# @flatfile/plugin-space-configure > A plugin for configuring a Flatfile Space. Latest version **0.10.1** (published 2025-02-28) · ISC license · 0 weekly downloads ## Install ```sh npm install @flatfile/plugin-space-configure pnpm add @flatfile/plugin-space-configure yarn add @flatfile/plugin-space-configure bun add @flatfile/plugin-space-configure ``` ## Health **Score 55/100 (C)** — status: stable. Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads; pre 1.0. Negative: stale. ## Facts | | | |---|---| | Version | 0.10.1 | | Published | 2025-02-28 | | First published | 2023-08-30 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >= 18 | | Dependencies | 1 | | Unpacked size | 64 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 7 | | Author | Flatfile, Inc. | | Maintainers | sarocu, dboskovic, jmmander, bangarang, carlbrugger, flatfileinfra, flatderek, bigcountrycrane, rjhyde, sambarrowclough, meritmalling, mmccooyyy, hjordan1990, nlazaris | | Keywords | flatfile-plugins, category-core | ## Links - npm: https://www.npmjs.com/package/@flatfile/plugin-space-configure - Repository: https://github.com/FlatFilers/flatfile-plugins - Homepage: https://github.com/FlatFilers/flatfile-plugins#readme - Issues: https://github.com/FlatFilers/flatfile-plugins/issues - npm.io page: https://npm.io/package/@flatfile/plugin-space-configure ## Dependencies (1) - [@flatfile/plugin-job-handler](https://npm.io/package/@flatfile/plugin-job-handler.md) ^0.8.1 ## Recent versions - 0.10.1 (latest) — 2025-02-28 - 0.10.0 — 2025-02-21 - 0.9.0 — 2025-02-19 - 0.8.1 — 2024-12-19 - 0.8.0 — 2024-11-07 - 0.7.0 — 2024-10-29 - 0.6.1 — 2024-10-03 - 0.6.0 — 2024-09-24 - 0.5.3 — 2024-09-03 - 0.5.2 — 2024-05-20 - 0.5.1 — 2024-04-30 - 0.5.0 — 2024-04-26 - 0.4.0 — 2024-04-23 - 0.3.6 — 2024-04-11 - 0.3.5 — 2024-04-08 - … 15 more at https://npm.io/package/@flatfile/plugin-space-configure/versions ## README The @flatfile/plugin-space-configure plugin streamlines the setup of a new Flatfile Space. **Event Type:** `listener.on('space:configure')` > When embedding Flatfile, this plugin should be deployed in a server-side listener. [Learn more](/docs/orchestration/listeners#listener-types) ## Parameters #### `setup` - `SetupFactory` - (required) The `setup` parameter holds the configuration settings for the new Space. #### `callback` - `function` 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` ## Usage The @flatfile/plugin-space-configure plugin simplifies the setup of new Flatfile Spaces. Designed for server-side listeners, it auto-configures the Space using the supplied settings. #### Install ```bash install npm i @flatfile/plugin-space-configure ``` #### Import ```js import import { configureSpace } from "@flatfile/plugin-space-configure"; ``` #### `listener.js` with no workbooks ```js listener.js w/ no workbooks listener.use( configureSpace({ workbooks: [], }) ); ``` #### `listener.js` with workbooks ```js listener.js /w workbooks listener.use( configureSpace({ workbooks: [ { name: "Getting Started", sheets: [ { name: "Contacts", slug: "contacts", fields: [ { key: "name", type: "string", label: "Name", }, { key: "email", type: "string", label: "Email", }, ], }, ], actions: [ { operation: "submitActionFg", mode: "foreground", label: "Submit data", type: "string", description: "Submit this data to ...", primary: true, }, ], }, ], }) ); ``` ## Full Example #### `contactsSheet.ts` ```typescript contactsSheet.ts import { Flatfile } from "@flatfile/api"; export const contactsSheet: Flatfile.SheetConfig = { name: "Contacts", slug: "contacts", fields: [ { key: "firstName", type: "string", label: "First Name", }, { key: "lastName", type: "string", label: "Last Name", }, { key: "email", type: "string", label: "Email", }, { key: "company", type: "reference", label: "Company", config: { key: "email", ref: "companies", relationship: "has-one", }, }, ], actions: [ { operation: "duplicateSheet", mode: "foreground", label: "Duplicate", description: "Duplicate this sheet.", primary: true, }, { operation: "dedupeEmail", mode: "background", label: "Dedupe emails", description: "Remove duplicate emails", }, ], }; ``` #### `companiesSheet.ts` ```typescript companiesSheet.ts import { Flatfile } from "@flatfile/api"; export const companiesSheet: Flatfile.SheetConfig = { name: "Companies", slug: "companies", fields: [ { key: "name", type: "string", label: "Name", }, { key: "website", type: "string", label: "Website", }, //... ], }; ``` #### `listener.ts` ```typescript listener.ts import api from "@flatfile/api"; import type { FlatfileListener } from "@flatfile/listener"; import { configureSpace } from "@flatfile/plugin-space-configure"; import { contactsSheet } from "./contactsSheet"; import { companiesSheet } from "./companiesSheet"; export default function (listener: FlatfileListener) { listener.use( configureSpace( { workbooks: [ { name: "Workbook 1", sheets: [contactsSheet, companiesSheet], actions: [ { operation: "submitActionFg", mode: "foreground", label: "Submit data", type: "string", description: "Submit this data to a webhook.", primary: true, }, { operation: "duplicateWorkbook", mode: "foreground", label: "Duplicate", description: "Duplicate this workbook.", }, ], }, ], space: { metadata: { theme: { root: { primaryColor: "black", }, sidebar: { logo: "https://images.ctfassets.net/hjneo4qi4goj/33l3kWmPd9vgl1WH3m9Jsq/13861635730a1b8af383a8be8932f1d6/flatfile-black.svg", }, }, }, }, documents: [ { 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.

2. Step Two

Consectetur libero id faucibus nisl tincidunt eget. Pellentesque elit eget gravida cum sociis natoque penatibus et. Tempor orci eu lobortis elementum nibh.

`, }, ], }, async (event, workbookIds, tick) => { const { spaceId } = event.context; // Callback is invoked once the Space and Workbooks are fully configured. // Job progress will be at 50% when the callback is invoked. tick(51, "Running callback!"); // Do something... await tick(99, "Callback complete!"); } ) ); } ``` --- _Source: https://npm.io/package/@flatfile/plugin-space-configure · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._