@voucherify/sdk 2.0.4 → 2.0.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @voucherify/sdk
 
+## 2.0.5
+
+### Patch Changes
+
+- [`a7811e7`](https://github.com/voucherifyio/voucherify-js-sdk/commit/a7811e7e2939efe7a4c59c004dbc9591fcd73030) [#121](https://github.com/voucherifyio/voucherify-js-sdk/pull/121) Thanks [@jkaliszuk](https://github.com/jkaliszuk)! - Added logic that allow to storage lastResponseHeaders data and get apiLimit through ApiLimitsHandler
+
 ## 2.0.4
 
 ### Patch Changes

package/README.md

@@ -66,6 +66,8 @@ Server side:
 <a href="#events">Events</a>
 |
 <a href="#async-actions">Async Actions</a>
+|
+<a href="#api-limits-handler">Api Limits Handler</a>
 </p>
 
 <p align="center">
@@ -1124,6 +1126,37 @@ client.asyncActions.list()
 client.asyncActions.list(params)
 ```
 
+--- 
+
+### Api Limits Handler
+
+Methods are provided within `client.apiLimitsHandler.*` namespace.
+
+- [Are Limits Available](#are-limits-available)
+- [Get Rate Limit](#get-rate-limit)
+- [Get Rate Limit Remaining](#get-rate-limit-remaining)
+
+#### Are Limits Available
+```javascript
+client.apiLimitsHandler.areLimitsAvailable()
+```
+
+This method should be called each time beforehand [Get Rate Limit](#get-rate-limit) or [Get Rate Limit Remaining](#get-rate-limit-remaining) to ensure limit data are available.
+
+#### Get Rate Limit
+```javascript
+if(client.apiLimitsHandler.areLimitsAvailable()){
+  client.apiLimitsHandler.getRateLimit()
+}
+```
+
+#### Get Rate Limit Remaining
+```javascript
+if(client.apiLimitsHandler.areLimitsAvailable()){
+  client.apiLimitsHandler.getRateLimitRemaining()
+}
+```
+
 ---
 
 # 💅 Client Side

package/dist/ApiLimitsHandler.d.ts

@@ -0,0 +1,9 @@
+import { RequestController } from './RequestController';
+export declare class ApiLimitsHandler {
+    private readonly requestController;
+    constructor(requestController: RequestController);
+    private getLastResponseHeadersFromController;
+    areLimitsAvailable(): boolean;
+    getRateLimit(): number;
+    getRateLimitRemaining(): number;
+}

package/dist/RequestController.d.ts

@@ -11,7 +11,12 @@ export declare class RequestController {
     private basePath;
     private headers;
     private request;
+    private lastResponseHeaders;
+    private isLastResponseHeadersSet;
     constructor({ basePath, baseURL, headers }: RequestControllerOptions);
+    isLastReponseHeadersSet(): boolean;
+    getLastResponseHeaders(): Record<string, string>;
+    private setLastResponseHeaders;
     setBaseUrl(baseURL: string): void;
     get<T>(path: string, params?: Record<string, any>): Promise<T>;
     post<T>(path: string, body: Record<string, any>, params?: Record<string, any>, headers?: Record<string, any>): Promise<T>;

package/dist/VoucherifyServerSide.d.ts

@@ -14,6 +14,7 @@ import { Rewards } from './Rewards';
 import { Loyalties } from './Loyalties';
 import { ValidationRules } from './ValidationRules';
 import { Segments } from './Segments';
+import { ApiLimitsHandler } from './ApiLimitsHandler';
 export interface VoucherifyServerSideOptions {
     /**
      * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -108,4 +109,5 @@ export declare function VoucherifyServerSide(options: VoucherifyServerSideOption
     validationRules: ValidationRules;
     events: Events;
     asyncActions: AsyncActions;
+    apiLimitsHandler: ApiLimitsHandler;
 };

package/dist/voucherifysdk.esm.js

@@ -44,9 +44,13 @@ class RequestController {
     this.basePath = void 0;
     this.headers = void 0;
     this.request = void 0;
+    this.lastResponseHeaders = void 0;
+    this.isLastResponseHeadersSet = void 0;
     this.basePath = basePath;
     this.baseURL = baseURL;
     this.headers = headers;
+    this.lastResponseHeaders = {};
+    this.isLastResponseHeadersSet = false;
     this.request = axios.create({
       baseURL: `${this.baseURL}/${this.basePath}/`,
       headers: this.headers,
@@ -66,6 +70,19 @@ class RequestController {
     });
   }
 
+  isLastReponseHeadersSet() {
+    return this.isLastResponseHeadersSet;
+  }
+
+  getLastResponseHeaders() {
+    return this.lastResponseHeaders;
+  }
+
+  setLastResponseHeaders(headers) {
+    this.lastResponseHeaders = headers;
+    this.isLastResponseHeadersSet = true;
+  }
+
   setBaseUrl(baseURL) {
     this.baseURL = baseURL;
     this.request.defaults.baseURL = `${baseURL}/${this.basePath}/`;
@@ -78,6 +95,7 @@ class RequestController {
         return Qs.stringify(params);
       }
     });
+    this.setLastResponseHeaders(response.headers);
     return response.data;
   }
 
@@ -89,6 +107,7 @@ class RequestController {
       },
       headers
     });
+    this.setLastResponseHeaders(response.headers);
     return response.data;
   }
 
@@ -96,6 +115,7 @@ class RequestController {
     const response = await this.request.put(path, body, {
       params
     });
+    this.setLastResponseHeaders(response.headers);
     return response.data;
   }
 
@@ -103,6 +123,7 @@ class RequestController {
     const response = await this.request.delete(path, {
       params
     });
+    this.setLastResponseHeaders(response.headers);
     return response.data;
   }
 
@@ -1307,6 +1328,36 @@ class Segments {
 
 }
 
+class ApiLimitsHandler {
+  constructor(requestController) {
+    this.requestController = void 0;
+    this.requestController = requestController;
+  }
+
+  getLastResponseHeadersFromController() {
+    return this.requestController.getLastResponseHeaders();
+  }
+
+  areLimitsAvailable() {
+    return this.requestController.isLastReponseHeadersSet();
+  }
+
+  getRateLimit() {
+    var _this$getLastResponse;
+
+    const rateLimit = (_this$getLastResponse = this.getLastResponseHeadersFromController()['x-rate-limit-limit']) != null ? _this$getLastResponse : 0;
+    return parseInt(rateLimit, 10);
+  }
+
+  getRateLimitRemaining() {
+    var _this$getLastResponse2;
+
+    const rateLimitRemaining = (_this$getLastResponse2 = this.getLastResponseHeadersFromController()['x-rate-limit-remaining']) != null ? _this$getLastResponse2 : 0;
+    return parseInt(rateLimitRemaining, 10);
+  }
+
+}
+
 // 	campaigns: Campaigns
 // 	consents: Consents
 // 	customers: Customers
@@ -1335,7 +1386,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.0.4"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.0.5"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1381,6 +1432,7 @@ function VoucherifyServerSide(options) {
   const loyalties = new Loyalties(client);
   const segments = new Segments(client);
   const validationRules = new ValidationRules(client);
+  const apiLimitsHandler = new ApiLimitsHandler(client);
   return {
     vouchers,
     campaigns,
@@ -1397,7 +1449,8 @@ function VoucherifyServerSide(options) {
     segments,
     validationRules,
     events,
-    asyncActions
+    asyncActions,
+    apiLimitsHandler
   };
 }
 
@@ -1580,7 +1633,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.0.4"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.0.5"}`
   };
 
   if (environment().startsWith('Node')) {