@openfin/cloud-interop-core-api 0.0.1-alpha.e8aa2c9 → 0.0.1-alpha.e8e2853

package/README.md

@@ -1,13 +1,13 @@
 # @openfin/cloud-interop-core-api
 
-This package contains the core interop library that handles all interactions with the Here™ Cloud Interop Service.
+This package contains the core interop library that handles all interactions with the HERE Cloud Interop Service.
 
 It is callable via browser or node applications.
 
 
 ## Authentication
 
-The library supports authentication with the Here™ Cloud Interop Service using the following methods:
+The library supports authentication with the HERE Cloud Interop Service using the following methods:
  - Basic Authentication
  - JWT Token Authentication
  - Default Authentication i.e. Interactive session based authentication using cookies

package/bundle.d.ts

@@ -51,7 +51,7 @@ declare const appIntentSchema: z.ZodObject<{
         name: string;
         displayName: string;
     }>;
-    apps: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
+    apps: z.ZodArray<z.ZodObject<{
         description: z.ZodOptional<z.ZodString>;
         icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
             size: z.ZodOptional<z.ZodString>;
@@ -88,10 +88,10 @@ declare const appIntentSchema: z.ZodObject<{
         title: z.ZodOptional<z.ZodString>;
         tooltip: z.ZodOptional<z.ZodString>;
         version: z.ZodOptional<z.ZodString>;
-    }, {
+    } & {
         appId: z.ZodString;
         instanceId: z.ZodOptional<z.ZodString>;
-    }>, "strip", z.ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         appId: string;
         instanceId?: string | undefined;
         description?: string | undefined;
@@ -245,36 +245,36 @@ export declare class CloudInteropAPI {
     /**
      * Connects and creates a session on the Cloud Interop service
      *
-     * @param {ConnectParameters} parameters - The parameters to use to connect
-     * @returns {*} {Promise<void>}
+     * @param parameters - The parameters to use to connect
+     * @returns Promise that resolves when connection is established
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during connection
-     * @throws {AuthorizationError} - If the connection is unauthorized
+     * @throws CloudInteropAPIError - If an error occurs during connection
+     * @throws AuthorizationError - If the connection is unauthorized
      */
     connect(parameters: ConnectParameters): Promise<void>;
     /**
      * Disconnects from the Cloud Interop service
      *
-     * @returns {*} {Promise<void>}
+     * @returns Promise that resolves when disconnected
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during disconnection
+     * @throws CloudInteropAPIError - If an error occurs during disconnection
      */
     disconnect(): Promise<void>;
     /**
      * Publishes a new context for the given context group to the other connected sessions
      *
-     * @param {string} contextGroup - The context group to publish to
-     * @param {object} context - The context to publish
-     * @returns {*} {Promise<void>}
+     * @param contextGroup - The context group to publish to
+     * @param context - The context to publish
+     * @returns Promise that resolves when context is published
      * @memberof CloudInteropAPI
      */
-    setContext(contextGroup: string, context: object): Promise<void>;
+    setContext(contextGroup: string, context: InferredContext): Promise<void>;
     /**
      * Starts an intent discovery operation
      *
-     * @returns {*} {Promise<void>}
+     * @returns Promise that resolves when intent discovery is started
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
+     * @throws CloudInteropAPIError - If an error occurs during intent discovery
      */
     startIntentDiscovery(options: StartIntentDiscoveryOptions): Promise<void>;
     raiseIntent(options: RaiseIntentAPIOptions): Promise<void>;
@@ -418,8 +418,17 @@ export declare type CreateSessionResponse = {
     sub: string;
     platformId: string;
     sourceId: string;
+    localSessionExpiryHandling?: boolean;
 };
 
+declare const errorSchema: z.ZodObject<{
+    error: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    error: string;
+}, {
+    error: string;
+}>;
+
 export declare type EventListenersMap = Map<keyof EventMap, Array<(...args: Parameters<EventMap[keyof EventMap]>) => void>>;
 
 export declare type EventMap = {
@@ -545,6 +554,8 @@ declare type HistoryRecord = {
  */
 export declare type InferredContext = z.infer<typeof contextSchema>;
 
+export declare type InferredError = z.infer<typeof errorSchema>;
+
 /**
  * @internal
  */

package/index.cjs

@@ -3,6 +3,8 @@
 var buffer = require('buffer');
 var mqtt = require('mqtt');
 
+var l=t=>{let e=t.replaceAll("-","+").replaceAll("_","/");return e.padEnd(e.length+(4-e.length%4)%4,"=")};
+
 class CloudInteropAPIError extends Error {
     code;
     constructor(message = 'An unexpected error has occurred', code = 'UNEXPECTED_ERROR', cause) {
@@ -46,6 +48,8 @@ class EventController {
     }
 }
 
+const isErrorIntentResult = (result) => 'error' in result;
+
 const APP_ID_DELIM = '::';
 const getRequestHeaders = (connectionParameters) => {
     const headers = {};
@@ -72,13 +76,9 @@ const getRequestHeaders = (connectionParameters) => {
  * @param source
  * @returns
  */
-const encodeAppIntents = (appIntents, { sessionId, sourceId }) => appIntents.map((intent) => ({
+const encodeAppIntents = (appIntents, source) => appIntents.map((intent) => ({
     ...intent,
-    apps: intent.apps.map((app) => {
-        const id = encodeURIComponent(app.appId);
-        const sId = encodeURIComponent(sourceId);
-        return { ...app, appId: `${id}${APP_ID_DELIM}${sId}${APP_ID_DELIM}${sessionId}` };
-    }),
+    apps: intent.apps.map((app) => ({ ...app, appId: encodeAppId(app.appId, source) })),
 }));
 /**
  * Decodes all app intents by URI decoding the parts previously encoded by `encodeAppIntents`
@@ -87,13 +87,19 @@ const encodeAppIntents = (appIntents, { sessionId, sourceId }) => appIntents.map
  */
 const decodeAppIntents = (appIntents) => appIntents.map((intent) => ({
     ...intent,
-    apps: intent.apps.map((app) => {
-        const [encodedAppId, encodedSourceId, sessionId] = app.appId.split(APP_ID_DELIM);
-        const id = decodeURIComponent(encodedAppId);
-        const sourceId = decodeURIComponent(encodedSourceId);
-        return { ...app, appId: `${id}${APP_ID_DELIM}${sourceId}${APP_ID_DELIM}${sessionId}` };
-    }),
+    apps: intent.apps.map((app) => ({ ...app, appId: decodeAppId(app.appId) })),
 }));
+const encodeAppId = (appIdString, { sessionId, sourceId }) => {
+    const id = encodeURIComponent(appIdString);
+    const sId = encodeURIComponent(sourceId);
+    return `${id}${APP_ID_DELIM}${sId}${APP_ID_DELIM}${sessionId}`;
+};
+const decodeAppId = (appId) => {
+    const [encodedAppId, encodedSourceId, sessionId] = appId.split(APP_ID_DELIM);
+    const id = decodeURIComponent(encodedAppId);
+    const sourceId = decodeURIComponent(encodedSourceId);
+    return `${id}${APP_ID_DELIM}${sourceId}${APP_ID_DELIM}${sessionId}`;
+};
 /**
  * Decodes the AppIdentifier to extract the appId, sourceId, and sessionId.
  * @returns an object with:
@@ -158,13 +164,18 @@ class IntentController {
                 body: JSON.stringify({ findOptions }),
             });
             if (!startResponse.ok) {
-                throw new Error(startResponse.statusText);
+                throw new Error(`Error creating intent discovery record: ${startResponse.statusText}`);
             }
             // TODO: type this response?
             const json = await startResponse.json();
             this.#discovery.id = json.discoveryId;
             this.#discovery.sessionCount = json.sessionCount;
             this.#discovery.state = 'in-progress';
+            if (this.#discovery.sessionCount === 1) {
+                // since we have no other connected sessions, we can end discovery immediately
+                await this.#endIntentDiscovery(false);
+                return;
+            }
             // Listen out for discovery results directly sent to us
             await this.#mqttClient.subscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`);
             this.#discoveryTimeout = setTimeout(() => this.#endIntentDiscovery(), clampedTimeout);
@@ -175,10 +186,8 @@ class IntentController {
             throw new CloudInteropAPIError('Error starting intent discovery', 'ERR_STARTING_INTENT_DISCOVERY', error);
         }
     }
-    async #endIntentDiscovery() {
+    async #endIntentDiscovery(mqttUnsubscribe = true) {
         if (this.#discovery.state !== 'in-progress') {
-            // TODO: remove debug logs
-            this.#logger('debug', 'Intent discovery not in progress');
             return;
         }
         if (this.#discoveryTimeout) {
@@ -188,10 +197,12 @@ class IntentController {
         this.#discovery.state = 'ended';
         // emit our aggregated events
         this.#events.emitEvent('aggregate-intent-details', { responses: this.#discovery.pendingIntentDetailsEvents });
-        // gracefully end discovery
-        await this.#mqttClient.unsubscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`).catch(() => {
-            this.#logger('warn', `Error ending intent discovery: could not unsubscribe from discovery id ${this.#discovery.id}`);
-        });
+        if (mqttUnsubscribe) {
+            // gracefully end discovery
+            await this.#mqttClient.unsubscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`).catch(() => {
+                this.#logger('warn', `Error ending intent discovery: could not unsubscribe from discovery id ${this.#discovery.id}`);
+            });
+        }
         await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/${this.#discovery.id}`, {
             method: 'DELETE',
             headers: getRequestHeaders(this.#connectionParams),
@@ -200,7 +211,6 @@ class IntentController {
             if (!deleteResponse.ok) {
                 throw new Error(`Error ending intent discovery: ${deleteResponse.statusText}`);
             }
-            this.#logger('debug', 'Intent discovery ended');
         })
             .catch((error) => {
             this.#logger('warn', `Error ending intent discovery: ${error}`);
@@ -244,6 +254,13 @@ class IntentController {
         return false;
     }
     async sendIntentResult(initiatingSessionId, result) {
+        if (!isErrorIntentResult(result)) {
+            // cloud-encode the source app id to support chained intent actions over cloud
+            // https://fdc3.finos.org/docs/2.0/api/spec#resolution-object -> "Use metadata about the resolving app instance to target a further intent"
+            const source = getSourceFromSession(this.#sessionDetails);
+            const encoded = encodeAppId(typeof result.source === 'string' ? result.source : result.source.appId, source);
+            result.source = typeof result.source === 'string' ? encoded : { ...result.source, appId: encoded };
+        }
         const { sessionId } = getSourceFromSession(this.#sessionDetails);
         const resultResponse = await fetch(`${this.#url}/api/intents/${initiatingSessionId}/result/${sessionId}`, {
             method: 'POST',
@@ -338,6 +355,7 @@ class CloudInteropAPI {
     #attemptingToReconnect = false;
     #events = new EventController();
     #intents;
+    #sessionTimer;
     constructor(cloudInteropSettings) {
         this.#cloudInteropSettings = cloudInteropSettings;
     }
@@ -350,11 +368,11 @@ class CloudInteropAPI {
     /**
      * Connects and creates a session on the Cloud Interop service
      *
-     * @param {ConnectParameters} parameters - The parameters to use to connect
-     * @returns {*} {Promise<void>}
+     * @param parameters - The parameters to use to connect
+     * @returns Promise that resolves when connection is established
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during connection
-     * @throws {AuthorizationError} - If the connection is unauthorized
+     * @throws CloudInteropAPIError - If an error occurs during connection
+     * @throws AuthorizationError - If the connection is unauthorized
      */
     async connect(parameters) {
         this.#validateConnectParams(parameters);
@@ -378,6 +396,11 @@ class CloudInteropAPI {
             throw new CloudInteropAPIError(`Failed to connect to the Cloud Interop service: ${this.#cloudInteropSettings.url}`, 'ERR_CONNECT', new Error(createSessionResponse.statusText));
         }
         this.#sessionDetails = (await createSessionResponse.json());
+        // If local session expiry handling is enabled, start the session timer
+        if (this.#sessionDetails.localSessionExpiryHandling) {
+            this.#logger('debug', `Local session expiry handling is enabled`);
+            this.#startSessionTimer();
+        }
         const sessionRootTopic = this.#sessionDetails.sessionRootTopic;
         const clientOptions = {
             keepalive: this.#keepAliveIntervalSeconds,
@@ -407,9 +430,7 @@ class CloudInteropAPI {
             if (error instanceof mqtt.ErrorWithReasonCode) {
                 switch (error.code) {
                     case BadUserNamePasswordError: {
-                        await this.#disconnect(false);
-                        this.#logger('warn', `Session expired`);
-                        this.#events.emitEvent('session-expired');
+                        this.#handleSessionExpiry();
                         return;
                     }
                     default: {
@@ -463,9 +484,9 @@ class CloudInteropAPI {
     /**
      * Disconnects from the Cloud Interop service
      *
-     * @returns {*} {Promise<void>}
+     * @returns Promise that resolves when disconnected
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during disconnection
+     * @throws CloudInteropAPIError - If an error occurs during disconnection
      */
     async disconnect() {
         await this.#disconnect(true);
@@ -473,9 +494,9 @@ class CloudInteropAPI {
     /**
      * Publishes a new context for the given context group to the other connected sessions
      *
-     * @param {string} contextGroup - The context group to publish to
-     * @param {object} context - The context to publish
-     * @returns {*} {Promise<void>}
+     * @param contextGroup - The context group to publish to
+     * @param context - The context to publish
+     * @returns Promise that resolves when context is published
      * @memberof CloudInteropAPI
      */
     async setContext(contextGroup, context) {
@@ -502,9 +523,9 @@ class CloudInteropAPI {
     /**
      * Starts an intent discovery operation
      *
-     * @returns {*} {Promise<void>}
+     * @returns Promise that resolves when intent discovery is started
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
+     * @throws CloudInteropAPIError - If an error occurs during intent discovery
      */
     async startIntentDiscovery(options) {
         this.#throwIfNotConnected();
@@ -545,6 +566,11 @@ class CloudInteropAPI {
             if (!this.#connectionParams) {
                 throw new Error('Connect parameters must be provided');
             }
+            // Cancel session timer if it's running
+            if (this.#sessionTimer) {
+                clearTimeout(this.#sessionTimer);
+                this.#sessionTimer = undefined;
+            }
             const disconnectResponse = await fetch(`${this.#cloudInteropSettings.url}/api/sessions/${this.#sessionDetails.sessionId}`, {
                 method: 'DELETE',
                 headers: getRequestHeaders(this.#connectionParams),
@@ -580,8 +606,13 @@ class CloudInteropAPI {
             if (contextEvent.source.sessionId === sessionDetails.sessionId) {
                 return;
             }
-            const { contextGroup, context, source, history } = contextEvent;
-            this.#events.emitEvent('context', { contextGroup, context, source, history: { ...history, clientReceived: Date.now() } });
+            const { context, payload, contextGroup, channelName, source, history } = contextEvent;
+            this.#events.emitEvent('context', {
+                contextGroup: channelName || contextGroup,
+                context: payload || context,
+                source,
+                history: { ...history, clientReceived: Date.now() },
+            });
         }
         else if (topic.startsWith(`${sessionDetails.sessionRootTopic}/commands`)) {
             this.#handleCommandMessage(messageEnvelope);
@@ -638,6 +669,88 @@ class CloudInteropAPI {
             throw new Error('MQTT client not connected');
         }
     }
+    /**
+     * Extracts the expiration timestamp from a JWT token.
+     *
+     * @param token - The JWT token string
+     * @returns The expiration timestamp in seconds, or null if extraction fails
+     */
+    #extractExpirationFromJwt(token) {
+        try {
+            // JWT tokens have three parts separated by dots: header.payload.signature
+            // The exp claim is in the payload
+            const parts = token.split('.');
+            if (parts.length < 2) {
+                this.#logger('warn', 'Invalid JWT token format: expected at least 2 parts');
+                return null;
+            }
+            const payload = parts[1];
+            // Decode base64url encoded payload
+            const decodedBytes = buffer.Buffer.from(l(payload), 'base64');
+            const payloadJson = decodedBytes.toString('utf8');
+            // Parse JSON to get the exp claim
+            const claims = JSON.parse(payloadJson);
+            const exp = claims.exp;
+            if (exp === undefined || exp === null) {
+                this.#logger('warn', "JWT token does not contain 'exp' claim");
+                return null;
+            }
+            if (typeof exp !== 'number') {
+                this.#logger('warn', `JWT token 'exp' claim is not a number: ${exp}`);
+                return null;
+            }
+            return exp;
+        }
+        catch (error) {
+            this.#logger('error', `Failed to extract expiration from JWT token: ${error instanceof Error ? error.message : error}`);
+            return null;
+        }
+    }
+    /**
+     * Start a session timer that will expire at the time specified in the JWT token's exp claim.
+     * When the timer fires, it executes the same actions as the BadUserNamePasswordError case.
+     */
+    #startSessionTimer() {
+        if (!this.#sessionDetails?.localSessionExpiryHandling) {
+            return;
+        }
+        const token = this.#sessionDetails.token;
+        if (!token) {
+            this.#logger('warn', 'Cannot start session timer: token not available');
+            return;
+        }
+        // Extract expiration time from JWT token
+        const expTimestamp = this.#extractExpirationFromJwt(token);
+        if (expTimestamp === null) {
+            this.#logger('warn', 'Cannot start session timer: could not extract expiration from JWT token');
+            return;
+        }
+        const currentTimeSeconds = Math.floor(Date.now() / 1000);
+        const delaySeconds = expTimestamp - currentTimeSeconds;
+        if (delaySeconds <= 0) {
+            this.#logger('warn', 'JWT token has already expired or expires immediately');
+            // Execute the same actions as BadUserNamePasswordError case
+            this.#handleSessionExpiry();
+            return;
+        }
+        // Clear any existing timer
+        if (this.#sessionTimer) {
+            clearTimeout(this.#sessionTimer);
+        }
+        const expirationTimeString = new Date(expTimestamp * 1000).toISOString();
+        this.#logger('debug', `Starting session timer to expire in ${delaySeconds} seconds (at ${expirationTimeString})`);
+        this.#sessionTimer = setTimeout(async () => {
+            this.#handleSessionExpiry();
+        }, delaySeconds * 1000);
+    }
+    /**
+     * Handles session expiry by executing the same actions as the BadUserNamePasswordError case.
+     */
+    async #handleSessionExpiry() {
+        await this.#disconnect(false);
+        this.#logger('warn', 'Session expired');
+        this.#events.emitEvent('session-expired');
+    }
 }
 
 exports.AuthorizationError = AuthorizationError;

package/index.mjs

@@ -1,6 +1,8 @@
 import { Buffer } from 'buffer';
 import mqtt from 'mqtt';
 
+var l=t=>{let e=t.replaceAll("-","+").replaceAll("_","/");return e.padEnd(e.length+(4-e.length%4)%4,"=")};
+
 class CloudInteropAPIError extends Error {
     code;
     constructor(message = 'An unexpected error has occurred', code = 'UNEXPECTED_ERROR', cause) {
@@ -44,6 +46,8 @@ class EventController {
     }
 }
 
+const isErrorIntentResult = (result) => 'error' in result;
+
 const APP_ID_DELIM = '::';
 const getRequestHeaders = (connectionParameters) => {
     const headers = {};
@@ -70,13 +74,9 @@ const getRequestHeaders = (connectionParameters) => {
  * @param source
  * @returns
  */
-const encodeAppIntents = (appIntents, { sessionId, sourceId }) => appIntents.map((intent) => ({
+const encodeAppIntents = (appIntents, source) => appIntents.map((intent) => ({
     ...intent,
-    apps: intent.apps.map((app) => {
-        const id = encodeURIComponent(app.appId);
-        const sId = encodeURIComponent(sourceId);
-        return { ...app, appId: `${id}${APP_ID_DELIM}${sId}${APP_ID_DELIM}${sessionId}` };
-    }),
+    apps: intent.apps.map((app) => ({ ...app, appId: encodeAppId(app.appId, source) })),
 }));
 /**
  * Decodes all app intents by URI decoding the parts previously encoded by `encodeAppIntents`
@@ -85,13 +85,19 @@ const encodeAppIntents = (appIntents, { sessionId, sourceId }) => appIntents.map
  */
 const decodeAppIntents = (appIntents) => appIntents.map((intent) => ({
     ...intent,
-    apps: intent.apps.map((app) => {
-        const [encodedAppId, encodedSourceId, sessionId] = app.appId.split(APP_ID_DELIM);
-        const id = decodeURIComponent(encodedAppId);
-        const sourceId = decodeURIComponent(encodedSourceId);
-        return { ...app, appId: `${id}${APP_ID_DELIM}${sourceId}${APP_ID_DELIM}${sessionId}` };
-    }),
+    apps: intent.apps.map((app) => ({ ...app, appId: decodeAppId(app.appId) })),
 }));
+const encodeAppId = (appIdString, { sessionId, sourceId }) => {
+    const id = encodeURIComponent(appIdString);
+    const sId = encodeURIComponent(sourceId);
+    return `${id}${APP_ID_DELIM}${sId}${APP_ID_DELIM}${sessionId}`;
+};
+const decodeAppId = (appId) => {
+    const [encodedAppId, encodedSourceId, sessionId] = appId.split(APP_ID_DELIM);
+    const id = decodeURIComponent(encodedAppId);
+    const sourceId = decodeURIComponent(encodedSourceId);
+    return `${id}${APP_ID_DELIM}${sourceId}${APP_ID_DELIM}${sessionId}`;
+};
 /**
  * Decodes the AppIdentifier to extract the appId, sourceId, and sessionId.
  * @returns an object with:
@@ -156,13 +162,18 @@ class IntentController {
                 body: JSON.stringify({ findOptions }),
             });
             if (!startResponse.ok) {
-                throw new Error(startResponse.statusText);
+                throw new Error(`Error creating intent discovery record: ${startResponse.statusText}`);
             }
             // TODO: type this response?
             const json = await startResponse.json();
             this.#discovery.id = json.discoveryId;
             this.#discovery.sessionCount = json.sessionCount;
             this.#discovery.state = 'in-progress';
+            if (this.#discovery.sessionCount === 1) {
+                // since we have no other connected sessions, we can end discovery immediately
+                await this.#endIntentDiscovery(false);
+                return;
+            }
             // Listen out for discovery results directly sent to us
             await this.#mqttClient.subscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`);
             this.#discoveryTimeout = setTimeout(() => this.#endIntentDiscovery(), clampedTimeout);
@@ -173,10 +184,8 @@ class IntentController {
             throw new CloudInteropAPIError('Error starting intent discovery', 'ERR_STARTING_INTENT_DISCOVERY', error);
         }
     }
-    async #endIntentDiscovery() {
+    async #endIntentDiscovery(mqttUnsubscribe = true) {
         if (this.#discovery.state !== 'in-progress') {
-            // TODO: remove debug logs
-            this.#logger('debug', 'Intent discovery not in progress');
             return;
         }
         if (this.#discoveryTimeout) {
@@ -186,10 +195,12 @@ class IntentController {
         this.#discovery.state = 'ended';
         // emit our aggregated events
         this.#events.emitEvent('aggregate-intent-details', { responses: this.#discovery.pendingIntentDetailsEvents });
-        // gracefully end discovery
-        await this.#mqttClient.unsubscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`).catch(() => {
-            this.#logger('warn', `Error ending intent discovery: could not unsubscribe from discovery id ${this.#discovery.id}`);
-        });
+        if (mqttUnsubscribe) {
+            // gracefully end discovery
+            await this.#mqttClient.unsubscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`).catch(() => {
+                this.#logger('warn', `Error ending intent discovery: could not unsubscribe from discovery id ${this.#discovery.id}`);
+            });
+        }
         await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/${this.#discovery.id}`, {
             method: 'DELETE',
             headers: getRequestHeaders(this.#connectionParams),
@@ -198,7 +209,6 @@ class IntentController {
             if (!deleteResponse.ok) {
                 throw new Error(`Error ending intent discovery: ${deleteResponse.statusText}`);
             }
-            this.#logger('debug', 'Intent discovery ended');
         })
             .catch((error) => {
             this.#logger('warn', `Error ending intent discovery: ${error}`);
@@ -242,6 +252,13 @@ class IntentController {
         return false;
     }
     async sendIntentResult(initiatingSessionId, result) {
+        if (!isErrorIntentResult(result)) {
+            // cloud-encode the source app id to support chained intent actions over cloud
+            // https://fdc3.finos.org/docs/2.0/api/spec#resolution-object -> "Use metadata about the resolving app instance to target a further intent"
+            const source = getSourceFromSession(this.#sessionDetails);
+            const encoded = encodeAppId(typeof result.source === 'string' ? result.source : result.source.appId, source);
+            result.source = typeof result.source === 'string' ? encoded : { ...result.source, appId: encoded };
+        }
         const { sessionId } = getSourceFromSession(this.#sessionDetails);
         const resultResponse = await fetch(`${this.#url}/api/intents/${initiatingSessionId}/result/${sessionId}`, {
             method: 'POST',
@@ -336,6 +353,7 @@ class CloudInteropAPI {
     #attemptingToReconnect = false;
     #events = new EventController();
     #intents;
+    #sessionTimer;
     constructor(cloudInteropSettings) {
         this.#cloudInteropSettings = cloudInteropSettings;
     }
@@ -348,11 +366,11 @@ class CloudInteropAPI {
     /**
      * Connects and creates a session on the Cloud Interop service
      *
-     * @param {ConnectParameters} parameters - The parameters to use to connect
-     * @returns {*} {Promise<void>}
+     * @param parameters - The parameters to use to connect
+     * @returns Promise that resolves when connection is established
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during connection
-     * @throws {AuthorizationError} - If the connection is unauthorized
+     * @throws CloudInteropAPIError - If an error occurs during connection
+     * @throws AuthorizationError - If the connection is unauthorized
      */
     async connect(parameters) {
         this.#validateConnectParams(parameters);
@@ -376,6 +394,11 @@ class CloudInteropAPI {
             throw new CloudInteropAPIError(`Failed to connect to the Cloud Interop service: ${this.#cloudInteropSettings.url}`, 'ERR_CONNECT', new Error(createSessionResponse.statusText));
         }
         this.#sessionDetails = (await createSessionResponse.json());
+        // If local session expiry handling is enabled, start the session timer
+        if (this.#sessionDetails.localSessionExpiryHandling) {
+            this.#logger('debug', `Local session expiry handling is enabled`);
+            this.#startSessionTimer();
+        }
         const sessionRootTopic = this.#sessionDetails.sessionRootTopic;
         const clientOptions = {
             keepalive: this.#keepAliveIntervalSeconds,
@@ -405,9 +428,7 @@ class CloudInteropAPI {
             if (error instanceof mqtt.ErrorWithReasonCode) {
                 switch (error.code) {
                     case BadUserNamePasswordError: {
-                        await this.#disconnect(false);
-                        this.#logger('warn', `Session expired`);
-                        this.#events.emitEvent('session-expired');
+                        this.#handleSessionExpiry();
                         return;
                     }
                     default: {
@@ -461,9 +482,9 @@ class CloudInteropAPI {
     /**
      * Disconnects from the Cloud Interop service
      *
-     * @returns {*} {Promise<void>}
+     * @returns Promise that resolves when disconnected
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during disconnection
+     * @throws CloudInteropAPIError - If an error occurs during disconnection
      */
     async disconnect() {
         await this.#disconnect(true);
@@ -471,9 +492,9 @@ class CloudInteropAPI {
     /**
      * Publishes a new context for the given context group to the other connected sessions
      *
-     * @param {string} contextGroup - The context group to publish to
-     * @param {object} context - The context to publish
-     * @returns {*} {Promise<void>}
+     * @param contextGroup - The context group to publish to
+     * @param context - The context to publish
+     * @returns Promise that resolves when context is published
      * @memberof CloudInteropAPI
      */
     async setContext(contextGroup, context) {
@@ -500,9 +521,9 @@ class CloudInteropAPI {
     /**
      * Starts an intent discovery operation
      *
-     * @returns {*} {Promise<void>}
+     * @returns Promise that resolves when intent discovery is started
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
+     * @throws CloudInteropAPIError - If an error occurs during intent discovery
      */
     async startIntentDiscovery(options) {
         this.#throwIfNotConnected();
@@ -543,6 +564,11 @@ class CloudInteropAPI {
             if (!this.#connectionParams) {
                 throw new Error('Connect parameters must be provided');
             }
+            // Cancel session timer if it's running
+            if (this.#sessionTimer) {
+                clearTimeout(this.#sessionTimer);
+                this.#sessionTimer = undefined;
+            }
             const disconnectResponse = await fetch(`${this.#cloudInteropSettings.url}/api/sessions/${this.#sessionDetails.sessionId}`, {
                 method: 'DELETE',
                 headers: getRequestHeaders(this.#connectionParams),
@@ -578,8 +604,13 @@ class CloudInteropAPI {
             if (contextEvent.source.sessionId === sessionDetails.sessionId) {
                 return;
             }
-            const { contextGroup, context, source, history } = contextEvent;
-            this.#events.emitEvent('context', { contextGroup, context, source, history: { ...history, clientReceived: Date.now() } });
+            const { context, payload, contextGroup, channelName, source, history } = contextEvent;
+            this.#events.emitEvent('context', {
+                contextGroup: channelName || contextGroup,
+                context: payload || context,
+                source,
+                history: { ...history, clientReceived: Date.now() },
+            });
         }
         else if (topic.startsWith(`${sessionDetails.sessionRootTopic}/commands`)) {
             this.#handleCommandMessage(messageEnvelope);
@@ -636,6 +667,88 @@ class CloudInteropAPI {
             throw new Error('MQTT client not connected');
         }
     }
+    /**
+     * Extracts the expiration timestamp from a JWT token.
+     *
+     * @param token - The JWT token string
+     * @returns The expiration timestamp in seconds, or null if extraction fails
+     */
+    #extractExpirationFromJwt(token) {
+        try {
+            // JWT tokens have three parts separated by dots: header.payload.signature
+            // The exp claim is in the payload
+            const parts = token.split('.');
+            if (parts.length < 2) {
+                this.#logger('warn', 'Invalid JWT token format: expected at least 2 parts');
+                return null;
+            }
+            const payload = parts[1];
+            // Decode base64url encoded payload
+            const decodedBytes = Buffer.from(l(payload), 'base64');
+            const payloadJson = decodedBytes.toString('utf8');
+            // Parse JSON to get the exp claim
+            const claims = JSON.parse(payloadJson);
+            const exp = claims.exp;
+            if (exp === undefined || exp === null) {
+                this.#logger('warn', "JWT token does not contain 'exp' claim");
+                return null;
+            }
+            if (typeof exp !== 'number') {
+                this.#logger('warn', `JWT token 'exp' claim is not a number: ${exp}`);
+                return null;
+            }
+            return exp;
+        }
+        catch (error) {
+            this.#logger('error', `Failed to extract expiration from JWT token: ${error instanceof Error ? error.message : error}`);
+            return null;
+        }
+    }
+    /**
+     * Start a session timer that will expire at the time specified in the JWT token's exp claim.
+     * When the timer fires, it executes the same actions as the BadUserNamePasswordError case.
+     */
+    #startSessionTimer() {
+        if (!this.#sessionDetails?.localSessionExpiryHandling) {
+            return;
+        }
+        const token = this.#sessionDetails.token;
+        if (!token) {
+            this.#logger('warn', 'Cannot start session timer: token not available');
+            return;
+        }
+        // Extract expiration time from JWT token
+        const expTimestamp = this.#extractExpirationFromJwt(token);
+        if (expTimestamp === null) {
+            this.#logger('warn', 'Cannot start session timer: could not extract expiration from JWT token');
+            return;
+        }
+        const currentTimeSeconds = Math.floor(Date.now() / 1000);
+        const delaySeconds = expTimestamp - currentTimeSeconds;
+        if (delaySeconds <= 0) {
+            this.#logger('warn', 'JWT token has already expired or expires immediately');
+            // Execute the same actions as BadUserNamePasswordError case
+            this.#handleSessionExpiry();
+            return;
+        }
+        // Clear any existing timer
+        if (this.#sessionTimer) {
+            clearTimeout(this.#sessionTimer);
+        }
+        const expirationTimeString = new Date(expTimestamp * 1000).toISOString();
+        this.#logger('debug', `Starting session timer to expire in ${delaySeconds} seconds (at ${expirationTimeString})`);
+        this.#sessionTimer = setTimeout(async () => {
+            this.#handleSessionExpiry();
+        }, delaySeconds * 1000);
+    }
+    /**
+     * Handles session expiry by executing the same actions as the BadUserNamePasswordError case.
+     */
+    async #handleSessionExpiry() {
+        await this.#disconnect(false);
+        this.#logger('warn', 'Session expired');
+        this.#events.emitEvent('session-expired');
+    }
 }
 
 export { AuthorizationError, CloudInteropAPI, CloudInteropAPIError };

package/package.json

@@ -1,18 +1,15 @@
 {
   "name": "@openfin/cloud-interop-core-api",
-  "version": "0.0.1-alpha.e8aa2c9",
-  "type": "module",
+  "version": "0.0.1-alpha.e8e2853",
   "description": "",
+  "type": "module",
   "main": "./index.cjs",
   "browser": "./index.mjs",
   "types": "./bundle.d.ts",
-  "author": "",
+  "author": "support@here.io",
   "license": "SEE LICENSE IN LICENSE.md",
-  "optionalDependencies": {
-    "@rollup/rollup-linux-x64-gnu": "*"
-  },
   "dependencies": {
-    "mqtt": "^5.3.1",
-    "zod": "^3.24.1"
+    "mqtt": "^5.15.1",
+    "zod": "catalog:"
   }
 }