@fullstackdatasolutions/articles 0.4.2 → 0.5.0

package/dist/index.d.ts

@@ -85,6 +85,10 @@ interface ArticlesConfig {
     comments?: CommentsConfig;
     /** Hero section title and description. Omit to use the built-in defaults. */
     hero?: HeroConfig;
+    /** Short description used in the RSS feed channel. Falls back to siteName if omitted. */
+    description?: string;
+    /** Set to false to hide the table of contents on article detail pages. Default: true. */
+    showToc?: boolean;
 }
 declare const DEFAULT_PAGE_SIZE = 6;
 declare const DEFAULT_CATEGORIES_PAGE_SIZE = 8;
@@ -94,11 +98,25 @@ declare function ArticlesPage({ config }: Readonly<{
     config: ArticlesConfig;
 }>): react_jsx_runtime.JSX.Element;
 
+interface TocItem {
+    id: string;
+    depth: number;
+    text: string;
+}
+interface FaqItem {
+    question: string;
+    answer: string;
+}
+interface HowToStep {
+    name: string;
+    text: string;
+}
 interface Article {
     slug: string;
     title: string;
     excerpt: string;
     date?: string;
+    lastmod?: string;
     author: string;
     category: string;
     categories: string[];
@@ -107,6 +125,15 @@ interface Article {
     tags?: string[];
     content?: string;
     htmlContent?: string;
+    mdxSource?: string;
+    contentType?: 'md' | 'mdx';
+    draft?: boolean;
+    toc?: TocItem[];
+    faq?: FaqItem[];
+    howTo?: HowToStep[];
+    canonicalUrl?: string;
+    articleType?: string;
+    series?: string;
 }
 interface CategoryInfo {
     name: string;
@@ -186,6 +213,20 @@ type BreadcrumbSchemaProps = Readonly<{
     }>;
 }>;
 declare function BreadcrumbSchema({ items }: BreadcrumbSchemaProps): react_jsx_runtime.JSX.Element;
+type ArticleSEOProps = Readonly<{
+    article: Article;
+    articleUrl: string;
+    siteName: string;
+    siteLogo?: string;
+}>;
+declare function ArticleSEO({ article, articleUrl, siteName, siteLogo }: ArticleSEOProps): react_jsx_runtime.JSX.Element;
+type FAQPageSchemaProps = Readonly<{
+    items: ReadonlyArray<{
+        question: string;
+        answer: string;
+    }>;
+}>;
+declare function FAQPageSchema({ items }: FAQPageSchemaProps): react_jsx_runtime.JSX.Element;
 type CollectionPageSchemaProps = Readonly<{
     title: string;
     description: string;
@@ -215,6 +256,14 @@ interface ArticleNavigationProps {
 }
 declare function ArticleNavigation({ previous, next, basePath }: ArticleNavigationProps): react_jsx_runtime.JSX.Element | null;
 
+type ArticleTOCProps = Readonly<{
+    toc: TocItem[];
+    className?: string;
+}>;
+declare function ArticleTOC({ toc, className }: ArticleTOCProps): react_jsx_runtime.JSX.Element | null;
+
+declare function ScrollToTop(): react_jsx_runtime.JSX.Element | null;
+
 interface CommentsSectionProps {
     readonly articleSlug: string;
     readonly config: CommentsConfig;
@@ -270,4 +319,4 @@ interface UseArticlesReturn {
 }
 declare function useArticles(): UseArticlesReturn;
 
-export { type Article, ArticleCard, ArticleCategoryGrid, type ArticleComment, type ArticleCommentWithReplies, ArticleDetailHero, ArticleNavigation, ArticleSchema, ArticleSearchBar, ArticleSocialShare, type ArticlesConfig, ArticlesHero, ArticlesPage, type ArticlesSection, type ArticlesTheme, BreadcrumbSchema, CategoryArticlesPage, type CategoryDescription, type CategoryInfo, CollectionPageSchema, CommentForm, CommentItem, CommentThread, type CommentsConfig, CommentsSection, DEFAULT_CATEGORIES_PAGE_SIZE, DEFAULT_LAYOUT, DEFAULT_PAGE_SIZE, FeaturedArticle, LatestArticles, LatestArticlesSection, type UseArticlesReturn, useArticles };
+export { type Article, ArticleCard, ArticleCategoryGrid, type ArticleComment, type ArticleCommentWithReplies, ArticleDetailHero, ArticleNavigation, ArticleSEO, ArticleSchema, ArticleSearchBar, ArticleSocialShare, ArticleTOC, type ArticlesConfig, ArticlesHero, ArticlesPage, type ArticlesSection, type ArticlesTheme, BreadcrumbSchema, CategoryArticlesPage, type CategoryDescription, type CategoryInfo, CollectionPageSchema, CommentForm, CommentItem, CommentThread, type CommentsConfig, CommentsSection, DEFAULT_CATEGORIES_PAGE_SIZE, DEFAULT_LAYOUT, DEFAULT_PAGE_SIZE, FAQPageSchema, type FaqItem, FeaturedArticle, type HowToStep, LatestArticles, LatestArticlesSection, ScrollToTop, type TocItem, type UseArticlesReturn, useArticles };