@piwitests/reporter 0.35.0 → 0.38.0

package/dist/index.d.ts

@@ -48,6 +48,17 @@ interface PiwiDashboardOptions {
      * also be forced off with `PIWI_CAPTURE_PAGE_STATE=false`.
      */
     capturePageState?: boolean;
+    /**
+     * Capture a lightweight inventory of each visited page on *passing* runs — the
+     * interactive controls (role + accessible name) and links (name, with the query
+     * and hash stripped from the href) present as the test navigates — so the
+     * dashboard can tell which controls and links the suite exposes but never
+     * exercises. Only names and hrefs are captured, never field values; a page's
+     * controls are read at most once per worker per run. **Defaults to `false`** —
+     * opt in with `capturePageInventory: true` (or `PIWI_CAPTURE_PAGE_INVENTORY=true`).
+     * Automatically disabled when `collectPerformanceMetrics` is `false`.
+     */
+    capturePageInventory?: boolean;
     /**
      * Capture server-side spans for each API/document request the test makes,
      * read from the `X-Piwi-Trace` response header emitted by a Piwi
@@ -68,6 +79,15 @@ interface PiwiDashboardOptions {
      * Set to `false` (or `PIWI_SAMPLE_ARIA_ON_PASS=false`) to never sample on pass.
      */
     sampleAriaOnPass?: boolean;
+    /**
+     * Upload the application's declared surface at run start: a committed
+     * `piwi.manifest.json` next to the Playwright config, and — when the base URL's
+     * first response carries an instrumentation header — the instrumentation
+     * package's `/__piwi/manifest`. A route or page the manifest declares that no
+     * test reaches becomes a "declared, never hit" gap. Defaults to `true`; set to
+     * `false` (or `PIWI_UPLOAD_MANIFEST=false`) to never upload.
+     */
+    uploadManifest?: boolean;
     /**
      * When installed via `wrapConfig`, default Playwright's own `screenshot` and
      * `trace` options on the top-level `use` block so a failing test keeps a
@@ -153,6 +173,12 @@ interface PiwiDashboardOptions {
     environment?: string;
     /** Optional display label for the test run (e.g. "v2.3.1 release") */
     label?: string;
+    /**
+     * Keep this run forever: the dashboard's retention never deletes it. Set it
+     * for the runs worth keeping, such as release or tag builds. Can also be set
+     * with `PIWI_KEEP=true`.
+     */
+    keep?: boolean;
     /** Related issue reference, e.g. `"JIRA-123"` */
     relatedIssue?: string;
     /** CI job information */
@@ -332,12 +358,15 @@ declare class PiwiDashboardReporter {
     onTestBegin(test: TestCase, result: TestResult): void;
     /** Track suite-level setup steps (beforeAll/afterAll) not tied to any test */
     private setupSteps;
+    /** Step categories streamed live while the run executes. */
+    private static readonly LIVE_STEP_CATEGORIES;
     /**
-     * Step categories streamed live while the run executes. `pw:assert` is
-     * excluded: it is the polling noise of `expect()`, not a step a human
-     * watches; the meaningful readout is the `pw:expect` wrapper around it.
+     * Whether a step streams live: its category is in `LIVE_STEP_CATEGORIES`
+     * and no ancestor is an `expect` step. The steps inside an assertion are its
+     * polling — every `expect.poll` attempt and `toPass` retry — not a step a
+     * human watches; the meaningful readout is the assertion around them.
      */
-    private static readonly LIVE_STEP_CATEGORIES;
+    private static isLiveStep;
     /** Playwright reporter hook: called when a step (including hook/fixture) begins */
     onStepBegin(test: TestCase | undefined, _result: TestResult | undefined, step: any): void;
     /** Playwright reporter hook: called when a step (including hook/fixture) ends */