@tianyr/schema-antd 0.0.0-stage → 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,133 @@
+/**
+ * 统一运行契约 v1.0 的类型落地。
+ *
+ * 本文件是 packages/schema 内公共类型的唯一来源，SchemaField / SchemaForm /
+ * EditableTable / FullEditableTable 只导入，不重新声明。
+ * 刻意只依赖 antd 与 react，不引用 @/ 下的工程封装，便于后续单独发包。
+ */
+import type { ReactNode } from 'react';
+import type { FormInstance, FormItemProps, TableColumnsType } from 'antd';
+export type NamePath = string | number | (string | number)[];
+/** 校验规则沿用 AntD 的 Rule 类型，避免自己维护一份平行定义 */
+export type Rule = NonNullable<FormItemProps['rules']>[number];
+export type FieldMode = 'edit' | 'read';
+export type FieldType = 'Input' | 'Input.TextArea' | 'Input.Password' | 'InputNumber' | 'AutoComplete' | 'Cascader' | 'Checkbox' | 'CheckboxGroup' | 'ColorPicker' | 'DatePicker' | 'RadioGroup' | 'Rate' | 'Select' | 'Slider' | 'TimePicker' | 'Transfer' | 'TreeSelect' | 'Upload' | 'BizSelect' | 'Custom'
+/**
+ * 业务方自定义类型：`registerField('XxxSelect', …)` 注册后即可直接写。
+ * 交叉一个空对象是为了保住内置字面量的补全，同时接受任意字符串。
+ */
+ | (string & {}) | (string & {});
+/** 单字段渲染协议：SchemaField 只消费这些属性 */
+export interface FieldSchema<TValue = unknown> {
+    type: FieldType;
+    props?: Record<string, unknown>;
+    mode?: FieldMode;
+    renderRead?: (value: TValue, schema: FieldSchema<TValue>) => ReactNode;
+}
+/** 自定义字段的公共上下文：只读元数据 + 最终非受控属性，不提供 Form 实例 */
+interface CustomShared<TValue = unknown> {
+    value: TValue | undefined;
+    /** 已完成 dynamic.props 合并、受控键剔除与 id 注入的最终非受控属性 */
+    props: Readonly<Record<string, unknown>>;
+    /** 运行时有效 Schema；不变量：schema.props === props */
+    schema: CustomFieldSchema<TValue>;
+}
+/**
+ * 局部自定义字段的渲染上下文。
+ * edit 与 read 是判别联合：只读态不提供 onChange，避免业务误以为可编辑。
+ */
+export type CustomRenderContext<TValue = unknown> = (CustomShared<TValue> & {
+    mode: 'edit';
+    onChange: (value: TValue, ...meta: unknown[]) => void;
+}) | (CustomShared<TValue> & {
+    mode: 'read';
+    onChange?: never;
+});
+/** 不注册全局类型、直接就地渲染的自定义字段；只在 type: 'Custom' 生效 */
+export interface CustomFieldSchema<TValue = unknown> extends Omit<FieldSchema<TValue>, 'type'> {
+    type: 'Custom';
+    render(ctx: CustomRenderContext<TValue>): ReactNode;
+}
+/** FieldType 是开放字符串联合，运行时仍需校验 render 是函数 */
+export type AnyFieldSchema<TValue = unknown> = FieldSchema<TValue> | CustomFieldSchema<TValue>;
+export interface ReadContext {
+    get(name: NamePath): unknown;
+    getValues(): Record<string, unknown>;
+}
+export interface WriteContext extends ReadContext {
+    form: FormInstance;
+    set(name: NamePath, value: unknown): void;
+    /**
+     * 批量写入：等价于对每个键连续调用 set，不额外触发联动。
+     * 键是顶层字段名（嵌套 NamePath 继续用 set）；`undefined` 是写值不是删键；
+     * 只负责写，不读选项、不清理失效值、不做类型转换。
+     */
+    setValues(values: Record<string, unknown>): void;
+    clear(name: NamePath): void;
+    clearValues(names: NamePath[]): void;
+}
+export interface FieldEventContext extends WriteContext {
+    /** Select / BizSelect 的选中项，来自 SchemaField onChange 的第二参数 */
+    option?: unknown;
+    /** 其余元数据 */
+    meta?: unknown[];
+}
+/** 允许静态值或读取表单值的纯函数 */
+export type Derived<T> = T | ((ctx: ReadContext) => T);
+export interface DynamicConfig {
+    /** 影响派生结果的所有字段都必须显式列出，不做自动依赖收集 */
+    dependencies: NamePath[];
+    visible?: Derived<boolean>;
+    disabled?: Derived<boolean>;
+    required?: Derived<boolean>;
+    rules?: Derived<Rule[]>;
+    props?: Derived<Record<string, unknown>>;
+}
+export interface LinkageRule {
+    dependencies: NamePath[];
+    handler(ctx: WriteContext): void;
+    /** 默认 false：仅在用户交互引发的变更时执行 */
+    immediate?: boolean;
+}
+/** 扁平扩展：同一份对象既交给 SchemaField，也交给 SchemaForm 做 Form.Item 绑定 */
+export interface FormFieldSchema<TValue = unknown> extends FieldSchema<TValue> {
+    name: NamePath;
+    label?: ReactNode;
+    rules?: Rule[];
+    /** 仅传给 AntD Form.Item 做校验依赖，不参与 DynamicConfig 的订阅 */
+    dependencies?: NamePath[];
+    visible?: boolean;
+    /** 仅存量兼容，新业务禁止与 visible 同时声明 */
+    hidden?: boolean;
+    dynamic?: DynamicConfig;
+    linkage?: LinkageRule[];
+    events?: {
+        onChange?: (value: TValue, ctx: FieldEventContext) => void;
+    };
+    colSpan?: number;
+    formItemProps?: Omit<FormItemProps, 'name' | 'label' | 'rules' | 'dependencies' | 'hidden' | 'children'>;
+}
+/** 自定义字段进入表单层后的形态：保留 FormFieldSchema 的表单语义 + Custom 的渲染函数 */
+export type CustomFormFieldSchema<TValue = unknown> = Omit<FormFieldSchema<TValue>, 'type'> & CustomFieldSchema<TValue>;
+/** 公开入口（SchemaForm / SchemaFormField / 表格列）统一接受这个联合 */
+export type AnyFormFieldSchema<TValue = unknown> = FormFieldSchema<TValue> | CustomFormFieldSchema<TValue>;
+/**
+ * 内置工具条（新增 / 插槽 / 批量删除）的位置。
+ * 默认底部；顶部与老家族 BatchEdit 的工具条一致，适合按钮少、表体长的页面。
+ */
+export type ToolbarPlacement = 'top' | 'bottom';
+/** 可编辑表格列：EditableTable 与 FullEditableTable 共用同一份定义 */
+export type EditableColumn<T> = TableColumnsType<T>[number] & {
+    /**
+     * 列形态：
+     * - `true`：编辑控件，写值进本行 Form，参与校验；
+     * - `false`/缺省：不挂 field，单元格直接读行记录——**跟不上 events/linkage 的写值**；
+     * - `'read'`：挂 field 但只读渲染，值跟随本行 Form（联动带出的列用这个），
+     *   与 SchemaFormField 的 read 态一致：不注册具名 Form.Item，因此不参与校验。
+     */
+    editable?: boolean | 'read';
+    /** 同一份扁平字段 Schema；editable 为 true 或 'read' 时必填 */
+    field?: AnyFormFieldSchema;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,MAAM,CAAC;AAE1E,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAE7D,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAExC,MAAM,MAAM,SAAS,GACjB,OAAO,GACP,gBAAgB,GAChB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,UAAU,GACV,UAAU,GACV,eAAe,GACf,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,WAAW,GAEX,QAAQ;AACV;;;GAGG;GACD,CAAC,MAAM,GAAG,EAAE,CAAC,GAEb,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElB,kCAAkC;AAClC,MAAM,WAAW,WAAW,CAAC,MAAM,GAAG,OAAO;IAC3C,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC;CACxE;AAED,8CAA8C;AAC9C,UAAU,YAAY,CAAC,MAAM,GAAG,OAAO;IACrC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACzC,8CAA8C;IAC9C,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,MAAM,GAAG,OAAO,IAC5C,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CACvD,CAAC,GACF,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB,CAAC,CAAC;AAEP,gDAAgD;AAChD,MAAM,WAAW,iBAAiB,CAAC,MAAM,GAAG,OAAO,CAAE,SAAQ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC5F,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,CAAC,GAAG,EAAE,mBAAmB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;CACrD;AAED,4CAA4C;AAC5C,MAAM,MAAM,cAAc,CAAC,MAAM,GAAG,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAE/F,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC7B,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1C;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACjD,KAAK,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,4DAA4D;IAC5D,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY;IACZ,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;CAClB;AAED,sBAAsB;AACtB,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,WAAW,KAAK,CAAC,CAAC,CAAC;AAEvD,MAAM,WAAW,aAAa;IAC5B,kCAAkC;IAClC,YAAY,EAAE,QAAQ,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,QAAQ,EAAE,CAAC;IACzB,OAAO,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,CAAC;IACjC,8BAA8B;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe,CAAC,MAAM,GAAG,OAAO,CAAE,SAAQ,WAAW,CAAC,MAAM,CAAC;IAC5E,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,qDAAqD;IACrD,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gCAAgC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,iBAAiB,KAAK,IAAI,CAAA;KAAE,CAAC;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,IAAI,CAClB,aAAa,EACb,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,cAAc,GAAG,QAAQ,GAAG,UAAU,CACpE,CAAC;CACH;AAED,6DAA6D;AAC7D,MAAM,MAAM,qBAAqB,CAAC,MAAM,GAAG,OAAO,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,GACzF,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAE5B,uDAAuD;AACvD,MAAM,MAAM,kBAAkB,CAAC,MAAM,GAAG,OAAO,IAC3C,eAAe,CAAC,MAAM,CAAC,GACvB,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEhD,uDAAuD;AACvD,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG;IAC5D;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B,kDAAkD;IAClD,KAAK,CAAC,EAAE,kBAAkB,CAAC;CAC5B,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,62 @@
 {
   "name": "@tianyr/schema-antd",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "基于 antd v5 的 Schema 驱动表单、字段渲染与两种可编辑表格",
+  "keywords": [
+    "antd",
+    "react",
+    "schema",
+    "form",
+    "editable-table"
+  ],
+  "homepage": "https://github.com/ER-Tiylor/schema-antd#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ER-Tiylor/schema-antd.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ER-Tiylor/schema-antd/issues"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": true,
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && node scripts/fix-esm-ext.mjs",
+    "typecheck": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run typecheck && npm run build",
+    "publish:public": "node scripts/publish.mjs public",
+    "publish:inner": "node scripts/publish.mjs inner"
+  },
+  "peerDependencies": {
+    "@ant-design/icons": "^5.2.0",
+    "antd": "^5.20.0",
+    "dayjs": "^1.11.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@ant-design/icons": "^5.2.6",
+    "@types/react": "^18.2.43",
+    "@types/react-dom": "^18.2.17",
+    "antd": "5.20.0",
+    "dayjs": "^1.11.10",
+    "typescript": "^5.2.2"
+  }
+}