@xexr/blog-platform 1.0.7 → 1.0.9

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { PublishedArticle, PublishedSite, PublishedTopic, PublishResult, PublishedAuthor } from './types/index.js';
-export { PublishPayload } from './types/index.js';
+import { PublishedArticle, PublishedSite, PublishedAuthor, PublishResult, PublishedTopic } from './types/index.js';
+export { PublishPayload, PublishedAuthorSocialLinks } from './types/index.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
-import { CSSProperties } from 'react';
+import { CSSProperties, ReactElement } from 'react';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
 import { ClassValue } from 'clsx';
@@ -100,55 +100,97 @@ declare function generateBlogHomeMetadata(siteName?: string, siteDescription?: s
 };
 
 interface ArticlePageProps {
-    article: PublishedArticle;
+  article: PublishedArticle;
+  className?: string;
+  navigation?: {
+    backToHome?: {
+      url: string;
+      label?: string;
+    };
+    previousArticle?: {
+      url: string;
+      title: string;
+      featuredImage?: string;
+      featuredImageAlt?: string;
+    };
+    nextArticle?: {
+      url: string;
+      title: string;
+      featuredImage?: string;
+      featuredImageAlt?: string;
+    };
+  };
+  basePath?: string;
+  theme?: BlogTheme;
+  postArticleCta?: {
+    title: string;
+    description?: string;
+    href: string;
+    label: string;
+  };
+  relatedArticles?: PublishedArticle[];
+  showShareLinks?: boolean;
+}
+
+declare function ArticlePage(props: ArticlePageProps): ReactElement;
+
+declare function generateArticleMetadata(
+  article: PublishedArticle,
+  basePath?: string,
+): {
+  title: string;
+  description: string;
+  keywords: string;
+  authors: { name: string }[] | undefined;
+  openGraph: {
+    title: string;
+    description: string;
+    type: string;
+    url: string;
+    images: { url: string; alt: string }[] | undefined;
+    publishedTime: string;
+    modifiedTime: string;
+    authors: string[] | undefined;
+    siteName: string;
+  };
+  twitter: {
+    card: string;
+    title: string;
+    description: string;
+    images: string[] | undefined;
+  };
+  alternates: {
+    canonical: string;
+  };
+};
+
+interface AuthorPageProps {
+    author: PublishedAuthor;
+    articles: PublishedArticle[];
+    site: PublishedSite;
     className?: string;
-    /** Optional navigation links */
+    basePath?: string;
+    theme?: BlogTheme;
+    pagination?: {
+        currentPage: number;
+        totalPages: number;
+        baseUrl?: string;
+        totalItems?: number;
+    };
     navigation?: {
         backToHome?: {
             url: string;
             label?: string;
         };
-        previousArticle?: {
-            url: string;
-            title: string;
-            featuredImage?: string;
-            featuredImageAlt?: string;
-        };
-        nextArticle?: {
-            url: string;
-            title: string;
-            featuredImage?: string;
-            featuredImageAlt?: string;
-        };
-    };
-    /** Public path where this blog is mounted, e.g. "/blog" or "/new-blog". */
-    basePath?: string;
-    /** Optional theme values for host-site brand integration. */
-    theme?: BlogTheme;
-    /** Optional post-article CTA supplied by the host site. */
-    postArticleCta?: {
-        title: string;
-        description?: string;
-        href: string;
-        label: string;
     };
-    /** Optional related articles supplied by the host site. */
-    relatedArticles?: PublishedArticle[];
-    /** Whether to render static article share links. */
-    showShareLinks?: boolean;
 }
-declare function ArticlePage({ article, className, navigation, basePath, theme, postArticleCta, relatedArticles, showShareLinks, }: ArticlePageProps): react_jsx_runtime.JSX.Element;
-/**
- * Generate metadata for the article page for SEO optimization.
- * This function should be used in the Next.js metadata API.
- */
-declare function generateArticleMetadata(article: PublishedArticle, basePath?: string): {
+declare function AuthorPage({ author, articles, site, className, basePath, theme, pagination, navigation, }: AuthorPageProps): react_jsx_runtime.JSX.Element;
+declare function generateAuthorPageMetadata(author: PublishedAuthor, site: PublishedSite, basePath?: string): {
     title: string;
     description: string;
-    keywords: string;
     authors: {
         name: string;
-    }[] | undefined;
+    }[];
     openGraph: {
         title: string;
         description: string;
@@ -158,9 +200,6 @@ declare function generateArticleMetadata(article: PublishedArticle, basePath?: s
             url: string;
             alt: string;
         }[] | undefined;
-        publishedTime: string;
-        modifiedTime: string;
-        authors: string[] | undefined;
         siteName: string;
     };
     twitter: {
@@ -262,8 +301,88 @@ declare function cn(...inputs: ClassValue[]): string;
  */
 declare function normalizeBlogBasePath(basePath?: string): string;
 declare function buildBlogPath(basePath: string | undefined, slug?: string): string;
+declare function buildAuthorPath(basePath: string | undefined, authorSlug: string): string;
 declare function getPathPrefixFromBlogUrl(blogUrl: string): string;
 
+/**
+ * Database interface for blog platform storage
+ *
+ * This provides a simple interface for storing published articles
+ * without coupling to any specific database implementation.
+ * Customers can implement this interface with their preferred database.
+ */
+
+interface BlogPlatformStorage {
+    /**
+     * Store a published article
+     */
+    saveArticle(article: PublishedArticle, idempotencyKey: string): Promise<PublishResult>;
+    /**
+     * Get an article by slug
+     */
+    getArticle(slug: string): Promise<PublishedArticle | null>;
+    /**
+     * List all published articles
+     */
+    listArticles(options?: {
+        limit?: number;
+        offset?: number;
+        sortBy?: "publishedAt" | "updatedAt";
+        order?: "asc" | "desc";
+    }): Promise<{
+        articles: PublishedArticle[];
+        total: number;
+    }>;
+    /**
+     * Remove an article by slug
+     */
+    removeArticle(slug: string, idempotencyKey: string): Promise<PublishResult>;
+    /**
+     * Check if an operation was already performed (idempotency)
+     */
+    checkIdempotency(idempotencyKey: string): Promise<PublishResult | null>;
+    /**
+     * Store the result of an operation for idempotency
+     */
+    storeOperationResult(idempotencyKey: string, result: PublishResult): Promise<void>;
+}
+/**
+ * Default in-memory storage implementation for development/testing
+ * IMPORTANT: This is not suitable for production use!
+ */
+declare class InMemoryStorage implements BlogPlatformStorage {
+    private articles;
+    private operations;
+    saveArticle(article: PublishedArticle, idempotencyKey: string): Promise<PublishResult>;
+    getArticle(slug: string): Promise<PublishedArticle | null>;
+    listArticles(options?: {
+        limit?: number;
+        offset?: number;
+        sortBy?: "publishedAt" | "updatedAt";
+        order?: "asc" | "desc";
+    }): Promise<{
+        articles: PublishedArticle[];
+        total: number;
+    }>;
+    removeArticle(slug: string, idempotencyKey: string): Promise<PublishResult>;
+    checkIdempotency(idempotencyKey: string): Promise<PublishResult | null>;
+    storeOperationResult(idempotencyKey: string, result: PublishResult): Promise<void>;
+}
+declare function getStorage(): BlogPlatformStorage;
+declare function setStorage(storage: BlogPlatformStorage): void;
+
+interface AuthorArchive {
+    author: PublishedAuthor;
+    articles: PublishedArticle[];
+}
+interface AuthorArchiveOptions {
+    limit?: number;
+    offset?: number;
+}
+declare function getAuthorsFromArticles(articles: readonly PublishedArticle[]): PublishedAuthor[];
+declare function getAuthorArchive(slug: string, articles: readonly PublishedArticle[]): AuthorArchive | null;
+declare function loadAuthorArchive(slug: string, options?: AuthorArchiveOptions, storage?: BlogPlatformStorage): Promise<AuthorArchive | null>;
+
 interface TopicArchive {
     topic: PublishedTopic;
     articles: PublishedArticle[];
@@ -290,6 +409,16 @@ interface BlogTopicArchivePageProps {
 declare function BlogTopicsIndexPage({ articles, basePath, title, description, className, theme, }: BlogTopicsIndexPageProps): react_jsx_runtime.JSX.Element;
 declare function BlogTopicArchivePage({ articles, topicSlug, basePath, className, theme, }: BlogTopicArchivePageProps): react_jsx_runtime.JSX.Element;
 
+interface BlogAuthorsIndexPageProps {
+    articles: PublishedArticle[];
+    basePath?: string;
+    title?: string;
+    description?: string;
+    className?: string;
+    theme?: BlogTheme;
+}
+declare function BlogAuthorsIndexPage({ articles, basePath, title, description, className, theme, }: BlogAuthorsIndexPageProps): react_jsx_runtime.JSX.Element;
+
 /**
  * Authentication configuration interface
  * Customers can implement this to customize authentication behavior
@@ -389,73 +518,6 @@ declare function initEnvAuth(envVarName?: string): void;
  */
 declare function shouldSkipAuth(): boolean;
 
-/**
- * Database interface for blog platform storage
- *
- * This provides a simple interface for storing published articles
- * without coupling to any specific database implementation.
- * Customers can implement this interface with their preferred database.
- */
-
-interface BlogPlatformStorage {
-    /**
-     * Store a published article
-     */
-    saveArticle(article: PublishedArticle, idempotencyKey: string): Promise<PublishResult>;
-    /**
-     * Get an article by slug
-     */
-    getArticle(slug: string): Promise<PublishedArticle | null>;
-    /**
-     * List all published articles
-     */
-    listArticles(options?: {
-        limit?: number;
-        offset?: number;
-        sortBy?: "publishedAt" | "updatedAt";
-        order?: "asc" | "desc";
-    }): Promise<{
-        articles: PublishedArticle[];
-        total: number;
-    }>;
-    /**
-     * Remove an article by slug
-     */
-    removeArticle(slug: string, idempotencyKey: string): Promise<PublishResult>;
-    /**
-     * Check if an operation was already performed (idempotency)
-     */
-    checkIdempotency(idempotencyKey: string): Promise<PublishResult | null>;
-    /**
-     * Store the result of an operation for idempotency
-     */
-    storeOperationResult(idempotencyKey: string, result: PublishResult): Promise<void>;
-}
-/**
- * Default in-memory storage implementation for development/testing
- * IMPORTANT: This is not suitable for production use!
- */
-declare class InMemoryStorage implements BlogPlatformStorage {
-    private articles;
-    private operations;
-    saveArticle(article: PublishedArticle, idempotencyKey: string): Promise<PublishResult>;
-    getArticle(slug: string): Promise<PublishedArticle | null>;
-    listArticles(options?: {
-        limit?: number;
-        offset?: number;
-        sortBy?: "publishedAt" | "updatedAt";
-        order?: "asc" | "desc";
-    }): Promise<{
-        articles: PublishedArticle[];
-        total: number;
-    }>;
-    removeArticle(slug: string, idempotencyKey: string): Promise<PublishResult>;
-    checkIdempotency(idempotencyKey: string): Promise<PublishResult | null>;
-    storeOperationResult(idempotencyKey: string, result: PublishResult): Promise<void>;
-}
-declare function getStorage(): BlogPlatformStorage;
-declare function setStorage(storage: BlogPlatformStorage): void;
-
 /**
  * Rate limiting for blog platform API endpoints
  *
@@ -1369,7 +1431,7 @@ interface SitemapOptions {
 /**
  * Valid sitemap change frequency values as per XML sitemap standard.
  */
-type SitemapChangeFreq = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
+type SitemapChangeFreq = "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never";
 /**
  * Next.js MetadataRoute.Sitemap compatible entry.
  * This matches the expected format for Next.js sitemap generation.
@@ -1885,4 +1947,4 @@ declare function OPTIONS(request: NextRequest): Promise<NextResponse>;
 
 declare const PACKAGE_VERSION: string;
 
-export { ApiKeyAuth, type AuthConfig, type AuthResult, ArticlePage as BlogArticlePage, BlogHomePage, type BlogPlatformConfig, type BlogPlatformStorage, type BlogPostingSchema, type BlogSitemapConfig, type BlogTheme, BlogTopicArchivePage, BlogTopicsIndexPage, type BreadcrumbListSchema, Button, type CanonicalUrlOptions, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, DrizzleStorage, EnvAuth, type GeneratedMetadata, InMemoryStorage, type LinkTag, type MetaTag, type MetadataOptions, type NextjsSitemapEntry, NoAuth, type OrganizationSchema, PACKAGE_VERSION, Pagination$1 as Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious, type PersonSchema, PublishResult, PublishedArticle, PublishedAuthor, PublishedSite, PublishedTopic, type RateLimitConfig, type RateLimitResult, Pagination as ShadcnPagination, type SitemapChangeFreq, type SitemapData, type SitemapEntry, type SitemapOptions, StructuredDataError, type StructuredDataOptions, type TopicArchive, UninitializedAuth, type WebSiteSchema, autoConfigureRateLimit, bpArticles, bpOperations, buildBlogPath, buttonVariants, checkRateLimit, cn, configureRateLimit, createBlogSitemapRoute, createDynamicBlogSitemap, createRateLimitErrorResponse, createStructuredDataScript, enforceRateLimit, extractKeywordsFromArticle, extractTableOfContents, extractTokenFromHeader, formatArticleDateMeta, generateArticleMetadata, generateArticleStructuredData, generateAuthorStructuredData, generateBlogHomeMetadata, generateBlogHomeStructuredData, generateBlogSitemapEntries, generateBreadcrumbStructuredData, generateCanonicalUrl, generateCanonicalUrlFromSlug, generateCompleteArticleStructuredData, generateOrganizationStructuredData, generatePaginationMetadata, generateSiteMetadata, generateSitemap, generateSitemapIndex, generateWebSiteStructuredData, getAllTopics, getArticlePrimaryTopic, getAuthConfig, getBaseUrl, getBlogThemeStyle, getDrizzleAdapterSql, getPathPrefixFromBlogUrl, getRateLimitHeaders, getStorage, getTopicArchive, initBlogPlatform, initBlogPlatformDev, initBlogPlatformOnce, initBlogPlatformProd, initEnvAuth, isValidCanonicalUrl, metadataToHtml, normalizeBlogBasePath, normalizeDomain, normalizeSlug, POST$1 as publishHandler, safeGenerateArticleStructuredData, setAuthConfig, setStorage, shouldSkipAuth, sitemapToXml, GET as slugExistsHandler, OPTIONS as slugExistsOptionsHandler, structuredDataToJsonLd, POST as unpublishHandler, updateArticleCanonicalUrl, usePagination, validateMetadata, validateSitemap, validateStructuredData, GET$1 as versionHandler };
+export { ApiKeyAuth, type AuthConfig, type AuthResult, type AuthorArchive, type AuthorArchiveOptions, ArticlePage as BlogArticlePage, AuthorPage as BlogAuthorPage, BlogAuthorsIndexPage, BlogHomePage, type BlogPlatformConfig, type BlogPlatformStorage, type BlogPostingSchema, type BlogSitemapConfig, type BlogTheme, BlogTopicArchivePage, BlogTopicsIndexPage, type BreadcrumbListSchema, Button, type CanonicalUrlOptions, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, DrizzleStorage, EnvAuth, type GeneratedMetadata, InMemoryStorage, type LinkTag, type MetaTag, type MetadataOptions, type NextjsSitemapEntry, NoAuth, type OrganizationSchema, PACKAGE_VERSION, Pagination$1 as Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious, type PersonSchema, PublishResult, PublishedArticle, PublishedAuthor, PublishedSite, PublishedTopic, type RateLimitConfig, type RateLimitResult, Pagination as ShadcnPagination, type SitemapChangeFreq, type SitemapData, type SitemapEntry, type SitemapOptions, StructuredDataError, type StructuredDataOptions, type TopicArchive, UninitializedAuth, type WebSiteSchema, autoConfigureRateLimit, bpArticles, bpOperations, buildAuthorPath, buildBlogPath, buttonVariants, checkRateLimit, cn, configureRateLimit, createBlogSitemapRoute, createDynamicBlogSitemap, createRateLimitErrorResponse, createStructuredDataScript, enforceRateLimit, extractKeywordsFromArticle, extractTableOfContents, extractTokenFromHeader, formatArticleDateMeta, generateArticleMetadata, generateArticleStructuredData, generateAuthorPageMetadata, generateAuthorStructuredData, generateBlogHomeMetadata, generateBlogHomeStructuredData, generateBlogSitemapEntries, generateBreadcrumbStructuredData, generateCanonicalUrl, generateCanonicalUrlFromSlug, generateCompleteArticleStructuredData, generateOrganizationStructuredData, generatePaginationMetadata, generateSiteMetadata, generateSitemap, generateSitemapIndex, generateWebSiteStructuredData, getAllTopics, getArticlePrimaryTopic, getAuthConfig, getAuthorArchive, getAuthorsFromArticles, getBaseUrl, getBlogThemeStyle, getDrizzleAdapterSql, getPathPrefixFromBlogUrl, getRateLimitHeaders, getStorage, getTopicArchive, initBlogPlatform, initBlogPlatformDev, initBlogPlatformOnce, initBlogPlatformProd, initEnvAuth, isValidCanonicalUrl, loadAuthorArchive, metadataToHtml, normalizeBlogBasePath, normalizeDomain, normalizeSlug, POST$1 as publishHandler, safeGenerateArticleStructuredData, setAuthConfig, setStorage, shouldSkipAuth, sitemapToXml, GET as slugExistsHandler, OPTIONS as slugExistsOptionsHandler, structuredDataToJsonLd, POST as unpublishHandler, updateArticleCanonicalUrl, usePagination, validateMetadata, validateSitemap, validateStructuredData, GET$1 as versionHandler };