@xexr/blog-platform 1.0.12 → 1.0.13

package/dist/index.d.mts

@@ -9,6 +9,8 @@ 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';
+import { C as CanonicalUrlOptions } from './sitemap-Dz9DB7py.mjs';
+export { B as BlogSitemapConfig, N as NextjsSitemapEntry, S as SitemapChangeFreq, a as SitemapData, b as SitemapEntry, c as SitemapOptions, d as createBlogSitemapRoute, e as createDynamicBlogSitemap, g as generateBlogSitemapEntries, f as generateCanonicalUrl, h as generateCanonicalUrlFromSlug, i as generateSitemap, j as generateSitemapIndex, k as getBaseUrl, l as isValidCanonicalUrl, n as normalizeDomain, m as normalizeSlug, s as sitemapToXml, u as updateArticleCanonicalUrl, v as validateSitemap } from './sitemap-Dz9DB7py.mjs';
 
 interface BlogTheme {
     accentColor?: string;
@@ -1151,140 +1153,6 @@ declare function getDrizzleAdapterSql(): {
     createOperations: string;
 };
 
-/**
- * SEO utilities for canonical URL generation and validation.
- *
- * These utilities ensure proper canonical URL structure for SEO optimization,
- * preventing duplicate content issues and improving search engine indexing.
- */
-
-/**
- * Configuration options for canonical URL generation.
- */
-interface CanonicalUrlOptions {
-    /** Whether to force HTTPS protocol (default: true) */
-    forceHttps?: boolean;
-    /** Whether to remove trailing slashes (default: true) */
-    removeTrailingSlash?: boolean;
-    /** Custom domain override (uses site.domain if not provided) */
-    domain?: string;
-    /** Custom path prefix (default: '/blog') */
-    pathPrefix?: string;
-}
-/**
- * Normalizes a domain by ensuring proper protocol and removing trailing slashes.
- *
- * @param domain - The domain to normalize
- * @param forceHttps - Whether to force HTTPS protocol
- * @returns The normalized domain
- *
- * @example
- * ```typescript
- * normalizeDomain('example.com') // 'https://example.com'
- * normalizeDomain('http://example.com/') // 'https://example.com'
- * normalizeDomain('https://example.com', false) // 'https://example.com'
- * ```
- */
-declare function normalizeDomain(domain: string, forceHttps?: boolean): string;
-/**
- * Validates and normalizes a slug for URL usage.
- *
- * @param slug - The slug to validate and normalize
- * @returns The normalized slug
- * @throws Error if slug is invalid
- *
- * @example
- * ```typescript
- * normalizeSlug('hello-world') // 'hello-world'
- * normalizeSlug('Hello World!') // throws Error
- * normalizeSlug('hello--world') // 'hello-world'
- * ```
- */
-declare function normalizeSlug(slug: string): string;
-/**
- * Generates a canonical URL for an article.
- *
- * @param article - The published article
- * @param options - Configuration options for URL generation
- * @returns The canonical URL
- * @throws Error if article or site data is invalid
- *
- * @example
- * ```typescript
- * const article = {
- *   slug: 'hello-world',
- *   site: { domain: 'example.com' },
- *   // ... other fields
- * };
- *
- * generateCanonicalUrl(article)
- * // 'https://example.com/blog/hello-world'
- *
- * generateCanonicalUrl(article, { pathPrefix: '/posts' })
- * // 'https://example.com/posts/hello-world'
- * ```
- */
-declare function generateCanonicalUrl(article: PublishedArticle, options?: CanonicalUrlOptions): string;
-/**
- * Generates a canonical URL for an article from site and slug data.
- * Useful when you don't have a full PublishedArticle object.
- *
- * @param site - The published site
- * @param slug - The article slug
- * @param options - Configuration options for URL generation
- * @returns The canonical URL
- *
- * @example
- * ```typescript
- * const site = { domain: 'example.com', ... };
- * generateCanonicalUrlFromSlug(site, 'hello-world')
- * // 'https://example.com/blog/hello-world'
- * ```
- */
-declare function generateCanonicalUrlFromSlug(site: PublishedSite, slug: string, options?: CanonicalUrlOptions): string;
-/**
- * Validates if a URL is a valid canonical URL format.
- *
- * @param url - The URL to validate
- * @returns True if the URL is valid for canonical use
- *
- * @example
- * ```typescript
- * isValidCanonicalUrl('https://example.com/blog/hello-world') // true
- * isValidCanonicalUrl('http://example.com/blog/hello-world') // true
- * isValidCanonicalUrl('example.com/blog/hello-world') // false (missing protocol)
- * isValidCanonicalUrl('https://example.com/blog/hello world') // false (spaces)
- * ```
- */
-declare function isValidCanonicalUrl(url: string): boolean;
-/**
- * Extracts the base URL (protocol + hostname + port) from a canonical URL.
- *
- * @param canonicalUrl - The canonical URL
- * @returns The base URL
- *
- * @example
- * ```typescript
- * getBaseUrl('https://example.com/blog/hello-world') // 'https://example.com'
- * getBaseUrl('https://blog.example.com:8080/posts/test') // 'https://blog.example.com:8080'
- * ```
- */
-declare function getBaseUrl(canonicalUrl: string): string;
-/**
- * Updates an article's canonical URL in its meta field.
- *
- * @param article - The article to update
- * @param options - Configuration options for URL generation
- * @returns A new article object with updated canonical URL
- *
- * @example
- * ```typescript
- * const updatedArticle = updateArticleCanonicalUrl(article);
- * console.log(updatedArticle.meta.canonicalUrl); // Generated canonical URL
- * ```
- */
-declare function updateArticleCanonicalUrl(article: PublishedArticle, options?: CanonicalUrlOptions): PublishedArticle;
-
 /**
  * Metadata generation utilities for SEO meta tags, OpenGraph, and Twitter Cards.
  *
@@ -1430,281 +1298,6 @@ declare function validateMetadata(metadata: GeneratedMetadata): {
     warnings: string[];
 };
 
-/**
- * Next.js-compatible sitemap generation utilities for blog platform integration.
- *
- * These utilities generate sitemap entries that follow Next.js MetadataRoute.Sitemap
- * conventions, allowing seamless integration with existing Next.js applications.
- *
- * @example Integration with existing Next.js sitemap:
- * ```typescript
- * // app/sitemap.ts
- * import { generateBlogSitemapEntries } from '@xexr/blog-platform';
- * import type { MetadataRoute } from 'next';
- *
- * export default async function sitemap(): Promise<MetadataRoute.Sitemap> {
- *   // Your existing routes
- *   const staticRoutes = [
- *     { url: 'https://yoursite.com', lastModified: new Date(), priority: 1 },
- *     { url: 'https://yoursite.com/about', lastModified: new Date(), priority: 0.8 }
- *   ];
- *
- *   // Blog platform entries
- *   const blogEntries = await generateBlogSitemapEntries(blogConfig);
- *
- *   return [...staticRoutes, ...blogEntries];
- * }
- * ```
- */
-
-/**
- * Configuration options for sitemap generation.
- */
-interface SitemapOptions {
-    /** Canonical URL configuration */
-    canonical?: CanonicalUrlOptions;
-    /** Whether to include author pages in sitemap */
-    includeAuthorPages?: boolean;
-    /** Whether to include pagination pages in sitemap */
-    includePaginationPages?: boolean;
-    /** Number of articles per page for pagination calculation */
-    articlesPerPage?: number;
-    /** Maximum number of sitemap entries (defaults to 50,000 per Google guidelines) */
-    maxEntries?: number;
-    /** Change frequency for different page types */
-    changeFrequency?: {
-        /** Change frequency for blog home page */
-        homePage?: SitemapChangeFreq;
-        /** Change frequency for article pages */
-        articles?: SitemapChangeFreq;
-        /** Change frequency for author pages */
-        authorPages?: SitemapChangeFreq;
-        /** Change frequency for pagination pages */
-        paginationPages?: SitemapChangeFreq;
-    };
-    /** Priority values for different page types */
-    priority?: {
-        /** Priority for blog home page (0.0-1.0) */
-        homePage?: number;
-        /** Priority for article pages (0.0-1.0) */
-        articles?: number;
-        /** Priority for author pages (0.0-1.0) */
-        authorPages?: number;
-        /** Priority for pagination pages (0.0-1.0) */
-        paginationPages?: number;
-    };
-}
-/**
- * Valid sitemap change frequency values as per XML sitemap standard.
- */
-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.
- */
-interface NextjsSitemapEntry {
-    /** The URL of the page */
-    url: string;
-    /** Last modification date */
-    lastModified?: string | Date;
-    /** Change frequency hint for search engines */
-    changeFrequency?: SitemapChangeFreq;
-    /** Priority relative to other URLs on the site (0.0-1.0) */
-    priority?: number;
-    /** Alternate language versions (for i18n) */
-    alternates?: {
-        languages?: Record<string, string>;
-    };
-}
-/**
- * Legacy XML sitemap entry format (for backward compatibility).
- * @deprecated Use NextjsSitemapEntry for new implementations
- */
-interface SitemapEntry {
-    /** The URL of the page */
-    loc: string;
-    /** Last modification date as ISO 8601 string */
-    lastmod?: string;
-    /** Change frequency hint for search engines */
-    changefreq?: SitemapChangeFreq;
-    /** Priority relative to other URLs on the site (0.0-1.0) */
-    priority?: number;
-}
-/**
- * Complete sitemap data structure.
- */
-interface SitemapData {
-    /** All URL entries in the sitemap */
-    entries: SitemapEntry[];
-    /** Total number of entries */
-    totalEntries: number;
-    /** Whether the sitemap was truncated due to size limits */
-    truncated: boolean;
-    /** Generation timestamp */
-    generatedAt: string;
-    /** Base URL used for canonical URL generation */
-    baseUrl: string;
-}
-/**
- * Generates Next.js-compatible sitemap entries for blog platform integration.
- *
- * @param site - The published site information
- * @param articles - Array of published articles
- * @param authors - Array of published authors (optional)
- * @param options - Sitemap generation options
- * @returns Array of Next.js MetadataRoute.Sitemap compatible entries
- *
- * @example
- * ```typescript
- * // In your Next.js app/sitemap.ts file:
- * import { generateBlogSitemapEntries } from '@xexr/blog-platform';
- * import type { MetadataRoute } from 'next';
- *
- * export default async function sitemap(): Promise<MetadataRoute.Sitemap> {
- *   const blogEntries = await generateBlogSitemapEntries(site, articles, authors, {
- *     includeAuthorPages: true,
- *     includePaginationPages: true,
- *     changeFrequency: { articles: 'monthly' }
- *   });
- *
- *   return [
- *     // Your existing site routes
- *     { url: 'https://yoursite.com', lastModified: new Date(), priority: 1 },
- *     { url: 'https://yoursite.com/about', lastModified: new Date() },
- *     // Blog entries
- *     ...blogEntries
- *   ];
- * }
- * ```
- */
-declare function generateBlogSitemapEntries(site: PublishedSite, articles: readonly PublishedArticle[], authors?: readonly PublishedAuthor[], options?: SitemapOptions): Promise<NextjsSitemapEntry[]>;
-/**
- * Legacy sitemap generation for backward compatibility.
- * @deprecated Use generateBlogSitemapEntries for Next.js integration
- *
- * @param site - The published site information
- * @param articles - Array of published articles
- * @param authors - Array of published authors (optional)
- * @param options - Sitemap generation options
- * @returns Complete sitemap data
- */
-declare function generateSitemap(site: PublishedSite, articles: readonly PublishedArticle[], authors?: readonly PublishedAuthor[], options?: SitemapOptions): SitemapData;
-/**
- * Converts sitemap data to XML format.
- *
- * @param sitemapData - The sitemap data to convert
- * @returns XML string in sitemap format
- *
- * @example
- * ```typescript
- * const sitemap = generateSitemap(site, articles);
- * const xmlString = sitemapToXml(sitemap);
- * // Use in API route response
- * ```
- */
-declare function sitemapToXml(sitemapData: SitemapData): string;
-/**
- * Generates a sitemap index for large blogs that need multiple sitemaps.
- *
- * @param sitemaps - Array of sitemap information
- * @param baseUrl - Base URL for the site
- * @returns XML string for sitemap index
- *
- * @example
- * ```typescript
- * const sitemapIndex = generateSitemapIndex([
- *   { url: 'https://example.com/sitemap-articles.xml', lastmod: '2023-01-01T00:00:00Z' },
- *   { url: 'https://example.com/sitemap-authors.xml', lastmod: '2023-01-01T00:00:00Z' }
- * ], 'https://example.com');
- * ```
- */
-declare function generateSitemapIndex(sitemaps: readonly {
-    url: string;
-    lastmod?: string;
-}[], _baseUrl: string): string;
-/**
- * Validates sitemap data for compliance with search engine guidelines.
- *
- * @param sitemapData - The sitemap data to validate
- * @returns Validation results with errors and warnings
- *
- * @example
- * ```typescript
- * const sitemap = generateSitemap(site, articles);
- * const validation = validateSitemap(sitemap);
- *
- * if (validation.errors.length > 0) {
- *   console.error('Sitemap errors:', validation.errors);
- * }
- * ```
- */
-declare function validateSitemap(sitemapData: SitemapData): {
-    valid: boolean;
-    errors: string[];
-    warnings: string[];
-};
-/**
- * Creates a separate sitemap specifically for blog content.
- * Useful for large sites that need to split sitemaps by content type.
- *
- * @param site - The published site information
- * @param articles - Array of published articles
- * @param authors - Array of published authors (optional)
- * @param options - Sitemap generation options
- * @returns Next.js sitemap function
- *
- * @example
- * ```typescript
- * // app/blog-sitemap/route.ts - separate blog sitemap endpoint
- * import { createBlogSitemapRoute } from '@xexr/blog-platform';
- *
- * export const GET = createBlogSitemapRoute(site, articles, authors, {
- *   includeAuthorPages: true,
- *   articlesPerPage: 20
- * });
- * ```
- */
-declare function createBlogSitemapRoute(site: PublishedSite, articles: readonly PublishedArticle[], authors?: readonly PublishedAuthor[], options?: SitemapOptions): () => Promise<Response>;
-/**
- * Configuration interface for blog data fetching.
- * Used to fetch blog data for sitemap generation.
- */
-interface BlogSitemapConfig {
-    /** Function to fetch site data */
-    getSite: () => Promise<PublishedSite>;
-    /** Function to fetch published articles */
-    getArticles: () => Promise<readonly PublishedArticle[]>;
-    /** Function to fetch authors (optional) */
-    getAuthors?: () => Promise<readonly PublishedAuthor[]>;
-    /** Sitemap generation options */
-    options?: SitemapOptions;
-}
-/**
- * Higher-order function that creates a Next.js sitemap function with data fetching.
- * Ideal for dynamic blog content that needs to be fetched at sitemap generation time.
- *
- * @param config - Configuration for fetching blog data
- * @returns Next.js sitemap function
- *
- * @example
- * ```typescript
- * // app/sitemap.ts
- * import { createDynamicBlogSitemap } from '@xexr/blog-platform';
- * import { getBlogData } from './lib/blog';
- *
- * export default createDynamicBlogSitemap({
- *   getSite: () => getBlogData().site,
- *   getArticles: () => getBlogData().articles,
- *   getAuthors: () => getBlogData().authors,
- *   options: {
- *     includeAuthorPages: true,
- *     changeFrequency: { articles: 'weekly' }
- *   }
- * });
- * ```
- */
-declare function createDynamicBlogSitemap(config: BlogSitemapConfig): () => Promise<NextjsSitemapEntry[]>;
-
 /**
  * Structured Data (JSON-LD) utilities for SEO optimization
  *
@@ -2013,4 +1606,4 @@ declare function OPTIONS(request: NextRequest): Promise<NextResponse>;
 
 declare const PACKAGE_VERSION: string;
 
-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, NEWSLETTER_SUCCESS_MESSAGE, NewsletterSignup, type NewsletterSignupProps, type NextjsSitemapEntry, NoAuth, type OrganizationSchema, PACKAGE_VERSION, Pagination$1 as Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious, type PersonSchema, PublishResult, PublishedArticle, PublishedAuthor, PublishedNewsletterSettings, 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, createTokenFingerprint, 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 };
+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 BlogTheme, BlogTopicArchivePage, BlogTopicsIndexPage, type BreadcrumbListSchema, Button, CanonicalUrlOptions, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, DrizzleStorage, EnvAuth, type GeneratedMetadata, InMemoryStorage, type LinkTag, type MetaTag, type MetadataOptions, NEWSLETTER_SUCCESS_MESSAGE, NewsletterSignup, type NewsletterSignupProps, NoAuth, type OrganizationSchema, PACKAGE_VERSION, Pagination$1 as Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious, type PersonSchema, PublishResult, PublishedArticle, PublishedAuthor, PublishedNewsletterSettings, PublishedSite, PublishedTopic, type RateLimitConfig, type RateLimitResult, Pagination as ShadcnPagination, StructuredDataError, type StructuredDataOptions, type TopicArchive, UninitializedAuth, type WebSiteSchema, autoConfigureRateLimit, bpArticles, bpOperations, buildAuthorPath, buildBlogPath, buttonVariants, checkRateLimit, cn, configureRateLimit, createRateLimitErrorResponse, createStructuredDataScript, createTokenFingerprint, enforceRateLimit, extractKeywordsFromArticle, extractTableOfContents, extractTokenFromHeader, formatArticleDateMeta, generateArticleMetadata, generateArticleStructuredData, generateAuthorPageMetadata, generateAuthorStructuredData, generateBlogHomeMetadata, generateBlogHomeStructuredData, generateBreadcrumbStructuredData, generateCompleteArticleStructuredData, generateOrganizationStructuredData, generatePaginationMetadata, generateSiteMetadata, generateWebSiteStructuredData, getAllTopics, getArticlePrimaryTopic, getAuthConfig, getAuthorArchive, getAuthorsFromArticles, getBlogThemeStyle, getDrizzleAdapterSql, getPathPrefixFromBlogUrl, getRateLimitHeaders, getStorage, getTopicArchive, initBlogPlatform, initBlogPlatformDev, initBlogPlatformOnce, initBlogPlatformProd, initEnvAuth, loadAuthorArchive, metadataToHtml, normalizeBlogBasePath, POST$1 as publishHandler, safeGenerateArticleStructuredData, setAuthConfig, setStorage, shouldSkipAuth, GET as slugExistsHandler, OPTIONS as slugExistsOptionsHandler, structuredDataToJsonLd, POST as unpublishHandler, usePagination, validateMetadata, validateStructuredData, GET$1 as versionHandler };