@openfin/core 35.78.5 → 35.78.11

package/out/mock-alpha.d.ts

@@ -3636,7 +3636,7 @@ declare type ConstWindowOptions = {
     /**
      * @defaultValue true
      *
-     * Toggling off would keep the Window alive even if all its Views were closed.
+     * Setting this to false would keep the Window alive even if all its Views were closed.
      * This is meant for advanced users and should be used with caution.
      * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
      * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3646,7 +3646,8 @@ declare type ConstWindowOptions = {
     /**
      * @defaultValue 'all'
      *
-     * 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'.
+     * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
+     +    * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
      * **NOTE:** - This option is ignored in non-Platforms apps.
      */
     viewsPreventingClose: 'all' | 'layout';
@@ -4593,6 +4594,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
     type: 'destroyed';
 };
 
+/**
+ * @interface
+ */
+declare type DeviceInfo = {
+    vendorId: string | number;
+    productId: string | number;
+};
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -5053,7 +5062,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<{
+        singleInstance: any | undefined;
+        layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>;
+    }>;
     createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
@@ -7433,7 +7445,7 @@ declare class InteropBroker extends Base {
      * // }
      * ```
      *
-     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
+     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
      *
      * @param contextForIntent Data passed between entities and applications.
      * @param clientIdentity Identity of the Client making the request.
@@ -8840,8 +8852,6 @@ declare type LayoutInitializedEvent = BaseEvent_5 & {
     })[];
 };
 
-/* Excluded from this release type: LayoutInstance */
-
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -8869,7 +8879,7 @@ declare type LayoutItemConfig = {
  *
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
+ * Responsible for aggergating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -8893,16 +8903,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
      * @throws if Object.keys(snapshot).length > 1
      */
     applyLayoutSnapshot(snapshot: T): Promise<void>;
-    /**
-     * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
-     * contains a single layout.
-     *
-     * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
-     * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
-     *
-     * @param snapshot
-     * @throws if Object.keys(snapshot).length > 1
-     */
     /**
      * @experimental
      *
@@ -8923,31 +8923,28 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      *
-     * @param layoutIdentity
-     * @returns
-     */
-    resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
-    /**
-     * @experimental
+     * A hook provided to the consumer when it's time to remove a layout. Use this hook to
+     * update your local state and remove the layout for the given LayoutIdentity. Note that
+     * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
+     * signify to your application it's time to destroy this layout.
      *
-     * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
-     * Throws if it does not exist.
-     * @param layoutName
-     * @returns
+     * 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.
+     *
+     * @param LayoutIdentity
      */
-    getLayoutByName(layoutName: string): LayoutInstance;
+    removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
     /**
      * @experimental
      */
-    getLayouts(): Record<string, LayoutInstance>;
+    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
+    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
     /**
      * @experimental
      */
-    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
+    size(): number;
 }
 
 /**
@@ -10132,6 +10129,7 @@ declare namespace OpenFin_2 {
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
+        DeviceInfo,
         Permissions_2 as Permissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
@@ -10289,7 +10287,6 @@ declare namespace OpenFin_2 {
         InitLayoutOptions,
         LayoutManagerConstructor,
         LayoutManagerOverride,
-        LayoutInstance,
         LayoutManager,
         CreateLayoutOptions,
         PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10481,6 +10478,7 @@ declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
     webAPIs?: WebPermission[];
+    devices?: DeviceInfo[];
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -17647,7 +17645,7 @@ declare namespace WebContentsEvents {
  * `clipboard-read`: Request access to read from the clipboard.<br>
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
  */
-declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
+declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
 
 /**
  * Object representing headers and their values, where the

package/out/mock-beta.d.ts

@@ -3636,7 +3636,7 @@ declare type ConstWindowOptions = {
     /**
      * @defaultValue true
      *
-     * Toggling off would keep the Window alive even if all its Views were closed.
+     * Setting this to false would keep the Window alive even if all its Views were closed.
      * This is meant for advanced users and should be used with caution.
      * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
      * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3646,7 +3646,8 @@ declare type ConstWindowOptions = {
     /**
      * @defaultValue 'all'
      *
-     * 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'.
+     * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
+     +    * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
      * **NOTE:** - This option is ignored in non-Platforms apps.
      */
     viewsPreventingClose: 'all' | 'layout';
@@ -4593,6 +4594,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
     type: 'destroyed';
 };
 
+/**
+ * @interface
+ */
+declare type DeviceInfo = {
+    vendorId: string | number;
+    productId: string | number;
+};
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -5053,7 +5062,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<{
+        singleInstance: any | undefined;
+        layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>;
+    }>;
     createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
@@ -7433,7 +7445,7 @@ declare class InteropBroker extends Base {
      * // }
      * ```
      *
-     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
+     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
      *
      * @param contextForIntent Data passed between entities and applications.
      * @param clientIdentity Identity of the Client making the request.
@@ -8840,8 +8852,6 @@ declare type LayoutInitializedEvent = BaseEvent_5 & {
     })[];
 };
 
-/* Excluded from this release type: LayoutInstance */
-
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -8869,7 +8879,7 @@ declare type LayoutItemConfig = {
  *
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
+ * Responsible for aggergating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -8893,16 +8903,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
      * @throws if Object.keys(snapshot).length > 1
      */
     applyLayoutSnapshot(snapshot: T): Promise<void>;
-    /**
-     * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
-     * contains a single layout.
-     *
-     * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
-     * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
-     *
-     * @param snapshot
-     * @throws if Object.keys(snapshot).length > 1
-     */
     /**
      * @experimental
      *
@@ -8923,31 +8923,28 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      *
-     * @param layoutIdentity
-     * @returns
-     */
-    resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
-    /**
-     * @experimental
+     * A hook provided to the consumer when it's time to remove a layout. Use this hook to
+     * update your local state and remove the layout for the given LayoutIdentity. Note that
+     * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
+     * signify to your application it's time to destroy this layout.
      *
-     * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
-     * Throws if it does not exist.
-     * @param layoutName
-     * @returns
+     * 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.
+     *
+     * @param LayoutIdentity
      */
-    getLayoutByName(layoutName: string): LayoutInstance;
+    removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
     /**
      * @experimental
      */
-    getLayouts(): Record<string, LayoutInstance>;
+    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
+    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
     /**
      * @experimental
      */
-    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
+    size(): number;
 }
 
 /**
@@ -10132,6 +10129,7 @@ declare namespace OpenFin_2 {
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
+        DeviceInfo,
         Permissions_2 as Permissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
@@ -10289,7 +10287,6 @@ declare namespace OpenFin_2 {
         InitLayoutOptions,
         LayoutManagerConstructor,
         LayoutManagerOverride,
-        LayoutInstance,
         LayoutManager,
         CreateLayoutOptions,
         PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10481,6 +10478,7 @@ declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
     webAPIs?: WebPermission[];
+    devices?: DeviceInfo[];
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -17647,7 +17645,7 @@ declare namespace WebContentsEvents {
  * `clipboard-read`: Request access to read from the clipboard.<br>
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
  */
-declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
+declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
 
 /**
  * Object representing headers and their values, where the

package/out/mock-public.d.ts

@@ -3636,7 +3636,7 @@ declare type ConstWindowOptions = {
     /**
      * @defaultValue true
      *
-     * Toggling off would keep the Window alive even if all its Views were closed.
+     * Setting this to false would keep the Window alive even if all its Views were closed.
      * This is meant for advanced users and should be used with caution.
      * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
      * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3646,7 +3646,8 @@ declare type ConstWindowOptions = {
     /**
      * @defaultValue 'all'
      *
-     * 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'.
+     * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
+     +    * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
      * **NOTE:** - This option is ignored in non-Platforms apps.
      */
     viewsPreventingClose: 'all' | 'layout';
@@ -4593,6 +4594,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
     type: 'destroyed';
 };
 
+/**
+ * @interface
+ */
+declare type DeviceInfo = {
+    vendorId: string | number;
+    productId: string | number;
+};
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -5053,7 +5062,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<{
+        singleInstance: any | undefined;
+        layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>;
+    }>;
     createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
@@ -7433,7 +7445,7 @@ declare class InteropBroker extends Base {
      * // }
      * ```
      *
-     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
+     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
      *
      * @param contextForIntent Data passed between entities and applications.
      * @param clientIdentity Identity of the Client making the request.
@@ -8840,8 +8852,6 @@ declare type LayoutInitializedEvent = BaseEvent_5 & {
     })[];
 };
 
-/* Excluded from this release type: LayoutInstance */
-
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -8869,7 +8879,7 @@ declare type LayoutItemConfig = {
  *
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
+ * Responsible for aggergating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -8893,16 +8903,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
      * @throws if Object.keys(snapshot).length > 1
      */
     applyLayoutSnapshot(snapshot: T): Promise<void>;
-    /**
-     * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
-     * contains a single layout.
-     *
-     * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
-     * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
-     *
-     * @param snapshot
-     * @throws if Object.keys(snapshot).length > 1
-     */
     /**
      * @experimental
      *
@@ -8923,31 +8923,28 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      *
-     * @param layoutIdentity
-     * @returns
-     */
-    resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
-    /**
-     * @experimental
+     * A hook provided to the consumer when it's time to remove a layout. Use this hook to
+     * update your local state and remove the layout for the given LayoutIdentity. Note that
+     * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
+     * signify to your application it's time to destroy this layout.
      *
-     * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
-     * Throws if it does not exist.
-     * @param layoutName
-     * @returns
+     * 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.
+     *
+     * @param LayoutIdentity
      */
-    getLayoutByName(layoutName: string): LayoutInstance;
+    removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
     /**
      * @experimental
      */
-    getLayouts(): Record<string, LayoutInstance>;
+    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
+    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
     /**
      * @experimental
      */
-    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
+    size(): number;
 }
 
 /**
@@ -10132,6 +10129,7 @@ declare namespace OpenFin_2 {
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
+        DeviceInfo,
         Permissions_2 as Permissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
@@ -10289,7 +10287,6 @@ declare namespace OpenFin_2 {
         InitLayoutOptions,
         LayoutManagerConstructor,
         LayoutManagerOverride,
-        LayoutInstance,
         LayoutManager,
         CreateLayoutOptions,
         PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10481,6 +10478,7 @@ declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
     webAPIs?: WebPermission[];
+    devices?: DeviceInfo[];
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -17647,7 +17645,7 @@ declare namespace WebContentsEvents {
  * `clipboard-read`: Request access to read from the clipboard.<br>
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
  */
-declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
+declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
 
 /**
  * Object representing headers and their values, where the

package/out/mock.d.ts

@@ -3730,7 +3730,7 @@ declare type ConstWindowOptions = {
     /**
      * @defaultValue true
      *
-     * Toggling off would keep the Window alive even if all its Views were closed.
+     * Setting this to false would keep the Window alive even if all its Views were closed.
      * This is meant for advanced users and should be used with caution.
      * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
      * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3740,7 +3740,8 @@ declare type ConstWindowOptions = {
     /**
      * @defaultValue 'all'
      *
-     * 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'.
+     * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
+     +    * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
      * **NOTE:** - This option is ignored in non-Platforms apps.
      */
     viewsPreventingClose: 'all' | 'layout';
@@ -4687,6 +4688,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
     type: 'destroyed';
 };
 
+/**
+ * @interface
+ */
+declare type DeviceInfo = {
+    vendorId: string | number;
+    productId: string | number;
+};
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -5152,7 +5161,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<{
+        singleInstance: any | undefined;
+        layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>;
+    }>;
     createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
@@ -7577,7 +7589,7 @@ declare class InteropBroker extends Base {
      * // }
      * ```
      *
-     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
+     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
      *
      * @param contextForIntent Data passed between entities and applications.
      * @param clientIdentity Identity of the Client making the request.
@@ -8993,28 +9005,6 @@ declare type LayoutInitializedEvent = BaseEvent_5 & {
     })[];
 };
 
-/**
- * @interface @experimental @internal
- *
- * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
- *
- * Responsible for handling all layout management and renderering
- */
-declare type LayoutInstance = {
-    identity: LayoutIdentity;
-    getFrameSnapshot: () => Promise<LayoutOptions>;
-    addView: (payload: AddViewOptions) => Promise<View_2>;
-    closeView: (viewIdentity: Identity_5) => Promise<void>;
-    removeView: (viewConfig: Identity_5 | ViewState) => Promise<View_2>;
-    replaceView: (payload: ReplaceViewOptions) => Promise<View_2>;
-    getViews: () => LayoutComponent[];
-    getCurrentViews: () => Identity_5[];
-    startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
-    applyPreset: (payload: PresetLayoutOptions_2) => void;
-    isVisible: () => boolean;
-    destroy: () => Promise<void>;
-};
-
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -9042,7 +9032,7 @@ declare type LayoutItemConfig = {
  *
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
+ * Responsible for aggergating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -9066,16 +9056,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
      * @throws if Object.keys(snapshot).length > 1
      */
     applyLayoutSnapshot(snapshot: T): Promise<void>;
-    /**
-     * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
-     * contains a single layout.
-     *
-     * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
-     * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
-     *
-     * @param snapshot
-     * @throws if Object.keys(snapshot).length > 1
-     */
     /**
      * @experimental
      *
@@ -9096,31 +9076,28 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      *
-     * @param layoutIdentity
-     * @returns
-     */
-    resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
-    /**
-     * @experimental
+     * A hook provided to the consumer when it's time to remove a layout. Use this hook to
+     * update your local state and remove the layout for the given LayoutIdentity. Note that
+     * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
+     * signify to your application it's time to destroy this layout.
      *
-     * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
-     * Throws if it does not exist.
-     * @param layoutName
-     * @returns
+     * 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.
+     *
+     * @param LayoutIdentity
      */
-    getLayoutByName(layoutName: string): LayoutInstance;
+    removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
     /**
      * @experimental
      */
-    getLayouts(): Record<string, LayoutInstance>;
+    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
+    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
     /**
      * @experimental
      */
-    isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
+    size(): number;
 }
 
 /**
@@ -10480,6 +10457,7 @@ declare namespace OpenFin_2 {
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
+        DeviceInfo,
         Permissions_2 as Permissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
@@ -10637,7 +10615,6 @@ declare namespace OpenFin_2 {
         InitLayoutOptions,
         LayoutManagerConstructor,
         LayoutManagerOverride,
-        LayoutInstance,
         LayoutManager,
         CreateLayoutOptions,
         PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10829,6 +10806,7 @@ declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
     webAPIs?: WebPermission[];
+    devices?: DeviceInfo[];
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -18188,7 +18166,7 @@ declare namespace WebContentsEvents {
  * `clipboard-read`: Request access to read from the clipboard.<br>
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
  */
-declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
+declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
 
 /**
  * Object representing headers and their values, where the

package/out/mock.js

@@ -3463,7 +3463,7 @@ function requireView () {
 		 * * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
 		 * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
 		 *
-		 * 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),
+		 * 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),
 		 * both of these were documented on the same page.
 		 *
 		 * @packageDocumentation
@@ -4604,7 +4604,7 @@ function requireApplication () {
 		 * * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
 		 * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
 		 *
-		 * 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),
+		 * 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),
 		 * both of these were documented on the same page.
 		 *
 		 * @packageDocumentation
@@ -6661,7 +6661,7 @@ function requireWindow () {
 		 * * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
 		 * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
 		 *
-		 * 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),
+		 * 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),
 		 * both of these were documented on the same page.
 		 *
 		 * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -11415,7 +11415,7 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
 	 * * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
 	 * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
 	 *
-	 * 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),
+	 * 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),
 	 * both of these were documented on the same page.
 	 *
 	 * @packageDocumentation
@@ -11666,7 +11666,7 @@ Factory$4._FrameModule = _FrameModule;
 	 * * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
 	 * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
 	 *
-	 * 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),
+	 * 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),
 	 * both of these were documented on the same page.
 	 *
 	 * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -13142,18 +13142,17 @@ class LayoutModule extends base_1$5.Base {
                 throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
             }
             __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
-            __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayout(this.fin, this.wire, options), "f");
+            const result = await this.wire.environment.initLayout(this.fin, this.wire, options);
+            __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, result.layoutManager, "f");
             // back-compat ONLY if layoutManagerOverride not provided
             if (!options.layoutManagerOverride) {
-                const layoutInstance = await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").resolveLayout();
-                const layout = this.wrapSync(layoutInstance.identity);
-                // Backward compat - undocumented / not typed layoutInstance as layoutManager
-                return Object.assign(layout, { layoutManager: layoutInstance });
+                const layout = this.wrapSync(result.singleInstance.identity);
+                // Backward compat - undocumented / not typed openfin-layout as layoutManager
+                return Object.assign(layout, { layoutManager: result.singleInstance });
             }
             // Warn user if they do not create any layouts in the next 10 seconds
             setTimeout(() => {
-                const layoutSize = Object.keys(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").getLayouts()).length;
-                if (layoutSize === 0) {
+                if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").size() === 0) {
                     console.warn(`[Layout.init] Layout.init was called but no layouts have been created yet. Make sure you ` +
                         `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
                 }
@@ -13286,7 +13285,7 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layou
 	 * * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
 	 * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
 	 *
-	 * 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),
+	 * 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),
 	 * both of these were documented on the same page.
 	 *
 	 * @packageDocumentation
@@ -13567,7 +13566,7 @@ Factory$3.PlatformModule = PlatformModule;
 	 * * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
 	 * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
 	 *
-	 * 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),
+	 * 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),
 	 * both of these were documented on the same page.
 	 *
 	 * @packageDocumentation
@@ -14974,7 +14973,7 @@ function requireInteropBroker () {
 	     * // }
 	     * ```
 	     *
-	     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
+	     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
 	     *
 	     * @param contextForIntent Data passed between entities and applications.
 	     * @param clientIdentity Identity of the Client making the request.
@@ -16777,7 +16776,7 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
 	 * * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
 	 * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
 	 *
-	 * 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),
+	 * 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),
 	 * both of these were documented on the same page.
 	 *
 	 * @packageDocumentation

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "35.78.5",
+    "version": "35.78.11",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/mock.js",