@plan2net/typo3-playwright-toolkit 0.1.0

package/dist/config.d.ts

@@ -0,0 +1,100 @@
+import type { BrowserContext } from '@playwright/test';
+import type { ContentBuilderInterface } from './types/content-builder.js';
+export type ContentTypeConstructor = new () => ContentBuilderInterface;
+export interface ToolkitScreenshotConfig {
+    threshold?: number;
+    maxDiffPixelRatio?: number;
+}
+export interface ToolkitAccessibilityConfig {
+    /**
+     * Projects to scan; omit for all. Worth narrowing: axe evaluates the rendered
+     * state, so desktop and mobile surface different violations while a tablet
+     * project or a second engine adds cost without coverage.
+     */
+    projects?: string[];
+    /** Overrides DEFAULT_SCAN_TAGS. */
+    tags?: string[];
+    disabledRules?: string[];
+    /**
+     * Scan after every test that opened a page, instead of calling
+     * runAccessibilityScan yourself. A test that already failed is left alone.
+     */
+    auto?: boolean;
+}
+export interface ToolkitCspConfig {
+    /**
+     * `any` (default) requires some policy header, `report-only` also refuses an
+     * enforcing one, `enforced` requires it and tolerates report-only alongside.
+     */
+    mode?: 'any' | 'report-only' | 'enforced';
+    /** Defaults to the origin of testingURL. */
+    expectedOrigin?: string;
+}
+/** All three are absolute, and both writable ones must sit inside consumerRoot. */
+export interface ToolkitPaths {
+    consumerRoot: string;
+    stateDir: string;
+    /** TYPO3 session directory; teardown deletes stale entries from it. */
+    sessionDir: string;
+}
+/** Every default lives in SETUP_DEFAULTS (ensure-state.ts), which is exported. */
+export interface ToolkitSetupConfig {
+    /** One setup attempt. */
+    attemptTimeoutMs?: number;
+    /** Whole wait for a scenario, lock waiting plus every attempt. */
+    waitTimeoutMs?: number;
+    /** Total attempts, so 2 means one retry. */
+    attempts?: number;
+    /** Silence after which a holder's lock may be taken. */
+    lockStaleMs?: number;
+    /** Gap between polls while waiting. */
+    pollMs?: number;
+}
+export interface ToolkitCleanupConfig {
+    /** Age after which unrecorded databases and abandoned runs are reclaimed. */
+    orphanAgeMs?: number;
+    /** Fail the run when a test database survives teardown. Defaults to true in CI. */
+    failOnLeak?: boolean;
+    /** Which databases to keep when something failed. Default `failed`. */
+    preserveOnFailure?: 'failed' | 'all' | 'none';
+}
+export interface ToolkitConfig {
+    /**
+     * The only URL the toolkit uses: the origin that serves the Testing context.
+     * Relative navigation, the test API and the builders all resolve against it,
+     * because the per-test database exists nowhere else. A bare origin — no path,
+     * query, fragment or credentials; `defineToolkitConfig` refuses anything else.
+     */
+    testingURL: string;
+    /** Screenshot tolerances merged into the base Playwright config + Screenshot helper. */
+    screenshot?: ToolkitScreenshotConfig;
+    /**
+     * Your own content-type builders, keyed by CType. Core CTypes (text,
+     * textmedia, bullets, table, …) ship with the toolkit and need no entry; a key
+     * matching one of them replaces the shipped builder.
+     */
+    contentTypes?: Record<string, ContentTypeConstructor>;
+    /** Selectors hidden before each screenshot. Defaults to []. */
+    hideBeforeScreenshot?: string[];
+    /**
+     * Runs on every context a scenario test uses, after the toolkit's own headers are
+     * in place. Where a consumer stubs a third-party script or adds its own routes.
+     */
+    prepareContext?: (context: BrowserContext) => Promise<void> | void;
+    /** Relocatability paths — never derived from __dirname. */
+    paths: ToolkitPaths;
+    /** Pins the run ID. Normally omitted — taken from PW_RUN_ID or minted. */
+    runId?: string;
+    cleanup?: ToolkitCleanupConfig;
+    accessibility?: ToolkitAccessibilityConfig;
+    csp?: ToolkitCspConfig;
+    setup?: ToolkitSetupConfig;
+}
+/** What a consumer writes: only consumerRoot is required, the other two are derived from it. */
+export type ToolkitConfigInput = Omit<ToolkitConfig, 'paths'> & {
+    paths: Pick<ToolkitPaths, 'consumerRoot'> & Partial<ToolkitPaths>;
+};
+export declare function defineToolkitConfig(config: ToolkitConfigInput): ToolkitConfig;
+export declare function setToolkitConfig(config: ToolkitConfig): void;
+export declare function getToolkitConfig(): ToolkitConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA;AAKzE,MAAM,MAAM,sBAAsB,GAAG,UAAU,uBAAuB,CAAA;AAEtE,MAAM,WAAW,uBAAuB;IACpC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED,MAAM,WAAW,0BAA0B;IACvC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,mCAAmC;IACnC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,aAAa,GAAG,UAAU,CAAA;IACzC,4CAA4C;IAC5C,cAAc,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED,mFAAmF;AACnF,MAAM,WAAW,YAAY;IACzB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAA;CACrB;AAED,kFAAkF;AAClF,MAAM,WAAW,kBAAkB;IAC/B,yBAAyB;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,kEAAkE;IAClE,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACjC,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mFAAmF;IACnF,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,uEAAuE;IACvE,iBAAiB,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAA;CAChD;AAED,MAAM,WAAW,aAAa;IAC1B;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB,wFAAwF;IACxF,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;IACrD,+DAA+D;IAC/D,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAClE,2DAA2D;IAC3D,KAAK,EAAE,YAAY,CAAA;IACnB,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,oBAAoB,CAAA;IAC9B,aAAa,CAAC,EAAE,0BAA0B,CAAA;IAC1C,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,KAAK,CAAC,EAAE,kBAAkB,CAAA;CAC7B;AAED,gGAAgG;AAChG,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG;IAC5D,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,cAAc,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;CACpE,CAAA;AAqDD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,aAAa,CAW7E;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAE5D;AAED,wBAAgB,gBAAgB,IAAI,aAAa,CAQhD"}

package/dist/config.js

@@ -0,0 +1,68 @@
+import * as path from 'path';
+import { registerContentTypes } from './builders/content-factory.js';
+import { resolveRunId } from './state/run-id.js';
+import { assertDeletableDirectory } from './state/safe-paths.js';
+let activeConfig;
+function resolvePaths(paths) {
+    if (!path.isAbsolute(paths.consumerRoot)) {
+        throw new Error(`[typo3-playwright-toolkit] paths.consumerRoot must be an absolute path, got "${paths.consumerRoot}".`);
+    }
+    const resolved = {
+        consumerRoot: paths.consumerRoot,
+        stateDir: paths.stateDir ?? path.join(paths.consumerRoot, '.test-state'),
+        sessionDir: paths.sessionDir ?? path.join(paths.consumerRoot, 'var/session'),
+    };
+    assertDeletableDirectory('stateDir', resolved.stateDir, resolved.consumerRoot);
+    assertDeletableDirectory('sessionDir', resolved.sessionDir, resolved.consumerRoot);
+    return resolved;
+}
+function resolveTestingURL(testingURL) {
+    const refuse = (reason) => {
+        throw new Error(`[typo3-playwright-toolkit] testingURL ${reason}, got "${testingURL}".`);
+    };
+    let url;
+    try {
+        url = new URL(testingURL);
+    }
+    catch {
+        return refuse('must be an absolute URL, such as https://example-testing.ddev.site');
+    }
+    if ('https:' !== url.protocol && 'http:' !== url.protocol) {
+        return refuse('must be http or https');
+    }
+    if (url.username || url.password) {
+        return refuse('must carry no credentials');
+    }
+    if (url.search || url.hash) {
+        return refuse('must carry no query string or fragment');
+    }
+    // The test API answers at /typo3/test-api/…, so a subdirectory install cannot
+    // work and dropping the path silently would hide that.
+    if (!/^\/+$/.test(url.pathname)) {
+        return refuse('must be a bare origin, with no path');
+    }
+    return url.origin;
+}
+export function defineToolkitConfig(config) {
+    // Resolved here: this runs in the main process before workers are forked.
+    const resolved = {
+        ...config,
+        testingURL: resolveTestingURL(config.testingURL),
+        paths: resolvePaths(config.paths),
+        runId: resolveRunId(config.runId),
+    };
+    setToolkitConfig(resolved);
+    registerContentTypes(config.contentTypes ?? {});
+    return resolved;
+}
+export function setToolkitConfig(config) {
+    activeConfig = config;
+}
+export function getToolkitConfig() {
+    if (!activeConfig) {
+        throw new Error('[typo3-playwright-toolkit] No toolkit config set. Call defineToolkitConfig(...) ' +
+            'in your Playwright config before the toolkit modules run.');
+    }
+    return activeConfig;
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAG5B,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAA;AAyGhE,IAAI,YAAuC,CAAA;AAE3C,SAAS,YAAY,CAAC,KAAkC;IACpD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CACX,gFAAgF,KAAK,CAAC,YAAY,IAAI,CACzG,CAAA;IACL,CAAC;IAED,MAAM,QAAQ,GAAG;QACb,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,CAAC;QACxE,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,CAAC;KAC/E,CAAA;IAED,wBAAwB,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;IAC9E,wBAAwB,CAAC,YAAY,EAAE,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;IAElF,OAAO,QAAQ,CAAA;AACnB,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAkB;IACzC,MAAM,MAAM,GAAG,CAAC,MAAc,EAAS,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,yCAAyC,MAAM,UAAU,UAAU,IAAI,CAAC,CAAA;IAC5F,CAAC,CAAA;IAED,IAAI,GAAQ,CAAA;IACZ,IAAI,CAAC;QACD,GAAG,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAA;IAC7B,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,MAAM,CAAC,oEAAoE,CAAC,CAAA;IACvF,CAAC;IAED,IAAI,QAAQ,KAAK,GAAG,CAAC,QAAQ,IAAI,OAAO,KAAK,GAAG,CAAC,QAAQ,EAAE,CAAC;QACxD,OAAO,MAAM,CAAC,uBAAuB,CAAC,CAAA;IAC1C,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC,2BAA2B,CAAC,CAAA;IAC9C,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC,wCAAwC,CAAC,CAAA;IAC3D,CAAC;IACD,8EAA8E;IAC9E,uDAAuD;IACvD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED,OAAO,GAAG,CAAC,MAAM,CAAA;AACrB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,MAA0B;IAC1D,0EAA0E;IAC1E,MAAM,QAAQ,GAAkB;QAC5B,GAAG,MAAM;QACT,UAAU,EAAE,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC;QAChD,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC;QACjC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC;KACpC,CAAA;IACD,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAC1B,oBAAoB,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC,CAAA;IAC/C,OAAO,QAAQ,CAAA;AACnB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAqB;IAClD,YAAY,GAAG,MAAM,CAAA;AACzB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACX,kFAAkF;YAC9E,2DAA2D,CAClE,CAAA;IACL,CAAC;IACD,OAAO,YAAY,CAAA;AACvB,CAAC"}

package/dist/contract.d.ts

@@ -0,0 +1,9 @@
+import type { ToolkitConfig } from './config.js';
+export declare const TEST_ID_HEADER = "X-Playwright-Test-Id";
+export declare const TEST_ID_PATTERN: RegExp;
+export declare function generateTestId(): string;
+/** Both headers, for one explicit request. */
+export declare function toolkitHeaders(config: ToolkitConfig, testId: string): Record<string, string>;
+/** What routing and the request client add. No secret: that stays explicit. */
+export declare function browserHeaders(testId: string): Record<string, string>;
+//# sourceMappingURL=contract.d.ts.map

package/dist/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAGhD,eAAO,MAAM,cAAc,yBAAyB,CAAA;AACpD,eAAO,MAAM,eAAe,QAAmB,CAAA;AAK/C,wBAAgB,cAAc,IAAI,MAAM,CAMvC;AAED,8CAA8C;AAC9C,wBAAgB,cAAc,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAK5F;AAED,+EAA+E;AAC/E,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAErE"}

package/dist/contract.js

@@ -0,0 +1,25 @@
+import { randomInt } from 'crypto';
+import { SECRET_HEADER, resolveApiSecret } from './http/api-secret.js';
+export const TEST_ID_HEADER = 'X-Playwright-Test-Id';
+export const TEST_ID_PATTERN = /^[A-Z0-9]{16}$/;
+const TEST_ID_ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+const TEST_ID_LENGTH = 16;
+export function generateTestId() {
+    let testId = '';
+    for (let index = 0; index < TEST_ID_LENGTH; index++) {
+        testId += TEST_ID_ALPHABET.charAt(randomInt(TEST_ID_ALPHABET.length));
+    }
+    return testId;
+}
+/** Both headers, for one explicit request. */
+export function toolkitHeaders(config, testId) {
+    return {
+        ...browserHeaders(testId),
+        [SECRET_HEADER]: resolveApiSecret(config),
+    };
+}
+/** What routing and the request client add. No secret: that stays explicit. */
+export function browserHeaders(testId) {
+    return { [TEST_ID_HEADER]: testId };
+}
+//# sourceMappingURL=contract.js.map

package/dist/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAElC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEtE,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAA;AACpD,MAAM,CAAC,MAAM,eAAe,GAAG,gBAAgB,CAAA;AAE/C,MAAM,gBAAgB,GAAG,sCAAsC,CAAA;AAC/D,MAAM,cAAc,GAAG,EAAE,CAAA;AAEzB,MAAM,UAAU,cAAc;IAC1B,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,cAAc,EAAE,KAAK,EAAE,EAAE,CAAC;QAClD,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAA;IACzE,CAAC;IACD,OAAO,MAAM,CAAA;AACjB,CAAC;AAED,8CAA8C;AAC9C,MAAM,UAAU,cAAc,CAAC,MAAqB,EAAE,MAAc;IAChE,OAAO;QACH,GAAG,cAAc,CAAC,MAAM,CAAC;QACzB,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC;KAC5C,CAAA;AACL,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,cAAc,CAAC,MAAc;IACzC,OAAO,EAAE,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;AACvC,CAAC"}

package/dist/global-setup.d.ts

@@ -0,0 +1,20 @@
+import { type ToolkitConfig } from './config.js';
+export declare function preflightTestId(config: ToolkitConfig): string;
+/** The oldest extension this toolkit can talk to. */
+export declare const MINIMUM_API_VERSION = 1;
+/**
+ * Sends no test ID, and runs before any test ID exists. A request with one makes
+ * the extension create a database, and an extension this old has no endpoint to
+ * delete it again.
+ */
+export declare function verifyApiVersion(config: ToolkitConfig, options?: {
+    fetchImpl?: typeof fetch;
+}): Promise<number>;
+export declare function runHealthCheck(testingURL: string, options?: {
+    testId?: string;
+    secret?: string;
+    fetchImpl?: typeof fetch;
+}): Promise<void>;
+declare function globalSetup(): Promise<void>;
+export default globalSetup;
+//# sourceMappingURL=global-setup.d.ts.map

package/dist/global-setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-setup.d.ts","sourceRoot":"","sources":["../src/global-setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AAMlE,wBAAgB,eAAe,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,CAK7D;AAED,qDAAqD;AACrD,eAAO,MAAM,mBAAmB,IAAI,CAAA;AAuCpC;;;;GAIG;AACH,wBAAsB,gBAAgB,CAClC,MAAM,EAAE,aAAa,EACrB,OAAO,GAAE;IAAE,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;CAAO,GAC3C,OAAO,CAAC,MAAM,CAAC,CA0BjB;AAED,wBAAsB,cAAc,CAChC,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;CAAO,GAC7E,OAAO,CAAC,IAAI,CAAC,CAoCf;AAED,iBAAe,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAe1C;AAED,eAAe,WAAW,CAAA"}

package/dist/global-setup.js

@@ -0,0 +1,103 @@
+import { getToolkitConfig } from './config.js';
+import { prepareRun } from './state/run-namespace.js';
+import { TEST_ID_HEADER, generateTestId } from './contract.js';
+import { SECRET_HEADER, resolveApiSecret } from './http/api-secret.js';
+import { registerSetupAttempt } from './state/attempt-registry.js';
+export function preflightTestId(config) {
+    const testId = generateTestId();
+    registerSetupAttempt(config, 'preflight', testId);
+    return testId;
+}
+/** The oldest extension this toolkit can talk to. */
+export const MINIMUM_API_VERSION = 1;
+/**
+ * The body is read whatever the status: an unhealthy site still reports its
+ * version, and "too old" is a different problem from "unhealthy".
+ */
+async function readHealth(healthUrl, headers, doFetch, unreachable) {
+    let response;
+    try {
+        response = await doFetch(healthUrl, {
+            method: 'GET',
+            signal: AbortSignal.timeout(Number(process.env.PW_HEALTH_TIMEOUT_MS) || 5000),
+            headers,
+        });
+    }
+    catch (error) {
+        throw new Error(unreachable(error instanceof Error ? error.message : String(error)));
+    }
+    try {
+        return { status: response.status, ok: response.ok, body: (await response.json()) };
+    }
+    catch {
+        throw new Error(`Preflight failed: ${healthUrl} returned non-JSON (status ${response.status}). ` +
+            'Check that the Playwright test API extension is loaded in the Testing context.');
+    }
+}
+/**
+ * Sends no test ID, and runs before any test ID exists. A request with one makes
+ * the extension create a database, and an extension this old has no endpoint to
+ * delete it again.
+ */
+export async function verifyApiVersion(config, options = {}) {
+    const healthUrl = `${config.testingURL}/typo3/test-api/health`;
+    const { body } = await readHealth(healthUrl, { [SECRET_HEADER]: resolveApiSecret(config) }, options.fetchImpl ?? fetch, (reason) => `Preflight failed: could not read the API version from ${healthUrl} (${reason}).`);
+    const reported = body.api;
+    if (typeof reported !== 'number' || reported < MINIMUM_API_VERSION) {
+        throw new Error([
+            `Preflight failed: the TYPO3 extension is too old for this toolkit.`,
+            `  needs api ${MINIMUM_API_VERSION} or newer, got ${JSON.stringify(reported)}`,
+            '',
+            'Upgrade it with:  composer update plan2net/playwright-toolkit',
+            '',
+            'Continuing would create test databases the extension has no endpoint',
+            'to clean up again.',
+        ].join('\n'));
+    }
+    return reported;
+}
+export async function runHealthCheck(testingURL, options = {}) {
+    const healthUrl = `${testingURL}/typo3/test-api/health`;
+    const headers = {};
+    if (options.testId) {
+        headers[TEST_ID_HEADER] = options.testId;
+    }
+    if (options.secret) {
+        headers[SECRET_HEADER] = options.secret;
+    }
+    const { status, ok, body } = await readHealth(healthUrl, headers, options.fetchImpl ?? fetch, (reason) => [
+        `Preflight failed: ${healthUrl} unreachable (${reason}).`,
+        'Likely causes:',
+        '  - The test environment is not running',
+        '  - The testing site configuration is missing',
+    ].join('\n'));
+    if (ok && body.ok) {
+        return;
+    }
+    const failed = Object.entries(body.checks ?? {})
+        .filter(([, check]) => !check.ok)
+        .map(([name, check]) => `  ✗ ${name}: ${check.detail}`)
+        .join('\n');
+    throw new Error([
+        `Preflight failed (HTTP ${status}):`,
+        failed || '  (no per-check detail returned — investigate the endpoint response)',
+        '',
+        'Fix the underlying issue then re-run. To bypass for endpoint debugging, set PW_SKIP_HEALTH=1.',
+    ].join('\n'));
+}
+async function globalSetup() {
+    const config = getToolkitConfig();
+    prepareRun(config);
+    if (process.env.PW_SKIP_HEALTH === '1') {
+        return;
+    }
+    // Order matters: verify the engine before minting an ID, or a mismatch leaves
+    // behind a database teardown can no longer reach.
+    await verifyApiVersion(config);
+    await runHealthCheck(config.testingURL, {
+        testId: preflightTestId(config),
+        secret: resolveApiSecret(config),
+    });
+}
+export default globalSetup;
+//# sourceMappingURL=global-setup.js.map

package/dist/global-setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-setup.js","sourceRoot":"","sources":["../src/global-setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAsB,MAAM,aAAa,CAAA;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAElE,MAAM,UAAU,eAAe,CAAC,MAAqB;IACjD,MAAM,MAAM,GAAG,cAAc,EAAE,CAAA;IAC/B,oBAAoB,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;IAEjD,OAAO,MAAM,CAAA;AACjB,CAAC;AAED,qDAAqD;AACrD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAA;AAQpC;;;GAGG;AACH,KAAK,UAAU,UAAU,CACrB,SAAiB,EACjB,OAA+B,EAC/B,OAAqB,EACrB,WAAuC;IAEvC,IAAI,QAAkB,CAAA;IACtB,IAAI,CAAC;QACD,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,IAAI,CAAC;YAC7E,OAAO;SACV,CAAC,CAAA;IACN,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxF,CAAC;IAED,IAAI,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA2B,EAAE,CAAA;IAChH,CAAC;IAAC,MAAM,CAAC;QACL,MAAM,IAAI,KAAK,CACX,qBAAqB,SAAS,8BAA8B,QAAQ,CAAC,MAAM,KAAK;YAC5E,gFAAgF,CACvF,CAAA;IACL,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAClC,MAAqB,EACrB,UAAwC,EAAE;IAE1C,MAAM,SAAS,GAAG,GAAG,MAAM,CAAC,UAAU,wBAAwB,CAAA;IAE9D,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAC7B,SAAS,EACT,EAAE,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAAE,EAC7C,OAAO,CAAC,SAAS,IAAI,KAAK,EAC1B,CAAC,MAAM,EAAE,EAAE,CAAC,yDAAyD,SAAS,KAAK,MAAM,IAAI,CAChG,CAAA;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAA;IAEzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,GAAG,mBAAmB,EAAE,CAAC;QACjE,MAAM,IAAI,KAAK,CACX;YACI,oEAAoE;YACpE,eAAe,mBAAmB,kBAAkB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;YAC9E,EAAE;YACF,+DAA+D;YAC/D,EAAE;YACF,sEAAsE;YACtE,oBAAoB;SACvB,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAA;IACL,CAAC;IAED,OAAO,QAAQ,CAAA;AACnB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAChC,UAAkB,EAClB,UAA0E,EAAE;IAE5E,MAAM,SAAS,GAAG,GAAG,UAAU,wBAAwB,CAAA;IACvD,MAAM,OAAO,GAA2B,EAAE,CAAA;IAC1C,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,MAAM,CAAA;IAC5C,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,MAAM,CAAA;IAC3C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CACrG;QACI,qBAAqB,SAAS,iBAAiB,MAAM,IAAI;QACzD,gBAAgB;QAChB,yCAAyC;QACzC,+CAA+C;KAClD,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAA;IAED,IAAI,EAAE,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;QAChB,OAAM;IACV,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;SAC3C,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;SAChC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;SACtD,IAAI,CAAC,IAAI,CAAC,CAAA;IAEf,MAAM,IAAI,KAAK,CACX;QACI,0BAA0B,MAAM,IAAI;QACpC,MAAM,IAAI,sEAAsE;QAChF,EAAE;QACF,+FAA+F;KAClG,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAA;AACL,CAAC;AAED,KAAK,UAAU,WAAW;IACtB,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAA;IACjC,UAAU,CAAC,MAAM,CAAC,CAAA;IAElB,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,GAAG,EAAE,CAAC;QACrC,OAAM;IACV,CAAC;IAED,8EAA8E;IAC9E,kDAAkD;IAClD,MAAM,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC9B,MAAM,cAAc,CAAC,MAAM,CAAC,UAAU,EAAE;QACpC,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC;QAC/B,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC;KACnC,CAAC,CAAA;AACN,CAAC;AAED,eAAe,WAAW,CAAA"}

package/dist/global-teardown.d.ts

@@ -0,0 +1,34 @@
+import { type ToolkitConfig } from './config.js';
+import { type CleanupClient } from './http/cleanup-client.js';
+export declare const DEFAULT_ORPHAN_AGE_MS = 86400000;
+export declare function failedScenarioKeys(config: ToolkitConfig): string[];
+export declare function preservedTestIds(config: ToolkitConfig): string[];
+export type PreservePlan = {
+    mode: 'none';
+} | {
+    mode: 'all';
+    reason?: string;
+} | {
+    mode: 'some';
+    testIds: string[];
+    reason?: string;
+};
+export declare function resolvePreservePlan(config: ToolkitConfig, cleanupSwitchedOff: boolean): PreservePlan;
+export interface TeardownOptions {
+    /** Injectable so tests need no site; see httpCleanup for the real one. */
+    cleanup: CleanupClient;
+    preserve: PreservePlan;
+}
+export interface TeardownSummary {
+    dropped: number;
+    /** Test IDs whose database may still exist, so the caller can fail the run. */
+    leaked: string[];
+    preserved: string[];
+}
+/** Only live runs go in `keepTestIds`; an abandoned run's databases are dropped. */
+export declare function sweepOrphans(config: ToolkitConfig, cleanup: CleanupClient, now?: number): Promise<number>;
+export declare function describePreservedRun(config: ToolkitConfig, keptTestIds?: string[], secret?: string, now?: number): string;
+export declare function runTeardown(config: ToolkitConfig, options: TeardownOptions): Promise<TeardownSummary>;
+declare function globalTeardown(): Promise<void>;
+export default globalTeardown;
+//# sourceMappingURL=global-teardown.d.ts.map

package/dist/global-teardown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-teardown.d.ts","sourceRoot":"","sources":["../src/global-teardown.ts"],"names":[],"mappings":"AAEA,OAAO,EAAoB,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AAClE,OAAO,EAAe,KAAK,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAO1E,eAAO,MAAM,qBAAqB,WAAa,CAAA;AAO/C,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,EAAE,CAwBlE;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,EAAE,CAgBhE;AAED,MAAM,MAAM,YAAY,GAClB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1D,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,OAAO,GAAG,YAAY,CAoBpG;AAMD,MAAM,WAAW,eAAe;IAC5B,0EAA0E;IAC1E,OAAO,EAAE,aAAa,CAAA;IACtB,QAAQ,EAAE,YAAY,CAAA;CACzB;AAED,MAAM,WAAW,eAAe;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,+EAA+E;IAC/E,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,SAAS,EAAE,MAAM,EAAE,CAAA;CACtB;AAED,oFAAoF;AACpF,wBAAsB,YAAY,CAC9B,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,aAAa,EACtB,GAAG,GAAE,MAAmB,GACzB,OAAO,CAAC,MAAM,CAAC,CA2DjB;AAED,wBAAgB,oBAAoB,CAChC,MAAM,EAAE,aAAa,EACrB,WAAW,CAAC,EAAE,MAAM,EAAE,EACtB,MAAM,SAAK,EACX,GAAG,GAAE,MAAmB,GACzB,MAAM,CAwBR;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CA8B3G;AA8FD,iBAAe,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAmC7C;AAgBD,eAAe,cAAc,CAAA"}