@openfin/cloud-interop-core-api 0.0.1-alpha.e8aa2c9 → 0.0.1-alpha.e96a3d8

package/bundle.d.ts

@@ -51,7 +51,7 @@ declare const appIntentSchema: z.ZodObject<{
         name: string;
         displayName: string;
     }>;
-    apps: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
+    apps: z.ZodArray<z.ZodObject<{
         description: z.ZodOptional<z.ZodString>;
         icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
             size: z.ZodOptional<z.ZodString>;
@@ -88,10 +88,10 @@ declare const appIntentSchema: z.ZodObject<{
         title: z.ZodOptional<z.ZodString>;
         tooltip: z.ZodOptional<z.ZodString>;
         version: z.ZodOptional<z.ZodString>;
-    }, {
+    } & {
         appId: z.ZodString;
         instanceId: z.ZodOptional<z.ZodString>;
-    }>, "strip", z.ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         appId: string;
         instanceId?: string | undefined;
         description?: string | undefined;
@@ -268,7 +268,7 @@ export declare class CloudInteropAPI {
      * @returns {*} {Promise<void>}
      * @memberof CloudInteropAPI
      */
-    setContext(contextGroup: string, context: object): Promise<void>;
+    setContext(contextGroup: string, context: InferredContext): Promise<void>;
     /**
      * Starts an intent discovery operation
      *
@@ -420,6 +420,14 @@ export declare type CreateSessionResponse = {
     sourceId: string;
 };
 
+declare const errorSchema: z.ZodObject<{
+    error: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    error: string;
+}, {
+    error: string;
+}>;
+
 export declare type EventListenersMap = Map<keyof EventMap, Array<(...args: Parameters<EventMap[keyof EventMap]>) => void>>;
 
 export declare type EventMap = {
@@ -545,6 +553,8 @@ declare type HistoryRecord = {
  */
 export declare type InferredContext = z.infer<typeof contextSchema>;
 
+export declare type InferredError = z.infer<typeof errorSchema>;
+
 /**
  * @internal
  */

package/index.cjs

@@ -46,6 +46,8 @@ class EventController {
     }
 }
 
+const isErrorIntentResult = (result) => 'error' in result;
+
 const APP_ID_DELIM = '::';
 const getRequestHeaders = (connectionParameters) => {
     const headers = {};
@@ -72,13 +74,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,13 +85,19 @@ 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 AppIdentifier to extract the appId, sourceId, and sessionId.
  * @returns an object with:
@@ -158,13 +162,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);
@@ -175,10 +184,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) {
@@ -188,10 +195,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),
@@ -200,7 +209,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}`);
@@ -244,6 +252,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',
@@ -580,8 +595,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);

package/index.mjs

@@ -44,6 +44,8 @@ class EventController {
     }
 }
 
+const isErrorIntentResult = (result) => 'error' in result;
+
 const APP_ID_DELIM = '::';
 const getRequestHeaders = (connectionParameters) => {
     const headers = {};
@@ -70,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`
@@ -85,13 +83,19 @@ 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 AppIdentifier to extract the appId, sourceId, and sessionId.
  * @returns an object with:
@@ -156,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);
@@ -173,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) {
@@ -186,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),
@@ -198,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}`);
@@ -242,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',
@@ -578,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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfin/cloud-interop-core-api",
-  "version": "0.0.1-alpha.e8aa2c9",
+  "version": "0.0.1-alpha.e96a3d8",
   "type": "module",
   "description": "",
   "main": "./index.cjs",
@@ -8,11 +8,11 @@
   "types": "./bundle.d.ts",
   "author": "",
   "license": "SEE LICENSE IN LICENSE.md",
+  "dependencies": {
+    "mqtt": "^5.13.0",
+    "zod": "^3.24.4"
+  },
   "optionalDependencies": {
     "@rollup/rollup-linux-x64-gnu": "*"
-  },
-  "dependencies": {
-    "mqtt": "^5.3.1",
-    "zod": "^3.24.1"
   }
 }