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

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

package/src/utils/color/color.ts

@@ -0,0 +1,84 @@
+/* eslint-disable no-bitwise */
+/* eslint-disable no-nested-ternary */
+const r = Math.round;
+/**
+ * @description 把颜色字符串转成RGBA数组
+ * @param {string} color 颜色字符串
+ * @returns {*}  {number[]}
+ */
+function toRGBA(color: string): number[] {
+  const l = color.length;
+  const rgba = [];
+  if (color.slice(0, 3).toLowerCase() === 'rgb') {
+    const d = color.match(/([\d|.%]{1,3})/g)!;
+    rgba[0] = parseInt(d[0], 10);
+    rgba[1] = parseInt(d[1], 10);
+    rgba[2] = parseInt(d[2], 10);
+    rgba[3] = d[3]
+      ? d[3].indexOf('%') !== -1
+        ? parseInt(d[3], 10) / 100
+        : parseFloat(d[3])
+      : 1;
+  } else {
+    let d: number;
+    if (l < 6)
+      d = parseInt(
+        String(color[1]) +
+          color[1] +
+          color[2] +
+          color[2] +
+          color[3] +
+          color[3] +
+          (l > 4 ? String(color[4]) + color[4] : ''),
+        16,
+      );
+    else d = parseInt(color.slice(1), 16);
+    rgba[0] = (d >> 16) & 255;
+    rgba[1] = (d >> 8) & 255;
+    rgba[2] = d & 255;
+    rgba[3] =
+      l === 9 || l === 5 ? r((((d >> 24) & 255) / 255) * 10000) / 10000 : 1;
+  }
+  return rgba;
+}
+
+/**
+ * @description 混合两种颜色，颜色格式支持hex和rgb，如：#46b5d555，#fff，转化结果为rgb(245 245 245 / 80%)
+ * @export
+ * @param {string} color1 颜色1
+ * @param {string} color2 颜色2
+ * @param {number} [p=0.5] 颜色1占多少百分比，小数格式
+ * @param {('hex' | 'rgb')} [format='hex'] 输出的格式，hex或rgb
+ * @returns {*}  {string}
+ */
+export function colorBlend(
+  color1: string,
+  color2: string,
+  p = 0.5,
+  format: 'hex' | 'rgb' = 'hex',
+): string {
+  color1 = color1.trim();
+  color2 = color2.trim();
+  const c1 = toRGBA(color1);
+  const c2 = toRGBA(color2);
+  const result = [
+    r((1 - p) * c1[0] + p * c2[0]),
+    r((1 - p) * c1[1] + p * c2[1]),
+    r((1 - p) * c1[2] + p * c2[2]),
+    (1 - p) * c1[3] + p * c2[3],
+  ];
+  if (format === 'hex') {
+    const hex = [
+      result[0].toString(16).padStart(2, '0'),
+      result[1].toString(16).padStart(2, '0'),
+      result[2].toString(16).padStart(2, '0'),
+      result[3] === 0
+        ? '00'
+        : r(result[3] * 255)
+            .toString(16)
+            .padStart(2, '0'),
+    ];
+    return `#${hex[0]}${hex[1]}${hex[2]}${hex[3]}`;
+  }
+  return `rgb(${result[0]} ${result[1]} ${result[2]} / ${result[3]})`;
+}

package/src/utils/cookie-util/cookie-util.ts

@@ -0,0 +1,192 @@
+import { CoreConst } from '../../constant';
+
+/**
+ * @description 获取所有的访问数据键名称
+ * @returns {string[]} 包含所有访问数据键名称的数组，如果出现错误则返回空数组
+ */
+function getAccessStoreAreakeys(): string[] {
+  try {
+    const key = CoreConst.ACCESS_STORE_AREA_KEYS;
+    let cookieAlls;
+    switch (ibiz.env.accessStoreArea) {
+      case 'LOCALSTORAGE':
+        cookieAlls = localStorage.getItem(key);
+        break;
+      case 'SESSIONSTORAGE':
+        cookieAlls = sessionStorage.getItem(key);
+        break;
+      default:
+        break;
+    }
+    return JSON.parse(cookieAlls || '[]');
+  } catch (error) {
+    ibiz.log.error(error);
+    return [];
+  }
+}
+
+/**
+ * @description 将新的访问数据键名称添加到已有的名称列表中
+ * @param {string} name 要添加的访问数据键名称
+ */
+function setAccessStoreAreakeys(name: string): void {
+  try {
+    const cookieAlls: string[] = [
+      ...new Set(getAccessStoreAreakeys().concat([name])),
+    ];
+    const key = CoreConst.ACCESS_STORE_AREA_KEYS;
+    switch (ibiz.env.accessStoreArea) {
+      case 'LOCALSTORAGE':
+        return localStorage.setItem(key, JSON.stringify(cookieAlls));
+      case 'SESSIONSTORAGE':
+        return sessionStorage.setItem(key, JSON.stringify(cookieAlls));
+      default:
+        break;
+    }
+  } catch (error) {
+    ibiz.log.error(error);
+  }
+}
+
+/**
+ * @description 设置cookie
+ * @export
+ * @param {string} name    cookie名称
+ * @param {string} value   cookie值
+ * @param {number} [day=0] 过期天数
+ * @param {boolean} [isDomain=false] 是否设置在主域下
+ * @param {string} [path='/'] 默认归属路径
+ * @param {string} [childDoMain=''] 子域,如果外部有传递，则需把cookie数据设置到传入子域上
+ */
+export function setCookie(
+  name: string,
+  value: string,
+  day = 0,
+  isDomain = false,
+  path = '/',
+  childDoMain: string = '',
+): void {
+  let domain = '';
+  setAccessStoreAreakeys(name);
+  switch (ibiz.env.accessStoreArea) {
+    case 'LOCALSTORAGE':
+      return localStorage.setItem(name, value);
+    case 'SESSIONSTORAGE':
+      return sessionStorage.setItem(name, value);
+    default:
+      // 设置cookie到主域下
+      if (isDomain) {
+        // 是否为ip正则
+        const regExpr =
+          /^(25[0-5]|2[0-4]\d|[0-1]\d{2}|[1-9]?\d)\.(25[0-5]|2[0-4]\d|[0-1]\d{2}|[1-9]?\d)\.(25[0-5]|2[0-4]\d|[0-1]\d{2}|[1-9]?\d)\.(25[0-5]|2[0-4]\d|[0-1]\d{2}|[1-9]?\d)$/;
+        // 为ip时忽略
+        if (!regExpr.test(window.location.hostname)) {
+          const host = window.location.hostname;
+          if (host.indexOf('.') !== host.lastIndexOf('.')) {
+            domain = `;domain=${host.substring(host.indexOf('.'), host.length)}`;
+          }
+        }
+      } else if (childDoMain) {
+        domain = `;domain=${childDoMain}`;
+      }
+      // 当设置的时间等于0时，不设置expires属性，cookie在浏览器关闭后删除
+      if (day !== 0) {
+        const expires = day * 24 * 60 * 60 * 1000;
+        const date = new Date(new Date().getTime() + expires);
+        document.cookie = `${name}=${escape(
+          value,
+        )};path=${path};expires=${date.toUTCString()}${domain}`;
+      } else {
+        document.cookie = `${name}=${escape(value)};path=${path}${domain}`;
+      }
+      break;
+  }
+}
+
+/**
+ * @description 设置应用cookie
+ * @export
+ * @param {string} name 名称
+ * @param {string} value 值
+ * @param {number} [day=0] 过期天数
+ */
+export function setAppCookie(
+  name: string,
+  value: string,
+  day: number = 0,
+): void {
+  if (
+    ibiz.env.cookieDomain &&
+    window.location.href.indexOf(ibiz.env.cookieDomain) !== -1
+  ) {
+    setCookie(name, value, day, false, '/', ibiz.env.cookieDomain);
+  } else {
+    setCookie(name, value, day, true);
+  }
+}
+
+/**
+ * @description 清除应用cookie
+ * @export
+ * @param {string} cookieName
+ */
+export function clearAppCookie(cookieName: string): void {
+  if (
+    ibiz.env.cookieDomain &&
+    window.location.href.indexOf(ibiz.env.cookieDomain) !== -1
+  ) {
+    setCookie(cookieName, '', -1, false, '/', ibiz.env.cookieDomain);
+  } else {
+    setCookie(cookieName, '', -1, true);
+  }
+}
+/**
+ * @description 获取cookie
+ * @export
+ * @param {string} name
+ * @returns {*}  {(string | null)}
+ */
+export function getAppCookie(name: string): string | null {
+  const reg = new RegExp(`(^| )${name}=([^;]*)(;|$)`);
+  const arr = document.cookie.match(reg);
+  switch (ibiz.env.accessStoreArea) {
+    case 'LOCALSTORAGE':
+      return localStorage.getItem(name);
+    case 'SESSIONSTORAGE':
+      return sessionStorage.getItem(name);
+    default:
+      if (arr && arr.length > 1) {
+        return unescape(arr[2]);
+      }
+      return null;
+  }
+}
+
+/**
+ * @description 重置应用cookie
+ * @export
+ */
+export function resetAppCookie(): void {
+  const cookies = document.cookie.split(';');
+  const cookieAlls = getAccessStoreAreakeys().concat([
+    CoreConst.ACCESS_STORE_AREA_KEYS,
+  ]);
+  switch (ibiz.env.accessStoreArea) {
+    case 'LOCALSTORAGE':
+      for (const name of cookieAlls) {
+        localStorage.removeItem(name);
+      }
+      break;
+    case 'SESSIONSTORAGE':
+      for (const name of cookieAlls) {
+        sessionStorage.removeItem(name);
+      }
+      break;
+    default:
+      for (const cookie of cookies) {
+        const [cookieName, cookieValue] = cookie.split('=');
+        document.cookie = `${cookieName}=${cookieValue};expires=Thu, 01 Jan 1970 00:00:00 UTC;path=/;domain=${window.location.host}`;
+      }
+      break;
+  }
+}