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

package/src/register/helper/tree-grid-ex-column-register.ts

@@ -0,0 +1,75 @@
+import { IDETreeColumn } from '@ibiz/model-core';
+import { ITreeGridExColumnProvider } from '../../interface';
+import { getPluginRegisterKey } from './common-register';
+
+/** 表格列适配器前缀 */
+export const TREEGRIDEX_COLUMN_PROVIDER_PREFIX = 'TREEGRIDEX_COLUMN';
+
+/**
+ * 注册表格列适配器
+ * @author lxm
+ * @date 2023-05-06 09:14:16
+ * @export
+ * @param {string} key
+ * @param {() => ITreeGridExColumnProvider} callback 生成表格列适配器的回调
+ */
+export function registerTreeGridExColumnProvider(
+  key: string,
+  callback: () => ITreeGridExColumnProvider,
+): void {
+  ibiz.register.register(
+    `${TREEGRIDEX_COLUMN_PROVIDER_PREFIX}_${key}`,
+    callback,
+  );
+}
+
+function getProvider(key: string): ITreeGridExColumnProvider | undefined {
+  return ibiz.register.get(
+    `${TREEGRIDEX_COLUMN_PROVIDER_PREFIX}_${key}`,
+  ) as ITreeGridExColumnProvider;
+}
+
+/**
+ * 获取表格列适配器
+ * @author lxm
+ * @date 2023-05-06 09:29:23
+ * @export
+ * @param {IAppView} model
+ * @return {*}  {Promise<ITreeGridExColumnProvider>}
+ */
+export async function getTreeGridExColumnProvider(
+  model: IDETreeColumn,
+): Promise<ITreeGridExColumnProvider | undefined> {
+  let provider: ITreeGridExColumnProvider | undefined;
+  const { columnType, appId, renderSysPFPluginId } =
+    model as Required<IDETreeColumn>;
+
+  // 树表格列插件
+  if (renderSysPFPluginId) {
+    const pluginKey = await getPluginRegisterKey(renderSysPFPluginId, appId);
+    if (pluginKey) {
+      provider = getProvider(pluginKey);
+    }
+    if (!provider) {
+      ibiz.log.warn(
+        ibiz.i18n.t('runtime.register.helper.treeTableColumnPlugin', {
+          pluginKey,
+        }),
+      );
+    } else {
+      return provider;
+    }
+  }
+
+  // 找表格列类型
+  provider = getProvider(columnType);
+  if (!provider) {
+    ibiz.log.warn(
+      ibiz.i18n.t('runtime.register.helper.tableColumnType', {
+        key: columnType,
+      }),
+    );
+  } else {
+    return provider;
+  }
+}

package/src/register/helper/ui-action-register.ts

@@ -0,0 +1,94 @@
+import { RuntimeError } from '@ibiz-template/core';
+import { IAppUIAction } from '@ibiz/model-core';
+import { IUIActionProvider } from '../../interface';
+import { getPluginRegisterKey } from './common-register';
+import { CustomRegister } from '../custom-register';
+
+/** 界面行为适配器前缀 */
+export const UIACTION_PROVIDER_PREFIX = 'UIACTION';
+
+/**
+ * 注册界面行为适配器
+ * @author lxm
+ * @date 2023-05-06 09:14:16
+ * @export
+ * @param {string} key
+ * @param {() => IUIActionProvider} callback 生成界面行为适配器的回调
+ */
+export function registerUIActionProvider(
+  key: string,
+  callback: () => IUIActionProvider,
+): void {
+  ibiz.register.register(`${UIACTION_PROVIDER_PREFIX}_${key}`, callback);
+}
+
+function getProvider(key: string): IUIActionProvider | undefined {
+  return ibiz.register.get(
+    `${UIACTION_PROVIDER_PREFIX}_${key}`,
+  ) as IUIActionProvider;
+}
+
+/**
+ * 获取界面行为适配器
+ * @author lxm
+ * @date 2023-05-06 09:29:23
+ * @export
+ * @param {IAppView} model
+ * @return {*}  {Promise<IUIActionProvider>}
+ */
+export async function getUIActionProvider(
+  model: IAppUIAction,
+): Promise<IUIActionProvider> {
+  let provider: IUIActionProvider | undefined;
+  const { uiactionMode, sysPFPluginId, appId, uiactionTag } =
+    model as Required<IAppUIAction>;
+  // 找自定义注册的适配器
+  const registerKey = CustomRegister.getRegisterKey(UIACTION_PROVIDER_PREFIX, {
+    uiActionModel: model,
+  });
+  provider = getProvider(registerKey);
+  if (!provider) {
+    ibiz.log.debug(
+      ibiz.i18n.t('runtime.register.helper.customRegistration', {
+        registerKey,
+      }),
+    );
+  } else {
+    return provider;
+  }
+
+  // 找插件适配器
+  if (sysPFPluginId) {
+    const pluginKey = await getPluginRegisterKey(sysPFPluginId, appId);
+    if (pluginKey) {
+      provider = getProvider(pluginKey);
+    }
+    if (!provider) {
+      ibiz.log.warn(
+        ibiz.i18n.t('runtime.register.helper.interfaceBehaviorPlugin', {
+          pluginKey,
+        }),
+      );
+    } else {
+      return provider;
+    }
+  }
+
+  // 先通过uiactionTag找界面行为适配器
+  provider = getProvider(`${uiactionMode}_${uiactionTag}`);
+  if (provider) {
+    return provider;
+  }
+
+  // 找界面行为类型
+  provider = getProvider(uiactionMode);
+  if (!provider) {
+    throw new RuntimeError(
+      ibiz.i18n.t('runtime.register.helper.interfaceBehaviorMode', {
+        uiactionMode,
+      }),
+    );
+  } else {
+    return provider;
+  }
+}

package/src/register/helper/ui-logic-node-register.ts

@@ -0,0 +1,54 @@
+import { IAppUIAction, IDEUIPFPluginLogic } from '@ibiz/model-core';
+import { RuntimeError } from '@ibiz-template/core';
+import { getPluginRegisterKey } from './common-register';
+import { IUILogicNodeProvider } from '../../interface';
+
+/** 界面逻辑节点适配器前缀 */
+export const UILOGINNODE_PROVIDER_PREFIX = 'UI_LOGIN_NODE';
+
+/**
+ * 注册界面逻辑节点适配器
+ *
+ * @author lxm
+ * @date 2023-05-06 09:14:16
+ * @export
+ * @param {string} key
+ * @param {() => IUILogicNodeProvider} callback 生成界面行为适配器的回调
+ */
+export function registerUILogicNodeProvider(
+  key: string,
+  callback: () => IUILogicNodeProvider,
+): void {
+  ibiz.register.register(`${UILOGINNODE_PROVIDER_PREFIX}_${key}`, callback);
+}
+
+/**
+ * 获取界面逻辑节点适配器
+ *
+ * @author chitanda
+ * @date 2023-11-01 17:11:43
+ * @export
+ * @param {IDEUIPFPluginLogic} model
+ * @return {*}  {Promise<IUILogicNodeProvider>}
+ */
+export async function getUILogicNodeProvider(
+  model: IDEUIPFPluginLogic,
+): Promise<IUILogicNodeProvider | undefined> {
+  let provider: IUILogicNodeProvider | undefined;
+  const { sysPFPluginId, appId } = model as Required<IAppUIAction>;
+
+  const pluginKey = await getPluginRegisterKey(sysPFPluginId, appId);
+  if (pluginKey) {
+    provider = ibiz.register.get(
+      `${UILOGINNODE_PROVIDER_PREFIX}_${pluginKey}`,
+    ) as IUILogicNodeProvider;
+    if (provider) {
+      return provider;
+    }
+    throw new RuntimeError(
+      ibiz.i18n.t('runtime.register.helper.frontEndPluginNode', {
+        pluginKey,
+      }),
+    );
+  }
+}

package/src/register/helper/view-register.ts

@@ -0,0 +1,86 @@
+import { IAppView } from '@ibiz/model-core';
+import { IViewProvider } from '../../interface';
+import { getPluginRegisterKey } from './common-register';
+
+/** 视图适配器前缀 */
+export const VIEW_PROVIDER_PREFIX = 'VIEW';
+
+/**
+ * 注册视图适配器
+ * @author lxm
+ * @date 2023-05-06 09:14:16
+ * @export
+ * @param {string} key
+ * @param {() => IViewProvider} callback 生成视图适配器的回调
+ */
+export function registerViewProvider(
+  key: string,
+  callback: () => IViewProvider,
+): void {
+  ibiz.register.register(`${VIEW_PROVIDER_PREFIX}_${key}`, callback);
+}
+
+function getProvider(key: string): IViewProvider | undefined {
+  return ibiz.register.get(`${VIEW_PROVIDER_PREFIX}_${key}`) as IViewProvider;
+}
+
+/**
+ * 获取视图适配器
+ * @author lxm
+ * @date 2023-05-06 09:29:23
+ * @export
+ * @param {IAppView} model
+ * @return {*}  {Promise<IViewProvider>}
+ */
+export async function getViewProvider(
+  model: IAppView,
+): Promise<IViewProvider | undefined> {
+  let provider: IViewProvider | undefined;
+  const { viewType, viewStyle, sysPFPluginId, appId } =
+    model as Required<IAppView>;
+
+  // 找插件适配器
+  if (sysPFPluginId) {
+    const pluginKey = await getPluginRegisterKey(sysPFPluginId, appId);
+    if (pluginKey) {
+      provider = getProvider(pluginKey);
+    }
+    if (!provider) {
+      ibiz.log.warn(
+        ibiz.i18n.t('runtime.register.helper.viewPlugin', {
+          pluginKey,
+        }),
+      );
+    } else {
+      return provider;
+    }
+  }
+
+  // 再找视图类型和视图样式
+  if (viewStyle && viewStyle !== 'DEFAULT') {
+    const key = `${viewType}_${viewStyle}`;
+    provider = getProvider(key);
+    if (!provider) {
+      ibiz.log.warn(
+        ibiz.i18n.t('runtime.register.helper.correspondViewTypeStyle', {
+          viewType,
+          viewStyle,
+        }),
+        model,
+      );
+    } else {
+      return provider;
+    }
+  }
+
+  // 找视图类型
+  if (!provider) {
+    provider = getProvider(viewType);
+  }
+
+  // 默认必给的通用视图适配器
+  if (!provider) {
+    provider = getProvider('DEFAULT')!;
+  }
+  return provider;
+}

package/src/register/index.ts

@@ -0,0 +1,2 @@
+export * from './helper';
+export * from './register-center';

package/src/register/register-center.ts

@@ -0,0 +1,59 @@
+import { IProvider } from '../interface';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type NewProvider = (...args: any[]) => IProvider;
+
+/**
+ * 注册中心
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @class Register
+ */
+export class RegisterCenter {
+  /**
+   * 已注册的适配器Map
+   * @author lxm
+   * @date 2023-05-06 09:55:33
+   * @protected
+   * @type {Map<string, NewProvider>}
+   */
+  protected providers: Map<string, NewProvider> = new Map();
+
+  /**
+   * 注册适配器
+   * @author lxm
+   * @date 2023-05-06 09:55:55
+   * @param {string} key 唯一标识
+   * @param {NewProvider} newProvider 创建适配器实例的回调
+   */
+  register(key: string, newProvider: NewProvider): void {
+    this.providers.set(key, newProvider);
+  }
+
+  /**
+   * 注销适配器
+   * @author lxm
+   * @date 2023-05-06 09:56:19
+   * @param {string} key
+   */
+  unRegister(key: string): void {
+    this.providers.delete(key);
+  }
+
+  /**
+   * 获取适配器的实例
+   * @author lxm
+   * @date 2023-05-06 09:56:34
+   * @param {string} key 唯一标识
+   * @param {...Parameters<NewProvider>} args 回调参数
+   * @return {*}  {(IProvider | undefined)}
+   */
+  get(key: string, ...args: Parameters<NewProvider>): IProvider | undefined {
+    const func = this.providers.get(key);
+    if (func) {
+      return func(...args);
+    }
+  }
+}

package/src/service/app-data-entity/app-data-entity.ts

@@ -0,0 +1,286 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable no-constructor-return */
+/* eslint-disable max-classes-per-file */
+import { IAppDataEntity } from '@ibiz/model-core';
+import { clone, isNil } from 'ramda';
+import { DataTypes } from '@ibiz-template/core';
+import { createUUID } from 'qx-util';
+import { Srfuf } from '../constant';
+import { findModelChild } from '../../model';
+import { IDataEntity } from '../../interface';
+
+/**
+ * 实体
+ *
+ * @author chitanda
+ * @date 2022-08-17 22:08:49
+ * @export
+ * @class AppDataEntity
+ */
+export class AppDataEntity implements IDataEntity {
+  [key: string | symbol]: any;
+
+  declare protected _data: IData;
+
+  declare protected _entity: IAppDataEntity;
+
+  declare srfdeid: string;
+
+  declare srfdecodename: string;
+
+  declare srfkeyfield: string;
+
+  declare srfmajorfield: string;
+
+  declare srfkey: string;
+
+  declare srfmajortext: string;
+
+  declare tempsrfkey: string;
+
+  declare srfordervalue: number;
+
+  declare srfunionkey: string;
+
+  get srfuf(): Srfuf {
+    return this.srfkey === this.tempsrfkey ? Srfuf.UPDATE : Srfuf.CREATE;
+  }
+
+  /**
+   * Creates an instance of AppDataEntity.
+   *
+   * @author chitanda
+   * @date 2023-11-16 15:11:08
+   * @param {IAppDataEntity} entity
+   * @param {(IData | AppDataEntity)} [data={}]
+   */
+  constructor(entity: IAppDataEntity, data: IData | AppDataEntity = {}) {
+    Object.defineProperty(this, '_entity', {
+      enumerable: false,
+      configurable: true,
+      value: entity,
+    });
+    Object.defineProperty(this, '_data', {
+      enumerable: false,
+      configurable: true,
+      value: data instanceof AppDataEntity ? clone(data._data) : clone(data),
+    });
+    Object.defineProperty(this, 'srfdeid', {
+      get() {
+        return entity.id;
+      },
+    });
+    Object.defineProperty(this, 'srfdecodename', {
+      get() {
+        return entity.codeName;
+      },
+    });
+
+    // 主键属性相关
+    const keyAppField = findModelChild(
+      entity.appDEFields || [],
+      entity.keyAppDEFieldId!,
+    );
+    if (keyAppField) {
+      const key = keyAppField.codeName!.toLowerCase();
+      Object.defineProperty(this, 'srfkeyfield', {
+        get() {
+          return key;
+        },
+      });
+      Object.defineProperty(this, 'srfkey', {
+        set(val: unknown) {
+          this._data[key] = val;
+        },
+        get() {
+          return this._data[key];
+        },
+      });
+    } else {
+      ibiz.log.warn(
+        ibiz.i18n.t('runtime.service.noConfiguredPrimary', {
+          codeName: entity.codeName,
+        }),
+      );
+    }
+    const majorAppField = findModelChild(
+      entity.appDEFields || [],
+      entity.majorAppDEFieldId!,
+    );
+
+    // 主文本属性相关
+    if (majorAppField) {
+      const major = majorAppField.codeName!.toLowerCase();
+      Object.defineProperty(this, 'srfmajorfield', {
+        get() {
+          return major;
+        },
+      });
+      Object.defineProperty(this, 'srfmajortext', {
+        set(val: unknown) {
+          this._data[major] = val;
+        },
+        get() {
+          return this._data[major];
+        },
+      });
+    } else {
+      ibiz.log.warn(
+        ibiz.i18n.t('runtime.service.noConfiguredField', {
+          codeName: entity.codeName,
+        }),
+      );
+    }
+
+    // 设置临时主键
+    Object.defineProperty(this, 'tempsrfkey', {
+      enumerable: false,
+      configurable: true,
+      writable: true,
+      value: isNil(this.srfkey) ? createUUID() : this.srfkey,
+    });
+
+    // 设置联合主键（存在联合主键属性集合才有值）
+    Object.defineProperty(this, 'srfunionkey', {
+      enumerable: false,
+      configurable: true,
+      writable: true,
+      value: '',
+    });
+
+    this.defineProperties();
+  }
+
+  /**
+   * 代理实际数据
+   *
+   * @author chitanda
+   * @date 2022-10-11 22:10:55
+   * @protected
+   */
+  protected defineProperties(): void {
+    const { _data, convertVal } = this;
+    const properties: { [key: string]: PropertyDescriptor } = {};
+    // fix：odoo#0059
+    const excludeKeys = [
+      '_entity',
+      '_data',
+      'srfdeid',
+      'srfdecodename',
+      'srfkeyfield',
+      'srfkey',
+      'srfmajorfield',
+      'srfmajortext',
+      'tempsrfkey',
+      'srfunionkey',
+    ];
+    const keys = Object.keys(_data);
+    keys.forEach(key => {
+      if (excludeKeys.indexOf(key) === -1) {
+        properties[key] = {
+          enumerable: true,
+          set(val: unknown): void {
+            _data[key] = val;
+          },
+          get(): any {
+            return _data[key];
+          },
+        };
+      }
+    });
+    this._entity.appDEFields?.forEach(field => {
+      const key = field.codeName!.toLowerCase();
+      properties[key] = {
+        enumerable: true,
+        set(val: unknown): void {
+          _data[key] = convertVal(val, field.stdDataType);
+        },
+        get(): any {
+          return _data[key];
+        },
+      };
+      // 初始值转换
+      _data[key] = convertVal(_data[key], field.stdDataType);
+    });
+    Object.defineProperties(this, properties);
+  }
+
+  /**
+   * 克隆数据
+   *
+   * @author chitanda
+   * @date 2022-10-11 00:10:15
+   * @return {*}  {AppDataEntity}
+   */
+  clone(): AppDataEntity {
+    const entity = new AppDataEntity(this._entity, this._data);
+    entity.srfkey = this.srfkey;
+    entity.srfordervalue = this.srfordervalue;
+    entity.srfunionkey = this.srfunionkey;
+    return entity;
+  }
+
+  /**
+   * 合并参数
+   *
+   * @author chitanda
+   * @date 2022-10-19 11:10:25
+   * @param {(IData | AppDataEntity)} data
+   * @return {*}  {AppDataEntity}
+   */
+  assign(data: IData | AppDataEntity): AppDataEntity {
+    let _data: IData = {};
+    if (data instanceof AppDataEntity) {
+      _data = data._data;
+      this.srfordervalue = data.srfordervalue;
+    } else {
+      _data = data;
+    }
+    Object.keys(_data).forEach(key => {
+      if (_data[key] === undefined) {
+        delete _data[key];
+      }
+    });
+    Object.assign(this._data, _data);
+    return this;
+  }
+
+  /**
+   * 根据属性的数据类型转换值
+   * @author lxm
+   * @date 2023-09-25 03:37:28
+   * @protected
+   * @param {unknown} value
+   * @param {(number | undefined)} dataType
+   * @return {*}  {unknown}
+   */
+  protected convertVal(value: unknown, dataType: number | undefined): unknown {
+    // 空值不转换
+    if (value == null) {
+      return value;
+    }
+
+    // 没有数据类型的给原值
+    if (isNil(dataType)) {
+      return value;
+    }
+
+    // 数值转换
+    if (DataTypes.isNumber(dataType)) {
+      const numVal = !isNil(value) && value !== '' ? Number(value) : value;
+
+      if (Number.isNaN(numVal)) {
+        // 不能转换的给原值
+        ibiz.log.debug(
+          ibiz.i18n.t('runtime.service.convertedNumber', {
+            value,
+          }),
+        );
+        return value;
+      }
+      return numVal;
+    }
+
+    return value;
+  }
+}

package/src/service/constant/index.ts

@@ -0,0 +1 @@
+export { Srfuf } from './srfuf';

package/src/service/constant/srfuf.ts

@@ -0,0 +1,15 @@
+/* eslint-disable no-shadow */
+/**
+ * 数据的状态（新建与否）
+ *
+ * @author lxm
+ * @date 2022-09-06 22:09:00
+ * @export
+ * @enum {number}
+ */
+export enum Srfuf {
+  // 新建数据
+  CREATE = 0,
+  // 更新数据
+  UPDATE = 1,
+}