@cappa/core 0.4.0 → 0.4.2
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 +12 -12
- package/CHANGELOG.md +16 -0
- package/dist/index.d.mts +29 -10
- package/dist/index.d.ts +29 -10
- package/dist/index.js +38 -22
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +37 -22
- package/dist/index.mjs.map +1 -1
- package/package.json +6 -4
- package/src/filesystem.ts +47 -22
- package/src/index.ts +8 -0
- package/src/types.ts +25 -6
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
1
|
|
|
2
|
-
> @cappa/core@0.4.
|
|
2
|
+
> @cappa/core@0.4.2 build /home/runner/work/cappa/cappa/packages/core
|
|
3
3
|
> tsdown
|
|
4
4
|
|
|
5
5
|
[34mℹ[39m tsdown [2mv0.15.12[22m powered by rolldown [2mv1.0.0-beta.45[22m
|
|
6
6
|
[34mℹ[39m Using tsdown config: [4m/home/runner/work/cappa/cappa/packages/core/tsdown.config.ts[24m
|
|
7
|
-
(node:
|
|
7
|
+
(node:2443) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/runner/work/cappa/cappa/packages/core/tsdown.config.ts is not specified and it doesn't parse as CommonJS.
|
|
8
8
|
Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
|
|
9
9
|
To eliminate this warning, add "type": "module" to /home/runner/work/cappa/cappa/packages/core/package.json.
|
|
10
10
|
(Use `node --trace-warnings ...` to show where the warning was created)
|
|
11
11
|
[34mℹ[39m entry: [34msrc/index.ts[39m
|
|
12
12
|
[34mℹ[39m tsconfig: [34mtsconfig.json[39m
|
|
13
13
|
[34mℹ[39m Build start
|
|
14
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[1mindex.js[22m [
|
|
15
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [
|
|
16
|
-
[34mℹ[39m [33m[CJS][39m 2 files, total:
|
|
17
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[1mindex.mjs[22m [
|
|
18
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22mindex.mjs.map [
|
|
19
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[32m[1mindex.d.mts[22m[39m [2m13.
|
|
20
|
-
[34mℹ[39m [34m[ESM][39m 3 files, total:
|
|
21
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[32m[1mindex.d.ts[22m[39m [2m13.
|
|
22
|
-
[34mℹ[39m [33m[CJS][39m 1 files, total: 13.
|
|
23
|
-
[32m✔[39m Build complete in [
|
|
14
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[1mindex.js[22m [2m26.47 kB[22m [2m│ gzip: 6.37 kB[22m
|
|
15
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [2m47.61 kB[22m [2m│ gzip: 11.17 kB[22m
|
|
16
|
+
[34mℹ[39m [33m[CJS][39m 2 files, total: 74.08 kB
|
|
17
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[1mindex.mjs[22m [2m24.41 kB[22m [2m│ gzip: 5.84 kB[22m
|
|
18
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22mindex.mjs.map [2m47.50 kB[22m [2m│ gzip: 11.13 kB[22m
|
|
19
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[32m[1mindex.d.mts[22m[39m [2m13.90 kB[22m [2m│ gzip: 3.89 kB[22m
|
|
20
|
+
[34mℹ[39m [34m[ESM][39m 3 files, total: 85.82 kB
|
|
21
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[32m[1mindex.d.ts[22m[39m [2m13.90 kB[22m [2m│ gzip: 3.89 kB[22m
|
|
22
|
+
[34mℹ[39m [33m[CJS][39m 1 files, total: 13.90 kB
|
|
23
|
+
[32m✔[39m Build complete in [32m2797ms[39m
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @cappa/core
|
|
2
2
|
|
|
3
|
+
## 0.4.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 1fad7cc: fix: deleted screenshot handling in approve command
|
|
8
|
+
- Updated dependencies [1fad7cc]
|
|
9
|
+
- @cappa/logger@0.0.7
|
|
10
|
+
|
|
11
|
+
## 0.4.1
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- 298486b: fix: package export types
|
|
16
|
+
- Updated dependencies [298486b]
|
|
17
|
+
- @cappa/logger@0.0.6
|
|
18
|
+
|
|
3
19
|
## 0.4.0
|
|
4
20
|
|
|
5
21
|
### Minor Changes
|
package/dist/index.d.mts
CHANGED
|
@@ -6,12 +6,15 @@ import { Browser, BrowserContext, Locator, Page } from "playwright-core";
|
|
|
6
6
|
* Class for interacting with the local file system to store the screenshots.
|
|
7
7
|
*/
|
|
8
8
|
declare class ScreenshotFileSystem {
|
|
9
|
-
private readonly
|
|
10
|
-
private readonly
|
|
11
|
-
private readonly
|
|
9
|
+
private readonly actual;
|
|
10
|
+
private readonly expected;
|
|
11
|
+
private readonly diff;
|
|
12
12
|
constructor(outputDir: string);
|
|
13
13
|
clearActual(): void;
|
|
14
14
|
clearDiff(): void;
|
|
15
|
+
getActualScreenshots(): Promise<string[]>;
|
|
16
|
+
getExpectedScreenshots(): Promise<string[]>;
|
|
17
|
+
getDiffScreenshots(): Promise<string[]>;
|
|
15
18
|
clearActualAndDiff(): void;
|
|
16
19
|
/**
|
|
17
20
|
* Approve a screenshot based on its actual file path.
|
|
@@ -95,6 +98,7 @@ declare class ScreenshotFileSystem {
|
|
|
95
98
|
* @returns The actual path of the screenshot file.
|
|
96
99
|
*/
|
|
97
100
|
private resolveActualPath;
|
|
101
|
+
getRelativePath(directory: "actual" | "expected" | "diff", filePath: string): string;
|
|
98
102
|
}
|
|
99
103
|
//#endregion
|
|
100
104
|
//#region src/screenshot.d.ts
|
|
@@ -380,15 +384,30 @@ type ScreenshotVariantWithUrl = {
|
|
|
380
384
|
type ScreenshotOptions = ScreenshotSettings & {
|
|
381
385
|
variants?: ScreenshotVariant[];
|
|
382
386
|
};
|
|
383
|
-
|
|
387
|
+
type NewScreenshot = {
|
|
388
|
+
actualPath: string;
|
|
389
|
+
category: "new";
|
|
390
|
+
};
|
|
391
|
+
type DeletedScreenshot = {
|
|
392
|
+
category: "deleted";
|
|
393
|
+
expectedPath: string;
|
|
394
|
+
};
|
|
395
|
+
type ChangedScreenshot = {
|
|
396
|
+
category: "changed";
|
|
397
|
+
diffPath: string;
|
|
398
|
+
actualPath: string;
|
|
399
|
+
expectedPath: string;
|
|
400
|
+
};
|
|
401
|
+
type PassedScreenshot = {
|
|
402
|
+
category: "passed";
|
|
403
|
+
actualPath: string;
|
|
404
|
+
expectedPath: string;
|
|
405
|
+
};
|
|
406
|
+
type Screenshot = {
|
|
384
407
|
id: string;
|
|
385
408
|
name: string;
|
|
386
|
-
category: "new" | "deleted" | "changed" | "passed";
|
|
387
|
-
actualPath?: string;
|
|
388
|
-
expectedPath?: string;
|
|
389
|
-
diffPath?: string;
|
|
390
409
|
approved?: boolean;
|
|
391
|
-
}
|
|
410
|
+
} & (NewScreenshot | DeletedScreenshot | ChangedScreenshot | PassedScreenshot);
|
|
392
411
|
type FailedScreenshot = Screenshot & {
|
|
393
412
|
/**
|
|
394
413
|
* Absolute path to the actual screenshot on disk.
|
|
@@ -438,5 +457,5 @@ declare function imagesMatch(image1: string | Buffer, image2: string | Buffer, o
|
|
|
438
457
|
*/
|
|
439
458
|
declare function defineConfig(options: PossiblePromise<UserConfig> | ((env: ConfigEnv) => PossiblePromise<UserConfig>)): typeof options;
|
|
440
459
|
//#endregion
|
|
441
|
-
export { type ConfigEnv, type FailedScreenshot, type Plugin, type PluginDef, type PluginFunction, type Screenshot, type ScreenshotCaptureDetails, type ScreenshotCaptureExtras, type ScreenshotCaptureResult, ScreenshotFileSystem, type ScreenshotOptions, type ScreenshotSettings, ScreenshotTool, type ScreenshotVariant, type ScreenshotVariantCaptureDetails, type ScreenshotVariantWithUrl, type UserConfig, type Viewport, compareImages, defineConfig, imagesMatch };
|
|
460
|
+
export { type ChangedScreenshot, type ConfigEnv, type DeletedScreenshot, type FailedScreenshot, type NewScreenshot, type PassedScreenshot, type Plugin, type PluginDef, type PluginFunction, type Screenshot, type ScreenshotCaptureDetails, type ScreenshotCaptureExtras, type ScreenshotCaptureResult, ScreenshotFileSystem, type ScreenshotOptions, type ScreenshotSettings, ScreenshotTool, type ScreenshotVariant, type ScreenshotVariantCaptureDetails, type ScreenshotVariantWithUrl, type UserConfig, type Viewport, compareImages, defineConfig, imagesMatch };
|
|
442
461
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.ts
CHANGED
|
@@ -6,12 +6,15 @@ import { Logger } from "@cappa/logger";
|
|
|
6
6
|
* Class for interacting with the local file system to store the screenshots.
|
|
7
7
|
*/
|
|
8
8
|
declare class ScreenshotFileSystem {
|
|
9
|
-
private readonly
|
|
10
|
-
private readonly
|
|
11
|
-
private readonly
|
|
9
|
+
private readonly actual;
|
|
10
|
+
private readonly expected;
|
|
11
|
+
private readonly diff;
|
|
12
12
|
constructor(outputDir: string);
|
|
13
13
|
clearActual(): void;
|
|
14
14
|
clearDiff(): void;
|
|
15
|
+
getActualScreenshots(): Promise<string[]>;
|
|
16
|
+
getExpectedScreenshots(): Promise<string[]>;
|
|
17
|
+
getDiffScreenshots(): Promise<string[]>;
|
|
15
18
|
clearActualAndDiff(): void;
|
|
16
19
|
/**
|
|
17
20
|
* Approve a screenshot based on its actual file path.
|
|
@@ -95,6 +98,7 @@ declare class ScreenshotFileSystem {
|
|
|
95
98
|
* @returns The actual path of the screenshot file.
|
|
96
99
|
*/
|
|
97
100
|
private resolveActualPath;
|
|
101
|
+
getRelativePath(directory: "actual" | "expected" | "diff", filePath: string): string;
|
|
98
102
|
}
|
|
99
103
|
//#endregion
|
|
100
104
|
//#region src/screenshot.d.ts
|
|
@@ -380,15 +384,30 @@ type ScreenshotVariantWithUrl = {
|
|
|
380
384
|
type ScreenshotOptions = ScreenshotSettings & {
|
|
381
385
|
variants?: ScreenshotVariant[];
|
|
382
386
|
};
|
|
383
|
-
|
|
387
|
+
type NewScreenshot = {
|
|
388
|
+
actualPath: string;
|
|
389
|
+
category: "new";
|
|
390
|
+
};
|
|
391
|
+
type DeletedScreenshot = {
|
|
392
|
+
category: "deleted";
|
|
393
|
+
expectedPath: string;
|
|
394
|
+
};
|
|
395
|
+
type ChangedScreenshot = {
|
|
396
|
+
category: "changed";
|
|
397
|
+
diffPath: string;
|
|
398
|
+
actualPath: string;
|
|
399
|
+
expectedPath: string;
|
|
400
|
+
};
|
|
401
|
+
type PassedScreenshot = {
|
|
402
|
+
category: "passed";
|
|
403
|
+
actualPath: string;
|
|
404
|
+
expectedPath: string;
|
|
405
|
+
};
|
|
406
|
+
type Screenshot = {
|
|
384
407
|
id: string;
|
|
385
408
|
name: string;
|
|
386
|
-
category: "new" | "deleted" | "changed" | "passed";
|
|
387
|
-
actualPath?: string;
|
|
388
|
-
expectedPath?: string;
|
|
389
|
-
diffPath?: string;
|
|
390
409
|
approved?: boolean;
|
|
391
|
-
}
|
|
410
|
+
} & (NewScreenshot | DeletedScreenshot | ChangedScreenshot | PassedScreenshot);
|
|
392
411
|
type FailedScreenshot = Screenshot & {
|
|
393
412
|
/**
|
|
394
413
|
* Absolute path to the actual screenshot on disk.
|
|
@@ -438,5 +457,5 @@ declare function imagesMatch(image1: string | Buffer, image2: string | Buffer, o
|
|
|
438
457
|
*/
|
|
439
458
|
declare function defineConfig(options: PossiblePromise<UserConfig> | ((env: ConfigEnv) => PossiblePromise<UserConfig>)): typeof options;
|
|
440
459
|
//#endregion
|
|
441
|
-
export { type ConfigEnv, type FailedScreenshot, type Plugin, type PluginDef, type PluginFunction, type Screenshot, type ScreenshotCaptureDetails, type ScreenshotCaptureExtras, type ScreenshotCaptureResult, ScreenshotFileSystem, type ScreenshotOptions, type ScreenshotSettings, ScreenshotTool, type ScreenshotVariant, type ScreenshotVariantCaptureDetails, type ScreenshotVariantWithUrl, type UserConfig, type Viewport, compareImages, defineConfig, imagesMatch };
|
|
460
|
+
export { type ChangedScreenshot, type ConfigEnv, type DeletedScreenshot, type FailedScreenshot, type NewScreenshot, type PassedScreenshot, type Plugin, type PluginDef, type PluginFunction, type Screenshot, type ScreenshotCaptureDetails, type ScreenshotCaptureExtras, type ScreenshotCaptureResult, ScreenshotFileSystem, type ScreenshotOptions, type ScreenshotSettings, ScreenshotTool, type ScreenshotVariant, type ScreenshotVariantCaptureDetails, type ScreenshotVariantWithUrl, type UserConfig, type Viewport, compareImages, defineConfig, imagesMatch };
|
|
442
461
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -29,6 +29,8 @@ let __cappa_logger = require("@cappa/logger");
|
|
|
29
29
|
__cappa_logger = __toESM(__cappa_logger);
|
|
30
30
|
let pngjs = require("pngjs");
|
|
31
31
|
pngjs = __toESM(pngjs);
|
|
32
|
+
let node_fs_promises = require("node:fs/promises");
|
|
33
|
+
node_fs_promises = __toESM(node_fs_promises);
|
|
32
34
|
let node_path = require("node:path");
|
|
33
35
|
node_path = __toESM(node_path);
|
|
34
36
|
let playwright_core = require("playwright-core");
|
|
@@ -152,22 +154,31 @@ function defineConfig(options) {
|
|
|
152
154
|
* Class for interacting with the local file system to store the screenshots.
|
|
153
155
|
*/
|
|
154
156
|
var ScreenshotFileSystem = class {
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
157
|
+
actual;
|
|
158
|
+
expected;
|
|
159
|
+
diff;
|
|
158
160
|
constructor(outputDir) {
|
|
159
|
-
this.
|
|
160
|
-
this.
|
|
161
|
-
this.
|
|
162
|
-
this.ensureParentDir(this.
|
|
163
|
-
this.ensureParentDir(this.
|
|
164
|
-
this.ensureParentDir(this.
|
|
161
|
+
this.actual = node_path.default.resolve(outputDir, "actual");
|
|
162
|
+
this.expected = node_path.default.resolve(outputDir, "expected");
|
|
163
|
+
this.diff = node_path.default.resolve(outputDir, "diff");
|
|
164
|
+
this.ensureParentDir(this.actual);
|
|
165
|
+
this.ensureParentDir(this.expected);
|
|
166
|
+
this.ensureParentDir(this.diff);
|
|
165
167
|
}
|
|
166
168
|
clearActual() {
|
|
167
|
-
this.removeDir(this.
|
|
169
|
+
this.removeDir(this.actual);
|
|
168
170
|
}
|
|
169
171
|
clearDiff() {
|
|
170
|
-
this.removeDir(this.
|
|
172
|
+
this.removeDir(this.diff);
|
|
173
|
+
}
|
|
174
|
+
getActualScreenshots() {
|
|
175
|
+
return Array.fromAsync((0, node_fs_promises.glob)(node_path.default.resolve(this.actual, "**/*.png")));
|
|
176
|
+
}
|
|
177
|
+
getExpectedScreenshots() {
|
|
178
|
+
return Array.fromAsync((0, node_fs_promises.glob)(node_path.default.resolve(this.expected, "**/*.png")));
|
|
179
|
+
}
|
|
180
|
+
getDiffScreenshots() {
|
|
181
|
+
return Array.fromAsync((0, node_fs_promises.glob)(node_path.default.resolve(this.diff, "**/*.png")));
|
|
171
182
|
}
|
|
172
183
|
clearActualAndDiff() {
|
|
173
184
|
this.clearActual();
|
|
@@ -180,7 +191,7 @@ var ScreenshotFileSystem = class {
|
|
|
180
191
|
*/
|
|
181
192
|
approveFromActualPath(actualFilePath) {
|
|
182
193
|
const actualAbsolute = this.resolveActualPath(actualFilePath);
|
|
183
|
-
const relativePath = node_path.default.relative(this.
|
|
194
|
+
const relativePath = node_path.default.relative(this.actual, actualAbsolute);
|
|
184
195
|
if (relativePath.startsWith("..")) throw new Error(`Cannot approve screenshot outside of actual directory: ${actualFilePath}`);
|
|
185
196
|
return this.approveRelative(relativePath);
|
|
186
197
|
}
|
|
@@ -199,9 +210,9 @@ var ScreenshotFileSystem = class {
|
|
|
199
210
|
* @returns The paths to the actual, expected, and diff screenshot files.
|
|
200
211
|
*/
|
|
201
212
|
approveRelative(relativePath) {
|
|
202
|
-
const actualPath = node_path.default.resolve(this.
|
|
203
|
-
const expectedPath = node_path.default.resolve(this.
|
|
204
|
-
const diffPath = node_path.default.resolve(this.
|
|
213
|
+
const actualPath = node_path.default.resolve(this.actual, relativePath);
|
|
214
|
+
const expectedPath = node_path.default.resolve(this.expected, relativePath);
|
|
215
|
+
const diffPath = node_path.default.resolve(this.diff, relativePath);
|
|
205
216
|
this.ensureParentDir(expectedPath);
|
|
206
217
|
node_fs.default.copyFileSync(actualPath, expectedPath);
|
|
207
218
|
if (node_fs.default.existsSync(diffPath)) node_fs.default.unlinkSync(diffPath);
|
|
@@ -233,37 +244,37 @@ var ScreenshotFileSystem = class {
|
|
|
233
244
|
* Get the actual directory path
|
|
234
245
|
*/
|
|
235
246
|
getActualDir() {
|
|
236
|
-
return this.
|
|
247
|
+
return this.actual;
|
|
237
248
|
}
|
|
238
249
|
/**
|
|
239
250
|
* Get the expected directory path
|
|
240
251
|
*/
|
|
241
252
|
getExpectedDir() {
|
|
242
|
-
return this.
|
|
253
|
+
return this.expected;
|
|
243
254
|
}
|
|
244
255
|
/**
|
|
245
256
|
* Get the diff directory path
|
|
246
257
|
*/
|
|
247
258
|
getDiffDir() {
|
|
248
|
-
return this.
|
|
259
|
+
return this.diff;
|
|
249
260
|
}
|
|
250
261
|
/**
|
|
251
262
|
* Get the path to an actual screenshot file
|
|
252
263
|
*/
|
|
253
264
|
getActualFilePath(filename) {
|
|
254
|
-
return node_path.default.resolve(this.
|
|
265
|
+
return node_path.default.resolve(this.actual, filename);
|
|
255
266
|
}
|
|
256
267
|
/**
|
|
257
268
|
* Get the path to an expected screenshot file
|
|
258
269
|
*/
|
|
259
270
|
getExpectedFilePath(filename) {
|
|
260
|
-
return node_path.default.resolve(this.
|
|
271
|
+
return node_path.default.resolve(this.expected, filename);
|
|
261
272
|
}
|
|
262
273
|
/**
|
|
263
274
|
* Get the path to a diff screenshot file
|
|
264
275
|
*/
|
|
265
276
|
getDiffFilePath(filename) {
|
|
266
|
-
return node_path.default.resolve(this.
|
|
277
|
+
return node_path.default.resolve(this.diff, filename);
|
|
267
278
|
}
|
|
268
279
|
/**
|
|
269
280
|
* Write a file to the actual directory
|
|
@@ -303,7 +314,12 @@ var ScreenshotFileSystem = class {
|
|
|
303
314
|
*/
|
|
304
315
|
resolveActualPath(filePath) {
|
|
305
316
|
if (node_path.default.isAbsolute(filePath)) return filePath;
|
|
306
|
-
return node_path.default.resolve(this.
|
|
317
|
+
return node_path.default.resolve(this.actual, filePath);
|
|
318
|
+
}
|
|
319
|
+
getRelativePath(directory, filePath) {
|
|
320
|
+
const relativePath = node_path.default.relative(this[directory], filePath);
|
|
321
|
+
if (relativePath.startsWith("..")) throw new Error(`Cannot resolve relative path outside of ${directory} directory: ${filePath}`);
|
|
322
|
+
return relativePath;
|
|
307
323
|
}
|
|
308
324
|
};
|
|
309
325
|
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["PNG","fs","path","fs","defaultDiffConfig: DiffConfig","screenshotSettings: ScreenshotSettings","diffImagePath: string | undefined","path","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 logConsoleEvents: boolean;\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 logConsoleEvents?: 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.diff = { ...defaultDiffConfig, ...options.diff };\n this.concurrency = Math.max(1, options.concurrency || 1);\n this.logConsoleEvents = options.logConsoleEvents ?? true;\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,sCAAiB,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,IAAIA,UAAI;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,OAAOA,UAAI,KAAK,MAAM,KAAK,GAAG;GAO/C,QAAQ,SAAS,mBAAmB,eAAe,QAAQ;GAC3D,gBAAgB;GACjB;UACM,OAAO;AACd,iCAAW,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,QAAOA,UAAI,KAAK,KAAK,OAAO;MACvB;EACL,MAAM,SAASC,gBAAG,aAAa,OAAO;AACtC,SAAOD,UAAI,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,IAAIA,UAAI;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,QAAOA,UAAI,KAAK,MAAM,IAAI;;;;;;;;ACxL5B,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;;;;ACJT,IAAa,uBAAb,MAAkC;CAChC,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CAEjB,YAAY,WAAmB;AAC7B,OAAK,YAAYE,kBAAK,QAAQ,WAAW,SAAS;AAClD,OAAK,cAAcA,kBAAK,QAAQ,WAAW,WAAW;AACtD,OAAK,UAAUA,kBAAK,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,eAAeA,kBAAK,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,aAAaA,kBAAK,QAAQ,KAAK,WAAW,aAAa;EAC7D,MAAM,eAAeA,kBAAK,QAAQ,KAAK,aAAa,aAAa;EACjE,MAAM,WAAWA,kBAAK,QAAQ,KAAK,SAAS,aAAa;AAEzD,OAAK,gBAAgB,aAAa;AAElC,kBAAG,aAAa,YAAY,aAAa;AAEzC,MAAIC,gBAAG,WAAW,SAAS,CACzB,iBAAG,WAAW,SAAS;AAGzB,SAAO;GACL;GACA;GACA;GACD;;;;;;CAOH,gBAAgB,UAAkB;EAChC,MAAM,MAAMD,kBAAK,QAAQ,SAAS;AAElC,MAAI,CAACC,gBAAG,WAAW,IAAI,CACrB,iBAAG,UAAU,KAAK,EAAE,WAAW,MAAM,CAAC;;;;;;CAQ1C,AAAQ,UAAU,KAAa;AAC7B,MAAIA,gBAAG,WAAW,IAAI,CACpB,iBAAG,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,SAAOD,kBAAK,QAAQ,KAAK,WAAW,SAAS;;;;;CAM/C,oBAAoB,UAA0B;AAC5C,SAAOA,kBAAK,QAAQ,KAAK,aAAa,SAAS;;;;;CAMjD,gBAAgB,UAA0B;AACxC,SAAOA,kBAAK,QAAQ,KAAK,SAAS,SAAS;;;;;CAM7C,gBAAgB,UAAkB,MAAoB;EACpD,MAAM,WAAW,KAAK,kBAAkB,SAAS;AACjD,OAAK,gBAAgB,SAAS;AAC9B,kBAAG,cAAc,UAAU,KAAK;;;;;CAMlC,cAAc,UAAkB,MAAoB;EAClD,MAAM,WAAW,KAAK,gBAAgB,SAAS;AAC/C,OAAK,gBAAgB,SAAS;AAC9B,kBAAG,cAAc,UAAU,KAAK;;;;;CAMlC,gBAAgB,UAA2B;EACzC,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,SAAOC,gBAAG,WAAW,aAAa;;;;;CAMpC,iBAAiB,UAA0B;EACzC,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,MAAI,CAACA,gBAAG,WAAW,aAAa,CAC9B,OAAM,IAAI,MAAM,6BAA6B,eAAe;AAE9D,SAAOA,gBAAG,aAAa,aAAa;;;;;;;CAQtC,AAAQ,kBAAkB,UAAkB;AAC1C,MAAID,kBAAK,WAAW,SAAS,CAC3B,QAAO;AAGT,SAAOA,kBAAK,QAAQ,KAAK,WAAW,SAAS;;;;;;AC9KjD,MAAME,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;CACA;CAEA,YAAY,SAST;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;AACxD,OAAK,mBAAmB,QAAQ,oBAAoB;AAEpD,OAAK,wCAAoB;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,SAASC,kBAAK,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,MAAMA,kBAAK,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,iCAAW,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,kCAAW,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.js","names":["PNG","fs","path","fs","defaultDiffConfig: DiffConfig","screenshotSettings: ScreenshotSettings","diffImagePath: string | undefined","path","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 { glob } from \"node:fs/promises\";\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 actual: string;\n private readonly expected: string;\n private readonly diff: string;\n\n constructor(outputDir: string) {\n this.actual = path.resolve(outputDir, \"actual\");\n this.expected = path.resolve(outputDir, \"expected\");\n this.diff = path.resolve(outputDir, \"diff\");\n\n this.ensureParentDir(this.actual);\n this.ensureParentDir(this.expected);\n this.ensureParentDir(this.diff);\n }\n\n clearActual() {\n this.removeDir(this.actual);\n }\n\n clearDiff() {\n this.removeDir(this.diff);\n }\n\n getActualScreenshots(): Promise<string[]> {\n return Array.fromAsync(glob(path.resolve(this.actual, \"**/*.png\")));\n }\n\n getExpectedScreenshots(): Promise<string[]> {\n return Array.fromAsync(glob(path.resolve(this.expected, \"**/*.png\")));\n }\n\n getDiffScreenshots(): Promise<string[]> {\n return Array.fromAsync(glob(path.resolve(this.diff, \"**/*.png\")));\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.actual, 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.actual, relativePath);\n const expectedPath = path.resolve(this.expected, relativePath);\n const diffPath = path.resolve(this.diff, 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.actual;\n }\n\n /**\n * Get the expected directory path\n */\n getExpectedDir(): string {\n return this.expected;\n }\n\n /**\n * Get the diff directory path\n */\n getDiffDir(): string {\n return this.diff;\n }\n\n /**\n * Get the path to an actual screenshot file\n */\n getActualFilePath(filename: string): string {\n return path.resolve(this.actual, filename);\n }\n\n /**\n * Get the path to an expected screenshot file\n */\n getExpectedFilePath(filename: string): string {\n return path.resolve(this.expected, filename);\n }\n\n /**\n * Get the path to a diff screenshot file\n */\n getDiffFilePath(filename: string): string {\n return path.resolve(this.diff, 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.actual, filePath);\n }\n\n getRelativePath(directory: \"actual\" | \"expected\" | \"diff\", filePath: string) {\n const relativePath = path.relative(this[directory], filePath);\n\n if (relativePath.startsWith(\"..\")) {\n throw new Error(\n `Cannot resolve relative path outside of ${directory} directory: ${filePath}`,\n );\n }\n\n return relativePath;\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 logConsoleEvents: boolean;\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 logConsoleEvents?: 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.diff = { ...defaultDiffConfig, ...options.diff };\n this.concurrency = Math.max(1, options.concurrency || 1);\n this.logConsoleEvents = options.logConsoleEvents ?? true;\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,sCAAiB,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,IAAIA,UAAI;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,OAAOA,UAAI,KAAK,MAAM,KAAK,GAAG;GAO/C,QAAQ,SAAS,mBAAmB,eAAe,QAAQ;GAC3D,gBAAgB;GACjB;UACM,OAAO;AACd,iCAAW,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,QAAOA,UAAI,KAAK,KAAK,OAAO;MACvB;EACL,MAAM,SAASC,gBAAG,aAAa,OAAO;AACtC,SAAOD,UAAI,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,IAAIA,UAAI;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,QAAOA,UAAI,KAAK,MAAM,IAAI;;;;;;;;ACxL5B,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;;;;ACHT,IAAa,uBAAb,MAAkC;CAChC,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CAEjB,YAAY,WAAmB;AAC7B,OAAK,SAASE,kBAAK,QAAQ,WAAW,SAAS;AAC/C,OAAK,WAAWA,kBAAK,QAAQ,WAAW,WAAW;AACnD,OAAK,OAAOA,kBAAK,QAAQ,WAAW,OAAO;AAE3C,OAAK,gBAAgB,KAAK,OAAO;AACjC,OAAK,gBAAgB,KAAK,SAAS;AACnC,OAAK,gBAAgB,KAAK,KAAK;;CAGjC,cAAc;AACZ,OAAK,UAAU,KAAK,OAAO;;CAG7B,YAAY;AACV,OAAK,UAAU,KAAK,KAAK;;CAG3B,uBAA0C;AACxC,SAAO,MAAM,qCAAeA,kBAAK,QAAQ,KAAK,QAAQ,WAAW,CAAC,CAAC;;CAGrE,yBAA4C;AAC1C,SAAO,MAAM,qCAAeA,kBAAK,QAAQ,KAAK,UAAU,WAAW,CAAC,CAAC;;CAGvE,qBAAwC;AACtC,SAAO,MAAM,qCAAeA,kBAAK,QAAQ,KAAK,MAAM,WAAW,CAAC,CAAC;;CAGnE,qBAAqB;AACnB,OAAK,aAAa;AAClB,OAAK,WAAW;;;;;;;CAQlB,sBAAsB,gBAAwB;EAC5C,MAAM,iBAAiB,KAAK,kBAAkB,eAAe;EAC7D,MAAM,eAAeA,kBAAK,SAAS,KAAK,QAAQ,eAAe;AAE/D,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,aAAaA,kBAAK,QAAQ,KAAK,QAAQ,aAAa;EAC1D,MAAM,eAAeA,kBAAK,QAAQ,KAAK,UAAU,aAAa;EAC9D,MAAM,WAAWA,kBAAK,QAAQ,KAAK,MAAM,aAAa;AAEtD,OAAK,gBAAgB,aAAa;AAElC,kBAAG,aAAa,YAAY,aAAa;AAEzC,MAAIC,gBAAG,WAAW,SAAS,CACzB,iBAAG,WAAW,SAAS;AAGzB,SAAO;GACL;GACA;GACA;GACD;;;;;;CAOH,gBAAgB,UAAkB;EAChC,MAAM,MAAMD,kBAAK,QAAQ,SAAS;AAElC,MAAI,CAACC,gBAAG,WAAW,IAAI,CACrB,iBAAG,UAAU,KAAK,EAAE,WAAW,MAAM,CAAC;;;;;;CAQ1C,AAAQ,UAAU,KAAa;AAC7B,MAAIA,gBAAG,WAAW,IAAI,CACpB,iBAAG,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,SAAOD,kBAAK,QAAQ,KAAK,QAAQ,SAAS;;;;;CAM5C,oBAAoB,UAA0B;AAC5C,SAAOA,kBAAK,QAAQ,KAAK,UAAU,SAAS;;;;;CAM9C,gBAAgB,UAA0B;AACxC,SAAOA,kBAAK,QAAQ,KAAK,MAAM,SAAS;;;;;CAM1C,gBAAgB,UAAkB,MAAoB;EACpD,MAAM,WAAW,KAAK,kBAAkB,SAAS;AACjD,OAAK,gBAAgB,SAAS;AAC9B,kBAAG,cAAc,UAAU,KAAK;;;;;CAMlC,cAAc,UAAkB,MAAoB;EAClD,MAAM,WAAW,KAAK,gBAAgB,SAAS;AAC/C,OAAK,gBAAgB,SAAS;AAC9B,kBAAG,cAAc,UAAU,KAAK;;;;;CAMlC,gBAAgB,UAA2B;EACzC,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,SAAOC,gBAAG,WAAW,aAAa;;;;;CAMpC,iBAAiB,UAA0B;EACzC,MAAM,eAAe,KAAK,oBAAoB,SAAS;AACvD,MAAI,CAACA,gBAAG,WAAW,aAAa,CAC9B,OAAM,IAAI,MAAM,6BAA6B,eAAe;AAE9D,SAAOA,gBAAG,aAAa,aAAa;;;;;;;CAQtC,AAAQ,kBAAkB,UAAkB;AAC1C,MAAID,kBAAK,WAAW,SAAS,CAC3B,QAAO;AAGT,SAAOA,kBAAK,QAAQ,KAAK,QAAQ,SAAS;;CAG5C,gBAAgB,WAA2C,UAAkB;EAC3E,MAAM,eAAeA,kBAAK,SAAS,KAAK,YAAY,SAAS;AAE7D,MAAI,aAAa,WAAW,KAAK,CAC/B,OAAM,IAAI,MACR,2CAA2C,UAAU,cAAc,WACpE;AAGH,SAAO;;;;;;ACvMX,MAAME,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;CACA;CAEA,YAAY,SAST;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;AACxD,OAAK,mBAAmB,QAAQ,oBAAoB;AAEpD,OAAK,wCAAoB;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,SAASC,kBAAK,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,MAAMA,kBAAK,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,iCAAW,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,kCAAW,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/dist/index.mjs
CHANGED
|
@@ -2,6 +2,7 @@ import fs from "node:fs";
|
|
|
2
2
|
import blazediff from "@blazediff/core";
|
|
3
3
|
import { getLogger } from "@cappa/logger";
|
|
4
4
|
import { PNG } from "pngjs";
|
|
5
|
+
import { glob } from "node:fs/promises";
|
|
5
6
|
import path from "node:path";
|
|
6
7
|
import { chromium, firefox, webkit } from "playwright-core";
|
|
7
8
|
|
|
@@ -123,22 +124,31 @@ function defineConfig(options) {
|
|
|
123
124
|
* Class for interacting with the local file system to store the screenshots.
|
|
124
125
|
*/
|
|
125
126
|
var ScreenshotFileSystem = class {
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
127
|
+
actual;
|
|
128
|
+
expected;
|
|
129
|
+
diff;
|
|
129
130
|
constructor(outputDir) {
|
|
130
|
-
this.
|
|
131
|
-
this.
|
|
132
|
-
this.
|
|
133
|
-
this.ensureParentDir(this.
|
|
134
|
-
this.ensureParentDir(this.
|
|
135
|
-
this.ensureParentDir(this.
|
|
131
|
+
this.actual = path.resolve(outputDir, "actual");
|
|
132
|
+
this.expected = path.resolve(outputDir, "expected");
|
|
133
|
+
this.diff = path.resolve(outputDir, "diff");
|
|
134
|
+
this.ensureParentDir(this.actual);
|
|
135
|
+
this.ensureParentDir(this.expected);
|
|
136
|
+
this.ensureParentDir(this.diff);
|
|
136
137
|
}
|
|
137
138
|
clearActual() {
|
|
138
|
-
this.removeDir(this.
|
|
139
|
+
this.removeDir(this.actual);
|
|
139
140
|
}
|
|
140
141
|
clearDiff() {
|
|
141
|
-
this.removeDir(this.
|
|
142
|
+
this.removeDir(this.diff);
|
|
143
|
+
}
|
|
144
|
+
getActualScreenshots() {
|
|
145
|
+
return Array.fromAsync(glob(path.resolve(this.actual, "**/*.png")));
|
|
146
|
+
}
|
|
147
|
+
getExpectedScreenshots() {
|
|
148
|
+
return Array.fromAsync(glob(path.resolve(this.expected, "**/*.png")));
|
|
149
|
+
}
|
|
150
|
+
getDiffScreenshots() {
|
|
151
|
+
return Array.fromAsync(glob(path.resolve(this.diff, "**/*.png")));
|
|
142
152
|
}
|
|
143
153
|
clearActualAndDiff() {
|
|
144
154
|
this.clearActual();
|
|
@@ -151,7 +161,7 @@ var ScreenshotFileSystem = class {
|
|
|
151
161
|
*/
|
|
152
162
|
approveFromActualPath(actualFilePath) {
|
|
153
163
|
const actualAbsolute = this.resolveActualPath(actualFilePath);
|
|
154
|
-
const relativePath = path.relative(this.
|
|
164
|
+
const relativePath = path.relative(this.actual, actualAbsolute);
|
|
155
165
|
if (relativePath.startsWith("..")) throw new Error(`Cannot approve screenshot outside of actual directory: ${actualFilePath}`);
|
|
156
166
|
return this.approveRelative(relativePath);
|
|
157
167
|
}
|
|
@@ -170,9 +180,9 @@ var ScreenshotFileSystem = class {
|
|
|
170
180
|
* @returns The paths to the actual, expected, and diff screenshot files.
|
|
171
181
|
*/
|
|
172
182
|
approveRelative(relativePath) {
|
|
173
|
-
const actualPath = path.resolve(this.
|
|
174
|
-
const expectedPath = path.resolve(this.
|
|
175
|
-
const diffPath = path.resolve(this.
|
|
183
|
+
const actualPath = path.resolve(this.actual, relativePath);
|
|
184
|
+
const expectedPath = path.resolve(this.expected, relativePath);
|
|
185
|
+
const diffPath = path.resolve(this.diff, relativePath);
|
|
176
186
|
this.ensureParentDir(expectedPath);
|
|
177
187
|
fs.copyFileSync(actualPath, expectedPath);
|
|
178
188
|
if (fs.existsSync(diffPath)) fs.unlinkSync(diffPath);
|
|
@@ -204,37 +214,37 @@ var ScreenshotFileSystem = class {
|
|
|
204
214
|
* Get the actual directory path
|
|
205
215
|
*/
|
|
206
216
|
getActualDir() {
|
|
207
|
-
return this.
|
|
217
|
+
return this.actual;
|
|
208
218
|
}
|
|
209
219
|
/**
|
|
210
220
|
* Get the expected directory path
|
|
211
221
|
*/
|
|
212
222
|
getExpectedDir() {
|
|
213
|
-
return this.
|
|
223
|
+
return this.expected;
|
|
214
224
|
}
|
|
215
225
|
/**
|
|
216
226
|
* Get the diff directory path
|
|
217
227
|
*/
|
|
218
228
|
getDiffDir() {
|
|
219
|
-
return this.
|
|
229
|
+
return this.diff;
|
|
220
230
|
}
|
|
221
231
|
/**
|
|
222
232
|
* Get the path to an actual screenshot file
|
|
223
233
|
*/
|
|
224
234
|
getActualFilePath(filename) {
|
|
225
|
-
return path.resolve(this.
|
|
235
|
+
return path.resolve(this.actual, filename);
|
|
226
236
|
}
|
|
227
237
|
/**
|
|
228
238
|
* Get the path to an expected screenshot file
|
|
229
239
|
*/
|
|
230
240
|
getExpectedFilePath(filename) {
|
|
231
|
-
return path.resolve(this.
|
|
241
|
+
return path.resolve(this.expected, filename);
|
|
232
242
|
}
|
|
233
243
|
/**
|
|
234
244
|
* Get the path to a diff screenshot file
|
|
235
245
|
*/
|
|
236
246
|
getDiffFilePath(filename) {
|
|
237
|
-
return path.resolve(this.
|
|
247
|
+
return path.resolve(this.diff, filename);
|
|
238
248
|
}
|
|
239
249
|
/**
|
|
240
250
|
* Write a file to the actual directory
|
|
@@ -274,7 +284,12 @@ var ScreenshotFileSystem = class {
|
|
|
274
284
|
*/
|
|
275
285
|
resolveActualPath(filePath) {
|
|
276
286
|
if (path.isAbsolute(filePath)) return filePath;
|
|
277
|
-
return path.resolve(this.
|
|
287
|
+
return path.resolve(this.actual, filePath);
|
|
288
|
+
}
|
|
289
|
+
getRelativePath(directory, filePath) {
|
|
290
|
+
const relativePath = path.relative(this[directory], filePath);
|
|
291
|
+
if (relativePath.startsWith("..")) throw new Error(`Cannot resolve relative path outside of ${directory} directory: ${filePath}`);
|
|
292
|
+
return relativePath;
|
|
278
293
|
}
|
|
279
294
|
};
|
|
280
295
|
|
package/dist/index.mjs.map
CHANGED
|
@@ -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/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 logConsoleEvents: boolean;\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 logConsoleEvents?: 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.diff = { ...defaultDiffConfig, ...options.diff };\n this.concurrency = Math.max(1, options.concurrency || 1);\n this.logConsoleEvents = options.logConsoleEvents ?? true;\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;CACA;CAEA,YAAY,SAST;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;AACxD,OAAK,mBAAmB,QAAQ,oBAAoB;AAEpD,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 { glob } from \"node:fs/promises\";\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 actual: string;\n private readonly expected: string;\n private readonly diff: string;\n\n constructor(outputDir: string) {\n this.actual = path.resolve(outputDir, \"actual\");\n this.expected = path.resolve(outputDir, \"expected\");\n this.diff = path.resolve(outputDir, \"diff\");\n\n this.ensureParentDir(this.actual);\n this.ensureParentDir(this.expected);\n this.ensureParentDir(this.diff);\n }\n\n clearActual() {\n this.removeDir(this.actual);\n }\n\n clearDiff() {\n this.removeDir(this.diff);\n }\n\n getActualScreenshots(): Promise<string[]> {\n return Array.fromAsync(glob(path.resolve(this.actual, \"**/*.png\")));\n }\n\n getExpectedScreenshots(): Promise<string[]> {\n return Array.fromAsync(glob(path.resolve(this.expected, \"**/*.png\")));\n }\n\n getDiffScreenshots(): Promise<string[]> {\n return Array.fromAsync(glob(path.resolve(this.diff, \"**/*.png\")));\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.actual, 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.actual, relativePath);\n const expectedPath = path.resolve(this.expected, relativePath);\n const diffPath = path.resolve(this.diff, 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.actual;\n }\n\n /**\n * Get the expected directory path\n */\n getExpectedDir(): string {\n return this.expected;\n }\n\n /**\n * Get the diff directory path\n */\n getDiffDir(): string {\n return this.diff;\n }\n\n /**\n * Get the path to an actual screenshot file\n */\n getActualFilePath(filename: string): string {\n return path.resolve(this.actual, filename);\n }\n\n /**\n * Get the path to an expected screenshot file\n */\n getExpectedFilePath(filename: string): string {\n return path.resolve(this.expected, filename);\n }\n\n /**\n * Get the path to a diff screenshot file\n */\n getDiffFilePath(filename: string): string {\n return path.resolve(this.diff, 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.actual, filePath);\n }\n\n getRelativePath(directory: \"actual\" | \"expected\" | \"diff\", filePath: string) {\n const relativePath = path.relative(this[directory], filePath);\n\n if (relativePath.startsWith(\"..\")) {\n throw new Error(\n `Cannot resolve relative path outside of ${directory} directory: ${filePath}`,\n );\n }\n\n return relativePath;\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 logConsoleEvents: boolean;\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 logConsoleEvents?: 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.diff = { ...defaultDiffConfig, ...options.diff };\n this.concurrency = Math.max(1, options.concurrency || 1);\n this.logConsoleEvents = options.logConsoleEvents ?? true;\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;;;;;;;;ACHT,IAAa,uBAAb,MAAkC;CAChC,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CAEjB,YAAY,WAAmB;AAC7B,OAAK,SAAS,KAAK,QAAQ,WAAW,SAAS;AAC/C,OAAK,WAAW,KAAK,QAAQ,WAAW,WAAW;AACnD,OAAK,OAAO,KAAK,QAAQ,WAAW,OAAO;AAE3C,OAAK,gBAAgB,KAAK,OAAO;AACjC,OAAK,gBAAgB,KAAK,SAAS;AACnC,OAAK,gBAAgB,KAAK,KAAK;;CAGjC,cAAc;AACZ,OAAK,UAAU,KAAK,OAAO;;CAG7B,YAAY;AACV,OAAK,UAAU,KAAK,KAAK;;CAG3B,uBAA0C;AACxC,SAAO,MAAM,UAAU,KAAK,KAAK,QAAQ,KAAK,QAAQ,WAAW,CAAC,CAAC;;CAGrE,yBAA4C;AAC1C,SAAO,MAAM,UAAU,KAAK,KAAK,QAAQ,KAAK,UAAU,WAAW,CAAC,CAAC;;CAGvE,qBAAwC;AACtC,SAAO,MAAM,UAAU,KAAK,KAAK,QAAQ,KAAK,MAAM,WAAW,CAAC,CAAC;;CAGnE,qBAAqB;AACnB,OAAK,aAAa;AAClB,OAAK,WAAW;;;;;;;CAQlB,sBAAsB,gBAAwB;EAC5C,MAAM,iBAAiB,KAAK,kBAAkB,eAAe;EAC7D,MAAM,eAAe,KAAK,SAAS,KAAK,QAAQ,eAAe;AAE/D,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,QAAQ,aAAa;EAC1D,MAAM,eAAe,KAAK,QAAQ,KAAK,UAAU,aAAa;EAC9D,MAAM,WAAW,KAAK,QAAQ,KAAK,MAAM,aAAa;AAEtD,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,QAAQ,SAAS;;;;;CAM5C,oBAAoB,UAA0B;AAC5C,SAAO,KAAK,QAAQ,KAAK,UAAU,SAAS;;;;;CAM9C,gBAAgB,UAA0B;AACxC,SAAO,KAAK,QAAQ,KAAK,MAAM,SAAS;;;;;CAM1C,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,QAAQ,SAAS;;CAG5C,gBAAgB,WAA2C,UAAkB;EAC3E,MAAM,eAAe,KAAK,SAAS,KAAK,YAAY,SAAS;AAE7D,MAAI,aAAa,WAAW,KAAK,CAC/B,OAAM,IAAI,MACR,2CAA2C,UAAU,cAAc,WACpE;AAGH,SAAO;;;;;;ACvMX,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;CACA;CAEA,YAAY,SAST;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;AACxD,OAAK,mBAAmB,QAAQ,oBAAoB;AAEpD,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,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cappa/core",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "Core Playwright screenshot functionality for Cappa",
|
|
5
5
|
"author": "Tim Richter",
|
|
6
6
|
"repository": {
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"@blazediff/types": "^1.4.1",
|
|
27
27
|
"playwright-core": "^1.56.1",
|
|
28
28
|
"pngjs": "^7.0.0",
|
|
29
|
-
"@cappa/logger": "0.0.
|
|
29
|
+
"@cappa/logger": "0.0.7"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"@types/node": "24.9.2",
|
|
@@ -35,7 +35,8 @@
|
|
|
35
35
|
"@vitest/ui": "4.0.6",
|
|
36
36
|
"tsdown": "0.15.12",
|
|
37
37
|
"typescript": "5.9.3",
|
|
38
|
-
"vitest": "4.0.6"
|
|
38
|
+
"vitest": "4.0.6",
|
|
39
|
+
"@arethetypeswrong/cli": "0.18.2"
|
|
39
40
|
},
|
|
40
41
|
"keywords": [
|
|
41
42
|
"screenshot",
|
|
@@ -52,6 +53,7 @@
|
|
|
52
53
|
"example:responsive": "node examples/responsive-screenshots.js",
|
|
53
54
|
"example:element": "node examples/element-screenshots.js",
|
|
54
55
|
"build": "tsdown",
|
|
55
|
-
"tsc": "tsc"
|
|
56
|
+
"tsc": "tsc",
|
|
57
|
+
"attw": "attw --pack --profile node16 ."
|
|
56
58
|
}
|
|
57
59
|
}
|
package/src/filesystem.ts
CHANGED
|
@@ -1,30 +1,43 @@
|
|
|
1
1
|
import fs from "node:fs";
|
|
2
|
+
import { glob } from "node:fs/promises";
|
|
2
3
|
import path from "node:path";
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* Class for interacting with the local file system to store the screenshots.
|
|
6
7
|
*/
|
|
7
8
|
export class ScreenshotFileSystem {
|
|
8
|
-
private readonly
|
|
9
|
-
private readonly
|
|
10
|
-
private readonly
|
|
9
|
+
private readonly actual: string;
|
|
10
|
+
private readonly expected: string;
|
|
11
|
+
private readonly diff: string;
|
|
11
12
|
|
|
12
13
|
constructor(outputDir: string) {
|
|
13
|
-
this.
|
|
14
|
-
this.
|
|
15
|
-
this.
|
|
14
|
+
this.actual = path.resolve(outputDir, "actual");
|
|
15
|
+
this.expected = path.resolve(outputDir, "expected");
|
|
16
|
+
this.diff = path.resolve(outputDir, "diff");
|
|
16
17
|
|
|
17
|
-
this.ensureParentDir(this.
|
|
18
|
-
this.ensureParentDir(this.
|
|
19
|
-
this.ensureParentDir(this.
|
|
18
|
+
this.ensureParentDir(this.actual);
|
|
19
|
+
this.ensureParentDir(this.expected);
|
|
20
|
+
this.ensureParentDir(this.diff);
|
|
20
21
|
}
|
|
21
22
|
|
|
22
23
|
clearActual() {
|
|
23
|
-
this.removeDir(this.
|
|
24
|
+
this.removeDir(this.actual);
|
|
24
25
|
}
|
|
25
26
|
|
|
26
27
|
clearDiff() {
|
|
27
|
-
this.removeDir(this.
|
|
28
|
+
this.removeDir(this.diff);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
getActualScreenshots(): Promise<string[]> {
|
|
32
|
+
return Array.fromAsync(glob(path.resolve(this.actual, "**/*.png")));
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
getExpectedScreenshots(): Promise<string[]> {
|
|
36
|
+
return Array.fromAsync(glob(path.resolve(this.expected, "**/*.png")));
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
getDiffScreenshots(): Promise<string[]> {
|
|
40
|
+
return Array.fromAsync(glob(path.resolve(this.diff, "**/*.png")));
|
|
28
41
|
}
|
|
29
42
|
|
|
30
43
|
clearActualAndDiff() {
|
|
@@ -39,7 +52,7 @@ export class ScreenshotFileSystem {
|
|
|
39
52
|
*/
|
|
40
53
|
approveFromActualPath(actualFilePath: string) {
|
|
41
54
|
const actualAbsolute = this.resolveActualPath(actualFilePath);
|
|
42
|
-
const relativePath = path.relative(this.
|
|
55
|
+
const relativePath = path.relative(this.actual, actualAbsolute);
|
|
43
56
|
|
|
44
57
|
if (relativePath.startsWith("..")) {
|
|
45
58
|
throw new Error(
|
|
@@ -67,9 +80,9 @@ export class ScreenshotFileSystem {
|
|
|
67
80
|
* @returns The paths to the actual, expected, and diff screenshot files.
|
|
68
81
|
*/
|
|
69
82
|
private approveRelative(relativePath: string) {
|
|
70
|
-
const actualPath = path.resolve(this.
|
|
71
|
-
const expectedPath = path.resolve(this.
|
|
72
|
-
const diffPath = path.resolve(this.
|
|
83
|
+
const actualPath = path.resolve(this.actual, relativePath);
|
|
84
|
+
const expectedPath = path.resolve(this.expected, relativePath);
|
|
85
|
+
const diffPath = path.resolve(this.diff, relativePath);
|
|
73
86
|
|
|
74
87
|
this.ensureParentDir(expectedPath);
|
|
75
88
|
|
|
@@ -112,42 +125,42 @@ export class ScreenshotFileSystem {
|
|
|
112
125
|
* Get the actual directory path
|
|
113
126
|
*/
|
|
114
127
|
getActualDir(): string {
|
|
115
|
-
return this.
|
|
128
|
+
return this.actual;
|
|
116
129
|
}
|
|
117
130
|
|
|
118
131
|
/**
|
|
119
132
|
* Get the expected directory path
|
|
120
133
|
*/
|
|
121
134
|
getExpectedDir(): string {
|
|
122
|
-
return this.
|
|
135
|
+
return this.expected;
|
|
123
136
|
}
|
|
124
137
|
|
|
125
138
|
/**
|
|
126
139
|
* Get the diff directory path
|
|
127
140
|
*/
|
|
128
141
|
getDiffDir(): string {
|
|
129
|
-
return this.
|
|
142
|
+
return this.diff;
|
|
130
143
|
}
|
|
131
144
|
|
|
132
145
|
/**
|
|
133
146
|
* Get the path to an actual screenshot file
|
|
134
147
|
*/
|
|
135
148
|
getActualFilePath(filename: string): string {
|
|
136
|
-
return path.resolve(this.
|
|
149
|
+
return path.resolve(this.actual, filename);
|
|
137
150
|
}
|
|
138
151
|
|
|
139
152
|
/**
|
|
140
153
|
* Get the path to an expected screenshot file
|
|
141
154
|
*/
|
|
142
155
|
getExpectedFilePath(filename: string): string {
|
|
143
|
-
return path.resolve(this.
|
|
156
|
+
return path.resolve(this.expected, filename);
|
|
144
157
|
}
|
|
145
158
|
|
|
146
159
|
/**
|
|
147
160
|
* Get the path to a diff screenshot file
|
|
148
161
|
*/
|
|
149
162
|
getDiffFilePath(filename: string): string {
|
|
150
|
-
return path.resolve(this.
|
|
163
|
+
return path.resolve(this.diff, filename);
|
|
151
164
|
}
|
|
152
165
|
|
|
153
166
|
/**
|
|
@@ -197,6 +210,18 @@ export class ScreenshotFileSystem {
|
|
|
197
210
|
return filePath;
|
|
198
211
|
}
|
|
199
212
|
|
|
200
|
-
return path.resolve(this.
|
|
213
|
+
return path.resolve(this.actual, filePath);
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
getRelativePath(directory: "actual" | "expected" | "diff", filePath: string) {
|
|
217
|
+
const relativePath = path.relative(this[directory], filePath);
|
|
218
|
+
|
|
219
|
+
if (relativePath.startsWith("..")) {
|
|
220
|
+
throw new Error(
|
|
221
|
+
`Cannot resolve relative path outside of ${directory} directory: ${filePath}`,
|
|
222
|
+
);
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
return relativePath;
|
|
201
226
|
}
|
|
202
227
|
}
|
package/src/index.ts
CHANGED
|
@@ -9,8 +9,12 @@ import ScreenshotTool, {
|
|
|
9
9
|
type ScreenshotVariantCaptureDetails,
|
|
10
10
|
} from "./screenshot";
|
|
11
11
|
import type {
|
|
12
|
+
ChangedScreenshot,
|
|
12
13
|
ConfigEnv,
|
|
14
|
+
DeletedScreenshot,
|
|
13
15
|
FailedScreenshot,
|
|
16
|
+
NewScreenshot,
|
|
17
|
+
PassedScreenshot,
|
|
14
18
|
Screenshot,
|
|
15
19
|
ScreenshotOptions,
|
|
16
20
|
ScreenshotSettings,
|
|
@@ -36,6 +40,10 @@ export {
|
|
|
36
40
|
type ScreenshotVariant,
|
|
37
41
|
type ScreenshotVariantWithUrl,
|
|
38
42
|
type Screenshot,
|
|
43
|
+
type NewScreenshot,
|
|
44
|
+
type DeletedScreenshot,
|
|
45
|
+
type ChangedScreenshot,
|
|
46
|
+
type PassedScreenshot,
|
|
39
47
|
type FailedScreenshot,
|
|
40
48
|
type ScreenshotCaptureResult,
|
|
41
49
|
type ScreenshotCaptureDetails,
|
package/src/types.ts
CHANGED
|
@@ -138,15 +138,34 @@ export type ScreenshotOptions = ScreenshotSettings & {
|
|
|
138
138
|
variants?: ScreenshotVariant[];
|
|
139
139
|
};
|
|
140
140
|
|
|
141
|
-
export
|
|
141
|
+
export type NewScreenshot = {
|
|
142
|
+
actualPath: string;
|
|
143
|
+
category: "new";
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
export type DeletedScreenshot = {
|
|
147
|
+
category: "deleted";
|
|
148
|
+
expectedPath: string;
|
|
149
|
+
};
|
|
150
|
+
|
|
151
|
+
export type ChangedScreenshot = {
|
|
152
|
+
category: "changed";
|
|
153
|
+
diffPath: string;
|
|
154
|
+
actualPath: string;
|
|
155
|
+
expectedPath: string;
|
|
156
|
+
};
|
|
157
|
+
|
|
158
|
+
export type PassedScreenshot = {
|
|
159
|
+
category: "passed";
|
|
160
|
+
actualPath: string;
|
|
161
|
+
expectedPath: string;
|
|
162
|
+
};
|
|
163
|
+
|
|
164
|
+
export type Screenshot = {
|
|
142
165
|
id: string;
|
|
143
166
|
name: string;
|
|
144
|
-
category: "new" | "deleted" | "changed" | "passed";
|
|
145
|
-
actualPath?: string;
|
|
146
|
-
expectedPath?: string;
|
|
147
|
-
diffPath?: string;
|
|
148
167
|
approved?: boolean;
|
|
149
|
-
}
|
|
168
|
+
} & (NewScreenshot | DeletedScreenshot | ChangedScreenshot | PassedScreenshot);
|
|
150
169
|
|
|
151
170
|
export type FailedScreenshot = Screenshot & {
|
|
152
171
|
/**
|