@groundcover/browser 0.1.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,66 @@
+# Changelog
+
+All notable changes to `@groundcover/browser` are documented here. This project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html) and the
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
+
+## [1.0.1]
+
+### Fixed
+
+- **README images now render on npm.** The logo used a relative path and the CI badge pointed at the
+  internal GitHub repo, so both 404'd on the npm package page. The logo is now served from the
+  published package via jsDelivr and the CI-status badge was removed.
+
+## [1.0.0]
+
+First major release. This version restructures the configuration API by concern and finalizes the
+privacy model. It contains **breaking changes** — see [Migrating to 1.0.0](./README.md#migrating-to-100).
+
+### Changed
+
+- **Breaking — `options` is restructured by concern.** Distributed-tracing, transport and replay
+  knobs now live in nested groups, `environment` is de-duplicated (top-level only), and
+  `userIdentifier` is renamed to `user`:
+
+  | `0.x` | `1.0.0` |
+  |---|---|
+  | `userIdentifier` | `user` |
+  | `options.tracePropagationUrls` | `options.tracing.propagationUrls` |
+  | `options.tracePropagationHeaders` | `options.tracing.propagationHeaders` |
+  | `options.tracePropagationTraceIdHeaderName` | `options.tracing.traceIdHeaderName` |
+  | `options.tracePropagationSpanIdHeaderName` | `options.tracing.spanIdHeaderName` |
+  | `options.traceOrigin` | `options.tracing.origin` |
+  | `options.batchSize` / `options.batchTimeout` | `options.transport.batchSize` / `options.transport.batchTimeout` |
+  | `options.enableCompression` | `options.transport.compression` |
+  | `options.sessionReplay.blockedSelectors` | `options.replay.blockedSelectors` |
+
+  Flat options (`debug`, `sessionSampleRate`, `eventSampleRate`, `enabledEvents`, `excludedUrls`,
+  `sessionMaxDuration`, `beforeSend`, `enrichEvent`) and the `privacy` group are unchanged. Nested
+  groups merge one level deep on `updateConfig` — and `tracing.origin` / `privacy.replay` one level
+  deeper — so a partial update preserves sibling keys (e.g. updating `tracing.origin.name` keeps
+  `origin.value`).
+
+### Removed
+
+- **Breaking — removed the deprecated masking flags `options.enableMasking` and `options.maskFields`.**
+  Use `options.privacy` instead: `enableMasking: true` → `privacy.level: 'mask-all'`, explicit
+  `enableMasking: false` → `privacy.level: 'allow'`, and `maskFields` → `privacy.maskSelectors` /
+  `privacy.sensitiveKeys`. The removed flags are **ignored, not reinterpreted** — passing either one
+  now emits a `console.warn` pointing to this migration so the change isn't silent.
+
+### Included since the previous release
+
+These shipped ahead of 1.0.0 and are part of this major:
+
+- **Privacy on by default.** Unified `options.privacy` config drives masking for both session replay
+  and non-replay events (DOM / network / logs / errors), defaulting to `mask-sensitive`. Sensitive
+  request/response headers, bodies, and URL query params are redacted; built-in auth headers are
+  always stripped. Opt out with `privacy.level: 'allow'`.
+- **Web Worker offloading.** Session-replay packing and outgoing-batch gzip run in a dedicated inline
+  worker, with a transparent main-thread fallback under strict CSP / sandboxed iframes / SSR.
+- **Configurable, lazily-enforced `sessionMaxDuration`** (default 4h, range 1 min–8h) plus 30-minute
+  inactivity-gap session rotation.
+
+[1.0.1]: https://github.com/groundcover-com/rum/releases/tag/1.0.1
+[1.0.0]: https://github.com/groundcover-com/rum/releases/tag/1.0.0