boltdocs 2.5.6 → 2.6.0

package/dist/node/index.d.cts

@@ -3,124 +3,26 @@ import * as _$vite from "vite";
 import { InlineConfig, Plugin } from "vite";
 import { z } from "zod";
 
-//#region src/node/plugins/plugin-types.d.ts
-/**
- * Permissions that a plugin can request to access specific Boltdocs capabilities.
- */
-type PluginPermission = 'fs:read' | 'fs:write' | 'vite:config' | 'mdx:remark' | 'mdx:rehype' | 'components' | 'hooks:build' | 'hooks:dev';
-/**
- * Shared context injected into every plugin lifecycle hook.
- */
-interface PluginContext {
-  /** The full, resolved Boltdocs configuration (Readonly) */
-  readonly config: BoltdocsConfig;
-  /** A plugin-specific logger */
-  readonly logger: PluginLogger;
-  /** A shared store for dependency injection and state sharing between plugins */
-  readonly store: PluginStore;
-  /** Metadata about the current plugin */
-  readonly meta: PluginMeta;
-}
-/**
- * Simple logger interface for plugins.
- */
-interface PluginLogger {
-  info(message: string): void;
-  warn(message: string): void;
-  error(message: string | Error): void;
-  debug(message: string): void;
-}
-/**
- * A shared key-value store that allows plugins to share state and configuration.
- */
-interface PluginStore {
-  /** Get a value from the store. Keys are namespaced by plugin internally. */
-  get<T = unknown>(pluginName: string, key: string): T | undefined;
-  /** Set a value in the store. */
-  set(pluginName: string, key: string, value: unknown): void;
-  /** Check if a key exists in the store. */
-  has(pluginName: string, key: string): boolean;
-}
-/**
- * Metadata for a plugin, used for identification and compatibility checks.
- */
-interface PluginMeta {
-  /** Unique identifier for the plugin */
-  name: string;
-  /** Version of the plugin itself (semver) */
-  version?: string;
-  /** Minimum required version of Boltdocs (semver range) */
-  boltdocsVersion?: string;
-}
-/**
- * Lifecycle hooks that a plugin can implement to hook into the build and dev processes.
- */
-interface PluginLifecycleHooks {
-  /** Called before the build process starts */
-  beforeBuild?: (ctx: PluginContext) => Promise<void> | void;
-  /** Called after the build process finishes successfully */
-  afterBuild?: (ctx: PluginContext) => Promise<void> | void;
-  /** Called before the dev server starts */
-  beforeDev?: (ctx: PluginContext) => Promise<void> | void;
-  /** Called after the dev server is ready (configureServer) */
-  afterDev?: (ctx: PluginContext) => Promise<void> | void;
-  /** Called when the final Boltdocs config is resolved */
-  configResolved?: (ctx: PluginContext, config: BoltdocsConfig) => void;
-  /** Called when the build is closing */
-  buildEnd?: (ctx: PluginContext) => Promise<void> | void;
-}
-/**
- * The extended, secure Boltdocs plugin interface.
- */
-interface SecureBoltdocsPlugin {
-  /** A unique name for the plugin (e.g., 'boltdocs-plugin-mermaid') */
-  name: string;
-  /** Whether to run this plugin before or after default ones */
-  enforce?: 'pre' | 'post';
-  /** Version of the plugin (optional, but recommended for security) */
-  version?: string;
-  /** Minimum compatible Boltdocs version (optional, semver range) */
-  boltdocsVersion?: string;
-  /** List of permissions this plugin requires to operate */
-  permissions?: PluginPermission[];
-  /** Optional remark plugins to add to the MDX pipeline (requires 'mdx:remark' permission) */
-  remarkPlugins?: unknown[];
-  /** Optional rehype plugins to add to the MDX pipeline (requires 'mdx:rehype' permission) */
-  rehypePlugins?: unknown[];
-  /** Optional Vite plugins to inject into the build process (requires 'vite:config' permission) */
-  vitePlugins?: Plugin[];
-  /** Optional custom React components to register in MDX. Map of Name -> Module Path. (requires 'components' permission) */
-  components?: Record<string, string>;
-  /** Implementation of lifecycle hooks (requires 'hooks:build' or 'hooks:dev' permissions) */
-  hooks?: PluginLifecycleHooks;
-}
-//#endregion
-//#region src/node/config.d.ts
+//#region src/shared/types.d.ts
 /**
  * Represents a single social link in the configuration.
  */
 interface BoltdocsSocialLink {
-  /** Identifier for the icon (e.g., 'github') */
   icon: 'discord' | 'x' | 'github' | 'bluesky' | string;
-  /** The URL the social link points to */
   link: string;
 }
 /**
  * Configuration for the site footer.
  */
 interface BoltdocsFooterConfig {
-  /** Text to display in the footer (HTML is supported) */
   text?: string;
 }
 /**
- * Theme-specific configuration options governing the appearance and navigation of the site.
+ * Theme-specific configuration options.
  */
 interface BoltdocsThemeConfig {
-  /** The global title of the documentation site (can be translated) */
   title?: string | Record<string, string>;
-  /** The global description of the site (can be translated) */
   description?: string | Record<string, string>;
-  /** URL path to the site logo or an object for light/dark versions */
   logo?: string | {
     dark: string;
     light: string;
@@ -128,190 +30,150 @@ interface BoltdocsThemeConfig {
     width?: number;
     height?: number;
   };
-  /** Items to display in the top navigation bar */
   navbar?: Array<{
-    /** Text to display (can be a string or a map of translations) */label: string | Record<string, string>; /** URL path or external link */
+    label: string | Record<string, string>;
     href: string;
   }>;
-  /** Items to display in the sidebar, organized optionally by group URLs */
   sidebar?: Record<string, Array<{
     text: string;
     link: string;
   }>>;
-  /** Social links to display in the navigation bar */
+  sidebarGroups?: Record<string, {
+    title?: string;
+    icon?: string;
+  }>;
   socialLinks?: BoltdocsSocialLink[];
-  /** Site footer configuration */
   footer?: BoltdocsFooterConfig;
-  /** Whether to show breadcrumbs navigation (default: true) */
   breadcrumbs?: boolean;
-  /** URL template for 'Edit this page'. Use :path as a placeholder. */
   editLink?: string;
-  /** URL for the 'Community help' link. */
   communityHelp?: string;
-  /** The current version of the project (e.g., 'v2.8.9'). Displayed in the Navbar. */
   version?: string;
-  /** The GitHub repository in the format 'owner/repo' to fetch and display star count. */
   githubRepo?: string;
-  /**
-   * URL path to the site favicon.
-   * If not specified, the logo will be used if available.
-   */
   favicon?: string;
-  /**
-   * The Open Graph image URL to display when the site is shared on social media.
-   */
-  ogImage?: string;
-  /** Whether to show the 'Powered by LiteDocs' badge in the sidebar (default: true) */
   poweredBy?: boolean;
-  /**
-   * Top-level tabs for organizing documentation groups.
-   * Tab discovery uses the (tab-id) directory syntax.
-   */
   tabs?: Array<{
-    id: string; /** Text to display (can be a string or a map of translations) */
+    id: string;
     text: string | Record<string, string>;
     icon?: string;
   }>;
-  /**
-   * The syntax highlighting theme for code blocks.
-   * Supports any Shiki theme name (e.g., 'github-dark', 'one-dark-pro', 'aurora-x').
-   * Can also be an object for multiple themes (e.g., { light: 'github-light', dark: 'github-dark' }).
-   * Default: { light: 'github-light', dark: 'one-dark-pro' }
-   */
-  codeTheme?: string | {
-    light: string;
-    dark: string;
+  codeTheme?: ShikiTheme | {
+    light: ShikiTheme;
+    dark: ShikiTheme;
   };
-  /**
-   * Configuration for the 'Copy Markdown' button.
-   * Can be a boolean or an object with text and icon.
-   * Default: true
-   */
   copyMarkdown?: boolean | {
     text?: string;
     icon?: string;
   };
 }
+/**
+ * List of supported syntax highlighting themes.
+ */
+type ShikiTheme = 'github-dark' | 'github-light' | 'tokyo-night' | 'dracula' | 'nord' | 'one-dark-pro' | 'one-light';
 /**
  * Configuration for the robots.txt file.
  */
 type BoltdocsRobotsConfig = string | {
-  /** User-agent rules */rules?: Array<{
-    userAgent: string; /** Paths allowed to be crawled */
-    allow?: string | string[]; /** Paths disallowed to be crawled */
+  rules?: Array<{
+    userAgent: string;
+    allow?: string | string[];
     disallow?: string | string[];
-  }>; /** Sitemaps to include in the robots.txt */
+  }>;
   sitemaps?: string[];
 };
 /**
  * Configuration for a specific locale.
  */
 interface BoltdocsLocaleConfig {
-  /** The display name of the locale */
   label?: string;
-  /** The text direction (ltr or rtl) */
   direction?: 'ltr' | 'rtl';
-  /** The HTML lang attribute value (e.g., 'en-US') */
   htmlLang?: string;
-  /** The calendar system to use (e.g., 'gregory') */
   calendar?: string;
 }
 /**
  * Configuration for internationalization (i18n).
  */
 interface BoltdocsI18nConfig {
-  /** The default locale (e.g., 'en') */
   defaultLocale: string;
-  /** Available locales and their basic display names (e.g., { en: 'English', es: 'Español' }) */
   locales: Record<string, string>;
-  /** Detailed configuration for each locale */
   localeConfigs?: Record<string, BoltdocsLocaleConfig>;
 }
 /**
  * Configuration for a specific documentation version.
  */
 interface BoltdocsVersionConfig {
-  /** The display name of the version (e.g., 'v2.0') */
   label: string;
-  /** The URL path prefix for the version (e.g., '2.0') */
   path: string;
 }
 /**
  * Configuration for documentation versioning.
  */
 interface BoltdocsVersionsConfig {
-  /** The default version path (e.g., 'v2') */
   defaultVersion: string;
-  /**
-   * Optional prefix for all version paths (e.g., 'v').
-   * If set to 'v', version '1.1' will be available at '/docs/v1.1'.
-   */
   prefix?: string;
-  /** Available versions configurations */
   versions: BoltdocsVersionConfig[];
 }
 /**
- * Defines a Boltdocs plugin that can extend the build process and client-side functionality.
+ * Defines a Boltdocs plugin.
  */
 interface BoltdocsPlugin {
-  /** A unique name for the plugin */
   name: string;
-  /** Whether to run this plugin before or after default ones (optional) */
   enforce?: 'pre' | 'post';
-  /** Version of the plugin (optional) */
   version?: string;
-  /** Minimum compatible Boltdocs version (optional, semver range) */
   boltdocsVersion?: string;
-  /** List of permissions this plugin requires to operate */
-  permissions?: PluginPermission[];
-  /** Optional remark plugins to add to the MDX pipeline */
+  permissions?: string[];
   remarkPlugins?: unknown[];
-  /** Optional rehype plugins to add to the MDX pipeline */
   rehypePlugins?: unknown[];
-  /** Optional Vite plugins to inject into the build process */
   vitePlugins?: Plugin[];
-  /** Optional custom React components to register in MDX. Map of Name -> Module Path. */
   components?: Record<string, string>;
-  /** Implementation of lifecycle hooks */
-  hooks?: PluginLifecycleHooks;
+  hooks?: Record<string, any>;
 }
 /**
  * Configuration for security-related settings.
  */
 interface BoltdocsSecurityConfig {
-  /** Map of standard security headers to override or supplement defaults */
   headers?: Record<string, string>;
-  /** Whether to enable Content Security Policy (CSP) generation (default: false) */
   enableCSP?: boolean;
-  /** Additional custom headers to inject into responses */
   customHeaders?: Record<string, string>;
 }
+/**
+ * Configuration for SEO.
+ */
+interface BoltdocsSeoConfig {
+  metatags?: Record<string, string>;
+  indexing?: 'all' | 'public';
+  thumbnails?: {
+    background?: string;
+  };
+}
 /**
  * The root configuration object for Boltdocs.
  */
 interface BoltdocsConfig {
-  /** The base URL of the site, used for generating the sitemap */
   siteUrl?: string;
-  /** The root directory containing markdown documentation files (default: 'docs') */
   docsDir?: string;
-  /** Path to a custom HomePage component */
+  base?: string;
   homePage?: string;
-  /** Configuration pertaining to the UI and appearance */
   theme?: BoltdocsThemeConfig;
-  /** Configuration for internationalization */
   i18n?: BoltdocsI18nConfig;
-  /** Configuration for documentation versioning */
   versions?: BoltdocsVersionsConfig;
-  /** Custom plugins for extending functionality */
   plugins?: BoltdocsPlugin[];
-  /** Configuration for the robots.txt file */
   robots?: BoltdocsRobotsConfig;
-  /** Security-related settings and headers */
   security?: BoltdocsSecurityConfig;
-  /** Low-level Vite configuration overrides */
-  vite?: _$vite.InlineConfig;
+  seo?: BoltdocsSeoConfig;
+  vite?: any;
 }
+//#endregion
+//#region src/shared/config-utils.d.ts
+/**
+ * Type-safe helper for defining Boltdocs configuration.
+ * This is an identity function that provides IntelliSense in both
+ * Node.js (config files) and client-side code (MDX examples).
+ *
+ * @param config - The Boltdocs configuration object
+ */
 declare function defineConfig(config: BoltdocsConfig): BoltdocsConfig;
+//#endregion
+//#region src/node/config.d.ts
 /**
  * Loads user's configuration file (e.g., `boltdocs.config.js` or `boltdocs.config.ts`) if it exists,
  * merges it with the default configuration, and returns the final `BoltdocsConfig`.
@@ -333,29 +195,16 @@ interface BoltdocsPluginOptions {
   homePage?: string;
 }
 //#endregion
-//#region src/node/ssg/options.d.ts
-/**
- * Options for the Static Site Generation process.
- */
-interface SSGOptions {
-  /** The root directory containing markdown documentation files */
-  docsDir: string;
-  /** The name of the documentation directory (e.g. 'docs') */
-  docsDirName: string;
-  /** The output directory where Vite placed the compiled `index.html` and assets */
-  outDir: string;
-  /** Pre-resolved config (avoids re-resolving during the SSG phase) */
-  config?: BoltdocsConfig;
-}
-//#endregion
-//#region src/node/ssg/index.d.ts
+//#region src/node/plugin/entry.d.ts
 /**
- * Generates static HTML files and a \`sitemap.xml\` for all documentation routes.
- * Called automatically in the \`closeBundle\` hook of the Vite plugin during a production build.
+ * Generates the raw source code for the virtual entry file (`\0virtual:boltdocs-entry`).
+ * This code initializes the client-side React application.
  *
- * @param options - Configuration for paths and site metadata
+ * @param options - Plugin options containing potential custom overrides (like `homePage` or `customCss`)
+ * @param config - The resolved Boltdocs configuration containing custom plugins and components
+ * @returns A string of JavaScript code to be evaluated by the browser
  */
-declare function generateStaticPages(options: SSGOptions): Promise<void>;
+declare function generateEntryCode(options: BoltdocsPluginOptions, config?: BoltdocsConfig): string;
 //#endregion
 //#region src/node/routes/types.d.ts
 /**
@@ -383,6 +232,8 @@ interface RouteMeta {
   groupPosition?: number;
   /** Optional icon for the route's group */
   groupIcon?: string;
+  /** The sub-route group this route belongs to (from folders starting with _) */
+  subRouteGroup?: string;
   /** Extracted markdown headings for search indexing */
   headings?: {
     level: number;
@@ -406,6 +257,100 @@ interface RouteMeta {
   _content?: string;
   /** The raw markdown content of the page */
   _rawContent?: string;
+  /** Extracted SEO and Open Graph metadata from frontmatter */
+  seo?: Record<string, any>;
+}
+//#endregion
+//#region src/node/plugins/plugin-types.d.ts
+/**
+ * Permissions that a plugin can request to access specific Boltdocs capabilities.
+ */
+type PluginPermission = 'fs:read' | 'fs:write' | 'vite:config' | 'mdx:remark' | 'mdx:rehype' | 'components' | 'hooks:build' | 'hooks:dev';
+/**
+ * Shared context injected into every plugin lifecycle hook.
+ */
+interface PluginContext {
+  /** The full, resolved Boltdocs configuration (Readonly) */
+  readonly config: BoltdocsConfig;
+  /** A plugin-specific logger */
+  readonly logger: PluginLogger;
+  /** A shared store for dependency injection and state sharing between plugins */
+  readonly store: PluginStore;
+  /** Metadata about the current plugin */
+  readonly meta: PluginMeta;
+}
+/**
+ * Simple logger interface for plugins.
+ */
+interface PluginLogger {
+  info(message: string): void;
+  warn(message: string): void;
+  error(message: string | Error): void;
+  debug(message: string): void;
+}
+/**
+ * A shared key-value store that allows plugins to share state and configuration.
+ */
+interface PluginStore {
+  /** Get a value from the store. Keys are namespaced by plugin internally. */
+  get<T = unknown>(pluginName: string, key: string): T | undefined;
+  /** Set a value in the store. */
+  set(pluginName: string, key: string, value: unknown): void;
+  /** Check if a key exists in the store. */
+  has(pluginName: string, key: string): boolean;
+}
+/**
+ * Metadata for a plugin, used for identification and compatibility checks.
+ */
+interface PluginMeta {
+  /** Unique identifier for the plugin */
+  name: string;
+  /** Version of the plugin itself (semver) */
+  version?: string;
+  /** Minimum required version of Boltdocs (semver range) */
+  boltdocsVersion?: string;
+}
+/**
+ * Lifecycle hooks that a plugin can implement to hook into the build and dev processes.
+ */
+interface PluginLifecycleHooks {
+  /** Called before the build process starts */
+  beforeBuild?: (ctx: PluginContext) => Promise<void> | void;
+  /** Called after the build process finishes successfully */
+  afterBuild?: (ctx: PluginContext) => Promise<void> | void;
+  /** Called before the dev server starts */
+  beforeDev?: (ctx: PluginContext) => Promise<void> | void;
+  /** Called after the dev server is ready (configureServer) */
+  afterDev?: (ctx: PluginContext) => Promise<void> | void;
+  /** Called when the final Boltdocs config is resolved */
+  configResolved?: (ctx: PluginContext, config: BoltdocsConfig) => void;
+  /** Called when the build is closing */
+  buildEnd?: (ctx: PluginContext) => Promise<void> | void;
+}
+/**
+ * The extended, secure Boltdocs plugin interface.
+ */
+interface SecureBoltdocsPlugin {
+  /** A unique name for the plugin (e.g., 'boltdocs-plugin-mermaid') */
+  name: string;
+  /** Whether to run this plugin before or after default ones */
+  enforce?: 'pre' | 'post';
+  /** Version of the plugin (optional, but recommended for security) */
+  version?: string;
+  /** Minimum compatible Boltdocs version (optional, semver range) */
+  boltdocsVersion?: string;
+  /** List of permissions this plugin requires to operate */
+  permissions?: PluginPermission[];
+  /** Optional remark plugins to add to the MDX pipeline (requires 'mdx:remark' permission) */
+  remarkPlugins?: unknown[];
+  /** Optional rehype plugins to add to the MDX pipeline (requires 'mdx:rehype' permission) */
+  rehypePlugins?: unknown[];
+  /** Optional Vite plugins to inject into the build process (requires 'vite:config' permission) */
+  vitePlugins?: Plugin[];
+  /** Optional custom React components to register in MDX. Map of Name -> Module Path. (requires 'components' permission) */
+  components?: Record<string, string>;
+  /** Implementation of lifecycle hooks (requires 'hooks:build' or 'hooks:dev' permissions) */
+  hooks?: PluginLifecycleHooks;
 }
 //#endregion
 //#region src/node/plugins/plugin-errors.d.ts
@@ -571,4 +516,4 @@ declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;
  */
 declare function createViteConfig(root: string, mode?: 'development' | 'production'): Promise<InlineConfig>;
 //#endregion
-export { type BoltdocsConfig, type BoltdocsPlugin, type BoltdocsPluginOptions, BoltdocsPluginStore, type BoltdocsThemeConfig, PluginCompatibilityError, PluginContext, PluginError, PluginHookError, PluginLifecycleHooks, PluginLifecycleManager, PluginLogger, PluginMeta, PluginPermission, PluginPermissionError, PluginSandbox, PluginStore, PluginValidationError, type RouteMeta, type SSGOptions, SecureBoltdocsPlugin, SecurePluginSchema, createPlugin, createViteConfig, boltdocs as default, defineConfig, generateStaticPages, hasPermission, resolveConfig, validatePlugins };
+export { type BoltdocsConfig, type BoltdocsPlugin, type BoltdocsPluginOptions, BoltdocsPluginStore, type BoltdocsThemeConfig, PluginCompatibilityError, PluginContext, PluginError, PluginHookError, PluginLifecycleHooks, PluginLifecycleManager, PluginLogger, PluginMeta, PluginPermission, PluginPermissionError, PluginSandbox, PluginStore, PluginValidationError, type RouteMeta, SecureBoltdocsPlugin, SecurePluginSchema, createPlugin, createViteConfig, boltdocs as default, defineConfig, generateEntryCode, hasPermission, resolveConfig, validatePlugins };