@openfin/fdc3-api 36.79.5 → 36.79.10

package/out/fdc3-api-alpha.d.ts

@@ -97,7 +97,10 @@ declare type Api = {
         enableDeprecatedSharedName?: boolean;
     };
     /**
-     *  Prevent fin API injection. If 'none', `fin` won't be available in this context.
+     * Configure injection of the `fin` API in this context.
+     *
+     * * 'none': The `fin` API will be not available in this context.
+     * * 'global': The entire `fin` API will be available in this context.
      */
     fin?: InjectionType;
 };
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
 
 /**
  * @interface
+ *
+ * Rules for domain-conditional `fin` API injection.
  */
 declare type ApiInjection = {
+    /**
+     * Injection setting for the `fin` API for contexts on a matched domain.
+     *
+     * * 'none': The `fin` API will be not available.
+     * * 'global': The entire `fin` API will be available.
+     *
+     * @defaultValue 'global'
+     */
     fin: InjectionType;
 };
 
@@ -858,7 +871,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';
 };
 
@@ -1712,7 +1725,7 @@ declare type BaseConfig = {
  */
 declare type BaseContentCreationRule = {
     /**
-     * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
+     * List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
      * behavior should be used
      */
     match: MatchPattern[];
@@ -1725,13 +1738,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
@@ -1784,14 +1814,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 {
@@ -3608,13 +3646,13 @@ declare type ConstWindowOptions = {
     /**
      * Restrict navigation to URLs that match an allowed pattern.
      * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
-     * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
+     * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
      */
     contentNavigation: ContentNavigation;
     /**
      * Restrict redirects to URLs that match an allowed pattern.
      * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
-     * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
+     * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
      */
     contentRedirect: Partial<ContentRedirect>;
     /**
@@ -4159,7 +4197,7 @@ declare interface ContentItem extends EventEmitter_2 {
 /**
  * Restrict navigation to URLs that match an allowed pattern.
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
  *
  * @interface
  */
@@ -4168,7 +4206,7 @@ declare type ContentNavigation = NavigationRules;
 /**
  * Restrict redirects to URLs that match an allowed pattern.
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
  *
  * @interface
  */
@@ -4570,7 +4608,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';
 };
 
@@ -4772,19 +4810,42 @@ declare type DisplayMetadata_3 = {
 
 /**
  * @interface
- * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+ * Defines application settings that vary by the domain of the current context.
+ *
+ * @remarks Only the first rule in the array that matches the current URL is applied.  Multiple behaviors for the same
+ * domain should be represented with a single rule.
  */
 declare type DomainSettings = {
+    /**
+     * {@inheritDoc DomainSettingsRule}
+     */
     rules: DomainSettingsRule[];
 };
 
 /**
  * @interface
+ *
+ * Defines domain-conditional settings for an OpenFin application.
  */
 declare type DomainSettingsRule = {
+    /**
+     * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
+     * the domain(s) for which the rule applies.
+     */
     match: string[];
+    /**
+     * Settings applied when a webcontents has been navigated to a matched domain.
+     */
     options: {
+        /**
+         * {@inheritDoc FileDownloadSettings}
+         *
+         * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
+         */
         downloadSettings?: FileDownloadSettings;
+        /**
+         * {@inheritDoc ApiInjection}
+         */
         api?: ApiInjection;
     };
 };
@@ -4823,9 +4884,20 @@ declare type DownloadPreloadOption = {
 
 /**
  * @interface
+ *
+ * A rule governing domain-conditional download behavior.
  */
 declare type DownloadRule = {
+    /**
+     * {@inheritDoc FileDownloadBehaviorNames}
+     */
     behavior: FileDownloadBehaviorNames;
+    /**
+     * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
+     * the domain(s) for which the rule applies.
+     *
+     * @remarks The match is evaluated against the URL of the *download*.
+     */
     match: string[];
 };
 
@@ -5080,6 +5152,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 
 declare interface Environment {
     initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
+    applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
     createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
     resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5121,14 +5194,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).
  */
@@ -5136,7 +5209,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 = {
@@ -5145,7 +5218,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).
  */
@@ -5153,7 +5226,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'> & {
@@ -5170,21 +5243,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 = {
@@ -5193,13 +5266,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;
@@ -5857,6 +5927,9 @@ declare type FetchManifestPayload = {
     manifestUrl: string;
 };
 
+/**
+ * Whether file downloads raise a user prompt.
+ */
 declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
 
 /**
@@ -5939,9 +6012,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
 };
 
 /**
- * @interface
+ * Domain-conditional rules for file downloads.
+ *
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
  */
 declare type FileDownloadSettings = {
+    /**
+     * {@inheritDoc DownloadRule}
+     */
     rules: DownloadRule[];
 };
 
@@ -6378,6 +6456,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
 
 declare namespace GlobalHotkeyEvents {
     export {
+        BaseEvent_8 as BaseEvent,
         RegisteredEvent,
         UnregisteredEvent,
         Event_9 as Event,
@@ -6865,7 +6944,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;
@@ -7004,9 +7083,10 @@ declare type InitPlatformOptions = {
 };
 
 /**
- * * 'none': The `fin` API will be not available from within this context.
- * * 'global': The entire `fin` API will be available from within this context.
- * @defaultValue 'global'
+ * Injection setting for the `fin` API.
+ *
+ * * 'none': The `fin` API will be not available.
+ * * 'global': The entire `fin` API will be available.
  */
 declare type InjectionType = 'none' | 'global';
 
@@ -8895,16 +8975,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.LayoutIdentity;
-    ofViews: (OpenFin.Identity & {
+    ofViews: {
+        identity: OpenFin.Identity;
         entityType: 'view';
-    })[];
+    }[];
 };
 
 /**
@@ -9272,9 +9353,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
     layoutIdentity: OpenFin.LayoutIdentity;
-    views: (OpenFin.Identity & {
+    views: {
+        identity: OpenFin.Identity;
         success: boolean;
-    })[];
+        error?: Error;
+    }[];
 };
 
 /**
@@ -9650,7 +9733,7 @@ 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.MonitorInfo & {
+declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
@@ -9707,7 +9790,7 @@ declare type MutableViewOptions = {
     /**
      * Restrict navigation to URLs that match an allowed pattern.
      * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
-     * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
+     * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
      */
     contentNavigation: ContentNavigation;
     contentRedirect: ContentRedirect;
@@ -10389,7 +10472,7 @@ declare namespace OpenFin {
         AppVersionCompleteEvent,
         AppVersionRuntimeStatusEvent,
         Events,
-        BaseEvent_9 as BaseEvent,
+        BaseEvent_10 as BaseEvent,
         WebContentsEvent_2 as WebContentsEvent,
         SystemEvent_2 as SystemEvent,
         ApplicationEvent_2 as ApplicationEvent,
@@ -12847,7 +12930,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';
 };
 
@@ -13269,7 +13352,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';
 };
@@ -15203,7 +15286,7 @@ declare namespace SystemEvents {
     export {
         NotRequested,
         ExcludeRequested,
-        BaseEvent_8 as BaseEvent,
+        BaseEvent_9 as BaseEvent,
         IdleStateChangedEvent,
         IdleEvent,
         MonitorInfoChangedEvent,
@@ -15681,7 +15764,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';
 };