@lexibase/rdx-next 1.0.0 → 1.1.0

package/README.md

@@ -2,6 +2,11 @@
 
 The official Next.js runtime for RDX documentation projects.
 
+Generated projects use the main `@lexibase/rdx` package. This adapter remains
+available for advanced integrations. It declares the shared UI as a compatible
+peer dependency rather than owning a fixed UI copy. The main package supplies
+the selected UI; direct adapter consumers must install a compatible UI themselves.
+
 Requires Node.js 22.18+ (22.x) or 24.11+ (24.x). Use the latest patch of either line.
 The MDX renderer keeps JavaScript expression blocking enabled. Markdown, fenced
 code and registered JSX components with literal props remain supported, but

package/bin/cli.d.mts

@@ -0,0 +1,2 @@
+/** Run the adapter CLI with an optional prepared runtime template directory. */
+export function runRdxCli(options?: { templateDir?: string }): Promise<void>

package/bin/cli.mjs

@@ -0,0 +1,129 @@
+import { spawn } from 'node:child_process'
+import { createRequire } from 'node:module'
+import { access, cp, mkdir } from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import process from 'node:process'
+
+import { createRdxProject } from '@lexibase/rdx-core/config'
+import { createJiti } from 'jiti'
+
+import { preparePublicAssets } from './public-assets.mjs'
+
+export async function runRdxCli({ templateDir } = {}) {
+  const supportedCommands = new Set(['dev', 'build', 'start'])
+  let command = process.argv[2]
+  const commandArgs = process.argv.slice(3)
+  const projectRoot = process.cwd()
+  const packageRoot = path.resolve(
+    path.dirname(fileURLToPath(import.meta.url)),
+    '..'
+  )
+  const runtimeTemplate =
+    templateDir ?? path.join(packageRoot, 'templates', 'runtime')
+  const runtimeDirectory = path.join(projectRoot, '.rdx')
+
+  async function prepareRuntime() {
+    await mkdir(runtimeDirectory, { recursive: true })
+    await preparePublicAssets(projectRoot, runtimeDirectory)
+    await cp(runtimeTemplate, runtimeDirectory, {
+      force: true,
+      recursive: true,
+    })
+  }
+
+  async function main() {
+    if (!command || command === 'help' || command === '--help') {
+      console.log('Usage: rdx <dev|build|start|prepare|add|plugin-command>')
+      console.log('  rdx add versioning [--package-manager npm|pnpm|yarn]')
+      console.log(
+        'Plugin commands are registered through plugins in rdx.config.ts.'
+      )
+      return
+    }
+
+    if (command === 'add') {
+      const { addVersioning, parseAddArguments } =
+        await import('./add-plugin.mjs')
+      const options = parseAddArguments(commandArgs)
+      await addVersioning(projectRoot, options)
+      command = 'prepare'
+    }
+
+    const configPath = path.join(projectRoot, 'rdx.config.ts')
+    try {
+      await access(configPath)
+    } catch {
+      throw new Error(
+        `Missing ${configPath}. Run rdx from the documentation project root.`
+      )
+    }
+
+    const jiti = createJiti(import.meta.url, {
+      moduleCache: false,
+      fsCache: false,
+      jsx: { runtime: 'automatic' },
+    })
+    let input
+    try {
+      input = await jiti.import(configPath, { default: true })
+    } catch (error) {
+      const hint =
+        error.code === 'MODULE_NOT_FOUND' ||
+        error.code === 'ERR_MODULE_NOT_FOUND'
+          ? ' If a configured plugin cannot be resolved, install its package in this project.'
+          : ''
+      throw new Error(`Could not load rdx.config.ts: ${error.message}${hint}`)
+    }
+
+    const project = await createRdxProject(input, {
+      rootDir: projectRoot,
+      command,
+    })
+    if (command === 'prepare') {
+      await prepareRuntime()
+      console.log('RDX runtime prepared in .rdx/')
+      return
+    }
+    if (!supportedCommands.has(command)) {
+      const pluginCommand = project.commands.find(
+        (entry) => entry.name === command
+      )
+      if (!pluginCommand)
+        throw new Error(
+          `Unknown command "${command}". Available: dev, build, start, prepare, add${project.commands.map((entry) => `, ${entry.name}`).join('')}. Install and configure the plugin that provides this command.`
+        )
+      await pluginCommand.run({
+        rootDir: projectRoot,
+        config: project.config,
+        command,
+        args: commandArgs,
+      })
+      return
+    }
+
+    await prepareRuntime()
+    const projectRequire = createRequire(path.join(projectRoot, 'package.json'))
+    const nextCli = projectRequire.resolve('next/dist/bin/next')
+    const child = spawn(
+      process.execPath,
+      [nextCli, command, runtimeDirectory, ...commandArgs],
+      { cwd: projectRoot, stdio: 'inherit' }
+    )
+    child.on('error', (error) => {
+      console.error(`[RDX] Could not start Next.js: ${error.message}`)
+      process.exitCode = 1
+    })
+    child.on('exit', (code, signal) => {
+      if (signal) process.kill(process.pid, signal)
+      process.exit(code ?? 1)
+    })
+  }
+
+  try {
+    await main()
+  } catch (error) {
+    console.error(`[RDX] ${error.message}`)
+    process.exitCode = 1
+  }
+}

package/bin/plugin-config.mjs

@@ -36,7 +36,11 @@ export function activateVersioning(source) {
         if (specifier.isTypeOnly) continue
         const imported = (specifier.propertyName ?? specifier.name).text
         if (
-          ['@lexibase/rdx-next', '@lexibase/rdx-core/config'].includes(name) &&
+          [
+            '@lexibase/rdx',
+            '@lexibase/rdx-next',
+            '@lexibase/rdx-core/config',
+          ].includes(name) &&
           imported === 'defineConfig'
         )
           definitions.add(specifier.name.text)

package/bin/rdx.mjs

@@ -1,124 +1,5 @@
 #!/usr/bin/env node
 
-import { spawn } from 'node:child_process'
-import { createRequire } from 'node:module'
-import { access, cp, mkdir } from 'node:fs/promises'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-import process from 'node:process'
+import { runRdxCli } from './cli.mjs'
 
-import { createRdxProject } from '@lexibase/rdx-core/config'
-import { createJiti } from 'jiti'
-
-import { preparePublicAssets } from './public-assets.mjs'
-
-const supportedCommands = new Set(['dev', 'build', 'start'])
-let command = process.argv[2]
-const commandArgs = process.argv.slice(3)
-const projectRoot = process.cwd()
-const packageRoot = path.resolve(
-  path.dirname(fileURLToPath(import.meta.url)),
-  '..'
-)
-const runtimeTemplate = path.join(packageRoot, 'templates', 'runtime')
-const runtimeDirectory = path.join(projectRoot, '.rdx')
-
-async function prepareRuntime() {
-  await mkdir(runtimeDirectory, { recursive: true })
-  await preparePublicAssets(projectRoot, runtimeDirectory)
-  await cp(runtimeTemplate, runtimeDirectory, { force: true, recursive: true })
-}
-
-async function main() {
-  if (!command || command === 'help' || command === '--help') {
-    console.log('Usage: rdx <dev|build|start|prepare|add|plugin-command>')
-    console.log('  rdx add versioning [--package-manager npm|pnpm|yarn]')
-    console.log(
-      'Plugin commands are registered through plugins in rdx.config.ts.'
-    )
-    return
-  }
-
-  if (command === 'add') {
-    const { addVersioning, parseAddArguments } =
-      await import('./add-plugin.mjs')
-    const options = parseAddArguments(commandArgs)
-    await addVersioning(projectRoot, options)
-    command = 'prepare'
-  }
-
-  const configPath = path.join(projectRoot, 'rdx.config.ts')
-  try {
-    await access(configPath)
-  } catch {
-    throw new Error(
-      `Missing ${configPath}. Run rdx from the documentation project root.`
-    )
-  }
-
-  const jiti = createJiti(import.meta.url, {
-    moduleCache: false,
-    fsCache: false,
-    jsx: { runtime: 'automatic' },
-  })
-  let input
-  try {
-    input = await jiti.import(configPath, { default: true })
-  } catch (error) {
-    const hint =
-      error.code === 'MODULE_NOT_FOUND' || error.code === 'ERR_MODULE_NOT_FOUND'
-        ? ' If a configured plugin cannot be resolved, install its package in this project.'
-        : ''
-    throw new Error(`Could not load rdx.config.ts: ${error.message}${hint}`)
-  }
-
-  const project = await createRdxProject(input, {
-    rootDir: projectRoot,
-    command,
-  })
-  if (command === 'prepare') {
-    await prepareRuntime()
-    console.log('RDX runtime prepared in .rdx/')
-    return
-  }
-  if (!supportedCommands.has(command)) {
-    const pluginCommand = project.commands.find(
-      (entry) => entry.name === command
-    )
-    if (!pluginCommand)
-      throw new Error(
-        `Unknown command "${command}". Available: dev, build, start, prepare, add${project.commands.map((entry) => `, ${entry.name}`).join('')}. Install and configure the plugin that provides this command.`
-      )
-    await pluginCommand.run({
-      rootDir: projectRoot,
-      config: project.config,
-      command,
-      args: commandArgs,
-    })
-    return
-  }
-
-  await prepareRuntime()
-  const projectRequire = createRequire(path.join(projectRoot, 'package.json'))
-  const nextCli = projectRequire.resolve('next/dist/bin/next')
-  const child = spawn(
-    process.execPath,
-    [nextCli, command, runtimeDirectory, ...commandArgs],
-    { cwd: projectRoot, stdio: 'inherit' }
-  )
-  child.on('error', (error) => {
-    console.error(`[RDX] Could not start Next.js: ${error.message}`)
-    process.exitCode = 1
-  })
-  child.on('exit', (code, signal) => {
-    if (signal) process.kill(process.pid, signal)
-    process.exit(code ?? 1)
-  })
-}
-
-try {
-  await main()
-} catch (error) {
-  console.error(`[RDX] ${error.message}`)
-  process.exitCode = 1
-}
+await runRdxCli()

package/dist/runtime/index.d.ts

@@ -9,6 +9,11 @@ declare function getSearchSources(project: RdxProject): {
 }[];
 declare function getSearchResponse(project: RdxProject, key: string): Response;
 
+/** Read metadata from the same content source and index used by the page. */
+declare function getDocumentMetadata({ project, slug, }: {
+    project: RdxProject;
+    slug?: string[];
+}): Metadata;
 /** Translate the shared configuration through Next's native Metadata API. */
 declare function getRdxMetadata(config: RDXConfig): Metadata;
 
@@ -25,4 +30,4 @@ declare function DocsPage({ slug, project, }: {
     project: RdxProject;
 }): Promise<react.JSX.Element>;
 
-export { DocsPage, HomePage, RdxLayout, getRdxMetadata, getSearchResponse, getSearchSources };
+export { DocsPage, HomePage, RdxLayout, getDocumentMetadata, getRdxMetadata, getSearchResponse, getSearchSources };

package/dist/runtime/index.js

@@ -3,7 +3,7 @@ import {
   getDocument as getDocument2,
   getDocsPaths,
   getSourceOptions as getSourceOptions2,
-  resolveDocsRoute
+  resolveDocsRoute as resolveDocsRoute2
 } from "@lexibase/rdx-core";
 import { Button } from "@lexibase/rdx-ui/components/button";
 import { ButtonLink } from "@lexibase/rdx-ui/components/button-link";
@@ -18,7 +18,7 @@ import {
   VersionDropdown
 } from "@lexibase/rdx-ui/components/version-dropdown";
 import { ThemeProvider } from "@lexibase/rdx-ui/providers/theme-provider";
-import { notFound, redirect } from "next/navigation";
+import { notFound as notFound2, redirect } from "next/navigation";
 
 // src/runtime/mdx.ts
 import { compileMDX } from "next-mdx-remote/rsc";
@@ -76,6 +76,21 @@ function getSearchResponse(project, key) {
 }
 
 // src/runtime/metadata.ts
+import { resolveDocsRoute } from "@lexibase/rdx-core";
+import { notFound } from "next/navigation";
+function getDocumentMetadata({
+  project,
+  slug
+}) {
+  const route = resolveDocsRoute(project, slug);
+  if (!route.slug) return {};
+  if (!route.document) notFound();
+  const page = route.categories.flatMap((category) => category.pages).find((page2) => page2.slug === route.slug);
+  return {
+    title: page.title,
+    description: page.description || project.config.description
+  };
+}
 function getRdxMetadata(config) {
   const { metadataBase, ...metadata } = config.metadata;
   const name = metadata.applicationName;
@@ -127,7 +142,7 @@ function RdxHeader({
   slug
 }) {
   const { config } = project;
-  const { source, slug: currentSlug } = resolveDocsRoute(project, slug);
+  const { source, slug: currentSlug } = resolveDocsRoute2(project, slug);
   const options = project.sources.map((edition) => {
     const docs = getSourceOptions2(project, edition);
     const destination = currentSlug && getDocument2(currentSlug, docs) ? currentSlug : getDocsPaths(docs)[0];
@@ -196,7 +211,7 @@ async function DocsPage({
     slug: currentSlug,
     document,
     categories
-  } = resolveDocsRoute(project, slug);
+  } = resolveDocsRoute2(project, slug);
   if (!currentSlug)
     return /* @__PURE__ */ jsxs(Fragment, { children: [
       /* @__PURE__ */ jsx(RdxHeader, { project, slug }),
@@ -205,7 +220,7 @@ async function DocsPage({
         /* @__PURE__ */ jsx("p", { children: "Add an .mdx file inside your configured documentation directory." })
       ] })
     ] });
-  if (!document) notFound();
+  if (!document) notFound2();
   const { content } = await compileDocumentation(
     document.content,
     mdxComponents,
@@ -314,6 +329,7 @@ export {
   HomePage,
   RdxLayout,
   createRdxProject,
+  getDocumentMetadata,
   getProjectDocsPaths,
   getRdxMetadata,
   getSearchResponse,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/rdx-next",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "The Next.js runtime for RDX documentation projects.",
   "license": "MIT",
   "type": "module",
@@ -11,6 +11,11 @@
     "rdx": "./bin/rdx.mjs"
   },
   "exports": {
+    "./package.json": "./package.json",
+    "./cli": {
+      "types": "./bin/cli.d.mts",
+      "import": "./bin/cli.mjs"
+    },
     "./config": {
       "types": "./config.d.mts",
       "import": "./config.mjs"
@@ -46,11 +51,11 @@
     "next-mdx-remote": "^6.0.0",
     "remark-gfm": "^4",
     "typescript": "6.0.3",
-    "@lexibase/rdx-core": "1.0.0",
-    "@lexibase/rdx-ui": "1.0.0",
-    "@lexibase/rdx-types": "1.0.0"
+    "@lexibase/rdx-types": "1.0.0",
+    "@lexibase/rdx-core": "1.0.0"
   },
   "peerDependencies": {
+    "@lexibase/rdx-ui": "^1.0.0",
     "next": "^16.4.2",
     "react": "^19.3.1",
     "react-dom": "^19.3.1"
@@ -75,12 +80,13 @@
     "next": "^16.4.2",
     "react": "19.3.1",
     "react-dom": "19.3.1",
-    "@rdx/typescript-config": "1.0.0",
-    "@rdx/eslint-config": "1.0.0"
+    "@lexibase/rdx-ui": "1.0.0",
+    "@rdx/eslint-config": "1.0.0",
+    "@rdx/typescript-config": "1.0.0"
   },
   "scripts": {
-    "dev": "tsup src/index.ts src/runtime/index.tsx --format esm --dts --watch --external @lexibase/rdx-core --external @lexibase/rdx-types --external next --external react --external react-dom --external next-mdx-remote",
-    "build": "tsup src/index.ts src/runtime/index.tsx --format esm --dts --clean --external @lexibase/rdx-core --external @lexibase/rdx-types --external next --external react --external react-dom --external next-mdx-remote",
+    "dev": "tsup src/index.ts src/runtime/index.tsx --format esm --dts --watch --external @lexibase/rdx-core --external @lexibase/rdx-types --external @lexibase/rdx-ui --external next --external react --external react-dom --external next-mdx-remote",
+    "build": "tsup src/index.ts src/runtime/index.tsx --format esm --dts --clean --external @lexibase/rdx-core --external @lexibase/rdx-types --external @lexibase/rdx-ui --external next --external react --external react-dom --external next-mdx-remote",
     "lint": "eslint . --max-warnings 0",
     "check-types": "tsc --noEmit",
     "test": "node --test tests/*.test.mjs",

package/templates/runtime/app/docs/[[...slug]]/page.tsx

@@ -1,7 +1,21 @@
-import { DocsPage, getProjectDocsPaths } from '@lexibase/rdx-next/runtime'
+import type { Metadata } from 'next'
+import {
+  DocsPage,
+  getDocumentMetadata,
+  getProjectDocsPaths,
+} from '@lexibase/rdx-next/runtime'
 
 import { getProject } from '../../../rdx-project'
 
+export async function generateMetadata({
+  params,
+}: {
+  params: Promise<{ slug?: string[] }>
+}): Promise<Metadata> {
+  const { slug } = await params
+  return getDocumentMetadata({ project: await getProject(), slug })
+}
+
 export async function generateStaticParams() {
   return getProjectDocsPaths(await getProject()).map((slug) => ({
     slug: slug.split('/'),