@gct-paas/core 0.0.1-dev.15 → 0.0.1-dev.17

package/es/interface/form/i-form/i-form-edit-item.d.ts

@@ -0,0 +1,140 @@
+import { Rule } from 'async-validator';
+import { IDictionary } from '../../i-dictionary/i-dictionary';
+import { IEditorBasic } from '../i-editor/i-editor-basic';
+import { IFormItemBasic } from './i-form-item-basic';
+/**
+ * 表单编辑项
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 20:04:09
+ * @export
+ * @interface IFormEditItem
+ * @extends {IFormItemBasic}
+ */
+export interface IFormEditItem extends IFormItemBasic {
+    /**
+     * 项类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:44
+     * @type {'item'}
+     */
+    type: 'item' | 'hidden';
+    /**
+     * 表单项标识
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:25
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 表单项映射字段（用于提交数据，未指定时取 name）
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 10:04:17
+     * @type {string}
+     */
+    field?: string;
+    /**
+     * 默认值
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 20:04:11
+     * @type {*}
+     */
+    defaultValue?: unknown;
+    /**
+     * 编辑器
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:57
+     * @type {IEditorBasic}
+     */
+    editor: IEditorBasic;
+    /**
+     * 标题
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:50
+     * @type {string}
+     */
+    label?: string;
+    /**
+     * 标题后面加个问号的tooltip
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:50
+     * @type {string}
+     */
+    labelTooltip?: string;
+    /**
+     * 标题宽度
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 09:04:52
+     * @type {string}
+     */
+    labelWidth?: string;
+    /**
+     * 标题位置
+     * @author lingxiaoming
+     * @date 2024-07-18 11:36:31
+     * @type {('left' | 'top')}
+     */
+    labelPosition?: 'left' | 'top';
+    /**
+     * 开启后label不显示冒号
+     * @author lingxiaoming
+     * @date 2024-07-18 03:55:12
+     * @type {boolean}
+     */
+    noColon?: boolean;
+    /**
+     * label文字的对齐方式,默认right
+     * @author lingxiaoming
+     * @date 2024-07-18 03:56:31
+     * @type {('left' | 'right')}
+     */
+    labelAlign?: 'left' | 'right';
+    /**
+     * 编辑器的对齐方式,默认left
+     * @author lingxiaoming
+     * @date 2024-07-18 03:56:31
+     * @type {('left' | 'right')}
+     */
+    editorAlign?: 'left' | 'right';
+    /**
+     * 属性项
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 14:03:29
+     * @type {string[]}
+     */
+    fields?: string[];
+    /**
+     * 表单项规则
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 19:04:48
+     * @type {Rule[]>}
+     */
+    rules?: Rule[];
+    /**
+     * 代码表标识
+     *
+     * @description 用于从全局获取代码表的标识
+     * @author zhanghanrui
+     * @date 2024-04-02 21:04:06
+     * @type {string}
+     */
+    dictionaryTag?: string;
+    /**
+     * 代码表（数据字典），优先级高于 codeTag
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 21:04:58
+     * @type {IDictionary}
+     */
+    dictionary?: IDictionary;
+}

package/es/interface/form/i-form/i-form-edit-item.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/i-form/i-form-group-container.d.ts

@@ -0,0 +1,24 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单分组容器
+ *
+ * @author zhanghanrui
+ * @date 2024-03-28 15:03:32
+ * @export
+ * @interface IFormGroupContainer
+ * @extends {IFormContainer}
+ */
+export interface IFormGroupContainer extends IFormContainer {
+    /**
+     * 分组类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:44
+     * @type {'group'}
+     */
+    type: 'group';
+    /**
+     * 分组标题
+     */
+    title: string;
+}

package/es/interface/form/i-form/i-form-group-container.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/i-form/i-form-group.d.ts

@@ -0,0 +1,35 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单分组容器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 14:04:06
+ * @export
+ * @interface IFormGroup
+ * @extends {IFormContainer}
+ */
+export interface IFormGroup extends IFormContainer {
+    /**
+     * 分组标题
+     */
+    title?: string;
+    /**
+     * 是否显示标题
+     *
+     * @description 当值为 false 时，title 配置不生效。若不指定，title 有值时显示标题，否则不显示标题
+     * @author zhanghanrui
+     * @date 2024-04-01 18:04:57
+     * @type {boolean}
+     */
+    showHeader?: boolean;
+    /**
+     * 是否可折叠
+     *
+     * @description 当值为 true 时，showHeader 配置不生效
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-04-01 18:04:12
+     * @type {boolean}
+     */
+    isCollapse?: boolean;
+}

package/es/interface/form/i-form/i-form-group.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/i-form/i-form-hidden-item.d.ts

@@ -0,0 +1,11 @@
+import { IFormEditItem } from './i-form-edit-item';
+/**
+ * 隐藏表单项
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 14:04:13
+ * @export
+ * @interface IFormHiddenItem
+ * @extends {IFormEditItem}
+ */
+export type IFormHiddenItem = IFormEditItem;

package/es/interface/form/i-form/i-form-hidden-item.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/i-form/i-form-item-basic.d.ts

@@ -0,0 +1,126 @@
+import { IFlexItem, IGridItem } from '../../layout';
+import { IFormItemProvider } from '../../provider';
+import { IFormController, IFormEditItemController } from '../../controller';
+/**
+ * 表单项基础
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 20:03:37
+ * @export
+ * @interface IFormItemBasic
+ */
+export interface IFormItemBasic {
+    /**
+     * 项类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:30
+     * @type {string} 具体类型由子类定义
+     */
+    type: string;
+    /**
+     * 是否为容器
+     *
+     * @type {boolean}
+     */
+    container?: boolean;
+    /**
+     * 表单项名称
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:43
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 表单项高度
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 15:04:02
+     * @type {string}
+     */
+    height?: string;
+    /**
+     * 表单项宽度
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 15:04:24
+     * @type {string}
+     */
+    width?: string;
+    /**
+     * 内间距
+     *
+     * @author zhanghanrui
+     * @date 2024-06-06 17:06:30
+     * @type {string}
+     */
+    padding?: string;
+    /**
+     * 外间距
+     *
+     * @author zhanghanrui
+     * @date 2024-06-06 17:06:16
+     * @type {string}
+     */
+    margin?: string;
+    /**
+     * 容器作为 flex 布局子元素的参数
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 11:03:35
+     * @type {IFlexItem}
+     */
+    flexItem?: IFlexItem;
+    /**
+     * 容器作为栅格布局子元素的参数
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 11:03:56
+     * @type {IGridItem}
+     */
+    gridItem?: IGridItem;
+    /**
+     * 额外的类名
+     * @author lingxiaoming
+     * @date 2024-07-18 01:05:19
+     * @type {*}
+     */
+    class?: string[];
+    /**
+     * 额外行内的样式
+     * @author lingxiaoming
+     * @date 2024-07-18 01:05:33
+     * @type {StyleValue}
+     */
+    style?: IParams;
+    /**
+     * 独立适配器
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 13:04:21
+     */
+    provider?: (...args: unknown[]) => IFormItemProvider;
+    /**
+     * 表单项隐藏计算
+     *
+     * @author zhanghanrui
+     * @date 2024-08-01 11:08:16
+     * @param {IFormController} form 表单控制器实例
+     * @param {IFormEditItemController} item 当前表单项控制器实例
+     * @param {IData} data 表单数据
+     * @return {*}  {boolean}
+     */
+    hidden?(form: IFormController, item: IFormEditItemController, data: IData): boolean;
+    /**
+     * 表单项值变更
+     *
+     * @author zhanghanrui
+     * @date 2024-08-02 16:08:41
+     * @param {IFormController} form 表单控制器实例
+     * @param {IFormEditItemController} item 当前表单项控制器实例
+     * @param {*} [val] 变更后的值
+     * @param {*} [oldVal] 变更前的值
+     */
+    watch?(form: IFormController, item: IFormEditItemController, val?: any, oldVal?: any): void;
+}

package/es/interface/form/i-form/i-form-item-basic.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/i-form/i-form-item.d.ts

@@ -0,0 +1,11 @@
+import { IFormEditItem } from './i-form-edit-item';
+/**
+ * 表单项
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 20:03:57
+ * @export
+ * @interface IFormItem
+ * @extends {IFormEditItem}
+ */
+export type IFormItem = IFormEditItem;

package/es/interface/form/i-form/i-form-item.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/i-form/i-form-tab-pane.d.ts

@@ -0,0 +1,19 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单分页容器
+ * @author lingxiaoming
+ * @date 2024-07-14 01:38:20
+ * @export
+ * @interface IFormTab
+ * @extends {IFormContainer}
+ */
+export interface IFormTabPane extends IFormContainer {
+    type: 'tab-pane';
+    /**
+     * 分页标题
+     * @author lingxiaoming
+     * @date 2024-07-14 01:43:06
+     * @type {string}
+     */
+    title: string;
+}

package/es/interface/form/i-form/i-form-tab-pane.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/i-form/i-form-tab.d.ts

@@ -0,0 +1,21 @@
+import { IFormContainer } from './i-form-container';
+import { IFormTabPane } from './i-form-tab-pane';
+/**
+ * 表单分页容器
+ * @author lingxiaoming
+ * @date 2024-07-14 01:38:20
+ * @export
+ * @interface IFormTab
+ * @extends {IFormContainer}
+ */
+export interface IFormTab extends IFormContainer {
+    type: 'tab';
+    children?: IFormTabPane[];
+    /**
+     * 导航位置
+     * @author lingxiaoming
+     * @date 2024-07-15 01:19:44
+     * @type {('center' | 'left' | 'right')}
+     */
+    navPosition?: 'center' | 'left' | 'right';
+}

package/es/interface/form/i-form/i-form-tab.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/i-form/i-form.d.ts

@@ -0,0 +1,72 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 20:03:14
+ * @export
+ * @interface IForm
+ */
+export interface IForm {
+    /**
+     * 表单类型
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 11:03:21
+     * @type {('edit' | 'search')} 编辑表单 | 搜索表单
+     */
+    type: 'edit' | 'search';
+    /**
+     * 表单布局方式
+     *
+     * @author zhanghanrui
+     * @date 2024-04-08 13:04:59
+     * @type {('horizontal' | 'vertical' | 'inline')}
+     */
+    layout?: 'horizontal' | 'vertical' | 'inline';
+    /**
+     * 是否为信息表单，只读模式
+     *
+     * @author zhanghanrui
+     * @date 2024-04-08 14:04:13
+     * @type {boolean}
+     */
+    info?: boolean;
+    /**
+     * 不显示[冒号]
+     *
+     * @description 默认显示冒号
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-07-29 15:07:52
+     * @type {boolean}
+     */
+    noColon?: boolean;
+    /**
+     * 表单项标题默认宽度
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 09:04:44
+     * @type {string}
+     */
+    labelWidth?: string | number;
+    /**
+     * 表单项
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 20:03:39
+     * @type {IFormContainer[]}
+     */
+    children: IFormContainer[];
+    /**
+     * 加载数据
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 16:04:27
+     * @param {{ id: string }} params
+     * @return {*}  {Promise<IData>}
+     */
+    loadRequest?(params: {
+        id: string;
+    }): Promise<IData>;
+}

package/es/interface/form/i-form/i-form.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/form/index.d.ts

@@ -0,0 +1,28 @@
+export type { ILengthUnitEditor } from './i-editor/i-length-unit-editor';
+export type { IColorEditor } from './i-editor/i-color-editor';
+export type { IEditorBasic } from './i-editor/i-editor-basic';
+export type { IIconSelectEditor } from './i-editor/i-icon-select-editor';
+export type { IInfoEditor } from './i-editor/i-info-editor';
+export type { INumberEditor } from './i-editor/i-number-editor';
+export type { IPickerEditor } from './i-editor/i-picker-editor';
+export type { ISelectEditor } from './i-editor/i-select-editor';
+export type { ISpanEditor } from './i-editor/i-span-editor';
+export type { ITextEditor } from './i-editor/i-text-editor';
+export type { ITextareaEditor } from './i-editor/i-textarea-editor';
+export type { ISwitchEditor } from './i-editor/i-switch-editor';
+export type { ICheckSwitchEditor } from './i-editor/i-check-switch';
+export type { IRadioEditor } from './i-editor/i-radio-editor';
+export type { ICheckboxEditor } from './i-editor/i-checkbox-editor';
+export type { IFormCollapsePane } from './i-form/i-form-collapse-pane';
+export type { IFormCollapse } from './i-form/i-form-collapse';
+export type { IEditForm } from './i-form/i-edit-form';
+export type { IFormContainer } from './i-form/i-form-container';
+export type { IFormEditItem } from './i-form/i-form-edit-item';
+export type { IFormGroupContainer } from './i-form/i-form-group-container';
+export type { IFormGroup } from './i-form/i-form-group';
+export type { IFormTab } from './i-form/i-form-tab';
+export type { IFormTabPane } from './i-form/i-form-tab-pane';
+export type { IFormHiddenItem } from './i-form/i-form-hidden-item';
+export type { IFormItemBasic } from './i-form/i-form-item-basic';
+export type { IFormItem } from './i-form/i-form-item';
+export type { IForm } from './i-form/i-form';

package/es/interface/form/index.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/i-dictionary/i-dictionary-item.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 数据字典项
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 21:04:23
+ * @export
+ * @interface IDictionaryItem
+ */
+export interface IDictionaryItem {
+    /**
+     * 名称
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 13:03:41
+     * @type {string}
+     */
+    label: string;
+    /**
+     * 值
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 13:03:46
+     * @type {(string | number)}
+     */
+    value: string | number;
+    /**
+     * 显示图标
+     *
+     * @type {string}
+     */
+    icon?: string;
+    /**
+     * 是否禁用
+     *
+     * @author zhanghanrui
+     * @date 2024-10-16 09:10:22
+     * @type {boolean}
+     */
+    disabled?: boolean;
+    /**
+     * 递归子项
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 21:04:31
+     * @type {IDictionaryItem[]}
+     */
+    options?: IDictionaryItem[];
+}

package/es/interface/i-dictionary/i-dictionary-item.mjs

@@ -0,0 +1 @@
+"use strict";

package/es/interface/i-dictionary/i-dictionary.d.ts

@@ -0,0 +1,52 @@
+import { IDictionaryItem } from './i-dictionary-item';
+/**
+ * 数据字典配置
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 21:04:01
+ * @export
+ * @interface IDictionary
+ */
+export interface IDictionary {
+    /**
+     * 代码表标识
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 13:03:25
+     * @type {string}
+     */
+    tag: string;
+    /**
+     * 代码表模式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 13:03:09
+     * @type {('static' | 'async')} static: 静态 async: 异步
+     */
+    mode: 'static' | 'async';
+    /**
+     * 用于异步代码表获取
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 13:03:25
+     * @param {IParams} params
+     * @return {*}  {Promise<IData[]>}
+     */
+    fetch?(params: IParams): Promise<IData[]>;
+    /**
+     * 指定数据字典项的键值属性，动态代码表需要。若不配置动态代码表默认取 id 和 name
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 21:04:06
+     * @type {[labelKey: string, valueKey: string]}
+     */
+    keys?: [labelKey: string, valueKey: string];
+    /**
+     * 代码表项
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 21:04:29
+     * @type {IDictionaryItem[]}
+     */
+    items?: IDictionaryItem[];
+}

package/es/interface/i-dictionary/i-dictionary.mjs

@@ -0,0 +1 @@
+"use strict";