@openfin/cloud-interop 0.1.0

package/LICENSE.md

@@ -0,0 +1,4 @@
+Learn more about OpenFin licensing at the links listed below or email us at support@openfin.co with questions.
+
+- [Developer agreement](https://openfin.co/developer-agreement)
+

package/README.md

@@ -0,0 +1,49 @@
+# @openfin/cloud-interop
+
+This package contains an override that enables Cloud Interop for OpenFin `InteropBroker`'s unlocking Interop across applications and devices.
+
+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.
+
+## Usage
+
+In a Platform:
+
+```typescript
+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
+  url: "<CLOUD_INTEROP_SERVER_URL>",
+  sourceId: fin.me.identity.uuid,
+  source: "Desktop",
+};
+
+const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
+
+// Ordering is important, ensure Cloud Interop Override is at the end of the list to send overriden Context to the cloud
+await fin.Platform.init({
+  interopOverride: [ExampleOverride, InitializedCloudInteropOverride],
+});
+```
+
+When creating an `InteropBroker` directly:
+
+```typescript
+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
+  url: "<CLOUD_INTEROP_SERVER_URL>",
+  sourceId: fin.me.identity.uuid,
+  source: "Desktop",
+};
+
+const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
+
+await fin.Interop.init(fin.me.uuid, InitializedCloudInteropOverride);
+```

package/dist/api.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+import mqtt from 'mqtt';
+import { Client, ConnectParams, Source, IntentDetail } from './interfaces';
+export type { ConnectParams };
+interface ConnectResponse {
+    sessionId: string;
+    sessionRootTopic: string;
+    mqttUrl: string;
+    mqttToken?: string;
+}
+export declare class CloudInteropAPI implements Client {
+    private connectParams;
+    private _sessionDetails?;
+    private _mqttClient?;
+    private reconnectRetryLimit;
+    private reconnectRetries;
+    private contextListener?;
+    constructor(connectParams: ConnectParams);
+    get sessionDetails(): ConnectResponse | undefined;
+    get mqttClient(): mqtt.MqttClient | undefined;
+    connect(params: ConnectParams): Promise<void>;
+    disconnect(): Promise<void>;
+    setContext(contextGroup: string, context: object): Promise<void>;
+    addContextListener(callback: (contextGroup: string, context: object, source: Source) => void): void;
+    startIntentDiscovery(intentName?: string | undefined, context?: object | undefined): Promise<string>;
+    endIntentDiscovery(discoveryId: string): Promise<void>;
+    sendIntentDetail(discoveryId: string, intentDetail: IntentDetail): Promise<void>;
+    raiseIntent(targetSession: string, intentInstanceId: string, context: Object): Promise<any>;
+    addIntentDetailListener(callback: (discoveryId: string, intentDetail: IntentDetail) => void): void;
+    handleCommand(topic: string, message: Buffer, sessionDetails: ConnectResponse): void;
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { cloudInteropOverride, type CloudInteropOverrideParams, type CloudInteropConnectionStates } from "./override";
+export { cloudInteropOverride, type CloudInteropOverrideParams, type CloudInteropConnectionStates };