@marianmeres/http-utils 1.6.0 → 1.6.2

package/README.md

@@ -30,7 +30,10 @@ 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.detail.message === 'hey');
+    // `body` is a custom prop containing the raw http response body text (JSON.parse-d if available)
+    assert(e.body.message === 'hey');
+    // `cause` is a standart Error prop, containg here some default debug info
+    assert(err.cause.response.headers)
 }
 
 // EXAMPLE: assuming `/foo` returns 404 header and json {"message":"hey"}
@@ -46,6 +49,11 @@ assert(r.message === 'created');
 // EXAMPLE: raw Response
 const r = await api.get('/resource', { raw: true });
 assert(r instanceof Response);
+
+// EXAMPLE: access to response headers
+let respHeaders = {};
+const r = await api.get('/resource', null, respHeaders);
+assert(Object.keys(respHeaders).length)
 ```
 
 See [`HTTP_STATUS`](./src/status.ts) and [`HTTP_ERROR`](./src/error.ts) for more.

package/dist/api.d.ts

@@ -13,10 +13,10 @@ interface FetchParams {
 }
 type BaseFetchParams = BaseParams & FetchParams;
 export declare const createHttpApi: (base?: string | null, defaults?: Partial<BaseFetchParams> | (() => Promise<Partial<BaseFetchParams>>)) => {
-    get(path: string, params?: FetchParams, respHeaders?: null, _dumpParams?: boolean): Promise<string | BaseFetchParams | Response>;
-    post(path: string, data?: null, params?: FetchParams, respHeaders?: null, _dumpParams?: boolean): Promise<string | BaseFetchParams | Response>;
-    put(path: string, data?: null, params?: FetchParams, respHeaders?: null, _dumpParams?: boolean): Promise<string | BaseFetchParams | Response>;
-    patch(path: string, data?: null, params?: FetchParams, respHeaders?: null, _dumpParams?: boolean): Promise<string | BaseFetchParams | Response>;
-    del(path: string, data?: null, params?: FetchParams, respHeaders?: null, _dumpParams?: boolean): Promise<string | BaseFetchParams | Response>;
+    get(path: string, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
+    post(path: string, data?: null, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
+    put(path: string, data?: null, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
+    patch(path: string, data?: null, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
+    del(path: string, data?: null, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
 };
 export {};

package/dist/index.cjs

@@ -218,14 +218,12 @@ const createHttpError = (code, message,
 // (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 details, typically response text (will be JSON.parse-d if text is a valid json string)
+// arbitrary details, typically response text (will be JSON.parse-d if the content is a valid json string)
 cause) => {
     const fallback = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR;
     code = Number(code);
     if (isNaN(code) || !(code >= 400 && code < 600))
         code = fallback.CODE;
-    const found = HTTP_STATUS.findByCode(code);
-    const statusText = found?.TEXT ?? fallback.TEXT;
     // opinionated convention
     if (typeof body === 'string') {
         // prettier-ignore
@@ -244,6 +242,10 @@ cause) => {
     }
     // try to find the well known one, otherwise fallback to generic
     const ctor = _wellKnownCtorMap[`${code}`] ?? HttpError;
+    //
+    const found = HTTP_STATUS.findByCode(code);
+    const statusText = found?.TEXT ?? fallback.TEXT;
+    //
     let e = new ctor(message || statusText, { cause });
     e.status = found?.CODE ?? fallback.CODE;
     e.statusText = statusText;
@@ -326,28 +328,28 @@ const createHttpApi = (base, defaults) => {
     return {
         // GET
         async get(path, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...params, method: 'GET', path }), respHeaders, _dumpParams);
         },
         // POST
         async post(path, data = null, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'POST', path }), respHeaders, _dumpParams);
         },
         // PUT
         async put(path, data = null, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PUT', path }), respHeaders, _dumpParams);
         },
         // PATCH
         async patch(path, data = null, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PATCH', path }), respHeaders, _dumpParams);
         },
         // DELETE
         // https://stackoverflow.com/questions/299628/is-an-entity-body-allowed-for-an-http-delete-request
         async del(path, data = null, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'DELETE', path }), respHeaders, _dumpParams);
         },
     };

package/dist/index.js

@@ -216,14 +216,12 @@ const createHttpError = (code, message,
 // (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 details, typically response text (will be JSON.parse-d if text is a valid json string)
+// arbitrary details, typically response text (will be JSON.parse-d if the content is a valid json string)
 cause) => {
     const fallback = HTTP_STATUS.ERROR_SERVER.INTERNAL_SERVER_ERROR;
     code = Number(code);
     if (isNaN(code) || !(code >= 400 && code < 600))
         code = fallback.CODE;
-    const found = HTTP_STATUS.findByCode(code);
-    const statusText = found?.TEXT ?? fallback.TEXT;
     // opinionated convention
     if (typeof body === 'string') {
         // prettier-ignore
@@ -242,6 +240,10 @@ cause) => {
     }
     // try to find the well known one, otherwise fallback to generic
     const ctor = _wellKnownCtorMap[`${code}`] ?? HttpError;
+    //
+    const found = HTTP_STATUS.findByCode(code);
+    const statusText = found?.TEXT ?? fallback.TEXT;
+    //
     let e = new ctor(message || statusText, { cause });
     e.status = found?.CODE ?? fallback.CODE;
     e.statusText = statusText;
@@ -324,28 +326,28 @@ const createHttpApi = (base, defaults) => {
     return {
         // GET
         async get(path, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...params, method: 'GET', path }), respHeaders, _dumpParams);
         },
         // POST
         async post(path, data = null, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'POST', path }), respHeaders, _dumpParams);
         },
         // PUT
         async put(path, data = null, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PUT', path }), respHeaders, _dumpParams);
         },
         // PATCH
         async patch(path, data = null, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PATCH', path }), respHeaders, _dumpParams);
         },
         // DELETE
         // https://stackoverflow.com/questions/299628/is-an-entity-body-allowed-for-an-http-delete-request
         async del(path, data = null, params, respHeaders = null, _dumpParams = false) {
-            path = `${base || ''}` + path;
+            path = `${base || ''}${path || ''}`;
             return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'DELETE', path }), respHeaders, _dumpParams);
         },
     };

package/package.json

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