@openfin/core 34.78.12 → 34.78.13

package/out/mock-alpha.d.ts

@@ -1175,17 +1175,30 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * When set to `false` it will disable the same-origin policy for the app.
      */
     webSecurity: boolean;
+    /**
+     * Configuration for keyboard commands.
+     * For details and usage, see {@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands Using Keyboard Commands}.
+     */
     commands: ShortcutOverride[];
     isPlatformController: boolean;
     /**
      * @defaultValue 1000
      *
-     * Platforms Only.  The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
+     * Platforms Only. The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
      * If you do not wish for views to be pooled on your platform, set this property to zero.
      */
     maxViewPoolSize: number;
+    /**
+     * Platforms Only. Default window options apply to all platform windows.
+     */
     defaultWindowOptions: Partial<WindowOptions>;
+    /**
+     * Platforms Only. Default view options apply to all platform views.
+     */
     defaultViewOptions: Partial<ViewOptions>;
+    /**
+     * Platforms Only. The snapshot to be applied.
+     */
     snapshot: Snapshot;
     /**
      * @defaultValue false
@@ -1195,15 +1208,33 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
      */
     preventQuitOnLastWindowClosed: boolean;
+    /**
+     * Configuration for interop broker.
+     */
     interopBrokerConfiguration: InteropBrokerOptions;
+    /**
+     * @defaultValue true
+     *
+     * When set to `false` it will disable OpenFin Diagnostics for the app.
+     */
     apiDiagnostics: boolean;
+    /**
+     * Define the file download rules.
+     * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
+     */
     defaultDomainSettings: DefaultDomainSettings;
     /**
      * @defaultValue false
+     *
      * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
      * Only relevant in Windows.
      */
     enableJumpList: boolean;
+    /**
+     * @defaultValue false
+     *
+     * When set to `true`, any `beforeunload` handler set on the app will fire.
+     */
     enableBeforeUnload: boolean;
 };
 
@@ -1301,7 +1332,7 @@ declare type ApplySnapshotOptions = {
  */
 declare type ApplySnapshotPayload = {
     /**
-     * TThe snapshot to be applied.
+     * The snapshot to be applied.
      */
     snapshot: Snapshot;
     /**
@@ -1523,6 +1554,13 @@ declare class Base {
     /* Excluded from this release type: wire */
     /* Excluded from this release type: __constructor */
     protected get fin(): OpenFin_2.Fin<OpenFin_2.EntityType>;
+    /**
+     * Provides access to the OpenFin representation of the current code context (usually a document
+     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
+     *
+     * Useful for debugging in the devtools console, where this will intelligently type itself based
+     * on the context in which the devtools panel was opened.
+     */
     get me(): Identity;
     protected isNodeEnvironment: () => boolean;
     protected isOpenFinEnvironment: () => boolean;
@@ -2704,11 +2742,16 @@ declare type ClearCacheOption = {
 };
 
 /**
+ * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+ * of all possible data shapes for the entire menu, and the click handler should process
+ * these with a "reducer" pattern.
+ *
  * @interface
  */
-declare type ClickedMenuResult<T extends unknown = unknown> = {
+declare type ClickedMenuResult<Data extends unknown = unknown> = {
     result: 'clicked';
-    data: T;
+    data: Data;
 };
 
 /**
@@ -2717,7 +2760,7 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
 declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
 
 /**
- * Identity of a channel client
+ * Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
  * @interface
  */
 declare type ClientIdentity = Identity_5 & {
@@ -3087,6 +3130,11 @@ declare type ConstViewOptions = {
     zoomLevel: number;
     experimental: any;
     fdc3InteropApi?: string;
+    /**
+     * @defaultValue false
+     *
+     * When set to `true`, any `beforeunload` handler set on Views will fire.
+     */
     enableBeforeUnload: boolean;
     /**
      * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
@@ -3319,15 +3367,12 @@ declare type ContentCreationOptions = {
  * A rule for creating content in OpenFin; maps a content type to the way in which
  * newly-opened content of that type will be handled.
  *
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
- * @property { object } options Window creation options or View creation options.
  *
  * @interface
  */
 declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
     /**
-     * Behavior to use when opening matched content.
+     * Behavior to use when opening matched content. The value could be 'view' | 'window' | 'browser' | 'block'.
      */
     behavior: T;
     /**
@@ -3419,6 +3464,9 @@ declare type ContextForIntent<MetadataType = any> = Context & {
     metadata?: MetadataType;
 };
 
+/**
+ * Information for a Context Group. Contains metadata for displaying the group properly.
+ */
 /**
  * @interface
  */
@@ -3439,6 +3487,9 @@ declare type ContextGroupStates = {
     };
 };
 
+/**
+ * Subscription function for addContextHandler.
+ */
 declare type ContextHandler = (context: Context) => void;
 
 /**
@@ -5160,8 +5211,14 @@ declare type Intent<MetadataType = IntentMetadata> = {
     metadata?: MetadataType;
 };
 
+/**
+ * Subscription function for registerIntentHandler.
+ */
 declare type IntentHandler = (intent: Intent) => void;
 
+/**
+ * The type used to describe an intent within the platform.
+ */
 /**
  * @interface
  */
@@ -6469,6 +6526,9 @@ declare class InteropClient extends Base {
  */
 declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
 
+/**
+ * Information relevant to the Interop Broker.
+ */
 /**
  * @interface
  */
@@ -6968,7 +7028,13 @@ declare type LayoutColumn = LayoutItemConfig & {
  * @interface
  */
 declare type LayoutComponent = LayoutItemConfig & {
+    /**
+     * Only a component type will have this property and it should be set to view.
+     */
     componentName: 'view';
+    /**
+     * Only a component type will have this property and it represents the view options of a given component.
+     */
     componentState?: Partial<ViewCreationOptions>;
 };
 
@@ -7010,7 +7076,7 @@ declare type LayoutInitializedEvent = NamedEvent & {
 };
 
 /**
- * Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
+ * 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} or our
  * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
  *
@@ -7279,6 +7345,11 @@ declare type LayoutOptions = {
          * (not to be confused with close button on every tab).
          */
         showCloseIcon?: boolean;
+        /**
+         * @defaultValue false
+         *
+         * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
+         */
         constrainDragToHeaders?: boolean;
         /**
          * @defaultValue true
@@ -7307,6 +7378,11 @@ declare type LayoutOptions = {
          */
         preventDragIn?: boolean;
     };
+    /**
+     * Content of the layout. There can only be one top-level LayoutItem in the content array.
+     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
+     * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+     */
     content?: LayoutContent;
     dimensions?: {
         borderWidth?: number;
@@ -7471,6 +7547,9 @@ declare type ManifestInfo = {
  * @interface
  */
 declare type Margins = {
+    /**
+     * The margin type. If `custom` is chosen, you will also need to specify top, bottom, left, and right.
+     */
     marginType?: 'default' | 'none' | 'printableArea' | 'custom';
     /**
      * The top margin of the printed webpage, in pixels.
@@ -7500,20 +7579,36 @@ declare type MaximizedEvent = NamedEvent & {
     type: 'maximized';
 };
 
+/**
+ * Type of the OpenFin `me` API handle, which provides access to the OpenFin representation of the current
+ * code context (usually a document such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as
+ * to the current `Interop` context.
+ *
+ * Useful for debugging in the devtools console, where this will intelligently type itself based
+ * on the context in which the devtools panel was opened.
+ */
 declare type Me<MeType extends EntityType_3> = OpenFin_2.EntityInfo & (MeType extends 'view' ? EntityTypeHelpers<'view'> & OpenFin_2.View & WithInterop : MeType extends 'window' ? EntityTypeHelpers<'window'> & OpenFin_2.Window & WithInterop : MeType extends 'iframe' ? EntityTypeHelpers<'iframe'> & OpenFin_2.Frame & WithInterop : MeType extends 'external connection' ? EntityTypeHelpers<'external connection'> & OpenFin_2.ExternalApplication & WithInterop : EntityTypeHelpers<MeType> & WithInterop) & {
     isOpenFin: boolean;
 };
 
 /**
  * @interface
+ *
+ * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+ * of all possible data shapes for the entire menu, and the click handler should process
+ * these with a "reducer" pattern.
  */
-declare type MenuItemTemplate<T extends unknown = unknown> = {
+declare type MenuItemTemplate<Data extends unknown = unknown> = {
     /**
      * Can be `normal`, `separator`, `submenu`, or `checkbox`.
      * Defaults to 'normal' unless a 'submenu' key exists
      */
     type?: 'normal' | 'separator' | 'submenu' | 'checkbox';
     role?: 'cut' | 'copy' | 'paste' | 'toggleDevTools' | 'reload';
+    /**
+     * The text to show on the menu item. Should be left undefined for type: 'separator'
+     */
     label?: string;
     /**
      * If false, the menu item will be greyed out and unclickable.
@@ -7531,18 +7626,26 @@ declare type MenuItemTemplate<T extends unknown = unknown> = {
      * Should be specified for `submenu` type menu items. If `submenu` is specified,
      * the `type: 'submenu'` can be omitted.
      */
-    submenu?: MenuItemTemplate<T>[];
+    submenu?: MenuItemTemplate<Data>[];
     /**
      * Data to be returned if the user selects the element. Must be serializable
      */
-    data?: T;
+    data?: Data;
     /**
      * Image Data URI with image dimensions inferred from the encoded string
      */
     icon?: string;
 };
 
-declare type MenuResult<T extends unknown = unknown> = ClickedMenuResult<T> | ClosedMenuResult;
+/**
+ * Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
+ *
+ * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+ * of all possible data shapes for the entire menu, and the click handler should process
+ * these with a "reducer" pattern.
+ */
+declare type MenuResult<Data extends unknown = unknown> = ClickedMenuResult<Data> | ClosedMenuResult;
 
 declare interface Message<T> {
     action: string;
@@ -9243,9 +9346,17 @@ declare type PlatformOptions = ApplicationCreationOptions & {
     disableDefaultCommands?: boolean;
     /**
      * Strategy to assign views to process affinity by domain.
+     * * `same` - The views in the same domain will have same renderer processes.
+     * * `different` - The views in the same domain will have their own renderer processes.
      */
     viewProcessAffinityStrategy?: ProcessAffinityStrategy;
+    /**
+     * The provider url.
+     */
     providerUrl?: string;
+    /**
+     * The permissions for secured APIs.
+     */
     permissions?: Partial<Permissions_2>;
 };
 
@@ -10042,9 +10153,21 @@ declare type PrinterInfo = OpenFin_2.PrinterInfo;
  * @interface
  */
 declare type PrinterInfo_2 = {
+    /**
+     * Printer Name
+     */
     name: string;
+    /**
+     * Printer Description
+     */
     description: string;
+    /**
+     * Printer Status
+     */
     status: number;
+    /**
+     * Indicates that system's default printer.
+     */
     isDefault: boolean;
 };
 
@@ -10056,10 +10179,14 @@ declare type PrinterInfo_2 = {
 declare type PrintOptions = {
     content?: 'self';
     /**
+     * @defaultValue false
+     *
      * Disables prompting the user for print settings.
      */
     silent?: boolean;
     /**
+     * @defaultValue false
+     *
      * Includes the webpage background color and image when printing.
      */
     printBackground?: boolean;
@@ -10068,6 +10195,8 @@ declare type PrintOptions = {
      */
     deviceName?: string;
     /**
+     * @defaultValue true
+     *
      * Prints in full color (greyscale otherwise).
      */
     color?: boolean;
@@ -10076,6 +10205,8 @@ declare type PrintOptions = {
      */
     margins?: Margins;
     /**
+     * @defaultValue true
+     *
      * Prints in landscape mode (portrait otherwise).
      */
     landscape?: boolean;
@@ -11005,13 +11136,33 @@ declare type SessionChangedEvent = {
     reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
 };
 
+/**
+ * An instance of a SessionContextGroup
+ */
 /**
  * @interface
  */
 declare type SessionContextGroup = {
+    /**
+     * The SessionContextGroup's id.
+     */
     id: string;
+    /**
+     * A SessionContextGroup instance method for setting a context in the SessionContextGroup.
+     * @param context The Context to be set.
+     */
     setContext: (context: Context) => Promise<void>;
+    /**
+     * A SessionContextGroup instance method for getting the current context of a certain type.
+     * @param type The Context Type to get. If not specified the last contextType set would get used.
+     */
     getCurrentContext: (type?: string) => Promise<Context>;
+    /**
+     * A SessionContextGroup instance method for adding a handler for context change.
+     * @param handler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
+     * @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
+     *
+     */
     addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
         unsubscribe: () => void;
     }>;
@@ -11039,7 +11190,13 @@ declare type SetWindowContextPayload = {
  * @interface
  */
 declare type SharedWorkerInfo = {
+    /**
+     * The unique id of the shared worker.
+     */
     id: string;
+    /**
+     * The url of the shared worker.
+     */
     url: string;
 };
 
@@ -11077,11 +11234,27 @@ declare type ShownEvent = BaseViewEvent & {
 };
 
 /**
+ * Options for showing a popup menu
+ *
+ * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+ * of all possible data shapes for the entire menu, and the click handler should process
+ * these with a "reducer" pattern.
+ *
  * @interface
  */
-declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
-    template: MenuItemTemplate<T>[];
+declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
+    /**
+     * An array describing the menu to show.
+     */
+    template: MenuItemTemplate<Data>[];
+    /**
+     * The window x coordinate where to show the menu. Defaults to mouse position. If using must also use y.
+     */
     x?: number;
+    /**
+     * The window y coordinate where to show the menu. Defaults to mouse position. If using must also use x
+     */
     y?: number;
 };
 
@@ -11123,6 +11296,9 @@ declare type Size = TransitionBase & {
  * @interface
  */
 declare type Snapshot = {
+    /**
+     * The array of window options objects
+     */
     windows: WindowCreationOptions[];
     snapshotDetails?: {
         monitorInfo: MonitorInfo;
@@ -13087,8 +13263,17 @@ declare type Time = {
  * @interface
  */
 declare type Transition = {
+    /**
+     * The Opacity transition
+     */
     opacity?: Opacity;
+    /**
+     * The Position transition
+     */
     position?: Position;
+    /**
+     * The Size transition
+     */
     size?: Size;
 };
 
@@ -14094,6 +14279,11 @@ declare interface ViewStatuses {
  * @interface
  */
 declare type ViewVisibilityOption = {
+    /**
+     * @defaultValue false
+     *
+     * Enables or disables showing views when the layout splitter or a tab is being dragged.
+     */
     enabled?: boolean;
 };
 
@@ -14123,8 +14313,12 @@ declare type WebContent = View_2 | _Window;
 
 declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
     identity: OpenFin_2.Identity;
-    entityType: string;
-    constructor(wire: Transport, identity: OpenFin_2.Identity, entityType: string);
+    entityType: 'window' | 'view';
+    /**
+     * @param identity The identity of the {@link OpenFin.WebContentsEvents WebContents}.
+     * @param entityType The type of the {@link OpenFin.WebContentsEvents WebContents}.
+     */
+    constructor(wire: Transport, identity: OpenFin_2.Identity, entityType: 'window' | 'view');
     /**
      * Gets a base64 encoded image of all or part of the WebContents.
      * @param options Options for the capturePage call.
@@ -16453,7 +16647,10 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      * Calling this method will close previously opened menus.
      * @experimental
      * @param options
-     *
+     * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+     * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+     * of all possible data shapes for the entire menu, and the click handler should process
+     * these with a "reducer" pattern.
      * @example
      * This could be used to show a drop down menu over views in a platform window:
      * ```js
@@ -16520,7 +16717,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      * })
      * ```
      */
-    showPopupMenu<T>(options: OpenFin_2.ShowPopupMenuOptions<T>): Promise<OpenFin_2.MenuResult<T>>;
+    showPopupMenu<Data>(options: OpenFin_2.ShowPopupMenuOptions<Data>): Promise<OpenFin_2.MenuResult<Data>>;
     /**
      * Closes the window's popup menu, if one exists.
      * @experimental
@@ -17049,6 +17246,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
       * @interface
       */
      declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
+         /**
+          * Data to be written
+          */
          data: {
              text?: string;
              html?: string;