@marianmeres/http-utils 1.4.0 → 1.6.0

package/dist/error.d.ts

@@ -2,7 +2,7 @@ declare class HttpError extends Error {
     name: string;
     status: number;
     statusText: string;
-    detail: any;
+    body: any;
 }
 declare class BadRequest extends HttpError {
     name: string;
@@ -83,5 +83,5 @@ export declare const HTTP_ERROR: {
     BadGateway: typeof BadGateway;
     ServiceUnavailable: typeof ServiceUnavailable;
 };
-export declare const createHttpError: (code: number | string, message?: string | null, detail?: any, cause?: any) => BadRequest | Unauthorized | Forbidden | NotFound | MethodNotAllowed | RequestTimeout | Conflict | Gone | ImATeapot | InternalServerError | NotImplemented | BadGateway | ServiceUnavailable;
+export declare const createHttpError: (code: number | string, message?: string | null, body?: string | null, cause?: any) => BadRequest | Unauthorized | Forbidden | NotFound | MethodNotAllowed | RequestTimeout | Conflict | Gone | ImATeapot | InternalServerError | NotImplemented | BadGateway | ServiceUnavailable;
 export {};

package/dist/index.cjs

@@ -106,9 +106,10 @@ class HTTP_STATUS {
 // opinionated base for all
 class HttpError extends Error {
     name = 'HttpError';
+    // props simulating fetch Response
     status = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR.CODE;
     statusText = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR.TEXT;
-    detail = null;
+    body = null;
 }
 // some more specific instances of the well known ones...
 // client
@@ -213,10 +214,11 @@ const _wellKnownCtorMap = {
     '503': ServiceUnavailable,
 };
 const createHttpError = (code, message, 
-// arbitrary details, typically response text (will be JSON.parse-d if text is valid json string)
-detail, 
+// arbitrary content, typically http response body which threw this error
+// (will be JSON.parse-d if the content is a valid json string)
+body, 
 // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause
-// arbitrary further details provided manually
+// arbitrary details, typically response text (will be JSON.parse-d if text is a valid json string)
 cause) => {
     const fallback = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR;
     code = Number(code);
@@ -225,10 +227,18 @@ cause) => {
     const found = HTTP_STATUS.findByCode(code);
     const statusText = found?.TEXT ?? fallback.TEXT;
     // opinionated convention
-    if (typeof detail === 'string') {
+    if (typeof body === 'string') {
         // prettier-ignore
         try {
-            detail = JSON.parse(detail);
+            body = JSON.parse(body);
+        }
+        catch (e) { }
+    }
+    // opinionated convention
+    if (typeof cause === 'string') {
+        // prettier-ignore
+        try {
+            cause = JSON.parse(cause);
         }
         catch (e) { }
     }
@@ -237,7 +247,7 @@ cause) => {
     let e = new ctor(message || statusText, { cause });
     e.status = found?.CODE ?? fallback.CODE;
     e.statusText = statusText;
-    e.detail = detail;
+    e.body = body;
     return e;
 };
 
@@ -271,14 +281,13 @@ const _fetch = async (params, respHeaders = null, _dumpParams = false) => {
     const r = await _fetchRaw(params);
     if (params.raw)
         return r;
+    //
+    const headers = [...r.headers.entries()].reduce((m, [k, v]) => ({ ...m, [k]: v }), {});
     // quick-n-dirty reference to headers (so it's still accessible over this api wrap)
     if (respHeaders) {
-        Object.assign(respHeaders, [...r.headers.entries()].reduce((m, [k, v]) => ({ ...m, [k]: v }), {}), 
+        Object.assign(respHeaders, { ...headers }, 
         // adding status/text under special keys
-        {
-            __http_status_code__: r.status,
-            __http_status_text__: r.statusText,
-        });
+        { __http_status_code__: r.status, __http_status_text__: r.statusText });
     }
     let body = await r.text();
     // prettier-ignore
@@ -288,7 +297,15 @@ const _fetch = async (params, respHeaders = null, _dumpParams = false) => {
     catch (e) { }
     params.assert ??= true; // default is true
     if (!r.ok && params.assert) {
-        throw createHttpError(r.status, null, body);
+        throw createHttpError(r.status, null, body, {
+            method: params.method,
+            path: params.path,
+            response: {
+                status: r.status,
+                statusText: r.statusText,
+                headers,
+            },
+        });
     }
     return body;
 };

package/dist/index.js

@@ -104,9 +104,10 @@ class HTTP_STATUS {
 // opinionated base for all
 class HttpError extends Error {
     name = 'HttpError';
+    // props simulating fetch Response
     status = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR.CODE;
     statusText = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR.TEXT;
-    detail = null;
+    body = null;
 }
 // some more specific instances of the well known ones...
 // client
@@ -211,10 +212,11 @@ const _wellKnownCtorMap = {
     '503': ServiceUnavailable,
 };
 const createHttpError = (code, message, 
-// arbitrary details, typically response text (will be JSON.parse-d if text is valid json string)
-detail, 
+// arbitrary content, typically http response body which threw this error
+// (will be JSON.parse-d if the content is a valid json string)
+body, 
 // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause
-// arbitrary further details provided manually
+// arbitrary details, typically response text (will be JSON.parse-d if text is a valid json string)
 cause) => {
     const fallback = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR;
     code = Number(code);
@@ -223,10 +225,18 @@ cause) => {
     const found = HTTP_STATUS.findByCode(code);
     const statusText = found?.TEXT ?? fallback.TEXT;
     // opinionated convention
-    if (typeof detail === 'string') {
+    if (typeof body === 'string') {
         // prettier-ignore
         try {
-            detail = JSON.parse(detail);
+            body = JSON.parse(body);
+        }
+        catch (e) { }
+    }
+    // opinionated convention
+    if (typeof cause === 'string') {
+        // prettier-ignore
+        try {
+            cause = JSON.parse(cause);
         }
         catch (e) { }
     }
@@ -235,7 +245,7 @@ cause) => {
     let e = new ctor(message || statusText, { cause });
     e.status = found?.CODE ?? fallback.CODE;
     e.statusText = statusText;
-    e.detail = detail;
+    e.body = body;
     return e;
 };
 
@@ -269,14 +279,13 @@ const _fetch = async (params, respHeaders = null, _dumpParams = false) => {
     const r = await _fetchRaw(params);
     if (params.raw)
         return r;
+    //
+    const headers = [...r.headers.entries()].reduce((m, [k, v]) => ({ ...m, [k]: v }), {});
     // quick-n-dirty reference to headers (so it's still accessible over this api wrap)
     if (respHeaders) {
-        Object.assign(respHeaders, [...r.headers.entries()].reduce((m, [k, v]) => ({ ...m, [k]: v }), {}), 
+        Object.assign(respHeaders, { ...headers }, 
         // adding status/text under special keys
-        {
-            __http_status_code__: r.status,
-            __http_status_text__: r.statusText,
-        });
+        { __http_status_code__: r.status, __http_status_text__: r.statusText });
     }
     let body = await r.text();
     // prettier-ignore
@@ -286,7 +295,15 @@ const _fetch = async (params, respHeaders = null, _dumpParams = false) => {
     catch (e) { }
     params.assert ??= true; // default is true
     if (!r.ok && params.assert) {
-        throw createHttpError(r.status, null, body);
+        throw createHttpError(r.status, null, body, {
+            method: params.method,
+            path: params.path,
+            response: {
+                status: r.status,
+                statusText: r.statusText,
+                headers,
+            },
+        });
     }
     return body;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@marianmeres/http-utils",
-	"version": "1.4.0",
+	"version": "1.6.0",
 	"description": "Misc DRY http fetch related helpers",
 	"type": "module",
 	"main": "./dist/index.cjs",