@qlover/fe-corekit 1.2.5 → 1.2.8

package/dist/interface/index.es.js

@@ -1,269 +1 @@
-/**
- * Base executor class providing plugin management and execution pipeline
- *
- * The Executor pattern implements a pluggable execution pipeline that allows:
- * 1. Pre-processing of input data
- * 2. Post-processing of results
- * 3. Error handling
- * 4. Custom execution logic
- *
- * execNoError returns all errors as they are., and if there is a plugin onerror handler chain in which an error occurs, it will also return the error instead of throwing it.
- *
- * @abstract
- * @class Executor
- * @category Executor
- * @example
- * ```typescript
- * // Create an executor instance
- * const executor = new AsyncExecutor();
- *
- * // Add plugins
- * executor.use(new LoggerPlugin());
- * executor.use(new RetryPlugin({ maxAttempts: 3 }));
- *
- * // Execute a task
- * const result = await executor.exec(async (data) => {
- *   return await someAsyncOperation(data);
- * });
- * ```
- */
-var Executor = /** @class */ (function () {
-    /**
-     * Creates a new Executor instance
-     *
-     * - Purpose: Initialize executor with optional configuration
-     * - Core Concept: Configurable executor setup
-     * - Main Features: Configuration injection
-     * - Primary Use: Executor instantiation
-     *
-     * @param {ExecutorConfig} config - Optional configuration object
-     *
-     * @example
-     * ```typescript
-     * const executor = new Executor({
-     *   // config options
-     * });
-     * ```
-     */
-    function Executor(config) {
-        this.config = config;
-        /**
-         * Array of active plugins
-         *
-         * - Purpose: Stores and manages executor plugins
-         * - Core Concept: Ordered plugin pipeline
-         * - Main Features:
-         *  - Maintains plugin execution order
-         *  - Supports plugin lifecycle management
-         * - Primary Use: Plugin orchestration and execution
-         *
-         * @example
-         * ```typescript
-         * protected plugins = [
-         *   new LoggerPlugin(),
-         *   new RetryPlugin()
-         * ];
-         * ```
-         */
-        this.plugins = [];
-    }
-    /**
-     * Add a plugin to the executor
-     *
-     * - Purpose: Extends executor functionality through plugins
-     * - Core Concept: Plugin registration and deduplication
-     * - Main Features:
-     *  - Prevents duplicate plugins if onlyOne is true
-     *  - Maintains plugin execution order
-     * - Primary Use: Adding new capabilities to executor
-     *
-     * @param plugin - Plugin instance to add
-     *
-     * @example
-     * ```typescript
-     * executor.use(new LoggerPlugin());
-     * executor.use(new RetryPlugin({ maxAttempts: 3 }));
-     * ```
-     *
-     * @example
-     *
-     * Use a plain object as a plugin
-     * ```typescript
-     * executor.use({
-     *   onBefore: (data) => ({ ...data, modified: true })
-     * });
-     * ```
-     */
-    Executor.prototype.use = function (plugin) {
-        if (this.plugins.find(function (p) {
-            return p === plugin ||
-                p.pluginName === plugin.pluginName ||
-                p.constructor === plugin.constructor;
-        }) &&
-            plugin.onlyOne) {
-            console.warn("Plugin ".concat(plugin.pluginName, " is already used, skip adding"));
-            return;
-        }
-        this.plugins.push(plugin);
-    };
-    return Executor;
-}());
-
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
-
-var extendStatics = function(d, b) {
-    extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-    return extendStatics(d, b);
-};
-
-function __extends(d, b) {
-    if (typeof b !== "function" && b !== null)
-        throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-    extendStatics(d, b);
-    function __() { this.constructor = d; }
-    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
-/**
- * Custom error class for executor operations.
- *
- * This class provides a structured way to handle errors that occur during executor operations.
- * It extends the standard Error class to include an error identification string, which can be used
- * to categorize and manage errors more effectively.
- *
- * @category Executor
- *
- * @example
- * ```typescript
- * try {
- *   // some executor operation
- * } catch (error) {
- *   throw new ExecutorError('EXECUTOR_ERROR', error);
- * }
- * ```
- *
- * @example
- *
- * create an error with a message from a string
- *
- * ```typescript
- * const error = new ExecutorError('ERROR_ID', 'This is an error message');
- *
- * // => error.message is 'This is an error message'
- * // => error.id is 'ERROR_ID'
- * ```
- */
-var ExecutorError = /** @class */ (function (_super) {
-    __extends(ExecutorError, _super);
-    /**
-     * Constructs a new ExecutorError.
-     *
-     * if originalError is a string, it will be used as the error message.
-     * if originalError is an Error object, its message will be used as the error message.
-     * if originalError is not provided, the error message will be the id.
-     *
-     * @param id - A unique identifier for the error, used for categorization and tracking.
-     * @param originalError - The original error message or Error object that triggered this error.
-     *                        This parameter is optional.
-     */
-    function ExecutorError(id, originalError) {
-        var _newTarget = this.constructor;
-        var _this = _super.call(this, originalError instanceof Error
-            ? originalError.message
-            : originalError || id) || this;
-        _this.id = id;
-        // if originalError is an Error object, use its stack
-        if (originalError instanceof Error && 'stack' in originalError) {
-            _this.stack = originalError.stack;
-        }
-        Object.setPrototypeOf(_this, _newTarget.prototype);
-        return _this;
-    }
-    return ExecutorError;
-}(Error));
-
-/**
- * Represents a custom error class for handling request-related errors in the application
- *
- * RequestError extends the base ExecutorError class to provide specific error handling
- * for HTTP requests and fetch operations. It works in conjunction with RequestErrorID
- * to categorize different types of request failures.
- *
- * @since 1.0.14
- *
- * @example
- * ```typescript
- * try {
- *   await fetchData(url);
- * } catch (error) {
- *   if (error instanceof RequestError) {
- *     // Handle request specific error
- *     console.error('Request failed:', error.message);
- *   }
- * }
- * ```
- */
-var RequestError = /** @class */ (function (_super) {
-    __extends(RequestError, _super);
-    function RequestError() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return RequestError;
-}(ExecutorError));
-/**
- * Error IDs for different fetch request failure scenarios
- * Used to identify specific error types in error handling
- *
- * @description
- * This enum provides a standardized set of error identifiers that can be used
- * to categorize and handle different types of request failures in a consistent manner.
- * Each error ID represents a specific failure scenario that might occur during HTTP requests.
- *
- * @example
- * ```typescript
- * if (error.id === RequestErrorID.RESPONSE_NOT_OK) {
- *   // Handle non-200 response
- * } else if (error.id === RequestErrorID.ABORT_ERROR) {
- *   // Handle aborted request
- * }
- * ```
- */
-var RequestErrorID;
-(function (RequestErrorID) {
-    /** Generic fetch request error */
-    RequestErrorID["REQUEST_ERROR"] = "REQUEST_ERROR";
-    /** Environment doesn't support fetch API */
-    RequestErrorID["ENV_FETCH_NOT_SUPPORT"] = "ENV_FETCH_NOT_SUPPORT";
-    /** No fetcher function provided */
-    RequestErrorID["FETCHER_NONE"] = "FETCHER_NONE";
-    /** Response status is not OK (not in 200-299 range) */
-    RequestErrorID["RESPONSE_NOT_OK"] = "RESPONSE_NOT_OK";
-    /** Request was aborted */
-    RequestErrorID["ABORT_ERROR"] = "ABORT_ERROR";
-    /** URL is not provided */
-    RequestErrorID["URL_NONE"] = "URL_NONE";
-})(RequestErrorID || (RequestErrorID = {}));
-
-export { Executor, ExecutorError, RequestError, RequestErrorID };
-//# sourceMappingURL=index.es.js.map
+var t=function(){function t(t){this.config=t,this.plugins=[]}return t.prototype.use=function(t){this.plugins.find((function(n){return n===t||n.pluginName===t.pluginName||n.constructor===t.constructor}))&&t.onlyOne?console.warn("Plugin ".concat(t.pluginName," is already used, skip adding")):this.plugins.push(t)},t}(),n=function(t,r){return n=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,n){t.__proto__=n}||function(t,n){for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(t[r]=n[r])},n(t,r)};function r(t,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function o(){this.constructor=t}n(t,r),t.prototype=null===r?Object.create(r):(o.prototype=r.prototype,new o)}"function"==typeof SuppressedError&&SuppressedError;var o,e=function(t){function n(n,r){var o=this.constructor,e=t.call(this,r instanceof Error?r.message:r||n)||this;return e.id=n,r instanceof Error&&"stack"in r&&(e.stack=r.stack),Object.setPrototypeOf(e,o.prototype),e}return r(n,t),n}(Error),i=function(t){function n(){return null!==t&&t.apply(this,arguments)||this}return r(n,t),n}(e);!function(t){t.REQUEST_ERROR="REQUEST_ERROR",t.ENV_FETCH_NOT_SUPPORT="ENV_FETCH_NOT_SUPPORT",t.FETCHER_NONE="FETCHER_NONE",t.RESPONSE_NOT_OK="RESPONSE_NOT_OK",t.ABORT_ERROR="ABORT_ERROR",t.URL_NONE="URL_NONE"}(o||(o={}));export{t as Executor,e as ExecutorError,i as RequestError,o as RequestErrorID};

package/dist/interface/index.umd.js

@@ -1,279 +1 @@
-(function (global, factory) {
-  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
-  typeof define === 'function' && define.amd ? define(['exports'], factory) :
-  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.FeUtilsInterface = {}));
-})(this, (function (exports) { 'use strict';
-
-  /**
-   * Base executor class providing plugin management and execution pipeline
-   *
-   * The Executor pattern implements a pluggable execution pipeline that allows:
-   * 1. Pre-processing of input data
-   * 2. Post-processing of results
-   * 3. Error handling
-   * 4. Custom execution logic
-   *
-   * execNoError returns all errors as they are., and if there is a plugin onerror handler chain in which an error occurs, it will also return the error instead of throwing it.
-   *
-   * @abstract
-   * @class Executor
-   * @category Executor
-   * @example
-   * ```typescript
-   * // Create an executor instance
-   * const executor = new AsyncExecutor();
-   *
-   * // Add plugins
-   * executor.use(new LoggerPlugin());
-   * executor.use(new RetryPlugin({ maxAttempts: 3 }));
-   *
-   * // Execute a task
-   * const result = await executor.exec(async (data) => {
-   *   return await someAsyncOperation(data);
-   * });
-   * ```
-   */
-  var Executor = /** @class */ (function () {
-      /**
-       * Creates a new Executor instance
-       *
-       * - Purpose: Initialize executor with optional configuration
-       * - Core Concept: Configurable executor setup
-       * - Main Features: Configuration injection
-       * - Primary Use: Executor instantiation
-       *
-       * @param {ExecutorConfig} config - Optional configuration object
-       *
-       * @example
-       * ```typescript
-       * const executor = new Executor({
-       *   // config options
-       * });
-       * ```
-       */
-      function Executor(config) {
-          this.config = config;
-          /**
-           * Array of active plugins
-           *
-           * - Purpose: Stores and manages executor plugins
-           * - Core Concept: Ordered plugin pipeline
-           * - Main Features:
-           *  - Maintains plugin execution order
-           *  - Supports plugin lifecycle management
-           * - Primary Use: Plugin orchestration and execution
-           *
-           * @example
-           * ```typescript
-           * protected plugins = [
-           *   new LoggerPlugin(),
-           *   new RetryPlugin()
-           * ];
-           * ```
-           */
-          this.plugins = [];
-      }
-      /**
-       * Add a plugin to the executor
-       *
-       * - Purpose: Extends executor functionality through plugins
-       * - Core Concept: Plugin registration and deduplication
-       * - Main Features:
-       *  - Prevents duplicate plugins if onlyOne is true
-       *  - Maintains plugin execution order
-       * - Primary Use: Adding new capabilities to executor
-       *
-       * @param plugin - Plugin instance to add
-       *
-       * @example
-       * ```typescript
-       * executor.use(new LoggerPlugin());
-       * executor.use(new RetryPlugin({ maxAttempts: 3 }));
-       * ```
-       *
-       * @example
-       *
-       * Use a plain object as a plugin
-       * ```typescript
-       * executor.use({
-       *   onBefore: (data) => ({ ...data, modified: true })
-       * });
-       * ```
-       */
-      Executor.prototype.use = function (plugin) {
-          if (this.plugins.find(function (p) {
-              return p === plugin ||
-                  p.pluginName === plugin.pluginName ||
-                  p.constructor === plugin.constructor;
-          }) &&
-              plugin.onlyOne) {
-              console.warn("Plugin ".concat(plugin.pluginName, " is already used, skip adding"));
-              return;
-          }
-          this.plugins.push(plugin);
-      };
-      return Executor;
-  }());
-
-  /******************************************************************************
-  Copyright (c) Microsoft Corporation.
-
-  Permission to use, copy, modify, and/or distribute this software for any
-  purpose with or without fee is hereby granted.
-
-  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-  PERFORMANCE OF THIS SOFTWARE.
-  ***************************************************************************** */
-  /* global Reflect, Promise, SuppressedError, Symbol, Iterator */
-
-  var extendStatics = function(d, b) {
-      extendStatics = Object.setPrototypeOf ||
-          ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-          function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-      return extendStatics(d, b);
-  };
-
-  function __extends(d, b) {
-      if (typeof b !== "function" && b !== null)
-          throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-      extendStatics(d, b);
-      function __() { this.constructor = d; }
-      d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-  }
-
-  typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-      var e = new Error(message);
-      return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-  };
-
-  /**
-   * Custom error class for executor operations.
-   *
-   * This class provides a structured way to handle errors that occur during executor operations.
-   * It extends the standard Error class to include an error identification string, which can be used
-   * to categorize and manage errors more effectively.
-   *
-   * @category Executor
-   *
-   * @example
-   * ```typescript
-   * try {
-   *   // some executor operation
-   * } catch (error) {
-   *   throw new ExecutorError('EXECUTOR_ERROR', error);
-   * }
-   * ```
-   *
-   * @example
-   *
-   * create an error with a message from a string
-   *
-   * ```typescript
-   * const error = new ExecutorError('ERROR_ID', 'This is an error message');
-   *
-   * // => error.message is 'This is an error message'
-   * // => error.id is 'ERROR_ID'
-   * ```
-   */
-  var ExecutorError = /** @class */ (function (_super) {
-      __extends(ExecutorError, _super);
-      /**
-       * Constructs a new ExecutorError.
-       *
-       * if originalError is a string, it will be used as the error message.
-       * if originalError is an Error object, its message will be used as the error message.
-       * if originalError is not provided, the error message will be the id.
-       *
-       * @param id - A unique identifier for the error, used for categorization and tracking.
-       * @param originalError - The original error message or Error object that triggered this error.
-       *                        This parameter is optional.
-       */
-      function ExecutorError(id, originalError) {
-          var _newTarget = this.constructor;
-          var _this = _super.call(this, originalError instanceof Error
-              ? originalError.message
-              : originalError || id) || this;
-          _this.id = id;
-          // if originalError is an Error object, use its stack
-          if (originalError instanceof Error && 'stack' in originalError) {
-              _this.stack = originalError.stack;
-          }
-          Object.setPrototypeOf(_this, _newTarget.prototype);
-          return _this;
-      }
-      return ExecutorError;
-  }(Error));
-
-  /**
-   * Represents a custom error class for handling request-related errors in the application
-   *
-   * RequestError extends the base ExecutorError class to provide specific error handling
-   * for HTTP requests and fetch operations. It works in conjunction with RequestErrorID
-   * to categorize different types of request failures.
-   *
-   * @since 1.0.14
-   *
-   * @example
-   * ```typescript
-   * try {
-   *   await fetchData(url);
-   * } catch (error) {
-   *   if (error instanceof RequestError) {
-   *     // Handle request specific error
-   *     console.error('Request failed:', error.message);
-   *   }
-   * }
-   * ```
-   */
-  var RequestError = /** @class */ (function (_super) {
-      __extends(RequestError, _super);
-      function RequestError() {
-          return _super !== null && _super.apply(this, arguments) || this;
-      }
-      return RequestError;
-  }(ExecutorError));
-  /**
-   * Error IDs for different fetch request failure scenarios
-   * Used to identify specific error types in error handling
-   *
-   * @description
-   * This enum provides a standardized set of error identifiers that can be used
-   * to categorize and handle different types of request failures in a consistent manner.
-   * Each error ID represents a specific failure scenario that might occur during HTTP requests.
-   *
-   * @example
-   * ```typescript
-   * if (error.id === RequestErrorID.RESPONSE_NOT_OK) {
-   *   // Handle non-200 response
-   * } else if (error.id === RequestErrorID.ABORT_ERROR) {
-   *   // Handle aborted request
-   * }
-   * ```
-   */
-  exports.RequestErrorID = void 0;
-  (function (RequestErrorID) {
-      /** Generic fetch request error */
-      RequestErrorID["REQUEST_ERROR"] = "REQUEST_ERROR";
-      /** Environment doesn't support fetch API */
-      RequestErrorID["ENV_FETCH_NOT_SUPPORT"] = "ENV_FETCH_NOT_SUPPORT";
-      /** No fetcher function provided */
-      RequestErrorID["FETCHER_NONE"] = "FETCHER_NONE";
-      /** Response status is not OK (not in 200-299 range) */
-      RequestErrorID["RESPONSE_NOT_OK"] = "RESPONSE_NOT_OK";
-      /** Request was aborted */
-      RequestErrorID["ABORT_ERROR"] = "ABORT_ERROR";
-      /** URL is not provided */
-      RequestErrorID["URL_NONE"] = "URL_NONE";
-  })(exports.RequestErrorID || (exports.RequestErrorID = {}));
-
-  exports.Executor = Executor;
-  exports.ExecutorError = ExecutorError;
-  exports.RequestError = RequestError;
-
-}));
-//# sourceMappingURL=index.umd.js.map
+!function(t,r){"object"==typeof exports&&"undefined"!=typeof module?r(exports):"function"==typeof define&&define.amd?define(["exports"],r):r((t="undefined"!=typeof globalThis?globalThis:t||self).FeUtilsInterface={})}(this,(function(t){"use strict";var r=function(){function t(t){this.config=t,this.plugins=[]}return t.prototype.use=function(t){this.plugins.find((function(r){return r===t||r.pluginName===t.pluginName||r.constructor===t.constructor}))&&t.onlyOne?console.warn("Plugin ".concat(t.pluginName," is already used, skip adding")):this.plugins.push(t)},t}(),n=function(t,r){return n=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,r){t.__proto__=r}||function(t,r){for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(t[n]=r[n])},n(t,r)};function o(t,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function o(){this.constructor=t}n(t,r),t.prototype=null===r?Object.create(r):(o.prototype=r.prototype,new o)}"function"==typeof SuppressedError&&SuppressedError;var e,i=function(t){function r(r,n){var o=this.constructor,e=t.call(this,n instanceof Error?n.message:n||r)||this;return e.id=r,n instanceof Error&&"stack"in n&&(e.stack=n.stack),Object.setPrototypeOf(e,o.prototype),e}return o(r,t),r}(Error),s=function(t){function r(){return null!==t&&t.apply(this,arguments)||this}return o(r,t),r}(i);t.RequestErrorID=void 0,(e=t.RequestErrorID||(t.RequestErrorID={})).REQUEST_ERROR="REQUEST_ERROR",e.ENV_FETCH_NOT_SUPPORT="ENV_FETCH_NOT_SUPPORT",e.FETCHER_NONE="FETCHER_NONE",e.RESPONSE_NOT_OK="RESPONSE_NOT_OK",e.ABORT_ERROR="ABORT_ERROR",e.URL_NONE="URL_NONE",t.Executor=r,t.ExecutorError=i,t.RequestError=s}));