@ibiz-template/runtime 0.0.4-beta.2 → 0.0.4-beta.4

package/src/controller/common/view.controller.ts

@@ -0,0 +1,314 @@
+import { createUUID, notNilEmpty } from 'qx-util';
+import { IBizContext } from '@ibiz-template/core';
+import { IAppView, IAppViewLogic } from '@ibiz/model-core';
+import { isNil } from 'ramda';
+import { LoadingState } from '../utils/loading/loading-state';
+import { EventBase, IViewEvent } from '../interface';
+import { IModal, IModalData } from '../../interface';
+import { ViewMode } from '../../constant';
+import { convertNavData } from '../../utils';
+import { executeViewLogic, ViewLogicDispatcher } from '../../view-logic';
+import { ViewState } from '../state';
+import { CTX } from '../ctx';
+import { PresetViewEngine } from '../../engine';
+import { ControllerEvent } from '../utils';
+import { BaseController } from './base.controller';
+
+/**
+ * 视图控制器
+ *
+ * @author chitanda
+ * @date 2022-07-21 15:07:51
+ * @export
+ * @class ViewController
+ */
+export class ViewController<
+  T extends IAppView = IAppView,
+> extends BaseController {
+  /**
+   * 视图UI状态
+   *
+   * @memberof ViewController
+   */
+  state = new ViewState();
+
+  /**
+   * 当为模态、飘窗等非路由模式打开时，外部会注入此方法，用于关闭视图。
+   *
+   * @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 {IContext}
+   */
+  context: IContext;
+
+  /**
+   * 视图参数
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:55
+   * @type {IParams}
+   */
+  params: IParams;
+
+  declare evt: ControllerEvent<IViewEvent>;
+
+  /**
+   * 预置引擎
+   * @author lxm
+   * @date 2023-04-25 08:53:28
+   * @type {PresetViewEngine}
+   */
+  presetEngine?: PresetViewEngine;
+
+  /**
+   * 视图loading状态控制器
+   *
+   * @author lxm
+   * @date 2022-09-19 14:09:12
+   */
+  viewLoading = new LoadingState();
+
+  /**
+   * 视图逻辑的事件调度分发器
+   * @author lxm
+   * @date 2023-03-23 08:15:02
+   * @type {ViewLogicDispatcher}
+   */
+  logicDispatcher!: ViewLogicDispatcher;
+
+  /**
+   * Creates an instance of ViewController.
+   * @author lxm
+   * @date 2023-04-20 02:05:33
+   * @param {T} model 视图模型
+   * @param {IContext} context 上下文
+   * @param {IParams} [params] 视图参数
+   * @param {CTX} [ctx]
+   */
+  constructor(public model: T, context: IContext, params?: IParams, ctx?: CTX) {
+    super(new CTX(ctx));
+    this.model = ibiz.util.viewLayout.fill(model) as T;
+
+    // 如果视图有上层ctx，作为上层的子在上层注册自身
+    if (ctx) {
+      ctx.registerController(this.model.name!, this);
+    }
+    this.name = this.model.name!;
+    this.context = IBizContext.create({}, context);
+    this.params = params || {};
+    this.ctx.init(this);
+    this.presetEngine = ibiz.engine.getPresetViewEngine(this.model, this)!;
+  }
+
+  getEventArgs(): Omit<EventBase, 'eventName'> {
+    return {
+      context: this.context,
+      params: this.params,
+      data: this.getData() || [],
+      targetName: this.model.name!,
+      ctx: this.ctx,
+    };
+  }
+
+  protected async doCreated(): Promise<void> {
+    await super.doCreated();
+
+    // 处理上下文和导航参数
+    this.handleViewParams();
+    this.setCaption(this.model.caption);
+
+    // 引擎初始化
+    this.presetEngine?.init();
+
+    // 初始化视图布局面板适配器
+    // const { viewLayoutPanel } = this.model;
+    // if (viewLayoutPanel?.useDefaultLayout) {
+    //   const provider = await ibiz.register.control.get(viewLayoutPanel!);
+    //   this.providers.viewLayoutPanel = provider;
+    // }
+
+    // this.logicDispatcher = new ViewLogicDispatcher(this.context, this.params);
+    // if (this.model.appViewLogics?.length) {
+    //   await this.logicDispatcher.init(this.model.appViewLogics);
+    // }
+
+    // // 监听视图事件
+    // this.evt.onAll((_name, event) => {
+    //   return this.logicDispatcher.view.fire(event);
+    // });
+  }
+
+  protected doDestroyed(): void {
+    super.doDestroyed();
+    this.ctx.destory();
+    this.context.destroy();
+    this.presetEngine = undefined;
+    // this.logicDispatcher.destroy();
+  }
+
+  /**
+   * 处理上下文和导航参数相关的，如自定义导航参数的处理
+   *
+   * @author lxm
+   * @date 2022-09-08 15:09:47
+   * @protected
+   */
+  protected handleViewParams(): void {
+    // // 识别上下文的srfkey并转成实体名称，然后置空srfkey
+    // if (this.context.srfkey && this.model.appEntity) {
+    //   this.context[this.model.appEntity.deName] = this.context.srfkey;
+    //   this.context.srfkey = undefined;
+    // }
+    this.context.srfappid = this.model.appId!;
+
+    // 路由打开的设置srfsessionid
+    if (this.modal.mode === ViewMode.ROUTE) {
+      this.context.srfsessionid = createUUID();
+    }
+
+    // 处理自定义导航上下文
+    const navContexts = this.model.appViewNavContexts;
+    let context = {};
+    if (notNilEmpty(navContexts)) {
+      context = convertNavData(navContexts!, this.context, this.params);
+    }
+    Object.assign(this.context, context);
+
+    // 处理自定义视图参数
+    const navParams = this.model.appViewNavParams;
+    let params = {};
+    if (notNilEmpty(navParams)) {
+      params = convertNavData(navParams!, this.context, this.params);
+    }
+    Object.assign(this.params, params);
+  }
+
+  /**
+   * 刷新方法
+   *
+   * @author lxm
+   * @date 2022-08-30 17:08:42
+   */
+  async refresh() {
+    // 子类实现
+  }
+
+  /**
+   * 获取视图的数据，根据不同视图类型会不同，返回的都是数据的集合
+   * 编辑视图是表单数据
+   * 多数据是对应的数据部件的选中数据。
+   *
+   * @author lxm
+   * @date 2022-08-28 17:08:56
+   * @returns {*}  {IDatum[]}
+   */
+  getData(): IDatum[] {
+    return [];
+  }
+
+  /**
+   * 关闭视图
+   *
+   * @author lxm
+   * @date 2022-08-29 01:08:50
+   */
+  async closeView(modalData: IModalData = { ok: true, data: this.getData() }) {
+    this.evt.emit('onCloseView', {
+      data: modalData.data,
+      ok: modalData.ok,
+    });
+  }
+
+  /**
+   * 执行视图逻辑
+   *
+   * @author lxm
+   * @date 2022-09-08 10:09:38
+   * @param {IPSAppViewLogic} appViewLogic 视图逻辑
+   * @param {IDatum[]} data 数据
+   * @param {MouseEvent} event 原生事件
+   */
+  async executeViewLogic(
+    appViewLogic: IAppViewLogic,
+    data: IDatum[],
+    event?: MouseEvent,
+  ): Promise<void> {
+    // todo 后面没用了
+    const result = await executeViewLogic(
+      appViewLogic,
+      this.context,
+      data,
+      this.params,
+      {
+        event,
+        // neuron: this.nerve.self,
+      },
+    );
+
+    // 界面行为执行后续处理
+    if (result.refresh) {
+      await this.refresh();
+    }
+    if (result.closeView) {
+      await this.closeView();
+    }
+  }
+
+  /**
+   * 设置视图标题
+   *
+   * @author lxm
+   * @date 2022-08-31 16:08:49
+   * @param {string} caption
+   */
+  setCaption(caption?: string) {
+    if (isNil(caption)) {
+      return;
+    }
+    this.state.caption = caption;
+    this.evt.emit('onSetTitle', {
+      title: caption,
+    });
+  }
+
+  /**
+   * 开启视图loading
+   *
+   * @author lxm
+   * @date 2022-09-19 14:09:00
+   */
+  startLoading() {
+    this.viewLoading.begin();
+    this.state.isLoading = this.viewLoading.isLoading;
+  }
+
+  /**
+   *关闭视图loading
+   *
+   * @author lxm
+   * @date 2022-09-19 14:09:09
+   */
+  endLoading() {
+    this.viewLoading.end();
+    this.state.isLoading = this.viewLoading.isLoading;
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  async onCtrlEvent(event: EventBase): Promise<void> {
+    if (event?.targetName === 'toolbar') {
+      event.context = this.context;
+      event.params = this.params;
+      event.data = this.getData();
+    }
+    return this.logicDispatcher.ctrl.fire(event);
+  }
+}

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,3 @@
+export * from './form/form-notify-state';
+export * from './grid/grid-notify-state';
+export * from './panel/panel-notify-state';

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

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

package/src/controller/constant/index.ts

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

package/src/controller/control/control.ts

@@ -0,0 +1,132 @@
+import { IControl } from '@ibiz/model-core';
+import { BaseController } from '../common';
+import { CTX } from '../ctx';
+import { IControlEvent } from '../interface';
+import { ControlState } from '../state';
+import { ControllerEvent } from '../utils';
+
+/**
+ * 部件控制器
+ *
+ * @author chitanda
+ * @date 2022-07-21 15:07:08
+ * @export
+ * @class ControlController
+ */
+export class ControlController<
+  T extends IControl = IControl,
+> extends BaseController {
+  declare evt: ControllerEvent<IControlEvent>;
+
+  /**
+   * 部件模型
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:28
+   * @type {T}
+   */
+  readonly model: T;
+
+  /**
+   * 上下文
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:35
+   * @type {IContext}
+   */
+  readonly context: IContext;
+
+  /**
+   * 视图参数
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:41
+   * @type {IParams}
+   */
+  readonly params: IParams;
+
+  /**
+   * 部件UI状态
+   *
+   * @memberof ControlController
+   */
+  state = new ControlState();
+
+  /**
+   * 获取部件通用的事件参数
+   * @author lxm
+   * @date 2023-03-26 11:42:21
+   * @readonly
+   */
+  getEventArgs() {
+    return {
+      context: this.context,
+      params: this.params,
+      data: this.getData() || [],
+      targetName: this.model.name!,
+      // neuron: this.nerve.self,
+      // view: this.ctx.view,
+      ctx: this.ctx,
+    };
+  }
+
+  /**
+   * Creates an instance of ControlController.
+   *
+   * @author chitanda
+   * @date 2022-07-24 17:07:58
+   * @param {T} model
+   * @param {IContext} context
+   * @param {IParams} [params={}]
+   */
+  constructor(model: T, context: IContext, params: IParams, ctx: CTX) {
+    super(ctx);
+    this.model = model;
+    this.name = this.model.name!;
+    this.context = context;
+    this.params = params;
+    this.ctx.registerController(this.model.name!, this);
+  }
+
+  /**
+   * 获取部件类型
+   * @author lxm
+   * @date 2023-03-28 02:23:37
+   * @return {*}  {string}
+   */
+  getControlType(): string {
+    return this.model.controlType!;
+  }
+
+  /**
+   * 获取部件数据，非数据部件没有数据
+   * @author lxm
+   * @date 2023-03-26 11:41:51
+   * @return {*}  {(IDatum[] | null)}
+   */
+  getData(): IDatum[] | null {
+    return null;
+  }
+
+  /**
+   * 开始加载
+   *
+   * @author chitanda
+   * @date 2022-09-21 15:09:18
+   * @return {*}  {Promise<void>}
+   */
+  async startLoading(): Promise<void> {
+    this.ctx.startLoading();
+  }
+
+  /**
+   * 加载完毕
+   *
+   * @author chitanda
+   * @date 2022-09-21 15:09:31
+   * @return {*}  {Promise<void>}
+   */
+  async endLoading(): Promise<void> {
+    this.ctx.endLoading();
+  }
+}

package/src/controller/control/index.ts

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

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

@@ -0,0 +1,2 @@
+export * from './md-item';
+export * from './md';

package/src/controller/control/md/md-item.ts

@@ -0,0 +1,30 @@
+import { ControlVO } from '../../../service';
+import { MDController } from './md';
+
+/**
+ * 多数据部件数据项状态管理控制器
+ *
+ * @class MDItemController
+ */
+export class MDItemController {
+  /**
+   * 数据项
+   *
+   */
+  data: ControlVO;
+
+  constructor(data: ControlVO, _mdController: MDController) {
+    this.data = data;
+  }
+
+  /**
+   * 销毁方法
+   *
+   * @author lxm
+   * @date 2022-09-06 19:09:02
+   */
+  destroy() {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (this.data as any) = undefined;
+  }
+}