@marianmeres/http-utils 1.10.0 → 1.11.0

package/README.md

@@ -32,7 +32,7 @@ try {
     assert(e.statusText === HTTP_STATUS.ERROR_CLIENT.NOT_FOUND.TEXT);
     // `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
+    // `cause` is a standart Error prop, containing here some default debug info
     assert(err.cause.response.headers)
 }
 

package/dist/api.d.ts

@@ -12,11 +12,15 @@ interface FetchParams {
     assert?: null | boolean;
 }
 type BaseFetchParams = BaseParams & FetchParams;
-export declare const createHttpApi: (base?: string | null, defaults?: Partial<BaseFetchParams> | (() => Promise<Partial<BaseFetchParams>>)) => {
-    get(path: string, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
-    post(path: string, data?: any, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
-    put(path: string, data?: any, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
-    patch(path: string, data?: any, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
-    del(path: string, data?: any, params?: FetchParams, respHeaders?: any, _dumpParams?: boolean): Promise<any>;
+type ErrorMessageExtractor = (body: any, response: Response) => any;
+export declare function createHttpApi(base?: string | null, defaults?: Partial<BaseFetchParams> | (() => Promise<Partial<BaseFetchParams>>), factoryErrorMessageExtractor?: ErrorMessageExtractor | null | undefined): {
+    get(path: string, params?: FetchParams, respHeaders?: any, errorMessageExtractor?: ErrorMessageExtractor | null | undefined, _dumpParams?: boolean): Promise<any>;
+    post(path: string, data?: any, params?: FetchParams, respHeaders?: any, errorMessageExtractor?: ErrorMessageExtractor | null | undefined, _dumpParams?: boolean): Promise<any>;
+    put(path: string, data?: any, params?: FetchParams, respHeaders?: any, errorMessageExtractor?: ErrorMessageExtractor | null | undefined, _dumpParams?: boolean): Promise<any>;
+    patch(path: string, data?: any, params?: FetchParams, respHeaders?: any, errorMessageExtractor?: ErrorMessageExtractor | null | undefined, _dumpParams?: boolean): Promise<any>;
+    del(path: string, data?: any, params?: FetchParams, respHeaders?: any, errorMessageExtractor?: ErrorMessageExtractor | null | undefined, _dumpParams?: boolean): Promise<any>;
 };
+export declare namespace createHttpApi {
+    var defaultErrorMessageExtractor: ErrorMessageExtractor | null | undefined;
+}
 export {};

package/dist/index.cjs

@@ -297,7 +297,7 @@ const _fetchRaw = async ({ method, path, data = null, token = null, headers = nu
     }
     return await fetch(path, opts);
 };
-const _fetch = async (params, respHeaders = null, _dumpParams = false) => {
+const _fetch = async (params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) => {
     if (_dumpParams)
         return params;
     const r = await _fetchRaw(params);
@@ -319,7 +319,24 @@ 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, {
+        // now we need to extract error message from an unknown response... this is obviously
+        // impossible unless we know what to expect, but we'll do some educated tries...
+        const extractor = errorMessageExtractor ?? // provided arg
+            createHttpApi.defaultErrorMessageExtractor ?? // static default
+            // educated guess fallback
+            function (_body, _response) {
+                let msg = 
+                // try opinionated convention first
+                _body?.error?.message ||
+                    _body?.message ||
+                    _response?.statusText ||
+                    'Unknown error';
+                if (msg.length > 255)
+                    msg = `[Shortened]: ${msg.slice(0, 255)}`;
+                return msg;
+            };
+        // adding `cause` describing more details
+        throw createHttpError(r.status, extractor(body, r), body, {
             method: params.method,
             path: params.path,
             response: {
@@ -331,7 +348,7 @@ const _fetch = async (params, respHeaders = null, _dumpParams = false) => {
     }
     return body;
 };
-const createHttpApi = (base, defaults) => {
+function createHttpApi(base, defaults, factoryErrorMessageExtractor) {
     const _merge = (a, b) => {
         const wrap = { result: a };
         merge.dset(wrap, 'result', b);
@@ -347,33 +364,34 @@ const createHttpApi = (base, defaults) => {
     });
     return {
         // GET
-        async get(path, params, respHeaders = null, _dumpParams = false) {
+        async get(path, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...params, method: 'GET', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...params, method: 'GET', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _dumpParams);
         },
         // POST
-        async post(path, data = null, params, respHeaders = null, _dumpParams = false) {
+        async post(path, data = null, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'POST', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'POST', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _dumpParams);
         },
         // PUT
-        async put(path, data = null, params, respHeaders = null, _dumpParams = false) {
+        async put(path, data = null, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PUT', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PUT', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _dumpParams);
         },
         // PATCH
-        async patch(path, data = null, params, respHeaders = null, _dumpParams = false) {
+        async patch(path, data = null, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PATCH', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PATCH', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _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) {
+        async del(path, data = null, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'DELETE', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'DELETE', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _dumpParams);
         },
     };
-};
+}
+createHttpApi.defaultErrorMessageExtractor = null;
 
 exports.HTTP_ERROR = HTTP_ERROR;
 exports.HTTP_STATUS = HTTP_STATUS;

package/dist/index.js

@@ -295,7 +295,7 @@ const _fetchRaw = async ({ method, path, data = null, token = null, headers = nu
     }
     return await fetch(path, opts);
 };
-const _fetch = async (params, respHeaders = null, _dumpParams = false) => {
+const _fetch = async (params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) => {
     if (_dumpParams)
         return params;
     const r = await _fetchRaw(params);
@@ -317,7 +317,24 @@ 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, {
+        // now we need to extract error message from an unknown response... this is obviously
+        // impossible unless we know what to expect, but we'll do some educated tries...
+        const extractor = errorMessageExtractor ?? // provided arg
+            createHttpApi.defaultErrorMessageExtractor ?? // static default
+            // educated guess fallback
+            function (_body, _response) {
+                let msg = 
+                // try opinionated convention first
+                _body?.error?.message ||
+                    _body?.message ||
+                    _response?.statusText ||
+                    'Unknown error';
+                if (msg.length > 255)
+                    msg = `[Shortened]: ${msg.slice(0, 255)}`;
+                return msg;
+            };
+        // adding `cause` describing more details
+        throw createHttpError(r.status, extractor(body, r), body, {
             method: params.method,
             path: params.path,
             response: {
@@ -329,7 +346,7 @@ const _fetch = async (params, respHeaders = null, _dumpParams = false) => {
     }
     return body;
 };
-const createHttpApi = (base, defaults) => {
+function createHttpApi(base, defaults, factoryErrorMessageExtractor) {
     const _merge = (a, b) => {
         const wrap = { result: a };
         dset(wrap, 'result', b);
@@ -345,32 +362,33 @@ const createHttpApi = (base, defaults) => {
     });
     return {
         // GET
-        async get(path, params, respHeaders = null, _dumpParams = false) {
+        async get(path, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...params, method: 'GET', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...params, method: 'GET', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _dumpParams);
         },
         // POST
-        async post(path, data = null, params, respHeaders = null, _dumpParams = false) {
+        async post(path, data = null, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'POST', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'POST', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _dumpParams);
         },
         // PUT
-        async put(path, data = null, params, respHeaders = null, _dumpParams = false) {
+        async put(path, data = null, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PUT', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PUT', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _dumpParams);
         },
         // PATCH
-        async patch(path, data = null, params, respHeaders = null, _dumpParams = false) {
+        async patch(path, data = null, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PATCH', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'PATCH', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _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) {
+        async del(path, data = null, params, respHeaders = null, errorMessageExtractor = null, _dumpParams = false) {
             path = `${base || ''}${path || ''}`;
-            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'DELETE', path }), respHeaders, _dumpParams);
+            return _fetch(_merge(await _getDefs(), { ...(params || {}), data, method: 'DELETE', path }), respHeaders, errorMessageExtractor ?? factoryErrorMessageExtractor, _dumpParams);
         },
     };
-};
+}
+createHttpApi.defaultErrorMessageExtractor = null;
 
 export { HTTP_ERROR, HTTP_STATUS, createHttpApi, createHttpError };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@marianmeres/http-utils",
-	"version": "1.10.0",
+	"version": "1.11.0",
 	"description": "Misc DRY http fetch related helpers",
 	"type": "module",
 	"main": "./dist/index.cjs",
@@ -32,6 +32,7 @@
 	},
 	"homepage": "https://github.com/marianmeres/http-utils#readme",
 	"devDependencies": {
+		"@marianmeres/clog": "^1.0.1",
 		"@marianmeres/release": "^1.1.2",
 		"@marianmeres/test-runner": "^2.0.16",
 		"@rollup/plugin-typescript": "^11.1.6",