@ibiz-template/runtime 0.6.1-dev.0 → 0.6.1-dev.2

package/src/ui-action/provider/ui-action-provider-base.ts

@@ -1,387 +0,0 @@
-import { RuntimeModelError } from '@ibiz-template/core';
-import { IAppDEUIAction, ILanguageRes, INavigateParam } from '@ibiz/model-core';
-import {
-  IUIActionProvider,
-  IUIActionResult,
-  IUILogicParams,
-} from '../../interface';
-import { calcDeCodeNameById } from '../../model';
-import { execUILogic } from '../../ui-logic';
-import { convertNavData, formatMultiData, ScriptFactory } from '../../utils';
-import { UIActionUtil } from '../uiaction-util';
-
-/**
- * 界面行为处理器基类
- *
- * @author lxm
- * @date 2022-10-25 14:10:31
- * @export
- * @class UIActionProviderBase
- */
-export abstract class UIActionProviderBase implements IUIActionProvider {
-  /**
-   * 界面行为执行入口，处理公共逻辑，子类一般不要重写
-   * @author lxm
-   * @date 2023-05-08 10:02:10
-   * @param {IAppDEUIAction} action
-   * @param {IUILogicParams} params
-   * @return {*}  {Promise<IUIActionResult>}
-   */
-  async exec(
-    action: IAppDEUIAction,
-    args: IUILogicParams,
-  ): Promise<IUIActionResult> {
-    const result: IUIActionResult = {
-      refresh: action.reloadData,
-      refreshMode: action.refreshMode,
-      closeView: action.closeEditView,
-    };
-
-    // ** 界面逻辑替换执行界面行为
-    const { appDEUILogicId, appDataEntityId, uilogicAttachMode } = action;
-    if (uilogicAttachMode === 'REPLACE') {
-      if (!appDEUILogicId) {
-        throw new RuntimeModelError(action, '没有配置实体界面逻辑');
-      }
-      await execUILogic(appDEUILogicId, appDataEntityId!, args);
-      return result;
-    }
-
-    // **用户操作确认**
-    if (!(await this.isConfirm(action, args))) {
-      return this.returnError(result);
-    }
-
-    // ** 执行不同类型的界面行为独有逻辑，并且合并result
-    const _result = await this.execAction(action, args);
-    Object.assign(result, _result);
-    // 如果是取消操作则中断后续处理逻辑。
-    if (result.cancel === true) {
-      return this.returnError(result);
-    }
-
-    // ** 界面行为执行之后，执行界面逻辑
-    if (action.uilogicAttachMode === 'AFTER') {
-      if (!appDEUILogicId) {
-        throw new RuntimeModelError(action, '没有配置实体界面逻辑');
-      }
-      await execUILogic(
-        appDEUILogicId,
-        appDataEntityId!,
-        this.mergeArgsByResult(args, result),
-      );
-    }
-
-    // ** 后续界面行为
-    const nextActionParams = this.mergeArgsByResult(args, result);
-    if (action.closeEditView) {
-      // 关闭视图的情况下，不等待后续界面行为
-      this.doNextAction(action, nextActionParams, action.appId);
-    } else {
-      const nextResult = await this.doNextAction(
-        action,
-        nextActionParams,
-        action.appId,
-      );
-      if (nextResult) {
-        Object.assign(result, nextResult);
-        if (nextResult.cancel === true) {
-          return this.returnError(result);
-        }
-      }
-    }
-
-    return result;
-  }
-
-  /**
-   * 根据界面行为逻辑返回值，合并参数获得后续逻辑要用的参数
-   * @author lxm
-   * @date 2023-12-25 02:42:23
-   * @protected
-   * @param {IUILogicParams} args 当前环境的参数
-   * @param {IUIActionResult} result 上一次逻辑执行的结果
-   * @return {*}  {IUILogicParams}
-   */
-  protected mergeArgsByResult(
-    args: IUILogicParams,
-    result: IUIActionResult,
-  ): IUILogicParams {
-    return {
-      ...args,
-      context: result.nextContext || args.context,
-      data: result.data || args.data,
-      params: result.nextParams || args.params,
-    };
-  }
-
-  /**
-   * 有错误和取消时对result做的处理
-   * @author lxm
-   * @date 2023-03-15 07:43:21
-   * @protected
-   * @param {IUIActionResult} result
-   * @returns {*}  {IUIActionResult}
-   * @memberof UIActionHandler
-   */
-  protected returnError(result: IUIActionResult): IUIActionResult {
-    return Object.assign(result, {
-      refresh: false,
-      closeView: false,
-    });
-  }
-
-  /**
-   * 用户操作确认
-   *
-   * @author lxm
-   * @date 2022-10-25 14:10:55
-   * @param {IAppDEUIAction} action 界面行为模型
-   * @returns {*}  {Promise<boolean>}
-   */
-  async isConfirm(
-    action: IAppDEUIAction,
-    args: IUILogicParams,
-  ): Promise<boolean> {
-    const confirmMsg = this.calcMessage('confirm', action, args);
-    if (action.enableConfirm && confirmMsg) {
-      return ibiz.confirm.warning({ title: '操作确认', desc: confirmMsg });
-    }
-    return true;
-  }
-
-  /**
-   * 执行具体界面行为的独有逻辑(子类重写)
-   *
-   * @author lxm
-   * @date 2022-10-25 15:10:03
-   * @abstract
-   * @param {IAppDEUIAction} action
-   * @param {IContext} context
-   * @param {(IData[])} data
-   * @param {IParams} params
-   * @param {(IData | undefined)} [opts]
-   * @returns {*}  {Promise<IUIActionResult>}
-   */
-  abstract execAction(
-    action: IAppDEUIAction,
-    params: IUILogicParams,
-  ): Promise<IUIActionResult>;
-
-  /**
-   * 执行后续界面行为
-   *
-   * @author lxm
-   * @date 2022-10-25 15:10:54
-   * @param {IAppDEUIAction} action
-   * @param {IContext} context
-   * @param {(IData[])} data
-   * @param {IParams} params
-   * @param {(IData | undefined)} [opts]
-   * @returns {*}  {Promise<void>}
-   */
-  async doNextAction(
-    action: IAppDEUIAction,
-    params: IUILogicParams,
-    appId: string,
-  ): Promise<IUIActionResult | undefined> {
-    const nextActionId = action.nextId;
-    if (nextActionId) {
-      return UIActionUtil.exec(nextActionId, params, appId);
-    }
-  }
-
-  /**
-   * 参数处理(根据数据目标和数据参数，导航参数)
-   *
-   * @author lxm
-   * @date 2022-08-29 17:08:00
-   * @protected
-   * @static
-   * @param {IAppDEUIAction} action 界面行为
-   * @param {IContext} context 上下文
-   * @param {(IData[])} data 数据集合
-   * @param {IParams} params 视图参数
-   * @returns {*}  {Promise<{
-   *     resultContext: IContext; 处理后的上下文
-   *     resultData: IData[]; 处理后的数据集合
-   *     resultParams: IParams; 处理后的视图参数
-   *   }>}
-   */
-  protected async handleParams(
-    action: IAppDEUIAction,
-    context: IContext,
-    data: IData[],
-    params: IParams,
-  ): Promise<{
-    resultContext: IContext;
-    resultData: IData[];
-    resultParams: IParams;
-  }> {
-    let resultData: IData[] = [];
-
-    // 准备实体名称
-    const deName = calcDeCodeNameById(action.appDataEntityId!);
-    const entity = await ibiz.hub.getAppDataEntity(
-      action.appDataEntityId!,
-      context.srfappid,
-    );
-    const keyField = entity.keyAppDEFieldId!; // 主键属性名称
-
-    // 根据数据目标处理数据集合
-    switch (action.actionTarget) {
-      // 数据目标为无数据时，清空数据
-      case 'NONE':
-        resultData = [];
-        break;
-      // 单项数据给单个数据
-      case 'SINGLEDATA':
-        resultData = [data[0]];
-        break;
-      // 多项数据传递数组
-      case 'MULTIDATA':
-        resultData = data;
-        break;
-      // 多项数据主键传递数组，数组内只有一个主键
-      case 'MULTIKEY':
-        resultData =
-          deName && data.length > 0
-            ? data.map(item => ({ [keyField]: item.srfkey || item[keyField] }))
-            : [{}];
-        break;
-      // 单项数据主键，传递包含一个对象的数组，对象里只含有一个主键
-      case 'SINGLEKEY':
-        {
-          const originData = data[0] || {};
-          resultData = deName
-            ? [{ [keyField]: originData.srfkey || originData[keyField] }]
-            : [{}];
-        }
-        break;
-      default:
-        break;
-    }
-
-    // 处理上下文导航参数
-    const resultContext = context.clone();
-    const navContexts = [...(action.navigateContexts || [])];
-
-    // 非无数据时，在导航参数开头加一个主键的导航参数，可以被配置的同名导航参数覆盖。
-    // 数据项名称替换主键的取值属性，参数项名称替换处理后主键在上下文的名称
-    // 配置的值项和参数项可以改变这个默认导航参数。
-    if (deName && action.actionTarget !== 'NONE') {
-      const { valueItem, paramItem } = action;
-      const key = paramItem || deName;
-      const valueKey = valueItem || 'srfkey';
-      navContexts.unshift({
-        key,
-        value: valueKey,
-        rawValue: false,
-      } as INavigateParam);
-    }
-
-    // 是否是多数据
-    const isMultiData =
-      ['MULTIKEY', 'MULTIDATA'].includes(action.actionTarget!) &&
-      data.length > 0;
-
-    // 处理自定义导航上下文
-    const tempContext = convertNavData(
-      navContexts,
-      isMultiData ? formatMultiData(navContexts, data) : data[0] || {},
-      params,
-      context,
-    );
-    Object.assign(resultContext, tempContext);
-
-    // 处理自定义导航视图参数
-    const navParams = action.navigateParams;
-    const resultParams = convertNavData(
-      navParams,
-      isMultiData ? formatMultiData(navParams, data) : data[0] || {},
-      params,
-      resultContext,
-    );
-    return { resultContext, resultData, resultParams };
-  }
-
-  /**
-   * 计算消息信息（动态，多语言资源）
-   * @author lxm
-   * @date 2023-09-25 03:03:01
-   * @protected
-   * @param {('confirm' | 'success')} type
-   * @param {IAppDEUIAction} action
-   * @param {IUILogicParams} args
-   * @return {*}
-   */
-  protected calcMessage(
-    type: 'confirm' | 'success',
-    action: IAppDEUIAction,
-    args: IUILogicParams,
-  ): string | undefined {
-    let msg: string | undefined;
-    let msgRes: ILanguageRes | undefined;
-    const { confirmMsg, cmlanguageRes, successMsg, smlanguageRes } = action;
-    switch (type) {
-      case 'confirm':
-        msg = confirmMsg;
-        msgRes = cmlanguageRes;
-        break;
-      case 'success':
-        msg = successMsg;
-        msgRes = smlanguageRes;
-        break;
-      default:
-    }
-
-    // 多语言资源转换
-    if (msgRes) {
-      const msgResContent = ibiz.i18n.t(
-        msgRes.lanResTag!,
-        msgRes.defaultContent || msg,
-      );
-      if (msgResContent !== msgRes.lanResTag) {
-        msg = msgResContent;
-      }
-    }
-
-    if (msg) {
-      const { data } = args;
-      const scriptParams: IParams = { ...args };
-      if (data.length === 1) {
-        // 单数据
-        [scriptParams.data] = data;
-      } else if (data.length === 0) {
-        // 无数据
-        delete scriptParams.data;
-      }
-      return ScriptFactory.execScriptFn(scriptParams, `\`${msg}\``, {
-        isAsync: false,
-        singleRowReturn: true,
-      }) as string;
-    }
-  }
-
-  /**
-   * 处理打开视图配置自定义参数 modalOption
-   *
-   * @author zk
-   * @date 2024-02-01 01:02:28
-   * @param {IData} param
-   * @return {*}  {IData}
-   * @memberof FrontUIActionProvider
-   */
-  handleViewOptionParams(param: IData): IData {
-    if (param.modaloption) {
-      try {
-        const modalOption = JSON.parse(param.modaloption);
-        delete param.modaloption;
-        return { modalOption };
-      } catch (error) {
-        ibiz.log.error(`视图参数modalOption 解析失败：${error}`);
-      }
-    }
-    return {};
-  }
-}

package/src/ui-action/provider/wf-withdraw-ui-action-provider.ts

@@ -1,34 +0,0 @@
-import { IAppDEUIAction } from '@ibiz/model-core';
-import { IUIActionResult, IUILogicParams } from '../../interface';
-import { UIActionProviderBase } from './ui-action-provider-base';
-
-/**
- * 工作流流程撤回界面行为适配器
- *
- * @author lxm
- * @date 2022-10-25 15:10:51
- * @export
- * @class WFWithdrawUIActionProvider
- * @implements {IUIActionProvider}
- */
-export class WFWithdrawUIActionProvider extends UIActionProviderBase {
-  async execAction(
-    _action: IAppDEUIAction,
-    args: IUILogicParams,
-  ): Promise<IUIActionResult> {
-    const { view } = args;
-    const isWithdraw = await ibiz.modal.confirm({
-      title: '提示',
-      desc: '是否确认执行撤回操作？',
-    });
-    let isCloseView = false;
-    if (isWithdraw && view) {
-      await view.call('WFWithdraw', args);
-      isCloseView = true;
-    }
-    return {
-      refresh: false,
-      closeView: isCloseView,
-    };
-  }
-}

package/src/ui-action/uiaction-util.ts

@@ -1,125 +0,0 @@
-import { RuntimeError } from '@ibiz-template/core';
-import { PresetIdentifier, SysUIActionTag, ViewCallTag } from '../constant';
-import { IUILogicParams, IUIActionResult } from '../interface';
-import { getUIActionById } from '../model';
-import { getUIActionProvider } from '../register';
-
-/**
- * 界面行为工具类
- *
- * @author chitanda
- * @date 2022-08-26 00:08:17
- * @export
- * @class AppDEUIActionUtil
- */
-export class UIActionUtil {
-  /**
-   * 执行界面行为
-   *
-   * @author lxm
-   * @date 2023-05-15 07:54:53
-   * @static
-   * @param {string} actionId 界面行为id
-   * @param {IUILogicParams} params 界面行为参数
-   * @return {*}  {Promise<IUIActionResult>}
-   */
-  static async exec(
-    actionId: string,
-    params: IUILogicParams,
-    appId: string,
-  ): Promise<IUIActionResult> {
-    const action = await getUIActionById(actionId, appId);
-    if (!action) {
-      throw new RuntimeError(`没找到${actionId}的界面行为模型`);
-    }
-    // 单项数据的界面行为执行前校验表单的数据，不通过则拦截
-    if (action.actionTarget === 'SINGLEDATA') {
-      const validateResult = await params.view.call(ViewCallTag.VALIDATE);
-      if (validateResult === false) {
-        return { cancel: true };
-      }
-    }
-    const provider = await getUIActionProvider(action);
-    return provider.exec(action, params);
-  }
-
-  /**
-   * 执行界面行为并处理返回值
-   * @author lxm
-   * @date 2023-05-15 07:54:36
-   * @static
-   * @param {string} actionId 界面行为id
-   * @param {IUILogicParams} params 界面行为参数
-   */
-  static async execAndResolved(
-    actionId: string,
-    params: IUILogicParams,
-    appId: string,
-  ): Promise<void> {
-    const result = await this.exec(actionId, params, appId);
-    if (result.closeView) {
-      params.view.modal.ignoreDismissCheck = true;
-      params.view.closeView({ ok: true });
-    } else if (result.refresh) {
-      switch (result.refreshMode) {
-        case 1:
-          params.view.callUIAction(SysUIActionTag.REFRESH);
-          break;
-        case 2:
-          params.view.parentView?.callUIAction(SysUIActionTag.REFRESH);
-          break;
-        case 3:
-          params.view.getTopView()?.callUIAction(SysUIActionTag.REFRESH);
-          break;
-        default:
-      }
-    }
-    const action = await getUIActionById(actionId, appId);
-    // 异步行为模型配置方式:
-    // 1、配置实体行为 返回值类型选择为 异步操作对象
-    // 2、配置界面行为 界面行为类型选择 后台调用 、配置实体行为
-    // 界面行为模型基于选择的实体行为的返回值类型计算异步行为（asyncAction）模型
-    if (action!.asyncAction && !result.cancel) {
-      this.handleAsyncAction(params.event);
-    }
-  }
-
-  /**
-   * 处理异步行为
-   *
-   * @author zk
-   * @date 2024-01-23 11:01:58
-   * @static
-   * @param {(Event | undefined)} event
-   * @return {*}  {Promise<void>}
-   * @memberof UIActionUtil
-   */
-  private static async handleAsyncAction(
-    event: Event | undefined,
-  ): Promise<void> {
-    this.handleAsyncActionAnime(event);
-  }
-
-  /**
-   * 处理异步行为动画
-   *
-   * @author zk
-   * @date 2024-01-24 04:01:29
-   * @private
-   * @static
-   * @param {(Event | undefined)} event
-   * @return {*}  {Promise<void>}
-   * @memberof UIActionUtil
-   */
-  private static async handleAsyncActionAnime(
-    event: Event | undefined,
-  ): Promise<void> {
-    if (!event || !event.target) {
-      return;
-    }
-    await ibiz.util.anime.moveAndResize(
-      event.target as HTMLElement,
-      `#${PresetIdentifier.MESSAGE}`,
-    );
-  }
-}

package/src/ui-logic/index.ts

@@ -1,41 +0,0 @@
-import { RuntimeError } from '@ibiz-template/core';
-import { IDEUILogic } from '@ibiz/model-core';
-import { IUILogicParams } from '../interface';
-import { UILogic } from './ui-logic';
-
-/**
- * 界面行为实例缓存
- */
-const uiLogicMap: WeakMap<IDEUILogic, UILogic> = new Map();
-
-/**
- * 执行界面行为
- *
- * @author chitanda
- * @date 2023-02-09 11:02:23
- * @export
- * @param {IPSDEUILogic} deUILogic
- * @param {IContext} context
- * @param {(IData[] | null)} data
- * @param {IParams} params
- * @param {IParams} [opt]
- * @return {*}  {Promise<unknown>}
- */
-export async function execUILogic(
-  deUILogicId: string,
-  appDataEntityId: string,
-  parameters: IUILogicParams,
-): Promise<unknown> {
-  const app = ibiz.hub.getApp(parameters.context.srfappid);
-  const deUILogic = await app.getDEUILogic(deUILogicId, appDataEntityId);
-  if (!deUILogic) {
-    throw new RuntimeError(
-      `找不到实体${appDataEntityId}的界面逻辑${deUILogicId}`,
-    );
-  }
-  if (!uiLogicMap.has(deUILogic)) {
-    uiLogicMap.set(deUILogic, new UILogic(deUILogic));
-  }
-  const uiLogic = uiLogicMap.get(deUILogic)!;
-  return uiLogic.exec(parameters);
-}