@openfin/core 41.100.29 → 41.100.31
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +20 -27
- package/out/mock-alpha.d.ts +36 -2
- package/out/mock-beta.d.ts +36 -2
- package/out/mock-public.d.ts +36 -2
- package/out/mock.d.ts +37 -3
- package/out/mock.js +3869 -3925
- package/package.json +1 -5
package/README.md
CHANGED
@@ -1,52 +1,54 @@
|
|
1
|
-
ℹ️
|
2
|
-
---
|
1
|
+
## ℹ️ _Note: `@openfin/core` is changing the structure of its output. See [v33 Bundling Changes](#v33-bundling-changes)_
|
3
2
|
|
4
3
|
# OpenFin Core
|
5
4
|
|
6
|
-
This package contains the type definitions and API entry points for the OpenFin Core API.
|
5
|
+
This package contains the type definitions and API entry points for the OpenFin Core API. Start here to develop OpenFin applications in TypeScript.
|
7
6
|
|
8
7
|
Libraries are also available for the following frameworks:
|
9
8
|
|
10
|
-
|
11
|
-
|
12
|
-
|
9
|
+
- [Node.js](https://www.npmjs.com/package/openfin-adapter)
|
10
|
+
- [.Net](https://developers.openfin.co/of-docs/docs/net-api)
|
11
|
+
- [Java](https://developers.openfin.co/of-docs/docs/java-api)
|
13
12
|
|
14
13
|
## Installation
|
15
14
|
|
16
15
|
This package cannot be installed as a dev dependency because it is not types-only.
|
17
16
|
|
18
17
|
With npm:
|
18
|
+
|
19
19
|
```bash
|
20
20
|
$ npm i -S @openfin/core
|
21
21
|
```
|
22
22
|
|
23
23
|
With yarn:
|
24
|
+
|
24
25
|
```bash
|
25
26
|
$ yarn add @openfin/core
|
26
27
|
```
|
27
28
|
|
28
29
|
## Usage
|
29
30
|
|
30
|
-
The `fin` export is the primary API entry point.
|
31
|
+
The `fin` export is the primary API entry point. Type definitions are defined in the package's default export.
|
31
32
|
|
32
|
-
The static `fin.me` object contains some information about the current runtime environment even if imported outside of an OpenFin setting.
|
33
|
+
The static `fin.me` object contains some information about the current runtime environment even if imported outside of an OpenFin setting. In this case, the `isOpenFin` property of `fin.me` will be `false`. Outside of OpenFin environments, OpenFin API calls will nullop and throw an error.
|
33
34
|
|
34
35
|
```typescript
|
35
|
-
import OpenFin, { fin } from
|
36
|
+
import OpenFin, { fin } from '@openfin/core';
|
36
37
|
|
37
38
|
const showWindow = async (identity: OpenFin.Identity) => {
|
38
|
-
|
39
|
-
|
39
|
+
const win = await fin.Window.wrap(identity);
|
40
|
+
await win.show();
|
40
41
|
|
41
|
-
|
42
|
-
}
|
42
|
+
const isOpenFin = fin.me.isOpenFin; // false if not in OpenFin
|
43
|
+
};
|
43
44
|
```
|
44
45
|
|
45
46
|
### Importing the type
|
46
47
|
|
47
48
|
To import the `OpenFin` namespace:
|
49
|
+
|
48
50
|
```typescript
|
49
|
-
import OpenFin from
|
51
|
+
import OpenFin from '@openfin/core';
|
50
52
|
|
51
53
|
type OFWindow = OpenFin.Window;
|
52
54
|
```
|
@@ -54,6 +56,7 @@ type OFWindow = OpenFin.Window;
|
|
54
56
|
### TSConfig types array
|
55
57
|
|
56
58
|
To have the `OpenFin` available in your code automatically, just update your tsconfig `types` key:
|
59
|
+
|
57
60
|
```json
|
58
61
|
{
|
59
62
|
"compilerOptions": {
|
@@ -68,8 +71,8 @@ To have the `OpenFin` available in your code automatically, just update your tsc
|
|
68
71
|
|
69
72
|
## For more information
|
70
73
|
|
71
|
-
-
|
72
|
-
-
|
74
|
+
- [Developer guide](https://developers.openfin.co/of-docs/docs/container-overview)
|
75
|
+
- [API reference](https://developer.openfin.co/docs/javascript/stable/Platform.html)
|
73
76
|
|
74
77
|
## Migrations
|
75
78
|
|
@@ -79,7 +82,7 @@ To have the `OpenFin` available in your code automatically, just update your tsc
|
|
79
82
|
|
80
83
|
These changes will allow for improved API and type discoverability via code suggestion and type inspection, and create a clearer, more dependable usage contract for consumers of the package.
|
81
84
|
|
82
|
-
Explicit imports from arbitrary files within the module directory (e.g. "@openfin/core
|
85
|
+
Explicit imports from arbitrary files within the module directory (e.g. "@openfin/core/\*") will no longer be supported in new versions of @openfin/core , for example:
|
83
86
|
|
84
87
|
```js
|
85
88
|
import { fin } from '@openfin/core/src/mock';
|
@@ -96,13 +99,3 @@ Until further notice, older versions of the `@openfin/core` package will be comp
|
|
96
99
|
## v30 Ambient type changes
|
97
100
|
|
98
101
|
Prior to v30, the `OpenFin` namespace was ambiently declared and always available. Starting with v30, you must import it directly or specify it in the tsconfig.
|
99
|
-
|
100
|
-
## License
|
101
|
-
|
102
|
-
Copyright 2020-2023 OpenFin
|
103
|
-
|
104
|
-
The code in this package is distributed under the Apache License, Version 2.0.
|
105
|
-
|
106
|
-
However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or email us at support@openfin.co with questions.
|
107
|
-
|
108
|
-
- [Developer agreement](https://openfin.co/developer-agreement/)
|
package/out/mock-alpha.d.ts
CHANGED
@@ -5253,6 +5253,10 @@ declare namespace FDC3 {
|
|
5253
5253
|
}
|
5254
5254
|
}
|
5255
5255
|
|
5256
|
+
declare type FDC3Factory = typeof fdc3Factory;
|
5257
|
+
|
5258
|
+
declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin_2.InteropClient, wire: Transport<'unknown'>) => OpenFin_2.FDC3.v2_0.DesktopAgent | OpenFin_2.FDC3.v1_2.DesktopAgent;
|
5259
|
+
|
5256
5260
|
/**
|
5257
5261
|
* @interface
|
5258
5262
|
*/
|
@@ -6880,7 +6884,7 @@ declare class InteropBroker extends Base {
|
|
6880
6884
|
};
|
6881
6885
|
private getClientState;
|
6882
6886
|
private static toObject;
|
6883
|
-
static checkContextIntegrity(context: OpenFin_2.Context)
|
6887
|
+
static checkContextIntegrity: (context: OpenFin_2.Context) => {
|
6884
6888
|
isValid: true;
|
6885
6889
|
} | {
|
6886
6890
|
isValid: false;
|
@@ -7903,6 +7907,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
7903
7907
|
|
7904
7908
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
7905
7909
|
|
7910
|
+
/**
|
7911
|
+
* Generated after a layout is created.
|
7912
|
+
* @interface
|
7913
|
+
*/
|
7914
|
+
declare type LayoutCreatedEvent = BaseEvent_5 & {
|
7915
|
+
type: 'layout-created';
|
7916
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
7917
|
+
};
|
7918
|
+
|
7919
|
+
/**
|
7920
|
+
* Generated after a layout is destroyed.
|
7921
|
+
* @interface
|
7922
|
+
*/
|
7923
|
+
declare type LayoutDestroyedEvent = BaseEvent_5 & {
|
7924
|
+
type: 'layout-destroyed';
|
7925
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
7926
|
+
};
|
7927
|
+
|
7906
7928
|
/**
|
7907
7929
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
7908
7930
|
*/
|
@@ -8388,6 +8410,15 @@ declare type LayoutSnapshot = {
|
|
8388
8410
|
layouts: Record<string, LayoutOptions>;
|
8389
8411
|
};
|
8390
8412
|
|
8413
|
+
/**
|
8414
|
+
* Generated after a snapshot is applied.
|
8415
|
+
* @interface
|
8416
|
+
*/
|
8417
|
+
declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
|
8418
|
+
type: 'layout-snapshot-applied';
|
8419
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8420
|
+
};
|
8421
|
+
|
8391
8422
|
/**
|
8392
8423
|
* Generated when the Layout experiences a state change, for example tabs added/removed.
|
8393
8424
|
* @interface
|
@@ -18588,6 +18619,9 @@ declare namespace WindowEvents {
|
|
18588
18619
|
PerformanceReportEvent,
|
18589
18620
|
InputEvent_2 as InputEvent,
|
18590
18621
|
LayoutInitializedEvent,
|
18622
|
+
LayoutCreatedEvent,
|
18623
|
+
LayoutDestroyedEvent,
|
18624
|
+
LayoutSnapshotAppliedEvent,
|
18591
18625
|
LayoutReadyEvent,
|
18592
18626
|
CloseRequestedEvent,
|
18593
18627
|
WindowCloseRequestedEvent,
|
@@ -18821,7 +18855,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
18821
18855
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
18822
18856
|
* from {@link OpenFin.ViewEvents}.
|
18823
18857
|
*/
|
18824
|
-
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;
|
18858
|
+
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 | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
18825
18859
|
|
18826
18860
|
/**
|
18827
18861
|
* Generated when a child window starts loading.
|
package/out/mock-beta.d.ts
CHANGED
@@ -5253,6 +5253,10 @@ declare namespace FDC3 {
|
|
5253
5253
|
}
|
5254
5254
|
}
|
5255
5255
|
|
5256
|
+
declare type FDC3Factory = typeof fdc3Factory;
|
5257
|
+
|
5258
|
+
declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin_2.InteropClient, wire: Transport<'unknown'>) => OpenFin_2.FDC3.v2_0.DesktopAgent | OpenFin_2.FDC3.v1_2.DesktopAgent;
|
5259
|
+
|
5256
5260
|
/**
|
5257
5261
|
* @interface
|
5258
5262
|
*/
|
@@ -6880,7 +6884,7 @@ declare class InteropBroker extends Base {
|
|
6880
6884
|
};
|
6881
6885
|
private getClientState;
|
6882
6886
|
private static toObject;
|
6883
|
-
static checkContextIntegrity(context: OpenFin_2.Context)
|
6887
|
+
static checkContextIntegrity: (context: OpenFin_2.Context) => {
|
6884
6888
|
isValid: true;
|
6885
6889
|
} | {
|
6886
6890
|
isValid: false;
|
@@ -7903,6 +7907,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
7903
7907
|
|
7904
7908
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
7905
7909
|
|
7910
|
+
/**
|
7911
|
+
* Generated after a layout is created.
|
7912
|
+
* @interface
|
7913
|
+
*/
|
7914
|
+
declare type LayoutCreatedEvent = BaseEvent_5 & {
|
7915
|
+
type: 'layout-created';
|
7916
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
7917
|
+
};
|
7918
|
+
|
7919
|
+
/**
|
7920
|
+
* Generated after a layout is destroyed.
|
7921
|
+
* @interface
|
7922
|
+
*/
|
7923
|
+
declare type LayoutDestroyedEvent = BaseEvent_5 & {
|
7924
|
+
type: 'layout-destroyed';
|
7925
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
7926
|
+
};
|
7927
|
+
|
7906
7928
|
/**
|
7907
7929
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
7908
7930
|
*/
|
@@ -8388,6 +8410,15 @@ declare type LayoutSnapshot = {
|
|
8388
8410
|
layouts: Record<string, LayoutOptions>;
|
8389
8411
|
};
|
8390
8412
|
|
8413
|
+
/**
|
8414
|
+
* Generated after a snapshot is applied.
|
8415
|
+
* @interface
|
8416
|
+
*/
|
8417
|
+
declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
|
8418
|
+
type: 'layout-snapshot-applied';
|
8419
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8420
|
+
};
|
8421
|
+
|
8391
8422
|
/**
|
8392
8423
|
* Generated when the Layout experiences a state change, for example tabs added/removed.
|
8393
8424
|
* @interface
|
@@ -18588,6 +18619,9 @@ declare namespace WindowEvents {
|
|
18588
18619
|
PerformanceReportEvent,
|
18589
18620
|
InputEvent_2 as InputEvent,
|
18590
18621
|
LayoutInitializedEvent,
|
18622
|
+
LayoutCreatedEvent,
|
18623
|
+
LayoutDestroyedEvent,
|
18624
|
+
LayoutSnapshotAppliedEvent,
|
18591
18625
|
LayoutReadyEvent,
|
18592
18626
|
CloseRequestedEvent,
|
18593
18627
|
WindowCloseRequestedEvent,
|
@@ -18821,7 +18855,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
18821
18855
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
18822
18856
|
* from {@link OpenFin.ViewEvents}.
|
18823
18857
|
*/
|
18824
|
-
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;
|
18858
|
+
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 | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
18825
18859
|
|
18826
18860
|
/**
|
18827
18861
|
* Generated when a child window starts loading.
|
package/out/mock-public.d.ts
CHANGED
@@ -5253,6 +5253,10 @@ declare namespace FDC3 {
|
|
5253
5253
|
}
|
5254
5254
|
}
|
5255
5255
|
|
5256
|
+
declare type FDC3Factory = typeof fdc3Factory;
|
5257
|
+
|
5258
|
+
declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin_2.InteropClient, wire: Transport<'unknown'>) => OpenFin_2.FDC3.v2_0.DesktopAgent | OpenFin_2.FDC3.v1_2.DesktopAgent;
|
5259
|
+
|
5256
5260
|
/**
|
5257
5261
|
* @interface
|
5258
5262
|
*/
|
@@ -6880,7 +6884,7 @@ declare class InteropBroker extends Base {
|
|
6880
6884
|
};
|
6881
6885
|
private getClientState;
|
6882
6886
|
private static toObject;
|
6883
|
-
static checkContextIntegrity(context: OpenFin_2.Context)
|
6887
|
+
static checkContextIntegrity: (context: OpenFin_2.Context) => {
|
6884
6888
|
isValid: true;
|
6885
6889
|
} | {
|
6886
6890
|
isValid: false;
|
@@ -7903,6 +7907,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
7903
7907
|
|
7904
7908
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
7905
7909
|
|
7910
|
+
/**
|
7911
|
+
* Generated after a layout is created.
|
7912
|
+
* @interface
|
7913
|
+
*/
|
7914
|
+
declare type LayoutCreatedEvent = BaseEvent_5 & {
|
7915
|
+
type: 'layout-created';
|
7916
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
7917
|
+
};
|
7918
|
+
|
7919
|
+
/**
|
7920
|
+
* Generated after a layout is destroyed.
|
7921
|
+
* @interface
|
7922
|
+
*/
|
7923
|
+
declare type LayoutDestroyedEvent = BaseEvent_5 & {
|
7924
|
+
type: 'layout-destroyed';
|
7925
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
7926
|
+
};
|
7927
|
+
|
7906
7928
|
/**
|
7907
7929
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
7908
7930
|
*/
|
@@ -8388,6 +8410,15 @@ declare type LayoutSnapshot = {
|
|
8388
8410
|
layouts: Record<string, LayoutOptions>;
|
8389
8411
|
};
|
8390
8412
|
|
8413
|
+
/**
|
8414
|
+
* Generated after a snapshot is applied.
|
8415
|
+
* @interface
|
8416
|
+
*/
|
8417
|
+
declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
|
8418
|
+
type: 'layout-snapshot-applied';
|
8419
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8420
|
+
};
|
8421
|
+
|
8391
8422
|
/**
|
8392
8423
|
* Generated when the Layout experiences a state change, for example tabs added/removed.
|
8393
8424
|
* @interface
|
@@ -18588,6 +18619,9 @@ declare namespace WindowEvents {
|
|
18588
18619
|
PerformanceReportEvent,
|
18589
18620
|
InputEvent_2 as InputEvent,
|
18590
18621
|
LayoutInitializedEvent,
|
18622
|
+
LayoutCreatedEvent,
|
18623
|
+
LayoutDestroyedEvent,
|
18624
|
+
LayoutSnapshotAppliedEvent,
|
18591
18625
|
LayoutReadyEvent,
|
18592
18626
|
CloseRequestedEvent,
|
18593
18627
|
WindowCloseRequestedEvent,
|
@@ -18821,7 +18855,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
18821
18855
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
18822
18856
|
* from {@link OpenFin.ViewEvents}.
|
18823
18857
|
*/
|
18824
|
-
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;
|
18858
|
+
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 | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
18825
18859
|
|
18826
18860
|
/**
|
18827
18861
|
* Generated when a child window starts loading.
|
package/out/mock.d.ts
CHANGED
@@ -5338,6 +5338,10 @@ declare namespace FDC3 {
|
|
5338
5338
|
}
|
5339
5339
|
}
|
5340
5340
|
|
5341
|
+
declare type FDC3Factory = typeof fdc3Factory;
|
5342
|
+
|
5343
|
+
declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin_2.InteropClient, wire: Transport<'unknown'>) => OpenFin_2.FDC3.v2_0.DesktopAgent | OpenFin_2.FDC3.v1_2.DesktopAgent;
|
5344
|
+
|
5341
5345
|
/**
|
5342
5346
|
* @interface
|
5343
5347
|
*/
|
@@ -6989,7 +6993,7 @@ declare class InteropBroker extends Base {
|
|
6989
6993
|
};
|
6990
6994
|
private getClientState;
|
6991
6995
|
private static toObject;
|
6992
|
-
static checkContextIntegrity(context: OpenFin_2.Context)
|
6996
|
+
static checkContextIntegrity: (context: OpenFin_2.Context) => {
|
6993
6997
|
isValid: true;
|
6994
6998
|
} | {
|
6995
6999
|
isValid: false;
|
@@ -7088,7 +7092,7 @@ declare class InteropClient extends Base {
|
|
7088
7092
|
/**
|
7089
7093
|
* @internal
|
7090
7094
|
*/
|
7091
|
-
constructor(wire: Transport, clientPromise: Promise<OpenFin_2.ChannelClient
|
7095
|
+
constructor(wire: Transport, clientPromise: Promise<OpenFin_2.ChannelClient>, fdc3Factory: FDC3Factory);
|
7092
7096
|
/**
|
7093
7097
|
* Sets a context for the context group of the current entity.
|
7094
7098
|
*
|
@@ -8029,6 +8033,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
8029
8033
|
|
8030
8034
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
8031
8035
|
|
8036
|
+
/**
|
8037
|
+
* Generated after a layout is created.
|
8038
|
+
* @interface
|
8039
|
+
*/
|
8040
|
+
declare type LayoutCreatedEvent = BaseEvent_5 & {
|
8041
|
+
type: 'layout-created';
|
8042
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8043
|
+
};
|
8044
|
+
|
8045
|
+
/**
|
8046
|
+
* Generated after a layout is destroyed.
|
8047
|
+
* @interface
|
8048
|
+
*/
|
8049
|
+
declare type LayoutDestroyedEvent = BaseEvent_5 & {
|
8050
|
+
type: 'layout-destroyed';
|
8051
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8052
|
+
};
|
8053
|
+
|
8032
8054
|
/**
|
8033
8055
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
8034
8056
|
*/
|
@@ -8684,6 +8706,15 @@ declare type LayoutSnapshot = {
|
|
8684
8706
|
layouts: Record<string, LayoutOptions>;
|
8685
8707
|
};
|
8686
8708
|
|
8709
|
+
/**
|
8710
|
+
* Generated after a snapshot is applied.
|
8711
|
+
* @interface
|
8712
|
+
*/
|
8713
|
+
declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
|
8714
|
+
type: 'layout-snapshot-applied';
|
8715
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8716
|
+
};
|
8717
|
+
|
8687
8718
|
/**
|
8688
8719
|
* Generated when the Layout experiences a state change, for example tabs added/removed.
|
8689
8720
|
* @interface
|
@@ -19042,6 +19073,9 @@ declare namespace WindowEvents {
|
|
19042
19073
|
PerformanceReportEvent,
|
19043
19074
|
InputEvent_2 as InputEvent,
|
19044
19075
|
LayoutInitializedEvent,
|
19076
|
+
LayoutCreatedEvent,
|
19077
|
+
LayoutDestroyedEvent,
|
19078
|
+
LayoutSnapshotAppliedEvent,
|
19045
19079
|
LayoutReadyEvent,
|
19046
19080
|
CloseRequestedEvent,
|
19047
19081
|
WindowCloseRequestedEvent,
|
@@ -19275,7 +19309,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
19275
19309
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
19276
19310
|
* from {@link OpenFin.ViewEvents}.
|
19277
19311
|
*/
|
19278
|
-
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;
|
19312
|
+
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 | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
19279
19313
|
|
19280
19314
|
/**
|
19281
19315
|
* Generated when a child window starts loading.
|