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

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

@@ -0,0 +1,12 @@
+/**
+ * @description 可释放的对象
+ * @export
+ * @interface IDisposable
+ */
+export interface IDisposable {
+  /**
+   * @description 释放对象持有的所有资源
+   * @memberof IDisposable
+   */
+  dispose(): void;
+}

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

@@ -0,0 +1,50 @@
+import { ICommandHandler, ICommandOption } from '../../command';
+import { IDisposable } from './disposable/i-disposable';
+
+/**
+ * @description 指令控制器接口
+ * @export
+ * @interface ICommandController
+ */
+export interface ICommandController {
+  /**
+   * @description 注册指令
+   * @param {string} id 指令id
+   * @param {ICommandHandler} handler 指令处理回调
+   * @param {ICommandOption} [opts] 指令参数
+   * @returns {*}  {IDisposable} 指令释放对象
+   * @memberof ICommandController
+   */
+  register(
+    id: string,
+    handler: ICommandHandler,
+    opts?: ICommandOption,
+  ): IDisposable;
+
+  /**
+   * @description 执行指令
+   * @template T
+   * @param {string} id 指令id
+   * @param {...unknown[]} args 指令参数
+   * @returns {*}  {Promise<T>} 指令返回值
+   * @memberof ICommandController
+   */
+  execute<T = undefined>(id: string, ...args: unknown[]): Promise<T>;
+
+  /**
+   * @description 判断指令是否存在，没有则直接抛出异常
+   * @param {string} id 指令id
+   * @param {boolean} [err] 是否抛出异常
+   * @returns {*}  {boolean} 是否存在
+   * @memberof ICommandController
+   */
+  hasCommand(id: string, err?: boolean): boolean;
+
+  /**
+   * @description 获取指令参数
+   * @param {string} id 指令id
+   * @returns {*}  {(ICommandOption | undefined)} 指令参数
+   * @memberof ICommandController
+   */
+  getCommandOpts(id: string): ICommandOption | undefined;
+}

package/src/interface/command/index.ts

@@ -0,0 +1,11 @@
+export type {
+  ICommand,
+  ICommandsMap,
+  ICommandRegistry,
+} from './command/i-command';
+export type {
+  ICommandOption,
+  ICommandHandler,
+} from './command/i-command-option';
+export type { IDisposable } from './disposable/i-disposable';
+export type { ICommandController } from './i-command-controller';

package/src/interface/context/index.ts

@@ -0,0 +1,42 @@
+/**
+ * @description 应用上下文处理接口
+ * @export
+ * @interface IIBizContext
+ * @extends {IContext}
+ */
+export interface IIBizContext extends IContext {
+  /**
+   * @description 返回自身的上下文，独有的和与父有差异的
+   * @returns {*}  {IData}
+   * @memberof IIBizContext
+   */
+  getOwnContext(): IData;
+
+  /**
+   * @description 销毁当前上下文
+   * @memberof IIBizContext
+   */
+  destroy(): void;
+
+  /**
+   * @description 克隆当前上下文
+   * @returns {*}  {IContext}
+   * @memberof IIBizContext
+   */
+  clone(): IContext;
+
+  /**
+   * @description 深度克隆
+   * @return {*}  {IData}
+   * @memberof IIBizContext
+   */
+  deepClone(): IData;
+
+  /**
+   * @description 在不改变对象引用的情况下，重置上下文，等效于重新实例化，但是引用不变
+   * @param {IData} [context] 默认值
+   * @param {IContext} [parent] 父上下文
+   * @memberof IIBizContext
+   */
+  reset(context?: IData, parent?: IContext): void;
+}

package/src/interface/error/index.ts

@@ -0,0 +1,13 @@
+import { AxiosResponse } from 'axios';
+
+export type InputError = {
+  message: string;
+  response?: AxiosResponse;
+};
+
+export type detailMessage = {
+  name: string;
+  logicName: string;
+  errorType: number;
+  errorInfo: string;
+};

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

@@ -0,0 +1,16 @@
+import { IPortalAsyncAction } from '../api';
+import { IApiChatMessage } from '../api/chat-message';
+
+/**
+ * @description AI聊天消息
+ * @export
+ * @interface IChatMessage
+ */
+export interface IChatMessage extends IApiChatMessage {
+  /**
+   * @description 消息数据
+   * @type {(IPortalAsyncAction | IData | string | unknown)}
+   * @memberof IChatMessage
+   */
+  data?: IPortalAsyncAction | IData | string | unknown;
+}

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

@@ -0,0 +1,33 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Logger } from 'loglevel';
+import { IApiIBizsys } from '../api';
+import { ICommandController } from '../command';
+
+/**
+ * @description 全局对象
+ * @export
+ * @interface IIBizsys
+ */
+export interface IIBizsys extends IApiIBizsys {
+  /**
+   * @description 日志输出工具
+   * @type {Logger}
+   * @memberof IIBizsys
+   */
+  log: Logger;
+
+  /**
+   * @description 指令控制器
+   * @type {ICommandController}
+   * @memberof IIBizsys
+   */
+  commands: ICommandController;
+
+  /**
+   * @description 注册全局扩展，用于替换预置能力
+   * @param {keyof IBizSys} key
+   * @param {*} value
+   * @memberof IIBizsys
+   */
+  registerExtension(key: keyof IApiIBizsys, value: any): void;
+}

package/src/interface/ibizsys/index.ts

@@ -0,0 +1 @@
+export type { IIBizsys } from './i-ibizsys';

package/src/interface/index.ts

@@ -0,0 +1,11 @@
+import { IOrgData } from './api/ibizsys/i-org-data';
+
+export * from './api';
+export * from './click-outside/click-outside';
+export * from './command';
+export * from './context';
+export * from './error';
+export type { IChatMessage } from './i-chat-message/i-chat-message';
+export type OrgData = IOrgData;
+export * from './ibizsys';
+export * from './utils';

package/src/interface/utils/i-18n.ts

@@ -0,0 +1,22 @@
+import { IApiI18n } from '../api';
+
+/**
+ * @description 多语言工具接口
+ * @export
+ * @interface I18n
+ */
+export interface I18n extends IApiI18n {
+  /**
+   * @description 异步初始化，加载多语言文件
+   * @returns {*}  {Promise<void>}
+   * @memberof I18n
+   */
+  init(): Promise<void>;
+
+  /**
+   * @description 设置异步加载的多语言模块
+   * @param {Record<string, () => Promise<IData>>} languages
+   * @memberof I18n
+   */
+  setLangConfigs(languages: Record<string, () => Promise<IData>>): void;
+}

package/src/interface/utils/index.ts

@@ -0,0 +1 @@
+export type { I18n } from './i-18n';

package/src/locale/en/index.ts

@@ -0,0 +1,30 @@
+export const en = {
+  core: {
+    command: {
+      unregisteredCommand:
+        'Unregistered command: {id}, please register the command first',
+    },
+    error: {
+      networkAbnormality: 'Network abnormality, please try again later',
+      modelMsg: '「{id}」 model {msg}',
+      unsupportedModels: 'Unsupported models',
+      modelConfigurationMissing: 'Model Configuration Missing',
+      serviceException: 'Exception in service handling',
+      serviceResNotExist: 'Request resource path does not exist',
+      serviceResNotPermission: 'Requesting resources without permission',
+    },
+    utils: {
+      powerOfTwo: '{permission} is not a power of two.',
+      targetElement: 'The target element does not exist',
+      cannotFindWindow: 'Cannot find window',
+      unrealized: 'unrealized',
+      remoteStylesheet: 'Failed to load remote stylesheet',
+      notMatchLockUnlock: 'The lock and unlock counts do not match!',
+      multiApplicationMode:
+        'Multi-application mode waiting for reimplementation requests',
+      uploadFailed: '{file}Upload failed',
+      invalidInputValue: 'Invalid input value, must be >= 0',
+    },
+    noReInstall: 'ibiz already exists, no need to re-install it',
+  },
+};

package/src/locale/index.ts

@@ -0,0 +1,2 @@
+export { en } from './en';
+export { zhCn } from './zh-CN';

package/src/locale/zh-CN/index.ts

@@ -0,0 +1,28 @@
+export const zhCn = {
+  core: {
+    command: {
+      unregisteredCommand: '未注册指令: {id}，请先注册指令',
+    },
+    error: {
+      networkAbnormality: '网络异常，请稍后重试',
+      modelMsg: '「{id}」模型 {msg}',
+      unsupportedModels: '未支持的模型',
+      modelConfigurationMissing: '模型配置缺失',
+      serviceException: '服务处理异常',
+      serviceResNotExist: '请求资源路径不存在',
+      serviceResNotPermission: '请求资源无权限',
+    },
+    utils: {
+      powerOfTwo: '{permission}不是2的幂',
+      targetElement: 'target元素不存在',
+      cannotFindWindow: '找不到window',
+      unrealized: '未实现',
+      remoteStylesheet: '未实现加载远程样式表失败',
+      notMatchLockUnlock: 'lock和unlock次数不匹配！',
+      multiApplicationMode: '多应用模式等待重新实现请求',
+      uploadFailed: '{file}Upload failed',
+      invalidInputValue: '无效输入值，必须>=0',
+    },
+    noReInstall: 'ibiz 已经存在, 无需重复安装',
+  },
+};

package/src/params/params.ts

@@ -0,0 +1,131 @@
+/* eslint-disable no-constructor-return */
+
+/**
+ * @description 视图参数处理类
+ * @export
+ * @class IBizParams
+ * @implements {IParams}
+ */
+export class IBizParams implements IParams {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string | symbol]: any;
+
+  /**
+   * @description 自身的属性
+   * @protected
+   * @type {IParams}
+   * @memberof IBizParams
+   */
+  declare protected _params: IParams;
+
+  /**
+   * @description 父视图参数
+   * @protected
+   * @type {IParams}
+   * @memberof IBizParams
+   */
+  declare protected _parent?: IParams;
+
+  /**
+   * Creates an instance of IBizParams.
+   * @param {IParams} [params] 自身的参数
+   * @param {IParams} [parent] 父视图参数
+   * @memberof IBizParams
+   */
+  constructor(params?: IParams, parent?: IParams) {
+    // 定义私有变量，存放父视图参数源对象
+    Object.defineProperty(this, '_parent', {
+      enumerable: false,
+      configurable: true,
+      writable: true,
+      value: parent,
+    });
+
+    // 定义私有变量，用于存储对父已有视图参数的修改。
+    Object.defineProperty(this, '_params', {
+      enumerable: false,
+      configurable: true,
+      writable: true,
+      value: params || {},
+    });
+
+    return this.createProxy();
+  }
+
+  /**
+   * @description 创建代理对象
+   * @protected
+   * @returns {*}  {IBizParams}
+   * @memberof IBizParams
+   */
+  protected createProxy(): IBizParams {
+    // 更新属性，缺的补充定义
+    function updateKeyDefine(target: IParams, keys: string[]): void {
+      keys.forEach(key => {
+        if (!Object.prototype.hasOwnProperty.call(target, key)) {
+          Object.defineProperty(target, key, {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined,
+          });
+        }
+      });
+    }
+
+    return new Proxy(this, {
+      set(target: IBizParams, p: string, value: unknown): boolean {
+        if (['_params', '_parent'].includes(p)) {
+          target[p] = value;
+        } else {
+          target._params[p] = value;
+        }
+        return true;
+      },
+
+      get(target: IBizParams, p: string | symbol, _receiver: unknown): unknown {
+        if (target[p] !== undefined) {
+          return target[p];
+        }
+        if (target._params[p] !== undefined) {
+          return target._params[p];
+        }
+        if (target._parent && target._parent[p] !== undefined) {
+          return target._parent[p];
+        }
+      },
+
+      ownKeys(target: IBizParams): ArrayLike<string | symbol> {
+        // 整合所有并排重
+        const allKeys = [
+          ...new Set([
+            ...Object.keys(target._params),
+            ...Object.keys(target._parent || {}),
+          ]),
+        ];
+        updateKeyDefine(target, allKeys);
+        return allKeys;
+      },
+    });
+  }
+
+  /**
+   * @description 在不改变对象引用的情况下，重置视图参数，等效于重新实例化，但是引用不变
+   * @param {IParams} [params] 视图参数
+   * @param {IParams} [parent] 父视图参数
+   * @memberof IBizParams
+   */
+  reset(params?: IParams, parent?: IParams): void {
+    this._params = params || {};
+    this._parent = parent;
+  }
+
+  /**
+   * @description 销毁视图参数，避免内存泄漏
+   * @memberof IBizParams
+   */
+  destroy(): void {
+    this._params = {};
+    this._parent = undefined;
+  }
+}

package/src/types.ts

@@ -0,0 +1,26 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IBizSys } from './ibizsys';
+import {
+  IApiContext,
+  IApiData,
+  IApiObject,
+  IApiParams,
+  IEnvironment,
+} from './interface';
+
+declare global {
+  const ibiz: IBizSys;
+
+  interface Window {
+    ibiz: IBizSys;
+    Environment: IEnvironment;
+  }
+
+  type IContext = IApiContext;
+
+  type IParams = IApiParams;
+
+  type IData = IApiData;
+
+  type IObject = IApiObject;
+}

package/src/utils/bit-mask/bit-mask.ts

@@ -0,0 +1,87 @@
+/* eslint-disable default-param-last */
+/* eslint-disable no-bitwise */
+
+import { RuntimeError } from '../../error';
+
+/**
+ * @description 检查权限码是否有效，权限码是否是2的幂
+ * @example
+ * ```typescript
+ *  validate(1) // => true
+ *  validate(3) // => false
+ * ```
+ * @static
+ * @param {number} permission
+ */
+function validate(permission: number): boolean {
+  return !!permission && !(permission & (permission - 1));
+}
+
+/**
+ * @description 检查权限码是否有效,无效抛错
+ * @param {number} permission
+ */
+function validateAndThrow(permission: number): void {
+  const isPowerOf2 = validate(permission);
+  if (!isPowerOf2) {
+    throw new RuntimeError(
+      ibiz.i18n.t('core.utils.powerOfTwo', { permission }),
+    );
+  }
+}
+
+/**
+ * @description 设置权限，数字转二进制后进行|运算, 设置对应bit位为1（bit位为1代表有权限，bit位为0代表没有权限）
+ * @example
+ * ```typescript
+ *  setPermission(0, 1) // => 1
+ *  setPermission(1, 4) // => 5
+ * ```
+ * @param {number} [allPermissions=0]
+ * @param {number} permission
+ * @returns {*}  {number}
+ */
+function setPermission(allPermissions: number = 0, permission: number): number {
+  validateAndThrow(permission);
+  return allPermissions | permission;
+}
+
+/**
+ * @description 移出权限，数字转二进制后进行取反并且进行&运算, 设置对应bit位为0（bit位为1代表有权限，bit位为0代表没有权限）
+ * @param {number} [allPermissions=0] 当前所有权限
+ * @param {number} permission 要移出的权限
+ * @returns {*}  {number}
+ */
+function removePermission(
+  allPermissions: number = 0,
+  permission: number,
+): number {
+  validateAndThrow(permission);
+  return allPermissions & ~permission;
+}
+
+/**
+ * @description 检查是否有某个权限，数字转二进制后进行&运算，为1则有权限，为0则没有权限
+ * @example
+ * ```typescript
+ *  checkPermission(0, 1) // => false
+ *  checkPermission(5, 4) // => true
+ * ```
+ * @param {number} [allPermissions=0]
+ * @param {number} permission
+ * @returns {*}  {boolean}
+ */
+function checkPermission(
+  allPermissions: number = 0,
+  permission: number,
+): boolean {
+  validateAndThrow(permission);
+  return (allPermissions & permission) !== 0;
+}
+
+export const BitMask = {
+  validate,
+  setPermission,
+  removePermission,
+  checkPermission,
+};

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

@@ -0,0 +1,108 @@
+import { RuntimeError } from '../../error';
+import {
+  OnClickOutsideHandler,
+  OnClickOutsideOptions,
+  OnClickOutsideResult,
+} from '../../interface';
+import { eventPath, isEventInside, listenJSEvent } from '../event/event';
+
+const defaultWindow = typeof window !== 'undefined' ? window : undefined;
+
+/**
+ * @description 监听目标元素之外的点击事件回调
+ * @export
+ * @param {HTMLElement} target 目标元素
+ * @param {OnClickOutsideHandler} handler 触发的时间回调
+ * @param {OnClickOutsideOptions} [options={}] 额外配置参数
+ * @returns {*}  {OnClickOutsideResult}
+ */
+export function onClickOutside(
+  target: HTMLElement,
+  handler: OnClickOutsideHandler,
+  options: OnClickOutsideOptions = {},
+): OnClickOutsideResult {
+  const { window = defaultWindow, ignore = [], capture = true } = options;
+
+  if (!target) throw new RuntimeError(ibiz.i18n.t('core.utils.targetElement'));
+  if (!window)
+    throw new RuntimeError(ibiz.i18n.t('core.utils.cannotFindWindow'));
+
+  /** 是否需要监听，为false时handler不会执行 */
+  let shouldListen = true;
+
+  /**
+   * 判断event的触发是否是在元素的外部(排除了ignore元素)
+   * @param event 事件对象
+   * @returns
+   */
+  const isOutside = (event: MouseEvent): boolean => {
+    // 有一个判断是在内部，则不算外部，返回false
+    return ![target, ...ignore].some(el => {
+      return isEventInside(event, el);
+    });
+  };
+
+  /** 暂停，所有监听的回调都不执行，用于增强某些ignore无法实现的场景 */
+  let isPaused = false;
+  const pause = (): void => {
+    isPaused = true;
+  };
+  const proceed = (): void => {
+    isPaused = false;
+  };
+
+  /** pointerup延时触发标识 */
+  let fallback: number;
+
+  /**
+   * 事件监听处理回调
+   * @param event 事件对象
+   * @returns
+   */
+  const listener = (event: MouseEvent): void => {
+    if (isPaused) return;
+    window.clearTimeout(fallback);
+
+    // 当需要监听并且最终触发在外部时才需要执行回调
+    if (!(shouldListen && isOutside(event))) return;
+
+    handler(event);
+  };
+
+  // 鼠标左键单击先后触发pointerdown,pointerup,click
+  // 鼠标右键单击先后触发pointerdown,pointerup
+  const cleanups = [
+    listenJSEvent(window, 'click', listener, { passive: true, capture }),
+    listenJSEvent(
+      window,
+      'pointerdown',
+      e => {
+        if (isPaused) return;
+        // 当pointerdown是在内部触发则不需要后续监听
+        shouldListen = isOutside(e);
+      },
+      { passive: true },
+    ),
+    listenJSEvent(
+      window,
+      'pointerup',
+      e => {
+        if (isPaused) return;
+        // 鼠标左键触发才执行
+        if (e.button === 0) {
+          // 锁死结果避免延时执行时变更
+          const path = eventPath(e);
+          e.composedPath = (): (EventTarget | null)[] => path;
+          fallback = window.setTimeout(() => listener(e), 50);
+        }
+      },
+      { passive: true },
+    ),
+  ].filter(Boolean);
+
+  /**
+   * 停止事件监听，移除监听
+   */
+  const stop = (): void => cleanups.forEach(fn => fn());
+  return { stop, pause, proceed };
+}

package/src/utils/clone/clone.ts

@@ -0,0 +1,38 @@
+import { cloneDeepWith, cloneWith, isFunction, isObject } from 'lodash-es';
+import { mergeDeepRight } from 'ramda';
+
+export type CloneOpts = {
+  deep?: boolean;
+};
+
+/**
+ * @description 自定义克隆逻辑，有clone方法的拿clone方法，否则直接用lodash的clone
+ * @template T
+ * @param {T} value
+ * @returns {*}  {(T | undefined)}
+ */
+function customizeFn<T>(value: T): T | undefined {
+  if (isObject(value) && isFunction((value as IData).clone)) {
+    return (value as IData).clone();
+  }
+}
+
+const DefaultCloneOpts: CloneOpts = {
+  deep: true,
+} as const;
+
+/**
+ * @description 克隆方法（如果对象有clone方法会用clone方法调用clone）
+ * @export
+ * @template T
+ * @param {T} value
+ * @param {CloneOpts} [opts]
+ * @returns {*}  {T}
+ */
+export function clone<T>(value: T, opts?: CloneOpts): T {
+  const options = mergeDeepRight(DefaultCloneOpts, opts || {})!;
+  if (options.deep) {
+    return cloneDeepWith(value, customizeFn);
+  }
+  return cloneWith(value, customizeFn);
+}