@openfin/core 43.100.104 → 43.100.106

package/out/stub.js

@@ -5179,6 +5179,68 @@ function requireInstance () {
 	                return undefined;
 	        }
 	    }
+	    /**
+	     * 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.
+	     * @example
+	     * ```js
+	     * const w = fin.Window.getCurrentSync();
+	     * const el = document.getElementById("download-bubble-button");
+	     * const rect = el.getBoundingClientRect();
+	     * const anchor = {
+	     *     bounds: rect,
+	     *     location: "topRight"
+	     * };
+	     * w.showDownloadBubble(anchor);
+	     * ```
+	     */
+	    async showDownloadBubble(anchor) {
+	        return this.wire.sendAction('show-download-bubble', { ...this.identity, anchor }).then(() => undefined);
+	    }
+	    /**
+	     * 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.
+	     * @example
+	     * ```js
+	     * var w = fin.Window.getCurrentSync();
+	     * w.on('download-button-visibility-changed', (evt) => {
+	     *     if (evt.visible) {
+	     *         const el = document.getElementById("download-bubble-button");
+	     *         //We show our button and get it's bounding rect
+	     *         el.classList.remove("hidden");
+	     *         const rect = el.getBoundingClientRect();
+	     *         const anchor = {
+	     *            bounds: rect,
+	     *            location: "topRight"
+	     *          }
+	     *          w.updateDownloadBubbleAnchor(anchor);
+	     *     } else {
+	     *        //We hide our button
+	     *         document.getElementById("download-bubble-button")?.classList.add("hidden");
+	     * }
+	});
+	     */
+	    async updateDownloadBubbleAnchor(anchor) {
+	        return this.wire
+	            .sendAction('update-download-bubble-anchor', { ...this.identity, anchor })
+	            .then(() => undefined);
+	    }
 	}
 	Instance$7._Window = _Window;
 	return Instance$7;
@@ -6264,14 +6326,15 @@ class System extends base_1$m.EmitterBase {
      * 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 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, message) {
-        return this.wire.sendAction('write-to-log', { level, message }).then(() => undefined);
+    log(level, message, target) {
+        return this.wire.sendAction('write-to-log', { level, message, target: target ?? {} }).then(() => undefined);
     }
     /**
      * Opens the passed URL in the default web browser.
@@ -7287,6 +7350,88 @@ class System extends base_1$m.EmitterBase {
     async serveAsset(options) {
         return (await this.wire.sendAction('serve-asset', { options })).payload.data;
     }
+    /**
+     * Get's the native theme preferences for the current runtime.
+     * Prefer css media-queries wherever possible, but this can be useful to see if the system setting has been overridden.
+     * See @link OpenFin.NativeTheme for more information.
+     * @example Theme selector menu
+     * ```ts
+    async function handleThemeMenu(e: React.MouseEvent<HTMLDivElement>) {
+        const currentTheme = await fin.System.getThemePreferences();
+        const result = await (fin.me as OpenFin.Window).showPopupMenu({
+            x: e.clientX,
+            y: e.clientY,
+            template: [
+                {
+                    label: 'Light',
+                    type: 'checkbox',
+                    checked: currentTheme.themeSource === 'light',
+                    data: { themeSource: 'light' } as const
+                },
+                {
+                    label: 'Dark',
+                    type: 'checkbox',
+                    checked: currentTheme.themeSource === 'dark',
+                    data: { themeSource: 'dark' } as const
+                },
+                {
+                    label: 'System',
+                    type: 'checkbox',
+                    checked: currentTheme.themeSource === 'system',
+                    data: { themeSource: 'system' } as const
+                }
+            ]
+        });
+        if (result.result === 'clicked') {
+            await fin.System.setThemePreferences(result.data);
+        }
+    }
+    ```
+     */
+    async getThemePreferences() {
+        return (await this.wire.sendAction('get-theme-preferences')).payload.data;
+    }
+    /**
+     * Sets the native theme preferences for the current runtime.
+     * Can be used to force runtime-wide light or dark mode.
+     * @important Due to this impacting all applications on a runtime, this method is only usable if a security realm has been set.
+     * @example Theme selector menu
+     * ```ts
+    async function handleThemeMenu(e: React.MouseEvent<HTMLDivElement>) {
+        const currentTheme = await fin.System.getThemePreferences();
+        const result = await (fin.me as OpenFin.Window).showPopupMenu({
+            x: e.clientX,
+            y: e.clientY,
+            template: [
+                {
+                    label: 'Light',
+                    type: 'checkbox',
+                    checked: currentTheme.themeSource === 'light',
+                    data: { themeSource: 'light' } as const
+                },
+                {
+                    label: 'Dark',
+                    type: 'checkbox',
+                    checked: currentTheme.themeSource === 'dark',
+                    data: { themeSource: 'dark' } as const
+                },
+                {
+                    label: 'System',
+                    type: 'checkbox',
+                    checked: currentTheme.themeSource === 'system',
+                    data: { themeSource: 'system' } as const
+                }
+            ]
+        });
+        if (result.result === 'clicked') {
+            await fin.System.setThemePreferences(result.data);
+        }
+    }
+    ```
+     */
+    async setThemePreferences(preferences) {
+        return (await this.wire.sendAction('set-theme-preferences', { preferences })).payload.data;
+    }
     /**
      * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
      * @experimental
@@ -7294,6 +7439,45 @@ class System extends base_1$m.EmitterBase {
     async launchLogUploader(options) {
         return (await this.wire.sendAction('launch-log-uploader', { options })).payload.data;
     }
+    /**
+     *  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
+     * @example
+     * ```ts
+     * await fin.System.setThemePalette([
+     * {
+     *   colorProviderKey: { colorMode: 'light' },
+     *   colorsMap: {
+     *     kColorLabelForeground: 4278190080,
+     *     kColorBubbleBackground: 4293980400
+     *     }
+     *   },
+     *   {
+     *     colorProviderKey: { colorMode: 'dark' },
+     *     colorsMap: {
+     *       kColorLabelForeground: 4293980400,
+     *       kColorBubbleBackground: 4293980400
+     *     }
+     *   }
+     * ]);
+     * ```
+     */
+    async setThemePalette(themePalette) {
+        return (await this.wire.sendAction('set-theme-palette', { themePalette })).payload.data;
+    }
+    /**
+     * Retrieves currently used color overrides
+     * @returns Array of ColorProviderOverrides objects
+     * @example
+     * ```ts
+     * const themePalette = await fin.System.getThemePalette();
+     * console.log(themePalette);
+     * ```
+     */
+    async getThemePalette() {
+        const { payload } = await this.wire.sendAction('get-theme-palette');
+        return payload.data;
+    }
 }
 system.System = System;
 
@@ -11688,7 +11872,7 @@ class LayoutNode {
          * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
          * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
          * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-         * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
+         * Note: This issue does not occur when using `tabOverflowBehavior: 'scroll'` in the layout configuration.
          *
          * @param views The views that will populate the new TabStack.
          * @param options Additional options that control new TabStack creation.
@@ -11824,6 +12008,7 @@ class TabStack extends LayoutNode {
          * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
          * If that happens and then getViews() is called, it will return the identities in a different order than
          * than the currently rendered tab order.
+         * Note: This issue does not occur when using `tabOverflowBehavior: 'scroll'` in the layout configuration.
          *
          *
          * @throws If the {@link TabStack} has been destroyed.
@@ -11848,6 +12033,7 @@ class TabStack extends LayoutNode {
          *
          * @remarks Known Issue: If adding a view overflows the tab-container, the added view will be set as active
          * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+         * Note: This issue does not occur when using `tabOverflowBehavior: 'scroll'` in the layout configuration.
          *
          * @param view The identity of an existing view to add, or options to create a view.
          * @param options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "43.100.104",
+    "version": "43.100.106",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/stub.js",