@kengic/vue 0.19.1-beta.0 → 0.19.2-beta.0

package/dist/src/components/KgTable/index.vm.d.ts

@@ -9,7 +9,7 @@ export declare type IKgTableRow = {
     [index: string]: any;
 };
 /** 查询方法参数. */
-export interface IKgTableSearchParams {
+export interface IKgTableRequestParams {
     /**
      * 是否查询首页, 否则查询当页.
      * @default false

package/dist/src/components/KgVar/index.hooks.d.ts

@@ -1,62 +1,6 @@
 import { ComputedRef } from 'vue';
-import { VarProfileDetail, VarSubmitField } from '../../apis/WMS/models';
-import { IKgVarRetrieveCb, IKgVarStore } from './index.store';
-export declare type IUseKgVar = {
-    /** 状态数据. */
-    store: IKgVarStore;
-    /** 正在查询变量配置. */
-    isRetrieving: ComputedRef<ReturnType<IKgVarStore['isRetrieving']>>;
-    /** 正在查询 VarProfileMaster. */
-    isRetrievingVarProfileMaster: ComputedRef<ReturnType<IKgVarStore['isRetrievingVarProfileMaster']>>;
-    /** 正在查询 VarGridMaster. */
-    isRetrievingVarGridMaster: ComputedRef<ReturnType<IKgVarStore['isRetrievingVarGridMaster']>>;
-    /** 变量配置是否查询完成. */
-    isSearched: ComputedRef<ReturnType<IKgVarStore['isSearched']>>;
-    /** 正在创建. */
-    isCreating: ComputedRef<ReturnType<IKgVarStore['isCreating']>>;
-    /** 正在创建:正在调用接口. */
-    isCreatingRequesting: ComputedRef<ReturnType<IKgVarStore['isCreatingRequesting']>>;
-    /** 正在更新. */
-    isUpdating: ComputedRef<ReturnType<IKgVarStore['isUpdating']>>;
-    /** 正在更新:正在调用接口. */
-    isUpdatingRequesting: ComputedRef<ReturnType<IKgVarStore['isUpdatingRequesting']>>;
-    /** 正在复制. */
-    isCopying: ComputedRef<ReturnType<IKgVarStore['isCopying']>>;
-    /** 正在复制:正在调用接口. */
-    isCopyingRequesting: ComputedRef<ReturnType<IKgVarStore['isCopyingRequesting']>>;
-    /** 正在删除. */
-    isDeleting: ComputedRef<ReturnType<IKgVarStore['isDeleting']>>;
-    /** 正在删除:正在调用接口. */
-    isDeletingRequesting: ComputedRef<ReturnType<IKgVarStore['isDeletingRequesting']>>;
-    /** 其他按钮:正在调用接口. */
-    isOtherRequesting: ComputedRef<ReturnType<IKgVarStore['isOtherRequesting']>>;
-    /** 所有的 VarButton 列表. */
-    varButtons: ComputedRef<ReturnType<IKgVarStore['getVarButtons']>>;
-    varButtonSearch: ComputedRef<ReturnType<IKgVarStore['getVarButtonSearch']>>;
-    varButtonCreate: ComputedRef<ReturnType<IKgVarStore['getVarButtonCreate']>>;
-    varButtonUpdate: ComputedRef<ReturnType<IKgVarStore['getVarButtonUpdate']>>;
-    varButtonCopy: ComputedRef<ReturnType<IKgVarStore['getVarButtonCopy']>>;
-    varButtonDelete: ComputedRef<ReturnType<IKgVarStore['getVarButtonDelete']>>;
-    /** 所有的 VarProfileMaster 列表. */
-    varProfileMasters: ComputedRef<ReturnType<IKgVarStore['getVarProfileMasters']>>;
-    /** 当前的 VarProfileMaster ID. */
-    currentVarProfileMasterID: ComputedRef<ReturnType<IKgVarStore['getCurrentVarProfileMasterID']>>;
-    /** 当前的 VarProfileMaster. */
-    currentVarProfileMaster: ComputedRef<ReturnType<IKgVarStore['getCurrentVarProfileMaster']>>;
-    /** 当前的 VarProfileDetail 列表. */
-    currentVarProfileDetails: ComputedRef<Array<VarProfileDetail> | null>;
-    varGridConfig: ComputedRef<ReturnType<IKgVarStore['getVarGridConfig']>>;
-    /** 所有的 VarGridMaster 列表. */
-    varGridMasters: ComputedRef<ReturnType<IKgVarStore['getVarGridMasters']>>;
-    /** 当前的 VarGridMaster ID. */
-    currentVarGridMasteID: ComputedRef<ReturnType<IKgVarStore['getCurrentVarGridMasterID']>>;
-    /** 当前的 VarGridMaster. */
-    currentVarGridMaster: ComputedRef<ReturnType<IKgVarStore['getCurrentVarGridMaster']>>;
-    /** 系统的 VarGridDetail 列表. */
-    systemVarGridDetails: ComputedRef<ReturnType<IKgVarStore['getSystemVarGridDetails']>>;
-    /** 当前的 VarGridDetail 列表. */
-    currentVarGridDetails: ComputedRef<ReturnType<IKgVarStore['getCurrentVarGridDetails']>>;
-};
+import { VarSubmitField } from '../../apis/WMS/models';
+import { IKgVarRetrieveCb } from './index.store';
 /**
  * <p>使用变量配置.</p>
  * <ol>
@@ -73,10 +17,12 @@ export declare function useKgVar(formID?: string | null, init?: boolean, level?:
      * 界面标识.
      */
     formID: string;
+    /** 状态数据. */
     store: import("pinia").Store<"KgVar", import("./index.store").IKgVarState, {
         getTopFormIDs(): string[];
         getFormLevel(): (frm_id: string | null | undefined) => number;
         t(): (frm_id: string | null | undefined, var_nam: string | null | undefined) => string;
+        /** 正在查询变量配置. */
         isRetrieving(): (frm_id: string | null | undefined) => boolean | null;
         isRetrievingVarProfileMaster(): (frm_id: string | null | undefined) => boolean | null;
         isRetrievingVarGridMaster(): (frm_id: string | null | undefined) => boolean | null;
@@ -91,16 +37,26 @@ export declare function useKgVar(formID?: string | null, init?: boolean, level?:
         isDeletingRequesting(): (frm_id: string | null | undefined) => boolean | null;
         isOtherRequesting(): (frm_id: string | null | undefined) => boolean | null;
         getVarCatalogs(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarVariableCatalog[] | null;
+        /** 当前的 VarProfileMaster. */
         getVarCatalog(): (frm_id: string | null | undefined, var_nam: string | null | undefined) => import("../../apis/WMS/models").VarVariableCatalog | null;
         getVarLookup(): (frm_id: string | null | undefined, var_nam: string | null | undefined) => import("../../apis/WMS/models").VarVariableLookup | null;
         getVarPossibility(): (frm_id: string | null | undefined, var_nam: string | null | undefined) => import("../../apis/WMS/models").VarVariablePossibility | null;
+        /**
+         * 设置'是否正在创建'.
+         * @param value 是否正在创建.
+         */
         getVarVariableConfig(): (frm_id: string | null | undefined, var_nam: string | null | undefined) => import("../../apis/WMS/models").VarVariableConfig | null;
         getVarVariableInput(): (frm_id: string | null | undefined, var_nam: string | null | undefined) => import("../../apis/WMS/models").VarVariableInput | null;
         getVarButtons(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarButton[] | null;
         getVarSubmitConfig(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarSubmitConfig | null;
         getVarSubmitConfigProps(): (frm_id: string | null | undefined) => import("../../consts").IKgSubmitConfigProps;
         getVarSubmitFields(): (frm_id: string | null | undefined) => VarSubmitField[] | null;
-        getVarSubmitFieldsForCreate(): (frm_id: string | null | undefined) => VarSubmitField[] | null;
+        getVarSubmitFieldsForCreate(): (frm_id: string | null | undefined) => VarSubmitField[] | null; /**
+         * 修改 VarSubmitField 的部分属性.
+         * @param variableName 变量名称
+         * @param properties 要修改的部分属性.
+         * @param isTriggerEvent 是否触发变更事件.
+         */
         getVarSubmitFieldsForCreateKey(): (frm_id: string | null | undefined) => VarSubmitField[] | null;
         getVarSubmitFieldsForCreateNotKey(): (frm_id: string | null | undefined) => VarSubmitField[] | null;
         getVarSubmitFieldsForCreateKeyVisible(): (frm_id: string | null | undefined) => VarSubmitField[] | null;
@@ -130,9 +86,9 @@ export declare function useKgVar(formID?: string | null, init?: boolean, level?:
         getVarButtonDelete(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarButton | null;
         getVarProfileConfig(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarProfileConfig | null;
         getVarProfileMasters(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarProfileMasterDTO[] | null;
-        getVarProfileDetail(): (frm_id: string | null | undefined, var_nam: string | null | undefined) => VarProfileDetail | null;
-        getVarProfileDetails(): (frm_id: string | null | undefined) => VarProfileDetail[] | null;
-        getSystemVarProfileDetails(): (frm_id: string | null | undefined) => VarProfileDetail[] | null;
+        getVarProfileDetail(): (frm_id: string | null | undefined, var_nam: string | null | undefined) => import("../../apis/WMS/models").VarProfileDetail | null;
+        getVarProfileDetails(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarProfileDetail[] | null;
+        getSystemVarProfileDetails(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarProfileDetail[] | null;
         getCurrentVarProfileMasterID(): (frm_id: string | null | undefined) => string | null;
         getCurrentVarProfileMaster(): (frm_id: string | null | undefined) => import("../../apis/WMS/models").VarProfileMasterDTO | null;
         getVarGridConfigMap(): Map<string, import("../../apis/WMS/models").VarGridConfig | null>;
@@ -166,40 +122,63 @@ export declare function useKgVar(formID?: string | null, init?: boolean, level?:
         setCurrentVarGridMasterID(frm_id: string, currentVarGridMasterID: string): Promise<void>;
         setVarGridDetailWidth(frm_id: string, var_nam: string | null | undefined, width: number): void;
         patchVarGridDetail(frm_id: string, var_nam: string | null | undefined, properties: import("../../apis/WMS/models").VarGridDetail): Promise<void>;
-        patchVarProfileDetail(frm_id: string, var_nam: string | null | undefined, properties: VarProfileDetail): Promise<void>;
+        patchVarProfileDetail(frm_id: string, var_nam: string | null | undefined, properties: import("../../apis/WMS/models").VarProfileDetail): Promise<void>;
         setVarPossibility(frm_id: string | null | undefined, var_nam: string | null | undefined, varPossibility: import("../../apis/WMS/models").VarVariablePossibility): void;
         patchVarSubmitField(frm_id: string | null | undefined, var_nam: string | null | undefined, properties: VarSubmitField, isTriggerEvent?: boolean | undefined): void;
         patchVarPossibilityCommandParameter(frm_id: string | null | undefined, var_nam: string | null | undefined, properties: Record<string, any>): Promise<void>;
         dragSortCurrentVarGridDetails(frm_id: string | null | undefined, from_var_nam: string | null | undefined, to_var_nam: string | null | undefined): void;
     }>;
+    /** 正在查询变量配置. */
     isRetrieving: ComputedRef<boolean | null>;
+    /** 正在查询 VarProfileMaster. */
     isRetrievingVarProfileMaster: ComputedRef<boolean | null>;
+    /** 正在查询 VarGridMaster. */
     isRetrievingVarGridMaster: ComputedRef<boolean | null>;
+    /** 变量配置是否查询完成. */
     isSearched: ComputedRef<boolean>;
+    /** 正在创建. */
     isCreating: ComputedRef<boolean | null>;
+    /** 正在创建:正在调用接口. */
     isCreatingRequesting: ComputedRef<boolean | null>;
+    /** 正在更新. */
     isUpdating: ComputedRef<boolean | null>;
+    /** 正在更新:正在调用接口. */
     isUpdatingRequesting: ComputedRef<boolean | null>;
+    /** 正在复制. */
     isCopying: ComputedRef<boolean | null>;
+    /** 正在复制:正在调用接口. */
     isCopyingRequesting: ComputedRef<boolean | null>;
+    /** 正在删除. */
     isDeleting: ComputedRef<boolean | null>;
+    /** 正在删除:正在调用接口. */
     isDeletingRequesting: ComputedRef<boolean | null>;
+    /** 其他按钮:正在调用接口. */
     isOtherRequesting: ComputedRef<boolean | null>;
+    /** 所有的 VarButton 列表. */
     varButtons: ComputedRef<import("../../apis/WMS/models").VarButton[] | null>;
     varButtonSearch: ComputedRef<import("../../apis/WMS/models").VarButton | null>;
     varButtonCreate: ComputedRef<import("../../apis/WMS/models").VarButton | null>;
     varButtonUpdate: ComputedRef<import("../../apis/WMS/models").VarButton | null>;
     varButtonCopy: ComputedRef<import("../../apis/WMS/models").VarButton | null>;
     varButtonDelete: ComputedRef<import("../../apis/WMS/models").VarButton | null>;
+    /** 所有的 VarProfileMaster 列表. */
     varProfileMasters: ComputedRef<import("../../apis/WMS/models").VarProfileMasterDTO[] | null>;
+    /** 当前的 VarProfileMaster ID. */
     currentVarProfileMasterID: ComputedRef<string | null>;
+    /** 当前的 VarProfileMaster. */
     currentVarProfileMaster: ComputedRef<import("../../apis/WMS/models").VarProfileMasterDTO | null>;
-    currentVarProfileDetails: ComputedRef<VarProfileDetail[] | null>;
+    /** 当前的 VarProfileDetail 列表. */
+    currentVarProfileDetails: ComputedRef<import("../../apis/WMS/models").VarProfileDetail[] | null>;
     varGridConfig: ComputedRef<import("../../apis/WMS/models").VarGridConfig | null>;
+    /** 所有的 VarGridMaster 列表. */
     varGridMasters: ComputedRef<import("../../apis/WMS/models").VarGridMasterDTO[] | null>;
+    /** 当前的 VarGridMaster ID. */
     currentVarGridMasteID: ComputedRef<string | null>;
+    /** 当前的 VarGridMaster. */
     currentVarGridMaster: ComputedRef<import("../../apis/WMS/models").VarGridMasterDTO | null>;
+    /** 系统的 VarGridDetail 列表. */
     systemVarGridDetails: ComputedRef<import("../../apis/WMS/models").VarGridDetail[] | null>;
+    /** 当前的 VarGridDetail 列表. */
     currentVarGridDetails: ComputedRef<import("../../apis/WMS/models").VarGridDetail[] | null>;
     /**
      * 设置'是否正在创建'.
@@ -228,15 +207,15 @@ export declare function useKgVar(formID?: string | null, init?: boolean, level?:
      * @param isTriggerEvent 是否触发变更事件.
      */
     patchVarSubmitField(variableName: string | null | undefined, properties: VarSubmitField, isTriggerEvent?: boolean): void;
-    /**
-     * 事件: 变量配置查询完成.
-     * @param cb 回调函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
-     */
-    onRetrieve: (cb: IKgVarRetrieveCb) => import("../../consts").IRemoveEventListenerHandler;
     /**
      * 翻译变量. 响应式的.
      * @param variableName 变量名称.
      */
     t(variableName: string | null | undefined): ComputedRef<string>;
+    /**
+     * 事件: 变量配置查询完成.
+     * @param cb 回调函数.
+     * @param once 是否只会触发一次. 默认为 undefined.
+     */
+    onRetrieve: (cb: IKgVarRetrieveCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
 };

package/dist/src/components/KgVar/index.store.d.ts

@@ -1,5 +1,5 @@
 import { type StoreDefinition } from 'pinia';
-import { VarButton, VarButtonConfig, VarVariableCatalog, VarGridConfig, VarGridDetail, VarGridMasterDTO, VarVariableLookup, VarVariablePossibility, VarProfileConfig, VarProfileDetail, VarProfileMasterDTO, VarSubmitConfig, VarSubmitField, VarVariableConfig, VarVariableInput } from '../../apis/WMS/models';
+import { VarButton, VarButtonConfig, VarGridConfig, VarGridDetail, VarGridMasterDTO, VarProfileConfig, VarProfileDetail, VarProfileMasterDTO, VarSubmitConfig, VarSubmitField, VarVariableCatalog, VarVariableConfig, VarVariableInput, VarVariableLookup, VarVariablePossibility } from '../../apis/WMS/models';
 import { IKgEventCb, IKgSubmitConfigProps } from '../../consts';
 /**
  * 事件类型.
@@ -14,9 +14,9 @@ export declare type IFormID = {
     /**
      * 页面所处的模态框(弹出框)的层级.
      *
-     * - 普通页面中该属性值为 0
-     * - 第一级弹出框中该属性值为 1
-     * - 第二级弹出框中该属性值为 2
+     * - 普通页面中此属性值为 0
+     * - 第一级弹出框中此属性值为 1
+     * - 第二级弹出框中此属性值为 2
      * - 依次类推...
      */
     level: number;
@@ -30,7 +30,7 @@ export interface IKgVarState {
     /** 正在查询变量配置. */
     isRetrievingMap: Map<string, boolean>;
     /** 变量配置是否查询完成. */
-    isSearchedMap: Map<string, boolean>;
+    isRequestedMap: Map<string, boolean>;
     /** 正在查询 VarProfileMaster. */
     isRetrievingVarProfileMasterMap: Map<string, boolean>;
     /** 正在查询 VarGridMaster. */

package/dist/src/components/KgWarehouse/KgWarehouse.d.ts

@@ -3,9 +3,9 @@ import './KgWarehouse.less';
 export declare const getProps: () => {
     /**
      * 是否隐藏.
-     * 该组件需要在不同的地方使用,
+     * 此组件需要在不同的地方使用,
      *     在有的地方需要显示当前选择的仓库, 并且可以通过点击打开弹窗, 比如顶部导航栏,
-     *     在有的地方, 不需要显示该组件, 用户通过参数控制是否打开弹窗, 比如登录页,
+     *     在有的地方, 不需要显示此组件, 用户通过参数控制是否打开弹窗, 比如登录页,
      * @default undefined
      */
     kgInvisible: PropType<boolean>;
@@ -15,9 +15,9 @@ export declare type IKgWarehouseProps = Partial<ExtractPropTypes<ReturnType<type
 declare const _default: import("vue").DefineComponent<{
     /**
      * 是否隐藏.
-     * 该组件需要在不同的地方使用,
+     * 此组件需要在不同的地方使用,
      *     在有的地方需要显示当前选择的仓库, 并且可以通过点击打开弹窗, 比如顶部导航栏,
-     *     在有的地方, 不需要显示该组件, 用户通过参数控制是否打开弹窗, 比如登录页,
+     *     在有的地方, 不需要显示此组件, 用户通过参数控制是否打开弹窗, 比如登录页,
      * @default undefined
      */
     kgInvisible: PropType<boolean>;
@@ -25,9 +25,9 @@ declare const _default: import("vue").DefineComponent<{
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "kgOk"[], "kgOk", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
     /**
      * 是否隐藏.
-     * 该组件需要在不同的地方使用,
+     * 此组件需要在不同的地方使用,
      *     在有的地方需要显示当前选择的仓库, 并且可以通过点击打开弹窗, 比如顶部导航栏,
-     *     在有的地方, 不需要显示该组件, 用户通过参数控制是否打开弹窗, 比如登录页,
+     *     在有的地方, 不需要显示此组件, 用户通过参数控制是否打开弹窗, 比如登录页,
      * @default undefined
      */
     kgInvisible: PropType<boolean>;

package/dist/src/components/util.d.ts

@@ -1,14 +1,14 @@
 import { IKgEventCb, IRemoveEventListenerHandler } from '../consts';
 /**
  * 构造事件监听.
- * @param frm_id 界面标识.
+ * @param frmId 界面标识.
  * @param store 状态管理.
  * @param event 事件名称.
  */
 export declare function onEventFactory<S extends {
-    addEventListener(frm_id: string, event: E, cb: C): void;
-    removeEventListener(frm_id: string, event: E, cb?: C): void;
+    addEventListener(frmId: string, event: E, cb: C): void;
+    removeEventListener(frmId: string, event: E, cb?: C): void;
 } | {
     addEventListener(event: E, cb: C): void;
     removeEventListener(event: E, cb?: C): void;
-} = any, E = any, C extends IKgEventCb = any>(frm_id: string | null, store: S, event: E): (cb: C) => IRemoveEventListenerHandler;
+} = any, E = any, C extends IKgEventCb = any>(frmId: string | null, store: S, event: E): (cb: C, once?: boolean) => IRemoveEventListenerHandler;

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

@@ -154,8 +154,8 @@ export interface IKgGridDetailDisplayTypeProps {
          */
         isTag?: boolean;
         /**
-         * 如果 {@link IKgGridDetailDisplayTypeProps.DESC.isTag} 为 true, 则该属性用来定义每个值对应的标签颜色分别是什么.
-         * 如果 {@link IKgGridDetailDisplayTypeProps.DESC.isTag} 为 false, 则该属性会被忽略.
+         * 如果 {@link IKgGridDetailDisplayTypeProps.DESC.isTag} 为 true, 则此属性用来定义每个值对应的标签颜色分别是什么.
+         * 如果 {@link IKgGridDetailDisplayTypeProps.DESC.isTag} 为 false, 则此属性会被忽略.
          */
         tagColors?: Array<{
             /** 值. */

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

@@ -9,7 +9,7 @@ export declare class KgVarUtil {
      * @param params JSON 字符串形式的参数.
      * @return {} 参数对象.
      */
-    static parseCommandParameter(params?: string | null): Record<string, any>;
+    static parseRequestParamsToJSON(params?: string | null): Record<string, any>;
     /**
      * 根据控件类型, 将任意的值(可能非法)转换为合法的值.
      * @param frm_id 界面标识.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kengic/vue",
-    "version": "0.19.1-beta.0",
+    "version": "0.19.2-beta.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",