@flareapp/electron 0.1.0

package/dist/renderer.cjs

@@ -0,0 +1,84 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let _flareapp_js_browser = require("@flareapp/js/browser");
+let _flareapp_core = require("@flareapp/core");
+
+//#region src/constants.ts
+/** Global key the preload bridge exposes in the renderer's main world. */
+const FLARE_BRIDGE_KEY = "__flare";
+
+//#endregion
+//#region src/env.ts
+const CLIENT_VERSION = typeof process !== "undefined" && true ? "0.1.0" : "?";
+
+//#endregion
+//#region src/renderer/RendererFlare.ts
+var RendererFlare = class extends _flareapp_js_browser.Flare {
+	maxReportBytes;
+	rendererBeforeSubmit = (r) => r;
+	noBridgeCount = 0;
+	oversizedCount = 0;
+	sendFailedCount = 0;
+	constructor(options = {}) {
+		super();
+		this.maxReportBytes = options.maxReportBytes ?? 1e6;
+		this.setSdkInfo({
+			name: "@flareapp/electron",
+			version: CLIENT_VERSION
+		});
+	}
+	configure(config) {
+		if (config.beforeSubmit !== void 0) this.rendererBeforeSubmit = config.beforeSubmit;
+		return super.configure(config);
+	}
+	/**
+	* Renderer transport. Core's sendReport short-circuits without an API key, so we override it
+	* entirely: scrub, serialize cycle-safely, size-check, then forward a STRING over the bridge.
+	*/
+	async sendReport(report) {
+		const scrubbed = await this.rendererBeforeSubmit(report);
+		if (!scrubbed) return;
+		const payload = (0, _flareapp_core.flatJsonStringify)(scrubbed);
+		if (byteLength(payload) > this.maxReportBytes) {
+			this.oversizedCount += 1;
+			if (shouldWarn(this.oversizedCount)) console.warn(`[flare] Renderer report exceeds maxReportBytes; dropping. (count: ${this.oversizedCount})`);
+			return;
+		}
+		const bridge = globalThis[FLARE_BRIDGE_KEY];
+		if (!bridge) {
+			this.noBridgeCount += 1;
+			if (shouldWarn(this.noBridgeCount)) console.warn(`[flare] window.__flare is not available. Did you call exposeFlare() in your preload script? (count: ${this.noBridgeCount})`);
+			return;
+		}
+		try {
+			await bridge.report(payload);
+		} catch (error) {
+			this.sendFailedCount += 1;
+			if (shouldWarn(this.sendFailedCount)) console.warn(`[flare] Failed to forward a report to the main process. (count: ${this.sendFailedCount})`, error);
+		}
+	}
+};
+function byteLength(s) {
+	return new TextEncoder().encode(s).length;
+}
+function shouldWarn(count) {
+	if (count < 1) return false;
+	let n = count;
+	while (n > 1) {
+		if (n % 10 !== 0) return false;
+		n /= 10;
+	}
+	return n === 1;
+}
+
+//#endregion
+//#region src/renderer.ts
+const flare = new RendererFlare();
+if (typeof window !== "undefined" && window) {
+	window.flare = flare;
+	(0, _flareapp_js_browser.catchWindowErrors)();
+}
+
+//#endregion
+exports.FLARE_BRIDGE_KEY = FLARE_BRIDGE_KEY;
+exports.RendererFlare = RendererFlare;
+exports.flare = flare;

package/dist/renderer.d.cts

@@ -0,0 +1,30 @@
+import { Config, Report } from "@flareapp/core";
+import { Flare } from "@flareapp/js/browser";
+
+//#region src/renderer/RendererFlare.d.ts
+type RendererFlareOptions = {
+  /** Max serialized report size in bytes; oversized reports are dropped with a warning. */maxReportBytes?: number;
+};
+declare class RendererFlare extends Flare {
+  private maxReportBytes;
+  private rendererBeforeSubmit;
+  private noBridgeCount;
+  private oversizedCount;
+  private sendFailedCount;
+  constructor(options?: RendererFlareOptions);
+  configure(config: Partial<Config>): this;
+  /**
+   * Renderer transport. Core's sendReport short-circuits without an API key, so we override it
+   * entirely: scrub, serialize cycle-safely, size-check, then forward a STRING over the bridge.
+   */
+  sendReport(report: Report): Promise<void>;
+}
+//#endregion
+//#region src/constants.d.ts
+/** Global key the preload bridge exposes in the renderer's main world. */
+declare const FLARE_BRIDGE_KEY = "__flare";
+//#endregion
+//#region src/renderer.d.ts
+declare const flare: RendererFlare;
+//#endregion
+export { FLARE_BRIDGE_KEY, RendererFlare, type RendererFlareOptions, flare };

package/dist/renderer.d.mts

@@ -0,0 +1,30 @@
+import { Flare } from "@flareapp/js/browser";
+import { Config, Report } from "@flareapp/core";
+
+//#region src/renderer/RendererFlare.d.ts
+type RendererFlareOptions = {
+  /** Max serialized report size in bytes; oversized reports are dropped with a warning. */maxReportBytes?: number;
+};
+declare class RendererFlare extends Flare {
+  private maxReportBytes;
+  private rendererBeforeSubmit;
+  private noBridgeCount;
+  private oversizedCount;
+  private sendFailedCount;
+  constructor(options?: RendererFlareOptions);
+  configure(config: Partial<Config>): this;
+  /**
+   * Renderer transport. Core's sendReport short-circuits without an API key, so we override it
+   * entirely: scrub, serialize cycle-safely, size-check, then forward a STRING over the bridge.
+   */
+  sendReport(report: Report): Promise<void>;
+}
+//#endregion
+//#region src/constants.d.ts
+/** Global key the preload bridge exposes in the renderer's main world. */
+declare const FLARE_BRIDGE_KEY = "__flare";
+//#endregion
+//#region src/renderer.d.ts
+declare const flare: RendererFlare;
+//#endregion
+export { FLARE_BRIDGE_KEY, RendererFlare, type RendererFlareOptions, flare };

package/dist/renderer.mjs

@@ -0,0 +1,81 @@
+import { Flare, catchWindowErrors } from "@flareapp/js/browser";
+import { flatJsonStringify } from "@flareapp/core";
+
+//#region src/constants.ts
+/** Global key the preload bridge exposes in the renderer's main world. */
+const FLARE_BRIDGE_KEY = "__flare";
+
+//#endregion
+//#region src/env.ts
+const CLIENT_VERSION = typeof process !== "undefined" && true ? "0.1.0" : "?";
+
+//#endregion
+//#region src/renderer/RendererFlare.ts
+var RendererFlare = class extends Flare {
+	maxReportBytes;
+	rendererBeforeSubmit = (r) => r;
+	noBridgeCount = 0;
+	oversizedCount = 0;
+	sendFailedCount = 0;
+	constructor(options = {}) {
+		super();
+		this.maxReportBytes = options.maxReportBytes ?? 1e6;
+		this.setSdkInfo({
+			name: "@flareapp/electron",
+			version: CLIENT_VERSION
+		});
+	}
+	configure(config) {
+		if (config.beforeSubmit !== void 0) this.rendererBeforeSubmit = config.beforeSubmit;
+		return super.configure(config);
+	}
+	/**
+	* Renderer transport. Core's sendReport short-circuits without an API key, so we override it
+	* entirely: scrub, serialize cycle-safely, size-check, then forward a STRING over the bridge.
+	*/
+	async sendReport(report) {
+		const scrubbed = await this.rendererBeforeSubmit(report);
+		if (!scrubbed) return;
+		const payload = flatJsonStringify(scrubbed);
+		if (byteLength(payload) > this.maxReportBytes) {
+			this.oversizedCount += 1;
+			if (shouldWarn(this.oversizedCount)) console.warn(`[flare] Renderer report exceeds maxReportBytes; dropping. (count: ${this.oversizedCount})`);
+			return;
+		}
+		const bridge = globalThis[FLARE_BRIDGE_KEY];
+		if (!bridge) {
+			this.noBridgeCount += 1;
+			if (shouldWarn(this.noBridgeCount)) console.warn(`[flare] window.__flare is not available. Did you call exposeFlare() in your preload script? (count: ${this.noBridgeCount})`);
+			return;
+		}
+		try {
+			await bridge.report(payload);
+		} catch (error) {
+			this.sendFailedCount += 1;
+			if (shouldWarn(this.sendFailedCount)) console.warn(`[flare] Failed to forward a report to the main process. (count: ${this.sendFailedCount})`, error);
+		}
+	}
+};
+function byteLength(s) {
+	return new TextEncoder().encode(s).length;
+}
+function shouldWarn(count) {
+	if (count < 1) return false;
+	let n = count;
+	while (n > 1) {
+		if (n % 10 !== 0) return false;
+		n /= 10;
+	}
+	return n === 1;
+}
+
+//#endregion
+//#region src/renderer.ts
+const flare = new RendererFlare();
+if (typeof window !== "undefined" && window) {
+	window.flare = flare;
+	catchWindowErrors();
+}
+
+//#endregion
+export { FLARE_BRIDGE_KEY, RendererFlare, flare };

package/package.json

@@ -0,0 +1,80 @@
+{
+    "name": "@flareapp/electron",
+    "version": "0.1.0",
+    "description": "Experimental Electron SDK for flareapp.io",
+    "homepage": "https://flareapp.io",
+    "bugs": {
+        "url": "https://github.com/spatie/flare-client-js/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/spatie/flare-client-js.git"
+    },
+    "license": "MIT",
+    "author": {
+        "name": "Spatie",
+        "email": "info@spatie.be"
+    },
+    "files": [
+        "dist"
+    ],
+    "exports": {
+        "./main": {
+            "import": {
+                "types": "./dist/main.d.mts",
+                "default": "./dist/main.mjs"
+            },
+            "require": {
+                "types": "./dist/main.d.cts",
+                "default": "./dist/main.cjs"
+            }
+        },
+        "./preload": {
+            "import": {
+                "types": "./dist/preload.d.mts",
+                "default": "./dist/preload.mjs"
+            },
+            "require": {
+                "types": "./dist/preload.d.cts",
+                "default": "./dist/preload.cjs"
+            }
+        },
+        "./renderer": {
+            "import": {
+                "types": "./dist/renderer.d.mts",
+                "default": "./dist/renderer.mjs"
+            },
+            "require": {
+                "types": "./dist/renderer.d.cts",
+                "default": "./dist/renderer.cjs"
+            }
+        }
+    },
+    "engines": {
+        "node": ">=22"
+    },
+    "scripts": {
+        "prepublishOnly": "npm run build",
+        "build": "tsdown",
+        "test": "vitest run",
+        "typescript": "tsc --noEmit",
+        "verify:exports": "node scripts/verify-exports.mjs",
+        "release": "release-it"
+    },
+    "dependencies": {
+        "@flareapp/core": "2.4.0",
+        "@flareapp/js": "2.4.0"
+    },
+    "peerDependencies": {
+        "electron": ">=35"
+    },
+    "devDependencies": {
+        "electron": "^35.0.0",
+        "tsdown": "^0.20.3",
+        "typescript": "^5.7.0",
+        "vitest": "^4.0.18"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}