@cappa/plugin-storybook 0.0.11 → 0.0.12

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.js CHANGED
@@ -1,203 +1,211 @@
1
- //#region rolldown:runtime
1
+ "use strict";
2
2
  var __create = Object.create;
3
3
  var __defProp = Object.defineProperty;
4
4
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
5
  var __getOwnPropNames = Object.getOwnPropertyNames;
6
6
  var __getProtoOf = Object.getPrototypeOf;
7
7
  var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __export = (target, all) => {
9
+ for (var name in all)
10
+ __defProp(target, name, { get: all[name], enumerable: true });
11
+ };
8
12
  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;
13
+ if (from && typeof from === "object" || typeof from === "function") {
14
+ for (let key of __getOwnPropNames(from))
15
+ if (!__hasOwnProp.call(to, key) && key !== except)
16
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
17
+ }
18
+ return to;
17
19
  };
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));
20
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
21
+ // If the importer is in node compatibility mode or this is not an ESM
22
+ // file that has been converted to a CommonJS file using a Babel-
23
+ // compatible transform (i.e. "__esModule" has not been set), then set
24
+ // "default" to the CommonJS "module.exports" for node compatibility.
25
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
26
+ mod
27
+ ));
28
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
29
+
30
+ // src/index.ts
31
+ var index_exports = {};
32
+ __export(index_exports, {
33
+ cappaPluginStorybook: () => cappaPluginStorybook,
34
+ previewAnnotations: () => previewAnnotations
35
+ });
36
+ module.exports = __toCommonJS(index_exports);
22
37
 
23
- //#endregion
24
- require("@cappa/core");
25
- let storybook_preview_api = require("storybook/preview-api");
26
- storybook_preview_api = __toESM(storybook_preview_api);
38
+ // src/cappa/plugin.ts
39
+ var import_core = require("@cappa/core");
27
40
 
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: `
41
+ // src/cappa/util.ts
42
+ var freezeUI = async (page) => {
43
+ await page.addStyleTag({
44
+ content: `
35
45
  * { transition: none !important; animation: none !important }
36
46
  * { caret-color: transparent !important }
37
47
  ::-webkit-scrollbar { display: none }
38
- ` });
48
+ `
49
+ });
39
50
  };
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
- });
51
+ var waitForVisualIdle = async (page) => {
52
+ await page.waitForLoadState("networkidle");
53
+ await page.evaluate(async () => {
54
+ if (document.fonts?.ready) await document.fonts.ready;
55
+ await new Promise(
56
+ (r) => requestAnimationFrame(() => requestAnimationFrame(r))
57
+ );
58
+ });
50
59
  };
51
60
 
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
- */
61
+ // src/cappa/plugin.ts
59
62
  function createLatch() {
60
- let resolve;
61
- return {
62
- p: new Promise((r) => resolve = r),
63
- resolve
64
- };
63
+ let resolve;
64
+ const p = new Promise((r) => resolve = r);
65
+ return { p, resolve };
65
66
  }
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
- await screenshotTool.init();
95
- let currentLatch = createLatch();
96
- await screenshotTool.page?.exposeFunction("__cappa_parameters", async (payload) => {
97
- currentLatch.resolve(payload);
98
- });
99
- for (const story of filteredStories) try {
100
- const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;
101
- const screenshotOptions = {
102
- viewport: defaultViewport,
103
- waitForSelector,
104
- waitForTimeout,
105
- fullPage: true,
106
- quality: 90,
107
- type: "jpeg"
108
- };
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");
112
- page.on("console", (message) => {
113
- console.log("console", message.text());
114
- });
115
- page.on("pageerror", (error) => {
116
- console.log("pageerror", error);
117
- });
118
- await page.goto(storyUrl);
119
- const options$1 = await currentLatch.p;
120
- currentLatch = createLatch();
121
- if (options$1.skip) console.log(`Skipping story ${story.title} - ${story.name}`);
122
- await freezeUI(page);
123
- await waitForVisualIdle(page);
124
- if (options$1.delay) await page.waitForTimeout(options$1.delay);
125
- const actualFilepath = await screenshotTool.takeScreenshot(page, filename, {
126
- fullPage: options$1.fullPage ?? screenshotOptions.fullPage,
127
- type: options$1.type ?? screenshotOptions.type,
128
- waitForSelector: options$1.waitForSelector ?? screenshotOptions.waitForSelector,
129
- waitForTimeout: options$1.waitForTimeout ?? screenshotOptions.waitForTimeout
130
- });
131
- results.push({
132
- storyId: story.id,
133
- storyName: story.name,
134
- storyTitle: story.title,
135
- success: true,
136
- filepath: actualFilepath
137
- });
138
- } catch (error) {
139
- console.error(`Error taking screenshot of story ${story.title} - ${story.name}:`, error.message);
140
- results.push({
141
- storyId: story.id,
142
- storyName: story.name,
143
- storyTitle: story.title,
144
- success: false,
145
- error: error.message
146
- });
147
- }
148
- console.log(`Completed screenshots: ${results.filter((r) => r.success).length}/${results.length} successful`);
149
- return results;
150
- } catch (error) {
151
- console.error("Error in Storybook plugin:", error.message);
152
- throw error;
153
- }
154
- }
155
- };
67
+ var cappaPluginStorybook = (options) => {
68
+ return {
69
+ name: "StorybookPlugin",
70
+ description: "Takes screenshots of Storybook stories with configurable options",
71
+ version: "1.0.0",
72
+ execute: async (screenshotTool) => {
73
+ if (!options) {
74
+ throw new Error("Storybook plugin options are required");
75
+ }
76
+ if (!options.storybookUrl) {
77
+ throw new Error("storybookUrl is required");
78
+ }
79
+ const {
80
+ storybookUrl,
81
+ includeStories = [],
82
+ excludeStories = [],
83
+ defaultViewport = { width: 1920, height: 1080 },
84
+ waitForSelector,
85
+ waitForTimeout
86
+ } = options;
87
+ const storiesUrl = `${storybookUrl}/index.json`;
88
+ console.log(`Fetching stories from: ${storiesUrl}`);
89
+ try {
90
+ const response = await fetch(storiesUrl);
91
+ if (!response.ok) {
92
+ throw new Error(
93
+ `Failed to fetch stories: ${response.status} ${response.statusText}`
94
+ );
95
+ }
96
+ const data = await response.json();
97
+ const stories = Object.values(data.entries);
98
+ let filteredStories = stories;
99
+ if (includeStories.length > 0) {
100
+ filteredStories = filteredStories.filter(
101
+ (story) => includeStories.some(
102
+ (pattern) => story.title.includes(pattern) || story.name.includes(pattern)
103
+ )
104
+ );
105
+ }
106
+ if (excludeStories.length > 0) {
107
+ filteredStories = filteredStories.filter(
108
+ (story) => !excludeStories.some(
109
+ (pattern) => story.title.includes(pattern) || story.name.includes(pattern)
110
+ )
111
+ );
112
+ }
113
+ filteredStories = filteredStories.filter(
114
+ (story) => story.type === "story"
115
+ );
116
+ console.log(`Found ${filteredStories.length} stories to screenshot`);
117
+ const results = [];
118
+ await screenshotTool.init();
119
+ let currentLatch = createLatch();
120
+ await screenshotTool.page?.exposeFunction(
121
+ "__cappa_parameters",
122
+ async (payload) => {
123
+ currentLatch.resolve(payload);
124
+ }
125
+ );
126
+ for (const story of filteredStories) {
127
+ try {
128
+ const storyUrl = `${storybookUrl}/iframe.html?id=${story.id}&viewMode=story`;
129
+ const screenshotOptions = {
130
+ viewport: defaultViewport,
131
+ waitForSelector,
132
+ waitForTimeout,
133
+ fullPage: true,
134
+ quality: 90,
135
+ type: "jpeg"
136
+ };
137
+ const filename = `${story.title.replace(
138
+ /[^a-zA-Z0-9]/g,
139
+ "_"
140
+ )}_${story.name.replace(/[^a-zA-Z0-9]/g, "_")}.${screenshotOptions.type}`;
141
+ const page = screenshotTool.page;
142
+ if (!page) {
143
+ throw new Error("Page not initialized");
144
+ }
145
+ page.on("console", (message) => {
146
+ console.log("console", message.text());
147
+ });
148
+ page.on("pageerror", (error) => {
149
+ console.log("pageerror", error);
150
+ });
151
+ await page.goto(storyUrl);
152
+ const options2 = await currentLatch.p;
153
+ currentLatch = createLatch();
154
+ if (options2.skip) {
155
+ console.log(`Skipping story ${story.title} - ${story.name}`);
156
+ }
157
+ await freezeUI(page);
158
+ await waitForVisualIdle(page);
159
+ if (options2.delay) {
160
+ await page.waitForTimeout(options2.delay);
161
+ }
162
+ const actualFilepath = await screenshotTool.takeScreenshot(
163
+ page,
164
+ filename,
165
+ {
166
+ fullPage: options2.fullPage ?? screenshotOptions.fullPage,
167
+ type: options2.type ?? screenshotOptions.type,
168
+ waitForSelector: options2.waitForSelector ?? screenshotOptions.waitForSelector,
169
+ waitForTimeout: options2.waitForTimeout ?? screenshotOptions.waitForTimeout
170
+ }
171
+ );
172
+ results.push({
173
+ storyId: story.id,
174
+ storyName: story.name,
175
+ storyTitle: story.title,
176
+ success: true,
177
+ filepath: actualFilepath
178
+ });
179
+ } catch (error) {
180
+ console.error(
181
+ `Error taking screenshot of story ${story.title} - ${story.name}:`,
182
+ error.message
183
+ );
184
+ results.push({
185
+ storyId: story.id,
186
+ storyName: story.name,
187
+ storyTitle: story.title,
188
+ success: false,
189
+ error: error.message
190
+ });
191
+ }
192
+ }
193
+ console.log(
194
+ `Completed screenshots: ${results.filter((r) => r.success).length}/${results.length} successful`
195
+ );
196
+ return results;
197
+ } catch (error) {
198
+ console.error("Error in Storybook plugin:", error.message);
199
+ throw error;
200
+ }
201
+ }
202
+ };
156
203
  };
157
204
 
158
- //#endregion
159
- //#region src/storybook/util.ts
160
- /**
161
- * Wait for a function to be exposed on the window object
162
- * @param name - The name of the function to wait for
163
- * @param timeoutMs - The timeout in milliseconds
164
- * @returns The function or rejects if the function is not exposed within the timeout
165
- */
166
- const waitForExposed = (name, timeoutMs = 5e3) => {
167
- return new Promise((resolve, reject) => {
168
- const start = performance.now();
169
- const t = setInterval(() => {
170
- const fn = window[name];
171
- if (typeof fn === "function") {
172
- clearInterval(t);
173
- resolve(fn);
174
- } else if (performance.now() - start > timeoutMs) {
175
- clearInterval(t);
176
- reject(/* @__PURE__ */ new Error(`Timed out waiting for ${name}`));
177
- }
178
- }, 16);
179
- });
180
- };
181
-
182
- //#endregion
183
- //#region src/storybook/decorator.ts
184
- const withCappaDecorator = (0, storybook_preview_api.makeDecorator)({
185
- name: "withCappa",
186
- parameterName: "cappa",
187
- skipIfNoParametersOrOptions: false,
188
- wrapper: (getStory, context, { parameters }) => {
189
- queueMicrotask(async () => {
190
- try {
191
- (await waitForExposed("__cappa_parameters"))(parameters ?? {});
192
- } catch (error) {
193
- console.error(error);
194
- }
195
- });
196
- return getStory(context);
197
- }
205
+ // src/index.ts
206
+ var previewAnnotations = [require.resolve("./preview.mjs")];
207
+ // Annotate the CommonJS export names for ESM import in node:
208
+ 0 && (module.exports = {
209
+ cappaPluginStorybook,
210
+ previewAnnotations
198
211
  });
199
-
200
- //#endregion
201
- exports.cappaPluginStorybook = cappaPluginStorybook;
202
- exports.withCappaDecorator = withCappaDecorator;
203
- //# sourceMappingURL=index.js.map