@beyonk/http 12.2.0 → 12.5.0

package/README.MD

@@ -192,6 +192,8 @@ Handlers have a signature with two items:
 })
 ```
 
+Every error carries the request that failed as `e.request` (`{ method, url }`), and HTTP failures also carry `e.status` and the parsed response as `e.body`. Errors thrown by `fetch` itself, such as network failures or aborts, have `e.request` but no `e.status`.
+
 ctx can be whatever you want really - it is whatever you pass in as `context(...)`.
 
 However, if the `context` object you pass in has a `fetch` function, this is used as the `fetch` for XHR requests.
@@ -240,6 +242,19 @@ Names are the same as the local handlers:
     .get()
 ```
 
+A global `default` handler catches anything that no other handler does. A request-level `.default()` takes precedence over it, but global status handlers (such as `notFound`) do not check it.
+
+```js
+  Api.configure({
+    baseUrl: 'https://example.com/your/api/base',
+    handlers: {
+      default (e) {
+        throw error(500, e.message)
+      }
+    }
+  })
+```
+
 ## Retries
 
 The http client can retry if a network error is encountered. The default is `retry: false`, and requests won't be retried.

package/dist/index.cjs

@@ -29,10 +29,13 @@ var HttpError = class extends Error {
    * Create a new HTTP error
    * @param {string} message - Error message
    * @param {any} body - Error response body
+   * @param {number} [status] - HTTP status code, absent when the request never got a response
    */
-  constructor(message, body) {
+  constructor(message, body, status) {
     super(message);
     this.body = body;
+    this.status = status;
+    this.request = void 0;
   }
 };
 var AccessDeniedError = class extends HttpError {
@@ -141,7 +144,7 @@ var Api = class {
   handle(e, ctx) {
     const constructorName = Object.getPrototypeOf(e).constructor.name;
     const globalHandlerName = `${constructorName[0].toLowerCase()}${constructorName.slice(1, -5)}`;
-    const handler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName] || this.defaultHandler || ((e2) => {
+    const handler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName] || this.defaultHandler || this.options.handlers && this.options.handlers.default || ((e2) => {
       console.error(constructorName, e2.message, e2);
     });
     return handler(e, ctx);
@@ -175,13 +178,13 @@ var Api = class {
     try {
       result = await this.#doQuery(1, client, ep, options);
     } catch (e) {
-      console.log(e);
+      e.request = { method: options.method, url: ep };
       return this.handle(e, this.ctx);
     } finally {
       this.resetRequest();
     }
-    const { json, httpStatus } = result;
-    return fn ? fn(json, httpStatus) : json;
+    const { json, httpStatus, response } = result;
+    return fn ? fn(json, httpStatus, response) : json;
   }
   /**
    * Check if the response has content
@@ -219,7 +222,7 @@ var Api = class {
             console.error("Unable to parse response json", e.message);
           }
         }
-        return { httpStatus: r.status, json };
+        return { httpStatus: r.status, json, response: r };
       }
       let content = "";
       try {
@@ -228,7 +231,7 @@ var Api = class {
         console.log("Failed to parse error body when asked.");
       }
       const ClientError = getErrorByCode(r.status);
-      throw new ClientError(r.statusText, content);
+      throw new ClientError(r.statusText, content, r.status);
     } catch (e) {
       if (retry.attempts && retry.errors && attempt < retry.attempts && retry.errors.includes(e.code)) {
         console.warn(`Got ${e.code} when calling ${endpoint}. Retrying request (${attempt}/${retry.attempts})`);

package/dist/index.d.cts

@@ -52,12 +52,14 @@ type ErrorHandlers = {
     expectationFailed?: ErrorHandler;
     badData?: ErrorHandler;
     tooManyRequests?: ErrorHandler;
+    /** Called when no request-level or status-specific handler matches */
+    default?: ErrorHandler;
     [key: string]: ErrorHandler | undefined;
 };
 /**
  * Function to transform API response
  */
-type ResponseTransformer<T = any> = (json: any, httpStatus: number) => T;
+type ResponseTransformer<T = any> = (json: any, httpStatus: number, response: Response) => T;
 /**
  * Fetch client interface
  */
@@ -96,9 +98,16 @@ declare class HttpError extends Error {
      * Create a new HTTP error
      * @param {string} message - Error message
      * @param {any} body - Error response body
+     * @param {number} [status] - HTTP status code, absent when the request never got a response
      */
-    constructor(message: string, body: any);
+    constructor(message: string, body: any, status?: number);
     body: any;
+    status: number;
+    /** @type {{ method: string, url: string } | undefined} The request that failed */
+    request: {
+        method: string;
+        url: string;
+    } | undefined;
 }
 declare namespace _default {
     export { create };

package/dist/index.d.ts

@@ -52,12 +52,14 @@ type ErrorHandlers = {
     expectationFailed?: ErrorHandler;
     badData?: ErrorHandler;
     tooManyRequests?: ErrorHandler;
+    /** Called when no request-level or status-specific handler matches */
+    default?: ErrorHandler;
     [key: string]: ErrorHandler | undefined;
 };
 /**
  * Function to transform API response
  */
-type ResponseTransformer<T = any> = (json: any, httpStatus: number) => T;
+type ResponseTransformer<T = any> = (json: any, httpStatus: number, response: Response) => T;
 /**
  * Fetch client interface
  */
@@ -96,9 +98,16 @@ declare class HttpError extends Error {
      * Create a new HTTP error
      * @param {string} message - Error message
      * @param {any} body - Error response body
+     * @param {number} [status] - HTTP status code, absent when the request never got a response
      */
-    constructor(message: string, body: any);
+    constructor(message: string, body: any, status?: number);
     body: any;
+    status: number;
+    /** @type {{ method: string, url: string } | undefined} The request that failed */
+    request: {
+        method: string;
+        url: string;
+    } | undefined;
 }
 declare namespace _default {
     export { create };

package/dist/index.js

@@ -4,10 +4,13 @@ var HttpError = class extends Error {
    * Create a new HTTP error
    * @param {string} message - Error message
    * @param {any} body - Error response body
+   * @param {number} [status] - HTTP status code, absent when the request never got a response
    */
-  constructor(message, body) {
+  constructor(message, body, status) {
     super(message);
     this.body = body;
+    this.status = status;
+    this.request = void 0;
   }
 };
 var AccessDeniedError = class extends HttpError {
@@ -116,7 +119,7 @@ var Api = class {
   handle(e, ctx) {
     const constructorName = Object.getPrototypeOf(e).constructor.name;
     const globalHandlerName = `${constructorName[0].toLowerCase()}${constructorName.slice(1, -5)}`;
-    const handler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName] || this.defaultHandler || ((e2) => {
+    const handler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName] || this.defaultHandler || this.options.handlers && this.options.handlers.default || ((e2) => {
       console.error(constructorName, e2.message, e2);
     });
     return handler(e, ctx);
@@ -150,13 +153,13 @@ var Api = class {
     try {
       result = await this.#doQuery(1, client, ep, options);
     } catch (e) {
-      console.log(e);
+      e.request = { method: options.method, url: ep };
       return this.handle(e, this.ctx);
     } finally {
       this.resetRequest();
     }
-    const { json, httpStatus } = result;
-    return fn ? fn(json, httpStatus) : json;
+    const { json, httpStatus, response } = result;
+    return fn ? fn(json, httpStatus, response) : json;
   }
   /**
    * Check if the response has content
@@ -194,7 +197,7 @@ var Api = class {
             console.error("Unable to parse response json", e.message);
           }
         }
-        return { httpStatus: r.status, json };
+        return { httpStatus: r.status, json, response: r };
       }
       let content = "";
       try {
@@ -203,7 +206,7 @@ var Api = class {
         console.log("Failed to parse error body when asked.");
       }
       const ClientError = getErrorByCode(r.status);
-      throw new ClientError(r.statusText, content);
+      throw new ClientError(r.statusText, content, r.status);
     } catch (e) {
       if (retry.attempts && retry.errors && attempt < retry.attempts && retry.errors.includes(e.code)) {
         console.warn(`Got ${e.code} when calling ${endpoint}. Retrying request (${attempt}/${retry.attempts})`);

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "@beyonk/http",
-  "version": "12.2.0",
+  "version": "12.5.0",
   "description": "An isomorphic http client for Svelte apps",
   "type": "module",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/beyonk-adventures/http.git"
-  },
+  "repository": "https://github.com/beyonk/http.git",
   "files": [
     "dist"
   ],
@@ -48,9 +45,6 @@
   ],
   "author": "Antony Jones",
   "license": "MIT",
-  "volta": {
-    "node": "18.15.0"
-  },
   "scripts": {
     "test": "mocha './!(node_modules)/**/**.+(spec).js'",
     "lint": "eslint lib --ext .js",