@openfin/fdc3-api 44.100.57 → 44.100.58

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

@@ -1417,6 +1417,56 @@ declare type ApplicationWindowInfo = {
     uuid: string;
 };
 
+/**
+ * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled  when the app logging feature is enabled for its application.
+ *
+ * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
+ *
+ * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
+ *
+ * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its options will be ignored.
+ *
+ * @default 'debug'
+ *
+ * @example Controlling App Logs With DefaultViewOptions + Domain Settings
+ *
+ * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
+ *
+ * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
+ *
+ * ```ts
+ * {
+ *   <rest of settings>
+ *   "platform": {
+ *      <rest of settings>
+ *     "enableAppLogging": "true",
+ *     "defaultViewOptions": {
+ *       "appLogLevel": "warn"
+ *     },
+ *     "domainSettings": {
+ *        "default": {  <rest of settings> }
+ *        "rules": [
+ *           <rest of rules>
+ *          {
+ *               "match": ["*://*?app-logging-level=silent"],
+ *               "options": {
+ *                  "appLogLevel": "silent"
+ *               }
+ *           },
+ *          {
+ *               "match": ["*://*?app-logging-level=debug"],
+ *               "options": {
+ *                  "appLogLevel": "debug"
+ *               }
+ *           },
+ *        ]
+ *     }
+ *   }
+ * }
+ */
+declare type AppLogLevel = 'silent' | 'debug' | 'info' | 'warn' | 'error';
+
 /**
  * @interface
  */
@@ -9153,6 +9203,12 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+declare type LogPath = 'debug.log' | 'app.log';
+
+declare type LogTarget = {
+    type: LogPath;
+};
+
 /**
  * Log types
  *
@@ -9673,10 +9729,9 @@ declare type MutableViewOptions = {
      */
     chromiumPolicies: ChromiumPolicies;
     /**
-     * When set to `false`, disables sending application logs to RVM for this view.
-     * When omitted, inherits from the parent application.
+     * Specifies the AppLogLevel for the specified View. See {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 /**
@@ -9952,11 +10007,9 @@ declare type MutableWindowOptions = {
      */
     chromiumPolicies: ChromiumPolicies;
     /**
-     * When set to `false`, disables sending application logs to RVM for this window.
-     * When omitted, inherits from the parent application.
-     *
+     * Specifies the AppLogLevel for the Window. See {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -10355,6 +10408,9 @@ declare namespace OpenFin {
         InheritableOptions,
         PolicyOptions,
         ChromiumPolicies,
+        AppLogLevel,
+        LogPath,
+        LogTarget,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -10935,10 +10991,10 @@ 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.
+     * Allows the app log level of any matching content to be overriden.
+     * See also {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 /**
@@ -13275,10 +13331,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'get-current-window': VoidCall;
     'get-current-window-sync': VoidCall;
     'show-download-bubble': IdentityCall<{
-        options: OpenFin.Anchor;
+        anchor?: OpenFin.Anchor;
     }, void>;
     'update-download-bubble-anchor': IdentityCall<{
-        options: OpenFin.Anchor;
+        anchor: OpenFin.Anchor;
     }, void>;
     'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
     'external-application-wrap': VoidCall;
@@ -15693,16 +15749,14 @@ 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.
+     * @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: string, message: string, { type }?: {
-        type?: 'app.log' | 'debug.log';
-    }): Promise<void>;
+    log(level: string, message: string, target?: OpenFin.LogTarget): Promise<void>;
     /**
      * Opens the passed URL in the default web browser.
      *
@@ -16527,11 +16581,35 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     /**
      *  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
+     *     }
+     *   }
+     * ]);
+     * ```
      */
     setThemePalette(themePalette: Array<OpenFin.ThemePalette>): Promise<void>;
     /**
      * Retrieves currently used color overrides
      * @returns Array of ColorProviderOverrides objects
+     * @example
+     * ```ts
+     * const themePalette = await fin.System.getThemePalette();
+     * console.log(themePalette);
+     * ```
      */
     getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
 }
@@ -20251,8 +20329,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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);
+     * ```
      */
-    showDownloadBubble(options: OpenFin.Anchor): Promise<void>;
+    showDownloadBubble(anchor?: 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,
@@ -20264,8 +20353,27 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      *
      * @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");
+     * }
+     });
      */
-    updateDownloadBubbleAnchor(options: OpenFin.Anchor): Promise<void>;
+    updateDownloadBubbleAnchor(anchor: OpenFin.Anchor): Promise<void>;
 }
 
 /**

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

@@ -1417,6 +1417,56 @@ declare type ApplicationWindowInfo = {
     uuid: string;
 };
 
+/**
+ * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled  when the app logging feature is enabled for its application.
+ *
+ * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
+ *
+ * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
+ *
+ * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its options will be ignored.
+ *
+ * @default 'debug'
+ *
+ * @example Controlling App Logs With DefaultViewOptions + Domain Settings
+ *
+ * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
+ *
+ * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
+ *
+ * ```ts
+ * {
+ *   <rest of settings>
+ *   "platform": {
+ *      <rest of settings>
+ *     "enableAppLogging": "true",
+ *     "defaultViewOptions": {
+ *       "appLogLevel": "warn"
+ *     },
+ *     "domainSettings": {
+ *        "default": {  <rest of settings> }
+ *        "rules": [
+ *           <rest of rules>
+ *          {
+ *               "match": ["*://*?app-logging-level=silent"],
+ *               "options": {
+ *                  "appLogLevel": "silent"
+ *               }
+ *           },
+ *          {
+ *               "match": ["*://*?app-logging-level=debug"],
+ *               "options": {
+ *                  "appLogLevel": "debug"
+ *               }
+ *           },
+ *        ]
+ *     }
+ *   }
+ * }
+ */
+declare type AppLogLevel = 'silent' | 'debug' | 'info' | 'warn' | 'error';
+
 /**
  * @interface
  */
@@ -9153,6 +9203,12 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+declare type LogPath = 'debug.log' | 'app.log';
+
+declare type LogTarget = {
+    type: LogPath;
+};
+
 /**
  * Log types
  *
@@ -9673,10 +9729,9 @@ declare type MutableViewOptions = {
      */
     chromiumPolicies: ChromiumPolicies;
     /**
-     * When set to `false`, disables sending application logs to RVM for this view.
-     * When omitted, inherits from the parent application.
+     * Specifies the AppLogLevel for the specified View. See {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 /**
@@ -9952,11 +10007,9 @@ declare type MutableWindowOptions = {
      */
     chromiumPolicies: ChromiumPolicies;
     /**
-     * When set to `false`, disables sending application logs to RVM for this window.
-     * When omitted, inherits from the parent application.
-     *
+     * Specifies the AppLogLevel for the Window. See {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -10355,6 +10408,9 @@ declare namespace OpenFin {
         InheritableOptions,
         PolicyOptions,
         ChromiumPolicies,
+        AppLogLevel,
+        LogPath,
+        LogTarget,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -10935,10 +10991,10 @@ 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.
+     * Allows the app log level of any matching content to be overriden.
+     * See also {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 /**
@@ -13275,10 +13331,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'get-current-window': VoidCall;
     'get-current-window-sync': VoidCall;
     'show-download-bubble': IdentityCall<{
-        options: OpenFin.Anchor;
+        anchor?: OpenFin.Anchor;
     }, void>;
     'update-download-bubble-anchor': IdentityCall<{
-        options: OpenFin.Anchor;
+        anchor: OpenFin.Anchor;
     }, void>;
     'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
     'external-application-wrap': VoidCall;
@@ -15693,16 +15749,14 @@ 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.
+     * @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: string, message: string, { type }?: {
-        type?: 'app.log' | 'debug.log';
-    }): Promise<void>;
+    log(level: string, message: string, target?: OpenFin.LogTarget): Promise<void>;
     /**
      * Opens the passed URL in the default web browser.
      *
@@ -16527,11 +16581,35 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     /**
      *  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
+     *     }
+     *   }
+     * ]);
+     * ```
      */
     setThemePalette(themePalette: Array<OpenFin.ThemePalette>): Promise<void>;
     /**
      * Retrieves currently used color overrides
      * @returns Array of ColorProviderOverrides objects
+     * @example
+     * ```ts
+     * const themePalette = await fin.System.getThemePalette();
+     * console.log(themePalette);
+     * ```
      */
     getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
 }
@@ -20251,8 +20329,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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);
+     * ```
      */
-    showDownloadBubble(options: OpenFin.Anchor): Promise<void>;
+    showDownloadBubble(anchor?: 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,
@@ -20264,8 +20353,27 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      *
      * @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");
+     * }
+     });
      */
-    updateDownloadBubbleAnchor(options: OpenFin.Anchor): Promise<void>;
+    updateDownloadBubbleAnchor(anchor: OpenFin.Anchor): Promise<void>;
 }
 
 /**

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

@@ -1417,6 +1417,56 @@ declare type ApplicationWindowInfo = {
     uuid: string;
 };
 
+/**
+ * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled  when the app logging feature is enabled for its application.
+ *
+ * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
+ *
+ * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
+ *
+ * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its options will be ignored.
+ *
+ * @default 'debug'
+ *
+ * @example Controlling App Logs With DefaultViewOptions + Domain Settings
+ *
+ * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
+ *
+ * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
+ *
+ * ```ts
+ * {
+ *   <rest of settings>
+ *   "platform": {
+ *      <rest of settings>
+ *     "enableAppLogging": "true",
+ *     "defaultViewOptions": {
+ *       "appLogLevel": "warn"
+ *     },
+ *     "domainSettings": {
+ *        "default": {  <rest of settings> }
+ *        "rules": [
+ *           <rest of rules>
+ *          {
+ *               "match": ["*://*?app-logging-level=silent"],
+ *               "options": {
+ *                  "appLogLevel": "silent"
+ *               }
+ *           },
+ *          {
+ *               "match": ["*://*?app-logging-level=debug"],
+ *               "options": {
+ *                  "appLogLevel": "debug"
+ *               }
+ *           },
+ *        ]
+ *     }
+ *   }
+ * }
+ */
+declare type AppLogLevel = 'silent' | 'debug' | 'info' | 'warn' | 'error';
+
 /**
  * @interface
  */
@@ -9153,6 +9203,12 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+declare type LogPath = 'debug.log' | 'app.log';
+
+declare type LogTarget = {
+    type: LogPath;
+};
+
 /**
  * Log types
  *
@@ -9673,10 +9729,9 @@ declare type MutableViewOptions = {
      */
     chromiumPolicies: ChromiumPolicies;
     /**
-     * When set to `false`, disables sending application logs to RVM for this view.
-     * When omitted, inherits from the parent application.
+     * Specifies the AppLogLevel for the specified View. See {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 /**
@@ -9952,11 +10007,9 @@ declare type MutableWindowOptions = {
      */
     chromiumPolicies: ChromiumPolicies;
     /**
-     * When set to `false`, disables sending application logs to RVM for this window.
-     * When omitted, inherits from the parent application.
-     *
+     * Specifies the AppLogLevel for the Window. See {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -10355,6 +10408,9 @@ declare namespace OpenFin {
         InheritableOptions,
         PolicyOptions,
         ChromiumPolicies,
+        AppLogLevel,
+        LogPath,
+        LogTarget,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -10935,10 +10991,10 @@ 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.
+     * Allows the app log level of any matching content to be overriden.
+     * See also {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 /**
@@ -13275,10 +13331,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'get-current-window': VoidCall;
     'get-current-window-sync': VoidCall;
     'show-download-bubble': IdentityCall<{
-        options: OpenFin.Anchor;
+        anchor?: OpenFin.Anchor;
     }, void>;
     'update-download-bubble-anchor': IdentityCall<{
-        options: OpenFin.Anchor;
+        anchor: OpenFin.Anchor;
     }, void>;
     'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
     'external-application-wrap': VoidCall;
@@ -15693,16 +15749,14 @@ 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.
+     * @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: string, message: string, { type }?: {
-        type?: 'app.log' | 'debug.log';
-    }): Promise<void>;
+    log(level: string, message: string, target?: OpenFin.LogTarget): Promise<void>;
     /**
      * Opens the passed URL in the default web browser.
      *
@@ -16527,11 +16581,35 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     /**
      *  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
+     *     }
+     *   }
+     * ]);
+     * ```
      */
     setThemePalette(themePalette: Array<OpenFin.ThemePalette>): Promise<void>;
     /**
      * Retrieves currently used color overrides
      * @returns Array of ColorProviderOverrides objects
+     * @example
+     * ```ts
+     * const themePalette = await fin.System.getThemePalette();
+     * console.log(themePalette);
+     * ```
      */
     getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
 }
@@ -20251,8 +20329,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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);
+     * ```
      */
-    showDownloadBubble(options: OpenFin.Anchor): Promise<void>;
+    showDownloadBubble(anchor?: 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,
@@ -20264,8 +20353,27 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      *
      * @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");
+     * }
+     });
      */
-    updateDownloadBubbleAnchor(options: OpenFin.Anchor): Promise<void>;
+    updateDownloadBubbleAnchor(anchor: OpenFin.Anchor): Promise<void>;
 }
 
 /**

package/out/fdc3-api.d.ts

@@ -1423,6 +1423,56 @@ declare type ApplicationWindowInfo = {
     uuid: string;
 };
 
+/**
+ * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled  when the app logging feature is enabled for its application.
+ *
+ * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
+ *
+ * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
+ *
+ * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its options will be ignored.
+ *
+ * @default 'debug'
+ *
+ * @example Controlling App Logs With DefaultViewOptions + Domain Settings
+ *
+ * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
+ *
+ * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
+ *
+ * ```ts
+ * {
+ *   <rest of settings>
+ *   "platform": {
+ *      <rest of settings>
+ *     "enableAppLogging": "true",
+ *     "defaultViewOptions": {
+ *       "appLogLevel": "warn"
+ *     },
+ *     "domainSettings": {
+ *        "default": {  <rest of settings> }
+ *        "rules": [
+ *           <rest of rules>
+ *          {
+ *               "match": ["*://*?app-logging-level=silent"],
+ *               "options": {
+ *                  "appLogLevel": "silent"
+ *               }
+ *           },
+ *          {
+ *               "match": ["*://*?app-logging-level=debug"],
+ *               "options": {
+ *                  "appLogLevel": "debug"
+ *               }
+ *           },
+ *        ]
+ *     }
+ *   }
+ * }
+ */
+declare type AppLogLevel = 'silent' | 'debug' | 'info' | 'warn' | 'error';
+
 /**
  * @interface
  */
@@ -9462,6 +9512,12 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+declare type LogPath = 'debug.log' | 'app.log';
+
+declare type LogTarget = {
+    type: LogPath;
+};
+
 /**
  * Log types
  *
@@ -9986,10 +10042,9 @@ declare type MutableViewOptions = {
      */
     chromiumPolicies: ChromiumPolicies;
     /**
-     * When set to `false`, disables sending application logs to RVM for this view.
-     * When omitted, inherits from the parent application.
+     * Specifies the AppLogLevel for the specified View. See {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 /**
@@ -10273,11 +10328,9 @@ declare type MutableWindowOptions = {
      */
     chromiumPolicies: ChromiumPolicies;
     /**
-     * When set to `false`, disables sending application logs to RVM for this window.
-     * When omitted, inherits from the parent application.
-     *
+     * Specifies the AppLogLevel for the Window. See {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -10689,6 +10742,9 @@ declare namespace OpenFin {
         InheritableOptions,
         PolicyOptions,
         ChromiumPolicies,
+        AppLogLevel,
+        LogPath,
+        LogTarget,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -11269,10 +11325,10 @@ 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.
+     * Allows the app log level of any matching content to be overriden.
+     * See also {@link AppLogLevel} for more information.
      */
-    enableAppLogging?: boolean;
+    appLogLevel?: AppLogLevel;
 };
 
 /**
@@ -13692,10 +13748,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'get-current-window': VoidCall;
     'get-current-window-sync': VoidCall;
     'show-download-bubble': IdentityCall<{
-        options: OpenFin.Anchor;
+        anchor?: OpenFin.Anchor;
     }, void>;
     'update-download-bubble-anchor': IdentityCall<{
-        options: OpenFin.Anchor;
+        anchor: OpenFin.Anchor;
     }, void>;
     'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
     'external-application-wrap': VoidCall;
@@ -16116,16 +16172,14 @@ 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.
+     * @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: string, message: string, { type }?: {
-        type?: 'app.log' | 'debug.log';
-    }): Promise<void>;
+    log(level: string, message: string, target?: OpenFin.LogTarget): Promise<void>;
     /**
      * Opens the passed URL in the default web browser.
      *
@@ -16950,11 +17004,35 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     /**
      *  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
+     *     }
+     *   }
+     * ]);
+     * ```
      */
     setThemePalette(themePalette: Array<OpenFin.ThemePalette>): Promise<void>;
     /**
      * Retrieves currently used color overrides
      * @returns Array of ColorProviderOverrides objects
+     * @example
+     * ```ts
+     * const themePalette = await fin.System.getThemePalette();
+     * console.log(themePalette);
+     * ```
      */
     getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
 }
@@ -20721,8 +20799,19 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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);
+     * ```
      */
-    showDownloadBubble(options: OpenFin.Anchor): Promise<void>;
+    showDownloadBubble(anchor?: 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,
@@ -20734,8 +20823,27 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      *
      * @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");
+     * }
+     });
      */
-    updateDownloadBubbleAnchor(options: OpenFin.Anchor): Promise<void>;
+    updateDownloadBubbleAnchor(anchor: OpenFin.Anchor): Promise<void>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "44.100.57",
+    "version": "44.100.58",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,