SMP-3191 | @token-io/core v1.0.25 (#417)

* SMP-3191 | @token-io/core v1.0.25

* SMP-3191 | @token-io/core v1.0.25

Author: JulesPatry

app/package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@token-io/core",
-    "version": "1.0.24",
+    "version": "1.0.25",
     "description": "Token JavaScript Core SDK",
     "license": "ISC",
     "author": {

core/package-lock.json

@@ -8,9 +8,11 @@ import CustomerTrackingMetadataHeader from './CustomerTrackingMetadataHeader';
 import DeveloperHeader from './DeveloperHeader';
 import VersionHeader from './VersionHeader';
 import stringify from 'fast-json-stable-stringify';
+import setAdditionalHeaders from './setAdditionalHeaders';
 
 /**
  * Client for making authenticated requests to the Token gateway.
+ * defaultHeaders argument is for passing in optional headers like https://developer.token.io/token_rest_api_doc/content/0_-_common/request-headers.htm 
  */
 export class AuthHttpClient {
     constructor({
@@ -22,6 +24,7 @@ export class AuthHttpClient {
         loggingEnabled,
         customSdkUrl,
         customResponseInterceptor,
+        defaultHeaders
     }) {
         if (!(config.urls[env] || customSdkUrl)) {
             throw new Error('Invalid environment string. Please use one of: ' +
@@ -41,7 +44,7 @@ export class AuthHttpClient {
         this._authHeader = new AuthHeader(customSdkUrl || config.urls[env], this);
 
         this._developerKey = developerKey;
-
+        this.defaultHeaders = defaultHeaders;
         this._resetRequestInterceptor();
 
         const errorHandler = new ErrorHandler(globalRpcErrorCallback);
@@ -625,6 +628,8 @@ export class AuthHttpClient {
             versionHeader.addVersionHeader(request);
             developerHeader.addDeveloperHeader(request);
             customerTrackingMetadataHeader.addCustomerTrackingMetadata(request, this._context);
+            setAdditionalHeaders(request, this.defaultHeaders);
+            
             return request;
         });
     }

core/package.json

@@ -2,7 +2,7 @@ import config from '../config.json';
 import ErrorHandler from './ErrorHandler';
 import DeveloperHeader from './DeveloperHeader';
 import VersionHeader from './VersionHeader';
-import AdditionalHeaders from './AdditionalHeaders';
+import setAdditionalHeaders from './setAdditionalHeaders';
 import Util from '../Util';
 import axios from 'axios';
 
@@ -29,14 +29,12 @@ export class HttpClient {
             Util.setUpHttpErrorLogging(this._instance);
         }
         Util.setUpCustomResponseInterceptor(this._instance, customResponseInterceptor);
-
         const versionHeader = new VersionHeader();
         const developerHeader = new DeveloperHeader(developerKey);
-        const additionalHeaders = new AdditionalHeaders();
         this._instance.interceptors.request.use(request => {
             versionHeader.addVersionHeader(request);
             developerHeader.addDeveloperHeader(request);
-            additionalHeaders.addAdditionalHeaders(request);
+            setAdditionalHeaders(request);
             return request;
         });
 
@@ -145,7 +143,7 @@ export class HttpClient {
         const request = {
             method: 'get',
             url: url,
-            additionalHeaders: headers
+            requestHeaders: headers
         };
         return this._instance(request);
     }

core/src/http/AdditionalHeaders.js

@@ -0,0 +1,11 @@
+export default function setAdditionalHeaders(config, defaultHeaders = {}) {
+  // defaultHeaders are set when the http client class is instantiated and applies to all requests 
+  if (defaultHeaders) {
+    config.headers = {...config.headers, ...defaultHeaders}
+  }
+
+  // requestHeaders are set when a method fires and applies to only one request
+  if (config.requestHeaders) {
+     config.headers = {...config.headers, ...config.requestHeaders}
+  }
+};

core/src/http/AuthHttpClient.js

@@ -25,6 +25,7 @@ export class TokenClient {
     ManualCryptoEngine: Class<MemoryCryptoEngine>;
     Util: Util;
     _unauthenticatedClient: HttpClient;
+    defaultHeaders: Object;
 
     constructor(options: {
         // Token environment to target, defaults to 'prd'
@@ -39,13 +40,16 @@ export class TokenClient {
         customSdkUrl?: string,
         // custom HTTP response interceptor for axios
         customResponseInterceptor?: Object,
+        // default headers passed into a authHttpClient
+        defaultHeaders?: Object
     } = {}) {
         this.options = options;
         this.options.developerKey = this.options.developerKey || config.devKey.default;
         this.KeyLevel = config.KeyLevel;
         this.Crypto = Crypto;
         this.MemoryCryptoEngine = MemoryCryptoEngine;
         this.ManualCryptoEngine = ManualCryptoEngine;
+        this.setDefaultHeaders(options.defaultHeaders);
     }
 
     /**
@@ -127,6 +131,7 @@ export class TokenClient {
                 memberId,
                 cryptoEngine: engine,
                 ...this.options,
+                defaultHeaders: this.getDefaultHeaders()
             });
         });
     }
@@ -181,4 +186,22 @@ export class TokenClient {
             return res.data.countries;
         });
     }
+
+    /**
+     * Sets default headers passed into authHttpClient
+     *
+     * @param defaultHeaders - object with string values passed into axios headers
+     */
+    setDefaultHeaders(defaultHeaders: Object) {
+      this.defaultHeaders = defaultHeaders || {};
+    }
+
+    /**
+     * Gets default headers passed into authHttpClient. Used to understand what default headers are existing
+     *
+     * @return object with string values
+     */
+    getDefaultHeaders() {
+      return this.defaultHeaders;
+    }
 }