@ibiz-template/core 0.7.41-alpha.101 → 0.7.41-alpha.113

package/src/utils/interceptor/interceptor.ts

@@ -0,0 +1,122 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import {
+  AxiosInstance,
+  InternalAxiosRequestConfig,
+  AxiosResponse,
+} from 'axios';
+
+/**
+ * @description 拦截器基类
+ * @export
+ * @class Interceptor
+ */
+export class Interceptor {
+  /**
+   * @description 请求拦截器绑定标识
+   * @private
+   * @type {number}
+   * @memberof Interceptor
+   */
+  private requestTag?: number;
+
+  /**
+   * @description 响应拦截器绑定标识
+   * @private
+   * @type {number}
+   * @memberof Interceptor
+   */
+  private responseTag?: number;
+
+  /**
+   * @description axios实例
+   * @protected
+   * @type {(AxiosInstance | undefined)}
+   * @memberof Interceptor
+   */
+  protected instance: AxiosInstance | undefined;
+
+  /**
+   * @description 请求之前处理
+   * @protected
+   * @param {InternalAxiosRequestConfig} config
+   * @returns {*}  {Promise<InternalAxiosRequestConfig>}
+   * @memberof Interceptor
+   */
+  protected async onBeforeRequest(
+    config: InternalAxiosRequestConfig,
+  ): Promise<InternalAxiosRequestConfig> {
+    return config;
+  }
+
+  /**
+   * @description 请求失败之后处理
+   * @protected
+   * @param {Error} error
+   * @returns {*}  {Promise<never>}
+   * @memberof Interceptor
+   */
+  protected onRequestError(error: Error): Promise<never> {
+    // 处理请求错误
+    return Promise.reject(error);
+  }
+
+  /**
+   * @description 响应成功之后处理
+   * @protected
+   * @param {AxiosResponse} config
+   * @returns {*}  {Promise<AxiosResponse>}
+   * @memberof Interceptor
+   */
+  protected async onResponseSuccess(
+    config: AxiosResponse,
+  ): Promise<AxiosResponse> {
+    return config;
+  }
+
+  /**
+   * @description 响应失败之后处理
+   * @protected
+   * @param {Error} error
+   * @returns {*}  {Promise<never>}
+   * @memberof Interceptor
+   */
+  protected onResponseError(error: Error): Promise<never> {
+    // 处理响应错误
+    return Promise.reject(error);
+  }
+
+  /**
+   * @description 使用拦截器
+   * @param {AxiosInstance} instance
+   * @memberof Interceptor
+   */
+  use(instance: AxiosInstance): void {
+    this.instance = instance;
+    this.onBeforeRequest = this.onBeforeRequest.bind(this);
+    this.onRequestError = this.onRequestError.bind(this);
+    this.onResponseSuccess = this.onResponseSuccess.bind(this);
+    this.onResponseError = this.onResponseError.bind(this);
+    this.requestTag = instance.interceptors.request.use(
+      this.onBeforeRequest,
+      this.onRequestError,
+    );
+    this.responseTag = instance.interceptors.response.use(
+      this.onResponseSuccess,
+      this.onResponseError,
+    );
+  }
+
+  /**
+   * @description 移出拦截器
+   * @param {AxiosInstance} instance
+   * @memberof Interceptor
+   */
+  eject(instance: AxiosInstance): void {
+    if (this.requestTag) {
+      instance.interceptors.request.eject(this.requestTag);
+    }
+    if (this.responseTag) {
+      instance.interceptors.response.eject(this.responseTag);
+    }
+  }
+}

package/src/utils/logger/logger.ts

@@ -0,0 +1,34 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+import Logger from 'loglevel';
+import prefix from 'loglevel-plugin-prefix';
+
+// 重写 methodFactory
+const originalFactory = Logger.methodFactory;
+const NOOP = (message: string) => {};
+Logger.methodFactory = (methodName, logLevel, loggerName) => {
+  const rawMethod = originalFactory(methodName, logLevel, loggerName);
+  if (window.Environment?.environmentTag === 'production') {
+    if (
+      methodName === 'error' ||
+      methodName === 'warn' ||
+      methodName === 'debug'
+    ) {
+      return NOOP;
+    }
+  }
+  if (window.Environment?.environmentTag === 'test') {
+    if (methodName === 'error' || methodName === 'warn') {
+      return NOOP;
+    }
+  }
+  return rawMethod;
+};
+
+const logger = Logger.noConflict();
+
+prefix.reg(logger);
+
+prefix.apply(logger);
+
+export { logger };

package/src/utils/message-center/base/message-all.ts

@@ -0,0 +1,10 @@
+import { IMessageAll } from '../../../interface';
+import { MessageBase } from './message-base';
+
+/**
+ * @description 所有消息控制器
+ * @export
+ * @class MessageAll
+ * @extends {MessageBase}
+ */
+export class MessageAll extends MessageBase implements IMessageAll {}

package/src/utils/message-center/base/message-base.ts

@@ -0,0 +1,73 @@
+import { QXEvent } from 'qx-util';
+import {
+  IMessageBase,
+  IMessageCenterEvent,
+  IPortalMessage,
+} from '../../../interface';
+
+/**
+ * @description 消息基类控制器，各个类型消息继承此类
+ * @export
+ * @abstract
+ * @class MessageBase
+ * @implements {IMessageBase}
+ */
+export abstract class MessageBase implements IMessageBase {
+  /**
+   * @description 事件对象
+   * @protected
+   * @type {QXEvent<IMessageCenterEvent>}
+   * @memberof MessageBase
+   */
+  protected evt: QXEvent<IMessageCenterEvent> = new QXEvent(1000);
+
+  /**
+   * Creates an instance of MessageBase.
+   * @param {MessageBase} [parent]
+   * @memberof MessageBase
+   */
+  constructor(protected parent?: MessageBase) {}
+
+  /**
+   * @description 推送标准结构消息
+   * @param {IPortalMessage} msg
+   * @memberof MessageBase
+   */
+  next(msg: IPortalMessage): void {
+    this.evt.emit('all', msg);
+    if (this.parent) {
+      this.nextParent(msg);
+    }
+  }
+
+  /**
+   * @description 向父级推送消息（私有方法）
+   * @protected
+   * @param {IPortalMessage} msg
+   * @memberof MessageBase
+   */
+  protected nextParent(msg: IPortalMessage): void {
+    if (this.parent) {
+      this.parent.evt.emit('all', msg);
+      this.parent.nextParent(msg);
+    }
+  }
+
+  /**
+   * @description 订阅消息
+   * @param {(msg: IPortalMessage) => void} cb
+   * @memberof MessageBase
+   */
+  on(cb: (msg: IPortalMessage) => void): void {
+    this.evt.on('all', cb);
+  }
+
+  /**
+   * @description 取消订阅消息
+   * @param {(msg: IPortalMessage) => void} cb
+   * @memberof MessageBase
+   */
+  off(cb: (msg: IPortalMessage) => void): void {
+    this.evt.off('all', cb);
+  }
+}

package/src/utils/message-center/command/add-in-changed/command-add-in-changed.ts

@@ -0,0 +1,23 @@
+import { IAddInChanged, ICommandAddInChanged } from '../../../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * @description 添加变更指令消息控制器
+ * @export
+ * @class CommandAddInChanged
+ * @extends {CommandBase}
+ * @implements {ICommandAddInChanged}
+ */
+export class CommandAddInChanged
+  extends CommandBase
+  implements ICommandAddInChanged
+{
+  /**
+   * @description 发送消息
+   * @param {IAddInChanged} data
+   * @memberof CommandAddInChanged
+   */
+  send(data: IAddInChanged): void {
+    this.sendCommand(data, 'ADDINCHANGED');
+  }
+}

package/src/utils/message-center/command/async-action/command-async-action.ts

@@ -0,0 +1,23 @@
+import { ICommandAsyncAction, IPortalAsyncAction } from '../../../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * @description 异步作业指令消息控制器
+ * @export
+ * @class CommandAsyncAction
+ * @extends {CommandBase}
+ * @implements {ICommandAsyncAction}
+ */
+export class CommandAsyncAction
+  extends CommandBase
+  implements ICommandAsyncAction
+{
+  /**
+   * @description 发送消息
+   * @param {IPortalAsyncAction} data
+   * @memberof CommandAsyncAction
+   */
+  send(data: IPortalAsyncAction): void {
+    this.sendCommand(data, 'ASYNCACTION');
+  }
+}

package/src/utils/message-center/command/change/command-change.ts

@@ -0,0 +1,11 @@
+import { ICommandChange } from '../../../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * @description 数据变更指令消息控制器
+ * @export
+ * @class CommandChange
+ * @extends {CommandBase}
+ * @implements {ICommandChange}
+ */
+export class CommandChange extends CommandBase implements ICommandChange {}

package/src/utils/message-center/command/command-base/command-base.ts

@@ -0,0 +1,35 @@
+import { createUUID } from 'qx-util';
+import { ICommandBase, IPortalMessage } from '../../../../interface';
+import { MessageBase } from '../../base/message-base';
+
+/**
+ * @description 指令消息基类控制器
+ * @export
+ * @class CommandBase
+ * @extends {MessageBase}
+ * @implements {ICommandBase}
+ */
+export class CommandBase extends MessageBase implements ICommandBase {
+  /**
+   * @description 发送指令消息
+   * @param {IData} data
+   * @param {IPortalMessage['subtype']} subtype
+   * @param {string} [triggerKey]
+   * @memberof CommandBase
+   */
+  sendCommand(
+    data: IData,
+    subtype: IPortalMessage['subtype'],
+    triggerKey?: string,
+  ): void {
+    const msg: IPortalMessage = {
+      messageid: createUUID(),
+      messagename: 'command',
+      type: 'COMMAND',
+      subtype,
+      triggerKey,
+      data,
+    };
+    this.next(msg);
+  }
+}

package/src/utils/message-center/command/create/command-create.ts

@@ -0,0 +1,25 @@
+import {
+  IAppDataEntity,
+  ICommandCreate,
+  IMsgMetaData,
+} from '../../../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * @description 创建指令消息控制器
+ * @export
+ * @class CommandCreate
+ * @extends {CommandBase}
+ * @implements {ICommandCreate}
+ */
+export class CommandCreate extends CommandBase implements ICommandCreate {
+  /**
+   * @description 发送消息
+   * @param {IAppDataEntity} data
+   * @param {IMsgMetaData} [meta]
+   * @memberof CommandCreate
+   */
+  send(data: IAppDataEntity, meta?: IMsgMetaData): void {
+    this.sendCommand(data, 'OBJECTCREATED', meta?.triggerKey);
+  }
+}

package/src/utils/message-center/command/internal-message/command-internal-message.ts

@@ -0,0 +1,26 @@
+import {
+  ICommandInternalMessage,
+  IInternalMessage,
+} from '../../../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * @description 站内信指令消息控制器
+ * @export
+ * @class CommandInternalMessage
+ * @extends {CommandBase}
+ * @implements {ICommandInternalMessage}
+ */
+export class CommandInternalMessage
+  extends CommandBase
+  implements ICommandInternalMessage
+{
+  /**
+   * @description 发送消息
+   * @param {IInternalMessage} data
+   * @memberof CommandInternalMessage
+   */
+  send(data: IInternalMessage): void {
+    this.sendCommand(data, 'INTERNALMESSAGE');
+  }
+}

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

@@ -0,0 +1,23 @@
+import { ICommandMarkOpenData, IMarkOpenData } from '../../../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * @description 协同指令消息控制器
+ * @export
+ * @class CommandMarkOpenData
+ * @extends {CommandBase}
+ * @implements {ICommandMarkOpenData}
+ */
+export class CommandMarkOpenData
+  extends CommandBase
+  implements ICommandMarkOpenData
+{
+  /**
+   * @description 发送消息
+   * @param {IMarkOpenData} data
+   * @memberof CommandMarkOpenData
+   */
+  send(data: IMarkOpenData): void {
+    this.sendCommand(data, 'MARKOPENDATA');
+  }
+}

package/src/utils/message-center/command/message-command.ts

@@ -0,0 +1,162 @@
+import { createUUID } from 'qx-util';
+import { IMessageCommand, IPortalMessage } from '../../../interface';
+import { MessageBase } from '../base/message-base';
+import { CommandCreate } from './create/command-create';
+import { CommandUpdate } from './update/command-update';
+import { CommandRemove } from './remove/command-remove';
+import { CommandChange } from './change/command-change';
+import { CommandAsyncAction } from './async-action/command-async-action';
+import { CommandInternalMessage } from './internal-message/command-internal-message';
+import { CommandMarkOpenData } from './mark-open-data/command-mark-open-data';
+import { CommandAddInChanged } from './add-in-changed/command-add-in-changed';
+
+/**
+ * @description 指令消息控制器
+ * @export
+ * @class MessageCommand
+ * @extends {MessageBase}
+ * @implements {IMessageCommand}
+ */
+export class MessageCommand extends MessageBase implements IMessageCommand {
+  /**
+   * @description 数据变更指令消息控制器
+   * @type {CommandChange}
+   * @memberof MessageCommand
+   */
+  readonly change: CommandChange = new CommandChange();
+
+  /**
+   * @description 新建数据指令消息控制器
+   * @type {CommandCreate}
+   * @memberof MessageCommand
+   */
+  readonly create: CommandCreate = new CommandCreate(this);
+
+  /**
+   * @description 更新数据指令消息控制器
+   * @type {CommandUpdate}
+   * @memberof MessageCommand
+   */
+  readonly update: CommandUpdate = new CommandUpdate(this);
+
+  /**
+   * @description 删除数据指令消息控制器
+   * @type {CommandRemove}
+   * @memberof MessageCommand
+   */
+  readonly remove: CommandRemove = new CommandRemove(this);
+
+  /**
+   * @description 异步指令消息控制器
+   * @type {CommandAsyncAction}
+   * @memberof MessageCommand
+   */
+  readonly asyncAction: CommandAsyncAction = new CommandAsyncAction(this);
+
+  /**
+   * @description 站内信消息指令消息控制器
+   * @type {CommandInternalMessage}
+   * @memberof MessageCommand
+   */
+  readonly internalMessage: CommandInternalMessage = new CommandInternalMessage(
+    this,
+  );
+
+  /**
+   * @description 协同指令消息控制器
+   * @type {CommandMarkOpenData}
+   * @memberof MessageCommand
+   */
+  readonly markOpenData: CommandMarkOpenData = new CommandMarkOpenData(this);
+
+  /**
+   * @description 添加变更指令消息控制器
+   * @type {CommandAddInChanged}
+   * @memberof MessageCommand
+   */
+  readonly addInChanged: CommandAddInChanged = new CommandAddInChanged(this);
+
+  /**
+   * @description 推送指令消息
+   * @param {IPortalMessage} msg
+   * @memberof MessageCommand
+   */
+  next(msg: IPortalMessage): void {
+    // 消息分子类型，子类型发完消息后，会让父发消息
+    // 所以子类型有父时，会一级一级的往上发消息。不需要在此处发全局消息
+    // change 特殊处理，不给父发消息
+    switch (msg.subtype) {
+      case 'OBJECTCREATED':
+        this.create.next(msg);
+        this.change.next(msg);
+        break;
+      case 'OBJECTUPDATED':
+        this.update.next(msg);
+        this.change.next(msg);
+        break;
+      case 'OBJECTREMOVED':
+        this.remove.next(msg);
+        this.change.next(msg);
+        break;
+      case 'ASYNCACTION':
+        this.asyncAction.next(msg);
+        break;
+      case 'INTERNALMESSAGE':
+        this.internalMessage.next(msg);
+        break;
+      case 'MARKOPENDATA':
+        this.markOpenData.next(msg);
+        break;
+      case 'ADDINCHANGED':
+        this.addInChanged.next(msg);
+        break;
+      default:
+        super.next(msg);
+    }
+  }
+
+  /**
+   * @description 发送消息给父级
+   * @protected
+   * @param {IPortalMessage} msg
+   * @memberof MessageCommand
+   */
+  protected nextParent(msg: IPortalMessage): void {
+    switch (msg.subtype) {
+      case 'OBJECTCREATED':
+        this.change.next(msg);
+        break;
+      case 'OBJECTUPDATED':
+        this.change.next(msg);
+        break;
+      case 'OBJECTREMOVED':
+        this.change.next(msg);
+        break;
+      default:
+    }
+    super.nextParent(msg);
+  }
+
+  /**
+   * @description 发送指令消息
+   * @param {IData} data
+   * @param {IPortalMessage['subtype']} subtype
+   * @param {string} [triggerKey]
+   * @memberof MessageCommand
+   */
+  send(
+    data: IData,
+    subtype: IPortalMessage['subtype'],
+    triggerKey?: string,
+  ): void {
+    const msg: IPortalMessage = {
+      messageid: createUUID(),
+      messagename: 'command',
+      type: 'COMMAND',
+      subtype,
+      triggerKey,
+      data,
+    };
+    this.next(msg);
+  }
+}

package/src/utils/message-center/command/remove/command-remove.ts

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

package/src/utils/message-center/command/update/command-update.ts

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

package/src/utils/message-center/console/message-console.ts

@@ -0,0 +1,27 @@
+import { createUUID } from 'qx-util';
+import { IMessageConsole, IPortalMessage } from '../../../interface';
+import { MessageBase } from '../base/message-base';
+
+/**
+ * @description 日志消息控制器
+ * @export
+ * @class MessageConsole
+ * @extends {MessageBase}
+ * @implements {IMessageConsole}
+ */
+export class MessageConsole extends MessageBase implements IMessageConsole {
+  /**
+   * @description 发送消息
+   * @param {(IData | string)} data
+   * @memberof MessageConsole
+   */
+  send(data: IData | string): void {
+    const msg: IPortalMessage = {
+      messageid: createUUID(),
+      messagename: 'console',
+      type: 'CONSOLE',
+      data,
+    };
+    this.next(msg);
+  }
+}

package/src/utils/message-center/error/message-error.ts

@@ -0,0 +1,27 @@
+import { createUUID } from 'qx-util';
+import { IMessageError, IPortalMessage } from '../../../interface';
+import { MessageBase } from '../base/message-base';
+
+/**
+ * @description 错误消息控制器
+ * @export
+ * @class MessageError
+ * @extends {MessageBase}
+ * @implements {IMessageError}
+ */
+export class MessageError extends MessageBase implements IMessageError {
+  /**
+   * @description 发送消息
+   * @param {(IData | string)} data
+   * @memberof MessageError
+   */
+  send(data: IData | string): void {
+    const msg: IPortalMessage = {
+      messageid: createUUID(),
+      messagename: 'error',
+      type: 'ERROR',
+      data,
+    };
+    this.next(msg);
+  }
+}

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

@@ -0,0 +1 @@
+export { MessageCenter } from './message-center';