@openfin/core 38.81.9 → 38.81.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.
- package/out/mock-alpha.d.ts +123 -7
- package/out/mock-beta.d.ts +123 -7
- package/out/mock-public.d.ts +123 -7
- package/out/mock.d.ts +123 -7
- package/out/mock.js +1189 -1158
- package/package.json +16 -1
package/out/mock-alpha.d.ts
CHANGED
@@ -2018,6 +2018,15 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2018
2018
|
*/
|
2019
2019
|
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
2020
2020
|
|
2021
|
+
/**
|
2022
|
+
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
2023
|
+
*
|
2024
|
+
* Alias for {@link Payload}, which may read better in source.
|
2025
|
+
*
|
2026
|
+
* @typeParam Type String key specifying the event to extract
|
2027
|
+
*/
|
2028
|
+
declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
|
2029
|
+
|
2021
2030
|
/**
|
2022
2031
|
* Configuration for page capture.
|
2023
2032
|
*
|
@@ -3816,6 +3825,14 @@ declare interface Container extends EventEmitter_2 {
|
|
3816
3825
|
close(): boolean;
|
3817
3826
|
}
|
3818
3827
|
|
3828
|
+
/**
|
3829
|
+
* Generated when a Layout Container Component was created.
|
3830
|
+
* @interface
|
3831
|
+
*/
|
3832
|
+
declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
3833
|
+
type: 'container-created';
|
3834
|
+
};
|
3835
|
+
|
3819
3836
|
/**
|
3820
3837
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
3821
3838
|
*/
|
@@ -4660,7 +4677,14 @@ declare type DomainApiSettings = {
|
|
4660
4677
|
*
|
4661
4678
|
* @defaultValue 'global'
|
4662
4679
|
*/
|
4663
|
-
fin
|
4680
|
+
fin?: InjectionType;
|
4681
|
+
/**
|
4682
|
+
* API permissions for domains matched to the current {@link DomainSettingsRule}.
|
4683
|
+
*
|
4684
|
+
* @remarks If an application manifest includes this property in {@link DomainSettings.default},
|
4685
|
+
* then {@link WindowOptions.permissions} and {@link ViewOptions.permissions} will be **ignored**.
|
4686
|
+
*/
|
4687
|
+
permissions?: Permissions_2;
|
4664
4688
|
};
|
4665
4689
|
|
4666
4690
|
/**
|
@@ -4994,6 +5018,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
4994
5018
|
} : never;
|
4995
5019
|
|
4996
5020
|
declare interface Environment {
|
5021
|
+
layoutAllowedInContext(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): boolean;
|
4997
5022
|
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
4998
5023
|
applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
|
4999
5024
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
@@ -5056,6 +5081,12 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
5056
5081
|
*/
|
5057
5082
|
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
5058
5083
|
|
5084
|
+
/**
|
5085
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
|
5086
|
+
* Events are discriminated by {@link LayoutDOMEvent.type}.
|
5087
|
+
*/
|
5088
|
+
declare type Event_12 = TabCreatedEvent | TabClosedEvent | TabDroppedEvent | ContainerCreatedEvent | LayoutStateChangedEvent;
|
5089
|
+
|
5059
5090
|
/**
|
5060
5091
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
5061
5092
|
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
|
@@ -5088,7 +5119,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
5088
5119
|
*/
|
5089
5120
|
declare type Event_5<Topic extends string> = {
|
5090
5121
|
topic: Topic;
|
5091
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent);
|
5122
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent);
|
5092
5123
|
|
5093
5124
|
/**
|
5094
5125
|
* [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
|
@@ -5225,6 +5256,11 @@ declare type EventType_7 = Event_10['type'];
|
|
5225
5256
|
*/
|
5226
5257
|
declare type EventType_8 = Event_11['type'];
|
5227
5258
|
|
5259
|
+
/**
|
5260
|
+
* Union of possible `type` values for a {@link LayoutDOMEvent}.
|
5261
|
+
*/
|
5262
|
+
declare type EventType_9 = Event_12['type'];
|
5263
|
+
|
5228
5264
|
/* Excluded from this release type: EventWithId */
|
5229
5265
|
|
5230
5266
|
/* Excluded from this release type: ExcludeRequested */
|
@@ -8411,6 +8447,32 @@ declare type LayoutComponent = LayoutItemConfig & {
|
|
8411
8447
|
|
8412
8448
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
8413
8449
|
|
8450
|
+
/**
|
8451
|
+
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
8452
|
+
*/
|
8453
|
+
declare type LayoutDOMEvent = Identity_5 & {
|
8454
|
+
type: string;
|
8455
|
+
topic: 'openfin-DOM-event';
|
8456
|
+
tabSelector: string;
|
8457
|
+
containerSelector: string;
|
8458
|
+
};
|
8459
|
+
|
8460
|
+
declare type LayoutDOMEvent_2 = LayoutDOMEvents.Event;
|
8461
|
+
|
8462
|
+
declare namespace LayoutDOMEvents {
|
8463
|
+
export {
|
8464
|
+
TabCreatedEvent,
|
8465
|
+
TabClosedEvent,
|
8466
|
+
TabDroppedEvent,
|
8467
|
+
ContainerCreatedEvent,
|
8468
|
+
LayoutStateChangedEvent,
|
8469
|
+
Event_12 as Event,
|
8470
|
+
EventType_9 as EventType,
|
8471
|
+
Payload_10 as Payload,
|
8472
|
+
ByType_9 as ByType
|
8473
|
+
}
|
8474
|
+
}
|
8475
|
+
|
8414
8476
|
declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
|
8415
8477
|
|
8416
8478
|
declare type LayoutEntitiesController = {
|
@@ -8856,6 +8918,14 @@ declare type LayoutSnapshot = {
|
|
8856
8918
|
layouts: Record<string, LayoutOptions>;
|
8857
8919
|
};
|
8858
8920
|
|
8921
|
+
/**
|
8922
|
+
* Generated when the Layout experiences a state change, for example tabs added/removed.
|
8923
|
+
* @interface
|
8924
|
+
*/
|
8925
|
+
declare type LayoutStateChangedEvent = LayoutDOMEvent & {
|
8926
|
+
type: 'layout-state-changed';
|
8927
|
+
};
|
8928
|
+
|
8859
8929
|
/**
|
8860
8930
|
* @interface
|
8861
8931
|
*/
|
@@ -9943,6 +10013,7 @@ declare namespace OpenFin_2 {
|
|
9943
10013
|
AppVersionCompleteEvent,
|
9944
10014
|
AppVersionRuntimeStatusEvent,
|
9945
10015
|
Events,
|
10016
|
+
LayoutDOMEvents,
|
9946
10017
|
BaseEvent_10 as BaseEvent,
|
9947
10018
|
WebContentsEvent_2 as WebContentsEvent,
|
9948
10019
|
SystemEvent_2 as SystemEvent,
|
@@ -9951,6 +10022,7 @@ declare namespace OpenFin_2 {
|
|
9951
10022
|
ViewEvent_2 as ViewEvent,
|
9952
10023
|
GlobalHotkeyEvent_2 as GlobalHotkeyEvent,
|
9953
10024
|
FrameEvent_2 as FrameEvent,
|
10025
|
+
LayoutDOMEvent_2 as LayoutDOMEvent,
|
9954
10026
|
PlatformEvent_2 as PlatformEvent,
|
9955
10027
|
ExternalApplicationEvent_2 as ExternalApplicationEvent,
|
9956
10028
|
ContextMenuOptions,
|
@@ -10024,6 +10096,15 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10024
10096
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
10025
10097
|
};
|
10026
10098
|
|
10099
|
+
/**
|
10100
|
+
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
10101
|
+
*
|
10102
|
+
* @typeParam Type String key specifying the event to extract
|
10103
|
+
*/
|
10104
|
+
declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
|
10105
|
+
type: Type;
|
10106
|
+
}>;
|
10107
|
+
|
10027
10108
|
/**
|
10028
10109
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
10029
10110
|
*
|
@@ -10131,6 +10212,14 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
10131
10212
|
|
10132
10213
|
/**
|
10133
10214
|
* @interface
|
10215
|
+
*
|
10216
|
+
* Governs access to OpenFin APIs. Property paths of this literal match call
|
10217
|
+
* paths for OpenFin API functions (e.g. `System.launchExternalProcess`), and can
|
10218
|
+
* take a value of `true`, `false`, or in some cases an object literal for more-complicated
|
10219
|
+
* semantics.
|
10220
|
+
*
|
10221
|
+
* For a list of APIs that are secure by default (and thus must be granted access via
|
10222
|
+
* `permissions`), see https://developers.openfin.co/of-docs/docs/api-security#secured-apis.
|
10134
10223
|
*/
|
10135
10224
|
declare type Permissions_2 = {
|
10136
10225
|
Application?: Partial<ApplicationPermissions>;
|
@@ -14866,6 +14955,23 @@ declare interface Tab {
|
|
14866
14955
|
setActive(isActive: boolean): void;
|
14867
14956
|
}
|
14868
14957
|
|
14958
|
+
/**
|
14959
|
+
* Generated when a Layout Tab Component was closed.
|
14960
|
+
* @interface
|
14961
|
+
*/
|
14962
|
+
declare type TabClosedEvent = LayoutDOMEvent & {
|
14963
|
+
type: 'tab-closed';
|
14964
|
+
url: string;
|
14965
|
+
};
|
14966
|
+
|
14967
|
+
/**
|
14968
|
+
* Generated when a Layout Tab Component was created.
|
14969
|
+
* @interface
|
14970
|
+
*/
|
14971
|
+
declare type TabCreatedEvent = LayoutDOMEvent & {
|
14972
|
+
type: 'tab-created';
|
14973
|
+
};
|
14974
|
+
|
14869
14975
|
declare interface TabDragListener extends EventEmitter_2 {
|
14870
14976
|
/**
|
14871
14977
|
* A reference to the content item this tab relates to
|
@@ -14873,6 +14979,15 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
14873
14979
|
contentItem: ContentItem;
|
14874
14980
|
}
|
14875
14981
|
|
14982
|
+
/**
|
14983
|
+
* Generated when a Layout Tab Component was dropped.
|
14984
|
+
* @interface
|
14985
|
+
*/
|
14986
|
+
declare type TabDroppedEvent = LayoutDOMEvent & {
|
14987
|
+
type: 'tab-dropped';
|
14988
|
+
url: string;
|
14989
|
+
};
|
14990
|
+
|
14876
14991
|
/**
|
14877
14992
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
14878
14993
|
*/
|
@@ -17082,7 +17197,8 @@ declare namespace WebContentsEvents {
|
|
17082
17197
|
Event_5 as Event,
|
17083
17198
|
WebContentsEvent,
|
17084
17199
|
WillPropagateWebContentsEvent,
|
17085
|
-
NonPropagatedWebContentsEvent
|
17200
|
+
NonPropagatedWebContentsEvent,
|
17201
|
+
WillRedirectEvent
|
17086
17202
|
}
|
17087
17203
|
}
|
17088
17204
|
|
@@ -17160,14 +17276,15 @@ declare type WillPropagateWebContentsEvent = Event_5<string>;
|
|
17160
17276
|
declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
17161
17277
|
|
17162
17278
|
/**
|
17163
|
-
* Generated
|
17279
|
+
* Generated whenever a redirection occurs.
|
17164
17280
|
* @interface
|
17165
17281
|
*/
|
17166
|
-
declare type WillRedirectEvent =
|
17282
|
+
declare type WillRedirectEvent = NamedEvent & {
|
17167
17283
|
type: 'will-redirect';
|
17168
17284
|
blocked: boolean;
|
17169
17285
|
isInPlace: boolean;
|
17170
17286
|
url: string;
|
17287
|
+
isMainFrame: boolean;
|
17171
17288
|
};
|
17172
17289
|
|
17173
17290
|
/**
|
@@ -18312,7 +18429,6 @@ declare namespace WindowEvents {
|
|
18312
18429
|
AlertRequestedEvent,
|
18313
18430
|
AuthRequestedEvent,
|
18314
18431
|
EndLoadEvent,
|
18315
|
-
WillRedirectEvent,
|
18316
18432
|
ReloadedEvent,
|
18317
18433
|
OptionsChangedEvent,
|
18318
18434
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
@@ -18568,7 +18684,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
18568
18684
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
18569
18685
|
* from {@link OpenFin.ViewEvents}.
|
18570
18686
|
*/
|
18571
|
-
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 |
|
18687
|
+
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;
|
18572
18688
|
|
18573
18689
|
/**
|
18574
18690
|
* Generated when a child window starts loading.
|
package/out/mock-beta.d.ts
CHANGED
@@ -2018,6 +2018,15 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2018
2018
|
*/
|
2019
2019
|
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
2020
2020
|
|
2021
|
+
/**
|
2022
|
+
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
2023
|
+
*
|
2024
|
+
* Alias for {@link Payload}, which may read better in source.
|
2025
|
+
*
|
2026
|
+
* @typeParam Type String key specifying the event to extract
|
2027
|
+
*/
|
2028
|
+
declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
|
2029
|
+
|
2021
2030
|
/**
|
2022
2031
|
* Configuration for page capture.
|
2023
2032
|
*
|
@@ -3816,6 +3825,14 @@ declare interface Container extends EventEmitter_2 {
|
|
3816
3825
|
close(): boolean;
|
3817
3826
|
}
|
3818
3827
|
|
3828
|
+
/**
|
3829
|
+
* Generated when a Layout Container Component was created.
|
3830
|
+
* @interface
|
3831
|
+
*/
|
3832
|
+
declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
3833
|
+
type: 'container-created';
|
3834
|
+
};
|
3835
|
+
|
3819
3836
|
/**
|
3820
3837
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
3821
3838
|
*/
|
@@ -4660,7 +4677,14 @@ declare type DomainApiSettings = {
|
|
4660
4677
|
*
|
4661
4678
|
* @defaultValue 'global'
|
4662
4679
|
*/
|
4663
|
-
fin
|
4680
|
+
fin?: InjectionType;
|
4681
|
+
/**
|
4682
|
+
* API permissions for domains matched to the current {@link DomainSettingsRule}.
|
4683
|
+
*
|
4684
|
+
* @remarks If an application manifest includes this property in {@link DomainSettings.default},
|
4685
|
+
* then {@link WindowOptions.permissions} and {@link ViewOptions.permissions} will be **ignored**.
|
4686
|
+
*/
|
4687
|
+
permissions?: Permissions_2;
|
4664
4688
|
};
|
4665
4689
|
|
4666
4690
|
/**
|
@@ -4994,6 +5018,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
4994
5018
|
} : never;
|
4995
5019
|
|
4996
5020
|
declare interface Environment {
|
5021
|
+
layoutAllowedInContext(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): boolean;
|
4997
5022
|
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
4998
5023
|
applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
|
4999
5024
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
@@ -5056,6 +5081,12 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
5056
5081
|
*/
|
5057
5082
|
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
5058
5083
|
|
5084
|
+
/**
|
5085
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
|
5086
|
+
* Events are discriminated by {@link LayoutDOMEvent.type}.
|
5087
|
+
*/
|
5088
|
+
declare type Event_12 = TabCreatedEvent | TabClosedEvent | TabDroppedEvent | ContainerCreatedEvent | LayoutStateChangedEvent;
|
5089
|
+
|
5059
5090
|
/**
|
5060
5091
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
5061
5092
|
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
|
@@ -5088,7 +5119,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
5088
5119
|
*/
|
5089
5120
|
declare type Event_5<Topic extends string> = {
|
5090
5121
|
topic: Topic;
|
5091
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent);
|
5122
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent);
|
5092
5123
|
|
5093
5124
|
/**
|
5094
5125
|
* [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
|
@@ -5225,6 +5256,11 @@ declare type EventType_7 = Event_10['type'];
|
|
5225
5256
|
*/
|
5226
5257
|
declare type EventType_8 = Event_11['type'];
|
5227
5258
|
|
5259
|
+
/**
|
5260
|
+
* Union of possible `type` values for a {@link LayoutDOMEvent}.
|
5261
|
+
*/
|
5262
|
+
declare type EventType_9 = Event_12['type'];
|
5263
|
+
|
5228
5264
|
/* Excluded from this release type: EventWithId */
|
5229
5265
|
|
5230
5266
|
/* Excluded from this release type: ExcludeRequested */
|
@@ -8411,6 +8447,32 @@ declare type LayoutComponent = LayoutItemConfig & {
|
|
8411
8447
|
|
8412
8448
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
8413
8449
|
|
8450
|
+
/**
|
8451
|
+
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
8452
|
+
*/
|
8453
|
+
declare type LayoutDOMEvent = Identity_5 & {
|
8454
|
+
type: string;
|
8455
|
+
topic: 'openfin-DOM-event';
|
8456
|
+
tabSelector: string;
|
8457
|
+
containerSelector: string;
|
8458
|
+
};
|
8459
|
+
|
8460
|
+
declare type LayoutDOMEvent_2 = LayoutDOMEvents.Event;
|
8461
|
+
|
8462
|
+
declare namespace LayoutDOMEvents {
|
8463
|
+
export {
|
8464
|
+
TabCreatedEvent,
|
8465
|
+
TabClosedEvent,
|
8466
|
+
TabDroppedEvent,
|
8467
|
+
ContainerCreatedEvent,
|
8468
|
+
LayoutStateChangedEvent,
|
8469
|
+
Event_12 as Event,
|
8470
|
+
EventType_9 as EventType,
|
8471
|
+
Payload_10 as Payload,
|
8472
|
+
ByType_9 as ByType
|
8473
|
+
}
|
8474
|
+
}
|
8475
|
+
|
8414
8476
|
declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
|
8415
8477
|
|
8416
8478
|
declare type LayoutEntitiesController = {
|
@@ -8856,6 +8918,14 @@ declare type LayoutSnapshot = {
|
|
8856
8918
|
layouts: Record<string, LayoutOptions>;
|
8857
8919
|
};
|
8858
8920
|
|
8921
|
+
/**
|
8922
|
+
* Generated when the Layout experiences a state change, for example tabs added/removed.
|
8923
|
+
* @interface
|
8924
|
+
*/
|
8925
|
+
declare type LayoutStateChangedEvent = LayoutDOMEvent & {
|
8926
|
+
type: 'layout-state-changed';
|
8927
|
+
};
|
8928
|
+
|
8859
8929
|
/**
|
8860
8930
|
* @interface
|
8861
8931
|
*/
|
@@ -9943,6 +10013,7 @@ declare namespace OpenFin_2 {
|
|
9943
10013
|
AppVersionCompleteEvent,
|
9944
10014
|
AppVersionRuntimeStatusEvent,
|
9945
10015
|
Events,
|
10016
|
+
LayoutDOMEvents,
|
9946
10017
|
BaseEvent_10 as BaseEvent,
|
9947
10018
|
WebContentsEvent_2 as WebContentsEvent,
|
9948
10019
|
SystemEvent_2 as SystemEvent,
|
@@ -9951,6 +10022,7 @@ declare namespace OpenFin_2 {
|
|
9951
10022
|
ViewEvent_2 as ViewEvent,
|
9952
10023
|
GlobalHotkeyEvent_2 as GlobalHotkeyEvent,
|
9953
10024
|
FrameEvent_2 as FrameEvent,
|
10025
|
+
LayoutDOMEvent_2 as LayoutDOMEvent,
|
9954
10026
|
PlatformEvent_2 as PlatformEvent,
|
9955
10027
|
ExternalApplicationEvent_2 as ExternalApplicationEvent,
|
9956
10028
|
ContextMenuOptions,
|
@@ -10024,6 +10096,15 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10024
10096
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
10025
10097
|
};
|
10026
10098
|
|
10099
|
+
/**
|
10100
|
+
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
10101
|
+
*
|
10102
|
+
* @typeParam Type String key specifying the event to extract
|
10103
|
+
*/
|
10104
|
+
declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
|
10105
|
+
type: Type;
|
10106
|
+
}>;
|
10107
|
+
|
10027
10108
|
/**
|
10028
10109
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
10029
10110
|
*
|
@@ -10131,6 +10212,14 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
10131
10212
|
|
10132
10213
|
/**
|
10133
10214
|
* @interface
|
10215
|
+
*
|
10216
|
+
* Governs access to OpenFin APIs. Property paths of this literal match call
|
10217
|
+
* paths for OpenFin API functions (e.g. `System.launchExternalProcess`), and can
|
10218
|
+
* take a value of `true`, `false`, or in some cases an object literal for more-complicated
|
10219
|
+
* semantics.
|
10220
|
+
*
|
10221
|
+
* For a list of APIs that are secure by default (and thus must be granted access via
|
10222
|
+
* `permissions`), see https://developers.openfin.co/of-docs/docs/api-security#secured-apis.
|
10134
10223
|
*/
|
10135
10224
|
declare type Permissions_2 = {
|
10136
10225
|
Application?: Partial<ApplicationPermissions>;
|
@@ -14866,6 +14955,23 @@ declare interface Tab {
|
|
14866
14955
|
setActive(isActive: boolean): void;
|
14867
14956
|
}
|
14868
14957
|
|
14958
|
+
/**
|
14959
|
+
* Generated when a Layout Tab Component was closed.
|
14960
|
+
* @interface
|
14961
|
+
*/
|
14962
|
+
declare type TabClosedEvent = LayoutDOMEvent & {
|
14963
|
+
type: 'tab-closed';
|
14964
|
+
url: string;
|
14965
|
+
};
|
14966
|
+
|
14967
|
+
/**
|
14968
|
+
* Generated when a Layout Tab Component was created.
|
14969
|
+
* @interface
|
14970
|
+
*/
|
14971
|
+
declare type TabCreatedEvent = LayoutDOMEvent & {
|
14972
|
+
type: 'tab-created';
|
14973
|
+
};
|
14974
|
+
|
14869
14975
|
declare interface TabDragListener extends EventEmitter_2 {
|
14870
14976
|
/**
|
14871
14977
|
* A reference to the content item this tab relates to
|
@@ -14873,6 +14979,15 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
14873
14979
|
contentItem: ContentItem;
|
14874
14980
|
}
|
14875
14981
|
|
14982
|
+
/**
|
14983
|
+
* Generated when a Layout Tab Component was dropped.
|
14984
|
+
* @interface
|
14985
|
+
*/
|
14986
|
+
declare type TabDroppedEvent = LayoutDOMEvent & {
|
14987
|
+
type: 'tab-dropped';
|
14988
|
+
url: string;
|
14989
|
+
};
|
14990
|
+
|
14876
14991
|
/**
|
14877
14992
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
14878
14993
|
*/
|
@@ -17082,7 +17197,8 @@ declare namespace WebContentsEvents {
|
|
17082
17197
|
Event_5 as Event,
|
17083
17198
|
WebContentsEvent,
|
17084
17199
|
WillPropagateWebContentsEvent,
|
17085
|
-
NonPropagatedWebContentsEvent
|
17200
|
+
NonPropagatedWebContentsEvent,
|
17201
|
+
WillRedirectEvent
|
17086
17202
|
}
|
17087
17203
|
}
|
17088
17204
|
|
@@ -17160,14 +17276,15 @@ declare type WillPropagateWebContentsEvent = Event_5<string>;
|
|
17160
17276
|
declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
17161
17277
|
|
17162
17278
|
/**
|
17163
|
-
* Generated
|
17279
|
+
* Generated whenever a redirection occurs.
|
17164
17280
|
* @interface
|
17165
17281
|
*/
|
17166
|
-
declare type WillRedirectEvent =
|
17282
|
+
declare type WillRedirectEvent = NamedEvent & {
|
17167
17283
|
type: 'will-redirect';
|
17168
17284
|
blocked: boolean;
|
17169
17285
|
isInPlace: boolean;
|
17170
17286
|
url: string;
|
17287
|
+
isMainFrame: boolean;
|
17171
17288
|
};
|
17172
17289
|
|
17173
17290
|
/**
|
@@ -18312,7 +18429,6 @@ declare namespace WindowEvents {
|
|
18312
18429
|
AlertRequestedEvent,
|
18313
18430
|
AuthRequestedEvent,
|
18314
18431
|
EndLoadEvent,
|
18315
|
-
WillRedirectEvent,
|
18316
18432
|
ReloadedEvent,
|
18317
18433
|
OptionsChangedEvent,
|
18318
18434
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
@@ -18568,7 +18684,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
18568
18684
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
18569
18685
|
* from {@link OpenFin.ViewEvents}.
|
18570
18686
|
*/
|
18571
|
-
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 |
|
18687
|
+
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;
|
18572
18688
|
|
18573
18689
|
/**
|
18574
18690
|
* Generated when a child window starts loading.
|