@ibiz-template/core 0.7.41-alpha.1 → 0.7.41-alpha.106

package/src/interface/api/utils/message-center/command/internal-message/i-internal-message.ts

@@ -0,0 +1,132 @@
+// 站内信状态
+export type InternalMessageStatus =
+  | 'SENT'
+  | 'RECEIVED'
+  | 'READ'
+  | 'NOT_SENT'
+  | 'SEND_FAILED'
+  | 'REPLIED'
+  | 'DELETED';
+
+// 站内信内容类型
+export type InternalMessageContentType = 'TEXT' | 'HTML' | 'MARKDOWN' | 'JSON';
+
+/**
+ * @description 站内信消息
+ * @export
+ * @interface IInternalMessage
+ */
+export interface IInternalMessage {
+  /**
+   * @description 更新人
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  update_man: string;
+  /**
+   * @description 更新时间
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  update_time: string;
+  /**
+   * @description 创建人
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  create_man: string;
+  /**
+   * @description 创建时间
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  create_time: string;
+  /**
+   * @description 唯一标识
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  id: string;
+  /**
+   * @description 状态
+   * @type {InternalMessageStatus}
+   * @memberof IInternalMessage
+   */
+  status: InternalMessageStatus;
+
+  /**
+   * @description 内容类型
+   * @type {InternalMessageContentType}
+   * @memberof IInternalMessage
+   */
+  content_type: InternalMessageContentType;
+  /**
+   * @description 内容
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  content: string;
+
+  /**
+   * @description 系统标记
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  system_tag: string;
+
+  /**
+   * @description 所有者标记
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  owner_id: string;
+
+  /**
+   * @description 消息所有者类型
+   * @type {('PERSONAL' | 'SYSTEM')}
+   * @memberof IInternalMessage
+   */
+  owner_type: 'PERSONAL' | 'SYSTEM';
+
+  /**
+   * @description 消息类型
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  message_type: string;
+
+  /**
+   * @description 标题
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  title: string;
+
+  /**
+   * @description 接受者
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  receiver: string;
+
+  /**
+   * @description 短内容
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  short_content?: string;
+
+  /**
+   * @description 链接
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  url?: string;
+
+  /**
+   * @description 移动端链接
+   * @type {string}
+   * @memberof IInternalMessage
+   */
+  mobile_url?: string;
+}

package/src/interface/api/utils/message-center/command/mark-open-data/i-command-mark-open-data.ts

@@ -0,0 +1,17 @@
+import { ICommandBase } from '../i-command-base';
+import { IMarkOpenData } from './i-mark-open-data';
+
+/**
+ * @description 协同指令消息控制器
+ * @export
+ * @interface ICommandMarkOpenData
+ * @extends {ICommandBase}
+ */
+export interface ICommandMarkOpenData extends ICommandBase {
+  /**
+   * @description 发送消息
+   * @param {IMarkOpenData} data 协同数据
+   * @memberof ICommandMarkOpenData
+   */
+  send(data: IMarkOpenData): void;
+}

package/src/interface/api/utils/message-center/command/mark-open-data/i-mark-open-data.ts

@@ -0,0 +1,47 @@
+import { IApiData } from '../../../../global-param';
+
+// 协同消息类型
+export type MarkOpenDataAction = 'VIEW' | 'EDIT' | 'UPDATE' | 'CLOSE';
+/**
+ * @description 协同消息
+ * @export
+ * @interface IMarkOpenData
+ */
+export interface IMarkOpenData {
+  /**
+   * @description 行为类型
+   * @type {MarkOpenDataAction}
+   * @memberof IMarkOpenData
+   */
+  action: MarkOpenDataAction;
+  /**
+   * @description 实体名称
+   * @type {string}
+   * @memberof IMarkOpenData
+   */
+  entity: string;
+  /**
+   * @description 实体主键
+   * @type {string}
+   * @memberof IMarkOpenData
+   */
+  key: string;
+  /**
+   * @description 时间戳
+   * @type {number}
+   * @memberof IMarkOpenData
+   */
+  time: number;
+  /**
+   * @description 消息数据
+   * @type {IApiData}
+   * @memberof IMarkOpenData
+   */
+  data?: IApiData;
+  /**
+   * @description 用户名
+   * @type {string}
+   * @memberof IMarkOpenData
+   */
+  username: string;
+}

package/src/interface/api/utils/message-center/command/remove/i-command-remove.ts

@@ -0,0 +1,18 @@
+import { IAppDataEntity, IMsgMetaData } from '../../common';
+import { ICommandBase } from '../i-command-base';
+
+/**
+ * @description 删除指令消息控制器
+ * @export
+ * @interface ICommandRemove
+ * @extends {ICommandBase}
+ */
+export interface ICommandRemove extends ICommandBase {
+  /**
+   * @description 发送消息
+   * @param {IAppDataEntity} data 实体数据
+   * @param {IMsgMetaData} [meta] 元数据
+   * @memberof ICommandRemove
+   */
+  send(data: IAppDataEntity, meta?: IMsgMetaData): void;
+}

package/src/interface/api/utils/message-center/command/update/i-command-update.ts

@@ -0,0 +1,18 @@
+import { IAppDataEntity, IMsgMetaData } from '../../common';
+import { ICommandBase } from '../i-command-base';
+
+/**
+ * @description 更新指令消息控制器
+ * @export
+ * @interface ICommandUpdate
+ * @extends {ICommandBase}
+ */
+export interface ICommandUpdate extends ICommandBase {
+  /**
+   * @description 发送消息
+   * @param {IAppDataEntity} data 实体数据
+   * @param {IMsgMetaData} [meta] 元数据
+   * @memberof ICommandUpdate
+   */
+  send(data: IAppDataEntity, meta?: IMsgMetaData): void;
+}

package/src/interface/api/utils/message-center/common/i-app-data-entity.ts

@@ -0,0 +1,16 @@
+import { IApiData } from '../../../global-param';
+
+/**
+ * @description 应用实体数据对象
+ * @export
+ * @interface IAppDataEntity
+ * @extends {IApiData}
+ */
+export interface IAppDataEntity extends IApiData {
+  /**
+   * @description 应用实体数据对象标识
+   * @type {string}
+   * @memberof IAppDataEntity
+   */
+  srfdecodename: string;
+}

package/src/interface/api/utils/message-center/common/i-message-center-event.ts

@@ -0,0 +1,15 @@
+import { IPortalMessage } from './i-portal-message';
+
+/**
+ * @description 消息事件
+ * @export
+ * @interface IMessageCenterEvent
+ */
+export interface IMessageCenterEvent {
+  /**
+   * @description 所有消息事件
+   * @param {IPortalMessage} msg 消息
+   * @memberof IMessageCenterEvent
+   */
+  all: (msg: IPortalMessage) => void;
+}

package/src/interface/api/utils/message-center/common/i-msg-meta-data.ts

@@ -0,0 +1,13 @@
+/**
+ * @description 实体数据变更通知元数据接口
+ * @export
+ * @interface IMsgMetaData
+ */
+export interface IMsgMetaData {
+  /**
+   * @description 触发源的key
+   * @type {string}
+   * @memberof IMsgMetaData
+   */
+  triggerKey: string;
+}

package/src/interface/api/utils/message-center/common/i-portal-async-action.ts

@@ -0,0 +1,144 @@
+/**
+ * @description 异步作业信息
+ * @export
+ * @interface IPortalAsyncAction
+ */
+export interface IPortalAsyncAction {
+  /**
+   * @description 异步操作标识
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  asyncacitonid: string;
+  /**
+   * @description 异步操作名称
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  asyncacitonname: string;
+  /**
+   * @description 会话标识
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  fulltopictag: string;
+  /**
+   * @description 租户标识
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  srfdcid: string;
+  /**
+   * @description 租户系统标识
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  dcsystemid: string;
+
+  /**
+   * @description 异步作业类型，DEIMPORTDATA2: 异步导入
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  actiontype: string;
+
+  /**
+   * @description 作业状态
+   * @type {(10 | 20 | 30 | 40)} 未开始 | 执行中 | 已执行 | 执行失败
+   * @memberof IPortalAsyncAction
+   */
+  actionstate: 10 | 20 | 30 | 40;
+
+  /**
+   * @description 异步作业执行结果
+   * @type {unknown}
+   * @memberof IPortalAsyncAction
+   */
+  actionresult?: unknown;
+
+  /**
+   * @description 步骤信息
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  stepinfo?: string;
+
+  /**
+   * @description 完成百分比
+   * @type {number}
+   * @memberof IPortalAsyncAction
+   */
+  completionrate?: number;
+
+  /**
+   * @description 异步结果下载路径，目前是留给导出数据使用
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  asyncresultdownloadurl?: string;
+
+  /**
+   * @description 预留参数
+   * @type {unknown}
+   * @memberof IPortalAsyncAction
+   */
+  actionparam?: unknown;
+
+  /**
+   * @description 预留参数2
+   * @type {unknown}
+   * @memberof IPortalAsyncAction
+   */
+  actionparam2?: unknown;
+
+  /**
+   * @description 预留参数3
+   * @type {unknown}
+   * @memberof IPortalAsyncAction
+   */
+  actionparam3?: unknown;
+
+  /**
+   * @description 预留参数4
+   * @type {unknown}
+   * @memberof IPortalAsyncAction
+   */
+  actionparam4?: unknown;
+
+  /**
+   * @description 操作开始时间
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  begintime: string;
+  /**
+   * @description 操作结束时间
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  endtime: string;
+  /**
+   * @description 创建人标识
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  createman: string;
+  /**
+   * @description 创建时间
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  createdate: string;
+  /**
+   * @description 更新人标识
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  updateman: string;
+  /**
+   * @description 更新时间
+   * @type {string}
+   * @memberof IPortalAsyncAction
+   */
+  updatedate: string;
+}

package/src/interface/api/utils/message-center/common/i-portal-message.ts

@@ -0,0 +1,84 @@
+import { IApiData } from '../../../global-param';
+import { IPortalAsyncAction } from './i-portal-async-action';
+
+/**
+ * @description 消息数据
+ * @export
+ * @interface IPortalMessage
+ */
+export interface IPortalMessage {
+  /**
+   * @description 消息标识
+   * @type {string}
+   * @memberof IPortalMessage
+   */
+  messageid: string;
+  /**
+   * @description 消息名称
+   * @type {string}
+   * @memberof IPortalMessage
+   */
+  messagename?: string;
+
+  /**
+   * @description 消息类型, 日志消息 | 命令 | 错误消息
+   * @type {('CONSOLE' | 'COMMAND' | 'ERROR')} 日志消息 | 命令 | 错误消息
+   * @memberof IPortalMessage
+   */
+  type: 'CONSOLE' | 'COMMAND' | 'ERROR';
+
+  /**
+   * @description 消息子类型, 标注打开数据 | 异步作业 | 站内信 | 数据更新 | 数据删除 | 数据创建 | 添加更改
+   * @type {('MARKOPENDATA'
+   *     | 'ASYNCACTION'
+   *     | 'INTERNALMESSAGE'
+   *     | 'OBJECTUPDATED'
+   *     | 'OBJECTREMOVED'
+   *     | 'OBJECTCREATED'
+   *     | 'ADDINCHANGED')} 标注打开数据 | 异步作业 | 站内信 | 数据更新 | 数据删除 | 数据创建 | 添加更改
+   * @memberof IPortalMessage
+   */
+  subtype?:
+    | 'MARKOPENDATA'
+    | 'ASYNCACTION'
+    | 'INTERNALMESSAGE'
+    | 'OBJECTUPDATED'
+    | 'OBJECTREMOVED'
+    | 'OBJECTCREATED'
+    | 'ADDINCHANGED';
+
+  /**
+   * @description 内容摘要
+   * @type {string}
+   * @memberof IPortalMessage
+   */
+  content?: string;
+
+  /**
+   * @description 消息数据
+   * @type {(IPortalAsyncAction | IApiData | string | unknown)}
+   * @memberof IPortalMessage
+   */
+  data?: IPortalAsyncAction | IApiData | string | unknown;
+
+  /**
+   * @description 消息路径
+   * @type {string}
+   * @memberof IPortalMessage
+   */
+  url?: string;
+
+  /**
+   * @description 移动端消息路径
+   * @type {string}
+   * @memberof IPortalMessage
+   */
+  mobileurl?: string;
+
+  /**
+   * @description 触发源的key，随机字符串，作为接收方判断是否相同环境触发，相同环境则不做处理，可不传
+   * @type {string}
+   * @memberof IPortalMessage
+   */
+  triggerKey?: string;
+}

package/src/interface/api/utils/message-center/common/index.ts

@@ -0,0 +1,5 @@
+export type { IMessageCenterEvent } from './i-message-center-event';
+export type { IPortalAsyncAction } from './i-portal-async-action';
+export type { IPortalMessage } from './i-portal-message';
+export type { IAppDataEntity } from './i-app-data-entity';
+export type { IMsgMetaData } from './i-msg-meta-data';

package/src/interface/api/utils/message-center/console/i-message-console.ts

@@ -0,0 +1,17 @@
+import { IApiData } from '../../../global-param';
+import { IMessageBase } from '../base';
+
+/**
+ * @description 日志消息控制器
+ * @export
+ * @interface IMessageConsole
+ * @extends {IMessageBase}
+ */
+export interface IMessageConsole extends IMessageBase {
+  /**
+   * @description 发送消息
+   * @param {(IApiData | string)} data 日志数据
+   * @memberof IMessageConsole
+   */
+  send(data: IApiData | string): void;
+}

package/src/interface/api/utils/message-center/error/i-message-error.ts

@@ -0,0 +1,17 @@
+import { IApiData } from '../../../global-param';
+import { IMessageBase } from '../base';
+
+/**
+ * @description 错误消息控制器
+ * @export
+ * @interface IMessageError
+ * @extends {IMessageBase}
+ */
+export interface IMessageError extends IMessageBase {
+  /**
+   * @description 发送消息
+   * @param {(IApiData | string)} data 错误数据
+   * @memberof IMessageError
+   */
+  send(data: IApiData | string): void;
+}

package/src/interface/api/utils/message-center/i-message-center.ts

@@ -0,0 +1,53 @@
+import { IMessageCommand } from './command';
+import { IPortalMessage } from './common';
+import { IMessageConsole } from './console/i-message-console';
+import { IMessageError } from './error/i-message-error';
+
+/**
+ * @description 界面消息中心
+ * @export
+ * @interface IMessageCenter
+ */
+export interface IMessageCenter {
+  /**
+   * @description 指令消息
+   * @type {IMessageCommand}
+   * @memberof IMessageCenter
+   */
+  readonly command: IMessageCommand;
+
+  /**
+   * @description 日志消息
+   * @type {IMessageConsole}
+   * @memberof IMessageCenter
+   */
+  readonly console: IMessageConsole;
+
+  /**
+   * @description 错误消息
+   * @type {IMessageError}
+   * @memberof IMessageCenter
+   */
+  readonly error: IMessageError;
+
+  /**
+   * @description 发送消息
+   * @param {IPortalMessage} msg 消息
+   * @memberof IMessageCenter
+   */
+  next(msg: IPortalMessage): void;
+
+  /**
+   * @description 订阅消息
+   * @param {(msg: IPortalMessage) => void} callback 回调函数
+   * @memberof IMessageCenter
+   */
+  on(callback: (msg: IPortalMessage) => void): void;
+
+  /**
+   * @description 取消订阅
+   * @param {(msg: IPortalMessage) => void} callback 回调函数
+   * @memberof IMessageCenter
+   */
+  off(callback: (msg: IPortalMessage) => void): void;
+}

package/src/interface/api/utils/message-center/index.ts

@@ -0,0 +1,6 @@
+export * from './common';
+export * from './base';
+export * from './command';
+export type { IMessageConsole } from './console/i-message-console';
+export type { IMessageError } from './error/i-message-error';
+export type { IMessageCenter } from './i-message-center';

package/src/interface/api/utils/net/i-api-http-error.ts

@@ -0,0 +1,43 @@
+import { AxiosResponse } from 'axios';
+
+/**
+ * @description Http错误接口
+ * @export
+ * @interface IApiHttpError
+ */
+export interface IApiHttpError {
+  /**
+   * @description 错误名称
+   * @type {string}
+   * @memberof IApiHttpError
+   */
+  name: string;
+
+  /**
+   * @description 错误消息
+   * @type {string}
+   * @memberof IApiHttpError
+   */
+  message: string;
+
+  /**
+   * @description 状态码
+   * @type {number}
+   * @memberof IApiHttpError
+   */
+  status: number;
+
+  /**
+   * @description 错误标识
+   * @type {string}
+   * @memberof IApiHttpError
+   */
+  tag: string;
+
+  /**
+   * @description axios响应对象
+   * @type {AxiosResponse}
+   * @memberof IApiHttpError
+   */
+  response?: AxiosResponse;
+}