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

package/src/logic-scheduler/index.ts

@@ -0,0 +1,99 @@
+import { LogicExecutor } from './executor/logic-executor';
+import { LogicExecutorFactory } from './executor/logic-executor-factory';
+import { ScriptExecutor } from './executor/script-executor';
+import { AppDEUILogicExecutor } from './executor/app-de-ui-logic-executor';
+import { LogicSchedulerCenter } from './logic-scheduler-center';
+import { ControlLogicScheduler } from './scheduler/control-logic-scheduler';
+import { ViewLogicScheduler } from './scheduler/view-logic-scheduler';
+import { CustomTrigger } from './trigger/custom-trigger';
+import { ItemDynaLogicTrigger } from './trigger/item-dyna-logic-trigger';
+import { LogicTrigger } from './trigger/logic-trigger';
+import { LogicTriggerFactory } from './trigger/logic-trigger-factory';
+import { TimerTrigger } from './trigger/timer-trigger';
+import { AppUILogicExecutor } from './executor/app-ui-logic-executor';
+import { ViewEventTrigger } from './trigger/view-event-trigger';
+import { ControlEventTrigger } from './trigger/control-event-trigger';
+import { AppDEUIActionExecutor } from './executor/app-ui-action-executor';
+
+export {
+  LogicSchedulerCenter,
+  ViewLogicScheduler,
+  ControlLogicScheduler,
+  ItemDynaLogicTrigger,
+  TimerTrigger,
+  LogicTriggerFactory,
+  LogicTrigger,
+  LogicExecutorFactory,
+  LogicExecutor,
+  ScriptExecutor,
+  AppDEUILogicExecutor,
+};
+
+export function installLogicSchedule(): void {
+  ibiz.scheduler = new LogicSchedulerCenter();
+  // 触发器
+  ibiz.scheduler.triggerFactory.register(
+    'ITEMVISIBLE',
+    (logic, scheduler, scriptArgKeys) =>
+      new ItemDynaLogicTrigger(logic, scheduler, scriptArgKeys),
+  );
+  ibiz.scheduler.triggerFactory.register(
+    'ITEMENABLE',
+    (logic, scheduler, scriptArgKeys) =>
+      new ItemDynaLogicTrigger(logic, scheduler, scriptArgKeys),
+  );
+  ibiz.scheduler.triggerFactory.register(
+    'ITEMBLANK',
+    (logic, scheduler, scriptArgKeys) =>
+      new ItemDynaLogicTrigger(logic, scheduler, scriptArgKeys),
+  );
+  ibiz.scheduler.triggerFactory.register(
+    'TIMER',
+    (logic, scheduler, scriptArgKeys) =>
+      new TimerTrigger(logic, scheduler, scriptArgKeys),
+  );
+  ibiz.scheduler.triggerFactory.register(
+    'CUSTOM',
+    (logic, scheduler, scriptArgKeys) =>
+      new CustomTrigger(logic, scheduler, scriptArgKeys),
+  );
+  ibiz.scheduler.triggerFactory.register(
+    'VIEWEVENT',
+    (logic, scheduler, scriptArgKeys) =>
+      new ViewEventTrigger(logic, scheduler, scriptArgKeys),
+  );
+  ibiz.scheduler.triggerFactory.register(
+    'CTRLEVENT',
+    (logic, scheduler, scriptArgKeys) =>
+      new ControlEventTrigger(logic, scheduler, scriptArgKeys),
+  );
+
+  // 执行器
+  // 脚本
+  ibiz.scheduler.executorFactory.register(
+    'SCRIPT',
+    (logic, scheduler) => new ScriptExecutor(logic, scheduler),
+  );
+
+  // 实体逻辑
+  ibiz.scheduler.executorFactory.register(
+    'APPDEUILOGIC',
+    (logic, scheduler) => new AppDEUILogicExecutor(logic, scheduler),
+  );
+  ibiz.scheduler.executorFactory.register(
+    'DEUILOGIC',
+    (logic, scheduler) => new AppDEUILogicExecutor(logic, scheduler),
+  );
+
+  // 界面逻辑
+  ibiz.scheduler.executorFactory.register(
+    'APPUILOGIC',
+    (logic, scheduler) => new AppUILogicExecutor(logic, scheduler),
+  );
+
+  // 界面行为
+  ibiz.scheduler.executorFactory.register(
+    'APPDEUIACTION',
+    (logic, scheduler) => new AppDEUIActionExecutor(logic, scheduler),
+  );
+}

package/src/logic-scheduler/logic-scheduler-center.ts

@@ -0,0 +1,58 @@
+import { IAppDEViewLogic, IControlLogic } from '@ibiz/model-core';
+import { LogicExecutorFactory } from './executor/logic-executor-factory';
+import { ControlLogicScheduler } from './scheduler/control-logic-scheduler';
+import { ViewLogicScheduler } from './scheduler/view-logic-scheduler';
+import { LogicTriggerFactory } from './trigger/logic-trigger-factory';
+
+/**
+ * 调度器中心
+ * @author lxm
+ * @date 2023-06-25 03:30:21
+ * @export
+ * @class LogicSchedulerFactory
+ */
+export class LogicSchedulerCenter {
+  /**
+   * 执行器工厂
+   * @author lxm
+   * @date 2023-06-25 06:41:42
+   * @type {LogicExecutorFactory}
+   */
+  executorFactory: LogicExecutorFactory = new LogicExecutorFactory();
+
+  /**
+   * 触发器工厂
+   * @author lxm
+   * @date 2023-06-25 06:44:12
+   * @type {LogicTriggerFactory}
+   */
+  triggerFactory: LogicTriggerFactory = new LogicTriggerFactory();
+
+  /**
+   * @description 创建视图逻辑调度器实例
+   * @param {IAppDEViewLogic[]} logics
+   * @param {string[]} [scriptArgKeys=[]]
+   * @returns {*}  {ViewLogicScheduler}
+   * @memberof LogicSchedulerCenter
+   */
+  createViewScheduler(
+    logics: IAppDEViewLogic[],
+    scriptArgKeys: string[] = [],
+  ): ViewLogicScheduler {
+    return new ViewLogicScheduler(logics, scriptArgKeys);
+  }
+
+  /**
+   * @description 创建部件逻辑调度器实例
+   * @param {IControlLogic[]} logics
+   * @param {string[]} [scriptArgKeys=[]]
+   * @returns {*}  {ControlLogicScheduler}
+   * @memberof LogicSchedulerCenter
+   */
+  createControlScheduler(
+    logics: IControlLogic[],
+    scriptArgKeys: string[] = [],
+  ): ControlLogicScheduler {
+    return new ControlLogicScheduler(logics, scriptArgKeys);
+  }
+}

package/src/logic-scheduler/scheduler/control-logic-scheduler.ts

@@ -0,0 +1,27 @@
+import { IControlLogic } from '@ibiz/model-core';
+import type { ISchedulerLogic } from '../../interface';
+import { LogicScheduler } from './logic-scheduler';
+
+/**
+ * 部件逻辑调度器实例类
+ * @author lxm
+ * @date 2023-06-25 03:36:32
+ * @export
+ * @class ViewLogicScheduler
+ * @extends {LogicScheduler}
+ */
+export class ControlLogicScheduler extends LogicScheduler {
+  constructor(logics: IControlLogic[], scriptArgKeys: string[] = []) {
+    // 部件逻辑把APPVIEWENGINE排除掉。
+    const filterLogics = logics.filter(
+      item => item.triggerType !== 'APPVIEWENGINE',
+    );
+    filterLogics.forEach(logic => {
+      // 部件事件的部件名称在itemName上，当itemName没有时说明是部件自身触发此时名称在logicTag上，统一写到ctrlName,与视图逻辑保持一致。
+      if (logic.triggerType === 'CTRLEVENT') {
+        (logic as IData).ctrlName = logic.itemName || logic.logicTag;
+      }
+    });
+    super(filterLogics as ISchedulerLogic[], scriptArgKeys);
+  }
+}

package/src/logic-scheduler/scheduler/logic-scheduler.ts

@@ -0,0 +1,299 @@
+import { mergeLeft } from 'ramda';
+import type {
+  IUILogicParams,
+  ISchedulerLogic,
+  ITriggerMatchParams,
+} from '../../interface';
+import { LogicExecutor } from '../executor/logic-executor';
+import { LogicTrigger } from '../trigger/logic-trigger';
+import { TimerTrigger } from '../trigger/timer-trigger';
+
+/**
+ * 逻辑调度器实例类
+ * @author lxm
+ * @date 2023-06-25 03:35:46
+ * @export
+ * @class LogicScheduler
+ */
+export class LogicScheduler {
+  logics: ISchedulerLogic[];
+
+  triggers = new Map<string, LogicTrigger>();
+
+  executors = new Map<string, LogicExecutor>();
+
+  /**
+   * 是否有视图事件触发类型逻辑
+   * @author lxm
+   * @date 2023-08-14 02:19:51
+   * @type {boolean}
+   */
+  hasViewEventTrigger: boolean = false;
+
+  /**
+   * 是否有部件事件触发类型逻辑
+   * @author lxm
+   * @date 2023-08-14 02:19:51
+   * @type {boolean}
+   */
+  hasControlEventTrigger: boolean = false;
+
+  /**
+   * @description 是否销毁
+   * @type {boolean}
+   * @memberof LogicScheduler
+   */
+  isDestroyed: boolean = false;
+
+  constructor(logics: ISchedulerLogic[], scriptArgKeys: string[] = []) {
+    this.logics = logics;
+    logics.forEach(logic => {
+      try {
+        const executor = this.createExecutor(logic);
+        this.executors.set(logic.id, executor);
+        const trigger = this.createTrigger(logic, scriptArgKeys);
+        this.triggers.set(logic.id, trigger);
+        trigger.bindExecutor(executor);
+      } catch (error) {
+        if ((logic.logicType as string) === 'CUSTOM') {
+          ibiz.log.warn((error as IData).message);
+        } else {
+          ibiz.log.error((error as IData).message);
+        }
+      }
+    });
+  }
+
+  /**
+   * 销毁方法
+   * @author lxm
+   * @date 2023-07-17 11:47:51
+   */
+  destroy(): void {
+    this.triggers.forEach(trigger => trigger.destroy());
+    this.executors.forEach(executor => executor.destroy());
+    this.isDestroyed = true;
+  }
+
+  /**
+   * 默认参数回调
+   * @author lxm
+   * @date 2023-06-25 08:25:51
+   */
+  defaultParamsCb?: () => IUILogicParams;
+
+  /**
+   * 获取执行参数,把默认参数和调用参数合并
+   * @author lxm
+   * @date 2023-06-25 08:28:34
+   * @param {IData} args
+   * @return {*}
+   */
+  getExecuteParams(executeParams: Partial<IUILogicParams>): IUILogicParams {
+    let defaultParams = {};
+    if (this.defaultParamsCb) {
+      defaultParams = this.defaultParamsCb();
+    }
+    return mergeLeft(executeParams, defaultParams) as IUILogicParams;
+  }
+
+  /**
+   * 创建触发器实例
+   * @author lxm
+   * @date 2023-06-26 02:33:35
+   * @protected
+   * @param {ISchedulerLogic} logic
+   * @return {*}  {LogicTrigger}
+   */
+  protected createTrigger(
+    logic: ISchedulerLogic,
+    scriptArgKeys: string[] = [],
+  ): LogicTrigger {
+    switch (logic.triggerType) {
+      case 'VIEWEVENT':
+        this.hasViewEventTrigger = true;
+        break;
+      case 'CTRLEVENT':
+        this.hasControlEventTrigger = true;
+        break;
+      default:
+    }
+    return ibiz.scheduler.triggerFactory.createTrigger(
+      logic,
+      this,
+      scriptArgKeys,
+    );
+  }
+
+  /**
+   * 创建执行器实例
+   * @author lxm
+   * @date 2023-06-26 02:33:52
+   * @protected
+   * @param {ISchedulerLogic} logic
+   * @return {*}  {LogicExecutor}
+   */
+  protected createExecutor(logic: ISchedulerLogic): LogicExecutor {
+    return ibiz.scheduler.executorFactory.createExecutor(logic, this);
+  }
+
+  /**
+   * 获取匹配的触发器。
+   * @author lxm
+   * @date 2023-06-26 02:32:24
+   * @param {ITriggerMatchParams} matchParams
+   * @return {*}  {LogicTrigger[]}
+   */
+  protected getMatchTriggers(matchParams: ITriggerMatchParams): LogicTrigger[] {
+    const triggers: LogicTrigger[] = [];
+    this.triggers.forEach(trigger => {
+      if (trigger.match(matchParams)) {
+        triggers.push(trigger);
+      }
+    });
+    return triggers;
+  }
+
+  /**
+   * 找到匹配的触发器并执行对应的执行器，并返回结果。
+   * 返回undefined表示没有匹配的触发器。
+   * @author lxm
+   * @date 2023-06-26 02:30:24
+   * @param {ITriggerMatchParams} matchParams 匹配参数
+   * @param {Partial<IUILogicParams>} [executeParams={}] 执行参数
+   * @return {*}  {(any[] | undefined)}
+   */
+  triggerAndExecute(
+    matchParams: ITriggerMatchParams,
+    executeParams: Partial<IUILogicParams> = {},
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ): any[] | undefined {
+    if (this.isDestroyed) {
+      return;
+    }
+    const triggers = this.getMatchTriggers(matchParams);
+    if (triggers.length > 0) {
+      const params = this.getExecuteParams(executeParams);
+      const result = triggers.map(trigger => {
+        return trigger.execute(params);
+      });
+      return result;
+    }
+  }
+
+  /**
+   * 预定义项的动态逻辑
+   * @author lxm
+   * @date 2023-06-26 02:29:08
+   * @protected
+   * @param {string} itemName 子项名称
+   * @param {('ITEMVISIBLE' | 'ITEMENABLE' | 'ITEMBLANK')} triggerType 预定义逻辑类型
+   * @param {Partial<IUILogicParams>} executeParams 执行参数
+   * @return {*}  {(boolean | undefined)}
+   */
+  protected triggerItemDynaLogic(
+    itemName: string,
+    triggerType: 'ITEMVISIBLE' | 'ITEMENABLE' | 'ITEMBLANK',
+    executeParams: Partial<IUILogicParams>,
+  ): boolean | undefined {
+    const matchParams = { itemName, triggerType };
+    const result = this.triggerAndExecute(matchParams, executeParams);
+    if (result?.length) {
+      return result.pop();
+    }
+  }
+
+  /**
+   * 预定义项显示逻辑
+   * @author lxm
+   * @date 2023-06-26 02:26:36
+   * @param {string} itemName 子项名称
+   * @param {Partial<IUILogicParams>} executeParams 执行参数
+   * @return {*}  {(boolean | undefined)}
+   */
+  triggerItemVisible(
+    itemName: string,
+    executeParams: Partial<IUILogicParams>,
+  ): boolean | undefined {
+    return this.triggerItemDynaLogic(itemName, 'ITEMVISIBLE', executeParams);
+  }
+
+  /**
+   * 预定义项启用逻辑
+   * @author lxm
+   * @date 2023-06-26 02:26:35
+   * @param {string} itemName 子项名称
+   * @param {Partial<IUILogicParams>} executeParams 执行参数
+   * @return {*}  {(boolean | undefined)}
+   */
+  triggerItemEnable(
+    itemName: string,
+    executeParams: Partial<IUILogicParams>,
+  ): boolean | undefined {
+    return this.triggerItemDynaLogic(itemName, 'ITEMENABLE', executeParams);
+  }
+
+  /**
+   * 预定义项空输入逻辑
+   * @author lxm
+   * @date 2023-06-26 02:26:33
+   * @param {string} itemName 子项名称
+   * @param {Partial<IUILogicParams>} executeParams 执行参数
+   * @return {*}  {(boolean | undefined)}
+   */
+  triggerItemBlank(
+    itemName: string,
+    executeParams: Partial<IUILogicParams>,
+  ): boolean | undefined {
+    return this.triggerItemDynaLogic(itemName, 'ITEMBLANK', executeParams);
+  }
+
+  /**
+   * 定时器触发开始启用并计时
+   * @author lxm
+   * @date 2023-07-17 01:49:14
+   */
+  startTimerTrigger(): void {
+    const triggers = this.getMatchTriggers({ triggerType: 'TIMER' });
+    triggers.forEach(trigger => (trigger as TimerTrigger).start());
+  }
+
+  /**
+   * 执行自定义触发逻辑类型的视图逻辑
+   * @author lxm
+   * @date 2023-07-17 07:44:12
+   * @param {string} id
+   * @param {Partial<IUILogicParams>} executeParams
+   * @return {*}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  triggerCustom(id: string, executeParams: Partial<IUILogicParams>): any {
+    const trigger = this.triggers.get(id);
+    if (!trigger) {
+      return -1;
+    }
+    const params = this.getExecuteParams(executeParams);
+    return trigger.execute(params);
+  }
+
+  /**
+   * 触发部件事件
+   * @author lxm
+   * @date 2023-06-26 02:26:33
+   * @param {string} itemName 子项名称
+   * @param {Partial<IUILogicParams>} executeParams 执行参数
+   * @return {*}  {(boolean | undefined)}
+   */
+  triggerControlEvent(
+    ctrlName: string,
+    eventName: string,
+    executeParams?: Partial<IUILogicParams>,
+  ): void {
+    const matchParams = {
+      ctrlName,
+      eventName,
+      triggerType: 'CTRLEVENT',
+    } as const;
+    this.triggerAndExecute(matchParams, executeParams);
+  }
+}

package/src/logic-scheduler/scheduler/view-logic-scheduler.ts

@@ -0,0 +1,37 @@
+import { IAppDEViewLogic } from '@ibiz/model-core';
+import type { EventBase, ISchedulerLogic } from '../../interface';
+import { LogicScheduler } from './logic-scheduler';
+
+/**
+ * 视图逻辑调度器实例类
+ * @author lxm
+ * @date 2023-06-25 03:36:32
+ * @export
+ * @class ViewLogicScheduler
+ * @extends {LogicScheduler}
+ */
+export class ViewLogicScheduler extends LogicScheduler {
+  constructor(logics: IAppDEViewLogic[], scriptArgKeys: string[] = []) {
+    logics.forEach(logic => {
+      // 视图逻辑的触发类型logicTrigger统一成triggerType
+      (logic as IData).triggerType = logic.logicTrigger!;
+    });
+    super(logics as IData[] as ISchedulerLogic[], scriptArgKeys);
+  }
+
+  /**
+   * 触发视图事件
+   * @author lxm
+   * @date 2023-06-26 02:26:33
+   * @param {string} itemName 子项名称
+   * @param {Partial<IUILogicParams>} executeParams 执行参数
+   * @return {*}  {(boolean | undefined)}
+   */
+  triggerViewEvent(event: EventBase): void {
+    const matchParams = {
+      eventName: event.eventName,
+      triggerType: 'VIEWEVENT',
+    } as const;
+    this.triggerAndExecute(matchParams, event);
+  }
+}

package/src/logic-scheduler/trigger/control-event-trigger.ts

@@ -0,0 +1,48 @@
+import { StudioControlEvents } from '../../constant';
+import type { ISchedulerLogic, ITriggerMatchParams } from '../../interface';
+import { LogicScheduler } from '../scheduler/logic-scheduler';
+import { LogicTrigger } from './logic-trigger';
+
+/**
+ * 部件事件触发器
+ * @author lxm
+ * @date 2023-08-14 02:10:46
+ * @export
+ * @class ControlEventTrigger
+ * @extends {LogicTrigger}
+ */
+export class ControlEventTrigger extends LogicTrigger {
+  declare type: 'CTRLEVENT';
+
+  /**
+   * 监听事件名称集合
+   * @author lxm
+   * @date 2023-07-26 05:48:30
+   * @protected
+   * @type {string[]}
+   */
+  protected listenEventNames: string[] = [];
+
+  constructor(
+    protected logic: ISchedulerLogic,
+    protected scheduler: LogicScheduler,
+    protected scriptArgKeys: string[] = [],
+  ) {
+    super(logic, scheduler, scriptArgKeys);
+    const names = logic.eventNames!.split(';');
+    this.listenEventNames = names.map(
+      name => StudioControlEvents[name as keyof StudioControlEvents] || name,
+    );
+  }
+
+  match(matchParams: ITriggerMatchParams): boolean {
+    const superResult = super.match(matchParams);
+    return (
+      superResult &&
+      // 忽略大小写匹配
+      matchParams.ctrlName?.toLowerCase() ===
+        this.logic.ctrlName!.toLowerCase() &&
+      this.listenEventNames.includes(matchParams.eventName!)
+    );
+  }
+}

package/src/logic-scheduler/trigger/custom-trigger.ts

@@ -0,0 +1,13 @@
+import { LogicTrigger } from './logic-trigger';
+
+/**
+ * 自定义触发
+ * @author lxm
+ * @date 2023-07-17 12:53:35
+ * @export
+ * @class CustomTrigger
+ * @extends {LogicTrigger}
+ */
+export class CustomTrigger extends LogicTrigger {
+  declare type: 'CUSTOM';
+}

package/src/logic-scheduler/trigger/item-dyna-logic-trigger.ts

@@ -0,0 +1,55 @@
+import { RuntimeError } from '@ibiz-template/core';
+import type { ITriggerMatchParams, IUILogicParams } from '../../interface';
+import { LogicExecutor } from '../executor/logic-executor';
+import { ScriptExecutor } from '../executor/script-executor';
+import { LogicTrigger } from './logic-trigger';
+
+export class ItemDynaLogicTrigger extends LogicTrigger {
+  declare type: 'ITEMVISIBLE' | 'ITEMENABLE' | 'ITEMBLANK';
+
+  declare executor: ScriptExecutor;
+
+  bindExecutor(executor: LogicExecutor): void {
+    super.bindExecutor(executor);
+    if (this.executor.type !== 'SCRIPT') {
+      throw new RuntimeError(
+        ibiz.i18n.t('runtime.logicScheduler.trigger.triggerType'),
+      );
+    }
+  }
+
+  bindScriptExecutor(executor: ScriptExecutor): void {
+    executor.init(
+      ['context', 'viewparams', 'data', 'env', 'view', 'ctrl'],
+      executeParams => {
+        const { context, params, data, view, ctrl } = executeParams;
+        return {
+          context,
+          params,
+          data: data?.[0] || {},
+          env: ibiz.env,
+          view,
+          ctrl,
+        };
+      },
+      {
+        singleRowReturn: true,
+        isAsync: false,
+      },
+    );
+  }
+
+  match(matchParams: ITriggerMatchParams): boolean {
+    const superResult = super.match(matchParams);
+    return (
+      superResult &&
+      // 忽略大小写匹配
+      matchParams.itemName?.toLowerCase() === this.logic.itemName?.toLowerCase()
+    );
+  }
+
+  execute(executeParams: IUILogicParams): boolean {
+    const result = this.executor.execute(executeParams);
+    return !!result;
+  }
+}