oneschemaImporter Function (default export)

The default export of the package is a function which will return a OneSchemaImporter class.

Sample usage:

import oneschemaImporter from "@oneschema/importer"

const importer = oneschemaImporter(clientId, iframeConfig, baseUrl)

clientId

iframeConfig

baseUrl

OneSchemaImporter Class

The OneSchemaImporter class is used to integrate OneSchema into your application. It inherits from an EventEmitter class. Events will be emitted based on what happens in OneSchema.

Sample usage:

importer.launch(config)

importer.close(open)

importer.on('success', (data) => {
  console.log(data)
})

importer.on('cancel', () => {
  console.log('OneSchema embed flow cancelled')
})

importer.on('error', (message) => {
  console.log(message)
})

launch(config)

The launch function will show the OneSchema iframe and start an import based on the given config.

close(clean = false)

The close function will hide the OneSchema iframe from view.

success Event

The success event will fire when the import is complete. The parameter to the callback will include the data that has been imported. The format of the data will be the same as the schema of webhook payload row data.

cancel Event

The cancel event will fire when the import is cancelled.

error Event

The error event will fire when an error occurs during the import. The parameter to the callback will be a message about the error.

IframeConfig

className

parentId

devMode

autoClose

OneSchemaImporterConfig

userJwt

templateKey

webhookKey

options

OneSchemaImporterConfigOptions

blockImportIfErrors

OneSchemaImporter React Component

This component is the default export from the @oneschema/react package.

Here is a sample usage:

      <OneSchemaImporter
        /* managing state from your application */
        isOpen={isOpen}
        onRequestClose={() => setIsOpen(false)}
        /* required config values */
        clientId={clientId}
        userJwt={token}
        templateKey={templateKey}
        /* optional config values */
        webhookKey={webhookKey}
        blockImportIfErrors={true}
        devMode={process.env.NODE_ENV !== "production"}
        className="oneschema-importer"
        parentId="oneschema-container"
        baseUrl="https://embed.eu.oneschema.co"
        /* handling results */
        onSuccess={handleData}
        onCancel={() => console.log("cancelled")}
        onError={(message) => console.log(message)}
      />

You will need to manage state for whether the embed should be shown through isOpen and onRequestClose

isOpen

onRequestClose

clientId

userJwt

templateKey

webhookKey

blockImportIfErrors

devMode

className

parentId

baseUrl

onSuccess

onError

onCancel