@cappa/core 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +13 -19
- package/.turbo/turbo-test.log +53 -0
- package/CHANGELOG.md +21 -0
- package/LICENSE +21 -0
- package/README.md +20 -0
- package/dist/index.d.mts +190 -38
- package/dist/index.d.ts +190 -38
- package/dist/index.js +430 -88
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +430 -89
- package/dist/index.mjs.map +1 -1
- package/package.json +10 -12
- package/src/compare.test.ts +9 -4
- package/src/compare.ts +76 -23
- package/src/filesystem.test.ts +83 -0
- package/src/filesystem.ts +202 -0
- package/src/index.ts +23 -2
- package/src/plugin.ts +26 -3
- package/src/screenshot.test.ts +40 -0
- package/src/screenshot.ts +425 -119
- package/src/types.ts +23 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,26 +1,137 @@
|
|
|
1
1
|
import { Browser, BrowserContext, Locator, Page } from "playwright-core";
|
|
2
2
|
import { Logger } from "@cappa/logger";
|
|
3
|
-
import { BlazeDiffOptions } from "@blazediff/types";
|
|
4
3
|
|
|
5
4
|
//#region src/compare.d.ts
|
|
6
|
-
type CompareOptions = BlazeDiffOptions;
|
|
7
5
|
interface CompareResult {
|
|
8
6
|
numDiffPixels: number;
|
|
9
7
|
totalPixels: number;
|
|
10
8
|
percentDifference: number;
|
|
11
9
|
diffBuffer?: Buffer;
|
|
12
10
|
passed: boolean;
|
|
11
|
+
error?: string;
|
|
12
|
+
differentSizes: boolean;
|
|
13
13
|
}
|
|
14
|
+
//#endregion
|
|
15
|
+
//#region src/filesystem.d.ts
|
|
14
16
|
/**
|
|
15
|
-
*
|
|
16
|
-
* @param image1 - First image (file path or Buffer)
|
|
17
|
-
* @param image2 - Second image (file path or Buffer)
|
|
18
|
-
* @param withDiff - Whether to create a diff image
|
|
19
|
-
* @param options - Comparison options
|
|
20
|
-
* @returns Comparison result
|
|
17
|
+
* Class for interacting with the local file system to store the screenshots.
|
|
21
18
|
*/
|
|
19
|
+
declare class ScreenshotFileSystem {
|
|
20
|
+
private readonly actualDir;
|
|
21
|
+
private readonly expectedDir;
|
|
22
|
+
private readonly diffDir;
|
|
23
|
+
constructor(outputDir: string);
|
|
24
|
+
clearActual(): void;
|
|
25
|
+
clearDiff(): void;
|
|
26
|
+
clearActualAndDiff(): void;
|
|
27
|
+
/**
|
|
28
|
+
* Approve a screenshot based on its actual file path.
|
|
29
|
+
* @param actualFilePath - The path to the actual screenshot file.
|
|
30
|
+
* @returns The paths to the actual, expected, and diff screenshot files.
|
|
31
|
+
*/
|
|
32
|
+
approveFromActualPath(actualFilePath: string): {
|
|
33
|
+
actualPath: string;
|
|
34
|
+
expectedPath: string;
|
|
35
|
+
diffPath: string;
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Approve a screenshot based on its name.
|
|
39
|
+
* @param name - The name of the screenshot. Can include '.png' extension.
|
|
40
|
+
* @returns The paths to the actual, expected, and diff screenshot files.
|
|
41
|
+
*/
|
|
42
|
+
approveByName(name: string): {
|
|
43
|
+
actualPath: string;
|
|
44
|
+
expectedPath: string;
|
|
45
|
+
diffPath: string;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Approve a screenshot based on a relative path.
|
|
49
|
+
* @param relativePath - The relative path to the screenshot.
|
|
50
|
+
* @returns The paths to the actual, expected, and diff screenshot files.
|
|
51
|
+
*/
|
|
52
|
+
private approveRelative;
|
|
53
|
+
/**
|
|
54
|
+
* Ensure the parent directory of a file exists. If not, it creates it.
|
|
55
|
+
* @param filePath - The path to the file.
|
|
56
|
+
*/
|
|
57
|
+
private ensureParentDir;
|
|
58
|
+
/**
|
|
59
|
+
* Remove a directory and all its contents.
|
|
60
|
+
* @param dir - The path to the directory.
|
|
61
|
+
*/
|
|
62
|
+
private removeDir;
|
|
63
|
+
/**
|
|
64
|
+
* Get the actual directory path
|
|
65
|
+
*/
|
|
66
|
+
getActualDir(): string;
|
|
67
|
+
/**
|
|
68
|
+
* Get the expected directory path
|
|
69
|
+
*/
|
|
70
|
+
getExpectedDir(): string;
|
|
71
|
+
/**
|
|
72
|
+
* Get the diff directory path
|
|
73
|
+
*/
|
|
74
|
+
getDiffDir(): string;
|
|
75
|
+
/**
|
|
76
|
+
* Get the path to an actual screenshot file
|
|
77
|
+
*/
|
|
78
|
+
getActualFilePath(filename: string): string;
|
|
79
|
+
/**
|
|
80
|
+
* Get the path to an expected screenshot file
|
|
81
|
+
*/
|
|
82
|
+
getExpectedFilePath(filename: string): string;
|
|
83
|
+
/**
|
|
84
|
+
* Get the path to a diff screenshot file
|
|
85
|
+
*/
|
|
86
|
+
getDiffFilePath(filename: string): string;
|
|
87
|
+
/**
|
|
88
|
+
* Write a file to the actual directory
|
|
89
|
+
*/
|
|
90
|
+
writeActualFile(filename: string, data: Buffer): void;
|
|
91
|
+
/**
|
|
92
|
+
* Write a file to the diff directory
|
|
93
|
+
*/
|
|
94
|
+
writeDiffFile(filename: string, data: Buffer): void;
|
|
95
|
+
/**
|
|
96
|
+
* Check if an expected file exists
|
|
97
|
+
*/
|
|
98
|
+
hasExpectedFile(filename: string): boolean;
|
|
99
|
+
/**
|
|
100
|
+
* Read an expected file
|
|
101
|
+
*/
|
|
102
|
+
readExpectedFile(filename: string): Buffer;
|
|
103
|
+
/**
|
|
104
|
+
* Resolve the actual path of a screenshot file.
|
|
105
|
+
* @param filePath - The path to the screenshot file.
|
|
106
|
+
* @returns The actual path of the screenshot file.
|
|
107
|
+
*/
|
|
108
|
+
private resolveActualPath;
|
|
109
|
+
}
|
|
22
110
|
//#endregion
|
|
23
111
|
//#region src/screenshot.d.ts
|
|
112
|
+
interface ScreenshotCaptureDetails {
|
|
113
|
+
filename: string;
|
|
114
|
+
filepath?: string;
|
|
115
|
+
comparisonResult?: CompareResult;
|
|
116
|
+
diffImagePath?: string;
|
|
117
|
+
skipped?: boolean;
|
|
118
|
+
}
|
|
119
|
+
interface ScreenshotVariantCaptureDetails extends ScreenshotCaptureDetails {
|
|
120
|
+
id: string;
|
|
121
|
+
label?: string;
|
|
122
|
+
}
|
|
123
|
+
interface ScreenshotCaptureResult {
|
|
124
|
+
base: ScreenshotCaptureDetails;
|
|
125
|
+
variants: ScreenshotVariantCaptureDetails[];
|
|
126
|
+
}
|
|
127
|
+
interface ScreenshotCaptureExtras {
|
|
128
|
+
saveDiffImage?: boolean;
|
|
129
|
+
diffImageFilename?: string;
|
|
130
|
+
variants?: Record<string, {
|
|
131
|
+
saveDiffImage?: boolean;
|
|
132
|
+
diffImageFilename?: string;
|
|
133
|
+
}>;
|
|
134
|
+
}
|
|
24
135
|
declare class ScreenshotTool {
|
|
25
136
|
browserType: "chromium" | "firefox" | "webkit";
|
|
26
137
|
headless: boolean;
|
|
@@ -29,14 +140,16 @@ declare class ScreenshotTool {
|
|
|
29
140
|
height: number;
|
|
30
141
|
};
|
|
31
142
|
outputDir: string;
|
|
32
|
-
actualDir: string;
|
|
33
|
-
diffDir: string;
|
|
34
|
-
expectedDir: string;
|
|
35
143
|
browser: Browser | null;
|
|
36
144
|
context: BrowserContext | null;
|
|
37
145
|
page: Page | null;
|
|
146
|
+
concurrency: number;
|
|
147
|
+
contexts: BrowserContext[];
|
|
148
|
+
pages: Page[];
|
|
38
149
|
diff: DiffConfig;
|
|
39
150
|
logger: Logger;
|
|
151
|
+
retries: number;
|
|
152
|
+
filesystem: ScreenshotFileSystem;
|
|
40
153
|
constructor(options: {
|
|
41
154
|
browserType?: "chromium" | "firefox" | "webkit";
|
|
42
155
|
headless?: boolean;
|
|
@@ -46,6 +159,8 @@ declare class ScreenshotTool {
|
|
|
46
159
|
};
|
|
47
160
|
outputDir?: string;
|
|
48
161
|
diff?: DiffConfig;
|
|
162
|
+
retries?: number;
|
|
163
|
+
concurrency?: number;
|
|
49
164
|
});
|
|
50
165
|
/**
|
|
51
166
|
* Initialize playwright and page
|
|
@@ -61,31 +176,19 @@ declare class ScreenshotTool {
|
|
|
61
176
|
*/
|
|
62
177
|
goTo(page: Page, url: string): Promise<void>;
|
|
63
178
|
/**
|
|
64
|
-
*
|
|
65
|
-
*/
|
|
66
|
-
private createDirectories;
|
|
67
|
-
/**
|
|
68
|
-
* Gets the path to the actual screenshot file
|
|
179
|
+
* Takes a screenshot of the page
|
|
69
180
|
*/
|
|
70
|
-
|
|
181
|
+
takeScreenshot(page: Page, filename: string, options: ScreenshotSettings): Promise<string | undefined>;
|
|
71
182
|
/**
|
|
72
|
-
*
|
|
183
|
+
* Sets the viewport size and executes the action, ensuring the original viewport is restored
|
|
184
|
+
* even if the action throws an error.
|
|
73
185
|
*/
|
|
74
|
-
|
|
186
|
+
private withViewport;
|
|
75
187
|
/**
|
|
76
|
-
*
|
|
188
|
+
* Takes a screenshot and returns the buffer (for comparison purposes)
|
|
77
189
|
*/
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
* Takes a screenshot of the page
|
|
81
|
-
*/
|
|
82
|
-
takeScreenshot(page: Page, filename: string, options: ScreenshotOptions): Promise<string | undefined>;
|
|
83
|
-
takeScreenshotWithComparison(page: Page, filename: string, referenceImage: Buffer, options?: {
|
|
84
|
-
fullPage?: boolean;
|
|
85
|
-
mask?: Locator[];
|
|
86
|
-
omitBackground?: boolean;
|
|
87
|
-
compareOptions?: CompareOptions;
|
|
88
|
-
maxDifferencePercent?: number;
|
|
190
|
+
takeScreenshotBuffer(page: Page, options: ScreenshotSettings): Promise<Buffer>;
|
|
191
|
+
takeScreenshotWithComparison(page: Page, filename: string, referenceImage: Buffer, options: ScreenshotSettings & {
|
|
89
192
|
saveDiffImage?: boolean;
|
|
90
193
|
diffImageFilename?: string;
|
|
91
194
|
}): Promise<{
|
|
@@ -93,22 +196,49 @@ declare class ScreenshotTool {
|
|
|
93
196
|
comparisonResult: CompareResult;
|
|
94
197
|
diffImagePath?: string;
|
|
95
198
|
}>;
|
|
96
|
-
|
|
97
|
-
|
|
199
|
+
retryScreenshot(page: Page, referenceImage: Buffer, options: ScreenshotSettings): Promise<{
|
|
200
|
+
screenshotPath: Buffer<ArrayBufferLike>;
|
|
201
|
+
comparisonResult: CompareResult;
|
|
202
|
+
passed: boolean;
|
|
203
|
+
} | {
|
|
204
|
+
screenshotPath: null;
|
|
205
|
+
comparisonResult: null;
|
|
206
|
+
passed: boolean;
|
|
207
|
+
}>;
|
|
208
|
+
getVariantFilename(filename: string, variant: ScreenshotVariant): string;
|
|
209
|
+
capture(page: Page, filename: string, options: ScreenshotOptions, extras?: ScreenshotCaptureExtras): Promise<ScreenshotCaptureResult>;
|
|
210
|
+
/**
|
|
211
|
+
* Gets the exponential backoff delay
|
|
212
|
+
*/
|
|
213
|
+
getIncBackoffDelay(i: number, delay: number): number;
|
|
214
|
+
/**
|
|
215
|
+
* Get a page from the pool by index
|
|
216
|
+
*/
|
|
217
|
+
getPageFromPool(index: number): Page;
|
|
98
218
|
}
|
|
99
219
|
//#endregion
|
|
100
220
|
//#region src/plugin.d.ts
|
|
101
221
|
/**
|
|
102
|
-
* Plugin
|
|
222
|
+
* Plugin task interface
|
|
223
|
+
*/
|
|
224
|
+
type PluginTask<TData = any> = {
|
|
225
|
+
id: string;
|
|
226
|
+
url: string;
|
|
227
|
+
data?: TData;
|
|
228
|
+
};
|
|
229
|
+
/**
|
|
230
|
+
* Plugin function type definition (legacy)
|
|
103
231
|
*/
|
|
104
232
|
type PluginFunction = (screenshotTool: ScreenshotTool) => Promise<any[]>;
|
|
105
233
|
/**
|
|
106
234
|
* Plugin definition interface
|
|
107
235
|
*/
|
|
108
|
-
type PluginDef = {
|
|
236
|
+
type PluginDef<TResult = any, TContext = any, TData = any> = {
|
|
109
237
|
name: string;
|
|
110
238
|
description: string;
|
|
111
|
-
|
|
239
|
+
discover: (screenshotTool: ScreenshotTool) => Promise<PluginTask<TData>[]>;
|
|
240
|
+
execute: (task: PluginTask<TData>, page: Page, screenshotTool: ScreenshotTool, context: TContext) => Promise<TResult>;
|
|
241
|
+
initPage?: (page: Page, screenshotTool: ScreenshotTool) => Promise<TContext>;
|
|
112
242
|
};
|
|
113
243
|
/**
|
|
114
244
|
* Plugin function type definition
|
|
@@ -179,18 +309,40 @@ type UserConfig = {
|
|
|
179
309
|
* Configuration for the comparison of images
|
|
180
310
|
*/
|
|
181
311
|
diff?: DiffConfig;
|
|
312
|
+
/**
|
|
313
|
+
* The number of times to retry a screenshot if it fails
|
|
314
|
+
*/
|
|
315
|
+
retries?: number;
|
|
316
|
+
/**
|
|
317
|
+
* The number of parallel browser contexts to use for taking screenshots
|
|
318
|
+
*/
|
|
319
|
+
concurrency?: number;
|
|
182
320
|
/**
|
|
183
321
|
* An array of Cappa plugins used for generation.
|
|
184
322
|
* Each plugin may have additional configurable options (defined within the plugin itself).
|
|
185
323
|
*/
|
|
186
324
|
plugins?: Array<Plugin | PluginDef>;
|
|
187
325
|
};
|
|
188
|
-
type
|
|
326
|
+
type Viewport = {
|
|
327
|
+
width: number;
|
|
328
|
+
height: number;
|
|
329
|
+
};
|
|
330
|
+
type ScreenshotSettings = {
|
|
189
331
|
fullPage?: boolean;
|
|
190
332
|
delay?: number;
|
|
191
333
|
skip?: boolean;
|
|
192
334
|
mask?: Locator[];
|
|
193
335
|
omitBackground?: boolean;
|
|
336
|
+
viewport?: Viewport;
|
|
337
|
+
};
|
|
338
|
+
type ScreenshotVariant = {
|
|
339
|
+
id: string;
|
|
340
|
+
label?: string;
|
|
341
|
+
filename?: string;
|
|
342
|
+
options?: ScreenshotSettings;
|
|
343
|
+
};
|
|
344
|
+
type ScreenshotOptions = ScreenshotSettings & {
|
|
345
|
+
variants?: ScreenshotVariant[];
|
|
194
346
|
};
|
|
195
347
|
interface Screenshot {
|
|
196
348
|
id: string;
|
|
@@ -208,5 +360,5 @@ interface Screenshot {
|
|
|
208
360
|
*/
|
|
209
361
|
declare function defineConfig(options: PossiblePromise<UserConfig | Array<UserConfig>> | (() => PossiblePromise<UserConfig | Array<UserConfig>>)): typeof options;
|
|
210
362
|
//#endregion
|
|
211
|
-
export { type Plugin, type PluginDef, type PluginFunction, type Screenshot, type ScreenshotOptions, ScreenshotTool, type UserConfig, defineConfig };
|
|
363
|
+
export { 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 UserConfig, type Viewport, defineConfig };
|
|
212
364
|
//# sourceMappingURL=index.d.ts.map
|