@openfin/node-adapter 34.78.54 → 34.78.57
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/node-adapter-alpha.d.ts +76 -55
- package/out/node-adapter-beta.d.ts +76 -55
- package/out/node-adapter-public.d.ts +76 -55
- package/out/node-adapter.d.ts +91 -178
- package/out/node-adapter.js +61 -146
- package/package.json +1 -1
@@ -43,6 +43,8 @@ declare type Accelerator = {
|
|
43
43
|
};
|
44
44
|
|
45
45
|
/**
|
46
|
+
* Options to use when adding a view to a {@link TabStack}.
|
47
|
+
*
|
46
48
|
* @interface
|
47
49
|
*/
|
48
50
|
declare type AddViewOptions = CreateViewTarget & {
|
@@ -3640,7 +3642,7 @@ declare type ConstWindowOptions = {
|
|
3640
3642
|
/**
|
3641
3643
|
* @defaultValue true
|
3642
3644
|
*
|
3643
|
-
*
|
3645
|
+
* Setting this to false would keep the Window alive even if all its Views were closed.
|
3644
3646
|
* This is meant for advanced users and should be used with caution.
|
3645
3647
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
3646
3648
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
@@ -3650,7 +3652,8 @@ declare type ConstWindowOptions = {
|
|
3650
3652
|
/**
|
3651
3653
|
* @defaultValue 'all'
|
3652
3654
|
*
|
3653
|
-
*
|
3655
|
+
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
3656
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
3654
3657
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
3655
3658
|
*/
|
3656
3659
|
viewsPreventingClose: 'all' | 'layout';
|
@@ -4457,7 +4460,7 @@ declare type CreateViewPayload = {
|
|
4457
4460
|
/**
|
4458
4461
|
* @interface
|
4459
4462
|
*/
|
4460
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
4463
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
4461
4464
|
/**
|
4462
4465
|
* If specified, view creation will not attach to a window and caller must
|
4463
4466
|
* insert the view into the layout explicitly
|
@@ -4597,6 +4600,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
|
|
4597
4600
|
type: 'destroyed';
|
4598
4601
|
};
|
4599
4602
|
|
4603
|
+
/**
|
4604
|
+
* @interface
|
4605
|
+
*/
|
4606
|
+
declare type DeviceInfo = {
|
4607
|
+
vendorId: string | number;
|
4608
|
+
productId: string | number;
|
4609
|
+
};
|
4610
|
+
|
4600
4611
|
/**
|
4601
4612
|
* Generated when a page's theme color changes. This is usually due to encountering a meta tag.
|
4602
4613
|
* @interface
|
@@ -5057,9 +5068,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
5057
5068
|
} : never;
|
5058
5069
|
|
5059
5070
|
declare interface Environment {
|
5060
|
-
|
5071
|
+
initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
|
5061
5072
|
createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
|
5062
5073
|
destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
|
5074
|
+
resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
|
5063
5075
|
initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
|
5064
5076
|
observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
|
5065
5077
|
writeToken(path: string, token: string): Promise<string>;
|
@@ -7441,7 +7453,7 @@ declare class InteropBroker extends Base {
|
|
7441
7453
|
* // }
|
7442
7454
|
* ```
|
7443
7455
|
*
|
7444
|
-
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/
|
7456
|
+
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
|
7445
7457
|
*
|
7446
7458
|
* @param contextForIntent Data passed between entities and applications.
|
7447
7459
|
* @param clientIdentity Identity of the Client making the request.
|
@@ -8617,7 +8629,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
8617
8629
|
declare class Layout extends Base {
|
8618
8630
|
#private;
|
8619
8631
|
/* Excluded from this release type: init */
|
8620
|
-
identity: OpenFin.LayoutIdentity;
|
8632
|
+
identity: OpenFin.Identity | OpenFin.LayoutIdentity;
|
8621
8633
|
private platform;
|
8622
8634
|
wire: Transport;
|
8623
8635
|
/* Excluded from this release type: __constructor */
|
@@ -8833,25 +8845,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
8833
8845
|
*/
|
8834
8846
|
declare type LayoutIdentity = Identity_5 & {
|
8835
8847
|
/**
|
8836
|
-
* The name of the layout
|
8837
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
8848
|
+
* The name of the layout in a given window.
|
8838
8849
|
*/
|
8839
|
-
layoutName
|
8850
|
+
layoutName: string;
|
8840
8851
|
};
|
8841
8852
|
|
8842
8853
|
/**
|
8843
|
-
* Generated when
|
8854
|
+
* Generated when the window is created, and all of its layout's views have either finished or failed
|
8855
|
+
* navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
|
8844
8856
|
* @interface
|
8845
8857
|
*/
|
8846
8858
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8847
8859
|
type: 'layout-initialized';
|
8860
|
+
layoutIdentity: OpenFin.LayoutIdentity;
|
8848
8861
|
ofViews: (OpenFin.Identity & {
|
8849
8862
|
entityType: 'view';
|
8850
8863
|
})[];
|
8851
8864
|
};
|
8852
8865
|
|
8853
|
-
/* Excluded from this release type: LayoutInstance */
|
8854
|
-
|
8855
8866
|
/**
|
8856
8867
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
8857
8868
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
|
@@ -8879,7 +8890,7 @@ declare type LayoutItemConfig = {
|
|
8879
8890
|
*
|
8880
8891
|
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
8881
8892
|
*
|
8882
|
-
* Responsible for
|
8893
|
+
* Responsible for aggregating all layout snapshots and storing layout instances
|
8883
8894
|
*/
|
8884
8895
|
declare interface LayoutManager<T extends LayoutSnapshot> {
|
8885
8896
|
/**
|
@@ -8903,16 +8914,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8903
8914
|
* @throws if Object.keys(snapshot).length > 1
|
8904
8915
|
*/
|
8905
8916
|
applyLayoutSnapshot(snapshot: T): Promise<void>;
|
8906
|
-
/**
|
8907
|
-
* Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
|
8908
|
-
* contains a single layout.
|
8909
|
-
*
|
8910
|
-
* Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
|
8911
|
-
* fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
|
8912
|
-
*
|
8913
|
-
* @param snapshot
|
8914
|
-
* @throws if Object.keys(snapshot).length > 1
|
8915
|
-
*/
|
8916
8917
|
/**
|
8917
8918
|
* @experimental
|
8918
8919
|
*
|
@@ -8933,31 +8934,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8933
8934
|
/**
|
8934
8935
|
* @experimental
|
8935
8936
|
*
|
8936
|
-
*
|
8937
|
-
*
|
8937
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
8938
|
+
* this method to control the target layout for Layout API calls.
|
8939
|
+
*
|
8940
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
8941
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
8942
|
+
* "last visible" layout identity and return it.
|
8943
|
+
*
|
8944
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
8945
|
+
* call must route to in this order of precedence:
|
8946
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
8947
|
+
* - if there is only 1 layout, resolves that one
|
8948
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
8949
|
+
* - returns undefined
|
8950
|
+
*
|
8951
|
+
* @param identity
|
8952
|
+
* @returns LayoutIdentity | undefined
|
8938
8953
|
*/
|
8939
|
-
|
8954
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
8940
8955
|
/**
|
8941
8956
|
* @experimental
|
8942
8957
|
*
|
8943
|
-
*
|
8944
|
-
*
|
8945
|
-
*
|
8946
|
-
*
|
8958
|
+
* A hook provided to the consumer when it's time to remove a layout. Use this hook to
|
8959
|
+
* update your local state and remove the layout for the given LayoutIdentity. Note that
|
8960
|
+
* this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
|
8961
|
+
* signify to your application it's time to destroy this layout.
|
8962
|
+
*
|
8963
|
+
* Note that if the Window Option {@link WindowOptions.closeOnLastViewRemoved} is true, and the last View in this layout is closed, this hook will be called before the window closes.
|
8964
|
+
*
|
8965
|
+
* @param LayoutIdentity
|
8947
8966
|
*/
|
8948
|
-
|
8967
|
+
removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
|
8949
8968
|
/**
|
8950
8969
|
* @experimental
|
8951
8970
|
*/
|
8952
|
-
|
8971
|
+
getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
|
8953
8972
|
/**
|
8954
8973
|
* @experimental
|
8955
8974
|
*/
|
8956
|
-
|
8975
|
+
isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
|
8957
8976
|
/**
|
8958
8977
|
* @experimental
|
8959
8978
|
*/
|
8960
|
-
|
8979
|
+
size(): number;
|
8961
8980
|
}
|
8962
8981
|
|
8963
8982
|
/**
|
@@ -9004,7 +9023,7 @@ declare class LayoutModule extends Base {
|
|
9004
9023
|
* const layoutConfig = await layout.getConfig();
|
9005
9024
|
* ```
|
9006
9025
|
*/
|
9007
|
-
wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9026
|
+
wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9008
9027
|
/**
|
9009
9028
|
* Synchronously returns a Layout object that represents a Window's layout.
|
9010
9029
|
*
|
@@ -9024,7 +9043,7 @@ declare class LayoutModule extends Base {
|
|
9024
9043
|
* const layoutConfig = await layout.getConfig();
|
9025
9044
|
* ```
|
9026
9045
|
*/
|
9027
|
-
wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
|
9046
|
+
wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
|
9028
9047
|
/**
|
9029
9048
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
9030
9049
|
*
|
@@ -9192,6 +9211,9 @@ declare type LayoutOptions = {
|
|
9192
9211
|
};
|
9193
9212
|
};
|
9194
9213
|
|
9214
|
+
/**
|
9215
|
+
* Represents the position of an item in a layout relative to another.
|
9216
|
+
*/
|
9195
9217
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
9196
9218
|
|
9197
9219
|
/**
|
@@ -9200,11 +9222,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
|
9200
9222
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
9201
9223
|
|
9202
9224
|
/**
|
9203
|
-
* Generated when
|
9225
|
+
* Generated when the layout and all of the its views have been created and can receive API calls.
|
9204
9226
|
* @interface
|
9205
9227
|
*/
|
9206
9228
|
declare type LayoutReadyEvent = BaseEvent_5 & {
|
9207
9229
|
type: 'layout-ready';
|
9230
|
+
layoutIdentity: OpenFin.LayoutIdentity;
|
9208
9231
|
views: (OpenFin.Identity & {
|
9209
9232
|
success: boolean;
|
9210
9233
|
})[];
|
@@ -10142,6 +10165,7 @@ declare namespace OpenFin {
|
|
10142
10165
|
WebPermission,
|
10143
10166
|
VerboseWebPermission,
|
10144
10167
|
OpenExternalPermission,
|
10168
|
+
DeviceInfo,
|
10145
10169
|
Permissions_2 as Permissions,
|
10146
10170
|
PlatformWindowCreationOptions,
|
10147
10171
|
PlatformWindowOptions,
|
@@ -10299,7 +10323,6 @@ declare namespace OpenFin {
|
|
10299
10323
|
InitLayoutOptions,
|
10300
10324
|
LayoutManagerConstructor,
|
10301
10325
|
LayoutManagerOverride,
|
10302
|
-
LayoutInstance,
|
10303
10326
|
LayoutManager,
|
10304
10327
|
CreateLayoutOptions,
|
10305
10328
|
PresetLayoutOptions_2 as PresetLayoutOptions,
|
@@ -10491,6 +10514,7 @@ declare type Permissions_2 = {
|
|
10491
10514
|
Application?: Partial<ApplicationPermissions>;
|
10492
10515
|
System?: Partial<SystemPermissions>;
|
10493
10516
|
webAPIs?: WebPermission[];
|
10517
|
+
devices?: DeviceInfo[];
|
10494
10518
|
};
|
10495
10519
|
|
10496
10520
|
declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
|
@@ -11403,6 +11427,17 @@ declare interface PlatformProvider {
|
|
11403
11427
|
*/
|
11404
11428
|
getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
|
11405
11429
|
/* Excluded from this release type: getInitialLayoutSnapshot */
|
11430
|
+
/**
|
11431
|
+
* @experimental
|
11432
|
+
*
|
11433
|
+
* This API is called during the {@link PlatformProvider.getSnapshot()} call.
|
11434
|
+
* Gets the current state of a particular window and its views and returns an object that
|
11435
|
+
* can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
|
11436
|
+
* you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
|
11437
|
+
* @param identity
|
11438
|
+
* @param callerIdentity
|
11439
|
+
*/
|
11440
|
+
getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
|
11406
11441
|
/* Excluded from this release type: createViewsForLayout */
|
11407
11442
|
/* Excluded from this release type: getViewSnapshot */
|
11408
11443
|
/**
|
@@ -12831,7 +12866,7 @@ declare type ReplaceLayoutPayload = {
|
|
12831
12866
|
/**
|
12832
12867
|
* Identity of the window whose layout will be replaced.
|
12833
12868
|
*/
|
12834
|
-
target: LayoutIdentity;
|
12869
|
+
target: Identity_5 | LayoutIdentity;
|
12835
12870
|
};
|
12836
12871
|
|
12837
12872
|
/**
|
@@ -15322,20 +15357,6 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
15322
15357
|
contentItem: ContentItem;
|
15323
15358
|
}
|
15324
15359
|
|
15325
|
-
/**
|
15326
|
-
* @typedef {string} LayoutPosition
|
15327
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
15328
|
-
*/
|
15329
|
-
/**
|
15330
|
-
* @typedef {object} StackCreationOptions
|
15331
|
-
* @summary Stack creation options.
|
15332
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
15333
|
-
*/
|
15334
|
-
/**
|
15335
|
-
* @typedef {object} TabStack~AddViewOptions
|
15336
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
15337
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
15338
|
-
*/
|
15339
15360
|
/**
|
15340
15361
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
15341
15362
|
*/
|
@@ -16421,7 +16442,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
16421
16442
|
*/
|
16422
16443
|
declare type ViewDetachedEvent = BaseEvent_5 & {
|
16423
16444
|
type: 'view-detached';
|
16424
|
-
target: OpenFin.Identity;
|
16445
|
+
target: OpenFin.Identity | null;
|
16425
16446
|
previousTarget: OpenFin.Identity;
|
16426
16447
|
viewIdentity: OpenFin.Identity;
|
16427
16448
|
};
|
@@ -17657,7 +17678,7 @@ declare namespace WebContentsEvents {
|
|
17657
17678
|
* `clipboard-read`: Request access to read from the clipboard.<br>
|
17658
17679
|
* `clipboard-sanitized-write`: Request access to write to the clipboard.
|
17659
17680
|
*/
|
17660
|
-
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
|
17681
|
+
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
|
17661
17682
|
|
17662
17683
|
/**
|
17663
17684
|
* Object representing headers and their values, where the
|
@@ -43,6 +43,8 @@ declare type Accelerator = {
|
|
43
43
|
};
|
44
44
|
|
45
45
|
/**
|
46
|
+
* Options to use when adding a view to a {@link TabStack}.
|
47
|
+
*
|
46
48
|
* @interface
|
47
49
|
*/
|
48
50
|
declare type AddViewOptions = CreateViewTarget & {
|
@@ -3640,7 +3642,7 @@ declare type ConstWindowOptions = {
|
|
3640
3642
|
/**
|
3641
3643
|
* @defaultValue true
|
3642
3644
|
*
|
3643
|
-
*
|
3645
|
+
* Setting this to false would keep the Window alive even if all its Views were closed.
|
3644
3646
|
* This is meant for advanced users and should be used with caution.
|
3645
3647
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
3646
3648
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
@@ -3650,7 +3652,8 @@ declare type ConstWindowOptions = {
|
|
3650
3652
|
/**
|
3651
3653
|
* @defaultValue 'all'
|
3652
3654
|
*
|
3653
|
-
*
|
3655
|
+
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
3656
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
3654
3657
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
3655
3658
|
*/
|
3656
3659
|
viewsPreventingClose: 'all' | 'layout';
|
@@ -4457,7 +4460,7 @@ declare type CreateViewPayload = {
|
|
4457
4460
|
/**
|
4458
4461
|
* @interface
|
4459
4462
|
*/
|
4460
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
4463
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
4461
4464
|
/**
|
4462
4465
|
* If specified, view creation will not attach to a window and caller must
|
4463
4466
|
* insert the view into the layout explicitly
|
@@ -4597,6 +4600,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
|
|
4597
4600
|
type: 'destroyed';
|
4598
4601
|
};
|
4599
4602
|
|
4603
|
+
/**
|
4604
|
+
* @interface
|
4605
|
+
*/
|
4606
|
+
declare type DeviceInfo = {
|
4607
|
+
vendorId: string | number;
|
4608
|
+
productId: string | number;
|
4609
|
+
};
|
4610
|
+
|
4600
4611
|
/**
|
4601
4612
|
* Generated when a page's theme color changes. This is usually due to encountering a meta tag.
|
4602
4613
|
* @interface
|
@@ -5057,9 +5068,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
5057
5068
|
} : never;
|
5058
5069
|
|
5059
5070
|
declare interface Environment {
|
5060
|
-
|
5071
|
+
initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
|
5061
5072
|
createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
|
5062
5073
|
destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
|
5074
|
+
resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
|
5063
5075
|
initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
|
5064
5076
|
observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
|
5065
5077
|
writeToken(path: string, token: string): Promise<string>;
|
@@ -7441,7 +7453,7 @@ declare class InteropBroker extends Base {
|
|
7441
7453
|
* // }
|
7442
7454
|
* ```
|
7443
7455
|
*
|
7444
|
-
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/
|
7456
|
+
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
|
7445
7457
|
*
|
7446
7458
|
* @param contextForIntent Data passed between entities and applications.
|
7447
7459
|
* @param clientIdentity Identity of the Client making the request.
|
@@ -8617,7 +8629,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
8617
8629
|
declare class Layout extends Base {
|
8618
8630
|
#private;
|
8619
8631
|
/* Excluded from this release type: init */
|
8620
|
-
identity: OpenFin.LayoutIdentity;
|
8632
|
+
identity: OpenFin.Identity | OpenFin.LayoutIdentity;
|
8621
8633
|
private platform;
|
8622
8634
|
wire: Transport;
|
8623
8635
|
/* Excluded from this release type: __constructor */
|
@@ -8833,25 +8845,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
8833
8845
|
*/
|
8834
8846
|
declare type LayoutIdentity = Identity_5 & {
|
8835
8847
|
/**
|
8836
|
-
* The name of the layout
|
8837
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
8848
|
+
* The name of the layout in a given window.
|
8838
8849
|
*/
|
8839
|
-
layoutName
|
8850
|
+
layoutName: string;
|
8840
8851
|
};
|
8841
8852
|
|
8842
8853
|
/**
|
8843
|
-
* Generated when
|
8854
|
+
* Generated when the window is created, and all of its layout's views have either finished or failed
|
8855
|
+
* navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
|
8844
8856
|
* @interface
|
8845
8857
|
*/
|
8846
8858
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8847
8859
|
type: 'layout-initialized';
|
8860
|
+
layoutIdentity: OpenFin.LayoutIdentity;
|
8848
8861
|
ofViews: (OpenFin.Identity & {
|
8849
8862
|
entityType: 'view';
|
8850
8863
|
})[];
|
8851
8864
|
};
|
8852
8865
|
|
8853
|
-
/* Excluded from this release type: LayoutInstance */
|
8854
|
-
|
8855
8866
|
/**
|
8856
8867
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
8857
8868
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
|
@@ -8879,7 +8890,7 @@ declare type LayoutItemConfig = {
|
|
8879
8890
|
*
|
8880
8891
|
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
8881
8892
|
*
|
8882
|
-
* Responsible for
|
8893
|
+
* Responsible for aggregating all layout snapshots and storing layout instances
|
8883
8894
|
*/
|
8884
8895
|
declare interface LayoutManager<T extends LayoutSnapshot> {
|
8885
8896
|
/**
|
@@ -8903,16 +8914,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8903
8914
|
* @throws if Object.keys(snapshot).length > 1
|
8904
8915
|
*/
|
8905
8916
|
applyLayoutSnapshot(snapshot: T): Promise<void>;
|
8906
|
-
/**
|
8907
|
-
* Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
|
8908
|
-
* contains a single layout.
|
8909
|
-
*
|
8910
|
-
* Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
|
8911
|
-
* fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
|
8912
|
-
*
|
8913
|
-
* @param snapshot
|
8914
|
-
* @throws if Object.keys(snapshot).length > 1
|
8915
|
-
*/
|
8916
8917
|
/**
|
8917
8918
|
* @experimental
|
8918
8919
|
*
|
@@ -8933,31 +8934,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8933
8934
|
/**
|
8934
8935
|
* @experimental
|
8935
8936
|
*
|
8936
|
-
*
|
8937
|
-
*
|
8937
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
8938
|
+
* this method to control the target layout for Layout API calls.
|
8939
|
+
*
|
8940
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
8941
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
8942
|
+
* "last visible" layout identity and return it.
|
8943
|
+
*
|
8944
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
8945
|
+
* call must route to in this order of precedence:
|
8946
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
8947
|
+
* - if there is only 1 layout, resolves that one
|
8948
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
8949
|
+
* - returns undefined
|
8950
|
+
*
|
8951
|
+
* @param identity
|
8952
|
+
* @returns LayoutIdentity | undefined
|
8938
8953
|
*/
|
8939
|
-
|
8954
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
8940
8955
|
/**
|
8941
8956
|
* @experimental
|
8942
8957
|
*
|
8943
|
-
*
|
8944
|
-
*
|
8945
|
-
*
|
8946
|
-
*
|
8958
|
+
* A hook provided to the consumer when it's time to remove a layout. Use this hook to
|
8959
|
+
* update your local state and remove the layout for the given LayoutIdentity. Note that
|
8960
|
+
* this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
|
8961
|
+
* signify to your application it's time to destroy this layout.
|
8962
|
+
*
|
8963
|
+
* Note that if the Window Option {@link WindowOptions.closeOnLastViewRemoved} is true, and the last View in this layout is closed, this hook will be called before the window closes.
|
8964
|
+
*
|
8965
|
+
* @param LayoutIdentity
|
8947
8966
|
*/
|
8948
|
-
|
8967
|
+
removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
|
8949
8968
|
/**
|
8950
8969
|
* @experimental
|
8951
8970
|
*/
|
8952
|
-
|
8971
|
+
getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
|
8953
8972
|
/**
|
8954
8973
|
* @experimental
|
8955
8974
|
*/
|
8956
|
-
|
8975
|
+
isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
|
8957
8976
|
/**
|
8958
8977
|
* @experimental
|
8959
8978
|
*/
|
8960
|
-
|
8979
|
+
size(): number;
|
8961
8980
|
}
|
8962
8981
|
|
8963
8982
|
/**
|
@@ -9004,7 +9023,7 @@ declare class LayoutModule extends Base {
|
|
9004
9023
|
* const layoutConfig = await layout.getConfig();
|
9005
9024
|
* ```
|
9006
9025
|
*/
|
9007
|
-
wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9026
|
+
wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9008
9027
|
/**
|
9009
9028
|
* Synchronously returns a Layout object that represents a Window's layout.
|
9010
9029
|
*
|
@@ -9024,7 +9043,7 @@ declare class LayoutModule extends Base {
|
|
9024
9043
|
* const layoutConfig = await layout.getConfig();
|
9025
9044
|
* ```
|
9026
9045
|
*/
|
9027
|
-
wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
|
9046
|
+
wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
|
9028
9047
|
/**
|
9029
9048
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
9030
9049
|
*
|
@@ -9192,6 +9211,9 @@ declare type LayoutOptions = {
|
|
9192
9211
|
};
|
9193
9212
|
};
|
9194
9213
|
|
9214
|
+
/**
|
9215
|
+
* Represents the position of an item in a layout relative to another.
|
9216
|
+
*/
|
9195
9217
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
9196
9218
|
|
9197
9219
|
/**
|
@@ -9200,11 +9222,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
|
9200
9222
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
9201
9223
|
|
9202
9224
|
/**
|
9203
|
-
* Generated when
|
9225
|
+
* Generated when the layout and all of the its views have been created and can receive API calls.
|
9204
9226
|
* @interface
|
9205
9227
|
*/
|
9206
9228
|
declare type LayoutReadyEvent = BaseEvent_5 & {
|
9207
9229
|
type: 'layout-ready';
|
9230
|
+
layoutIdentity: OpenFin.LayoutIdentity;
|
9208
9231
|
views: (OpenFin.Identity & {
|
9209
9232
|
success: boolean;
|
9210
9233
|
})[];
|
@@ -10142,6 +10165,7 @@ declare namespace OpenFin {
|
|
10142
10165
|
WebPermission,
|
10143
10166
|
VerboseWebPermission,
|
10144
10167
|
OpenExternalPermission,
|
10168
|
+
DeviceInfo,
|
10145
10169
|
Permissions_2 as Permissions,
|
10146
10170
|
PlatformWindowCreationOptions,
|
10147
10171
|
PlatformWindowOptions,
|
@@ -10299,7 +10323,6 @@ declare namespace OpenFin {
|
|
10299
10323
|
InitLayoutOptions,
|
10300
10324
|
LayoutManagerConstructor,
|
10301
10325
|
LayoutManagerOverride,
|
10302
|
-
LayoutInstance,
|
10303
10326
|
LayoutManager,
|
10304
10327
|
CreateLayoutOptions,
|
10305
10328
|
PresetLayoutOptions_2 as PresetLayoutOptions,
|
@@ -10491,6 +10514,7 @@ declare type Permissions_2 = {
|
|
10491
10514
|
Application?: Partial<ApplicationPermissions>;
|
10492
10515
|
System?: Partial<SystemPermissions>;
|
10493
10516
|
webAPIs?: WebPermission[];
|
10517
|
+
devices?: DeviceInfo[];
|
10494
10518
|
};
|
10495
10519
|
|
10496
10520
|
declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
|
@@ -11403,6 +11427,17 @@ declare interface PlatformProvider {
|
|
11403
11427
|
*/
|
11404
11428
|
getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
|
11405
11429
|
/* Excluded from this release type: getInitialLayoutSnapshot */
|
11430
|
+
/**
|
11431
|
+
* @experimental
|
11432
|
+
*
|
11433
|
+
* This API is called during the {@link PlatformProvider.getSnapshot()} call.
|
11434
|
+
* Gets the current state of a particular window and its views and returns an object that
|
11435
|
+
* can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
|
11436
|
+
* you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
|
11437
|
+
* @param identity
|
11438
|
+
* @param callerIdentity
|
11439
|
+
*/
|
11440
|
+
getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
|
11406
11441
|
/* Excluded from this release type: createViewsForLayout */
|
11407
11442
|
/* Excluded from this release type: getViewSnapshot */
|
11408
11443
|
/**
|
@@ -12831,7 +12866,7 @@ declare type ReplaceLayoutPayload = {
|
|
12831
12866
|
/**
|
12832
12867
|
* Identity of the window whose layout will be replaced.
|
12833
12868
|
*/
|
12834
|
-
target: LayoutIdentity;
|
12869
|
+
target: Identity_5 | LayoutIdentity;
|
12835
12870
|
};
|
12836
12871
|
|
12837
12872
|
/**
|
@@ -15322,20 +15357,6 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
15322
15357
|
contentItem: ContentItem;
|
15323
15358
|
}
|
15324
15359
|
|
15325
|
-
/**
|
15326
|
-
* @typedef {string} LayoutPosition
|
15327
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
15328
|
-
*/
|
15329
|
-
/**
|
15330
|
-
* @typedef {object} StackCreationOptions
|
15331
|
-
* @summary Stack creation options.
|
15332
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
15333
|
-
*/
|
15334
|
-
/**
|
15335
|
-
* @typedef {object} TabStack~AddViewOptions
|
15336
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
15337
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
15338
|
-
*/
|
15339
15360
|
/**
|
15340
15361
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
15341
15362
|
*/
|
@@ -16421,7 +16442,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
16421
16442
|
*/
|
16422
16443
|
declare type ViewDetachedEvent = BaseEvent_5 & {
|
16423
16444
|
type: 'view-detached';
|
16424
|
-
target: OpenFin.Identity;
|
16445
|
+
target: OpenFin.Identity | null;
|
16425
16446
|
previousTarget: OpenFin.Identity;
|
16426
16447
|
viewIdentity: OpenFin.Identity;
|
16427
16448
|
};
|
@@ -17657,7 +17678,7 @@ declare namespace WebContentsEvents {
|
|
17657
17678
|
* `clipboard-read`: Request access to read from the clipboard.<br>
|
17658
17679
|
* `clipboard-sanitized-write`: Request access to write to the clipboard.
|
17659
17680
|
*/
|
17660
|
-
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
|
17681
|
+
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
|
17661
17682
|
|
17662
17683
|
/**
|
17663
17684
|
* Object representing headers and their values, where the
|