@cappa/plugin-storybook 0.0.9 → 0.0.10
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 +9 -9
- package/CHANGELOG.md +8 -0
- package/dist/index.js +9 -6
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +9 -6
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/cappa/plugin.ts +17 -11
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
-
> @cappa/plugin-storybook@0.0.
|
|
3
|
+
> @cappa/plugin-storybook@0.0.9 build /home/tim/cappa/packages/plugins/plugin-storybook
|
|
4
4
|
> tsdown
|
|
5
5
|
|
|
6
6
|
[34mℹ[39m tsdown [2mv0.14.1[22m powered by rolldown [2mv1.0.0-beta.37[22m
|
|
7
7
|
[34mℹ[39m Using tsdown config: [4m/home/tim/cappa/packages/plugins/plugin-storybook/tsdown.config.ts[24m
|
|
8
|
-
(node:
|
|
8
|
+
(node:218205) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/tim/cappa/packages/plugins/plugin-storybook/tsdown.config.ts is not specified and it doesn't parse as CommonJS.
|
|
9
9
|
Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
|
|
10
10
|
To eliminate this warning, add "type": "module" to /home/tim/cappa/packages/plugins/plugin-storybook/package.json.
|
|
11
11
|
(Use `node --trace-warnings ...` to show where the warning was created)
|
|
@@ -17,15 +17,15 @@ To eliminate this warning, add "type": "module" to /home/tim/cappa/packages/plug
|
|
|
17
17
|
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
18
18
|
[33mWarning: Invalid input options (1 issue found)
|
|
19
19
|
- 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 7.
|
|
21
|
-
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [
|
|
22
|
-
[34mℹ[39m [33m[CJS][39m 2 files, total: 20.
|
|
20
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[1mindex.js[22m [2m 7.48 kB[22m [2m│ gzip: 2.60 kB[22m
|
|
21
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [2m13.21 kB[22m [2m│ gzip: 4.15 kB[22m
|
|
22
|
+
[34mℹ[39m [33m[CJS][39m 2 files, total: 20.68 kB
|
|
23
23
|
[33mWarning: Invalid input options (1 issue found)
|
|
24
24
|
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
25
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[1mindex.mjs[22m [2m 6.
|
|
26
|
-
[34mℹ[39m [34m[ESM][39m [2mdist/[22mindex.mjs.map [
|
|
25
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[1mindex.mjs[22m [2m 6.38 kB[22m [2m│ gzip: 2.19 kB[22m
|
|
26
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22mindex.mjs.map [2m13.19 kB[22m [2m│ gzip: 4.16 kB[22m
|
|
27
27
|
[34mℹ[39m [34m[ESM][39m [2mdist/[22m[32m[1mindex.d.mts[22m[39m [2m 0.71 kB[22m [2m│ gzip: 0.39 kB[22m
|
|
28
|
-
[34mℹ[39m [34m[ESM][39m 3 files, total:
|
|
28
|
+
[34mℹ[39m [34m[ESM][39m 3 files, total: 20.28 kB
|
|
29
29
|
[34mℹ[39m [33m[CJS][39m [2mdist/[22m[32m[1mindex.d.ts[22m[39m [2m0.71 kB[22m [2m│ gzip: 0.38 kB[22m
|
|
30
30
|
[34mℹ[39m [33m[CJS][39m 1 files, total: 0.71 kB
|
|
31
|
-
[32m✔[39m Build complete in [
|
|
31
|
+
[32m✔[39m Build complete in [32m1442ms[39m
|
package/CHANGELOG.md
CHANGED
package/dist/index.js
CHANGED
|
@@ -91,7 +91,11 @@ const cappaPluginStorybook = (options) => {
|
|
|
91
91
|
filteredStories = filteredStories.filter((story) => story.type === "story");
|
|
92
92
|
console.log(`Found ${filteredStories.length} stories to screenshot`);
|
|
93
93
|
const results = [];
|
|
94
|
-
|
|
94
|
+
await screenshotTool.init();
|
|
95
|
+
let currentLatch = createLatch();
|
|
96
|
+
await screenshotTool.page?.exposeFunction("__cappa_parameters", async (payload) => {
|
|
97
|
+
currentLatch.resolve(payload);
|
|
98
|
+
});
|
|
95
99
|
for (const story of filteredStories) try {
|
|
96
100
|
const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;
|
|
97
101
|
const screenshotOptions = {
|
|
@@ -103,18 +107,17 @@ const cappaPluginStorybook = (options) => {
|
|
|
103
107
|
type: "jpeg"
|
|
104
108
|
};
|
|
105
109
|
const filename = `${story.title.replace(/[^a-zA-Z0-9]/g, "_")}_${story.name.replace(/[^a-zA-Z0-9]/g, "_")}.${screenshotOptions.type}`;
|
|
110
|
+
const page = screenshotTool.page;
|
|
111
|
+
if (!page) throw new Error("Page not initialized");
|
|
106
112
|
page.on("console", (message) => {
|
|
107
113
|
console.log("console", message.text());
|
|
108
114
|
});
|
|
109
115
|
page.on("pageerror", (error) => {
|
|
110
116
|
console.log("pageerror", error);
|
|
111
117
|
});
|
|
112
|
-
const latch = createLatch();
|
|
113
|
-
await page.exposeFunction("__cappa_parameters", async (payload) => {
|
|
114
|
-
latch.resolve(payload);
|
|
115
|
-
});
|
|
116
118
|
await page.goto(storyUrl);
|
|
117
|
-
const options$1 = await
|
|
119
|
+
const options$1 = await currentLatch.p;
|
|
120
|
+
currentLatch = createLatch();
|
|
118
121
|
if (options$1.skip) console.log(`Skipping story ${story.title} - ${story.name}`);
|
|
119
122
|
await freezeUI(page);
|
|
120
123
|
await waitForVisualIdle(page);
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["resolve!: (v: T) => void","cappaPluginStorybook: Plugin<StorybookPluginOptions>","data: StorybookStoriesResponse","results: Array<{\n storyId: string;\n storyName: string;\n storyTitle: string;\n success: boolean;\n filepath?: string;\n error?: string;\n }>","options"],"sources":["../src/cappa/util.ts","../src/cappa/plugin.ts","../src/storybook/util.ts","../src/storybook/decorator.ts"],"sourcesContent":["import type { Page } from \"playwright\";\n\n/**\n * Disable CSS transitions, animations, and scrollbars\n * @param page - The page to disable CSS transitions, animations, and scrollbars\n */\nexport const freezeUI = async (page: Page) => {\n await page.addStyleTag({\n content: `\n\t\t\t* { transition: none !important; animation: none !important }\n\t\t\t* { caret-color: transparent !important }\n\t\t\t::-webkit-scrollbar { display: none }\n\t\t`,\n });\n};\n\n/**\n * Wait for general visual stability on the page\n * @param page - The page to wait for\n */\nexport const waitForVisualIdle = async (page: Page) => {\n // Wait for the page to be fully loaded\n await page.waitForLoadState(\"networkidle\");\n\n await page.evaluate(async () => {\n // Wait for the fonts to be loaded\n if (document.fonts?.ready) await document.fonts.ready;\n\n // Wait for a frame to be idle in the requestAnimationFrame queue\n await new Promise((r) =>\n requestAnimationFrame(() => requestAnimationFrame(r))\n );\n });\n};\n","import { Plugin, ScreenshotOptions, ScreenshotTool } from \"@cappa/core\";\nimport { freezeUI, waitForVisualIdle } from \"./util\";\n\ninterface StorybookStory {\n id: string;\n name: string;\n title: string;\n kind: string;\n story: string;\n type: \"story\" | \"docs\";\n}\n\ninterface StorybookStoriesResponse {\n entries: Record<string, StorybookStory>;\n}\n\ninterface StorybookPluginOptions {\n storybookUrl: string;\n includeStories?: string[];\n excludeStories?: string[];\n defaultViewport?: { width: number; height: number };\n waitForSelector?: string;\n waitForTimeout?: number;\n}\n\n/**\n * Create a latch for a Promise. A latch is a Promise that can be resolved from outside.\n * @param T - The type of the Promise\n * @returns A latch for a Promise\n */\nfunction createLatch<T>() {\n let resolve!: (v: T) => void;\n const p = new Promise<T>((r) => (resolve = r));\n return { p, resolve };\n}\n\n/**\n * Storybook Plugin for Cappa\n * Fetches stories from a running Storybook server and takes screenshots of each story\n */\nexport const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (\n options\n) => {\n return {\n name: \"StorybookPlugin\",\n description:\n \"Takes screenshots of Storybook stories with configurable options\",\n version: \"1.0.0\",\n execute: async (screenshotTool: ScreenshotTool) => {\n if (!options) {\n throw new Error(\"Storybook plugin options are required\");\n }\n if (!options.storybookUrl) {\n throw new Error(\"storybookUrl is required\");\n }\n\n const {\n storybookUrl,\n includeStories = [],\n excludeStories = [],\n defaultViewport = { width: 1920, height: 1080 },\n waitForSelector,\n waitForTimeout,\n } = options;\n\n const storiesUrl = `${storybookUrl}/index.json`;\n console.log(`Fetching stories from: ${storiesUrl}`);\n\n try {\n // Fetch stories from Storybook\n const response = await fetch(storiesUrl);\n if (!response.ok) {\n throw new Error(\n `Failed to fetch stories: ${response.status} ${response.statusText}`\n );\n }\n\n const data: StorybookStoriesResponse = await response.json();\n const stories = Object.values(data.entries);\n\n // Filter stories based on include/exclude patterns\n let filteredStories = stories;\n\n if (includeStories.length > 0) {\n filteredStories = filteredStories.filter((story) =>\n includeStories.some(\n (pattern) =>\n story.title.includes(pattern) || story.name.includes(pattern)\n )\n );\n }\n\n if (excludeStories.length > 0) {\n filteredStories = filteredStories.filter(\n (story) =>\n !excludeStories.some(\n (pattern) =>\n story.title.includes(pattern) || story.name.includes(pattern)\n )\n );\n }\n\n // Filter docs etc\n filteredStories = filteredStories.filter(\n (story) => story.type === \"story\"\n );\n\n console.log(`Found ${filteredStories.length} stories to screenshot`);\n\n const results: Array<{\n storyId: string;\n storyName: string;\n storyTitle: string;\n success: boolean;\n filepath?: string;\n error?: string;\n }> = [];\n\n const page = await screenshotTool.newPage();\n\n // Take screenshots of each story\n for (const story of filteredStories) {\n try {\n const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;\n\n // Merge with default options\n const screenshotOptions = {\n viewport: defaultViewport,\n waitForSelector: waitForSelector,\n waitForTimeout: waitForTimeout,\n fullPage: true,\n quality: 90,\n type: \"jpeg\" as const,\n };\n\n // Take screenshot with story-specific filename\n const filename = `${story.title.replace(\n /[^a-zA-Z0-9]/g,\n \"_\"\n )}_${story.name.replace(/[^a-zA-Z0-9]/g, \"_\")}.${\n screenshotOptions.type\n }`;\n\n page.on(\"console\", (message) => {\n console.log(\"console\", message.text());\n });\n page.on(\"pageerror\", (error) => {\n console.log(\"pageerror\", error);\n });\n\n const latch = createLatch<ScreenshotOptions>();\n\n await page.exposeFunction(\n \"__cappa_parameters\",\n async (payload: ScreenshotOptions) => {\n latch.resolve(payload);\n }\n );\n\n await page.goto(storyUrl);\n\n const options = await latch.p;\n\n if (options.skip) {\n console.log(`Skipping story ${story.title} - ${story.name}`);\n }\n\n await freezeUI(page);\n await waitForVisualIdle(page);\n\n if (options.delay) {\n await page.waitForTimeout(options.delay);\n }\n\n // Actually take the screenshot\n const actualFilepath = await screenshotTool.takeScreenshot(\n page,\n filename,\n {\n fullPage: options.fullPage ?? screenshotOptions.fullPage,\n type: options.type ?? screenshotOptions.type,\n waitForSelector:\n options.waitForSelector ?? screenshotOptions.waitForSelector,\n waitForTimeout:\n options.waitForTimeout ?? screenshotOptions.waitForTimeout,\n }\n );\n\n results.push({\n storyId: story.id,\n storyName: story.name,\n storyTitle: story.title,\n success: true,\n filepath: actualFilepath,\n });\n } catch (error) {\n console.error(\n `Error taking screenshot of story ${story.title} - ${story.name}:`,\n (error as Error).message\n );\n results.push({\n storyId: story.id,\n storyName: story.name,\n storyTitle: story.title,\n success: false,\n error: (error as Error).message,\n });\n }\n }\n\n console.log(\n `Completed screenshots: ${results.filter((r) => r.success).length}/${\n results.length\n } successful`\n );\n return results;\n } catch (error) {\n console.error(\"Error in Storybook plugin:\", (error as Error).message);\n throw error;\n }\n },\n };\n};\n","/**\n * Wait for a function to be exposed on the window object\n * @param name - The name of the function to wait for\n * @param timeoutMs - The timeout in milliseconds\n * @returns The function or rejects if the function is not exposed within the timeout\n */\nexport const waitForExposed = (name: string, timeoutMs = 5000) => {\n return new Promise<Function>((resolve, reject) => {\n const start = performance.now();\n\n const t = setInterval(() => {\n const fn = (window as any)[name];\n if (typeof fn === \"function\") {\n clearInterval(t);\n resolve(fn);\n } else if (performance.now() - start > timeoutMs) {\n clearInterval(t);\n reject(new Error(`Timed out waiting for ${name}`));\n }\n }, 16);\n });\n};\n","import { makeDecorator } from \"storybook/preview-api\";\nimport { waitForExposed } from \"./util\";\n\nexport const withCappaDecorator = makeDecorator({\n name: \"withCappa\",\n parameterName: \"cappa\",\n skipIfNoParametersOrOptions: false,\n wrapper: (getStory, context, { parameters }) => {\n queueMicrotask(async () => {\n try {\n const cappaParameters = await waitForExposed(\"__cappa_parameters\");\n\n cappaParameters(parameters ?? {});\n } catch (error) {\n console.error(error);\n }\n });\n\n return getStory(context);\n },\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,MAAa,WAAW,OAAO,SAAe;AAC5C,OAAM,KAAK,YAAY,EACrB,SAAS;;;;KAKV,CAAC;;;;;;AAOJ,MAAa,oBAAoB,OAAO,SAAe;AAErD,OAAM,KAAK,iBAAiB,cAAc;AAE1C,OAAM,KAAK,SAAS,YAAY;AAE9B,MAAI,SAAS,OAAO,MAAO,OAAM,SAAS,MAAM;AAGhD,QAAM,IAAI,SAAS,MACjB,4BAA4B,sBAAsB,EAAE,CAAC,CACtD;GACD;;;;;;;;;;ACFJ,SAAS,cAAiB;CACxB,IAAIA;AAEJ,QAAO;EAAE,GADC,IAAI,SAAY,MAAO,UAAU,EAAG;EAClC;EAAS;;;;;;AAOvB,MAAaC,wBACX,YACG;AACH,QAAO;EACL,MAAM;EACN,aACE;EACF,SAAS;EACT,SAAS,OAAO,mBAAmC;AACjD,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,wCAAwC;AAE1D,OAAI,CAAC,QAAQ,aACX,OAAM,IAAI,MAAM,2BAA2B;GAG7C,MAAM,EACJ,cACA,iBAAiB,EAAE,EACnB,iBAAiB,EAAE,EACnB,kBAAkB;IAAE,OAAO;IAAM,QAAQ;IAAM,EAC/C,iBACA,mBACE;GAEJ,MAAM,aAAa,GAAG,aAAa;AACnC,WAAQ,IAAI,0BAA0B,aAAa;AAEnD,OAAI;IAEF,MAAM,WAAW,MAAM,MAAM,WAAW;AACxC,QAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MACR,4BAA4B,SAAS,OAAO,GAAG,SAAS,aACzD;IAGH,MAAMC,OAAiC,MAAM,SAAS,MAAM;IAI5D,IAAI,kBAHY,OAAO,OAAO,KAAK,QAAQ;AAK3C,QAAI,eAAe,SAAS,EAC1B,mBAAkB,gBAAgB,QAAQ,UACxC,eAAe,MACZ,YACC,MAAM,MAAM,SAAS,QAAQ,IAAI,MAAM,KAAK,SAAS,QAAQ,CAChE,CACF;AAGH,QAAI,eAAe,SAAS,EAC1B,mBAAkB,gBAAgB,QAC/B,UACC,CAAC,eAAe,MACb,YACC,MAAM,MAAM,SAAS,QAAQ,IAAI,MAAM,KAAK,SAAS,QAAQ,CAChE,CACJ;AAIH,sBAAkB,gBAAgB,QAC/B,UAAU,MAAM,SAAS,QAC3B;AAED,YAAQ,IAAI,SAAS,gBAAgB,OAAO,wBAAwB;IAEpE,MAAMC,UAOD,EAAE;IAEP,MAAM,OAAO,MAAM,eAAe,SAAS;AAG3C,SAAK,MAAM,SAAS,gBAClB,KAAI;KACF,MAAM,WAAW,GAAG,aAAa,kBAAkB,MAAM,GAAG;KAG5D,MAAM,oBAAoB;MACxB,UAAU;MACO;MACD;MAChB,UAAU;MACV,SAAS;MACT,MAAM;MACP;KAGD,MAAM,WAAW,GAAG,MAAM,MAAM,QAC9B,iBACA,IACD,CAAC,GAAG,MAAM,KAAK,QAAQ,iBAAiB,IAAI,CAAC,GAC5C,kBAAkB;AAGpB,UAAK,GAAG,YAAY,YAAY;AAC9B,cAAQ,IAAI,WAAW,QAAQ,MAAM,CAAC;OACtC;AACF,UAAK,GAAG,cAAc,UAAU;AAC9B,cAAQ,IAAI,aAAa,MAAM;OAC/B;KAEF,MAAM,QAAQ,aAAgC;AAE9C,WAAM,KAAK,eACT,sBACA,OAAO,YAA+B;AACpC,YAAM,QAAQ,QAAQ;OAEzB;AAED,WAAM,KAAK,KAAK,SAAS;KAEzB,MAAMC,YAAU,MAAM,MAAM;AAE5B,SAAIA,UAAQ,KACV,SAAQ,IAAI,kBAAkB,MAAM,MAAM,KAAK,MAAM,OAAO;AAG9D,WAAM,SAAS,KAAK;AACpB,WAAM,kBAAkB,KAAK;AAE7B,SAAIA,UAAQ,MACV,OAAM,KAAK,eAAeA,UAAQ,MAAM;KAI1C,MAAM,iBAAiB,MAAM,eAAe,eAC1C,MACA,UACA;MACE,UAAUA,UAAQ,YAAY,kBAAkB;MAChD,MAAMA,UAAQ,QAAQ,kBAAkB;MACxC,iBACEA,UAAQ,mBAAmB,kBAAkB;MAC/C,gBACEA,UAAQ,kBAAkB,kBAAkB;MAC/C,CACF;AAED,aAAQ,KAAK;MACX,SAAS,MAAM;MACf,WAAW,MAAM;MACjB,YAAY,MAAM;MAClB,SAAS;MACT,UAAU;MACX,CAAC;aACK,OAAO;AACd,aAAQ,MACN,oCAAoC,MAAM,MAAM,KAAK,MAAM,KAAK,IAC/D,MAAgB,QAClB;AACD,aAAQ,KAAK;MACX,SAAS,MAAM;MACf,WAAW,MAAM;MACjB,YAAY,MAAM;MAClB,SAAS;MACT,OAAQ,MAAgB;MACzB,CAAC;;AAIN,YAAQ,IACN,0BAA0B,QAAQ,QAAQ,MAAM,EAAE,QAAQ,CAAC,OAAO,GAChE,QAAQ,OACT,aACF;AACD,WAAO;YACA,OAAO;AACd,YAAQ,MAAM,8BAA+B,MAAgB,QAAQ;AACrE,UAAM;;;EAGX;;;;;;;;;;;ACvNH,MAAa,kBAAkB,MAAc,YAAY,QAAS;AAChE,QAAO,IAAI,SAAmB,SAAS,WAAW;EAChD,MAAM,QAAQ,YAAY,KAAK;EAE/B,MAAM,IAAI,kBAAkB;GAC1B,MAAM,KAAM,OAAe;AAC3B,OAAI,OAAO,OAAO,YAAY;AAC5B,kBAAc,EAAE;AAChB,YAAQ,GAAG;cACF,YAAY,KAAK,GAAG,QAAQ,WAAW;AAChD,kBAAc,EAAE;AAChB,2BAAO,IAAI,MAAM,yBAAyB,OAAO,CAAC;;KAEnD,GAAG;GACN;;;;;ACjBJ,MAAa,8DAAmC;CAC9C,MAAM;CACN,eAAe;CACf,6BAA6B;CAC7B,UAAU,UAAU,SAAS,EAAE,iBAAiB;AAC9C,iBAAe,YAAY;AACzB,OAAI;AAGF,KAFwB,MAAM,eAAe,qBAAqB,EAElD,cAAc,EAAE,CAAC;YAC1B,OAAO;AACd,YAAQ,MAAM,MAAM;;IAEtB;AAEF,SAAO,SAAS,QAAQ;;CAE3B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","names":["resolve!: (v: T) => void","cappaPluginStorybook: Plugin<StorybookPluginOptions>","data: StorybookStoriesResponse","results: Array<{\n storyId: string;\n storyName: string;\n storyTitle: string;\n success: boolean;\n filepath?: string;\n error?: string;\n }>","options"],"sources":["../src/cappa/util.ts","../src/cappa/plugin.ts","../src/storybook/util.ts","../src/storybook/decorator.ts"],"sourcesContent":["import type { Page } from \"playwright\";\n\n/**\n * Disable CSS transitions, animations, and scrollbars\n * @param page - The page to disable CSS transitions, animations, and scrollbars\n */\nexport const freezeUI = async (page: Page) => {\n await page.addStyleTag({\n content: `\n\t\t\t* { transition: none !important; animation: none !important }\n\t\t\t* { caret-color: transparent !important }\n\t\t\t::-webkit-scrollbar { display: none }\n\t\t`,\n });\n};\n\n/**\n * Wait for general visual stability on the page\n * @param page - The page to wait for\n */\nexport const waitForVisualIdle = async (page: Page) => {\n // Wait for the page to be fully loaded\n await page.waitForLoadState(\"networkidle\");\n\n await page.evaluate(async () => {\n // Wait for the fonts to be loaded\n if (document.fonts?.ready) await document.fonts.ready;\n\n // Wait for a frame to be idle in the requestAnimationFrame queue\n await new Promise((r) =>\n requestAnimationFrame(() => requestAnimationFrame(r))\n );\n });\n};\n","import { Plugin, ScreenshotOptions, ScreenshotTool } from \"@cappa/core\";\nimport { freezeUI, waitForVisualIdle } from \"./util\";\n\ninterface StorybookStory {\n id: string;\n name: string;\n title: string;\n kind: string;\n story: string;\n type: \"story\" | \"docs\";\n}\n\ninterface StorybookStoriesResponse {\n entries: Record<string, StorybookStory>;\n}\n\ninterface StorybookPluginOptions {\n storybookUrl: string;\n includeStories?: string[];\n excludeStories?: string[];\n defaultViewport?: { width: number; height: number };\n waitForSelector?: string;\n waitForTimeout?: number;\n}\n\n/**\n * Create a latch for a Promise. A latch is a Promise that can be resolved from outside.\n * @param T - The type of the Promise\n * @returns A latch for a Promise\n */\nfunction createLatch<T>() {\n let resolve!: (v: T) => void;\n const p = new Promise<T>((r) => (resolve = r));\n return { p, resolve };\n}\n\n/**\n * Storybook Plugin for Cappa\n * Fetches stories from a running Storybook server and takes screenshots of each story\n */\nexport const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (\n options\n) => {\n return {\n name: \"StorybookPlugin\",\n description:\n \"Takes screenshots of Storybook stories with configurable options\",\n version: \"1.0.0\",\n execute: async (screenshotTool: ScreenshotTool) => {\n if (!options) {\n throw new Error(\"Storybook plugin options are required\");\n }\n if (!options.storybookUrl) {\n throw new Error(\"storybookUrl is required\");\n }\n\n const {\n storybookUrl,\n includeStories = [],\n excludeStories = [],\n defaultViewport = { width: 1920, height: 1080 },\n waitForSelector,\n waitForTimeout,\n } = options;\n\n const storiesUrl = `${storybookUrl}/index.json`;\n console.log(`Fetching stories from: ${storiesUrl}`);\n\n try {\n // Fetch stories from Storybook\n const response = await fetch(storiesUrl);\n if (!response.ok) {\n throw new Error(\n `Failed to fetch stories: ${response.status} ${response.statusText}`\n );\n }\n\n const data: StorybookStoriesResponse = await response.json();\n const stories = Object.values(data.entries);\n\n // Filter stories based on include/exclude patterns\n let filteredStories = stories;\n\n if (includeStories.length > 0) {\n filteredStories = filteredStories.filter((story) =>\n includeStories.some(\n (pattern) =>\n story.title.includes(pattern) || story.name.includes(pattern)\n )\n );\n }\n\n if (excludeStories.length > 0) {\n filteredStories = filteredStories.filter(\n (story) =>\n !excludeStories.some(\n (pattern) =>\n story.title.includes(pattern) || story.name.includes(pattern)\n )\n );\n }\n\n // Filter docs etc\n filteredStories = filteredStories.filter(\n (story) => story.type === \"story\"\n );\n\n console.log(`Found ${filteredStories.length} stories to screenshot`);\n\n const results: Array<{\n storyId: string;\n storyName: string;\n storyTitle: string;\n success: boolean;\n filepath?: string;\n error?: string;\n }> = [];\n\n await screenshotTool.init();\n\n let currentLatch = createLatch<ScreenshotOptions>();\n\n await screenshotTool.page?.exposeFunction(\n \"__cappa_parameters\",\n async (payload: ScreenshotOptions) => {\n currentLatch.resolve(payload);\n }\n );\n\n // Take screenshots of each story\n for (const story of filteredStories) {\n try {\n const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;\n\n // Merge with default options\n const screenshotOptions = {\n viewport: defaultViewport,\n waitForSelector: waitForSelector,\n waitForTimeout: waitForTimeout,\n fullPage: true,\n quality: 90,\n type: \"jpeg\" as const,\n };\n\n // Take screenshot with story-specific filename\n const filename = `${story.title.replace(\n /[^a-zA-Z0-9]/g,\n \"_\"\n )}_${story.name.replace(/[^a-zA-Z0-9]/g, \"_\")}.${\n screenshotOptions.type\n }`;\n\n const page = screenshotTool.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n\n page.on(\"console\", (message) => {\n console.log(\"console\", message.text());\n });\n page.on(\"pageerror\", (error) => {\n console.log(\"pageerror\", error);\n });\n\n await page.goto(storyUrl);\n\n const options = await currentLatch.p;\n currentLatch = createLatch<ScreenshotOptions>();\n\n if (options.skip) {\n console.log(`Skipping story ${story.title} - ${story.name}`);\n }\n\n await freezeUI(page);\n await waitForVisualIdle(page);\n\n if (options.delay) {\n await page.waitForTimeout(options.delay);\n }\n\n // Actually take the screenshot\n const actualFilepath = await screenshotTool.takeScreenshot(\n page,\n filename,\n {\n fullPage: options.fullPage ?? screenshotOptions.fullPage,\n type: options.type ?? screenshotOptions.type,\n waitForSelector:\n options.waitForSelector ?? screenshotOptions.waitForSelector,\n waitForTimeout:\n options.waitForTimeout ?? screenshotOptions.waitForTimeout,\n }\n );\n\n results.push({\n storyId: story.id,\n storyName: story.name,\n storyTitle: story.title,\n success: true,\n filepath: actualFilepath,\n });\n } catch (error) {\n console.error(\n `Error taking screenshot of story ${story.title} - ${story.name}:`,\n (error as Error).message\n );\n results.push({\n storyId: story.id,\n storyName: story.name,\n storyTitle: story.title,\n success: false,\n error: (error as Error).message,\n });\n }\n }\n\n console.log(\n `Completed screenshots: ${results.filter((r) => r.success).length}/${\n results.length\n } successful`\n );\n return results;\n } catch (error) {\n console.error(\"Error in Storybook plugin:\", (error as Error).message);\n throw error;\n }\n },\n };\n};\n","/**\n * Wait for a function to be exposed on the window object\n * @param name - The name of the function to wait for\n * @param timeoutMs - The timeout in milliseconds\n * @returns The function or rejects if the function is not exposed within the timeout\n */\nexport const waitForExposed = (name: string, timeoutMs = 5000) => {\n return new Promise<Function>((resolve, reject) => {\n const start = performance.now();\n\n const t = setInterval(() => {\n const fn = (window as any)[name];\n if (typeof fn === \"function\") {\n clearInterval(t);\n resolve(fn);\n } else if (performance.now() - start > timeoutMs) {\n clearInterval(t);\n reject(new Error(`Timed out waiting for ${name}`));\n }\n }, 16);\n });\n};\n","import { makeDecorator } from \"storybook/preview-api\";\nimport { waitForExposed } from \"./util\";\n\nexport const withCappaDecorator = makeDecorator({\n name: \"withCappa\",\n parameterName: \"cappa\",\n skipIfNoParametersOrOptions: false,\n wrapper: (getStory, context, { parameters }) => {\n queueMicrotask(async () => {\n try {\n const cappaParameters = await waitForExposed(\"__cappa_parameters\");\n\n cappaParameters(parameters ?? {});\n } catch (error) {\n console.error(error);\n }\n });\n\n return getStory(context);\n },\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,MAAa,WAAW,OAAO,SAAe;AAC5C,OAAM,KAAK,YAAY,EACrB,SAAS;;;;KAKV,CAAC;;;;;;AAOJ,MAAa,oBAAoB,OAAO,SAAe;AAErD,OAAM,KAAK,iBAAiB,cAAc;AAE1C,OAAM,KAAK,SAAS,YAAY;AAE9B,MAAI,SAAS,OAAO,MAAO,OAAM,SAAS,MAAM;AAGhD,QAAM,IAAI,SAAS,MACjB,4BAA4B,sBAAsB,EAAE,CAAC,CACtD;GACD;;;;;;;;;;ACFJ,SAAS,cAAiB;CACxB,IAAIA;AAEJ,QAAO;EAAE,GADC,IAAI,SAAY,MAAO,UAAU,EAAG;EAClC;EAAS;;;;;;AAOvB,MAAaC,wBACX,YACG;AACH,QAAO;EACL,MAAM;EACN,aACE;EACF,SAAS;EACT,SAAS,OAAO,mBAAmC;AACjD,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,wCAAwC;AAE1D,OAAI,CAAC,QAAQ,aACX,OAAM,IAAI,MAAM,2BAA2B;GAG7C,MAAM,EACJ,cACA,iBAAiB,EAAE,EACnB,iBAAiB,EAAE,EACnB,kBAAkB;IAAE,OAAO;IAAM,QAAQ;IAAM,EAC/C,iBACA,mBACE;GAEJ,MAAM,aAAa,GAAG,aAAa;AACnC,WAAQ,IAAI,0BAA0B,aAAa;AAEnD,OAAI;IAEF,MAAM,WAAW,MAAM,MAAM,WAAW;AACxC,QAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MACR,4BAA4B,SAAS,OAAO,GAAG,SAAS,aACzD;IAGH,MAAMC,OAAiC,MAAM,SAAS,MAAM;IAI5D,IAAI,kBAHY,OAAO,OAAO,KAAK,QAAQ;AAK3C,QAAI,eAAe,SAAS,EAC1B,mBAAkB,gBAAgB,QAAQ,UACxC,eAAe,MACZ,YACC,MAAM,MAAM,SAAS,QAAQ,IAAI,MAAM,KAAK,SAAS,QAAQ,CAChE,CACF;AAGH,QAAI,eAAe,SAAS,EAC1B,mBAAkB,gBAAgB,QAC/B,UACC,CAAC,eAAe,MACb,YACC,MAAM,MAAM,SAAS,QAAQ,IAAI,MAAM,KAAK,SAAS,QAAQ,CAChE,CACJ;AAIH,sBAAkB,gBAAgB,QAC/B,UAAU,MAAM,SAAS,QAC3B;AAED,YAAQ,IAAI,SAAS,gBAAgB,OAAO,wBAAwB;IAEpE,MAAMC,UAOD,EAAE;AAEP,UAAM,eAAe,MAAM;IAE3B,IAAI,eAAe,aAAgC;AAEnD,UAAM,eAAe,MAAM,eACzB,sBACA,OAAO,YAA+B;AACpC,kBAAa,QAAQ,QAAQ;MAEhC;AAGD,SAAK,MAAM,SAAS,gBAClB,KAAI;KACF,MAAM,WAAW,GAAG,aAAa,kBAAkB,MAAM,GAAG;KAG5D,MAAM,oBAAoB;MACxB,UAAU;MACO;MACD;MAChB,UAAU;MACV,SAAS;MACT,MAAM;MACP;KAGD,MAAM,WAAW,GAAG,MAAM,MAAM,QAC9B,iBACA,IACD,CAAC,GAAG,MAAM,KAAK,QAAQ,iBAAiB,IAAI,CAAC,GAC5C,kBAAkB;KAGpB,MAAM,OAAO,eAAe;AAC5B,SAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAGzC,UAAK,GAAG,YAAY,YAAY;AAC9B,cAAQ,IAAI,WAAW,QAAQ,MAAM,CAAC;OACtC;AACF,UAAK,GAAG,cAAc,UAAU;AAC9B,cAAQ,IAAI,aAAa,MAAM;OAC/B;AAEF,WAAM,KAAK,KAAK,SAAS;KAEzB,MAAMC,YAAU,MAAM,aAAa;AACnC,oBAAe,aAAgC;AAE/C,SAAIA,UAAQ,KACV,SAAQ,IAAI,kBAAkB,MAAM,MAAM,KAAK,MAAM,OAAO;AAG9D,WAAM,SAAS,KAAK;AACpB,WAAM,kBAAkB,KAAK;AAE7B,SAAIA,UAAQ,MACV,OAAM,KAAK,eAAeA,UAAQ,MAAM;KAI1C,MAAM,iBAAiB,MAAM,eAAe,eAC1C,MACA,UACA;MACE,UAAUA,UAAQ,YAAY,kBAAkB;MAChD,MAAMA,UAAQ,QAAQ,kBAAkB;MACxC,iBACEA,UAAQ,mBAAmB,kBAAkB;MAC/C,gBACEA,UAAQ,kBAAkB,kBAAkB;MAC/C,CACF;AAED,aAAQ,KAAK;MACX,SAAS,MAAM;MACf,WAAW,MAAM;MACjB,YAAY,MAAM;MAClB,SAAS;MACT,UAAU;MACX,CAAC;aACK,OAAO;AACd,aAAQ,MACN,oCAAoC,MAAM,MAAM,KAAK,MAAM,KAAK,IAC/D,MAAgB,QAClB;AACD,aAAQ,KAAK;MACX,SAAS,MAAM;MACf,WAAW,MAAM;MACjB,YAAY,MAAM;MAClB,SAAS;MACT,OAAQ,MAAgB;MACzB,CAAC;;AAIN,YAAQ,IACN,0BAA0B,QAAQ,QAAQ,MAAM,EAAE,QAAQ,CAAC,OAAO,GAChE,QAAQ,OACT,aACF;AACD,WAAO;YACA,OAAO;AACd,YAAQ,MAAM,8BAA+B,MAAgB,QAAQ;AACrE,UAAM;;;EAGX;;;;;;;;;;;AC7NH,MAAa,kBAAkB,MAAc,YAAY,QAAS;AAChE,QAAO,IAAI,SAAmB,SAAS,WAAW;EAChD,MAAM,QAAQ,YAAY,KAAK;EAE/B,MAAM,IAAI,kBAAkB;GAC1B,MAAM,KAAM,OAAe;AAC3B,OAAI,OAAO,OAAO,YAAY;AAC5B,kBAAc,EAAE;AAChB,YAAQ,GAAG;cACF,YAAY,KAAK,GAAG,QAAQ,WAAW;AAChD,kBAAc,EAAE;AAChB,2BAAO,IAAI,MAAM,yBAAyB,OAAO,CAAC;;KAEnD,GAAG;GACN;;;;;ACjBJ,MAAa,8DAAmC;CAC9C,MAAM;CACN,eAAe;CACf,6BAA6B;CAC7B,UAAU,UAAU,SAAS,EAAE,iBAAiB;AAC9C,iBAAe,YAAY;AACzB,OAAI;AAGF,KAFwB,MAAM,eAAe,qBAAqB,EAElD,cAAc,EAAE,CAAC;YAC1B,OAAO;AACd,YAAQ,MAAM,MAAM;;IAEtB;AAEF,SAAO,SAAS,QAAQ;;CAE3B,CAAC"}
|
package/dist/index.mjs
CHANGED
|
@@ -67,7 +67,11 @@ const cappaPluginStorybook = (options) => {
|
|
|
67
67
|
filteredStories = filteredStories.filter((story) => story.type === "story");
|
|
68
68
|
console.log(`Found ${filteredStories.length} stories to screenshot`);
|
|
69
69
|
const results = [];
|
|
70
|
-
|
|
70
|
+
await screenshotTool.init();
|
|
71
|
+
let currentLatch = createLatch();
|
|
72
|
+
await screenshotTool.page?.exposeFunction("__cappa_parameters", async (payload) => {
|
|
73
|
+
currentLatch.resolve(payload);
|
|
74
|
+
});
|
|
71
75
|
for (const story of filteredStories) try {
|
|
72
76
|
const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;
|
|
73
77
|
const screenshotOptions = {
|
|
@@ -79,18 +83,17 @@ const cappaPluginStorybook = (options) => {
|
|
|
79
83
|
type: "jpeg"
|
|
80
84
|
};
|
|
81
85
|
const filename = `${story.title.replace(/[^a-zA-Z0-9]/g, "_")}_${story.name.replace(/[^a-zA-Z0-9]/g, "_")}.${screenshotOptions.type}`;
|
|
86
|
+
const page = screenshotTool.page;
|
|
87
|
+
if (!page) throw new Error("Page not initialized");
|
|
82
88
|
page.on("console", (message) => {
|
|
83
89
|
console.log("console", message.text());
|
|
84
90
|
});
|
|
85
91
|
page.on("pageerror", (error) => {
|
|
86
92
|
console.log("pageerror", error);
|
|
87
93
|
});
|
|
88
|
-
const latch = createLatch();
|
|
89
|
-
await page.exposeFunction("__cappa_parameters", async (payload) => {
|
|
90
|
-
latch.resolve(payload);
|
|
91
|
-
});
|
|
92
94
|
await page.goto(storyUrl);
|
|
93
|
-
const options$1 = await
|
|
95
|
+
const options$1 = await currentLatch.p;
|
|
96
|
+
currentLatch = createLatch();
|
|
94
97
|
if (options$1.skip) console.log(`Skipping story ${story.title} - ${story.name}`);
|
|
95
98
|
await freezeUI(page);
|
|
96
99
|
await waitForVisualIdle(page);
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["resolve!: (v: T) => void","cappaPluginStorybook: Plugin<StorybookPluginOptions>","data: StorybookStoriesResponse","results: Array<{\n storyId: string;\n storyName: string;\n storyTitle: string;\n success: boolean;\n filepath?: string;\n error?: string;\n }>","options"],"sources":["../src/cappa/util.ts","../src/cappa/plugin.ts","../src/storybook/util.ts","../src/storybook/decorator.ts"],"sourcesContent":["import type { Page } from \"playwright\";\n\n/**\n * Disable CSS transitions, animations, and scrollbars\n * @param page - The page to disable CSS transitions, animations, and scrollbars\n */\nexport const freezeUI = async (page: Page) => {\n await page.addStyleTag({\n content: `\n\t\t\t* { transition: none !important; animation: none !important }\n\t\t\t* { caret-color: transparent !important }\n\t\t\t::-webkit-scrollbar { display: none }\n\t\t`,\n });\n};\n\n/**\n * Wait for general visual stability on the page\n * @param page - The page to wait for\n */\nexport const waitForVisualIdle = async (page: Page) => {\n // Wait for the page to be fully loaded\n await page.waitForLoadState(\"networkidle\");\n\n await page.evaluate(async () => {\n // Wait for the fonts to be loaded\n if (document.fonts?.ready) await document.fonts.ready;\n\n // Wait for a frame to be idle in the requestAnimationFrame queue\n await new Promise((r) =>\n requestAnimationFrame(() => requestAnimationFrame(r))\n );\n });\n};\n","import { Plugin, ScreenshotOptions, ScreenshotTool } from \"@cappa/core\";\nimport { freezeUI, waitForVisualIdle } from \"./util\";\n\ninterface StorybookStory {\n id: string;\n name: string;\n title: string;\n kind: string;\n story: string;\n type: \"story\" | \"docs\";\n}\n\ninterface StorybookStoriesResponse {\n entries: Record<string, StorybookStory>;\n}\n\ninterface StorybookPluginOptions {\n storybookUrl: string;\n includeStories?: string[];\n excludeStories?: string[];\n defaultViewport?: { width: number; height: number };\n waitForSelector?: string;\n waitForTimeout?: number;\n}\n\n/**\n * Create a latch for a Promise. A latch is a Promise that can be resolved from outside.\n * @param T - The type of the Promise\n * @returns A latch for a Promise\n */\nfunction createLatch<T>() {\n let resolve!: (v: T) => void;\n const p = new Promise<T>((r) => (resolve = r));\n return { p, resolve };\n}\n\n/**\n * Storybook Plugin for Cappa\n * Fetches stories from a running Storybook server and takes screenshots of each story\n */\nexport const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (\n options\n) => {\n return {\n name: \"StorybookPlugin\",\n description:\n \"Takes screenshots of Storybook stories with configurable options\",\n version: \"1.0.0\",\n execute: async (screenshotTool: ScreenshotTool) => {\n if (!options) {\n throw new Error(\"Storybook plugin options are required\");\n }\n if (!options.storybookUrl) {\n throw new Error(\"storybookUrl is required\");\n }\n\n const {\n storybookUrl,\n includeStories = [],\n excludeStories = [],\n defaultViewport = { width: 1920, height: 1080 },\n waitForSelector,\n waitForTimeout,\n } = options;\n\n const storiesUrl = `${storybookUrl}/index.json`;\n console.log(`Fetching stories from: ${storiesUrl}`);\n\n try {\n // Fetch stories from Storybook\n const response = await fetch(storiesUrl);\n if (!response.ok) {\n throw new Error(\n `Failed to fetch stories: ${response.status} ${response.statusText}`\n );\n }\n\n const data: StorybookStoriesResponse = await response.json();\n const stories = Object.values(data.entries);\n\n // Filter stories based on include/exclude patterns\n let filteredStories = stories;\n\n if (includeStories.length > 0) {\n filteredStories = filteredStories.filter((story) =>\n includeStories.some(\n (pattern) =>\n story.title.includes(pattern) || story.name.includes(pattern)\n )\n );\n }\n\n if (excludeStories.length > 0) {\n filteredStories = filteredStories.filter(\n (story) =>\n !excludeStories.some(\n (pattern) =>\n story.title.includes(pattern) || story.name.includes(pattern)\n )\n );\n }\n\n // Filter docs etc\n filteredStories = filteredStories.filter(\n (story) => story.type === \"story\"\n );\n\n console.log(`Found ${filteredStories.length} stories to screenshot`);\n\n const results: Array<{\n storyId: string;\n storyName: string;\n storyTitle: string;\n success: boolean;\n filepath?: string;\n error?: string;\n }> = [];\n\n const page = await screenshotTool.newPage();\n\n // Take screenshots of each story\n for (const story of filteredStories) {\n try {\n const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;\n\n // Merge with default options\n const screenshotOptions = {\n viewport: defaultViewport,\n waitForSelector: waitForSelector,\n waitForTimeout: waitForTimeout,\n fullPage: true,\n quality: 90,\n type: \"jpeg\" as const,\n };\n\n // Take screenshot with story-specific filename\n const filename = `${story.title.replace(\n /[^a-zA-Z0-9]/g,\n \"_\"\n )}_${story.name.replace(/[^a-zA-Z0-9]/g, \"_\")}.${\n screenshotOptions.type\n }`;\n\n page.on(\"console\", (message) => {\n console.log(\"console\", message.text());\n });\n page.on(\"pageerror\", (error) => {\n console.log(\"pageerror\", error);\n });\n\n const latch = createLatch<ScreenshotOptions>();\n\n await page.exposeFunction(\n \"__cappa_parameters\",\n async (payload: ScreenshotOptions) => {\n latch.resolve(payload);\n }\n );\n\n await page.goto(storyUrl);\n\n const options = await latch.p;\n\n if (options.skip) {\n console.log(`Skipping story ${story.title} - ${story.name}`);\n }\n\n await freezeUI(page);\n await waitForVisualIdle(page);\n\n if (options.delay) {\n await page.waitForTimeout(options.delay);\n }\n\n // Actually take the screenshot\n const actualFilepath = await screenshotTool.takeScreenshot(\n page,\n filename,\n {\n fullPage: options.fullPage ?? screenshotOptions.fullPage,\n type: options.type ?? screenshotOptions.type,\n waitForSelector:\n options.waitForSelector ?? screenshotOptions.waitForSelector,\n waitForTimeout:\n options.waitForTimeout ?? screenshotOptions.waitForTimeout,\n }\n );\n\n results.push({\n storyId: story.id,\n storyName: story.name,\n storyTitle: story.title,\n success: true,\n filepath: actualFilepath,\n });\n } catch (error) {\n console.error(\n `Error taking screenshot of story ${story.title} - ${story.name}:`,\n (error as Error).message\n );\n results.push({\n storyId: story.id,\n storyName: story.name,\n storyTitle: story.title,\n success: false,\n error: (error as Error).message,\n });\n }\n }\n\n console.log(\n `Completed screenshots: ${results.filter((r) => r.success).length}/${\n results.length\n } successful`\n );\n return results;\n } catch (error) {\n console.error(\"Error in Storybook plugin:\", (error as Error).message);\n throw error;\n }\n },\n };\n};\n","/**\n * Wait for a function to be exposed on the window object\n * @param name - The name of the function to wait for\n * @param timeoutMs - The timeout in milliseconds\n * @returns The function or rejects if the function is not exposed within the timeout\n */\nexport const waitForExposed = (name: string, timeoutMs = 5000) => {\n return new Promise<Function>((resolve, reject) => {\n const start = performance.now();\n\n const t = setInterval(() => {\n const fn = (window as any)[name];\n if (typeof fn === \"function\") {\n clearInterval(t);\n resolve(fn);\n } else if (performance.now() - start > timeoutMs) {\n clearInterval(t);\n reject(new Error(`Timed out waiting for ${name}`));\n }\n }, 16);\n });\n};\n","import { makeDecorator } from \"storybook/preview-api\";\nimport { waitForExposed } from \"./util\";\n\nexport const withCappaDecorator = makeDecorator({\n name: \"withCappa\",\n parameterName: \"cappa\",\n skipIfNoParametersOrOptions: false,\n wrapper: (getStory, context, { parameters }) => {\n queueMicrotask(async () => {\n try {\n const cappaParameters = await waitForExposed(\"__cappa_parameters\");\n\n cappaParameters(parameters ?? {});\n } catch (error) {\n console.error(error);\n }\n });\n\n return getStory(context);\n },\n});\n"],"mappings":";;;;;;;;AAMA,MAAa,WAAW,OAAO,SAAe;AAC5C,OAAM,KAAK,YAAY,EACrB,SAAS;;;;KAKV,CAAC;;;;;;AAOJ,MAAa,oBAAoB,OAAO,SAAe;AAErD,OAAM,KAAK,iBAAiB,cAAc;AAE1C,OAAM,KAAK,SAAS,YAAY;AAE9B,MAAI,SAAS,OAAO,MAAO,OAAM,SAAS,MAAM;AAGhD,QAAM,IAAI,SAAS,MACjB,4BAA4B,sBAAsB,EAAE,CAAC,CACtD;GACD;;;;;;;;;;ACFJ,SAAS,cAAiB;CACxB,IAAIA;AAEJ,QAAO;EAAE,GADC,IAAI,SAAY,MAAO,UAAU,EAAG;EAClC;EAAS;;;;;;AAOvB,MAAaC,wBACX,YACG;AACH,QAAO;EACL,MAAM;EACN,aACE;EACF,SAAS;EACT,SAAS,OAAO,mBAAmC;AACjD,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,wCAAwC;AAE1D,OAAI,CAAC,QAAQ,aACX,OAAM,IAAI,MAAM,2BAA2B;GAG7C,MAAM,EACJ,cACA,iBAAiB,EAAE,EACnB,iBAAiB,EAAE,EACnB,kBAAkB;IAAE,OAAO;IAAM,QAAQ;IAAM,EAC/C,iBACA,mBACE;GAEJ,MAAM,aAAa,GAAG,aAAa;AACnC,WAAQ,IAAI,0BAA0B,aAAa;AAEnD,OAAI;IAEF,MAAM,WAAW,MAAM,MAAM,WAAW;AACxC,QAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MACR,4BAA4B,SAAS,OAAO,GAAG,SAAS,aACzD;IAGH,MAAMC,OAAiC,MAAM,SAAS,MAAM;IAI5D,IAAI,kBAHY,OAAO,OAAO,KAAK,QAAQ;AAK3C,QAAI,eAAe,SAAS,EAC1B,mBAAkB,gBAAgB,QAAQ,UACxC,eAAe,MACZ,YACC,MAAM,MAAM,SAAS,QAAQ,IAAI,MAAM,KAAK,SAAS,QAAQ,CAChE,CACF;AAGH,QAAI,eAAe,SAAS,EAC1B,mBAAkB,gBAAgB,QAC/B,UACC,CAAC,eAAe,MACb,YACC,MAAM,MAAM,SAAS,QAAQ,IAAI,MAAM,KAAK,SAAS,QAAQ,CAChE,CACJ;AAIH,sBAAkB,gBAAgB,QAC/B,UAAU,MAAM,SAAS,QAC3B;AAED,YAAQ,IAAI,SAAS,gBAAgB,OAAO,wBAAwB;IAEpE,MAAMC,UAOD,EAAE;IAEP,MAAM,OAAO,MAAM,eAAe,SAAS;AAG3C,SAAK,MAAM,SAAS,gBAClB,KAAI;KACF,MAAM,WAAW,GAAG,aAAa,kBAAkB,MAAM,GAAG;KAG5D,MAAM,oBAAoB;MACxB,UAAU;MACO;MACD;MAChB,UAAU;MACV,SAAS;MACT,MAAM;MACP;KAGD,MAAM,WAAW,GAAG,MAAM,MAAM,QAC9B,iBACA,IACD,CAAC,GAAG,MAAM,KAAK,QAAQ,iBAAiB,IAAI,CAAC,GAC5C,kBAAkB;AAGpB,UAAK,GAAG,YAAY,YAAY;AAC9B,cAAQ,IAAI,WAAW,QAAQ,MAAM,CAAC;OACtC;AACF,UAAK,GAAG,cAAc,UAAU;AAC9B,cAAQ,IAAI,aAAa,MAAM;OAC/B;KAEF,MAAM,QAAQ,aAAgC;AAE9C,WAAM,KAAK,eACT,sBACA,OAAO,YAA+B;AACpC,YAAM,QAAQ,QAAQ;OAEzB;AAED,WAAM,KAAK,KAAK,SAAS;KAEzB,MAAMC,YAAU,MAAM,MAAM;AAE5B,SAAIA,UAAQ,KACV,SAAQ,IAAI,kBAAkB,MAAM,MAAM,KAAK,MAAM,OAAO;AAG9D,WAAM,SAAS,KAAK;AACpB,WAAM,kBAAkB,KAAK;AAE7B,SAAIA,UAAQ,MACV,OAAM,KAAK,eAAeA,UAAQ,MAAM;KAI1C,MAAM,iBAAiB,MAAM,eAAe,eAC1C,MACA,UACA;MACE,UAAUA,UAAQ,YAAY,kBAAkB;MAChD,MAAMA,UAAQ,QAAQ,kBAAkB;MACxC,iBACEA,UAAQ,mBAAmB,kBAAkB;MAC/C,gBACEA,UAAQ,kBAAkB,kBAAkB;MAC/C,CACF;AAED,aAAQ,KAAK;MACX,SAAS,MAAM;MACf,WAAW,MAAM;MACjB,YAAY,MAAM;MAClB,SAAS;MACT,UAAU;MACX,CAAC;aACK,OAAO;AACd,aAAQ,MACN,oCAAoC,MAAM,MAAM,KAAK,MAAM,KAAK,IAC/D,MAAgB,QAClB;AACD,aAAQ,KAAK;MACX,SAAS,MAAM;MACf,WAAW,MAAM;MACjB,YAAY,MAAM;MAClB,SAAS;MACT,OAAQ,MAAgB;MACzB,CAAC;;AAIN,YAAQ,IACN,0BAA0B,QAAQ,QAAQ,MAAM,EAAE,QAAQ,CAAC,OAAO,GAChE,QAAQ,OACT,aACF;AACD,WAAO;YACA,OAAO;AACd,YAAQ,MAAM,8BAA+B,MAAgB,QAAQ;AACrE,UAAM;;;EAGX;;;;;;;;;;;ACvNH,MAAa,kBAAkB,MAAc,YAAY,QAAS;AAChE,QAAO,IAAI,SAAmB,SAAS,WAAW;EAChD,MAAM,QAAQ,YAAY,KAAK;EAE/B,MAAM,IAAI,kBAAkB;GAC1B,MAAM,KAAM,OAAe;AAC3B,OAAI,OAAO,OAAO,YAAY;AAC5B,kBAAc,EAAE;AAChB,YAAQ,GAAG;cACF,YAAY,KAAK,GAAG,QAAQ,WAAW;AAChD,kBAAc,EAAE;AAChB,2BAAO,IAAI,MAAM,yBAAyB,OAAO,CAAC;;KAEnD,GAAG;GACN;;;;;ACjBJ,MAAa,qBAAqB,cAAc;CAC9C,MAAM;CACN,eAAe;CACf,6BAA6B;CAC7B,UAAU,UAAU,SAAS,EAAE,iBAAiB;AAC9C,iBAAe,YAAY;AACzB,OAAI;AAGF,KAFwB,MAAM,eAAe,qBAAqB,EAElD,cAAc,EAAE,CAAC;YAC1B,OAAO;AACd,YAAQ,MAAM,MAAM;;IAEtB;AAEF,SAAO,SAAS,QAAQ;;CAE3B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["resolve!: (v: T) => void","cappaPluginStorybook: Plugin<StorybookPluginOptions>","data: StorybookStoriesResponse","results: Array<{\n storyId: string;\n storyName: string;\n storyTitle: string;\n success: boolean;\n filepath?: string;\n error?: string;\n }>","options"],"sources":["../src/cappa/util.ts","../src/cappa/plugin.ts","../src/storybook/util.ts","../src/storybook/decorator.ts"],"sourcesContent":["import type { Page } from \"playwright\";\n\n/**\n * Disable CSS transitions, animations, and scrollbars\n * @param page - The page to disable CSS transitions, animations, and scrollbars\n */\nexport const freezeUI = async (page: Page) => {\n await page.addStyleTag({\n content: `\n\t\t\t* { transition: none !important; animation: none !important }\n\t\t\t* { caret-color: transparent !important }\n\t\t\t::-webkit-scrollbar { display: none }\n\t\t`,\n });\n};\n\n/**\n * Wait for general visual stability on the page\n * @param page - The page to wait for\n */\nexport const waitForVisualIdle = async (page: Page) => {\n // Wait for the page to be fully loaded\n await page.waitForLoadState(\"networkidle\");\n\n await page.evaluate(async () => {\n // Wait for the fonts to be loaded\n if (document.fonts?.ready) await document.fonts.ready;\n\n // Wait for a frame to be idle in the requestAnimationFrame queue\n await new Promise((r) =>\n requestAnimationFrame(() => requestAnimationFrame(r))\n );\n });\n};\n","import { Plugin, ScreenshotOptions, ScreenshotTool } from \"@cappa/core\";\nimport { freezeUI, waitForVisualIdle } from \"./util\";\n\ninterface StorybookStory {\n id: string;\n name: string;\n title: string;\n kind: string;\n story: string;\n type: \"story\" | \"docs\";\n}\n\ninterface StorybookStoriesResponse {\n entries: Record<string, StorybookStory>;\n}\n\ninterface StorybookPluginOptions {\n storybookUrl: string;\n includeStories?: string[];\n excludeStories?: string[];\n defaultViewport?: { width: number; height: number };\n waitForSelector?: string;\n waitForTimeout?: number;\n}\n\n/**\n * Create a latch for a Promise. A latch is a Promise that can be resolved from outside.\n * @param T - The type of the Promise\n * @returns A latch for a Promise\n */\nfunction createLatch<T>() {\n let resolve!: (v: T) => void;\n const p = new Promise<T>((r) => (resolve = r));\n return { p, resolve };\n}\n\n/**\n * Storybook Plugin for Cappa\n * Fetches stories from a running Storybook server and takes screenshots of each story\n */\nexport const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (\n options\n) => {\n return {\n name: \"StorybookPlugin\",\n description:\n \"Takes screenshots of Storybook stories with configurable options\",\n version: \"1.0.0\",\n execute: async (screenshotTool: ScreenshotTool) => {\n if (!options) {\n throw new Error(\"Storybook plugin options are required\");\n }\n if (!options.storybookUrl) {\n throw new Error(\"storybookUrl is required\");\n }\n\n const {\n storybookUrl,\n includeStories = [],\n excludeStories = [],\n defaultViewport = { width: 1920, height: 1080 },\n waitForSelector,\n waitForTimeout,\n } = options;\n\n const storiesUrl = `${storybookUrl}/index.json`;\n console.log(`Fetching stories from: ${storiesUrl}`);\n\n try {\n // Fetch stories from Storybook\n const response = await fetch(storiesUrl);\n if (!response.ok) {\n throw new Error(\n `Failed to fetch stories: ${response.status} ${response.statusText}`\n );\n }\n\n const data: StorybookStoriesResponse = await response.json();\n const stories = Object.values(data.entries);\n\n // Filter stories based on include/exclude patterns\n let filteredStories = stories;\n\n if (includeStories.length > 0) {\n filteredStories = filteredStories.filter((story) =>\n includeStories.some(\n (pattern) =>\n story.title.includes(pattern) || story.name.includes(pattern)\n )\n );\n }\n\n if (excludeStories.length > 0) {\n filteredStories = filteredStories.filter(\n (story) =>\n !excludeStories.some(\n (pattern) =>\n story.title.includes(pattern) || story.name.includes(pattern)\n )\n );\n }\n\n // Filter docs etc\n filteredStories = filteredStories.filter(\n (story) => story.type === \"story\"\n );\n\n console.log(`Found ${filteredStories.length} stories to screenshot`);\n\n const results: Array<{\n storyId: string;\n storyName: string;\n storyTitle: string;\n success: boolean;\n filepath?: string;\n error?: string;\n }> = [];\n\n await screenshotTool.init();\n\n let currentLatch = createLatch<ScreenshotOptions>();\n\n await screenshotTool.page?.exposeFunction(\n \"__cappa_parameters\",\n async (payload: ScreenshotOptions) => {\n currentLatch.resolve(payload);\n }\n );\n\n // Take screenshots of each story\n for (const story of filteredStories) {\n try {\n const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;\n\n // Merge with default options\n const screenshotOptions = {\n viewport: defaultViewport,\n waitForSelector: waitForSelector,\n waitForTimeout: waitForTimeout,\n fullPage: true,\n quality: 90,\n type: \"jpeg\" as const,\n };\n\n // Take screenshot with story-specific filename\n const filename = `${story.title.replace(\n /[^a-zA-Z0-9]/g,\n \"_\"\n )}_${story.name.replace(/[^a-zA-Z0-9]/g, \"_\")}.${\n screenshotOptions.type\n }`;\n\n const page = screenshotTool.page;\n if (!page) {\n throw new Error(\"Page not initialized\");\n }\n\n page.on(\"console\", (message) => {\n console.log(\"console\", message.text());\n });\n page.on(\"pageerror\", (error) => {\n console.log(\"pageerror\", error);\n });\n\n await page.goto(storyUrl);\n\n const options = await currentLatch.p;\n currentLatch = createLatch<ScreenshotOptions>();\n\n if (options.skip) {\n console.log(`Skipping story ${story.title} - ${story.name}`);\n }\n\n await freezeUI(page);\n await waitForVisualIdle(page);\n\n if (options.delay) {\n await page.waitForTimeout(options.delay);\n }\n\n // Actually take the screenshot\n const actualFilepath = await screenshotTool.takeScreenshot(\n page,\n filename,\n {\n fullPage: options.fullPage ?? screenshotOptions.fullPage,\n type: options.type ?? screenshotOptions.type,\n waitForSelector:\n options.waitForSelector ?? screenshotOptions.waitForSelector,\n waitForTimeout:\n options.waitForTimeout ?? screenshotOptions.waitForTimeout,\n }\n );\n\n results.push({\n storyId: story.id,\n storyName: story.name,\n storyTitle: story.title,\n success: true,\n filepath: actualFilepath,\n });\n } catch (error) {\n console.error(\n `Error taking screenshot of story ${story.title} - ${story.name}:`,\n (error as Error).message\n );\n results.push({\n storyId: story.id,\n storyName: story.name,\n storyTitle: story.title,\n success: false,\n error: (error as Error).message,\n });\n }\n }\n\n console.log(\n `Completed screenshots: ${results.filter((r) => r.success).length}/${\n results.length\n } successful`\n );\n return results;\n } catch (error) {\n console.error(\"Error in Storybook plugin:\", (error as Error).message);\n throw error;\n }\n },\n };\n};\n","/**\n * Wait for a function to be exposed on the window object\n * @param name - The name of the function to wait for\n * @param timeoutMs - The timeout in milliseconds\n * @returns The function or rejects if the function is not exposed within the timeout\n */\nexport const waitForExposed = (name: string, timeoutMs = 5000) => {\n return new Promise<Function>((resolve, reject) => {\n const start = performance.now();\n\n const t = setInterval(() => {\n const fn = (window as any)[name];\n if (typeof fn === \"function\") {\n clearInterval(t);\n resolve(fn);\n } else if (performance.now() - start > timeoutMs) {\n clearInterval(t);\n reject(new Error(`Timed out waiting for ${name}`));\n }\n }, 16);\n });\n};\n","import { makeDecorator } from \"storybook/preview-api\";\nimport { waitForExposed } from \"./util\";\n\nexport const withCappaDecorator = makeDecorator({\n name: \"withCappa\",\n parameterName: \"cappa\",\n skipIfNoParametersOrOptions: false,\n wrapper: (getStory, context, { parameters }) => {\n queueMicrotask(async () => {\n try {\n const cappaParameters = await waitForExposed(\"__cappa_parameters\");\n\n cappaParameters(parameters ?? {});\n } catch (error) {\n console.error(error);\n }\n });\n\n return getStory(context);\n },\n});\n"],"mappings":";;;;;;;;AAMA,MAAa,WAAW,OAAO,SAAe;AAC5C,OAAM,KAAK,YAAY,EACrB,SAAS;;;;KAKV,CAAC;;;;;;AAOJ,MAAa,oBAAoB,OAAO,SAAe;AAErD,OAAM,KAAK,iBAAiB,cAAc;AAE1C,OAAM,KAAK,SAAS,YAAY;AAE9B,MAAI,SAAS,OAAO,MAAO,OAAM,SAAS,MAAM;AAGhD,QAAM,IAAI,SAAS,MACjB,4BAA4B,sBAAsB,EAAE,CAAC,CACtD;GACD;;;;;;;;;;ACFJ,SAAS,cAAiB;CACxB,IAAIA;AAEJ,QAAO;EAAE,GADC,IAAI,SAAY,MAAO,UAAU,EAAG;EAClC;EAAS;;;;;;AAOvB,MAAaC,wBACX,YACG;AACH,QAAO;EACL,MAAM;EACN,aACE;EACF,SAAS;EACT,SAAS,OAAO,mBAAmC;AACjD,OAAI,CAAC,QACH,OAAM,IAAI,MAAM,wCAAwC;AAE1D,OAAI,CAAC,QAAQ,aACX,OAAM,IAAI,MAAM,2BAA2B;GAG7C,MAAM,EACJ,cACA,iBAAiB,EAAE,EACnB,iBAAiB,EAAE,EACnB,kBAAkB;IAAE,OAAO;IAAM,QAAQ;IAAM,EAC/C,iBACA,mBACE;GAEJ,MAAM,aAAa,GAAG,aAAa;AACnC,WAAQ,IAAI,0BAA0B,aAAa;AAEnD,OAAI;IAEF,MAAM,WAAW,MAAM,MAAM,WAAW;AACxC,QAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MACR,4BAA4B,SAAS,OAAO,GAAG,SAAS,aACzD;IAGH,MAAMC,OAAiC,MAAM,SAAS,MAAM;IAI5D,IAAI,kBAHY,OAAO,OAAO,KAAK,QAAQ;AAK3C,QAAI,eAAe,SAAS,EAC1B,mBAAkB,gBAAgB,QAAQ,UACxC,eAAe,MACZ,YACC,MAAM,MAAM,SAAS,QAAQ,IAAI,MAAM,KAAK,SAAS,QAAQ,CAChE,CACF;AAGH,QAAI,eAAe,SAAS,EAC1B,mBAAkB,gBAAgB,QAC/B,UACC,CAAC,eAAe,MACb,YACC,MAAM,MAAM,SAAS,QAAQ,IAAI,MAAM,KAAK,SAAS,QAAQ,CAChE,CACJ;AAIH,sBAAkB,gBAAgB,QAC/B,UAAU,MAAM,SAAS,QAC3B;AAED,YAAQ,IAAI,SAAS,gBAAgB,OAAO,wBAAwB;IAEpE,MAAMC,UAOD,EAAE;AAEP,UAAM,eAAe,MAAM;IAE3B,IAAI,eAAe,aAAgC;AAEnD,UAAM,eAAe,MAAM,eACzB,sBACA,OAAO,YAA+B;AACpC,kBAAa,QAAQ,QAAQ;MAEhC;AAGD,SAAK,MAAM,SAAS,gBAClB,KAAI;KACF,MAAM,WAAW,GAAG,aAAa,kBAAkB,MAAM,GAAG;KAG5D,MAAM,oBAAoB;MACxB,UAAU;MACO;MACD;MAChB,UAAU;MACV,SAAS;MACT,MAAM;MACP;KAGD,MAAM,WAAW,GAAG,MAAM,MAAM,QAC9B,iBACA,IACD,CAAC,GAAG,MAAM,KAAK,QAAQ,iBAAiB,IAAI,CAAC,GAC5C,kBAAkB;KAGpB,MAAM,OAAO,eAAe;AAC5B,SAAI,CAAC,KACH,OAAM,IAAI,MAAM,uBAAuB;AAGzC,UAAK,GAAG,YAAY,YAAY;AAC9B,cAAQ,IAAI,WAAW,QAAQ,MAAM,CAAC;OACtC;AACF,UAAK,GAAG,cAAc,UAAU;AAC9B,cAAQ,IAAI,aAAa,MAAM;OAC/B;AAEF,WAAM,KAAK,KAAK,SAAS;KAEzB,MAAMC,YAAU,MAAM,aAAa;AACnC,oBAAe,aAAgC;AAE/C,SAAIA,UAAQ,KACV,SAAQ,IAAI,kBAAkB,MAAM,MAAM,KAAK,MAAM,OAAO;AAG9D,WAAM,SAAS,KAAK;AACpB,WAAM,kBAAkB,KAAK;AAE7B,SAAIA,UAAQ,MACV,OAAM,KAAK,eAAeA,UAAQ,MAAM;KAI1C,MAAM,iBAAiB,MAAM,eAAe,eAC1C,MACA,UACA;MACE,UAAUA,UAAQ,YAAY,kBAAkB;MAChD,MAAMA,UAAQ,QAAQ,kBAAkB;MACxC,iBACEA,UAAQ,mBAAmB,kBAAkB;MAC/C,gBACEA,UAAQ,kBAAkB,kBAAkB;MAC/C,CACF;AAED,aAAQ,KAAK;MACX,SAAS,MAAM;MACf,WAAW,MAAM;MACjB,YAAY,MAAM;MAClB,SAAS;MACT,UAAU;MACX,CAAC;aACK,OAAO;AACd,aAAQ,MACN,oCAAoC,MAAM,MAAM,KAAK,MAAM,KAAK,IAC/D,MAAgB,QAClB;AACD,aAAQ,KAAK;MACX,SAAS,MAAM;MACf,WAAW,MAAM;MACjB,YAAY,MAAM;MAClB,SAAS;MACT,OAAQ,MAAgB;MACzB,CAAC;;AAIN,YAAQ,IACN,0BAA0B,QAAQ,QAAQ,MAAM,EAAE,QAAQ,CAAC,OAAO,GAChE,QAAQ,OACT,aACF;AACD,WAAO;YACA,OAAO;AACd,YAAQ,MAAM,8BAA+B,MAAgB,QAAQ;AACrE,UAAM;;;EAGX;;;;;;;;;;;AC7NH,MAAa,kBAAkB,MAAc,YAAY,QAAS;AAChE,QAAO,IAAI,SAAmB,SAAS,WAAW;EAChD,MAAM,QAAQ,YAAY,KAAK;EAE/B,MAAM,IAAI,kBAAkB;GAC1B,MAAM,KAAM,OAAe;AAC3B,OAAI,OAAO,OAAO,YAAY;AAC5B,kBAAc,EAAE;AAChB,YAAQ,GAAG;cACF,YAAY,KAAK,GAAG,QAAQ,WAAW;AAChD,kBAAc,EAAE;AAChB,2BAAO,IAAI,MAAM,yBAAyB,OAAO,CAAC;;KAEnD,GAAG;GACN;;;;;ACjBJ,MAAa,qBAAqB,cAAc;CAC9C,MAAM;CACN,eAAe;CACf,6BAA6B;CAC7B,UAAU,UAAU,SAAS,EAAE,iBAAiB;AAC9C,iBAAe,YAAY;AACzB,OAAI;AAGF,KAFwB,MAAM,eAAe,qBAAqB,EAElD,cAAc,EAAE,CAAC;YAC1B,OAAO;AACd,YAAQ,MAAM,MAAM;;IAEtB;AAEF,SAAO,SAAS,QAAQ;;CAE3B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cappa/plugin-storybook",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.10",
|
|
4
4
|
"description": "Storybook plugin for Cappa - takes screenshots of Storybook stories",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"storybook": "^9.1.4",
|
|
27
|
-
"@cappa/core": "0.0.
|
|
27
|
+
"@cappa/core": "0.0.10"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"tsdown": "0.14.1",
|
package/src/cappa/plugin.ts
CHANGED
|
@@ -116,7 +116,16 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
116
116
|
error?: string;
|
|
117
117
|
}> = [];
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
await screenshotTool.init();
|
|
120
|
+
|
|
121
|
+
let currentLatch = createLatch<ScreenshotOptions>();
|
|
122
|
+
|
|
123
|
+
await screenshotTool.page?.exposeFunction(
|
|
124
|
+
"__cappa_parameters",
|
|
125
|
+
async (payload: ScreenshotOptions) => {
|
|
126
|
+
currentLatch.resolve(payload);
|
|
127
|
+
}
|
|
128
|
+
);
|
|
120
129
|
|
|
121
130
|
// Take screenshots of each story
|
|
122
131
|
for (const story of filteredStories) {
|
|
@@ -141,6 +150,11 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
141
150
|
screenshotOptions.type
|
|
142
151
|
}`;
|
|
143
152
|
|
|
153
|
+
const page = screenshotTool.page;
|
|
154
|
+
if (!page) {
|
|
155
|
+
throw new Error("Page not initialized");
|
|
156
|
+
}
|
|
157
|
+
|
|
144
158
|
page.on("console", (message) => {
|
|
145
159
|
console.log("console", message.text());
|
|
146
160
|
});
|
|
@@ -148,18 +162,10 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
148
162
|
console.log("pageerror", error);
|
|
149
163
|
});
|
|
150
164
|
|
|
151
|
-
const latch = createLatch<ScreenshotOptions>();
|
|
152
|
-
|
|
153
|
-
await page.exposeFunction(
|
|
154
|
-
"__cappa_parameters",
|
|
155
|
-
async (payload: ScreenshotOptions) => {
|
|
156
|
-
latch.resolve(payload);
|
|
157
|
-
}
|
|
158
|
-
);
|
|
159
|
-
|
|
160
165
|
await page.goto(storyUrl);
|
|
161
166
|
|
|
162
|
-
const options = await
|
|
167
|
+
const options = await currentLatch.p;
|
|
168
|
+
currentLatch = createLatch<ScreenshotOptions>();
|
|
163
169
|
|
|
164
170
|
if (options.skip) {
|
|
165
171
|
console.log(`Skipping story ${story.title} - ${story.name}`);
|