@marianmeres/http-utils 1.3.2 → 1.4.0

package/README.md

@@ -30,7 +30,7 @@ try {
     assert(e.toString() === 'HttpNotFoundError: Not Found');
     assert(e.status === HTTP_STATUS.ERROR_CLIENT.NOT_FOUND.CODE);
     assert(e.statusText === HTTP_STATUS.ERROR_CLIENT.NOT_FOUND.TEXT);
-    assert(e.body.message === 'hey');
+    assert(e.detail.message === 'hey');
 }
 
 // EXAMPLE: assuming `/foo` returns 404 header and json {"message":"hey"}

package/dist/error.d.ts

@@ -2,7 +2,7 @@ declare class HttpError extends Error {
     name: string;
     status: number;
     statusText: string;
-    body: string | null;
+    detail: 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, body?: 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, detail?: any, cause?: any) => BadRequest | Unauthorized | Forbidden | NotFound | MethodNotAllowed | RequestTimeout | Conflict | Gone | ImATeapot | InternalServerError | NotImplemented | BadGateway | ServiceUnavailable;
 export {};

package/dist/index.cjs

@@ -108,7 +108,7 @@ class HttpError extends Error {
     name = 'HttpError';
     status = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR.CODE;
     statusText = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR.TEXT;
-    body = null;
+    detail = null;
 }
 // some more specific instances of the well known ones...
 // client
@@ -212,8 +212,12 @@ const _wellKnownCtorMap = {
     '502': BadGateway,
     '503': ServiceUnavailable,
 };
+const createHttpError = (code, message, 
+// arbitrary details, typically response text (will be JSON.parse-d if text is valid json string)
+detail, 
 // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause
-const createHttpError = (code, message, body, cause) => {
+// arbitrary further details provided manually
+cause) => {
     const fallback = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR;
     code = Number(code);
     if (isNaN(code) || !(code >= 400 && code < 600))
@@ -221,10 +225,10 @@ const createHttpError = (code, message, body, cause) => {
     const found = HTTP_STATUS.findByCode(code);
     const statusText = found?.TEXT ?? fallback.TEXT;
     // opinionated convention
-    if (typeof body === 'string') {
+    if (typeof detail === 'string') {
         // prettier-ignore
         try {
-            body = JSON.parse(body);
+            detail = JSON.parse(detail);
         }
         catch (e) { }
     }
@@ -233,7 +237,7 @@ const createHttpError = (code, message, body, cause) => {
     let e = new ctor(message || statusText, { cause });
     e.status = found?.CODE ?? fallback.CODE;
     e.statusText = statusText;
-    e.body = body;
+    e.detail = detail;
     return e;
 };
 

package/dist/index.js

@@ -106,7 +106,7 @@ class HttpError extends Error {
     name = 'HttpError';
     status = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR.CODE;
     statusText = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR.TEXT;
-    body = null;
+    detail = null;
 }
 // some more specific instances of the well known ones...
 // client
@@ -210,8 +210,12 @@ const _wellKnownCtorMap = {
     '502': BadGateway,
     '503': ServiceUnavailable,
 };
+const createHttpError = (code, message, 
+// arbitrary details, typically response text (will be JSON.parse-d if text is valid json string)
+detail, 
 // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause
-const createHttpError = (code, message, body, cause) => {
+// arbitrary further details provided manually
+cause) => {
     const fallback = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR;
     code = Number(code);
     if (isNaN(code) || !(code >= 400 && code < 600))
@@ -219,10 +223,10 @@ const createHttpError = (code, message, body, cause) => {
     const found = HTTP_STATUS.findByCode(code);
     const statusText = found?.TEXT ?? fallback.TEXT;
     // opinionated convention
-    if (typeof body === 'string') {
+    if (typeof detail === 'string') {
         // prettier-ignore
         try {
-            body = JSON.parse(body);
+            detail = JSON.parse(detail);
         }
         catch (e) { }
     }
@@ -231,7 +235,7 @@ const createHttpError = (code, message, body, cause) => {
     let e = new ctor(message || statusText, { cause });
     e.status = found?.CODE ?? fallback.CODE;
     e.statusText = statusText;
-    e.body = body;
+    e.detail = detail;
     return e;
 };
 

package/package.json

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