@beyonk/http 12.5.0 → 12.6.0

package/README.MD

@@ -198,6 +198,8 @@ 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.
 
+If it has a `logger` with an `error(details, message)` method, such as a pino logger, every failure that reaches a `default` handler (request-level or global) is logged through it before the handler runs, with `err`, `status`, `method`, `url` and `body`. Without one the console is used. Failures caught by a status-specific handler such as `.notFound()` are not logged.
+
 ```js
 export async function preload () {
   await Api

package/dist/index.cjs

@@ -144,11 +144,26 @@ 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 || this.options.handlers && this.options.handlers.default || ((e2) => {
+    const specificHandler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName];
+    const handler = specificHandler || this.defaultHandler || this.options.handlers && this.options.handlers.default || ((e2) => {
       console.error(constructorName, e2.message, e2);
     });
+    if (!specificHandler) {
+      this.log(e, ctx);
+    }
     return handler(e, ctx);
   }
+  /**
+   * Log a failed request through the context logger, or the console
+   * @param {HttpError} e - Error instance
+   * @param {ApiContext} [ctx] - API context
+   */
+  log(e, ctx) {
+    const logger = ctx && ctx.logger || console;
+    const { method, url } = e.request || {};
+    const reason = e.status ? `with ${e.status}` : `(${e.message})`;
+    logger.error({ err: e, status: e.status, method, url, body: e.body }, `${method} ${url} failed ${reason}`);
+  }
   /**
    * Send the HTTP request
    * @template T

package/dist/index.d.cts

@@ -30,6 +30,10 @@ type RetryOptions = {
 type ApiContext = {
     /** Fetch client */
     fetch?: FetchClient;
+    /** Logger for failed requests, defaults to console */
+    logger?: {
+        error: (details: Record<string, any>, message: string) => void;
+    };
     /** Additional context properties */
     [key: string]: any;
 };
@@ -152,6 +156,12 @@ declare class Api {
      * @returns {any} Result of error handler
      */
     handle(e: HttpError, ctx?: ApiContext): any;
+    /**
+     * Log a failed request through the context logger, or the console
+     * @param {HttpError} e - Error instance
+     * @param {ApiContext} [ctx] - API context
+     */
+    log(e: HttpError, ctx?: ApiContext): void;
     /**
      * Send the HTTP request
      * @template T

package/dist/index.d.ts

@@ -30,6 +30,10 @@ type RetryOptions = {
 type ApiContext = {
     /** Fetch client */
     fetch?: FetchClient;
+    /** Logger for failed requests, defaults to console */
+    logger?: {
+        error: (details: Record<string, any>, message: string) => void;
+    };
     /** Additional context properties */
     [key: string]: any;
 };
@@ -152,6 +156,12 @@ declare class Api {
      * @returns {any} Result of error handler
      */
     handle(e: HttpError, ctx?: ApiContext): any;
+    /**
+     * Log a failed request through the context logger, or the console
+     * @param {HttpError} e - Error instance
+     * @param {ApiContext} [ctx] - API context
+     */
+    log(e: HttpError, ctx?: ApiContext): void;
     /**
      * Send the HTTP request
      * @template T

package/dist/index.js

@@ -119,11 +119,26 @@ 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 || this.options.handlers && this.options.handlers.default || ((e2) => {
+    const specificHandler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName];
+    const handler = specificHandler || this.defaultHandler || this.options.handlers && this.options.handlers.default || ((e2) => {
       console.error(constructorName, e2.message, e2);
     });
+    if (!specificHandler) {
+      this.log(e, ctx);
+    }
     return handler(e, ctx);
   }
+  /**
+   * Log a failed request through the context logger, or the console
+   * @param {HttpError} e - Error instance
+   * @param {ApiContext} [ctx] - API context
+   */
+  log(e, ctx) {
+    const logger = ctx && ctx.logger || console;
+    const { method, url } = e.request || {};
+    const reason = e.status ? `with ${e.status}` : `(${e.message})`;
+    logger.error({ err: e, status: e.status, method, url, body: e.body }, `${method} ${url} failed ${reason}`);
+  }
   /**
    * Send the HTTP request
    * @template T

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beyonk/http",
-  "version": "12.5.0",
+  "version": "12.6.0",
   "description": "An isomorphic http client for Svelte apps",
   "type": "module",
   "repository": "https://github.com/beyonk/http.git",