@openfin/fdc3-api 36.80.11 → 36.80.25

package/out/fdc3-api-beta.d.ts

@@ -42,6 +42,15 @@ declare type Accelerator = {
     zoom: boolean;
 };
 
+/**
+ * Generated when a View is added to a layout.
+ * @interface
+ */
+declare type AddedToLayoutEvent = BaseEvent_4 & {
+    type: 'added-to-layout';
+    layoutIdentity: OpenFin.LayoutIdentity;
+};
+
 /**
  * Options to use when adding a view to a {@link TabStack}.
  *
@@ -99,7 +108,7 @@ declare type ApiInjection = DomainApiSettings;
  * Generated when a new Platform's API becomes responsive.
  * @interface
  */
-declare type ApiReadyEvent = BaseEvent & {
+declare type ApiReadyEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-api-ready';
 };
@@ -936,7 +945,7 @@ declare namespace ApplicationEvents {
         PropagatedApplicationEvent,
         PropagatedEventType_3 as PropagatedEventType,
         PropagatedApplicationEventType,
-        Payload_4 as Payload,
+        Payload_5 as Payload,
         ByType_3 as ByType
     }
 }
@@ -1178,9 +1187,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     mainWindowOptions: WindowCreationOptions;
     /**
-     * The name of the application (and the application's main window).
+     * The name of the application.
+     *
+     * @remarks
+     * This property is used for naming the application logging folder, which will be sanitized to remove
+     * any special characters, spaces or international characters. It's also used in error messages, API
+     * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
      *
-     * If provided, _must_ match `uuid`.
+     * This property will be deprecated in the future.
      */
     name: string;
     /**
@@ -1210,9 +1224,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
     url: string;
     /**
      * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
-     *  running in the OpenFin Runtime.
-     *
-     * Note that `name` and `uuid` must match.
+     * running in the OpenFin Runtime.
      */
     uuid: string;
     /**
@@ -1772,7 +1784,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
  * A base Channel event.
  * @interface
  */
-declare type BaseEvent_2 = NamedEvent & {
+declare type BaseEvent_2 = BaseEvents.NamedEvent & {
     channelName: string;
     channelId: string;
 };
@@ -1842,6 +1854,7 @@ declare namespace BaseEvents {
         NotCloseRequested,
         PropagatedEventType,
         PropagatedEvent,
+        Payload_2 as Payload,
         EventHandler,
         BaseEvent,
         IdentityEvent,
@@ -1975,48 +1988,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
     behavior: 'browser';
 };
 
-declare interface BrowserWindow {
-    /**
-     * True if the window has been opened and its GoldenLayout instance initialised.
-     */
-    isInitialised: boolean;
-
-    /**
-     * Creates a window configuration object from the Popout.
-     */
-    toConfig(): {
-        dimensions: {
-            width: number;
-            height: number;
-            left: number;
-            top: number;
-        };
-        content: Config;
-        parentId: string;
-        indexInParent: number;
-    };
-
-    /**
-     * Returns the GoldenLayout instance from the child window
-     */
-    getGlInstance(): GoldenLayout_2;
-
-    /**
-     * Returns the native Window object
-     */
-    getWindow(): Window;
-
-    /**
-     * Closes the popout
-     */
-    close(): void;
-
-    /**
-     * Returns the popout to its original position as specified in parentId and indexInParent
-     */
-    popIn(): void;
-}
-
 /**
  * Extracts a single event type matching the given key from the View {@link Event} union.
  *
@@ -2024,7 +1995,7 @@ declare interface BrowserWindow {
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType<Type extends EventType> = Payload_2<Type>;
+declare type ByType<Type extends EventType> = Payload_3<Type>;
 
 /**
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -2033,7 +2004,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
+declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
 
 /**
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -2042,7 +2013,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
+declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
 
 /**
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -2051,7 +2022,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
+declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
 
 /**
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -2060,7 +2031,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
+declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
 
 /**
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -2069,7 +2040,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
+declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
 
 /**
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -2078,7 +2049,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
+declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
 
 /**
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -2087,7 +2058,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
+declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
 
 /**
  * Configuration for page capture.
@@ -3436,31 +3407,6 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
     close(): Promise<void>;
 }
 
-declare interface ComponentConfig extends ItemConfig {
-    /**
-     * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
-     */
-    componentName: string;
-
-    /**
-     * A serialisable object. Will be passed to the component constructor function and will be the value returned by
-     * container.getState().
-     */
-    componentState?: any;
-}
-
-declare interface Config {
-    settings?: Settings;
-    dimensions?: Dimensions;
-    labels?: Labels;
-    content?: ItemConfigType[];
-    /**
-     * (Only on layout config object)
-     * Id of the currently maximised content item
-     */
-    maximisedItemId?: string;
-}
-
 declare type ConfigWithRuntime = BaseConfig & {
     runtime: RuntimeConfig;
 };
@@ -3748,7 +3694,9 @@ declare type ConstWindowOptions = {
      */
     preloadScripts: PreloadScript[];
     /**
-     * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
+     * String tag that attempts to group like-tagged renderers together.
+     * However, there is no guarantee that a different affinity value will create a different process, under the hood Chromium can enforce its own process management under certain circumstances.
+     * @remarks Will only be used if pages are on the same origin.
      */
     processAffinity: string;
     /**
@@ -3838,103 +3786,6 @@ declare type ConstWindowOptions = {
     inheritance?: Partial<InheritableOptions>;
 };
 
-declare interface Container extends EventEmitter_2 {
-    /**
-     * The current width of the container in pixel
-     */
-    width: number;
-
-    /**
-     * The current height of the container in pixel
-     */
-    height: number;
-
-    /**
-     * A reference to the component-item that controls this container
-     */
-    parent: ContentItem;
-
-    /**
-     * A reference to the tab that controls this container. Will initially be null
-     * (and populated once a tab event has been fired).
-     */
-    tab: Tab;
-
-    /**
-     * The current title of the container
-     */
-    title: string;
-
-    /*
-    * A reference to the GoldenLayout instance this container belongs to
-    */
-    layoutManager: GoldenLayout_2;
-
-    /**
-     * True if the item is currently hidden
-     */
-    isHidden: boolean;
-
-    /**
-     * Overwrites the components state with the provided value. To only change parts of the componentState see
-     * extendState below. This is the main mechanism for saving the state of a component. This state will be the
-     * value of componentState when layout.toConfig() is called and will be passed back to the component's
-     * constructor function. It will also be used when the component is opened in a new window.
-     * @param state A serialisable object
-     */
-    setState(state: any): void;
-
-    /**
-     * The same as setState but does not emit 'stateChanged' event
-     * @param {serialisable} state
-     */
-    setStateSkipEvent(state: any): void;
-
-    /**
-     * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
-     * @param state A serialisable object
-     */
-    extendState(state: any): void;
-
-    /**
-     * Returns the current state.
-     */
-    getState(): any;
-
-    /**
-     * Returns the container's inner element as a jQuery element
-     */
-    getElement(): JQuery;
-
-    /**
-     * hides the container or returns false if hiding it is not possible
-     */
-    hide(): boolean;
-
-    /**
-     * shows the container or returns false if showing it is not possible
-     */
-    show(): boolean;
-
-    /**
-     * Sets the container to the specified size or returns false if that's not possible
-     * @param width the new width in pixel
-     * @param height the new height in pixel
-     */
-    setSize(width: number, height: number): boolean;
-
-    /**
-     * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
-     * @param title the new title
-     */
-    setTitle(title: string): void;
-
-    /**
-     * Closes the container or returns false if that is not possible
-     */
-    close(): boolean;
-}
-
 declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
 
 /**
@@ -3997,218 +3848,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
     disposition: string;
 };
 
-declare interface ContentItem extends EventEmitter_2 {
-    instance: any;
-    header: any;
-    _splitter: any;
-    /**
-     * This items configuration in its current state
-     */
-    config: ItemConfigType;
-
-    /**
-     * The type of the item. Can be row, column, stack, component or root
-     */
-    type: ItemType;
-
-    /**
-     * An array of items that are children of this item
-     */
-    contentItems: ContentItem[];
-
-    container: Container;
-    /**
-     * The item that is this item's parent (or null if the item is root)
-     */
-    parent: ContentItem;
-
-    /**
-     * A String or array of identifiers if provided in the configuration
-     */
-    id: string;
-
-    /**
-     * True if the item had been initialised
-     */
-    isInitialised: boolean;
-
-    /**
-     * True if the item is maximised
-     */
-    isMaximised: boolean;
-
-    /**
-     * True if the item is the layout's root item
-     */
-    isRoot: boolean;
-
-    /**
-     * True if the item is a row
-     */
-    isRow: boolean;
-
-    /**
-     * True if the item is a column
-     */
-    isColumn: boolean;
-
-    /**
-     * True if the item is a stack
-     */
-    isStack: boolean;
-
-    /**
-     * True if the item is a component
-     */
-    isComponent: boolean;
-
-    /**
-     * A reference to the layoutManager that controls this item
-     */
-    layoutManager: any;
-
-    /**
-     * The item's outer element
-     */
-    element: JQuery;
-
-    /**
-     * The item's inner element. Can be the same as the outer element.
-     */
-    childElementContainer: Container;
-
-    /**
-     * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
-     * from its original position before adding it to this item.
-     * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
-     * @param index last index  An optional index that determines at which position the new item should be added. Default: last index.
-     */
-    addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
-
-    /**
-     * Destroys the item and all it's children
-     * @param contentItem The contentItem that should be removed
-     * @param keepChild If true the item won't be destroyed. (Use cautiosly, if the item isn't destroyed it's up to you to destroy it later). Default: false.
-     */
-    removeChild(contentItem: ContentItem, keepChild?: boolean): void;
-
-    /**
-     * The contentItem that should be removed
-     * @param oldChild    ContentItem The contentItem that should be removed
-     * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
-     */
-    replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
-
-    /**
-     * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
-     */
-    setSize(): void;
-
-    /**
-     * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
-     * @param title the new title
-     */
-    setTitle(title: string): void;
-
-    /**
-     * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
-     * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
-     * @param functionName The name of the method to invoke
-     * @param functionArguments An array of arguments to pass to every function
-     * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
-     * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
-     */
-    callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
-
-    /**
-     * Emits an event that bubbles up the item tree until it reaches the root element (and after a delay the layout manager). Useful e.g. for indicating state changes.
-     */
-    emitBubblingEvent(name: string): void;
-
-    /**
-     * Convenience method for item.parent.removeChild( item )
-     */
-    remove(): void;
-
-    /**
-     * Removes the item from its current position in the layout and opens it in a window
-     */
-    popout(): BrowserWindow;
-
-    /**
-     * Maximises the item or minimises it if it's already maximised
-     */
-    toggleMaximise(): void;
-
-    /**
-     * Selects the item. Only relevant if settings.selectionEnabled is set to true
-     */
-    select(): void;
-
-    /**
-     * Unselects the item. Only relevant if settings.selectionEnabled is set to true
-     */
-    deselect(): void;
-
-    /**
-     * Returns true if the item has the specified id or false if not
-     * @param id An id to check for
-     */
-    hasId(id: string): boolean;
-
-    /**
-     * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
-     * @param contentItem The new active content item
-     * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
-     */
-    // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
-    setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
-
-    /**
-     * Only Stacks have this method! Returns the currently selected contentItem.
-     */
-    getActiveContentItem(): ContentItem;
-
-    /**
-     * Adds an id to an item or does nothing if the id is already present
-     * @param id The id to be added
-     */
-    addId(id: string): void;
-
-    /**
-     * Removes an id from an item or throws an error if the id couldn't be found
-     * @param id The id to be removed
-     */
-    removeId(id: string): void;
-
-    /**
-     * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
-     * @param filterFunction A function that determines whether an item matches certain criteria
-     */
-    getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
-
-    /**
-     * Returns all items with the specified id.
-     * @param id An id specified in the itemConfig
-     */
-    getItemsById(id: string | string[]): ContentItem[];
-
-    /**
-     * Returns all items with the specified type
-     * @param type 'row', 'column', 'stack', 'component' or 'root'
-     */
-    getItemsByType(type: string): ContentItem[];
-
-    /**
-     * Returns all instances of the component with the specified componentName
-     * @param componentName a componentName as specified in the itemConfig
-     */
-    getComponentsByName(componentName: string): any;
-
-    _contentAreaDimensions: any;
-    _$getArea: () => any;
-}
-
 /**
  * Restrict navigation to URLs that match an allowed pattern.
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4693,46 +4332,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
     type: 'did-finish-load';
 };
 
-declare interface Dimensions {
-    /**
-     * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
-     * than the visible one, making it safe to set this to small values without affecting usability.
-     * Default: 5
-     */
-    borderWidth?: number;
-
-    /**
-     * The minimum height an item can be resized to (in pixel).
-     * Default: 10
-     */
-    minItemHeight?: number;
-
-    /**
-     * The minimum width an item can be resized to (in pixel).
-     * Default: 10
-     */
-    minItemWidth?: number;
-
-    /**
-     * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
-     * adjusted accordingly.
-     * Default: 20
-     */
-    headerHeight?: number;
-
-    /**
-     * The width of the element that appears when an item is dragged (in pixel).
-     * Default: 300
-     */
-    dragProxyWidth?: number;
-
-    /**
-     * The height of the element that appears when an item is dragged (in pixel).
-     * Default: 200
-     */
-    dragProxyHeight?: number;
-}
-
 /**
  * @interface
  */
@@ -5029,8 +4628,6 @@ declare type Dpi = {
     vertical?: number;
 };
 
-declare interface DragSource {}
-
 /**
  * Generated when a window has been embedded.
  * @interface
@@ -5298,7 +4895,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
     target: OpenFin.Identity;
-}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
+}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -5342,51 +4939,12 @@ declare class EventAggregator extends EmitterMap {
     dispatchEvent: (message: Message<any>) => boolean;
 }
 
-declare interface EventEmitter_2 {
-    [x: string]: any;
-    /**
-     * Subscribe to an event
-     * @param eventName The name of the event to describe to
-     * @param callback The function that should be invoked when the event occurs
-     * @param context The value of the this pointer in the callback function
-     */
-    on(eventName: string, callback: Function, context?: any): void;
-
-    /**
-     * Notify listeners of an event and pass arguments along
-     * @param eventName The name of the event to emit
-     */
-    emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
-
-    /**
-     * Alias for emit
-     */
-    trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
-
-    /**
-     * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
-     * eventName and callback or just a specific callback with a specific context if invoked with all three
-     * arguments.
-     * @param eventName The name of the event to unsubscribe from
-     * @param callback The function that should be invoked when the event occurs
-     * @param context The value of the this pointer in the callback function
-     */
-    unbind(eventName: string, callback?: Function, context?: any): void;
-
-    /**
-     * Alias for unbind
-     */
-    off(eventName: string, callback?: Function, context?: any): void;
-}
-
 /**
  * Handler for an event on an EventEmitter.
  * @remarks Selects the correct type for the event
  * payload from the provided union based on the provided string literal type.
  */
-declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
-    type: EventType;
-}>, ...args: any[]) => void;
+declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
 
 declare namespace Events {
     export {
@@ -5517,7 +5075,7 @@ declare namespace ExternalApplicationEvents {
         ExternalApplicationEvent,
         EventType_4 as EventType,
         ExternalApplicationEventType,
-        Payload_5 as Payload,
+        Payload_6 as Payload,
         ByType_4 as ByType
     }
 }
@@ -6297,7 +5855,7 @@ declare namespace FrameEvents {
         FrameEvent,
         EventType_5 as EventType,
         FrameEventType,
-        Payload_6 as Payload,
+        Payload_7 as Payload,
         ByType_5 as ByType
     }
 }
@@ -6491,297 +6049,64 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
      *
      * @remarks Raises the `unregistered` event for each hotkey unregistered.
      *
-     * @example
-     * ```js
-     * fin.GlobalHotkey.unregisterAll()
-     * .then(() => {
-     *     console.log('Success');
-     * })
-     * .catch(err => {
-     *     console.log('Error unregistering all hotkeys for this application', err);
-     * });
-     * ```
-     */
-    unregisterAll(): Promise<void>;
-    /**
-     * Checks if a given hotkey has been registered by an application within the current runtime.
-     * @param hotkey a hotkey string
-     *
-     * @example
-     * ```js
-     * const hotkey = 'CommandOrControl+X';
-     *
-     * fin.GlobalHotkey.isRegistered(hotkey)
-     * .then((registered) => {
-     *     console.log(`hotkey ${hotkey} is registered ? ${registered}`);
-     * })
-     * .catch(err => {
-     *     console.log('Error unregistering the hotkey', err);
-     * });
-     * ```
-     */
-    isRegistered(hotkey: string): Promise<boolean>;
-}
-
-/**
- * @deprecated Renamed to {@link Event}.
- */
-declare type GlobalHotkeyEvent = Event_9;
-
-declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
-
-declare namespace GlobalHotkeyEvents {
-    export {
-        BaseEvent_8 as BaseEvent,
-        RegisteredEvent,
-        UnregisteredEvent,
-        Event_9 as Event,
-        GlobalHotkeyEvent,
-        EventType_6 as EventType,
-        GlobalHotkeyEventType,
-        Payload_7 as Payload,
-        ByType_6 as ByType
-    }
-}
-
-/**
- * @deprecated Renamed to {@link EventType}.
- */
-declare type GlobalHotkeyEventType = EventType_6;
-
-declare namespace GoldenLayout {
-    export {
-        GoldenLayout_2 as GoldenLayout,
-        ItemConfigType,
-        Settings,
-        Dimensions,
-        Labels,
-        ItemType,
-        ItemConfig,
-        ComponentConfig,
-        ReactComponentConfig,
-        Config,
-        ContentItem,
-        Container,
-        DragSource,
-        BrowserWindow,
-        Header,
-        TabDragListener,
-        Tab,
-        EventEmitter_2 as EventEmitter
-    }
-}
-
-declare class GoldenLayout_2 implements EventEmitter_2 {
-    /**
-     * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
-     * object and of goldenLayout.root as the document.
-     */
-    root: ContentItem;
-
-    /**
-     * A reference to the (jQuery) DOM element containing the layout
-     */
-    container: JQuery;
-
-    /**
-     * True once the layout item tree has been created and the initialised event has been fired
-     */
-    isInitialised: boolean;
-
-    /**
-     * A reference to the current, extended top level config.
-     *
-     * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
-     */
-    config: Config;
-
-    /**
-     * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
-     * to true.
-     */
-    selectedItem: ContentItem;
-
-    /**
-     * The current outer width of the layout in pixels.
-     */
-    width: number;
-
-    /**
-     * The current outer height of the layout in pixels.
-     */
-    height: number;
-
-    /**
-     * An array of BrowserWindow instances
-     */
-    openPopouts: BrowserWindow[];
-
-    /**
-     * True if the layout has been opened as a popout by another layout.
-     */
-    isSubWindow: boolean;
-
-    /**
-     * A singleton instance of EventEmitter that works across windows
-     */
-    eventHub: EventEmitter_2;
-
-    _dragProxy: any;
-
-    dropTargetIndicator: any;
-
-    /**
-     * @param config A GoldenLayout configuration object
-     * @param container The DOM element the layout will be initialised in. Default: document.body
-     */
-    constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
-
-    /*
-    * @param name 	The name of the component, as referred to by componentName in the component configuration.
-    * @param component 	A constructor or factory function. Will be invoked with new and two arguments, a
-    *                      containerobject and a component state
-    */
-    registerComponent(name: String, component: any): void;
-
-    /**
-     * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
-     * a listener to the document and executes once it becomes ready.
-     */
-    init(): void;
-
-    /**
-     * Returns the current state of the layout and its components as a serialisable object.
-     */
-    toConfig(): Config;
-
-    /**
-     * Returns a component that was previously registered with layout.registerComponent().
-     * @param name The name of a previously registered component
-     */
-    getComponent(name: string): any;
-
-    /**
-     * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
-     * @param width The outer width the layout should be resized to. Default: The container elements width
-     * @param height The outer height the layout should be resized to. Default: The container elements height
-     */
-    updateSize(width?: number, height?: number): void;
-
-    /**
-     * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
-     * listeners and finally removes itself from the DOM.
-     */
-    destroy(): void;
-
-    /**
-     * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
-     * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
-     * all call this method implicitly.
-     * @param itemConfiguration An item configuration (can be an entire tree of items)
-     * @param parent A parent item
-     */
-    createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
-
-    /**
-     * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
-     * @param configOrContentItem   The content item or config that will be created in the new window. If a item is
-     *                              provided its config will be read, if config is provided, only the content key
-     *                              will be used
-     * @param dimensions    A map containing the keys left, top, width and height. Left and top can be negative to
-     *                      place the window in another screen.
-     * @param parentId  The id of the item within the current layout the child window's content will be appended to
-     *                  when popIn is clicked
-     * @param indexInParent The index at which the child window's contents will be appended to. Default: null
-     */
-    createPopout(
-    configOrContentItem: ItemConfigType | ContentItem,
-    dimensions: {
-        width: number;
-        height: number;
-        left: number;
-        top: number;
-    },
-    parentId?: string,
-    indexInParent?: number
-    ): void;
-
-    /**
-     * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
-     * where it turns into a contentItem.
-     * @param element The DOM element that will be turned into a dragSource
-     * @param itemConfiguration An item configuration (can be an entire tree of items)
-     * @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;
-
-    /**
-     * Removes a dragSource from the layout.
-     *
-     * @param dragSource The dragSource to remove
-     */
-    removeDragSource(dragSource: DragSource): void;
-
-    /**
-     * If settings.selectionEnabled is set to true, this allows to select items programmatically.
-     * @param contentItem A ContentItem instance
-     */
-    selectItem(contentItem: ContentItem): void;
-
-    /**
-     * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
-     * and replace frequent keys and values with single letter substitutes.
-     * @param config A GoldenLayout configuration object
-     */
-    static minifyConfig(config: any): any;
-
-    /**
-     * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
-     * @param minifiedConfig A minified GoldenLayout configuration object
-     */
-    static unminifyConfig(minifiedConfig: any): any;
-
-    /**
-     * Subscribe to an event
-     * @param eventName The name of the event to describe to
-     * @param callback The function that should be invoked when the event occurs
-     * @param context The value of the this pointer in the callback function
-     */
-    on(eventName: string, callback: Function, context?: any): void;
-
-    /**
-     * Notify listeners of an event and pass arguments along
-     * @param eventName The name of the event to emit
+     * @example
+     * ```js
+     * fin.GlobalHotkey.unregisterAll()
+     * .then(() => {
+     *     console.log('Success');
+     * })
+     * .catch(err => {
+     *     console.log('Error unregistering all hotkeys for this application', err);
+     * });
+     * ```
      */
-    emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
-
+    unregisterAll(): Promise<void>;
     /**
-     * Alias for emit
+     * Checks if a given hotkey has been registered by an application within the current runtime.
+     * @param hotkey a hotkey string
+     *
+     * @example
+     * ```js
+     * const hotkey = 'CommandOrControl+X';
+     *
+     * fin.GlobalHotkey.isRegistered(hotkey)
+     * .then((registered) => {
+     *     console.log(`hotkey ${hotkey} is registered ? ${registered}`);
+     * })
+     * .catch(err => {
+     *     console.log('Error unregistering the hotkey', err);
+     * });
+     * ```
      */
-    trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
+    isRegistered(hotkey: string): Promise<boolean>;
+}
 
-    /**
-     * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
-     * eventName and callback or just a specific callback with a specific context if invoked with all three
-     * arguments.
-     * @param eventName The name of the event to unsubscribe from
-     * @param callback The function that should be invoked when the event occurs
-     * @param context The value of the this pointer in the callback function
-     */
-    unbind(eventName: string, callback?: Function, context?: any): void;
+/**
+ * @deprecated Renamed to {@link Event}.
+ */
+declare type GlobalHotkeyEvent = Event_9;
 
-    /**
-     * Alias for unbind
-     */
-    off(eventName: string, callback?: Function, context?: any): void;
+declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
 
-    /**
-     * Internal method that create drop areas on the far edges of window, e.g. far-right of window
-     */
-    _$createRootItemAreas(): void;
+declare namespace GlobalHotkeyEvents {
+    export {
+        BaseEvent_8 as BaseEvent,
+        RegisteredEvent,
+        UnregisteredEvent,
+        Event_9 as Event,
+        GlobalHotkeyEvent,
+        EventType_6 as EventType,
+        GlobalHotkeyEventType,
+        Payload_8 as Payload,
+        ByType_6 as ByType
+    }
 }
 
+/**
+ * @deprecated Renamed to {@link EventType}.
+ */
+declare type GlobalHotkeyEventType = EventType_6;
+
 /**
  * @interface
  */
@@ -6789,62 +6114,6 @@ declare type GpuInfo = {
     name: string;
 };
 
-declare interface Header {
-    /**
-     * A reference to the LayoutManager instance
-     */
-    layoutManager: GoldenLayout_2;
-
-    /**
-     * A reference to the Stack this Header belongs to
-     */
-    parent: ContentItem;
-
-    /**
-     * An array of the Tabs within this header
-     */
-    tabs: Tab[];
-
-    /**
-     * The currently selected activeContentItem
-     */
-    activeContentItem: ContentItem;
-
-    /**
-     * The outer (jQuery) DOM element of this Header
-     */
-    element: JQuery;
-
-    /**
-     * The (jQuery) DOM element containing the tabs
-     */
-    tabsContainer: JQuery;
-
-    /**
-     * The (jQuery) DOM element containing the close, maximise and popout button
-     */
-    controlsContainer: JQuery;
-
-    /**
-     * Hides the currently selected contentItem, shows the specified one and highlights its tab.
-     * @param contentItem The content item that will be selected
-     */
-    setActiveContentItem(contentItem: ContentItem): void;
-
-    /**
-     * Creates a new tab and associates it with a content item
-     * @param contentItem The content item the tab will be associated with
-     * @param index A zero based index, specifying the position of the new tab
-     */
-    createTab(contentItem: ContentItem, index?: number): void;
-
-    /**
-     * Finds a tab by its contentItem and removes it
-     * @param contentItem The content item the tab is associated with
-     */
-    removeTab(contentItem: ContentItem): void;
-}
-
 /**
  * Generated when a View is hidden.
  * @interface
@@ -8513,50 +7782,6 @@ declare class InteropModule extends Base {
     connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
 }
 
-declare interface ItemConfig {
-    /**
-     * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
-     */
-    type: ItemType;
-
-    /**
-     * An array of configurations for items that will be created as children of this item.
-     */
-    content?: ItemConfigType[];
-
-    /**
-     * The width of this item, relative to the other children of its parent in percent
-     */
-    width?: number;
-
-    /**
-     * The height of this item, relative to the other children of its parent in percent
-     */
-    height?: number;
-
-    /**
-     * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
-     */
-    id?: string | string[];
-
-    /**
-     * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
-     * will return false
-     * Default: true
-     */
-    isClosable?: boolean;
-
-    /**
-     * The title of the item as displayed on its tab and on popout windows
-     * Default: componentName or ''
-     */
-    title?: string;
-}
-
-declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
-
-declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
-
 /**
  * @interface
  */
@@ -8614,32 +7839,6 @@ declare type JumpListTask = {
     iconIndex?: number;
 };
 
-declare interface Labels {
-    /**
-     * The tooltip text that appears when hovering over the close icon.
-     * Default: 'close'
-     */
-    close?: string;
-
-    /**
-     * The tooltip text that appears when hovering over the maximise icon.
-     * Default: 'maximise'
-     */
-    maximise?: string;
-
-    /**
-     * The tooltip text that appears when hovering over the minimise icon.
-     * Default: 'minimise'
-     */
-    minimise?: string;
-
-    /**
-     * The tooltip text that appears when hovering over the popout icon.
-     * Default: 'open in new window'
-     */
-    popout?: string;
-}
-
 /**
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
  *
@@ -9065,7 +8264,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
     entityId: string;
 };
 
-declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
+declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
 
 /**
  * @interface
@@ -10673,76 +9872,100 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
 };
 
 /**
- * Extracts a single event type matching the given key from the View {@link Event} union.
+ * Extracts a single event type matching the given key from the System {@link Event} union.
+ *
+ * @see {@link ByType}
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_2<Type extends EventType> = Extract<Event_4, {
-    type: Type;
+declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
+
+/**
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
+ *
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
+ * the appropriate payload union for that namespace.
+ *
+ * @typeParam Event Union of payloads for events on the given emitter
+ * @see {@link ByType}
+ *
+ * @typeParam Type String key specifying the event to extract from the union
+ *
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
+ */
+declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
+    type: EventType;
 }>;
 
+/**
+ * Extracts a single event type matching the given key from the View {@link Event} union.
+ *
+ * @see {@link ByType}
+ *
+ * @typeParam Type String key specifying the event to extract
+ */
+declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
+
 /**
  * Extracts a single event type matching the given key from the Window {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
-    type: Type;
-}>;
+declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
 
 /**
  * Extracts a single event type matching the given key from the Application {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
-    type: Type;
-}>;
+declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
 
 /**
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
-    type: Type;
-}>;
+declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
 
 /**
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
-    type: Type;
-}>;
+declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
 
 /**
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
-    type: Type;
-}>;
+declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
 
 /**
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
  *
- * @typeParam Type String key specifying the event to extract
- */
-declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
-    type: Type;
-}>;
-
-/**
- * Extracts a single event type matching the given key from the System {@link Event} union.
+ * @see {@link ByType}
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
-    type: Type;
-}>;
+declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
 
 declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
 
@@ -11406,7 +10629,7 @@ declare namespace PlatformEvents {
         PlatformEvent,
         EventType_7 as EventType,
         PlatformEventType,
-        Payload_8 as Payload,
+        Payload_9 as Payload,
         ByType_7 as ByType
     }
 }
@@ -12990,18 +12213,6 @@ declare type QueryPermissionResult = {
     rawValue?: unknown;
 };
 
-declare interface ReactComponentConfig extends ItemConfig {
-    /**
-     * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
-     */
-    component: string;
-
-    /**
-     * Properties that will be passed to the component and accessible using this.props.
-     */
-    props?: any;
-}
-
 /**
  * @interface
  */
@@ -13089,6 +12300,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
     token: string;
 }
 
+/**
+ * Generated when a View is removed from a layout.
+ * @interface
+ */
+declare type RemovedFromLayoutEvent = BaseEvent_4 & {
+    type: 'removed-from-layout';
+    layoutIdentity: OpenFin.LayoutIdentity;
+};
+
 /**
  * @interface
  */
@@ -13508,97 +12728,6 @@ declare type SessionContextGroup = {
     }>;
 };
 
-declare interface Settings {
-    preventSplitterResize?: boolean;
-
-    newTabButton?: {
-        url?: string;
-    };
-
-    /**
-     * If true, tabs can't be dragged into the window.
-     * Default: false
-     */
-    preventDragIn?: boolean;
-
-    /**
-     * If true, tabs can't be dragged out of the window.
-     * Default: false
-     */
-    preventDragOut?: boolean;
-
-    /**
-     * If true, stack headers are the only areas where tabs can be dropped.
-     * Default: false
-     */
-    constrainDragToHeaders?: boolean;
-    /**
-     * Turns headers on or off. If false, the layout will be displayed with splitters only.
-     * Default: true
-     */
-    hasHeaders?: boolean;
-
-    /**
-     * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
-     * automatically when layout.createDragSource() is called.
-     * Default: true
-     */
-    constrainDragToContainer?: boolean;
-
-    /**
-     * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
-     * Default: true
-     */
-    reorderEnabled?: boolean;
-
-    /**
-     * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
-     * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
-     * Default: false
-     */
-    selectionEnabled?: boolean;
-
-    /**
-     * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
-     * be transferred to the new window, if false only the active component will be opened.
-     * Default: false
-     */
-    popoutWholeStack?: boolean;
-
-    /**
-     * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
-     * If false, the popout call will fail silently.
-     * Default: true
-     */
-    blockedPopoutsThrowError?: boolean;
-
-    /**
-     * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
-     * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
-     * addition, any changes made to popouts won't be stored after the parent is closed.
-     * Default: true
-     */
-    closePopoutsOnUnload?: boolean;
-
-    /**
-     * Specifies if the popout icon should be displayed in the header-bar.
-     * Default: true
-     */
-    showPopoutIcon?: boolean;
-
-    /**
-     * Specifies if the maximise icon should be displayed in the header-bar.
-     * Default: true
-     */
-    showMaximiseIcon?: boolean;
-
-    /**
-     * Specifies if the close icon should be displayed in the header-bar.
-     * Default: true
-     */
-    showCloseIcon?: boolean;
-}
-
 /**
  * @interface
  */
@@ -13822,7 +12951,7 @@ declare type Snapshot = {
  * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
  * @interface
  */
-declare type SnapshotAppliedEvent = BaseEvent & {
+declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
 };
@@ -15428,7 +14557,7 @@ declare namespace SystemEvents {
         SystemEvent,
         EventType_8 as EventType,
         SystemEventType,
-        Payload_9 as Payload,
+        Payload_10 as Payload,
         ByType_8 as ByType
     }
 }
@@ -15495,59 +14624,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
     proceed: () => void;
 }) => void;
 
-declare interface Tab {
-    _dragListener: TabDragListener;
-
-    /**
-     * True if this tab is the selected tab
-     */
-    isActive: boolean;
-
-    /**
-     * A reference to the header this tab is a child of
-     */
-    header: Header;
-
-    /**
-     * A reference to the content item this tab relates to
-     */
-    contentItem: ContentItem;
-
-    /**
-     * The tabs outer (jQuery) DOM element
-     */
-    element: JQuery;
-
-    /**
-     * The (jQuery) DOM element containing the title
-     */
-    titleElement: JQuery;
-
-    /**
-     * The (jQuery) DOM element that closes the tab
-     */
-    closeElement: JQuery;
-
-    /**
-     * Sets the tab's title. Does not affect the contentItem's title!
-     * @param title The new title
-     */
-    setTitle(title: string): void;
-
-    /**
-     * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
-     * @param isActive Whether the tab is active
-     */
-    setActive(isActive: boolean): void;
-}
-
-declare interface TabDragListener extends EventEmitter_2 {
-    /**
-     * A reference to the content item this tab relates to
-     */
-    contentItem: ContentItem;
-}
-
 /**
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
  */
@@ -16487,6 +15563,8 @@ declare namespace ViewEvents {
         BaseEvent_4 as BaseEvent,
         BaseViewEvent,
         TargetChangedEvent,
+        AddedToLayoutEvent,
+        RemovedFromLayoutEvent,
         NonPropagatedViewEvent,
         CreatedEvent,
         DestroyedEvent,
@@ -16503,7 +15581,7 @@ declare namespace ViewEvents {
         PropagatedViewEvent,
         PropagatedEventType_2 as PropagatedEventType,
         PropagatedViewEventType,
-        Payload_2 as Payload,
+        Payload_3 as Payload,
         ByType
     }
 }
@@ -18979,7 +18057,7 @@ declare namespace WindowEvents {
         PropagatedEvent_3 as PropagatedEvent,
         PropagatedWindowEvent,
         PropagatedWindowEventType,
-        Payload_3 as Payload,
+        Payload_4 as Payload,
         ByType_2 as ByType
     }
 }