@ibiz-template/runtime 0.0.1-beta.1 → 0.0.2-beta.0

package/src/service/utils/index.ts

@@ -0,0 +1,13 @@
+export { AppCounter } from './app-counter/app-counter';
+export * from './de-dq-cond';
+export { DEDQCondUtil } from './de-dq-cond-util/de-dq-cond-util';
+export { DynamicCodeListCache } from './dynamic-code-list/dynamic-code-list';
+export { EntityCache } from './entity-cache/entity-cache';
+export { SearchFilter } from './search-filter/search-filter';
+export {
+  ServicePathDeep,
+  ServicePathItem,
+  ServicePathUtil,
+} from './service-path-util/service-path-util';
+export { IBizVerify } from './ibiz-verify/ibiz-verify';
+export * from './res-path/res-path';

package/src/service/utils/res-path/res-path.ts

@@ -0,0 +1,39 @@
+import { ServicePathItem } from '../service-path-util/service-path-util';
+
+/**
+ * 计算资源路径url
+ *
+ * @author lxm
+ * @date 2022-11-25 13:11:53
+ * @export
+ * @param {IContext} context 上下文对象
+ * @param {ServicePathItem[][]} pathItems 计算出的资源关系路径
+ * @returns {*}  {string}
+ */
+export function calcResPath(
+  context: IContext,
+  pathItems: ServicePathItem[][],
+): string {
+  let paths: string[][] = [];
+  // 计算不包含自身路径
+  pathItems.forEach(items => {
+    let values: string[] = [];
+    for (let i = 0; i < items.length - 1; i++) {
+      const item = items[i];
+      const val = context[item.name];
+      if (val) {
+        values.push(item.plural);
+        values.push(val);
+      } else {
+        values = [];
+      }
+    }
+    paths.push(values);
+  });
+  paths = paths.sort((a, b) => b.length - a.length);
+  const [pathArr] = paths;
+  if (pathArr) {
+    return `${pathArr.length > 1 ? '/' : ''}${pathArr.join('/')}`;
+  }
+  return '';
+}

package/src/service/utils/search-filter/search-filter.ts

@@ -0,0 +1,142 @@
+import { isEmpty, isNil } from 'ramda';
+
+/**
+ * 搜索过滤
+ *
+ * @export
+ * @class SearchFilter
+ */
+export class SearchFilter {
+  /**
+   * 上下文
+   *
+   * @author chitanda
+   * @date 2022-08-17 22:08:24
+   * @type {IContext}
+   */
+  readonly context: IContext;
+
+  /**
+   * 父关系实体
+   *
+   * @type {string}
+   * @memberof SearchFilter
+   */
+  readonly srfparentdename?: string;
+
+  /**
+   * 指定父数据主键
+   *
+   * @type {string}
+   * @memberof SearchFilter
+   */
+  readonly srfparentkey?: string;
+
+  /**
+   * 分页
+   *
+   * @type {number}
+   * @memberof SearchFilter
+   */
+  readonly page = 0;
+
+  /**
+   * 分页数据量
+   *
+   * @type {number}
+   * @memberof SearchFilter
+   */
+  readonly size = 1000;
+
+  /**
+   * 快速搜索值
+   *
+   * @type {string}
+   * @memberof SearchFilter
+   */
+  readonly query!: string;
+
+  /**
+   * 数据
+   *
+   * @author chitanda
+   * @date 2022-08-17 22:08:00
+   * @type {IData}
+   */
+  readonly data: IData = {};
+
+  /**
+   * 排序属性
+   *
+   * @type {string}
+   * @memberof SearchFilter
+   */
+  readonly sortField = 'srfordervalue';
+
+  /**
+   * 排序模式
+   *
+   * @type {('ASC' | 'DESC')}
+   * @memberof SearchFilter
+   */
+  readonly sortMode: 'ASC' | 'DESC' = 'ASC';
+
+  /**
+   * Creates an instance of SearchFilter.
+   *
+   * @param {*} context
+   * @param {*} [data]
+   * @memberof SearchFilter
+   */
+  constructor(context: IContext, data?: IData) {
+    this.context = context;
+    if (data) {
+      if (!isNil(data.page) && !isEmpty(data.page)) {
+        this.page = data.page;
+      }
+      if (!isNil(data.size) && !isEmpty(data.size)) {
+        this.size = data.size;
+      }
+      if (!isNil(data.query) && !isEmpty(data.query)) {
+        this.query = data.query;
+      }
+      if (!isNil(data.sort) && !isEmpty(data.sort)) {
+        const arr = data.sort.split(',');
+        if (arr.length >= 1) {
+          [this.sortField] = arr;
+        }
+        if (arr.length >= 2) {
+          this.sortMode = arr[1].toUpperCase();
+        }
+      }
+      if (!isNil(data.srfparentkey) && !isEmpty(data.srfparentkey)) {
+        this.srfparentkey = data.srfparentkey;
+      }
+      if (!isNil(data.srfparentdename) && !isEmpty(data.srfparentdename)) {
+        this.srfparentdename = data.srfparentdename;
+      }
+      this.data = { ...data };
+      delete this.data.page;
+      delete this.data.size;
+      delete this.data.query;
+      delete this.data.sort;
+      delete this.data.srfparentkey;
+      delete this.data.srfparentdename;
+    }
+  }
+
+  /**
+   * 获取条件值
+   *
+   * @author chitanda
+   * @date 2022-08-17 22:08:11
+   * @param {string} key
+   * @return {*}  {unknown}
+   */
+  getValue(key: string): unknown {
+    if (this.data[key]) {
+      return this.data[key];
+    }
+    return this.context[key];
+  }
+}

package/src/service/utils/service-exist-util/service-exist-util.ts

@@ -0,0 +1,37 @@
+import { RuntimeError } from '@ibiz-template/core';
+import { isEmpty, isNil } from 'ramda';
+import { Entity } from '../../entity/entity';
+
+/**
+ * 判断数据主键是否存在，不存在抛出异常
+ *
+ * @export
+ * @param {string} funcName 执行方法名称
+ * @param {Entity} entity 判断数据
+ * @return {*}  {boolean}
+ */
+export function isExistSrfKey(funcName: string, entity: Entity): boolean {
+  if (entity != null) {
+    const { srfkey } = entity;
+    if (!isNil(srfkey) && !isEmpty(srfkey)) {
+      return true;
+    }
+  }
+  throw new RuntimeError(`执行「${funcName}」不存在「srfkey」无法处理`);
+}
+
+/**
+ * 判断缓存 srfsessionid 是否存在，不存在抛异常
+ *
+ * @export
+ * @param {string} funcName 执行方法名称
+ * @param {IContext} context 上下文
+ * @return {*}  {boolean}
+ */
+export function isExistSessionId(funcName: string, context: IContext): boolean {
+  const { srfsessionid } = context;
+  if (!isNil(srfsessionid) && !isEmpty(srfsessionid)) {
+    return true;
+  }
+  throw new RuntimeError(`执行「${funcName}」不存在「srfsessionid」无法处理`);
+}

package/src/service/utils/service-path-util/service-path-util.ts

@@ -0,0 +1,219 @@
+import { pluralLower } from '@ibiz-template/core';
+import { IPSAppDERS } from '@ibiz-template/model';
+
+/**
+ * 获取服务拼接递归对象
+ */
+export type ServicePathDeep = [IPSAppDERS, ServicePathDeep[]];
+
+/**
+ * 服务路径项
+ */
+export type ServicePathItem = {
+  /**
+   * 实体名称(标准)
+   *
+   * @author chitanda
+   * @date 2022-08-25 18:08:35
+   * @type {string}
+   */
+  deName: string;
+  /**
+   * 实体名称(小写)
+   *
+   * @author chitanda
+   * @date 2022-08-25 18:08:54
+   * @type {string}
+   */
+  name: string;
+  /**
+   * 实体名称复数(小写)
+   *
+   * @author chitanda
+   * @date 2022-08-25 18:08:13
+   * @type {string}
+   */
+  plural: string;
+};
+
+/**
+ * 服务路径拼接工具
+ *
+ * @author chitanda
+ * @date 2022-08-22 21:08:52
+ * @export
+ * @class ServicePathUtil
+ */
+export class ServicePathUtil {
+  protected static allDERss: IPSAppDERS[] = [];
+
+  /**
+   * 应用实体关系
+   *
+   * @author chitanda
+   * @date 2022-08-22 22:08:18
+   * @protected
+   * @type {Map<string, IPSAppDERS[]>} <应用实体, 应用实体父关系>
+   */
+  protected static entityRsMap: Map<string, IPSAppDERS[]> = new Map();
+
+  /**
+   * 实体资源路径
+   *
+   * @author chitanda
+   * @date 2022-08-22 22:08:58
+   * @protected
+   * @type {Map<string, ServicePathItem[][]>}
+   */
+  protected static entityRsPathMap: Map<string, ServicePathItem[][]> =
+    new Map();
+
+  /**
+   * 初始化工具参数
+   *
+   * @author chitanda
+   * @date 2022-08-22 21:08:47
+   * @protected
+   * @param {IContext} context
+   * @return {*}  {Promise<void>}
+   */
+  protected static async init(context: IContext): Promise<void> {
+    if (this.allDERss.length > 0) {
+      return;
+    }
+    const service = await ibiz.model.getModelService(context);
+    const { app } = service;
+    const allPSAppEntities = app.getAllPSAppDataEntities() || [];
+    this.allDERss = app.getAllPSAppDERSs() || [];
+    allPSAppEntities.forEach(entity => {
+      const codeName = entity.isFill ? entity.codeName : entity.refM.codeName;
+      const items = this.allDERss.filter(item => {
+        if (item.minorDECodeName === codeName) {
+          return item;
+        }
+        return null;
+      });
+      if (items.length > 0) {
+        this.entityRsMap.set(codeName, items);
+      }
+    });
+  }
+
+  /**
+   * 计算指定实体所有资源路径
+   *
+   * @author chitanda
+   * @date 2022-08-22 22:08:54
+   * @param {IParams} context
+   * @param {string} deName
+   * @return {*}  {Promise<string[][]>} 返回顺序为 [祖父实体，爷爷实体，父实体，当前实体]
+   */
+  static async calcPaths(
+    context: IParams,
+    deName: string,
+  ): Promise<ServicePathItem[][]> {
+    if (this.entityRsPathMap.has(deName)) {
+      return this.entityRsPathMap.get(deName)!;
+    }
+    await this.init(context);
+    const deRss = this.entityRsMap.get(deName);
+    if (deRss) {
+      const arr = this.calcDeepPath(deRss);
+      this.deepFillPath(deName, [deName], arr);
+      const paths = this.entityRsPathMap.get(deName);
+      if (paths) {
+        const sortedPaths = this.sortPath(paths);
+        this.entityRsPathMap.set(deName, sortedPaths);
+        return sortedPaths;
+      }
+    }
+    return [
+      [{ deName, name: deName.toLowerCase(), plural: pluralLower(deName) }],
+    ];
+  }
+
+  /**
+   * 计算递归资源路径
+   *
+   * @author chitanda
+   * @date 2022-08-22 22:08:32
+   * @protected
+   * @param {IPSAppDERS[]} deRss
+   * @return {*}  {ServicePathDeep[]}
+   */
+  protected static calcDeepPath(
+    deRss: IPSAppDERS[],
+    num: number = 0,
+  ): ServicePathDeep[] {
+    if (num > 10) {
+      throw new Error('服务路径计算超过最大层级 10');
+    }
+    num += 1;
+    const arr: ServicePathDeep[] = [];
+    deRss.forEach(rs => {
+      const items = this.entityRsMap.get(rs.majorDECodeName) || [];
+      arr.push([rs, this.calcDeepPath(items, num)]);
+    });
+    return arr;
+  }
+
+  /**
+   * 递归填充计算所有资源路径
+   *
+   * @author chitanda
+   * @date 2022-08-22 22:08:04
+   * @protected
+   * @param {string} deName
+   * @param {string[]} pathNames
+   * @param {ServicePathDeep[]} items
+   */
+  protected static deepFillPath(
+    deName: string,
+    pathNames: string[],
+    items: ServicePathDeep[],
+  ): void {
+    items.forEach(item => {
+      const [rs, children] = item;
+      if (children.length > 0) {
+        this.deepFillPath(deName, [...pathNames, rs.majorDECodeName], children);
+      } else {
+        if (!this.entityRsPathMap.has(deName)) {
+          this.entityRsPathMap.set(deName, []);
+        }
+        const arr = this.entityRsPathMap.get(deName)!;
+
+        arr.push(
+          [
+            ...pathNames.map(pathName => {
+              return {
+                deName: pathName,
+                name: pathName.toLowerCase(),
+                plural: pluralLower(pathName),
+              };
+            }),
+            {
+              deName: rs.majorDECodeName,
+              name: rs.majorDECodeName.toLowerCase(),
+              plural: pluralLower(rs.majorDECodeName),
+            },
+          ].reverse(),
+        );
+      }
+    });
+  }
+
+  /**
+   * 排序资源路径顺序
+   *
+   * @author chitanda
+   * @date 2022-08-22 22:08:44
+   * @protected
+   * @param {ServicePathItem[][]} paths
+   * @return {*}  {ServicePathItem[][]}
+   */
+  protected static sortPath(paths: ServicePathItem[][]): ServicePathItem[][] {
+    return paths.sort((a, b) => {
+      return b.length - a.length;
+    });
+  }
+}

package/src/service/vo/control.vo.ts

@@ -0,0 +1,217 @@
+import { isNil } from 'ramda';
+import { Srfuf } from '../constant';
+import { UIMapField } from './ui-map-field';
+
+/**
+ * 部件UI显示层数据转换
+ *
+ * @author lxm
+ * @date 2022-09-05 15:09:31
+ * @export
+ * @class ControlVO
+ */
+export class ControlVO {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string | symbol]: any;
+
+  /**
+   * 原始后台数据
+   *
+   * @author lxm
+   * @date 2022-10-18 15:10:19
+   * @private
+   * @type {IData}
+   */
+  declare $origin: IData;
+
+  /**
+   * 属性映射集合
+   *
+   * @author lxm
+   * @date 2022-10-18 15:10:33
+   * @private
+   * @type {Map<string, UIMapField>}
+   */
+  declare $dataUIMap: Map<string, UIMapField>;
+
+  /**
+   * 是否是新建数据，0为新建
+   *
+   * @author lxm
+   * @date 2022-09-06 22:09:24
+   * @type {Srfuf}
+   */
+  get srfuf(): Srfuf {
+    if (isNil(this.$origin.srfuf)) {
+      return this.srfkey ? Srfuf.UPDATE : Srfuf.CREATE;
+    }
+    return this.$origin.srfuf;
+  }
+
+  /**
+   * 主键
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:42
+   * @type {string}
+   */
+  declare srfkey: string;
+
+  /**
+   * 主信息
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:42
+   * @type {string}
+   */
+  declare srfmajortext: string;
+
+  /**
+   * Creates an instance of ControlVO.
+   * @author lxm
+   * @date 2022-09-05 15:09:10
+   * @param {IData} origin 后台原始数据
+   * @param {Map<string, string>} dataUIMap 转换映射map，key为转换后的属性，value为映射字段描述信息
+   */
+  constructor($origin?: IData, $dataUIMap?: Map<string, UIMapField>) {
+    if (!$origin || !$dataUIMap) {
+      return;
+    }
+
+    Object.defineProperty(this, '$origin', {
+      enumerable: false,
+      value: $origin || {},
+    });
+
+    Object.defineProperty(this, '$dataUIMap', {
+      enumerable: false,
+      value: $dataUIMap || new Map(),
+    });
+
+    // 先转换映射的属性
+    this.$dataUIMap.forEach((mapField, key) => {
+      const value = mapField.dataKey;
+      // 关联映射属性
+      this.linkProperty(key, value, mapField.isOriginField);
+    });
+
+    // 映射属性里没有涉及到的建立直接关联，用于使用实体属性也要取到值的场景。
+    Object.keys($origin).forEach(value => {
+      if (!Object.prototype.hasOwnProperty.call(this, value)) {
+        // 原始属性的键也能直接使用
+        this.linkProperty(value, value);
+      }
+    });
+  }
+
+  /**
+   * 关联实体属性
+   *
+   * @author lxm
+   * @date 2022-10-18 15:10:48
+   * @private
+   * @param {string} uiKey 界面字段
+   * @param {string} dataKey 数据字段
+   * @param {boolean} [isOriginField=true] 是否是后台存储字段，是的话存取都在$origin里
+   * @returns {*}
+   */
+  private linkProperty(
+    uiKey: string,
+    dataKey: string,
+    isOriginField: boolean = true,
+  ) {
+    // srfuf不做处理
+    if (uiKey === 'srfuf') {
+      return;
+    }
+
+    // 后台数据存在$origin里，其他存在ControlVo上
+    if (isOriginField) {
+      Object.defineProperty(this, uiKey, {
+        enumerable: true,
+        configurable: true,
+        get() {
+          return this.$origin[dataKey];
+        },
+        set(val) {
+          this.$origin[dataKey] = val;
+        },
+      });
+    } else {
+      Object.defineProperty(this, uiKey, {
+        enumerable: true,
+        configurable: true,
+        writable: true,
+        value: null,
+      });
+    }
+  }
+
+  /**
+   * 获取原始数据
+   *
+   * @author lxm
+   * @date 2022-09-05 15:09:52
+   * @returns {*}
+   */
+  getOrigin() {
+    return this.$origin;
+  }
+
+  /**
+   * 获取请求数据
+   *
+   * @author lxm
+   * @date 2022-10-18 15:10:53
+   * @returns {*}
+   */
+  getRequestData() {
+    const requestData: IData = { ...this.$origin };
+    this.$dataUIMap.forEach(mapField => {
+      if (mapField.isRequestNeed !== mapField.isOriginField) {
+        requestData[mapField.dataKey] = this[mapField.uiKey];
+      }
+    });
+    return requestData;
+  }
+
+  /**
+   * 设置原始数据
+   *
+   * @author lxm
+   * @date 2022-10-17 20:10:39
+   * @param {IData} data
+   */
+  setOrigin(data: IData | ControlVO) {
+    this.$origin = data instanceof ControlVO ? data.getOrigin() : data;
+  }
+
+  /**
+   * 合并原始数据，有的字段合并，没有的不合并
+   *
+   * @author lxm
+   * @date 2022-10-19 12:10:09
+   * @param {(IData | ControlVO)} data
+   */
+  mergeOrigin(data: IData | ControlVO) {
+    Object.assign(
+      this.$origin,
+      data instanceof ControlVO ? data.getOrigin() : data,
+    );
+  }
+
+  /**
+   * 临时处理，响应式需要
+   *
+   * @author lxm
+   * @date 2022-10-19 12:10:11
+   */
+  reactiveInit() {
+    // vue响应式需要，给所有界面属性字段的undefined改成null
+    this.$dataUIMap.forEach((value, key) => {
+      if (this.$origin[key] === undefined) {
+        this.$origin[key] = null;
+      }
+    });
+  }
+}

package/src/service/vo/tree-node-data.ts

@@ -0,0 +1,47 @@
+/**
+ * 树节点数据格式
+ *
+ * @export
+ * @class TreeNodeData
+ */
+export interface TreeNodeData {
+  /**
+   * 节点标识(节点模型的标识)
+   *
+   * @type {string}
+   * @memberof TreeNodeData
+   */
+  nodeId: string;
+
+  /**
+   * 节点数据主键
+   *
+   * @type {string}
+   * @memberof TreeNodeData
+   */
+  id: string;
+
+  /**
+   * 节点显示名称
+   *
+   * @type {string}
+   * @memberof TreeNodeData
+   */
+  text: string;
+
+  /**
+   * 是否没有子节点
+   *
+   * @type {boolean}
+   * @memberof TreeNodeData
+   */
+  leaf: boolean;
+
+  /**
+   * 子节点集合（没有子节点则不存在）
+   *
+   * @type {TreeNodeData[]}
+   * @memberof TreeNodeData
+   */
+  children?: TreeNodeData[];
+}