@cappa/plugin-storybook 0.1.3 → 0.2.1

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/dist/index.mjs CHANGED
@@ -7,7 +7,42 @@ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require
7
7
 
8
8
  // src/cappa/plugin.ts
9
9
  import { getLogger } from "@cappa/logger";
10
- import chalk from "chalk";
10
+
11
+ // src/cappa/storybook-url.ts
12
+ function encodePairs(obj) {
13
+ if (!obj || !Object.keys(obj).length) return "";
14
+ return Object.entries(obj).filter(([, v]) => v !== void 0).map(([k, v]) => {
15
+ const val = typeof v === "string" ? encodeURIComponent(v) : typeof v === "number" || typeof v === "boolean" ? String(v) : encodeURIComponent(JSON.stringify(v));
16
+ return `${encodeURIComponent(k)}:${val}`;
17
+ }).join(";");
18
+ }
19
+ function buildStorybookIframeUrl({
20
+ baseUrl,
21
+ storyId,
22
+ viewMode = "story",
23
+ args,
24
+ globals,
25
+ query,
26
+ fullscreen = true,
27
+ singleStory = true
28
+ }) {
29
+ const u = new URL("/iframe.html", baseUrl);
30
+ u.searchParams.set("id", storyId);
31
+ u.searchParams.set("viewMode", viewMode);
32
+ const argPairs = encodePairs(args);
33
+ if (argPairs) u.searchParams.set("args", argPairs);
34
+ const globalPairs = encodePairs(globals);
35
+ if (globalPairs) u.searchParams.set("globals", globalPairs);
36
+ if (fullscreen) u.searchParams.set("full", "1");
37
+ if (singleStory) u.searchParams.set("singleStory", "true");
38
+ if (query) {
39
+ for (const [k, v] of Object.entries(query)) {
40
+ if (v === void 0) continue;
41
+ u.searchParams.set(k, String(v));
42
+ }
43
+ }
44
+ return u.toString();
45
+ }
11
46
 
12
47
  // src/cappa/util.ts
13
48
  var freezeUI = async (page) => {
@@ -84,6 +119,33 @@ var buildFilename = (story) => {
84
119
  };
85
120
 
86
121
  // src/cappa/plugin.ts
122
+ async function waitForPlayFunctionCompletion(page, storyName) {
123
+ const logger = getLogger();
124
+ try {
125
+ const hasPlayFunction = await page.evaluate(
126
+ () => window.__cappa_has_play_function === true
127
+ );
128
+ if (!hasPlayFunction) {
129
+ return;
130
+ }
131
+ logger.debug(
132
+ `Waiting for play function to complete for story: ${storyName}`
133
+ );
134
+ await page.waitForFunction(() => window.playAfterEach === true, {
135
+ timeout: 1e4
136
+ });
137
+ logger.debug(`Play function completed for story: ${storyName}`);
138
+ await page.evaluate(() => {
139
+ window.playAfterEach = false;
140
+ window.__cappa_has_play_function = false;
141
+ });
142
+ } catch {
143
+ await page.evaluate(() => {
144
+ window.playAfterEach = false;
145
+ window.__cappa_has_play_function = false;
146
+ });
147
+ }
148
+ }
87
149
  function createLatch() {
88
150
  let resolve;
89
151
  const p = new Promise((r) => resolve = r);
@@ -93,8 +155,7 @@ var cappaPluginStorybook = (options) => {
93
155
  return {
94
156
  name: "StorybookPlugin",
95
157
  description: "Takes screenshots of Storybook stories with configurable options",
96
- version: "1.0.0",
97
- execute: async (screenshotTool) => {
158
+ discover: async () => {
98
159
  if (!options) {
99
160
  throw new Error("Storybook plugin options are required");
100
161
  }
@@ -105,7 +166,8 @@ var cappaPluginStorybook = (options) => {
105
166
  const {
106
167
  storybookUrl,
107
168
  includeStories = [],
108
- excludeStories = []
169
+ excludeStories = [],
170
+ storybook: defaultStorybookOptions
109
171
  } = options;
110
172
  const storiesUrl = `${storybookUrl}/index.json`;
111
173
  logger.debug(`Fetching stories from: ${storiesUrl}`);
@@ -115,159 +177,195 @@ var cappaPluginStorybook = (options) => {
115
177
  `Failed to fetch stories: ${response.status} ${response.statusText}`
116
178
  );
117
179
  }
180
+ const data = await response.json();
181
+ const stories = Object.values(data.entries);
182
+ let filteredStories = stories;
183
+ if (includeStories.length > 0) {
184
+ filteredStories = filteredStories.filter(
185
+ (story) => includeStories.some(
186
+ (pattern) => story.title.includes(pattern) || story.name.includes(pattern)
187
+ )
188
+ );
189
+ }
190
+ if (excludeStories.length > 0) {
191
+ filteredStories = filteredStories.filter(
192
+ (story) => !excludeStories.some(
193
+ (pattern) => story.title.includes(pattern) || story.name.includes(pattern)
194
+ )
195
+ );
196
+ }
197
+ filteredStories = filteredStories.filter(
198
+ (story) => story.type === "story"
199
+ );
200
+ logger.start(`Found ${filteredStories.length} stories to screenshot...`);
201
+ return filteredStories.map((story) => ({
202
+ id: story.id,
203
+ url: buildStorybookIframeUrl({
204
+ baseUrl: storybookUrl,
205
+ storyId: story.id,
206
+ viewMode: defaultStorybookOptions?.viewMode,
207
+ args: defaultStorybookOptions?.args,
208
+ globals: defaultStorybookOptions?.globals,
209
+ query: defaultStorybookOptions?.query,
210
+ fullscreen: defaultStorybookOptions?.fullscreen,
211
+ singleStory: defaultStorybookOptions?.singleStory
212
+ }),
213
+ data: {
214
+ story
215
+ }
216
+ }));
217
+ },
218
+ initPage: async () => {
219
+ return {
220
+ latchMap: /* @__PURE__ */ new Map()
221
+ };
222
+ },
223
+ // Phase 2: Execute single story
224
+ execute: async (task, page, screenshotTool, context) => {
225
+ const { url, data } = task;
226
+ const { story } = data;
227
+ const logger = getLogger();
228
+ const { storybook: defaultStorybookOptions } = options || {};
118
229
  try {
119
- const data = await response.json();
120
- const stories = Object.values(data.entries);
121
- let filteredStories = stories;
122
- if (includeStories.length > 0) {
123
- filteredStories = filteredStories.filter(
124
- (story) => includeStories.some(
125
- (pattern) => story.title.includes(pattern) || story.name.includes(pattern)
126
- )
230
+ const currentLatch = createLatch();
231
+ context.latchMap.set(story.id, currentLatch);
232
+ if (await page.evaluate(() => {
233
+ return window.__cappa_parameters === void 0;
234
+ })) {
235
+ await page.exposeFunction(
236
+ "__cappa_parameters",
237
+ async (id, payload) => {
238
+ context.latchMap.get(id)?.resolve?.(payload);
239
+ }
127
240
  );
128
241
  }
129
- if (excludeStories.length > 0) {
130
- filteredStories = filteredStories.filter(
131
- (story) => !excludeStories.some(
132
- (pattern) => story.title.includes(pattern) || story.name.includes(pattern)
133
- )
134
- );
242
+ page.on("console", (message) => {
243
+ logger.debug("console", message.text());
244
+ });
245
+ page.on("pageerror", (error) => {
246
+ logger.debug("pageerror", error);
247
+ });
248
+ await page.goto(url);
249
+ const storyParameters = await context.latchMap.get(story.id)?.p;
250
+ context.latchMap.delete(story.id);
251
+ const variantParameters = storyParameters?.variants ?? [];
252
+ if (storyParameters?.skip) {
253
+ logger.warn(`Skipping story ${story.title} - ${story.name}`);
254
+ return {
255
+ storyId: story.id,
256
+ storyName: `${story.title} - ${story.name}`,
257
+ skipped: true
258
+ };
135
259
  }
136
- filteredStories = filteredStories.filter(
137
- (story) => story.type === "story"
138
- );
139
- logger.start(
140
- `Found ${filteredStories.length} stories to screenshot...`
141
- );
142
- const results = [];
143
- await screenshotTool.init();
144
- let currentLatch = createLatch();
145
- await screenshotTool.page?.exposeFunction(
146
- "__cappa_parameters",
147
- async (payload) => {
148
- currentLatch.resolve(payload);
149
- }
260
+ if (storyParameters && Object.keys(storyParameters).length > 0) {
261
+ logger.debug("Taking screenshot with options", storyParameters);
262
+ }
263
+ const resolvedViewport = storyParameters?.viewport ?? screenshotTool.viewport;
264
+ await page.setViewportSize(resolvedViewport);
265
+ await freezeUI(page);
266
+ await waitForVisualIdle(page);
267
+ await waitForPlayFunctionCompletion(
268
+ page,
269
+ `${story.title} - ${story.name}`
150
270
  );
151
- for (const story of filteredStories) {
152
- try {
153
- const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;
154
- const page = screenshotTool.page;
155
- if (!page) {
156
- throw new Error("Page not initialized");
157
- }
158
- page.on("console", (message) => {
159
- logger.debug("console", message.text());
160
- });
161
- page.on("pageerror", (error) => {
162
- logger.debug("pageerror", error);
271
+ const toLocatorMask = (mask) => mask?.map((selector) => page.locator(selector));
272
+ const filename = buildFilename(story);
273
+ const expectedExists = screenshotTool.filesystem.hasExpectedFile(filename);
274
+ if (!expectedExists) {
275
+ logger.info(
276
+ `Expected image not found for story ${story.title} - ${story.name}, taking screenshot`
277
+ );
278
+ }
279
+ const variantsWithUrls = variantParameters.map(
280
+ (variant) => {
281
+ const variantFilename = variant.filename || screenshotTool.getVariantFilename(filename, {
282
+ id: variant.id,
283
+ label: variant.label,
284
+ filename: variant.filename
163
285
  });
164
- await page.goto(storyUrl);
165
- const options2 = await currentLatch.p;
166
- currentLatch = createLatch();
167
- if (options2.skip) {
168
- logger.warn(`Skipping story ${story.title} - ${story.name}`);
169
- results.push({
170
- storyId: story.id,
171
- storyName: `${story.title} - ${story.name}`,
172
- skipped: true
173
- });
174
- continue;
175
- }
176
- if (options2 && Object.keys(options2).length > 0) {
177
- logger.debug("Taking screenshot with options", options2);
178
- }
179
- await freezeUI(page);
180
- await waitForVisualIdle(page);
181
- if (options2.delay) {
182
- await page.waitForTimeout(options2.delay);
183
- }
184
- const filename = buildFilename(story);
185
- const expectedExists = screenshotTool.hasExpectedImage(filename);
186
- let actualFilepath;
187
- if (expectedExists) {
188
- const { screenshotPath, comparisonResult } = await screenshotTool.takeScreenshotWithComparison(
189
- page,
190
- filename,
191
- screenshotTool.getExpectedImageBuffer(filename),
192
- {
193
- fullPage: options2.fullPage,
194
- mask: options2.mask?.map(
195
- (selector) => page.locator(selector)
196
- ),
197
- omitBackground: options2.omitBackground,
198
- saveDiffImage: true
199
- }
200
- );
201
- actualFilepath = screenshotPath;
202
- results.push({
203
- storyId: story.id,
204
- storyName: `${story.title} - ${story.name}`,
205
- filepath: actualFilepath,
206
- success: comparisonResult.passed
207
- });
208
- } else {
209
- logger.info(
210
- `Expected image not found for story ${story.title} - ${story.name}, taking screenshot`
211
- );
212
- actualFilepath = await screenshotTool.takeScreenshot(
213
- page,
214
- filename,
215
- {
216
- fullPage: options2.fullPage,
217
- mask: options2.mask?.map((selector) => page.locator(selector)),
218
- omitBackground: options2.omitBackground
219
- }
220
- );
221
- results.push({
286
+ const mergedArgs = {
287
+ ...defaultStorybookOptions?.args,
288
+ ...variant.options?.args
289
+ };
290
+ return {
291
+ id: variant.id,
292
+ label: variant.label,
293
+ filename: variantFilename,
294
+ url: buildStorybookIframeUrl({
295
+ baseUrl: options?.storybookUrl || "",
222
296
  storyId: story.id,
223
- storyName: `${story.title} - ${story.name}`,
224
- filepath: actualFilepath,
225
- success: true
226
- });
227
- }
228
- } catch (error) {
229
- logger.error(
230
- `Error taking screenshot of story ${story.title} - ${story.name}:`,
231
- error.message
297
+ viewMode: defaultStorybookOptions?.viewMode,
298
+ args: mergedArgs,
299
+ globals: defaultStorybookOptions?.globals,
300
+ query: defaultStorybookOptions?.query,
301
+ fullscreen: defaultStorybookOptions?.fullscreen,
302
+ singleStory: defaultStorybookOptions?.singleStory
303
+ }),
304
+ options: variant.options ? {
305
+ ...variant.options,
306
+ mask: toLocatorMask(variant.options.mask)
307
+ } : void 0
308
+ };
309
+ }
310
+ );
311
+ const baseOptions = {
312
+ fullPage: storyParameters?.fullPage,
313
+ delay: storyParameters?.delay,
314
+ omitBackground: storyParameters?.omitBackground,
315
+ skip: storyParameters?.skip,
316
+ viewport: storyParameters?.viewport ?? screenshotTool.viewport,
317
+ mask: toLocatorMask(storyParameters?.mask)
318
+ };
319
+ const variantFilenameMap = /* @__PURE__ */ new Map();
320
+ for (const variant of variantsWithUrls) {
321
+ const variantFilename = variant.filename;
322
+ if (!variantFilename) continue;
323
+ variantFilenameMap.set(variant.id, variantFilename);
324
+ if (!screenshotTool.filesystem.hasExpectedFile(variantFilename)) {
325
+ logger.info(
326
+ `Expected image not found for variant ${story.title} - ${story.name} [${variant.label ?? variant.id}], taking screenshot`
232
327
  );
233
- results.push({
234
- storyId: story.id,
235
- storyName: `${story.title} - ${story.name}`,
236
- error: error?.message ?? "Unknown error"
237
- });
238
328
  }
239
329
  }
240
- if (results.some((r) => r.error)) {
241
- logger.error(
242
- `Error report:
243
- ${results.filter((r) => r.error).map((r) => `${r.storyName}: ${r.error}`).join("\n")}`
244
- );
245
- }
246
- if (results.some((r) => r.skipped)) {
247
- logger.warn(
248
- `Skipped stories:
249
- ${results.filter((r) => r.skipped).map((r) => `${r.storyName}`).join("\n")}`
250
- );
251
- }
252
- const skipped = results.filter((r) => r.skipped);
253
- const failed = results.filter(
254
- (r) => r.error || !r.skipped && !r.success
330
+ const variantExtrasEntries = variantsWithUrls.map(
331
+ (variant) => [
332
+ variant.id,
333
+ {
334
+ saveDiffImage: true,
335
+ diffImageFilename: variant.filename
336
+ }
337
+ ]
255
338
  );
256
- const successful = results.filter((r) => r.success);
257
- const output = [
258
- `${chalk.yellow("Skipped stories:")} ${skipped.length}`,
259
- `${chalk.red("Failed stories:")} ${failed.length}`,
260
- `${chalk.green("Successful stories:")} ${successful.length}`,
261
- `${chalk.blue("Total stories:")} ${results.length}`
262
- ];
263
- logger.box({
264
- title: "Storybook Report",
265
- message: output.join("\n")
266
- });
267
- return results;
339
+ const captureExtras = {
340
+ saveDiffImage: true,
341
+ diffImageFilename: filename,
342
+ variants: variantExtrasEntries.length ? Object.fromEntries(variantExtrasEntries) : void 0
343
+ };
344
+ const captureResult = await screenshotTool.captureWithVariants(
345
+ page,
346
+ filename,
347
+ url,
348
+ baseOptions,
349
+ variantsWithUrls,
350
+ captureExtras
351
+ );
352
+ return {
353
+ storyId: story.id,
354
+ storyName: `${story.title} - ${story.name}`,
355
+ filepath: captureResult.base.filepath,
356
+ success: captureResult.base.skipped ? void 0 : captureResult.base.comparisonResult ? captureResult.base.comparisonResult.passed : Boolean(captureResult.base.filepath),
357
+ skipped: captureResult.base.skipped
358
+ };
268
359
  } catch (error) {
269
- logger.error("Error in Storybook plugin:", error.message);
270
- throw error;
360
+ logger.error(
361
+ `Error taking screenshot of story ${story.title} - ${story.name}:`,
362
+ error.message
363
+ );
364
+ return {
365
+ storyId: story.id,
366
+ storyName: `${story.title} - ${story.name}`,
367
+ error: error?.message ?? "Unknown error"
368
+ };
271
369
  }
272
370
  }
273
371
  };
package/dist/preview.mjs CHANGED
@@ -25,13 +25,15 @@ var withCappaDecorator = makeDecorator({
25
25
  skipIfNoParametersOrOptions: false,
26
26
  wrapper: (getStory, context, { parameters: parameters2 }) => {
27
27
  window.__cappa_screenshot = true;
28
- const _hasPlayFunction = context.playFunction != null;
28
+ if (context.playFunction != null) {
29
+ window.__cappa_has_play_function = true;
30
+ }
29
31
  queueMicrotask(async () => {
30
32
  try {
31
33
  const cappaParameters = await waitForExposed("__cappa_parameters");
32
- cappaParameters(parameters2 ?? {});
34
+ cappaParameters(context.id, parameters2 ?? {});
33
35
  } catch (error) {
34
- console.error(error);
36
+ console.error("Cappa decorator error:", error);
35
37
  }
36
38
  });
37
39
  return getStory(context);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cappa/plugin-storybook",
3
- "version": "0.1.3",
3
+ "version": "0.2.1",
4
4
  "description": "Storybook plugin for Cappa - takes screenshots of Storybook stories",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -8,6 +8,8 @@
8
8
  "main": "./dist/index.js",
9
9
  "types": "./dist/index.d.ts",
10
10
  "module": "CommonJS",
11
+ "license": "MIT",
12
+ "author": "Tim Richter",
11
13
  "exports": {
12
14
  ".": {
13
15
  "import": "./dist/index.js",
@@ -25,21 +27,19 @@
25
27
  "storybook",
26
28
  "visual-testing"
27
29
  ],
28
- "author": "Tim Richter",
29
- "license": "MIT",
30
30
  "dependencies": {
31
31
  "@swc/core": "^1.13.5",
32
32
  "chalk": "^5.6.2",
33
- "storybook": "^9.1.5",
34
- "@cappa/core": "0.1.3",
35
- "@cappa/logger": "0.0.3"
33
+ "storybook": "^9.1.12",
34
+ "@cappa/core": "0.2.1",
35
+ "@cappa/logger": "0.0.4"
36
36
  },
37
37
  "devDependencies": {
38
38
  "@vitest/coverage-v8": "3.2.4",
39
39
  "@vitest/ui": "3.2.4",
40
- "playwright-core": "^1.55.0",
40
+ "playwright-core": "^1.56.0",
41
41
  "tsup": "8.5.0",
42
- "typescript": "5.7.3",
42
+ "typescript": "5.9.3",
43
43
  "vitest": "3.2.4"
44
44
  },
45
45
  "scripts": {