@openfin/core 34.78.73 → 34.78.75

package/out/mock-alpha.d.ts

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
 };
@@ -875,7 +884,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
  * Generated when an application is created.
  * @interface
  */
-declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
+declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
     type: 'application-created';
 };
 
@@ -1733,13 +1742,30 @@ declare type BaseContentCreationRule = {
 /**
  * A base OpenFin event.  All OpenFin event payloads extend this type.
  *
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys.  Within each
+ * `topic`, the `type` key is unique.
+ *
  * @interface
  */
 declare type BaseEvent = {
+    /**
+     * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
+     *
+     * @remarks {@link OpenFin.Frame} is represented as `iframe`.
+     */
     topic: string;
+    /**
+     * The type of event that was raised.  Equal to the typename of the event payload in "kebab case".
+     *
+     * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
+     * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
+     * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
+     */
     type: string;
 };
 
+declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
+
 /**
  * A base Channel event.
  * @interface
@@ -1792,14 +1818,22 @@ declare type BaseEvent_7 = NamedEvent & {
 };
 
 /**
- * Base type for events emitting on the `system` topic
+ * Base type for events emitting on the `global-hotkey` topic.
+ *
  * @interface
  */
 declare type BaseEvent_8 = BaseEvents.BaseEvent & {
-    topic: 'system';
+    topic: 'global-hotkey';
+    hotkey: string;
 };
 
-declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
+/**
+ * Base type for events emitting on the `system` topic
+ * @interface
+ */
+declare type BaseEvent_9 = BaseEvents.BaseEvent & {
+    topic: 'system';
+};
 
 declare namespace BaseEvents {
     export {
@@ -4450,6 +4484,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -4598,7 +4658,7 @@ declare interface DesktopAgent_2 {
  * Generated when the desktop icon is clicked while it's already running.
  * @interface
  */
-declare type DesktopIconClickedEvent = BaseEvent_8 & {
+declare type DesktopIconClickedEvent = BaseEvent_9 & {
     type: 'desktop-icon-clicked';
 };
 
@@ -5089,6 +5149,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 
 declare interface Environment {
     initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
     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>;
@@ -5130,14 +5191,14 @@ declare type ErrorPlainObject = {
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}.  Events are
- *  discriminated by {@link Event.type | their type}.  Event payloads unique to `Platform` can be found
+ *  discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `Platform` can be found
  *  under the {@link OpenFin.PlatformEvents} namespace.
  */
 declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}.  Events are
- *  discriminated by {@link SystemEvent.type | their type}.  Event payloads unique to `System` can be found
+ *  discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `System` can be found
  *  under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
  *  from which they propagate).
  */
@@ -5145,7 +5206,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
 
 /**
  * [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
- * discriminated by {@link Event.type | their type}.  Event payloads unique to `Channel` can be found
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `Channel` can be found
  * under the {@link OpenFin.ChannelEvents} namespace.
  */
 declare type Event_2 = {
@@ -5154,7 +5215,7 @@ declare type Event_2 = {
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}.  Events are
- *  discriminated by {@link Event.type | their type}.  Event payloads unique to `Application` can be found
+ *  discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `Application` can be found
  *  under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
  *  from which they propagate).
  */
@@ -5162,7 +5223,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}.  Events are
- *  discriminated by {@link Event.type | their type}.  Event payloads unique to `View` can be found
+ *  discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `View` can be found
  *  under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5179,21 +5240,21 @@ declare type Event_5<Topic extends string> = {
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}.  Events are
- *  discriminated by {@link Event.type | their type}.  Event payloads unique to `Window` can be found
+ *  discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `Window` can be found
  *  under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
  */
 declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}.  Events are
- *  discriminated by {@link ExternalApplicationEvent.type | their type}.  Event payloads unique to `ExternalApplication` can be found
+ *  discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `ExternalApplication` can be found
  *  under the {@link OpenFin.ExternalApplicationEvents} namespace.
  */
 declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}.  Events are
- *  discriminated by {@link _Frame.type | their type}.  Event payloads unique to `Frame` can be found
+ *  discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `Frame` can be found
  *  under the {@link OpenFin.FrameEvents} namespace.
  */
 declare type Event_8 = {
@@ -5202,13 +5263,10 @@ declare type Event_8 = {
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}.  Events are
- *  discriminated by {@link Event.type | their type}.  Event payloads unique to `GlobalHotkey` can be found
+ *  discriminated by {@link BaseEvents.BaseEvent.type | their type}.  Event payloads unique to `GlobalHotkey` can be found
  *  under the {@link OpenFin.GlobalHotkeyEvents} namespace.
  */
-declare type Event_9 = {
-    topic: 'global-hotkey';
-    hotkey: 'string';
-} & (RegisteredEvent | UnregisteredEvent);
+declare type Event_9 = RegisteredEvent | UnregisteredEvent;
 
 declare class EventAggregator extends EmitterMap {
     dispatchEvent: (message: Message<any>) => boolean;
@@ -6207,6 +6265,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
 
 declare namespace GlobalHotkeyEvents {
     export {
+        BaseEvent_8 as BaseEvent,
         RegisteredEvent,
         UnregisteredEvent,
         Event_9 as Event,
@@ -6694,7 +6753,7 @@ declare type IdleEvent = IdleStateChangedEvent;
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
  * @interface
  */
-declare type IdleStateChangedEvent = BaseEvent_8 & {
+declare type IdleStateChangedEvent = BaseEvent_9 & {
     type: 'idle-state-changed';
     elapsedTime: number;
     isIdle: boolean;
@@ -7721,7 +7780,7 @@ declare type InteropBrokerDisconnectionEvent = {
  * @interface
  */
 declare type InteropBrokerOptions = {
-    contextGroups?: ContextGroupInfo;
+    contextGroups?: ContextGroupInfo[];
     logging?: InteropLoggingOptions;
 };
 
@@ -8863,16 +8922,17 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * 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.
+ * Generated after a layout is created and all of its views have either finished or failed navigation
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    ofViews: (OpenFin_2.Identity & {
+    ofViews: {
+        identity: OpenFin_2.Identity;
         entityType: 'view';
-    })[];
+    }[];
 };
 
 /**
@@ -9240,9 +9300,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    views: (OpenFin_2.Identity & {
+    views: {
+        identity: OpenFin_2.Identity;
         success: boolean;
-    })[];
+        error?: Error;
+    }[];
 };
 
 /**
@@ -9618,10 +9680,17 @@ declare type MonitorInfo = {
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
  * @interface
  */
-declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
+declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10337,6 +10406,7 @@ declare namespace OpenFin_2 {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,
@@ -10352,7 +10422,7 @@ declare namespace OpenFin_2 {
         AppVersionCompleteEvent,
         AppVersionRuntimeStatusEvent,
         Events,
-        BaseEvent_9 as BaseEvent,
+        BaseEvent_10 as BaseEvent,
         WebContentsEvent_2 as WebContentsEvent,
         SystemEvent_2 as SystemEvent,
         ApplicationEvent_2 as ApplicationEvent,
@@ -12811,7 +12881,7 @@ declare type RectangleByEdgePositions = {
  * Generated when a hotkey has been registered with the operating system.
  * @interface
  */
-declare type RegisteredEvent = BaseEvent & {
+declare type RegisteredEvent = BaseEvent_8 & {
     type: 'registered';
 };
 
@@ -13233,7 +13303,7 @@ declare type ServiceIdentifier = {
  * Generated on changes to a user’s local computer session.
  * @interface
  */
-declare type SessionChangedEvent = BaseEvent_8 & {
+declare type SessionChangedEvent = BaseEvent_9 & {
     type: 'session-changed';
     reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
 };
@@ -15227,7 +15297,7 @@ declare namespace SystemEvents {
     export {
         NotRequested,
         ExcludeRequested,
-        BaseEvent_8 as BaseEvent,
+        BaseEvent_9 as BaseEvent,
         IdleStateChangedEvent,
         IdleEvent,
         MonitorInfoChangedEvent,
@@ -15705,7 +15775,7 @@ declare interface TypedEventEmitter<Event extends {
  * Generated when a hotkey has been unregistered with the operating system.
  * @interface
  */
-declare type UnregisteredEvent = BaseEvent & {
+declare type UnregisteredEvent = BaseEvent_8 & {
     type: 'unregistered';
 };