@openfin/cloud-interop 0.2.0 → 0.4.0

package/README.md

@@ -6,6 +6,10 @@ Overrides are passed to `fin.Platform.init` when initializing a platform or to `
 
 Once overriden the `InteropBroker` will connect to Cloud Interop. `Context` will be sent to the Cloud Interop server and the broker will receive `Context` updates from other any other connected brokers in the shared session.
 
+## Auth
+
+Using the service currently requires user credentials provided by OpenFin, please contact support@openfin.co.
+
 ## Usage
 
 In a Platform:
@@ -15,8 +19,9 @@ import { cloudInteropOverride } from "@openfin/cloud-interop";
 import { ExampleOverride } from "./example";
 
 const cloudConfig = {
-  userId: "andy",
-  platformId: "8cef8205-d5a8-41c4-b368-47475b32c019", // This id is shared between platforms that should communicate
+  userId: "andy", // Credentials provided by OpenFin
+  password: "asdf1234", // Credentials provided by OpenFin
+  platformId: "8cef8205-d5a8-41c4-b368-47475b32c019", // Shared identifier for apps that should communicate
   url: "<CLOUD_INTEROP_SERVER_URL>",
   sourceId: fin.me.identity.uuid,
   source: "Desktop",
@@ -36,8 +41,9 @@ When creating an `InteropBroker` directly:
 import { cloudInteropOverride } from "@openfin/cloud-interop";
 
 const cloudConfig = {
-  userId: "andy",
-  platformId: "8cef8205-d5a8-41c4-b368-47475b32c019", // This id is shared between platforms that should communicate
+  userId: "andy", // Credentials provided by OpenFin
+  password: "asdf1234", // Credentials provided by OpenFin
+  platformId: "8cef8205-d5a8-41c4-b368-47475b32c019", // Shared identifier for apps that should communicate
   url: "<CLOUD_INTEROP_SERVER_URL>",
   sourceId: fin.me.identity.uuid,
   source: "Desktop",

package/dist/index.js

@@ -3279,7 +3279,7 @@ class CloudInteropAPI {
         return this._mqttClient;
     }
     async connect(params) {
-        const { userId, sourceId, platformId } = params;
+        const { userId, password, sourceId, platformId } = params;
         let connectResponse;
         try {
             connectResponse = await axios.post(`${this.connectParams.url}/sessions`, {
@@ -3307,10 +3307,9 @@ class CloudInteropAPI {
                     qos: 0,
                     retain: false
                 },
+                username: userId,
+                password
             };
-            if (connectResponse.data.mqttToken) {
-                clientOptions.username = connectResponse.data.mqttToken;
-            }
             this._mqttClient = await mqtt.connectAsync(connectResponse.data.mqttUrl, clientOptions);
             this._sessionDetails = connectResponse.data;
             console.log(`Cloud Interop successfully connected to ${this.connectParams.url}`);
@@ -3424,7 +3423,7 @@ async function cloudInteropOverride(config) {
             // @ts-expect-error
             const version = await fin.System.getVersion();
             const [major, chromium, api, build] = version.split('.').map((v) => parseInt(v));
-            if (major < 37 || build < 38) {
+            if (major < 37 || major === 37 && (chromium < 122 && build < 38)) {
                 throw new Error(`Cloud Interop requires runtime version 37.121.80.38+ when running in OpenFin.`);
             }
         }

package/dist/interfaces.d.ts

@@ -7,12 +7,15 @@ export interface ConnectParams {
      */
     url: string;
     /**
-     * The user ID to connect as.
-     * Note: Might be the sub from a openid JWT
+     * The user to connect as. Credentials provided by OpenFin.
      */
     userId: string;
     /**
-     * ID for a group of shared applications. Until we have auth we can't rely on only userId.
+     * Password for the user. Credentials provided by OpenFin.
+     */
+    password: string;
+    /**
+     * ID for a group of shared applications.
      */
     platformId: string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfin/cloud-interop",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "",
   "files": [
     "./dist/*"