@kengic/vue 0.30.1-beta.8 → 0.30.1-beta.81

package/dist/src/const/const.model.d.ts

@@ -1,12 +1,13 @@
-import { type TooltipProps } from 'ant-design-vue';
+import { FormInstance, type TooltipProps } from 'ant-design-vue';
 import { ModalFuncProps } from 'ant-design-vue/lib/modal/Modal';
 import { Pinia, StoreOnActionListener } from 'pinia';
-import { KgModalProps } from '../component';
+import { ComputedRef, InjectionKey, Ref } from 'vue';
+import { IKgProps, IKgSlots, KgModalProps } from '../component';
 /**
  * 常量.
  * TODO LT 将所有常量都统一放到这个常量中
  */
-export declare const KG_CONST: {
+export declare const KG: {
     /**
      * 数据库的列的类型.
      */
@@ -33,21 +34,547 @@ export declare const KG_CONST: {
      */
     DESCRIPTION_KEY: {
         /**
-         * 所有翻译.
+         * 该组件库的所有翻译.
+         */
+        KG: string;
+        /**
+         * 前端项目的所有翻译, 包含 PDA 的.
+         */
+        WEB: string;
+    };
+    /**
+     * 依赖注入的键.
+     */
+    DI: {
+        /**
+         * 界面标识.
+         */
+        FORM_ID: InjectionKey<string>;
+        /**
+         * 唯一标识.
+         */
+        ID: InjectionKey<string>;
+        /**
+         * 画布.
+         */
+        KG_CANVAS: {
+            /**
+             * 组件参数.
+             */
+            PROPS: InjectionKey<Partial<import("vue").ExtractPropTypes<{
+                id: {
+                    /**
+                     * 表单.
+                     */
+                    type: import("vue").PropType<string>;
+                    required: boolean;
+                };
+                kg$ContextMenu$Reload$IsAvailable: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+                kg$KgCanvasToolbarButtonMode$IsAvailable: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+                kgCanvasToolbarFullscreen: {
+                    type: import("vue").PropType<Partial<import("vue").ExtractPropTypes<{
+                        kgIsShowText: {
+                            type: import("vue").PropType<boolean>;
+                            default: boolean;
+                        };
+                    }>>>;
+                };
+                kgIsEditable: {
+                    type: import("vue").PropType<boolean>; /**
+                     * 变量名称.
+                     */
+                    default: boolean;
+                };
+                kgIsEnableOverview: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+                kgIsGridBackground: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+                kgIsResizable: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+            }>>>;
+        };
+        /**
+         * 表单.
+         */
+        KG_FORM: {
+            /**
+             * <p>依赖注入表单数据对象.</p>
+             * <p>在表单组件(KgForm)的任何下级组件中, 都可以通过注入获取表单数据对象.</p>
+             */
+            FORM_MODEL: InjectionKey<ComputedRef<Record<string, any>>>;
+            /**
+             * formRef.
+             */
+            FORM_REF: InjectionKey<Ref<FormInstance | null>>;
+        };
+        /**
+         * 表单控件.
+         */
+        KG_FORM_ITEM: {
+            /**
+             * 变量名称.
+             */
+            CONTEXT: InjectionKey<KG_FORM_CONTEXT>;
+            /**
+             * 变量名称.
+             */
+            VAR_NAME: InjectionKey<string>;
+        };
+        /**
+         * 模拟器.
+         */
+        KG_SIMULATOR: {
+            /**
+             * 左下侧面板.
+             */
+            PANEL__LEFT_BOTTOM__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 左上侧面板.
+             */
+            PANEL__LEFT_TOP__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 右下侧面板.
+             */
+            PANEL__RIGHT_BOTTOM__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 右上侧面板.
+             */
+            PANEL__RIGHT_TOP__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 左下侧工具栏.
+             */
+            TOOLBAR__LEFT_BOTTOM__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 左上侧工具栏.
+             */
+            TOOLBAR__LEFT_TOP__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 右下侧工具栏.
+             */
+            TOOLBAR__RIGHT_BOTTOM__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 右上侧工具栏.
+             */
+            TOOLBAR__RIGHT_TOP__TELEPORT_ID: InjectionKey<string>;
+        };
+        /**
+         * 变量页面.
+         */
+        KG_VAR: {
+            /**
+             * 注入 kgProps 参数.
+             */
+            KG_PROPS: InjectionKey<ComputedRef<IKgProps | undefined>>;
+            /**
+             * 注入 kgSlots 参数.
+             */
+            KG_SLOTS: InjectionKey<IKgSlots | undefined>;
+        };
+        /**
+         * 变量配置弹窗.
+         */
+        KG_VAR_CONFIG: {
+            /**
+             * 正在被配置的界面标识.
+             */
+            HOST_FORM_ID: InjectionKey<Ref<string | null>>;
+        };
+        /**
+         * 「变量配置:查找弹窗」.
+         */
+        VAR_CONFIG_LOOKUP: {
+            /**
+             * 宿主界面标识.
+             */
+            HOST_FORM_ID: InjectionKey<string>;
+            /**
+             * 变量查找编号.
+             */
+            LOOKUP_ID: InjectionKey<string>;
+        };
+    };
+    /**
+     * 高级查询的操作符.
+     */
+    DYNAMIC_QUERY_OPERATOR: {
+        /** 范围之内. */
+        BETWEEN: string;
+        /** 包含. */
+        CONTAIN: string;
+        /** 为空. */
+        EMPTY: string;
+        /** 以之结束. */
+        END_WITH: string;
+        /** 等于. */
+        EQ: string;
+        /** 大于. */
+        GT: string;
+        /** 大于等于. */
+        GTE: string;
+        /** 属于. */
+        IN: string;
+        /** 小于. */
+        LT: string;
+        /** 小于等于. */
+        LTE: string;
+        /** 不等于. */
+        NE: string;
+        /** 不为空. */
+        NOT_EMPTY: string;
+        /** 以之开始. */
+        START_WITH: string;
+    };
+    /**
+     * HTTP 请求头.
+     */
+    HTTP_HEADER: {
+        KG_BUTTON_VAR_NAME: string;
+        /**
+         * 数据库的类型.
+         */
+        KG_DB_TYPE: string;
+        /** 界面标识. */
+        KG_FORM_ID: string;
+        /** 是否启用高级查询. */
+        KG_IS_DYNAMIC_QUERY: string;
+        /** 当前页码. */
+        KG_PAGE_INDEX: string;
+        /** 每页条数. */
+        KG_PAGE_SIZE: string;
+        /**
+         * <p>高级查询时, 每个查询字段的参数值.</p>
+         * <p>是一个 JSON 字符串, 由后端进行解析. 其中的 key 表示查询字段的名称, 其中的 value 表示查询字段的值.</p>
+         */
+        KG_QUERY_OBJECT: string;
+        /**
+         * <p>高级查询时, 每个查询字段的操作符.</p>
+         * <p>是一个 JSON 字符串, 由后端进行解析. 其中的 key 表示查询字段的名称, 其中的 value 表示查询字段的操作符.</p>
+         */
+        KG_QUERY_OPERATOR_OBJECT: string;
+        /** 查询语句中的 ORDER BY 片段. */
+        KG_QUERY_ORDER_BY_SQL: string;
+        /**
+         * <p>高级查询时, 每个查询字段的 WHERE 片段.</p>
+         * <p>是一个 JSON 字符串, 由后端进行解析. 其中的 key 表示查询字段的名称, 其中的 value 表示查询字段的 WHERE 片段.</p>
+         */
+        KG_QUERY_WHERE_OBJECT: string;
+        /** 查询语句中的 WHERE 片段. */
+        KG_QUERY_WHERE_SQL: string;
+        /** 查询语句中的 WHERE 片段. */
+        KG_QUERY_WHERE_SQL_01: string;
+        /** 查询语句中的 WHERE 片段. */
+        KG_QUERY_WHERE_SQL_02: string;
+        /** 查询语句中的 WHERE 片段. */
+        KG_QUERY_WHERE_SQL_03: string;
+        /** 查询语句中的 WHERE 片段. */
+        KG_QUERY_WHERE_SQL_04: string;
+        /** 查询语句中的 WHERE 片段. */
+        KG_QUERY_WHERE_SQL_05: string;
+        /**
+         * 仓库编号.
+         */
+        KG_WAREHOUSE: string;
+        /**
+         * 工作区.
+         */
+        KG_WORK_AREA: string;
+        /**
+         * 工作站.
+         */
+        KG_WORK_STATION: string;
+    };
+    VAR_CONFIG_CONTROL: {
+        /**
+         * 表单控件类型.
+         * @see VarConfigControl.ctrl_prop
+         * @see IKgVarConfigControlControlProperties
+         */
+        CONTROL_TYPE: {
+            /** 文件上传按钮. */
+            BUTTON_UPLOAD: string;
+            /** 多选框. */
+            CHECKBOX: string;
+            /**
+             * <p>多选框列表.</p>
+             * <p>配置属性参见 {@link IKgVarConfigControlControlProperties.CHECKBOX_GROUP}.</p>
+             */
+            CHECKBOX_GROUP: string;
+            /** 年月日, 2020-05-01. */
+            DATE_DATE: string;
+            /** 年月日时分秒, 2020-05-01 11:59:59. */
+            DATE_DATETIME: string;
+            /** 年月日时分秒的范围, [DATE_DATETIME, DATE_DATETIME] */
+            DATE_DATETIME_RANGE: string;
+            /** 年月日的范围, [DATE_DATE, DATE_DATE] */
+            DATE_DATE_RANGE: string;
+            DATE_MONTH: string;
+            /** 时分秒, 11:59:59. */
+            DATE_TIME: string;
+            /** 时分秒的范围, [DATE_TIME, DATE_TIME]. */
+            DATE_TIME_RANGE: string;
+            DATE_WEEK: string;
+            DATE_YEAR: string;
+            /**
+             * <p>图片.</p>
+             * <p>点击可以预览.</p>
+             */
+            IMAGE: string;
+            /** 单行文本. */
+            INPUT: string;
+            /** 数字. */
+            INPUT_NUMBER: string;
+            /** 密码. */
+            INPUT_PASSWORD: string;
+            /** 链接. */
+            LINK: string;
+            /**
+             * <p>单选框列表.</p>
+             * <p>配置属性参见 {@link IKgVarConfigControlControlProperties.RADIO_GROUP}.</p>
+             */
+            RADIO_GROUP: string;
+            /**
+             * <p>单选下拉列表.<p>
+             * <p>配置属性参见 {@link IKgVarConfigControlControlProperties.SELECT}.</p>
+             */
+            SELECT: string;
+            /** 多选下拉列表. */
+            SELECT_MULTIPLE: string;
+            /** 开关. */
+            SWITCH: string;
+            /**
+             * <p>多行文本.</p>
+             * <p>配置属性参见 {@link IKgVarConfigControlControlProperties.TEXT_AREA}.</p>
+             */
+            TEXT_AREA: string;
+        };
+    };
+    /**
+     * 用于添加的行.
+     * 在「查询条件」「提交字段」「表格视图」中, 用户可以自己添加额外的行, 作为「查询字段」「提交字段」「表格的列」,
+     * 为了操作方便, 会在表格中始终显示一个特殊的行, 称之为「用于添加的行」, 点击该行左侧的加号就可以添加新的行, 本常量用来作为该特殊的行的 ID.
+     */
+    __KG__CREATE_ROW_ID__: string;
+    /**
+     * 用户添加的行.
+     * 在「查询条件」「提交字段」「表格视图」中, 用户可以自己添加额外的行, 作为「查询字段」「提交字段」「表格的列」, 本常量用来作为该行的 ID.
+     */
+    __KG__CUSTOM_ROW_ID__: string;
+    __KG__NULL__: string;
+    /**
+     * 在表格内创建时, 空白行的临时主键.
+     */
+    __KG__TABLE_TEMP_ID__: string;
+};
+/** @deprecated 已弃用, 请使用 {@link KG}. */
+export declare const KG_CONST: {
+    /**
+     * 数据库的列的类型.
+     */
+    DB_COLUMN_TYPE: {
+        NCHAR: string;
+        NVARCHAR: string;
+    };
+    /**
+     * 数据库的类型.
+     */
+    DB_TYPE: {
+        /**
+         * 达梦.
          */
-        ALL: string;
+        DM: string;
+        MYSQL: string;
+        ORACLE: string;
+        POSTGRESQL: string;
+        SQLITE: string;
+        SQLSERVER: string;
+    };
+    /**
+     * 描述表中的键.
+     */
+    DESCRIPTION_KEY: {
         /**
          * 该组件库的所有翻译.
          */
         KG: string;
         /**
-         * 手持项目的所有翻译.
+         * 前端项目的所有翻译, 包含 PDA 的.
          */
-        PDA: string;
+        WEB: string;
+    };
+    /**
+     * 依赖注入的键.
+     */
+    DI: {
         /**
-         * 网页前端项目的所有翻译.
+         * 界面标识.
          */
-        WEB: string;
+        FORM_ID: InjectionKey<string>;
+        /**
+         * 唯一标识.
+         */
+        ID: InjectionKey<string>;
+        /**
+         * 画布.
+         */
+        KG_CANVAS: {
+            /**
+             * 组件参数.
+             */
+            PROPS: InjectionKey<Partial<import("vue").ExtractPropTypes<{
+                id: {
+                    /**
+                     * 表单.
+                     */
+                    type: import("vue").PropType<string>;
+                    required: boolean;
+                };
+                kg$ContextMenu$Reload$IsAvailable: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+                kg$KgCanvasToolbarButtonMode$IsAvailable: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+                kgCanvasToolbarFullscreen: {
+                    type: import("vue").PropType<Partial<import("vue").ExtractPropTypes<{
+                        kgIsShowText: {
+                            type: import("vue").PropType<boolean>;
+                            default: boolean;
+                        };
+                    }>>>;
+                };
+                kgIsEditable: {
+                    type: import("vue").PropType<boolean>; /**
+                     * 变量名称.
+                     */
+                    default: boolean;
+                };
+                kgIsEnableOverview: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+                kgIsGridBackground: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+                kgIsResizable: {
+                    type: import("vue").PropType<boolean>;
+                    default: boolean;
+                };
+            }>>>;
+        };
+        /**
+         * 表单.
+         */
+        KG_FORM: {
+            /**
+             * <p>依赖注入表单数据对象.</p>
+             * <p>在表单组件(KgForm)的任何下级组件中, 都可以通过注入获取表单数据对象.</p>
+             */
+            FORM_MODEL: InjectionKey<ComputedRef<Record<string, any>>>;
+            /**
+             * formRef.
+             */
+            FORM_REF: InjectionKey<Ref<FormInstance | null>>;
+        };
+        /**
+         * 表单控件.
+         */
+        KG_FORM_ITEM: {
+            /**
+             * 变量名称.
+             */
+            CONTEXT: InjectionKey<KG_FORM_CONTEXT>;
+            /**
+             * 变量名称.
+             */
+            VAR_NAME: InjectionKey<string>;
+        };
+        /**
+         * 模拟器.
+         */
+        KG_SIMULATOR: {
+            /**
+             * 左下侧面板.
+             */
+            PANEL__LEFT_BOTTOM__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 左上侧面板.
+             */
+            PANEL__LEFT_TOP__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 右下侧面板.
+             */
+            PANEL__RIGHT_BOTTOM__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 右上侧面板.
+             */
+            PANEL__RIGHT_TOP__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 左下侧工具栏.
+             */
+            TOOLBAR__LEFT_BOTTOM__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 左上侧工具栏.
+             */
+            TOOLBAR__LEFT_TOP__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 右下侧工具栏.
+             */
+            TOOLBAR__RIGHT_BOTTOM__TELEPORT_ID: InjectionKey<string>;
+            /**
+             * 右上侧工具栏.
+             */
+            TOOLBAR__RIGHT_TOP__TELEPORT_ID: InjectionKey<string>;
+        };
+        /**
+         * 变量页面.
+         */
+        KG_VAR: {
+            /**
+             * 注入 kgProps 参数.
+             */
+            KG_PROPS: InjectionKey<ComputedRef<IKgProps | undefined>>;
+            /**
+             * 注入 kgSlots 参数.
+             */
+            KG_SLOTS: InjectionKey<IKgSlots | undefined>;
+        };
+        /**
+         * 变量配置弹窗.
+         */
+        KG_VAR_CONFIG: {
+            /**
+             * 正在被配置的界面标识.
+             */
+            HOST_FORM_ID: InjectionKey<Ref<string | null>>;
+        };
+        /**
+         * 「变量配置:查找弹窗」.
+         */
+        VAR_CONFIG_LOOKUP: {
+            /**
+             * 宿主界面标识.
+             */
+            HOST_FORM_ID: InjectionKey<string>;
+            /**
+             * 变量查找编号.
+             */
+            LOOKUP_ID: InjectionKey<string>;
+        };
     };
     /**
      * 高级查询的操作符.
@@ -204,18 +731,44 @@ export declare const KG_CONST: {
             TEXT_AREA: string;
         };
     };
+    /**
+     * 用于添加的行.
+     * 在「查询条件」「提交字段」「表格视图」中, 用户可以自己添加额外的行, 作为「查询字段」「提交字段」「表格的列」,
+     * 为了操作方便, 会在表格中始终显示一个特殊的行, 称之为「用于添加的行」, 点击该行左侧的加号就可以添加新的行, 本常量用来作为该特殊的行的 ID.
+     */
+    __KG__CREATE_ROW_ID__: string;
+    /**
+     * 用户添加的行.
+     * 在「查询条件」「提交字段」「表格视图」中, 用户可以自己添加额外的行, 作为「查询字段」「提交字段」「表格的列」, 本常量用来作为该行的 ID.
+     */
+    __KG__CUSTOM_ROW_ID__: string;
+    __KG__NULL__: string;
+    /**
+     * 在表格内创建时, 空白行的临时主键.
+     */
+    __KG__TABLE_TEMP_ID__: string;
+};
+/**
+ * 模块.
+ */
+export declare const KG_APP: {
+    /**
+     * 系统管理.
+     */
+    readonly SYS: "sys";
+    /**
+     * WCS.
+     */
+    readonly WCS: "wcs";
+    /**
+     * 仓库管理.
+     */
+    readonly WMS_BUSINESS_MANAGER: "business-manager";
+    /**
+     * 数据管理.
+     */
+    readonly WMS_DATA_MANAGER: "data-manager";
 };
-/** 模块. */
-export declare const enum KG_APP {
-    /** 数据管理. */
-    WMS_DATA_MANAGER = "data-manager",
-    /** 仓库管理. */
-    WMS_BUSINESS_MANAGER = "business-manager",
-    /** WCS. */
-    WCS = "wcs",
-    /** 系统管理. */
-    SYS = "sys"
-}
 /** 模块路径前缀. */
 export declare const enum KG_APP_PREFIX {
     /** 数据管理. */
@@ -228,7 +781,7 @@ export declare const enum KG_APP_PREFIX {
     SYS = "/sys"
 }
 /** 所有模块. */
-export declare const KG_APPS: Array<KG_APP>;
+export declare const KG_APPS: Array<string>;
 /** 所有模块路径前缀. */
 export declare const KG_APP_PREFIXS: Array<KG_APP_PREFIX>;
 /**
@@ -655,7 +1208,7 @@ export declare const enum KG_DESCRIPTION_CODE_NAME {
     /** 宽度单位. */
     VAR_WIDTH_UNIT = "var_width_unit"
 }
-/** @deprecated 已废弃, 请使用 {@linkplain KG_CONST.DYNAMIC_QUERY_OPERATOR} */
+/** @deprecated 已废弃, 请使用 {@linkplain KG.DYNAMIC_QUERY_OPERATOR} */
 export declare const KG_DYNAMIC_QUERY_OPERATOR: {
     /** 范围之内. */
     BETWEEN: string;
@@ -804,6 +1357,12 @@ export interface IKgVarSubmitConfigProperties {
  * <p>额外的配置属性. 对应 {@link VarButton#props} 字段.</p>
  */
 export interface IKgVarButtonProperties {
+    /**
+     * 是否显示, 默认为 true.
+     *
+     * @default true
+     */
+    isVisible?: boolean;
     /**
      * 文本提示.
      */
@@ -984,7 +1543,7 @@ export interface IKgVarVariableProperties {
  * <p>表单控件的参数.</p>
  * <p>对应于 {@link VarConfigControl.ctrl_prop} 字段, 根据表单控件的类型, 设置额外的参数.</p>
  * @see VarConfigControl.ctrl_prop
- * @see KG_CONST.VAR_CONFIG_CONTROL.CONTROL_TYPE
+ * @see KG.VAR_CONFIG_CONTROL.CONTROL_TYPE
  */
 export interface IKgVarConfigControlControlProperties {
     CHECKBOX: {
@@ -1190,27 +1749,20 @@ export interface IKgVarGridDetailDisplayTypeProperties {
 /**
  * 通用常量.
  */
+/** @deprecated 已废弃, 请使用 {@link KG} */
 export declare const KG_COMMON_CONST: {
-    /**
-     * 用于添加的行.
-     * 在「查询条件」「提交字段」「表格视图」中, 用户可以自己添加额外的行, 作为「查询字段」「提交字段」「表格的列」,
-     * 为了操作方便, 会在表格中始终显示一个特殊的行, 称之为「用于添加的行」, 点击该行左侧的加号就可以添加新的行, 本常量用来作为该特殊的行的 ID.
-     */
+    /** @deprecated 已废弃, 请使用 {@link KG.__KG__CREATE_ROW_ID__} */
     __KG__CREATE_ROW_ID__: string;
-    /**
-     * 用户添加的行.
-     * 在「查询条件」「提交字段」「表格视图」中, 用户可以自己添加额外的行, 作为「查询字段」「提交字段」「表格的列」, 本常量用来作为该行的 ID.
-     */
+    /** @deprecated 已废弃, 请使用 {@link KG.__KG__CUSTOM_ROW_ID__} */
     __KG__CUSTOM_ROW_ID__: string;
+    /** @deprecated 已废弃, 请使用 {@link KG.__KG__NULL__} */
     __KG__NULL__: string;
 };
+/** @deprecated 已废弃, 请使用 {@link KG.__KG__TABLE_TEMP_ID__} */
+export declare const KG_TABLE_TEMP_ID = "__KG__TABLE_TEMP_ID__";
 /**
  * 状态管理类型定义.
  */
 export declare type KgStoreDefinition<GETTERS, ACTIONS> = (pinia?: Pinia | null | undefined) => GETTERS & ACTIONS & {
     $onAction(callback: StoreOnActionListener<any, any, any, any>, detached?: boolean): () => void;
 };
-/**
- * 在表格内创建时, 空白行的临时主键.
- */
-export declare const KG_TABLE_TEMP_ID = "__KG_TABLE_TEMP_ID__";