boltdocs 1.11.0 → 2.0.0

package/dist/client/index.d.mts

@@ -0,0 +1,212 @@
+import { B as BoltdocsConfig } from '../config-CX4l-ZNp.mjs';
+export { a as BoltdocsThemeConfig } from '../config-CX4l-ZNp.mjs';
+import { a as CreateBoltdocsAppOptions, C as ComponentRoute, O as OnThisPageProps, S as SandboxOptions } from '../types-CvT-SGbK.mjs';
+export { L as LayoutProps, b as SandboxEmbedOptions, c as SandboxFile, d as SandboxFiles } from '../types-CvT-SGbK.mjs';
+export { u as useRoutes } from '../use-routes-5bAtAAYX.mjs';
+import * as React$1 from 'react';
+import React__default, { Component, ReactNode, ErrorInfo } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+export { Admonition, AdmonitionProps, Badge, BadgeProps, Button, ButtonProps, Card, CardProps, Cards, CardsProps, Caution, CodeBlock, ComponentPreview, ComponentPreviewProps, ComponentProps, ComponentPropsProps, CopyMarkdown, Danger, Field, FieldProps, FileTree, FileTreeProps, Image, ImageProps, Important, InfoBox, Link, LinkProps, List, ListProps, Note, Tab, TabProps, Table, TableProps, Tabs, TabsProps, Tip, Video, Warning } from './components/mdx/index.mjs';
+import 'vite';
+import 'class-variance-authority/types';
+import 'react-aria-components';
+import 'class-variance-authority';
+
+/**
+ * Creates and mounts the Boltdocs documentation app.
+ *
+ * Usage:
+ * ```tsx
+ * import { createBoltdocsApp } from 'boltdocs/client'
+ * import routes from 'virtual:boltdocs-routes'
+ * import config from 'virtual:boltdocs-config'
+ * import 'boltdocs/style.css'
+ * import HomePage from './HomePage'
+ *
+ * createBoltdocsApp({
+ *   target: '#root',
+ *   routes,
+ *   config,
+ *   modules: import.meta.glob('/docs/**\/*.{md,mdx}'),
+ *   hot: import.meta.hot,
+ *   homePage: HomePage,
+ * })
+ * ```
+ */
+declare function createBoltdocsApp(options: CreateBoltdocsAppOptions): void;
+
+/**
+ * Hook to access the Boltdocs configuration.
+ */
+declare function useConfig(): BoltdocsConfig;
+
+type Theme = 'light' | 'dark';
+interface ThemeContextType {
+    theme: Theme;
+    toggleTheme: () => void;
+    setTheme: (theme: Theme) => void;
+}
+declare function useTheme(): ThemeContextType;
+
+type MdxComponentsType = Record<string, React__default.ComponentType<any>>;
+declare function useMdxComponents(): MdxComponentsType;
+
+/**
+ * Props shared by all layout slot components.
+ */
+interface SlotProps {
+    children?: React__default.ReactNode;
+    className?: string;
+    style?: React__default.CSSProperties;
+}
+/**
+ * Root layout shell. Renders a full-height flex column.
+ *
+ * Usage:
+ * ```tsx
+ * <DocsLayout>
+ *   <Navbar />
+ *   <DocsLayout.Body>...</DocsLayout.Body>
+ * </DocsLayout>
+ * ```
+ */
+declare function DocsLayoutRoot({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Horizontal flex container for sidebar + content + toc.
+ */
+declare function Body({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Main scrollable content area.
+ */
+declare function Content({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Content header row (breadcrumbs + copy markdown).
+ */
+declare function ContentHeader({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Footer area inside the content section (page nav).
+ */
+declare function ContentFooter({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+declare const DocsLayout: typeof DocsLayoutRoot & {
+    Body: typeof Body;
+    Content: typeof Content;
+    ContentHeader: typeof ContentHeader;
+    ContentFooter: typeof ContentFooter;
+};
+
+interface LayoutProps {
+    children: React.ReactNode;
+}
+/**
+ * The built-in default layout for Boltdocs.
+ * Users who create their own `layout.tsx` can import the same building blocks
+ * and rearrange, wrap, or replace any section.
+ */
+declare function DefaultLayout({ children }: LayoutProps): react_jsx_runtime.JSX.Element;
+
+declare function Navbar(): react_jsx_runtime.JSX.Element;
+
+declare function Sidebar({ routes, config, }: {
+    routes: ComponentRoute[];
+    config: BoltdocsConfig;
+}): react_jsx_runtime.JSX.Element;
+
+declare function OnThisPage({ headings: rawHeadings, editLink, communityHelp, filePath, }: OnThisPageProps): react_jsx_runtime.JSX.Element | null;
+
+interface HeadProps {
+    siteTitle: string;
+    siteDescription?: string;
+    routes: Array<{
+        path: string;
+        title: string;
+        description?: string;
+    }>;
+}
+declare function Head({ siteTitle, siteDescription, routes }: HeadProps): null;
+
+declare function Breadcrumbs(): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * Component to display the previous and next page navigation buttons.
+ */
+declare function PageNav(): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * A reading progress bar component that tracks the scroll position
+ * within the Boltdocs content area.
+ *
+ * It utilizes react-aria-components for accessibility and is fixed
+ * to the top of the viewport for a premium, non-intrusive UI experience.
+ */
+declare function ProgressBar(): react_jsx_runtime.JSX.Element;
+
+interface Props {
+    children?: ReactNode;
+    fallback?: ReactNode;
+}
+interface State {
+    hasError: boolean;
+    error?: Error;
+}
+declare class ErrorBoundary extends Component<Props, State> {
+    state: State;
+    static getDerivedStateFromError(error: Error): State;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
+}
+
+declare function NotFound(): react_jsx_runtime.JSX.Element;
+
+/**
+ * A premium loading component that includes an SVG fill animation
+ * and a synchronized progress indicator.
+ *
+ * It features a glassmorphism container and a Bolt-style SVG logo
+ * with a dynamic fill effect.
+ */
+declare function Loading(): react_jsx_runtime.JSX.Element;
+
+/**
+ * Helper to define a sandbox and get a URL for the CodeSandbox Define API.
+ * Uses the official SDK `getParameters` for proper LZ-string compression.
+ */
+declare function defineSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
+/**
+ * CORE API: Open a CodeSandbox using a form POST to the Define API.
+ *
+ * Uses a hidden form + POST which avoids URL length limits and is the
+ * recommended approach from CodeSandbox documentation. The SDK's
+ * `getParameters` handles LZ-string compression internally.
+ */
+declare function openSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
+/**
+ * Generate an embeddable iframe URL for a CodeSandbox.
+ *
+ * This gives you more control than `openSandbox` — you can embed the sandbox
+ * inline on the page rather than opening a new tab. The returned URL can be
+ * used as the `src` of an `<iframe>`.
+ *
+ * @example
+ * ```tsx
+ * const url = embedSandbox({
+ *   files: { "index.js": { content: "console.log('hello')" } },
+ *   embed: { view: "editor", theme: "dark" },
+ * }).url;
+ * // url → "https://codesandbox.io/api/v1/sandboxes/define?parameters=…&embed=1&view=editor&theme=dark"
+ * ```
+ */
+declare function embedSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
+
+export { BoltdocsConfig, Breadcrumbs, ComponentRoute, CreateBoltdocsAppOptions, DefaultLayout, DocsLayout, ErrorBoundary, Head, Loading, Navbar, NotFound, OnThisPage, PageNav, ProgressBar, SandboxOptions, Sidebar, createBoltdocsApp, defineSandbox, embedSandbox, openSandbox, useConfig, useMdxComponents, useTheme };

package/dist/client/index.d.ts

@@ -0,0 +1,212 @@
+import { B as BoltdocsConfig } from '../config-CX4l-ZNp.js';
+export { a as BoltdocsThemeConfig } from '../config-CX4l-ZNp.js';
+import { a as CreateBoltdocsAppOptions, C as ComponentRoute, O as OnThisPageProps, S as SandboxOptions } from '../types-BuZWFT7r.js';
+export { L as LayoutProps, b as SandboxEmbedOptions, c as SandboxFile, d as SandboxFiles } from '../types-BuZWFT7r.js';
+export { u as useRoutes } from '../use-routes-BefRXY3v.js';
+import * as React$1 from 'react';
+import React__default, { Component, ReactNode, ErrorInfo } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+export { Admonition, AdmonitionProps, Badge, BadgeProps, Button, ButtonProps, Card, CardProps, Cards, CardsProps, Caution, CodeBlock, ComponentPreview, ComponentPreviewProps, ComponentProps, ComponentPropsProps, CopyMarkdown, Danger, Field, FieldProps, FileTree, FileTreeProps, Image, ImageProps, Important, InfoBox, Link, LinkProps, List, ListProps, Note, Tab, TabProps, Table, TableProps, Tabs, TabsProps, Tip, Video, Warning } from './components/mdx/index.js';
+import 'vite';
+import 'class-variance-authority/types';
+import 'react-aria-components';
+import 'class-variance-authority';
+
+/**
+ * Creates and mounts the Boltdocs documentation app.
+ *
+ * Usage:
+ * ```tsx
+ * import { createBoltdocsApp } from 'boltdocs/client'
+ * import routes from 'virtual:boltdocs-routes'
+ * import config from 'virtual:boltdocs-config'
+ * import 'boltdocs/style.css'
+ * import HomePage from './HomePage'
+ *
+ * createBoltdocsApp({
+ *   target: '#root',
+ *   routes,
+ *   config,
+ *   modules: import.meta.glob('/docs/**\/*.{md,mdx}'),
+ *   hot: import.meta.hot,
+ *   homePage: HomePage,
+ * })
+ * ```
+ */
+declare function createBoltdocsApp(options: CreateBoltdocsAppOptions): void;
+
+/**
+ * Hook to access the Boltdocs configuration.
+ */
+declare function useConfig(): BoltdocsConfig;
+
+type Theme = 'light' | 'dark';
+interface ThemeContextType {
+    theme: Theme;
+    toggleTheme: () => void;
+    setTheme: (theme: Theme) => void;
+}
+declare function useTheme(): ThemeContextType;
+
+type MdxComponentsType = Record<string, React__default.ComponentType<any>>;
+declare function useMdxComponents(): MdxComponentsType;
+
+/**
+ * Props shared by all layout slot components.
+ */
+interface SlotProps {
+    children?: React__default.ReactNode;
+    className?: string;
+    style?: React__default.CSSProperties;
+}
+/**
+ * Root layout shell. Renders a full-height flex column.
+ *
+ * Usage:
+ * ```tsx
+ * <DocsLayout>
+ *   <Navbar />
+ *   <DocsLayout.Body>...</DocsLayout.Body>
+ * </DocsLayout>
+ * ```
+ */
+declare function DocsLayoutRoot({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Horizontal flex container for sidebar + content + toc.
+ */
+declare function Body({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Main scrollable content area.
+ */
+declare function Content({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Content header row (breadcrumbs + copy markdown).
+ */
+declare function ContentHeader({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Footer area inside the content section (page nav).
+ */
+declare function ContentFooter({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+declare const DocsLayout: typeof DocsLayoutRoot & {
+    Body: typeof Body;
+    Content: typeof Content;
+    ContentHeader: typeof ContentHeader;
+    ContentFooter: typeof ContentFooter;
+};
+
+interface LayoutProps {
+    children: React.ReactNode;
+}
+/**
+ * The built-in default layout for Boltdocs.
+ * Users who create their own `layout.tsx` can import the same building blocks
+ * and rearrange, wrap, or replace any section.
+ */
+declare function DefaultLayout({ children }: LayoutProps): react_jsx_runtime.JSX.Element;
+
+declare function Navbar(): react_jsx_runtime.JSX.Element;
+
+declare function Sidebar({ routes, config, }: {
+    routes: ComponentRoute[];
+    config: BoltdocsConfig;
+}): react_jsx_runtime.JSX.Element;
+
+declare function OnThisPage({ headings: rawHeadings, editLink, communityHelp, filePath, }: OnThisPageProps): react_jsx_runtime.JSX.Element | null;
+
+interface HeadProps {
+    siteTitle: string;
+    siteDescription?: string;
+    routes: Array<{
+        path: string;
+        title: string;
+        description?: string;
+    }>;
+}
+declare function Head({ siteTitle, siteDescription, routes }: HeadProps): null;
+
+declare function Breadcrumbs(): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * Component to display the previous and next page navigation buttons.
+ */
+declare function PageNav(): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * A reading progress bar component that tracks the scroll position
+ * within the Boltdocs content area.
+ *
+ * It utilizes react-aria-components for accessibility and is fixed
+ * to the top of the viewport for a premium, non-intrusive UI experience.
+ */
+declare function ProgressBar(): react_jsx_runtime.JSX.Element;
+
+interface Props {
+    children?: ReactNode;
+    fallback?: ReactNode;
+}
+interface State {
+    hasError: boolean;
+    error?: Error;
+}
+declare class ErrorBoundary extends Component<Props, State> {
+    state: State;
+    static getDerivedStateFromError(error: Error): State;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
+}
+
+declare function NotFound(): react_jsx_runtime.JSX.Element;
+
+/**
+ * A premium loading component that includes an SVG fill animation
+ * and a synchronized progress indicator.
+ *
+ * It features a glassmorphism container and a Bolt-style SVG logo
+ * with a dynamic fill effect.
+ */
+declare function Loading(): react_jsx_runtime.JSX.Element;
+
+/**
+ * Helper to define a sandbox and get a URL for the CodeSandbox Define API.
+ * Uses the official SDK `getParameters` for proper LZ-string compression.
+ */
+declare function defineSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
+/**
+ * CORE API: Open a CodeSandbox using a form POST to the Define API.
+ *
+ * Uses a hidden form + POST which avoids URL length limits and is the
+ * recommended approach from CodeSandbox documentation. The SDK's
+ * `getParameters` handles LZ-string compression internally.
+ */
+declare function openSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
+/**
+ * Generate an embeddable iframe URL for a CodeSandbox.
+ *
+ * This gives you more control than `openSandbox` — you can embed the sandbox
+ * inline on the page rather than opening a new tab. The returned URL can be
+ * used as the `src` of an `<iframe>`.
+ *
+ * @example
+ * ```tsx
+ * const url = embedSandbox({
+ *   files: { "index.js": { content: "console.log('hello')" } },
+ *   embed: { view: "editor", theme: "dark" },
+ * }).url;
+ * // url → "https://codesandbox.io/api/v1/sandboxes/define?parameters=…&embed=1&view=editor&theme=dark"
+ * ```
+ */
+declare function embedSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
+
+export { BoltdocsConfig, Breadcrumbs, ComponentRoute, CreateBoltdocsAppOptions, DefaultLayout, DocsLayout, ErrorBoundary, Head, Loading, Navbar, NotFound, OnThisPage, PageNav, ProgressBar, SandboxOptions, Sidebar, createBoltdocsApp, defineSandbox, embedSandbox, openSandbox, useConfig, useMdxComponents, useTheme };