@cappa/plugin-storybook 0.8.0 → 0.8.2
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/browser.cjs +9 -31
- package/dist/browser.d.cts +3 -2
- package/dist/{browser.d.ts → browser.d.mts} +3 -2
- package/dist/browser.mjs +9 -0
- package/dist/index.cjs.cjs +322 -0
- package/dist/index.cjs.d.cts +59 -56
- package/dist/index.esm.d.mts +84 -0
- package/dist/index.esm.mjs +321 -0
- package/dist/preview.d.mts +6 -0
- package/dist/preview.mjs +58 -0
- package/package.json +18 -18
- package/dist/browser.js +0 -7
- package/dist/index.cjs +0 -423
- package/dist/index.esm.d.ts +0 -81
- package/dist/index.js +0 -390
- package/dist/preview.js +0 -60
package/dist/index.js
DELETED
|
@@ -1,390 +0,0 @@
|
|
|
1
|
-
// src/index.esm.ts
|
|
2
|
-
import { fileURLToPath } from "url";
|
|
3
|
-
|
|
4
|
-
// src/cappa/plugin.ts
|
|
5
|
-
import { getLogger } from "@cappa/logger";
|
|
6
|
-
|
|
7
|
-
// src/cappa/storybook-url.ts
|
|
8
|
-
function encodePairs(obj) {
|
|
9
|
-
if (!obj || !Object.keys(obj).length) return "";
|
|
10
|
-
return Object.entries(obj).filter(([, v]) => v !== void 0).map(([k, v]) => {
|
|
11
|
-
const val = typeof v === "string" ? encodeURIComponent(v) : typeof v === "number" || typeof v === "boolean" ? String(v) : encodeURIComponent(JSON.stringify(v));
|
|
12
|
-
return `${encodeURIComponent(k)}:${val}`;
|
|
13
|
-
}).join(";");
|
|
14
|
-
}
|
|
15
|
-
function buildStorybookIframeUrl({
|
|
16
|
-
baseUrl,
|
|
17
|
-
storyId,
|
|
18
|
-
viewMode = "story",
|
|
19
|
-
args,
|
|
20
|
-
globals,
|
|
21
|
-
query,
|
|
22
|
-
fullscreen = true,
|
|
23
|
-
singleStory = true
|
|
24
|
-
}) {
|
|
25
|
-
const u = new URL("/iframe.html", baseUrl);
|
|
26
|
-
u.searchParams.set("id", storyId);
|
|
27
|
-
u.searchParams.set("viewMode", viewMode);
|
|
28
|
-
const argPairs = encodePairs(args);
|
|
29
|
-
if (argPairs) u.searchParams.set("args", argPairs);
|
|
30
|
-
const globalPairs = encodePairs(globals);
|
|
31
|
-
if (globalPairs) u.searchParams.set("globals", globalPairs);
|
|
32
|
-
if (fullscreen) u.searchParams.set("full", "1");
|
|
33
|
-
if (singleStory) u.searchParams.set("singleStory", "true");
|
|
34
|
-
if (query) {
|
|
35
|
-
for (const [k, v] of Object.entries(query)) {
|
|
36
|
-
if (v === void 0) continue;
|
|
37
|
-
u.searchParams.set(k, String(v));
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
return u.toString();
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
// src/cappa/util.ts
|
|
44
|
-
var freezeUI = async (page) => {
|
|
45
|
-
await page.addStyleTag({
|
|
46
|
-
content: `
|
|
47
|
-
*, *::before, *::after {
|
|
48
|
-
-moz-animation: none !important;
|
|
49
|
-
-moz-transition: none !important;
|
|
50
|
-
transition: none !important;
|
|
51
|
-
animation: none !important;
|
|
52
|
-
}
|
|
53
|
-
*, input, textarea { caret-color: transparent !important }
|
|
54
|
-
*:focus { outline: none !important }
|
|
55
|
-
*:focus-visible { outline: none !important }
|
|
56
|
-
*:focus-within { outline: none !important }
|
|
57
|
-
* { text-rendering: optimizeLegibility !important }
|
|
58
|
-
::-webkit-scrollbar { display: none !important }
|
|
59
|
-
html { scroll-behavior: auto !important }
|
|
60
|
-
svg, svg * {
|
|
61
|
-
shape-rendering: crispEdges !important;
|
|
62
|
-
text-rendering: geometricPrecision !important;
|
|
63
|
-
vector-effect: non-scaling-stroke !important;
|
|
64
|
-
}
|
|
65
|
-
img { image-rendering: crisp-edges !important }
|
|
66
|
-
`
|
|
67
|
-
});
|
|
68
|
-
};
|
|
69
|
-
var waitForVisualIdle = async (page) => {
|
|
70
|
-
await page.waitForLoadState("load");
|
|
71
|
-
await page.evaluate(async () => {
|
|
72
|
-
await document.fonts?.ready?.catch(() => {
|
|
73
|
-
});
|
|
74
|
-
const imgs = Array.from(document.images).filter((i) => !i.complete);
|
|
75
|
-
await Promise.all(
|
|
76
|
-
imgs.map(
|
|
77
|
-
(i) => new Promise((res) => {
|
|
78
|
-
i.onload = i.onerror = () => res(null);
|
|
79
|
-
})
|
|
80
|
-
)
|
|
81
|
-
);
|
|
82
|
-
});
|
|
83
|
-
await page.evaluate(
|
|
84
|
-
({ minIdleMs }) => new Promise((resolve) => {
|
|
85
|
-
let timer = null;
|
|
86
|
-
let last = performance.now();
|
|
87
|
-
const done = () => {
|
|
88
|
-
if (timer) cancelAnimationFrame(timer);
|
|
89
|
-
resolve();
|
|
90
|
-
};
|
|
91
|
-
const mo = new MutationObserver(() => {
|
|
92
|
-
last = performance.now();
|
|
93
|
-
});
|
|
94
|
-
mo.observe(document, {
|
|
95
|
-
attributes: true,
|
|
96
|
-
childList: true,
|
|
97
|
-
subtree: true,
|
|
98
|
-
characterData: true
|
|
99
|
-
});
|
|
100
|
-
const tick = () => {
|
|
101
|
-
if (performance.now() - last >= minIdleMs) {
|
|
102
|
-
mo.disconnect();
|
|
103
|
-
done();
|
|
104
|
-
} else {
|
|
105
|
-
timer = requestAnimationFrame(tick);
|
|
106
|
-
}
|
|
107
|
-
};
|
|
108
|
-
requestAnimationFrame(() => requestAnimationFrame(tick));
|
|
109
|
-
}),
|
|
110
|
-
{ minIdleMs: 100 }
|
|
111
|
-
);
|
|
112
|
-
};
|
|
113
|
-
var buildFilename = (story) => {
|
|
114
|
-
return `${story.title.replace(/[^a-zA-Z0-9/]/g, "")}/${story.name.replace(/[^a-zA-Z0-9]/g, "")}.png`;
|
|
115
|
-
};
|
|
116
|
-
|
|
117
|
-
// src/cappa/plugin.ts
|
|
118
|
-
async function waitForPlayFunctionCompletion(page, storyName) {
|
|
119
|
-
const logger = getLogger();
|
|
120
|
-
try {
|
|
121
|
-
const hasPlayFunction = await page.evaluate(
|
|
122
|
-
() => window.__cappa_has_play_function === true
|
|
123
|
-
);
|
|
124
|
-
if (!hasPlayFunction) {
|
|
125
|
-
return;
|
|
126
|
-
}
|
|
127
|
-
logger.debug(
|
|
128
|
-
`Waiting for play function to complete for story: ${storyName}`
|
|
129
|
-
);
|
|
130
|
-
await page.waitForFunction(() => window.playAfterEach === true, {
|
|
131
|
-
timeout: 1e4
|
|
132
|
-
});
|
|
133
|
-
logger.debug(`Play function completed for story: ${storyName}`);
|
|
134
|
-
await page.evaluate(() => {
|
|
135
|
-
window.playAfterEach = false;
|
|
136
|
-
window.__cappa_has_play_function = false;
|
|
137
|
-
});
|
|
138
|
-
} catch {
|
|
139
|
-
await page.evaluate(() => {
|
|
140
|
-
window.playAfterEach = false;
|
|
141
|
-
window.__cappa_has_play_function = false;
|
|
142
|
-
});
|
|
143
|
-
}
|
|
144
|
-
}
|
|
145
|
-
function toFilterContext(story) {
|
|
146
|
-
return {
|
|
147
|
-
id: story.id,
|
|
148
|
-
title: story.title,
|
|
149
|
-
name: story.name,
|
|
150
|
-
filePath: `${story.title}/${story.name}`
|
|
151
|
-
};
|
|
152
|
-
}
|
|
153
|
-
function createLatch() {
|
|
154
|
-
let resolve;
|
|
155
|
-
const p = new Promise((r) => {
|
|
156
|
-
resolve = r;
|
|
157
|
-
});
|
|
158
|
-
return { p, resolve };
|
|
159
|
-
}
|
|
160
|
-
var cappaPluginStorybook = (options) => {
|
|
161
|
-
return {
|
|
162
|
-
name: "StorybookPlugin",
|
|
163
|
-
description: "Takes screenshots of Storybook stories with configurable options",
|
|
164
|
-
discover: async (screenshotTool) => {
|
|
165
|
-
if (!options) {
|
|
166
|
-
throw new Error("Storybook plugin options are required");
|
|
167
|
-
}
|
|
168
|
-
if (!options.storybookUrl) {
|
|
169
|
-
throw new Error("storybookUrl is required");
|
|
170
|
-
}
|
|
171
|
-
const logger = getLogger();
|
|
172
|
-
const {
|
|
173
|
-
storybookUrl,
|
|
174
|
-
includeStories,
|
|
175
|
-
excludeStories,
|
|
176
|
-
storybook: defaultStorybookOptions
|
|
177
|
-
} = options;
|
|
178
|
-
const storiesUrl = `${storybookUrl}/index.json`;
|
|
179
|
-
logger.debug(`Fetching stories from: ${storiesUrl}`);
|
|
180
|
-
const timeout = screenshotTool.connectionTimeout;
|
|
181
|
-
let response;
|
|
182
|
-
try {
|
|
183
|
-
response = await fetch(storiesUrl, {
|
|
184
|
-
signal: AbortSignal.timeout(timeout)
|
|
185
|
-
});
|
|
186
|
-
} catch (error) {
|
|
187
|
-
if (error instanceof DOMException && error.name === "TimeoutError") {
|
|
188
|
-
throw new Error(
|
|
189
|
-
`Connection to Storybook at ${storybookUrl} timed out after ${timeout}ms. Make sure Storybook is running and accessible.`
|
|
190
|
-
);
|
|
191
|
-
}
|
|
192
|
-
throw new Error(
|
|
193
|
-
`Failed to connect to Storybook at ${storybookUrl}. Make sure Storybook is running and accessible. Error: ${error.message}`
|
|
194
|
-
);
|
|
195
|
-
}
|
|
196
|
-
if (!response.ok) {
|
|
197
|
-
throw new Error(
|
|
198
|
-
`Failed to fetch stories: ${response.status} ${response.statusText}`
|
|
199
|
-
);
|
|
200
|
-
}
|
|
201
|
-
const data = await response.json();
|
|
202
|
-
const stories = Object.values(data.entries);
|
|
203
|
-
let filteredStories = stories;
|
|
204
|
-
if (includeStories) {
|
|
205
|
-
filteredStories = filteredStories.filter(
|
|
206
|
-
(story) => includeStories(toFilterContext(story))
|
|
207
|
-
);
|
|
208
|
-
}
|
|
209
|
-
if (excludeStories) {
|
|
210
|
-
filteredStories = filteredStories.filter(
|
|
211
|
-
(story) => !excludeStories(toFilterContext(story))
|
|
212
|
-
);
|
|
213
|
-
}
|
|
214
|
-
filteredStories = filteredStories.filter(
|
|
215
|
-
(story) => story.type === "story"
|
|
216
|
-
);
|
|
217
|
-
logger.start(`Found ${filteredStories.length} stories to screenshot...`);
|
|
218
|
-
return filteredStories.map((story) => ({
|
|
219
|
-
id: story.id,
|
|
220
|
-
url: buildStorybookIframeUrl({
|
|
221
|
-
baseUrl: storybookUrl,
|
|
222
|
-
storyId: story.id,
|
|
223
|
-
viewMode: defaultStorybookOptions?.viewMode,
|
|
224
|
-
args: defaultStorybookOptions?.args,
|
|
225
|
-
globals: defaultStorybookOptions?.globals,
|
|
226
|
-
query: defaultStorybookOptions?.query,
|
|
227
|
-
fullscreen: defaultStorybookOptions?.fullscreen,
|
|
228
|
-
singleStory: defaultStorybookOptions?.singleStory
|
|
229
|
-
}),
|
|
230
|
-
data: {
|
|
231
|
-
story
|
|
232
|
-
}
|
|
233
|
-
}));
|
|
234
|
-
},
|
|
235
|
-
initPage: async (page, screenshotTool) => {
|
|
236
|
-
const logger = getLogger();
|
|
237
|
-
const { logConsoleEvents = true } = screenshotTool;
|
|
238
|
-
const latchMap = /* @__PURE__ */ new Map();
|
|
239
|
-
await page.exposeFunction(
|
|
240
|
-
"__cappa_parameters",
|
|
241
|
-
async (id, payload) => {
|
|
242
|
-
latchMap.get(id)?.resolve?.(payload);
|
|
243
|
-
}
|
|
244
|
-
);
|
|
245
|
-
if (logConsoleEvents) {
|
|
246
|
-
page.on("console", (message) => {
|
|
247
|
-
logger.debug("console", message.text());
|
|
248
|
-
});
|
|
249
|
-
}
|
|
250
|
-
page.on("pageerror", (error) => {
|
|
251
|
-
logger.debug("pageerror", error);
|
|
252
|
-
});
|
|
253
|
-
return { latchMap };
|
|
254
|
-
},
|
|
255
|
-
// Phase 2: Execute single story
|
|
256
|
-
execute: async (task, page, screenshotTool, context) => {
|
|
257
|
-
const { url, data } = task;
|
|
258
|
-
const { story } = data;
|
|
259
|
-
const logger = getLogger();
|
|
260
|
-
const { storybook: defaultStorybookOptions } = options || {};
|
|
261
|
-
try {
|
|
262
|
-
const currentLatch = createLatch();
|
|
263
|
-
context.latchMap.set(story.id, currentLatch);
|
|
264
|
-
const captureStart = performance.now();
|
|
265
|
-
await page.goto(url, { timeout: screenshotTool.connectionTimeout });
|
|
266
|
-
const storyParameters = await context.latchMap.get(story.id)?.p;
|
|
267
|
-
context.latchMap.delete(story.id);
|
|
268
|
-
const variantParameters = storyParameters?.variants ?? [];
|
|
269
|
-
if (storyParameters?.skip) {
|
|
270
|
-
logger.warn(`Skipping story ${story.title} - ${story.name}`);
|
|
271
|
-
return {
|
|
272
|
-
storyId: story.id,
|
|
273
|
-
storyName: `${story.title} - ${story.name}`,
|
|
274
|
-
skipped: true
|
|
275
|
-
};
|
|
276
|
-
}
|
|
277
|
-
if (storyParameters && Object.keys(storyParameters).length > 0) {
|
|
278
|
-
logger.debug("Taking screenshot with options", storyParameters);
|
|
279
|
-
}
|
|
280
|
-
const resolvedViewport = storyParameters?.viewport ?? screenshotTool.viewport;
|
|
281
|
-
await page.setViewportSize(resolvedViewport);
|
|
282
|
-
await freezeUI(page);
|
|
283
|
-
await waitForVisualIdle(page);
|
|
284
|
-
await waitForPlayFunctionCompletion(
|
|
285
|
-
page,
|
|
286
|
-
`${story.title} - ${story.name}`
|
|
287
|
-
);
|
|
288
|
-
const toLocatorMask = (mask) => mask?.map((selector) => page.locator(selector));
|
|
289
|
-
const filename = buildFilename(story);
|
|
290
|
-
const variantsWithUrls = [];
|
|
291
|
-
const variantExtrasEntries = [];
|
|
292
|
-
for (const variant of variantParameters) {
|
|
293
|
-
const variantFilename = variant.filename || screenshotTool.getVariantFilename(filename, {
|
|
294
|
-
id: variant.id,
|
|
295
|
-
label: variant.label,
|
|
296
|
-
filename: variant.filename
|
|
297
|
-
});
|
|
298
|
-
const mergedArgs = {
|
|
299
|
-
...defaultStorybookOptions?.args,
|
|
300
|
-
...variant.options?.args
|
|
301
|
-
};
|
|
302
|
-
variantsWithUrls.push({
|
|
303
|
-
id: variant.id,
|
|
304
|
-
label: variant.label,
|
|
305
|
-
filename: variantFilename,
|
|
306
|
-
url: buildStorybookIframeUrl({
|
|
307
|
-
baseUrl: options?.storybookUrl || "",
|
|
308
|
-
storyId: story.id,
|
|
309
|
-
viewMode: defaultStorybookOptions?.viewMode,
|
|
310
|
-
args: mergedArgs,
|
|
311
|
-
globals: defaultStorybookOptions?.globals,
|
|
312
|
-
query: defaultStorybookOptions?.query,
|
|
313
|
-
fullscreen: defaultStorybookOptions?.fullscreen,
|
|
314
|
-
singleStory: defaultStorybookOptions?.singleStory
|
|
315
|
-
}),
|
|
316
|
-
options: variant.options ? {
|
|
317
|
-
...variant.options,
|
|
318
|
-
mask: toLocatorMask(variant.options.mask)
|
|
319
|
-
} : void 0
|
|
320
|
-
});
|
|
321
|
-
variantExtrasEntries.push([
|
|
322
|
-
variant.id,
|
|
323
|
-
{
|
|
324
|
-
saveDiffImage: true,
|
|
325
|
-
diffImageFilename: variantFilename,
|
|
326
|
-
diff: variant.options?.diff
|
|
327
|
-
}
|
|
328
|
-
]);
|
|
329
|
-
}
|
|
330
|
-
const baseOptions = {
|
|
331
|
-
fullPage: storyParameters?.fullPage,
|
|
332
|
-
delay: storyParameters?.delay,
|
|
333
|
-
omitBackground: storyParameters?.omitBackground,
|
|
334
|
-
skip: storyParameters?.skip,
|
|
335
|
-
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
336
|
-
mask: toLocatorMask(storyParameters?.mask)
|
|
337
|
-
};
|
|
338
|
-
const variantFilenameMap = /* @__PURE__ */ new Map();
|
|
339
|
-
for (const variant of variantsWithUrls) {
|
|
340
|
-
const variantFilename = variant.filename;
|
|
341
|
-
if (!variantFilename) continue;
|
|
342
|
-
variantFilenameMap.set(variant.id, variantFilename);
|
|
343
|
-
}
|
|
344
|
-
const captureExtras = {
|
|
345
|
-
saveDiffImage: true,
|
|
346
|
-
diffImageFilename: filename,
|
|
347
|
-
diff: storyParameters?.diff,
|
|
348
|
-
variants: variantExtrasEntries.length ? Object.fromEntries(variantExtrasEntries) : void 0,
|
|
349
|
-
skipBaseNavigation: true,
|
|
350
|
-
waitForStability: waitForVisualIdle,
|
|
351
|
-
captureStart
|
|
352
|
-
};
|
|
353
|
-
const captureResult = await screenshotTool.captureWithVariants(
|
|
354
|
-
page,
|
|
355
|
-
filename,
|
|
356
|
-
url,
|
|
357
|
-
baseOptions,
|
|
358
|
-
variantsWithUrls,
|
|
359
|
-
captureExtras
|
|
360
|
-
);
|
|
361
|
-
return {
|
|
362
|
-
storyId: story.id,
|
|
363
|
-
storyName: `${story.title} - ${story.name}`,
|
|
364
|
-
filepath: captureResult.base.filepath,
|
|
365
|
-
success: captureResult.base.skipped ? void 0 : captureResult.base.comparisonResult ? captureResult.base.comparisonResult.passed : Boolean(captureResult.base.filepath),
|
|
366
|
-
skipped: captureResult.base.skipped
|
|
367
|
-
};
|
|
368
|
-
} catch (error) {
|
|
369
|
-
logger.error(
|
|
370
|
-
`Error taking screenshot of story ${story.title} - ${story.name}:`,
|
|
371
|
-
error.message
|
|
372
|
-
);
|
|
373
|
-
return {
|
|
374
|
-
storyId: story.id,
|
|
375
|
-
storyName: `${story.title} - ${story.name}`,
|
|
376
|
-
error: error?.message ?? "Unknown error"
|
|
377
|
-
};
|
|
378
|
-
}
|
|
379
|
-
}
|
|
380
|
-
};
|
|
381
|
-
};
|
|
382
|
-
|
|
383
|
-
// src/index.esm.ts
|
|
384
|
-
var previewAnnotations = [
|
|
385
|
-
fileURLToPath(new URL("./preview.js", import.meta.url))
|
|
386
|
-
];
|
|
387
|
-
export {
|
|
388
|
-
cappaPluginStorybook,
|
|
389
|
-
previewAnnotations
|
|
390
|
-
};
|
package/dist/preview.js
DELETED
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
// src/storybook/addon/decorator.ts
|
|
2
|
-
import { makeDecorator } from "storybook/preview-api";
|
|
3
|
-
|
|
4
|
-
// src/storybook/util.ts
|
|
5
|
-
var waitForExposed = (name, timeoutMs = 5e3) => {
|
|
6
|
-
return new Promise((resolve, reject) => {
|
|
7
|
-
const start = performance.now();
|
|
8
|
-
const t = setInterval(() => {
|
|
9
|
-
const fn = window[name];
|
|
10
|
-
if (typeof fn === "function") {
|
|
11
|
-
clearInterval(t);
|
|
12
|
-
resolve(fn);
|
|
13
|
-
} else if (performance.now() - start > timeoutMs) {
|
|
14
|
-
clearInterval(t);
|
|
15
|
-
reject(new Error(`Timed out waiting for ${name}`));
|
|
16
|
-
}
|
|
17
|
-
}, 16);
|
|
18
|
-
});
|
|
19
|
-
};
|
|
20
|
-
|
|
21
|
-
// src/storybook/addon/browser.ts
|
|
22
|
-
var isCappa = () => {
|
|
23
|
-
return navigator.userAgent.includes("CappaStorybook");
|
|
24
|
-
};
|
|
25
|
-
|
|
26
|
-
// src/storybook/addon/decorator.ts
|
|
27
|
-
var withCappaDecorator = makeDecorator({
|
|
28
|
-
name: "withCappa",
|
|
29
|
-
parameterName: "cappa",
|
|
30
|
-
skipIfNoParametersOrOptions: false,
|
|
31
|
-
wrapper: (getStory, context, { parameters: parameters2 }) => {
|
|
32
|
-
if (isCappa()) {
|
|
33
|
-
window.__cappa_screenshot = true;
|
|
34
|
-
if (context.playFunction != null) {
|
|
35
|
-
window.__cappa_has_play_function = true;
|
|
36
|
-
}
|
|
37
|
-
queueMicrotask(async () => {
|
|
38
|
-
try {
|
|
39
|
-
const cappaParameters = await waitForExposed("__cappa_parameters");
|
|
40
|
-
cappaParameters(context.id, parameters2 ?? {});
|
|
41
|
-
} catch (error) {
|
|
42
|
-
console.error("Cappa decorator error:", error);
|
|
43
|
-
}
|
|
44
|
-
});
|
|
45
|
-
}
|
|
46
|
-
return getStory(context);
|
|
47
|
-
}
|
|
48
|
-
});
|
|
49
|
-
|
|
50
|
-
// src/storybook/addon/preview.ts
|
|
51
|
-
var decorators = [withCappaDecorator];
|
|
52
|
-
var parameters = {};
|
|
53
|
-
var afterEach = () => {
|
|
54
|
-
window.playAfterEach = true;
|
|
55
|
-
};
|
|
56
|
-
export {
|
|
57
|
-
afterEach,
|
|
58
|
-
decorators,
|
|
59
|
-
parameters
|
|
60
|
-
};
|