boltdocs 2.5.5 → 2.6.0

package/dist/node/index.d.cts

@@ -0,0 +1,519 @@
+
+import * as _$vite from "vite";
+import { InlineConfig, Plugin } from "vite";
+import { z } from "zod";
+
+//#region src/shared/types.d.ts
+/**
+ * Represents a single social link in the configuration.
+ */
+interface BoltdocsSocialLink {
+  icon: 'discord' | 'x' | 'github' | 'bluesky' | string;
+  link: string;
+}
+/**
+ * Configuration for the site footer.
+ */
+interface BoltdocsFooterConfig {
+  text?: string;
+}
+/**
+ * Theme-specific configuration options.
+ */
+interface BoltdocsThemeConfig {
+  title?: string | Record<string, string>;
+  description?: string | Record<string, string>;
+  logo?: string | {
+    dark: string;
+    light: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+  };
+  navbar?: Array<{
+    label: string | Record<string, string>;
+    href: string;
+  }>;
+  sidebar?: Record<string, Array<{
+    text: string;
+    link: string;
+  }>>;
+  sidebarGroups?: Record<string, {
+    title?: string;
+    icon?: string;
+  }>;
+  socialLinks?: BoltdocsSocialLink[];
+  footer?: BoltdocsFooterConfig;
+  breadcrumbs?: boolean;
+  editLink?: string;
+  communityHelp?: string;
+  version?: string;
+  githubRepo?: string;
+  favicon?: string;
+  poweredBy?: boolean;
+  tabs?: Array<{
+    id: string;
+    text: string | Record<string, string>;
+    icon?: string;
+  }>;
+  codeTheme?: ShikiTheme | {
+    light: ShikiTheme;
+    dark: ShikiTheme;
+  };
+  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 | {
+  rules?: Array<{
+    userAgent: string;
+    allow?: string | string[];
+    disallow?: string | string[];
+  }>;
+  sitemaps?: string[];
+};
+/**
+ * Configuration for a specific locale.
+ */
+interface BoltdocsLocaleConfig {
+  label?: string;
+  direction?: 'ltr' | 'rtl';
+  htmlLang?: string;
+  calendar?: string;
+}
+/**
+ * Configuration for internationalization (i18n).
+ */
+interface BoltdocsI18nConfig {
+  defaultLocale: string;
+  locales: Record<string, string>;
+  localeConfigs?: Record<string, BoltdocsLocaleConfig>;
+}
+/**
+ * Configuration for a specific documentation version.
+ */
+interface BoltdocsVersionConfig {
+  label: string;
+  path: string;
+}
+/**
+ * Configuration for documentation versioning.
+ */
+interface BoltdocsVersionsConfig {
+  defaultVersion: string;
+  prefix?: string;
+  versions: BoltdocsVersionConfig[];
+}
+/**
+ * Defines a Boltdocs plugin.
+ */
+interface BoltdocsPlugin {
+  name: string;
+  enforce?: 'pre' | 'post';
+  version?: string;
+  boltdocsVersion?: string;
+  permissions?: string[];
+  remarkPlugins?: unknown[];
+  rehypePlugins?: unknown[];
+  vitePlugins?: Plugin[];
+  components?: Record<string, string>;
+  hooks?: Record<string, any>;
+}
+/**
+ * Configuration for security-related settings.
+ */
+interface BoltdocsSecurityConfig {
+  headers?: Record<string, string>;
+  enableCSP?: boolean;
+  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 {
+  siteUrl?: string;
+  docsDir?: string;
+  base?: string;
+  homePage?: string;
+  theme?: BoltdocsThemeConfig;
+  i18n?: BoltdocsI18nConfig;
+  versions?: BoltdocsVersionsConfig;
+  plugins?: BoltdocsPlugin[];
+  robots?: BoltdocsRobotsConfig;
+  security?: BoltdocsSecurityConfig;
+  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`.
+ *
+ * @param docsDir - The directory containing the documentation files
+ * @param root - The project root directory (defaults to process.cwd())
+ * @returns The merged configuration object
+ */
+declare function resolveConfig(docsDir: string, root?: string): Promise<BoltdocsConfig>;
+//#endregion
+//#region src/node/plugin/types.d.ts
+/**
+ * Configuration options specifically for the Boltdocs Vite plugin.
+ */
+interface BoltdocsPluginOptions {
+  /** The root directory containing markdown files (default: 'docs') */
+  docsDir?: string;
+  /** Path to a custom home page component (relative to project root) to render at '/' */
+  homePage?: string;
+}
+//#endregion
+//#region src/node/plugin/entry.d.ts
+/**
+ * Generates the raw source code for the virtual entry file (`\0virtual:boltdocs-entry`).
+ * This code initializes the client-side React application.
+ *
+ * @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 generateEntryCode(options: BoltdocsPluginOptions, config?: BoltdocsConfig): string;
+//#endregion
+//#region src/node/routes/types.d.ts
+/**
+ * Metadata representing a single documentation route.
+ * This information is used to build the client-side router and the sidebar navigation.
+ */
+interface RouteMeta {
+  /** The final URL path for the route (e.g., '/docs/guide/start') */
+  path: string;
+  /** The absolute filesystem path to the source markdown/mdx file */
+  componentPath: string;
+  /** The title of the page, usually extracted from frontmatter or the filename */
+  title: string;
+  /** The relative path from the docs directory, used for edit links */
+  filePath: string;
+  /** Optional description of the page (for SEO/meta tags) */
+  description?: string;
+  /** Optional explicit position for ordering in the sidebar */
+  sidebarPosition?: number;
+  /** The group (directory) this route belongs to */
+  group?: string;
+  /** The display title for the route's group */
+  groupTitle?: string;
+  /** Optional explicit position for ordering the group itself */
+  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;
+    text: string;
+    id: string;
+  }[];
+  /** The locale this route belongs to, if i18n is configured */
+  locale?: string;
+  /** The version this route belongs to, if versioning is configured */
+  version?: string;
+  /** Optional badge to display next to the sidebar item (e.g., 'New', 'Experimental') */
+  badge?: string | {
+    text: string;
+    expires?: string;
+  };
+  /** Optional icon to display (Lucide icon name or raw SVG) */
+  icon?: string;
+  /** The tab this route belongs to, if tabs are configured */
+  tab?: string;
+  /** The extracted plain-text content of the page for search indexing */
+  _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
+/**
+ * Base class for all plugin-related errors in Boltdocs.
+ */
+declare class PluginError extends Error {
+  readonly pluginName: string;
+  constructor(pluginName: string, message: string);
+}
+/**
+ * Specifically for schema or structure validation failures.
+ */
+declare class PluginValidationError extends PluginError {
+  constructor(pluginName: string, message: string);
+}
+/**
+ * Specifically for version mismatch or compatibility issues.
+ */
+declare class PluginCompatibilityError extends PluginError {
+  constructor(pluginName: string, message: string);
+}
+/**
+ * Specifically for attempts to use capabilities without proper permissions.
+ */
+declare class PluginPermissionError extends PluginError {
+  constructor(pluginName: string, permission: string);
+}
+/**
+ * Specifically for errors that occur during the execution of a lifecycle hook.
+ */
+declare class PluginHookError extends PluginError {
+  readonly hookName: string;
+  constructor(pluginName: string, hookName: string, originalError: Error);
+}
+//#endregion
+//#region src/node/plugins/plugin-store.d.ts
+/**
+ * Implementation of the shared plugin store.
+ * Uses a namespaced approach to prevent key collisions between plugins.
+ */
+declare class BoltdocsPluginStore implements PluginStore {
+  private data;
+  /**
+   * Internal helper to create a namespaced key.
+   */
+  private getNamespaceKey;
+  /**
+   * Retrieves a value from the store. Returns a deep clone to prevent mutations (side-effects).
+   */
+  get<T = unknown>(pluginName: string, key: string): T | undefined;
+  /**
+   * Stores a value in the store. Key is automatically namespaced.
+   */
+  set(pluginName: string, key: string, value: unknown): void;
+  /**
+   * Checks for the existence of a key in the store.
+   */
+  has(pluginName: string, key: string): boolean;
+}
+//#endregion
+//#region src/node/plugins/plugin-validator.d.ts
+/**
+ * Enhanced Zod schema for secure plugins.
+ */
+declare const SecurePluginSchema: z.ZodObject<{
+  name: z.ZodString;
+  enforce: z.ZodOptional<z.ZodEnum<{
+    pre: "pre";
+    post: "post";
+  }>>;
+  remarkPlugins: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+  rehypePlugins: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+  vitePlugins: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+  components: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  version: z.ZodOptional<z.ZodString>;
+  boltdocsVersion: z.ZodOptional<z.ZodString>;
+  permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  hooks: z.ZodOptional<z.ZodObject<{
+    beforeBuild: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+    afterBuild: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+    beforeDev: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+    afterDev: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+    configResolved: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+    buildEnd: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Validates a list of plugins for correctness, security, and compatibility.
+ */
+declare function validatePlugins(plugins: any[], boltdocsVersion: string): SecureBoltdocsPlugin[];
+/**
+ * Helper to check if a specific permission is granted to a plugin.
+ */
+declare function hasPermission(plugin: SecureBoltdocsPlugin, permission: PluginPermission): boolean;
+//#endregion
+//#region src/node/plugins/plugin-sandbox.d.ts
+/**
+ * The Sandbox provides a protective layer that ensures plugins only use
+ * the capabilities they have explicitly requested permissions for.
+ */
+declare class PluginSandbox {
+  /**
+   * Validates if a plugin has the required permission for a capability.
+   * Throws a PluginPermissionError if not granted.
+   */
+  static checkPermission(plugin: SecureBoltdocsPlugin, permission: PluginPermission): void;
+  /**
+   * Filters a plugin's capabilities based on its declared permissions.
+   * This is used when aggregating plugins (remark, rehype, vite, components).
+   */
+  static getSanitizedCapabilities(plugin: SecureBoltdocsPlugin): {
+    remarkPlugins: unknown[] | undefined;
+    rehypePlugins: unknown[] | undefined;
+    vitePlugins: _$vite.Plugin<any>[] | undefined;
+    components: Record<string, string> | undefined;
+  };
+  /**
+   * Wraps a hook execution with permission checks and error isolation.
+   */
+  static executeWithIsolation<T>(plugin: SecureBoltdocsPlugin, requiredPermission: PluginPermission, hookName: string, action: () => Promise<T> | T): Promise<T | undefined>;
+}
+//#endregion
+//#region src/node/plugins/plugin-lifecycle.d.ts
+/**
+ * Manages the lifecycle of all loaded plugins, ensuring hooks are executed
+ * in the correct order with proper error isolation and context.
+ */
+declare class PluginLifecycleManager {
+  private plugins;
+  private config;
+  private store;
+  constructor(plugins: SecureBoltdocsPlugin[], config: BoltdocsConfig);
+  /**
+   * Runs a specific hook for all plugins that implement it.
+   */
+  runHook(hookName: keyof PluginLifecycleHooks, ...args: any[]): Promise<void>;
+  /**
+   * Sorts plugins based on their 'enforce' property (pre -> normal -> post).
+   */
+  private getSortedPlugins;
+  /**
+   * Creates a specialized context for a plugin.
+   */
+  private createContext;
+  /**
+   * Creates a namespaced logger for a plugin.
+   */
+  private createLogger;
+}
+//#endregion
+//#region src/node/plugins/index.d.ts
+/**
+ * Utility to create a Boltdocs plugin with full type safety.
+ */
+declare function createPlugin(plugin: SecureBoltdocsPlugin): SecureBoltdocsPlugin;
+//#endregion
+//#region src/node/index.d.ts
+declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;
+/**
+ * Generates the complete Vite configuration for a Boltdocs project.
+ * This is used by the Boltdocs CLI to run Vite without a user-defined vite.config.ts.
+ */
+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, SecureBoltdocsPlugin, SecurePluginSchema, createPlugin, createViteConfig, boltdocs as default, defineConfig, generateEntryCode, hasPermission, resolveConfig, validatePlugins };