@reportforge/playwright-pdf 0.2.2 → 0.4.0

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [0.3.1] — 2026-06-09
+
+### Security
+
+- **License gate hardened in `PdfGenerator`** — JWT verification is now enforced at the PDF generator boundary, not only in the reporter entry point. Real licenses require a valid Ed25519-signed JWT (verified against the bundled public key) with a non-expired `exp` claim checked directly from the JWT payload.
+- **`DEMO_LICENSE_INFO` no longer exported** — the demo fixture constant is now module-private; not accessible via deep import from the published package.
+- **Compile-time demo flag** — the demo CLI bypass (`reportforge-demo`) is gated on a tsup `define` constant (`__RF_IS_DEMO__`) baked into `dist/demo/cli.js` at build time. The main library (`dist/pdf/PdfGenerator.js`) has the flag set to `false` and cannot be bypassed by constructing a `LicenseInfo` with `source: 'demo'` at runtime.
+
+---
+
+## [0.3.0] — 2026-06-08
+
+### Added
+
+- **`reportforge-demo` instant demo report** — run `npx @reportforge/playwright-pdf reportforge-demo` to generate a realistic sample PDF in under 60 seconds with no license key required. Supports `--template=minimal|detailed|executive` and `--output=<path>`. Lets evaluators see the exact report ReportForge produces before subscribing.
+- **`reportforge-demo` bin wired in `package.json`** — available immediately after `npm install`; no global install required via `npx`.
+
+### Changed
+
+- `src/collector/stats-utils.ts` (new) — `statsFromTests` and `aggregateStats` extracted from `SuiteWalker` and `ShardMerger` to a shared utility; eliminates 3-way duplication.
+- GitHub Actions pinned to commit SHAs (supply-chain hardening).
+
+---
+
 ## [0.0.1] — 2026-05-26
 
 ### Changed

package/README.md

@@ -51,10 +51,13 @@ Three templates, one reporter. Every PDF is fully offline — fonts, charts, and
 - **Self-contained PDFs** — screenshots, fonts, logos all embedded; share or archive with confidence
 - **Custom branding** — logo, primary/accent colours, watermark, PDF password encryption
 - **Dynamic filenames** — `{date}`, `{branch}`, `{status}` tokens in the output path
+- **Instant demo report** — `npx @reportforge/playwright-pdf reportforge-demo` generates a realistic sample PDF before subscribing — no license key required
 - **CI/CD snippets** — GitHub Actions, GitLab CI, Bitbucket Pipelines, Jenkins, Azure DevOps
 - **Shard merging** — combine N Playwright JSON shard reports into one PDF via `shardResults`; accepts glob patterns or explicit paths
 - **Notifications** — post pass/fail summaries to Slack, Teams, Discord, or email after each run; configurable trigger (`always` / `failure` / `success`) per channel; email supports optional PDF attachment via `attachPdf`
 - **Flakiness trend** — top-N flakiest tests table with per-test dot sparkline across stored history runs in the `detailed` template; `flakinessTopN` option (default 5, `0` disables)
+- **Offline failure analysis** — classifies failures into 7 root-cause categories, clusters them, and renders a breakdown in the `detailed` PDF (one-liner in `executive`). No network, no AI service. The classifier model auto-updates offline over the existing license-refresh channel — each delivered model is Ed25519-signed and verified against the bundled public key, with the bundled model always the floor; set `failureAnalysis.autoUpdateModel: false` to pin the bundled model.
+- `reportforge-export-feedback` — exports locally-collected unrecognized failures (tokenized, local-only) for optional manual sharing.
 - **Hybrid licensing** — one short key unlocks it; reports keep rendering offline via a cached JWT between refreshes
 
 ---
@@ -88,6 +91,8 @@ npx playwright test
 # → reports/2026-05-01-main-failed.pdf
 ```
 
+> **See it first.** Run `npx @reportforge/playwright-pdf reportforge-demo` to generate a realistic sample PDF in under 60 seconds — no license key required. Supports `--template=minimal|detailed|executive` and `--output=<path>`.
+
 > **License required.** Start a **[7-day free trial at reportforge.org/pricing](https://reportforge.org/pricing)** — card required, no charge until day 8. Paste the resulting `RFSU-…` key into `RF_LICENSE_KEY`. Without a valid license the reporter logs a warning and skips PDF generation; your Playwright tests still run normally.
 
 ---
@@ -187,6 +192,7 @@ All options are the second element of the reporter tuple.
 | `maxFileSizeMb` | `number` | `8` | Soft cap on the final PDF size in MB. If exceeded, the report is re-rendered once with the `'max'` compression preset. |
 | `shardResults` | `string \| string[]` | — | Glob or path array of Playwright JSON shard report files to merge into one PDF. See the Shard Merging docs. |
 | `notify` | `object` | — | Notification channels: `slack`, `teams`, `discord` (each `{ url, enabled, on }`), `email` (`{ to, enabled, on, attachPdf }`). See the Notifications docs. |
+| `failureAnalysis` | `object` | `{ enabled: true }` | Offline failure root-cause analysis (embedded Naive Bayes; no runtime network). Fields: `enabled` (default `true`), `maxClusters` (default `10`), `minStrength` (`weak`\|`moderate`\|`strong`, default `weak`), `maxFailuresToAnalyse` (default `500`), `collectUnclassified` (default `true`), `autoUpdateModel` (default `true`). See the Failure Analysis docs. |
 | `historyFile` | `string` | `~/.reportforge/{key}/history.json` | Path to the history JSON file. Relative paths resolve from `cwd`. Enables pass-rate trending charts in the `detailed` template. |
 | `historySize` | `number` | `10` | Maximum number of test runs to keep in the history file (integer ≥ 2). Older runs are pruned on append. |
 | `showTrend` | `boolean` | `true` | Show the pass-rate sparkline and delta badge in the `detailed` template. Set to `false` to disable history tracking entirely. |

package/dist/cli/export-feedback.js

@@ -0,0 +1,87 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/cli/export-feedback.ts
+var export_feedback_exports = {};
+__export(export_feedback_exports, {
+  exportFeedback: () => exportFeedback
+});
+module.exports = __toCommonJS(export_feedback_exports);
+var import_node_fs = __toESM(require("fs"));
+var import_node_os = __toESM(require("os"));
+var import_node_path = __toESM(require("path"));
+
+// src/analysis/feedback-csv.ts
+var FEEDBACK_HEADER = "category,margin,text";
+function parseFeedbackRows(content) {
+  return content.trim().split("\n").slice(1).filter(Boolean).map((line) => {
+    const parts = line.split(",");
+    return { category: parts[0], margin: parts[1], text: parts.slice(2).join(","), raw: line };
+  });
+}
+
+// src/cli/export-feedback.ts
+function exportFeedback(deps = {}) {
+  const home = deps.home ?? import_node_os.default.homedir();
+  const cwd = deps.cwd ?? process.cwd();
+  const root = import_node_path.default.join(home, ".reportforge");
+  const rows = [];
+  if (import_node_fs.default.existsSync(root)) {
+    for (const entry of import_node_fs.default.readdirSync(root)) {
+      const file = import_node_path.default.join(root, entry, "unclassified.csv");
+      if (!import_node_fs.default.existsSync(file)) continue;
+      for (const r of parseFeedbackRows(import_node_fs.default.readFileSync(file, "utf8"))) {
+        rows.push(r.raw);
+      }
+    }
+  }
+  if (rows.length === 0) return { rowCount: 0, outFile: null };
+  const outFile = import_node_path.default.join(cwd, "reportforge-feedback.csv");
+  import_node_fs.default.writeFileSync(outFile, `${FEEDBACK_HEADER}
+${rows.join("\n")}
+`, "utf8");
+  return { rowCount: rows.length, outFile };
+}
+if (process.argv[1] && process.argv[1].endsWith("export-feedback.js")) {
+  const res = exportFeedback();
+  if (res.rowCount === 0) {
+    process.stdout.write("No locally collected failures found (~/.reportforge/*/unclassified.csv).\n");
+  } else {
+    process.stdout.write(
+      `Saved ${res.rowCount} row(s) to ${res.outFile} - tokenized + redacted, LOCAL only.
+Review it before sharing; there is no upload.
+`
+    );
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  exportFeedback
+});