boltdocs 3.0.1 → 3.1.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-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-DH2iPKXM.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-DdSgCs4G.cjs";
 import * as _$react from "react";
 import React$1, { ComponentType, JSXElementConstructor, ReactNode } from "react";
 import { RouteRecord, ViteReactSSG } from "@bdocs/ssg";
@@ -19,10 +19,35 @@ interface CollectionPost$1 {
   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;
 }
 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 {
@@ -52,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({
@@ -253,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 {
@@ -333,26 +366,34 @@ declare function DocsLayoutComponent({
 }: DocsLayoutThemeProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/client/collections/hooks.d.ts
+interface UsePostsOptions {
+  includeDrafts?: boolean;
+}
 /**
- * Returns the posts of a collection.
- * @param collection - The name of the collection.
- * @returns The posts of the collection.
+ * 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): CollectionPost$1[];
+declare function usePosts(collection?: string, options?: UsePostsOptions): CollectionPost$1[];
 /**
- * Returns a post by its slug.
- * @param collection - The name of the collection.
- * @param slug - The slug of the post.
- * @returns The post with the given slug.
+ * 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.
- * @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/utils/cn.d.ts
 declare function cn(...inputs: ClassValue[]): string;
@@ -433,4 +474,4 @@ declare function useCodeBlock(props: CodeBlockProps): {
   }>;
 };
 //#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, ComponentRoute, CopyMarkdown, CurrentPostProvider, 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-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-DknLUI1R.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-DjujkctF.js";
 import { RouteRecord, ViteReactSSG } from "@bdocs/ssg";
 import * as _$react from "react";
 import React$1, { ComponentType, JSXElementConstructor, ReactNode } from "react";
@@ -19,10 +19,35 @@ interface CollectionPost$1 {
   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;
 }
 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 {
@@ -52,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({
@@ -253,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 {
@@ -333,26 +366,34 @@ declare function DocsLayoutComponent({
 }: DocsLayoutThemeProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/client/collections/hooks.d.ts
+interface UsePostsOptions {
+  includeDrafts?: boolean;
+}
 /**
- * Returns the posts of a collection.
- * @param collection - The name of the collection.
- * @returns The posts of the collection.
+ * 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): CollectionPost$1[];
+declare function usePosts(collection?: string, options?: UsePostsOptions): CollectionPost$1[];
 /**
- * Returns a post by its slug.
- * @param collection - The name of the collection.
- * @param slug - The slug of the post.
- * @returns The post with the given slug.
+ * 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.
- * @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/utils/cn.d.ts
 declare function cn(...inputs: ClassValue[]): string;
@@ -433,4 +474,4 @@ declare function useCodeBlock(props: CodeBlockProps): {
   }>;
 };
 //#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, ComponentRoute, CopyMarkdown, CurrentPostProvider, 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 };