@spotify-confidence/csr-common 0.18.3 → 0.18.4

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.18.4](https://github.com/spotify/confidence-sdk-js/compare/csr-common-v0.18.3...csr-common-v0.18.4) (2026-08-05)
+
+
+### ✨ New Features
+
+* **csr-common:** optional eventId identity on custom event payloads ([#428](https://github.com/spotify/confidence-sdk-js/issues/428)) ([f49970a](https://github.com/spotify/confidence-sdk-js/commit/f49970a4ccd34cbfbdef7729df19a256f077fced))
+
 ## [0.18.3](https://github.com/spotify/confidence-sdk-js/compare/csr-common-v0.18.2...csr-common-v0.18.3) (2026-07-16)
 
 

package/dist/index.d.cts

@@ -64,6 +64,7 @@ declare enum MouseInteractions {
 type RageClickCustomData = {
   tag: "csr:rageClick";
   payload: {
+    eventId?: string;
     targetId: number;
     clickCount: number;
     durationMs: number;
@@ -74,6 +75,7 @@ type RageClickCustomData = {
 type FormFieldReEditCustomData = {
   tag: "csr:formFieldReEdit";
   payload: {
+    eventId?: string;
     targetId: number;
     editCount: number;
     element?: ElementDescriptor;
@@ -83,6 +85,7 @@ type FormFieldReEditCustomData = {
 type ScrollBackCustomData = {
   tag: "csr:scrollBack";
   payload: {
+    eventId?: string;
     scrollBackPx: number;
     fromY: number;
     toY: number;
@@ -98,6 +101,7 @@ type ElementDescriptor = {
 type ClickCustomData = {
   tag: "csr:click";
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -106,6 +110,7 @@ type ClickCustomData = {
 type InputCustomData = {
   tag: "csr:input";
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -116,6 +121,7 @@ type InputCustomData = {
 type DeadClickCustomData = {
   tag: "csr:deadClick";
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -124,12 +130,14 @@ type DeadClickCustomData = {
 type TabUnfocusCustomData = {
   tag: "csr:tabUnfocus";
   payload: {
+    eventId?: string;
     pathname?: string;
   };
 };
 type TabRefocusCustomData = {
   tag: "csr:tabRefocus";
   payload: {
+    eventId?: string;
     awayDurationMs: number;
     pathname?: string;
   };
@@ -142,7 +150,9 @@ type RouteChangePayload = {
 };
 type RouteChangeCustomData = {
   tag: "csr:routeChange";
-  payload: RouteChangePayload;
+  payload: RouteChangePayload & {
+    eventId?: string;
+  };
 };
 /**
 * Plugin event data emitted by the recorder for tab visibility changes.
@@ -211,18 +221,21 @@ type FlagEvaluationPluginData = {
 type ErrorMessageCustomData = {
   tag: "csr:errorMessage";
   payload: {
+    eventId?: string;
     text: string;
   };
 };
 type DialogOpenedCustomData = {
   tag: "csr:dialogOpened";
   payload: {
+    eventId?: string;
     content: string[];
   };
 };
 type IdleGapCustomData = {
   tag: "csr:idleGap";
   payload: {
+    eventId?: string;
     visibleGapS: number;
     totalGapS: number;
     hiddenS: number;
@@ -232,6 +245,7 @@ type IdleGapCustomData = {
 type AwayGapCustomData = {
   tag: "csr:awayGap";
   payload: {
+    eventId?: string;
     totalGapS: number;
     hiddenS: number;
   };
@@ -239,6 +253,11 @@ type AwayGapCustomData = {
 /**
 * Closed union of every Custom event we emit. Add a new variant here when
 * introducing a new tag — emitting an unregistered tag is a TS error.
+*
+* Every payload carries an optional `eventId`: a per-event identity stamped
+* at emission by the analyzer (uuid). It is inert metadata — players ignore
+* it — and exists so downstream review tooling can reference and remove
+* individual generated events without patching untyped data.
 */
 type CustomEventData = ClickCustomData | InputCustomData | RageClickCustomData | FormFieldReEditCustomData | ScrollBackCustomData | DeadClickCustomData | TabUnfocusCustomData | TabRefocusCustomData | RouteChangeCustomData | ErrorMessageCustomData | DialogOpenedCustomData | IdleGapCustomData | AwayGapCustomData;
 /**

package/dist/index.d.ts

@@ -64,6 +64,7 @@ declare enum MouseInteractions {
 type RageClickCustomData = {
   tag: "csr:rageClick";
   payload: {
+    eventId?: string;
     targetId: number;
     clickCount: number;
     durationMs: number;
@@ -74,6 +75,7 @@ type RageClickCustomData = {
 type FormFieldReEditCustomData = {
   tag: "csr:formFieldReEdit";
   payload: {
+    eventId?: string;
     targetId: number;
     editCount: number;
     element?: ElementDescriptor;
@@ -83,6 +85,7 @@ type FormFieldReEditCustomData = {
 type ScrollBackCustomData = {
   tag: "csr:scrollBack";
   payload: {
+    eventId?: string;
     scrollBackPx: number;
     fromY: number;
     toY: number;
@@ -98,6 +101,7 @@ type ElementDescriptor = {
 type ClickCustomData = {
   tag: "csr:click";
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -106,6 +110,7 @@ type ClickCustomData = {
 type InputCustomData = {
   tag: "csr:input";
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -116,6 +121,7 @@ type InputCustomData = {
 type DeadClickCustomData = {
   tag: "csr:deadClick";
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -124,12 +130,14 @@ type DeadClickCustomData = {
 type TabUnfocusCustomData = {
   tag: "csr:tabUnfocus";
   payload: {
+    eventId?: string;
     pathname?: string;
   };
 };
 type TabRefocusCustomData = {
   tag: "csr:tabRefocus";
   payload: {
+    eventId?: string;
     awayDurationMs: number;
     pathname?: string;
   };
@@ -142,7 +150,9 @@ type RouteChangePayload = {
 };
 type RouteChangeCustomData = {
   tag: "csr:routeChange";
-  payload: RouteChangePayload;
+  payload: RouteChangePayload & {
+    eventId?: string;
+  };
 };
 /**
 * Plugin event data emitted by the recorder for tab visibility changes.
@@ -211,18 +221,21 @@ type FlagEvaluationPluginData = {
 type ErrorMessageCustomData = {
   tag: "csr:errorMessage";
   payload: {
+    eventId?: string;
     text: string;
   };
 };
 type DialogOpenedCustomData = {
   tag: "csr:dialogOpened";
   payload: {
+    eventId?: string;
     content: string[];
   };
 };
 type IdleGapCustomData = {
   tag: "csr:idleGap";
   payload: {
+    eventId?: string;
     visibleGapS: number;
     totalGapS: number;
     hiddenS: number;
@@ -232,6 +245,7 @@ type IdleGapCustomData = {
 type AwayGapCustomData = {
   tag: "csr:awayGap";
   payload: {
+    eventId?: string;
     totalGapS: number;
     hiddenS: number;
   };
@@ -239,6 +253,11 @@ type AwayGapCustomData = {
 /**
 * Closed union of every Custom event we emit. Add a new variant here when
 * introducing a new tag — emitting an unregistered tag is a TS error.
+*
+* Every payload carries an optional `eventId`: a per-event identity stamped
+* at emission by the analyzer (uuid). It is inert metadata — players ignore
+* it — and exists so downstream review tooling can reference and remove
+* individual generated events without patching untyped data.
 */
 type CustomEventData = ClickCustomData | InputCustomData | RageClickCustomData | FormFieldReEditCustomData | ScrollBackCustomData | DeadClickCustomData | TabUnfocusCustomData | TabRefocusCustomData | RouteChangeCustomData | ErrorMessageCustomData | DialogOpenedCustomData | IdleGapCustomData | AwayGapCustomData;
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotify-confidence/csr-common",
   "license": "Apache-2.0",
-  "version": "0.18.3",
+  "version": "0.18.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/spotify/confidence-sdk-js.git",

package/src/events.ts

@@ -65,6 +65,7 @@ export enum MouseInteractions {
 export type RageClickCustomData = {
   tag: 'csr:rageClick';
   payload: {
+    eventId?: string;
     targetId: number;
     clickCount: number;
     durationMs: number;
@@ -76,6 +77,7 @@ export type RageClickCustomData = {
 export type FormFieldReEditCustomData = {
   tag: 'csr:formFieldReEdit';
   payload: {
+    eventId?: string;
     targetId: number;
     editCount: number;
     element?: ElementDescriptor;
@@ -86,6 +88,7 @@ export type FormFieldReEditCustomData = {
 export type ScrollBackCustomData = {
   tag: 'csr:scrollBack';
   payload: {
+    eventId?: string;
     scrollBackPx: number;
     fromY: number;
     toY: number;
@@ -103,6 +106,7 @@ export type ElementDescriptor = {
 export type ClickCustomData = {
   tag: 'csr:click';
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -112,6 +116,7 @@ export type ClickCustomData = {
 export type InputCustomData = {
   tag: 'csr:input';
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -123,6 +128,7 @@ export type InputCustomData = {
 export type DeadClickCustomData = {
   tag: 'csr:deadClick';
   payload: {
+    eventId?: string;
     targetId: number;
     element?: ElementDescriptor;
     pathname?: string;
@@ -132,6 +138,7 @@ export type DeadClickCustomData = {
 export type TabUnfocusCustomData = {
   tag: 'csr:tabUnfocus';
   payload: {
+    eventId?: string;
     pathname?: string;
   };
 };
@@ -139,6 +146,7 @@ export type TabUnfocusCustomData = {
 export type TabRefocusCustomData = {
   tag: 'csr:tabRefocus';
   payload: {
+    eventId?: string;
     awayDurationMs: number;
     pathname?: string;
   };
@@ -154,7 +162,9 @@ export type RouteChangePayload = {
 
 export type RouteChangeCustomData = {
   tag: 'csr:routeChange';
-  payload: RouteChangePayload;
+  // Intersected rather than added to RouteChangePayload so the plugin-event
+  // shape (RouteChangePluginData) stays free of analyzer identity.
+  payload: RouteChangePayload & { eventId?: string };
 };
 
 /**
@@ -231,6 +241,7 @@ export type FlagEvaluationPluginData = {
 export type ErrorMessageCustomData = {
   tag: 'csr:errorMessage';
   payload: {
+    eventId?: string;
     text: string;
   };
 };
@@ -238,6 +249,7 @@ export type ErrorMessageCustomData = {
 export type DialogOpenedCustomData = {
   tag: 'csr:dialogOpened';
   payload: {
+    eventId?: string;
     content: string[];
   };
 };
@@ -245,6 +257,7 @@ export type DialogOpenedCustomData = {
 export type IdleGapCustomData = {
   tag: 'csr:idleGap';
   payload: {
+    eventId?: string;
     visibleGapS: number;
     totalGapS: number;
     hiddenS: number;
@@ -255,6 +268,7 @@ export type IdleGapCustomData = {
 export type AwayGapCustomData = {
   tag: 'csr:awayGap';
   payload: {
+    eventId?: string;
     totalGapS: number;
     hiddenS: number;
   };
@@ -263,6 +277,11 @@ export type AwayGapCustomData = {
 /**
  * Closed union of every Custom event we emit. Add a new variant here when
  * introducing a new tag — emitting an unregistered tag is a TS error.
+ *
+ * Every payload carries an optional `eventId`: a per-event identity stamped
+ * at emission by the analyzer (uuid). It is inert metadata — players ignore
+ * it — and exists so downstream review tooling can reference and remove
+ * individual generated events without patching untyped data.
  */
 export type CustomEventData =
   | ClickCustomData