@gooddata/sdk-e2e-utils 11.60.0-alpha.3 → 11.60.0

package/esm/playwright.d.ts

@@ -1,97 +0,0 @@
-import { type Fixtures, type PlaywrightTestArgs, type PlaywrightTestOptions, type PlaywrightWorkerArgs, type PlaywrightWorkerOptions, type TestDetails, test } from "@playwright/test";
-import { type IGoodmockMapping, type ILeakPattern, type ISecretMapping, type IWorkspaceIdMapping } from "./goodmock.js";
-/**
- * @internal
- */
-export interface IGoodmockOptions {
-    host: string;
-    backendHost: string;
-    getMappingPath: (specFile: string) => string;
-    workspaceIdMappings?: IWorkspaceIdMapping | IWorkspaceIdMapping[];
-    baseUrl?: string;
-    /** Secret values replaced by placeholders in saved recordings (see {@link ISecretMapping}). */
-    secretMappings?: ISecretMapping[];
-    /** Credential-shaped patterns that must never appear in saved recordings (see {@link ILeakPattern}). */
-    leakPatterns?: ILeakPattern[];
-    /** Consumer-supplied redaction hook for domain-specific secrets (see snapshotAndSaveRecording). */
-    sanitizeMappings?: (mappings: IGoodmockMapping[]) => IGoodmockMapping[];
-}
-/**
- * @internal
- */
-export interface IE2eTestDetails extends TestDetails {
-    workspaceSettings?: Record<string, unknown>;
-    additionalWindowProperties?: Record<string, unknown>;
-}
-/**
- * @internal
- */
-export interface IFeatureHubFeature {
-    id: string;
-    key: string;
-    l: boolean;
-    version?: number;
-    type: string;
-    value?: boolean | string | number;
-    strategies?: unknown[];
-    v?: string;
-}
-/**
- * @internal
- */
-export interface IFeatureHubEnvironment {
-    id: string;
-    features: IFeatureHubFeature[];
-}
-/**
- * @internal
- */
-export type BaseTestArgs = PlaywrightTestArgs & PlaywrightTestOptions;
-/**
- * @internal
- */
-export type BaseWorkerArgs = PlaywrightWorkerArgs & PlaywrightWorkerOptions;
-/**
- * @internal
- */
-export interface ICreateTestOptions<T extends Record<string, unknown> = {}, W extends Record<string, unknown> = {}> {
-    goodmock?: IGoodmockOptions;
-    fixtures?: Fixtures<T, W, BaseTestArgs & T, BaseWorkerArgs & W>;
-    featureHubResponse?: IFeatureHubEnvironment[];
-}
-/**
- * @internal
- */
-export interface IDescribeFunction {
-    (suiteName: string, specName: string, fn: () => void): void;
-    (suiteName: string, specName: string, details: IE2eTestDetails, fn: () => void): void;
-    skip: {
-        (suiteName: string, specName: string, fn: () => void): void;
-        (suiteName: string, specName: string, details: IE2eTestDetails, fn: () => void): void;
-    };
-}
-/**
- * @internal
- */
-export type IE2eTest = typeof test & {
-    topLevelDescribe: IDescribeFunction;
-    describe: {
-        (title: string, callback: () => void): void;
-        (title: string, details: IE2eTestDetails, callback: () => void): void;
-        skip: {
-            (title: string, callback: () => void): void;
-            (title: string, details: IE2eTestDetails, callback: () => void): void;
-        };
-        only: (typeof test)["describe"]["only"];
-        configure: (typeof test)["describe"]["configure"];
-        fixme: (typeof test)["describe"]["fixme"];
-        serial: (typeof test)["describe"]["serial"];
-        parallel: (typeof test)["describe"]["parallel"];
-    };
-};
-/**
- * @internal
- * @param options -
- */
-export declare function createTest<T extends Record<string, unknown> = {}, W extends Record<string, unknown> = {}>(options?: ICreateTestOptions<T, W>): IE2eTest;
-//# sourceMappingURL=playwright.d.ts.map

package/esm/playwright.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"playwright.d.ts","sourceRoot":"","sources":["../src/playwright.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,KAAK,QAAQ,EACb,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,WAAW,EAChB,IAAI,EACP,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAEH,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EAM3B,MAAM,eAAe,CAAC;AAIvB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7C,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,mBAAmB,EAAE,CAAC;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+FAA+F;IAC/F,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;IAClC,wGAAwG;IACxG,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;IAC9B,mGAAmG;IACnG,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,gBAAgB,EAAE,CAAC;CAC3E;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAChD,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5C,0BAA0B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,CAAC,EAAE,OAAO,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;IACvB,CAAC,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,kBAAkB,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,qBAAqB,CAAC;AACtE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG,uBAAuB,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,EACtC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE;IAEtC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,GAAG,CAAC,EAAE,cAAc,GAAG,CAAC,CAAC,CAAC;IAChE,kBAAkB,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACjD;AAID;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAC5D,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IACtF,IAAI,EAAE;QACF,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;QAC5D,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;KACzF,CAAC;CACL;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,IAAI,GAAG;IACjC,gBAAgB,EAAE,iBAAiB,CAAC;IACpC,QAAQ,EAAE;QACN,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;QAC5C,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;QACtE,IAAI,EAAE;YACF,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;YAC5C,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;SACzE,CAAC;QACF,IAAI,EAAE,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;QACxC,SAAS,EAAE,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC;QAClD,KAAK,EAAE,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,EAAE,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC5C,QAAQ,EAAE,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,CAAC;KACnD,CAAC;CACL,CAAC;AA8CF;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,EACrG,OAAO,GAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAkC,GACnE,QAAQ,CAsNV"}

package/esm/playwright.js

@@ -1,189 +0,0 @@
-// (C) 2026 GoodData Corporation
-// oxlint-disable typescript-eslint/no-empty-object-type
-import { test, } from "@playwright/test";
-import { GoodmockMode, goodmockMode as getGoodmockMode, loadMappings, resetMappings, snapshotAndSaveRecording, startRecording, } from "./goodmock.js";
-// --- Internal helpers ---
-function parseArgs(detailsOrFn, func) {
-    const hasDetails = typeof detailsOrFn !== "function";
-    return {
-        details: hasDetails ? detailsOrFn : undefined,
-        fn: hasDetails ? func : detailsOrFn,
-    };
-}
-/** Strip custom fields before passing details to Playwright. */
-function toPlaywrightDetails(details) {
-    if (!details)
-        return undefined;
-    // oxlint-disable-next-line @typescript-eslint/no-unused-vars
-    const { workspaceSettings: _ws, additionalWindowProperties: _awp, ...rest } = details;
-    return Object.keys(rest).length > 0 ? rest : undefined;
-}
-/** Inject workspace settings and additional window properties via a single addInitScript. */
-function injectWindowProperties(testInst, settings, awp) {
-    testInst.beforeEach(async ({ page }) => {
-        await page.addInitScript((args) => {
-            const w = window;
-            if (Object.keys(args.s).length > 0) {
-                w["customWorkspaceSettings"] = args.s;
-            }
-            for (const [key, value] of Object.entries(args.a)) {
-                w[key] = value;
-            }
-        }, { s: settings, a: awp });
-    });
-}
-// --- Factory ---
-/**
- * @internal
- * @param options -
- */
-export function createTest(options = {}) {
-    const testInstance = options.fixtures
-        ? test.extend(options.fixtures)
-        : test;
-    // Tracks whether we're inside a topLevelDescribe during synchronous registration.
-    let insideTopLevelDescribe = false;
-    // Stacks track workspace settings / additionalWindowProperties hierarchy during
-    // synchronous describe registration. Each level merges on top of the parent's.
-    // The beforeEach at each level captures the fully-merged snapshot, so the
-    // innermost beforeEach (which runs last) wins.
-    const settingsStack = [];
-    const awpStack = [];
-    function currentSettings() {
-        return settingsStack.length > 0 ? settingsStack[settingsStack.length - 1] : {};
-    }
-    function currentAwp() {
-        return awpStack.length > 0 ? awpStack[awpStack.length - 1] : {};
-    }
-    /** Push merged settings/awp onto stacks, register a single beforeEach, call fn, pop. */
-    function withDescribeDetails(ws, awp, fn) {
-        if (!ws && !awp) {
-            fn();
-            return;
-        }
-        const mergedSettings = ws ? { ...currentSettings(), ...ws } : currentSettings();
-        const mergedAwp = awp ? { ...currentAwp(), ...awp } : currentAwp();
-        if (ws)
-            settingsStack.push(mergedSettings);
-        if (awp)
-            awpStack.push(mergedAwp);
-        injectWindowProperties(testInstance, mergedSettings, mergedAwp);
-        fn();
-        if (awp)
-            awpStack.pop();
-        if (ws)
-            settingsStack.pop();
-    }
-    function buildSuiteCallback(specName, details, fn) {
-        return () => {
-            // FeatureHub mock — each test gets a fresh page, so route dies with it.
-            if (options.featureHubResponse) {
-                const body = JSON.stringify(options.featureHubResponse);
-                testInstance.beforeEach(async ({ page }) => {
-                    await page.route("**/features*", async (route) => {
-                        await route.fulfill({
-                            status: 200,
-                            contentType: "application/json",
-                            headers: { "access-control-allow-origin": "*" },
-                            body,
-                        });
-                    });
-                });
-            }
-            // Goodmock lifecycle hooks
-            const gm = options.goodmock;
-            if (gm?.host) {
-                const goodmockMode = getGoodmockMode();
-                if (goodmockMode !== GoodmockMode.Proxy) {
-                    testInstance.beforeAll(async () => {
-                        await resetMappings(gm.host);
-                        if (goodmockMode === GoodmockMode.Record) {
-                            await startRecording(gm.host, gm.backendHost);
-                        }
-                        else if (goodmockMode === GoodmockMode.Replay) {
-                            await loadMappings(gm.host, gm.getMappingPath(specName));
-                        }
-                    });
-                    testInstance.afterAll(async () => {
-                        if (goodmockMode === GoodmockMode.Record) {
-                            await snapshotAndSaveRecording(gm.host, gm.getMappingPath(specName), {
-                                workspaceIdMappings: gm.workspaceIdMappings,
-                                backendHost: gm.backendHost,
-                                baseUrl: gm.baseUrl,
-                                secretMappings: gm.secretMappings,
-                                leakPatterns: gm.leakPatterns,
-                                sanitizeMappings: gm.sanitizeMappings,
-                            });
-                        }
-                        await resetMappings(gm.host);
-                    });
-                    // TODO: When this is supported in goodmock, uncomment this block
-                    // testInstance.beforeEach(async () => {
-                    //     await resetScenarios(gm.host);
-                    // });
-                }
-            }
-            // Workspace settings + additional window properties — merge with parent
-            // stack and inject beforeEach. Wraps fn() so nested describes inherit.
-            insideTopLevelDescribe = true;
-            withDescribeDetails(details?.workspaceSettings, details?.additionalWindowProperties, fn);
-            insideTopLevelDescribe = false;
-        };
-    }
-    // --- Override test.describe to support workspaceSettings merging ---
-    const originalDescribe = testInstance.describe;
-    function wrappedDescribe(title, detailsOrCb, cb) {
-        if (!insideTopLevelDescribe) {
-            throw new Error(`test.describe("${title}") must be nested inside a test.topLevelDescribe() block.`);
-        }
-        const hasDetails = typeof detailsOrCb !== "function";
-        const details = hasDetails ? detailsOrCb : undefined;
-        const callback = hasDetails ? cb : detailsOrCb;
-        const pwDetails = toPlaywrightDetails(details);
-        const wrapped = () => withDescribeDetails(details?.workspaceSettings, details?.additionalWindowProperties, callback);
-        if (pwDetails) {
-            originalDescribe(title, pwDetails, wrapped);
-        }
-        else {
-            originalDescribe(title, wrapped);
-        }
-    }
-    // Wrap describe.skip with the same workspaceSettings merging logic.
-    const originalSkip = originalDescribe.skip;
-    function wrappedSkip(title, detailsOrCb, cb) {
-        const hasDetails = typeof detailsOrCb !== "function";
-        const details = hasDetails ? detailsOrCb : undefined;
-        const callback = hasDetails ? cb : detailsOrCb;
-        const wrapped = () => withDescribeDetails(details?.workspaceSettings, details?.additionalWindowProperties, callback);
-        originalSkip(title, wrapped);
-    }
-    // Preserve all sub-methods (.only, .serial, .parallel, .configure, .fixme)
-    Object.assign(wrappedDescribe, originalDescribe);
-    wrappedDescribe.skip = wrappedSkip;
-    // oxlint-disable-next-line @typescript-eslint/no-explicit-any
-    testInstance.describe = wrappedDescribe;
-    function topLevelDescribe(suiteName, specName, detailsOrFn, func) {
-        const { details, fn } = parseArgs(detailsOrFn, func);
-        const suite = buildSuiteCallback(specName, details, fn);
-        const pwDetails = toPlaywrightDetails(details);
-        if (pwDetails) {
-            // oxlint-disable-next-line playwright/valid-describe-callback
-            originalDescribe(suiteName, pwDetails, suite);
-        }
-        else {
-            // oxlint-disable-next-line playwright/valid-describe-callback
-            originalDescribe(suiteName, suite);
-        }
-    }
-    function skip(suiteName, specName, detailsOrFn, func) {
-        const { details, fn } = parseArgs(detailsOrFn, func);
-        const suite = buildSuiteCallback(specName, details, fn);
-        // oxlint-disable-next-line playwright/valid-describe-callback
-        originalSkip(suiteName, suite);
-    }
-    topLevelDescribe.skip = skip;
-    // Attach topLevelDescribe onto the test instance
-    const e2eTest = testInstance;
-    e2eTest.topLevelDescribe = topLevelDescribe;
-    return e2eTest;
-}