@cappa/core 0.0.26 → 0.1.0
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.
- package/.turbo/turbo-build.log +17 -13
- package/CHANGELOG.md +12 -0
- package/dist/index.d.mts +96 -3
- package/dist/index.d.ts +96 -3
- package/dist/index.js +142 -18
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +140 -18
- package/dist/index.mjs.map +1 -1
- package/package.json +11 -3
- package/src/compare.test.ts +358 -0
- package/src/compare.ts +118 -0
- package/src/index.ts +7 -1
- package/src/screenshot.ts +173 -28
- package/src/types.ts +53 -0
- package/vitest.config.ts +11 -0
- package/.turbo/turbo-tsc.log +0 -5
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["fs","path","results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]","results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]"],"sources":["../src/config.ts","../src/screenshot.ts"],"sourcesContent":["import type { PossiblePromise, UserConfig } from \"./types\";\n\n/**\n * Type helper to make it easier to use vite.config.ts accepts a direct UserConfig object, 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\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n Locator,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\n\nclass ScreenshotTool {\n browserType: string;\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n fullPage: boolean;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n constructor(options: {\n browserType?: string;\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n fullPage?: boolean;\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.fullPage = options.fullPage !== false; // Default to full page\n }\n\n async init() {\n // Create output directory if it doesn't exist\n if (!fs.existsSync(this.outputDir)) {\n fs.mkdirSync(this.outputDir, { recursive: true });\n }\n\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass =\n browserMap[this.browserType as keyof typeof browserMap];\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 chromiumSandbox: true,\n });\n\n const defaultUserAgent = (await this.browser.newContext())\n .newPage()\n .then((page) => page.evaluate(() => navigator.userAgent));\n\n this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 2,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n });\n\n this.page = await this.context?.newPage();\n this.page?.setViewportSize(this.viewport);\n }\n\n async close() {\n if (this.context) {\n await this.context.close();\n }\n if (this.browser) {\n await this.browser.close();\n }\n }\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 getFilePath(filename: string) {\n const filepath = path.join(this.outputDir, filename);\n return filepath;\n }\n\n async takeScreenshot(\n page: Page,\n filename: string,\n options: {\n fullPage?: boolean;\n waitForSelector?: string;\n waitForTimeout?: number;\n mask?: Locator[];\n omitBackground?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for selector if specified\n if (options.waitForSelector) {\n console.log(`Waiting for selector: ${options.waitForSelector}`);\n await page.waitForSelector(options.waitForSelector, { timeout: 10000 });\n }\n\n // Wait for custom timeout or default\n const waitTime =\n options.waitForTimeout !== undefined ? options.waitForTimeout : 0;\n if (waitTime > 0) {\n console.log(`Waiting for ${waitTime}ms for dynamic content`);\n await page.waitForTimeout(waitTime);\n }\n\n // Generate filename\n const filepath = this.getFilePath(filename);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\",\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n } satisfies PageScreenshotOptions;\n\n await page.screenshot(screenshotOptions);\n\n console.log(`Screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeElementScreenshot(\n page: Page,\n selector: string,\n options: {\n filename?: string;\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for element to be visible\n await page.waitForSelector(selector, { timeout: 10000 });\n\n const element = await page.$(selector);\n if (!element) {\n throw new Error(`Element not found: ${selector}`);\n }\n\n const filename =\n (options.filename as string | undefined) ||\n `${selector.replace(/[^a-zA-Z0-9]/g, \"_\")}.png`;\n const filepath = this.getFilePath(filename);\n\n const elementScreenshotOptions = {\n path: filepath,\n type: \"png\",\n } satisfies PageScreenshotOptions;\n\n await element.screenshot(elementScreenshotOptions);\n\n console.log(`Element screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking element screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n } finally {\n await page.close();\n }\n }\n\n async batchScreenshots(urls: string[], options = {}) {\n const results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const url of urls) {\n try {\n const page = this.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n await this.goTo(page, url);\n const filepath = await this.takeScreenshot(page, url, options);\n results.push({ url, success: true, filepath });\n } catch (error) {\n results.push({\n url,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n async takeResponsiveScreenshots(\n url: string,\n viewports: { width: number; height: number; name: string }[] = [\n { width: 1920, height: 1080, name: \"desktop\" },\n { width: 768, height: 1024, name: \"tablet\" },\n { width: 375, height: 667, name: \"mobile\" },\n ],\n options: {\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n\n const results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const viewport of viewports) {\n try {\n const page = await this.context?.newPage();\n await page.setViewportSize(viewport);\n\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n await page.waitForTimeout(2000);\n\n const filename = `${viewport.name}.png`;\n const filepath = this.getFilePath(filename);\n\n const responsiveScreenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\" as const,\n };\n\n await page.screenshot(responsiveScreenshotOptions);\n\n await page.close();\n\n console.log(`Responsive screenshot saved: ${filepath}`);\n results.push({ viewport: viewport.name, success: true, filepath });\n } catch (error) {\n console.error(\n `Error taking responsive screenshot for ${viewport.name}:`,\n (error as Error).message,\n );\n results.push({\n viewport: viewport.name,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n}\n\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;ACGT,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB,YAAY,SAMT;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,WAAW,QAAQ,aAAa;;CAGvC,MAAM,OAAO;AAEX,MAAI,CAACA,gBAAG,WAAW,KAAK,UAAU,CAChC,iBAAG,UAAU,KAAK,WAAW,EAAE,WAAW,MAAM,CAAC;EAUnD,MAAM,eANa;GACjB;GACA;GACA;GACD,CAGY,KAAK;AAClB,MAAI,CAAC,aACH,OAAM,IAAI,MAAM,6BAA6B,KAAK,cAAc;AAGlE,OAAK,UAAU,MAAM,aAAa,OAAO;GACvC,UAAU,KAAK;GACf,iBAAiB;GAClB,CAAC;EAEF,MAAM,oBAAoB,MAAM,KAAK,QAAQ,YAAY,EACtD,SAAS,CACT,MAAM,SAAS,KAAK,eAAe,UAAU,UAAU,CAAC;AAE3D,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACnB,WAAW,GAAG,MAAM,iBAAiB;GACtC,CAAC;AAEF,OAAK,OAAO,MAAM,KAAK,SAAS,SAAS;AACzC,OAAK,MAAM,gBAAgB,KAAK,SAAS;;CAG3C,MAAM,QAAQ;AACZ,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;AAE5B,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;CAI9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;CAGzD,YAAY,UAAkB;AAE5B,SADiBC,kBAAK,KAAK,KAAK,WAAW,SAAS;;CAItD,MAAM,eACJ,MACA,UACA,UAMI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,OAAI,QAAQ,iBAAiB;AAC3B,YAAQ,IAAI,yBAAyB,QAAQ,kBAAkB;AAC/D,UAAM,KAAK,gBAAgB,QAAQ,iBAAiB,EAAE,SAAS,KAAO,CAAC;;GAIzE,MAAM,WACJ,QAAQ,mBAAmB,SAAY,QAAQ,iBAAiB;AAClE,OAAI,WAAW,GAAG;AAChB,YAAQ,IAAI,eAAe,SAAS,wBAAwB;AAC5D,UAAM,KAAK,eAAe,SAAS;;GAIrC,MAAM,WAAW,KAAK,YAAY,SAAS;GAG3C,MAAM,oBAAoB;IACxB,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACR;AAED,SAAM,KAAK,WAAW,kBAAkB;AAExC,WAAQ,IAAI,qBAAqB,WAAW;AAC5C,UAAO;WACA,OAAO;AACd,WAAQ,MACN,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,sBACJ,MACA,UACA,UAGI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,SAAM,KAAK,gBAAgB,UAAU,EAAE,SAAS,KAAO,CAAC;GAExD,MAAM,UAAU,MAAM,KAAK,EAAE,SAAS;AACtC,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,sBAAsB,WAAW;GAGnD,MAAM,WACH,QAAQ,YACT,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GAC5C,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,2BAA2B;IAC/B,MAAM;IACN,MAAM;IACP;AAED,SAAM,QAAQ,WAAW,yBAAyB;AAElD,WAAQ,IAAI,6BAA6B,WAAW;AACpD,UAAO;WACA,OAAO;AACd,WAAQ,MACN,sCAAsC,KAAK,KAAK,CAAC,IAChD,MAAgB,QAClB;AACD,SAAM;YACE;AACR,SAAM,KAAK,OAAO;;;CAItB,MAAM,iBAAiB,MAAgB,UAAU,EAAE,EAAE;EACnD,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,OAAO,KAChB,KAAI;GACF,MAAM,OAAO,KAAK;AAClB,OAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAEzC,SAAM,KAAK,KAAK,MAAM,IAAI;GAC1B,MAAM,WAAW,MAAM,KAAK,eAAe,MAAM,KAAK,QAAQ;AAC9D,WAAQ,KAAK;IAAE;IAAK,SAAS;IAAM;IAAU,CAAC;WACvC,OAAO;AACd,WAAQ,KAAK;IACX;IACA,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAGT,MAAM,0BACJ,KACA,YAA+D;EAC7D;GAAE,OAAO;GAAM,QAAQ;GAAM,MAAM;GAAW;EAC9C;GAAE,OAAO;GAAK,QAAQ;GAAM,MAAM;GAAU;EAC5C;GAAE,OAAO;GAAK,QAAQ;GAAK,MAAM;GAAU;EAC5C,EACD,UAEI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,YAAY,UACrB,KAAI;GACF,MAAM,OAAO,MAAM,KAAK,SAAS,SAAS;AAC1C,SAAM,KAAK,gBAAgB,SAAS;AAEpC,SAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;AACvD,SAAM,KAAK,eAAe,IAAK;GAE/B,MAAM,WAAW,GAAG,SAAS,KAAK;GAClC,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,8BAA8B;IAClC,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACP;AAED,SAAM,KAAK,WAAW,4BAA4B;AAElD,SAAM,KAAK,OAAO;AAElB,WAAQ,IAAI,gCAAgC,WAAW;AACvD,WAAQ,KAAK;IAAE,UAAU,SAAS;IAAM,SAAS;IAAM;IAAU,CAAC;WAC3D,OAAO;AACd,WAAQ,MACN,0CAA0C,SAAS,KAAK,IACvD,MAAgB,QAClB;AACD,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;;AAIX,yBAAe"}
|
|
1
|
+
{"version":3,"file":"index.js","names":["PNG","fs","defaultDiffConfig: DiffConfig","path","fs","diffImagePath: string | undefined","results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]","results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]"],"sources":["../src/config.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 vite.config.ts accepts a direct UserConfig object, 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 blazediff from \"@blazediff/core\";\nimport type { BlazeDiffOptions } from \"@blazediff/types\";\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}\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 * @param maxDifferencePercent - Maximum allowed difference percentage (0-100)\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 // Load images as PNG objects\n const png1 = await loadPNG(image1);\n const png2 = await loadPNG(image2);\n\n const { width, height } = png1;\n\n // Create diff image\n const diff = withDiff ? new PNG({ width, height }) : undefined;\n\n // Compare images using pixelmatch\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 const passed = percentDifference <= (options.maxDiffPercentage || 0);\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,\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 maxDifferencePercent - Maximum allowed difference percentage (0-100)\n * @param options - Comparison options\n * @returns Whether the images are similar enough\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 return result.passed;\n}\n","import fs from \"node:fs\";\nimport path from \"node:path\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n type Locator,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\nimport {\n type CompareOptions,\n type CompareResult,\n compareImages,\n} from \"./compare\";\nimport type { DiffConfig } from \"./types\";\n\nconst defaultDiffConfig: DiffConfig = {\n threshold: 0.1,\n includeAA: false,\n fastBufferCheck: true,\n maxDiffPixels: 0,\n maxDiffPercentage: 0,\n};\n\nclass ScreenshotTool {\n browserType: string;\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n actualDir: string;\n diffDir: string;\n expectedDir: string;\n fullPage: boolean;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n diff: DiffConfig;\n\n constructor(options: {\n browserType?: string;\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n fullPage?: boolean;\n diff?: DiffConfig;\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.fullPage = options.fullPage !== false; // Default to full page\n this.diff = { ...defaultDiffConfig, ...options.diff };\n // Set up subdirectories\n this.actualDir = path.join(this.outputDir, \"actual\");\n this.diffDir = path.join(this.outputDir, \"diff\");\n this.expectedDir = path.join(this.outputDir, \"expected\");\n }\n\n async init() {\n // Create output directories if they don't exist\n this.createDirectories();\n\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass =\n browserMap[this.browserType as keyof typeof browserMap];\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 this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 2,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n });\n\n this.page = await this.context?.newPage();\n this.page?.setViewportSize(this.viewport);\n }\n\n async close() {\n if (this.context) {\n await this.context.close();\n }\n if (this.browser) {\n await this.browser.close();\n }\n }\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 private createDirectories() {\n // Create main output directory and subdirectories\n const directories = [\n this.outputDir,\n this.actualDir,\n this.diffDir,\n this.expectedDir,\n ];\n\n for (const dir of directories) {\n if (!fs.existsSync(dir)) {\n fs.mkdirSync(dir, { recursive: true });\n console.log(`Created directory: ${dir}`);\n }\n }\n }\n\n getActualFilePath(filename: string): string {\n return path.join(this.actualDir, filename);\n }\n\n getDiffFilePath(filename: string): string {\n return path.join(this.diffDir, filename);\n }\n\n getExpectedFilePath(filename: string): string {\n return path.join(this.expectedDir, filename);\n }\n\n // Keep original method for backward compatibility\n getFilePath(filename: string) {\n return this.getActualFilePath(filename);\n }\n\n async takeScreenshot(\n page: Page,\n filename: string,\n options: {\n fullPage?: boolean;\n mask?: Locator[];\n omitBackground?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Generate filename - save to actual directory\n const filepath = this.getActualFilePath(filename);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\",\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n } satisfies PageScreenshotOptions;\n\n await page.screenshot(screenshotOptions);\n\n console.log(`Screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeElementScreenshot(\n page: Page,\n selector: string,\n options: {\n filename?: string;\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for element to be visible\n await page.waitForSelector(selector, { timeout: 10000 });\n\n const element = await page.$(selector);\n if (!element) {\n throw new Error(`Element not found: ${selector}`);\n }\n\n const filename =\n (options.filename as string | undefined) ||\n `${selector.replace(/[^a-zA-Z0-9]/g, \"_\")}.png`;\n // Save to actual directory\n const filepath = this.getActualFilePath(filename);\n\n const elementScreenshotOptions = {\n path: filepath,\n type: \"png\",\n } satisfies PageScreenshotOptions;\n\n await element.screenshot(elementScreenshotOptions);\n\n console.log(`Element screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking element screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n } finally {\n await page.close();\n }\n }\n\n async takeScreenshotWithComparison(\n page: Page,\n filename: string,\n referenceImage: Buffer,\n options: {\n fullPage?: boolean;\n mask?: Locator[];\n omitBackground?: boolean;\n // Comparison options\n compareOptions?: CompareOptions;\n maxDifferencePercent?: number;\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.getActualFilePath(filename);\n fs.mkdirSync(path.dirname(filepath), { recursive: true });\n\n // Take screenshot and get buffer\n const screenshotOptions = {\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\" as const,\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n } satisfies PageScreenshotOptions;\n\n // Get screenshot as buffer for comparison\n const screenshotBuffer = await page.screenshot(screenshotOptions);\n\n // Save screenshot to actual directory\n fs.writeFileSync(filepath, screenshotBuffer);\n\n console.log(`Screenshot saved: ${filepath}`);\n\n // Perform comparison\n const comparisonResult = await compareImages(\n screenshotBuffer,\n referenceImage,\n true,\n { ...this.diff, ...options.compareOptions },\n );\n\n console.log(\n `Comparison result: ${comparisonResult.numDiffPixels} pixels different (${comparisonResult.percentDifference.toFixed(2)}%) (${\n comparisonResult.passed ? \"PASSED\" : \"FAILED\"\n })`,\n );\n\n let diffImagePath: string | undefined;\n\n // Save diff image if requested and there are differences\n if (\n options.saveDiffImage &&\n comparisonResult.diffBuffer &&\n !comparisonResult.passed\n ) {\n const diffFilename = options.diffImageFilename || filename;\n // Save to diff directory\n diffImagePath = this.getDiffFilePath(diffFilename);\n\n fs.mkdirSync(path.dirname(diffImagePath), { recursive: true });\n fs.writeFileSync(diffImagePath, comparisonResult.diffBuffer);\n }\n\n return {\n screenshotPath: filepath,\n comparisonResult,\n diffImagePath,\n };\n } catch (error) {\n console.error(\n `Error taking screenshot with comparison of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async batchScreenshots(urls: string[], options = {}) {\n const results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const url of urls) {\n try {\n const page = this.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n await this.goTo(page, url);\n const filepath = await this.takeScreenshot(page, url, options);\n results.push({ url, success: true, filepath });\n } catch (error) {\n results.push({\n url,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n async takeResponsiveScreenshots(\n url: string,\n viewports: { width: number; height: number; name: string }[] = [\n { width: 1920, height: 1080, name: \"desktop\" },\n { width: 768, height: 1024, name: \"tablet\" },\n { width: 375, height: 667, name: \"mobile\" },\n ],\n options: {\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n\n const results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const viewport of viewports) {\n try {\n const page = await this.context?.newPage();\n await page.setViewportSize(viewport);\n\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n await page.waitForTimeout(2000);\n\n const filename = `${viewport.name}.png`;\n // Save to actual directory\n const filepath = this.getActualFilePath(filename);\n\n const responsiveScreenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\" as const,\n };\n\n await page.screenshot(responsiveScreenshotOptions);\n\n await page.close();\n\n console.log(`Responsive screenshot saved: ${filepath}`);\n results.push({ viewport: viewport.name, success: true, filepath });\n } catch (error) {\n console.error(\n `Error taking responsive screenshot for ${viewport.name}:`,\n (error as Error).message,\n );\n results.push({\n viewport: viewport.name,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n // Utility method to check if expected image exists\n hasExpectedImage(filename: string): boolean {\n const expectedPath = this.getExpectedFilePath(filename);\n return fs.existsSync(expectedPath);\n }\n\n // Utility method to get expected image as buffer (for future approval process)\n getExpectedImageBuffer(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\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;ACMT,MAAM,WACJ,QACA,QACA,MACA,OACA,QACA,YACG;AACH,sCAAiB,QAAQ,QAAQ,MAAM,OAAO,QAAQ,QAAQ;;;;;;;;;;;AAYhE,eAAsB,cACpB,QACA,QACA,WAAoB,OACpB,SACwB;CAExB,MAAM,OAAO,MAAM,QAAQ,OAAO;CAClC,MAAM,OAAO,MAAM,QAAQ,OAAO;CAElC,MAAM,EAAE,OAAO,WAAW;CAG1B,MAAM,OAAO,WAAW,IAAIA,UAAI;EAAE;EAAO;EAAQ,CAAC,GAAG;CAGrD,MAAM,gBAAgB,QACpB,KAAK,MACL,KAAK,MACL,MAAM,MACN,OACA,QACA,QACD;CAED,MAAM,cAAc,QAAQ;CAC5B,MAAM,oBAAqB,gBAAgB,cAAe;CAC1D,MAAM,SAAS,sBAAsB,QAAQ,qBAAqB;CAGlE,MAAM,aAAa,OAAOA,UAAI,KAAK,MAAM,KAAK,GAAG;AAEjD,QAAO;EACL;EACA;EACA;EACA;EACA;EACD;;;;;AAMH,eAAe,QAAQ,QAAuC;AAC5D,KAAI,OAAO,SAAS,OAAO,CACzB,QAAOA,UAAI,KAAK,KAAK,OAAO;MACvB;EACL,MAAM,SAASC,gBAAG,aAAa,OAAO;AACtC,SAAOD,UAAI,KAAK,KAAK,OAAO;;;;;;AClEhC,MAAME,oBAAgC;CACpC,WAAW;CACX,WAAW;CACX,iBAAiB;CACjB,eAAe;CACf,mBAAmB;CACpB;AAED,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB;CAEA,YAAY,SAOT;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,WAAW,QAAQ,aAAa;AACrC,OAAK,OAAO;GAAE,GAAG;GAAmB,GAAG,QAAQ;GAAM;AAErD,OAAK,YAAYC,kBAAK,KAAK,KAAK,WAAW,SAAS;AACpD,OAAK,UAAUA,kBAAK,KAAK,KAAK,WAAW,OAAO;AAChD,OAAK,cAAcA,kBAAK,KAAK,KAAK,WAAW,WAAW;;CAG1D,MAAM,OAAO;AAEX,OAAK,mBAAmB;EASxB,MAAM,eANa;GACjB;GACA;GACA;GACD,CAGY,KAAK;AAClB,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;AAE3D,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACnB,WAAW,GAAG,MAAM,iBAAiB;GACtC,CAAC;AAEF,OAAK,OAAO,MAAM,KAAK,SAAS,SAAS;AACzC,OAAK,MAAM,gBAAgB,KAAK,SAAS;;CAG3C,MAAM,QAAQ;AACZ,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;AAE5B,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;CAI9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;CAGzD,AAAQ,oBAAoB;EAE1B,MAAM,cAAc;GAClB,KAAK;GACL,KAAK;GACL,KAAK;GACL,KAAK;GACN;AAED,OAAK,MAAM,OAAO,YAChB,KAAI,CAACC,gBAAG,WAAW,IAAI,EAAE;AACvB,mBAAG,UAAU,KAAK,EAAE,WAAW,MAAM,CAAC;AACtC,WAAQ,IAAI,sBAAsB,MAAM;;;CAK9C,kBAAkB,UAA0B;AAC1C,SAAOD,kBAAK,KAAK,KAAK,WAAW,SAAS;;CAG5C,gBAAgB,UAA0B;AACxC,SAAOA,kBAAK,KAAK,KAAK,SAAS,SAAS;;CAG1C,oBAAoB,UAA0B;AAC5C,SAAOA,kBAAK,KAAK,KAAK,aAAa,SAAS;;CAI9C,YAAY,UAAkB;AAC5B,SAAO,KAAK,kBAAkB,SAAS;;CAGzC,MAAM,eACJ,MACA,UACA,UAII,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;GAEF,MAAM,WAAW,KAAK,kBAAkB,SAAS;GAGjD,MAAM,oBAAoB;IACxB,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACR;AAED,SAAM,KAAK,WAAW,kBAAkB;AAExC,WAAQ,IAAI,qBAAqB,WAAW;AAC5C,UAAO;WACA,OAAO;AACd,WAAQ,MACN,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,sBACJ,MACA,UACA,UAGI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,SAAM,KAAK,gBAAgB,UAAU,EAAE,SAAS,KAAO,CAAC;GAExD,MAAM,UAAU,MAAM,KAAK,EAAE,SAAS;AACtC,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,sBAAsB,WAAW;GAGnD,MAAM,WACH,QAAQ,YACT,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GAE5C,MAAM,WAAW,KAAK,kBAAkB,SAAS;GAEjD,MAAM,2BAA2B;IAC/B,MAAM;IACN,MAAM;IACP;AAED,SAAM,QAAQ,WAAW,yBAAyB;AAElD,WAAQ,IAAI,6BAA6B,WAAW;AACpD,UAAO;WACA,OAAO;AACd,WAAQ,MACN,sCAAsC,KAAK,KAAK,CAAC,IAChD,MAAgB,QAClB;AACD,SAAM;YACE;AACR,SAAM,KAAK,OAAO;;;CAItB,MAAM,6BACJ,MACA,UACA,gBACA,UASI,EAAE,EAKL;AACD,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;GAEF,MAAM,WAAW,KAAK,kBAAkB,SAAS;AACjD,mBAAG,UAAUA,kBAAK,QAAQ,SAAS,EAAE,EAAE,WAAW,MAAM,CAAC;GAGzD,MAAM,oBAAoB;IACxB,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACR;GAGD,MAAM,mBAAmB,MAAM,KAAK,WAAW,kBAAkB;AAGjE,mBAAG,cAAc,UAAU,iBAAiB;AAE5C,WAAQ,IAAI,qBAAqB,WAAW;GAG5C,MAAM,mBAAmB,MAAM,cAC7B,kBACA,gBACA,MACA;IAAE,GAAG,KAAK;IAAM,GAAG,QAAQ;IAAgB,CAC5C;AAED,WAAQ,IACN,sBAAsB,iBAAiB,cAAc,qBAAqB,iBAAiB,kBAAkB,QAAQ,EAAE,CAAC,MACtH,iBAAiB,SAAS,WAAW,SACtC,GACF;GAED,IAAIE;AAGJ,OACE,QAAQ,iBACR,iBAAiB,cACjB,CAAC,iBAAiB,QAClB;IACA,MAAM,eAAe,QAAQ,qBAAqB;AAElD,oBAAgB,KAAK,gBAAgB,aAAa;AAElD,oBAAG,UAAUF,kBAAK,QAAQ,cAAc,EAAE,EAAE,WAAW,MAAM,CAAC;AAC9D,oBAAG,cAAc,eAAe,iBAAiB,WAAW;;AAG9D,UAAO;IACL,gBAAgB;IAChB;IACA;IACD;WACM,OAAO;AACd,WAAQ,MACN,8CAA8C,KAAK,KAAK,CAAC,IACxD,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,iBAAiB,MAAgB,UAAU,EAAE,EAAE;EACnD,MAAMG,UAKA,EAAE;AAER,OAAK,MAAM,OAAO,KAChB,KAAI;GACF,MAAM,OAAO,KAAK;AAClB,OAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAEzC,SAAM,KAAK,KAAK,MAAM,IAAI;GAC1B,MAAM,WAAW,MAAM,KAAK,eAAe,MAAM,KAAK,QAAQ;AAC9D,WAAQ,KAAK;IAAE;IAAK,SAAS;IAAM;IAAU,CAAC;WACvC,OAAO;AACd,WAAQ,KAAK;IACX;IACA,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAGT,MAAM,0BACJ,KACA,YAA+D;EAC7D;GAAE,OAAO;GAAM,QAAQ;GAAM,MAAM;GAAW;EAC9C;GAAE,OAAO;GAAK,QAAQ;GAAM,MAAM;GAAU;EAC5C;GAAE,OAAO;GAAK,QAAQ;GAAK,MAAM;GAAU;EAC5C,EACD,UAEI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,YAAY,UACrB,KAAI;GACF,MAAM,OAAO,MAAM,KAAK,SAAS,SAAS;AAC1C,SAAM,KAAK,gBAAgB,SAAS;AAEpC,SAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;AACvD,SAAM,KAAK,eAAe,IAAK;GAE/B,MAAM,WAAW,GAAG,SAAS,KAAK;GAElC,MAAM,WAAW,KAAK,kBAAkB,SAAS;GAEjD,MAAM,8BAA8B;IAClC,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACP;AAED,SAAM,KAAK,WAAW,4BAA4B;AAElD,SAAM,KAAK,OAAO;AAElB,WAAQ,IAAI,gCAAgC,WAAW;AACvD,WAAQ,KAAK;IAAE,UAAU,SAAS;IAAM,SAAS;IAAM;IAAU,CAAC;WAC3D,OAAO;AACd,WAAQ,MACN,0CAA0C,SAAS,KAAK,IACvD,MAAgB,QAClB;AACD,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAIT,iBAAiB,UAA2B;EAC1C,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,SAAOH,gBAAG,WAAW,aAAa;;CAIpC,uBAAuB,UAA0B;EAC/C,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,MAAI,CAACA,gBAAG,WAAW,aAAa,CAC9B,OAAM,IAAI,MAAM,6BAA6B,eAAe;AAE9D,SAAOA,gBAAG,aAAa,aAAa;;;AAIxC,yBAAe"}
|
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import fs from "node:fs";
|
|
2
2
|
import path from "node:path";
|
|
3
3
|
import { chromium, firefox, webkit } from "playwright-core";
|
|
4
|
+
import blazediff from "@blazediff/core";
|
|
5
|
+
import { PNG } from "pngjs";
|
|
4
6
|
|
|
5
7
|
//#region src/config.ts
|
|
6
8
|
/**
|
|
@@ -10,17 +12,74 @@ function defineConfig(options) {
|
|
|
10
12
|
return options;
|
|
11
13
|
}
|
|
12
14
|
|
|
15
|
+
//#endregion
|
|
16
|
+
//#region src/compare.ts
|
|
17
|
+
const compare = (image1, image2, diff, width, height, options) => {
|
|
18
|
+
return blazediff(image1, image2, diff, width, height, options);
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Compare two PNG images and return the difference
|
|
22
|
+
* @param image1 - First image (file path or Buffer)
|
|
23
|
+
* @param image2 - Second image (file path or Buffer)
|
|
24
|
+
* @param withDiff - Whether to create a diff image
|
|
25
|
+
* @param options - Comparison options
|
|
26
|
+
* @param maxDifferencePercent - Maximum allowed difference percentage (0-100)
|
|
27
|
+
* @returns Comparison result
|
|
28
|
+
*/
|
|
29
|
+
async function compareImages(image1, image2, withDiff = false, options) {
|
|
30
|
+
const png1 = await loadPNG(image1);
|
|
31
|
+
const png2 = await loadPNG(image2);
|
|
32
|
+
const { width, height } = png1;
|
|
33
|
+
const diff = withDiff ? new PNG({
|
|
34
|
+
width,
|
|
35
|
+
height
|
|
36
|
+
}) : void 0;
|
|
37
|
+
const numDiffPixels = compare(png1.data, png2.data, diff?.data, width, height, options);
|
|
38
|
+
const totalPixels = width * height;
|
|
39
|
+
const percentDifference = numDiffPixels / totalPixels * 100;
|
|
40
|
+
const passed = percentDifference <= (options.maxDiffPercentage || 0);
|
|
41
|
+
const diffBuffer = diff ? PNG.sync.write(diff) : void 0;
|
|
42
|
+
return {
|
|
43
|
+
numDiffPixels,
|
|
44
|
+
totalPixels,
|
|
45
|
+
percentDifference,
|
|
46
|
+
diffBuffer,
|
|
47
|
+
passed
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Load a PNG image from file path or Buffer
|
|
52
|
+
*/
|
|
53
|
+
async function loadPNG(source) {
|
|
54
|
+
if (Buffer.isBuffer(source)) return PNG.sync.read(source);
|
|
55
|
+
else {
|
|
56
|
+
const buffer = fs.readFileSync(source);
|
|
57
|
+
return PNG.sync.read(buffer);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
13
61
|
//#endregion
|
|
14
62
|
//#region src/screenshot.ts
|
|
63
|
+
const defaultDiffConfig = {
|
|
64
|
+
threshold: .1,
|
|
65
|
+
includeAA: false,
|
|
66
|
+
fastBufferCheck: true,
|
|
67
|
+
maxDiffPixels: 0,
|
|
68
|
+
maxDiffPercentage: 0
|
|
69
|
+
};
|
|
15
70
|
var ScreenshotTool = class {
|
|
16
71
|
browserType;
|
|
17
72
|
headless;
|
|
18
73
|
viewport;
|
|
19
74
|
outputDir;
|
|
75
|
+
actualDir;
|
|
76
|
+
diffDir;
|
|
77
|
+
expectedDir;
|
|
20
78
|
fullPage;
|
|
21
79
|
browser = null;
|
|
22
80
|
context = null;
|
|
23
81
|
page = null;
|
|
82
|
+
diff;
|
|
24
83
|
constructor(options) {
|
|
25
84
|
this.browserType = options.browserType || "chromium";
|
|
26
85
|
this.headless = options.headless !== false;
|
|
@@ -30,19 +89,23 @@ var ScreenshotTool = class {
|
|
|
30
89
|
};
|
|
31
90
|
this.outputDir = options.outputDir || "./screenshots";
|
|
32
91
|
this.fullPage = options.fullPage !== false;
|
|
92
|
+
this.diff = {
|
|
93
|
+
...defaultDiffConfig,
|
|
94
|
+
...options.diff
|
|
95
|
+
};
|
|
96
|
+
this.actualDir = path.join(this.outputDir, "actual");
|
|
97
|
+
this.diffDir = path.join(this.outputDir, "diff");
|
|
98
|
+
this.expectedDir = path.join(this.outputDir, "expected");
|
|
33
99
|
}
|
|
34
100
|
async init() {
|
|
35
|
-
|
|
101
|
+
this.createDirectories();
|
|
36
102
|
const browserClass = {
|
|
37
103
|
chromium,
|
|
38
104
|
firefox,
|
|
39
105
|
webkit
|
|
40
106
|
}[this.browserType];
|
|
41
107
|
if (!browserClass) throw new Error(`Unsupported browser type: ${this.browserType}`);
|
|
42
|
-
this.browser = await browserClass.launch({
|
|
43
|
-
headless: this.headless,
|
|
44
|
-
chromiumSandbox: true
|
|
45
|
-
});
|
|
108
|
+
this.browser = await browserClass.launch({ headless: this.headless });
|
|
46
109
|
const defaultUserAgent = (await this.browser.newContext()).newPage().then((page) => page.evaluate(() => navigator.userAgent));
|
|
47
110
|
this.context = await this.browser.newContext({
|
|
48
111
|
reducedMotion: "reduce",
|
|
@@ -60,22 +123,34 @@ var ScreenshotTool = class {
|
|
|
60
123
|
if (!this.context) throw new Error("Browser not initialized");
|
|
61
124
|
await page.goto(url, { waitUntil: "domcontentloaded" });
|
|
62
125
|
}
|
|
126
|
+
createDirectories() {
|
|
127
|
+
const directories = [
|
|
128
|
+
this.outputDir,
|
|
129
|
+
this.actualDir,
|
|
130
|
+
this.diffDir,
|
|
131
|
+
this.expectedDir
|
|
132
|
+
];
|
|
133
|
+
for (const dir of directories) if (!fs.existsSync(dir)) {
|
|
134
|
+
fs.mkdirSync(dir, { recursive: true });
|
|
135
|
+
console.log(`Created directory: ${dir}`);
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
getActualFilePath(filename) {
|
|
139
|
+
return path.join(this.actualDir, filename);
|
|
140
|
+
}
|
|
141
|
+
getDiffFilePath(filename) {
|
|
142
|
+
return path.join(this.diffDir, filename);
|
|
143
|
+
}
|
|
144
|
+
getExpectedFilePath(filename) {
|
|
145
|
+
return path.join(this.expectedDir, filename);
|
|
146
|
+
}
|
|
63
147
|
getFilePath(filename) {
|
|
64
|
-
return
|
|
148
|
+
return this.getActualFilePath(filename);
|
|
65
149
|
}
|
|
66
150
|
async takeScreenshot(page, filename, options = {}) {
|
|
67
151
|
if (!this.browser) throw new Error("Browser not initialized");
|
|
68
152
|
try {
|
|
69
|
-
|
|
70
|
-
console.log(`Waiting for selector: ${options.waitForSelector}`);
|
|
71
|
-
await page.waitForSelector(options.waitForSelector, { timeout: 1e4 });
|
|
72
|
-
}
|
|
73
|
-
const waitTime = options.waitForTimeout !== void 0 ? options.waitForTimeout : 0;
|
|
74
|
-
if (waitTime > 0) {
|
|
75
|
-
console.log(`Waiting for ${waitTime}ms for dynamic content`);
|
|
76
|
-
await page.waitForTimeout(waitTime);
|
|
77
|
-
}
|
|
78
|
-
const filepath = this.getFilePath(filename);
|
|
153
|
+
const filepath = this.getActualFilePath(filename);
|
|
79
154
|
const screenshotOptions = {
|
|
80
155
|
path: filepath,
|
|
81
156
|
fullPage: options.fullPage !== void 0 ? options.fullPage : this.fullPage,
|
|
@@ -100,7 +175,7 @@ var ScreenshotTool = class {
|
|
|
100
175
|
const element = await page.$(selector);
|
|
101
176
|
if (!element) throw new Error(`Element not found: ${selector}`);
|
|
102
177
|
const filename = options.filename || `${selector.replace(/[^a-zA-Z0-9]/g, "_")}.png`;
|
|
103
|
-
const filepath = this.
|
|
178
|
+
const filepath = this.getActualFilePath(filename);
|
|
104
179
|
const elementScreenshotOptions = {
|
|
105
180
|
path: filepath,
|
|
106
181
|
type: "png"
|
|
@@ -115,6 +190,44 @@ var ScreenshotTool = class {
|
|
|
115
190
|
await page.close();
|
|
116
191
|
}
|
|
117
192
|
}
|
|
193
|
+
async takeScreenshotWithComparison(page, filename, referenceImage, options = {}) {
|
|
194
|
+
if (!this.browser) throw new Error("Browser not initialized");
|
|
195
|
+
try {
|
|
196
|
+
const filepath = this.getActualFilePath(filename);
|
|
197
|
+
fs.mkdirSync(path.dirname(filepath), { recursive: true });
|
|
198
|
+
const screenshotOptions = {
|
|
199
|
+
fullPage: options.fullPage !== void 0 ? options.fullPage : this.fullPage,
|
|
200
|
+
type: "png",
|
|
201
|
+
timeout: 6e4,
|
|
202
|
+
mask: options.mask,
|
|
203
|
+
omitBackground: options.omitBackground,
|
|
204
|
+
scale: "css"
|
|
205
|
+
};
|
|
206
|
+
const screenshotBuffer = await page.screenshot(screenshotOptions);
|
|
207
|
+
fs.writeFileSync(filepath, screenshotBuffer);
|
|
208
|
+
console.log(`Screenshot saved: ${filepath}`);
|
|
209
|
+
const comparisonResult = await compareImages(screenshotBuffer, referenceImage, true, {
|
|
210
|
+
...this.diff,
|
|
211
|
+
...options.compareOptions
|
|
212
|
+
});
|
|
213
|
+
console.log(`Comparison result: ${comparisonResult.numDiffPixels} pixels different (${comparisonResult.percentDifference.toFixed(2)}%) (${comparisonResult.passed ? "PASSED" : "FAILED"})`);
|
|
214
|
+
let diffImagePath;
|
|
215
|
+
if (options.saveDiffImage && comparisonResult.diffBuffer && !comparisonResult.passed) {
|
|
216
|
+
const diffFilename = options.diffImageFilename || filename;
|
|
217
|
+
diffImagePath = this.getDiffFilePath(diffFilename);
|
|
218
|
+
fs.mkdirSync(path.dirname(diffImagePath), { recursive: true });
|
|
219
|
+
fs.writeFileSync(diffImagePath, comparisonResult.diffBuffer);
|
|
220
|
+
}
|
|
221
|
+
return {
|
|
222
|
+
screenshotPath: filepath,
|
|
223
|
+
comparisonResult,
|
|
224
|
+
diffImagePath
|
|
225
|
+
};
|
|
226
|
+
} catch (error) {
|
|
227
|
+
console.error(`Error taking screenshot with comparison of ${page.url()}:`, error.message);
|
|
228
|
+
throw error;
|
|
229
|
+
}
|
|
230
|
+
}
|
|
118
231
|
async batchScreenshots(urls, options = {}) {
|
|
119
232
|
const results = [];
|
|
120
233
|
for (const url of urls) try {
|
|
@@ -162,7 +275,7 @@ var ScreenshotTool = class {
|
|
|
162
275
|
await page.goto(url, { waitUntil: "domcontentloaded" });
|
|
163
276
|
await page.waitForTimeout(2e3);
|
|
164
277
|
const filename = `${viewport.name}.png`;
|
|
165
|
-
const filepath = this.
|
|
278
|
+
const filepath = this.getActualFilePath(filename);
|
|
166
279
|
const responsiveScreenshotOptions = {
|
|
167
280
|
path: filepath,
|
|
168
281
|
fullPage: options.fullPage !== void 0 ? options.fullPage : this.fullPage,
|
|
@@ -187,6 +300,15 @@ var ScreenshotTool = class {
|
|
|
187
300
|
}
|
|
188
301
|
return results;
|
|
189
302
|
}
|
|
303
|
+
hasExpectedImage(filename) {
|
|
304
|
+
const expectedPath = this.getExpectedFilePath(filename);
|
|
305
|
+
return fs.existsSync(expectedPath);
|
|
306
|
+
}
|
|
307
|
+
getExpectedImageBuffer(filename) {
|
|
308
|
+
const expectedPath = this.getExpectedFilePath(filename);
|
|
309
|
+
if (!fs.existsSync(expectedPath)) throw new Error(`Expected image not found: ${expectedPath}`);
|
|
310
|
+
return fs.readFileSync(expectedPath);
|
|
311
|
+
}
|
|
190
312
|
};
|
|
191
313
|
var screenshot_default = ScreenshotTool;
|
|
192
314
|
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]","results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]"],"sources":["../src/config.ts","../src/screenshot.ts"],"sourcesContent":["import type { PossiblePromise, UserConfig } from \"./types\";\n\n/**\n * Type helper to make it easier to use vite.config.ts accepts a direct UserConfig object, 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\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n Locator,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\n\nclass ScreenshotTool {\n browserType: string;\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n fullPage: boolean;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n constructor(options: {\n browserType?: string;\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n fullPage?: boolean;\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.fullPage = options.fullPage !== false; // Default to full page\n }\n\n async init() {\n // Create output directory if it doesn't exist\n if (!fs.existsSync(this.outputDir)) {\n fs.mkdirSync(this.outputDir, { recursive: true });\n }\n\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass =\n browserMap[this.browserType as keyof typeof browserMap];\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 chromiumSandbox: true,\n });\n\n const defaultUserAgent = (await this.browser.newContext())\n .newPage()\n .then((page) => page.evaluate(() => navigator.userAgent));\n\n this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 2,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n });\n\n this.page = await this.context?.newPage();\n this.page?.setViewportSize(this.viewport);\n }\n\n async close() {\n if (this.context) {\n await this.context.close();\n }\n if (this.browser) {\n await this.browser.close();\n }\n }\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 getFilePath(filename: string) {\n const filepath = path.join(this.outputDir, filename);\n return filepath;\n }\n\n async takeScreenshot(\n page: Page,\n filename: string,\n options: {\n fullPage?: boolean;\n waitForSelector?: string;\n waitForTimeout?: number;\n mask?: Locator[];\n omitBackground?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for selector if specified\n if (options.waitForSelector) {\n console.log(`Waiting for selector: ${options.waitForSelector}`);\n await page.waitForSelector(options.waitForSelector, { timeout: 10000 });\n }\n\n // Wait for custom timeout or default\n const waitTime =\n options.waitForTimeout !== undefined ? options.waitForTimeout : 0;\n if (waitTime > 0) {\n console.log(`Waiting for ${waitTime}ms for dynamic content`);\n await page.waitForTimeout(waitTime);\n }\n\n // Generate filename\n const filepath = this.getFilePath(filename);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\",\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n } satisfies PageScreenshotOptions;\n\n await page.screenshot(screenshotOptions);\n\n console.log(`Screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeElementScreenshot(\n page: Page,\n selector: string,\n options: {\n filename?: string;\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for element to be visible\n await page.waitForSelector(selector, { timeout: 10000 });\n\n const element = await page.$(selector);\n if (!element) {\n throw new Error(`Element not found: ${selector}`);\n }\n\n const filename =\n (options.filename as string | undefined) ||\n `${selector.replace(/[^a-zA-Z0-9]/g, \"_\")}.png`;\n const filepath = this.getFilePath(filename);\n\n const elementScreenshotOptions = {\n path: filepath,\n type: \"png\",\n } satisfies PageScreenshotOptions;\n\n await element.screenshot(elementScreenshotOptions);\n\n console.log(`Element screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking element screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n } finally {\n await page.close();\n }\n }\n\n async batchScreenshots(urls: string[], options = {}) {\n const results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const url of urls) {\n try {\n const page = this.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n await this.goTo(page, url);\n const filepath = await this.takeScreenshot(page, url, options);\n results.push({ url, success: true, filepath });\n } catch (error) {\n results.push({\n url,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n async takeResponsiveScreenshots(\n url: string,\n viewports: { width: number; height: number; name: string }[] = [\n { width: 1920, height: 1080, name: \"desktop\" },\n { width: 768, height: 1024, name: \"tablet\" },\n { width: 375, height: 667, name: \"mobile\" },\n ],\n options: {\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n\n const results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const viewport of viewports) {\n try {\n const page = await this.context?.newPage();\n await page.setViewportSize(viewport);\n\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n await page.waitForTimeout(2000);\n\n const filename = `${viewport.name}.png`;\n const filepath = this.getFilePath(filename);\n\n const responsiveScreenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\" as const,\n };\n\n await page.screenshot(responsiveScreenshotOptions);\n\n await page.close();\n\n console.log(`Responsive screenshot saved: ${filepath}`);\n results.push({ viewport: viewport.name, success: true, filepath });\n } catch (error) {\n console.error(\n `Error taking responsive screenshot for ${viewport.name}:`,\n (error as Error).message,\n );\n results.push({\n viewport: viewport.name,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n}\n\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;ACGT,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB,YAAY,SAMT;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,WAAW,QAAQ,aAAa;;CAGvC,MAAM,OAAO;AAEX,MAAI,CAAC,GAAG,WAAW,KAAK,UAAU,CAChC,IAAG,UAAU,KAAK,WAAW,EAAE,WAAW,MAAM,CAAC;EAUnD,MAAM,eANa;GACjB;GACA;GACA;GACD,CAGY,KAAK;AAClB,MAAI,CAAC,aACH,OAAM,IAAI,MAAM,6BAA6B,KAAK,cAAc;AAGlE,OAAK,UAAU,MAAM,aAAa,OAAO;GACvC,UAAU,KAAK;GACf,iBAAiB;GAClB,CAAC;EAEF,MAAM,oBAAoB,MAAM,KAAK,QAAQ,YAAY,EACtD,SAAS,CACT,MAAM,SAAS,KAAK,eAAe,UAAU,UAAU,CAAC;AAE3D,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACnB,WAAW,GAAG,MAAM,iBAAiB;GACtC,CAAC;AAEF,OAAK,OAAO,MAAM,KAAK,SAAS,SAAS;AACzC,OAAK,MAAM,gBAAgB,KAAK,SAAS;;CAG3C,MAAM,QAAQ;AACZ,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;AAE5B,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;CAI9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;CAGzD,YAAY,UAAkB;AAE5B,SADiB,KAAK,KAAK,KAAK,WAAW,SAAS;;CAItD,MAAM,eACJ,MACA,UACA,UAMI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,OAAI,QAAQ,iBAAiB;AAC3B,YAAQ,IAAI,yBAAyB,QAAQ,kBAAkB;AAC/D,UAAM,KAAK,gBAAgB,QAAQ,iBAAiB,EAAE,SAAS,KAAO,CAAC;;GAIzE,MAAM,WACJ,QAAQ,mBAAmB,SAAY,QAAQ,iBAAiB;AAClE,OAAI,WAAW,GAAG;AAChB,YAAQ,IAAI,eAAe,SAAS,wBAAwB;AAC5D,UAAM,KAAK,eAAe,SAAS;;GAIrC,MAAM,WAAW,KAAK,YAAY,SAAS;GAG3C,MAAM,oBAAoB;IACxB,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACR;AAED,SAAM,KAAK,WAAW,kBAAkB;AAExC,WAAQ,IAAI,qBAAqB,WAAW;AAC5C,UAAO;WACA,OAAO;AACd,WAAQ,MACN,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,sBACJ,MACA,UACA,UAGI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,SAAM,KAAK,gBAAgB,UAAU,EAAE,SAAS,KAAO,CAAC;GAExD,MAAM,UAAU,MAAM,KAAK,EAAE,SAAS;AACtC,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,sBAAsB,WAAW;GAGnD,MAAM,WACH,QAAQ,YACT,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GAC5C,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,2BAA2B;IAC/B,MAAM;IACN,MAAM;IACP;AAED,SAAM,QAAQ,WAAW,yBAAyB;AAElD,WAAQ,IAAI,6BAA6B,WAAW;AACpD,UAAO;WACA,OAAO;AACd,WAAQ,MACN,sCAAsC,KAAK,KAAK,CAAC,IAChD,MAAgB,QAClB;AACD,SAAM;YACE;AACR,SAAM,KAAK,OAAO;;;CAItB,MAAM,iBAAiB,MAAgB,UAAU,EAAE,EAAE;EACnD,MAAMA,UAKA,EAAE;AAER,OAAK,MAAM,OAAO,KAChB,KAAI;GACF,MAAM,OAAO,KAAK;AAClB,OAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAEzC,SAAM,KAAK,KAAK,MAAM,IAAI;GAC1B,MAAM,WAAW,MAAM,KAAK,eAAe,MAAM,KAAK,QAAQ;AAC9D,WAAQ,KAAK;IAAE;IAAK,SAAS;IAAM;IAAU,CAAC;WACvC,OAAO;AACd,WAAQ,KAAK;IACX;IACA,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAGT,MAAM,0BACJ,KACA,YAA+D;EAC7D;GAAE,OAAO;GAAM,QAAQ;GAAM,MAAM;GAAW;EAC9C;GAAE,OAAO;GAAK,QAAQ;GAAM,MAAM;GAAU;EAC5C;GAAE,OAAO;GAAK,QAAQ;GAAK,MAAM;GAAU;EAC5C,EACD,UAEI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,YAAY,UACrB,KAAI;GACF,MAAM,OAAO,MAAM,KAAK,SAAS,SAAS;AAC1C,SAAM,KAAK,gBAAgB,SAAS;AAEpC,SAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;AACvD,SAAM,KAAK,eAAe,IAAK;GAE/B,MAAM,WAAW,GAAG,SAAS,KAAK;GAClC,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,8BAA8B;IAClC,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACP;AAED,SAAM,KAAK,WAAW,4BAA4B;AAElD,SAAM,KAAK,OAAO;AAElB,WAAQ,IAAI,gCAAgC,WAAW;AACvD,WAAQ,KAAK;IAAE,UAAU,SAAS;IAAM,SAAS;IAAM;IAAU,CAAC;WAC3D,OAAO;AACd,WAAQ,MACN,0CAA0C,SAAS,KAAK,IACvD,MAAgB,QAClB;AACD,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;;AAIX,yBAAe"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["defaultDiffConfig: DiffConfig","diffImagePath: string | undefined","results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]","results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]"],"sources":["../src/config.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 vite.config.ts accepts a direct UserConfig object, 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 blazediff from \"@blazediff/core\";\nimport type { BlazeDiffOptions } from \"@blazediff/types\";\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}\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 * @param maxDifferencePercent - Maximum allowed difference percentage (0-100)\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 // Load images as PNG objects\n const png1 = await loadPNG(image1);\n const png2 = await loadPNG(image2);\n\n const { width, height } = png1;\n\n // Create diff image\n const diff = withDiff ? new PNG({ width, height }) : undefined;\n\n // Compare images using pixelmatch\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 const passed = percentDifference <= (options.maxDiffPercentage || 0);\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,\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 maxDifferencePercent - Maximum allowed difference percentage (0-100)\n * @param options - Comparison options\n * @returns Whether the images are similar enough\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 return result.passed;\n}\n","import fs from \"node:fs\";\nimport path from \"node:path\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n type Locator,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\nimport {\n type CompareOptions,\n type CompareResult,\n compareImages,\n} from \"./compare\";\nimport type { DiffConfig } from \"./types\";\n\nconst defaultDiffConfig: DiffConfig = {\n threshold: 0.1,\n includeAA: false,\n fastBufferCheck: true,\n maxDiffPixels: 0,\n maxDiffPercentage: 0,\n};\n\nclass ScreenshotTool {\n browserType: string;\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n actualDir: string;\n diffDir: string;\n expectedDir: string;\n fullPage: boolean;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n diff: DiffConfig;\n\n constructor(options: {\n browserType?: string;\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n fullPage?: boolean;\n diff?: DiffConfig;\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.fullPage = options.fullPage !== false; // Default to full page\n this.diff = { ...defaultDiffConfig, ...options.diff };\n // Set up subdirectories\n this.actualDir = path.join(this.outputDir, \"actual\");\n this.diffDir = path.join(this.outputDir, \"diff\");\n this.expectedDir = path.join(this.outputDir, \"expected\");\n }\n\n async init() {\n // Create output directories if they don't exist\n this.createDirectories();\n\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass =\n browserMap[this.browserType as keyof typeof browserMap];\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 this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 2,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n });\n\n this.page = await this.context?.newPage();\n this.page?.setViewportSize(this.viewport);\n }\n\n async close() {\n if (this.context) {\n await this.context.close();\n }\n if (this.browser) {\n await this.browser.close();\n }\n }\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 private createDirectories() {\n // Create main output directory and subdirectories\n const directories = [\n this.outputDir,\n this.actualDir,\n this.diffDir,\n this.expectedDir,\n ];\n\n for (const dir of directories) {\n if (!fs.existsSync(dir)) {\n fs.mkdirSync(dir, { recursive: true });\n console.log(`Created directory: ${dir}`);\n }\n }\n }\n\n getActualFilePath(filename: string): string {\n return path.join(this.actualDir, filename);\n }\n\n getDiffFilePath(filename: string): string {\n return path.join(this.diffDir, filename);\n }\n\n getExpectedFilePath(filename: string): string {\n return path.join(this.expectedDir, filename);\n }\n\n // Keep original method for backward compatibility\n getFilePath(filename: string) {\n return this.getActualFilePath(filename);\n }\n\n async takeScreenshot(\n page: Page,\n filename: string,\n options: {\n fullPage?: boolean;\n mask?: Locator[];\n omitBackground?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Generate filename - save to actual directory\n const filepath = this.getActualFilePath(filename);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\",\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n } satisfies PageScreenshotOptions;\n\n await page.screenshot(screenshotOptions);\n\n console.log(`Screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeElementScreenshot(\n page: Page,\n selector: string,\n options: {\n filename?: string;\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for element to be visible\n await page.waitForSelector(selector, { timeout: 10000 });\n\n const element = await page.$(selector);\n if (!element) {\n throw new Error(`Element not found: ${selector}`);\n }\n\n const filename =\n (options.filename as string | undefined) ||\n `${selector.replace(/[^a-zA-Z0-9]/g, \"_\")}.png`;\n // Save to actual directory\n const filepath = this.getActualFilePath(filename);\n\n const elementScreenshotOptions = {\n path: filepath,\n type: \"png\",\n } satisfies PageScreenshotOptions;\n\n await element.screenshot(elementScreenshotOptions);\n\n console.log(`Element screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking element screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n } finally {\n await page.close();\n }\n }\n\n async takeScreenshotWithComparison(\n page: Page,\n filename: string,\n referenceImage: Buffer,\n options: {\n fullPage?: boolean;\n mask?: Locator[];\n omitBackground?: boolean;\n // Comparison options\n compareOptions?: CompareOptions;\n maxDifferencePercent?: number;\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.getActualFilePath(filename);\n fs.mkdirSync(path.dirname(filepath), { recursive: true });\n\n // Take screenshot and get buffer\n const screenshotOptions = {\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\" as const,\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n } satisfies PageScreenshotOptions;\n\n // Get screenshot as buffer for comparison\n const screenshotBuffer = await page.screenshot(screenshotOptions);\n\n // Save screenshot to actual directory\n fs.writeFileSync(filepath, screenshotBuffer);\n\n console.log(`Screenshot saved: ${filepath}`);\n\n // Perform comparison\n const comparisonResult = await compareImages(\n screenshotBuffer,\n referenceImage,\n true,\n { ...this.diff, ...options.compareOptions },\n );\n\n console.log(\n `Comparison result: ${comparisonResult.numDiffPixels} pixels different (${comparisonResult.percentDifference.toFixed(2)}%) (${\n comparisonResult.passed ? \"PASSED\" : \"FAILED\"\n })`,\n );\n\n let diffImagePath: string | undefined;\n\n // Save diff image if requested and there are differences\n if (\n options.saveDiffImage &&\n comparisonResult.diffBuffer &&\n !comparisonResult.passed\n ) {\n const diffFilename = options.diffImageFilename || filename;\n // Save to diff directory\n diffImagePath = this.getDiffFilePath(diffFilename);\n\n fs.mkdirSync(path.dirname(diffImagePath), { recursive: true });\n fs.writeFileSync(diffImagePath, comparisonResult.diffBuffer);\n }\n\n return {\n screenshotPath: filepath,\n comparisonResult,\n diffImagePath,\n };\n } catch (error) {\n console.error(\n `Error taking screenshot with comparison of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async batchScreenshots(urls: string[], options = {}) {\n const results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const url of urls) {\n try {\n const page = this.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n await this.goTo(page, url);\n const filepath = await this.takeScreenshot(page, url, options);\n results.push({ url, success: true, filepath });\n } catch (error) {\n results.push({\n url,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n async takeResponsiveScreenshots(\n url: string,\n viewports: { width: number; height: number; name: string }[] = [\n { width: 1920, height: 1080, name: \"desktop\" },\n { width: 768, height: 1024, name: \"tablet\" },\n { width: 375, height: 667, name: \"mobile\" },\n ],\n options: {\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n\n const results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const viewport of viewports) {\n try {\n const page = await this.context?.newPage();\n await page.setViewportSize(viewport);\n\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n await page.waitForTimeout(2000);\n\n const filename = `${viewport.name}.png`;\n // Save to actual directory\n const filepath = this.getActualFilePath(filename);\n\n const responsiveScreenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\" as const,\n };\n\n await page.screenshot(responsiveScreenshotOptions);\n\n await page.close();\n\n console.log(`Responsive screenshot saved: ${filepath}`);\n results.push({ viewport: viewport.name, success: true, filepath });\n } catch (error) {\n console.error(\n `Error taking responsive screenshot for ${viewport.name}:`,\n (error as Error).message,\n );\n results.push({\n viewport: viewport.name,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n // Utility method to check if expected image exists\n hasExpectedImage(filename: string): boolean {\n const expectedPath = this.getExpectedFilePath(filename);\n return fs.existsSync(expectedPath);\n }\n\n // Utility method to get expected image as buffer (for future approval process)\n getExpectedImageBuffer(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\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;ACMT,MAAM,WACJ,QACA,QACA,MACA,OACA,QACA,YACG;AACH,QAAO,UAAU,QAAQ,QAAQ,MAAM,OAAO,QAAQ,QAAQ;;;;;;;;;;;AAYhE,eAAsB,cACpB,QACA,QACA,WAAoB,OACpB,SACwB;CAExB,MAAM,OAAO,MAAM,QAAQ,OAAO;CAClC,MAAM,OAAO,MAAM,QAAQ,OAAO;CAElC,MAAM,EAAE,OAAO,WAAW;CAG1B,MAAM,OAAO,WAAW,IAAI,IAAI;EAAE;EAAO;EAAQ,CAAC,GAAG;CAGrD,MAAM,gBAAgB,QACpB,KAAK,MACL,KAAK,MACL,MAAM,MACN,OACA,QACA,QACD;CAED,MAAM,cAAc,QAAQ;CAC5B,MAAM,oBAAqB,gBAAgB,cAAe;CAC1D,MAAM,SAAS,sBAAsB,QAAQ,qBAAqB;CAGlE,MAAM,aAAa,OAAO,IAAI,KAAK,MAAM,KAAK,GAAG;AAEjD,QAAO;EACL;EACA;EACA;EACA;EACA;EACD;;;;;AAMH,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;;;;;;AClEhC,MAAMA,oBAAgC;CACpC,WAAW;CACX,WAAW;CACX,iBAAiB;CACjB,eAAe;CACf,mBAAmB;CACpB;AAED,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB;CAEA,YAAY,SAOT;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,WAAW,QAAQ,aAAa;AACrC,OAAK,OAAO;GAAE,GAAG;GAAmB,GAAG,QAAQ;GAAM;AAErD,OAAK,YAAY,KAAK,KAAK,KAAK,WAAW,SAAS;AACpD,OAAK,UAAU,KAAK,KAAK,KAAK,WAAW,OAAO;AAChD,OAAK,cAAc,KAAK,KAAK,KAAK,WAAW,WAAW;;CAG1D,MAAM,OAAO;AAEX,OAAK,mBAAmB;EASxB,MAAM,eANa;GACjB;GACA;GACA;GACD,CAGY,KAAK;AAClB,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;AAE3D,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACnB,WAAW,GAAG,MAAM,iBAAiB;GACtC,CAAC;AAEF,OAAK,OAAO,MAAM,KAAK,SAAS,SAAS;AACzC,OAAK,MAAM,gBAAgB,KAAK,SAAS;;CAG3C,MAAM,QAAQ;AACZ,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;AAE5B,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;CAI9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;CAGzD,AAAQ,oBAAoB;EAE1B,MAAM,cAAc;GAClB,KAAK;GACL,KAAK;GACL,KAAK;GACL,KAAK;GACN;AAED,OAAK,MAAM,OAAO,YAChB,KAAI,CAAC,GAAG,WAAW,IAAI,EAAE;AACvB,MAAG,UAAU,KAAK,EAAE,WAAW,MAAM,CAAC;AACtC,WAAQ,IAAI,sBAAsB,MAAM;;;CAK9C,kBAAkB,UAA0B;AAC1C,SAAO,KAAK,KAAK,KAAK,WAAW,SAAS;;CAG5C,gBAAgB,UAA0B;AACxC,SAAO,KAAK,KAAK,KAAK,SAAS,SAAS;;CAG1C,oBAAoB,UAA0B;AAC5C,SAAO,KAAK,KAAK,KAAK,aAAa,SAAS;;CAI9C,YAAY,UAAkB;AAC5B,SAAO,KAAK,kBAAkB,SAAS;;CAGzC,MAAM,eACJ,MACA,UACA,UAII,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;GAEF,MAAM,WAAW,KAAK,kBAAkB,SAAS;GAGjD,MAAM,oBAAoB;IACxB,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACR;AAED,SAAM,KAAK,WAAW,kBAAkB;AAExC,WAAQ,IAAI,qBAAqB,WAAW;AAC5C,UAAO;WACA,OAAO;AACd,WAAQ,MACN,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,sBACJ,MACA,UACA,UAGI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,SAAM,KAAK,gBAAgB,UAAU,EAAE,SAAS,KAAO,CAAC;GAExD,MAAM,UAAU,MAAM,KAAK,EAAE,SAAS;AACtC,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,sBAAsB,WAAW;GAGnD,MAAM,WACH,QAAQ,YACT,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GAE5C,MAAM,WAAW,KAAK,kBAAkB,SAAS;GAEjD,MAAM,2BAA2B;IAC/B,MAAM;IACN,MAAM;IACP;AAED,SAAM,QAAQ,WAAW,yBAAyB;AAElD,WAAQ,IAAI,6BAA6B,WAAW;AACpD,UAAO;WACA,OAAO;AACd,WAAQ,MACN,sCAAsC,KAAK,KAAK,CAAC,IAChD,MAAgB,QAClB;AACD,SAAM;YACE;AACR,SAAM,KAAK,OAAO;;;CAItB,MAAM,6BACJ,MACA,UACA,gBACA,UASI,EAAE,EAKL;AACD,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;GAEF,MAAM,WAAW,KAAK,kBAAkB,SAAS;AACjD,MAAG,UAAU,KAAK,QAAQ,SAAS,EAAE,EAAE,WAAW,MAAM,CAAC;GAGzD,MAAM,oBAAoB;IACxB,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACR;GAGD,MAAM,mBAAmB,MAAM,KAAK,WAAW,kBAAkB;AAGjE,MAAG,cAAc,UAAU,iBAAiB;AAE5C,WAAQ,IAAI,qBAAqB,WAAW;GAG5C,MAAM,mBAAmB,MAAM,cAC7B,kBACA,gBACA,MACA;IAAE,GAAG,KAAK;IAAM,GAAG,QAAQ;IAAgB,CAC5C;AAED,WAAQ,IACN,sBAAsB,iBAAiB,cAAc,qBAAqB,iBAAiB,kBAAkB,QAAQ,EAAE,CAAC,MACtH,iBAAiB,SAAS,WAAW,SACtC,GACF;GAED,IAAIC;AAGJ,OACE,QAAQ,iBACR,iBAAiB,cACjB,CAAC,iBAAiB,QAClB;IACA,MAAM,eAAe,QAAQ,qBAAqB;AAElD,oBAAgB,KAAK,gBAAgB,aAAa;AAElD,OAAG,UAAU,KAAK,QAAQ,cAAc,EAAE,EAAE,WAAW,MAAM,CAAC;AAC9D,OAAG,cAAc,eAAe,iBAAiB,WAAW;;AAG9D,UAAO;IACL,gBAAgB;IAChB;IACA;IACD;WACM,OAAO;AACd,WAAQ,MACN,8CAA8C,KAAK,KAAK,CAAC,IACxD,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,iBAAiB,MAAgB,UAAU,EAAE,EAAE;EACnD,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,OAAO,KAChB,KAAI;GACF,MAAM,OAAO,KAAK;AAClB,OAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAEzC,SAAM,KAAK,KAAK,MAAM,IAAI;GAC1B,MAAM,WAAW,MAAM,KAAK,eAAe,MAAM,KAAK,QAAQ;AAC9D,WAAQ,KAAK;IAAE;IAAK,SAAS;IAAM;IAAU,CAAC;WACvC,OAAO;AACd,WAAQ,KAAK;IACX;IACA,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAGT,MAAM,0BACJ,KACA,YAA+D;EAC7D;GAAE,OAAO;GAAM,QAAQ;GAAM,MAAM;GAAW;EAC9C;GAAE,OAAO;GAAK,QAAQ;GAAM,MAAM;GAAU;EAC5C;GAAE,OAAO;GAAK,QAAQ;GAAK,MAAM;GAAU;EAC5C,EACD,UAEI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,YAAY,UACrB,KAAI;GACF,MAAM,OAAO,MAAM,KAAK,SAAS,SAAS;AAC1C,SAAM,KAAK,gBAAgB,SAAS;AAEpC,SAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;AACvD,SAAM,KAAK,eAAe,IAAK;GAE/B,MAAM,WAAW,GAAG,SAAS,KAAK;GAElC,MAAM,WAAW,KAAK,kBAAkB,SAAS;GAEjD,MAAM,8BAA8B;IAClC,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACP;AAED,SAAM,KAAK,WAAW,4BAA4B;AAElD,SAAM,KAAK,OAAO;AAElB,WAAQ,IAAI,gCAAgC,WAAW;AACvD,WAAQ,KAAK;IAAE,UAAU,SAAS;IAAM,SAAS;IAAM;IAAU,CAAC;WAC3D,OAAO;AACd,WAAQ,MACN,0CAA0C,SAAS,KAAK,IACvD,MAAgB,QAClB;AACD,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAIT,iBAAiB,UAA2B;EAC1C,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,SAAO,GAAG,WAAW,aAAa;;CAIpC,uBAAuB,UAA0B;EAC/C,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,MAAI,CAAC,GAAG,WAAW,aAAa,CAC9B,OAAM,IAAI,MAAM,6BAA6B,eAAe;AAE9D,SAAO,GAAG,aAAa,aAAa;;;AAIxC,yBAAe"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cappa/core",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Core Playwright screenshot functionality for Cappa",
|
|
5
5
|
"author": "tim-richter",
|
|
6
6
|
"license": "MIT",
|
|
@@ -18,10 +18,16 @@
|
|
|
18
18
|
"./package.json": "./package.json"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"
|
|
21
|
+
"@blazediff/core": "^1.1.0",
|
|
22
|
+
"@blazediff/types": "^1.1.0",
|
|
23
|
+
"pixelmatch": "^6.0.0",
|
|
24
|
+
"playwright-core": "^1.55.0",
|
|
25
|
+
"pngjs": "^7.0.0"
|
|
22
26
|
},
|
|
23
27
|
"devDependencies": {
|
|
24
28
|
"@types/node": "22.13.10",
|
|
29
|
+
"@types/pixelmatch": "^5.2.4",
|
|
30
|
+
"@types/pngjs": "^6.0.4",
|
|
25
31
|
"@vitest/coverage-v8": "3.2.4",
|
|
26
32
|
"@vitest/ui": "3.2.4",
|
|
27
33
|
"consola": "3.4.2",
|
|
@@ -36,7 +42,9 @@
|
|
|
36
42
|
],
|
|
37
43
|
"module": "./dist/index.mjs",
|
|
38
44
|
"scripts": {
|
|
39
|
-
"test": "
|
|
45
|
+
"test": "vitest",
|
|
46
|
+
"test:ui": "vitest --ui",
|
|
47
|
+
"test:coverage": "vitest --coverage",
|
|
40
48
|
"example:basic": "node examples/basic-usage.js",
|
|
41
49
|
"example:batch": "node examples/batch-screenshots.js",
|
|
42
50
|
"example:responsive": "node examples/responsive-screenshots.js",
|