@openfin/fdc3-api 43.100.106 → 43.100.110

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

@@ -1418,29 +1418,26 @@ declare type ApplicationWindowInfo = {
 };
 
 /**
- * `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.
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled 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.
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its view/window options will be ignored.
  *
  * @default 'debug'
  *
+ * Please note, if the manifest setting `platform.enableAppLogging`  or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
+ *
  * @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.
+ * We also use domain settings to suppress logs 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"
  *     },
@@ -6624,7 +6621,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */
@@ -9838,10 +9856,12 @@ declare type MutableWindowOptions = {
      */
     customData: any;
     /**
-     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      *
+     * @remarks
+     * This property will not be updatable starting runtime version 45.
+     *
      * @default true
      */
     frame: boolean;

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

@@ -1418,29 +1418,26 @@ declare type ApplicationWindowInfo = {
 };
 
 /**
- * `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.
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled 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.
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its view/window options will be ignored.
  *
  * @default 'debug'
  *
+ * Please note, if the manifest setting `platform.enableAppLogging`  or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
+ *
  * @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.
+ * We also use domain settings to suppress logs 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"
  *     },
@@ -6624,7 +6621,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */
@@ -9838,10 +9856,12 @@ declare type MutableWindowOptions = {
      */
     customData: any;
     /**
-     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      *
+     * @remarks
+     * This property will not be updatable starting runtime version 45.
+     *
      * @default true
      */
     frame: boolean;

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

@@ -1418,29 +1418,26 @@ declare type ApplicationWindowInfo = {
 };
 
 /**
- * `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.
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled 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.
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its view/window options will be ignored.
  *
  * @default 'debug'
  *
+ * Please note, if the manifest setting `platform.enableAppLogging`  or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
+ *
  * @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.
+ * We also use domain settings to suppress logs 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"
  *     },
@@ -6624,7 +6621,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */
@@ -9838,10 +9856,12 @@ declare type MutableWindowOptions = {
      */
     customData: any;
     /**
-     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      *
+     * @remarks
+     * This property will not be updatable starting runtime version 45.
+     *
      * @default true
      */
     frame: boolean;

package/out/fdc3-api.d.ts

@@ -1424,29 +1424,26 @@ declare type ApplicationWindowInfo = {
 };
 
 /**
- * `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.
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled 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.
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its view/window options will be ignored.
  *
  * @default 'debug'
  *
+ * Please note, if the manifest setting `platform.enableAppLogging`  or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
+ *
  * @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.
+ * We also use domain settings to suppress logs 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"
  *     },
@@ -6715,7 +6712,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */
@@ -10151,10 +10169,12 @@ declare type MutableWindowOptions = {
      */
     customData: any;
     /**
-     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      *
+     * @remarks
+     * This property will not be updatable starting runtime version 45.
+     *
      * @default true
      */
     frame: boolean;

package/package.json

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