@openfin/node-adapter 34.78.52 → 34.78.56

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.
@@ -924,7 +924,6 @@ declare namespace ApplicationEvents {
924
924
  WindowRespondingEvent,
925
925
  WindowStartLoadEvent,
926
926
  ApplicationWindowEvent,
927
- ApplicationWindowEventTypes,
928
927
  ClosedEvent,
929
928
  ConnectedEvent_2 as ConnectedEvent,
930
929
  ApplicationConnectedEvent,
@@ -1343,11 +1342,6 @@ declare type ApplicationType = {
1343
1342
  */
1344
1343
  declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
1345
1344
 
1346
- /**
1347
- * Array of valid `type` values for an {@link ApplicationWindowEvent}.
1348
- */
1349
- declare const ApplicationWindowEventTypes: readonly ["window-alert-requested", "window-created", "window-end-load", "window-not-responding", "window-responding", "window-start-load"];
1350
-
1351
1345
  declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
1352
1346
 
1353
1347
  /**
@@ -3740,7 +3734,7 @@ declare type ConstWindowOptions = {
3740
3734
  /**
3741
3735
  * @defaultValue true
3742
3736
  *
3743
- * Toggling off would keep the Window alive even if all its Views were closed.
3737
+ * Setting this to false would keep the Window alive even if all its Views were closed.
3744
3738
  * This is meant for advanced users and should be used with caution.
3745
3739
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3746
3740
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3750,7 +3744,8 @@ declare type ConstWindowOptions = {
3750
3744
  /**
3751
3745
  * @defaultValue 'all'
3752
3746
  *
3753
- * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3747
+ * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3748
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3754
3749
  * **NOTE:** - This option is ignored in non-Platforms apps.
3755
3750
  */
3756
3751
  viewsPreventingClose: 'all' | 'layout';
@@ -4557,7 +4552,7 @@ declare type CreateViewPayload = {
4557
4552
  /**
4558
4553
  * @interface
4559
4554
  */
4560
- declare type CreateViewTarget = LayoutIdentity & {
4555
+ declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
4561
4556
  /**
4562
4557
  * If specified, view creation will not attach to a window and caller must
4563
4558
  * insert the view into the layout explicitly
@@ -4697,6 +4692,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
4697
4692
  type: 'destroyed';
4698
4693
  };
4699
4694
 
4695
+ /**
4696
+ * @interface
4697
+ */
4698
+ declare type DeviceInfo = {
4699
+ vendorId: string | number;
4700
+ productId: string | number;
4701
+ };
4702
+
4700
4703
  /**
4701
4704
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4702
4705
  * @interface
@@ -5162,9 +5165,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5162
5165
  } : never;
5163
5166
 
5164
5167
  declare interface Environment {
5165
- initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5168
+ initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5166
5169
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5167
5170
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5171
+ resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
5168
5172
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
5169
5173
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
5170
5174
  writeToken(path: string, token: string): Promise<string>;
@@ -5214,7 +5218,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
5214
5218
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5215
5219
  * from which they propagate).
5216
5220
  */
5217
- declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5221
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5218
5222
 
5219
5223
  /**
5220
5224
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
@@ -5773,7 +5777,7 @@ declare type FileDownloadEvent = {
5773
5777
  *
5774
5778
  * @interface
5775
5779
  */
5776
- declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5780
+ declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
5777
5781
  type: 'file-download-location-changed';
5778
5782
  };
5779
5783
 
@@ -6811,6 +6815,11 @@ declare type IdentityEvent = BaseEvent & {
6811
6815
  */
6812
6816
  declare type IdEventType = WithId<AppVersionEventType>;
6813
6817
 
6818
+ /**
6819
+ * @deprecated Renamed to {@link IdleStateChangedEvent}.
6820
+ */
6821
+ declare type IdleEvent = IdleStateChangedEvent;
6822
+
6814
6823
  /**
6815
6824
  * Generated when a user enters or returns from idle state.
6816
6825
  * @remarks This method is continuously generated every minute while the user is in idle.
@@ -6818,7 +6827,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
6818
6827
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6819
6828
  * @interface
6820
6829
  */
6821
- declare type IdleEvent = BaseEvent_8 & {
6830
+ declare type IdleStateChangedEvent = BaseEvent_8 & {
6822
6831
  type: 'idle-state-changed';
6823
6832
  elapsedTime: number;
6824
6833
  isIdle: boolean;
@@ -7608,7 +7617,7 @@ declare class InteropBroker extends Base {
7608
7617
  * // }
7609
7618
  * ```
7610
7619
  *
7611
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
7620
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
7612
7621
  *
7613
7622
  * @param contextForIntent Data passed between entities and applications.
7614
7623
  * @param clientIdentity Identity of the Client making the request.
@@ -8790,7 +8799,7 @@ declare class Layout extends Base {
8790
8799
  * @internal
8791
8800
  */
8792
8801
  init: (options?: OpenFin.InitLayoutOptions) => Promise<Layout>;
8793
- identity: OpenFin.LayoutIdentity;
8802
+ identity: OpenFin.Identity | OpenFin.LayoutIdentity;
8794
8803
  private platform;
8795
8804
  wire: Transport;
8796
8805
  /**
@@ -9009,45 +9018,23 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
9009
9018
  */
9010
9019
  declare type LayoutIdentity = Identity_5 & {
9011
9020
  /**
9012
- * The name of the layout an action should be targeted to. When not provided,
9013
- * OpenFin attempts to resolve the instance via visibility checks.
9021
+ * The name of the layout in a given window.
9014
9022
  */
9015
- layoutName?: string;
9023
+ layoutName: string;
9016
9024
  };
9017
9025
 
9018
9026
  /**
9019
- * Generated when a window and all of its layout's views have either finished or failed navigation.
9027
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
9020
9028
  * @interface
9021
9029
  */
9022
9030
  declare type LayoutInitializedEvent = BaseEvent_5 & {
9023
9031
  type: 'layout-initialized';
9032
+ layoutIdentity: OpenFin.LayoutIdentity;
9024
9033
  ofViews: (OpenFin.Identity & {
9025
9034
  entityType: 'view';
9026
9035
  })[];
9027
9036
  };
9028
9037
 
9029
- /**
9030
- * @interface @experimental @internal
9031
- *
9032
- * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
9033
- *
9034
- * Responsible for handling all layout management and renderering
9035
- */
9036
- declare type LayoutInstance = {
9037
- identity: LayoutIdentity;
9038
- getFrameSnapshot: () => Promise<LayoutOptions>;
9039
- addView: (payload: AddViewOptions) => Promise<View_2>;
9040
- closeView: (viewIdentity: Identity_5) => Promise<void>;
9041
- removeView: (viewConfig: Identity_5 | ViewState) => Promise<View_2>;
9042
- replaceView: (payload: ReplaceViewOptions) => Promise<View_2>;
9043
- getViews: () => LayoutComponent[];
9044
- getCurrentViews: () => Identity_5[];
9045
- startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
9046
- applyPreset: (payload: PresetLayoutOptions_2) => void;
9047
- isVisible: () => boolean;
9048
- destroy: () => Promise<void>;
9049
- };
9050
-
9051
9038
  /**
9052
9039
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
9053
9040
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -9075,7 +9062,7 @@ declare type LayoutItemConfig = {
9075
9062
  *
9076
9063
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
9077
9064
  *
9078
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
9065
+ * Responsible for aggregating all layout snapshots and storing layout instances
9079
9066
  */
9080
9067
  declare interface LayoutManager<T extends LayoutSnapshot> {
9081
9068
  /**
@@ -9099,16 +9086,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
9099
9086
  * @throws if Object.keys(snapshot).length > 1
9100
9087
  */
9101
9088
  applyLayoutSnapshot(snapshot: T): Promise<void>;
9102
- /**
9103
- * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
9104
- * contains a single layout.
9105
- *
9106
- * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
9107
- * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
9108
- *
9109
- * @param snapshot
9110
- * @throws if Object.keys(snapshot).length > 1
9111
- */
9112
9089
  /**
9113
9090
  * @experimental
9114
9091
  *
@@ -9129,31 +9106,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
9129
9106
  /**
9130
9107
  * @experimental
9131
9108
  *
9132
- * @param layoutIdentity
9133
- * @returns
9109
+ * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
9110
+ * this method to control the target layout for Layout API calls.
9111
+ *
9112
+ * Example use case: You have hidden all the layouts and are showing a dialog that will
9113
+ * execute an API call (ex: Layout.replace()) - override this method and save the
9114
+ * "last visible" layout identity and return it.
9115
+ *
9116
+ * By default, OpenFin will use a series of checks to determine which Layout the API
9117
+ * call must route to in this order of precedence:
9118
+ * - try to resolve the layout from the layoutIdentity, throws if missing
9119
+ * - if there is only 1 layout, resolves that one
9120
+ * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
9121
+ * - returns undefined
9122
+ *
9123
+ * @param identity
9124
+ * @returns LayoutIdentity | undefined
9134
9125
  */
9135
- resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
9126
+ resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
9136
9127
  /**
9137
9128
  * @experimental
9138
9129
  *
9139
- * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
9140
- * Throws if it does not exist.
9141
- * @param layoutName
9142
- * @returns
9130
+ * A hook provided to the consumer when it's time to remove a layout. Use this hook to
9131
+ * update your local state and remove the layout for the given LayoutIdentity. Note that
9132
+ * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
9133
+ * signify to your application it's time to destroy this layout.
9134
+ *
9135
+ * 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.
9136
+ *
9137
+ * @param LayoutIdentity
9143
9138
  */
9144
- getLayoutByName(layoutName: string): LayoutInstance;
9139
+ removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
9145
9140
  /**
9146
9141
  * @experimental
9147
9142
  */
9148
- getLayouts(): Record<string, LayoutInstance>;
9143
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
9149
9144
  /**
9150
9145
  * @experimental
9151
9146
  */
9152
- getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
9147
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
9153
9148
  /**
9154
9149
  * @experimental
9155
9150
  */
9156
- isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
9151
+ size(): number;
9157
9152
  }
9158
9153
 
9159
9154
  /**
@@ -9200,7 +9195,7 @@ declare class LayoutModule extends Base {
9200
9195
  * const layoutConfig = await layout.getConfig();
9201
9196
  * ```
9202
9197
  */
9203
- wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
9198
+ wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
9204
9199
  /**
9205
9200
  * Synchronously returns a Layout object that represents a Window's layout.
9206
9201
  *
@@ -9220,7 +9215,7 @@ declare class LayoutModule extends Base {
9220
9215
  * const layoutConfig = await layout.getConfig();
9221
9216
  * ```
9222
9217
  */
9223
- wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
9218
+ wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
9224
9219
  /**
9225
9220
  * Asynchronously returns a Layout object that represents a Window's layout.
9226
9221
  *
@@ -9553,11 +9548,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9553
9548
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9554
9549
 
9555
9550
  /**
9556
- * Generated when a window and all of its layout's views have been created and can receive API calls.
9551
+ * Generated when the layout and all of the its views have been created and can receive API calls.
9557
9552
  * @interface
9558
9553
  */
9559
9554
  declare type LayoutReadyEvent = BaseEvent_5 & {
9560
9555
  type: 'layout-ready';
9556
+ layoutIdentity: OpenFin.LayoutIdentity;
9561
9557
  views: (OpenFin.Identity & {
9562
9558
  success: boolean;
9563
9559
  })[];
@@ -9904,14 +9900,9 @@ declare type MonitorDetails = {
9904
9900
  };
9905
9901
 
9906
9902
  /**
9907
- * Generated on changes of a monitor's size/location.
9908
- * @remarks A monitor's size changes when the taskbar is resized or relocated.
9909
- * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9910
- * @interface
9903
+ * @deprecated Renamed to {@link MonitorInfoChangedEvent}.
9911
9904
  */
9912
- declare type MonitorEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9913
- type: 'monitor-info-changed';
9914
- };
9905
+ declare type MonitorEvent = MonitorInfoChangedEvent;
9915
9906
 
9916
9907
  /**
9917
9908
  * @interface
@@ -9935,6 +9926,16 @@ declare type MonitorInfo = {
9935
9926
  virtualScreen: DipRect;
9936
9927
  };
9937
9928
 
9929
+ /**
9930
+ * Generated on changes of a monitor's size/location.
9931
+ * @remarks A monitor's size changes when the taskbar is resized or relocated.
9932
+ * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9933
+ * @interface
9934
+ */
9935
+ declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9936
+ type: 'monitor-info-changed';
9937
+ };
9938
+
9938
9939
  /**
9939
9940
  * @interface
9940
9941
  */
@@ -10508,6 +10509,7 @@ declare namespace OpenFin {
10508
10509
  WebPermission,
10509
10510
  VerboseWebPermission,
10510
10511
  OpenExternalPermission,
10512
+ DeviceInfo,
10511
10513
  Permissions_2 as Permissions,
10512
10514
  PlatformWindowCreationOptions,
10513
10515
  PlatformWindowOptions,
@@ -10665,7 +10667,6 @@ declare namespace OpenFin {
10665
10667
  InitLayoutOptions,
10666
10668
  LayoutManagerConstructor,
10667
10669
  LayoutManagerOverride,
10668
- LayoutInstance,
10669
10670
  LayoutManager,
10670
10671
  CreateLayoutOptions,
10671
10672
  PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10857,6 +10858,7 @@ declare type Permissions_2 = {
10857
10858
  Application?: Partial<ApplicationPermissions>;
10858
10859
  System?: Partial<SystemPermissions>;
10859
10860
  webAPIs?: WebPermission[];
10861
+ devices?: DeviceInfo[];
10860
10862
  };
10861
10863
 
10862
10864
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -13290,7 +13292,7 @@ declare type ReplaceLayoutPayload = {
13290
13292
  /**
13291
13293
  * Identity of the window whose layout will be replaced.
13292
13294
  */
13293
- target: LayoutIdentity;
13295
+ target: Identity_5 | LayoutIdentity;
13294
13296
  };
13295
13297
 
13296
13298
  /**
@@ -15647,7 +15649,9 @@ declare namespace SystemEvents {
15647
15649
  NotRequested,
15648
15650
  ExcludeRequested,
15649
15651
  BaseEvent_8 as BaseEvent,
15652
+ IdleStateChangedEvent,
15650
15653
  IdleEvent,
15654
+ MonitorInfoChangedEvent,
15651
15655
  MonitorEvent,
15652
15656
  SessionChangedEvent,
15653
15657
  AppVersionEvent,
@@ -16978,7 +16982,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
16978
16982
  */
16979
16983
  declare type ViewDetachedEvent = BaseEvent_5 & {
16980
16984
  type: 'view-detached';
16981
- target: OpenFin.Identity;
16985
+ target: OpenFin.Identity | null;
16982
16986
  previousTarget: OpenFin.Identity;
16983
16987
  viewIdentity: OpenFin.Identity;
16984
16988
  };
@@ -18214,7 +18218,7 @@ declare namespace WebContentsEvents {
18214
18218
  * `clipboard-read`: Request access to read from the clipboard.<br>
18215
18219
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
18216
18220
  */
18217
- declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
18221
+ declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
18218
18222
 
18219
18223
  /**
18220
18224
  * Object representing headers and their values, where the
@@ -19900,7 +19904,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19900
19904
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19901
19905
  * @interface
19902
19906
  */
19903
- declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
19907
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19904
19908
  type: 'window-alert-requested';
19905
19909
  };
19906
19910
 
@@ -19948,7 +19952,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19948
19952
  * Generated when a child window is created.
19949
19953
  * @interface
19950
19954
  */
19951
- declare type WindowCreatedEvent = BaseApplicationEvent & {
19955
+ declare type WindowCreatedEvent = BaseEvent_3 & {
19952
19956
  type: 'window-created';
19953
19957
  };
19954
19958
 
@@ -20005,7 +20009,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
20005
20009
  * Generated when a child window ends loading.
20006
20010
  * @interface
20007
20011
  */
20008
- declare type WindowEndLoadEvent = BaseApplicationEvent & {
20012
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
20009
20013
  type: 'window-end-load';
20010
20014
  };
20011
20015
 
@@ -20219,7 +20223,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
20219
20223
  * Generated when a child window is not responding.
20220
20224
  * @interface
20221
20225
  */
20222
- declare type WindowNotRespondingEvent = BaseApplicationEvent & {
20226
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
20223
20227
  type: 'window-not-responding';
20224
20228
  };
20225
20229
 
@@ -20251,7 +20255,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
20251
20255
  * Generated when a child window is responding.
20252
20256
  * @interface
20253
20257
  */
20254
- declare type WindowRespondingEvent = BaseApplicationEvent & {
20258
+ declare type WindowRespondingEvent = BaseEvent_3 & {
20255
20259
  type: 'window-responding';
20256
20260
  };
20257
20261
 
@@ -20280,7 +20284,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
20280
20284
  * Generated when a child window starts loading.
20281
20285
  * @interface
20282
20286
  */
20283
- declare type WindowStartLoadEvent = BaseApplicationEvent & {
20287
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
20284
20288
  type: 'window-start-load';
20285
20289
  };
20286
20290
 
@@ -3243,7 +3243,7 @@ function requireView () {
3243
3243
  * * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
3244
3244
  * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
3245
3245
  *
3246
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
3246
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
3247
3247
  * both of these were documented on the same page.
3248
3248
  *
3249
3249
  * @packageDocumentation
@@ -4384,7 +4384,7 @@ function requireApplication () {
4384
4384
  * * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
4385
4385
  * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
4386
4386
  *
4387
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
4387
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
4388
4388
  * both of these were documented on the same page.
4389
4389
  *
4390
4390
  * @packageDocumentation
@@ -6441,7 +6441,7 @@ function requireWindow () {
6441
6441
  * * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
6442
6442
  * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
6443
6443
  *
6444
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
6444
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
6445
6445
  * both of these were documented on the same page.
6446
6446
  *
6447
6447
  * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -11195,7 +11195,7 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
11195
11195
  * * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
11196
11196
  * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
11197
11197
  *
11198
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
11198
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
11199
11199
  * both of these were documented on the same page.
11200
11200
  *
11201
11201
  * @packageDocumentation
@@ -11446,7 +11446,7 @@ Factory$4._FrameModule = _FrameModule;
11446
11446
  * * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
11447
11447
  * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
11448
11448
  *
11449
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
11449
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
11450
11450
  * both of these were documented on the same page.
11451
11451
  *
11452
11452
  * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -12792,7 +12792,6 @@ class Layout extends base_1$6.Base {
12792
12792
  // don't expose
12793
12793
  });
12794
12794
  const client = await this.platform.getClient();
12795
- console.log(`Layout::toConfig() called!`);
12796
12795
  return client.dispatch('get-frame-snapshot', {
12797
12796
  target: this.identity
12798
12797
  });
@@ -12842,7 +12841,7 @@ class Layout extends base_1$6.Base {
12842
12841
  // don't expose
12843
12842
  });
12844
12843
  const client = await __classPrivateFieldGet$5(this, _Layout_layoutClient, "f").getValue();
12845
- const root = await client.getRoot(this.identity);
12844
+ const root = await client.getRoot('layoutName' in this.identity ? this.identity : undefined);
12846
12845
  return layout_entities_1.LayoutNode.getEntity(root, client);
12847
12846
  }
12848
12847
  }
@@ -12860,7 +12859,7 @@ var __classPrivateFieldSet$4 = (commonjsGlobal && commonjsGlobal.__classPrivateF
12860
12859
  if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
12861
12860
  return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
12862
12861
  };
12863
- var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
12862
+ var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_getBackCompatLayoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
12864
12863
  Object.defineProperty(Factory$2, "__esModule", { value: true });
12865
12864
  Factory$2.LayoutModule = void 0;
12866
12865
  const base_1$5 = base$1;
@@ -12923,39 +12922,53 @@ class LayoutModule extends base_1$5.Base {
12923
12922
  throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
12924
12923
  }
12925
12924
  __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
12926
- __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayout(this.fin, this.wire, options), "f");
12927
- // back-compat ONLY if layoutManagerOverride not provided
12925
+ __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
12926
+ // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
12927
+ const platformClient = await this.fin.Platform.getCurrentSync().getClient();
12928
+ const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
12929
+ await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
12928
12930
  if (!options.layoutManagerOverride) {
12929
- const layoutInstance = await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").resolveLayout();
12930
- const layout = this.wrapSync(layoutInstance.identity);
12931
- // Backward compat - undocumented / not typed layoutInstance as layoutManager
12932
- return Object.assign(layout, { layoutManager: layoutInstance });
12931
+ return __classPrivateFieldGet$4(this, _LayoutModule_getBackCompatLayoutManager, "f").call(this, this.fin);
12933
12932
  }
12934
- // Warn user if they do not create any layouts in the next 10 seconds
12933
+ // warn user if they do not call create() in the next 30 seconds
12935
12934
  setTimeout(() => {
12936
- const layoutSize = Object.keys(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").getLayouts()).length;
12937
- if (layoutSize === 0) {
12938
- console.warn(`[Layout.init] Layout.init was called but no layouts have been created yet. Make sure you ` +
12935
+ if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").size() === 0) {
12936
+ console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
12939
12937
  `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
12940
12938
  }
12941
- }, 10000);
12939
+ }, 30000);
12942
12940
  return this.wrapSync(this.fin.me.identity);
12943
12941
  };
12942
+ _LayoutModule_getBackCompatLayoutManager.set(this, async (fin) => {
12943
+ let layoutManager;
12944
+ let resolve;
12945
+ const layoutResolved = new Promise((r) => {
12946
+ resolve = r;
12947
+ });
12948
+ // wait for a layout to be created
12949
+ await fin.me.once('layout-ready', async ({ layoutIdentity }) => {
12950
+ layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
12951
+ // Backward compat - undocumented / not typed openfin-layout as layoutManager
12952
+ // TODO: eventually deprecate this
12953
+ resolve(Object.assign(this.wrapSync(layoutIdentity), { layoutManager }));
12954
+ });
12955
+ return layoutResolved;
12956
+ });
12944
12957
  /**
12945
12958
  * Returns the layout manager for the current window
12946
12959
  * @returns
12947
12960
  */
12948
12961
  this.getCurrentLayoutManagerSync = () => {
12949
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
12962
+ __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.getCurrentLayoutManagerSync()`);
12950
12963
  // @ts-expect-error User may have implemented their own snapshot type when overriding LayoutManager
12951
12964
  return __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f");
12952
12965
  };
12953
12966
  this.create = async (options) => {
12954
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
12967
+ __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.create()`);
12955
12968
  return this.wire.environment.createLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
12956
12969
  };
12957
12970
  this.destroy = async (layoutIdentity) => {
12958
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
12971
+ __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.destroy()`);
12959
12972
  return this.wire.environment.destroyLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
12960
12973
  };
12961
12974
  }
@@ -13054,9 +13067,9 @@ class LayoutModule extends base_1$5.Base {
13054
13067
  }
13055
13068
  }
13056
13069
  Factory$2.LayoutModule = LayoutModule;
13057
- _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized() {
13070
+ _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_getBackCompatLayoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized(method) {
13058
13071
  if (!__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")) {
13059
- throw new Error('You must call init before using this API');
13072
+ throw new Error(`You must call init before using the API ${method}`);
13060
13073
  }
13061
13074
  };
13062
13075
 
@@ -13067,7 +13080,7 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layou
13067
13080
  * * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
13068
13081
  * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
13069
13082
  *
13070
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
13083
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
13071
13084
  * both of these were documented on the same page.
13072
13085
  *
13073
13086
  * @packageDocumentation
@@ -13348,7 +13361,7 @@ Factory$3.PlatformModule = PlatformModule;
13348
13361
  * * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
13349
13362
  * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
13350
13363
  *
13351
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
13364
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
13352
13365
  * both of these were documented on the same page.
13353
13366
  *
13354
13367
  * @packageDocumentation
@@ -14755,7 +14768,7 @@ function requireInteropBroker () {
14755
14768
  * // }
14756
14769
  * ```
14757
14770
  *
14758
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
14771
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
14759
14772
  *
14760
14773
  * @param contextForIntent Data passed between entities and applications.
14761
14774
  * @param clientIdentity Identity of the Client making the request.
@@ -16558,7 +16571,7 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
16558
16571
  * * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
16559
16572
  * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
16560
16573
  *
16561
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
16574
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
16562
16575
  * both of these were documented on the same page.
16563
16576
  *
16564
16577
  * @packageDocumentation
@@ -17502,7 +17515,7 @@ function requireNodeEnv () {
17502
17515
  getRtcPeer() {
17503
17516
  throw new Error('Method not implemented.');
17504
17517
  }
17505
- async initLayout() {
17518
+ async initLayoutManager() {
17506
17519
  throw new Error('Method not implemented.');
17507
17520
  }
17508
17521
  async createLayout() {
@@ -17511,6 +17524,9 @@ function requireNodeEnv () {
17511
17524
  async destroyLayout() {
17512
17525
  throw new Error('Method not implemented.');
17513
17526
  }
17527
+ async resolveLayout() {
17528
+ throw new Error('Method not implemented.');
17529
+ }
17514
17530
  async initPlatform() {
17515
17531
  throw new Error('Method not implemented.');
17516
17532
  }
@@ -18044,18 +18060,6 @@ var application = {};
18044
18060
  * @packageDocumentation
18045
18061
  */
18046
18062
  Object.defineProperty(application, "__esModule", { value: true });
18047
- application.ApplicationWindowEventTypes = void 0;
18048
- /**
18049
- * Array of valid `type` values for an {@link ApplicationWindowEvent}.
18050
- */
18051
- application.ApplicationWindowEventTypes = [
18052
- 'window-alert-requested',
18053
- 'window-created',
18054
- 'window-end-load',
18055
- 'window-not-responding',
18056
- 'window-responding',
18057
- 'window-start-load'
18058
- ];
18059
18063
 
18060
18064
  var base = {};
18061
18065