@ibiz-template/runtime 0.6.1-dev.0 → 0.6.1-dev.1

package/src/controller/common/base.controller.ts

@@ -1,269 +0,0 @@
-import { IModelObject } from '@ibiz/model-core';
-import { createUUID } from 'qx-util';
-import { CTX } from '../ctx';
-import {
-  EventBase,
-  IComponentEvent,
-  IController,
-  IViewController,
-} from '../../interface/controller';
-import { IControllerState } from '../../interface';
-import { ActivityCounter, ControllerEvent } from '../utils';
-
-const SELF_KEY = '__self';
-
-/**
- * 控制器基类
- * @author lxm
- * @date 2023-04-25 11:00:31
- * @export
- * @class BaseController
- */
-export class BaseController<
-  T extends IModelObject = IModelObject,
-  S extends IControllerState = IControllerState,
-  E extends IComponentEvent = IComponentEvent,
-> implements IController<T, S, E>
-{
-  id: string = createUUID();
-
-  /**
-   * 中间层的基类才会使用，用于在内部使用自身的事件，事件类型不是泛型用evt就能正确推导出来。
-   * @author lxm
-   * @date 2023-05-18 02:48:57
-   * @readonly
-   * @protected
-   */
-  protected get _evt(): ControllerEvent<IComponentEvent> {
-    return this.evt;
-  }
-
-  state: S = {} as S;
-
-  /**
-   * 控制器名称，作为检索控制器的唯一标识
-   * @author lxm
-   * @date 2023-04-26 08:22:30
-   * @type {string}
-   */
-  name: string = '';
-
-  /**
-   * Creates an instance of BaseController.
-   * @author lxm
-   * @date 2023-04-26 06:46:21
-   * @param {CTX} ctx 跨组件上下文环境，内部机制不暴露
-   */
-  constructor(
-    public readonly model: T,
-    public readonly context: IContext,
-    public readonly params: IParams,
-    protected readonly ctx: CTX,
-  ) {
-    this.name = model.name || model.id!;
-    this.initState();
-    this.convertMultipleLanguages();
-  }
-
-  /**
-   * 初始化state的属性放，一般情况下只需要把对应的默认值直接赋值给state
-   * 如果需要构造特殊class类型的state,可以重写该方法时，
-   * 一开就new一个state替换当前的state,然后调用super初始化默认值
-   * @author lxm
-   * @date 2023-05-18 02:57:00
-   * @protected
-   */
-  protected initState(): void {
-    this.state.isCreated = false;
-    this.state.isMounted = false;
-    this.state.isDestroyed = false;
-  }
-
-  /**
-   * 获取事件的基础参数
-   * @author lxm
-   * @date 2023-04-25 11:03:44
-   * @return {*}  {Omit<EventBase, 'eventName'>}
-   */
-  protected getEventArgs(): Omit<EventBase, 'eventName'> {
-    return {
-      context: this.context,
-      params: this.params,
-      data: [],
-      targetName: this.model.name!,
-      view: this.ctx.view,
-    };
-  }
-
-  /**
-   * 事件触发器
-   * @author lxm
-   * @date 2023-04-25 09:36:31
-   * @type {ControllerEvent}
-   */
-  evt: ControllerEvent<E> = new ControllerEvent<E>(
-    this.getEventArgs.bind(this),
-  );
-
-  /**
-   * 计算父子加载顺序的计数器
-   * @author lxm
-   * @date 2023-04-26 06:14:22
-   * @type {ActivityCounter}
-   */
-  mountCounter: ActivityCounter = new ActivityCounter(this.mounted.bind(this));
-
-  /**
-   * 子组件的名称，会监听指定子组件的生命周期，影响自身的声明周期。
-   * @author lxm
-   * @date 2023-04-26 08:10:57
-   * @type {string[]}
-   */
-  childNames: string[] = [];
-
-  /**
-   * 生命周期-创建完成，不推荐子类实现
-   * @author lxm
-   * @date 2023-04-25 11:08:54
-   */
-  async created(): Promise<void> {
-    // 登记自身
-    this.mountCounter.enroll(SELF_KEY);
-    await this.onCreated();
-    this.state.isCreated = true;
-    this.force(() => {
-      this.mountSelf();
-    });
-    ibiz.log.debug(`${this.constructor.name}:${this.name} onCreated`);
-    this._evt.emit('onCreated', undefined);
-  }
-
-  /**
-   * 生命周期-创建完成，实际执行逻辑，子类重写用这个
-   * @author lxm
-   * @date 2023-04-25 11:12:02
-   */
-  protected async onCreated(): Promise<void> {
-    // 监听预告，提前让计数器等待将要绘制的子组件
-    this.ctx.evt.on('onForecast', name => {
-      if (this.childNames.includes(name)) {
-        this.mountCounter.enroll(name);
-      }
-    });
-    // 监听指定子组件的注册和加载声明周期，操作计数器，使父组件mounted在子组件都mounted之后
-    this.ctx.evt.on('onRegister', (name, c) => {
-      if (this.childNames.includes(name)) {
-        c.evt.on('onMounted', () => {
-          this.mountCounter.attend(name);
-        });
-      }
-    });
-  }
-
-  /**
-   * 自身挂载方法，默认是设置自身已经挂载的状态，用于计数器计算。
-   * 异步方法，可以把异步初始化放这里，执行完后调基类的mountSelf，mounted声明周期就可以在异步之后触发
-   * @author lxm
-   * @date 2023-04-27 03:34:35
-   */
-  protected async mountSelf(): Promise<void> {
-    const isSelfMounted = this.mountCounter.registration.get(SELF_KEY);
-    if (!isSelfMounted) {
-      this.mountCounter.attend(SELF_KEY);
-    }
-  }
-
-  /**
-   * 生命周期-加载完成，不推荐子类实现
-   * 外部不允许调用，只能被mountCounter触发，保证mounted时机正确，外部调用mountSelf
-   *
-   * @author lxm
-   * @date 2023-04-25 11:08:54
-   */
-  protected async mounted(): Promise<void> {
-    await this.onMounted();
-    this.state.isMounted = true;
-    ibiz.log.debug(`${this.constructor.name}:${this.name} onMounted`);
-    this._evt.emit('onMounted', undefined);
-  }
-
-  /**
-   * 生命周期-加载完成，实际执行逻辑，子类重写用这个
-   * 放置等自身后需要等待的子组件都加载完成后才会执行的逻辑。
-   * @author lxm
-   * @date 2023-04-25 11:12:02
-   */
-  protected async onMounted(): Promise<void> {
-    // 子类重写
-  }
-
-  /**
-   * 生命周期-销毁完成，不推荐子类实现
-   * @author lxm
-   * @date 2023-04-25 11:08:54
-   */
-  async destroyed(): Promise<void> {
-    await this.onDestroyed();
-    this.state.isDestroyed = true;
-    ibiz.log.debug(`${this.constructor.name}:${this.name} onDestroyed`);
-    await this._evt.emit('onDestroyed', undefined);
-    this.evt.destroy();
-  }
-
-  /**
-   * 生命周期-销毁完成，实际执行逻辑，子类重写用这个
-   * @author lxm
-   * @date 2023-04-25 11:12:02
-   */
-  protected async onDestroyed(): Promise<void> {
-    // 子类重写
-  }
-
-  /**
-   * 强制更新视图（框架级）
-   *
-   * @author chitanda
-   * @param {() => void} [callback] 更新之后，组件渲染完成后的回调
-   * @date 2022-07-24 14:07:38
-   */
-  force(_callback?: () => void): void {
-    // 在界面数据发生变更时，会调用此方法。
-    // 可外部覆盖实例的此方法，实现自定义的数据更新逻辑。
-  }
-
-  /**
-   * 获取指定名称的控制器
-   * @author lxm
-   * @date 2023-04-25 10:14:42
-   * @param {string} name
-   * @param {boolean} [traceRoot=false] 是否跨越视图作用域，一路向根上找。
-   * @return {*}  {(BaseController | undefined)}
-   */
-  getController(name: string, traceRoot = false): IController | undefined {
-    return this.ctx.getController(name, traceRoot);
-  }
-
-  getTopView(): IViewController {
-    return this.ctx.getTopView();
-  }
-
-  /**
-   * 当前视图上下文内有新的控制产生时触发回调。
-   * @author lxm
-   * @date 2023-04-26 07:59:41
-   * @param {(name: string, c: IController) => void} cb
-   */
-  listenNewController(cb: (name: string, c: IController) => void): void {
-    this.ctx.evt.on('onRegister', cb);
-  }
-
-  /**
-   * 转换各类多语言
-   *
-   * @date 2023-05-18 02:57:00
-   * @protected
-   */
-  protected convertMultipleLanguages(): void {
-    // 子类重写
-  }
-}

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

@@ -1,446 +0,0 @@
-import {
-  IControl,
-  IControlLogic,
-  IMDControl,
-  IViewLayoutPanel,
-} from '@ibiz/model-core';
-import { IBizContext, IBizParams, NoticeError } from '@ibiz-template/core';
-import { clone, isNil } from 'ramda';
-import { notNilEmpty } from 'qx-util';
-import { BaseController } from '..';
-import { CTX } from '../../ctx';
-import {
-  EventBase,
-  IControlController,
-  IControlEvent,
-  IControlState,
-  IViewController,
-  IViewLayoutPanelController,
-} from '../../../interface/controller';
-import { ControllerEvent } from '../../utils';
-import {
-  IDataAbilityParams,
-  IProvider,
-  IUILogicParams,
-} from '../../../interface';
-import { ControlLogicScheduler } from '../../../logic-scheduler';
-import { getControlProvider } from '../../../register';
-import { convertNavData, ScriptFactory } from '../../../utils';
-import { getControlPanel } from '../../../model';
-
-/**
- * 部件控制器
- *
- * @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;
-  }
-
-  /**
-   * 部件逻辑调度器
-   * @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;
-
-  /**
-   * 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.controlPanel = getControlPanel(model);
-    if (!this.controlPanel) {
-      const panelModel = ibiz.util.layoutPanel.get(
-        `${model.controlType}_DEFAULT`,
-      );
-      if (panelModel) {
-        this.controlPanel = clone(panelModel);
-      }
-    }
-
-    this.updateContextParams({});
-  }
-
-  /**
-   * 往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
-   */
-  protected getEventArgs(): Omit<EventBase, 'eventName'> {
-    const result = super.getEventArgs();
-    return {
-      ...result,
-      data: this.getData() || [],
-      ctrl: this,
-    };
-  }
-
-  protected initState(): void {
-    super.initState();
-    this.state.activated = true;
-    this.state.isLoading = false;
-  }
-
-  protected async onCreated(): Promise<void> {
-    await super.onCreated();
-
-    // 部件布局面板
-    if (this.controlPanel) {
-      this.childNames.push(this.controlPanel.name!);
-      const provider = await getControlProvider(this.controlPanel);
-      this.providers[this.controlPanel.name!] = provider!;
-    }
-    // 处理上下文和导航参数
-    this.handleControlParams();
-    // 部件逻辑初始化
-    this.initControlScheduler(this.model.controlLogics);
-
-    // 监听部件所有事件触发部件逻辑
-    if (this.scheduler?.hasControlEventTrigger) {
-      this._evt.onAll((eventName, event) => {
-        this.scheduler!.triggerControlEvent(
-          event.targetName,
-          event.eventName,
-          event,
-        );
-      });
-    }
-  }
-
-  protected async onMounted(): Promise<void> {
-    await super.onMounted();
-
-    // 启动定时器触发
-    this.scheduler?.startTimerTrigger();
-  }
-
-  protected async onDestroyed(): Promise<void> {
-    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(): Promise<void> {
-    this.state.isLoading = true;
-    this.ctx.startLoading();
-  }
-
-  /**
-   * 加载完毕
-   *
-   * @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.state.activated = true;
-    ibiz.log.debug(`视图[${this.model.name}](${this.model.id})激活`);
-  }
-
-  /**
-   * 部件暂时停用
-   *
-   * @author chitanda
-   * @date 2023-07-12 17:07:06
-   */
-  onDeactivated(): void {
-    this.state.activated = false;
-    ibiz.log.debug(`视图[${this.model.name}](${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 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 {
-    const { ctrlMsg } = this.model;
-    const msgItem = ctrlMsg?.ctrlMsgItems?.find(item => item.name === tag);
-    let message: string;
-    let duration: number | undefined;
-    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;
-    } else {
-      // 全局多语言资源提示信息
-      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) {
-      ibiz.log.error(opts.error);
-      // 报错时抛错误
-      throw new NoticeError(message, duration);
-    } else {
-      ibiz.message.success(message, duration, duration === 0);
-    }
-  }
-}

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

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