@ibiz-template/core 0.7.41-alpha.12 → 0.7.41-alpha.138

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;
+}

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

@@ -0,0 +1,93 @@
+import {
+  AxiosRequestConfig,
+  AxiosResponse,
+  RawAxiosRequestHeaders,
+} from 'axios';
+import { IHttpResponse } from './i-http-response';
+import { IApiData, IApiParams } from '../../global-param';
+
+/**
+ * @description 网络请求工具
+ * @export
+ * @interface IApiNet
+ */
+export interface IApiNet {
+  /**
+   * @description Post 请求
+   * @param {string} url 请求地址
+   * @param {IApiData} data 请求数据
+   * @param {IApiParams} [params={}] 请求参数
+   * @param {RawAxiosRequestHeaders} [headers={}] 请求头
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  post(
+    url: string,
+    data: IApiData,
+    params?: IApiParams,
+    headers?: RawAxiosRequestHeaders,
+  ): Promise<IHttpResponse>;
+
+  /**
+   * @description Get 请求
+   * @param {string} url 请求地址
+   * @param {IApiParams} [params={}] 请求参数
+   * @param {RawAxiosRequestHeaders} [headers={}] 请求头
+   * @param {AxiosRequestConfig} [option={}] 请求配置
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  get(
+    url: string,
+    params?: IApiParams,
+    headers?: RawAxiosRequestHeaders,
+    option?: AxiosRequestConfig,
+  ): Promise<IHttpResponse>;
+
+  /**
+   * @description Delete 请求
+   * @param {string} url 请求地址
+   * @param {IApiParams} [params] 请求参数
+   * @param {RawAxiosRequestHeaders} [headers] 请求头
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  delete(
+    url: string,
+    params?: IApiParams,
+    headers?: RawAxiosRequestHeaders,
+  ): Promise<IHttpResponse>;
+
+  /**
+   * @description Put 请求
+   * @param {string} url 请求地址
+   * @param {IApiData} data 请求数据
+   * @param {IApiParams} [params={}] 请求参数
+   * @param {RawAxiosRequestHeaders} [headers={}] 请求头
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  put(
+    url: string,
+    data: IApiData,
+    params?: IApiParams,
+    headers?: RawAxiosRequestHeaders,
+  ): Promise<IHttpResponse>;
+
+  /**
+   * @description 基础请求方法，会合并预置配置
+   * @param {string} url 请求地址
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  request(url: string, config?: AxiosRequestConfig): Promise<IHttpResponse>;
+
+  /**
+   * @description 创建标准 axios 请求,此方法会跳过预置网络拦截器
+   * @param {AxiosRequestConfig<IApiData>} config 请求配置
+   * @returns {*}  {Promise<AxiosResponse>}
+   * @memberof IApiNet
+   */
+  axios(config: AxiosRequestConfig<IApiData>): Promise<AxiosResponse>;
+}

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

@@ -0,0 +1,67 @@
+import { AxiosResponse } from 'axios';
+import { IApiData } from '../../global-param';
+
+/**
+ * @description Http请求返回接口
+ * @export
+ * @interface IHttpResponse
+ * @extends {AxiosResponse}
+ * @template T
+ */
+export interface IHttpResponse<T = IApiData> extends AxiosResponse {
+  /**
+   * @description 是否请求成功,当状态码为 200-299 时认为成功
+   * @type {boolean}
+   * @memberof IHttpResponse
+   */
+  ok: boolean;
+
+  /**
+   * @description 是否为本地仿造响应,只有当值为 true 时, 才认为是本地仿造响应
+   * @type {boolean}
+   * @memberof IHttpResponse
+   */
+  local: boolean;
+
+  /**
+   * @description 响应数据
+   * @type {T}
+   * @memberof IHttpResponse
+   */
+  data: T;
+
+  /**
+   * @description 当前页
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  page?: number;
+
+  /**
+   * @description 分页条数
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  size?: number;
+
+  /**
+   * @description 总条数
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  total?: number;
+
+  /**
+   * @description 全部计数条数
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  totalx?: number;
+
+  /**
+   * @description 总页数
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  totalPages?: number;
+}

package/src/interface/click-outside/click-outside.ts

@@ -0,0 +1,51 @@
+/**
+ * @description 可选配置参数
+ * @export
+ * @interface OnClickOutsideOptions
+ */
+export interface OnClickOutsideOptions {
+  /**
+   * @description 指定使用的window,不给就用默认的window
+   * @type {Window}
+   * @memberof OnClickOutsideOptions
+   */
+  window?: Window;
+  /**
+   * @description 指定需要忽略的元素，用于排除某些外部的元素
+   * @type {HTMLElement[]}
+   * @memberof OnClickOutsideOptions
+   */
+  ignore?: HTMLElement[];
+  /**
+   * @description 是否捕获内部元素。默认为是，内部元素不会触发回调。
+   * @type {boolean}
+   * @memberof OnClickOutsideOptions
+   */
+  capture?: boolean;
+}
+
+// 回调处理函数类型
+export type OnClickOutsideHandler = (_evt: PointerEvent | MouseEvent) => void;
+
+/**
+ * @description OnClickOutside返回对象类型
+ * @export
+ * @interface OnClickOutsideResult
+ */
+export interface OnClickOutsideResult {
+  /**
+   * @description 停止监听，并移除相关监听事件
+   * @memberof OnClickOutsideResult
+   */
+  stop: () => void;
+  /**
+   * @description 暂停监听
+   * @memberof OnClickOutsideResult
+   */
+  pause: () => void;
+  /**
+   * @description 继续监听
+   * @memberof OnClickOutsideResult
+   */
+  proceed: () => void;
+}

package/src/interface/command/command/i-command-option.ts

@@ -0,0 +1,47 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @description 指令参数, 主要用于在指令呈现时的展示参数
+ * @export
+ * @interface ICommandOption
+ */
+export interface ICommandOption {
+  /**
+   * @description 唯一标识符（必需）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly id: string;
+  /**
+   * @description 显示标题（必需）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly title: string;
+  /**
+   * @description 悬停提示（可选）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly tooltip?: string;
+  /**
+   * @description 描述（可选）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly description?: string;
+  /**
+   * @description svg图标（可选）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly icon?: string;
+}
+
+/**
+ * @description 指令处理回调
+ * @export
+ * @interface ICommandHandler
+ */
+export interface ICommandHandler {
+  (...args: any[]): unknown | Promise<unknown>;
+}

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

@@ -0,0 +1,68 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IDisposable } from '../disposable/i-disposable';
+import { ICommandHandler, ICommandOption } from './i-command-option';
+
+/**
+ * @description 指令声明
+ * @export
+ * @interface ICommand
+ */
+export interface ICommand {
+  id: string;
+  handler: ICommandHandler;
+  opts?: ICommandOption;
+}
+
+/**
+ * 指令控制器集
+ */
+export type ICommandsMap = Map<string, ICommand>;
+
+/**
+ * @description 指令注册器
+ * @export
+ * @interface ICommandRegistry
+ */
+export interface ICommandRegistry {
+  /**
+   * @description 注册指令
+   * @param {string} id 指令id
+   * @param {ICommandHandler} command 指令处理回调
+   * @param {ICommandOption} opts 指令参数
+   * @returns {*}  {IDisposable} 指令释放对象
+   * @memberof ICommandRegistry
+   */
+  registerCommand(
+    id: string,
+    command: ICommandHandler,
+    opts: ICommandOption,
+  ): IDisposable;
+  /**
+   * @description 注册指令
+   * @param {string} id 指令id
+   * @param {ICommandHandler} command 指令处理回调
+   * @returns {*}  {IDisposable} 指令释放对象
+   * @memberof ICommandRegistry
+   */
+  registerCommand(id: string, command: ICommandHandler): IDisposable;
+  /**
+   * @description 注册指令
+   * @param {ICommand} command 指令
+   * @returns {*}  {IDisposable} 指令释放对象
+   * @memberof ICommandRegistry
+   */
+  registerCommand(command: ICommand): IDisposable;
+  /**
+   * @description 获取指令
+   * @param {string} id 指令id
+   * @returns {*}  {(ICommand | undefined)}
+   * @memberof ICommandRegistry
+   */
+  getCommand(id: string): ICommand | undefined;
+  /**
+   * @description 获取所有指令
+   * @returns {*}  {ICommandsMap}
+   * @memberof ICommandRegistry
+   */
+  getCommands(): ICommandsMap;
+}