@openfin/cloud-interop 0.1.0

package/dist/interfaces.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Represents the parameters to use to connect to an interop server
+ */
+export interface ConnectParams {
+    /**
+     * The URL of the server to connect to.
+     */
+    url: string;
+    /**
+     * The user ID to connect as.
+     * Note: Might be the sub from a openid JWT
+     */
+    userId?: string;
+    /**
+     * ID for a group of shared applications. Until we have auth we can't rely on only userId.
+     */
+    platformId: string;
+    /**
+     * An identifier for the source environment e.g. a hostname, a browser name etc.
+     */
+    sourceId?: string;
+    /**
+     * A display name for the source environment e.g. Andys Mobile
+     */
+    sourceDisplayName?: string;
+    /**
+     * Specifies an optional extra divider to use that allows separation of interop messages for the
+     * same user
+     * defaults to "default"
+     */
+    realm?: string;
+}
+/**
+* Represents a session
+*/
+export interface InteropSession {
+    sessionId: string;
+}
+/**
+* Represents a source session
+*/
+export interface Source {
+    /**
+     * Source session id
+     */
+    sessionId: string;
+    /**
+     * source environment id
+     */
+    sourceId: string;
+    /**
+     * source environment display name
+     */
+    sourceDisplayName: string;
+}
+/**
+* Represents the details of an intent found during discovery
+*/
+export interface IntentDetail {
+    /**
+     * The location of the intent implementation
+     */
+    source: Source;
+    /**
+     * The instance id of the intent
+     */
+    intentInstanceId: string;
+    /**
+     * The name of the intent
+     */
+    intentName: string;
+}
+export interface Client {
+    /**
+     * Connects to an interop server and returns a session
+     * @param params The parameters to use to connect
+     */
+    connect(params: ConnectParams): Promise<void>;
+    /**
+     * Disconnects from an interop server
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Publishes a new context for the given context group to the user other connected sessions
+     * @param contextGroup
+     * @param context
+     */
+    setContext(contextGroup: string, context: object): Promise<void>;
+    /**
+     * Adds a listener for any received context changes
+     * @param callback
+     */
+    addContextListener(callback: (contextGroup: string, context: object, source: Source) => void): void;
+    /**
+     * Starts the remote intent discovery flow
+     *
+     * @param intentName The name of the intent to discover when discovering by name
+     * @param context The context to use when discovering by context
+     *
+     * @returns A discovery id that can be used to end the discovery flow
+     */
+    startIntentDiscovery(intentName?: string, context?: object): Promise<string>;
+    /**
+     * Ends the remote intent discovery flow
+     *
+     * @param discoveryId The discovery id returned from startIntentDiscovery
+     */
+    endIntentDiscovery(discoveryId: string): Promise<void>;
+    /**
+     * Any client that is responding to an intent discovery request
+     * should call this method to send the details of an intent to the requesting client
+     * As intents are registered on each client and during a previously started intent discovery flow, this method
+     * can be called multiple times to support live intent discovery
+     */
+    sendIntentDetail(discoveryId: string, intentDetail: IntentDetail): Promise<void>;
+    /**
+     * Raises the given intent on the given session
+     *
+     * @param targetSession The session to raise the intent on
+     * @param intentInstanceId The instance id of the intent to raise
+     * @param context The context to use when raising the intent
+     *
+     * @returns A promise that resolves to the result of the intent invocation
+     */
+    raiseIntent(targetSession: string, intentInstanceId: string, context: Object): Promise<any>;
+    /**
+     * Adds a listener for any received intent details in a client that has invoked startIntentDiscovery
+     */
+    addIntentDetailListener(callback: (discoveryId: string, intentDetail: IntentDetail) => void): void;
+}

package/dist/override.d.ts

@@ -0,0 +1,5 @@
+import type OpenFin from '@openfin/core';
+import type { ConnectParams } from './interfaces';
+export type CloudInteropOverrideParams = ConnectParams;
+export type CloudInteropConnectionStates = 'connected' | 'reconnecting' | 'disconnected';
+export declare function cloudInteropOverride(config: CloudInteropOverrideParams): Promise<OpenFin.ConstructorOverride<OpenFin.InteropBroker>>;

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@openfin/cloud-interop",
+  "version": "0.1.0",
+  "description": "",
+  "files": [
+    "./dist/*"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "rollup -c"
+  },
+  "author": "",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/node": "^20.10.0",
+    "rollup": "^4.9.6",
+    "typescript": "^5.3.2"
+  },
+  "dependencies": {
+    "@openfin/core": "^37.80.39",
+    "axios": "^1.6.2",
+    "mqtt": "^5.3.1"
+  }
+}