@kengic/vue 0.30.1-beta.96 → 0.31.0

package/config/config.store.ts

@@ -1,705 +0,0 @@
-import { ____DEBUG____, ____ERROR____, ____WARN_____ } from '@kengic/core.core';
-import { set, values } from 'lodash-es';
-import { defineStore, StoreDefinition } from 'pinia';
-import { computed, ref, unref } from 'vue';
-import { Router } from 'vue-router';
-import { API } from '../api';
-import { DescriptionDTO, SysUserWarehouseDTO, VarConfigDescription } from '../api/WMS/models';
-import { I18N } from '../i18n';
-import { KG, KG_APP, IKgStoreDefinition } from '../model';
-import { Menu } from '../project/src/router/types';
-import { useLocaleStore } from '../project/src/store/modules/locale';
-import { UserInfo } from '../project/types/store';
-import { KgUtil } from '../util';
-import { useKg } from './config.hooks';
-
-export type IKgOption = {
-    /**
-     * 工作站选择--是否启用功能, 默认为 true.
-     */
-    $KgWorkStation$isOn?: boolean;
-
-    /**
-     * 多标签页.
-     */
-    KgLayoutTab?: {
-        /**
-         * <p>是否放到页面头部区域.</p>
-         * @default true
-         */
-        isTeleportToHeader?: boolean;
-    };
-
-    KgModal?: {
-        /** 拖拽改变位置. */
-        drag?: {
-            /**
-             * 是否启用功能.
-             *
-             * @default false
-             */
-            on?: boolean;
-        };
-
-        /** 拖拽改变大小. */
-        dragToResize?: {
-            /**
-             * 是否启用功能.
-             *
-             * @default false
-             */
-            isOn?: boolean;
-        };
-    };
-
-    KgSearch?: {
-        /** 高级查询. */
-        dynamicQuery?: {
-            /**
-             * 是否启用功能.
-             *
-             * @default false
-             */
-            on?: boolean;
-        };
-    };
-
-    /** @deprecated 已弃用, 请使用 {@link IKgOption.$KgWorkStation$isOn}. */
-    KgStation?: {
-        /** @deprecated 已弃用, 请使用 {@link IKgOption.$KgWorkStation$isOn}. */
-        isOn?: boolean;
-    };
-
-    KgTable?: {
-        /**
-         * 表头.
-         */
-        HeaderCell?: {
-            /**
-             * 右键菜单.
-             */
-            contextMenu?: {
-                /**
-                 * @default false
-                 */
-                isOn?: boolean;
-            };
-        };
-
-        Info?: {
-            /**
-             * 定位勾选的行.
-             */
-            locateSelectedRows: {
-                /**
-                 * @default false
-                 */
-                isOn?: boolean;
-            };
-        };
-
-        /**
-         * 表格设置菜单.
-         */
-        Setting?: {
-            /**
-             * 行高.
-             */
-            rowHeight?: {
-                /**
-                 * 是否启用功能.
-                 * @default false
-                 */
-                on?: boolean;
-            };
-
-            /**
-             * 字段.
-             */
-            columns?: {
-                /**
-                 * 拖拽排序.
-                 */
-                dragToSort?: {
-                    /**
-                     * @default false
-                     */
-                    isOn?: boolean;
-                };
-            };
-        };
-
-        /** 列的过滤. */
-        filter?: {
-            /**
-             * 是否启用功能.
-             * @default false
-             */
-            on?: boolean;
-        };
-    };
-
-    /** 仓库选择. */
-    KgWarehouse?: {
-        /** 默认的仓库编码, 只有在 {@link IKgOption.KgWarehouse.on} 为 false 时才生效. */
-        defaultWarehouseID?: string;
-
-        /**
-         * 是否启用功能.
-         * @default true
-         */
-        on?: boolean;
-    };
-
-    /** 模块首页地址. */
-    appIndex?: {
-        /** 默认为 '/sys/index'. */
-        [KG_APP.SYS]?: string;
-        /** 默认为 '/wcs/index'. */
-        [KG_APP.WCS]?: string;
-        /** 默认为 '/wms/business-manager/index'. */
-        [KG_APP.WMS_BUSINESS_MANAGER]?: string;
-        /** 默认为 '/wms/data-manager/index'. */
-        [KG_APP.WMS_DATA_MANAGER]?: string;
-    };
-
-    /** 模块标题. */
-    appTitle?: {
-        /** 默认为 '系统配置'. */
-        [KG_APP.SYS]?: string;
-        /** 默认为 'WCS'. */
-        [KG_APP.WCS]?: string;
-        /** 默认为 '仓库管理'. */
-        [KG_APP.WMS_BUSINESS_MANAGER]?: string;
-        /** 默认为 '数据管理'. */
-        [KG_APP.WMS_DATA_MANAGER]?: string;
-    };
-
-    /**
-     * 数据库的类型.
-     *
-     * @see {@link KG.DB_TYPE}
-     * @default {@link KG.DB_TYPE.SQLSERVER}
-     */
-    dbType?: string;
-
-    /**
-     * <p>项目的版本号. 即 package.json 中的 version 值.</p>
-     *
-     * @default 0.0.0
-     */
-    projectVersion?: string;
-
-    /**
-     * <p>后端接口地址前缀.</p>
-     *
-     * @default '/kengic-boot'
-     */
-    publicPath?: string;
-};
-
-/** 翻译的方法. */
-export type T = {
-    (key: string | null | undefined): string;
-    (key: string | null | undefined, locale: string): string;
-    (key: string | null | undefined, locale: string, list: unknown[]): string;
-    (key: string | null | undefined, locale: string, named: Record<string, unknown>): string;
-    (key: string | null | undefined, list: unknown[]): string;
-    (key: string | null | undefined, named: Record<string, unknown>): string;
-};
-
-/** 检查权限的方法. */
-export type P = { (permissionCode?: string | Array<string> | null): boolean };
-
-export interface UserState {
-    roleList: any[];
-    sessionTimeout?: boolean;
-    token?: string;
-    userInfo: UserInfo | null;
-    userWarehouses: SysUserWarehouseDTO[];
-}
-
-interface AuthItem {
-    /** 权限编码. */
-    action: string;
-    /** 权限名称. */
-    describe?: string;
-    /** 权限状态. 0:无效, 1:有效. */
-    status: string | number;
-    /** 权限策略. 1:显示, 2:禁用. */
-    type: string | number;
-}
-
-export interface PermissionState {
-    /** 全部权限配置. */
-    allAuthList: AuthItem[];
-    /** 当前登录用户所拥有的权限配置. */
-    authList: AuthItem[];
-    /** 菜单列表. */
-    backMenuList: Menu[];
-    /** 当前登录用户所拥有的权限编码列表. */
-    permCodeList: string[] | number[];
-}
-
-//region GETTERS 类型定义
-//----------------------------------------------------------------------------------------------------
-export interface IUseKgStoreGetters {
-    I18N: Record<string, any>;
-
-    /**
-     * 根据 codeName 和 codeValue 获取当前语言下的某个描述.
-     */
-    getDescription: (param: { codeName: string | null | undefined; codeValue: string | null | undefined }) => DescriptionDTO | null;
-
-    /**
-     * 根据 codeName 获取当前语言下的它的所有描述.
-     */
-    getDescriptionList: (param: { codeName: string | null | undefined }) => Array<DescriptionDTO>;
-
-    i18n: any;
-
-    /**
-     * 配置参数.
-     */
-    option: IKgOption;
-
-    /**
-     * 后端接口地址前缀.
-     */
-    publicPath: IKgOption;
-
-    router: Router | null;
-
-    /**
-     * 菜单数据.
-     */
-    usePermissionStore: StoreDefinition<
-        string,
-        PermissionState,
-        {
-            getPermCodeList(): string[] | number[];
-            getBackMenuList(): Menu[];
-        }
-    > | null;
-
-    /**
-     * 权限数据.
-     */
-    useUserStore: StoreDefinition<
-        string,
-        UserState,
-        {
-            getToken(): string;
-            getRoleList(): any[];
-            getUserWarehouses(): SysUserWarehouseDTO[];
-            getSessionTimeout(): boolean;
-            getUserInfo(): UserInfo;
-        },
-        {}
-    > | null;
-}
-//----------------------------------------------------------------------------------------------------
-//endregion
-
-//region ACTIONS 类型定义
-//----------------------------------------------------------------------------------------------------
-export interface IUseKgStoreActions {
-    /**
-     * 检查权限.
-     */
-    p: P;
-
-    /**
-     * 请求某组描述数据.
-     *
-     * @param param.codeName 描述组名.
-     * @param param.isForceRequest 是否强制请求, 即无论是否已经请求过该组, 始终重新请求, 默认为 true.
-     */
-    requestDescriptionList(param: { codeName: string | null | undefined; isForceRequest?: boolean | null | undefined }): Promise<void>;
-
-    /**
-     * 请求某组变量描述数据.
-     *
-     * @param param.fid 界面标识.
-     */
-    requestVarConfigDescriptionList(param: { fid: string | null | undefined }): Promise<void>;
-
-    /**
-     * 设置某组描述的数据.
-     *
-     * @param param.codeName 描述组名.
-     * @param param.descriptions 描述数据.
-     */
-    setDescriptionList(param: { codeName: string | null | undefined; descriptions: Array<DescriptionDTO> }): void;
-
-    setI18N(I18N?: Record<string, any>): void;
-
-    setI18n(i18n: any): void;
-
-    setOption(option: IKgOption): void;
-
-    setP(fn: P): void;
-
-    setRouter(router: Router): void;
-
-    setT(i18n: any): void;
-
-    setUsePermissionStore(usePermissionStore: StoreDefinition<any, any, any, any>): void;
-
-    setUseUserStore(useUserStore: StoreDefinition<any, any, any, any>): void;
-
-    /**
-     * 翻译.
-     *
-     * @param key 键.
-     * @param param 参数对象.
-     * @param defaultValue 默认翻译结果.
-     */
-    t(key: string | null | undefined, param?: Record<string, any> | null | undefined, defaultValue?: string | null | undefined): string;
-}
-//----------------------------------------------------------------------------------------------------
-//endregion
-
-// @ts-ignore
-export const useKgStore: IKgStoreDefinition<IUseKgStoreGetters, IUseKgStoreActions> = defineStore('Kg', () => {
-    //region DATA
-    //----------------------------------------------------------------------------------------------------
-    //----------------------------------------------------------------------------------------------------
-    //endregion
-
-    //region STATE
-    //----------------------------------------------------------------------------------------------------
-    const I18N$ = ref<Record<string, any>>({});
-    const descriptionMap$ = ref<Record<string, Record<string, DescriptionDTO>>>({});
-    const i18n$ = ref<any>(null);
-    const isDescriptionsRequestingMap$ = ref<Record<string, boolean>>({});
-    const option$ = ref<IKgOption>({});
-    const pFunction$ = ref<P | null>(null);
-    const router$ = ref<Router | null>(null);
-    const tFunction$ = ref<T | null>(null);
-    const usePermissionStore$ = ref<StoreDefinition | null>(null);
-    const useUserStore$ = ref<StoreDefinition | null>(null);
-    //----------------------------------------------------------------------------------------------------
-    //endregion
-
-    //region GETTERS
-    //----------------------------------------------------------------------------------------------------
-    const getDescription$$ = computed<(param: { codeName: string | null | undefined; codeValue: string | null | undefined }) => DescriptionDTO | null>(() => (param) => {
-        const { codeName, codeValue } = param ?? {};
-        if (!codeName || !codeValue) {
-            return null;
-        }
-
-        return descriptionMap$.value[codeName]?.[codeValue] ?? null;
-    });
-
-    const getDescriptionList$$ = computed<(param: { codeName: string | null | undefined }) => Array<DescriptionDTO>>(() => (param) => {
-        const { codeName } = param ?? {};
-
-        if (!codeName) {
-            return [];
-        }
-
-        return [...values(descriptionMap$.value[codeName])];
-    });
-
-    const I18N$$ = computed<Record<string, any>>(() => {
-        return I18N$.value ?? {};
-    });
-
-    const i18n$$ = computed<Record<string, any>>(() => {
-        return i18n$.value ?? {};
-    });
-
-    const option$$ = computed<IKgOption>(() => {
-        return option$.value ?? {};
-    });
-
-    const publicPath$$ = computed<string>(() => {
-        return option$.value?.publicPath || '/kengic-boot';
-    });
-
-    const router$$ = computed<Router | null>(() => {
-        return router$.value as any;
-    });
-
-    const usePermissionStore$$ = computed<StoreDefinition<
-        string,
-        PermissionState,
-        {
-            getPermCodeList(): string[] | number[];
-            getBackMenuList(): Menu[];
-        }
-    > | null>(() => {
-        return usePermissionStore$.value as any;
-    });
-
-    const useUserStore$$ = computed<StoreDefinition<
-        string,
-        UserState,
-        {
-            getToken(): string;
-            getRoleList(): any[];
-            getUserWarehouses(): SysUserWarehouseDTO[];
-            getSessionTimeout(): boolean;
-            getUserInfo(): UserInfo;
-        },
-        {}
-    > | null>(() => {
-        return useUserStore$.value as any;
-    });
-    //----------------------------------------------------------------------------------------------------
-    //endregion
-
-    //region ACTIONS
-    //----------------------------------------------------------------------------------------------------
-    function p(permissionCode?: string | Array<string> | null): boolean {
-        if (!pFunction$.value) {
-            ____WARN_____('检查权限的方法为空');
-            return true;
-        }
-
-        return pFunction$.value(permissionCode);
-    }
-
-    async function requestDescriptionList(param: { codeName: string | null | undefined; isForceRequest?: boolean | null | undefined }): Promise<void> {
-        const { codeName, isForceRequest } = param ?? {};
-
-        if (!codeName) {
-            return;
-        }
-
-        // 正在请求该组描述, 禁止重复请求,
-        if (isDescriptionsRequestingMap$.value[codeName]) {
-            ____DEBUG____(`kg.requestDescriptionList() | 正在查询, 不许重复查询. | { codeName: ${codeName}`);
-            return;
-        }
-
-        // 该组描述已经请求过了, 不再请求,
-        const codeNameMap = descriptionMap$.value[codeName];
-        if (codeNameMap && isForceRequest === false) {
-            return;
-        }
-
-        const kg = useKg();
-
-        try {
-            isDescriptionsRequestingMap$.value[codeName] = true;
-
-            const { records } =
-                (await API.WMS.DescriptionController.List({
-                    params: {
-                        codnam: codeName,
-                        localeId: kg.locale?.value,
-                        pageNo: 1,
-                        pageSize: 999999,
-                    },
-                })) ?? {};
-
-            setDescriptionList({ codeName: codeName, descriptions: records ?? [] });
-        } finally {
-            isDescriptionsRequestingMap$.value[codeName] = false;
-        }
-    }
-
-    async function requestVarConfigDescriptionList(param: { fid: string | null | undefined }): Promise<void> {
-        if (!param.fid) {
-            return;
-        }
-
-        const varConfigDescriptionList = (await API.WMS.VarConfigDescriptionController.ListByFormId({ data: new VarConfigDescription({ frm_id: param.fid }) }).catch(() => [])) ?? [];
-
-        setDescriptionList({
-            codeName: param.fid,
-            descriptions: varConfigDescriptionList.map(
-                (i) =>
-                    new DescriptionDTO({
-                        codnam: param.fid,
-                        codval: i.var_nam,
-                        id: KgUtil.uuid(),
-                        lngDsc: i.var_text,
-                        localeId: i.locale_id,
-                        shortDsc: i.var_text,
-                    }),
-            ),
-        });
-    }
-
-    function setDescriptionList(param: { codeName: string | null | undefined; descriptions: Array<DescriptionDTO> }): void {
-        const { codeName, descriptions } = param ?? {};
-        if (!codeName) {
-            return;
-        }
-
-        let codeNameMap = descriptionMap$.value[codeName];
-        if (!codeNameMap) {
-            codeNameMap = {};
-
-            descriptionMap$.value[codeName] = codeNameMap;
-        }
-
-        for (let description of descriptions) {
-            if (description.codval) {
-                codeNameMap[description.codval] = description;
-            }
-        }
-    }
-
-    function setI18N(_I18N?: Record<string, any>): void {
-        if (_I18N) {
-            I18N$.value = _I18N;
-        }
-    }
-
-    function setI18n(_i18n: any): void {
-        i18n$.value = _i18n;
-    }
-
-    function setOption(_option: IKgOption): void {
-        const __option = _option ?? {};
-
-        //region 设置配置的默认值,
-        //----------------------------------------------------------------------------------------------------
-        if (!__option.dbType) {
-            set(__option, 'dbType', KG.DB_TYPE.SQLSERVER);
-        }
-
-        //----------------------------------------------------------------------------------------------------
-        //endregion
-
-        option$.value = __option;
-    }
-
-    function setP(fn: P): void {
-        pFunction$.value = fn;
-    }
-
-    function setRouter(_router: Router): void {
-        router$.value = _router as any;
-    }
-
-    function setT(i18n: any): void {
-        const locale = useLocaleStore().getLocale;
-
-        if (!locale) {
-            ____ERROR____('当前语言为空.');
-            return;
-        }
-
-        // TODO LT 语言文件存储到数据库, 移除代码中的语言文件
-        i18n.global.setLocaleMessage(locale, I18N[unref(locale)]);
-        i18n.global.mergeLocaleMessage(locale, I18N$.value[unref(locale)].message);
-
-        tFunction$.value = (key: string | null | undefined, ...arg: any[]) => {
-            if (!key) {
-                return '';
-            }
-
-            return i18n.global.t(key, ...(arg as [string, any]));
-        };
-    }
-
-    function setUsePermissionStore(_usePermissionStore: StoreDefinition<any, any, any, any>): void {
-        usePermissionStore$.value = _usePermissionStore as any;
-    }
-
-    function setUseUserStore(_useUserStore: StoreDefinition<any, any, any, any>): void {
-        useUserStore$.value = _useUserStore as any;
-    }
-
-    function t(key: string | null | undefined, param?: Record<string, any> | null | undefined, defaultValue?: string | null | undefined): string {
-        if (!key) {
-            return '';
-        }
-
-        const key01 = key.replace("t('", '').replace('t("', '').replace("')", '').replace('")', '');
-
-        //region 使用描述表的翻译
-        //----------------------------------------------------------------------------------------------------
-        const description = getDescription$$.value({ codeName: KG.DESCRIPTION_KEY__KG, codeValue: key01 }) ?? getDescription$$.value({ codeName: KG.DESCRIPTION_KEY__WEB, codeValue: key01 });
-        if (description) {
-            let _text = description.shortDsc ?? defaultValue ?? key ?? '';
-
-            //region 替换参数
-            //----------------------------------------------------------------------------------------------------
-            if (_text && param) {
-                for (let paramKey of Object.keys(param)) {
-                    const paramValue = param[paramKey];
-                    _text = _text.replaceAll(new RegExp(`\\{${paramKey}\\}`, 'g'), paramValue);
-                }
-            }
-            //----------------------------------------------------------------------------------------------------
-            //endregion
-
-            return _text;
-        } else {
-            // N/A
-        }
-        //----------------------------------------------------------------------------------------------------
-        //endregion
-
-        //region 其次使用翻译方法 TODO LT 后续移除
-        //----------------------------------------------------------------------------------------------------
-        if (!tFunction$.value) {
-            return defaultValue ?? key ?? '';
-        }
-
-        if (!key) {
-            return '';
-        }
-
-        // `t('...')` 和 `t("...")`
-        let _key = key ?? '';
-        if ((_key.startsWith("t('") && _key.endsWith("')")) || (_key.startsWith('t("') && _key.endsWith('")'))) {
-            _key = _key.match(/^t\(['|"](.*)?['|"]\)$/)?.[1] ?? _key;
-        }
-
-        let _text = tFunction$.value(_key, param ?? {}) as string;
-
-        if (_text === _key) {
-            return defaultValue ?? key ?? '';
-        }
-
-        return _text;
-        //----------------------------------------------------------------------------------------------------
-        //endregion
-    }
-
-    //----------------------------------------------------------------------------------------------------
-    //endregion
-
-    return {
-        I18N: I18N$$,
-        I18N$: I18N$,
-        descriptionMap$: descriptionMap$,
-        getDescription: getDescription$$,
-        getDescriptionList: getDescriptionList$$,
-        i18n: i18n$$,
-        i18n$: i18n$,
-        isDescriptionsRequestingMap$: isDescriptionsRequestingMap$,
-        option: option$$,
-        option$: option$,
-        p: p,
-        pFunction$: pFunction$,
-        publicPath: publicPath$$,
-        requestDescriptionList: requestDescriptionList,
-        requestVarConfigDescriptionList: requestVarConfigDescriptionList,
-        router: router$$,
-        router$: router$,
-        setDescriptionList: setDescriptionList,
-        setI18N: setI18N,
-        setI18n: setI18n,
-        setOption: setOption,
-        setP: setP,
-        setRouter: setRouter,
-        setT: setT,
-        setUsePermissionStore: setUsePermissionStore,
-        setUseUserStore: setUseUserStore,
-        t: t,
-        tFunction$: tFunction$,
-        usePermissionStore: usePermissionStore$$,
-        usePermissionStore$: usePermissionStore$,
-        useUserStore: useUserStore$$,
-        useUserStore$: useUserStore$,
-    };
-});