@openfin/core 43.100.106 → 43.100.110

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1421,29 +1421,26 @@ declare type ApplicationWindowInfo = {
1421
1421
  };
1422
1422
 
1423
1423
  /**
1424
- * `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.
1424
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
1425
1425
  *
1426
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
1427
- *
1428
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
1429
- *
1430
- * 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
1431
- * controlling a url's appLogLevel, its options will be ignored.
1426
+ * 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
1427
+ * controlling a url's appLogLevel, its view/window options will be ignored.
1432
1428
  *
1433
1429
  * @default 'debug'
1434
1430
  *
1431
+ * Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
1432
+ *
1435
1433
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
1436
1434
  *
1437
1435
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
1438
1436
  *
1439
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
1437
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
1440
1438
  *
1441
1439
  * ```ts
1442
1440
  * {
1443
1441
  * <rest of settings>
1444
1442
  * "platform": {
1445
1443
  * <rest of settings>
1446
- * "enableAppLogging": "true",
1447
1444
  * "defaultViewOptions": {
1448
1445
  * "appLogLevel": "warn"
1449
1446
  * },
@@ -6282,7 +6279,28 @@ declare type Hotkey = {
6282
6279
  */
6283
6280
  keys: string;
6284
6281
  /**
6285
- * Prevent default key handling before emitting the event.
6282
+ * Controls the event phase at which the hotkey is triggered.
6283
+ *
6284
+ * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
6285
+ * This is the only phase where the `preventDefault` property is effective.
6286
+ *
6287
+ * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
6288
+ * This behaves exactly like a standard JavaScript event listener attached to the window:
6289
+ * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
6290
+ * 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.
6291
+ *
6292
+ * @default 'capture'
6293
+ */
6294
+ phase?: 'capture' | 'bubble';
6295
+ /**
6296
+ * Determines if the event should continue to the renderer.
6297
+ *
6298
+ * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
6299
+ * - `false`: The event is sent to the renderer after this hotkey executes.
6300
+ *
6301
+ * @remarks
6302
+ * This property is **only valid** when `phase` is set to `'capture'`.
6303
+ * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
6286
6304
  *
6287
6305
  * @default false
6288
6306
  */
@@ -9496,10 +9514,12 @@ declare type MutableWindowOptions = {
9496
9514
  */
9497
9515
  customData: any;
9498
9516
  /**
9499
- * @deprecated Will be removed in runtime version 45
9500
9517
  *
9501
9518
  * Show the window's frame.
9502
9519
  *
9520
+ * @remarks
9521
+ * This property will not be updatable starting runtime version 45.
9522
+ *
9503
9523
  * @default true
9504
9524
  */
9505
9525
  frame: boolean;
@@ -1421,29 +1421,26 @@ declare type ApplicationWindowInfo = {
1421
1421
  };
1422
1422
 
1423
1423
  /**
1424
- * `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.
1424
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
1425
1425
  *
1426
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
1427
- *
1428
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
1429
- *
1430
- * 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
1431
- * controlling a url's appLogLevel, its options will be ignored.
1426
+ * 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
1427
+ * controlling a url's appLogLevel, its view/window options will be ignored.
1432
1428
  *
1433
1429
  * @default 'debug'
1434
1430
  *
1431
+ * Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
1432
+ *
1435
1433
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
1436
1434
  *
1437
1435
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
1438
1436
  *
1439
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
1437
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
1440
1438
  *
1441
1439
  * ```ts
1442
1440
  * {
1443
1441
  * <rest of settings>
1444
1442
  * "platform": {
1445
1443
  * <rest of settings>
1446
- * "enableAppLogging": "true",
1447
1444
  * "defaultViewOptions": {
1448
1445
  * "appLogLevel": "warn"
1449
1446
  * },
@@ -6282,7 +6279,28 @@ declare type Hotkey = {
6282
6279
  */
6283
6280
  keys: string;
6284
6281
  /**
6285
- * Prevent default key handling before emitting the event.
6282
+ * Controls the event phase at which the hotkey is triggered.
6283
+ *
6284
+ * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
6285
+ * This is the only phase where the `preventDefault` property is effective.
6286
+ *
6287
+ * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
6288
+ * This behaves exactly like a standard JavaScript event listener attached to the window:
6289
+ * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
6290
+ * 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.
6291
+ *
6292
+ * @default 'capture'
6293
+ */
6294
+ phase?: 'capture' | 'bubble';
6295
+ /**
6296
+ * Determines if the event should continue to the renderer.
6297
+ *
6298
+ * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
6299
+ * - `false`: The event is sent to the renderer after this hotkey executes.
6300
+ *
6301
+ * @remarks
6302
+ * This property is **only valid** when `phase` is set to `'capture'`.
6303
+ * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
6286
6304
  *
6287
6305
  * @default false
6288
6306
  */
@@ -9496,10 +9514,12 @@ declare type MutableWindowOptions = {
9496
9514
  */
9497
9515
  customData: any;
9498
9516
  /**
9499
- * @deprecated Will be removed in runtime version 45
9500
9517
  *
9501
9518
  * Show the window's frame.
9502
9519
  *
9520
+ * @remarks
9521
+ * This property will not be updatable starting runtime version 45.
9522
+ *
9503
9523
  * @default true
9504
9524
  */
9505
9525
  frame: boolean;
@@ -1421,29 +1421,26 @@ declare type ApplicationWindowInfo = {
1421
1421
  };
1422
1422
 
1423
1423
  /**
1424
- * `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.
1424
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
1425
1425
  *
1426
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
1427
- *
1428
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
1429
- *
1430
- * 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
1431
- * controlling a url's appLogLevel, its options will be ignored.
1426
+ * 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
1427
+ * controlling a url's appLogLevel, its view/window options will be ignored.
1432
1428
  *
1433
1429
  * @default 'debug'
1434
1430
  *
1431
+ * Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
1432
+ *
1435
1433
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
1436
1434
  *
1437
1435
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
1438
1436
  *
1439
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
1437
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
1440
1438
  *
1441
1439
  * ```ts
1442
1440
  * {
1443
1441
  * <rest of settings>
1444
1442
  * "platform": {
1445
1443
  * <rest of settings>
1446
- * "enableAppLogging": "true",
1447
1444
  * "defaultViewOptions": {
1448
1445
  * "appLogLevel": "warn"
1449
1446
  * },
@@ -6282,7 +6279,28 @@ declare type Hotkey = {
6282
6279
  */
6283
6280
  keys: string;
6284
6281
  /**
6285
- * Prevent default key handling before emitting the event.
6282
+ * Controls the event phase at which the hotkey is triggered.
6283
+ *
6284
+ * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
6285
+ * This is the only phase where the `preventDefault` property is effective.
6286
+ *
6287
+ * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
6288
+ * This behaves exactly like a standard JavaScript event listener attached to the window:
6289
+ * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
6290
+ * 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.
6291
+ *
6292
+ * @default 'capture'
6293
+ */
6294
+ phase?: 'capture' | 'bubble';
6295
+ /**
6296
+ * Determines if the event should continue to the renderer.
6297
+ *
6298
+ * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
6299
+ * - `false`: The event is sent to the renderer after this hotkey executes.
6300
+ *
6301
+ * @remarks
6302
+ * This property is **only valid** when `phase` is set to `'capture'`.
6303
+ * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
6286
6304
  *
6287
6305
  * @default false
6288
6306
  */
@@ -9496,10 +9514,12 @@ declare type MutableWindowOptions = {
9496
9514
  */
9497
9515
  customData: any;
9498
9516
  /**
9499
- * @deprecated Will be removed in runtime version 45
9500
9517
  *
9501
9518
  * Show the window's frame.
9502
9519
  *
9520
+ * @remarks
9521
+ * This property will not be updatable starting runtime version 45.
9522
+ *
9503
9523
  * @default true
9504
9524
  */
9505
9525
  frame: boolean;
package/out/stub.d.ts CHANGED
@@ -1427,29 +1427,26 @@ declare type ApplicationWindowInfo = {
1427
1427
  };
1428
1428
 
1429
1429
  /**
1430
- * `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.
1430
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
1431
1431
  *
1432
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
1433
- *
1434
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
1435
- *
1436
- * 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
1437
- * controlling a url's appLogLevel, its options will be ignored.
1432
+ * 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
1433
+ * controlling a url's appLogLevel, its view/window options will be ignored.
1438
1434
  *
1439
1435
  * @default 'debug'
1440
1436
  *
1437
+ * Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
1438
+ *
1441
1439
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
1442
1440
  *
1443
1441
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
1444
1442
  *
1445
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
1443
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
1446
1444
  *
1447
1445
  * ```ts
1448
1446
  * {
1449
1447
  * <rest of settings>
1450
1448
  * "platform": {
1451
1449
  * <rest of settings>
1452
- * "enableAppLogging": "true",
1453
1450
  * "defaultViewOptions": {
1454
1451
  * "appLogLevel": "warn"
1455
1452
  * },
@@ -6373,7 +6370,28 @@ declare type Hotkey = {
6373
6370
  */
6374
6371
  keys: string;
6375
6372
  /**
6376
- * Prevent default key handling before emitting the event.
6373
+ * Controls the event phase at which the hotkey is triggered.
6374
+ *
6375
+ * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
6376
+ * This is the only phase where the `preventDefault` property is effective.
6377
+ *
6378
+ * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
6379
+ * This behaves exactly like a standard JavaScript event listener attached to the window:
6380
+ * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
6381
+ * 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.
6382
+ *
6383
+ * @default 'capture'
6384
+ */
6385
+ phase?: 'capture' | 'bubble';
6386
+ /**
6387
+ * Determines if the event should continue to the renderer.
6388
+ *
6389
+ * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
6390
+ * - `false`: The event is sent to the renderer after this hotkey executes.
6391
+ *
6392
+ * @remarks
6393
+ * This property is **only valid** when `phase` is set to `'capture'`.
6394
+ * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
6377
6395
  *
6378
6396
  * @default false
6379
6397
  */
@@ -9809,10 +9827,12 @@ declare type MutableWindowOptions = {
9809
9827
  */
9810
9828
  customData: any;
9811
9829
  /**
9812
- * @deprecated Will be removed in runtime version 45
9813
9830
  *
9814
9831
  * Show the window's frame.
9815
9832
  *
9833
+ * @remarks
9834
+ * This property will not be updatable starting runtime version 45.
9835
+ *
9816
9836
  * @default true
9817
9837
  */
9818
9838
  frame: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "43.100.106",
3
+ "version": "43.100.110",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/stub.js",