@spotify-confidence/csr-recorder 0.0.0 → 0.17.3

package/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+## [0.17.3](https://github.com/spotify/confidence-sdk-js/compare/csr-recorder-v0.17.2...csr-recorder-v0.17.3) (2026-06-16)
+
+
+### ✨ New Features
+
+* add route parameterization for route change and meta events ([#370](https://github.com/spotify/confidence-sdk-js/issues/370)) ([6efbee0](https://github.com/spotify/confidence-sdk-js/commit/6efbee08776c88b05dfa0949844f6c330bb0bcaa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @spotify-confidence/csr-common bumped to 0.17.3
+
+## [0.17.2](https://github.com/spotify/confidence-sdk-js/compare/csr-recorder-v0.17.1...csr-recorder-v0.17.2) (2026-06-15)
+
+
+### 🐛 Bug Fixes
+
+* improve csr package READMEs ([#367](https://github.com/spotify/confidence-sdk-js/issues/367)) ([3c5a254](https://github.com/spotify/confidence-sdk-js/commit/3c5a254b6b7bd23142ffe7ce6d99f327e67ff478))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @spotify-confidence/csr-common bumped to 0.17.2
+
+## [0.17.1](https://github.com/spotify/confidence-sdk-js/compare/csr-recorder-v0.17.0...csr-recorder-v0.17.1) (2026-06-15)
+
+
+### 🐛 Bug Fixes
+
+* add csr packages to release-please ([#363](https://github.com/spotify/confidence-sdk-js/issues/363)) ([f868e03](https://github.com/spotify/confidence-sdk-js/commit/f868e036ee27fcdd26ee26c8a47d2466a47e2a60))
+
+
+### ✨ New Features
+
+* add session recording packages ([#360](https://github.com/spotify/confidence-sdk-js/issues/360)) ([4584f50](https://github.com/spotify/confidence-sdk-js/commit/4584f502f17d01a15390789519c99308797a513d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @spotify-confidence/csr-common bumped to 0.17.1

package/README.md

@@ -0,0 +1,64 @@
+# @spotify-confidence/csr-recorder
+
+![](https://img.shields.io/badge/lifecycle-beta-a0c3d2.svg)
+
+Low-level browser recording engine that captures DOM events using [rrweb](https://github.com/rrweb-io/rrweb). This package is used internally by `@spotify-confidence/session-recording` — most consumers should use that SDK directly.
+
+## Usage
+
+```typescript
+import { record } from '@spotify-confidence/csr-recorder';
+
+const stop = record(
+  event => {
+    // handle each recording event
+  },
+  {
+    maskSelectors: ['.sensitive'],
+    blockSelectors: ['video'],
+    maskInputs: true,
+    captureConsoleLogs: true,
+    captureNetworkRequests: false,
+    captureRouteChanges: true,
+  },
+);
+
+// Later:
+stop();
+```
+
+## Route parameterization
+
+Routes containing dynamic segments (such as IDs in the URL) are automatically normalized into patterns — for example, `/users/123/profile` becomes `/users/:id/profile`. This ensures that per-page metrics are grouped by route rather than by individual page visit, keeping dashboards meaningful and query performance fast.
+
+Default replacements:
+
+| Pattern                | Example                                | Replacement |
+| ---------------------- | -------------------------------------- | ----------- |
+| UUID                   | `550e8400-e29b-41d4-a716-446655440000` | `:uuid`     |
+| Numeric ID             | `123`                                  | `:id`       |
+| AIP-122 ID             | `cmvkznnjmbkc9rw2oxws`                 | `:id`       |
+| Hex string (20+ chars) | `507f1f77bcf86cd799439011`             | `:id`       |
+
+If your app uses URL patterns that aren't automatically detected, you can provide a custom `parameterizeRoute` function to control how routes are grouped:
+
+```typescript
+import { record, defaultParameterizeRoute } from '@spotify-confidence/csr-recorder';
+
+const stop = record(event => {}, {
+  parameterizeRoute: route => {
+    // Apply defaults first, then handle your own patterns
+    return defaultParameterizeRoute(route).replace(/\/teams\/[^/]+/, '/teams/:slug');
+  },
+});
+```
+
+The same parameterization is also applied to the `href` in rrweb Meta events.
+
+## rrweb version
+
+This package pins `rrweb@^2.0.0-alpha.20`. The rrweb 2.x line is in alpha but is the version we've validated against. The recording engine is bundled — consumers do not need rrweb as a peer dependency.
+
+## License
+
+Apache 2.0 — see [LICENSE](../../LICENSE).