@openfin/cloud-interop 0.4.0 → 0.38.39

package/LICENSE.md

@@ -1,4 +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)
-
+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

@@ -1,55 +1,55 @@
-# @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.
-
-## Auth
-
-Using the service currently requires user credentials provided by OpenFin, please contact support@openfin.co.
-
-## Usage
-
-In a Platform:
-
-```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",
-};
-
-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", // 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",
-};
-
-const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
-
-await fin.Interop.init(fin.me.uuid, InitializedCloudInteropOverride);
-```
+# @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.
+
+## Auth
+
+Using the service currently requires user credentials provided by OpenFin, please contact support@openfin.co.
+
+## Usage
+
+In a Platform:
+
+```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",
+};
+
+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", // 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",
+};
+
+const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);
+
+await fin.Interop.init(fin.me.uuid, InitializedCloudInteropOverride);
+```

package/{dist → out}/api.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-import mqtt from 'mqtt';
 import { Client, ConnectParams, Source, IntentDetail } from './interfaces';
 export type { ConnectParams };
 interface ConnectResponse {
@@ -16,8 +15,8 @@ export declare class CloudInteropAPI implements Client {
     private reconnectRetries;
     private contextListener?;
     constructor(connectParams: ConnectParams);
-    get sessionDetails(): ConnectResponse | undefined;
-    get mqttClient(): mqtt.MqttClient | undefined;
+    get sessionDetails(): typeof this._sessionDetails;
+    get mqttClient(): typeof this._mqttClient;
     connect(params: ConnectParams): Promise<void>;
     disconnect(): Promise<void>;
     setContext(contextGroup: string, context: object): Promise<void>;

package/{dist → out}/index.d.ts

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