boltdocs 3.2.2 → 3.3.0

package/dist/index-Cu9H6CRa.d.ts

@@ -0,0 +1,1344 @@
+
+import { Q as CreateRoutesResult, _t as StructuredData$1, ct as BoltdocsIntegrationsConfig, ft as BoltdocsRoutePathWithFallback, gt as JsonLdObject, ht as BoltdocsVersion, lt as BoltdocsLocale, ot as BadgeValue, pt as BoltdocsSocialLink, st as BoltdocsConfig, ut as BoltdocsMdxComponents } from "./index-Ci4kfOHF.js";
+import { ViteReactSSG } from "@bdocs/ssg";
+import * as React$2 from "react";
+import React$1, { ComponentType, JSXElementConstructor, ReactNode, SVGProps } from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+import { ClassValue } from "clsx";
+
+//#region src/client/types.d.ts
+/**
+ * Metadata provided by the server for a specific route.
+ * Maps closely to the `RouteMeta` type in the Node environment.
+ */
+interface ComponentRoute {
+  /** The final URL path */
+  path: string;
+  /** The absolute filesystem path of the source file */
+  componentPath: string;
+  /** The page title */
+  title: string;
+  /** Explicit order in the sidebar */
+  sidebarPosition?: number;
+  /** The relative path from the docs directory */
+  filePath: string;
+  /** The group directory name */
+  group?: string;
+  /** The display title of the group */
+  groupTitle?: string;
+  /** Explicit order of the group in the sidebar */
+  groupPosition?: number;
+  /** Extracted markdown headings for search indexing */
+  headings?: {
+    level: number;
+    text: string;
+    id: string;
+  }[];
+  /** The page summary or description */
+  description?: 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 icon to display (Lucide icon name or raw SVG) */
+  icon?: string;
+  /** The tab this route belongs to, if tabs are configured */
+  tab?: string;
+  /** Optional badge to display next to the sidebar item */
+  badge?: BadgeValue;
+  /** Optional icon for the route's group */
+  groupIcon?: string;
+  /** The sub-route group this route belongs to (from folders starting with _) */
+  subRouteGroup?: string;
+  /** The nested sub-routes if this route acts as the parent of a subRouteGroup */
+  subRoutes?: ComponentRoute[];
+  /** Internal helper map for nesting routes during sidebar construction */
+  _subMap?: Map<string, ComponentRoute>;
+  /** The extracted plain-text content of the page for search indexing */
+  _content?: string;
+  /** The raw markdown content of the page */
+  _rawContent?: string;
+  /** The publication date */
+  date?: string | Date;
+  /** The last updated timestamp or date */
+  lastUpdated?: string | number | Date;
+  /** The collection this route belongs to (from [name] directories) */
+  collection?: string;
+  /** Tags for blog posts */
+  tags?: string[];
+  /** Author identifier for blog posts */
+  author?: string | {
+    name: string;
+    avatar?: string;
+    url?: string;
+    image?: string;
+  };
+  /** Draft flag */
+  draft?: boolean;
+  /** Feature flags required for this page to be visible */
+  featureFlags?: string[];
+  /** Short excerpt for list displays */
+  excerpt?: string;
+  /** Cover image for blog posts */
+  coverImage?: string;
+  /** Optional explicit order (alternative to sidebarPosition) */
+  order?: number;
+  /** Optional explicit label for the sidebar */
+  sidebarLabel?: string;
+  /** Optional category for the page */
+  category?: string;
+  /** Whether the page is hidden from the sidebar */
+  sidebarHidden?: boolean;
+  /**
+   * Optional nested child routes for sidebar hierarchies that mirror the
+   * server-side `RouteMeta.subRoutes` shape. `sidebar.tsx` walks this
+   * field to render the group → subRoutes → items tree.
+   */
+  routes?: ComponentRoute[];
+  /** Raw extensible frontmatter data for custom components and formatters */
+  frontmatter?: Record<string, unknown>;
+  /** Clean URL segments stripped of locale/version prefixes */
+  slugParts?: string[];
+  /** SEO metadata for page headers */
+  seo?: Record<string, unknown>;
+  /** Flag to indicate if this is a fallback redirect route */
+  fallback?: boolean;
+}
+/**
+ * Site configuration provided by the server.
+ */
+type SiteConfig = BoltdocsConfig;
+/**
+ * Tab configuration for the documentation site.
+ */
+interface BoltdocsTab {
+  id: string;
+  /** Text to display (can be a string or a map of translations) */
+  text: string | Record<string, string>;
+  icon?: string;
+}
+/**
+ * Props for the Sidebar component.
+ */
+interface SidebarProps$1 {
+  routes: ComponentRoute[];
+  config: BoltdocsConfig;
+}
+/**
+ * Props for the OnThisPage (TOC) component.
+ */
+interface OnThisPageProps {
+  headings?: {
+    level: number;
+    text: string;
+    id: string;
+  }[];
+  editLink?: string;
+  communityHelp?: string;
+  filePath?: string;
+}
+/**
+ * Props for the Tabs component.
+ */
+interface TabsProps {
+  tabs: BoltdocsTab[];
+  routes: ComponentRoute[];
+}
+/**
+ * Props for user-defined layout components (layout.tsx).
+ */
+interface LayoutProps {
+  children: React$2.ReactNode;
+}
+/**
+ * Unified type for navbar links.
+ */
+interface NavbarLink {
+  label: string | Record<string, string>;
+  href: BoltdocsRoutePathWithFallback;
+  active: boolean;
+  to?: string;
+  items?: NavbarLink[];
+}
+/**
+ * Shape of the data returned by a collection post route loader.
+ * Consumed by `BlogPost` via `useLoaderData<CollectionPostLoaderData>()`.
+ */
+interface CollectionPostLoaderData {
+  /** Full route metadata for this post (title, date, author, tags, etc.) */
+  route: ComponentRoute;
+  /** The name of the collection this post belongs to (e.g. 'blog') */
+  collection: string;
+  /** Extracted page headings for the Table of Contents */
+  headings: {
+    level: number;
+    text: string;
+    id: string;
+  }[];
+}
+/**
+ * Shape of the data returned by a collection listing route loader.
+ * Consumed by `BlogList` via `useLoaderData<CollectionListLoaderData>()`.
+ */
+interface CollectionListLoaderData {
+  /** Paginated subset of posts to display on this page */
+  posts: Array<{
+    path: string;
+    title: string;
+    date?: string | Date;
+    excerpt?: string;
+    tags?: string[];
+    author?: string;
+    coverImage?: string;
+    filePath: string;
+  }>;
+  /** Total number of pages available */
+  totalPages: number;
+  /** Current page index (1-based) */
+  currentPage: number;
+  /** Collection name used to build pagination URLs (e.g. 'blog' → '/blog/page/2') */
+  collection: string;
+}
+//#endregion
+//#region src/client/collections/collections-context.d.ts
+interface CollectionPost$1 {
+  path: string;
+  title: string;
+  date?: string | Date;
+  excerpt?: string;
+  tags?: string[];
+  author?: string;
+  coverImage?: string;
+  filePath: string;
+  locale?: string;
+  version?: string;
+  frontmatter?: Record<string, any>;
+  lastUpdated?: string | number | Date;
+  headings?: {
+    level: number;
+    text: string;
+    id: string;
+  }[];
+  draft?: boolean;
+  /** Collection id this post belongs to (added by the server for HMR). */
+  collection?: string;
+}
+type CollectionsData = Record<string, CollectionPost$1[]>;
+declare const CollectionsContext: React$2.Context<CollectionsData>;
+interface CurrentPostContextValue {
+  route: ComponentRoute;
+  headings: {
+    level: number;
+    text: string;
+    id: string;
+  }[];
+  collection: string;
+}
+declare function CurrentPostProvider({
+  value,
+  children
+}: {
+  value: CurrentPostContextValue;
+  children: React.ReactNode;
+}): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/ssg/create-routes.d.ts
+interface CreateRoutesOptions {
+  routesData: ComponentRoute[];
+  collectionsData?: CollectionsData;
+  collectionLayouts?: Record<string, React$1.ComponentType<{
+    children: React$1.ReactNode;
+  }>>;
+  collectionLists?: Record<string, React$1.ComponentType>;
+  collectionPosts?: Record<string, React$1.ComponentType<any>>;
+  config: BoltdocsConfig;
+  mdxModules: Record<string, any>;
+  externalPages?: Record<string, React$1.ComponentType>;
+  externalLayout?: React$1.ComponentType<{
+    children: React$1.ReactNode;
+  }>;
+  externalFilePages?: Record<string, React$1.ComponentType>;
+  externalFileMdx?: Record<string, unknown>;
+  components?: Record<string, React$1.ComponentType>;
+}
+declare function createRoutes(options: CreateRoutesOptions): CreateRoutesResult;
+//#endregion
+//#region src/client/ssg/mdx-page.d.ts
+type MdxPageProps = {
+  MDXComponent: React.ComponentType<React.PropsWithChildren<unknown>>;
+  mdxComponents: Record<string, React.ComponentType<HTMLElement>>;
+  collectionPostComponent?: React.ComponentType<any>;
+};
+/**
+ * Renders an MDX page by consuming pre-loaded route data.
+ *
+ * - If the route belongs to a collection (`data.collection` is set), wraps
+ *   the content with `CurrentPostProvider` so that `usePost()` (called without
+ *   a slug) can read the current post's data from context.
+ * - Otherwise, renders the standard `DocPage` layout.
+ */
+declare function MdxPage({
+  MDXComponent,
+  mdxComponents: propComponents,
+  collectionPostComponent: CollectionPost
+}: MdxPageProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/ssg/boltdocs-shell.d.ts
+declare function BoltdocsShell({
+  config,
+  routes,
+  components,
+  collectionsData,
+  contentClassName
+}: {
+  config: BoltdocsConfig;
+  routes: ComponentRoute[];
+  components?: Record<string, React.ComponentType>;
+  collectionsData?: CollectionsData; /** Class name for the shell content frame (defaults to fixed viewport). */
+  contentClassName?: string;
+}): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/app/config-context.d.ts
+/**
+ * Hook to access the Boltdocs configuration.
+ */
+declare function useConfig(): BoltdocsConfig;
+//#endregion
+//#region src/client/app/theme-context.d.ts
+type Theme = 'light' | 'dark' | 'system';
+type ResolvedTheme = 'light' | 'dark';
+interface ThemeContextType {
+  theme: Theme;
+  resolvedTheme: ResolvedTheme;
+  setTheme: (theme: Theme) => void;
+}
+declare function useTheme(): ThemeContextType;
+//#endregion
+//#region src/client/app/mdx-components-context.d.ts
+type MdxComponentsType = {
+  [key: string]: ComponentType<any>;
+} & {
+  Frontmatter?: Record<string, ComponentType<{
+    value: unknown;
+  }>>;
+};
+declare function useMdxComponents(): BoltdocsMdxComponents;
+//#endregion
+//#region src/client/app/ui-context.d.ts
+declare function useUI(): {
+  isSidebarOpen: boolean;
+  toggleSidebar: () => void;
+  closeSidebar: () => void;
+};
+//#endregion
+//#region src/client/hooks/use-navbar.d.ts
+declare function useNavbar(): {
+  links: NavbarLink[];
+  title: string;
+  logo: string | null;
+  logoProps: {
+    alt: string;
+    width: number | undefined;
+    height: number | undefined;
+  };
+  github: string | null;
+  social: BoltdocsSocialLink[];
+  config: BoltdocsConfig;
+  theme: Theme;
+};
+//#endregion
+//#region src/client/hooks/use-sidebar.d.ts
+interface SidebarGroupData {
+  slug: string;
+  title: string;
+  icon?: string;
+  path: string;
+  filePath: string;
+  routes: ComponentRoute[];
+  sidebarPosition?: number;
+  collapsible?: boolean;
+  collapsed?: boolean;
+}
+type MergedSidebarItem = {
+  type: 'link';
+  position: number;
+  title: string;
+  route: ComponentRoute;
+} | {
+  type: 'group';
+  position: number;
+  title: string;
+  group: SidebarGroupData;
+};
+interface SidebarNode {
+  route: ComponentRoute;
+  depth: number;
+  isGroup: boolean;
+  isActive: boolean;
+  hasChildren: boolean;
+  children: SidebarNode[];
+}
+declare function useSidebar(routes: ComponentRoute[]): {
+  tree: SidebarNode[];
+  isActive: (route: ComponentRoute) => boolean;
+  isGroupActive: (group: SidebarGroupData) => boolean;
+  activeRoute: ComponentRoute | undefined;
+  activePath: string;
+  config: BoltdocsConfig;
+  groups: SidebarGroupData[];
+  ungrouped: ComponentRoute[];
+  merged: MergedSidebarItem[];
+};
+//#endregion
+//#region src/client/hooks/use-search.d.ts
+declare function useSearch(routes: ComponentRoute[]): {
+  isOpen: boolean;
+  setIsOpen: React$2.Dispatch<React$2.SetStateAction<boolean>>;
+  query: string;
+  setQuery: React$2.Dispatch<React$2.SetStateAction<string>>;
+  list: {
+    id: string;
+    title: string;
+    path: string;
+    bio: string;
+    groupTitle: string | undefined;
+  }[];
+  searchDataLoading: boolean;
+  searchDataError: Error | null;
+  handleSelect: (key: React.Key) => void;
+  input: {
+    value: string;
+    onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+  };
+};
+//#endregion
+//#region src/client/hooks/use-tabs.d.ts
+declare function useTabs(tabs?: BoltdocsTab[], routes?: ComponentRoute[]): {
+  tabs: BoltdocsTab[];
+  activeIndex: number;
+  indicatorStyle: React$2.CSSProperties;
+  tabRefs: React$2.RefObject<(HTMLAnchorElement | null)[]>;
+  activeTabId: string | undefined;
+};
+//#endregion
+//#region src/client/hooks/use-version.d.ts
+interface VersionOption {
+  key: BoltdocsVersion;
+  label: string;
+  value: string;
+  isCurrent: boolean;
+}
+interface UseVersionReturn {
+  currentVersion: BoltdocsVersion | undefined;
+  currentVersionLabel: string | undefined;
+  availableVersions: VersionOption[];
+  handleVersionChange: (version: BoltdocsVersion) => void;
+}
+/**
+ * Hook to manage and switch between different versions of the documentation.
+ */
+declare function useVersion(): UseVersionReturn;
+//#endregion
+//#region src/client/hooks/use-i18n.d.ts
+interface LocaleOption {
+  key: BoltdocsLocale;
+  label: string;
+  value: string;
+  isCurrent: boolean;
+}
+interface UseI18nReturn {
+  currentLocale: BoltdocsLocale | undefined;
+  currentLocaleLabel: string | undefined;
+  availableLocales: LocaleOption[];
+  handleLocaleChange: (locale: BoltdocsLocale) => void;
+}
+/**
+ * Hook to manage and switch between different locales (languages) of the documentation.
+ */
+declare function useI18n(): UseI18nReturn;
+//#endregion
+//#region src/client/hooks/use-page-nav.d.ts
+declare function usePageNav(): {
+  prevPage: null;
+  nextPage: null;
+  currentRoute: null;
+} | {
+  prevPage: ComponentRoute | null;
+  nextPage: ComponentRoute | null;
+  currentRoute: ComponentRoute;
+};
+//#endregion
+//#region src/client/hooks/use-breadcrumbs.d.ts
+/**
+ * Hook to generate breadcrumbs based on the current active route.
+ */
+declare function useBreadcrumbs(): {
+  crumbs: {
+    label: string;
+    href?: string;
+  }[];
+  activeRoute: ComponentRoute | undefined;
+};
+//#endregion
+//#region src/client/hooks/use-routes.d.ts
+/**
+ * Hook to access the framework's routing state.
+ * Returns both the complete set of routes and a filtered list based on the current
+ * version and locale.
+ */
+declare function useRoutes(): {
+  routes: ComponentRoute[];
+  allRoutes: ComponentRoute[];
+  currentRoute: ComponentRoute | undefined;
+  isCollectionPage: boolean;
+  currentLocale: BoltdocsLocale;
+  currentVersion: BoltdocsVersion;
+};
+//#endregion
+//#region src/client/hooks/use-localized-to.d.ts
+/**
+ * Hook to automatically localize a path based on the current version and locale context.
+ * It ensures that navigation preserves the active version and language across the entire site.
+ */
+declare function useLocalizedTo(to: BoltdocsRoutePathWithFallback): string;
+declare function useLocalizedTo(to: string): string;
+//#endregion
+//#region src/client/hooks/use-search-highlight.d.ts
+/**
+ * Hook to highlight search terms based on the 'hl' query parameter.
+ */
+declare function useSearchHighlight(containerSelector?: string): void;
+//#endregion
+//#region src/client/hooks/use-analytics.d.ts
+declare global {
+  interface Window {
+    gtag?: (...args: unknown[]) => void;
+    dataLayer?: unknown[];
+    gtag_report_conversion?: (url?: string) => boolean;
+    posthog?: {
+      capture: (event: string, properties?: Record<string, unknown>) => void;
+      identify: (distinctId: string) => void;
+      reset: () => void;
+      opt_out_capturing: () => void;
+      opt_in_capturing: () => void;
+    };
+  }
+}
+interface AnalyticsEvent {
+  action: string;
+  category?: string;
+  label?: string;
+  value?: number;
+  params?: Record<string, unknown>;
+}
+interface AnalyticsInstance {
+  trackPageView: (path: string, title?: string) => void;
+  trackEvent: (event: AnalyticsEvent) => void;
+  trackSearch: (query: string, resultsCount?: number) => void;
+  trackDownload: (file: string, type?: string) => void;
+  trackExternalLink: (url: string) => void;
+  isEnabled: boolean;
+}
+interface UseAnalyticsOptions {
+  config?: BoltdocsIntegrationsConfig;
+  autoTrackPageViews?: boolean;
+  autoTrackDownloads?: boolean;
+  autoTrackExternalLinks?: boolean;
+  excludePatterns?: RegExp[];
+}
+declare function useAnalytics(options?: UseAnalyticsOptions): AnalyticsInstance;
+declare function useTrackPageView(): (path: string, title?: string) => void;
+declare function useTrackEvent(): (event: AnalyticsEvent) => void;
+//#endregion
+//#region src/client/hooks/use-headings.d.ts
+/**
+ * Returns the headings of the current page, extracted from the route loader data.
+ * Useful for building custom Tables of Contents or jumping to sections.
+ *
+ * @returns An array of heading objects with level, text, and id.
+ */
+declare function useHeadings(): {
+  level: number;
+  text: string;
+  id: string;
+}[];
+//#endregion
+//#region src/client/hooks/use-merged-components.d.ts
+declare function useMergedComponents(propComponents?: Record<string, ComponentType<any>>): MdxComponentsType;
+//#endregion
+//#region src/client/hooks/use-feedback.d.ts
+interface FeedbackData {
+  rating: 'good' | 'neutral' | 'bad';
+  comment?: string;
+  path: string;
+  title: string;
+  blockId?: string;
+}
+interface UseFeedbackOptions {
+  endpoint?: string;
+  onSubmit?: (data: FeedbackData) => void | Promise<void>;
+}
+/**
+ * Hook for managing the feedback rating form state and submission.
+ * Resets automatically when navigating to a new page.
+ */
+declare function useFeedback(options?: UseFeedbackOptions): {
+  rating: "good" | "neutral" | "bad" | null;
+  setRating: React$2.Dispatch<React$2.SetStateAction<"good" | "neutral" | "bad" | null>>;
+  comment: string;
+  setComment: React$2.Dispatch<React$2.SetStateAction<string>>;
+  loading: boolean;
+  submitted: boolean;
+  error: string | null;
+  submit: (commentOverride?: string, blockId?: string) => Promise<void>;
+};
+//#endregion
+//#region src/client/components/docs-layout-default.d.ts
+interface DocsLayoutThemeProps {
+  children?: ReactNode;
+}
+/**
+ * Default docs layout — composes the visual primitives and delegates
+ * sub-area routing to them. Slot rendering (plugin injections at
+ * `navbar:end`, `sidebar:bottom`, `docs-content:top`, etc.) is handled
+ * internally by each primitive so the layout itself does no slot "magic".
+ *
+ * A custom layout can reuse any primitive and the slot wiring just works.
+ */
+declare function DocsLayoutComponent({
+  children
+}: DocsLayoutThemeProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/navbar.d.ts
+declare function Navbar({
+  className
+}: {
+  className?: string;
+}): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/primitives/types.d.ts
+type ComponentBase = {
+  className?: string;
+  children?: ReactNode;
+};
+//#endregion
+//#region src/client/components/ui-base/icon-renderer.d.ts
+type IconProps = SVGProps<SVGSVGElement> & {
+  size?: number | string;
+};
+type IconValue = string | ComponentType<IconProps>;
+//#endregion
+//#region src/client/components/primitives/sidebar.d.ts
+/**
+ * Desktop Sidebar Container
+ */
+declare function SidebarRoot({
+  children,
+  className
+}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Mobile Sidebar Modal
+ */
+declare function SidebarMobile({
+  children,
+  className,
+  overlayClassName,
+  dialogClassName
+}: ComponentBase & {
+  overlayClassName?: string;
+  dialogClassName?: string;
+}): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Shared Header for Sidebar
+ */
+declare function SidebarHeader({
+  children,
+  className
+}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Scrollable Content Wrapper
+ *
+ * The scroll container doubles as the semantic `<nav>` landmark. State and
+ * scroll-position handling live here; all visuals belong to the theme.
+ */
+declare function SidebarContent({
+  children,
+  className
+}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Navigation Group
+ */
+declare function SidebarGroup({
+  title,
+  icon: Icon,
+  children,
+  className,
+  collapsible,
+  collapsed,
+  active,
+  headerClassName,
+  iconClassName,
+  titleClassName,
+  contentClassName,
+  trailing,
+  trailingClassName,
+  renderTitle
+}: {
+  title?: string;
+  icon?: IconValue;
+  collapsible?: boolean;
+  collapsed?: boolean;
+  active?: boolean;
+  headerClassName?: string;
+  iconClassName?: string;
+  titleClassName?: string;
+  contentClassName?: string;
+  trailing?: ReactNode; /** Class name for the trailing element wrapper (non-collapsible header). */
+  trailingClassName?: string;
+  renderTitle?: (props: {
+    title?: string;
+    isOpen: boolean;
+  }) => ReactNode;
+} & ComponentBase): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Sidebar Link
+ */
+interface SidebarLinkProps extends ComponentBase {
+  label: string;
+  href: BoltdocsRoutePathWithFallback;
+  active?: boolean;
+  icon?: IconValue;
+  badge?: ComponentRoute['badge'];
+  iconClassName?: string;
+  labelClassName?: string;
+  badgeClassName?: string;
+  trailing?: ReactNode;
+  depth?: number;
+}
+declare function SidebarLink({
+  label,
+  href,
+  active,
+  icon: Icon,
+  badge,
+  className,
+  iconClassName,
+  labelClassName,
+  badgeClassName,
+  children,
+  trailing,
+  depth
+}: SidebarLinkProps): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Nested SubGroup
+ */
+declare function SidebarSubGroup({
+  label,
+  href,
+  active,
+  icon: Icon,
+  badge,
+  isOpen,
+  onToggle,
+  children,
+  className,
+  rootClassName,
+  linkClassName,
+  contentClassName,
+  toggleClassName,
+  wrapperClassName,
+  renderToggle,
+  depth
+}: SidebarLinkProps & {
+  isOpen: boolean;
+  onToggle: () => void;
+  children: ReactNode;
+  rootClassName?: string;
+  linkClassName?: string;
+  contentClassName?: string;
+  toggleClassName?: string; /** Class name for the relative row that wraps the link and toggle. */
+  wrapperClassName?: string;
+  renderToggle?: (props: {
+    isOpen: boolean;
+  }) => ReactNode;
+}): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Automated single-route rendering primitive
+ */
+interface SidebarItemProps extends ComponentBase {
+  route: ComponentRoute;
+  activePath: string;
+  activeRoute?: ComponentRoute;
+  depth?: number;
+  renderItem?: (route: ComponentRoute, depth: number) => ReactNode;
+  classNames?: SidebarSlots;
+}
+declare function SidebarItem({
+  route,
+  activePath,
+  activeRoute,
+  className,
+  depth,
+  renderItem,
+  classNames
+}: SidebarItemProps): _$react_jsx_runtime0.JSX.Element;
+/**
+ * High-level automated routes data rendering primitive
+ */
+interface SidebarSlots {
+  /** Link root (leaf route) */
+  item?: string;
+  /** Link leading icon */
+  itemIcon?: string;
+  /** Link label */
+  itemLabel?: string;
+  /** Link badge */
+  itemBadge?: string;
+  /** Group root container */
+  group?: string;
+  /** Group header (button or heading) */
+  groupHeader?: string;
+  /** Group leading icon */
+  groupIcon?: string;
+  /** Group title text */
+  groupTitle?: string;
+  /** Group children wrapper */
+  groupContent?: string;
+  /** Subgroup root container */
+  subgroup?: string;
+  /** Subgroup link */
+  subgroupLink?: string;
+  /** Subgroup children wrapper */
+  subgroupContent?: string;
+  /** Subgroup link + toggle row */
+  subgroupWrapper?: string;
+  /** Subgroup expand/collapse toggle */
+  toggle?: string;
+}
+interface SidebarItemRenderProps {
+  route: ComponentRoute;
+  activePath: string;
+  activeRoute?: ComponentRoute;
+  isActive: boolean;
+  depth: number;
+}
+interface SidebarGroupRenderProps {
+  group: SidebarGroupData;
+  isGroupActive: boolean;
+  children: ReactNode;
+}
+interface SidebarItemsProps extends ComponentBase {
+  routes: ComponentRoute[];
+  /**
+   * Per-piece class overrides merged over the default styles.
+   */
+  classNames?: SidebarSlots;
+  /**
+   * Full render replacement for a single route node (leaf or subgroup).
+   * Runs recursively for nested routes.
+   */
+  componentItem?: (props: SidebarItemRenderProps) => ReactNode;
+  /**
+   * Full render replacement for a top-level group wrapper.
+   */
+  componentGroup?: (props: SidebarGroupRenderProps) => ReactNode;
+}
+declare function SidebarItems$1({
+  routes,
+  className,
+  classNames,
+  componentItem,
+  componentGroup
+}: SidebarItemsProps): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Main Sidebar Export
+ */
+declare const Sidebar$1: typeof SidebarRoot & {
+  Root: typeof SidebarRoot;
+  Mobile: typeof SidebarMobile;
+  Header: typeof SidebarHeader;
+  Content: typeof SidebarContent;
+  Group: typeof SidebarGroup;
+  Link: typeof SidebarLink;
+  SubGroup: typeof SidebarSubGroup;
+  Item: typeof SidebarItem;
+  Items: typeof SidebarItems$1;
+};
+//#endregion
+//#region src/client/components/ui-base/sidebar.d.ts
+interface SidebarProps {
+  routes: ComponentRoute[];
+  config: BoltdocsConfig;
+  className?: string;
+}
+declare function SidebarMain({
+  routes,
+  config,
+  className
+}: SidebarProps): _$react_jsx_runtime0.JSX.Element;
+declare function SidebarItems(props: SidebarItemsProps): _$react_jsx_runtime0.JSX.Element;
+declare const Sidebar: typeof SidebarMain & {
+  Root: typeof SidebarRoot;
+  Mobile: typeof SidebarMobile;
+  Header: typeof SidebarHeader;
+  Content: typeof SidebarContent;
+  Group: typeof SidebarGroup;
+  Link: typeof SidebarLink;
+  SubGroup: typeof SidebarSubGroup;
+  Item: typeof SidebarItem;
+  Items: typeof SidebarItems;
+};
+//#endregion
+//#region src/client/components/ui-base/on-this-page.d.ts
+interface OnThisPageUIProps extends OnThisPageProps {
+  className?: string;
+}
+declare function OnThisPage({
+  headings,
+  editLink,
+  communityHelp,
+  filePath,
+  className
+}: OnThisPageUIProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/breadcrumbs.d.ts
+declare function Breadcrumbs({
+  className
+}: {
+  className?: string;
+}): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/page-nav.d.ts
+/**
+ * Component to display the previous and next page navigation buttons.
+ * Enhanced with subtle entrance animations, modern card layout, and hover highlights.
+ */
+declare function PageNav({
+  className
+}: {
+  className?: string;
+}): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/error-boundary.d.ts
+interface ErrorBoundaryProps {
+  children?: ReactNode;
+  fallback?: ReactNode;
+}
+declare function ErrorBoundary({
+  children,
+  fallback
+}: ErrorBoundaryProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/copy-markdown.d.ts
+interface CopyMarkdownProps {
+  content?: string;
+  mdxRaw?: string;
+  route?: ComponentRoute;
+  className?: string;
+}
+declare function CopyMarkdown({
+  content,
+  mdxRaw,
+  className
+}: CopyMarkdownProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/search-dialog.d.ts
+declare function SearchDialog({
+  routes,
+  className,
+  markClassName
+}: {
+  routes: ComponentRoute[];
+  className?: string;
+  markClassName?: string;
+}): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/not-found.d.ts
+declare function NotFound({
+  className
+}: {
+  className?: string;
+}): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/banner.d.ts
+interface BannerProps extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * If true, shows a close button to dismiss the banner.
+   */
+  dismissible?: boolean;
+  /**
+   * Unique identifier for the banner. If provided and dismissible is true,
+   * the dismissed state will be saved in localStorage so it doesn't reappear
+   * on subsequent visits.
+   */
+  id?: string;
+}
+declare function Banner({
+  children,
+  className,
+  dismissible,
+  id,
+  ...props
+}: BannerProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/collections/hooks.d.ts
+interface UsePostsOptions {
+  includeDrafts?: boolean;
+}
+/**
+ * Returns the posts of a collection, filtered by the current locale and version.
+ * Defaults to "blog" if no collection is specified.
+ * @param collection - The name of the collection. Defaults to "blog".
+ * @param options - Options to customize the query.
+ * @param options.includeDrafts - If true, includes draft posts in the results.
+ * @returns The filtered posts of the collection.
+ */
+declare function usePosts(collection?: string, options?: UsePostsOptions): CollectionPost$1[];
+/**
+ * Returns a single post from a collection.
+ *
+ * @param collection - The name of the collection (optional inside post routes).
+ * @param slug - The post slug (optional inside post routes).
+ * @returns The matching post, or undefined if not found.
+ */
+declare function usePost(): CollectionPost$1 | undefined;
+declare function usePost(collection: string, slug: string): CollectionPost$1 | undefined;
+/**
+ * Returns the recent posts of a collection. Defaults to "blog".
+ * @param collection - The name of the collection. Defaults to "blog".
+ * @param count - The number of recent posts to return.
+ * @returns The recent posts of the collection.
+ */
+declare function useRecentPosts(collection?: string, count?: number): CollectionPost$1[];
+//#endregion
+//#region src/client/components/mdx/timeline.d.ts
+/**
+ * Variants for both dots and badges.
+ *
+ * - Semantic: `primary`, `success`, `info`, `warning`, `danger` map directly
+ *   to the dot accent color and the badge pill background.
+ * - Lifecycle (alias for semantic but convenient for changelogs):
+ *   `major` → primary, `minor` → success, `patch` → info,
+ *   `new` → primary, `deprecated` → warning, `breaking` → danger.
+ */
+type TimelineVariant = 'primary' | 'success' | 'info' | 'warning' | 'danger' | 'major' | 'minor' | 'patch' | 'new' | 'deprecated' | 'breaking';
+interface TimelineBadgeConfig {
+  text: ReactNode;
+  variant?: TimelineVariant;
+}
+interface TimelineProps extends Omit<React.HTMLAttributes<HTMLOListElement>, 'children'> {
+  children?: ReactNode;
+  /** Reduce vertical padding between items. */
+  compact?: boolean;
+  connectorClassName?: string;
+}
+interface TimelineItemProps extends Omit<React.HTMLAttributes<HTMLLIElement>, 'title' | 'children'> {
+  /** Date the entry happened. Accepts ISO string, epoch ms, or `Date` instance. */
+  date?: string | number | Date;
+  /** Headline shown beside the date. */
+  title: ReactNode;
+  /** Inline badge to the right of the title (e.g. "Major", "Breaking"). */
+  badge?: string | TimelineBadgeConfig;
+  /** Icon to render inside the dot. Falls back to a coloured filled circle. */
+  icon?: ReactNode;
+  /** Dot / badge accent colour. Defaults to `primary`. */
+  variant?: TimelineVariant;
+  /**
+   * BCP-47 locale tag used by `toLocaleDateString` for the rendered
+   * date. Defaults to `'en-US'` so server and client produce identical
+   * markup on hydration. Pass `'es'`, `'fr'`, etc. to localize.
+   */
+  locale?: string;
+  /** Body content for the entry. Accepts Markdown/markup from MDX. */
+  children?: ReactNode;
+  dotClassName?: string;
+  headerClassName?: string;
+  timeClassName?: string;
+  badgeClassName?: string;
+  titleClassName?: string;
+  bodyClassName?: string;
+}
+declare function TimelineRoot({
+  children,
+  className,
+  compact,
+  connectorClassName,
+  ...props
+}: TimelineProps): _$react_jsx_runtime0.JSX.Element;
+declare function TimelineItem({
+  date,
+  title,
+  badge,
+  icon,
+  variant,
+  locale,
+  className,
+  children,
+  dotClassName,
+  headerClassName,
+  timeClassName,
+  badgeClassName,
+  titleClassName,
+  bodyClassName,
+  ...props
+}: TimelineItemProps): _$react_jsx_runtime0.JSX.Element;
+declare const Timeline: typeof TimelineRoot & {
+  Item: typeof TimelineItem;
+};
+//#endregion
+//#region src/client/utils/cn.d.ts
+declare function cn(...inputs: ClassValue[]): string;
+//#endregion
+//#region src/client/utils/path.d.ts
+/**
+ * Resolves a public asset URL under the configured Vite/base path.
+ * Root-relative URLs are otherwise interpreted against the origin root, which
+ * breaks sites deployed under a documentation base such as `/docs`.
+ */
+declare function resolvePublicAssetUrl(value: string, base?: string): string;
+//#endregion
+//#region src/client/utils/i18n.d.ts
+/**
+ * Retrieves the correct translation from a value that can be either
+ * a simple string or a map of locale-specific strings.
+ *
+ * @param value - The text to translate
+ * @param locale - The current active locale (e.g., 'en', 'es')
+ * @returns The translated string
+ */
+declare function getTranslated(value: string | Record<string, string> | undefined, locale?: string): string;
+//#endregion
+//#region src/shared/structured-data.d.ts
+interface WebSiteStructuredDataOptions {
+  name: string;
+  url: string;
+  description?: string;
+  searchUrl?: string;
+}
+interface ArticleStructuredDataOptions {
+  headline: string;
+  url: string;
+  description?: string;
+  datePublished?: string | Date;
+  dateModified?: string | Date;
+  image?: string;
+  author?: string | {
+    name: string;
+    url?: string;
+  };
+}
+interface BreadcrumbStructuredDataItem {
+  name: string;
+  url: string;
+}
+interface StructuredDataFactoryOptions {
+  /** A WebSite graph for the global site identity. */
+  website?: WebSiteStructuredDataOptions;
+  /** An Article graph for the current page or release post. */
+  article?: ArticleStructuredDataOptions;
+  /** A BreadcrumbList graph for the current page hierarchy. */
+  breadcrumbs?: BreadcrumbStructuredDataItem[];
+  /** Additional graph nodes for schema types not covered by the presets. */
+  additional?: JsonLdObject | JsonLdObject[];
+}
+/** Preserve literal JSON-LD types in config files and frontmatter helpers. */
+declare function defineStructuredData<T extends StructuredData$1>(data: T): T;
+/**
+ * Creates one JSON-LD value from the common website/article/breadcrumb presets.
+ * Single-node input returns an object; multiple nodes return a graph array.
+ */
+declare function createStructuredData(options: StructuredDataFactoryOptions): StructuredData$1;
+declare function createWebSiteStructuredData(options: WebSiteStructuredDataOptions): JsonLdObject;
+declare function createArticleStructuredData(options: ArticleStructuredDataOptions): JsonLdObject;
+declare function createBreadcrumbStructuredData(items: BreadcrumbStructuredDataItem[]): JsonLdObject;
+//#endregion
+//#region src/client/components/structured-data.d.ts
+interface StructuredDataProps {
+  data: StructuredData$1;
+  id?: string;
+}
+/**
+ * Renders safe, valid JSON-LD. Escaping `<` prevents a JSON value from closing
+ * the surrounding script tag when the document is rendered server-side.
+ */
+declare function StructuredData({
+  data,
+  id
+}: StructuredDataProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/view-transitions.d.ts
+interface ViewTransitionOptions {
+  /** Enable or disable this individual transition. */
+  enabled?: boolean;
+  /** Transition types forwarded to the native API. */
+  types?: string[];
+}
+interface ViewTransitionHandle {
+  finished?: Promise<unknown>;
+  ready?: Promise<unknown>;
+  updateCallbackDone?: Promise<unknown>;
+  skipTransition?: () => void;
+}
+type ViewTransitionUpdate = () => void | Promise<void>;
+interface ViewTransitionRunner {
+  (update: ViewTransitionUpdate, options?: ViewTransitionOptions): ViewTransitionHandle | null;
+  /** Alias for the callable form, useful for event handlers and callbacks. */
+  run: (update: ViewTransitionUpdate, options?: ViewTransitionOptions) => ViewTransitionHandle | null;
+  /** Explicit alias for code that reads like an imperative action. */
+  start: (update: ViewTransitionUpdate, options?: ViewTransitionOptions) => ViewTransitionHandle | null;
+  /** Whether the project has enabled the experimental integration. */
+  enabled: boolean;
+  /** Whether the current browser exposes the native API. */
+  supported: boolean;
+}
+/**
+ * Starts a native document transition when the browser supports it. On older
+ * browsers, the update still runs normally and the function returns null.
+ */
+declare function startViewTransition(update: ViewTransitionUpdate, options?: ViewTransitionOptions): ViewTransitionHandle | null;
+/**
+ * Returns a transition-aware runner that follows the project's experimental
+ * configuration. It is safe to use in custom layouts and external pages.
+ *
+ * The returned value is callable for backwards compatibility:
+ * `transition(() => setState(...))`. It also exposes `run` and `start` aliases
+ * for discoverability in editor autocomplete.
+ */
+declare function useViewTransition(): ViewTransitionRunner;
+//#endregion
+//#region src/client/utils/react-to-text.d.ts
+type ResolverMap = Map<string | JSXElementConstructor<object>, (props: object) => string>;
+declare const reactToText: (node: ReactNode, resolvers?: ResolverMap) => string;
+//#endregion
+//#region src/client/utils/copy-clipboard.d.ts
+/**
+ * Copy text to clipboard.
+ * @param text - The text to copy.
+ * @returns True if the text was copied successfully.
+ */
+declare const copyToClipboard: (text: string) => Promise<boolean>;
+//#endregion
+//#region src/client/utils/github.d.ts
+/**
+ * Get the number of stars for a GitHub repository.
+ * @param repo - owner/repo
+ * @param token - The GitHub token.
+ * @param baseUrl - The GitHub API base URL.
+ * @returns The number of stars for the repository.
+ * @example
+ * getStarsRepo('owner/repo') // 100k
+ */
+declare function getStarsRepo(repo: string, token?: string, baseUrl?: string): Promise<string>;
+//#endregion
+//#region src/client/components/mdx/code-block.d.ts
+interface CodeBlockProps {
+  children?: React.ReactNode;
+  className?: string;
+  hideCopy?: boolean;
+  title?: string;
+  lang?: string;
+  highlightedHtml?: string;
+  'data-lang'?: string;
+  'data-title'?: string;
+  'data-highlighted'?: string;
+  'data-highlighted-html'?: string;
+  plain?: boolean;
+  lineNumbers?: boolean | string;
+  showLineNumbers?: boolean | string;
+  wordWrap?: boolean | string;
+  'word-wrap'?: boolean | string;
+  metastring?: string;
+  feedbackClassName?: string;
+  copyButtonClassName?: string;
+}
+//#endregion
+//#region src/client/components/mdx/use-code-block.d.ts
+/**
+ * @deprecated Use the feature-scoped hooks instead: `useCopyButton`,
+ * `useExpandable` and `useCodeBlockFeedback`. This composition keeps the
+ * historical single-hook API and will be removed in a future major version.
+ */
+declare function useCodeBlock(props: CodeBlockProps): {
+  copied: boolean;
+  isExpanded: boolean;
+  setIsExpanded: React$2.Dispatch<React$2.SetStateAction<boolean>>;
+  isExpandable: boolean;
+  preRef: React$2.RefObject<HTMLElement | null>;
+  handleCopy: () => void;
+  shouldTruncate: boolean;
+  isHighlighted: boolean;
+  effectiveHighlightedHtml: string | undefined;
+  effectiveTitle: string | undefined;
+  lang: string;
+  showCodeBlockFeedback: boolean;
+  rated: "up" | "down" | null;
+  handleRate: (type: "up" | "down") => Promise<void>;
+};
+//#endregion
+//#region src/client/components/mdx/use-copy-button.d.ts
+/**
+ * Copy-to-clipboard state for a code block (or any copyable surface).
+ * `handleCopy(code)` copies the given text and shows a transient "copied"
+ * confirmation for 2 seconds.
+ */
+declare function useCopyButton(): {
+  copied: boolean;
+  handleCopy: (code: string) => void;
+};
+//#endregion
+//#region src/client/components/mdx/use-expandable.d.ts
+interface UseExpandableOptions {
+  /** The raw children rendered inside the code area (for line counting). */
+  children?: React.ReactNode;
+  /** Pre-rendered Shiki HTML when available (for line counting). */
+  highlightedHtml?: string;
+  /** Number of lines above which the block becomes expandable. @default 6 */
+  maxLines?: number;
+}
+/**
+ * Expand / collapse behavior for long code blocks. Measures the rendered code
+ * through `preRef` and exposes whether the block is expandable, whether it
+ * should be visually truncated, and a toggle handler.
+ */
+declare function useExpandable(options?: UseExpandableOptions): {
+  isExpanded: boolean;
+  setIsExpanded: React$2.Dispatch<React$2.SetStateAction<boolean>>;
+  isExpandable: boolean;
+  shouldTruncate: boolean;
+  toggle: () => void;
+  preRef: React$2.RefObject<HTMLElement | null>;
+};
+//#endregion
+//#region src/client/components/mdx/use-code-block-feedback.d.ts
+interface CodeBlockFeedbackPayload {
+  rating: 'good' | 'bad';
+  comment: string;
+  blockId: string;
+  path: string;
+  title: string;
+  lang: string;
+  snippet: string;
+}
+interface UseCodeBlockFeedbackOptions {
+  /** Plain blocks never show feedback. @default false */
+  plain?: boolean;
+  /** Language label used to build the block id. */
+  lang?: string;
+  /**
+   * Custom submit handler. When provided it replaces the default POST to the
+   * configured feedback endpoint (useful for plugins or custom backends).
+   */
+  submitFeedback?: (payload: CodeBlockFeedbackPayload) => Promise<void> | void;
+}
+/**
+ * Thumbs-up / thumbs-down feedback for code blocks. Only enabled when the
+ * `feedback.custom` integration is configured in the site config. The submit
+ * behavior can be overridden via `submitFeedback`.
+ */
+declare function useCodeBlockFeedback(options?: UseCodeBlockFeedbackOptions): {
+  rated: "up" | "down" | null;
+  handleRate: (type: "up" | "down", code?: string) => Promise<void>;
+  enabled: boolean;
+};
+//#endregion
+export { SidebarItem as $, cn as A, useUI as At, NotFound as B, CollectionsData as Bt, createArticleStructuredData as C, usePageNav as Ct, defineStructuredData as D, useSearch as Dt, createWebSiteStructuredData as E, useTabs as Et, TimelineVariant as F, BoltdocsShell as Ft, Breadcrumbs as G, ComponentRoute as Gt, CopyMarkdown as H, BoltdocsTab as Ht, usePost as I, MdxPage as It, Sidebar$1 as J, OnThisPageProps as Jt, OnThisPage as K, LayoutProps as Kt, usePosts as L, createRoutes as Lt, TimelineBadgeConfig as M, useTheme as Mt, TimelineItemProps as N, useConfig as Nt, getTranslated as O, useSidebar as Ot, TimelineProps as P, ViteReactSSG as Pt, SidebarHeader as Q, useRecentPosts as R, CollectionPost$1 as Rt, WebSiteStructuredDataOptions as S, useBreadcrumbs as St, createStructuredData as T, useVersion as Tt, ErrorBoundary as U, CollectionListLoaderData as Ut, SearchDialog as V, CurrentPostProvider as Vt, PageNav as W, CollectionPostLoaderData as Wt, SidebarGroup as X, SiteConfig as Xt, SidebarContent as Y, SidebarProps$1 as Yt, SidebarGroupRenderProps as Z, TabsProps as Zt, StructuredData as _, useTrackEvent as _t, useExpandable as a, SidebarLinkProps as at, BreadcrumbStructuredDataItem as b, useLocalizedTo as bt, getStarsRepo as c, SidebarSlots as ct, ViewTransitionHandle as d, Navbar as dt, SidebarItemProps as et, ViewTransitionOptions as f, DocsLayoutComponent as ft, useViewTransition as g, useAnalytics as gt, startViewTransition as h, useHeadings as ht, UseExpandableOptions as i, SidebarLink as it, Timeline as j, useMdxComponents as jt, resolvePublicAssetUrl as k, useNavbar as kt, copyToClipboard as l, SidebarSubGroup as lt, ViewTransitionUpdate as m, useMergedComponents as mt, UseCodeBlockFeedbackOptions as n, SidebarItems$1 as nt, useCopyButton as o, SidebarMobile as ot, ViewTransitionRunner as p, useFeedback as pt, Sidebar as q, NavbarLink as qt, useCodeBlockFeedback as r, SidebarItemsProps as rt, useCodeBlock as s, SidebarRoot as st, CodeBlockFeedbackPayload as t, SidebarItemRenderProps as tt, reactToText as u, ComponentBase as ut, StructuredDataProps as v, useTrackPageView as vt, createBreadcrumbStructuredData as w, useI18n as wt, StructuredDataFactoryOptions as x, useRoutes as xt, ArticleStructuredDataOptions as y, useSearchHighlight as yt, Banner as z, CollectionsContext as zt };