@cappa/core 0.2.5 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":["defaultDiffConfig: DiffConfig","screenshotSettings: ScreenshotSettings","diffImagePath: string | undefined","result: ScreenshotCaptureDetails","baseResult: ScreenshotCaptureDetails","variantResults: ScreenshotVariantCaptureDetails[]","variantOptions: ScreenshotSettings","variantResult: ScreenshotVariantCaptureDetails"],"sources":["../src/config.ts","../src/filesystem.ts","../src/compare.ts","../src/screenshot.ts"],"sourcesContent":["import type { PossiblePromise, UserConfig } from \"./types\";\n\n/**\n * Type helper to make it easier to use cappa.config.ts, or a function that returns it. The function receives a ConfigEnv object.\n */\nexport function defineConfig(\n options:\n | PossiblePromise<UserConfig | Array<UserConfig>>\n | (() => PossiblePromise<UserConfig | Array<UserConfig>>),\n): typeof options {\n return options;\n}\n","import fs from \"node:fs\";\nimport path from \"node:path\";\n\n/**\n * Class for interacting with the local file system to store the screenshots.\n */\nexport class ScreenshotFileSystem {\n private readonly actualDir: string;\n private readonly expectedDir: string;\n private readonly diffDir: string;\n\n constructor(outputDir: string) {\n this.actualDir = path.resolve(outputDir, \"actual\");\n this.expectedDir = path.resolve(outputDir, \"expected\");\n this.diffDir = path.resolve(outputDir, \"diff\");\n\n this.ensureParentDir(this.actualDir);\n this.ensureParentDir(this.expectedDir);\n this.ensureParentDir(this.diffDir);\n }\n\n clearActual() {\n this.removeDir(this.actualDir);\n }\n\n clearDiff() {\n this.removeDir(this.diffDir);\n }\n\n clearActualAndDiff() {\n this.clearActual();\n this.clearDiff();\n }\n\n /**\n * Approve a screenshot based on its actual file path.\n * @param actualFilePath - The path to the actual screenshot file.\n * @returns The paths to the actual, expected, and diff screenshot files.\n */\n approveFromActualPath(actualFilePath: string) {\n const actualAbsolute = this.resolveActualPath(actualFilePath);\n const relativePath = path.relative(this.actualDir, actualAbsolute);\n\n if (relativePath.startsWith(\"..\")) {\n throw new Error(\n `Cannot approve screenshot outside of actual directory: ${actualFilePath}`,\n );\n }\n\n return this.approveRelative(relativePath);\n }\n\n /**\n * Approve a screenshot based on its name.\n * @param name - The name of the screenshot. Can include '.png' extension.\n * @returns The paths to the actual, expected, and diff screenshot files.\n */\n approveByName(name: string) {\n const relativeWithExtension = name.endsWith(\".png\") ? name : `${name}.png`;\n\n return this.approveRelative(relativeWithExtension);\n }\n\n /**\n * Approve a screenshot based on a relative path.\n * @param relativePath - The relative path to the screenshot.\n * @returns The paths to the actual, expected, and diff screenshot files.\n */\n private approveRelative(relativePath: string) {\n const actualPath = path.resolve(this.actualDir, relativePath);\n const expectedPath = path.resolve(this.expectedDir, relativePath);\n const diffPath = path.resolve(this.diffDir, relativePath);\n\n this.ensureParentDir(expectedPath);\n\n fs.copyFileSync(actualPath, expectedPath);\n\n if (fs.existsSync(diffPath)) {\n fs.unlinkSync(diffPath);\n }\n\n return {\n actualPath,\n expectedPath,\n diffPath,\n };\n }\n\n /**\n * Ensure the parent directory of a file exists. If not, it creates it.\n * @param filePath - The path to the file.\n */\n ensureParentDir(filePath: string) {\n const dir = path.dirname(filePath);\n\n if (!fs.existsSync(dir)) {\n fs.mkdirSync(dir, { recursive: true });\n }\n }\n\n /**\n * Remove a directory and all its contents.\n * @param dir - The path to the directory.\n */\n private removeDir(dir: string) {\n if (fs.existsSync(dir)) {\n fs.rmSync(dir, { recursive: true, force: true });\n }\n }\n\n /**\n * Get the actual directory path\n */\n getActualDir(): string {\n return this.actualDir;\n }\n\n /**\n * Get the expected directory path\n */\n getExpectedDir(): string {\n return this.expectedDir;\n }\n\n /**\n * Get the diff directory path\n */\n getDiffDir(): string {\n return this.diffDir;\n }\n\n /**\n * Get the path to an actual screenshot file\n */\n getActualFilePath(filename: string): string {\n return path.resolve(this.actualDir, filename);\n }\n\n /**\n * Get the path to an expected screenshot file\n */\n getExpectedFilePath(filename: string): string {\n return path.resolve(this.expectedDir, filename);\n }\n\n /**\n * Get the path to a diff screenshot file\n */\n getDiffFilePath(filename: string): string {\n return path.resolve(this.diffDir, filename);\n }\n\n /**\n * Write a file to the actual directory\n */\n writeActualFile(filename: string, data: Buffer): void {\n const filepath = this.getActualFilePath(filename);\n this.ensureParentDir(filepath);\n fs.writeFileSync(filepath, data);\n }\n\n /**\n * Write a file to the diff directory\n */\n writeDiffFile(filename: string, data: Buffer): void {\n const filepath = this.getDiffFilePath(filename);\n this.ensureParentDir(filepath);\n fs.writeFileSync(filepath, data);\n }\n\n /**\n * Check if an expected file exists\n */\n hasExpectedFile(filename: string): boolean {\n const expectedPath = this.getExpectedFilePath(filename);\n return fs.existsSync(expectedPath);\n }\n\n /**\n * Read an expected file\n */\n readExpectedFile(filename: string): Buffer {\n const expectedPath = this.getExpectedFilePath(filename);\n if (!fs.existsSync(expectedPath)) {\n throw new Error(`Expected image not found: ${expectedPath}`);\n }\n return fs.readFileSync(expectedPath);\n }\n\n /**\n * Resolve the actual path of a screenshot file.\n * @param filePath - The path to the screenshot file.\n * @returns The actual path of the screenshot file.\n */\n private resolveActualPath(filePath: string) {\n if (path.isAbsolute(filePath)) {\n return filePath;\n }\n\n return path.resolve(this.actualDir, filePath);\n }\n}\n","import fs from \"node:fs\";\nimport blazediff from \"@blazediff/core\";\nimport type { BlazeDiffOptions } from \"@blazediff/types\";\nimport { getLogger } from \"@cappa/logger\";\nimport { PNG } from \"pngjs\";\nimport type { DiffConfig } from \"./types\";\n\nexport type CompareOptions = BlazeDiffOptions;\n\nexport interface CompareResult {\n numDiffPixels: number;\n totalPixels: number;\n percentDifference: number;\n diffBuffer?: Buffer; // PNG buffer of the diff image\n passed: boolean; // Whether the comparison passed based on threshold\n error?: string; // Error message if the comparison failed\n differentSizes: boolean; // Whether the images have different sizes\n}\n\nconst compare = (\n image1: Uint8Array | Uint8ClampedArray,\n image2: Uint8Array | Uint8ClampedArray,\n diff: Uint8Array | Uint8ClampedArray | undefined,\n width: number,\n height: number,\n options?: BlazeDiffOptions,\n) => {\n return blazediff(image1, image2, diff, width, height, options);\n};\n\n/**\n * Compare two PNG images and return the difference\n * @param image1 - First image (file path or Buffer)\n * @param image2 - Second image (file path or Buffer)\n * @param withDiff - Whether to create a diff image\n * @param options - Comparison options\n * @returns Comparison result\n */\nexport async function compareImages(\n image1: string | Buffer,\n image2: string | Buffer,\n withDiff: boolean = false,\n options: DiffConfig = {},\n): Promise<CompareResult> {\n const png1 = await loadPNG(image1);\n const png2 = await loadPNG(image2);\n\n const { width, height } = png1;\n\n if (width !== png2.width || height !== png2.height) {\n return {\n numDiffPixels: 0,\n totalPixels: 0,\n percentDifference: 0,\n passed: false,\n differentSizes: true,\n };\n }\n\n const diff = withDiff ? new PNG({ width, height }) : undefined;\n\n try {\n const numDiffPixels = compare(\n png1.data,\n png2.data,\n diff?.data,\n width,\n height,\n options,\n );\n\n const totalPixels = width * height;\n const percentDifference = (numDiffPixels / totalPixels) * 100;\n\n // Convert diff image to buffer\n const diffBuffer = diff ? PNG.sync.write(diff) : undefined;\n\n return {\n numDiffPixels,\n totalPixels,\n percentDifference,\n diffBuffer,\n passed: isPassed(percentDifference, numDiffPixels, options),\n differentSizes: false,\n };\n } catch (error) {\n getLogger().error((error as Error).message || \"Unknown error\");\n\n return {\n numDiffPixels: 0,\n totalPixels: 0,\n percentDifference: 0,\n passed: false,\n differentSizes: false,\n error: (error as Error).message || \"Unknown error\",\n };\n }\n}\n\n/**\n * Load a PNG image from file path or Buffer\n */\nasync function loadPNG(source: string | Buffer): Promise<PNG> {\n if (Buffer.isBuffer(source)) {\n return PNG.sync.read(source);\n } else {\n const buffer = fs.readFileSync(source);\n return PNG.sync.read(buffer);\n }\n}\n\n/**\n * Save a comparison result diff image to file\n * @param result - Comparison result containing diffBuffer\n * @param outputPath - Path to save the diff image\n */\nexport function saveDiffImage(result: CompareResult, outputPath: string): void {\n if (!result.diffBuffer) {\n throw new Error(\"No diff buffer available in comparison result\");\n }\n\n fs.writeFileSync(outputPath, result.diffBuffer);\n}\n\n/**\n * Quick comparison function that returns only pass/fail\n * @param image1 - First image (file path or Buffer)\n * @param image2 - Second image (file path or Buffer)\n * @param options - Comparison options\n * @returns Whether the images match\n */\nexport async function imagesMatch(\n image1: string | Buffer,\n image2: string | Buffer,\n options: DiffConfig = {},\n): Promise<boolean> {\n const result = await compareImages(image1, image2, false, options);\n\n return result.passed;\n}\n\n/**\n * Check if the comparison passed based on the options\n * @param percentDifference - Percentage difference between the images\n * @param numDiffPixels - Number of different pixels\n * @param options - Comparison options\n * @returns Whether the comparison passed\n */\nconst isPassed = (\n percentDifference: number,\n numDiffPixels: number,\n options: DiffConfig,\n) => {\n if (options.maxDiffPercentage && options.maxDiffPixels) {\n return (\n percentDifference <= options.maxDiffPercentage &&\n numDiffPixels <= options.maxDiffPixels\n );\n }\n\n if (options.maxDiffPercentage) {\n return percentDifference <= options.maxDiffPercentage;\n }\n\n if (options.maxDiffPixels) {\n return numDiffPixels <= options.maxDiffPixels;\n }\n\n // fallback to 0 pixels\n return numDiffPixels === 0;\n};\n\n/**\n * Create different size png image with all pixels red\n * @returns\n */\nexport function createDiffSizePngImage(width: number, height: number): Buffer {\n const png = new PNG({ width, height });\n\n for (let y = 0; y < height; y++) {\n for (let x = 0; x < width; x++) {\n const idx = (width * y + x) << 2;\n png.data[idx] = 255; // red\n png.data[idx + 1] = 0; // green\n png.data[idx + 2] = 0; // blue\n png.data[idx + 3] = 255; // alpha\n }\n }\n\n return PNG.sync.write(png);\n}\n","import path from \"node:path\";\nimport { getLogger, type Logger } from \"@cappa/logger\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\nimport {\n type CompareResult,\n compareImages,\n createDiffSizePngImage,\n} from \"./compare\";\nimport { ScreenshotFileSystem } from \"./filesystem\";\nimport type {\n DiffConfig,\n ScreenshotOptions,\n ScreenshotSettings,\n ScreenshotVariant,\n ScreenshotVariantWithUrl,\n} from \"./types\";\n\nconst defaultDiffConfig: DiffConfig = {\n threshold: 0.1,\n includeAA: false,\n fastBufferCheck: true,\n maxDiffPixels: 0,\n maxDiffPercentage: 0,\n};\n\nexport interface ScreenshotCaptureDetails {\n filename: string;\n filepath?: string;\n comparisonResult?: CompareResult;\n diffImagePath?: string;\n skipped?: boolean;\n}\n\nexport interface ScreenshotVariantCaptureDetails\n extends ScreenshotCaptureDetails {\n id: string;\n label?: string;\n}\n\nexport interface ScreenshotCaptureResult {\n base: ScreenshotCaptureDetails;\n variants: ScreenshotVariantCaptureDetails[];\n}\n\nexport interface ScreenshotCaptureExtras {\n saveDiffImage?: boolean;\n diffImageFilename?: string;\n variants?: Record<\n string,\n {\n saveDiffImage?: boolean;\n diffImageFilename?: string;\n }\n >;\n}\n\nclass ScreenshotTool {\n browserType: \"chromium\" | \"firefox\" | \"webkit\";\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n concurrency: number;\n contexts: BrowserContext[] = [];\n pages: Page[] = [];\n diff: DiffConfig;\n logger: Logger;\n retries: number;\n filesystem: ScreenshotFileSystem;\n\n constructor(options: {\n browserType?: \"chromium\" | \"firefox\" | \"webkit\";\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n diff?: DiffConfig;\n retries?: number;\n concurrency?: number;\n }) {\n this.browserType = options.browserType || \"chromium\";\n this.headless = options.headless !== false; // Default to headless\n this.viewport = options.viewport || { width: 1920, height: 1080 };\n this.outputDir = options.outputDir || \"./screenshots\";\n this.diff = { ...defaultDiffConfig, ...options.diff };\n this.concurrency = Math.max(1, options.concurrency || 1);\n\n this.logger = getLogger();\n this.retries = options.retries || 2;\n this.filesystem = new ScreenshotFileSystem(this.outputDir);\n }\n\n /**\n * Initialize playwright and page\n */\n async init() {\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass = browserMap[this.browserType];\n if (!browserClass) {\n throw new Error(`Unsupported browser type: ${this.browserType}`);\n }\n\n this.browser = await browserClass.launch({\n headless: this.headless,\n });\n\n const defaultUserAgent = (await this.browser.newContext())\n .newPage()\n .then((page) => page.evaluate(() => navigator.userAgent));\n\n // Create N contexts and pages\n this.contexts = [];\n this.pages = [];\n\n for (let i = 0; i < this.concurrency; i++) {\n const context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 2,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n viewport: this.viewport,\n });\n const page = await context.newPage();\n\n this.contexts.push(context);\n this.pages.push(page);\n }\n\n // Backward compatibility\n this.context = this.contexts[0] ?? null;\n this.page = this.pages[0] ?? null;\n }\n\n /**\n * Closes browser\n * If not closed, the process will not exit\n */\n async close() {\n for (const context of this.contexts) {\n await context.close();\n }\n if (this.browser) {\n await this.browser.close();\n }\n }\n\n /**\n * Navigates to a URL with \"domcontentloaded\" waitUntil\n */\n async goTo(page: Page, url: string) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n }\n\n /**\n * Takes a screenshot of the page\n */\n async takeScreenshot(\n page: Page,\n filename: string,\n options: ScreenshotSettings,\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n if (options.skip) {\n return;\n }\n\n try {\n // Generate filename - save to actual directory\n const filepath = this.filesystem.getActualFilePath(filename);\n\n // Ensure parent directories exist before taking screenshot\n this.filesystem.ensureParentDir(filepath);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage: options.fullPage,\n type: \"png\" as const,\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n animations: \"disabled\",\n caret: \"hide\",\n } satisfies PageScreenshotOptions;\n\n await this.withViewport(page, options.viewport, async () => {\n if (options.delay) {\n await page.waitForTimeout(options.delay);\n }\n\n await page.screenshot(screenshotOptions);\n });\n\n this.logger.success(`Screenshot saved: ${filepath}`);\n\n return filepath;\n } catch (error) {\n this.logger.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n /**\n * Sets the viewport size and executes the action, ensuring the original viewport is restored\n * even if the action throws an error.\n */\n private async withViewport<T>(\n page: Page,\n viewport: ScreenshotSettings[\"viewport\"],\n action: () => Promise<T>,\n ): Promise<T> {\n if (!viewport) {\n return action();\n }\n\n const previousViewport = page.viewportSize();\n\n // Check if the new viewport is the same as the current one\n if (\n previousViewport &&\n previousViewport.width === viewport.width &&\n previousViewport.height === viewport.height\n ) {\n return action();\n }\n\n await page.setViewportSize(viewport);\n\n try {\n return await action();\n } finally {\n // Always restore the original viewport, even if the action throws an error\n if (previousViewport) {\n await page.setViewportSize(previousViewport);\n }\n }\n }\n\n /**\n * Takes a screenshot and returns the buffer (for comparison purposes)\n */\n async takeScreenshotBuffer(\n page: Page,\n options: ScreenshotSettings,\n ): Promise<Buffer> {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n if (options.skip) {\n throw new Error(\"Screenshot skipped\");\n }\n\n try {\n // Take screenshot without saving to file\n const screenshotOptions = {\n fullPage: options.fullPage,\n type: \"png\" as const,\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n animations: \"disabled\",\n caret: \"hide\",\n } satisfies PageScreenshotOptions;\n\n const buffer = await this.withViewport(\n page,\n options.viewport,\n async () => {\n if (options.delay) {\n await page.waitForTimeout(options.delay);\n }\n\n return page.screenshot(screenshotOptions);\n },\n );\n\n return buffer;\n } catch (error) {\n this.logger.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeScreenshotWithComparison(\n page: Page,\n filename: string,\n referenceImage: Buffer,\n options: ScreenshotSettings & {\n saveDiffImage?: boolean;\n diffImageFilename?: string;\n },\n ): Promise<{\n screenshotPath: string;\n comparisonResult: CompareResult;\n diffImagePath?: string;\n }> {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Generate filename and take screenshot - save to actual directory\n const filepath = this.filesystem.getActualFilePath(filename);\n\n const screenshotSettings: ScreenshotSettings = {\n fullPage: options.fullPage,\n mask: options.mask,\n omitBackground: options.omitBackground,\n delay: options.delay,\n viewport: options.viewport,\n };\n\n const retryScreenshot = await this.retryScreenshot(\n page,\n referenceImage,\n screenshotSettings,\n );\n\n if (!retryScreenshot.screenshotPath) {\n throw new Error(\"Screenshot buffer is undefined\");\n }\n\n // Save screenshot to actual directory\n this.filesystem.writeActualFile(filename, retryScreenshot.screenshotPath);\n this.logger.debug(`Actual screenshot saved: ${filepath}`);\n\n if (retryScreenshot.passed) {\n this.logger.success(`Screenshot passed visual comparison`);\n } else {\n this.logger.error(`Screenshot failed visual comparison`);\n }\n\n let diffImagePath: string | undefined;\n\n // Save diff image if requested and there are differences\n if (\n options.saveDiffImage &&\n retryScreenshot.comparisonResult.diffBuffer &&\n !retryScreenshot.passed\n ) {\n const diffFilename = options.diffImageFilename || filename;\n // Save to diff directory\n diffImagePath = this.filesystem.getDiffFilePath(diffFilename);\n\n this.filesystem.writeDiffFile(\n diffFilename,\n retryScreenshot.comparisonResult.diffBuffer,\n );\n\n this.logger.debug(`Diff image saved: ${diffImagePath}`);\n }\n\n // different sizes diff image\n if (retryScreenshot.comparisonResult.differentSizes) {\n this.logger.warn(`Screenshot has different sizes than reference image`);\n\n const diffFilename = options.diffImageFilename || filename;\n diffImagePath = this.filesystem.getDiffFilePath(diffFilename);\n const diffBuffer = createDiffSizePngImage(200, 200);\n\n this.filesystem.writeDiffFile(diffFilename, diffBuffer);\n\n this.logger.debug(`Diff Size image saved: ${diffImagePath}`);\n }\n\n return {\n screenshotPath: filepath,\n comparisonResult: retryScreenshot.comparisonResult,\n diffImagePath,\n };\n } catch (error) {\n this.logger.error(\n `Error taking screenshot with comparison of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async retryScreenshot(\n page: Page,\n referenceImage: Buffer,\n options: ScreenshotSettings,\n ) {\n for (let i = 0; i < this.retries; i++) {\n try {\n const screenshotBuffer = await this.takeScreenshotBuffer(page, {\n ...options,\n delay: this.getIncBackoffDelay(i, options.delay || 0),\n });\n\n if (!screenshotBuffer) {\n throw new Error(\"Screenshot buffer is undefined\");\n }\n\n const comparisonResult = await compareImages(\n screenshotBuffer,\n referenceImage,\n true,\n this.diff,\n );\n\n // bail early if the images are different sizes\n if (comparisonResult.differentSizes) {\n return {\n screenshotPath: screenshotBuffer,\n comparisonResult,\n passed: false,\n };\n }\n\n // last retry\n if (i === this.retries - 1 && !comparisonResult.passed) {\n this.logger.error(\n `Failed to match screenshot after ${this.retries} retries`,\n );\n return {\n screenshotPath: screenshotBuffer,\n comparisonResult,\n passed: false,\n };\n }\n\n if (comparisonResult.passed) {\n return {\n screenshotPath: screenshotBuffer,\n comparisonResult,\n passed: true,\n };\n } else {\n this.logger.warn(\n `Comparison did not match. Retrying in ${this.getIncBackoffDelay(i + 1, options.delay || 0)}ms... \\nComparison result: ${comparisonResult.numDiffPixels} pixels different (${comparisonResult.percentDifference.toFixed(2)}%)`,\n );\n }\n } catch (error) {\n this.logger.error(\n `Error taking screenshot after ${i + 1} retries:`,\n (error as Error).message,\n );\n }\n }\n\n return {\n screenshotPath: null,\n comparisonResult: null,\n passed: false,\n };\n }\n\n getVariantFilename(filename: string, variant: ScreenshotVariant): string {\n if (variant.filename) {\n return variant.filename;\n }\n\n const parsed = path.parse(filename);\n const sanitizedId = variant.id\n .trim()\n .replace(/[^a-zA-Z0-9_-]+/g, \"-\")\n .replace(/-+/g, \"-\")\n .replace(/^-|-$/g, \"\");\n const suffix = sanitizedId || \"variant\";\n const ext = parsed.ext || \".png\";\n const variantName = `${parsed.name}--${suffix}${ext}`;\n\n return parsed.dir ? path.join(parsed.dir, variantName) : variantName;\n }\n\n /**\n * Captures a single screenshot with the given options\n */\n private async captureSingleScreenshot(\n page: Page,\n filename: string,\n options: ScreenshotSettings,\n extras: {\n saveDiffImage?: boolean;\n diffImageFilename?: string;\n } = {},\n ): Promise<ScreenshotCaptureDetails> {\n const result: ScreenshotCaptureDetails = { filename };\n\n if (options.skip) {\n result.skipped = true;\n return result;\n }\n\n const saveDiff = extras.saveDiffImage ?? false;\n const diffFilename = extras.diffImageFilename ?? filename;\n\n if (!this.filesystem.hasExpectedFile(filename)) {\n this.logger.debug(\n `Expected image not found for ${filename}, taking screenshot`,\n );\n\n result.filepath = await this.takeScreenshot(page, filename, options);\n } else {\n const { screenshotPath, comparisonResult, diffImagePath } =\n await this.takeScreenshotWithComparison(\n page,\n filename,\n this.filesystem.readExpectedFile(filename),\n {\n ...options,\n saveDiffImage: saveDiff,\n diffImageFilename: diffFilename,\n },\n );\n\n result.filepath = screenshotPath;\n result.comparisonResult = comparisonResult;\n result.diffImagePath = diffImagePath;\n }\n\n return result;\n }\n\n async capture(\n page: Page,\n filename: string,\n options: ScreenshotOptions,\n extras: ScreenshotCaptureExtras = {},\n ): Promise<ScreenshotCaptureResult> {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n const { variants = [], ...baseOptions } = options;\n const baseResult: ScreenshotCaptureDetails = { filename };\n const variantResults: ScreenshotVariantCaptureDetails[] = [];\n\n const baseSaveDiff = extras.saveDiffImage ?? false;\n const baseDiffFilename = extras.diffImageFilename ?? filename;\n\n if (baseOptions.skip) {\n return {\n base: { ...baseResult, skipped: true },\n variants: variants.map((variant) => ({\n id: variant.id,\n label: variant.label,\n filename: this.getVariantFilename(filename, variant),\n skipped: true,\n })),\n };\n }\n\n // Capture base screenshot\n const baseCaptureResult = await this.captureSingleScreenshot(\n page,\n filename,\n baseOptions,\n {\n saveDiffImage: baseSaveDiff,\n diffImageFilename: baseDiffFilename,\n },\n );\n\n baseResult.filepath = baseCaptureResult.filepath;\n baseResult.comparisonResult = baseCaptureResult.comparisonResult;\n baseResult.diffImagePath = baseCaptureResult.diffImagePath;\n baseResult.skipped = baseCaptureResult.skipped;\n\n for (const variant of variants) {\n const variantFilename = this.getVariantFilename(filename, variant);\n const variantOptions: ScreenshotSettings = {\n ...baseOptions,\n ...variant.options,\n };\n\n const variantResult: ScreenshotVariantCaptureDetails = {\n id: variant.id,\n label: variant.label,\n filename: variantFilename,\n };\n\n if (variantOptions.skip) {\n variantResult.skipped = true;\n variantResults.push(variantResult);\n continue;\n }\n\n const variantExtra = extras.variants?.[variant.id];\n const variantSaveDiff = variantExtra?.saveDiffImage ?? baseSaveDiff;\n const variantDiffFilename =\n variantExtra?.diffImageFilename ?? variantFilename;\n\n const variantCaptureResult = await this.captureSingleScreenshot(\n page,\n variantFilename,\n variantOptions,\n {\n saveDiffImage: variantSaveDiff,\n diffImageFilename: variantDiffFilename,\n },\n );\n\n variantResult.filepath = variantCaptureResult.filepath;\n variantResult.comparisonResult = variantCaptureResult.comparisonResult;\n variantResult.diffImagePath = variantCaptureResult.diffImagePath;\n variantResult.skipped = variantCaptureResult.skipped;\n\n variantResults.push(variantResult);\n }\n\n return {\n base: baseResult,\n variants: variantResults,\n };\n }\n\n /**\n * Applies SVG and UI optimizations for screenshots\n */\n private async applyScreenshotOptimizations(page: Page) {\n await page.addStyleTag({\n content: `\n *, *::before, *::after {\n -moz-animation: none !important;\n -moz-transition: none !important;\n transition: none !important; \n animation: none !important;\n }\n *, input, textarea { caret-color: transparent !important }\n *:focus { outline: none !important }\n *:focus-visible { outline: none !important }\n *:focus-within { outline: none !important }\n * { text-rendering: optimizeLegibility !important }\n ::-webkit-scrollbar { display: none !important }\n html { scroll-behavior: auto !important }\n svg, svg * {\n shape-rendering: crispEdges !important;\n text-rendering: geometricPrecision !important;\n vector-effect: non-scaling-stroke !important;\n }\n img { image-rendering: crisp-edges !important }\n `,\n });\n }\n\n /**\n * Captures screenshots for multiple variants, each with their own URL\n */\n async captureWithVariants(\n page: Page,\n baseFilename: string,\n baseUrl: string,\n baseOptions: ScreenshotSettings,\n variants: ScreenshotVariantWithUrl[],\n extras: ScreenshotCaptureExtras = {},\n ): Promise<ScreenshotCaptureResult> {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n const baseResult: ScreenshotCaptureDetails = { filename: baseFilename };\n const variantResults: ScreenshotVariantCaptureDetails[] = [];\n\n const baseSaveDiff = extras.saveDiffImage ?? false;\n const baseDiffFilename = extras.diffImageFilename ?? baseFilename;\n\n // Capture base screenshot\n getLogger().debug(`Going to base URL: ${baseUrl}`);\n await page.goto(baseUrl);\n await this.applyScreenshotOptimizations(page);\n const baseCaptureResult = await this.captureSingleScreenshot(\n page,\n baseFilename,\n baseOptions,\n {\n saveDiffImage: baseSaveDiff,\n diffImageFilename: baseDiffFilename,\n },\n );\n\n baseResult.filepath = baseCaptureResult.filepath;\n baseResult.comparisonResult = baseCaptureResult.comparisonResult;\n baseResult.diffImagePath = baseCaptureResult.diffImagePath;\n baseResult.skipped = baseCaptureResult.skipped;\n\n // Capture variant screenshots\n for (const variant of variants) {\n const variantFilename =\n variant.filename || this.getVariantFilename(baseFilename, variant);\n const variantOptions: ScreenshotSettings = {\n ...baseOptions,\n ...variant.options,\n };\n\n const variantResult: ScreenshotVariantCaptureDetails = {\n id: variant.id,\n label: variant.label,\n filename: variantFilename,\n };\n\n if (variantOptions.skip) {\n variantResult.skipped = true;\n variantResults.push(variantResult);\n continue;\n }\n\n // Navigate to variant URL and apply optimizations\n getLogger().debug(`Going to variant URL: ${variant.url}`);\n await page.goto(variant.url);\n await this.applyScreenshotOptimizations(page);\n\n const variantExtra = extras.variants?.[variant.id];\n const variantSaveDiff = variantExtra?.saveDiffImage ?? baseSaveDiff;\n const variantDiffFilename =\n variantExtra?.diffImageFilename ?? variantFilename;\n\n const variantCaptureResult = await this.captureSingleScreenshot(\n page,\n variantFilename,\n variantOptions,\n {\n saveDiffImage: variantSaveDiff,\n diffImageFilename: variantDiffFilename,\n },\n );\n\n variantResult.filepath = variantCaptureResult.filepath;\n variantResult.comparisonResult = variantCaptureResult.comparisonResult;\n variantResult.diffImagePath = variantCaptureResult.diffImagePath;\n variantResult.skipped = variantCaptureResult.skipped;\n\n variantResults.push(variantResult);\n }\n\n return {\n base: baseResult,\n variants: variantResults,\n };\n }\n\n /**\n * Gets the exponential backoff delay\n */\n getIncBackoffDelay(i: number, delay: number): number {\n return i > 0 ? 500 * 2 ** (i - 1) + (delay || 0) : 0;\n }\n\n /**\n * Get a page from the pool by index\n */\n getPageFromPool(index: number): Page {\n if (index < 0) {\n throw new Error(`Page index ${index} must be non-negative`);\n }\n\n if (index >= this.pages.length) {\n throw new Error(\n `Page index ${index} exceeds pool size ${this.pages.length}`,\n );\n }\n\n if (!this.pages[index]) {\n throw new Error(`Page index ${index} is undefined`);\n }\n\n return this.pages[index];\n }\n}\n\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;;;;ACJT,IAAa,uBAAb,MAAkC;CAChC,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CAEjB,YAAY,WAAmB;AAC7B,OAAK,YAAY,KAAK,QAAQ,WAAW,SAAS;AAClD,OAAK,cAAc,KAAK,QAAQ,WAAW,WAAW;AACtD,OAAK,UAAU,KAAK,QAAQ,WAAW,OAAO;AAE9C,OAAK,gBAAgB,KAAK,UAAU;AACpC,OAAK,gBAAgB,KAAK,YAAY;AACtC,OAAK,gBAAgB,KAAK,QAAQ;;CAGpC,cAAc;AACZ,OAAK,UAAU,KAAK,UAAU;;CAGhC,YAAY;AACV,OAAK,UAAU,KAAK,QAAQ;;CAG9B,qBAAqB;AACnB,OAAK,aAAa;AAClB,OAAK,WAAW;;;;;;;CAQlB,sBAAsB,gBAAwB;EAC5C,MAAM,iBAAiB,KAAK,kBAAkB,eAAe;EAC7D,MAAM,eAAe,KAAK,SAAS,KAAK,WAAW,eAAe;AAElE,MAAI,aAAa,WAAW,KAAK,CAC/B,OAAM,IAAI,MACR,0DAA0D,iBAC3D;AAGH,SAAO,KAAK,gBAAgB,aAAa;;;;;;;CAQ3C,cAAc,MAAc;EAC1B,MAAM,wBAAwB,KAAK,SAAS,OAAO,GAAG,OAAO,GAAG,KAAK;AAErE,SAAO,KAAK,gBAAgB,sBAAsB;;;;;;;CAQpD,AAAQ,gBAAgB,cAAsB;EAC5C,MAAM,aAAa,KAAK,QAAQ,KAAK,WAAW,aAAa;EAC7D,MAAM,eAAe,KAAK,QAAQ,KAAK,aAAa,aAAa;EACjE,MAAM,WAAW,KAAK,QAAQ,KAAK,SAAS,aAAa;AAEzD,OAAK,gBAAgB,aAAa;AAElC,KAAG,aAAa,YAAY,aAAa;AAEzC,MAAI,GAAG,WAAW,SAAS,CACzB,IAAG,WAAW,SAAS;AAGzB,SAAO;GACL;GACA;GACA;GACD;;;;;;CAOH,gBAAgB,UAAkB;EAChC,MAAM,MAAM,KAAK,QAAQ,SAAS;AAElC,MAAI,CAAC,GAAG,WAAW,IAAI,CACrB,IAAG,UAAU,KAAK,EAAE,WAAW,MAAM,CAAC;;;;;;CAQ1C,AAAQ,UAAU,KAAa;AAC7B,MAAI,GAAG,WAAW,IAAI,CACpB,IAAG,OAAO,KAAK;GAAE,WAAW;GAAM,OAAO;GAAM,CAAC;;;;;CAOpD,eAAuB;AACrB,SAAO,KAAK;;;;;CAMd,iBAAyB;AACvB,SAAO,KAAK;;;;;CAMd,aAAqB;AACnB,SAAO,KAAK;;;;;CAMd,kBAAkB,UAA0B;AAC1C,SAAO,KAAK,QAAQ,KAAK,WAAW,SAAS;;;;;CAM/C,oBAAoB,UAA0B;AAC5C,SAAO,KAAK,QAAQ,KAAK,aAAa,SAAS;;;;;CAMjD,gBAAgB,UAA0B;AACxC,SAAO,KAAK,QAAQ,KAAK,SAAS,SAAS;;;;;CAM7C,gBAAgB,UAAkB,MAAoB;EACpD,MAAM,WAAW,KAAK,kBAAkB,SAAS;AACjD,OAAK,gBAAgB,SAAS;AAC9B,KAAG,cAAc,UAAU,KAAK;;;;;CAMlC,cAAc,UAAkB,MAAoB;EAClD,MAAM,WAAW,KAAK,gBAAgB,SAAS;AAC/C,OAAK,gBAAgB,SAAS;AAC9B,KAAG,cAAc,UAAU,KAAK;;;;;CAMlC,gBAAgB,UAA2B;EACzC,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,SAAO,GAAG,WAAW,aAAa;;;;;CAMpC,iBAAiB,UAA0B;EACzC,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,MAAI,CAAC,GAAG,WAAW,aAAa,CAC9B,OAAM,IAAI,MAAM,6BAA6B,eAAe;AAE9D,SAAO,GAAG,aAAa,aAAa;;;;;;;CAQtC,AAAQ,kBAAkB,UAAkB;AAC1C,MAAI,KAAK,WAAW,SAAS,CAC3B,QAAO;AAGT,SAAO,KAAK,QAAQ,KAAK,WAAW,SAAS;;;;;;ACpLjD,MAAM,WACJ,QACA,QACA,MACA,OACA,QACA,YACG;AACH,QAAO,UAAU,QAAQ,QAAQ,MAAM,OAAO,QAAQ,QAAQ;;;;;;;;;;AAWhE,eAAsB,cACpB,QACA,QACA,WAAoB,OACpB,UAAsB,EAAE,EACA;CACxB,MAAM,OAAO,MAAM,QAAQ,OAAO;CAClC,MAAM,OAAO,MAAM,QAAQ,OAAO;CAElC,MAAM,EAAE,OAAO,WAAW;AAE1B,KAAI,UAAU,KAAK,SAAS,WAAW,KAAK,OAC1C,QAAO;EACL,eAAe;EACf,aAAa;EACb,mBAAmB;EACnB,QAAQ;EACR,gBAAgB;EACjB;CAGH,MAAM,OAAO,WAAW,IAAI,IAAI;EAAE;EAAO;EAAQ,CAAC,GAAG;AAErD,KAAI;EACF,MAAM,gBAAgB,QACpB,KAAK,MACL,KAAK,MACL,MAAM,MACN,OACA,QACA,QACD;EAED,MAAM,cAAc,QAAQ;EAC5B,MAAM,oBAAqB,gBAAgB,cAAe;AAK1D,SAAO;GACL;GACA;GACA;GACA,YANiB,OAAO,IAAI,KAAK,MAAM,KAAK,GAAG;GAO/C,QAAQ,SAAS,mBAAmB,eAAe,QAAQ;GAC3D,gBAAgB;GACjB;UACM,OAAO;AACd,aAAW,CAAC,MAAO,MAAgB,WAAW,gBAAgB;AAE9D,SAAO;GACL,eAAe;GACf,aAAa;GACb,mBAAmB;GACnB,QAAQ;GACR,gBAAgB;GAChB,OAAQ,MAAgB,WAAW;GACpC;;;;;;AAOL,eAAe,QAAQ,QAAuC;AAC5D,KAAI,OAAO,SAAS,OAAO,CACzB,QAAO,IAAI,KAAK,KAAK,OAAO;MACvB;EACL,MAAM,SAAS,GAAG,aAAa,OAAO;AACtC,SAAO,IAAI,KAAK,KAAK,OAAO;;;;;;;;;;AAyChC,MAAM,YACJ,mBACA,eACA,YACG;AACH,KAAI,QAAQ,qBAAqB,QAAQ,cACvC,QACE,qBAAqB,QAAQ,qBAC7B,iBAAiB,QAAQ;AAI7B,KAAI,QAAQ,kBACV,QAAO,qBAAqB,QAAQ;AAGtC,KAAI,QAAQ,cACV,QAAO,iBAAiB,QAAQ;AAIlC,QAAO,kBAAkB;;;;;;AAO3B,SAAgB,uBAAuB,OAAe,QAAwB;CAC5E,MAAM,MAAM,IAAI,IAAI;EAAE;EAAO;EAAQ,CAAC;AAEtC,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,IAC1B,MAAK,IAAI,IAAI,GAAG,IAAI,OAAO,KAAK;EAC9B,MAAM,MAAO,QAAQ,IAAI,KAAM;AAC/B,MAAI,KAAK,OAAO;AAChB,MAAI,KAAK,MAAM,KAAK;AACpB,MAAI,KAAK,MAAM,KAAK;AACpB,MAAI,KAAK,MAAM,KAAK;;AAIxB,QAAO,IAAI,KAAK,MAAM,IAAI;;;;;ACpK5B,MAAMA,oBAAgC;CACpC,WAAW;CACX,WAAW;CACX,iBAAiB;CACjB,eAAe;CACf,mBAAmB;CACpB;AAiCD,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB;CACA,WAA6B,EAAE;CAC/B,QAAgB,EAAE;CAClB;CACA;CACA;CACA;CAEA,YAAY,SAQT;AACD,OAAK,cAAc,QAAQ,eAAe;AAC1C,OAAK,WAAW,QAAQ,aAAa;AACrC,OAAK,WAAW,QAAQ,YAAY;GAAE,OAAO;GAAM,QAAQ;GAAM;AACjE,OAAK,YAAY,QAAQ,aAAa;AACtC,OAAK,OAAO;GAAE,GAAG;GAAmB,GAAG,QAAQ;GAAM;AACrD,OAAK,cAAc,KAAK,IAAI,GAAG,QAAQ,eAAe,EAAE;AAExD,OAAK,SAAS,WAAW;AACzB,OAAK,UAAU,QAAQ,WAAW;AAClC,OAAK,aAAa,IAAI,qBAAqB,KAAK,UAAU;;;;;CAM5D,MAAM,OAAO;EAQX,MAAM,eANa;GACjB;GACA;GACA;GACD,CAE+B,KAAK;AACrC,MAAI,CAAC,aACH,OAAM,IAAI,MAAM,6BAA6B,KAAK,cAAc;AAGlE,OAAK,UAAU,MAAM,aAAa,OAAO,EACvC,UAAU,KAAK,UAChB,CAAC;EAEF,MAAM,oBAAoB,MAAM,KAAK,QAAQ,YAAY,EACtD,SAAS,CACT,MAAM,SAAS,KAAK,eAAe,UAAU,UAAU,CAAC;AAG3D,OAAK,WAAW,EAAE;AAClB,OAAK,QAAQ,EAAE;AAEf,OAAK,IAAI,IAAI,GAAG,IAAI,KAAK,aAAa,KAAK;GACzC,MAAM,UAAU,MAAM,KAAK,QAAQ,WAAW;IAC5C,eAAe;IACf,mBAAmB;IACnB,WAAW,GAAG,MAAM,iBAAiB;IACrC,UAAU,KAAK;IAChB,CAAC;GACF,MAAM,OAAO,MAAM,QAAQ,SAAS;AAEpC,QAAK,SAAS,KAAK,QAAQ;AAC3B,QAAK,MAAM,KAAK,KAAK;;AAIvB,OAAK,UAAU,KAAK,SAAS,MAAM;AACnC,OAAK,OAAO,KAAK,MAAM,MAAM;;;;;;CAO/B,MAAM,QAAQ;AACZ,OAAK,MAAM,WAAW,KAAK,SACzB,OAAM,QAAQ,OAAO;AAEvB,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;;;;CAO9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;;;;CAMzD,MAAM,eACJ,MACA,UACA,SACA;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI,QAAQ,KACV;AAGF,MAAI;GAEF,MAAM,WAAW,KAAK,WAAW,kBAAkB,SAAS;AAG5D,QAAK,WAAW,gBAAgB,SAAS;GAGzC,MAAM,oBAAoB;IACxB,MAAM;IACN,UAAU,QAAQ;IAClB,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACP,YAAY;IACZ,OAAO;IACR;AAED,SAAM,KAAK,aAAa,MAAM,QAAQ,UAAU,YAAY;AAC1D,QAAI,QAAQ,MACV,OAAM,KAAK,eAAe,QAAQ,MAAM;AAG1C,UAAM,KAAK,WAAW,kBAAkB;KACxC;AAEF,QAAK,OAAO,QAAQ,qBAAqB,WAAW;AAEpD,UAAO;WACA,OAAO;AACd,QAAK,OAAO,MACV,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;;;;;CAQV,MAAc,aACZ,MACA,UACA,QACY;AACZ,MAAI,CAAC,SACH,QAAO,QAAQ;EAGjB,MAAM,mBAAmB,KAAK,cAAc;AAG5C,MACE,oBACA,iBAAiB,UAAU,SAAS,SACpC,iBAAiB,WAAW,SAAS,OAErC,QAAO,QAAQ;AAGjB,QAAM,KAAK,gBAAgB,SAAS;AAEpC,MAAI;AACF,UAAO,MAAM,QAAQ;YACb;AAER,OAAI,iBACF,OAAM,KAAK,gBAAgB,iBAAiB;;;;;;CAQlD,MAAM,qBACJ,MACA,SACiB;AACjB,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI,QAAQ,KACV,OAAM,IAAI,MAAM,qBAAqB;AAGvC,MAAI;GAEF,MAAM,oBAAoB;IACxB,UAAU,QAAQ;IAClB,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACP,YAAY;IACZ,OAAO;IACR;AAcD,UAZe,MAAM,KAAK,aACxB,MACA,QAAQ,UACR,YAAY;AACV,QAAI,QAAQ,MACV,OAAM,KAAK,eAAe,QAAQ,MAAM;AAG1C,WAAO,KAAK,WAAW,kBAAkB;KAE5C;WAGM,OAAO;AACd,QAAK,OAAO,MACV,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,6BACJ,MACA,UACA,gBACA,SAQC;AACD,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;GAEF,MAAM,WAAW,KAAK,WAAW,kBAAkB,SAAS;GAE5D,MAAMC,qBAAyC;IAC7C,UAAU,QAAQ;IAClB,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO,QAAQ;IACf,UAAU,QAAQ;IACnB;GAED,MAAM,kBAAkB,MAAM,KAAK,gBACjC,MACA,gBACA,mBACD;AAED,OAAI,CAAC,gBAAgB,eACnB,OAAM,IAAI,MAAM,iCAAiC;AAInD,QAAK,WAAW,gBAAgB,UAAU,gBAAgB,eAAe;AACzE,QAAK,OAAO,MAAM,4BAA4B,WAAW;AAEzD,OAAI,gBAAgB,OAClB,MAAK,OAAO,QAAQ,sCAAsC;OAE1D,MAAK,OAAO,MAAM,sCAAsC;GAG1D,IAAIC;AAGJ,OACE,QAAQ,iBACR,gBAAgB,iBAAiB,cACjC,CAAC,gBAAgB,QACjB;IACA,MAAM,eAAe,QAAQ,qBAAqB;AAElD,oBAAgB,KAAK,WAAW,gBAAgB,aAAa;AAE7D,SAAK,WAAW,cACd,cACA,gBAAgB,iBAAiB,WAClC;AAED,SAAK,OAAO,MAAM,qBAAqB,gBAAgB;;AAIzD,OAAI,gBAAgB,iBAAiB,gBAAgB;AACnD,SAAK,OAAO,KAAK,sDAAsD;IAEvE,MAAM,eAAe,QAAQ,qBAAqB;AAClD,oBAAgB,KAAK,WAAW,gBAAgB,aAAa;IAC7D,MAAM,aAAa,uBAAuB,KAAK,IAAI;AAEnD,SAAK,WAAW,cAAc,cAAc,WAAW;AAEvD,SAAK,OAAO,MAAM,0BAA0B,gBAAgB;;AAG9D,UAAO;IACL,gBAAgB;IAChB,kBAAkB,gBAAgB;IAClC;IACD;WACM,OAAO;AACd,QAAK,OAAO,MACV,8CAA8C,KAAK,KAAK,CAAC,IACxD,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,gBACJ,MACA,gBACA,SACA;AACA,OAAK,IAAI,IAAI,GAAG,IAAI,KAAK,SAAS,IAChC,KAAI;GACF,MAAM,mBAAmB,MAAM,KAAK,qBAAqB,MAAM;IAC7D,GAAG;IACH,OAAO,KAAK,mBAAmB,GAAG,QAAQ,SAAS,EAAE;IACtD,CAAC;AAEF,OAAI,CAAC,iBACH,OAAM,IAAI,MAAM,iCAAiC;GAGnD,MAAM,mBAAmB,MAAM,cAC7B,kBACA,gBACA,MACA,KAAK,KACN;AAGD,OAAI,iBAAiB,eACnB,QAAO;IACL,gBAAgB;IAChB;IACA,QAAQ;IACT;AAIH,OAAI,MAAM,KAAK,UAAU,KAAK,CAAC,iBAAiB,QAAQ;AACtD,SAAK,OAAO,MACV,oCAAoC,KAAK,QAAQ,UAClD;AACD,WAAO;KACL,gBAAgB;KAChB;KACA,QAAQ;KACT;;AAGH,OAAI,iBAAiB,OACnB,QAAO;IACL,gBAAgB;IAChB;IACA,QAAQ;IACT;OAED,MAAK,OAAO,KACV,yCAAyC,KAAK,mBAAmB,IAAI,GAAG,QAAQ,SAAS,EAAE,CAAC,6BAA6B,iBAAiB,cAAc,qBAAqB,iBAAiB,kBAAkB,QAAQ,EAAE,CAAC,IAC5N;WAEI,OAAO;AACd,QAAK,OAAO,MACV,iCAAiC,IAAI,EAAE,YACtC,MAAgB,QAClB;;AAIL,SAAO;GACL,gBAAgB;GAChB,kBAAkB;GAClB,QAAQ;GACT;;CAGH,mBAAmB,UAAkB,SAAoC;AACvE,MAAI,QAAQ,SACV,QAAO,QAAQ;EAGjB,MAAM,SAAS,KAAK,MAAM,SAAS;EAMnC,MAAM,SALc,QAAQ,GACzB,MAAM,CACN,QAAQ,oBAAoB,IAAI,CAChC,QAAQ,OAAO,IAAI,CACnB,QAAQ,UAAU,GAAG,IACM;EAC9B,MAAM,MAAM,OAAO,OAAO;EAC1B,MAAM,cAAc,GAAG,OAAO,KAAK,IAAI,SAAS;AAEhD,SAAO,OAAO,MAAM,KAAK,KAAK,OAAO,KAAK,YAAY,GAAG;;;;;CAM3D,MAAc,wBACZ,MACA,UACA,SACA,SAGI,EAAE,EAC6B;EACnC,MAAMC,SAAmC,EAAE,UAAU;AAErD,MAAI,QAAQ,MAAM;AAChB,UAAO,UAAU;AACjB,UAAO;;EAGT,MAAM,WAAW,OAAO,iBAAiB;EACzC,MAAM,eAAe,OAAO,qBAAqB;AAEjD,MAAI,CAAC,KAAK,WAAW,gBAAgB,SAAS,EAAE;AAC9C,QAAK,OAAO,MACV,gCAAgC,SAAS,qBAC1C;AAED,UAAO,WAAW,MAAM,KAAK,eAAe,MAAM,UAAU,QAAQ;SAC/D;GACL,MAAM,EAAE,gBAAgB,kBAAkB,kBACxC,MAAM,KAAK,6BACT,MACA,UACA,KAAK,WAAW,iBAAiB,SAAS,EAC1C;IACE,GAAG;IACH,eAAe;IACf,mBAAmB;IACpB,CACF;AAEH,UAAO,WAAW;AAClB,UAAO,mBAAmB;AAC1B,UAAO,gBAAgB;;AAGzB,SAAO;;CAGT,MAAM,QACJ,MACA,UACA,SACA,SAAkC,EAAE,EACF;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAM,EAAE,WAAW,EAAE,CAAE,GAAG,gBAAgB;EAC1C,MAAMC,aAAuC,EAAE,UAAU;EACzD,MAAMC,iBAAoD,EAAE;EAE5D,MAAM,eAAe,OAAO,iBAAiB;EAC7C,MAAM,mBAAmB,OAAO,qBAAqB;AAErD,MAAI,YAAY,KACd,QAAO;GACL,MAAM;IAAE,GAAG;IAAY,SAAS;IAAM;GACtC,UAAU,SAAS,KAAK,aAAa;IACnC,IAAI,QAAQ;IACZ,OAAO,QAAQ;IACf,UAAU,KAAK,mBAAmB,UAAU,QAAQ;IACpD,SAAS;IACV,EAAE;GACJ;EAIH,MAAM,oBAAoB,MAAM,KAAK,wBACnC,MACA,UACA,aACA;GACE,eAAe;GACf,mBAAmB;GACpB,CACF;AAED,aAAW,WAAW,kBAAkB;AACxC,aAAW,mBAAmB,kBAAkB;AAChD,aAAW,gBAAgB,kBAAkB;AAC7C,aAAW,UAAU,kBAAkB;AAEvC,OAAK,MAAM,WAAW,UAAU;GAC9B,MAAM,kBAAkB,KAAK,mBAAmB,UAAU,QAAQ;GAClE,MAAMC,iBAAqC;IACzC,GAAG;IACH,GAAG,QAAQ;IACZ;GAED,MAAMC,gBAAiD;IACrD,IAAI,QAAQ;IACZ,OAAO,QAAQ;IACf,UAAU;IACX;AAED,OAAI,eAAe,MAAM;AACvB,kBAAc,UAAU;AACxB,mBAAe,KAAK,cAAc;AAClC;;GAGF,MAAM,eAAe,OAAO,WAAW,QAAQ;GAC/C,MAAM,kBAAkB,cAAc,iBAAiB;GACvD,MAAM,sBACJ,cAAc,qBAAqB;GAErC,MAAM,uBAAuB,MAAM,KAAK,wBACtC,MACA,iBACA,gBACA;IACE,eAAe;IACf,mBAAmB;IACpB,CACF;AAED,iBAAc,WAAW,qBAAqB;AAC9C,iBAAc,mBAAmB,qBAAqB;AACtD,iBAAc,gBAAgB,qBAAqB;AACnD,iBAAc,UAAU,qBAAqB;AAE7C,kBAAe,KAAK,cAAc;;AAGpC,SAAO;GACL,MAAM;GACN,UAAU;GACX;;;;;CAMH,MAAc,6BAA6B,MAAY;AACrD,QAAM,KAAK,YAAY,EACrB,SAAS;;;;;;;;;;;;;;;;;;;;SAqBV,CAAC;;;;;CAMJ,MAAM,oBACJ,MACA,cACA,SACA,aACA,UACA,SAAkC,EAAE,EACF;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMH,aAAuC,EAAE,UAAU,cAAc;EACvE,MAAMC,iBAAoD,EAAE;EAE5D,MAAM,eAAe,OAAO,iBAAiB;EAC7C,MAAM,mBAAmB,OAAO,qBAAqB;AAGrD,aAAW,CAAC,MAAM,sBAAsB,UAAU;AAClD,QAAM,KAAK,KAAK,QAAQ;AACxB,QAAM,KAAK,6BAA6B,KAAK;EAC7C,MAAM,oBAAoB,MAAM,KAAK,wBACnC,MACA,cACA,aACA;GACE,eAAe;GACf,mBAAmB;GACpB,CACF;AAED,aAAW,WAAW,kBAAkB;AACxC,aAAW,mBAAmB,kBAAkB;AAChD,aAAW,gBAAgB,kBAAkB;AAC7C,aAAW,UAAU,kBAAkB;AAGvC,OAAK,MAAM,WAAW,UAAU;GAC9B,MAAM,kBACJ,QAAQ,YAAY,KAAK,mBAAmB,cAAc,QAAQ;GACpE,MAAMC,iBAAqC;IACzC,GAAG;IACH,GAAG,QAAQ;IACZ;GAED,MAAMC,gBAAiD;IACrD,IAAI,QAAQ;IACZ,OAAO,QAAQ;IACf,UAAU;IACX;AAED,OAAI,eAAe,MAAM;AACvB,kBAAc,UAAU;AACxB,mBAAe,KAAK,cAAc;AAClC;;AAIF,cAAW,CAAC,MAAM,yBAAyB,QAAQ,MAAM;AACzD,SAAM,KAAK,KAAK,QAAQ,IAAI;AAC5B,SAAM,KAAK,6BAA6B,KAAK;GAE7C,MAAM,eAAe,OAAO,WAAW,QAAQ;GAC/C,MAAM,kBAAkB,cAAc,iBAAiB;GACvD,MAAM,sBACJ,cAAc,qBAAqB;GAErC,MAAM,uBAAuB,MAAM,KAAK,wBACtC,MACA,iBACA,gBACA;IACE,eAAe;IACf,mBAAmB;IACpB,CACF;AAED,iBAAc,WAAW,qBAAqB;AAC9C,iBAAc,mBAAmB,qBAAqB;AACtD,iBAAc,gBAAgB,qBAAqB;AACnD,iBAAc,UAAU,qBAAqB;AAE7C,kBAAe,KAAK,cAAc;;AAGpC,SAAO;GACL,MAAM;GACN,UAAU;GACX;;;;;CAMH,mBAAmB,GAAW,OAAuB;AACnD,SAAO,IAAI,IAAI,MAAM,MAAM,IAAI,MAAM,SAAS,KAAK;;;;;CAMrD,gBAAgB,OAAqB;AACnC,MAAI,QAAQ,EACV,OAAM,IAAI,MAAM,cAAc,MAAM,uBAAuB;AAG7D,MAAI,SAAS,KAAK,MAAM,OACtB,OAAM,IAAI,MACR,cAAc,MAAM,qBAAqB,KAAK,MAAM,SACrD;AAGH,MAAI,CAAC,KAAK,MAAM,OACd,OAAM,IAAI,MAAM,cAAc,MAAM,eAAe;AAGrD,SAAO,KAAK,MAAM;;;AAItB,yBAAe"}
1
+ {"version":3,"file":"index.mjs","names":["defaultDiffConfig: DiffConfig","screenshotSettings: ScreenshotSettings","diffImagePath: string | undefined","result: ScreenshotCaptureDetails","baseResult: ScreenshotCaptureDetails","variantResults: ScreenshotVariantCaptureDetails[]","variantOptions: ScreenshotSettings","variantResult: ScreenshotVariantCaptureDetails"],"sources":["../src/compare.ts","../src/config.ts","../src/filesystem.ts","../src/screenshot.ts"],"sourcesContent":["import fs from \"node:fs\";\nimport blazediff from \"@blazediff/core\";\nimport type { BlazeDiffOptions } from \"@blazediff/types\";\nimport { getLogger } from \"@cappa/logger\";\nimport { PNG } from \"pngjs\";\nimport type { DiffConfig } from \"./types\";\n\nexport type CompareOptions = BlazeDiffOptions;\n\nexport interface CompareResult {\n numDiffPixels: number;\n totalPixels: number;\n percentDifference: number;\n diffBuffer?: Buffer; // PNG buffer of the diff image\n passed: boolean; // Whether the comparison passed based on threshold\n error?: string; // Error message if the comparison failed\n differentSizes: boolean; // Whether the images have different sizes\n}\n\nconst compare = (\n image1: Uint8Array | Uint8ClampedArray,\n image2: Uint8Array | Uint8ClampedArray,\n diff: Uint8Array | Uint8ClampedArray | undefined,\n width: number,\n height: number,\n options?: BlazeDiffOptions,\n) => {\n return blazediff(image1, image2, diff, width, height, options);\n};\n\n/**\n * Compare two PNG images and return the difference\n * @param image1 - First image (file path or Buffer)\n * @param image2 - Second image (file path or Buffer)\n * @param withDiff - Whether to create a diff image\n * @param options - Comparison options\n * @returns Comparison result\n */\nexport async function compareImages(\n image1: string | Buffer,\n image2: string | Buffer,\n withDiff: boolean = false,\n options: DiffConfig = {},\n): Promise<CompareResult> {\n const png1 = await loadPNG(image1);\n const png2 = await loadPNG(image2);\n\n const { width, height } = png1;\n\n if (width !== png2.width || height !== png2.height) {\n return {\n numDiffPixels: 0,\n totalPixels: 0,\n percentDifference: 0,\n passed: false,\n differentSizes: true,\n };\n }\n\n const diff = withDiff ? new PNG({ width, height }) : undefined;\n\n try {\n const numDiffPixels = compare(\n png1.data,\n png2.data,\n diff?.data,\n width,\n height,\n options,\n );\n\n const totalPixels = width * height;\n const percentDifference = (numDiffPixels / totalPixels) * 100;\n\n // Convert diff image to buffer\n const diffBuffer = diff ? PNG.sync.write(diff) : undefined;\n\n return {\n numDiffPixels,\n totalPixels,\n percentDifference,\n diffBuffer,\n passed: isPassed(percentDifference, numDiffPixels, options),\n differentSizes: false,\n };\n } catch (error) {\n getLogger().error((error as Error).message || \"Unknown error\");\n\n return {\n numDiffPixels: 0,\n totalPixels: 0,\n percentDifference: 0,\n passed: false,\n differentSizes: false,\n error: (error as Error).message || \"Unknown error\",\n };\n }\n}\n\n/**\n * Load a PNG image from file path or Buffer\n */\nasync function loadPNG(source: string | Buffer): Promise<PNG> {\n if (Buffer.isBuffer(source)) {\n return PNG.sync.read(source);\n } else {\n const buffer = fs.readFileSync(source);\n return PNG.sync.read(buffer);\n }\n}\n\n/**\n * Save a comparison result diff image to file\n * @param result - Comparison result containing diffBuffer\n * @param outputPath - Path to save the diff image\n */\nexport function saveDiffImage(result: CompareResult, outputPath: string): void {\n if (!result.diffBuffer) {\n throw new Error(\"No diff buffer available in comparison result\");\n }\n\n fs.writeFileSync(outputPath, result.diffBuffer);\n}\n\n/**\n * Quick comparison function that returns only pass/fail\n * @param image1 - First image (file path or Buffer)\n * @param image2 - Second image (file path or Buffer)\n * @param options - Comparison options\n * @returns Whether the images match\n */\nexport async function imagesMatch(\n image1: string | Buffer,\n image2: string | Buffer,\n options: DiffConfig = {},\n): Promise<boolean> {\n const result = await compareImages(image1, image2, false, options);\n\n return result.passed;\n}\n\n/**\n * Check if the comparison passed based on the options\n * @param percentDifference - Percentage difference between the images\n * @param numDiffPixels - Number of different pixels\n * @param options - Comparison options\n * @returns Whether the comparison passed\n */\nconst isPassed = (\n percentDifference: number,\n numDiffPixels: number,\n options: DiffConfig,\n) => {\n if (options.maxDiffPercentage && options.maxDiffPixels) {\n return (\n percentDifference <= options.maxDiffPercentage &&\n numDiffPixels <= options.maxDiffPixels\n );\n }\n\n if (options.maxDiffPercentage) {\n return percentDifference <= options.maxDiffPercentage;\n }\n\n if (options.maxDiffPixels) {\n return numDiffPixels <= options.maxDiffPixels;\n }\n\n // fallback to 0 pixels\n return numDiffPixels === 0;\n};\n\n/**\n * Create different size png image with all pixels red\n * @returns\n */\nexport function createDiffSizePngImage(width: number, height: number): Buffer {\n const png = new PNG({ width, height });\n\n for (let y = 0; y < height; y++) {\n for (let x = 0; x < width; x++) {\n const idx = (width * y + x) << 2;\n png.data[idx] = 255; // red\n png.data[idx + 1] = 0; // green\n png.data[idx + 2] = 0; // blue\n png.data[idx + 3] = 255; // alpha\n }\n }\n\n return PNG.sync.write(png);\n}\n","import type { ConfigEnv, PossiblePromise, UserConfig } from \"./types\";\n\n/**\n * Type helper to make it easier to use cappa.config.ts, or a function that returns it. The function receives a ConfigEnv object.\n */\nexport function defineConfig(\n options:\n | PossiblePromise<UserConfig>\n | ((env: ConfigEnv) => PossiblePromise<UserConfig>),\n): typeof options {\n return options;\n}\n","import fs from \"node:fs\";\nimport path from \"node:path\";\n\n/**\n * Class for interacting with the local file system to store the screenshots.\n */\nexport class ScreenshotFileSystem {\n private readonly actualDir: string;\n private readonly expectedDir: string;\n private readonly diffDir: string;\n\n constructor(outputDir: string) {\n this.actualDir = path.resolve(outputDir, \"actual\");\n this.expectedDir = path.resolve(outputDir, \"expected\");\n this.diffDir = path.resolve(outputDir, \"diff\");\n\n this.ensureParentDir(this.actualDir);\n this.ensureParentDir(this.expectedDir);\n this.ensureParentDir(this.diffDir);\n }\n\n clearActual() {\n this.removeDir(this.actualDir);\n }\n\n clearDiff() {\n this.removeDir(this.diffDir);\n }\n\n clearActualAndDiff() {\n this.clearActual();\n this.clearDiff();\n }\n\n /**\n * Approve a screenshot based on its actual file path.\n * @param actualFilePath - The path to the actual screenshot file.\n * @returns The paths to the actual, expected, and diff screenshot files.\n */\n approveFromActualPath(actualFilePath: string) {\n const actualAbsolute = this.resolveActualPath(actualFilePath);\n const relativePath = path.relative(this.actualDir, actualAbsolute);\n\n if (relativePath.startsWith(\"..\")) {\n throw new Error(\n `Cannot approve screenshot outside of actual directory: ${actualFilePath}`,\n );\n }\n\n return this.approveRelative(relativePath);\n }\n\n /**\n * Approve a screenshot based on its name.\n * @param name - The name of the screenshot. Can include '.png' extension.\n * @returns The paths to the actual, expected, and diff screenshot files.\n */\n approveByName(name: string) {\n const relativeWithExtension = name.endsWith(\".png\") ? name : `${name}.png`;\n\n return this.approveRelative(relativeWithExtension);\n }\n\n /**\n * Approve a screenshot based on a relative path.\n * @param relativePath - The relative path to the screenshot.\n * @returns The paths to the actual, expected, and diff screenshot files.\n */\n private approveRelative(relativePath: string) {\n const actualPath = path.resolve(this.actualDir, relativePath);\n const expectedPath = path.resolve(this.expectedDir, relativePath);\n const diffPath = path.resolve(this.diffDir, relativePath);\n\n this.ensureParentDir(expectedPath);\n\n fs.copyFileSync(actualPath, expectedPath);\n\n if (fs.existsSync(diffPath)) {\n fs.unlinkSync(diffPath);\n }\n\n return {\n actualPath,\n expectedPath,\n diffPath,\n };\n }\n\n /**\n * Ensure the parent directory of a file exists. If not, it creates it.\n * @param filePath - The path to the file.\n */\n ensureParentDir(filePath: string) {\n const dir = path.dirname(filePath);\n\n if (!fs.existsSync(dir)) {\n fs.mkdirSync(dir, { recursive: true });\n }\n }\n\n /**\n * Remove a directory and all its contents.\n * @param dir - The path to the directory.\n */\n private removeDir(dir: string) {\n if (fs.existsSync(dir)) {\n fs.rmSync(dir, { recursive: true, force: true });\n }\n }\n\n /**\n * Get the actual directory path\n */\n getActualDir(): string {\n return this.actualDir;\n }\n\n /**\n * Get the expected directory path\n */\n getExpectedDir(): string {\n return this.expectedDir;\n }\n\n /**\n * Get the diff directory path\n */\n getDiffDir(): string {\n return this.diffDir;\n }\n\n /**\n * Get the path to an actual screenshot file\n */\n getActualFilePath(filename: string): string {\n return path.resolve(this.actualDir, filename);\n }\n\n /**\n * Get the path to an expected screenshot file\n */\n getExpectedFilePath(filename: string): string {\n return path.resolve(this.expectedDir, filename);\n }\n\n /**\n * Get the path to a diff screenshot file\n */\n getDiffFilePath(filename: string): string {\n return path.resolve(this.diffDir, filename);\n }\n\n /**\n * Write a file to the actual directory\n */\n writeActualFile(filename: string, data: Buffer): void {\n const filepath = this.getActualFilePath(filename);\n this.ensureParentDir(filepath);\n fs.writeFileSync(filepath, data);\n }\n\n /**\n * Write a file to the diff directory\n */\n writeDiffFile(filename: string, data: Buffer): void {\n const filepath = this.getDiffFilePath(filename);\n this.ensureParentDir(filepath);\n fs.writeFileSync(filepath, data);\n }\n\n /**\n * Check if an expected file exists\n */\n hasExpectedFile(filename: string): boolean {\n const expectedPath = this.getExpectedFilePath(filename);\n return fs.existsSync(expectedPath);\n }\n\n /**\n * Read an expected file\n */\n readExpectedFile(filename: string): Buffer {\n const expectedPath = this.getExpectedFilePath(filename);\n if (!fs.existsSync(expectedPath)) {\n throw new Error(`Expected image not found: ${expectedPath}`);\n }\n return fs.readFileSync(expectedPath);\n }\n\n /**\n * Resolve the actual path of a screenshot file.\n * @param filePath - The path to the screenshot file.\n * @returns The actual path of the screenshot file.\n */\n private resolveActualPath(filePath: string) {\n if (path.isAbsolute(filePath)) {\n return filePath;\n }\n\n return path.resolve(this.actualDir, filePath);\n }\n}\n","import path from \"node:path\";\nimport { getLogger, type Logger } from \"@cappa/logger\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\nimport {\n type CompareResult,\n compareImages,\n createDiffSizePngImage,\n} from \"./compare\";\nimport { ScreenshotFileSystem } from \"./filesystem\";\nimport type {\n DiffConfig,\n ScreenshotOptions,\n ScreenshotSettings,\n ScreenshotVariant,\n ScreenshotVariantWithUrl,\n} from \"./types\";\n\nconst defaultDiffConfig: DiffConfig = {\n threshold: 0.1,\n includeAA: false,\n fastBufferCheck: true,\n maxDiffPixels: 0,\n maxDiffPercentage: 0,\n};\n\nexport interface ScreenshotCaptureDetails {\n filename: string;\n filepath?: string;\n comparisonResult?: CompareResult;\n diffImagePath?: string;\n skipped?: boolean;\n}\n\nexport interface ScreenshotVariantCaptureDetails\n extends ScreenshotCaptureDetails {\n id: string;\n label?: string;\n}\n\nexport interface ScreenshotCaptureResult {\n base: ScreenshotCaptureDetails;\n variants: ScreenshotVariantCaptureDetails[];\n}\n\nexport interface ScreenshotCaptureExtras {\n saveDiffImage?: boolean;\n diffImageFilename?: string;\n variants?: Record<\n string,\n {\n saveDiffImage?: boolean;\n diffImageFilename?: string;\n }\n >;\n}\n\nclass ScreenshotTool {\n browserType: \"chromium\" | \"firefox\" | \"webkit\";\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n concurrency: number;\n contexts: BrowserContext[] = [];\n pages: Page[] = [];\n diff: DiffConfig;\n logger: Logger;\n retries: number;\n filesystem: ScreenshotFileSystem;\n\n constructor(options: {\n browserType?: \"chromium\" | \"firefox\" | \"webkit\";\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n diff?: DiffConfig;\n retries?: number;\n concurrency?: number;\n }) {\n this.browserType = options.browserType || \"chromium\";\n this.headless = options.headless !== false; // Default to headless\n this.viewport = options.viewport || { width: 1920, height: 1080 };\n this.outputDir = options.outputDir || \"./screenshots\";\n this.diff = { ...defaultDiffConfig, ...options.diff };\n this.concurrency = Math.max(1, options.concurrency || 1);\n\n this.logger = getLogger();\n this.retries = options.retries || 2;\n this.filesystem = new ScreenshotFileSystem(this.outputDir);\n }\n\n /**\n * Initialize playwright and page\n */\n async init() {\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass = browserMap[this.browserType];\n if (!browserClass) {\n throw new Error(`Unsupported browser type: ${this.browserType}`);\n }\n\n this.browser = await browserClass.launch({\n headless: this.headless,\n });\n\n const defaultUserAgent = (await this.browser.newContext())\n .newPage()\n .then((page) => page.evaluate(() => navigator.userAgent));\n\n // Create N contexts and pages\n this.contexts = [];\n this.pages = [];\n\n for (let i = 0; i < this.concurrency; i++) {\n const context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 2,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n viewport: this.viewport,\n });\n const page = await context.newPage();\n\n this.contexts.push(context);\n this.pages.push(page);\n }\n\n // Backward compatibility\n this.context = this.contexts[0] ?? null;\n this.page = this.pages[0] ?? null;\n }\n\n /**\n * Closes browser\n * If not closed, the process will not exit\n */\n async close() {\n for (const context of this.contexts) {\n await context.close();\n }\n if (this.browser) {\n await this.browser.close();\n }\n }\n\n /**\n * Navigates to a URL with \"domcontentloaded\" waitUntil\n */\n async goTo(page: Page, url: string) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n }\n\n /**\n * Takes a screenshot of the page\n */\n async takeScreenshot(\n page: Page,\n filename: string,\n options: ScreenshotSettings,\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n if (options.skip) {\n return;\n }\n\n try {\n // Generate filename - save to actual directory\n const filepath = this.filesystem.getActualFilePath(filename);\n\n // Ensure parent directories exist before taking screenshot\n this.filesystem.ensureParentDir(filepath);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage: options.fullPage,\n type: \"png\" as const,\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n animations: \"disabled\",\n caret: \"hide\",\n } satisfies PageScreenshotOptions;\n\n await this.withViewport(page, options.viewport, async () => {\n if (options.delay) {\n await page.waitForTimeout(options.delay);\n }\n\n await page.screenshot(screenshotOptions);\n });\n\n this.logger.success(`Screenshot saved: ${filepath}`);\n\n return filepath;\n } catch (error) {\n this.logger.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n /**\n * Sets the viewport size and executes the action, ensuring the original viewport is restored\n * even if the action throws an error.\n */\n private async withViewport<T>(\n page: Page,\n viewport: ScreenshotSettings[\"viewport\"],\n action: () => Promise<T>,\n ): Promise<T> {\n if (!viewport) {\n return action();\n }\n\n const previousViewport = page.viewportSize();\n\n // Check if the new viewport is the same as the current one\n if (\n previousViewport &&\n previousViewport.width === viewport.width &&\n previousViewport.height === viewport.height\n ) {\n return action();\n }\n\n await page.setViewportSize(viewport);\n\n try {\n return await action();\n } finally {\n // Always restore the original viewport, even if the action throws an error\n if (previousViewport) {\n await page.setViewportSize(previousViewport);\n }\n }\n }\n\n /**\n * Takes a screenshot and returns the buffer (for comparison purposes)\n */\n async takeScreenshotBuffer(\n page: Page,\n options: ScreenshotSettings,\n ): Promise<Buffer> {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n if (options.skip) {\n throw new Error(\"Screenshot skipped\");\n }\n\n try {\n // Take screenshot without saving to file\n const screenshotOptions = {\n fullPage: options.fullPage,\n type: \"png\" as const,\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n animations: \"disabled\",\n caret: \"hide\",\n } satisfies PageScreenshotOptions;\n\n const buffer = await this.withViewport(\n page,\n options.viewport,\n async () => {\n if (options.delay) {\n await page.waitForTimeout(options.delay);\n }\n\n return page.screenshot(screenshotOptions);\n },\n );\n\n return buffer;\n } catch (error) {\n this.logger.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeScreenshotWithComparison(\n page: Page,\n filename: string,\n referenceImage: Buffer,\n options: ScreenshotSettings & {\n saveDiffImage?: boolean;\n diffImageFilename?: string;\n },\n ): Promise<{\n screenshotPath: string;\n comparisonResult: CompareResult;\n diffImagePath?: string;\n }> {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Generate filename and take screenshot - save to actual directory\n const filepath = this.filesystem.getActualFilePath(filename);\n\n const screenshotSettings: ScreenshotSettings = {\n fullPage: options.fullPage,\n mask: options.mask,\n omitBackground: options.omitBackground,\n delay: options.delay,\n viewport: options.viewport,\n };\n\n const retryScreenshot = await this.retryScreenshot(\n page,\n referenceImage,\n screenshotSettings,\n );\n\n if (!retryScreenshot.screenshotPath) {\n throw new Error(\"Screenshot buffer is undefined\");\n }\n\n // Save screenshot to actual directory\n this.filesystem.writeActualFile(filename, retryScreenshot.screenshotPath);\n this.logger.debug(`Actual screenshot saved: ${filepath}`);\n\n if (retryScreenshot.passed) {\n this.logger.success(`Screenshot passed visual comparison`);\n } else {\n this.logger.error(`Screenshot failed visual comparison`);\n }\n\n let diffImagePath: string | undefined;\n\n // Save diff image if requested and there are differences\n if (\n options.saveDiffImage &&\n retryScreenshot.comparisonResult.diffBuffer &&\n !retryScreenshot.passed\n ) {\n const diffFilename = options.diffImageFilename || filename;\n // Save to diff directory\n diffImagePath = this.filesystem.getDiffFilePath(diffFilename);\n\n this.filesystem.writeDiffFile(\n diffFilename,\n retryScreenshot.comparisonResult.diffBuffer,\n );\n\n this.logger.debug(`Diff image saved: ${diffImagePath}`);\n }\n\n // different sizes diff image\n if (retryScreenshot.comparisonResult.differentSizes) {\n this.logger.warn(`Screenshot has different sizes than reference image`);\n\n const diffFilename = options.diffImageFilename || filename;\n diffImagePath = this.filesystem.getDiffFilePath(diffFilename);\n const diffBuffer = createDiffSizePngImage(200, 200);\n\n this.filesystem.writeDiffFile(diffFilename, diffBuffer);\n\n this.logger.debug(`Diff Size image saved: ${diffImagePath}`);\n }\n\n return {\n screenshotPath: filepath,\n comparisonResult: retryScreenshot.comparisonResult,\n diffImagePath,\n };\n } catch (error) {\n this.logger.error(\n `Error taking screenshot with comparison of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async retryScreenshot(\n page: Page,\n referenceImage: Buffer,\n options: ScreenshotSettings,\n ) {\n for (let i = 0; i < this.retries; i++) {\n try {\n const screenshotBuffer = await this.takeScreenshotBuffer(page, {\n ...options,\n delay: this.getIncBackoffDelay(i, options.delay || 0),\n });\n\n if (!screenshotBuffer) {\n throw new Error(\"Screenshot buffer is undefined\");\n }\n\n const comparisonResult = await compareImages(\n screenshotBuffer,\n referenceImage,\n true,\n this.diff,\n );\n\n // bail early if the images are different sizes\n if (comparisonResult.differentSizes) {\n return {\n screenshotPath: screenshotBuffer,\n comparisonResult,\n passed: false,\n };\n }\n\n // last retry\n if (i === this.retries - 1 && !comparisonResult.passed) {\n this.logger.error(\n `Failed to match screenshot after ${this.retries} retries`,\n );\n return {\n screenshotPath: screenshotBuffer,\n comparisonResult,\n passed: false,\n };\n }\n\n if (comparisonResult.passed) {\n return {\n screenshotPath: screenshotBuffer,\n comparisonResult,\n passed: true,\n };\n } else {\n this.logger.warn(\n `Comparison did not match. Retrying in ${this.getIncBackoffDelay(i + 1, options.delay || 0)}ms... \\nComparison result: ${comparisonResult.numDiffPixels} pixels different (${comparisonResult.percentDifference.toFixed(2)}%)`,\n );\n }\n } catch (error) {\n this.logger.error(\n `Error taking screenshot after ${i + 1} retries:`,\n (error as Error).message,\n );\n }\n }\n\n return {\n screenshotPath: null,\n comparisonResult: null,\n passed: false,\n };\n }\n\n getVariantFilename(filename: string, variant: ScreenshotVariant): string {\n if (variant.filename) {\n return variant.filename;\n }\n\n const parsed = path.parse(filename);\n const sanitizedId = variant.id\n .trim()\n .replace(/[^a-zA-Z0-9_-]+/g, \"-\")\n .replace(/-+/g, \"-\")\n .replace(/^-|-$/g, \"\");\n const suffix = sanitizedId || \"variant\";\n const ext = parsed.ext || \".png\";\n const variantName = `${parsed.name}--${suffix}${ext}`;\n\n return parsed.dir ? path.join(parsed.dir, variantName) : variantName;\n }\n\n /**\n * Captures a single screenshot with the given options\n */\n private async captureSingleScreenshot(\n page: Page,\n filename: string,\n options: ScreenshotSettings,\n extras: {\n saveDiffImage?: boolean;\n diffImageFilename?: string;\n } = {},\n ): Promise<ScreenshotCaptureDetails> {\n const result: ScreenshotCaptureDetails = { filename };\n\n if (options.skip) {\n result.skipped = true;\n return result;\n }\n\n const saveDiff = extras.saveDiffImage ?? false;\n const diffFilename = extras.diffImageFilename ?? filename;\n\n if (!this.filesystem.hasExpectedFile(filename)) {\n this.logger.debug(\n `Expected image not found for ${filename}, taking screenshot`,\n );\n\n result.filepath = await this.takeScreenshot(page, filename, options);\n } else {\n const { screenshotPath, comparisonResult, diffImagePath } =\n await this.takeScreenshotWithComparison(\n page,\n filename,\n this.filesystem.readExpectedFile(filename),\n {\n ...options,\n saveDiffImage: saveDiff,\n diffImageFilename: diffFilename,\n },\n );\n\n result.filepath = screenshotPath;\n result.comparisonResult = comparisonResult;\n result.diffImagePath = diffImagePath;\n }\n\n return result;\n }\n\n async capture(\n page: Page,\n filename: string,\n options: ScreenshotOptions,\n extras: ScreenshotCaptureExtras = {},\n ): Promise<ScreenshotCaptureResult> {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n const { variants = [], ...baseOptions } = options;\n const baseResult: ScreenshotCaptureDetails = { filename };\n const variantResults: ScreenshotVariantCaptureDetails[] = [];\n\n const baseSaveDiff = extras.saveDiffImage ?? false;\n const baseDiffFilename = extras.diffImageFilename ?? filename;\n\n if (baseOptions.skip) {\n return {\n base: { ...baseResult, skipped: true },\n variants: variants.map((variant) => ({\n id: variant.id,\n label: variant.label,\n filename: this.getVariantFilename(filename, variant),\n skipped: true,\n })),\n };\n }\n\n // Capture base screenshot\n const baseCaptureResult = await this.captureSingleScreenshot(\n page,\n filename,\n baseOptions,\n {\n saveDiffImage: baseSaveDiff,\n diffImageFilename: baseDiffFilename,\n },\n );\n\n baseResult.filepath = baseCaptureResult.filepath;\n baseResult.comparisonResult = baseCaptureResult.comparisonResult;\n baseResult.diffImagePath = baseCaptureResult.diffImagePath;\n baseResult.skipped = baseCaptureResult.skipped;\n\n for (const variant of variants) {\n const variantFilename = this.getVariantFilename(filename, variant);\n const variantOptions: ScreenshotSettings = {\n ...baseOptions,\n ...variant.options,\n };\n\n const variantResult: ScreenshotVariantCaptureDetails = {\n id: variant.id,\n label: variant.label,\n filename: variantFilename,\n };\n\n if (variantOptions.skip) {\n variantResult.skipped = true;\n variantResults.push(variantResult);\n continue;\n }\n\n const variantExtra = extras.variants?.[variant.id];\n const variantSaveDiff = variantExtra?.saveDiffImage ?? baseSaveDiff;\n const variantDiffFilename =\n variantExtra?.diffImageFilename ?? variantFilename;\n\n const variantCaptureResult = await this.captureSingleScreenshot(\n page,\n variantFilename,\n variantOptions,\n {\n saveDiffImage: variantSaveDiff,\n diffImageFilename: variantDiffFilename,\n },\n );\n\n variantResult.filepath = variantCaptureResult.filepath;\n variantResult.comparisonResult = variantCaptureResult.comparisonResult;\n variantResult.diffImagePath = variantCaptureResult.diffImagePath;\n variantResult.skipped = variantCaptureResult.skipped;\n\n variantResults.push(variantResult);\n }\n\n return {\n base: baseResult,\n variants: variantResults,\n };\n }\n\n /**\n * Applies SVG and UI optimizations for screenshots\n */\n private async applyScreenshotOptimizations(page: Page) {\n await page.addStyleTag({\n content: `\n *, *::before, *::after {\n -moz-animation: none !important;\n -moz-transition: none !important;\n transition: none !important; \n animation: none !important;\n }\n *, input, textarea { caret-color: transparent !important }\n *:focus { outline: none !important }\n *:focus-visible { outline: none !important }\n *:focus-within { outline: none !important }\n * { text-rendering: optimizeLegibility !important }\n ::-webkit-scrollbar { display: none !important }\n html { scroll-behavior: auto !important }\n svg, svg * {\n shape-rendering: crispEdges !important;\n text-rendering: geometricPrecision !important;\n vector-effect: non-scaling-stroke !important;\n }\n img { image-rendering: crisp-edges !important }\n `,\n });\n }\n\n /**\n * Captures screenshots for multiple variants, each with their own URL\n */\n async captureWithVariants(\n page: Page,\n baseFilename: string,\n baseUrl: string,\n baseOptions: ScreenshotSettings,\n variants: ScreenshotVariantWithUrl[],\n extras: ScreenshotCaptureExtras = {},\n ): Promise<ScreenshotCaptureResult> {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n const baseResult: ScreenshotCaptureDetails = { filename: baseFilename };\n const variantResults: ScreenshotVariantCaptureDetails[] = [];\n\n const baseSaveDiff = extras.saveDiffImage ?? false;\n const baseDiffFilename = extras.diffImageFilename ?? baseFilename;\n\n // Capture base screenshot\n getLogger().debug(`Going to base URL: ${baseUrl}`);\n await page.goto(baseUrl);\n await this.applyScreenshotOptimizations(page);\n const baseCaptureResult = await this.captureSingleScreenshot(\n page,\n baseFilename,\n baseOptions,\n {\n saveDiffImage: baseSaveDiff,\n diffImageFilename: baseDiffFilename,\n },\n );\n\n baseResult.filepath = baseCaptureResult.filepath;\n baseResult.comparisonResult = baseCaptureResult.comparisonResult;\n baseResult.diffImagePath = baseCaptureResult.diffImagePath;\n baseResult.skipped = baseCaptureResult.skipped;\n\n // Capture variant screenshots\n for (const variant of variants) {\n const variantFilename =\n variant.filename || this.getVariantFilename(baseFilename, variant);\n const variantOptions: ScreenshotSettings = {\n ...baseOptions,\n ...variant.options,\n };\n\n const variantResult: ScreenshotVariantCaptureDetails = {\n id: variant.id,\n label: variant.label,\n filename: variantFilename,\n };\n\n if (variantOptions.skip) {\n variantResult.skipped = true;\n variantResults.push(variantResult);\n continue;\n }\n\n // Navigate to variant URL and apply optimizations\n getLogger().debug(`Going to variant URL: ${variant.url}`);\n await page.goto(variant.url);\n await this.applyScreenshotOptimizations(page);\n\n const variantExtra = extras.variants?.[variant.id];\n const variantSaveDiff = variantExtra?.saveDiffImage ?? baseSaveDiff;\n const variantDiffFilename =\n variantExtra?.diffImageFilename ?? variantFilename;\n\n const variantCaptureResult = await this.captureSingleScreenshot(\n page,\n variantFilename,\n variantOptions,\n {\n saveDiffImage: variantSaveDiff,\n diffImageFilename: variantDiffFilename,\n },\n );\n\n variantResult.filepath = variantCaptureResult.filepath;\n variantResult.comparisonResult = variantCaptureResult.comparisonResult;\n variantResult.diffImagePath = variantCaptureResult.diffImagePath;\n variantResult.skipped = variantCaptureResult.skipped;\n\n variantResults.push(variantResult);\n }\n\n return {\n base: baseResult,\n variants: variantResults,\n };\n }\n\n /**\n * Gets the exponential backoff delay\n */\n getIncBackoffDelay(i: number, delay: number): number {\n return i > 0 ? 500 * 2 ** (i - 1) + (delay || 0) : 0;\n }\n\n /**\n * Get a page from the pool by index\n */\n getPageFromPool(index: number): Page {\n if (index < 0) {\n throw new Error(`Page index ${index} must be non-negative`);\n }\n\n if (index >= this.pages.length) {\n throw new Error(\n `Page index ${index} exceeds pool size ${this.pages.length}`,\n );\n }\n\n if (!this.pages[index]) {\n throw new Error(`Page index ${index} is undefined`);\n }\n\n return this.pages[index];\n }\n}\n\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;AAmBA,MAAM,WACJ,QACA,QACA,MACA,OACA,QACA,YACG;AACH,QAAO,UAAU,QAAQ,QAAQ,MAAM,OAAO,QAAQ,QAAQ;;;;;;;;;;AAWhE,eAAsB,cACpB,QACA,QACA,WAAoB,OACpB,UAAsB,EAAE,EACA;CACxB,MAAM,OAAO,MAAM,QAAQ,OAAO;CAClC,MAAM,OAAO,MAAM,QAAQ,OAAO;CAElC,MAAM,EAAE,OAAO,WAAW;AAE1B,KAAI,UAAU,KAAK,SAAS,WAAW,KAAK,OAC1C,QAAO;EACL,eAAe;EACf,aAAa;EACb,mBAAmB;EACnB,QAAQ;EACR,gBAAgB;EACjB;CAGH,MAAM,OAAO,WAAW,IAAI,IAAI;EAAE;EAAO;EAAQ,CAAC,GAAG;AAErD,KAAI;EACF,MAAM,gBAAgB,QACpB,KAAK,MACL,KAAK,MACL,MAAM,MACN,OACA,QACA,QACD;EAED,MAAM,cAAc,QAAQ;EAC5B,MAAM,oBAAqB,gBAAgB,cAAe;AAK1D,SAAO;GACL;GACA;GACA;GACA,YANiB,OAAO,IAAI,KAAK,MAAM,KAAK,GAAG;GAO/C,QAAQ,SAAS,mBAAmB,eAAe,QAAQ;GAC3D,gBAAgB;GACjB;UACM,OAAO;AACd,aAAW,CAAC,MAAO,MAAgB,WAAW,gBAAgB;AAE9D,SAAO;GACL,eAAe;GACf,aAAa;GACb,mBAAmB;GACnB,QAAQ;GACR,gBAAgB;GAChB,OAAQ,MAAgB,WAAW;GACpC;;;;;;AAOL,eAAe,QAAQ,QAAuC;AAC5D,KAAI,OAAO,SAAS,OAAO,CACzB,QAAO,IAAI,KAAK,KAAK,OAAO;MACvB;EACL,MAAM,SAAS,GAAG,aAAa,OAAO;AACtC,SAAO,IAAI,KAAK,KAAK,OAAO;;;;;;;;;;AAwBhC,eAAsB,YACpB,QACA,QACA,UAAsB,EAAE,EACN;AAGlB,SAFe,MAAM,cAAc,QAAQ,QAAQ,OAAO,QAAQ,EAEpD;;;;;;;;;AAUhB,MAAM,YACJ,mBACA,eACA,YACG;AACH,KAAI,QAAQ,qBAAqB,QAAQ,cACvC,QACE,qBAAqB,QAAQ,qBAC7B,iBAAiB,QAAQ;AAI7B,KAAI,QAAQ,kBACV,QAAO,qBAAqB,QAAQ;AAGtC,KAAI,QAAQ,cACV,QAAO,iBAAiB,QAAQ;AAIlC,QAAO,kBAAkB;;;;;;AAO3B,SAAgB,uBAAuB,OAAe,QAAwB;CAC5E,MAAM,MAAM,IAAI,IAAI;EAAE;EAAO;EAAQ,CAAC;AAEtC,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,IAC1B,MAAK,IAAI,IAAI,GAAG,IAAI,OAAO,KAAK;EAC9B,MAAM,MAAO,QAAQ,IAAI,KAAM;AAC/B,MAAI,KAAK,OAAO;AAChB,MAAI,KAAK,MAAM,KAAK;AACpB,MAAI,KAAK,MAAM,KAAK;AACpB,MAAI,KAAK,MAAM,KAAK;;AAIxB,QAAO,IAAI,KAAK,MAAM,IAAI;;;;;;;;ACxL5B,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;;;;ACJT,IAAa,uBAAb,MAAkC;CAChC,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CAEjB,YAAY,WAAmB;AAC7B,OAAK,YAAY,KAAK,QAAQ,WAAW,SAAS;AAClD,OAAK,cAAc,KAAK,QAAQ,WAAW,WAAW;AACtD,OAAK,UAAU,KAAK,QAAQ,WAAW,OAAO;AAE9C,OAAK,gBAAgB,KAAK,UAAU;AACpC,OAAK,gBAAgB,KAAK,YAAY;AACtC,OAAK,gBAAgB,KAAK,QAAQ;;CAGpC,cAAc;AACZ,OAAK,UAAU,KAAK,UAAU;;CAGhC,YAAY;AACV,OAAK,UAAU,KAAK,QAAQ;;CAG9B,qBAAqB;AACnB,OAAK,aAAa;AAClB,OAAK,WAAW;;;;;;;CAQlB,sBAAsB,gBAAwB;EAC5C,MAAM,iBAAiB,KAAK,kBAAkB,eAAe;EAC7D,MAAM,eAAe,KAAK,SAAS,KAAK,WAAW,eAAe;AAElE,MAAI,aAAa,WAAW,KAAK,CAC/B,OAAM,IAAI,MACR,0DAA0D,iBAC3D;AAGH,SAAO,KAAK,gBAAgB,aAAa;;;;;;;CAQ3C,cAAc,MAAc;EAC1B,MAAM,wBAAwB,KAAK,SAAS,OAAO,GAAG,OAAO,GAAG,KAAK;AAErE,SAAO,KAAK,gBAAgB,sBAAsB;;;;;;;CAQpD,AAAQ,gBAAgB,cAAsB;EAC5C,MAAM,aAAa,KAAK,QAAQ,KAAK,WAAW,aAAa;EAC7D,MAAM,eAAe,KAAK,QAAQ,KAAK,aAAa,aAAa;EACjE,MAAM,WAAW,KAAK,QAAQ,KAAK,SAAS,aAAa;AAEzD,OAAK,gBAAgB,aAAa;AAElC,KAAG,aAAa,YAAY,aAAa;AAEzC,MAAI,GAAG,WAAW,SAAS,CACzB,IAAG,WAAW,SAAS;AAGzB,SAAO;GACL;GACA;GACA;GACD;;;;;;CAOH,gBAAgB,UAAkB;EAChC,MAAM,MAAM,KAAK,QAAQ,SAAS;AAElC,MAAI,CAAC,GAAG,WAAW,IAAI,CACrB,IAAG,UAAU,KAAK,EAAE,WAAW,MAAM,CAAC;;;;;;CAQ1C,AAAQ,UAAU,KAAa;AAC7B,MAAI,GAAG,WAAW,IAAI,CACpB,IAAG,OAAO,KAAK;GAAE,WAAW;GAAM,OAAO;GAAM,CAAC;;;;;CAOpD,eAAuB;AACrB,SAAO,KAAK;;;;;CAMd,iBAAyB;AACvB,SAAO,KAAK;;;;;CAMd,aAAqB;AACnB,SAAO,KAAK;;;;;CAMd,kBAAkB,UAA0B;AAC1C,SAAO,KAAK,QAAQ,KAAK,WAAW,SAAS;;;;;CAM/C,oBAAoB,UAA0B;AAC5C,SAAO,KAAK,QAAQ,KAAK,aAAa,SAAS;;;;;CAMjD,gBAAgB,UAA0B;AACxC,SAAO,KAAK,QAAQ,KAAK,SAAS,SAAS;;;;;CAM7C,gBAAgB,UAAkB,MAAoB;EACpD,MAAM,WAAW,KAAK,kBAAkB,SAAS;AACjD,OAAK,gBAAgB,SAAS;AAC9B,KAAG,cAAc,UAAU,KAAK;;;;;CAMlC,cAAc,UAAkB,MAAoB;EAClD,MAAM,WAAW,KAAK,gBAAgB,SAAS;AAC/C,OAAK,gBAAgB,SAAS;AAC9B,KAAG,cAAc,UAAU,KAAK;;;;;CAMlC,gBAAgB,UAA2B;EACzC,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,SAAO,GAAG,WAAW,aAAa;;;;;CAMpC,iBAAiB,UAA0B;EACzC,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,MAAI,CAAC,GAAG,WAAW,aAAa,CAC9B,OAAM,IAAI,MAAM,6BAA6B,eAAe;AAE9D,SAAO,GAAG,aAAa,aAAa;;;;;;;CAQtC,AAAQ,kBAAkB,UAAkB;AAC1C,MAAI,KAAK,WAAW,SAAS,CAC3B,QAAO;AAGT,SAAO,KAAK,QAAQ,KAAK,WAAW,SAAS;;;;;;AC9KjD,MAAMA,oBAAgC;CACpC,WAAW;CACX,WAAW;CACX,iBAAiB;CACjB,eAAe;CACf,mBAAmB;CACpB;AAiCD,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB;CACA,WAA6B,EAAE;CAC/B,QAAgB,EAAE;CAClB;CACA;CACA;CACA;CAEA,YAAY,SAQT;AACD,OAAK,cAAc,QAAQ,eAAe;AAC1C,OAAK,WAAW,QAAQ,aAAa;AACrC,OAAK,WAAW,QAAQ,YAAY;GAAE,OAAO;GAAM,QAAQ;GAAM;AACjE,OAAK,YAAY,QAAQ,aAAa;AACtC,OAAK,OAAO;GAAE,GAAG;GAAmB,GAAG,QAAQ;GAAM;AACrD,OAAK,cAAc,KAAK,IAAI,GAAG,QAAQ,eAAe,EAAE;AAExD,OAAK,SAAS,WAAW;AACzB,OAAK,UAAU,QAAQ,WAAW;AAClC,OAAK,aAAa,IAAI,qBAAqB,KAAK,UAAU;;;;;CAM5D,MAAM,OAAO;EAQX,MAAM,eANa;GACjB;GACA;GACA;GACD,CAE+B,KAAK;AACrC,MAAI,CAAC,aACH,OAAM,IAAI,MAAM,6BAA6B,KAAK,cAAc;AAGlE,OAAK,UAAU,MAAM,aAAa,OAAO,EACvC,UAAU,KAAK,UAChB,CAAC;EAEF,MAAM,oBAAoB,MAAM,KAAK,QAAQ,YAAY,EACtD,SAAS,CACT,MAAM,SAAS,KAAK,eAAe,UAAU,UAAU,CAAC;AAG3D,OAAK,WAAW,EAAE;AAClB,OAAK,QAAQ,EAAE;AAEf,OAAK,IAAI,IAAI,GAAG,IAAI,KAAK,aAAa,KAAK;GACzC,MAAM,UAAU,MAAM,KAAK,QAAQ,WAAW;IAC5C,eAAe;IACf,mBAAmB;IACnB,WAAW,GAAG,MAAM,iBAAiB;IACrC,UAAU,KAAK;IAChB,CAAC;GACF,MAAM,OAAO,MAAM,QAAQ,SAAS;AAEpC,QAAK,SAAS,KAAK,QAAQ;AAC3B,QAAK,MAAM,KAAK,KAAK;;AAIvB,OAAK,UAAU,KAAK,SAAS,MAAM;AACnC,OAAK,OAAO,KAAK,MAAM,MAAM;;;;;;CAO/B,MAAM,QAAQ;AACZ,OAAK,MAAM,WAAW,KAAK,SACzB,OAAM,QAAQ,OAAO;AAEvB,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;;;;CAO9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;;;;CAMzD,MAAM,eACJ,MACA,UACA,SACA;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI,QAAQ,KACV;AAGF,MAAI;GAEF,MAAM,WAAW,KAAK,WAAW,kBAAkB,SAAS;AAG5D,QAAK,WAAW,gBAAgB,SAAS;GAGzC,MAAM,oBAAoB;IACxB,MAAM;IACN,UAAU,QAAQ;IAClB,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACP,YAAY;IACZ,OAAO;IACR;AAED,SAAM,KAAK,aAAa,MAAM,QAAQ,UAAU,YAAY;AAC1D,QAAI,QAAQ,MACV,OAAM,KAAK,eAAe,QAAQ,MAAM;AAG1C,UAAM,KAAK,WAAW,kBAAkB;KACxC;AAEF,QAAK,OAAO,QAAQ,qBAAqB,WAAW;AAEpD,UAAO;WACA,OAAO;AACd,QAAK,OAAO,MACV,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;;;;;CAQV,MAAc,aACZ,MACA,UACA,QACY;AACZ,MAAI,CAAC,SACH,QAAO,QAAQ;EAGjB,MAAM,mBAAmB,KAAK,cAAc;AAG5C,MACE,oBACA,iBAAiB,UAAU,SAAS,SACpC,iBAAiB,WAAW,SAAS,OAErC,QAAO,QAAQ;AAGjB,QAAM,KAAK,gBAAgB,SAAS;AAEpC,MAAI;AACF,UAAO,MAAM,QAAQ;YACb;AAER,OAAI,iBACF,OAAM,KAAK,gBAAgB,iBAAiB;;;;;;CAQlD,MAAM,qBACJ,MACA,SACiB;AACjB,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI,QAAQ,KACV,OAAM,IAAI,MAAM,qBAAqB;AAGvC,MAAI;GAEF,MAAM,oBAAoB;IACxB,UAAU,QAAQ;IAClB,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACP,YAAY;IACZ,OAAO;IACR;AAcD,UAZe,MAAM,KAAK,aACxB,MACA,QAAQ,UACR,YAAY;AACV,QAAI,QAAQ,MACV,OAAM,KAAK,eAAe,QAAQ,MAAM;AAG1C,WAAO,KAAK,WAAW,kBAAkB;KAE5C;WAGM,OAAO;AACd,QAAK,OAAO,MACV,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,6BACJ,MACA,UACA,gBACA,SAQC;AACD,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;GAEF,MAAM,WAAW,KAAK,WAAW,kBAAkB,SAAS;GAE5D,MAAMC,qBAAyC;IAC7C,UAAU,QAAQ;IAClB,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO,QAAQ;IACf,UAAU,QAAQ;IACnB;GAED,MAAM,kBAAkB,MAAM,KAAK,gBACjC,MACA,gBACA,mBACD;AAED,OAAI,CAAC,gBAAgB,eACnB,OAAM,IAAI,MAAM,iCAAiC;AAInD,QAAK,WAAW,gBAAgB,UAAU,gBAAgB,eAAe;AACzE,QAAK,OAAO,MAAM,4BAA4B,WAAW;AAEzD,OAAI,gBAAgB,OAClB,MAAK,OAAO,QAAQ,sCAAsC;OAE1D,MAAK,OAAO,MAAM,sCAAsC;GAG1D,IAAIC;AAGJ,OACE,QAAQ,iBACR,gBAAgB,iBAAiB,cACjC,CAAC,gBAAgB,QACjB;IACA,MAAM,eAAe,QAAQ,qBAAqB;AAElD,oBAAgB,KAAK,WAAW,gBAAgB,aAAa;AAE7D,SAAK,WAAW,cACd,cACA,gBAAgB,iBAAiB,WAClC;AAED,SAAK,OAAO,MAAM,qBAAqB,gBAAgB;;AAIzD,OAAI,gBAAgB,iBAAiB,gBAAgB;AACnD,SAAK,OAAO,KAAK,sDAAsD;IAEvE,MAAM,eAAe,QAAQ,qBAAqB;AAClD,oBAAgB,KAAK,WAAW,gBAAgB,aAAa;IAC7D,MAAM,aAAa,uBAAuB,KAAK,IAAI;AAEnD,SAAK,WAAW,cAAc,cAAc,WAAW;AAEvD,SAAK,OAAO,MAAM,0BAA0B,gBAAgB;;AAG9D,UAAO;IACL,gBAAgB;IAChB,kBAAkB,gBAAgB;IAClC;IACD;WACM,OAAO;AACd,QAAK,OAAO,MACV,8CAA8C,KAAK,KAAK,CAAC,IACxD,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,gBACJ,MACA,gBACA,SACA;AACA,OAAK,IAAI,IAAI,GAAG,IAAI,KAAK,SAAS,IAChC,KAAI;GACF,MAAM,mBAAmB,MAAM,KAAK,qBAAqB,MAAM;IAC7D,GAAG;IACH,OAAO,KAAK,mBAAmB,GAAG,QAAQ,SAAS,EAAE;IACtD,CAAC;AAEF,OAAI,CAAC,iBACH,OAAM,IAAI,MAAM,iCAAiC;GAGnD,MAAM,mBAAmB,MAAM,cAC7B,kBACA,gBACA,MACA,KAAK,KACN;AAGD,OAAI,iBAAiB,eACnB,QAAO;IACL,gBAAgB;IAChB;IACA,QAAQ;IACT;AAIH,OAAI,MAAM,KAAK,UAAU,KAAK,CAAC,iBAAiB,QAAQ;AACtD,SAAK,OAAO,MACV,oCAAoC,KAAK,QAAQ,UAClD;AACD,WAAO;KACL,gBAAgB;KAChB;KACA,QAAQ;KACT;;AAGH,OAAI,iBAAiB,OACnB,QAAO;IACL,gBAAgB;IAChB;IACA,QAAQ;IACT;OAED,MAAK,OAAO,KACV,yCAAyC,KAAK,mBAAmB,IAAI,GAAG,QAAQ,SAAS,EAAE,CAAC,6BAA6B,iBAAiB,cAAc,qBAAqB,iBAAiB,kBAAkB,QAAQ,EAAE,CAAC,IAC5N;WAEI,OAAO;AACd,QAAK,OAAO,MACV,iCAAiC,IAAI,EAAE,YACtC,MAAgB,QAClB;;AAIL,SAAO;GACL,gBAAgB;GAChB,kBAAkB;GAClB,QAAQ;GACT;;CAGH,mBAAmB,UAAkB,SAAoC;AACvE,MAAI,QAAQ,SACV,QAAO,QAAQ;EAGjB,MAAM,SAAS,KAAK,MAAM,SAAS;EAMnC,MAAM,SALc,QAAQ,GACzB,MAAM,CACN,QAAQ,oBAAoB,IAAI,CAChC,QAAQ,OAAO,IAAI,CACnB,QAAQ,UAAU,GAAG,IACM;EAC9B,MAAM,MAAM,OAAO,OAAO;EAC1B,MAAM,cAAc,GAAG,OAAO,KAAK,IAAI,SAAS;AAEhD,SAAO,OAAO,MAAM,KAAK,KAAK,OAAO,KAAK,YAAY,GAAG;;;;;CAM3D,MAAc,wBACZ,MACA,UACA,SACA,SAGI,EAAE,EAC6B;EACnC,MAAMC,SAAmC,EAAE,UAAU;AAErD,MAAI,QAAQ,MAAM;AAChB,UAAO,UAAU;AACjB,UAAO;;EAGT,MAAM,WAAW,OAAO,iBAAiB;EACzC,MAAM,eAAe,OAAO,qBAAqB;AAEjD,MAAI,CAAC,KAAK,WAAW,gBAAgB,SAAS,EAAE;AAC9C,QAAK,OAAO,MACV,gCAAgC,SAAS,qBAC1C;AAED,UAAO,WAAW,MAAM,KAAK,eAAe,MAAM,UAAU,QAAQ;SAC/D;GACL,MAAM,EAAE,gBAAgB,kBAAkB,kBACxC,MAAM,KAAK,6BACT,MACA,UACA,KAAK,WAAW,iBAAiB,SAAS,EAC1C;IACE,GAAG;IACH,eAAe;IACf,mBAAmB;IACpB,CACF;AAEH,UAAO,WAAW;AAClB,UAAO,mBAAmB;AAC1B,UAAO,gBAAgB;;AAGzB,SAAO;;CAGT,MAAM,QACJ,MACA,UACA,SACA,SAAkC,EAAE,EACF;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAM,EAAE,WAAW,EAAE,CAAE,GAAG,gBAAgB;EAC1C,MAAMC,aAAuC,EAAE,UAAU;EACzD,MAAMC,iBAAoD,EAAE;EAE5D,MAAM,eAAe,OAAO,iBAAiB;EAC7C,MAAM,mBAAmB,OAAO,qBAAqB;AAErD,MAAI,YAAY,KACd,QAAO;GACL,MAAM;IAAE,GAAG;IAAY,SAAS;IAAM;GACtC,UAAU,SAAS,KAAK,aAAa;IACnC,IAAI,QAAQ;IACZ,OAAO,QAAQ;IACf,UAAU,KAAK,mBAAmB,UAAU,QAAQ;IACpD,SAAS;IACV,EAAE;GACJ;EAIH,MAAM,oBAAoB,MAAM,KAAK,wBACnC,MACA,UACA,aACA;GACE,eAAe;GACf,mBAAmB;GACpB,CACF;AAED,aAAW,WAAW,kBAAkB;AACxC,aAAW,mBAAmB,kBAAkB;AAChD,aAAW,gBAAgB,kBAAkB;AAC7C,aAAW,UAAU,kBAAkB;AAEvC,OAAK,MAAM,WAAW,UAAU;GAC9B,MAAM,kBAAkB,KAAK,mBAAmB,UAAU,QAAQ;GAClE,MAAMC,iBAAqC;IACzC,GAAG;IACH,GAAG,QAAQ;IACZ;GAED,MAAMC,gBAAiD;IACrD,IAAI,QAAQ;IACZ,OAAO,QAAQ;IACf,UAAU;IACX;AAED,OAAI,eAAe,MAAM;AACvB,kBAAc,UAAU;AACxB,mBAAe,KAAK,cAAc;AAClC;;GAGF,MAAM,eAAe,OAAO,WAAW,QAAQ;GAC/C,MAAM,kBAAkB,cAAc,iBAAiB;GACvD,MAAM,sBACJ,cAAc,qBAAqB;GAErC,MAAM,uBAAuB,MAAM,KAAK,wBACtC,MACA,iBACA,gBACA;IACE,eAAe;IACf,mBAAmB;IACpB,CACF;AAED,iBAAc,WAAW,qBAAqB;AAC9C,iBAAc,mBAAmB,qBAAqB;AACtD,iBAAc,gBAAgB,qBAAqB;AACnD,iBAAc,UAAU,qBAAqB;AAE7C,kBAAe,KAAK,cAAc;;AAGpC,SAAO;GACL,MAAM;GACN,UAAU;GACX;;;;;CAMH,MAAc,6BAA6B,MAAY;AACrD,QAAM,KAAK,YAAY,EACrB,SAAS;;;;;;;;;;;;;;;;;;;;SAqBV,CAAC;;;;;CAMJ,MAAM,oBACJ,MACA,cACA,SACA,aACA,UACA,SAAkC,EAAE,EACF;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMH,aAAuC,EAAE,UAAU,cAAc;EACvE,MAAMC,iBAAoD,EAAE;EAE5D,MAAM,eAAe,OAAO,iBAAiB;EAC7C,MAAM,mBAAmB,OAAO,qBAAqB;AAGrD,aAAW,CAAC,MAAM,sBAAsB,UAAU;AAClD,QAAM,KAAK,KAAK,QAAQ;AACxB,QAAM,KAAK,6BAA6B,KAAK;EAC7C,MAAM,oBAAoB,MAAM,KAAK,wBACnC,MACA,cACA,aACA;GACE,eAAe;GACf,mBAAmB;GACpB,CACF;AAED,aAAW,WAAW,kBAAkB;AACxC,aAAW,mBAAmB,kBAAkB;AAChD,aAAW,gBAAgB,kBAAkB;AAC7C,aAAW,UAAU,kBAAkB;AAGvC,OAAK,MAAM,WAAW,UAAU;GAC9B,MAAM,kBACJ,QAAQ,YAAY,KAAK,mBAAmB,cAAc,QAAQ;GACpE,MAAMC,iBAAqC;IACzC,GAAG;IACH,GAAG,QAAQ;IACZ;GAED,MAAMC,gBAAiD;IACrD,IAAI,QAAQ;IACZ,OAAO,QAAQ;IACf,UAAU;IACX;AAED,OAAI,eAAe,MAAM;AACvB,kBAAc,UAAU;AACxB,mBAAe,KAAK,cAAc;AAClC;;AAIF,cAAW,CAAC,MAAM,yBAAyB,QAAQ,MAAM;AACzD,SAAM,KAAK,KAAK,QAAQ,IAAI;AAC5B,SAAM,KAAK,6BAA6B,KAAK;GAE7C,MAAM,eAAe,OAAO,WAAW,QAAQ;GAC/C,MAAM,kBAAkB,cAAc,iBAAiB;GACvD,MAAM,sBACJ,cAAc,qBAAqB;GAErC,MAAM,uBAAuB,MAAM,KAAK,wBACtC,MACA,iBACA,gBACA;IACE,eAAe;IACf,mBAAmB;IACpB,CACF;AAED,iBAAc,WAAW,qBAAqB;AAC9C,iBAAc,mBAAmB,qBAAqB;AACtD,iBAAc,gBAAgB,qBAAqB;AACnD,iBAAc,UAAU,qBAAqB;AAE7C,kBAAe,KAAK,cAAc;;AAGpC,SAAO;GACL,MAAM;GACN,UAAU;GACX;;;;;CAMH,mBAAmB,GAAW,OAAuB;AACnD,SAAO,IAAI,IAAI,MAAM,MAAM,IAAI,MAAM,SAAS,KAAK;;;;;CAMrD,gBAAgB,OAAqB;AACnC,MAAI,QAAQ,EACV,OAAM,IAAI,MAAM,cAAc,MAAM,uBAAuB;AAG7D,MAAI,SAAS,KAAK,MAAM,OACtB,OAAM,IAAI,MACR,cAAc,MAAM,qBAAqB,KAAK,MAAM,SACrD;AAGH,MAAI,CAAC,KAAK,MAAM,OACd,OAAM,IAAI,MAAM,cAAc,MAAM,eAAe;AAGrD,SAAO,KAAK,MAAM;;;AAItB,yBAAe"}
package/package.json CHANGED
@@ -1,8 +1,12 @@
1
1
  {
2
2
  "name": "@cappa/core",
3
- "version": "0.2.5",
3
+ "version": "0.3.1",
4
4
  "description": "Core Playwright screenshot functionality for Cappa",
5
5
  "author": "Tim Richter",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/tim-richter/cappa.git"
9
+ },
6
10
  "license": "MIT",
7
11
  "publishConfig": {
8
12
  "access": "public"
@@ -18,20 +22,20 @@
18
22
  "./package.json": "./package.json"
19
23
  },
20
24
  "dependencies": {
21
- "@blazediff/core": "^1.4.1",
25
+ "@blazediff/core": "^1.6.0",
22
26
  "@blazediff/types": "^1.4.1",
23
- "playwright-core": "^1.56.0",
27
+ "playwright-core": "^1.56.1",
24
28
  "pngjs": "^7.0.0",
25
29
  "@cappa/logger": "0.0.4"
26
30
  },
27
31
  "devDependencies": {
28
- "@types/node": "24.8.0",
32
+ "@types/node": "24.9.2",
29
33
  "@types/pngjs": "^6.0.5",
30
- "@vitest/coverage-v8": "3.2.4",
31
- "@vitest/ui": "3.2.4",
32
- "tsdown": "0.15.7",
34
+ "@vitest/coverage-v8": "4.0.6",
35
+ "@vitest/ui": "4.0.6",
36
+ "tsdown": "0.15.12",
33
37
  "typescript": "5.9.3",
34
- "vitest": "3.2.4"
38
+ "vitest": "4.0.6"
35
39
  },
36
40
  "keywords": [
37
41
  "screenshot",
package/src/config.ts CHANGED
@@ -1,12 +1,12 @@
1
- import type { PossiblePromise, UserConfig } from "./types";
1
+ import type { ConfigEnv, PossiblePromise, UserConfig } from "./types";
2
2
 
3
3
  /**
4
4
  * Type helper to make it easier to use cappa.config.ts, or a function that returns it. The function receives a ConfigEnv object.
5
5
  */
6
6
  export function defineConfig(
7
7
  options:
8
- | PossiblePromise<UserConfig | Array<UserConfig>>
9
- | (() => PossiblePromise<UserConfig | Array<UserConfig>>),
8
+ | PossiblePromise<UserConfig>
9
+ | ((env: ConfigEnv) => PossiblePromise<UserConfig>),
10
10
  ): typeof options {
11
11
  return options;
12
12
  }
package/src/index.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { compareImages, imagesMatch } from "./compare";
1
2
  import { defineConfig } from "./config";
2
3
  import { ScreenshotFileSystem } from "./filesystem";
3
4
  import type { Plugin, PluginDef, PluginFunction } from "./plugin";
@@ -8,6 +9,8 @@ import ScreenshotTool, {
8
9
  type ScreenshotVariantCaptureDetails,
9
10
  } from "./screenshot";
10
11
  import type {
12
+ ConfigEnv,
13
+ FailedScreenshot,
11
14
  Screenshot,
12
15
  ScreenshotOptions,
13
16
  ScreenshotSettings,
@@ -21,15 +24,19 @@ export {
21
24
  ScreenshotTool,
22
25
  ScreenshotFileSystem,
23
26
  defineConfig,
27
+ compareImages,
28
+ imagesMatch,
24
29
  type PluginFunction,
25
30
  type Plugin,
26
31
  type PluginDef,
32
+ type ConfigEnv,
27
33
  type UserConfig,
28
34
  type ScreenshotOptions,
29
35
  type ScreenshotSettings,
30
36
  type ScreenshotVariant,
31
37
  type ScreenshotVariantWithUrl,
32
38
  type Screenshot,
39
+ type FailedScreenshot,
33
40
  type ScreenshotCaptureResult,
34
41
  type ScreenshotCaptureDetails,
35
42
  type ScreenshotVariantCaptureDetails,
package/src/types.ts CHANGED
@@ -3,6 +3,21 @@ import type { Plugin, PluginDef } from "./plugin";
3
3
 
4
4
  export type PossiblePromise<T> = Promise<T> | T;
5
5
 
6
+ export interface ConfigEnv {
7
+ /**
8
+ * The CLI command being executed, for example `capture` or `review`.
9
+ */
10
+ command?: string;
11
+ /**
12
+ * The mode the CLI is running in, defaults to `process.env.NODE_ENV`.
13
+ */
14
+ mode: string;
15
+ /**
16
+ * The environment variables available when the configuration is loaded.
17
+ */
18
+ env: NodeJS.ProcessEnv;
19
+ }
20
+
6
21
  /**
7
22
  * Configuration for the comparison of images
8
23
  */
@@ -79,6 +94,11 @@ export type UserConfig = {
79
94
  * Each plugin may have additional configurable options (defined within the plugin itself).
80
95
  */
81
96
  plugins?: Array<Plugin | PluginDef>;
97
+ /**
98
+ * Callback executed when screenshots fail comparison.
99
+ * Receives the failing screenshots so they can be uploaded or processed.
100
+ */
101
+ onFail?: (screenshots: FailedScreenshot[]) => PossiblePromise<void>;
82
102
  };
83
103
 
84
104
  export type Viewport = { width: number; height: number };
@@ -120,3 +140,18 @@ export interface Screenshot {
120
140
  diffPath?: string;
121
141
  approved?: boolean;
122
142
  }
143
+
144
+ export type FailedScreenshot = Screenshot & {
145
+ /**
146
+ * Absolute path to the actual screenshot on disk.
147
+ */
148
+ absoluteActualPath?: string;
149
+ /**
150
+ * Absolute path to the expected screenshot on disk.
151
+ */
152
+ absoluteExpectedPath?: string;
153
+ /**
154
+ * Absolute path to the diff screenshot on disk.
155
+ */
156
+ absoluteDiffPath?: string;
157
+ };
@@ -1,53 +0,0 @@
1
-
2
-
3
- > @cappa/core@0.1.3 test /home/tim/cappa/packages/core
4
- > vitest
5
-
6
- [?25l
7
-  DEV  v3.2.4 /home/tim/cappa/packages/core
8
-
9
- [?2026h
10
-  ❯ src/compare.test.ts [queued]
11
-
12
-  Test Files 0 passed (1)
13
-  Tests 0 passed (0)
14
-  Start at 17:14:17
15
-  Duration 100ms
16
- [?2026l[?2026h
17
-  ❯ src/compare.test.ts 1/21
18
-
19
-  Test Files 0 passed (1)
20
-  Tests 1 passed (21)
21
-  Start at 17:14:17
22
-  Duration 299ms
23
- [?2026l ✓ src/compare.test.ts (21 tests) 53ms
24
- ✓ compare > compareImages > should return 0% difference for identical images 5ms
25
- ✓ compare > compareImages > should return 100% difference for completely different images 3ms
26
- ✓ compare > compareImages > should work with file paths 4ms
27
- ✓ compare > compareImages > should work with mixed file path and buffer 3ms
28
- ✓ compare > compareImages > should respect maxDiffPercentage parameter 4ms
29
- ✓ compare > compareImages > should apply threshold option correctly 2ms
30
- ✓ compare > compareImages > should throw error for mismatched dimensions 1ms
31
- ✓ compare > compareImages > should handle custom compare options 1ms
32
- ✓ compare > compareImages > should handle identical file paths 1ms
33
- ✓ compare > imagesMatch > should return true for identical images 1ms
34
- ✓ compare > imagesMatch > should return false for completely different images 1ms
35
- ✓ compare > imagesMatch > should respect maxDifferencePercent 2ms
36
- ✓ compare > imagesMatch > should work with file paths 6ms
37
- ✓ compare > imagesMatch > should pass through compare options 1ms
38
- ✓ compare > saveDiffImage > should save diff image to file 2ms
39
- ✓ compare > saveDiffImage > should throw error when no diff buffer available 0ms
40
- ✓ compare > error handling > should handle non-existent file paths 1ms
41
- ✓ compare > error handling > should handle invalid image buffers 0ms
42
- ✓ compare > edge cases > should handle 1x1 pixel images 0ms
43
- ✓ compare > edge cases > should handle very large difference percentages 0ms
44
- ✓ compare > edge cases > should handle zero difference threshold 0ms
45
-
46
-  Test Files  1 passed (1)
47
-  Tests  21 passed (21)
48
-  Start at  17:14:17
49
-  Duration  327ms (transform 47ms, setup 0ms, collect 81ms, tests 53ms, environment 0ms, prepare 55ms)
50
-
51
-  PASS  Waiting for file changes...
52
- press h to show help, press q to quit
53
- [?25h[?25h ELIFECYCLE  Test failed. See above for more details.