@ibiz-template/runtime 0.7.41-alpha.105 → 0.7.41-alpha.106

package/src/controller/control/tree-grid-ex/tree-grid-ex.service.ts

@@ -0,0 +1,16 @@
+import { IDETreeGridEx } from '@ibiz/model-core';
+import { TreeService } from '../tree/tree.service';
+
+/**
+ * 树表格增强部件服务
+ *
+ * @author lxm
+ * @date 2023-12-21 10:50:35
+ * @export
+ * @class TreeGridExService
+ * @extends {TreeService<T>}
+ * @template T
+ */
+export class TreeGridExService<
+  T extends IDETreeGridEx = IDETreeGridEx,
+> extends TreeService<T> {}

package/src/controller/control/view-panel/index.ts

@@ -0,0 +1 @@
+export * from './view-panel.controller';

package/src/controller/control/view-panel/view-panel.controller.ts

@@ -0,0 +1,36 @@
+import { IDEViewPanel } from '@ibiz/model-core';
+import { ControlController } from '../../common';
+import {
+  IViewController,
+  IViewPanelController,
+  IViewPanelEvent,
+  IViewPanelState,
+} from '../../../interface';
+
+/**
+ * @description 视图面板控制器
+ * @export
+ * @class ViewPanelController
+ * @extends {ControlController<IDEViewPanel, IViewPanelState, IViewPanelEvent>}
+ * @implements {IViewPanelController}
+ */
+export class ViewPanelController
+  extends ControlController<IDEViewPanel, IViewPanelState, IViewPanelEvent>
+  implements IViewPanelController
+{
+  /**
+   * @description 嵌入视图控制器
+   * @type {(IViewController | undefined)}
+   * @memberof ViewPanelController
+   */
+  embedView: IViewController | undefined;
+
+  /**
+   * @description 设置嵌入视图
+   * @param {IViewController} view 嵌入视图控制器
+   * @memberof ViewPanelController
+   */
+  setEmbedView(view: IViewController): void {
+    this.embedView = view;
+  }
+}

package/src/controller/control/wizard-panel/index.ts

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

package/src/controller/control/wizard-panel/wizard-panel.controller.ts

@@ -0,0 +1,582 @@
+import { RuntimeError } from '@ibiz-template/core';
+import {
+  IDEWizardEditForm,
+  IDEWizardForm,
+  IDEWizardPanel,
+} from '@ibiz/model-core';
+import {
+  IWizardPanelState,
+  IWizardPanelEvent,
+  IWizardPanelController,
+  IControlProvider,
+  EventBase,
+  IButtonState,
+} from '../../../interface';
+import { calcDeCodeNameById } from '../../../model';
+import { getControlProvider } from '../../../register';
+import { ControlVO } from '../../../service';
+import { ScriptFactory } from '../../../utils';
+import { ControlController } from '../../common';
+import { ButtonContainerState, UIActionButtonState } from '../../utils';
+import { EditFormController } from '../form';
+import { WizardPanelService } from './wizard-panel.service';
+
+/**
+ * 向导面板控制器
+ *
+ * @author chitanda
+ * @date 2022-07-24 15:07:07
+ * @export
+ * @class WizardPanelController
+ * @extends {ControlController}
+ */
+export class WizardPanelController
+  extends ControlController<
+    IDEWizardPanel,
+    IWizardPanelState,
+    IWizardPanelEvent
+  >
+  implements IWizardPanelController
+{
+  /**
+   * 编辑表单服务
+   * @author lxm
+   * @date 2023-05-15 11:03:34
+   * @type {WizardPanelService}
+   */
+  service!: WizardPanelService;
+
+  /**
+   * 表单标识历史
+   *
+   * @author lxm
+   * @date 2023-02-16 08:41:35
+   * @type {string[]}
+   * @memberof WizardPanelController
+   */
+  tagHistory: string[] = [];
+
+  /**
+   * 所有部件的适配器
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:07
+   * @type {{ [key: string]: IControlProvider }}
+   */
+  providers: { [key: string]: IControlProvider } = {};
+
+  /**
+   * 首表单模型
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-06-07 15:03:39
+   */
+  firstForm: IDEWizardForm | undefined = undefined;
+
+  /**
+   * 所有表单控制器Map
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-06-07 15:13:21
+   */
+  formControllers: Map<string, EditFormController> = new Map();
+
+  /**
+   * 步骤集合
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-06-07 15:13:21
+   */
+  steps: string[] = [];
+
+  /**
+   * 步骤标识集合
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-06-07 15:13:21
+   */
+  stepTags: IData = {};
+
+  /**
+   * 向导表单数据
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-12-12 13:43:07
+   */
+  formData: IData = {};
+
+  /**
+   * 获取向导面板数据
+   * @returns
+   */
+  getData(): IData[] {
+    return [this.formData];
+  }
+
+  protected initState(): void {
+    super.initState();
+    this.state.buttonsState = new ButtonContainerState();
+  }
+
+  protected async onCreated(): Promise<void> {
+    await super.onCreated();
+
+    this.model.dewizard!.dewizardForms!.forEach((wizardForm: IDEWizardForm) => {
+      // 首表单
+      if (wizardForm.firstForm) {
+        this.firstForm = wizardForm;
+      }
+      // 步骤标识
+      const formName = `${
+        this.model.name
+      }_form_${wizardForm.formTag?.toLowerCase()}`;
+      const wizardStep = this.model.dewizard?.dewizardSteps?.find(step => {
+        return step.id === wizardForm.dewizardStepId;
+      });
+      const stepTag = wizardStep?.stepTag;
+      this.stepTags[formName] = stepTag;
+      // 按钮状态如果有脚本代码则默认隐藏
+      wizardForm.stepActions?.forEach(step => {
+        const name = `${wizardForm.formTag}@${step}`;
+        const buttonState = new UIActionButtonState(
+          name,
+          this.context.srfappid!,
+        );
+        buttonState.visible = !this.getStepScriptCode(wizardForm, step);
+        this.state.buttonsState.addState(name, buttonState);
+      });
+    });
+    // 按钮初始化
+    this.state.buttonsState.init();
+    // 步骤集合
+    this.model.dewizard?.dewizardSteps?.forEach(step => {
+      this.steps.push(step.stepTag!);
+    });
+    // 实例部件服务
+    this.service = new WizardPanelService(this.model);
+    await this.service.init(this.context);
+    // 编辑表单适配器
+    const { deeditForms } = this.model;
+    if (deeditForms && deeditForms.length > 0) {
+      await Promise.all(
+        deeditForms.map(async editForm => {
+          const { formTag } = (editForm as IDEWizardEditForm).dewizardForm!;
+          if (formTag) {
+            const provider = await getControlProvider(editForm);
+            if (provider) {
+              this.providers[formTag] = provider;
+            }
+          }
+        }),
+      );
+    }
+  }
+
+  /**
+   * 当前激活的向导表单
+   *
+   * @author lxm
+   * @date 2023-02-17 10:42:06
+   * @readonly
+   * @memberof WizardPanelController
+   */
+  get activeWizardForm(): IDEWizardForm | undefined {
+    const { activeFormTag } = this.state;
+    const form = this.model.dewizard!.dewizardForms!.find(
+      (wizardForm: IDEWizardForm) => {
+        return wizardForm.formTag === activeFormTag;
+      },
+    );
+    if (!form) {
+      ibiz.log.debug(
+        ibiz.i18n.t('runtime.controller.control.wizardPanel.wizardForm', {
+          activeFormTag,
+        }),
+      );
+    }
+    return form;
+  }
+
+  /**
+   * 当前激活向导表单的控制器
+   *
+   * @author lxm
+   * @date 2023-02-17 03:44:46
+   * @readonly
+   * @memberof WizardPanelController
+   */
+  get activeFormController(): EditFormController {
+    const { activeFormTag } = this.state;
+    const controller = this.formControllers.get(activeFormTag);
+    if (!controller) {
+      throw new RuntimeError(
+        ibiz.i18n.t('runtime.controller.control.wizardPanel.formController', {
+          activeFormTag,
+        }),
+      );
+    }
+    return controller;
+  }
+
+  /**
+   * 表单挂载后把控制器抛出来
+   * @param {string} activeFormTag
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-06-07 15:14:05
+   */
+  async onFormMounted(activeFormTag: string, event: EventBase): Promise<void> {
+    const formController = event.ctrl as EditFormController;
+    this.formControllers.set(activeFormTag, formController);
+    formController.evt.on('onFormDataChange', evt => {
+      this.calcButtonState(evt.data[0], formController);
+    });
+    // 调用表单的load加载一次数据
+    const data = await formController.load();
+    this.calcButtonState(formController.data, formController);
+    Object.assign(this.formData, data);
+  }
+
+  /**
+   * 表单保存后，如果上下文里没有主键，赋予主键
+   * @param {EventBase} event
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-06-08 14:06:25
+   */
+  onFormSaved(event: EventBase): void {
+    const data = event.data[0];
+    Object.assign(this.formData, data);
+    const deName = calcDeCodeNameById(this.model.appDataEntityId!);
+    if (!this.context[deName] && data && data.srfkey) {
+      this.context[deName] = data.srfkey;
+    }
+  }
+
+  /**
+   * 根据tag获取应该激活的向导表单
+   * @param {string} tag
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-11-10 18:35:37
+   */
+  getWizardFormByTag(tag: string): IDEWizardForm | undefined {
+    if (!this.model.dewizard?.dewizardForms) {
+      throw new RuntimeError(
+        ibiz.i18n.t('runtime.controller.control.wizardPanel.noConfiguration'),
+      );
+    }
+    const wizardForm = this.model.dewizard.dewizardForms.find(
+      (form: IDEWizardForm) => {
+        return form.formTag === tag;
+      },
+    );
+    if (!wizardForm) {
+      throw new RuntimeError(
+        ibiz.i18n.t(
+          'runtime.controller.control.wizardPanel.wizardFormIdentifier',
+          { tag },
+        ),
+      );
+    }
+    return wizardForm;
+  }
+
+  /**
+   * 执行初始化操作，存在初始化实体行为的时候加载数据并把主键放入上下文
+   *
+   * @author lxm
+   * @date 2022-08-19 14:08:50
+   */
+  async initialize(): Promise<void> {
+    const initAction = this.model.initControlAction?.appDEMethodId;
+    if (initAction) {
+      let res;
+      try {
+        res = await this.service.initialize(this.context, this.params);
+      } catch (error) {
+        this.actionNotification(`INITIALIZEERROR`, {
+          error: error as Error,
+        });
+        throw error;
+      }
+      const deName = calcDeCodeNameById(this.model.appDataEntityId!);
+      if (res.data && res.data.srfkey) {
+        this.formData = res.data;
+        this.context[deName] = res.data.srfkey;
+      }
+      // 初始化时状态向导面板根据状态属性去决定当前激活哪个表单
+      if (
+        res.data &&
+        this.model.stateAppDEFieldId &&
+        res.data[this.model.stateAppDEFieldId]
+      ) {
+        const activeForm = this.getWizardFormByTag(
+          res.data[this.model.stateAppDEFieldId],
+        );
+        if (activeForm) {
+          this.state.activeFormTag = activeForm.formTag!;
+          this.tagHistory.push(activeForm.formTag!);
+        }
+      }
+    }
+    // 没有激活的表单标识就选配置的首表单
+    if (!this.state.activeFormTag && this.firstForm) {
+      this.state.activeFormTag = this.firstForm.formTag!;
+      this.tagHistory.push(this.firstForm.formTag!);
+    }
+    this.evt.emit('onInitialized', undefined);
+  }
+
+  /**
+   * 执行完成操作
+   *
+   * @author lxm
+   * @date 2023-02-16 06:20:18
+   * @returns {*}  {Promise<void>}
+   * @memberof WizardPanelController
+   */
+  async finish(): Promise<void> {
+    try {
+      await this.service.finish(this.context, this.formData, this.params);
+    } catch (error) {
+      this.actionNotification('FINISHERROR', {
+        error: error as Error,
+      });
+      throw error;
+    }
+    this.endLoading();
+    this.evt.emit('onFinishSuccess', undefined);
+    this.actionNotification('FINISHESUCCESS');
+  }
+
+  /**
+   * 处理上一步按钮点击
+   *
+   * @author lxm
+   * @date 2023-02-16 09:10:04
+   * @memberof WizardPanelController
+   */
+  async onPrevClick(): Promise<void> {
+    this.startLoading();
+    try {
+      // 状态向导先执行表单返回行为
+      let data;
+      if (
+        (this.activeFormController.model as IDEWizardEditForm)
+          .goBackControlAction
+      ) {
+        data = await this.activeFormController.goBack();
+      }
+      let prevTag;
+      // 返回上一个表单优先级 stateAppDEFieldId > tagHistory
+      if (
+        this.model.stateAppDEFieldId &&
+        data &&
+        data[this.model.stateAppDEFieldId]
+      ) {
+        const wizardForm = this.getWizardFormByTag(
+          data[this.model.stateAppDEFieldId],
+        );
+        if (wizardForm) {
+          prevTag = data[this.model.stateAppDEFieldId];
+        }
+      } else {
+        // 先删除在获取最后一个 否则prevTag会异常
+        this.tagHistory.pop();
+        prevTag = this.tagHistory[this.tagHistory.length - 1];
+      }
+      if (!prevTag) {
+        throw new RuntimeError(
+          ibiz.i18n.t('runtime.controller.control.wizardPanel.noPreviousForm'),
+        );
+      }
+      this.state.activeFormTag = prevTag;
+      // eslint-disable-next-line no-useless-catch
+    } catch (error: unknown) {
+      throw error;
+    } finally {
+      this.endLoading();
+    }
+  }
+
+  /**
+   * 处理下一步按钮点击
+   *
+   * @author lxm
+   * @date 2023-02-16 09:10:17
+   * @memberof WizardPanelController
+   */
+  async onNextClick(): Promise<void> {
+    this.startLoading();
+    try {
+      // 保存
+      const data = await this.activeFormController.save({ silent: true });
+      let nextTag;
+      if (data.srfnextform) {
+        const wizardForm = this.getWizardFormByTag(data.srfnextform);
+        if (wizardForm) {
+          nextTag = data.srfnextform;
+        }
+      } else if (
+        this.model.stateAppDEFieldId &&
+        data[this.model.stateAppDEFieldId]
+      ) {
+        const wizardForm = this.getWizardFormByTag(
+          data[this.model.stateAppDEFieldId],
+        );
+        if (wizardForm) {
+          nextTag = data[this.model.stateAppDEFieldId];
+        }
+      } else {
+        // 通过步骤找,找到下一个步骤对应的第一个向导表单
+        const wizardSteps = this.model.dewizard!.dewizardSteps;
+        const editForms = this.model.dewizard!.dewizardForms;
+        if (wizardSteps && editForms) {
+          // 从向导表单列表中找到当前表单对应的向导步骤
+          const index = wizardSteps.findIndex(_step => {
+            return _step.id === this.activeWizardForm!.dewizardStepId;
+          });
+          const nextWizardStep = wizardSteps[index + 1];
+          if (!nextWizardStep) {
+            throw new RuntimeError(
+              ibiz.i18n.t('runtime.controller.control.wizardPanel.nextStep'),
+            );
+          }
+          const nextWizardForm = this.getWizardFormByTag(
+            nextWizardStep.stepTag!,
+          );
+          if (nextWizardForm && nextWizardForm.formTag) {
+            nextTag = nextWizardForm.formTag;
+          }
+        }
+      }
+      if (!nextTag) {
+        throw new RuntimeError(
+          ibiz.i18n.t('runtime.controller.control.wizardPanel.nextForm'),
+        );
+      }
+      this.state.activeFormTag = nextTag;
+      this.tagHistory.push(nextTag);
+      // eslint-disable-next-line no-useless-catch
+    } catch (error: unknown) {
+      throw error;
+    } finally {
+      this.endLoading();
+    }
+  }
+
+  /**
+   * 处理完成按钮点击
+   *
+   * @author lxm
+   * @date 2023-02-16 09:09:45
+   * @memberof WizardPanelController
+   */
+  async onFinishClick(): Promise<void> {
+    this.startLoading();
+    try {
+      // 保存
+      await this.activeFormController.save({ silent: true });
+      await this.finish();
+      // eslint-disable-next-line no-useless-catch
+    } catch (error: unknown) {
+      this.endLoading();
+      throw error;
+    }
+  }
+
+  /**
+   * 获取向导表单步骤脚本代码
+   * @param wizardForm
+   * @param step
+   */
+  private getStepScriptCode(
+    wizardForm: IDEWizardForm,
+    step: string,
+  ): string | undefined {
+    switch (step) {
+      case 'PREV':
+        return wizardForm.goPrevEnableScriptCode;
+      case 'NEXT':
+        return wizardForm.goNextEnableScriptCode;
+      case 'FINISH':
+        return wizardForm.goFinishEnableScriptCode;
+      default:
+    }
+  }
+
+  /**
+   * 计算按钮状态
+   *
+   * @param item 数据
+   * @memberof WizardPanelController
+   */
+  async calcButtonState(
+    item?: IData,
+    _form?: EditFormController,
+  ): Promise<void> {
+    const { activeWizardForm } = this;
+    if (activeWizardForm) {
+      let data = item;
+      if (data && data instanceof ControlVO) {
+        data = data.getOrigin();
+      }
+      activeWizardForm.stepActions?.forEach(step => {
+        const buttonState = this.state.buttonsState[
+          `${activeWizardForm.formTag}@${step}`
+        ] as IButtonState;
+        const scriptCode = this.getStepScriptCode(activeWizardForm, step);
+        if (buttonState && scriptCode) {
+          buttonState.visible = !!ScriptFactory.execScriptFn(
+            {
+              view: this.view,
+              ctrl: _form,
+              context: this.context,
+              params: this.params,
+              data,
+              env: ibiz.env,
+            },
+            scriptCode,
+            { isAsync: false, singleRowReturn: true },
+          );
+        }
+      });
+    }
+  }
+
+  /**
+   * @description 转换各类多语言
+   * @protected
+   * @memberof WizardPanelController
+   */
+  protected convertMultipleLanguages(): void {
+    const { dewizard } = this.model;
+    if (!dewizard) return;
+    const {
+      dewizardSteps,
+      prevCapLanResTag,
+      nextCapLanResTag,
+      finishCapLanResTag,
+    } = dewizard;
+    if (prevCapLanResTag)
+      dewizard.prevCaption = ibiz.i18n.t(
+        prevCapLanResTag,
+        dewizard.prevCaption,
+      );
+    if (nextCapLanResTag)
+      dewizard.nextCaption = ibiz.i18n.t(
+        nextCapLanResTag,
+        dewizard.nextCaption,
+      );
+    if (finishCapLanResTag)
+      dewizard.finishCaption = ibiz.i18n.t(
+        finishCapLanResTag,
+        dewizard.finishCaption,
+      );
+    dewizardSteps?.forEach(step => {
+      if (step.titleLanguageRes?.lanResTag)
+        step.title = ibiz.i18n.t(step.titleLanguageRes.lanResTag, step.title);
+    });
+  }
+}

package/src/controller/control/wizard-panel/wizard-panel.service.ts

@@ -0,0 +1,58 @@
+import { IHttpResponse } from '@ibiz-template/core';
+import { IDEWizardPanel } from '@ibiz/model-core';
+import { ControlService } from '../../../service';
+
+/**
+ * 向导面板服务
+ *
+ * @author lxm
+ * @date 2023-02-16 04:11:13
+ * @export
+ * @class WizardPanelService
+ * @extends {ControlService<T>}
+ * @template T
+ */
+export class WizardPanelService<
+  T extends IDEWizardPanel = IDEWizardPanel,
+> extends ControlService<T> {
+  /**
+   * 执行向导初始化
+   * 服务调用之前确认是否有初始化实体行为
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:41
+   * @param {IContext} context 上下文
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async initialize(
+    context: IContext,
+    data?: IData,
+    params?: IParams,
+  ): Promise<IHttpResponse<IData>> {
+    const initAction = this.model.initControlAction?.appDEMethodId;
+    let res = await this.exec(initAction!, context, data, params);
+    res = this.handleResponse(res);
+    return res as IHttpResponse<IData>;
+  }
+
+  /**
+   * 执行向导完成
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:41
+   * @param {IContext} context 上下文
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async finish(
+    context: IContext,
+    data: IData = {},
+    params: IParams = {},
+  ): Promise<IHttpResponse<IData>> {
+    const finishAction = this.model.finishControlAction?.appDEMethodId;
+    let res = await this.exec(finishAction!, context, data, params);
+    res = this.handleResponse(res);
+    return res as IHttpResponse<IData>;
+  }
+}

package/src/controller/ctx/ctx.state.ts

@@ -0,0 +1 @@
+export class CTXState {}