add api key and client api id to axios header (#1087)

Co-authored-by: Nathan Ballantyne <[email protected]>

Author: shineli1984

README.md

@@ -121,6 +121,22 @@ If you run out of memory, set NODE_OPTIONS to limit Node's use of memory (this a
 export NODE_OPTIONS=--max-old-space-size=14366
 ```
 
+### API keys and Client App Id
+
+API keys and Client App ID are used to authenticate and track usage respectively per partner/project/environment.
+
+Once created from hub, they can be optionally passed into base config as followed:
+
+```
+import { config } from '@imtbl/sdk';
+
+const baseConfig = new config.ImmutableConfiguration({
+  environment: config.Environment.PRODUCTION,
+  clientAppId: '....',
+  apiKey: '....',
+});
+```
+
 ### Linting
 
 #### ESLint Tooling

packages/config/src/index.ts

@@ -1,15 +1,41 @@
+import axios from 'axios';
+
 export enum Environment {
   PRODUCTION = 'production',
   SANDBOX = 'sandbox',
 }
 export class ImmutableConfiguration {
   readonly environment: Environment;
 
+  readonly rateLimitingKey?: string;
+
   readonly apiKey?: string;
 
-  constructor(options: { environment: Environment; apiKey?: string }) {
+  readonly clientAppId?: string;
+
+  constructor(options: { environment: Environment; rateLimitingKey?: string; apiKey?: string; clientAppId?: string }) {
     this.environment = options.environment;
-    this.apiKey = options.apiKey;
+
+    if (options.rateLimitingKey) {
+      this.rateLimitingKey = options.rateLimitingKey;
+      axios.defaults.headers.common['x-api-key'] = this.rateLimitingKey;
+    }
+
+    if (options.apiKey) {
+      if (!options.apiKey.startsWith('sk_imapik-')) {
+        throw new Error('Invalid API key');
+      }
+      this.apiKey = options.apiKey;
+      axios.defaults.headers.common['x-immutable-api-key'] = this.apiKey;
+    }
+
+    if (options.clientAppId) {
+      if (!options.clientAppId.startsWith('cai_imapik-')) {
+        throw new Error('Invalid Client App Id');
+      }
+      this.clientAppId = options.clientAppId;
+      axios.defaults.headers.common['x-immutable-client-app-id'] = this.clientAppId;
+    }
   }
 }