@openfin/node-adapter 44.101.1 → 44.101.3

package/out/node-adapter.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var events = require('events');
-var isEqual = require('lodash/isEqual');
+var esToolkit = require('es-toolkit');
 var fs = require('fs');
 var crypto = require('crypto');
 var _WS = require('ws');
@@ -4828,6 +4828,13 @@ class _WindowModule extends Base {
 class SystemContentTracing extends Base {
     /**
      * Gets the currently known tracing category groups.
+     *
+     * @example
+     * ```ts
+     * const categories = await fin.System.ContentTracing.getCategories();
+     * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
+     * console.log(`Loaded ${sorted.length} tracing categories`);
+     * ```
      */
     async getCategories() {
         const { payload } = await this.wire.sendAction('content-tracing-get-categories');
@@ -4838,6 +4845,29 @@ class SystemContentTracing extends Base {
      *
      * Only one content tracing session may be active across the runtime at a time.
      * This method rejects if another identity already owns the active session.
+     *
+     * @example
+     * ```ts
+     * await fin.System.ContentTracing.startRecording({
+     *     recording_mode: 'record-as-much-as-possible',
+     *     included_categories: [
+     *         '*',
+     *         'disabled-by-default-blink.invalidation',
+     *         'disabled-by-default-cc.debug',
+     *         'disabled-by-default-viz.surface_id_flow'
+     *     ]
+     * });
+     *
+     * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
+     * ```
+     *
+     * @example
+     * ```ts
+     * await fin.System.ContentTracing.startRecording({
+     *     categoryFilter: 'electron,blink,cc',
+     *     traceOptions: 'record-until-full,enable-sampling'
+     * });
+     * ```
      */
     async startRecording(options) {
         await this.wire.sendAction('content-tracing-start-recording', { options });
@@ -4847,6 +4877,13 @@ class SystemContentTracing extends Base {
      *
      * The calling identity must match the identity that started the active tracing session.
      * This method rejects if tracing is not active or is owned by another identity.
+     *
+     * @example
+     * ```ts
+     * const tracePath = await fin.System.ContentTracing.stopRecording();
+     * console.log('Trace written to:', tracePath);
+     * // Load the file in chrome://tracing or https://ui.perfetto.dev/
+     * ```
      */
     async stopRecording() {
         const { payload } = await this.wire.sendAction('content-tracing-stop-recording');
@@ -4856,6 +4893,16 @@ class SystemContentTracing extends Base {
      * Returns the current maximum trace buffer usage across processes.
      *
      * This method is not supported on macOS and rejects on that platform.
+     *
+     * @example
+     * ```ts
+     * try {
+     *     const usage = await fin.System.ContentTracing.getTraceBufferUsage();
+     *     console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
+     * } catch (error) {
+     *     console.warn('Trace buffer usage is not available on this platform.', error);
+     * }
+     * ```
      */
     async getTraceBufferUsage() {
         const { payload } = await this.wire.sendAction('content-tracing-get-trace-buffer-usage');
@@ -4952,13 +4999,15 @@ class System extends EmitterBase {
      * * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
      * * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
      * * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
+     * * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
      * @example
      * ```js
      * const clearCacheOptions = {
      *     appcache: true,
      *     cache: true,
      *     cookies: true,
-     *     localStorage: true
+     *     localStorage: true,
+     *     windowState: true
      * };
      * fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
      * ```
@@ -4987,12 +5036,16 @@ class System extends EmitterBase {
      *
      * @param options - Optional configuration for what data to clear
      *
+     * @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
+     * After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
+     *
      * @example
      * ```js
      * // Clear only cookies and localStorage for a specific origin
      * await fin.System.clearCacheData({
      *     dataTypes: ['cookies', 'localStorage'],
-     *     origins: ['http://localhost:8081']
+     *     origins: ['http://localhost:8081'],
+     *     windowState: true
      * });
      *
      * // Clear everything except for a specific origin
@@ -12881,7 +12934,7 @@ class InteropBroker extends Base {
             constructor(...unused) {
                 if (unused.length) {
                     const [_ignore1, ignore2, opts] = unused;
-                    if (opts && typeof opts === 'object' && !isEqual(opts, args[2])) {
+                    if (opts && typeof opts === 'object' && !esToolkit.isEqual(opts, args[2])) {
                         // eslint-disable-next-line no-console
                         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.');
                         super(args[0], args[1], opts);
@@ -14921,7 +14974,7 @@ const createV1Channel = (sessionContextGroup) => {
                 const wrappedHandler = (context, contextMetadata) => {
                     if (first) {
                         first = false;
-                        if (isEqual(currentContext, context)) {
+                        if (esToolkit.isEqual(currentContext, context)) {
                             return;
                         }
                     }
@@ -15329,7 +15382,7 @@ class FDC3ModuleBase {
                     const wrappedHandler = (context, contextMetadata) => {
                         if (first) {
                             first = false;
-                            if (isEqual(currentContext, context)) {
+                            if (esToolkit.isEqual(currentContext, context)) {
                                 return;
                             }
                         }
@@ -17105,7 +17158,7 @@ class NodeEnvironment extends BaseEnvironment {
         };
     }
     getAdapterVersionSync() {
-        return "44.101.1";
+        return "44.101.3";
     }
     observeBounds(element, onChange) {
         throw new Error('Method not implemented.');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfin/node-adapter",
-  "version": "44.101.1",
+  "version": "44.101.3",
   "description": "See README.md",
   "main": "out/node-adapter.js",
   "types": "out/node-adapter.d.ts",
@@ -17,10 +17,10 @@
   "author": "OpenFin",
   "dependencies": {
     "@types/node": "^20.14.2",
-    "lodash": "^4.17.21",
+    "es-toolkit": "^1.39.3",
     "ws": "^7.5.10",
     "tslib": "2.8.1",
-    "@openfin/core": "44.101.1"
+    "@openfin/core": "44.101.3"
   },
   "scripts": {
     "prebuild": "rimraf ./out",