@keq-request/exception 5.0.0-alpha.10

package/CHANGELOG.md

@@ -0,0 +1,125 @@
+# Changelog
+
+## 5.0.0-alpha.10
+
+### Patch Changes
+
+- e7eb9dc: Don't publish .turbo and jest.config.cts to npm
+- 7343445: Incorrect build before release
+- Updated dependencies [e7eb9dc]
+- Updated dependencies [7343445]
+  - keq@5.0.0-alpha.10
+
+## 5.0.0-alpha.9
+
+### Patch Changes
+
+- 2686b8d: build with burbo
+- 2686b8d: remove private dependencies
+- Updated dependencies [2686b8d]
+- Updated dependencies [2686b8d]
+  - keq@5.0.0-alpha.9
+
+## 5.0.0-alpha.8
+
+### Patch Changes
+
+- 0873c7e: Incorrect build before release.
+- Updated dependencies [0873c7e]
+  - keq@5.0.0-alpha.8
+
+## 5.0.0-alpha.7
+
+### Major Changes
+
+- 5175097: **BREAKING CHANGE:** group all packages under the @keq-request scope
+
+  - keq-cache => @keq-request/cache
+  - keq-headers => @keq-request/headers
+  - keq-cli => @keq-request/cli
+  - keq-url => @keq-request/url
+  - keq-exception => @keq-request/exception
+
+- 153244f: **BREAKING CHANGE:** move `RequestException` form `@keq-request/exception` to `keq`
+
+### Patch Changes
+
+- 153244f: remove override `retryOn`.
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [7ff2162]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+  - keq@5.0.0-alpha.7
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [3.2.0](https://github.com/keq-request/keq-exception/compare/v3.1.4...v3.2.0) (2025-06-05)
+
+### Features
+
+- add type-fest dependency and update Promisable type usage in catchException and throwException ([7c3cc96](https://github.com/keq-request/keq-exception/commit/7c3cc96a149914afac090ada383010fa4482c311))
+
+## [3.1.4](https://github.com/keq-request/keq-exception/compare/v3.1.3...v3.1.4) (2025-06-05)
+
+### Bug Fixes
+
+- update catchException handler to support async functions ([18dd4f2](https://github.com/keq-request/keq-exception/commit/18dd4f25201c9e8eaaa20782b94bc78906807262))
+
+## [3.1.3](https://github.com/keq-request/keq-exception/compare/v3.1.2...v3.1.3) (2024-12-18)
+
+### Bug Fixes
+
+- update module exports to include file extensions for esm ([ba42c19](https://github.com/keq-request/keq-exception/commit/ba42c198fe75c2fdd8ad4b6325675fe7920cf45b))
+
+## [3.1.2](https://github.com/keq-request/keq-exception/compare/v3.1.1...v3.1.2) (2024-10-15)
+
+### Bug Fixes
+
+- move jest-environment-jsdom to dev deps ([7b316de](https://github.com/keq-request/keq-exception/commit/7b316de1c7720d2f68fb7c63002a595e6cf93798))
+
+## [3.1.1](https://github.com/keq-request/keq-exception/compare/v3.1.0...v3.1.1) (2024-10-15)
+
+### Bug Fixes
+
+- export esm module error ([aba0c00](https://github.com/keq-request/keq-exception/commit/aba0c00cc3f0918aa49df8ccfc312b890ee3efa1))
+
+## [3.1.0](https://github.com/keq-request/keq-exception/compare/v3.0.0...v3.1.0) (2024-05-28)
+
+### Features
+
+- control whether to trigger retry ([decd756](https://github.com/keq-request/keq-exception/commit/decd756ff54697754ac1e9d9dad97300c824732d))
+
+## [3.0.0](https://github.com/keq-request/keq-exception/compare/v2.1.2...v3.0.0) (2024-05-26)
+
+### ⚠ BREAKING CHANGES
+
+- throwException parameter changes
+
+### Features
+
+- throw error takes effect when retrying ([5ff1fb5](https://github.com/keq-request/keq-exception/commit/5ff1fb5b3ebca23e63111bb7ace9030da0d2d078))
+
+## [2.1.2](https://github.com/keq-request/keq-exception/compare/v2.1.1...v2.1.2) (2024-05-13)
+
+### Continuous Integration
+
+- cannot publish ([3dd7c23](https://github.com/keq-request/keq-exception/commit/3dd7c23aaaa933c03ad8f4634ee888871028e88a))
+
+## [2.1.1](https://github.com/keq-request/keq-exception/compare/v2.1.0...v2.1.1) (2024-05-13)
+
+### Performance Improvements
+
+- add middleware function name ([028a50a](https://github.com/keq-request/keq-exception/commit/028a50a54440b303ca1d5f928045ca2fed9bf368))
+
+## [2.1.0](https://github.com/keq-request/keq-exception/compare/v2.0.0...v2.1.0) (2024-04-23)
+
+### Features
+
+- message never required for RequestException ([828f29e](https://github.com/keq-request/keq-exception/commit/828f29e8b2048536e1267f45f6380c384ca2afbe))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Val.istar.Guo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+<!-- title -->
+<p align="center" style="padding-top: 41px">
+  <img src="https://raw.githubusercontent.com/keq-request/keq/refs/heads/master/images/logo.svg" width="121" alt="logo" />
+</p>
+
+<h2 align="center" style="text-align: center">KEQ-EXCEPTION</h2>
+<!-- title -->
+
+[![version](https://img.shields.io/npm/v/keq-exception.svg?style=for-the-badge)](https://www.npmjs.com/package/keq-exception)
+[![downloads](https://img.shields.io/npm/dm/keq-exception.svg?style=for-the-badge)](https://www.npmjs.com/package/keq-exception)
+[![license](https://img.shields.io/npm/l/keq-exception.svg?style=for-the-badge)](https://www.npmjs.com/package/keq-exception)
+[![dependencies](https://img.shields.io/librariesio/release/npm/keq-exception?style=for-the-badge)](https://www.npmjs.com/package/keq-exception)
+[![codecov](https://img.shields.io/codecov/c/gh/keq-request/keq-exception?logo=codecov&token=HWP4GTMWV8&style=for-the-badge)](https://codecov.io/gh/keq-request/keq-exception)
+
+[Document EN]: https://keq-request.github.io/guide/libraries/keq-exception
+[Document CN]: https://keq-request.github.io/zh/guide/libraries/keq-exception
+
+[**Document**][Document EN] | [**中文文档**][Document CN]
+
+`Middleware` for throwing/catching exceptions. And it can control whether the exception trigger `retry`.
+
+## Usage
+
+<!-- prettier-ignore -->
+```typescript
+import { request } from "keq"
+import {
+  throwException,
+  catchException,
+  RequestException,
+} from "keq-exception"
+
+request
+  .use(
+    catchException((err) => {
+      if (err instanceof RequestException && err.code === 401) {
+        context.redirect("/login")
+        return
+      }
+
+      throw err
+    })
+  )
+
+  // Callback will run after `await next()`.
+  // This way you can throw errors based on the response body.
+  .use(
+    throwException(async (ctx) => {
+      if (ctx.response && ctx.response.status >= 400) {
+        const body = await ctx.response.json()
+        throw new RequestException(ctx.response.status, body.message)
+      }
+    })
+  )
+```
+
+### RequestException(statusCode[, errorMessage[, retry]])
+
+| **Parameter** | **Default** | **Description**                              |
+| :------------ | :---------- | -------------------------------------------- |
+| statusCode    | -           | Error code                                   |
+| message       | `''`        | Error message                                |
+| retry         | `true`      | Whether the thrown error can trigger a retry |

package/dist/catch-exception.d.ts

@@ -0,0 +1,4 @@
+import { KeqMiddleware } from 'keq';
+import { Promisable } from 'type-fest';
+export declare function catchException(handler: (e: unknown) => Promisable<void>): KeqMiddleware;
+//# sourceMappingURL=catch-exception.d.ts.map

package/dist/catch-exception.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catch-exception.d.ts","sourceRoot":"","sources":["../src/catch-exception.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAA;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAGtC,wBAAgB,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,UAAU,CAAC,IAAI,CAAC,GAAG,aAAa,CAQvF"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './throw-exception.js';
+export * from './catch-exception.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA"}

package/dist/index.js

@@ -0,0 +1,51 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  catchException: () => catchException,
+  throwException: () => throwException
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/throw-exception.ts
+function throwException(check) {
+  return async function throwException2(ctx, next) {
+    await next();
+    await check(ctx);
+  };
+}
+
+// src/catch-exception.ts
+function catchException(handler) {
+  return async function catchException2(ctx, next) {
+    try {
+      await next();
+    } catch (err) {
+      await handler(err);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  catchException,
+  throwException
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/throw-exception.ts","../src/catch-exception.ts"],"sourcesContent":["export * from './throw-exception.js'\nexport * from './catch-exception.js'\n","import { KeqContext, KeqMiddleware } from 'keq'\nimport { Promisable } from 'type-fest'\n\n\nexport type Check = (ctx: KeqContext) => Promisable<void>\n\nexport function throwException(check: Check): KeqMiddleware {\n  return async function throwException(ctx, next) {\n    await next()\n\n    await check(ctx)\n  }\n}\n","import { KeqMiddleware } from 'keq'\nimport { Promisable } from 'type-fest'\n\n\nexport function catchException(handler: (e: unknown) => Promisable<void>): KeqMiddleware {\n  return async function catchException(ctx, next) {\n    try {\n      await next()\n    } catch (err) {\n      await handler(err)\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACMO,SAAS,eAAe,OAA6B;AAC1D,SAAO,eAAeA,gBAAe,KAAK,MAAM;AAC9C,UAAM,KAAK;AAEX,UAAM,MAAM,GAAG;AAAA,EACjB;AACF;;;ACRO,SAAS,eAAe,SAA0D;AACvF,SAAO,eAAeC,gBAAe,KAAK,MAAM;AAC9C,QAAI;AACF,YAAM,KAAK;AAAA,IACb,SAAS,KAAK;AACZ,YAAM,QAAQ,GAAG;AAAA,IACnB;AAAA,EACF;AACF;","names":["throwException","catchException"]}

package/dist/index.mjs

@@ -0,0 +1,23 @@
+// src/throw-exception.ts
+function throwException(check) {
+  return async function throwException2(ctx, next) {
+    await next();
+    await check(ctx);
+  };
+}
+
+// src/catch-exception.ts
+function catchException(handler) {
+  return async function catchException2(ctx, next) {
+    try {
+      await next();
+    } catch (err) {
+      await handler(err);
+    }
+  };
+}
+export {
+  catchException,
+  throwException
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/throw-exception.ts","../src/catch-exception.ts"],"sourcesContent":["import { KeqContext, KeqMiddleware } from 'keq'\nimport { Promisable } from 'type-fest'\n\n\nexport type Check = (ctx: KeqContext) => Promisable<void>\n\nexport function throwException(check: Check): KeqMiddleware {\n  return async function throwException(ctx, next) {\n    await next()\n\n    await check(ctx)\n  }\n}\n","import { KeqMiddleware } from 'keq'\nimport { Promisable } from 'type-fest'\n\n\nexport function catchException(handler: (e: unknown) => Promisable<void>): KeqMiddleware {\n  return async function catchException(ctx, next) {\n    try {\n      await next()\n    } catch (err) {\n      await handler(err)\n    }\n  }\n}\n"],"mappings":";AAMO,SAAS,eAAe,OAA6B;AAC1D,SAAO,eAAeA,gBAAe,KAAK,MAAM;AAC9C,UAAM,KAAK;AAEX,UAAM,MAAM,GAAG;AAAA,EACjB;AACF;;;ACRO,SAAS,eAAe,SAA0D;AACvF,SAAO,eAAeC,gBAAe,KAAK,MAAM;AAC9C,QAAI;AACF,YAAM,KAAK;AAAA,IACb,SAAS,KAAK;AACZ,YAAM,QAAQ,GAAG;AAAA,IACnB;AAAA,EACF;AACF;","names":["throwException","catchException"]}

package/dist/throw-exception.d.ts

@@ -0,0 +1,5 @@
+import { KeqContext, KeqMiddleware } from 'keq';
+import { Promisable } from 'type-fest';
+export type Check = (ctx: KeqContext) => Promisable<void>;
+export declare function throwException(check: Check): KeqMiddleware;
+//# sourceMappingURL=throw-exception.d.ts.map

package/dist/throw-exception.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"throw-exception.d.ts","sourceRoot":"","sources":["../src/throw-exception.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,KAAK,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAGtC,MAAM,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,UAAU,KAAK,UAAU,CAAC,IAAI,CAAC,CAAA;AAEzD,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,aAAa,CAM1D"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@keq-request/exception",
+  "version": "5.0.0-alpha.10",
+  "description": "Request exception for keq",
+  "keywords": [
+    "keq",
+    "request",
+    "exception",
+    "error",
+    "fetch"
+  ],
+  "homepage": "https://github.com/keq-request/keq#readme",
+  "bugs": {
+    "url": "https://github.com/keq-request/keq/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/keq-request/keq.git"
+  },
+  "license": "MIT",
+  "author": "Val.istar.Guo <val.istar.guo@gmail.com>",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "dependencies": {
+    "type-fest": "^5.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19.24",
+    "keq": "5.0.0-alpha.10"
+  },
+  "peerDependencies": {
+    "keq": "^5.0.0-alpha.10"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "jest",
+    "test:update": "jest -u"
+  }
+}