@openfin/node-adapter 36.78.5 → 36.78.7

package/out/node-adapter-alpha.d.ts

@@ -111,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
+declare type ApiInjection = {
+    fin: InjectionType;
+};
+
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -774,6 +781,72 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      * ```
      */
     getFileDownloadLocation(): Promise<string>;
+    /**
+     * Shows a menu on the tray icon. Use with tray-icon-clicked event.
+     * @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.
+     * @throws if the application has no tray icon set
+     * @throws if the system tray is currently hidden
+     * @example
+     *
+     * ```js
+     * const iconUrl = 'http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png';
+     * const app = fin.Application.getCurrentSync();
+     *
+     * await app.setTrayIcon(iconUrl);
+     *
+     * const template = [
+     *  {
+     *    label: 'Menu Item 1',
+     *    data: 'hello from item 1'
+     *  },
+     *  { type: 'separator' },
+     *  {
+     *    label: 'Menu Item 2',
+     *    type: 'checkbox',
+     *    checked: true,
+     *    data: 'The user clicked the checkbox'
+     *  },
+     *  {
+     *    label: 'see more',
+     *    enabled: false,
+     *    submenu: [
+     *      { label: 'submenu 1', data: 'hello from submenu' }
+     *    ]
+     *  }
+     * ];
+     *
+     * app.addListener('tray-icon-clicked', (event) => {
+     *   // right-click
+     *   if (event.button === 2) {
+     *     app.showTrayIconPopupMenu({ template }).then(r => {
+     *       if (r.result === 'closed') {
+     *         console.log('nothing happened');
+     *       } else {
+     *         console.log(r.data);
+     *       }
+     *     });
+     *   }
+     * });
+     * ```
+     */
+    showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
+    /**
+     * CLoses the tray icon menu.
+     *
+     * @throws if the application has no tray icon set
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.getCurrentSync();
+     *
+     * await app.closeTrayIconPopupMenu();
+     * ```
+     */
+    closeTrayIconPopupMenu(): Promise<void>;
 }
 
 /**
@@ -1178,10 +1251,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     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.
+     * @deprecated Please use {@link domainSettings} instead
      */
     defaultDomainSettings: DefaultDomainSettings;
+    /**
+     * 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.
+     */
+    domainSettings: DomainSettings;
     /**
      * @defaultValue false
      *
@@ -3480,9 +3556,13 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf?: {
+    downloadShelf: {
         /**
-         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
+         *
+         * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
+         * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
+         * `enabled: false`.
          */
         enabled: boolean;
     };
@@ -3598,6 +3678,12 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    /**
+     * Controls the styling and behavior of the window download shelf.
+     *
+     * @remarks This will control the styling for the download shelf regardless of whether its display was
+     * triggered by the window itself, or a view targeting the window.
+     */
     downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
@@ -4435,21 +4521,15 @@ declare type CustomRequestHeaders = {
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
  */
-declare type DefaultDomainSettings = {
-    rules: DefaultDomainSettingsRule[];
-};
+declare type DefaultDomainSettings = DomainSettings;
 
 /**
- * @interface
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
  */
-declare type DefaultDomainSettingsRule = {
-    match: string[];
-    options: {
-        downloadSettings: FileDownloadSettings;
-    };
-};
+declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
 declare interface DesktopAgent {
     open(app: TargetApp, context?: Context): Promise<void>;
@@ -4694,6 +4774,25 @@ declare type DisplayMetadata_3 = {
     readonly glyph?: string;
 };
 
+/**
+ * @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.
+ */
+declare type DomainSettings = {
+    rules: DomainSettingsRule[];
+};
+
+/**
+ * @interface
+ */
+declare type DomainSettingsRule = {
+    match: string[];
+    options: {
+        downloadSettings?: FileDownloadSettings;
+        api?: ApiInjection;
+    };
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -4738,14 +4837,24 @@ declare type DownloadRule = {
  * @interface
  *
  * Controls the styling and behavior of the window download shelf.
+ *
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
+ * triggered by the window itself, or a view targeting the window.
  */
 declare type DownloadShelfOptions = {
     /**
-     * Whether downloads in this window trigger opening the download shelf.
+     * Whether downloads in this window trigger display of the download shelf.
+     *
+     * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
+     * with `downloadShelf: { enabled: true }` initiates a download.
      */
     enabled: boolean;
     /**
      * Styling options for the download shelf border.
+     *
+     * @remarks These apply regardless of whether download shelf display was
+     * triggered by this window itself, or a view targeting the window.  Individual views
+     * cannot control the rendering of their parent window's download shelf.
      */
     border?: {
         /**
@@ -6568,6 +6677,11 @@ declare type InitPlatformOptions = {
     interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
 };
 
+/**
+ * * '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'
+ */
 declare type InjectionType = 'none' | 'global';
 
 /**
@@ -8823,7 +8937,7 @@ declare type LayoutOptions = {
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
- * @interface
+ * Layout preset type.
  */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
@@ -9869,11 +9983,15 @@ declare namespace OpenFin {
         ClosedMenuResult,
         MenuResult,
         ShowPopupMenuOptions,
+        ShowTrayIconPopupMenuOptions,
         MenuItemTemplate,
         NativeWindowIntegrationProviderAuthorization,
         RuntimeInfo,
         DefaultDomainSettings,
         DefaultDomainSettingsRule,
+        DomainSettings,
+        ApiInjection,
+        DomainSettingsRule,
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,
@@ -13104,6 +13222,23 @@ declare type ShowRequestedEvent = BaseEvent_5 & {
     type: 'show-requested';
 };
 
+/**
+ * Options for showing a tray icon 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 ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
+    /**
+     * An array describing the menu to show.
+     */
+    template: MenuItemTemplate<Data>[];
+};
+
 /**
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
  *

package/out/node-adapter-beta.d.ts

@@ -111,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
+declare type ApiInjection = {
+    fin: InjectionType;
+};
+
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -774,6 +781,72 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      * ```
      */
     getFileDownloadLocation(): Promise<string>;
+    /**
+     * Shows a menu on the tray icon. Use with tray-icon-clicked event.
+     * @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.
+     * @throws if the application has no tray icon set
+     * @throws if the system tray is currently hidden
+     * @example
+     *
+     * ```js
+     * const iconUrl = 'http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png';
+     * const app = fin.Application.getCurrentSync();
+     *
+     * await app.setTrayIcon(iconUrl);
+     *
+     * const template = [
+     *  {
+     *    label: 'Menu Item 1',
+     *    data: 'hello from item 1'
+     *  },
+     *  { type: 'separator' },
+     *  {
+     *    label: 'Menu Item 2',
+     *    type: 'checkbox',
+     *    checked: true,
+     *    data: 'The user clicked the checkbox'
+     *  },
+     *  {
+     *    label: 'see more',
+     *    enabled: false,
+     *    submenu: [
+     *      { label: 'submenu 1', data: 'hello from submenu' }
+     *    ]
+     *  }
+     * ];
+     *
+     * app.addListener('tray-icon-clicked', (event) => {
+     *   // right-click
+     *   if (event.button === 2) {
+     *     app.showTrayIconPopupMenu({ template }).then(r => {
+     *       if (r.result === 'closed') {
+     *         console.log('nothing happened');
+     *       } else {
+     *         console.log(r.data);
+     *       }
+     *     });
+     *   }
+     * });
+     * ```
+     */
+    showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
+    /**
+     * CLoses the tray icon menu.
+     *
+     * @throws if the application has no tray icon set
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.getCurrentSync();
+     *
+     * await app.closeTrayIconPopupMenu();
+     * ```
+     */
+    closeTrayIconPopupMenu(): Promise<void>;
 }
 
 /**
@@ -1178,10 +1251,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     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.
+     * @deprecated Please use {@link domainSettings} instead
      */
     defaultDomainSettings: DefaultDomainSettings;
+    /**
+     * 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.
+     */
+    domainSettings: DomainSettings;
     /**
      * @defaultValue false
      *
@@ -3480,9 +3556,13 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf?: {
+    downloadShelf: {
         /**
-         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
+         *
+         * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
+         * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
+         * `enabled: false`.
          */
         enabled: boolean;
     };
@@ -3598,6 +3678,12 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    /**
+     * Controls the styling and behavior of the window download shelf.
+     *
+     * @remarks This will control the styling for the download shelf regardless of whether its display was
+     * triggered by the window itself, or a view targeting the window.
+     */
     downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
@@ -4435,21 +4521,15 @@ declare type CustomRequestHeaders = {
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
  */
-declare type DefaultDomainSettings = {
-    rules: DefaultDomainSettingsRule[];
-};
+declare type DefaultDomainSettings = DomainSettings;
 
 /**
- * @interface
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
  */
-declare type DefaultDomainSettingsRule = {
-    match: string[];
-    options: {
-        downloadSettings: FileDownloadSettings;
-    };
-};
+declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
 declare interface DesktopAgent {
     open(app: TargetApp, context?: Context): Promise<void>;
@@ -4694,6 +4774,25 @@ declare type DisplayMetadata_3 = {
     readonly glyph?: string;
 };
 
+/**
+ * @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.
+ */
+declare type DomainSettings = {
+    rules: DomainSettingsRule[];
+};
+
+/**
+ * @interface
+ */
+declare type DomainSettingsRule = {
+    match: string[];
+    options: {
+        downloadSettings?: FileDownloadSettings;
+        api?: ApiInjection;
+    };
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -4738,14 +4837,24 @@ declare type DownloadRule = {
  * @interface
  *
  * Controls the styling and behavior of the window download shelf.
+ *
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
+ * triggered by the window itself, or a view targeting the window.
  */
 declare type DownloadShelfOptions = {
     /**
-     * Whether downloads in this window trigger opening the download shelf.
+     * Whether downloads in this window trigger display of the download shelf.
+     *
+     * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
+     * with `downloadShelf: { enabled: true }` initiates a download.
      */
     enabled: boolean;
     /**
      * Styling options for the download shelf border.
+     *
+     * @remarks These apply regardless of whether download shelf display was
+     * triggered by this window itself, or a view targeting the window.  Individual views
+     * cannot control the rendering of their parent window's download shelf.
      */
     border?: {
         /**
@@ -6568,6 +6677,11 @@ declare type InitPlatformOptions = {
     interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
 };
 
+/**
+ * * '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'
+ */
 declare type InjectionType = 'none' | 'global';
 
 /**
@@ -8823,7 +8937,7 @@ declare type LayoutOptions = {
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
- * @interface
+ * Layout preset type.
  */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
@@ -9869,11 +9983,15 @@ declare namespace OpenFin {
         ClosedMenuResult,
         MenuResult,
         ShowPopupMenuOptions,
+        ShowTrayIconPopupMenuOptions,
         MenuItemTemplate,
         NativeWindowIntegrationProviderAuthorization,
         RuntimeInfo,
         DefaultDomainSettings,
         DefaultDomainSettingsRule,
+        DomainSettings,
+        ApiInjection,
+        DomainSettingsRule,
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,
@@ -13104,6 +13222,23 @@ declare type ShowRequestedEvent = BaseEvent_5 & {
     type: 'show-requested';
 };
 
+/**
+ * Options for showing a tray icon 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 ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
+    /**
+     * An array describing the menu to show.
+     */
+    template: MenuItemTemplate<Data>[];
+};
+
 /**
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
  *

package/out/node-adapter-public.d.ts

@@ -111,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
+declare type ApiInjection = {
+    fin: InjectionType;
+};
+
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -774,6 +781,72 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      * ```
      */
     getFileDownloadLocation(): Promise<string>;
+    /**
+     * Shows a menu on the tray icon. Use with tray-icon-clicked event.
+     * @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.
+     * @throws if the application has no tray icon set
+     * @throws if the system tray is currently hidden
+     * @example
+     *
+     * ```js
+     * const iconUrl = 'http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png';
+     * const app = fin.Application.getCurrentSync();
+     *
+     * await app.setTrayIcon(iconUrl);
+     *
+     * const template = [
+     *  {
+     *    label: 'Menu Item 1',
+     *    data: 'hello from item 1'
+     *  },
+     *  { type: 'separator' },
+     *  {
+     *    label: 'Menu Item 2',
+     *    type: 'checkbox',
+     *    checked: true,
+     *    data: 'The user clicked the checkbox'
+     *  },
+     *  {
+     *    label: 'see more',
+     *    enabled: false,
+     *    submenu: [
+     *      { label: 'submenu 1', data: 'hello from submenu' }
+     *    ]
+     *  }
+     * ];
+     *
+     * app.addListener('tray-icon-clicked', (event) => {
+     *   // right-click
+     *   if (event.button === 2) {
+     *     app.showTrayIconPopupMenu({ template }).then(r => {
+     *       if (r.result === 'closed') {
+     *         console.log('nothing happened');
+     *       } else {
+     *         console.log(r.data);
+     *       }
+     *     });
+     *   }
+     * });
+     * ```
+     */
+    showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
+    /**
+     * CLoses the tray icon menu.
+     *
+     * @throws if the application has no tray icon set
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.getCurrentSync();
+     *
+     * await app.closeTrayIconPopupMenu();
+     * ```
+     */
+    closeTrayIconPopupMenu(): Promise<void>;
 }
 
 /**
@@ -1178,10 +1251,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     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.
+     * @deprecated Please use {@link domainSettings} instead
      */
     defaultDomainSettings: DefaultDomainSettings;
+    /**
+     * 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.
+     */
+    domainSettings: DomainSettings;
     /**
      * @defaultValue false
      *
@@ -3480,9 +3556,13 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf?: {
+    downloadShelf: {
         /**
-         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
+         *
+         * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
+         * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
+         * `enabled: false`.
          */
         enabled: boolean;
     };
@@ -3598,6 +3678,12 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    /**
+     * Controls the styling and behavior of the window download shelf.
+     *
+     * @remarks This will control the styling for the download shelf regardless of whether its display was
+     * triggered by the window itself, or a view targeting the window.
+     */
     downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
@@ -4435,21 +4521,15 @@ declare type CustomRequestHeaders = {
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
  */
-declare type DefaultDomainSettings = {
-    rules: DefaultDomainSettingsRule[];
-};
+declare type DefaultDomainSettings = DomainSettings;
 
 /**
- * @interface
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
  */
-declare type DefaultDomainSettingsRule = {
-    match: string[];
-    options: {
-        downloadSettings: FileDownloadSettings;
-    };
-};
+declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
 declare interface DesktopAgent {
     open(app: TargetApp, context?: Context): Promise<void>;
@@ -4694,6 +4774,25 @@ declare type DisplayMetadata_3 = {
     readonly glyph?: string;
 };
 
+/**
+ * @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.
+ */
+declare type DomainSettings = {
+    rules: DomainSettingsRule[];
+};
+
+/**
+ * @interface
+ */
+declare type DomainSettingsRule = {
+    match: string[];
+    options: {
+        downloadSettings?: FileDownloadSettings;
+        api?: ApiInjection;
+    };
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -4738,14 +4837,24 @@ declare type DownloadRule = {
  * @interface
  *
  * Controls the styling and behavior of the window download shelf.
+ *
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
+ * triggered by the window itself, or a view targeting the window.
  */
 declare type DownloadShelfOptions = {
     /**
-     * Whether downloads in this window trigger opening the download shelf.
+     * Whether downloads in this window trigger display of the download shelf.
+     *
+     * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
+     * with `downloadShelf: { enabled: true }` initiates a download.
      */
     enabled: boolean;
     /**
      * Styling options for the download shelf border.
+     *
+     * @remarks These apply regardless of whether download shelf display was
+     * triggered by this window itself, or a view targeting the window.  Individual views
+     * cannot control the rendering of their parent window's download shelf.
      */
     border?: {
         /**
@@ -6568,6 +6677,11 @@ declare type InitPlatformOptions = {
     interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
 };
 
+/**
+ * * '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'
+ */
 declare type InjectionType = 'none' | 'global';
 
 /**
@@ -8823,7 +8937,7 @@ declare type LayoutOptions = {
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
- * @interface
+ * Layout preset type.
  */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
@@ -9869,11 +9983,15 @@ declare namespace OpenFin {
         ClosedMenuResult,
         MenuResult,
         ShowPopupMenuOptions,
+        ShowTrayIconPopupMenuOptions,
         MenuItemTemplate,
         NativeWindowIntegrationProviderAuthorization,
         RuntimeInfo,
         DefaultDomainSettings,
         DefaultDomainSettingsRule,
+        DomainSettings,
+        ApiInjection,
+        DomainSettingsRule,
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,
@@ -13104,6 +13222,23 @@ declare type ShowRequestedEvent = BaseEvent_5 & {
     type: 'show-requested';
 };
 
+/**
+ * Options for showing a tray icon 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 ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
+    /**
+     * An array describing the menu to show.
+     */
+    template: MenuItemTemplate<Data>[];
+};
+
 /**
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
  *

package/out/node-adapter.d.ts

@@ -111,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
+declare type ApiInjection = {
+    fin: InjectionType;
+};
+
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -780,6 +787,72 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      * ```
      */
     getFileDownloadLocation(): Promise<string>;
+    /**
+     * Shows a menu on the tray icon. Use with tray-icon-clicked event.
+     * @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.
+     * @throws if the application has no tray icon set
+     * @throws if the system tray is currently hidden
+     * @example
+     *
+     * ```js
+     * const iconUrl = 'http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png';
+     * const app = fin.Application.getCurrentSync();
+     *
+     * await app.setTrayIcon(iconUrl);
+     *
+     * const template = [
+     *  {
+     *    label: 'Menu Item 1',
+     *    data: 'hello from item 1'
+     *  },
+     *  { type: 'separator' },
+     *  {
+     *    label: 'Menu Item 2',
+     *    type: 'checkbox',
+     *    checked: true,
+     *    data: 'The user clicked the checkbox'
+     *  },
+     *  {
+     *    label: 'see more',
+     *    enabled: false,
+     *    submenu: [
+     *      { label: 'submenu 1', data: 'hello from submenu' }
+     *    ]
+     *  }
+     * ];
+     *
+     * app.addListener('tray-icon-clicked', (event) => {
+     *   // right-click
+     *   if (event.button === 2) {
+     *     app.showTrayIconPopupMenu({ template }).then(r => {
+     *       if (r.result === 'closed') {
+     *         console.log('nothing happened');
+     *       } else {
+     *         console.log(r.data);
+     *       }
+     *     });
+     *   }
+     * });
+     * ```
+     */
+    showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
+    /**
+     * CLoses the tray icon menu.
+     *
+     * @throws if the application has no tray icon set
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.getCurrentSync();
+     *
+     * await app.closeTrayIconPopupMenu();
+     * ```
+     */
+    closeTrayIconPopupMenu(): Promise<void>;
 }
 
 /**
@@ -1184,10 +1257,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     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.
+     * @deprecated Please use {@link domainSettings} instead
      */
     defaultDomainSettings: DefaultDomainSettings;
+    /**
+     * 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.
+     */
+    domainSettings: DomainSettings;
     /**
      * @defaultValue false
      *
@@ -3523,9 +3599,13 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf?: {
+    downloadShelf: {
         /**
-         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
+         *
+         * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
+         * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
+         * `enabled: false`.
          */
         enabled: boolean;
     };
@@ -3641,6 +3721,12 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    /**
+     * Controls the styling and behavior of the window download shelf.
+     *
+     * @remarks This will control the styling for the download shelf regardless of whether its display was
+     * triggered by the window itself, or a view targeting the window.
+     */
     downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
@@ -4478,21 +4564,15 @@ declare type CustomRequestHeaders = {
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
  */
-declare type DefaultDomainSettings = {
-    rules: DefaultDomainSettingsRule[];
-};
+declare type DefaultDomainSettings = DomainSettings;
 
 /**
- * @interface
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
  */
-declare type DefaultDomainSettingsRule = {
-    match: string[];
-    options: {
-        downloadSettings: FileDownloadSettings;
-    };
-};
+declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
 declare interface DesktopAgent {
     open(app: TargetApp, context?: Context): Promise<void>;
@@ -4737,6 +4817,25 @@ declare type DisplayMetadata_3 = {
     readonly glyph?: string;
 };
 
+/**
+ * @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.
+ */
+declare type DomainSettings = {
+    rules: DomainSettingsRule[];
+};
+
+/**
+ * @interface
+ */
+declare type DomainSettingsRule = {
+    match: string[];
+    options: {
+        downloadSettings?: FileDownloadSettings;
+        api?: ApiInjection;
+    };
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -4781,14 +4880,24 @@ declare type DownloadRule = {
  * @interface
  *
  * Controls the styling and behavior of the window download shelf.
+ *
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
+ * triggered by the window itself, or a view targeting the window.
  */
 declare type DownloadShelfOptions = {
     /**
-     * Whether downloads in this window trigger opening the download shelf.
+     * Whether downloads in this window trigger display of the download shelf.
+     *
+     * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
+     * with `downloadShelf: { enabled: true }` initiates a download.
      */
     enabled: boolean;
     /**
      * Styling options for the download shelf border.
+     *
+     * @remarks These apply regardless of whether download shelf display was
+     * triggered by this window itself, or a view targeting the window.  Individual views
+     * cannot control the rendering of their parent window's download shelf.
      */
     border?: {
         /**
@@ -6668,6 +6777,11 @@ declare type InitPlatformOptions = {
     interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
 };
 
+/**
+ * * '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'
+ */
 declare type InjectionType = 'none' | 'global';
 
 /**
@@ -9122,7 +9236,7 @@ declare type LayoutOptions = {
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
- * @interface
+ * Layout preset type.
  */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
@@ -10186,11 +10300,15 @@ declare namespace OpenFin {
         ClosedMenuResult,
         MenuResult,
         ShowPopupMenuOptions,
+        ShowTrayIconPopupMenuOptions,
         MenuItemTemplate,
         NativeWindowIntegrationProviderAuthorization,
         RuntimeInfo,
         DefaultDomainSettings,
         DefaultDomainSettingsRule,
+        DomainSettings,
+        ApiInjection,
+        DomainSettingsRule,
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,
@@ -13499,6 +13617,23 @@ declare type ShowRequestedEvent = BaseEvent_5 & {
     type: 'show-requested';
 };
 
+/**
+ * Options for showing a tray icon 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 ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
+    /**
+     * An array describing the menu to show.
+     */
+    template: MenuItemTemplate<Data>[];
+};
+
 /**
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
  *

package/out/node-adapter.js

@@ -3720,6 +3720,81 @@ function requireInstance$1 () {
 	        const { payload: { data } } = await this.wire.sendAction('get-file-download-location', this.identity);
 	        return data;
 	    }
+	    /**
+	     * Shows a menu on the tray icon. Use with tray-icon-clicked event.
+	     * @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.
+	     * @throws if the application has no tray icon set
+	     * @throws if the system tray is currently hidden
+	     * @example
+	     *
+	     * ```js
+	     * const iconUrl = 'http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png';
+	     * const app = fin.Application.getCurrentSync();
+	     *
+	     * await app.setTrayIcon(iconUrl);
+	     *
+	     * const template = [
+	     *  {
+	     *    label: 'Menu Item 1',
+	     *    data: 'hello from item 1'
+	     *  },
+	     *  { type: 'separator' },
+	     *  {
+	     *    label: 'Menu Item 2',
+	     *    type: 'checkbox',
+	     *    checked: true,
+	     *    data: 'The user clicked the checkbox'
+	     *  },
+	     *  {
+	     *    label: 'see more',
+	     *    enabled: false,
+	     *    submenu: [
+	     *      { label: 'submenu 1', data: 'hello from submenu' }
+	     *    ]
+	     *  }
+	     * ];
+	     *
+	     * app.addListener('tray-icon-clicked', (event) => {
+	     *   // right-click
+	     *   if (event.button === 2) {
+	     *     app.showTrayIconPopupMenu({ template }).then(r => {
+	     *       if (r.result === 'closed') {
+	     *         console.log('nothing happened');
+	     *       } else {
+	     *         console.log(r.data);
+	     *       }
+	     *     });
+	     *   }
+	     * });
+	     * ```
+	     */
+	    async showTrayIconPopupMenu(options) {
+	        const { name } = this.wire.me;
+	        const entityIdentity = { uuid: this.identity.uuid, name };
+	        const { payload } = await this.wire.sendAction('show-tray-icon-popup-menu', { ...entityIdentity, options });
+	        return payload.data;
+	    }
+	    /**
+	     * CLoses the tray icon menu.
+	     *
+	     * @throws if the application has no tray icon set
+	     * @example
+	     *
+	     * ```js
+	     * const app = fin.Application.getCurrentSync();
+	     *
+	     * await app.closeTrayIconPopupMenu();
+	     * ```
+	     */
+	    async closeTrayIconPopupMenu() {
+	        const { name } = this.wire.me;
+	        const entityIdentity = { uuid: this.identity.uuid, name };
+	        await this.wire.sendAction('close-tray-icon-popup-menu', { ...entityIdentity });
+	    }
 	}
 	Instance$6.Application = Application;
 	return Instance$6;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "36.78.5",
+    "version": "36.78.7",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",