@ibiz-template/core 0.0.1-alpha.4 → 0.0.1-alpha.40

package/src/install.ts

@@ -1,5 +1,6 @@
+import { FactoryCenter } from './factory-center';
 import { IBizSys } from './ibizsys';
-import { Interceptor } from './utils';
+import { CoreInterceptor } from './utils';
 
 /**
  * 初始化全局对象
@@ -13,5 +14,6 @@ export function install(): void {
     throw new Error('ibiz 已经存在, 无需重复安装');
   }
   window.ibiz = new IBizSys();
-  new Interceptor();
+  window.___fc = new FactoryCenter();
+  ibiz.net.addInterceptor('CoreInterceptor', new CoreInterceptor());
 }

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

@@ -0,0 +1,71 @@
+/**
+ * 可选配置参数
+ *
+ * @author lxm
+ * @date 2022-10-28 16:10:48
+ * @export
+ * @interface OnClickOutsideOptions
+ * @extends {ConfigurableWindow}
+ * @template E
+ */
+export interface OnClickOutsideOptions {
+  /**
+   * 指定使用的window,不给就用默认的window
+   * 一般是在iframe或测试环境中使用。
+   *
+   * @author lxm
+   * @date 2022-10-28 17:10:49
+   * @type {Window}
+   */
+  window?: Window;
+  /**
+   * 指定需要忽略的元素，用于排除某些外部的元素
+   *
+   * @author lxm
+   * @date 2022-10-28 17:10:50
+   * @type {HTMLElement[]}
+   */
+  ignore?: HTMLElement[];
+  /**
+   * 是否捕获内部元素。默认为是，内部元素不会触发回调。
+   * @default true
+   */
+  capture?: boolean;
+}
+
+/**
+ * 回调处理函数类型
+ */
+export type OnClickOutsideHandler = (_evt: PointerEvent | MouseEvent) => void;
+
+/**
+ * OnClickOutside返回对象类型
+ *
+ * @author lxm
+ * @date 2022-10-31 11:10:59
+ * @export
+ * @interface OnClickOutsideResult
+ */
+export interface OnClickOutsideResult {
+  /**
+   * 停止监听，并移除相关监听事件
+   *
+   * @author lxm
+   * @date 2022-10-31 11:10:28
+   */
+  stop: () => void;
+  /**
+   * 暂停监听
+   *
+   * @author lxm
+   * @date 2022-10-31 11:10:30
+   */
+  pause: () => void;
+  /**
+   * 继续监听
+   *
+   * @author lxm
+   * @date 2022-10-31 11:10:32
+   */
+  proceed: () => void;
+}

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

@@ -1,3 +1,6 @@
+import { LogLevelDesc } from 'loglevel';
+import { LoginMode, MenuPermissionMode } from '../../constant';
+
 /**
  * 配置参数
  *
@@ -16,6 +19,35 @@ export interface IEnvironment {
    */
   namespace?: string;
 
+  /**
+   * 是否为开发模式
+   *
+   * @default false
+   * @author chitanda
+   * @date 2022-10-21 11:10:29
+   * @type {boolean}
+   */
+  dev: boolean;
+
+  /**
+   * 日志级别
+   *
+   * @author chitanda
+   * @date 2022-10-25 20:10:55
+   * @type {LogLevelDesc}
+   */
+  logLevel: LogLevelDesc;
+
+  /**
+   * js 静态文件 cdn 地址
+   *
+   * @default https://cdn.jsdelivr.net/
+   * @author chitanda
+   * @date 2022-10-24 11:10:14
+   * @type {string}
+   */
+  jsCdn: string;
+
   /**
    * 请求根路径
    *
@@ -25,6 +57,42 @@ export interface IEnvironment {
    */
   baseUrl: string;
 
+  /**
+   * 插件默认所在目录
+   *
+   * @author chitanda
+   * @date 2022-10-31 14:10:49
+   * @type {string}
+   */
+  pluginBaseUrl: string;
+
+  /**
+   * 登录模式
+   *
+   * @author lxm
+   * @date 2022-10-12 14:10:51
+   * @type {LoginMode}
+   */
+  loginMode: LoginMode;
+
+  /**
+   * 中央认证登录地址
+   *
+   * @author lxm
+   * @date 2022-10-11 12:10:21
+   * @type {string}
+   */
+  casLoginUrl: string;
+
+  /**
+   * 远程模型路径
+   *
+   * @author chitanda
+   * @date 2022-09-22 18:09:25
+   * @type {string}
+   */
+  remoteModelUrl: string;
+
   /**
    * 资源文件根路径
    *
@@ -60,4 +128,22 @@ export interface IEnvironment {
    * @type {string}
    */
   UploadFile: string;
+
+  /**
+   * 是否启用权限校验（默认true）
+   *
+   * @author lxm
+   * @date 2022-10-12 18:10:25
+   * @type {boolean}
+   */
+  enablePermission: boolean;
+
+  /**
+   * 菜单权限校验模式（默认MIXIN）
+   *
+   * @author lxm
+   * @date 2022-10-12 18:10:27
+   * @type {MenuPermissionMode}
+   */
+  menuPermissionMode: MenuPermissionMode;
 }

package/src/interface/index.ts

@@ -1,2 +1,3 @@
 export { IEnvironment } from './i-environment/i-environment';
 export { OrgData } from './org-data/org-data';
+export * from './click-outside/click-outside';

package/src/types.ts

@@ -1,11 +1,21 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import { FactoryCenter } from './factory-center';
 import { IBizSys } from './ibizsys';
 
 declare global {
   const ibiz: IBizSys;
+  const ___fc: FactoryCenter;
 
   interface Window {
     ibiz: IBizSys;
+    /**
+     * 全局工厂中心
+     *
+     * @author lxm
+     * @date 2022-10-17 15:10:43
+     * @type {FactoryCenter}
+     */
+    ___fc: FactoryCenter;
   }
 
   /**
@@ -40,4 +50,15 @@ declare global {
   interface IData {
     [key: string | symbol]: any;
   }
+
+  /**
+   * 任意对象结构
+   *
+   * @author chitanda
+   * @date 2022-09-21 15:09:30
+   * @interface IObject
+   */
+  interface IObject {
+    [key: string | symbol]: any;
+  }
 }

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

@@ -0,0 +1,110 @@
+import { RuntimeError } from '../../error';
+import {
+  OnClickOutsideHandler,
+  OnClickOutsideOptions,
+  OnClickOutsideResult,
+} from '../../interface';
+import { eventPath, isEventInside, listenJSEvent } from '../event/event';
+
+const defaultWindow = typeof window !== 'undefined' ? window : undefined;
+
+/**
+ * 监听目标元素之外的点击事件回调
+ *
+ * @author lxm
+ * @date 2022-10-28 18:10:25
+ * @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('target元素不存在');
+  if (!window) throw new RuntimeError('找不到window');
+
+  /** 是否需要监听，为false时handler不会执行 */
+  let shouldListen = true;
+
+  /**
+   * 判断event的触发是否是在元素的外部(排除了ignore元素)
+   * @param event 事件对象
+   * @returns
+   */
+  const isOutside = (event: MouseEvent) => {
+    // 有一个判断是在内部，则不算外部，返回false
+    return ![target, ...ignore].some(el => {
+      return isEventInside(event, el);
+    });
+  };
+
+  /** 暂停，所有监听的回调都不执行，用于增强某些ignore无法实现的场景 */
+  let isPaused = false;
+  const pause = () => {
+    isPaused = true;
+  };
+  const proceed = () => {
+    isPaused = false;
+  };
+
+  /** pointerup延时触发标识 */
+  let fallback: number;
+
+  /**
+   * 事件监听处理回调
+   * @param event 事件对象
+   * @returns
+   */
+  const listener = (event: MouseEvent) => {
+    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 = () => path;
+          fallback = window.setTimeout(() => listener(e), 50);
+        }
+      },
+      { passive: true },
+    ),
+  ].filter(Boolean);
+
+  /**
+   * 停止事件监听，移除监听
+   */
+  const stop = () => cleanups.forEach(fn => fn());
+  return { stop, pause, proceed };
+}

package/src/utils/event/event.ts

@@ -0,0 +1,77 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { NOOP } from '../../constant';
+
+/**
+ * 计算event的composedPath返回事件路径(兼容了IE)
+ *
+ * @author lxm
+ * @date 2022-10-28 17:10:14
+ * @param {MouseEvent} event
+ * @returns {*}
+ */
+export function eventPath(event: MouseEvent): (EventTarget | null)[] {
+  const path = ((event.composedPath && event.composedPath()) ||
+    (event as any).path) as HTMLElement[] | undefined;
+
+  if (path != null) return path;
+
+  // 浏览器没有提供的，自己递归计算
+  function getParents(
+    node: HTMLElement,
+    memo: HTMLElement[] = [],
+  ): HTMLElement[] {
+    const parentNode = node.parentNode as HTMLElement | null;
+
+    return parentNode
+      ? getParents(parentNode, memo.concat([parentNode]))
+      : memo;
+  }
+
+  return [event.target].concat(getParents(event.target as HTMLElement));
+}
+
+/**
+ * 监听JS原生事件，返回cleanup回调，调用后删除该监听
+ *
+ * @author lxm
+ * @date 2022-10-28 18:10:36
+ * @export
+ * @param {EventTarget} target 监听对象
+ * @param {string} eventName 监听事件名称
+ * @param {(..._args: any[]) => any} listener 监听回调
+ * @param {AddEventListenerOptions} options 额外参数
+ * @returns {*}  {() => void}
+ */
+export function listenJSEvent(
+  target: EventTarget,
+  eventName: string,
+  listener: (..._args: any[]) => any,
+  options: AddEventListenerOptions = {},
+): () => void {
+  target.addEventListener(eventName, listener, options);
+
+  let cleanup = () => {
+    target.removeEventListener(eventName, listener, options);
+    // cleanup方法只能调用一次
+    cleanup = NOOP;
+  };
+
+  return () => {
+    cleanup();
+  };
+}
+
+/**
+ * event是否是在目标元素内部触发的
+ *
+ * @author lxm
+ * @date 2022-10-31 11:10:49
+ * @export
+ * @param {MouseEvent} event 原生事件
+ * @param {HTMLElement} el 目标元素
+ * @returns {*}  {boolean}
+ */
+export function isEventInside(event: MouseEvent, el: HTMLElement): boolean {
+  return el && (event.target === el || eventPath(event).includes(el));
+}

package/src/utils/index.ts

@@ -1,6 +1,10 @@
-export { Interceptor } from './interceptor/interceptor';
+export * from './interceptor';
+export { Logger } from './logger/logger';
 export { Namespace } from './namespace/namespace';
 export { IHttpResponse, HttpResponse } from './net/http-response';
 export { Net } from './net/net';
 export { plural, pluralLower } from './plural/plural';
 export * from './util/util';
+export * from './url-helper/url-helper';
+export * from './event/event';
+export * from './click-outside/click-outside';

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

@@ -0,0 +1,35 @@
+import { AxiosRequestConfig } from 'axios';
+import { getToken } from '../util/util';
+import { Interceptor } from './interceptor';
+
+/**
+ * 核心包拦截器
+ *
+ * @author lxm
+ * @date 2022-10-27 17:10:48
+ * @export
+ * @class CoreInterceptor
+ * @extends {Interceptor}
+ */
+export class CoreInterceptor extends Interceptor {
+  protected async onBeforeRequest(
+    config: AxiosRequestConfig,
+  ): Promise<AxiosRequestConfig> {
+    await super.onBeforeRequest(config);
+
+    if (!config.headers) {
+      config.headers = {};
+    }
+    config.headers.Authorization = `Bearer ${getToken()}`;
+    const { orgData } = ibiz;
+    if (orgData) {
+      if (orgData.systemid) {
+        config.headers.srfsystemid = orgData.systemid;
+      }
+      if (orgData.orgid) {
+        config.headers.srforgid = orgData.orgid;
+      }
+    }
+    return config;
+  }
+}

package/src/utils/interceptor/index.ts

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

package/src/utils/interceptor/interceptor.ts

@@ -1,8 +1,8 @@
-import axios from 'axios';
-import { getToken } from '../util/util';
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 
 /**
- * 默认请求拦截器
+ * 拦截器基类
  *
  * @author chitanda
  * @date 2022-07-20 18:07:11
@@ -10,26 +10,113 @@ import { getToken } from '../util/util';
  * @class Interceptor
  */
 export class Interceptor {
-  constructor() {
-    this.init();
+  /**
+   * 请求拦截器绑定标识
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:20
+   * @private
+   * @type {number}
+   */
+  private requestTag?: number;
+
+  /**
+   * 响应拦截器绑定标识
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:19
+   * @private
+   * @type {number}
+   */
+  private responseTag?: number;
+
+  /**
+   * 请求之前处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:41
+   * @protected
+   * @param {AxiosRequestConfig} config
+   * @returns {*}  {Promise<AxiosRequestConfig>}
+   */
+  protected async onBeforeRequest(
+    config: AxiosRequestConfig,
+  ): Promise<AxiosRequestConfig> {
+    return config;
+  }
+
+  /**
+   * 请求失败之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:40
+   * @protected
+   * @param {*} error
+   */
+  protected onRequestError(error: any) {
+    // 处理请求错误
+    return Promise.reject(error);
+  }
+
+  /**
+   * 响应成功之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:38
+   * @protected
+   * @param {AxiosResponse} config
+   * @returns {*}  {Promise<AxiosRequestConfig>}
+   */
+  protected async onResponseSuccess(
+    config: AxiosResponse,
+  ): Promise<AxiosResponse> {
+    return config;
+  }
+
+  /**
+   * 响应失败之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:37
+   * @protected
+   * @param {*} _error
+   */
+  protected onResponseError(error: any) {
+    // 处理响应错误
+    return Promise.reject(error);
+  }
+
+  /**
+   * 使用拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:28
+   * @param {AxiosInstance} instance
+   */
+  use(instance: AxiosInstance): void {
+    this.requestTag = instance.interceptors.request.use(
+      this.onBeforeRequest,
+      this.onRequestError,
+    );
+    this.responseTag = instance.interceptors.response.use(
+      this.onResponseSuccess,
+      this.onResponseError,
+    );
   }
 
-  protected init(): void {
-    axios.interceptors.request.use(config => {
-      if (!config.headers) {
-        config.headers = {};
-      }
-      config.headers.Authorization = `Bearer ${getToken()}`;
-      const { orgData } = ibiz;
-      if (orgData) {
-        if (orgData.systemid) {
-          config.headers.srfsystemid = orgData.systemid;
-        }
-        if (orgData.orgid) {
-          config.headers.srforgid = orgData.orgid;
-        }
-      }
-      return config;
-    });
+  /**
+   * 移出拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:27
+   * @param {AxiosInstance} instance
+   */
+  eject(instance: AxiosInstance) {
+    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,3 @@
+import * as Logger from 'loglevel';
+
+export { Logger };

package/src/utils/net/http-response.ts

@@ -28,7 +28,7 @@ export interface IHttpResponse<T = IData> extends AxiosResponse {
    * @date 2022-08-18 15:08:44
    * @type {boolean}
    */
-  local?: boolean;
+  local: boolean;
 
   data: T;
 
@@ -75,14 +75,11 @@ export class HttpResponse<T = IData> implements IHttpResponse<T> {
 
   statusText: string;
 
-  /**
-   * header 本地仿造时值为空
-   *
-   * @author chitanda
-   * @date 2022-08-18 15:08:46
-   * @type {AxiosResponseHeaders}
-   */
-  headers: AxiosResponseHeaders = {};
+  headers:
+    | AxiosResponseHeaders
+    | Partial<
+        Record<string, string> & { 'set-cookie'?: string[] | undefined }
+      > = {};
 
   /**
    * AxiosResponse 本地仿造时值为空