@fatcherjs/middleware-aborter 3.0.0-alpha-11 → 3.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Fansy
+Copyright (c) 2022 fatcherjs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,8 +1,48 @@
 # @fatcherjs/middleware-aborter
 
-<a href="https://npmjs.com/package/@fatcherjs/middleware-aborter"><img src="https://img.shields.io/npm/v/@fatcherjs/middleware-aborter.svg" alt="npm package"></a>
-[![install size](https://packagephobia.com/badge?p=@fatcherjs/middleware-aborter)](https://packagephobia.com/result?p=@fatcherjs/middleware-aborter)
-<a href="https://unpkg.com/@fatcherjs/middleware-aborter"><img alt="Size" src="https://img.badgesize.io/https://unpkg.com/@fatcherjs/middleware-aborter"></a>
+<div align="center">
+  <a href="https://codecov.io/github/fatcherjs/middleware-aborter" > 
+    <img src="https://codecov.io/github/fatcherjs/middleware-aborter/graph/badge.svg?token=BEJA311FY2"/> 
+ </a>
+  <a href="https://www.jsdelivr.com/package/npm/@fatcherjs/middleware-aborter">
+    <img src="https://data.jsdelivr.com/v1/package/npm/@fatcherjs/middleware-aborter/badge?style=rounded" alt="jsDelivr">
+  </a>
+  <a href="https://packagephobia.com/result?p=@fatcherjs/middleware-aborter">
+    <img src="https://packagephobia.com/badge?p=@fatcherjs/middleware-aborter" alt="install size">
+  </a>
+  <a href="https://unpkg.com/@fatcherjs/middleware-aborter">
+    <img src="https://img.badgesize.io/https://unpkg.com/@fatcherjs/middleware-aborter" alt="Size">
+  </a>
+  <a href="https://npmjs.com/package/@fatcherjs/middleware-aborter">
+    <img src="https://img.shields.io/npm/v/@fatcherjs/middleware-aborter.svg" alt="npm package">
+  </a>
+  <a href="https://github.com/fatcherjs/middleware-aborter/actions/workflows/ci.yml">
+    <img src="https://github.com/fatcherjs/middleware-aborter/actions/workflows/ci.yml/badge.svg?branch=master" alt="build status">
+  </a>
+</div>
+
+## Tips
+
+If you want to abort request manually, you should use `AbortController` and pass the signal to `fatcher`
+
+```ts
+import { fatcher } from 'fatcher';
+
+const abortController = new AbortController();
+
+fatcher('your-url', {
+  signal: abortController.signal,
+}).catch(error => {
+  if (error instanceof DOMException && error.name === 'AbortError') {
+    // aborted.
+    return;
+  }
+
+  // other
+});
+
+abortController.abort();
+```
 
 ## Install
 
@@ -15,106 +55,77 @@
 ### CDN
 
 ```html
+<script src="https://cdn.jsdelivr.net/npm/fatcher/dist/fatcher.min.js"></script>
 <script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/index.min.js"></script>
+
+<script>
+  Fatcher.fatcher('xxx', {
+    middlewares: [FatcherMiddlewareAborter.timeout],
+    onTimeout: () => {},
+    timeout: 30000,
+  })
+    .then(response => {
+      console.log(response);
+    })
+    .catch(error => {
+      if (FatcherMiddlewareAborter.isTimeoutError(error)) {
+        // do somethings
+        return;
+      }
+
+      // do other thing
+    });
+</script>
 ```
 
-## Provider
+## Usage
 
-### FatcherRequest
+### Timeout
 
-#### abort
+#### Types
 
 ```ts
 declare module 'fatcher' {
-  interface FatcherRequest {
-    abort: (reason?: string) => void;
+  interface FatcherOptions {
+    timeout?: number; // default 60 * 1000 (60s)
+    onTimeout?: () => void;
   }
 }
 ```
 
-Middleware can get a `abort` function after call `aborter`;
-
-```ts
-fatcher('https://foo.bar', {
-  middlewares: [
-    aborter(),
-    (req, next) => {
-      console.log(typeof req.abort); // 'function'
-      return next();
-    },
-  ],
-});
-```
-
-## Usage
-
-### Basic
+#### Basic
 
 ```ts
 import { fatcher } from 'fatcher';
-import { aborter } from '@fatcherjs/middleware-aborter';
-
-fatcher('https://foo.bar', {
-  onAbort: () => console.log('aborted'),
-  middlewares: [aborter()],
+import { timeout } from '@fatcherjs/middleware-aborter';
+
+const response = await fatcher('xxx', {
+  middlewares: [timeout],
+  timeout: 30 * 1000,
+  onTimeout: () => {
+    console.log('timeout!');
+  },
 });
 ```
 
-### Timeout
-
-```ts
-import { fatcher } from 'fatcher';
-import { aborter, timeout } from '@fatcherjs/middleware-aborter';
-
-fatcher('https://foo.bar', {
-  onAbort: () => console.log('aborted'),
-  timeout: 1000 * 10, // 10s
-  middlewares: [aborter, timeout /* must call after aborter */],
-});
-```
-
-### User Cancelable
-
-```ts
-import { fatcher } from 'fatcher';
-import { aborter } from '@fatcherjs/middleware-aborter';
-
-const abortController = new AbortController();
-
-fatcher('https://foo.bar', {
-  onAbort: () => console.log('aborted'),
-  abortController,
-  middlewares: [aborter],
-}).catch(error => {
-  // abort error
-});
-
-abortController.abort();
-```
-
-### isAbortError
+### isTimeoutError
 
 ```ts
 import { fatcher } from 'fatcher';
-import { aborter, isAbortError } from '@fatcherjs/middleware-aborter';
-
-const abortController = new AbortController();
+import { isTimeoutError, timeout } from '@fatcherjs/middleware-aborter';
 
 fatcher('https://foo.bar', {
-  onAbort: () => console.log('aborted'),
-  abortController,
-  middlewares: [aborter],
+  timeout: 30 * 1000,
+  middlewares: [timeout],
 }).catch(error => {
-  if (isAbortError(error)) {
+  if (isTimeoutError(error)) {
     // do something..
     return;
   }
   // other error
 });
-
-abortController.abort();
 ```
 
 ## License
 
-[MIT](https://github.com/fanhaoyuan/fatcher/blob/master/LICENSE)
+[MIT](https://github.com/fatcherjs/middleware-aborter/blob/master/LICENSE)

package/dist/abortSignalAny.d.ts

@@ -0,0 +1 @@
+export declare function abortSignalAny(signals: AbortSignal[]): AbortSignal;

package/dist/abortSignalTimeout.d.ts

@@ -0,0 +1 @@
+export declare function abortSignalTimeout(timeout: number): AbortSignal;

package/dist/index.d.ts

@@ -1,25 +1,3 @@
-import { FatcherMiddleware } from 'fatcher';
-
-declare const aborter: FatcherMiddleware;
-
-/**
- * Confirm an error whether is DOMException
- * @param error
- * @returns
- */
-declare function isAbortError(error: unknown): error is DOMException;
-
-declare const timeout: FatcherMiddleware;
-
-declare module 'fatcher' {
-    interface FatcherOptions {
-        onAbort?: (reason?: string) => void;
-        abortController?: AbortController;
-        timeout?: number;
-    }
-    interface FatcherContext {
-        abort: (reason?: string) => void;
-    }
-}
-
-export { aborter, isAbortError, timeout };
+export * from './isTimeoutError';
+export * from './timeout';
+export * from './types';

package/dist/index.esm.js

@@ -1,52 +1,47 @@
-import 'fatcher';
-
-const aborter = {
-  name: "fatcher-middleware-aborter",
-  use: async (request, next) => {
-    const { onAbort, abortController = new AbortController() } = request;
-    const handler = () => {
-      onAbort?.(abortController.signal.reason);
-      abortController.signal.removeEventListener("abort", handler);
-    };
-    if (onAbort) {
-      abortController.signal.addEventListener("abort", handler);
-    }
-    const response = await next({
-      abort: abortController.abort.bind(abortController),
-      signal: abortController.signal
-    });
-    if (onAbort) {
-      abortController.signal.removeEventListener("abort", handler);
+function c(t) {
+  return t instanceof DOMException && t.name === "TimeoutError";
+}
+function u(t) {
+  if (typeof AbortSignal.any == "function")
+    return AbortSignal.any(t);
+  const o = new AbortController(), e = () => {
+    o.abort(), r();
+  }, r = () => {
+    for (const n of t)
+      n.removeEventListener("abort", e);
+  };
+  for (const n of t) {
+    if (n.aborted) {
+      e();
+      break;
     }
-    return response;
+    n.addEventListener("abort", e);
   }
-};
-
-function isAbortError(error) {
-  return error instanceof DOMException && error.name === "AbortError";
+  return o.signal;
+}
+function s(t) {
+  if (typeof AbortSignal.timeout == "function")
+    return AbortSignal.timeout(t);
+  const o = new AbortController(), e = setTimeout(() => {
+    o.abort(new DOMException("The operation timed out.", "TimeoutError"));
+  }, t);
+  return o.signal.addEventListener("abort", () => clearTimeout(e)), o.signal;
 }
-
-const timeout = {
+const l = {
   name: "fatcher-middleware-timeout",
-  use: async (context, next) => {
-    const { abort, timeout: _timeout } = context;
-    let timer = null;
-    if (_timeout) {
-      timer = setTimeout(() => {
-        abort();
-      }, _timeout);
-    }
-    let response;
-    try {
-      response = await next();
-    } catch (error) {
-      if (timer) {
-        clearTimeout(timer);
+  use: async (t, o) => {
+    const { timeout: e = 6e4, signal: r, onTimeout: n } = t, i = s(e), a = r ? u([i, r]) : i;
+    return a.addEventListener("abort", () => {
+      if (i.aborted) {
+        n?.();
+        return;
       }
-      throw error;
-    }
-    return response;
+    }), o({
+      request: new Request(t.request, { signal: a })
+    });
   }
 };
-
-export { aborter, isAbortError, timeout };
+export {
+  c as isTimeoutError,
+  l as timeout
+};

package/dist/index.js

@@ -1,58 +1 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-require('fatcher');
-
-const aborter = {
-  name: "fatcher-middleware-aborter",
-  use: async (request, next) => {
-    const { onAbort, abortController = new AbortController() } = request;
-    const handler = () => {
-      onAbort?.(abortController.signal.reason);
-      abortController.signal.removeEventListener("abort", handler);
-    };
-    if (onAbort) {
-      abortController.signal.addEventListener("abort", handler);
-    }
-    const response = await next({
-      abort: abortController.abort.bind(abortController),
-      signal: abortController.signal
-    });
-    if (onAbort) {
-      abortController.signal.removeEventListener("abort", handler);
-    }
-    return response;
-  }
-};
-
-function isAbortError(error) {
-  return error instanceof DOMException && error.name === "AbortError";
-}
-
-const timeout = {
-  name: "fatcher-middleware-timeout",
-  use: async (context, next) => {
-    const { abort, timeout: _timeout } = context;
-    let timer = null;
-    if (_timeout) {
-      timer = setTimeout(() => {
-        abort();
-      }, _timeout);
-    }
-    let response;
-    try {
-      response = await next();
-    } catch (error) {
-      if (timer) {
-        clearTimeout(timer);
-      }
-      throw error;
-    }
-    return response;
-  }
-};
-
-exports.aborter = aborter;
-exports.isAbortError = isAbortError;
-exports.timeout = timeout;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function u(t){return t instanceof DOMException&&t.name==="TimeoutError"}function s(t){if(typeof AbortSignal.any=="function")return AbortSignal.any(t);const o=new AbortController,e=()=>{o.abort(),r()},r=()=>{for(const n of t)n.removeEventListener("abort",e)};for(const n of t){if(n.aborted){e();break}n.addEventListener("abort",e)}return o.signal}function l(t){if(typeof AbortSignal.timeout=="function")return AbortSignal.timeout(t);const o=new AbortController,e=setTimeout(()=>{o.abort(new DOMException("The operation timed out.","TimeoutError"))},t);return o.signal.addEventListener("abort",()=>clearTimeout(e)),o.signal}const c={name:"fatcher-middleware-timeout",use:async(t,o)=>{const{timeout:e=6e4,signal:r,onTimeout:n}=t,i=l(e),a=r?s([i,r]):i;return a.addEventListener("abort",()=>{if(i.aborted){n?.();return}}),o({request:new Request(t.request,{signal:a})})}};exports.isTimeoutError=u;exports.timeout=c;

package/dist/index.min.js

@@ -1 +1 @@
-(function(t,i){typeof exports=="object"&&typeof module!="undefined"?i(exports):typeof define=="function"&&define.amd?define(["exports"],i):(t=typeof globalThis!="undefined"?globalThis:t||self,i(t.FatcherMiddlewareAborter={}))})(this,function(t){"use strict";const i={name:"fatcher-middleware-aborter",use:async(o,s)=>{const{onAbort:r,abortController:e=new AbortController}=o,n=()=>{r==null||r(e.signal.reason),e.signal.removeEventListener("abort",n)};r&&e.signal.addEventListener("abort",n);const a=await s({abort:e.abort.bind(e),signal:e.signal});return r&&e.signal.removeEventListener("abort",n),a}};function u(o){return o instanceof DOMException&&o.name==="AbortError"}const l={name:"fatcher-middleware-timeout",use:async(o,s)=>{const{abort:r,timeout:e}=o;let n=null;e&&(n=setTimeout(()=>{r()},e));let a;try{a=await s()}catch(c){throw n&&clearTimeout(n),c}return a}};t.aborter=i,t.isAbortError=u,t.timeout=l,Object.defineProperty(t,"__esModule",{value:!0})});
+(function(o,i){typeof exports=="object"&&typeof module<"u"?i(exports):typeof define=="function"&&define.amd?define(["exports"],i):(o=typeof globalThis<"u"?globalThis:o||self,i(o.FatcherMiddlewareAborter={}))})(this,(function(o){"use strict";function i(t){return t instanceof DOMException&&t.name==="TimeoutError"}function f(t){if(typeof AbortSignal.any=="function")return AbortSignal.any(t);const e=new AbortController,n=()=>{e.abort(),a()},a=()=>{for(const r of t)r.removeEventListener("abort",n)};for(const r of t){if(r.aborted){n();break}r.addEventListener("abort",n)}return e.signal}function l(t){if(typeof AbortSignal.timeout=="function")return AbortSignal.timeout(t);const e=new AbortController,n=setTimeout(()=>{e.abort(new DOMException("The operation timed out.","TimeoutError"))},t);return e.signal.addEventListener("abort",()=>clearTimeout(n)),e.signal}const c={name:"fatcher-middleware-timeout",use:async(t,e)=>{const{timeout:n=6e4,signal:a,onTimeout:r}=t,u=l(n),s=a?f([u,a]):u;return s.addEventListener("abort",()=>{if(u.aborted){r?.();return}}),e({request:new Request(t.request,{signal:s})})}};o.isTimeoutError=i,o.timeout=c,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})}));

package/dist/isTimeoutError.d.ts

@@ -0,0 +1 @@
+export declare function isTimeoutError(value: unknown): value is DOMException;

package/dist/timeout.d.ts

@@ -0,0 +1,2 @@
+import { FatcherMiddleware } from 'fatcher';
+export declare const timeout: FatcherMiddleware;

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+declare module 'fatcher' {
+    interface FatcherOptions {
+        timeout?: number;
+        onTimeout?: () => void;
+    }
+}
+export {};

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@fatcherjs/middleware-aborter",
-  "homepage": "https://github.com/fanhaoyuan/fatcher",
+  "version": "3.0.0",
+  "homepage": "https://github.com/fatcherjs/middleware-aborter",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/fanhaoyuan/fatcher.git"
+    "url": "git+https://github.com/fatcherjs/middleware-aborter.git"
   },
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -13,16 +14,32 @@
     "dist"
   ],
   "peerDependencies": {
-    "fatcher": "3.0.0-alpha-11"
+    "fatcher": "^3.0.0"
   },
   "devDependencies": {
-    "fatcher": "3.0.0-alpha-11"
+    "@fansy/eslint-config": "^1.4.2",
+    "@fansy/prettier-config": "^1.1.0",
+    "@types/node": "^24.3.1",
+    "@typescript-eslint/eslint-plugin": "^8.11.0",
+    "@typescript-eslint/parser": "^8.11.0",
+    "@vitest/coverage-v8": "3.2.4",
+    "eslint": "^8.57.1",
+    "eslint-plugin-prettier": "^5.2.1",
+    "fatcher": "^3.0.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.1.6",
+    "msw": "^2.11.1",
+    "prettier": "^3.3.3",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.5",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3.2.4"
   },
-  "version": "3.0.0-alpha-11",
   "scripts": {
-    "clean": "rimraf dist",
-    "build": "npm run clean && rollup -c rollup.config.ts",
-    "test": "jest",
-    "test:cov": "jest --coverage"
+    "build": "vite build",
+    "test": "vitest run",
+    "test:cov": "vitest run --coverage",
+    "eslint": "eslint ."
   }
 }