@enegalan/request-manager 1.1.0 → 1.1.2

package/main.js

@@ -163,7 +163,13 @@ class RequestManager {
      * });
      */
     axios(url, options = {}, axiosInstance = null) {
-        const axiosLib = axiosInstance || axios;
+        const axiosLib = axiosInstance || (typeof axios !== 'undefined' ? axios : null);
+        if (!axiosLib) {
+            throw new Error(
+                'axios was not found: pass an axios instance as the third argument of requestManager.axios() or make sure axios is available globally'
+            );
+        }
+        this.#_checkAxiosVersion(axiosLib);
         return this.#_request(
             this.getRequestId(url, options),
             ({ options: requestOptions }) => axiosLib({ url, ...requestOptions }),
@@ -224,7 +230,6 @@ class RequestManager {
      * });
      */
     xhr(url, options = {}) {
-        const requestId = this.getRequestId(url, options);
         /** @type {import('./index.d.ts').RequestFunction<import('./index.d.ts').XhrResponse>} */
         const xhrFunction = ({ options: fetchOptions }) => {
             // Create XMLHttpRequest
@@ -233,6 +238,7 @@ class RequestManager {
             // Create a promise that wraps the XHR request
             const xhrPromise = new Promise((resolve, reject) => {
                 xhr.onload = function () {
+                    detachAbortListener();
                     if (xhr.status >= 200 && xhr.status < 300) {
                         let response = xhr.response;
                         if (
@@ -262,12 +268,14 @@ class RequestManager {
                     }
                 };
                 xhr.onerror = function () {
+                    detachAbortListener();
                     reject({
                         message: 'Network error',
                         xhr: xhr,
                     });
                 };
                 xhr.ontimeout = function () {
+                    detachAbortListener();
                     reject({
                         message: 'Request timeout',
                         xhr: xhr,
@@ -290,14 +298,26 @@ class RequestManager {
                     });
 
                 // Connect abort signal to xhr.abort()
-                if (fetchOptions.signal) fetchOptions.signal.addEventListener('abort', () => xhr.abort());
+                const abortListener = () => xhr.abort();
+                if (fetchOptions.signal) fetchOptions.signal.addEventListener('abort', abortListener);
+                // Detach the listener once the request settles so completed requests do not keep it alive
+                const detachAbortListener = () => {
+                    if (fetchOptions.signal) fetchOptions.signal.removeEventListener('abort', abortListener);
+                };
+
+                xhr.onabort = function () {
+                    reject({
+                        message: 'Request was cancelled',
+                        xhr: xhr,
+                    });
+                };
 
                 // Send the request
                 xhr.send(options.body || null);
             });
             return xhrPromise;
         };
-        return this.#_request(requestId, xhrFunction, options);
+        return this.#_request(this.getRequestId(url, options), xhrFunction, options);
     }
 
     /**
@@ -335,7 +355,11 @@ class RequestManager {
         if (cleanedUrl.includes('://')) cleanedUrl = cleanedUrl.split('://')[1];
         if (cleanedUrl.includes('#')) cleanedUrl = cleanedUrl.split('#')[0];
         if (!options.includeQuery && cleanedUrl.includes('?')) cleanedUrl = cleanedUrl.split('?')[0];
-        return `${prefix}${cleanedUrl}`;
+
+        const methodPrefix =
+            options.includeMethod === false ? '' : `${(options.method || options.type || 'GET').toUpperCase()}_`;
+
+        return `${prefix}${methodPrefix}${cleanedUrl}`;
     }
 
     /**
@@ -444,7 +468,15 @@ class RequestManager {
      */
     #_prepareRequestOptions(options, signal) {
         const requestOptions = {};
-        const customOptions = ['abortController', 'cancelToken', 'requestKey', 'noCancel', 'includeQuery'];
+        const customOptions = [
+            'abortController',
+            'cancelToken',
+            'requestKey',
+            'noCancel',
+            'includeQuery',
+            'includeMethod',
+            'verbose',
+        ];
         Object.keys(options).forEach((key) => {
             if (customOptions.includes(key)) return;
             requestOptions[key] = options[key];
@@ -453,6 +485,24 @@ class RequestManager {
         return requestOptions;
     }
 
+    /**
+     * Warns when the provided axios instance predates 0.22.0, the first version
+     * supporting AbortSignal cancellation. Older instances silently ignore
+     * options.signal, so duplicate requests would not be cancelled.
+     * @param {object} axiosLib - The axios instance about to be used
+     * @private
+     */
+    #_checkAxiosVersion(axiosLib) {
+        const version = typeof axiosLib?.VERSION === 'string' ? axiosLib.VERSION : null;
+        if (!version) return;
+        const [major, minor] = version.split('.').map(Number);
+        if (major === 0 && minor < 22) {
+            console.warn(
+                `[request-manager] axios >= 0.22.0 is required: axios ${version} ignores the AbortSignal used for automatic cancellation. Please upgrade axios.`
+            );
+        }
+    }
+
     /**
      * Deletes a request from the active requests map and rejects the wrapper promise
      * @param {string} requestId - The unique identifier of the request

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "@enegalan/request-manager",
-    "version": "1.1.0",
+    "version": "1.1.2",
     "description": "JavaScript library for managing and regulating HTTP requests efficiently",
     "publishConfig": {
         "access": "public"
     },
-    "main": "dist/request-manager.cjs.js",
+    "main": "dist/request-manager.cjs",
     "module": "dist/request-manager.esm.js",
     "browser": "dist/request-manager.min.js",
     "unpkg": "dist/request-manager.min.js",
@@ -23,7 +23,7 @@
         ".": {
             "types": "./index.d.ts",
             "import": "./dist/request-manager.esm.js",
-            "require": "./dist/request-manager.cjs.js",
+            "require": "./dist/request-manager.cjs",
             "browser": "./dist/request-manager.min.js",
             "default": "./dist/request-manager.esm.js"
         },
@@ -41,7 +41,9 @@
         "test:coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage"
     },
     "devDependencies": {
+        "@babel/preset-env": "^7.29.7",
         "@eslint/js": "^10.0.1",
+        "@rollup/plugin-babel": "^6.1.0",
         "@rollup/plugin-terser": "^0.4.4",
         "eslint": "^10.8.1",
         "eslint-config-prettier": "^10.1.8",