@ibiz-template/core 0.0.1-alpha.6 → 0.0.1-beta.17

package/src/command/command-register.ts

@@ -0,0 +1,135 @@
+import {
+  ICommand,
+  ICommandHandler,
+  ICommandOption,
+  ICommandRegistry,
+  ICommandsMap,
+  IDisposable,
+} from './interface';
+import { LinkedList, toDisposable } from './utils';
+
+/**
+ * 命令注册中心
+ *
+ * @author chitanda
+ * @date 2022-06-27 13:06:50
+ * @export
+ * @class CommandRegisterService
+ * @implements {ICommandRegistry}
+ */
+export class CommandsRegistry implements ICommandRegistry {
+  /**
+   * 已经注册的所有指令
+   *
+   * @author chitanda
+   * @date 2022-07-21 15:07:47
+   * @private
+   */
+  private readonly commands = new Map<string, LinkedList<ICommand>>();
+
+  /**
+   * 注册指令
+   *
+   * @author chitanda
+   * @date 2022-06-27 13:06:31
+   * @param {(string | ICommand)} idOrCommand
+   * @param {ICommandHandler} [handler]
+   * @return {*}  {IDisposable}
+   */
+  registerCommand(
+    idOrCommand: string | ICommand,
+    handler?: ICommandHandler,
+    opts?: ICommandOption,
+  ): IDisposable {
+    if (!idOrCommand) {
+      throw new Error(`invalid command`);
+    }
+
+    if (typeof idOrCommand === 'string') {
+      if (!handler) {
+        throw new Error(`invalid command`);
+      }
+      return this.registerCommand({ id: idOrCommand, handler, opts });
+    }
+
+    const { id } = idOrCommand;
+
+    let commands = this.commands.get(id);
+    if (!commands) {
+      commands = new LinkedList<ICommand>();
+      this.commands.set(id, commands);
+    }
+
+    const removeFn = commands.unshift(idOrCommand);
+
+    const ret = toDisposable(() => {
+      removeFn();
+      const command = this.commands.get(id);
+      if (command?.isEmpty()) {
+        this.commands.delete(id);
+      }
+    });
+
+    return ret;
+  }
+
+  /**
+   * 指令是否已经注册
+   *
+   * @author chitanda
+   * @date 2022-07-21 15:07:58
+   * @param {string} id
+   * @return {*}  {boolean}
+   */
+  hasCommand(id: string): boolean {
+    return this.commands.has(id);
+  }
+
+  /**
+   * 查找指令
+   *
+   * @author chitanda
+   * @date 2022-07-21 16:07:12
+   * @param {string} id
+   * @return {*}  {(ICommand | undefined)}
+   */
+  getCommand(id: string): ICommand | undefined {
+    const list = this.commands.get(id);
+    if (!list || list.isEmpty()) {
+      return undefined;
+    }
+    return list[Symbol.iterator]().next().value;
+  }
+
+  /**
+   * 获取所有指令
+   *
+   * @author chitanda
+   * @date 2022-07-21 16:07:20
+   * @return {*}  {ICommandsMap}
+   */
+  getCommands(): ICommandsMap {
+    const result = new Map<string, ICommand>();
+    const keys = this.commands.keys();
+    for (const key of keys) {
+      const command = this.getCommand(key);
+      if (command) {
+        result.set(key, command);
+      }
+    }
+    return result;
+  }
+
+  /**
+   * 获取指令配置参数
+   *
+   * @author chitanda
+   * @date 2022-07-21 16:07:27
+   * @param {string} id
+   * @return {*}  {(ICommandOption | undefined)}
+   */
+  getCommandOpt(id: string): ICommandOption | undefined {
+    const cmd = this.getCommand(id);
+    return cmd?.opts;
+  }
+}

package/src/command/command.ts

@@ -0,0 +1,79 @@
+import { ICommandHandler, ICommandOption, IDisposable } from './interface';
+import { CommandsRegistry } from './command-register';
+
+/**
+ * 指令控制器
+ *
+ * @author chitanda
+ * @date 2022-06-28 19:06:51
+ * @export
+ * @class CommandController
+ */
+export class CommandController {
+  private commandRegister = new CommandsRegistry();
+
+  /**
+   * 注册指令
+   *
+   * @author chitanda
+   * @date 2022-06-28 19:06:45
+   * @param {string} id
+   * @param {ICommandHandler} handler
+   * @param {ICommandOption} [opts]
+   * @return {*}  {IDisposable}
+   */
+  register(
+    id: string,
+    handler: ICommandHandler,
+    opts?: ICommandOption,
+  ): IDisposable {
+    return this.commandRegister.registerCommand(id, handler, opts);
+  }
+
+  /**
+   * 执行指令
+   *
+   * @author chitanda
+   * @date 2022-06-28 19:06:38
+   * @template T
+   * @param {string} id
+   * @param {...unknown[]} args
+   * @return {*}  {Promise<T>}
+   */
+  async execute<T = undefined>(id: string, ...args: unknown[]): Promise<T> {
+    const command = this.commandRegister.getCommand(id);
+    if (command) {
+      return command.handler(...args) as T | Promise<T>;
+    }
+    throw new Error(`未注册指令: ${id}，请先注册指令`);
+  }
+
+  /**
+   * 判断指令是否存在，可直接抛出异常
+   *
+   * @author chitanda
+   * @date 2022-06-28 19:06:11
+   * @param {string} id
+   * @param {boolean} [err]
+   * @return {*}  {boolean}
+   */
+  hasCommand(id: string, err?: boolean): boolean {
+    const bol = !!this.commandRegister.hasCommand(id);
+    if (err === true && bol === true) {
+      throw new Error(`未注册指令: ${id}，请先注册指令`);
+    }
+    return bol;
+  }
+
+  /**
+   * 获取指令配置参数
+   *
+   * @author chitanda
+   * @date 2022-07-21 17:07:11
+   * @param {string} id
+   * @return {*}  {(ICommandOption | undefined)}
+   */
+  getCommandOpts(id: string): ICommandOption | undefined {
+    return this.commandRegister.getCommandOpt(id);
+  }
+}

package/src/command/index.ts

@@ -0,0 +1,11 @@
+import { CommandController } from './command';
+
+export * from './interface';
+export * from './utils';
+export { CommandsRegistry } from './command-register';
+export { CommandController } from './command';
+
+/**
+ * 命令控制器
+ */
+export const commands = new CommandController();

package/src/command/interface/command/command-option.ts

@@ -0,0 +1,22 @@
+/**
+ * 指令参数, 主要用于在指令呈现时的展示参数
+ *
+ * @author chitanda
+ * @date 2022-06-28 17:06:47
+ * @export
+ * @interface ICommandOption
+ */
+export interface ICommandOption {
+  readonly id: string;
+  readonly title: string;
+  readonly tooltip?: string;
+  readonly description?: string;
+  /**
+   * 只支持 svg 图标
+   *
+   * @author chitanda
+   * @date 2022-06-29 14:06:42
+   * @type {string}
+   */
+  readonly icon?: string;
+}

package/src/command/interface/command/command.ts

@@ -0,0 +1,86 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IDisposable } from '../disposable/disposable';
+import { ICommandOption } from './command-option';
+
+/**
+ * 注册指令
+ *
+ * @author chitanda
+ * @date 2022-06-27 13:06:25
+ * @export
+ * @interface ICommand
+ */
+export interface ICommand {
+  id: string;
+  handler: ICommandHandler;
+  opts?: ICommandOption;
+}
+
+/**
+ * 触发指令声明
+ *
+ * @author chitanda
+ * @date 2022-06-28 17:06:10
+ * @export
+ * @interface Command
+ */
+export interface Command {
+  /**
+   * Title of the command, like `save`.
+   */
+  title: string;
+
+  /**
+   * The identifier of the actual command handler.
+   * @see {@link commands.registerCommand}
+   */
+  command: string;
+
+  /**
+   * A tooltip for the command, when represented in the UI.
+   */
+  tooltip?: string;
+
+  /**
+   * Arguments that the command handler should be
+   * invoked with.
+   */
+  arguments?: any[];
+}
+
+/**
+ * 指令处理回调
+ *
+ * @author chitanda
+ * @date 2022-06-27 13:06:33
+ * @export
+ * @interface ICommandHandler
+ */
+export interface ICommandHandler {
+  (...args: any[]): unknown | Promise<unknown>;
+}
+
+/**
+ * 指令控制器集
+ */
+export type ICommandsMap = Map<string, ICommand>;
+
+/**
+ * 注册服务
+ *
+ * @author chitanda
+ * @date 2022-06-27 13:06:16
+ * @export
+ * @interface ICommandRegistry
+ */
+export interface ICommandRegistry {
+  registerCommand(
+    id: string,
+    command: ICommandHandler,
+    opts: ICommandOption,
+  ): IDisposable;
+  registerCommand(id: string, command: ICommandHandler): IDisposable;
+  registerCommand(command: ICommand): IDisposable;
+  getCommand(id: string): ICommand | undefined;
+  getCommands(): ICommandsMap;
+}

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

@@ -0,0 +1,3 @@
+export interface IDisposable {
+  dispose(): void;
+}

package/src/command/interface/index.ts

@@ -0,0 +1,9 @@
+export {
+  ICommand,
+  Command,
+  ICommandHandler,
+  ICommandsMap,
+  ICommandRegistry,
+} from './command/command';
+export { ICommandOption } from './command/command-option';
+export { IDisposable } from './disposable/disposable';

package/src/command/utils/index.ts

@@ -0,0 +1,2 @@
+export { LinkedList } from './linked-list';
+export { toDisposable, debounce, throttle } from './util';

package/src/command/utils/linked-list.ts

@@ -0,0 +1,136 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable max-classes-per-file */
+class Node<E> {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static readonly Undefined = new Node<any>(undefined);
+
+  element: E;
+
+  next: Node<E>;
+
+  prev: Node<E>;
+
+  constructor(element: E) {
+    this.element = element;
+    this.next = Node.Undefined;
+    this.prev = Node.Undefined;
+  }
+}
+
+export class LinkedList<E> {
+  private _first: Node<E> = Node.Undefined;
+
+  private _last: Node<E> = Node.Undefined;
+
+  private _size: number = 0;
+
+  get size(): number {
+    return this._size;
+  }
+
+  isEmpty(): boolean {
+    return this._first === Node.Undefined;
+  }
+
+  clear(): void {
+    let node = this._first;
+    while (node !== Node.Undefined) {
+      const { next } = node;
+      node.prev = Node.Undefined;
+      node.next = Node.Undefined;
+      node = next;
+    }
+
+    this._first = Node.Undefined;
+    this._last = Node.Undefined;
+    this._size = 0;
+  }
+
+  unshift(element: E): () => void {
+    return this._insert(element, false);
+  }
+
+  push(element: E): () => void {
+    return this._insert(element, true);
+  }
+
+  private _insert(element: E, atTheEnd: boolean): () => void {
+    const newNode = new Node(element);
+    if (this._first === Node.Undefined) {
+      this._first = newNode;
+      this._last = newNode;
+    } else if (atTheEnd) {
+      // push
+      const oldLast = this._last!;
+      this._last = newNode;
+      newNode.prev = oldLast;
+      oldLast.next = newNode;
+    } else {
+      // unshift
+      const oldFirst = this._first;
+      this._first = newNode;
+      newNode.next = oldFirst;
+      oldFirst.prev = newNode;
+    }
+    this._size += 1;
+
+    let didRemove = false;
+    return () => {
+      if (!didRemove) {
+        didRemove = true;
+        this._remove(newNode);
+      }
+    };
+  }
+
+  shift(): E | undefined {
+    if (this._first === Node.Undefined) {
+      return undefined;
+    }
+    const res = this._first.element;
+    this._remove(this._first);
+    return res;
+  }
+
+  pop(): E | undefined {
+    if (this._last === Node.Undefined) {
+      return undefined;
+    }
+    const res = this._last.element;
+    this._remove(this._last);
+    return res;
+  }
+
+  private _remove(node: Node<E>): void {
+    if (node.prev !== Node.Undefined && node.next !== Node.Undefined) {
+      // middle
+      const anchor = node.prev;
+      anchor.next = node.next;
+      node.next.prev = anchor;
+    } else if (node.prev === Node.Undefined && node.next === Node.Undefined) {
+      // only node
+      this._first = Node.Undefined;
+      this._last = Node.Undefined;
+    } else if (node.next === Node.Undefined) {
+      // last
+      this._last = this._last!.prev!;
+      this._last.next = Node.Undefined;
+    } else if (node.prev === Node.Undefined) {
+      // first
+      this._first = this._first!.next!;
+      this._first.prev = Node.Undefined;
+    }
+
+    // done
+    this._size -= 1;
+  }
+
+  *[Symbol.iterator](): Iterator<E> {
+    let node = this._first;
+    while (node !== Node.Undefined) {
+      yield node.element;
+      node = node.next;
+    }
+  }
+}

package/src/command/utils/util.ts

@@ -0,0 +1,95 @@
+/* eslint-disable func-names */
+/* eslint-disable prefer-rest-params */
+/* eslint-disable no-underscore-dangle */
+import { IDisposable } from '../interface';
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+export function once<T extends Function>(this: unknown, fn: T): T {
+  // eslint-disable-next-line @typescript-eslint/no-this-alias
+  const _this = this;
+  let didCall = false;
+  let result: unknown;
+
+  return function () {
+    if (didCall) {
+      return result;
+    }
+
+    didCall = true;
+    result = fn.apply(_this, arguments);
+
+    return result;
+  } as unknown as T;
+}
+
+export function toDisposable(fn: () => void): IDisposable {
+  const self = {
+    dispose: once(() => {
+      fn();
+    }),
+  };
+  return self;
+}
+
+/**
+ * 函数防抖---“立即执行版本” 和 “非立即执行版本” 的组合版本
+ *
+ * @author chitanda
+ * @date 2022-06-29 19:06:15
+ * @export
+ * @param {((...args: unknown[]) => void | Promise<void>)} func 处理函数
+ * @param {number} wait 延迟执行时间（毫秒）
+ * @param {boolean} [immediate] 是否立即执行
+ * @return {*}  {(...args: unknown[]) => void}
+ */
+export function debounce(
+  func: (...args: unknown[]) => void | Promise<void>,
+  wait: number,
+  immediate?: boolean,
+): (...args: unknown[]) => void {
+  let timer: unknown;
+
+  return function (this: unknown, ...args: unknown[]): void {
+    if (timer) {
+      clearTimeout(timer as number);
+    }
+    if (immediate) {
+      const callNow = !timer;
+      timer = setTimeout(() => {
+        timer = null;
+      }, wait);
+      if (callNow) {
+        func.apply(this, args);
+      }
+    } else {
+      timer = setTimeout(() => {
+        func.apply(this, args);
+      }, wait);
+    }
+  };
+}
+
+/**
+ * 节流函数
+ *
+ * @author chitanda
+ * @date 2022-06-29 20:06:38
+ * @export
+ * @param {((...args: unknown[]) => void | Promise<void>)} fn
+ * @param {number} wait
+ * @return {*}  {(...args: unknown[]) => void}
+ */
+export function throttle(
+  fn: (...args: unknown[]) => void | Promise<void>,
+  wait: number,
+): (...args: unknown[]) => void {
+  let timer: unknown = null;
+  return function (this: unknown, ...args: unknown[]): void {
+    if (!timer) {
+      timer = setTimeout(() => {
+        fn.apply(this, args);
+        timer = null;
+      }, wait);
+    }
+  };
+}

package/src/constant/index.ts

@@ -1,2 +1,5 @@
 export { CoreConst } from './core/core';
+export * from './util/util';
 export { HttpStatusMessageConst } from './http-status-message/http-status-message';
+export { LoginMode } from './login-mode/login-mode';
+export { MenuPermissionMode } from './menu-permission-mode/menu-permission-mode';

package/src/constant/login-mode/login-mode.ts

@@ -0,0 +1,23 @@
+/* eslint-disable no-shadow */
+/**
+ * 登录模式
+ *
+ * @author lxm
+ * @date 2022-10-12 14:10:56
+ * @export
+ * @enum {number}
+ */
+export enum LoginMode {
+  /**
+   * 默认标准登录
+   */
+  DEFAULT = 'DEFAULT',
+  /**
+   * 自定义登录
+   */
+  CUSTOM = 'CUSTOM',
+  /**
+   * 中央认证登录
+   */
+  CAS = 'CAS',
+}

package/src/constant/menu-permission-mode/menu-permission-mode.ts

@@ -0,0 +1,23 @@
+/* eslint-disable no-shadow */
+/**
+ * 菜单权限校验模式
+ *
+ * @author lxm
+ * @date 2022-10-12 14:10:56
+ * @export
+ * @enum {number}
+ */
+export enum MenuPermissionMode {
+  /**
+   * 混合模式（默认）
+   */
+  MIXIN = 'MIXIN',
+  /**
+   * 统一资源模式
+   */
+  RESOURCE = 'RESOURCE',
+  /**
+   * RT模式
+   */
+  RT = 'RT',
+}

package/src/constant/util/util.ts

@@ -0,0 +1,5 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+/**
+ * 无操作函数
+ */
+export const NOOP = () => {};