@ibiz-template/runtime 0.7.41-alpha.11 → 0.7.41-alpha.110

package/src/controller/control/form/form-detail/form-rawitem/form-rawitem.controller.ts

@@ -0,0 +1,22 @@
+import { IDEFormRawItem } from '@ibiz/model-core';
+import { FormDetailController } from '../form-detail';
+import { FormRawItemState } from './form-rawitem.state';
+import { IApiFormRawItemController } from '../../../../../interface';
+
+/**
+ * @description 表单直接内容控制器
+ * @export
+ * @class FormRawItemController
+ * @extends {FormDetailController<IDEFormRawItem>}
+ * @implements {IApiFormRawItemController}
+ */
+export class FormRawItemController
+  extends FormDetailController<IDEFormRawItem>
+  implements IApiFormRawItemController
+{
+  declare state: FormRawItemState;
+
+  protected createState(): FormRawItemState {
+    return new FormRawItemState(this.parent?.state);
+  }
+}

package/src/controller/control/form/form-detail/form-rawitem/form-rawitem.state.ts

@@ -0,0 +1,13 @@
+import { IApiFormRawItemState } from '../../../../../interface';
+import { FormDetailState } from '../form-detail';
+
+/**
+ * @description 表单直接内容状态
+ * @export
+ * @class FormRawItemState
+ * @extends {FormDetailState}
+ * @implements {IApiFormRawItemState}
+ */
+export class FormRawItemState
+  extends FormDetailState
+  implements IApiFormRawItemState {}

package/src/controller/control/form/form-detail/form-rawitem/index.ts

@@ -0,0 +1,2 @@
+export * from './form-rawitem.controller';
+export * from './form-rawitem.state';

package/src/controller/control/form/form-detail/form-tab-page/form-tab-page.controller.ts

@@ -0,0 +1,37 @@
+import { IDEFormTabPage } from '@ibiz/model-core';
+import { FormTabPageState } from './form-tab-page.state';
+import { FormTabPanelController } from '../form-tab-panel';
+import { IApiFormTabPageController } from '../../../../../interface';
+import { FormContainerController } from '../form-container';
+
+/**
+ * 表单分页部件分页控制器
+ *
+ * @author lxm
+ * @date 2022-09-04 15:09:52
+ * @export
+ * @class FormTabPageController
+ * @extends {FormContainerController}
+ */
+export class FormTabPageController
+  extends FormContainerController<IDEFormTabPage>
+  implements IApiFormTabPageController
+{
+  declare state: FormTabPageState;
+
+  protected createState(): FormTabPageState {
+    return new FormTabPageState(this.parent?.state);
+  }
+
+  /**
+   * @description 是否激活的分页
+   * @readonly
+   * @type {boolean}
+   * @memberof FormTabPageController
+   */
+  get isActive(): boolean {
+    return (
+      (this.parent as FormTabPanelController).state.activeTab === this.model.id
+    );
+  }
+}

package/src/controller/control/form/form-detail/form-tab-page/form-tab-page.state.ts

@@ -0,0 +1,13 @@
+import { IApiFormTabPageState } from '../../../../../interface';
+import { FormContainerState } from '../form-container';
+
+/**
+ * @description 表单分页部件分页状态
+ * @export
+ * @class FormTabPageState
+ * @extends {FormContainerState}
+ * @implements {IApiFormTabPageState}
+ */
+export class FormTabPageState
+  extends FormContainerState
+  implements IApiFormTabPageState {}

package/src/controller/control/form/form-detail/form-tab-page/index.ts

@@ -0,0 +1,2 @@
+export * from './form-tab-page.controller';
+export * from './form-tab-page.state';

package/src/controller/control/form/form-detail/form-tab-panel/form-tab-panel.controller.ts

@@ -0,0 +1,141 @@
+import { IDEFormTabPanel } from '@ibiz/model-core';
+import { FormTabPanelState } from './form-tab-panel.state';
+import { AppCounter } from '../../../../../service';
+import { FormTabPageController } from '../form-tab-page';
+import { IApiFormTabPanelController } from '../../../../../interface';
+import { FormContainerController } from '../form-container';
+import { FormNotifyState } from '../../../../constant';
+
+/**
+ * @description 表单分页部件控制器
+ * @export
+ * @class FormTabPanelController
+ * @extends {FormContainerController<IDEFormTabPanel>}
+ * @implements {IApiFormTabPanelController}
+ */
+export class FormTabPanelController
+  extends FormContainerController<IDEFormTabPanel>
+  implements IApiFormTabPanelController
+{
+  declare state: FormTabPanelState;
+
+  /**
+   * @description 缓存标识
+   * @readonly
+   * @type {string}
+   * @memberof FormTabPanelController
+   */
+  get srfcachekeytempl(): string {
+    return `${this.form.srfcachekeytempl}_${this.model.codeName}_${this.form.data.tempsrfkey}`;
+  }
+
+  protected createState(): FormTabPanelState {
+    return new FormTabPanelState(this.parent?.state);
+  }
+
+  protected async onInit(): Promise<void> {
+    await super.onInit();
+    // 初始化默认的激活分页
+    this.state.activeTab = this.model.deformTabPages?.[0].id || '';
+  }
+
+  /**
+   * @description 表单状态变更通知
+   * @param {FormNotifyState} state
+   * @returns {*}  {Promise<void>}
+   * @memberof FormTabPanelController
+   */
+  async formStateNotify(state: FormNotifyState): Promise<void> {
+    super.formStateNotify(state);
+    if ([FormNotifyState.LOAD, FormNotifyState.DRAFT].includes(state)) {
+      const cacheTabId = localStorage.getItem(this.srfcachekeytempl);
+      if (this.form.srfCachePos && cacheTabId) {
+        const isExist = this.model.deformTabPages?.some(
+          page => page.id === cacheTabId,
+        );
+        if (isExist) this.state.activeTab = cacheTabId;
+      }
+    }
+  }
+
+  /**
+   * @description 初始化计数器
+   * @protected
+   * @returns {*}  {void}
+   * @memberof FormTabPanelController
+   */
+  protected initCounter(): void {
+    const tabPage = this.model.deformTabPages?.find(
+      _item => !!_item.appCounterRefId,
+    );
+    if (!tabPage) return;
+    const { counters } = this.form;
+    const { appCounterRefId } = tabPage;
+    if (appCounterRefId) {
+      this.counter = counters[appCounterRefId];
+      this.counter?.onChange(this.handleCounterChange);
+    }
+  }
+
+  /**
+   * 分页点击切换处理
+   * @author lxm
+   * @date 2024-01-17 02:59:38
+   * @param {string} tabId
+   * @deprecated
+   */
+  onTabChange(tabId: string): void {
+    this.state.activeTab = tabId;
+    if (this.form.srfCachePos)
+      localStorage.setItem(`${this.srfcachekeytempl}`, tabId);
+  }
+
+  /**
+   * @description 切换激活分页
+   * @param {string} tabId 分页id
+   * @memberof FormTabPanelController
+   */
+  selectTab(tabId: string): void {
+    this.state.activeTab = tabId;
+  }
+
+  /**
+   * 根据id去表单控制器里取得计数器对象
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2023-07-10 15:14:21
+   */
+  getCounter(id: string): AppCounter | null {
+    const { counters } = this.form;
+    if (counters && counters[id]) {
+      return counters[id];
+    }
+    return null;
+  }
+
+  /**
+   * 更新激活的分页
+   *
+   * @author zhanghengfeng
+   * @date 2025-02-05 20:02:55
+   * @return {*}  {void}
+   */
+  updateActiveTab(): void {
+    if (!this.state.visible) {
+      return;
+    }
+    const activeTab = this.form.details[this.state.activeTab];
+    if (activeTab && !activeTab.state.visible) {
+      const children: FormTabPageController[] = [];
+      this.model.deformTabPages?.forEach(item => {
+        if (item.id && this.form.details[item.id]) {
+          children.push(this.form.details[item.id] as FormTabPageController);
+        }
+      });
+      const child = children.find(item => item.state.visible);
+      if (child && child.model.id) {
+        this.state.activeTab = child.model.id;
+      }
+    }
+  }
+}

package/src/controller/control/form/form-detail/form-tab-panel/form-tab-panel.state.ts

@@ -0,0 +1,21 @@
+import { IApiFormTabPanelState } from '../../../../../interface';
+import { FormContainerState } from '../form-container';
+
+/**
+ * @description 表单分页部件状态
+ * @export
+ * @class FormTabPanelState
+ * @extends {FormContainerState}
+ * @implements {IApiFormTabPanelState}
+ */
+export class FormTabPanelState
+  extends FormContainerState
+  implements IApiFormTabPanelState
+{
+  /**
+   * @description 当前激活的分页
+   * @type {string}
+   * @memberof FormTabPanelState
+   */
+  activeTab: string = '';
+}

package/src/controller/control/form/form-detail/form-tab-panel/index.ts

@@ -0,0 +1,2 @@
+export * from './form-tab-panel.controller';
+export * from './form-tab-panel.state';

package/src/controller/control/form/form-detail/index.ts

@@ -0,0 +1,13 @@
+export * from './form-button/index';
+export * from './form-detail/index';
+export * from './form-druipart/index';
+export * from './form-group-panel/index';
+export * from './form-item/index';
+export * from './form-mdctrl/index';
+export * from './form-page/index';
+export * from './form-rawitem/index';
+export * from './form-tab-page/index';
+export * from './form-tab-panel/index';
+export * from './form-button-list/index';
+export * from './form-iframe';
+export * from './form-container';

package/src/controller/control/form/index.ts

@@ -0,0 +1,4 @@
+export * from './search-form';
+export * from './form-detail';
+export * from './edit-form';
+export * from './form';

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

@@ -0,0 +1,2 @@
+export * from './search-form.controller';
+export * from './search-form.service';

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

@@ -0,0 +1,419 @@
+import { RuntimeError } from '@ibiz-template/core';
+import { IDESearchForm } from '@ibiz/model-core';
+import {
+  BeforeSearchEventCtx,
+  ISearchFormController,
+  ISearchFormEvent,
+  ISearchFormState,
+} from '../../../../interface';
+import { FormNotifyState } from '../../../constant';
+import { FormController } from '../form/form.controller';
+import { SearchFormService } from './search-form.service';
+import { ConfigService, ControlVO } from '../../../../service';
+import { paramsToSearchconds } from '../../../../utils';
+
+/**
+ * 搜索表单控制器
+ *
+ * @author lxm
+ * @date 2023-05-15 09:33:27
+ * @export
+ * @class SearchFormController
+ * @extends {FormController<IDESearchForm>}
+ * @implements {ISearchFormController}
+ */
+export class SearchFormController
+  extends FormController<IDESearchForm, ISearchFormState, ISearchFormEvent>
+  implements ISearchFormController
+{
+  /**
+   * 搜索表单部件服务
+   *
+   * @author lxm
+   * @date 2022-08-19 13:08:51
+   * @type {EntityService}
+   */
+  service!: SearchFormService;
+
+  /**
+   * 表单旧数据（simple模式使用）
+   *
+   * @author tony001
+   * @date 2025-02-14 17:02:04
+   * @protected
+   * @type {IData}
+   */
+  protected oldData: IData = new ControlVO();
+
+  /**
+   * 应用配置存储服务
+   * @author lxm
+   * @date 2023-11-27 02:52:45
+   * @type {ConfigService}
+   */
+  config!: ConfigService;
+
+  /**
+   * @description 搜索过滤参数转换模式
+   * @readonly
+   * @type {('default' | 'searchconds')}
+   * @memberof SearchFormController
+   */
+  get convertparammode(): 'default' | 'searchconds' {
+    if (this.controlParams.convertparammode) {
+      return this.controlParams.convertparammode;
+    }
+    return ibiz.config.searchform.convertParamMode;
+  }
+
+  protected initState(): void {
+    super.initState();
+    this.state.storedFilters = [];
+    this.state.enableStoredFilters = true;
+  }
+
+  protected async onCreated(): Promise<void> {
+    await super.onCreated();
+    const enableStoredFilters =
+      this.controlParams.enablestoredfilters ||
+      ibiz.config.searchform.enableStoredFilters;
+    if (enableStoredFilters === false || enableStoredFilters === 'false') {
+      this.state.enableStoredFilters = false;
+    }
+    this.config = new ConfigService(
+      this.model.appId!,
+      'dynafilter',
+      `searchform_${
+        this.model.appDataEntityId?.toLowerCase() || 'app'
+      }_${this.model.codeName?.toLowerCase()}`,
+    );
+
+    this.preprocessLayoutPanel();
+    // 实例部件服务
+    this.service = new SearchFormService(this.model);
+    await this.service.init(this.context);
+    // 先加载数据，加载完后才会mounted, simple模式不加载
+    if (!this.state.isSimple) {
+      await this.load();
+      await this.loadConfig();
+    }
+  }
+
+  /**
+   * 设置simple模式的数据
+   *
+   * @author tony001
+   * @date 2025-02-14 17:02:59
+   * @param {IData} data
+   */
+  setSimpleData(data: IData): void {
+    // data由外部直接修改，先克隆一份隔离跟外部的对象。补全对应表单项字段不存在的时候设置为null，避免响应式问题。
+    const UIData: ControlVO = this.service.toUIData(data);
+    const cloneData = UIData.clone();
+    this.formItems.forEach(item => {
+      if (!Object.prototype.hasOwnProperty.call(cloneData, item.name)) {
+        cloneData[item.name] = null;
+      }
+    });
+    this.state.modified = false;
+    this.state.data = cloneData;
+
+    if (!this.state.isLoaded) {
+      this.state.isLoaded = true;
+    }
+  }
+
+  /**
+   * 加载草稿
+   *
+   * @author lxm
+   * @date 2022-09-22 17:09:04
+   * @returns {*}  {Promise<IData>}
+   */
+  async load(): Promise<IData> {
+    const queryParams = { ...this.params };
+
+    await this.evt.emit('onBeforeLoadDraft', { params: queryParams });
+    let res;
+    try {
+      res = await this.service.getDraft(this.context, queryParams);
+    } catch (error) {
+      this.actionNotification('GETDRAFTERROR', {
+        error: error as Error,
+      });
+      throw error;
+    }
+    this.state.data = res.data;
+    this.state.isLoaded = true;
+    await this.evt.emit('onLoadDraftSuccess', undefined);
+    this.formStateNotify(FormNotifyState.DRAFT);
+    this.actionNotification('GETDRAFTSUCCESS');
+    return this.data;
+  }
+
+  /**
+   * 获取搜索表单的过滤参数
+   *
+   * @author lxm
+   * @date 2022-09-22 17:09:21
+   * @returns {*}  {IParams}
+   */
+  getFilterParams(): IParams {
+    const filterParams: IParams = {};
+    if (this.convertparammode === 'searchconds') {
+      const searchconds = paramsToSearchconds(this.state.data);
+      if (searchconds.length > 0)
+        Object.assign(filterParams, {
+          searchconds: [
+            {
+              condop: 'AND',
+              condtype: 'GROUP',
+              searchconds,
+            },
+          ],
+        });
+    } else {
+      Object.keys(this.state.data).forEach(key => {
+        const value = this.state.data[key];
+        // 排除空值
+        if (
+          value !== null &&
+          value !== undefined &&
+          value !== '' &&
+          key !== '$srfuf'
+        ) {
+          filterParams[key] = value;
+        }
+      });
+    }
+    return filterParams;
+  }
+
+  /**
+   * 执行搜索行为
+   * @author lxm
+   * @date 2023-03-26 02:27:23
+   * @return {*}  {Promise<void>}
+   */
+  async search(args?: { silentVerify: boolean }): Promise<void> {
+    // 校验表单值规则
+    const isValid =
+      args?.silentVerify === true
+        ? await this.silentValidate()
+        : await this.validate();
+    if (!isValid) {
+      if (args?.silentVerify === true) {
+        return;
+      }
+      this.handleValidateFail();
+    }
+    // 触发onBeforeSearch事件，基于eventCtx.allowSearch进行拦截
+    const eventCtx: BeforeSearchEventCtx = {};
+    await this.evt.emit('onBeforeSearch', {
+      data: [this.data],
+      args: { eventCtx },
+    });
+    if (eventCtx.allowSearch === false) {
+      return;
+    }
+    // 触发onSearch事件
+    await this.evt.emit('onSearch', undefined);
+  }
+
+  /**
+   * 搜索表单按钮回调
+   *
+   * @author lxm
+   * @date 2022-09-22 19:09:07
+   */
+  async onSearchButtonClick(): Promise<void> {
+    await this.search();
+  }
+
+  /**
+   * 重置搜索表单
+   *
+   * @author lxm
+   * @date 2022-09-22 19:09:07
+   */
+  async reset(): Promise<void> {
+    await this.load();
+    await this.search();
+  }
+
+  /**
+   * 通知所有表单成员表单操作过程中的数据变更
+   *
+   * @author lxm
+   * @date 2022-09-20 18:09:40
+   * @param {string[]} names
+   */
+  async dataChangeNotify(names: string[]): Promise<void> {
+    await super.dataChangeNotify(names);
+    if (this.model.enableAutoSearch) {
+      this.search();
+    }
+  }
+
+  /**
+   * 监听回车事件
+   * @param {IData} event
+   * @return {*}
+   * @author: zhujiamin
+   * @date 2022-09-27 16:48:47
+   */
+  async onKeyUp(event: KeyboardEvent): Promise<void> {
+    const e = event || window.event;
+    //  回车触发搜索
+    if (e && e.code === 'Enter') {
+      await this.onSearchButtonClick();
+    }
+  }
+
+  /**
+   * 根据搜索表单的按钮位置和按钮样式
+   * 预处理部件布局面板模型
+   * @author lxm
+   * @date 2023-11-21 04:17:43
+   * @protected
+   * @return {*}
+   */
+  protected preprocessLayoutPanel(): void {
+    if (!this.controlPanel) {
+      return;
+    }
+    const { searchButtonStyle } = this.model;
+    let deleteRight = false;
+    let deleteBottom = false;
+    const searchButtonPos = this.model.searchButtonPos || 'RIGHT';
+    deleteRight = searchButtonPos === 'BOTTOM';
+    deleteBottom = searchButtonPos !== 'BOTTOM';
+
+    if (searchButtonStyle === 'NONE') {
+      deleteRight = true;
+      deleteBottom = true;
+    }
+
+    /**
+     * 递归面板项
+     * @author lxm
+     * @date 2023-11-21 04:16:36
+     * @param {IData} parent
+     */
+    const recursivePanelItems = (parent: IData): void => {
+      let children: IData[] | undefined;
+      let childrenKey = '';
+      ['rootPanelItems', 'panelItems'].find(key => {
+        if (parent[key]) {
+          children = parent[key];
+          childrenKey = key;
+          return true;
+        }
+        return false;
+      });
+      if (children && children.length > 0) {
+        const newArr: IData[] = [];
+        children.forEach((item: IData) => {
+          const isDelete =
+            (deleteRight && item.id === 'control_buttons_right') ||
+            (deleteBottom && item.id === 'control_buttons_bottom');
+          if (!isDelete) {
+            newArr.push(item);
+            recursivePanelItems(item);
+          }
+        });
+        if (newArr.length < children.length) {
+          parent[childrenKey] = newArr;
+        }
+      }
+    };
+
+    if (deleteBottom || deleteRight) {
+      recursivePanelItems(this.controlPanel);
+    }
+  }
+
+  /**
+   * 加载存储的过滤条件
+   * @author lxm
+   * @date 2023-11-27 04:02:49
+   * @return {*}  {Promise<void>}
+   */
+  async loadConfig(): Promise<void> {
+    if (!this.state.enableStoredFilters) {
+      return;
+    }
+    const res = await this.config.load();
+    if (res.model) {
+      this.state.storedFilters = res.model;
+    }
+  }
+
+  /**
+   * 保存存储的过滤条件
+   * @author lxm
+   * @date 2023-11-27 04:03:07
+   * @return {*}  {Promise<void>}
+   */
+  async saveConfig(): Promise<void> {
+    if (!this.state.enableStoredFilters) {
+      return;
+    }
+    await this.config.save({
+      model: this.state.storedFilters,
+    });
+  }
+
+  /**
+   * 存储搜索条件
+   * @author lxm
+   * @date 2023-11-27 04:08:02
+   * @param {string} name 存储的名称
+   * @return {*}  {Promise<void>}
+   */
+  async storeFilter(name: string): Promise<void> {
+    this.state.storedFilters.push({
+      name,
+      data: { ...this.data },
+    });
+
+    await this.saveConfig();
+  }
+
+  /**
+   * 应用保存的过滤条件
+   * @author lxm
+   * @date 2023-11-27 04:11:53
+   * @param {number} index
+   */
+  applyStoredFilter(index: number): void {
+    const filter = this.state.storedFilters[index];
+    if (!filter) {
+      throw new RuntimeError(
+        ibiz.i18n.t('runtime.controller.control.form.searchTerms'),
+      );
+    }
+    if (filter.data) {
+      Object.assign(this.data, filter.data);
+    }
+    // 修改后搜索
+    this.search();
+  }
+
+  /**
+   * 删除保存的过滤条件
+   * @author lxm
+   * @date 2023-11-27 04:15:22
+   * @param {number} index
+   */
+  async removeStoredFilter(index: number): Promise<void> {
+    const filter = this.state.storedFilters[index];
+    if (!filter) {
+      throw new RuntimeError(
+        ibiz.i18n.t('runtime.controller.control.form.saveSearch'),
+      );
+    }
+    this.state.storedFilters.splice(index, 1);
+    await this.saveConfig();
+  }
+}