creevey 0.10.0-beta.9 → 0.10.0-rc.1

package/dist/playwright/generator.js

@@ -0,0 +1,267 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.definePlaywrightTests = definePlaywrightTests;
+const path_1 = __importDefault(require("path"));
+const assert_1 = __importDefault(require("assert"));
+const fs_1 = require("fs");
+const test_1 = require("@playwright/test");
+const isEqual_js_1 = __importDefault(require("lodash/isEqual.js"));
+const types_1 = require("../types");
+const compare_1 = require("../server/compare");
+const webdriver_1 = require("../server/webdriver");
+const helpers_1 = require("./helpers");
+const cacheDir = process.env.CREEVEY_CACHE_DIR;
+const defaultConfig = {
+    diffOptions: { threshold: 0.1, includeAA: false },
+    odiffOptions: { threshold: 0.1, antialiasing: true },
+    comparisonLibrary: 'pixelmatch',
+    reusePageContext: true,
+    trace: false,
+};
+// TODO: Use this Storybook function for building args for query params
+// export const buildArgsParam = (initialArgs: Args | undefined, args: Args): string => {
+// TODO: Pass globals to story
+function appendStoryQueryParams(url, storyId) {
+    return `${url}?args=&globals=&id=${storyId}`;
+}
+function assertWrapper(assert) {
+    return async function assertImage(actual, imageName) {
+        try {
+            const errorMessage = await assert(actual, imageName);
+            if (errorMessage) {
+                throw new Error(errorMessage);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                error.stack = error.stack
+                    ?.split('\n')
+                    .filter((line) => !line.includes('at assertImage'))
+                    .join('\n');
+            }
+            throw error;
+        }
+    };
+}
+async function takeScreenshot(page, storyId, captureElement, ignoreElements) {
+    const ignore = ignoreElements ? (Array.isArray(ignoreElements) ? ignoreElements : [ignoreElements]) : [];
+    const mask = ignore.map((selector) => page.locator(selector));
+    if (captureElement) {
+        // TODO Use page.locator(captureElement) instead of page.$(captureElement)
+        // TODO Test `#storybook-root > *` selector, probably we don't need `> *` and use `#storybook-root >*:first-child` instead
+        const element = await page.$(captureElement);
+        if (!element)
+            throw new Error(`Capture element '${captureElement}' not found for story '${storyId}'`);
+        return element.screenshot({
+            style: ':root { overflow: hidden !important; }',
+            animations: 'disabled',
+            mask,
+        });
+    }
+    else {
+        return page.screenshot({
+            animations: 'disabled',
+            mask,
+        });
+    }
+}
+// TODO: To support parallel tests, we need to define each test suite in separate file
+// TODO: How to support custom interactions for different tests
+// Main function to define tests using Playwright's API
+function definePlaywrightTests(config) {
+    (0, assert_1.default)(cacheDir, 'Cache directory not found');
+    const stories = JSON.parse((0, fs_1.readFileSync)(path_1.default.join(cacheDir, 'stories.json'), 'utf-8'));
+    let globals = {};
+    let reusedContext;
+    let reusedPage;
+    const { diffOptions, odiffOptions, comparisonLibrary, reusePageContext, trace } = {
+        ...defaultConfig,
+        ...config,
+    };
+    async function updateGlobals(page, storybookGlobals) {
+        if (storybookGlobals && typeof storybookGlobals === 'object' && !(0, isEqual_js_1.default)(globals, storybookGlobals)) {
+            globals = storybookGlobals;
+            await page.evaluate((globals) => {
+                window.__STORYBOOK_ADDONS_CHANNEL__.emit(types_1.StorybookEvents.UPDATE_GLOBALS, { globals });
+            }, globals);
+        }
+    }
+    test_1.test.describe('Creevey Tests', () => {
+        const imagesContext = {
+            attachments: [],
+            testFullPath: [],
+            images: {},
+        };
+        let assertImage;
+        test_1.test.beforeAll('Setup images context', async ({ browser }, { project }) => {
+            const { snapshotDir, outputDir, use: { viewport }, } = project;
+            if (reusePageContext) {
+                const storybookUrl = project.use.baseURL;
+                (0, assert_1.default)(storybookUrl, 'Storybook URL not found');
+                // TODO Record video
+                reusedContext = await browser.newContext({ viewport, screen: viewport ?? undefined });
+                if (trace) {
+                    await reusedContext.tracing.start(typeof trace === 'object' ? trace : { screenshots: true, snapshots: true, sources: true });
+                }
+                reusedPage = await reusedContext.newPage();
+                await reusedPage.goto((0, webdriver_1.appendIframePath)(storybookUrl), { timeout: 60000 });
+                await reusedPage.waitForLoadState('networkidle');
+                await (0, helpers_1.waitForStorybookReady)(reusedPage);
+            }
+            if (comparisonLibrary === 'pixelmatch') {
+                const { default: pixelmatch } = await import('pixelmatch');
+                assertImage = assertWrapper((0, compare_1.getPixelmatchAssert)(pixelmatch, imagesContext, { screenDir: snapshotDir, reportDir: outputDir, diffOptions }));
+            }
+            else {
+                const { compare } = await import('odiff-bin');
+                assertImage = assertWrapper((0, compare_1.getOdiffAssert)(compare, imagesContext, { screenDir: snapshotDir, reportDir: outputDir, odiffOptions }));
+            }
+        });
+        test_1.test.beforeEach('Switch story', async ({ page }, { annotations, project }) => {
+            const { description: storyId } = annotations.find((annotation) => annotation.type === 'storyId') ?? {};
+            (0, assert_1.default)(storyId, 'Cannot get storyId. It seems like inner test annotation is missing');
+            const story = stories[storyId];
+            (0, assert_1.default)(story, `Story '${storyId}' not found in stories cache`);
+            const { title, name, parameters } = story;
+            const { waitForReady: shouldWaitForReady } = (parameters.creevey ?? {});
+            const storybookGlobals = project.metadata.storybookGlobals;
+            imagesContext.attachments = [];
+            imagesContext.testFullPath = [...title.split('/').map((x) => x.trim()), name, project.name];
+            imagesContext.images = {};
+            if (!reusePageContext) {
+                const storybookUrl = project.use.baseURL;
+                (0, assert_1.default)(storybookUrl, 'Storybook URL not found');
+                await page.goto(appendStoryQueryParams((0, webdriver_1.appendIframePath)(storybookUrl), storyId), { timeout: 60000 });
+                await page.waitForLoadState('networkidle');
+                await (0, helpers_1.waitForStorybookReady)(page);
+                // TODO: Pass globals to story
+                await updateGlobals(page, storybookGlobals);
+                return;
+            }
+            // 1. Update Storybook Globals
+            await updateGlobals(reusedPage, storybookGlobals);
+            // 2. Reset Mouse Position
+            await reusedPage.mouse.move(0, 0);
+            // 3. Select Story
+            const errorMessage = await reusedPage.evaluate(async ({ storyId, StorybookEvents, shouldWaitForReady }) => {
+                // TODO: DRY with withCreevey.ts
+                // NOTE: Copy-pasted from withCreevey.ts
+                const channel = window.__STORYBOOK_ADDONS_CHANNEL__;
+                async function sequence(fns) {
+                    for (const fn of fns) {
+                        await fn();
+                    }
+                }
+                const waitForReady = shouldWaitForReady
+                    ? new Promise((resolve) => (window.__CREEVEY_SET_READY_FOR_CAPTURE__ = resolve))
+                    : Promise.resolve();
+                let rejectCallback;
+                const renderErrorPromise = new Promise((_resolve, reject) => (rejectCallback = reject));
+                function errorHandler({ title, description }) {
+                    rejectCallback({
+                        message: title,
+                        stack: description,
+                    });
+                }
+                function exceptionHandler(exception) {
+                    rejectCallback(exception);
+                }
+                function removeErrorHandlers() {
+                    channel.off(StorybookEvents.STORY_ERRORED, errorHandler);
+                    channel.off(StorybookEvents.STORY_THREW_EXCEPTION, errorHandler);
+                }
+                channel.once(StorybookEvents.STORY_ERRORED, errorHandler);
+                channel.once(StorybookEvents.STORY_THREW_EXCEPTION, exceptionHandler);
+                let resolveCallback;
+                const storyRenderedPromise = new Promise((resolve) => (resolveCallback = resolve));
+                function renderHandler() {
+                    resolveCallback();
+                }
+                function removeRenderHandlers() {
+                    channel.off(StorybookEvents.STORY_RENDERED, renderHandler);
+                }
+                channel.once(StorybookEvents.STORY_RENDERED, renderHandler);
+                setTimeout(() => {
+                    channel.emit(StorybookEvents.SET_CURRENT_STORY, { storyId });
+                }, 0);
+                try {
+                    await Promise.race([
+                        renderErrorPromise,
+                        sequence([() => storyRenderedPromise, () => document.fonts.ready, () => waitForReady]),
+                    ]);
+                }
+                catch (reason) {
+                    // NOTE Event `STORY_THREW_EXCEPTION` triggered only in react and vue frameworks and return Error instance
+                    // NOTE Event `STORY_ERRORED` return error-like object without `name` field
+                    const errorMessage = reason instanceof Error
+                        ? (reason.stack ?? reason.message)
+                        : (0, types_1.isObject)(reason)
+                            ? `${reason.message}\n    ${reason.stack}`
+                            : reason;
+                    return errorMessage;
+                }
+                finally {
+                    removeErrorHandlers();
+                    removeRenderHandlers();
+                }
+                return null;
+            }, { storyId: story.id, StorybookEvents: types_1.StorybookEvents, shouldWaitForReady });
+            if (errorMessage) {
+                throw new Error(`Failed to select story '${story.id}': ${errorMessage}`);
+            }
+        });
+        test_1.test.afterEach('Save screenshot', () => {
+            const { name: projectName } = test_1.test.info().project;
+            // TODO: Use another way to handle attachments
+            // NOTE: Don't need to copy files for assertImage, because it's done internally
+            const { actual, diff, expect } = imagesContext.images[projectName] ?? {};
+            for (const image of imagesContext.attachments) {
+                switch (true) {
+                    case image.includes('actual') && !!actual: {
+                        test_1.test.info().attachments.push({ name: actual, path: image, contentType: 'image/png' });
+                        // await test.info().attach(actual, { path: image });
+                        break;
+                    }
+                    case image.includes('expect') && !!expect: {
+                        test_1.test.info().attachments.push({ name: expect, path: image, contentType: 'image/png' });
+                        // await test.info().attach(expect, { path: image });
+                        break;
+                    }
+                    case image.includes('diff') && !!diff: {
+                        test_1.test.info().attachments.push({ name: diff, path: image, contentType: 'image/png' });
+                        // await test.info().attach(diff, { path: image });
+                        break;
+                    }
+                }
+            }
+        });
+        if (trace && reusePageContext) {
+            test_1.test.afterAll('Save trace', async (_, { project }) => {
+                const { outputDir, name: projectName } = project;
+                await reusedContext.tracing.stop({
+                    path: `${outputDir}/traces/${projectName}-${process.pid}.zip`,
+                });
+            });
+        }
+        for (const story of Object.values(stories)) {
+            const { name, title, parameters } = story;
+            const { captureElement, ignoreElements } = (parameters.creevey ?? {});
+            test_1.test.describe(title, () => {
+                // TODO: Support creevey.skip
+                (0, test_1.test)(name, { annotation: [{ type: 'storyId', description: story.id }] }, async ({ page }) => {
+                    // 4. Take Screenshot
+                    const screenshot = await takeScreenshot(reusePageContext ? reusedPage : page, story.id, captureElement, ignoreElements);
+                    // TODO: Support this
+                    // NOTE: Bear in mind that page.locator('#root > *') is not working
+                    // await expect(page.locator(captureElement)).toHaveScreenshot(name);
+                    // 5. Assert Image
+                    await assertImage(screenshot);
+                });
+            });
+        }
+    });
+}
+//# sourceMappingURL=generator.js.map

package/dist/playwright/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../src/playwright/generator.ts"],"names":[],"mappings":";;;;;AA4GA,sDA2PC;AAvWD,gDAAwB;AACxB,oDAA4B;AAC5B,2BAAkC;AAGlC,2CAA8D;AAC9D,mEAAwC;AACxC,oCAAuG;AACvG,+CAAsF;AACtF,mDAAuD;AACvD,uCAAkD;AA8BlD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;AAC/C,MAAM,aAAa,GAAgB;IACjC,WAAW,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE;IACjD,YAAY,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE;IACpD,iBAAiB,EAAE,YAAY;IAC/B,gBAAgB,EAAE,IAAI;IACtB,KAAK,EAAE,KAAK;CACb,CAAC;AAEF,uEAAuE;AACvE,yFAAyF;AAEzF,8BAA8B;AAC9B,SAAS,sBAAsB,CAAC,GAAW,EAAE,OAAe;IAC1D,OAAO,GAAG,GAAG,sBAAsB,OAAO,EAAE,CAAC;AAC/C,CAAC;AAED,SAAS,aAAa,CACpB,MAA2E;IAE3E,OAAO,KAAK,UAAU,WAAW,CAAC,MAAM,EAAE,SAAS;QACjD,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACrD,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK;oBACvB,EAAE,KAAK,CAAC,IAAI,CAAC;qBACZ,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;qBAClD,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,cAAc,CAC3B,IAAU,EACV,OAAe,EACf,cAA8B,EAC9B,cAAyC;IAEzC,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzG,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE9D,IAAI,cAAc,EAAE,CAAC;QACnB,0EAA0E;QAC1E,0HAA0H;QAC1H,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,cAAc,0BAA0B,OAAO,GAAG,CAAC,CAAC;QACtG,OAAO,OAAO,CAAC,UAAU,CAAC;YACxB,KAAK,EAAE,wCAAwC;YAC/C,UAAU,EAAE,UAAU;YACtB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,UAAU,EAAE,UAAU;YACtB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,sFAAsF;AACtF,+DAA+D;AAC/D,uDAAuD;AACvD,SAAgB,qBAAqB,CAAC,MAA6B;IACjE,IAAA,gBAAM,EAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,OAAO,CAAC,CAAe,CAAC;IACrG,IAAI,OAAO,GAAqB,EAAE,CAAC;IACnC,IAAI,aAA6B,CAAC;IAClC,IAAI,UAAgB,CAAC;IAErB,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,KAAK,EAAE,GAAG;QAChF,GAAG,aAAa;QAChB,GAAG,MAAM;KACV,CAAC;IAEF,KAAK,UAAU,aAAa,CAAC,IAAU,EAAE,gBAAyB;QAChE,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,CAAC,IAAA,oBAAO,EAAC,OAAO,EAAE,gBAAgB,CAAC,EAAE,CAAC;YACpG,OAAO,GAAG,gBAAoC,CAAC;YAC/C,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC9B,MAAM,CAAC,4BAA4B,CAAC,IAAI,CAAC,uBAAe,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YACxF,CAAC,EAAE,OAAO,CAAC,CAAC;QACd,CAAC;IACH,CAAC;IAED,WAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAClC,MAAM,aAAa,GAAiB;YAClC,WAAW,EAAE,EAAE;YACf,YAAY,EAAE,EAAE;YAChB,MAAM,EAAE,EAAE;SACX,CAAC;QACF,IAAI,WAAkE,CAAC;QAEvE,WAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;YACxE,MAAM,EACJ,WAAW,EACX,SAAS,EACT,GAAG,EAAE,EAAE,QAAQ,EAAE,GAClB,GAAG,OAAO,CAAC;YAEZ,IAAI,gBAAgB,EAAE,CAAC;gBACrB,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;gBAEzC,IAAA,gBAAM,EAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;gBAEhD,oBAAoB;gBACpB,aAAa,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,SAAS,EAAE,CAAC,CAAC;gBACtF,IAAI,KAAK,EAAE,CAAC;oBACV,MAAM,aAAa,CAAC,OAAO,CAAC,KAAK,CAC/B,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAC1F,CAAC;gBACJ,CAAC;gBACD,UAAU,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC;gBAC3C,MAAM,UAAU,CAAC,IAAI,CAAC,IAAA,4BAAgB,EAAC,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC1E,MAAM,UAAU,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;gBACjD,MAAM,IAAA,+BAAqB,EAAC,UAAU,CAAC,CAAC;YAC1C,CAAC;YACD,IAAI,iBAAiB,KAAK,YAAY,EAAE,CAAC;gBACvC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;gBAC3D,WAAW,GAAG,aAAa,CACzB,IAAA,6BAAmB,EAAC,UAAU,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAC9G,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;gBAC9C,WAAW,GAAG,aAAa,CACzB,IAAA,wBAAc,EAAC,OAAO,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CACvG,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,WAAI,CAAC,UAAU,CAAC,cAAc,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,EAAE;YAC3E,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;YAEvG,IAAA,gBAAM,EAAC,OAAO,EAAE,oEAAoE,CAAC,CAAC;YAEtF,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;YAE/B,IAAA,gBAAM,EAAC,KAAK,EAAE,UAAU,OAAO,8BAA8B,CAAC,CAAC;YAE/D,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;YAC1C,MAAM,EAAE,YAAY,EAAE,kBAAkB,EAAE,GAAG,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAuB,CAAC;YAE9F,MAAM,gBAAgB,GAAY,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAEpE,aAAa,CAAC,WAAW,GAAG,EAAE,CAAC;YAC/B,aAAa,CAAC,YAAY,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5F,aAAa,CAAC,MAAM,GAAG,EAAE,CAAC;YAE1B,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;gBAEzC,IAAA,gBAAM,EAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;gBAEhD,MAAM,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAA,4BAAgB,EAAC,YAAY,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;gBACrG,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;gBAC3C,MAAM,IAAA,+BAAqB,EAAC,IAAI,CAAC,CAAC;gBAClC,8BAA8B;gBAC9B,MAAM,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;gBAE5C,OAAO;YACT,CAAC;YAED,8BAA8B;YAC9B,MAAM,aAAa,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;YAElD,0BAA0B;YAC1B,MAAM,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAElC,kBAAkB;YAClB,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,QAAQ,CAI5C,KAAK,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,EAAE,EAAE;gBACzD,gCAAgC;gBAChC,wCAAwC;gBACxC,MAAM,OAAO,GAAG,MAAM,CAAC,4BAA4B,CAAC;gBAEpD,KAAK,UAAU,QAAQ,CAAC,GAA+B;oBACrD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;wBACrB,MAAM,EAAE,EAAE,CAAC;oBACb,CAAC;gBACH,CAAC;gBAED,MAAM,YAAY,GAAG,kBAAkB;oBACrC,CAAC,CAAC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,iCAAiC,GAAG,OAAO,CAAC,CAAC;oBACtF,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBAEtB,IAAI,cAA0C,CAAC;gBAC/C,MAAM,kBAAkB,GAAG,IAAI,OAAO,CAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC;gBAE9F,SAAS,YAAY,CAAC,EAAE,KAAK,EAAE,WAAW,EAA0C;oBAClF,cAAc,CAAC;wBACb,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,WAAW;qBACnB,CAAC,CAAC;gBACL,CAAC;gBACD,SAAS,gBAAgB,CAAC,SAAgB;oBACxC,cAAc,CAAC,SAAS,CAAC,CAAC;gBAC5B,CAAC;gBACD,SAAS,mBAAmB;oBAC1B,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;oBACzD,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;gBACnE,CAAC;gBAED,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;gBAC1D,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;gBAEtE,IAAI,eAA2B,CAAC;gBAChC,MAAM,oBAAoB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC;gBACzF,SAAS,aAAa;oBACpB,eAAe,EAAE,CAAC;gBACpB,CAAC;gBACD,SAAS,oBAAoB;oBAC3B,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;gBAC7D,CAAC;gBAED,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;gBAE5D,UAAU,CAAC,GAAG,EAAE;oBACd,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC/D,CAAC,EAAE,CAAC,CAAC,CAAC;gBAEN,IAAI,CAAC;oBACH,MAAM,OAAO,CAAC,IAAI,CAAC;wBACjB,kBAAkB;wBAClB,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,CAAC;qBACvF,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,MAAM,EAAE,CAAC;oBAChB,0GAA0G;oBAC1G,2EAA2E;oBAC3E,MAAM,YAAY,GAChB,MAAM,YAAY,KAAK;wBACrB,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC;wBAClC,CAAC,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC;4BAChB,CAAC,CAAC,GAAG,MAAM,CAAC,OAAiB,SAAS,MAAM,CAAC,KAAe,EAAE;4BAC9D,CAAC,CAAE,MAAiB,CAAC;oBAC3B,OAAO,YAAY,CAAC;gBACtB,CAAC;wBAAS,CAAC;oBACT,mBAAmB,EAAE,CAAC;oBACtB,oBAAoB,EAAE,CAAC;gBACzB,CAAC;gBAED,OAAO,IAAI,CAAC;YACd,CAAC,EACD,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE,eAAe,EAAf,uBAAe,EAAE,kBAAkB,EAAE,CAC3D,CAAC;YAEF,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,CAAC,EAAE,MAAM,YAAY,EAAE,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,WAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,GAAG,EAAE;YACrC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,WAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC;YAElD,8CAA8C;YAE9C,+EAA+E;YAC/E,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YACzE,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;gBAC9C,QAAQ,IAAI,EAAE,CAAC;oBACb,KAAK,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;wBAC1C,WAAI,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;wBACtF,qDAAqD;wBACrD,MAAM;oBACR,CAAC;oBACD,KAAK,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;wBAC1C,WAAI,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;wBACtF,qDAAqD;wBACrD,MAAM;oBACR,CAAC;oBACD,KAAK,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;wBACtC,WAAI,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;wBACpF,mDAAmD;wBACnD,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,KAAK,IAAI,gBAAgB,EAAE,CAAC;YAC9B,WAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;gBACnD,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;gBACjD,MAAM,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC;oBAC/B,IAAI,EAAE,GAAG,SAAS,WAAW,WAAW,IAAI,OAAO,CAAC,GAAG,MAAM;iBAC9D,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;YAC1C,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAuB,CAAC;YAE5F,WAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;gBACxB,6BAA6B;gBAC7B,IAAA,WAAI,EAAC,IAAI,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;oBAC1F,qBAAqB;oBACrB,MAAM,UAAU,GAAG,MAAM,cAAc,CACrC,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,EACpC,KAAK,CAAC,EAAE,EACR,cAAc,EACd,cAAc,CACf,CAAC;oBACF,qBAAqB;oBACrB,mEAAmE;oBACnE,qEAAqE;oBAErE,kBAAkB;oBAClB,MAAM,WAAW,CAAC,UAAU,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/playwright/helpers.d.ts

@@ -0,0 +1,2 @@
+import { Page } from '@playwright/test';
+export declare function waitForStorybookReady(page: Page, timeout?: number): Promise<void>;

package/dist/playwright/helpers.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForStorybookReady = waitForStorybookReady;
+const types_1 = require("../types");
+async function waitForStorybookReady(page, timeout = 60000) {
+    const isStorybookInitialized = await page.evaluate(({ timeout, event }) => {
+        return new Promise((resolve, reject) => {
+            let attempts = 0;
+            const maxAttempts = timeout / 100;
+            function check() {
+                if (typeof window.__STORYBOOK_ADDONS_CHANNEL__ !== 'undefined' &&
+                    window.__STORYBOOK_ADDONS_CHANNEL__.last(event) !== undefined) {
+                    resolve(true);
+                }
+                else if (attempts++ < maxAttempts) {
+                    setTimeout(check, 100);
+                }
+                else {
+                    reject(new Error('Storybook initialization timed out. Required Storybook functions not found on window.'));
+                }
+            }
+            check();
+        });
+    }, { timeout, event: types_1.StorybookEvents.SET_GLOBALS });
+    if (!isStorybookInitialized) {
+        throw new Error('Failed to confirm Storybook API is ready after extended wait.');
+    }
+}
+//# sourceMappingURL=helpers.js.map

package/dist/playwright/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/playwright/helpers.ts"],"names":[],"mappings":";;AAGA,sDA2BC;AA9BD,oCAA2C;AAGpC,KAAK,UAAU,qBAAqB,CAAC,IAAU,EAAE,OAAO,GAAG,KAAK;IACrE,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC,QAAQ,CAChD,CAAC,EAAE,OAAO,EAAE,KAAK,EAAsC,EAAE,EAAE;QACzD,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9C,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,MAAM,WAAW,GAAG,OAAO,GAAG,GAAG,CAAC;YAClC,SAAS,KAAK;gBACZ,IACE,OAAO,MAAM,CAAC,4BAA4B,KAAK,WAAW;oBAC1D,MAAM,CAAC,4BAA4B,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,EAC7D,CAAC;oBACD,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC;qBAAM,IAAI,QAAQ,EAAE,GAAG,WAAW,EAAE,CAAC;oBACpC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBACzB,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,KAAK,CAAC,uFAAuF,CAAC,CAAC,CAAC;gBAC7G,CAAC;YACH,CAAC;YACD,KAAK,EAAE,CAAC;QACV,CAAC,CAAC,CAAC;IACL,CAAC,EACD,EAAE,OAAO,EAAE,KAAK,EAAE,uBAAe,CAAC,WAAW,EAAE,CAChD,CAAC;IAEF,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;AACH,CAAC"}

package/dist/playwright/reporter.d.ts

@@ -0,0 +1,83 @@
+import type { Reporter, FullConfig, Suite, TestCase, TestResult, TestStep } from '@playwright/test/reporter';
+/**
+ * CreeveyPlaywrightReporter is a Playwright reporter that integrates with Creevey
+ * to provide visual testing capabilities and use Creevey's UI for reviewing and approving screenshots.
+ */
+declare class CreeveyPlaywrightReporter implements Reporter {
+    private testsManager;
+    private api;
+    private port;
+    private debug;
+    private testIdMap;
+    private asyncQueue;
+    /**
+     * Creates a new instance of the CreeveyPlaywrightReporter
+     * @param options Configuration options for the reporter
+     */
+    constructor(options?: {
+        port?: number;
+        debug?: boolean;
+    });
+    /**
+     * Called when the test run starts
+     * @param config Playwright configuration
+     * @param suite Test suite information
+     */
+    onBegin(config: FullConfig, suite: Suite): void;
+    /**
+     * Called when a test begins
+     * @param test Test case information
+     * @param result Test result (initially empty)
+     */
+    onTestBegin(test: TestCase, _result: TestResult): void;
+    /**
+     * Called when a test step begins
+     * @param test Test case information
+     * @param result Test result
+     * @param step Test step information
+     */
+    onStepBegin(test: TestCase, _result: TestResult, step: TestStep): void;
+    /**
+     * Called when a test step ends
+     * @param test Test case information
+     * @param result Test result
+     * @param step Test step information
+     */
+    onStepEnd(_test: TestCase, _result: TestResult, step: TestStep): void;
+    /**
+     * Called when a test ends
+     * @param test Test case information
+     * @param result Test result
+     */
+    onTestEnd(test: TestCase, result: TestResult): void;
+    /**
+     * Called when the test run ends
+     * @param result The overall test run result
+     */
+    onEnd(result: {
+        status: 'passed' | 'failed' | 'timedout' | 'interrupted';
+    }): Promise<void>;
+    /**
+     * Maps a Playwright test to a Creevey test format
+     * @param test Playwright test case
+     * @returns Creevey test object or null if mapping fails
+     */
+    private mapToCreeveyTest;
+    /**
+     * Process a test result and any attachments
+     * @param test Playwright test case
+     * @param result Playwright test result
+     */
+    private processTestResult;
+    /**
+     * Logs a debug message if debug mode is enabled
+     * @param message Message to log
+     */
+    private logDebug;
+    /**
+     * Logs an error message
+     * @param message Error message to log
+     */
+    private logError;
+}
+export default CreeveyPlaywrightReporter;