@voucherify/sdk 2.1.6 → 2.1.7

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @voucherify/sdk
 
+## 2.1.7
+
+### Patch Changes
+
+- [`92ab4fb`](https://github.com/voucherifyio/voucherify-js-sdk/commit/92ab4fb3577332b60846536204c9d3cc6955b22b) [#188](https://github.com/voucherifyio/voucherify-js-sdk/pull/188) Thanks [@darekg11](https://github.com/darekg11)! - Add explicit properties to VoucherifyError class to make it easier for TypeScript folks. Added examples of proper error handling for both classical Node.JS and for TypeScript. Examples includes different handling for networking and API errors
+
+* [`48a46b9`](https://github.com/voucherifyio/voucherify-js-sdk/commit/48a46b9c3c3b64636fa8885919ca9311f2b497e5) [#190](https://github.com/voucherifyio/voucherify-js-sdk/pull/190) Thanks [@darekg11](https://github.com/darekg11)! - Add missing 'related_object_ids', 'related_object_type' and 'related_object_total' properties to 'VoucherifyError' class. Those properties are returned fmor API in case of 'resource_in_ise' error
+
 ## 2.1.6
 
 ### Patch Changes

package/README.md

@@ -1347,6 +1347,25 @@ You can find TS example in [examples/with-nodejs-typescript](/examples/with-node
 
 Voucherify `error` object always has consistent structure, described in details in our [API reference](https://docs.voucherify.io/reference/errors).
 
+If you wish to see code examples for server-side error handling, you can check it here:
+- [Error handling for Node.JS example without TypeScript](../../examples/sdk/with-nodejs/server-error-handling.js)
+- [Error handling for Node.JS example with TypeScript](../../examples/sdk//with-nodejs-typescript/server-error-handling.ts)
+
+Structure / typing for error returned from Voucherify API can be seen here:
+- [VoucherifyError class](src/VoucherifyError.ts)
+
+If you wish to receive original `AxiosError` when `VoucherifyError` is thrown then you need to explicitly set `exposeErrorCause` property to `true` when creating instance of `VouchierfyClient`, ie:
+
+```
+const voucherify = VoucherifyServerSide({
+	applicationId: 'APPLICATION-ID',
+	secretKey: 'SECRET-KEY',
+	exposeErrorCause: true
+})
+```
+
+Original `AxiosError` will be available under `cause` property of `VoucherifyError`
+
 # <a name="legacy"></a>👴 Legacy Voucherify JS SDKs
 
 Legacy client-side Voucherify JS SDK is available here: [voucherify.js](https://github.com/rspective/voucherify.js).

package/dist/RequestController.d.ts

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

package/dist/VoucherifyClientSide.d.ts

@@ -72,5 +72,11 @@ export interface VoucherifyClientSideOptions {
      * ```
      */
     customHeaders?: Record<string, string>;
+    /**
+     * If you wish to include original Axios error in VoucherifyError instance set this to true
+     * It can prove to be useful when debugging various scenarios.
+     * The original Axios error will be included in cause property of VoucherifyError
+     */
+    exposeErrorCause?: boolean;
 }
 export declare function VoucherifyClientSide(options: VoucherifyClientSideOptions): ClientSide;

package/dist/VoucherifyError.d.ts

@@ -1,6 +1,17 @@
+import { AxiosError } from 'axios';
 /**
  * @internal
  */
 export declare class VoucherifyError extends Error {
-    constructor(statusCode: number, body?: unknown);
+    code: number;
+    key: string;
+    details?: string;
+    request_id?: string;
+    resource_id?: string;
+    resource_type?: string;
+    related_object_ids?: string[];
+    related_object_type?: string;
+    related_object_total?: number;
+    cause?: AxiosError;
+    constructor(statusCode: number, body?: unknown, axiosError?: AxiosError);
 }

package/dist/VoucherifyServerSide.d.ts

@@ -92,6 +92,12 @@ export interface VoucherifyServerSideOptions {
      * ```
      */
     customHeaders?: Record<string, string>;
+    /**
+     * If you wish to include original Axios error in VoucherifyError instance set this to true
+     * It can prove to be useful when debugging various scenarios.
+     * The original Axios error will be included in cause property of VoucherifyError
+     */
+    exposeErrorCause?: boolean;
 }
 export declare function VoucherifyServerSide(options: VoucherifyServerSideOptions): {
     vouchers: Vouchers;

package/dist/voucherifysdk.esm.js

@@ -14,13 +14,32 @@ var DiscountVouchersTypesEnum;
  * @internal
  */
 class VoucherifyError extends Error {
-  constructor(statusCode, body) {
+  constructor(statusCode, body, axiosError) {
     var _body, _body2;
 
     body = (_body = body) != null ? _body : {};
     const message = ((_body2 = body) == null ? void 0 : _body2.message) || generateMessage(body, statusCode);
     super(message);
-    Object.assign(this, body);
+    this.code = void 0;
+    this.key = void 0;
+    this.details = void 0;
+    this.request_id = void 0;
+    this.resource_id = void 0;
+    this.resource_type = void 0;
+    this.related_object_ids = void 0;
+    this.related_object_type = void 0;
+    this.related_object_total = void 0;
+    this.cause = void 0;
+    this.code = body.code;
+    this.key = body.key;
+    this.details = body.details;
+    this.request_id = body.request_id;
+    this.resource_id = body.resource_id;
+    this.resource_type = body.resource_type;
+    this.related_object_ids = body.related_object_ids;
+    this.related_object_type = body.related_object_type;
+    this.related_object_total = body.related_object_total;
+    this.cause = axiosError;
   }
 
 }
@@ -38,7 +57,8 @@ class RequestController {
   constructor({
     basePath,
     baseURL,
-    headers
+    headers,
+    exposeErrorCause
   }) {
     this.baseURL = void 0;
     this.basePath = void 0;
@@ -46,9 +66,11 @@ class RequestController {
     this.request = void 0;
     this.lastResponseHeaders = void 0;
     this.isLastResponseHeadersSet = void 0;
+    this.exposeErrorCause = void 0;
     this.basePath = basePath;
     this.baseURL = baseURL;
     this.headers = headers;
+    this.exposeErrorCause = exposeErrorCause;
     this.lastResponseHeaders = {};
     this.isLastResponseHeadersSet = false;
     this.request = axios.create({
@@ -63,7 +85,7 @@ class RequestController {
        * Handle any HTTP response error (status code outside of 2xx) as a VoucherifyError
        */
       if (error != null && (_error$response = error.response) != null && _error$response.status) {
-        return Promise.reject(new VoucherifyError(error.response.status, error.response.data));
+        return Promise.reject(new VoucherifyError(error.response.status, error.response.data, this.exposeErrorCause === true ? error : undefined));
       }
 
       return Promise.reject(error);
@@ -1417,7 +1439,7 @@ class MetadataSchemas {
 // }
 
 function VoucherifyServerSide(options) {
-  var _options$apiUrl;
+  var _options$apiUrl, _options$exposeErrorC;
 
   assert(isObject(options), 'VoucherifyServerSide: the "options" argument must be an object');
   assert(isString(options.applicationId), 'VoucherifyServerSide: "options.applicationId" is required');
@@ -1427,7 +1449,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.1.6"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.1.7"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1452,7 +1474,8 @@ function VoucherifyServerSide(options) {
   const client = new RequestController({
     basePath: 'v1',
     baseURL: (_options$apiUrl = options.apiUrl) != null ? _options$apiUrl : 'https://api.voucherify.io',
-    headers
+    headers,
+    exposeErrorCause: (_options$exposeErrorC = options.exposeErrorCause) != null ? _options$exposeErrorC : false
   });
   const asyncActions = new AsyncActions(client);
   const balance = new Balance(client);
@@ -1666,7 +1689,7 @@ class ClientSide {
 }
 
 function VoucherifyClientSide(options) {
-  var _options$apiUrl;
+  var _options$apiUrl, _options$exposeErrorC;
 
   assert(isObject(options), 'VoucherifyCustomer: expected "options" argument to be an object');
   assert(isString(options.clientApplicationId), 'VoucherifyCustomer: "options.clientApplicationId" is required');
@@ -1676,7 +1699,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.1.6"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.1.7"}`
   };
 
   if (environment().startsWith('Node')) {
@@ -1691,7 +1714,8 @@ function VoucherifyClientSide(options) {
   const client = new RequestController({
     basePath: 'client/v1',
     baseURL: (_options$apiUrl = options.apiUrl) != null ? _options$apiUrl : 'https://api.voucherify.io',
-    headers
+    headers,
+    exposeErrorCause: (_options$exposeErrorC = options.exposeErrorCause) != null ? _options$exposeErrorC : false
   });
   return new ClientSide(client, options.trackingId);
 }