@kengic/vue 0.21.1-beta.1 → 0.21.1-beta.2

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

@@ -1,4 +1,3 @@
-import { StoreDefinition } from 'pinia';
 import { IKgEventCb } from '../../consts';
 import { IKgTableRequestParams } from '../KgTable';
 /**
@@ -10,6 +9,7 @@ import { IKgTableRequestParams } from '../KgTable';
 export declare type IKgSearchEvent = 'ready' | 'search' | 'reset';
 /** 事件监听函数: ready. */
 export declare type IKgSearchReadyCb = ((param: any) => Promise<boolean>) & IKgEventCb;
+/** 事件监听函数: search. */
 export declare type IKgSearchSearchCb = ((param: IKgTableRequestParams) => Promise<boolean>) & IKgEventCb;
 /** 事件监听函数: reset. */
 export declare type IKgSearchResetCb = ((param: any) => Promise<boolean>) & IKgEventCb;
@@ -19,33 +19,198 @@ export declare type IKgSearchCb = IKgSearchReadyCb | IKgSearchSearchCb | IKgSear
 export declare type IKgSearchSearchFn = (param?: IKgTableRequestParams) => void;
 /** 重置方法. */
 export declare type IKgSearchResetFn = () => void;
-export interface IKgSearchState {
-    /** 是否就绪: 查询字段初始完成, 组件渲染完成. */
+export declare const useKgSearchStore: import("pinia").StoreDefinition<"KgSearch", {
+    /**
+     * 是否就绪: 查询字段初始完成, 组件渲染完成.
+     */
     isReadyMap: Map<string, boolean>;
     /** 表单数据对象. */
     modelMap: Map<string, Record<string, any>>;
-    /** 高级查询的操作符表单数据对象. */
-    operatorModelMap: Map<string, Record<string, string>>;
     /** 事件监听函数列表: ready. */
-    onReadyListenersMap: Map<string, Array<IKgSearchReadyCb>>;
-    /** 事件监听函数列表: search. */
-    onSearchListenersMap: Map<string, Array<IKgSearchSearchCb>>;
+    onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
     /** 事件监听函数列表: reset. */
-    onResetListenersMap: Map<string, Array<IKgSearchResetCb>>;
-    /** 查询方法, 可供外部调用, 用来触发查询操作. */
-    searchFnMap: Map<string, IKgSearchSearchFn>;
+    onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+    /** 事件监听函数列表: search. */
+    onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+    /** 高级查询的操作符表单数据对象. */
+    operatorModelMap: Map<string, Record<string, string>>;
     /** 重置方法, 可供外部调用, 用来触发重置操作. */
     resetFnMap: Map<string, IKgSearchResetFn>;
-}
-export declare type IKgSearchStoreDefinition = StoreDefinition<'KgSearch', IKgSearchState, {
-    getIsReady(): (formID: string | null | undefined) => boolean;
-    getModel(): (formID: string | null | undefined) => Record<string, any> | null;
-    getOperatorModel(): (formID: string | null | undefined) => Record<string, string> | null;
-    getSearchFn(): (formID: string | null | undefined) => IKgSearchSearchFn | null;
-    getResetFn(): (formID: string | null | undefined) => IKgSearchResetFn | null;
+    /** 查询方法, 可供外部调用, 用来触发查询操作. */
+    searchFnMap: Map<string, IKgSearchSearchFn>;
 }, {
+    getIsReady(state: {
+        isReadyMap: Map<string, boolean>;
+        modelMap: Map<string, Record<string, any>>;
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        operatorModelMap: Map<string, Record<string, string>>;
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    } & import("pinia").PiniaCustomStateProperties<{
+        /**
+         * 是否就绪: 查询字段初始完成, 组件渲染完成.
+         */
+        isReadyMap: Map<string, boolean>;
+        /** 表单数据对象. */
+        modelMap: Map<string, Record<string, any>>;
+        /** 事件监听函数列表: ready. */
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        /** 事件监听函数列表: reset. */
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        /** 事件监听函数列表: search. */
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        /** 高级查询的操作符表单数据对象. */
+        operatorModelMap: Map<string, Record<string, string>>;
+        /** 重置方法, 可供外部调用, 用来触发重置操作. */
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        /** 查询方法, 可供外部调用, 用来触发查询操作. */
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    }>): (formID: string | null | undefined) => boolean;
+    getModel(state: {
+        isReadyMap: Map<string, boolean>;
+        modelMap: Map<string, Record<string, any>>;
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        operatorModelMap: Map<string, Record<string, string>>;
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    } & import("pinia").PiniaCustomStateProperties<{
+        /**
+         * 是否就绪: 查询字段初始完成, 组件渲染完成.
+         */
+        isReadyMap: Map<string, boolean>;
+        /** 表单数据对象. */
+        modelMap: Map<string, Record<string, any>>;
+        /** 事件监听函数列表: ready. */
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        /** 事件监听函数列表: reset. */
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        /** 事件监听函数列表: search. */
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        /** 高级查询的操作符表单数据对象. */
+        operatorModelMap: Map<string, Record<string, string>>;
+        /** 重置方法, 可供外部调用, 用来触发重置操作. */
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        /** 查询方法, 可供外部调用, 用来触发查询操作. */
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    }>): (formID: string | null | undefined) => Record<string, any> | null;
+    getOperatorModel(state: {
+        isReadyMap: Map<string, boolean>;
+        modelMap: Map<string, Record<string, any>>;
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        operatorModelMap: Map<string, Record<string, string>>;
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    } & import("pinia").PiniaCustomStateProperties<{
+        /**
+         * 是否就绪: 查询字段初始完成, 组件渲染完成.
+         */
+        isReadyMap: Map<string, boolean>;
+        /** 表单数据对象. */
+        modelMap: Map<string, Record<string, any>>;
+        /** 事件监听函数列表: ready. */
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        /** 事件监听函数列表: reset. */
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        /** 事件监听函数列表: search. */
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        /** 高级查询的操作符表单数据对象. */
+        operatorModelMap: Map<string, Record<string, string>>;
+        /** 重置方法, 可供外部调用, 用来触发重置操作. */
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        /** 查询方法, 可供外部调用, 用来触发查询操作. */
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    }>): (formID: string | null | undefined) => Record<string, any> | null;
+    /**
+     * 根据 formID 获取查询方法.
+     * @param state
+     */
+    getSearchFn(state: {
+        isReadyMap: Map<string, boolean>;
+        modelMap: Map<string, Record<string, any>>;
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        operatorModelMap: Map<string, Record<string, string>>;
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    } & import("pinia").PiniaCustomStateProperties<{
+        /**
+         * 是否就绪: 查询字段初始完成, 组件渲染完成.
+         */
+        isReadyMap: Map<string, boolean>;
+        /** 表单数据对象. */
+        modelMap: Map<string, Record<string, any>>;
+        /** 事件监听函数列表: ready. */
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        /** 事件监听函数列表: reset. */
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        /** 事件监听函数列表: search. */
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        /** 高级查询的操作符表单数据对象. */
+        operatorModelMap: Map<string, Record<string, string>>;
+        /** 重置方法, 可供外部调用, 用来触发重置操作. */
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        /** 查询方法, 可供外部调用, 用来触发查询操作. */
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    }>): (formID: string | null | undefined) => IKgSearchSearchFn | null;
+    /**
+     * 根据 formID 获取重置方法.
+     * @param state
+     */
+    getResetFn(state: {
+        isReadyMap: Map<string, boolean>;
+        modelMap: Map<string, Record<string, any>>;
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        operatorModelMap: Map<string, Record<string, string>>;
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    } & import("pinia").PiniaCustomStateProperties<{
+        /**
+         * 是否就绪: 查询字段初始完成, 组件渲染完成.
+         */
+        isReadyMap: Map<string, boolean>;
+        /** 表单数据对象. */
+        modelMap: Map<string, Record<string, any>>;
+        /** 事件监听函数列表: ready. */
+        onReadyListenersMap: Map<string, IKgSearchReadyCb[]>;
+        /** 事件监听函数列表: reset. */
+        onResetListenersMap: Map<string, IKgSearchResetCb[]>;
+        /** 事件监听函数列表: search. */
+        onSearchListenersMap: Map<string, IKgSearchSearchCb[]>;
+        /** 高级查询的操作符表单数据对象. */
+        operatorModelMap: Map<string, Record<string, string>>;
+        /** 重置方法, 可供外部调用, 用来触发重置操作. */
+        resetFnMap: Map<string, IKgSearchResetFn>;
+        /** 查询方法, 可供外部调用, 用来触发查询操作. */
+        searchFnMap: Map<string, IKgSearchSearchFn>;
+    }>): (formID: string | null | undefined) => IKgSearchResetFn | null;
+}, {
+    /**
+     * 清理数据.
+     * @param formID 页面标识.
+     */
     dispose(formID: string | null | undefined): void;
+    /**
+     * 注册事件监听.
+     * @param formID 界面标识.
+     * @param event 事件名称.
+     * @param cb 回调函数.
+     */
     addEventListener(formID: string, event: IKgSearchEvent, cb: IKgSearchCb): void;
+    /**
+     * 退订事件监听.
+     * @param formID 界面标识.
+     * @param event 事件名称.
+     * @param cb 回调函数.
+     */
     removeEventListener(formID: string, event: IKgSearchEvent, cb?: IKgSearchCb): void;
     /**
      * 触发事件.
@@ -54,28 +219,38 @@ export declare type IKgSearchStoreDefinition = StoreDefinition<'KgSearch', IKgSe
      * @param param 事件参数.
      */
     emit(formID: string, event: IKgSearchEvent, param: IKgSearchCbParam): Promise<boolean>;
+    setIsReady(formID: string | null | undefined, ready?: boolean): void;
     /**
-     * 设置是否就绪.
+     * 设置表单数据.
      * @param formID 界面标识.
-     * @param ready 是否就绪.
+     * @param model 表单数据.
      */
-    setIsReady(formID: string | null | undefined, ready?: boolean): void;
-    setModel(formID: string, model: Record<string, any>): void;
-    setOperatorModel(formID: string, model: Record<string, string>): void;
+    setModel(formID: string | null | undefined, model?: Record<string, any> | null): void;
+    setOperatorModel(formID: string | null | undefined, model?: Record<string, any> | null): void;
+    /**
+     * 修改查询字段的表单数据的部分属性.
+     *
+     * @param formID 界面标识.
+     * @param properties 要修改的部分属性.
+     */
+    patchModel(formID: string | null | undefined, properties?: Record<string, any> | null): Promise<void>;
     /**
-     * 修改部分查询字段的值.
+     * 修改查询字段的高级查询操作符的部分属性.
+     *
      * @param formID 界面标识.
-     * @param model 要修改的查询字段.
+     * @param properties 要修改的部分属性.
      */
-    patchModel(formID: string, model: Record<string, any>): Promise<void>;
+    patchOperatorModel(formID: string | null | undefined, properties?: Record<string, any> | null): Promise<void>;
     /**
-     * 修改部分查询字段的高级查询操作符.
+     * 设置查询方法.
      * @param formID 界面标识.
-     * @param model 要修改的查询字段.
+     * @param fn 查询方法.
      */
-    patchOperatorModel(formID: string, model: Record<string, string>): Promise<void>;
     setSearchFn(formID: string | null | undefined, fn?: IKgSearchSearchFn | null): void;
+    /**
+     * 设置重置方法.
+     * @param formID 界面标识.
+     * @param fn 重置方法.
+     */
     setResetFn(formID: string | null | undefined, fn?: IKgSearchResetFn | null): void;
 }>;
-export declare type IKgSearchStore = ReturnType<IKgSearchStoreDefinition>;
-export declare const useKgSearchStore: () => IKgSearchStoreDefinition;

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

@@ -11,15 +11,19 @@ export declare function useKgSubmit(formID?: string | null): {
         isLoading(): (formID?: string | null | undefined) => boolean;
         getModel(): (formID: string | null | undefined) => Record<string, any> | null;
         getFormRef(): (formID?: string | null | undefined) => import("vue").Ref<import("ant-design-vue").FormInstance | null>;
-        getRules(): (formID?: string | null | undefined) => import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>;
-    }, {
-        dispose(formID?: string | null | undefined): void;
-        /**
-         * <p>事件: 请求失败. 请求失败了, 或者请求返回了错误消息.</p>
+        getRules(): (formID?: string | null | undefined) => import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>; /**
+         * <p>事件: 关闭提交弹窗. 下面几种场景都会触发此事件:</p>
+         * <ul>
+         *     <li>点击右上角的关闭按钮,</li>
+         *     <li>点击取消按钮,</li>
+         *     <li>点击保存按钮之后, 调用接口成功, 关闭弹窗,</li>
+         * </ul>
          * @param cb 回调函数.
          * @param once 是否只会触发一次. 默认为 undefined.
          * @return {} 移除事件监听函数.
          */
+    }, {
+        dispose(formID?: string | null | undefined): void;
         addEventListener(formID: string, event: IKgSubmitEvent, cb: import("./index.store").IKgSubmitCb): void;
         removeEventListener(formID: string, event: IKgSubmitEvent, cb?: import("./index.store").IKgSubmitCb | undefined): void;
         emit(formID: string, event: IKgSubmitEvent, param: import("./index.store").IKgSubmitCbParam): Promise<boolean>;
@@ -94,7 +98,12 @@ export declare function useKgSubmit(formID?: string | null): {
      */
     onError: (cb: IKgSubmitErrorCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
     /**
-     * <p>事件: 关闭提交弹窗. 点击取消或者点击确定并且成功之后, 都会触发.</p>
+     * <p>事件: 关闭提交弹窗. 下面几种场景都会触发此事件:</p>
+     * <ul>
+     *     <li>点击右上角的关闭按钮,</li>
+     *     <li>点击取消按钮,</li>
+     *     <li>点击保存按钮之后, 调用接口成功, 关闭弹窗,</li>
+     * </ul>
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      * @return {} 移除事件监听函数.

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

@@ -69,12 +69,22 @@ export declare type IKgSubmitAfterValidateCbParam = {
 export declare type IKgSubmitAfterValidateCb = ((param: IKgSubmitAfterValidateCbParam) => Promise<boolean>) & IKgEventCb;
 /** 事件监听函数: beforeRequest. */
 export declare type IKgSubmitBeforeRequestCbParam = {
+    /**
+     * <p>请求参数.</p>
+     * <p>是一个对象或者列表.</p>
+     */
     data: Ref<Record<string, any> | Array<Record<string, any>>>;
     isCopying: boolean | null;
     isCreating: boolean | null;
     isDeleting: boolean | null;
     isUpdating: boolean | null;
+    /**
+     * 表单数据对象.
+     */
     model: Ref<Record<string, any>>;
+    /**
+     * 请求参数.
+     */
     params: Ref<Record<string, any>>;
     row: IKgTableRow | null;
     rows: Array<IKgTableRow> | null;

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

@@ -12,11 +12,13 @@ export declare type IKgTableRow = {
 export interface IKgTableRequestParams {
     /**
      * 是否查询首页, 否则查询当页.
+     *
      * @default false
      */
     isSearchFirstPage?: boolean;
     /**
-     * 是否保留行的勾选状态.
+     * 重新查询之后, 是否保留行的勾选状态.
+     *
      * @default false
      */
     isPreserveSelectedRows?: boolean;

package/package.json

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