boltdocs 2.8.3 → 2.9.0

package/dist/client/index.d.cts

@@ -1,6 +1,6 @@
 
-import { A as BoltdocsRoutePathWithFallback, C as SiteConfig, D as BoltdocsLocale, E as BoltdocsIntegrationsConfig, M as BoltdocsTypes, N as BoltdocsVersion, O as BoltdocsMdxComponents, S as SidebarProps, T as BoltdocsConfig, _ as CollectionPostLoaderData, b as NavbarLink, g as CollectionListLoaderData, h as BoltdocsTab, j as BoltdocsSocialLink, k as BoltdocsRoutePath, v as ComponentRoute, w as TabsProps, x as OnThisPageProps, y as LayoutProps } from "../sidebar-Dlkgbxs6.cjs";
-import { a as ErrorBoundary, c as OnThisPage, i as CopyMarkdown, l as Sidebar, n as NotFound, o as PageNav, r as SearchDialog, s as Breadcrumbs, t as Banner, u as Navbar } from "../banner-MynZD_Ox.cjs";
+import { A as BoltdocsRoutePathWithFallback, C as SiteConfig, D as BoltdocsLocale, E as BoltdocsIntegrationsConfig, M as BoltdocsTypes, N as BoltdocsVersion, O as BoltdocsMdxComponents, S as SidebarProps, T as BoltdocsConfig, _ as CollectionPostLoaderData, b as NavbarLink, g as CollectionListLoaderData, h as BoltdocsTab, j as BoltdocsSocialLink, k as BoltdocsRoutePath, v as ComponentRoute, w as TabsProps, x as OnThisPageProps, y as LayoutProps } from "../sidebar-BtJyWHy4.cjs";
+import { a as ErrorBoundary, c as OnThisPage, i as CopyMarkdown, l as Sidebar, n as NotFound, o as PageNav, r as SearchDialog, s as Breadcrumbs, t as Banner, u as Navbar } from "../banner-C_xkGxzI.cjs";
 import * as _$react from "react";
 import React$1, { ComponentType, JSXElementConstructor, ReactNode } from "react";
 import { RouteRecord, ViteReactSSG } from "@bdocs/ssg";
@@ -66,11 +66,13 @@ declare function MdxPage({
 declare function BoltdocsShell({
   config,
   routes,
-  components
+  components,
+  collectionsData
 }: {
   config: BoltdocsConfig;
   routes: ComponentRoute[];
   components?: Record<string, React.ComponentType>;
+  collectionsData?: CollectionsData;
 }): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/client/app/config-context.d.ts
@@ -190,10 +192,6 @@ interface UseI18nReturn {
 declare function useI18n(): UseI18nReturn;
 //#endregion
 //#region src/client/hooks/use-page-nav.d.ts
-/**
- * Hook to manage the previous and next button functionality for documentation pages.
- * Intelligent: respects current locale, version, and tab to keep navigation logical.
- */
 declare function usePageNav(): {
   prevPage: null;
   nextPage: null;
@@ -298,6 +296,33 @@ declare function useHeadings(): {
 //#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.Dispatch<_$react.SetStateAction<"good" | "neutral" | "bad" | null>>;
+  comment: string;
+  setComment: _$react.Dispatch<_$react.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?: React.ReactNode;
@@ -366,4 +391,45 @@ declare const copyToClipboard: (text: string) => Promise<boolean>;
  */
 declare function getStarsRepo(repo: string, token?: string, baseUrl?: string): Promise<string>;
 //#endregion
-export { Banner, BoltdocsConfig, type BoltdocsLocale, BoltdocsRoutePath, BoltdocsRoutePathWithFallback, BoltdocsShell, BoltdocsTab, type BoltdocsTypes, type BoltdocsVersion, Breadcrumbs, type CollectionListLoaderData, type CollectionPost$1 as CollectionPost, type CollectionPostLoaderData, CollectionsContext, type CollectionsData, ComponentRoute, CopyMarkdown, DocsLayoutComponent as DocsLayout, ErrorBoundary, LayoutProps, MdxPage, Navbar, NavbarLink, NotFound, OnThisPage, OnThisPageProps, PageNav, SearchDialog, Sidebar, SidebarProps, SiteConfig, TabsProps, ViteReactSSG, cn, copyToClipboard, createRoutes, getStarsRepo, getTranslated, reactToText, useAnalytics, useBreadcrumbs, useConfig, useHeadings, useI18n, useLocalizedTo, useLocation, useMdxComponents, useMergedComponents, useNavbar, usePageNav, usePost, usePosts, useRecentPosts, useRoutes, useSearch, useSearchHighlight, useSidebar, useTabs, useTheme, useTrackEvent, useTrackPageView, useUI, useVersion };
+//#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;
+}
+//#endregion
+//#region src/client/components/mdx/use-code-block.d.ts
+declare function useCodeBlock(props: CodeBlockProps): {
+  copied: boolean;
+  isExpanded: boolean;
+  setIsExpanded: _$react.Dispatch<_$react.SetStateAction<boolean>>;
+  isExpandable: boolean;
+  preRef: _$react.RefObject<HTMLPreElement | HTMLDivElement | null>;
+  handleCopy: () => Promise<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>;
+  LangIcon: _$react.ComponentType<{
+    size?: number;
+  }>;
+};
+//#endregion
+export { Banner, BoltdocsConfig, type BoltdocsLocale, BoltdocsRoutePath, BoltdocsRoutePathWithFallback, BoltdocsShell, BoltdocsTab, type BoltdocsTypes, type BoltdocsVersion, Breadcrumbs, type CollectionListLoaderData, type CollectionPost$1 as CollectionPost, type CollectionPostLoaderData, CollectionsContext, type CollectionsData, ComponentRoute, CopyMarkdown, DocsLayoutComponent as DocsLayout, ErrorBoundary, LayoutProps, MdxPage, Navbar, NavbarLink, NotFound, OnThisPage, OnThisPageProps, PageNav, SearchDialog, Sidebar, SidebarProps, SiteConfig, TabsProps, ViteReactSSG, cn, copyToClipboard, createRoutes, getStarsRepo, getTranslated, reactToText, useAnalytics, useBreadcrumbs, useCodeBlock, useConfig, useFeedback, useHeadings, useI18n, useLocalizedTo, useLocation, useMdxComponents, useMergedComponents, useNavbar, usePageNav, usePost, usePosts, useRecentPosts, useRoutes, useSearch, useSearchHighlight, useSidebar, useTabs, useTheme, useTrackEvent, useTrackPageView, useUI, useVersion };

package/dist/client/index.d.ts

@@ -1,6 +1,6 @@
 
-import { A as BoltdocsRoutePathWithFallback, C as SiteConfig, D as BoltdocsLocale, E as BoltdocsIntegrationsConfig, M as BoltdocsTypes, N as BoltdocsVersion, O as BoltdocsMdxComponents, S as SidebarProps, T as BoltdocsConfig, _ as CollectionPostLoaderData, b as NavbarLink, g as CollectionListLoaderData, h as BoltdocsTab, j as BoltdocsSocialLink, k as BoltdocsRoutePath, v as ComponentRoute, w as TabsProps, x as OnThisPageProps, y as LayoutProps } from "../sidebar-DNq4_ZAa.js";
-import { a as ErrorBoundary, c as OnThisPage, i as CopyMarkdown, l as Sidebar, n as NotFound, o as PageNav, r as SearchDialog, s as Breadcrumbs, t as Banner, u as Navbar } from "../banner-3N4Jd_L9.js";
+import { A as BoltdocsRoutePathWithFallback, C as SiteConfig, D as BoltdocsLocale, E as BoltdocsIntegrationsConfig, M as BoltdocsTypes, N as BoltdocsVersion, O as BoltdocsMdxComponents, S as SidebarProps, T as BoltdocsConfig, _ as CollectionPostLoaderData, b as NavbarLink, g as CollectionListLoaderData, h as BoltdocsTab, j as BoltdocsSocialLink, k as BoltdocsRoutePath, v as ComponentRoute, w as TabsProps, x as OnThisPageProps, y as LayoutProps } from "../sidebar-C4fuRYYS.js";
+import { a as ErrorBoundary, c as OnThisPage, i as CopyMarkdown, l as Sidebar, n as NotFound, o as PageNav, r as SearchDialog, s as Breadcrumbs, t as Banner, u as Navbar } from "../banner-D2NddBfF.js";
 import { RouteRecord, ViteReactSSG } from "@bdocs/ssg";
 import * as _$react from "react";
 import React$1, { ComponentType, JSXElementConstructor, ReactNode } from "react";
@@ -66,11 +66,13 @@ declare function MdxPage({
 declare function BoltdocsShell({
   config,
   routes,
-  components
+  components,
+  collectionsData
 }: {
   config: BoltdocsConfig;
   routes: ComponentRoute[];
   components?: Record<string, React.ComponentType>;
+  collectionsData?: CollectionsData;
 }): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/client/app/config-context.d.ts
@@ -190,10 +192,6 @@ interface UseI18nReturn {
 declare function useI18n(): UseI18nReturn;
 //#endregion
 //#region src/client/hooks/use-page-nav.d.ts
-/**
- * Hook to manage the previous and next button functionality for documentation pages.
- * Intelligent: respects current locale, version, and tab to keep navigation logical.
- */
 declare function usePageNav(): {
   prevPage: null;
   nextPage: null;
@@ -298,6 +296,33 @@ declare function useHeadings(): {
 //#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.Dispatch<_$react.SetStateAction<"good" | "neutral" | "bad" | null>>;
+  comment: string;
+  setComment: _$react.Dispatch<_$react.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?: React.ReactNode;
@@ -366,4 +391,45 @@ declare const copyToClipboard: (text: string) => Promise<boolean>;
  */
 declare function getStarsRepo(repo: string, token?: string, baseUrl?: string): Promise<string>;
 //#endregion
-export { Banner, BoltdocsConfig, type BoltdocsLocale, BoltdocsRoutePath, BoltdocsRoutePathWithFallback, BoltdocsShell, BoltdocsTab, type BoltdocsTypes, type BoltdocsVersion, Breadcrumbs, type CollectionListLoaderData, type CollectionPost$1 as CollectionPost, type CollectionPostLoaderData, CollectionsContext, type CollectionsData, ComponentRoute, CopyMarkdown, DocsLayoutComponent as DocsLayout, ErrorBoundary, LayoutProps, MdxPage, Navbar, NavbarLink, NotFound, OnThisPage, OnThisPageProps, PageNav, SearchDialog, Sidebar, SidebarProps, SiteConfig, TabsProps, ViteReactSSG, cn, copyToClipboard, createRoutes, getStarsRepo, getTranslated, reactToText, useAnalytics, useBreadcrumbs, useConfig, useHeadings, useI18n, useLocalizedTo, useLocation, useMdxComponents, useMergedComponents, useNavbar, usePageNav, usePost, usePosts, useRecentPosts, useRoutes, useSearch, useSearchHighlight, useSidebar, useTabs, useTheme, useTrackEvent, useTrackPageView, useUI, useVersion };
+//#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;
+}
+//#endregion
+//#region src/client/components/mdx/use-code-block.d.ts
+declare function useCodeBlock(props: CodeBlockProps): {
+  copied: boolean;
+  isExpanded: boolean;
+  setIsExpanded: _$react.Dispatch<_$react.SetStateAction<boolean>>;
+  isExpandable: boolean;
+  preRef: _$react.RefObject<HTMLPreElement | HTMLDivElement | null>;
+  handleCopy: () => Promise<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>;
+  LangIcon: _$react.ComponentType<{
+    size?: number;
+  }>;
+};
+//#endregion
+export { Banner, BoltdocsConfig, type BoltdocsLocale, BoltdocsRoutePath, BoltdocsRoutePathWithFallback, BoltdocsShell, BoltdocsTab, type BoltdocsTypes, type BoltdocsVersion, Breadcrumbs, type CollectionListLoaderData, type CollectionPost$1 as CollectionPost, type CollectionPostLoaderData, CollectionsContext, type CollectionsData, ComponentRoute, CopyMarkdown, DocsLayoutComponent as DocsLayout, ErrorBoundary, LayoutProps, MdxPage, Navbar, NavbarLink, NotFound, OnThisPage, OnThisPageProps, PageNav, SearchDialog, Sidebar, SidebarProps, SiteConfig, TabsProps, ViteReactSSG, cn, copyToClipboard, createRoutes, getStarsRepo, getTranslated, reactToText, useAnalytics, useBreadcrumbs, useCodeBlock, useConfig, useFeedback, useHeadings, useI18n, useLocalizedTo, useLocation, useMdxComponents, useMergedComponents, useNavbar, usePageNav, usePost, usePosts, useRecentPosts, useRoutes, useSearch, useSearchHighlight, useSidebar, useTabs, useTheme, useTrackEvent, useTrackPageView, useUI, useVersion };