@piwitests/reporter 0.5.0 → 0.7.0

package/dist/types/wire.d.ts

@@ -0,0 +1,174 @@
+/**
+ * Wire contract — the **external** shapes sent to / received from the Piwi
+ * Dashboard server.
+ *
+ * These structurally mirror — but do not import — `application/shared/types.ts`
+ * (`TestCasePayload`, `StreamEventPayload`, `TestRunFinishPayload`). Importing
+ * that module would leak the monorepo path into the published `.d.ts` files; the
+ * constraint forbids the import, not the types. **Any change here is a change to
+ * the server contract** — keep both sides structurally compatible.
+ *
+ * For the in-process collection model (never sent verbatim), see `./collected.ts`.
+ */
+export interface SuiteConfigEntry {
+    mode: 'parallel' | 'serial' | 'default';
+    annotations: Array<{
+        type: string;
+        description?: string;
+    }>;
+}
+export interface TestAnnotation {
+    type: string;
+    description?: string;
+}
+/**
+ * Filter that narrowed a run to a subset of tests, recorded when `isFullRun`
+ * is false. Mirrors `FilterDetails` in `application/shared/types.ts`.
+ */
+export interface FilterDetails {
+    /** A non-default `--grep` pattern (Playwright's default `.*` is excluded). */
+    grep?: string;
+    /** A `--grep-invert` pattern. */
+    grepInvert?: string;
+    /** Positional file/path filters from the CLI invocation (e.g. ["tests/login.spec.ts"]). */
+    files?: string[];
+}
+export interface BrowserConfig {
+    projectName?: string;
+    browserName?: string | null;
+    channel?: string | null;
+    viewport?: {
+        width: number;
+        height: number;
+    } | null;
+    deviceScaleFactor?: number | null;
+    isMobile?: boolean | null;
+    hasTouch?: boolean | null;
+    locale?: string | null;
+    timezoneId?: string | null;
+    geolocation?: {
+        longitude: number;
+        latitude: number;
+        accuracy?: number;
+    } | null;
+    colorScheme?: string | null;
+    reducedMotion?: string | null;
+    forcedColors?: string | null;
+    offline?: boolean | null;
+    bypassCSP?: boolean | null;
+    javaScriptEnabled?: boolean | null;
+    serviceWorkers?: string | null;
+    userAgent?: string | null;
+}
+/** A hook/fixture step event with absolute timings (for the workers timeline). */
+export interface TestStepEvent {
+    title: string;
+    category: 'hook' | 'fixture' | 'test.step' | 'expect' | 'wait';
+    startedAt: number;
+    duration: number;
+    status: string;
+    location?: string | null;
+}
+/**
+ * The per-case wire shape that `toWireTestCase` produces and the server
+ * receives. Structurally compatible with `TestCasePayload` and the per-event
+ * `StreamEventPayload`.
+ */
+export interface WireTestCase {
+    type?: 'begin' | 'complete' | 'step-begin' | 'step-end';
+    title: string;
+    location: string;
+    status?: string;
+    duration?: number;
+    error?: string | null;
+    retries?: number;
+    workerIndex?: number | null;
+    shardIndex?: number | null;
+    startedAt?: number | null;
+    steps?: unknown;
+    stepEvents?: TestStepEvent[] | null;
+    slowestStep?: string | null;
+    slowestStepDuration?: number | null;
+    wastedTimeMs?: number | null;
+    networkRequests?: unknown;
+    webVitals?: unknown;
+    consoleLogs?: unknown;
+    ariaSnapshot?: unknown;
+    testSource?: string | null;
+    browser?: BrowserConfig | null;
+    suitePath?: string[] | null;
+    suiteConfig?: SuiteConfigEntry[] | null;
+    testAnnotations?: TestAnnotation[] | null;
+    /** Step-event discriminant (only for `step-begin`/`step-end` events). */
+    stepCategory?: string | null;
+    parentTitle?: string | null;
+    /** Per-element locator snapshots with ranked alternatives (transient — not stored per-run). */
+    locatorSnapshots?: unknown;
+}
+export interface BeginStreamEvent {
+    type: 'begin';
+    title: string;
+    location: string;
+    workerIndex: number | null;
+    shardIndex: number | null;
+    browser?: BrowserConfig | null;
+    suitePath?: string[] | null;
+    suiteConfig?: SuiteConfigEntry[] | null;
+}
+export interface CompleteStreamEvent {
+    type: 'complete';
+    title: string;
+    location: string;
+    status: string;
+    duration: number;
+    error: string | null;
+    retries: number;
+    workerIndex: number | null;
+    shardIndex: number | null;
+    startedAt: number | null;
+    browser?: BrowserConfig | null;
+    suitePath?: string[] | null;
+    suiteConfig?: SuiteConfigEntry[] | null;
+    testAnnotations?: TestAnnotation[] | null;
+    steps?: unknown;
+    stepEvents?: TestStepEvent[] | null;
+    slowestStep?: string | null;
+    slowestStepDuration?: number | null;
+    networkRequests?: unknown;
+    webVitals?: unknown;
+    consoleLogs?: unknown;
+    ariaSnapshot?: unknown;
+    testSource?: string | null;
+    locatorSnapshots?: unknown;
+}
+export interface StepBeginStreamEvent {
+    type: 'step-begin';
+    title: string;
+    location: string;
+    stepCategory: 'hook' | 'fixture';
+    parentTitle: string | null;
+    workerIndex: number | null;
+    startedAt: number | null;
+}
+export interface StepEndStreamEvent {
+    type: 'step-end';
+    title: string;
+    location: string;
+    status: string;
+    duration: number;
+    stepCategory: 'hook' | 'fixture';
+    parentTitle: string | null;
+    workerIndex: number | null;
+    startedAt: number | null;
+}
+/** Discriminated union of events queued to `StreamManager` and persisted by `StreamBuffer`. */
+export type StreamEvent = BeginStreamEvent | CompleteStreamEvent | StepBeginStreamEvent | StepEndStreamEvent;
+export interface SetupStep {
+    title: string;
+    category: string;
+    startedAt: number;
+    duration: number;
+    status: string;
+    location?: string | null;
+    workerIndex?: number | null;
+}

package/dist/types/wire.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Wire contract — the **external** shapes sent to / received from the Piwi
+ * Dashboard server.
+ *
+ * These structurally mirror — but do not import — `application/shared/types.ts`
+ * (`TestCasePayload`, `StreamEventPayload`, `TestRunFinishPayload`). Importing
+ * that module would leak the monorepo path into the published `.d.ts` files; the
+ * constraint forbids the import, not the types. **Any change here is a change to
+ * the server contract** — keep both sides structurally compatible.
+ *
+ * For the in-process collection model (never sent verbatim), see `./collected.ts`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -1,256 +1,11 @@
 /**
- * Reporter-local domain model.
+ * Reporter-local domain model, split by audience:
+ *  - `types/wire.ts` — the **external** contract sent to / received from the server.
+ *  - `types/collected.ts` — the **internal** model the reporter accumulates in process.
  *
- * These interfaces describe the data that flows *between* the reporter's
- * classes (`FileHandler`, `Uploader`, `StreamManager`, `PiwiDashboardReporter`).
- * They intentionally mirror — but do not import — the wire types in
- * `application/shared/types.ts`. Importing that module would leak the monorepo
- * path into the published `.d.ts` files; the constraint forbids the import,
- * not the types. Keep these structurally compatible with
- * `TestCasePayload` / `StreamEventPayload` / `TestRunFinishPayload` when
- * evolving them.
+ * This barrel re-exports both so `./types.js` imports keep resolving. Prefer
+ * importing from the specific module (`./types/wire.js` / `./types/collected.js`)
+ * so each import site shows whether it touches the wire contract or the internal model.
  */
-export interface SuiteConfigEntry {
-    mode: 'parallel' | 'serial' | 'default';
-    annotations: Array<{
-        type: string;
-        description?: string;
-    }>;
-}
-export interface TestAnnotation {
-    type: string;
-    description?: string;
-}
-/**
- * Filter that narrowed a run to a subset of tests, recorded when `isFullRun`
- * is false. Mirrors `FilterDetails` in `application/shared/types.ts`.
- */
-export interface FilterDetails {
-    /** A non-default `--grep` pattern (Playwright's default `.*` is excluded). */
-    grep?: string;
-    /** A `--grep-invert` pattern. */
-    grepInvert?: string;
-    /** Positional file/path filters from the CLI invocation (e.g. ["tests/login.spec.ts"]). */
-    files?: string[];
-}
-export interface BrowserConfig {
-    projectName?: string;
-    browserName?: string | null;
-    channel?: string | null;
-    viewport?: {
-        width: number;
-        height: number;
-    } | null;
-    deviceScaleFactor?: number | null;
-    isMobile?: boolean | null;
-    hasTouch?: boolean | null;
-    locale?: string | null;
-    timezoneId?: string | null;
-    geolocation?: {
-        longitude: number;
-        latitude: number;
-        accuracy?: number;
-    } | null;
-    colorScheme?: string | null;
-    reducedMotion?: string | null;
-    forcedColors?: string | null;
-    offline?: boolean | null;
-    bypassCSP?: boolean | null;
-    javaScriptEnabled?: boolean | null;
-    serviceWorkers?: string | null;
-    userAgent?: string | null;
-}
-/**
- * A raw Playwright attachment as exposed on `TestResult.attachments`.
- * Carried verbatim on `CollectedTestCase.attachments` so `FileHandler` can
- * resolve trace/attachment paths; never sent to the server.
- */
-export interface RawAttachment {
-    name: string;
-    path?: string;
-    contentType?: string;
-    body?: Buffer;
-    originalName?: string;
-}
-/** Performance metrics collected from `result.steps` by `step-analyzer`. */
-export interface CollectedPerformanceMetrics {
-    steps: Array<{
-        title: string;
-        duration: number;
-        category: string;
-    }>;
-    totalStepDuration: number;
-    slowestStep: {
-        title: string;
-        duration: number;
-    } | null;
-    navigationCount: number;
-    navigationTotalDuration: number;
-    waitTotalDuration: number;
-    waitCount: number;
-}
-/** A hook/fixture step event with absolute timings (for the workers timeline). */
-export interface TestStepEvent {
-    title: string;
-    category: 'hook' | 'fixture' | 'test.step' | 'expect' | 'wait';
-    startedAt: number;
-    duration: number;
-    status: string;
-    location?: string | null;
-}
-/**
- * What `onTestEnd` accumulates per test case. Mixes three concerns that the
- * reporter must keep together during a run:
- *  - **wire fields** (`title`, `status`, `duration`, …) that `toWireTestCase`
- *    projects onto `WireTestCase` before sending,
- *  - **collection-only state** (`attachments`, `performanceMetrics`,
- *    `stepEvents`) consumed by `FileHandler` and the run-level summary,
- *  - the `type` discriminant so the same collected object can be queued as a
- *    stream event.
- *
- * Upload bookkeeping (`_filesUploaded`) is deliberately NOT on this object —
- * `StreamManager` tracks it in a side `Set` so the data model stays clean.
- */
-export interface CollectedTestCase {
-    /** Stream-event discriminant: `'begin'` or `'complete'`. Omitted for batch-only runs. */
-    type?: 'begin' | 'complete';
-    title: string;
-    location: string;
-    status?: string;
-    duration?: number;
-    error?: string | null;
-    retries?: number;
-    workerIndex?: number | null;
-    shardIndex?: number | null;
-    startedAt?: number | null;
-    /** Raw Playwright attachments — never sent on the wire. */
-    attachments?: RawAttachment[];
-    browser?: BrowserConfig | null;
-    suitePath?: string[] | null;
-    suiteConfig?: SuiteConfigEntry[] | null;
-    testAnnotations?: TestAnnotation[] | null;
-    /** Source snippet around the failing line (failed/timedOut only). */
-    testSource?: string;
-    /** Step metrics from `collectStepMetrics`. Consumed by the run summary + `toWireTestCase`. */
-    performanceMetrics?: CollectedPerformanceMetrics;
-    stepEvents?: TestStepEvent[];
-    /** Parsed from `piwi-dashboard-network` attachments by `FileHandler`. */
-    networkRequests?: unknown;
-    /** Parsed from `piwi-dashboard-web-vitals` attachments. */
-    webVitals?: unknown;
-    /** Parsed from `piwi-dashboard-console` attachments. */
-    consoleLogs?: unknown;
-    /** Parsed from `piwi-dashboard-aria-snapshot` attachment. */
-    ariaSnapshot?: string;
-    /** Parsed from `piwi-dashboard-locators` attachment. */
-    locatorSnapshots?: import('./locator-healing.js').LocatorSnapshot[];
-}
-/**
- * The per-case wire shape that `toWireTestCase` produces and the server
- * receives. Structurally compatible with `TestCasePayload` and the per-event
- * `StreamEventPayload`.
- */
-export interface WireTestCase {
-    type?: 'begin' | 'complete' | 'step-begin' | 'step-end';
-    title: string;
-    location: string;
-    status?: string;
-    duration?: number;
-    error?: string | null;
-    retries?: number;
-    workerIndex?: number | null;
-    shardIndex?: number | null;
-    startedAt?: number | null;
-    steps?: unknown;
-    stepEvents?: TestStepEvent[] | null;
-    slowestStep?: string | null;
-    slowestStepDuration?: number | null;
-    wastedTimeMs?: number | null;
-    networkRequests?: unknown;
-    webVitals?: unknown;
-    consoleLogs?: unknown;
-    ariaSnapshot?: unknown;
-    testSource?: string | null;
-    browser?: BrowserConfig | null;
-    suitePath?: string[] | null;
-    suiteConfig?: SuiteConfigEntry[] | null;
-    testAnnotations?: TestAnnotation[] | null;
-    /** Step-event discriminant (only for `step-begin`/`step-end` events). */
-    stepCategory?: string | null;
-    parentTitle?: string | null;
-    /** Per-element locator snapshots with ranked alternatives (transient — not stored per-run). */
-    locatorSnapshots?: unknown;
-}
-export interface BeginStreamEvent {
-    type: 'begin';
-    title: string;
-    location: string;
-    workerIndex: number | null;
-    shardIndex: number | null;
-    browser?: BrowserConfig | null;
-    suitePath?: string[] | null;
-    suiteConfig?: SuiteConfigEntry[] | null;
-}
-export interface CompleteStreamEvent {
-    type: 'complete';
-    title: string;
-    location: string;
-    status: string;
-    duration: number;
-    error: string | null;
-    retries: number;
-    workerIndex: number | null;
-    shardIndex: number | null;
-    startedAt: number | null;
-    browser?: BrowserConfig | null;
-    suitePath?: string[] | null;
-    suiteConfig?: SuiteConfigEntry[] | null;
-    testAnnotations?: TestAnnotation[] | null;
-    steps?: unknown;
-    stepEvents?: TestStepEvent[] | null;
-    slowestStep?: string | null;
-    slowestStepDuration?: number | null;
-    networkRequests?: unknown;
-    webVitals?: unknown;
-    consoleLogs?: unknown;
-    ariaSnapshot?: unknown;
-    testSource?: string | null;
-    locatorSnapshots?: unknown;
-}
-export interface StepBeginStreamEvent {
-    type: 'step-begin';
-    title: string;
-    location: string;
-    stepCategory: 'hook' | 'fixture';
-    parentTitle: string | null;
-    workerIndex: number | null;
-    startedAt: number | null;
-}
-export interface StepEndStreamEvent {
-    type: 'step-end';
-    title: string;
-    location: string;
-    status: string;
-    duration: number;
-    stepCategory: 'hook' | 'fixture';
-    parentTitle: string | null;
-    workerIndex: number | null;
-    startedAt: number | null;
-}
-/** Discriminated union of events queued to `StreamManager` and persisted by `StreamBuffer`. */
-export type StreamEvent = BeginStreamEvent | CompleteStreamEvent | StepBeginStreamEvent | StepEndStreamEvent;
-export interface SetupStep {
-    title: string;
-    category: string;
-    startedAt: number;
-    duration: number;
-    status: string;
-    location?: string | null;
-    workerIndex?: number | null;
-}
-/** Hash + size of a single trace file, used for dedup against the server. */
-export interface TraceHashInfo {
-    tracePath: string;
-    hash: string;
-    size: number;
-}
+export * from './types/wire.js';
+export * from './types/collected.js';

package/dist/types.js

@@ -1,14 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 /**
- * Reporter-local domain model.
+ * Reporter-local domain model, split by audience:
+ *  - `types/wire.ts` — the **external** contract sent to / received from the server.
+ *  - `types/collected.ts` — the **internal** model the reporter accumulates in process.
  *
- * These interfaces describe the data that flows *between* the reporter's
- * classes (`FileHandler`, `Uploader`, `StreamManager`, `PiwiDashboardReporter`).
- * They intentionally mirror — but do not import — the wire types in
- * `application/shared/types.ts`. Importing that module would leak the monorepo
- * path into the published `.d.ts` files; the constraint forbids the import,
- * not the types. Keep these structurally compatible with
- * `TestCasePayload` / `StreamEventPayload` / `TestRunFinishPayload` when
- * evolving them.
+ * This barrel re-exports both so `./types.js` imports keep resolving. Prefer
+ * importing from the specific module (`./types/wire.js` / `./types/collected.js`)
+ * so each import site shows whether it touches the wire contract or the internal model.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/wire.js"), exports);
+__exportStar(require("./types/collected.js"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@piwitests/reporter",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Playwright reporter for sending test results to Piwi Dashboard",
   "url": "https://github.com/PiwiTests/platform",
   "homepage": "https://piwitests.github.io",
@@ -19,11 +19,6 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.js"
-    },
-    "./fixtures": {
-      "types": "./dist/fixtures.d.ts",
-      "import": "./dist/fixtures.js",
-      "require": "./dist/fixtures.js"
     }
   },
   "keywords": [

package/dist/compression.js

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compressDirectory = compressDirectory;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const zlib_1 = __importDefault(require("zlib"));
-const util_1 = require("util");
-const gzipAsync = (0, util_1.promisify)(zlib_1.default.gzip);
-/**
- * Recursively read a directory and pack all files into a gzip-compressed
- * archive (a concatenation of length-prefixed path+content pairs).
- */
-async function compressDirectory(sourceDir) {
-    const files = [];
-    function collect(dir, baseDir = '') {
-        for (const entry of fs_1.default.readdirSync(dir, { withFileTypes: true })) {
-            const full = path_1.default.join(dir, entry.name);
-            const rel = path_1.default.join(baseDir, entry.name);
-            if (entry.isDirectory())
-                collect(full, rel);
-            else if (entry.isFile())
-                files.push({ path: rel, content: fs_1.default.readFileSync(full) });
-        }
-    }
-    collect(sourceDir);
-    const parts = [];
-    for (const f of files) {
-        const pb = Buffer.from(f.path, 'utf8');
-        const plb = Buffer.allocUnsafe(4);
-        plb.writeUInt32LE(pb.length, 0);
-        const clb = Buffer.allocUnsafe(4);
-        clb.writeUInt32LE(f.content.length, 0);
-        parts.push(plb, pb, clb, f.content);
-    }
-    return await gzipAsync(Buffer.concat(parts), { level: 5 });
-}

package/dist/fixtures.d.ts

@@ -1,25 +0,0 @@
-import type { Fixtures } from '@playwright/test';
-/**
- * Playwright fixtures that collect network requests, console entries,
- * web vitals, ARIA snapshots, and locator interaction data during a test.
- *
- * Attaches collected data as `piwi-dashboard-*` test-info attachments
- * which the Piwi Dashboard reporter parses on `onTestEnd`.
- */
-export declare const dashboardFixtures: Fixtures;
-/**
- * Extend a Playwright `test` object with Piwi Dashboard fixtures.
- *
- * Use this instead of importing `@playwright/test` directly from this package
- * to avoid the "Requiring @playwright/test second time" error caused by
- * duplicate module resolution.
- *
- * @example
- * ```ts
- * import { test as base } from '@playwright/test';
- * import { extendDashboardFixtures } from '@piwitests/reporter/fixtures';
- *
- * export const test = extendDashboardFixtures(base);
- * ```
- */
-export declare function extendDashboardFixtures<T>(test: T): T;