@dfosco/storyboard-react 4.0.0-beta.3 → 4.0.0-beta.31

package/src/canvas/widgets/embedInteraction.test.jsx

@@ -0,0 +1,235 @@
+/**
+ * Tests for embed interaction UX (click-to-interact overlay).
+ */
+import { describe, it, expect, vi } from 'vitest'
+import { render, fireEvent, screen } from '@testing-library/react'
+import PrototypeEmbed from './PrototypeEmbed.jsx'
+import FigmaEmbed from './FigmaEmbed.jsx'
+import ComponentWidget from './ComponentWidget.jsx'
+import StoryWidget from './StoryWidget.jsx'
+
+// Mock buildPrototypeIndex for PrototypeEmbed
+vi.mock('@dfosco/storyboard-core', () => ({
+  buildPrototypeIndex: () => ({
+    folders: [],
+    prototypes: [
+      {
+        name: 'Design Overview',
+        dirName: 'examples',
+        isExternal: false,
+        hideFlows: true,
+        flows: [{ route: '/test', name: 'default', meta: { title: 'Design Overview' } }],
+      },
+    ],
+    globalFlows: [],
+    sorted: { title: { prototypes: [], folders: [] } },
+  }),
+  getStoryData: (storyId) => ({ _route: `/components/${storyId}` }),
+}))
+
+// Simple mock wrapper for WidgetWrapper
+vi.mock('./WidgetWrapper.jsx', () => ({
+  default: ({ children }) => <div data-testid="widget-wrapper">{children}</div>,
+}))
+
+vi.mock('@dfosco/storyboard-core/inspector/highlighter', () => ({
+  createInspectorHighlighter: async () => ({
+    codeToHtml: () => '<pre><code></code></pre>',
+  }),
+}))
+
+// Mock ResizeHandle
+vi.mock('./ResizeHandle.jsx', () => ({
+  default: () => <div data-testid="resize-handle" />,
+}))
+
+// Mock ComponentErrorBoundary
+vi.mock('../ComponentErrorBoundary.jsx', () => ({
+  default: ({ children }) => <div data-testid="error-boundary">{children}</div>,
+}))
+
+describe('Embed interaction overlay', () => {
+  describe('PrototypeEmbed', () => {
+    const defaultProps = {
+      props: { src: '/test', width: 400, height: 300, zoom: 100 },
+      onUpdate: vi.fn(),
+      resizable: false,
+    }
+
+    it('renders "Click to open" hint when no snapshot exists', () => {
+      render(<PrototypeEmbed {...defaultProps} />)
+      
+      const hint = screen.getByText('Click to open')
+      expect(hint).toBeInTheDocument()
+      // CSS modules mangle class names, just check the element exists
+    })
+
+    it('enters interactive mode on single click (not double-click)', async () => {
+      const { container } = render(<PrototypeEmbed {...defaultProps} />)
+      
+      // Overlay should exist before interaction
+      const overlay = screen.getByRole('button', { name: /click to open/i })
+      expect(overlay).toBeInTheDocument()
+      expect(container.querySelector('iframe')).not.toBeInTheDocument()
+      expect(screen.getByText('Design Overview')).toBeInTheDocument()
+      
+      // Single click should remove the overlay (enter interactive mode)
+      fireEvent.click(overlay)
+      
+      // Overlay should no longer exist
+      expect(screen.queryByRole('button', { name: /click to open/i })).not.toBeInTheDocument()
+      expect(container.querySelector('iframe')).toBeInTheDocument()
+
+      fireEvent.pointerDown(document.body)
+      expect(screen.getByRole('button', { name: /click to open/i })).toBeInTheDocument()
+      expect(container.querySelector('iframe')).not.toBeInTheDocument()
+    })
+
+    it('does not enter interactive mode on shift+click (preserves multi-select)', () => {
+      render(<PrototypeEmbed {...defaultProps} />)
+      
+      const overlay = screen.getByRole('button', { name: /click to open/i })
+      fireEvent.click(overlay, { shiftKey: true })
+      
+      // Overlay should still exist (did not enter interactive mode)
+      expect(screen.getByRole('button', { name: /click to open/i })).toBeInTheDocument()
+    })
+
+    it('does not enter interactive mode on meta+click (preserves multi-select)', () => {
+      render(<PrototypeEmbed {...defaultProps} />)
+      
+      const overlay = screen.getByRole('button', { name: /click to open/i })
+      fireEvent.click(overlay, { metaKey: true })
+      
+      expect(screen.getByRole('button', { name: /click to open/i })).toBeInTheDocument()
+    })
+
+    it('supports keyboard interaction (Enter key) with event prevention', () => {
+      render(<PrototypeEmbed {...defaultProps} />)
+      
+      const overlay = screen.getByRole('button', { name: /click to open/i })
+      const event = { key: 'Enter', preventDefault: vi.fn(), stopPropagation: vi.fn() }
+      fireEvent.keyDown(overlay, event)
+      
+      expect(screen.queryByRole('button', { name: /click to open/i })).not.toBeInTheDocument()
+    })
+
+    it('supports keyboard interaction (Space key) with event prevention', () => {
+      render(<PrototypeEmbed {...defaultProps} />)
+      
+      const overlay = screen.getByRole('button', { name: /click to open/i })
+      const event = { key: ' ', preventDefault: vi.fn(), stopPropagation: vi.fn() }
+      fireEvent.keyDown(overlay, event)
+      
+      expect(screen.queryByRole('button', { name: /click to open/i })).not.toBeInTheDocument()
+    })
+  })
+
+  describe('FigmaEmbed', () => {
+    const defaultProps = {
+      props: { url: 'https://www.figma.com/design/abc123/Test', width: 400, height: 300 },
+      onUpdate: vi.fn(),
+      resizable: false,
+    }
+
+    it('renders "Click to interact" hint', () => {
+      render(<FigmaEmbed {...defaultProps} />)
+      
+      const hint = screen.getByText('Click to interact')
+      expect(hint).toBeInTheDocument()
+    })
+
+    it('enters interactive mode on single click', () => {
+      const { container } = render(<FigmaEmbed {...defaultProps} />)
+      
+      const overlay = screen.getByRole('button', { name: /click to interact/i })
+      expect(container.querySelector('iframe')).not.toBeInTheDocument()
+      fireEvent.click(overlay)
+      
+      expect(screen.queryByRole('button', { name: /click to interact/i })).not.toBeInTheDocument()
+      expect(container.querySelector('iframe')).toBeInTheDocument()
+
+      fireEvent.pointerDown(document.body)
+      expect(screen.getByRole('button', { name: /click to interact/i })).toBeInTheDocument()
+      expect(container.querySelector('iframe')).not.toBeInTheDocument()
+    })
+  })
+
+  describe('StoryWidget', () => {
+    const defaultProps = {
+      props: { storyId: 'button-patterns', exportName: 'Primary', width: 400, height: 300 },
+      onUpdate: vi.fn(),
+      resizable: false,
+    }
+
+    it('mounts iframe only after user activation', () => {
+      const { container } = render(<StoryWidget {...defaultProps} />)
+
+      const overlay = screen.getByRole('button', { name: /click to open story component/i })
+      expect(container.querySelector('iframe')).not.toBeInTheDocument()
+
+      fireEvent.click(overlay)
+
+      expect(screen.queryByRole('button', { name: /click to open story component/i })).not.toBeInTheDocument()
+      expect(container.querySelector('iframe')).toBeInTheDocument()
+
+      fireEvent.pointerDown(document.body)
+      expect(screen.getByRole('button', { name: /click to open story component/i })).toBeInTheDocument()
+      expect(container.querySelector('iframe')).not.toBeInTheDocument()
+    })
+  })
+
+  describe('ComponentWidget', () => {
+    const MockComponent = () => <div>Mock Component</div>
+    
+    const defaultProps = {
+      component: MockComponent,
+      jsxModule: null,
+      exportName: 'MockComponent',
+      canvasTheme: 'light',
+      isLocalDev: false,
+      width: 200,
+      height: 150,
+      onUpdate: vi.fn(),
+      resizable: false,
+    }
+
+    it('renders "Click to interact" hint', () => {
+      render(<ComponentWidget {...defaultProps} />)
+      
+      const hint = screen.getByText('Click to interact')
+      expect(hint).toBeInTheDocument()
+    })
+
+    it('enters interactive mode on single click', () => {
+      render(<ComponentWidget {...defaultProps} />)
+      
+      const overlay = screen.getByRole('button', { name: /click to interact/i })
+      fireEvent.click(overlay)
+      
+      expect(screen.queryByRole('button', { name: /click to interact/i })).not.toBeInTheDocument()
+    })
+
+    it('mounts dev iframe only after user activation', () => {
+      const { container } = render(
+        <ComponentWidget
+          {...defaultProps}
+          isLocalDev
+          jsxModule="/src/canvas/mock.canvas.jsx"
+          exportName="MockComponent"
+        />
+      )
+
+      const overlay = screen.getByRole('button', { name: /click to interact with component/i })
+      expect(container.querySelector('iframe')).not.toBeInTheDocument()
+
+      fireEvent.click(overlay)
+
+      expect(container.querySelector('iframe')).toBeInTheDocument()
+
+      fireEvent.pointerDown(document.body)
+      expect(screen.getByRole('button', { name: /click to interact with component/i })).toBeInTheDocument()
+      expect(container.querySelector('iframe')).not.toBeInTheDocument()
+    })
+  })
+})

package/src/canvas/widgets/embedOverlay.module.css

@@ -0,0 +1,35 @@
+/**
+ * Shared styles for embed interaction overlays.
+ * Used by PrototypeEmbed, FigmaEmbed, and ComponentWidget.
+ */
+
+.interactOverlay {
+  position: absolute;
+  inset: 0;
+  z-index: 1;
+  cursor: pointer;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  transition: background-color 150ms ease;
+}
+
+.interactOverlay:hover {
+  background-color: rgba(0, 0, 0, 0.15);
+}
+
+.interactHint {
+  opacity: 0;
+  color: var(--fgColor-onInverse);
+  background-color: var(--bgColor-inverse);
+  padding: var(--base-size-12) var(--base-size-16);
+  border-radius: var(--base-size-6);
+  font-size: 14px;
+  font-weight: 600;
+  pointer-events: none;
+  transition: opacity 150ms ease;
+}
+
+.interactOverlay:hover .interactHint {
+  opacity: 1;
+}

package/src/canvas/widgets/embedTheme.js

@@ -1,3 +1,59 @@
+/**
+ * Resolve the effective canvas theme from localStorage + sync settings.
+ * Respects the canvas-specific theme sync toggle.
+ */
+export function resolveCanvasTheme() {
+  if (typeof localStorage === 'undefined') return 'light'
+  let sync = { prototype: true, toolbar: false, codeBoxes: true, canvas: true }
+  try {
+    const rawSync = localStorage.getItem('sb-theme-sync')
+    if (rawSync) sync = { ...sync, ...JSON.parse(rawSync) }
+  } catch { /* ignore */ }
+  if (!sync.canvas) return 'light'
+  const attrTheme = document.documentElement.getAttribute('data-sb-canvas-theme')
+  if (attrTheme) return attrTheme
+  const stored = localStorage.getItem('sb-color-scheme') || 'system'
+  if (stored !== 'system') return stored
+  return typeof window.matchMedia === 'function' &&
+    window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'
+}
+
+/**
+ * Subscribe to canvas theme changes for embed widget snapshot switching.
+ *
+ * Reads `data-sb-canvas-theme` from the nearest ancestor set by CanvasPage.
+ * With canvas sync ON (the default), this attribute follows the global theme.
+ * Uses MutationObserver for immediate reaction + event backup.
+ */
+export function subscribeCanvasTheme({ anchorRef, onTheme }) {
+  if (typeof onTheme !== 'function') return () => {}
+
+  let observed = null
+  let observer = null
+
+  function readAndEmit() {
+    const el = anchorRef?.current?.closest?.('[data-sb-canvas-theme]') || null
+    if (el !== observed) {
+      if (observer) observer.disconnect()
+      observer = null
+      observed = el
+      if (el && typeof MutationObserver !== 'undefined') {
+        observer = new MutationObserver(readAndEmit)
+        observer.observe(el, { attributes: true, attributeFilter: ['data-sb-canvas-theme'] })
+      }
+    }
+    onTheme(el?.getAttribute('data-sb-canvas-theme') || 'light')
+  }
+
+  readAndEmit()
+  document.addEventListener('storyboard:theme:changed', readAndEmit)
+
+  return () => {
+    document.removeEventListener('storyboard:theme:changed', readAndEmit)
+    if (observer) observer.disconnect()
+  }
+}
+
 export function getEmbedChromeVars(theme) {
   const value = String(theme || 'light')
   if (value === 'dark_dimmed') {

package/src/canvas/widgets/githubUrl.js

@@ -0,0 +1,82 @@
+const GH_HOST_RE = /^(www\.)?github\.com$/i
+const ISSUE_PATH_RE = /^\/([^/]+)\/([^/]+)\/issues\/(\d+)\/?$/
+const DISCUSSION_PATH_RE = /^\/([^/]+)\/([^/]+)\/discussions\/(\d+)\/?$/
+const PULL_REQUEST_PATH_RE = /^\/([^/]+)\/([^/]+)\/pull\/(\d+)\/?$/
+const ISSUE_COMMENT_HASH_RE = /^#issuecomment-(\d+)$/i
+const DISCUSSION_COMMENT_HASH_RE = /^#discussioncomment-(\d+)$/i
+
+function toNumber(raw) {
+  const value = Number.parseInt(raw, 10)
+  return Number.isFinite(value) ? value : null
+}
+
+/**
+ * Parse supported GitHub embed URLs (issues, discussions, comments).
+ * @param {string} rawUrl
+ * @returns {null | {
+ *   kind: 'issue' | 'discussion' | 'comment',
+ *   parentKind: 'issue' | 'discussion',
+ *   owner: string,
+ *   repo: string,
+ *   number: number,
+ *   commentId?: number
+ * }}
+ */
+export function parseGitHubUrl(rawUrl) {
+  try {
+    const parsed = new URL(rawUrl)
+    if (!GH_HOST_RE.test(parsed.hostname)) return null
+
+    const issueMatch = parsed.pathname.match(ISSUE_PATH_RE)
+    if (issueMatch) {
+      const [, owner, repo, numberRaw] = issueMatch
+      const number = toNumber(numberRaw)
+      if (!number) return null
+
+      const commentMatch = parsed.hash.match(ISSUE_COMMENT_HASH_RE)
+      if (commentMatch) {
+        const commentId = toNumber(commentMatch[1])
+        if (!commentId) return null
+        return { kind: 'comment', parentKind: 'issue', owner, repo, number, commentId }
+      }
+
+      if (parsed.hash) return null
+      return { kind: 'issue', parentKind: 'issue', owner, repo, number }
+    }
+
+    const discussionMatch = parsed.pathname.match(DISCUSSION_PATH_RE)
+    if (discussionMatch) {
+      const [, owner, repo, numberRaw] = discussionMatch
+      const number = toNumber(numberRaw)
+      if (!number) return null
+
+      const commentMatch = parsed.hash.match(DISCUSSION_COMMENT_HASH_RE)
+      if (commentMatch) {
+        const commentId = toNumber(commentMatch[1])
+        if (!commentId) return null
+        return { kind: 'comment', parentKind: 'discussion', owner, repo, number, commentId }
+      }
+
+      if (parsed.hash) return null
+      return { kind: 'discussion', parentKind: 'discussion', owner, repo, number }
+    }
+
+    const prMatch = parsed.pathname.match(PULL_REQUEST_PATH_RE)
+    if (prMatch) {
+      const [, owner, repo, numberRaw] = prMatch
+      const number = toNumber(numberRaw)
+      if (!number) return null
+
+      if (parsed.hash) return null
+      return { kind: 'pull_request', parentKind: 'pull_request', owner, repo, number }
+    }
+  } catch {
+    return null
+  }
+
+  return null
+}
+
+export function isGitHubEmbedUrl(rawUrl) {
+  return parseGitHubUrl(rawUrl) !== null
+}

package/src/canvas/widgets/githubUrl.test.js

@@ -0,0 +1,74 @@
+import { describe, expect, it } from 'vitest'
+import { isGitHubEmbedUrl, parseGitHubUrl } from './githubUrl.js'
+
+describe('parseGitHubUrl', () => {
+  it('classifies issue URLs', () => {
+    expect(parseGitHubUrl('https://github.com/dfosco/storyboard/issues/12')).toEqual({
+      kind: 'issue',
+      parentKind: 'issue',
+      owner: 'dfosco',
+      repo: 'storyboard',
+      number: 12,
+    })
+  })
+
+  it('classifies discussion URLs', () => {
+    expect(parseGitHubUrl('https://github.com/dfosco/storyboard/discussions/99')).toEqual({
+      kind: 'discussion',
+      parentKind: 'discussion',
+      owner: 'dfosco',
+      repo: 'storyboard',
+      number: 99,
+    })
+  })
+
+  it('classifies issue comment URLs', () => {
+    expect(parseGitHubUrl('https://github.com/dfosco/storyboard/issues/12#issuecomment-345')).toEqual({
+      kind: 'comment',
+      parentKind: 'issue',
+      owner: 'dfosco',
+      repo: 'storyboard',
+      number: 12,
+      commentId: 345,
+    })
+  })
+
+  it('classifies discussion comment URLs', () => {
+    expect(parseGitHubUrl('https://github.com/dfosco/storyboard/discussions/99#discussioncomment-888')).toEqual({
+      kind: 'comment',
+      parentKind: 'discussion',
+      owner: 'dfosco',
+      repo: 'storyboard',
+      number: 99,
+      commentId: 888,
+    })
+  })
+
+  it('classifies pull request URLs', () => {
+    expect(parseGitHubUrl('https://github.com/dfosco/storyboard/pull/12')).toEqual({
+      kind: 'pull_request',
+      parentKind: 'pull_request',
+      owner: 'dfosco',
+      repo: 'storyboard',
+      number: 12,
+    })
+  })
+
+  it('rejects unsupported paths and hashes', () => {
+    expect(parseGitHubUrl('https://github.com/dfosco/storyboard/issues/12#random')).toBeNull()
+    expect(parseGitHubUrl('https://example.com/dfosco/storyboard/issues/12')).toBeNull()
+    expect(parseGitHubUrl('not a url')).toBeNull()
+  })
+})
+
+describe('isGitHubEmbedUrl', () => {
+  it('returns true for supported GitHub URLs', () => {
+    expect(isGitHubEmbedUrl('https://github.com/dfosco/storyboard/issues/12')).toBe(true)
+    expect(isGitHubEmbedUrl('https://github.com/dfosco/storyboard/discussions/99#discussioncomment-888')).toBe(true)
+    expect(isGitHubEmbedUrl('https://github.com/dfosco/storyboard/pull/1')).toBe(true)
+  })
+
+  it('returns false for unsupported URLs', () => {
+    expect(isGitHubEmbedUrl('https://example.com')).toBe(false)
+  })
+})

package/src/canvas/widgets/iframeDevLogs.js

@@ -0,0 +1,49 @@
+import { useEffect, useRef } from 'react'
+
+let loadedIframeCount = 0
+
+function isDevRuntime() {
+  return typeof window !== 'undefined' && window.__SB_LOCAL_DEV__ === true
+}
+
+function toText(value) {
+  return value ? String(value) : '(no src)'
+}
+
+function logIframeEvent(event, count, meta) {
+  console.log(`[storyboard][iframe] ${event} | count=${count} | ${meta.widget}`, {
+    event,
+    count,
+    widget: meta.widget,
+    src: toText(meta.src),
+  })
+}
+
+/**
+ * Dev-only iframe load/unload logging with a live count of mounted iframes.
+ */
+export function useIframeDevLogs({ widget, loaded, src }) {
+  const metaRef = useRef({ widget, src })
+
+  useEffect(() => {
+    metaRef.current = { widget, src }
+  }, [widget, src])
+
+  useEffect(() => {
+    if (!loaded) return
+
+    loadedIframeCount += 1
+    if (isDevRuntime()) {
+      const meta = metaRef.current
+      logIframeEvent('loaded', loadedIframeCount, meta)
+    }
+
+    return () => {
+      loadedIframeCount = Math.max(0, loadedIframeCount - 1)
+      if (isDevRuntime()) {
+        const meta = metaRef.current
+        logIframeEvent('unloaded', loadedIframeCount, meta)
+      }
+    }
+  }, [loaded])
+}

package/src/canvas/widgets/iframeDevLogs.test.jsx

@@ -0,0 +1,81 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+import { render } from '@testing-library/react'
+import { useIframeDevLogs } from './iframeDevLogs.js'
+
+function Probe({ widget = 'Probe', loaded = false, src = '/test' }) {
+  useIframeDevLogs({ widget, loaded, src })
+  return null
+}
+
+describe('useIframeDevLogs', () => {
+  let logSpy
+
+  beforeEach(() => {
+    window.__SB_LOCAL_DEV__ = true
+    logSpy = vi.spyOn(console, 'log').mockImplementation(() => {})
+  })
+
+  afterEach(() => {
+    logSpy.mockRestore()
+    delete window.__SB_LOCAL_DEV__
+  })
+
+  it('logs iframe load and unload with tally', () => {
+    const { rerender, unmount } = render(<Probe loaded={false} src="/alpha" />)
+    rerender(<Probe loaded src="/alpha" />)
+    rerender(<Probe loaded={false} src="/alpha" />)
+
+    expect(logSpy).toHaveBeenNthCalledWith(
+      1,
+      '[storyboard][iframe] loaded | count=1 | Probe',
+      { event: 'loaded', count: 1, widget: 'Probe', src: '/alpha' },
+    )
+    expect(logSpy).toHaveBeenNthCalledWith(
+      2,
+      '[storyboard][iframe] unloaded | count=0 | Probe',
+      { event: 'unloaded', count: 0, widget: 'Probe', src: '/alpha' },
+    )
+
+    unmount()
+  })
+
+  it('tracks tally across multiple loaded iframes', () => {
+    const first = render(<Probe widget="PrototypeEmbed" loaded src="/proto" />)
+    const second = render(<Probe widget="FigmaEmbed" loaded src="/figma" />)
+
+    expect(logSpy).toHaveBeenNthCalledWith(
+      1,
+      '[storyboard][iframe] loaded | count=1 | PrototypeEmbed',
+      { event: 'loaded', count: 1, widget: 'PrototypeEmbed', src: '/proto' },
+    )
+    expect(logSpy).toHaveBeenNthCalledWith(
+      2,
+      '[storyboard][iframe] loaded | count=2 | FigmaEmbed',
+      { event: 'loaded', count: 2, widget: 'FigmaEmbed', src: '/figma' },
+    )
+
+    first.unmount()
+    expect(logSpy).toHaveBeenNthCalledWith(
+      3,
+      '[storyboard][iframe] unloaded | count=1 | PrototypeEmbed',
+      { event: 'unloaded', count: 1, widget: 'PrototypeEmbed', src: '/proto' },
+    )
+
+    second.unmount()
+    expect(logSpy).toHaveBeenNthCalledWith(
+      4,
+      '[storyboard][iframe] unloaded | count=0 | FigmaEmbed',
+      { event: 'unloaded', count: 0, widget: 'FigmaEmbed', src: '/figma' },
+    )
+  })
+
+  it('does not log outside local dev runtime', () => {
+    window.__SB_LOCAL_DEV__ = false
+    const { rerender, unmount } = render(<Probe loaded={false} src="/off" />)
+    rerender(<Probe loaded src="/off" />)
+    rerender(<Probe loaded={false} src="/off" />)
+
+    expect(logSpy).not.toHaveBeenCalled()
+    unmount()
+  })
+})

package/src/canvas/widgets/index.js

@@ -4,6 +4,8 @@ import PrototypeEmbed from './PrototypeEmbed.jsx'
 import LinkPreview from './LinkPreview.jsx'
 import ImageWidget from './ImageWidget.jsx'
 import FigmaEmbed from './FigmaEmbed.jsx'
+import CodePenEmbed from './CodePenEmbed.jsx'
+import StoryWidget from './StoryWidget.jsx'
 
 /**
  * Maps widget type strings to their React components.
@@ -16,6 +18,8 @@ export const widgetRegistry = {
   'link-preview': LinkPreview,
   'image': ImageWidget,
   'figma-embed': FigmaEmbed,
+  'codepen-embed': CodePenEmbed,
+  'story': StoryWidget,
 }
 
 /**