@piwitests/reporter 0.11.0 → 0.13.0

package/dist/internal/capture/attachments.d.ts

@@ -5,15 +5,21 @@
  * the dogfooding `application/tests/fixtures.ts`, so producer and consumer can
  * never drift on a name.
  */
-export declare const ATTACHMENT_NAMES: {
+declare const ATTACHMENT_NAMES: {
     readonly locators: "piwi-locators";
     readonly ariaSnapshot: "piwi-aria-snapshot";
     readonly console: "piwi-console";
     readonly network: "piwi-network";
     readonly webVitals: "piwi-web-vitals";
     readonly locatorSuggestion: "piwi-locator-suggestion";
+    readonly pageState: "piwi-page-state";
+    readonly userPick: "piwi-user-pick";
 };
 /** Set of every internal attachment name — used to skip them when collecting user attachments. */
-export declare const INTERNAL_ATTACHMENT_NAMES: ReadonlySet<string>;
+declare const INTERNAL_ATTACHMENT_NAMES: ReadonlySet<string>;
 /** Annotation type that surfaces a locator-healing suggestion in the report/trace. */
-export declare const LOCATOR_SUGGESTION_ANNOTATION: "piwi-locator-suggestion";
+declare const LOCATOR_SUGGESTION_ANNOTATION: "piwi-locator-suggestion";
+/** Annotation type that surfaces a human-confirmed replacement locator in the report/trace. */
+declare const USER_PICK_ANNOTATION: "piwi-user-pick";
+
+export { ATTACHMENT_NAMES, INTERNAL_ATTACHMENT_NAMES, LOCATOR_SUGGESTION_ANNOTATION, USER_PICK_ANNOTATION };

package/dist/internal/capture/attachments.js

@@ -1,22 +1,48 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOCATOR_SUGGESTION_ANNOTATION = exports.INTERNAL_ATTACHMENT_NAMES = exports.ATTACHMENT_NAMES = void 0;
-/**
- * Names of the `testInfo` attachments the dashboard fixtures produce and the
- * reporter parses. Single source of truth — imported by the producer
- * (`capture-fixtures.ts`), the consumers (`reporter.ts` / `file-handler.ts`), and
- * the dogfooding `application/tests/fixtures.ts`, so producer and consumer can
- * never drift on a name.
- */
-exports.ATTACHMENT_NAMES = {
-    locators: 'piwi-locators',
-    ariaSnapshot: 'piwi-aria-snapshot',
-    console: 'piwi-console',
-    network: 'piwi-network',
-    webVitals: 'piwi-web-vitals',
-    locatorSuggestion: 'piwi-locator-suggestion',
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
 };
-/** Set of every internal attachment name — used to skip them when collecting user attachments. */
-exports.INTERNAL_ATTACHMENT_NAMES = new Set(Object.values(exports.ATTACHMENT_NAMES));
-/** Annotation type that surfaces a locator-healing suggestion in the report/trace. */
-exports.LOCATOR_SUGGESTION_ANNOTATION = exports.ATTACHMENT_NAMES.locatorSuggestion;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/internal/capture/attachments.ts
+var attachments_exports = {};
+__export(attachments_exports, {
+  ATTACHMENT_NAMES: () => ATTACHMENT_NAMES,
+  INTERNAL_ATTACHMENT_NAMES: () => INTERNAL_ATTACHMENT_NAMES,
+  LOCATOR_SUGGESTION_ANNOTATION: () => LOCATOR_SUGGESTION_ANNOTATION,
+  USER_PICK_ANNOTATION: () => USER_PICK_ANNOTATION
+});
+module.exports = __toCommonJS(attachments_exports);
+var ATTACHMENT_NAMES = {
+  locators: "piwi-locators",
+  ariaSnapshot: "piwi-aria-snapshot",
+  console: "piwi-console",
+  network: "piwi-network",
+  webVitals: "piwi-web-vitals",
+  locatorSuggestion: "piwi-locator-suggestion",
+  pageState: "piwi-page-state",
+  userPick: "piwi-user-pick"
+};
+var INTERNAL_ATTACHMENT_NAMES = new Set(Object.values(ATTACHMENT_NAMES));
+var LOCATOR_SUGGESTION_ANNOTATION = ATTACHMENT_NAMES.locatorSuggestion;
+var USER_PICK_ANNOTATION = ATTACHMENT_NAMES.userPick;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ATTACHMENT_NAMES,
+  INTERNAL_ATTACHMENT_NAMES,
+  LOCATOR_SUGGESTION_ANNOTATION,
+  USER_PICK_ANNOTATION
+});

package/dist/internal/capture/capture-fixtures.d.ts

@@ -1,4 +1,5 @@
-import type { Fixtures, Locator, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from '@playwright/test';
+import { TestType, Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, Locator } from '@playwright/test';
+
 type FixtureArgs = {
     [key: string]: any;
 };
@@ -20,7 +21,108 @@ interface CapturedAttrs {
         name?: number;
         classes?: Record<string, number>;
     };
+    /** Position among same-role elements, document-wide (null when the element has no role). */
+    rolePosition: {
+        role: string;
+        count: number;
+        index: number;
+        levelCount?: number;
+    } | null;
+    /** Anchor-worthy ancestors, nearest first (empty when none found or probing failed). */
+    ancestors: Array<{
+        tag: string;
+        depth: number;
+        testId: string | null;
+        id: string | null;
+        role: string | null;
+        ariaLabel: string | null;
+        scopedRoleCount?: number;
+        testIdCount?: number;
+        idCount?: number;
+        roleCount?: number;
+    }>;
 }
+/** Plain-object projection of a performance entry, shipped out of the page. */
+interface RawVitalEntry {
+    startTime?: number;
+    value?: number;
+    hadRecentInput?: boolean;
+    interactionId?: number;
+    duration?: number;
+}
+/**
+ * Aggregate buffered performance entries into LCP/CLS/INP. Pure and Node-side
+ * so it is unit-testable; the in-page evaluate only ships raw entry projections.
+ * A null entry list means the entry type is unsupported (non-Chromium) — the
+ * metric is null rather than 0 so absence is distinguishable from "no shifts".
+ */
+declare function computeCoreVitals(lcpEntries: RawVitalEntry[] | null, shiftEntries: RawVitalEntry[] | null, eventEntries: RawVitalEntry[] | null): {
+    lcp: number | null;
+    cls: number | null;
+    inp: number | null;
+} | null;
+/** Page state captured at test end. Storage values and cookie values are NEVER included. */
+interface PageState {
+    url: string;
+    hash: string | null;
+    /** `history.state` as JSON, capped and token-masked. */
+    historyState: string | null;
+    /** Key names + value lengths only. */
+    localStorage: Array<{
+        key: string;
+        length: number;
+    }>;
+    sessionStorage: Array<{
+        key: string;
+        length: number;
+    }>;
+    /** Cookie names + flags only (values are never read). */
+    cookies: Array<{
+        name: string;
+        domain: string;
+        path: string;
+        httpOnly: boolean;
+        secure: boolean;
+        sameSite?: string;
+        expires?: number;
+    }>;
+}
+/** Raw in-page reads shipped out of the evaluate (see `readPageState`). */
+interface RawPageState {
+    url: string;
+    hash: string | null;
+    historyState: string | null;
+    localStorage: Array<{
+        key: string;
+        length: number;
+    }>;
+    sessionStorage: Array<{
+        key: string;
+        length: number;
+    }>;
+}
+/**
+ * Assemble the wire page-state from the in-page reads and the context cookies.
+ * Pure and Node-side so the sanitization (token masking, caps, value-free
+ * cookies) is unit-testable.
+ */
+declare function buildPageState(raw: RawPageState, cookies: Array<Record<string, unknown>> | null): PageState;
+/**
+ * Everything the in-page probe needs, serialized into the browser on every
+ * action. `tagRoles`/`inputRoles` are the shared role maps (single source of
+ * truth in `locator-healing.ts`), and `roleSources` is the CSS selector for
+ * every element the probe can resolve a role for — all derived from the map so
+ * nothing is hand-maintained twice. Exported so the dogfood mirror
+ * (`application/tests/fixtures.ts`) reuses the same assembled object.
+ */
+interface ProbeArg {
+    keep: string[];
+    tagRoles: Record<string, string>;
+    inputRoles: Record<string, string>;
+    roleSources: string;
+}
+/** Built once — passed verbatim into evaluate() on every action. */
+declare const CAPTURED_ATTRS_ARG: ProbeArg;
 /**
  * ARIA snapshot that tolerates every Playwright version the reporter supports,
  * returning null instead of throwing so a capture can never fail the test. The
@@ -34,7 +136,7 @@ interface CapturedAttrs {
  *     server-side, so the first call already returns a plain flat snapshot.
  *   - < 1.49: `locator.ariaSnapshot` does not exist — returns null up front.
  */
-export declare function ariaSnapshotBestEffort(target: Locator, timeout?: number): Promise<string | null>;
+declare function ariaSnapshotBestEffort(target: Locator, timeout?: number): Promise<string | null>;
 /**
  * Runs inside the browser via `evaluate()` — probes a captured element for its
  * attributes, geometry, label association, and selector-uniqueness counts.
@@ -43,7 +145,7 @@ export declare function ariaSnapshotBestEffort(target: Locator, timeout?: number
  * `el` is browser-context (no DOM lib in this Node package), hence `any`.
  * Exported for unit testing; still passed directly to `evaluate()` below.
  */
-export declare function probeElementAttrs(el: any, keep: string[]): CapturedAttrs;
+declare function probeElementAttrs(el: any, arg: ProbeArg): CapturedAttrs;
 /**
  * The fixtures `piwiFixtures` / `extendPiwiFixtures` contribute. The single
  * added fixture is `piwiCapture`: an auto, test-scoped teardown hook that
@@ -52,7 +154,7 @@ export declare function probeElementAttrs(el: any, keep: string[]): CapturedAttr
  * all capture. Exported so `piwiFixtures` and the extended `test` carry it in
  * their types (and a collision surfaces to the type checker).
  */
-export interface PiwiFixtures {
+interface PiwiFixtures {
     piwiCapture: void;
 }
 /**
@@ -64,7 +166,7 @@ export interface PiwiFixtures {
  * `browser.newContext()`. Collected data is attached as `piwi-*`
  * test-info attachments which the Piwi Dashboard reporter parses on `onTestEnd`.
  */
-export declare const piwiFixtures: Fixtures<PiwiFixtures, {}, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+declare const piwiFixtures: Fixtures<PiwiFixtures, {}, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 /**
  * Extend a Playwright `test` object with the Piwi capture fixtures. The
  * returned `test` carries the existing fixtures plus {@link PiwiFixtures}.
@@ -81,5 +183,6 @@ export declare const piwiFixtures: Fixtures<PiwiFixtures, {}, PlaywrightTestArgs
  * export const test = extendPiwiFixtures(base);
  * ```
  */
-export declare function extendPiwiFixtures<TestArgs extends FixtureArgs, WorkerArgs extends FixtureArgs>(test: TestType<TestArgs, WorkerArgs>): TestType<TestArgs & PiwiFixtures, WorkerArgs>;
-export {};
+declare function extendPiwiFixtures<TestArgs extends FixtureArgs, WorkerArgs extends FixtureArgs>(test: TestType<TestArgs, WorkerArgs>): TestType<TestArgs & PiwiFixtures, WorkerArgs>;
+
+export { CAPTURED_ATTRS_ARG, type PageState, type PiwiFixtures, type ProbeArg, type RawPageState, type RawVitalEntry, ariaSnapshotBestEffort, buildPageState, computeCoreVitals, extendPiwiFixtures, piwiFixtures, probeElementAttrs };