@openfin/fdc3-api 44.100.49 → 44.100.51

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

@@ -91,6 +91,34 @@ declare type AnalyticsProtocolMap = {
     [k in AnalyticsOnlyCalls]: VoidCall;
 };
 
+/**
+ * Represents an anchor configuration consisting of a bounding rectangle
+ * and an anchor point describing which part of that rectangle should be
+ * used as the reference for positioning the download bubble.
+ * @interface
+ */
+declare type Anchor = {
+    /**
+     * The DOM or screen-space rectangle that defines the anchor area.
+     */
+    bounds: Rectangle;
+    /**
+     *  The location within the rectangle that should act as the anchor
+     *   (e.g., `topRight`, `bottomLeft`, `center`, etc.).
+     * For example, `topRight` means the rectangle's top-right corner is used
+     * as the anchoring reference point.
+     */
+    location: AnchorLocation;
+};
+
+/**
+ * Defines the point within the rectangle that should be used as the anchor
+ * when positioning UI elements relative to another surface.
+ *
+ * @interface
+ */
+declare type AnchorLocation = 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' | 'leftTop' | 'rightTop' | 'leftBottom' | 'rightBottom' | 'topCenter' | 'bottomCenter' | 'leftCenter' | 'rightCenter' | 'none' | 'float';
+
 declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
 
 declare type AnyStrategy = ChannelStrategy<any>;
@@ -3864,6 +3892,10 @@ declare type ConstWindowOptions = {
      * Controls whether frameless window should have rounded corners. Default is false for Windows and true for MacOS. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.
      */
     roundedCorners: boolean;
+    /**
+     * Configuration for download bubble UI.
+     */
+    downloadBubble?: DownloadBubbleOptions;
 };
 
 /**
@@ -4616,6 +4648,50 @@ declare type DomainSettingsRule = {
     matchOptions?: RuleMatchOptions;
 };
 
+/**
+ * Configuration options for enabling and positioning the download bubble UI.
+ * @interface
+ */
+declare type DownloadBubbleOptions = {
+    /**
+     * Whether the download bubble feature is enabled.
+     */
+    enabled: boolean;
+    /**
+     * Anchor configuration describing where the download bubble should attach.
+     */
+    anchor: Anchor;
+};
+
+/**
+ * Generated when the download button icon needs to be updated. Only raised if the download bubble feature is enabled.
+ *
+ * @interface
+ */
+declare type DownloadButtonIconUpdatedEvent = BaseEvent_5 & {
+    type: 'download-button-icon-updated';
+    disabled: boolean;
+    active: boolean;
+    touchMode: boolean;
+    progressIndicatorState: 'idle' | 'scanning' | 'downloading' | 'dormant';
+    progressDownloadCount: number;
+    progressPercentage: number;
+    buttonTooltip: string;
+};
+
+/**
+ * Generated when the visibility of the window's download button changes. Only raised if the download bubble feature is enabled.
+ *
+ * @interface
+ */
+declare type DownloadButtonVisibilityChangedEvent = BaseEvent_5 & {
+    type: 'download-button-visibility-changed';
+    /**
+     * True if the download button should be displayed, false if it should be hidden.
+     */
+    visible: boolean;
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -4675,6 +4751,7 @@ declare type DownloadRule = {
  *
  * @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.
+ * @deprecated Use the DownloadBubble API instead.
  */
 declare type DownloadShelfOptions = {
     /**
@@ -4710,6 +4787,7 @@ declare type DownloadShelfOptions = {
  * Generated when the visibility of the window's download shelf changes.
  *
  * @interface
+ * @deprecated use DownloadBubble API instead
  */
 declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
     type: 'download-shelf-visibility-changed';
@@ -4976,7 +5054,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
  *  under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
  *  from which they propagate).
  */
-declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent | NativeThemeUpdatedEvent;
+declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent | ThemePaletteChangedEvent | NativeThemeUpdatedEvent;
 
 /**
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
@@ -8934,17 +9012,17 @@ declare type LayoutOptions = {
         /* Excluded from this release type: disableTabOverflowDropdown */
         /**
          * When set to 'scroll', enables horizontal scrolling of tabs when they overflow the stack width.
-         * When set to 'dropdown' the default golden-layouts behavior will apply.
+         * When set to 'dropdown', the default behavior occurs, in which excess tabs appear in a menu.
          *
-         * Setting this to `scroll` may break styles written for the default dropdown behavior, as it significantly changes the dom structure and css of tabs.
+         * Setting this to `scroll` might break styles written for the default dropdown behavior, as it significantly changes the DOM structure and CSS of tabs.
          *
-         * The DOM structure will be modified in this way:
-         * - `lm_tabs` will be wrapped in a div with class `lm_scroll_shadow`. This div will be revealed by a mask on the tabs when they are overflowing.
-         * - the `.newTabButton` (if enabled) will be a direct child of `.lm_header`
+         * The DOM structure is modified in this way:
+         * - `lm_tabs` is wrapped in a div with class `lm_scroll_shadow`. This div is revealed by a mask on the tabs when they are overflowing.
+         * - the `.newTabButton` (if enabled) is a direct child of `.lm_header`
          *
-         * **The following css variables are available to customize tab appearance:**
+         * **The following CSS variables are available to customize tab appearance:**
          *
-         * - `--layout-tab-width`: The default (max) width of the tabs. Using this enables using `lm_tab` as a queryable css container (must be an absolute value to use container queries). Default: `fit-content`
+         * - `--layout-tab-width`: The default (max) width of the tabs. Using this enables using `lm_tab` as a queryable CSS container (must be an absolute value to use container queries). Default: `fit-content`
          * - `--layout-tab-min-width`: The minimum width of the tabs before they start overflowing. Set this to enable tab shrinking. Defaults to the same value as `--layout-tab-width` (no shrinking).
          * - `--layout-tab-overflow-fade-size`: The width of the scroll shadows when tabs are overflowing. Default: `20px`
          * - `--layout-tab-overflow-shadow-color`: The color of the scroll shadows when tabs are overflowing. Enabling a contrasting shadow color may require setting the background color on `.lm_tabs` if it was not previously set via `--tabs-background-color`. Default is transparent so overlowing tabs fade into the background.
@@ -8953,7 +9031,7 @@ declare type LayoutOptions = {
          *
          * - `--layout-tab-overflow-fade-left`: The strength of the left fade when tabs are overflowing. This is a number between 0 and 1 where 0 means no fade and 1 means a full fade.
          * - `--layout-tab-overflow-fade-right`: The strength of the right fade when tabs are overflowing. This is a number between 0 and 1 where 0 means no fade and 1 means a full fade.
-         * - `--layout-tabs-overflowing`: A [css space toggle](https://css-tricks.com/the-css-custom-property-toggle-trick/) that is empty when tabs are overflowing and `initial` otherwise. If you are only targeting Chrome > 137 you may want to use the `if()` function with left/right fade instead of this toggle.
+         * - `--layout-tabs-overflowing`: A [CSS space toggle](https://css-tricks.com/the-css-custom-property-toggle-trick/) that is empty when tabs are overflowing and `initial` otherwise. If you are targeting only Chrome 137 or greater, you might want to use the `if()` function with left/right fade instead of this toggle.
          *
          * @example
          * ```css
@@ -9220,6 +9298,7 @@ declare type Manifest = {
         policies?: {
             CloudAPAuthEnabled?: 'enabled' | 'disabled';
         };
+        themePalette?: Array<ThemePalette>;
     };
     services?: string[];
     shortcut?: {
@@ -9593,6 +9672,11 @@ declare type MutableViewOptions = {
      * {@inheritDoc ChromiumPolicies}
      */
     chromiumPolicies: ChromiumPolicies;
+    /**
+     * When set to `false`, disables sending application logs to RVM for this view.
+     * When omitted, inherits from the parent application.
+     */
+    enableAppLogging?: boolean;
 };
 
 /**
@@ -9867,6 +9951,12 @@ declare type MutableWindowOptions = {
      * {@inheritDoc ChromiumPolicies}
      */
     chromiumPolicies: ChromiumPolicies;
+    /**
+     * When set to `false`, disables sending application logs to RVM for this window.
+     * When omitted, inherits from the parent application.
+     *
+     */
+    enableAppLogging?: boolean;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -10236,6 +10326,9 @@ declare namespace OpenFin {
         CustomProtocolOptions,
         InteropBrokerOptions,
         ContextGroupInfo,
+        AnchorLocation,
+        Anchor,
+        DownloadBubbleOptions,
         DisplayMetadata,
         LegacyWinOptionsInAppOptions,
         Snapshot,
@@ -10339,6 +10432,9 @@ declare namespace OpenFin {
         LogUploaderUIOptions,
         LogTypes,
         LogUploadOptions,
+        ThemeColorsMap,
+        ThemeColorId,
+        ThemePalette,
         Manifest,
         LayoutContent,
         LayoutItemConfig,
@@ -10838,6 +10934,11 @@ declare type PerDomainSettings = {
          */
         drag?: 'allow' | 'block';
     };
+    /**
+     * When set to `false`, disables sending application logs to RVM for this window.
+     * When omitted, inherits from the parent application.
+     */
+    enableAppLogging?: boolean;
 };
 
 /**
@@ -13173,6 +13274,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'create-window': VoidCall;
     'get-current-window': VoidCall;
     'get-current-window-sync': VoidCall;
+    'show-download-bubble': IdentityCall<{
+        options: OpenFin.Anchor;
+    }, void>;
+    'update-download-bubble-anchor': IdentityCall<{
+        options: OpenFin.Anchor;
+    }, void>;
     'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
     'external-application-wrap': VoidCall;
     'external-application-wrap-sync': VoidCall;
@@ -13360,6 +13467,9 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'write-to-log': ApiCall<{
         level: string;
         message: string;
+        target?: {
+            type?: 'app.log' | 'debug.log';
+        };
     }, void>;
     'open-url-with-browser': ApiCall<{
         url: string;
@@ -13523,6 +13633,15 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         request: void;
         response: OpenFin.ExtensionInfo[];
     };
+    'set-theme-palette': ApiCall<{
+        themePalette: Array<OpenFin.ThemePalette>;
+    }, void> & {
+        themePalette: Array<OpenFin.ThemePalette>;
+    };
+    'get-theme-palette': ApiCall<void, Array<OpenFin.ThemePalette>> & {
+        request: void;
+        response: Array<OpenFin.ThemePalette>;
+    };
     'fdc3-add-context-listener': VoidCall;
     'fdc3-add-intent-listener': VoidCall;
     'fdc3-raise-intent': VoidCall;
@@ -15574,13 +15693,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * Writes the passed message into both the log file and the console.
      * @param level The log level for the entry. Can be either "info", "warning" or "error"
      * @param message The log message text
+     * @param target.type Optional. The the log stream this message will be sent to, defaults to 'debug.log'. Specify 'app.log' to log to the app log of the sending View / Window. Note, when using `app.log`, it will always log to app.log irrespective of the `enableAppLogging` setting for the sender. This is particularly useful if you wish to log certain things from a View / Window but ignore generic console logs.
      *
      * @example
      * ```js
-     * fin.System.log("info", "An example log message").then(() => console.log('Log info message')).catch(err => console.log(err));
+     * fin.System.log("info", "An example log message", { type: 'debug.log' }).then(() => console.log('Log info message')).catch(err => console.log(err));
      * ```
      */
-    log(level: string, message: string): Promise<void>;
+    log(level: string, message: string, { type }?: {
+        type?: 'app.log' | 'debug.log';
+    }): Promise<void>;
     /**
      * Opens the passed URL in the default web browser.
      *
@@ -16402,6 +16524,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * @experimental
      */
     launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
+    /**
+     *  Overrides original Chromium theme color providers matching key (currently except high contrast ones). Only colors passed in the map will be overridden.
+     * @param overrides - Array of ColorProviderOverrides objects
+     */
+    setThemePalette(themePalette: Array<OpenFin.ThemePalette>): Promise<void>;
+    /**
+     * Retrieves currently used color overrides
+     * @returns Array of ColorProviderOverrides objects
+     */
+    getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
 }
 
 /**
@@ -16440,6 +16572,7 @@ declare namespace SystemEvents {
         ExtensionsInstallFailedEvent,
         ExtensionInstallFailedEvent,
         ExtensionsInitializationFailedEvent,
+        ThemePaletteChangedEvent,
         NativeThemeUpdatedEvent,
         Event_11 as Event,
         SystemEvent,
@@ -16711,6 +16844,104 @@ declare type TerminateExternalRequestType = {
     killTree: boolean;
 };
 
+/**
+ * String literal type of all supported theme color IDs.
+ * Useful wherever you need to refer to a color slot by name.
+ * @interface
+ */
+declare type ThemeColorId = keyof ThemeColorsMap;
+
+/**
+ * All supported color slots for the Download Bubble and related UI.
+ * @interface
+ */
+declare interface ThemeColorsMap {
+    /**
+     * Enterprise/Window/Background – bubble header and footer background.
+     */
+    kColorBubbleBackground?: number;
+    /**
+     * Windows only – Enterprise/Window/Border.
+     */
+    kColorBubbleBorder?: number;
+    /**
+     * Windows only – Enterprise/Window/Border (large shadow).
+     */
+    kColorBubbleBorderShadowLarge?: number;
+    /**
+     * Windows only – Enterprise/Window/Border (small shadow).
+     */
+    kColorBubbleBorderShadowSmall?: number;
+    /**
+     * Enterprise/Window/Background – downloaded item row background.
+     */
+    kColorDialogBackground?: number;
+    /**
+     * Enterprise/Search Result/Background/Hover – download item row hover.
+     */
+    kColorDownloadBubbleRowHover?: number;
+    /**
+     * Enterprise/Window/Icon – “Show all downloads” icon color.
+     */
+    kColorDownloadBubbleShowAllDownloadsIcon?: number;
+    /**
+     * Enterprise/Search Result/Background/Hover – full download history
+     * button (full row) hover background.
+     */
+    kColorHoverButtonBackgroundHovered?: number;
+    /**
+     * Shared/Icon Button/Subtle/Icon/Default – SVG icon color
+     * (except full download history button).
+     */
+    kColorIcon?: number;
+    /**
+     * Enterprise/Window/Text/Base – main label text color.
+     * May be post-processed to increase readability on kColorDialogBackground
+     * (can be disabled via transparent kColorLabelBackground).
+     */
+    kColorLabelForeground?: number;
+    /**
+     * Label background used for readability adjustment.
+     * Set to transparent (0) to disable Chromium’s readability alignment logic.
+     */
+    kColorLabelBackground?: number;
+    /**
+     * Enterprise/Window/Text/Soft – secondary text color.
+     * May be post-processed to increase readability on kColorDialogBackground
+     * (can be disabled via transparent kColorLabelBackground).
+     */
+    kColorSecondaryForeground?: number;
+}
+
+/**
+ * Defines a set of color overrides for Chromium UI surfaces based on a theme
+ * provider (e.g., light or dark mode).
+ * @interface
+ */
+declare type ThemePalette = {
+    /**
+     * Identifies the color provider mode that the palette applies to.
+     */
+    colorProviderKey: {
+        /**
+         * The UI color mode that this palette is intended to style.
+         */
+        colorMode: 'light' | 'dark';
+    };
+    /**
+     * A mapping of known Chromium color IDs to ARGB values (0xAARRGGBB).
+     */
+    colorsMap: ThemeColorsMap;
+};
+
+/**
+ * An event that fires when the system theme palette is changed.
+ */
+declare type ThemePaletteChangedEvent = BaseEvent_9 & {
+    type: 'theme-palette-changed';
+    themePalette: OpenFin.ThemePalette;
+};
+
 /**
  * Settable options for the native theme of the operating system.
  */
@@ -20009,6 +20240,32 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * To print the views embedded in their page context, set `content` to `screenshot`.
      */
     print(options?: OpenFin.WindowPrintOptions): Promise<void>;
+    /**
+     * Displays the download bubble UI. If an anchor is provided, the bubble
+     * will be positioned according to the specified rectangle and anchor point.
+     *
+     * @param {OpenFin.Anchor} options
+     *   Anchor configuration used to position the download bubble. This includes
+     *   the bounding rectangle and the anchor location within that rectangle.
+     *
+     * @returns {Promise<void>}
+     *   A promise that resolves once the request to show the download bubble
+     *   has been processed.
+     */
+    showDownloadBubble(options: OpenFin.Anchor): Promise<void>;
+    /**
+     * Updates the anchor used for positioning the download bubble. This allows
+     * moving the bubble reactively—for example, in response to window resizes,
+     * layout changes, or DOM element repositioning.
+     *
+     * @param {OpenFin.Anchor} options
+     *   New anchor configuration describing the updated position and anchor
+     *   location for the download bubble.
+     *
+     * @returns {Promise<void>}
+     *   A promise that resolves once the anchor update has been applied.
+     */
+    updateDownloadBubbleAnchor(options: OpenFin.Anchor): Promise<void>;
 }
 
 /**
@@ -20204,6 +20461,8 @@ declare namespace WindowEvents {
         NonPropagatedWindowEvent,
         ShowAllDownloadsEvent,
         DownloadShelfVisibilityChangedEvent,
+        DownloadButtonVisibilityChangedEvent,
+        DownloadButtonIconUpdatedEvent,
         WindowSourcedEvent,
         WillPropagateWindowEvent,
         Event_6 as Event,
@@ -20407,7 +20666,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
  * from {@link OpenFin.ViewEvents}.
  */
-declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent | SnappedEvent | SnapZoneChangedEvent;
+declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent;
 
 /**
  * Generated when a child window starts loading.