@openfin/node-adapter 34.78.49 → 34.78.51

package/out/node-adapter.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="jquery" />
 /// <reference types="node" />
 
 import { EventEmitter } from 'events';
@@ -43,15 +42,6 @@ declare type Accelerator = {
     zoom: boolean;
 };
 
-/**
- * @interface
- */
-declare type AddLayoutInstanceOptions = {
-    container: HTMLDivElement;
-    layoutName: string;
-    layout: LayoutOptions;
-};
-
 /**
  * @interface
  */
@@ -1746,6 +1736,23 @@ declare type BaseConfig = {
     timeout?: number;
 };
 
+/**
+ * Properties shared by all content creation rules, regardless of context.
+ *
+ * @interface
+ */
+declare type BaseContentCreationRule = {
+    /**
+     * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
+     * behavior should be used
+     */
+    match: MatchPattern[];
+    /**
+     * custom property
+     */
+    data?: unknown;
+};
+
 /**
  * A base OpenFin event.  All OpenFin event payloads extend this type.
  *
@@ -1846,6 +1853,18 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
     type: 'begin-user-bounds-changing';
 };
 
+/**
+ * A rule prescribing content creation that should be blocked.
+ *
+ * @interface
+ */
+declare type BlockedContentCreationRule = BaseContentCreationRule & {
+    /**
+     * Behavior to use when opening matched content.
+     */
+    behavior: 'block';
+};
+
 /**
  * Generated when a WebContents loses focus.
  * @interface
@@ -1893,6 +1912,18 @@ declare type BoundsChangingEvent = BoundsChangeEvent & {
     type: 'bounds-changing';
 };
 
+/**
+ * A rule prescribing content creation in the browser.
+ *
+ * @interface
+ */
+declare type BrowserContentCreationRule = BaseContentCreationRule & {
+    /**
+     * Behavior to use when opening matched content.
+     */
+    behavior: 'browser';
+};
+
 declare interface BrowserWindow {
     /**
      * True if the window has been opened and its GoldenLayout instance initialised.
@@ -3012,7 +3043,7 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
     private messageReceiver;
     private endpointId;
     private providerIdentity;
-    constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
+    constructor(wire: Transport, messageReceiver: MessageReceiver_2, endpointId: string, // Provider endpointId is channelId
     providerIdentity: ProviderIdentity_4);
     onEndpointDisconnect(endpointId: string, listener: () => void): void;
     receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
@@ -3291,6 +3322,16 @@ declare type ClosedMenuResult = {
     result: 'closed';
 };
 
+/**
+ * @interface
+ */
+declare type CloseViewOptions = {
+    /**
+     *View to be closed.
+     */
+    viewIdentity: Identity_5;
+};
+
 /**
  * @interface
  */
@@ -3299,6 +3340,11 @@ declare type CloseViewPayload = {
      *View to be closed.
      */
     view: Identity_5;
+    /**
+     * The target layout identity where this view should be closed. If not provided, will resolve to the
+     * visible layout.
+     */
+    target?: LayoutIdentity;
 };
 
 /**
@@ -3538,12 +3584,23 @@ declare type ConstViewOptions = {
     /**
      * **Platforms Only.**
      * Determines what happens when a view is closed in a platform window.
-     * Supersedes `detachOnClose`, but has no default value.
+     * Supersedes the deprecated `detachOnClose`.
+     * If not set, detaults to `destroy` if `detachOnClose` is false (default), or `detach` if `detachOnClose` is true.
+     * While this option is not updateable, it may change at runtime if `detachOnClose` is updated.
      * 'hide' hides the view on the platform window that closed it.
-     * 'detach' behaves like 'detachOnClose': true.
-     * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
+     * 'detach' behaves like 'detachOnClose': true. It attaches the closed view to the platform provider.
+     * 'destroy' is the default behavior as long as 'detachOnClose' is not set. It destroys the view.
+     */
+    closeBehavior: 'hide' | 'detach' | 'destroy';
+    /**
+     * Controls interaction of the view with its parent window's download shelf.
      */
-    closeBehavior?: 'hide' | 'detach' | 'destroy';
+    downloadShelf?: {
+        /**
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         */
+        enabled: boolean;
+    };
 };
 
 /**
@@ -3655,8 +3712,16 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
+    /**
+     * @experimental
+     *
+     * The collection of layouts to load when the window is created. When launching multiple layouts, manage
+     * the lifecycle via fin.Platform.Layout.create()/destroy() methods.
+     */
+    layoutSnapshot: LayoutSnapshot;
     /**
      * Parent identity of a modal window. It will create a modal child window when this option is set.
      */
@@ -3872,28 +3937,15 @@ declare type ContentCreationOptions = {
  * A rule for creating content in OpenFin; maps a content type to the way in which
  * newly-opened content of that type will be handled.
  *
+ * @remarks This is effectively just a union type discriminated by the `behavior` key.  The generic
+ * parameter is a legacy feature that is included for backwards-compatibility reasons.
  *
- * @interface
+ * @typeParam Behavior The way content governed by this rule will be created.  If provided, this type will narrow to
+ * the specified `behavior` key.
  */
-declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
-    /**
-     * Behavior to use when opening matched content. The value could be 'view' | 'window' | 'browser' | 'block'.
-     */
-    behavior: T;
-    /**
-     * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
-     * behavior should be used
-     */
-    match: MatchPattern[];
-    /**
-     * Options for newly-created view or window (if applicable).
-     */
-    options?: T extends 'window' ? Partial<WindowOptions> : T extends 'view' ? Partial<ViewOptions> : never;
-    /**
-     * custom property
-     */
-    data?: unknown;
-};
+declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
+    behavior: Behavior;
+}>;
 
 /**
  * @interface
@@ -4402,15 +4454,12 @@ declare type CreatedEvent = BaseViewEvent & {
 };
 
 /**
- * @interface
+ * @interface @experimental
  */
 declare type CreateLayoutOptions = {
-    /**
-     * @experimental
-     *
-     * @returns
-     */
-    layoutManagerOverride: () => any;
+    container: HTMLElement;
+    layoutName: string;
+    layout: LayoutOptions;
 };
 
 /**
@@ -4431,7 +4480,7 @@ declare type CreateViewPayload = {
 /**
  * @interface
  */
-declare type CreateViewTarget = Identity_5 & {
+declare type CreateViewTarget = LayoutIdentity & {
     /**
      * If specified, view creation will not attach to a window and caller must
      * insert the view into the layout explicitly
@@ -4442,6 +4491,44 @@ declare type CreateViewTarget = Identity_5 & {
     };
 };
 
+/**
+ * The registry entry for a given protocol exists but can't be parsed.
+ * @interface
+ */
+declare type CustomProtocolMalformedState = {
+    state: 'Malformed';
+};
+
+/**
+ * The registry entry is missing for a given custom protocol.
+ * @interface
+ */
+declare type CustomProtocolMissingState = {
+    state: 'Missing';
+};
+
+/**
+ * Define possible options for Custom protocol.
+ * @interface
+ */
+declare type CustomProtocolOptions = {
+    protocolName: string;
+};
+
+/**
+ * The registry rentry for a given protocol exists and can be parsed successfully.
+ * @interface
+ */
+declare type CustomProtocolRegisteredState = {
+    state: 'Registered';
+    handlerManifestUrl: string;
+};
+
+/**
+ * Define possible registration states for a given custom protocol.
+ */
+declare type CustomProtocolState = CustomProtocolMissingState | CustomProtocolMalformedState | CustomProtocolRegisteredState;
+
 /**
  * Custom headers for requests sent by the window.
  *
@@ -4459,6 +4546,8 @@ declare type CustomRequestHeaders = {
     headers: WebRequestHeader[];
 };
 
+declare type DataChannelReadyState = RTCDataChannel['readyState'];
+
 /**
  * @interface
  */
@@ -4531,13 +4620,6 @@ declare type DestroyedEvent = BaseViewEvent & {
     type: 'destroyed';
 };
 
-/**
- * @interface
- */
-declare type DestroyLayoutOptions = {
-    layoutName: string;
-};
-
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -4734,6 +4816,47 @@ declare type DownloadRule = {
     match: string[];
 };
 
+/**
+ * @interface
+ *
+ * Controls the styling and behavior of the window download shelf.
+ */
+declare type DownloadShelfOptions = {
+    /**
+     * Whether downloads in this window trigger opening the download shelf.
+     */
+    enabled: boolean;
+    /**
+     * Styling options for the download shelf border.
+     */
+    border?: {
+        /**
+         * Thickness of the border in pixels.  Default 1 pixel.  Used only for frameless windows.
+         *
+         * @remarks The top border is fixed to 1 pixel regardless of this setting.
+         */
+        size?: number;
+        /**
+         * Color of the border, either a string name or a hex code.  Defaults to chromium theme
+         * if absent.
+         */
+        color?: string;
+    };
+};
+
+/**
+ * Generated when the visibility of the window's download shelf changes.
+ *
+ * @interface
+ */
+declare type DownloadShelfVisibilityChangedEvent = BaseWindowEvent & {
+    type: 'download-shelf-visibility-changed';
+    /**
+     * True if the download shelf was just opened; false if it was just closed.
+     */
+    visible: boolean;
+};
+
 /**
  * DPI (dots per inch) configuration for printing.
  *
@@ -4938,9 +5061,11 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, ...args: Parameters<OpenFin.Fin['Platform']['Layout']['init']>): ReturnType<OpenFin.Fin['Platform']['Layout']['init']>;
+    initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
+    createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
+    destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
     initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
-    observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): (() => void);
+    observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
     writeToken(path: string, token: string): Promise<string>;
     retrievePort(config: NewConnectConfig): Promise<number>;
     getNextMessageId(): any;
@@ -5219,7 +5344,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -5571,6 +5696,8 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type FlexReadyState = WebSocketReadyState | DataChannelReadyState;
+
 /**
  * Generated when a WebContents gains focus.
  * @interface
@@ -5891,6 +6018,8 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
      * Registers a global hotkey with the operating system.
      * @param hotkey a hotkey string
      * @param listener called when the registered hotkey is pressed by the user.
+     * @throws If the `hotkey` is reserved, see list below.
+     * @throws if the `hotkey` is already registered by another application.
      *
      * @remarks The `hotkey` parameter expects an electron compatible [accelerator](https://github.com/electron/electron/blob/master/docs/api/accelerator.md) and the `listener` will be called if the `hotkey` is pressed by the user.
      * If successfull, the hotkey will be 'claimed' by the application, meaning that this register call can be called multiple times from within the same application but will fail if another application has registered the hotkey.
@@ -5963,7 +6092,7 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
      */
     unregisterAll(): Promise<void>;
     /**
-     * Checks if a given hotkey has been registered
+     * Checks if a given hotkey has been registered by an application within the current runtime.
      * @param hotkey a hotkey string
      *
      * @example
@@ -6027,6 +6156,7 @@ declare namespace GoldenLayout {
         DragSource,
         BrowserWindow,
         Header,
+        TabDragListener,
         Tab,
         EventEmitter_2 as EventEmitter
     }
@@ -6141,10 +6271,7 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
      * @param itemConfiguration An item configuration (can be an entire tree of items)
      * @param parent A parent item
      */
-    createContentItem(
-    itemConfiguration?: ItemConfigType,
-    parent?: ContentItem
-    ): ContentItem;
+    createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
 
     /**
      * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
@@ -6177,10 +6304,7 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
      * @return the dragSource that was created. This can be used to remove the
      *         dragSource from the layout later.
      */
-    createDragSource(
-    element: HTMLElement | JQuery,
-    itemConfiguration: ItemConfigType
-    ): DragSource;
+    createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
 
     /**
      * Removes a dragSource from the layout.
@@ -6556,19 +6680,30 @@ declare type InitializedEvent = IdentityEvent & {
     type: 'initialized';
 };
 
-declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
-
-declare type InitLayoutOptions_2 = OpenFin.InitLayoutOptions;
-
 /**
  * @interface
  */
-declare type InitLayoutOptions_3 = {
+declare type InitLayoutOptions = {
     /**
+     * @deprecated use container HTMLElement instead
+     *
      * The id attribute of the container where the window's Layout should be initialized.  If not provided
      * then an element with id `layout-container` is used. We recommend using a div element.
      */
     containerId?: string;
+    /**
+     * The HTMLElement where the window's Layout should be initialized. We recommend using a div element.
+     */
+    container?: HTMLElement;
+    /**
+     * An override callback used to instantiate a custom LayoutManager. When present, will enable
+     * Multiple Layouts. The callback should return a class.
+     *
+     * @remarks
+     * **NOTE**: Unlike the Platform Provider overrideCallback and interopOverride, this override should
+     * return a class, not an instance
+     */
+    layoutManagerOverride?: LayoutManagerOverride<LayoutSnapshot>;
 };
 
 /**
@@ -8418,8 +8553,8 @@ declare class Layout extends Base {
     /**
      * @internal
      */
-    init: (options?: InitLayoutOptions_2) => Promise<Layout>;
-    identity: Identity_4;
+    init: (options?: OpenFin.InitLayoutOptions) => Promise<Layout>;
+    identity: OpenFin.LayoutIdentity;
     private platform;
     wire: Transport;
     /**
@@ -8598,133 +8733,30 @@ declare type LayoutComponent = LayoutItemConfig & {
 
 declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
 
-declare class LayoutContentCache {
-    private contentItemCache;
-    private contentItemCacheId;
-    private createCacheKey;
-    hasKey: (id: string) => boolean;
-    getItemOrUndefined: (id: string) => GoldenLayout.ContentItem | undefined;
-    getContentItemOrThrow: (id: string, expectedType?: string[]) => GoldenLayout.ContentItem;
-    getOrCreateEntityId: (contentItem: GoldenLayout.ContentItem) => string;
-}
-
 declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
 
-/**
- * @internal
- * Controller for the layout entities apis, allowing alterations to be applied
- * to an instance of layout manager in a structured manner.
- */
-declare class LayoutEntitiesController {
-    private layoutInstance;
-    private layoutContentCache;
-    private wire;
-    constructor(layoutInstance: OpenFinLayout, layoutContentCache: LayoutContentCache);
-    private analytics;
-    /**
-     * @internal
-     * @returns the root contentItem of the layout.
-     */
-    getRoot: () => OpenFin.LayoutEntityDefinition;
-    /**
-     * @internal
-     * Retrieves the containing stack of a given view identity.
-     * @param view Identity of the view to retrieve the stack of.
-     * @returns Stack containing the given view.
-     * @throws If the view does not belong to a stack within the layout manager.
-     */
-    getStackByView: (view: OpenFin.Identity) => Promise<OpenFin.LayoutEntityDefinition | undefined>;
-    /**
-     * @internal
-     * Returns all views belonging to a given stack
-     *
-     * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
-     * when the amount of new views to add overflows the width of the container. This results
-     * in tabs being re-ordered in the UI, while the underlying content item array remains in the
-     * original order specified. So calling getStackViews() will return this underlying array order,
-     * with indexes that will not match up to the render-order of the tabs.
-     *
-     * @param id - Entity id of the stack.
-     * @returns A list of view identities in order of appearance.
-     * @throws if the content item associated with the entity id does not exist or is not a stack.
-     */
+declare type LayoutEntitiesController = {
+    getLayoutIdentityForViewOrThrow: (viewIdentity?: OpenFin.Identity) => Promise<OpenFin.LayoutIdentity>;
+    getRoot: (layoutIdentity?: OpenFin.LayoutIdentity) => Promise<OpenFin.LayoutEntityDefinition>;
+    getStackByView: (viewIdentity: OpenFin.Identity) => Promise<OpenFin.LayoutEntityDefinition | undefined>;
     getStackViews: (id: string) => OpenFin.Identity[];
-    /**
-     * @internal
-     * Retrieves the content of a column or row and adds each to the
-     * entity cache to allow them to be addressed externally.
-     * @param id Entity id of the Column Or Row to retrieve the content of.
-     * @returns Array of layout entity definitions
-     * @throws if the entity associated with {@link id} is not in the entity cache, does not belogn to a layout, or is not a column/row.
-     */
-    getContent(id: string): OpenFin.LayoutEntityDefinition[];
-    /**
-     * @internal
-     * Retrieves the parent content item of the given entity, and adds it to the entity cache
-     * so it can be addressed externally.
-     * @param id Entity id associated with a layout content item.
-     * @returns An entity definition for the given entity's parent, or undefined if the entity is the top level
-     * content item or has been removed from the layout entirely.
-     */
-    getParent(id: string): OpenFin.LayoutEntityDefinition | undefined;
-    /**
-     * @internal
-     * @param id Entity id associated with a layout content item.
-     * @returns true if the given entity is the root content item, false otherwise.
-     */
+    getContent: (id: string) => OpenFin.LayoutEntityDefinition[];
+    getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
-    /**
-     * @internal
-     * Checks whether the given entity exists.
-     * @param entityId Id of a content item within the layout
-     * @returns True if the content item exists and belongs to the layout.
-     */
     exists: (entityId: string) => boolean;
-    /**
-     * @internal
-     * Adds an existing view to the stack, or creates and adds a view to the given stack.
-     *
-     * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
-     * when the amount of new views to add overflows the width of the container. This results
-     * in tabs being re-ordered in the UI, while the underlying content item array remains in the
-     * original order specified. So calling getStackViews() will return this underlying array order,
-     * with indexes that will not match up to the render-order of the tabs.
-     *
-     * @param stackEntityId Entity id of the stack content item within the layout.
-     * @param viewCreationOrReference View identity or creation options
-     * @param options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
-     * @returns Promise resolving with the identity of the newly added view.
-     * @throws If the view does not exist, fails to create, or the stack does not exist.
-     */
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, { index }?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
-    private findViewInStack;
-    /**
-     * @internal
-     * Removes a view from the given stack. If it's the only view, the stack will be destroyed, unless window creation
-     * option closeOnLastViewRemoved is set to false.
-     *
-     * @param stackEntityId Entity id of a stack content item to remove the view from.
-     * @param view Identity of the view to remove.
-     * @throws If the stack does not exist or the view does not exist or belong to the stack.
-     */
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
+        index?: number;
+    }) => Promise<OpenFin.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
-    /**
-     * @internal
-     * Creates a new adjacent 'stack' and adds the views to it at the specified position
-     * @param targetId Entity id of the content item to add a stack adjacent to it
-     * @param views List of identities or view creation options of the views to include in the stack
-     * @param options Creation options, defaults to { position: 'right' }
-     * @returns the Entity Id of the new stack
-     */
-    createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], { position }?: {
+    createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin.LayoutPosition;
     }) => Promise<string>;
-    getAdjacentStacks: ({ targetId, edge }: {
+    getAdjacentStacks: (stackTarget: {
         targetId: string;
         edge: OpenFin.LayoutPosition;
     }) => Promise<Pick<OpenFin.LayoutEntityDefinition, 'entityId'>[]>;
     setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
-}
+};
 
 /**
  * @interface
@@ -8759,11 +8791,14 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
 };
 
 /**
- * @interface @experimental
+ * @interface @experimental @internal
+ *
+ * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
  * Responsible for handling all layout management and renderering
  */
 declare type LayoutInstance = {
+    identity: LayoutIdentity;
     getFrameSnapshot: () => Promise<LayoutOptions>;
     addView: (payload: AddViewOptions) => Promise<View_2>;
     closeView: (viewIdentity: Identity_5) => Promise<void>;
@@ -8772,15 +8807,14 @@ declare type LayoutInstance = {
     getViews: () => LayoutComponent[];
     getCurrentViews: () => Identity_5[];
     startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
-    applyPreset: (payload: PresetLayoutOptions_3) => void;
+    applyPreset: (payload: PresetLayoutOptions_2) => void;
     isVisible: () => boolean;
-    destroy: () => void;
+    destroy: () => Promise<void>;
 };
 
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
  *
  * @interface
  */
@@ -8802,25 +8836,43 @@ declare type LayoutItemConfig = {
 
 /**
  * @interface @experimental
+ *
+ * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
+ *
+ * Responsible for aggergating all layout snapshots and storing LayoutInstances
  */
-declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
+declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      *
-     * Must be overridden when working with multiple layouts
+     * To enable multiple layouts, override this method and do not call super.applyLayoutSnapshot()
+     *
+     * This hook is called by OpenFin during fin.Platform.Layout.init() call, to pass a snapshot to derived
+     * classes which will be used launch a platform window. Use this hook to set your local UI state and
+     * begin rendering the containers for your layouts UI.
+     *
+     * Ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts when that layout is
+     * ready to be created in your application.
      *
-     * Hook called during fin.Platform.Layout.init() call, to inform derived classes
-     * when a snapshot is being applied to launch a platform window. Use this hook to set the
-     * local state and ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts
+     * If you add custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
+     * be included in the snapshot type.
      *
-     * When using custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
-     * be included in the snapshot type T and should align with your component state T.
+     * The default implementation throws if it is called with a snapshot containing more than one layout.
      *
-     * TODO: detect if layoutManager override was set and this was not overridden somehow to warn?
      * @param snapshot
-     * @returns
+     * @throws if Object.keys(snapshot).length > 1
+     */
+    applyLayoutSnapshot(snapshot: T): Promise<void>;
+    /**
+     * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
+     * contains a single layout.
+     *
+     * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
+     * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
+     *
+     * @param snapshot
+     * @throws if Object.keys(snapshot).length > 1
      */
-    applyLayoutSnapshot: (snapshot: T) => Promise<void>;
     /**
      * @experimental
      *
@@ -8831,35 +8883,63 @@ declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
      * @param layoutIdentity
      * @returns
      */
-    showLayout: ({ layoutName }: LayoutIdentity) => Promise<void>;
+    showLayout({ layoutName }: LayoutIdentity): Promise<void>;
     /**
      * @experimental
      *
      * @returns T
      */
-    getLayoutSnapshot: () => Promise<T>;
+    getLayoutSnapshot(): Promise<T>;
     /**
      * @experimental
      *
-     * @param param0
+     * @param layoutIdentity
      * @returns
      */
-    resolveLayout: ({ layoutName }: LayoutIdentity) => LayoutInstance;
+    resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
     /**
      * @experimental
      *
      * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
      * Throws if it does not exist.
-     * @param layoutIdentity
+     * @param layoutName
      * @returns
      */
-    getLayoutByName: (layoutName: string) => LayoutInstance;
+    getLayoutByName(layoutName: string): LayoutInstance;
     /**
      * @experimental
      */
     getLayouts(): Record<string, LayoutInstance>;
+    /**
+     * @experimental
+     */
+    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
+    /**
+     * @experimental
+     */
+    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
 }
 
+/**
+ * @experimental
+ *
+ * Constructor type for LayoutManager to be used with multiple layouts
+ */
+declare type LayoutManagerConstructor<T extends LayoutSnapshot> = {
+    new (): LayoutManager<T>;
+};
+
+/**
+ * @experimental
+ *
+ * Override callback used to init and configure multiple layouts. Implement by passing
+ * a lambda and returning a class that OpenFin will new up for you.
+ * @remarks
+ * **NOTE**: Unlike the Platform Provider overrideCallback and interopOverride, this override should
+ * return a class, not an instance
+ */
+declare type LayoutManagerOverride<T extends LayoutSnapshot> = (Base: LayoutManagerConstructor<LayoutSnapshot>) => LayoutManagerConstructor<T>;
+
 /**
  * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
  */
@@ -8884,7 +8964,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrap(identity: OpenFin.Identity): Promise<OpenFin.Layout>;
+    wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
     /**
      * Synchronously returns a Layout object that represents a Window's layout.
      *
@@ -8904,7 +8984,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrapSync(identity: OpenFin.Identity): OpenFin.Layout;
+    wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
     /**
      * Asynchronously returns a Layout object that represents a Window's layout.
      *
@@ -8968,7 +9048,14 @@ declare class LayoutModule extends Base {
      * const layout = await fin.Platform.Layout.init({ containerId });
      * ```
      */
-    init: (options?: InitLayoutOptions) => Promise<OpenFin.Layout>;
+    init: (options?: OpenFin.InitLayoutOptions) => Promise<OpenFin.Layout>;
+    /**
+     * Returns the layout manager for the current window
+     * @returns
+     */
+    getCurrentLayoutManagerSync: <UserSnapshotType extends OpenFin.LayoutSnapshot>() => OpenFin.LayoutManager<UserSnapshotType>;
+    create: (options: OpenFin.CreateLayoutOptions) => Promise<void>;
+    destroy: (layoutIdentity: OpenFin.LayoutIdentity) => Promise<void>;
 }
 
 declare type LayoutModule_2 = OpenFin.Fin['Platform']['Layout'];
@@ -8996,7 +9083,7 @@ declare abstract class LayoutNode {
     /**
      * @ignore
      * @internal
-     * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
+     * Encapsulates Api consumption of {@link LayoutEntitiesClient} with a relayed dispatch
      * @param client
      * @param controllerId
      * @param identity
@@ -9211,8 +9298,7 @@ declare type LayoutOptions = {
     };
     /**
      * Content of the layout. There can only be one top-level LayoutItem in the content array.
-     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
-     * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
      */
     content?: LayoutContent;
     dimensions?: {
@@ -9508,7 +9594,17 @@ declare interface Message<T> {
 
 declare type MessageHandler = (data: any) => boolean;
 
-declare class MessageReceiver extends Base {
+declare interface MessageReceiver {
+    addEventListener(e: 'open', listener: (ev: Event) => void): void;
+    addEventListener(e: 'error', listener: (ev: Event) => void): void;
+    addEventListener(e: 'message', listener: (ev: MessageEvent) => void): void;
+    addEventListener(e: 'close', listener: (ev: Event) => void): void;
+    send(data: unknown): void;
+    close(): void;
+    readyState: FlexReadyState;
+}
+
+declare class MessageReceiver_2 extends Base {
     private endpointMap;
     private latestEndpointIdByChannelId;
     constructor(wire: Transport);
@@ -9662,7 +9758,7 @@ declare type MutableViewOptions = {
     contentRedirect: ContentRedirect;
     /**
      * @defaultValue false
-     *
+     * @deprecated
      * **Platforms Only.**  If true, will hide and detach the View from the window for later use instead of closing,
      * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
      */
@@ -10085,6 +10181,11 @@ declare namespace OpenFin {
         Rectangle,
         ApplicationCreationOptions,
         ApplicationOptions,
+        CustomProtocolMissingState,
+        CustomProtocolMalformedState,
+        CustomProtocolRegisteredState,
+        CustomProtocolState,
+        CustomProtocolOptions,
         InteropBrokerOptions,
         ContextGroupInfo,
         DisplayMetadata_3 as DisplayMetadata,
@@ -10148,6 +10249,7 @@ declare namespace OpenFin {
         ReplaceViewPayload,
         ReplaceViewOptions,
         CloseViewPayload,
+        CloseViewOptions,
         FetchManifestPayload,
         ReplaceLayoutOpts,
         ReplaceLayoutPayload,
@@ -10271,6 +10373,11 @@ declare namespace OpenFin {
         IntentHandler_2 as IntentHandler,
         ContentCreationBehaviorNames,
         MatchPattern,
+        BaseContentCreationRule,
+        WindowContentCreationRule,
+        ViewContentCreationRule,
+        BrowserContentCreationRule,
+        BlockedContentCreationRule,
         ContentCreationRule,
         ContentCreationOptions,
         SnapshotProvider,
@@ -10310,13 +10417,13 @@ declare namespace OpenFin {
         LayoutPresetType,
         LayoutIdentity,
         LayoutSnapshot,
-        InitLayoutOptions_3 as InitLayoutOptions,
+        InitLayoutOptions,
+        LayoutManagerConstructor,
+        LayoutManagerOverride,
         LayoutInstance,
         LayoutManager,
-        AddLayoutInstanceOptions,
         CreateLayoutOptions,
-        DestroyLayoutOptions,
-        PresetLayoutOptions_3 as PresetLayoutOptions,
+        PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,
         PopupResultBehavior,
@@ -10356,6 +10463,7 @@ declare namespace OpenFin {
         ChannelClientDisconnectionListener,
         ChannelProviderDisconnectionListener,
         RoutingInfo,
+        DownloadShelfOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -10370,105 +10478,6 @@ declare namespace OpenFin {
 }
 export default OpenFin;
 
-declare class OpenFinLayout implements OpenFin.LayoutInstance {
-    #private;
-    private readonly splitterController;
-    private readonly tabDragController;
-    private readonly layoutContentCache;
-    private get defaultFaviconUrl();
-    private get isDragging();
-    private get resizing();
-    private get showBackgroundImages();
-    private get showFavicons();
-    private get showViewsOnSplitterDrag();
-    private get showViewsOnTabDrag();
-    private get showViewsOnWindowResize();
-    private get container();
-    get layout(): GoldenLayout.GoldenLayout;
-    private get layoutConfigToRestore();
-    private client;
-    private containerResizeObserver;
-    private viewsResizeObserver;
-    readonly ofWindow: OpenFin.Window;
-    readonly platform: Platform_2;
-    private lastItemDestroyed?;
-    private viewsSubscribedTo;
-    constructor(splitterController: SplitterController, tabDragController: TabDragController, layoutContentCache: LayoutContentCache, container: HTMLElement);
-    getViews: () => OpenFin.LayoutComponent[];
-    startReplaceLayout: ({ layout }: {
-        layout: GoldenLayout.Config;
-    }) => Promise<void>;
-    applyPreset: (payload: PresetLayoutOptions_2) => void;
-    isVisible: () => boolean;
-    destroy: () => void;
-    /**
-     * @internal
-     * Needed by init-layout util to wire up {@link LayoutEntitiesController}
-     */
-    static getClient: (instance: OpenFinLayout) => OpenFin.ChannelClient;
-    initManager: () => Promise<void>;
-    createLayout: (layout: GoldenLayout.Config, container: HTMLElement) => Promise<void>;
-    private setContainer;
-    private setupDragDropRegions;
-    private replaceLayout;
-    private onViewDetached;
-    private setupLayoutListeners;
-    private onLayoutInit;
-    private registerViewComponent;
-    private setupWindowListeners;
-    private setupResizeObservers;
-    /**
-     * Shows/hides a view depending on use case (used by browser)
-     * @ignore
-     */
-    private updateViewVisibility;
-    private onStackCreated;
-    private onTabCreated;
-    private onTabMouseUp;
-    private replaceCloseTabButton;
-    onCloseTabButtonClick: (tab: GoldenLayout.Tab) => Promise<void>;
-    addFaviconToTab: (tab: GoldenLayout.Tab, eventIcons: string[]) => void;
-    onPopoutClick: (stack: GoldenLayout.ContentItem) => void;
-    onStackCloseClick: (stack: GoldenLayout.ContentItem) => void;
-    private updateButtonDisplay;
-    private onItemCreated;
-    private observeSplitters;
-    handleOutOfWindowDrop: (e: {
-        screenY: number;
-        screenX: number;
-    }, parentTab: GoldenLayout.Tab, dimensions: {
-        width: any;
-        height: any;
-    }) => Promise<void>;
-    private onTabDragStart;
-    private setBackgroundImage;
-    private setBackgroundImages;
-    getFrameSnapshot: () => Promise<GoldenLayout.Config>;
-    getCurrentViews: () => OpenFin.Identity[];
-    addView: ({ options: viewConfig, targetView, location }: OpenFin.AddViewOptions) => Promise<View_4>;
-    replaceView: ({ viewToReplace, newView }: OpenFin.ReplaceViewOptions) => Promise<View_4>;
-    removeView: (viewConfig: OpenFin.Identity | OpenFin.ViewState) => Promise<View_4>;
-    closeView: (viewIdentity: OpenFin.Identity) => Promise<void>;
-    private createChannelConnections;
-    getViewComponent: ({ name }: {
-        name: string;
-    }) => ViewComponent | undefined;
-    getViewComponents: () => ViewComponent[];
-    private hideHighlight;
-    getOfViewFromComponentState: ({ name }: {
-        name: string;
-    }) => View_4;
-    private hideAllViews;
-    private showViews;
-    private initializeLayoutViews;
-    private createResizableView;
-    private attachView;
-    private createAndAttachView;
-    private setupViewEvents;
-    private dispatchLayoutEvent;
-    private setComponentState;
-}
-
 declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 
 declare type OverlapsOnlyIfMatching<T, U> = {
@@ -11235,8 +11244,6 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     }): Promise<void>;
 }
 
-declare type Platform_2 = OpenFin.Platform;
-
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -11531,6 +11538,29 @@ declare interface PlatformProvider {
      * ```
      */
     getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
+    /**
+     * @experimental @internal
+     *
+     * **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
+     *
+     * Returns the window options value for `layoutSnapshot` which has already been normalized.
+     * @param payload
+     * @param callerIdentity
+     */
+    getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin.Identity): Promise<OpenFin.LayoutSnapshot | undefined>;
+    /**
+     * @experimental @internal
+     *
+     * **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
+     *
+     * Calls platform.createView for every view in the given layout. Returns an array of promises
+     * one promise for each view create call
+     *
+     * @param layout
+     * @param target
+     * @returns an array of promises
+     */
+    createViewsForLayout(layout: GoldenLayout.Config, target: OpenFin.Identity): Promise<OpenFin.View>[];
     /**
      * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
      * Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
@@ -12266,12 +12296,10 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
 
 declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
 
-declare type PresetLayoutOptions_2 = OpenFin.PresetLayoutOptions;
-
 /**
  * @interface
  */
-declare type PresetLayoutOptions_3 = {
+declare type PresetLayoutOptions_2 = {
     /**
      * Which preset layout arrangement to use.
      * The preset options are `columns`, `grid`, `rows`, and `tabs`.
@@ -12495,7 +12523,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -12509,7 +12537,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *
@@ -12727,6 +12755,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
         anchor: OpenFin.AnchorType;
     }>>;
     'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
+    'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
+    'unregister-custom-protocol': ApiCall<{
+        protocolName: string;
+    }, void>;
+    'get-custom-protocol-state': ApiCall<{
+        protocolName: string;
+    }, OpenFin.CustomProtocolState>;
 }
 
 declare interface ProtocolMapBase {
@@ -12858,6 +12893,10 @@ declare interface ReactComponentConfig extends ItemConfig {
  */
 declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
 
+declare interface ReceiverConfig extends Omit<RemoteConfig, 'address'> {
+    receiver: MessageReceiver;
+}
+
 /**
  * A rectangular area on the screen.
  *
@@ -12939,19 +12978,19 @@ declare interface RemoteConfig extends ExistingConnectConfig {
 /**
  * @interface
  */
-declare type ReplaceLayoutOptions = ReplaceLayoutOpts;
+declare type ReplaceLayoutOptions = {
+    /**
+     * Layout config to be applied.
+     */
+    layout: LayoutOptions;
+};
 
 /**
  * @interface
  *
  * @deprecated use ReplaceLayoutOptions instead
  */
-declare type ReplaceLayoutOpts = {
-    /**
-     * Layout config to be applied.
-     */
-    layout: LayoutOptions;
-};
+declare type ReplaceLayoutOpts = ReplaceLayoutOptions;
 
 /**
  * @interface
@@ -12962,9 +13001,9 @@ declare type ReplaceLayoutPayload = {
      */
     opts: ReplaceLayoutOptions;
     /**
-     * Identity of the window whose layout will be replace.
+     * Identity of the window whose layout will be replaced.
      */
-    target: Identity_5;
+    target: LayoutIdentity;
 };
 
 /**
@@ -12983,7 +13022,7 @@ declare type ReplaceViewPayload = {
         viewToReplace: Identity_5;
         newView: Partial<ViewOptions>;
     };
-    target: Identity_5;
+    target: LayoutIdentity;
 };
 
 /**
@@ -13495,6 +13534,49 @@ declare type ShortcutOverride = Hotkey & {
     command: string;
 };
 
+/**
+ * Generated when the Download Shelf 'Show All' button is clicked.
+ *
+ * @remarks By default, OpenFin does not handle the clicking of the `Show All` button on the download
+ * shelf.  Instead, it fires this event, which leaves rendering a download manager to the user.  For a simple
+ * implementation, the `chrome://downloads` page can be used (see the example below):
+ *
+ * @example
+ *
+ * ```typescript
+ * const platform = await fin.Platform.getCurrentSync();
+ * // Listen to the propagated event at the Platform level, so that we only need one listener for a click from any window
+ * platform.on('window-show-all-downloads', () => {
+ *   // Render the `chrome://downloads` window when a user clicks on the download shelf `Show All` button
+ *   platform.createWindow({
+ *         name: 'show-download-window',
+ *         layout: {
+ *             content: [
+ *                 {
+ *                     type: 'stack',
+ *                     content: [
+ *                         {
+ *                             type: 'component',
+ *                             componentName: 'view',
+ *                             componentState: {
+ *                                 name: 'show-download-view',
+ *                                 url: 'chrome://downloads'
+ *                             }
+ *                         }
+ *                     ]
+ *                 }
+ *             ]
+ *         }
+ *     });
+ * })
+ * ```
+ *
+ * @interface
+ */
+declare type ShowAllDownloadsEvent = BaseWindowEvent & {
+    type: 'show-all-downloads';
+};
+
 /**
  * Generated when a View is shown. This event will fire during creation of a View.
  * @interface
@@ -13687,37 +13769,6 @@ declare class SnapshotSourceModule extends Base {
     wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
 }
 
-/**
- * Utility class for managing Golden Layout splitter drag interactions.
- * @ignore
- */
-declare class SplitterController {
-    private readonly viewOverlay;
-    constructor(viewOverlay: ViewOverlay);
-    private teardown?;
-    private tryTeardown;
-    /**
-     * Disables the pointer events on the splitters, preventing them from being dragged.
-     */
-    preventSplitterResize: () => void;
-    /**
-     * Ends a splitter drag move, if one is in progress.
-     */
-    endMove: () => Promise<void>;
-    /**
-     * Initialises a splitter drag move, rendering a view on top of the splitter
-     * to allow it to render on top of the views within a layout (as they will always
-     * have a higher z-index to the platform window itself).
-     * @param splitterItem The Golden Layout splitter item that is currently being dragged.
-     */
-    startMove: (splitterItem: SplitterItem) => Promise<void>;
-}
-
-declare type SplitterItem = GoldenLayout.ContentItem & {
-    viewEventsAdded: boolean;
-    isVertical: boolean;
-};
-
 /**
  * Generated when an application has started.
  * @interface
@@ -14566,6 +14617,70 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * ```
      */
     openUrlWithBrowser(url: string): Promise<void>;
+    /**
+     * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
+     * overwrites the existing registry entry if the given custom protocol name already exists.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be registered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a given custom protocol failed to be registered.
+     * @throws if a manifest URL contains the '%1' string.
+     * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
+     * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
+     *
+     * @example
+     * ```js
+     * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
+     * ```
+     */
+    registerCustomProtocol(options: OpenFin.CustomProtocolOptions): Promise<void>;
+    /**
+     * Removes the registry entry for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be unregistered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a protocol entry failed to be removed in registry.
+     *
+     * @example
+     * ```js
+     * await fin.System.unregisterCustomProtocol('protocol1');
+     * ```
+     */
+    unregisterCustomProtocol(protocolName: string): Promise<void>;
+    /**
+     * Retrieves the registration state for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     * @remarks These protocols are reserved and cannot get states for them:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     *
+     * @example
+     * ```js
+     * const protocolState = await fin.System.getCustomProtocolState('protocol1');
+     */
+    getCustomProtocolState(protocolName: string): Promise<OpenFin.CustomProtocolState>;
     /**
      * Removes the process entry for the passed UUID obtained from a prior call
      * of fin.System.launchExternalProcess().
@@ -15262,6 +15377,18 @@ declare type SystemPermissions = {
         enabled: boolean;
         protocols: string[];
     };
+    registerCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
+    unregisterCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
+    getCustomProtocolState: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
 };
 
 /**
@@ -15286,7 +15413,7 @@ declare type SystemShutdownHandler = (shutdownEvent: {
 }) => void;
 
 declare interface Tab {
-    _dragListener: EventEmitter_2;
+    _dragListener: TabDragListener;
 
     /**
      * True if this tab is the selected tab
@@ -15331,60 +15458,11 @@ declare interface Tab {
     setActive(isActive: boolean): void;
 }
 
-/**
- * Set of apis used to facilitate tab drag interactions without needing to hide views.
- * @ignore
- */
-declare class TabDragController {
-    private readonly viewOverlay;
-    constructor(viewOverlay: ViewOverlay);
-    private dropZonePreview?;
-    /**
-     *
-     * When a tab is dragged out of a stack, it will need to be hidden from the stack.
-     *
-     * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
-     * containerBounds
-     *
-     * As drag interactions can under extreme circumstances complete before this chain of promises has completed,
-     * we need to pass in a isDragging() function which returns whether the drag is in progress.
-     * This allows us to cancel any layout affecting operations.
-     *
-     * @param draggingView The view which is currently being dragged
-     * @param isLastViewInWindow Whether the draggin view is the last view in a window or not. If false, the dragging view will not hide.
-     * @param isDragging A function which returns true if the drag is still in progress. As we chain some async calls here, we want to avoid
-     * modifying any views if the drag has completed (as the post drag procedure will have taken care of it.)
-     * @param containerBounds The bounds of the container of the view to be shown in the stack
-     * @param nextView The view which has become active after dragging the draggingView out.
-     */
-    handleTabStackActiveView: (draggingView: View_3, isLastViewInWindow: boolean, isDragging: () => boolean, containerBounds?: OpenFin.Bounds, nextView?: View_3) => Promise<void>;
-    /**
-     * Extracts the border and backgroundColor css values from the drop zone preview,
-     * and sets the viewOverlay to match them.
-     */
-    inheritStyles: () => Promise<void>;
+declare interface TabDragListener extends EventEmitter_2 {
     /**
-     * Called when a tab drag interaction is started from the current window (not when it enters the window).
-     *
-     * Sets all views in the platform to ignore mouse events so that they can pass through to the golden-layout
-     * document whilst remaining visible.
-     */
-    startDrag: () => Promise<void>;
-    /**
-     * Called when a tab drag interaction which was started from the current window ends.
-     *
-     * Disables the click through setting on every view in the platform.
-     */
-    endDrag: () => Promise<void>;
-    private disposeObserve?;
-    disposeOverlayObserver: () => void;
-    /**
-     * Observes a golden-layout drop zone preview in order to render a BrowserView
-     * overlay whenever a tab is dragged over a droppable region.
-     * @param dropZonePreview The drop zone preview element created by Golden Layout in order to highlight
-     * droppable regions of the UI.
+     * A reference to the content item this tab relates to
      */
-    observeOverlay: (dropZonePreview: HTMLElement) => Promise<void>;
+    contentItem: ContentItem;
 }
 
 /**
@@ -15716,7 +15794,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
     connectSync: () => void;
     getPort: () => string;
     shutdown(): Promise<void>;
-    connect(config: InternalConnectConfig | RemoteConfig): Promise<string | void>;
+    connect(config: InternalConnectConfig | RemoteConfig | ReceiverConfig): Promise<string | void>;
     private connectRemote;
     connectByPort(config: ExistingConnectConfig): Promise<void>;
     private authorize;
@@ -16526,10 +16604,6 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
     bindToElement: (element: HTMLElement) => Promise<() => void>;
 }
 
-declare type View_3 = OpenFin.View;
-
-declare type View_4 = OpenFin.View;
-
 /**
  * Generated when a View is attached to a window.
  * @interface
@@ -16540,9 +16614,21 @@ declare type ViewAttachedEvent = BaseWindowEvent & {
     viewIdentity: OpenFin.Identity;
 };
 
-declare interface ViewComponent extends GoldenLayout.ContentItem {
-    componentState: OpenFin.ViewState;
-}
+/**
+ * A rule prescribing content creation in a {@link OpenFin.View}.
+ *
+ * @interface
+ */
+declare type ViewContentCreationRule = BaseContentCreationRule & {
+    /**
+     * Behavior to use when opening matched content.
+     */
+    behavior: 'view';
+    /**
+     * Options for newly-created view.
+     */
+    options?: Partial<ViewOptions>;
+};
 
 /**
  * The options object required by {@link View.ViewModule.create View.create}.
@@ -16709,40 +16795,6 @@ declare class ViewModule extends Base {
  */
 declare type ViewOptions = ConstViewOptions & MutableViewOptions;
 
-/**
- * Api client allowing an empty electron BrowserView to be rendered
- * in the current window with the specified bounds.
- *
- * Please note, only one  view based overlay can be rendered at a time per runtime.
- * @ignore
- */
-declare class ViewOverlay {
-    private wire;
-    constructor(wire: Transport);
-    /**
-     * Sets the style of the root <html> element of the view overlay webcontent.
-     * @param style A partial collection of Css style declarations to set.
-     */
-    setStyle: (style: Partial<CSSStyleDeclaration>) => Promise<void>;
-    /**
-     * Renders the overlay at the specified position relative to the calling window.
-     * @param options Bounds and background color to display in the overlay.
-     */
-    renderOverlay: (bounds: OpenFin.Bounds) => Promise<void>;
-    /**
-     * Removes the overlay from the current window.
-     */
-    detachOverlay: () => Promise<void>;
-    /**
-     * Allows setting all OpenFin views to ignore or consume mouse events.
-     *
-     * This can help with the rendering of view overlays that depend on OpenFin views not consuming mouse events.
-     *
-     * @param enabled If true, all mouse events are ignored by openfin views. If false, all OpenFin views will consume mouse events.
-     */
-    setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
-}
-
 /**
  * Represents the payload shape for Views that are trying to prevent an unload.
  * @interface
@@ -17846,6 +17898,8 @@ declare type WebRequestHeader = {
     [key: string]: string;
 };
 
+declare type WebSocketReadyState = WebSocket['readyState'];
+
 /**
  * Generated when a window is being moved by the user.
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
@@ -18816,7 +18870,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * ```
      * @experimental
      */
-    getLayout(): Promise<OpenFin.Layout>;
+    getLayout(layoutIdentity?: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
     /**
      * Gets the current settings of the window.
      *
@@ -19558,6 +19612,22 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
          type: 'closing';
      };
 
+     /**
+      * A rule prescribing content creation in a {@link OpenFin.Window}.
+      *
+      * @interface
+      */
+     declare type WindowContentCreationRule = BaseContentCreationRule & {
+         /**
+          * Behavior to use when opening matched content.
+          */
+         behavior: 'window';
+         /**
+          * Options for newly-created window.
+          */
+         options?: Partial<WindowOptions>;
+     };
+
      /**
       * Generated when a child window is created.
       * @interface
@@ -19682,6 +19752,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
              WillMoveEvent,
              WillResizeEvent,
              NonPropagatedWindowEvent,
+             ShowAllDownloadsEvent,
+             DownloadShelfVisibilityChangedEvent,
              WindowSourcedEvent,
              WillPropagateWindowEvent,
              WindowEvent,
@@ -19901,7 +19973,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
       * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
       * from {@link OpenFin.ViewEvents}.
       */
-     declare type WindowSourcedEvent = WebContentsEvent<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | WindowHiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent_2 | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent;
+     declare type WindowSourcedEvent = WebContentsEvent<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | WindowHiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent_2 | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
 
      /**
       * Generated when a child window starts loading.
@@ -19933,7 +20005,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      };
 
      declare type Wire = EventEmitter & {
-         connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
+         connect(messageReciever: MessageReceiver): Promise<any>;
          connectSync(): any;
          send(data: any): Promise<any>;
          shutdown(): Promise<void>;