Add method for fetching Data Taps client token

Author: dforsber

.nvmrc

@@ -1 +1 @@
-v18.16
+v20

README.md

@@ -89,6 +89,14 @@ async function main() {
 }
 ```
 
+`getTapClientToken()` method can be used to fetch [Data Taps client token](https://www.taps.boilingdata.com/). You need fresh token when sending data to a Data Tap shared to you (or with your own Data Tap too). This API call does not require `connect()` method to be called as the request goes through via REST API rather than WebSocket API.
+
+```typescript
+const bdInstance = new BoilingData({ username: process.env["BD_USERNAME"], password: process.env["BD_PASSWORD"] });
+// first argument is token lifetime, max "24h", 2nd argument is the sharing user (unless your own Tap). Both arguments are optional.
+const tapClientToken = await bdInstance.getTapClientToken("24h", "[email protected]");
+```
+
 This repository contains JS/TS BoilingData client SDK that can be used both with NodeJS and in browser. Please see the integration tests on `tests/query.test.ts` for for more examples.
 
 ### Callbacks

browser/boilingdata.min.js

@@ -1,4 +1,4 @@
-import { BDCredentials, getBoilingDataCredentials } from "../common/identity";
+import { BDCredentials, getBoilingDataCredentials, getIdToken } from "../common/identity";
 import { EEngineTypes, EEvent, EMessageTypes, IBDDataQuery, IBDDataResponse } from "./boilingdata.api";
 import { v4 as uuidv4 } from "uuid";
 import WebSocket from "isomorphic-ws";
@@ -128,13 +128,31 @@ export function isDataResponse(data: IBDDataResponse | unknown): data is IBDData
   return (data as IBDDataResponse).messageType !== undefined && (data as IBDDataResponse).messageType === "DATA";
 }
 
+// FIXME: Make org specific
+export const apiKey = "Ak7itOEG1N1I7XpFfmYO97NWHRZwEYDmYBL4y0lb";
+
+export function getApiKey(): Promise<string> {
+  return Promise.resolve(apiKey); // FIXME: Get API key..
+}
+
+export async function getReqHeaders(token: string): Promise<{ [k: string]: string }> {
+  const apikey = await getApiKey();
+  return {
+    Authorization: token,
+    "x-api-key": apikey,
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  };
+}
+
 export class BoilingData {
   private region: BDAWSRegion;
   private creds?: BDCredentials;
   private socketInstance: ISocketInstance;
   private logger: Console;
   private closedPromise?: Promise<void>;
   private authcontext!: any;
+  private cognitoIdToken!: string;
 
   constructor(public props: IBoilingData) {
     this.logger = createLogger({ name: "boilingdata", logLevel: this.props.logLevel ?? "info" });
@@ -187,6 +205,32 @@ export class BoilingData {
     return this.authcontext;
   }
 
+  public async getTapClientToken(tokenLifetime = "12h", sharingUser?: string): Promise<string> {
+    if (this.authcontext?.idToken) {
+      this.cognitoIdToken = this.authcontext.idToken;
+    } else if (this.props.username && this.props.password) {
+      this.cognitoIdToken = (await getIdToken(this.props.username, this.props.password)).getJwtToken();
+    }
+    const headers = await getReqHeaders(this.cognitoIdToken); // , { tokenLifetime, vendingSchedule, shareId });
+    const method = "POST";
+    const tapTokenUrl = "https://rest.api.test.boilingdata.com/taptoken";
+    const body = JSON.stringify({ tokenLifetime, sharingUser });
+    this.logger.debug({ method, tapTokenUrl, headers, body });
+    const res = await fetch(tapTokenUrl, { method, headers, body });
+    const resBody = await res.json();
+    this.logger.debug({ getTapToken: { body: resBody } });
+    if (!resBody.ResponseCode || !resBody.ResponseText) {
+      throw new Error("Malformed response from BD API");
+    }
+    if (resBody.ResponseCode != "00") {
+      throw new Error(`Failed to fetch token: ${resBody.ResponseText}`);
+    }
+    if (!resBody.bdTapToken) {
+      throw new Error("Missing bdStsToken in BD API Response");
+    }
+    return resBody.bdTapToken;
+  }
+
   public async connect(): Promise<void> {
     return new Promise((resolve, reject) => {
       const sock = this.socketInstance;

src/boilingdata/boilingdata.ts

@@ -23,7 +23,12 @@ export interface BDCredentials {
   idToken: any;
 }
 
-function getIdToken(Username: string, Password: string, mfa?: number, logger?: Console): Promise<CognitoIdToken> {
+export function getIdToken(
+  Username: string,
+  Password: string,
+  mfa?: number,
+  logger?: Console,
+): Promise<CognitoIdToken> {
   return new Promise((resolve, reject) => {
     try {
       const loginDetails = { Username, Password };

src/common/identity.ts

@@ -0,0 +1,21 @@
+import { BoilingData } from "../boilingdata/boilingdata";
+
+const username = process.env["BD_USERNAME"];
+const password = process.env["BD_PASSWORD"];
+if (!password || !username) throw new Error("Set BD_USERNAME and BD_PASSWORD envs");
+
+describe("boilingdata with DuckDB", () => {
+  const bdInstance: BoilingData = new BoilingData({ username, password, region: "eu-west-1" });
+
+  it("can get client TapToken with default arguments", async () => {
+    const tapClientToken = await bdInstance.getTapClientToken();
+    console.log({ tapClientToken });
+    expect(tapClientToken.length).toBeGreaterThan(0);
+  });
+
+  it("can get client TapToken with default arguments", async () => {
+    const tapClientToken = await bdInstance.getTapClientToken("24h", "[email protected]");
+    console.log({ tapClientToken });
+    expect(tapClientToken.length).toBeGreaterThan(0);
+  });
+});