@kengic/vue 0.22.0 → 0.23.0

package/dist/src/config/index.hooks.d.ts

@@ -1,42 +1,35 @@
 import { Pinia } from 'pinia';
+import { ComputedRef } from 'vue';
+import { Description } from '../apis/WMS/models';
+import { IKgStore, P, T } from './index.store';
+export interface IUseKg {
+    /**
+     * 获取当前语言下的某个描述.
+     *
+     * @param.codeName 描述组名.
+     * @param.codeValue 描述数值.
+     */
+    getDescription(param: {
+        codeName: string | null | undefined;
+        codeValue: string | null | undefined;
+    }): Description | null;
+    /** 当前语言. */
+    locale: IKgStore['getLocale'];
+    /**
+     * 组件库的配置参数.
+     */
+    option: ComputedRef<IKgStore['getOption']>;
+    /** 检查权限. */
+    p: P;
+    /**
+     * 路由对象.
+     */
+    router: ComputedRef<IKgStore['getRouter']>;
+    store: IKgStore;
+    /** 翻译. */
+    t: T;
+}
 /**
  * @param pinia 在某些地方调用时(比如在路由守卫中), pinia 尚未初始化, 此时需要手动传入 pinia 实例.
  */
-export declare function useKg(pinia?: Pinia): {
-    store: import("pinia").Store<"Kg", import("./index.store").IKgState, {
-        getLocale(): import("vue").ComputedRef<import("..").IKgLocale> | null;
-        getRouter(): import("vue-router").Router | null;
-        getUseUserStore(): import("pinia").StoreDefinition<string, import("./index.store").UserState, {
-            getToken(): string;
-            getRoleList(): any[];
-            getUserWarehouses(): import("..").SysUserWarehouseDTO[];
-            getSessionTimeout(): boolean;
-            getUserInfo(): import("./index.store").UserInfo;
-        }, {}> | null;
-        getUsePermissionStore(): import("pinia").StoreDefinition<string, import("./index.store").PermissionState, {
-            getPermCodeList(): string[] | number[];
-            getBackMenuList(): import("..").Menu[];
-        }, import("pinia")._ActionsTree> | null;
-        getOption(): import("./index.store").IKgOption;
-        getPublicPath(): string;
-    }, {
-        setLocale(locale: import("vue").ComputedRef<import("..").IKgLocale> | null): void;
-        setRouter(router: import("vue-router").Router): void;
-        setUseUserStore(useUserStore: import("pinia").StoreDefinition<any, any, any, any>): void;
-        setUsePermissionStore(usePermissionStore: import("pinia").StoreDefinition<any, any, any, any>): void;
-        setT(i18n: any): void;
-        setP(fn: import("./index.store").P): void;
-        setOption(option: import("./index.store").IKgOption): void;
-        t(key: string | null | undefined, ...arg: any[]): string;
-        p(permissionCode?: string | string[] | null | undefined): boolean;
-    }>;
-    /** 当前语言. */
-    locale: import("vue").ComputedRef<import("..").IKgLocale>;
-    router: any;
-    /** 配置参数. */
-    option: import("vue").ComputedRef<import("./index.store").IKgOption>;
-    /** 翻译. */
-    t: (key: string | null | undefined, ...arg: any[]) => string;
-    /** 检查权限. */
-    p: (permissionCode?: string | string[] | null | undefined) => boolean;
-};
+export declare function useKg(pinia?: Pinia): IUseKg;

package/dist/src/config/index.store.d.ts

@@ -1,7 +1,7 @@
 import { StoreDefinition } from 'pinia';
 import { ComputedRef } from 'vue';
 import { Router } from 'vue-router';
-import { SysUserWarehouseDTO } from '../apis/WMS/models';
+import { Description, SysUserWarehouseDTO } from '../apis/WMS/models';
 import { IKgLocale, KG_APP, Menu } from '../consts';
 export declare type IKgOption = {
     /** 模块首页地址. */
@@ -161,54 +161,61 @@ export interface PermissionState {
     /** 全部权限配置. */
     allAuthList: AuthItem[];
 }
-export interface IKgState {
+export interface IUseKgStoreState {
+    /**
+     * <p>系统描述.</p>
+     * <p>第一层 key 为 codeName, 第二层 key 为 codeValue.</p>
+     */
+    descriptionMap: Map<string, Map<string, Description>>;
     /** 语言. */
     locale: ComputedRef<IKgLocale> | null;
-    /** 翻译的方法. */
-    tFunction: T | null;
+    /** 配置参数. */
+    option: IKgOption;
     /** 检查权限的方法. */
     pFunction: P | null;
     router: Router | null;
-    /** 用户数据. */
-    useUserStore: StoreDefinition | null;
+    /** 翻译的方法. */
+    tFunction: T | null;
     /** 权限数据. */
     usePermissionStore: StoreDefinition | null;
-    /** 配置参数. */
-    option: IKgOption;
+    /** 用户数据. */
+    useUserStore: StoreDefinition | null;
 }
-export declare type IKgStoreDefinition = StoreDefinition<'Kg', IKgState, {
-    /** 获取配置参数. */
-    getLocale: ComputedRef<IKgLocale> | null;
-    getRouter: Router | null;
-    getUseUserStore(): StoreDefinition<string, UserState, {
-        getToken(): string;
-        getRoleList(): any[];
-        getUserWarehouses(): SysUserWarehouseDTO[];
-        getSessionTimeout(): boolean;
-        getUserInfo(): UserInfo;
-    }, {}> | null;
+export interface IUseKgStoreGetters {
+    /**
+     * 根据 codeName 和 codeValue 获取当前语言下的某个描述.
+     */
+    getDescription(): (param: {
+        codeName: string | null | undefined;
+        codeValue: string | null | undefined;
+    }) => Description | null;
+    /**
+     * 根据 codeName 获取当前语言下的它的所有描述.
+     */
+    getDescriptions(): (param: {
+        codeName: string | null | undefined;
+    }) => Array<Description>;
+    /** 组件库的配置参数. */
+    getLocale(): ComputedRef<IKgLocale> | null;
+    /**
+     * 配置参数.
+     */
+    getOption(): IKgOption;
+    /**
+     * 后端接口地址前缀.
+     */
+    getPublicPath(): IKgOption;
+    getRouter(): Router | null;
+    /**
+     * 菜单数据.
+     */
     getUsePermissionStore(): StoreDefinition<string, PermissionState, {
         getPermCodeList(): string[] | number[];
         getBackMenuList(): Menu[];
     }> | null;
-    /** 获取配置参数. */
-    getOption: IKgOption;
-}, {
-    setLocale(locale: ComputedRef<IKgLocale> | null): void;
-    setRouter(router: Router): void;
-    setUseUserStore(useUserStore: StoreDefinition<any, any, any, any>): void;
-    setUsePermissionStore(usePermissionStore: StoreDefinition<any, any, any, any>): void;
-    setT(i18n: any): void;
-    setP(fn: P): void;
-    setOption(option: IKgOption): void;
-    /** 翻译. */
-    t: T;
-    /** 检查权限. */
-    p: P;
-}>;
-export declare const useKgStore: StoreDefinition<"Kg", IKgState, {
-    getLocale(): ComputedRef<IKgLocale> | null;
-    getRouter(): Router | null;
+    /**
+     * 权限数据.
+     */
     getUseUserStore(): StoreDefinition<string, UserState, {
         getToken(): string;
         getRoleList(): any[];
@@ -216,24 +223,39 @@ export declare const useKgStore: StoreDefinition<"Kg", IKgState, {
         getSessionTimeout(): boolean;
         getUserInfo(): UserInfo;
     }, {}> | null;
-    getUsePermissionStore(): StoreDefinition<string, PermissionState, {
-        getPermCodeList(): string[] | number[];
-        getBackMenuList(): Menu[];
-    }> | null;
-    getOption(): IKgOption;
+}
+export interface IUseKgStoreActions {
+    /** 检查权限. */
+    p: P;
     /**
-     * 获取后端接口地址前缀.
+     * 请求某组描述数据.
+     *
+     * @param param.codeName 描述组名.
      */
-    getPublicPath(): string;
-}, {
+    requestDescriptions(param: {
+        codeName: string | null | undefined;
+    }): Promise<void>;
+    /**
+     * 设置某组描述的数据.
+     *
+     * @param param.codeName 描述组名.
+     * @param param.descriptions 描述数据.
+     */
+    setDescriptions(param: {
+        codeName: string | null | undefined;
+        descriptions: Array<Description>;
+    }): void;
     setLocale(locale: ComputedRef<IKgLocale> | null): void;
+    setOption(option: IKgOption): void;
+    setP(fn: P): void;
     setRouter(router: Router): void;
-    setUseUserStore(useUserStore: StoreDefinition<any, any, any, any>): void;
-    setUsePermissionStore(usePermissionStore: StoreDefinition<any, any, any, any>): void;
     setT(i18n: any): void;
-    setP(fn: P): void;
-    setOption(option: IKgOption): void;
-    t(key: string | null | undefined, ...arg: any[]): string;
-    p(permissionCode?: string | Array<string> | null): boolean;
-}>;
+    setUsePermissionStore(usePermissionStore: StoreDefinition<any, any, any, any>): void;
+    setUseUserStore(useUserStore: StoreDefinition<any, any, any, any>): void;
+    /** 翻译. */
+    t: T;
+}
+export declare type IUseKgStore = StoreDefinition<'Kg', IUseKgStoreState, IUseKgStoreGetters, IUseKgStoreActions>;
+export declare type IKgStore = ReturnType<IUseKgStore>;
+export declare const useKgStore: IUseKgStore;
 export {};

package/dist/src/consts/i18n/en.d.ts

@@ -95,6 +95,7 @@ declare const _default: {
             config: string;
             'dynamic-query-is-off-in-server': string;
             emptyText: string;
+            'is-show-description': string;
             'request-fail-error': string;
             'request-fail-no-data': string;
             rowHeight: string;

package/dist/src/consts/i18n/zh_CN.d.ts

@@ -95,6 +95,7 @@ declare const _default: {
             config: string;
             'dynamic-query-is-off-in-server': string;
             emptyText: string;
+            'is-show-description': string;
             'request-fail-error': string;
             'request-fail-no-data': string;
             rowHeight: string;

package/dist/src/consts/index.d.ts

@@ -30,7 +30,7 @@ export declare const KG_APP_PREFIXS: Array<KG_APP_PREFIX>;
 /**
  * 表单控件类型.
  * @see VarConfigControl.ctrl_prop
- * @see IKgVariableConfigProps
+ * @see IKgVarConfigControlProperties
  */
 export declare const enum KG_FORM_ITEM_CONTROL_TYPE {
     /** 文本. */
@@ -41,26 +41,26 @@ export declare const enum KG_FORM_ITEM_CONTROL_TYPE {
     INPUT_NUMBER = "INPUT_NUMBER",
     /**
      * <p>多行文本.</p>
-     * <p>配置属性参见 {@link IKgVariableConfigProps.TEXT_AREA}.</p>
+     * <p>配置属性参见 {@link IKgVarConfigControlProperties.TEXT_AREA}.</p>
      */
     TEXT_AREA = "TEXT_AREA",
     /** 多选框. */
     CHECKBOX = "CHECKBOX",
     /**
      * <p>多选框列表.</p>
-     * <p>配置属性参见 {@link IKgVariableConfigProps.CHECKBOX_GROUP}.</p>
+     * <p>配置属性参见 {@link IKgVarConfigControlProperties.CHECKBOX_GROUP}.</p>
      */
     CHECKBOX_GROUP = "CHECKBOX_GROUP",
     /**
      * <p>单选框列表.</p>
-     * <p>配置属性参见 {@link IKgVariableConfigProps.RADIO_GROUP}.</p>
+     * <p>配置属性参见 {@link IKgVarConfigControlProperties.RADIO_GROUP}.</p>
      */
     RADIO_GROUP = "RADIO_GROUP",
     /** 开关. */
     SWITCH = "SWITCH",
     /**
      * <p>下拉列表单选.<p>
-     * <p>配置属性参见 {@link IKgVariableConfigProps.SELECT}.</p>
+     * <p>配置属性参见 {@link IKgVarConfigControlProperties.SELECT}.</p>
      */
     SELECT = "SELECT",
     /** 下拉列表多选. */
@@ -100,7 +100,7 @@ export declare const enum KG_FORM_CONTEXT {
 /**
  * 表格单元格的显示类型.
  * @see VarGridDetail.display_type_properties
- * @see IKgGridDetailDisplayTypeProps
+ * @see IKgVarGridDetailDisplayTypeProperties
  */
 export declare const enum KG_TABLE_CELL_DISPLAY_TYPE {
     /** 布尔数据, 使用 KgYesOrNo 组件显示. */
@@ -111,19 +111,26 @@ export declare const enum KG_TABLE_CELL_DISPLAY_TYPE {
     PROGRESS = "PROGRESS",
     /** 文件大小, 将以字节(byte)为单位的数字格式化显示(XXX MB, XXX GB, ...). */
     FILE_SIZE = "FILE_SIZE",
-    /** 显示为超链接, 点击打开更新弹窗. */
+    /** 超链接, 点击打开更新弹窗. */
     UPDATE_LINK = "UPDATE_LINK",
-    /** 显示为超链接, 点击跳转到其他路由. */
+    /** 超链接, 点击跳转到其他路由. */
     ROUTE_LINK = "ROUTE_LINK",
     /**
-     * <p>显示描述字段.</p>
-     * <p>假如原字段为 'status', 则实际上会显示描述字段 'status_dsc(或者 statusDsc)' 的值,</p>
-     * <p>默认, 描述字段是原字段加上 '_dsc(或者 Dsc)' 后缀, 比如原字段为 'status', 则描述字段为 'status_dsc(或者 statusDsc)',</p>
-     * <p>可以通过 {@link IKgGridDetailDisplayTypeProps.DESC.dscFieldName} 设置自定义的描述字段名,</p>
+     * <p>描述. 显示该列的值所对应的描述, 而不是直接显示该列的值.</p>
+     * <p>
+     *     描述的来源有 2 种, 按优先级从高到低依次为:
+     *     <ul>
+     *         <li>如果 {@link IKgVarGridDetailDisplayTypeProperties.DESC.description.codeName} 不为空, 则描述来源于系统描述表, 并且默认的 codeValue 就是该列的值,</li>
+     *         <li>
+     *             <p>否则, 描述来源于描述列.</p>
+     *             <p>默认情况下, 描述列的列名为原始列的列名加上 _dsc 或者 Dsc 后缀, 比如原始列的列名为 xyz, 则描述列的列名为 xyz_dsc 或者 xyzDsc, 可以通过 {@link IKgVarGridDetailDisplayTypeProperties.DESC.dscFieldName} 将描述列的列名配置为其他值,</p>
+     *         </li>
+     *     </ul>
+     * </p>
      */
     DESC = "DESC",
     /**
-     * <p>显示为图片, 点击可以预览.</p>
+     * <p>图片, 可以点击预览大图.</p>
      */
     IMAGE = "IMAGE"
 }

package/dist/src/consts/index.vm.d.ts

@@ -25,7 +25,7 @@ export declare type IKgLocale = 'zh_CN' | 'en' | 'ru' | 'ja' | 'ko';
  * 按钮确认弹窗的参数.
  * <p>对应于 {@link VarButton#modal_props} 字段.</p>
  */
-export declare type IKgButtonModalProps = ModalFuncProps & {
+export declare type IKgVarButtonModalProperties = ModalFuncProps & {
     /** 是否隐藏取消按钮. */
     kgHideCancelButton?: boolean;
 };
@@ -33,7 +33,7 @@ export declare type IKgButtonModalProps = ModalFuncProps & {
  * <p>提交弹窗的配置参数.</p>
  * <p>对应于 {@link VarSubmitConfig#props} 字段.</p>
  */
-export interface IKgVarSubmitConfigProps {
+export interface IKgVarSubmitConfigProperties {
     /** 确认按钮. */
     okButton?: {
         /** 确认按钮的文本, 实际是一个变量名, 根据变量进行翻译. */
@@ -46,7 +46,7 @@ export interface IKgVarSubmitConfigProps {
  * @see VarConfigControl.ctrl_prop
  * @see KG_FORM_ITEM_TYPE
  */
-export interface IKgVariableConfigProps {
+export interface IKgVarConfigControlProperties {
     DATE_RANGE: {
         /**
          * <p>是否允许为空.</p>
@@ -102,29 +102,66 @@ export interface IKgVariableConfigProps {
     };
 }
 /**
- * 对应于 {@link VarGridDetail.display_type_properties} 字段, 根据显示类型, 设置额外的参数.
+ * 对应的是 {@link VarGridDetail.display_type_properties} 字段, 根据显示类型, 设置额外的参数.
+ *
  * @see VarGridDetail.display_type_properties
  * @see KG_TABLE_CELL_DISPLAY_TYPE
  */
-export interface IKgGridDetailDisplayTypeProps {
-    YN: {
+export interface IKgVarGridDetailDisplayTypeProperties {
+    DESC: {
+        description?: {
+            /**
+             * <p>对应的是 {@link Description.codnam}.</p>
+             * <p>当该配置项不为空时, 表示则描述来源于系统描述表.<p>
+             */
+            codeName?: string;
+            /**
+             * <p>对应的是 {@link Description.codval}.</p>
+             * <p>默认值为该列的值.</p>
+             * <p>
+             *     可以是一个 JS 表达式, 组件库会解析该表达式, 并得到真正的值. 比如表达式 \`${row.id}\` 表示获取该行的 id 列的值. 表达式中可以使用下列变量:
+             *     <ul>
+             *         <li>row: 表示该行数据,</li>
+             *     </ul>
+             * </p>
+             */
+            codeValue?: string;
+            /**
+             * <p>是否延迟获取系统描述数据.</p>
+             * <p>默认情况下, 在页面加载后会立即获取 {@link IKgVarGridDetailDisplayTypeProperties.DESC.description.codeName} 对应的系统描述数据. 这种场景适合数据较少的枚举数据.</p>
+             * <p>如果描述数据特别多, 比如每一行的描述都不一样, 则可以将该配置项的值配置为 true, 表示会在表格每次查询的时候, 才去请求这些列表数据对应的系统描述数据.</p>
+             *
+             * @default false
+             */
+            isDefer?: boolean;
+        };
         /**
-         * 显示为'是'的值.
-         * @default 1
+         * <p>默认情况下, 当原始列的列名为 xyz 时, 描述列的列名为 xyz_dsc 或者 xyzDsc.</p>
+         * <p>通过该配置项可以将描述列的列名配置为其他值.</p>
          */
-        yValue?: any;
+        dscFieldName?: string;
         /**
-         * 显示为'否'的值.
-         * @default 0
+         * 是否显示为一个 Tag 标签.
+         * @default false
          */
-        nValue?: any;
+        isTag?: boolean;
         /**
-         * 是否将 null/undefined 当成 false.
-         * @default false
+         * <ul>
+         *     <li>如果 {@link IKgVarGridDetailDisplayTypeProperties.DESC.isTag} 为 true, 则此属性用来定义每个值对应的标签颜色分别是什么,</li>
+         *     <li>如果 {@link IKgVarGridDetailDisplayTypeProperties.DESC.isTag} 为 false, 则此属性会被忽略,</li>
+         * </ul>
          */
-        nilAsFalse?: boolean;
+        tagColors?: Array<{
+            /** 值. */
+            value: any;
+            /**
+             * 颜色.
+             * @default 'default'
+             */
+            color?: string;
+        }>;
     };
-    /** @deprecated 请使用 {@link IKgGridDetailDisplayTypeProps.DESC}. */
+    /** @deprecated 请使用 {@link IKgVarGridDetailDisplayTypeProperties.DESC}. */
     ENUM: Array<{
         /** 变量名称. */
         varName: string;
@@ -136,6 +173,21 @@ export interface IKgGridDetailDisplayTypeProps {
          */
         color?: string;
     }>;
+    FILE_SIZE: {};
+    IMAGE: {
+        /**
+         * 宽度.
+         *
+         * @default 29
+         */
+        width?: number;
+        /**
+         * 宽度.
+         *
+         * @default 29
+         */
+        height?: number;
+    };
     PROGRESS: {
         /** 左侧数值对应的列. */
         leftColumn: string;
@@ -147,51 +199,26 @@ export interface IKgGridDetailDisplayTypeProps {
          */
         textWidth?: 'auto' | string;
     };
-    FILE_SIZE: {};
-    UPDATE_LINK: {};
     ROUTE_LINK: {
         /** 要跳转的路由地址. */
         path: string;
     };
-    DESC: {
+    UPDATE_LINK: {};
+    YN: {
         /**
-         * 对应的描述字段的名称.
-         * @default `原字段名 + '_dsc'`, 或者 `原字段名 + 'Dsc'`
+         * 显示为'否'的值.
+         * @default 0
          */
-        dscFieldName?: string;
+        nValue?: any;
         /**
-         * 是否显示为一个 Tag 标签.
+         * 是否将 null/undefined 当成 false.
          * @default false
          */
-        isTag?: boolean;
-        /**
-         * <ul>
-         *     <li>如果 {@link IKgGridDetailDisplayTypeProps.DESC.isTag} 为 true, 则此属性用来定义每个值对应的标签颜色分别是什么,</li>
-         *     <li>如果 {@link IKgGridDetailDisplayTypeProps.DESC.isTag} 为 false, 则此属性会被忽略,</li>
-         * </ul>
-         */
-        tagColors?: Array<{
-            /** 值. */
-            value: any;
-            /**
-             * 颜色.
-             * @default 'default'
-             */
-            color?: string;
-        }>;
-    };
-    IMAGE: {
-        /**
-         * 宽度.
-         *
-         * @default 29
-         */
-        width?: number;
+        nilAsFalse?: boolean;
         /**
-         * 宽度.
-         *
-         * @default 29
+         * 显示为'是'的值.
+         * @default 1
          */
-        height?: number;
+        yValue?: any;
     };
 }

package/dist/src/pages/KgPageDda/components/KgPageDda.Create.store.d.ts

@@ -1418,4 +1418,4 @@ export declare const useKgPageDdaCreateStore: import("pinia").StoreDefinition<"K
     }) => void;
     setVarConfigControls: (varConfigControls: Array<VarConfigControl>) => void;
     getVarText: (varNam: string | null | undefined) => string;
-}, "setIsLoading" | "initCreateVarDdaQuery" | "setResultSetMetadataColumns" | "setFrmId" | "patchSysPermission" | "updateVarDda" | "createVarButton" | "patchVarButton" | "deleteVarButton" | "setVarProfileDetails" | "setVarGridDetails" | "setVarSubmitDetails" | "createVarConfigDescription" | "updateVarConfigDescription" | "setVarConfigControls" | "getVarText">>;
+}, "initCreateVarDdaQuery" | "setIsLoading" | "setResultSetMetadataColumns" | "setFrmId" | "patchSysPermission" | "updateVarDda" | "createVarButton" | "patchVarButton" | "deleteVarButton" | "setVarProfileDetails" | "setVarGridDetails" | "setVarSubmitDetails" | "createVarConfigDescription" | "updateVarConfigDescription" | "setVarConfigControls" | "getVarText">>;

package/dist/src/utils/kg-route.util.d.ts

@@ -7,9 +7,10 @@ export declare class KgRouteUtil {
      */
     static addOnlineRoutesForAllApps(routes: any[]): any[];
     /**
-     * 根据地址获取菜单.
+     * 根据菜单地址地址获取菜单.
+     *
      * @param menus 菜单列表.
-     * @param path 地址.
+     * @param path 菜单地址.
      * @return {} 如果能找到某个菜单的地址等于传入的地址, 则返回该菜单, 否则返回 null.
      */
     static getMenuByPath(menus: Array<Menu> | null | undefined, path: string): Menu | null;

package/dist/src/utils/kg.util.d.ts

@@ -1,6 +1,6 @@
 import { ModalFuncProps } from 'ant-design-vue/lib/modal/Modal';
 import dayjs, { Dayjs } from 'dayjs';
-import { IKgButtonModalProps } from '../consts';
+import { IKgVarButtonModalProperties } from '../consts';
 /**
  * 通用工具.
  */
@@ -94,7 +94,7 @@ export declare class KgUtil {
      * https://www.antdv.com/components/modal
      * @param props
      */
-    static confirm(props: IKgButtonModalProps): ModalFunc;
+    static confirm(props: IKgVarButtonModalProperties): ModalFunc;
     /**
      * 如果此错误不是表单验证错误, 则抛出此错误.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kengic/vue",
-    "version": "0.22.0",
+    "version": "0.23.0",
     "scripts": {
         "build": "npm run switch-node-version && rimraf dist && vue-tsc && vite build",
         "build:dev": "npm run switch-node-version && rimraf dist && vue-tsc && vite build --mode development",