@voucherify/sdk 2.2.5 → 2.2.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @voucherify/sdk
 
+## 2.2.6
+
+### Patch Changes
+
+- [`a266c2a`](https://github.com/voucherifyio/voucherify-js-sdk/commit/a266c2a9a4a1942e2b6d8ef54021e04d36ddb02c) [#223](https://github.com/voucherifyio/voucherify-js-sdk/pull/223) Thanks [@darekg11](https://github.com/darekg11)! - Add optional timeoutMs option to VoucherifyServerSide and VoucherifyClientSide classes defiing timeout in miliseconds after which Axios is going to abort the request. By default this is equal to 0 meaining that there is no timeout beside default Voucherify's Load balancer timeout which is set to 3 minutes
+
 ## 2.2.5
 
 ### Patch Changes

package/README.md

@@ -131,6 +131,7 @@ const client = VoucherifyServerSide({
 	apiVersion: 'v2018-08-01', // optional
 	channel: 'e-commerce', // optional
 	customHeaders: { "MY_CUSTOM_HEADER": "my_value" } // optional
+	timeoutMs: 10000 // optional
 })
 ```
 
@@ -1214,6 +1215,7 @@ const client = VoucherifyClientSide({
 	apiUrl: 'https://<region>.api.voucherify.io', // optional
 	origin: 'example.com', // read more below
 	customHeaders: { "MY_CUSTOM_HEADER": "my_value" } // optional
+	timeoutMs: 10000 // optional
 })
 ```
 

package/dist/RequestController.d.ts

@@ -3,6 +3,7 @@ export interface RequestControllerOptions {
     basePath: string;
     headers: Record<string, any>;
     exposeErrorCause: boolean;
+    timeoutMs: number;
 }
 /**
  * @internal
@@ -15,7 +16,8 @@ export declare class RequestController {
     private lastResponseHeaders;
     private isLastResponseHeadersSet;
     private exposeErrorCause;
-    constructor({ basePath, baseURL, headers, exposeErrorCause }: RequestControllerOptions);
+    private timeoutMs;
+    constructor({ basePath, baseURL, headers, exposeErrorCause, timeoutMs }: RequestControllerOptions);
     isLastReponseHeadersSet(): boolean;
     getLastResponseHeaders(): Record<string, string>;
     private setLastResponseHeaders;

package/dist/VoucherifyClientSide.d.ts

@@ -78,5 +78,9 @@ export interface VoucherifyClientSideOptions {
      * The original Axios error will be included in cause property of VoucherifyError
      */
     exposeErrorCause?: boolean;
+    /**
+     * Optionally, you can set timeout in miliseconds. After this time request will be aborted. By default Voucherify's API has timeout value of 3 minutes.
+     */
+    timeoutMs?: number;
 }
 export declare function VoucherifyClientSide(options: VoucherifyClientSideOptions): ClientSide;

package/dist/VoucherifyServerSide.d.ts

@@ -98,6 +98,10 @@ export interface VoucherifyServerSideOptions {
      * The original Axios error will be included in cause property of VoucherifyError
      */
     exposeErrorCause?: boolean;
+    /**
+     * Optionally, you can set timeout in miliseconds. After this time request will be aborted. By default Voucherify's API has timeout value of 3 minutes.
+     */
+    timeoutMs?: number;
 }
 export declare function VoucherifyServerSide(options: VoucherifyServerSideOptions): {
     vouchers: Vouchers;

package/dist/voucherifysdk.esm.js

@@ -58,7 +58,8 @@ class RequestController {
     basePath,
     baseURL,
     headers,
-    exposeErrorCause
+    exposeErrorCause,
+    timeoutMs
   }) {
     this.baseURL = void 0;
     this.basePath = void 0;
@@ -67,12 +68,14 @@ class RequestController {
     this.lastResponseHeaders = void 0;
     this.isLastResponseHeadersSet = void 0;
     this.exposeErrorCause = void 0;
+    this.timeoutMs = void 0;
     this.basePath = basePath;
     this.baseURL = baseURL;
     this.headers = headers;
     this.exposeErrorCause = exposeErrorCause;
     this.lastResponseHeaders = {};
     this.isLastResponseHeadersSet = false;
+    this.timeoutMs = timeoutMs;
     this.request = axios.create({
       baseURL: `${this.baseURL}/${this.basePath}/`,
       headers: this.headers,
@@ -115,7 +118,8 @@ class RequestController {
       params,
       paramsSerializer: function (params) {
         return Qs.stringify(params);
-      }
+      },
+      timeout: this.timeoutMs
     });
     this.setLastResponseHeaders(response.headers);
     return response.data;
@@ -127,7 +131,8 @@ class RequestController {
       paramsSerializer: function (params) {
         return Qs.stringify(params);
       },
-      headers
+      headers,
+      timeout: this.timeoutMs
     });
     this.setLastResponseHeaders(response.headers);
     return response.data;
@@ -135,7 +140,8 @@ class RequestController {
 
   async put(path, body, params) {
     const response = await this.request.put(path, body, {
-      params
+      params,
+      timeout: this.timeoutMs
     });
     this.setLastResponseHeaders(response.headers);
     return response.data;
@@ -143,7 +149,8 @@ class RequestController {
 
   async delete(path, params) {
     const response = await this.request.delete(path, {
-      params
+      params,
+      timeout: this.timeoutMs
     });
     this.setLastResponseHeaders(response.headers);
     return response.data;
@@ -1447,7 +1454,7 @@ class MetadataSchemas {
 // }
 
 function VoucherifyServerSide(options) {
-  var _options$apiUrl, _options$exposeErrorC;
+  var _options$apiUrl, _options$exposeErrorC, _options$timeoutMs;
 
   assert(isObject(options), 'VoucherifyServerSide: the "options" argument must be an object');
   assert(isString(options.applicationId), 'VoucherifyServerSide: "options.applicationId" is required');
@@ -1457,7 +1464,7 @@ function VoucherifyServerSide(options) {
   let headers = {
     'X-App-Id': options.applicationId,
     'X-App-Token': options.secretKey,
-    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.2.5"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.2.6"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1483,7 +1490,8 @@ function VoucherifyServerSide(options) {
     basePath: 'v1',
     baseURL: (_options$apiUrl = options.apiUrl) != null ? _options$apiUrl : 'https://api.voucherify.io',
     headers,
-    exposeErrorCause: (_options$exposeErrorC = options.exposeErrorCause) != null ? _options$exposeErrorC : false
+    exposeErrorCause: (_options$exposeErrorC = options.exposeErrorCause) != null ? _options$exposeErrorC : false,
+    timeoutMs: (_options$timeoutMs = options.timeoutMs) != null ? _options$timeoutMs : 0
   });
   const asyncActions = new AsyncActions(client);
   const balance = new Balance(client);
@@ -1697,7 +1705,7 @@ class ClientSide {
 }
 
 function VoucherifyClientSide(options) {
-  var _options$apiUrl, _options$exposeErrorC;
+  var _options$apiUrl, _options$exposeErrorC, _options$timeoutMs;
 
   assert(isObject(options), 'VoucherifyCustomer: expected "options" argument to be an object');
   assert(isString(options.clientApplicationId), 'VoucherifyCustomer: "options.clientApplicationId" is required');
@@ -1707,7 +1715,7 @@ function VoucherifyClientSide(options) {
   let headers = {
     'X-Client-Application-Id': options.clientApplicationId,
     'X-Client-Token': options.clientSecretKey,
-    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.2.5"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.2.6"}`
   };
 
   if (environment().startsWith('Node')) {
@@ -1723,7 +1731,8 @@ function VoucherifyClientSide(options) {
     basePath: 'client/v1',
     baseURL: (_options$apiUrl = options.apiUrl) != null ? _options$apiUrl : 'https://api.voucherify.io',
     headers,
-    exposeErrorCause: (_options$exposeErrorC = options.exposeErrorCause) != null ? _options$exposeErrorC : false
+    exposeErrorCause: (_options$exposeErrorC = options.exposeErrorCause) != null ? _options$exposeErrorC : false,
+    timeoutMs: (_options$timeoutMs = options.timeoutMs) != null ? _options$timeoutMs : 0
   });
   return new ClientSide(client, options.trackingId);
 }