@xexr/blog-platform 1.0.1 → 1.0.3

package/dist/index.d.mts

@@ -1,14 +1,42 @@
 import { PublishedArticle, PublishedSite, PublishResult, PublishedAuthor } from './types/index.mjs';
 export { PublishPayload } from './types/index.mjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as class_variance_authority_types from 'class-variance-authority/types';
 import * as React from 'react';
+import { CSSProperties } from 'react';
+import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
 import { ClassValue } from 'clsx';
 import { NextRequest, NextResponse } from 'next/server';
 import * as drizzle_orm_sqlite_core from 'drizzle-orm/sqlite-core';
 import { LibSQLDatabase } from 'drizzle-orm/libsql';
 
+interface BlogTheme {
+    accentColor?: string;
+    accentHoverColor?: string;
+    accentBackgroundColor?: string;
+    accentBorderColor?: string;
+}
+interface TocItem {
+    id: string;
+    text: string;
+    level: 2 | 3;
+}
+interface ArticleDateMeta {
+    publishedDateLabel: string;
+    publishedRelativeLabel: string;
+    updatedDateLabel: string;
+    isUpdated: boolean;
+}
+type BlogThemeStyle = CSSProperties & {
+    "--blog-accent": string;
+    "--blog-accent-hover": string;
+    "--blog-accent-bg": string;
+    "--blog-accent-border": string;
+};
+declare function getBlogThemeStyle(theme?: BlogTheme): BlogThemeStyle;
+declare function formatArticleDateMeta(publishedAt: string, updatedAt: string): ArticleDateMeta;
+declare function extractTableOfContents(markdown: string): TocItem[];
+
 interface BlogHomePageProps {
     articles: PublishedArticle[];
     siteName?: string;
@@ -18,12 +46,16 @@ interface BlogHomePageProps {
     site?: PublishedSite;
     /** Whether to include structured data */
     includeStructuredData?: boolean;
+    /** Public path where this blog is mounted, e.g. "/blog" or "/new-blog". */
+    basePath?: string;
     /** Pagination configuration */
     pagination?: {
         currentPage: number;
         totalPages: number;
         baseUrl?: string;
     };
+    /** Optional theme values for host-site brand integration. */
+    theme?: BlogTheme;
 }
 /**
  * Blog home page component that displays a list of published articles.
@@ -32,7 +64,7 @@ interface BlogHomePageProps {
  * @xexr/blog-platform package. It provides a clean, SEO-friendly
  * article listing with proper metadata.
  */
-declare function BlogHomePage({ articles, siteName, siteTagline, className, site, includeStructuredData, pagination, }: BlogHomePageProps): react_jsx_runtime.JSX.Element;
+declare function BlogHomePage({ articles, siteName, siteTagline, className, site, includeStructuredData, basePath, pagination, theme, }: BlogHomePageProps): react_jsx_runtime.JSX.Element;
 /**
  * Generate metadata for the blog home page for SEO optimization.
  * This function should be used in the Next.js metadata API.
@@ -40,7 +72,7 @@ declare function BlogHomePage({ articles, siteName, siteTagline, className, site
 declare function generateBlogHomeMetadata(siteName?: string, siteDescription?: string, siteUrl?: string, pagination?: {
     currentPage: number;
     totalPages: number;
-}): {
+}, basePath?: string): {
     title: string;
     description: string;
     openGraph: {
@@ -81,13 +113,28 @@ interface ArticlePageProps {
             title: 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, }: ArticlePageProps): react_jsx_runtime.JSX.Element;
+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): {
+declare function generateArticleMetadata(article: PublishedArticle, basePath?: string): {
     title: string;
     description: string;
     keywords: string;
@@ -202,6 +249,13 @@ declare function PaginationEllipsis({ className, ...props }: React.ComponentProp
 
 declare function cn(...inputs: ClassValue[]): string;
 
+/**
+ * URL helpers shared by package UI, metadata, and sitemap integrations.
+ */
+declare function normalizeBlogBasePath(basePath?: string): string;
+declare function buildBlogPath(basePath: string | undefined, slug?: string): string;
+declare function getPathPrefixFromBlogUrl(blogUrl: string): string;
+
 /**
  * Authentication configuration interface
  * Customers can implement this to customize authentication behavior
@@ -1796,4 +1850,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 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, type RateLimitConfig, type RateLimitResult, Pagination as ShadcnPagination, type SitemapChangeFreq, type SitemapData, type SitemapEntry, type SitemapOptions, StructuredDataError, type StructuredDataOptions, UninitializedAuth, type WebSiteSchema, autoConfigureRateLimit, bpArticles, bpOperations, buttonVariants, checkRateLimit, cn, configureRateLimit, createBlogSitemapRoute, createDynamicBlogSitemap, createRateLimitErrorResponse, createStructuredDataScript, enforceRateLimit, extractKeywordsFromArticle, extractTokenFromHeader, generateArticleMetadata, generateArticleStructuredData, generateAuthorStructuredData, generateBlogHomeMetadata, generateBlogHomeStructuredData, generateBlogSitemapEntries, generateBreadcrumbStructuredData, generateCanonicalUrl, generateCanonicalUrlFromSlug, generateCompleteArticleStructuredData, generateOrganizationStructuredData, generatePaginationMetadata, generateSiteMetadata, generateSitemap, generateSitemapIndex, generateWebSiteStructuredData, getAuthConfig, getBaseUrl, getDrizzleAdapterSql, getRateLimitHeaders, getStorage, initBlogPlatform, initBlogPlatformDev, initBlogPlatformOnce, initBlogPlatformProd, initEnvAuth, isValidCanonicalUrl, metadataToHtml, 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, ArticlePage as BlogArticlePage, BlogHomePage, type BlogPlatformConfig, type BlogPlatformStorage, type BlogPostingSchema, type BlogSitemapConfig, type BlogTheme, 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, type RateLimitConfig, type RateLimitResult, Pagination as ShadcnPagination, type SitemapChangeFreq, type SitemapData, type SitemapEntry, type SitemapOptions, StructuredDataError, type StructuredDataOptions, 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, getAuthConfig, getBaseUrl, getBlogThemeStyle, getDrizzleAdapterSql, getPathPrefixFromBlogUrl, getRateLimitHeaders, getStorage, 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 };

package/dist/index.d.ts

@@ -1,14 +1,42 @@
 import { PublishedArticle, PublishedSite, PublishResult, PublishedAuthor } from './types/index.js';
 export { PublishPayload } from './types/index.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as class_variance_authority_types from 'class-variance-authority/types';
 import * as React from 'react';
+import { CSSProperties } from 'react';
+import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
 import { ClassValue } from 'clsx';
 import { NextRequest, NextResponse } from 'next/server';
 import * as drizzle_orm_sqlite_core from 'drizzle-orm/sqlite-core';
 import { LibSQLDatabase } from 'drizzle-orm/libsql';
 
+interface BlogTheme {
+    accentColor?: string;
+    accentHoverColor?: string;
+    accentBackgroundColor?: string;
+    accentBorderColor?: string;
+}
+interface TocItem {
+    id: string;
+    text: string;
+    level: 2 | 3;
+}
+interface ArticleDateMeta {
+    publishedDateLabel: string;
+    publishedRelativeLabel: string;
+    updatedDateLabel: string;
+    isUpdated: boolean;
+}
+type BlogThemeStyle = CSSProperties & {
+    "--blog-accent": string;
+    "--blog-accent-hover": string;
+    "--blog-accent-bg": string;
+    "--blog-accent-border": string;
+};
+declare function getBlogThemeStyle(theme?: BlogTheme): BlogThemeStyle;
+declare function formatArticleDateMeta(publishedAt: string, updatedAt: string): ArticleDateMeta;
+declare function extractTableOfContents(markdown: string): TocItem[];
+
 interface BlogHomePageProps {
     articles: PublishedArticle[];
     siteName?: string;
@@ -18,12 +46,16 @@ interface BlogHomePageProps {
     site?: PublishedSite;
     /** Whether to include structured data */
     includeStructuredData?: boolean;
+    /** Public path where this blog is mounted, e.g. "/blog" or "/new-blog". */
+    basePath?: string;
     /** Pagination configuration */
     pagination?: {
         currentPage: number;
         totalPages: number;
         baseUrl?: string;
     };
+    /** Optional theme values for host-site brand integration. */
+    theme?: BlogTheme;
 }
 /**
  * Blog home page component that displays a list of published articles.
@@ -32,7 +64,7 @@ interface BlogHomePageProps {
  * @xexr/blog-platform package. It provides a clean, SEO-friendly
  * article listing with proper metadata.
  */
-declare function BlogHomePage({ articles, siteName, siteTagline, className, site, includeStructuredData, pagination, }: BlogHomePageProps): react_jsx_runtime.JSX.Element;
+declare function BlogHomePage({ articles, siteName, siteTagline, className, site, includeStructuredData, basePath, pagination, theme, }: BlogHomePageProps): react_jsx_runtime.JSX.Element;
 /**
  * Generate metadata for the blog home page for SEO optimization.
  * This function should be used in the Next.js metadata API.
@@ -40,7 +72,7 @@ declare function BlogHomePage({ articles, siteName, siteTagline, className, site
 declare function generateBlogHomeMetadata(siteName?: string, siteDescription?: string, siteUrl?: string, pagination?: {
     currentPage: number;
     totalPages: number;
-}): {
+}, basePath?: string): {
     title: string;
     description: string;
     openGraph: {
@@ -81,13 +113,28 @@ interface ArticlePageProps {
             title: 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, }: ArticlePageProps): react_jsx_runtime.JSX.Element;
+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): {
+declare function generateArticleMetadata(article: PublishedArticle, basePath?: string): {
     title: string;
     description: string;
     keywords: string;
@@ -202,6 +249,13 @@ declare function PaginationEllipsis({ className, ...props }: React.ComponentProp
 
 declare function cn(...inputs: ClassValue[]): string;
 
+/**
+ * URL helpers shared by package UI, metadata, and sitemap integrations.
+ */
+declare function normalizeBlogBasePath(basePath?: string): string;
+declare function buildBlogPath(basePath: string | undefined, slug?: string): string;
+declare function getPathPrefixFromBlogUrl(blogUrl: string): string;
+
 /**
  * Authentication configuration interface
  * Customers can implement this to customize authentication behavior
@@ -1796,4 +1850,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 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, type RateLimitConfig, type RateLimitResult, Pagination as ShadcnPagination, type SitemapChangeFreq, type SitemapData, type SitemapEntry, type SitemapOptions, StructuredDataError, type StructuredDataOptions, UninitializedAuth, type WebSiteSchema, autoConfigureRateLimit, bpArticles, bpOperations, buttonVariants, checkRateLimit, cn, configureRateLimit, createBlogSitemapRoute, createDynamicBlogSitemap, createRateLimitErrorResponse, createStructuredDataScript, enforceRateLimit, extractKeywordsFromArticle, extractTokenFromHeader, generateArticleMetadata, generateArticleStructuredData, generateAuthorStructuredData, generateBlogHomeMetadata, generateBlogHomeStructuredData, generateBlogSitemapEntries, generateBreadcrumbStructuredData, generateCanonicalUrl, generateCanonicalUrlFromSlug, generateCompleteArticleStructuredData, generateOrganizationStructuredData, generatePaginationMetadata, generateSiteMetadata, generateSitemap, generateSitemapIndex, generateWebSiteStructuredData, getAuthConfig, getBaseUrl, getDrizzleAdapterSql, getRateLimitHeaders, getStorage, initBlogPlatform, initBlogPlatformDev, initBlogPlatformOnce, initBlogPlatformProd, initEnvAuth, isValidCanonicalUrl, metadataToHtml, 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, ArticlePage as BlogArticlePage, BlogHomePage, type BlogPlatformConfig, type BlogPlatformStorage, type BlogPostingSchema, type BlogSitemapConfig, type BlogTheme, 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, type RateLimitConfig, type RateLimitResult, Pagination as ShadcnPagination, type SitemapChangeFreq, type SitemapData, type SitemapEntry, type SitemapOptions, StructuredDataError, type StructuredDataOptions, 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, getAuthConfig, getBaseUrl, getBlogThemeStyle, getDrizzleAdapterSql, getPathPrefixFromBlogUrl, getRateLimitHeaders, getStorage, 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 };