@cubenest/rrweb-core 0.1.0-alpha.6 → 0.1.0-alpha.7
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/README.md +21 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
# @cubenest/rrweb-core
|
|
2
|
+
> The shared rrweb capture + masking engine behind tracelane and peek — vendored PostHog fork, PII masking, network/console capture, large-DOM throttling. Not a standalone product.
|
|
2
3
|
|
|
3
|
-
|
|
4
|
+
[](https://www.npmjs.com/package/@cubenest/rrweb-core)
|
|
5
|
+
[](https://www.npmjs.com/package/@cubenest/rrweb-core)
|
|
6
|
+
[](https://github.com/Cubenest/rrweb-stack/blob/main/LICENSE)
|
|
7
|
+
[](https://github.com/Cubenest/rrweb-stack/actions/workflows/ci.yml)
|
|
8
|
+
[](https://scorecard.dev/viewer/?uri=github.com/Cubenest/rrweb-stack)
|
|
9
|
+
[](https://www.npmjs.com/package/@cubenest/rrweb-core)
|
|
10
|
+
[](https://www.npmjs.com/package/@cubenest/rrweb-core)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
Shared rrweb-based capture substrate. Used by [`tracelane`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-core) and [`peek`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/peek-extension).
|
|
14
|
+
|
|
15
|
+
**Not intended for direct consumption** — depend on a product package instead. It exists to share the masking and capture primitives (PII masking selectors + regex bank, body/header redaction, network/console capture, large-DOM throttling) between the two product families so the privacy and recording behaviour stay identical.
|
|
4
16
|
|
|
5
17
|
## What's in here
|
|
6
18
|
|
|
@@ -13,12 +25,18 @@ Shared rrweb-based capture substrate. Used by [`tracelane`](https://github.com/C
|
|
|
13
25
|
- Console capture
|
|
14
26
|
- Compression helpers (`fflate`)
|
|
15
27
|
- IndexedDB persistence helper
|
|
16
|
-
- Compatibility matrix
|
|
28
|
+
- [Compatibility matrix](https://github.com/Cubenest/rrweb-stack/blob/main/packages/rrweb-core/COMPATIBILITY.md)
|
|
17
29
|
|
|
18
30
|
## Versioning
|
|
19
31
|
|
|
20
32
|
Independent semver. Breaking changes are coordinated across `tracelane` and `peek` releases.
|
|
33
|
+
## Related packages
|
|
34
|
+
|
|
35
|
+
The two product families that consume this substrate:
|
|
36
|
+
|
|
37
|
+
- **tracelane** — failed-test recorder for E2E suites. Start at [`@tracelane/wdio`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-wdio) (WebdriverIO) or [`@tracelane/playwright`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-playwright); engine is [`@tracelane/core`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-core).
|
|
38
|
+
- **peek** — browser companion for AI coding agents. Install via [`@peekdev/cli`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/peek-cli); the MCP server is [`@peekdev/mcp`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/peek-mcp) and the recorder is [`@peekdev/extension`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/peek-extension).
|
|
21
39
|
|
|
22
40
|
## License
|
|
23
41
|
|
|
24
|
-
Apache 2.0. Vendored rrweb fork remains MIT-licensed; see NOTICE.
|
|
42
|
+
Apache 2.0. Vendored rrweb fork remains MIT-licensed; see [NOTICE](https://github.com/Cubenest/rrweb-stack/blob/main/packages/rrweb-core/NOTICE).
|