@kengic/vue 0.22.0 → 0.23.0

package/dist/project/build/script/postBuild.ts

@@ -12,7 +12,7 @@ export const runBuild = async () => {
             runBuildConfig();
         }
 
-        console.log(`✨` + ' - build successfully!');
+        console.log('打包成功.');
     } catch (error) {
         console.log(colors.red('vite build error:\n' + error));
         process.exit(1);

package/dist/src/apis/WMS/Controllers/DescriptionController/ListByCodeNamesAndCodeValues.d.ts

@@ -0,0 +1,16 @@
+import { IRequestConfig, IRequestOptions } from '../../../../services';
+import * as DEF from '../../../def';
+/** 请求参数. */
+export declare class ListByCodeNamesAndCodeValuesQuery {
+}
+/**
+ * 根据多个 codeName 和 codeValue 批量查询描述数据.
+ *
+ * @param config 请求配置.
+ * @param option 请求选项.
+ */
+export declare function ListByCodeNamesAndCodeValues(config?: IRequestConfig<ListByCodeNamesAndCodeValuesQuery, Array<DEF.WMS.DescriptionBatchQuery>>, option?: IRequestOptions): Promise<Array<DEF.WMS.Description>>;
+export declare namespace ListByCodeNamesAndCodeValues {
+    var method: "POST";
+    var url: string;
+}

package/dist/src/apis/WMS/Controllers/DescriptionController/index.d.ts

@@ -1 +1,2 @@
 export { List, ListQuery } from './List';
+export { ListByCodeNamesAndCodeValues, ListByCodeNamesAndCodeValuesQuery } from './ListByCodeNamesAndCodeValues';

package/dist/src/apis/WMS/models.d.ts

@@ -96,6 +96,14 @@ export declare class Description {
     sysDefFlg?: number | null;
     constructor(obj?: Description);
 }
+/** 根据多个 codeName 和 codeValue 批量查询描述数据. */
+export declare class DescriptionBatchQuery {
+    /** 描述组的编号. */
+    codeName?: string | null;
+    /** 描述项的编号列表. */
+    codeValues?: Array<string> | null;
+    constructor(obj?: DescriptionBatchQuery);
+}
 /** 获取 SQL 查询结果的元数据. */
 export declare class GetResultSetMetadataFromSqlQuery {
     /** SQL. */

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

@@ -1,152 +1,11 @@
-import { VarButton } from '../../apis/WMS/models';
-import { KG_BUTTON_TYPE } from '../../consts';
-import { IKgButtonClickCb, IKgButtonEvent, IKgButtonImportOkCb, IKgButtonSubmitCancelCb, IKgButtonSubmitSaveCb } from './index.store';
-/**
- * @param formID 界面标识.
- */
-export declare function useKgButton(formID?: string | null): {
-    formID: string;
-    store: import("pinia").Store<"KgButton", {
-        currentButtonMap: Map<string, VarButton | null>;
-        isCurrentButtonRequestingMap: Map<string, boolean>;
-        isClickInterceptedMap: Map<string, boolean>;
-        clickListenersMap: Map<string, IKgButtonClickCb[]>;
-        importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-        submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-        submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-    }, {
-        isClickIntercepted(state: {
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        }>): (formID: string | null | undefined, param: {
-            type?: KG_BUTTON_TYPE | undefined; /**
-             * <p>判断某个按钮是否是「当前按钮」.</p>
-             *
-             * <ul>
-             *     <li>
-             *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
-             *         <p>调用方式如下: <code>isCurrentButton({ type: KG_BUTTON_TYPE.CREATE });</code></p>
-             *     </li>
-             *     <li>
-             *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
-             *         <p>根据参数 {@link param.varName} 获取按钮.</p>
-             *         <p>调用方式如下: <code>isCurrentButton({ varName: 'SOME-OTHER-BUTTON' });</code></p>
-             *     </li>
-             * </ul>
-             *
-             * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
-             * @param param.varName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
-             */
-            varName?: string | null | undefined;
-        }) => boolean;
-        isCurrentButtonRequesting(state: {
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        }>): (formID: string | null | undefined) => boolean;
-        getCurrentButton: (state: {
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        }>) => (formID: string | null | undefined) => VarButton | null;
-        isCurrentButton(state: {
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        }>): (formID: string, param: {
-            varName?: string | undefined;
-            type?: KG_BUTTON_TYPE | undefined;
-        }) => boolean;
-        getSearchButton(state: {
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            currentButtonMap: Map<string, VarButton | null>;
-            isCurrentButtonRequestingMap: Map<string, boolean>;
-            isClickInterceptedMap: Map<string, boolean>;
-            clickListenersMap: Map<string, IKgButtonClickCb[]>;
-            importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-            submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-            submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-        }>): (formID: string | null | undefined) => VarButton | null;
-    }, {
-        dispose(formID: string | null | undefined): void;
-        addEventListener(formID: string, event: IKgButtonEvent, cb: import("./index.store").IKgButtonCb): void;
-        removeEventListener(formID: string, event: IKgButtonEvent, cb?: import("./index.store").IKgButtonCb | undefined): void;
-        emit(formID: string, event: IKgButtonEvent, param: any): Promise<boolean>;
-        setIsClickIntercepted(formID: string | null | undefined, param: {
-            isIntercepted: boolean;
-            type?: KG_BUTTON_TYPE | undefined;
-            varName?: string | null | undefined;
-        }): void;
-        setIsCurrentButtonRequesting(formID: string | null | undefined, param: {
-            isRequesting: boolean;
-        }): void;
-        setCurrentButton(formID: string, param: {
-            type?: KG_BUTTON_TYPE | undefined;
-            varName?: string | null | undefined;
-        } | null): Promise<void>;
-        click(formID: string, type: KG_BUTTON_TYPE, variableName?: string | undefined): void;
-    }>;
+import { ComputedRef } from 'vue';
+import { IRemoveEventListenerHandler, KG_BUTTON_TYPE } from '../../consts';
+import { IKgButtonClickCb, IKgButtonImportOkCb, IKgButtonStore, IKgButtonSubmitCancelCb, IKgButtonSubmitSaveCb } from './index.store';
+export interface IUseKgButton {
     /**
      * <p>手动点击某个按钮.</p>
      * <p>调用此方法相当于手动触发某个按钮的点击事件.</p>
      *
-     * @param param.
      * @param param.type 按钮类型.
      * @param param.variableName 按钮变量名称.
      */
@@ -157,45 +16,35 @@ export declare function useKgButton(formID?: string | null): {
     /**
      * <p>「当前按钮」.</p>
      */
-    currentButton: import("vue").ComputedRef<VarButton | null>;
+    currentButton: ComputedRef<ReturnType<IKgButtonStore['getCurrentButton']>>;
     /**
-     * <p>「查询按钮」.</p>
+     * 界面标识.
      */
-    searchButton: import("vue").ComputedRef<VarButton | null>;
-    /**
-     * <p>判断「当前按钮」的 click 事件是否被拦截.</p>
-     */
-    isCurrentButtonClickIntercepted: import("vue").ComputedRef<boolean>;
-    /**
-     * <p>判断「当前按钮」是否正在请求后端接口.</p>
-     */
-    isCurrentButtonRequesting: import("vue").ComputedRef<boolean>;
+    formID: string;
     /**
-     * <p>设置「当前按钮」. 比如点击「创建」按钮, 则此时「创建」按钮就是「当前按钮」, 同一时间最多只会有一个按钮处于「正在执行」状态.</p>
+     * <p>判断某个按钮的 click 事件是否被拦截.</p>
+     * <p>用户调用 <code>kgVar.kgButton.onClick(cb)</code> 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
+     * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
      *
      * <ul>
      *     <li>
-     *         <p>如果参数 {@link param} === null, 表示清空「当前按钮」.</p>
-     *         <p>调用方式如下: <code>setCurrentButton(null);</code></p>
-     *     </li>
-     *     <li>
-     *         <p>否则, 如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
-     *         <p>调用方式如下: <code>setCurrentButton({ type: KG_BUTTON_TYPE.CREATE });</code></p>
+     *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
+     *         <p>调用方式如下: <code>isClickIntercepted({ type: KG_BUTTON_TYPE.CREATE });</code></p>
      *     </li>
      *     <li>
-     *         <p>否则, 如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
+     *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
      *         <p>根据参数 {@link param.varName} 获取按钮.</p>
-     *         <p>调用方式如下: <code>setCurrentButton({ varName: 'SOME-OTHER-BUTTON' });</code></p>
+     *         <p>调用方式如下: <code>isClickIntercepted({ varName: 'SOME-OTHER-BUTTON' });</code></p>
      *     </li>
      * </ul>
      *
      * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
      * @param param.varName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
      */
-    setCurrentButton(param: {
+    isClickIntercepted(param: {
         type?: KG_BUTTON_TYPE;
         varName?: string | null;
-    } | null): Promise<void>;
+    }): boolean;
     /**
      * <p>判断某个按钮是否是「当前按钮」.</p>
      *
@@ -219,29 +68,71 @@ export declare function useKgButton(formID?: string | null): {
         varName?: string;
     }): boolean;
     /**
-     * <p>判断某个按钮的 click 事件是否被拦截.</p>
-     * <p>用户调用 <code>kgVar.kgButton().onClick(cb)</code> 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
-     * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
+     * <p>判断「当前按钮」的 click 事件是否被拦截.</p>
+     */
+    isCurrentButtonClickIntercepted: ComputedRef<ReturnType<IKgButtonStore['isClickIntercepted']>>;
+    /**
+     * <p>判断「当前按钮」是否正在请求后端接口.</p>
+     */
+    isCurrentButtonRequesting: ComputedRef<ReturnType<IKgButtonStore['isCurrentButtonRequesting']>>;
+    /**
+     * 事件: 点击按钮.
+     *
+     * @param cb 回调函数.
+     * @param once 是否只会触发一次. 默认为 undefined.
+     */
+    onClick(cb: IKgButtonClickCb, once?: boolean): IRemoveEventListenerHandler;
+    /**
+     * 事件: 导入成功, 导入接口调用成功.
+     *
+     * @param cb 回调函数.
+     * @param once 是否只会触发一次. 默认为 undefined.
+     */
+    onImportOk(cb: IKgButtonImportOkCb, once?: boolean): IRemoveEventListenerHandler;
+    /**
+     * 事件: 表格内编辑时, 点击取消按钮.
+     *
+     * @param cb 回调函数.
+     * @param once 是否只会触发一次. 默认为 undefined.
+     */
+    onSubmitCancel(cb: IKgButtonSubmitCancelCb, once?: boolean): IRemoveEventListenerHandler;
+    /**
+     * 事件: 表格内编辑时, 点击保存按钮.
+     *
+     * @param cb 回调函数.
+     * @param once 是否只会触发一次. 默认为 undefined.
+     */
+    onSubmitSave(cb: IKgButtonSubmitSaveCb, once?: boolean): IRemoveEventListenerHandler;
+    /**
+     * <p>「查询按钮」.</p>
+     */
+    searchButton: ComputedRef<ReturnType<IKgButtonStore['getSearchButton']>>;
+    /**
+     * <p>设置「当前按钮」. 比如点击「创建」按钮, 则此时「创建」按钮就是「当前按钮」, 同一时间最多只会有一个按钮处于「正在执行」状态.</p>
      *
      * <ul>
      *     <li>
-     *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
-     *         <p>调用方式如下: <code>isClickIntercepted({ type: KG_BUTTON_TYPE.CREATE });</code></p>
+     *         <p>如果参数 {@link param} === null, 表示清空「当前按钮」.</p>
+     *         <p>调用方式如下: <code>setCurrentButton(null);</code></p>
      *     </li>
      *     <li>
-     *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
+     *         <p>否则, 如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
+     *         <p>调用方式如下: <code>setCurrentButton({ type: KG_BUTTON_TYPE.CREATE });</code></p>
+     *     </li>
+     *     <li>
+     *         <p>否则, 如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
      *         <p>根据参数 {@link param.varName} 获取按钮.</p>
-     *         <p>调用方式如下: <code>isClickIntercepted({ varName: 'SOME-OTHER-BUTTON' });</code></p>
+     *         <p>调用方式如下: <code>setCurrentButton({ varName: 'SOME-OTHER-BUTTON' });</code></p>
      *     </li>
      * </ul>
      *
      * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
      * @param param.varName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
      */
-    isClickIntercepted(param: {
+    setCurrentButton(param: {
         type?: KG_BUTTON_TYPE;
         varName?: string | null;
-    }): boolean;
+    } | null): Promise<void>;
     /**
      * <p>设置某个按钮的 click 事件是否被拦截.</p>
      *
@@ -275,27 +166,11 @@ export declare function useKgButton(formID?: string | null): {
         isRequesting: boolean;
     }): void;
     /**
-     * 事件: 点击按钮.
-     * @param cb 回调函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
-     */
-    onClick: (cb: IKgButtonClickCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
-    /**
-     * 事件: 导入成功, 导入接口调用成功.
-     * @param cb 回调函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
-     */
-    onImportOk: (cb: IKgButtonImportOkCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
-    /**
-     * 事件: 表格内编辑时, 点击保存按钮.
-     * @param cb 回调函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
+     * 状态数据.
      */
-    onSubmitSave: (cb: IKgButtonSubmitSaveCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
-    /**
-     * 事件: 表格内编辑时, 点击取消按钮.
-     * @param cb 回调函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
-     */
-    onSubmitCancel: (cb: IKgButtonSubmitCancelCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
-};
+    store: IKgButtonStore;
+}
+/**
+ * @param formID 界面标识.
+ */
+export declare function useKgButton(formID?: string | null): IUseKgButton;