@squasher-ai/browser 0.1.1 → 0.2.0

package/dist/__tests__/replay-startup.test.js

@@ -1,99 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { ReplayRecorder } from "../replay";
-import { resetSessionId } from "../session";
-const rrwebRecordMock = vi.hoisted(() => vi.fn());
-const rrwebStopMock = vi.hoisted(() => vi.fn());
-vi.mock("rrweb", () => ({
-    record: rrwebRecordMock,
-}));
-function createReplayEvent(type, timestamp) {
-    return {
-        type,
-        timestamp,
-        data: {
-            source: type,
-        },
-    };
-}
-describe("ReplayRecorder startup behavior", () => {
-    let emitReplayEvent;
-    beforeEach(() => {
-        resetSessionId();
-        emitReplayEvent = undefined;
-        vi.useFakeTimers();
-        vi.restoreAllMocks();
-        const storage = {};
-        vi.stubGlobal("crypto", {
-            randomUUID: vi.fn().mockReturnValue("11111111-2222-4333-8444-555555555555"),
-        });
-        vi.stubGlobal("sessionStorage", {
-            getItem: (key) => storage[key] ?? null,
-            setItem: (key, value) => {
-                storage[key] = value;
-            },
-            removeItem: (key) => {
-                delete storage[key];
-            },
-        });
-        vi.stubGlobal("location", {
-            href: "https://example.com/dashboard",
-        });
-        vi.stubGlobal("fetch", vi.fn().mockResolvedValue({ ok: true }));
-        vi.stubGlobal("navigator", {
-            sendBeacon: vi.fn().mockReturnValue(true),
-        });
-        vi.stubGlobal("document", {});
-        vi.stubGlobal("window", {
-            addEventListener: vi.fn(),
-            removeEventListener: vi.fn(),
-        });
-        rrwebStopMock.mockReset();
-        rrwebRecordMock.mockReset();
-        rrwebRecordMock.mockImplementation((options) => {
-            emitReplayEvent = options?.emit;
-            return rrwebStopMock;
-        });
-    });
-    afterEach(() => {
-        vi.useRealTimers();
-        vi.unstubAllGlobals();
-    });
-    it("preserves rrweb bootstrap events emitted before record() returns", async () => {
-        rrwebRecordMock.mockImplementation((options) => {
-            options?.emit?.(createReplayEvent(4, 1));
-            options?.emit?.(createReplayEvent(2, 2));
-            emitReplayEvent = options?.emit;
-            return rrwebStopMock;
-        });
-        const recorder = new ReplayRecorder({
-            endpoint: "https://ingest.squasher.ai",
-            projectId: "project-123",
-            apiKey: "sq_pk_test",
-            debug: false,
-            sampleRate: 1,
-        });
-        await recorder.ready;
-        emitReplayEvent?.(createReplayEvent(3, 3));
-        vi.advanceTimersByTime(5_000);
-        const requestBody = vi.mocked(fetch).mock.calls[0]?.[1]?.body;
-        expect(typeof requestBody).toBe("string");
-        if (typeof requestBody !== "string") {
-            throw new Error("expected replay request body to be a string");
-        }
-        const payload = JSON.parse(requestBody);
-        expect(payload.events.map((event) => event.type)).toEqual([4, 2, 3]);
-        recorder.dispose();
-    });
-    it("skips recording when the replay sample rate drops the session", () => {
-        vi.spyOn(Math, "random").mockReturnValue(0.9);
-        const recorder = new ReplayRecorder({
-            endpoint: "https://ingest.squasher.ai",
-            projectId: "project-123",
-            apiKey: "sq_pk_test",
-            debug: false,
-            sampleRate: 0.5,
-        });
-        expect(rrwebRecordMock).not.toHaveBeenCalled();
-        recorder.dispose();
-    });
-});

package/dist/__tests__/replay.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=replay.test.d.ts.map

package/dist/__tests__/replay.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"replay.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/replay.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/replay.test.js

@@ -1,217 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { ReplayRecorder } from "../replay";
-import { resetSessionId } from "../session";
-const rrwebRecordMock = vi.hoisted(() => vi.fn());
-const rrwebStopMock = vi.hoisted(() => vi.fn());
-vi.mock("rrweb", () => ({
-    record: rrwebRecordMock,
-}));
-function createReplayEvent(type, timestamp) {
-    return {
-        type,
-        timestamp,
-        data: {
-            source: type,
-        },
-    };
-}
-describe("ReplayRecorder", () => {
-    let listeners;
-    let emitReplayEvent;
-    beforeEach(() => {
-        resetSessionId();
-        listeners = {};
-        emitReplayEvent = undefined;
-        vi.useFakeTimers();
-        vi.restoreAllMocks();
-        const storage = {};
-        vi.stubGlobal("crypto", {
-            randomUUID: vi.fn().mockReturnValue("11111111-2222-4333-8444-555555555555"),
-        });
-        vi.stubGlobal("sessionStorage", {
-            getItem: (key) => storage[key] ?? null,
-            setItem: (key, value) => {
-                storage[key] = value;
-            },
-            removeItem: (key) => {
-                delete storage[key];
-            },
-        });
-        vi.stubGlobal("location", {
-            href: "https://example.com/dashboard",
-        });
-        vi.stubGlobal("fetch", vi.fn().mockResolvedValue({ ok: true }));
-        vi.stubGlobal("navigator", {
-            sendBeacon: vi.fn().mockReturnValue(true),
-        });
-        vi.stubGlobal("document", {});
-        vi.stubGlobal("window", {
-            addEventListener: vi.fn((event, listener) => {
-                listeners[event] = [...(listeners[event] ?? []), listener];
-            }),
-            removeEventListener: vi.fn((event, listener) => {
-                listeners[event] = (listeners[event] ?? []).filter((value) => value !== listener);
-            }),
-        });
-        rrwebStopMock.mockReset();
-        rrwebRecordMock.mockReset();
-        rrwebRecordMock.mockImplementation((options) => {
-            emitReplayEvent = options?.emit;
-            return rrwebStopMock;
-        });
-    });
-    afterEach(() => {
-        vi.useRealTimers();
-        vi.unstubAllGlobals();
-    });
-    it("starts rrweb recording when replay is enabled", async () => {
-        const recorder = new ReplayRecorder({
-            endpoint: "https://ingest.squasher.ai",
-            projectId: "project-123",
-            apiKey: "sq_pk_test",
-            debug: false,
-            sampleRate: 1,
-        });
-        await recorder.ready;
-        expect(rrwebRecordMock).toHaveBeenCalledOnce();
-        recorder.dispose();
-        expect(rrwebStopMock).toHaveBeenCalledOnce();
-    });
-    it("flushes replay events once the buffer reaches 50 events", async () => {
-        const recorder = new ReplayRecorder({
-            endpoint: "https://ingest.squasher.ai",
-            projectId: "project-123",
-            apiKey: "sq_pk_test",
-            debug: false,
-            sampleRate: 1,
-        });
-        await recorder.ready;
-        for (let index = 0; index < 50; index += 1) {
-            emitReplayEvent?.(createReplayEvent(index === 0 ? 2 : 3, index));
-        }
-        const fetchMock = vi.mocked(fetch);
-        expect(fetchMock).toHaveBeenCalledOnce();
-        const [url, requestInit] = fetchMock.mock.calls[0] ?? [];
-        expect(url).toBe("https://ingest.squasher.ai/v1/projects/project-123/replays");
-        expect(requestInit?.headers).toEqual({
-            "Content-Type": "application/json",
-            "x-squasher-key": "sq_pk_test",
-        });
-        const requestBody = requestInit?.body;
-        expect(typeof requestBody).toBe("string");
-        if (typeof requestBody !== "string") {
-            throw new Error("expected replay request body to be a string");
-        }
-        const payload = JSON.parse(requestBody);
-        expect(payload.session_id).toBe("11111111-2222-4333-8444-555555555555");
-        expect(payload.page_url).toBe("https://example.com/dashboard");
-        expect(payload.events).toHaveLength(50);
-        expect(payload.events[0]?.type).toBe(2);
-        expect(payload.events[49]?.type).toBe(3);
-        recorder.dispose();
-    });
-    it("flushes queued replay events every five seconds", async () => {
-        const recorder = new ReplayRecorder({
-            endpoint: "https://ingest.squasher.ai",
-            projectId: "project-123",
-            apiKey: "sq_pk_test",
-            debug: false,
-            sampleRate: 1,
-        });
-        await recorder.ready;
-        emitReplayEvent?.(createReplayEvent(2, 1));
-        expect(fetch).not.toHaveBeenCalled();
-        vi.advanceTimersByTime(5_000);
-        expect(fetch).toHaveBeenCalledOnce();
-        recorder.dispose();
-    });
-    it("uses sendBeacon for the final pagehide flush", async () => {
-        const recorder = new ReplayRecorder({
-            endpoint: "https://ingest.squasher.ai",
-            projectId: "project-123",
-            apiKey: "sq_pk_test",
-            debug: false,
-            sampleRate: 1,
-        });
-        await recorder.ready;
-        emitReplayEvent?.(createReplayEvent(3, 99));
-        listeners.pagehide?.forEach((listener) => listener());
-        const sendBeaconMock = vi.mocked(navigator.sendBeacon);
-        expect(sendBeaconMock).toHaveBeenCalledOnce();
-        expect(fetch).not.toHaveBeenCalled();
-        const [url, payloadBlob] = sendBeaconMock.mock.calls[0] ?? [];
-        expect(url).toBe("https://ingest.squasher.ai/v1/projects/project-123/replays?key=sq_pk_test");
-        expect(payloadBlob).toBeInstanceOf(Blob);
-        if (!(payloadBlob instanceof Blob)) {
-            throw new Error("expected sendBeacon payload to be a Blob");
-        }
-        const payload = JSON.parse(await payloadBlob.text());
-        expect(payload.session_id).toBe("11111111-2222-4333-8444-555555555555");
-        expect(payload.events).toHaveLength(1);
-        expect(payload.events[0]?.type).toBe(3);
-        recorder.dispose();
-    });
-    it("passes privacy controls to rrweb and redacts masked text in serialized payloads", async () => {
-        const recorder = new ReplayRecorder({
-            endpoint: "https://ingest.squasher.ai",
-            projectId: "project-123",
-            apiKey: "sq_pk_test",
-            debug: false,
-            privacy: {
-                blockSelector: ".pii-container",
-                maskAllText: true,
-            },
-            sampleRate: 1,
-        });
-        await recorder.ready;
-        expect(rrwebRecordMock).toHaveBeenCalledWith(expect.objectContaining({
-            blockSelector: ".pii-container",
-            maskAllInputs: true,
-            maskAllText: true,
-            maskTextSelector: "body, body *",
-        }));
-        emitReplayEvent?.({
-            data: {
-                node: {
-                    attributes: {
-                        placeholder: "customer@example.com",
-                        value: "customer@example.com",
-                    },
-                    childNodes: [
-                        { textContent: "Jane Example", type: 3 },
-                        {
-                            childNodes: [{ textContent: "body{color:#0f172a;}", type: 3 }],
-                            tagName: "style",
-                            type: 2,
-                        },
-                        {
-                            childNodes: [
-                                { textContent: 'window.__STATE__={email:"customer@example.com"};', type: 3 },
-                            ],
-                            tagName: "script",
-                            type: 2,
-                        },
-                    ],
-                    type: 2,
-                },
-                text: "customer@example.com",
-            },
-            timestamp: 1,
-            type: 3,
-        });
-        vi.advanceTimersByTime(5_000);
-        const requestBody = vi.mocked(fetch).mock.calls[0]?.[1]?.body;
-        expect(typeof requestBody).toBe("string");
-        if (typeof requestBody !== "string") {
-            throw new Error("expected replay request body to be a string");
-        }
-        const payload = JSON.parse(requestBody);
-        const serializedEvents = JSON.stringify(payload.events);
-        expect(serializedEvents).not.toContain("Jane Example");
-        expect(serializedEvents).not.toContain("customer@example.com");
-        expect(serializedEvents).not.toContain("body{color:#0f172a;}");
-        expect(serializedEvents).not.toContain('window.__STATE__={email:"customer@example.com"};');
-        expect(serializedEvents).toContain("************");
-        recorder.dispose();
-    });
-});

package/dist/__tests__/session.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=session.test.d.ts.map

package/dist/__tests__/session.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"session.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/session.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/session.test.js

@@ -1,46 +0,0 @@
-import { describe, it, expect, beforeEach, vi } from "vitest";
-import { getSessionId, resetSessionId } from "../session";
-describe("session", () => {
-    beforeEach(() => {
-        resetSessionId();
-        // Mock sessionStorage
-        const store = {};
-        vi.stubGlobal("sessionStorage", {
-            getItem: (key) => store[key] ?? null,
-            setItem: (key, val) => {
-                store[key] = val;
-            },
-            removeItem: (key) => {
-                delete store[key];
-            },
-        });
-    });
-    it("generates a UUID session ID", () => {
-        const id = getSessionId();
-        expect(id).toMatch(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/);
-    });
-    it("returns the same ID on subsequent calls", () => {
-        const id1 = getSessionId();
-        const id2 = getSessionId();
-        expect(id1).toBe(id2);
-    });
-    it("generates a new ID after reset", () => {
-        const id1 = getSessionId();
-        resetSessionId();
-        const id2 = getSessionId();
-        expect(id1).not.toBe(id2);
-    });
-    it("persists to sessionStorage", () => {
-        const id = getSessionId();
-        expect(sessionStorage.getItem("__sq_sid")).toBe(id);
-    });
-    it("restores from sessionStorage", () => {
-        sessionStorage.setItem("__sq_sid", "existing-session-id");
-        // Clear the in-memory cache
-        resetSessionId();
-        // Re-set the storage value after reset cleared it
-        sessionStorage.setItem("__sq_sid", "existing-session-id");
-        const id = getSessionId();
-        expect(id).toBe("existing-session-id");
-    });
-});

package/dist/__tests__/transport.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=transport.test.d.ts.map

package/dist/__tests__/transport.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"transport.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/transport.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/transport.test.js

@@ -1,101 +0,0 @@
-import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
-import { Transport } from "../transport";
-describe("Transport", () => {
-    let transport;
-    beforeEach(() => {
-        vi.useFakeTimers();
-        // Mock sendBeacon
-        vi.stubGlobal("navigator", {
-            sendBeacon: vi.fn().mockReturnValue(true),
-        });
-        // Mock document visibility
-        vi.stubGlobal("document", {
-            addEventListener: vi.fn(),
-            visibilityState: "visible",
-        });
-        // Mock window
-        vi.stubGlobal("window", {
-            addEventListener: vi.fn(),
-        });
-        transport = new Transport({
-            endpoint: "https://ingest.squasher.ai",
-            projectId: "test-project",
-            apiKey: "sq_pk_test",
-            debug: false,
-            vitalsBufferSize: 3,
-            vitalsFlushIntervalMs: 10_000,
-        });
-    });
-    afterEach(() => {
-        transport.dispose();
-        vi.useRealTimers();
-        vi.restoreAllMocks();
-    });
-    it("sends errors immediately via sendBeacon", () => {
-        transport.sendError({
-            message: "Test error",
-            level: "error",
-            sdk: { name: "@squasher-ai/browser", version: "0.1.0" },
-        });
-        expect(navigator.sendBeacon).toHaveBeenCalledOnce();
-        const [url, blob] = navigator.sendBeacon.mock.calls[0];
-        expect(url).toBe("https://ingest.squasher.ai/v1/ingest/test-project?key=sq_pk_test");
-        expect(blob).toBeInstanceOf(Blob);
-    });
-    it("buffers vitals and flushes when buffer is full", () => {
-        const vital = {
-            type: "vital",
-            name: "LCP",
-            value: 2400,
-            rating: "needs-improvement",
-            delta: 2400,
-            navigationType: "navigate",
-            url: "https://example.com",
-            session_id: "test-session",
-            timestamp: Date.now(),
-        };
-        // Send 2 vitals (below buffer size of 3)
-        transport.enqueueVital(vital);
-        transport.enqueueVital(vital);
-        expect(navigator.sendBeacon).not.toHaveBeenCalled();
-        // Third vital triggers flush
-        transport.enqueueVital(vital);
-        expect(navigator.sendBeacon).toHaveBeenCalledOnce();
-        const [url] = navigator.sendBeacon.mock.calls[0];
-        expect(url).toBe("https://ingest.squasher.ai/v1/vitals/test-project");
-    });
-    it("flushes on dispose", () => {
-        const vital = {
-            type: "vital",
-            name: "FCP",
-            value: 1000,
-            rating: "good",
-            delta: 1000,
-            navigationType: "navigate",
-            url: "https://example.com",
-            session_id: "s1",
-            timestamp: Date.now(),
-        };
-        transport.enqueueVital(vital);
-        expect(navigator.sendBeacon).not.toHaveBeenCalled();
-        transport.dispose();
-        expect(navigator.sendBeacon).toHaveBeenCalledOnce();
-    });
-    it("does not enqueue after dispose", () => {
-        transport.dispose();
-        vi.mocked(navigator.sendBeacon).mockClear();
-        transport.enqueueVital({
-            type: "vital",
-            name: "CLS",
-            value: 0.05,
-            rating: "good",
-            delta: 0.05,
-            navigationType: "navigate",
-            url: "https://example.com",
-            session_id: "s1",
-            timestamp: Date.now(),
-        });
-        // Should not send after dispose
-        expect(navigator.sendBeacon).not.toHaveBeenCalled();
-    });
-});

package/dist/__tests__/types.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.test.d.ts.map

package/dist/__tests__/types.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/types.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/types.test.js

@@ -1,139 +0,0 @@
-import { describe, it, expect } from "vitest";
-/**
- * Type-level parity tests.
- *
- * These tests verify that the browser SDK types match the ingestion wire
- * protocol and API spec shapes. They don't test runtime behavior — they
- * ensure type definitions are structurally compatible.
- */
-describe("type parity", () => {
-    it("VitalEvent matches the ingestion payload schema", () => {
-        const event = {
-            type: "vital",
-            name: "LCP",
-            value: 2400,
-            rating: "needs-improvement",
-            delta: 2400,
-            navigationType: "navigate",
-            url: "https://example.com/checkout",
-            route: "/checkout",
-            session_id: "abc-123",
-            timestamp: 1711234567890,
-            environment: "production",
-            release: "1.0.0",
-            connection: "4g",
-            device_type: "desktop",
-            referrer: "https://google.com",
-        };
-        // Verify all fields are serializable to JSON
-        const json = JSON.parse(JSON.stringify(event));
-        expect(json.type).toBe("vital");
-        expect(json.name).toBe("LCP");
-        expect(json.value).toBe(2400);
-        expect(json.rating).toBe("needs-improvement");
-        expect(json.session_id).toBe("abc-123");
-    });
-    it("VitalsPayload wraps events array", () => {
-        const payload = {
-            events: [
-                {
-                    type: "vital",
-                    name: "CLS",
-                    value: 0.05,
-                    rating: "good",
-                    delta: 0.01,
-                    navigationType: "navigate",
-                    url: "https://example.com",
-                    session_id: "s1",
-                    timestamp: 1000,
-                },
-            ],
-        };
-        const json = JSON.parse(JSON.stringify(payload));
-        expect(json.events).toHaveLength(1);
-        expect(json.events[0].name).toBe("CLS");
-    });
-    it("BrowserErrorEvent includes session_id", () => {
-        const event = {
-            message: "Test error",
-            type: "TypeError",
-            level: "error",
-            session_id: "browser-session-123",
-            sdk: { name: "@squasher-ai/browser", version: "0.1.0" },
-            timestamp: new Date().toISOString(),
-        };
-        expect(event.session_id).toBe("browser-session-123");
-    });
-    it("BrowserErrorEvent supports analytics and agent telemetry fields", () => {
-        const event = {
-            message: "tool call completed",
-            kind: "tool_call",
-            event_name: "db.lookup",
-            distinct_id: "agent-123",
-            analytics: {
-                event: "checkout_started",
-                properties: {
-                    step: 1,
-                },
-            },
-            trace: {
-                trace_id: "trace-1",
-                span_id: "span-1",
-            },
-            tool_call: {
-                name: "db.lookup",
-                duration_ms: 42,
-            },
-            llm: {
-                provider: "anthropic",
-                model: "claude-sonnet",
-            },
-        };
-        expect(event.kind).toBe("tool_call");
-        expect(event.analytics?.event).toBe("checkout_started");
-        expect(event.trace?.trace_id).toBe("trace-1");
-        expect(event.tool_call?.name).toBe("db.lookup");
-        expect(event.llm?.model).toBe("claude-sonnet");
-    });
-    it("BrowserConfig has vitals-specific fields", () => {
-        const config = {
-            apiKey: "sq_pk_test",
-            projectId: "test-project",
-            enableVitals: true,
-            vitalsSampleRate: 0.5,
-            vitalsBufferSize: 10,
-            vitalsFlushIntervalMs: 10_000,
-            enableErrorCapture: true,
-            enableAutoBreadcrumbs: true,
-        };
-        expect(config.enableVitals).toBe(true);
-        expect(config.vitalsSampleRate).toBe(0.5);
-    });
-    it("BrowserConfig supports replay recording options", () => {
-        const config = {
-            apiKey: "sq_pk_test",
-            projectId: "test-project",
-            replay: {
-                enabled: true,
-                privacy: {
-                    blockSelector: ".pii-container",
-                    maskAllText: true,
-                },
-                sampleRate: 0.25,
-            },
-        };
-        expect(config.replay?.enabled).toBe(true);
-        expect(config.replay?.privacy?.blockSelector).toBe(".pii-container");
-        expect(config.replay?.privacy?.maskAllText).toBe(true);
-        expect(config.replay?.sampleRate).toBe(0.25);
-    });
-    it("VitalMetricName only allows valid metric names", () => {
-        // TypeScript compile-time check — these are the only valid values
-        const validNames = ["LCP", "CLS", "INP", "FCP", "TTFB"];
-        expect(validNames).toHaveLength(5);
-    });
-    it("VitalRating only allows valid ratings", () => {
-        const validRatings = ["good", "needs-improvement", "poor"];
-        expect(validRatings).toHaveLength(3);
-    });
-});