@ibiz-template/model-helper 0.7.41-alpha.13 → 0.7.41-alpha.130

package/src/model-loader.ts

@@ -0,0 +1,95 @@
+import { ModelLoaderProvider } from '@ibiz-template/runtime';
+import {
+  IApplication,
+  IAppView,
+  IAppDataEntity,
+  IAppBIScheme,
+  IAppBICube,
+  IAppBIReport,
+  ISubAppRef,
+  IAppCodeList,
+  IAppLan,
+} from '@ibiz/model-core';
+import { ModelHelper } from './model-helper';
+
+/**
+ * 模型加载适配器
+ *
+ * @author chitanda
+ * @date 2023-04-17 23:04:44
+ * @export
+ * @class ModelLoader
+ * @implements {ModelLoaderProvider}
+ */
+export class ModelLoader implements ModelLoaderProvider {
+  constructor(protected helper: ModelHelper) {}
+
+  initApp(id?: string): Promise<boolean> {
+    return this.helper.initApp(id);
+  }
+
+  getApp(id?: string): Promise<IApplication> {
+    return this.helper.getAppModel(id);
+  }
+
+  getSubAppRef(appId: string): Promise<ISubAppRef | undefined> {
+    return this.helper.getSubAppRef(appId);
+  }
+
+  getAppView(appId: string, codeName: string): Promise<IAppView> {
+    return this.helper.getAppViewModel(codeName, appId);
+  }
+
+  getAppDataEntity(appId: string, id: string): Promise<IAppDataEntity> {
+    return this.helper.getAppDataEntityModel(id, appId);
+  }
+
+  getAppDataEntityByCodeName(
+    appId: string,
+    codeName: string,
+  ): Promise<IAppDataEntity> {
+    return this.helper.getAppDataEntityModel(codeName, appId, false);
+  }
+
+  async getPSAppLang(
+    language: string,
+    appId?: string | IObject,
+  ): Promise<IAppLan | null> {
+    return this.helper.getPSAppLang(language, appId);
+  }
+
+  getAppStyle(appId: string): Promise<string | null> {
+    return this.helper.getAppStyle(appId);
+  }
+
+  loadAppView(
+    appId: string,
+    viewId: string,
+    params: IParams,
+  ): Promise<IAppView> {
+    return this.helper.loadAppViewModel(viewId, params, appId);
+  }
+
+  getAppBISchemes(appId: string, ids: string[]): Promise<IAppBIScheme[]> {
+    return this.helper.getAppBISchemes(appId, ids);
+  }
+
+  getAppAppBICubes(appId: string, ids: string[]): Promise<IAppBICube[]> {
+    return this.helper.getAppAppBICubes(appId, ids);
+  }
+
+  getAppBIReports(appId: string, ids: string[]): Promise<IAppBIReport[]> {
+    return this.helper.getAppBIReports(appId, ids);
+  }
+
+  translationModelToDsl(
+    data: IData,
+    type: 'APP' | 'VIEW' | 'CTRL' | 'APPENTITY' | 'APPBIREPORT',
+  ): Promise<IModel | undefined> {
+    return this.helper.translationModelToDsl(data, type);
+  }
+
+  mergeSubAppCodeList(codeList: IAppCodeList): void {
+    this.helper.mergeSubAppCodeList(codeList);
+  }
+}

package/src/model-util.ts

@@ -0,0 +1,483 @@
+import { calcUniqueTag } from '@ibiz/rt-model-api';
+import { IAppDERS } from '@ibiz/model-core';
+import { isEmpty } from 'ramda';
+import {
+  formatPath,
+  mergeModel,
+  ModelTransformer,
+  ServicePathUtil,
+} from './utils';
+import { PSSysApp } from './model/PSSYSAPP';
+
+/**
+ * 全动模型处理工具类,每个App一个实例
+ *
+ * @author chitanda
+ * @date 2023-04-16 17:04:06
+ * @export
+ * @class ModelUtil
+ */
+export class ModelUtil {
+  /**
+   * 模型缓存
+   *
+   * @author chitanda
+   * @date 2023-04-16 17:04:40
+   * @protected
+   * @type {Map<string, IModel>}
+   */
+  protected modelCache: Map<string, IModel> = new Map();
+
+  /**
+   * 应用模型
+   *
+   * @author chitanda
+   * @date 2023-04-16 17:04:17
+   * @protected
+   * @type {IModel}
+   */
+  protected appModel!: IModel;
+
+  /**
+   * 服务路径计算工具类
+   *
+   * @author chitanda
+   * @date 2023-04-22 12:04:15
+   * @type {ServicePathUtil}
+   */
+  servicePathUtil!: ServicePathUtil;
+
+  /**
+   * Creates an instance of GlobalModel.
+   *
+   * @author chitanda
+   * @date 2023-04-13 21:04:21
+   * @param {string}appId 应用标识
+   * @param {string} modelTag
+   * @param {(url: string, params?: IParams) => Promise<IModel>} get 模型加载方法
+   * @param {boolean} hub 是否为 hub 应用基座
+   * @param {IParams} appContext 应用级上下文参数
+   */
+  constructor(
+    protected appId: string,
+    protected modelTag: string,
+    protected get: (url: string, params?: IParams) => Promise<IModel>,
+    protected hub: boolean,
+    protected appContext: IParams,
+    protected permission: boolean = true,
+  ) {}
+
+  /**
+   * 在使用前需要初始化，来进行异步加载
+   *
+   * @author chitanda
+   * @date 2023-04-16 17:04:35
+   * @return {*}  {Promise<void>}
+   */
+  async init(): Promise<void> {
+    await this.getAppModel();
+    await this.specialHandling();
+    // 填充缓存模型
+    {
+      const { cache } = this.appModel;
+      if (cache) {
+        const views = cache.getPSAppViews;
+        if (views) {
+          views.forEach((item: IModel) => {
+            item.path = item.dynaModelFilePath;
+            const appPath = this.calcAppPath(item.path);
+            this.modelCache.set(appPath, item);
+          });
+          if (this.appModel.getAllPSAppViews == null) {
+            this.appModel.getAllPSAppViews = views;
+          } else {
+            this.appModel.getAllPSAppViews.push(...views);
+          }
+        }
+      }
+    }
+    const allDataEntities = (this.appModel.getAllPSAppDataEntities ||
+      []) as IModel[];
+    allDataEntities.forEach(item => {
+      item.id = calcUniqueTag(item, false);
+    });
+    const allViews = (this.appModel.getAllPSAppViews || []) as IModel[];
+    allViews.forEach(item => {
+      item.id = calcUniqueTag(item, false);
+    });
+    const allAppDERSs = (this.appModel.getAllPSAppDERSs || []) as IModel[];
+    allAppDERSs.forEach(item => {
+      const major = item.getMajorPSAppDataEntity;
+      const minor = item.getMinorPSAppDataEntity;
+      item.majorAppDataEntityId = calcUniqueTag(major, false);
+      item.minorAppDataEntityId = calcUniqueTag(minor, false);
+    });
+    this.servicePathUtil = new ServicePathUtil(
+      allDataEntities,
+      allAppDERSs as IAppDERS[],
+      this,
+    );
+  }
+
+  /**
+   * 特殊处理应用模型
+   *
+   * @author chitanda
+   * @date 2023-09-21 15:09:07
+   * @protected
+   * @return {*}  {Promise<void>}
+   */
+  protected async specialHandling(): Promise<void> {
+    // 特殊处理预置全局界面行为，附加一些特殊的模板预置模型
+    if (this.appModel.getAllPSAppDEUIActions) {
+      mergeModel(
+        this.appModel.getAllPSAppDEUIActions,
+        PSSysApp.getAllPSAppDEUIActions,
+        'codeName',
+      );
+    }
+  }
+
+  /**
+   * 获取应用模型
+   *
+   * @author chitanda
+   * @date 2023-04-16 17:04:21
+   * @return {*}  {Promise<IModel>}
+   */
+  async getAppModel(): Promise<IModel> {
+    if (!this.appModel) {
+      let appPath: string = '/PSSYSAPP.json';
+      if (this.hub && ibiz.env.hub) {
+        appPath = `/PSSYSAPP.hub.json`;
+      }
+      if (this.permission === false) {
+        appPath = `/simple/PSSYSAPP.simple.json`;
+      }
+      this.appModel = await this.getModel(appPath);
+      this.appModel.id = this.appId;
+    }
+    return this.appModel;
+  }
+
+  /**
+   * 加载应用模型全局样式
+   *
+   * @author chitanda
+   * @date 2023-09-06 10:09:11
+   * @return {*}  {(Promise<string | null>)}
+   */
+  async getAppStyle(): Promise<string | null> {
+    let style: string = '';
+    try {
+      let stylePath: string = '/PSSYSAPP.json.css';
+      if (this.hub && ibiz.env.hub) {
+        stylePath = `/PSSYSAPP.hubsubapp.json.css`;
+      }
+      if (this.permission === false) {
+        stylePath = `/simple/PSSYSAPP.simple.json.css`;
+      }
+      style = await this.getStyleModel(stylePath);
+      if (style) {
+        return style;
+      }
+    } catch (error) {
+      // 忽略样式加载异常
+      ibiz.log.error(error);
+    }
+    return null;
+  }
+
+  /**
+   * 根据应用实体 codeName 或者 id 获取应用实体模型
+   *
+   * @author chitanda
+   * @date 2023-04-16 18:04:45
+   * @param {string} tag
+   * @param {boolean} [isId=true]
+   * @param {boolean} [ignoreCase=false]
+   * @return {*}  {Promise<IModel>}
+   */
+  async getAppDataEntityModel(
+    tag: string,
+    isId: boolean = true,
+    ignoreCase: boolean = false,
+  ): Promise<IModel> {
+    const allDataEntities = this.appModel.getAllPSAppDataEntities as IModel[];
+    if (allDataEntities && allDataEntities.length > 0) {
+      const lowerTag = tag.toLowerCase();
+      let dataEntity: IModel | undefined;
+      if (isId) {
+        dataEntity = allDataEntities.find(v => {
+          if (ignoreCase) {
+            return v.id.toLowerCase() === lowerTag;
+          }
+          return v.id === tag;
+        });
+      } else {
+        dataEntity = allDataEntities.find(v => {
+          if (ignoreCase) {
+            return v.codeName.toLowerCase() === lowerTag;
+          }
+          return v.codeName === tag;
+        });
+      }
+      if (dataEntity) {
+        return this.getModel(dataEntity.path);
+      }
+    }
+
+    throw new Error(
+      ibiz.i18n.t('modelHelper.noFoundEntity', { appId: this.appId, tag }),
+    );
+  }
+
+  /**
+   * 根据应用视图 id 获取应用视图模型,如果给了 params 则每次都会重新加载模型
+   *
+   * @author chitanda
+   * @date 2024-01-15 12:01:36
+   * @param {string} tag
+   * @param {IParams} [params]
+   * @param {boolean} [isDynamic]
+   * @return {*}  {Promise<IModel>}
+   */
+  async getAppViewModel(
+    tag: string,
+    params?: IParams,
+    isDynamic?: boolean,
+  ): Promise<IModel> {
+    const allViews = this.appModel.getAllPSAppViews as IModel[];
+    if (allViews && allViews.length > 0) {
+      const lowerTag = tag.toLowerCase();
+      const exTag = `.${lowerTag}`;
+      const view = allViews.find(
+        v => v.id.endsWith(exTag) || v.id === lowerTag,
+      );
+      if (view) {
+        return this.getModel(view.path, params, isDynamic);
+      }
+    }
+    throw new Error(
+      ibiz.i18n.t('modelHelper.noFoundView', { appId: this.appId, tag }),
+    );
+  }
+
+  /**
+   * 加载应用多语言模型
+   *
+   * @author chitanda
+   * @date 2023-08-24 22:08:23
+   * @param {string} language
+   * @return {*}  {Promise<IModel>}
+   */
+  async getPSAppLang(language: string): Promise<IModel> {
+    const app = await this.getAppModel();
+    if (app.getAllPSAppLans) {
+      const langs = app.getAllPSAppLans as IModel[];
+      const lang = langs.find(item => item.language === language);
+      if (lang) {
+        try {
+          const result = await this.getModel(
+            lang.path || lang.dynaModelFilePath,
+          );
+          return result;
+        } catch (error) {
+          ibiz.log.error(error);
+          return {};
+        }
+      }
+      ibiz.log.error(ibiz.i18n.t('modelHelper.noSupported', { language }));
+    }
+    return {};
+  }
+
+  /**
+   * 加载应用样式字符串
+   *
+   * @author chitanda
+   * @date 2023-09-07 11:09:11
+   * @param {string} modelPath
+   * @return {*}  {Promise<string>}
+   */
+  getStyleModel(modelPath: string): Promise<string> {
+    let url: string;
+    if (this.hub) {
+      url = this.calcAppPath(modelPath);
+    } else {
+      url = this.calcSubAppPath(modelPath);
+    }
+    return this.get(url) as unknown as Promise<string>;
+  }
+
+  /**
+   * 获取应用智能报表体系集合
+   *
+   * @author tony001
+   * @date 2024-06-04 16:06:19
+   * @param {IModel[]} model
+   * @return {*}  {Promise<IModel[]>}
+   */
+  async getAppBISchemeModel(model: IModel[] = []): Promise<IModel[]> {
+    const appBISchemeModel: IModel[] = [];
+    if (model.length > 0) {
+      for (let i = 0; i < model.length; i++) {
+        const appBISchemeItem = await this.getModel(model[i].path);
+        appBISchemeModel.push(appBISchemeItem);
+      }
+    }
+    return appBISchemeModel;
+  }
+
+  /**
+   * 获取应用智能报表立方体数据集合
+   *
+   * @author tony001
+   * @date 2024-06-04 16:06:19
+   * @param {IModel[]} [model=[]]
+   * @return {*}  {Promise<IModel[]>}
+   */
+  async getAppAppBICubes(model: IModel[] = []): Promise<IModel[]> {
+    const appBICubeModel: IModel[] = [];
+    if (model.length > 0) {
+      for (let i = 0; i < model.length; i++) {
+        const appBICubeItem = await this.getModel(model[i].path);
+        appBICubeModel.push(appBICubeItem);
+      }
+    }
+    return appBICubeModel;
+  }
+
+  /**
+   * 获取应用智能报表数据集合
+   *
+   * @author tony001
+   * @date 2024-06-04 16:06:29
+   * @param {IModel[]} [model=[]]
+   * @return {*}  {Promise<IModel[]>}
+   */
+  async getAppBIReports(model: IModel[] = []): Promise<IModel[]> {
+    const appBIReportModel: IModel[] = [];
+    if (model.length > 0) {
+      for (let i = 0; i < model.length; i++) {
+        const appBIReportItem = await this.getModel(model[i].path);
+        appBIReportModel.push(appBIReportItem);
+      }
+    }
+    return appBIReportModel;
+  }
+
+  /**
+   * 加载模型，如果给了 params 则不会缓存模型
+   *
+   * @author chitanda
+   * @date 2024-01-15 12:01:57
+   * @param {string} modelPath
+   * @param {IParams} [params]
+   * @param {boolean} [isDynamic]
+   * @return {*}  {Promise<IModel>}
+   */
+  async getModel(
+    modelPath: string,
+    params?: IParams,
+    isDynamic?: boolean,
+  ): Promise<IModel> {
+    let url: string;
+    if (this.hub) {
+      url = this.calcAppPath(modelPath, isDynamic);
+    } else {
+      url = this.calcSubAppPath(modelPath, isDynamic);
+    }
+    const isParams = params && !isEmpty(params);
+    if (this.modelCache.has(url) && !isParams) {
+      return this.modelCache.get(url)!;
+    }
+    const model = await this.get(url, params);
+    const filledModel = this.deepFillModel(model);
+    if (!isParams) {
+      this.modelCache.set(url, filledModel);
+    }
+    return filledModel;
+  }
+
+  /**
+   * 递归填充模型，包括填充模型appId、变换模型
+   *
+   * @author chitanda
+   * @date 2023-08-21 10:08:41
+   * @protected
+   * @param {IModel} model
+   * @return {*}  {IModel} 返回处理后的模型，若处理器返回新对象则替换原引用
+   */
+  protected deepFillModel(model: IModel): IModel {
+    // 变换模型
+    let result = model;
+    if (model.dynaModelFilePath) {
+      result = ModelTransformer.getInstance().transform(
+        model.dynaModelFilePath,
+        model,
+      );
+    }
+    // 填充模型appId
+    result.appId = this.appId;
+    const keys = Object.keys(result);
+    keys.forEach(key => {
+      const value = result[key];
+      if (value && typeof value === 'object') {
+        if (Array.isArray(value)) {
+          value.forEach((item, index) => {
+            if (item && typeof item === 'object') {
+              value[index] = this.deepFillModel(item);
+            }
+          });
+        } else {
+          result[key] = this.deepFillModel(value);
+        }
+      }
+    });
+    return result;
+  }
+
+  /**
+   * 计算应用模型请求路径
+   *
+   * @author chitanda
+   * @date 2024-01-15 12:01:45
+   * @protected
+   * @param {string} modelPath
+   * @param {boolean} [isDynamic=false]
+   * @return {*}  {string}
+   */
+  protected calcAppPath(modelPath: string, isDynamic: boolean = false): string {
+    if (isDynamic) {
+      return formatPath(modelPath);
+    }
+    return `${formatPath(modelPath)}${
+      this.modelTag
+        ? `?dynamodeltag=${this.modelTag}${this.appContext && this.appContext.srfembsubapp ? `&srfembsubapp=${this.appContext.srfembsubapp}` : ''}`
+        : ''
+    }`;
+  }
+
+  /**
+   * 计算子应用模型请求路径
+   *
+   * @author chitanda
+   * @date 2024-01-15 12:01:39
+   * @protected
+   * @param {string} modelPath
+   * @param {boolean} [isDynamic=false]
+   * @return {*}  {string}
+   */
+  protected calcSubAppPath(
+    modelPath: string,
+    isDynamic: boolean = false,
+  ): string {
+    if (isDynamic) {
+      return `/subapps/${this.appId}${formatPath(modelPath)}`;
+    }
+    return `/subapps/${this.appId}${formatPath(modelPath)}?dynamodeltag=${
+      this.modelTag
+    }`;
+  }
+}

package/src/utils/format-path/format-path.ts

@@ -0,0 +1,9 @@
+export function formatPath(path: string): string {
+  // 合成路径，需要判断模型路径是否从 PSSYSAPPS 开始
+  if (path?.indexOf('PSSYSAPPS/') === 0) {
+    // 合成路径
+    const pos = path.indexOf('/');
+    return path.substring(path.indexOf('/', pos + 1));
+  }
+  return path;
+}

package/src/utils/index.ts

@@ -0,0 +1,12 @@
+export { formatPath } from './format-path/format-path';
+export { mergeModel } from './merge-model/merge-model';
+export { plural, pluralLower } from './plural/plural';
+export {
+  ServicePathDeep,
+  ServicePathItem,
+  ServicePathUtil,
+} from './service-path-util/service-path-util';
+export { MergeSubModelHelper } from './merge-model/merge-model-helper';
+export { ModelHandler } from './model-transformer/model-handler';
+export { ModelTransformer } from './model-transformer/model-transformer';
+export { registerModelHandler } from './model-transformer/model-register';

package/src/utils/merge-model/merge-app-codelist.ts

@@ -0,0 +1,42 @@
+import { IAppCodeList } from '@ibiz/model-core';
+
+/**
+ * 合并应用代码表,子应用代码表需开启支持动态模式和配置用户标记，合并规则：dynamic_overlay:replace|merge,replace表示子应用代码表完全覆盖主应用代码表，merge表示子应用代码表项合并到主应用代码表项中（前提条件：主应用代码表和子应用代码表均是静态代码表），其他情况不做处理
+ * @param mainCodeList - 主应用代码表
+ * @param subCodeList - 子应用代码表
+ */
+export function mergeAppCodeList(
+  mainCodeList: IAppCodeList,
+  subCodeList: IAppCodeList,
+): void {
+  const { userTag } = subCodeList as IModel;
+  if (!userTag) return;
+  const [mergeTag, mergeWay] = userTag.split(':');
+  if (
+    !mergeTag ||
+    !mergeWay ||
+    mergeTag !== 'dynamic_overlay' ||
+    (mergeWay !== 'replace' && mergeWay !== 'merge')
+  )
+    return;
+  switch (mergeWay) {
+    case 'replace':
+      mainCodeList = subCodeList;
+      break;
+    case 'merge':
+      if (
+        mainCodeList.codeListType === 'STATIC' &&
+        subCodeList.codeListType === 'STATIC'
+      ) {
+        if (!mainCodeList.codeItems) mainCodeList.codeItems = [];
+        if (subCodeList.codeItems && subCodeList.codeItems.length > 0) {
+          subCodeList.codeItems.forEach(codeItem => {
+            mainCodeList.codeItems!.push(codeItem);
+          });
+        }
+      }
+      break;
+    default:
+      break;
+  }
+}