diff --git a/plugins/core/space-configure.mdx b/plugins/core/space-configure.mdx index 695108e40..c00549d27 100644 --- a/plugins/core/space-configure.mdx +++ b/plugins/core/space-configure.mdx @@ -40,16 +40,14 @@ icon: "download" ## API Calls -- `api.spaces.get` - `api.spaces.update` -- `api.workbooks.get` - `api.workbooks.create` ## Imported NPM Packages - [`@flatfile/api@1.4.9+`](https://npmjs.com/package/@flatfile/api) - [`@flatfile/listener@0.3.15+`](https://npmjs.com/package/@flatfile/listener) -- [`@flatfile/plugin-job-handler@0.1.0+`](./job-handler) +- [`@flatfile/plugin-job-handler@0.1.0+`](https://www.npmjs.com/package/@flatfile/plugin-job-handler) ## Usage @@ -251,7 +249,7 @@ export default function (listener: FlatfileListener) { diff --git a/plugins/schemas/convert-json-schema.mdx b/plugins/schemas/convert-json-schema.mdx index bbeda4a94..2d10b39fc 100644 --- a/plugins/schemas/convert-json-schema.mdx +++ b/plugins/schemas/convert-json-schema.mdx @@ -1,24 +1,162 @@ --- -title: "@flatfile/plugin-json-schema" -description: "A plugin for converting JSON Schema to Flatfile Blueprint." -icon: "clock" +title: "@flatfile/plugin-convert-json-schema" +description: "A plugin for converting JSON Schema to Flatfile Blueprint and configuring a Flatfile Space." +icon: "download" --- + + When embedding Flatfile, this plugin should be deployed in a server-side + listener. [Learn + more](../../developer-tools/client_server_side#server-side-listeners) + + - - *currently in development*
+ + The @flatfile/plugin-convert-json-schema plugin will automatically convert JSON Schema to the Flatfile Blueprint, a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation, and configure a Flatfile Space using the Blueprint. +
+
+ **Event Type:**
- check back soon for updates - + `listener.on('space:configure')` + + +## Parameters + + + The `models` parameter holds the JSON Schema `sourceUrl` and take other Sheet + configuration options. + + + + The `options.workbookConfig` parameter takes other optional Workbook + configurations. + + + + The `options.debug` parameter lets you toggle on/off helpful debugging + messages for development purposes. + + + + The `callback` parameter receives three arguments: `event`, `workbookIds`, and + a `tick` function. The `tick` function can be used to update the Job's + progress. The `callback` function is invoked once the Space and Workbooks are + fully configured. + + +## API Calls + +- `api.spaces.update` +- `api.workbooks.create` + +## Imported NPM Packages + +- [`@flatfile/api@1.5.37+`](https://npmjs.com/package/@flatfile/api) +- [`@flatfile/plugin-space-configure@0.1.6+`](https://npmjs.com/package/@flatfile/plugin-space-configure) +- [`@hyperjump/json-schema@1.6.4+`](https://npmjs.com/package/@hyperjump/json-schema) +- [`axios@1.5.1+`](https://npmjs.com/package/axios) + +## Usage +The @flatfile/plugin-convert-json-schema plugin simplifies the setup of new Flatfile Spaces by configuring the Space from a provided JSON Schema. +Designed for server-side listeners, it auto-configures the Space using the supplied settings. -### Overview +```bash install +npm i @flatfile/plugin-convert-json-schema +``` -This plugin will automatically convert JSON Schema to the Flatfile Blueprint, a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation. +```js import +import { configureSpaceWithJsonSchema } from "@flatfile/plugin-convert-json-schema"; +``` + - +```js listener.js w/ basic configuration +listener.use( + configureSpaceWithJsonSchema([ + { sourceUrl: "https://example.com/customer.schema.json" }, + ]) +); +``` ---- \ No newline at end of file +```js listener.js /w advanced configuration +const workbookActions: Flatfile.Action[] = [ + { + operation: 'submitAction', + mode: 'foreground', + label: 'Submit data', + type: 'string', + description: 'Submit this data to a webhook.', + primary: true, + }, +] + +const sheetActions: Flatfile.Action[] = [ + { + operation: 'duplicateSheet', + mode: 'foreground', + label: 'Duplicate', + description: 'Duplicate this sheet.', + primary: true, + }, +] + +const customerModel: PartialSheetConfig = { + sourceUrl: 'https://example.com/customer.schema.json' + slug: 'customer', + name: 'Customer', + actions: sheetActions, +} + +const personModel: PartialSheetConfig = { + sourceUrl: 'https://example.com/person.schema.json', + slug: 'person', + name: 'Person', + actions: sheetActions, +} + +const workbookConfig: PartialWorkbookConfig = { actions: workbookActions } + +const callback = async (event, workbookIds, tick) => { + const { spaceId } = event.context + await api.documents.create(spaceId, { + title: 'Welcome', + body: `
+

Welcome!

+

To get started, follow these steps:

+

1. Step One

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

+

Remember, if you need any assistance, you can always refer back to this page by clicking "Welcome" in the left-hand sidebar!

+
`, + }) + await tick(80, 'Document created') +} + +listener.use( + configureSpaceWithJsonSchema( + [ + customerModel, + personModel, + ], + { workbookConfig, debug: true }, + callback + ) +) +``` + + + +## See the code + + + +