@lexibase/rdx-next 1.0.0-beta.6 → 1.0.0-beta.7

package/README.md

@@ -17,3 +17,10 @@ explicitly configured plugins enable the shared navbar dropdown.
 
 `.rdx/` is generated. Configure the site or edit a project-owned `home.tsx`
 instead of modifying files inside `.rdx/`.
+
+Place images, favicon and downloads in the project-root `public/` directory.
+The CLI links `.rdx/public` to it using a junction on Windows or a directory
+symlink elsewhere. `/images/logo.svg` serves `public/images/logo.svg` in dev and
+production. No asset copies are cached and original files are never removed.
+Restart/redeploy production after adding/removing assets. Documentation versions
+share this directory; snapshots do not copy its contents.

package/bin/public-assets.mjs

@@ -0,0 +1,58 @@
+import { lstat, mkdir, realpath, symlink, unlink } from 'node:fs/promises'
+import path from 'node:path'
+import process from 'node:process'
+
+async function inspect(filePath) {
+  try {
+    return await lstat(filePath)
+  } catch (error) {
+    if (error.code === 'ENOENT') return null
+    throw error
+  }
+}
+
+/** Link generated Next public/ to project-owned assets; never copy or delete them. */
+export async function preparePublicAssets(projectRoot, runtimeDirectory) {
+  const runtime = await inspect(runtimeDirectory)
+  if (!runtime?.isDirectory() || runtime.isSymbolicLink())
+    throw new Error(
+      '.rdx/ must be a real directory, not a symbolic link or junction.'
+    )
+
+  const publicDirectory = path.join(projectRoot, 'public')
+  const existing = await inspect(publicDirectory)
+  if (existing && (!existing.isDirectory() || existing.isSymbolicLink()))
+    throw new Error('public/ must be a real directory in the project root.')
+  await mkdir(publicDirectory, { recursive: true })
+
+  const destination = path.join(runtimeDirectory, 'public')
+  const link = await inspect(destination)
+  if (link) {
+    if (!link.isSymbolicLink())
+      throw new Error(
+        'Cannot prepare .rdx/public: a file or directory already exists there. Move any assets to the project public/ directory, then remove the conflicting .rdx/public entry and retry. RDX has not removed it.'
+      )
+    let target
+    try {
+      target = await realpath(destination)
+    } catch (error) {
+      if (error.code !== 'ENOENT') throw error
+    }
+    if (target === (await realpath(publicDirectory))) return
+    // Only unlink the internal pointer, never its old target or the user's files.
+    await unlink(destination)
+  }
+
+  const target = process.platform === 'win32' ? publicDirectory : '../public'
+  try {
+    await symlink(
+      target,
+      destination,
+      process.platform === 'win32' ? 'junction' : 'dir'
+    )
+  } catch (error) {
+    throw new Error(
+      `Could not link .rdx/public to public/: ${error.message}. Use a filesystem that supports directory links (junctions on Windows); your public files have not been removed.`
+    )
+  }
+}

package/bin/rdx.mjs

@@ -10,6 +10,8 @@ import process from 'node:process'
 import { createRdxProject } from '@lexibase/rdx-core/config'
 import { createJiti } from 'jiti'
 
+import { preparePublicAssets } from './public-assets.mjs'
+
 const supportedCommands = new Set(['dev', 'build', 'start'])
 const command = process.argv[2]
 const commandArgs = process.argv.slice(3)
@@ -23,6 +25,7 @@ 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 })
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/rdx-next",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.0-beta.7",
   "description": "The Next.js runtime for RDX documentation projects.",
   "license": "MIT",
   "type": "module",
@@ -60,8 +60,8 @@
     "react": "19.1.0",
     "react-dom": "19.1.0",
     "typescript": "5.9.2",
-    "@rdx/typescript-config": "1.0.0",
-    "@rdx/eslint-config": "1.0.0"
+    "@rdx/eslint-config": "1.0.0",
+    "@rdx/typescript-config": "1.0.0"
   },
   "scripts": {
     "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",

package/templates/runtime/tsconfig.json

@@ -16,5 +16,5 @@
     "target": "esnext"
   },
   "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "public"]
 }