@yongdall/types 0.1.0

package/index.d.mts

@@ -0,0 +1,268 @@
+//#region packages/types/Field.d.mts
+type Field = {
+  /**
+   * 字段的基本类型
+   */
+  type: string | Record<string, Field>;
+  /**
+   * 是否可为空
+   */
+  nullable?: boolean | undefined;
+  /**
+   * 默认值
+   */
+  default?: any;
+  renderer?: string | {
+    [k: string]: any;
+    component: string;
+  } | (string | {
+    [k: string]: any;
+    component: string;
+  })[] | undefined;
+  array?: boolean | undefined;
+  /**
+   * 缩放比
+   */
+  scale?: number | undefined;
+  /**
+   * 是否为主键
+   */
+  primary?: number | undefined;
+  /**
+   * 是否为可创建值
+   */
+  uncreatable?: boolean | undefined;
+  /**
+   * 是否为固定值
+   */
+  immutable?: boolean | undefined;
+  /**
+   * 排序顺序，绝对值表示在排序列表中的顺序，负数表示逆序排序, 0 表示不排序
+   */
+  sort?: number | undefined;
+  /**
+   * 权限配置
+   */
+  group?: string | undefined;
+  /**
+   * 行终点
+   */
+  layout?: Field.Layout | undefined;
+  layoutOrder?: number | undefined;
+  model?: string | undefined;
+  scripts?: (string | [string, object])[] | null | undefined;
+  readonly?: boolean | undefined;
+  required?: boolean | undefined;
+  clearable?: boolean | undefined;
+  disabled?: boolean | undefined;
+  label?: string | null | undefined;
+  description?: string | null | undefined;
+  placeholder?: string | null | undefined;
+  step?: number | null | undefined;
+  max?: number | null | undefined;
+  min?: number | null | undefined;
+  options?: string | undefined;
+  quick?: boolean | undefined;
+  translatable?: boolean | undefined;
+  ignorePermissions?: boolean | undefined;
+  noCopy?: boolean | undefined;
+};
+/**
+ * @typedef {Object} Field.Layout.Column
+ * @property {string[]} [actions] 操作
+ * @property {string} [action] 操作
+ * @property {string} [field] 字段
+ * @property {number} [placeholder] 占位符
+ * @property {string} [pattern] 模式
+ * @property {number} [width] 宽度
+ * @property {string} [label] 标签
+ */
+/**
+ * @typedef {Object} Field.Layout
+ * @property {number} [colSpan] 占用列数
+ * @property {number} [colStart] 列起点
+ * @property {number} [colEnd] 列终点
+ * @property {number} [rowSpan] 占用行数
+ * @property {number} [rowStart] 行起点
+ * @property {number} [rowEnd] 行终点
+ * @property {string} [levelKey]
+ * @property {number} [head]
+ * @property {boolean} [hidden]
+ * @property {Field.Layout.Column[]} [columns]
+ */
+/**
+ * @typedef {Object} Field
+ * @property {string | Record<string, Field>} type 字段的基本类型
+ * @property {boolean} [nullable] 是否可为空
+ * @property {any} [default] 默认值
+ * @property {({component: string; [k: string]: any} | string)[] | {component: string; [k: string]: any} | string} [renderer]
+ * @property {boolean} [array]
+ *
+ * @property {number} [scale] 缩放比
+ * @property {number} [primary] 是否为主键
+ * @property {boolean} [uncreatable] 是否为可创建值
+ * @property {boolean} [immutable] 是否为固定值
+ * @property {number} [sort] 排序顺序，绝对值表示在排序列表中的顺序，负数表示逆序排序, 0 表示不排序
+ *
+ * @property {string} [group] 权限配置
+ *
+ * @property {Field.Layout} [layout] 行终点
+ *
+ * @property {number} [layoutOrder]
+ *
+ *
+ * @property {string} [model]
+ *
+ * @property {(string | [string, object])[] | null} [scripts]
+ *
+ * @property {boolean} [readonly]
+ * @property {boolean} [required]
+ * @property {boolean} [clearable]
+ * @property {boolean} [disabled]
+ *
+ * @property {string?} [label]
+ * @property {string?} [description]
+ * @property {string?} [placeholder]
+ * @property {number?} [step]
+ * @property {number?} [max]
+ * @property {number?} [min]
+ *
+ *
+ *
+ *
+ *
+ * @property {string} [options]
+ *
+ * @property {boolean} [quick]
+ * @property {boolean} [translatable]
+ *
+ * @property {boolean} [ignorePermissions]
+ * @property {boolean} [noCopy]
+ */
+declare const Field: {};
+declare namespace Field {
+  type Layout = {
+    /**
+     * 占用列数
+     */
+    colSpan?: number | undefined;
+    /**
+     * 列起点
+     */
+    colStart?: number | undefined;
+    /**
+     * 列终点
+     */
+    colEnd?: number | undefined;
+    /**
+     * 占用行数
+     */
+    rowSpan?: number | undefined;
+    /**
+     * 行起点
+     */
+    rowStart?: number | undefined;
+    /**
+     * 行终点
+     */
+    rowEnd?: number | undefined;
+    levelKey?: string | undefined;
+    head?: number | undefined;
+    hidden?: boolean | undefined;
+    columns?: Field.Layout.Column[] | undefined;
+  };
+  namespace Layout {
+    type Column = {
+      /**
+       * 操作
+       */
+      actions?: string[] | undefined;
+      /**
+       * 操作
+       */
+      action?: string | undefined;
+      /**
+       * 字段
+       */
+      field?: string | undefined;
+      /**
+       * 占位符
+       */
+      placeholder?: number | undefined;
+      /**
+       * 模式
+       */
+      pattern?: string | undefined;
+      /**
+       * 宽度
+       */
+      width?: number | undefined;
+      /**
+       * 标签
+       */
+      label?: string | undefined;
+    };
+  }
+}
+//#endregion
+//#region packages/types/index.d.mts
+type Tenant = {
+  /**
+   * - 租户的唯一标识符。
+   */
+  id: string;
+  /**
+   * - 租户的名称。
+   */
+  label: string;
+  /**
+   * - 指示该租户是否为单实例模式。
+   */
+  single: boolean;
+  /**
+   * - 包含提供商名称及其对应值的键值对记录。
+   */
+  providers: {
+    [x: string]: string;
+  };
+  /**
+   * 加密盐
+   */
+  salt: Uint8Array<ArrayBuffer> | string;
+};
+/**
+ * 模型权限定义
+ */
+type Permission = {
+  /**
+   * - 关联到的权限信息
+   */
+  permission?: string | undefined;
+  /**
+   * - 字段分组
+   */
+  group?: string | string[] | undefined;
+  /**
+   * - 字段
+   */
+  fields?: string | string[] | undefined;
+  /**
+   * - 字段信息约束
+   */
+  constraints?: Record<string, {
+    value?: unknown;
+    values?: unknown[];
+    user?: boolean;
+  }> | undefined;
+  /**
+   * - 授权列表
+   */
+  authorizations?: string[] | Set<string> | undefined;
+  /**
+   * - 可选，组织类型字段，其值为模型的组织类型字段，如果设置此项，则表示用户需要在文档此字段所示组织内由上述权限，此规则才生效
+   */
+  organizationField?: string | undefined;
+};
+type MaybePromise<T> = PromiseLike<T> | T;
+//#endregion
+export { Field, MaybePromise, Permission, Tenant };

package/index.mjs

@@ -0,0 +1,102 @@
+//#region packages/types/Field.mjs
+/**
+* @typedef {Object} Field.Layout.Column
+* @property {string[]} [actions] 操作
+* @property {string} [action] 操作
+* @property {string} [field] 字段
+* @property {number} [placeholder] 占位符
+* @property {string} [pattern] 模式
+* @property {number} [width] 宽度
+* @property {string} [label] 标签
+*/
+/**
+* @typedef {Object} Field.Layout
+* @property {number} [colSpan] 占用列数
+* @property {number} [colStart] 列起点
+* @property {number} [colEnd] 列终点
+* @property {number} [rowSpan] 占用行数
+* @property {number} [rowStart] 行起点
+* @property {number} [rowEnd] 行终点
+* @property {string} [levelKey]
+* @property {number} [head]
+* @property {boolean} [hidden]
+* @property {Field.Layout.Column[]} [columns]
+*/
+/**
+* @typedef {Object} Field
+* @property {string | Record<string, Field>} type 字段的基本类型
+* @property {boolean} [nullable] 是否可为空
+* @property {any} [default] 默认值
+* @property {({component: string; [k: string]: any} | string)[] | {component: string; [k: string]: any} | string} [renderer]
+* @property {boolean} [array] 
+* 
+* @property {number} [scale] 缩放比
+* @property {number} [primary] 是否为主键
+* @property {boolean} [uncreatable] 是否为可创建值
+* @property {boolean} [immutable] 是否为固定值
+* @property {number} [sort] 排序顺序，绝对值表示在排序列表中的顺序，负数表示逆序排序, 0 表示不排序
+* 
+* @property {string} [group] 权限配置
+* 
+* @property {Field.Layout} [layout] 行终点
+* 
+* @property {number} [layoutOrder]
+* 
+* 
+* @property {string} [model]
+* 
+* @property {(string | [string, object])[] | null} [scripts]
+* 
+* @property {boolean} [readonly]
+* @property {boolean} [required]
+* @property {boolean} [clearable]
+* @property {boolean} [disabled]
+* 
+* @property {string?} [label]
+* @property {string?} [description]
+* @property {string?} [placeholder]
+* @property {number?} [step]
+* @property {number?} [max]
+* @property {number?} [min]
+* 
+* 
+* 
+* 
+* 
+* @property {string} [options]
+* 
+* @property {boolean} [quick]
+* @property {boolean} [translatable]
+* 
+* @property {boolean} [ignorePermissions]
+* @property {boolean} [noCopy]
+*/
+const Field = {};
+
+//#endregion
+//#region packages/types/index.mjs
+/**
+* @typedef {Object} Tenant
+* @property {string} id - 租户的唯一标识符。
+* @property {string} label - 租户的名称。
+* @property {boolean} single - 指示该租户是否为单实例模式。
+* @property {Object.<string, string>} providers - 包含提供商名称及其对应值的键值对记录。
+* @property {Uint8Array<ArrayBuffer> | string} salt 加密盐
+*/
+/**
+* @typedef {object} Permission 模型权限定义
+* @property {string} [permission] - 关联到的权限信息
+* @property {string | string[]} [group] - 字段分组
+* @property {string | string[]} [fields] - 字段
+* @property {Record<string, {value?: unknown; values?: unknown[]; user?: boolean}>} [constraints] - 字段信息约束
+* @property {string[] | Set<string>} [authorizations] - 授权列表
+* @property {string} [organizationField] - 可选，组织类型字段，其值为模型的组织类型字段，如果设置此项，则表示用户需要在文档此字段所示组织内由上述权限，此规则才生效
+*/
+/**
+* @template T
+* @typedef {PromiseLike<T> | T} MaybePromise
+*/
+
+//#endregion
+export { Field };
+//# sourceMappingURL=index.mjs.map

package/index.mjs.map

@@ -0,0 +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 * @typedef {Object} Field\n * @property {string | Record<string, Field>} type 字段的基本类型\n * @property {boolean} [nullable] 是否可为空\n * @property {any} [default] 默认值\n * @property {({component: string; [k: string]: any} | string)[] | {component: string; [k: string]: any} | string} [renderer]\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 * @property {string} [group] 权限配置\n * \n * @property {Field.Layout} [layout] 行终点\n * \n * @property {number} [layoutOrder]\n * \n * \n * @property {string} [model]\n * \n * @property {(string | [string, object])[] | null} [scripts]\n * \n * @property {boolean} [readonly]\n * @property {boolean} [required]\n * @property {boolean} [clearable]\n * @property {boolean} [disabled]\n * \n * @property {string?} [label]\n * @property {string?} [description]\n * @property {string?} [placeholder]\n * @property {number?} [step]\n * @property {number?} [max]\n * @property {number?} [min]\n * \n * \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\nexport const Field = {\n\t\n}\n","export * from './Field.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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0EA,MAAa,QAAQ,EAEpB"}

package/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@yongdall/types",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./index.mjs",
+  "exports": {
+    ".": "./index.mjs"
+  }
+}