boltdocs 3.0.2 → 3.2.1

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-7gIifpBX.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-DNSkgUsO.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-CrEdJuHX.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-CVD0GugR.cjs";
 import * as _$react from "react";
 import React$1, { ComponentType, JSXElementConstructor, ReactNode } from "react";
 import { RouteRecord, ViteReactSSG } from "@bdocs/ssg";
@@ -22,9 +22,32 @@ interface CollectionPost$1 {
   locale?: string;
   version?: string;
   frontmatter?: Record<string, any>;
+  lastUpdated?: string | number | Date;
+  headings?: {
+    level: number;
+    text: string;
+    id: string;
+  }[];
+  draft?: boolean;
 }
 type CollectionsData = Record<string, CollectionPost$1[]>;
 declare const CollectionsContext: _$react.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 {
@@ -54,8 +77,9 @@ type MdxPageProps = {
 /**
  * Renders an MDX page by consuming pre-loaded route data.
  *
- * - If the route belongs to a collection (`data.collection` is set), renders
- *   the custom post component if provided, else falls back to the standard DocPage.
+ * - 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({
@@ -95,9 +119,9 @@ declare function useTheme(): ThemeContextType;
 //#endregion
 //#region src/client/app/mdx-components-context.d.ts
 type MdxComponentsType = {
-  [key: string]: React.ComponentType<HTMLElement>;
+  [key: string]: ComponentType<any>;
 } & {
-  Frontmatter?: Record<string, React.ComponentType<{
+  Frontmatter?: Record<string, ComponentType<{
     value: unknown;
   }>>;
 };
@@ -255,6 +279,13 @@ declare global {
     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 {
@@ -328,27 +359,110 @@ declare function useFeedback(options?: UseFeedbackOptions): {
 //#endregion
 //#region src/client/components/docs-layout-default.d.ts
 interface DocsLayoutThemeProps {
-  children?: React.ReactNode;
+  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/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 the posts of a collection.
- * @param collection - The name of the collection.
- * @returns The posts of the collection.
+ * 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 usePosts(collection: string): CollectionPost$1[];
+declare function usePost(): CollectionPost$1 | undefined;
 declare function usePost(collection: string, slug: string): CollectionPost$1 | undefined;
 /**
- * Returns the recent posts of a collection.
- * @param collection - The name of the collection.
+ * 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[];
+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;
+}
+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;
+}
+declare function TimelineRoot({
+  children,
+  className,
+  compact,
+  ...props
+}: TimelineProps): _$react_jsx_runtime0.JSX.Element;
+declare function TimelineItem({
+  date,
+  title,
+  badge,
+  icon,
+  variant,
+  locale,
+  className,
+  children,
+  ...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;
@@ -424,9 +538,6 @@ declare function useCodeBlock(props: CodeBlockProps): {
   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 };
+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, type ComponentRoute, CopyMarkdown, CurrentPostProvider, DocsLayoutComponent as DocsLayout, ErrorBoundary, LayoutProps, MdxPage, Navbar, NavbarLink, NotFound, OnThisPage, OnThisPageProps, PageNav, SearchDialog, Sidebar, SidebarProps, SiteConfig, TabsProps, Timeline, type TimelineBadgeConfig, type TimelineItemProps, type TimelineProps, type TimelineVariant, 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-BAKgJ-Er.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-CfdalYLL.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-COTaMHR-.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-BMop1KLF.js";
 import { RouteRecord, ViteReactSSG } from "@bdocs/ssg";
 import * as _$react from "react";
 import React$1, { ComponentType, JSXElementConstructor, ReactNode } from "react";
@@ -22,9 +22,32 @@ interface CollectionPost$1 {
   locale?: string;
   version?: string;
   frontmatter?: Record<string, any>;
+  lastUpdated?: string | number | Date;
+  headings?: {
+    level: number;
+    text: string;
+    id: string;
+  }[];
+  draft?: boolean;
 }
 type CollectionsData = Record<string, CollectionPost$1[]>;
 declare const CollectionsContext: _$react.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 {
@@ -54,8 +77,9 @@ type MdxPageProps = {
 /**
  * Renders an MDX page by consuming pre-loaded route data.
  *
- * - If the route belongs to a collection (`data.collection` is set), renders
- *   the custom post component if provided, else falls back to the standard DocPage.
+ * - 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({
@@ -95,9 +119,9 @@ declare function useTheme(): ThemeContextType;
 //#endregion
 //#region src/client/app/mdx-components-context.d.ts
 type MdxComponentsType = {
-  [key: string]: React.ComponentType<HTMLElement>;
+  [key: string]: ComponentType<any>;
 } & {
-  Frontmatter?: Record<string, React.ComponentType<{
+  Frontmatter?: Record<string, ComponentType<{
     value: unknown;
   }>>;
 };
@@ -255,6 +279,13 @@ declare global {
     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 {
@@ -328,27 +359,110 @@ declare function useFeedback(options?: UseFeedbackOptions): {
 //#endregion
 //#region src/client/components/docs-layout-default.d.ts
 interface DocsLayoutThemeProps {
-  children?: React.ReactNode;
+  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/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 the posts of a collection.
- * @param collection - The name of the collection.
- * @returns The posts of the collection.
+ * 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 usePosts(collection: string): CollectionPost$1[];
+declare function usePost(): CollectionPost$1 | undefined;
 declare function usePost(collection: string, slug: string): CollectionPost$1 | undefined;
 /**
- * Returns the recent posts of a collection.
- * @param collection - The name of the collection.
+ * 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[];
+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;
+}
+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;
+}
+declare function TimelineRoot({
+  children,
+  className,
+  compact,
+  ...props
+}: TimelineProps): _$react_jsx_runtime0.JSX.Element;
+declare function TimelineItem({
+  date,
+  title,
+  badge,
+  icon,
+  variant,
+  locale,
+  className,
+  children,
+  ...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;
@@ -424,9 +538,6 @@ declare function useCodeBlock(props: CodeBlockProps): {
   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 };
+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, type ComponentRoute, CopyMarkdown, CurrentPostProvider, DocsLayoutComponent as DocsLayout, ErrorBoundary, LayoutProps, MdxPage, Navbar, NavbarLink, NotFound, OnThisPage, OnThisPageProps, PageNav, SearchDialog, Sidebar, SidebarProps, SiteConfig, TabsProps, Timeline, type TimelineBadgeConfig, type TimelineItemProps, type TimelineProps, type TimelineVariant, 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 };