@fatcherjs/middleware-aborter 1.0.0 → 1.4.0

package/README.md

@@ -13,7 +13,7 @@ A middleware for aborting fatcher request.
 ### CDN
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/aborter.min.js"></script>
 ```
 
 ## Usage
@@ -69,4 +69,4 @@ A callback when aborting this request.
 
 ## License
 
-[MIT](../../LICENSE)
+[MIT](https://github.com/fatcherjs/fatcher/blob/master/LICENSE)

package/dist/aborter.d.ts

@@ -0,0 +1,52 @@
+import { Context, Middleware } from 'fatcher';
+
+declare type AbortReason = 'concurrency' | 'timeout' | 'manual';
+declare type AbortEventHandler = (type: AbortReason) => void;
+declare type RoadSign = {
+    abort: (type: AbortReason) => void;
+    timer: NodeJS.Timeout | null;
+    signal: AbortSignal;
+};
+declare type RoadMap = Record<string, RoadSign[]>;
+interface AborterOptions {
+    /**
+     * Request timeout
+     *
+     * `ms`
+     *
+     * @default 0
+     */
+    timeout?: number;
+    /**
+     * Callback with aborted request.
+     *
+     * @default null
+     */
+    onAbort?: AbortEventHandler | null;
+    /**
+     * Request concurrency restrictions
+     *
+     * @default false
+     */
+    concurrency?: boolean;
+    /**
+     * Concurrency key.
+     */
+    groupBy?: (context: Readonly<Context>) => string;
+}
+
+/**
+ * A middleware for aborting fatcher request.
+ * @param options
+ * @returns
+ */
+declare function aborter(options?: AborterOptions): Middleware;
+
+/**
+ * Confirm an error whether is DOMException
+ * @param error
+ * @returns
+ */
+declare function isAbortError(error: unknown): error is DOMException;
+
+export { AbortEventHandler, AbortReason, AborterOptions, RoadMap, RoadSign, aborter, isAbortError };

package/dist/aborter.esm.js

@@ -0,0 +1,54 @@
+const roadMap = {};
+function aborter(options = {}) {
+  const { timeout = 0, onAbort = null, concurrency, groupBy } = options;
+  let _timeout = timeout;
+  if (isNaN(timeout) || ~~timeout < 0) {
+    console.warn("[fatcher-middleware-aborter] Timeout is not a valid number.");
+    _timeout = 0;
+  }
+  return {
+    name: "fatcher-middleware-aborter",
+    async use(context, next) {
+      var _a, _b, _c;
+      const abortController = new AbortController();
+      const { abort, signal } = abortController;
+      const requestTask = next({ signal });
+      const group = (_a = groupBy == null ? void 0 : groupBy(context)) != null ? _a : `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}`;
+      if (((_b = roadMap[group]) == null ? void 0 : _b.length) && concurrency) {
+        roadMap[group].forEach((item) => {
+          item.abort("concurrency");
+        });
+      }
+      (_c = roadMap[group]) != null ? _c : roadMap[group] = [];
+      roadMap[group].push({
+        abort: (reason) => {
+          abort.call(abortController);
+          onAbort == null ? void 0 : onAbort(reason);
+        },
+        timer: _timeout ? setTimeout(() => abort("timeout"), _timeout) : null,
+        signal
+      });
+      signal.addEventListener("abort", () => {
+        roadMap[group] = roadMap[group].filter((item) => {
+          if (item.signal === signal) {
+            if (item.timer) {
+              clearTimeout(item.timer);
+            }
+            return false;
+          }
+          return true;
+        });
+        if (!roadMap[group].length) {
+          delete roadMap[group];
+        }
+      });
+      return requestTask;
+    }
+  };
+}
+
+function isAbortError(error) {
+  return error instanceof DOMException && error.name === "AbortError";
+}
+
+export { aborter, isAbortError };

package/dist/aborter.js

@@ -0,0 +1,59 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const roadMap = {};
+function aborter(options = {}) {
+  const { timeout = 0, onAbort = null, concurrency, groupBy } = options;
+  let _timeout = timeout;
+  if (isNaN(timeout) || ~~timeout < 0) {
+    console.warn("[fatcher-middleware-aborter] Timeout is not a valid number.");
+    _timeout = 0;
+  }
+  return {
+    name: "fatcher-middleware-aborter",
+    async use(context, next) {
+      var _a, _b, _c;
+      const abortController = new AbortController();
+      const { abort, signal } = abortController;
+      const requestTask = next({ signal });
+      const group = (_a = groupBy == null ? void 0 : groupBy(context)) != null ? _a : `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}`;
+      if (((_b = roadMap[group]) == null ? void 0 : _b.length) && concurrency) {
+        roadMap[group].forEach((item) => {
+          item.abort("concurrency");
+        });
+      }
+      (_c = roadMap[group]) != null ? _c : roadMap[group] = [];
+      roadMap[group].push({
+        abort: (reason) => {
+          abort.call(abortController);
+          onAbort == null ? void 0 : onAbort(reason);
+        },
+        timer: _timeout ? setTimeout(() => abort("timeout"), _timeout) : null,
+        signal
+      });
+      signal.addEventListener("abort", () => {
+        roadMap[group] = roadMap[group].filter((item) => {
+          if (item.signal === signal) {
+            if (item.timer) {
+              clearTimeout(item.timer);
+            }
+            return false;
+          }
+          return true;
+        });
+        if (!roadMap[group].length) {
+          delete roadMap[group];
+        }
+      });
+      return requestTask;
+    }
+  };
+}
+
+function isAbortError(error) {
+  return error instanceof DOMException && error.name === "AbortError";
+}
+
+exports.aborter = aborter;
+exports.isAbortError = isAbortError;

package/dist/aborter.min.js

@@ -0,0 +1 @@
+(function(t,e){typeof exports=="object"&&typeof module<"u"?e(exports):typeof define=="function"&&define.amd?define(["exports"],e):(t=typeof globalThis<"u"?globalThis:t||self,e(t.FatcherMiddlewareAborter={}))})(this,function(t){"use strict";const e={};function p(o={}){const{timeout:u=0,onAbort:s=null,concurrency:g,groupBy:c}=o;let l=u;return(isNaN(u)||~~u<0)&&(console.warn("[fatcher-middleware-aborter] Timeout is not a valid number."),l=0),{name:"fatcher-middleware-aborter",async use(i,v){var d,f,b;const m=new AbortController,{abort:h,signal:a}=m,y=v({signal:a}),r=(d=c?.(i))!=null?d:`${i.url}_${i.method}_${new URLSearchParams(i.params).toString()}`;return((f=e[r])==null?void 0:f.length)&&g&&e[r].forEach(n=>{n.abort("concurrency")}),(b=e[r])!=null||(e[r]=[]),e[r].push({abort:n=>{h.call(m),s?.(n)},timer:l?setTimeout(()=>h("timeout"),l):null,signal:a}),a.addEventListener("abort",()=>{e[r]=e[r].filter(n=>n.signal===a?(n.timer&&clearTimeout(n.timer),!1):!0),e[r].length||delete e[r]}),y}}}function _(o){return o instanceof DOMException&&o.name==="AbortError"}t.aborter=p,t.isAbortError=_,Object.defineProperty(t,"__esModule",{value:!0})});

package/package.json

@@ -1,21 +1,25 @@
 {
   "name": "@fatcherjs/middleware-aborter",
-  "version": "1.0.0",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "browser": "dist/index.min.js",
-  "typings": "dist/index.d.ts",
-  "repository": "https://github.com/fatcherjs/middlewares/tree/master/packages/aborter",
+  "version": "1.4.0",
+  "main": "dist/aborter.js",
+  "module": "dist/aborter.esm.js",
+  "browser": "dist/aborter.min.js",
+  "typings": "dist/aborter.d.ts",
   "license": "MIT",
   "files": [
     "dist"
   ],
+  "homepage": "https://github.com/fatcherjs/fatcher/tree/master/packages/aborter",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fatcherjs/fatcher.git"
+  },
   "peerDependencies": {
     "fatcher": "^1.0.0"
   },
   "scripts": {
     "dev": "rimraf dist && rollup -c rollup.config.ts -w",
-    "build": "rimraf dist && rollup -c rollup.config.ts"
-  },
-  "readme": "# @fatcherjs/middleware-aborter\n\nA middleware for aborting fatcher request.\n\n## Install\n\n### NPM\n\n```bash\n>$ npm install @fatcherjs/middleware-aborter\n```\n\n### CDN\n\n```html\n<script src=\"https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/index.min.js\"></script>\n```\n\n## Usage\n\n```ts\nimport { aborter } from '@fatcherjs/middleware-aborter';\nimport { fatcher, isAbortError } from 'fatcher';\n\nfatcher({\n    url: '/bar/foo',\n    middlewares: [\n        aborter({\n            timeout: 10 * 1000, // 10s\n            onAbort: () => {\n                console.log('Request is Aborted.');\n            },\n        }),\n    ],\n})\n    .then(res => {\n        // Request success in 10s\n        console.log(res);\n    })\n    .catch(err => {\n        if (isAbortError(err)) {\n            //Run error when request aborted.\n            console.error(err);\n        }\n\n        // Other errors.\n    });\n```\n\n## Options\n\n### timeout\n\n-   Type: `number`\n-   DefaultValue: `0`\n-   Description:\n\nIf `timeout > 0`, will abort this request later.\n\nAborted request will throw a DOMException which can use `isAbortError` to confirm.\n\n### onAbort\n\n-   Type: `(() => void) | null`\n-   DefaultValue: `null`\n-   Description:\n\nA callback when aborting this request.\n\n## License\n\n[MIT](../../LICENSE)\n"
+    "build": "rimraf dist && rollup -c rollup.config.ts",
+    "deploy": "pnpm run build && pnpm publish --no-git-check"
+  }
 }

package/dist/index.d.ts

@@ -1,27 +0,0 @@
-import { Middleware } from 'fatcher';
-
-interface AborterOptions {
-    /**
-     * Request timeout
-     *
-     * `ms`
-     *
-     * @default 0
-     */
-    timeout?: number;
-    /**
-     * Callback with aborted request.
-     *
-     * @default null
-     */
-    onAbort?: (() => void) | null;
-}
-
-/**
- * A middleware for aborting fatcher request.
- * @param options
- * @returns
- */
-declare function aborter(options?: AborterOptions): Middleware;
-
-export { AborterOptions, aborter };

package/dist/index.esm.js

@@ -1,31 +0,0 @@
-import { warn } from 'fatcher';
-
-function aborter(options = {}) {
-  const { timeout = 0, onAbort = null } = options;
-  let _timeout = timeout;
-  if (isNaN(timeout) || ~~timeout <= 0) {
-    warn("<Aborter> Timeout is not a valid number.");
-    _timeout = 0;
-  }
-  return {
-    name: "fatcher-middleware-aborter",
-    async use(context, next) {
-      const abortController = new AbortController();
-      const requestTask = next({
-        signal: abortController.signal
-      });
-      if (!_timeout) {
-        return requestTask;
-      }
-      const timer = setTimeout(() => {
-        abortController.abort();
-        onAbort == null ? void 0 : onAbort();
-      }, _timeout);
-      const response = await requestTask;
-      clearTimeout(timer);
-      return response;
-    }
-  };
-}
-
-export { aborter };

package/dist/index.js

@@ -1,35 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var fatcher = require('fatcher');
-
-function aborter(options = {}) {
-  const { timeout = 0, onAbort = null } = options;
-  let _timeout = timeout;
-  if (isNaN(timeout) || ~~timeout <= 0) {
-    fatcher.warn("<Aborter> Timeout is not a valid number.");
-    _timeout = 0;
-  }
-  return {
-    name: "fatcher-middleware-aborter",
-    async use(context, next) {
-      const abortController = new AbortController();
-      const requestTask = next({
-        signal: abortController.signal
-      });
-      if (!_timeout) {
-        return requestTask;
-      }
-      const timer = setTimeout(() => {
-        abortController.abort();
-        onAbort == null ? void 0 : onAbort();
-      }, _timeout);
-      const response = await requestTask;
-      clearTimeout(timer);
-      return response;
-    }
-  };
-}
-
-exports.aborter = aborter;

package/dist/index.min.js

@@ -1 +0,0 @@
-(function(e,t){typeof exports=="object"&&typeof module<"u"?t(exports,require("fatcher")):typeof define=="function"&&define.amd?define(["exports","fatcher"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e.FatcherMiddlewareAborter={},e.Fatcher))})(this,function(e,t){"use strict";function u(a={}){const{timeout:r=0,onAbort:o=null}=a;let n=r;return(isNaN(r)||~~r<=0)&&(t.warn("<Aborter> Timeout is not a valid number."),n=0),{name:"fatcher-middleware-aborter",async use(l,c){const i=new AbortController,s=c({signal:i.signal});if(!n)return s;const f=setTimeout(()=>{i.abort(),o?.()},n),d=await s;return clearTimeout(f),d}}}e.aborter=u,Object.defineProperty(e,"__esModule",{value:!0})});