@ibiz-template/runtime 0.7.41-alpha.105 → 0.7.41-alpha.107

package/src/interface/service/service/i-third-auth.service.ts

@@ -0,0 +1,44 @@
+export interface IThirdAuthResult {
+  /**
+   * 是否成功
+   *
+   * @author tony001
+   * @date 2024-11-18 16:11:01
+   * @type {boolean}
+   */
+  ok: boolean;
+
+  /**
+   * 数据
+   *
+   * @author tony001
+   * @date 2024-11-18 16:11:16
+   * @type {IData}
+   */
+  data?: IData;
+}
+/**
+ * 第三方授权服务接口
+ *
+ * @author tony001
+ * @date 2024-11-18 14:11:04
+ * @export
+ * @interface IThirdAuthService
+ */
+export interface IThirdAuthService {
+  /**
+   * 授权
+   *
+   * @author tony001
+   * @date 2024-11-18 14:11:19
+   * @param {('DINGTALK' | 'WXWORK' | 'OAUTH'  |string)} type 授权类型：钉钉 | 企业微信 | OAUTH | 自定义
+   * @param {('EMBED' | 'THIRD')} mode 授权模式：嵌入 | 第三方（网页扫码）
+   * @param {IData} [params] 授权参数
+   * @return {*}  {Promise<IThirdAuthResult>}
+   */
+  auth(
+    type: 'DINGTALK' | 'WXWORK' | 'OAUTH' | string,
+    mode: 'EMBED' | 'THIRD',
+    params?: IData,
+  ): Promise<IThirdAuthResult>;
+}

package/src/interface/service/service/i-wf.service.ts

@@ -0,0 +1,88 @@
+import { IHttpResponse } from '@ibiz-template/core';
+
+export interface IWorkFlowService {
+  /**
+   * 根据当前步骤和任务获取工作流步骤数据（如：流程表单等）
+   *
+   * @author lxm
+   * @date 2022-09-29 14:09:45
+   * @param {IContext} context
+   * @returns {*}  {Promise<IHttpResponse<IData>>}
+   */
+  getWFStep(context: IContext): Promise<IHttpResponse<IData>>;
+
+  /**
+   * 根据业务主键和当前步骤获取操作路径
+   *
+   * @author lxm
+   * @date 2022-09-29 14:09:52
+   * @param {IContext} context 路径参数
+   * @param {IData} data 数据
+   * @returns {*}  {Promise<IHttpResponse<IData>>}
+   */
+  getWFLink(context: IContext, data: IData): Promise<IHttpResponse<IData[]>>;
+
+  /**
+   * 根据业务主键获取工作流程进度
+   *
+   * @author lxm
+   * @date 2022-09-29 14:09:45
+   * @param {IContext} context
+   * @returns {*}  {Promise<IHttpResponse<IData>>}
+   */
+  getWFHistory(context: IContext): Promise<IHttpResponse<IData>>;
+
+  /**
+   * 根据业务主键获取工作流流程图片
+   *
+   * @author lxm
+   * @date 2022-10-27 16:10:13
+   * @param {IContext} context
+   * @returns {*}  {Promise<IHttpResponse<IData>>}
+   */
+  getWFProcessDiagram(context: IContext): Promise<IHttpResponse<IData>>;
+
+  /**
+   * 获取标准工作流版本信息
+   *
+   * @author chitanda
+   * @date 2024-01-10 16:01:30
+   * @param {string} srfWFTag
+   * @return {*}  {Promise<IHttpResponse<IData>>}
+   */
+  getWFVersion(srfWFTag: string): Promise<IHttpResponse<IData>>;
+
+  /**
+   * 工作流撤销
+   *
+   * @author lxm
+   * @date 2022-09-30 17:09:51
+   * @param {IContext} context 路径参数
+   * @param {IParams} params 请求参数
+   * @param {IData} data 数据
+   * @returns {*}  {Promise<IHttpResponse<IData>>}
+   */
+  wfWithdraw(
+    context: IContext,
+    params: IParams,
+    data: IData,
+  ): Promise<IHttpResponse<IData>>;
+
+  /**
+   * 调用工作流接口
+   *
+   * @author lxm
+   * @date 2022-09-30 17:09:38
+   * @param {string} methodName 接口名称
+   * @param {IContext} context 路径参数
+   * @param {IParams} [params={}] 查询参数
+   * @param {IData} [data={}] 主数据数据
+   * @returns {*}  {Promise<IHttpResponse<IData>>}
+   */
+  exec(
+    methodName: string,
+    context: IContext,
+    params?: IParams,
+    data?: IData,
+  ): Promise<IHttpResponse<IData>>;
+}

package/src/interface/service/service/index.ts

@@ -0,0 +1,17 @@
+export type { IAppDeAuthorityService } from './i-app-de-authority.service';
+export type { IConfigService } from './i-config.service';
+export type { IAppDEService } from './i-app-de.service';
+export type { IAuthService, IAuthInfo } from './i-auth.service';
+export type { IFileService } from './i-file.service';
+export type { IWorkFlowService } from './i-wf.service';
+export type { IAsyncActionService } from './i-async-action.service';
+export type { IInternalMessageService } from './i-internal-message.service';
+export type {
+  MarkOpenDataActionType,
+  IMarkOpenDataService,
+  MarkOpenDataCallbackFun,
+} from './i-mark-open-data.service';
+export type {
+  IThirdAuthService,
+  IThirdAuthResult,
+} from './i-third-auth.service';

package/src/interface/store/i-store.ts

@@ -0,0 +1,39 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+export type SetEventHandler<StoreType> = (
+  key: keyof StoreType,
+  newValue: any,
+  oldValue: any,
+) => void;
+export type GetEventHandler<StoreType> = (key: keyof StoreType) => void;
+
+export interface OnHandler<StoreType> {
+  (eventName: 'set', callback: SetEventHandler<StoreType>): () => void;
+  (eventName: 'get', callback: GetEventHandler<StoreType>): () => void;
+}
+
+export interface OnChangeHandler<StoreType> {
+  <Key extends keyof StoreType>(
+    propName: Key,
+    cb: (newValue: StoreType[Key], oldValue: StoreType[Key]) => void,
+  ): () => void;
+}
+
+export interface ObservableStore<T> {
+  state: T;
+
+  on: OnHandler<T>;
+
+  onChange: OnChangeHandler<T>;
+}
+
+export interface IStoreUtil {
+  createStore<T extends IData>(initialState: T): ObservableStore<T>;
+}
+
+// state可以响应式绘制界面
+// state可以直接修改,
+// 通过监听函数可以监听
+// !可选功能
+// state要不要非state属性不能添加
+// 监听回调要不要可以阻止改值。

package/src/interface/studio/i-view-session.ts

@@ -0,0 +1,9 @@
+import { IApiViewSession } from '../api';
+
+/**
+ * @description 视图会话共享变量接口
+ * @export
+ * @interface IViewSession
+ * @extends {IApiViewSession}
+ */
+export interface IViewSession extends IApiViewSession {}

package/src/interface/studio/index.ts

@@ -0,0 +1 @@
+export * from './i-view-session';

package/src/interface/ui-logic/i-ui-logic-context.ts

@@ -0,0 +1,95 @@
+export interface IUILogicContext {
+  /**
+   * 上一次返回值
+   */
+  lastReturn: unknown;
+
+  /**
+   * 上下文
+   */
+  readonly context: IContext;
+
+  /**
+   * 数据
+   */
+  readonly data: IData;
+
+  /**
+   * 视图参数
+   */
+  readonly viewParam: IParams;
+
+  /**
+   * 界面逻辑参数
+   *
+   * @author chitanda
+   * @date 2023-11-01 17:11:52
+   * @type {Record<string, unknown>}
+   */
+  readonly params: Record<string, unknown>;
+
+  /**
+   * UI 逻辑执行返回值
+   *
+   * @author chitanda
+   * @date 2023-11-01 17:11:29
+   * @type {unknown}
+   */
+  result: unknown;
+
+  /**
+   * 是否存在结束节点
+   *
+   * @author chitanda
+   * @date 2023-11-01 17:11:57
+   * @type {boolean}
+   */
+  isEndNode: boolean;
+
+  /**
+   * 默认参数节点名称
+   *
+   * @default 'Default'
+   * @author chitanda
+   * @date 2023-11-01 17:11:31
+   * @type {string}
+   */
+  defaultParamName: string;
+
+  /**
+   * 重置实体逻辑参数
+   *
+   * @author chitanda
+   * @date 2023-11-01 17:11:18
+   * @param {string} name
+   */
+  resetParam(name: string): void;
+
+  /**
+   * 设置上一次返回值
+   *
+   * @author chitanda
+   * @date 2023-11-01 17:11:31
+   * @param {string} name
+   */
+  renewParam(name: string): void;
+
+  /**
+   * 设置上一次返回值
+   *
+   * @author chitanda
+   * @date 2023-11-01 17:11:48
+   * @param {unknown} value
+   */
+  setLastReturn(value: unknown): void;
+
+  /**
+   * 是否是实体参数变量（即后台数据对象）
+   *
+   * @author chitanda
+   * @date 2023-11-01 17:11:01
+   * @param {string} paramId
+   * @return {*}  {boolean}
+   */
+  isEntityParam(paramId: string): boolean;
+}

package/src/interface/ui-logic/index.ts

@@ -0,0 +1 @@
+export type { IUILogicContext } from './i-ui-logic-context';

package/src/interface/util/i-ai-chat-util/i-ai-chat-util.ts

@@ -0,0 +1,11 @@
+import { IApiAIChatUtil, IApiAIToolbarItem } from '../../api';
+
+/**
+ * @description AI聊天工具栏项
+ */
+export interface IAIToolbarItem extends IApiAIToolbarItem {}
+
+/**
+ * @description AI聊天工具
+ */
+export interface IAIChatUtil extends IApiAIChatUtil {}

package/src/interface/util/i-animation-util/i-animation-options.ts

@@ -0,0 +1,34 @@
+export interface IAnimationOptions {
+  /**
+   * 动画持续时间
+   *
+   * @author zk
+   * @date 2024-01-24 04:01:29
+   * @type {number}
+   * @memberof IAnimationOptions
+   */
+  duration?: number;
+
+  /**
+   * 是否循环
+   *
+   * @author zk
+   * @date 2024-01-24 04:01:19
+   * @type {false}
+   * @memberof IAnimationOptions
+   */
+  loop?: false;
+
+  /**
+   * 运行速度曲线
+   *
+   * @author zk
+   * @date 2024-01-25 01:01:52
+   * @type {string}
+   * @memberof IAnimationOptions
+   */
+  easing?: string;
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string | symbol]: any;
+}

package/src/interface/util/i-app-util/i-app-util.ts

@@ -0,0 +1,17 @@
+import { IApiAiChatParam, IApiAppUtil } from '../../api';
+
+/**
+ * @description Ai聊天参数
+ * @export
+ * @interface IAiChatParam
+ * @extends {IApiAiChatParam}
+ */
+export interface IAiChatParam extends IApiAiChatParam {}
+
+/**
+ * @description 应用级功能接口定义，承载应用级功能实现，包含登录、注册、修改密码、切换主题等功能
+ * @export
+ * @interface IAppUtil
+ * @extends {IApiAppUtil}
+ */
+export interface IAppUtil extends IApiAppUtil {}

package/src/interface/util/i-confirm-util/i-confirm-util.ts

@@ -0,0 +1,17 @@
+import { IApiConfirmParams, IApiConfirmUtil } from '../../api';
+
+/**
+ * @description 确认框参数
+ * @export
+ * @interface ConfirmParams
+ * @extends {IApiConfirmParams}
+ */
+export interface ConfirmParams extends IApiConfirmParams {}
+
+/**
+ * @description 确认消息，提示用户确认其已经触发的动作，并询问是否进行此操作时会用到此对话框。
+ * @export
+ * @interface IConfirmUtil
+ * @extends {IApiConfirmUtil}
+ */
+export interface IConfirmUtil extends IApiConfirmUtil {}

package/src/interface/util/i-encryption-uitl/i-encryption-uitl.ts

@@ -0,0 +1,10 @@
+import { IApiEncryptionUtil } from '../../api';
+
+/**
+ * 加密工具类接口
+ *
+ * @export
+ * @interface IEncyptionUtil
+ * @extends {IApiEncryptionUtil}
+ */
+export interface IEncyptionUtil extends IApiEncryptionUtil {}

package/src/interface/util/i-excel-util/i-excel-util.ts

@@ -0,0 +1,11 @@
+import { IApiExcelUtil } from '../../api';
+
+/**
+ * excel文件工具
+ * @author lxm
+ * @date 2023-08-24 10:45:32
+ * @export
+ * @interface IExcelUtil
+ * @extends {IApiExcelUtil}
+ */
+export interface IExcelUtil extends IApiExcelUtil {}

package/src/interface/util/i-fullscreen-util/i-fullscreen-util.ts

@@ -0,0 +1,22 @@
+import { IApiFullscreenUtil } from '../../api';
+/**
+ * @description 全屏工具类
+ * @export
+ * @interface IFullscreenUtil
+ * @extends {IApiFullscreenUtil}
+ */
+export interface IFullscreenUtil extends IApiFullscreenUtil {
+  /**
+   * @description 全屏样式名称
+   * @type {string}
+   * @memberof IFullscreenUtil
+   */
+  FullscreenClass: string;
+
+  /**
+   * @description 是否是全屏状态
+   * @type {boolean}
+   * @memberof IFullscreenUtil
+   */
+  isFullScreen: boolean;
+}

package/src/interface/util/i-html2canvas-util/i-html2canvas-option.ts

@@ -0,0 +1,9 @@
+import { IApiHtml2canvasOption } from '../../api';
+
+/**
+ * @description html2canvas配置项
+ * @export
+ * @interface IHtml2canvasOption
+ * @extends {IApiHtml2canvasOption}
+ */
+export interface IHtml2canvasOption extends IApiHtml2canvasOption {}

package/src/interface/util/i-inline-ai-util/i-inline-ai-util.ts

@@ -0,0 +1,15 @@
+import { IApiInLineAiChatOptions, IApiInLineAIUtil } from '../../api';
+
+/**
+ *  行内AI聊天参数
+ * @export
+ * @interface IInLineAiChatOptions
+ */
+export interface IInLineAiChatOptions extends IApiInLineAiChatOptions {}
+
+/**
+ * @description 行内AI工具类
+ * @export
+ * @interface IInLineAIUtil
+ */
+export interface IInLineAIUtil extends IApiInLineAIUtil {}

package/src/interface/util/i-json-util/i-json-util.ts

@@ -0,0 +1,6 @@
+import { IApiJsonUtil } from '../../api';
+
+/**
+ * @description JSON工具类
+ */
+export interface IJsonUtil extends IApiJsonUtil {}

package/src/interface/util/i-jsonschema-util/i-jsonschema-util.ts

@@ -0,0 +1,45 @@
+import { ValueOP } from '../../../constant';
+
+export interface IJsonSchemaUtil {
+  /**
+   * 获取jsonschema属性数据
+   *
+   * @author tony001
+   * @date 2024-07-25 00:07:33
+   * @param {string} entityId
+   * @param {IContext} context
+   * @param {IParams} params
+   * @return {*}  {Promise<IData[]>}
+   */
+  getEntitySchemaFields(
+    entityId: string,
+    context: IContext,
+    params: IParams,
+  ): Promise<IData[]>;
+
+  /**
+   * 通过数据类型获取可使用操作标识集合
+   *
+   * @author tony001
+   * @date 2024-07-25 17:07:42
+   * @param {string} dataType
+   * @return {*}  {IData[]}
+   */
+  getValueOPsByDataType(dataType: string): IData[];
+
+  /**
+   * 获取仿真编辑器
+   *
+   * @author tony001
+   * @date 2024-07-25 17:07:31
+   * @param {IContext} context
+   * @param {IData} item
+   * @param {ValueOP} [valueOP]
+   * @return {*}  {(IData | undefined)}
+   */
+  getMockEditor(
+    context: IContext,
+    item: IData,
+    valueOP?: ValueOP,
+  ): IData | undefined;
+}

package/src/interface/util/i-loading-util/i-loading-util.ts

@@ -0,0 +1,39 @@
+/**
+ * 加载动画工具
+ *
+ * @author chitanda
+ * @date 2022-08-17 17:08:25
+ * @export
+ * @interface ILoadingUtil
+ */
+export interface ILoadingUtil {
+  /**
+   * 显示全局加载动画
+   *
+   * @author chitanda
+   * @date 2022-08-17 17:08:24
+   * @param {string} [message]
+   */
+  show(message?: string): void;
+  /**
+   * 隐藏全局加载动画
+   *
+   * @author chitanda
+   * @date 2022-08-17 17:08:48
+   */
+  hide(): void;
+  /**
+   * 显示顶部全局加载动画
+   *
+   * @author chitanda
+   * @date 2022-10-08 16:10:18
+   */
+  showRedirect(): void;
+  /**
+   * 隐藏顶部全局加载动画
+   *
+   * @author chitanda
+   * @date 2022-10-08 16:10:29
+   */
+  hideRedirect(): void;
+}

package/src/interface/util/i-message-util/i-message-util.ts

@@ -0,0 +1,17 @@
+import { IApiMessageParams, IApiMessageUtil } from '../../api';
+
+/**
+ * @description 消息提示参数接口
+ * @export
+ * @interface IMessageParams
+ * @extends {IApiMessageParams}
+ */
+export interface IMessageParams extends IApiMessageParams {}
+
+/**
+ * @description 主动操作后的反馈提示，顶部居中显示，并自动消失
+ * @export
+ * @interface IMessageUtil
+ * @extends {IApiMessageUtil}
+ */
+export interface IMessageUtil extends IApiMessageUtil {}

package/src/interface/util/i-modal-util/i-modal-util.ts

@@ -0,0 +1,17 @@
+import { IApiModalParams, IApiModalUtil } from '../../api';
+
+/**
+ * @description 简洁确认框参数
+ * @export
+ * @interface ModalParams
+ * @extends {IApiModalParams}
+ */
+export interface ModalParams extends IApiModalParams {}
+
+/**
+ * @description 消息提示，当用户进行操作时会被触发，该对话框中断用户操作，直到用户确认知晓后才可关闭。
+ * @export
+ * @interface IModalUtil
+ * @extends {IApiModalUtil}
+ */
+export interface IModalUtil extends IApiModalUtil {}

package/src/interface/util/i-notice-util/i-notice-util.ts

@@ -0,0 +1,42 @@
+import { IPortalAsyncAction } from '@ibiz-template/core';
+
+/**
+ * 系统全局消息通知的呈现工具类
+ *
+ * @author lxm
+ * @date 2024-01-26 05:09:14
+ * @export
+ * @interface INoticeUtil
+ */
+export interface INoticeUtil {
+  /**
+   * 展示异步操作的通知
+   * @author lxm
+   * @date 2024-01-26 04:40:10
+   * @param {IPortalAsyncAction} asyncAction
+   */
+  showAsyncAction(asyncAction: IPortalAsyncAction): void;
+
+  /**
+   * 展示正在执行的相关信息的通知
+   * @author lxm
+   * @date 2024-01-26 05:11:55
+   * @param {{ num: number }} info
+   */
+  showDoingNotice(info: { num: number }): void;
+
+  /**
+   * 展示外挂插件操作的通知
+   *
+   * @author tony001
+   * @date 2025-01-10 11:01:19
+   */
+  showAddInChangedNotice(msg: IData): void;
+
+  /**
+   * 关闭正在执行的相关信息的通知
+   * @author lxm
+   * @date 2024-01-26 05:13:12
+   */
+  closeDoingNotice(): void;
+}

package/src/interface/util/i-notification-util/i-notification-util.ts

@@ -0,0 +1,53 @@
+/* eslint-disable prettier/prettier */
+
+import { IApiNotificationParams, IApiNotificationUtil } from "../../api";
+
+/**
+ * @description 全局通知参数
+ * @export
+ * @interface NotificationParams
+ * @extends {IApiNotificationParams}
+ */
+export interface NotificationParams extends IApiNotificationParams { }
+
+/**
+ * @description 上传管理器参数
+ * @export
+ * @interface IUploadManagerParams
+ */
+export interface IUploadManagerParams {
+  /**
+   * @description 上传路径
+   * @type {string}
+   * @memberof IUploadManagerParams
+   */
+  uploadUrl: string;
+  /**
+   * @description 上传文件
+   * @type {FileList}
+   * @memberof IUploadManagerParams
+   */
+  files: FileList;
+  /**
+   * @description 请求头
+   * @type {Record<string, string>}
+   * @memberof IUploadManagerParams
+   */
+  headers?: Record<string, string>;
+}
+
+/**
+ * @description 悬浮出现在界面右上角，显示全局的通知
+ * @export
+ * @interface INotificationUtil
+ * @extends {IApiNotificationUtil}
+ */
+export interface INotificationUtil extends IApiNotificationUtil {
+  /**
+   * @description 上传管理器
+   * @param {IUploadManagerParams} params
+   * @returns {*}  {Promise<IData[]>}
+   * @memberof INotificationUtil
+   */
+  uploadManager(params: IUploadManagerParams): Promise<IData[]>;
+}