@sailfish-ai/recorder 1.11.0 → 1.11.3

package/dist/recording.js

@@ -1,6 +1,6 @@
 // import { NetworkRecordOptions } from "@sailfish-rrweb/rrweb-plugin-network-record";
 import { EventType } from "@sailfish-rrweb/types";
-import { Complete, DomContentEventId, DomContentSource, Loading, } from "./constants";
+import { Complete, DomContentEventId, DomContentSource, Loading, PerformanceMetricEventId, } from "./constants";
 import { getCallerLocation, getCallerLocationFromTrace, } from "./sourceLocation";
 import suppressConsoleLogsDuringCall from "./suppressConsoleLogsDuringCall";
 import { yieldToMain } from "./scheduler";
@@ -157,6 +157,36 @@ export function initializeDomContentEvents(sessionId) {
         });
     });
 }
+export async function initializePerformancePlugin(sessionId) {
+    try {
+        const { getRecordPerformancePlugin } = await import("@sailfish-rrweb/rrweb-plugin-performance-record");
+        await yieldToMain();
+        const plugin = getRecordPerformancePlugin({
+            getPageVisitUuid: () => sessionStorage.getItem("pageVisitUUID"),
+        });
+        // `observer` is defined on the plugin (see rrweb-plugin-performance-record).
+        // Call it directly so the plugin can start its PerformanceObservers without
+        // needing to be registered through rrweb's record() lifecycle — same pattern
+        // as initializeConsolePlugin.
+        plugin.observer?.((payload) => {
+            const typed = payload;
+            sendEvent({
+                type: PerformanceMetricEventId,
+                timestamp: typed.timestamp,
+                sessionId,
+                data: {
+                    plugin: plugin.name,
+                    payload: typed,
+                },
+                ...getUrlAndStoredUuids(),
+            });
+        }, window, plugin.options);
+    }
+    catch (error) {
+        // Never let a plugin failure break the recorder.
+        console.warn("[Sailfish] Performance plugin failed to initialize:", error);
+    }
+}
 export async function initializeConsolePlugin(consoleRecordSettings, sessionId) {
     const { getRecordConsolePlugin } = await import("@sailfish-rrweb/rrweb-plugin-console-record");
     // Yield between dynamic import and observer setup
@@ -320,8 +350,8 @@ backendApi, apiKey, sessionId, envValue, deferRecordingStart = true, useWsWorker
                     },
                     maskInputOptions: { text: true },
                     maskInputFn,
-                    maskTextClass: MASK_CLASS,
                     ...captureSettings,
+                    maskTextClass: captureSettings.maskTextClass ?? MASK_CLASS,
                     recordDOM: false, // after spread so it can't be overridden
                 });
                 const snapshotStartTime = Date.now();
@@ -383,8 +413,8 @@ backendApi, apiKey, sessionId, envValue, deferRecordingStart = true, useWsWorker
                     },
                     maskInputOptions: { text: true },
                     maskInputFn,
-                    maskTextClass: MASK_CLASS,
                     ...captureSettings,
+                    maskTextClass: captureSettings.maskTextClass ?? MASK_CLASS,
                 });
             }
         };

package/dist/sendSailfishMessages.js

@@ -4,6 +4,10 @@ import { sendMessage } from "./websocket";
 let lastIdentifyMessage = null;
 let lastMetadataMessage = null;
 let deviceInfoSent = false;
+// Get the last identified user (for matching reporter in Report Issue modal)
+export function getIdentifiedUser() {
+    return lastIdentifyMessage;
+}
 // Function to send identify message
 export function identify(userId, traits = {}, overwrite = false) {
     const message = {

package/dist/snippet-auto-init.js

@@ -2,37 +2,158 @@
  * Auto-init from <script> data attributes (CDN / snippet mode).
  *
  * This file is ONLY included in the UMD build (not ES/CJS). It runs at load
- * time and checks document.currentScript for data-api-key to auto-initialize.
+ * time, reads `data-*` attributes off the currently-executing <script> tag,
+ * coerces them to their proper TypeScript-typed `initRecorder` options,
+ * and invokes the recorder.
  *
- * CRITICAL: Everything is wrapped in try/catch. A Sailfish error must
- * NEVER break the customer's application.
+ * CRITICAL: Everything is wrapped in try/catch. A Sailfish error must NEVER
+ * break the customer's application. Malformed attribute values are silently
+ * ignored rather than thrown — the SDK's own defaults take over in that
+ * case.
  *
  * Usage:
- *   <script src="https://cdn.jsdelivr.net/npm/@sailfish-ai/recorder@1/dist/recorder.umd.js"
+ *   <script src="https://cdn.jsdelivr.net/npm/@sailfish-ai/recorder@1.11.0"
  *     data-api-key="YOUR_API_KEY"
- *     data-service-identifier="my-app"
+ *     data-service-identifier="acme-corp/web-app"
  *     data-service-version="1.0.0"
- *     data-backend-api="https://api-service.sailfish.ai"
+ *     data-domains-to-propagate-header-to="*.acme.com,api.acme.com"
+ *     data-domains-to-not-propagate-header-to="analytics.google.com,sentry.io"
+ *     data-enable-fiber-tracking="true"
+ *     data-enable-ip-tracking="false"
+ *     data-capture-streaming-response-body="true"
+ *     data-capture-response-body-max-mb="10"
+ *     data-capture-stream-prefix-kb="64"
+ *     data-capture-stream-timeout-ms="10000"
+ *     data-defer-recording="true"
+ *     data-chunk-snapshot="false"
+ *     data-use-ws-worker="false"
+ *     data-custom-base-url="https://triage.acme.com"
+ *     data-git-sha="abc1234"
+ *     data-show-eng-ticket-fields-in-report-issue-modal-default="false"
+ *     data-library="JS/TS SNIPPET"
  *   ></script>
+ *
+ * Attribute name convention: HTML5 `dataset` kebab-case. Each camelCase
+ * option on `initRecorder({ ... })` maps to `data-<kebab-case>`. See
+ * docs/docs-enterprise/integrate-with-your-code/frontend/javascript-typescript-cdn.md
+ * for the authoritative mapping table.
+ *
+ * Options NOT supported via data attributes (require npm install):
+ *   - serviceAdditionalMetadata (Record<string, any>) — JSON in HTML attrs
+ *     is error-prone; use initRecorder({ serviceAdditionalMetadata }) instead.
+ *   - reportIssueShortcuts (Partial<ShortcutsConfig>) — same reason.
+ *   - backendApi — Enterprise customers should use the SDK default.
  */
 import { initRecorder } from "./index";
+/**
+ * Split a CSV attribute value into a trimmed, non-empty string array.
+ * Returns `null` if the value is falsy or produces no entries so the
+ * caller can skip setting the option (letting the SDK default apply).
+ */
+function parseCsv(raw) {
+    if (!raw)
+        return null;
+    try {
+        const parts = raw
+            .split(",")
+            .map((s) => s.trim())
+            .filter(Boolean);
+        return parts.length > 0 ? parts : null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Parse a boolean attribute. Only the literal string `"true"` is
+ * treated as true; anything else (including `"false"`, absent values,
+ * numeric strings) returns `null` so the caller can skip setting the
+ * option and let the SDK default apply.
+ */
+function parseBool(raw) {
+    if (raw === undefined)
+        return null;
+    if (raw === "true")
+        return true;
+    if (raw === "false")
+        return false;
+    return null;
+}
+/**
+ * Parse a numeric attribute. Non-finite results (NaN, Infinity) return
+ * `null` so the caller skips setting the option.
+ */
+function parseNumber(raw) {
+    if (raw === undefined || raw === "")
+        return null;
+    try {
+        const n = Number(raw);
+        return Number.isFinite(n) ? n : null;
+    }
+    catch {
+        return null;
+    }
+}
 try {
     if (typeof document !== "undefined" && document.currentScript) {
         const script = document.currentScript;
-        if (script.dataset?.apiKey) {
+        const ds = script.dataset ?? {};
+        if (ds.apiKey) {
             const opts = {
-                apiKey: script.dataset.apiKey,
+                apiKey: ds.apiKey,
             };
-            if (script.dataset.backendApi)
-                opts.backendApi = script.dataset.backendApi;
-            if (script.dataset.serviceIdentifier)
-                opts.serviceIdentifier = script.dataset.serviceIdentifier;
-            if (script.dataset.serviceVersion)
-                opts.serviceVersion = script.dataset.serviceVersion;
-            if (script.dataset.library)
-                opts.library = script.dataset.library;
-            if (!opts.library)
-                opts.library = "JS/TS SNIPPET";
+            // ── Service identification (strings) ──────────────────────────
+            if (ds.serviceIdentifier)
+                opts.serviceIdentifier = ds.serviceIdentifier;
+            if (ds.serviceVersion)
+                opts.serviceVersion = ds.serviceVersion;
+            if (ds.gitSha)
+                opts.gitSha = ds.gitSha;
+            if (ds.customBaseUrl)
+                opts.customBaseUrl = ds.customBaseUrl;
+            // ── Domain allowlist/blocklist (CSV → string[]) ───────────────
+            const propagate = parseCsv(ds.domainsToPropagateHeaderTo);
+            if (propagate)
+                opts.domainsToPropagateHeaderTo = propagate;
+            const noPropagate = parseCsv(ds.domainsToNotPropagateHeaderTo);
+            if (noPropagate)
+                opts.domainsToNotPropagateHeaderTo = noPropagate;
+            // ── Tracking flags (boolean) ──────────────────────────────────
+            const enableFiber = parseBool(ds.enableFiberTracking);
+            if (enableFiber !== null)
+                opts.enableFiberTracking = enableFiber;
+            const enableIp = parseBool(ds.enableIpTracking);
+            if (enableIp !== null)
+                opts.enableIpTracking = enableIp;
+            // ── Network body capture (boolean + number) ───────────────────
+            const captureStream = parseBool(ds.captureStreamingResponseBody);
+            if (captureStream !== null)
+                opts.captureStreamingResponseBody = captureStream;
+            const maxMb = parseNumber(ds.captureResponseBodyMaxMb);
+            if (maxMb !== null)
+                opts.captureResponseBodyMaxMb = maxMb;
+            const prefixKb = parseNumber(ds.captureStreamPrefixKb);
+            if (prefixKb !== null)
+                opts.captureStreamPrefixKb = prefixKb;
+            const timeoutMs = parseNumber(ds.captureStreamTimeoutMs);
+            if (timeoutMs !== null)
+                opts.captureStreamTimeoutMs = timeoutMs;
+            // ── Performance knobs (boolean) ───────────────────────────────
+            const defer = parseBool(ds.deferRecording);
+            if (defer !== null)
+                opts.deferRecording = defer;
+            const chunk = parseBool(ds.chunkSnapshot);
+            if (chunk !== null)
+                opts.chunkSnapshot = chunk;
+            const wsWorker = parseBool(ds.useWsWorker);
+            if (wsWorker !== null)
+                opts.useWsWorker = wsWorker;
+            // ── Issue reporting (boolean) ─────────────────────────────────
+            const showEngTicket = parseBool(ds.showEngTicketFieldsInReportIssueModalDefault);
+            if (showEngTicket !== null)
+                opts.showEngTicketFieldsInReportIssueModalDefault = showEngTicket;
+            // ── Library tag (string) ──────────────────────────────────────
+            opts.library = ds.library || "JS/TS SNIPPET";
             initRecorder(opts).catch(() => {
                 // Silently swallow — never break customer's app
             });
@@ -42,3 +163,11 @@ try {
 catch (_) {
     // Silently swallow any errors during auto-init
 }
+/**
+ * Internal helpers are exported for the test suite only. The UMD
+ * bundle is the entry point for customers — they should never `import`
+ * from this module.
+ *
+ * @internal
+ */
+export const __testing = { parseCsv, parseBool, parseNumber };

package/dist/types/constants.d.ts

@@ -1,5 +1,6 @@
 export declare const DomContentEventId = 24;
 export declare const NetworkRequestEventId = 27;
+export declare const PerformanceMetricEventId = 28;
 export declare const xSf3RidHeader = "X-Sf3-Rid";
 export declare const DomContentSource: {
     loading: number;

package/dist/types/inAppReportIssueModal/integrations.d.ts

@@ -16,5 +16,12 @@ export declare function getSprintFieldId(): string;
 export declare function updateIssueTypeOptions(selectElement: HTMLSelectElement, projectId: string): void;
 export declare function getFieldsForProject(projectId: string, issueTypeId?: string): any[];
 export declare function getUsers(): any[];
+/**
+ * Match the current identified user against the Jira users list and
+ * return their accountId. Uses email, name, and email-prefix matching
+ * (same logic as the dashboard). Only returns a match when exactly one
+ * user matches to avoid ambiguity.
+ */
+export declare function getDefaultReporterAccountId(): string | null;
 export declare function getProjectsForTeam(teamId?: string): any[];
 export declare function updateFormWithIntegrationData(currentState: IssueReportState): IssueReportState;

package/dist/types/index.d.ts

@@ -6,7 +6,7 @@ export declare const DEFAULT_CAPTURE_SETTINGS: CaptureSettings;
 export declare const DEFAULT_CONSOLE_RECORDING_SETTINGS: LogRecordOptions;
 export declare function matchUrlWithWildcard(input: unknown, patterns: string[]): boolean;
 export declare function createSkipHeadersPropagationChecker(domainsToNotPropagateHeaderTo?: string[], domainsToPropagateHeaderTo?: string[]): (url: string) => boolean;
-export declare function startRecording({ apiKey, backendApi, domainsToPropagateHeaderTo, domainsToNotPropagateHeaderTo, serviceVersion, serviceIdentifier, gitSha, serviceAdditionalMetadata, enableIpTracking, captureStreamingResponseBody, captureResponseBodyMaxMb, captureStreamPrefixKb, captureStreamTimeoutMs, enableFiberTracking, deferRecording, deferRecordingStart, chunkSnapshot, useWsWorker, library, }: {
+export declare function startRecording({ apiKey, backendApi, domainsToPropagateHeaderTo, domainsToNotPropagateHeaderTo, serviceVersion, serviceIdentifier, gitSha, serviceAdditionalMetadata, enableIpTracking, captureStreamingResponseBody, captureResponseBodyMaxMb, captureStreamPrefixKb, captureStreamTimeoutMs, enableFiberTracking, deferRecording, deferRecordingStart, chunkSnapshot, useWsWorker, capturePerformanceMetrics, maskTextClass, library, headlessRecording, }: {
     apiKey: string;
     backendApi?: string;
     domainsToPropagateHeaderTo?: string[];
@@ -27,6 +27,9 @@ export declare function startRecording({ apiKey, backendApi, domainsToPropagateH
     deferRecordingStart?: boolean;
     chunkSnapshot?: boolean;
     useWsWorker?: boolean;
+    capturePerformanceMetrics?: boolean;
+    maskTextClass?: string;
+    headlessRecording?: boolean;
 }): Promise<void>;
 export declare const initRecorder: (options: {
     apiKey: string;
@@ -76,7 +79,26 @@ export declare const initRecorder: (options: {
      */
     chunkSnapshot?: boolean;
     useWsWorker?: boolean;
+    /**
+     * Capture browser performance metrics (FCP, LCP, TBT, DCL, LOAD) per
+     * page_visit_uuid via the `@sailfish-rrweb/rrweb-plugin-performance-record`
+     * plugin. Set to `false` to skip the plugin entirely — the plugin code is
+     * dynamically imported, so opting out also avoids loading `web-vitals` and
+     * the metric observers. Useful for benchmarking the recorder's own
+     * overhead, or for sites that already collect RUM through another vendor.
+     * @default true
+     */
+    capturePerformanceMetrics?: boolean;
     showEngTicketFieldsInReportIssueModalDefault?: boolean;
+    maskTextClass?: string;
+    /**
+     * When true, recording proceeds even inside headless / automated browser
+     * environments (Puppeteer, Playwright, Cypress, etc.), bypassing the
+     * `isHeadlessOrLighthouse()` guard in `startRecording`.
+     * When false (default), those environments are silently skipped.
+     * @default false
+     */
+    headlessRecording?: boolean;
 }) => Promise<void>;
 export * from "./graphql";
 export { openReportIssueModal } from "./inAppReportIssueModal";

package/dist/types/recording.d.ts

@@ -10,6 +10,7 @@ export declare const getUrlAndStoredUuids: () => {
     tabVisibilityState: string;
 };
 export declare function initializeDomContentEvents(sessionId: string): void;
+export declare function initializePerformancePlugin(sessionId: string): Promise<void>;
 export declare function initializeConsolePlugin(consoleRecordSettings: LogRecordOptions, sessionId: string): Promise<void>;
 export declare function initializeRecording(captureSettings: any, // TODO - Sibyl post-launch - replace type
 backendApi: string, apiKey: string, sessionId: string, envValue?: string, deferRecordingStart?: boolean, useWsWorker?: boolean, chunkSnapshot?: boolean): Promise<WsHandle>;

package/dist/types/sendSailfishMessages.d.ts

@@ -1,3 +1,7 @@
+export declare function getIdentifiedUser(): {
+    userId: string;
+    traits: Record<string, any>;
+} | null;
 export declare function identify(userId: string, traits?: Record<string, any>, overwrite?: boolean): void;
 export declare function addOrUpdateMetadata(metadata: Record<string, any>): void;
 export declare function trackingEvent(trackingData: Record<string, any>): void;

package/dist/types/snippet-auto-init.d.ts

@@ -1 +1,31 @@
+/**
+ * Split a CSV attribute value into a trimmed, non-empty string array.
+ * Returns `null` if the value is falsy or produces no entries so the
+ * caller can skip setting the option (letting the SDK default apply).
+ */
+declare function parseCsv(raw: string | undefined): string[] | null;
+/**
+ * Parse a boolean attribute. Only the literal string `"true"` is
+ * treated as true; anything else (including `"false"`, absent values,
+ * numeric strings) returns `null` so the caller can skip setting the
+ * option and let the SDK default apply.
+ */
+declare function parseBool(raw: string | undefined): boolean | null;
+/**
+ * Parse a numeric attribute. Non-finite results (NaN, Infinity) return
+ * `null` so the caller skips setting the option.
+ */
+declare function parseNumber(raw: string | undefined): number | null;
+/**
+ * Internal helpers are exported for the test suite only. The UMD
+ * bundle is the entry point for customers — they should never `import`
+ * from this module.
+ *
+ * @internal
+ */
+export declare const __testing: {
+    parseCsv: typeof parseCsv;
+    parseBool: typeof parseBool;
+    parseNumber: typeof parseNumber;
+};
 export {};

package/dist/types/types.d.ts

@@ -11,6 +11,7 @@ export interface CaptureSettings {
     sampling: object;
     textEditThrottleEnabled?: boolean;
     enableFiberTracking?: boolean;
+    maskTextClass?: string;
 }
 export interface ConsoleRecordSettings {
     level: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailfish-ai/recorder",
-  "version": "1.11.0",
+  "version": "1.11.3",
   "publishPublicly": true,
   "publishToCdn": {
     "jsdelivr": true,
@@ -19,6 +19,7 @@
     "test": "vitest run",
     "test:watch": "vitest watch",
     "check-types": "tsc --noEmit",
+    "bench-perf": "node scripts/bench-perf.js",
     "prepublish": "npm run check-types && npm run build",
     "artifactregistry-login": "npx google-artifactregistry-auth",
     "publish-local": "npm publish --tag latest --registry http://localhost:4873 --//localhost:4873/:_authToken=none"
@@ -47,9 +48,10 @@
     "dist"
   ],
   "dependencies": {
-    "@sailfish-rrweb/rrweb-plugin-console-record": "0.5.9",
-    "@sailfish-rrweb/rrweb-record-only": "0.5.9",
-    "@sailfish-rrweb/types": "0.5.9",
+    "@sailfish-rrweb/rrweb-plugin-console-record": "0.5.11",
+    "@sailfish-rrweb/rrweb-plugin-performance-record": "0.5.11",
+    "@sailfish-rrweb/rrweb-record-only": "0.5.11",
+    "@sailfish-rrweb/types": "0.5.11",
     "reconnecting-websocket": "^4.4.0",
     "source-map-js": "^1.2.1"
   },
@@ -74,6 +76,7 @@
     "jest-localstorage-mock": "^2.4.26",
     "jest-transform-stub": "^2.0.0",
     "jsdom": "^25.0.0",
+    "puppeteer": "^23.0.0",
     "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-visualizer": "^5.12.0",
     "ts-jest": "^29.4.0",