@reportforge/playwright-pdf 0.22.0 → 0.23.0

package/dist/index.d.mts

@@ -73,8 +73,10 @@ interface ReporterOptions {
      */
     watermark?: string;
     /**
-     * Password to protect the generated PDF (Enterprise tier).
-     * Requires qpdf to be installed on the system.
+     * Password to protect the generated PDF (AES-256). Applied in-process — no
+     * external tools required. Also encrypts the failure-overflow sidecar JSON
+     * when one is written. Recommended: source from an env var rather than
+     * committing it — `pdfPassword: process.env.RF_PDF_PASSWORD`.
      */
     pdfPassword?: string;
     /**
@@ -202,7 +204,7 @@ interface ReporterOptions {
     };
     /**
      * Offline failure root-cause analysis. Classifies failures into categories
-     * using an embedded Naive Bayes model and renders a clustered breakdown in
+     * using an embedded classifier model and renders a clustered breakdown in
      * the `detailed` PDF (one-liner in `executive`). No network calls at runtime.
      * Optionally personalizes on YOUR machine: label collected failures
      * (`label-feedback`), then `train-model` trains + evaluates a local layer that
@@ -230,9 +232,9 @@ interface ReporterOptions {
          */
         collectScope?: 'blind-spots' | 'all';
         /**
-         * Auto-update the BASE classifier model from the signed license-refresh channel
-         * (offline-tolerant; the bundled model is always the floor; the delivered model
-         * is Ed25519-verified). Set false to pin the bundled model for reproducibility.
+         * Auto-update the BASE classifier model (offline-tolerant; the bundled
+         * model is always the floor; delivered models are signature-verified).
+         * Set false to pin the bundled model for reproducibility.
          * Default: true
          */
         autoUpdateModel?: boolean;
@@ -279,6 +281,24 @@ interface ReporterOptions {
         /** Max console lines retained per stream. Default: 50 */
         maxConsoleLines?: number;
     };
+    /**
+     * Opt-in redaction of likely-sensitive values (credentials, tokens, emails)
+     * in report content — error messages, stacks, step titles, console output,
+     * test titles — and in the live watch stream. Off by default.
+     *
+     * @example
+     * redact: { enabled: true, patterns: ['MYCO_[A-Z0-9]+'] }
+     */
+    redact?: {
+        /** Enable redaction. Default: false */
+        enabled?: boolean;
+        /** Apply the built-in credential/PII patterns. Default: true */
+        builtins?: boolean;
+        /** Additional regexes (compiled with the `g` flag); matches are fully masked. Default: [] */
+        patterns?: string[];
+        /** Replacement text for masked values. Default: '[REDACTED]' */
+        mask?: string;
+    };
     /**
      * Live test-execution streaming (opt-in, off by default). When enabled the
      * reporter mints an unguessable watch link, prints it to the CI logs at run
@@ -335,10 +355,10 @@ interface ReporterOptions {
     /**
      * Store the pass-rate trend on the ReportForge server so it survives
      * ephemeral CI runners (where the local history file is wiped every run).
-     * One request per run over the existing license connection, carrying
-     * AGGREGATE NUMBERS ONLY — pass rate, counts, duration, verdict. No test
-     * titles, no error text; even the branch name is sent as a hash. Falls back
-     * to the local history file on any failure.
+     * One small authenticated request per run, carrying AGGREGATE NUMBERS ONLY —
+     * pass rate, counts, duration, verdict. No test titles, no error text; even
+     * the branch name never travels in plaintext. Falls back to the local
+     * history file on any failure.
      * @default false
      */
     remoteHistory?: boolean;
@@ -483,6 +503,7 @@ declare class PdfReporter implements Reporter {
     private readonly licenseClient;
     private readonly dataCollector;
     private readonly pdfGenerator;
+    private readonly redactor?;
     private licensePromise?;
     private liveStreamer?;
     private liveShardKey;

package/dist/index.d.ts

@@ -73,8 +73,10 @@ interface ReporterOptions {
      */
     watermark?: string;
     /**
-     * Password to protect the generated PDF (Enterprise tier).
-     * Requires qpdf to be installed on the system.
+     * Password to protect the generated PDF (AES-256). Applied in-process — no
+     * external tools required. Also encrypts the failure-overflow sidecar JSON
+     * when one is written. Recommended: source from an env var rather than
+     * committing it — `pdfPassword: process.env.RF_PDF_PASSWORD`.
      */
     pdfPassword?: string;
     /**
@@ -202,7 +204,7 @@ interface ReporterOptions {
     };
     /**
      * Offline failure root-cause analysis. Classifies failures into categories
-     * using an embedded Naive Bayes model and renders a clustered breakdown in
+     * using an embedded classifier model and renders a clustered breakdown in
      * the `detailed` PDF (one-liner in `executive`). No network calls at runtime.
      * Optionally personalizes on YOUR machine: label collected failures
      * (`label-feedback`), then `train-model` trains + evaluates a local layer that
@@ -230,9 +232,9 @@ interface ReporterOptions {
          */
         collectScope?: 'blind-spots' | 'all';
         /**
-         * Auto-update the BASE classifier model from the signed license-refresh channel
-         * (offline-tolerant; the bundled model is always the floor; the delivered model
-         * is Ed25519-verified). Set false to pin the bundled model for reproducibility.
+         * Auto-update the BASE classifier model (offline-tolerant; the bundled
+         * model is always the floor; delivered models are signature-verified).
+         * Set false to pin the bundled model for reproducibility.
          * Default: true
          */
         autoUpdateModel?: boolean;
@@ -279,6 +281,24 @@ interface ReporterOptions {
         /** Max console lines retained per stream. Default: 50 */
         maxConsoleLines?: number;
     };
+    /**
+     * Opt-in redaction of likely-sensitive values (credentials, tokens, emails)
+     * in report content — error messages, stacks, step titles, console output,
+     * test titles — and in the live watch stream. Off by default.
+     *
+     * @example
+     * redact: { enabled: true, patterns: ['MYCO_[A-Z0-9]+'] }
+     */
+    redact?: {
+        /** Enable redaction. Default: false */
+        enabled?: boolean;
+        /** Apply the built-in credential/PII patterns. Default: true */
+        builtins?: boolean;
+        /** Additional regexes (compiled with the `g` flag); matches are fully masked. Default: [] */
+        patterns?: string[];
+        /** Replacement text for masked values. Default: '[REDACTED]' */
+        mask?: string;
+    };
     /**
      * Live test-execution streaming (opt-in, off by default). When enabled the
      * reporter mints an unguessable watch link, prints it to the CI logs at run
@@ -335,10 +355,10 @@ interface ReporterOptions {
     /**
      * Store the pass-rate trend on the ReportForge server so it survives
      * ephemeral CI runners (where the local history file is wiped every run).
-     * One request per run over the existing license connection, carrying
-     * AGGREGATE NUMBERS ONLY — pass rate, counts, duration, verdict. No test
-     * titles, no error text; even the branch name is sent as a hash. Falls back
-     * to the local history file on any failure.
+     * One small authenticated request per run, carrying AGGREGATE NUMBERS ONLY —
+     * pass rate, counts, duration, verdict. No test titles, no error text; even
+     * the branch name never travels in plaintext. Falls back to the local
+     * history file on any failure.
      * @default false
      */
     remoteHistory?: boolean;
@@ -483,6 +503,7 @@ declare class PdfReporter implements Reporter {
     private readonly licenseClient;
     private readonly dataCollector;
     private readonly pdfGenerator;
+    private readonly redactor?;
     private licensePromise?;
     private liveStreamer?;
     private liveShardKey;