@kengic/vue 0.30.1-beta.93 → 0.30.1-beta.95

package/component/KgSubmit/KgSubmit.store.ts

@@ -0,0 +1,568 @@
+import { ____ERROR____ } from '@kengic/core.core';
+import { RuleObject } from 'ant-design-vue/es/form';
+import { FormInstance } from 'ant-design-vue/lib/form/Form';
+import { isNil } from 'lodash-es';
+import { defineStore, StoreDefinition } from 'pinia';
+import { isReactive, reactive, ref, Ref, watch } from 'vue';
+import { VarProfileDetail, VarSubmitConfig, VarSubmitDetail } from '../../api/WMS/models';
+import { KG__VAR_BUTTON__TYPE, IKgStoreDefinition } from '../../model';
+import { transformVarSubmitDetails, useKgVar } from '../KgVar';
+import { emit, IKgSubmit$EventListenerParameter$onAfterSetFormModel } from './KgSubmit.event';
+
+export interface IUseKgSubmitStoreState {
+    /** 表单数据对象. */
+    formModelMap: Map<string, Record<string, any>>;
+
+    /** 表单对象. */
+    formRefMap: Map<string, Ref<FormInstance | null>>;
+
+    /**
+     * <p>自定义的表单验证规则.</p>
+     * <p>在 beforeOk 事件中会将此对象传给调用者, 调用者可以修改此对象, 从而添加自定义的表单验证规则.</p>
+     */
+    formRulesMap: Map<string, Ref<Record<string, Array<RuleObject>>>>;
+
+    isLoadingMap: Map<string, boolean>;
+}
+
+export interface IUseKgSubmitStoreGetters {
+    getFormModel: (fid: string | null | undefined) => Record<string, any> | null;
+
+    getFormRef: (fid: string | null | undefined) => Ref<FormInstance | null>;
+
+    getFormRules: (fid: string | null | undefined) => Ref<Record<string, Array<RuleObject>>>;
+
+    /** 是否处于加载状态. */
+    getIsLoading: (fid: string | null | undefined) => boolean;
+
+    getVarSubmitConfig: (
+        fid: string | null | undefined,
+        param?: {
+            buttonType?: string;
+            buttonVarName?: string | null;
+        },
+    ) => VarSubmitConfig | null;
+
+    getVarSubmitConfigs: (fid: string | null | undefined) => Array<VarSubmitConfig>;
+
+    getVarSubmitDetailByVarProfileDetail: (
+        fid: string | null | undefined,
+        param?: {
+            varProfileDetail: VarProfileDetail | null;
+        },
+    ) => VarSubmitDetail | null;
+
+    getVarSubmitDetails: (
+        fid: string | null | undefined,
+        param?: {
+            buttonType?: string;
+            buttonVarName?: string | null;
+            isKey?: 0 | 1 | null;
+            isVisible?: 0 | 1 | null;
+            searchProfileVarName?: string | null;
+            varName?: string | null;
+        } | null,
+    ) => Array<VarSubmitDetail> | null;
+}
+
+export interface IUseKgSubmitStoreActions {
+    /**
+     * 添加一个「提交表单字段」.
+     *
+     * @param fid 页面标识.
+     * @param varSubmitDetail 要添加的「提交表单字段」.
+     */
+    createVarSubmitDetail(fid: string | null | undefined, varSubmitDetail: VarSubmitDetail): void;
+
+    /**
+     * 清理数据.
+     * @param fid 页面标识.
+     */
+    dispose(fid: string | null | undefined): void;
+
+    /**
+     * <p>修改某个「提交表单字段」的部分属性.</p>
+     *
+     * <p>由于提交表单肯定是关联某个按钮的, 因此需要先确认是哪个按钮, 确认逻辑如下:</p>
+     * <ul>
+     *     <li>
+     *         <p>如果参数 param.buttonVarName === <code>undefined</code> && param.buttonType === <code>undefined</code>, 表示修改的是「当前按钮」.</p>
+     *     </li>
+     *    <li>
+     *         <p>如果参数 param.buttonVarName !== <code>undefined</code>, 则忽略参数 param.buttonType, 根据 param.buttonVarName 和 VarButton.var_nam 是否匹配来确认按钮.</p>
+     *     </li>
+     *    <li>
+     *         <p>如果参数 param.buttonType !== <code>undefined</code> && param.buttonType !== <code>OTHER</code>, 根据 param.buttonType 和 VarButton.typ 是否匹配来确认按钮.</p>
+     *     </li>
+     * </ul>
+     *
+     * @param param.buttonType <p>按钮的类型, 对应的是 VarButton.typ 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
+     * @param param.buttonVarName <p>按钮的变量名称, 对应的是 VarButton.var_nam 属性.</p>
+     * @param param.properties 要修改的部分属性.
+     * @param param.varName 「提交表单字段」的变量名称, 对应的是 {@link VarSubmitDetail.var_nam} 属性.
+     */
+    patchVarSubmitDetail(
+        fid: string | null | undefined,
+        param: {
+            buttonType?: string;
+            buttonVarName?: string | null;
+            properties: VarSubmitDetail;
+            varName: string | null | undefined;
+        },
+    ): Promise<void>;
+
+    /**
+     * <p>修改某些「提交表单字段」的部分属性.</p>
+     *
+     * <p>由于提交表单肯定是关联某个按钮的, 因此需要先确认是哪个按钮, 确认逻辑如下:</p>
+     * <ul>
+     *     <li>
+     *         <p>如果参数 param.buttonVarName === <code>undefined</code> && param.buttonType === <code>undefined</code>, 表示修改的是「当前按钮」.</p>
+     *     </li>
+     *    <li>
+     *         <p>如果参数 param.buttonVarName !== <code>undefined</code>, 则忽略参数 param.buttonType, 根据 param.buttonVarName 和 VarButton.var_nam 是否匹配来确认按钮.</p>
+     *     </li>
+     *    <li>
+     *         <p>如果参数 param.buttonType !== <code>undefined</code> && param.buttonType !== <code>OTHER</code>, 根据 param.buttonType 和 VarButton.typ 是否匹配来确认按钮.</p>
+     *     </li>
+     * </ul>
+     *
+     * @param param.buttonType <p>按钮的类型, 对应的是 VarButton.typ 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
+     * @param param.buttonVarName <p>按钮的变量名称, 对应的是 VarButton.var_nam 属性.</p>
+     * @param param.varSubmitDetailList 要修改的「提交表单字段」列表, 列表中的每个对象只需要包含要修改的属性, 注意 {@link VarSubmitDetail.frm_id} 和 {@link VarSubmitDetail.var_nam} 必须包含.
+     */
+    patchVarSubmitDetailList(param: { buttonType?: string; buttonVarName?: string | null; varSubmitDetailList: Array<VarSubmitDetail> }): Promise<void>;
+
+    setFormModel(fid: string | null | undefined, model?: Record<string, any> | null): void;
+
+    setIsLoading(fid: string, value: boolean): void;
+}
+
+export type IUseKgSubmitStore = StoreDefinition<'KgSubmit', IUseKgSubmitStoreState, IUseKgSubmitStoreGetters, IUseKgSubmitStoreActions>;
+export type IKgSubmitStore = ReturnType<IUseKgSubmitStore>;
+
+// @ts-ignore
+export const useKgSubmitStore: IKgStoreDefinition<IUseKgSubmitStoreGetters, IUseKgSubmitStoreActions> = defineStore('KgSubmit', {
+    actions: {
+        createVarSubmitDetail(fid: string | null | undefined, varSubmitDetail: VarSubmitDetail): void {
+            if (!fid) {
+                return;
+            }
+
+            const kgVar = useKgVar(fid);
+
+            const oldVarSubmitDetails = kgVar.store.getVarSubmitDetailMap[fid] ?? [];
+            kgVar.store.getVarSubmitDetailMap[fid] = [...oldVarSubmitDetails, ...transformVarSubmitDetails([varSubmitDetail])].sort((x, y) => (x.srtseq ?? 0) - (y.srtseq ?? 0));
+        },
+
+        dispose(fid: string | null | undefined): void {
+            if (!fid) {
+                return;
+            }
+
+            this.formModelMap.delete(fid);
+            this.formRefMap.delete(fid);
+            this.isLoadingMap.delete(fid);
+        },
+
+        patchVarSubmitDetail(
+            fid: string | null | undefined,
+            param: {
+                buttonType?: string;
+                buttonVarName?: string | null;
+                properties: VarSubmitDetail;
+                varName: string | null | undefined;
+            },
+        ): Promise<void> {
+            const kgVar = useKgVar(fid);
+
+            // 必须传参
+            if (
+                param.buttonVarName === undefined &&
+                (param.buttonType === KG__VAR_BUTTON__TYPE.IMPORT || param.buttonType === KG__VAR_BUTTON__TYPE.IMPORT_TEMPLATE || param.buttonType === KG__VAR_BUTTON__TYPE.EXPORT || param.buttonType === KG__VAR_BUTTON__TYPE.OTHER)
+            ) {
+                // prettier-ignore
+                ____ERROR____(`${fid} | KgSubmit.store.patchVarSubmitDetail() | 参数 param.buttonVarName 不能为空.`, { fid: fid, param: param });
+                return Promise.resolve();
+            }
+
+            if (!fid || !param.varName) {
+                return Promise.resolve();
+            }
+
+            // 如果参数 buttonType 和 buttonVarName 都为 undefined, 表示修改的是「当前按钮」的「提交表单字段」,
+            let _buttonVarName: string | null | undefined = (() => {
+                if (param.buttonType === undefined && param.buttonVarName === undefined) {
+                    return kgVar.kgButton.currentButton?.var_nam;
+                } else if (param.buttonVarName !== undefined) {
+                    return param.buttonVarName;
+                } else if (param.buttonType !== undefined) {
+                    return (kgVar.store.getVarButtonMap[fid!]?.filter((i) => i.typ === param.buttonType)?.map((i) => i.var_nam) ?? [])[0];
+                } else {
+                    return undefined;
+                }
+            })();
+
+            if (!_buttonVarName) {
+                return Promise.resolve();
+            }
+
+            return new Promise((resolve, reject) => {
+                // 等待变量配置数据查询完成
+                const stopWatch = watch(
+                    () => kgVar.store.getIsRequestedMap[fid],
+                    (isRequested) => {
+                        if (!isRequested) {
+                            return;
+                        }
+
+                        setTimeout(() => {
+                            stopWatch();
+
+                            kgVar.store.getVarSubmitDetailMap[fid]!.forEach((varSubmitDetail) => {
+                                if (varSubmitDetail.button_var_name === _buttonVarName && varSubmitDetail.var_nam === param.varName) {
+                                    Object.entries(param.properties).forEach(([key, value]) => {
+                                        if (key in varSubmitDetail) {
+                                            (varSubmitDetail as any)[key] = value;
+                                        }
+                                    });
+                                }
+                            });
+
+                            resolve();
+                        });
+                    },
+                    { immediate: true },
+                );
+            });
+        },
+
+        patchVarSubmitDetailList(param: { buttonType?: string; buttonVarName?: string | null; varSubmitDetailList: Array<VarSubmitDetail> }): Promise<void> {
+            //region 验证参数
+            //----------------------------------------------------------------------------------------------------
+            if (param.varSubmitDetailList.length === 0) {
+                ____ERROR____(`KgSubmit.store.patchVarSubmitDetailList() | 参数 param.varSubmitDetailList 为空.`, { param: param });
+                return Promise.resolve();
+            }
+
+            const id = param.varSubmitDetailList[0].frm_id;
+            if (!id) {
+                ____ERROR____(`KgSubmit.store.patchVarSubmitDetailList() | 参数 param.varSubmitDetailList 中的界面标识为空.`, { param: param });
+                return Promise.resolve();
+            }
+
+            // 必须传参
+            if (
+                param.buttonVarName === undefined &&
+                (param.buttonType === KG__VAR_BUTTON__TYPE.IMPORT || param.buttonType === KG__VAR_BUTTON__TYPE.IMPORT_TEMPLATE || param.buttonType === KG__VAR_BUTTON__TYPE.EXPORT || param.buttonType === KG__VAR_BUTTON__TYPE.OTHER)
+            ) {
+                ____ERROR____(`${id} | KgSubmit.store.patchVarSubmitDetail() | 参数 param.buttonVarName 不能为空.`, { param: param });
+                return Promise.resolve();
+            }
+            //----------------------------------------------------------------------------------------------------
+            //endregion
+
+            const kgVar = useKgVar(id);
+
+            // 如果参数 buttonType 和 buttonVarName 都为 undefined, 表示修改的是「当前按钮」的「提交表单字段」,
+            let _buttonVarName: string | null | undefined = (() => {
+                if (param.buttonType === undefined && param.buttonVarName === undefined) {
+                    return kgVar.kgButton.currentButton?.var_nam;
+                } else if (param.buttonVarName !== undefined) {
+                    return param.buttonVarName;
+                } else if (param.buttonType !== undefined) {
+                    return (kgVar.store.getVarButtonMap[id!]?.filter((i) => i.typ === param.buttonType)?.map((i) => i.var_nam) ?? [])[0];
+                } else {
+                    return undefined;
+                }
+            })();
+
+            if (!_buttonVarName) {
+                return Promise.resolve();
+            }
+
+            return new Promise((resolve, reject) => {
+                // 等待变量配置数据查询完成
+                const stopWatch = watch(
+                    () => kgVar.store.getIsRequestedMap[id],
+                    (isRequested) => {
+                        if (!isRequested) {
+                            return;
+                        }
+
+                        setTimeout(() => {
+                            stopWatch();
+
+                            const oldVarSubmitDetailList = kgVar.store.getVarSubmitDetailMap[id] ?? [];
+
+                            for (const oldVarSubmitDetail of oldVarSubmitDetailList) {
+                                for (const newVarSubmitDetail of param.varSubmitDetailList) {
+                                    if (oldVarSubmitDetail.button_var_name === _buttonVarName && oldVarSubmitDetail.var_nam === newVarSubmitDetail.var_nam) {
+                                        for (const [key, value] of Object.entries(newVarSubmitDetail)) {
+                                            if (key in oldVarSubmitDetail) {
+                                                Reflect.set(oldVarSubmitDetail, key, value);
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+
+                            resolve();
+                        });
+                    },
+                    { immediate: true },
+                );
+            });
+        },
+
+        setFormModel(fid: string | null | undefined, model?: Record<string, any> | null): void {
+            if (!fid) {
+                return;
+            }
+
+            if (!model) {
+                this.formModelMap.delete(fid);
+                return;
+            }
+
+            let _model = model;
+            if (!isReactive(model)) {
+                _model = reactive(model);
+            }
+
+            this.formModelMap.set(fid, { ..._model, __KG_IS_INIT__: true });
+
+            emit<IKgSubmit$EventListenerParameter$onAfterSetFormModel>({ event: 'onAfterSetFormModel', id: fid, parameter: {} });
+        },
+
+        setIsLoading(fid: string, value: boolean): void {
+            this.isLoadingMap.set(fid, value);
+        },
+    },
+    getters: {
+        getFormModel(): (fid: string | null | undefined) => Record<string, any> | null {
+            return (fid) => {
+                if (!fid) {
+                    return null;
+                }
+
+                return this.formModelMap.get(fid) ?? null;
+            };
+        },
+
+        getFormRef(): (fid: string | null | undefined) => Ref<FormInstance | null> {
+            return (fid) => {
+                if (!fid) {
+                    throw new Error('fid 为空.');
+                }
+
+                let formRef = this.formRefMap.get(fid);
+                if (!formRef) {
+                    formRef = ref(null);
+                    this.formRefMap.set(fid, formRef);
+                }
+
+                return formRef;
+            };
+        },
+
+        getFormRules(): (fid: string | null | undefined) => Ref<Record<string, Array<RuleObject>>> {
+            return (fid) => {
+                if (!fid) {
+                    throw new Error('fid 为空.');
+                }
+
+                let rules = this.formRulesMap.get(fid);
+                if (!rules) {
+                    rules = ref({});
+                    this.formRulesMap.set(fid, rules);
+                }
+
+                return rules;
+            };
+        },
+
+        getIsLoading(): (fid: string | null | undefined) => boolean {
+            return (fid) => {
+                if (!fid) {
+                    return false;
+                }
+
+                return this.isLoadingMap.get(fid) ?? false;
+            };
+        },
+
+        getVarSubmitConfig(): (
+            fid: string | null | undefined,
+            param?: {
+                buttonType?: string;
+                buttonVarName?: string | null;
+            },
+        ) => VarSubmitConfig | null {
+            return (fid, param) => {
+                const { buttonType, buttonVarName } = param ?? {};
+
+                if (!fid) {
+                    return null;
+                }
+
+                const kgVar = useKgVar(fid);
+
+                let varSubmitConfigs = kgVar.store.getVarSubmitConfigMap[fid] ?? [];
+
+                // 参数为空, 则返回「当前按钮」的「提交表单配置」
+                if (!param) {
+                    return varSubmitConfigs.find((i) => i.button_var_name === kgVar.kgButton.currentButton?.var_nam) ?? null;
+                }
+
+                // 根据按钮的变量名称过滤,
+                if (buttonVarName !== undefined) {
+                    return varSubmitConfigs.find((i) => i.button_var_name === buttonVarName) ?? null;
+                }
+
+                // 必须传参
+                if (
+                    buttonVarName === undefined &&
+                    (buttonType === KG__VAR_BUTTON__TYPE.IMPORT || buttonType === KG__VAR_BUTTON__TYPE.IMPORT_TEMPLATE || buttonType === KG__VAR_BUTTON__TYPE.EXPORT || buttonType === KG__VAR_BUTTON__TYPE.OTHER)
+                ) {
+                    ____ERROR____(`${fid} | KgSubmit.store.getVarSubmitConfig() | 参数 param.buttonVarName 不能为空.`, { fid: fid, param: param });
+                    return null;
+                }
+
+                // 必须传参
+                if (buttonVarName === undefined && buttonType === undefined) {
+                    ____ERROR____(`${fid} | KgSubmit.store.getVarSubmitConfig() | 参数 param.buttonType 和 param.buttonVarName 不能同时为空.`, { fid: fid, param: param });
+                    return null;
+                }
+
+                // 根据按钮的类型获取按钮, 再根据按钮的变量名称过滤,
+                if (buttonVarName === undefined && buttonType !== undefined) {
+                    const button = kgVar.store.getVarButtonMap[fid]?.find((i) => i.typ === buttonType);
+                    if (!button) {
+                        ____ERROR____(`${fid} | KgSubmit.store.getVarSubmitConfig() | 类型为「${buttonType}」的按钮不存在.`, { fid: fid, param: param });
+                        return null;
+                    }
+
+                    return varSubmitConfigs.find((i) => i.button_var_name === button?.var_nam) ?? null;
+                }
+
+                return null;
+            };
+        },
+
+        getVarSubmitConfigs(): (fid: string | null | undefined) => Array<VarSubmitConfig> {
+            return (fid) => {
+                if (!fid) {
+                    return [];
+                }
+
+                const kgVar = useKgVar(fid);
+
+                return kgVar.store.getVarSubmitConfigMap[fid] ?? [];
+            };
+        },
+
+        getVarSubmitDetailByVarProfileDetail(): (
+            fid: string | null | undefined,
+            param?: {
+                varProfileDetail: VarProfileDetail | null;
+            },
+        ) => VarSubmitDetail | null {
+            return (fid, param) => {
+                if (!fid) {
+                    return null;
+                }
+
+                const { varProfileDetail } = param ?? {};
+                if (!varProfileDetail) {
+                    return null;
+                }
+
+                const kgVar = useKgVar(fid);
+
+                return kgVar.store.getVarSubmitDetailMap[fid]?.find((i) => i.var_nam === varProfileDetail.var_nam && i.button_var_name === kgVar.varButtonSearch.value?.var_nam && i.prf_var_nam === varProfileDetail.prf_var_nam) ?? null;
+            };
+        },
+
+        getVarSubmitDetails(): (
+            fid: string | null | undefined,
+            param?: {
+                buttonType?: string;
+                buttonVarName?: string | null;
+                isKey?: 0 | 1 | null;
+                isVisible?: 0 | 1 | null;
+                searchProfileVarName?: string | null;
+                varName?: string | null;
+            } | null,
+        ) => Array<VarSubmitDetail> | null {
+            return (fid, param) => {
+                const { buttonType, buttonVarName, isKey, isVisible, searchProfileVarName, varName } = param ?? {};
+
+                if (!fid) {
+                    return null;
+                }
+
+                const kgVar = useKgVar(fid);
+
+                let varSubmitDetails = kgVar.store.getVarSubmitDetailMap[fid]?.sort((x, y) => x.srtseq! - y.srtseq!) ?? null;
+                if (!varSubmitDetails) {
+                    return null;
+                }
+
+                // 获取所有提交表单字段,
+                if (isNil(param)) {
+                    return varSubmitDetails;
+                }
+
+                // 必须传参
+                if (
+                    buttonVarName === undefined &&
+                    (buttonType === KG__VAR_BUTTON__TYPE.IMPORT || buttonType === KG__VAR_BUTTON__TYPE.IMPORT_TEMPLATE || buttonType === KG__VAR_BUTTON__TYPE.EXPORT || buttonType === KG__VAR_BUTTON__TYPE.OTHER)
+                ) {
+                    ____ERROR____(`${fid} | KgSubmit.store.getVarSubmitDetails() | 参数 param.buttonVarName 不能为空.`, { formID: fid, param: param });
+                    return null;
+                }
+
+                // 根据按钮的变量名称过滤,
+                if (buttonVarName !== undefined) {
+                    varSubmitDetails = varSubmitDetails?.filter((i) => i.button_var_name === buttonVarName) ?? null;
+                }
+
+                // 根据按钮的类型获取所有按钮, 再根据这些按钮的变量名称过滤,
+                if (buttonVarName === undefined && buttonType !== undefined) {
+                    const buttonVarNames = kgVar.store.getVarButtonMap[fid]?.filter((i) => i.typ === buttonType)?.map((i) => i.var_nam) ?? [];
+
+                    varSubmitDetails = varSubmitDetails?.filter((i) => buttonVarNames.includes(i.button_var_name)) ?? null;
+                }
+
+                // 根据「变量名称」过滤,
+                if (varName !== undefined) {
+                    varSubmitDetails = varSubmitDetails?.filter((i) => i.var_nam === varName) ?? null;
+                }
+
+                // 根据「所属查询条件视图的变量名称」过滤,
+                if (searchProfileVarName !== undefined) {
+                    varSubmitDetails = varSubmitDetails?.filter((i) => i.prf_var_nam === searchProfileVarName) ?? null;
+                }
+
+                // 根据是否是关键的字段过滤,
+                if (isKey !== undefined) {
+                    varSubmitDetails = varSubmitDetails?.filter((i) => i.key_flg === isKey) ?? null;
+                }
+
+                // 根据是否可见过滤,
+                if (isVisible !== undefined) {
+                    varSubmitDetails = varSubmitDetails?.filter((i) => i.visible_flag === isVisible) ?? null;
+                }
+
+                return varSubmitDetails;
+            };
+        },
+    },
+    state: (): IUseKgSubmitStoreState => ({
+        formModelMap: new Map(),
+        formRefMap: new Map(),
+        formRulesMap: new Map(),
+        isLoadingMap: new Map(),
+    }),
+});