@ibiz-template/core 0.0.1-beta.1 → 0.0.1-beta.17

package/out/utils/upload/select-file.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 文件List转数组
+ *
+ * @author lxm
+ * @date 2022-11-18 13:11:03
+ * @export
+ * @param {FileList} fileList
+ * @returns {*}
+ */
+export declare function fileListToArr(fileList: FileList): File[];
+/**
+ * JS打开文件上传操作配置参数
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:47
+ * @export
+ * @interface SelectFileOpts
+ */
+export interface SelectFileOpts {
+    /**
+     * 接受的文件类型
+     *
+     * @author lxm
+     * @date 2022-11-20 21:11:52
+     * @type {string}
+     */
+    accept?: string;
+    /**
+     * 是否支持多选
+     *
+     * @author lxm
+     * @date 2022-11-20 21:11:52
+     * @type {boolean}
+     */
+    multiple?: boolean;
+    /**
+     * 选中文件后回调
+     *
+     * @author lxm
+     * @date 2022-11-20 21:11:50
+     */
+    onSelected: (_fileList: File[]) => void;
+}
+/**
+ * JS打开文件上传操作
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:31
+ * @export
+ * @param {SelectFileOpts} _opts 配置参数
+ */
+export declare function selectFile(_opts: SelectFileOpts): void;
+//# sourceMappingURL=select-file.d.ts.map

package/out/utils/upload/select-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"select-file.d.ts","sourceRoot":"","sources":["../../../src/utils/upload/select-file.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,EAAE,CAMxD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,UAAU,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,cAAc,QAwB/C"}

package/out/utils/upload/select-file.js

@@ -0,0 +1,47 @@
+import { merge } from 'lodash-es';
+/**
+ * 文件List转数组
+ *
+ * @author lxm
+ * @date 2022-11-18 13:11:03
+ * @export
+ * @param {FileList} fileList
+ * @returns {*}
+ */
+export function fileListToArr(fileList) {
+    const files = [];
+    for (let i = 0; i < fileList.length; i++) {
+        files.push(fileList[i]);
+    }
+    return files;
+}
+/**
+ * JS打开文件上传操作
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:31
+ * @export
+ * @param {SelectFileOpts} _opts 配置参数
+ */
+export function selectFile(_opts) {
+    const opts = merge({
+        multiple: true,
+        accept: '',
+    }, _opts);
+    const input = document.createElement('input');
+    input.setAttribute('type', 'file');
+    input.setAttribute('multiple', `${opts.multiple}`);
+    input.setAttribute('accept', opts.accept);
+    input.onchange = e => {
+        const inputEl = e.target;
+        const files = inputEl.files ? fileListToArr(inputEl.files) : [];
+        if (files.length === 0) {
+            return;
+        }
+        opts.onSelected(files);
+        inputEl.value = ''; // 如果不置空，相同的文件不会触发change事件
+    };
+    document.body.appendChild(input);
+    input.click();
+    document.body.removeChild(input);
+}

package/out/utils/upload/upload-file.d.ts

@@ -0,0 +1,46 @@
+import { HttpResponse } from '../net/http-response';
+export interface IUploadFile {
+    name: string;
+    uid: string;
+    status: 'uploading' | 'finished' | 'fail' | 'cancel';
+    percentage: number;
+    response?: HttpResponse;
+    error?: unknown;
+}
+export interface IUploadFileOpts {
+    uploadUrl: string;
+    /**
+     * 接受的文件类型
+     *
+     * @author lxm
+     * @date 2022-11-20 21:11:52
+     * @type {string}
+     */
+    accept?: string;
+    /**
+     * 是否支持多选
+     *
+     * @author lxm
+     * @date 2022-11-20 21:11:52
+     * @type {Boolean}
+     */
+    multiple?: boolean;
+    separate?: string;
+    request?: (_files: File[]) => Promise<HttpResponse>;
+    beforeUpload?: (_fileData: File[], _files: IUploadFile[]) => boolean;
+    finish?: (_resultFiles: IUploadFile[]) => void;
+    success?: (_resultFiles: IUploadFile[], _res: HttpResponse) => void;
+    error?: (_resultFiles: IUploadFile[], _error: unknown) => void;
+    progress?: (_files: IUploadFile[]) => void;
+}
+/**
+ * 使用上传文件逻辑
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:52
+ * @export
+ * @param {IUploadFileOpts} _opts
+ * @returns {*}
+ */
+export declare function uploadFile(_opts: IUploadFileOpts): void;
+//# sourceMappingURL=upload-file.d.ts.map

package/out/utils/upload/upload-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-file.d.ts","sourceRoot":"","sources":["../../../src/utils/upload/upload-file.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGpD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACpD,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,OAAO,CAAC;IACrE,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,EAAE,KAAK,IAAI,CAAC;IAC/C,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;IACpE,KAAK,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/D,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,IAAI,CAAC;CAC5C;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,QA0JhD"}

package/out/utils/upload/upload-file.js

@@ -0,0 +1,150 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+/* eslint-disable no-param-reassign */
+import { cloneDeep, isFunction, merge, round, uniqueId } from 'lodash-es';
+import { selectFile } from './select-file';
+/**
+ * 使用上传文件逻辑
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:52
+ * @export
+ * @param {IUploadFileOpts} _opts
+ * @returns {*}
+ */
+export function uploadFile(_opts) {
+    const opts = merge({
+        multiple: true,
+        accept: '',
+        separate: true,
+        beforeUpload: (_fileData, _files) => true,
+        finish: (_resultFiles) => { },
+        success: (_resultFiles, _res) => { },
+        error: (_resultFiles, _error) => { },
+        progress: (_files) => { },
+    }, _opts);
+    /**
+     * 进度条回调
+     *
+     * @author lxm
+     * @date 2022-11-20 21:11:47
+     * @param {IParams} event
+     * @param {IUploadFile[]} files
+     */
+    const onUploadProgress = (event, files) => {
+        files.forEach(file => {
+            file.percentage = round(event.progress * 100);
+        });
+        opts.progress(cloneDeep(files));
+    };
+    /**
+     * 上传请求方法，返回响应对象
+     *
+     * @author lxm
+     * @date 2022-11-18 13:11:57
+     * @param {File[]} files
+     * @returns {*}  {Promise<HttpResponse>}
+     */
+    const uploadRequest = async (files, onProgress) => {
+        // 自定义上传请求
+        if (opts.request && isFunction(opts.request)) {
+            return opts.request(files);
+        }
+        // 默认每次单个文件上传，可能存在接口一次上传多个文件,
+        const data = new FormData();
+        files.forEach(file => {
+            data.append('file', file);
+        });
+        const res = await ibiz.net.request(opts.uploadUrl, {
+            method: 'post',
+            baseURL: '',
+            data,
+            headers: { 'Content-Type': 'multipart/form-data' },
+            onUploadProgress: onProgress,
+        });
+        return res;
+    };
+    /**
+     * 执行一次上传，可能是一个文件也可能是多个文件
+     *
+     * @author lxm
+     * @date 2022-11-18 14:11:54
+     * @param {File[]} files 此次上传文件的集合
+     * @returns {*}  {Promise<IUploadFile[]>}
+     */
+    const executeSingleUpload = async (files) => {
+        const resultFiles = files.map(file => {
+            return {
+                status: 'uploading',
+                name: file.name,
+                uid: uniqueId(),
+                percentage: 0,
+            };
+        });
+        // 上传前回调，可以取消此次下载
+        const pass = opts.beforeUpload(files, resultFiles);
+        if (!pass) {
+            resultFiles.forEach(file => {
+                file.status = 'cancel';
+            });
+            ibiz.log.debug('取消上传', resultFiles);
+            return resultFiles;
+        }
+        try {
+            const res = await uploadRequest(files, event => {
+                onUploadProgress(event, resultFiles);
+            });
+            resultFiles.forEach(file => {
+                file.status = 'finished';
+            });
+            // 上传成功事件
+            opts.success(resultFiles, res);
+            resultFiles.forEach(file => {
+                file.response = res;
+            });
+        }
+        catch (error) {
+            resultFiles.forEach(file => {
+                file.status = 'fail';
+            });
+            // 上传失败事件
+            opts.error(resultFiles, error);
+            resultFiles.forEach(file => {
+                file.error = error;
+            });
+            ibiz.log.error(error);
+            ibiz.log.error(`${files.map(file => file.name).join(',')}上传失败`);
+        }
+        return resultFiles;
+    };
+    /**
+     * 执行上传文件逻辑
+     *
+     * @author lxm
+     * @date 2022-11-18 13:11:21
+     * @param {files} File[] 文件集合
+     */
+    const uploadFiles = async (files) => {
+        const uploadSequence = opts.separate ? files.map(file => [file]) : [files];
+        const res = await Promise.allSettled(uploadSequence.map(async (sequence) => {
+            return executeSingleUpload(sequence);
+        }));
+        // 整合所有的返回文件
+        const resultFiles = [];
+        res.forEach(result => {
+            if (result.status === 'fulfilled') {
+                resultFiles.push(...result.value);
+            }
+        });
+        opts.finish(resultFiles);
+    };
+    const select = () => {
+        selectFile({
+            accept: opts.accept,
+            multiple: opts.multiple,
+            onSelected: files => {
+                uploadFiles(files);
+            },
+        });
+    };
+    select();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibiz-template/core",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.17",
   "description": "核心包",
   "type": "module",
   "main": "out/index.js",
@@ -30,7 +30,7 @@
   "author": "chitanda",
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.1.3",
+    "axios": "^1.2.1",
     "loglevel": "^1.8.0",
     "pluralize": "^8.0.0",
     "qs": "^6.11.0"
@@ -45,5 +45,5 @@
     "lodash-es": "^4.17.21",
     "qx-util": "^0.4.4"
   },
-  "gitHead": "9514cbc720208af6160c67bc43e822262274da1f"
+  "gitHead": "ec02483ab23e246c852c28e4973fd7b086416657"
 }

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';