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

package/src/config/global-config.ts

@@ -0,0 +1,14 @@
+import { IGlobalConfig } from '../interface/i-global-config/i-global-config';
+
+/**
+ * 全局配置类,控制应用的功能开关。
+ *
+ * @author lxm
+ * @date 2022-12-09 14:12:28
+ * @export
+ * @class GlobalConfig
+ * @implements {IGlobalConfig}
+ */
+export class GlobalConfig implements IGlobalConfig {
+  enableDataInfoBar: boolean = true;
+}

package/src/constant/index.ts

@@ -1 +1 @@
-export * from './view-mode';
+export { ViewMode } from './view-mode';

package/src/controller/constant/control/form/form-notify-state.ts

@@ -0,0 +1,6 @@
+/* eslint-disable no-shadow */
+export enum FormNotifyState {
+  LOAD = 'LOAD',
+  DRAFT = 'DRAFT',
+  SAVE = 'SAVE',
+}

package/src/controller/constant/control/grid/grid-notify-state.ts

@@ -0,0 +1,6 @@
+/* eslint-disable no-shadow */
+export enum GridNotifyState {
+  LOAD = 'LOAD',
+  DRAFT = 'DRAFT',
+  SAVE = 'SAVE',
+}

package/src/controller/constant/control/index.ts

@@ -0,0 +1,2 @@
+export * from './form/form-notify-state';
+export * from './grid/grid-notify-state';

package/src/controller/constant/index.ts

@@ -0,0 +1 @@
+export * from './control';

package/src/controller/control/app-menu.ts

@@ -0,0 +1,87 @@
+import {
+  AppMenuModel,
+  DefectModelError,
+  AppMenuItemModel,
+} from '@ibiz-template/model';
+import { AppFuncCommand } from '../../command';
+import { AppMenuNerve } from '../neuron';
+import { ControlController } from './control';
+
+/**
+ * 应用菜单控制器
+ *
+ * @author chitanda
+ * @date 2022-07-24 15:07:07
+ * @export
+ * @class AppMenuController
+ * @extends {ControlController}
+ */
+export class AppMenuController extends ControlController<AppMenuModel> {
+  declare nerve: AppMenuNerve;
+
+  protected createNerve(): AppMenuNerve {
+    return new AppMenuNerve(this);
+  }
+
+  /**
+   * 菜单项状态
+   *
+   * @author lxm
+   * @date 2022-10-12 20:10:51
+   * @type {{ [p: string]: { visible: boolean; permitted: boolean } }}
+   */
+  menuItemsState: { [p: string]: { visible: boolean; permitted: boolean } } =
+    {};
+
+  protected async onInit(): Promise<void> {
+    super.onInit();
+
+    // 初始化菜单项状态
+    this.model.items.forEach(item => {
+      this.initMenuItemState(item);
+    });
+  }
+
+  /**
+   * 菜单项点击回调，触发对应的应用功能
+   *
+   * @author chitanda
+   * @date 2022-12-22 14:12:53
+   * @param {string} id
+   * @return {*}  {Promise<void>}
+   */
+  async onClickMenuItem(id: string): Promise<void> {
+    const menuItem = this.model.findMenuItemModelById(id)!;
+    const appFunc = await ibiz.model.getAppFunc(menuItem);
+    if (!appFunc) {
+      throw new DefectModelError(menuItem.source, `未配置界面行为`);
+    }
+    await ibiz.commands.execute(AppFuncCommand.TAG, appFunc);
+  }
+
+  /**
+   * 初始化菜单项状态
+   *
+   * @author lxm
+   * @date 2022-10-12 20:10:37
+   * @param {AppMenuItemModel} menu
+   */
+  initMenuItemState(menu: AppMenuItemModel): {
+    visible: boolean;
+    permitted: boolean;
+  } {
+    const app = ibiz.hub.getApp(menu);
+    const permitted = app.authority.hasMenuPermitted(menu);
+    let visible = permitted;
+    // 有子的计算子状态，如果本身显示但是子都不显示则不显示
+    if (menu.children?.length) {
+      const childrenState = menu.children.map(child => {
+        return this.initMenuItemState(child).visible;
+      });
+      visible = visible && childrenState.includes(true);
+    }
+    const result = { permitted, visible };
+    this.menuItemsState[menu.source.id] = result;
+    return result;
+  }
+}

package/src/controller/control/control.ts

@@ -0,0 +1,166 @@
+import { IBizContext } from '@ibiz-template/core';
+import { ControlModel } from '@ibiz-template/model';
+import { ControlNerve } from '../neuron';
+
+/**
+ * 部件控制器
+ *
+ * @author chitanda
+ * @date 2022-07-21 15:07:08
+ * @export
+ * @class ControlController
+ */
+export class ControlController<T extends ControlModel = ControlModel> {
+  /**
+   * 部件模型
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:28
+   * @type {T}
+   */
+  readonly model: T;
+
+  /**
+   * 上下文
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:35
+   * @type {IBizContext}
+   */
+  readonly context: IBizContext;
+
+  /**
+   * 视图参数
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:41
+   * @type {IParams}
+   */
+  readonly params: IParams;
+
+  /**
+   * 控制器是否已经准备完成
+   *
+   * @author lxm
+   * @date 2022-08-18 22:08:23
+   * @type {boolean}
+   */
+  complete: boolean = false;
+
+  /**
+   * 部件神经系统
+   *
+   * @author lxm
+   * @date 2022-08-21 11:08:33
+   * @type {ViewNeuron}
+   */
+  nerve!: ControlNerve;
+
+  /**
+   * Creates an instance of ControlController.
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:58
+   * @param {T} model
+   * @param {IBizContext} context
+   * @param {IParams} [params={}]
+   */
+  constructor(model: T, context: IBizContext, params: IParams = {}) {
+    this.model = model;
+    this.context = context;
+    this.params = params;
+    this.nerve = this.createNerve();
+  }
+
+  /**
+   * 创建部件神经系统，子类覆盖
+   *
+   * @author lxm
+   * @date 2022-09-13 17:09:09
+   * @protected
+   * @returns {*}
+   */
+  protected createNerve(): ControlNerve {
+    return new ControlNerve(this);
+  }
+
+  /**
+   * 子类不可覆盖或重写此方法，在 init 时需要重写的使用 onInit 方法。
+   *
+   * @author lxm
+   * @date 2022-08-18 22:08:30
+   * @returns {*}  {Promise<void>}
+   */
+  async init(): Promise<void> {
+    await this.onInit();
+    this.complete = true;
+    this.nerve.created();
+    this.force(() => {
+      this.nerve.mounted();
+    });
+  }
+
+  protected async onInit(): Promise<void> {
+    // 异步初始化
+    this.emit('neuronInit', this.nerve.self);
+  }
+
+  /**
+   * 强制更新视图
+   *
+   * @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 {...IData[]} args
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  emit(_event: string, ..._args: any[]): void {
+    // 在需要向父组件抛事件时，会调用此方法。
+    // 可外部覆盖实例的此方法，实现自定义的抛事件逻辑。
+  }
+
+  /**
+   * 销毁
+   *
+   * @author chitanda
+   * @date 2022-07-24 15:07:12
+   */
+  destroy(): void {
+    // 务必在组件销毁时调用此方法。
+    this.nerve.destroy();
+  }
+
+  /**
+   * 开始加载
+   *
+   * @author chitanda
+   * @date 2022-09-21 15:09:18
+   * @return {*}  {Promise<void>}
+   */
+  async startLoading(): Promise<void> {
+    this.nerve.self.evt.emit('beginViewLoading');
+  }
+
+  /**
+   * 加载完毕
+   *
+   * @author chitanda
+   * @date 2022-09-21 15:09:31
+   * @return {*}  {Promise<void>}
+   */
+  async endLoading(): Promise<void> {
+    this.nerve.self.evt.emit('endViewLoading');
+  }
+}

package/src/controller/control/dashboard.ts

@@ -0,0 +1,89 @@
+import {
+  ContainerPortletModel,
+  DashboardModel,
+  PortletPartModel,
+} from '@ibiz-template/model';
+import { ContainerPortletController } from './portlet/container-portlet';
+import { PortletPartController } from './portlet/portlet-part';
+import { IPortletPartProvider } from '../interface';
+import { DashboardNerve } from '../neuron';
+import { ControlController } from './control';
+
+/**
+ * 数据看板控制器
+ *
+ * @author lxm
+ * @date 2022-10-14 11:10:47
+ * @export
+ * @class DashboardController
+ * @extends {ControlController<T>}
+ * @template T
+ */
+export class DashboardController<
+  T extends DashboardModel = DashboardModel,
+> extends ControlController<T> {
+  /**
+   * 所有数据看板成员的适配器
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:07
+   * @type {{ [key: string]: IPortletPartProvider }}
+   */
+  providers: { [key: string]: IPortletPartProvider } = {};
+
+  /**
+   * 门户部件控制器
+   *
+   * @author lxm
+   * @date 2022-10-20 22:10:26
+   * @type {{ [key: string]: PortletPartController }}
+   */
+  portlets: { [key: string]: PortletPartController } = {};
+
+  declare nerve: DashboardNerve;
+
+  protected createNerve(): DashboardNerve {
+    return new DashboardNerve(this);
+  }
+
+  protected async onInit(): Promise<void> {
+    await super.onInit();
+    // 初始化providers和portlets
+    await this.initPortlets(this.model.children);
+  }
+
+  /**
+   * 初始化子门户部件
+   *
+   * @author lxm
+   * @date 2022-10-21 03:10:49
+   * @param {PortletPartModel[]} portletModels
+   * @param {ContainerPortletController} [parent]
+   * @returns {*}  {Promise<void>}
+   */
+  async initPortlets(
+    portletModels: PortletPartModel[],
+    parent?: ContainerPortletController,
+  ): Promise<void> {
+    await Promise.all(
+      portletModels.map(async portlet => {
+        const provider = await ibiz.register.portletPart.get(portlet);
+        if (provider) {
+          this.providers[portlet.name] = provider;
+          const controller = await provider.createController(
+            portlet,
+            this,
+            parent,
+          );
+          this.portlets[portlet.name] = controller;
+          if ((portlet as ContainerPortletModel).children?.length) {
+            await this.initPortlets(
+              (portlet as ContainerPortletModel).children,
+              controller as ContainerPortletController,
+            );
+          }
+        }
+      }),
+    );
+  }
+}

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

@@ -0,0 +1,226 @@
+import { EditFormModel } from '@ibiz-template/model';
+import { RuntimeError } from '@ibiz-template/core';
+import { FormNotifyState } from '../../constant';
+import { EditFormNerve } from '../../neuron';
+import { FormController } from './form';
+import { ControlVO, EditFormService } from '../../../service';
+
+/**
+ * 编辑表单控制器
+ *
+ * @author chitanda
+ * @date 2022-08-03 11:08:20
+ * @export
+ * @class EditFormController
+ * @extends {FormController<EditFormModel>}
+ */
+export class EditFormController extends FormController<EditFormModel> {
+  /**
+   * 编辑表单部件服务
+   *
+   * @author lxm
+   * @date 2022-08-19 13:08:51
+   * @type {EntityService}
+   */
+  service!: EditFormService;
+
+  /**
+   * 视图内部通信器
+   *
+   * @author lxm
+   * @date 2022-08-21 11:08:33
+   * @type {ViewNeuron}
+   */
+  declare nerve: EditFormNerve;
+
+  /**
+   * 是否是新建数据
+   *
+   * @author lxm
+   * @date 2022-08-31 22:08:44
+   * @type {boolean}
+   */
+  isNewData: boolean = false;
+
+  protected createNerve(): EditFormNerve {
+    return new EditFormNerve(this);
+  }
+
+  /**
+   * 初始化方法
+   *
+   * @author lxm
+   * @date 2022-08-22 22:08:16
+   * @protected
+   * @returns {*}  {Promise<void>}
+   */
+  protected async onInit(): Promise<void> {
+    await super.onInit();
+    // 实例部件服务
+    this.service = new EditFormService(this.model);
+    await this.service.init(this.context);
+  }
+
+  /**
+   * 部件加载数据行为
+   *
+   * @author lxm
+   * @date 2022-08-19 14:08:50
+   */
+  async load(): Promise<ControlVO> {
+    this.isNewData = !this.context[this.model.appEntity.deName];
+    await this.startLoading();
+    let res;
+    try {
+      res = this.isNewData
+        ? await this.service.getDraft(this.context, this.params)
+        : await this.service.get(this.context, this.params);
+    } finally {
+      await this.endLoading();
+    }
+    res.data.reactiveInit();
+    this.data = res.data;
+    this.formStateNotify(
+      this.isNewData ? FormNotifyState.DRAFT : FormNotifyState.LOAD,
+    );
+    this.isLoaded = true;
+    this.force();
+    return this.data;
+  }
+
+  /**
+   * 保存表单数据
+   *
+   * @author lxm
+   * @date 2022-08-31 22:08:40
+   */
+  async save(): Promise<IData> {
+    const isValid = await this.validate();
+    if (!isValid) {
+      throw new RuntimeError('请检查表单填写！');
+    }
+    await this.startLoading();
+    let res;
+    try {
+      res = this.isNewData
+        ? await this.service.create(this.context, this.data)
+        : await this.service.update(this.context, this.data);
+    } finally {
+      await this.endLoading();
+    }
+    // 保存结束后的事件
+    if (res.data) {
+      this.data.mergeOrigin(res.data);
+    }
+    await this.nerve.self.evt.asyncEmit('afterSave', this.isNewData, this.data);
+    this.isNewData = false;
+    this.formStateNotify(FormNotifyState.SAVE);
+    ibiz.message.success(`${this.data.srfmajortext || ''}保存成功`);
+    this.force();
+    return this.data;
+  }
+
+  /**
+   * 删除表单数据
+   *
+   * @author lxm
+   * @date 2022-09-01 09:09:36
+   * @returns {*}
+   */
+  async remove() {
+    // 新建数据清空数据
+    if (!this.isNewData) {
+      await this.startLoading();
+      try {
+        await this.service.remove(this.context, this.params);
+      } finally {
+        await this.endLoading();
+      }
+    }
+    await this.nerve.self.evt.asyncEmit('afterRemove', this.data);
+    this.data = new ControlVO();
+    this.force();
+  }
+
+  /**
+   * 表单项更新
+   *
+   * @author lxm
+   * @date 2022-09-15 21:09:13
+   * @param {string} methodName 更新实体方法
+   * @param {string[]} updateItems 更新项名称集合
+   */
+  async updateFormItem(methodName: string, updateItems?: string[]) {
+    const params = { ...this.params, ...this.data.getRequestData() };
+    const res = await this.service.updateFormItem(
+      methodName,
+      this.context,
+      params,
+    );
+    const result = res.data;
+    if (result && updateItems?.length) {
+      for (const itemName of updateItems) {
+        // 可能会置空，所以直接赋值
+        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('流程提交成功');
+  }
+}

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

@@ -0,0 +1,82 @@
+import { RuntimeError } from '@ibiz-template/core';
+import { FormButtonModel, IPSAppViewLogic } from '@ibiz-template/model';
+import { EditFormController, FormDetailController } from '.';
+
+/**
+ * 表单按钮控制器
+ *
+ * @author lxm
+ * @date 2022-09-04 15:09:52
+ * @export
+ * @class FormButtonController
+ * @extends {FormDetailController}
+ */
+export class FormButtonController extends FormDetailController<FormButtonModel> {
+  /**
+   * 视图逻辑
+   *
+   * @author lxm
+   * @date 2022-09-28 21:09:32
+   * @type {IPSAppViewLogic}
+   */
+  viewLogic?: IPSAppViewLogic;
+
+  protected async onInit(): Promise<void> {
+    await super.onInit();
+    // 初始化视图逻辑对象
+    const tag1 = this.form.model.source.name.toLowerCase();
+    const tag2 = this.model.source.codeName.toLowerCase();
+    const viewLogicKey = `${tag1}_${tag2}_click`;
+    this.viewLogic =
+      this.form.model.source.findPSAppViewLogic(viewLogicKey) || undefined;
+  }
+
+  /**
+   * 按钮点击处理回调
+   *
+   * @author lxm
+   * @date 2022-09-28 21:09:33
+   * @param {MouseEvent} event
+   */
+  async onClick(event: MouseEvent): Promise<void> {
+    if (this.model.source.actionType === 'UIACTION') {
+      return this.doUIAction(event);
+    }
+    return this.doFormItemUpdate();
+  }
+
+  /**
+   * 执行界面行为
+   *
+   * @author lxm
+   * @date 2022-10-19 22:10:20
+   * @param {MouseEvent} event
+   * @returns {*}  {Promise<void>}
+   */
+  async doUIAction(event: MouseEvent): Promise<void> {
+    if (!this.viewLogic) {
+      throw new RuntimeError('没有找到按钮对应的视图逻辑');
+    }
+    await this.form.nerve.self.evt.asyncEmit(
+      'actionClick',
+      this.viewLogic,
+      [this.form.data],
+      event,
+    );
+  }
+
+  /**
+   * 执行表单项更新
+   *
+   * @author lxm
+   * @date 2022-10-19 22:10:22
+   * @returns {*}  {Promise<void>}
+   */
+  async doFormItemUpdate(): Promise<void> {
+    if (!this.model.formItemUpdate) {
+      throw new RuntimeError('不存在表单项更新');
+    }
+    const { methodName, itemNames } = this.model.formItemUpdate;
+    (this.form as EditFormController).updateFormItem(methodName, itemNames);
+  }
+}

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

@@ -0,0 +1,16 @@
+import { FormGroupPanelModel } from '@ibiz-template/model';
+import { FormDetailController } from '.';
+
+/**
+ * 表单容器的控制器
+ *
+ * @author lxm
+ * @date 2022-09-04 12:09:52
+ * @export
+ * @class FormContainerController
+ * @extends {FormDetailController<T>}
+ * @template T
+ */
+export class FormContainerController<
+  T extends FormGroupPanelModel = FormGroupPanelModel,
+> extends FormDetailController<T> {}