@openfin/cloud-interop-core-api 0.0.1-alpha.e646bca → 0.0.1-alpha.e648cd4

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

@@ -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: 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,6 +418,7 @@ export declare type CreateSessionResponse = {
     sub: string;
     platformId: string;
     sourceId: string;
+    localSessionExpiryHandling?: boolean;
 };
 
 declare const errorSchema: z.ZodObject<{

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) {
@@ -353,6 +355,7 @@ class CloudInteropAPI {
     #attemptingToReconnect = false;
     #events = new EventController();
     #intents;
+    #sessionTimer;
     constructor(cloudInteropSettings) {
         this.#cloudInteropSettings = cloudInteropSettings;
     }
@@ -365,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);
@@ -393,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,
@@ -422,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: {
@@ -478,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);
@@ -488,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) {
@@ -517,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();
@@ -560,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),
@@ -658,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) {
@@ -351,6 +353,7 @@ class CloudInteropAPI {
     #attemptingToReconnect = false;
     #events = new EventController();
     #intents;
+    #sessionTimer;
     constructor(cloudInteropSettings) {
         this.#cloudInteropSettings = cloudInteropSettings;
     }
@@ -363,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);
@@ -391,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,
@@ -420,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: {
@@ -476,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);
@@ -486,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) {
@@ -515,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();
@@ -558,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),
@@ -656,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,6 +1,6 @@
 {
   "name": "@openfin/cloud-interop-core-api",
-  "version": "0.0.1-alpha.e646bca",
+  "version": "0.0.1-alpha.e648cd4",
   "type": "module",
   "description": "",
   "main": "./index.cjs",