@tracelane/report 0.1.0-alpha.19 → 0.1.0-alpha.20

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.
Files changed (2) hide show
  1. package/README.md +28 -2
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -2,7 +2,16 @@
2
2
 
3
3
  # @tracelane/report
4
4
 
5
- > The recorder for your WebdriverIO and Playwright tests Cypress on the roadmap. Self-contained HTML for every run — replay failures, audit successes, attach to any bug tracker. No SaaS, no dashboard, no signup.
5
+ > The HTML report builder behind tracelaneturns a captured rrweb event stream into a single, self-contained `.html` file that replays offline. No SaaS, no dashboard, no signup.
6
+
7
+ [![npm](https://img.shields.io/npm/v/@tracelane/report.svg)](https://www.npmjs.com/package/@tracelane/report)
8
+ [![downloads](https://img.shields.io/npm/dw/@tracelane/report.svg)](https://www.npmjs.com/package/@tracelane/report)
9
+ [![license](https://img.shields.io/npm/l/@tracelane/report.svg)](https://github.com/Cubenest/rrweb-stack/blob/main/LICENSE)
10
+ [![CI](https://github.com/Cubenest/rrweb-stack/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Cubenest/rrweb-stack/actions/workflows/ci.yml)
11
+ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Cubenest/rrweb-stack/badge)](https://scorecard.dev/viewer/?uri=github.com/Cubenest/rrweb-stack)
12
+ [![types](https://img.shields.io/npm/types/@tracelane/report.svg)](https://www.npmjs.com/package/@tracelane/report)
13
+ [![node](https://img.shields.io/node/v/@tracelane/report.svg)](https://www.npmjs.com/package/@tracelane/report)
14
+ ![status: alpha](https://img.shields.io/badge/status-alpha-orange.svg)
6
15
 
7
16
  The self-contained, offline HTML report builder for [`tracelane`](https://github.com/Cubenest/rrweb-stack). Given a captured rrweb event stream plus test metadata, it produces a **single `.html` file** that:
8
17
 
@@ -12,6 +21,14 @@ The self-contained, offline HTML report builder for [`tracelane`](https://github
12
21
  - renders console + network panels, a metadata header, and a "Copy as Markdown for AI paste" button.
13
22
 
14
23
  **Not generally intended for direct consumption** — depend on a product package (`@tracelane/wdio`) instead. See the [`@tracelane/wdio` README](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-wdio) for the integration guide.
24
+ ## Install
25
+
26
+ ```sh
27
+ npm install @tracelane/report
28
+ ```
29
+
30
+ - **ESM-only.** The package ships `"type": "module"` and a single `import` export — there is no CommonJS entry, so `require('@tracelane/report')` will not work. Use `import { buildReport } from '@tracelane/report'` (or a dynamic `import()` from CJS).
31
+ - **Node >= 22** is required (`engines.node`).
15
32
 
16
33
  ## Usage
17
34
 
@@ -40,4 +57,13 @@ const html = buildReport(events, {
40
57
 
41
58
  ## License
42
59
 
43
- Apache 2.0. The inlined rrweb player and fflate remain MIT-licensed; see NOTICE.
60
+ Apache 2.0. The inlined rrweb player and fflate remain MIT-licensed; see [NOTICE](https://github.com/Cubenest/rrweb-stack/blob/main/packages/tracelane-report/NOTICE).
61
+
62
+ ## Related packages
63
+
64
+ - [`@tracelane/cli`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-cli) — wires the recorder into your test runners (WebdriverIO and Playwright; Cypress on the roadmap).
65
+ - [`@tracelane/wdio`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-wdio) — the WebdriverIO integration that captures sessions and calls this builder on failure.
66
+ - [`@tracelane/playwright`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-playwright) — the Playwright integration.
67
+ - [`@tracelane/core`](https://github.com/Cubenest/rrweb-stack/tree/main/packages/tracelane-core) — the capture engine (rrweb event stream + `compress()`).
68
+
69
+ See the [CHANGELOG](https://github.com/Cubenest/rrweb-stack/blob/main/packages/tracelane-report/CHANGELOG.md) for release history.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tracelane/report",
3
- "version": "0.1.0-alpha.19",
3
+ "version": "0.1.0-alpha.20",
4
4
  "description": "Self-contained, offline HTML report builder for tracelane. Embeds the rrweb player and a gzipped event blob into a single .html file.",
5
5
  "keywords": [
6
6
  "tracelane",
@@ -34,12 +34,12 @@
34
34
  "@fontsource-variable/jetbrains-mono": "^5.2.7",
35
35
  "fflate": "^0.8.2",
36
36
  "rrweb-player": "1.0.0-alpha.4",
37
- "@cubenest/rrweb-core": "0.1.0-alpha.6",
38
- "@tracelane/core": "0.1.0-alpha.16"
37
+ "@cubenest/rrweb-core": "0.1.0-alpha.7",
38
+ "@tracelane/core": "0.1.0-alpha.17"
39
39
  },
40
40
  "devDependencies": {
41
41
  "jsdom": "^25.0.1",
42
- "@tracelane/security": "0.1.0-alpha.1"
42
+ "@tracelane/security": "0.1.0-alpha.2"
43
43
  },
44
44
  "publishConfig": {
45
45
  "access": "public",