@ibiz-template/runtime 0.0.1-beta.1 → 0.0.1-beta.17

package/src/controller/control/form/search-form.ts

@@ -0,0 +1,117 @@
+import { SearchFormModel } from '@ibiz-template/model';
+import { SearchFormService } from '../../../service';
+import { FormController } from './form';
+import { SearchFormNerve } from '../../neuron';
+import { FormNotifyState } from '../../constant';
+
+/**
+ * 搜索表单控制器
+ *
+ * @author chitanda
+ * @date 2022-08-03 11:08:14
+ * @export
+ * @class SearchFormController
+ * @extends {FormController<SearchFormModel>}
+ */
+export class SearchFormController extends FormController<SearchFormModel> {
+  /**
+   * 搜索表单部件服务
+   *
+   * @author lxm
+   * @date 2022-08-19 13:08:51
+   * @type {EntityService}
+   */
+  service!: SearchFormService;
+
+  declare nerve: SearchFormNerve;
+
+  protected createNerve(): SearchFormNerve {
+    return new SearchFormNerve(this);
+  }
+
+  protected async onInit(): Promise<void> {
+    await super.onInit();
+    // 实例部件服务
+    this.service = new SearchFormService(this.model);
+    await this.service.init(this.context);
+    // 先加载数据，加载完后才会mounted
+    await this.load();
+  }
+
+  /**
+   * 加载草稿
+   *
+   * @author lxm
+   * @date 2022-09-22 17:09:04
+   * @returns {*}  {Promise<IData>}
+   */
+  async load(): Promise<IData> {
+    const res = await this.service.getDraft(this.context, this.params);
+    this.data = res.data;
+    this.isLoaded = true;
+    this.formStateNotify(FormNotifyState.DRAFT);
+    this.force();
+    return this.data;
+  }
+
+  /**
+   * 获取搜索表单的视图过滤参数
+   *
+   * @author lxm
+   * @date 2022-09-22 17:09:21
+   * @returns {*}  {IParams}
+   */
+  getParams(): IParams {
+    return { ...this.data.getRequestData() };
+  }
+
+  /**
+   * 搜索表单按钮回调
+   *
+   * @author lxm
+   * @date 2022-09-22 19:09:07
+   */
+  async onSearchButtonClick(): Promise<void> {
+    await this.nerve.self.evt.asyncEmit('search');
+  }
+
+  /**
+   * 重置搜索表单
+   *
+   * @author lxm
+   * @date 2022-09-22 19:09:07
+   */
+  async reset(): Promise<void> {
+    await this.load();
+    await this.nerve.self.evt.asyncEmit('search');
+  }
+
+  /**
+   * 通知所有表单成员表单操作过程中的数据变更
+   *
+   * @author lxm
+   * @date 2022-09-20 18:09:40
+   * @param {string[]} names
+   */
+  dataChangeNotify(names: string[]): void {
+    super.dataChangeNotify(names);
+    if (this.model.source.enableAutoSearch) {
+      this.nerve.self.evt.asyncEmit('search');
+    }
+  }
+
+  /**
+   * 监听回车事件
+   * @param {IData} event
+   * @return {*}
+   * @author: zhujiamin
+   * @date 2022-09-27 16:48:47
+   */
+  async onKeyUp(event: KeyboardEvent) {
+    const e = event || window.event;
+    //  回车触发搜索
+    if (e && e.code === 'Enter') {
+      await this.onSearchButtonClick();
+    }
+  }
+}

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

@@ -0,0 +1,100 @@
+import { IBizContext } from '@ibiz-template/core';
+import { GridColumnModel } from '@ibiz-template/model';
+import { GridController } from '.';
+
+/**
+ * 表格列控制器
+ * @return {*}
+ * @author: zhujiamin
+ * @Date: 2022-09-01 18:25:20
+ */
+export class GridColumnController<T extends GridColumnModel = GridColumnModel> {
+  /**
+   * 表格列模型对象
+   *
+   * @author lxm
+   * @date 2022-09-05 19:09:07
+   * @type {T}
+   */
+  model: T;
+
+  /**
+   * 表单控制器
+   *
+   * @author lxm
+   * @date 2022-08-24 22:08:59
+   * @type {GridController}
+   */
+  readonly grid: GridController;
+
+  /**
+   * 上下文
+   *
+   * @author lxm
+   * @date 2022-09-05 19:09:24
+   * @readonly
+   * @type {IBizContext}
+   */
+  get context(): IBizContext {
+    return this.grid.context;
+  }
+
+  /**
+   * 视图参数
+   *
+   * @author lxm
+   * @date 2022-09-05 19:09:00
+   * @readonly
+   * @type {IParams}
+   */
+  get params(): IParams {
+    return this.grid.params;
+  }
+
+  /**
+   * 该列是否启用行编辑
+   *
+   * @author lxm
+   * @date 2022-09-06 11:09:58
+   * @readonly
+   */
+  get enableRowEdit() {
+    return (
+      this.grid.model.source.enableRowEdit && this.model.source.enableRowEdit
+    );
+  }
+
+  /**
+   * Creates an instance of GridFieldColumnController.
+   * @author lxm
+   * @date 2022-08-24 20:08:22
+   * @param {T} model
+   */
+  constructor(model: T, grid: GridController) {
+    this.model = model;
+    this.grid = grid;
+  }
+
+  /**
+   * 子类不可覆盖或重写此方法，在 init 时需要重写的使用 onInit 方法。
+   *
+   * @author lxm
+   * @date 2022-08-18 22:08:30
+   * @returns {*}  {Promise<void>}
+   */
+  async init(): Promise<void> {
+    await this.onInit();
+  }
+
+  /**
+   * 初始化方法
+   *
+   * @author lxm
+   * @date 2022-09-28 15:09:15
+   * @protected
+   * @returns {*}  {Promise<void>}
+   */
+  protected async onInit(): Promise<void> {
+    // 初始化操作
+  }
+}

package/src/controller/control/grid/grid-edit-item.ts

@@ -0,0 +1,277 @@
+import { IBizContext, RuntimeError } from '@ibiz-template/core';
+import { GridEditItemModel } from '@ibiz-template/model';
+import Schema from 'async-validator';
+import { GridNotifyState } from '../../constant';
+import { EditorController } from '../../editor';
+import { generateRules } from '../../utils';
+import { GridRowController, GridController } from '.';
+import { IEditorProvider } from '../../interface';
+import { Srfuf } from '../../../service';
+
+/**
+ * 表格编辑项控制器
+ * @return {*}
+ * @author: zhujiamin
+ * @Date: 2022-09-01 18:25:20
+ */
+export class GridEditItemController {
+  /**
+   * 表格列模型对象
+   *
+   * @author lxm
+   * @date 2022-09-05 19:09:07
+   * @type {GridEditItemModel}
+   */
+  model: GridEditItemModel;
+
+  /**
+   * 表格列标题
+   *
+   * @author lxm
+   * @date 2022-09-20 14:09:44
+   * @type {string}
+   */
+  title: string = '';
+
+  /**
+   * 表单控制器
+   *
+   * @author lxm
+   * @date 2022-08-24 22:08:59
+   * @type {GridController}
+   */
+  readonly grid: GridController;
+
+  /**
+   * 编辑器控制器
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:42
+   * @type {EditorController}
+   */
+  editor?: EditorController;
+
+  /**
+   * 编辑器适配器
+   *
+   * @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 2022-09-05 19:09:24
+   * @readonly
+   * @type {IBizContext}
+   */
+  get context(): IBizContext {
+    return this.grid.context;
+  }
+
+  /**
+   * 视图参数
+   *
+   * @author lxm
+   * @date 2022-09-05 19:09:00
+   * @readonly
+   * @type {IParams}
+   */
+  get params(): IParams {
+    return this.grid.params;
+  }
+
+  /**
+   * 是否必填
+   *
+   * @author lxm
+   * @date 2022-09-06 15:09:12
+   * @readonly
+   */
+  get required() {
+    return !this.model.source.allowEmpty;
+  }
+
+  /**
+   * Creates an instance of GridEditItemController.
+   * @author lxm
+   * @date 2022-09-05 19:09:03
+   * @param {GridEditItemModel} model 模型
+   * @param {GridController} grid 表格控制器
+   */
+  constructor(model: GridEditItemModel, grid: GridController) {
+    this.model = model;
+    this.grid = grid;
+  }
+
+  /**
+   * 子类不可覆盖或重写此方法，在 init 时需要重写的使用 onInit 方法。
+   *
+   * @author lxm
+   * @date 2022-08-18 22:08:30
+   * @returns {*}  {Promise<void>}
+   */
+  async init(): Promise<void> {
+    await this.onInit();
+  }
+
+  protected async onInit(): Promise<void> {
+    this.title = this.model.gridFieldColumn?.title || '';
+    // 初始化操作,隐藏项不需要编辑器控制器
+    if (this.model.editor && this.model.editor.editorType !== 'HIDDEN') {
+      this.editorProvider = await ibiz.register.editor.get(this.model.editor);
+      if (this.editorProvider) {
+        this.editor = await this.editorProvider.createController(
+          this.model.editor,
+          this,
+        );
+        await this.editor.init();
+        await this.initRules();
+      }
+    }
+  }
+
+  /**
+   * 初始化值规则
+   *
+   * @author lxm
+   * @date 2022-09-02 09:09:27
+   * @protected
+   * @returns {*}
+   */
+  protected async initRules() {
+    const editItemsVRs = this.model.editItemVRs;
+
+    if (!editItemsVRs) {
+      return;
+    }
+    this.rules = generateRules(
+      editItemsVRs,
+      this.model.codeName,
+      this.model.source.valueItemName,
+    );
+    // 初始化async-validator实例
+    this.validator = new Schema({ [this.model.codeName]: this.rules });
+  }
+
+  /**
+   * 设置行属性的值
+   *
+   * @author lxm
+   * @date 2022-08-24 10:08:40
+   * @param {GridRowController} row 行状态控制器
+   * @param {unknown} value 要设置的值
+   * @param {string} name 要设置的表单数据的属性名称
+   */
+  async setRowValue(row: GridRowController, value: unknown, name?: string) {
+    name = name || this.model.codeName;
+    await this.grid.setRowValue(row, name, value);
+  }
+
+  /**
+   * 通知所有表格编辑项成员表格编辑项数据变更
+   *
+   * @author lxm
+   * @date 2022-09-06 15:09:40
+   * @param {GridRowController} row 行数据控制器
+   * @param {string[]} names 变更属性名称
+   */
+  async dataChangeNotify(
+    row: GridRowController,
+    names: string[],
+  ): Promise<void> {
+    // 刚加载初始化时的值不校验,只校验值项和自身值变更
+    if (
+      names.includes(this.model.codeName) ||
+      names.includes(this.model.source.valueItemName)
+    ) {
+      const result = await this.validate(row);
+      // todo校验不通过是否报错
+      if (!result) {
+        throw new RuntimeError(`${this.model.codeName}校验报错`);
+      }
+    }
+
+    // 有编辑列更新，且是自身变更时，触发编辑列更新
+    if (names.includes(this.model.codeName) && this.model.gridItemUpdate) {
+      const { methodName, itemNames } = this.model.gridItemUpdate;
+      await this.grid.updateGridEditItem(row, methodName, itemNames);
+    }
+  }
+
+  /**
+   * 表格状态变更通知
+   *
+   * @author lxm
+   * @date 2022-09-20 18:09:07
+   */
+  gridStateNotify(row: GridRowController, _state: GridNotifyState): void {
+    this.calcEnableCond(row);
+  }
+
+  /**
+   * 计算启用项的禁用
+   *
+   * @author lxm
+   * @date 2022-09-20 00:09:57
+   * @returns {*}
+   */
+  calcEnableCond(row: GridRowController) {
+    const { enableCond } = this.model.source;
+    const isNew = row.data.srfuf === Srfuf.CREATE;
+    if (enableCond === 0) {
+      row.columnState[this.model.codeName]!.disabled = true;
+    } else if ((isNew && enableCond === 2) || (!isNew && enableCond === 1)) {
+      row.columnState[this.model.codeName]!.disabled = true;
+    }
+  }
+
+  /**
+   * 表格编辑项值规则校验
+   * 如果表格编辑项不显示则不校验直接返回true
+   *
+   * @author lxm
+   * @date 2022-09-01 22:09:29
+   */
+  async validate(row: GridRowController): Promise<boolean> {
+    const editName = this.model.codeName;
+    // 表格单元格行编辑不支持必填校验
+    // if (this.required && isNilOrEmpty(row.data[editName])) {
+    //   row.errors[editName] = `请填写${this.title}`;
+    //   return false;
+    // }
+
+    if (this.validator) {
+      try {
+        await this.validator.validate(row.data);
+      } catch ({ errors, _fields }) {
+        row.errors[editName] = (errors as IData[])[0].message;
+        return false;
+      }
+    }
+    row.errors[editName] = null;
+    return true;
+  }
+}

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

@@ -0,0 +1,130 @@
+import { RuntimeError, IBizContext } from '@ibiz-template/core';
+import { GridFieldColumnModel } from '@ibiz-template/model';
+import { clone } from 'ramda';
+import { GridColumnController, GridRowController } from '.';
+import { OpenAppViewCommand } from '../../../command';
+import { CodeListItem } from '../../../service';
+
+/**
+ * 表格属性列控制器
+ * @return {*}
+ * @author: zhujiamin
+ * @Date: 2022-09-01 18:25:20
+ */
+export class GridFieldColumnController extends GridColumnController<GridFieldColumnModel> {
+  /**
+   * 代码表项
+   *
+   * @author lxm
+   * @date 2022-09-28 16:09:51
+   * @type {readonly}
+   */
+  codeListItems?: readonly CodeListItem[];
+
+  /**
+   * 是否是链接列
+   *
+   * @author lxm
+   * @date 2022-09-28 17:09:15
+   * @returns {*}
+   */
+  get isLinkColumn(): boolean {
+    return this.model.source.enableLinkView && !!this.model.linkView;
+  }
+
+  /**
+   * 是否有触发界面行为
+   *
+   * @author lxm
+   * @date 2022-12-08 14:12:37
+   * @readonly
+   * @type {boolean}
+   */
+  get hasAction(): boolean {
+    return !!this.model.source.getPSDEUIAction();
+  }
+
+  /**
+   * 行是否可点击（影响列的界面样式）
+   *
+   * @author lxm
+   * @date 2022-12-08 15:12:58
+   * @readonly
+   */
+  get clickable() {
+    return this.isLinkColumn || this.hasAction;
+  }
+
+  /**
+   * 打开链接视图
+   *
+   * @author lxm
+   * @date 2022-09-28 18:09:14
+   * @param {GridRowController} row 行数据
+   * @param {MouseEvent} event 原生事件
+   * @returns {*}  {Promise<void>}
+   */
+  async openLinkView(row: GridRowController, event: MouseEvent): Promise<void> {
+    const valueItem = this.model.source.linkValueItem || 'srfkey';
+    const value = row.data[valueItem];
+    if (!value) {
+      throw new RuntimeError('链接值项取不到值');
+    }
+    const { linkView } = this.model;
+    const deName = linkView?.appEntity.deName;
+    const newContext = new IBizContext({ [deName!]: value }, this.context);
+    const newParams = clone(this.params);
+    // 打开视图
+    await ibiz.commands.execute(
+      OpenAppViewCommand.TAG,
+      linkView!.source,
+      newContext,
+      newParams,
+      { event },
+    );
+  }
+
+  /**
+   * 触发表格列附加界面行为
+   *
+   * @author lxm
+   * @date 2022-12-08 15:12:35
+   * @param {GridRowController} row 行数据
+   * @param {MouseEvent} event 鼠标事件
+   * @returns {*}  {Promise<void>}
+   */
+  async triggerAction(
+    row: GridRowController,
+    event: MouseEvent,
+  ): Promise<void> {
+    if (this.model.viewLogic) {
+      await this.grid.nerve.self.evt.asyncEmit(
+        'actionClick',
+        this.model.viewLogic,
+        [row.data],
+        event,
+      );
+    }
+  }
+
+  /**
+   * 加载代码表数据
+   *
+   * @author lxm
+   * @date 2022-09-28 15:09:38
+   * @returns {*}
+   */
+  async loadCodeList(): Promise<readonly CodeListItem[] | undefined> {
+    const codeList = this.model.source.getPSAppCodeList();
+    if (!codeList) {
+      return;
+    }
+    const dataItems = await ibiz.codeListService.get(
+      codeList.codeName,
+      this.context,
+      this.params,
+    );
+    this.codeListItems = dataItems;
+    return dataItems;
+  }
+}

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

@@ -0,0 +1,54 @@
+import { GridEditItemModel } from '@ibiz-template/model';
+import { GridEditItemController } from './grid-edit-item';
+import { GridFieldColumnController } from './grid-field-column';
+
+/**
+ * 表格属性列(开启行编辑)控制器
+ * @return {*}
+ * @author: zhujiamin
+ * @Date: 2022-09-01 18:25:20
+ */
+export class GridFieldEditColumnController extends GridFieldColumnController {
+  /**
+   * 表格编辑项控制器
+   *
+   * @author lxm
+   * @date 2022-11-14 15:11:57
+   * @type {GridEditItemController}
+   */
+  editItem!: GridEditItemController;
+
+  /**
+   * 初始化方法，生成表格编辑项控制器
+   *
+   * @author lxm
+   * @date 2022-11-14 13:11:33
+   * @protected
+   * @returns {*}  {Promise<void>}
+   */
+  protected async onInit(): Promise<void> {
+    await super.onInit();
+    const { editItem } = this.model;
+    if (editItem) {
+      this.editItem = await this.createEditItemController(editItem);
+      this.grid.editItems[editItem.codeName] = this.editItem;
+    }
+  }
+
+  /**
+   * 创建并初始化表格编辑项控制器
+   *
+   * @author lxm
+   * @date 2022-11-14 14:11:29
+   * @protected
+   * @param {GridEditItemModel} editItem
+   * @returns {*}  {Promise<GridEditItemController>}
+   */
+  protected async createEditItemController(
+    editItem: GridEditItemModel,
+  ): Promise<GridEditItemController> {
+    const editItemC = new GridEditItemController(editItem, this.grid);
+    await editItemC.init();
+    return editItemC;
+  }
+}