@openfin/node-adapter 34.78.20 → 34.78.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,6 @@
2
2
  /// <reference types="node" />
3
3
 
4
4
  import { EventEmitter } from 'events';
5
- import type * as GoldenLayout from '@openfin/golden-layout';
6
5
 
7
6
  /**
8
7
  * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
@@ -1721,7 +1720,9 @@ declare type BaseConfig = {
1721
1720
  };
1722
1721
 
1723
1722
  /**
1724
- * A base event.
1723
+ * A base OpenFin event. All OpenFin event payloads extend this type.
1724
+ *
1725
+ * @interface
1725
1726
  */
1726
1727
  declare type BaseEvent = {
1727
1728
  topic: string;
@@ -1841,6 +1842,48 @@ declare type BoundsChangingEvent = BoundsChangeEvent & {
1841
1842
  type: 'bounds-changing';
1842
1843
  };
1843
1844
 
1845
+ declare interface BrowserWindow {
1846
+ /**
1847
+ * True if the window has been opened and its GoldenLayout instance initialised.
1848
+ */
1849
+ isInitialised: boolean;
1850
+
1851
+ /**
1852
+ * Creates a window configuration object from the Popout.
1853
+ */
1854
+ toConfig(): {
1855
+ dimensions: {
1856
+ width: number;
1857
+ height: number;
1858
+ left: number;
1859
+ top: number;
1860
+ };
1861
+ content: Config;
1862
+ parentId: string;
1863
+ indexInParent: number;
1864
+ };
1865
+
1866
+ /**
1867
+ * Returns the GoldenLayout instance from the child window
1868
+ */
1869
+ getGlInstance(): GoldenLayout_2;
1870
+
1871
+ /**
1872
+ * Returns the native Window object
1873
+ */
1874
+ getWindow(): Window;
1875
+
1876
+ /**
1877
+ * Closes the popout
1878
+ */
1879
+ close(): void;
1880
+
1881
+ /**
1882
+ * Returns the popout to its original position as specified in parentId and indexInParent
1883
+ */
1884
+ popIn(): void;
1885
+ }
1886
+
1844
1887
  /**
1845
1888
  * Configuration for page capture.
1846
1889
  *
@@ -3253,6 +3296,31 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
3253
3296
  close(): Promise<void>;
3254
3297
  }
3255
3298
 
3299
+ declare interface ComponentConfig extends ItemConfig {
3300
+ /**
3301
+ * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3302
+ */
3303
+ componentName: string;
3304
+
3305
+ /**
3306
+ * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3307
+ * container.getState().
3308
+ */
3309
+ componentState?: any;
3310
+ }
3311
+
3312
+ declare interface Config {
3313
+ settings?: Settings;
3314
+ dimensions?: Dimensions;
3315
+ labels?: Labels;
3316
+ content?: ItemConfigType[];
3317
+ /**
3318
+ * (Only on layout config object)
3319
+ * Id of the currently maximised content item
3320
+ */
3321
+ maximisedItemId?: string;
3322
+ }
3323
+
3256
3324
  declare type ConfigWithRuntime = BaseConfig & {
3257
3325
  runtime: RuntimeConfig;
3258
3326
  };
@@ -3547,6 +3615,103 @@ declare type ConstWindowOptions = {
3547
3615
  viewVisibility?: ViewVisibilityOptions;
3548
3616
  };
3549
3617
 
3618
+ declare interface Container extends EventEmitter_2 {
3619
+ /**
3620
+ * The current width of the container in pixel
3621
+ */
3622
+ width: number;
3623
+
3624
+ /**
3625
+ * The current height of the container in pixel
3626
+ */
3627
+ height: number;
3628
+
3629
+ /**
3630
+ * A reference to the component-item that controls this container
3631
+ */
3632
+ parent: ContentItem;
3633
+
3634
+ /**
3635
+ * A reference to the tab that controls this container. Will initially be null
3636
+ * (and populated once a tab event has been fired).
3637
+ */
3638
+ tab: Tab;
3639
+
3640
+ /**
3641
+ * The current title of the container
3642
+ */
3643
+ title: string;
3644
+
3645
+ /*
3646
+ * A reference to the GoldenLayout instance this container belongs to
3647
+ */
3648
+ layoutManager: GoldenLayout_2;
3649
+
3650
+ /**
3651
+ * True if the item is currently hidden
3652
+ */
3653
+ isHidden: boolean;
3654
+
3655
+ /**
3656
+ * Overwrites the components state with the provided value. To only change parts of the componentState see
3657
+ * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3658
+ * value of componentState when layout.toConfig() is called and will be passed back to the component's
3659
+ * constructor function. It will also be used when the component is opened in a new window.
3660
+ * @param state A serialisable object
3661
+ */
3662
+ setState(state: any): void;
3663
+
3664
+ /**
3665
+ * The same as setState but does not emit 'stateChanged' event
3666
+ * @param {serialisable} state
3667
+ */
3668
+ setStateSkipEvent(state: any): void;
3669
+
3670
+ /**
3671
+ * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3672
+ * @param state A serialisable object
3673
+ */
3674
+ extendState(state: any): void;
3675
+
3676
+ /**
3677
+ * Returns the current state.
3678
+ */
3679
+ getState(): any;
3680
+
3681
+ /**
3682
+ * Returns the container's inner element as a jQuery element
3683
+ */
3684
+ getElement(): JQuery;
3685
+
3686
+ /**
3687
+ * hides the container or returns false if hiding it is not possible
3688
+ */
3689
+ hide(): boolean;
3690
+
3691
+ /**
3692
+ * shows the container or returns false if showing it is not possible
3693
+ */
3694
+ show(): boolean;
3695
+
3696
+ /**
3697
+ * Sets the container to the specified size or returns false if that's not possible
3698
+ * @param width the new width in pixel
3699
+ * @param height the new height in pixel
3700
+ */
3701
+ setSize(width: number, height: number): boolean;
3702
+
3703
+ /**
3704
+ * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3705
+ * @param title the new title
3706
+ */
3707
+ setTitle(title: string): void;
3708
+
3709
+ /**
3710
+ * Closes the container or returns false if that is not possible
3711
+ */
3712
+ close(): boolean;
3713
+ }
3714
+
3550
3715
  declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3551
3716
 
3552
3717
  /**
@@ -3617,6 +3782,218 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3617
3782
  disposition: string;
3618
3783
  };
3619
3784
 
3785
+ declare interface ContentItem extends EventEmitter_2 {
3786
+ instance: any;
3787
+ header: any;
3788
+ _splitter: any;
3789
+ /**
3790
+ * This items configuration in its current state
3791
+ */
3792
+ config: ItemConfigType;
3793
+
3794
+ /**
3795
+ * The type of the item. Can be row, column, stack, component or root
3796
+ */
3797
+ type: ItemType;
3798
+
3799
+ /**
3800
+ * An array of items that are children of this item
3801
+ */
3802
+ contentItems: ContentItem[];
3803
+
3804
+ container: Container;
3805
+ /**
3806
+ * The item that is this item's parent (or null if the item is root)
3807
+ */
3808
+ parent: ContentItem;
3809
+
3810
+ /**
3811
+ * A String or array of identifiers if provided in the configuration
3812
+ */
3813
+ id: string;
3814
+
3815
+ /**
3816
+ * True if the item had been initialised
3817
+ */
3818
+ isInitialised: boolean;
3819
+
3820
+ /**
3821
+ * True if the item is maximised
3822
+ */
3823
+ isMaximised: boolean;
3824
+
3825
+ /**
3826
+ * True if the item is the layout's root item
3827
+ */
3828
+ isRoot: boolean;
3829
+
3830
+ /**
3831
+ * True if the item is a row
3832
+ */
3833
+ isRow: boolean;
3834
+
3835
+ /**
3836
+ * True if the item is a column
3837
+ */
3838
+ isColumn: boolean;
3839
+
3840
+ /**
3841
+ * True if the item is a stack
3842
+ */
3843
+ isStack: boolean;
3844
+
3845
+ /**
3846
+ * True if the item is a component
3847
+ */
3848
+ isComponent: boolean;
3849
+
3850
+ /**
3851
+ * A reference to the layoutManager that controls this item
3852
+ */
3853
+ layoutManager: any;
3854
+
3855
+ /**
3856
+ * The item's outer element
3857
+ */
3858
+ element: JQuery;
3859
+
3860
+ /**
3861
+ * The item's inner element. Can be the same as the outer element.
3862
+ */
3863
+ childElementContainer: Container;
3864
+
3865
+ /**
3866
+ * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
3867
+ * from its original position before adding it to this item.
3868
+ * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
3869
+ * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
3870
+ */
3871
+ addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
3872
+
3873
+ /**
3874
+ * Destroys the item and all it's children
3875
+ * @param contentItem The contentItem that should be removed
3876
+ * @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.
3877
+ */
3878
+ removeChild(contentItem: ContentItem, keepChild?: boolean): void;
3879
+
3880
+ /**
3881
+ * The contentItem that should be removed
3882
+ * @param oldChild ContentItem The contentItem that should be removed
3883
+ * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
3884
+ */
3885
+ replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
3886
+
3887
+ /**
3888
+ * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
3889
+ */
3890
+ setSize(): void;
3891
+
3892
+ /**
3893
+ * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3894
+ * @param title the new title
3895
+ */
3896
+ setTitle(title: string): void;
3897
+
3898
+ /**
3899
+ * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
3900
+ * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
3901
+ * @param functionName The name of the method to invoke
3902
+ * @param functionArguments An array of arguments to pass to every function
3903
+ * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
3904
+ * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
3905
+ */
3906
+ callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
3907
+
3908
+ /**
3909
+ * 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.
3910
+ */
3911
+ emitBubblingEvent(name: string): void;
3912
+
3913
+ /**
3914
+ * Convenience method for item.parent.removeChild( item )
3915
+ */
3916
+ remove(): void;
3917
+
3918
+ /**
3919
+ * Removes the item from its current position in the layout and opens it in a window
3920
+ */
3921
+ popout(): BrowserWindow;
3922
+
3923
+ /**
3924
+ * Maximises the item or minimises it if it's already maximised
3925
+ */
3926
+ toggleMaximise(): void;
3927
+
3928
+ /**
3929
+ * Selects the item. Only relevant if settings.selectionEnabled is set to true
3930
+ */
3931
+ select(): void;
3932
+
3933
+ /**
3934
+ * Unselects the item. Only relevant if settings.selectionEnabled is set to true
3935
+ */
3936
+ deselect(): void;
3937
+
3938
+ /**
3939
+ * Returns true if the item has the specified id or false if not
3940
+ * @param id An id to check for
3941
+ */
3942
+ hasId(id: string): boolean;
3943
+
3944
+ /**
3945
+ * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
3946
+ * @param contentItem The new active content item
3947
+ * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
3948
+ */
3949
+ // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
3950
+ setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
3951
+
3952
+ /**
3953
+ * Only Stacks have this method! Returns the currently selected contentItem.
3954
+ */
3955
+ getActiveContentItem(): ContentItem;
3956
+
3957
+ /**
3958
+ * Adds an id to an item or does nothing if the id is already present
3959
+ * @param id The id to be added
3960
+ */
3961
+ addId(id: string): void;
3962
+
3963
+ /**
3964
+ * Removes an id from an item or throws an error if the id couldn't be found
3965
+ * @param id The id to be removed
3966
+ */
3967
+ removeId(id: string): void;
3968
+
3969
+ /**
3970
+ * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
3971
+ * @param filterFunction A function that determines whether an item matches certain criteria
3972
+ */
3973
+ getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
3974
+
3975
+ /**
3976
+ * Returns all items with the specified id.
3977
+ * @param id An id specified in the itemConfig
3978
+ */
3979
+ getItemsById(id: string | string[]): ContentItem[];
3980
+
3981
+ /**
3982
+ * Returns all items with the specified type
3983
+ * @param type 'row', 'column', 'stack', 'component' or 'root'
3984
+ */
3985
+ getItemsByType(type: string): ContentItem[];
3986
+
3987
+ /**
3988
+ * Returns all instances of the component with the specified componentName
3989
+ * @param componentName a componentName as specified in the itemConfig
3990
+ */
3991
+ getComponentsByName(componentName: string): any;
3992
+
3993
+ _contentAreaDimensions: any;
3994
+ _$getArea: () => any;
3995
+ }
3996
+
3620
3997
  /**
3621
3998
  * Restrict navigation to URLs that match an allowed pattern.
3622
3999
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4000,6 +4377,46 @@ declare type DidFinishLoadEvent = NamedEvent & {
4000
4377
  type: 'did-finish-load';
4001
4378
  };
4002
4379
 
4380
+ declare interface Dimensions {
4381
+ /**
4382
+ * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4383
+ * than the visible one, making it safe to set this to small values without affecting usability.
4384
+ * Default: 5
4385
+ */
4386
+ borderWidth?: number;
4387
+
4388
+ /**
4389
+ * The minimum height an item can be resized to (in pixel).
4390
+ * Default: 10
4391
+ */
4392
+ minItemHeight?: number;
4393
+
4394
+ /**
4395
+ * The minimum width an item can be resized to (in pixel).
4396
+ * Default: 10
4397
+ */
4398
+ minItemWidth?: number;
4399
+
4400
+ /**
4401
+ * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4402
+ * adjusted accordingly.
4403
+ * Default: 20
4404
+ */
4405
+ headerHeight?: number;
4406
+
4407
+ /**
4408
+ * The width of the element that appears when an item is dragged (in pixel).
4409
+ * Default: 300
4410
+ */
4411
+ dragProxyWidth?: number;
4412
+
4413
+ /**
4414
+ * The height of the element that appears when an item is dragged (in pixel).
4415
+ * Default: 200
4416
+ */
4417
+ dragProxyHeight?: number;
4418
+ }
4419
+
4003
4420
  /**
4004
4421
  * @interface
4005
4422
  */
@@ -4148,6 +4565,8 @@ declare type Dpi = {
4148
4565
  vertical?: number;
4149
4566
  };
4150
4567
 
4568
+ declare interface DragSource {}
4569
+
4151
4570
  /**
4152
4571
  * Generated when a window has been embedded.
4153
4572
  * @interface
@@ -4375,6 +4794,43 @@ declare class EventAggregator extends EmitterMap {
4375
4794
  dispatchEvent: (message: Message<any>) => boolean;
4376
4795
  }
4377
4796
 
4797
+ declare interface EventEmitter_2 {
4798
+ [x: string]: any;
4799
+ /**
4800
+ * Subscribe to an event
4801
+ * @param eventName The name of the event to describe to
4802
+ * @param callback The function that should be invoked when the event occurs
4803
+ * @param context The value of the this pointer in the callback function
4804
+ */
4805
+ on(eventName: string, callback: Function, context?: any): void;
4806
+
4807
+ /**
4808
+ * Notify listeners of an event and pass arguments along
4809
+ * @param eventName The name of the event to emit
4810
+ */
4811
+ emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
4812
+
4813
+ /**
4814
+ * Alias for emit
4815
+ */
4816
+ trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
4817
+
4818
+ /**
4819
+ * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
4820
+ * eventName and callback or just a specific callback with a specific context if invoked with all three
4821
+ * arguments.
4822
+ * @param eventName The name of the event to unsubscribe from
4823
+ * @param callback The function that should be invoked when the event occurs
4824
+ * @param context The value of the this pointer in the callback function
4825
+ */
4826
+ unbind(eventName: string, callback?: Function, context?: any): void;
4827
+
4828
+ /**
4829
+ * Alias for unbind
4830
+ */
4831
+ off(eventName: string, callback?: Function, context?: any): void;
4832
+ }
4833
+
4378
4834
  /**
4379
4835
  * Handler for an event on an EventEmitter.
4380
4836
  * @remarks Selects the correct type for the event
@@ -5352,6 +5808,244 @@ declare namespace GlobalHotkeyEvents {
5352
5808
  }
5353
5809
  }
5354
5810
 
5811
+ declare namespace GoldenLayout {
5812
+ export {
5813
+ GoldenLayout_2 as GoldenLayout,
5814
+ ItemConfigType,
5815
+ Settings,
5816
+ Dimensions,
5817
+ Labels,
5818
+ ItemType,
5819
+ ItemConfig,
5820
+ ComponentConfig,
5821
+ ReactComponentConfig,
5822
+ Config,
5823
+ ContentItem,
5824
+ Container,
5825
+ DragSource,
5826
+ BrowserWindow,
5827
+ Header,
5828
+ Tab,
5829
+ EventEmitter_2 as EventEmitter
5830
+ }
5831
+ }
5832
+
5833
+ declare class GoldenLayout_2 implements EventEmitter_2 {
5834
+ /**
5835
+ * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
5836
+ * object and of goldenLayout.root as the document.
5837
+ */
5838
+ root: ContentItem;
5839
+
5840
+ /**
5841
+ * A reference to the (jQuery) DOM element containing the layout
5842
+ */
5843
+ container: JQuery;
5844
+
5845
+ /**
5846
+ * True once the layout item tree has been created and the initialised event has been fired
5847
+ */
5848
+ isInitialised: boolean;
5849
+
5850
+ /**
5851
+ * A reference to the current, extended top level config.
5852
+ *
5853
+ * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
5854
+ */
5855
+ config: Config;
5856
+
5857
+ /**
5858
+ * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
5859
+ * to true.
5860
+ */
5861
+ selectedItem: ContentItem;
5862
+
5863
+ /**
5864
+ * The current outer width of the layout in pixels.
5865
+ */
5866
+ width: number;
5867
+
5868
+ /**
5869
+ * The current outer height of the layout in pixels.
5870
+ */
5871
+ height: number;
5872
+
5873
+ /**
5874
+ * An array of BrowserWindow instances
5875
+ */
5876
+ openPopouts: BrowserWindow[];
5877
+
5878
+ /**
5879
+ * True if the layout has been opened as a popout by another layout.
5880
+ */
5881
+ isSubWindow: boolean;
5882
+
5883
+ /**
5884
+ * A singleton instance of EventEmitter that works across windows
5885
+ */
5886
+ eventHub: EventEmitter_2;
5887
+
5888
+ _dragProxy: any;
5889
+
5890
+ dropTargetIndicator: any;
5891
+
5892
+ /**
5893
+ * @param config A GoldenLayout configuration object
5894
+ * @param container The DOM element the layout will be initialised in. Default: document.body
5895
+ */
5896
+ constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
5897
+
5898
+ /*
5899
+ * @param name The name of the component, as referred to by componentName in the component configuration.
5900
+ * @param component A constructor or factory function. Will be invoked with new and two arguments, a
5901
+ * containerobject and a component state
5902
+ */
5903
+ registerComponent(name: String, component: any): void;
5904
+
5905
+ /**
5906
+ * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
5907
+ * a listener to the document and executes once it becomes ready.
5908
+ */
5909
+ init(): void;
5910
+
5911
+ /**
5912
+ * Returns the current state of the layout and its components as a serialisable object.
5913
+ */
5914
+ toConfig(): Config;
5915
+
5916
+ /**
5917
+ * Returns a component that was previously registered with layout.registerComponent().
5918
+ * @param name The name of a previously registered component
5919
+ */
5920
+ getComponent(name: string): any;
5921
+
5922
+ /**
5923
+ * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
5924
+ * @param width The outer width the layout should be resized to. Default: The container elements width
5925
+ * @param height The outer height the layout should be resized to. Default: The container elements height
5926
+ */
5927
+ updateSize(width?: number, height?: number): void;
5928
+
5929
+ /**
5930
+ * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
5931
+ * listeners and finally removes itself from the DOM.
5932
+ */
5933
+ destroy(): void;
5934
+
5935
+ /**
5936
+ * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
5937
+ * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
5938
+ * all call this method implicitly.
5939
+ * @param itemConfiguration An item configuration (can be an entire tree of items)
5940
+ * @param parent A parent item
5941
+ */
5942
+ createContentItem(
5943
+ itemConfiguration?: ItemConfigType,
5944
+ parent?: ContentItem
5945
+ ): ContentItem;
5946
+
5947
+ /**
5948
+ * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
5949
+ * @param configOrContentItem The content item or config that will be created in the new window. If a item is
5950
+ * provided its config will be read, if config is provided, only the content key
5951
+ * will be used
5952
+ * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
5953
+ * place the window in another screen.
5954
+ * @param parentId The id of the item within the current layout the child window's content will be appended to
5955
+ * when popIn is clicked
5956
+ * @param indexInParent The index at which the child window's contents will be appended to. Default: null
5957
+ */
5958
+ createPopout(
5959
+ configOrContentItem: ItemConfigType | ContentItem,
5960
+ dimensions: {
5961
+ width: number;
5962
+ height: number;
5963
+ left: number;
5964
+ top: number;
5965
+ },
5966
+ parentId?: string,
5967
+ indexInParent?: number
5968
+ ): void;
5969
+
5970
+ /**
5971
+ * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
5972
+ * where it turns into a contentItem.
5973
+ * @param element The DOM element that will be turned into a dragSource
5974
+ * @param itemConfiguration An item configuration (can be an entire tree of items)
5975
+ * @return the dragSource that was created. This can be used to remove the
5976
+ * dragSource from the layout later.
5977
+ */
5978
+ createDragSource(
5979
+ element: HTMLElement | JQuery,
5980
+ itemConfiguration: ItemConfigType
5981
+ ): DragSource;
5982
+
5983
+ /**
5984
+ * Removes a dragSource from the layout.
5985
+ *
5986
+ * @param dragSource The dragSource to remove
5987
+ */
5988
+ removeDragSource(dragSource: DragSource): void;
5989
+
5990
+ /**
5991
+ * If settings.selectionEnabled is set to true, this allows to select items programmatically.
5992
+ * @param contentItem A ContentItem instance
5993
+ */
5994
+ selectItem(contentItem: ContentItem): void;
5995
+
5996
+ /**
5997
+ * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
5998
+ * and replace frequent keys and values with single letter substitutes.
5999
+ * @param config A GoldenLayout configuration object
6000
+ */
6001
+ static minifyConfig(config: any): any;
6002
+
6003
+ /**
6004
+ * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6005
+ * @param minifiedConfig A minified GoldenLayout configuration object
6006
+ */
6007
+ static unminifyConfig(minifiedConfig: any): any;
6008
+
6009
+ /**
6010
+ * Subscribe to an event
6011
+ * @param eventName The name of the event to describe to
6012
+ * @param callback The function that should be invoked when the event occurs
6013
+ * @param context The value of the this pointer in the callback function
6014
+ */
6015
+ on(eventName: string, callback: Function, context?: any): void;
6016
+
6017
+ /**
6018
+ * Notify listeners of an event and pass arguments along
6019
+ * @param eventName The name of the event to emit
6020
+ */
6021
+ emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6022
+
6023
+ /**
6024
+ * Alias for emit
6025
+ */
6026
+ trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6027
+
6028
+ /**
6029
+ * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6030
+ * eventName and callback or just a specific callback with a specific context if invoked with all three
6031
+ * arguments.
6032
+ * @param eventName The name of the event to unsubscribe from
6033
+ * @param callback The function that should be invoked when the event occurs
6034
+ * @param context The value of the this pointer in the callback function
6035
+ */
6036
+ unbind(eventName: string, callback?: Function, context?: any): void;
6037
+
6038
+ /**
6039
+ * Alias for unbind
6040
+ */
6041
+ off(eventName: string, callback?: Function, context?: any): void;
6042
+
6043
+ /**
6044
+ * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6045
+ */
6046
+ _$createRootItemAreas(): void;
6047
+ }
6048
+
5355
6049
  /**
5356
6050
  * @interface
5357
6051
  */
@@ -5359,6 +6053,62 @@ declare type GpuInfo = {
5359
6053
  name: string;
5360
6054
  };
5361
6055
 
6056
+ declare interface Header {
6057
+ /**
6058
+ * A reference to the LayoutManager instance
6059
+ */
6060
+ layoutManager: GoldenLayout_2;
6061
+
6062
+ /**
6063
+ * A reference to the Stack this Header belongs to
6064
+ */
6065
+ parent: ContentItem;
6066
+
6067
+ /**
6068
+ * An array of the Tabs within this header
6069
+ */
6070
+ tabs: Tab[];
6071
+
6072
+ /**
6073
+ * The currently selected activeContentItem
6074
+ */
6075
+ activeContentItem: ContentItem;
6076
+
6077
+ /**
6078
+ * The outer (jQuery) DOM element of this Header
6079
+ */
6080
+ element: JQuery;
6081
+
6082
+ /**
6083
+ * The (jQuery) DOM element containing the tabs
6084
+ */
6085
+ tabsContainer: JQuery;
6086
+
6087
+ /**
6088
+ * The (jQuery) DOM element containing the close, maximise and popout button
6089
+ */
6090
+ controlsContainer: JQuery;
6091
+
6092
+ /**
6093
+ * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6094
+ * @param contentItem The content item that will be selected
6095
+ */
6096
+ setActiveContentItem(contentItem: ContentItem): void;
6097
+
6098
+ /**
6099
+ * Creates a new tab and associates it with a content item
6100
+ * @param contentItem The content item the tab will be associated with
6101
+ * @param index A zero based index, specifying the position of the new tab
6102
+ */
6103
+ createTab(contentItem: ContentItem, index?: number): void;
6104
+
6105
+ /**
6106
+ * Finds a tab by its contentItem and removes it
6107
+ * @param contentItem The content item the tab is associated with
6108
+ */
6109
+ removeTab(contentItem: ContentItem): void;
6110
+ }
6111
+
5362
6112
  /**
5363
6113
  * Generated when a View is hidden.
5364
6114
  * @interface
@@ -5483,7 +6233,8 @@ declare type Identity_5 = {
5483
6233
  declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
5484
6234
 
5485
6235
  /**
5486
- * An Identity event.
6236
+ * An event that contains the `uuid` property of an {@link OpenFin.Identity}.
6237
+ *
5487
6238
  * @interface
5488
6239
  */
5489
6240
  declare type IdentityEvent = BaseEvent & {
@@ -7107,6 +7858,50 @@ declare class InteropModule extends Base {
7107
7858
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
7108
7859
  }
7109
7860
 
7861
+ declare interface ItemConfig {
7862
+ /**
7863
+ * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
7864
+ */
7865
+ type: ItemType;
7866
+
7867
+ /**
7868
+ * An array of configurations for items that will be created as children of this item.
7869
+ */
7870
+ content?: ItemConfigType[];
7871
+
7872
+ /**
7873
+ * The width of this item, relative to the other children of its parent in percent
7874
+ */
7875
+ width?: number;
7876
+
7877
+ /**
7878
+ * The height of this item, relative to the other children of its parent in percent
7879
+ */
7880
+ height?: number;
7881
+
7882
+ /**
7883
+ * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
7884
+ */
7885
+ id?: string | string[];
7886
+
7887
+ /**
7888
+ * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
7889
+ * will return false
7890
+ * Default: true
7891
+ */
7892
+ isClosable?: boolean;
7893
+
7894
+ /**
7895
+ * The title of the item as displayed on its tab and on popout windows
7896
+ * Default: componentName or ''
7897
+ */
7898
+ title?: string;
7899
+ }
7900
+
7901
+ declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
7902
+
7903
+ declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
7904
+
7110
7905
  /**
7111
7906
  * @interface
7112
7907
  */
@@ -7164,6 +7959,32 @@ declare type JumpListTask = {
7164
7959
  iconIndex?: number;
7165
7960
  };
7166
7961
 
7962
+ declare interface Labels {
7963
+ /**
7964
+ * The tooltip text that appears when hovering over the close icon.
7965
+ * Default: 'close'
7966
+ */
7967
+ close?: string;
7968
+
7969
+ /**
7970
+ * The tooltip text that appears when hovering over the maximise icon.
7971
+ * Default: 'maximise'
7972
+ */
7973
+ maximise?: string;
7974
+
7975
+ /**
7976
+ * The tooltip text that appears when hovering over the minimise icon.
7977
+ * Default: 'minimise'
7978
+ */
7979
+ minimise?: string;
7980
+
7981
+ /**
7982
+ * The tooltip text that appears when hovering over the popout icon.
7983
+ * Default: 'open in new window'
7984
+ */
7985
+ popout?: string;
7986
+ }
7987
+
7167
7988
  export declare function launch(config: ConnectConfig): Promise<number>;
7168
7989
 
7169
7990
  /**
@@ -7405,6 +8226,16 @@ declare class Layout extends Base {
7405
8226
  * ```
7406
8227
  */
7407
8228
  getConfig(): Promise<any>;
8229
+ /**
8230
+ * Retrieves the attached views in current window layout.
8231
+ *
8232
+ * @example
8233
+ * ```js
8234
+ * const layout = fin.Platform.Layout.getCurrentSync();
8235
+ * const views = await layout.getCurrentViews();
8236
+ * ```
8237
+ */
8238
+ getCurrentViews(): Promise<OpenFin.View[]>;
7408
8239
  /**
7409
8240
  * Replaces a Platform window's layout with a new layout.
7410
8241
  *
@@ -7793,6 +8624,7 @@ declare class LayoutManager {
7793
8624
  private setBackgroundImage;
7794
8625
  private setBackgroundImages;
7795
8626
  private getFrameSnapshot;
8627
+ private getCurrentViews;
7796
8628
  private addView;
7797
8629
  private replaceView;
7798
8630
  private removeView;
@@ -8889,7 +9721,7 @@ declare type MutableWindowOptions = {
8889
9721
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
8890
9722
 
8891
9723
  /**
8892
- * A Name event.
9724
+ * An event that contains an entire {@link OpenFin.Identity}.
8893
9725
  * @interface
8894
9726
  */
8895
9727
  declare type NamedEvent = IdentityEvent & {
@@ -8976,6 +9808,10 @@ declare type Opacity = TransitionBase & {
8976
9808
  opacity: number;
8977
9809
  };
8978
9810
 
9811
+ declare type OpenExternalPermission = VerboseWebPermission & {
9812
+ protocols: string[];
9813
+ };
9814
+
8979
9815
  declare namespace OpenFin {
8980
9816
  export {
8981
9817
  FinApi,
@@ -9095,6 +9931,8 @@ declare namespace OpenFin {
9095
9931
  LaunchExternalProcessRule,
9096
9932
  SystemPermissions,
9097
9933
  WebPermission,
9934
+ VerboseWebPermission,
9935
+ OpenExternalPermission,
9098
9936
  Permissions_2 as Permissions,
9099
9937
  PlatformWindowCreationOptions,
9100
9938
  PlatformWindowOptions,
@@ -11578,6 +12416,18 @@ declare type QueryPermissionResult = {
11578
12416
  rawValue?: unknown;
11579
12417
  };
11580
12418
 
12419
+ declare interface ReactComponentConfig extends ItemConfig {
12420
+ /**
12421
+ * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12422
+ */
12423
+ component: string;
12424
+
12425
+ /**
12426
+ * Properties that will be passed to the component and accessible using this.props.
12427
+ */
12428
+ props?: any;
12429
+ }
12430
+
11581
12431
  /**
11582
12432
  * @interface
11583
12433
  */
@@ -12055,6 +12905,97 @@ declare type SessionContextGroup = {
12055
12905
  }>;
12056
12906
  };
12057
12907
 
12908
+ declare interface Settings {
12909
+ preventSplitterResize?: boolean;
12910
+
12911
+ newTabButton?: {
12912
+ url?: string;
12913
+ };
12914
+
12915
+ /**
12916
+ * If true, tabs can't be dragged into the window.
12917
+ * Default: false
12918
+ */
12919
+ preventDragIn?: boolean;
12920
+
12921
+ /**
12922
+ * If true, tabs can't be dragged out of the window.
12923
+ * Default: false
12924
+ */
12925
+ preventDragOut?: boolean;
12926
+
12927
+ /**
12928
+ * If true, stack headers are the only areas where tabs can be dropped.
12929
+ * Default: false
12930
+ */
12931
+ constrainDragToHeaders?: boolean;
12932
+ /**
12933
+ * Turns headers on or off. If false, the layout will be displayed with splitters only.
12934
+ * Default: true
12935
+ */
12936
+ hasHeaders?: boolean;
12937
+
12938
+ /**
12939
+ * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
12940
+ * automatically when layout.createDragSource() is called.
12941
+ * Default: true
12942
+ */
12943
+ constrainDragToContainer?: boolean;
12944
+
12945
+ /**
12946
+ * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
12947
+ * Default: true
12948
+ */
12949
+ reorderEnabled?: boolean;
12950
+
12951
+ /**
12952
+ * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
12953
+ * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
12954
+ * Default: false
12955
+ */
12956
+ selectionEnabled?: boolean;
12957
+
12958
+ /**
12959
+ * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
12960
+ * be transferred to the new window, if false only the active component will be opened.
12961
+ * Default: false
12962
+ */
12963
+ popoutWholeStack?: boolean;
12964
+
12965
+ /**
12966
+ * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
12967
+ * If false, the popout call will fail silently.
12968
+ * Default: true
12969
+ */
12970
+ blockedPopoutsThrowError?: boolean;
12971
+
12972
+ /**
12973
+ * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
12974
+ * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
12975
+ * addition, any changes made to popouts won't be stored after the parent is closed.
12976
+ * Default: true
12977
+ */
12978
+ closePopoutsOnUnload?: boolean;
12979
+
12980
+ /**
12981
+ * Specifies if the popout icon should be displayed in the header-bar.
12982
+ * Default: true
12983
+ */
12984
+ showPopoutIcon?: boolean;
12985
+
12986
+ /**
12987
+ * Specifies if the maximise icon should be displayed in the header-bar.
12988
+ * Default: true
12989
+ */
12990
+ showMaximiseIcon?: boolean;
12991
+
12992
+ /**
12993
+ * Specifies if the close icon should be displayed in the header-bar.
12994
+ * Default: true
12995
+ */
12996
+ showCloseIcon?: boolean;
12997
+ }
12998
+
12058
12999
  /**
12059
13000
  * @interface
12060
13001
  */
@@ -13900,6 +14841,52 @@ declare type SystemShutdownHandler = (shutdownEvent: {
13900
14841
  proceed: () => void;
13901
14842
  }) => void;
13902
14843
 
14844
+ declare interface Tab {
14845
+ _dragListener: EventEmitter_2;
14846
+
14847
+ /**
14848
+ * True if this tab is the selected tab
14849
+ */
14850
+ isActive: boolean;
14851
+
14852
+ /**
14853
+ * A reference to the header this tab is a child of
14854
+ */
14855
+ header: Header;
14856
+
14857
+ /**
14858
+ * A reference to the content item this tab relates to
14859
+ */
14860
+ contentItem: ContentItem;
14861
+
14862
+ /**
14863
+ * The tabs outer (jQuery) DOM element
14864
+ */
14865
+ element: JQuery;
14866
+
14867
+ /**
14868
+ * The (jQuery) DOM element containing the title
14869
+ */
14870
+ titleElement: JQuery;
14871
+
14872
+ /**
14873
+ * The (jQuery) DOM element that closes the tab
14874
+ */
14875
+ closeElement: JQuery;
14876
+
14877
+ /**
14878
+ * Sets the tab's title. Does not affect the contentItem's title!
14879
+ * @param title The new title
14880
+ */
14881
+ setTitle(title: string): void;
14882
+
14883
+ /**
14884
+ * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
14885
+ * @param isActive Whether the tab is active
14886
+ */
14887
+ setActive(isActive: boolean): void;
14888
+ }
14889
+
13903
14890
  /**
13904
14891
  * Set of apis used to facilitate tab drag interactions without needing to hide views.
13905
14892
  * @ignore
@@ -14457,6 +15444,11 @@ declare namespace v2 {
14457
15444
  }
14458
15445
  }
14459
15446
 
15447
+ declare type VerboseWebPermission = {
15448
+ api: string;
15449
+ enabled: boolean;
15450
+ };
15451
+
14460
15452
  declare type View = OpenFin.View;
14461
15453
 
14462
15454
  /**
@@ -16340,7 +17332,7 @@ declare namespace WebContentsEvents {
16340
17332
  * `clipboard-read`: Request access to read from the clipboard.<br>
16341
17333
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
16342
17334
  */
16343
- declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write';
17335
+ declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
16344
17336
 
16345
17337
  /**
16346
17338
  * Object representing headers and their values, where the