@cappa/core 0.0.21 → 0.0.23
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 +11 -11
- package/CHANGELOG.md +12 -0
- package/dist/index.d.mts +5 -11
- package/dist/index.d.ts +5 -11
- package/dist/index.js +7 -8
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +7 -8
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/screenshot.ts +10 -15
- package/src/types.ts +2 -2
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
-
> @cappa/core@0.0.
|
|
3
|
+
> @cappa/core@0.0.22 build /home/tim/code/work/cappa/packages/core
|
|
4
4
|
> tsdown
|
|
5
5
|
|
|
6
6
|
[34mℹ[39m tsdown [2mv0.14.1[22m powered by rolldown [2mv1.0.0-beta.38[22m
|
|
@@ -13,15 +13,15 @@
|
|
|
13
13
|
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
14
14
|
[33mWarning: Invalid input options (1 issue found)
|
|
15
15
|
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
16
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[1mindex.js[22m [2m
|
|
17
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [2m12.
|
|
18
|
-
[34mℹ[39m [33m[CJS][39m 2 files, total: 19.
|
|
16
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[1mindex.js[22m [2m 6.92 kB[22m [2m│ gzip: 2.15 kB[22m
|
|
17
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [2m12.34 kB[22m [2m│ gzip: 3.45 kB[22m
|
|
18
|
+
[34mℹ[39m [33m[CJS][39m 2 files, total: 19.26 kB
|
|
19
19
|
[33mWarning: Invalid input options (1 issue found)
|
|
20
20
|
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
21
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[32m[1mindex.d.ts[22m[39m [2m3.
|
|
22
|
-
[34mℹ[39m [33m[CJS][39m 1 files, total: 3.
|
|
23
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[1mindex.mjs[22m [2m 5.
|
|
24
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22mindex.mjs.map [2m12.
|
|
25
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[32m[1mindex.d.mts[22m[39m [2m 3.
|
|
26
|
-
[34mℹ[39m [34m[ESM][39m 3 files, total:
|
|
27
|
-
[32m✔[39m Build complete in [
|
|
21
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[32m[1mindex.d.ts[22m[39m [2m3.70 kB[22m [2m│ gzip: 1.33 kB[22m
|
|
22
|
+
[34mℹ[39m [33m[CJS][39m 1 files, total: 3.70 kB
|
|
23
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[1mindex.mjs[22m [2m 5.70 kB[22m [2m│ gzip: 1.71 kB[22m
|
|
24
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22mindex.mjs.map [2m12.30 kB[22m [2m│ gzip: 3.44 kB[22m
|
|
25
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[32m[1mindex.d.mts[22m[39m [2m 3.70 kB[22m [2m│ gzip: 1.33 kB[22m
|
|
26
|
+
[34mℹ[39m [34m[ESM][39m 3 files, total: 21.70 kB
|
|
27
|
+
[32m✔[39m Build complete in [32m950ms[39m
|
package/CHANGELOG.md
CHANGED
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Browser, BrowserContext, Page } from "playwright-core";
|
|
1
|
+
import { Browser, BrowserContext, Locator, Page } from "playwright-core";
|
|
2
2
|
import { ConsolaInstance } from "consola";
|
|
3
3
|
|
|
4
4
|
//#region src/screenshot.d.ts
|
|
@@ -10,7 +10,6 @@ declare class ScreenshotTool {
|
|
|
10
10
|
height: number;
|
|
11
11
|
};
|
|
12
12
|
outputDir: string;
|
|
13
|
-
quality: number;
|
|
14
13
|
fullPage: boolean;
|
|
15
14
|
browser: Browser | null;
|
|
16
15
|
context: BrowserContext | null;
|
|
@@ -23,7 +22,6 @@ declare class ScreenshotTool {
|
|
|
23
22
|
height: number;
|
|
24
23
|
};
|
|
25
24
|
outputDir?: string;
|
|
26
|
-
quality?: number;
|
|
27
25
|
fullPage?: boolean;
|
|
28
26
|
});
|
|
29
27
|
init(): Promise<void>;
|
|
@@ -32,16 +30,14 @@ declare class ScreenshotTool {
|
|
|
32
30
|
getFilePath(filename: string): string;
|
|
33
31
|
takeScreenshot(page: Page, filename: string, options?: {
|
|
34
32
|
fullPage?: boolean;
|
|
35
|
-
type?: string;
|
|
36
|
-
quality?: number;
|
|
37
33
|
waitForSelector?: string;
|
|
38
34
|
waitForTimeout?: number;
|
|
35
|
+
mask?: Locator[];
|
|
36
|
+
omitBackground?: boolean;
|
|
39
37
|
}): Promise<string>;
|
|
40
38
|
takeElementScreenshot(page: Page, selector: string, options?: {
|
|
41
39
|
filename?: string;
|
|
42
40
|
fullPage?: boolean;
|
|
43
|
-
type?: string;
|
|
44
|
-
quality?: number;
|
|
45
41
|
}): Promise<string>;
|
|
46
42
|
batchScreenshots(urls: string[], options?: {}): Promise<{
|
|
47
43
|
url: string;
|
|
@@ -55,8 +51,6 @@ declare class ScreenshotTool {
|
|
|
55
51
|
name: string;
|
|
56
52
|
}[], options?: {
|
|
57
53
|
fullPage?: boolean;
|
|
58
|
-
type?: string;
|
|
59
|
-
quality?: number;
|
|
60
54
|
}): Promise<{
|
|
61
55
|
viewport: string;
|
|
62
56
|
success: boolean;
|
|
@@ -110,12 +104,12 @@ type UserConfig = {
|
|
|
110
104
|
};
|
|
111
105
|
type ScreenshotOptions = {
|
|
112
106
|
fullPage?: boolean;
|
|
113
|
-
type?: string;
|
|
114
|
-
quality?: number;
|
|
115
107
|
waitForSelector?: string;
|
|
116
108
|
waitForTimeout?: number;
|
|
117
109
|
delay?: number;
|
|
118
110
|
skip?: boolean;
|
|
111
|
+
mask?: string[];
|
|
112
|
+
omitBackground?: boolean;
|
|
119
113
|
};
|
|
120
114
|
interface Exposed {
|
|
121
115
|
emitCapture(opt: ScreenshotOptions): void;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ConsolaInstance } from "consola";
|
|
2
|
-
import { Browser, BrowserContext, Page } from "playwright-core";
|
|
2
|
+
import { Browser, BrowserContext, Locator, Page } from "playwright-core";
|
|
3
3
|
|
|
4
4
|
//#region src/screenshot.d.ts
|
|
5
5
|
declare class ScreenshotTool {
|
|
@@ -10,7 +10,6 @@ declare class ScreenshotTool {
|
|
|
10
10
|
height: number;
|
|
11
11
|
};
|
|
12
12
|
outputDir: string;
|
|
13
|
-
quality: number;
|
|
14
13
|
fullPage: boolean;
|
|
15
14
|
browser: Browser | null;
|
|
16
15
|
context: BrowserContext | null;
|
|
@@ -23,7 +22,6 @@ declare class ScreenshotTool {
|
|
|
23
22
|
height: number;
|
|
24
23
|
};
|
|
25
24
|
outputDir?: string;
|
|
26
|
-
quality?: number;
|
|
27
25
|
fullPage?: boolean;
|
|
28
26
|
});
|
|
29
27
|
init(): Promise<void>;
|
|
@@ -32,16 +30,14 @@ declare class ScreenshotTool {
|
|
|
32
30
|
getFilePath(filename: string): string;
|
|
33
31
|
takeScreenshot(page: Page, filename: string, options?: {
|
|
34
32
|
fullPage?: boolean;
|
|
35
|
-
type?: string;
|
|
36
|
-
quality?: number;
|
|
37
33
|
waitForSelector?: string;
|
|
38
34
|
waitForTimeout?: number;
|
|
35
|
+
mask?: Locator[];
|
|
36
|
+
omitBackground?: boolean;
|
|
39
37
|
}): Promise<string>;
|
|
40
38
|
takeElementScreenshot(page: Page, selector: string, options?: {
|
|
41
39
|
filename?: string;
|
|
42
40
|
fullPage?: boolean;
|
|
43
|
-
type?: string;
|
|
44
|
-
quality?: number;
|
|
45
41
|
}): Promise<string>;
|
|
46
42
|
batchScreenshots(urls: string[], options?: {}): Promise<{
|
|
47
43
|
url: string;
|
|
@@ -55,8 +51,6 @@ declare class ScreenshotTool {
|
|
|
55
51
|
name: string;
|
|
56
52
|
}[], options?: {
|
|
57
53
|
fullPage?: boolean;
|
|
58
|
-
type?: string;
|
|
59
|
-
quality?: number;
|
|
60
54
|
}): Promise<{
|
|
61
55
|
viewport: string;
|
|
62
56
|
success: boolean;
|
|
@@ -110,12 +104,12 @@ type UserConfig = {
|
|
|
110
104
|
};
|
|
111
105
|
type ScreenshotOptions = {
|
|
112
106
|
fullPage?: boolean;
|
|
113
|
-
type?: string;
|
|
114
|
-
quality?: number;
|
|
115
107
|
waitForSelector?: string;
|
|
116
108
|
waitForTimeout?: number;
|
|
117
109
|
delay?: number;
|
|
118
110
|
skip?: boolean;
|
|
111
|
+
mask?: string[];
|
|
112
|
+
omitBackground?: boolean;
|
|
119
113
|
};
|
|
120
114
|
interface Exposed {
|
|
121
115
|
emitCapture(opt: ScreenshotOptions): void;
|
package/dist/index.js
CHANGED
|
@@ -43,7 +43,6 @@ var ScreenshotTool = class {
|
|
|
43
43
|
headless;
|
|
44
44
|
viewport;
|
|
45
45
|
outputDir;
|
|
46
|
-
quality;
|
|
47
46
|
fullPage;
|
|
48
47
|
browser = null;
|
|
49
48
|
context = null;
|
|
@@ -56,7 +55,6 @@ var ScreenshotTool = class {
|
|
|
56
55
|
height: 1080
|
|
57
56
|
};
|
|
58
57
|
this.outputDir = options.outputDir || "./screenshots";
|
|
59
|
-
this.quality = options.quality || 90;
|
|
60
58
|
this.fullPage = options.fullPage !== false;
|
|
61
59
|
}
|
|
62
60
|
async init() {
|
|
@@ -103,8 +101,11 @@ var ScreenshotTool = class {
|
|
|
103
101
|
const screenshotOptions = {
|
|
104
102
|
path: filepath,
|
|
105
103
|
fullPage: options.fullPage !== void 0 ? options.fullPage : this.fullPage,
|
|
106
|
-
type:
|
|
107
|
-
|
|
104
|
+
type: "png",
|
|
105
|
+
timeout: 6e4,
|
|
106
|
+
mask: options.mask,
|
|
107
|
+
omitBackground: options.omitBackground,
|
|
108
|
+
scale: "css"
|
|
108
109
|
};
|
|
109
110
|
await page.screenshot(screenshotOptions);
|
|
110
111
|
console.log(`Screenshot saved: ${filepath}`);
|
|
@@ -124,8 +125,7 @@ var ScreenshotTool = class {
|
|
|
124
125
|
const filepath = this.getFilePath(filename);
|
|
125
126
|
const elementScreenshotOptions = {
|
|
126
127
|
path: filepath,
|
|
127
|
-
type:
|
|
128
|
-
quality: options.quality || this.quality
|
|
128
|
+
type: "png"
|
|
129
129
|
};
|
|
130
130
|
await element.screenshot(elementScreenshotOptions);
|
|
131
131
|
console.log(`Element screenshot saved: ${filepath}`);
|
|
@@ -188,8 +188,7 @@ var ScreenshotTool = class {
|
|
|
188
188
|
const responsiveScreenshotOptions = {
|
|
189
189
|
path: filepath,
|
|
190
190
|
fullPage: options.fullPage !== void 0 ? options.fullPage : this.fullPage,
|
|
191
|
-
type:
|
|
192
|
-
quality: options.quality || this.quality
|
|
191
|
+
type: "png"
|
|
193
192
|
};
|
|
194
193
|
await page.screenshot(responsiveScreenshotOptions);
|
|
195
194
|
await page.close();
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["fs","path","results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]","results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]"],"sources":["../src/config.ts","../src/screenshot.ts"],"sourcesContent":["import type { PossiblePromise, UserConfig } from \"./types\";\n\n/**\n * Type helper to make it easier to use vite.config.ts accepts a direct UserConfig object, or a function that returns it. The function receives a ConfigEnv object.\n */\nexport function defineConfig(\n options:\n | PossiblePromise<UserConfig | Array<UserConfig>>\n | (() => PossiblePromise<UserConfig | Array<UserConfig>>),\n): typeof options {\n return options;\n}\n","import fs from \"node:fs\";\nimport path from \"node:path\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\n\nclass ScreenshotTool {\n browserType: string;\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n quality: number;\n fullPage: boolean;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n constructor(options: {\n browserType?: string;\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n quality?: number;\n fullPage?: boolean;\n }) {\n this.browserType = options.browserType || \"chromium\";\n this.headless = options.headless !== false; // Default to headless\n this.viewport = options.viewport || { width: 1920, height: 1080 };\n this.outputDir = options.outputDir || \"./screenshots\";\n this.quality = options.quality || 90;\n this.fullPage = options.fullPage !== false; // Default to full page\n }\n\n async init() {\n // Create output directory if it doesn't exist\n if (!fs.existsSync(this.outputDir)) {\n fs.mkdirSync(this.outputDir, { recursive: true });\n }\n\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass =\n browserMap[this.browserType as keyof typeof browserMap];\n if (!browserClass) {\n throw new Error(`Unsupported browser type: ${this.browserType}`);\n }\n\n this.browser = await browserClass.launch({\n headless: this.headless,\n });\n\n const defaultUserAgent = (await this.browser.newContext())\n .newPage()\n .then((page) => page.evaluate(() => navigator.userAgent));\n\n this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 1,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n });\n\n this.page = await this.context?.newPage();\n this.page?.setViewportSize(this.viewport);\n }\n\n async close() {\n if (this.browser) {\n await this.browser.close();\n }\n }\n\n async goTo(page: Page, url: string) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n }\n\n getFilePath(filename: string) {\n const filepath = path.join(this.outputDir, filename);\n return filepath;\n }\n\n async takeScreenshot(\n page: Page,\n filename: string,\n options: {\n fullPage?: boolean;\n type?: string;\n quality?: number;\n waitForSelector?: string;\n waitForTimeout?: number;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for selector if specified\n if (options.waitForSelector) {\n console.log(`Waiting for selector: ${options.waitForSelector}`);\n await page.waitForSelector(options.waitForSelector, { timeout: 10000 });\n }\n\n // Wait for custom timeout or default\n const waitTime =\n options.waitForTimeout !== undefined ? options.waitForTimeout : 0;\n if (waitTime > 0) {\n console.log(`Waiting for ${waitTime}ms for dynamic content`);\n await page.waitForTimeout(waitTime);\n }\n\n // Generate filename\n const filepath = this.getFilePath(filename);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: (options.type as \"jpeg\" | \"png\") || \"jpeg\",\n quality: (options.quality as number) || this.quality,\n } satisfies PageScreenshotOptions;\n\n await page.screenshot(screenshotOptions);\n\n console.log(`Screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeElementScreenshot(\n page: Page,\n selector: string,\n options: {\n filename?: string;\n fullPage?: boolean;\n type?: string;\n quality?: number;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for element to be visible\n await page.waitForSelector(selector, { timeout: 10000 });\n\n const element = await page.$(selector);\n if (!element) {\n throw new Error(`Element not found: ${selector}`);\n }\n\n const filename =\n (options.filename as string | undefined) ||\n `${selector.replace(/[^a-zA-Z0-9]/g, \"_\")}.png`;\n const filepath = this.getFilePath(filename);\n\n const elementScreenshotOptions = {\n path: filepath,\n type: (options.type as \"jpeg\" | \"png\") || \"jpeg\",\n quality: (options.quality as number) || this.quality,\n } satisfies PageScreenshotOptions;\n\n await element.screenshot(elementScreenshotOptions);\n\n console.log(`Element screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking element screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n } finally {\n await page.close();\n }\n }\n\n async batchScreenshots(urls: string[], options = {}) {\n const results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const url of urls) {\n try {\n const page = this.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n await this.goTo(page, url);\n const filepath = await this.takeScreenshot(page, url, options);\n results.push({ url, success: true, filepath });\n } catch (error) {\n results.push({\n url,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n async takeResponsiveScreenshots(\n url: string,\n viewports: { width: number; height: number; name: string }[] = [\n { width: 1920, height: 1080, name: \"desktop\" },\n { width: 768, height: 1024, name: \"tablet\" },\n { width: 375, height: 667, name: \"mobile\" },\n ],\n options: {\n fullPage?: boolean;\n type?: string;\n quality?: number;\n } = {},\n ) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n\n const results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const viewport of viewports) {\n try {\n const page = await this.context?.newPage();\n await page.setViewportSize(viewport);\n\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n await page.waitForTimeout(2000);\n\n const filename = `${viewport.name}.png`;\n const filepath = this.getFilePath(filename);\n\n const responsiveScreenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: (options.type as \"jpeg\" | \"png\") || \"png\",\n quality: (options.quality as number) || this.quality,\n };\n\n await page.screenshot(responsiveScreenshotOptions);\n\n await page.close();\n\n console.log(`Responsive screenshot saved: ${filepath}`);\n results.push({ viewport: viewport.name, success: true, filepath });\n } catch (error) {\n console.error(\n `Error taking responsive screenshot for ${viewport.name}:`,\n (error as Error).message,\n );\n results.push({\n viewport: viewport.name,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n}\n\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;ACET,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB,YAAY,SAOT;AACD,OAAK,cAAc,QAAQ,eAAe;AAC1C,OAAK,WAAW,QAAQ,aAAa;AACrC,OAAK,WAAW,QAAQ,YAAY;GAAE,OAAO;GAAM,QAAQ;GAAM;AACjE,OAAK,YAAY,QAAQ,aAAa;AACtC,OAAK,UAAU,QAAQ,WAAW;AAClC,OAAK,WAAW,QAAQ,aAAa;;CAGvC,MAAM,OAAO;AAEX,MAAI,CAACA,gBAAG,WAAW,KAAK,UAAU,CAChC,iBAAG,UAAU,KAAK,WAAW,EAAE,WAAW,MAAM,CAAC;EAUnD,MAAM,eANa;GACjB;GACA;GACA;GACD,CAGY,KAAK;AAClB,MAAI,CAAC,aACH,OAAM,IAAI,MAAM,6BAA6B,KAAK,cAAc;AAGlE,OAAK,UAAU,MAAM,aAAa,OAAO,EACvC,UAAU,KAAK,UAChB,CAAC;EAEF,MAAM,oBAAoB,MAAM,KAAK,QAAQ,YAAY,EACtD,SAAS,CACT,MAAM,SAAS,KAAK,eAAe,UAAU,UAAU,CAAC;AAE3D,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACnB,WAAW,GAAG,MAAM,iBAAiB;GACtC,CAAC;AAEF,OAAK,OAAO,MAAM,KAAK,SAAS,SAAS;AACzC,OAAK,MAAM,gBAAgB,KAAK,SAAS;;CAG3C,MAAM,QAAQ;AACZ,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;CAI9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;CAGzD,YAAY,UAAkB;AAE5B,SADiBC,kBAAK,KAAK,KAAK,WAAW,SAAS;;CAItD,MAAM,eACJ,MACA,UACA,UAMI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,OAAI,QAAQ,iBAAiB;AAC3B,YAAQ,IAAI,yBAAyB,QAAQ,kBAAkB;AAC/D,UAAM,KAAK,gBAAgB,QAAQ,iBAAiB,EAAE,SAAS,KAAO,CAAC;;GAIzE,MAAM,WACJ,QAAQ,mBAAmB,SAAY,QAAQ,iBAAiB;AAClE,OAAI,WAAW,GAAG;AAChB,YAAQ,IAAI,eAAe,SAAS,wBAAwB;AAC5D,UAAM,KAAK,eAAe,SAAS;;GAIrC,MAAM,WAAW,KAAK,YAAY,SAAS;GAG3C,MAAM,oBAAoB;IACxB,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAO,QAAQ,QAA2B;IAC1C,SAAU,QAAQ,WAAsB,KAAK;IAC9C;AAED,SAAM,KAAK,WAAW,kBAAkB;AAExC,WAAQ,IAAI,qBAAqB,WAAW;AAC5C,UAAO;WACA,OAAO;AACd,WAAQ,MACN,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,sBACJ,MACA,UACA,UAKI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,SAAM,KAAK,gBAAgB,UAAU,EAAE,SAAS,KAAO,CAAC;GAExD,MAAM,UAAU,MAAM,KAAK,EAAE,SAAS;AACtC,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,sBAAsB,WAAW;GAGnD,MAAM,WACH,QAAQ,YACT,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GAC5C,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,2BAA2B;IAC/B,MAAM;IACN,MAAO,QAAQ,QAA2B;IAC1C,SAAU,QAAQ,WAAsB,KAAK;IAC9C;AAED,SAAM,QAAQ,WAAW,yBAAyB;AAElD,WAAQ,IAAI,6BAA6B,WAAW;AACpD,UAAO;WACA,OAAO;AACd,WAAQ,MACN,sCAAsC,KAAK,KAAK,CAAC,IAChD,MAAgB,QAClB;AACD,SAAM;YACE;AACR,SAAM,KAAK,OAAO;;;CAItB,MAAM,iBAAiB,MAAgB,UAAU,EAAE,EAAE;EACnD,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,OAAO,KAChB,KAAI;GACF,MAAM,OAAO,KAAK;AAClB,OAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAEzC,SAAM,KAAK,KAAK,MAAM,IAAI;GAC1B,MAAM,WAAW,MAAM,KAAK,eAAe,MAAM,KAAK,QAAQ;AAC9D,WAAQ,KAAK;IAAE;IAAK,SAAS;IAAM;IAAU,CAAC;WACvC,OAAO;AACd,WAAQ,KAAK;IACX;IACA,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAGT,MAAM,0BACJ,KACA,YAA+D;EAC7D;GAAE,OAAO;GAAM,QAAQ;GAAM,MAAM;GAAW;EAC9C;GAAE,OAAO;GAAK,QAAQ;GAAM,MAAM;GAAU;EAC5C;GAAE,OAAO;GAAK,QAAQ;GAAK,MAAM;GAAU;EAC5C,EACD,UAII,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,YAAY,UACrB,KAAI;GACF,MAAM,OAAO,MAAM,KAAK,SAAS,SAAS;AAC1C,SAAM,KAAK,gBAAgB,SAAS;AAEpC,SAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;AACvD,SAAM,KAAK,eAAe,IAAK;GAE/B,MAAM,WAAW,GAAG,SAAS,KAAK;GAClC,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,8BAA8B;IAClC,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAO,QAAQ,QAA2B;IAC1C,SAAU,QAAQ,WAAsB,KAAK;IAC9C;AAED,SAAM,KAAK,WAAW,4BAA4B;AAElD,SAAM,KAAK,OAAO;AAElB,WAAQ,IAAI,gCAAgC,WAAW;AACvD,WAAQ,KAAK;IAAE,UAAU,SAAS;IAAM,SAAS;IAAM;IAAU,CAAC;WAC3D,OAAO;AACd,WAAQ,MACN,0CAA0C,SAAS,KAAK,IACvD,MAAgB,QAClB;AACD,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;;AAIX,yBAAe"}
|
|
1
|
+
{"version":3,"file":"index.js","names":["fs","path","results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]","results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]"],"sources":["../src/config.ts","../src/screenshot.ts"],"sourcesContent":["import type { PossiblePromise, UserConfig } from \"./types\";\n\n/**\n * Type helper to make it easier to use vite.config.ts accepts a direct UserConfig object, or a function that returns it. The function receives a ConfigEnv object.\n */\nexport function defineConfig(\n options:\n | PossiblePromise<UserConfig | Array<UserConfig>>\n | (() => PossiblePromise<UserConfig | Array<UserConfig>>),\n): typeof options {\n return options;\n}\n","import fs from \"node:fs\";\nimport path from \"node:path\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n Locator,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\n\nclass ScreenshotTool {\n browserType: string;\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n fullPage: boolean;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n constructor(options: {\n browserType?: string;\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n fullPage?: boolean;\n }) {\n this.browserType = options.browserType || \"chromium\";\n this.headless = options.headless !== false; // Default to headless\n this.viewport = options.viewport || { width: 1920, height: 1080 };\n this.outputDir = options.outputDir || \"./screenshots\";\n this.fullPage = options.fullPage !== false; // Default to full page\n }\n\n async init() {\n // Create output directory if it doesn't exist\n if (!fs.existsSync(this.outputDir)) {\n fs.mkdirSync(this.outputDir, { recursive: true });\n }\n\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass =\n browserMap[this.browserType as keyof typeof browserMap];\n if (!browserClass) {\n throw new Error(`Unsupported browser type: ${this.browserType}`);\n }\n\n this.browser = await browserClass.launch({\n headless: this.headless,\n });\n\n const defaultUserAgent = (await this.browser.newContext())\n .newPage()\n .then((page) => page.evaluate(() => navigator.userAgent));\n\n this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 1,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n });\n\n this.page = await this.context?.newPage();\n this.page?.setViewportSize(this.viewport);\n }\n\n async close() {\n if (this.browser) {\n await this.browser.close();\n }\n }\n\n async goTo(page: Page, url: string) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n }\n\n getFilePath(filename: string) {\n const filepath = path.join(this.outputDir, filename);\n return filepath;\n }\n\n async takeScreenshot(\n page: Page,\n filename: string,\n options: {\n fullPage?: boolean;\n waitForSelector?: string;\n waitForTimeout?: number;\n mask?: Locator[];\n omitBackground?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for selector if specified\n if (options.waitForSelector) {\n console.log(`Waiting for selector: ${options.waitForSelector}`);\n await page.waitForSelector(options.waitForSelector, { timeout: 10000 });\n }\n\n // Wait for custom timeout or default\n const waitTime =\n options.waitForTimeout !== undefined ? options.waitForTimeout : 0;\n if (waitTime > 0) {\n console.log(`Waiting for ${waitTime}ms for dynamic content`);\n await page.waitForTimeout(waitTime);\n }\n\n // Generate filename\n const filepath = this.getFilePath(filename);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\",\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n } satisfies PageScreenshotOptions;\n\n await page.screenshot(screenshotOptions);\n\n console.log(`Screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeElementScreenshot(\n page: Page,\n selector: string,\n options: {\n filename?: string;\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for element to be visible\n await page.waitForSelector(selector, { timeout: 10000 });\n\n const element = await page.$(selector);\n if (!element) {\n throw new Error(`Element not found: ${selector}`);\n }\n\n const filename =\n (options.filename as string | undefined) ||\n `${selector.replace(/[^a-zA-Z0-9]/g, \"_\")}.png`;\n const filepath = this.getFilePath(filename);\n\n const elementScreenshotOptions = {\n path: filepath,\n type: \"png\",\n } satisfies PageScreenshotOptions;\n\n await element.screenshot(elementScreenshotOptions);\n\n console.log(`Element screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking element screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n } finally {\n await page.close();\n }\n }\n\n async batchScreenshots(urls: string[], options = {}) {\n const results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const url of urls) {\n try {\n const page = this.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n await this.goTo(page, url);\n const filepath = await this.takeScreenshot(page, url, options);\n results.push({ url, success: true, filepath });\n } catch (error) {\n results.push({\n url,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n async takeResponsiveScreenshots(\n url: string,\n viewports: { width: number; height: number; name: string }[] = [\n { width: 1920, height: 1080, name: \"desktop\" },\n { width: 768, height: 1024, name: \"tablet\" },\n { width: 375, height: 667, name: \"mobile\" },\n ],\n options: {\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n\n const results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const viewport of viewports) {\n try {\n const page = await this.context?.newPage();\n await page.setViewportSize(viewport);\n\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n await page.waitForTimeout(2000);\n\n const filename = `${viewport.name}.png`;\n const filepath = this.getFilePath(filename);\n\n const responsiveScreenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\" as const,\n };\n\n await page.screenshot(responsiveScreenshotOptions);\n\n await page.close();\n\n console.log(`Responsive screenshot saved: ${filepath}`);\n results.push({ viewport: viewport.name, success: true, filepath });\n } catch (error) {\n console.error(\n `Error taking responsive screenshot for ${viewport.name}:`,\n (error as Error).message,\n );\n results.push({\n viewport: viewport.name,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n}\n\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;ACGT,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB,YAAY,SAMT;AACD,OAAK,cAAc,QAAQ,eAAe;AAC1C,OAAK,WAAW,QAAQ,aAAa;AACrC,OAAK,WAAW,QAAQ,YAAY;GAAE,OAAO;GAAM,QAAQ;GAAM;AACjE,OAAK,YAAY,QAAQ,aAAa;AACtC,OAAK,WAAW,QAAQ,aAAa;;CAGvC,MAAM,OAAO;AAEX,MAAI,CAACA,gBAAG,WAAW,KAAK,UAAU,CAChC,iBAAG,UAAU,KAAK,WAAW,EAAE,WAAW,MAAM,CAAC;EAUnD,MAAM,eANa;GACjB;GACA;GACA;GACD,CAGY,KAAK;AAClB,MAAI,CAAC,aACH,OAAM,IAAI,MAAM,6BAA6B,KAAK,cAAc;AAGlE,OAAK,UAAU,MAAM,aAAa,OAAO,EACvC,UAAU,KAAK,UAChB,CAAC;EAEF,MAAM,oBAAoB,MAAM,KAAK,QAAQ,YAAY,EACtD,SAAS,CACT,MAAM,SAAS,KAAK,eAAe,UAAU,UAAU,CAAC;AAE3D,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACnB,WAAW,GAAG,MAAM,iBAAiB;GACtC,CAAC;AAEF,OAAK,OAAO,MAAM,KAAK,SAAS,SAAS;AACzC,OAAK,MAAM,gBAAgB,KAAK,SAAS;;CAG3C,MAAM,QAAQ;AACZ,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;CAI9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;CAGzD,YAAY,UAAkB;AAE5B,SADiBC,kBAAK,KAAK,KAAK,WAAW,SAAS;;CAItD,MAAM,eACJ,MACA,UACA,UAMI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,OAAI,QAAQ,iBAAiB;AAC3B,YAAQ,IAAI,yBAAyB,QAAQ,kBAAkB;AAC/D,UAAM,KAAK,gBAAgB,QAAQ,iBAAiB,EAAE,SAAS,KAAO,CAAC;;GAIzE,MAAM,WACJ,QAAQ,mBAAmB,SAAY,QAAQ,iBAAiB;AAClE,OAAI,WAAW,GAAG;AAChB,YAAQ,IAAI,eAAe,SAAS,wBAAwB;AAC5D,UAAM,KAAK,eAAe,SAAS;;GAIrC,MAAM,WAAW,KAAK,YAAY,SAAS;GAG3C,MAAM,oBAAoB;IACxB,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACR;AAED,SAAM,KAAK,WAAW,kBAAkB;AAExC,WAAQ,IAAI,qBAAqB,WAAW;AAC5C,UAAO;WACA,OAAO;AACd,WAAQ,MACN,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,sBACJ,MACA,UACA,UAGI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,SAAM,KAAK,gBAAgB,UAAU,EAAE,SAAS,KAAO,CAAC;GAExD,MAAM,UAAU,MAAM,KAAK,EAAE,SAAS;AACtC,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,sBAAsB,WAAW;GAGnD,MAAM,WACH,QAAQ,YACT,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GAC5C,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,2BAA2B;IAC/B,MAAM;IACN,MAAM;IACP;AAED,SAAM,QAAQ,WAAW,yBAAyB;AAElD,WAAQ,IAAI,6BAA6B,WAAW;AACpD,UAAO;WACA,OAAO;AACd,WAAQ,MACN,sCAAsC,KAAK,KAAK,CAAC,IAChD,MAAgB,QAClB;AACD,SAAM;YACE;AACR,SAAM,KAAK,OAAO;;;CAItB,MAAM,iBAAiB,MAAgB,UAAU,EAAE,EAAE;EACnD,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,OAAO,KAChB,KAAI;GACF,MAAM,OAAO,KAAK;AAClB,OAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAEzC,SAAM,KAAK,KAAK,MAAM,IAAI;GAC1B,MAAM,WAAW,MAAM,KAAK,eAAe,MAAM,KAAK,QAAQ;AAC9D,WAAQ,KAAK;IAAE;IAAK,SAAS;IAAM;IAAU,CAAC;WACvC,OAAO;AACd,WAAQ,KAAK;IACX;IACA,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAGT,MAAM,0BACJ,KACA,YAA+D;EAC7D;GAAE,OAAO;GAAM,QAAQ;GAAM,MAAM;GAAW;EAC9C;GAAE,OAAO;GAAK,QAAQ;GAAM,MAAM;GAAU;EAC5C;GAAE,OAAO;GAAK,QAAQ;GAAK,MAAM;GAAU;EAC5C,EACD,UAEI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,YAAY,UACrB,KAAI;GACF,MAAM,OAAO,MAAM,KAAK,SAAS,SAAS;AAC1C,SAAM,KAAK,gBAAgB,SAAS;AAEpC,SAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;AACvD,SAAM,KAAK,eAAe,IAAK;GAE/B,MAAM,WAAW,GAAG,SAAS,KAAK;GAClC,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,8BAA8B;IAClC,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACP;AAED,SAAM,KAAK,WAAW,4BAA4B;AAElD,SAAM,KAAK,OAAO;AAElB,WAAQ,IAAI,gCAAgC,WAAW;AACvD,WAAQ,KAAK;IAAE,UAAU,SAAS;IAAM,SAAS;IAAM;IAAU,CAAC;WAC3D,OAAO;AACd,WAAQ,MACN,0CAA0C,SAAS,KAAK,IACvD,MAAgB,QAClB;AACD,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;;AAIX,yBAAe"}
|
package/dist/index.mjs
CHANGED
|
@@ -17,7 +17,6 @@ var ScreenshotTool = class {
|
|
|
17
17
|
headless;
|
|
18
18
|
viewport;
|
|
19
19
|
outputDir;
|
|
20
|
-
quality;
|
|
21
20
|
fullPage;
|
|
22
21
|
browser = null;
|
|
23
22
|
context = null;
|
|
@@ -30,7 +29,6 @@ var ScreenshotTool = class {
|
|
|
30
29
|
height: 1080
|
|
31
30
|
};
|
|
32
31
|
this.outputDir = options.outputDir || "./screenshots";
|
|
33
|
-
this.quality = options.quality || 90;
|
|
34
32
|
this.fullPage = options.fullPage !== false;
|
|
35
33
|
}
|
|
36
34
|
async init() {
|
|
@@ -77,8 +75,11 @@ var ScreenshotTool = class {
|
|
|
77
75
|
const screenshotOptions = {
|
|
78
76
|
path: filepath,
|
|
79
77
|
fullPage: options.fullPage !== void 0 ? options.fullPage : this.fullPage,
|
|
80
|
-
type:
|
|
81
|
-
|
|
78
|
+
type: "png",
|
|
79
|
+
timeout: 6e4,
|
|
80
|
+
mask: options.mask,
|
|
81
|
+
omitBackground: options.omitBackground,
|
|
82
|
+
scale: "css"
|
|
82
83
|
};
|
|
83
84
|
await page.screenshot(screenshotOptions);
|
|
84
85
|
console.log(`Screenshot saved: ${filepath}`);
|
|
@@ -98,8 +99,7 @@ var ScreenshotTool = class {
|
|
|
98
99
|
const filepath = this.getFilePath(filename);
|
|
99
100
|
const elementScreenshotOptions = {
|
|
100
101
|
path: filepath,
|
|
101
|
-
type:
|
|
102
|
-
quality: options.quality || this.quality
|
|
102
|
+
type: "png"
|
|
103
103
|
};
|
|
104
104
|
await element.screenshot(elementScreenshotOptions);
|
|
105
105
|
console.log(`Element screenshot saved: ${filepath}`);
|
|
@@ -162,8 +162,7 @@ var ScreenshotTool = class {
|
|
|
162
162
|
const responsiveScreenshotOptions = {
|
|
163
163
|
path: filepath,
|
|
164
164
|
fullPage: options.fullPage !== void 0 ? options.fullPage : this.fullPage,
|
|
165
|
-
type:
|
|
166
|
-
quality: options.quality || this.quality
|
|
165
|
+
type: "png"
|
|
167
166
|
};
|
|
168
167
|
await page.screenshot(responsiveScreenshotOptions);
|
|
169
168
|
await page.close();
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]","results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]"],"sources":["../src/config.ts","../src/screenshot.ts"],"sourcesContent":["import type { PossiblePromise, UserConfig } from \"./types\";\n\n/**\n * Type helper to make it easier to use vite.config.ts accepts a direct UserConfig object, or a function that returns it. The function receives a ConfigEnv object.\n */\nexport function defineConfig(\n options:\n | PossiblePromise<UserConfig | Array<UserConfig>>\n | (() => PossiblePromise<UserConfig | Array<UserConfig>>),\n): typeof options {\n return options;\n}\n","import fs from \"node:fs\";\nimport path from \"node:path\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\n\nclass ScreenshotTool {\n browserType: string;\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n quality: number;\n fullPage: boolean;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n constructor(options: {\n browserType?: string;\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n quality?: number;\n fullPage?: boolean;\n }) {\n this.browserType = options.browserType || \"chromium\";\n this.headless = options.headless !== false; // Default to headless\n this.viewport = options.viewport || { width: 1920, height: 1080 };\n this.outputDir = options.outputDir || \"./screenshots\";\n this.quality = options.quality || 90;\n this.fullPage = options.fullPage !== false; // Default to full page\n }\n\n async init() {\n // Create output directory if it doesn't exist\n if (!fs.existsSync(this.outputDir)) {\n fs.mkdirSync(this.outputDir, { recursive: true });\n }\n\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass =\n browserMap[this.browserType as keyof typeof browserMap];\n if (!browserClass) {\n throw new Error(`Unsupported browser type: ${this.browserType}`);\n }\n\n this.browser = await browserClass.launch({\n headless: this.headless,\n });\n\n const defaultUserAgent = (await this.browser.newContext())\n .newPage()\n .then((page) => page.evaluate(() => navigator.userAgent));\n\n this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 1,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n });\n\n this.page = await this.context?.newPage();\n this.page?.setViewportSize(this.viewport);\n }\n\n async close() {\n if (this.browser) {\n await this.browser.close();\n }\n }\n\n async goTo(page: Page, url: string) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n }\n\n getFilePath(filename: string) {\n const filepath = path.join(this.outputDir, filename);\n return filepath;\n }\n\n async takeScreenshot(\n page: Page,\n filename: string,\n options: {\n fullPage?: boolean;\n type?: string;\n quality?: number;\n waitForSelector?: string;\n waitForTimeout?: number;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for selector if specified\n if (options.waitForSelector) {\n console.log(`Waiting for selector: ${options.waitForSelector}`);\n await page.waitForSelector(options.waitForSelector, { timeout: 10000 });\n }\n\n // Wait for custom timeout or default\n const waitTime =\n options.waitForTimeout !== undefined ? options.waitForTimeout : 0;\n if (waitTime > 0) {\n console.log(`Waiting for ${waitTime}ms for dynamic content`);\n await page.waitForTimeout(waitTime);\n }\n\n // Generate filename\n const filepath = this.getFilePath(filename);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: (options.type as \"jpeg\" | \"png\") || \"jpeg\",\n quality: (options.quality as number) || this.quality,\n } satisfies PageScreenshotOptions;\n\n await page.screenshot(screenshotOptions);\n\n console.log(`Screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeElementScreenshot(\n page: Page,\n selector: string,\n options: {\n filename?: string;\n fullPage?: boolean;\n type?: string;\n quality?: number;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for element to be visible\n await page.waitForSelector(selector, { timeout: 10000 });\n\n const element = await page.$(selector);\n if (!element) {\n throw new Error(`Element not found: ${selector}`);\n }\n\n const filename =\n (options.filename as string | undefined) ||\n `${selector.replace(/[^a-zA-Z0-9]/g, \"_\")}.png`;\n const filepath = this.getFilePath(filename);\n\n const elementScreenshotOptions = {\n path: filepath,\n type: (options.type as \"jpeg\" | \"png\") || \"jpeg\",\n quality: (options.quality as number) || this.quality,\n } satisfies PageScreenshotOptions;\n\n await element.screenshot(elementScreenshotOptions);\n\n console.log(`Element screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking element screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n } finally {\n await page.close();\n }\n }\n\n async batchScreenshots(urls: string[], options = {}) {\n const results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const url of urls) {\n try {\n const page = this.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n await this.goTo(page, url);\n const filepath = await this.takeScreenshot(page, url, options);\n results.push({ url, success: true, filepath });\n } catch (error) {\n results.push({\n url,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n async takeResponsiveScreenshots(\n url: string,\n viewports: { width: number; height: number; name: string }[] = [\n { width: 1920, height: 1080, name: \"desktop\" },\n { width: 768, height: 1024, name: \"tablet\" },\n { width: 375, height: 667, name: \"mobile\" },\n ],\n options: {\n fullPage?: boolean;\n type?: string;\n quality?: number;\n } = {},\n ) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n\n const results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const viewport of viewports) {\n try {\n const page = await this.context?.newPage();\n await page.setViewportSize(viewport);\n\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n await page.waitForTimeout(2000);\n\n const filename = `${viewport.name}.png`;\n const filepath = this.getFilePath(filename);\n\n const responsiveScreenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: (options.type as \"jpeg\" | \"png\") || \"png\",\n quality: (options.quality as number) || this.quality,\n };\n\n await page.screenshot(responsiveScreenshotOptions);\n\n await page.close();\n\n console.log(`Responsive screenshot saved: ${filepath}`);\n results.push({ viewport: viewport.name, success: true, filepath });\n } catch (error) {\n console.error(\n `Error taking responsive screenshot for ${viewport.name}:`,\n (error as Error).message,\n );\n results.push({\n viewport: viewport.name,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n}\n\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;ACET,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB,YAAY,SAOT;AACD,OAAK,cAAc,QAAQ,eAAe;AAC1C,OAAK,WAAW,QAAQ,aAAa;AACrC,OAAK,WAAW,QAAQ,YAAY;GAAE,OAAO;GAAM,QAAQ;GAAM;AACjE,OAAK,YAAY,QAAQ,aAAa;AACtC,OAAK,UAAU,QAAQ,WAAW;AAClC,OAAK,WAAW,QAAQ,aAAa;;CAGvC,MAAM,OAAO;AAEX,MAAI,CAAC,GAAG,WAAW,KAAK,UAAU,CAChC,IAAG,UAAU,KAAK,WAAW,EAAE,WAAW,MAAM,CAAC;EAUnD,MAAM,eANa;GACjB;GACA;GACA;GACD,CAGY,KAAK;AAClB,MAAI,CAAC,aACH,OAAM,IAAI,MAAM,6BAA6B,KAAK,cAAc;AAGlE,OAAK,UAAU,MAAM,aAAa,OAAO,EACvC,UAAU,KAAK,UAChB,CAAC;EAEF,MAAM,oBAAoB,MAAM,KAAK,QAAQ,YAAY,EACtD,SAAS,CACT,MAAM,SAAS,KAAK,eAAe,UAAU,UAAU,CAAC;AAE3D,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACnB,WAAW,GAAG,MAAM,iBAAiB;GACtC,CAAC;AAEF,OAAK,OAAO,MAAM,KAAK,SAAS,SAAS;AACzC,OAAK,MAAM,gBAAgB,KAAK,SAAS;;CAG3C,MAAM,QAAQ;AACZ,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;CAI9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;CAGzD,YAAY,UAAkB;AAE5B,SADiB,KAAK,KAAK,KAAK,WAAW,SAAS;;CAItD,MAAM,eACJ,MACA,UACA,UAMI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,OAAI,QAAQ,iBAAiB;AAC3B,YAAQ,IAAI,yBAAyB,QAAQ,kBAAkB;AAC/D,UAAM,KAAK,gBAAgB,QAAQ,iBAAiB,EAAE,SAAS,KAAO,CAAC;;GAIzE,MAAM,WACJ,QAAQ,mBAAmB,SAAY,QAAQ,iBAAiB;AAClE,OAAI,WAAW,GAAG;AAChB,YAAQ,IAAI,eAAe,SAAS,wBAAwB;AAC5D,UAAM,KAAK,eAAe,SAAS;;GAIrC,MAAM,WAAW,KAAK,YAAY,SAAS;GAG3C,MAAM,oBAAoB;IACxB,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAO,QAAQ,QAA2B;IAC1C,SAAU,QAAQ,WAAsB,KAAK;IAC9C;AAED,SAAM,KAAK,WAAW,kBAAkB;AAExC,WAAQ,IAAI,qBAAqB,WAAW;AAC5C,UAAO;WACA,OAAO;AACd,WAAQ,MACN,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,sBACJ,MACA,UACA,UAKI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,SAAM,KAAK,gBAAgB,UAAU,EAAE,SAAS,KAAO,CAAC;GAExD,MAAM,UAAU,MAAM,KAAK,EAAE,SAAS;AACtC,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,sBAAsB,WAAW;GAGnD,MAAM,WACH,QAAQ,YACT,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GAC5C,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,2BAA2B;IAC/B,MAAM;IACN,MAAO,QAAQ,QAA2B;IAC1C,SAAU,QAAQ,WAAsB,KAAK;IAC9C;AAED,SAAM,QAAQ,WAAW,yBAAyB;AAElD,WAAQ,IAAI,6BAA6B,WAAW;AACpD,UAAO;WACA,OAAO;AACd,WAAQ,MACN,sCAAsC,KAAK,KAAK,CAAC,IAChD,MAAgB,QAClB;AACD,SAAM;YACE;AACR,SAAM,KAAK,OAAO;;;CAItB,MAAM,iBAAiB,MAAgB,UAAU,EAAE,EAAE;EACnD,MAAMA,UAKA,EAAE;AAER,OAAK,MAAM,OAAO,KAChB,KAAI;GACF,MAAM,OAAO,KAAK;AAClB,OAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAEzC,SAAM,KAAK,KAAK,MAAM,IAAI;GAC1B,MAAM,WAAW,MAAM,KAAK,eAAe,MAAM,KAAK,QAAQ;AAC9D,WAAQ,KAAK;IAAE;IAAK,SAAS;IAAM;IAAU,CAAC;WACvC,OAAO;AACd,WAAQ,KAAK;IACX;IACA,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAGT,MAAM,0BACJ,KACA,YAA+D;EAC7D;GAAE,OAAO;GAAM,QAAQ;GAAM,MAAM;GAAW;EAC9C;GAAE,OAAO;GAAK,QAAQ;GAAM,MAAM;GAAU;EAC5C;GAAE,OAAO;GAAK,QAAQ;GAAK,MAAM;GAAU;EAC5C,EACD,UAII,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,YAAY,UACrB,KAAI;GACF,MAAM,OAAO,MAAM,KAAK,SAAS,SAAS;AAC1C,SAAM,KAAK,gBAAgB,SAAS;AAEpC,SAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;AACvD,SAAM,KAAK,eAAe,IAAK;GAE/B,MAAM,WAAW,GAAG,SAAS,KAAK;GAClC,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,8BAA8B;IAClC,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAO,QAAQ,QAA2B;IAC1C,SAAU,QAAQ,WAAsB,KAAK;IAC9C;AAED,SAAM,KAAK,WAAW,4BAA4B;AAElD,SAAM,KAAK,OAAO;AAElB,WAAQ,IAAI,gCAAgC,WAAW;AACvD,WAAQ,KAAK;IAAE,UAAU,SAAS;IAAM,SAAS;IAAM;IAAU,CAAC;WAC3D,OAAO;AACd,WAAQ,MACN,0CAA0C,SAAS,KAAK,IACvD,MAAgB,QAClB;AACD,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;;AAIX,yBAAe"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]","results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[]"],"sources":["../src/config.ts","../src/screenshot.ts"],"sourcesContent":["import type { PossiblePromise, UserConfig } from \"./types\";\n\n/**\n * Type helper to make it easier to use vite.config.ts accepts a direct UserConfig object, or a function that returns it. The function receives a ConfigEnv object.\n */\nexport function defineConfig(\n options:\n | PossiblePromise<UserConfig | Array<UserConfig>>\n | (() => PossiblePromise<UserConfig | Array<UserConfig>>),\n): typeof options {\n return options;\n}\n","import fs from \"node:fs\";\nimport path from \"node:path\";\nimport {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n Locator,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright-core\";\n\nclass ScreenshotTool {\n browserType: string;\n headless: boolean;\n viewport: { width: number; height: number };\n outputDir: string;\n fullPage: boolean;\n browser: Browser | null = null;\n context: BrowserContext | null = null;\n page: Page | null = null;\n constructor(options: {\n browserType?: string;\n headless?: boolean;\n viewport?: { width: number; height: number };\n outputDir?: string;\n fullPage?: boolean;\n }) {\n this.browserType = options.browserType || \"chromium\";\n this.headless = options.headless !== false; // Default to headless\n this.viewport = options.viewport || { width: 1920, height: 1080 };\n this.outputDir = options.outputDir || \"./screenshots\";\n this.fullPage = options.fullPage !== false; // Default to full page\n }\n\n async init() {\n // Create output directory if it doesn't exist\n if (!fs.existsSync(this.outputDir)) {\n fs.mkdirSync(this.outputDir, { recursive: true });\n }\n\n // Launch browser based on type\n const browserMap = {\n chromium,\n firefox,\n webkit,\n };\n\n const browserClass =\n browserMap[this.browserType as keyof typeof browserMap];\n if (!browserClass) {\n throw new Error(`Unsupported browser type: ${this.browserType}`);\n }\n\n this.browser = await browserClass.launch({\n headless: this.headless,\n });\n\n const defaultUserAgent = (await this.browser.newContext())\n .newPage()\n .then((page) => page.evaluate(() => navigator.userAgent));\n\n this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 1,\n userAgent: `${await defaultUserAgent} CappaStorybook`,\n });\n\n this.page = await this.context?.newPage();\n this.page?.setViewportSize(this.viewport);\n }\n\n async close() {\n if (this.browser) {\n await this.browser.close();\n }\n }\n\n async goTo(page: Page, url: string) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n }\n\n getFilePath(filename: string) {\n const filepath = path.join(this.outputDir, filename);\n return filepath;\n }\n\n async takeScreenshot(\n page: Page,\n filename: string,\n options: {\n fullPage?: boolean;\n waitForSelector?: string;\n waitForTimeout?: number;\n mask?: Locator[];\n omitBackground?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for selector if specified\n if (options.waitForSelector) {\n console.log(`Waiting for selector: ${options.waitForSelector}`);\n await page.waitForSelector(options.waitForSelector, { timeout: 10000 });\n }\n\n // Wait for custom timeout or default\n const waitTime =\n options.waitForTimeout !== undefined ? options.waitForTimeout : 0;\n if (waitTime > 0) {\n console.log(`Waiting for ${waitTime}ms for dynamic content`);\n await page.waitForTimeout(waitTime);\n }\n\n // Generate filename\n const filepath = this.getFilePath(filename);\n\n // Take screenshot\n const screenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\",\n timeout: 60000,\n mask: options.mask,\n omitBackground: options.omitBackground,\n scale: \"css\" as const,\n } satisfies PageScreenshotOptions;\n\n await page.screenshot(screenshotOptions);\n\n console.log(`Screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n }\n }\n\n async takeElementScreenshot(\n page: Page,\n selector: string,\n options: {\n filename?: string;\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.browser) {\n throw new Error(\"Browser not initialized\");\n }\n\n try {\n // Wait for element to be visible\n await page.waitForSelector(selector, { timeout: 10000 });\n\n const element = await page.$(selector);\n if (!element) {\n throw new Error(`Element not found: ${selector}`);\n }\n\n const filename =\n (options.filename as string | undefined) ||\n `${selector.replace(/[^a-zA-Z0-9]/g, \"_\")}.png`;\n const filepath = this.getFilePath(filename);\n\n const elementScreenshotOptions = {\n path: filepath,\n type: \"png\",\n } satisfies PageScreenshotOptions;\n\n await element.screenshot(elementScreenshotOptions);\n\n console.log(`Element screenshot saved: ${filepath}`);\n return filepath;\n } catch (error) {\n console.error(\n `Error taking element screenshot of ${page.url()}:`,\n (error as Error).message,\n );\n throw error;\n } finally {\n await page.close();\n }\n }\n\n async batchScreenshots(urls: string[], options = {}) {\n const results: {\n url: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const url of urls) {\n try {\n const page = this.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n await this.goTo(page, url);\n const filepath = await this.takeScreenshot(page, url, options);\n results.push({ url, success: true, filepath });\n } catch (error) {\n results.push({\n url,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n\n async takeResponsiveScreenshots(\n url: string,\n viewports: { width: number; height: number; name: string }[] = [\n { width: 1920, height: 1080, name: \"desktop\" },\n { width: 768, height: 1024, name: \"tablet\" },\n { width: 375, height: 667, name: \"mobile\" },\n ],\n options: {\n fullPage?: boolean;\n } = {},\n ) {\n if (!this.context) {\n throw new Error(\"Browser not initialized\");\n }\n\n const results: {\n viewport: string;\n success: boolean;\n filepath: string;\n error?: string;\n }[] = [];\n\n for (const viewport of viewports) {\n try {\n const page = await this.context?.newPage();\n await page.setViewportSize(viewport);\n\n await page.goto(url, { waitUntil: \"domcontentloaded\" });\n await page.waitForTimeout(2000);\n\n const filename = `${viewport.name}.png`;\n const filepath = this.getFilePath(filename);\n\n const responsiveScreenshotOptions = {\n path: filepath,\n fullPage:\n (options.fullPage as boolean) !== undefined\n ? options.fullPage\n : this.fullPage,\n type: \"png\" as const,\n };\n\n await page.screenshot(responsiveScreenshotOptions);\n\n await page.close();\n\n console.log(`Responsive screenshot saved: ${filepath}`);\n results.push({ viewport: viewport.name, success: true, filepath });\n } catch (error) {\n console.error(\n `Error taking responsive screenshot for ${viewport.name}:`,\n (error as Error).message,\n );\n results.push({\n viewport: viewport.name,\n success: false,\n error: (error as Error).message,\n filepath: \"\",\n });\n }\n }\n\n return results;\n }\n}\n\nexport default ScreenshotTool;\n"],"mappings":";;;;;;;;AAKA,SAAgB,aACd,SAGgB;AAChB,QAAO;;;;;ACGT,IAAM,iBAAN,MAAqB;CACnB;CACA;CACA;CACA;CACA;CACA,UAA0B;CAC1B,UAAiC;CACjC,OAAoB;CACpB,YAAY,SAMT;AACD,OAAK,cAAc,QAAQ,eAAe;AAC1C,OAAK,WAAW,QAAQ,aAAa;AACrC,OAAK,WAAW,QAAQ,YAAY;GAAE,OAAO;GAAM,QAAQ;GAAM;AACjE,OAAK,YAAY,QAAQ,aAAa;AACtC,OAAK,WAAW,QAAQ,aAAa;;CAGvC,MAAM,OAAO;AAEX,MAAI,CAAC,GAAG,WAAW,KAAK,UAAU,CAChC,IAAG,UAAU,KAAK,WAAW,EAAE,WAAW,MAAM,CAAC;EAUnD,MAAM,eANa;GACjB;GACA;GACA;GACD,CAGY,KAAK;AAClB,MAAI,CAAC,aACH,OAAM,IAAI,MAAM,6BAA6B,KAAK,cAAc;AAGlE,OAAK,UAAU,MAAM,aAAa,OAAO,EACvC,UAAU,KAAK,UAChB,CAAC;EAEF,MAAM,oBAAoB,MAAM,KAAK,QAAQ,YAAY,EACtD,SAAS,CACT,MAAM,SAAS,KAAK,eAAe,UAAU,UAAU,CAAC;AAE3D,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACnB,WAAW,GAAG,MAAM,iBAAiB;GACtC,CAAC;AAEF,OAAK,OAAO,MAAM,KAAK,SAAS,SAAS;AACzC,OAAK,MAAM,gBAAgB,KAAK,SAAS;;CAG3C,MAAM,QAAQ;AACZ,MAAI,KAAK,QACP,OAAM,KAAK,QAAQ,OAAO;;CAI9B,MAAM,KAAK,MAAY,KAAa;AAClC,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAE5C,QAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;;CAGzD,YAAY,UAAkB;AAE5B,SADiB,KAAK,KAAK,KAAK,WAAW,SAAS;;CAItD,MAAM,eACJ,MACA,UACA,UAMI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,OAAI,QAAQ,iBAAiB;AAC3B,YAAQ,IAAI,yBAAyB,QAAQ,kBAAkB;AAC/D,UAAM,KAAK,gBAAgB,QAAQ,iBAAiB,EAAE,SAAS,KAAO,CAAC;;GAIzE,MAAM,WACJ,QAAQ,mBAAmB,SAAY,QAAQ,iBAAiB;AAClE,OAAI,WAAW,GAAG;AAChB,YAAQ,IAAI,eAAe,SAAS,wBAAwB;AAC5D,UAAM,KAAK,eAAe,SAAS;;GAIrC,MAAM,WAAW,KAAK,YAAY,SAAS;GAG3C,MAAM,oBAAoB;IACxB,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACN,SAAS;IACT,MAAM,QAAQ;IACd,gBAAgB,QAAQ;IACxB,OAAO;IACR;AAED,SAAM,KAAK,WAAW,kBAAkB;AAExC,WAAQ,IAAI,qBAAqB,WAAW;AAC5C,UAAO;WACA,OAAO;AACd,WAAQ,MACN,8BAA8B,KAAK,KAAK,CAAC,IACxC,MAAgB,QAClB;AACD,SAAM;;;CAIV,MAAM,sBACJ,MACA,UACA,UAGI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;AAG5C,MAAI;AAEF,SAAM,KAAK,gBAAgB,UAAU,EAAE,SAAS,KAAO,CAAC;GAExD,MAAM,UAAU,MAAM,KAAK,EAAE,SAAS;AACtC,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,sBAAsB,WAAW;GAGnD,MAAM,WACH,QAAQ,YACT,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GAC5C,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,2BAA2B;IAC/B,MAAM;IACN,MAAM;IACP;AAED,SAAM,QAAQ,WAAW,yBAAyB;AAElD,WAAQ,IAAI,6BAA6B,WAAW;AACpD,UAAO;WACA,OAAO;AACd,WAAQ,MACN,sCAAsC,KAAK,KAAK,CAAC,IAChD,MAAgB,QAClB;AACD,SAAM;YACE;AACR,SAAM,KAAK,OAAO;;;CAItB,MAAM,iBAAiB,MAAgB,UAAU,EAAE,EAAE;EACnD,MAAMA,UAKA,EAAE;AAER,OAAK,MAAM,OAAO,KAChB,KAAI;GACF,MAAM,OAAO,KAAK;AAClB,OAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAEzC,SAAM,KAAK,KAAK,MAAM,IAAI;GAC1B,MAAM,WAAW,MAAM,KAAK,eAAe,MAAM,KAAK,QAAQ;AAC9D,WAAQ,KAAK;IAAE;IAAK,SAAS;IAAM;IAAU,CAAC;WACvC,OAAO;AACd,WAAQ,KAAK;IACX;IACA,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;CAGT,MAAM,0BACJ,KACA,YAA+D;EAC7D;GAAE,OAAO;GAAM,QAAQ;GAAM,MAAM;GAAW;EAC9C;GAAE,OAAO;GAAK,QAAQ;GAAM,MAAM;GAAU;EAC5C;GAAE,OAAO;GAAK,QAAQ;GAAK,MAAM;GAAU;EAC5C,EACD,UAEI,EAAE,EACN;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAMC,UAKA,EAAE;AAER,OAAK,MAAM,YAAY,UACrB,KAAI;GACF,MAAM,OAAO,MAAM,KAAK,SAAS,SAAS;AAC1C,SAAM,KAAK,gBAAgB,SAAS;AAEpC,SAAM,KAAK,KAAK,KAAK,EAAE,WAAW,oBAAoB,CAAC;AACvD,SAAM,KAAK,eAAe,IAAK;GAE/B,MAAM,WAAW,GAAG,SAAS,KAAK;GAClC,MAAM,WAAW,KAAK,YAAY,SAAS;GAE3C,MAAM,8BAA8B;IAClC,MAAM;IACN,UACG,QAAQ,aAAyB,SAC9B,QAAQ,WACR,KAAK;IACX,MAAM;IACP;AAED,SAAM,KAAK,WAAW,4BAA4B;AAElD,SAAM,KAAK,OAAO;AAElB,WAAQ,IAAI,gCAAgC,WAAW;AACvD,WAAQ,KAAK;IAAE,UAAU,SAAS;IAAM,SAAS;IAAM;IAAU,CAAC;WAC3D,OAAO;AACd,WAAQ,MACN,0CAA0C,SAAS,KAAK,IACvD,MAAgB,QAClB;AACD,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;;AAIX,yBAAe"}
|
package/package.json
CHANGED
package/src/screenshot.ts
CHANGED
|
@@ -5,6 +5,7 @@ import {
|
|
|
5
5
|
type BrowserContext,
|
|
6
6
|
chromium,
|
|
7
7
|
firefox,
|
|
8
|
+
Locator,
|
|
8
9
|
type Page,
|
|
9
10
|
type PageScreenshotOptions,
|
|
10
11
|
webkit,
|
|
@@ -15,7 +16,6 @@ class ScreenshotTool {
|
|
|
15
16
|
headless: boolean;
|
|
16
17
|
viewport: { width: number; height: number };
|
|
17
18
|
outputDir: string;
|
|
18
|
-
quality: number;
|
|
19
19
|
fullPage: boolean;
|
|
20
20
|
browser: Browser | null = null;
|
|
21
21
|
context: BrowserContext | null = null;
|
|
@@ -25,14 +25,12 @@ class ScreenshotTool {
|
|
|
25
25
|
headless?: boolean;
|
|
26
26
|
viewport?: { width: number; height: number };
|
|
27
27
|
outputDir?: string;
|
|
28
|
-
quality?: number;
|
|
29
28
|
fullPage?: boolean;
|
|
30
29
|
}) {
|
|
31
30
|
this.browserType = options.browserType || "chromium";
|
|
32
31
|
this.headless = options.headless !== false; // Default to headless
|
|
33
32
|
this.viewport = options.viewport || { width: 1920, height: 1080 };
|
|
34
33
|
this.outputDir = options.outputDir || "./screenshots";
|
|
35
|
-
this.quality = options.quality || 90;
|
|
36
34
|
this.fullPage = options.fullPage !== false; // Default to full page
|
|
37
35
|
}
|
|
38
36
|
|
|
@@ -96,10 +94,10 @@ class ScreenshotTool {
|
|
|
96
94
|
filename: string,
|
|
97
95
|
options: {
|
|
98
96
|
fullPage?: boolean;
|
|
99
|
-
type?: string;
|
|
100
|
-
quality?: number;
|
|
101
97
|
waitForSelector?: string;
|
|
102
98
|
waitForTimeout?: number;
|
|
99
|
+
mask?: Locator[];
|
|
100
|
+
omitBackground?: boolean;
|
|
103
101
|
} = {},
|
|
104
102
|
) {
|
|
105
103
|
if (!this.browser) {
|
|
@@ -131,8 +129,11 @@ class ScreenshotTool {
|
|
|
131
129
|
(options.fullPage as boolean) !== undefined
|
|
132
130
|
? options.fullPage
|
|
133
131
|
: this.fullPage,
|
|
134
|
-
type:
|
|
135
|
-
|
|
132
|
+
type: "png",
|
|
133
|
+
timeout: 60000,
|
|
134
|
+
mask: options.mask,
|
|
135
|
+
omitBackground: options.omitBackground,
|
|
136
|
+
scale: "css" as const,
|
|
136
137
|
} satisfies PageScreenshotOptions;
|
|
137
138
|
|
|
138
139
|
await page.screenshot(screenshotOptions);
|
|
@@ -154,8 +155,6 @@ class ScreenshotTool {
|
|
|
154
155
|
options: {
|
|
155
156
|
filename?: string;
|
|
156
157
|
fullPage?: boolean;
|
|
157
|
-
type?: string;
|
|
158
|
-
quality?: number;
|
|
159
158
|
} = {},
|
|
160
159
|
) {
|
|
161
160
|
if (!this.browser) {
|
|
@@ -178,8 +177,7 @@ class ScreenshotTool {
|
|
|
178
177
|
|
|
179
178
|
const elementScreenshotOptions = {
|
|
180
179
|
path: filepath,
|
|
181
|
-
type:
|
|
182
|
-
quality: (options.quality as number) || this.quality,
|
|
180
|
+
type: "png",
|
|
183
181
|
} satisfies PageScreenshotOptions;
|
|
184
182
|
|
|
185
183
|
await element.screenshot(elementScreenshotOptions);
|
|
@@ -236,8 +234,6 @@ class ScreenshotTool {
|
|
|
236
234
|
],
|
|
237
235
|
options: {
|
|
238
236
|
fullPage?: boolean;
|
|
239
|
-
type?: string;
|
|
240
|
-
quality?: number;
|
|
241
237
|
} = {},
|
|
242
238
|
) {
|
|
243
239
|
if (!this.context) {
|
|
@@ -268,8 +264,7 @@ class ScreenshotTool {
|
|
|
268
264
|
(options.fullPage as boolean) !== undefined
|
|
269
265
|
? options.fullPage
|
|
270
266
|
: this.fullPage,
|
|
271
|
-
type:
|
|
272
|
-
quality: (options.quality as number) || this.quality,
|
|
267
|
+
type: "png" as const,
|
|
273
268
|
};
|
|
274
269
|
|
|
275
270
|
await page.screenshot(responsiveScreenshotOptions);
|
package/src/types.ts
CHANGED
|
@@ -26,12 +26,12 @@ export type UserConfig = {
|
|
|
26
26
|
|
|
27
27
|
export type ScreenshotOptions = {
|
|
28
28
|
fullPage?: boolean;
|
|
29
|
-
type?: string;
|
|
30
|
-
quality?: number;
|
|
31
29
|
waitForSelector?: string;
|
|
32
30
|
waitForTimeout?: number;
|
|
33
31
|
delay?: number;
|
|
34
32
|
skip?: boolean;
|
|
33
|
+
mask?: string[];
|
|
34
|
+
omitBackground?: boolean;
|
|
35
35
|
};
|
|
36
36
|
|
|
37
37
|
export interface Exposed {
|