@orbytes/astrolab 0.3.0

package/src/core/virtual-module/virtual-routes.ts

@@ -0,0 +1,130 @@
+// Vendored from astrobook 0.13.3 (virtual-module/virtual-routes.ts) — see ../LICENSE-astrobook.
+// Divergence: relative imports carry the .ts extension so node can load this graph directly
+// (upstream is bundled before it ships; this package is not).
+// Divergence: the specifiers this file emits into every generated route are absolute paths into ./lib-paths.ts rather
+// than bare `astrobook/...` ids — see that file for why.
+import path from 'node:path'
+
+import type { AstroIntegrationLogger } from 'astro'
+import slash from 'slash'
+
+import {
+  CLIENT_MODULE,
+  PREVIEW_PAGE,
+  STORY_PAGE,
+  WITH_DECORATORS_COMPONENT,
+} from '../lib-paths.ts'
+import type { Story, StoryModule } from '../../types/types.ts'
+import { invariant } from '../utils/invariant.ts'
+import type { PathBuilder } from '../utils/path-builder.ts'
+
+import { getStoryModules } from './get-story-modules.ts'
+
+export interface VirtualRoute {
+  pattern: string
+  /**
+   * The absolute path to the virtual entrypoint file. Posix slash format.
+   *
+   * It's important to use an absolute path here because we must ensure that we
+   * only have one `id`, so that Astro's CSS plugin can find the correct CSS
+   * content in the following line.
+   * https://github.com/withastro/astro/blob/bc2796436dc3810e988c27b71b7a66fcb1ae8bda/packages/astro/src/core/build/plugins/plugin-css.ts#L144
+   */
+  entrypoint: string
+  storyModule: StoryModule
+  story: Story
+  props: {
+    hasSidebar: boolean
+    story: string
+  }
+}
+
+export async function getVirtualRoutes(
+  rootDir: string,
+  codegenDir: string,
+  logger: AstroIntegrationLogger,
+  dashboardSubpath: string,
+  previewSubpath: string,
+  buildPath: PathBuilder,
+): Promise<Map<string, VirtualRoute>> {
+  const routes: VirtualRoute[] = []
+  const storyModules = await getStoryModules(rootDir)
+
+  for (const storyModule of storyModules) {
+    logger.debug(
+      `Found ${storyModule.stories.length} stories in ${storyModule.importPath}`,
+    )
+    for (const story of storyModule.stories) {
+      invariant(
+        !story.id.startsWith('..'),
+        `Story ID cannot start with '..', but got '${story.id}'`,
+      )
+      invariant(
+        !story.id.startsWith('/'),
+        `Story ID cannot start with '/', but got '${story.id}'`,
+      )
+      routes.push(
+        {
+          pattern: buildPath(dashboardSubpath, story.id),
+          entrypoint: slash(
+            path.resolve(codegenDir, 'dashboard', story.id + '.astro'),
+          ),
+          storyModule,
+          story,
+          props: { hasSidebar: true, story: story.id },
+        },
+        {
+          pattern: buildPath(previewSubpath, story.id),
+          entrypoint: slash(
+            path.resolve(codegenDir, 'stories', story.id + '.astro'),
+          ),
+          storyModule,
+          story,
+          props: { hasSidebar: false, story: story.id },
+        },
+      )
+    }
+  }
+
+  logger.info(`Found ${routes.length} stories in ${storyModules.length} files`)
+
+  return new Map(routes.map((route) => [route.pattern, route]))
+}
+
+export function createVirtualRouteComponent(route: VirtualRoute): string {
+  // A module name that's useful for debugging and error messages
+  const modName = `astrobook_module_${route.storyModule.id}`
+    .replaceAll(/\W+/g, '_')
+    .replaceAll(/_+/g, '_')
+    .replace(/_+$/, '')
+
+  // Divergence: upstream emits STORY_PAGE for both routes. The dashboard route (hasSidebar) is
+  // chrome plus preview and keeps it; the bare story route gets PREVIEW_PAGE, which carries the
+  // consumer's CSS and none of the lab's — decided 2026-09-22, see ../../ui/lab.css.
+  const page = route.props.hasSidebar ? STORY_PAGE : PREVIEW_PAGE
+
+  return `
+---
+// Automatically generated by Astrobook
+
+import StoryPage from '${page}';
+import WithDecorators from '${WITH_DECORATORS_COMPONENT}';
+import { parseStoryDefaultExport, parseStoryNamedExport } from '${CLIENT_MODULE}';
+
+import * as ${modName} from '${route.storyModule.importPath}';
+
+const { isAstroComponent } = parseStoryDefaultExport(${modName}, '${route.storyModule.importPath}');
+const { decorators, args } = parseStoryNamedExport(${modName}, '${route.storyModule.importPath}', '${route.story.name}');
+---
+
+<StoryPage story={'${route.props.story}'} hasSidebar={${route.props.hasSidebar}}>
+  <WithDecorators decorators={decorators}>
+    {isAstroComponent ? (
+      <${modName}.default.component {...args} />
+    ) : (
+      <${modName}.default.component {...args} client:load />
+    )}
+  </WithDecorators>
+</StoryPage>
+`.trim()
+}

package/src/core/virtual-module/vite-plugin.ts

@@ -0,0 +1,125 @@
+// Vendored from astrobook 0.13.3 (virtual-module/vite-plugin.ts) — see ../LICENSE-astrobook.
+// Divergence: relative imports carry the .ts extension so node can load this graph directly
+// (upstream is bundled before it ships; this package is not).
+import { resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import type { GlobalConfig } from '../../types/types.ts'
+import type { AstroConfig, AstroIntegrationLogger } from 'astro'
+import type { Plugin, ViteDevServer } from 'vite'
+
+import { loadStoryModules } from './story-modules.ts'
+import {
+  COMPONENT_HEAD_ID,
+  COMPONENT_HEAD_RESOLVED_ID,
+  COMPONENT_HOME_ID,
+  COMPONENT_HOME_RESOLVED_ID,
+  STORY_MODULES_ID,
+  STORY_MODULES_RESOLVED_ID,
+  GLOBAL_CONFIG_ID,
+  GLOBAL_CONFIG_RESOLVED_ID,
+  USER_CSS_RESOLVED_ID,
+  USER_CSS_ID,
+} from './virtual-module-ids.ts'
+
+export function createVirtualFilesPlugin(
+  rootDir: string,
+  config: GlobalConfig,
+  astroConfig: AstroConfig,
+  logger: AstroIntegrationLogger,
+): Plugin {
+  const root = astroConfig.root
+
+  /**
+   * Resolves module IDs to a usable format:
+   * - Relative paths (e.g. `'./module.js'`) are resolved against `base` and formatted as an absolute path.
+   * - Package identifiers (e.g. `'module'`) are returned unchanged.
+   *
+   * By default, `base` is the project root directory.
+   */
+  function resolveId(id: string, base = root) {
+    return JSON.stringify(
+      id.startsWith('.') ? resolve(fileURLToPath(base), id) : id,
+    )
+  }
+
+  let storyModules: string | undefined
+  let needToReload = false
+  let watcherInitialized = false
+
+  async function getStoryModules(): Promise<string> {
+    const newStoryModules = await loadStoryModules(rootDir)
+    if (storyModules && newStoryModules !== storyModules) {
+      needToReload = true
+    }
+    storyModules = newStoryModules
+    return storyModules
+  }
+
+  async function restartServerIfNeeded(server: ViteDevServer) {
+    await getStoryModules()
+    if (needToReload) {
+      needToReload = false
+      logger.info(`Restarting`)
+      await server.restart()
+    }
+  }
+
+  function initializeNewFileWatcher(server: ViteDevServer) {
+    if (watcherInitialized || !server.watcher) return
+    watcherInitialized = true
+
+    server.watcher.on('add', async (filePath: string) => {
+      if (filePath.includes('.stories.')) {
+        logger.debug(`Potential story file added: ${filePath}`)
+        await restartServerIfNeeded(server)
+      }
+    })
+
+    server.watcher.on('unlink', async (filePath: string) => {
+      if (filePath.includes('.stories.')) {
+        logger.debug(`Potential story file deleted: ${filePath}`)
+        await restartServerIfNeeded(server)
+      }
+    })
+
+    logger.debug(`Initialized file watcher for story files`)
+  }
+
+  return {
+    name: 'astrobook/virtual-files',
+    resolveId(id) {
+      switch (id) {
+        case STORY_MODULES_ID:
+          return STORY_MODULES_RESOLVED_ID
+        case GLOBAL_CONFIG_ID:
+          return GLOBAL_CONFIG_RESOLVED_ID
+        case COMPONENT_HEAD_ID:
+          return COMPONENT_HEAD_RESOLVED_ID
+        case COMPONENT_HOME_ID:
+          return COMPONENT_HOME_RESOLVED_ID
+        case USER_CSS_ID:
+          return USER_CSS_RESOLVED_ID
+      }
+    },
+    load(id) {
+      switch (id) {
+        case STORY_MODULES_RESOLVED_ID:
+          return getStoryModules()
+        case GLOBAL_CONFIG_RESOLVED_ID:
+          return `const config = ${JSON.stringify(config)}; export default config;`
+        case COMPONENT_HEAD_RESOLVED_ID:
+          return `export { default } from ${resolveId(config.head)};`
+        case COMPONENT_HOME_RESOLVED_ID:
+          return `export { default } from ${resolveId(config.home)};`
+        case USER_CSS_RESOLVED_ID:
+          return config.css.map((id) => `import ${resolveId(id)};`).join('')
+      }
+    },
+    async handleHotUpdate(ctx) {
+      const { server } = ctx
+      initializeNewFileWatcher(server)
+      await restartServerIfNeeded(server)
+    },
+  }
+}