@openfin/core 30.73.5 → 30.73.7

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

@@ -1,3 +1,5 @@
+import type * as FDC3v1 from './shapes/fdc3v1';
+import type * as FDC3v2 from './shapes/fdc3v2';
 import { Base } from '../../base';
 import Transport from '../../../transport/transport';
 /**
@@ -164,19 +166,19 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @returns { Promise<AppIdentifier> }
      * @tutorial fdc3.open
      */
-    open(app: FDC3v2.AppIdentifier | FDC3.TargetApp, context?: OpenFin.Context): Promise<FDC3v2.AppIdentifier>;
+    open(app: FDC3v2.AppIdentifier | FDC3v1.TargetApp, context?: FDC3v2.Context): Promise<FDC3v2.AppIdentifier>;
     /**
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial fdc3v2.findInstances
+     * @tutorial findInstances
      */
     findInstances(app: FDC3v2.AppIdentifier): Promise<Array<FDC3v2.AppIdentifier>>;
     /**
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial fdc3v2.getAppMetadata
+     * @tutorial getAppMetadata
      */
     getAppMetadata(app: FDC3v2.AppIdentifier): Promise<FDC3v2.AppMetadata>;
     /**
@@ -185,7 +187,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @returns { Promise<void> }
      * @tutorial fdc3.broadcast
      */
-    broadcast(context: OpenFin.Context): Promise<void>;
+    broadcast(context: FDC3v2.Context): Promise<void>;
     /**
      * Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts. If you wish to listen for all incoming contexts, pass `null` for the contextType argument.
      * @param { string | null } contextType
@@ -193,7 +195,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @returns { Listener }
      * @tutorial fdc3.addContextListener
      */
-    addContextListener(contextType: string | null, handler: FDC3v2.ContextHandler): Promise<FDC3.Listener>;
+    addContextListener(contextType: string | null, handler: FDC3v2.ContextHandler): Promise<FDC3v2.Listener>;
     /**
      * Find out more information about a particular intent by passing its name, and optionally its context and resultType.
      * @param { string } intent Name of the Intent
@@ -202,32 +204,32 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @returns { Promise<AppIntent(2)> }
      * @tutorial fdc3.findIntent
      */
-    findIntent(intent: string, context?: OpenFin.Context, resultType?: string): Promise<FDC3v2.AppIntent>;
+    findIntent(intent: string, context?: FDC3v2.Context, resultType?: string): Promise<FDC3v2.AppIntent>;
     /**
      * Find all the available intents for a particular context.
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial fdc3v2.findIntentsByContext
+     * @tutorial findIntentsByContext
      */
-    findIntentsByContext(context: OpenFin.Context, resultType?: string): Promise<Array<FDC3v2.AppIntent>>;
+    findIntentsByContext(context: FDC3v2.Context, resultType?: string): Promise<Array<FDC3v2.AppIntent>>;
     /**
      * Raises a specific intent for resolution against apps registered with the desktop agent.
      * @param { string } intent Name of the Intent
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3v2.raiseIntent
+     * @tutorial raiseIntent
      */
-    raiseIntent(intent: string, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3v2.IntentResolution>;
+    raiseIntent(intent: string, context: FDC3v2.Context, app?: FDC3v2.AppIdentifier | FDC3v1.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
      * 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 fdc3v2.raiseIntentForContext
+     * @tutorial raiseIntentForContext
      */
-    raiseIntentForContext(context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3v2.IntentResolution>;
+    raiseIntentForContext(context: FDC3v2.Context, app?: FDC3v2.AppIdentifier | FDC3v1.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
      * Adds a listener for incoming intents.
      * @param { string } intent  Name of the Intent
@@ -235,38 +237,38 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @returns { Promise<Listener> }
      * @tutorial fdc3.addIntentListener
      */
-    addIntentListener(intent: string, handler: FDC3v2.IntentHandler): Promise<FDC3.Listener>;
+    addIntentListener(intent: string, handler: FDC3v2.IntentHandler): Promise<FDC3v1.Listener>;
     /**
      * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
      * @param channelId
      * @returns { Promise<Channel> }
      * @tutorial fdc3.getOrCreateChannel
      */
-    getOrCreateChannel(channelId: string): Promise<FDC3.Channel>;
+    getOrCreateChannel(channelId: string): Promise<FDC3v1.Channel>;
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial fdc3v2.createPrivateChannel
+     * @tutorial createPrivateChannel
      */
     createPrivateChannel(): Promise<FDC3v2.PrivateChannel>;
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial fdc3v2.getUserChannels
+     * @tutorial getUserChannels
      */
-    getUserChannels(): Promise<Array<OpenFin.ContextGroupInfo>>;
+    getUserChannels(): Promise<Array<FDC3v1.SystemChannel>>;
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
      * @deprecated Please use {@link fdc3.getUserChannels fdc3.getUserChannels} instead
      * @tutorial fdc3.getSystemChannels
      */
-    getSystemChannels(): Promise<Array<OpenFin.ContextGroupInfo>>;
+    getSystemChannels(): Promise<Array<FDC3v1.SystemChannel>>;
     /**
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial fdc3v2.joinUserChannel
+     * @tutorial joinUserChannel
      */
     joinUserChannel(channelId: string): Promise<void>;
     /**
@@ -281,7 +283,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * Returns the Channel object for the current User channel membership
      * @returns { Promise<FDC3.Channel | null> }
      */
-    getCurrentChannel(): Promise<FDC3.Channel | null>;
+    getCurrentChannel(): Promise<FDC3v1.Channel | null>;
     /**
      * Removes the app from any User channel membership.
      * @returns { Promise<void> }
@@ -290,8 +292,9 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
     leaveCurrentChannel(): Promise<void>;
     /**
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
+     * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial fdc3v2.getInfo
+     * @tutorial getInfo
      */
     getInfo(): Promise<FDC3v2.ImplementationMetadata>;
 }

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

@@ -181,14 +181,14 @@ class Fdc3Module2 extends base_1.Base {
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial fdc3v2.findInstances
+     * @tutorial findInstances
      */
     async findInstances(app) {
         this.wire.sendAction('fdc3-find-instances').catch((e) => {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
         try {
-            return await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3FindInstances', app);
+            return await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3FindInstances', app);
         }
         catch (error) {
             const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3FindInstances ? 'ResolverUnavailable' : error;
@@ -199,14 +199,14 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial fdc3v2.getAppMetadata
+     * @tutorial getAppMetadata
      */
     async getAppMetadata(app) {
         this.wire.sendAction('fdc3-get-app-metadata').catch((e) => {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
         try {
-            return await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3GetAppMetadata', app);
+            return await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3GetAppMetadata', app);
         }
         catch (error) {
             const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3GetAppMetadata ? 'ResolverUnavailable' : error;
@@ -277,7 +277,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial fdc3v2.findIntentsByContext
+     * @tutorial findIntentsByContext
      */
     async findIntentsByContext(context, resultType) {
         this.wire.sendAction('fdc3-find-intents-by-context').catch((e) => {
@@ -285,7 +285,7 @@ class Fdc3Module2 extends base_1.Base {
         });
         const payload = resultType ? { context, metadata: { resultType } } : context;
         try {
-            return await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3v2FindIntentsByContext', payload);
+            return await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3v2FindIntentsByContext', payload);
         }
         catch (error) {
             const errorToThrow = error.message === utils_1.BROKER_ERRORS.getInfoForIntentsByContext ? 'ResolverUnavailable' : error;
@@ -298,14 +298,14 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3v2.raiseIntent
+     * @tutorial raiseIntent
      */
     async 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);
+            return (0, utils_2.getIntentResolution)(this.fin.me.interop, context, app, intent);
         }
         catch (error) {
             const errorToThrow = error.message === utils_1.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error;
@@ -317,7 +317,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3v2.raiseIntentForContext
+     * @tutorial raiseIntentForContext
      */
     async raiseIntentForContext(context, app) {
         // TODO: We have to do the same thing we do for raiseIntent here as well.
@@ -325,7 +325,7 @@ class Fdc3Module2 extends base_1.Base {
             // 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);
+            return (0, utils_2.getIntentResolution)(this.fin.me.interop, context, app);
         }
         catch (error) {
             const errorToThrow = error.message === utils_1.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error;
@@ -362,7 +362,7 @@ class Fdc3Module2 extends base_1.Base {
             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);
+                this.fin.InterApplicationBus.publish(intentResolutionResultId, intentResult);
             }
             if (intentResult instanceof Error) {
                 throw new Error(intentResult.message);
@@ -385,23 +385,28 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial fdc3v2.createPrivateChannel
+     * @tutorial createPrivateChannel
      */
     async createPrivateChannel() {
-        const channelId = utils_1.generateId();
+        const channelId = (0, utils_1.generateId)();
         const channelProvider = await this.fin.InterApplicationBus.Channel.create(channelId);
         const newPrivateChannelProvider = new PrivateChannelProvider_1.PrivateChannelProvider(channelProvider, channelId);
         const channelClient = await this.fin.InterApplicationBus.Channel.connect(channelId);
         const newPrivateChannelClient = new PrivateChannelClient_1.PrivateChannelClient(channelClient, channelId);
-        return utils_2.buildPrivateChannelObject(newPrivateChannelClient);
+        return (0, utils_2.buildPrivateChannelObject)(newPrivateChannelClient);
     }
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial fdc3v2.getUserChannels
+     * @tutorial getUserChannels
      */
     async getUserChannels() {
-        return this.fdc3Module.getSystemChannels();
+        const channels = await this.fin.me.interop.getContextGroups();
+        // fdc3 implementation of getUserChannels returns on array of channels, have to decorate over
+        // this so people know that these APIs are not supported
+        return channels.map((channel) => {
+            return { ...channel, type: 'user', ...(0, utils_2.getUnsupportedChannelApis)('User') };
+        });
     }
     /**
      * Retrieves a list of the User Channels available for the app to join.
@@ -410,13 +415,14 @@ class Fdc3Module2 extends base_1.Base {
      * @tutorial fdc3.getSystemChannels
      */
     async getSystemChannels() {
+        console.warn('This API has been deprecated. Please use fdc3.getUserChannels instead.');
         return this.fdc3Module.getSystemChannels();
     }
     /**
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial fdc3v2.joinUserChannel
+     * @tutorial joinUserChannel
      */
     async joinUserChannel(channelId) {
         return this.fdc3Module.joinChannel(channelId);
@@ -429,6 +435,7 @@ class Fdc3Module2 extends base_1.Base {
      * @tutorial fdc3.joinChannel
      */
     async joinChannel(channelId) {
+        console.warn('This API has been deprecated. Please use fdc3.joinUserChannel instead.');
         return this.fdc3Module.joinChannel(channelId);
     }
     /**
@@ -448,19 +455,12 @@ class Fdc3Module2 extends base_1.Base {
     }
     /**
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
+     * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial fdc3v2.getInfo
+     * @tutorial getInfo
      */
     async getInfo() {
-        try {
-            const result = await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3v2GetInfo', {});
-            const partialInfo = this.fdc3Module.getInfo();
-            return { ...partialInfo, ...result };
-        }
-        catch (error) {
-            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3GetInfo ? 'ResolverUnavailable' : error;
-            throw new Error(errorToThrow);
-        }
+        return InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3v2GetInfo', { fdc3Version: '2.0' });
     }
 }
 exports.default = Fdc3Module2;

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

@@ -0,0 +1,12 @@
+import Fdc3Module from './fdc3-1.2';
+import Fdc3Module2 from './fdc3-2.0';
+import type Transport from '../../../transport/transport';
+import { Fdc3Version } from './versions';
+declare global {
+    interface Window {
+        fdc3: Fdc3Module | Fdc3Module2;
+    }
+}
+export declare const versionMap: Record<Fdc3Version, typeof Fdc3Module | typeof Fdc3Module2>;
+export declare function registerFdc3Shim(version: string, transport: Transport): void;
+export declare function getFdc3(transport: Transport, version?: Fdc3Version): Fdc3Module | Fdc3Module2;

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

@@ -0,0 +1,4 @@
+import * as OpenFin from '../../../OpenFin';
+import { Fdc3Version } from './versions';
+export declare function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }: Awaited<ReturnType<OpenFin.Application['getInfo']>>): Fdc3Version | undefined;
+export declare function overrideCheck(overriddenBroker: OpenFin.InteropBroker, fdc3InteropApi?: Fdc3Version): void;

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.overrideCheck = exports.getDefaultViewFdc3VersionFromAppInfo = void 0;
+const InteropBroker_1 = require("../InteropBroker");
+function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
+    var _a, _b, _c, _d;
+    const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
+    return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
+}
+exports.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
+// TODO: Unit test this
+function overrideCheck(overriddenBroker, fdc3InteropApi) {
+    if (fdc3InteropApi && fdc3InteropApi === '2.0') {
+        const mustOverrideAPIs = [
+            'fdc3HandleFindInstances',
+            'handleInfoForIntent',
+            'handleInfoForIntentsByContext',
+            'fdc3HandleGetAppMetadata',
+            'fdc3HandleGetInfo',
+            'fdc3HandleOpen',
+            'handleFiredIntent',
+            'handleFiredIntentForContext'
+        ];
+        const notOverridden = mustOverrideAPIs.filter((api) => {
+            return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
+        });
+        if (notOverridden.length > 0) {
+            console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
+        }
+    }
+}
+exports.overrideCheck = overrideCheck;

package/src/api/interop/fdc3/shapes/fdc3v1.d.ts

@@ -0,0 +1,53 @@
+import type { DisplayMetadata } from 'fdc3v1/src/api/DisplayMetadata';
+import type { Listener } from 'fdc3v1/src/api/Listener';
+import type { AppMetadata } from 'fdc3v1/src/api/AppMetadata';
+import type { AppIntent } from 'fdc3v1/src/api/AppIntent';
+import type { ImplementationMetadata } from 'fdc3v1/src/api/ImplementationMetadata';
+export type { DisplayMetadata } from 'fdc3v1/src/api/DisplayMetadata';
+export type { Listener } from 'fdc3v1/src/api/Listener';
+export type { AppMetadata } from 'fdc3v1/src/api/AppMetadata';
+export type { AppIntent } from 'fdc3v1/src/api/AppIntent';
+export type { ImplementationMetadata } from 'fdc3v1/src/api/ImplementationMetadata';
+export declare type ContextHandler = (context: Context) => void;
+export declare type TargetApp = string | AppMetadata;
+export interface Context {
+    id?: {
+        [key: string]: string;
+    };
+    name?: string;
+    type: string;
+}
+export interface IntentResolution {
+    source: TargetApp;
+    data?: object;
+    version: string;
+}
+export interface Channel {
+    id: string;
+    type: string;
+    displayMetadata?: DisplayMetadata;
+    broadcast(context: Context): void;
+    getCurrentContext(contextType?: string): Promise<Context | null>;
+    addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
+}
+export declare type SystemChannel = Omit<Channel, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
+    addContextListener(): Error;
+    broadcast(): Error;
+    getCurrentContext(): Error;
+};
+export interface DesktopAgent {
+    open(app: TargetApp, context?: Context): Promise<void>;
+    findIntent(intent: string, context?: Context): Promise<AppIntent>;
+    findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
+    broadcast(context: Context): void;
+    raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
+    raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
+    addIntentListener(intent: string, handler: ContextHandler): Listener;
+    joinChannel(channelId: string): Promise<void>;
+    leaveCurrentChannel(): Promise<void>;
+    getInfo(): ImplementationMetadata;
+    addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
+    getOrCreateChannel(channelId: string): Promise<Channel>;
+    getSystemChannels(): Promise<SystemChannel[]>;
+    getCurrentChannel(): Promise<Channel | null>;
+}

package/src/api/interop/fdc3/shapes/fdc3v1.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable import/no-extraneous-dependencies */
+/* eslint-disable no-restricted-imports */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/interop/fdc3/shapes/fdc3v2.d.ts

@@ -0,0 +1,75 @@
+import * as OpenFin from '../../../../OpenFin';
+import { Channel as ChannelV1, SystemChannel } from './fdc3v1';
+import type { Listener } from 'fdc3v2/src/api/Listener';
+import type { AppIntent } from 'fdc3v2/src/api/AppIntent';
+import type { ImplementationMetadata } from 'fdc3v2/src/api/ImplementationMetadata';
+import type { ContextMetadata } from 'fdc3v2/src/api/ContextMetadata';
+import type { AppIdentifier } from 'fdc3v2/src/api/AppIdentifier';
+import type { AppMetadata } from 'fdc3v2/src/api/AppMetadata';
+import type { DisplayMetadata } from 'fdc3v2/src/api/DisplayMetadata';
+export type { Listener } from 'fdc3v2/src/api/Listener';
+export type { AppIntent } from 'fdc3v2/src/api/AppIntent';
+export type { ImplementationMetadata } from 'fdc3v2/src/api/ImplementationMetadata';
+export type { ContextMetadata } from 'fdc3v2/src/api/ContextMetadata';
+export type { AppIdentifier } from 'fdc3v2/src/api/AppIdentifier';
+export type { AppMetadata } from 'fdc3v2/src/api/AppMetadata';
+export type { DisplayMetadata } from 'fdc3v2/src/api/DisplayMetadata';
+export declare type ContextHandler = (context: Context, metadata?: ContextMetadata) => void;
+export declare type IntentHandler = (context: Context, metadata?: ContextMetadata) => Promise<IntentResult> | void;
+export declare type IntentResult = Context | Channel | PrivateChannel;
+export interface Context {
+    id?: {
+        [key: string]: string;
+    };
+    name?: string;
+    type: string;
+    contextMetadata?: ContextMetadata;
+    metadata?: any;
+}
+export interface Intent {
+    name: string;
+    context: Context;
+    metadata: OpenFin.IntentMetadata;
+}
+export interface IntentResolution {
+    source: AppIdentifier;
+    intent: string;
+    version?: string;
+    getResult(): Promise<IntentResult>;
+}
+export interface Channel {
+    readonly id: string;
+    readonly type: 'user' | 'app' | 'private';
+    readonly displayMetadata?: DisplayMetadata;
+    broadcast(context: Context): Promise<void>;
+    getCurrentContext(contextType?: string): Promise<Context | null>;
+    addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
+}
+export declare type PrivateChannel = Omit<Channel, 'addContextListener'> & {
+    addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
+    onAddContextListener(handler: (contextType?: string) => void): Listener;
+    onUnsubscribe(handler: (contextType?: string) => void): Listener;
+    onDisconnect(handler: () => void): Listener;
+    disconnect(): void;
+};
+export interface DesktopAgent {
+    open(app: AppIdentifier, context?: Context): Promise<AppIdentifier>;
+    findIntent(intent: string, context?: Context, resultType?: string): Promise<AppIntent>;
+    findIntentsByContext(context: Context, resultType?: string): Promise<Array<AppIntent>>;
+    findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
+    broadcast(context: Context): Promise<void>;
+    raiseIntent(intent: string, context: Context, app?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentForContext(context: Context, app?: AppIdentifier): Promise<IntentResolution>;
+    addIntentListener(intent: string, handler: IntentHandler): Promise<Listener>;
+    addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
+    getUserChannels(): Promise<Array<SystemChannel>>;
+    joinUserChannel(channelId: string): Promise<void>;
+    getOrCreateChannel(channelId: string): Promise<ChannelV1>;
+    createPrivateChannel(): Promise<PrivateChannel>;
+    getCurrentChannel(): Promise<ChannelV1 | null>;
+    leaveCurrentChannel(): Promise<void>;
+    getInfo(): Promise<ImplementationMetadata>;
+    getAppMetadata(app: AppIdentifier): Promise<AppMetadata>;
+    getSystemChannels(): Promise<Array<SystemChannel>>;
+    joinChannel(channelId: string): Promise<void>;
+}

package/src/api/interop/fdc3/shapes/fdc3v2.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,6 +1,15 @@
+import type { TargetApp } from './shapes/fdc3v1';
+import type { AppIdentifier, IntentResolution, Channel, PrivateChannel, Context } from './shapes/fdc3v2';
+import type * as OpenFin from '../../../OpenFin';
 import { PrivateChannelClient } from './PrivateChannelClient';
+interface UnsupportedChannelApis {
+    addContextListener(): Error;
+    broadcast(): Error;
+    getCurrentContext(): Error;
+}
+export declare const getUnsupportedChannelApis: (channelType?: string) => UnsupportedChannelApis;
 export declare class UnsupportedChannelApiError extends Error {
-    constructor(apiName: string);
+    constructor(apiName: string, channelType?: string);
 }
 export declare enum ResultError {
     /** Returned if the `IntentHandler` exited without returning a Promise or that
@@ -12,7 +21,8 @@ export declare enum ResultError {
      */
     IntentHandlerRejected = "IntentHandlerRejected"
 }
-export declare const buildPrivateChannelObject: (privateChannelClient: PrivateChannelClient) => FDC3v2.PrivateChannel;
-export declare const buildAppChannelObject: (sessionContextGroup: OpenFin.SessionContextGroup) => FDC3.Channel;
-export declare const connectPrivateChannel: (channelId: string) => Promise<FDC3v2.PrivateChannel>;
-export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp, intent?: string) => Promise<FDC3v2.IntentResolution>;
+export declare const buildPrivateChannelObject: (privateChannelClient: PrivateChannelClient) => PrivateChannel;
+export declare const buildAppChannelObject: (sessionContextGroup: OpenFin.SessionContextGroup) => Channel;
+export declare const connectPrivateChannel: (channelId: string) => Promise<PrivateChannel>;
+export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: Context, app?: AppIdentifier | TargetApp, intent?: string) => Promise<IntentResolution>;
+export {};

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

@@ -1,12 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIntentResolution = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ResultError = exports.UnsupportedChannelApiError = void 0;
+exports.getIntentResolution = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
 const utils_1 = require("../utils");
 const PrivateChannelClient_1 = require("./PrivateChannelClient");
+const getUnsupportedChannelApis = (channelType) => {
+    return {
+        addContextListener: () => {
+            throw new UnsupportedChannelApiError('Channel.addContextListener', channelType);
+        },
+        broadcast: () => {
+            throw new UnsupportedChannelApiError('Channel.broadcast', channelType);
+        },
+        getCurrentContext: () => {
+            throw new UnsupportedChannelApiError('Channel.getCurrentContext', channelType);
+        }
+    };
+};
+exports.getUnsupportedChannelApis = getUnsupportedChannelApis;
 class UnsupportedChannelApiError extends Error {
-    constructor(apiName) {
+    constructor(apiName, channelType = 'System') {
         super(apiName);
-        this.message = `Calling ${apiName} on an instance of a System Channel returned by fdc3.getSystemChannels is not supported. If you would like to use a System Channel, please use fdc3.joinChannel, fdc3.addContextListener, and fdc3.broadcast instead.`;
+        this.message = `Calling ${apiName} on an instance of a ${channelType} Channel returned by fdc3.get${channelType}Channels is not supported. If you would like to use a ${channelType} Channel, please use fdc3.joinChannel, fdc3.addContextListener, and fdc3.broadcast instead.`;
     }
 }
 exports.UnsupportedChannelApiError = UnsupportedChannelApiError;
@@ -21,7 +35,7 @@ var ResultError;
      */
     ResultError["IntentHandlerRejected"] = "IntentHandlerRejected";
 })(ResultError = exports.ResultError || (exports.ResultError = {}));
-exports.buildPrivateChannelObject = (privateChannelClient) => {
+const buildPrivateChannelObject = (privateChannelClient) => {
     let clientDisconnected = false;
     const checkIfClientDisconnected = () => {
         if (clientDisconnected) {
@@ -70,7 +84,8 @@ exports.buildPrivateChannelObject = (privateChannelClient) => {
         }
     };
 };
-exports.buildAppChannelObject = (sessionContextGroup) => {
+exports.buildPrivateChannelObject = buildPrivateChannelObject;
+const buildAppChannelObject = (sessionContextGroup) => {
     return {
         id: sessionContextGroup.id,
         type: 'app',
@@ -95,20 +110,22 @@ exports.buildAppChannelObject = (sessionContextGroup) => {
         }
     };
 };
-exports.connectPrivateChannel = async (channelId) => {
+exports.buildAppChannelObject = buildAppChannelObject;
+const connectPrivateChannel = async (channelId) => {
     try {
         const channelClient = await fin.InterApplicationBus.Channel.connect(channelId);
         const privateChannelClient = new PrivateChannelClient_1.PrivateChannelClient(channelClient, channelId);
-        return exports.buildPrivateChannelObject(privateChannelClient);
+        return (0, exports.buildPrivateChannelObject)(privateChannelClient);
     }
     catch (error) {
         throw new Error(`Private Channel with id: ${channelId} doesn't exist`);
     }
 };
-exports.getIntentResolution = async (interopModule, context, app, intent) => {
+exports.connectPrivateChannel = connectPrivateChannel;
+const 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();
+    const guid = (0, utils_1.generateId)();
     // Promise we'll use in getResult
     const getResultPromise = new Promise((resolve) => {
         fin.InterApplicationBus.subscribe({ uuid: '*' }, guid, (intentResult) => {
@@ -132,12 +149,12 @@ exports.getIntentResolution = async (interopModule, context, app, intent) => {
             if (type && id && typeof id === 'string') {
                 switch (type) {
                     case 'private': {
-                        intentResult = await exports.connectPrivateChannel(id);
+                        intentResult = await (0, exports.connectPrivateChannel)(id);
                         break;
                     }
                     case 'app': {
                         const sessionContextGroup = await interopModule.joinSessionContextGroup(id);
-                        intentResult = exports.buildAppChannelObject(sessionContextGroup);
+                        intentResult = (0, exports.buildAppChannelObject)(sessionContextGroup);
                         break;
                     }
                     default: {
@@ -165,3 +182,4 @@ exports.getIntentResolution = async (interopModule, context, app, intent) => {
     }
     return { ...intentResolutionInfoFromBroker, getResult };
 };
+exports.getIntentResolution = getIntentResolution;

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

@@ -0,0 +1 @@
+export declare type Fdc3Version = '1.2' | '2.0';