@onlook/storybook-plugin 0.4.0-beta.1 → 0.4.0-beta.11

package/README.md

@@ -44,7 +44,7 @@ Configures Vite HMR for E2B sandboxes (WSS protocol, port 443 routing).
 
 ### CORS
 
-Pre-configured for `https://app.onlook.ai`, `localhost:3000`, and `localhost:6006`.
+Pre-configured for `https://app.onlook.com`, `localhost:3000`, and `localhost:6006`.
 
 ## Options
 

package/dist/cli/index.js

@@ -1,11 +1,15 @@
 #!/usr/bin/env node
+import { createRequire } from 'node:module';
 import { command, string, boolean, run } from '@drizzle-team/brocli';
-import { spawn } from 'child_process';
+import { execFile, spawn } from 'child_process';
 import fs, { readFileSync, existsSync } from 'fs';
 import path, { resolve, join, dirname } from 'path';
 import crypto from 'crypto';
+import { createRequire as createRequire$1 } from 'module';
+import { promisify } from 'util';
 import { chromium } from 'playwright';
 
+globalThis.require = createRequire(import.meta.url);
 var CACHE_DIR = path.join(process.cwd(), ".storybook-cache");
 var SCREENSHOTS_DIR = path.join(CACHE_DIR, "screenshots");
 var MANIFEST_PATH = path.join(CACHE_DIR, "manifest.json");
@@ -55,24 +59,88 @@ function updateManifest(storyId, sourcePath, fileHash, boundingBox) {
   };
   saveManifest(manifest);
 }
-var browser = null;
+var execFileAsync = promisify(execFile);
+var require2 = createRequire$1(import.meta.url);
+var browserPromise = null;
+var installPromise = null;
+var isMissingExecutableError = (err) => {
+  const msg = err instanceof Error ? err.message : String(err);
+  return msg.includes("Executable doesn't exist") || msg.includes("Please run the following command to download new browsers") || // Older playwright revisions phrase the version-mismatch case differently.
+  /chromium-\d+\/chrome-linux\/chrome/i.test(msg);
+};
+function resolvePlaywrightCli() {
+  const pkgJson = require2.resolve("playwright-core/package.json");
+  return join(dirname(pkgJson), "cli.js");
+}
+async function installChromium() {
+  if (!installPromise) {
+    installPromise = (async () => {
+      const cliPath = resolvePlaywrightCli();
+      console.log(
+        `[STORYBOOK_PLUGIN] chromium binary missing \u2014 installing via ${cliPath}`
+      );
+      try {
+        const { stdout, stderr } = await execFileAsync(
+          process.execPath,
+          [cliPath, "install", "--force", "chromium"],
+          { timeout: 5 * 60 * 1e3, maxBuffer: 32 * 1024 * 1024 }
+        );
+        if (stdout)
+          console.log(`[STORYBOOK_PLUGIN] playwright install: ${stdout.slice(-1e3)}`);
+        if (stderr)
+          console.log(
+            `[STORYBOOK_PLUGIN] playwright install stderr: ${stderr.slice(-1e3)}`
+          );
+        console.log("[STORYBOOK_PLUGIN] chromium installed");
+      } catch (err) {
+        const detail = err instanceof Error ? err.message : String(err);
+        console.error(`[STORYBOOK_PLUGIN] chromium install FAILED: ${detail}`);
+        throw new Error(`Playwright chromium install failed: ${detail}`);
+      } finally {
+        installPromise = null;
+      }
+    })();
+  }
+  return installPromise;
+}
+async function launchWithSelfHeal() {
+  try {
+    return await chromium.launch({ headless: true });
+  } catch (err) {
+    if (!isMissingExecutableError(err)) throw err;
+    console.log("[STORYBOOK_PLUGIN] launch failed, attempting self-heal install");
+    await installChromium();
+    try {
+      return await chromium.launch({ headless: true });
+    } catch (postInstallErr) {
+      const detail = postInstallErr instanceof Error ? postInstallErr.message : String(postInstallErr);
+      console.error(
+        `[STORYBOOK_PLUGIN] launch still failing after install \u2014 likely path or libs issue: ${detail}`
+      );
+      throw new Error(
+        `Playwright chromium is unavailable in this sandbox (install ran but launch still failed): ${detail}`
+      );
+    }
+  }
+}
 async function getBrowser() {
-  if (!browser) {
-    browser = await chromium.launch({
-      headless: true
+  if (!browserPromise) {
+    browserPromise = launchWithSelfHeal().catch((err) => {
+      browserPromise = null;
+      throw err;
     });
   }
-  return browser;
+  return browserPromise;
 }
 async function closeBrowser() {
-  if (browser) {
-    try {
-      await browser.close();
-    } catch (error) {
-      console.error("Error closing browser:", error);
-    } finally {
-      browser = null;
-    }
+  const pending = browserPromise;
+  if (!pending) return;
+  browserPromise = null;
+  try {
+    const b = await pending;
+    await b.close();
+  } catch (error) {
+    console.error("Error closing browser:", error);
   }
 }
 function getScreenshotPath(storyId, theme) {
@@ -84,8 +152,8 @@ function screenshotExists(storyId, theme) {
   return fs.existsSync(screenshotPath);
 }
 async function captureScreenshotBuffer(storyId, theme, width = VIEWPORT_WIDTH, height = VIEWPORT_HEIGHT, storybookUrl = "http://localhost:6006", timeoutMs = 3e4) {
-  const browser2 = await getBrowser();
-  const context = await browser2.newContext({
+  const browser = await getBrowser();
+  const context = await browser.newContext({
     viewport: { width, height },
     deviceScaleFactor: 2
   });
@@ -190,6 +258,61 @@ async function generateScreenshot(storyId, theme, storybookUrl = "http://localho
 }
 
 // src/screenshot-service/screenshot-service.ts
+var ONBOOK_PROXY_TOKEN = process.env.ONBOOK_PROXY_TOKEN ?? null;
+var ONBOOK_BROADCAST_URL = process.env.ONBOOK_BROADCAST_URL ?? null;
+var PROGRESS_TIMEOUT_MS = 3e3;
+async function broadcastScreenshotProgress(completed, total) {
+  if (!ONBOOK_PROXY_TOKEN || !ONBOOK_BROADCAST_URL) return;
+  const percent = total > 0 ? Math.min(100, Math.floor(completed / total * 100)) : null;
+  try {
+    await fetch(ONBOOK_BROADCAST_URL, {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${ONBOOK_PROXY_TOKEN}`,
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify({
+        event: {
+          type: "SANDBOX_PHASE_PROGRESS",
+          phase: "generating_screenshots",
+          completed,
+          total,
+          percent,
+          label: "Capturing stories"
+        }
+      }),
+      signal: AbortSignal.timeout(PROGRESS_TIMEOUT_MS)
+    });
+  } catch {
+  }
+}
+var StoryTimeoutError = class extends Error {
+  constructor(storyId, timeoutMs) {
+    super(`Story ${storyId} timed out after ${timeoutMs / 1e3}s`);
+    this.storyId = storyId;
+    this.timeoutMs = timeoutMs;
+    this.name = "StoryTimeoutError";
+  }
+};
+async function captureBothThemes(storyId, storybookUrl, timeoutMs, storyTimeoutMs) {
+  let timer;
+  try {
+    return await Promise.race([
+      Promise.all([
+        generateScreenshot(storyId, "light", storybookUrl, timeoutMs),
+        generateScreenshot(storyId, "dark", storybookUrl, timeoutMs)
+      ]),
+      new Promise((_, reject) => {
+        timer = setTimeout(
+          () => reject(new StoryTimeoutError(storyId, storyTimeoutMs)),
+          storyTimeoutMs
+        );
+      })
+    ]);
+  } finally {
+    if (timer) clearTimeout(timer);
+  }
+}
 async function generateAllScreenshots(stories, storybookUrl = "http://localhost:6006", concurrency = 10, offset = 0, total, skipExisting = false, timeoutMs = 3e4) {
   const displayTotal = total ?? offset + stories.length;
   console.log(
@@ -200,58 +323,82 @@ async function generateAllScreenshots(stories, storybookUrl = "http://localhost:
   for (let i = 0; i < stories.length; i += BATCH_SIZE) {
     batches.push(stories.slice(i, i + BATCH_SIZE));
   }
+  const storyTimeout = timeoutMs * 2 + 1e4;
   let completed = 0;
+  void broadcastScreenshotProgress(0, displayTotal);
   for (const batch of batches) {
     await Promise.all(
       batch.map(async (story) => {
         if (skipExisting && screenshotExists(story.id, "light") && screenshotExists(story.id, "dark")) {
           completed++;
-          const absoluteIndex = offset + completed;
-          console.log(`[${absoluteIndex}/${displayTotal}] Skipped (exists) ${story.id}`);
+          const absoluteIndex2 = offset + completed;
+          console.log(`[${absoluteIndex2}/${displayTotal}] Skipped (exists) ${story.id}`);
           return;
         }
-        const storyTimeout = timeoutMs * 2 + 1e4;
-        let timer;
-        try {
-          const result = await Promise.race([
-            Promise.all([
-              generateScreenshot(story.id, "light", storybookUrl, timeoutMs),
-              generateScreenshot(story.id, "dark", storybookUrl, timeoutMs)
-            ]),
-            new Promise((_, reject) => {
-              timer = setTimeout(
-                () => reject(
-                  new Error(
-                    `Story ${story.id} timed out after ${storyTimeout / 1e3}s`
-                  )
-                ),
-                storyTimeout
-              );
-            })
-          ]);
-          clearTimeout(timer);
-          const [lightResult, darkResult] = result;
-          if (lightResult && darkResult) {
-            const fileHash = computeFileHash(story.importPath);
-            updateManifest(story.id, story.importPath, fileHash, lightResult.boundingBox);
+        let lightResult = null;
+        let darkResult = null;
+        let lastError;
+        const startedAt = Date.now();
+        let attempts = 0;
+        const maxAttempts = 2;
+        while (attempts < maxAttempts) {
+          attempts++;
+          try {
+            [lightResult, darkResult] = await captureBothThemes(
+              story.id,
+              storybookUrl,
+              timeoutMs,
+              storyTimeout
+            );
+            lastError = void 0;
+            break;
+          } catch (error) {
+            lastError = error;
+            if (!(error instanceof StoryTimeoutError) || attempts >= maxAttempts) {
+              break;
+            }
+            console.warn(
+              `[screenshot] Retrying ${story.id} after timeout (attempt ${attempts + 1}/${maxAttempts})`
+            );
           }
-          completed++;
-          const absoluteIndex = offset + completed;
+        }
+        completed++;
+        const absoluteIndex = offset + completed;
+        const durationMs = Date.now() - startedAt;
+        if (lightResult && darkResult) {
+          const fileHash = computeFileHash(story.importPath);
+          updateManifest(story.id, story.importPath, fileHash, lightResult.boundingBox);
           console.log(
-            `[${absoluteIndex}/${displayTotal}] Generated screenshots for ${story.id}`
+            `[${absoluteIndex}/${displayTotal}] Generated screenshots for ${story.id}`,
+            { storyId: story.id, attempts, durationMs, outcome: "ok" }
           );
-        } catch (error) {
-          completed++;
-          const absoluteIndex = offset + completed;
+        } else if (lastError) {
           console.error(
             `[${absoluteIndex}/${displayTotal}] \u26A0\uFE0F Failed ${story.id}:`,
-            error instanceof Error ? error.message : error
+            lastError instanceof Error ? lastError.message : lastError,
+            {
+              storyId: story.id,
+              attempts,
+              durationMs,
+              outcome: lastError instanceof StoryTimeoutError ? "timeout" : "error"
+            }
           );
+        } else {
+          console.warn(`[${absoluteIndex}/${displayTotal}] Partial result ${story.id}`, {
+            storyId: story.id,
+            attempts,
+            durationMs,
+            outcome: "partial",
+            hasLight: !!lightResult,
+            hasDark: !!darkResult
+          });
         }
       })
     );
+    void broadcastScreenshotProgress(offset + completed, displayTotal);
   }
   await closeBrowser();
+  void broadcastScreenshotProgress(displayTotal, displayTotal);
   console.log("Screenshot generation complete!");
 }
 var LOCKFILES = {
@@ -402,8 +549,8 @@ async function startStorybook(command2, args, storybookDir) {
 }
 async function warmupStorybook(url, firstStoryId) {
   console.log("\u{1F525} Warming up Storybook...");
-  const browser2 = await getBrowser();
-  const context = await browser2.newContext();
+  const browser = await getBrowser();
+  const context = await browser.newContext();
   const page = await context.newPage();
   try {
     const warmupUrl = `${url}/iframe.html?id=${firstStoryId}&viewMode=story`;
@@ -509,5 +656,5 @@ var generateScreenshotsCommand = command({
 });
 run([generateScreenshotsCommand], {
   name: "onlook-storybook",
-  description: "Storybook plugin for Onbook - generate screenshots and more"
+  description: "Storybook plugin for Onlook - generate screenshots and more"
 });

package/dist/index.d.ts

@@ -1,24 +1,97 @@
-import { PluginOption } from 'vite';
+export { E as EnvContainmentOptions, a as EnvContainmentSubstitution, O as OnlookPluginOptions, e as envContainmentPlugin, s as storybookOnlookPlugin } from './storybook-onlook-plugin-B9Eo_OIq.js';
+import { Plugin } from 'vite';
+import { Indexer } from 'storybook/internal/types';
 
-/** Folder name for auto-generated stories (created next to each component) */
-declare const AUTO_STORIES_FOLDER = ".onlook-stories";
-type OnlookPluginOptions = {
-    /** Storybook port (default: 6006) */
-    port?: number;
-    /** Additional allowed origins for CORS (merged with defaults) */
-    allowedOrigins?: string[];
-    /**
-     * Auto-generate stories for all components.
-     * Glob patterns for component file discovery.
-     * Set to false to disable. (default: ['src\/\*\*\/*.tsx'])
-     */
-    autoStories?: string[] | false;
-    /**
-     * Glob patterns to exclude from auto-story generation.
-     * (default: stories, tests, and node_modules)
-     */
-    autoStoriesIgnore?: string[];
+/** Advertised + embedded in every event payload. Mirrored CLI-side (U8). */
+declare const ONLOOK_CONTAINMENT_CONTRACT_VERSION = 1;
+/**
+ * Global registry the env-containment stand-ins populate at evaluation time:
+ * `Record<modulePath, ContainedModuleMarker>`.
+ */
+declare const ONLOOK_CONTAINED_MODULES_GLOBAL = "__ONLOOK_CONTAINED_MODULES__";
+/** Property carrying the marker on stand-in exports and thrown errors. */
+declare const ONLOOK_CONTAINED_PROP = "__onlookContained";
+/** Marker attached to every contained export, thrown error, and the global registry. */
+type ContainedModuleMarker = {
+    modulePath: string;
+    reason: 'env-validation';
+    envKeys: string[];
+    schemaKind?: string;
 };
-declare function storybookOnlookPlugin(options?: OnlookPluginOptions): PluginOption[];
+/**
+ * Handshake global, set by the preview annotations (in `beforeAll` and again
+ * defensively when the decorator first runs):
+ * `globalThis.__ONLOOK_CONTAINMENT_CONTRACT__ = { version: 1 }`.
+ */
+declare const ONLOOK_CONTAINMENT_CONTRACT_GLOBAL = "__ONLOOK_CONTAINMENT_CONTRACT__";
+type OnlookContainmentContract = {
+    version: number;
+};
+/**
+ * Emitted when the error-boundary decorator catches a render-time throw and
+ * renders the "needs setup" card in place of the story.
+ */
+declare const ONLOOK_CONTAINED_EVENT = "onlook/contained";
+/**
+ * Emitted once per story mount, after the boundary's children committed
+ * without throwing. The verifier must key `rendered` on THIS (plus absence of
+ * Storybook error events) — never on `STORY_RENDERED` alone, which Storybook
+ * fires even after its own boundary catches.
+ */
+declare const ONLOOK_RENDERED_EVENT = "onlook/rendered";
+/**
+ * Tag-for-verifier re-emit of errors the boundary cannot catch (loader /
+ * `beforeEach` / module-load throws surface as Storybook's
+ * `storyThrewException` / `storyErrored` channel events, outside the React
+ * render). These remain overlay-not-card; no DOM repaint is attempted.
+ */
+declare const ONLOOK_UNCONTAINED_ERROR_EVENT = "onlook/uncontained-error";
+type OnlookContainedPayload = {
+    storyId: string;
+    contractVersion: number;
+    /** Trimmed failure summary (error message). */
+    message: string;
+    /** Present when the failure is attributed to a contained module (U4). */
+    module?: ContainedModuleMarker;
+};
+type OnlookRenderedPayload = {
+    storyId: string;
+    contractVersion: number;
+};
+type OnlookUncontainedErrorPayload = {
+    /** Best-effort (read from the preview iframe URL); absent when unknown. */
+    storyId?: string;
+    contractVersion: number;
+    message: string;
+    /** Which Storybook channel event this re-emits. */
+    source: 'storyThrewException' | 'storyErrored';
+};
+/**
+ * Render-state attribute, value `'rendered' | 'contained'`. Set on
+ * `#storybook-root` (falling back to `document.body` when absent) after each
+ * boundary commit, and ALSO carried on the card's own wrapper element when
+ * contained. Cleared on boundary unmount (story switch), so a stale value
+ * never leaks into the next story's mount — verifiers should match it
+ * together with `data-onlook-story-id`.
+ */
+declare const ONLOOK_RENDER_STATE_ATTR = "data-onlook-render-state";
+/** Companion attribute carrying the story id the render state belongs to. */
+declare const ONLOOK_RENDER_STORY_ATTR = "data-onlook-story-id";
+/** Present (empty value) on the "needs setup" card's wrapper element. */
+declare const ONLOOK_CONTAINED_CARD_ATTR = "data-onlook-contained-card";
+type OnlookRenderState = 'rendered' | 'contained';
+
+/** Virtual stories module id as builder-vite declares it (SB_VIRTUAL_FILES). */
+declare const STORYBOOK_VIRTUAL_STORIES_ID = "virtual:/@storybook/builder-vite/storybook-stories.js";
+/** Rollup-resolved form (`getResolvedVirtualModuleId` prepends `\0`). */
+declare const RESOLVED_STORYBOOK_VIRTUAL_STORIES_ID = "\0virtual:/@storybook/builder-vite/storybook-stories.js";
+declare const MODULE_LOAD_CATCH_ALL_PLUGIN_NAME = "onlook-module-load-catch-all";
+/**
+ * The Vite plugin. Registered by `storybookOnlookPlugin()` unless the
+ * `moduleLoadCatchAll` option is `false`.
+ */
+declare function moduleLoadCatchAllPlugin(): Plugin;
+
+declare const tolerantCsfIndexer: Indexer;
 
-export { AUTO_STORIES_FOLDER, type OnlookPluginOptions, storybookOnlookPlugin };
+export { type ContainedModuleMarker, MODULE_LOAD_CATCH_ALL_PLUGIN_NAME, ONLOOK_CONTAINED_CARD_ATTR, ONLOOK_CONTAINED_EVENT, ONLOOK_CONTAINED_MODULES_GLOBAL, ONLOOK_CONTAINED_PROP, ONLOOK_CONTAINMENT_CONTRACT_GLOBAL, ONLOOK_CONTAINMENT_CONTRACT_VERSION, ONLOOK_RENDERED_EVENT, ONLOOK_RENDER_STATE_ATTR, ONLOOK_RENDER_STORY_ATTR, ONLOOK_UNCONTAINED_ERROR_EVENT, type OnlookContainedPayload, type OnlookContainmentContract, type OnlookRenderState, type OnlookRenderedPayload, type OnlookUncontainedErrorPayload, RESOLVED_STORYBOOK_VIRTUAL_STORIES_ID, STORYBOOK_VIRTUAL_STORIES_ID, moduleLoadCatchAllPlugin, tolerantCsfIndexer };