@piwitests/reporter 0.39.0 → 0.41.0

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

@@ -13,6 +13,8 @@ declare const ATTACHMENT_NAMES: {
     readonly dialogs: "piwi-dialogs";
     readonly network: "piwi-network";
     readonly pageInventory: "piwi-page-inventory";
+    readonly locatorPages: "piwi-locator-pages";
+    readonly codeReach: "piwi-code-reach";
     readonly webVitals: "piwi-web-vitals";
     readonly locatorSuggestion: "piwi-locator-suggestion";
     readonly pageState: "piwi-page-state";

package/dist/internal/capture/attachments.js

@@ -34,6 +34,8 @@ var ATTACHMENT_NAMES = {
   dialogs: "piwi-dialogs",
   network: "piwi-network",
   pageInventory: "piwi-page-inventory",
+  locatorPages: "piwi-locator-pages",
+  codeReach: "piwi-code-reach",
   webVitals: "piwi-web-vitals",
   locatorSuggestion: "piwi-locator-suggestion",
   pageState: "piwi-page-state",

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

@@ -1,6 +1,70 @@
 import { ProbeArg } from '@piwitests/picker-dom';
 export { ProbeArg, ProbedAttrs, probeElementAttrs } from '@piwitests/picker-dom';
-import { TestType, Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, Locator } from '@playwright/test';
+import { Page, TestType, Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, Locator } from '@playwright/test';
+import { LocatorPageUse } from '@piwitests/core/wire';
+import { JsCoverageEntry } from '@piwitests/core/code-reach';
+
+/** A main-frame navigation, full or same-document: the page starts over. */
+declare function noteNavigation(page: object): void;
+/**
+ * A locator call starts on `page`: returns whether it is on arrival, and counts
+ * it when it is an interaction (every action but `waitFor`; assertions are not).
+ */
+declare function noteLocatorCall(page: object, method: string, assertion?: boolean): boolean;
+declare class LocatorPageLog {
+    private readonly entries;
+    /** Record one call. Silently skipped without a call site, off an http(s) page, or past the limits. */
+    record(call: {
+        location: string | null;
+        locator: string;
+        url: string;
+        arrival: boolean;
+    }): void;
+    get size(): number;
+    /** The entries in the order the calls first happened. */
+    list(): LocatorPageUse[];
+}
+
+/**
+ * Register this package's `dist/` directory as a boxed stack prefix — the list
+ * Playwright filters its own frames with — so a wrapped action's step location
+ * and error stack name the test's line instead of the wrapper. `extraPrefixes`
+ * adds more: a fixtures file of your own that wraps locators the same way.
+ * Playwright's own package stays in the list. A missing hook or an unexpected
+ * layout leaves Playwright's defaults untouched.
+ */
+declare function boxCaptureFrames(extraPrefixes?: readonly string[]): void;
+/**
+ * Run a page read as an internal Playwright call: every API call made inside
+ * `run` is kept out of the test's steps and the trace. `owner` is the page (or
+ * any Playwright channel object) the reads go through; without the hook the
+ * read simply runs.
+ */
+declare function internalCall<T>(owner: unknown, run: () => Promise<T>): Promise<T>;
+
+/** Where code reach resolves paths. */
+interface CodeReachRoots {
+    /** Directories a module path or a map source is tried against, first match wins; the repository root is last. */
+    roots: string[];
+    /** Paths go out relative to it. */
+    repoRoot: string;
+}
+/** Fetches a source map's text; null when it cannot. */
+type MapFetcher = (url: string) => Promise<string | null>;
+/**
+ * The roots for a test: `codeReachRoots` when set, else the Playwright config's
+ * directory; the repository root always comes last, since bundlers name
+ * sources from the project root (Turbopack's `[project]/`).
+ */
+declare function codeReachRoots(configDir: string, configured: string[] | null | undefined): CodeReachRoots;
+/** The repository-relative files the covered scripts reached, sorted and capped. */
+declare function resolveCodeReach(entries: JsCoverageEntry[], roots: CodeReachRoots, fetchMap: MapFetcher): Promise<string[]>;
+/** A map fetcher through the page's request context, bounded in size and time. */
+declare function pageMapFetcher(page: Page): MapFetcher;
+/** Start JavaScript coverage on a page; false when the browser has none or it fails. */
+declare function startCodeReach(page: Page): Promise<boolean>;
+/** Stop JavaScript coverage and return its entries; null when it cannot be read. */
+declare function stopCodeReach(page: Page): Promise<JsCoverageEntry[] | null>;
 
 type FixtureArgs = {
     [key: string]: any;
@@ -24,6 +88,8 @@ declare function computeCoreVitals(lcpEntries: RawVitalEntry[] | null, shiftEntr
     cls: number | null;
     inp: number | null;
 } | null;
+/** The code reach roots from `PIWI_CODE_REACH_ROOTS` (a JSON array or a path list). */
+declare function configuredCodeReachRoots(): string[] | null;
 /** Page state captured at test end. Storage values and cookie values are NEVER included. */
 interface PageState {
     url: string;
@@ -100,6 +166,13 @@ declare function ariaSnapshotBestEffort(target: Locator, timeout?: number): Prom
  * yields null and the capture proceeds with the YAML alone.
  */
 declare function ariaSnapshotJSONBestEffort(target: Locator, timeout?: number): Promise<string | null>;
+/**
+ * Call a Playwright method on its own receiver. Playwright names an API call
+ * after the method frame the call enters, so the call keeps its real name
+ * (`locator.fill: Timeout …`); a call through `Function.prototype.apply` is
+ * named `apply`.
+ */
+declare function callMethod(target: object, prop: string | symbol, args: unknown[]): unknown;
 /**
  * The fixtures `piwiFixtures` / `extendPiwiFixtures` contribute. The single
  * added fixture is `piwiCapture`: an auto, test-scoped teardown hook that
@@ -139,4 +212,4 @@ declare const piwiFixtures: Fixtures<PiwiFixtures, {}, PlaywrightTestArgs & Play
  */
 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 RawPageState, type RawVitalEntry, ariaSnapshotBestEffort, ariaSnapshotJSONBestEffort, buildPageState, computeCoreVitals, extendPiwiFixtures, piwiFixtures };
+export { CAPTURED_ATTRS_ARG, LocatorPageLog, type PageState, type PiwiFixtures, type RawPageState, type RawVitalEntry, ariaSnapshotBestEffort, ariaSnapshotJSONBestEffort, boxCaptureFrames, buildPageState, callMethod, codeReachRoots, computeCoreVitals, configuredCodeReachRoots, extendPiwiFixtures, internalCall, noteLocatorCall, noteNavigation, pageMapFetcher, piwiFixtures, resolveCodeReach, startCodeReach, stopCodeReach };