@flexkit/schema

中文文档
0.2.15发布于 2026/10/21MITTypeScriptESM + CJS构建来源已验证近 30 天下载 2952

Flexkit project configuration: schema types, defineConfig/defineEntity, and the serializer that turns a flexkit.config.ts into the deployable JSON schema.

原始使用文档

@flexkit/schema

Types and helpers for flexkit.config.ts:

  • defineConfig and defineEntity to author a project configuration with full typing.
  • The schema types (Entity, Attribute, ProjectConfig, …) and their deployed counterparts (UiEntity, UiAttribute, UiProjectSchema).
  • serializeConfig, used by flexkit deploy, which turns the config into pure data: Zod validation functions are compiled to JSON Schema (draft-07), and anything that cannot be expressed that way fails with a SchemaSerializationError naming the entity and attribute.
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 共发布 19 个版本,首次发布于 2026/10/15;过去 12 个月发布了 19 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.15latest2026/10/2126 天前
0.2.142026/10/2026 天前
0.2.132026/10/2026 天前
0.2.122026/10/1927 天前
0.2.112026/10/1927 天前
0.2.102026/10/1928 天前

关于 @flexkit/schema 的常见问题

@flexkit/schema 是什么?

Flexkit project configuration: schema types, defineConfig/defineEntity, and the serializer that turns a flexkit.config.ts into the deployable 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 和提交记录判断。