@asteroidcms/core-utils 0.1.7 → 0.2.0

package/dist/client.d.cts

@@ -294,4 +294,312 @@ declare function extractHeadingsFromElement(root: HTMLElement, options?: Extract
     scrollMarginTop?: number;
 }): ExtractedHeading[];
 
-export { AsteroidCMSProvider, type AsteroidCMSProviderProps, type ExtractHeadingsOptions, type ExtractedHeading, type HeadingLevel, RichTextContent, type UseCmsContentOptions, type UseCmsMutateOptions, extractHeadingsFromElement, extractHeadingsFromHtml, slugify, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };
+type SeoClientProps = {
+    title: string;
+    description: string;
+    url: string;
+    siteName?: string;
+    keywords?: string;
+    twitter?: string;
+    image?: string;
+    noindex?: boolean;
+};
+/** Theme colors used when generating dynamic OG images. */
+interface AsteroidOgImagePalette {
+    background: string;
+    foreground: string;
+    accent: string;
+    accentMuted?: string;
+    mutedText?: string;
+}
+interface AsteroidOgImageParams {
+    title: string;
+    subtitle?: string;
+    eyebrow?: string;
+    type?: "article" | "listing";
+}
+/** Site-level identity used to build the Organization/WebSite JSON-LD graph. */
+interface AsteroidOrganizationConfig {
+    logoUrl?: string;
+    contactEmail?: string;
+    contactPhone?: string;
+    address?: {
+        street?: string;
+        city?: string;
+        country?: string;
+    };
+    /** Generic list of profile URLs (LinkedIn, X, etc.). Maps to schema.org `sameAs`. */
+    socials?: string[];
+}
+/** Site-level SEO config passed into the headless Asteroid content components. */
+interface AsteroidSeoConfig {
+    siteName: string;
+    baseUrl: string;
+    twitter?: string;
+    defaultDescription?: string;
+    defaultKeywords?: string;
+    /** Path prefix for the article collection (e.g. `/blog`, `/news`, `/docs`). Default: `/blog` */
+    articlePath?: string;
+    /**
+     * Human label for the article collection, used in default titles/eyebrows
+     * (e.g. "Blog", "News", "Documentation"). Default: `"Articles"`.
+     */
+    contentLabel?: string;
+    /**
+     * Override how a raw page/article title becomes the final `<title>`.
+     * Default: `(title) => `${title} | ${siteName}``.
+     */
+    titleTemplate?: (title: string) => string;
+    ogImage?: {
+        palette: AsteroidOgImagePalette;
+        /** OG image API route path. Default: `/api/og` */
+        apiPath?: string;
+    };
+    /** Override dynamic OG image URL generation (e.g. custom CDN or renderer). */
+    getOgImageUrl?: (params: AsteroidOgImageParams) => string | undefined;
+    /** Site identity for the Organization/WebSite JSON-LD graph. */
+    organization?: AsteroidOrganizationConfig;
+    /** Extra schema.org @graph nodes (e.g. a ProfessionalService node). */
+    extraJsonLdNodes?: object[];
+    /** CMS base URL for resolving featured-image URLs. Required server-side for featured images. */
+    cmsUrl?: string;
+    /** URL to a PWA manifest.json. When set, a `<link rel="manifest">` is emitted. */
+    manifestUrl?: string;
+    /** Site-wide default robots policy. Per-page overrides are available on builder options. */
+    noindex?: boolean;
+}
+
+/** Render a JSON-LD <script>. Pass a built graph via `data`; renders nothing if absent. */
+declare function JsonLd({ data }: {
+    data?: object;
+}): react_jsx_runtime.JSX.Element | null;
+/**
+ * Imperatively sets document title, meta description, canonical URL and social
+ * tags. Works in plain React apps and Next.js client components. In a Next.js
+ * App Router app, prefer server `generateMetadata` from the `/next` entry.
+ */
+declare function Seo({ title, description, url, siteName, keywords, twitter, image, noindex, }: SeoClientProps): null;
+
+/** schema.org Article subtypes; pick per content kind. */
+type ArticleJsonLdType = "Article" | "BlogPosting" | "NewsArticle" | "TechArticle" | (string & {});
+
+/** Resolves a CMS asset id (or passthrough URL) to an absolute media URL. */
+type ArticleImageResolver = (idOrUrl?: string) => string;
+/** Minimal article post shape shared across Asteroid CMS apps. */
+interface AsteroidArticlePost {
+    slug: string;
+    title: string;
+    description?: string;
+    featured_image?: string;
+    featured?: boolean;
+    published_date?: string | null;
+    category?: {
+        slug: string;
+        name: string;
+        description?: string;
+    };
+}
+interface AsteroidArticleCategoryGroup<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    categoryName: string;
+    categorySlug: string;
+    posts: TPost[];
+}
+/** Runtime-agnostic computed state shared by client + server listing. */
+interface ArticlesViewState<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    posts: TPost[];
+    featured: TPost | null;
+    rest: TPost[];
+    categoryGroups: AsteroidArticleCategoryGroup<TPost>[];
+    isEmpty: boolean;
+    isSearching: boolean;
+    /** The effective (already-debounced, for client) search query. */
+    searchQuery: string;
+}
+type AsteroidArticlesEmptyReason = "error" | "no-posts" | "no-results";
+interface AsteroidArticlesSearchParams {
+    value: string;
+    onChange: (value: string) => void;
+    onSubmit: (event: {
+        preventDefault: () => void;
+    }) => void;
+}
+interface AsteroidArticlesHeaderParams {
+    eyebrow: ReactNode;
+    title: ReactNode;
+    description?: ReactNode;
+    search: ReactNode;
+}
+interface AsteroidArticlesFeaturedCardParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    post: TPost;
+    cmsImage: ArticleImageResolver;
+}
+interface AsteroidArticlesPostCardParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    post: TPost;
+    index: number;
+    group: AsteroidArticleCategoryGroup<TPost>;
+    cmsImage: ArticleImageResolver;
+}
+interface AsteroidArticlesPostGridParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    posts: TPost[];
+    group: AsteroidArticleCategoryGroup<TPost>;
+    children: ReactNode;
+}
+interface AsteroidArticlesCategoryHeadingParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    group: AsteroidArticleCategoryGroup<TPost>;
+}
+interface AsteroidArticlesCategoryGroupParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    group: AsteroidArticleCategoryGroup<TPost>;
+    defaultContent: ReactNode;
+}
+interface AsteroidArticlesEmptyParams {
+    reason: AsteroidArticlesEmptyReason;
+    searchQuery?: string;
+    error?: unknown;
+}
+interface AsteroidArticlesContentParams {
+    featured: ReactNode;
+    groups: ReactNode;
+    noSearchResults: ReactNode;
+}
+
+interface AsteroidArticlePagePost {
+    slug: string;
+    title: string;
+    description?: string;
+    content?: string;
+    featured_image?: string;
+    tags?: string;
+    published_date?: string | null;
+    category?: {
+        slug: string;
+        name: string;
+    };
+    author?: {
+        name: string;
+        bio?: string;
+    };
+}
+type Slot<TPost> = (params: {
+    post: TPost;
+    cmsImage: ArticleImageResolver;
+}) => ReactNode;
+interface ArticleBodyRenderProps<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost> {
+    backLink?: ReactNode;
+    renderHeader?: Slot<TPost>;
+    renderMeta?: Slot<TPost>;
+    renderDescription?: Slot<TPost>;
+    renderFeaturedImage?: Slot<TPost>;
+    renderToc?: Slot<TPost>;
+    renderContent?: Slot<TPost>;
+    renderPreArticle?: Slot<TPost>;
+    renderMidArticle?: Slot<TPost>;
+    renderPostArticle?: Slot<TPost>;
+    renderTags?: Slot<TPost>;
+    renderAuthorDetails?: Slot<TPost>;
+    renderRelatedPosts?: (params: {
+        post: TPost;
+        relatedPosts: TPost[];
+        cmsImage: ArticleImageResolver;
+    }) => ReactNode;
+    renderCTA?: Slot<TPost>;
+}
+
+type AsteroidArticlePageUseArticleResult<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost> = {
+    data?: TPost | null;
+    loading: boolean;
+    error?: unknown;
+};
+type AsteroidArticlePageUseArticle<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost> = (slug: string) => AsteroidArticlePageUseArticleResult<TPost>;
+interface AsteroidArticlePageProps<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost> extends ArticleBodyRenderProps<TPost> {
+    slug: string;
+    useArticle: AsteroidArticlePageUseArticle<TPost>;
+    seo?: AsteroidSeoConfig;
+    articleType?: ArticleJsonLdType;
+    noindex?: boolean;
+    relatedPosts?: TPost[];
+    renderRoot?: (params: {
+        children: ReactNode;
+    }) => ReactNode;
+    renderSkeleton?: () => ReactNode;
+    renderError?: (params: {
+        error?: unknown;
+        reason: "error" | "not-found";
+    }) => ReactNode;
+    renderJsonLd?: (params: {
+        post: TPost;
+    }) => ReactNode;
+    children?: (state: AsteroidArticlePageUseArticleResult<TPost>) => ReactNode;
+}
+declare function AsteroidArticlePage<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost>(props: AsteroidArticlePageProps<TPost>): react_jsx_runtime.JSX.Element;
+
+interface ArticlesListingRenderProps<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    eyebrow?: ReactNode;
+    title?: ReactNode;
+    description?: ReactNode;
+    renderRoot?: (params: {
+        children: ReactNode;
+    }) => ReactNode;
+    renderHeader?: (params: AsteroidArticlesHeaderParams) => ReactNode;
+    renderFeaturedCard?: (params: AsteroidArticlesFeaturedCardParams<TPost>) => ReactNode;
+    renderPostCard: (params: AsteroidArticlesPostCardParams<TPost>) => ReactNode;
+    renderCategoryHeading?: (params: AsteroidArticlesCategoryHeadingParams<TPost>) => ReactNode;
+    renderPostGrid?: (params: AsteroidArticlesPostGridParams<TPost>) => ReactNode;
+    renderCategoryGroup?: (params: AsteroidArticlesCategoryGroupParams<TPost>) => ReactNode;
+    renderSkeleton?: () => ReactNode;
+    renderEmpty?: (params: AsteroidArticlesEmptyParams) => ReactNode;
+    renderContent?: (params: AsteroidArticlesContentParams) => ReactNode;
+}
+
+interface AsteroidArticlesUsePostsResult<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    posts: TPost[];
+    featured?: TPost | null;
+    rest?: TPost[];
+    loading: boolean;
+    error?: unknown;
+}
+type AsteroidArticlesUsePosts<TPost extends AsteroidArticlePost = AsteroidArticlePost> = (searchQuery: string) => AsteroidArticlesUsePostsResult<TPost>;
+interface AsteroidArticlesState<TPost extends AsteroidArticlePost = AsteroidArticlePost> extends ArticlesViewState<TPost> {
+    loading: boolean;
+    error: unknown;
+    hasError: boolean;
+    /** Raw, un-debounced input value. Bind your search box to this. */
+    inputValue: string;
+    setSearchQuery: (value: string) => void;
+}
+interface AsteroidArticlesProps<TPost extends AsteroidArticlePost = AsteroidArticlePost> extends ArticlesListingRenderProps<TPost> {
+    usePosts: AsteroidArticlesUsePosts<TPost>;
+    categorySlug?: string;
+    articleSlug?: string;
+    searchDebounceMs?: number;
+    seo?: AsteroidSeoConfig;
+    noindex?: boolean;
+    renderSearch?: (params: AsteroidArticlesSearchParams) => ReactNode;
+    renderJsonLd?: (state: AsteroidArticlesState<TPost>) => ReactNode;
+    groupPostsByCategory?: (posts: TPost[]) => AsteroidArticleCategoryGroup<TPost>[];
+    children?: (state: AsteroidArticlesState<TPost>) => ReactNode;
+}
+declare function useAsteroidArticlesState<TPost extends AsteroidArticlePost = AsteroidArticlePost>(props: Pick<AsteroidArticlesProps<TPost>, "usePosts" | "categorySlug" | "articleSlug" | "searchDebounceMs" | "groupPostsByCategory">): AsteroidArticlesState<TPost>;
+declare function AsteroidArticlesListing<TPost extends AsteroidArticlePost = AsteroidArticlePost>(props: AsteroidArticlesProps<TPost>): react_jsx_runtime.JSX.Element;
+
+declare function defaultGetCategoryName(post: Pick<AsteroidArticlePost, "category">): string | undefined;
+declare function defaultGroupPostsByCategory<TPost extends AsteroidArticlePost = AsteroidArticlePost>(posts: TPost[]): AsteroidArticleCategoryGroup<TPost>[];
+
+interface ArticleSearchBoxProps {
+    /** URL query param the search writes to. Default: "q". */
+    paramKey?: string;
+    placeholder?: string;
+    /** Debounce before navigating. Default: 500ms. */
+    debounceMs?: number;
+    className?: string;
+    /** Override the default input UI. */
+    render?: (params: {
+        value: string;
+        onChange: (value: string) => void;
+        onSubmit: (event: {
+            preventDefault: () => void;
+        }) => void;
+    }) => ReactNode;
+}
+declare function ArticleSearchBox({ paramKey, placeholder, debounceMs, className, render, }: ArticleSearchBoxProps): react_jsx_runtime.JSX.Element;
+
+export { type ArticleBodyRenderProps, type ArticleImageResolver, ArticleSearchBox, type ArticleSearchBoxProps, type AsteroidArticleCategoryGroup, AsteroidArticlePage, type AsteroidArticlePagePost, type AsteroidArticlePageProps, type AsteroidArticlePageUseArticle, type AsteroidArticlePageUseArticleResult, type AsteroidArticlePost, type AsteroidArticlesCategoryGroupParams, type AsteroidArticlesCategoryHeadingParams, type AsteroidArticlesContentParams, type AsteroidArticlesEmptyParams, type AsteroidArticlesEmptyReason, type AsteroidArticlesFeaturedCardParams, type AsteroidArticlesHeaderParams, AsteroidArticlesListing, type AsteroidArticlesPostCardParams, type AsteroidArticlesPostGridParams, type AsteroidArticlesProps, type AsteroidArticlesSearchParams, type AsteroidArticlesState, type AsteroidArticlesUsePosts, type AsteroidArticlesUsePostsResult, AsteroidCMSProvider, type AsteroidCMSProviderProps, type ExtractHeadingsOptions, type ExtractedHeading, type HeadingLevel, JsonLd, RichTextContent, Seo, type UseCmsContentOptions, type UseCmsMutateOptions, defaultGetCategoryName, defaultGroupPostsByCategory, extractHeadingsFromElement, extractHeadingsFromHtml, slugify, useAsteroidArticlesState, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };

package/dist/client.d.ts

@@ -294,4 +294,312 @@ declare function extractHeadingsFromElement(root: HTMLElement, options?: Extract
     scrollMarginTop?: number;
 }): ExtractedHeading[];
 
-export { AsteroidCMSProvider, type AsteroidCMSProviderProps, type ExtractHeadingsOptions, type ExtractedHeading, type HeadingLevel, RichTextContent, type UseCmsContentOptions, type UseCmsMutateOptions, extractHeadingsFromElement, extractHeadingsFromHtml, slugify, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };
+type SeoClientProps = {
+    title: string;
+    description: string;
+    url: string;
+    siteName?: string;
+    keywords?: string;
+    twitter?: string;
+    image?: string;
+    noindex?: boolean;
+};
+/** Theme colors used when generating dynamic OG images. */
+interface AsteroidOgImagePalette {
+    background: string;
+    foreground: string;
+    accent: string;
+    accentMuted?: string;
+    mutedText?: string;
+}
+interface AsteroidOgImageParams {
+    title: string;
+    subtitle?: string;
+    eyebrow?: string;
+    type?: "article" | "listing";
+}
+/** Site-level identity used to build the Organization/WebSite JSON-LD graph. */
+interface AsteroidOrganizationConfig {
+    logoUrl?: string;
+    contactEmail?: string;
+    contactPhone?: string;
+    address?: {
+        street?: string;
+        city?: string;
+        country?: string;
+    };
+    /** Generic list of profile URLs (LinkedIn, X, etc.). Maps to schema.org `sameAs`. */
+    socials?: string[];
+}
+/** Site-level SEO config passed into the headless Asteroid content components. */
+interface AsteroidSeoConfig {
+    siteName: string;
+    baseUrl: string;
+    twitter?: string;
+    defaultDescription?: string;
+    defaultKeywords?: string;
+    /** Path prefix for the article collection (e.g. `/blog`, `/news`, `/docs`). Default: `/blog` */
+    articlePath?: string;
+    /**
+     * Human label for the article collection, used in default titles/eyebrows
+     * (e.g. "Blog", "News", "Documentation"). Default: `"Articles"`.
+     */
+    contentLabel?: string;
+    /**
+     * Override how a raw page/article title becomes the final `<title>`.
+     * Default: `(title) => `${title} | ${siteName}``.
+     */
+    titleTemplate?: (title: string) => string;
+    ogImage?: {
+        palette: AsteroidOgImagePalette;
+        /** OG image API route path. Default: `/api/og` */
+        apiPath?: string;
+    };
+    /** Override dynamic OG image URL generation (e.g. custom CDN or renderer). */
+    getOgImageUrl?: (params: AsteroidOgImageParams) => string | undefined;
+    /** Site identity for the Organization/WebSite JSON-LD graph. */
+    organization?: AsteroidOrganizationConfig;
+    /** Extra schema.org @graph nodes (e.g. a ProfessionalService node). */
+    extraJsonLdNodes?: object[];
+    /** CMS base URL for resolving featured-image URLs. Required server-side for featured images. */
+    cmsUrl?: string;
+    /** URL to a PWA manifest.json. When set, a `<link rel="manifest">` is emitted. */
+    manifestUrl?: string;
+    /** Site-wide default robots policy. Per-page overrides are available on builder options. */
+    noindex?: boolean;
+}
+
+/** Render a JSON-LD <script>. Pass a built graph via `data`; renders nothing if absent. */
+declare function JsonLd({ data }: {
+    data?: object;
+}): react_jsx_runtime.JSX.Element | null;
+/**
+ * Imperatively sets document title, meta description, canonical URL and social
+ * tags. Works in plain React apps and Next.js client components. In a Next.js
+ * App Router app, prefer server `generateMetadata` from the `/next` entry.
+ */
+declare function Seo({ title, description, url, siteName, keywords, twitter, image, noindex, }: SeoClientProps): null;
+
+/** schema.org Article subtypes; pick per content kind. */
+type ArticleJsonLdType = "Article" | "BlogPosting" | "NewsArticle" | "TechArticle" | (string & {});
+
+/** Resolves a CMS asset id (or passthrough URL) to an absolute media URL. */
+type ArticleImageResolver = (idOrUrl?: string) => string;
+/** Minimal article post shape shared across Asteroid CMS apps. */
+interface AsteroidArticlePost {
+    slug: string;
+    title: string;
+    description?: string;
+    featured_image?: string;
+    featured?: boolean;
+    published_date?: string | null;
+    category?: {
+        slug: string;
+        name: string;
+        description?: string;
+    };
+}
+interface AsteroidArticleCategoryGroup<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    categoryName: string;
+    categorySlug: string;
+    posts: TPost[];
+}
+/** Runtime-agnostic computed state shared by client + server listing. */
+interface ArticlesViewState<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    posts: TPost[];
+    featured: TPost | null;
+    rest: TPost[];
+    categoryGroups: AsteroidArticleCategoryGroup<TPost>[];
+    isEmpty: boolean;
+    isSearching: boolean;
+    /** The effective (already-debounced, for client) search query. */
+    searchQuery: string;
+}
+type AsteroidArticlesEmptyReason = "error" | "no-posts" | "no-results";
+interface AsteroidArticlesSearchParams {
+    value: string;
+    onChange: (value: string) => void;
+    onSubmit: (event: {
+        preventDefault: () => void;
+    }) => void;
+}
+interface AsteroidArticlesHeaderParams {
+    eyebrow: ReactNode;
+    title: ReactNode;
+    description?: ReactNode;
+    search: ReactNode;
+}
+interface AsteroidArticlesFeaturedCardParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    post: TPost;
+    cmsImage: ArticleImageResolver;
+}
+interface AsteroidArticlesPostCardParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    post: TPost;
+    index: number;
+    group: AsteroidArticleCategoryGroup<TPost>;
+    cmsImage: ArticleImageResolver;
+}
+interface AsteroidArticlesPostGridParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    posts: TPost[];
+    group: AsteroidArticleCategoryGroup<TPost>;
+    children: ReactNode;
+}
+interface AsteroidArticlesCategoryHeadingParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    group: AsteroidArticleCategoryGroup<TPost>;
+}
+interface AsteroidArticlesCategoryGroupParams<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    group: AsteroidArticleCategoryGroup<TPost>;
+    defaultContent: ReactNode;
+}
+interface AsteroidArticlesEmptyParams {
+    reason: AsteroidArticlesEmptyReason;
+    searchQuery?: string;
+    error?: unknown;
+}
+interface AsteroidArticlesContentParams {
+    featured: ReactNode;
+    groups: ReactNode;
+    noSearchResults: ReactNode;
+}
+
+interface AsteroidArticlePagePost {
+    slug: string;
+    title: string;
+    description?: string;
+    content?: string;
+    featured_image?: string;
+    tags?: string;
+    published_date?: string | null;
+    category?: {
+        slug: string;
+        name: string;
+    };
+    author?: {
+        name: string;
+        bio?: string;
+    };
+}
+type Slot<TPost> = (params: {
+    post: TPost;
+    cmsImage: ArticleImageResolver;
+}) => ReactNode;
+interface ArticleBodyRenderProps<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost> {
+    backLink?: ReactNode;
+    renderHeader?: Slot<TPost>;
+    renderMeta?: Slot<TPost>;
+    renderDescription?: Slot<TPost>;
+    renderFeaturedImage?: Slot<TPost>;
+    renderToc?: Slot<TPost>;
+    renderContent?: Slot<TPost>;
+    renderPreArticle?: Slot<TPost>;
+    renderMidArticle?: Slot<TPost>;
+    renderPostArticle?: Slot<TPost>;
+    renderTags?: Slot<TPost>;
+    renderAuthorDetails?: Slot<TPost>;
+    renderRelatedPosts?: (params: {
+        post: TPost;
+        relatedPosts: TPost[];
+        cmsImage: ArticleImageResolver;
+    }) => ReactNode;
+    renderCTA?: Slot<TPost>;
+}
+
+type AsteroidArticlePageUseArticleResult<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost> = {
+    data?: TPost | null;
+    loading: boolean;
+    error?: unknown;
+};
+type AsteroidArticlePageUseArticle<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost> = (slug: string) => AsteroidArticlePageUseArticleResult<TPost>;
+interface AsteroidArticlePageProps<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost> extends ArticleBodyRenderProps<TPost> {
+    slug: string;
+    useArticle: AsteroidArticlePageUseArticle<TPost>;
+    seo?: AsteroidSeoConfig;
+    articleType?: ArticleJsonLdType;
+    noindex?: boolean;
+    relatedPosts?: TPost[];
+    renderRoot?: (params: {
+        children: ReactNode;
+    }) => ReactNode;
+    renderSkeleton?: () => ReactNode;
+    renderError?: (params: {
+        error?: unknown;
+        reason: "error" | "not-found";
+    }) => ReactNode;
+    renderJsonLd?: (params: {
+        post: TPost;
+    }) => ReactNode;
+    children?: (state: AsteroidArticlePageUseArticleResult<TPost>) => ReactNode;
+}
+declare function AsteroidArticlePage<TPost extends AsteroidArticlePagePost = AsteroidArticlePagePost>(props: AsteroidArticlePageProps<TPost>): react_jsx_runtime.JSX.Element;
+
+interface ArticlesListingRenderProps<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    eyebrow?: ReactNode;
+    title?: ReactNode;
+    description?: ReactNode;
+    renderRoot?: (params: {
+        children: ReactNode;
+    }) => ReactNode;
+    renderHeader?: (params: AsteroidArticlesHeaderParams) => ReactNode;
+    renderFeaturedCard?: (params: AsteroidArticlesFeaturedCardParams<TPost>) => ReactNode;
+    renderPostCard: (params: AsteroidArticlesPostCardParams<TPost>) => ReactNode;
+    renderCategoryHeading?: (params: AsteroidArticlesCategoryHeadingParams<TPost>) => ReactNode;
+    renderPostGrid?: (params: AsteroidArticlesPostGridParams<TPost>) => ReactNode;
+    renderCategoryGroup?: (params: AsteroidArticlesCategoryGroupParams<TPost>) => ReactNode;
+    renderSkeleton?: () => ReactNode;
+    renderEmpty?: (params: AsteroidArticlesEmptyParams) => ReactNode;
+    renderContent?: (params: AsteroidArticlesContentParams) => ReactNode;
+}
+
+interface AsteroidArticlesUsePostsResult<TPost extends AsteroidArticlePost = AsteroidArticlePost> {
+    posts: TPost[];
+    featured?: TPost | null;
+    rest?: TPost[];
+    loading: boolean;
+    error?: unknown;
+}
+type AsteroidArticlesUsePosts<TPost extends AsteroidArticlePost = AsteroidArticlePost> = (searchQuery: string) => AsteroidArticlesUsePostsResult<TPost>;
+interface AsteroidArticlesState<TPost extends AsteroidArticlePost = AsteroidArticlePost> extends ArticlesViewState<TPost> {
+    loading: boolean;
+    error: unknown;
+    hasError: boolean;
+    /** Raw, un-debounced input value. Bind your search box to this. */
+    inputValue: string;
+    setSearchQuery: (value: string) => void;
+}
+interface AsteroidArticlesProps<TPost extends AsteroidArticlePost = AsteroidArticlePost> extends ArticlesListingRenderProps<TPost> {
+    usePosts: AsteroidArticlesUsePosts<TPost>;
+    categorySlug?: string;
+    articleSlug?: string;
+    searchDebounceMs?: number;
+    seo?: AsteroidSeoConfig;
+    noindex?: boolean;
+    renderSearch?: (params: AsteroidArticlesSearchParams) => ReactNode;
+    renderJsonLd?: (state: AsteroidArticlesState<TPost>) => ReactNode;
+    groupPostsByCategory?: (posts: TPost[]) => AsteroidArticleCategoryGroup<TPost>[];
+    children?: (state: AsteroidArticlesState<TPost>) => ReactNode;
+}
+declare function useAsteroidArticlesState<TPost extends AsteroidArticlePost = AsteroidArticlePost>(props: Pick<AsteroidArticlesProps<TPost>, "usePosts" | "categorySlug" | "articleSlug" | "searchDebounceMs" | "groupPostsByCategory">): AsteroidArticlesState<TPost>;
+declare function AsteroidArticlesListing<TPost extends AsteroidArticlePost = AsteroidArticlePost>(props: AsteroidArticlesProps<TPost>): react_jsx_runtime.JSX.Element;
+
+declare function defaultGetCategoryName(post: Pick<AsteroidArticlePost, "category">): string | undefined;
+declare function defaultGroupPostsByCategory<TPost extends AsteroidArticlePost = AsteroidArticlePost>(posts: TPost[]): AsteroidArticleCategoryGroup<TPost>[];
+
+interface ArticleSearchBoxProps {
+    /** URL query param the search writes to. Default: "q". */
+    paramKey?: string;
+    placeholder?: string;
+    /** Debounce before navigating. Default: 500ms. */
+    debounceMs?: number;
+    className?: string;
+    /** Override the default input UI. */
+    render?: (params: {
+        value: string;
+        onChange: (value: string) => void;
+        onSubmit: (event: {
+            preventDefault: () => void;
+        }) => void;
+    }) => ReactNode;
+}
+declare function ArticleSearchBox({ paramKey, placeholder, debounceMs, className, render, }: ArticleSearchBoxProps): react_jsx_runtime.JSX.Element;
+
+export { type ArticleBodyRenderProps, type ArticleImageResolver, ArticleSearchBox, type ArticleSearchBoxProps, type AsteroidArticleCategoryGroup, AsteroidArticlePage, type AsteroidArticlePagePost, type AsteroidArticlePageProps, type AsteroidArticlePageUseArticle, type AsteroidArticlePageUseArticleResult, type AsteroidArticlePost, type AsteroidArticlesCategoryGroupParams, type AsteroidArticlesCategoryHeadingParams, type AsteroidArticlesContentParams, type AsteroidArticlesEmptyParams, type AsteroidArticlesEmptyReason, type AsteroidArticlesFeaturedCardParams, type AsteroidArticlesHeaderParams, AsteroidArticlesListing, type AsteroidArticlesPostCardParams, type AsteroidArticlesPostGridParams, type AsteroidArticlesProps, type AsteroidArticlesSearchParams, type AsteroidArticlesState, type AsteroidArticlesUsePosts, type AsteroidArticlesUsePostsResult, AsteroidCMSProvider, type AsteroidCMSProviderProps, type ExtractHeadingsOptions, type ExtractedHeading, type HeadingLevel, JsonLd, RichTextContent, Seo, type UseCmsContentOptions, type UseCmsMutateOptions, defaultGetCategoryName, defaultGroupPostsByCategory, extractHeadingsFromElement, extractHeadingsFromHtml, slugify, useAsteroidArticlesState, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };