@brostark/solutions-client 1.1.14 → 1.1.15

package/dist/helper.d.ts

@@ -13,4 +13,10 @@ export declare const setLimit: (limit: number, min: number, max: number) => numb
  * @returns The URL with the query string
  */
 export declare const buildUrlWithParams: (baseUrl: string, params?: Record<string, unknown>) => string;
+/**
+ * Remove undefined values of an objet
+ * @param record - The record
+ * @returns The record filtered
+ */
+export declare const removeUndefinedValues: <T extends object>(record: T) => T;
 //# sourceMappingURL=helper.d.ts.map

package/dist/helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,WAE/D,CAAA;AAGD;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,MAiBtF,CAAA"}
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,WAE/D,CAAA;AAGD;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,MAiBtF,CAAA;AAGD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,MAAM,EAAE,QAAQ,CAAC,KAAG,CAUnE,CAAA"}

package/dist/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildUrlWithParams = exports.setLimit = void 0;
+exports.removeUndefinedValues = exports.buildUrlWithParams = exports.setLimit = void 0;
 /**
  * Sets a limit between a minimum and maximum value
  * @param limit - The desired limit
@@ -33,3 +33,18 @@ const buildUrlWithParams = (baseUrl, params) => {
     return `${baseUrl}${separator}${search}`;
 };
 exports.buildUrlWithParams = buildUrlWithParams;
+/**
+ * Remove undefined values of an objet
+ * @param record - The record
+ * @returns The record filtered
+ */
+const removeUndefinedValues = (record) => {
+    Object.keys(record).forEach((key) => {
+        const value = record[key];
+        if (typeof value === "undefined") {
+            delete record[key];
+        }
+    });
+    return record;
+};
+exports.removeUndefinedValues = removeUndefinedValues;

package/dist/lib/httpRequest.d.ts

@@ -2,6 +2,7 @@ import { ListOptions } from "./types";
 type RequestOptions = Omit<RequestInit, "body"> & {
     params?: Record<string, unknown>;
     data?: unknown;
+    timeout?: number;
 };
 /**
  * Base function to make an HTTP request

package/dist/lib/httpRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"httpRequest.d.ts","sourceRoot":"","sources":["../../src/lib/httpRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,KAAK,cAAc,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAGF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAU,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,SAAS,cAAc,iBA2CxF,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,SAAS,WAAW,iBAOnF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,iBAI5D,CAAA;AAGD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,MAAM,OAAO,iBAK5E,CAAA;AAGD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,iBAI/D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,MAAM,IAAI,iBAQ3E,CAAA"}
+{"version":3,"file":"httpRequest.d.ts","sourceRoot":"","sources":["../../src/lib/httpRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,KAAK,cAAc,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAGF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAU,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,SAAS,cAAc,iBAkDxF,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,SAAS,WAAW,iBAOnF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,iBAI5D,CAAA;AAGD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,MAAM,OAAO,iBAK5E,CAAA;AAGD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,iBAI/D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,MAAM,IAAI,iBAQ3E,CAAA"}

package/dist/lib/httpRequest.js

@@ -11,13 +11,16 @@ const constant_1 = require("../constant");
  * @returns A promise with the request response
  */
 const httpRequest = async (apiUrl, apiKey, options) => {
-    const { headers, params, data, ...rest } = options;
+    const { headers, params, data, timeout: timeoutValue, ...rest } = options;
     const url = (0, helper_1.buildUrlWithParams)(apiUrl, params);
-    const config = {
+    const controller = typeof timeoutValue === "number" ? new AbortController() : undefined;
+    const timeoutId = typeof timeoutValue === "number" ? setTimeout(() => controller.abort(), timeoutValue) : undefined;
+    const config = (0, helper_1.removeUndefinedValues)({
         mode: "cors",
         method: "GET",
         ...rest,
-    };
+        signal: controller?.signal,
+    });
     const finalHeaders = {
         "x-api-key": apiKey,
         ...headers,
@@ -47,6 +50,11 @@ const httpRequest = async (apiUrl, apiKey, options) => {
     catch (e) {
         return responseText;
     }
+    finally {
+        if (timeoutId !== undefined) {
+            clearTimeout(timeoutId);
+        }
+    }
 };
 exports.httpRequest = httpRequest;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brostark/solutions-client",
-  "version": "1.1.14",
+  "version": "1.1.15",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/helper.ts

@@ -33,4 +33,22 @@ export const buildUrlWithParams = (baseUrl: string, params?: Record<string, unkn
   const separator = baseUrl.includes("?") ? "&" : "?";
 
   return `${baseUrl}${separator}${search}`;
-}
+}
+
+
+/**
+ * Remove undefined values of an objet
+ * @param record - The record
+ * @returns The record filtered
+ */
+export const removeUndefinedValues = <T extends object>(record: T): T => {
+  Object.keys(record).forEach((key) => {
+    const value = record[key as keyof typeof record];
+
+    if (typeof value === "undefined") {
+      delete record[key as keyof typeof record];
+    }
+  });
+
+  return record as T;
+}

package/src/lib/httpRequest.ts

@@ -1,10 +1,11 @@
 import { ListOptions } from "./types";
-import { buildUrlWithParams, setLimit } from "../helper";
+import { buildUrlWithParams, removeUndefinedValues, setLimit } from "../helper";
 import { MAX_LIMIT } from "../constant";
 
 type RequestOptions = Omit<RequestInit, "body"> & {
   params?: Record<string, unknown>;
   data?: unknown;
+  timeout?: number;
 };
 
 
@@ -16,15 +17,18 @@ type RequestOptions = Omit<RequestInit, "body"> & {
  * @returns A promise with the request response
  */
 export const httpRequest = async (apiUrl: string, apiKey: string, options: RequestOptions) => {
-  const { headers, params, data, ...rest } = options;
+  const { headers, params, data, timeout: timeoutValue,...rest } = options;
 
   const url = buildUrlWithParams(apiUrl, params);
+  const controller = typeof timeoutValue === "number" ? new AbortController() : undefined;
+  const timeoutId = typeof timeoutValue === "number" ? setTimeout(() => controller!.abort(), timeoutValue) : undefined;
 
-  const config: RequestInit = {
+  const config: RequestInit = removeUndefinedValues({
     mode: "cors",
     method: "GET",
     ...rest,
-  };
+    signal: controller?.signal,
+  });
 
   const finalHeaders: Record<string, string> = {
     "x-api-key": apiKey,
@@ -57,6 +61,10 @@ export const httpRequest = async (apiUrl: string, apiKey: string, options: Reque
     return JSON.parse(responseText);
   } catch (e) {
     return responseText;
+  } finally {
+    if (timeoutId !== undefined) {
+      clearTimeout(timeoutId);
+    }
   }
 }