@lexibase/rdx-types 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/config.d.ts

@@ -1,5 +1,7 @@
 import type { ComponentType } from 'react'
+import type { RdxPlugin } from './plugins'
 
+/** @deprecated Legacy development website config. New projects use RdxConfig. */
 export type RDXConfig = {
   /**
    * The title of the documentation site.
@@ -103,10 +105,21 @@ export type RDXConfig = {
   }
 }
 
-/** The minimal configuration accepted by the official RDX Next.js runtime. */
-export type RdxRuntimeConfig = {
+/** Public configuration shared by the CLI, runtime, and plugins. */
+export type RdxHomepage = {
+  enabled?: boolean
+  title?: string
+  description?: string
+  buttons?: { label: string; href: string }[]
+}
+
+export type RdxConfig = {
   title: string
   description?: string
+  lang?: string
+  docsDir?: string
+  homepage?: RdxHomepage
+  plugins?: RdxPlugin[]
   theme?: {
     defaultTheme?: 'system' | 'dark' | 'light'
   }
@@ -120,3 +133,17 @@ export type RdxRuntimeConfig = {
     }
   }
 }
+
+/** Compatibility alias for projects created by the first beta. */
+export type RdxRuntimeConfig = RdxConfig
+
+export type ResolvedRdxConfig = Omit<
+  RdxConfig,
+  'description' | 'lang' | 'docsDir' | 'theme' | 'plugins'
+> & {
+  description: string
+  lang: string
+  docsDir: string
+  theme: { defaultTheme: 'system' | 'dark' | 'light' }
+  plugins: RdxPlugin[]
+}

package/dist/index.d.ts

@@ -1,5 +1,18 @@
 export { VersionsRaw, MDXLoader, DocLink, DocCategory } from './loaders'
-export { RDXConfig, RdxRuntimeConfig } from './config'
+export {
+  RDXConfig,
+  RdxConfig,
+  RdxHomepage,
+  RdxRuntimeConfig,
+  ResolvedRdxConfig,
+} from './config'
+export {
+  RdxContentSource,
+  RdxPlugin,
+  RdxPluginCommand,
+  RdxPluginContext,
+  RdxProject,
+} from './plugins'
 export {
   RdxDocCategory,
   RdxDocFrontmatter,

package/dist/plugins.d.ts

@@ -0,0 +1,42 @@
+import type { ResolvedRdxConfig } from './config'
+
+/** A separate documentation tree exposed below /docs/<routePrefix>. */
+export type RdxContentSource = {
+  id: string
+  label: string
+  docsDir: string
+  routePrefix: string
+  badge?: string
+}
+
+export type RdxPluginContext = {
+  rootDir: string
+  command: string
+  config: ResolvedRdxConfig
+}
+
+export type RdxPluginCommand = {
+  name: string
+  description: string
+  run: (context: RdxPluginContext & { args: string[] }) => void | Promise<void>
+}
+
+/** Hooks run only for explicitly configured plugins, in declaration order. */
+export type RdxPlugin = {
+  name: string
+  apiVersion: 1
+  setup?: (
+    context: RdxPluginContext
+  ) =>
+    | { sources?: RdxContentSource[] }
+    | void
+    | Promise<{ sources?: RdxContentSource[] } | void>
+  commands?: RdxPluginCommand[]
+}
+
+export type RdxProject = {
+  rootDir: string
+  config: ResolvedRdxConfig
+  sources: RdxContentSource[]
+  commands: RdxPluginCommand[]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/rdx-types",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "license": "MIT",
   "description": "Shared TypeScript types for RDX documentation projects.",
   "types": "./dist/index.d.ts",