# @flatfile/plugin-space-configure 中文文档

规范地址：https://npmcn.com/package/%40flatfile/plugin-space-configure/

版本：0\.10\.1
npm 元数据更新时间：2026-04-23T23:54:54.513Z
中文译文更新时间：2026-11-14T21:49:24.165Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flatfile/plugin-space-configure
原文对照：https://npmcn.com/package/%40flatfile/plugin-space-configure/?lang=original
项目主页：https://github.com/FlatFilers/flatfile-plugins#readme
源码仓库：https://github.com/FlatFilers/flatfile-plugins

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：65.5 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：1 个
- peer 依赖：@flatfile/api ^1\.9\.19，@flatfile/listener ^1\.1\.0
- 首次发布：2023-08-30T18:00:29.017Z
- 最新版本发布：2025-02-28T17:28:10.821Z
- 近 30 天下载量：18710（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 0 个）

## 中文简介

配置平面文件空间的插件 .

## 安装

```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`

## README

@flatfile/plugin-space-confit插件简化了新平面文件空间的设置.

**事件类型 :** `listener.on('space:configure')`

> 嵌入Flatfile时,该插件应被部署在服务器侧听器中. [学多点](https://npmcn.com/docs/orchestration/listeners#listener-types)

## 参数

#### `setup` - 说吧 `SetupFactory` - (必须)

这个 `setup` 参数持有新空间的配置设置.

#### `callback` - 说吧 `function`

这个 `callback` 参数收到三个参数: `event`, (中文(简体) ), `workbookIds`,则a `tick` 函数。 这个 `tick` 函数可用于更新 Job 的进展。 这个 `callback` 函数在空间和工作簿完全配置后被引用.

## API 调用

-   `api.spaces.update`
-   `api.workbooks.create`

## 使用量

@flatfile/plugin-space-confit插件简化了新平面文件空间的设置.

为服务器侧听器所设计,它利用所提供的设置自动配置了空间.

#### 安装

```bash
npm i @flatfile/plugin-space-configure
```

#### 导入

```js
import { configureSpace } from "@flatfile/plugin-space-configure";
```

#### `listener.js` 没有工作手册

```js
listener.use(
  configureSpace({
    workbooks: [],
  })
);
```

#### `listener.js` 有工作手册

```js
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,
          },
        ],
      },
    ],
  })
);
```

## 完整示例

#### `contactsSheet.ts`

```typescript
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
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
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: `<div>
          <h1 style="margin-bottom: 36px;">Welcome!</h1>
          <h2 style="margin-top: 0px; margin-bottom: 12px;">To get started, follow these steps:</h2>
          <h2 style="margin-bottom: 0px;">1. Step One</h2>
          <p style="margin-top: 0px; margin-bottom: 8px;">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.</p>
          <h2 style="margin-bottom: 0px;">2. Step Two</h2>
          <p style="margin-top: 0px; margin-bottom: 8px;">Consectetur libero id faucibus nisl tincidunt eget. Pellentesque elit eget gravida cum sociis natoque penatibus et. Tempor orci eu lobortis elementum nibh.</p>
          </div>`,
          },
        ],
      },
      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!");
      }
    )
  );
}
```

## 常见问题

### @flatfile/plugin-space-configure 是什么？

配置平面文件空间的插件 \.

### 如何安装 @flatfile/plugin-space-configure？

在项目目录运行 npm install @flatfile/plugin-space-configure，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@flatfile/api（^1\.9\.19）、@flatfile/listener（^1\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flatfile/plugin-space-configure 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @flatfile/plugin-space-configure 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @flatfile/plugin-space-configure 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @flatfile/plugin-space-configure 可以商用吗？

@flatfile/plugin-space-configure 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @flatfile/plugin-space-configure 的下载量有多少？

根据 npm 官方下载统计，@flatfile/plugin-space-configure 在 2026/10/15 – 2026/11/13 这 30 天内被下载 18,710 次，日均约 624 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @flatfile/plugin-space-configure 还在维护吗？

最新版本 0\.10\.1 发布于 2025/03/01（1\.7 年前）；至今共发布 30 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/08/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。