@openfin/node-adapter 34.78.19 → 34.78.20

package/out/node-adapter.d.ts

@@ -1,9 +1,8 @@
 /// <reference types="jquery" />
 /// <reference types="node" />
 
-import { AppIdentifier } from 'fdc3v2/dist/api/AppIdentifier';
-import type { AppMetadata } from 'fdc3v1/dist/api/AppMetadata';
 import { EventEmitter } from 'events';
+import type * as GoldenLayout from '@openfin/golden-layout';
 
 /**
  * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
@@ -138,6 +137,31 @@ declare type AppAssetRequest = {
     alias: string;
 };
 
+declare interface AppIdentifier {
+    /** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
+    readonly appId: string;
+    /** An optional instance identifier, indicating that this object represents a specific instance of the application described. */
+    readonly instanceId?: string;
+}
+
+/**
+ * An interface that relates an intent to apps
+ */
+declare interface AppIntent {
+    readonly intent: IntentMetadata;
+    readonly apps: Array<AppMetadata>;
+}
+
+/**
+ * An interface that relates an intent to apps
+ */
+declare interface AppIntent_2 {
+    /** Details of the intent whose relationship to resolving applications is being described. */
+    readonly intent: IntentMetadata_2;
+    /** Details of applications that can resolve the intent. */
+    readonly apps: Array<AppMetadata_2>;
+}
+
 /**
  * An object representing an application. Allows the developer to create,
  * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
@@ -1353,6 +1377,60 @@ declare type ApplySnapshotPayload = {
     options?: ApplySnapshotOptions;
 };
 
+/**
+ * App definition as provided by the application directory
+ */
+declare interface AppMetadata {
+    /** The unique app name that can be used with the open and raiseIntent calls. */
+    readonly name: string;
+    /** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
+    readonly appId?: string;
+    /** The Version of the application. */
+    readonly version?: string;
+    /** A more user-friendly application title that can be used to render UI elements  */
+    readonly title?: string;
+    /**  A tooltip for the application that can be used to render UI elements */
+    readonly tooltip?: string;
+    /** A longer, multi-paragraph description for the application that could include markup */
+    readonly description?: string;
+    /** A list of icon URLs for the application that can be used to render UI elements */
+    readonly icons?: Array<string>;
+    /** A list of image URLs for the application that can be used to render UI elements */
+    readonly images?: Array<string>;
+}
+
+/**
+ * Extends an `AppIdentifier`, describing an application or instance of an application, with additional descriptive metadata that is usually provided by an FDC3 App Directory that the desktop agent connects to.
+ *
+ * The additional information from an app directory can aid in rendering UI elements, such as a launcher menu or resolver UI. This includes a title, description, tooltip and icon and screenshot URLs.
+ *
+ * Note that as `AppMetadata` instances are also `AppIdentifiers` they may be passed to the `app` argument of `fdc3.open`, `fdc3.raiseIntent` etc.
+ */
+declare interface AppMetadata_2 extends AppIdentifier {
+    /**
+     The 'friendly' app name.
+     This field was used with the `open` and `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier` wth `appId` set.
+     Note that for display purposes the `title` field should be used, if set, in preference to this field.
+     */
+    readonly name?: string;
+    /** The Version of the application. */
+    readonly version?: string;
+    /** An optional set of, implementation specific, metadata fields that can be used to disambiguate instances, such as a window title or screen position. Must only be set if `instanceId` is set. */
+    readonly instanceMetadata?: Record<string, any>;
+    /** A more user-friendly application title that can be used to render UI elements  */
+    readonly title?: string;
+    /**  A tooltip for the application that can be used to render UI elements */
+    readonly tooltip?: string;
+    /** A longer, multi-paragraph description for the application that could include markup */
+    readonly description?: string;
+    /** A list of icon URLs for the application that can be used to render UI elements */
+    readonly icons?: Array<Icon>;
+    /** Images representing the app in common usage scenarios that can be used to render UI elements  */
+    readonly screenshots?: Array<Image_2>;
+    /** The type of output returned for any intent specified during resolution. May express a particular context type (e.g. "fdc3.instrument"), channel (e.g. "channel") or a channel that will receive a specified type (e.g. "channel<fdc3.instrument>"). */
+    readonly resultType?: string | null;
+}
+
 /**
  * @interface
  */
@@ -2035,7 +2113,25 @@ declare class Channel extends EmitterBase<ChannelEvent> {
 
 declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
 
-declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
+declare interface Channel_3 {
+    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>;
+}
+
+declare interface Channel_4 {
+    readonly id: string;
+    readonly type: 'user' | 'app' | 'private';
+    readonly displayMetadata?: DisplayMetadata_2;
+    broadcast(context: Context_2): Promise<void>;
+    getCurrentContext(contextType?: string): Promise<Context_2 | null>;
+    addContextListener(contextType: string | null, handler: ContextHandler_2): Listener_2 & Promise<Listener_2>;
+}
+
+declare type Channel_5 = OpenFin.Fin['InterApplicationBus']['Channel'];
 
 declare type ChannelAction = OpenFin.ChannelAction;
 
@@ -3539,12 +3635,26 @@ declare type ContentNavigation = NavigationRules;
  */
 declare type ContentRedirect = NavigationRules;
 
+declare interface Context {
+    id?: { [key: string]: string };
+    name?: string;
+    type: string;
+}
+
+declare interface Context_2 {
+    id?: { [key: string]: string };
+    name?: string;
+    type: string;
+    contextMetadata?: ContextMetadata;
+    metadata?: any;
+}
+
 /**
  * Data passed between entities and applications.
  *
  * @interface
  */
-declare type Context = {
+declare type Context_3 = {
     /**
      * An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
      */
@@ -3564,7 +3674,7 @@ declare type Context = {
 /**
  * @interface
  */
-declare type ContextForIntent<MetadataType = any> = Context & {
+declare type ContextForIntent<MetadataType = any> = Context_3 & {
     metadata?: MetadataType;
 };
 
@@ -3580,19 +3690,23 @@ declare type ContextGroupInfo = {
     /**
      * Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
      */
-    displayMetadata?: DisplayMetadata;
+    displayMetadata?: DisplayMetadata_3;
 };
 
 declare type ContextGroupStates = {
     [key: string]: {
-        [key: string]: Context;
+        [key: string]: Context_3;
     };
 };
 
+declare type ContextHandler = (context: Context) => void;
+
+declare type ContextHandler_2 = (context: Context_2, metadata?: ContextMetadata) => void;
+
 /**
  * Subscription function for addContextHandler.
  */
-declare type ContextHandler = (context: Context) => void;
+declare type ContextHandler_3 = (context: Context_3) => void;
 
 /**
  * Configure the context menu when right-clicking on a window.
@@ -3631,6 +3745,20 @@ declare type ContextMenuSettings = {
     reload?: boolean;
 };
 
+/**
+ * Metadata relating to a context or intent and context received through the
+ * `addContextListener` and `addIntentListener` functions.
+ *
+ * @experimental Introduced in FDC3 2.0 and may be refined by further changes outside the normal FDC3 versioning policy.
+ */
+declare interface ContextMetadata {
+    /** Identifier for the app instance that sent the context and/or intent.
+     *
+     *  @experimental
+     */
+    readonly source: AppIdentifier;
+}
+
 /**
  * @interface
  */
@@ -3793,6 +3921,45 @@ declare type DefaultDomainSettingsRule = {
     };
 };
 
+declare 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_3>;
+    getSystemChannels(): Promise<SystemChannel[]>;
+    getCurrentChannel(): Promise<Channel_3 | null>;
+}
+
+declare interface DesktopAgent_2 {
+    open(app: AppIdentifier | TargetApp, context?: Context_2): Promise<AppIdentifier>;
+    findIntent(intent: string, context?: Context_2, resultType?: string): Promise<AppIntent_2>;
+    findIntentsByContext(context: Context_2, resultType?: string): Promise<Array<AppIntent_2>>;
+    findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
+    broadcast(context: Context_2): Promise<void>;
+    raiseIntent(intent: string, context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
+    raiseIntentForContext(context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
+    addIntentListener(intent: string, handler: IntentHandler): Promise<Listener_2>;
+    addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
+    getUserChannels(): Promise<Array<SystemChannel>>;
+    joinUserChannel(channelId: string): Promise<void>;
+    getOrCreateChannel(channelId: string): Promise<Channel_4>;
+    createPrivateChannel(): Promise<PrivateChannel>;
+    getCurrentChannel(): Promise<Channel_3 | null>;
+    leaveCurrentChannel(): Promise<void>;
+    getInfo(): Promise<ImplementationMetadata_2>;
+    getAppMetadata(app: AppIdentifier): Promise<AppMetadata_2>;
+    getSystemChannels(): Promise<Array<SystemChannel>>;
+    joinChannel(channelId: string): Promise<void>;
+}
+
 /**
  * Generated when the desktop icon is clicked while it's already running.
  * @interface
@@ -3865,12 +4032,52 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
     type: 'disabled-movement-bounds-changing';
 };
 
+/**
+ * A system channel will be global enough to have a presence across many apps. This gives us some hints
+ * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
+ * this is their meaning.
+ */
+declare interface DisplayMetadata {
+    /**
+     * A user-readable name for this channel, e.g: `"Red"`
+     */
+    readonly name?: string;
+    /**
+     * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
+     */
+    readonly color?: string;
+    /**
+     * A URL of an image that can be used to display this channel
+     */
+    readonly glyph?: string;
+}
+
+/**
+ * A system channel will be global enough to have a presence across many apps. This gives us some hints
+ * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
+ * this is their meaning.
+ */
+declare interface DisplayMetadata_2 {
+    /**
+     * A user-readable name for this channel, e.g: `"Red"`
+     */
+    readonly name?: string;
+    /**
+     * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
+     */
+    readonly color?: string;
+    /**
+     * A URL of an image that can be used to display this channel
+     */
+    readonly glyph?: string;
+}
+
 /**
  * The display data for a context group.
  *
  * @interface
  */
-declare type DisplayMetadata = {
+declare type DisplayMetadata_3 = {
     /**
      * A user-readable name for this context group, e.g: `"Red"`
      */
@@ -4490,6 +4697,13 @@ declare type FaviconUpdatedEvent = NamedEvent & {
     favicons: string[];
 };
 
+declare namespace FDC3 {
+    export {
+        v1,
+        v2
+    }
+}
+
 /**
  * @interface
  */
@@ -4704,8 +4918,8 @@ declare type FindInPageResult = {
 /**
  * @interface
  */
-declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
-    context: Context;
+declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
+    context: Context_3;
     metadata?: MetadataType;
 };
 
@@ -5230,6 +5444,15 @@ declare type HotkeyEvent = BaseViewEvent & {
     type: 'hotkey';
 };
 
+declare interface Icon {
+    /** The icon url */
+    readonly src: string;
+    /** The icon dimension, formatted as `<height>x<width>`. */
+    readonly size?: string;
+    /** Icon media type. If not present the Desktop Agent may use the src file extension. */
+    readonly type?: string;
+}
+
 declare type Identity = OpenFin.Identity;
 
 declare type Identity_2 = OpenFin.Identity;
@@ -5285,6 +5508,17 @@ declare type IdleEvent = {
     isIdle: boolean;
 };
 
+declare interface Image_2 {
+    /** The image url. */
+    readonly src: string;
+    /** The image dimension, formatted as `<height>x<width>`. */
+    readonly size?: string;
+    /** Image media type. If not present the Desktop Agent may use the src file extension. */
+    readonly type?: string;
+    /** Caption for the image. */
+    readonly label?: string;
+}
+
 declare type ImageFormatOptions = {
     format: 'dataURL' | 'png' | 'bmp';
 } | {
@@ -5295,15 +5529,57 @@ declare type ImageFormatOptions = {
     quality?: number;
 };
 
+/**
+ * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
+ */
+declare interface ImplementationMetadata {
+    /** The version number of the FDC3 specification that the implementation provides.
+     *  The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
+     */
+    readonly fdc3Version: string;
+    /** The name of the provider of the FDC3 Desktop Agent Implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
+    readonly provider: string;
+    /** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
+    readonly providerVersion?: string;
+}
+
+/**
+ * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
+ */
+declare interface ImplementationMetadata_2 {
+    /** The version number of the FDC3 specification that the implementation provides.
+     *  The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
+     */
+    readonly fdc3Version: string;
+    /** The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
+    readonly provider: string;
+    /** The version of the provider of the Desktop Agent implementation (e.g. 5.3.0). */
+    readonly providerVersion?: string;
+    /** Metadata indicating whether the Desktop Agent implements optional features of
+     *  the Desktop Agent API.
+     */
+    readonly optionalFeatures: {
+        /** Used to indicate whether the exposure of 'originating app metadata' for
+         *  context and intent messages is supported by the Desktop Agent. */
+        readonly OriginatingAppMetadata: boolean;
+        /** Used to indicate whether the optional `fdc3.joinUserChannel`,
+         *  `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
+         *  the Desktop Agent. */
+        readonly UserChannelMembershipAPIs: boolean;
+    };
+    /** The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`). */
+    readonly appMetadata: AppMetadata_2;
+}
+
 /**
  * @interface
  */
-declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
+declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
     /**
      * Name of the intent to get info for.
      */
     name: string;
-    context?: Context;
+    context?: Context_3;
     metadata?: MetadataType;
 };
 
@@ -5376,10 +5652,16 @@ declare type InstalledApps_2 = {
     [key: string]: InstallationInfo;
 };
 
+declare interface Intent {
+    name: string;
+    context: Context_2;
+    metadata: IntentMetadata_2;
+}
+
 /**
  * Combination of an action and a context that is passed to an application for resolution.
  */
-declare type Intent<MetadataType = IntentMetadata> = {
+declare type Intent_2<MetadataType = IntentMetadata_3> = {
     /**
      * Name of the intent.
      */
@@ -5387,25 +5669,54 @@ declare type Intent<MetadataType = IntentMetadata> = {
     /**
      * Data associated with the intent.
      */
-    context: Context;
+    context: Context_3;
     metadata?: MetadataType;
 };
 
+declare type IntentHandler = (context: Context_2, metadata?: ContextMetadata) => Promise<IntentResult> | void;
+
 /**
  * Subscription function for registerIntentHandler.
  */
-declare type IntentHandler = (intent: Intent) => void;
+declare type IntentHandler_2 = (intent: Intent_2) => void;
 
 /**
- * The type used to describe an intent within the platform.
- * @interface
+ * Intent descriptor
  */
-declare type IntentMetadata<TargetType = any> = {
+declare interface IntentMetadata {
+    /** The unique name of the intent that can be invoked by the raiseIntent call */
+    readonly name: string;
+    /** A friendly display name for the intent that should be used to render UI elements */
+    readonly displayName: string;
+}
+
+declare type IntentMetadata_2<TargetType = any> = {
     target?: TargetType;
     resultType?: string;
     intentResolutionResultId?: string;
 };
 
+/**
+ * The type used to describe an intent within the platform.
+ * @interface
+ */
+declare type IntentMetadata_3<TargetType = any> = FDC3.v2.IntentMetadata<TargetType>;
+
+declare interface IntentResolution {
+    source: TargetApp;
+    data?: object;
+    version: string;
+}
+
+declare interface IntentResolution_2 {
+    source: AppIdentifier;
+    intent: string;
+    version?: string;
+    getResult(): Promise<IntentResult>;
+}
+
+declare type IntentResult = Context_2 | Channel_4 | PrivateChannel;
+
 /**
  * A messaging bus that allows for pub/sub messaging between different applications.
  *
@@ -6010,23 +6321,23 @@ declare class InteropBroker extends Base {
      * @param clientIdentity Identity of the Client making the request.
      */
     fdc3HandleOpen({ app, context }: {
-        app: TargetApp | AppIdentifier;
+        app: FDC3.v1.TargetApp | FDC3.v2.AppIdentifier;
         context: OpenFin.Context;
-    }, clientIdentity: OpenFin.ClientIdentity): Promise<void | AppIdentifier>;
+    }, clientIdentity: OpenFin.ClientIdentity): Promise<void | FDC3.v2.AppIdentifier>;
     /**
      * Responsible for resolving the fdc3.findInstances call.
      * Must be overridden
      * @param app AppIdentifier that was passed to fdc3.findInstances
      * @param clientIdentity Identity of the Client making the request.
      */
-    fdc3HandleFindInstances(app: AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    fdc3HandleFindInstances(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
      * Responsible for resolving the fdc3.getAppMetadata call.
      * Must be overridden
      * @param app AppIdentifier that was passed to fdc3.getAppMetadata
      * @param clientIdentity Identity of the Client making the request.
      */
-    fdc3HandleGetAppMetadata(app: AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    fdc3HandleGetAppMetadata(app: FDC3.v2.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
@@ -7900,7 +8211,21 @@ declare type LayoutRow = LayoutItemConfig & {
  */
 declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
 
-declare type Listener<T extends {
+declare interface Listener {
+    /**
+     * Unsubscribe the listener object.
+     */
+    unsubscribe(): void;
+}
+
+declare interface Listener_2 {
+    /**
+     * Unsubscribe the listener object.
+     */
+    unsubscribe(): void;
+}
+
+declare type Listener_3<T extends {
     type: string;
 }> = (payload: T) => void;
 
@@ -8701,11 +9026,11 @@ declare namespace OpenFin {
         ApplicationOptions,
         InteropBrokerOptions,
         ContextGroupInfo,
-        DisplayMetadata,
+        DisplayMetadata_3 as DisplayMetadata,
         LegacyWinOptionsInAppOptions,
         Snapshot,
         ContextGroupStates,
-        Context,
+        Context_3 as Context,
         MonitorInfo,
         Point,
         PointTopLeft,
@@ -8874,10 +9199,10 @@ declare namespace OpenFin {
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,
-        ContextHandler,
-        Intent,
-        IntentMetadata,
-        IntentHandler,
+        ContextHandler_3 as ContextHandler,
+        Intent_2 as Intent,
+        IntentMetadata_3 as IntentMetadata,
+        IntentHandler_2 as IntentHandler,
         ContentCreationBehaviorNames,
         MatchPattern,
         ContentCreationRule,
@@ -9036,7 +9361,7 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     /**
      * @internal
      */
-    constructor(identity: OpenFin.ApplicationIdentity, channel: Channel_3);
+    constructor(identity: OpenFin.ApplicationIdentity, channel: Channel_5);
     getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient_2>;
     /**
      * Creates a new view and attaches it to a specified target window.
@@ -10793,6 +11118,14 @@ declare type PrintOptions = {
     dpi?: Dpi;
 };
 
+declare type PrivateChannel = Omit<Channel_4, 'addContextListener'> & {
+    addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
+    onAddContextListener(handler: (contextType?: string) => void): Listener_2;
+    onUnsubscribe(handler: (contextType?: string) => void): Listener_2;
+    onDisconnect(handler: () => void): Listener_2;
+    disconnect(): void;
+};
+
 /**
  * Strategy to assign views to process affinity by domain.
  *
@@ -11705,19 +12038,19 @@ declare type SessionContextGroup = {
      * A SessionContextGroup instance method for setting a context in the SessionContextGroup.
      * @param context The Context to be set.
      */
-    setContext: (context: Context) => Promise<void>;
+    setContext: (context: Context_3) => Promise<void>;
     /**
      * A SessionContextGroup instance method for getting the current context of a certain type.
      * @param type The Context Type to get. If not specified the last contextType set would get used.
      */
-    getCurrentContext: (type?: string) => Promise<Context>;
+    getCurrentContext: (type?: string) => Promise<Context_3>;
     /**
      * A SessionContextGroup instance method for adding a handler for context change.
      * @param handler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
      * @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
      *
      */
-    addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
+    addContextHandler: (handler: ContextHandler_3, contextType?: string) => Promise<{
         unsubscribe: () => void;
     }>;
 };
@@ -13470,6 +13803,12 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
 }
 
+declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
+    addContextListener(): Error;
+    broadcast(): Error;
+    getCurrentContext(): Error;
+};
+
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}.  Events are
  *  discriminated by {@link SystemEvent.type | their type}.  Event payloads unique to `System` can be found
@@ -13999,13 +14338,13 @@ declare type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-i
 declare interface TypedEventEmitter<Event extends {
     type: string;
 }, EmitterEventType = Event['type']> {
-    on<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
+    on<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
         type: EventType;
     }>>): this;
-    addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
+    addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
         type: EventType;
     }>>): this;
-    removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
+    removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
         type: EventType;
     }>>): this;
     removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
@@ -14076,6 +14415,48 @@ declare type UserMovementEnabledEvent = NamedEvent & {
     type: 'user-movement-enabled';
 };
 
+declare namespace v1 {
+    export {
+        Listener,
+        AppMetadata,
+        IntentMetadata,
+        AppIntent,
+        DisplayMetadata,
+        ImplementationMetadata,
+        ContextHandler,
+        TargetApp,
+        Context,
+        IntentResolution,
+        Channel_3 as Channel,
+        SystemChannel,
+        DesktopAgent
+    }
+}
+
+declare namespace v2 {
+    export {
+        IntentMetadata_2 as IntentMetadata,
+        AppIdentifier,
+        Listener_2 as Listener,
+        AppIntent_2 as AppIntent,
+        ImplementationMetadata_2 as ImplementationMetadata,
+        ContextMetadata,
+        Icon,
+        Image_2 as Image,
+        AppMetadata_2 as AppMetadata,
+        DisplayMetadata_2 as DisplayMetadata,
+        ContextHandler_2 as ContextHandler,
+        IntentHandler,
+        IntentResult,
+        Context_2 as Context,
+        Intent,
+        IntentResolution_2 as IntentResolution,
+        Channel_4 as Channel,
+        PrivateChannel,
+        DesktopAgent_2 as DesktopAgent
+    }
+}
+
 declare type View = OpenFin.View;
 
 /**