fetch-request-browser 1.0.9 → 1.0.10

package/README.md

@@ -34,6 +34,7 @@ await sendGET<IHTTPBinResponse>(
 );
 // {
 //   code: 200,
+//   statusText: 'OK',
 //   headers: Headers {
 //     date: 'Fri, 06 Dec 2024 14:14:12 GMT',
 //     'content-type': 'application/json',
@@ -81,6 +82,7 @@ await sendPOST<IHTTPBinResponse>(
 );
 // {
 //   code: 200,
+//   statusText: 'OK',
 //   headers: Headers {
 //     date: 'Fri, 06 Dec 2024 12:57:25 GMT',
 //     'content-type': 'application/json',
@@ -133,6 +135,7 @@ await sendPOST<IHTTPBinResponse>(
   );
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:05:20 GMT',
   //     'content-type': 'application/json',
@@ -168,6 +171,7 @@ await sendPOST<IHTTPBinResponse>(
   await sendGET<IHTTPBinResponse>('https://httpbin.org/get?foo=hey&bar=123');
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:05:20 GMT',
   //     'content-type': 'application/json',
@@ -213,6 +217,7 @@ await sendPOST<IHTTPBinResponse>(
   );
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:13:18 GMT',
   //     'content-type': 'application/json',
@@ -264,6 +269,7 @@ await sendPOST<IHTTPBinResponse>(
   );
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:19:07 GMT',
   //     'content-type': 'application/json',
@@ -315,6 +321,7 @@ await sendPOST<IHTTPBinResponse>(
   );
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:22:54 GMT',
   //     'content-type': 'application/json',
@@ -356,6 +363,7 @@ await sendPOST<IHTTPBinResponse>(
   await sendDELETE<IHTTPBinResponse>('https://httpbin.org/delete?id=1');
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:25:41 GMT',
   //     'content-type': 'application/json',
@@ -518,6 +526,9 @@ await sendPOST<IHTTPBinResponse>(
     // the HTTP status code extracted from the Response
     code: number;
 
+    // the message associated with the status code
+    statusText: string;
+
     // the Response's Headers. Useful as some service providers attach important info in the headers
     headers: Headers;
 

package/dist/index.js

@@ -1 +1 @@
-import{extractMessage}from"error-message-utils";import{isArrayValid,delay}from"web-utils-kit";import{buildOptions,buildRequest,extractResponseData}from"./utils/utils.js";import{validateResponse}from"./validations/validations.js";const __executeSend=async(e,s)=>{const t=buildOptions(s),n=buildRequest(e,t.requestOptions),r=await fetch(n);return validateResponse(n,r,t),r.redirected&&console.warn(`The request sent to '${n.url}' was redirected. Please update the implementation to avoid future redirections.`),{code:r.status,headers:r.headers,data:await extractResponseData(r,t.responseDataType)}},send=async(e,s,t)=>{try{return await __executeSend(e,s)}catch(n){if(extractMessage(n).includes("429")||!isArrayValid(t))throw n;return await delay(t[0]),send(e,s,t.slice(1))}},sendGET=(e,s,t)=>send(e,{...s,requestOptions:{...s?.requestOptions,method:"GET"}},t),sendPOST=(e,s,t)=>send(e,{...s,requestOptions:{...s?.requestOptions,method:"POST"}},t),sendPUT=(e,s,t)=>send(e,{...s,requestOptions:{...s?.requestOptions,method:"PUT"}},t),sendPATCH=(e,s,t)=>send(e,{...s,requestOptions:{...s?.requestOptions,method:"PATCH"}},t),sendDELETE=(e,s,t)=>send(e,{...s,requestOptions:{...s?.requestOptions,method:"DELETE"}},t);export{send,sendGET,sendPOST,sendPUT,sendPATCH,sendDELETE};
+import{extractMessage}from"error-message-utils";import{isArrayValid,delay}from"web-utils-kit";import{buildOptions,buildRequest,extractErrorMessageFromResponseBody,extractResponseData}from"./utils/utils.js";import{validateResponse}from"./validations/validations.js";const __executeSend=async(e,t)=>{const s=buildOptions(t),r=buildRequest(e,s.requestOptions),a=await fetch(r);try{return validateResponse(r,a,s),a.redirected&&console.warn(`The request sent to '${r.url}' was redirected. Please update the implementation to avoid future redirections.`),{code:a.status,statusText:a.statusText,headers:a.headers,data:await extractResponseData(a,s.responseDataType)}}catch(e){const t=await extractErrorMessageFromResponseBody(a);if(t)throw new Error(extractMessage(e),{cause:t});throw e}},send=async(e,t,s)=>{try{return await __executeSend(e,t)}catch(r){if(extractMessage(r).includes("429")||!isArrayValid(s))throw r;return await delay(s[0]),send(e,t,s.slice(1))}},sendGET=(e,t,s)=>send(e,{...t,requestOptions:{...t?.requestOptions,method:"GET"}},s),sendPOST=(e,t,s)=>send(e,{...t,requestOptions:{...t?.requestOptions,method:"POST"}},s),sendPUT=(e,t,s)=>send(e,{...t,requestOptions:{...t?.requestOptions,method:"PUT"}},s),sendPATCH=(e,t,s)=>send(e,{...t,requestOptions:{...t?.requestOptions,method:"PATCH"}},s),sendDELETE=(e,t,s)=>send(e,{...t,requestOptions:{...t?.requestOptions,method:"DELETE"}},s);export{send,sendGET,sendPOST,sendPUT,sendPATCH,sendDELETE};

package/dist/shared/types.d.ts

@@ -54,6 +54,7 @@ interface IOptions {
  */
 interface IRequestResponse<T> {
     code: number;
+    statusText: string;
     headers: Headers;
     data: T;
 }

package/dist/utils/utils.d.ts

@@ -19,10 +19,18 @@ declare const buildRequest: (input: IRequestInput, options?: Partial<IRequestOpt
  * - INVALID_RESPONSE_DTYPE: if the data type is not supported by the Response Instance
  */
 declare const extractResponseData: <T>(res: Response, dType: IResponseDataType) => Promise<T>;
+/**
+ * Attempts to extract the error message from the response object. If it fails, it returns
+ * undefined.
+ * @param res
+ * @returns Promise<string | undefined>
+ * @stable
+ */
+declare const extractErrorMessageFromResponseBody: (res: Response) => Promise<string | undefined>;
 /**
  * Builds the main options object based on given args (if any).
  * @param options
  * @returns IOptions
  */
 declare const buildOptions: (options?: Partial<IOptions>) => IOptions;
-export { buildRequest, extractResponseData, buildOptions, };
+export { buildRequest, extractResponseData, extractErrorMessageFromResponseBody, buildOptions, };

package/dist/utils/utils.js

@@ -1 +1 @@
-import{encodeError,isEncodedError}from"error-message-utils";import{isArrayValid,isObjectValid}from"web-utils-kit";import{ERRORS}from"../shared/errors.js";const __buildRequestInput=e=>{if(e instanceof URL)return e;try{return new URL(e)}catch(e){throw new Error(encodeError(e,ERRORS.INVALID_REQUEST_URL))}},__buildRequestHeaders=(e,r)=>{let t;if(e&&"object"==typeof e)try{t=new Headers(e)}catch(e){throw new Error(encodeError(e,ERRORS.INVALID_REQUEST_HEADERS))}else t=e instanceof Headers?e:"GET"===r?new Headers({Accept:"application/json"}):new Headers({Accept:"application/json","Content-Type":"application/json"});return t.has("Accept")||t.append("Accept","application/json"),t.has("Content-Type")||"GET"===r||t.append("Content-Type","application/json"),t},__buildRequestBody=e=>e?isObjectValid(e,!0)||isArrayValid(e,!0)?JSON.stringify(e):e:null,__buildRequestOptions=(e={})=>{const r=e.method??"GET";return{method:r,mode:e.mode??"cors",cache:e.cache??"default",credentials:e.credentials??"same-origin",headers:__buildRequestHeaders(e.headers,r),priority:e.priority??"auto",redirect:e.redirect??"follow",referrer:e.referrer??"about:client",referrerPolicy:e.referrerPolicy??"no-referrer-when-downgrade",signal:e.signal,integrity:e.integrity||"",keepalive:e.keepalive??!1,body:"GET"===r?null:__buildRequestBody(e.body)}},buildRequest=(e,r)=>{try{return new Request(__buildRequestInput(e),__buildRequestOptions(r))}catch(e){if(isEncodedError(e))throw e;throw new Error(encodeError(e,ERRORS.INVALID_REQUEST_OPTIONS))}},extractResponseData=async(e,r)=>{switch(r){case"arrayBuffer":return e.arrayBuffer();case"blob":return e.blob();case"formData":return e.formData();case"json":return e.json();case"text":return e.text();default:throw new Error(encodeError(`The provided response data type '${r}' is invalid.`,ERRORS.INVALID_RESPONSE_DTYPE))}},buildOptions=(e={})=>({requestOptions:e.requestOptions,responseDataType:e.responseDataType??"json",acceptableStatusCodes:e.acceptableStatusCodes,acceptableStatusCodesRange:e.acceptableStatusCodesRange??{min:200,max:299},skipStatusCodeValidation:e.skipStatusCodeValidation??!1});export{buildRequest,extractResponseData,buildOptions};
+import{encodeError,extractMessage,isDefaultErrorMessage,isEncodedError}from"error-message-utils";import{isArrayValid,isObjectValid}from"web-utils-kit";import{ERRORS}from"../shared/errors.js";const __buildRequestInput=e=>{if(e instanceof URL)return e;try{return new URL(e)}catch(e){throw new Error(encodeError(e,ERRORS.INVALID_REQUEST_URL))}},__buildRequestHeaders=(e,r)=>{let t;if(e&&"object"==typeof e)try{t=new Headers(e)}catch(e){throw new Error(encodeError(e,ERRORS.INVALID_REQUEST_HEADERS))}else t=e instanceof Headers?e:"GET"===r?new Headers({Accept:"application/json"}):new Headers({Accept:"application/json","Content-Type":"application/json"});return t.has("Accept")||t.append("Accept","application/json"),t.has("Content-Type")||"GET"===r||t.append("Content-Type","application/json"),t},__buildRequestBody=e=>e?isObjectValid(e,!0)||isArrayValid(e,!0)?JSON.stringify(e):e:null,__buildRequestOptions=(e={})=>{const r=e.method??"GET";return{method:r,mode:e.mode??"cors",cache:e.cache??"default",credentials:e.credentials??"same-origin",headers:__buildRequestHeaders(e.headers,r),priority:e.priority??"auto",redirect:e.redirect??"follow",referrer:e.referrer??"about:client",referrerPolicy:e.referrerPolicy??"no-referrer-when-downgrade",signal:e.signal,integrity:e.integrity||"",keepalive:e.keepalive??!1,body:"GET"===r?null:__buildRequestBody(e.body)}},buildRequest=(e,r)=>{try{return new Request(__buildRequestInput(e),__buildRequestOptions(r))}catch(e){if(isEncodedError(e))throw e;throw new Error(encodeError(e,ERRORS.INVALID_REQUEST_OPTIONS))}},extractResponseData=async(e,r)=>{switch(r){case"arrayBuffer":return e.arrayBuffer();case"blob":return e.blob();case"formData":return e.formData();case"json":return e.json();case"text":return e.text();default:throw new Error(encodeError(`The provided response data type '${r}' is invalid.`,ERRORS.INVALID_RESPONSE_DTYPE))}},extractErrorMessageFromResponseBody=async e=>{try{const r=await e.json(),t=extractMessage(r);return isDefaultErrorMessage(t)?void 0:t}catch(e){return}},buildOptions=(e={})=>({requestOptions:e.requestOptions,responseDataType:e.responseDataType??"json",acceptableStatusCodes:e.acceptableStatusCodes,acceptableStatusCodesRange:e.acceptableStatusCodesRange??{min:200,max:299},skipStatusCodeValidation:e.skipStatusCodeValidation??!1});export{buildRequest,extractResponseData,extractErrorMessageFromResponseBody,buildOptions};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fetch-request-browser",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "The fetch-request-browser package makes working with external APIs simple and efficient. This intuitive wrapper leverages the power of the Fetch API, providing a clean and concise interface for your API interactions.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -42,7 +42,7 @@
     "vitest": "^1.6.1"
   },
   "dependencies": {
-    "error-message-utils": "^1.1.2",
+    "error-message-utils": "^1.1.3",
     "web-utils-kit": "^1.0.5"
   }
 }