@reportforge/playwright-pdf 0.26.1 → 0.27.0

package/README.md

@@ -2,7 +2,7 @@
 
 > Playwright PDF reporter: generate branded PDF reports from [Playwright Test](https://playwright.dev/) results. Three templates (minimal, detailed, executive) for developers, QA teams, and stakeholders. CI-ready, self-contained, with embedded screenshots and charts.
 
-Drop it into any Playwright project and get a PDF report on every CI run. No changes to your tests.
+Drop it into any Playwright project and get a PDF report on every CI run. No changes to your tests. Testing with Python? The same reports ship as [`reportforge-playwright-pdf` on PyPI](https://pypi.org/project/reportforge-playwright-pdf/) for pytest-playwright, on the same license key (see [Python](#python)).
 
 [![npm](https://img.shields.io/npm/v/@reportforge/playwright-pdf.svg)](https://www.npmjs.com/package/@reportforge/playwright-pdf)
 [![Node](https://img.shields.io/node/v/@reportforge/playwright-pdf.svg)](https://nodejs.org/)
@@ -67,6 +67,7 @@ Three templates, one reporter. Every PDF is fully offline: fonts, charts, and sc
 - **Executive report brief band**: leads with a plain-language brief (trend + root causes) and one hero pass-rate number instead of a flat KPI grid
 - **Data protection**: AES-256 password-protected PDFs (no external tools) and opt-in redaction of credentials/PII in report content and live streams
 - **Hybrid licensing**: one short key unlocks it; reports keep rendering offline via a locally cached license between refreshes
+- **Python support**: the same reports for pytest-playwright via the `reportforge-playwright-pdf` PyPI package; one subscription key covers both ecosystems (live runs and step trees are Node.js-only today)
 - **Update notice**: when a newer reporter version is published, each run ends with one info line naming it and the update command; no extra network calls
 
 ---
@@ -157,6 +158,31 @@ reporter: [['@reportforge/playwright-pdf', {
 
 ---
 
+## Python
+
+The same reports for [pytest-playwright](https://playwright.dev/python/) runs, from the `reportforge-playwright-pdf` PyPI package. One subscription key covers Node.js and Python, and both count against the same machine allowance.
+
+```bash
+pip install reportforge-playwright-pdf
+python -m playwright install chromium
+
+export RF_LICENSE_KEY=RFSU-XXXX-XXXX-XXXX-XXXX
+pytest --pdf
+```
+
+Project defaults go in `pyproject.toml` with the same camelCase option names as this reporter:
+
+```toml
+[tool.reportforge]
+enabled = true
+template = "detailed"
+outputFile = "reports/{date}-{branch}-report.pdf"
+```
+
+The plugin reuses the Node runtime and Chromium that Playwright for Python already ships, so there is nothing else to install. pytest-xdist and pytest-rerunfailures are supported; failure screenshots from `--screenshot only-on-failure` are embedded. Live runs and step trees are Node.js-only today. Full guide: [reportforge.org/docs/python](https://reportforge.org/docs/python).
+
+---
+
 ## Pricing
 
 | Plan | INR | USD | Includes |
@@ -270,7 +296,9 @@ reporter: [
 
 The merge step can run against a dummy test file with zero tests: `shardResults` takes precedence over live results.
 
-> **Note:** Timed-out tests are counted as failures in shard mode (Playwright JSON stats do not distinguish `timedOut` from `failed`).
+Timed-out tests keep their own count in shard mode: the aggregate JSON stats fold them into failures, but the per-test result status carries `timedOut` and the report recovers it for the KPI cards and charts.
+
+The merger also honors two optional fields in the JSON report's `config` block when the emitting run provides them: `workers` (shown as the worker count in the environment panel, defaults to 1) and `metadata.playwrightVersion` (shown as the Playwright version when the merge runs where `@playwright/test` is not installed).
 
 ### Notifications
 
@@ -676,6 +704,7 @@ ReportForge ships a **hybrid offline-first** model:
 3. Every subsequent run is **fully offline**: the cached license is validated on-device. No network call.
 4. The reporter refreshes the cache automatically in the background before it expires.
 5. Each subscription allows up to **25 active machines**. Machines that haven't run in 30 days free up automatically.
+6. The key is **language-neutral**: the same subscription activates the Node.js reporter and the Python plugin, and a machine running both uses one slot.
 
 Cancel the subscription and the reporter keeps working until the end of the current billing period, then stops generating PDFs until you restart. **A license issue never aborts your test run**: the reporter logs a warning and skips PDF generation; your Playwright tests still pass.
 
@@ -736,6 +765,7 @@ Full guide: [reportforge.org/docs/troubleshooting](https://reportforge.org/docs/
 Full documentation at [reportforge.org/docs](https://reportforge.org/docs):
 
 - [Quick start](https://reportforge.org/docs/quickstart): install, configure, activate
+- [Python](https://reportforge.org/docs/python): the pytest-playwright plugin, same license key
 - [Chrome setup](https://reportforge.org/docs/running-tests#chrome-setup): Windows, Linux, macOS
 - [CI/CD integration](https://reportforge.org/docs/ci-cd): GitHub Actions, GitLab CI, Bitbucket Pipelines, Jenkins, Azure DevOps
 - [Configuration reference](https://reportforge.org/docs/configuration): all options

package/dist/cli/index.js

@@ -6952,13 +6952,25 @@ var init_engine = __esm({
 });
 
 // src/screenshots/ScreenshotEmbedder.ts
-var import_fs2, import_sharp, ScreenshotEmbedder;
+function loadSharp() {
+  if (sharpModule === void 0) {
+    try {
+      sharpModule = require("sharp");
+    } catch {
+      sharpModule = null;
+      logger.warn(
+        "sharp is not available \u2014 screenshots are embedded at original size. Reports with many screenshots may exceed maxFileSizeMb more often."
+      );
+    }
+  }
+  return sharpModule;
+}
+var import_fs2, sharpModule, ScreenshotEmbedder;
 var init_ScreenshotEmbedder = __esm({
   "src/screenshots/ScreenshotEmbedder.ts"() {
     "use strict";
     init_cjs_shims();
     import_fs2 = __toESM(require("fs"));
-    import_sharp = __toESM(require("sharp"));
     init_logger();
     ScreenshotEmbedder = class {
       async embedAll(failures, opts) {
@@ -6995,7 +7007,11 @@ var init_ScreenshotEmbedder = __esm({
         if (this.looksLikeSvg(buf)) {
           return { buffer: buf, mime: "image/svg+xml" };
         }
-        const img = (0, import_sharp.default)(buf, { failOn: "none" });
+        const sharp = loadSharp();
+        if (!sharp) {
+          return { buffer: buf, mime: this.detectMimeType(buf) };
+        }
+        const img = sharp(buf, { failOn: "none" });
         const meta = await img.metadata();
         const needsResize = (meta.width ?? 0) > opts.maxWidth;
         let pipeline = img.rotate();

package/dist/index.d.mts

@@ -432,43 +432,6 @@ interface ReporterOptions {
     sections?: SectionsOption;
 }
 
-/**
- * The resolved license for the current reporter run.
- *
- * The mere existence of a LicenseInfo means the subscription is active —
- * "no license" is represented by `LicenseClient.resolve()` returning null,
- * not by a sentinel plan or `valid: false` flag.
- *
- * `source` surfaces how the license was obtained so the reporter can log
- * actionable diagnostics:
- *   - 'jwt-online'  → freshly activated/refreshed against the server
- *   - 'jwt-cache'   → served from ~/.reportforge/license.json (offline)
- */
-interface LicenseInfo {
-    plan: LicensePlan;
-    source: 'jwt-online' | 'jwt-cache' | 'demo';
-    expiry: Date;
-    key: string;
-    /** Raw Ed25519-signed JWT from the server. Absent only in demo mode. */
-    jwt?: string;
-    machinesUsed?: number;
-    machineLimit?: number;
-    /**
-     * Entitlement flags carried on the signed JWT (`features` claim). Surfaces
-     * server-gated capabilities (e.g. `'live'`) to the reporter without a second
-     * network trip. Undefined for caches written by reporter versions before this
-     * field was persisted — treat absence as "no extra features".
-     */
-    features?: string[];
-    /**
-     * Latest published npm version of the reporter, as last reported by the
-     * license server (activate/refresh piggyback). Absent when the server
-     * could not reach the registry or the cache predates this field. Used
-     * only for the non-blocking run-end update notice.
-     */
-    latestVersion?: string;
-}
-
 /**
  * PdfReporter — Playwright custom reporter that generates professional PDF reports.
  *
@@ -526,9 +489,6 @@ declare class PdfReporter implements Reporter {
     onExit(): Promise<void>;
     onEnd(result: FullResult): Promise<void>;
     private _collectData;
-    private _appendTrend;
-    private _populateHistoryCharts;
-    private _buildReportData;
     printsToStdio(): boolean;
     /**
      * Memoized license resolution shared by the live stream (kicked early in
@@ -566,8 +526,43 @@ declare class PdfReporter implements Reporter {
      * posts one message, not N. The banner still prints from every shard's own log.
      */
     private announceLive;
-    private resolveProjectName;
-    private openPdf;
+}
+
+/**
+ * The resolved license for the current reporter run.
+ *
+ * The mere existence of a LicenseInfo means the subscription is active —
+ * "no license" is represented by `LicenseClient.resolve()` returning null,
+ * not by a sentinel plan or `valid: false` flag.
+ *
+ * `source` surfaces how the license was obtained so the reporter can log
+ * actionable diagnostics:
+ *   - 'jwt-online'  → freshly activated/refreshed against the server
+ *   - 'jwt-cache'   → served from ~/.reportforge/license.json (offline)
+ */
+interface LicenseInfo {
+    plan: LicensePlan;
+    source: 'jwt-online' | 'jwt-cache' | 'demo';
+    expiry: Date;
+    key: string;
+    /** Raw Ed25519-signed JWT from the server. Absent only in demo mode. */
+    jwt?: string;
+    machinesUsed?: number;
+    machineLimit?: number;
+    /**
+     * Entitlement flags carried on the signed JWT (`features` claim). Surfaces
+     * server-gated capabilities (e.g. `'live'`) to the reporter without a second
+     * network trip. Undefined for caches written by reporter versions before this
+     * field was persisted — treat absence as "no extra features".
+     */
+    features?: string[];
+    /**
+     * Latest published npm version of the reporter, as last reported by the
+     * license server (activate/refresh piggyback). Absent when the server
+     * could not reach the registry or the cache predates this field. Used
+     * only for the non-blocking run-end update notice.
+     */
+    latestVersion?: string;
 }
 
 /**

package/dist/index.d.ts

@@ -432,43 +432,6 @@ interface ReporterOptions {
     sections?: SectionsOption;
 }
 
-/**
- * The resolved license for the current reporter run.
- *
- * The mere existence of a LicenseInfo means the subscription is active —
- * "no license" is represented by `LicenseClient.resolve()` returning null,
- * not by a sentinel plan or `valid: false` flag.
- *
- * `source` surfaces how the license was obtained so the reporter can log
- * actionable diagnostics:
- *   - 'jwt-online'  → freshly activated/refreshed against the server
- *   - 'jwt-cache'   → served from ~/.reportforge/license.json (offline)
- */
-interface LicenseInfo {
-    plan: LicensePlan;
-    source: 'jwt-online' | 'jwt-cache' | 'demo';
-    expiry: Date;
-    key: string;
-    /** Raw Ed25519-signed JWT from the server. Absent only in demo mode. */
-    jwt?: string;
-    machinesUsed?: number;
-    machineLimit?: number;
-    /**
-     * Entitlement flags carried on the signed JWT (`features` claim). Surfaces
-     * server-gated capabilities (e.g. `'live'`) to the reporter without a second
-     * network trip. Undefined for caches written by reporter versions before this
-     * field was persisted — treat absence as "no extra features".
-     */
-    features?: string[];
-    /**
-     * Latest published npm version of the reporter, as last reported by the
-     * license server (activate/refresh piggyback). Absent when the server
-     * could not reach the registry or the cache predates this field. Used
-     * only for the non-blocking run-end update notice.
-     */
-    latestVersion?: string;
-}
-
 /**
  * PdfReporter — Playwright custom reporter that generates professional PDF reports.
  *
@@ -526,9 +489,6 @@ declare class PdfReporter implements Reporter {
     onExit(): Promise<void>;
     onEnd(result: FullResult): Promise<void>;
     private _collectData;
-    private _appendTrend;
-    private _populateHistoryCharts;
-    private _buildReportData;
     printsToStdio(): boolean;
     /**
      * Memoized license resolution shared by the live stream (kicked early in
@@ -566,8 +526,43 @@ declare class PdfReporter implements Reporter {
      * posts one message, not N. The banner still prints from every shard's own log.
      */
     private announceLive;
-    private resolveProjectName;
-    private openPdf;
+}
+
+/**
+ * The resolved license for the current reporter run.
+ *
+ * The mere existence of a LicenseInfo means the subscription is active —
+ * "no license" is represented by `LicenseClient.resolve()` returning null,
+ * not by a sentinel plan or `valid: false` flag.
+ *
+ * `source` surfaces how the license was obtained so the reporter can log
+ * actionable diagnostics:
+ *   - 'jwt-online'  → freshly activated/refreshed against the server
+ *   - 'jwt-cache'   → served from ~/.reportforge/license.json (offline)
+ */
+interface LicenseInfo {
+    plan: LicensePlan;
+    source: 'jwt-online' | 'jwt-cache' | 'demo';
+    expiry: Date;
+    key: string;
+    /** Raw Ed25519-signed JWT from the server. Absent only in demo mode. */
+    jwt?: string;
+    machinesUsed?: number;
+    machineLimit?: number;
+    /**
+     * Entitlement flags carried on the signed JWT (`features` claim). Surfaces
+     * server-gated capabilities (e.g. `'live'`) to the reporter without a second
+     * network trip. Undefined for caches written by reporter versions before this
+     * field was persisted — treat absence as "no extra features".
+     */
+    features?: string[];
+    /**
+     * Latest published npm version of the reporter, as last reported by the
+     * license server (activate/refresh piggyback). Absent when the server
+     * could not reach the registry or the cache predates this field. Used
+     * only for the non-blocking run-end update notice.
+     */
+    latestVersion?: string;
 }
 
 /**