egaki 0.6.0 → 0.7.0

package/src/vite/vite-plugin.ts

@@ -0,0 +1,584 @@
+/**
+ * Vite plugin for the video framework.
+ *
+ * Discovers MDX files in the project root and serves each as a page route.
+ * The default entry (video.mdx or index.mdx) is served at /; others at
+ * /<relative-path-without-extension>. Auto-injects spiceflow + react plugins.
+ *
+ * Usage in vite.config.ts:
+ *   import { video } from 'egaki/vite'
+ *   export default defineConfig({ plugins: [video()] })
+ *   // or with explicit default entry:
+ *   export default defineConfig({ plugins: [video({ entry: './video.mdx' })] })
+ */
+
+import path from 'node:path'
+import fs from 'node:fs'
+import { createRequire } from 'node:module'
+import { fileURLToPath } from 'node:url'
+import type { Plugin, PluginOption } from 'vite'
+import { spiceflowPlugin } from 'spiceflow/vite'
+import react from '@vitejs/plugin-react'
+import tailwindcss from '@tailwindcss/vite'
+import { mdxParse } from 'safe-mdx/parse'
+import { collectServerImportSources } from './server-mdx.ts'
+import { parseFrontmatter } from './mdx-parse.ts'
+
+// Resolve the package src/ directory from this file's location.
+// Used for resolve.alias so the RSC module runner can resolve relative
+// imports from app.tsx (same pattern as egaki/vite).
+const __srcDir = fileURLToPath(new URL('.', import.meta.url))
+const APP_SRC_PATH = path.join(__srcDir, 'app.tsx')
+
+const VIRTUAL_APP = 'virtual:egaki-app'
+const RESOLVED_APP = '\0' + VIRTUAL_APP
+
+const VIRTUAL_MDX = 'virtual:egaki-mdx'
+const RESOLVED_MDX = '\0' + VIRTUAL_MDX
+
+const VIRTUAL_MODULES = 'virtual:egaki-modules'
+const RESOLVED_MODULES = '\0' + VIRTUAL_MODULES
+
+
+
+const PKG_NAME = 'egaki'
+
+export interface VideoPluginOptions {
+  /** Path to the default MDX entry file (relative to vite root or absolute).
+   *  When omitted, auto-discovers: video.mdx > index.mdx > first .mdx found.
+   *  All other .mdx files in the project become additional routes. */
+  entry?: string
+}
+
+/** Resolve a relative MDX import source against the project root,
+ *  probing common extensions. Returns the absolute path or undefined. */
+function resolveSourceToFile(root: string, source: string): string | undefined {
+  const base = path.resolve(root, source)
+  for (const ext of ['', '.tsx', '.ts', '.jsx', '.js', '.mdx', '.md']) {
+    const candidate = base + ext
+    if (fs.existsSync(candidate) && fs.statSync(candidate).isFile()) {
+      return candidate.replace(/\\/g, '/')
+    }
+  }
+  return undefined
+}
+
+/**
+ * Extract raw source text ranges per section directly from the mdast.
+ * Works with heading nodes' positions to capture the FULL raw heading
+ * text including props like `duration=3s` and `transition=20` that
+ * `splitIntoSections` strips during parsing. Each section spans from
+ * its heading's start offset to the next heading's start (or EOF).
+ */
+function sectionRawTexts(source: string, mdast: any): string[] {
+  // Collect the start offsets of each heading node
+  const headingStarts: number[] = []
+  for (const node of mdast.children) {
+    if (node.type === 'heading' && node.position?.start?.offset != null) {
+      headingStarts.push(node.position.start.offset)
+    }
+  }
+  // Slice source between consecutive headings, trimming trailing whitespace
+  // so boundary changes (adding/removing a following section) don't cause
+  // false positives on the preceding section.
+  return headingStarts.map((start, i) => {
+    const end = i + 1 < headingStarts.length ? headingStarts[i + 1]! : source.length
+    return source.slice(start, end).trimEnd()
+  })
+}
+
+/**
+ * Compare old and new MDX sources section-by-section. Returns the index
+ * of the first added or edited section, or null if nothing changed (or
+ * only deletions occurred, which we skip per design).
+ */
+export function findChangedSectionIndex(oldSource: string, newSource: string): number | null {
+  try {
+    const oldTexts = sectionRawTexts(oldSource, mdxParse(oldSource))
+    const newTexts = sectionRawTexts(newSource, mdxParse(newSource))
+
+    const maxLen = Math.max(oldTexts.length, newTexts.length)
+    for (let i = 0; i < maxLen; i++) {
+      if (i >= oldTexts.length) return i // new section added
+      if (i >= newTexts.length) return null // section deleted, skip
+      if (oldTexts[i] !== newTexts[i]) {
+        // Distinguish edit from deletion: if the next old section matches
+        // the current new section, a section was deleted (shifted down).
+        // Look ahead to detect deletions at any position, not just the tail.
+        if (newTexts.length < oldTexts.length && oldTexts[i + 1] === newTexts[i]) {
+          return null // deletion, skip
+        }
+        return i // content changed
+      }
+    }
+    return null // no scene-level change (frontmatter/preamble only)
+  } catch {
+    return null // parse error, don't seek
+  }
+}
+
+/** Discover .mdx files in the project root directory (non-recursive).
+ *  Only root-level files become entries to avoid import resolution issues
+ *  with nested paths. Returns a map of routePath → absolutePath. */
+function discoverMdxEntries(root: string): Map<string, string> {
+  const entries = new Map<string, string>()
+  if (!fs.existsSync(root)) return entries
+  for (const entry of fs.readdirSync(root, { withFileTypes: true })) {
+    if (entry.isDirectory()) continue
+    if (!/\.mdx$/.test(entry.name)) continue
+    const fullPath = path.join(root, entry.name)
+    const routePath = entry.name.replace(/\.mdx$/, '')
+    entries.set(routePath, fullPath.replace(/\\/g, '/'))
+  }
+  return entries
+}
+
+/** Pick the default entry route from discovered entries.
+ *  Priority: explicit option > video.mdx > index.mdx > first alphabetically. */
+function resolveDefaultRoute(entries: Map<string, string>, explicitEntry?: string, root?: string): string {
+  if (explicitEntry && root) {
+    const absEntry = path.isAbsolute(explicitEntry)
+      ? explicitEntry.replace(/\\/g, '/')
+      : path.resolve(root, explicitEntry).replace(/\\/g, '/')
+    for (const [route, absPath] of entries) {
+      if (absPath === absEntry) return route
+    }
+  }
+  if (entries.has('video')) return 'video'
+  if (entries.has('index')) return 'index'
+  // First alphabetically
+  const sorted = [...entries.keys()].sort()
+  return sorted[0] ?? 'video'
+}
+
+export function video(options?: VideoPluginOptions): PluginOption[] {
+  let root: string
+  /** All discovered MDX entry files: routePath → absolutePath */
+  let mdxEntries: Map<string, string> = new Map()
+  /** Route path of the default entry (served at /) */
+  let defaultRoute: string = ''
+  /** Whether the user's project has `motion` (framer-motion) installed. */
+  let hasMotion = false
+  /** Cached previous MDX sources for section-level diff detection, keyed by abs path. */
+  const previousMdxSources: Map<string, string> = new Map()
+  /** Set of absolute paths of all entry MDX files for quick lookup. */
+  let entryPathSet: Set<string> = new Set()
+
+  /** Is this file referenced inside a <Server> block of any entry MDX?
+   *  Parsed on demand (no cache — file changes are rare and parsing is
+   *  milliseconds). Used to decide which edits need an rsc:update. */
+  const isServerImportedFile = (file: string): boolean => {
+    try {
+      for (const absPath of entryPathSet) {
+        const sources = collectServerImportSources(mdxParse(fs.readFileSync(absPath, 'utf-8')))
+        if (sources.some((source) => resolveSourceToFile(root, source) === file)) return true
+      }
+      return false
+    } catch {
+      return false
+    }
+  }
+
+  const videoPlugin: Plugin = {
+    name: 'egaki:core',
+
+    configResolved(config) {
+      root = config.root
+
+      // Discover all MDX entries in the project root.
+      mdxEntries = discoverMdxEntries(root)
+
+      // If explicit entry is provided but not found, create a minimal entry
+      // in the map (will error below if file doesn't exist).
+      if (options?.entry) {
+        const absEntry = (path.isAbsolute(options.entry)
+          ? options.entry
+          : path.resolve(root, options.entry)).replace(/\\/g, '/')
+        if (!fs.existsSync(absEntry)) {
+          throw new Error(
+            `[egaki] entry file not found: ${absEntry}\n` +
+            `Set entry to a path relative to the vite root.`,
+          )
+        }
+        // Ensure explicit entry is in the map
+        const relPath = path.relative(root, absEntry).replace(/\\/g, '/')
+        const routePath = relPath.replace(/\.mdx$/, '')
+        mdxEntries.set(routePath, absEntry)
+      }
+
+      if (mdxEntries.size === 0) {
+        throw new Error(
+          `[egaki] no .mdx files found in ${root}\n` +
+          `Create a video.mdx file or set entry explicitly.`,
+        )
+      }
+
+      defaultRoute = resolveDefaultRoute(mdxEntries, options?.entry, root)
+      entryPathSet = new Set(mdxEntries.values())
+
+      // Seed previous sources for section-level diff detection.
+      for (const [, absPath] of mdxEntries) {
+        try {
+          previousMdxSources.set(absPath, fs.readFileSync(absPath, 'utf-8'))
+        } catch { /* ignore read errors */ }
+      }
+
+      // Auto-generate egaki-env.d.ts so MDX LSP knows about built-in
+      // components via the global MDXProvidedComponents type. Same
+      // pattern Vite uses for vite-env.d.ts.
+      const envDtsPath = path.join(root, 'egaki-env.d.ts')
+      const envDtsContent = 'import \'egaki/mdx-components\'\n'
+      try {
+        const existing = fs.existsSync(envDtsPath) ? fs.readFileSync(envDtsPath, 'utf-8') : ''
+        if (existing !== envDtsContent) {
+          fs.writeFileSync(envDtsPath, envDtsContent)
+        }
+      } catch {
+        // Non-fatal: LSP autocomplete just won't work
+      }
+
+      // Detect if the user has `motion` (framer-motion) installed.
+      // When present, we inject timing patches so motion.div animations
+      // sync with Remotion's frame-based rendering.
+      try {
+        createRequire(root + '/').resolve('motion-dom')
+        hasMotion = true
+      } catch {
+        hasMotion = false
+      }
+    },
+
+    resolveId(id) {
+      if (id === VIRTUAL_APP) return RESOLVED_APP
+      if (id === VIRTUAL_MDX) return RESOLVED_MDX
+      if (id === VIRTUAL_MODULES) return RESOLVED_MODULES
+    },
+
+    load(id) {
+      if (id === RESOLVED_MDX) {
+        // Import all entry MDX files as raw strings (?raw for HMR tracking).
+        // Export an entries map so app.tsx can serve each at its route.
+        const defaultAbsPath = mdxEntries.get(defaultRoute)!
+        // Parse frontmatter from the default entry for composition dimensions.
+        let fm: ReturnType<typeof parseFrontmatter>
+        try {
+          const mdxContent = fs.readFileSync(defaultAbsPath, 'utf-8')
+          fm = parseFrontmatter(mdxParse(mdxContent))
+        } catch (e) {
+          console.error('[egaki] frontmatter parse error:', e)
+          fm = { fps: 30, bpm: 120, width: 1920, height: 1080, scale: 1 }
+        }
+        const folderName = path.basename(root)
+
+        const imports: string[] = []
+        const entriesObj: string[] = []
+        const pathsObj: string[] = []
+        let i = 0
+        for (const [routePath, absPath] of mdxEntries) {
+          const varName = `__entry${i++}`
+          imports.push(`import ${varName} from ${JSON.stringify(absPath + '?raw')}`)
+          entriesObj.push(`  ${JSON.stringify(routePath)}: ${varName}`)
+          pathsObj.push(`  ${JSON.stringify(routePath)}: ${JSON.stringify(absPath)}`)
+        }
+
+        return [
+          ...imports,
+          `export const entries = {`,
+          entriesObj.join(',\n'),
+          `}`,
+          `export const entryPaths = {`,
+          pathsObj.join(',\n'),
+          `}`,
+          `export const defaultRoute = ${JSON.stringify(defaultRoute)}`,
+          `export const projectRoot = ${JSON.stringify(root.replace(/\\/g, '/'))}`,
+          `export const compositionWidth = ${fm.width}`,
+          `export const compositionHeight = ${fm.height}`,
+          `export const folderName = ${JSON.stringify(folderName)}`,
+          // Backward compat: default export is the default entry source
+          `export default entries[${JSON.stringify(defaultRoute)}]`,
+          `export const entryPath = entryPaths[${JSON.stringify(defaultRoute)}]`,
+        ].join('\n')
+      }
+
+      if (id === RESOLVED_MODULES) {
+        // Build an eager module map for all user files in the project
+        // root. Each file is imported statically so modules are available
+        // synchronously — no async resolution, no loading state.
+        //
+        // This map is only imported by the client (and ssr) — the rsc env
+        // resolves <Server> slot modules via dynamic imports in app.tsx.
+        // *.server.{ts,tsx} files are excluded: that postfix is the hard
+        // "never bundle to the browser" guarantee for files with API keys
+        // or node-only imports.
+        const imports: string[] = []
+        const entries: string[] = []
+        let i = 0
+        const walkDir = (dir: string) => {
+          if (!fs.existsSync(dir)) return
+          for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+            if (entry.name === 'node_modules' || entry.name === 'dist' || entry.name === 'e2e' || entry.name === 'test-results' || entry.name.startsWith('.')) continue
+            const fullPath = path.join(dir, entry.name)
+            if (entry.isDirectory()) {
+              walkDir(fullPath)
+            } else if (/\.(tsx?|jsx?|mdx?)$/.test(entry.name) && !/\.(test|spec|config)\./.test(entry.name)) {
+              // Entry MDX files are NOT skipped: they may be imported as
+              // partials by other MDX files (e.g. `import Intro from './intro.mdx'`).
+              // Self-import is a user error and harmless (safe-mdx handles it).
+              if (/\.server\.[jt]sx?$/.test(entry.name)) continue
+              const isMdx = /\.mdx?$/.test(entry.name)
+              const relPath = './' + path.relative(root, fullPath).replace(/\\/g, '/')
+              const absPath = fullPath.replace(/\\/g, '/')
+              const varName = `__mod${i++}`
+              if (isMdx) {
+                // MDX/MD files loaded as raw strings for client rendering
+                imports.push(`import ${varName} from ${JSON.stringify(absPath + '?raw')}`)
+                entries.push(`  ${JSON.stringify(relPath)}: { default: ${varName} }`)
+              } else {
+                imports.push(`import * as ${varName} from ${JSON.stringify(absPath)}`)
+                entries.push(`  ${JSON.stringify(relPath)}: ${varName}`)
+              }
+            }
+          }
+        }
+        walkDir(root)
+
+        // No self-accept here: mdx-client.tsx accepts updates of this
+        // module via import.meta.hot.accept('virtual:egaki-modules', cb).
+        // When a user file changes, HMR propagates through this module to
+        // that boundary, re-executing this module with fresh imports and
+        // handing the new map to the callback. Self-accepting here would
+        // make THIS module the boundary and the importer callback would
+        // never fire.
+        // When motion is installed, import motion-timing.ts as a
+        // side-effect so JSAnimation patches run before any user component.
+        // resolve.dedupe (set in configEnvironment) ensures motion-dom
+        // resolves to the same instance that motion/react uses.
+        const motionTimingPath = path.join(__srcDir, 'motion-timing.ts').replace(/\\/g, '/')
+        const motionImport = hasMotion ? [`import ${JSON.stringify(motionTimingPath)}`] : []
+
+        return [
+          ...motionImport,
+          ...imports,
+          `export const eagerModules = {`,
+          entries.join(',\n'),
+          `}`,
+        ].join('\n')
+      }
+
+      if (id === RESOLVED_APP) {
+        // Spiceflow entry: import the framework's app from its absolute
+        // source path so the RSC module runner resolves relative imports
+        // (./mdx-parse.ts etc.) from the correct filesystem directory.
+        return [
+          `import { app } from ${JSON.stringify(APP_SRC_PATH)}`,
+          `export { app }`,
+        ].join('\n')
+      }
+    },
+
+    // HMR for file changes in the project.
+    //
+    // Entry MDX: the source string flows server → client through the RSC
+    // flight payload, so invalidate the virtual modules in all envs and
+    // send rsc:update to re-fetch the flight.
+    //
+    // User .tsx/.ts/.mdx/.css files: handled in the client module graph
+    // (Fast Refresh for components, dep-accept in mdx-client.tsx for the
+    // rest) AND via rsc:update, because <Server> slots are rendered in the
+    // rsc env from the same files — the flight refetch delivers fresh
+    // slots. On rsc/ssr envs we invalidate the changed modules manually
+    // and return [] to suppress default HMR, which would trigger an SSR
+    // "program reload" → full page reload.
+    //
+    // File create/delete: the generated module list changed and no accept
+    // chain exists for new files, so invalidate everything + full reload.
+    hotUpdate(ctx) {
+      const normalizedFile = ctx.file.replace(/\\/g, '/')
+      const isEntryMdx = entryPathSet.has(normalizedFile)
+      const isImportedMdx = /\.mdx?$/.test(ctx.file)
+        && !isEntryMdx
+        && !ctx.file.includes('node_modules')
+        && ctx.file.startsWith(root)
+      const isUserFile = /\.[jt]sx?$/.test(ctx.file)
+        && !ctx.file.includes('node_modules')
+        && ctx.file.startsWith(root)
+      const isCss = /\.css$/.test(ctx.file)
+        && !ctx.file.includes('node_modules')
+        && ctx.file.startsWith(root)
+
+      if (!isEntryMdx && !isImportedMdx && !isUserFile && !isCss) return
+
+      const invalidateVirtual = (ids: string[]) => {
+        for (const env of Object.values(ctx.server.environments)) {
+          for (const resolvedId of ids) {
+            const mod = env.moduleGraph.getModuleById(resolvedId)
+            if (mod) {
+              env.moduleGraph.invalidateModule(mod)
+            }
+          }
+        }
+      }
+
+      // Create/delete: regenerate module list and entry map, full reload.
+      if (ctx.type !== 'update') {
+        // Re-discover entries in case a new MDX file was added or removed.
+        mdxEntries = discoverMdxEntries(root)
+        if (options?.entry) {
+          const absEntry = (path.isAbsolute(options.entry)
+            ? options.entry
+            : path.resolve(root, options.entry)).replace(/\\/g, '/')
+          const relPath = path.relative(root, absEntry).replace(/\\/g, '/')
+          mdxEntries.set(relPath.replace(/\.mdx$/, ''), absEntry)
+        }
+        defaultRoute = resolveDefaultRoute(mdxEntries, options?.entry, root)
+        const nextEntryPathSet = new Set(mdxEntries.values())
+
+        // Sync previousMdxSources: seed new entries, prune removed ones.
+        for (const file of previousMdxSources.keys()) {
+          if (!nextEntryPathSet.has(file)) previousMdxSources.delete(file)
+        }
+        for (const file of nextEntryPathSet) {
+          if (!previousMdxSources.has(file)) {
+            try { previousMdxSources.set(file, fs.readFileSync(file, 'utf-8')) }
+            catch { /* file may be mid-write */ }
+          }
+        }
+        entryPathSet = nextEntryPathSet
+
+        invalidateVirtual([RESOLVED_APP, RESOLVED_MDX, RESOLVED_MODULES])
+        if (this.environment.name === 'client') {
+          ctx.server.environments.client?.hot.send({ type: 'full-reload' })
+        }
+        return []
+      }
+
+      if (isEntryMdx) {
+        invalidateVirtual([RESOLVED_APP, RESOLVED_MDX])
+
+        if (this.environment.name === 'client') {
+          // Section-level diff detection for the changed entry.
+          const newMdxSource = fs.readFileSync(normalizedFile, 'utf-8')
+          const prevSource = previousMdxSources.get(normalizedFile)
+          const changedSection = prevSource != null
+            ? findChangedSectionIndex(prevSource, newMdxSource)
+            : null
+          previousMdxSources.set(normalizedFile, newMdxSource)
+
+          ctx.server.environments.client?.hot.send({
+            type: 'custom',
+            event: 'rsc:update',
+            data: { file: ctx.file },
+          })
+          if (changedSection != null) {
+            ctx.server.environments.client?.hot.send({
+              type: 'custom',
+              event: 'egaki:scene-changed',
+              data: { sectionIndex: changedSection, file: normalizedFile },
+            })
+          }
+        }
+        return []
+      }
+
+      // User file / imported MDX / CSS updates.
+      // Client env: let default HMR run (Fast Refresh for components,
+      // dep-accept propagation through virtual:egaki-modules for the rest).
+      if (this.environment.name === 'client') {
+        return
+      }
+
+      // rsc/ssr envs: keep graphs fresh for the next render, but suppress
+      // default HMR (would cause a full program reload).
+      invalidateVirtual([RESOLVED_APP, RESOLVED_MODULES])
+      for (const mod of ctx.modules) {
+        this.environment.moduleGraph.invalidateModule(mod)
+      }
+
+      // Edits to files referenced inside <Server> (or *.server.* postfix)
+      // send rsc:update: <Server> slots render in the rsc env, so the
+      // flight must be refetched for fresh slot content. Sent from the
+      // rsc branch AFTER invalidation so the browser's refetch cannot
+      // race a stale rsc module graph. The refetch remounts the client
+      // tree (spiceflow payload swap resets the Player to frame 0), so it
+      // must NOT fire for regular files — those are covered by
+      // client-graph HMR which preserves player state.
+      if (this.environment.name === 'rsc') {
+        const file = ctx.file.replace(/\\/g, '/')
+        if (/\.server\.[jt]sx?$/.test(file) || isServerImportedFile(file)) {
+          ctx.server.environments.client?.hot.send({
+            type: 'custom',
+            event: 'rsc:update',
+            data: { file: ctx.file },
+          })
+        }
+      }
+      return []
+    },
+  }
+
+  // Keep the video package inside the RSC/SSR transform pipeline
+  const rscPackagePlugin: Plugin = {
+    name: 'egaki:rsc-package',
+    configEnvironment(name, config) {
+      // noExternal: keep package in transform pipeline for all environments
+      config.resolve ??= {}
+      const existing = config.resolve.noExternal
+      if (existing === true) return
+      const arr = Array.isArray(existing) ? existing : existing ? [existing] : []
+      arr.push(new RegExp(`^${PKG_NAME}`))
+      arr.push(/^tweakpane/)
+      config.resolve.noExternal = arr
+
+      // Deduplicate motion packages so egaki's motion-timing virtual module
+      // patches the same JSAnimation class that motion/react uses. Without
+      // this, Vite can resolve motion-dom to different instances and
+      // prototype patches won't affect the user's animations.
+      // Always applied (not gated by hasMotion) because configEnvironment
+      // runs before configResolved where hasMotion is set. Harmless when
+      // motion isn't installed — dedupe on missing packages is a no-op.
+      config.resolve.dedupe = mergeUnique(
+        config.resolve.dedupe as string[] | undefined,
+        ['motion', 'motion-dom', 'motion-utils'],
+      )
+
+      if (name === 'client') {
+        config.optimizeDeps ??= {}
+        config.optimizeDeps.exclude = mergeUnique(
+          config.optimizeDeps.exclude,
+          [PKG_NAME],
+        )
+        config.optimizeDeps.include = mergeUnique(
+          config.optimizeDeps.include,
+          [
+            `${PKG_NAME} > spiceflow > @vitejs/plugin-rsc/vendor/react-server-dom/client.browser`,
+            `${PKG_NAME} > remotion`,
+            `${PKG_NAME} > @remotion/player`,
+            `${PKG_NAME} > safe-mdx`,
+          ],
+        )
+      }
+
+      if (name === 'rsc' || name === 'ssr') {
+        config.optimizeDeps ??= {}
+        config.optimizeDeps.exclude = mergeUnique(
+          config.optimizeDeps.exclude,
+          ['spiceflow'],
+        )
+      }
+    },
+  }
+
+  return [
+    videoPlugin,
+    rscPackagePlugin,
+    tailwindcss(),
+    spiceflowPlugin({ entry: VIRTUAL_APP }),
+    react(),
+  ]
+}
+
+function mergeUnique(existing: string[] | undefined, items: string[]): string[] {
+  const set = new Set(existing ?? [])
+  for (const item of items) set.add(item)
+  return [...set]
+}