@openfin/cloud-interop-core-api - npm Package Compare versions

Comparing version 0.0.1-alpha.e6793f0 to 0.0.1-alpha.ec59187

dist/api.d.ts

@@ -14,3 +14,3 @@ import mqtt from 'mqtt';
 type EventMap = {
-    connected: () => void;
+    reconnected: () => void;
     disconnected: () => void;
@@ -20,2 +20,3 @@ context: (event: ContextEvent) => void;
     error: (error: Error) => void;
+    'session-expired': () => void;
 };
@@ -31,10 +32,2 @@ /**
     #private;
-    private cloudInteropSettings;
-    private _sessionDetails?;
-    private _mqttClient?;
-    private reconnectRetryLimit;
-    private logger;
-    private reconnectRetries;
-    private connectionParams?;
-    private eventListeners;
     constructor(cloudInteropSettings: CloudInteropSettings);
@@ -41,0 +34,0 @@ get sessionDetails(): CreateSessionResponse | undefined;

dist/interfaces.d.ts

@@ -12,2 +12,3 @@ export type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
      * 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
      */
@@ -18,3 +19,3 @@ platformId: string;
      */
-    sourceId?: string;
+    sourceId: string;
     /**
@@ -25,8 +26,2 @@ * A display name for the source environment e.g. Andys Mobile
     /**
-     * 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
@@ -37,2 +32,7 @@ * defaults to 30
     /**
+     * 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
@@ -134,5 +134,14 @@ *
 export type ContextEvent = {
+    /**
+     * The context group
+     */
     contextGroup: string;
+    /**
+     * The context object
+     */
     context: object;
+    /**
+     * The source of the context
+     */
     source: Source;
 };

package.json

 {
     "name": "@openfin/cloud-interop-core-api",
-    "version": "0.0.1-alpha.e6793f0",
+    "version": "0.0.1-alpha.ec59187",
     "type": "module",
@@ -5,0 +5,0 @@ "description": "",

No alert changes

Improved metrics

Total package byte prevSize

469355

increased by1.21%

Lines of code

5199

increased by1.76%

No dependency changes