@raystack/chronicle 0.1.2 → 0.1.3

package/dist/cli/index.js

@@ -9628,6 +9628,7 @@ Run`, source_default.cyan("chronicle dev"), "to start development server");
 // src/cli/commands/dev.ts
 import { spawn } from "child_process";
 import path3 from "path";
+import { fileURLToPath } from "url";
 
 // src/cli/utils/config.ts
 import fs2 from "fs";
@@ -9660,7 +9661,8 @@ function attachLifecycleHandlers(child) {
   process.on("SIGTERM", () => child.kill("SIGTERM"));
 }
 // src/cli/commands/dev.ts
-var nextBin = path3.join("/home/runner/work/chronicle/chronicle/packages/chronicle", "node_modules", ".bin", process.platform === "win32" ? "next.cmd" : "next");
+var PACKAGE_ROOT = path3.resolve(path3.dirname(fileURLToPath(import.meta.url)), "..", "..");
+var nextBin = path3.join(PACKAGE_ROOT, "node_modules", ".bin", process.platform === "win32" ? "next.cmd" : "next");
 var devCommand = new Command("dev").description("Start development server").option("-p, --port <port>", "Port number", "3000").option("-c, --content <path>", "Content directory").action((options) => {
   const contentDir = resolveContentDir(options.content);
   loadCLIConfig(contentDir);
@@ -9668,7 +9670,7 @@ var devCommand = new Command("dev").description("Start development server").opti
   console.log(source_default.gray(`Content: ${contentDir}`));
   const child = spawn(nextBin, ["dev", "-p", options.port], {
     stdio: "inherit",
-    cwd: "/home/runner/work/chronicle/chronicle/packages/chronicle",
+    cwd: PACKAGE_ROOT,
     env: {
       ...process.env,
       CHRONICLE_CONTENT_DIR: contentDir
@@ -9680,7 +9682,9 @@ var devCommand = new Command("dev").description("Start development server").opti
 // src/cli/commands/build.ts
 import { spawn as spawn2 } from "child_process";
 import path4 from "path";
-var nextBin2 = path4.join("/home/runner/work/chronicle/chronicle/packages/chronicle", "node_modules", ".bin", process.platform === "win32" ? "next.cmd" : "next");
+import { fileURLToPath as fileURLToPath2 } from "url";
+var PACKAGE_ROOT2 = path4.resolve(path4.dirname(fileURLToPath2(import.meta.url)), "..", "..");
+var nextBin2 = path4.join(PACKAGE_ROOT2, "node_modules", ".bin", process.platform === "win32" ? "next.cmd" : "next");
 var buildCommand = new Command("build").description("Build for production").option("-c, --content <path>", "Content directory").action((options) => {
   const contentDir = resolveContentDir(options.content);
   loadCLIConfig(contentDir);
@@ -9688,7 +9692,7 @@ var buildCommand = new Command("build").description("Build for production").opti
   console.log(source_default.gray(`Content: ${contentDir}`));
   const child = spawn2(nextBin2, ["build"], {
     stdio: "inherit",
-    cwd: "/home/runner/work/chronicle/chronicle/packages/chronicle",
+    cwd: PACKAGE_ROOT2,
     env: {
       ...process.env,
       CHRONICLE_CONTENT_DIR: contentDir
@@ -9700,7 +9704,9 @@ var buildCommand = new Command("build").description("Build for production").opti
 // src/cli/commands/start.ts
 import { spawn as spawn3 } from "child_process";
 import path5 from "path";
-var nextBin3 = path5.join("/home/runner/work/chronicle/chronicle/packages/chronicle", "node_modules", ".bin", process.platform === "win32" ? "next.cmd" : "next");
+import { fileURLToPath as fileURLToPath3 } from "url";
+var PACKAGE_ROOT3 = path5.resolve(path5.dirname(fileURLToPath3(import.meta.url)), "..", "..");
+var nextBin3 = path5.join(PACKAGE_ROOT3, "node_modules", ".bin", process.platform === "win32" ? "next.cmd" : "next");
 var startCommand = new Command("start").description("Start production server").option("-p, --port <port>", "Port number", "3000").option("-c, --content <path>", "Content directory").action((options) => {
   const contentDir = resolveContentDir(options.content);
   loadCLIConfig(contentDir);
@@ -9708,7 +9714,7 @@ var startCommand = new Command("start").description("Start production server").o
   console.log(source_default.gray(`Content: ${contentDir}`));
   const child = spawn3(nextBin3, ["start", "-p", options.port], {
     stdio: "inherit",
-    cwd: "/home/runner/work/chronicle/chronicle/packages/chronicle",
+    cwd: PACKAGE_ROOT3,
     env: {
       ...process.env,
       CHRONICLE_CONTENT_DIR: contentDir
@@ -9720,7 +9726,9 @@ var startCommand = new Command("start").description("Start production server").o
 // src/cli/commands/serve.ts
 import { spawn as spawn4 } from "child_process";
 import path6 from "path";
-var nextBin4 = path6.join("/home/runner/work/chronicle/chronicle/packages/chronicle", "node_modules", ".bin", process.platform === "win32" ? "next.cmd" : "next");
+import { fileURLToPath as fileURLToPath4 } from "url";
+var PACKAGE_ROOT4 = path6.resolve(path6.dirname(fileURLToPath4(import.meta.url)), "..", "..");
+var nextBin4 = path6.join(PACKAGE_ROOT4, "node_modules", ".bin", process.platform === "win32" ? "next.cmd" : "next");
 var serveCommand = new Command("serve").description("Build and start production server").option("-p, --port <port>", "Port number", "3000").option("-c, --content <path>", "Content directory").action((options) => {
   const contentDir = resolveContentDir(options.content);
   loadCLIConfig(contentDir);
@@ -9732,7 +9740,7 @@ var serveCommand = new Command("serve").description("Build and start production
   console.log(source_default.gray(`Content: ${contentDir}`));
   const buildChild = spawn4(nextBin4, ["build"], {
     stdio: "inherit",
-    cwd: "/home/runner/work/chronicle/chronicle/packages/chronicle",
+    cwd: PACKAGE_ROOT4,
     env: env2
   });
   process.once("SIGINT", () => buildChild.kill("SIGINT"));
@@ -9745,7 +9753,7 @@ var serveCommand = new Command("serve").description("Build and start production
     console.log(source_default.cyan("Starting production server..."));
     const startChild = spawn4(nextBin4, ["start", "-p", options.port], {
       stdio: "inherit",
-      cwd: "/home/runner/work/chronicle/chronicle/packages/chronicle",
+      cwd: PACKAGE_ROOT4,
       env: env2
     });
     attachLifecycleHandlers(startChild);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raystack/chronicle",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Config-driven documentation framework",
   "license": "Apache-2.0",
   "type": "module",
@@ -38,11 +38,12 @@
     "@codemirror/view": "^6.39.14",
     "@heroicons/react": "^2.2.0",
     "@raystack/apsara": "^0.56.0",
+    "@types/unist": "^3.0.3",
     "chalk": "^5.6.2",
     "class-variance-authority": "^0.7.1",
     "codemirror": "^6.0.2",
     "commander": "^14.0.2",
-    "fumadocs-core": "^16.4.9",
+    "fumadocs-core": "16.6.15",
     "fumadocs-mdx": "^14.2.6",
     "lodash": "^4.17.23",
     "mermaid": "^11.13.0",
@@ -53,6 +54,7 @@
     "remark-attr": "^0.11.1",
     "remark-directive": "^4.0.0",
     "slugify": "^1.6.6",
+    "unified": "^11.0.5",
     "unist-util-visit": "^5.1.0",
     "yaml": "^2.8.2",
     "zod": "^4.3.6"

package/source.config.ts

@@ -1,4 +1,5 @@
-import { defineDocs, defineConfig } from 'fumadocs-mdx/config'
+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'
@@ -8,6 +9,12 @@ 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/**'],
   },
 })

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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,15 @@
+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/cli/commands/build.ts

@@ -1,11 +1,11 @@
 import { Command } from 'commander'
 import { spawn } from 'child_process'
 import path from 'path'
+import { fileURLToPath } from 'url'
 import chalk from 'chalk'
 import { resolveContentDir, loadCLIConfig, attachLifecycleHandlers } from '@/cli/utils'
 
-declare const PACKAGE_ROOT: string
-
+const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..')
 const nextBin = path.join(PACKAGE_ROOT, 'node_modules', '.bin', process.platform === 'win32' ? 'next.cmd' : 'next')
 
 export const buildCommand = new Command('build')

package/src/cli/commands/dev.ts

@@ -1,11 +1,11 @@
 import { Command } from 'commander'
 import { spawn } from 'child_process'
 import path from 'path'
+import { fileURLToPath } from 'url'
 import chalk from 'chalk'
 import { resolveContentDir, loadCLIConfig, attachLifecycleHandlers } from '@/cli/utils'
 
-declare const PACKAGE_ROOT: string
-
+const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..')
 const nextBin = path.join(PACKAGE_ROOT, 'node_modules', '.bin', process.platform === 'win32' ? 'next.cmd' : 'next')
 
 export const devCommand = new Command('dev')

package/src/cli/commands/serve.ts

@@ -1,11 +1,11 @@
 import { Command } from 'commander'
 import { spawn } from 'child_process'
 import path from 'path'
+import { fileURLToPath } from 'url'
 import chalk from 'chalk'
 import { resolveContentDir, loadCLIConfig, attachLifecycleHandlers } from '@/cli/utils'
 
-declare const PACKAGE_ROOT: string
-
+const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..')
 const nextBin = path.join(PACKAGE_ROOT, 'node_modules', '.bin', process.platform === 'win32' ? 'next.cmd' : 'next')
 
 export const serveCommand = new Command('serve')

package/src/cli/commands/start.ts

@@ -1,11 +1,11 @@
 import { Command } from 'commander'
 import { spawn } from 'child_process'
 import path from 'path'
+import { fileURLToPath } from 'url'
 import chalk from 'chalk'
 import { resolveContentDir, loadCLIConfig, attachLifecycleHandlers } from '@/cli/utils'
 
-declare const PACKAGE_ROOT: string
-
+const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..')
 const nextBin = path.join(PACKAGE_ROOT, 'node_modules', '.bin', process.platform === 'win32' ? 'next.cmd' : 'next')
 
 export const startCommand = new Command('start')

package/src/lib/config.ts

@@ -32,5 +32,6 @@ export function loadConfig(): ChronicleConfig {
     search: { ...defaultConfig.search, ...userConfig.search },
     footer: userConfig.footer,
     api: userConfig.api,
+    llms: { enabled: false, ...userConfig.llms },
   }
 }

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

@@ -0,0 +1,10 @@
+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}`
+}

package/src/lib/remark-unused-directives.ts

@@ -2,26 +2,25 @@ import { visit } from 'unist-util-visit'
 import type { Plugin } from 'unified'
 import type { Node } from 'unist'
 
-interface DirectiveNode extends Node {
-  name?: string
-  attributes?: Record<string, string>
-  children?: Node[]
-  data?: unknown
-  [key: string]: unknown
-}
-
 const remarkUnusedDirectives: Plugin = () => {
   return (tree) => {
-    visit(tree, ['textDirective'], (node: DirectiveNode) => {
-      if (!node.data) {
-        const hasAttributes = node.attributes && Object.keys(node.attributes).length > 0
-        const hasChildren = node.children && node.children.length > 0
+    visit(tree, ['textDirective'], (node) => {
+      const directive = node as Node & {
+        name?: string
+        attributes?: Record<string, string>
+        children?: Node[]
+        value?: string
+        [key: string]: unknown
+      }
+      if (!directive.data) {
+        const hasAttributes = directive.attributes && Object.keys(directive.attributes).length > 0
+        const hasChildren = directive.children && directive.children.length > 0
         if (!hasAttributes && !hasChildren) {
-          const name = node.name
+          const name = directive.name
           if (!name) return
-          Object.keys(node).forEach((key) => delete node[key])
-          node.type = 'text'
-          node.value = `:${name}`
+          Object.keys(directive).forEach((key) => delete directive[key])
+          directive.type = 'text'
+          directive.value = `:${name}`
         }
       }
     })

package/src/lib/source.ts

@@ -51,11 +51,12 @@ export function buildPageTree(): PageTree {
   const folderItems: PageTreeItem[] = []
   folders.forEach((items, folder) => {
     const sorted = sortByOrder(items)
-    const indexPage = sorted[0]
+    const indexPage = items.find(item => item.url === `/${folder}`)
+    const folderOrder = indexPage?.order ?? sorted[0]?.order
     folderItems.push({
       type: 'folder',
       name: folder.charAt(0).toUpperCase() + folder.slice(1),
-      order: indexPage?.order,
+      order: folderOrder,
       children: sorted,
     })
   })

package/src/types/config.ts

@@ -7,6 +7,11 @@ export interface ChronicleConfig {
   search?: SearchConfig
   footer?: FooterConfig
   api?: ApiConfig[]
+  llms?: LlmsConfig
+}
+
+export interface LlmsConfig {
+  enabled?: boolean
 }
 
 export interface ApiConfig {