Merge pull request #140 from fireblocks/user-agent-version

User agent version

.github/workflows/node.js.yml

@@ -26,5 +26,7 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
+    - run: npm install -g npm@8
     - run: npm ci
     - run: npm run build --if-present
+    - run: npm pack

.github/workflows/publish-npm.yml

@@ -13,7 +13,7 @@ jobs:
           token: ${{ secrets.RELEASE_TOKEN }}
       - uses: actions/setup-node@v2
         with:
-          node-version: '12.x'
+          node-version: '16.x'
           registry-url: 'https://registry.npmjs.org'
       - run: npm install
       - run: |

README.md

@@ -41,8 +41,16 @@ const fireblocks = new FireblocksSDK(privateKey, apiKey, baseUrl, authProvider,
 The `options` argument has the following structure:
 ```typescript
 interface SDKOptions {
-    timeoutInMs?: number;               // HTTP request timeout
-    proxy?: AxiosProxyConfig | false;   // Proxy configuration
-    anonymousPlatform?: boolean;        // Whether to remove platform from User-Agent header
+    /** HTTP request timeout */
+    timeoutInMs?: number;
+
+    /** Proxy configurations */
+    proxy?: AxiosProxyConfig | false;
+
+    /** Whether to remove platform from User-Agent header */
+    anonymousPlatform?: boolean;
+
+    /** Additional product identifier to be prepended to the User-Agent header */
+    userAgent?: string;
 }
 ```

package.json

@@ -1,8 +1,8 @@
 {
   "name": "fireblocks-sdk",
   "version": "3.1.2",
-  "main": "dist/fireblocks-sdk.js",
-  "types": "dist/fireblocks-sdk.d.ts",
+  "main": "dist/src/fireblocks-sdk.js",
+  "types": "dist/src/fireblocks-sdk.d.ts",
   "scripts": {
     "build": "tsc && npm run tslint",
     "tslint": "tslint -c tslint.json -p tsconfig.json --fix",

src/api-client.ts

@@ -4,6 +4,7 @@ import { IAuthProvider } from "./iauth-provider";
 import { RequestOptions } from "./types";
 import { SDKOptions } from "./fireblocks-sdk";
 import axios, { AxiosInstance } from "axios";
+import { version as SDK_VERSION } from "../package.json";
 
 export class ApiClient {
     private axiosInstance: AxiosInstance;
@@ -21,10 +22,13 @@ export class ApiClient {
     }
 
     private getUserAgent(): string {
-        let userAgent = `fireblocks-sdk-js`;
+        let userAgent = `fireblocks-sdk-js/${SDK_VERSION}`;
         if (!this.options?.anonymousPlatform) {
             userAgent += ` (${os.type()} ${os.release()}; ${platform.name} ${platform.version}; ${os.arch()})`;
         }
+        if (this.options?.userAgent) {
+            userAgent = `${this.options.userAgent} ${userAgent}`;
+        }
         return userAgent;
     }
 

src/fireblocks-sdk.ts

@@ -73,9 +73,17 @@ import { AxiosProxyConfig } from "axios";
 export * from "./types";
 
 export interface SDKOptions {
+    /** HTTP request timeout */
     timeoutInMs?: number;
+
+    /** Proxy configurations */
     proxy?: AxiosProxyConfig | false;
+
+    /** Whether to remove platform from User-Agent header */
     anonymousPlatform?: boolean;
+
+    /** Additional product identifier to be prepended to the User-Agent header */
+    userAgent?: string;
 }
 
 export class FireblocksSDK {

tsconfig.json

@@ -8,7 +8,8 @@
         "declaration": true,
         "sourceMap": true,
         "outDir": "dist",
-        "baseUrl": "."
+        "baseUrl": ".",
+        "resolveJsonModule": true
     },
     "include": [
         "./src/**/*"