@openfin/node-adapter 43.100.105 → 43.100.106

package/out/node-adapter.js

@@ -4902,9 +4902,20 @@ function requireInstance () {
 	     * @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(options) {
-	        return this.wire.sendAction('show-download-bubble', { ...this.identity, options }).then(() => undefined);
+	    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
@@ -4917,10 +4928,29 @@ function requireInstance () {
 	     *
 	     * @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(options) {
+	    async updateDownloadBubbleAnchor(anchor) {
 	        return this.wire
-	            .sendAction('update-download-bubble-anchor', { ...this.identity, options })
+	            .sendAction('update-download-bubble-anchor', { ...this.identity, anchor })
 	            .then(() => undefined);
 	    }
 	}
@@ -6008,15 +6038,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.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.
+     * @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", { type: 'debug.log' }).then(() => console.log('Log info message')).catch(err => console.log(err));
      * ```
      */
-    log(level, message, { type = 'debug.log' } = {}) {
-        return this.wire.sendAction('write-to-log', { level, message, target: { type } }).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.
@@ -7124,6 +7154,25 @@ class System extends base_1$m.EmitterBase {
     /**
      *  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;
@@ -7131,6 +7180,11 @@ class System extends base_1$m.EmitterBase {
     /**
      * 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');
@@ -18156,7 +18210,7 @@ class NodeEnvironment extends BaseEnvironment_1 {
         };
     }
     getAdapterVersionSync() {
-        return "43.100.105";
+        return "43.100.106";
     }
     observeBounds(element, onChange) {
         throw new Error('Method not implemented.');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "43.100.105",
+    "version": "43.100.106",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",
@@ -24,7 +24,7 @@
     "author": "OpenFin",
     "dependencies": {
         "@types/node": "^20.14.2",
-        "@openfin/core": "43.100.105",
+        "@openfin/core": "43.100.106",
         "lodash": "^4.17.21",
         "ws": "^7.3.0"
     }