@openfin/core 45.100.58 → 45.100.60

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.
@@ -16446,6 +16446,13 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
16446
16446
  declare class SystemContentTracing extends Base {
16447
16447
  /**
16448
16448
  * Gets the currently known tracing category groups.
16449
+ *
16450
+ * @example
16451
+ * ```ts
16452
+ * const categories = await fin.System.ContentTracing.getCategories();
16453
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
16454
+ * console.log(`Loaded ${sorted.length} tracing categories`);
16455
+ * ```
16449
16456
  */
16450
16457
  getCategories(): Promise<string[]>;
16451
16458
  /**
@@ -16453,6 +16460,29 @@ declare class SystemContentTracing extends Base {
16453
16460
  *
16454
16461
  * Only one content tracing session may be active across the runtime at a time.
16455
16462
  * This method rejects if another identity already owns the active session.
16463
+ *
16464
+ * @example
16465
+ * ```ts
16466
+ * await fin.System.ContentTracing.startRecording({
16467
+ * recording_mode: 'record-as-much-as-possible',
16468
+ * included_categories: [
16469
+ * '*',
16470
+ * 'disabled-by-default-blink.invalidation',
16471
+ * 'disabled-by-default-cc.debug',
16472
+ * 'disabled-by-default-viz.surface_id_flow'
16473
+ * ]
16474
+ * });
16475
+ *
16476
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
16477
+ * ```
16478
+ *
16479
+ * @example
16480
+ * ```ts
16481
+ * await fin.System.ContentTracing.startRecording({
16482
+ * categoryFilter: 'electron,blink,cc',
16483
+ * traceOptions: 'record-until-full,enable-sampling'
16484
+ * });
16485
+ * ```
16456
16486
  */
16457
16487
  startRecording(options: OpenFin_2.TraceConfig | OpenFin_2.TraceCategoriesAndOptions): Promise<void>;
16458
16488
  /**
@@ -16460,12 +16490,29 @@ declare class SystemContentTracing extends Base {
16460
16490
  *
16461
16491
  * The calling identity must match the identity that started the active tracing session.
16462
16492
  * This method rejects if tracing is not active or is owned by another identity.
16493
+ *
16494
+ * @example
16495
+ * ```ts
16496
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
16497
+ * console.log('Trace written to:', tracePath);
16498
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
16499
+ * ```
16463
16500
  */
16464
16501
  stopRecording(): Promise<string>;
16465
16502
  /**
16466
16503
  * Returns the current maximum trace buffer usage across processes.
16467
16504
  *
16468
16505
  * This method is not supported on macOS and rejects on that platform.
16506
+ *
16507
+ * @example
16508
+ * ```ts
16509
+ * try {
16510
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
16511
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
16512
+ * } catch (error) {
16513
+ * console.warn('Trace buffer usage is not available on this platform.', error);
16514
+ * }
16515
+ * ```
16469
16516
  */
16470
16517
  getTraceBufferUsage(): Promise<OpenFin_2.TraceBufferUsage>;
16471
16518
  }
@@ -16446,6 +16446,13 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
16446
16446
  declare class SystemContentTracing extends Base {
16447
16447
  /**
16448
16448
  * Gets the currently known tracing category groups.
16449
+ *
16450
+ * @example
16451
+ * ```ts
16452
+ * const categories = await fin.System.ContentTracing.getCategories();
16453
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
16454
+ * console.log(`Loaded ${sorted.length} tracing categories`);
16455
+ * ```
16449
16456
  */
16450
16457
  getCategories(): Promise<string[]>;
16451
16458
  /**
@@ -16453,6 +16460,29 @@ declare class SystemContentTracing extends Base {
16453
16460
  *
16454
16461
  * Only one content tracing session may be active across the runtime at a time.
16455
16462
  * This method rejects if another identity already owns the active session.
16463
+ *
16464
+ * @example
16465
+ * ```ts
16466
+ * await fin.System.ContentTracing.startRecording({
16467
+ * recording_mode: 'record-as-much-as-possible',
16468
+ * included_categories: [
16469
+ * '*',
16470
+ * 'disabled-by-default-blink.invalidation',
16471
+ * 'disabled-by-default-cc.debug',
16472
+ * 'disabled-by-default-viz.surface_id_flow'
16473
+ * ]
16474
+ * });
16475
+ *
16476
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
16477
+ * ```
16478
+ *
16479
+ * @example
16480
+ * ```ts
16481
+ * await fin.System.ContentTracing.startRecording({
16482
+ * categoryFilter: 'electron,blink,cc',
16483
+ * traceOptions: 'record-until-full,enable-sampling'
16484
+ * });
16485
+ * ```
16456
16486
  */
16457
16487
  startRecording(options: OpenFin_2.TraceConfig | OpenFin_2.TraceCategoriesAndOptions): Promise<void>;
16458
16488
  /**
@@ -16460,12 +16490,29 @@ declare class SystemContentTracing extends Base {
16460
16490
  *
16461
16491
  * The calling identity must match the identity that started the active tracing session.
16462
16492
  * This method rejects if tracing is not active or is owned by another identity.
16493
+ *
16494
+ * @example
16495
+ * ```ts
16496
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
16497
+ * console.log('Trace written to:', tracePath);
16498
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
16499
+ * ```
16463
16500
  */
16464
16501
  stopRecording(): Promise<string>;
16465
16502
  /**
16466
16503
  * Returns the current maximum trace buffer usage across processes.
16467
16504
  *
16468
16505
  * This method is not supported on macOS and rejects on that platform.
16506
+ *
16507
+ * @example
16508
+ * ```ts
16509
+ * try {
16510
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
16511
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
16512
+ * } catch (error) {
16513
+ * console.warn('Trace buffer usage is not available on this platform.', error);
16514
+ * }
16515
+ * ```
16469
16516
  */
16470
16517
  getTraceBufferUsage(): Promise<OpenFin_2.TraceBufferUsage>;
16471
16518
  }
@@ -16446,6 +16446,13 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
16446
16446
  declare class SystemContentTracing extends Base {
16447
16447
  /**
16448
16448
  * Gets the currently known tracing category groups.
16449
+ *
16450
+ * @example
16451
+ * ```ts
16452
+ * const categories = await fin.System.ContentTracing.getCategories();
16453
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
16454
+ * console.log(`Loaded ${sorted.length} tracing categories`);
16455
+ * ```
16449
16456
  */
16450
16457
  getCategories(): Promise<string[]>;
16451
16458
  /**
@@ -16453,6 +16460,29 @@ declare class SystemContentTracing extends Base {
16453
16460
  *
16454
16461
  * Only one content tracing session may be active across the runtime at a time.
16455
16462
  * This method rejects if another identity already owns the active session.
16463
+ *
16464
+ * @example
16465
+ * ```ts
16466
+ * await fin.System.ContentTracing.startRecording({
16467
+ * recording_mode: 'record-as-much-as-possible',
16468
+ * included_categories: [
16469
+ * '*',
16470
+ * 'disabled-by-default-blink.invalidation',
16471
+ * 'disabled-by-default-cc.debug',
16472
+ * 'disabled-by-default-viz.surface_id_flow'
16473
+ * ]
16474
+ * });
16475
+ *
16476
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
16477
+ * ```
16478
+ *
16479
+ * @example
16480
+ * ```ts
16481
+ * await fin.System.ContentTracing.startRecording({
16482
+ * categoryFilter: 'electron,blink,cc',
16483
+ * traceOptions: 'record-until-full,enable-sampling'
16484
+ * });
16485
+ * ```
16456
16486
  */
16457
16487
  startRecording(options: OpenFin_2.TraceConfig | OpenFin_2.TraceCategoriesAndOptions): Promise<void>;
16458
16488
  /**
@@ -16460,12 +16490,29 @@ declare class SystemContentTracing extends Base {
16460
16490
  *
16461
16491
  * The calling identity must match the identity that started the active tracing session.
16462
16492
  * This method rejects if tracing is not active or is owned by another identity.
16493
+ *
16494
+ * @example
16495
+ * ```ts
16496
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
16497
+ * console.log('Trace written to:', tracePath);
16498
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
16499
+ * ```
16463
16500
  */
16464
16501
  stopRecording(): Promise<string>;
16465
16502
  /**
16466
16503
  * Returns the current maximum trace buffer usage across processes.
16467
16504
  *
16468
16505
  * This method is not supported on macOS and rejects on that platform.
16506
+ *
16507
+ * @example
16508
+ * ```ts
16509
+ * try {
16510
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
16511
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
16512
+ * } catch (error) {
16513
+ * console.warn('Trace buffer usage is not available on this platform.', error);
16514
+ * }
16515
+ * ```
16469
16516
  */
16470
16517
  getTraceBufferUsage(): Promise<OpenFin_2.TraceBufferUsage>;
16471
16518
  }
package/out/stub.d.ts CHANGED
@@ -16869,6 +16869,13 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
16869
16869
  declare class SystemContentTracing extends Base {
16870
16870
  /**
16871
16871
  * Gets the currently known tracing category groups.
16872
+ *
16873
+ * @example
16874
+ * ```ts
16875
+ * const categories = await fin.System.ContentTracing.getCategories();
16876
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
16877
+ * console.log(`Loaded ${sorted.length} tracing categories`);
16878
+ * ```
16872
16879
  */
16873
16880
  getCategories(): Promise<string[]>;
16874
16881
  /**
@@ -16876,6 +16883,29 @@ declare class SystemContentTracing extends Base {
16876
16883
  *
16877
16884
  * Only one content tracing session may be active across the runtime at a time.
16878
16885
  * This method rejects if another identity already owns the active session.
16886
+ *
16887
+ * @example
16888
+ * ```ts
16889
+ * await fin.System.ContentTracing.startRecording({
16890
+ * recording_mode: 'record-as-much-as-possible',
16891
+ * included_categories: [
16892
+ * '*',
16893
+ * 'disabled-by-default-blink.invalidation',
16894
+ * 'disabled-by-default-cc.debug',
16895
+ * 'disabled-by-default-viz.surface_id_flow'
16896
+ * ]
16897
+ * });
16898
+ *
16899
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
16900
+ * ```
16901
+ *
16902
+ * @example
16903
+ * ```ts
16904
+ * await fin.System.ContentTracing.startRecording({
16905
+ * categoryFilter: 'electron,blink,cc',
16906
+ * traceOptions: 'record-until-full,enable-sampling'
16907
+ * });
16908
+ * ```
16879
16909
  */
16880
16910
  startRecording(options: OpenFin_2.TraceConfig | OpenFin_2.TraceCategoriesAndOptions): Promise<void>;
16881
16911
  /**
@@ -16883,12 +16913,29 @@ declare class SystemContentTracing extends Base {
16883
16913
  *
16884
16914
  * The calling identity must match the identity that started the active tracing session.
16885
16915
  * This method rejects if tracing is not active or is owned by another identity.
16916
+ *
16917
+ * @example
16918
+ * ```ts
16919
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
16920
+ * console.log('Trace written to:', tracePath);
16921
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
16922
+ * ```
16886
16923
  */
16887
16924
  stopRecording(): Promise<string>;
16888
16925
  /**
16889
16926
  * Returns the current maximum trace buffer usage across processes.
16890
16927
  *
16891
16928
  * This method is not supported on macOS and rejects on that platform.
16929
+ *
16930
+ * @example
16931
+ * ```ts
16932
+ * try {
16933
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
16934
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
16935
+ * } catch (error) {
16936
+ * console.warn('Trace buffer usage is not available on this platform.', error);
16937
+ * }
16938
+ * ```
16892
16939
  */
16893
16940
  getTraceBufferUsage(): Promise<OpenFin_2.TraceBufferUsage>;
16894
16941
  }
package/out/stub.js CHANGED
@@ -3,7 +3,7 @@
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var events = require('events');
6
- var isEqual = require('lodash/isEqual');
6
+ var esToolkit = require('es-toolkit');
7
7
 
8
8
  /**
9
9
  * Namespace for events that can be emitted by an {@link OpenFin.Application}. Includes events
@@ -4999,6 +4999,13 @@ class _WindowModule extends Base {
4999
4999
  class SystemContentTracing extends Base {
5000
5000
  /**
5001
5001
  * Gets the currently known tracing category groups.
5002
+ *
5003
+ * @example
5004
+ * ```ts
5005
+ * const categories = await fin.System.ContentTracing.getCategories();
5006
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
5007
+ * console.log(`Loaded ${sorted.length} tracing categories`);
5008
+ * ```
5002
5009
  */
5003
5010
  async getCategories() {
5004
5011
  const { payload } = await this.wire.sendAction('content-tracing-get-categories');
@@ -5009,6 +5016,29 @@ class SystemContentTracing extends Base {
5009
5016
  *
5010
5017
  * Only one content tracing session may be active across the runtime at a time.
5011
5018
  * This method rejects if another identity already owns the active session.
5019
+ *
5020
+ * @example
5021
+ * ```ts
5022
+ * await fin.System.ContentTracing.startRecording({
5023
+ * recording_mode: 'record-as-much-as-possible',
5024
+ * included_categories: [
5025
+ * '*',
5026
+ * 'disabled-by-default-blink.invalidation',
5027
+ * 'disabled-by-default-cc.debug',
5028
+ * 'disabled-by-default-viz.surface_id_flow'
5029
+ * ]
5030
+ * });
5031
+ *
5032
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
5033
+ * ```
5034
+ *
5035
+ * @example
5036
+ * ```ts
5037
+ * await fin.System.ContentTracing.startRecording({
5038
+ * categoryFilter: 'electron,blink,cc',
5039
+ * traceOptions: 'record-until-full,enable-sampling'
5040
+ * });
5041
+ * ```
5012
5042
  */
5013
5043
  async startRecording(options) {
5014
5044
  await this.wire.sendAction('content-tracing-start-recording', { options });
@@ -5018,6 +5048,13 @@ class SystemContentTracing extends Base {
5018
5048
  *
5019
5049
  * The calling identity must match the identity that started the active tracing session.
5020
5050
  * This method rejects if tracing is not active or is owned by another identity.
5051
+ *
5052
+ * @example
5053
+ * ```ts
5054
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
5055
+ * console.log('Trace written to:', tracePath);
5056
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
5057
+ * ```
5021
5058
  */
5022
5059
  async stopRecording() {
5023
5060
  const { payload } = await this.wire.sendAction('content-tracing-stop-recording');
@@ -5027,6 +5064,16 @@ class SystemContentTracing extends Base {
5027
5064
  * Returns the current maximum trace buffer usage across processes.
5028
5065
  *
5029
5066
  * This method is not supported on macOS and rejects on that platform.
5067
+ *
5068
+ * @example
5069
+ * ```ts
5070
+ * try {
5071
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
5072
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
5073
+ * } catch (error) {
5074
+ * console.warn('Trace buffer usage is not available on this platform.', error);
5075
+ * }
5076
+ * ```
5030
5077
  */
5031
5078
  async getTraceBufferUsage() {
5032
5079
  const { payload } = await this.wire.sendAction('content-tracing-get-trace-buffer-usage');
@@ -13052,7 +13099,7 @@ class InteropBroker extends Base {
13052
13099
  constructor(...unused) {
13053
13100
  if (unused.length) {
13054
13101
  const [_ignore1, ignore2, opts] = unused;
13055
- if (opts && typeof opts === 'object' && !isEqual(opts, args[2])) {
13102
+ if (opts && typeof opts === 'object' && !esToolkit.isEqual(opts, args[2])) {
13056
13103
  // eslint-disable-next-line no-console
13057
13104
  console.warn('You have modified the parameters of the InteropOverride constructor. This behavior is deprecated and will be removed in a future version. You can modify these options in your manifest. Please consult our Interop docs for guidance on migrating to the new override scheme.');
13058
13105
  super(args[0], args[1], opts);
@@ -15088,7 +15135,7 @@ const createV1Channel = (sessionContextGroup) => {
15088
15135
  const wrappedHandler = (context, contextMetadata) => {
15089
15136
  if (first) {
15090
15137
  first = false;
15091
- if (isEqual(currentContext, context)) {
15138
+ if (esToolkit.isEqual(currentContext, context)) {
15092
15139
  return;
15093
15140
  }
15094
15141
  }
@@ -15496,7 +15543,7 @@ class FDC3ModuleBase {
15496
15543
  const wrappedHandler = (context, contextMetadata) => {
15497
15544
  if (first) {
15498
15545
  first = false;
15499
- if (isEqual(currentContext, context)) {
15546
+ if (esToolkit.isEqual(currentContext, context)) {
15500
15547
  return;
15501
15548
  }
15502
15549
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "45.100.58",
3
+ "version": "45.100.60",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/stub.js",
@@ -18,7 +18,7 @@
18
18
  "dependencies": {
19
19
  "@types/node": "^20.14.2",
20
20
  "events": "^3.0.0",
21
- "lodash": "^4.17.21",
21
+ "es-toolkit": "^1.39.3",
22
22
  "ws": "^7.5.10",
23
23
  "tslib": "2.8.1"
24
24
  },