@ibiz-template/runtime 0.1.11 → 0.1.12

package/src/controller/control/form/edit-form/edit-form.controller.ts

@@ -0,0 +1,358 @@
+import {
+  awaitTimeout,
+  IHttpResponse,
+  mergeInLeft,
+  RuntimeError,
+  mergeDefaultInLeft,
+} from '@ibiz-template/core';
+import { IDEEditForm } from '@ibiz/model-core';
+import { debounce } from 'lodash-es';
+import {
+  IEditFormState,
+  IEditFormEvent,
+  IEditFormController,
+} from '../../../../interface';
+import { hasDeCodeName } from '../../../../model';
+import { Srfuf, ControlVO } from '../../../../service';
+import { FormNotifyState } from '../../../constant';
+import { FormController } from '../form';
+import { EditFormService } from './edit-form.service';
+
+/**
+ * 编辑表单控制器
+ *
+ * @author chitanda
+ * @date 2022-08-03 11:08:20
+ * @export
+ * @class EditFormController
+ * @extends {FormController<EditFormModel>}
+ */
+export class EditFormController
+  extends FormController<IDEEditForm, IEditFormState, IEditFormEvent>
+  implements IEditFormController
+{
+  /**
+   * 编辑表单服务
+   * @author lxm
+   * @date 2023-05-15 11:03:34
+   * @type {EditFormService}
+   */
+  service!: EditFormService;
+
+  /**
+   * 初始化方法
+   *
+   * @author lxm
+   * @date 2022-08-22 22:08:16
+   * @protected
+   * @returns {*}  {Promise<void>}
+   */
+  protected async onCreated(): Promise<void> {
+    await super.onCreated();
+    // 实例部件服务
+    this.service = new EditFormService(this.model);
+    await this.service.init(this.context);
+
+    // 自动保存防抖，只有最后一次执行
+    this.autoSave = debounce(this.autoSave.bind(this), 500, {
+      trailing: true,
+    }) as () => Promise<void>;
+  }
+
+  /**
+   * 加载草稿行为
+   * @author lxm
+   * @date 2023-08-25 02:45:11
+   * @return {*}  {Promise<IData>}
+   */
+  async loadDraft(): Promise<IData> {
+    const queryParams = { ...this.params };
+    // 新建默认值给到graft接口，接口会回来
+    const params = await this.getDraftParams(); // 新建默认值
+    Object.assign(queryParams, params);
+
+    let res;
+    try {
+      await this.startLoading();
+      await this.evt.emit('onBeforeLoadDraft', { params: queryParams });
+      res = await this.service.getDraft(this.context, queryParams);
+    } catch (error) {
+      await this.evt.emit('onLoadDraftError', undefined);
+      throw error;
+    } finally {
+      await this.endLoading();
+    }
+
+    // !getDraft的时候不替换，进行合并，空值不覆盖
+    mergeInLeft(this.data, res.data);
+
+    // 处理后台导致的新建默认值丢失
+    mergeDefaultInLeft(this.data, params);
+
+    this.formStateNotify(FormNotifyState.DRAFT);
+
+    await this.evt.emit('onLoadDraftSuccess', undefined);
+    this.state.isLoaded = true;
+    return this.data;
+  }
+
+  /**
+   * 部件加载数据行为
+   *
+   * @author lxm
+   * @date 2022-08-19 14:08:50
+   */
+  async load(): Promise<IData> {
+    const isLoadDraft = !hasDeCodeName(
+      this.context,
+      this.model.appDataEntityId!,
+    );
+    // 加载草稿单独走一个方法
+    if (isLoadDraft) {
+      return this.loadDraft();
+    }
+
+    const queryParams = { ...this.params };
+
+    let res;
+    try {
+      await this.startLoading();
+      await this.evt.emit('onBeforeLoad', undefined);
+      res = await this.service.get(this.context, queryParams);
+    } catch (error) {
+      await this.evt.emit('onLoadError', undefined);
+      throw error;
+    } finally {
+      await this.endLoading();
+    }
+
+    this.state.modified = false;
+    this.state.data = res.data;
+    this.formStateNotify(FormNotifyState.LOAD);
+
+    await this.evt.emit('onLoadSuccess', undefined);
+    this.state.isLoaded = true;
+    return this.data;
+  }
+
+  /**
+   * 保存表单数据
+   *
+   * @author lxm
+   * @date 2022-08-31 22:08:40
+   */
+  async save(): Promise<IData> {
+    // 如果数据正在处理中，则延迟保存
+    if (this.state.processing) {
+      const data = await awaitTimeout(500, this.save.bind(this));
+      return data!;
+    }
+
+    const isValid = await this.validate();
+    if (!isValid) {
+      throw new RuntimeError('请检查表单填写！');
+    }
+    await this.startLoading();
+    await this.evt.emit('onBeforeSave', undefined);
+    let res;
+    try {
+      res =
+        this.data.srfuf === Srfuf.CREATE
+          ? await this.service.create(this.context, this.data)
+          : await this.service.update(this.context, this.data);
+    } catch (error) {
+      await this.evt.emit('onSaveError', undefined);
+      throw error;
+    } finally {
+      await this.endLoading();
+    }
+    // 保存结束后的事件
+    if (res.data) {
+      mergeInLeft(this.data, res.data);
+    }
+    this.state.modified = false;
+    await this.evt.emit('onSaveSuccess', undefined);
+    this.formStateNotify(FormNotifyState.SAVE);
+    ibiz.message.success(`${this.data.srfmajortext || ''}保存成功`);
+    return this.data;
+  }
+
+  /**
+   * 删除表单数据
+   *
+   * @author lxm
+   * @date 2022-09-01 09:09:36
+   * @returns {*}
+   */
+  async remove(): Promise<boolean> {
+    // 新建数据清空数据
+    let res: IHttpResponse | undefined;
+    let ok: boolean = false;
+    await this.evt.emit('onBeforeRemove', undefined);
+    // 新建的数据不用进行后台删除
+    if (this.data.srfuf === Srfuf.UPDATE) {
+      ok = await ibiz.modal.confirm({
+        title: '提示',
+        desc: '确认删除吗？',
+      });
+      if (!ok) {
+        // 取消不抛事件
+        return false;
+      }
+      await this.startLoading();
+      try {
+        res = await this.service.remove(this.context, this.params);
+      } catch (error) {
+        await this.evt.emit('onRemoveError', undefined);
+        throw error;
+      } finally {
+        await this.endLoading();
+      }
+      ok = res.ok;
+    }
+
+    // 删除完成后都要置空当前表单数据
+    this.state.data = new ControlVO();
+    this.state.modified = false;
+    await this.evt.emit('onRemoveSuccess', undefined);
+
+    return ok;
+  }
+
+  /**
+   * 执行返回行为
+   *
+   * @author lxm
+   * @date 2022-09-01 09:09:36
+   * @returns {*}
+   */
+  async goBack(): Promise<void> {
+    await this.startLoading();
+    let res;
+    try {
+      res = await this.service.goBack(this.context, this.data);
+    } finally {
+      await this.endLoading();
+    }
+    // 合并后台返回数据
+    if (res.data) {
+      mergeInLeft(this.data, res.data);
+    }
+  }
+
+  /**
+   * 表单项更新
+   *
+   * @author lxm
+   * @date 2022-09-15 21:09:13
+   * @param {string} methodName 更新实体方法
+   * @param {string[]} updateItems 更新项名称集合
+   */
+  async updateFormItem(formItemUpdateId: string): Promise<void> {
+    const formItemUpdate = this.model.deformItemUpdates?.find(
+      item => item.id === formItemUpdateId,
+    );
+
+    if (!formItemUpdate) {
+      throw new RuntimeError(`没找到${formItemUpdateId}表单项更新`);
+    }
+
+    const { appDEMethodId, defiupdateDetails } = formItemUpdate;
+    const updateItems = defiupdateDetails!.map(item => item.id!);
+
+    const params = { ...this.params, ...this.data.getOrigin() };
+    const res = await this.service.updateFormItem(
+      appDEMethodId!,
+      this.context,
+      params,
+    );
+    const result = res.data;
+    if (result && updateItems?.length) {
+      await Promise.all(
+        updateItems.map(itemName =>
+          this.setDataValue(itemName, result[itemName]),
+        ),
+      );
+    }
+  }
+
+  /**
+   * 工作流启动(调用前先确保调用保存)
+   *
+   * @author lxm
+   * @date 2022-10-08 18:10:41
+   * @param {IParams} [extraParams={}] 不走工作流启动视图时使用
+   * @returns {*}  {Promise<void>}
+   */
+  async wfStart(extraParams: IParams = {}): Promise<void> {
+    const isValid = await this.validate();
+    if (!isValid) {
+      throw new RuntimeError('请检查表单填写！');
+    }
+    await this.startLoading();
+    try {
+      await this.service.wfStart(
+        this.context,
+        {
+          ...this.params,
+          ...extraParams,
+        },
+        this.data,
+      );
+    } finally {
+      await this.endLoading();
+    }
+    ibiz.message.success('流程启动成功');
+  }
+
+  /**
+   * 工作流提交(调用前先确保调用保存)
+   *
+   * @author lxm
+   * @date 2022-10-08 18:10:56
+   * @param {IParams} [extraParams={}] 不走工作流操作视图时使用
+   * @returns {*}  {Promise<void>}
+   */
+  async wfSubmit(extraParams: IParams = {}): Promise<void> {
+    const isValid = await this.validate();
+    if (!isValid) {
+      throw new RuntimeError('请检查表单填写！');
+    }
+    await this.startLoading();
+    try {
+      await this.service.wfSubmit(
+        this.context,
+        {
+          ...this.params,
+          ...extraParams,
+        },
+        this.data,
+      );
+    } finally {
+      await this.endLoading();
+    }
+    ibiz.message.success('流程提交成功');
+  }
+
+  async dataChangeNotify(names: string[]): Promise<void> {
+    await super.dataChangeNotify(names);
+    this.autoSave();
+  }
+
+  /**
+   * 自动保存
+   * @author lxm
+   * @date 2023-08-23 05:44:48
+   * @return {*}  {Promise<void>}
+   */
+  async autoSave(): Promise<void> {
+    if (this.model.enableAutoSave) {
+      // 自动保存静默，报错直接控制台输出
+      try {
+        await this.save();
+      } catch (error) {
+        ibiz.log.error(error);
+      }
+    }
+  }
+}

package/src/controller/control/form/edit-form/edit-form.service.ts

@@ -0,0 +1,322 @@
+import {
+  IHttpResponse,
+  recursiveIterate,
+  RuntimeModelError,
+} from '@ibiz-template/core';
+import {
+  IDEEditForm,
+  IDEEditFormItem,
+  IDEFormDetail,
+  IDEFormMDCtrl,
+  IDEWizardEditForm,
+  IWFEditForm,
+} from '@ibiz/model-core';
+import { ControlService, ControlVO, UIMapField } from '../../../../service';
+
+export class EditFormService<
+  T extends IDEEditForm = IDEEditForm,
+> extends ControlService<T> {
+  /**
+   * 执行获取单条数据方法
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:41
+   * @param {IParams} context 上下文
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async get(
+    context: IParams,
+    params: IParams = {},
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(
+      this.model.getControlAction?.appDEMethodId || 'get',
+      context,
+      undefined,
+      params,
+    );
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 执行获取草稿方法
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:41
+   * @param {IParams} context 上下文
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async getDraft(
+    context: IParams,
+    params: IParams = {},
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(
+      this.model.getDraftControlAction?.appDEMethodId || 'getdraft',
+      context,
+      undefined,
+      params,
+    );
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 删除单条数据
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:48
+   * @param {IParams} context 上下文
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}
+   */
+  async remove(context: IParams, params: IParams = {}): Promise<IHttpResponse> {
+    const res = await this.exec(
+      this.model.removeControlAction?.appDEMethodId || 'remove',
+      context,
+      undefined,
+      params,
+    );
+    return res;
+  }
+
+  /**
+   * 新建数据
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IParams} context 上下文
+   * @param {IData} data 数据
+   * @returns {*}
+   */
+  async create(
+    context: IParams,
+    data: IData,
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(
+      this.model.createControlAction?.appDEMethodId || 'create',
+      context,
+      data instanceof ControlVO ? data.getOrigin() : data,
+    );
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 更新数据
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IParams} context 上下文
+   * @param {IData} data 数据
+   * @returns {*}
+   */
+  async update(
+    context: IParams,
+    data: IData,
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(
+      this.model.updateControlAction?.appDEMethodId || 'update',
+      context,
+      data instanceof ControlVO ? data.getOrigin() : data,
+    );
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 返回操作
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IParams} context 上下文
+   * @param {IData} data 数据
+   * @returns {*}
+   */
+  async goBack(
+    context: IParams,
+    data: IData,
+  ): Promise<IHttpResponse<ControlVO>> {
+    const wizardForm = this.model as IDEWizardEditForm;
+    const methodName = wizardForm.goBackControlAction?.appDEMethodId;
+    if (!methodName) {
+      throw new RuntimeModelError(this.model, '缺少返回操作实体行为');
+    }
+    let res = await this.exec(
+      methodName,
+      context,
+      data instanceof ControlVO ? data.getOrigin() : data,
+    );
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 表单项更新
+   *
+   * @author lxm
+   * @date 2022-09-15 21:09:34
+   * @param {string} methodName
+   * @param {IParams} context
+   * @param {IParams} [params={}]
+   * @returns {*}  {Promise<IHttpResponse<ControlVO>>}
+   */
+  async updateFormItem(
+    methodName: string,
+    context: IParams,
+    params: IParams = {},
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(methodName, context, params);
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 工作流启动
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IParams} context 上下文
+   * @param {IData} data 数据
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}
+   */
+  async wfStart(
+    context: IParams,
+    params: IParams,
+    data: IData,
+  ): Promise<IHttpResponse<IData>> {
+    const wfForm = this.model as IWFEditForm;
+    const methodName = wfForm.wfstartControlAction?.appDEMethodId || 'wfstart';
+    const entityService = await this.app.deService.getService(
+      this.model.appDataEntityId!,
+    );
+    return entityService.wf.exec(
+      methodName,
+      context,
+      params,
+      data instanceof ControlVO ? data.getOrigin() : data,
+    );
+  }
+
+  /**
+   * 工作流提交
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IParams} context 上下文
+   * @param {IData} data 数据
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}
+   */
+  async wfSubmit(
+    context: IParams,
+    params: IParams,
+    data: IData,
+  ): Promise<IHttpResponse<IData>> {
+    const wfForm = this.model as IWFEditForm;
+
+    // 有type的操作方法传type。
+    let methodName = '';
+    if (params.type) {
+      methodName = params.type;
+    } else {
+      methodName = wfForm.wfsubmitControlAction?.appDEMethodId || 'wfsubmit';
+    }
+
+    const entityService = await this.app.deService.getService(
+      this.model.appDataEntityId!,
+    );
+    return entityService.wf.exec(
+      methodName,
+      context,
+      params,
+      data instanceof ControlVO ? data.getOrigin() : data,
+    );
+  }
+
+  /**
+   * 初始化属性映射
+   *
+   * @author lxm
+   * @date 2022-08-31 18:08:37
+   */
+  protected initUIDataMap(): void {
+    super.initUIDataMap();
+    // 预置属性映射
+    const presetFields = [
+      // 工作流预置
+      'srfwfmemo',
+      'srfwftransferor',
+      // 逻辑预置操作数据
+      'srfactionparam',
+      // 前端新增修改标识，新增为"0",修改为"1"或未设值
+      'srffrontuf',
+      // 向导预置
+      'srfnextform',
+    ];
+
+    // *初始化表单的属性映射
+    recursiveIterate(
+      this.model,
+      (item: IDEFormDetail) => {
+        if (item.detailType === 'FORMITEM') {
+          const formItem = item as IDEEditFormItem;
+          const uiKey = formItem.fieldName || formItem.id!.toLowerCase();
+          const deField =
+            formItem.fieldName || (item as IDEEditFormItem).appDEFieldId!;
+          let mapField: UIMapField;
+          if (deField) {
+            mapField = new UIMapField(uiKey, deField, {
+              isOriginField: true,
+            });
+          } else {
+            // 前台属性和没属性的表单项，或预置属性
+            mapField = new UIMapField(uiKey, uiKey, {
+              isOriginField: presetFields.includes(uiKey), // 工作流相关需要存到origin上
+            });
+          }
+          this.dataUIMap.set(uiKey, mapField);
+        }
+        if (item.detailType === 'MDCTRL') {
+          const formItem = item as IDEFormMDCtrl;
+          const uiKey = formItem.fieldName || formItem.id!.toLowerCase();
+          const deField =
+            formItem.fieldName || (item as IDEEditFormItem).appDEFieldId!;
+          let mapField: UIMapField;
+          if (deField) {
+            mapField = new UIMapField(uiKey, deField, {
+              isOriginField: true,
+            });
+          } else {
+            // 前台属性和没属性的表单项，或预置属性
+            mapField = new UIMapField(uiKey, uiKey, {
+              isOriginField: true,
+            });
+          }
+          this.dataUIMap.set(uiKey, mapField);
+        }
+      },
+      {
+        childrenFields: ['deformPages', 'deformDetails'],
+      },
+    );
+  }
+
+  /**
+   * 处理响应
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:13
+   * @param {IHttpResponse} res
+   * @returns {*}  {IHttpResponse}
+   */
+  handleResponse(response: IHttpResponse): IHttpResponse<ControlVO> {
+    const res = super.handleResponse(response);
+    if (res.ok && res.data) {
+      res.data = this.toUIData(res.data);
+    }
+    return res as IHttpResponse<ControlVO>;
+  }
+}

package/src/controller/control/form/edit-form/index.ts

@@ -0,0 +1,2 @@
+export * from './edit-form.controller';
+export * from './edit-form.service';