@cappa/core 0.0.11 → 0.0.13
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 -17
- package/CHANGELOG.md +12 -0
- package/dist/index.d.mts +2 -4
- package/dist/index.d.ts +2 -4
- package/dist/index.js +19 -17
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +14 -12
- package/dist/index.mjs.map +1 -1
- package/package.json +8 -7
- package/src/config.ts +2 -5
- package/src/index.ts +2 -2
- package/src/plugin.ts +2 -5
- package/src/screenshot.ts +19 -33
- package/src/types.ts +3 -1
- package/tsconfig.json +1 -6
- package/src/utils/types.ts +0 -13
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,14 +1,10 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
-
> @cappa/core@0.0.
|
|
3
|
+
> @cappa/core@0.0.12 build /home/tim/code/work/cappa/packages/core
|
|
4
4
|
> tsdown
|
|
5
5
|
|
|
6
|
-
[34mℹ[39m tsdown [2mv0.14.1[22m powered by rolldown [2mv1.0.0-beta.
|
|
7
|
-
[34mℹ[39m Using tsdown config: [4m/home/tim/cappa/packages/core/tsdown.config.ts[24m
|
|
8
|
-
(node:239491) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/tim/cappa/packages/core/tsdown.config.ts is not specified and it doesn't parse as CommonJS.
|
|
9
|
-
Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
|
|
10
|
-
To eliminate this warning, add "type": "module" to /home/tim/cappa/packages/core/package.json.
|
|
11
|
-
(Use `node --trace-warnings ...` to show where the warning was created)
|
|
6
|
+
[34mℹ[39m tsdown [2mv0.14.1[22m powered by rolldown [2mv1.0.0-beta.38[22m
|
|
7
|
+
[34mℹ[39m Using tsdown config: [4m/home/tim/code/work/cappa/packages/core/tsdown.config.ts[24m
|
|
12
8
|
[34mℹ[39m entry: [34msrc/index.ts[39m
|
|
13
9
|
[34mℹ[39m tsconfig: [34mtsconfig.json[39m
|
|
14
10
|
[34mℹ[39m Build start
|
|
@@ -17,15 +13,15 @@ To eliminate this warning, add "type": "module" to /home/tim/cappa/packages/core
|
|
|
17
13
|
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
18
14
|
[33mWarning: Invalid input options (1 issue found)
|
|
19
15
|
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
20
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[1mindex.js[22m [2m
|
|
21
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [2m12.
|
|
22
|
-
[34mℹ[39m [33m[CJS][39m 2 files, total: 19.
|
|
16
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[1mindex.js[22m [2m 7.05 kB[22m [2m│ gzip: 2.15 kB[22m
|
|
17
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [2m12.54 kB[22m [2m│ gzip: 3.39 kB[22m
|
|
18
|
+
[34mℹ[39m [33m[CJS][39m 2 files, total: 19.60 kB
|
|
23
19
|
[33mWarning: Invalid input options (1 issue found)
|
|
24
20
|
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
25
|
-
[34mℹ[39m [
|
|
26
|
-
[34mℹ[39m [
|
|
27
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[
|
|
28
|
-
[34mℹ[39m [34m[ESM][39m
|
|
29
|
-
[34mℹ[39m [
|
|
30
|
-
[34mℹ[39m [
|
|
31
|
-
[32m✔[39m Build complete in [
|
|
21
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[32m[1mindex.d.ts[22m[39m [2m3.74 kB[22m [2m│ gzip: 1.29 kB[22m
|
|
22
|
+
[34mℹ[39m [33m[CJS][39m 1 files, total: 3.74 kB
|
|
23
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[1mindex.mjs[22m [2m 5.84 kB[22m [2m│ gzip: 1.71 kB[22m
|
|
24
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22mindex.mjs.map [2m12.50 kB[22m [2m│ gzip: 3.38 kB[22m
|
|
25
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[32m[1mindex.d.mts[22m[39m [2m 3.74 kB[22m [2m│ gzip: 1.29 kB[22m
|
|
26
|
+
[34mℹ[39m [34m[ESM][39m 3 files, total: 22.07 kB
|
|
27
|
+
[32m✔[39m Build complete in [32m958ms[39m
|
package/CHANGELOG.md
CHANGED
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Browser, BrowserContext, Page } from "playwright";
|
|
1
|
+
import { Browser, BrowserContext, Page } from "playwright-core";
|
|
2
2
|
|
|
3
3
|
//#region src/screenshot.d.ts
|
|
4
4
|
declare class ScreenshotTool {
|
|
@@ -84,10 +84,8 @@ type PluginDef = {
|
|
|
84
84
|
*/
|
|
85
85
|
type Plugin<Config = any> = (config?: Config) => PluginDef;
|
|
86
86
|
//#endregion
|
|
87
|
-
//#region src/utils/types.d.ts
|
|
88
|
-
type PossiblePromise<T> = Promise<T> | T;
|
|
89
|
-
//#endregion
|
|
90
87
|
//#region src/types.d.ts
|
|
88
|
+
type PossiblePromise<T> = Promise<T> | T;
|
|
91
89
|
/**
|
|
92
90
|
* Config used in `cappa.config.ts`
|
|
93
91
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Browser, BrowserContext, Page } from "playwright";
|
|
1
|
+
import { Browser, BrowserContext, Page } from "playwright-core";
|
|
2
2
|
|
|
3
3
|
//#region src/screenshot.d.ts
|
|
4
4
|
declare class ScreenshotTool {
|
|
@@ -84,10 +84,8 @@ type PluginDef = {
|
|
|
84
84
|
*/
|
|
85
85
|
type Plugin<Config = any> = (config?: Config) => PluginDef;
|
|
86
86
|
//#endregion
|
|
87
|
-
//#region src/utils/types.d.ts
|
|
88
|
-
type PossiblePromise<T> = Promise<T> | T;
|
|
89
|
-
//#endregion
|
|
90
87
|
//#region src/types.d.ts
|
|
88
|
+
type PossiblePromise<T> = Promise<T> | T;
|
|
91
89
|
/**
|
|
92
90
|
* Config used in `cappa.config.ts`
|
|
93
91
|
*
|
package/dist/index.js
CHANGED
|
@@ -21,13 +21,22 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
21
21
|
}) : target, mod));
|
|
22
22
|
|
|
23
23
|
//#endregion
|
|
24
|
-
let playwright = require("playwright");
|
|
25
|
-
playwright = __toESM(playwright);
|
|
26
|
-
let node_path = require("node:path");
|
|
27
|
-
node_path = __toESM(node_path);
|
|
28
24
|
let node_fs = require("node:fs");
|
|
29
25
|
node_fs = __toESM(node_fs);
|
|
26
|
+
let node_path = require("node:path");
|
|
27
|
+
node_path = __toESM(node_path);
|
|
28
|
+
let playwright_core = require("playwright-core");
|
|
29
|
+
playwright_core = __toESM(playwright_core);
|
|
30
|
+
|
|
31
|
+
//#region src/config.ts
|
|
32
|
+
/**
|
|
33
|
+
* 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.
|
|
34
|
+
*/
|
|
35
|
+
function defineConfig(options) {
|
|
36
|
+
return options;
|
|
37
|
+
}
|
|
30
38
|
|
|
39
|
+
//#endregion
|
|
31
40
|
//#region src/screenshot.ts
|
|
32
41
|
var ScreenshotTool = class {
|
|
33
42
|
browserType;
|
|
@@ -53,15 +62,17 @@ var ScreenshotTool = class {
|
|
|
53
62
|
async init() {
|
|
54
63
|
if (!node_fs.default.existsSync(this.outputDir)) node_fs.default.mkdirSync(this.outputDir, { recursive: true });
|
|
55
64
|
const browserClass = {
|
|
56
|
-
chromium:
|
|
57
|
-
firefox:
|
|
58
|
-
webkit:
|
|
65
|
+
chromium: playwright_core.chromium,
|
|
66
|
+
firefox: playwright_core.firefox,
|
|
67
|
+
webkit: playwright_core.webkit
|
|
59
68
|
}[this.browserType];
|
|
60
69
|
if (!browserClass) throw new Error(`Unsupported browser type: ${this.browserType}`);
|
|
61
70
|
this.browser = await browserClass.launch({ headless: this.headless });
|
|
71
|
+
const defaultUserAgent = (await this.browser.newContext()).newPage().then((page) => page.evaluate(() => navigator.userAgent));
|
|
62
72
|
this.context = await this.browser.newContext({
|
|
63
73
|
reducedMotion: "reduce",
|
|
64
|
-
deviceScaleFactor: 1
|
|
74
|
+
deviceScaleFactor: 1,
|
|
75
|
+
userAgent: `${await defaultUserAgent} CappaStorybook`
|
|
65
76
|
});
|
|
66
77
|
this.page = await this.context?.newPage();
|
|
67
78
|
this.page?.setViewportSize(this.viewport);
|
|
@@ -202,15 +213,6 @@ var ScreenshotTool = class {
|
|
|
202
213
|
};
|
|
203
214
|
var screenshot_default = ScreenshotTool;
|
|
204
215
|
|
|
205
|
-
//#endregion
|
|
206
|
-
//#region src/config.ts
|
|
207
|
-
/**
|
|
208
|
-
* 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.
|
|
209
|
-
*/
|
|
210
|
-
function defineConfig(options) {
|
|
211
|
-
return options;
|
|
212
|
-
}
|
|
213
|
-
|
|
214
216
|
//#endregion
|
|
215
217
|
exports.ScreenshotTool = screenshot_default;
|
|
216
218
|
exports.defineConfig = defineConfig;
|
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/screenshot.ts","../src/config.ts"],"sourcesContent":["import {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright\";\nimport path from \"node:path\";\nimport fs from \"node:fs\";\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 this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 1,\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","import type { PossiblePromise } from \"./utils/types\";\nimport type { 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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAYA,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;AAEF,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACpB,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;;;;;;;AC/Rf,SAAgB,aACd,SAGgB;AAChB,QAAO"}
|
|
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: PossiblePromise<UserConfig | Array<UserConfig>> | (() => 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 = 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 = 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: (options.fullPage as boolean) !== undefined ? options.fullPage : 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(`Error taking screenshot of ${page.url()}:`, (error as Error).message);\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 = (options.filename as string | undefined) || `${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(`Error taking element screenshot of ${page.url()}:`, (error as Error).message);\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: (options.fullPage as boolean) !== undefined ? options.fullPage : 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(`Error taking responsive screenshot for ${viewport.name}:`, (error as Error).message);\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,SACgB;AAChB,QAAO;;;;;ACIT,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,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;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,WAAW,QAAQ,mBAAmB,SAAY,QAAQ,iBAAiB;AACjF,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,UAAW,QAAQ,aAAyB,SAAY,QAAQ,WAAW,KAAK;IAChF,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,MAAM,8BAA8B,KAAK,KAAK,CAAC,IAAK,MAAgB,QAAQ;AACpF,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,WAAY,QAAQ,YAAmC,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GACvG,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,MAAM,sCAAsC,KAAK,KAAK,CAAC,IAAK,MAAgB,QAAQ;AAC5F,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,UAAW,QAAQ,aAAyB,SAAY,QAAQ,WAAW,KAAK;IAChF,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,MAAM,0CAA0C,SAAS,KAAK,IAAK,MAAgB,QAAQ;AACnG,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;;AAIX,yBAAe"}
|
package/dist/index.mjs
CHANGED
|
@@ -1,7 +1,16 @@
|
|
|
1
|
-
import { chromium, firefox, webkit } from "playwright";
|
|
2
|
-
import path from "node:path";
|
|
3
1
|
import fs from "node:fs";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
import { chromium, firefox, webkit } from "playwright-core";
|
|
4
|
+
|
|
5
|
+
//#region src/config.ts
|
|
6
|
+
/**
|
|
7
|
+
* 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.
|
|
8
|
+
*/
|
|
9
|
+
function defineConfig(options) {
|
|
10
|
+
return options;
|
|
11
|
+
}
|
|
4
12
|
|
|
13
|
+
//#endregion
|
|
5
14
|
//#region src/screenshot.ts
|
|
6
15
|
var ScreenshotTool = class {
|
|
7
16
|
browserType;
|
|
@@ -33,9 +42,11 @@ var ScreenshotTool = class {
|
|
|
33
42
|
}[this.browserType];
|
|
34
43
|
if (!browserClass) throw new Error(`Unsupported browser type: ${this.browserType}`);
|
|
35
44
|
this.browser = await browserClass.launch({ headless: this.headless });
|
|
45
|
+
const defaultUserAgent = (await this.browser.newContext()).newPage().then((page) => page.evaluate(() => navigator.userAgent));
|
|
36
46
|
this.context = await this.browser.newContext({
|
|
37
47
|
reducedMotion: "reduce",
|
|
38
|
-
deviceScaleFactor: 1
|
|
48
|
+
deviceScaleFactor: 1,
|
|
49
|
+
userAgent: `${await defaultUserAgent} CappaStorybook`
|
|
39
50
|
});
|
|
40
51
|
this.page = await this.context?.newPage();
|
|
41
52
|
this.page?.setViewportSize(this.viewport);
|
|
@@ -176,15 +187,6 @@ var ScreenshotTool = class {
|
|
|
176
187
|
};
|
|
177
188
|
var screenshot_default = ScreenshotTool;
|
|
178
189
|
|
|
179
|
-
//#endregion
|
|
180
|
-
//#region src/config.ts
|
|
181
|
-
/**
|
|
182
|
-
* 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.
|
|
183
|
-
*/
|
|
184
|
-
function defineConfig(options) {
|
|
185
|
-
return options;
|
|
186
|
-
}
|
|
187
|
-
|
|
188
190
|
//#endregion
|
|
189
191
|
export { screenshot_default as ScreenshotTool, defineConfig };
|
|
190
192
|
//# sourceMappingURL=index.mjs.map
|
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/screenshot.ts","../src/config.ts"],"sourcesContent":["import {\n type Browser,\n type BrowserContext,\n chromium,\n firefox,\n type Page,\n type PageScreenshotOptions,\n webkit,\n} from \"playwright\";\nimport path from \"node:path\";\nimport fs from \"node:fs\";\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 this.context = await this.browser.newContext({\n reducedMotion: \"reduce\",\n deviceScaleFactor: 1,\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","import type { PossiblePromise } from \"./utils/types\";\nimport type { 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"],"mappings":";;;;;AAYA,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;AAEF,OAAK,UAAU,MAAM,KAAK,QAAQ,WAAW;GAC3C,eAAe;GACf,mBAAmB;GACpB,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;;;;;;;AC/Rf,SAAgB,aACd,SAGgB;AAChB,QAAO"}
|
|
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: PossiblePromise<UserConfig | Array<UserConfig>> | (() => 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 = 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 = 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: (options.fullPage as boolean) !== undefined ? options.fullPage : 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(`Error taking screenshot of ${page.url()}:`, (error as Error).message);\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 = (options.filename as string | undefined) || `${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(`Error taking element screenshot of ${page.url()}:`, (error as Error).message);\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: (options.fullPage as boolean) !== undefined ? options.fullPage : 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(`Error taking responsive screenshot for ${viewport.name}:`, (error as Error).message);\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,SACgB;AAChB,QAAO;;;;;ACIT,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,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;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,WAAW,QAAQ,mBAAmB,SAAY,QAAQ,iBAAiB;AACjF,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,UAAW,QAAQ,aAAyB,SAAY,QAAQ,WAAW,KAAK;IAChF,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,MAAM,8BAA8B,KAAK,KAAK,CAAC,IAAK,MAAgB,QAAQ;AACpF,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,WAAY,QAAQ,YAAmC,GAAG,SAAS,QAAQ,iBAAiB,IAAI,CAAC;GACvG,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,MAAM,sCAAsC,KAAK,KAAK,CAAC,IAAK,MAAgB,QAAQ;AAC5F,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,UAAW,QAAQ,aAAyB,SAAY,QAAQ,WAAW,KAAK;IAChF,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,MAAM,0CAA0C,SAAS,KAAK,IAAK,MAAgB,QAAQ;AACnG,WAAQ,KAAK;IACX,UAAU,SAAS;IACnB,SAAS;IACT,OAAQ,MAAgB;IACxB,UAAU;IACX,CAAC;;AAIN,SAAO;;;AAIX,yBAAe"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cappa/core",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.13",
|
|
4
4
|
"description": "Core Playwright screenshot functionality for Cappa",
|
|
5
5
|
"author": "tim-richter",
|
|
6
6
|
"license": "MIT",
|
|
@@ -18,15 +18,15 @@
|
|
|
18
18
|
"./package.json": "./package.json"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"playwright": "^1.
|
|
21
|
+
"playwright-core": "^1.55.0"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
|
-
"tsdown": "0.14.1",
|
|
25
24
|
"@types/node": "22.13.10",
|
|
26
|
-
"vitest": "3.2.4",
|
|
27
|
-
"@vitest/ui": "3.2.4",
|
|
28
25
|
"@vitest/coverage-v8": "3.2.4",
|
|
29
|
-
"
|
|
26
|
+
"@vitest/ui": "3.2.4",
|
|
27
|
+
"tsdown": "0.14.1",
|
|
28
|
+
"typescript": "5.7.3",
|
|
29
|
+
"vitest": "3.2.4"
|
|
30
30
|
},
|
|
31
31
|
"keywords": [
|
|
32
32
|
"screenshot",
|
|
@@ -40,6 +40,7 @@
|
|
|
40
40
|
"example:batch": "node examples/batch-screenshots.js",
|
|
41
41
|
"example:responsive": "node examples/responsive-screenshots.js",
|
|
42
42
|
"example:element": "node examples/element-screenshots.js",
|
|
43
|
-
"build": "tsdown"
|
|
43
|
+
"build": "tsdown",
|
|
44
|
+
"tsc": "tsc"
|
|
44
45
|
}
|
|
45
46
|
}
|
package/src/config.ts
CHANGED
|
@@ -1,13 +1,10 @@
|
|
|
1
|
-
import type { PossiblePromise } from "./
|
|
2
|
-
import type { UserConfig } from "./types";
|
|
1
|
+
import type { PossiblePromise, UserConfig } from "./types";
|
|
3
2
|
|
|
4
3
|
/**
|
|
5
4
|
* 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.
|
|
6
5
|
*/
|
|
7
6
|
export function defineConfig(
|
|
8
|
-
options:
|
|
9
|
-
| PossiblePromise<UserConfig | Array<UserConfig>>
|
|
10
|
-
| (() => PossiblePromise<UserConfig | Array<UserConfig>>)
|
|
7
|
+
options: PossiblePromise<UserConfig | Array<UserConfig>> | (() => PossiblePromise<UserConfig | Array<UserConfig>>),
|
|
11
8
|
): typeof options {
|
|
12
9
|
return options;
|
|
13
10
|
}
|
package/src/index.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import ScreenshotTool from "./screenshot";
|
|
2
|
-
import type { PluginFunction, Plugin, PluginDef } from "./plugin";
|
|
3
1
|
import { defineConfig } from "./config";
|
|
2
|
+
import type { Plugin, PluginDef, PluginFunction } from "./plugin";
|
|
3
|
+
import ScreenshotTool from "./screenshot";
|
|
4
4
|
import type { Exposed, ScreenshotOptions, UserConfig } from "./types";
|
|
5
5
|
|
|
6
6
|
export {
|
package/src/plugin.ts
CHANGED
|
@@ -1,12 +1,9 @@
|
|
|
1
|
-
import ScreenshotTool from "./screenshot";
|
|
1
|
+
import type ScreenshotTool from "./screenshot";
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Plugin function type definition
|
|
5
5
|
*/
|
|
6
|
-
export type PluginFunction = (
|
|
7
|
-
screenshotTool: ScreenshotTool,
|
|
8
|
-
options?: any
|
|
9
|
-
) => Promise<any[]>;
|
|
6
|
+
export type PluginFunction = (screenshotTool: ScreenshotTool, options?: any) => Promise<any[]>;
|
|
10
7
|
|
|
11
8
|
/**
|
|
12
9
|
* Plugin definition interface
|
package/src/screenshot.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import fs from "node:fs";
|
|
2
|
+
import path from "node:path";
|
|
1
3
|
import {
|
|
2
4
|
type Browser,
|
|
3
5
|
type BrowserContext,
|
|
@@ -6,9 +8,7 @@ import {
|
|
|
6
8
|
type Page,
|
|
7
9
|
type PageScreenshotOptions,
|
|
8
10
|
webkit,
|
|
9
|
-
} from "playwright";
|
|
10
|
-
import path from "node:path";
|
|
11
|
-
import fs from "node:fs";
|
|
11
|
+
} from "playwright-core";
|
|
12
12
|
|
|
13
13
|
class ScreenshotTool {
|
|
14
14
|
browserType: string;
|
|
@@ -49,8 +49,7 @@ class ScreenshotTool {
|
|
|
49
49
|
webkit,
|
|
50
50
|
};
|
|
51
51
|
|
|
52
|
-
const browserClass =
|
|
53
|
-
browserMap[this.browserType as keyof typeof browserMap];
|
|
52
|
+
const browserClass = browserMap[this.browserType as keyof typeof browserMap];
|
|
54
53
|
if (!browserClass) {
|
|
55
54
|
throw new Error(`Unsupported browser type: ${this.browserType}`);
|
|
56
55
|
}
|
|
@@ -59,9 +58,14 @@ class ScreenshotTool {
|
|
|
59
58
|
headless: this.headless,
|
|
60
59
|
});
|
|
61
60
|
|
|
61
|
+
const defaultUserAgent = (await this.browser.newContext())
|
|
62
|
+
.newPage()
|
|
63
|
+
.then((page) => page.evaluate(() => navigator.userAgent));
|
|
64
|
+
|
|
62
65
|
this.context = await this.browser.newContext({
|
|
63
66
|
reducedMotion: "reduce",
|
|
64
67
|
deviceScaleFactor: 1,
|
|
68
|
+
userAgent: `${await defaultUserAgent} CappaStorybook`,
|
|
65
69
|
});
|
|
66
70
|
|
|
67
71
|
this.page = await this.context?.newPage();
|
|
@@ -95,7 +99,7 @@ class ScreenshotTool {
|
|
|
95
99
|
quality?: number;
|
|
96
100
|
waitForSelector?: string;
|
|
97
101
|
waitForTimeout?: number;
|
|
98
|
-
} = {}
|
|
102
|
+
} = {},
|
|
99
103
|
) {
|
|
100
104
|
if (!this.browser) {
|
|
101
105
|
throw new Error("Browser not initialized");
|
|
@@ -109,8 +113,7 @@ class ScreenshotTool {
|
|
|
109
113
|
}
|
|
110
114
|
|
|
111
115
|
// Wait for custom timeout or default
|
|
112
|
-
const waitTime =
|
|
113
|
-
options.waitForTimeout !== undefined ? options.waitForTimeout : 0;
|
|
116
|
+
const waitTime = options.waitForTimeout !== undefined ? options.waitForTimeout : 0;
|
|
114
117
|
if (waitTime > 0) {
|
|
115
118
|
console.log(`Waiting for ${waitTime}ms for dynamic content`);
|
|
116
119
|
await page.waitForTimeout(waitTime);
|
|
@@ -122,10 +125,7 @@ class ScreenshotTool {
|
|
|
122
125
|
// Take screenshot
|
|
123
126
|
const screenshotOptions = {
|
|
124
127
|
path: filepath,
|
|
125
|
-
fullPage:
|
|
126
|
-
(options.fullPage as boolean) !== undefined
|
|
127
|
-
? options.fullPage
|
|
128
|
-
: this.fullPage,
|
|
128
|
+
fullPage: (options.fullPage as boolean) !== undefined ? options.fullPage : this.fullPage,
|
|
129
129
|
type: (options.type as "jpeg" | "png") || "jpeg",
|
|
130
130
|
quality: (options.quality as number) || this.quality,
|
|
131
131
|
} satisfies PageScreenshotOptions;
|
|
@@ -135,10 +135,7 @@ class ScreenshotTool {
|
|
|
135
135
|
console.log(`Screenshot saved: ${filepath}`);
|
|
136
136
|
return filepath;
|
|
137
137
|
} catch (error) {
|
|
138
|
-
console.error(
|
|
139
|
-
`Error taking screenshot of ${page.url()}:`,
|
|
140
|
-
(error as Error).message
|
|
141
|
-
);
|
|
138
|
+
console.error(`Error taking screenshot of ${page.url()}:`, (error as Error).message);
|
|
142
139
|
throw error;
|
|
143
140
|
}
|
|
144
141
|
}
|
|
@@ -151,7 +148,7 @@ class ScreenshotTool {
|
|
|
151
148
|
fullPage?: boolean;
|
|
152
149
|
type?: string;
|
|
153
150
|
quality?: number;
|
|
154
|
-
} = {}
|
|
151
|
+
} = {},
|
|
155
152
|
) {
|
|
156
153
|
if (!this.browser) {
|
|
157
154
|
throw new Error("Browser not initialized");
|
|
@@ -166,9 +163,7 @@ class ScreenshotTool {
|
|
|
166
163
|
throw new Error(`Element not found: ${selector}`);
|
|
167
164
|
}
|
|
168
165
|
|
|
169
|
-
const filename =
|
|
170
|
-
(options.filename as string | undefined) ||
|
|
171
|
-
`${selector.replace(/[^a-zA-Z0-9]/g, "_")}.png`;
|
|
166
|
+
const filename = (options.filename as string | undefined) || `${selector.replace(/[^a-zA-Z0-9]/g, "_")}.png`;
|
|
172
167
|
const filepath = this.getFilePath(filename);
|
|
173
168
|
|
|
174
169
|
const elementScreenshotOptions = {
|
|
@@ -182,10 +177,7 @@ class ScreenshotTool {
|
|
|
182
177
|
console.log(`Element screenshot saved: ${filepath}`);
|
|
183
178
|
return filepath;
|
|
184
179
|
} catch (error) {
|
|
185
|
-
console.error(
|
|
186
|
-
`Error taking element screenshot of ${page.url()}:`,
|
|
187
|
-
(error as Error).message
|
|
188
|
-
);
|
|
180
|
+
console.error(`Error taking element screenshot of ${page.url()}:`, (error as Error).message);
|
|
189
181
|
throw error;
|
|
190
182
|
} finally {
|
|
191
183
|
await page.close();
|
|
@@ -233,7 +225,7 @@ class ScreenshotTool {
|
|
|
233
225
|
fullPage?: boolean;
|
|
234
226
|
type?: string;
|
|
235
227
|
quality?: number;
|
|
236
|
-
} = {}
|
|
228
|
+
} = {},
|
|
237
229
|
) {
|
|
238
230
|
if (!this.context) {
|
|
239
231
|
throw new Error("Browser not initialized");
|
|
@@ -259,10 +251,7 @@ class ScreenshotTool {
|
|
|
259
251
|
|
|
260
252
|
const responsiveScreenshotOptions = {
|
|
261
253
|
path: filepath,
|
|
262
|
-
fullPage:
|
|
263
|
-
(options.fullPage as boolean) !== undefined
|
|
264
|
-
? options.fullPage
|
|
265
|
-
: this.fullPage,
|
|
254
|
+
fullPage: (options.fullPage as boolean) !== undefined ? options.fullPage : this.fullPage,
|
|
266
255
|
type: (options.type as "jpeg" | "png") || "png",
|
|
267
256
|
quality: (options.quality as number) || this.quality,
|
|
268
257
|
};
|
|
@@ -274,10 +263,7 @@ class ScreenshotTool {
|
|
|
274
263
|
console.log(`Responsive screenshot saved: ${filepath}`);
|
|
275
264
|
results.push({ viewport: viewport.name, success: true, filepath });
|
|
276
265
|
} catch (error) {
|
|
277
|
-
console.error(
|
|
278
|
-
`Error taking responsive screenshot for ${viewport.name}:`,
|
|
279
|
-
(error as Error).message
|
|
280
|
-
);
|
|
266
|
+
console.error(`Error taking responsive screenshot for ${viewport.name}:`, (error as Error).message);
|
|
281
267
|
results.push({
|
|
282
268
|
viewport: viewport.name,
|
|
283
269
|
success: false,
|
package/src/types.ts
CHANGED
package/tsconfig.json
CHANGED
package/src/utils/types.ts
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
export type PossiblePromise<T> = Promise<T> | T;
|
|
2
|
-
|
|
3
|
-
type ArrayWithLength<
|
|
4
|
-
T extends number,
|
|
5
|
-
U extends any[] = []
|
|
6
|
-
> = U["length"] extends T ? U : ArrayWithLength<T, [true, ...U]>;
|
|
7
|
-
|
|
8
|
-
export type GreaterThan<
|
|
9
|
-
T extends number,
|
|
10
|
-
U extends number
|
|
11
|
-
> = ArrayWithLength<U> extends [...ArrayWithLength<T>, ...infer _]
|
|
12
|
-
? false
|
|
13
|
-
: true;
|