fetch-request-browser 1.0.9 → 1.0.11

package/README.md

@@ -12,7 +12,7 @@ If you are working on a node-based environment, make use of [fetch-request-node]
 
 Install the package:
 ```bash
-npm install -S fetch-request-browser
+npm i -S fetch-request-browser
 ```
 
 ### Examples
@@ -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',
@@ -123,6 +125,7 @@ await sendPOST<IHTTPBinResponse>(
 
 <details>
   <summary><code>send</code></summary>
+  <br/>
 
   Builds and sends an HTTP Request based on the provided input and options.
   ```typescript
@@ -133,6 +136,7 @@ await sendPOST<IHTTPBinResponse>(
   );
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:05:20 GMT',
   //     'content-type': 'application/json',
@@ -158,16 +162,19 @@ await sendPOST<IHTTPBinResponse>(
   //   }
   // }
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>sendGET</code></summary>
+  <br/>
 
   Builds and sends a `GET` HTTP Request based on the provided input and options.
   ```typescript
   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',
@@ -193,10 +200,12 @@ await sendPOST<IHTTPBinResponse>(
   //   }
   // }
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>sendPOST</code></summary>
+  <br/>
 
   Builds and sends a `POST` HTTP Request based on the provided input and options.
   ```typescript
@@ -213,6 +222,7 @@ await sendPOST<IHTTPBinResponse>(
   );
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:13:18 GMT',
   //     'content-type': 'application/json',
@@ -244,10 +254,12 @@ await sendPOST<IHTTPBinResponse>(
   //   }
   // }
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>sendPUT</code></summary>
+  <br/>
 
   Builds and sends a `PUT` HTTP Request based on the provided input and options.
   ```typescript
@@ -264,6 +276,7 @@ await sendPOST<IHTTPBinResponse>(
   );
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:19:07 GMT',
   //     'content-type': 'application/json',
@@ -295,10 +308,12 @@ await sendPOST<IHTTPBinResponse>(
   //   }
   // }
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>sendPATCH</code></summary>
+  <br/>
 
   Builds and sends a `PATCH` HTTP Request based on the provided input and options.
   ```typescript
@@ -315,6 +330,7 @@ await sendPOST<IHTTPBinResponse>(
   );
   // {
   //   code: 200,
+  //   statusText: 'OK',
   //   headers: Headers {
   //     date: 'Fri, 06 Dec 2024 13:22:54 GMT',
   //     'content-type': 'application/json',
@@ -346,16 +362,19 @@ await sendPOST<IHTTPBinResponse>(
   //   }
   // }
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>sendDELETE</code></summary>
+  <br/>
 
   Builds and sends a `DELETE` HTTP Request based on the provided input and options.
   ```typescript
   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',
@@ -386,6 +405,7 @@ await sendPOST<IHTTPBinResponse>(
   //   }
   // }
   ```
+  <br/>
 </details>
 
 
@@ -399,24 +419,29 @@ await sendPOST<IHTTPBinResponse>(
 
 <details>
   <summary><code>IRequestInput</code></summary>
+  <br/>
 
   The URL of the request's target.
   ```typescript
   type IRequestInput = string | URL;
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>IRequestMethod</code></summary>
+  <br/>
 
   The HTTP Methods supported by this library. To make use of a different one, pass the method name directly in the request options.
   ```typescript
   type IRequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>RequestInit</code></summary>
+  <br/>
 
   The [`RequestInit`](https://developer.mozilla.org/en-US/docs/Web/API/RequestInit) dictionary of the Fetch API represents the set of options that can be used to configure a fetch request.
   ```typescript
@@ -450,10 +475,12 @@ await sendPOST<IHTTPBinResponse>(
     window?: null;
   }
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>IRequestOptions</code></summary>
+  <br/>
 
   The options that can be applied when sending a Fetch Request.
   IMPORTANT: the reason RequestInit is extended is because in the original type, the body property does not accept plain objects. Even though this makes sense,  utilities so the Request's body is always going to have a valid type.
@@ -467,19 +494,23 @@ await sendPOST<IHTTPBinResponse>(
     method: IRequestMethod;
   }
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>IResponseDataType</code></summary>
+  <br/>
 
   The type of data that will be extracted from the HTTP Response body.
   ```typescript
   type IResponseDataType = 'arrayBuffer' | 'blob' | 'formData' | 'json' | 'text';
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>IOptions</code></summary>
+  <br/>
 
   The options object that can be passed and used for any request.
   ```typescript
@@ -507,10 +538,12 @@ await sendPOST<IHTTPBinResponse>(
     skipStatusCodeValidation: boolean;
   }
   ```
+  <br/>
 </details>
 
 <details>
   <summary><code>IRequestResponse<T></code></summary>
+  <br/>
 
   The object containing the result of the Request.
   ```typescript
@@ -518,6 +551,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;
 
@@ -525,6 +561,7 @@ await sendPOST<IHTTPBinResponse>(
     data: T;
   }
   ```
+  <br/>
 </details>
 
 
@@ -560,29 +597,4 @@ npm run test:integration
 
 ## License
 
-[MIT](https://choosealicense.com/licenses/mit/)
-
-
-
-
-
-<br />
-
-## Deployment
-
-Install dependencies:
-```bash
-npm install
-```
-
-
-Build the library:
-```bash
-npm start
-```
-
-
-Publish to `npm`:
-```bash
-npm publish
-```
+[MIT](https://choosealicense.com/licenses/mit/)

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/errors.d.ts

@@ -2,4 +2,4 @@ type IErrorCode = 'INVALID_REQUEST_URL' | 'INVALID_REQUEST_HEADERS' | 'INVALID_R
 declare const ERRORS: {
     [key in IErrorCode]: IErrorCode;
 };
-export { ERRORS, };
+export { ERRORS };

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,12 +1,12 @@
 {
   "name": "fetch-request-browser",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "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",
   "type": "module",
   "scripts": {
-    "start": "ts-lib-builder --tsconfig=tsconfig.build.json",
+    "build": "ts-lib-builder --tsconfig=tsconfig.build.json",
     "test": "echo \"Error: tests are executed with  npm run test:(integration|unit)\" && exit 1",
     "test:integration": "vitest run --config vitest.test-integration.config.ts",
     "test:unit": "vitest run --config vitest.test-unit.config.ts",
@@ -33,16 +33,18 @@
   },
   "homepage": "https://github.com/jesusgraterol/fetch-request-browser#readme",
   "devDependencies": {
-    "@types/node": "^20.17.17",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "eslint-config-airbnb-typescript": "^18.0.0",
-    "ts-lib-builder": "^1.0.5",
-    "typescript": "^5.7.3",
-    "vitest": "^1.6.1"
+    "@types/node": "20.17.17",
+    "@typescript-eslint/eslint-plugin": "7.18.0",
+    "@typescript-eslint/parser": "7.18.0",
+    "eslint-config-airbnb-typescript": "18.0.0",
+    "eslint-config-prettier": "10.1.8",
+    "prettier": "3.6.2",
+    "ts-lib-builder": "1.0.7",
+    "typescript": "5.7.3",
+    "vitest": "3.2.4"
   },
   "dependencies": {
-    "error-message-utils": "^1.1.2",
-    "web-utils-kit": "^1.0.5"
+    "error-message-utils": "1.1.5",
+    "web-utils-kit": "1.0.6"
   }
 }