\n\nA tool for embedding OneSchema into your application. This library will give you convenient bindings to add an iframe to your application which can open OneSchema and import data into your application.\n\n## Getting Started\n\n### Installation\n\nYou can install this package with npm:\n\n```bash\nnpm i --save @oneschema/importer\n```\n\nor with a script tag:\n\n```html\n\n```\n\nWith pnpm, install `eventemitter3` alongside it:\n\n```bash\npnpm add @oneschema/importer eventemitter3@^4.0.7\n```\n\nThe importer class extends `EventEmitter` from `eventemitter3`, so that type is part of the published declarations. pnpm keeps each package's dependencies isolated instead of hoisting them, so your build cannot resolve `eventemitter3` unless it is declared in your project too. npm and yarn hoist it for you.\n\n### Sample usage\n\n```javascript\nimport oneschemaImporter from \"@oneschema/importer\"\n\nconst importer = oneschemaImporter({\n /* required here */\n clientId: \"YOUR_CLIENT_ID\",\n /* required here or at launch */\n templateKey: \"YOUR_TEMPLATE_KEY\",\n userJwt: \"YOUR_USER_JWT\",\n /* optional */\n importConfig: { type: \"local\" },\n devMode: true,\n className: \"oneschema-importer\",\n})\n\nimporter.launch()\n// OR\n// pass overrides and values not specified at creation time:\nimporter.launch({\n templateKey: \"YOUR_TEMPLATE_KEY\",\n userJwt: \"YOUR_USER_JWT\",\n importConfig: { type: \"local\" },\n})\n\nimporter.on(\"success\", (data) => {\n // handle success\n})\n\nimporter.on(\"cancel\", () => {\n // handle cancel\n})\n\nimporter.on(\"error\", (error) => {\n // error is { message, severity }\n})\n\n// release the iframe and every listener when you are done with the instance\nimporter.destroy()\n```\n\n## API reference\n\nThe tables below are generated from the TypeScript types by\n`yarn docs:api` — edit the JSDoc in `src/config.ts`, not the tables.\n\n### Options set at initialization\n\n\n\n| Option | Type | Required | Default | Description |\n| -------------- | ------------------------------ | -------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `clientId` | `string` | yes | | The client id from your OneSchema developer dashboard |\n| `devMode` | `boolean` | | `!!(process.env.NODE_ENV !== \"production\")` | Whether to launch the importer in dev mode, which shows the iframe even when launching fails |\n| `className` | `string` | | `\"oneschema-iframe\"` | CSS class for the iframe |\n| `styles` | `Partial` | | | CSS Styles to be applied directly to the iframe |\n| `languageCode` | `string` | | | Optional language code (like 'en' or 'zh') to force importer language By default, will use user's set language. Requires enterprise licensing |\n| `parentId` | `string` | | | The id of the DOM element the iframe should be appended to By default appends to document.body |\n| `saveSession` | `boolean` | | `true` | Whether to save session information to local storage and enable resuming |\n| `autoClose` | `boolean` | | `true` | Whether to close the importer when complete |\n| `manageDOM` | `boolean` | | `true` | Whether the class should create and append the iframe to the DOM |\n| `baseUrl` | `string` | | `\"https://embed.oneschema.co\"` | The base URL for the iframe. By default uses OneSchema's production instance |\n\n\n\n### Options set at initialization or at launch\n\nPass either `userJwt` + `templateKey`, or a `sessionToken` created through the\nAPI.\n\n\n\nLaunch with a user JWT and a template key:\n\n| Option | Type | Required | Default | Description |\n| ------------------------ | ---------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------- |\n| `userJwt` | `string` | yes | | The JSON web token for the user importing data |\n| `templateKey` | `string` | yes | | The key for the template that data will be imported for. Setup inside OneSchema before using |\n| `templateOverrides` | `OneSchemaTemplateOverrides` | | | Template overrides to modify the behavior of the base template |\n| `importConfig` | `ImportConfig` | | | The configuration for how data should be imported from OneSchema |\n| `customizationKey` | `string` | | | Key for a customization setup in OneSchema |\n| `customizationOverrides` | `ImporterCustomization` | | | Customization options for how OneSchema will behave |\n| `eventWebhookKeys` | `string[]` | | | Event webhooks that should be used during an import session |\n\nOr, instead of those, with a session token created through the API:\n\n| Option | Type | Required | Default | Description |\n| -------------- | -------- | -------- | ------- | ------------------------------------------------------------------------ |\n| `sessionToken` | `string` | yes | | A token for a session created through the API for initializing OneSchema |\n\n\n\n### Events\n\n\n\n| Event | Listener arguments | Description |\n| --------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `page-loaded` | `Record` | The embedded importer page finished loading behind the scenes |\n| `launched` | `OneSchemaLaunchStatus` | The import session was launched, or launching it failed |\n| `success` | `OneSchemaImportResult` | The user finished importing. For `local` imports the data is the payload, for `webhook` imports it summarizes the delivery |\n| `cancel` | none | The user cancelled the import |\n| `error` | `OneSchemaError` | Something went wrong. `severity` is `fatal` when the session cannot continue |\n| `user-activity` | none | The user interacted with the importer. Throttled to once every 30 seconds, and useful for resetting idle timers in the host application |\n\n\n\n## Documentation\n\nPlease see [📚 OneSchema's documentation](https://docs.oneschema.co/) for [📒 API reference](https://docs.oneschema.co/docs/javascript#api-reference) and other helpful guides.\n","readmeFilename":"README.md"}
![](\"https://uploads-ssl.webflow.com/62902d243ad8aef519be0d3e/62902d243ad8ae4014be0e97_oneschema-256.png\")
\n