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

package/src/controller/common/control/control.controller.ts

@@ -0,0 +1,709 @@
+import {
+  IControl,
+  IMDControl,
+  ICtrlMsgItem,
+  IControlLogic,
+  IViewLayoutPanel,
+} from '@ibiz/model-core';
+import {
+  HttpError,
+  StringUtil,
+  IBizParams,
+  IBizContext,
+  NoticeError,
+  RuntimeError,
+  IPortalMessage,
+} from '@ibiz-template/core';
+import { clone, isNil, isNotNil } from 'ramda';
+import { notNilEmpty } from 'qx-util';
+import { BaseController } from '..';
+import { CTX } from '../../ctx';
+import {
+  EventBase,
+  IControlEvent,
+  IControlState,
+  IViewController,
+  IControlController,
+  IViewLayoutPanelController,
+} from '../../../interface/controller';
+import { ControllerEvent } from '../../utils';
+import {
+  IProvider,
+  IApiMaskOption,
+  IUILogicParams,
+  IDataAbilityParams,
+} from '../../../interface';
+import { ControlLogicScheduler } from '../../../logic-scheduler';
+import { getControlProvider } from '../../../register';
+import { convertNavData, ScriptFactory } from '../../../utils';
+import { calcDeCodeNameById, getControlPanel } from '../../../model';
+import { ControlVO } from '../../../service';
+
+export type DEDataChangeType = 'create' | 'update' | 'remove';
+
+/**
+ * 部件控制器
+ *
+ * @author chitanda
+ * @date 2022-07-21 15:07:08
+ * @export
+ * @class ControlController
+ */
+export class ControlController<
+    T extends IControl = IControl,
+    S extends IControlState = IControlState,
+    E extends IControlEvent = IControlEvent,
+  >
+  extends BaseController<T, S, E>
+  implements IControlController<T, S, E>
+{
+  protected get _evt(): ControllerEvent<IControlEvent> {
+    return this.evt;
+  }
+
+  get view(): IViewController {
+    return this.ctx.view;
+  }
+
+  // 部件标识
+  get ctrlId(): string {
+    return `${this.view.model.id}@${this.model.id}`;
+  }
+
+  /**
+   * 部件逻辑调度器
+   * @author lxm
+   * @date 2023-06-25 09:09:26
+   * @type {ControlLogicScheduler}
+   */
+  scheduler?: ControlLogicScheduler;
+
+  /**
+   * 部件布局面板模型
+   * @author lxm
+   * @date 2023-07-19 03:45:45
+   * @type {IPanel}
+   */
+  controlPanel?: IViewLayoutPanel;
+
+  layoutPanel?: IViewLayoutPanelController;
+
+  /**
+   * 部件参数
+   *
+   * @author zk
+   * @date 2023-09-26 03:09:21
+   * @type {IData}
+   * @memberof ControlController
+   */
+  controlParams: IData = {};
+
+  /**
+   * 子适配器
+   * @author lxm
+   * @date 2023-07-19 04:14:50
+   * @type {{ [key: string]: IProvider }}
+   */
+  providers: { [key: string]: IProvider } = {};
+
+  declare params: IBizParams;
+
+  /**
+   * 触发源key
+   *
+   * @author tony001
+   * @date 2024-03-28 17:03:03
+   * @type {string}
+   */
+  triggerKey: string = '';
+
+  /**
+   * 等到激活的回调函数集合
+   *
+   * @author tony001
+   * @date 2024-03-28 17:03:15
+   */
+  awaitActiveCbs = new Map<string, () => void>();
+
+  /**
+   * 延迟执行（防抖用）
+   *
+   * @author tony001
+   * @date 2024-03-28 17:03:27
+   */
+  delayCbs = new Map<string, NodeJS.Timeout>();
+
+  /**
+   * 运行模式
+   *
+   * @type {('DESIGN' | 'RUNTIME')} （设计模式 | 运行时）
+   * @memberof ControlController
+   */
+  runMode: 'DESIGN' | 'RUNTIME' = 'RUNTIME';
+
+  /**
+   * 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(
+      model,
+      IBizContext.create({}, context),
+      new IBizParams({}, params),
+      ctx,
+    );
+    this.registerToCtx();
+    this.runMode = context.srfrunmode || 'RUNTIME';
+    // 初始化部件的布局面板
+    this.controlPanel = getControlPanel(model);
+    if (!this.controlPanel) {
+      const panelModel = ibiz.util.layoutPanel.get(
+        `${model.controlType}_DEFAULT`,
+      );
+      if (panelModel) {
+        this.controlPanel = clone(panelModel);
+      }
+    }
+
+    this.updateContextParams({});
+    // 处理部件控件参数时机
+    this.handleControlParams();
+  }
+
+  /**
+   * 往ctx里注册控制器
+   * @author lxm
+   * @date 2023-07-31 08:37:17
+   * @protected
+   */
+  protected registerToCtx(): void {
+    this.ctx.registerController(this.model.name! || this.model.id!, this);
+  }
+
+  /**
+   * 获取部件通用的事件参数
+   * @author lxm
+   * @date 2023-03-26 11:42:21
+   * @readonly
+   */
+  getEventArgs(): Omit<EventBase, 'eventName'> {
+    const result = super.getEventArgs();
+    return {
+      ...result,
+      data: this.getData() || [],
+      ctrl: this,
+    };
+  }
+
+  /**
+   * @description 获取是否静默参数的值
+   * @param {IParams} [args]
+   * @returns {*}  {boolean}
+   * @memberof ControlController
+   */
+  getSilent(args?: IParams): boolean {
+    return (
+      args?.silent ||
+      this.context.srfsilent === true ||
+      this.context.srfsilent === 'true'
+    );
+  }
+
+  protected initState(): void {
+    super.initState();
+    this.state.activated = true;
+    this.state.isLoading = false;
+    this.state.loadingText = '';
+    this.state.disabled = false;
+    this.state.maskOption = { mode: 'BLANK' };
+    this.state.zIndex = undefined;
+    this.state.isCounterDisabled = false;
+  }
+
+  protected async onCreated(): Promise<void> {
+    await super.onCreated();
+    // 填充部件加载提示文本
+    if (isNotNil(ibiz.config.view.loadingText)) {
+      this.state.loadingText = ibiz.config.view.loadingText;
+    }
+
+    // 部件布局面板
+    if (this.controlPanel) {
+      this.childNames.push(this.controlPanel.name!);
+      const provider = await getControlProvider(this.controlPanel);
+      this.providers[this.controlPanel.name!] = provider!;
+    }
+    // 部件逻辑初始化
+    this.initControlScheduler(this.model.controlLogics);
+
+    // 监听部件所有事件触发部件逻辑
+    if (this.scheduler?.hasControlEventTrigger) {
+      this._evt.onAll((eventName, event) => {
+        this.scheduler!.triggerControlEvent(
+          event.targetName,
+          event.eventName,
+          event,
+        );
+      });
+    }
+
+    // 初始化triggerKey
+    if (this.model.appDataEntityId) {
+      const codeName = calcDeCodeNameById(this.model.appDataEntityId);
+      this.triggerKey = `${(this.view as IData).name}@${codeName}@${this.model.controlType}@${this.model.codeName}`;
+    }
+
+    // 监听实体数据变更
+    if (this.controlParams.ignoremcmsg !== 'true') {
+      this.onDEDataChange = this.onDEDataChange.bind(this);
+      ibiz.mc.command.change.on(this.onDEDataChange);
+    }
+  }
+
+  protected async onMounted(): Promise<void> {
+    await super.onMounted();
+
+    // 启动定时器触发
+    this.scheduler?.startTimerTrigger();
+  }
+
+  protected async onDestroyed(): Promise<void> {
+    if (this.controlParams.ignoremcmsg !== 'true') {
+      ibiz.mc.command.change.off(this.onDEDataChange);
+    }
+    await super.onDestroyed();
+    if (this.scheduler) {
+      this.scheduler.destroy();
+    }
+    this.params.destroy();
+  }
+
+  /**
+   * 处理上下文和导航参数相关的，如自定义导航参数的处理
+   *
+   * @author lxm
+   * @date 2022-09-08 15:09:47
+   * @protected
+   */
+  updateContextParams(opts: { context?: IContext; params?: IParams }): void {
+    // 不改变引用的情况下，重置控制器里的上下文和视图参数。
+    if (opts.context) {
+      this.context.reset({}, opts.context);
+    }
+    if (opts.params) {
+      this.params.reset({}, opts.params);
+    }
+
+    const { controlNavContexts, controlNavParams } = this.model as IMDControl;
+    // 处理自定义导航上下文
+    let context = {};
+    if (notNilEmpty(controlNavContexts)) {
+      context = convertNavData(controlNavContexts!, this.params, this.context);
+    }
+    Object.assign(this.context, context);
+
+    // 处理自定义视图参数
+    let params = {};
+    if (notNilEmpty(controlNavParams)) {
+      params = convertNavData(controlNavParams!, this.params, this.context);
+    }
+    Object.assign(this.params, params);
+  }
+
+  /**
+   * 获取部件类型
+   * @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 {*}  {(IData[] | null)}
+   */
+  getData(): IData[] | null {
+    return null;
+  }
+
+  /**
+   * 开始加载
+   *
+   * @author chitanda
+   * @date 2022-09-21 15:09:18
+   * @return {*}  {Promise<void>}
+   */
+  async startLoading(loadingText?: string): Promise<void> {
+    this.state.isLoading = true;
+    if (isNotNil(loadingText)) {
+      this.state.loadingText = ibiz.appUtil.resolveI18nText(loadingText);
+    } else if (isNotNil(ibiz.config.view.loadingText)) {
+      this.state.loadingText = ibiz.config.view.loadingText;
+    } else {
+      this.state.loadingText = '';
+    }
+    this.ctx.startLoading(this.state.loadingText);
+  }
+
+  /**
+   * 加载完毕
+   *
+   * @author chitanda
+   * @date 2022-09-21 15:09:31
+   * @return {*}  {Promise<void>}
+   */
+  async endLoading(): Promise<void> {
+    this.state.isLoading = false;
+    this.ctx.endLoading();
+  }
+
+  /**
+   * 部件重新激活
+   *
+   * @author chitanda
+   * @date 2023-07-12 17:07:55
+   */
+  onActivated(): void {
+    this._evt.emit('onActivated', undefined);
+    this.state.activated = true;
+    // 执行等待激活执行的回调集合，执行完后清空
+    if (this.awaitActiveCbs.size > 0) {
+      this.awaitActiveCbs.forEach(cb => {
+        cb();
+      });
+    }
+    this.awaitActiveCbs.clear();
+    ibiz.log.debug(
+      ibiz.i18n.t('runtime.controller.common.control.componentActivation', {
+        name: this.model.name,
+        id: this.model.id,
+      }),
+    );
+  }
+
+  /**
+   * 部件暂时停用
+   *
+   * @author chitanda
+   * @date 2023-07-12 17:07:06
+   */
+  onDeactivated(): void {
+    this._evt.emit('onDeactivated', undefined);
+    this.state.activated = false;
+    ibiz.log.debug(
+      ibiz.i18n.t('runtime.controller.common.control.componentPause', {
+        name: this.model.name,
+        id: this.model.id,
+      }),
+    );
+  }
+
+  /**
+   * 处理数据能力方法通用参数，返回能力执行最终使用的参数
+   * @author lxm
+   * @date 2023-05-23 03:12:47
+   * @protected
+   * @param {IDataAbilityParams} [args]
+   * @return {*}
+   */
+  protected handlerAbilityParams(args?: IDataAbilityParams): {
+    context: IContext;
+    params: IParams;
+    data: IData[];
+  } {
+    const context = this.context.clone();
+    const params = { ...this.params };
+
+    let data = this.getData() || [];
+    if (args?.data) {
+      data = Array.isArray(args.data) ? args.data : [args.data];
+    }
+
+    // 合并附加上下文
+    if (args?.context) {
+      Object.assign(context, args.context);
+    }
+
+    // 合并附加视图参数
+    if (args?.viewParam) {
+      Object.assign(params, args.viewParam);
+    }
+    return { context, params, data };
+  }
+
+  /**
+   * 设置布局面板控制器
+   * @author lxm
+   * @date 2023-08-01 03:28:17
+   * @param {IViewLayoutPanelController} panel
+   */
+  setLayoutPanel(panel: IViewLayoutPanelController): void {
+    this.layoutPanel = panel;
+    if (this.layoutPanel.state.isMounted) {
+      this.mountCounter.attend(this.layoutPanel!.model.name!);
+    } else {
+      this.layoutPanel.evt.on('onMounted', () => {
+        this.mountCounter.attend(this.layoutPanel!.model.name!);
+      });
+    }
+  }
+
+  /**
+   * 部件参数解析
+   *
+   * @author zk
+   * @date 2023-09-27 07:09:08
+   * @protected
+   * @memberof ControlController
+   */
+  protected handleControlParams(): void {
+    if (!this.model.controlParam) {
+      return;
+    }
+    const { ctrlParams } = this.model.controlParam!;
+    let params = {};
+    if (notNilEmpty(ctrlParams)) {
+      params = convertNavData(ctrlParams!, this.params, this.context);
+    }
+    Object.assign(this.controlParams, params);
+  }
+
+  /**
+   * 初始化部件逻辑调度器
+   * @author lxm
+   * @date 2023-08-21 11:53:37
+   * @param {IControlLogic[]} logics
+   * @return {*}  {void}
+   */
+  protected initControlScheduler(logics: IControlLogic[] = []): void {
+    if (logics.length === 0) {
+      return;
+    }
+    this.scheduler = ibiz.scheduler.createControlScheduler(logics);
+    this.scheduler.defaultParamsCb = (): IUILogicParams => {
+      return this.getEventArgs();
+    };
+  }
+
+  /**
+   * 获取指定标识部件消息
+   *
+   * @author tony001
+   * @date 2024-05-29 17:05:52
+   * @protected
+   * @param {string} tag
+   * @return {*}  {(ICtrlMsgItem | undefined)}
+   */
+  protected findCtrlMsgByTag(tag: string): ICtrlMsgItem | undefined {
+    let targetCtrlMsg;
+    const { ctrlMsg } = this.model;
+    if (ctrlMsg && ctrlMsg.ctrlMsgItems) {
+      targetCtrlMsg = ctrlMsg.ctrlMsgItems.find(item => item.name === tag);
+    }
+    return targetCtrlMsg;
+  }
+
+  /**
+   * 执行对应部件行为消息提示
+   * @author lxm
+   * @date 2023-09-07 04:51:21
+   * @param {string} tag
+   * @param {({ default?: string; data?: IData | IData[]; error?: Error })} [opts]
+   * @return {*}  {void}
+   */
+  actionNotification(
+    tag: string,
+    opts?: { default?: string; data?: IData | IData[]; error?: Error },
+  ): void {
+    let message: string = '';
+    let duration: number | undefined;
+    const hiddenSsgItem = this.findCtrlMsgByTag(`${tag}_HIDDEN`);
+    if (hiddenSsgItem) {
+      return;
+    }
+    const msgItem = this.findCtrlMsgByTag(tag);
+    if (msgItem && msgItem.content) {
+      // 自定义部件消息提示
+      duration = isNil(msgItem.timeout) ? undefined : msgItem.timeout / 1000; // 单位转换为秒
+      const scriptParams: IParams = { ...this.getEventArgs() };
+      if (opts?.data) {
+        scriptParams.data = opts.data;
+      }
+      message = ScriptFactory.execScriptFn(
+        scriptParams,
+        `\`${msgItem.content}\``,
+        {
+          isAsync: false,
+          singleRowReturn: true,
+        },
+      ) as string;
+    }
+
+    if (!message && ibiz.i18n) {
+      // 全局多语言资源提示信息
+      const resTag = `CONTROL.${this.model.controlType}.${tag}`.toUpperCase();
+      message = ibiz.i18n.t(resTag, '');
+      // 多语言如果给出来是标识，说明没找到，消息改成空值
+      if (message === resTag) {
+        message = '';
+      }
+    }
+
+    // 都没有的时候如果给了默认输出信息，弹出默认输出信息
+    if (!message && opts?.default) {
+      message = opts.default;
+    }
+
+    // 如果报错有Message的时候给报错的信息
+    if (!message && opts?.error) {
+      message = message || opts.error.message;
+    }
+
+    // 如果默认信息也没有就不弹出信息
+    if (!message) {
+      return;
+    }
+
+    if (opts?.error) {
+      // 401和403的报错原样抛出
+      if (opts.error instanceof HttpError) {
+        if (opts.error.status !== 500) {
+          throw opts.error;
+        } else if (opts.error.status === 500) {
+          const { response } = opts.error;
+          if (response) {
+            const { data } = response;
+            if (data?.type === 'DataEntityRuntimeException') {
+              throw opts.error;
+            }
+          }
+        }
+      }
+      // 其他报错时抛错误信息
+      ibiz.log.error(opts.error);
+      throw new NoticeError(message, duration);
+    } else {
+      ibiz.message.success(message, duration, duration === 0);
+    }
+  }
+
+  /**
+   * 监听实体数据变更
+   *
+   * @author tony001
+   * @date 2024-03-28 18:03:33
+   * @protected
+   * @param {IPortalMessage} msg
+   */
+  protected onDEDataChange(msg: IPortalMessage): void {
+    ibiz.log.debug('onDEDataChange', msg);
+  }
+
+  /**
+   * 触发实体数据变更的通知
+   *
+   * @author tony001
+   * @date 2024-03-28 18:03:44
+   * @param {('create' | 'update' | 'remove')} type
+   * @param {IData} data
+   */
+  emitDEDataChange(type: 'create' | 'update' | 'remove', data: IData): void {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const msg = (data instanceof ControlVO ? data.$origin : data) as any;
+    const meta = { triggerKey: this.triggerKey };
+    switch (type) {
+      case 'create':
+        ibiz.mc.command.create.send(msg, meta);
+        break;
+      case 'update':
+        ibiz.mc.command.update.send(msg, meta);
+        break;
+      case 'remove':
+        ibiz.mc.command.remove.send(msg, meta);
+        break;
+      default:
+        throw new RuntimeError(
+          ibiz.i18n.t('runtime.controller.common.control.unsupportedType', {
+            type,
+          }),
+        );
+    }
+  }
+
+  /**
+   * 如果当前视图没有激活，则等待激活后执行回调函数
+   * - 在执行之前key相同的会替换
+   * 如果当前视图已经激活，则立即执行回调函数
+   * - delay参数指定延迟执行时间,可以防抖
+   *
+   * @author tony001
+   * @date 2024-03-28 18:03:00
+   * @param {() => void} cb
+   * @param {{ key: string; delay?: number }} opts
+   */
+  doNextActive(cb: () => void, opts: { key: string; delay?: number }): void {
+    if (isNil(opts.delay)) {
+      opts.delay = 300;
+    }
+    if (this.state.activated === false) {
+      this.awaitActiveCbs.set(opts.key, cb);
+    } else if (opts.delay) {
+      // 清除之前的延迟执行
+      const _timer = this.delayCbs.get(opts.key);
+      clearTimeout(_timer);
+      // 设置新的延迟执行
+      const timer = setTimeout(() => {
+        if (!this.ctx.isDestroyed) {
+          cb();
+        }
+        clearTimeout(this.delayCbs.get(opts.key));
+      }, opts.delay);
+      this.delayCbs.set(opts.key, timer);
+    } else if (!this.ctx.isDestroyed) {
+      cb();
+    }
+  }
+
+  /**
+   * @description 取消部件禁用
+   * @memberof ControlController
+   */
+  enable(): void {
+    this.state.disabled = false;
+    this.state.maskOption = { mode: 'BLANK' };
+  }
+
+  /**
+   * @description 设置部件禁用
+   * @param {IApiMaskOption} [options={ mode: 'BLANK' }]
+   * @memberof ControlController
+   */
+  disabled(options: IApiMaskOption = { mode: 'BLANK' }): void {
+    this.state.disabled = true;
+    if (options.maskInfo) {
+      options.maskInfo = StringUtil.fill(
+        options.maskInfo,
+        this.context,
+        this.params,
+      );
+    }
+    this.state.maskOption = options;
+  }
+
+  /**
+   * @description 禁用部件计数器
+   * @memberof ControlController
+   */
+  disableCounter(): void {
+    this.state.isCounterDisabled = true;
+  }
+}

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

@@ -0,0 +1,2 @@
+export { ControlController } from './control.controller';
+export { MDControlController } from './md-control.controller';