@ibiz-template/runtime 0.1.10 → 0.1.12-dev.0

package/src/controller/control/grid/grid/grid.service.ts

@@ -0,0 +1,71 @@
+import { IHttpResponse } from '@ibiz-template/core';
+import { IDEGrid } from '@ibiz/model-core';
+import { MDControlService, UIMapField, ControlVO } from '../../../../service';
+
+/**
+ * 表格部件服务
+ * @author lxm
+ * @date 2023-05-15 09:53:35
+ * @export
+ * @class GridService
+ * @extends {MDControlService<IDEGrid>}
+ */
+export class GridService extends MDControlService<IDEGrid> {
+  /**
+   * 初始化属性映射
+   *
+   * @author lxm
+   * @date 2022-08-31 18:08:37
+   */
+  initUIDataMap(): void {
+    super.initUIDataMap();
+    // *初始化表格数据项的属性映射
+    this.model.degridDataItems?.forEach(column => {
+      const uiKey = column.id!.toLowerCase();
+      // todo
+      const deField = column.appDEFieldId;
+      let mapField: UIMapField;
+      // 后台实体属性
+      if (deField) {
+        const deFieldKey = deField.toLowerCase();
+        mapField = new UIMapField(uiKey, deFieldKey, {
+          isOriginField: true,
+        });
+      } else {
+        // 前台属性
+        mapField = new UIMapField(uiKey, uiKey);
+      }
+      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 {IParams} context
+   * @param {IParams} [params={}]
+   * @returns {*}  {Promise<IHttpResponse<ControlVO>>}
+   */
+  async updateGridEditItem(
+    methodName: string,
+    context: IParams,
+    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/controller/control/grid/grid/index.ts

@@ -0,0 +1,4 @@
+export * from './grid-column.controller';
+export * from './grid-row.state';
+export * from './grid.controller';
+export * from './grid.service';

package/src/controller/control/grid/grid-column/grid-field-column/grid-field-column.controller.ts

@@ -0,0 +1,270 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { ModelError } from '@ibiz-template/core';
+import { IAppCodeList, IDEGridFieldColumn } from '@ibiz/model-core';
+import { clone } from 'ramda';
+import { OpenAppViewCommand } from '../../../../../command';
+import { CodeListItem, IModalData } from '../../../../../interface';
+import { parseUserParams } from '../../../../../model';
+import { convertNavData, getWFContext } from '../../../../../utils';
+import { GridColumnController } from '../../grid/grid-column.controller';
+import { GridRowState } from '../../grid/grid-row.state';
+
+/**
+ * 表格属性列控制器
+ * @return {*}
+ * @author: zhujiamin
+ * @Date: 2022-09-01 18:25:20
+ */
+export class GridFieldColumnController extends GridColumnController<IDEGridFieldColumn> {
+  /**
+   * 代码表项
+   *
+   * @author lxm
+   * @date 2022-09-28 16:09:51
+   * @type {readonly}
+   */
+  codeListItems?: readonly CodeListItem[];
+
+  /**
+   * 代码表模型
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-05-24 10:55:50
+   */
+  codeList: IAppCodeList | undefined = undefined;
+
+  /**
+   * 是否是链接列
+   *
+   * @author lxm
+   * @date 2022-09-28 17:09:15
+   * @returns {*}
+   */
+  get isLinkColumn(): boolean {
+    return !!this.model.enableLinkView && !!this.model.linkAppViewId;
+  }
+
+  /**
+   * 是否有触发界面行为
+   *
+   * @author lxm
+   * @date 2022-12-08 14:12:37
+   * @readonly
+   * @type {boolean}
+   */
+  get hasAction(): boolean {
+    return !!this.model.deuiactionId;
+  }
+
+  /**
+   * 行是否可点击（影响列的界面样式）
+   *
+   * @author lxm
+   * @date 2022-12-08 15:12:58
+   * @readonly
+   */
+  clickable(row: GridRowState): boolean {
+    const value = row.data[this.model.codeName!];
+    return (this.isLinkColumn || this.hasAction) && value;
+  }
+
+  /**
+   * 公共参数处理，计算上下文和视图参数
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2022-08-25 15:44:14
+   */
+  public handlePublicParams(
+    data: IData,
+    context: IContext,
+    params: IParams,
+  ): { context: IContext; params: IParams } {
+    // todo 从userParams里转出导航参数
+    const { userParam } = this.model;
+    if (!userParam) {
+      return { context, params };
+    }
+    const { navigateContexts, navigateParams } = parseUserParams(userParam);
+    let selfContext = {};
+    if (navigateContexts && data) {
+      selfContext = convertNavData(navigateContexts!, context, params, data);
+    }
+    const _context = Object.assign(context.clone(), selfContext);
+    let selfParams = {};
+    if (navigateParams && data) {
+      selfParams = convertNavData(navigateParams!, context, params, data);
+    }
+    const _params: IParams = { ...params, ...selfParams };
+    return { context: _context, params: _params };
+  }
+
+  /**
+   * 打开链接视图
+   *
+   * @author lxm
+   * @date 2022-09-28 18:09:14
+   * @param {GridRowState} row 行数据
+   * @param {MouseEvent} event 原生事件
+   * @returns {*}  {Promise<void>}
+   */
+  async openLinkView(row: GridRowState, event: MouseEvent): Promise<void> {
+    const curValue = row.data[this.model.codeName!];
+    if (!curValue) {
+      // 当前值不存在，不继续走打开链接视图逻辑
+      return;
+    }
+    const valueItem = this.model.linkValueItem || 'srfkey';
+    const value = row.data[valueItem];
+    if (value == null) {
+      throw new ModelError(this.model, `未在行数据中取到 ${valueItem} 的值`);
+    }
+    const { linkAppViewId } = this.model;
+    if (!linkAppViewId) {
+      return;
+    }
+    const wfContext = getWFContext(row.data);
+    const tempContext = Object.assign(this.context.clone(), {
+      srfkey: value,
+      ...wfContext,
+    });
+    const tempParams = clone(this.params);
+    const { context: newContext, params: newParams } = this.handlePublicParams(
+      row.data,
+      tempContext,
+      tempParams,
+    );
+    // 打开视图
+    const res: IModalData = await ibiz.commands.execute(
+      OpenAppViewCommand.TAG,
+      linkAppViewId,
+      newContext,
+      newParams,
+      { event },
+    );
+    if (res?.ok) {
+      this.grid.load();
+    }
+  }
+
+  /**
+   * 触发表格列附加界面行为
+   *
+   * @author lxm
+   * @date 2022-12-08 15:12:35
+   * @param {GridRowState} row 行数据
+   * @param {MouseEvent} event 鼠标事件
+   * @returns {*}  {Promise<void>}
+   */
+  async triggerAction(_row: GridRowState, _event: MouseEvent): Promise<void> {
+    // if (this.model.viewLogic) {
+    //   await executeViewLogic(
+    //     this.model.viewLogic,
+    //     this.context,
+    //     [row.data],
+    //     this.params,
+    //     {
+    //       event,
+    //       neuron: this.grid.nerve.self,
+    //       view: this.grid.ctx.view,
+    //     },
+    //   );
+    // }
+  }
+
+  /**
+   * 加载代码表数据
+   *
+   * @author lxm
+   * @date 2022-09-28 15:09:38
+   * @returns {*}
+   */
+  async loadCodeList(): Promise<Readonly<CodeListItem[]> | undefined> {
+    const appCodeListId = this.model.appCodeListId!;
+    if (!appCodeListId) {
+      return;
+    }
+    const app = ibiz.hub.getApp(this.context.srfappid);
+
+    // 顺便加载代码表模型
+    if (!this.codeList) {
+      this.codeList = app.codeList.getCodeList(appCodeListId);
+    }
+
+    const dataItems = await app.codeList.get(
+      appCodeListId,
+      this.context,
+      this.params,
+    );
+    this.codeListItems = dataItems;
+    return dataItems;
+  }
+
+  /**
+   * 计算聚合属性列的值
+   * 无配置返回undefined
+   * @author lxm
+   * @date 2023-08-07 04:50:47
+   * @param {IData[]} items
+   * @return {*}  {(string | undefined)}
+   */
+  calcFieldAgg(items: IData[]): string | undefined {
+    const { aggField, aggMode, aggValueFormat } = this.model;
+    // 无聚合配置的列，返回undefined
+    if (aggMode === 'NONE') {
+      return;
+    }
+    const fieldName = aggField || this.model.id!;
+    let aggValue: number;
+    if (this.grid.model.aggMode === 'PAGE') {
+      switch (aggMode) {
+        case 'SUM':
+          aggValue = items
+            .map(item => item[fieldName] as number)
+            .reduce((a, b) => a + b, 0);
+          break;
+        case 'AVG':
+          aggValue =
+            items
+              .map(item => item[fieldName] as number)
+              .reduce((a, b) => a + b, 0) / items.length;
+          break;
+        case 'MAX':
+          aggValue = Math.max(...items.map(item => item[fieldName] as number));
+          break;
+        case 'MIN':
+          aggValue = Math.min(...items.map(item => item[fieldName] as number));
+          break;
+        default:
+          throw new ModelError(this.model, `暂未支持属性列聚合模式${aggMode}`);
+      }
+    } else if (this.grid.model.aggMode === 'ALL') {
+      // if (!this.grid.state.remoteAggResult) {
+      //   throw new RuntimeError(`没有远程聚合数据`);
+      // }
+      // aggValue = this.grid.state.remoteAggResult[fieldName];
+      // if (!aggValue) {
+      //   throw new RuntimeError(`远程聚合数据里缺少${fieldName}的值`);
+      // }
+      throw new ModelError(this.model, `远程聚合暂未支持`);
+    } else {
+      throw new ModelError(
+        this.grid.model,
+        `暂未支持聚合模式${this.grid.model.aggMode}`,
+      );
+    }
+    if (!aggValueFormat) {
+      return `${aggValue}`;
+    }
+
+    // 聚合值格式化
+    const formatValue: string = '';
+    switch (aggValueFormat) {
+      default:
+        throw new ModelError(
+          this.model,
+          `暂未支持${aggValueFormat}的聚合值格式化`,
+        );
+    }
+    return formatValue;
+  }
+}

package/src/controller/control/grid/grid-column/grid-field-column/index.ts

@@ -0,0 +1 @@
+export * from './grid-field-column.controller';

package/src/controller/control/grid/grid-column/grid-field-edit-column/grid-field-edit-column.controller.ts

@@ -0,0 +1,364 @@
+/* eslint-disable no-param-reassign */
+import { RuntimeError } from '@ibiz-template/core';
+import { IValueItemEditor, IDEGridEditItem } from '@ibiz/model-core';
+import Schema from 'async-validator';
+import { isNilOrEmpty } from 'qx-util';
+import {
+  IEditorContainerController,
+  IEditorController,
+  IEditorProvider,
+} from '../../../../../interface';
+import { findEditItem } from '../../../../../model';
+import { getEditorProvider } from '../../../../../register';
+import { Srfuf } from '../../../../../service';
+import { filterValueRules } from '../../../../../utils';
+import { GridNotifyState } from '../../../../constant';
+import { generateRules } from '../../../../utils';
+import { GridRowState } from '../../grid/grid-row.state';
+import { GridFieldColumnController } from '../grid-field-column';
+
+/**
+ * 表格属性列(开启行编辑)控制器
+ * @return {*}
+ * @author: zhujiamin
+ * @Date: 2022-09-01 18:25:20
+ */
+export class GridFieldEditColumnController
+  extends GridFieldColumnController
+  implements IEditorContainerController
+{
+  /**
+   * 表格编辑项模型
+   *
+   * @author lxm
+   * @date 2022-11-14 15:11:57
+   * @type {IDEGridEditItem}
+   */
+  editItem!: IDEGridEditItem;
+
+  /**
+   * 编辑器控制器
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:42
+   * @type {IEditorController}
+   */
+  editor!: IEditorController;
+
+  /**
+   * 编辑器适配器
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:42
+   * @type {EditorController}
+   */
+  editorProvider?: IEditorProvider;
+
+  /**
+   * 值规则
+   *
+   * @author lxm
+   * @date 2022-09-01 22:09:49
+   * @type {IData}
+   */
+  rules: IData = [];
+
+  /**
+   * 表格编辑项校验器实例
+   *
+   * @author lxm
+   * @date 2022-09-04 18:09:56
+   * @private
+   * @type {Schema}
+   */
+  private validator!: Schema;
+
+  /**
+   * 单位
+   * @author lxm
+   * @date 2023-05-24 05:46:52
+   * @readonly
+   * @type {(string | undefined)}
+   */
+  get unitName(): string | undefined {
+    return this.editItem.unitName;
+  }
+
+  /**
+   * 值格式化
+   * @author lxm
+   * @date 2023-05-24 05:46:56
+   * @readonly
+   * @type {(string | undefined)}
+   */
+  get valueFormat(): string | undefined {
+    return this.model.valueFormat;
+  }
+
+  /**
+   * 值项
+   * @author lxm
+   * @date 2023-05-31 02:31:27
+   * @readonly
+   * @type {(string | undefined)}
+   */
+  get valueItemName(): string | undefined {
+    if (this.editItem.editor) {
+      return (this.editItem.editor as IValueItemEditor).valueItemName;
+    }
+    return undefined;
+  }
+
+  /**
+   * 列数据属性字段名称
+   * @author lxm
+   * @date 2023-06-25 09:26:04
+   * @readonly
+   */
+  get fieldName(): string {
+    return this.model.dataItemName!;
+  }
+
+  /**
+   * 初始化方法，生成表格编辑项控制器
+   *
+   * @author lxm
+   * @date 2022-11-14 13:11:33
+   * @protected
+   * @returns {*}  {Promise<void>}
+   */
+  protected async onInit(): Promise<void> {
+    await super.onInit();
+
+    const editItem = findEditItem(this.grid.model, this.model.codeName!);
+    if (editItem) {
+      this.editItem = editItem;
+      // 初始化操作,隐藏项不需要编辑器控制器
+      if (
+        this.editItem.editor &&
+        this.editItem.editor.editorType !== 'HIDDEN'
+      ) {
+        this.editorProvider = await getEditorProvider(this.editItem.editor);
+        if (this.editorProvider) {
+          this.editor = await this.editorProvider.createController(
+            this.editItem.editor,
+            this,
+          );
+          await this.initRules();
+        }
+      }
+    }
+  }
+
+  /**
+   * 初始化值规则
+   *
+   * @author lxm
+   * @date 2022-09-02 09:09:27
+   * @protected
+   * @returns {*}
+   */
+  protected async initRules(): Promise<void> {
+    const editItemsVRs = filterValueRules(
+      this.grid.model.degridEditItemVRs || [],
+      this.fieldName,
+    );
+    if (!editItemsVRs) {
+      return;
+    }
+    this.rules = generateRules(
+      editItemsVRs,
+      this.fieldName,
+      this.valueItemName,
+    );
+    // 初始化async-validator实例
+    this.validator = new Schema({ [this.fieldName]: this.rules });
+  }
+
+  /**
+   * 设置行属性的值
+   *
+   * @author lxm
+   * @date 2022-08-24 10:08:40
+   * @param {GridRowState} row 行状态控制器
+   * @param {unknown} value 要设置的值
+   * @param {string} name 要设置的表单数据的属性名称
+   */
+  async setRowValue(
+    row: GridRowState,
+    value: unknown,
+    name?: string,
+  ): Promise<void> {
+    name = name || this.fieldName;
+    await this.grid.setRowValue(row, name, value);
+  }
+
+  /**
+   * 通知所有表格编辑项成员表格编辑项数据变更
+   *
+   * @author lxm
+   * @date 2022-09-06 15:09:40
+   * @param {GridRowState} row 行数据控制器
+   * @param {string[]} names 变更属性名称
+   */
+  async dataChangeNotify(row: GridRowState, names: string[]): Promise<void> {
+    // 计算禁用状态
+    this.calcColumnDisabled(row);
+
+    // 计算必填状态
+    const oldRequired = row.editColStates[this.fieldName].required;
+    this.calcColumnRequired(row);
+    const requiredChanged =
+      oldRequired !== row.editColStates[this.fieldName].required;
+
+    // 保存前由保存调用校验，其他只有值项和自身值变化时校验
+    // 必填发生变更时也校验
+    if (
+      requiredChanged ||
+      names.includes(this.fieldName) ||
+      names.includes(this.valueItemName!)
+    ) {
+      const result = await this.validate(row);
+      // todo校验不通过是否报错
+      if (!result) {
+        throw new RuntimeError(
+          `${this.editItem.codeName}校验报错,${row.errors[this.fieldName]}`,
+        );
+      }
+    }
+
+    // 有编辑列更新，且是自身变更时，触发编辑列更新
+    if (
+      names.includes(this.fieldName) &&
+      this.editItem.degridEditItemUpdateId
+    ) {
+      await this.grid.updateGridEditItem(
+        row,
+        this.editItem.degridEditItemUpdateId,
+      );
+    }
+  }
+
+  /**
+   * 表格状态变更通知
+   *
+   * @author lxm
+   * @date 2022-09-20 18:09:07
+   */
+  gridStateNotify(row: GridRowState, _state: GridNotifyState): void {
+    this.calcColumnDisabled(row);
+    this.calcColumnReadonly(row);
+    this.calcColumnRequired(row);
+  }
+
+  /**
+   * 计算列的禁用状态
+   * @author lxm
+   * @date 2023-06-26 06:19:00
+   * @param {GridRowState} row
+   */
+  calcColumnDisabled(row: GridRowState): void {
+    let enable = this.calcEnableCond(row);
+
+    // 上层计算为启用时计算预定义项启用逻辑
+    if (enable && this.grid.scheduler) {
+      const itemEnable = this.grid.scheduler.triggerItemEnable(this.fieldName, {
+        data: [row.data],
+      });
+      if (itemEnable !== undefined) {
+        enable = itemEnable;
+      }
+    }
+
+    // 修改state
+    row.editColStates[this.fieldName]!.disabled = !enable;
+  }
+
+  /**
+   * 计算列的必填状态
+   * @author lxm
+   * @date 2023-06-26 06:23:25
+   * @param {GridRowState} row
+   */
+  calcColumnRequired(row: GridRowState): void {
+    let allowEmpty = this.editItem.allowEmpty !== false;
+
+    if (allowEmpty && this.grid.scheduler) {
+      const itemBlank = this.grid.scheduler.triggerItemBlank(this.fieldName, {
+        data: [row.data],
+      });
+      if (itemBlank !== undefined) {
+        allowEmpty = itemBlank;
+      }
+    }
+    // 修改state
+    row.editColStates[this.fieldName]!.required = !allowEmpty;
+  }
+
+  /**
+   * 计算列的只读状态
+   * @author lxm
+   * @date 2023-06-26 06:19:00
+   * @param {GridRowState} row
+   */
+  calcColumnReadonly(row: GridRowState): void {
+    const isReadOnly = !!this.editItem.editor?.readOnly;
+    // 修改state
+    row.editColStates[this.fieldName]!.readonly = isReadOnly;
+  }
+
+  /**
+   * 计算启用项的禁用
+   * 启用返回true,不启用返回false
+   *
+   * @author lxm
+   * @date 2022-09-20 00:09:57
+   * @returns {*}
+   */
+  calcEnableCond(row: GridRowState): boolean {
+    const { enableCond } = this.editItem;
+    const isNew = row.data.srfuf === Srfuf.CREATE;
+    switch (enableCond) {
+      case 0: // 不启用
+        return false;
+      case 1: // 新建启用
+        return isNew;
+      case 2: // 更新启用
+        return !isNew;
+      default: // 全部启用
+        return true;
+    }
+  }
+
+  /**
+   * 表格编辑项值规则校验
+   * 如果表格编辑项不显示则不校验直接返回true
+   *
+   * @author lxm
+   * @date 2022-09-01 22:09:29
+   */
+  async validate(row: GridRowState): Promise<boolean> {
+    const editName = this.fieldName;
+    // 表格单元格行编辑不支持必填校验
+    if (
+      ibiz.config.grid.editShowMode !== 'cell' &&
+      row.editColStates[editName]!.required &&
+      isNilOrEmpty(row.data[editName])
+    ) {
+      row.errors[editName] = `请填写${this.model.caption || ''}`;
+      return false;
+    }
+
+    if (this.rules.length && this.validator) {
+      try {
+        await this.validator.validate(row.data);
+      } catch (error) {
+        const { errors } = error as IData;
+        row.errors[editName] = (errors as IData[])[0].message;
+        return false;
+      }
+    }
+    row.errors[editName] = null;
+    return true;
+  }
+}

package/src/controller/control/grid/grid-column/grid-field-edit-column/index.ts

@@ -0,0 +1 @@
+export * from './grid-field-edit-column.controller';