boltdocs 2.5.5 → 2.5.6

package/dist/node/index.d.ts

@@ -1,567 +0,0 @@
-import * as vite from 'vite';
-import { Plugin, InlineConfig } from 'vite';
-import { z } from 'zod';
-
-/**
- * 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;
-}
-
-/**
- * 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.
- */
-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;
-        alt?: string;
-        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 */
-        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 */
-    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) */
-        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;
-    };
-    /**
-     * 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;
-    };
-}
-/**
- * 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 */
-        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.
- */
-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 */
-    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;
-}
-/**
- * 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>;
-}
-/**
- * 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 */
-    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;
-}
-declare function defineConfig(config: BoltdocsConfig): BoltdocsConfig;
-/**
- * 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>;
-
-/**
- * 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;
-}
-
-/**
- * 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;
-}
-
-/**
- * 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.
- *
- * @param options - Configuration for paths and site metadata
- */
-declare function generateStaticPages(options: SSGOptions): Promise<void>;
-
-/**
- * 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;
-    /** 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;
-}
-
-/**
- * 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);
-}
-
-/**
- * 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;
-}
-
-/**
- * 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;
-
-/**
- * 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>;
-}
-
-/**
- * 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;
-}
-
-/**
- * Utility to create a Boltdocs plugin with full type safety.
- */
-declare function createPlugin(plugin: SecureBoltdocsPlugin): SecureBoltdocsPlugin;
-
-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>;
-
-export { type BoltdocsConfig, type BoltdocsPlugin, type BoltdocsPluginOptions, BoltdocsPluginStore, type BoltdocsThemeConfig, PluginCompatibilityError, type PluginContext, PluginError, PluginHookError, type PluginLifecycleHooks, PluginLifecycleManager, type PluginLogger, type PluginMeta, type PluginPermission, PluginPermissionError, PluginSandbox, type PluginStore, PluginValidationError, type RouteMeta, type SSGOptions, type SecureBoltdocsPlugin, SecurePluginSchema, createPlugin, createViteConfig, boltdocs as default, defineConfig, generateStaticPages, hasPermission, resolveConfig, validatePlugins };