@kengic/vue 0.25.3 → 0.25.4-beta.1

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

@@ -1,3 +1,3 @@
-export * from './setup';
 export * from './index.hooks';
 export * from './index.store';
+export * from './setup';

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

@@ -1,6 +1,7 @@
 import { Pinia } from 'pinia';
 import { ComputedRef } from 'vue';
 import { Description } from '../apis/WMS/models';
+import { LocaleType } from '../project/types/config';
 import { IKgStore, P, T } from './index.store';
 export interface IUseKg {
     /**
@@ -14,7 +15,7 @@ export interface IUseKg {
         codeValue: string | null | undefined;
     }): Description | null;
     /** 当前语言. */
-    locale: IKgStore['getLocale'];
+    locale: ComputedRef<LocaleType>;
     /**
      * 组件库的配置参数.
      */

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

@@ -3,37 +3,19 @@ import { ComputedRef } from 'vue';
 import { Router } from 'vue-router';
 import { Description, SysUserWarehouseDTO } from '../apis/WMS/models';
 import { KG_APP, Menu } from '../consts';
-import { LocaleType } from '../project';
+import { LocaleType } from '../project/types/config';
 import { UserInfo } from '../project/types/store';
 export declare type IKgOption = {
-    /** 模块首页地址. */
-    appIndex?: {
-        /** 默认为 '/wms/data-manager/index'. */
-        [KG_APP.WMS_DATA_MANAGER]?: string;
-        /** 默认为 '/wms/business-manager/index'. */
-        [KG_APP.WMS_BUSINESS_MANAGER]?: string;
-        /** 默认为 '/wcs/index'. */
-        [KG_APP.WCS]?: string;
-        /** 默认为 '/sys/index'. */
-        [KG_APP.SYS]?: string;
-    };
-    /** 模块标题. */
-    appTitle?: {
-        /** 默认为 '数据管理'. */
-        [KG_APP.WMS_DATA_MANAGER]?: string;
-        /** 默认为 '仓库管理'. */
-        [KG_APP.WMS_BUSINESS_MANAGER]?: string;
-        /** 默认为 'WCS'. */
-        [KG_APP.WCS]?: string;
-        /** 默认为 '系统配置'. */
-        [KG_APP.SYS]?: string;
-    };
     /**
-     * <p>后端接口地址前缀.</p>
-     *
-     * @default '/kengic-boot'
+     * 多标签页.
      */
-    publicPath?: string;
+    KgLayoutTab?: {
+        /**
+         * <p>是否放到页面头部区域.</p>
+         * @default true
+         */
+        isTeleportToHeader?: boolean;
+    };
     KgModal?: {
         /** 拖拽改变位置. */
         drag?: {
@@ -139,16 +121,40 @@ export declare type IKgOption = {
         /** 默认的仓库编码, 只有在 {@link IKgOption.KgWarehouse.on} 为 false 时才生效. */
         defaultWarehouseID?: string;
     };
+    /** 模块首页地址. */
+    appIndex?: {
+        /** 默认为 '/wms/data-manager/index'. */
+        [KG_APP.WMS_DATA_MANAGER]?: string;
+        /** 默认为 '/wms/business-manager/index'. */
+        [KG_APP.WMS_BUSINESS_MANAGER]?: string;
+        /** 默认为 '/wcs/index'. */
+        [KG_APP.WCS]?: string;
+        /** 默认为 '/sys/index'. */
+        [KG_APP.SYS]?: string;
+    };
+    /** 模块标题. */
+    appTitle?: {
+        /** 默认为 '数据管理'. */
+        [KG_APP.WMS_DATA_MANAGER]?: string;
+        /** 默认为 '仓库管理'. */
+        [KG_APP.WMS_BUSINESS_MANAGER]?: string;
+        /** 默认为 'WCS'. */
+        [KG_APP.WCS]?: string;
+        /** 默认为 '系统配置'. */
+        [KG_APP.SYS]?: string;
+    };
     /**
-     * 多标签页.
+     * <p>项目的版本号. 即 package.json 中的 version 值.</p>
+     *
+     * @default 0.0.0
      */
-    KgLayoutTab?: {
-        /**
-         * <p>是否放到页面头部区域.</p>
-         * @default true
-         */
-        isTeleportToHeader?: boolean;
-    };
+    projectVersion?: string;
+    /**
+     * <p>后端接口地址前缀.</p>
+     *
+     * @default '/kengic-boot'
+     */
+    publicPath?: string;
 };
 /** 翻译的方法. */
 export declare type T = {
@@ -229,8 +235,6 @@ export interface IUseKgStoreGetters {
     getDescriptions(): (param: {
         codeName: string | null | undefined;
     }) => Array<Description>;
-    /** 组件库的配置参数. */
-    getLocale(): ComputedRef<LocaleType> | null;
     /**
      * 配置参数.
      */
@@ -279,7 +283,6 @@ export interface IUseKgStoreActions {
         codeName: string | null | undefined;
         descriptions: Array<Description>;
     }): void;
-    setLocale(locale: ComputedRef<LocaleType> | null): void;
     setOption(option: IKgOption): void;
     setP(fn: P): void;
     setRouter(router: Router): void;

package/dist/src/config/setup.d.ts

@@ -1,7 +1,6 @@
 import { Pinia, StoreDefinition } from 'pinia';
-import { App, ComputedRef } from 'vue';
+import { App } from 'vue';
 import { Router } from 'vue-router';
-import { LocaleType } from '../project';
 import { IKgOption, P } from './index.store';
 /**
  * 配置 pinia 实例.
@@ -14,30 +13,24 @@ export declare function setPinia(pinia: Pinia): void;
  * @throws Error 如果 pinia 实例为空, 抛错.
  */
 export declare function getPinia(): Pinia | null;
+/**
+ * 设置 pinia.
+ *
+ * @param pinia pinia.
+ */
+export declare function setupKgStore(pinia: Pinia): void;
 export declare type IKgOptions = {
     app: App;
-    /** 当前语言. */
-    locale: ComputedRef<LocaleType>;
-    /**
-     * import { createI18n } from 'vue-i18n';
-     * ReturnType<typeof createI18n>
-     */
-    i18n: any;
+    /** 配置参数. */
+    option?: IKgOption;
+    /** 权限方法, 用来判断是否具有某个(某些)权限. */
+    pFunction: P;
     router: Router;
-    /** 状态数据: 用户. */
-    useUserStore: StoreDefinition<any, any, any, any>;
     /** 状态数据: 权限. */
     usePermissionStore: StoreDefinition<any, any, any, any>;
-    /** 权限方法, 用来判断是否具有某个(某些)权限. */
-    pFunction: P;
-    /** 配置参数. */
-    option?: IKgOption;
+    /** 状态数据: 用户. */
+    useUserStore: StoreDefinition<any, any, any, any>;
 };
-/**
- * 初始化 pinia.
- * @param pinia pinia.
- */
-export declare function setupKgStore(pinia: Pinia): void;
 /**
  * 初始化组件库.
  * @param options 参数.

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

@@ -1,2 +1,2 @@
-import { LocaleType } from '../../project';
+import { LocaleType } from '../../project/types/config';
 export declare const I18N: Partial<Record<LocaleType, any>>;

package/dist/src/project/build/getConfigFileName.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get the configuration file variable name
+ * @param env
+ */
+export declare const getConfigFileName: (env: Record<string, any>) => string;

package/dist/src/project/build/index.d.ts

@@ -0,0 +1 @@
+export * from './getConfigFileName';

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

@@ -1,2 +1,3 @@
+export * from './build';
 export * from './src';
 export * from './types';

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

@@ -0,0 +1 @@
+export * from './web/useI18n';

package/dist/src/project/src/hooks/web/useI18n.d.ts

@@ -0,0 +1,13 @@
+declare type I18nGlobalTranslation = {
+    (key: string): string;
+    (key: string, locale: string): string;
+    (key: string, locale: string, list: unknown[]): string;
+    (key: string, locale: string, named: Record<string, unknown>): string;
+    (key: string, list: unknown[]): string;
+    (key: string, named: Record<string, unknown>): string;
+};
+export declare function useI18n(namespace?: string): {
+    t: I18nGlobalTranslation;
+};
+export declare const t: (key: string) => string;
+export {};

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

@@ -1,4 +1,13 @@
 export * from './api';
 export * from './components';
 export * from './enums';
+export * from './hooks';
+export * from './locales';
 export * from './settings';
+export * from './store';
+export * from './utils/cache/index';
+export * from './utils/cache/memory';
+export * from './utils/cache/persistent';
+export * from './utils/cache/storageCache';
+export * from './utils/cipher';
+export * from './utils/env';

package/dist/src/project/src/locales/helper.d.ts

@@ -0,0 +1,5 @@
+import { LocaleType } from '../../types';
+export declare const loadLocalePool: LocaleType[];
+export declare function setHtmlPageLang(locale: LocaleType): void;
+export declare function setLoadLocalePool(cb: (loadLocalePool: LocaleType[]) => void): void;
+export declare function genMessage(langs: Record<string, Record<string, any>>, prefix?: string): Recordable<any>;

package/dist/src/project/src/locales/index.d.ts

@@ -0,0 +1,3 @@
+export * from './helper';
+export * from './setupI18n';
+export * from './useLocale';

package/dist/src/project/src/locales/setupI18n.d.ts

@@ -0,0 +1,3 @@
+import type { App } from 'vue';
+export declare let i18n: any;
+export declare function setupI18n(app: App): Promise<void>;

package/dist/src/project/src/locales/useLocale.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Multi-language related operations
+ */
+import { LocaleType } from '../../types';
+export declare function useLocale(): {
+    getLocale: import("vue").ComputedRef<LocaleType>;
+    getShowLocalePicker: import("vue").ComputedRef<boolean>;
+    changeLocale: (locale: LocaleType) => Promise<LocaleType | undefined>;
+    getAntdLocale: import("vue").ComputedRef<any>;
+};

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

@@ -0,0 +1 @@
+export * from './modules';

package/dist/src/project/src/store/modules/index.d.ts

@@ -0,0 +1 @@
+export * from './locale';

package/dist/src/project/src/store/modules/locale.d.ts

@@ -0,0 +1,54 @@
+import { LocaleSetting, LocaleType } from '../../../types';
+interface LocaleState {
+    localInfo: LocaleSetting;
+    pathTitleMap: object;
+}
+export declare const _useLocaleStore: import("pinia").StoreDefinition<"app-locale", LocaleState, {
+    getShowPicker(): boolean;
+    getLocale(): LocaleType;
+    getPathTitle: (state: {
+        localInfo: {
+            showPicker: boolean;
+            locale: LocaleType;
+            fallback: LocaleType;
+            availableLocales: LocaleType[];
+        };
+        pathTitleMap: object;
+    } & import("pinia").PiniaCustomStateProperties<LocaleState>) => (path: any) => any;
+}, {
+    /**
+     * Set up multilingual information and cache
+     * @param info multilingual info
+     */
+    setLocaleInfo(info: Partial<LocaleSetting>): void;
+    /**
+     * Initialize multilingual information and load the existing configuration from the local cache
+     */
+    initLocale(): void;
+    setPathTitle(path: any, title: any): void;
+}>;
+export declare function useLocaleStore(): import("pinia").Store<"app-locale", LocaleState, {
+    getShowPicker(): boolean;
+    getLocale(): LocaleType;
+    getPathTitle: (state: {
+        localInfo: {
+            showPicker: boolean;
+            locale: LocaleType;
+            fallback: LocaleType;
+            availableLocales: LocaleType[];
+        };
+        pathTitleMap: object;
+    } & import("pinia").PiniaCustomStateProperties<LocaleState>) => (path: any) => any;
+}, {
+    /**
+     * Set up multilingual information and cache
+     * @param info multilingual info
+     */
+    setLocaleInfo(info: Partial<LocaleSetting>): void;
+    /**
+     * Initialize multilingual information and load the existing configuration from the local cache
+     */
+    initLocale(): void;
+    setPathTitle(path: any, title: any): void;
+}>;
+export {};

package/dist/src/project/src/utils/cache/index.d.ts

@@ -0,0 +1,7 @@
+import { CreateStorageParams } from './storageCache';
+export declare type Options = Partial<CreateStorageParams>;
+export declare const WebStorage: any;
+export declare const createStorage: (storage?: Storage, options?: Options) => any;
+export declare const createSessionStorage: (options?: Options) => any;
+export declare const createLocalStorage: (options?: Options) => any;
+export default WebStorage;

package/dist/src/project/src/utils/cache/memory.d.ts

@@ -0,0 +1,20 @@
+export interface Cache<V = any> {
+    value?: V;
+    timeoutId?: ReturnType<typeof setTimeout>;
+    time?: number;
+    alive?: number;
+}
+export declare class Memory<T = any, V = any> {
+    private cache;
+    private alive;
+    constructor(alive?: number);
+    get getCache(): { [key in keyof T]?: Cache<V> | undefined; };
+    setCache(cache: any): void;
+    get<K extends keyof T>(key: K): { [key in keyof T]?: Cache<V> | undefined; }[K];
+    set<K extends keyof T>(key: K, value: V, expires?: number): V;
+    remove<K extends keyof T>(key: K): V | undefined;
+    resetCache(cache: {
+        [K in keyof T]: Cache;
+    }): void;
+    clear(): void;
+}

package/dist/src/project/src/utils/cache/persistent.d.ts

@@ -0,0 +1,33 @@
+import type { RouteLocationNormalized } from 'vue-router';
+import { SysUserWarehouseDTO } from '../../../../apis/WMS/models';
+import { LoginInfo, ProjectConfig, UserInfo } from '../../../types';
+import { DB_DICT_DATA_KEY, LOCK_INFO_KEY, LOGIN_INFO_KEY, MULTIPLE_TABS_KEY, PROJ_CFG_KEY, ROLES_KEY, TENANT_ID, TOKEN_KEY, USER_INFO_KEY, USER_WAREHOUSE_KEY } from '../../enums';
+interface BasicStore {
+    [TOKEN_KEY]: string | number | null | undefined;
+    [USER_INFO_KEY]: UserInfo;
+    [ROLES_KEY]: string[];
+    [USER_WAREHOUSE_KEY]: SysUserWarehouseDTO[];
+    [LOCK_INFO_KEY]: LockInfo;
+    [PROJ_CFG_KEY]: ProjectConfig;
+    [MULTIPLE_TABS_KEY]: RouteLocationNormalized[];
+    [DB_DICT_DATA_KEY]: string;
+    [TENANT_ID]: string;
+    [LOGIN_INFO_KEY]: LoginInfo;
+}
+declare type LocalStore = BasicStore;
+declare type SessionStore = BasicStore;
+export declare type BasicKeys = keyof BasicStore;
+declare type LocalKeys = keyof LocalStore;
+declare type SessionKeys = keyof SessionStore;
+export declare class Persistent {
+    static getLocal<T>(key: LocalKeys): Nullable<T>;
+    static setLocal(key: LocalKeys, value: LocalStore[LocalKeys], immediate?: boolean): void;
+    static removeLocal(key: LocalKeys, immediate?: boolean): void;
+    static clearLocal(immediate?: boolean): void;
+    static getSession<T>(key: SessionKeys): Nullable<T>;
+    static setSession(key: SessionKeys, value: SessionStore[SessionKeys], immediate?: boolean): void;
+    static removeSession(key: SessionKeys, immediate?: boolean): void;
+    static clearSession(immediate?: boolean): void;
+    static clearAll(immediate?: boolean): void;
+}
+export {};

package/dist/src/project/src/utils/cache/storageCache.d.ts

@@ -0,0 +1,8 @@
+import { EncryptionParams } from '../cipher';
+export interface CreateStorageParams extends EncryptionParams {
+    prefixKey: string;
+    storage: Storage;
+    hasEncrypt: boolean;
+    timeout?: Nullable<number>;
+}
+export declare const create: any;

package/dist/src/project/src/utils/cipher.d.ts

@@ -0,0 +1,19 @@
+export interface EncryptionParams {
+    key: string;
+    iv: string;
+}
+export declare class AesEncryption {
+    private key;
+    private iv;
+    constructor(opt?: Partial<EncryptionParams>);
+    get getOptions(): {
+        mode: any;
+        padding: any;
+        iv: any;
+    };
+    encryptByAES(cipherText: string): string;
+    decryptByAES(cipherText: string): string;
+}
+export declare function encryptByBase64(cipherText: string): string;
+export declare function decodeByBase64(cipherText: string): string;
+export declare function encryptByMd5(password: string): string;

package/dist/src/project/src/utils/env.d.ts

@@ -0,0 +1,34 @@
+export declare function getCommonStoragePrefix(): string;
+export declare function getStorageShortName(): string;
+export declare function getAppEnvConfig(): {
+    VITE_GLOB_APP_TITLE: string;
+    VITE_GLOB_API_URL: string;
+    VITE_USE_MOCK: string;
+    VITE_GLOB_APP_SHORT_NAME: string;
+    VITE_GLOB_API_URL_PREFIX: string | undefined;
+    VITE_GLOB_APP_OPEN_SSO: string;
+    VITE_GLOB_APP_OPEN_QIANKUN: string;
+    VITE_GLOB_APP_CAS_BASE_URL: string;
+    VITE_GLOB_DOMAIN_URL: string;
+    VITE_GLOB_ONLINE_VIEW_URL: string | undefined;
+};
+/**
+ * @description: Development mode
+ */
+export declare const devMode = "development";
+/**
+ * @description: Production mode
+ */
+export declare const prodMode = "production";
+/**
+ * @description: Is it a development mode
+ * @returns:
+ * @example:
+ */
+export declare function isDevMode(): boolean;
+/**
+ * @description: Is it a production mode
+ * @returns:
+ * @example:
+ */
+export declare function isProdMode(): boolean;

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

@@ -35,7 +35,7 @@ declare class KgLogger {
      * @param collapsed 是否折叠.
      * @param style 样式.
      */
-    static log(level: "error" | "debug" | "info" | "warn" | "deprecated" | undefined, message: string, args?: Record<string, any>, collapsed?: boolean, style?: string | null): void;
+    static log(level: "error" | "warn" | "debug" | "info" | "deprecated" | undefined, message: string, args?: Record<string, any>, collapsed?: boolean, style?: string | null): void;
     /**
      * 打印警告日志.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kengic/vue",
-    "version": "0.25.3",
+    "version": "0.25.4-beta.1",
     "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",
@@ -47,6 +47,7 @@
         "@iconify/vue": "4.1.1",
         "@kengic/pont": "1.2.13",
         "@rys-fe/vite-plugin-theme": "0.8.6",
+        "@types/crypto-js": "4.1.1",
         "@types/fs-extra": "9.0.13",
         "@types/inquirer": "8.2.5",
         "@types/lodash-es": "4.17.9",
@@ -61,6 +62,7 @@
         "ant-design-vue": "3.2.14",
         "axios": "0.26.1",
         "chalk": "4.1.2",
+        "crypto-js": "4.1.1",
         "dayjs": "1.11.10",
         "dotenv": "16.0.3",
         "filesize": "10.1.0",
@@ -94,6 +96,7 @@
         "vite-plugin-vue-setup-extend": "0.4.0",
         "vite-plugin-windicss": "1.8.8",
         "vue": "3.2.43",
+        "vue-i18n": "9.2.2",
         "vue-router": "4.1.6",
         "vue-tsc": "1.8.27"
     },