@plan2net/typo3-playwright-toolkit 0.1.0

package/dist/builders/request-context.js

@@ -0,0 +1,32 @@
+import { getToolkitConfig } from '../config.js';
+/** TYPO3's own default for `BE/entryPoint`, which 11.5 and 12.4 have no setting for. */
+export const DEFAULT_BACKEND_PATH = '/typo3';
+/**
+ * The fixtures put the test ID on the page and context; an explicit one overrides
+ * it. An empty ID is refused rather than sent, because the extension reads an
+ * empty header as "use the base database".
+ */
+export function ambientTestId(page) {
+    return (page.testId ||
+        page.context().testId ||
+        undefined);
+}
+export function requireTestId(page, explicit) {
+    const testId = explicit || ambientTestId(page) || '';
+    if (!testId) {
+        throw new Error('[typo3-playwright-toolkit] No test ID for this request. Pass one in, or use a page from the ' +
+            'toolkit fixtures — without it the request would run against the base database.');
+    }
+    return testId;
+}
+export function resolveRequestContext(page, explicit = {}) {
+    return {
+        // Never derived from page.url(): the request carries the API secret, and a
+        // page that navigated off-site must not decide where the builder posts it.
+        baseUrl: explicit.baseUrl ?? getToolkitConfig().testingURL,
+        backendPath: explicit.backendPath ?? DEFAULT_BACKEND_PATH,
+        testId: requireTestId(page, explicit.testId),
+        routeToken: explicit.routeToken ?? '',
+    };
+}
+//# sourceMappingURL=request-context.js.map

package/dist/builders/request-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.js","sourceRoot":"","sources":["../../src/builders/request-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAG/C,wFAAwF;AACxF,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAA;AAgB5C;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAA0B;IACpD,OAAO,CACF,IAAkC,CAAC,MAAM;QACzC,IAAI,CAAC,OAAO,EAAwB,CAAC,MAAM;QAC5C,SAAS,CACZ,CAAA;AACL,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAA0B,EAAE,QAAiB;IACvE,MAAM,MAAM,GAAG,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;IAEpD,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACX,8FAA8F;YAC1F,gFAAgF,CACvF,CAAA;IACL,CAAC;IAED,OAAO,MAAM,CAAA;AACjB,CAAC;AAED,MAAM,UAAU,qBAAqB,CACjC,IAA0B,EAC1B,WAAoC,EAAE;IAEtC,OAAO;QACH,2EAA2E;QAC3E,2EAA2E;QAC3E,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,gBAAgB,EAAE,CAAC,UAAU;QAC1D,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,oBAAoB;QACzD,MAAM,EAAE,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC;QAC5C,UAAU,EAAE,QAAQ,CAAC,UAAU,IAAI,EAAE;KACxC,CAAA;AACL,CAAC"}

package/dist/checks/accessibility.d.ts

@@ -0,0 +1,34 @@
+import { type Page } from '@playwright/test';
+import type { AxeResults } from 'axe-core';
+import { type ToolkitAccessibilityConfig } from '../config.js';
+export declare const DEFAULT_SCAN_TAGS: string[];
+export interface AccessibilityScanOptions {
+    disabledRules?: string[];
+    include?: string;
+    exclude?: string;
+    tags?: string[];
+    /** Normally taken from test.info(); injectable so this is testable. */
+    projectName?: string;
+}
+export interface AxeRunInput {
+    include: string | null;
+    exclude: string | null;
+    disabledRules: string[];
+    tags: string[];
+}
+export declare function axeSource(): string;
+export declare function shouldScanAutomatically(outcome: {
+    status: string;
+    navigated: boolean;
+}, config?: {
+    auto?: boolean;
+}): boolean;
+export declare function shouldScanProject(projectName: string, projects: string[] | undefined): boolean;
+export declare function buildAxeRunInput(options: AccessibilityScanOptions, config: ToolkitAccessibilityConfig | undefined): AxeRunInput;
+/**
+ * @returns axe's raw results, or null when this project is not scanned
+ */
+export declare function scanAccessibility(page: Page, options?: AccessibilityScanOptions): Promise<AxeResults | null>;
+/** Use scanAccessibility instead when you need the results themselves. */
+export declare function runAccessibilityScan(page: Page, options?: AccessibilityScanOptions): Promise<void>;
+//# sourceMappingURL=accessibility.d.ts.map

package/dist/checks/accessibility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessibility.d.ts","sourceRoot":"","sources":["../../src/checks/accessibility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAA8B,MAAM,UAAU,CAAA;AAGtE,OAAO,EAAoB,KAAK,0BAA0B,EAAE,MAAM,cAAc,CAAA;AAGhF,eAAO,MAAM,iBAAiB,UAAgE,CAAA;AAE9F,MAAM,WAAW,wBAAwB;IACrC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,uEAAuE;IACvE,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,WAAW;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,IAAI,EAAE,MAAM,EAAE,CAAA;CACjB;AAID,wBAAgB,SAAS,IAAI,MAAM,CAOlC;AAID,wBAAgB,uBAAuB,CACnC,OAAO,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,EAC/C,MAAM,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,GAC5B,OAAO,CAET;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,OAAO,CAE9F;AAED,wBAAgB,gBAAgB,CAC5B,OAAO,EAAE,wBAAwB,EACjC,MAAM,EAAE,0BAA0B,GAAG,SAAS,GAC/C,WAAW,CAgBb;AAcD;;GAEG;AACH,wBAAsB,iBAAiB,CACnC,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,wBAA6B,GACvC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAuC5B;AAED,0EAA0E;AAC1E,wBAAsB,oBAAoB,CACtC,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,wBAA6B,GACvC,OAAO,CAAC,IAAI,CAAC,CAef"}

package/dist/checks/accessibility.js

@@ -0,0 +1,90 @@
+import { expect, test } from '@playwright/test';
+import { createRequire } from 'module';
+import * as fs from 'fs';
+import { getToolkitConfig } from '../config.js';
+// Not AAA: it includes rules most sites intentionally do not meet.
+export const DEFAULT_SCAN_TAGS = ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa', 'best-practice'];
+let cachedAxeSource;
+export function axeSource() {
+    if (undefined === cachedAxeSource) {
+        const require = createRequire(import.meta.url);
+        cachedAxeSource = fs.readFileSync(require.resolve('axe-core/axe.min.js'), 'utf-8');
+    }
+    return cachedAxeSource;
+}
+// No configured list means every project: scanning nowhere would leave the suite
+// green while proving nothing.
+export function shouldScanAutomatically(outcome, config) {
+    return true === config?.auto && outcome.navigated && 'failed' !== outcome.status;
+}
+export function shouldScanProject(projectName, projects) {
+    return !projects || projects.length === 0 || projects.includes(projectName);
+}
+export function buildAxeRunInput(options, config) {
+    const disabled = new Set([...(config?.disabledRules ?? []), ...(options.disabledRules ?? [])]);
+    // axe checks the headings of one part against the whole page, so a component
+    // that starts at h3 fails because of the page's h1. A scan of the whole page
+    // still checks the heading order.
+    if (options.include) {
+        disabled.add('heading-order');
+    }
+    return {
+        include: options.include ?? null,
+        exclude: options.exclude ?? null,
+        disabledRules: [...disabled],
+        tags: options.tags ?? config?.tags ?? DEFAULT_SCAN_TAGS,
+    };
+}
+function currentProjectName(options) {
+    if (options.projectName) {
+        return options.projectName;
+    }
+    try {
+        return test.info().project.name;
+    }
+    catch {
+        return '';
+    }
+}
+/**
+ * @returns axe's raw results, or null when this project is not scanned
+ */
+export async function scanAccessibility(page, options = {}) {
+    const config = getToolkitConfig().accessibility;
+    const projectName = currentProjectName(options);
+    if (!shouldScanProject(projectName, config?.projects)) {
+        // Said out loud: a project renamed in playwright.config.ts but not in the
+        // toolkit config would otherwise leave every a11y assertion passing on
+        // nothing.
+        console.warn(`[typo3-playwright-toolkit] No accessibility scan for project "${projectName}": ` +
+            `accessibility.projects is [${(config?.projects ?? []).join(', ')}].`);
+        return null;
+    }
+    const hasAxe = await page.evaluate(() => 'object' === typeof window.axe);
+    if (!hasAxe) {
+        await page.evaluate(axeSource());
+    }
+    // window.axe.run() directly rather than @axe-core/playwright's analyze():
+    // ~100-300ms against ~1s, which it spends on cross-frame orchestration this
+    // needs. The trade-off is no cross-origin iframe traversal.
+    return (await page.evaluate(({ include, exclude, disabledRules, tags }) => {
+        const axe = window.axe;
+        const context = (include || exclude ? { ...(include && { include }), ...(exclude && { exclude }) } : document);
+        return axe.run(context, {
+            runOnly: { type: 'tag', values: tags },
+            rules: Object.fromEntries(disabledRules.map((rule) => [rule, { enabled: false }])),
+        });
+    }, buildAxeRunInput(options, config)));
+}
+/** Use scanAccessibility instead when you need the results themselves. */
+export async function runAccessibilityScan(page, options = {}) {
+    const results = await scanAccessibility(page, options);
+    if (null === results) {
+        return;
+    }
+    // An empty or inert region passes vacuously, which is worse than a violation.
+    const evaluatedRules = results.violations.length + results.passes.length + results.incomplete.length;
+    expect(evaluatedRules, 'accessibility scan evaluated no rules — the scanned region is empty or inert').toBeGreaterThan(0);
+    expect(results.violations).toEqual([]);
+}
+//# sourceMappingURL=accessibility.js.map

package/dist/checks/accessibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessibility.js","sourceRoot":"","sources":["../../src/checks/accessibility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAa,MAAM,kBAAkB,CAAA;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAA;AACxB,OAAO,EAAE,gBAAgB,EAAmC,MAAM,cAAc,CAAA;AAEhF,mEAAmE;AACnE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;AAkB9F,IAAI,eAAmC,CAAA;AAEvC,MAAM,UAAU,SAAS;IACrB,IAAI,SAAS,KAAK,eAAe,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC9C,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC,CAAA;IACtF,CAAC;IAED,OAAO,eAAe,CAAA;AAC1B,CAAC;AAED,iFAAiF;AACjF,+BAA+B;AAC/B,MAAM,UAAU,uBAAuB,CACnC,OAA+C,EAC/C,MAA2B;IAE3B,OAAO,IAAI,KAAK,MAAM,EAAE,IAAI,IAAI,OAAO,CAAC,SAAS,IAAI,QAAQ,KAAK,OAAO,CAAC,MAAM,CAAA;AACpF,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,WAAmB,EAAE,QAA8B;IACjF,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;AAC/E,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC5B,OAAiC,EACjC,MAA8C;IAE9C,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;IAE9F,6EAA6E;IAC7E,6EAA6E;IAC7E,kCAAkC;IAClC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QAClB,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;IACjC,CAAC;IAED,OAAO;QACH,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;QAChC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;QAChC,aAAa,EAAE,CAAC,GAAG,QAAQ,CAAC;QAC5B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,MAAM,EAAE,IAAI,IAAI,iBAAiB;KAC1D,CAAA;AACL,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAiC;IACzD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACtB,OAAO,OAAO,CAAC,WAAW,CAAA;IAC9B,CAAC;IAED,IAAI,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAA;IACnC,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,EAAE,CAAA;IACb,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACnC,IAAU,EACV,UAAoC,EAAE;IAEtC,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC,aAAa,CAAA;IAC/C,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAE/C,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QACpD,0EAA0E;QAC1E,uEAAuE;QACvE,WAAW;QACX,OAAO,CAAC,IAAI,CACR,iEAAiE,WAAW,KAAK;YAC7E,8BAA8B,CAAC,MAAM,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAC5E,CAAA;QAED,OAAO,IAAI,CAAA;IACf,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,QAAQ,KAAK,OAAQ,MAAuC,CAAC,GAAG,CAAC,CAAA;IAC1G,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAA;IACpC,CAAC;IAED,0EAA0E;IAC1E,4EAA4E;IAC5E,4DAA4D;IAC5D,OAAO,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE;QACtE,MAAM,GAAG,GACL,MAGH,CAAC,GAAG,CAAA;QACL,MAAM,OAAO,GAAG,CACZ,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAC7E,CAAA;QAEnB,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE;YACpB,OAAO,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE;YACtC,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;SACrF,CAAC,CAAA;IACN,CAAC,EAAE,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;AAC1C,CAAC;AAED,0EAA0E;AAC1E,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACtC,IAAU,EACV,UAAoC,EAAE;IAEtC,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACtD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACnB,OAAM;IACV,CAAC;IAED,8EAA8E;IAC9E,MAAM,cAAc,GAChB,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAA;IACjF,MAAM,CACF,cAAc,EACd,8EAA8E,CACjF,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;IAEpB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;AAC1C,CAAC"}

package/dist/checks/csp.d.ts

@@ -0,0 +1,39 @@
+import { type BrowserContext, type TestInfo } from '@playwright/test';
+export type CspMode = 'any' | 'report-only' | 'enforced';
+export interface CspViolation {
+    blockedUri: string;
+    columnNumber: number;
+    disposition: SecurityPolicyViolationEventDisposition;
+    documentUri: string;
+    effectiveDirective: string;
+    lineNumber: number;
+    originalPolicy: string;
+    sample: string;
+    sourceFile: string;
+    violatedDirective: string;
+}
+export interface DocumentPolicy {
+    enforced: string | null;
+    reportOnly: string | null;
+    url: string;
+}
+export declare function isExpectedDocumentOrigin(documentUri: string, expectedOrigin: string): boolean;
+export declare function policyIssues(policies: DocumentPolicy[], requestedDocuments: string[], mode: CspMode, expectedOrigin: string): string[];
+export declare function describeViolations(violations: CspViolation[]): string[];
+export declare class CspVerifier {
+    private readonly context;
+    private readonly expectedOrigin;
+    private readonly mode;
+    private readonly documentRequests;
+    private readonly documentPolicies;
+    private readonly violations;
+    private installed;
+    constructor(context: BrowserContext, options?: {
+        expectedOrigin?: string;
+        mode?: CspMode;
+    });
+    install(): Promise<void>;
+    assertNoViolations(testInfo?: TestInfo, label?: string): Promise<void>;
+    private isExpectedOrigin;
+}
+//# sourceMappingURL=csp.d.ts.map

package/dist/checks/csp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"csp.d.ts","sourceRoot":"","sources":["../../src/checks/csp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,cAAc,EAAE,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAG7E,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,aAAa,GAAG,UAAU,CAAA;AAExD,MAAM,WAAW,YAAY;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,uCAAuC,CAAA;IACpD,WAAW,EAAE,MAAM,CAAA;IACnB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,iBAAiB,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACd;AAQD,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAY7F;AAED,wBAAgB,YAAY,CACxB,QAAQ,EAAE,cAAc,EAAE,EAC1B,kBAAkB,EAAE,MAAM,EAAE,EAC5B,IAAI,EAAE,OAAO,EACb,cAAc,EAAE,MAAM,GACvB,MAAM,EAAE,CAmCV;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,MAAM,EAAE,CA0BvE;AAED,qBAAa,WAAW;IAShB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAR5B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;IACvC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAe;IAChD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuB;IACxD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqB;IAChD,OAAO,CAAC,SAAS,CAAQ;gBAGJ,OAAO,EAAE,cAAc,EACxC,OAAO,GAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAO;IAQvD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA+DxB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,KAAK,SAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IA8ClF,OAAO,CAAC,gBAAgB;CAO3B"}

package/dist/checks/csp.js

@@ -0,0 +1,179 @@
+import { expect } from '@playwright/test';
+import { getToolkitConfig } from '../config.js';
+const BINDING_NAME = '__playwrightReportCspViolation';
+function isPresent(header) {
+    return !!header?.trim();
+}
+export function isExpectedDocumentOrigin(documentUri, expectedOrigin) {
+    if (!documentUri.trim()) {
+        return false;
+    }
+    try {
+        const documentOrigin = new URL(documentUri).origin;
+        return 'null' !== documentOrigin && documentOrigin === expectedOrigin;
+    }
+    catch {
+        return false;
+    }
+}
+export function policyIssues(policies, requestedDocuments, mode, expectedOrigin) {
+    if (0 === policies.length) {
+        if (0 === requestedDocuments.length) {
+            return [];
+        }
+        // Documents were asked for but none answered, so nothing was checked.
+        return [
+            `No successful same-origin HTML document response was observed for ${expectedOrigin}.\n` +
+                `Requested documents:\n${requestedDocuments.map((url) => `  - ${url}`).join('\n')}`,
+        ];
+    }
+    return policies.flatMap((policy) => {
+        const issues = [];
+        if ('report-only' === mode) {
+            if (!isPresent(policy.reportOnly)) {
+                issues.push(`Missing Content-Security-Policy-Report-Only header: ${policy.url}`);
+            }
+            if (isPresent(policy.enforced)) {
+                issues.push(`Unexpected enforcing Content-Security-Policy header: ${policy.url}`);
+            }
+        }
+        else if ('enforced' === mode) {
+            // A report-only header next to it is normal: sites enforce one policy
+            // while testing a stricter one.
+            if (!isPresent(policy.enforced)) {
+                issues.push(`Missing enforcing Content-Security-Policy header: ${policy.url}`);
+            }
+        }
+        else if (!isPresent(policy.enforced) && !isPresent(policy.reportOnly)) {
+            issues.push(`Document served with no Content-Security-Policy header: ${policy.url}`);
+        }
+        return issues;
+    });
+}
+export function describeViolations(violations) {
+    const grouped = new Map();
+    for (const violation of violations) {
+        grouped.set(violation.effectiveDirective, [
+            ...(grouped.get(violation.effectiveDirective) ?? []),
+            violation,
+        ]);
+    }
+    return [...grouped.entries()].map(([directive, group]) => {
+        const details = group.map((violation) => {
+            const source = violation.sourceFile
+                ? `${violation.sourceFile}:${violation.lineNumber}:${violation.columnNumber}`
+                : violation.documentUri;
+            const sample = violation.sample ? `\n    Sample: ${violation.sample}` : '';
+            return (`  - Blocked: ${violation.blockedUri || 'unknown'}\n` +
+                `    Document: ${violation.documentUri}\n` +
+                `    Source: ${source}\n` +
+                `    Disposition: ${violation.disposition}${sample}`);
+        });
+        return `${directive} (${group.length})\n${details.join('\n')}`;
+    });
+}
+export class CspVerifier {
+    context;
+    expectedOrigin;
+    mode;
+    documentRequests = [];
+    documentPolicies = [];
+    violations = [];
+    installed = false;
+    constructor(context, options = {}) {
+        this.context = context;
+        const config = getToolkitConfig();
+        this.expectedOrigin =
+            options.expectedOrigin ?? config.csp?.expectedOrigin ?? new URL(config.testingURL).origin;
+        this.mode = options.mode ?? config.csp?.mode ?? 'any';
+    }
+    async install() {
+        this.installed = true;
+        await this.context.exposeBinding(BINDING_NAME, (_source, violation) => {
+            if (isExpectedDocumentOrigin(violation.documentUri, this.expectedOrigin)) {
+                this.violations.push(violation);
+            }
+        });
+        await this.context.addInitScript((reportBindingName) => {
+            document.addEventListener('securitypolicyviolation', (event) => {
+                const report = globalThis[reportBindingName];
+                if (!report) {
+                    return;
+                }
+                void report({
+                    blockedUri: event.blockedURI,
+                    columnNumber: event.columnNumber,
+                    disposition: event.disposition,
+                    documentUri: event.documentURI,
+                    effectiveDirective: event.effectiveDirective,
+                    lineNumber: event.lineNumber,
+                    originalPolicy: event.originalPolicy,
+                    sample: event.sample,
+                    sourceFile: event.sourceFile,
+                    violatedDirective: event.violatedDirective,
+                });
+            });
+        }, BINDING_NAME);
+        this.context.on('request', (request) => {
+            if ('document' === request.resourceType() && this.isExpectedOrigin(request.url())) {
+                this.documentRequests.push(request.url());
+            }
+        });
+        this.context.on('response', (response) => {
+            const headers = response.headers();
+            const contentType = headers['content-type'] ?? '';
+            if ('document' !== response.request().resourceType() ||
+                response.status() < 200 ||
+                response.status() >= 300 ||
+                !contentType.toLowerCase().includes('text/html') ||
+                !this.isExpectedOrigin(response.url())) {
+                return;
+            }
+            this.documentPolicies.push({
+                enforced: headers['content-security-policy'] ?? null,
+                reportOnly: headers['content-security-policy-report-only'] ?? null,
+                url: response.url(),
+            });
+        });
+    }
+    async assertNoViolations(testInfo, label = 'csp-report') {
+        // The listeners live in install(). Without them nothing was ever collected,
+        // and this would pass for a page it never saw.
+        if (!this.installed) {
+            throw new Error('[typo3-playwright-toolkit] CspVerifier.assertNoViolations() before install(). ' +
+                'Call install() before the page navigates, or it observes nothing.');
+        }
+        // Messages from the page arrive in order, so asking the page one more
+        // question makes sure the earlier violations have already reached us.
+        await Promise.all(this.context
+            .pages()
+            .filter((page) => !page.isClosed())
+            .map((page) => page.evaluate(() => undefined)));
+        const issues = [
+            ...policyIssues(this.documentPolicies, this.documentRequests, this.mode, this.expectedOrigin),
+            ...describeViolations(this.violations),
+        ];
+        if (issues.length > 0 && testInfo) {
+            await testInfo.attach(`${label}.json`, {
+                body: Buffer.from(JSON.stringify({
+                    expectedOrigin: this.expectedOrigin,
+                    mode: this.mode,
+                    documentRequests: this.documentRequests,
+                    documentPolicies: this.documentPolicies,
+                    violations: this.violations,
+                }, null, 2)),
+                contentType: 'application/json',
+            });
+        }
+        expect(issues, `CSP verification failed:\n\n${issues.join('\n\n')}`).toHaveLength(0);
+    }
+    isExpectedOrigin(url) {
+        try {
+            return new URL(url).origin === this.expectedOrigin;
+        }
+        catch {
+            return false;
+        }
+    }
+}
+//# sourceMappingURL=csp.js.map

package/dist/checks/csp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csp.js","sourceRoot":"","sources":["../../src/checks/csp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAsC,MAAM,kBAAkB,CAAA;AAC7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAuB/C,MAAM,YAAY,GAAG,gCAAgC,CAAA;AAErD,SAAS,SAAS,CAAC,MAAqB;IACpC,OAAO,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAA;AAC3B,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,WAAmB,EAAE,cAAsB;IAChF,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;QACtB,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,IAAI,CAAC;QACD,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,MAAM,CAAA;QAElD,OAAO,MAAM,KAAK,cAAc,IAAI,cAAc,KAAK,cAAc,CAAA;IACzE,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAA;IAChB,CAAC;AACL,CAAC;AAED,MAAM,UAAU,YAAY,CACxB,QAA0B,EAC1B,kBAA4B,EAC5B,IAAa,EACb,cAAsB;IAEtB,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,kBAAkB,CAAC,MAAM,EAAE,CAAC;YAClC,OAAO,EAAE,CAAA;QACb,CAAC;QAED,sEAAsE;QACtE,OAAO;YACH,qEAAqE,cAAc,KAAK;gBACpF,yBAAyB,kBAAkB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SAC1F,CAAA;IACL,CAAC;IAED,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAC/B,MAAM,MAAM,GAAa,EAAE,CAAA;QAE3B,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,uDAAuD,MAAM,CAAC,GAAG,EAAE,CAAC,CAAA;YACpF,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC,wDAAwD,MAAM,CAAC,GAAG,EAAE,CAAC,CAAA;YACrF,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YAC7B,sEAAsE;YACtE,gCAAgC;YAChC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,qDAAqD,MAAM,CAAC,GAAG,EAAE,CAAC,CAAA;YAClF,CAAC;QACL,CAAC;aAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACtE,MAAM,CAAC,IAAI,CAAC,2DAA2D,MAAM,CAAC,GAAG,EAAE,CAAC,CAAA;QACxF,CAAC;QAED,OAAO,MAAM,CAAA;IACjB,CAAC,CAAC,CAAA;AACN,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAA0B;IACzD,MAAM,OAAO,GAAG,IAAI,GAAG,EAA0B,CAAA;IACjD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,kBAAkB,EAAE;YACtC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC;YACpD,SAAS;SACZ,CAAC,CAAA;IACN,CAAC;IAED,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE;QACrD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;YACpC,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU;gBAC/B,CAAC,CAAC,GAAG,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,YAAY,EAAE;gBAC7E,CAAC,CAAC,SAAS,CAAC,WAAW,CAAA;YAC3B,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;YAE1E,OAAO,CACH,gBAAgB,SAAS,CAAC,UAAU,IAAI,SAAS,IAAI;gBACrD,iBAAiB,SAAS,CAAC,WAAW,IAAI;gBAC1C,eAAe,MAAM,IAAI;gBACzB,oBAAoB,SAAS,CAAC,WAAW,GAAG,MAAM,EAAE,CACvD,CAAA;QACL,CAAC,CAAC,CAAA;QAEF,OAAO,GAAG,SAAS,KAAK,KAAK,CAAC,MAAM,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;IAClE,CAAC,CAAC,CAAA;AACN,CAAC;AAED,MAAM,OAAO,WAAW;IASC;IARJ,cAAc,CAAQ;IACtB,IAAI,CAAS;IACb,gBAAgB,GAAa,EAAE,CAAA;IAC/B,gBAAgB,GAAqB,EAAE,CAAA;IACvC,UAAU,GAAmB,EAAE,CAAA;IACxC,SAAS,GAAG,KAAK,CAAA;IAEzB,YACqB,OAAuB,EACxC,UAAuD,EAAE;QADxC,YAAO,GAAP,OAAO,CAAgB;QAGxC,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAA;QACjC,IAAI,CAAC,cAAc;YACf,OAAO,CAAC,cAAc,IAAI,MAAM,CAAC,GAAG,EAAE,cAAc,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAA;QAC7F,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,EAAE,IAAI,IAAI,KAAK,CAAA;IACzD,CAAC;IAED,KAAK,CAAC,OAAO;QACT,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,SAAuB,EAAE,EAAE;YAChF,IAAI,wBAAwB,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;gBACvE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACnC,CAAC;QACL,CAAC,CAAC,CAAA;QAEF,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACnD,QAAQ,CAAC,gBAAgB,CAAC,yBAAyB,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC3D,MAAM,MAAM,GACR,UAGH,CAAC,iBAAiB,CAAC,CAAA;gBAEpB,IAAI,CAAC,MAAM,EAAE,CAAC;oBACV,OAAM;gBACV,CAAC;gBAED,KAAK,MAAM,CAAC;oBACR,UAAU,EAAE,KAAK,CAAC,UAAU;oBAC5B,YAAY,EAAE,KAAK,CAAC,YAAY;oBAChC,WAAW,EAAE,KAAK,CAAC,WAAW;oBAC9B,WAAW,EAAE,KAAK,CAAC,WAAW;oBAC9B,kBAAkB,EAAE,KAAK,CAAC,kBAAkB;oBAC5C,UAAU,EAAE,KAAK,CAAC,UAAU;oBAC5B,cAAc,EAAE,KAAK,CAAC,cAAc;oBACpC,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,UAAU,EAAE,KAAK,CAAC,UAAU;oBAC5B,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;iBAC7C,CAAC,CAAA;YACN,CAAC,CAAC,CAAA;QACN,CAAC,EAAE,YAAY,CAAC,CAAA;QAEhB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;YACnC,IAAI,UAAU,KAAK,OAAO,CAAC,YAAY,EAAE,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;gBAChF,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;YAC7C,CAAC;QACL,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAA;YAClC,MAAM,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,CAAA;YAEjD,IACI,UAAU,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC,YAAY,EAAE;gBAChD,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG;gBACvB,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG;gBACxB,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC;gBAChD,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EACxC,CAAC;gBACC,OAAM;YACV,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACvB,QAAQ,EAAE,OAAO,CAAC,yBAAyB,CAAC,IAAI,IAAI;gBACpD,UAAU,EAAE,OAAO,CAAC,qCAAqC,CAAC,IAAI,IAAI;gBAClE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE;aACtB,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,QAAmB,EAAE,KAAK,GAAG,YAAY;QAC9D,4EAA4E;QAC5E,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACX,gFAAgF;gBAC5E,mEAAmE,CAC1E,CAAA;QACL,CAAC;QAED,sEAAsE;QACtE,sEAAsE;QACtE,MAAM,OAAO,CAAC,GAAG,CACb,IAAI,CAAC,OAAO;aACP,KAAK,EAAE;aACP,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;aAClC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CACrD,CAAA;QAED,MAAM,MAAM,GAAG;YACX,GAAG,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC;YAC7F,GAAG,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;SACzC,CAAA;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,EAAE,CAAC;YAChC,MAAM,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,EAAE;gBACnC,IAAI,EAAE,MAAM,CAAC,IAAI,CACb,IAAI,CAAC,SAAS,CACV;oBACI,cAAc,EAAE,IAAI,CAAC,cAAc;oBACnC,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;oBACvC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;oBACvC,UAAU,EAAE,IAAI,CAAC,UAAU;iBAC9B,EACD,IAAI,EACJ,CAAC,CACJ,CACJ;gBACD,WAAW,EAAE,kBAAkB;aAClC,CAAC,CAAA;QACN,CAAC;QAED,MAAM,CAAC,MAAM,EAAE,+BAA+B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IACxF,CAAC;IAEO,gBAAgB,CAAC,GAAW;QAChC,IAAI,CAAC;YACD,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,CAAA;QACtD,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,KAAK,CAAA;QAChB,CAAC;IACL,CAAC;CACJ"}

package/dist/checks/screenshot.d.ts

@@ -0,0 +1,18 @@
+import { Locator, Page, PageAssertionsToHaveScreenshotOptions } from '@playwright/test';
+export declare function buildHideStyles(selectors: string[]): string;
+/**
+ * takeScreenshot already waits; call this when you interact and then assert
+ * without one, such as an accessibility scan after opening an accordion.
+ */
+export declare function waitForAnimations(page: Page, selector?: string, timeout?: number): Promise<void>;
+export declare function loadLazyElements(page: Page): Promise<void>;
+export declare function resolveScreenshotTarget(target: Page | Locator, include?: string): {
+    shot: Page | Locator;
+    wholePage: boolean;
+};
+export interface ScreenshotOptions extends PageAssertionsToHaveScreenshotOptions {
+    /** Shoot only this element. */
+    include?: string;
+}
+export declare function takeScreenshot(target: Page | Locator, name: string, options?: ScreenshotOptions): Promise<void>;
+//# sourceMappingURL=screenshot.d.ts.map

package/dist/checks/screenshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../src/checks/screenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,OAAO,EAAE,IAAI,EAAE,qCAAqC,EAAE,MAAM,kBAAkB,CAAA;AAW/F,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAM3D;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,SAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAsBpG;AAID,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAMhE;AA6DD,wBAAgB,uBAAuB,CACnC,MAAM,EAAE,IAAI,GAAG,OAAO,EACtB,OAAO,CAAC,EAAE,MAAM,GACjB;IAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAM9C;AAED,MAAM,WAAW,iBAAkB,SAAQ,qCAAqC;IAC5E,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,wBAAsB,cAAc,CAChC,MAAM,EAAE,IAAI,GAAG,OAAO,EACtB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAChC,OAAO,CAAC,IAAI,CAAC,CA6Bf"}

package/dist/checks/screenshot.js

@@ -0,0 +1,125 @@
+import { expect } from '@playwright/test';
+import { getToolkitConfig } from '../config.js';
+const FREEZE_STYLES = `* {
+    animation-duration: 0s !important;
+    transition-duration: 0s !important;
+    transition-delay: 0s !important;
+    contain-intrinsic-size: none !important;
+    content-visibility: visible !important;
+}`;
+export function buildHideStyles(selectors) {
+    if (selectors.length === 0) {
+        return '';
+    }
+    return `${selectors.join(', ')} { visibility: hidden !important; }`;
+}
+/**
+ * takeScreenshot already waits; call this when you interact and then assert
+ * without one, such as an accessibility scan after opening an accordion.
+ */
+export async function waitForAnimations(page, selector, timeout = 5000) {
+    await page.evaluate(async ({ selector, timeout }) => {
+        const timeoutPromise = new Promise((resolve) => setTimeout(resolve, timeout));
+        const root = selector ? document.querySelector(selector) : document.body;
+        const waitForAll = async () => {
+            const animations = root?.getAnimations({ subtree: true }) ?? [];
+            if (animations.length > 0) {
+                await Promise.race([
+                    Promise.all(animations.map((animation) => animation.finished.catch(() => { }))),
+                    timeoutPromise,
+                ]);
+            }
+        };
+        // Twice: finishing the first round can start the animations it was chaining.
+        await waitForAll();
+        await waitForAll();
+    }, { selector, timeout });
+}
+// fullPage captures past the viewport instead of scrolling to it, so a lazy
+// element below the fold never starts loading at all.
+export async function loadLazyElements(page) {
+    await page.evaluate(() => document
+        .querySelectorAll('[loading="lazy"]')
+        .forEach((element) => (element.loading = 'eager')));
+}
+async function waitForImagesDecoded(page, timeout = 15000) {
+    await page.evaluate(async (timeout) => {
+        const images = Array.from(document.querySelectorAll('img'));
+        const settle = (image) => new Promise((resolve) => {
+            const finish = async () => {
+                await image.decode().catch(() => { });
+                resolve();
+            };
+            if (image.complete) {
+                void finish();
+                return;
+            }
+            image.addEventListener('load', () => void finish(), { once: true });
+            image.addEventListener('error', () => resolve(), { once: true });
+        });
+        const timeoutPromise = new Promise((resolve) => setTimeout(resolve, timeout));
+        await Promise.race([Promise.all(images.map(settle)), timeoutPromise]);
+        await new Promise((resolve) => requestAnimationFrame(() => requestAnimationFrame(() => resolve())));
+    }, timeout);
+}
+/**
+ * Finishes the `media="print"` async-CSS trick by hand. A stylesheet loaded as
+ * print and swapped to `all` on load is not applied while it is still print, so
+ * a screenshot taken mid-swap captures the page unstyled.
+ */
+async function applyDeferredStylesheets(page) {
+    await page.evaluate(() => new Promise((resolve) => {
+        const twoFrames = () => requestAnimationFrame(() => requestAnimationFrame(() => resolve()));
+        const links = Array.from(document.querySelectorAll('link[media="print"]'));
+        if (links.length === 0) {
+            twoFrames();
+            return;
+        }
+        const settled = links.map((link) => new Promise((done) => {
+            if (link.sheet) {
+                link.media = 'all';
+                done();
+                return;
+            }
+            link.addEventListener('load', () => done(), { once: true });
+            link.addEventListener('error', () => done(), { once: true });
+            link.media = 'all';
+        }));
+        // Resolving on rejection too: a stylesheet that never settles must
+        // cost a frame, not the whole screenshot.
+        Promise.all(settled).then(twoFrames, resolve);
+    }));
+}
+export function resolveScreenshotTarget(target, include) {
+    if (undefined !== include) {
+        return { shot: target.locator(include), wholePage: false };
+    }
+    return { shot: target, wholePage: !('page' in target) };
+}
+export async function takeScreenshot(target, name, options = {}) {
+    const config = getToolkitConfig();
+    const { include, ...screenshotOptions } = options;
+    const { shot, wholePage } = resolveScreenshotTarget(target, include);
+    const page = 'page' in target ? target.page() : target;
+    await page.addStyleTag({ content: FREEZE_STYLES });
+    const hideStyles = buildHideStyles(config.hideBeforeScreenshot ?? []);
+    if (hideStyles) {
+        await page.addStyleTag({ content: hideStyles });
+    }
+    await applyDeferredStylesheets(page);
+    await page.evaluate(() => document.fonts.ready);
+    await waitForAnimations(page, undefined, 3000);
+    await loadLazyElements(page);
+    await waitForImagesDecoded(page);
+    // Playwright creates a missing reference itself and has --update-snapshots
+    // for the rest; hand-building the snapshot path got the platform suffix
+    // wrong off Linux.
+    await expect(shot).toHaveScreenshot(`${name}.png`, {
+        animations: 'disabled',
+        timeout: 15000,
+        threshold: config.screenshot?.threshold ?? 0.2,
+        ...(wholePage ? { fullPage: true } : {}),
+        ...screenshotOptions,
+    });
+}
+//# sourceMappingURL=screenshot.js.map

package/dist/checks/screenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../../src/checks/screenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAwD,MAAM,kBAAkB,CAAA;AAC/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAE/C,MAAM,aAAa,GAAG;;;;;;EAMpB,CAAA;AAEF,MAAM,UAAU,eAAe,CAAC,SAAmB;IAC/C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,CAAA;IACb,CAAC;IAED,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,qCAAqC,CAAA;AACvE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,IAAU,EAAE,QAAiB,EAAE,OAAO,GAAG,IAAI;IACjF,MAAM,IAAI,CAAC,QAAQ,CACf,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE;QAC5B,MAAM,cAAc,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;QACnF,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAA;QAExE,MAAM,UAAU,GAAG,KAAK,IAAI,EAAE;YAC1B,MAAM,UAAU,GAAG,IAAI,EAAE,aAAa,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,CAAA;YAC/D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAM,OAAO,CAAC,IAAI,CAAC;oBACf,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC;oBAC9E,cAAc;iBACjB,CAAC,CAAA;YACN,CAAC;QACL,CAAC,CAAA;QAED,6EAA6E;QAC7E,MAAM,UAAU,EAAE,CAAA;QAClB,MAAM,UAAU,EAAE,CAAA;IACtB,CAAC,EACD,EAAE,QAAQ,EAAE,OAAO,EAAE,CACxB,CAAA;AACL,CAAC;AAED,4EAA4E;AAC5E,sDAAsD;AACtD,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,IAAU;IAC7C,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CACrB,QAAQ;SACH,gBAAgB,CAAuC,kBAAkB,CAAC;SAC1E,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,CACzD,CAAA;AACL,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,IAAU,EAAE,OAAO,GAAG,KAAK;IAC3D,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QAClC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;QAC3D,MAAM,MAAM,GAAG,CAAC,KAAuB,EAAE,EAAE,CACvC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAC1B,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE;gBACtB,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;gBACpC,OAAO,EAAE,CAAA;YACb,CAAC,CAAA;YACD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACjB,KAAK,MAAM,EAAE,CAAA;gBACb,OAAM;YACV,CAAC;YACD,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;YACnE,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;QACpE,CAAC,CAAC,CAAA;QACN,MAAM,cAAc,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;QACnF,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAA;QACrE,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAC7G,CAAC,EAAE,OAAO,CAAC,CAAA;AACf,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,wBAAwB,CAAC,IAAU;IAC9C,MAAM,IAAI,CAAC,QAAQ,CACf,GAAG,EAAE,CACD,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QAC1B,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;QAC3F,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAkB,qBAAqB,CAAC,CAAC,CAAA;QAC3F,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,SAAS,EAAE,CAAA;YACX,OAAM;QACV,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CACrB,CAAC,IAAI,EAAE,EAAE,CACL,IAAI,OAAO,CAAO,CAAC,IAAI,EAAE,EAAE;YACvB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;gBAClB,IAAI,EAAE,CAAA;gBACN,OAAM;YACV,CAAC;YACD,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;YAC3D,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;YAC5D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACtB,CAAC,CAAC,CACT,CAAA;QAED,mEAAmE;QACnE,0CAA0C;QAC1C,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IACjD,CAAC,CAAC,CACT,CAAA;AACL,CAAC;AAED,MAAM,UAAU,uBAAuB,CACnC,MAAsB,EACtB,OAAgB;IAEhB,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;QACxB,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;IAC9D,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,CAAA;AAC3D,CAAC;AAOD,MAAM,CAAC,KAAK,UAAU,cAAc,CAChC,MAAsB,EACtB,IAAY,EACZ,UAA6B,EAAE;IAE/B,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAA;IACjC,MAAM,EAAE,OAAO,EAAE,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAA;IACjD,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpE,MAAM,IAAI,GAAG,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAA;IAEtD,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAA;IAElD,MAAM,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAA;IACrE,IAAI,UAAU,EAAE,CAAC;QACb,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,wBAAwB,CAAC,IAAI,CAAC,CAAA;IACpC,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAC/C,MAAM,iBAAiB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IAC9C,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC5B,MAAM,oBAAoB,CAAC,IAAI,CAAC,CAAA;IAEhC,2EAA2E;IAC3E,wEAAwE;IACxE,mBAAmB;IACnB,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,GAAG,IAAI,MAAM,EAAE;QAC/C,UAAU,EAAE,UAAU;QACtB,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,MAAM,CAAC,UAAU,EAAE,SAAS,IAAI,GAAG;QAC9C,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,GAAG,iBAAiB;KACvB,CAAC,CAAA;AACN,CAAC"}