@openfin/cloud-interop-core-api 0.0.1-alpha.f5e354c → 0.0.1-alpha.f6523ef

package/{dist/index.cjs → index.mjs}

@@ -1,7 +1,5 @@
-'use strict';
-
-var mqtt = require('mqtt');
-var sharedUtils = require('@openfin/shared-utils');
+import { Buffer } from 'buffer';
+import mqtt from 'mqtt';
 
 class CloudInteropAPIError extends Error {
     code;
@@ -46,6 +44,8 @@ class EventController {
     }
 }
 
+const isErrorIntentResult = (result) => 'error' in result;
+
 const APP_ID_DELIM = '::';
 const getRequestHeaders = (connectionParameters) => {
     const headers = {};
@@ -72,13 +72,9 @@ const getRequestHeaders = (connectionParameters) => {
  * @param source
  * @returns
  */
-const encodeAppIntents = (appIntents, { sessionId, sourceId }) => appIntents.map((intent) => ({
+const encodeAppIntents = (appIntents, source) => appIntents.map((intent) => ({
     ...intent,
-    apps: intent.apps.map((app) => {
-        const id = encodeURIComponent(app.appId);
-        const sId = encodeURIComponent(sourceId);
-        return { ...app, appId: `${id}${APP_ID_DELIM}${sId}${APP_ID_DELIM}${sessionId}` };
-    }),
+    apps: intent.apps.map((app) => ({ ...app, appId: encodeAppId(app.appId, source) })),
 }));
 /**
  * Decodes all app intents by URI decoding the parts previously encoded by `encodeAppIntents`
@@ -87,19 +83,35 @@ const encodeAppIntents = (appIntents, { sessionId, sourceId }) => appIntents.map
  */
 const decodeAppIntents = (appIntents) => appIntents.map((intent) => ({
     ...intent,
-    apps: intent.apps.map((app) => {
-        const [encodedAppId, encodedSourceId, sessionId] = app.appId.split(APP_ID_DELIM);
-        const id = decodeURIComponent(encodedAppId);
-        const sourceId = decodeURIComponent(encodedSourceId);
-        return { ...app, appId: `${id}${APP_ID_DELIM}${sourceId}${APP_ID_DELIM}${sessionId}` };
-    }),
+    apps: intent.apps.map((app) => ({ ...app, appId: decodeAppId(app.appId) })),
 }));
+const encodeAppId = (appIdString, { sessionId, sourceId }) => {
+    const id = encodeURIComponent(appIdString);
+    const sId = encodeURIComponent(sourceId);
+    return `${id}${APP_ID_DELIM}${sId}${APP_ID_DELIM}${sessionId}`;
+};
+const decodeAppId = (appId) => {
+    const [encodedAppId, encodedSourceId, sessionId] = appId.split(APP_ID_DELIM);
+    const id = decodeURIComponent(encodedAppId);
+    const sourceId = decodeURIComponent(encodedSourceId);
+    return `${id}${APP_ID_DELIM}${sourceId}${APP_ID_DELIM}${sessionId}`;
+};
 /**
- * Decodes the app id to extract the sessionId, returns '' if not able to parse
- * @param app
- * @returns
+ * Decodes the AppIdentifier to extract the appId, sourceId, and sessionId.
+ * @returns an object with:
+ * - appId: The appId, or the original appId if unable to parse.
+ * - sourceId: The sourceId, or an '' if unable to parse.
+ * - sessionId: The sessionId, or an '' if unable to parse.
  */
-const parseSessionId = (appId) => (typeof appId === 'string' ? appId : appId.appId).split(APP_ID_DELIM)?.[2]?.trim() ?? '';
+const parseCloudAppId = (appId = '') => {
+    const originalAppString = typeof appId === 'string' ? appId : (appId.appId ?? '');
+    const parts = originalAppString.split(APP_ID_DELIM);
+    return {
+        appId: parts[0]?.trim() ?? originalAppString,
+        sourceId: parts[1]?.trim() ?? '',
+        sessionId: parts[2]?.trim() ?? '',
+    };
+};
 const getSourceFromSession = (sessionDetails) => ({
     sessionId: sessionDetails.sessionId,
     sourceId: sessionDetails.sourceId,
@@ -148,13 +160,18 @@ class IntentController {
                 body: JSON.stringify({ findOptions }),
             });
             if (!startResponse.ok) {
-                throw new Error(startResponse.statusText);
+                throw new Error(`Error creating intent discovery record: ${startResponse.statusText}`);
             }
             // TODO: type this response?
             const json = await startResponse.json();
             this.#discovery.id = json.discoveryId;
             this.#discovery.sessionCount = json.sessionCount;
             this.#discovery.state = 'in-progress';
+            if (this.#discovery.sessionCount === 1) {
+                // since we have no other connected sessions, we can end discovery immediately
+                await this.#endIntentDiscovery(false);
+                return;
+            }
             // Listen out for discovery results directly sent to us
             await this.#mqttClient.subscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`);
             this.#discoveryTimeout = setTimeout(() => this.#endIntentDiscovery(), clampedTimeout);
@@ -165,10 +182,8 @@ class IntentController {
             throw new CloudInteropAPIError('Error starting intent discovery', 'ERR_STARTING_INTENT_DISCOVERY', error);
         }
     }
-    async #endIntentDiscovery() {
+    async #endIntentDiscovery(mqttUnsubscribe = true) {
         if (this.#discovery.state !== 'in-progress') {
-            // TODO: remove debug logs
-            this.#logger('debug', 'Intent discovery not in progress');
             return;
         }
         if (this.#discoveryTimeout) {
@@ -178,10 +193,12 @@ class IntentController {
         this.#discovery.state = 'ended';
         // emit our aggregated events
         this.#events.emitEvent('aggregate-intent-details', { responses: this.#discovery.pendingIntentDetailsEvents });
-        // gracefully end discovery
-        await this.#mqttClient.unsubscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`).catch(() => {
-            this.#logger('warn', `Error ending intent discovery: could not unsubscribe from discovery id ${this.#discovery.id}`);
-        });
+        if (mqttUnsubscribe) {
+            // gracefully end discovery
+            await this.#mqttClient.unsubscribeAsync(`${this.#sessionDetails.sessionRootTopic}/commands/${this.#discovery.id}`).catch(() => {
+                this.#logger('warn', `Error ending intent discovery: could not unsubscribe from discovery id ${this.#discovery.id}`);
+            });
+        }
         await fetch(`${this.#url}/api/intents/${this.#sessionDetails.sessionId}/${this.#discovery.id}`, {
             method: 'DELETE',
             headers: getRequestHeaders(this.#connectionParams),
@@ -190,7 +207,6 @@ class IntentController {
             if (!deleteResponse.ok) {
                 throw new Error(`Error ending intent discovery: ${deleteResponse.statusText}`);
             }
-            this.#logger('debug', 'Intent discovery ended');
         })
             .catch((error) => {
             this.#logger('warn', `Error ending intent discovery: ${error}`);
@@ -199,7 +215,7 @@ class IntentController {
         this.#discovery = newDiscovery();
     }
     async raiseIntent({ raiseOptions, appId }) {
-        const targetSessionId = parseSessionId(appId);
+        const targetSessionId = parseCloudAppId(appId).sessionId;
         if (!targetSessionId) {
             // TODO: should we add more info here about the format?
             throw new CloudInteropAPIError(`Invalid AppId specified, must be encoded as a cloud-session app id`, 'ERR_INVALID_TARGET_SESSION_ID');
@@ -234,6 +250,13 @@ class IntentController {
         return false;
     }
     async sendIntentResult(initiatingSessionId, result) {
+        if (!isErrorIntentResult(result)) {
+            // cloud-encode the source app id to support chained intent actions over cloud
+            // https://fdc3.finos.org/docs/2.0/api/spec#resolution-object -> "Use metadata about the resolving app instance to target a further intent"
+            const source = getSourceFromSession(this.#sessionDetails);
+            const encoded = encodeAppId(typeof result.source === 'string' ? result.source : result.source.appId, source);
+            result.source = typeof result.source === 'string' ? encoded : { ...result.source, appId: encoded };
+        }
         const { sessionId } = getSourceFromSession(this.#sessionDetails);
         const resultResponse = await fetch(`${this.#url}/api/intents/${initiatingSessionId}/result/${sessionId}`, {
             method: 'POST',
@@ -311,9 +334,8 @@ const BadUserNamePasswordError = 134;
 /**
  * Represents a single connection to a Cloud Interop service
  *
- * @export
- * @class CloudInteropAPI
- * @implements {Client}
+ * @public
+ * @class
  */
 class CloudInteropAPI {
     #cloudInteropSettings;
@@ -342,7 +364,7 @@ class CloudInteropAPI {
      * Connects and creates a session on the Cloud Interop service
      *
      * @param {ConnectParameters} parameters - The parameters to use to connect
-     * @return {*}  {Promise<void>}
+     * @returns {*} {Promise<void>}
      * @memberof CloudInteropAPI
      * @throws {CloudInteropAPIError} - If an error occurs during connection
      * @throws {AuthorizationError} - If the connection is unauthorized
@@ -454,7 +476,7 @@ class CloudInteropAPI {
     /**
      * Disconnects from the Cloud Interop service
      *
-     * @return {*}  {Promise<void>}
+     * @returns {*} {Promise<void>}
      * @memberof CloudInteropAPI
      * @throws {CloudInteropAPIError} - If an error occurs during disconnection
      */
@@ -466,7 +488,7 @@ class CloudInteropAPI {
      *
      * @param {string} contextGroup - The context group to publish to
      * @param {object} context - The context to publish
-     * @return {*}  {Promise<void>}
+     * @returns {*} {Promise<void>}
      * @memberof CloudInteropAPI
      */
     async setContext(contextGroup, context) {
@@ -493,7 +515,7 @@ class CloudInteropAPI {
     /**
      * Starts an intent discovery operation
      *
-     * @return {*}  {Promise<void>}
+     * @returns {*} {Promise<void>}
      * @memberof CloudInteropAPI
      * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
      */
@@ -514,7 +536,10 @@ class CloudInteropAPI {
         return this.#intents?.sendIntentResult(initiatingSessionId, result);
     }
     parseSessionId(appId) {
-        return parseSessionId(appId);
+        return parseCloudAppId(appId).sessionId;
+    }
+    parseAppId(appId) {
+        return parseCloudAppId(appId).appId;
     }
     addEventListener(type, callback) {
         this.#events.addEventListener(type, callback);
@@ -526,10 +551,13 @@ class CloudInteropAPI {
         this.#events.once(type, callback);
     }
     async #disconnect(fireDisconnectedEvent) {
-        if (!this.#sessionDetails || !this.#connectionParams) {
+        if (!this.#sessionDetails) {
             return;
         }
         try {
+            if (!this.#connectionParams) {
+                throw new Error('Connect parameters must be provided');
+            }
             const disconnectResponse = await fetch(`${this.#cloudInteropSettings.url}/api/sessions/${this.#sessionDetails.sessionId}`, {
                 method: 'DELETE',
                 headers: getRequestHeaders(this.#connectionParams),
@@ -565,8 +593,13 @@ class CloudInteropAPI {
             if (contextEvent.source.sessionId === sessionDetails.sessionId) {
                 return;
             }
-            const { contextGroup, context, source, history } = contextEvent;
-            this.#events.emitEvent('context', { contextGroup, context, source, history: { ...history, clientReceived: Date.now() } });
+            const { context, payload, contextGroup, channelName, source, history } = contextEvent;
+            this.#events.emitEvent('context', {
+                contextGroup: channelName || contextGroup,
+                context: payload || context,
+                source,
+                history: { ...history, clientReceived: Date.now() },
+            });
         }
         else if (topic.startsWith(`${sessionDetails.sessionRootTopic}/commands`)) {
             this.#handleCommandMessage(messageEnvelope);
@@ -625,12 +658,4 @@ class CloudInteropAPI {
     }
 }
 
-exports.AuthorizationError = AuthorizationError;
-exports.CloudInteropAPI = CloudInteropAPI;
-exports.CloudInteropAPIError = CloudInteropAPIError;
-Object.keys(sharedUtils).forEach(function (k) {
-    if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-        enumerable: true,
-        get: function () { return sharedUtils[k]; }
-    });
-});
+export { AuthorizationError, CloudInteropAPI, CloudInteropAPIError };

package/package.json

@@ -1,231 +1,18 @@
 {
-    "name": "@openfin/cloud-interop-core-api",
-    "version": "0.0.1-alpha.f5e354c",
-    "type": "module",
-    "description": "",
-    "files": [
-        "./dist/*"
-    ],
-    "main": "./dist/index.cjs",
-    "browser": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
-    "scripts": {
-        "build": "rimraf dist && rollup -c",
-        "build:watch": "rollup -c --watch",
-        "typecheck": "tsc --noEmit",
-        "test": "jest --coverage",
-        "lint": "eslint . --max-warnings 0",
-        "lint:fix": "eslint . --fix --max-warnings 0"
-    },
-    "author": "",
-    "license": "SEE LICENSE IN LICENSE.md",
-    "devDependencies": {
-        "@rollup/plugin-commonjs": "^28.0.1",
-        "@rollup/plugin-inject": "^5.0.5",
-        "@rollup/plugin-node-resolve": "^15.2.3",
-        "@rollup/plugin-typescript": "^11.1.6",
-        "@types/jest": "^29.5.14",
-        "@types/node": "^22.7.7",
-        "@typescript-eslint/eslint-plugin": "^7.5.0",
-        "@typescript-eslint/parser": "^7.15.0",
-        "eslint": "^8.57.0",
-        "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-check-file": "^2.8.0",
-        "eslint-plugin-prettier": "^5.2.1",
-        "eslint-plugin-simple-import-sort": "^12.1.1",
-        "eslint-plugin-unicorn": "^55.0.0",
-        "eslint-plugin-unused-imports": "^4.1.4",
-        "jest": "^29.7.0",
-        "prettier": "^3.3.3",
-        "rollup": "^4.9.6",
-        "ts-jest": "^29.2.5",
-        "typescript": "^5.6.3"
-    },
-    "dependencies": {
-        "@openfin/shared-utils": "file:../shared-utils",
-        "mqtt": "^5.3.1"
-    },
-    "eslintConfig": {
-        "env": {
-            "browser": true,
-            "node": true
-        },
-        "parser": "@typescript-eslint/parser",
-        "parserOptions": {
-            "ecmaVersion": "latest",
-            "project": true,
-            "sourceType": "module"
-        },
-        "extends": [
-            "eslint:recommended",
-            "plugin:@typescript-eslint/recommended",
-            "plugin:@typescript-eslint/strict",
-            "plugin:unicorn/recommended",
-            "plugin:prettier/recommended"
-        ],
-        "plugins": [
-            "prettier",
-            "check-file",
-            "simple-import-sort",
-            "unused-imports"
-        ],
-        "rules": {
-            "unused-imports/no-unused-imports": "warn",
-            "unicorn/prevent-abbreviations": [
-                "error",
-                {
-                    "replacements": {
-                        "props": false,
-                        "prop": false,
-                        "ref": false,
-                        "args": false,
-                        "arg": false,
-                        "src": false,
-                        "dev": false,
-                        "str": false,
-                        "req": false,
-                        "res": false
-                    }
-                }
-            ],
-            "@typescript-eslint/no-non-null-assertion": "error",
-            "unicorn/no-nested-ternary": "off",
-            "unicorn/no-array-for-each": "off",
-            "unicorn/no-useless-undefined": "off",
-            "unicorn/no-null": "off",
-            "eqeqeq": [
-                "error",
-                "always"
-            ],
-            "no-alert": "error",
-            "no-eval": "error",
-            "prettier/prettier": "warn",
-            "simple-import-sort/imports": [
-                "error",
-                {
-                    "groups": [
-                        [
-                            "^react$"
-                        ],
-                        [
-                            "^react"
-                        ],
-                        [
-                            "^next"
-                        ],
-                        [
-                            "^zod"
-                        ],
-                        [
-                            "^@radix-ui/"
-                        ],
-                        [
-                            "^[^.]"
-                        ],
-                        [
-                            "@/components/ui/.*"
-                        ],
-                        [
-                            "@/components/.*"
-                        ],
-                        [
-                            "@/config/.*"
-                        ],
-                        [
-                            "@/lib/.*"
-                        ],
-                        [
-                            "^\\.\\.(?!/?$)",
-                            "^\\.\\./?$"
-                        ],
-                        [
-                            "^\\./(?=.*/)(?!/?$)",
-                            "^\\.(?!/?$)",
-                            "^\\./?$"
-                        ],
-                        [
-                            "^.+\\.s?css$"
-                        ]
-                    ]
-                }
-            ],
-            "check-file/no-index": "off",
-            "check-file/filename-naming-convention": [
-                "error",
-                {
-                    "**/*.{jsx,tsx}": "KEBAB_CASE",
-                    "**/*.{js,ts}": "KEBAB_CASE"
-                },
-                {
-                    "ignoreMiddleExtensions": true
-                }
-            ],
-            "check-file/filename-blocklist": [
-                "error",
-                {
-                    "**/*.spec.js": "*.test.js",
-                    "**/*.spec.jsx": "*.test.jsx",
-                    "**/*.spec.ts": "*.test.ts",
-                    "**/*.spec.tsx": "*.test.tsx"
-                }
-            ],
-            "no-restricted-syntax": [
-                "error",
-                {
-                    "selector": "TSEnumDeclaration",
-                    "message": "Prefer string unions to enums."
-                }
-            ],
-            "curly": [
-                "error",
-                "multi-line"
-            ],
-            "@typescript-eslint/consistent-type-definitions": [
-                "error",
-                "type"
-            ],
-            "@typescript-eslint/no-unused-vars": [
-                "warn",
-                {
-                    "argsIgnorePattern": "^_",
-                    "varsIgnorePattern": "^_"
-                }
-            ],
-            "@typescript-eslint/no-explicit-any": "warn"
-        },
-        "ignorePatterns": [
-            "node_modules",
-            "out",
-            "build",
-            "dist",
-            "coverage",
-            "tests",
-            "rollup.config.mjs",
-            "examples"
-        ]
-    },
-    "jest": {
-        "collectCoverage": true,
-        "collectCoverageFrom": [
-            "src/**/*.ts"
-        ],
-        "coverageReporters": [
-            "lcov",
-            "text-summary"
-        ],
-        "preset": "ts-jest",
-        "restoreMocks": true,
-        "setupFiles": [],
-        "testMatch": [
-            "**/tests/*.test.ts"
-        ],
-        "testTimeout": 100000
-    },
-    "prettier": {
-        "printWidth": 160,
-        "semi": true,
-        "singleQuote": true,
-        "tabWidth": 4,
-        "trailingComma": "all"
-    }
+  "name": "@openfin/cloud-interop-core-api",
+  "version": "0.0.1-alpha.f6523ef",
+  "type": "module",
+  "description": "",
+  "main": "./index.cjs",
+  "browser": "./index.mjs",
+  "types": "./bundle.d.ts",
+  "author": "",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "optionalDependencies": {
+    "@rollup/rollup-linux-x64-gnu": "*"
+  },
+  "dependencies": {
+    "mqtt": "^5.3.1",
+    "zod": "^3.24.2"
+  }
 }

package/dist/api.d.ts

@@ -1,59 +0,0 @@
-import { AppIdentifier, AppIntent, IntentResult } from '@openfin/shared-utils';
-import mqtt from 'mqtt';
-import { CloudInteropSettings, ConnectParameters, CreateSessionResponse } from './interfaces/connect.interface';
-import { EventMap, RaiseIntentAPIOptions, StartIntentDiscoveryOptions } from './interfaces';
-/**
- * Represents a single connection to a Cloud Interop service
- *
- * @export
- * @class CloudInteropAPI
- * @implements {Client}
- */
-export declare class CloudInteropAPI {
-    #private;
-    constructor(cloudInteropSettings: CloudInteropSettings);
-    get sessionDetails(): CreateSessionResponse | undefined;
-    get mqttClient(): mqtt.MqttClient | undefined;
-    /**
-     * Connects and creates a session on the Cloud Interop service
-     *
-     * @param {ConnectParameters} parameters - The parameters to use to connect
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during connection
-     * @throws {AuthorizationError} - If the connection is unauthorized
-     */
-    connect(parameters: ConnectParameters): Promise<void>;
-    /**
-     * Disconnects from the Cloud Interop service
-     *
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during disconnection
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Publishes a new context for the given context group to the other connected sessions
-     *
-     * @param {string} contextGroup - The context group to publish to
-     * @param {object} context - The context to publish
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     */
-    setContext(contextGroup: string, context: object): Promise<void>;
-    /**
-     * Starts an intent discovery operation
-     *
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
-     */
-    startIntentDiscovery(options: StartIntentDiscoveryOptions): Promise<void>;
-    raiseIntent(options: RaiseIntentAPIOptions): Promise<void>;
-    reportAppIntents(discoveryId: string, intents: AppIntent[]): Promise<boolean>;
-    sendIntentResult(initiatingSessionId: string, result: IntentResult): Promise<void>;
-    parseSessionId(appId: AppIdentifier | string): string;
-    addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
-    removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
-    once<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
-}

package/dist/controllers/event.controller.d.ts

@@ -1,8 +0,0 @@
-import { EventMap } from '../interfaces';
-export declare class EventController {
-    #private;
-    addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
-    removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
-    once<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
-    emitEvent<K extends keyof EventMap>(type: K, ...args: Parameters<EventMap[K]>): void;
-}

package/dist/controllers/index.d.ts

@@ -1,2 +0,0 @@
-export * from './event.controller';
-export * from './intent.controller';

package/dist/controllers/intent.controller.d.ts

@@ -1,13 +0,0 @@
-import { AppIntent, CommandMessage, IntentResult } from '@openfin/shared-utils';
-import mqtt from 'mqtt';
-import { CloudInteropLogger, ConnectParameters, CreateSessionResponse, RaiseIntentAPIOptions, StartIntentDiscoveryOptions } from '../interfaces';
-import { EventController } from './event.controller';
-export declare class IntentController {
-    #private;
-    constructor(url: string, mqttClient: mqtt.MqttClient, sessionDetails: CreateSessionResponse, connectionParameters: ConnectParameters, events: EventController, logger: CloudInteropLogger);
-    startIntentDiscovery(options: StartIntentDiscoveryOptions): Promise<void>;
-    raiseIntent({ raiseOptions, appId }: RaiseIntentAPIOptions): Promise<void>;
-    reportAppIntents(discoveryId: string, intents: AppIntent[]): Promise<boolean>;
-    sendIntentResult(initiatingSessionId: string, result: IntentResult): Promise<void>;
-    handleCommandMessage(message: CommandMessage): void;
-}

package/dist/errors/api.error.d.ts

@@ -1,7 +0,0 @@
-export declare class CloudInteropAPIError extends Error {
-    code: string;
-    constructor(message?: string, code?: string, cause?: unknown);
-}
-export declare class AuthorizationError extends CloudInteropAPIError {
-    constructor(message?: string, code?: string);
-}

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-export * from './api';
-export * from './errors/api.error';
-export * from './interfaces/connect.interface';
-export * from './interfaces/event.interface';
-export * from './interfaces/intents.interface';
-export * from '@openfin/shared-utils';