@openfin/cloud-interop 0.41.63 → 0.41.64

package/README.md

@@ -1,30 +1,23 @@
 # @openfin/cloud-interop
 
-This package contains an override that enables Cloud Interop for OpenFin `InteropBroker`'s unlocking Interop across applications and devices.
+This package contains an override that enables Cloud Interop for `InteropBroker`'s unlocking Interop across applications and devices. It is powered by the [@openfin/cloud-interop-core-api](https://www.npmjs.com/package/@openfin/cloud-interop-core-api?activeTab=readme) package which provides an API client to communicate with the Cloud Interop Service.
 
 Overrides are passed to `fin.Platform.init` when initializing a platform or to `fin.Interop.init` when creating an `InteropBroker` directly.
 
-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.
+Once overriden the `InteropBroker` will connect to the given Cloud Interop Service upon initialization. `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.
 
 ## Usage
 
-In a Platform:
+In a Platform with other overrides:
 
 ```typescript
 import { cloudInteropOverride } from "@openfin/cloud-interop";
 import { ExampleOverride } from "./example";
 
 const cloudConfig = {
-  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",
+  url: "<CLOUD_INTEROP_SERVICE_URL>",
+  platformId: "my-platform", // Shared identifier for apps that should communicate
+  sourceId: "my-desktop"
 };
 
 const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
@@ -41,15 +34,70 @@ When creating an `InteropBroker` directly:
 import { cloudInteropOverride } from "@openfin/cloud-interop";
 
 const cloudConfig = {
-  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",
+  url: "<CLOUD_INTEROP_SERVICE_URL>",
+  platformId: "my-platform", // Shared identifier for apps that should communicate
+  sourceId: "my-desktop"
 };
 
 const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
 
 await fin.Interop.init(fin.me.uuid, InitializedCloudInteropOverride);
 ```
+
+## Authentication
+
+The Cloud Interop API client offers various authentication methods which can be enabled through configuration.
+
+Interactive session based authentication using cookies (default):
+
+```typescript
+import { cloudInteropOverride } from "@openfin/cloud-interop";
+
+const cloudConfig = {
+  url: "<CLOUD_INTEROP_SERVICE_URL>",
+  platformId: "my-platform", // Shared identifier for apps that should communicate
+  sourceId: "my-desktop",
+};
+
+const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
+```
+
+Basic authentication with credentials provisioned per Cloud Interop Service:
+
+```typescript
+import { cloudInteropOverride } from "@openfin/cloud-interop";
+
+const cloudConfig = {
+  url: "<CLOUD_INTEROP_SERVICE_URL>",
+  platformId: "my-platform", // Shared identifier for apps that should communicate
+  sourceId: "my-desktop",
+  authenticationType: "basic",
+  basicAuthenticationParameters: {
+    username: "bob@acme.com",
+    password: "password"
+  }
+};
+
+const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
+```
+
+JWT token authentication:
+
+```typescript
+import { cloudInteropOverride } from "@openfin/cloud-interop";
+
+const cloudConfig = {
+  url: "<CLOUD_INTEROP_SERVICE_URL>",
+  platformId: "my-platform", // Shared identifier for apps that should communicate
+  sourceId: "my-desktop",
+  authenticationType: "jwt",
+  jwtAuthenticationParameters: {
+    // Service Gateway authentication identifier, contact Here support to obtain id for your organization. 
+    authenticationId: "00b671f2-e1a9-4c29-9fa9-55f1988a11fb",
+    // Callback invoked whenever a jwt token is required for a request
+    jwtRequestCallback: () => "my-token"
+  }
+};
+
+const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
+```