@groundcover/browser 0.1.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +57 -0
- package/README.md +371 -193
- package/assets/logo.png +0 -0
- package/dist/index.d.mts +56 -31
- package/dist/index.d.ts +56 -31
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +25 -5
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to `@groundcover/browser` are documented here. This project adheres to
|
|
4
|
+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html) and the
|
|
5
|
+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
|
|
6
|
+
|
|
7
|
+
## [1.0.0]
|
|
8
|
+
|
|
9
|
+
First major release. This version restructures the configuration API by concern and finalizes the
|
|
10
|
+
privacy model. It contains **breaking changes** — see [Migrating to 1.0.0](./README.md#migrating-to-100).
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- **Breaking — `options` is restructured by concern.** Distributed-tracing, transport and replay
|
|
15
|
+
knobs now live in nested groups, `environment` is de-duplicated (top-level only), and
|
|
16
|
+
`userIdentifier` is renamed to `user`:
|
|
17
|
+
|
|
18
|
+
| `0.x` | `1.0.0` |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `userIdentifier` | `user` |
|
|
21
|
+
| `options.tracePropagationUrls` | `options.tracing.propagationUrls` |
|
|
22
|
+
| `options.tracePropagationHeaders` | `options.tracing.propagationHeaders` |
|
|
23
|
+
| `options.tracePropagationTraceIdHeaderName` | `options.tracing.traceIdHeaderName` |
|
|
24
|
+
| `options.tracePropagationSpanIdHeaderName` | `options.tracing.spanIdHeaderName` |
|
|
25
|
+
| `options.traceOrigin` | `options.tracing.origin` |
|
|
26
|
+
| `options.batchSize` / `options.batchTimeout` | `options.transport.batchSize` / `options.transport.batchTimeout` |
|
|
27
|
+
| `options.enableCompression` | `options.transport.compression` |
|
|
28
|
+
| `options.sessionReplay.blockedSelectors` | `options.replay.blockedSelectors` |
|
|
29
|
+
|
|
30
|
+
Flat options (`debug`, `sessionSampleRate`, `eventSampleRate`, `enabledEvents`, `excludedUrls`,
|
|
31
|
+
`sessionMaxDuration`, `beforeSend`, `enrichEvent`) and the `privacy` group are unchanged. Nested
|
|
32
|
+
groups merge one level deep on `updateConfig` — and `tracing.origin` / `privacy.replay` one level
|
|
33
|
+
deeper — so a partial update preserves sibling keys (e.g. updating `tracing.origin.name` keeps
|
|
34
|
+
`origin.value`).
|
|
35
|
+
|
|
36
|
+
### Removed
|
|
37
|
+
|
|
38
|
+
- **Breaking — removed the deprecated masking flags `options.enableMasking` and `options.maskFields`.**
|
|
39
|
+
Use `options.privacy` instead: `enableMasking: true` → `privacy.level: 'mask-all'`, explicit
|
|
40
|
+
`enableMasking: false` → `privacy.level: 'allow'`, and `maskFields` → `privacy.maskSelectors` /
|
|
41
|
+
`privacy.sensitiveKeys`. The removed flags are **ignored, not reinterpreted** — passing either one
|
|
42
|
+
now emits a `console.warn` pointing to this migration so the change isn't silent.
|
|
43
|
+
|
|
44
|
+
### Included since the previous release
|
|
45
|
+
|
|
46
|
+
These shipped ahead of 1.0.0 and are part of this major:
|
|
47
|
+
|
|
48
|
+
- **Privacy on by default.** Unified `options.privacy` config drives masking for both session replay
|
|
49
|
+
and non-replay events (DOM / network / logs / errors), defaulting to `mask-sensitive`. Sensitive
|
|
50
|
+
request/response headers, bodies, and URL query params are redacted; built-in auth headers are
|
|
51
|
+
always stripped. Opt out with `privacy.level: 'allow'`.
|
|
52
|
+
- **Web Worker offloading.** Session-replay packing and outgoing-batch gzip run in a dedicated inline
|
|
53
|
+
worker, with a transparent main-thread fallback under strict CSP / sandboxed iframes / SSR.
|
|
54
|
+
- **Configurable, lazily-enforced `sessionMaxDuration`** (default 4h, range 1 min–8h) plus 30-minute
|
|
55
|
+
inactivity-gap session rotation.
|
|
56
|
+
|
|
57
|
+
[1.0.0]: https://github.com/groundcover-com/rum/releases/tag/1.0.0
|