@openfin/core 29.73.4 → 29.73.7

package/src/OpenFin.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const snapshot_source_1 = require("./api/snapshot-source");
+const window_1 = require("./api/window");

package/src/api/events/system.d.ts

@@ -10,13 +10,28 @@ export declare type MonitorEvent<Topic, Type> = OpenFin.MonitorInfo & BaseEvent<
 export interface SessionChangedEvent<Topic, Type> extends BaseEvent<Topic, Type> {
     reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
 }
-export interface SystemEventMapping<Topic = string, Type = string> extends BaseEventMap {
+export declare type SystemEventMapping<Topic = string, Type = string> = BaseEventMap & {
     'application-created': ApplicationEvent<Topic, Type>;
     'desktop-icon-clicked': ApplicationEvent<Topic, Type>;
     'idle-state-changed': IdleEvent<Topic, Type>;
     'monitor-info-changed': MonitorEvent<Topic, Type>;
     'session-changed': SessionChangedEvent<Topic, Type>;
-}
+};
+export declare type WithId<T extends AppVersionEventNames> = `${T}.${string}`;
+export declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
+declare type AppVersionEventNames = OpenFin.AppVersionEvents['type'];
+declare type IdEventNames = WithId<AppVersionEventNames>;
+export declare type AppVersionTypeFromIdEvent<T extends IdEventNames> = Extract<OpenFin.AppVersionEvents, {
+    type: WithoutId<T>;
+}>;
+export declare type AppVersionEventsWithId = {
+    [key in IdEventNames]: Omit<AppVersionTypeFromIdEvent<key>, 'type'> & {
+        type: key;
+        topic: 'system';
+        appVersionId: string;
+    };
+};
 export declare type SystemEvents = PropagatedWindowEvents<'system'> & PropagatedApplicationEvents<'system'> & PropagatedViewEvents<'system'> & {
     [Type in keyof SystemEventMapping]: SystemEventMapping<'system', Type>[Type];
-};
+} & AppVersionEventsWithId;
+export {};

package/src/api/events/typedEventEmitter.d.ts

@@ -0,0 +1,13 @@
+export declare type Listener<T extends {
+    type: string;
+}> = (payload: T) => void;
+export interface TypedEventEmitter<Events extends {
+    type: string;
+}> {
+    on<Event extends Events>(event: Event['type'], listener: Listener<Event>): this;
+    once<Event extends Events>(event: Event['type'], listener: Listener<Event>): this;
+    addListener<Event extends Events>(event: Event['type'], listener: Listener<Event>): this;
+    removeListener<Event extends Events>(event: Event['type'], listener: Listener<Event>): this;
+    removeAllListeners<Event extends Events>(event?: Event['type']): this;
+    emit<Event extends Events>(event: Event['type'], payload: Event): boolean;
+}

package/src/api/events/typedEventEmitter.js

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

package/src/api/interop/Factory.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../base");
 const InteropBroker_1 = require("./InteropBroker");
 const InteropClient_1 = require("./InteropClient");
+const overrideCheck_1 = require("./fdc3/overrideCheck");
 const defaultOverride = (Class, ...args) => new Class(...args);
 /**
  * @typedef { object } InteropConfig
@@ -38,7 +39,9 @@ class InteropModule extends base_1.Base {
             }
             return provider;
         };
-        return override(InteropBroker_1.InteropBroker, this.wire, getProvider, options.initialOptions.interopBrokerConfiguration);
+        const broker = await override(InteropBroker_1.InteropBroker, this.wire, getProvider, options.initialOptions.interopBrokerConfiguration);
+        (0, overrideCheck_1.overrideCheck)(broker, (0, overrideCheck_1.getDefaultViewFdc3VersionFromAppInfo)(options));
+        return broker;
     }
     /**
      * Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.

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

@@ -1,3 +1,5 @@
+import { TargetApp } from './fdc3/shapes/fdc3v1';
+import { AppIdentifier } from './fdc3/shapes/fdc3v2';
 import { Base } from '../base';
 import type Transport from '../../transport/transport';
 import Identity = OpenFin.Identity;
@@ -356,23 +358,23 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
      */
     fdc3HandleOpen({ app, context }: {
-        app: FDC3.TargetApp | FDC3v2.AppIdentifier;
+        app: TargetApp | AppIdentifier;
         context: OpenFin.Context;
-    }, clientIdentity: OpenFin.ClientIdentity): Promise<void | FDC3v2.AppIdentifier>;
+    }, clientIdentity: OpenFin.ClientIdentity): Promise<void | AppIdentifier>;
     /**
      * Responsible for resolving the fdc3.findInstances call.
      * Must be overridden
      * @param { AppIdentifier(2) }  app AppIdentifier that was passed to fdc3.findInstances
      * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
      */
-    fdc3HandleFindInstances(app: FDC3v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    fdc3HandleFindInstances(app: AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
      * Responsible for resolving the fdc3.getAppMetadata call.
      * Must be overridden
      * @param { AppIdentifier(2) } app AppIdentifier that was passed to fdc3.getAppMetadata
      * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
      */
-    fdc3HandleGetAppMetadata(app: FDC3v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    fdc3HandleGetAppMetadata(app: AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
      * This function is called by the Interop Broker whenever a Context handler would fire.
      * For FDC3 2.0 you would need to override this function and add the contextMetadata as
@@ -413,7 +415,7 @@ export declare class InteropBroker extends Base {
      * FDC3 2.0: Use the endpointId in the ClientInfo as the instanceId when generating
      * an AppIdentifier.
      * @return { Promise<Array<ClientInfo>> }
-     * @tutorial interop.getAllClientInfo()
+     * @tutorial interop.getAllClientInfo
      */
     getAllClientInfo(): Promise<Array<OpenFin.ClientInfo>>;
     decorateSnapshot(snapshot: OpenFin.Snapshot): OpenFin.Snapshot;

package/src/api/interop/InteropBroker.js

@@ -198,6 +198,7 @@ let contextGroups = [
  */
 class InteropBroker extends base_1.Base {
     constructor(wire, getProvider, options) {
+        // Tip from Pierre and Michael from the overrideCheck work: Don't use bound methods for overrideable InteropBroker functions.
         super(wire);
         this.getProvider = getProvider;
         this.interopClients = new Map();
@@ -746,7 +747,7 @@ class InteropBroker extends base_1.Base {
      * FDC3 2.0: Use the endpointId in the ClientInfo as the instanceId when generating
      * an AppIdentifier.
      * @return { Promise<Array<ClientInfo>> }
-     * @tutorial interop.getAllClientInfo()
+     * @tutorial interop.getAllClientInfo
      */
     async getAllClientInfo() {
         const provider = await this.getProvider();

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

@@ -1,17 +1,18 @@
+import type { Listener, Context, ContextHandler } from './shapes/fdc3v2';
 declare type HandlerId = string;
 export declare class PrivateChannelClient {
     id: string;
     client: OpenFin.ChannelClient;
-    listeners: Map<HandlerId, FDC3v2.Listener>;
+    listeners: Map<HandlerId, Listener>;
     constructor(client: OpenFin.ChannelClient, id: string);
-    broadcast(context: OpenFin.Context): Promise<void>;
-    getCurrentContext(contextType?: string): Promise<OpenFin.Context | null>;
-    addContextListener(contextType: string | null, handler: OpenFin.ContextHandler): Promise<FDC3v2.Listener>;
+    broadcast(context: Context): Promise<void>;
+    getCurrentContext(contextType?: string): Promise<Context | null>;
+    addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
     private createNonStandardUnsubscribeCb;
     private createContextUnsubscribeCb;
-    onAddContextListener(handler: (contextType?: string) => void): FDC3v2.Listener;
-    onDisconnect(handler: () => void): FDC3v2.Listener;
-    onUnsubscribe(handler: (contextType?: string) => void): FDC3v2.Listener;
+    onAddContextListener(handler: (contextType?: string) => void): Listener;
+    onDisconnect(handler: () => void): Listener;
+    onUnsubscribe(handler: (contextType?: string) => void): Listener;
     disconnect(): Promise<void>;
 }
 export {};

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

@@ -1,3 +1,4 @@
+import * as FDC3v1 from './shapes/fdc3v1';
 import { Base } from '../../base';
 /**
  * @typedef { object } Listener
@@ -88,7 +89,7 @@ import { Base } from '../../base';
  * }
  * ```
  */
-export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
+export default class Fdc3Module extends Base implements FDC3v1.DesktopAgent {
     /**
      * 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 - The type of context you wish to handle.
@@ -97,7 +98,7 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
      * @tutorial fdc3.addContextListener
      * @static
      */
-    addContextListener(contextType: string | null, handler: OpenFin.ContextHandler): FDC3.Listener & Promise<FDC3.Listener>;
+    addContextListener(contextType: string | null, handler: FDC3v1.ContextHandler): FDC3v1.Listener & Promise<FDC3v1.Listener>;
     /**
      * Broadcasts a context for the channel of the current entity.
      * @param { Context } context - New context to set.
@@ -105,14 +106,14 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
      * @tutorial fdc3.broadcast
      * @static
      */
-    broadcast(context: OpenFin.Context): Promise<void>;
+    broadcast(context: FDC3v1.Context): Promise<void>;
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join.
      * @returns { Promise<Channel[]>}
      * @tutorial fdc3.getSystemChannels
      * @static
      */
-    getSystemChannels(): Promise<OpenFin.ContextGroupInfo[]>;
+    getSystemChannels(): Promise<FDC3v1.SystemChannel[]>;
     /**
      * Join all Interop Clients at the given identity to context group `contextGroupId`.
      * If no target is specified, it adds the sender to the context group.
@@ -141,7 +142,7 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
      * @tutorial fdc3.addIntentListener
      * @static
      */
-    addIntentListener(intent: string, handler: OpenFin.ContextHandler): FDC3.Listener & Promise<FDC3.Listener>;
+    addIntentListener(intent: string, handler: FDC3v1.ContextHandler): FDC3v1.Listener & Promise<FDC3v1.Listener>;
     /**
      * Raises a specific intent.
      * @param { string } intent Name of the Intent.
@@ -151,13 +152,13 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
      * @tutorial fdc3.raiseIntent
      * @static
      */
-    raiseIntent(intent: string, context: OpenFin.Context, app?: FDC3.TargetApp): Promise<FDC3.IntentResolution>;
+    raiseIntent(intent: string, context: FDC3v1.Context, app?: FDC3v1.TargetApp): Promise<FDC3v1.IntentResolution>;
     /**
      * Returns the Channel that the entity is subscribed to. Returns null if not joined to a channel.
      * @returns { Channel | null }
      * @tutorial fdc3.getCurrentChannel
      */
-    getCurrentChannel(): Promise<FDC3.Channel | null>;
+    getCurrentChannel(): Promise<FDC3v1.Channel | null>;
     /**
      * Find out more information about a particular intent by passing its name, and optionally its context.
      * @param { string } intent Name of the Intent
@@ -165,14 +166,14 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
      * @return { Promise<AppIntent> }
      * @tutorial fdc3.findIntent
      */
-    findIntent(intent: string, context?: OpenFin.Context): Promise<FDC3.AppIntent>;
+    findIntent(intent: string, context?: FDC3v1.Context): Promise<FDC3v1.AppIntent>;
     /**
      * Find all the available intents for a particular context.
      * @param { Context } context
      * @return { Promise<Array<AppIntent>> }
      * @tutorial fdc3.findIntentsByContext
      */
-    findIntentsByContext(context: OpenFin.Context): Promise<Array<FDC3.AppIntent>>;
+    findIntentsByContext(context: FDC3v1.Context): Promise<Array<FDC3v1.AppIntent>>;
     /**
      * Finds and raises an intent against a target app based purely on context data.
      * @param { Context } context
@@ -180,20 +181,20 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
      * @return { Promise<IntentResolution> }
      * @tutorial fdc3.raiseIntentForContext
      */
-    raiseIntentForContext(context: OpenFin.Context, app?: FDC3.TargetApp): Promise<FDC3.IntentResolution>;
+    raiseIntentForContext(context: FDC3v1.Context, app?: FDC3v1.TargetApp): Promise<FDC3v1.IntentResolution>;
     /**
      * 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 metadata relating to the FDC3 object and its provider, including the supported version of the FDC3 specification and the name of the provider of the implementation.
      * @return { Promise<ImplementationMetadata> }
      * @tutorial fdc3.getInfo
      */
-    getInfo(): FDC3.ImplementationMetadata;
+    getInfo(): FDC3v1.ImplementationMetadata;
     /**
      * Launches an app with target information, which can either be a string or an AppMetadata object.
      * @param { TargetApp } app
@@ -201,7 +202,7 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
      * @return { Promise<void> }
      * @tutorial fdc3.open
      */
-    open(app: FDC3.TargetApp, context?: OpenFin.Context): Promise<void>;
+    open(app: FDC3v1.TargetApp, context?: FDC3v1.Context): Promise<void>;
     private getCurrentContextGroupInfo;
     private buildChannelObject;
 }

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

@@ -1,3 +1,5 @@
+import * as FDC3v1 from './shapes/fdc3v1';
+import * 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> }
@@ -292,7 +294,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * 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,7 +181,7 @@ 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) => {
@@ -199,7 +199,7 @@ 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) => {
@@ -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) => {
@@ -298,7 +298,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.raiseIntent
+     * @tutorial raiseIntent
      */
     async raiseIntent(intent, context, app) {
         this.wire.sendAction('fdc3-raise-intent').catch((e) => {
@@ -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.
@@ -385,7 +385,7 @@ 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 = (0, utils_1.generateId)();
@@ -398,7 +398,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial fdc3v2.getUserChannels
+     * @tutorial getUserChannels
      */
     async getUserChannels() {
         const channels = await this.fin.me.interop.getContextGroups();
@@ -422,7 +422,7 @@ class Fdc3Module2 extends base_1.Base {
      * 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);
@@ -457,7 +457,7 @@ 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() {
         return InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3v2GetInfo', { fdc3Version: '2.0' });

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 });