@fatcherjs/middleware-aborter 2.0.0 → 3.0.0-alpha-4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 fatcherjs
+Copyright (c) 2022 Fansy
 
 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,12 +1,4 @@
-# @fatcherjs/middleware-aborter
-
-A middleware for aborting fatcher request.
-
-[![codecov](https://codecov.io/gh/fatcherjs/middleware-aborter/branch/master/graph/badge.svg?token=TFKUGW6YNI)](https://codecov.io/gh/fatcherjs/middleware-aborter)
-[![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>
-<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>
+# @fatcher/middleware-aborter
 
 ## Install
 
@@ -19,49 +11,56 @@ A middleware for aborting fatcher request.
 ### CDN
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/aborter.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/index.min.js"></script>
 ```
 
 ## Usage
 
 ```ts
-import { aborter, isAbortError } from '@fatcherjs/middleware-aborter';
 import { fatcher } from 'fatcher';
+import { aborter } from '@fatcherjs/middleware-aborter';
 
-fatcher({
-    url: '/bar/foo',
-    middlewares: [
-        aborter({
-            timeout: 10 * 1000, // 10s
-            onAbort: () => {
-                console.log('Request is Aborted.');
-            },
-        }),
-    ],
-})
-    .then(res => {
-        // Request success in 10s
-        console.log(res);
-    })
-    .catch(err => {
-        if (isAbortError(err)) {
-            //Run error when request aborted.
-            console.error(err);
-        }
-
-        // Other errors.
-    });
+fatcher('https://foo.bar', {
+  middlewares: [
+    aborter({
+      /* Options*/
+    }),
+  ],
+});
 ```
 
 ## Options
 
-| Name        | Description                                     | Type                                     | DefaultValue                                                                         |
-| ----------- | ----------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------ |
-| timeout     | If `timeout > 0`, will abort this request later | `number`                                 | `0`                                                                                  |
-| onAbort     | A callback when aborting this request           | `(() => void) \| null`                   | `null`                                                                               |
-| concurrency | Request concurrency restrictions                | `boolean`                                | `false`                                                                              |
-| groupBy     | Concurrency key                                 | `(context: Readonly<Context>) => string` | `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}` |
+### onAbort
+
+```ts
+import { fatcher } from 'fatcher';
+import { aborter } from '@fatcherjs/middleware-aborter';
+
+fatcher('https://foo.bar', {
+  middlewares: [
+    aborter({
+      onAbort: () => console.log('aborted'),
+    }),
+  ],
+});
+```
+
+### timeout
+
+```ts
+import { fatcher } from 'fatcher';
+import { aborter } from '@fatcherjs/middleware-aborter';
+
+fatcher('https://foo.bar', {
+  middlewares: [
+    aborter({
+      timeout: 10 * 1000, // abort in 10 seconds
+    }),
+  ],
+});
+```
 
 ## License
 
-[MIT](https://github.com/fatcherjs/fatcher/blob/master/LICENSE)
+[MIT](https://github.com/fanhaoyuan/fatcher/blob/master/LICENSE)

package/package.json

@@ -1,49 +1,27 @@
 {
   "name": "@fatcherjs/middleware-aborter",
-  "version": "2.0.0",
-  "main": "dist/aborter.js",
-  "module": "dist/aborter.esm.js",
-  "browser": "dist/aborter.min.js",
-  "typings": "dist/aborter.d.ts",
-  "license": "MIT",
+  "homepage": "https://github.com/fanhaoyuan/fatcher",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fanhaoyuan/fatcher.git"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "browser": "dist/index.min.js",
+  "typings": "dist/index.d.ts",
   "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": "3.0.0-alpha-4"
   },
   "devDependencies": {
-    "@fansy/eslint-config": "^1.1.0",
-    "@fansy/prettier-config": "^1.0.0",
-    "@jest/types": "^29.1.2",
-    "@rollup/plugin-node-resolve": "^15.0.0",
-    "@types/jest": "^29.1.2",
-    "@types/node": "^18.8.5",
-    "esbuild": "^0.15.10",
-    "fatcher": "^2.0.0",
-    "jest": "^29.1.2",
-    "jest-fetch-mock": "^3.0.3",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.79.1",
-    "rollup-plugin-dts": "^4.2.3",
-    "rollup-plugin-esbuild": "^4.10.1",
-    "ts-jest": "^29.0.3",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.8.4"
-  },
-  "peerDependencies": {
-    "fatcher": "^2.0.0"
+    "fatcher": "3.0.0-alpha-4"
   },
+  "version": "3.0.0-alpha-4",
   "scripts": {
-    "dev": "rimraf dist && rollup -c rollup.config.ts -w",
-    "build": "rimraf dist && rollup -c rollup.config.ts",
-    "deploy": "pnpm run build && pnpm publish --no-git-check",
-    "test": "jest",
-    "test:cov": "jest --coverage",
-    "eslint": "eslint .",
-    "tsc": "tsc --noEmit",
-    "ci": "npm run eslint && npm run tsc && npm run build && npm run test"
+    "clean": "rimraf dist",
+    "build": "npm run clean && rollup -c rollup.config.ts",
+    "tsc": "tsc --noEmit"
   }
 }

package/dist/aborter.d.ts

@@ -1,59 +0,0 @@
-import * as fatcher from 'fatcher';
-import { Context } from 'fatcher';
-
-declare type RoadSign = {
-    abort: () => void;
-    signal: AbortSignal;
-};
-declare type RoadMap = Record<string, RoadSign[]>;
-interface AborterMiddlewareContext extends Readonly<Context> {
-    /**
-     * Provides with aborter
-     *
-     * @require `@fatcherjs/middleware-aborter`
-     */
-    abort: () => void;
-    signal: AbortSignal;
-}
-interface AborterOptions {
-    /**
-     * Request timeout
-     *
-     * `ms`
-     *
-     * @default 0
-     */
-    timeout?: number;
-    /**
-     * Callback with aborted request.
-     *
-     * @default null
-     */
-    onAbort?: (() => void) | 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): fatcher.Middleware[];
-
-/**
- * Confirm an error whether is DOMException
- * @param error
- * @returns
- */
-declare function isAbortError(error: unknown): error is DOMException;
-
-export { AborterMiddlewareContext, AborterOptions, RoadMap, RoadSign, aborter, isAbortError };

package/dist/aborter.esm.js

@@ -1,72 +0,0 @@
-import { defineMiddleware } from 'fatcher';
-
-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;
-  }
-  const baseAborter = defineMiddleware(async (context, next) => {
-    const abortController = new AbortController();
-    if (onAbort) {
-      abortController.signal.addEventListener("abort", () => onAbort());
-    }
-    return next({
-      signal: abortController.signal,
-      abort: abortController.abort.bind(abortController)
-    });
-  }, "fatcher-middleware-aborter");
-  const timeoutAborter = defineMiddleware(async (context, next) => {
-    const { signal, abort } = context;
-    let timer = setTimeout(abort, _timeout);
-    const release = () => {
-      if (timer) {
-        clearTimeout(timer);
-      }
-      timer = null;
-    };
-    signal.addEventListener("abort", release);
-    const result = await next();
-    release();
-    return result;
-  }, "fatcher-middleware-timeout-aborter");
-  const concurrencyAborter = defineMiddleware(async (context, next) => {
-    const { signal, abort } = context;
-    const group = groupBy ? groupBy(context) : `${context.url}_${context.method}_${new URLSearchParams(context.params)}`;
-    if (roadMap[group] && roadMap[group].length) {
-      roadMap[group].forEach((item) => item.abort());
-    }
-    if (!roadMap[group]) {
-      roadMap[group] = [];
-    }
-    roadMap[group].push({ abort, signal });
-    const release = () => {
-      roadMap[group] = roadMap[group].filter((item) => {
-        return item.signal !== signal;
-      });
-      if (!roadMap[group].length) {
-        delete roadMap[group];
-      }
-    };
-    signal.addEventListener("abort", release);
-    const result = await next();
-    release();
-    return result;
-  }, "fatcher-middleware-concurrency-aborter");
-  const middlewares = [baseAborter];
-  if (_timeout) {
-    middlewares.push(timeoutAborter);
-  }
-  if (concurrency) {
-    middlewares.push(concurrencyAborter);
-  }
-  return middlewares;
-}
-
-function isAbortError(error) {
-  return error instanceof DOMException && error.name === "AbortError";
-}
-
-export { aborter, isAbortError };

package/dist/aborter.js

@@ -1,77 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var fatcher = require('fatcher');
-
-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;
-  }
-  const baseAborter = fatcher.defineMiddleware(async (context, next) => {
-    const abortController = new AbortController();
-    if (onAbort) {
-      abortController.signal.addEventListener("abort", () => onAbort());
-    }
-    return next({
-      signal: abortController.signal,
-      abort: abortController.abort.bind(abortController)
-    });
-  }, "fatcher-middleware-aborter");
-  const timeoutAborter = fatcher.defineMiddleware(async (context, next) => {
-    const { signal, abort } = context;
-    let timer = setTimeout(abort, _timeout);
-    const release = () => {
-      if (timer) {
-        clearTimeout(timer);
-      }
-      timer = null;
-    };
-    signal.addEventListener("abort", release);
-    const result = await next();
-    release();
-    return result;
-  }, "fatcher-middleware-timeout-aborter");
-  const concurrencyAborter = fatcher.defineMiddleware(async (context, next) => {
-    const { signal, abort } = context;
-    const group = groupBy ? groupBy(context) : `${context.url}_${context.method}_${new URLSearchParams(context.params)}`;
-    if (roadMap[group] && roadMap[group].length) {
-      roadMap[group].forEach((item) => item.abort());
-    }
-    if (!roadMap[group]) {
-      roadMap[group] = [];
-    }
-    roadMap[group].push({ abort, signal });
-    const release = () => {
-      roadMap[group] = roadMap[group].filter((item) => {
-        return item.signal !== signal;
-      });
-      if (!roadMap[group].length) {
-        delete roadMap[group];
-      }
-    };
-    signal.addEventListener("abort", release);
-    const result = await next();
-    release();
-    return result;
-  }, "fatcher-middleware-concurrency-aborter");
-  const middlewares = [baseAborter];
-  if (_timeout) {
-    middlewares.push(timeoutAborter);
-  }
-  if (concurrency) {
-    middlewares.push(concurrencyAborter);
-  }
-  return middlewares;
-}
-
-function isAbortError(error) {
-  return error instanceof DOMException && error.name === "AbortError";
-}
-
-exports.aborter = aborter;
-exports.isAbortError = isAbortError;

package/dist/aborter.min.js

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