@raystack/chronicle 0.1.0-canary.5a730d4 → 0.1.0-canary.67113f8

package/src/server/routes/llms.txt.ts

@@ -0,0 +1,61 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import matter from 'gray-matter';
+import { defineHandler, HTTPError } from 'nitro';
+import { loadConfig } from '@/lib/config';
+
+function getContentDir(): string {
+  return __CHRONICLE_CONTENT_DIR__ || path.join(process.cwd(), 'content');
+}
+
+async function scanPages(): Promise<{ title: string; url: string }[]> {
+  const contentDir = getContentDir();
+  const pages: { title: string; url: string }[] = [];
+
+  async function scan(dir: string, prefix: string[] = []) {
+    try {
+      const entries = await fs.readdir(dir, { withFileTypes: true });
+      for (const entry of entries) {
+        if (entry.name.startsWith('.') || entry.name === 'node_modules')
+          continue;
+        const fullPath = path.join(dir, entry.name);
+
+        if (entry.isDirectory()) {
+          await scan(fullPath, [...prefix, entry.name]);
+          continue;
+        }
+
+        if (!entry.name.endsWith('.mdx') && !entry.name.endsWith('.md'))
+          continue;
+
+        const raw = await fs.readFile(fullPath, 'utf-8');
+        const { data: fm } = matter(raw);
+        const baseName = entry.name.replace(/\.(mdx|md)$/, '');
+        const slugs = baseName === 'index' ? prefix : [...prefix, baseName];
+        const url = slugs.length === 0 ? '/' : `/${slugs.join('/')}`;
+
+        pages.push({ title: fm.title ?? baseName, url });
+      }
+    } catch {
+      /* directory not readable */
+    }
+  }
+
+  await scan(contentDir);
+  return pages;
+}
+
+export default defineHandler(async event => {
+  const config = loadConfig();
+
+  if (!config.llms?.enabled) {
+    throw new HTTPError({ status: 404, message: 'Not Found' });
+  }
+
+  const pages = await scanPages();
+  const index = pages.map(p => `- [${p.title}](${p.url})`).join('\n');
+  const body = `# ${config.title}\n\n${config.description ?? ''}\n\n${index}`;
+
+  event.res.headers.set('Content-Type', 'text/plain');
+  return body;
+});

package/src/server/routes/og.tsx

@@ -0,0 +1,75 @@
+import { defineHandler } from 'nitro';
+import React from 'react';
+import satori from 'satori';
+import { loadConfig } from '@/lib/config';
+
+let fontData: ArrayBuffer | null = null;
+
+async function loadFont(): Promise<ArrayBuffer> {
+  if (fontData) return fontData;
+
+  try {
+    const response = await fetch(
+      'https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hiA.woff2'
+    );
+    fontData = await response.arrayBuffer();
+  } catch {
+    fontData = new ArrayBuffer(0);
+  }
+
+  return fontData;
+}
+
+export default defineHandler(async event => {
+  const config = loadConfig();
+  const title = event.url.searchParams.get('title') ?? config.title;
+  const description = event.url.searchParams.get('description') ?? '';
+  const siteName = config.title;
+
+  const font = await loadFont();
+
+  const svg = await satori(
+    <div
+      style={{
+        height: '100%',
+        width: '100%',
+        display: 'flex',
+        flexDirection: 'column',
+        justifyContent: 'center',
+        padding: '60px 80px',
+        backgroundColor: '#0a0a0a',
+        color: '#fafafa',
+      }}
+    >
+      <div style={{ fontSize: 24, color: '#888', marginBottom: 16 }}>
+        {siteName}
+      </div>
+      <div
+        style={{
+          fontSize: 56,
+          fontWeight: 700,
+          lineHeight: 1.2,
+          marginBottom: 24,
+        }}
+      >
+        {title}
+      </div>
+      {description && (
+        <div style={{ fontSize: 24, color: '#999', lineHeight: 1.4 }}>
+          {description}
+        </div>
+      )}
+    </div>,
+    {
+      width: 1200,
+      height: 630,
+      fonts: [
+        { name: 'Inter', data: font, weight: 400, style: 'normal' as const },
+      ],
+    },
+  );
+
+  event.res.headers.set('Content-Type', 'image/svg+xml');
+  event.res.headers.set('Cache-Control', 'public, max-age=86400');
+  return svg;
+});

package/src/server/routes/robots.txt.ts

@@ -0,0 +1,11 @@
+import { defineHandler } from 'nitro';
+import { loadConfig } from '@/lib/config';
+
+export default defineHandler(event => {
+  const config = loadConfig();
+  const sitemap = config.url ? `\nSitemap: ${config.url}/sitemap.xml` : '';
+  const body = `User-agent: *\nAllow: /${sitemap}`;
+
+  event.res.headers.set('Content-Type', 'text/plain');
+  return body;
+});

package/src/server/routes/sitemap.xml.ts

@@ -0,0 +1,40 @@
+import { defineHandler } from 'nitro';
+import { buildApiRoutes } from '@/lib/api-routes';
+import { loadConfig } from '@/lib/config';
+import { loadApiSpecs } from '@/lib/openapi';
+import { getPages } from '@/lib/source';
+
+export default defineHandler(async event => {
+  const config = loadConfig();
+
+  if (!config.url) {
+    event.res.headers.set('Content-Type', 'application/xml');
+    return '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"/>';
+  }
+
+  const baseUrl = config.url.replace(/\/$/, '');
+
+  const pages = await getPages();
+  const docPages = pages.map(page => {
+    const data = page.data as Record<string, unknown>;
+    const lastmod = data.lastModified
+      ? `<lastmod>${new Date(data.lastModified as string).toISOString()}</lastmod>`
+      : '';
+    return `<url><loc>${baseUrl}/${page.slugs.join('/')}</loc>${lastmod}</url>`;
+  });
+
+  const apiPages = config.api?.length
+    ? buildApiRoutes(await loadApiSpecs(config.api)).map(
+        route => `<url><loc>${baseUrl}/apis/${route.slug.join('/')}</loc></url>`
+      )
+    : [];
+
+  const xml = `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<url><loc>${baseUrl}</loc></url>
+${[...docPages, ...apiPages].join('\n')}
+</urlset>`;
+
+  event.res.headers.set('Content-Type', 'application/xml');
+  return xml;
+});

package/src/server/utils/safe-path.ts

@@ -0,0 +1,17 @@
+import path from 'node:path';
+
+/**
+ * Resolve a URL path within a base directory, preventing path traversal.
+ * Returns null if the resolved path escapes the base directory.
+ */
+export function safePath(baseDir: string, urlPath: string): string | null {
+  const decoded = decodeURIComponent(urlPath.split('?')[0]);
+  const resolved = path.resolve(baseDir, '.' + decoded);
+  if (
+    !resolved.startsWith(path.resolve(baseDir) + path.sep) &&
+    resolved !== path.resolve(baseDir)
+  ) {
+    return null;
+  }
+  return resolved;
+}

package/src/server/vite-config.ts

@@ -1,65 +1,111 @@
-import path from 'path'
-import { type InlineConfig } from 'vite'
-import react from '@vitejs/plugin-react'
-import mdx from '@mdx-js/rollup'
-import remarkDirective from 'remark-directive'
-import remarkGfm from 'remark-gfm'
-import remarkFrontmatter from 'remark-frontmatter'
-import remarkMdxFrontmatter from 'remark-mdx-frontmatter'
-import rehypeShiki from '@shikijs/rehype'
+import react from '@vitejs/plugin-react';
+import { remarkDirectiveAdmonition, remarkMdxMermaid } from 'fumadocs-core/mdx-plugins';
+import { defineConfig as defineFumadocsConfig } from 'fumadocs-mdx/config';
+import mdx from 'fumadocs-mdx/vite';
+import { nitro } from 'nitro/vite';
+import path from 'node:path';
+import remarkDirective from 'remark-directive';
+import { type InlineConfig } from 'vite';
+import remarkUnusedDirectives from '../lib/remark-unused-directives';
+
+function resolveOutputDir(projectRoot: string, preset?: string): string {
+  if (preset === 'vercel' || preset === 'vercel-static') return path.resolve(projectRoot, '.vercel/output');
+  return path.resolve(projectRoot, '.output');
+}
 
 export interface ViteConfigOptions {
-  root: string
-  contentDir: string
-  isDev?: boolean
+  packageRoot: string;
+  projectRoot: string;
+  contentDir: string;
+  preset?: string;
 }
 
-export async function createViteConfig(options: ViteConfigOptions): Promise<InlineConfig> {
-  const { root, contentDir, isDev = false } = options
+export async function createViteConfig(
+  options: ViteConfigOptions
+): Promise<InlineConfig> {
+  const { packageRoot, projectRoot, contentDir, preset } = options;
 
   return {
-    root,
+    root: packageRoot,
     configFile: false,
+    plugins: [
+      nitro({
+        serverDir: path.resolve(packageRoot, 'src/server'),
+        ...(preset && { preset }),
+      }),
+      mdx({
+        default: defineFumadocsConfig({
+          mdxOptions: {
+            remarkPlugins: [
+              remarkDirective,
+              [remarkDirectiveAdmonition, {
+                tags: {
+                  CalloutContainer: 'Callout',
+                  CalloutTitle: 'CalloutTitle',
+                  CalloutDescription: 'CalloutDescription',
+                },
+                types: {
+                  note: 'accent',
+                  tip: 'accent',
+                  info: 'accent',
+                  warn: 'attention',
+                  warning: 'attention',
+                  danger: 'alert',
+                  caution: 'alert',
+                  success: 'success',
+                },
+              }],
+              remarkUnusedDirectives,
+              remarkMdxMermaid,
+            ],
+          },
+        }),
+      }, { index: false }),
+      react()
+    ],
     resolve: {
       alias: {
-        '@': path.resolve(root, 'src'),
-        '@content': contentDir,
+        '@': path.resolve(packageRoot, 'src'),
       },
+      conditions: ['module-sync', 'import', 'node'],
+      dedupe: [
+        'react',
+        'react-dom',
+        'react/jsx-runtime',
+        'react/jsx-dev-runtime',
+        'react-router',
+      ]
+    },
+    server: {
+      fs: {
+        allow: [packageRoot, projectRoot, contentDir]
+      }
     },
-    plugins: [
-      mdx({
-        remarkPlugins: [
-          remarkFrontmatter,
-          remarkMdxFrontmatter,
-          remarkGfm,
-          remarkDirective,
-        ],
-        rehypePlugins: [
-          [rehypeShiki, { themes: { light: 'github-light', dark: 'github-dark' } }],
-        ],
-        mdExtensions: ['.md'],
-        mdxExtensions: ['.mdx'],
-      }),
-      react(),
-    ],
     define: {
-      'process.env.CHRONICLE_CONTENT_DIR': JSON.stringify(contentDir),
-      'process.env.CHRONICLE_PROJECT_ROOT': JSON.stringify(root),
+      __CHRONICLE_CONTENT_DIR__: JSON.stringify(contentDir),
+      __CHRONICLE_PROJECT_ROOT__: JSON.stringify(projectRoot)
     },
     css: {
       modules: {
-        localsConvention: 'camelCase',
-      },
+        localsConvention: 'camelCase'
+      }
     },
     ssr: {
-      noExternal: ['@raystack/apsara'],
+      noExternal: ['@raystack/apsara', 'dayjs', 'fumadocs-core']
+    },
+    environments: {
+      client: {
+        build: {
+          rollupOptions: {
+            input: path.resolve(packageRoot, 'src/server/entry-client.tsx')
+          }
+        }
+      }
     },
-    build: {
-      rolldownOptions: {
-        input: isDev ? undefined : {
-          client: path.resolve(root, 'src/server/index.html'),
-        },
+    nitro: {
+      output: {
+        dir: resolveOutputDir(projectRoot, preset),
       },
     },
-  }
+  };
 }

package/src/themes/default/Layout.tsx

@@ -1,64 +1,87 @@
-"use client";
-
-import { useMemo, useEffect, useRef } from "react";
-import { useLocation, Link } from "react-router-dom";
-import { cx } from "class-variance-authority";
-import { Flex, Navbar, Headline, Sidebar, Button } from "@raystack/apsara";
-import { RectangleStackIcon } from "@heroicons/react/24/outline";
-import { ClientThemeSwitcher } from "@/components/ui/client-theme-switcher";
-import { Search } from "@/components/ui/search";
-import { Footer } from "@/components/ui/footer";
-import { MethodBadge } from "@/components/api/method-badge";
-import type { ThemeLayoutProps, PageTreeItem } from "@/types";
-import styles from "./Layout.module.css";
+import { RectangleStackIcon } from '@heroicons/react/24/outline';
+import {
+  Button,
+  Flex,
+  Headline,
+  Link,
+  Navbar,
+  Sidebar
+} from '@raystack/apsara';
+import { cx } from 'class-variance-authority';
+import { useEffect, useMemo, useRef } from 'react';
+import { Link as RouterLink, useLocation } from 'react-router';
+import { MethodBadge } from '@/components/api/method-badge';
+import { ClientThemeSwitcher } from '@/components/ui/client-theme-switcher';
+import { Footer } from '@/components/ui/footer';
+import { Search } from '@/components/ui/search';
+import type { Node } from 'fumadocs-core/page-tree';
+import type { ThemeLayoutProps } from '@/types';
+import styles from './Layout.module.css';
 
 const iconMap: Record<string, React.ReactNode> = {
-  "rectangle-stack": <RectangleStackIcon width={16} height={16} />,
-  "method-get": <MethodBadge method="GET" size="micro" />,
-  "method-post": <MethodBadge method="POST" size="micro" />,
-  "method-put": <MethodBadge method="PUT" size="micro" />,
-  "method-delete": <MethodBadge method="DELETE" size="micro" />,
-  "method-patch": <MethodBadge method="PATCH" size="micro" />,
+  'rectangle-stack': <RectangleStackIcon width={16} height={16} />,
+  'method-get': <MethodBadge method='GET' size='micro' />,
+  'method-post': <MethodBadge method='POST' size='micro' />,
+  'method-put': <MethodBadge method='PUT' size='micro' />,
+  'method-delete': <MethodBadge method='DELETE' size='micro' />,
+  'method-patch': <MethodBadge method='PATCH' size='micro' />
 };
 
 let savedScrollTop = 0;
 
-export function Layout({ children, config, tree, classNames }: ThemeLayoutProps) {
+export function Layout({
+  children,
+  config,
+  tree,
+  classNames
+}: ThemeLayoutProps) {
   const { pathname } = useLocation();
   const scrollRef = useRef<HTMLDivElement>(null);
 
   useEffect(() => {
     const el = scrollRef.current;
     if (!el) return;
-    const onScroll = () => { savedScrollTop = el.scrollTop; };
+    const onScroll = () => {
+      savedScrollTop = el.scrollTop;
+    };
     el.addEventListener('scroll', onScroll);
     return () => el.removeEventListener('scroll', onScroll);
   }, []);
 
   useEffect(() => {
     const el = scrollRef.current;
-    if (el) requestAnimationFrame(() => { el.scrollTop = savedScrollTop; });
+    if (el)
+      requestAnimationFrame(() => {
+        el.scrollTop = savedScrollTop;
+      });
   }, [pathname]);
 
   return (
-    <Flex direction="column" className={cx(styles.layout, classNames?.layout)}>
+    <Flex direction='column' className={cx(styles.layout, classNames?.layout)}>
       <Navbar className={styles.header}>
         <Navbar.Start>
-          <Link to="/" style={{ textDecoration: 'none', color: 'inherit' }}>
-            <Headline size="small" weight="medium" as="h1">
+          <RouterLink
+            to='/'
+            style={{ textDecoration: 'none', color: 'inherit' }}
+          >
+            <Headline size='small' weight='medium' as='h1'>
               {config.title}
             </Headline>
-          </Link>
+          </RouterLink>
         </Navbar.Start>
         <Navbar.End>
-          <Flex gap="medium" align="center" className={styles.navActions}>
-            {config.api?.map((api) => (
-              <Link key={api.name} to={api.basePath} className={styles.navButton}>
+          <Flex gap='medium' align='center' className={styles.navActions}>
+            {config.api?.map(api => (
+              <RouterLink
+                key={api.basePath}
+                to={api.basePath}
+                className={styles.navButton}
+              >
                 {api.name} API
-              </Link>
+              </RouterLink>
             ))}
-            {config.navigation?.links?.map((link) => (
-              <Link key={link.href} to={link.href}>
+            {config.navigation?.links?.map(link => (
+              <Link key={link.href} href={link.href}>
                 {link.label}
               </Link>
             ))}
@@ -68,18 +91,24 @@ export function Layout({ children, config, tree, classNames }: ThemeLayoutProps)
         </Navbar.End>
       </Navbar>
       <Flex className={cx(styles.body, classNames?.body)}>
-        <Sidebar defaultOpen collapsible={false} className={cx(styles.sidebar, classNames?.sidebar)}>
+        <Sidebar
+          defaultOpen
+          collapsible={false}
+          className={cx(styles.sidebar, classNames?.sidebar)}
+        >
           <Sidebar.Main ref={scrollRef}>
-            {tree.children.map((item) => (
+            {tree.children.map((item, i) => (
               <SidebarNode
-                key={item.url ?? item.name}
+                key={item.type === 'page' ? item.url : (item.name?.toString() ?? i)}
                 item={item}
                 pathname={pathname}
               />
             ))}
           </Sidebar.Main>
         </Sidebar>
-        <main className={cx(styles.content, classNames?.content)}>{children}</main>
+        <main className={cx(styles.content, classNames?.content)}>
+          {children}
+        </main>
       </Flex>
       <Footer config={config.footer} />
     </Flex>
@@ -88,25 +117,26 @@ export function Layout({ children, config, tree, classNames }: ThemeLayoutProps)
 
 function SidebarNode({
   item,
-  pathname,
+  pathname
 }: {
-  item: PageTreeItem;
+  item: Node;
   pathname: string;
 }) {
-  if (item.type === "separator") {
+  if (item.type === 'separator') {
     return null;
   }
 
-  if (item.type === "folder" && item.children) {
+  if (item.type === 'folder') {
+    const icon = typeof item.icon === 'string' ? iconMap[item.icon] : item.icon;
     return (
       <Sidebar.Group
-        label={item.name}
-        leadingIcon={item.icon ? iconMap[item.icon] : undefined}
+        label={item.name?.toString() ?? ''}
+        leadingIcon={icon ?? undefined}
         classNames={{ items: styles.groupItems }}
       >
-        {item.children.map((child) => (
+        {item.children.map((child, i) => (
           <SidebarNode
-            key={child.url ?? child.name}
+            key={child.type === 'page' ? child.url : (child.name?.toString() ?? i)}
             item={child}
             pathname={pathname}
           />
@@ -116,14 +146,15 @@ function SidebarNode({
   }
 
   const isActive = pathname === item.url;
-  const href = item.url ?? "#";
-  const link = useMemo(() => <Link to={href} />, [href]);
+  const href = item.url ?? '#';
+  const icon = typeof item.icon === 'string' ? iconMap[item.icon] : item.icon;
+  const link = useMemo(() => <RouterLink to={href} />, [href]);
 
   return (
     <Sidebar.Item
       href={href}
       active={isActive}
-      leadingIcon={item.icon ? iconMap[item.icon] : undefined}
+      leadingIcon={icon ?? undefined}
       as={link}
     >
       {item.name}

package/src/themes/default/Page.module.css

@@ -38,18 +38,6 @@
   margin-bottom: var(--rs-space-3);
 }
 
-.content :global(pre code span) {
-  color: var(--shiki-light);
-}
-
-:global([data-theme="dark"]) .content :global(pre code span) {
-  color: var(--shiki-dark);
-}
-
-:global([data-theme="dark"]) .content :global(pre) {
-  background-color: var(--shiki-dark-bg, #24292e);
-}
-
 .content img {
   max-width: 100%;
   height: auto;

package/src/themes/default/Page.tsx

@@ -1,21 +1,19 @@
-'use client'
+'use client';
 
-import { Flex } from '@raystack/apsara'
-import type { ThemePageProps } from '@/types'
-import { Breadcrumbs } from '@/components/ui/breadcrumbs'
-import { Toc } from './Toc'
-import styles from './Page.module.css'
+import { Flex } from '@raystack/apsara';
+import { Breadcrumbs } from '@/components/ui/breadcrumbs';
+import type { ThemePageProps } from '@/types';
+import styles from './Page.module.css';
+import { Toc } from './Toc';
 
 export function Page({ page, tree }: ThemePageProps) {
   return (
     <Flex className={styles.page}>
-      <article className={styles.article}>
+      <article className={styles.article} data-article-content>
         <Breadcrumbs slug={page.slug} tree={tree} />
-        <div className={styles.content}>
-          {page.content}
-        </div>
+        <div className={styles.content}>{page.content}</div>
       </article>
       <Toc items={page.toc} />
     </Flex>
-  )
+  );
 }