@fullstackdatasolutions/articles 0.8.2 → 0.10.0

package/dist/server.d.ts

@@ -21,6 +21,7 @@ interface Article {
     date?: string;
     lastmod?: string;
     author: string;
+    authors?: string[];
     category: string;
     categories: string[];
     readTime: string;
@@ -45,6 +46,35 @@ interface CategoryInfo {
     count: number;
     featuredImage: string;
 }
+interface AuthorSocial {
+    website?: string;
+    facebook?: string;
+    twitter?: string;
+    x?: string;
+    linkedin?: string;
+    instagram?: string;
+    youtube?: string;
+    tiktok?: string;
+    github?: string;
+    bluesky?: string;
+    threads?: string;
+    mastodon?: string;
+    medium?: string;
+    newsletter?: string;
+    other?: Record<string, string>;
+}
+interface AuthorProfile {
+    name: string;
+    slug: string;
+    bio: string;
+    avatar?: string;
+    url?: string;
+    social?: AuthorSocial;
+}
+interface BreadcrumbItem {
+    name: string;
+    url?: string;
+}
 
 /** Keys for each renderable section of the articles listing page. */
 type ArticlesSection = 'hero' | 'search' | 'featured' | 'latest' | 'categories' | 'newsletter';
@@ -104,6 +134,41 @@ interface HeroConfig {
     /** Subheading paragraph displayed beneath the title. Default: the built-in description. */
     description?: string;
 }
+/** Controls how article body links set target/rel attributes. */
+type LinkTargetStrategy = 'external-new-tab' | 'all-new-tab' | 'same-tab';
+type ArticleBreadcrumbToken = 'home' | 'articles' | 'primaryCategory' | 'folderPath' | 'articleTitle';
+type CategoryBreadcrumbToken = 'home' | 'articles' | 'category';
+type AuthorBreadcrumbToken = 'home' | 'articles' | 'authors' | 'authorName';
+interface CustomBreadcrumbItem {
+    /** Label displayed in the breadcrumb trail. */
+    name: string;
+    /** Custom URL. Relative paths are resolved against `siteUrl` by server builders. */
+    url: string;
+}
+type ArticleBreadcrumbEntry = ArticleBreadcrumbToken | CustomBreadcrumbItem;
+type CategoryBreadcrumbEntry = CategoryBreadcrumbToken | CustomBreadcrumbItem;
+type AuthorBreadcrumbEntry = AuthorBreadcrumbToken | CustomBreadcrumbItem;
+interface BreadcrumbLabels {
+    home?: string;
+    articles?: string;
+    authors?: string;
+}
+interface BreadcrumbsConfig {
+    /** Set to false to hide visible breadcrumbs and breadcrumb JSON-LD generated by the helper builders. */
+    show?: boolean;
+    /** Separator used by the visible Breadcrumb component. Default: '>'. */
+    separator?: string;
+    /** Set to false to render visible breadcrumbs without JSON-LD. Default: true. */
+    showSchema?: boolean;
+    /** Article breadcrumb trail. Example: ['primaryCategory', { name: 'Guides', url: '/guides' }, 'articleTitle']. */
+    article?: ArticleBreadcrumbEntry[];
+    /** Category breadcrumb trail. Default: ['home', 'articles', 'category']. */
+    category?: CategoryBreadcrumbEntry[];
+    /** Author breadcrumb trail. Default: ['home', 'articles', 'authors', 'authorName']. */
+    author?: AuthorBreadcrumbEntry[];
+    /** Optional label overrides for built-in breadcrumb items. */
+    labels?: BreadcrumbLabels;
+}
 /** Top-level configuration object. Pass one instance to every library component. */
 interface ArticlesConfig {
     /** Canonical base URL of the site, used in metadata and JSON-LD. Example: `'https://yoursite.com'` */
@@ -139,12 +204,26 @@ interface ArticlesConfig {
     showBackToArticles?: boolean;
     /** Set to false to hide author names from UI and metadata. Default: true. */
     showAuthor?: boolean;
+    /** Author profiles keyed by slug. Omit to keep plain string author display. */
+    authors?: Record<string, AuthorProfile>;
+    /** Author slug used when article frontmatter omits author fields. */
+    defaultAuthor?: string;
+    /** Set to false to disable copied author page routes in consuming apps. Default: true. */
+    showAuthorPage?: boolean;
+    /** Set to false to disable breadcrumbs, or pass a config object to customize breadcrumb trails. */
+    breadcrumbs?: false | BreadcrumbsConfig;
+    /** Article body link target behavior. Default: `'external-new-tab'`. */
+    linkTargetStrategy?: LinkTargetStrategy;
 }
+declare function getBreadcrumbsConfig(config: ArticlesConfig): BreadcrumbsConfig;
 
 declare function sanitizeImagePath(rawPath: string, articleSlug: string): string | null;
 declare function getAvailableArticleSlugs(): string[];
-declare const getArticleMetadata: (slug: string) => Promise<Article | null>;
-declare const getAllArticles: () => Promise<Article[]>;
+declare function getAuthorBySlug(slug: string, config: ArticlesConfig): AuthorProfile | null;
+declare function getArticleAuthors(article: Article, config: ArticlesConfig): AuthorProfile[];
+declare function getAllAuthors(config: ArticlesConfig): AuthorProfile[];
+declare const getArticleMetadata: (slug: string, config?: ArticlesConfig) => Promise<Article | null>;
+declare const getAllArticles: (config?: ArticlesConfig) => Promise<Article[]>;
 declare function getAdjacentArticles(currentSlug: string): Promise<{
     previous: Article | null;
     next: Article | null;
@@ -157,20 +236,30 @@ declare function getAiRobotsTxtRules(): Promise<string>;
 declare function searchArticles(query: string, config?: ArticlesConfig): Promise<Article[]>;
 declare function categoryToSlug(category: string): string;
 declare function getAllCategories(): Promise<CategoryInfo[]>;
-declare function getArticlesByCategory(categorySlug: string): Promise<Article[]>;
+declare function getArticlesByCategory(categorySlug: string, config?: ArticlesConfig): Promise<Article[]>;
+declare function getArticlesByAuthor(authorSlug: string, config: ArticlesConfig): Promise<Article[]>;
 
+declare function generateRssFeed(articles: Article[], config: ArticlesConfig): string;
 declare function generateArticleStaticParams(): {
     slug: string;
 }[];
 declare function generateCategoryStaticParams(): Promise<{
     category: string;
 }[]>;
+declare function generateAuthorStaticParams(config: ArticlesConfig): {
+    author: string;
+}[];
 declare function generateArticleMetadata(slug: string, config: ArticlesConfig): Promise<Metadata>;
 declare function generateArticlesIndexMetadata(config: ArticlesConfig): Metadata;
 declare function generateCategoryMetadata(categorySlug: string, config: ArticlesConfig): Promise<Metadata>;
+declare function generateAuthorMetadata(authorSlug: string, config: ArticlesConfig): Promise<Metadata>;
+declare function buildArticleBreadcrumbs(article: Pick<Article, 'slug' | 'title' | 'category'>, config: ArticlesConfig): BreadcrumbItem[];
+declare function buildCategoryBreadcrumbs(category: string, config: ArticlesConfig, categoryName?: string): BreadcrumbItem[];
+declare function buildAuthorBreadcrumbs(author: AuthorProfile, config: ArticlesConfig): BreadcrumbItem[];
+declare function resolveAuthorAvatar(author: AuthorProfile, config: ArticlesConfig): string;
 declare function getArticleSitemapEntries(baseUrlOrConfig: string | ArticlesConfig): Promise<MetadataRoute.Sitemap>;
 
-declare function markdownToHtml(markdown: string, articleSlug?: string): Promise<string>;
+declare function markdownToHtml(markdown: string, articleSlug?: string, config?: ArticlesConfig): Promise<string>;
 declare function extractToc(markdown: string): Promise<TocItem[]>;
 
 type ArticlesErrorCode = 'article-directory-read-failed' | 'article-load-failed' | 'article-markdown-load-failed' | 'markdown-conversion-failed' | 'unsafe-image-path';
@@ -187,8 +276,9 @@ declare function setArticlesErrorHandler(handler?: ArticlesErrorHandler): void;
 type ArticleContentProps = Readonly<{
     article: Article;
     className?: string;
+    config?: ArticlesConfig;
 }>;
-declare function ArticleContent({ article, className }: ArticleContentProps): Promise<react_jsx_runtime.JSX.Element>;
+declare function ArticleContent({ article, className, config }: ArticleContentProps): Promise<react_jsx_runtime.JSX.Element>;
 
 type ArticleTOCProps = Readonly<{
     toc: TocItem[];
@@ -196,4 +286,4 @@ type ArticleTOCProps = Readonly<{
 }>;
 declare function ArticleTOC({ toc, className }: ArticleTOCProps): react_jsx_runtime.JSX.Element | null;
 
-export { type Article, ArticleContent, ArticleTOC, type ArticlesConfig, type ArticlesErrorCode, type ArticlesErrorContext, type ArticlesErrorHandler, type ArticlesErrorReport, type CategoryInfo, type TocItem, categoryToSlug, extractToc, generateArticleMetadata, generateArticleStaticParams, generateArticlesIndexMetadata, generateCategoryMetadata, generateCategoryStaticParams, getAdjacentArticles, getAiRobotsTxtRules, getAllArticles, getAllCategories, getArticleAiHeaders, getArticleMarkdown, getArticleMarkdownResponse, getArticleMarkdownUrl, getArticleMetadata, getArticleSitemapEntries, getArticlesByCategory, getAvailableArticleSlugs, markdownToHtml, sanitizeImagePath, searchArticles, setArticlesErrorHandler };
+export { type Article, ArticleContent, ArticleTOC, type ArticlesConfig, type ArticlesErrorCode, type ArticlesErrorContext, type ArticlesErrorHandler, type ArticlesErrorReport, type AuthorProfile, type AuthorSocial, type BreadcrumbItem, type CategoryInfo, type LinkTargetStrategy, type TocItem, buildArticleBreadcrumbs, buildAuthorBreadcrumbs, buildCategoryBreadcrumbs, categoryToSlug, extractToc, generateArticleMetadata, generateArticleStaticParams, generateArticlesIndexMetadata, generateAuthorMetadata, generateAuthorStaticParams, generateCategoryMetadata, generateCategoryStaticParams, generateRssFeed, getAdjacentArticles, getAiRobotsTxtRules, getAllArticles, getAllAuthors, getAllCategories, getArticleAiHeaders, getArticleAuthors, getArticleMarkdown, getArticleMarkdownResponse, getArticleMarkdownUrl, getArticleMetadata, getArticleSitemapEntries, getArticlesByAuthor, getArticlesByCategory, getAuthorBySlug, getAvailableArticleSlugs, getBreadcrumbsConfig, markdownToHtml, resolveAuthorAvatar, sanitizeImagePath, searchArticles, setArticlesErrorHandler };