boltdocs 2.6.2 → 2.7.1

package/dist/sidebar-DKvg6KOc.d.cts

@@ -0,0 +1,491 @@
+
+import * as React$2 from "react";
+import { ComponentType, ReactNode } from "react";
+import { Plugin } from "vite";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#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;
+    items?: Array<{
+      label: string | Record<string, string>;
+      href: string;
+    }>;
+  }>;
+  sidebar?: Record<string, Array<{
+    text: string;
+    link: string;
+  }>>;
+  sidebarGroups?: Record<string, {
+    title?: string | Record<string, string>;
+    icon?: string;
+  }>;
+  socialLinks?: BoltdocsSocialLink[];
+  footer?: BoltdocsFooterConfig;
+  editLink?: string;
+  communityHelp?: string;
+  version?: string;
+  githubRepo?: string;
+  favicon?: string;
+  tabs?: Array<{
+    id: string;
+    text: string | Record<string, string>;
+    icon?: string;
+  }>;
+  codeTheme?: ShikiTheme | {
+    light: ShikiTheme;
+    dark: ShikiTheme;
+  };
+}
+/**
+ * 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: string[] | 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;
+  };
+}
+/**
+ * Configuration for Google Analytics 4 (GA4).
+ */
+interface BoltdocsGA4Config {
+  measurementId: string;
+  debug?: boolean;
+  anonymizeIp?: boolean;
+  sendPageView?: boolean;
+  cookieFlags?: string;
+  autoTrack?: {
+    pageViews?: boolean;
+    downloads?: boolean;
+    externalLinks?: boolean;
+    search?: boolean;
+  };
+}
+/**
+ * Configuration for Google Tag Manager (GTM).
+ */
+interface BoltdocsGTMConfig {
+  tagId: string;
+  dataLayerName?: string;
+  preview?: string;
+}
+interface BoltdocsIntegrationsConfig {
+  ga4?: BoltdocsGA4Config;
+  gtm?: BoltdocsGTMConfig;
+}
+/**
+ * The root configuration object for Boltdocs.
+ */
+interface BoltdocsConfig$1 {
+  siteUrl?: string;
+  docsDir?: string;
+  base?: string;
+  theme?: BoltdocsThemeConfig;
+  i18n?: BoltdocsI18nConfig;
+  versions?: BoltdocsVersionsConfig;
+  plugins?: BoltdocsPlugin[];
+  robots?: BoltdocsRobotsConfig;
+  security?: BoltdocsSecurityConfig;
+  seo?: BoltdocsSeoConfig;
+  integrations?: BoltdocsIntegrationsConfig;
+  /** Aggregated metadata from local meta.json files */
+  directoryMeta?: Record<string, any>;
+  vite?: any;
+}
+/**
+ * Global namespace for Boltdocs types that can be augmented by generated code.
+ * This allows for strictly typed locales and versions based on the project configuration.
+ */
+declare global {
+  namespace Boltdocs {
+    interface Types {}
+  }
+}
+type BoltdocsTypes = Boltdocs.Types;
+type BoltdocsLocale = Boltdocs.Types extends {
+  Locale: infer L;
+} ? L : string;
+type BoltdocsVersion = Boltdocs.Types extends {
+  Version: infer V;
+} ? V : string;
+type UnpackMdxComponents<T> = T extends {
+  default: infer D;
+} ? D : T;
+type TransformMdxComponents<T> = { [K in keyof T as K extends `Frontmatter_${string}` ? never : K]: T[K] } & {
+  Frontmatter: { [K in keyof T as K extends `Frontmatter_${infer Name}` ? Name : never]: T[K] };
+};
+type BoltdocsMdxComponents = Boltdocs.Types extends {
+  MdxComponents: infer M;
+} ? TransformMdxComponents<UnpackMdxComponents<M>> : {
+  [key: string]: ComponentType<any>;
+  Frontmatter: Record<string, ComponentType<any>>;
+};
+//#endregion
+//#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?: string | {
+    text: 'updated' | 'new' | 'deprecated';
+    expires?: string;
+  };
+  /** 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[];
+  /** 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;
+  /** Raw extensible frontmatter data for custom components and formatters */
+  frontmatter?: Record<string, any>;
+  /** Clean URL segments stripped of locale/version prefixes */
+  slugParts?: string[];
+}
+/**
+ * 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 {
+  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: string;
+  active: boolean;
+  to?: string;
+  items?: NavbarLink[];
+}
+//#endregion
+//#region src/client/components/primitives/types.d.ts
+type ComponentBase = {
+  className?: string;
+  children?: ReactNode;
+};
+//#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
+}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Shared Header for Sidebar
+ */
+declare function SidebarHeader({
+  children,
+  className
+}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Scrollable Content Wrapper
+ */
+declare function SidebarContent({
+  children,
+  className
+}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Navigation Group
+ */
+declare const SidebarGroup: ({
+  title,
+  icon: Icon,
+  children,
+  className
+}: {
+  title?: string;
+  icon?: React.ElementType;
+} & ComponentBase) => _$react_jsx_runtime0.JSX.Element;
+/**
+ * Sidebar Link
+ */
+interface SidebarLinkProps extends ComponentBase {
+  label: string;
+  href: string;
+  active?: boolean;
+  icon?: React.ElementType;
+  badge?: ComponentRoute['badge'];
+}
+declare const SidebarLink: ({
+  label,
+  href,
+  active,
+  icon: Icon,
+  badge,
+  className
+}: SidebarLinkProps) => _$react_jsx_runtime0.JSX.Element;
+/**
+ * Nested SubGroup
+ */
+declare const SidebarSubGroup: ({
+  label,
+  href,
+  active,
+  icon: Icon,
+  badge,
+  isOpen,
+  onToggle,
+  children,
+  className
+}: SidebarLinkProps & {
+  isOpen: boolean;
+  onToggle: () => void;
+  children: ReactNode;
+}) => _$react_jsx_runtime0.JSX.Element;
+/**
+ * Automated single-route rendering primitive
+ */
+interface SidebarItemProps extends ComponentBase {
+  route: ComponentRoute;
+  activePath: string;
+}
+declare function SidebarItem({
+  route,
+  activePath,
+  className
+}: SidebarItemProps): _$react_jsx_runtime0.JSX.Element;
+/**
+ * High-level automated routes data rendering primitive
+ */
+interface SidebarItemsProps extends ComponentBase {
+  routes: ComponentRoute[];
+}
+declare function SidebarItems({
+  routes,
+  className
+}: SidebarItemsProps): _$react_jsx_runtime0.JSX.Element;
+/**
+ * Main Sidebar Export
+ */
+declare const Sidebar: typeof SidebarRoot & {
+  Root: typeof SidebarRoot;
+  Mobile: typeof SidebarMobile;
+  Header: typeof SidebarHeader;
+  Content: typeof SidebarContent;
+  Group: ({
+    title,
+    icon: Icon,
+    children,
+    className
+  }: {
+    title?: string;
+    icon?: React.ElementType;
+  } & ComponentBase) => _$react_jsx_runtime0.JSX.Element;
+  Link: ({
+    label,
+    href,
+    active,
+    icon: Icon,
+    badge,
+    className
+  }: SidebarLinkProps) => _$react_jsx_runtime0.JSX.Element;
+  SubGroup: ({
+    label,
+    href,
+    active,
+    icon: Icon,
+    badge,
+    isOpen,
+    onToggle,
+    children,
+    className
+  }: SidebarLinkProps & {
+    isOpen: boolean;
+    onToggle: () => void;
+    children: ReactNode;
+  }) => _$react_jsx_runtime0.JSX.Element;
+  Item: typeof SidebarItem;
+  Items: typeof SidebarItems;
+};
+//#endregion
+export { BoltdocsConfig$1 as C, BoltdocsSocialLink as D, BoltdocsMdxComponents as E, BoltdocsTypes as O, TabsProps as S, BoltdocsLocale as T, LayoutProps as _, SidebarItem as a, SidebarProps as b, SidebarItemsProps as c, SidebarMobile as d, SidebarRoot as f, ComponentRoute as g, BoltdocsTab as h, SidebarHeader as i, BoltdocsVersion as k, SidebarLink as l, ComponentBase as m, SidebarContent as n, SidebarItemProps as o, SidebarSubGroup as p, SidebarGroup as r, SidebarItems as s, Sidebar as t, SidebarLinkProps as u, NavbarLink as v, BoltdocsIntegrationsConfig as w, SiteConfig as x, OnThisPageProps as y };