@openfin/cloud-interop-core-api 0.0.1-alpha.c459095 → 0.0.1-alpha.c4f1368

package/bundle.d.ts

@@ -364,7 +364,7 @@ export declare type ConnectParameters = {
         /**
          * When JWT authentication is being used, this will be invoked just whenever a JWT token is required for a request
          */
-        jwtRequestCallback: () => string | object;
+        jwtRequestCallback: () => string | object | Promise<string | object>;
         /**
          * The id of the service gateway JWT authentication definition to use
          *

package/index.cjs

@@ -53,11 +53,11 @@ class EventController {
 const isErrorIntentResult = (result) => 'error' in result;
 
 const APP_ID_DELIM = '::';
-const getRequestHeaders = (connectionParameters) => {
+const getRequestHeaders = async (connectionParameters) => {
     const headers = {};
     headers['Content-Type'] = 'application/json';
     if (connectionParameters.authenticationType === 'jwt' && connectionParameters.jwtAuthenticationParameters) {
-        const tokenResult = connectionParameters.jwtAuthenticationParameters.jwtRequestCallback();
+        const tokenResult = await connectionParameters.jwtAuthenticationParameters.jwtRequestCallback();
         if (!tokenResult) {
             throw new Error('jwtRequestCallback must return a token');
         }
@@ -162,7 +162,7 @@ class IntentController {
         try {
             const startResponse = await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}`, {
                 method: 'POST',
-                headers: getRequestHeaders(this.#connectionParams),
+                headers: await getRequestHeaders(this.#connectionParams),
                 body: JSON.stringify({ findOptions }),
             });
             if (!startResponse.ok) {
@@ -207,7 +207,7 @@ class IntentController {
         }
         await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/${this.#discovery.id}`, {
             method: 'DELETE',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
         })
             .then((deleteResponse) => {
             if (!deleteResponse.ok) {
@@ -228,7 +228,7 @@ class IntentController {
         }
         const postResponse = await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/sessions/${targetSessionId}`, {
             method: 'POST',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
             body: JSON.stringify({ raiseOptions }),
         });
         if (!postResponse.ok) {
@@ -242,7 +242,7 @@ class IntentController {
         try {
             const reportResponse = await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/${discoveryId}`, {
                 method: 'POST',
-                headers: getRequestHeaders(this.#connectionParams),
+                headers: await getRequestHeaders(this.#connectionParams),
                 body: JSON.stringify({ intents }),
             });
             if (reportResponse.ok) {
@@ -266,7 +266,7 @@ class IntentController {
         const { sessionId } = getSourceFromSession(this.#sessionDetails);
         const resultResponse = await fetch(`${this.#url}/api/intents/${initiatingSessionId}/result/${sessionId}`, {
             method: 'POST',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
             body: JSON.stringify({ result }),
         });
         if (!resultResponse.ok) {
@@ -350,6 +350,7 @@ class CloudInteropAPI {
     #reconnectRetryLimit = 30;
     #keepAliveIntervalSeconds = 30;
     #logger = (level, message) => {
+        // eslint-disable-next-line security/detect-object-injection -- level is restricted to the LogLevel union
         console[level](message);
     };
     #reconnectRetries = 0;
@@ -385,7 +386,7 @@ class CloudInteropAPI {
         const { sourceId, platformId } = this.#connectionParams;
         const createSessionResponse = await fetch(`${this.#cloudInteropSettings.url}/api/sessions`, {
             method: 'POST',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
             body: JSON.stringify({ sourceId: sourceId.trim(), platformId }),
         });
         if (!createSessionResponse.ok) {
@@ -423,6 +424,7 @@ class CloudInteropAPI {
         // TODO: Dynamic intent discovery
         // search for any ongoing discoveries in DB and fire report-intents on self
         this.#logger('log', `Cloud Interop successfully connected to ${this.#cloudInteropSettings.url}`);
+        // eslint-disable-next-line security-node/detect-unhandled-event-errors -- this callback handles MQTT error events
         this.#mqttClient.on('error', async (error) => {
             // We will receive errors for each failed reconnection attempt
             // We don't want to disconnect on these else we will never reconnect
@@ -515,7 +517,7 @@ class CloudInteropAPI {
         };
         const postResponse = await fetch(`${this.#cloudInteropSettings.url}/api/context-groups/${this.#sessionDetails.sessionId}/${contextGroup}`, {
             method: 'POST',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
             body: JSON.stringify(payload),
         });
         if (!postResponse.ok) {
@@ -575,7 +577,7 @@ class CloudInteropAPI {
             }
             const disconnectResponse = await fetch(`${this.#cloudInteropSettings.url}/api/sessions/${this.#sessionDetails.sessionId}`, {
                 method: 'DELETE',
-                headers: getRequestHeaders(this.#connectionParams),
+                headers: await getRequestHeaders(this.#connectionParams),
             });
             if (disconnectResponse.status !== 200) {
                 throw new CloudInteropAPIError('Error during session tear down - unexpected status', 'ERR_DISCONNECT', new Error(disconnectResponse.statusText));

package/index.mjs

@@ -51,11 +51,11 @@ class EventController {
 const isErrorIntentResult = (result) => 'error' in result;
 
 const APP_ID_DELIM = '::';
-const getRequestHeaders = (connectionParameters) => {
+const getRequestHeaders = async (connectionParameters) => {
     const headers = {};
     headers['Content-Type'] = 'application/json';
     if (connectionParameters.authenticationType === 'jwt' && connectionParameters.jwtAuthenticationParameters) {
-        const tokenResult = connectionParameters.jwtAuthenticationParameters.jwtRequestCallback();
+        const tokenResult = await connectionParameters.jwtAuthenticationParameters.jwtRequestCallback();
         if (!tokenResult) {
             throw new Error('jwtRequestCallback must return a token');
         }
@@ -160,7 +160,7 @@ class IntentController {
         try {
             const startResponse = await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}`, {
                 method: 'POST',
-                headers: getRequestHeaders(this.#connectionParams),
+                headers: await getRequestHeaders(this.#connectionParams),
                 body: JSON.stringify({ findOptions }),
             });
             if (!startResponse.ok) {
@@ -205,7 +205,7 @@ class IntentController {
         }
         await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/${this.#discovery.id}`, {
             method: 'DELETE',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
         })
             .then((deleteResponse) => {
             if (!deleteResponse.ok) {
@@ -226,7 +226,7 @@ class IntentController {
         }
         const postResponse = await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/sessions/${targetSessionId}`, {
             method: 'POST',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
             body: JSON.stringify({ raiseOptions }),
         });
         if (!postResponse.ok) {
@@ -240,7 +240,7 @@ class IntentController {
         try {
             const reportResponse = await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/${discoveryId}`, {
                 method: 'POST',
-                headers: getRequestHeaders(this.#connectionParams),
+                headers: await getRequestHeaders(this.#connectionParams),
                 body: JSON.stringify({ intents }),
             });
             if (reportResponse.ok) {
@@ -264,7 +264,7 @@ class IntentController {
         const { sessionId } = getSourceFromSession(this.#sessionDetails);
         const resultResponse = await fetch(`${this.#url}/api/intents/${initiatingSessionId}/result/${sessionId}`, {
             method: 'POST',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
             body: JSON.stringify({ result }),
         });
         if (!resultResponse.ok) {
@@ -348,6 +348,7 @@ class CloudInteropAPI {
     #reconnectRetryLimit = 30;
     #keepAliveIntervalSeconds = 30;
     #logger = (level, message) => {
+        // eslint-disable-next-line security/detect-object-injection -- level is restricted to the LogLevel union
         console[level](message);
     };
     #reconnectRetries = 0;
@@ -383,7 +384,7 @@ class CloudInteropAPI {
         const { sourceId, platformId } = this.#connectionParams;
         const createSessionResponse = await fetch(`${this.#cloudInteropSettings.url}/api/sessions`, {
             method: 'POST',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
             body: JSON.stringify({ sourceId: sourceId.trim(), platformId }),
         });
         if (!createSessionResponse.ok) {
@@ -421,6 +422,7 @@ class CloudInteropAPI {
         // TODO: Dynamic intent discovery
         // search for any ongoing discoveries in DB and fire report-intents on self
         this.#logger('log', `Cloud Interop successfully connected to ${this.#cloudInteropSettings.url}`);
+        // eslint-disable-next-line security-node/detect-unhandled-event-errors -- this callback handles MQTT error events
         this.#mqttClient.on('error', async (error) => {
             // We will receive errors for each failed reconnection attempt
             // We don't want to disconnect on these else we will never reconnect
@@ -513,7 +515,7 @@ class CloudInteropAPI {
         };
         const postResponse = await fetch(`${this.#cloudInteropSettings.url}/api/context-groups/${this.#sessionDetails.sessionId}/${contextGroup}`, {
             method: 'POST',
-            headers: getRequestHeaders(this.#connectionParams),
+            headers: await getRequestHeaders(this.#connectionParams),
             body: JSON.stringify(payload),
         });
         if (!postResponse.ok) {
@@ -573,7 +575,7 @@ class CloudInteropAPI {
             }
             const disconnectResponse = await fetch(`${this.#cloudInteropSettings.url}/api/sessions/${this.#sessionDetails.sessionId}`, {
                 method: 'DELETE',
-                headers: getRequestHeaders(this.#connectionParams),
+                headers: await getRequestHeaders(this.#connectionParams),
             });
             if (disconnectResponse.status !== 200) {
                 throw new CloudInteropAPIError('Error during session tear down - unexpected status', 'ERR_DISCONNECT', new Error(disconnectResponse.statusText));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfin/cloud-interop-core-api",
-  "version": "0.0.1-alpha.c459095",
+  "version": "0.0.1-alpha.c4f1368",
   "description": "",
   "type": "module",
   "main": "./index.cjs",
@@ -9,7 +9,7 @@
   "author": "support@here.io",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "mqtt": "^5.15.1",
+    "mqtt": "catalog:",
     "zod": "catalog:"
   }
 }