@flareapp/electron 2.11.0 → 2.12.0

package/dist/main.cjs

@@ -34,7 +34,7 @@ let node_fs_promises = require("node:fs/promises");
 let node_url = require("node:url");
 
 //#region src/env.ts
-const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.11.0" : "?";
+const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.12.0" : "?";
 
 //#endregion
 //#region src/types.ts
@@ -50,7 +50,6 @@ const DEFAULT_ELECTRON_OPTIONS = {
 
 //#endregion
 //#region src/main/deviceInfo.ts
-/** Electron main os + runtime as normalised device info. */
 var ElectronDeviceInfoProvider = class {
 	collect() {
 		const versions = process.versions;
@@ -70,11 +69,6 @@ const electronDeviceInfoProvider = new ElectronDeviceInfoProvider();
 
 //#endregion
 //#region src/main/collectElectron.ts
-/**
-* App + runtime attributes safe to overlay onto any report regardless of origin. Reused by both
-* the collector (main errors) and the IPC receiver (forwarded renderer reports). Excludes per-process
-* fields like `flare.entry_point.type` / `process.type` so forwarded renderer reports keep their own.
-*/
 function collectElectronAppAttributes(app) {
 	const versions = process.versions;
 	const attrs = {
@@ -92,7 +86,6 @@ function collectElectronAppAttributes(app) {
 	} catch {}
 	return attrs;
 }
-/** Build the ContextCollector core calls on every main-process report. */
 function makeElectronContextCollector(app) {
 	return (_config) => ({
 		"flare.entry_point.type": "web",
@@ -103,7 +96,6 @@ function makeElectronContextCollector(app) {
 
 //#endregion
 //#region src/main/ElectronDiskFileReader.ts
-/** Reads source snippets for main-process stack frames from disk. Mirrors @flareapp/node's DiskFileReader. */
 var ElectronDiskFileReader = class {
 	async read(url) {
 		if (!isLocalFileUrl(url)) return null;
@@ -120,7 +112,6 @@ function isLocalFileUrl(url) {
 
 //#endregion
 //#region src/main/ElectronFlushScheduler.ts
-/** Flushes pending logs/reports when the Electron app is quitting. App is injectable for tests. */
 var ElectronFlushScheduler = class {
 	listener = null;
 	constructor(app) {
@@ -133,7 +124,6 @@ var ElectronFlushScheduler = class {
 		};
 		this.app.on("before-quit", this.listener);
 	}
-	/** Detach the before-quit listener so a disposed ElectronFlare leaves no flush handler on the shared app. */
 	dispose() {
 		if (this.listener) {
 			this.app.off("before-quit", this.listener);
@@ -151,9 +141,7 @@ const FLARE_BRIDGE_KEY = "__flare";
 
 //#endregion
 //#region src/main/ipcReceiver.ts
-/** Module-level ownership token for the single flare:report channel. */
 let currentOwner = null;
-/** Default sender-trust check: accept file: and localhost/127.0.0.1 only, plus configured custom protocols. */
 function defaultTrustPolicy(frame, opts) {
 	let parsed;
 	try {
@@ -173,11 +161,6 @@ function isTrusted(frame, opts) {
 	if (opts.trustSender) return opts.trustSender(frame);
 	return defaultTrustPolicy(frame, opts);
 }
-/**
-* Minimal top-level structural guard for a parsed report, not an exhaustive StackFrame/SpanEvent
-* validator: a compromised renderer could forge any valid-looking shape anyway. The security boundary
-* is the sender-trust check plus the byte-size cap; this only rejects obviously-wrong payloads.
-*/
 function isReportShape(value) {
 	if (typeof value !== "object" || value === null) return false;
 	const r = value;
@@ -210,11 +193,6 @@ function disposeIpcReceiver(ipcMain, owner) {
 
 //#endregion
 //#region src/main/processHandlers.ts
-/**
-* Fatal callbacks for Electron main. Mirrors @flareapp/node's buildFatalCallbacks but exits via the
-* injected `exit` (app.exit at the call site), which is immediate and skips before-quit/will-quit,
-* correct after an uncaught exception.
-*/
 function buildFatalCallbacks(flare, getOpts, exit) {
 	return {
 		async onUncaught(err, origin) {
@@ -243,15 +221,6 @@ function buildFatalCallbacks(flare, getOpts, exit) {
 		}
 	};
 }
-/**
-* Owns the lifecycle of the two process-level error listeners for the Electron main process,
-* reconciling attach/detach against the desired modes. Mirrors node's ProcessHandlerManager.
-*
-* Deliberately a copy, not a shared module. @flareapp/electron does not depend on @flareapp/node, and
-* the only package both import is @flareapp/core, which ships in every browser bundle and touches
-* `process` only behind a typeof guard. A shared manager belongs in a new package, not in core, and
-* one method does not pay for one.
-*/
 var ProcessHandlerManager = class {
 	uncaughtHandler = null;
 	rejectionHandler = null;
@@ -293,7 +262,6 @@ var ProcessHandlerManager = class {
 //#endregion
 //#region src/main/ElectronFlare.ts
 const SDK_NAME = "@flareapp/electron";
-/** Write `value` under `key` when non-empty, otherwise remove any renderer-supplied value. */
 function overlayOrDelete(attributes, key, value) {
 	if (value) attributes[key] = value;
 	else delete attributes[key];
@@ -364,7 +332,6 @@ var ElectronFlare = class extends _flareapp_core.Flare {
 		disposeIpcReceiver(this.ipcMain, this);
 		this.flushScheduler.dispose();
 	}
-	/** Attach/detach the process-gone listeners to match options.captureRenderProcessGone. Idempotent. */
 	reconcileCrashListeners() {
 		const want = Boolean(this.options.captureRenderProcessGone);
 		if (want === (this.renderGoneHandler !== null)) return;
@@ -409,9 +376,8 @@ var ElectronFlare = class extends _flareapp_core.Flare {
 		return this.report(error, attrs);
 	}
 	/**
-	* Wait for both core's tracked reports AND forwarded renderer reports (which bypass core's
-	* private track()), bounded by timeoutMs. The timeout is cleared when all reports settle
-	* first, so the event loop is not kept alive unnecessarily.
+	* Waits for core's tracked reports and forwarded renderer reports (which bypass track()), bounded by
+	* timeoutMs. Clears the timer once everything settles, so the event loop isn't held open needlessly.
 	*/
 	flush(timeoutMs = 2e3) {
 		const settled = Promise.allSettled([super.flush(timeoutMs), ...this.forwardedInFlight]);
@@ -423,7 +389,6 @@ var ElectronFlare = class extends _flareapp_core.Flare {
 			});
 		});
 	}
-	/** Overlay main-authoritative config + Electron metadata + user identity (from the main scope) onto a forwarded report, then send. */
 	receiveRendererReport(report) {
 		for (const key of _flareapp_core.USER_IDENTITY_KEYS) delete report.attributes[key];
 		Object.assign(report.attributes, collectElectronAppAttributes(this.app), (0, _flareapp_core.userIdentityAttributes)(this.mainScope.active()));

package/dist/main.d.cts

@@ -44,18 +44,15 @@ declare class ElectronFlare extends Flare {
   light(key?: string, debug?: boolean): this;
   configureElectron(partial: ElectronOptions): this;
   dispose(): void;
-  /** Attach/detach the process-gone listeners to match options.captureRenderProcessGone. Idempotent. */
   private reconcileCrashListeners;
   private attachCrashListeners;
   private detachCrashListeners;
   private reportProcessGone;
   /**
-   * Wait for both core's tracked reports AND forwarded renderer reports (which bypass core's
-   * private track()), bounded by timeoutMs. The timeout is cleared when all reports settle
-   * first, so the event loop is not kept alive unnecessarily.
+   * Waits for core's tracked reports and forwarded renderer reports (which bypass track()), bounded by
+   * timeoutMs. Clears the timer once everything settles, so the event loop isn't held open needlessly.
    */
   flush(timeoutMs?: number): Promise<void>;
-  /** Overlay main-authoritative config + Electron metadata + user identity (from the main scope) onto a forwarded report, then send. */
   private receiveRendererReport;
 }
 //#endregion

package/dist/main.d.mts

@@ -44,18 +44,15 @@ declare class ElectronFlare extends Flare {
   light(key?: string, debug?: boolean): this;
   configureElectron(partial: ElectronOptions): this;
   dispose(): void;
-  /** Attach/detach the process-gone listeners to match options.captureRenderProcessGone. Idempotent. */
   private reconcileCrashListeners;
   private attachCrashListeners;
   private detachCrashListeners;
   private reportProcessGone;
   /**
-   * Wait for both core's tracked reports AND forwarded renderer reports (which bypass core's
-   * private track()), bounded by timeoutMs. The timeout is cleared when all reports settle
-   * first, so the event loop is not kept alive unnecessarily.
+   * Waits for core's tracked reports and forwarded renderer reports (which bypass track()), bounded by
+   * timeoutMs. Clears the timer once everything settles, so the event loop isn't held open needlessly.
    */
   flush(timeoutMs?: number): Promise<void>;
-  /** Overlay main-authoritative config + Electron metadata + user identity (from the main scope) onto a forwarded report, then send. */
   private receiveRendererReport;
 }
 //#endregion

package/dist/main.mjs

@@ -5,7 +5,7 @@ import { readFile } from "node:fs/promises";
 import { fileURLToPath } from "node:url";
 
 //#region src/env.ts
-const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.11.0" : "?";
+const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.12.0" : "?";
 
 //#endregion
 //#region src/types.ts
@@ -21,7 +21,6 @@ const DEFAULT_ELECTRON_OPTIONS = {
 
 //#endregion
 //#region src/main/deviceInfo.ts
-/** Electron main os + runtime as normalised device info. */
 var ElectronDeviceInfoProvider = class {
 	collect() {
 		const versions = process.versions;
@@ -41,11 +40,6 @@ const electronDeviceInfoProvider = new ElectronDeviceInfoProvider();
 
 //#endregion
 //#region src/main/collectElectron.ts
-/**
-* App + runtime attributes safe to overlay onto any report regardless of origin. Reused by both
-* the collector (main errors) and the IPC receiver (forwarded renderer reports). Excludes per-process
-* fields like `flare.entry_point.type` / `process.type` so forwarded renderer reports keep their own.
-*/
 function collectElectronAppAttributes(app) {
 	const versions = process.versions;
 	const attrs = {
@@ -63,7 +57,6 @@ function collectElectronAppAttributes(app) {
 	} catch {}
 	return attrs;
 }
-/** Build the ContextCollector core calls on every main-process report. */
 function makeElectronContextCollector(app) {
 	return (_config) => ({
 		"flare.entry_point.type": "web",
@@ -74,7 +67,6 @@ function makeElectronContextCollector(app) {
 
 //#endregion
 //#region src/main/ElectronDiskFileReader.ts
-/** Reads source snippets for main-process stack frames from disk. Mirrors @flareapp/node's DiskFileReader. */
 var ElectronDiskFileReader = class {
 	async read(url) {
 		if (!isLocalFileUrl(url)) return null;
@@ -91,7 +83,6 @@ function isLocalFileUrl(url) {
 
 //#endregion
 //#region src/main/ElectronFlushScheduler.ts
-/** Flushes pending logs/reports when the Electron app is quitting. App is injectable for tests. */
 var ElectronFlushScheduler = class {
 	listener = null;
 	constructor(app) {
@@ -104,7 +95,6 @@ var ElectronFlushScheduler = class {
 		};
 		this.app.on("before-quit", this.listener);
 	}
-	/** Detach the before-quit listener so a disposed ElectronFlare leaves no flush handler on the shared app. */
 	dispose() {
 		if (this.listener) {
 			this.app.off("before-quit", this.listener);
@@ -122,9 +112,7 @@ const FLARE_BRIDGE_KEY = "__flare";
 
 //#endregion
 //#region src/main/ipcReceiver.ts
-/** Module-level ownership token for the single flare:report channel. */
 let currentOwner = null;
-/** Default sender-trust check: accept file: and localhost/127.0.0.1 only, plus configured custom protocols. */
 function defaultTrustPolicy(frame, opts) {
 	let parsed;
 	try {
@@ -144,11 +132,6 @@ function isTrusted(frame, opts) {
 	if (opts.trustSender) return opts.trustSender(frame);
 	return defaultTrustPolicy(frame, opts);
 }
-/**
-* Minimal top-level structural guard for a parsed report, not an exhaustive StackFrame/SpanEvent
-* validator: a compromised renderer could forge any valid-looking shape anyway. The security boundary
-* is the sender-trust check plus the byte-size cap; this only rejects obviously-wrong payloads.
-*/
 function isReportShape(value) {
 	if (typeof value !== "object" || value === null) return false;
 	const r = value;
@@ -181,11 +164,6 @@ function disposeIpcReceiver(ipcMain, owner) {
 
 //#endregion
 //#region src/main/processHandlers.ts
-/**
-* Fatal callbacks for Electron main. Mirrors @flareapp/node's buildFatalCallbacks but exits via the
-* injected `exit` (app.exit at the call site), which is immediate and skips before-quit/will-quit,
-* correct after an uncaught exception.
-*/
 function buildFatalCallbacks(flare, getOpts, exit) {
 	return {
 		async onUncaught(err, origin) {
@@ -214,15 +192,6 @@ function buildFatalCallbacks(flare, getOpts, exit) {
 		}
 	};
 }
-/**
-* Owns the lifecycle of the two process-level error listeners for the Electron main process,
-* reconciling attach/detach against the desired modes. Mirrors node's ProcessHandlerManager.
-*
-* Deliberately a copy, not a shared module. @flareapp/electron does not depend on @flareapp/node, and
-* the only package both import is @flareapp/core, which ships in every browser bundle and touches
-* `process` only behind a typeof guard. A shared manager belongs in a new package, not in core, and
-* one method does not pay for one.
-*/
 var ProcessHandlerManager = class {
 	uncaughtHandler = null;
 	rejectionHandler = null;
@@ -264,7 +233,6 @@ var ProcessHandlerManager = class {
 //#endregion
 //#region src/main/ElectronFlare.ts
 const SDK_NAME = "@flareapp/electron";
-/** Write `value` under `key` when non-empty, otherwise remove any renderer-supplied value. */
 function overlayOrDelete(attributes, key, value) {
 	if (value) attributes[key] = value;
 	else delete attributes[key];
@@ -335,7 +303,6 @@ var ElectronFlare = class extends Flare {
 		disposeIpcReceiver(this.ipcMain, this);
 		this.flushScheduler.dispose();
 	}
-	/** Attach/detach the process-gone listeners to match options.captureRenderProcessGone. Idempotent. */
 	reconcileCrashListeners() {
 		const want = Boolean(this.options.captureRenderProcessGone);
 		if (want === (this.renderGoneHandler !== null)) return;
@@ -380,9 +347,8 @@ var ElectronFlare = class extends Flare {
 		return this.report(error, attrs);
 	}
 	/**
-	* Wait for both core's tracked reports AND forwarded renderer reports (which bypass core's
-	* private track()), bounded by timeoutMs. The timeout is cleared when all reports settle
-	* first, so the event loop is not kept alive unnecessarily.
+	* Waits for core's tracked reports and forwarded renderer reports (which bypass track()), bounded by
+	* timeoutMs. Clears the timer once everything settles, so the event loop isn't held open needlessly.
 	*/
 	flush(timeoutMs = 2e3) {
 		const settled = Promise.allSettled([super.flush(timeoutMs), ...this.forwardedInFlight]);
@@ -394,7 +360,6 @@ var ElectronFlare = class extends Flare {
 			});
 		});
 	}
-	/** Overlay main-authoritative config + Electron metadata + user identity (from the main scope) onto a forwarded report, then send. */
 	receiveRendererReport(report) {
 		for (const key of USER_IDENTITY_KEYS) delete report.attributes[key];
 		Object.assign(report.attributes, collectElectronAppAttributes(this.app), userIdentityAttributes(this.mainScope.active()));

package/dist/renderer.cjs

@@ -8,7 +8,7 @@ const FLARE_BRIDGE_KEY = "__flare";
 
 //#endregion
 //#region src/env.ts
-const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.11.0" : "?";
+const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.12.0" : "?";
 
 //#endregion
 //#region src/renderer/RendererFlare.ts

package/dist/renderer.mjs

@@ -7,7 +7,7 @@ const FLARE_BRIDGE_KEY = "__flare";
 
 //#endregion
 //#region src/env.ts
-const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.11.0" : "?";
+const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.12.0" : "?";
 
 //#endregion
 //#region src/renderer/RendererFlare.ts

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flareapp/electron",
-    "version": "2.11.0",
+    "version": "2.12.0",
     "description": "Electron SDK for flareapp.io",
     "homepage": "https://flareapp.io",
     "bugs": {
@@ -65,8 +65,8 @@
         "release": "release-it"
     },
     "dependencies": {
-        "@flareapp/core": "2.11.0",
-        "@flareapp/js": "2.11.0"
+        "@flareapp/core": "2.12.0",
+        "@flareapp/js": "2.12.0"
     },
     "peerDependencies": {
         "electron": ">=35"