@openfin/remote-adapter 36.80.26 → 37.80.3

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.
@@ -42,15 +42,6 @@ declare type Accelerator = {
42
42
  zoom: boolean;
43
43
  };
44
44
 
45
- /**
46
- * Generated when a View is added to a layout.
47
- * @interface
48
- */
49
- declare type AddedToLayoutEvent = BaseEvent_4 & {
50
- type: 'added-to-layout';
51
- layoutIdentity: OpenFin.LayoutIdentity;
52
- };
53
-
54
45
  /**
55
46
  * Options to use when adding a view to a {@link TabStack}.
56
47
  *
@@ -85,42 +76,14 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
85
76
 
86
77
  declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<PayloadTypeByStrategy<RTCStrategy>, PayloadTypeByStrategy<ClassicStrategy>>;
87
78
 
88
- /**
89
- * @deprecated Renamed to {@link ApiSettings}.
90
- */
91
- declare type Api = ApiSettings;
92
-
93
- declare type ApiCall<Request, Response> = {
94
- request: Request;
95
- response: Response;
96
- };
97
-
98
- declare type ApiClient<T extends Record<any, any>> = {
99
- [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
100
- };
101
-
102
- /**
103
- * @deprecated Renamed to {@link DomainApiSettings}.
104
- */
105
- declare type ApiInjection = DomainApiSettings;
106
-
107
- /**
108
- * Generated when a new Platform's API becomes responsive.
109
- * @interface
110
- */
111
- declare type ApiReadyEvent = BaseEvents.BaseEvent & {
112
- topic: 'application';
113
- type: 'platform-api-ready';
114
- };
115
-
116
79
  /**
117
80
  * Configurations for API injection.
118
81
  *
119
82
  * @interface
120
83
  */
121
- declare type ApiSettings = {
84
+ declare type Api = {
122
85
  /**
123
- * Configure conditional injection of OpenFin API into iframes
86
+ * Configure injection of OpenFin API into iframes based on domain
124
87
  */
125
88
  iframe?: {
126
89
  /**
@@ -151,6 +114,41 @@ declare type ApiSettings = {
151
114
  fin?: InjectionType;
152
115
  };
153
116
 
117
+ declare type ApiCall<Request, Response> = {
118
+ request: Request;
119
+ response: Response;
120
+ };
121
+
122
+ declare type ApiClient<T extends Record<any, any>> = {
123
+ [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
124
+ };
125
+
126
+ /**
127
+ * @interface
128
+ *
129
+ * Rules for domain-conditional `fin` API injection.
130
+ */
131
+ declare type ApiInjection = {
132
+ /**
133
+ * Injection setting for the `fin` API for contexts on a matched domain.
134
+ *
135
+ * * 'none': The `fin` API will be not available.
136
+ * * 'global': The entire `fin` API will be available.
137
+ *
138
+ * @defaultValue 'global'
139
+ */
140
+ fin: InjectionType;
141
+ };
142
+
143
+ /**
144
+ * Generated when a new Platform's API becomes responsive.
145
+ * @interface
146
+ */
147
+ declare type ApiReadyEvent = BaseEvent & {
148
+ topic: 'application';
149
+ type: 'platform-api-ready';
150
+ };
151
+
154
152
  /**
155
153
  * @interface
156
154
  */
@@ -945,7 +943,7 @@ declare namespace ApplicationEvents {
945
943
  PropagatedApplicationEvent,
946
944
  PropagatedEventType_3 as PropagatedEventType,
947
945
  PropagatedApplicationEventType,
948
- Payload_5 as Payload,
946
+ Payload_4 as Payload,
949
947
  ByType_3 as ByType
950
948
  }
951
949
  }
@@ -968,7 +966,7 @@ declare type ApplicationIdentity_2 = {
968
966
  * @interface
969
967
  */
970
968
  declare type ApplicationInfo = {
971
- initialOptions: ApplicationCreationOptions | PlatformOptions;
969
+ initialOptions: ApplicationCreationOptions;
972
970
  launchMode: string;
973
971
  manifest: Manifest & {
974
972
  [key: string]: any;
@@ -1187,14 +1185,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1187
1185
  */
1188
1186
  mainWindowOptions: WindowCreationOptions;
1189
1187
  /**
1190
- * The name of the application.
1191
- *
1192
- * @remarks
1193
- * This property is used for naming the application logging folder, which will be sanitized to remove
1194
- * any special characters, spaces or international characters. It's also used in error messages, API
1195
- * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1188
+ * The name of the application (and the application's main window).
1196
1189
  *
1197
- * This property will be deprecated in the future.
1190
+ * If provided, _must_ match `uuid`.
1198
1191
  */
1199
1192
  name: string;
1200
1193
  /**
@@ -1224,7 +1217,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1224
1217
  url: string;
1225
1218
  /**
1226
1219
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1227
- * running in the OpenFin Runtime.
1220
+ * running in the OpenFin Runtime.
1221
+ *
1222
+ * Note that `name` and `uuid` must match.
1228
1223
  */
1229
1224
  uuid: string;
1230
1225
  /**
@@ -1285,10 +1280,6 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1285
1280
  * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
1286
1281
  */
1287
1282
  domainSettings: DomainSettings;
1288
- /**
1289
- * The permissions for secured APIs.
1290
- */
1291
- permissions?: Partial<Permissions_2>;
1292
1283
  /**
1293
1284
  * @defaultValue false
1294
1285
  *
@@ -1784,7 +1775,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1784
1775
  * A base Channel event.
1785
1776
  * @interface
1786
1777
  */
1787
- declare type BaseEvent_2 = BaseEvents.NamedEvent & {
1778
+ declare type BaseEvent_2 = NamedEvent & {
1788
1779
  channelName: string;
1789
1780
  channelId: string;
1790
1781
  };
@@ -1854,7 +1845,6 @@ declare namespace BaseEvents {
1854
1845
  NotCloseRequested,
1855
1846
  PropagatedEventType,
1856
1847
  PropagatedEvent,
1857
- Payload_2 as Payload,
1858
1848
  EventHandler,
1859
1849
  BaseEvent,
1860
1850
  IdentityEvent,
@@ -1988,6 +1978,48 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1988
1978
  behavior: 'browser';
1989
1979
  };
1990
1980
 
1981
+ declare interface BrowserWindow {
1982
+ /**
1983
+ * True if the window has been opened and its GoldenLayout instance initialised.
1984
+ */
1985
+ isInitialised: boolean;
1986
+
1987
+ /**
1988
+ * Creates a window configuration object from the Popout.
1989
+ */
1990
+ toConfig(): {
1991
+ dimensions: {
1992
+ width: number;
1993
+ height: number;
1994
+ left: number;
1995
+ top: number;
1996
+ };
1997
+ content: Config;
1998
+ parentId: string;
1999
+ indexInParent: number;
2000
+ };
2001
+
2002
+ /**
2003
+ * Returns the GoldenLayout instance from the child window
2004
+ */
2005
+ getGlInstance(): GoldenLayout_2;
2006
+
2007
+ /**
2008
+ * Returns the native Window object
2009
+ */
2010
+ getWindow(): Window;
2011
+
2012
+ /**
2013
+ * Closes the popout
2014
+ */
2015
+ close(): void;
2016
+
2017
+ /**
2018
+ * Returns the popout to its original position as specified in parentId and indexInParent
2019
+ */
2020
+ popIn(): void;
2021
+ }
2022
+
1991
2023
  /**
1992
2024
  * Extracts a single event type matching the given key from the View {@link Event} union.
1993
2025
  *
@@ -1995,7 +2027,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1995
2027
  *
1996
2028
  * @typeParam Type String key specifying the event to extract
1997
2029
  */
1998
- declare type ByType<Type extends EventType> = Payload_3<Type>;
2030
+ declare type ByType<Type extends EventType> = Payload_2<Type>;
1999
2031
 
2000
2032
  /**
2001
2033
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -2004,7 +2036,7 @@ declare type ByType<Type extends EventType> = Payload_3<Type>;
2004
2036
  *
2005
2037
  * @typeParam Type String key specifying the event to extract
2006
2038
  */
2007
- declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
2039
+ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
2008
2040
 
2009
2041
  /**
2010
2042
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -2013,7 +2045,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
2013
2045
  *
2014
2046
  * @typeParam Type String key specifying the event to extract
2015
2047
  */
2016
- declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
2048
+ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
2017
2049
 
2018
2050
  /**
2019
2051
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -2022,7 +2054,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
2022
2054
  *
2023
2055
  * @typeParam Type String key specifying the event to extract
2024
2056
  */
2025
- declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
2057
+ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
2026
2058
 
2027
2059
  /**
2028
2060
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -2031,7 +2063,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
2031
2063
  *
2032
2064
  * @typeParam Type String key specifying the event to extract
2033
2065
  */
2034
- declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
2066
+ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
2035
2067
 
2036
2068
  /**
2037
2069
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -2040,7 +2072,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
2040
2072
  *
2041
2073
  * @typeParam Type String key specifying the event to extract
2042
2074
  */
2043
- declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
2075
+ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2044
2076
 
2045
2077
  /**
2046
2078
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -2049,7 +2081,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
2049
2081
  *
2050
2082
  * @typeParam Type String key specifying the event to extract
2051
2083
  */
2052
- declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
2084
+ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2053
2085
 
2054
2086
  /**
2055
2087
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -2058,7 +2090,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
2058
2090
  *
2059
2091
  * @typeParam Type String key specifying the event to extract
2060
2092
  */
2061
- declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
2093
+ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2062
2094
 
2063
2095
  /**
2064
2096
  * Configuration for page capture.
@@ -3407,6 +3439,31 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
3407
3439
  close(): Promise<void>;
3408
3440
  }
3409
3441
 
3442
+ declare interface ComponentConfig extends ItemConfig {
3443
+ /**
3444
+ * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3445
+ */
3446
+ componentName: string;
3447
+
3448
+ /**
3449
+ * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3450
+ * container.getState().
3451
+ */
3452
+ componentState?: any;
3453
+ }
3454
+
3455
+ declare interface Config {
3456
+ settings?: Settings;
3457
+ dimensions?: Dimensions;
3458
+ labels?: Labels;
3459
+ content?: ItemConfigType[];
3460
+ /**
3461
+ * (Only on layout config object)
3462
+ * Id of the currently maximised content item
3463
+ */
3464
+ maximisedItemId?: string;
3465
+ }
3466
+
3410
3467
  declare type ConfigWithRuntime = BaseConfig & {
3411
3468
  runtime: RuntimeConfig;
3412
3469
  };
@@ -3485,7 +3542,7 @@ declare type ConstViewOptions = {
3485
3542
  /**
3486
3543
  * Configurations for API injection.
3487
3544
  */
3488
- api: ApiSettings;
3545
+ api: Api;
3489
3546
  /**
3490
3547
  * The name of the view.
3491
3548
  */
@@ -3718,9 +3775,7 @@ declare type ConstWindowOptions = {
3718
3775
  */
3719
3776
  preloadScripts: PreloadScript[];
3720
3777
  /**
3721
- * String tag that attempts to group like-tagged renderers together.
3722
- * 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.
3723
- * @remarks Will only be used if pages are on the same origin.
3778
+ * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
3724
3779
  */
3725
3780
  processAffinity: string;
3726
3781
  /**
@@ -3804,18 +3859,106 @@ declare type ConstWindowOptions = {
3804
3859
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3805
3860
  */
3806
3861
  viewVisibility?: ViewVisibilityOptions;
3862
+ };
3863
+
3864
+ declare interface Container extends EventEmitter_2 {
3807
3865
  /**
3808
- * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3866
+ * The current width of the container in pixel
3809
3867
  */
3810
- inheritance?: Partial<InheritableOptions>;
3811
- };
3868
+ width: number;
3812
3869
 
3813
- declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3870
+ /**
3871
+ * The current height of the container in pixel
3872
+ */
3873
+ height: number;
3814
3874
 
3815
- /**
3816
- * @deprecated Renamed to {@link ContentCreationBehavior}.
3817
- */
3818
- declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3875
+ /**
3876
+ * A reference to the component-item that controls this container
3877
+ */
3878
+ parent: ContentItem;
3879
+
3880
+ /**
3881
+ * A reference to the tab that controls this container. Will initially be null
3882
+ * (and populated once a tab event has been fired).
3883
+ */
3884
+ tab: Tab;
3885
+
3886
+ /**
3887
+ * The current title of the container
3888
+ */
3889
+ title: string;
3890
+
3891
+ /*
3892
+ * A reference to the GoldenLayout instance this container belongs to
3893
+ */
3894
+ layoutManager: GoldenLayout_2;
3895
+
3896
+ /**
3897
+ * True if the item is currently hidden
3898
+ */
3899
+ isHidden: boolean;
3900
+
3901
+ /**
3902
+ * Overwrites the components state with the provided value. To only change parts of the componentState see
3903
+ * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3904
+ * value of componentState when layout.toConfig() is called and will be passed back to the component's
3905
+ * constructor function. It will also be used when the component is opened in a new window.
3906
+ * @param state A serialisable object
3907
+ */
3908
+ setState(state: any): void;
3909
+
3910
+ /**
3911
+ * The same as setState but does not emit 'stateChanged' event
3912
+ * @param {serialisable} state
3913
+ */
3914
+ setStateSkipEvent(state: any): void;
3915
+
3916
+ /**
3917
+ * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3918
+ * @param state A serialisable object
3919
+ */
3920
+ extendState(state: any): void;
3921
+
3922
+ /**
3923
+ * Returns the current state.
3924
+ */
3925
+ getState(): any;
3926
+
3927
+ /**
3928
+ * Returns the container's inner element as a jQuery element
3929
+ */
3930
+ getElement(): JQuery;
3931
+
3932
+ /**
3933
+ * hides the container or returns false if hiding it is not possible
3934
+ */
3935
+ hide(): boolean;
3936
+
3937
+ /**
3938
+ * shows the container or returns false if showing it is not possible
3939
+ */
3940
+ show(): boolean;
3941
+
3942
+ /**
3943
+ * Sets the container to the specified size or returns false if that's not possible
3944
+ * @param width the new width in pixel
3945
+ * @param height the new height in pixel
3946
+ */
3947
+ setSize(width: number, height: number): boolean;
3948
+
3949
+ /**
3950
+ * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3951
+ * @param title the new title
3952
+ */
3953
+ setTitle(title: string): void;
3954
+
3955
+ /**
3956
+ * Closes the container or returns false if that is not possible
3957
+ */
3958
+ close(): boolean;
3959
+ }
3960
+
3961
+ declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3819
3962
 
3820
3963
  /**
3821
3964
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3839,7 +3982,7 @@ declare type ContentCreationOptions = {
3839
3982
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3840
3983
  * the specified `behavior` key.
3841
3984
  */
3842
- declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3985
+ declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3843
3986
  behavior: Behavior;
3844
3987
  }>;
3845
3988
 
@@ -3872,6 +4015,218 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3872
4015
  disposition: string;
3873
4016
  };
3874
4017
 
4018
+ declare interface ContentItem extends EventEmitter_2 {
4019
+ instance: any;
4020
+ header: any;
4021
+ _splitter: any;
4022
+ /**
4023
+ * This items configuration in its current state
4024
+ */
4025
+ config: ItemConfigType;
4026
+
4027
+ /**
4028
+ * The type of the item. Can be row, column, stack, component or root
4029
+ */
4030
+ type: ItemType;
4031
+
4032
+ /**
4033
+ * An array of items that are children of this item
4034
+ */
4035
+ contentItems: ContentItem[];
4036
+
4037
+ container: Container;
4038
+ /**
4039
+ * The item that is this item's parent (or null if the item is root)
4040
+ */
4041
+ parent: ContentItem;
4042
+
4043
+ /**
4044
+ * A String or array of identifiers if provided in the configuration
4045
+ */
4046
+ id: string;
4047
+
4048
+ /**
4049
+ * True if the item had been initialised
4050
+ */
4051
+ isInitialised: boolean;
4052
+
4053
+ /**
4054
+ * True if the item is maximised
4055
+ */
4056
+ isMaximised: boolean;
4057
+
4058
+ /**
4059
+ * True if the item is the layout's root item
4060
+ */
4061
+ isRoot: boolean;
4062
+
4063
+ /**
4064
+ * True if the item is a row
4065
+ */
4066
+ isRow: boolean;
4067
+
4068
+ /**
4069
+ * True if the item is a column
4070
+ */
4071
+ isColumn: boolean;
4072
+
4073
+ /**
4074
+ * True if the item is a stack
4075
+ */
4076
+ isStack: boolean;
4077
+
4078
+ /**
4079
+ * True if the item is a component
4080
+ */
4081
+ isComponent: boolean;
4082
+
4083
+ /**
4084
+ * A reference to the layoutManager that controls this item
4085
+ */
4086
+ layoutManager: any;
4087
+
4088
+ /**
4089
+ * The item's outer element
4090
+ */
4091
+ element: JQuery;
4092
+
4093
+ /**
4094
+ * The item's inner element. Can be the same as the outer element.
4095
+ */
4096
+ childElementContainer: Container;
4097
+
4098
+ /**
4099
+ * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4100
+ * from its original position before adding it to this item.
4101
+ * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4102
+ * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4103
+ */
4104
+ addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4105
+
4106
+ /**
4107
+ * Destroys the item and all it's children
4108
+ * @param contentItem The contentItem that should be removed
4109
+ * @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.
4110
+ */
4111
+ removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4112
+
4113
+ /**
4114
+ * The contentItem that should be removed
4115
+ * @param oldChild ContentItem The contentItem that should be removed
4116
+ * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4117
+ */
4118
+ replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4119
+
4120
+ /**
4121
+ * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4122
+ */
4123
+ setSize(): void;
4124
+
4125
+ /**
4126
+ * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4127
+ * @param title the new title
4128
+ */
4129
+ setTitle(title: string): void;
4130
+
4131
+ /**
4132
+ * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4133
+ * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4134
+ * @param functionName The name of the method to invoke
4135
+ * @param functionArguments An array of arguments to pass to every function
4136
+ * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4137
+ * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4138
+ */
4139
+ callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4140
+
4141
+ /**
4142
+ * 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.
4143
+ */
4144
+ emitBubblingEvent(name: string): void;
4145
+
4146
+ /**
4147
+ * Convenience method for item.parent.removeChild( item )
4148
+ */
4149
+ remove(): void;
4150
+
4151
+ /**
4152
+ * Removes the item from its current position in the layout and opens it in a window
4153
+ */
4154
+ popout(): BrowserWindow;
4155
+
4156
+ /**
4157
+ * Maximises the item or minimises it if it's already maximised
4158
+ */
4159
+ toggleMaximise(): void;
4160
+
4161
+ /**
4162
+ * Selects the item. Only relevant if settings.selectionEnabled is set to true
4163
+ */
4164
+ select(): void;
4165
+
4166
+ /**
4167
+ * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4168
+ */
4169
+ deselect(): void;
4170
+
4171
+ /**
4172
+ * Returns true if the item has the specified id or false if not
4173
+ * @param id An id to check for
4174
+ */
4175
+ hasId(id: string): boolean;
4176
+
4177
+ /**
4178
+ * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4179
+ * @param contentItem The new active content item
4180
+ * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4181
+ */
4182
+ // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4183
+ setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4184
+
4185
+ /**
4186
+ * Only Stacks have this method! Returns the currently selected contentItem.
4187
+ */
4188
+ getActiveContentItem(): ContentItem;
4189
+
4190
+ /**
4191
+ * Adds an id to an item or does nothing if the id is already present
4192
+ * @param id The id to be added
4193
+ */
4194
+ addId(id: string): void;
4195
+
4196
+ /**
4197
+ * Removes an id from an item or throws an error if the id couldn't be found
4198
+ * @param id The id to be removed
4199
+ */
4200
+ removeId(id: string): void;
4201
+
4202
+ /**
4203
+ * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4204
+ * @param filterFunction A function that determines whether an item matches certain criteria
4205
+ */
4206
+ getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4207
+
4208
+ /**
4209
+ * Returns all items with the specified id.
4210
+ * @param id An id specified in the itemConfig
4211
+ */
4212
+ getItemsById(id: string | string[]): ContentItem[];
4213
+
4214
+ /**
4215
+ * Returns all items with the specified type
4216
+ * @param type 'row', 'column', 'stack', 'component' or 'root'
4217
+ */
4218
+ getItemsByType(type: string): ContentItem[];
4219
+
4220
+ /**
4221
+ * Returns all instances of the component with the specified componentName
4222
+ * @param componentName a componentName as specified in the itemConfig
4223
+ */
4224
+ getComponentsByName(componentName: string): any;
4225
+
4226
+ _contentAreaDimensions: any;
4227
+ _$getArea: () => any;
4228
+ }
4229
+
3875
4230
  /**
3876
4231
  * Restrict navigation to URLs that match an allowed pattern.
3877
4232
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4356,6 +4711,46 @@ declare type DidFinishLoadEvent = NamedEvent & {
4356
4711
  type: 'did-finish-load';
4357
4712
  };
4358
4713
 
4714
+ declare interface Dimensions {
4715
+ /**
4716
+ * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4717
+ * than the visible one, making it safe to set this to small values without affecting usability.
4718
+ * Default: 5
4719
+ */
4720
+ borderWidth?: number;
4721
+
4722
+ /**
4723
+ * The minimum height an item can be resized to (in pixel).
4724
+ * Default: 10
4725
+ */
4726
+ minItemHeight?: number;
4727
+
4728
+ /**
4729
+ * The minimum width an item can be resized to (in pixel).
4730
+ * Default: 10
4731
+ */
4732
+ minItemWidth?: number;
4733
+
4734
+ /**
4735
+ * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4736
+ * adjusted accordingly.
4737
+ * Default: 20
4738
+ */
4739
+ headerHeight?: number;
4740
+
4741
+ /**
4742
+ * The width of the element that appears when an item is dragged (in pixel).
4743
+ * Default: 300
4744
+ */
4745
+ dragProxyWidth?: number;
4746
+
4747
+ /**
4748
+ * The height of the element that appears when an item is dragged (in pixel).
4749
+ * Default: 200
4750
+ */
4751
+ dragProxyHeight?: number;
4752
+ }
4753
+
4359
4754
  /**
4360
4755
  * @interface
4361
4756
  */
@@ -4472,25 +4867,6 @@ declare type DisplayMetadata_3 = {
4472
4867
  readonly glyph?: string;
4473
4868
  };
4474
4869
 
4475
- /**
4476
- * @interface
4477
- *
4478
- * Rules for domain-conditional `fin` API injection.
4479
- *
4480
- * @remarks Subset of {@link DomainSettings}.
4481
- */
4482
- declare type DomainApiSettings = {
4483
- /**
4484
- * Injection setting for the `fin` API for contexts on a matched domain.
4485
- *
4486
- * * 'none': The `fin` API will be not available.
4487
- * * 'global': The entire `fin` API will be available.
4488
- *
4489
- * @defaultValue 'global'
4490
- */
4491
- fin: InjectionType;
4492
- };
4493
-
4494
4870
  /**
4495
4871
  * @interface
4496
4872
  * Defines application settings that vary by the domain of the current context.
@@ -4529,7 +4905,7 @@ declare type DomainSettingsRule = {
4529
4905
  /**
4530
4906
  * {@inheritDoc ApiInjection}
4531
4907
  */
4532
- api?: DomainApiSettings;
4908
+ api?: ApiInjection;
4533
4909
  };
4534
4910
  };
4535
4911
 
@@ -4568,19 +4944,18 @@ declare type DownloadPreloadOption = {
4568
4944
  /**
4569
4945
  * @interface
4570
4946
  *
4571
- * A rule that governs download behavior, discriminated by the URL of the download.
4947
+ * A rule governing domain-conditional download behavior.
4572
4948
  */
4573
4949
  declare type DownloadRule = {
4574
4950
  /**
4575
- * {@inheritDoc FileDownloadBehavior}
4951
+ * {@inheritDoc FileDownloadBehaviorNames}
4576
4952
  */
4577
- behavior: FileDownloadBehavior;
4953
+ behavior: FileDownloadBehaviorNames;
4578
4954
  /**
4579
4955
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4580
- * URL(s) of the resource(s) being downloaded.
4956
+ * the domain(s) for which the rule applies.
4581
4957
  *
4582
- * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4583
- * of the page in which a file download link is embedded.
4958
+ * @remarks The match is evaluated against the URL of the *download*.
4584
4959
  */
4585
4960
  match: string[];
4586
4961
  };
@@ -4652,6 +5027,8 @@ declare type Dpi = {
4652
5027
  vertical?: number;
4653
5028
  };
4654
5029
 
5030
+ declare interface DragSource {}
5031
+
4655
5032
  /**
4656
5033
  * Generated when a window has been embedded.
4657
5034
  * @interface
@@ -4919,7 +5296,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
4919
5296
  */
4920
5297
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4921
5298
  target: OpenFin.Identity;
4922
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
5299
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4923
5300
 
4924
5301
  /**
4925
5302
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -4927,7 +5304,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4927
5304
  */
4928
5305
  declare type Event_5<Topic extends string> = {
4929
5306
  topic: Topic;
4930
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | WillRedirectEvent);
5307
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
4931
5308
 
4932
5309
  /**
4933
5310
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
@@ -4963,12 +5340,51 @@ declare class EventAggregator extends EmitterMap {
4963
5340
  dispatchEvent: (message: Message<any>) => boolean;
4964
5341
  }
4965
5342
 
5343
+ declare interface EventEmitter_2 {
5344
+ [x: string]: any;
5345
+ /**
5346
+ * Subscribe to an event
5347
+ * @param eventName The name of the event to describe to
5348
+ * @param callback The function that should be invoked when the event occurs
5349
+ * @param context The value of the this pointer in the callback function
5350
+ */
5351
+ on(eventName: string, callback: Function, context?: any): void;
5352
+
5353
+ /**
5354
+ * Notify listeners of an event and pass arguments along
5355
+ * @param eventName The name of the event to emit
5356
+ */
5357
+ emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5358
+
5359
+ /**
5360
+ * Alias for emit
5361
+ */
5362
+ trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5363
+
5364
+ /**
5365
+ * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5366
+ * eventName and callback or just a specific callback with a specific context if invoked with all three
5367
+ * arguments.
5368
+ * @param eventName The name of the event to unsubscribe from
5369
+ * @param callback The function that should be invoked when the event occurs
5370
+ * @param context The value of the this pointer in the callback function
5371
+ */
5372
+ unbind(eventName: string, callback?: Function, context?: any): void;
5373
+
5374
+ /**
5375
+ * Alias for unbind
5376
+ */
5377
+ off(eventName: string, callback?: Function, context?: any): void;
5378
+ }
5379
+
4966
5380
  /**
4967
5381
  * Handler for an event on an EventEmitter.
4968
5382
  * @remarks Selects the correct type for the event
4969
5383
  * payload from the provided union based on the provided string literal type.
4970
5384
  */
4971
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
5385
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
5386
+ type: EventType;
5387
+ }>, ...args: any[]) => void;
4972
5388
 
4973
5389
  declare namespace Events {
4974
5390
  export {
@@ -5099,7 +5515,7 @@ declare namespace ExternalApplicationEvents {
5099
5515
  ExternalApplicationEvent,
5100
5516
  EventType_4 as EventType,
5101
5517
  ExternalApplicationEventType,
5102
- Payload_6 as Payload,
5518
+ Payload_5 as Payload,
5103
5519
  ByType_4 as ByType
5104
5520
  }
5105
5521
  }
@@ -5245,12 +5661,7 @@ declare type FetchManifestPayload = {
5245
5661
  /**
5246
5662
  * Whether file downloads raise a user prompt.
5247
5663
  */
5248
- declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5249
-
5250
- /**
5251
- * @deprecated Renamed to {@link FileDownloadBehavior}.
5252
- */
5253
- declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5664
+ declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5254
5665
 
5255
5666
  /**
5256
5667
  * Generated when a file download has completed.
@@ -5500,8 +5911,6 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5500
5911
  * Returns a frame info object representing the window that the referenced iframe is
5501
5912
  * currently embedded in.
5502
5913
  *
5503
- * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5504
- *
5505
5914
  * @example
5506
5915
  * ```js
5507
5916
  * async function getParentWindow() {
@@ -5543,7 +5952,7 @@ declare namespace FrameEvents {
5543
5952
  FrameEvent,
5544
5953
  EventType_5 as EventType,
5545
5954
  FrameEventType,
5546
- Payload_7 as Payload,
5955
+ Payload_6 as Payload,
5547
5956
  ByType_5 as ByType
5548
5957
  }
5549
5958
  }
@@ -5766,34 +6175,267 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5766
6175
  * });
5767
6176
  * ```
5768
6177
  */
5769
- isRegistered(hotkey: string): Promise<boolean>;
5770
- }
6178
+ isRegistered(hotkey: string): Promise<boolean>;
6179
+ }
6180
+
6181
+ /**
6182
+ * @deprecated Renamed to {@link Event}.
6183
+ */
6184
+ declare type GlobalHotkeyEvent = Event_9;
6185
+
6186
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6187
+
6188
+ declare namespace GlobalHotkeyEvents {
6189
+ export {
6190
+ BaseEvent_8 as BaseEvent,
6191
+ RegisteredEvent,
6192
+ UnregisteredEvent,
6193
+ Event_9 as Event,
6194
+ GlobalHotkeyEvent,
6195
+ EventType_6 as EventType,
6196
+ GlobalHotkeyEventType,
6197
+ Payload_7 as Payload,
6198
+ ByType_6 as ByType
6199
+ }
6200
+ }
6201
+
6202
+ /**
6203
+ * @deprecated Renamed to {@link EventType}.
6204
+ */
6205
+ declare type GlobalHotkeyEventType = EventType_6;
6206
+
6207
+ declare namespace GoldenLayout {
6208
+ export {
6209
+ GoldenLayout_2 as GoldenLayout,
6210
+ ItemConfigType,
6211
+ Settings,
6212
+ Dimensions,
6213
+ Labels,
6214
+ ItemType,
6215
+ ItemConfig,
6216
+ ComponentConfig,
6217
+ ReactComponentConfig,
6218
+ Config,
6219
+ ContentItem,
6220
+ Container,
6221
+ DragSource,
6222
+ BrowserWindow,
6223
+ Header,
6224
+ TabDragListener,
6225
+ Tab,
6226
+ EventEmitter_2 as EventEmitter
6227
+ }
6228
+ }
6229
+
6230
+ declare class GoldenLayout_2 implements EventEmitter_2 {
6231
+ /**
6232
+ * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6233
+ * object and of goldenLayout.root as the document.
6234
+ */
6235
+ root: ContentItem;
6236
+
6237
+ /**
6238
+ * A reference to the (jQuery) DOM element containing the layout
6239
+ */
6240
+ container: JQuery;
6241
+
6242
+ /**
6243
+ * True once the layout item tree has been created and the initialised event has been fired
6244
+ */
6245
+ isInitialised: boolean;
6246
+
6247
+ /**
6248
+ * A reference to the current, extended top level config.
6249
+ *
6250
+ * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6251
+ */
6252
+ config: Config;
6253
+
6254
+ /**
6255
+ * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6256
+ * to true.
6257
+ */
6258
+ selectedItem: ContentItem;
6259
+
6260
+ /**
6261
+ * The current outer width of the layout in pixels.
6262
+ */
6263
+ width: number;
6264
+
6265
+ /**
6266
+ * The current outer height of the layout in pixels.
6267
+ */
6268
+ height: number;
6269
+
6270
+ /**
6271
+ * An array of BrowserWindow instances
6272
+ */
6273
+ openPopouts: BrowserWindow[];
6274
+
6275
+ /**
6276
+ * True if the layout has been opened as a popout by another layout.
6277
+ */
6278
+ isSubWindow: boolean;
6279
+
6280
+ /**
6281
+ * A singleton instance of EventEmitter that works across windows
6282
+ */
6283
+ eventHub: EventEmitter_2;
6284
+
6285
+ _dragProxy: any;
6286
+
6287
+ dropTargetIndicator: any;
6288
+
6289
+ /**
6290
+ * @param config A GoldenLayout configuration object
6291
+ * @param container The DOM element the layout will be initialised in. Default: document.body
6292
+ */
6293
+ constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6294
+
6295
+ /*
6296
+ * @param name The name of the component, as referred to by componentName in the component configuration.
6297
+ * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6298
+ * containerobject and a component state
6299
+ */
6300
+ registerComponent(name: String, component: any): void;
6301
+
6302
+ /**
6303
+ * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6304
+ * a listener to the document and executes once it becomes ready.
6305
+ */
6306
+ init(): void;
6307
+
6308
+ /**
6309
+ * Returns the current state of the layout and its components as a serialisable object.
6310
+ */
6311
+ toConfig(): Config;
6312
+
6313
+ /**
6314
+ * Returns a component that was previously registered with layout.registerComponent().
6315
+ * @param name The name of a previously registered component
6316
+ */
6317
+ getComponent(name: string): any;
6318
+
6319
+ /**
6320
+ * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6321
+ * @param width The outer width the layout should be resized to. Default: The container elements width
6322
+ * @param height The outer height the layout should be resized to. Default: The container elements height
6323
+ */
6324
+ updateSize(width?: number, height?: number): void;
6325
+
6326
+ /**
6327
+ * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6328
+ * listeners and finally removes itself from the DOM.
6329
+ */
6330
+ destroy(): void;
6331
+
6332
+ /**
6333
+ * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6334
+ * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6335
+ * all call this method implicitly.
6336
+ * @param itemConfiguration An item configuration (can be an entire tree of items)
6337
+ * @param parent A parent item
6338
+ */
6339
+ createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6340
+
6341
+ /**
6342
+ * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6343
+ * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6344
+ * provided its config will be read, if config is provided, only the content key
6345
+ * will be used
6346
+ * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6347
+ * place the window in another screen.
6348
+ * @param parentId The id of the item within the current layout the child window's content will be appended to
6349
+ * when popIn is clicked
6350
+ * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6351
+ */
6352
+ createPopout(
6353
+ configOrContentItem: ItemConfigType | ContentItem,
6354
+ dimensions: {
6355
+ width: number;
6356
+ height: number;
6357
+ left: number;
6358
+ top: number;
6359
+ },
6360
+ parentId?: string,
6361
+ indexInParent?: number
6362
+ ): void;
6363
+
6364
+ /**
6365
+ * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6366
+ * where it turns into a contentItem.
6367
+ * @param element The DOM element that will be turned into a dragSource
6368
+ * @param itemConfiguration An item configuration (can be an entire tree of items)
6369
+ * @return the dragSource that was created. This can be used to remove the
6370
+ * dragSource from the layout later.
6371
+ */
6372
+ createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6373
+
6374
+ /**
6375
+ * Removes a dragSource from the layout.
6376
+ *
6377
+ * @param dragSource The dragSource to remove
6378
+ */
6379
+ removeDragSource(dragSource: DragSource): void;
6380
+
6381
+ /**
6382
+ * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6383
+ * @param contentItem A ContentItem instance
6384
+ */
6385
+ selectItem(contentItem: ContentItem): void;
6386
+
6387
+ /**
6388
+ * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6389
+ * and replace frequent keys and values with single letter substitutes.
6390
+ * @param config A GoldenLayout configuration object
6391
+ */
6392
+ static minifyConfig(config: any): any;
5771
6393
 
5772
- /**
5773
- * @deprecated Renamed to {@link Event}.
5774
- */
5775
- declare type GlobalHotkeyEvent = Event_9;
6394
+ /**
6395
+ * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6396
+ * @param minifiedConfig A minified GoldenLayout configuration object
6397
+ */
6398
+ static unminifyConfig(minifiedConfig: any): any;
5776
6399
 
5777
- declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6400
+ /**
6401
+ * Subscribe to an event
6402
+ * @param eventName The name of the event to describe to
6403
+ * @param callback The function that should be invoked when the event occurs
6404
+ * @param context The value of the this pointer in the callback function
6405
+ */
6406
+ on(eventName: string, callback: Function, context?: any): void;
5778
6407
 
5779
- declare namespace GlobalHotkeyEvents {
5780
- export {
5781
- BaseEvent_8 as BaseEvent,
5782
- RegisteredEvent,
5783
- UnregisteredEvent,
5784
- Event_9 as Event,
5785
- GlobalHotkeyEvent,
5786
- EventType_6 as EventType,
5787
- GlobalHotkeyEventType,
5788
- Payload_8 as Payload,
5789
- ByType_6 as ByType
5790
- }
5791
- }
6408
+ /**
6409
+ * Notify listeners of an event and pass arguments along
6410
+ * @param eventName The name of the event to emit
6411
+ */
6412
+ emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5792
6413
 
5793
- /**
5794
- * @deprecated Renamed to {@link EventType}.
5795
- */
5796
- declare type GlobalHotkeyEventType = EventType_6;
6414
+ /**
6415
+ * Alias for emit
6416
+ */
6417
+ trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6418
+
6419
+ /**
6420
+ * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6421
+ * eventName and callback or just a specific callback with a specific context if invoked with all three
6422
+ * arguments.
6423
+ * @param eventName The name of the event to unsubscribe from
6424
+ * @param callback The function that should be invoked when the event occurs
6425
+ * @param context The value of the this pointer in the callback function
6426
+ */
6427
+ unbind(eventName: string, callback?: Function, context?: any): void;
6428
+
6429
+ /**
6430
+ * Alias for unbind
6431
+ */
6432
+ off(eventName: string, callback?: Function, context?: any): void;
6433
+
6434
+ /**
6435
+ * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6436
+ */
6437
+ _$createRootItemAreas(): void;
6438
+ }
5797
6439
 
5798
6440
  /**
5799
6441
  * @interface
@@ -5802,6 +6444,62 @@ declare type GpuInfo = {
5802
6444
  name: string;
5803
6445
  };
5804
6446
 
6447
+ declare interface Header {
6448
+ /**
6449
+ * A reference to the LayoutManager instance
6450
+ */
6451
+ layoutManager: GoldenLayout_2;
6452
+
6453
+ /**
6454
+ * A reference to the Stack this Header belongs to
6455
+ */
6456
+ parent: ContentItem;
6457
+
6458
+ /**
6459
+ * An array of the Tabs within this header
6460
+ */
6461
+ tabs: Tab[];
6462
+
6463
+ /**
6464
+ * The currently selected activeContentItem
6465
+ */
6466
+ activeContentItem: ContentItem;
6467
+
6468
+ /**
6469
+ * The outer (jQuery) DOM element of this Header
6470
+ */
6471
+ element: JQuery;
6472
+
6473
+ /**
6474
+ * The (jQuery) DOM element containing the tabs
6475
+ */
6476
+ tabsContainer: JQuery;
6477
+
6478
+ /**
6479
+ * The (jQuery) DOM element containing the close, maximise and popout button
6480
+ */
6481
+ controlsContainer: JQuery;
6482
+
6483
+ /**
6484
+ * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6485
+ * @param contentItem The content item that will be selected
6486
+ */
6487
+ setActiveContentItem(contentItem: ContentItem): void;
6488
+
6489
+ /**
6490
+ * Creates a new tab and associates it with a content item
6491
+ * @param contentItem The content item the tab will be associated with
6492
+ * @param index A zero based index, specifying the position of the new tab
6493
+ */
6494
+ createTab(contentItem: ContentItem, index?: number): void;
6495
+
6496
+ /**
6497
+ * Finds a tab by its contentItem and removes it
6498
+ * @param contentItem The content item the tab is associated with
6499
+ */
6500
+ removeTab(contentItem: ContentItem): void;
6501
+ }
6502
+
5805
6503
  /**
5806
6504
  * Generated when a View is hidden.
5807
6505
  * @interface
@@ -6058,13 +6756,6 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6058
6756
  metadata?: MetadataType;
6059
6757
  };
6060
6758
 
6061
- declare type InheritableOptions = {
6062
- customContext: boolean;
6063
- customData: boolean;
6064
- icon: boolean;
6065
- preloadScripts: boolean;
6066
- };
6067
-
6068
6759
  /**
6069
6760
  * Initialize a remote connection as a "host" application.
6070
6761
  * @param {InitOptions} options init options
@@ -6514,15 +7205,6 @@ declare class InteropBroker extends Base {
6514
7205
  setContext({ context }: {
6515
7206
  context: OpenFin.Context;
6516
7207
  }, clientIdentity: OpenFin.ClientIdentity): void;
6517
- /**
6518
- * Sets a context for the context group.
6519
- * @param setContextOptions - New context to set.
6520
- * @param contextGroupId - Context group id.
6521
- *
6522
- */
6523
- setContextForGroup({ context }: {
6524
- context: OpenFin.Context;
6525
- }, contextGroupId: string): void;
6526
7208
  /**
6527
7209
  * Get current context for a client subscribed to a Context Group.
6528
7210
  *
@@ -7491,6 +8173,50 @@ declare class InteropModule extends Base {
7491
8173
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
7492
8174
  }
7493
8175
 
8176
+ declare interface ItemConfig {
8177
+ /**
8178
+ * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8179
+ */
8180
+ type: ItemType;
8181
+
8182
+ /**
8183
+ * An array of configurations for items that will be created as children of this item.
8184
+ */
8185
+ content?: ItemConfigType[];
8186
+
8187
+ /**
8188
+ * The width of this item, relative to the other children of its parent in percent
8189
+ */
8190
+ width?: number;
8191
+
8192
+ /**
8193
+ * The height of this item, relative to the other children of its parent in percent
8194
+ */
8195
+ height?: number;
8196
+
8197
+ /**
8198
+ * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8199
+ */
8200
+ id?: string | string[];
8201
+
8202
+ /**
8203
+ * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8204
+ * will return false
8205
+ * Default: true
8206
+ */
8207
+ isClosable?: boolean;
8208
+
8209
+ /**
8210
+ * The title of the item as displayed on its tab and on popout windows
8211
+ * Default: componentName or ''
8212
+ */
8213
+ title?: string;
8214
+ }
8215
+
8216
+ declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8217
+
8218
+ declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8219
+
7494
8220
  /**
7495
8221
  * @interface
7496
8222
  */
@@ -7548,6 +8274,32 @@ declare type JumpListTask = {
7548
8274
  iconIndex?: number;
7549
8275
  };
7550
8276
 
8277
+ declare interface Labels {
8278
+ /**
8279
+ * The tooltip text that appears when hovering over the close icon.
8280
+ * Default: 'close'
8281
+ */
8282
+ close?: string;
8283
+
8284
+ /**
8285
+ * The tooltip text that appears when hovering over the maximise icon.
8286
+ * Default: 'maximise'
8287
+ */
8288
+ maximise?: string;
8289
+
8290
+ /**
8291
+ * The tooltip text that appears when hovering over the minimise icon.
8292
+ * Default: 'minimise'
8293
+ */
8294
+ minimise?: string;
8295
+
8296
+ /**
8297
+ * The tooltip text that appears when hovering over the popout icon.
8298
+ * Default: 'open in new window'
8299
+ */
8300
+ popout?: string;
8301
+ }
8302
+
7551
8303
  /**
7552
8304
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
7553
8305
  *
@@ -7626,7 +8378,6 @@ declare type LaunchExternalProcessRule = {
7626
8378
  */
7627
8379
  declare type LaunchIntoPlatformPayload = {
7628
8380
  manifest: any;
7629
- manifestUrl?: string;
7630
8381
  };
7631
8382
 
7632
8383
  /**
@@ -7973,7 +8724,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
7973
8724
  entityId: string;
7974
8725
  };
7975
8726
 
7976
- declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8727
+ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7977
8728
 
7978
8729
  /**
7979
8730
  * @interface
@@ -8804,7 +9555,7 @@ declare type MutableViewOptions = {
8804
9555
  /**
8805
9556
  * Configurations for API injection.
8806
9557
  */
8807
- api: ApiSettings;
9558
+ api: Api;
8808
9559
  /**
8809
9560
  * Restrict navigation to URLs that match an allowed pattern.
8810
9561
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -9257,7 +10008,6 @@ declare namespace OpenFin {
9257
10008
  WindowState,
9258
10009
  AutoplayPolicyOptions,
9259
10010
  ConstWindowOptions,
9260
- InheritableOptions,
9261
10011
  MutableWindowOptions,
9262
10012
  WorkspacePlatformOptions,
9263
10013
  WebRequestHeader,
@@ -9266,7 +10016,6 @@ declare namespace OpenFin {
9266
10016
  ResizeRegion,
9267
10017
  Accelerator,
9268
10018
  Api,
9269
- ApiSettings,
9270
10019
  InjectionType,
9271
10020
  NavigationRules,
9272
10021
  ContentNavigation,
@@ -9418,9 +10167,7 @@ declare namespace OpenFin {
9418
10167
  DefaultDomainSettingsRule,
9419
10168
  DomainSettings,
9420
10169
  ApiInjection,
9421
- DomainApiSettings,
9422
10170
  DomainSettingsRule,
9423
- FileDownloadBehavior,
9424
10171
  FileDownloadBehaviorNames,
9425
10172
  FileDownloadSettings,
9426
10173
  DownloadRule,
@@ -9428,7 +10175,6 @@ declare namespace OpenFin {
9428
10175
  Intent_2 as Intent,
9429
10176
  IntentMetadata_3 as IntentMetadata,
9430
10177
  IntentHandler_2 as IntentHandler,
9431
- ContentCreationBehavior,
9432
10178
  ContentCreationBehaviorNames,
9433
10179
  MatchPattern,
9434
10180
  BaseContentCreationRule,
@@ -9580,101 +10326,77 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
9580
10326
  error?: Success extends false ? ErrorPlainObject | undefined : never;
9581
10327
  };
9582
10328
 
9583
- /**
9584
- * Extracts a single event type matching the given key from the System {@link Event} union.
9585
- *
9586
- * @see {@link ByType}
9587
- *
9588
- * @typeParam Type String key specifying the event to extract
9589
- */
9590
- declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9591
-
9592
- /**
9593
- * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9594
- *
9595
- * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9596
- * the appropriate payload union for that namespace.
9597
- *
9598
- * @typeParam Event Union of payloads for events on the given emitter
9599
- * @see {@link ByType}
9600
- *
9601
- * @typeParam Type String key specifying the event to extract from the union
9602
- *
9603
- * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9604
- * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9605
- * @see {@link OpenFin.Events.FrameEvents.Payload}
9606
- * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9607
- * @see {@link OpenFin.Events.PlatformEvents.Payload}
9608
- * @see {@link OpenFin.Events.SystemEvents.Payload}
9609
- * @see {@link OpenFin.Events.ViewEvents.Payload}
9610
- * @see {@link OpenFin.Events.WindowEvents.Payload}
9611
- */
9612
- declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9613
- type: EventType;
9614
- }>;
9615
-
9616
10329
  /**
9617
10330
  * Extracts a single event type matching the given key from the View {@link Event} union.
9618
10331
  *
9619
- * @see {@link ByType}
9620
- *
9621
10332
  * @typeParam Type String key specifying the event to extract
9622
10333
  */
9623
- declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
10334
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10335
+ type: Type;
10336
+ }>;
9624
10337
 
9625
10338
  /**
9626
10339
  * Extracts a single event type matching the given key from the Window {@link Event} union.
9627
10340
  *
9628
- * @see {@link ByType}
9629
- *
9630
10341
  * @typeParam Type String key specifying the event to extract
9631
10342
  */
9632
- declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
10343
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10344
+ type: Type;
10345
+ }>;
9633
10346
 
9634
10347
  /**
9635
10348
  * Extracts a single event type matching the given key from the Application {@link Event} union.
9636
10349
  *
9637
- * @see {@link ByType}
9638
- *
9639
10350
  * @typeParam Type String key specifying the event to extract
9640
10351
  */
9641
- declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
10352
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10353
+ type: Type;
10354
+ }>;
9642
10355
 
9643
10356
  /**
9644
10357
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
9645
10358
  *
9646
- * @see {@link ByType}
9647
- *
9648
10359
  * @typeParam Type String key specifying the event to extract
9649
10360
  */
9650
- declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
10361
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10362
+ type: Type;
10363
+ }>;
9651
10364
 
9652
10365
  /**
9653
10366
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
9654
10367
  *
9655
- * @see {@link ByType}
9656
- *
9657
10368
  * @typeParam Type String key specifying the event to extract
9658
10369
  */
9659
- declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
10370
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10371
+ type: Type;
10372
+ }>;
9660
10373
 
9661
10374
  /**
9662
10375
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
9663
10376
  *
9664
- * @see {@link ByType}
9665
- *
9666
10377
  * @typeParam Type String key specifying the event to extract
9667
10378
  */
9668
- declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
10379
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10380
+ type: Type;
10381
+ }>;
9669
10382
 
9670
10383
  /**
9671
10384
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
9672
10385
  *
9673
- * @see {@link ByType}
10386
+ * @typeParam Type String key specifying the event to extract
10387
+ */
10388
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10389
+ type: Type;
10390
+ }>;
10391
+
10392
+ /**
10393
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9674
10394
  *
9675
10395
  * @typeParam Type String key specifying the event to extract
9676
10396
  */
9677
- declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
10397
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10398
+ type: Type;
10399
+ }>;
9678
10400
 
9679
10401
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
9680
10402
 
@@ -10338,7 +11060,7 @@ declare namespace PlatformEvents {
10338
11060
  PlatformEvent,
10339
11061
  EventType_7 as EventType,
10340
11062
  PlatformEventType,
10341
- Payload_9 as Payload,
11063
+ Payload_8 as Payload,
10342
11064
  ByType_7 as ByType
10343
11065
  }
10344
11066
  }
@@ -10522,13 +11244,9 @@ declare type PlatformOptions = ApplicationCreationOptions & {
10522
11244
  */
10523
11245
  providerUrl?: string;
10524
11246
  /**
10525
- * @defaultValue true
10526
- *
10527
- * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
10528
- *
10529
- * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11247
+ * The permissions for secured APIs.
10530
11248
  */
10531
- allowLaunchIntoPlatform?: boolean;
11249
+ permissions?: Partial<Permissions_2>;
10532
11250
  };
10533
11251
 
10534
11252
  /**
@@ -11288,7 +12006,7 @@ declare type PreloadScriptInfoRunning = {
11288
12006
  * @interface
11289
12007
  */
11290
12008
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11291
- type: 'preload-scripts-state-changed';
12009
+ type: 'preload-script-state-changed';
11292
12010
  };
11293
12011
 
11294
12012
  /**
@@ -11305,7 +12023,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11305
12023
  * @interface
11306
12024
  */
11307
12025
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11308
- type: 'preload-scripts-state-changing';
12026
+ type: 'preload-script-state-changing';
11309
12027
  };
11310
12028
 
11311
12029
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -11731,7 +12449,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
11731
12449
  'interop-broker-remove-client-from-context-group': VoidCall;
11732
12450
  'interop-broker-remove-from-context-group': VoidCall;
11733
12451
  'interop-broker-set-context': VoidCall;
11734
- 'interop-broker-set-context-for-group': VoidCall;
11735
12452
  'query-permission-for-current-context': {
11736
12453
  request: {
11737
12454
  apiName: string;
@@ -11922,6 +12639,18 @@ declare type QueryPermissionResult = {
11922
12639
  rawValue?: unknown;
11923
12640
  };
11924
12641
 
12642
+ declare interface ReactComponentConfig extends ItemConfig {
12643
+ /**
12644
+ * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12645
+ */
12646
+ component: string;
12647
+
12648
+ /**
12649
+ * Properties that will be passed to the component and accessible using this.props.
12650
+ */
12651
+ props?: any;
12652
+ }
12653
+
11925
12654
  /**
11926
12655
  * @interface
11927
12656
  */
@@ -12009,15 +12738,6 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12009
12738
  token: string;
12010
12739
  }
12011
12740
 
12012
- /**
12013
- * Generated when a View is removed from a layout.
12014
- * @interface
12015
- */
12016
- declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12017
- type: 'removed-from-layout';
12018
- layoutIdentity: OpenFin.LayoutIdentity;
12019
- };
12020
-
12021
12741
  /**
12022
12742
  * @interface
12023
12743
  */
@@ -12437,6 +13157,97 @@ declare type SessionContextGroup = {
12437
13157
  }>;
12438
13158
  };
12439
13159
 
13160
+ declare interface Settings {
13161
+ preventSplitterResize?: boolean;
13162
+
13163
+ newTabButton?: {
13164
+ url?: string;
13165
+ };
13166
+
13167
+ /**
13168
+ * If true, tabs can't be dragged into the window.
13169
+ * Default: false
13170
+ */
13171
+ preventDragIn?: boolean;
13172
+
13173
+ /**
13174
+ * If true, tabs can't be dragged out of the window.
13175
+ * Default: false
13176
+ */
13177
+ preventDragOut?: boolean;
13178
+
13179
+ /**
13180
+ * If true, stack headers are the only areas where tabs can be dropped.
13181
+ * Default: false
13182
+ */
13183
+ constrainDragToHeaders?: boolean;
13184
+ /**
13185
+ * Turns headers on or off. If false, the layout will be displayed with splitters only.
13186
+ * Default: true
13187
+ */
13188
+ hasHeaders?: boolean;
13189
+
13190
+ /**
13191
+ * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13192
+ * automatically when layout.createDragSource() is called.
13193
+ * Default: true
13194
+ */
13195
+ constrainDragToContainer?: boolean;
13196
+
13197
+ /**
13198
+ * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13199
+ * Default: true
13200
+ */
13201
+ reorderEnabled?: boolean;
13202
+
13203
+ /**
13204
+ * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13205
+ * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13206
+ * Default: false
13207
+ */
13208
+ selectionEnabled?: boolean;
13209
+
13210
+ /**
13211
+ * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13212
+ * be transferred to the new window, if false only the active component will be opened.
13213
+ * Default: false
13214
+ */
13215
+ popoutWholeStack?: boolean;
13216
+
13217
+ /**
13218
+ * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13219
+ * If false, the popout call will fail silently.
13220
+ * Default: true
13221
+ */
13222
+ blockedPopoutsThrowError?: boolean;
13223
+
13224
+ /**
13225
+ * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13226
+ * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13227
+ * addition, any changes made to popouts won't be stored after the parent is closed.
13228
+ * Default: true
13229
+ */
13230
+ closePopoutsOnUnload?: boolean;
13231
+
13232
+ /**
13233
+ * Specifies if the popout icon should be displayed in the header-bar.
13234
+ * Default: true
13235
+ */
13236
+ showPopoutIcon?: boolean;
13237
+
13238
+ /**
13239
+ * Specifies if the maximise icon should be displayed in the header-bar.
13240
+ * Default: true
13241
+ */
13242
+ showMaximiseIcon?: boolean;
13243
+
13244
+ /**
13245
+ * Specifies if the close icon should be displayed in the header-bar.
13246
+ * Default: true
13247
+ */
13248
+ showCloseIcon?: boolean;
13249
+ }
13250
+
12440
13251
  /**
12441
13252
  * @interface
12442
13253
  */
@@ -12660,7 +13471,7 @@ declare type Snapshot = {
12660
13471
  * _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.
12661
13472
  * @interface
12662
13473
  */
12663
- declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
13474
+ declare type SnapshotAppliedEvent = BaseEvent & {
12664
13475
  topic: 'application';
12665
13476
  type: 'platform-snapshot-applied';
12666
13477
  };
@@ -14266,7 +15077,7 @@ declare namespace SystemEvents {
14266
15077
  SystemEvent,
14267
15078
  EventType_8 as EventType,
14268
15079
  SystemEventType,
14269
- Payload_10 as Payload,
15080
+ Payload_9 as Payload,
14270
15081
  ByType_8 as ByType
14271
15082
  }
14272
15083
  }
@@ -14333,6 +15144,59 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14333
15144
  proceed: () => void;
14334
15145
  }) => void;
14335
15146
 
15147
+ declare interface Tab {
15148
+ _dragListener: TabDragListener;
15149
+
15150
+ /**
15151
+ * True if this tab is the selected tab
15152
+ */
15153
+ isActive: boolean;
15154
+
15155
+ /**
15156
+ * A reference to the header this tab is a child of
15157
+ */
15158
+ header: Header;
15159
+
15160
+ /**
15161
+ * A reference to the content item this tab relates to
15162
+ */
15163
+ contentItem: ContentItem;
15164
+
15165
+ /**
15166
+ * The tabs outer (jQuery) DOM element
15167
+ */
15168
+ element: JQuery;
15169
+
15170
+ /**
15171
+ * The (jQuery) DOM element containing the title
15172
+ */
15173
+ titleElement: JQuery;
15174
+
15175
+ /**
15176
+ * The (jQuery) DOM element that closes the tab
15177
+ */
15178
+ closeElement: JQuery;
15179
+
15180
+ /**
15181
+ * Sets the tab's title. Does not affect the contentItem's title!
15182
+ * @param title The new title
15183
+ */
15184
+ setTitle(title: string): void;
15185
+
15186
+ /**
15187
+ * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15188
+ * @param isActive Whether the tab is active
15189
+ */
15190
+ setActive(isActive: boolean): void;
15191
+ }
15192
+
15193
+ declare interface TabDragListener extends EventEmitter_2 {
15194
+ /**
15195
+ * A reference to the content item this tab relates to
15196
+ */
15197
+ contentItem: ContentItem;
15198
+ }
15199
+
14336
15200
  /**
14337
15201
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
14338
15202
  */
@@ -15272,8 +16136,6 @@ declare namespace ViewEvents {
15272
16136
  BaseEvent_4 as BaseEvent,
15273
16137
  BaseViewEvent,
15274
16138
  TargetChangedEvent,
15275
- AddedToLayoutEvent,
15276
- RemovedFromLayoutEvent,
15277
16139
  NonPropagatedViewEvent,
15278
16140
  CreatedEvent,
15279
16141
  DestroyedEvent,
@@ -15290,7 +16152,7 @@ declare namespace ViewEvents {
15290
16152
  PropagatedViewEvent,
15291
16153
  PropagatedEventType_2 as PropagatedEventType,
15292
16154
  PropagatedViewEventType,
15293
- Payload_3 as Payload,
16155
+ Payload_2 as Payload,
15294
16156
  ByType
15295
16157
  }
15296
16158
  }
@@ -16473,8 +17335,7 @@ declare namespace WebContentsEvents {
16473
17335
  Event_5 as Event,
16474
17336
  WebContentsEvent,
16475
17337
  WillPropagateWebContentsEvent,
16476
- NonPropagatedWebContentsEvent,
16477
- WillRedirectEvent
17338
+ NonPropagatedWebContentsEvent
16478
17339
  }
16479
17340
  }
16480
17341
 
@@ -16552,15 +17413,14 @@ declare type WillPropagateWebContentsEvent = Event_5<string>;
16552
17413
  declare type WillPropagateWindowEvent = WindowSourcedEvent;
16553
17414
 
16554
17415
  /**
16555
- * Generated whenever a redirection occurs.
17416
+ * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
16556
17417
  * @interface
16557
17418
  */
16558
- declare type WillRedirectEvent = NamedEvent & {
17419
+ declare type WillRedirectEvent = BaseEvent_5 & {
16559
17420
  type: 'will-redirect';
16560
17421
  blocked: boolean;
16561
17422
  isInPlace: boolean;
16562
17423
  url: string;
16563
- isMainFrame: boolean;
16564
17424
  };
16565
17425
 
16566
17426
  /**
@@ -16582,7 +17442,7 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
16582
17442
  */
16583
17443
  declare class _Window extends WebContents<OpenFin.WindowEvent> {
16584
17444
  /* Excluded from this release type: __constructor */
16585
- createWindow(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
17445
+ /* Excluded from this release type: createWindow */
16586
17446
  /**
16587
17447
  * Retrieves an array of frame info objects representing the main frame and any
16588
17448
  * iframes that are currently on the page.
@@ -17705,6 +18565,7 @@ declare namespace WindowEvents {
17705
18565
  AlertRequestedEvent,
17706
18566
  AuthRequestedEvent,
17707
18567
  EndLoadEvent,
18568
+ WillRedirectEvent,
17708
18569
  ReloadedEvent,
17709
18570
  OptionsChangedEvent,
17710
18571
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
@@ -17766,7 +18627,7 @@ declare namespace WindowEvents {
17766
18627
  PropagatedEvent_3 as PropagatedEvent,
17767
18628
  PropagatedWindowEvent,
17768
18629
  PropagatedWindowEventType,
17769
- Payload_4 as Payload,
18630
+ Payload_3 as Payload,
17770
18631
  ByType_2 as ByType
17771
18632
  }
17772
18633
  }
@@ -17952,7 +18813,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
17952
18813
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
17953
18814
  * from {@link OpenFin.ViewEvents}.
17954
18815
  */
17955
- declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
18816
+ declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
17956
18817
 
17957
18818
  /**
17958
18819
  * Generated when a child window starts loading.