@yongdall/types 0.4.5 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.mts +34 -6
- package/index.mjs +10 -1
- package/index.mjs.map +1 -1
- package/package.json +1 -1
package/index.d.mts
CHANGED
|
@@ -53,7 +53,16 @@ type Field = Field.Base & Field.Extends;
|
|
|
53
53
|
* @property {Field.Show[]?} [fields] 显示字段
|
|
54
54
|
* @property {{ field: string; label?: string; operator: string; }[]?} [queryFilters] 快速过滤字段
|
|
55
55
|
*/
|
|
56
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* @typedef {Object} Field.Binder
|
|
58
|
+
* @property {string} [source] 数据源属性映射。从源值对象中提取该属性赋值给目标字段（fixed 为 false 、配置有此字段时有效，且有关联对象时有效）。
|
|
59
|
+
* @property {boolean} [fixed] 是否为固定值模式。若为 true，则忽略动态计算，强制将目标字段设置为下方定义的 'set'
|
|
60
|
+
* @property {*} [set] 固定值内容。作为目标字段的最终值（fixed 为 true 且有关联对象时有效）。
|
|
61
|
+
* @property {boolean} [clear] 空值重置策略。若为 true，当源选项被清空（null/undefined）时，触发重置逻辑。
|
|
62
|
+
* @property {*} [reset] 默认重置值。当触发重置时，将目标字段设置为此值（clear 为 true 、且无关联对象时有效）。
|
|
63
|
+
*
|
|
64
|
+
*/
|
|
65
|
+
/** @typedef {Record<string, string | Field.Binder> | (Field.Binder & { field: string; })[]} Field.Bind */
|
|
57
66
|
/**
|
|
58
67
|
* @typedef {Object} Field.Base
|
|
59
68
|
* @property {string | Record<string, Field>} type 字段的基本类型
|
|
@@ -234,12 +243,31 @@ declare namespace Field {
|
|
|
234
243
|
operator: string;
|
|
235
244
|
}[] | null | undefined;
|
|
236
245
|
};
|
|
237
|
-
type
|
|
238
|
-
|
|
239
|
-
|
|
246
|
+
type Binder = {
|
|
247
|
+
/**
|
|
248
|
+
* 数据源属性映射。从源值对象中提取该属性赋值给目标字段（fixed 为 false 、配置有此字段时有效，且有关联对象时有效）。
|
|
249
|
+
*/
|
|
250
|
+
source?: string | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* 是否为固定值模式。若为 true，则忽略动态计算，强制将目标字段设置为下方定义的 'set'
|
|
253
|
+
*/
|
|
254
|
+
fixed?: boolean | undefined;
|
|
255
|
+
/**
|
|
256
|
+
* 固定值内容。作为目标字段的最终值（fixed 为 true 且有关联对象时有效）。
|
|
257
|
+
*/
|
|
258
|
+
set?: any;
|
|
259
|
+
/**
|
|
260
|
+
* 空值重置策略。若为 true，当源选项被清空（null/undefined）时，触发重置逻辑。
|
|
261
|
+
*/
|
|
262
|
+
clear?: boolean | undefined;
|
|
263
|
+
/**
|
|
264
|
+
* 默认重置值。当触发重置时，将目标字段设置为此值（clear 为 true 、且无关联对象时有效）。
|
|
265
|
+
*/
|
|
266
|
+
reset?: any;
|
|
267
|
+
};
|
|
268
|
+
type Bind = Record<string, string | Field.Binder> | (Field.Binder & {
|
|
240
269
|
field: string;
|
|
241
|
-
|
|
242
|
-
}[];
|
|
270
|
+
})[];
|
|
243
271
|
type Base = {
|
|
244
272
|
/**
|
|
245
273
|
* 字段的基本类型
|
package/index.mjs
CHANGED
|
@@ -52,7 +52,16 @@
|
|
|
52
52
|
* @property {Field.Show[]?} [fields] 显示字段
|
|
53
53
|
* @property {{ field: string; label?: string; operator: string; }[]?} [queryFilters] 快速过滤字段
|
|
54
54
|
*/
|
|
55
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* @typedef {Object} Field.Binder
|
|
57
|
+
* @property {string} [source] 数据源属性映射。从源值对象中提取该属性赋值给目标字段（fixed 为 false 、配置有此字段时有效，且有关联对象时有效）。
|
|
58
|
+
* @property {boolean} [fixed] 是否为固定值模式。若为 true，则忽略动态计算，强制将目标字段设置为下方定义的 'set'
|
|
59
|
+
* @property {*} [set] 固定值内容。作为目标字段的最终值（fixed 为 true 且有关联对象时有效）。
|
|
60
|
+
* @property {boolean} [clear] 空值重置策略。若为 true，当源选项被清空（null/undefined）时，触发重置逻辑。
|
|
61
|
+
* @property {*} [reset] 默认重置值。当触发重置时，将目标字段设置为此值（clear 为 true 、且无关联对象时有效）。
|
|
62
|
+
*
|
|
63
|
+
*/
|
|
64
|
+
/** @typedef {Record<string, string | Field.Binder> | (Field.Binder & { field: string; })[]} Field.Bind */
|
|
56
65
|
/**
|
|
57
66
|
* @typedef {Object} Field.Base
|
|
58
67
|
* @property {string | Record<string, Field>} type 字段的基本类型
|
package/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../../packages/types/Field.mjs","../../packages/types/index.mjs"],"sourcesContent":["\n/**\n * @typedef {Object} Field.Layout.Column\n * @property {string[]} [actions] 操作\n * @property {string} [action] 操作\n * @property {string} [field] 字段\n * @property {number} [placeholder] 占位符\n * @property {string} [pattern] 模式\n * @property {number} [width] 宽度\n * @property {string} [label] 标签\n */\n/**\n * @typedef {Object} Field.Layout\n * @property {number} [colSpan] 占用列数\n * @property {number} [colStart] 列起点\n * @property {number} [colEnd] 列终点\n * @property {number} [rowSpan] 占用行数\n * @property {number} [rowStart] 行起点\n * @property {number} [rowEnd] 行终点\n * @property {string} [levelKey]\n * @property {number} [head]\n * @property {boolean} [hidden]\n * @property {Field.Layout.Column[]} [columns]\n */\n\n/**\n * @typedef {object} Field.Show\n * @property {string} [field]\n * @property {string} [label]\n * @property {number} [width]\n * @property {string} [pattern]\n * @property {'' | 'left' | 'center' | 'right'} [align]\n * @property {boolean} [enableLink]\n */\n/**\n * @typedef {Object} Field.Source\n * @property {*[]} [values] 列表\n * @property {'enumeration' | 'model'} [type] 列表类型\n * @property {string?} [name] 名称\n * @property {string?} [search] 搜索信息\n * \n * @property {string?} [id] id字段(或模式)\n * @property {string?} [label] 标签字段(或模式)\n * @property {string?} [value] 值字段(或模式)\n * @property {string?} [parent] 父节点字段(或模式)\n * \n * @property {string?} [children] 子列表\n * @property {string?} [sequence] 序列字段\n * @property {string?} [disabled] 禁用字段\n * \n * @property {string?} [configurator] 配置信息字段\n * \n * @property {Field.Show[]?} [fields] 显示字段\n * @property {{ field: string; label?: string; operator: string; }[]?} [queryFilters] 快速过滤字段\n */\n/** @typedef {Record<string, string |
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../../packages/types/Field.mjs","../../packages/types/index.mjs"],"sourcesContent":["\n/**\n * @typedef {Object} Field.Layout.Column\n * @property {string[]} [actions] 操作\n * @property {string} [action] 操作\n * @property {string} [field] 字段\n * @property {number} [placeholder] 占位符\n * @property {string} [pattern] 模式\n * @property {number} [width] 宽度\n * @property {string} [label] 标签\n */\n/**\n * @typedef {Object} Field.Layout\n * @property {number} [colSpan] 占用列数\n * @property {number} [colStart] 列起点\n * @property {number} [colEnd] 列终点\n * @property {number} [rowSpan] 占用行数\n * @property {number} [rowStart] 行起点\n * @property {number} [rowEnd] 行终点\n * @property {string} [levelKey]\n * @property {number} [head]\n * @property {boolean} [hidden]\n * @property {Field.Layout.Column[]} [columns]\n */\n\n/**\n * @typedef {object} Field.Show\n * @property {string} [field]\n * @property {string} [label]\n * @property {number} [width]\n * @property {string} [pattern]\n * @property {'' | 'left' | 'center' | 'right'} [align]\n * @property {boolean} [enableLink]\n */\n/**\n * @typedef {Object} Field.Source\n * @property {*[]} [values] 列表\n * @property {'enumeration' | 'model'} [type] 列表类型\n * @property {string?} [name] 名称\n * @property {string?} [search] 搜索信息\n * \n * @property {string?} [id] id字段(或模式)\n * @property {string?} [label] 标签字段(或模式)\n * @property {string?} [value] 值字段(或模式)\n * @property {string?} [parent] 父节点字段(或模式)\n * \n * @property {string?} [children] 子列表\n * @property {string?} [sequence] 序列字段\n * @property {string?} [disabled] 禁用字段\n * \n * @property {string?} [configurator] 配置信息字段\n * \n * @property {Field.Show[]?} [fields] 显示字段\n * @property {{ field: string; label?: string; operator: string; }[]?} [queryFilters] 快速过滤字段\n */\n/**\n * @typedef {Object} Field.Binder\n * @property {string} [source] 数据源属性映射。从源值对象中提取该属性赋值给目标字段（fixed 为 false 、配置有此字段时有效，且有关联对象时有效）。\n * @property {boolean} [fixed] 是否为固定值模式。若为 true，则忽略动态计算，强制将目标字段设置为下方定义的 'set'\n * @property {*} [set] 固定值内容。作为目标字段的最终值（fixed 为 true 且有关联对象时有效）。\n * @property {boolean} [clear] 空值重置策略。若为 true，当源选项被清空（null/undefined）时，触发重置逻辑。\n * @property {*} [reset] 默认重置值。当触发重置时，将目标字段设置为此值（clear 为 true 、且无关联对象时有效）。\n * \n */\n/** @typedef {Record<string, string | Field.Binder> | (Field.Binder & { field: string; })[]} Field.Bind */\n/**\n * @typedef {Object} Field.Base\n * @property {string | Record<string, Field>} type 字段的基本类型\n * @property {boolean} [nullable] 是否可为空\n * @property {any} [default] 默认值\n * @property {boolean} [array] \n * \n * @property {number} [scale] 缩放比\n * @property {number} [primary] 是否为主键\n * @property {boolean} [uncreatable] 是否为可创建值\n * @property {boolean} [immutable] 是否为固定值\n * @property {number} [sort] 排序顺序，绝对值表示在排序列表中的顺序，负数表示逆序排序, 0 表示不排序\n * \n * \n * \n * @property {string} [options]\n * \n * @property {boolean} [quick]\n * @property {boolean} [translatable]\n * \n * @property {boolean} [ignorePermissions]\n * @property {boolean} [noCopy]\n */\n/**\n * @typedef {Object} Field.Extends\n * @property {number?} [no] - 字段序号\n * @property {string?} [label] - 字段的显示标签。\n * @property {string?} [description] - 字段的详细描述信息，可用于提示或帮助文本。\n * @property {string?} [placeholder] - 输入框等控件的占位提示文字。\n * @property {number?} [step] - 数值输入时的步长（如用于 number 类型 input 的 step 属性）。\n * @property {number?} [max] - 字段允许的最大值（常用于数值或日期类型校验）。\n * @property {number?} [min] - 字段允许的最小值（常用于数值或日期类型校验）。\n * @property {boolean} [readonly] - 是否只读，用户可聚焦但不可修改内容。\n * @property {boolean} [required] - 是否为必填项，用于表单验证。\n * @property {boolean} [clearable] - 是否支持清空操作（如带“×”按钮的输入框或选择器）。\n * @property {boolean} [disabled] - 是否禁用，禁用状态下用户无法交互且通常视觉上置灰。\n * @property {string} [group] - 字段所属的逻辑分组名称，用于权限分组。\n * @property {number} [layoutOrder] - 布局顺序\n * @property {({component: string; values?: any[]; [k: string]: any} | string)[] | {component: string; values?: any[]; [k: string]: any} | string} [renderer] - 渲染器配置数组\n * @property {(string | [string, object])[] | null} [scripts] - 脚本列表，可以是字符串或 [脚本名, 配置对象] 的元组\n * @property {Field.Layout} [layout] - 布局信息\n * @property {string} [model] - 关联模型\n * @property {Field.Bind} [bind]\n * @property {Field.Source | any[] | null} [source]\n */\n/** @typedef {Field.Base & Field.Extends} Field */\n\nexport const Field = {\n\t\n}\n","export * from './Field.mjs'\nexport * from './ModelService.mjs'\n/**\n * @typedef {Object} Tenant\n * @property {string} id - 租户的唯一标识符。\n * @property {string} label - 租户的名称。\n * @property {boolean} single - 指示该租户是否为单实例模式。\n * @property {Object.<string, string>} providers - 包含提供商名称及其对应值的键值对记录。\n * @property {Uint8Array<ArrayBuffer> | string} salt 加密盐\n */\n\n/**\n * @typedef {object} Permission 模型权限定义\n * @property {string} [permission] - 关联到的权限信息\n * @property {string | string[]} [group] - 字段分组\n * @property {string | string[]} [fields] - 字段\n * @property {Record<string, {value?: unknown; values?: unknown[]; user?: boolean}>} [constraints] - 字段信息约束\n * @property {string[] | Set<string>} [authorizations] - 授权列表\n * @property {string} [organizationField] - 可选，组织类型字段，其值为模型的组织类型字段，如果设置此项，则表示用户需要在文档此字段所示组织内由上述权限，此规则才生效\n */\n\n/**\n * @template T\n * @typedef {PromiseLike<T> | T} MaybePromise\n */\n\n/**\n * @typedef {object} Permissions\n * @property {(permission: string) => boolean} has\n * @property {number} size\n */\n\n\n/**\n * @typedef {object} PageForm\n * @property {string?} [layoutId]\n */\n\n/**\n * @typedef {object} FormLayout\n * @property {any} layout\n * @property {string} [type]\n * @property {boolean} [enableLink]\n * @property {boolean} [enableLinkEditable]\n */\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgHA,MAAa,QAAQ,EAEpB"}
|