@kengic/vue 0.22.1-beta.0 → 0.23.1

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

@@ -1,5 +1,6 @@
+import { StoreDefinition } from 'pinia';
 import { VarButton } from '../../apis/WMS/models';
-import { IKgEventCb, KG_BUTTON_TYPE } from '../../consts';
+import { IKgEventListener, KG_BUTTON_TYPE } from '../../consts';
 /**
  * 事件类型.
  *   'click':             点击按钮
@@ -8,222 +9,95 @@ import { IKgEventCb, KG_BUTTON_TYPE } from '../../consts';
  *   'submitCancel':      表格内编辑时, 点击取消按钮
  */
 export declare type IKgButtonEvent = 'click' | 'importOk' | 'submitSave' | 'submitCancel';
-export declare type IKgButtonClickCbParam = {
+export declare type IKgButtonClickEventListenerParameter = {
     /**
      * 被点击的按钮.
      */
     button: VarButton;
 };
-export declare type IKgButtonClickCb = ((param: IKgButtonClickCbParam) => Promise<boolean>) & IKgEventCb;
-export declare type IKgButtonImportOkCbParam = {
+export declare type IKgButtonClickEventListener = ((param: IKgButtonClickEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgButtonImportOkEventListenerParameter = {
     button?: VarButton | null;
 };
-export declare type IKgButtonImportOkCb = ((args: IKgButtonImportOkCbParam) => Promise<boolean>) & IKgEventCb;
-export declare type IKgButtonSubmitSaveCb = (() => Promise<boolean>) & IKgEventCb;
-export declare type IKgButtonSubmitCancelCb = (() => Promise<boolean>) & IKgEventCb;
-export declare type IKgButtonCbParam = IKgButtonClickCbParam | IKgButtonImportOkCbParam;
-export declare type IKgButtonCb = IKgButtonClickCb | IKgButtonImportOkCb | IKgButtonSubmitSaveCb | IKgButtonSubmitCancelCb;
-export declare const useKgButtonStore: import("pinia").StoreDefinition<"KgButton", {
+export declare type IKgButtonImportOkEventListener = ((param: IKgButtonImportOkEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgButtonSubmitSaveEventListenerParameter = {};
+export declare type IKgButtonSubmitSaveEventListener = ((param: IKgButtonSubmitSaveEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgButtonSubmitCancelEventListenerParameter = {};
+export declare type IKgButtonSubmitCancelEventListener = ((param: IKgButtonSubmitCancelEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgButtonEventListenerParameter = IKgButtonClickEventListenerParameter | IKgButtonImportOkEventListenerParameter | IKgButtonSubmitSaveEventListenerParameter | IKgButtonSubmitCancelEventListenerParameter;
+export declare type IKgButtonEventListener = IKgButtonClickEventListener | IKgButtonImportOkEventListener | IKgButtonSubmitSaveEventListener | IKgButtonSubmitCancelEventListener;
+export interface IUseKgButtonStoreState {
+    clickEventListenersMap: Map<string, Array<IKgButtonClickEventListener>>;
     /**
      * <p>当前按钮.</p>
      * <p>同一时间最多只会有一个按钮处于「正在执行」状态, 比如点击了创建按钮, 则当前按钮就是创建按钮.</p>
      */
     currentButtonMap: Map<string, VarButton | null>;
-    /**
-     * <p>当前按钮是否正在请求后端接口.</p>
-     * <p>比如点击了创建按钮, 打开了创建弹窗, 此时「当前按钮」指的就是创建按钮. 当点击弹窗中的保存按钮时, 表示正在请求后端接口.</p>
-     */
-    isCurrentButtonRequestingMap: Map<string, boolean>;
+    importOkEventListenersMap: Map<string, Array<IKgButtonImportOkEventListener>>;
     /**
      * <p>按钮的 click 事件是否被拦截.</p>
-     * <p>用户调用 kgVar.kgButton().onClick(cb) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
+     * <p>用户调用 kgVar.kgButton.onClick(cb) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
      * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
      */
     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<{
-        /**
-         * <p>当前按钮.</p>
-         * <p>同一时间最多只会有一个按钮处于「正在执行」状态, 比如点击了创建按钮, 则当前按钮就是创建按钮.</p>
-         */
-        currentButtonMap: Map<string, VarButton | null>;
-        /**
-         * <p>当前按钮是否正在请求后端接口.</p>
-         * <p>比如点击了创建按钮, 打开了创建弹窗, 此时「当前按钮」指的就是创建按钮. 当点击弹窗中的保存按钮时, 表示正在请求后端接口.</p>
-         */
-        isCurrentButtonRequestingMap: Map<string, boolean>;
-        /**
-         * <p>按钮的 click 事件是否被拦截.</p>
-         * <p>用户调用 kgVar.kgButton().onClick(cb) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
-         * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
-         */
-        isClickInterceptedMap: Map<string, boolean>;
-        clickListenersMap: Map<string, IKgButtonClickCb[]>;
-        importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-        submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-        submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-    }>): (formID: string | undefined | null, param: {
+    /**
+     * <p>当前按钮是否正在请求后端接口.</p>
+     * <p>比如点击了创建按钮, 打开了创建弹窗, 此时「当前按钮」指的就是创建按钮. 当点击弹窗中的保存按钮时, 表示正在请求后端接口.</p>
+     */
+    isCurrentButtonRequestingMap: Map<string, boolean>;
+    submitCancelEventListenersMap: Map<string, Array<IKgButtonSubmitCancelEventListener>>;
+    submitSaveEventListenersMap: Map<string, Array<IKgButtonSubmitSaveEventListener>>;
+}
+export interface IUseKgButtonStoreGetters {
+    getCurrentButton(): (formID: string | null | undefined) => VarButton | null;
+    getSearchButton(): (formID: string | null | undefined) => VarButton | null;
+    getVarButtons(): (formID: string | null | undefined) => Array<VarButton>;
+    isClickIntercepted(): (formID: string | undefined | null, param: {
         type?: KG_BUTTON_TYPE;
         varName?: string | null;
     }) => 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<{
-        /**
-         * <p>当前按钮.</p>
-         * <p>同一时间最多只会有一个按钮处于「正在执行」状态, 比如点击了创建按钮, 则当前按钮就是创建按钮.</p>
-         */
-        currentButtonMap: Map<string, VarButton | null>;
-        /**
-         * <p>当前按钮是否正在请求后端接口.</p>
-         * <p>比如点击了创建按钮, 打开了创建弹窗, 此时「当前按钮」指的就是创建按钮. 当点击弹窗中的保存按钮时, 表示正在请求后端接口.</p>
-         */
-        isCurrentButtonRequestingMap: Map<string, boolean>;
-        /**
-         * <p>按钮的 click 事件是否被拦截.</p>
-         * <p>用户调用 kgVar.kgButton().onClick(cb) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
-         * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
-         */
-        isClickInterceptedMap: Map<string, boolean>;
-        clickListenersMap: Map<string, IKgButtonClickCb[]>;
-        importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-        submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-        submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-    }>): (formID: string | undefined | null) => 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<{
-        /**
-         * <p>当前按钮.</p>
-         * <p>同一时间最多只会有一个按钮处于「正在执行」状态, 比如点击了创建按钮, 则当前按钮就是创建按钮.</p>
-         */
-        currentButtonMap: Map<string, VarButton | null>;
-        /**
-         * <p>当前按钮是否正在请求后端接口.</p>
-         * <p>比如点击了创建按钮, 打开了创建弹窗, 此时「当前按钮」指的就是创建按钮. 当点击弹窗中的保存按钮时, 表示正在请求后端接口.</p>
-         */
-        isCurrentButtonRequestingMap: Map<string, boolean>;
-        /**
-         * <p>按钮的 click 事件是否被拦截.</p>
-         * <p>用户调用 kgVar.kgButton().onClick(cb) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
-         * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
-         */
-        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<{
-        /**
-         * <p>当前按钮.</p>
-         * <p>同一时间最多只会有一个按钮处于「正在执行」状态, 比如点击了创建按钮, 则当前按钮就是创建按钮.</p>
-         */
-        currentButtonMap: Map<string, VarButton | null>;
-        /**
-         * <p>当前按钮是否正在请求后端接口.</p>
-         * <p>比如点击了创建按钮, 打开了创建弹窗, 此时「当前按钮」指的就是创建按钮. 当点击弹窗中的保存按钮时, 表示正在请求后端接口.</p>
-         */
-        isCurrentButtonRequestingMap: Map<string, boolean>;
-        /**
-         * <p>按钮的 click 事件是否被拦截.</p>
-         * <p>用户调用 kgVar.kgButton().onClick(cb) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
-         * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
-         */
-        isClickInterceptedMap: Map<string, boolean>;
-        clickListenersMap: Map<string, IKgButtonClickCb[]>;
-        importOkListenersMap: Map<string, IKgButtonImportOkCb[]>;
-        submitCancelListenersMap: Map<string, IKgButtonSubmitCancelCb[]>;
-        submitSaveListenersMap: Map<string, IKgButtonSubmitSaveCb[]>;
-    }>): (formID: string, param: {
+    isCurrentButton(): (formID: string, param: {
         varName?: string;
         type?: KG_BUTTON_TYPE;
     }) => 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<{
-        /**
-         * <p>当前按钮.</p>
-         * <p>同一时间最多只会有一个按钮处于「正在执行」状态, 比如点击了创建按钮, 则当前按钮就是创建按钮.</p>
-         */
-        currentButtonMap: Map<string, VarButton | null>;
-        /**
-         * <p>当前按钮是否正在请求后端接口.</p>
-         * <p>比如点击了创建按钮, 打开了创建弹窗, 此时「当前按钮」指的就是创建按钮. 当点击弹窗中的保存按钮时, 表示正在请求后端接口.</p>
-         */
-        isCurrentButtonRequestingMap: Map<string, boolean>;
-        /**
-         * <p>按钮的 click 事件是否被拦截.</p>
-         * <p>用户调用 kgVar.kgButton().onClick(cb) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
-         * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
-         */
-        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;
+    isCurrentButtonRequesting(): (formID: string | undefined | null) => boolean;
+}
+export interface IUseKgButtonStoreActions {
     /**
      * 注册事件监听.
      * @param formID 界面标识.
      * @param event 事件名称.
      * @param cb 回调函数.
      */
-    addEventListener(formID: string, event: IKgButtonEvent, cb: IKgButtonCb): void;
+    addEventListener(formID: string, event: IKgButtonEvent, cb: IKgButtonEventListener): void;
     /**
-     * 退订事件监听.
+     * <p>手动点击某个按钮.</p>
+     * <p>调用此方法相当于手动触发某个按钮的点击事件.</p>
+     *
      * @param formID 界面标识.
-     * @param event 事件名称.
-     * @param cb 回调函数.
+     * @param type 按钮类型.
+     * @param variableName 按钮变量名称.
      */
-    removeEventListener(formID: string, event: IKgButtonEvent, cb?: IKgButtonCb): void;
+    click(formID: string, type: KG_BUTTON_TYPE, variableName?: string): void;
+    dispose(formID: string | null | undefined): void;
     /**
      * 触发事件.
      * @param formID 界面标识.
      * @param event 事件名称.
      * @param param 数据.
      */
-    emit(formID: string, event: IKgButtonEvent, param: IKgButtonCbParam): Promise<boolean>;
+    emit<T = IKgButtonEventListenerParameter>(formID: string, event: IKgButtonEvent, param: T): Promise<boolean>;
+    /**
+     * 退订事件监听.
+     * @param formID 界面标识.
+     * @param event 事件名称.
+     * @param cb 回调函数.
+     */
+    removeEventListener(formID: string, event: IKgButtonEvent, cb?: IKgButtonEventListener): void;
+    setCurrentButton(formID: string, param: {
+        type?: KG_BUTTON_TYPE;
+        varName?: string | null;
+    } | null): Promise<void>;
     setIsClickIntercepted(formID: string | undefined | null, param: {
         isIntercepted: boolean;
         type?: KG_BUTTON_TYPE;
@@ -232,17 +106,7 @@ export declare const useKgButtonStore: import("pinia").StoreDefinition<"KgButton
     setIsCurrentButtonRequesting(formID: string | undefined | null, param: {
         isRequesting: boolean;
     }): void;
-    setCurrentButton(formID: string, param: {
-        type?: KG_BUTTON_TYPE;
-        varName?: string | null;
-    } | null): Promise<void>;
-    /**
-     * <p>手动点击某个按钮.</p>
-     * <p>调用此方法相当于手动触发某个按钮的点击事件.</p>
-     *
-     * @param formID 界面标识.
-     * @param type 按钮类型.
-     * @param variableName 按钮变量名称.
-     */
-    click(formID: string, type: KG_BUTTON_TYPE, variableName?: string): void;
-}>;
+}
+export declare type IUseKgButtonStore = StoreDefinition<'KgButton', IUseKgButtonStoreState, IUseKgButtonStoreGetters, IUseKgButtonStoreActions>;
+export declare type IKgButtonStore = ReturnType<IUseKgButtonStore>;
+export declare const useKgButtonStore: IUseKgButtonStore;

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

@@ -1,55 +1,62 @@
-import { IKgFormChangeCb, IKgFormEvent, IKgFormLookupBeforeOkCb, IKgFormLookupBeforeOpenCb, IKgFormLookupOkCb, IKgFormSelectBeforeSetDatasCb, IKgFormSelectChangeCb } from './index.store';
-/**
- * @param formID 界面标识.
- */
-export declare function useKgForm(formID?: string | null): {
+import { IRemoveEventListenerHandler } from '../../consts';
+import { IKgFormChangeEventListener, IKgFormLookupBeforeOkEventListener, IKgFormLookupBeforeOpenEventListener, IKgFormLookupOkEventListener, IKgFormSelectBeforeRequestEventListener, IKgFormSelectBeforeSetDatasEventListener, IKgFormSelectChangeEventListener, IKgFormStore } from './index.store';
+export declare type IUseKgForm = {
     formID: string;
-    store: import("pinia").Store<"KgForm", {
-        changeListenersMap: Map<string, IKgFormChangeCb[]>;
-        selectBeforeSetDatasListenersMap: Map<string, IKgFormSelectBeforeSetDatasCb[]>;
-        selectChangeListenersMap: Map<string, IKgFormSelectChangeCb[]>;
-        lookupBeforeOpenListenersMap: Map<string, IKgFormLookupBeforeOpenCb[]>;
-        lookupBeforeOkListenersMap: Map<string, IKgFormLookupBeforeOkCb[]>;
-        lookupOkListenersMap: Map<string, IKgFormLookupOkCb[]>;
-    }, {}, {
-        addEventListener(formID: string, event: IKgFormEvent, cb: import("./index.store").IKgFormCb): void;
-        removeEventListener(formID: string, event: IKgFormEvent, cb?: import("./index.store").IKgFormCb | undefined): void;
-        emit<T = import("./index.store").IKgFormCbParam>(formID: string, event: IKgFormEvent, param: T): Promise<boolean>;
-    }>;
-    /**
-     * 事件: 表单控件数据发生变更.
+    /**
+     * 事件: 表单控件的值发生变更.
+     *
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      */
-    onChange: (cb: IKgFormChangeCb, once?: boolean | undefined) => import("../..").IRemoveEventListenerHandler;
+    onChange(cb: IKgFormChangeEventListener, once?: boolean): IRemoveEventListenerHandler;
     /**
-     * 事件: 查询请求成功, 列表数据尚未赋值. 此处可以对查询接口返回的列表数据作处理.
+     * 事件: 查找弹窗点击确定之前. 如果返回 true 则查找弹窗不会触发 kgOk 事件.
+     *
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      */
-    onSelectBeforeSetDatas: (cb: IKgFormSelectBeforeSetDatasCb, once?: boolean | undefined) => import("../..").IRemoveEventListenerHandler;
+    onLookupBeforeOk(cb: IKgFormLookupBeforeOkEventListener, once?: boolean): IRemoveEventListenerHandler;
     /**
-     * 事件: 下拉列表选中某个(可能多个)数据.
+     * 事件: 查找弹窗打开之前.
+     *
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      */
-    onSelectChange: (cb: IKgFormSelectChangeCb, once?: boolean | undefined) => import("../..").IRemoveEventListenerHandler;
+    onLookupBeforeOpen(cb: IKgFormLookupBeforeOpenEventListener, once?: boolean): IRemoveEventListenerHandler;
     /**
-     * 事件: 查找弹窗打开之前.
+     * 事件: 查找弹窗点击确定.
+     *
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      */
-    onLookupBeforeOpen: (cb: IKgFormLookupBeforeOpenCb, once?: boolean | undefined) => import("../..").IRemoveEventListenerHandler;
+    onLookupOk(cb: IKgFormLookupOkEventListener, once?: boolean): IRemoveEventListenerHandler;
     /**
-     * 事件: 查找弹窗点击确定之前. 如果返回 true 则查找弹窗不会触发 kgOk 事件.
+     * 事件: 即将发起查询请求, 如果返回 true 表示不会发起请求.
+     *
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      */
-    onLookupBeforeOk: (cb: IKgFormLookupBeforeOkCb, once?: boolean | undefined) => import("../..").IRemoveEventListenerHandler;
+    onSelectBeforeRequest(cb: IKgFormSelectBeforeRequestEventListener, once?: boolean): IRemoveEventListenerHandler;
     /**
-     * 事件: 查找弹窗点击确定.
+     * 事件: 查询请求成功, 列表数据尚未赋值. 此处可以对查询接口返回的列表数据作处理.
+     *
+     * @param cb 回调函数.
+     * @param once 是否只会触发一次. 默认为 undefined.
+     */
+    onSelectBeforeSetDatas(cb: IKgFormSelectBeforeSetDatasEventListener, once?: boolean): IRemoveEventListenerHandler;
+    /**
+     * 事件: 下拉列表选中某个(可能多个)数据.
+     *
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      */
-    onLookupOk: (cb: IKgFormLookupOkCb, once?: boolean | undefined) => import("../..").IRemoveEventListenerHandler;
+    onSelectChange(cb: IKgFormSelectChangeEventListener, once?: boolean): IRemoveEventListenerHandler;
+    /**
+     * 状态数据.
+     */
+    store: IKgFormStore;
 };
+/**
+ * @param formID 界面标识.
+ */
+export declare function useKgForm(formID?: string | null): IUseKgForm;

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

@@ -1,18 +1,23 @@
+import { StoreDefinition } from 'pinia';
 import { ComputedRef, Ref } from 'vue';
-import { IKgEventCb } from '../../consts';
+import { IKgEventListener, KG_FORM_CONTEXT } from '../../consts';
 import { IKgTableRow } from '../KgTable';
 /**
  * 事件类型.
- *   'change':                   表单控件数据发生变更
+ *   'change':                   表单控件的值发生变更
+ *   'selectBeforeRequest':      即将发起查询请求, 如果返回 true 表示不会发起请求,
  *   'selectBeforeSetDatas':     下拉列表查询请求成功, 列表数据尚未赋值. 此处可以对查询接口返回的列表数据作处理
  *   'selectChange':             下拉列表选中某个(可能多个)数据
  *   'lookupBeforeOpen':         查找弹窗打开之前
  *   'lookupBeforeOk':           查找弹窗点击确定之前. 如果返回 true 则查找弹窗不会触发 kgOk 事件
  *   'lookupOk':                 查找弹窗点击确定
  */
-export declare type IKgFormEvent = 'change' | 'selectBeforeSetDatas' | 'selectChange' | 'lookupBeforeOpen' | 'lookupBeforeOk' | 'lookupOk';
-/** 事件监听函数: change. */
-export declare type IKgFormChangeCbParam = {
+export declare type IKgFormEvent = 'change' | 'selectBeforeRequest' | 'selectBeforeSetDatas' | 'selectChange' | 'lookupBeforeOpen' | 'lookupBeforeOk' | 'lookupOk';
+export declare type IKgFormChangeEventListenerParameter = {
+    /**
+     * 表单控件所处环境.
+     */
+    context: KG_FORM_CONTEXT;
     isCopying: boolean | null;
     isCreating: boolean | null;
     isDeleting: boolean | null;
@@ -26,9 +31,27 @@ export declare type IKgFormChangeCbParam = {
      */
     variableName: string;
 };
-export declare type IKgFormChangeCb = ((param: IKgFormChangeCbParam) => Promise<boolean>) & IKgEventCb;
-/** 事件监听函数: selectBeforeSetDatas. */
-export declare type IKgFormSelectBeforeSetDatasCbParam<T = any> = {
+export declare type IKgFormChangeEventListener = ((param: IKgFormChangeEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgFormSelectBeforeRequestEventListenerParameter = {
+    /**
+     * 表单控件所处环境.
+     */
+    context: KG_FORM_CONTEXT;
+    /** 查询接口请求参数. */
+    params: Record<string, any>;
+    /** 查询接口返回的数据, 调用者可以直接修改该数据, 从而实现手动提供列表数据. */
+    response: Ref;
+    /**
+     * 变量名称.
+     */
+    varName: string;
+};
+export declare type IKgFormSelectBeforeRequestEventListener = ((param: IKgFormSelectBeforeRequestEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgFormSelectBeforeSetDatasEventListenerParameter<T = any> = {
+    /**
+     * 表单控件所处环境.
+     */
+    context: KG_FORM_CONTEXT;
     /** 列表数据. */
     datas: Ref<Array<T>>;
     isCopying: boolean | null;
@@ -36,11 +59,14 @@ export declare type IKgFormSelectBeforeSetDatasCbParam<T = any> = {
     isDeleting: boolean | null;
     isUpdating: boolean | null;
     /** 变量名称. */
-    variableName: string;
+    varName: string;
 };
-export declare type IKgFormSelectBeforeSetDatasCb = ((param: IKgFormSelectBeforeSetDatasCbParam) => Promise<boolean>) & IKgEventCb;
-/** 事件监听函数: selectChange. */
-export declare type IKgFormSelectChangeCbParam = {
+export declare type IKgFormSelectBeforeSetDatasEventListener = ((param: IKgFormSelectBeforeSetDatasEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgFormSelectChangeEventListenerParameter = {
+    /**
+     * 表单控件所处环境.
+     */
+    context: KG_FORM_CONTEXT;
     isCopying: boolean | null;
     isCreating: boolean | null;
     isDeleting: boolean | null;
@@ -48,7 +74,7 @@ export declare type IKgFormSelectChangeCbParam = {
     isMultiple: boolean;
     isUpdating: boolean | null;
     /** 表单数据对象. */
-    model: Ref<Record<string, any>> | null;
+    model: Ref<Record<string, any> | null> | null;
     /** 选中的数据对象组成的数组, 如果是单选则数组中只有一个数据对象. */
     rows: Array<any> | null;
     /** 选中的数据组成的数组, 如果是单选则数组中只有一个数据. */
@@ -56,17 +82,23 @@ export declare type IKgFormSelectChangeCbParam = {
     /** 变量. */
     var_nam: string;
 };
-export declare type IKgFormSelectChangeCb = ((param: IKgFormSelectChangeCbParam) => Promise<boolean>) & IKgEventCb;
-/** 事件监听函数: lookupBeforeOpen. */
-export declare type IKgFormLookupBeforeOpenCbParam = {
+export declare type IKgFormSelectChangeEventListener = ((param: IKgFormSelectChangeEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgFormLookupBeforeOpenEventListenerParameter = {
+    /**
+     * 表单控件所处环境.
+     */
+    context: KG_FORM_CONTEXT;
     /** 查找弹出的界面标识. */
     lookupFormID: string;
     /** 变量. */
     var_nam: string;
 };
-export declare type IKgFormLookupBeforeOpenCb = ((param: IKgFormLookupBeforeOpenCbParam) => Promise<boolean>) & IKgEventCb;
-/** 事件监听函数: lookupBeforeOk. */
-export declare type IKgFormLookupBeforeOkCbParam = {
+export declare type IKgFormLookupBeforeOpenEventListener = ((param: IKgFormLookupBeforeOpenEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgFormLookupBeforeOkEventListenerParameter = {
+    /**
+     * 表单控件所处环境.
+     */
+    context: KG_FORM_CONTEXT;
     /** 是否多选, 否则单选. */
     isMultiple: boolean;
     /**
@@ -86,9 +118,12 @@ export declare type IKgFormLookupBeforeOkCbParam = {
     /** 变量. */
     var_nam: string;
 };
-export declare type IKgFormLookupBeforeOkCb = ((param: IKgFormLookupBeforeOkCbParam) => Promise<boolean>) & IKgEventCb;
-/** 事件监听函数: lookupOk. */
-export declare type IKgFormLookupOkCbParam = {
+export declare type IKgFormLookupBeforeOkEventListener = ((param: IKgFormLookupBeforeOkEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgFormLookupOkEventListenerParameter = {
+    /**
+     * 表单控件所处环境.
+     */
+    context: KG_FORM_CONTEXT;
     /** 是否多选, 否则单选. */
     isMultiple: boolean;
     /** 表单数据对象. */
@@ -110,36 +145,48 @@ export declare type IKgFormLookupOkCbParam = {
     /** 变量. */
     var_nam: string;
 };
-export declare type IKgFormLookupOkCb = ((param: IKgFormLookupOkCbParam) => Promise<boolean>) & IKgEventCb;
-export declare type IKgFormCbParam = IKgFormChangeCbParam | IKgFormSelectBeforeSetDatasCbParam | IKgFormSelectChangeCbParam | IKgFormLookupBeforeOpenCbParam | IKgFormLookupBeforeOkCbParam | IKgFormLookupOkCbParam;
-export declare type IKgFormCb = IKgFormChangeCb | IKgFormSelectBeforeSetDatasCb | IKgFormSelectChangeCb | IKgFormLookupBeforeOpenCb | IKgFormLookupBeforeOkCb | IKgFormLookupOkCb;
-export declare const useKgFormStore: import("pinia").StoreDefinition<"KgForm", {
-    changeListenersMap: Map<string, IKgFormChangeCb[]>;
-    selectBeforeSetDatasListenersMap: Map<string, IKgFormSelectBeforeSetDatasCb[]>;
-    selectChangeListenersMap: Map<string, IKgFormSelectChangeCb[]>;
-    lookupBeforeOpenListenersMap: Map<string, IKgFormLookupBeforeOpenCb[]>;
-    lookupBeforeOkListenersMap: Map<string, IKgFormLookupBeforeOkCb[]>;
-    lookupOkListenersMap: Map<string, IKgFormLookupOkCb[]>;
-}, {}, {
+export declare type IKgFormLookupOkEventListener = ((param: IKgFormLookupOkEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgFormEventListenerParameter = IKgFormChangeEventListenerParameter | IKgFormSelectBeforeRequestEventListenerParameter | IKgFormSelectBeforeSetDatasEventListenerParameter | IKgFormSelectChangeEventListenerParameter | IKgFormLookupBeforeOpenEventListenerParameter | IKgFormLookupBeforeOkEventListenerParameter | IKgFormLookupOkEventListenerParameter;
+export declare type IKgFormEventListener = IKgFormChangeEventListener | IKgFormSelectBeforeRequestEventListener | IKgFormSelectBeforeSetDatasEventListener | IKgFormSelectChangeEventListener | IKgFormLookupBeforeOpenEventListener | IKgFormLookupBeforeOkEventListener | IKgFormLookupOkEventListener;
+export interface IUseKgFormStoreState {
+    changeEventListenersMap: Map<string, Array<IKgFormChangeEventListener>>;
+    lookupBeforeOkEventListenersMap: Map<string, Array<IKgFormLookupBeforeOkEventListener>>;
+    lookupBeforeOpenEventListenersMap: Map<string, Array<IKgFormLookupBeforeOpenEventListener>>;
+    lookupOkEventListenersMap: Map<string, Array<IKgFormLookupOkEventListener>>;
+    selectBeforeRequestEventListenersMap: Map<string, Array<IKgFormSelectBeforeRequestEventListener>>;
+    selectBeforeSetDatasEventListenersMap: Map<string, Array<IKgFormSelectBeforeSetDatasEventListener>>;
+    selectChangeEventListenersMap: Map<string, Array<IKgFormSelectChangeEventListener>>;
+}
+export interface IUseKgFormStoreGetters {
+}
+export interface IUseKgFormStoreActions {
     /**
      * 注册事件监听.
      * @param formID 界面标识.
      * @param event 事件名称.
      * @param cb 回调函数.
      */
-    addEventListener(formID: string, event: IKgFormEvent, cb: IKgFormCb): void;
+    addEventListener(formID: string, event: IKgFormEvent, cb: IKgFormEventListener): void;
     /**
-     * 退订事件监听.
-     * @param formID 界面标识.
-     * @param event 事件名称.
-     * @param cb 回调函数.
+     * 清理数据.
+     * @param formID 页面标识.
      */
-    removeEventListener(formID: string, event: IKgFormEvent, cb?: IKgFormCb): void;
+    dispose(formID: string | null | undefined): void;
     /**
      * 触发事件.
      * @param formID 界面标识.
      * @param event 事件名称.
      * @param param 数据.
      */
-    emit<T = IKgFormCbParam>(formID: string, event: IKgFormEvent, param: T): Promise<boolean>;
-}>;
+    emit<T = IKgFormEventListenerParameter>(formID: string, event: IKgFormEvent, param: T): Promise<boolean>;
+    /**
+     * 退订事件监听.
+     * @param formID 界面标识.
+     * @param event 事件名称.
+     * @param cb 回调函数.
+     */
+    removeEventListener(formID: string, event: IKgFormEvent, cb?: IKgFormEventListener): void;
+}
+export declare type IUseKgFormStore = StoreDefinition<'KgForm', IUseKgFormStoreState, IUseKgFormStoreGetters, IUseKgFormStoreActions>;
+export declare type IKgFormStore = ReturnType<IUseKgFormStore>;
+export declare const useKgFormStore: IUseKgFormStore;

package/dist/src/components/KgForm.Item/KgForm.Item.d.ts

@@ -6,7 +6,7 @@ declare const _default: import("vue").DefineComponent<{
         required: boolean;
     };
     kgContext: {
-        type: import("vue").PropType<string>;
+        type: import("vue").PropType<KG_FORM_CONTEXT>;
         default: KG_FORM_CONTEXT;
     };
     kgDisabled: {
@@ -48,7 +48,7 @@ declare const _default: import("vue").DefineComponent<{
         required: boolean;
     };
     kgContext: {
-        type: import("vue").PropType<string>;
+        type: import("vue").PropType<KG_FORM_CONTEXT>;
         default: KG_FORM_CONTEXT;
     };
     kgDisabled: {
@@ -91,7 +91,7 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     value: import("./index.vm").IKgFormItemValue;
     kgDisabled: boolean;
-    kgContext: string;
+    kgContext: KG_FORM_CONTEXT;
     kgShowLabel: boolean;
     kgAllowClear: boolean;
     kgShowTime: boolean | import("ant-design-vue/es/vc-picker/panels/TimePanel").SharedTimeProps<import("dayjs").Dayjs>;

package/dist/src/components/KgForm.Item/{KgForm.Item.hooks.d.ts → KgForm.Item.service.d.ts}

@@ -1,11 +1,11 @@
-import { IKgFormItemProps } from './index.vm';
-export declare function _useFormRules(props: IKgFormItemProps): {
+import { KgFormItemProps } from './index.vm';
+export declare function _useFormRules(props: KgFormItemProps): {
     /** 表单验证规则. */
     formRules: import("vue").ComputedRef<import("ant-design-vue/es/form").RuleObject[]>;
     /** 正在计算表单验证规则. */
     isFormRulesLoading: import("vue").Ref<boolean>;
 };
-export declare function useKgFormItem<T = Record<string, any>>(props?: IKgFormItemProps): {
+export declare function useKgFormItem<T = Record<string, any>>(props?: KgFormItemProps): {
     /** 控件类型. */
     controlType: import("vue").ComputedRef<string | null | undefined>;
     /** 控件配置参数. */