@ibiz-template/runtime 0.0.1-beta.1 → 0.0.2-beta.0

package/src/controller/view/view.ts

@@ -0,0 +1,412 @@
+import { IBizContext, RuntimeError } from '@ibiz-template/core';
+import {
+  DefectModelError,
+  IPSAppViewLogic,
+  IPSDETBUIActionItem,
+  ViewModel,
+} from '@ibiz-template/model';
+import { createUUID, notNilEmpty } from 'qx-util';
+import { LoadingState } from '../utils/loading/loading-state';
+import { ViewNerve } from '../neuron';
+import { ButtonContainerState, ButtonState } from '../utils';
+import { IButtonContainerState, IControlProvider } from '../interface';
+import { IModal, IModalData } from '../../interface';
+import { ViewMode } from '../../constant';
+import { convertNavData } from '../../utils';
+import { executeViewLogic } from '../../view-logic';
+import { Application } from '../../application';
+
+/**
+ * 视图控制器
+ *
+ * @author chitanda
+ * @date 2022-07-21 15:07:51
+ * @export
+ * @class ViewController
+ */
+export class ViewController<T extends ViewModel = ViewModel> {
+  /**
+   * 视图模型
+   *
+   * @author chitanda
+   * @date 2022-07-22 16:07:26
+   * @protected
+   * @type {T}
+   */
+  model!: T;
+
+  /**
+   * 当前视图所归属的应用
+   *
+   * @author chitanda
+   * @date 2022-12-21 11:12:29
+   * @type {Application}
+   */
+  app!: Application;
+
+  /**
+   * 当为模态、飘窗等非路由模式打开时，外部会注入此方法，用于关闭视图。
+   *
+   * @author chitanda
+   * @date 2022-08-17 18:08:20
+   * @type {IModal}
+   */
+  modal: IModal = { mode: ViewMode.ROUTE };
+
+  /**
+   * 视图上下文
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:46
+   * @type {IBizContext}
+   */
+  context: IBizContext;
+
+  /**
+   * 视图参数
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:55
+   * @type {IParams}
+   */
+  params: IParams;
+
+  /**
+   * 控制器是否已经准备完成
+   *
+   * @author chitanda
+   * @date 2022-07-24 16:07:25
+   * @type {boolean}
+   */
+  complete: boolean = false;
+
+  /**
+   * 视图神经系统
+   *
+   * @author lxm
+   * @date 2022-08-21 11:08:33
+   * @type {ViewNerve}
+   */
+  nerve!: ViewNerve;
+
+  /**
+   * 视图标题
+   *
+   * @author lxm
+   * @date 2022-08-25 11:08:45
+   * @type {string}
+   */
+  caption!: string;
+
+  /**
+   * 视图工具栏界面状态
+   *
+   * @author lxm
+   * @date 2022-10-13 23:10:20
+   * @type {IButtonContainerState}
+   */
+  toolbarState: IButtonContainerState | null = null;
+
+  /**
+   * 视图loading
+   *
+   * @author lxm
+   * @date 2022-09-19 14:09:12
+   */
+  viewLoading = new LoadingState();
+
+  /**
+   * 所有部件的适配器
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:07
+   * @type {{ [key: string]: IControlProvider }}
+   */
+  providers: { [key: string]: IControlProvider } = {};
+
+  /**
+   * Creates an instance of View.
+   *
+   * @description 实例化后，需调用init方法初始化。
+   * @author chitanda
+   * @date 2022-07-21 17:07:57
+   * @param {string} modelPath 视图模型路径
+   * @param {IContext} context 上下文
+   * @param {IParams} params 视图参数
+   */
+  constructor(
+    public modelPath: string,
+    context: IContext,
+    params: IParams = {},
+  ) {
+    this.context = new IBizContext(context);
+    this.params = params;
+    this.nerve = this.createNerve();
+  }
+
+  /**
+   * 创建视图神经系统，子类覆盖
+   *
+   * @author lxm
+   * @date 2022-09-13 17:09:09
+   * @protected
+   * @returns {*}
+   */
+  protected createNerve(): ViewNerve {
+    return new ViewNerve(this);
+  }
+
+  /**
+   * 初始化
+   *
+   * @description 子类不可覆盖或重写此方法，在 init 时需要重写的使用 onInit 方法。
+   * @author chitanda
+   * @date 2022-07-24 16:07:52
+   * @return {*}  {Promise<void>}
+   */
+  async init(): Promise<void> {
+    await this.onInit();
+    this.complete = true;
+    this.nerve.created();
+    this.setCaption(this.model.caption);
+    this.force(() => {
+      this.nerve.mounted();
+    });
+  }
+
+  /**
+   * 重写的初始化操作
+   *
+   * @author lxm
+   * @date 2022-09-29 15:09:33
+   * @protected
+   * @returns {*}  {Promise<void>}
+   */
+  protected async onInit(): Promise<void> {
+    this.emit('neuronInit', this.nerve.self);
+    this.model = (await ibiz.model.getView(this.modelPath)) as T;
+    this.app = ibiz.hub.getApp(this.model.modelService.app);
+
+    // 处理上下文和导航参数
+    this.handleViewParams();
+
+    this.initToolbarState();
+  }
+
+  /**
+   * 初始化工具栏控制对象
+   *
+   * @author lxm
+   * @date 2022-10-13 23:10:37
+   * @returns {*}  {void}
+   */
+  initToolbarState(): void {
+    if (!this.model.toolbar) {
+      return;
+    }
+    // 初始化工具栏状态控制对象
+    const toolbarState = new ButtonContainerState();
+    [...this.model.toolbar.actionItems.values()].forEach(item => {
+      const buttonState = new ButtonState(
+        item.id,
+        item.getPSUIAction()!,
+        this.model.appEntity,
+      );
+      if (['Edit', 'Remove'].includes(item.getPSUIAction()!.uIActionTag)) {
+        buttonState.noPermissionMode = 'DISABLED';
+      }
+
+      toolbarState.addState(item.id, buttonState);
+    });
+    toolbarState.update();
+    this.toolbarState = toolbarState;
+  }
+
+  /**
+   * 处理上下文和导航参数相关的，如自定义导航参数的处理
+   *
+   * @author lxm
+   * @date 2022-09-08 15:09:47
+   * @protected
+   */
+  protected handleViewParams(): void {
+    // 路由打开的设置srfsessionid
+    if (this.modal.mode === ViewMode.ROUTE) {
+      this.context.srfsessionid = createUUID();
+    }
+
+    // 处理自定义导航上下文
+    const navContexts = this.model.source.getPSAppViewNavContexts();
+    let context = {};
+    if (notNilEmpty(navContexts)) {
+      context = convertNavData(navContexts!, this.context, this.params);
+    }
+    Object.assign(this.context, context);
+
+    // 处理自定义视图参数
+    const navParams = this.model.source.getPSAppViewNavParams();
+    let params = {};
+    if (notNilEmpty(navParams)) {
+      params = convertNavData(navParams!, this.context, this.params);
+    }
+    Object.assign(this.params, params);
+  }
+
+  /**
+   * 销毁
+   *
+   * @description 在视图界面组件销毁时，一定要调用此方法。
+   * @author chitanda
+   * @date 2022-07-24 15:07:12
+   */
+  destroy(): void {
+    this.nerve.destroy();
+  }
+
+  /**
+   * 刷新方法
+   *
+   * @author lxm
+   * @date 2022-08-30 17:08:42
+   */
+  async refresh() {
+    // 子类实现
+  }
+
+  /**
+   * 获取视图的数据，根据不同视图类型会不同，返回的都是数据的集合
+   * 编辑视图是表单数据
+   * 多数据是对应的数据部件的选中数据。
+   *
+   * @author lxm
+   * @date 2022-08-28 17:08:56
+   * @returns {*}  {IData[]}
+   */
+  getData(): IData[] {
+    return [];
+  }
+
+  /**
+   * 关闭视图
+   *
+   * @author lxm
+   * @date 2022-08-29 01:08:50
+   */
+  async closeView(data: IModalData = { ok: true, data: this.getData() }) {
+    this.nerve.self.evt.emit('closeView', data);
+  }
+
+  /**
+   * 注入neuron的能力，由外部接受close事件的父级去调用
+   *
+   * @author lxm
+   * @date 2022-09-09 16:09:41
+   * @returns {*}  {Promise<boolean>}
+   */
+  async beforeClose(): Promise<boolean> {
+    // todo关闭视图的判断，如弹出关闭提示
+    return true;
+  }
+
+  /**
+   * 强制更新视图（框架级）
+   *
+   * @author chitanda
+   * @param {() => void} [callback] 更新之后，组件渲染完成后的回调
+   * @date 2022-07-24 14:07:38
+   */
+  force(_callback?: () => void): void {
+    // 在界面数据发生变更时，会调用此方法。
+    // 可外部覆盖实例的此方法，实现自定义的数据更新逻辑。
+  }
+
+  /**
+   * 抛事件方法(框架级)
+   *
+   * @author lxm
+   * @date 2022-08-21 18:08:20
+   * @param {string} event
+   * @param {...any[]} args
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  emit(_event: string, ..._args: any[]): void {
+    // 在需要向父组件抛事件时，会调用此方法。
+    // 可外部覆盖实例的此方法，实现自定义的抛事件逻辑。
+  }
+
+  /**
+   * 处理工具栏菜单项点击
+   *
+   * @author lxm
+   * @date 2022-08-28 20:08:25
+   * @param {IPSDETBUIActionItem} item
+   * @param {MouseEvent} _event
+   */
+  async onToolbarClick(
+    item: IPSDETBUIActionItem,
+    event: MouseEvent,
+  ): Promise<void> {
+    if (!item.getPSAppViewUIAction()) {
+      throw new DefectModelError(item, '菜单项没有配置界面行为！');
+    }
+    const viewLogicKey = `${item.getPSAppViewUIAction()!.name}_click`;
+    const appViewLogic = this.model.source.findPSAppViewLogic(viewLogicKey);
+    if (!appViewLogic) {
+      throw new RuntimeError('没有找到对应的视图逻辑');
+    }
+    return this.executeViewLogic(appViewLogic, this.getData(), event);
+  }
+
+  /**
+   * 执行视图逻辑
+   *
+   * @author lxm
+   * @date 2022-09-08 10:09:38
+   * @param {IPSAppViewLogic} appViewLogic 视图逻辑
+   * @param {IData} data 数据
+   * @param {MouseEvent} event 原生事件
+   */
+  async executeViewLogic(
+    appViewLogic: IPSAppViewLogic,
+    data: IData[],
+    event?: MouseEvent,
+  ): Promise<void> {
+    await executeViewLogic(appViewLogic, this.context, data, this.params, {
+      event,
+      neuron: this.nerve.self,
+    });
+  }
+
+  /**
+   * 设置视图标题
+   *
+   * @author lxm
+   * @date 2022-08-31 16:08:49
+   * @param {string} caption
+   */
+  setCaption(caption: string) {
+    this.caption = caption;
+    this.nerve.self.evt.asyncEmit('setTitle', this.caption);
+    this.force();
+  }
+
+  /**
+   * 开启视图loading
+   *
+   * @author lxm
+   * @date 2022-09-19 14:09:00
+   */
+  beginViewLoading() {
+    this.viewLoading.begin();
+  }
+
+  /**
+   *关闭视图loading
+   *
+   * @author lxm
+   * @date 2022-09-19 14:09:09
+   */
+  endViewLoading() {
+    this.viewLoading.end();
+  }
+}

package/src/controller/view/wf-dyna-action-view.ts

@@ -0,0 +1,68 @@
+import { WFDynaActionViewModel } from '@ibiz-template/model';
+import { RuntimeError } from '@ibiz-template/core';
+import { WFDynaActionViewNerve } from '..';
+import { WFEditViewController } from '.';
+
+/**
+ * 工作流编辑视图控制器
+ *
+ * @author chitanda
+ * @date 2022-08-01 21:08:31
+ * @export
+ * @class EditViewController
+ * @extends {ViewController}
+ */
+export class WFDynaActionViewController<
+  T extends WFDynaActionViewModel = WFDynaActionViewModel,
+> extends WFEditViewController<T> {
+  declare nerve: WFDynaActionViewNerve;
+
+  protected createNerve(): WFDynaActionViewNerve {
+    return new WFDynaActionViewNerve(this);
+  }
+
+  /**
+   * 计算当前步骤的表单(通过视图参数获取)
+   *
+   * @author lxm
+   * @date 2022-09-29 15:09:07
+   * @returns {*}  {Promise<void>}
+   */
+  async calcActiveForm(): Promise<void> {
+    const processForm = this.context.activeForm
+      ? `wfform_${this.context.activeForm}`
+      : 'form';
+    const formModel = this.model.forms.get(processForm.toLowerCase());
+    if (!formModel) {
+      throw new RuntimeError(`找不到表单${processForm}的模型`);
+    }
+    this.activeForm = formModel;
+    // 编辑表单适配器
+    this.providers[formModel.name] = await ibiz.register.control.get(formModel);
+  }
+
+  /**
+   * 确认按钮回调
+   *
+   * @author lxm
+   * @date 2022-09-12 20:09:13
+   */
+  async onOkButtonClick(): Promise<void> {
+    // 先保存数据在提交工作流
+    if (this.context.isEditable) {
+      await this.save();
+    }
+    await this.nerve.form.call.wfSubmit();
+    await this.closeView({ ok: true, data: this.getData() });
+  }
+
+  /**
+   * 取消按钮回调
+   *
+   * @author lxm
+   * @date 2022-09-12 20:09:00
+   */
+  async onCancelButtonClick() {
+    await this.closeView({ ok: false, data: [] });
+  }
+}

package/src/controller/view/wf-dyna-edit-view.ts

@@ -0,0 +1,123 @@
+import { WFDynaEditViewModel } from '@ibiz-template/model';
+import { IBizContext } from '@ibiz-template/core';
+import { WFDynaEditViewNerve } from '..';
+import { WFEditViewController } from '.';
+import { WFLink } from '../interface';
+import { IModalData } from '../../interface';
+import { OpenAppViewCommand } from '../../command';
+
+/**
+ * 工作流动态编辑视图控制器
+ *
+ * @author chitanda
+ * @date 2022-08-01 21:08:31
+ * @export
+ * @class EditViewController
+ * @extends {ViewController}
+ */
+export class WFDynaEditViewController<
+  T extends WFDynaEditViewModel = WFDynaEditViewModel,
+> extends WFEditViewController<T> {
+  /**
+   * 工作流links
+   *
+   * @author lxm
+   * @date 2022-10-08 16:10:53
+   * @type {WFLink[]}
+   */
+  wfLinks: WFLink[] = [];
+
+  declare nerve: WFDynaEditViewNerve;
+
+  protected createNerve(): WFDynaEditViewNerve {
+    return new WFDynaEditViewNerve(this);
+  }
+
+  async load(): Promise<IData> {
+    const res = await super.load();
+    this.calcWfToolbar();
+    return res;
+  }
+
+  /**
+   * 计算工作流工具栏，需要在表单加载回来之后执行
+   *
+   * @author lxm
+   * @date 2022-09-30 19:09:44
+   * @returns {*}  {Promise<void>}
+   */
+  async calcWfToolbar(): Promise<void> {
+    const res = await this.entityService.wf.getWFLink(
+      new IBizContext(
+        { taskDefinitionKey: this.params.taskDefinitionKey },
+        this.context,
+      ),
+      this.getData(),
+    );
+    this.wfLinks = res.data as WFLink[];
+  }
+
+  /**
+   * 工作流工具栏点击回调处理
+   *
+   * @author lxm
+   * @date 2022-10-08 17:10:29
+   * @param {WFLink} link 点击按钮对应的WFLink
+   * @returns {*}  {Promise<void>}
+   */
+  async onLinkClick(link: WFLink): Promise<void> {
+    if (link.type) {
+      // todo 处理有type的情况
+    } else {
+      // 没有type的都走流程提交
+      return this.wfSubmitByLink(link);
+    }
+  }
+
+  async wfSubmitByLink(link: WFLink) {
+    // 流程表单可以编辑才会先保存
+    if (this.isEditable) {
+      await this.save();
+    }
+
+    // 处理视图上下文
+    const newContext = new IBizContext(
+      {
+        isEditable: this.isEditable,
+        activeForm: link.sequenceFlowForm,
+      },
+      this.context,
+    );
+    // 处理视图参数
+    const newParams = {
+      ...link,
+    };
+
+    const { sequenceFlowView } = link;
+
+    // 查找工作流提交视图
+    const submitView = this.model.source
+      .findPSAppViewRef(`WFACTION@${sequenceFlowView}`)
+      ?.getRefPSAppView();
+
+    // *没有工作流操作视图的，自己提交工作流
+    if (!submitView) {
+      await this.nerve.form.call.wfSubmit(newParams);
+      await this.closeView();
+      return;
+    }
+
+    // *有工作流操作视图的，由提交视图执行工作流提交
+    const result: IModalData = await ibiz.commands.execute(
+      OpenAppViewCommand.TAG,
+      submitView,
+      newContext,
+      newParams,
+    );
+
+    // 提交视图正常关闭后关闭当前视图
+    if (result.ok) {
+      await this.closeView();
+    }
+  }
+}

package/src/controller/view/wf-dyna-edit-view3.ts

@@ -0,0 +1,116 @@
+import { WFDynaEditView3Model } from '@ibiz-template/model';
+import { createUUID, notNilEmpty } from 'qx-util';
+import { IBizContext } from '@ibiz-template/core';
+import { WFDynaEditViewController } from '.';
+import { WFDynaEditView3Nerve } from '..';
+import { Srfuf } from '../../service';
+import { convertNavData } from '../../utils';
+
+/**
+ * 工作流动态编辑视图控制器
+ *
+ * @author chitanda
+ * @date 2022-08-01 21:08:31
+ * @export
+ * @class EditViewController
+ * @extends {ViewController}
+ */
+export class WFDynaEditView3Controller<
+  T extends WFDynaEditView3Model = WFDynaEditView3Model,
+> extends WFDynaEditViewController<T> {
+  /**
+   * 是否是新建数据
+   *
+   * @author lxm
+   * @date 2022-08-31 22:08:44
+   * @type {boolean}
+   */
+  isNewData: boolean = true;
+
+  /**
+   * 关系界面绘制参数
+   *
+   * @author lxm
+   * @date 2022-09-26 14:09:11
+   */
+  drPages: {
+    [key: string]: {
+      context: IContext;
+      params: IParams;
+      key: string;
+    };
+  } = {};
+
+  declare nerve: WFDynaEditView3Nerve;
+
+  protected createNerve(): WFDynaEditView3Nerve {
+    return new WFDynaEditView3Nerve(this);
+  }
+
+  protected async onInit(): Promise<void> {
+    await super.onInit();
+
+    // 初始化drPages
+    if (this.model.drTab?.pages.length) {
+      this.model.drTab.pages.forEach(page => {
+        this.drPages[page.source.name] = {
+          context: this.context,
+          params: this.params,
+          key: createUUID(),
+        };
+      });
+    }
+  }
+
+  async load(): Promise<IData> {
+    const data = await super.load();
+    this.isNewData = data.srfuf === Srfuf.CREATE;
+    this.calcViewParams(data);
+    return data;
+  }
+
+  /**
+   * 计算视图上下文和视图参数,并刷新视图
+   *
+   * @author lxm
+   * @date 2022-09-14 18:09:35
+   */
+  calcViewParams(data: IData): void {
+    const { pages } = this.model.drTab;
+    for (const page of pages) {
+      const { name } = page.source;
+      // 计算导航上下文
+      let newContext = new IBizContext({}, this.context);
+      const navContexts = page.source.getPSNavigateContexts();
+      if (notNilEmpty(navContexts)) {
+        newContext = Object.assign(
+          newContext,
+          convertNavData(navContexts!, this.context, this.params, data),
+        );
+      }
+
+      // 处理导航视图参数
+      const navParams = page.source.getPSNavigateParams();
+      let newParams: IData = {};
+      if (notNilEmpty(navParams)) {
+        newParams = convertNavData(navParams!, this.params, this.context, data);
+      }
+
+      // 视图参数或上下文发生变化时，销毁重绘视图
+      if (
+        !this.nerve.drViews.has(name) ||
+        JSON.stringify(this.drPages[name].context) !==
+          JSON.stringify(newContext) ||
+        JSON.stringify(this.drPages[name].params) !== JSON.stringify(newParams)
+      ) {
+        this.drPages[name].context = newContext;
+        this.drPages[name].params = newParams;
+        this.drPages[name].key = createUUID();
+      } else {
+        // 不变的情况重新加载视图的数据
+        this.nerve.drViews.get(name)?.call.refresh();
+      }
+    }
+    this.force();
+  }
+}