@terra-symposium/standards-reporting 0.0.0-stage → 0.3.0

package/dist/playwright.d.ts

@@ -0,0 +1,113 @@
+/**
+ * packages/reporting/src/playwright.ts
+ * Playwright fixtures and reporter for reusable test evidence.
+ */
+import { diagnosticCount } from './core.js';
+import type { LoadBudgetOverride, LoadTestingConfig, ProjectDefinition } from './core.js';
+import type { ViewportCatalog } from './viewports.js';
+/** Browser diagnostic captured by the reusable page fixture. */
+export type BrowserDiagnostic = {
+    level: string;
+    message: string;
+    url?: string;
+};
+/** Playwright fixture that records browser console, page, and request failures. */
+export declare const diagnosticsTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+/** Test-local load helpers exposed by the reusable load fixture. */
+export type LoadTestController = {
+    /** Sets a budget override for this test's total elapsed duration. */
+    setTestBudget: (budget: LoadBudgetOverride) => void;
+    /** Measures a named asynchronous or synchronous operation and preserves its return value. */
+    measure: <T>(name: string, op: () => T | Promise<T>, budget?: LoadBudgetOverride) => Promise<T>;
+};
+/**
+ * Playwright fixture that records navigations and named operation timings.
+ * Import as `test` in suites that need page and operation-level measurements.
+ */
+export declare const loadTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
+    load: LoadTestController;
+}, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+/** Application-specific paths and catalog settings for the shared reporter. */
+export type ReportingOptions = {
+    featureFiles?: readonly string[];
+    projects?: readonly ProjectDefinition[];
+    viewportCatalog?: ViewportCatalog;
+    outputRoot?: string;
+    reportFile?: string;
+    slideshowFile?: string;
+    supplementalResultsFile?: string;
+    qualityConfigFile?: string;
+    loadTesting?: LoadTestingConfig;
+};
+/**
+ * Removes terminal color escapes before diagnostics enter an artifact.
+ * @param valerminal output that may contain ANSI escape sequences.
+ * @returns Terminal output with ANSI formatting removed.
+ */
+export declare const stripAnsi: (val: string) => string;
+/**
+ * Parses browser diagnostic attachments into readable artifact lines.
+ * @param raw JSON attachment text or a plain diagnostic message.
+ * @returns Normalized diagnostic lines.
+ */
+export declare const parseDiagnostics: (raw: string) => string[];
+/** Creates the reusable Playwright reporter with application-specific output configuration. */
+export default class ProgressReporter {
+    private readonly options;
+    private readonly results;
+    private readonly terminalDiagnostics;
+    private readonly runDiagnostics;
+    private readonly expectedTests;
+    private readonly completedTests;
+    /**
+     * Creates a reporter that writes application-specific visual test artifacts.
+     *
+     * @param opts Application-specific reporter configuration.
+     */
+    constructor(opts?: ReportingOptions);
+    /**
+     * Records the full expected suite so interrupted tests can be represented.
+     * @param _config Playwright configuration supplied by the reporter lifecycle.
+     * @param suite Playwright suite containing all discovered tests.
+     * @returns Nothing; the expected-test registry is updated in place.
+     */
+    onBegin(_config: Parameters<NonNullable<import('@playwright/test/reporter').Reporter['onBegin']>>[0], suite: Parameters<NonNullable<import('@playwright/test/reporter').Reporter['onBegin']>>[1]): void;
+    /**
+     * Associates stderr with a test result or the run when no test is active.
+     * @param chunk Terminal output emitted by Playwright.
+     * @param test Active test identity, when available.
+     * @param result Active test result, when available.
+     * @returns Nothing; diagnostic state is updated in place.
+     */
+    onStdErr(chunk: string | Buffer, test?: object, result?: object): void;
+    /**
+     * Retains diagnostic-looking stdout without treating ordinary output as failure evidence.
+     * @param chunk Terminal output emitted by Playwright.
+     * @param test Active test identity, when available.
+     * @param result Active test result, when available.
+     * @returns Nothing; diagnostic state is updated in place.
+     */
+    onStdOut(chunk: string | Buffer, test?: object, result?: object): void;
+    /**
+     * Retains reporter-level errors in the run diagnostics.
+     * @param err Reporter-level error emitted by Playwright.
+     * @returns Nothing; run diagnostics are updated in place.
+     */
+    onError(err: {
+        message: string;
+    }): void;
+    /**
+     * Normalizes a completed Playwright result and associates its evidence.
+     * @param test Completed Playwright test case.
+     * @param result Completed Playwright test result and attachments.
+     * @returns Nothing; the normalized result is appended to the run.
+     */
+    onTestEnd(test: import('@playwright/test/reporter').TestCase, result: import('@playwright/test/reporter').TestResult): void;
+    /**
+     * Emits interrupted results and writes the spreadsheet and slideshow artifacts.
+     * @returns A promise that resolves after both report artifacts are written.
+     */
+    onEnd(): Promise<'failed' | void>;
+}
+export { diagnosticCount };
+//# sourceMappingURL=playwright.d.ts.map

package/dist/playwright.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright.d.ts","sourceRoot":"","sources":["../src/playwright.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EAAE,eAAe,EAAyB,MAAM,WAAW,CAAC;AAUnE,OAAO,KAAK,EAAE,kBAAkB,EAAyC,iBAAiB,EAAE,iBAAiB,EAA2B,MAAM,WAAW,CAAC;AAC1J,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAMtD,gEAAgE;AAChE,MAAM,MAAM,iBAAiB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAMjF,mFAAmF;AACnF,eAAO,MAAM,eAAe,6OA0B1B,CAAC;AAEH,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAChC,qEAAqE;IACrE,aAAa,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACpD,6FAA6F;IAC7F,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CAChG,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,QAAQ;UAAkC,kBAAkB;wGA6DvE,CAAC;AAEH,+EAA+E;AAC/E,MAAM,MAAM,gBAAgB,GAAG;IAC9B,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,QAAQ,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACxC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,iBAAiB,CAAC;CAChC,CAAC;AASF;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,KAAG,MAA4F,CAAC;AAErI;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,KAAG,MAAM,EAapD,CAAC;AAqPF,+FAA+F;AAC/F,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CACuF;IAC/G,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAC9C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA+B;IACnE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAwJ;IACtL,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqB;IAEpD;;;;OAIG;gBACS,IAAI,GAAE,gBAAqB;IAavC;;;;;OAKG;IACH,OAAO,CACN,OAAO,EAAE,UAAU,CAAC,WAAW,CAAC,OAAO,2BAA2B,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAC5F,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,OAAO,2BAA2B,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACxF,IAAI;IAiBP;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAUtE;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAUtE;;;;OAIG;IACH,OAAO,CAAC,GAAG,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAIvC;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,OAAO,2BAA2B,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,2BAA2B,EAAE,UAAU,GAAG,IAAI;IA2B3H;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;CA8CvC;AACD,OAAO,EAAE,eAAe,EAAE,CAAC"}