@openfin/core 34.78.54 → 34.78.57

package/out/mock.d.ts

@@ -43,6 +43,8 @@ declare type Accelerator = {
 };
 
 /**
+ * Options to use when adding a view to a {@link TabStack}.
+ *
  * @interface
  */
 declare type AddViewOptions = CreateViewTarget & {
@@ -3411,57 +3413,6 @@ declare type ClosingEvent = BaseEvent_5 & {
  */
 declare class ColumnOrRow extends LayoutNode {
     #private;
-    /**
-     * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof ColumnOrRow
-     * @instance
-     * @tutorial ColumnOrRow.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link ColumnOrRow} exists.
-     * @function exists
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.exists
-     * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.getParent
-     * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
-     * this {@link ColumnOrRow}does not exist or is the root content item.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof ColumnOrRow
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial ColumnOrRow.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof ColumnOrRow
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack
-     * @tutorial ColumnOrRow.createAdjacentStack
-     * @experimental
-     */
     /**
      * @internal
      */
@@ -3730,7 +3681,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 +3691,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';
@@ -4547,7 +4499,7 @@ declare type CreateViewPayload = {
 /**
  * @interface
  */
-declare type CreateViewTarget = LayoutIdentity & {
+declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
     /**
      * If specified, view creation will not attach to a window and caller must
      * insert the view into the layout explicitly
@@ -4687,6 +4639,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,9 +5112,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>>;
+    initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<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>;
+    resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
     writeToken(path: string, token: string): Promise<string>;
@@ -7577,7 +7538,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.
@@ -8757,7 +8718,7 @@ declare class Layout extends Base {
      * @internal
      */
     init: (options?: OpenFin_2.InitLayoutOptions) => Promise<Layout>;
-    identity: OpenFin_2.LayoutIdentity;
+    identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
     private platform;
     wire: Transport;
     /**
@@ -8976,45 +8937,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
  */
 declare type LayoutIdentity = Identity_5 & {
     /**
-     * The name of the layout an action should be targeted to. When not provided,
-     * OpenFin attempts to resolve the instance via visibility checks.
+     * The name of the layout in a given window.
      */
-    layoutName?: string;
+    layoutName: string;
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window is created, and all of its layout's views have either finished or failed
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     ofViews: (OpenFin_2.Identity & {
         entityType: 'view';
     })[];
 };
 
-/**
- * @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 +8982,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 aggregating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -9066,16 +9006,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 +9026,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      *
-     * @param layoutIdentity
-     * @returns
+     * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
+     * this method to control the target layout for Layout API calls.
+     *
+     * Example use case: You have hidden all the layouts and are showing a dialog that will
+     * execute an API call (ex: Layout.replace()) - override this method and save the
+     * "last visible" layout identity and return it.
+     *
+     * By default, OpenFin will use a series of checks to determine which Layout the API
+     * call must route to in this order of precedence:
+     * - try to resolve the layout from the layoutIdentity, throws if missing
+     * - if there is only 1 layout, resolves that one
+     * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
+     * - returns undefined
+     *
+     * @param identity
+     * @returns LayoutIdentity | undefined
      */
-    resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
+    resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
     /**
      * @experimental
      *
-     * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
-     * Throws if it does not exist.
-     * @param layoutName
-     * @returns
+     * 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.
+     *
+     * 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;
 }
 
 /**
@@ -9167,7 +9115,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrap(identity: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
+    wrap(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
     /**
      * Synchronously returns a Layout object that represents a Window's layout.
      *
@@ -9187,7 +9135,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrapSync(identity: OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
+    wrapSync(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
     /**
      * Asynchronously returns a Layout object that represents a Window's layout.
      *
@@ -9359,6 +9307,15 @@ declare abstract class LayoutNode {
     /**
      * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
      *
+     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
+     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
+     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
+     *
+     * @param views The views that will populate the new TabStack.
+     * @param options Additional options that control new TabStack creation.
+     * @returns The newly-created TabStack.
+     *
      * @example
      * ```js
      * if (!fin.me.isView) {
@@ -9393,12 +9350,15 @@ declare abstract class LayoutNode {
      * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
      *
      * ```
+     * @experimental
      */
     createAdjacentStack: (views: OpenFin_2.PlatformViewCreationOptions[], options: {
         position?: OpenFin_2.LayoutPosition;
     }) => Promise<TabStack>;
     /**
-     * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
+     * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
+     *
+     * @param edge Edge whose adjacent TabStacks will be returned.
      *
      * @example
      * ```js
@@ -9418,6 +9378,7 @@ declare abstract class LayoutNode {
      * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
      *
      * ```
+     * @experimental
      */
     getAdjacentStacks: (edge: OpenFin_2.LayoutPosition) => Promise<TabStack[]>;
 }
@@ -9512,6 +9473,9 @@ declare type LayoutOptions = {
     };
 };
 
+/**
+ * Represents the position of an item in a layout relative to another.
+ */
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
@@ -9520,11 +9484,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
 /**
- * Generated when a window and all of its layout's views have been created and can receive API calls.
+ * Generated when the layout and all of the its views have been created and can receive API calls.
  * @interface
  */
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     views: (OpenFin_2.Identity & {
         success: boolean;
     })[];
@@ -10480,6 +10445,7 @@ declare namespace OpenFin_2 {
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
+        DeviceInfo,
         Permissions_2 as Permissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
@@ -10637,7 +10603,6 @@ declare namespace OpenFin_2 {
         InitLayoutOptions,
         LayoutManagerConstructor,
         LayoutManagerOverride,
-        LayoutInstance,
         LayoutManager,
         CreateLayoutOptions,
         PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10829,6 +10794,7 @@ declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
     webAPIs?: WebPermission[];
+    devices?: DeviceInfo[];
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -11783,6 +11749,17 @@ declare interface PlatformProvider {
      * @param callerIdentity
      */
     getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.LayoutSnapshot | undefined>;
+    /**
+     * @experimental
+     *
+     * This API is called during the {@link PlatformProvider.getSnapshot()} call.
+     * Gets the current state of a particular window and its views and returns an object that
+     * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
+     * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
+     * @param identity
+     * @param callerIdentity
+     */
+    getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
     /**
      * @experimental @internal
      *
@@ -11797,7 +11774,7 @@ declare interface PlatformProvider {
      */
     createViewsForLayout(payload: {
         layout: GoldenLayout.Config;
-        target?: OpenFin_2.Identity;
+        target?: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
     }, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
     /**
      * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
@@ -13262,7 +13239,7 @@ declare type ReplaceLayoutPayload = {
     /**
      * Identity of the window whose layout will be replaced.
      */
-    target: LayoutIdentity;
+    target: Identity_5 | LayoutIdentity;
 };
 
 /**
@@ -15765,75 +15742,11 @@ declare interface TabDragListener extends EventEmitter_2 {
     contentItem: ContentItem;
 }
 
-/**
- * @typedef {string} LayoutPosition
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
- */
-/**
- * @typedef {object} StackCreationOptions
- * @summary Stack creation options.
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
- */
-/**
- * @typedef {object} TabStack~AddViewOptions
- * @summary Options to use when adding a view to a {@link TabStack}
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
- */
 /**
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
  */
 declare class TabStack extends LayoutNode {
     #private;
-    /**
-     * Determines if this {@link TabStack} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof TabStack
-     * @instance
-     * @tutorial TabStack.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link TabStack} exists.
-     * @function exists
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.exists
-     * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.getParent
-     * @returns is the root content item or does not exist.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof TabStack
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial TabStack.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof TabStack
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack.
-     * @tutorial TabStack.createAdjacentStack
-     * @experimental
-     */
     /** @internal */
     constructor(client: LayoutEntitiesClient, entityId: string);
     /**
@@ -16952,7 +16865,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin_2.Identity;
+    target: OpenFin_2.Identity | null;
     previousTarget: OpenFin_2.Identity;
     viewIdentity: OpenFin_2.Identity;
 };
@@ -18188,7 +18101,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