@openfin/core 29.72.17 → 29.72.18

package/OpenFin.d.ts

@@ -250,13 +250,13 @@ declare namespace OpenFin {
 
     export type WindowOptions = MutableWindowOptions & ConstWindowOptions;
 
-    export type ViewVisibilityOption = { 
+    export type ViewVisibilityOption = {
         enabled?: boolean;
-    }
+    };
 
-    export type ShowViewOnWindowResizeOptions =  ViewVisibilityOption & {
+    export type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
         paintIntervalMs?: number;
-    }
+    };
 
     export type ViewVisibilityOptions = {
         showViewsOnWindowResize?: ShowViewOnWindowResizeOptions;
@@ -1427,6 +1427,7 @@ declare namespace OpenFin {
     export type IntentMetadata<TargetType = any> = {
         target?: TargetType;
         resultType?: string;
+        intentResolutionResultId?: string;
     };
 
     export type IntentHandler = (intent: OpenFin.Intent) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "29.72.17",
+    "version": "29.72.18",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/api/interop/fdc3/fdc3-2.0.d.ts

@@ -203,7 +203,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3.raiseIntent
+     * @tutorial fdc3v2.raiseIntent
      */
     raiseIntent(intent: string, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
@@ -211,7 +211,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3.raiseIntentForContext
+     * @tutorial fdc3v2.raiseIntentForContext
      */
     raiseIntentForContext(context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**

package/src/api/interop/fdc3/fdc3-2.0.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../../base");
 const utils_1 = require("../utils");
 const InteropClient_1 = require("../InteropClient");
+const utils_2 = require("./utils");
 const fdc3_1_2_1 = require("./fdc3-1.2");
 /**
  * @typedef { object } AppIdentifier
@@ -281,20 +282,39 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3.raiseIntent
+     * @tutorial fdc3v2.raiseIntent
      */
     async raiseIntent(intent, context, app) {
-        return this.fdc3Module.raiseIntent(intent, context, app);
+        this.wire.sendAction('fdc3-raise-intent').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        try {
+            return utils_2.getIntentResolution(this.fin.me.interop, context, app, intent);
+        }
+        catch (error) {
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error;
+            throw new Error(errorToThrow);
+        }
     }
     /**
      * Finds and raises an intent against apps registered with the desktop agent based purely on the type of the context data.
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3.raiseIntentForContext
+     * @tutorial fdc3v2.raiseIntentForContext
      */
     async raiseIntentForContext(context, app) {
-        return this.fdc3Module.raiseIntentForContext(context, app);
+        // TODO: We have to do the same thing we do for raiseIntent here as well.
+        this.wire.sendAction('fdc3-raise-intent-for-context').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        try {
+            return utils_2.getIntentResolution(this.fin.me.interop, context, app);
+        }
+        catch (error) {
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error;
+            throw new Error(errorToThrow);
+        }
     }
     /**
      * Adds a listener for incoming intents.
@@ -307,13 +327,33 @@ class Fdc3Module2 extends base_1.Base {
         this.wire.sendAction('fdc3-add-intent-listener').catch((e) => {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
+        if (typeof intent !== 'string') {
+            throw new Error('First argument must be an Intent name');
+        }
         // The FDC3 Intenter handler only expects the context and contextMetadata to be passed to the handler,
         // so we wrap it here and only pass those paramaters.
-        const contextHandler = (raisedIntent) => {
-            const { context } = raisedIntent;
-            const { contextMetadata, ...rest } = context;
-            const args = contextMetadata ? [{ ...rest }, contextMetadata] : [context, null];
-            handler(...args);
+        const contextHandler = async (raisedIntent) => {
+            const { context, metadata: intentMetadata } = raisedIntent;
+            const { contextMetadata, metadata, ...rest } = context;
+            let intentResult;
+            try {
+                const newContext = metadata ? { metadata, ...rest } : { ...rest };
+                intentResult = await handler(newContext, contextMetadata);
+            }
+            catch (error) {
+                intentResult = error;
+            }
+            const intentResolutionResultId = (intentMetadata === null || intentMetadata === void 0 ? void 0 : intentMetadata.intentResolutionResultId) || (metadata === null || metadata === void 0 ? void 0 : metadata.intentResolutionResultId);
+            if (intentResolutionResultId) {
+                // Send whatever the result is.
+                fin.InterApplicationBus.publish(intentResolutionResultId, intentResult);
+            }
+            if (intentResult instanceof Error) {
+                throw new Error(intentResult.message);
+            }
+            else {
+                return intentResult;
+            }
         };
         return this.fin.me.interop.registerIntentHandler(contextHandler, intent, { fdc3Version: '2.0' });
     }

package/src/api/interop/fdc3/utils.d.ts

@@ -1,3 +1,14 @@
 export declare class UnsupportedChannelApiError extends Error {
     constructor(apiName: string);
 }
+export declare enum ResultError {
+    /** Returned if the `IntentHandler` exited without returning a Promise or that
+     *  Promise was not resolved with a Context or Channel object.
+     */
+    NoResultReturned = "NoResultReturned",
+    /** Returned if the `IntentHandler` function processing the raised intent
+     *  throws an error or rejects the Promise it returned.
+     */
+    IntentHandlerRejected = "IntentHandlerRejected"
+}
+export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp, intent?: string) => Promise<FDC3v2.IntentResolution>;

package/src/api/interop/fdc3/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnsupportedChannelApiError = void 0;
+exports.getIntentResolution = exports.ResultError = exports.UnsupportedChannelApiError = void 0;
+const utils_1 = require("../utils");
 class UnsupportedChannelApiError extends Error {
     constructor(apiName) {
         super(apiName);
@@ -8,3 +9,55 @@ class UnsupportedChannelApiError extends Error {
     }
 }
 exports.UnsupportedChannelApiError = UnsupportedChannelApiError;
+var ResultError;
+(function (ResultError) {
+    /** Returned if the `IntentHandler` exited without returning a Promise or that
+     *  Promise was not resolved with a Context or Channel object.
+     */
+    ResultError["NoResultReturned"] = "NoResultReturned";
+    /** Returned if the `IntentHandler` function processing the raised intent
+     *  throws an error or rejects the Promise it returned.
+     */
+    ResultError["IntentHandlerRejected"] = "IntentHandlerRejected";
+})(ResultError = exports.ResultError || (exports.ResultError = {}));
+exports.getIntentResolution = async (interopModule, context, app, intent) => {
+    // Generate an ID to make a session context group with. We will pass that ID to the Broker.
+    // The broker will then setContext on that session context group later with our Intent Result,
+    const guid = utils_1.generateId();
+    // Promise we'll use in getResult
+    const getResultPromise = new Promise((resolve) => {
+        fin.InterApplicationBus.subscribe({ uuid: '*' }, guid, (intentResult) => {
+            resolve(intentResult);
+        });
+    });
+    // Adding the intentResolutionResultId to the intentObj. Because fireIntent only accepts a single arg, we have to slap it in here.
+    const metadata = app ? { target: app, intentResolutionResultId: guid } : { intentResolutionResultId: guid };
+    const intentObj = intent ? { name: intent, context, metadata } : { ...context, metadata };
+    // Set up the getResult call.
+    const getResult = async () => {
+        const intentResult = await getResultPromise;
+        if (!intentResult) {
+            throw new Error(ResultError.NoResultReturned);
+        }
+        if (intentResult instanceof Error) {
+            throw new Error(ResultError.IntentHandlerRejected);
+        }
+        return intentResult;
+    };
+    // Finally fire the intent.
+    const intentResolutionInfoFromBroker = intent
+        ? await interopModule.fireIntent(intentObj)
+        : await interopModule.fireIntentForContext(intentObj);
+    if (typeof intentResolutionInfoFromBroker !== 'object') {
+        return {
+            source: {
+                appId: '',
+                instanceId: ''
+            },
+            intent: '',
+            version: '2.0',
+            getResult
+        };
+    }
+    return { ...intentResolutionInfoFromBroker, getResult };
+};

package/src/api/interop/utils.js

@@ -45,7 +45,7 @@ exports.BROKER_ERRORS = {
 exports.wrapIntentHandler = (handler, handlerId) => {
     return async (intent) => {
         try {
-            await handler(intent);
+            return handler(intent);
         }
         catch (error) {
             console.error(`Error thrown by handler ${handlerId}: ${error}`);