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

package/src/controller/utils/counter/counter.ts

@@ -0,0 +1,99 @@
+import { RuntimeError } from '@ibiz-template/core';
+
+/**
+ * 计数器对象，
+ *
+ * @author lxm
+ * @date 2022-09-19 11:09:36
+ * @export
+ * @class Counter
+ */
+export class Counter {
+  /**
+   * 计数
+   *
+   * @author lxm
+   * @date 2022-09-19 11:09:30
+   * @type {number}
+   */
+  count: number = 0;
+
+  /**
+   * 计数器状态
+   * 调用过一次回调后就会变为使用过的状态，任何操作都不会执行
+   *
+   * @author lxm
+   * @date 2022-09-21 19:09:21
+   * @private
+   * @type {('Unused' | 'Used')}
+   */
+  protected state: 'Unused' | 'Used' = 'Unused';
+
+  /**
+   * 是否可以重复使用
+   *
+   * @author lxm
+   * @date 2022-09-21 19:09:22
+   * @protected
+   * @type {boolean}
+   */
+  protected reusable: boolean = true;
+
+  /**
+   * Creates an instance of Counter.
+   * @author lxm
+   * @date 2022-09-19 11:09:57
+   * @param {() => void} callback 回调函数，在计数归零的时候被调用
+   */
+  constructor(private callback: () => void) {}
+
+  /**
+   * 增加计数，返回增加后的计数
+   *
+   * @author lxm
+   * @date 2022-08-18 21:08:22
+   */
+  increment(): number {
+    if (this.state === 'Used') {
+      return this.count;
+    }
+    this.count += 1;
+    return this.count;
+  }
+
+  /**
+   * 减少计数，当计数为0时触发回调
+   *
+   * @author lxm
+   * @date 2022-08-18 21:08:22
+   */
+  decrement(callback2?: () => void): void {
+    if (this.state === 'Used') {
+      return;
+    }
+    if (this.count === 0) {
+      throw new RuntimeError('错误的调用！decrement不能对count为0调用');
+    }
+    this.count -= 1;
+    if (this.count === 0) {
+      if (callback2) {
+        callback2();
+      } else if (this.callback) {
+        this.callback();
+      }
+      if (!this.reusable) {
+        this.state = 'Used';
+      }
+    }
+  }
+
+  /**
+   * 销毁方法，解除关联
+   *
+   * @author lxm
+   * @date 2022-09-19 11:09:27
+   */
+  destroy() {
+    this.callback = undefined as never;
+  }
+}

package/src/controller/utils/counter/index.ts

@@ -0,0 +1,2 @@
+export * from './counter';
+export * from './mounted-counter';

package/src/controller/utils/counter/mounted-counter.ts

@@ -0,0 +1,53 @@
+import { Counter } from './counter';
+
+/**
+ * 活动计数器
+ *
+ * @author lxm
+ * @date 2022-09-21 18:09:53
+ * @export
+ * @class NerveCounter
+ * @extends {Counter}
+ */
+export class ActivityCounter extends Counter {
+  protected reusable: boolean = false;
+
+  /**
+   * 登记情况，记录了登记的名称和是否已经出席
+   *
+   * @author lxm
+   * @date 2022-09-21 18:09:27
+   * @type {string[]}
+   */
+  registration: Map<string, boolean> = new Map();
+
+  /**
+   * 登记要等待的名称
+   *
+   * @author lxm
+   * @date 2022-09-21 18:09:01
+   * @param {string} name
+   */
+  enroll(name: string) {
+    // 当计数器未触发之前才可以登记入册
+    if (this.state === 'Unused' && !this.registration.has(name)) {
+      this.registration.set(name, false);
+      this.increment();
+    }
+  }
+
+  /**
+   * 出席，只有登记了的名称才能出席，当所有登记的名称出席后计数器结束，触发回调
+   *
+   * @author lxm
+   * @date 2022-09-21 18:09:09
+   * @param {string} name
+   */
+  attend(name: string) {
+    // 在名称集合内，且未false时
+    if (this.registration.has(name) && this.registration.get(name) === false) {
+      this.registration.set(name, true);
+      this.decrement();
+    }
+  }
+}

package/src/controller/utils/event/controller-event.ts

@@ -0,0 +1,99 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { StrKeyOf } from '@ibiz-template/core';
+import { CompEventType, EventBase, IComponentEvent } from '../../interface';
+import { QXEventEx } from './qx-event-ex';
+
+export type FunProperty<T> = {
+  [p in keyof T]: (...args: any[]) => any;
+};
+
+export type defaultType = {
+  [p: string]: (...args: any[]) => any;
+};
+
+/**
+ * 控制器事件触发，监听工具类，需要提供基础事件参数的回调。
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:49
+ * @export
+ * @class ControllerEvent
+ * @template E 事件接口
+ * @template A 能力行为接口
+ */
+export class ControllerEvent<E extends CompEventType<E> = IComponentEvent> {
+  /**
+   * 事件对象
+   *
+   * @author lxm
+   * @date 2022-08-30 14:08:40
+   */
+  protected readonly evt = new QXEventEx<defaultType>();
+
+  /**
+   * 发送事件，并等待所有监听器执行完毕
+   * @author lxm
+   * @date 2023-03-30 06:49:12
+   * @template K
+   * @param name 事件名称
+   * @param args 事件参数
+   * @return {*}  {Promise<void>}
+   */
+  async emit<K extends StrKeyOf<E>>(
+    name: K,
+    args: E[K]['emitArgs'],
+  ): Promise<void> {
+    // 自动补全其他事件对象参数
+    await this.evt.asyncEmit(name, {
+      ...this.getBaseArgs(),
+      eventName: name,
+      // 合并抛出事件时候的输入的参数
+      ...(args || {}),
+    });
+  }
+
+  /**
+   * 订阅指定事件
+   * @author lxm
+   * @date 2023-03-30 06:46:59
+   * @param  name 事件名
+   * @param  fn 事件回调
+   */
+  on<K extends StrKeyOf<E>>(
+    name: K,
+    fn: (event: E[K]['event']) => void | Promise<void>,
+  ): void {
+    this.evt.on(name, fn);
+  }
+
+  /**
+   * 订阅任意事件
+   * @author lxm
+   * @date 2023-03-30 06:48:28
+   * @param fn 事件回调
+   */
+  onAll(
+    fn: (eventName: string, event: EventBase) => void | Promise<void>,
+  ): void {
+    this.evt.onAll(fn as any);
+  }
+
+  /**
+   * Creates an instance of ControllerEvent.
+   * @author lxm
+   * @date 2023-04-25 09:30:28
+   * @param {() => Omit<EventBase, 'eventName'>} getBaseArgs 提供当前控制器环境内的通用的事件参数
+   */
+  constructor(protected getBaseArgs: () => Omit<EventBase, 'eventName'>) {}
+
+  /**
+   * 销毁方法，清空
+   *
+   * @author lxm
+   * @date 2022-08-30 17:08:41
+   */
+  destroy() {
+    this.getBaseArgs = undefined as any;
+    this.evt.reset();
+  }
+}

package/src/controller/utils/event/index.ts

@@ -0,0 +1,2 @@
+export * from './controller-event';
+export * from './qx-event-ex';

package/src/controller/utils/event/qx-event-ex.ts

@@ -0,0 +1,58 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { clearAll, QXEvent } from 'qx-util';
+import { QXEmitter } from 'qx-util/out/interface';
+
+/**
+ * QXEvent增强，添加监听任意事件的方式
+ * @author lxm
+ * @date 2023-03-23 10:02:12
+ * @export
+ * @class QXEventEx
+ * @extends {QXEvent<T>}
+ * @template T
+ */
+export class QXEventEx<T extends QXEmitter<T>> extends QXEvent<T> {
+  private anyEventFns: Array<
+    (eventName: string | number | symbol, ...args: any[]) => Promise<any[]>
+  > = [];
+
+  /**
+   * 监听任意事件，返回值必须是数组，用来返回单次或多次的正常回调的结果。
+   * 该返回值数组会在正常事件触发的时候展开合并入正常事件的结果里，模拟多次监听的常规返回。
+   * @author lxm
+   * @date 2023-03-23 09:50:33
+   * @param {(...args: any[]) => Promise<any[]>} fn
+   */
+  onAll(
+    fn: (eventName: string | number | symbol, ...args: any[]) => Promise<any>,
+  ) {
+    // 避免反复监听
+    if (!this.anyEventFns.includes(fn)) {
+      this.anyEventFns.push(fn);
+    }
+  }
+
+  emit<K extends keyof T>(name: K, ...args: Parameters<T[K]>): void {
+    super.emit(name, ...args);
+    this.anyEventFns.forEach(fn => {
+      fn(name, ...args);
+    });
+  }
+
+  async asyncEmit<K extends keyof T>(
+    name: K,
+    ...args: Parameters<T[K]>
+  ): Promise<Awaited<ReturnType<T[K]>>[]> {
+    const result = await super.asyncEmit(name, ...args);
+    // 任意事件监听回调执行，并把执行结果展开合并入原始结果集合
+    const all = this.anyEventFns.map(fn => fn(name, ...args));
+    const resultArr = await Promise.all(all);
+    result.concat(...resultArr);
+    return result;
+  }
+
+  reset(): void {
+    super.reset();
+    clearAll(this.anyEventFns);
+  }
+}

package/src/controller/utils/index.ts

@@ -0,0 +1,5 @@
+export * from './counter';
+export * from './loading/loading-state';
+export * from './button-state';
+export * from './event';
+export * from './layout-helper/layout-helper';

package/src/controller/utils/layout-helper/layout-helper.ts

@@ -0,0 +1,86 @@
+import { ILayoutPos } from '@ibiz/model-core';
+
+/**
+ * 计算布局高宽
+ *
+ * @author lxm
+ * @date 2023-02-15 11:37:49
+ * @export
+ * @param {ILayoutPos} layoutPos
+ */
+export function calcLayoutHeightWidth(layoutPos: ILayoutPos): {
+  width: string;
+  height: string;
+} {
+  const { width, height, widthMode, heightMode } = layoutPos;
+  const result = { width: 'auto', height: 'auto' };
+  if (widthMode === 'FULL') {
+    result.width = '100%';
+  } else if (width && width > 0) {
+    if (widthMode === 'PERCENTAGE') {
+      result.width = `${width}%`;
+    } else {
+      result.width = `${width}px`;
+    }
+  }
+  if (heightMode === 'FULL') {
+    result.height = '100%';
+  } else if (height && height > 0) {
+    if (heightMode === 'PERCENTAGE') {
+      result.height = `${height}%`;
+    } else {
+      result.height = `${height}px`;
+    }
+  }
+  return result;
+}
+
+/**
+ * 计算布局内容压制自身的样式
+ *
+ * @author lxm
+ * @date 2023-02-15 11:49:06
+ * @export
+ * @param {ILayoutPos} layoutPos
+ * @returns {*}  {Partial<ILayoutController>}
+ */
+export function calcLayoutContentStyle(layoutPos: ILayoutPos): IData {
+  const { valignSelf, halignSelf } = layoutPos;
+  const result = {};
+  // 自身对齐方式
+  if (valignSelf || halignSelf) {
+    Object.assign(result, { display: 'flex' });
+    // 自身垂直对齐模式
+    switch (valignSelf) {
+      case 'TOP':
+        Object.assign(result, { 'align-items': 'flex-start' });
+        break;
+      case 'MIDDLE':
+        Object.assign(result, { 'align-items': 'center' });
+        break;
+      case 'BOTTOM':
+        Object.assign(result, { 'align-items': 'flex-end' });
+        break;
+      default:
+        break;
+    }
+    // 自身水平对齐模式
+    switch (halignSelf) {
+      case 'LEFT':
+        Object.assign(result, { 'justify-content': 'flex-start' });
+        break;
+      case 'CENTER':
+        Object.assign(result, { 'justify-content': 'center' });
+        break;
+      case 'RIGHT':
+        Object.assign(result, { 'justify-content': 'flex-end' });
+        break;
+      case 'JUSTIFY':
+        Object.assign(result, { 'justify-content': 'space-between' });
+        break;
+      default:
+        break;
+    }
+  }
+  return result;
+}

package/src/controller/utils/loading/loading-state.ts

@@ -0,0 +1,54 @@
+import { NOOP } from '@ibiz-template/core';
+import { Counter } from '../counter/counter';
+
+/**
+ * loading状态控制类
+ *
+ * @author lxm
+ * @date 2022-09-19 11:09:35
+ * @export
+ * @class LoadingState
+ */
+export class LoadingState {
+  /**
+   * 当前的loading状态，多次loading叠加时，只有所有loading都结束才会变回false。
+   *
+   * @author lxm
+   * @date 2022-09-19 11:09:43
+   * @readonly
+   * @type {boolean}
+   */
+  isLoading: boolean = false;
+
+  /**
+   * loading计数器
+   *
+   * @author lxm
+   * @date 2022-09-19 11:09:08
+   * @private
+   */
+  private counter = new Counter(NOOP);
+
+  /**
+   * 开始loading
+   *
+   * @author lxm
+   * @date 2022-09-19 11:09:55
+   */
+  begin() {
+    this.isLoading = true;
+    this.counter.increment();
+  }
+
+  /**
+   * 结束loading
+   *
+   * @author lxm
+   * @date 2022-09-19 11:09:34
+   */
+  end() {
+    this.counter.decrement(() => {
+      this.isLoading = false;
+    });
+  }
+}

package/src/engine/engine-factory.ts

@@ -0,0 +1,116 @@
+import { Logger } from '@ibiz-template/core';
+import { IAppView } from '@ibiz/model-core';
+import { PresetViewEngine } from './preset-view-engine';
+import { ViewEngine } from './view-engine';
+
+/**
+ * 引擎工厂
+ * @author lxm
+ * @date 2023-04-25 07:17:42
+ * @export
+ * @class EngineFactory
+ */
+export class EngineFactory {
+  /**
+   * 预置视图引擎classMap
+   * @author lxm
+   * @date 2023-04-25 07:28:36
+   * @protected
+   */
+  protected presetViewEngines = new Map<string, typeof PresetViewEngine>();
+
+  /**
+   * 通用视图引擎classMap
+   * @author lxm
+   * @date 2023-04-25 07:28:36
+   * @protected
+   */
+  protected viewEngines = new Map<string, typeof ViewEngine>();
+
+  /**
+   * 注册预置视图引擎class
+   * @author lxm
+   * @date 2023-04-25 07:39:52
+   * @param {string} key
+   * @param {IPresetViewEngine} engine
+   */
+  registerPreset(key: string, engine: typeof PresetViewEngine): void {
+    this.presetViewEngines.set(key, engine);
+  }
+
+  /**
+   * 注销预置视图引擎
+   * @author lxm
+   * @date 2023-04-25 07:40:01
+   * @param {string} key
+   */
+  unRegisterPreset(key: string): void {
+    this.presetViewEngines.delete(key);
+  }
+
+  /**
+   * 获取预置视图引擎实例
+   * @author lxm
+   * @date 2023-04-26 07:27:05
+   * @param {IAppView} model
+   * @param {...ConstructorParameters<typeof PresetViewEngine>} args 引擎构造函数参数
+   * @return {*}  {(PresetViewEngine | undefined)}
+   */
+  getPresetViewEngine(
+    model: IAppView,
+    ...args: ConstructorParameters<typeof PresetViewEngine>
+  ): PresetViewEngine | undefined {
+    const { viewType, viewStyle } = model;
+    const key1 = `${viewType}_${viewStyle}`;
+    if (this.presetViewEngines.has(key1)) {
+      return new (this.presetViewEngines.get(key1)!)(...args);
+    }
+    if (this.presetViewEngines.has(viewType!)) {
+      return new (this.presetViewEngines.get(viewType!)!)(...args);
+    }
+    Logger.debug('没有预置视图引擎');
+  }
+
+  /**
+   * 注册通用视图引擎
+   * @author lxm
+   * @date 2023-04-25 07:40:23
+   * @param {string} key
+   * @param {IViewEngine} engine
+   */
+  register(key: string, engine: typeof ViewEngine): void {
+    this.viewEngines.set(key, engine);
+  }
+
+  /**
+   * 注销通用视图引擎
+   * @author lxm
+   * @date 2023-04-25 07:40:32
+   * @param {string} key
+   */
+  unRegister(key: string): void {
+    this.viewEngines.delete(key);
+  }
+
+  /**
+   * 获取通用视图引擎
+   * @author lxm
+   * @date 2023-04-25 07:40:43
+   * @param {IAppView} model
+   * @return {*}  {(IViewEngine | undefined)}
+   */
+  getEngine(
+    model: IAppView,
+    ...args: ConstructorParameters<typeof ViewEngine>
+  ): ViewEngine | undefined {
+    const { viewType, viewStyle } = model;
+    const key1 = `${viewType}_${viewStyle}`;
+    if (this.viewEngines.has(key1)) {
+      return new (this.viewEngines.get(key1)!)(...args);
+    }
+    if (this.viewEngines.has(viewType!)) {
+      return new (this.viewEngines.get(viewType!)!)(...args);
+    }
+    Logger.debug('没有预置视图引擎');
+  }
+}

package/src/engine/index.ts

@@ -0,0 +1,4 @@
+export * from './engine-factory';
+export * from './preset-view-engine';
+export * from './view-engine-base';
+export * from './view-engine';

package/src/engine/preset-view-engine.ts

@@ -0,0 +1,51 @@
+import { IAppViewLogic } from '@ibiz/model-core';
+import { executeViewLogic } from '../view-logic';
+import { ViewEngineBase } from './view-engine-base';
+
+/**
+ * 预置视图引擎
+ * @author lxm
+ * @date 2023-04-26 07:29:27
+ * @export
+ * @class PresetViewEngine
+ */
+export class PresetViewEngine extends ViewEngineBase {
+  /**
+   * 执行视图逻辑
+   *
+   * @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.controller.context,
+      data,
+      this.controller.params,
+      {
+        event,
+        controller: this.controller,
+      },
+    );
+
+    // 界面行为执行后续处理
+    if (result.refresh) {
+      await this.controller.refresh();
+    }
+    if (result.closeView) {
+      await this.controller.closeView();
+    }
+  }
+
+  init() {
+    this.controller.childNames.push('toolbar', 'layoutpanel');
+  }
+}

package/src/engine/view-engine-base.ts

@@ -0,0 +1,21 @@
+import { ViewController } from '../controller';
+
+/**
+ * 视图里的引擎基类
+ * @author lxm
+ * @date 2023-04-26 07:32:34
+ * @export
+ * @class ViewEngineBase
+ */
+export class ViewEngineBase {
+  constructor(protected controller: ViewController) {}
+
+  /**
+   * 引擎初始化，一般在视图created声明周期里执行
+   * @author lxm
+   * @date 2023-04-26 07:33:26
+   */
+  init() {
+    // 引擎初始化逻辑
+  }
+}

package/src/engine/view-engine.ts

@@ -0,0 +1,10 @@
+import { ViewEngineBase } from './view-engine-base';
+
+/**
+ * 通用视图引擎
+ * @author lxm
+ * @date 2023-04-26 07:29:18
+ * @export
+ * @class ViewEngine
+ */
+export class ViewEngine extends ViewEngineBase {}

package/src/global/global-util/global-util.ts

@@ -0,0 +1,19 @@
+import { ViewLayoutUtil } from '../../utils';
+
+/**
+ * 全局工具方法或对象
+ *
+ * @author chitanda
+ * @date 2023-04-27 21:04:32
+ * @export
+ * @class GlobalUtil
+ */
+export class GlobalUtil {
+  /**
+   * 视图布局
+   *
+   * @author chitanda
+   * @date 2023-04-27 21:04:46
+   */
+  readonly viewLayout = new ViewLayoutUtil();
+}

package/src/global/index.ts

@@ -0,0 +1 @@
+export { GlobalUtil } from './global-util/global-util';