@openfin/cloud-interop-core-api 0.0.1-alpha.ca42c10 → 0.0.1-alpha.ec59187

package/dist/index.cjs

@@ -31,6 +31,7 @@ class CloudInteropAPI {
     #sessionDetails;
     #mqttClient;
     #reconnectRetryLimit = 30;
+    #keepAliveIntervalSeconds = 30;
     #logger = (level, message) => {
         console[level](message);
     };
@@ -60,6 +61,7 @@ class CloudInteropAPI {
         this.#validateConnectParams(parameters);
         this.#connectionParams = parameters;
         this.#reconnectRetryLimit = parameters.reconnectRetryLimit || this.#reconnectRetryLimit;
+        this.#keepAliveIntervalSeconds = parameters.keepAliveIntervalSeconds || this.#keepAliveIntervalSeconds;
         this.#logger = parameters.logger || this.#logger;
         const { sourceId, platformId } = this.#connectionParams;
         try {
@@ -75,6 +77,7 @@ class CloudInteropAPI {
             this.#sessionDetails = createSessionResponse.data;
             const sessionRootTopic = this.#sessionDetails.sessionRootTopic;
             const clientOptions = {
+                keepalive: this.#keepAliveIntervalSeconds,
                 clientId: this.#sessionDetails.sessionId,
                 clean: true,
                 protocolVersion: 5,
@@ -253,6 +256,12 @@ class CloudInteropAPI {
         if (!parameters) {
             throw new Error('Connect parameters must be provided');
         }
+        if (!parameters.sourceId) {
+            throw new Error('sourceId must be provided');
+        }
+        if (!parameters.platformId) {
+            throw new Error('platformId must be provided');
+        }
         if (parameters.authenticationType === 'jwt' &&
             (!parameters.jwtAuthenticationParameters?.jwtRequestCallback || !parameters.jwtAuthenticationParameters?.authenticationId)) {
             throw new Error('jwtAuthenticationParameters must be provided when using jwt authentication');

package/dist/index.mjs

@@ -3795,6 +3795,7 @@ class CloudInteropAPI {
     #sessionDetails;
     #mqttClient;
     #reconnectRetryLimit = 30;
+    #keepAliveIntervalSeconds = 30;
     #logger = (level, message) => {
         console[level](message);
     };
@@ -3824,6 +3825,7 @@ class CloudInteropAPI {
         this.#validateConnectParams(parameters);
         this.#connectionParams = parameters;
         this.#reconnectRetryLimit = parameters.reconnectRetryLimit || this.#reconnectRetryLimit;
+        this.#keepAliveIntervalSeconds = parameters.keepAliveIntervalSeconds || this.#keepAliveIntervalSeconds;
         this.#logger = parameters.logger || this.#logger;
         const { sourceId, platformId } = this.#connectionParams;
         try {
@@ -3839,6 +3841,7 @@ class CloudInteropAPI {
             this.#sessionDetails = createSessionResponse.data;
             const sessionRootTopic = this.#sessionDetails.sessionRootTopic;
             const clientOptions = {
+                keepalive: this.#keepAliveIntervalSeconds,
                 clientId: this.#sessionDetails.sessionId,
                 clean: true,
                 protocolVersion: 5,
@@ -4017,6 +4020,12 @@ class CloudInteropAPI {
         if (!parameters) {
             throw new Error('Connect parameters must be provided');
         }
+        if (!parameters.sourceId) {
+            throw new Error('sourceId must be provided');
+        }
+        if (!parameters.platformId) {
+            throw new Error('platformId must be provided');
+        }
         if (parameters.authenticationType === 'jwt' &&
             (!parameters.jwtAuthenticationParameters?.jwtRequestCallback || !parameters.jwtAuthenticationParameters?.authenticationId)) {
             throw new Error('jwtAuthenticationParameters must be provided when using jwt authentication');

package/dist/interfaces.d.ts

@@ -9,27 +9,27 @@ export type CloudInteropLogger = (level: LogLevel, message: string) => void;
 export type ConnectParameters = {
     /**
      * ID for a group of shared applications.
+     * This acts as a namespace for the interop messages that allows separation of messages between different groups of applications for the same user
      */
     platformId: string;
     /**
      * An identifier for the source environment e.g. a hostname, a browser name etc.
      */
-    sourceId?: string;
+    sourceId: string;
     /**
      * A display name for the source environment e.g. Andys Mobile
      */
     sourceDisplayName?: string;
-    /**
-     * Specifies an optional extra divider to use that allows separation of interop messages for the
-     * same user
-     * defaults to "default"
-     */
-    realm?: string;
     /**
      * The maximum number of times to retry connecting to the cloud interop service when the connection is dropped
      * defaults to 30
      */
     reconnectRetryLimit?: number;
+    /**
+     * Specifies how often keep alive messages should be sent to the cloud interop service in seconds
+     * defaults to 30
+     */
+    keepAliveIntervalSeconds?: number;
     /**
      * Optional function to call with any logging messages to allow integration with the host application's logging
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/cloud-interop-core-api",
-    "version": "0.0.1-alpha.ca42c10",
+    "version": "0.0.1-alpha.ec59187",
     "type": "module",
     "description": "",
     "files": [