@storyshelf/runner-playwright 0.1.0 → 0.1.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.
Files changed (7) hide show
  1. package/LICENSE +21 -0
  2. package/dist/capture-runner.d.mts +2 -1
  3. package/dist/capture-runner.mjs +50 -4
  4. package/dist/capture-runner.mjs.map +1 -1
  5. package/dist/static-server.mjs +6 -0
  6. package/dist/static-server.mjs.map +1 -1
  7. package/package.json +31 -23
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Siddhant Gupta
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/dist/capture-runner.d.mts CHANGED
@@ -1,8 +1,9 @@
1
1
  import __tsdown_shims_path from 'node:path';
2
2
  import __tsdown_shims_url from 'node:url';
3
3
  import { CaptureRunner } from "@storyshelf/core";
4
- import "pino";
4
+ import "@storyshelf/core/types";
5
5
  //#region src/capture-runner.d.ts
6
+ /** Create a CaptureRunner that renders Storybook stories with Playwright. */
6
7
  declare function createPlaywrightCaptureRunner(): CaptureRunner;
7
8
  //#endregion
8
9
  export { createPlaywrightCaptureRunner };
package/dist/capture-runner.mjs CHANGED
@@ -6,11 +6,12 @@ import { chromium } from "playwright";
6
6
  import { StorybookAdapter } from "@storyshelf/core";
7
7
  //#region src/capture-runner.ts
8
8
  const activeRuns = /* @__PURE__ */ new Map();
9
+ /** Create a CaptureRunner that renders Storybook stories with Playwright. */
9
10
  function createPlaywrightCaptureRunner() {
10
11
  return {
11
12
  metadata: {
12
13
  name: "Playwright",
13
- version: "0.1.0",
14
+ version: globalThis.__PKG_VERSION__ ?? "0.0.0",
14
15
  description: "Playwright capture runner",
15
16
  kind: "playwright"
16
17
  },
@@ -47,7 +48,9 @@ async function renderAll(input, active) {
47
48
  const ctx = {
48
49
  browser,
49
50
  adapter: new StorybookAdapter(),
50
- baseUrl: server.url
51
+ baseUrl: server.url,
52
+ executePlay: input.executePlay,
53
+ playTimeoutMs: input.playTimeoutMs
51
54
  };
52
55
  const captures = [];
53
56
  const failures = [];
@@ -104,8 +107,51 @@ async function captureScreenshot(ctx, story, viewport) {
104
107
  } });
105
108
  try {
106
109
  await page.goto(ctx.adapter.buildUrl(ctx.baseUrl, story.id), { waitUntil: "networkidle" });
107
- if (ctx.adapter.screenshotSelector) await page.waitForSelector(ctx.adapter.screenshotSelector);
108
- return await page.screenshot();
110
+ if (ctx.adapter.screenshotSelector) {
111
+ await page.waitForSelector(ctx.adapter.screenshotSelector, { state: "attached" });
112
+ const delay = story.parameters?.delay ?? 500;
113
+ await page.waitForTimeout(delay);
114
+ if (story.parameters?.pauseAnimationAtEnd) await page.evaluate(() => {
115
+ const doc = globalThis.document;
116
+ for (const anim of doc.getAnimations()) anim.pause();
117
+ });
118
+ }
119
+ if (ctx.executePlay) {
120
+ const timeout = ctx.playTimeoutMs ?? 1e4;
121
+ try {
122
+ await page.evaluate(async ({ storyId, timeoutMs }) => {
123
+ const preview = globalThis["__STORYBOOK_PREVIEW__"];
124
+ if (!preview) return;
125
+ let playError = null;
126
+ const handler = (err) => {
127
+ playError = err;
128
+ };
129
+ try {
130
+ preview.channel?.on("playFunctionThrewException", handler);
131
+ } catch {}
132
+ if (preview.executePlay) await Promise.race([preview.executePlay(storyId), new Promise((_, reject) => {
133
+ setTimeout(() => {
134
+ reject(/* @__PURE__ */ new Error(`play timeout after ${timeoutMs}ms`));
135
+ }, timeoutMs);
136
+ })]);
137
+ else if (preview.storyStore?.fromId) {
138
+ const loaded = preview.storyStore.fromId(storyId);
139
+ if (loaded?.play) await Promise.race([loaded.play({ canvasElement: globalThis.document.querySelector("#storybook-root") }), new Promise((_, reject) => {
140
+ setTimeout(() => {
141
+ reject(/* @__PURE__ */ new Error(`play timeout after ${timeoutMs}ms`));
142
+ }, timeoutMs);
143
+ })]);
144
+ }
145
+ if (playError) throw playError;
146
+ }, {
147
+ storyId: story.id,
148
+ timeoutMs: timeout
149
+ });
150
+ } catch (error) {
151
+ throw new Error(`play failed: ${messageOf(error)}`, { cause: error });
152
+ }
153
+ }
154
+ return await page.screenshot({ animations: story.parameters?.pauseAnimationAtEnd ? "allow" : "disabled" });
109
155
  } finally {
110
156
  await page.close();
111
157
  }
package/dist/capture-runner.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"capture-runner.mjs","names":[],"sources":["../src/capture-runner.ts"],"sourcesContent":["import { chromium, type Browser } from \"playwright\";\nimport type { Logger } from \"pino\";\n\nimport {\n StorybookAdapter,\n type CaptureRunner,\n type RenderResult,\n type RenderedSnapshot,\n type StoryEntry,\n type StorySourceAdapter,\n type Viewport,\n} from \"@storyshelf/core\";\n\ndeclare const __PKG_VERSION__: string;\n\nimport { createStaticServer } from \"./static-server.ts\";\n\ninterface ScreenshotContext {\n browser: Browser;\n adapter: StorySourceAdapter;\n baseUrl: string;\n}\n\n/** A render that may currently be in flight, so that `cancel` can abort it. */\ninterface ActiveRun {\n cancelled: boolean;\n browser: Browser | null;\n}\n\nconst activeRuns = new Map<string, ActiveRun>();\n\nexport interface PlaywrightRenderInput {\n buildId: string;\n storybookDir: string;\n stories: StoryEntry[];\n viewports: Viewport[];\n logger?: Logger;\n}\n\nexport function createPlaywrightCaptureRunner(): CaptureRunner {\n return {\n metadata: {\n name: \"Playwright\",\n version: typeof __PKG_VERSION__ === \"undefined\" ? \"0.0.0\" : __PKG_VERSION__, // oxlint-disable-line unicorn/no-typeof-undefined\n description: \"Playwright capture runner\",\n kind: \"playwright\",\n },\n async render(input: PlaywrightRenderInput) {\n const active: ActiveRun = { cancelled: false, browser: null };\n activeRuns.set(input.buildId, active);\n try {\n return await renderAll(input, active);\n } finally {\n activeRuns.delete(input.buildId);\n }\n },\n async cancel(buildId) {\n const active = activeRuns.get(buildId);\n if (!active) {\n return;\n }\n active.cancelled = true;\n await closeBrowser(active.browser);\n },\n };\n}\n\nasync function closeBrowser(browser: Browser | null): Promise<void> {\n if (!browser) {\n return;\n }\n try {\n await browser.close();\n } catch {\n // The run's own `finally` performs final cleanup; cancel must never throw.\n }\n}\n\nasync function renderAll(input: PlaywrightRenderInput, active: ActiveRun): Promise<RenderResult> {\n const server = await createStaticServer(input.storybookDir);\n const browser = await chromium.launch();\n active.browser = browser;\n const adapter = new StorybookAdapter();\n const ctx: ScreenshotContext = { browser, adapter, baseUrl: server.url };\n const captures: RenderedSnapshot[] = [];\n const failures: RenderResult[\"failures\"] = [];\n try {\n const tasks = input.viewports.flatMap((viewport) =>\n input.stories.map(async (story) => {\n if (active.cancelled) {\n throw new Error(\"Capture cancelled\");\n }\n try {\n const screenshot = await captureScreenshot(ctx, story, viewport);\n captures.push({ story, viewportName: viewport.name, screenshot });\n } catch (error) {\n failures.push({ storyId: story.id, viewportName: viewport.name, error: messageOf(error) });\n input.logger?.error({ storyId: story.id, viewport: viewport.name, err: error }, \"render failed for story\");\n }\n }),\n );\n await Promise.all(tasks);\n return { captures, failures };\n } finally {\n active.browser = null;\n await Promise.all([safeCloseBrowser(browser), safeCloseServer(server)]);\n }\n}\n\nfunction messageOf(error: unknown): string {\n return error instanceof Error ? error.message : String(error);\n}\n\nasync function safeCloseBrowser(browser: Browser): Promise<void> {\n try {\n await browser.close();\n } catch {\n // Already closed by `cancel`; the run must complete without throwing.\n }\n}\n\nasync function safeCloseServer(server: { close(): Promise<void> }): Promise<void> {\n try {\n await server.close();\n } catch {\n // Best-effort; teardown must never mask a render result.\n }\n}\n\nasync function captureScreenshot(ctx: ScreenshotContext, story: StoryEntry, viewport: Viewport): Promise<Buffer> {\n const page = await ctx.browser.newPage({ viewport: { width: viewport.width, height: viewport.height } });\n try {\n await page.goto(ctx.adapter.buildUrl(ctx.baseUrl, story.id), { waitUntil: \"networkidle\" });\n if (ctx.adapter.screenshotSelector) {\n await page.waitForSelector(ctx.adapter.screenshotSelector);\n }\n return await page.screenshot();\n } finally {\n await page.close();\n }\n}\n"],"mappings":";;;;;;;AA6BA,MAAM,6BAAa,IAAI,IAAuB;AAU9C,SAAgB,gCAA+C;CAC7D,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAA;GACA,aAAa;GACb,MAAM;EACR;EACA,MAAM,OAAO,OAA8B;GACzC,MAAM,SAAoB;IAAE,WAAW;IAAO,SAAS;GAAK;GAC5D,WAAW,IAAI,MAAM,SAAS,MAAM;GACpC,IAAI;IACF,OAAO,MAAM,UAAU,OAAO,MAAM;GACtC,UAAU;IACR,WAAW,OAAO,MAAM,OAAO;GACjC;EACF;EACA,MAAM,OAAO,SAAS;GACpB,MAAM,SAAS,WAAW,IAAI,OAAO;GACrC,IAAI,CAAC,QACH;GAEF,OAAO,YAAY;GACnB,MAAM,aAAa,OAAO,OAAO;EACnC;CACF;AACF;AAEA,eAAe,aAAa,SAAwC;CAClE,IAAI,CAAC,SACH;CAEF,IAAI;EACF,MAAM,QAAQ,MAAM;CACtB,QAAQ,CAER;AACF;AAEA,eAAe,UAAU,OAA8B,QAA0C;CAC/F,MAAM,SAAS,MAAM,mBAAmB,MAAM,YAAY;CAC1D,MAAM,UAAU,MAAM,SAAS,OAAO;CACtC,OAAO,UAAU;CAEjB,MAAM,MAAyB;EAAE;EAAS,SAAA,IADtB,iBAC4B;EAAG,SAAS,OAAO;CAAI;CACvE,MAAM,WAA+B,CAAC;CACtC,MAAM,WAAqC,CAAC;CAC5C,IAAI;EACF,MAAM,QAAQ,MAAM,UAAU,SAAS,aACrC,MAAM,QAAQ,IAAI,OAAO,UAAU;GACjC,IAAI,OAAO,WACT,MAAM,IAAI,MAAM,mBAAmB;GAErC,IAAI;IACF,MAAM,aAAa,MAAM,kBAAkB,KAAK,OAAO,QAAQ;IAC/D,SAAS,KAAK;KAAE;KAAO,cAAc,SAAS;KAAM;IAAW,CAAC;GAClE,SAAS,OAAO;IACd,SAAS,KAAK;KAAE,SAAS,MAAM;KAAI,cAAc,SAAS;KAAM,OAAO,UAAU,KAAK;IAAE,CAAC;IACzF,MAAM,QAAQ,MAAM;KAAE,SAAS,MAAM;KAAI,UAAU,SAAS;KAAM,KAAK;IAAM,GAAG,yBAAyB;GAC3G;EACF,CAAC,CACH;EACA,MAAM,QAAQ,IAAI,KAAK;EACvB,OAAO;GAAE;GAAU;EAAS;CAC9B,UAAU;EACR,OAAO,UAAU;EACjB,MAAM,QAAQ,IAAI,CAAC,iBAAiB,OAAO,GAAG,gBAAgB,MAAM,CAAC,CAAC;CACxE;AACF;AAEA,SAAS,UAAU,OAAwB;CACzC,OAAO,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAC9D;AAEA,eAAe,iBAAiB,SAAiC;CAC/D,IAAI;EACF,MAAM,QAAQ,MAAM;CACtB,QAAQ,CAER;AACF;AAEA,eAAe,gBAAgB,QAAmD;CAChF,IAAI;EACF,MAAM,OAAO,MAAM;CACrB,QAAQ,CAER;AACF;AAEA,eAAe,kBAAkB,KAAwB,OAAmB,UAAqC;CAC/G,MAAM,OAAO,MAAM,IAAI,QAAQ,QAAQ,EAAE,UAAU;EAAE,OAAO,SAAS;EAAO,QAAQ,SAAS;CAAO,EAAE,CAAC;CACvG,IAAI;EACF,MAAM,KAAK,KAAK,IAAI,QAAQ,SAAS,IAAI,SAAS,MAAM,EAAE,GAAG,EAAE,WAAW,cAAc,CAAC;EACzF,IAAI,IAAI,QAAQ,oBACd,MAAM,KAAK,gBAAgB,IAAI,QAAQ,kBAAkB;EAE3D,OAAO,MAAM,KAAK,WAAW;CAC/B,UAAU;EACR,MAAM,KAAK,MAAM;CACnB;AACF"}
1
+ {"version":3,"file":"capture-runner.mjs","names":["win"],"sources":["../src/capture-runner.ts"],"sourcesContent":["import { chromium, type Browser } from \"playwright\";\n\nimport {\n StorybookAdapter,\n type CaptureRunner,\n type RenderResult,\n type RenderedSnapshot,\n type StoryEntry,\n type StorySourceAdapter,\n type Viewport,\n} from \"@storyshelf/core\";\nimport type { Logger } from \"@storyshelf/core/types\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\nimport { createStaticServer } from \"./static-server.ts\";\n\ninterface ScreenshotContext {\n browser: Browser;\n adapter: StorySourceAdapter;\n baseUrl: string;\n}\n\n/** A render that may currently be in flight, so that `cancel` can abort it. */\ninterface ActiveRun {\n cancelled: boolean;\n browser: Browser | null;\n}\n\nconst activeRuns = new Map<string, ActiveRun>();\n\n/** Input for a Playwright capture run over a built Storybook directory. */\nexport interface PlaywrightRenderInput {\n buildId: string;\n storybookDir: string;\n stories: StoryEntry[];\n viewports: Viewport[];\n logger?: Logger;\n executePlay?: boolean;\n playTimeoutMs?: number;\n}\n\n/** Create a CaptureRunner that renders Storybook stories with Playwright. */\nexport function createPlaywrightCaptureRunner(): CaptureRunner {\n return {\n metadata: {\n name: \"Playwright\",\n version: (globalThis as unknown as { __PKG_VERSION__?: string }).__PKG_VERSION__ ?? \"0.0.0\",\n description: \"Playwright capture runner\",\n kind: \"playwright\",\n },\n async render(input: PlaywrightRenderInput) {\n const active: ActiveRun = { cancelled: false, browser: null };\n activeRuns.set(input.buildId, active);\n try {\n return await renderAll(input, active);\n } finally {\n activeRuns.delete(input.buildId);\n }\n },\n async cancel(buildId) {\n const active = activeRuns.get(buildId);\n if (!active) {\n return;\n }\n active.cancelled = true;\n await closeBrowser(active.browser);\n },\n };\n}\n\nasync function closeBrowser(browser: Browser | null): Promise<void> {\n if (!browser) {\n return;\n }\n try {\n await browser.close();\n } catch {\n // The run's own `finally` performs final cleanup; cancel must never throw.\n }\n}\n\nasync function renderAll(input: PlaywrightRenderInput, active: ActiveRun): Promise<RenderResult> {\n const server = await createStaticServer(input.storybookDir);\n const browser = await chromium.launch();\n active.browser = browser;\n const adapter = new StorybookAdapter();\n const ctx: ScreenshotContext & { executePlay?: boolean; playTimeoutMs?: number } = {\n browser,\n adapter,\n baseUrl: server.url,\n executePlay: input.executePlay,\n playTimeoutMs: input.playTimeoutMs,\n };\n const captures: RenderedSnapshot[] = [];\n const failures: RenderResult[\"failures\"] = [];\n try {\n const tasks = input.viewports.flatMap((viewport) =>\n input.stories.map(async (story) => {\n if (active.cancelled) {\n throw new Error(\"Capture cancelled\");\n }\n try {\n const screenshot = await captureScreenshot(ctx, story, viewport);\n captures.push({ story, viewportName: viewport.name, screenshot });\n } catch (error) {\n failures.push({ storyId: story.id, viewportName: viewport.name, error: messageOf(error) });\n input.logger?.error({ storyId: story.id, viewport: viewport.name, err: error }, \"render failed for story\");\n }\n }),\n );\n await Promise.all(tasks);\n return { captures, failures };\n } finally {\n active.browser = null;\n await Promise.all([safeCloseBrowser(browser), safeCloseServer(server)]);\n }\n}\n\nfunction messageOf(error: unknown): string {\n return error instanceof Error ? error.message : String(error);\n}\n\nasync function safeCloseBrowser(browser: Browser): Promise<void> {\n try {\n await browser.close();\n } catch {\n // Already closed by `cancel`; the run must complete without throwing.\n }\n}\n\nasync function safeCloseServer(server: { close(): Promise<void> }): Promise<void> {\n try {\n await server.close();\n } catch {\n // Best-effort; teardown must never mask a render result.\n }\n}\n\nasync function captureScreenshot(\n ctx: ScreenshotContext & { executePlay?: boolean; playTimeoutMs?: number },\n story: StoryEntry,\n viewport: Viewport,\n): Promise<Buffer> {\n const page = await ctx.browser.newPage({ viewport: { width: viewport.width, height: viewport.height } });\n try {\n await page.goto(ctx.adapter.buildUrl(ctx.baseUrl, story.id), { waitUntil: \"networkidle\" });\n if (ctx.adapter.screenshotSelector) {\n await page.waitForSelector(ctx.adapter.screenshotSelector, { state: \"attached\" });\n const delay = story.parameters?.delay ?? 500;\n await page.waitForTimeout(delay);\n if (story.parameters?.pauseAnimationAtEnd) {\n await page.evaluate(() => {\n const doc = globalThis.document as unknown as { getAnimations: () => { pause: () => void }[] };\n for (const anim of doc.getAnimations()) anim.pause();\n });\n }\n }\n if (ctx.executePlay) {\n const timeout = ctx.playTimeoutMs ?? 10_000;\n try {\n await page.evaluate(\n async ({ storyId, timeoutMs }: { storyId: string; timeoutMs: number }) => {\n const win = globalThis as unknown as {\n __STORYBOOK_PREVIEW__?: {\n executePlay?: (id: string) => Promise<void>;\n storyStore?: { fromId?: (id: string) => { play?: () => Promise<void> } };\n channel?: { on: (e: string, cb: (err: unknown) => void) => void };\n };\n };\n const preview = win[\"__STORYBOOK_PREVIEW__\"];\n if (!preview) return;\n // Try channel-based error capture for play failures\n let playError: unknown = null;\n const handler = (err: unknown): void => {\n playError = err;\n };\n // Storybook channel emits playFunctionThrewException on failure\n try {\n preview.channel?.on(\"playFunctionThrewException\", handler);\n } catch {\n // Channel hookup is best-effort; play still runs without it.\n }\n // Try direct executePlay if available (custom StoryShelf preview addition)\n if (preview.executePlay) {\n await Promise.race([\n preview.executePlay(storyId),\n new Promise((_, reject) => {\n setTimeout(() => {\n reject(new Error(`play timeout after ${timeoutMs}ms`));\n }, timeoutMs);\n }),\n ]);\n } else if (preview.storyStore?.fromId) {\n const loaded = preview.storyStore.fromId(storyId) as unknown as { play?: (ctx: unknown) => Promise<void> };\n if (loaded?.play) {\n await Promise.race([\n loaded.play({ canvasElement: globalThis.document.querySelector(\"#storybook-root\") }),\n new Promise((_, reject) => {\n setTimeout(() => {\n reject(new Error(`play timeout after ${timeoutMs}ms`));\n }, timeoutMs);\n }),\n ]);\n }\n }\n if (playError) throw playError;\n },\n { storyId: story.id, timeoutMs: timeout },\n );\n } catch (error) {\n throw new Error(`play failed: ${messageOf(error)}`, { cause: error });\n }\n }\n // Playwright page.screenshot supports animations: disabled to freeze CSS animations\n return await page.screenshot({ animations: story.parameters?.pauseAnimationAtEnd ? \"allow\" : \"disabled\" });\n } finally {\n await page.close();\n }\n}\n"],"mappings":";;;;;;;AA6BA,MAAM,6BAAa,IAAI,IAAuB;;AAc9C,SAAgB,gCAA+C;CAC7D,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAU,WAAuD,mBAAmB;GACpF,aAAa;GACb,MAAM;EACR;EACA,MAAM,OAAO,OAA8B;GACzC,MAAM,SAAoB;IAAE,WAAW;IAAO,SAAS;GAAK;GAC5D,WAAW,IAAI,MAAM,SAAS,MAAM;GACpC,IAAI;IACF,OAAO,MAAM,UAAU,OAAO,MAAM;GACtC,UAAU;IACR,WAAW,OAAO,MAAM,OAAO;GACjC;EACF;EACA,MAAM,OAAO,SAAS;GACpB,MAAM,SAAS,WAAW,IAAI,OAAO;GACrC,IAAI,CAAC,QACH;GAEF,OAAO,YAAY;GACnB,MAAM,aAAa,OAAO,OAAO;EACnC;CACF;AACF;AAEA,eAAe,aAAa,SAAwC;CAClE,IAAI,CAAC,SACH;CAEF,IAAI;EACF,MAAM,QAAQ,MAAM;CACtB,QAAQ,CAER;AACF;AAEA,eAAe,UAAU,OAA8B,QAA0C;CAC/F,MAAM,SAAS,MAAM,mBAAmB,MAAM,YAAY;CAC1D,MAAM,UAAU,MAAM,SAAS,OAAO;CACtC,OAAO,UAAU;CAEjB,MAAM,MAA6E;EACjF;EACA,SAAA,IAHkB,iBAGZ;EACN,SAAS,OAAO;EAChB,aAAa,MAAM;EACnB,eAAe,MAAM;CACvB;CACA,MAAM,WAA+B,CAAC;CACtC,MAAM,WAAqC,CAAC;CAC5C,IAAI;EACF,MAAM,QAAQ,MAAM,UAAU,SAAS,aACrC,MAAM,QAAQ,IAAI,OAAO,UAAU;GACjC,IAAI,OAAO,WACT,MAAM,IAAI,MAAM,mBAAmB;GAErC,IAAI;IACF,MAAM,aAAa,MAAM,kBAAkB,KAAK,OAAO,QAAQ;IAC/D,SAAS,KAAK;KAAE;KAAO,cAAc,SAAS;KAAM;IAAW,CAAC;GAClE,SAAS,OAAO;IACd,SAAS,KAAK;KAAE,SAAS,MAAM;KAAI,cAAc,SAAS;KAAM,OAAO,UAAU,KAAK;IAAE,CAAC;IACzF,MAAM,QAAQ,MAAM;KAAE,SAAS,MAAM;KAAI,UAAU,SAAS;KAAM,KAAK;IAAM,GAAG,yBAAyB;GAC3G;EACF,CAAC,CACH;EACA,MAAM,QAAQ,IAAI,KAAK;EACvB,OAAO;GAAE;GAAU;EAAS;CAC9B,UAAU;EACR,OAAO,UAAU;EACjB,MAAM,QAAQ,IAAI,CAAC,iBAAiB,OAAO,GAAG,gBAAgB,MAAM,CAAC,CAAC;CACxE;AACF;AAEA,SAAS,UAAU,OAAwB;CACzC,OAAO,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAC9D;AAEA,eAAe,iBAAiB,SAAiC;CAC/D,IAAI;EACF,MAAM,QAAQ,MAAM;CACtB,QAAQ,CAER;AACF;AAEA,eAAe,gBAAgB,QAAmD;CAChF,IAAI;EACF,MAAM,OAAO,MAAM;CACrB,QAAQ,CAER;AACF;AAEA,eAAe,kBACb,KACA,OACA,UACiB;CACjB,MAAM,OAAO,MAAM,IAAI,QAAQ,QAAQ,EAAE,UAAU;EAAE,OAAO,SAAS;EAAO,QAAQ,SAAS;CAAO,EAAE,CAAC;CACvG,IAAI;EACF,MAAM,KAAK,KAAK,IAAI,QAAQ,SAAS,IAAI,SAAS,MAAM,EAAE,GAAG,EAAE,WAAW,cAAc,CAAC;EACzF,IAAI,IAAI,QAAQ,oBAAoB;GAClC,MAAM,KAAK,gBAAgB,IAAI,QAAQ,oBAAoB,EAAE,OAAO,WAAW,CAAC;GAChF,MAAM,QAAQ,MAAM,YAAY,SAAS;GACzC,MAAM,KAAK,eAAe,KAAK;GAC/B,IAAI,MAAM,YAAY,qBACpB,MAAM,KAAK,eAAe;IACxB,MAAM,MAAM,WAAW;IACvB,KAAK,MAAM,QAAQ,IAAI,cAAc,GAAG,KAAK,MAAM;GACrD,CAAC;EAEL;EACA,IAAI,IAAI,aAAa;GACnB,MAAM,UAAU,IAAI,iBAAiB;GACrC,IAAI;IACF,MAAM,KAAK,SACT,OAAO,EAAE,SAAS,gBAAwD;KAQxE,MAAM,UAAUA,WAAI;KACpB,IAAI,CAAC,SAAS;KAEd,IAAI,YAAqB;KACzB,MAAM,WAAW,QAAuB;MACtC,YAAY;KACd;KAEA,IAAI;MACF,QAAQ,SAAS,GAAG,8BAA8B,OAAO;KAC3D,QAAQ,CAER;KAEA,IAAI,QAAQ,aACV,MAAM,QAAQ,KAAK,CACjB,QAAQ,YAAY,OAAO,GAC3B,IAAI,SAAS,GAAG,WAAW;MACzB,iBAAiB;OACf,uBAAO,IAAI,MAAM,sBAAsB,UAAU,GAAG,CAAC;MACvD,GAAG,SAAS;KACd,CAAC,CACH,CAAC;UACI,IAAI,QAAQ,YAAY,QAAQ;MACrC,MAAM,SAAS,QAAQ,WAAW,OAAO,OAAO;MAChD,IAAI,QAAQ,MACV,MAAM,QAAQ,KAAK,CACjB,OAAO,KAAK,EAAE,eAAe,WAAW,SAAS,cAAc,iBAAiB,EAAE,CAAC,GACnF,IAAI,SAAS,GAAG,WAAW;OACzB,iBAAiB;QACf,uBAAO,IAAI,MAAM,sBAAsB,UAAU,GAAG,CAAC;OACvD,GAAG,SAAS;MACd,CAAC,CACH,CAAC;KAEL;KACA,IAAI,WAAW,MAAM;IACvB,GACA;KAAE,SAAS,MAAM;KAAI,WAAW;IAAQ,CAC1C;GACF,SAAS,OAAO;IACd,MAAM,IAAI,MAAM,gBAAgB,UAAU,KAAK,KAAK,EAAE,OAAO,MAAM,CAAC;GACtE;EACF;EAEA,OAAO,MAAM,KAAK,WAAW,EAAE,YAAY,MAAM,YAAY,sBAAsB,UAAU,WAAW,CAAC;CAC3G,UAAU;EACR,MAAM,KAAK,MAAM;CACnB;AACF"}
package/dist/static-server.mjs CHANGED
@@ -61,6 +61,12 @@ async function closeServer(server) {
61
61
  });
62
62
  });
63
63
  }
64
+ /**
65
+ * Serve a built Storybook directory over HTTP on 127.0.0.1 for capture.
66
+ *
67
+ * @param rootDir - Directory containing the built Storybook (`index.html` entry).
68
+ * @returns The server URL and a `close` function to stop it.
69
+ */
64
70
  async function createStaticServer(rootDir) {
65
71
  const root = normalize(rootDir);
66
72
  const info = await stat(root).catch(() => null);
package/dist/static-server.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"static-server.mjs","names":[],"sources":["../src/static-server.ts"],"sourcesContent":["import { createReadStream } from \"node:fs\";\nimport { stat } from \"node:fs/promises\";\nimport { createServer, type Server, type ServerResponse } from \"node:http\";\nimport { extname, join, normalize, sep } from \"node:path\";\n\nexport interface StaticServer {\n url: string;\n close(): Promise<void>;\n}\n\nconst MIME_TYPES: Record<string, string> = {\n \".css\": \"text/css; charset=utf-8\",\n \".html\": \"text/html; charset=utf-8\",\n \".ico\": \"image/x-icon\",\n \".jpeg\": \"image/jpeg\",\n \".jpg\": \"image/jpeg\",\n \".js\": \"text/javascript; charset=utf-8\",\n \".json\": \"application/json; charset=utf-8\",\n \".map\": \"application/json; charset=utf-8\",\n \".mjs\": \"text/javascript; charset=utf-8\",\n \".png\": \"image/png\",\n \".svg\": \"image/svg+xml\",\n};\n\nfunction mimeFor(file: string): string {\n return MIME_TYPES[extname(file).toLowerCase()] ?? \"application/octet-stream\";\n}\n\nfunction sendNotFound(res: ServerResponse): void {\n res.writeHead(404, { \"content-type\": \"text/plain\" });\n res.end(\"Not found\");\n}\n\nasync function resolveFile(root: string, urlPath: string): Promise<string | null> {\n const clean = (urlPath.split(\"?\")[0] ?? \"/\").replace(/^\\/+/u, \"\");\n const target = normalize(join(root, clean === \"\" ? \"index.html\" : clean));\n if (target !== root && !target.startsWith(root + sep)) {\n return null;\n }\n const info = await stat(target).catch(() => null);\n if (!info) {\n return null;\n }\n if (info.isDirectory()) {\n return resolveFile(root, `${clean}/index.html`);\n }\n return info.isFile() ? target : null;\n}\n\nasync function handleRequest(root: string, url: string, res: ServerResponse): Promise<void> {\n const file = await resolveFile(root, url);\n if (!file) {\n sendNotFound(res);\n return;\n }\n res.writeHead(200, { \"content-type\": mimeFor(file) });\n createReadStream(file).pipe(res);\n}\n\nasync function listen(server: Server): Promise<number> {\n return await new Promise((resolve, reject) => {\n server.once(\"error\", reject);\n server.listen(0, \"127.0.0.1\", () => {\n const address = server.address();\n resolve(typeof address === \"object\" && address !== null ? address.port : 0);\n });\n });\n}\n\nasync function closeServer(server: Server): Promise<void> {\n await new Promise<void>((resolve, reject) => {\n server.close((error) => {\n if (error) {\n reject(error);\n } else {\n resolve();\n }\n });\n });\n}\n\nexport async function createStaticServer(rootDir: string): Promise<StaticServer> {\n const root = normalize(rootDir);\n const info = await stat(root).catch(() => null);\n if (!info || !info.isDirectory()) {\n throw new Error(`Storybook directory not found: ${rootDir}. Upload the built Storybook before capturing.`);\n }\n\n const server = createServer((req, res) => {\n handleRequest(root, req.url ?? \"/\", res).catch(() => {\n sendNotFound(res);\n });\n });\n\n const port = await listen(server);\n\n return {\n url: `http://127.0.0.1:${port}`,\n close: async () => {\n await closeServer(server);\n },\n };\n}\n"],"mappings":";;;;;;;;AAUA,MAAM,aAAqC;CACzC,QAAQ;CACR,SAAS;CACT,QAAQ;CACR,SAAS;CACT,QAAQ;CACR,OAAO;CACP,SAAS;CACT,QAAQ;CACR,QAAQ;CACR,QAAQ;CACR,QAAQ;AACV;AAEA,SAAS,QAAQ,MAAsB;CACrC,OAAO,WAAW,QAAQ,IAAI,CAAC,CAAC,YAAY,MAAM;AACpD;AAEA,SAAS,aAAa,KAA2B;CAC/C,IAAI,UAAU,KAAK,EAAE,gBAAgB,aAAa,CAAC;CACnD,IAAI,IAAI,WAAW;AACrB;AAEA,eAAe,YAAY,MAAc,SAAyC;CAChF,MAAM,SAAS,QAAQ,MAAM,GAAG,CAAC,CAAC,MAAM,IAAA,CAAK,QAAQ,SAAS,EAAE;CAChE,MAAM,SAAS,UAAU,KAAK,MAAM,UAAU,KAAK,eAAe,KAAK,CAAC;CACxE,IAAI,WAAW,QAAQ,CAAC,OAAO,WAAW,OAAO,GAAG,GAClD,OAAO;CAET,MAAM,OAAO,MAAM,KAAK,MAAM,CAAC,CAAC,YAAY,IAAI;CAChD,IAAI,CAAC,MACH,OAAO;CAET,IAAI,KAAK,YAAY,GACnB,OAAO,YAAY,MAAM,GAAG,MAAM,YAAY;CAEhD,OAAO,KAAK,OAAO,IAAI,SAAS;AAClC;AAEA,eAAe,cAAc,MAAc,KAAa,KAAoC;CAC1F,MAAM,OAAO,MAAM,YAAY,MAAM,GAAG;CACxC,IAAI,CAAC,MAAM;EACT,aAAa,GAAG;EAChB;CACF;CACA,IAAI,UAAU,KAAK,EAAE,gBAAgB,QAAQ,IAAI,EAAE,CAAC;CACpD,iBAAiB,IAAI,CAAC,CAAC,KAAK,GAAG;AACjC;AAEA,eAAe,OAAO,QAAiC;CACrD,OAAO,MAAM,IAAI,SAAS,SAAS,WAAW;EAC5C,OAAO,KAAK,SAAS,MAAM;EAC3B,OAAO,OAAO,GAAG,mBAAmB;GAClC,MAAM,UAAU,OAAO,QAAQ;GAC/B,QAAQ,OAAO,YAAY,YAAY,YAAY,OAAO,QAAQ,OAAO,CAAC;EAC5E,CAAC;CACH,CAAC;AACH;AAEA,eAAe,YAAY,QAA+B;CACxD,MAAM,IAAI,SAAe,SAAS,WAAW;EAC3C,OAAO,OAAO,UAAU;GACtB,IAAI,OACF,OAAO,KAAK;QAEZ,QAAQ;EAEZ,CAAC;CACH,CAAC;AACH;AAEA,eAAsB,mBAAmB,SAAwC;CAC/E,MAAM,OAAO,UAAU,OAAO;CAC9B,MAAM,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,YAAY,IAAI;CAC9C,IAAI,CAAC,QAAQ,CAAC,KAAK,YAAY,GAC7B,MAAM,IAAI,MAAM,kCAAkC,QAAQ,+CAA+C;CAG3G,MAAM,SAAS,cAAc,KAAK,QAAQ;EACxC,cAAc,MAAM,IAAI,OAAO,KAAK,GAAG,CAAC,CAAC,YAAY;GACnD,aAAa,GAAG;EAClB,CAAC;CACH,CAAC;CAID,OAAO;EACL,KAAK,oBAAoB,MAHR,OAAO,MAAM;EAI9B,OAAO,YAAY;GACjB,MAAM,YAAY,MAAM;EAC1B;CACF;AACF"}
1
+ {"version":3,"file":"static-server.mjs","names":[],"sources":["../src/static-server.ts"],"sourcesContent":["import { createReadStream } from \"node:fs\";\nimport { stat } from \"node:fs/promises\";\nimport { createServer, type Server, type ServerResponse } from \"node:http\";\nimport { extname, join, normalize, sep } from \"node:path\";\n\n/** A local HTTP server serving a built Storybook directory for capture. */\nexport interface StaticServer {\n url: string;\n close(): Promise<void>;\n}\n\nconst MIME_TYPES: Record<string, string> = {\n \".css\": \"text/css; charset=utf-8\",\n \".html\": \"text/html; charset=utf-8\",\n \".ico\": \"image/x-icon\",\n \".jpeg\": \"image/jpeg\",\n \".jpg\": \"image/jpeg\",\n \".js\": \"text/javascript; charset=utf-8\",\n \".json\": \"application/json; charset=utf-8\",\n \".map\": \"application/json; charset=utf-8\",\n \".mjs\": \"text/javascript; charset=utf-8\",\n \".png\": \"image/png\",\n \".svg\": \"image/svg+xml\",\n};\n\nfunction mimeFor(file: string): string {\n return MIME_TYPES[extname(file).toLowerCase()] ?? \"application/octet-stream\";\n}\n\nfunction sendNotFound(res: ServerResponse): void {\n res.writeHead(404, { \"content-type\": \"text/plain\" });\n res.end(\"Not found\");\n}\n\nasync function resolveFile(root: string, urlPath: string): Promise<string | null> {\n const clean = (urlPath.split(\"?\")[0] ?? \"/\").replace(/^\\/+/u, \"\");\n const target = normalize(join(root, clean === \"\" ? \"index.html\" : clean));\n if (target !== root && !target.startsWith(root + sep)) {\n return null;\n }\n const info = await stat(target).catch(() => null);\n if (!info) {\n return null;\n }\n if (info.isDirectory()) {\n return resolveFile(root, `${clean}/index.html`);\n }\n return info.isFile() ? target : null;\n}\n\nasync function handleRequest(root: string, url: string, res: ServerResponse): Promise<void> {\n const file = await resolveFile(root, url);\n if (!file) {\n sendNotFound(res);\n return;\n }\n res.writeHead(200, { \"content-type\": mimeFor(file) });\n createReadStream(file).pipe(res);\n}\n\nasync function listen(server: Server): Promise<number> {\n return await new Promise((resolve, reject) => {\n server.once(\"error\", reject);\n server.listen(0, \"127.0.0.1\", () => {\n const address = server.address();\n resolve(typeof address === \"object\" && address !== null ? address.port : 0);\n });\n });\n}\n\nasync function closeServer(server: Server): Promise<void> {\n await new Promise<void>((resolve, reject) => {\n server.close((error) => {\n if (error) {\n reject(error);\n } else {\n resolve();\n }\n });\n });\n}\n\n/**\n * Serve a built Storybook directory over HTTP on 127.0.0.1 for capture.\n *\n * @param rootDir - Directory containing the built Storybook (`index.html` entry).\n * @returns The server URL and a `close` function to stop it.\n */\nexport async function createStaticServer(rootDir: string): Promise<StaticServer> {\n const root = normalize(rootDir);\n const info = await stat(root).catch(() => null);\n if (!info || !info.isDirectory()) {\n throw new Error(`Storybook directory not found: ${rootDir}. Upload the built Storybook before capturing.`);\n }\n\n const server = createServer((req, res) => {\n handleRequest(root, req.url ?? \"/\", res).catch(() => {\n sendNotFound(res);\n });\n });\n\n const port = await listen(server);\n\n return {\n url: `http://127.0.0.1:${port}`,\n close: async () => {\n await closeServer(server);\n },\n };\n}\n"],"mappings":";;;;;;;;AAWA,MAAM,aAAqC;CACzC,QAAQ;CACR,SAAS;CACT,QAAQ;CACR,SAAS;CACT,QAAQ;CACR,OAAO;CACP,SAAS;CACT,QAAQ;CACR,QAAQ;CACR,QAAQ;CACR,QAAQ;AACV;AAEA,SAAS,QAAQ,MAAsB;CACrC,OAAO,WAAW,QAAQ,IAAI,CAAC,CAAC,YAAY,MAAM;AACpD;AAEA,SAAS,aAAa,KAA2B;CAC/C,IAAI,UAAU,KAAK,EAAE,gBAAgB,aAAa,CAAC;CACnD,IAAI,IAAI,WAAW;AACrB;AAEA,eAAe,YAAY,MAAc,SAAyC;CAChF,MAAM,SAAS,QAAQ,MAAM,GAAG,CAAC,CAAC,MAAM,IAAA,CAAK,QAAQ,SAAS,EAAE;CAChE,MAAM,SAAS,UAAU,KAAK,MAAM,UAAU,KAAK,eAAe,KAAK,CAAC;CACxE,IAAI,WAAW,QAAQ,CAAC,OAAO,WAAW,OAAO,GAAG,GAClD,OAAO;CAET,MAAM,OAAO,MAAM,KAAK,MAAM,CAAC,CAAC,YAAY,IAAI;CAChD,IAAI,CAAC,MACH,OAAO;CAET,IAAI,KAAK,YAAY,GACnB,OAAO,YAAY,MAAM,GAAG,MAAM,YAAY;CAEhD,OAAO,KAAK,OAAO,IAAI,SAAS;AAClC;AAEA,eAAe,cAAc,MAAc,KAAa,KAAoC;CAC1F,MAAM,OAAO,MAAM,YAAY,MAAM,GAAG;CACxC,IAAI,CAAC,MAAM;EACT,aAAa,GAAG;EAChB;CACF;CACA,IAAI,UAAU,KAAK,EAAE,gBAAgB,QAAQ,IAAI,EAAE,CAAC;CACpD,iBAAiB,IAAI,CAAC,CAAC,KAAK,GAAG;AACjC;AAEA,eAAe,OAAO,QAAiC;CACrD,OAAO,MAAM,IAAI,SAAS,SAAS,WAAW;EAC5C,OAAO,KAAK,SAAS,MAAM;EAC3B,OAAO,OAAO,GAAG,mBAAmB;GAClC,MAAM,UAAU,OAAO,QAAQ;GAC/B,QAAQ,OAAO,YAAY,YAAY,YAAY,OAAO,QAAQ,OAAO,CAAC;EAC5E,CAAC;CACH,CAAC;AACH;AAEA,eAAe,YAAY,QAA+B;CACxD,MAAM,IAAI,SAAe,SAAS,WAAW;EAC3C,OAAO,OAAO,UAAU;GACtB,IAAI,OACF,OAAO,KAAK;QAEZ,QAAQ;EAEZ,CAAC;CACH,CAAC;AACH;;;;;;;AAQA,eAAsB,mBAAmB,SAAwC;CAC/E,MAAM,OAAO,UAAU,OAAO;CAC9B,MAAM,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,YAAY,IAAI;CAC9C,IAAI,CAAC,QAAQ,CAAC,KAAK,YAAY,GAC7B,MAAM,IAAI,MAAM,kCAAkC,QAAQ,+CAA+C;CAG3G,MAAM,SAAS,cAAc,KAAK,QAAQ;EACxC,cAAc,MAAM,IAAI,OAAO,KAAK,GAAG,CAAC,CAAC,YAAY;GACnD,aAAa,GAAG;EAClB,CAAC;CACH,CAAC;CAID,OAAO;EACL,KAAK,oBAAoB,MAHR,OAAO,MAAM;EAI9B,OAAO,YAAY;GACjB,MAAM,YAAY,MAAM;EAC1B;CACF;AACF"}
package/package.json CHANGED
@@ -1,46 +1,53 @@
1
1
  {
2
2
  "name": "@storyshelf/runner-playwright",
3
- "version": "0.1.0",
4
- "type": "module",
3
+ "version": "0.1.2",
5
4
  "description": "Pure Playwright CaptureRunner implementation for StoryShelf: renders Storybook screenshots in-process (no db/storage coupling).",
5
+ "homepage": "https://github.com/GuptaSiddhant/StoryShelf#readme",
6
+ "bugs": {
7
+ "url": "https://github.com/GuptaSiddhant/StoryShelf/issues"
8
+ },
9
+ "license": "MIT",
6
10
  "author": {
7
11
  "name": "Siddhant Gupta",
8
12
  "url": "https://guptasiddhant.com"
9
13
  },
10
- "license": "MIT",
11
- "sideEffects": false,
12
14
  "repository": {
13
15
  "type": "git",
14
- "url": "git+https://github.com/GuptaSiddhant/storyshelf.git",
16
+ "url": "git+https://github.com/GuptaSiddhant/StoryShelf.git",
15
17
  "directory": "packages/runner-playwright"
16
18
  },
17
- "homepage": "https://github.com/GuptaSiddhant/storyshelf#readme",
18
- "bugs": {
19
- "url": "https://github.com/GuptaSiddhant/storyshelf/issues"
19
+ "files": [
20
+ "dist"
21
+ ],
22
+ "type": "module",
23
+ "sideEffects": false,
24
+ "types": "./dist/index.d.mts",
25
+ "exports": {
26
+ ".": {
27
+ "source": "./src/index.ts",
28
+ "default": "./dist/index.mjs"
29
+ },
30
+ "./package.json": "./package.json"
20
31
  },
21
32
  "publishConfig": {
22
- "access": "public",
23
33
  "exports": {
24
34
  ".": "./dist/index.mjs",
25
35
  "./package.json": "./package.json"
26
- }
36
+ },
37
+ "access": "public"
27
38
  },
28
- "files": [
29
- "dist"
30
- ],
31
39
  "scripts": {
32
40
  "build": "tsdown",
33
41
  "dev": "tsdown -w",
34
- "fmt": "oxfmt -c ../../.oxfmtrc.json ./src",
42
+ "fmt": "oxfmt ./src",
35
43
  "lint": "oxlint --type-aware --type-check ./src",
36
44
  "test": "vitest run",
37
45
  "test:integration": "RUN_INTEGRATION=1 vitest run integration.test.ts",
38
46
  "prepublishOnly": "nub run build"
39
47
  },
40
48
  "dependencies": {
41
- "@storyshelf/core": "workspace:*",
49
+ "@storyshelf/core": "^0.1.2",
42
50
  "adm-zip": "^0.6.0",
43
- "pino": "^10.3.1",
44
51
  "playwright": "^1.52.0"
45
52
  },
46
53
  "devDependencies": {
@@ -55,12 +62,13 @@
55
62
  "typescript": "catalog:",
56
63
  "vitest": "catalog:"
57
64
  },
58
- "types": "./dist/index.d.mts",
59
- "exports": {
60
- ".": {
61
- "source": "./src/index.ts",
62
- "default": "./dist/index.mjs"
63
- },
64
- "./package.json": "./package.json"
65
+ "jsr": {
66
+ "runtimeCompat": {
67
+ "node": true,
68
+ "deno": true,
69
+ "browser": false,
70
+ "workerd": false,
71
+ "bun": true
72
+ }
65
73
  }
66
74
  }