@ibiz-template/runtime 0.0.1-alpha.9 → 0.0.1-beta.17

package/src/service/service/entity/method/method.ts

@@ -0,0 +1,176 @@
+import { HttpResponse } from '@ibiz-template/core';
+import {
+  AppEntityModel,
+  DefectModelError,
+  IAppDEMethod,
+} from '@ibiz-template/model';
+import { Entity } from '../../../entity/entity';
+import { calcResPath, ServicePathItem } from '../../../utils';
+import { EntityService } from '../entity.service';
+import { MethodInput } from './method-input';
+import { MethodReturn } from './method-renturn';
+
+/**
+ * 应用实体方法
+ *
+ * @author chitanda
+ * @date 2022-10-10 11:10:43
+ * @export
+ * @class Method
+ */
+export abstract class Method {
+  /**
+   * 输入 DTO
+   *
+   * @author chitanda
+   * @date 2022-10-10 19:10:35
+   * @protected
+   * @type {MethodInput}
+   */
+  protected input: MethodInput;
+
+  /**
+   * 输出 DTO
+   *
+   * @author chitanda
+   * @date 2022-10-10 19:10:42
+   * @protected
+   * @type {MethodReturn}
+   */
+  protected result: MethodReturn;
+
+  /**
+   * 实体服务
+   *
+   * @author chitanda
+   * @date 2022-10-11 21:10:23
+   * @protected
+   * @type {EntityService}
+   */
+  protected service?: EntityService;
+
+  /**
+   * Creates an instance of Method.
+   *
+   * @author chitanda
+   * @date 2022-10-10 14:10:19
+   * @param {AppEntityModel} entity
+   * @param {IAppDEMethod} method
+   * @param {ServicePathItem[][]} paths
+   */
+  constructor(
+    protected entity: AppEntityModel,
+    protected method: IAppDEMethod,
+    protected paths: ServicePathItem[][],
+  ) {
+    this.input = new MethodInput(entity, method.getPSAppDEMethodInput()!);
+    this.result = new MethodReturn(entity, method.getPSAppDEMethodReturn()!);
+  }
+
+  /**
+   * 执行行为
+   *
+   * @author chitanda
+   * @date 2022-10-10 14:10:42
+   * @param {IContext} context
+   * @param {IData} [params={}]
+   * @param {IParams} [params2={}]
+   * @return {*}  {Promise<HttpResponse>}
+   */
+  abstract exec(
+    context: IContext,
+    params: IData,
+    params2: IParams,
+  ): Promise<HttpResponse>;
+
+  /**
+   * 发送请求
+   *
+   * @author chitanda
+   * @date 2022-10-10 17:10:44
+   * @protected
+   * @param {string} path
+   * @param {IContext} context
+   * @param {IData} data
+   * @param {IParams} params
+   * @return {*}  {Promise<HttpResponse<any>>}
+   */
+  protected async request(
+    path: string,
+    _context: IContext,
+    data: IData,
+    params: IParams,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ): Promise<HttpResponse<any>> {
+    const requestType = this.method.requestMethod;
+    const methodName = this.method.codeName.toLowerCase();
+    let res: HttpResponse | null = null;
+    switch (requestType) {
+      case 'POST':
+        res = await ibiz.net.post(`${path}/${methodName}`, data, params);
+        break;
+      case 'GET':
+        res = await ibiz.net.get(`${path}/${methodName}`, data, params);
+        break;
+      case 'PUT':
+        res = await ibiz.net.put(`${path}/${methodName}`, data, params);
+        break;
+      case 'DELETE':
+        res = await ibiz.net.delete(`${path}/${methodName}`, data, params);
+        break;
+      default:
+        if (requestType) {
+          throw new DefectModelError(
+            this.method,
+            `未支持的请求方式: ${requestType}`,
+          );
+        } else {
+          throw new DefectModelError(this.method, '未配置请求方式');
+        }
+    }
+    return res;
+  }
+
+  /**
+   * 根据上下文计算当前请求路径
+   *
+   * @author chitanda
+   * @date 2022-08-24 18:08:46
+   * @protected
+   * @param {IContext} context
+   * @return {*}  {string} 拼接结果说明: /祖父实体/祖父实体主键/爷爷实体/爷爷实体主键/父实体/父实体主键/当前实体
+   */
+  protected calcPath(context: IContext): string {
+    const curPath = `/${this.entity.deNamePlural}`;
+    const resPath = calcResPath(context, this.paths);
+    return resPath + curPath;
+  }
+
+  /**
+   * 获取当前实体服务
+   *
+   * @author chitanda
+   * @date 2022-10-11 21:10:12
+   * @protected
+   * @return {*}  {Promise<EntityService>}
+   */
+  protected async getService(): Promise<EntityService> {
+    if (!this.service) {
+      this.service = await ibiz.entityService.getService(this.entity.codeName);
+    }
+    return this.service;
+  }
+
+  /**
+   * 创建实体
+   *
+   * @author chitanda
+   * @date 2022-10-11 22:10:05
+   * @protected
+   * @param {(IData | Entity)} data
+   * @return {*}  {Entity}
+   */
+  protected createEntity(data: IData | Entity): Entity {
+    return new Entity(this.entity.source, data);
+  }
+}

package/src/service/service/file/file.service.ts

@@ -0,0 +1,47 @@
+import { IHttpResponse } from '@ibiz-template/core';
+import { AppEntityModel, IPSDEDataExport } from '@ibiz-template/model';
+import { calcResPath, ServicePathItem } from '../../utils';
+
+export class FileService {
+  /**
+   * Creates an instance of FileService.
+   * @author lxm
+   * @date 2022-11-25 13:11:49
+   * @param {AppEntityModel} model 应用实体
+   * @param {ServicePathItem[][]} paths 计算出的资源关系路径
+   */
+  constructor(
+    protected model: AppEntityModel,
+    protected paths: ServicePathItem[][],
+  ) {}
+
+  /**
+   * 后台导出数据，返回文件流
+   *
+   * @author lxm
+   * @date 2022-11-25 14:11:53
+   * @param {IPSDEDataExport} dataExport 导出模型
+   * @param {string} fetchAction 查询方法
+   * @param {IContext} context 上下文
+   * @param {IParams} params 请求参数
+   * @returns {*}  {Promise<IHttpResponse<Blob>>}
+   */
+  exportData(
+    dataExport: IPSDEDataExport,
+    fetchAction: string,
+    context: IContext,
+    params: IParams,
+  ): Promise<IHttpResponse<Blob>> {
+    const resPath = calcResPath(context, this.paths);
+    const exportUrl = `${resPath}/${
+      this.model.deNamePlural
+    }/exportdata/${fetchAction.toLowerCase()}/?srfexporttag=${
+      dataExport.codeName
+    }`;
+    return ibiz.net.request(exportUrl, {
+      method: 'post',
+      data: params,
+      responseType: 'blob',
+    }) as Promise<IHttpResponse<Blob>>;
+  }
+}

package/src/service/service/index.ts

@@ -0,0 +1,5 @@
+export { CodeListService } from './code-list/code-list.service';
+export { CounterService } from './counter/counter.service';
+export { EntityService } from './entity/entity.service';
+export { WorkFlowService } from './work-flow/work-flow.service';
+export * from './widget';

package/src/service/service/widget/control-service.ts

@@ -0,0 +1,138 @@
+import { IHttpResponse } from '@ibiz-template/core';
+import { AppEntityModel, ControlModel } from '@ibiz-template/model';
+import { ControlVO } from '../../vo/control.vo';
+import { UIMapField } from '../../vo/ui-map-field';
+import { EntityService } from '../entity/entity.service';
+
+export class ControlService<T extends ControlModel = ControlModel> {
+  /**
+   * 部件模型
+   *
+   * @author lxm
+   * @date 2022-08-29 18:08:10
+   * @type {T}
+   */
+  readonly model: T;
+
+  /**
+   * 应用实体模型
+   *
+   * @author lxm
+   * @date 2022-08-29 18:08:38
+   * @type {AppEntityModel}
+   */
+  get appEntity(): AppEntityModel {
+    return this.model.appEntity;
+  }
+
+  /**
+   * 实体服务
+   *
+   * @author lxm
+   * @date 2022-08-29 18:08:19
+   * @type {EntityService}
+   */
+  entityService!: EntityService;
+
+  /**
+   * UI数据和实体数据的属性名映射
+   * key：UI数据属性名
+   * value: 映射属性描述信息
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:35
+   */
+  dataUIMap = new Map<string, UIMapField>();
+
+  /**
+   * Creates an instance of ControlService.
+   * @author lxm
+   * @date 2022-08-29 18:08:08
+   * @param {T} model
+   */
+  constructor(model: T) {
+    this.model = model;
+  }
+
+  /**
+   * 子类不可覆盖或重写此方法，在 init 时需要重写的使用 onInit 方法。
+   *
+   * @author lxm
+   * @date 2022-08-18 22:08:30
+   * @returns {*}  {Promise<void>}
+   */
+  async init(context?: IContext): Promise<void> {
+    this.entityService = await ibiz.entityService.getService(
+      this.appEntity.source.codeName,
+      context,
+    );
+    this.initUIDataMap();
+  }
+
+  /**
+   * 初始化属性映射
+   *
+   * @author lxm
+   * @date 2022-08-31 18:08:37
+   */
+  protected initUIDataMap() {
+    // 默认提供实体名称主键和srfkey的主键
+    // 实体名称
+    const deName = this.model.appEntity.deName.toLowerCase();
+    // 主键key
+    const keyField = this.model.source
+      .getPSAppDataEntity()!
+      .getKeyPSAppDEField()?.codeName;
+    if (keyField) {
+      const mapField = new UIMapField(deName, keyField.toLowerCase(), {
+        isOriginField: true,
+      });
+      this.dataUIMap.set(deName, mapField);
+      this.dataUIMap.set('srfkey', mapField);
+    }
+  }
+
+  /**
+   * 执行服务方法
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:41
+   * @param {string} methodName 方法名
+   * @param {IContext} context 上下文
+   * @param {IParams} [params={}] 视图参数或数据
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async exec(
+    methodName: string,
+    context: IContext,
+    params: IParams = {},
+  ): Promise<IHttpResponse> {
+    const res = await this.entityService.exec(methodName, context, params);
+    return res;
+  }
+
+  /**
+   * 处理响应
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:13
+   * @param {IHttpResponse} res
+   * @returns {*}  {IHttpResponse}
+   */
+  handleResponse(res: IHttpResponse): IHttpResponse {
+    // 公共处理
+    return res;
+  }
+
+  /**
+   * 实体数据转ui数据
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:15
+   * @param {IData} entityData  实体数据
+   * @returns {*}  {IData}
+   */
+  toUIData(entityData: IData): ControlVO {
+    return new ControlVO(entityData, this.dataUIMap);
+  }
+}

package/src/service/service/widget/edit-form-service.ts

@@ -0,0 +1,233 @@
+import { IHttpResponse } from '@ibiz-template/core';
+import { DefectModelError, EditFormModel } from '@ibiz-template/model';
+import { ControlVO } from '../../vo/control.vo';
+import { UIMapField } from '../../vo/ui-map-field';
+import { ControlService } from './control-service';
+
+export class EditFormService<
+  T extends EditFormModel = EditFormModel,
+> extends ControlService<T> {
+  /**
+   * 执行获取单条数据方法
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:41
+   * @param {IContext} context 上下文
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async get(
+    context: IContext,
+    params: IParams = {},
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(this.model.getAction, context, params);
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 执行获取草稿方法
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:41
+   * @param {IContext} context 上下文
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async getDraft(
+    context: IContext,
+    params: IParams = {},
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(this.model.getDraftAction, context, params);
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 删除单条数据
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:48
+   * @param {IContext} context 上下文
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}
+   */
+  async remove(
+    context: IContext,
+    params: IParams = {},
+  ): Promise<IHttpResponse> {
+    const res = await this.exec(this.model.removeAction, context, params);
+    return res;
+  }
+
+  /**
+   * 新建数据
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IContext} context 上下文
+   * @param {ControlVO} data 数据
+   * @returns {*}
+   */
+  async create(
+    context: IContext,
+    data: ControlVO,
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(
+      this.model.createAction,
+      context,
+      data.getRequestData(),
+    );
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 更新数据
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IContext} context 上下文
+   * @param {ControlVO} data 数据
+   * @returns {*}
+   */
+  async update(
+    context: IContext,
+    data: ControlVO,
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.exec(
+      this.model.updateAction,
+      context,
+      data.getRequestData(),
+    );
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 表单项更新
+   *
+   * @author lxm
+   * @date 2022-09-15 21:09:34
+   * @param {string} methodName
+   * @param {IContext} context
+   * @param {IParams} [params={}]
+   * @returns {*}  {Promise<IHttpResponse<ControlVO>>}
+   */
+  async updateFormItem(
+    methodName: string,
+    context: IContext,
+    params: IParams = {},
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.entityService.exec(methodName, context, params);
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+
+  /**
+   * 工作流启动
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IContext} context 上下文
+   * @param {ControlVO} data 数据
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}
+   */
+  async wfStart(
+    context: IContext,
+    params: IParams,
+    data: ControlVO,
+  ): Promise<IHttpResponse<IData>> {
+    if (!this.model.wfStartAction) {
+      throw new DefectModelError(this.model.source, `不存在工作流启动行为`);
+    }
+    return this.entityService.wf.exec(
+      this.model.wfStartAction,
+      context,
+      params,
+      data.getRequestData(),
+    );
+  }
+
+  /**
+   * 工作流提交
+   *
+   * @author lxm
+   * @date 2022-09-07 19:09:11
+   * @param {IContext} context 上下文
+   * @param {ControlVO} data 数据
+   * @param {IParams} [params={}] 视图参数
+   * @returns {*}
+   */
+  async wfSubmit(
+    context: IContext,
+    params: IParams,
+    data: ControlVO,
+  ): Promise<IHttpResponse<IData>> {
+    if (!this.model.wfSubmitAction) {
+      throw new DefectModelError(this.model.source, `不存在工作流提交行为`);
+    }
+    return this.entityService.wf.exec(
+      this.model.wfSubmitAction,
+      context,
+      params,
+      data.getRequestData(),
+    );
+  }
+
+  /**
+   * 初始化属性映射
+   *
+   * @author lxm
+   * @date 2022-08-31 18:08:37
+   */
+  protected initUIDataMap() {
+    super.initUIDataMap();
+    // 工作流预置属性映射
+    const wfFields = [
+      'srfwfmemo',
+      'srfnextform',
+      'srfactionparam',
+      'srffrontuf',
+    ];
+
+    // *初始化表单的属性映射
+    this.model.source.getPSDEFormItems()!.forEach(item => {
+      const uiKey = item.id.toLowerCase();
+      const deField = item.getPSAppDEField();
+      let mapField: UIMapField;
+      // 后台实体属性
+
+      if (deField) {
+        const deFieldKey = deField.codeName.toLowerCase();
+        mapField = new UIMapField(uiKey, deFieldKey, {
+          isOriginField: true,
+        });
+      } else {
+        // 前台属性和没属性的表单项，或预置属性
+        mapField = new UIMapField(uiKey, uiKey, {
+          isRequestNeed: wfFields.includes(uiKey), // 工作流相关需要传到后台请求上
+          isOriginField: wfFields.includes(uiKey), // 工作流相关需要存到origin上
+        });
+      }
+      this.dataUIMap.set(uiKey, mapField);
+    });
+  }
+
+  /**
+   * 处理响应
+   *
+   * @author lxm
+   * @date 2022-08-31 17:08:13
+   * @param {IHttpResponse} res
+   * @returns {*}  {IHttpResponse}
+   */
+  handleResponse(response: IHttpResponse): IHttpResponse<ControlVO> {
+    const res = super.handleResponse(response);
+    if (res.ok && res.data) {
+      res.data = this.toUIData(res.data);
+    }
+    return res as IHttpResponse<ControlVO>;
+  }
+}

package/src/service/service/widget/grid-service.ts

@@ -0,0 +1,66 @@
+import { IHttpResponse } from '@ibiz-template/core';
+import { GridModel } from '@ibiz-template/model';
+import { ControlVO } from '../../vo/control.vo';
+import { UIMapField } from '../../vo/ui-map-field';
+import { MDControlService } from './md-control-service';
+
+export class GridService extends MDControlService<GridModel> {
+  /**
+   * 初始化属性映射
+   *
+   * @author lxm
+   * @date 2022-08-31 18:08:37
+   */
+  initUIDataMap() {
+    super.initUIDataMap();
+    // *初始化表格数据项的属性映射
+    this.model.source.getPSDEGridDataItems()?.forEach(column => {
+      const uiKey = column.name.toLowerCase();
+      const deField = column.getPSAppDEField();
+      let mapField: UIMapField;
+      // 后台实体属性
+      if (deField) {
+        const deFieldKey = deField.codeName.toLowerCase();
+        mapField = new UIMapField(uiKey, deFieldKey, {
+          isOriginField: true,
+        });
+      } else {
+        // 前台属性
+        mapField = new UIMapField(uiKey, uiKey, {
+          isRequestNeed: false,
+        });
+      }
+      this.dataUIMap.set(uiKey, mapField);
+    });
+
+    //* 如果属性列和表格数据列名称不一致，补充不一致的属性列的名称映射
+    this.model.fieldColumns.forEach(fieldColumn => {
+      if (fieldColumn.source.dataItemName !== fieldColumn.codeName) {
+        const value = this.dataUIMap.get(fieldColumn.source.dataItemName);
+        if (value) {
+          this.dataUIMap.set(fieldColumn.codeName, value);
+        }
+      }
+    });
+  }
+
+  /**
+   * 编辑列更新
+   *
+   * @author lxm
+   * @date 2022-09-15 21:09:34
+   * @param {string} methodName
+   * @param {IContext} context
+   * @param {IParams} [params={}]
+   * @returns {*}  {Promise<IHttpResponse<ControlVO>>}
+   */
+  async updateGridEditItem(
+    methodName: string,
+    context: IContext,
+    params: IParams = {},
+  ): Promise<IHttpResponse<ControlVO>> {
+    let res = await this.entityService.exec(methodName, context, params);
+    res = this.handleResponse(res);
+    return res as IHttpResponse<ControlVO>;
+  }
+}

package/src/service/service/widget/index.ts

@@ -0,0 +1,6 @@
+export * from './control-service';
+export * from './grid-service';
+export * from './list-service';
+export * from './edit-form-service';
+export * from './search-form-service';
+export * from './md-control-service';