@cappa/plugin-storybook 0.0.3 → 0.0.5
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 +31 -0
- package/CHANGELOG.md +15 -0
- package/dist/index.d.mts +25 -0
- package/dist/index.d.ts +25 -0
- package/dist/index.js +199 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +174 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +2 -2
- package/src/cappa/plugin.ts +4 -3
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
> @cappa/plugin-storybook@0.0.4 build /home/tim/cappa/packages/plugins/plugin-storybook
|
|
4
|
+
> tsdown
|
|
5
|
+
|
|
6
|
+
[34mℹ[39m tsdown [2mv0.14.1[22m powered by rolldown [2mv1.0.0-beta.37[22m
|
|
7
|
+
[34mℹ[39m Using tsdown config: [4m/home/tim/cappa/packages/plugins/plugin-storybook/tsdown.config.ts[24m
|
|
8
|
+
(node:59324) [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
|
+
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/plugins/plugin-storybook/package.json.
|
|
11
|
+
(Use `node --trace-warnings ...` to show where the warning was created)
|
|
12
|
+
[34mℹ[39m entry: [34msrc/index.ts[39m
|
|
13
|
+
[34mℹ[39m tsconfig: [34m../../../tsconfig.json[39m
|
|
14
|
+
[34mℹ[39m Build start
|
|
15
|
+
[34mℹ[39m Cleaning 6 files
|
|
16
|
+
[33mWarning: Invalid input options (1 issue found)
|
|
17
|
+
- For the "resolve.tsconfigFilename". It is deprecated. Please use the top-level `tsconfig` option instead. [0m
|
|
18
|
+
[33mWarning: Invalid input options (1 issue found)
|
|
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.24 kB[22m [2m│ gzip: 2.54 kB[22m
|
|
21
|
+
[34mℹ[39m [33m[CJS][39m [2mdist/[22mindex.js.map [2m12.74 kB[22m [2m│ gzip: 4.04 kB[22m
|
|
22
|
+
[34mℹ[39m [33m[CJS][39m 2 files, total: 19.98 kB
|
|
23
|
+
[33mWarning: Invalid input options (1 issue found)
|
|
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.14 kB[22m [2m│ gzip: 2.13 kB[22m
|
|
26
|
+
[34mℹ[39m [34m[ESM][39m [2mdist/[22mindex.mjs.map [2m12.72 kB[22m [2m│ gzip: 4.04 kB[22m
|
|
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: 19.58 kB
|
|
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
|
+
[34mℹ[39m [33m[CJS][39m 1 files, total: 0.71 kB
|
|
31
|
+
[32m✔[39m Build complete in [32m1302ms[39m
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# @cappa/plugin-storybook
|
|
2
2
|
|
|
3
|
+
## 0.0.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- a8a0d8f: Add delay option
|
|
8
|
+
- Updated dependencies [a8a0d8f]
|
|
9
|
+
- @cappa/core@0.0.5
|
|
10
|
+
|
|
11
|
+
## 0.0.4
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Updated dependencies [148b9ca]
|
|
16
|
+
- @cappa/core@0.0.4
|
|
17
|
+
|
|
3
18
|
## 0.0.3
|
|
4
19
|
|
|
5
20
|
### Patch Changes
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { Plugin } from "@cappa/core";
|
|
2
|
+
|
|
3
|
+
//#region src/cappa/plugin.d.ts
|
|
4
|
+
interface StorybookPluginOptions {
|
|
5
|
+
storybookUrl: string;
|
|
6
|
+
includeStories?: string[];
|
|
7
|
+
excludeStories?: string[];
|
|
8
|
+
defaultViewport?: {
|
|
9
|
+
width: number;
|
|
10
|
+
height: number;
|
|
11
|
+
};
|
|
12
|
+
waitForSelector?: string;
|
|
13
|
+
waitForTimeout?: number;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Storybook Plugin for Cappa
|
|
17
|
+
* Fetches stories from a running Storybook server and takes screenshots of each story
|
|
18
|
+
*/
|
|
19
|
+
declare const cappaPluginStorybook: Plugin<StorybookPluginOptions>;
|
|
20
|
+
//#endregion
|
|
21
|
+
//#region src/storybook/decorator.d.ts
|
|
22
|
+
declare const withCappaDecorator: (...args: any) => any;
|
|
23
|
+
//#endregion
|
|
24
|
+
export { cappaPluginStorybook, withCappaDecorator };
|
|
25
|
+
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { Plugin } from "@cappa/core";
|
|
2
|
+
|
|
3
|
+
//#region src/cappa/plugin.d.ts
|
|
4
|
+
interface StorybookPluginOptions {
|
|
5
|
+
storybookUrl: string;
|
|
6
|
+
includeStories?: string[];
|
|
7
|
+
excludeStories?: string[];
|
|
8
|
+
defaultViewport?: {
|
|
9
|
+
width: number;
|
|
10
|
+
height: number;
|
|
11
|
+
};
|
|
12
|
+
waitForSelector?: string;
|
|
13
|
+
waitForTimeout?: number;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Storybook Plugin for Cappa
|
|
17
|
+
* Fetches stories from a running Storybook server and takes screenshots of each story
|
|
18
|
+
*/
|
|
19
|
+
declare const cappaPluginStorybook: Plugin<StorybookPluginOptions>;
|
|
20
|
+
//#endregion
|
|
21
|
+
//#region src/storybook/decorator.d.ts
|
|
22
|
+
declare const withCappaDecorator: (...args: any) => any;
|
|
23
|
+
//#endregion
|
|
24
|
+
export { cappaPluginStorybook, withCappaDecorator };
|
|
25
|
+
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
//#region rolldown:runtime
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __copyProps = (to, from, except, desc) => {
|
|
9
|
+
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
|
|
10
|
+
key = keys[i];
|
|
11
|
+
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
|
|
12
|
+
get: ((k) => from[k]).bind(null, key),
|
|
13
|
+
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
|
|
19
|
+
value: mod,
|
|
20
|
+
enumerable: true
|
|
21
|
+
}) : target, mod));
|
|
22
|
+
|
|
23
|
+
//#endregion
|
|
24
|
+
require("@cappa/core");
|
|
25
|
+
let storybook_preview_api = require("storybook/preview-api");
|
|
26
|
+
storybook_preview_api = __toESM(storybook_preview_api);
|
|
27
|
+
|
|
28
|
+
//#region src/cappa/util.ts
|
|
29
|
+
/**
|
|
30
|
+
* Disable CSS transitions, animations, and scrollbars
|
|
31
|
+
* @param page - The page to disable CSS transitions, animations, and scrollbars
|
|
32
|
+
*/
|
|
33
|
+
const freezeUI = async (page) => {
|
|
34
|
+
await page.addStyleTag({ content: `
|
|
35
|
+
* { transition: none !important; animation: none !important }
|
|
36
|
+
* { caret-color: transparent !important }
|
|
37
|
+
::-webkit-scrollbar { display: none }
|
|
38
|
+
` });
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* Wait for general visual stability on the page
|
|
42
|
+
* @param page - The page to wait for
|
|
43
|
+
*/
|
|
44
|
+
const waitForVisualIdle = async (page) => {
|
|
45
|
+
await page.waitForLoadState("networkidle");
|
|
46
|
+
await page.evaluate(async () => {
|
|
47
|
+
if (document.fonts?.ready) await document.fonts.ready;
|
|
48
|
+
await new Promise((r) => requestAnimationFrame(() => requestAnimationFrame(r)));
|
|
49
|
+
});
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
//#endregion
|
|
53
|
+
//#region src/cappa/plugin.ts
|
|
54
|
+
/**
|
|
55
|
+
* Create a latch for a Promise. A latch is a Promise that can be resolved from outside.
|
|
56
|
+
* @param T - The type of the Promise
|
|
57
|
+
* @returns A latch for a Promise
|
|
58
|
+
*/
|
|
59
|
+
function createLatch() {
|
|
60
|
+
let resolve;
|
|
61
|
+
return {
|
|
62
|
+
p: new Promise((r) => resolve = r),
|
|
63
|
+
resolve
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Storybook Plugin for Cappa
|
|
68
|
+
* Fetches stories from a running Storybook server and takes screenshots of each story
|
|
69
|
+
*/
|
|
70
|
+
const cappaPluginStorybook = (options) => {
|
|
71
|
+
return {
|
|
72
|
+
name: "StorybookPlugin",
|
|
73
|
+
description: "Takes screenshots of Storybook stories with configurable options",
|
|
74
|
+
version: "1.0.0",
|
|
75
|
+
execute: async (screenshotTool) => {
|
|
76
|
+
if (!options) throw new Error("Storybook plugin options are required");
|
|
77
|
+
if (!options.storybookUrl) throw new Error("storybookUrl is required");
|
|
78
|
+
const { storybookUrl, includeStories = [], excludeStories = [], defaultViewport = {
|
|
79
|
+
width: 1920,
|
|
80
|
+
height: 1080
|
|
81
|
+
}, waitForSelector, waitForTimeout } = options;
|
|
82
|
+
const storiesUrl = `${storybookUrl}/index.json`;
|
|
83
|
+
console.log(`Fetching stories from: ${storiesUrl}`);
|
|
84
|
+
try {
|
|
85
|
+
const response = await fetch(storiesUrl);
|
|
86
|
+
if (!response.ok) throw new Error(`Failed to fetch stories: ${response.status} ${response.statusText}`);
|
|
87
|
+
const data = await response.json();
|
|
88
|
+
let filteredStories = Object.values(data.entries);
|
|
89
|
+
if (includeStories.length > 0) filteredStories = filteredStories.filter((story) => includeStories.some((pattern) => story.title.includes(pattern) || story.name.includes(pattern)));
|
|
90
|
+
if (excludeStories.length > 0) filteredStories = filteredStories.filter((story) => !excludeStories.some((pattern) => story.title.includes(pattern) || story.name.includes(pattern)));
|
|
91
|
+
filteredStories = filteredStories.filter((story) => story.type === "story");
|
|
92
|
+
console.log(`Found ${filteredStories.length} stories to screenshot`);
|
|
93
|
+
const results = [];
|
|
94
|
+
for (const story of filteredStories) try {
|
|
95
|
+
const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;
|
|
96
|
+
const screenshotOptions = {
|
|
97
|
+
viewport: defaultViewport,
|
|
98
|
+
waitForSelector,
|
|
99
|
+
waitForTimeout,
|
|
100
|
+
fullPage: true,
|
|
101
|
+
quality: 90,
|
|
102
|
+
type: "jpeg"
|
|
103
|
+
};
|
|
104
|
+
const filename = `${story.title.replace(/[^a-zA-Z0-9]/g, "_")}_${story.name.replace(/[^a-zA-Z0-9]/g, "_")}.${screenshotOptions.type}`;
|
|
105
|
+
const page = await screenshotTool.newPage();
|
|
106
|
+
page.on("console", (message) => {
|
|
107
|
+
console.log("console", message.text());
|
|
108
|
+
});
|
|
109
|
+
page.on("pageerror", (error) => {
|
|
110
|
+
console.log("pageerror", error);
|
|
111
|
+
});
|
|
112
|
+
const latch = createLatch();
|
|
113
|
+
await page.exposeFunction("__cappa_parameters", async (payload) => {
|
|
114
|
+
latch.resolve(payload);
|
|
115
|
+
});
|
|
116
|
+
await page.goto(storyUrl);
|
|
117
|
+
const options$1 = await latch.p;
|
|
118
|
+
await freezeUI(page);
|
|
119
|
+
await waitForVisualIdle(page);
|
|
120
|
+
if (options$1.delay) await page.waitForTimeout(options$1.delay);
|
|
121
|
+
const actualFilepath = await screenshotTool.takeScreenshot(page, filename, {
|
|
122
|
+
fullPage: options$1.fullPage ?? screenshotOptions.fullPage,
|
|
123
|
+
type: options$1.type ?? screenshotOptions.type,
|
|
124
|
+
waitForSelector: options$1.waitForSelector ?? screenshotOptions.waitForSelector,
|
|
125
|
+
waitForTimeout: options$1.waitForTimeout ?? screenshotOptions.waitForTimeout
|
|
126
|
+
});
|
|
127
|
+
results.push({
|
|
128
|
+
storyId: story.id,
|
|
129
|
+
storyName: story.name,
|
|
130
|
+
storyTitle: story.title,
|
|
131
|
+
success: true,
|
|
132
|
+
filepath: actualFilepath
|
|
133
|
+
});
|
|
134
|
+
} catch (error) {
|
|
135
|
+
console.error(`Error taking screenshot of story ${story.title} - ${story.name}:`, error.message);
|
|
136
|
+
results.push({
|
|
137
|
+
storyId: story.id,
|
|
138
|
+
storyName: story.name,
|
|
139
|
+
storyTitle: story.title,
|
|
140
|
+
success: false,
|
|
141
|
+
error: error.message
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
console.log(`Completed screenshots: ${results.filter((r) => r.success).length}/${results.length} successful`);
|
|
145
|
+
return results;
|
|
146
|
+
} catch (error) {
|
|
147
|
+
console.error("Error in Storybook plugin:", error.message);
|
|
148
|
+
throw error;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
};
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
//#endregion
|
|
155
|
+
//#region src/storybook/util.ts
|
|
156
|
+
/**
|
|
157
|
+
* Wait for a function to be exposed on the window object
|
|
158
|
+
* @param name - The name of the function to wait for
|
|
159
|
+
* @param timeoutMs - The timeout in milliseconds
|
|
160
|
+
* @returns The function or rejects if the function is not exposed within the timeout
|
|
161
|
+
*/
|
|
162
|
+
const waitForExposed = (name, timeoutMs = 5e3) => {
|
|
163
|
+
return new Promise((resolve, reject) => {
|
|
164
|
+
const start = performance.now();
|
|
165
|
+
const t = setInterval(() => {
|
|
166
|
+
const fn = window[name];
|
|
167
|
+
if (typeof fn === "function") {
|
|
168
|
+
clearInterval(t);
|
|
169
|
+
resolve(fn);
|
|
170
|
+
} else if (performance.now() - start > timeoutMs) {
|
|
171
|
+
clearInterval(t);
|
|
172
|
+
reject(/* @__PURE__ */ new Error(`Timed out waiting for ${name}`));
|
|
173
|
+
}
|
|
174
|
+
}, 16);
|
|
175
|
+
});
|
|
176
|
+
};
|
|
177
|
+
|
|
178
|
+
//#endregion
|
|
179
|
+
//#region src/storybook/decorator.ts
|
|
180
|
+
const withCappaDecorator = (0, storybook_preview_api.makeDecorator)({
|
|
181
|
+
name: "withCappa",
|
|
182
|
+
parameterName: "cappa",
|
|
183
|
+
skipIfNoParametersOrOptions: false,
|
|
184
|
+
wrapper: (getStory, context, { parameters }) => {
|
|
185
|
+
queueMicrotask(async () => {
|
|
186
|
+
try {
|
|
187
|
+
(await waitForExposed("__cappa_parameters"))(parameters ?? {});
|
|
188
|
+
} catch (error) {
|
|
189
|
+
console.error(error);
|
|
190
|
+
}
|
|
191
|
+
});
|
|
192
|
+
return getStory(context);
|
|
193
|
+
}
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
//#endregion
|
|
197
|
+
exports.cappaPluginStorybook = cappaPluginStorybook;
|
|
198
|
+
exports.withCappaDecorator = withCappaDecorator;
|
|
199
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +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 // 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 = await screenshotTool.newPage();\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 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;AAGP,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,MAAM,eAAe,SAAS;AAE3C,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,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;;;;;;;;;;;ACnNH,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
ADDED
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
import { Plugin } from "@cappa/core";
|
|
2
|
+
import { makeDecorator } from "storybook/preview-api";
|
|
3
|
+
|
|
4
|
+
//#region src/cappa/util.ts
|
|
5
|
+
/**
|
|
6
|
+
* Disable CSS transitions, animations, and scrollbars
|
|
7
|
+
* @param page - The page to disable CSS transitions, animations, and scrollbars
|
|
8
|
+
*/
|
|
9
|
+
const freezeUI = async (page) => {
|
|
10
|
+
await page.addStyleTag({ content: `
|
|
11
|
+
* { transition: none !important; animation: none !important }
|
|
12
|
+
* { caret-color: transparent !important }
|
|
13
|
+
::-webkit-scrollbar { display: none }
|
|
14
|
+
` });
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Wait for general visual stability on the page
|
|
18
|
+
* @param page - The page to wait for
|
|
19
|
+
*/
|
|
20
|
+
const waitForVisualIdle = async (page) => {
|
|
21
|
+
await page.waitForLoadState("networkidle");
|
|
22
|
+
await page.evaluate(async () => {
|
|
23
|
+
if (document.fonts?.ready) await document.fonts.ready;
|
|
24
|
+
await new Promise((r) => requestAnimationFrame(() => requestAnimationFrame(r)));
|
|
25
|
+
});
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
//#endregion
|
|
29
|
+
//#region src/cappa/plugin.ts
|
|
30
|
+
/**
|
|
31
|
+
* Create a latch for a Promise. A latch is a Promise that can be resolved from outside.
|
|
32
|
+
* @param T - The type of the Promise
|
|
33
|
+
* @returns A latch for a Promise
|
|
34
|
+
*/
|
|
35
|
+
function createLatch() {
|
|
36
|
+
let resolve;
|
|
37
|
+
return {
|
|
38
|
+
p: new Promise((r) => resolve = r),
|
|
39
|
+
resolve
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Storybook Plugin for Cappa
|
|
44
|
+
* Fetches stories from a running Storybook server and takes screenshots of each story
|
|
45
|
+
*/
|
|
46
|
+
const cappaPluginStorybook = (options) => {
|
|
47
|
+
return {
|
|
48
|
+
name: "StorybookPlugin",
|
|
49
|
+
description: "Takes screenshots of Storybook stories with configurable options",
|
|
50
|
+
version: "1.0.0",
|
|
51
|
+
execute: async (screenshotTool) => {
|
|
52
|
+
if (!options) throw new Error("Storybook plugin options are required");
|
|
53
|
+
if (!options.storybookUrl) throw new Error("storybookUrl is required");
|
|
54
|
+
const { storybookUrl, includeStories = [], excludeStories = [], defaultViewport = {
|
|
55
|
+
width: 1920,
|
|
56
|
+
height: 1080
|
|
57
|
+
}, waitForSelector, waitForTimeout } = options;
|
|
58
|
+
const storiesUrl = `${storybookUrl}/index.json`;
|
|
59
|
+
console.log(`Fetching stories from: ${storiesUrl}`);
|
|
60
|
+
try {
|
|
61
|
+
const response = await fetch(storiesUrl);
|
|
62
|
+
if (!response.ok) throw new Error(`Failed to fetch stories: ${response.status} ${response.statusText}`);
|
|
63
|
+
const data = await response.json();
|
|
64
|
+
let filteredStories = Object.values(data.entries);
|
|
65
|
+
if (includeStories.length > 0) filteredStories = filteredStories.filter((story) => includeStories.some((pattern) => story.title.includes(pattern) || story.name.includes(pattern)));
|
|
66
|
+
if (excludeStories.length > 0) filteredStories = filteredStories.filter((story) => !excludeStories.some((pattern) => story.title.includes(pattern) || story.name.includes(pattern)));
|
|
67
|
+
filteredStories = filteredStories.filter((story) => story.type === "story");
|
|
68
|
+
console.log(`Found ${filteredStories.length} stories to screenshot`);
|
|
69
|
+
const results = [];
|
|
70
|
+
for (const story of filteredStories) try {
|
|
71
|
+
const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;
|
|
72
|
+
const screenshotOptions = {
|
|
73
|
+
viewport: defaultViewport,
|
|
74
|
+
waitForSelector,
|
|
75
|
+
waitForTimeout,
|
|
76
|
+
fullPage: true,
|
|
77
|
+
quality: 90,
|
|
78
|
+
type: "jpeg"
|
|
79
|
+
};
|
|
80
|
+
const filename = `${story.title.replace(/[^a-zA-Z0-9]/g, "_")}_${story.name.replace(/[^a-zA-Z0-9]/g, "_")}.${screenshotOptions.type}`;
|
|
81
|
+
const page = await screenshotTool.newPage();
|
|
82
|
+
page.on("console", (message) => {
|
|
83
|
+
console.log("console", message.text());
|
|
84
|
+
});
|
|
85
|
+
page.on("pageerror", (error) => {
|
|
86
|
+
console.log("pageerror", error);
|
|
87
|
+
});
|
|
88
|
+
const latch = createLatch();
|
|
89
|
+
await page.exposeFunction("__cappa_parameters", async (payload) => {
|
|
90
|
+
latch.resolve(payload);
|
|
91
|
+
});
|
|
92
|
+
await page.goto(storyUrl);
|
|
93
|
+
const options$1 = await latch.p;
|
|
94
|
+
await freezeUI(page);
|
|
95
|
+
await waitForVisualIdle(page);
|
|
96
|
+
if (options$1.delay) await page.waitForTimeout(options$1.delay);
|
|
97
|
+
const actualFilepath = await screenshotTool.takeScreenshot(page, filename, {
|
|
98
|
+
fullPage: options$1.fullPage ?? screenshotOptions.fullPage,
|
|
99
|
+
type: options$1.type ?? screenshotOptions.type,
|
|
100
|
+
waitForSelector: options$1.waitForSelector ?? screenshotOptions.waitForSelector,
|
|
101
|
+
waitForTimeout: options$1.waitForTimeout ?? screenshotOptions.waitForTimeout
|
|
102
|
+
});
|
|
103
|
+
results.push({
|
|
104
|
+
storyId: story.id,
|
|
105
|
+
storyName: story.name,
|
|
106
|
+
storyTitle: story.title,
|
|
107
|
+
success: true,
|
|
108
|
+
filepath: actualFilepath
|
|
109
|
+
});
|
|
110
|
+
} catch (error) {
|
|
111
|
+
console.error(`Error taking screenshot of story ${story.title} - ${story.name}:`, error.message);
|
|
112
|
+
results.push({
|
|
113
|
+
storyId: story.id,
|
|
114
|
+
storyName: story.name,
|
|
115
|
+
storyTitle: story.title,
|
|
116
|
+
success: false,
|
|
117
|
+
error: error.message
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
console.log(`Completed screenshots: ${results.filter((r) => r.success).length}/${results.length} successful`);
|
|
121
|
+
return results;
|
|
122
|
+
} catch (error) {
|
|
123
|
+
console.error("Error in Storybook plugin:", error.message);
|
|
124
|
+
throw error;
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
|
|
130
|
+
//#endregion
|
|
131
|
+
//#region src/storybook/util.ts
|
|
132
|
+
/**
|
|
133
|
+
* Wait for a function to be exposed on the window object
|
|
134
|
+
* @param name - The name of the function to wait for
|
|
135
|
+
* @param timeoutMs - The timeout in milliseconds
|
|
136
|
+
* @returns The function or rejects if the function is not exposed within the timeout
|
|
137
|
+
*/
|
|
138
|
+
const waitForExposed = (name, timeoutMs = 5e3) => {
|
|
139
|
+
return new Promise((resolve, reject) => {
|
|
140
|
+
const start = performance.now();
|
|
141
|
+
const t = setInterval(() => {
|
|
142
|
+
const fn = window[name];
|
|
143
|
+
if (typeof fn === "function") {
|
|
144
|
+
clearInterval(t);
|
|
145
|
+
resolve(fn);
|
|
146
|
+
} else if (performance.now() - start > timeoutMs) {
|
|
147
|
+
clearInterval(t);
|
|
148
|
+
reject(/* @__PURE__ */ new Error(`Timed out waiting for ${name}`));
|
|
149
|
+
}
|
|
150
|
+
}, 16);
|
|
151
|
+
});
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
//#endregion
|
|
155
|
+
//#region src/storybook/decorator.ts
|
|
156
|
+
const withCappaDecorator = makeDecorator({
|
|
157
|
+
name: "withCappa",
|
|
158
|
+
parameterName: "cappa",
|
|
159
|
+
skipIfNoParametersOrOptions: false,
|
|
160
|
+
wrapper: (getStory, context, { parameters }) => {
|
|
161
|
+
queueMicrotask(async () => {
|
|
162
|
+
try {
|
|
163
|
+
(await waitForExposed("__cappa_parameters"))(parameters ?? {});
|
|
164
|
+
} catch (error) {
|
|
165
|
+
console.error(error);
|
|
166
|
+
}
|
|
167
|
+
});
|
|
168
|
+
return getStory(context);
|
|
169
|
+
}
|
|
170
|
+
});
|
|
171
|
+
|
|
172
|
+
//#endregion
|
|
173
|
+
export { cappaPluginStorybook, withCappaDecorator };
|
|
174
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +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 // 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 = await screenshotTool.newPage();\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 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;AAGP,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,MAAM,eAAe,SAAS;AAE3C,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,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;;;;;;;;;;;ACnNH,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.5",
|
|
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.5"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"tsdown": "0.14.1",
|
package/src/cappa/plugin.ts
CHANGED
|
@@ -156,9 +156,6 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
156
156
|
latch.resolve(payload);
|
|
157
157
|
}
|
|
158
158
|
);
|
|
159
|
-
await page.exposeFunction("__cappa_error", (error: Error) => {
|
|
160
|
-
throw error;
|
|
161
|
-
});
|
|
162
159
|
|
|
163
160
|
await page.goto(storyUrl);
|
|
164
161
|
|
|
@@ -167,6 +164,10 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
167
164
|
await freezeUI(page);
|
|
168
165
|
await waitForVisualIdle(page);
|
|
169
166
|
|
|
167
|
+
if (options.delay) {
|
|
168
|
+
await page.waitForTimeout(options.delay);
|
|
169
|
+
}
|
|
170
|
+
|
|
170
171
|
// Actually take the screenshot
|
|
171
172
|
const actualFilepath = await screenshotTool.takeScreenshot(
|
|
172
173
|
page,
|