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

package/src/utils/history-list/history-list.ts

@@ -0,0 +1,137 @@
+import { clone } from 'ramda';
+import { HistoryItem } from './history-item';
+
+/**
+ * @description 数据对象历史记录，只支持纯对象形式的数据。并未支持数组
+ * @export
+ * @class HistoryList
+ * @template E
+ */
+export class HistoryList<E = IData> {
+  /**
+   * @description 当前步骤的历史记录
+   * @private
+   * @type {HistoryItem<E>}
+   * @memberof HistoryList
+   */
+  private _cur: HistoryItem<E>;
+
+  /**
+   * @description 当前的数据
+   * @readonly
+   * @type {E}
+   * @memberof HistoryList
+   */
+  get data(): E {
+    return this._cur.data;
+  }
+
+  /**
+   * Creates an instance of HistoryList.
+   * @param {E} data
+   * @memberof HistoryList
+   */
+  constructor(data: E) {
+    this._cur = new HistoryItem<E>(data);
+  }
+
+  /**
+   * @description 先创建一次历史记录，再赋值
+   * @param {IData} data
+   * @memberof HistoryList
+   */
+  assign(data: IData): void {
+    if (data) {
+      this.save();
+      Object.assign(this._cur.data!, data);
+    }
+  }
+
+  /**
+   * @description 创建一次历史记录
+   * @memberof HistoryList
+   */
+  save(): void {
+    const oldCur = this._cur;
+    // 克隆当前数据对象
+    const data = clone(oldCur.data);
+    // 新的历史对象
+    const history = new HistoryItem<E>(data);
+    // 设置新历史的上一次历史为当前历史
+    history._prev = oldCur;
+    // 将下一步的前一步置空，断开引用
+    oldCur._next._prev = HistoryItem.Undefined;
+    // 清空下一步的所有引用
+    this._clear(oldCur._next);
+    // 设置当前历史的下一次历史为新历史，如果有旧的前进步骤就干掉了
+    oldCur._next = history;
+    // 设置新历史为新历史对象
+    this._cur = history;
+  }
+
+  /**
+   * @description 上一步
+   * @returns {*}  {boolean}
+   * @memberof HistoryList
+   */
+  prev(): boolean {
+    if (this._cur._prev && this._cur._prev !== HistoryItem.Undefined) {
+      this._cur = this._cur._prev;
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * @description 下一步
+   * @returns {*}  {boolean}
+   * @memberof HistoryList
+   */
+  next(): boolean {
+    if (this._cur._next && this._cur._next !== HistoryItem.Undefined) {
+      this._cur = this._cur._next;
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * @description 清空引用，避免内存泄漏
+   * @protected
+   * @param {HistoryItem<E>} h
+   * @memberof HistoryList
+   */
+  protected _clear(h: HistoryItem<E>): void {
+    if (h._prev && h._prev !== HistoryItem.Undefined) {
+      h._prev._next = HistoryItem.Undefined;
+      this._clear(h._prev);
+      h._prev = HistoryItem.Undefined;
+    }
+    if (h._next && h._next !== HistoryItem.Undefined) {
+      h._next._prev = HistoryItem.Undefined;
+      this._clear(h._next);
+      h._next = HistoryItem.Undefined;
+    }
+    h.data = {} as E;
+  }
+
+  /**
+   * @description 禁止克隆，直接返回当前实例
+   * @protected
+   * @returns {*}  {HistoryList<E>}
+   * @memberof HistoryList
+   */
+  protected clone(): HistoryList<E> {
+    const history = new HistoryList<E>({} as E);
+    history._cur = clone(this._cur);
+    return this;
+  }
+
+  /**
+   * @description 销毁
+   * @memberof HistoryList
+   */
+  destroy(): void {
+    this._clear(this._cur);
+  }
+}

package/src/utils/index.ts

@@ -0,0 +1,24 @@
+export * from './interceptor';
+export { MessageCenter } from './message-center';
+export { Namespace } from './namespace/namespace';
+export { HttpResponse } from './net/http-response';
+export { Net } from './net/net';
+export { StringUtil } from './string-util/string-util';
+export * from './util/util';
+export * from './types/types';
+export * from './url-helper/url-helper';
+export * from './event/event';
+export { HistoryItem } from './history-list/history-item';
+export { HistoryList } from './history-list/history-list';
+export * from './click-outside/click-outside';
+export * from './color/color';
+export * from './download-file/download-file';
+export * from './upload/select-file';
+export * from './upload/upload-file';
+export * from './sync';
+export * from './style/remote-style';
+export * from './recursive/find-recursive-child';
+export { DataTypes } from './data-type/data-types';
+export * from './clone/clone';
+export { BitMask } from './bit-mask/bit-mask';
+export * from './cookie-util/cookie-util';

package/src/utils/interceptor/core-interceptor.ts

@@ -0,0 +1,127 @@
+import { InternalAxiosRequestConfig } from 'axios';
+import { getToken } from '../util/util';
+import { Interceptor } from './interceptor';
+import { getAppCookie } from '../cookie-util/cookie-util';
+import { CoreConst } from '../../constant';
+
+/**
+ * @description 核心包拦截器
+ * @export
+ * @class CoreInterceptor
+ * @extends {Interceptor}
+ */
+export class CoreInterceptor extends Interceptor {
+  /**
+   * @description 请求之前处理
+   * @protected
+   * @param {InternalAxiosRequestConfig} config
+   * @returns {*}  {Promise<InternalAxiosRequestConfig>}
+   * @memberof CoreInterceptor
+   */
+  protected async onBeforeRequest(
+    config: InternalAxiosRequestConfig,
+  ): Promise<InternalAxiosRequestConfig> {
+    config = await super.onBeforeRequest(config);
+
+    const { headers } = config;
+
+    // Set the access token.
+    const token = getToken();
+    if (token) {
+      headers.set(
+        `${ibiz.env.tokenHeader}Authorization`,
+        `${ibiz.env.tokenPrefix}Bearer ${token}`,
+      );
+    }
+
+    // Set the system ID.
+    let systemId = ibiz.env.dcSystem;
+    const { orgData } = ibiz;
+    if (orgData) {
+      if (orgData.systemid) {
+        systemId = orgData.systemid;
+      }
+      if (orgData.orgid) {
+        headers.set('srforgid', orgData.orgid);
+      }
+    }
+    headers.set('srfsystemid', systemId);
+
+    return config;
+  }
+
+  /**
+   * @description 响应失败之后处理
+   * @protected
+   * @param {Error} error
+   * @returns {*}  {Promise<never>}
+   * @memberof CoreInterceptor
+   */
+  protected async onResponseError(error: Error): Promise<never> {
+    const { config, response } = error as IData;
+    if (
+      this.instance &&
+      response?.status === 401 &&
+      config &&
+      !config._retry &&
+      config.url &&
+      // 排除获取系统信息、应用数据、刷新 token 预定义接口
+      (config.url.indexOf('/uaa/getbydcsystem/') === -1 ||
+        config.url.indexOf('/appdata') !== -1 ||
+        config.url.indexOf('/uaa/refresh_token/') !== -1)
+    ) {
+      try {
+        // 标记为已重试
+        config._retry = true;
+        // 刷新 token(匿名登录通过登录换算token，非匿名登录通过refreshToken换算新的token)
+        if (ibiz.env.enableAnonymous) {
+          const authInfo = (ibiz as IData).auth.getAuthInfo();
+          const refreshToken = getAppCookie(CoreConst.REFRESH_TOKEN);
+          // 匿名登录、匿名登录无refreshToken情况通过登录换算token
+          if (authInfo.isAnonymous || !refreshToken) {
+            const tempOrgData = ibiz.orgData;
+            await (ibiz as IData).auth.anonymousLogin();
+            ibiz.orgData = tempOrgData;
+          } else {
+            await (ibiz as IData).auth.refreshToken();
+          }
+        } else {
+          await (ibiz as IData).auth.refreshToken();
+        }
+        // 重新加载应用数据
+        const res = await ibiz.net.get(
+          '/appdata',
+          (ibiz as IData).appUtil?.getAppContext(),
+        );
+        if (res && res.ok) {
+          ibiz.appData = res.data;
+        }
+        // 重新发起原始请求
+        const { headers } = config;
+        const token = getToken();
+        if (token) {
+          headers.set(
+            `${ibiz.env.tokenHeader}Authorization`,
+            `${ibiz.env.tokenPrefix}Bearer ${token}`,
+          );
+        }
+        let systemId = ibiz.env.dcSystem;
+        const { orgData } = ibiz;
+        if (orgData) {
+          if (orgData.systemid) {
+            systemId = orgData.systemid;
+          }
+          if (orgData.orgid) {
+            headers.set('srforgid', orgData.orgid);
+          }
+        }
+        headers.set('srfsystemid', systemId);
+        return this.instance(config);
+      } catch (err) {
+        return Promise.reject(error);
+      }
+    }
+    // 处理响应错误
+    return Promise.reject(error);
+  }
+}

package/src/utils/interceptor/index.ts

@@ -0,0 +1,2 @@
+export * from './core-interceptor';
+export * from './interceptor';

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