@openfin/fdc3-api 45.100.59 → 45.100.61

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.
@@ -16786,6 +16786,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
16786
16786
  declare class SystemContentTracing extends Base {
16787
16787
  /**
16788
16788
  * Gets the currently known tracing category groups.
16789
+ *
16790
+ * @example
16791
+ * ```ts
16792
+ * const categories = await fin.System.ContentTracing.getCategories();
16793
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
16794
+ * console.log(`Loaded ${sorted.length} tracing categories`);
16795
+ * ```
16789
16796
  */
16790
16797
  getCategories(): Promise<string[]>;
16791
16798
  /**
@@ -16793,6 +16800,29 @@ declare class SystemContentTracing extends Base {
16793
16800
  *
16794
16801
  * Only one content tracing session may be active across the runtime at a time.
16795
16802
  * This method rejects if another identity already owns the active session.
16803
+ *
16804
+ * @example
16805
+ * ```ts
16806
+ * await fin.System.ContentTracing.startRecording({
16807
+ * recording_mode: 'record-as-much-as-possible',
16808
+ * included_categories: [
16809
+ * '*',
16810
+ * 'disabled-by-default-blink.invalidation',
16811
+ * 'disabled-by-default-cc.debug',
16812
+ * 'disabled-by-default-viz.surface_id_flow'
16813
+ * ]
16814
+ * });
16815
+ *
16816
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
16817
+ * ```
16818
+ *
16819
+ * @example
16820
+ * ```ts
16821
+ * await fin.System.ContentTracing.startRecording({
16822
+ * categoryFilter: 'electron,blink,cc',
16823
+ * traceOptions: 'record-until-full,enable-sampling'
16824
+ * });
16825
+ * ```
16796
16826
  */
16797
16827
  startRecording(options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions): Promise<void>;
16798
16828
  /**
@@ -16800,12 +16830,29 @@ declare class SystemContentTracing extends Base {
16800
16830
  *
16801
16831
  * The calling identity must match the identity that started the active tracing session.
16802
16832
  * This method rejects if tracing is not active or is owned by another identity.
16833
+ *
16834
+ * @example
16835
+ * ```ts
16836
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
16837
+ * console.log('Trace written to:', tracePath);
16838
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
16839
+ * ```
16803
16840
  */
16804
16841
  stopRecording(): Promise<string>;
16805
16842
  /**
16806
16843
  * Returns the current maximum trace buffer usage across processes.
16807
16844
  *
16808
16845
  * This method is not supported on macOS and rejects on that platform.
16846
+ *
16847
+ * @example
16848
+ * ```ts
16849
+ * try {
16850
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
16851
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
16852
+ * } catch (error) {
16853
+ * console.warn('Trace buffer usage is not available on this platform.', error);
16854
+ * }
16855
+ * ```
16809
16856
  */
16810
16857
  getTraceBufferUsage(): Promise<OpenFin.TraceBufferUsage>;
16811
16858
  }
@@ -16786,6 +16786,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
16786
16786
  declare class SystemContentTracing extends Base {
16787
16787
  /**
16788
16788
  * Gets the currently known tracing category groups.
16789
+ *
16790
+ * @example
16791
+ * ```ts
16792
+ * const categories = await fin.System.ContentTracing.getCategories();
16793
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
16794
+ * console.log(`Loaded ${sorted.length} tracing categories`);
16795
+ * ```
16789
16796
  */
16790
16797
  getCategories(): Promise<string[]>;
16791
16798
  /**
@@ -16793,6 +16800,29 @@ declare class SystemContentTracing extends Base {
16793
16800
  *
16794
16801
  * Only one content tracing session may be active across the runtime at a time.
16795
16802
  * This method rejects if another identity already owns the active session.
16803
+ *
16804
+ * @example
16805
+ * ```ts
16806
+ * await fin.System.ContentTracing.startRecording({
16807
+ * recording_mode: 'record-as-much-as-possible',
16808
+ * included_categories: [
16809
+ * '*',
16810
+ * 'disabled-by-default-blink.invalidation',
16811
+ * 'disabled-by-default-cc.debug',
16812
+ * 'disabled-by-default-viz.surface_id_flow'
16813
+ * ]
16814
+ * });
16815
+ *
16816
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
16817
+ * ```
16818
+ *
16819
+ * @example
16820
+ * ```ts
16821
+ * await fin.System.ContentTracing.startRecording({
16822
+ * categoryFilter: 'electron,blink,cc',
16823
+ * traceOptions: 'record-until-full,enable-sampling'
16824
+ * });
16825
+ * ```
16796
16826
  */
16797
16827
  startRecording(options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions): Promise<void>;
16798
16828
  /**
@@ -16800,12 +16830,29 @@ declare class SystemContentTracing extends Base {
16800
16830
  *
16801
16831
  * The calling identity must match the identity that started the active tracing session.
16802
16832
  * This method rejects if tracing is not active or is owned by another identity.
16833
+ *
16834
+ * @example
16835
+ * ```ts
16836
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
16837
+ * console.log('Trace written to:', tracePath);
16838
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
16839
+ * ```
16803
16840
  */
16804
16841
  stopRecording(): Promise<string>;
16805
16842
  /**
16806
16843
  * Returns the current maximum trace buffer usage across processes.
16807
16844
  *
16808
16845
  * This method is not supported on macOS and rejects on that platform.
16846
+ *
16847
+ * @example
16848
+ * ```ts
16849
+ * try {
16850
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
16851
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
16852
+ * } catch (error) {
16853
+ * console.warn('Trace buffer usage is not available on this platform.', error);
16854
+ * }
16855
+ * ```
16809
16856
  */
16810
16857
  getTraceBufferUsage(): Promise<OpenFin.TraceBufferUsage>;
16811
16858
  }
@@ -16786,6 +16786,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
16786
16786
  declare class SystemContentTracing extends Base {
16787
16787
  /**
16788
16788
  * Gets the currently known tracing category groups.
16789
+ *
16790
+ * @example
16791
+ * ```ts
16792
+ * const categories = await fin.System.ContentTracing.getCategories();
16793
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
16794
+ * console.log(`Loaded ${sorted.length} tracing categories`);
16795
+ * ```
16789
16796
  */
16790
16797
  getCategories(): Promise<string[]>;
16791
16798
  /**
@@ -16793,6 +16800,29 @@ declare class SystemContentTracing extends Base {
16793
16800
  *
16794
16801
  * Only one content tracing session may be active across the runtime at a time.
16795
16802
  * This method rejects if another identity already owns the active session.
16803
+ *
16804
+ * @example
16805
+ * ```ts
16806
+ * await fin.System.ContentTracing.startRecording({
16807
+ * recording_mode: 'record-as-much-as-possible',
16808
+ * included_categories: [
16809
+ * '*',
16810
+ * 'disabled-by-default-blink.invalidation',
16811
+ * 'disabled-by-default-cc.debug',
16812
+ * 'disabled-by-default-viz.surface_id_flow'
16813
+ * ]
16814
+ * });
16815
+ *
16816
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
16817
+ * ```
16818
+ *
16819
+ * @example
16820
+ * ```ts
16821
+ * await fin.System.ContentTracing.startRecording({
16822
+ * categoryFilter: 'electron,blink,cc',
16823
+ * traceOptions: 'record-until-full,enable-sampling'
16824
+ * });
16825
+ * ```
16796
16826
  */
16797
16827
  startRecording(options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions): Promise<void>;
16798
16828
  /**
@@ -16800,12 +16830,29 @@ declare class SystemContentTracing extends Base {
16800
16830
  *
16801
16831
  * The calling identity must match the identity that started the active tracing session.
16802
16832
  * This method rejects if tracing is not active or is owned by another identity.
16833
+ *
16834
+ * @example
16835
+ * ```ts
16836
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
16837
+ * console.log('Trace written to:', tracePath);
16838
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
16839
+ * ```
16803
16840
  */
16804
16841
  stopRecording(): Promise<string>;
16805
16842
  /**
16806
16843
  * Returns the current maximum trace buffer usage across processes.
16807
16844
  *
16808
16845
  * This method is not supported on macOS and rejects on that platform.
16846
+ *
16847
+ * @example
16848
+ * ```ts
16849
+ * try {
16850
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
16851
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
16852
+ * } catch (error) {
16853
+ * console.warn('Trace buffer usage is not available on this platform.', error);
16854
+ * }
16855
+ * ```
16809
16856
  */
16810
16857
  getTraceBufferUsage(): Promise<OpenFin.TraceBufferUsage>;
16811
16858
  }
package/out/fdc3-api.d.ts CHANGED
@@ -17209,6 +17209,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
17209
17209
  declare class SystemContentTracing extends Base {
17210
17210
  /**
17211
17211
  * Gets the currently known tracing category groups.
17212
+ *
17213
+ * @example
17214
+ * ```ts
17215
+ * const categories = await fin.System.ContentTracing.getCategories();
17216
+ * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
17217
+ * console.log(`Loaded ${sorted.length} tracing categories`);
17218
+ * ```
17212
17219
  */
17213
17220
  getCategories(): Promise<string[]>;
17214
17221
  /**
@@ -17216,6 +17223,29 @@ declare class SystemContentTracing extends Base {
17216
17223
  *
17217
17224
  * Only one content tracing session may be active across the runtime at a time.
17218
17225
  * This method rejects if another identity already owns the active session.
17226
+ *
17227
+ * @example
17228
+ * ```ts
17229
+ * await fin.System.ContentTracing.startRecording({
17230
+ * recording_mode: 'record-as-much-as-possible',
17231
+ * included_categories: [
17232
+ * '*',
17233
+ * 'disabled-by-default-blink.invalidation',
17234
+ * 'disabled-by-default-cc.debug',
17235
+ * 'disabled-by-default-viz.surface_id_flow'
17236
+ * ]
17237
+ * });
17238
+ *
17239
+ * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
17240
+ * ```
17241
+ *
17242
+ * @example
17243
+ * ```ts
17244
+ * await fin.System.ContentTracing.startRecording({
17245
+ * categoryFilter: 'electron,blink,cc',
17246
+ * traceOptions: 'record-until-full,enable-sampling'
17247
+ * });
17248
+ * ```
17219
17249
  */
17220
17250
  startRecording(options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions): Promise<void>;
17221
17251
  /**
@@ -17223,12 +17253,29 @@ declare class SystemContentTracing extends Base {
17223
17253
  *
17224
17254
  * The calling identity must match the identity that started the active tracing session.
17225
17255
  * This method rejects if tracing is not active or is owned by another identity.
17256
+ *
17257
+ * @example
17258
+ * ```ts
17259
+ * const tracePath = await fin.System.ContentTracing.stopRecording();
17260
+ * console.log('Trace written to:', tracePath);
17261
+ * // Load the file in chrome://tracing or https://ui.perfetto.dev/
17262
+ * ```
17226
17263
  */
17227
17264
  stopRecording(): Promise<string>;
17228
17265
  /**
17229
17266
  * Returns the current maximum trace buffer usage across processes.
17230
17267
  *
17231
17268
  * This method is not supported on macOS and rejects on that platform.
17269
+ *
17270
+ * @example
17271
+ * ```ts
17272
+ * try {
17273
+ * const usage = await fin.System.ContentTracing.getTraceBufferUsage();
17274
+ * console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
17275
+ * } catch (error) {
17276
+ * console.warn('Trace buffer usage is not available on this platform.', error);
17277
+ * }
17278
+ * ```
17232
17279
  */
17233
17280
  getTraceBufferUsage(): Promise<OpenFin.TraceBufferUsage>;
17234
17281
  }
package/out/fdc3-api.js CHANGED
@@ -1,6 +1,6 @@
1
1
  'use strict';
2
2
 
3
- var isEqual = require('lodash/isEqual');
3
+ var esToolkit = require('es-toolkit');
4
4
 
5
5
  const generateId = () => `${Math.random()}${Date.now()}`;
6
6
  const wrapInTryCatch = (f, prefix) => (...args) => {
@@ -163,7 +163,7 @@ const createV1Channel = (sessionContextGroup) => {
163
163
  const wrappedHandler = (context, contextMetadata) => {
164
164
  if (first) {
165
165
  first = false;
166
- if (isEqual(currentContext, context)) {
166
+ if (esToolkit.isEqual(currentContext, context)) {
167
167
  return;
168
168
  }
169
169
  }
@@ -1453,7 +1453,7 @@ class FDC3ModuleBase {
1453
1453
  const wrappedHandler = (context, contextMetadata) => {
1454
1454
  if (first) {
1455
1455
  first = false;
1456
- if (isEqual(currentContext, context)) {
1456
+ if (esToolkit.isEqual(currentContext, context)) {
1457
1457
  return;
1458
1458
  }
1459
1459
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "45.100.59",
3
+ "version": "45.100.61",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,
@@ -14,7 +14,7 @@
14
14
  ],
15
15
  "author": "OpenFin",
16
16
  "dependencies": {
17
- "lodash": "^4.17.21",
17
+ "es-toolkit": "^1.39.3",
18
18
  "tslib": "2.8.1"
19
19
  },
20
20
  "scripts": {