@openfin/core 31.74.1 → 31.74.2
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/package.json +1 -1
- package/src/OpenFin.d.ts +284 -253
- package/src/OpenFin.js +0 -2
- package/src/api/api-exposer/api-consumer.d.ts +28 -0
- package/src/api/api-exposer/api-consumer.js +28 -0
- package/src/api/api-exposer/api-exposer.d.ts +35 -0
- package/src/api/api-exposer/api-exposer.js +38 -0
- package/src/api/api-exposer/decorators.d.ts +10 -0
- package/src/api/api-exposer/decorators.js +18 -0
- package/src/api/api-exposer/index.d.ts +4 -0
- package/src/api/api-exposer/index.js +20 -0
- package/src/api/api-exposer/strategies/index.d.ts +1 -0
- package/src/api/api-exposer/strategies/index.js +17 -0
- package/src/api/api-exposer/strategies/openfin-channels/channels-consumer.d.ts +14 -0
- package/src/api/api-exposer/strategies/openfin-channels/channels-consumer.js +20 -0
- package/src/api/api-exposer/strategies/openfin-channels/channels-exposer.d.ts +20 -0
- package/src/api/api-exposer/strategies/openfin-channels/channels-exposer.js +23 -0
- package/src/api/api-exposer/strategies/openfin-channels/index.d.ts +2 -0
- package/src/api/api-exposer/strategies/openfin-channels/index.js +18 -0
- package/src/api/application/Factory.js +1 -2
- package/src/api/base.d.ts +2 -2
- package/src/api/events/application.d.ts +22 -22
- package/src/api/events/base.d.ts +6 -9
- package/src/api/events/channel.d.ts +5 -5
- package/src/api/events/emitterMap.d.ts +1 -1
- package/src/api/events/externalApplication.d.ts +3 -3
- package/src/api/events/frame.d.ts +5 -5
- package/src/api/events/globalHotkey.d.ts +3 -3
- package/src/api/events/platform.d.ts +3 -3
- package/src/api/events/system.d.ts +17 -17
- package/src/api/events/typedEventEmitter.d.ts +1 -1
- package/src/api/events/view.d.ts +17 -14
- package/src/api/events/webcontents.d.ts +24 -22
- package/src/api/events/window.d.ts +65 -57
- package/src/api/fin.d.ts +1 -1
- package/src/api/frame/Instance.d.ts +1 -1
- package/src/api/interappbus/channel/channel.d.ts +4 -4
- package/src/api/interappbus/channel/channel.js +3 -3
- package/src/api/interappbus/channel/client.d.ts +2 -2
- package/src/api/interappbus/channel/client.js +20 -20
- package/src/api/interappbus/channel/connection-manager.d.ts +1 -1
- package/src/api/interappbus/channel/connection-manager.js +12 -12
- package/src/api/interappbus/channel/index.d.ts +2 -2
- package/src/api/interappbus/channel/index.js +1 -1
- package/src/api/interappbus/channel/protocols/classic/strategy.d.ts +1 -1
- package/src/api/interappbus/channel/protocols/combined/strategy.d.ts +2 -2
- package/src/api/interappbus/channel/protocols/combined/strategy.js +5 -5
- package/src/api/interappbus/channel/protocols/index.d.ts +4 -4
- package/src/api/interappbus/channel/protocols/rtc/endpoint.d.ts +1 -1
- package/src/api/interappbus/channel/protocols/rtc/strategy.d.ts +1 -1
- package/src/api/interappbus/channel/protocols/strategy-types.d.ts +4 -4
- package/src/api/interappbus/channel/protocols/strategy.d.ts +3 -3
- package/src/api/interappbus/channel/provider.d.ts +5 -5
- package/src/api/interappbus/channel/provider.js +24 -24
- package/src/api/interop/InteropBroker.d.ts +1 -1
- package/src/api/interop/InteropBroker.js +6 -2
- package/src/api/interop/fdc3/PrivateChannelClient.d.ts +2 -1
- package/src/api/interop/fdc3/PrivateChannelClient.js +15 -7
- package/src/api/interop/fdc3/PrivateChannelProvider.d.ts +16 -2
- package/src/api/interop/fdc3/PrivateChannelProvider.js +80 -21
- package/src/api/interop/fdc3/fdc3-1.2.js +19 -4
- package/src/api/interop/fdc3/fdc3-2.0.d.ts +11 -10
- package/src/api/interop/fdc3/fdc3-2.0.js +18 -19
- package/src/api/interop/fdc3/shapes/fdc3v1.d.ts +3 -3
- package/src/api/interop/fdc3/shapes/fdc3v2.d.ts +5 -5
- package/src/api/interop/fdc3/utils.d.ts +17 -0
- package/src/api/interop/fdc3/utils.js +52 -18
- package/src/api/interop/fdc3/versions.d.ts +1 -1
- package/src/api/interop/utils.d.ts +0 -1
- package/src/api/interop/utils.js +1 -9
- package/src/api/me.d.ts +3 -3
- package/src/api/platform/Factory.js +5 -9
- package/src/api/platform/Instance.d.ts +1 -1
- package/src/api/platform/Instance.js +1 -1
- package/src/api/platform/common-utils.d.ts +1 -1
- package/src/api/platform/layout/Factory.d.ts +1 -1
- package/src/api/platform/layout/Factory.js +11 -3
- package/src/api/platform/layout/Instance.d.ts +9 -3
- package/src/api/platform/layout/Instance.js +26 -1
- package/src/api/platform/layout/controllers/layout-content-cache.d.ts +9 -0
- package/src/api/platform/layout/controllers/layout-content-cache.js +54 -0
- package/src/api/platform/layout/controllers/layout-entities-controller.d.ts +117 -0
- package/src/api/platform/layout/controllers/layout-entities-controller.js +270 -0
- package/src/api/platform/layout/controllers/splitter-controller.d.ts +1 -1
- package/src/api/platform/layout/entities/layout-entities.d.ts +144 -0
- package/src/api/platform/layout/entities/layout-entities.js +216 -0
- package/src/api/platform/layout/entities/shapes.d.ts +6 -0
- package/src/api/platform/layout/entities/shapes.js +2 -0
- package/src/api/platform/layout/layout.constants.d.ts +1 -0
- package/src/api/platform/layout/layout.constants.js +4 -0
- package/src/api/platform/layout/shapes.d.ts +4 -1
- package/src/api/platform/layout/utils/layout-traversal.d.ts +4 -0
- package/src/api/platform/layout/utils/layout-traversal.js +65 -0
- package/src/api/system/index.d.ts +13 -13
- package/src/api/view/Instance.d.ts +13 -3
- package/src/api/view/Instance.js +41 -4
- package/src/environment/browser.d.ts +1 -1
- package/src/environment/environment.d.ts +1 -1
- package/src/environment/node-env.d.ts +1 -1
- package/src/environment/openfin-env.d.ts +1 -1
- package/src/mock.d.ts +1 -1
- package/src/mock.js +5 -2
- package/src/shapes/ERROR_BOX_TYPES.d.ts +1 -1
- package/src/shapes/protocol.d.ts +3 -3
- package/src/transport/transport-errors.d.ts +2 -2
- package/src/transport/transport.d.ts +3 -3
- package/src/transport/transport.js +1 -4
- package/src/transport/wire.d.ts +14 -13
- package/src/util/channel-api-relay.d.ts +13 -0
- package/src/util/channel-api-relay.js +37 -0
- package/src/util/errors.d.ts +2 -2
- package/src/util/http.js +4 -2
- package/src/util/lazy.d.ts +16 -0
- package/src/util/lazy.js +26 -0
- package/src/util/promises.d.ts +1 -1
- package/src/util/reversible-map.d.ts +11 -0
- package/src/util/reversible-map.js +49 -0
- package/src/util/utilTypes.d.ts +1 -1
package/src/OpenFin.d.ts
CHANGED
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
import type { Application } from './api/application';
|
|
1
|
+
import type { Application } from './api/application/index';
|
|
2
2
|
import { AppVersionEvent } from './api/events/system';
|
|
3
3
|
import { TypedEventEmitter } from './api/events/typedEventEmitter';
|
|
4
|
-
import type { ExternalApplication } from './api/external-application';
|
|
4
|
+
import type { ExternalApplication } from './api/external-application/index';
|
|
5
5
|
import { FinApi } from './api/fin';
|
|
6
|
-
import type { _Frame } from './api/frame';
|
|
6
|
+
import type { _Frame } from './api/frame/index';
|
|
7
7
|
import type ChannelClient from './api/interappbus/channel/client';
|
|
8
|
-
import { MessagingProtocols } from './api/interappbus/channel/protocols';
|
|
8
|
+
import { MessagingProtocols } from './api/interappbus/channel/protocols/index';
|
|
9
9
|
import type { ChannelProvider } from './api/interappbus/channel/provider';
|
|
10
|
-
import type { InteropBroker, InteropClient } from './api/interop';
|
|
11
|
-
import type { Platform } from './api/platform';
|
|
12
|
-
import type { Layout } from './api/platform/layout';
|
|
10
|
+
import type { InteropBroker, InteropClient } from './api/interop/index';
|
|
11
|
+
import type { Platform } from './api/platform/index';
|
|
12
|
+
import type { Layout } from './api/platform/layout/index';
|
|
13
13
|
import { PlatformProvider } from './api/platform/provider';
|
|
14
|
-
import { SnapshotSource } from './api/snapshot-source';
|
|
15
|
-
import type { View } from './api/view';
|
|
16
|
-
import { _Window } from './api/window';
|
|
17
|
-
|
|
18
|
-
export type
|
|
19
|
-
export
|
|
14
|
+
import { SnapshotSource } from './api/snapshot-source/index';
|
|
15
|
+
import type { View } from './api/view/index';
|
|
16
|
+
import { _Window } from './api/window/index';
|
|
17
|
+
import { ColumnOrRow, TabStack } from './api/platform/layout/entities/layout-entities';
|
|
18
|
+
export type Fin<MeType extends EntityType = 'window' | 'view'> = FinApi<MeType>;
|
|
19
|
+
export type { Application, ExternalApplication, _Frame as Frame, ChannelClient, ChannelProvider, Platform, Layout, View, ColumnOrRow, TabStack, _Window as Window, InteropClient, InteropBroker, SnapshotSource };
|
|
20
|
+
export type { LayoutEntityDefinition, LayoutEntityTypes, LayoutPosition } from './api/platform/layout/entities/shapes';
|
|
21
|
+
export type WebContent = View | _Window;
|
|
20
22
|
export type { PlatformProvider };
|
|
21
|
-
export
|
|
23
|
+
export type ApplicationIdentity = {
|
|
22
24
|
uuid: string;
|
|
23
25
|
};
|
|
24
|
-
export
|
|
26
|
+
export type Identity = {
|
|
25
27
|
/**
|
|
26
28
|
* Universally unique identifier of the compenent
|
|
27
29
|
*/
|
|
@@ -34,7 +36,7 @@ export declare type Identity = {
|
|
|
34
36
|
/**
|
|
35
37
|
* Identity of a channel client
|
|
36
38
|
*/
|
|
37
|
-
export
|
|
39
|
+
export type ClientIdentity = Identity & {
|
|
38
40
|
/**
|
|
39
41
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
|
40
42
|
*/
|
|
@@ -44,7 +46,7 @@ export declare type ClientIdentity = Identity & {
|
|
|
44
46
|
/**
|
|
45
47
|
* Extended channel client information
|
|
46
48
|
*/
|
|
47
|
-
export
|
|
49
|
+
export type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
48
50
|
/**
|
|
49
51
|
* Indicates if the client belongs to a Window or View
|
|
50
52
|
*/
|
|
@@ -54,16 +56,16 @@ export declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
54
56
|
*/
|
|
55
57
|
connectionUrl: string;
|
|
56
58
|
};
|
|
57
|
-
export
|
|
59
|
+
export type ClientIdentityMultiRuntime = ClientIdentity & {
|
|
58
60
|
runtimeUuid: string;
|
|
59
61
|
};
|
|
60
|
-
export
|
|
62
|
+
export type EntityInfo = {
|
|
61
63
|
uuid: string;
|
|
62
64
|
name: string;
|
|
63
65
|
entityType: EntityType;
|
|
64
66
|
};
|
|
65
|
-
export
|
|
66
|
-
export
|
|
67
|
+
export type EntityType = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
|
|
68
|
+
export type Bounds = {
|
|
67
69
|
top: number;
|
|
68
70
|
left: number;
|
|
69
71
|
height: number;
|
|
@@ -72,14 +74,14 @@ export declare type Bounds = {
|
|
|
72
74
|
/**
|
|
73
75
|
* Returned from getBounds call. bottom and right are never used for setting.
|
|
74
76
|
*/
|
|
75
|
-
export
|
|
77
|
+
export type WindowBounds = Bounds & {
|
|
76
78
|
bottom: number;
|
|
77
79
|
right: number;
|
|
78
80
|
};
|
|
79
81
|
/**
|
|
80
82
|
* A rectangular area on the screen.
|
|
81
83
|
*/
|
|
82
|
-
export
|
|
84
|
+
export type Rectangle = {
|
|
83
85
|
/**
|
|
84
86
|
* The x coordinate of the rectangle's origin in pixels
|
|
85
87
|
*/
|
|
@@ -112,14 +114,14 @@ export declare type Rectangle = {
|
|
|
112
114
|
* This object inherits all the properties of the window creation {@link Window~options options} object,
|
|
113
115
|
* which will take priority over those of the same name that may be provided in `mainWindowOptions`.
|
|
114
116
|
*/
|
|
115
|
-
export
|
|
117
|
+
export type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
116
118
|
name: string;
|
|
117
119
|
uuid: string;
|
|
118
120
|
};
|
|
119
121
|
/**
|
|
120
122
|
* The complete set of options for an application.
|
|
121
123
|
*/
|
|
122
|
-
export
|
|
124
|
+
export type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
123
125
|
/**
|
|
124
126
|
* @defaultValue false
|
|
125
127
|
*
|
|
@@ -213,11 +215,11 @@ export declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
213
215
|
enableJumpList: boolean;
|
|
214
216
|
enableBeforeUnload: boolean;
|
|
215
217
|
};
|
|
216
|
-
export
|
|
218
|
+
export type InteropBrokerOptions = {
|
|
217
219
|
contextGroups?: ContextGroupInfo;
|
|
218
220
|
logging?: InteropLoggingOptions;
|
|
219
221
|
};
|
|
220
|
-
export
|
|
222
|
+
export type ContextGroupInfo = {
|
|
221
223
|
/**
|
|
222
224
|
* Name of the context group.
|
|
223
225
|
*/
|
|
@@ -230,7 +232,7 @@ export declare type ContextGroupInfo = {
|
|
|
230
232
|
/**
|
|
231
233
|
* The display data for a context group.
|
|
232
234
|
*/
|
|
233
|
-
export
|
|
235
|
+
export type DisplayMetadata = {
|
|
234
236
|
/**
|
|
235
237
|
* A user-readable name for this context group, e.g: `"Red"`
|
|
236
238
|
*/
|
|
@@ -244,8 +246,8 @@ export declare type DisplayMetadata = {
|
|
|
244
246
|
*/
|
|
245
247
|
readonly glyph?: string;
|
|
246
248
|
};
|
|
247
|
-
export
|
|
248
|
-
export
|
|
249
|
+
export type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad'>;
|
|
250
|
+
export type Snapshot = {
|
|
249
251
|
windows: WindowCreationOptions[];
|
|
250
252
|
snapshotDetails?: {
|
|
251
253
|
monitorInfo: MonitorInfo;
|
|
@@ -256,7 +258,7 @@ export declare type Snapshot = {
|
|
|
256
258
|
contextGroupStates: ContextGroupStates;
|
|
257
259
|
};
|
|
258
260
|
};
|
|
259
|
-
export
|
|
261
|
+
export type ContextGroupStates = {
|
|
260
262
|
[key: string]: {
|
|
261
263
|
[key: string]: Context;
|
|
262
264
|
};
|
|
@@ -264,7 +266,7 @@ export declare type ContextGroupStates = {
|
|
|
264
266
|
/**
|
|
265
267
|
* Data passed between entities and applications.
|
|
266
268
|
*/
|
|
267
|
-
export
|
|
269
|
+
export type Context = {
|
|
268
270
|
/**
|
|
269
271
|
* An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
270
272
|
*/
|
|
@@ -280,7 +282,7 @@ export declare type Context = {
|
|
|
280
282
|
*/
|
|
281
283
|
type: string;
|
|
282
284
|
};
|
|
283
|
-
export
|
|
285
|
+
export type MonitorInfo = {
|
|
284
286
|
/**
|
|
285
287
|
* The device scale factor.
|
|
286
288
|
*/
|
|
@@ -298,7 +300,7 @@ export declare type MonitorInfo = {
|
|
|
298
300
|
*/
|
|
299
301
|
virtualScreen: DipRect;
|
|
300
302
|
};
|
|
301
|
-
export
|
|
303
|
+
export type Point = {
|
|
302
304
|
/**
|
|
303
305
|
* The mouse x position
|
|
304
306
|
*/
|
|
@@ -308,7 +310,7 @@ export declare type Point = {
|
|
|
308
310
|
*/
|
|
309
311
|
y: number;
|
|
310
312
|
};
|
|
311
|
-
export
|
|
313
|
+
export type PointTopLeft = {
|
|
312
314
|
/**
|
|
313
315
|
* The mouse top position in virtual screen coordinates
|
|
314
316
|
*/
|
|
@@ -318,13 +320,13 @@ export declare type PointTopLeft = {
|
|
|
318
320
|
*/
|
|
319
321
|
left: number;
|
|
320
322
|
};
|
|
321
|
-
export
|
|
323
|
+
export type RectangleByEdgePositions = {
|
|
322
324
|
top: number;
|
|
323
325
|
left: number;
|
|
324
326
|
bottom: number;
|
|
325
327
|
right: number;
|
|
326
328
|
};
|
|
327
|
-
export
|
|
329
|
+
export type MonitorDetails = {
|
|
328
330
|
/**
|
|
329
331
|
* The available DIP scale coordinates.
|
|
330
332
|
*/
|
|
@@ -359,15 +361,15 @@ export declare type MonitorDetails = {
|
|
|
359
361
|
*/
|
|
360
362
|
monitor: DipScaleRects;
|
|
361
363
|
};
|
|
362
|
-
export
|
|
364
|
+
export type DipRect = RectangleByEdgePositions & {
|
|
363
365
|
dipRect: RectangleByEdgePositions;
|
|
364
366
|
scaledRect: RectangleByEdgePositions;
|
|
365
367
|
};
|
|
366
|
-
export
|
|
368
|
+
export type DipScaleRects = {
|
|
367
369
|
dipRect: RectangleByEdgePositions;
|
|
368
370
|
scaledRect: RectangleByEdgePositions;
|
|
369
371
|
};
|
|
370
|
-
export
|
|
372
|
+
export type TaskBar = DipScaleRects & {
|
|
371
373
|
/**
|
|
372
374
|
* Which edge of a monitor the taskbar is on
|
|
373
375
|
*/
|
|
@@ -383,21 +385,21 @@ export declare type TaskBar = DipScaleRects & {
|
|
|
383
385
|
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
384
386
|
* (defaults to `"about:blank"` when omitted).
|
|
385
387
|
*/
|
|
386
|
-
export
|
|
388
|
+
export type WindowCreationOptions = Partial<WindowOptions> & {
|
|
387
389
|
name: string;
|
|
388
390
|
};
|
|
389
|
-
export
|
|
390
|
-
export
|
|
391
|
+
export type UpdatableWindowOptions = Partial<MutableWindowOptions>;
|
|
392
|
+
export type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
|
391
393
|
/**
|
|
392
394
|
* Configuration for view visibility settings
|
|
393
395
|
*/
|
|
394
|
-
export
|
|
396
|
+
export type ViewVisibilityOption = {
|
|
395
397
|
enabled?: boolean;
|
|
396
398
|
};
|
|
397
399
|
/**
|
|
398
400
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
399
401
|
*/
|
|
400
|
-
export
|
|
402
|
+
export type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
401
403
|
/**
|
|
402
404
|
* @defaultValue false
|
|
403
405
|
*
|
|
@@ -414,7 +416,7 @@ export declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
|
414
416
|
/**
|
|
415
417
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
416
418
|
*/
|
|
417
|
-
export
|
|
419
|
+
export type ViewVisibilityOptions = {
|
|
418
420
|
/**
|
|
419
421
|
* Enables views to be shown when a Platform Window is being resized by the user.
|
|
420
422
|
*/
|
|
@@ -431,12 +433,12 @@ export declare type ViewVisibilityOptions = {
|
|
|
431
433
|
/**
|
|
432
434
|
* Visibility state of a window.
|
|
433
435
|
*/
|
|
434
|
-
export
|
|
435
|
-
export
|
|
436
|
+
export type WindowState = 'maximized' | 'minimized' | 'normal';
|
|
437
|
+
export type AutoplayPolicyOptions = 'no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required';
|
|
436
438
|
/**
|
|
437
439
|
* Window options that cannot be changed after creation.
|
|
438
440
|
*/
|
|
439
|
-
export
|
|
441
|
+
export type ConstWindowOptions = {
|
|
440
442
|
/**
|
|
441
443
|
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
442
444
|
*/
|
|
@@ -629,7 +631,7 @@ export declare type ConstWindowOptions = {
|
|
|
629
631
|
/**
|
|
630
632
|
* Window options that can be changed after window creation.
|
|
631
633
|
*/
|
|
632
|
-
export
|
|
634
|
+
export type MutableWindowOptions = {
|
|
633
635
|
/**
|
|
634
636
|
* Turns anything of matching RGB value transparent.
|
|
635
637
|
*
|
|
@@ -794,7 +796,7 @@ export declare type MutableWindowOptions = {
|
|
|
794
796
|
interop: InteropConfig;
|
|
795
797
|
workspacePlatform: WorkspacePlatformOptions;
|
|
796
798
|
};
|
|
797
|
-
export
|
|
799
|
+
export type WorkspacePlatformOptions = {
|
|
798
800
|
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
|
799
801
|
[key: string]: any;
|
|
800
802
|
};
|
|
@@ -802,13 +804,13 @@ export declare type WorkspacePlatformOptions = {
|
|
|
802
804
|
* Object representing headers and their values, where the
|
|
803
805
|
* object key is the name of header and value key is the value of the header
|
|
804
806
|
*/
|
|
805
|
-
export
|
|
807
|
+
export type WebRequestHeader = {
|
|
806
808
|
[key: string]: string;
|
|
807
809
|
};
|
|
808
810
|
/**
|
|
809
811
|
* Custom headers for requests sent by the window.
|
|
810
812
|
*/
|
|
811
|
-
export
|
|
813
|
+
export type CustomRequestHeaders = {
|
|
812
814
|
/**
|
|
813
815
|
* The URL patterns for which the headers will be applied.
|
|
814
816
|
*/
|
|
@@ -819,7 +821,7 @@ export declare type CustomRequestHeaders = {
|
|
|
819
821
|
*/
|
|
820
822
|
headers: WebRequestHeader[];
|
|
821
823
|
};
|
|
822
|
-
export
|
|
824
|
+
export type WindowOptionDiff = {
|
|
823
825
|
[key in keyof WindowOptions]: {
|
|
824
826
|
oldVal: WindowOptions[key];
|
|
825
827
|
newVal: WindowOptions[key];
|
|
@@ -828,7 +830,7 @@ export declare type WindowOptionDiff = {
|
|
|
828
830
|
/**
|
|
829
831
|
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
|
830
832
|
*/
|
|
831
|
-
export
|
|
833
|
+
export type ResizeRegion = {
|
|
832
834
|
/**
|
|
833
835
|
* @defaultValue 7
|
|
834
836
|
*
|
|
@@ -874,7 +876,7 @@ export declare type ResizeRegion = {
|
|
|
874
876
|
/**
|
|
875
877
|
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
876
878
|
*/
|
|
877
|
-
export
|
|
879
|
+
export type Accelerator = {
|
|
878
880
|
/**
|
|
879
881
|
* If `true`, enables the devtools keyboard shortcut:<br>
|
|
880
882
|
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
|
@@ -911,7 +913,7 @@ export declare type Accelerator = {
|
|
|
911
913
|
/**
|
|
912
914
|
* Configurations for API injection.
|
|
913
915
|
*/
|
|
914
|
-
export
|
|
916
|
+
export type Api = {
|
|
915
917
|
/**
|
|
916
918
|
* Configure injection of OpenFin API into iframes based on domain
|
|
917
919
|
*/
|
|
@@ -932,7 +934,7 @@ export declare type Api = {
|
|
|
932
934
|
* In the lack of a whitelist, navigation to URLs that match a blacklisted pattern would be prohibited.
|
|
933
935
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
934
936
|
*/
|
|
935
|
-
export
|
|
937
|
+
export type ContentNavigation = {
|
|
936
938
|
/**
|
|
937
939
|
* Allowed URLs for navigation.
|
|
938
940
|
*/
|
|
@@ -947,7 +949,7 @@ export declare type ContentNavigation = {
|
|
|
947
949
|
* In the lack of a whitelist, redirects to URLs that match a blacklisted pattern would be prohibited.
|
|
948
950
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
949
951
|
*/
|
|
950
|
-
export
|
|
952
|
+
export type ContentRedirect = {
|
|
951
953
|
/**
|
|
952
954
|
* Allowed URLs for redirects.
|
|
953
955
|
*/
|
|
@@ -961,7 +963,7 @@ export declare type ContentRedirect = {
|
|
|
961
963
|
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
|
962
964
|
* average of _height_ and _width_.
|
|
963
965
|
*/
|
|
964
|
-
export
|
|
966
|
+
export type CornerRounding = {
|
|
965
967
|
/**
|
|
966
968
|
* @defaultValue 0
|
|
967
969
|
*
|
|
@@ -978,7 +980,7 @@ export declare type CornerRounding = {
|
|
|
978
980
|
/**
|
|
979
981
|
* Options for downloading a preload script.
|
|
980
982
|
*/
|
|
981
|
-
export
|
|
983
|
+
export type DownloadPreloadOption = {
|
|
982
984
|
/**
|
|
983
985
|
* URL from which to download the preload script.
|
|
984
986
|
*/
|
|
@@ -987,7 +989,7 @@ export declare type DownloadPreloadOption = {
|
|
|
987
989
|
/**
|
|
988
990
|
* Metadata returned from a preload script download request.
|
|
989
991
|
*/
|
|
990
|
-
export
|
|
992
|
+
export type DownloadPreloadInfo = {
|
|
991
993
|
/**
|
|
992
994
|
* Whether the download was successful.
|
|
993
995
|
*/
|
|
@@ -1001,7 +1003,7 @@ export declare type DownloadPreloadInfo = {
|
|
|
1001
1003
|
*/
|
|
1002
1004
|
error: string;
|
|
1003
1005
|
};
|
|
1004
|
-
export
|
|
1006
|
+
export type RGB = {
|
|
1005
1007
|
red: number;
|
|
1006
1008
|
blue: number;
|
|
1007
1009
|
green: number;
|
|
@@ -1010,7 +1012,7 @@ export declare type RGB = {
|
|
|
1010
1012
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
1011
1013
|
* Configure the context menu when right-clicking on a window.
|
|
1012
1014
|
*/
|
|
1013
|
-
export
|
|
1015
|
+
export type ContextMenuSettings = {
|
|
1014
1016
|
/**
|
|
1015
1017
|
* Should the context menu display on right click.
|
|
1016
1018
|
*/
|
|
@@ -1027,7 +1029,7 @@ export declare type ContextMenuSettings = {
|
|
|
1027
1029
|
/**
|
|
1028
1030
|
* A hotkey binding.
|
|
1029
1031
|
*/
|
|
1030
|
-
export
|
|
1032
|
+
export type Hotkey = {
|
|
1031
1033
|
/**
|
|
1032
1034
|
* The key combination of the hotkey, i.e. "Ctrl+T".
|
|
1033
1035
|
*/
|
|
@@ -1039,13 +1041,13 @@ export declare type Hotkey = {
|
|
|
1039
1041
|
*/
|
|
1040
1042
|
preventDefault?: boolean;
|
|
1041
1043
|
};
|
|
1042
|
-
export
|
|
1044
|
+
export type ShortcutOverride = Hotkey & {
|
|
1043
1045
|
command: string;
|
|
1044
1046
|
};
|
|
1045
1047
|
/**
|
|
1046
1048
|
* A script that is run before page load.
|
|
1047
1049
|
*/
|
|
1048
|
-
export
|
|
1050
|
+
export type PreloadScript = {
|
|
1049
1051
|
/**
|
|
1050
1052
|
* @defaultValue false
|
|
1051
1053
|
*
|
|
@@ -1061,7 +1063,7 @@ export declare type PreloadScript = {
|
|
|
1061
1063
|
*/
|
|
1062
1064
|
url: string;
|
|
1063
1065
|
};
|
|
1064
|
-
export
|
|
1066
|
+
export type AutoResizeOptions = {
|
|
1065
1067
|
/**
|
|
1066
1068
|
* If true, the view's width will grow and shrink together with the window. false
|
|
1067
1069
|
* by default.
|
|
@@ -1083,7 +1085,7 @@ export declare type AutoResizeOptions = {
|
|
|
1083
1085
|
*/
|
|
1084
1086
|
vertical?: boolean;
|
|
1085
1087
|
};
|
|
1086
|
-
export
|
|
1088
|
+
export type InteropConfig = {
|
|
1087
1089
|
/**
|
|
1088
1090
|
* Context Group for the client. (green, yellow, red, etc.).
|
|
1089
1091
|
*/
|
|
@@ -1093,7 +1095,7 @@ export declare type InteropConfig = {
|
|
|
1093
1095
|
*/
|
|
1094
1096
|
providerId?: string;
|
|
1095
1097
|
};
|
|
1096
|
-
export
|
|
1098
|
+
export type ViewInfo = {
|
|
1097
1099
|
canNavigateBack: boolean;
|
|
1098
1100
|
canNavigateForward: boolean;
|
|
1099
1101
|
processAffinity: string;
|
|
@@ -1104,19 +1106,19 @@ export declare type ViewInfo = {
|
|
|
1104
1106
|
/**
|
|
1105
1107
|
* View options that can be updated after creation.
|
|
1106
1108
|
*/
|
|
1107
|
-
export
|
|
1109
|
+
export type UpdatableViewOptions = Partial<MutableViewOptions>;
|
|
1108
1110
|
/**
|
|
1109
1111
|
* The options object required by {@link View.create View.create}.
|
|
1110
1112
|
*
|
|
1111
1113
|
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
|
1112
1114
|
* (defaults to `"about:blank"` when omitted).
|
|
1113
1115
|
*/
|
|
1114
|
-
export
|
|
1116
|
+
export type ViewCreationOptions = Partial<ViewOptions> & {
|
|
1115
1117
|
name: string;
|
|
1116
1118
|
url: string;
|
|
1117
1119
|
target: Identity;
|
|
1118
1120
|
};
|
|
1119
|
-
export
|
|
1121
|
+
export type MutableViewOptions = {
|
|
1120
1122
|
autoResize: AutoResizeOptions;
|
|
1121
1123
|
/**
|
|
1122
1124
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
@@ -1195,11 +1197,11 @@ export declare type MutableViewOptions = {
|
|
|
1195
1197
|
/**
|
|
1196
1198
|
* User-facing options for a view.
|
|
1197
1199
|
*/
|
|
1198
|
-
export
|
|
1200
|
+
export type ViewOptions = ConstViewOptions & MutableViewOptions;
|
|
1199
1201
|
/**
|
|
1200
1202
|
* View options that cannot be updated after creation.
|
|
1201
1203
|
*/
|
|
1202
|
-
export
|
|
1204
|
+
export type ConstViewOptions = {
|
|
1203
1205
|
/**
|
|
1204
1206
|
* The name of the view.
|
|
1205
1207
|
*/
|
|
@@ -1257,13 +1259,13 @@ export declare type ConstViewOptions = {
|
|
|
1257
1259
|
accelerator?: Partial<Accelerator>;
|
|
1258
1260
|
autoplayPolicy: AutoplayPolicyOptions;
|
|
1259
1261
|
};
|
|
1260
|
-
export
|
|
1262
|
+
export type ViewState = ViewCreationOptions & {
|
|
1261
1263
|
backgroundThrottling: boolean;
|
|
1262
1264
|
componentName: 'view';
|
|
1263
1265
|
initialUrl: string;
|
|
1264
1266
|
minWidth?: number;
|
|
1265
1267
|
};
|
|
1266
|
-
export
|
|
1268
|
+
export type Certificate = {
|
|
1267
1269
|
data: string;
|
|
1268
1270
|
fingerprint: string;
|
|
1269
1271
|
issuer: CertificatePrincipal;
|
|
@@ -1275,7 +1277,7 @@ export declare type Certificate = {
|
|
|
1275
1277
|
validExpiry: number;
|
|
1276
1278
|
validStart: number;
|
|
1277
1279
|
};
|
|
1278
|
-
|
|
1280
|
+
type CertificatePrincipal = {
|
|
1279
1281
|
commonName: string;
|
|
1280
1282
|
country: string;
|
|
1281
1283
|
locality: string;
|
|
@@ -1283,7 +1285,7 @@ declare type CertificatePrincipal = {
|
|
|
1283
1285
|
organizationUnits: string[];
|
|
1284
1286
|
state: string;
|
|
1285
1287
|
};
|
|
1286
|
-
export
|
|
1288
|
+
export type HostContextChangedPayload = {
|
|
1287
1289
|
/**
|
|
1288
1290
|
* The new context object
|
|
1289
1291
|
*/
|
|
@@ -1293,7 +1295,7 @@ export declare type HostContextChangedPayload = {
|
|
|
1293
1295
|
*/
|
|
1294
1296
|
reason: HostContextChangedReasons;
|
|
1295
1297
|
};
|
|
1296
|
-
export
|
|
1298
|
+
export type ApplySnapshotOptions = {
|
|
1297
1299
|
/**
|
|
1298
1300
|
* @defaultValue false
|
|
1299
1301
|
*
|
|
@@ -1320,7 +1322,7 @@ export declare type ApplySnapshotOptions = {
|
|
|
1320
1322
|
/**
|
|
1321
1323
|
* Payload sent to Platform Provider when {@link Platform#applySnapshot Platform.applySnapshot} is called.
|
|
1322
1324
|
*/
|
|
1323
|
-
export
|
|
1325
|
+
export type ApplySnapshotPayload = {
|
|
1324
1326
|
/**
|
|
1325
1327
|
* TThe snapshot to be applied.
|
|
1326
1328
|
*/
|
|
@@ -1330,7 +1332,23 @@ export declare type ApplySnapshotPayload = {
|
|
|
1330
1332
|
*/
|
|
1331
1333
|
options?: ApplySnapshotOptions;
|
|
1332
1334
|
};
|
|
1333
|
-
export
|
|
1335
|
+
export type AddViewToStackOptions = {
|
|
1336
|
+
/**
|
|
1337
|
+
* Optional index within the stack to insert the view. Defaults to 0
|
|
1338
|
+
*/
|
|
1339
|
+
index?: number;
|
|
1340
|
+
};
|
|
1341
|
+
export type CreateViewTarget = Identity & {
|
|
1342
|
+
/**
|
|
1343
|
+
* If specified, view creation will not attach to a window and caller must
|
|
1344
|
+
* insert the view into the layout explicitly
|
|
1345
|
+
*/
|
|
1346
|
+
location?: {
|
|
1347
|
+
id: string;
|
|
1348
|
+
index?: number;
|
|
1349
|
+
};
|
|
1350
|
+
};
|
|
1351
|
+
export type CreateViewPayload = {
|
|
1334
1352
|
/**
|
|
1335
1353
|
* Options for the view to be added.
|
|
1336
1354
|
*/
|
|
@@ -1338,35 +1356,35 @@ export declare type CreateViewPayload = {
|
|
|
1338
1356
|
/**
|
|
1339
1357
|
* Window the view will be added to. If no target is provided, a new window will be created.
|
|
1340
1358
|
*/
|
|
1341
|
-
target
|
|
1359
|
+
target?: CreateViewTarget;
|
|
1342
1360
|
targetView?: Identity;
|
|
1343
1361
|
};
|
|
1344
|
-
export
|
|
1362
|
+
export type ReplaceViewPayload = {
|
|
1345
1363
|
opts: {
|
|
1346
1364
|
viewToReplace: Identity;
|
|
1347
1365
|
newView: Partial<ViewOptions>;
|
|
1348
1366
|
};
|
|
1349
1367
|
target: Identity;
|
|
1350
1368
|
};
|
|
1351
|
-
export
|
|
1369
|
+
export type CloseViewPayload = {
|
|
1352
1370
|
/**
|
|
1353
1371
|
*View to be closed.
|
|
1354
1372
|
*/
|
|
1355
1373
|
view: Identity;
|
|
1356
1374
|
};
|
|
1357
|
-
export
|
|
1375
|
+
export type FetchManifestPayload = {
|
|
1358
1376
|
/**
|
|
1359
1377
|
* The URL of the manifest to fetch.
|
|
1360
1378
|
*/
|
|
1361
1379
|
manifestUrl: string;
|
|
1362
1380
|
};
|
|
1363
|
-
export
|
|
1381
|
+
export type ReplaceLayoutOpts = {
|
|
1364
1382
|
/**
|
|
1365
1383
|
* Layout config to be applied.
|
|
1366
1384
|
*/
|
|
1367
1385
|
layout: LayoutOptions;
|
|
1368
1386
|
};
|
|
1369
|
-
export
|
|
1387
|
+
export type ReplaceLayoutPayload = {
|
|
1370
1388
|
/**
|
|
1371
1389
|
* Object containing the layout to be applied.
|
|
1372
1390
|
*/
|
|
@@ -1376,7 +1394,7 @@ export declare type ReplaceLayoutPayload = {
|
|
|
1376
1394
|
*/
|
|
1377
1395
|
target: Identity;
|
|
1378
1396
|
};
|
|
1379
|
-
export
|
|
1397
|
+
export type SetWindowContextPayload = {
|
|
1380
1398
|
/**
|
|
1381
1399
|
* The requested context update.
|
|
1382
1400
|
*/
|
|
@@ -1390,10 +1408,10 @@ export declare type SetWindowContextPayload = {
|
|
|
1390
1408
|
*/
|
|
1391
1409
|
target: Identity;
|
|
1392
1410
|
};
|
|
1393
|
-
export
|
|
1411
|
+
export type LaunchIntoPlatformPayload = {
|
|
1394
1412
|
manifest: any;
|
|
1395
1413
|
};
|
|
1396
|
-
export
|
|
1414
|
+
export type GetWindowContextPayload = {
|
|
1397
1415
|
/**
|
|
1398
1416
|
* Entity type of the target of the context update ('view' or 'window').
|
|
1399
1417
|
*/
|
|
@@ -1403,14 +1421,14 @@ export declare type GetWindowContextPayload = {
|
|
|
1403
1421
|
*/
|
|
1404
1422
|
target: Identity;
|
|
1405
1423
|
};
|
|
1406
|
-
export
|
|
1424
|
+
export type ApplicationPermissions = {
|
|
1407
1425
|
setFileDownloadLocation: boolean;
|
|
1408
1426
|
};
|
|
1409
|
-
export
|
|
1427
|
+
export type LaunchExternalProcessRule = {
|
|
1410
1428
|
behavior: 'allow' | 'block';
|
|
1411
1429
|
match: string[];
|
|
1412
1430
|
};
|
|
1413
|
-
export
|
|
1431
|
+
export type SystemPermissions = {
|
|
1414
1432
|
getAllExternalWindows: boolean;
|
|
1415
1433
|
launchExternalProcess: boolean | {
|
|
1416
1434
|
enabled: boolean;
|
|
@@ -1436,13 +1454,13 @@ export declare type SystemPermissions = {
|
|
|
1436
1454
|
protocols: string[];
|
|
1437
1455
|
};
|
|
1438
1456
|
};
|
|
1439
|
-
export
|
|
1440
|
-
export
|
|
1457
|
+
export type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write';
|
|
1458
|
+
export type Permissions = {
|
|
1441
1459
|
Application?: Partial<ApplicationPermissions>;
|
|
1442
1460
|
System?: Partial<SystemPermissions>;
|
|
1443
1461
|
webAPIs?: WebPermission[];
|
|
1444
1462
|
};
|
|
1445
|
-
export
|
|
1463
|
+
export type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
|
|
1446
1464
|
updateStateIfExists?: boolean;
|
|
1447
1465
|
reason?: WindowCreationReason;
|
|
1448
1466
|
};
|
|
@@ -1452,7 +1470,7 @@ export declare type PlatformWindowCreationOptions = Partial<WindowCreationOption
|
|
|
1452
1470
|
* used by default in any window that is created in the current platform's scope.
|
|
1453
1471
|
* Individual window options will override these defaults.
|
|
1454
1472
|
*/
|
|
1455
|
-
export
|
|
1473
|
+
export type PlatformWindowOptions = WindowCreationOptions & {
|
|
1456
1474
|
/**
|
|
1457
1475
|
* Specify a path of a custom CSS file to be injected to all of the platform's windows.
|
|
1458
1476
|
* _note_: this option is only applied to windows that use the Default OpenFin Window.
|
|
@@ -1460,22 +1478,19 @@ export declare type PlatformWindowOptions = WindowCreationOptions & {
|
|
|
1460
1478
|
*/
|
|
1461
1479
|
stylesheetUrl: string;
|
|
1462
1480
|
};
|
|
1463
|
-
export
|
|
1464
|
-
url: string;
|
|
1465
|
-
target: Identity;
|
|
1466
|
-
};
|
|
1481
|
+
export type PlatformViewCreationOptions = Partial<ViewOptions>;
|
|
1467
1482
|
/**
|
|
1468
1483
|
* Strategy to assign views to process affinity by domain.
|
|
1469
1484
|
*
|
|
1470
1485
|
* `same`: views in the same domain will have the same process affinity.
|
|
1471
1486
|
* `different`: views in the same domain will have different process affinities.
|
|
1472
1487
|
*/
|
|
1473
|
-
export
|
|
1488
|
+
export type ProcessAffinityStrategy = 'same' | 'different';
|
|
1474
1489
|
/**
|
|
1475
1490
|
* The options object required by {@link Platform#start Platform.start}
|
|
1476
1491
|
* Any {@link ApplicationOptions Application option} is also a valid platform option
|
|
1477
1492
|
*/
|
|
1478
|
-
export
|
|
1493
|
+
export type PlatformOptions = ApplicationCreationOptions & {
|
|
1479
1494
|
/**
|
|
1480
1495
|
* Default window options apply to all platform windows.
|
|
1481
1496
|
*/
|
|
@@ -1492,7 +1507,7 @@ export declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
1492
1507
|
providerUrl?: string;
|
|
1493
1508
|
permissions?: Partial<Permissions>;
|
|
1494
1509
|
};
|
|
1495
|
-
export
|
|
1510
|
+
export type Manifest = {
|
|
1496
1511
|
appAssets?: {
|
|
1497
1512
|
alias: string;
|
|
1498
1513
|
args?: string;
|
|
@@ -1548,13 +1563,13 @@ export declare type Manifest = {
|
|
|
1548
1563
|
};
|
|
1549
1564
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1550
1565
|
};
|
|
1551
|
-
export
|
|
1566
|
+
export type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
|
1552
1567
|
/**
|
|
1553
1568
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
|
1554
1569
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
|
|
1555
1570
|
* {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }..
|
|
1556
1571
|
*/
|
|
1557
|
-
export
|
|
1572
|
+
export type LayoutItemConfig = {
|
|
1558
1573
|
/**
|
|
1559
1574
|
* The type of the item. Possible values are 'row', 'column', 'stack', and 'component'.
|
|
1560
1575
|
*/
|
|
@@ -1579,7 +1594,7 @@ export interface LayoutComponent extends LayoutItemConfig {
|
|
|
1579
1594
|
componentName: 'view';
|
|
1580
1595
|
componentState?: Partial<ViewCreationOptions>;
|
|
1581
1596
|
}
|
|
1582
|
-
export
|
|
1597
|
+
export type LayoutOptions = {
|
|
1583
1598
|
/**
|
|
1584
1599
|
* Represents a potential ways to customize behavior of your Layout
|
|
1585
1600
|
*/
|
|
@@ -1656,18 +1671,18 @@ export declare type LayoutOptions = {
|
|
|
1656
1671
|
headerHeight?: number;
|
|
1657
1672
|
};
|
|
1658
1673
|
};
|
|
1659
|
-
export
|
|
1660
|
-
export
|
|
1661
|
-
export
|
|
1662
|
-
export
|
|
1663
|
-
export
|
|
1674
|
+
export type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
1675
|
+
export type Constructor<T = {}> = new () => T;
|
|
1676
|
+
export type HostContextChangedReasons = 'updated' | 'reparented';
|
|
1677
|
+
export type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
|
1678
|
+
export type InitPlatformOptions = {
|
|
1664
1679
|
overrideCallback?: OverrideCallback<PlatformProvider>;
|
|
1665
1680
|
/**
|
|
1666
1681
|
* A callback function that can be used to extend or replace default Provider behavior.
|
|
1667
1682
|
*/
|
|
1668
1683
|
interopOverride?: OverrideCallback<InteropBroker>;
|
|
1669
1684
|
};
|
|
1670
|
-
export
|
|
1685
|
+
export type ProcessDetails = {
|
|
1671
1686
|
/**
|
|
1672
1687
|
* The percentage of total CPU usage.
|
|
1673
1688
|
*/
|
|
@@ -1711,7 +1726,7 @@ export declare type ProcessDetails = {
|
|
|
1711
1726
|
*/
|
|
1712
1727
|
pid: number;
|
|
1713
1728
|
};
|
|
1714
|
-
export
|
|
1729
|
+
export type FrameProcessDetails = ProcessDetails & {
|
|
1715
1730
|
/**
|
|
1716
1731
|
* Current URL associated with the process.
|
|
1717
1732
|
*/
|
|
@@ -1721,12 +1736,12 @@ export declare type FrameProcessDetails = ProcessDetails & {
|
|
|
1721
1736
|
*/
|
|
1722
1737
|
entityType: string;
|
|
1723
1738
|
};
|
|
1724
|
-
export
|
|
1739
|
+
export type EntityProcessDetails = FrameProcessDetails & {
|
|
1725
1740
|
name: string;
|
|
1726
1741
|
uuid: string;
|
|
1727
1742
|
iframes: FrameProcessDetails[];
|
|
1728
1743
|
};
|
|
1729
|
-
export
|
|
1744
|
+
export type AppProcessInfo = {
|
|
1730
1745
|
/**
|
|
1731
1746
|
* The uuid of the application.
|
|
1732
1747
|
*/
|
|
@@ -1736,15 +1751,15 @@ export declare type AppProcessInfo = {
|
|
|
1736
1751
|
*/
|
|
1737
1752
|
entities: EntityProcessDetails[];
|
|
1738
1753
|
};
|
|
1739
|
-
export
|
|
1754
|
+
export type NonAppProcessDetails = ProcessDetails & {
|
|
1740
1755
|
name: string;
|
|
1741
1756
|
};
|
|
1742
|
-
export
|
|
1757
|
+
export type SystemProcessInfo = {
|
|
1743
1758
|
apps: AppProcessInfo[];
|
|
1744
1759
|
browserProcess: NonAppProcessDetails;
|
|
1745
1760
|
nonApps: NonAppProcessDetails[];
|
|
1746
1761
|
};
|
|
1747
|
-
export
|
|
1762
|
+
export type ClearCacheOption = {
|
|
1748
1763
|
/**
|
|
1749
1764
|
* html5 application cache
|
|
1750
1765
|
*/
|
|
@@ -1762,29 +1777,29 @@ export declare type ClearCacheOption = {
|
|
|
1762
1777
|
*/
|
|
1763
1778
|
localStorage?: boolean;
|
|
1764
1779
|
};
|
|
1765
|
-
export
|
|
1780
|
+
export type CookieInfo = {
|
|
1766
1781
|
name: string;
|
|
1767
1782
|
domain: string;
|
|
1768
1783
|
path: string;
|
|
1769
1784
|
};
|
|
1770
|
-
export
|
|
1785
|
+
export type CookieOption = {
|
|
1771
1786
|
name: string;
|
|
1772
1787
|
};
|
|
1773
|
-
export
|
|
1788
|
+
export type CrashReporterOptions = {
|
|
1774
1789
|
/**
|
|
1775
1790
|
* In diagnostics mode the crash reporter will send diagnostic logs to
|
|
1776
1791
|
* the OpenFin reporting service on runtime shutdown
|
|
1777
1792
|
*/
|
|
1778
1793
|
diagnosticsMode: boolean;
|
|
1779
1794
|
};
|
|
1780
|
-
export
|
|
1795
|
+
export type CrashReporterState = CrashReporterOptions & {
|
|
1781
1796
|
/**
|
|
1782
1797
|
* Whether the crash reporter is running
|
|
1783
1798
|
*/
|
|
1784
1799
|
isRunning: boolean;
|
|
1785
1800
|
diagnosticMode: boolean;
|
|
1786
1801
|
};
|
|
1787
|
-
export
|
|
1802
|
+
export type Time = {
|
|
1788
1803
|
/**
|
|
1789
1804
|
* The number of milliseconds the CPU has spent in user mode.
|
|
1790
1805
|
*/
|
|
@@ -1806,7 +1821,7 @@ export declare type Time = {
|
|
|
1806
1821
|
*/
|
|
1807
1822
|
irq: number;
|
|
1808
1823
|
};
|
|
1809
|
-
export
|
|
1824
|
+
export type CpuInfo = {
|
|
1810
1825
|
/**
|
|
1811
1826
|
* The model of the cpu
|
|
1812
1827
|
*/
|
|
@@ -1820,10 +1835,10 @@ export declare type CpuInfo = {
|
|
|
1820
1835
|
*/
|
|
1821
1836
|
times: Time;
|
|
1822
1837
|
};
|
|
1823
|
-
export
|
|
1838
|
+
export type GpuInfo = {
|
|
1824
1839
|
name: string;
|
|
1825
1840
|
};
|
|
1826
|
-
export
|
|
1841
|
+
export type HostSpecs = {
|
|
1827
1842
|
/**
|
|
1828
1843
|
* True if Aero Glass theme is supported on Windows platforms
|
|
1829
1844
|
*/
|
|
@@ -1853,7 +1868,7 @@ export declare type HostSpecs = {
|
|
|
1853
1868
|
*/
|
|
1854
1869
|
screenSaver?: boolean;
|
|
1855
1870
|
};
|
|
1856
|
-
export
|
|
1871
|
+
export type PrinterInfo = {
|
|
1857
1872
|
name: string;
|
|
1858
1873
|
description: string;
|
|
1859
1874
|
status: number;
|
|
@@ -1862,7 +1877,7 @@ export declare type PrinterInfo = {
|
|
|
1862
1877
|
/**
|
|
1863
1878
|
* DPI (dots per inch) configuration for printing.
|
|
1864
1879
|
*/
|
|
1865
|
-
export
|
|
1880
|
+
export type Dpi = {
|
|
1866
1881
|
/**
|
|
1867
1882
|
* DPI (dots per inch) in the horizontal direction.
|
|
1868
1883
|
*/
|
|
@@ -1875,7 +1890,7 @@ export declare type Dpi = {
|
|
|
1875
1890
|
/**
|
|
1876
1891
|
* Margins configuration for printing.
|
|
1877
1892
|
*/
|
|
1878
|
-
export
|
|
1893
|
+
export type Margins = {
|
|
1879
1894
|
marginType?: 'default' | 'none' | 'printableArea' | 'custom';
|
|
1880
1895
|
/**
|
|
1881
1896
|
* The top margin of the printed webpage, in pixels.
|
|
@@ -1897,7 +1912,7 @@ export declare type Margins = {
|
|
|
1897
1912
|
/**
|
|
1898
1913
|
* Options for printing a webpage in OpenFin.
|
|
1899
1914
|
*/
|
|
1900
|
-
export
|
|
1915
|
+
export type PrintOptions = {
|
|
1901
1916
|
/**
|
|
1902
1917
|
* Disables prompting the user for print settings.
|
|
1903
1918
|
*/
|
|
@@ -1954,7 +1969,7 @@ export declare type PrintOptions = {
|
|
|
1954
1969
|
/**
|
|
1955
1970
|
* A request to write data to the clipboard.
|
|
1956
1971
|
*/
|
|
1957
|
-
export
|
|
1972
|
+
export type WriteRequestType = {
|
|
1958
1973
|
/**
|
|
1959
1974
|
* Data to write to the clipboard.
|
|
1960
1975
|
*/
|
|
@@ -1964,7 +1979,7 @@ export declare type WriteRequestType = {
|
|
|
1964
1979
|
*/
|
|
1965
1980
|
type?: string;
|
|
1966
1981
|
};
|
|
1967
|
-
export
|
|
1982
|
+
export type WriteAnyRequestType = {
|
|
1968
1983
|
data: {
|
|
1969
1984
|
text?: string;
|
|
1970
1985
|
html?: string;
|
|
@@ -1972,30 +1987,30 @@ export declare type WriteAnyRequestType = {
|
|
|
1972
1987
|
};
|
|
1973
1988
|
type?: string;
|
|
1974
1989
|
};
|
|
1975
|
-
export
|
|
1990
|
+
export type SubscriptionOptions = {
|
|
1976
1991
|
/**
|
|
1977
1992
|
* The event timestamp.
|
|
1978
1993
|
*/
|
|
1979
1994
|
timestamp?: number;
|
|
1980
1995
|
};
|
|
1981
|
-
export
|
|
1996
|
+
export type SharedWorkerInfo = {
|
|
1982
1997
|
id: string;
|
|
1983
1998
|
url: string;
|
|
1984
1999
|
};
|
|
1985
|
-
export
|
|
2000
|
+
export type ServiceIdentifier = {
|
|
1986
2001
|
/**
|
|
1987
2002
|
* The name of the service.
|
|
1988
2003
|
*/
|
|
1989
2004
|
name: string;
|
|
1990
2005
|
};
|
|
1991
|
-
export
|
|
2006
|
+
export type ServiceConfiguration = {
|
|
1992
2007
|
config: object;
|
|
1993
2008
|
/**
|
|
1994
2009
|
* The name of the service.
|
|
1995
2010
|
*/
|
|
1996
2011
|
name: string;
|
|
1997
2012
|
};
|
|
1998
|
-
export
|
|
2013
|
+
export type RVMInfo = {
|
|
1999
2014
|
/**
|
|
2000
2015
|
* The name of action: "get-rvm-info".
|
|
2001
2016
|
*/
|
|
@@ -2021,15 +2036,15 @@ export declare type RVMInfo = {
|
|
|
2021
2036
|
*/
|
|
2022
2037
|
'working-dir': string;
|
|
2023
2038
|
};
|
|
2024
|
-
export
|
|
2039
|
+
export type AppVersionProgress = {
|
|
2025
2040
|
manifest: string | null;
|
|
2026
2041
|
srcManifest: string;
|
|
2027
2042
|
};
|
|
2028
|
-
export
|
|
2043
|
+
export type AppVersionError = {
|
|
2029
2044
|
error: string;
|
|
2030
2045
|
srcManifest: string;
|
|
2031
2046
|
};
|
|
2032
|
-
export
|
|
2047
|
+
export type AppVersionRuntimeInfo = {
|
|
2033
2048
|
version: string | null;
|
|
2034
2049
|
exists: boolean | null;
|
|
2035
2050
|
writeAccess: boolean | null;
|
|
@@ -2037,8 +2052,8 @@ export declare type AppVersionRuntimeInfo = {
|
|
|
2037
2052
|
healthCheck: boolean | null;
|
|
2038
2053
|
error: string | null;
|
|
2039
2054
|
};
|
|
2040
|
-
export
|
|
2041
|
-
export
|
|
2055
|
+
export type LaunchEmitter = TypedEventEmitter<AppVersionEvent>;
|
|
2056
|
+
export type RvmLaunchOptions = {
|
|
2042
2057
|
/**
|
|
2043
2058
|
* True if no UI when launching
|
|
2044
2059
|
*/
|
|
@@ -2053,7 +2068,7 @@ export declare type RvmLaunchOptions = {
|
|
|
2053
2068
|
*/
|
|
2054
2069
|
subscribe?: (launch: LaunchEmitter) => void;
|
|
2055
2070
|
};
|
|
2056
|
-
export
|
|
2071
|
+
export type ShortCutConfig = {
|
|
2057
2072
|
/**
|
|
2058
2073
|
* True if application has a shortcut on the desktop.
|
|
2059
2074
|
*/
|
|
@@ -2067,7 +2082,7 @@ export declare type ShortCutConfig = {
|
|
|
2067
2082
|
*/
|
|
2068
2083
|
systemStartup?: boolean;
|
|
2069
2084
|
};
|
|
2070
|
-
export
|
|
2085
|
+
export type TerminateExternalRequestType = {
|
|
2071
2086
|
/**
|
|
2072
2087
|
* The uuid of the running application.
|
|
2073
2088
|
*/
|
|
@@ -2081,7 +2096,7 @@ export declare type TerminateExternalRequestType = {
|
|
|
2081
2096
|
*/
|
|
2082
2097
|
killTree: boolean;
|
|
2083
2098
|
};
|
|
2084
|
-
export
|
|
2099
|
+
export type TrayInfo = {
|
|
2085
2100
|
/**
|
|
2086
2101
|
* The bound of tray icon in virtual screen pixels.
|
|
2087
2102
|
*/
|
|
@@ -2099,12 +2114,12 @@ export declare type TrayInfo = {
|
|
|
2099
2114
|
*/
|
|
2100
2115
|
y: number;
|
|
2101
2116
|
};
|
|
2102
|
-
export
|
|
2117
|
+
export type Transition = {
|
|
2103
2118
|
opacity?: Opacity;
|
|
2104
2119
|
position?: Position;
|
|
2105
2120
|
size?: Size;
|
|
2106
2121
|
};
|
|
2107
|
-
export
|
|
2122
|
+
export type Size = TransitionBase & {
|
|
2108
2123
|
/**
|
|
2109
2124
|
* Optional if height is present. Defaults to the window's current width.
|
|
2110
2125
|
*/
|
|
@@ -2114,7 +2129,7 @@ export declare type Size = TransitionBase & {
|
|
|
2114
2129
|
*/
|
|
2115
2130
|
height: number;
|
|
2116
2131
|
};
|
|
2117
|
-
export
|
|
2132
|
+
export type Opacity = TransitionBase & {
|
|
2118
2133
|
/**
|
|
2119
2134
|
* The opacity from 0.0 (transparent) to 1.0 (normal).
|
|
2120
2135
|
*/
|
|
@@ -2123,7 +2138,7 @@ export declare type Opacity = TransitionBase & {
|
|
|
2123
2138
|
/**
|
|
2124
2139
|
* Base configuration options needed for all types of transitions.
|
|
2125
2140
|
*/
|
|
2126
|
-
export
|
|
2141
|
+
export type TransitionBase = {
|
|
2127
2142
|
/**
|
|
2128
2143
|
* The total time in milliseconds this transition should take.
|
|
2129
2144
|
*/
|
|
@@ -2135,7 +2150,7 @@ export declare type TransitionBase = {
|
|
|
2135
2150
|
*/
|
|
2136
2151
|
relative?: boolean;
|
|
2137
2152
|
};
|
|
2138
|
-
export
|
|
2153
|
+
export type Position = TransitionBase & {
|
|
2139
2154
|
/**
|
|
2140
2155
|
* Defaults to the window's current left position in virtual screen coordinates.
|
|
2141
2156
|
*/
|
|
@@ -2145,11 +2160,11 @@ export declare type Position = TransitionBase & {
|
|
|
2145
2160
|
*/
|
|
2146
2161
|
top: number;
|
|
2147
2162
|
};
|
|
2148
|
-
export
|
|
2163
|
+
export type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
2149
2164
|
/**
|
|
2150
2165
|
* Configuration for transition between windows.
|
|
2151
2166
|
*/
|
|
2152
|
-
export
|
|
2167
|
+
export type TransitionOptions = {
|
|
2153
2168
|
/**
|
|
2154
2169
|
* Interrupts the current animation (otherwise, the animation is added to the end of the queue).
|
|
2155
2170
|
*/
|
|
@@ -2162,11 +2177,11 @@ export declare type TransitionOptions = {
|
|
|
2162
2177
|
relative?: boolean;
|
|
2163
2178
|
tween?: tween;
|
|
2164
2179
|
};
|
|
2165
|
-
export
|
|
2180
|
+
export type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-in-quad' | 'ease-out-quad' | 'ease-in-out-quad' | 'ease-in-cubic' | 'ease-out-cubic' | 'ease-in-out-cubic' | 'ease-out-bounce' | 'ease-in-back' | 'ease-out-back' | 'ease-in-out-back' | 'ease-in-elastic' | 'ease-out-elastic' | 'ease-in-out-elastic';
|
|
2166
2181
|
/**
|
|
2167
2182
|
* Configuration for find-in-page requests.
|
|
2168
2183
|
*/
|
|
2169
|
-
export
|
|
2184
|
+
export type FindInPageOptions = {
|
|
2170
2185
|
/**
|
|
2171
2186
|
* @defaultValue true
|
|
2172
2187
|
*
|
|
@@ -2199,16 +2214,32 @@ export declare type FindInPageOptions = {
|
|
|
2199
2214
|
*/
|
|
2200
2215
|
medialCapitalAsWordStart?: boolean;
|
|
2201
2216
|
};
|
|
2202
|
-
export
|
|
2217
|
+
export type FindInPageResult = {
|
|
2218
|
+
requestId: number;
|
|
2219
|
+
/**
|
|
2220
|
+
* Position of the active match.
|
|
2221
|
+
*/
|
|
2222
|
+
activeMatchOrdinal: number;
|
|
2223
|
+
/**
|
|
2224
|
+
* Number of Matches.
|
|
2225
|
+
*/
|
|
2226
|
+
matches: number;
|
|
2227
|
+
/**
|
|
2228
|
+
* Coordinates of first match region.
|
|
2229
|
+
*/
|
|
2230
|
+
selectionArea: Rectangle;
|
|
2231
|
+
finalUpdate: boolean;
|
|
2232
|
+
};
|
|
2233
|
+
export type FrameInfo = {
|
|
2203
2234
|
name: string;
|
|
2204
2235
|
uuid: string;
|
|
2205
2236
|
entityType: EntityType;
|
|
2206
2237
|
parent: Identity;
|
|
2207
2238
|
};
|
|
2208
|
-
export
|
|
2239
|
+
export type ExternalApplicationInfo = {
|
|
2209
2240
|
parent: Identity;
|
|
2210
2241
|
};
|
|
2211
|
-
export
|
|
2242
|
+
export type ExternalConnection = {
|
|
2212
2243
|
/**
|
|
2213
2244
|
* The token to broker an external connection.
|
|
2214
2245
|
*/
|
|
@@ -2218,7 +2249,7 @@ export declare type ExternalConnection = {
|
|
|
2218
2249
|
*/
|
|
2219
2250
|
uuid: string;
|
|
2220
2251
|
};
|
|
2221
|
-
export
|
|
2252
|
+
export type ExternalProcessRequestType = {
|
|
2222
2253
|
/**
|
|
2223
2254
|
* The file path to where the running application resides.
|
|
2224
2255
|
*/
|
|
@@ -2241,26 +2272,26 @@ export declare type ExternalProcessRequestType = {
|
|
|
2241
2272
|
*/
|
|
2242
2273
|
cwd?: string;
|
|
2243
2274
|
};
|
|
2244
|
-
export
|
|
2275
|
+
export type CertificationInfo = {
|
|
2245
2276
|
serial?: string;
|
|
2246
2277
|
subject?: string;
|
|
2247
2278
|
publickey?: string;
|
|
2248
2279
|
thumbprint?: string;
|
|
2249
2280
|
trusted?: boolean;
|
|
2250
2281
|
};
|
|
2251
|
-
export
|
|
2282
|
+
export type ExitCode = {
|
|
2252
2283
|
topic: string;
|
|
2253
2284
|
uuid: string;
|
|
2254
2285
|
exitCode: number;
|
|
2255
2286
|
};
|
|
2256
|
-
export
|
|
2287
|
+
export type LaunchExternalProcessListener = {
|
|
2257
2288
|
(code: ExitCode): void;
|
|
2258
2289
|
};
|
|
2259
|
-
export
|
|
2290
|
+
export type ExternalProcessInfo = {
|
|
2260
2291
|
pid: number;
|
|
2261
2292
|
listener?: LaunchExternalProcessListener;
|
|
2262
2293
|
};
|
|
2263
|
-
export
|
|
2294
|
+
export type AppAssetInfo = {
|
|
2264
2295
|
/**
|
|
2265
2296
|
* The URL to a zip file containing the package files (executables, dlls, etc…)
|
|
2266
2297
|
*/
|
|
@@ -2290,30 +2321,30 @@ export declare type AppAssetInfo = {
|
|
|
2290
2321
|
/**
|
|
2291
2322
|
* The options object required by the downloadRuntime function.
|
|
2292
2323
|
*/
|
|
2293
|
-
export
|
|
2324
|
+
export type RuntimeDownloadOptions = {
|
|
2294
2325
|
/**
|
|
2295
2326
|
* The given version to download.
|
|
2296
2327
|
*/
|
|
2297
2328
|
version: string;
|
|
2298
2329
|
};
|
|
2299
|
-
export
|
|
2330
|
+
export type AppAssetRequest = {
|
|
2300
2331
|
alias: string;
|
|
2301
2332
|
};
|
|
2302
|
-
export
|
|
2333
|
+
export type RuntimeDownloadProgress = {
|
|
2303
2334
|
/**
|
|
2304
2335
|
* @property { string } alias The name of the asset
|
|
2305
2336
|
*/
|
|
2306
2337
|
downloadedBytes: number;
|
|
2307
2338
|
totalBytes: number;
|
|
2308
2339
|
};
|
|
2309
|
-
export
|
|
2340
|
+
export type CertifiedAppInfo = {
|
|
2310
2341
|
isRunning: boolean;
|
|
2311
2342
|
isOptedIntoCertfiedApp?: boolean;
|
|
2312
2343
|
isCertified?: boolean;
|
|
2313
2344
|
isSSLCertified?: boolean;
|
|
2314
2345
|
isPresentInAppDirectory?: boolean;
|
|
2315
2346
|
};
|
|
2316
|
-
export
|
|
2347
|
+
export type JumpListCategory = {
|
|
2317
2348
|
/**
|
|
2318
2349
|
* The display title for the category.
|
|
2319
2350
|
*
|
|
@@ -2326,8 +2357,8 @@ export declare type JumpListCategory = {
|
|
|
2326
2357
|
*/
|
|
2327
2358
|
items: Array<JumpListTask | JumpListSeparator>;
|
|
2328
2359
|
};
|
|
2329
|
-
export
|
|
2330
|
-
export
|
|
2360
|
+
export type JumpListItem = JumpListTask | JumpListSeparator;
|
|
2361
|
+
export type JumpListTask = {
|
|
2331
2362
|
type: 'task';
|
|
2332
2363
|
/**
|
|
2333
2364
|
* The text to be displayed for the JumpList Item.
|
|
@@ -2354,10 +2385,10 @@ export declare type JumpListTask = {
|
|
|
2354
2385
|
*/
|
|
2355
2386
|
iconIndex?: number;
|
|
2356
2387
|
};
|
|
2357
|
-
export
|
|
2388
|
+
export type JumpListSeparator = {
|
|
2358
2389
|
type: 'separator';
|
|
2359
2390
|
};
|
|
2360
|
-
export
|
|
2391
|
+
export type ApplicationInfo = {
|
|
2361
2392
|
initialOptions: ApplicationCreationOptions;
|
|
2362
2393
|
launchMode: string;
|
|
2363
2394
|
manifest: Manifest & {
|
|
@@ -2369,7 +2400,7 @@ export declare type ApplicationInfo = {
|
|
|
2369
2400
|
version: string;
|
|
2370
2401
|
};
|
|
2371
2402
|
};
|
|
2372
|
-
export
|
|
2403
|
+
export type ManifestInfo = {
|
|
2373
2404
|
/**
|
|
2374
2405
|
* The uuid of the application.
|
|
2375
2406
|
*/
|
|
@@ -2379,20 +2410,20 @@ export declare type ManifestInfo = {
|
|
|
2379
2410
|
*/
|
|
2380
2411
|
manifestUrl: string;
|
|
2381
2412
|
};
|
|
2382
|
-
export
|
|
2413
|
+
export type ClickedMenuResult = {
|
|
2383
2414
|
result: 'clicked';
|
|
2384
2415
|
data: any;
|
|
2385
2416
|
};
|
|
2386
|
-
export
|
|
2417
|
+
export type ClosedMenuResult = {
|
|
2387
2418
|
result: 'closed';
|
|
2388
2419
|
};
|
|
2389
|
-
export
|
|
2390
|
-
export
|
|
2420
|
+
export type MenuResult = ClickedMenuResult | ClosedMenuResult;
|
|
2421
|
+
export type ShowPopupMenuOptions = {
|
|
2391
2422
|
template: MenuItemTemplate[];
|
|
2392
2423
|
x?: number;
|
|
2393
2424
|
y?: number;
|
|
2394
2425
|
};
|
|
2395
|
-
export
|
|
2426
|
+
export type MenuItemTemplate = {
|
|
2396
2427
|
/**
|
|
2397
2428
|
* Can be `normal`, `separator`, `submenu`, or `checkbox`.
|
|
2398
2429
|
* Defaults to 'normal' unless a 'submenu' key exists
|
|
@@ -2426,10 +2457,10 @@ export declare type MenuItemTemplate = {
|
|
|
2426
2457
|
*/
|
|
2427
2458
|
icon?: string;
|
|
2428
2459
|
};
|
|
2429
|
-
export
|
|
2460
|
+
export type NativeWindowIntegrationProviderAuthorization = {
|
|
2430
2461
|
authorizedUuid: string;
|
|
2431
2462
|
};
|
|
2432
|
-
export
|
|
2463
|
+
export type RuntimeInfo = {
|
|
2433
2464
|
/**
|
|
2434
2465
|
* The runtime build architecture.
|
|
2435
2466
|
*/
|
|
@@ -2458,28 +2489,28 @@ export declare type RuntimeInfo = {
|
|
|
2458
2489
|
electronVersion: string;
|
|
2459
2490
|
devtoolsPort?: number;
|
|
2460
2491
|
};
|
|
2461
|
-
export
|
|
2492
|
+
export type DefaultDomainSettings = {
|
|
2462
2493
|
rules: DefaultDomainSettingsRule[];
|
|
2463
2494
|
};
|
|
2464
|
-
export
|
|
2495
|
+
export type DefaultDomainSettingsRule = {
|
|
2465
2496
|
match: string[];
|
|
2466
2497
|
options: {
|
|
2467
2498
|
downloadSettings: FileDownloadSettings;
|
|
2468
2499
|
};
|
|
2469
2500
|
};
|
|
2470
|
-
export
|
|
2471
|
-
export
|
|
2501
|
+
export type FileDownloadBehaviorNames = 'prompt' | 'no-prompt' | 'block';
|
|
2502
|
+
export type FileDownloadSettings = {
|
|
2472
2503
|
rules: DownloadRule[];
|
|
2473
2504
|
};
|
|
2474
|
-
export
|
|
2505
|
+
export type DownloadRule = {
|
|
2475
2506
|
behavior: FileDownloadBehaviorNames;
|
|
2476
2507
|
match: string[];
|
|
2477
2508
|
};
|
|
2478
|
-
export
|
|
2509
|
+
export type ContextHandler = (context: Context) => void;
|
|
2479
2510
|
/**
|
|
2480
2511
|
* Combination of an action and a context that is passed to an application for resolution.
|
|
2481
2512
|
*/
|
|
2482
|
-
export
|
|
2513
|
+
export type Intent<MetadataType = IntentMetadata> = {
|
|
2483
2514
|
/**
|
|
2484
2515
|
* Name of the intent.
|
|
2485
2516
|
*/
|
|
@@ -2490,14 +2521,14 @@ export declare type Intent<MetadataType = IntentMetadata> = {
|
|
|
2490
2521
|
context: Context;
|
|
2491
2522
|
metadata?: MetadataType;
|
|
2492
2523
|
};
|
|
2493
|
-
export
|
|
2524
|
+
export type IntentMetadata<TargetType = any> = {
|
|
2494
2525
|
target?: TargetType;
|
|
2495
2526
|
resultType?: string;
|
|
2496
2527
|
intentResolutionResultId?: string;
|
|
2497
2528
|
};
|
|
2498
|
-
export
|
|
2499
|
-
export
|
|
2500
|
-
export
|
|
2529
|
+
export type IntentHandler = (intent: Intent) => void;
|
|
2530
|
+
export type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
|
|
2531
|
+
export type MatchPattern = string;
|
|
2501
2532
|
/**
|
|
2502
2533
|
* A rule for creating content in OpenFin; maps a content type to the way in which
|
|
2503
2534
|
* newly-opened content of that type will be handled.
|
|
@@ -2506,7 +2537,7 @@ export declare type MatchPattern = string;
|
|
|
2506
2537
|
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
|
2507
2538
|
* @property { object } options Window creation options or View creation options.
|
|
2508
2539
|
*/
|
|
2509
|
-
export
|
|
2540
|
+
export type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
|
2510
2541
|
/**
|
|
2511
2542
|
* Behavior to use when opening matched content.
|
|
2512
2543
|
*/
|
|
@@ -2524,17 +2555,17 @@ export declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
|
|
2524
2555
|
/**
|
|
2525
2556
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
2526
2557
|
*/
|
|
2527
|
-
export
|
|
2558
|
+
export type ContentCreationOptions = {
|
|
2528
2559
|
/**
|
|
2529
2560
|
* List of rules for creation of new content.
|
|
2530
2561
|
*/
|
|
2531
2562
|
rules: ContentCreationRule[];
|
|
2532
2563
|
};
|
|
2533
|
-
export
|
|
2564
|
+
export type SnapshotProvider<T> = {
|
|
2534
2565
|
getSnapshot: () => Promise<T>;
|
|
2535
2566
|
applySnapshot: (snapshot: T) => Promise<void>;
|
|
2536
2567
|
};
|
|
2537
|
-
export
|
|
2568
|
+
export type QueryPermissionResult = {
|
|
2538
2569
|
/**
|
|
2539
2570
|
* The full name of a secured API.
|
|
2540
2571
|
*/
|
|
@@ -2549,7 +2580,7 @@ export declare type QueryPermissionResult = {
|
|
|
2549
2580
|
*/
|
|
2550
2581
|
rawValue?: unknown;
|
|
2551
2582
|
};
|
|
2552
|
-
export
|
|
2583
|
+
export type SessionContextGroup = {
|
|
2553
2584
|
id: string;
|
|
2554
2585
|
setContext: (context: Context) => Promise<void>;
|
|
2555
2586
|
getCurrentContext: (type?: string) => Promise<Context>;
|
|
@@ -2561,7 +2592,7 @@ export type { MessagingProtocols };
|
|
|
2561
2592
|
/**
|
|
2562
2593
|
* Channel provider creation options.
|
|
2563
2594
|
*/
|
|
2564
|
-
export
|
|
2595
|
+
export type ChannelCreateOptions = {
|
|
2565
2596
|
/**
|
|
2566
2597
|
* EXPERIMENTAL: Messaging protocols supported by the channel provider.
|
|
2567
2598
|
*/
|
|
@@ -2571,7 +2602,7 @@ export declare type ChannelCreateOptions = {
|
|
|
2571
2602
|
* Options provided on a client connection to a channel.
|
|
2572
2603
|
*
|
|
2573
2604
|
*/
|
|
2574
|
-
export
|
|
2605
|
+
export type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2575
2606
|
/**
|
|
2576
2607
|
* @defaultValue true
|
|
2577
2608
|
*
|
|
@@ -2583,10 +2614,10 @@ export declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
|
2583
2614
|
*/
|
|
2584
2615
|
payload?: any;
|
|
2585
2616
|
};
|
|
2586
|
-
export
|
|
2617
|
+
export type ContextForIntent<MetadataType = any> = Context & {
|
|
2587
2618
|
metadata?: MetadataType;
|
|
2588
2619
|
};
|
|
2589
|
-
export
|
|
2620
|
+
export type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
|
2590
2621
|
/**
|
|
2591
2622
|
* Name of the intent to get info for.
|
|
2592
2623
|
*/
|
|
@@ -2594,14 +2625,14 @@ export declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
|
|
2594
2625
|
context?: Context;
|
|
2595
2626
|
metadata?: MetadataType;
|
|
2596
2627
|
};
|
|
2597
|
-
export
|
|
2628
|
+
export type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
|
2598
2629
|
context: Context;
|
|
2599
2630
|
metadata?: MetadataType;
|
|
2600
2631
|
};
|
|
2601
2632
|
/**
|
|
2602
2633
|
* Identity of a channel provider.
|
|
2603
2634
|
*/
|
|
2604
|
-
export
|
|
2635
|
+
export type ProviderIdentity = Identity & {
|
|
2605
2636
|
/**
|
|
2606
2637
|
* Identifier of the channel.
|
|
2607
2638
|
*/
|
|
@@ -2611,7 +2642,7 @@ export declare type ProviderIdentity = Identity & {
|
|
|
2611
2642
|
*/
|
|
2612
2643
|
channelName: string;
|
|
2613
2644
|
};
|
|
2614
|
-
export
|
|
2645
|
+
export type RegisterUsageData = {
|
|
2615
2646
|
data: unknown;
|
|
2616
2647
|
type: string;
|
|
2617
2648
|
};
|
|
@@ -2672,11 +2703,11 @@ export interface CloseWindowPayload {
|
|
|
2672
2703
|
skipBeforeUnload?: boolean;
|
|
2673
2704
|
};
|
|
2674
2705
|
}
|
|
2675
|
-
export
|
|
2706
|
+
export type ProxyInfo = {
|
|
2676
2707
|
config: ProxyConfig;
|
|
2677
2708
|
system: ProxySystemInfo;
|
|
2678
2709
|
};
|
|
2679
|
-
export
|
|
2710
|
+
export type ProxyConfig = {
|
|
2680
2711
|
/**
|
|
2681
2712
|
* The configured proxy address.
|
|
2682
2713
|
*/
|
|
@@ -2687,7 +2718,7 @@ export declare type ProxyConfig = {
|
|
|
2687
2718
|
proxyPort: number;
|
|
2688
2719
|
type: string;
|
|
2689
2720
|
};
|
|
2690
|
-
export
|
|
2721
|
+
export type ProxySystemInfo = {
|
|
2691
2722
|
/**
|
|
2692
2723
|
* The auto configuration url.
|
|
2693
2724
|
*/
|
|
@@ -2705,10 +2736,10 @@ export declare type ProxySystemInfo = {
|
|
|
2705
2736
|
*/
|
|
2706
2737
|
proxy: string;
|
|
2707
2738
|
};
|
|
2708
|
-
export
|
|
2709
|
-
export
|
|
2710
|
-
export
|
|
2711
|
-
export
|
|
2739
|
+
export type ChannelAction = (payload: unknown, id: ProviderIdentity | ClientIdentity) => unknown;
|
|
2740
|
+
export type ChannelMiddleware = (topic: string, payload: unknown, senderIdentity: ProviderIdentity | ClientIdentity) => Promise<unknown> | unknown;
|
|
2741
|
+
export type ErrorMiddleware = (topic: string, error: Error, id: ProviderIdentity | ClientIdentity) => unknown;
|
|
2742
|
+
export type ApplicationState = {
|
|
2712
2743
|
/**
|
|
2713
2744
|
* True when the application is a Platform controller
|
|
2714
2745
|
*/
|
|
@@ -2726,13 +2757,13 @@ export declare type ApplicationState = {
|
|
|
2726
2757
|
*/
|
|
2727
2758
|
parentUuid?: string;
|
|
2728
2759
|
};
|
|
2729
|
-
export
|
|
2760
|
+
export type InstalledApps = {
|
|
2730
2761
|
[key: string]: InstallationInfo;
|
|
2731
2762
|
};
|
|
2732
|
-
export
|
|
2763
|
+
export type InstallationInfo = {
|
|
2733
2764
|
cachedManifest: any;
|
|
2734
2765
|
};
|
|
2735
|
-
export
|
|
2766
|
+
export type GetLogRequestType = {
|
|
2736
2767
|
/**
|
|
2737
2768
|
* The name of the running application
|
|
2738
2769
|
*/
|
|
@@ -2746,7 +2777,7 @@ export declare type GetLogRequestType = {
|
|
|
2746
2777
|
*/
|
|
2747
2778
|
sizeLimit?: number;
|
|
2748
2779
|
};
|
|
2749
|
-
export
|
|
2780
|
+
export type LogInfo = {
|
|
2750
2781
|
/**
|
|
2751
2782
|
* The filename of the log
|
|
2752
2783
|
*/
|
|
@@ -2760,7 +2791,7 @@ export declare type LogInfo = {
|
|
|
2760
2791
|
*/
|
|
2761
2792
|
date: string;
|
|
2762
2793
|
};
|
|
2763
|
-
export
|
|
2794
|
+
export type SendApplicationLogResponse = {
|
|
2764
2795
|
logId: string;
|
|
2765
2796
|
};
|
|
2766
2797
|
/**
|
|
@@ -2772,27 +2803,27 @@ export declare type SendApplicationLogResponse = {
|
|
|
2772
2803
|
* `error` and above
|
|
2773
2804
|
* `fatal`: fatal only, indicates a crash is imminent
|
|
2774
2805
|
*/
|
|
2775
|
-
export
|
|
2776
|
-
export
|
|
2777
|
-
export
|
|
2806
|
+
export type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
2807
|
+
export type PermissionState = 'granted' | 'denied' | 'unavailable';
|
|
2808
|
+
export type RegistryInfo = {
|
|
2778
2809
|
data: any;
|
|
2779
2810
|
rootKey: string;
|
|
2780
2811
|
subkey: string;
|
|
2781
2812
|
type: string;
|
|
2782
2813
|
value: string;
|
|
2783
2814
|
};
|
|
2784
|
-
export
|
|
2815
|
+
export type ApplicationType = {
|
|
2785
2816
|
type: 'application' | 'external-app';
|
|
2786
2817
|
uuid: string;
|
|
2787
2818
|
};
|
|
2788
|
-
export
|
|
2819
|
+
export type WindowInfo = {
|
|
2789
2820
|
canNavigateBack: boolean;
|
|
2790
2821
|
canNavigateForward: boolean;
|
|
2791
2822
|
preloadScripts: Array<any>;
|
|
2792
2823
|
title: string;
|
|
2793
2824
|
url: string;
|
|
2794
2825
|
};
|
|
2795
|
-
export
|
|
2826
|
+
export type ApplicationWindowInfo = {
|
|
2796
2827
|
childWindows: Array<WindowDetail>;
|
|
2797
2828
|
mainWindow: WindowDetail;
|
|
2798
2829
|
/**
|
|
@@ -2800,7 +2831,7 @@ export declare type ApplicationWindowInfo = {
|
|
|
2800
2831
|
*/
|
|
2801
2832
|
uuid: string;
|
|
2802
2833
|
};
|
|
2803
|
-
export
|
|
2834
|
+
export type WindowDetail = {
|
|
2804
2835
|
/**
|
|
2805
2836
|
* The bottom-most coordinate of the window.
|
|
2806
2837
|
*/
|
|
@@ -2832,26 +2863,26 @@ export declare type WindowDetail = {
|
|
|
2832
2863
|
*/
|
|
2833
2864
|
width: number;
|
|
2834
2865
|
};
|
|
2835
|
-
export
|
|
2836
|
-
export
|
|
2866
|
+
export type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
2867
|
+
export type InitLayoutOptions = {
|
|
2837
2868
|
/**
|
|
2838
2869
|
* The id attribute of the container where the window's Layout should be initialized. If not provided
|
|
2839
2870
|
* then an element with id `layout-container` is used. We recommend using a div element.
|
|
2840
2871
|
*/
|
|
2841
2872
|
containerId?: string;
|
|
2842
2873
|
};
|
|
2843
|
-
export
|
|
2874
|
+
export type PresetLayoutOptions = {
|
|
2844
2875
|
/**
|
|
2845
2876
|
* Which preset layout arrangement to use.
|
|
2846
2877
|
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
2847
2878
|
*/
|
|
2848
2879
|
presetType: LayoutPresetType;
|
|
2849
2880
|
};
|
|
2850
|
-
export
|
|
2851
|
-
export
|
|
2852
|
-
export
|
|
2853
|
-
export
|
|
2854
|
-
export
|
|
2881
|
+
export type ResultBehavior = 'close' | 'hide' | 'none';
|
|
2882
|
+
export type PopupBaseBehavior = 'close' | 'hide';
|
|
2883
|
+
export type PopupResultBehavior = 'none' | PopupBaseBehavior;
|
|
2884
|
+
export type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
|
|
2885
|
+
export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
|
2855
2886
|
export interface PopupOptions {
|
|
2856
2887
|
initialOptions?: Optional<WindowCreationOptions, 'name'>;
|
|
2857
2888
|
additionalOptions?: UpdatableWindowOptions;
|
|
@@ -2868,7 +2899,7 @@ export interface PopupOptions {
|
|
|
2868
2899
|
onPopupReady?: (popupWindow: _Window) => any;
|
|
2869
2900
|
onPopupResult?: (payload: PopupResult) => any;
|
|
2870
2901
|
}
|
|
2871
|
-
export
|
|
2902
|
+
export type PopupInteraction = 'clicked' | 'dismissed';
|
|
2872
2903
|
export interface PopupResult<T = any> {
|
|
2873
2904
|
identity: {
|
|
2874
2905
|
name: string;
|
|
@@ -2878,16 +2909,16 @@ export interface PopupResult<T = any> {
|
|
|
2878
2909
|
data?: T;
|
|
2879
2910
|
lastDispatchResult?: PopupResult;
|
|
2880
2911
|
}
|
|
2881
|
-
export
|
|
2912
|
+
export type AppVersionProgressEvent = {
|
|
2882
2913
|
type: 'app-version-progress';
|
|
2883
2914
|
} & AppVersionProgress;
|
|
2884
|
-
export
|
|
2915
|
+
export type AppVersionErrorEvent = {
|
|
2885
2916
|
type: 'app-version-error';
|
|
2886
2917
|
} & AppVersionError;
|
|
2887
|
-
export
|
|
2918
|
+
export type AppVersionCompleteEvent = {
|
|
2888
2919
|
type: 'app-version-complete';
|
|
2889
2920
|
} & AppVersionProgress;
|
|
2890
|
-
export
|
|
2921
|
+
export type AppVersionRuntimeStatusEvent = {
|
|
2891
2922
|
type: 'runtime-status';
|
|
2892
2923
|
} & AppVersionRuntimeInfo;
|
|
2893
2924
|
import type * as BaseEvents from './api/events/base';
|
|
@@ -2901,20 +2932,20 @@ import type * as FrameEvents from './api/events/frame';
|
|
|
2901
2932
|
import type * as PlatformEvents from './api/events/platform';
|
|
2902
2933
|
import type * as ExternalApplicationEvents from './api/events/externalApplication';
|
|
2903
2934
|
export type { BaseEvents, WebContentsEvents, SystemEvents, ApplicationEvents, WindowEvents, ViewEvents, GlobalHotkeyEvents, FrameEvents, PlatformEvents, ExternalApplicationEvents };
|
|
2904
|
-
export
|
|
2905
|
-
export
|
|
2906
|
-
export
|
|
2907
|
-
export
|
|
2908
|
-
export
|
|
2909
|
-
export
|
|
2910
|
-
export
|
|
2911
|
-
export
|
|
2912
|
-
export
|
|
2913
|
-
export
|
|
2935
|
+
export type BaseEvent = BaseEvents.BaseEvent;
|
|
2936
|
+
export type WebContentsEvent = WebContentsEvents.WebContentsEvent;
|
|
2937
|
+
export type SystemEvent = SystemEvents.SystemEvent;
|
|
2938
|
+
export type ApplicationEvent = ApplicationEvents.ApplicationEvent;
|
|
2939
|
+
export type WindowEvent = WindowEvents.WindowEvent;
|
|
2940
|
+
export type ViewEvent = ViewEvents.ViewEvent;
|
|
2941
|
+
export type GlobalHotkeyEvent = GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
2942
|
+
export type FrameEvent = FrameEvents.FrameEvent;
|
|
2943
|
+
export type PlatformEvent = PlatformEvents.PlatformEvent;
|
|
2944
|
+
export type ExternalApplicationEvent = ExternalApplicationEvents.ExternalApplicationEvent;
|
|
2914
2945
|
/**
|
|
2915
2946
|
* Configure the context menu when right-clicking on a window.
|
|
2916
2947
|
*/
|
|
2917
|
-
export
|
|
2948
|
+
export type ContextMenuOptions = {
|
|
2918
2949
|
/**
|
|
2919
2950
|
* Context menu items to display on right-click.
|
|
2920
2951
|
*/
|
|
@@ -2927,16 +2958,16 @@ export declare type ContextMenuOptions = {
|
|
|
2927
2958
|
/**
|
|
2928
2959
|
* Context menu item with an implementation provided by OpenFin.
|
|
2929
2960
|
*/
|
|
2930
|
-
export
|
|
2931
|
-
export
|
|
2961
|
+
export type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
2962
|
+
export type InteropBrokerDisconnectionEvent = {
|
|
2932
2963
|
type: string;
|
|
2933
2964
|
topic: string;
|
|
2934
2965
|
brokerName: string;
|
|
2935
2966
|
};
|
|
2936
|
-
export
|
|
2967
|
+
export type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
|
|
2937
2968
|
export interface InteropActionLoggingOption {
|
|
2938
2969
|
enabled: boolean;
|
|
2939
2970
|
}
|
|
2940
|
-
export
|
|
2941
|
-
export
|
|
2971
|
+
export type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
2972
|
+
export type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
|
2942
2973
|
export type { Me } from './api/me';
|