# @flexkit/schema 中文文档

规范地址：https://npmcn.com/package/%40flexkit/schema/

版本：0\.2\.15
npm 元数据更新时间：2026-10-20T17:27:51.744Z
中文译文更新时间：2026-11-14T22:39:54.257Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40flexkit/schema
原文对照：https://npmcn.com/package/%40flexkit/schema/?lang=original
项目主页：https://github.com/flexkit-io/flexkit#readme
源码仓库：https://github.com/flexkit-io/flexkit

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

- 包体积（解压后）：84.3 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-10-14T19:45:52.783Z
- 最新版本发布：2026-10-20T17:27:51.255Z
- 近 30 天下载量：2952（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 19 个）

## 中文简介

Flexkit项目配置: schema类型,定义Config/define Entity,以及将一个flexkit.config.ts转换为可部署的JSON schema的序列器.

## 安装

```sh
npm install @flexkit/schema
```

也可以使用：`pnpm add @flexkit/schema`、`yarn add @flexkit/schema`、`bun add @flexkit/schema`

## README

# 校对:soup

类型和助手 `flexkit.config.ts`数字 :

-   `defineConfig` 财务报告和审定财务报表 `defineEntity` 来创建带有完整打字功能的工程配置.
-   计划类型(`Entity`, (中文(简体) ), `Attribute`, (中文(简体) ), `ProjectConfig`(......)及其部署的对应人员(......)`UiEntity`, (中文(简体) ), `UiAttribute`, (中文(简体) ), `UiProjectSchema`) (中文(简体) ).
-   `serializeConfig`,用于 `flexkit deploy`,将配置转换为纯数据 : Zod `validation` 函数被编译为 JSON Schema( 草稿-07),任何无法用此方式表达的函数都会在 `SchemaSerializationError` 命名实体和属性.

```ts
import { defineConfig, defineEntity } from '@flexkit/schema';

export default defineConfig({
  projectId: 'abcdefghij',
  title: 'Shop',
  menuGroups: [{ name: 'catalog', title: 'Catalog' }],
  scopes: [{ name: 'default', label: 'Default', isDefault: true }],
  schema: [
    defineEntity({
      name: 'product',
      plural: 'products',
      menu: { group: 'catalog', icon: 'Tag' },
      attributes: [
        {
          name: 'name',
          label: 'Name',
          dataType: 'string',
          inputType: 'text',
          scope: 'global',
          validation: (z) => z.string().min(1),
        },
      ],
    }),
  ],
});
```

## 常见问题

### @flexkit/schema 是什么？

Flexkit项目配置: schema类型,定义Config/define Entity,以及将一个flexkit\.config\.ts转换为可部署的JSON schema的序列器\.

### 如何安装 @flexkit/schema？

在项目目录运行 npm install @flexkit/schema，或使用 pnpm add / yarn add / bun add。

### @flexkit/schema 支持 TypeScript 吗？

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

### @flexkit/schema 支持 ESM 还是 CommonJS？

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

### @flexkit/schema 可以商用吗？

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

### @flexkit/schema 的下载量有多少？

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

### @flexkit/schema 还在维护吗？

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