@raystack/chronicle 0.1.0-canary.e11f924 → 0.1.0-canary.f0d9bde

package/src/themes/paper/ChapterNav.tsx

@@ -1,7 +1,6 @@
 'use client'
 
-import { usePathname } from 'next/navigation'
-import NextLink from 'next/link'
+import { useLocation, Link } from 'react-router-dom'
 import { MethodBadge } from '@/components/api/method-badge'
 import type { PageTree, PageTreeItem } from '@/types'
 import styles from './ChapterNav.module.css'
@@ -31,7 +30,7 @@ function buildChapterIndices(children: PageTreeItem[]): Map<PageTreeItem, number
 }
 
 export function ChapterNav({ tree }: ChapterNavProps) {
-  const pathname = usePathname()
+  const { pathname } = useLocation()
   const chapterIndices = buildChapterIndices(tree.children)
 
   return (
@@ -84,13 +83,13 @@ function ChapterItem({ item, pathname }: { item: PageTreeItem; pathname: string
 
   return (
     <li>
-      <NextLink
-        href={item.url ?? '#'}
+      <Link
+        to={item.url ?? '#'}
         className={`${styles.link} ${isActive ? styles.active : ''}`}
       >
         {icon && <span className={styles.icon}>{icon}</span>}
         <span>{item.name}</span>
-      </NextLink>
+      </Link>
     </li>
   )
 }

package/src/themes/paper/Page.tsx

@@ -1,8 +1,7 @@
 'use client'
 
 import { useMemo } from 'react'
-import { usePathname } from 'next/navigation'
-import NextLink from 'next/link'
+import { useLocation, Link } from 'react-router-dom'
 import { Flex } from '@raystack/apsara'
 import { ChevronLeftIcon, ChevronRightIcon } from '@heroicons/react/24/outline'
 import type { ThemePageProps, PageTreeItem } from '@/types'
@@ -41,7 +40,7 @@ function findInTree(items: PageTreeItem[], path: string): PageTreeItem | undefin
 }
 
 export function Page({ page, config, tree }: ThemePageProps) {
-  const pathname = usePathname()
+  const { pathname } = useLocation()
 
   const { prev, next, crumbs } = useMemo(() => {
     const pages = flattenTree(tree.children)
@@ -59,18 +58,18 @@ export function Page({ page, config, tree }: ThemePageProps) {
         <Flex align="center" className={styles.navbar}>
           <Flex align="center" gap="small" className={styles.navLeft}>
             {prev ? (
-              <NextLink href={prev.url!} className={styles.arrow} aria-label="Previous page">
+              <Link to={prev.url!} className={styles.arrow} aria-label="Previous page">
                 <ChevronLeftIcon width={14} height={14} />
-              </NextLink>
+              </Link>
             ) : (
               <button disabled className={styles.arrowDisabled} aria-label="Previous page">
                 <ChevronLeftIcon width={14} height={14} />
               </button>
             )}
             {next ? (
-              <NextLink href={next.url!} className={styles.arrow} aria-label="Next page">
+              <Link to={next.url!} className={styles.arrow} aria-label="Next page">
                 <ChevronRightIcon width={14} height={14} />
-              </NextLink>
+              </Link>
             ) : (
               <button disabled className={styles.arrowDisabled} aria-label="Next page">
                 <ChevronRightIcon width={14} height={14} />
@@ -83,9 +82,9 @@ export function Page({ page, config, tree }: ThemePageProps) {
                   {i === crumbs.length - 1 ? (
                     <span className={styles.crumbActive}>{crumb.label}</span>
                   ) : (
-                    <NextLink href={crumb.href} className={styles.crumbLink}>
+                    <Link to={crumb.href} className={styles.crumbLink}>
                       {crumb.label}
-                    </NextLink>
+                    </Link>
                   )}
                 </span>
               ))}

package/src/types/config.ts

@@ -1,6 +1,7 @@
 export interface ChronicleConfig {
   title: string
   description?: string
+  url?: string
   logo?: LogoConfig
   theme?: ThemeConfig
   navigation?: NavigationConfig
@@ -8,12 +9,22 @@ export interface ChronicleConfig {
   footer?: FooterConfig
   api?: ApiConfig[]
   llms?: LlmsConfig
+  analytics?: AnalyticsConfig
 }
 
 export interface LlmsConfig {
   enabled?: boolean
 }
 
+export interface AnalyticsConfig {
+  enabled?: boolean
+  googleAnalytics?: GoogleAnalyticsConfig
+}
+
+export interface GoogleAnalyticsConfig {
+  measurementId: string
+}
+
 export interface ApiConfig {
   name: string
   spec: string

package/src/types/content.ts

@@ -5,6 +5,7 @@ export interface Frontmatter {
   description?: string
   order?: number
   icon?: string
+  lastModified?: string
 }
 
 export interface Page {

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "jsx": "react-jsx",
+    "module": "ESNext",
+    "target": "es6",
+    "outDir": "dist",
+    "rootDir": ".",
+    "baseUrl": ".",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "moduleResolution": "bundler",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}

package/next.config.mjs

@@ -1,10 +0,0 @@
-import { createMDX } from 'fumadocs-mdx/next'
-
-const withMDX = createMDX()
-
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  reactStrictMode: true,
-}
-
-export default withMDX(nextConfig)

package/source.config.ts

@@ -1,50 +0,0 @@
-import { defineDocs, defineConfig, frontmatterSchema } from 'fumadocs-mdx/config'
-import { z } from 'zod'
-import remarkDirective from 'remark-directive'
-import { remarkDirectiveAdmonition, remarkMdxMermaid } from 'fumadocs-core/mdx-plugins'
-import remarkUnusedDirectives from './src/lib/remark-unused-directives'
-
-const contentDir = process.env.CHRONICLE_CONTENT_DIR || './content'
-
-export const docs = defineDocs({
-  dir: contentDir,
-  docs: {
-    schema: frontmatterSchema.extend({
-      order: z.number().optional(),
-    }),
-    postprocess: {
-      includeProcessedMarkdown: true,
-    },
-    files: ['**/*.mdx', '**/*.md', '!**/node_modules/**'],
-  },
-})
-
-export default defineConfig({
-  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,
-    ],
-  },
-})

package/src/app/[[...slug]]/layout.tsx

@@ -1,15 +0,0 @@
-import { loadConfig } from '@/lib/config'
-import { buildPageTree } from '@/lib/source'
-import { getTheme } from '@/themes/registry'
-
-export default function DocsLayout({ children }: { children: React.ReactNode }) {
-  const config = loadConfig()
-  const tree = buildPageTree()
-  const { Layout, className } = getTheme(config.theme?.name)
-
-  return (
-    <Layout config={config} tree={tree} classNames={{ layout: className }}>
-      {children}
-    </Layout>
-  )
-}

package/src/app/[[...slug]]/page.tsx

@@ -1,57 +0,0 @@
-import { notFound } from 'next/navigation'
-import type { MDXContent } from 'mdx/types'
-import { loadConfig } from '@/lib/config'
-import { source, buildPageTree } from '@/lib/source'
-import { getTheme } from '@/themes/registry'
-import { mdxComponents } from '@/components/mdx'
-
-interface PageProps {
-  params: Promise<{ slug?: string[] }>
-}
-
-interface PageData {
-  title: string
-  description?: string
-  body: MDXContent
-  toc: { title: string; url: string; depth: number }[]
-}
-
-export default async function DocsPage({ params }: PageProps) {
-  const { slug } = await params
-  const config = loadConfig()
-
-  const page = source.getPage(slug)
-
-  if (!page) {
-    notFound()
-  }
-
-  const { Page } = getTheme(config.theme?.name)
-
-  const data = page.data as PageData
-  const MDXBody = data.body
-
-  const tree = buildPageTree()
-
-  return (
-    <Page
-      page={{
-        slug: slug ?? [],
-        frontmatter: {
-          title: data.title,
-          description: data.description,
-        },
-        content: <MDXBody components={mdxComponents} />,
-        toc: data.toc ?? [],
-      }}
-      config={config}
-      tree={tree}
-    />
-  )
-}
-
-export function generateStaticParams() {
-  return source.getPages().map((page) => ({
-    slug: page.slugs,
-  }))
-}

package/src/app/api/apis-proxy/route.ts

@@ -1,59 +0,0 @@
-import { NextRequest, NextResponse } from "next/server";
-import { loadConfig } from "@/lib/config";
-import { loadApiSpecs } from "@/lib/openapi";
-
-export async function POST(request: NextRequest) {
-  const { specName, method, path, headers, body } = await request.json();
-
-  if (!specName || !method || !path) {
-    return NextResponse.json(
-      { error: "Missing specName, method, or path" },
-      { status: 400 },
-    );
-  }
-
-  const config = loadConfig();
-  const specs = loadApiSpecs(config.api ?? []);
-  const spec = specs.find((s) => s.name === specName);
-
-  if (!spec) {
-    return NextResponse.json(
-      { error: `Unknown spec: ${specName}` },
-      { status: 404 },
-    );
-  }
-
-  const url = spec.server.url + path;
-
-  try {
-    const response = await fetch(url, {
-      method,
-      headers,
-      body: body ? JSON.stringify(body) : undefined,
-    });
-
-    const contentType = response.headers.get("content-type") ?? "";
-    const responseBody = contentType.includes("application/json")
-      ? await response.json()
-      : await response.text();
-
-    return NextResponse.json({
-      status: response.status,
-      statusText: response.statusText,
-      body: responseBody,
-    }, { status: response.status });
-  } catch (error) {
-    const message =
-      error instanceof Error
-        ? `${error.message}${error.cause ? `: ${(error.cause as Error).message}` : ""}`
-        : "Request failed";
-    return NextResponse.json(
-      {
-        status: 502,
-        statusText: "Bad Gateway",
-        body: `Could not reach ${url}\n${message}`,
-      },
-      { status: 502 },
-    );
-  }
-}

package/src/app/api/search/route.ts

@@ -1,90 +0,0 @@
-import { source } from '@/lib/source'
-import { createSearchAPI, type AdvancedIndex } from 'fumadocs-core/search/server'
-import type { StructuredData } from 'fumadocs-core/mdx-plugins'
-import type { OpenAPIV3 } from 'openapi-types'
-import { loadConfig } from '@/lib/config'
-import { loadApiSpecs, type ApiSpec } from '@/lib/openapi'
-import { getSpecSlug } from '@/lib/api-routes'
-
-interface PageData {
-  title?: string
-  description?: string
-  structuredData?: StructuredData
-  load?: () => Promise<{ structuredData?: StructuredData }>
-}
-
-const HTTP_METHODS = ['get', 'post', 'put', 'delete', 'patch'] as const
-type HttpMethod = (typeof HTTP_METHODS)[number]
-
-function getParamNames(op: OpenAPIV3.OperationObject): string[] {
-  const params = (op.parameters as OpenAPIV3.ParameterObject[] | undefined) ?? []
-  return params.map((p) => p.name)
-}
-
-function buildStructuredData(op: OpenAPIV3.OperationObject, method: string, pathStr: string) {
-  return {
-    headings: [{ id: op.operationId!, content: `${method.toUpperCase()} ${pathStr}` }],
-    contents: [{ heading: op.operationId!, content: `${method.toUpperCase()} ${[op.description, ...getParamNames(op)].filter(Boolean).join(' ')}` }],
-  }
-}
-
-function operationToIndex(specSlug: string, pathStr: string, method: HttpMethod, op: OpenAPIV3.OperationObject): AdvancedIndex {
-  const url = `/apis/${specSlug}/${encodeURIComponent(op.operationId!)}`
-  return {
-    id: url,
-    url,
-    title: `${method.toUpperCase()} ${op.summary ?? op.operationId!}`,
-    description: op.description ?? '',
-    structuredData: buildStructuredData(op, method, pathStr),
-  }
-}
-
-function pathEntryToIndexes(specSlug: string) {
-  return ([pathStr, pathItem]: [string, OpenAPIV3.PathItemObject | undefined]): AdvancedIndex[] => {
-    if (!pathItem) return []
-    const hasOp = (m: HttpMethod) => !!pathItem[m]?.operationId
-    const toIndex = (m: HttpMethod) => operationToIndex(specSlug, pathStr, m, pathItem[m]!)
-    return HTTP_METHODS.filter(hasOp).map(toIndex)
-  }
-}
-
-function specToIndexes(spec: ApiSpec): AdvancedIndex[] {
-  const specSlug = getSpecSlug(spec)
-  return Object.entries(spec.document.paths ?? {}).flatMap(pathEntryToIndexes(specSlug))
-}
-
-function buildApiIndexes(): AdvancedIndex[] {
-  const config = loadConfig()
-  if (!config.api?.length) return []
-  return loadApiSpecs(config.api).flatMap(specToIndexes)
-}
-
-export const { GET } = createSearchAPI('advanced', {
-  indexes: async (): Promise<AdvancedIndex[]> => {
-    const pages = source.getPages()
-    const indexes = await Promise.all(
-      pages.map(async (page): Promise<AdvancedIndex> => {
-        const data = page.data as PageData
-        let structuredData: StructuredData | undefined = data.structuredData
-
-        if (!structuredData && data.load) {
-          try {
-            const loaded = await data.load()
-            structuredData = loaded.structuredData
-          } catch (error) {
-            console.error(`Failed to load structured data for ${page.url}:`, error)
-          }
-        }
-
-        return {
-          id: page.url,
-          url: page.url,
-          title: data.title ?? '',
-          description: data.description ?? '',
-          structuredData: structuredData ?? { headings: [], contents: [] },
-        }
-      })
-    )
-    return [...indexes, ...buildApiIndexes()]
-  },
-})

package/src/app/apis/[[...slug]]/page.tsx

@@ -1,57 +0,0 @@
-import { notFound } from 'next/navigation'
-import type { OpenAPIV3 } from 'openapi-types'
-import { Flex, Headline, Text } from '@raystack/apsara'
-import { loadConfig } from '@/lib/config'
-import { loadApiSpecs } from '@/lib/openapi'
-import { buildApiRoutes, findApiOperation } from '@/lib/api-routes'
-import { EndpointPage } from '@/components/api'
-
-interface PageProps {
-  params: Promise<{ slug?: string[] }>
-}
-
-export default async function ApiPage({ params }: PageProps) {
-  const { slug } = await params
-  const config = loadConfig()
-  const specs = loadApiSpecs(config.api ?? [])
-
-  if (!slug || slug.length === 0) {
-    return <ApiLanding specs={specs} />
-  }
-
-  const match = findApiOperation(specs, slug)
-  if (!match) notFound()
-
-  return (
-    <EndpointPage
-      method={match.method}
-      path={match.path}
-      operation={match.operation}
-      serverUrl={match.spec.server.url}
-      specName={match.spec.name}
-      auth={match.spec.auth}
-    />
-  )
-}
-
-function ApiLanding({ specs }: { specs: { name: string; document: OpenAPIV3.Document }[] }) {
-  return (
-    <Flex direction="column" gap="large" style={{ padding: 'var(--rs-space-7)' }}>
-      <Headline size="medium" as="h1">API Reference</Headline>
-      {specs.map((spec) => (
-        <Flex key={spec.name} direction="column" gap="small">
-          <Headline size="small" as="h2">{spec.name}</Headline>
-          {spec.document.info.description && (
-            <Text size={3}>{spec.document.info.description}</Text>
-          )}
-        </Flex>
-      ))}
-    </Flex>
-  )
-}
-
-export function generateStaticParams() {
-  const config = loadConfig()
-  const specs = loadApiSpecs(config.api ?? [])
-  return [{ slug: [] }, ...buildApiRoutes(specs)]
-}

package/src/app/layout.tsx

@@ -1,26 +0,0 @@
-import '@raystack/apsara/normalize.css'
-import '@raystack/apsara/style.css'
-import type { Metadata } from 'next'
-import { loadConfig } from '@/lib/config'
-import { Providers } from './providers'
-
-const config = loadConfig()
-
-export const metadata: Metadata = {
-  title: config.title,
-  description: config.description,
-}
-
-export default function RootLayout({
-  children,
-}: {
-  children: React.ReactNode
-}) {
-  return (
-    <html lang="en" suppressHydrationWarning>
-      <body suppressHydrationWarning>
-        <Providers>{children}</Providers>
-      </body>
-    </html>
-  )
-}

package/src/app/llms-full.txt/route.ts

@@ -1,18 +0,0 @@
-import { source } from '@/lib/source'
-import { loadConfig } from '@/lib/config'
-import { getLLMText } from '@/lib/get-llm-text'
-
-export const revalidate = false
-
-export async function GET() {
-  const config = loadConfig()
-
-  if (!config.llms?.enabled) {
-    return new Response('Not Found', { status: 404 })
-  }
-
-  const scan = source.getPages().map(getLLMText)
-  const scanned = await Promise.all(scan)
-
-  return new Response(scanned.join('\n\n'))
-}

package/src/app/llms.txt/route.ts

@@ -1,15 +0,0 @@
-import { source } from '@/lib/source'
-import { loadConfig } from '@/lib/config'
-import { llms } from 'fumadocs-core/source'
-
-export const revalidate = false
-
-export function GET() {
-  const config = loadConfig()
-
-  if (!config.llms?.enabled) {
-    return new Response('Not Found', { status: 404 })
-  }
-
-  return new Response(llms(source).index())
-}

package/src/app/providers.tsx

@@ -1,8 +0,0 @@
-'use client'
-
-import { ThemeProvider } from '@raystack/apsara'
-import type { ReactNode } from 'react'
-
-export function Providers({ children }: { children: ReactNode }) {
-  return <ThemeProvider enableSystem>{children}</ThemeProvider>
-}

package/src/cli/utils/process.ts

@@ -1,7 +0,0 @@
-import type { ChildProcess } from 'child_process'
-
-export function attachLifecycleHandlers(child: ChildProcess) {
-  child.on('close', (code) => process.exit(code ?? 0))
-  process.on('SIGINT', () => child.kill('SIGINT'))
-  process.on('SIGTERM', () => child.kill('SIGTERM'))
-}

package/src/lib/get-llm-text.ts

@@ -1,10 +0,0 @@
-import { source } from '@/lib/source'
-import type { InferPageType } from 'fumadocs-core/source'
-
-export async function getLLMText(page: InferPageType<typeof source>) {
-  const processed = await page.data.getText('processed')
-
-  return `# ${page.data.title} (${page.url})
-
-${processed}`
-}