@xexr/blog-platform 1.0.15 → 1.0.17

package/dist/index-Dr8HaKGm.d.ts

@@ -0,0 +1,229 @@
+/**
+ * Public API contracts for the @xexr/blog-platform package.
+ *
+ * These types define the public interface between Bloggy and external blog platforms.
+ * They must remain stable and backward-compatible to ensure smooth upgrades.
+ *
+ * IMPORTANT: These contracts should never import from the main Bloggy application
+ * to maintain clean separation of concerns and prevent coupling.
+ */
+/**
+ * Public profile and social links for an author.
+ */
+interface PublishedAuthorSocialLinks {
+    /** Author website or profile URL */
+    readonly website?: string;
+    /** X/Twitter profile URL */
+    readonly x?: string;
+    /** Legacy Twitter profile URL */
+    readonly twitter?: string;
+    /** LinkedIn profile URL */
+    readonly linkedin?: string;
+    /** GitHub profile URL */
+    readonly github?: string;
+    /** Public contact email address */
+    readonly email?: string;
+}
+/**
+ * Represents a published author with essential information for bylines and attribution.
+ */
+interface PublishedAuthor {
+    /** Unique identifier for the author */
+    readonly id: string;
+    /** Author's full name */
+    readonly name: string;
+    /** URL-friendly slug for author pages */
+    readonly slug: string;
+    /** Author's bio/description (optional) */
+    readonly bio?: string;
+    /** Author avatar image URL (optional) */
+    readonly avatarUrl?: string;
+    /** Public profile and social links (optional) */
+    readonly socialLinks?: PublishedAuthorSocialLinks;
+    /** Pronouns for proper attribution */
+    readonly pronouns?: string;
+    /** Whether this is a guest author */
+    readonly isGuest: boolean;
+    /** Tone adjectives that describe this author's writing style */
+    readonly toneAdjectives: readonly string[];
+}
+/**
+ * Represents a published site with essential metadata for blog rendering.
+ */
+interface PublishedSite {
+    /** Unique identifier for the site */
+    readonly id: string;
+    /** Site name/title */
+    readonly name: string;
+    /** Site tagline/subtitle */
+    readonly tagline: string;
+    /** Site description */
+    readonly description: string;
+    /** Primary domain for the site */
+    readonly domain: string;
+    /** Site-wide tone adjectives for content context */
+    readonly toneAdjectives: readonly string[];
+    /** Default locale/language code */
+    readonly locale: string;
+    /** Optional Bloggy-owned newsletter capture configuration */
+    readonly newsletter?: PublishedNewsletterSettings;
+}
+/**
+ * Public configuration for Bloggy-owned newsletter capture.
+ */
+interface PublishedNewsletterSettings {
+    /** Whether the capture form should render */
+    readonly enabled: boolean;
+    /** Form heading */
+    readonly title: string;
+    /** Form supporting copy */
+    readonly description: string;
+    /** Submit button label */
+    readonly buttonLabel: string;
+    /** Base URL for the Bloggy instance that receives subscriptions */
+    readonly captureBaseUrl: string;
+    /** Site-scoped public token used to validate public submissions */
+    readonly publicSubscribeToken: string;
+}
+/**
+ * Public post-article CTA configuration.
+ */
+interface PublishedArticleCta {
+    /** CTA heading */
+    readonly title: string;
+    /** Optional supporting copy */
+    readonly description?: string;
+    /** Primary sign-up action */
+    readonly primary?: PublishedArticleCtaAction;
+    /** Secondary learn-more action */
+    readonly secondary?: PublishedArticleCtaAction;
+}
+/**
+ * Public post-article CTA link.
+ */
+interface PublishedArticleCtaAction {
+    /** Button label */
+    readonly label: string;
+    /** Safe http(s) URL or same-site relative path */
+    readonly href: string;
+}
+/**
+ * Public topic/category taxonomy assigned to published articles.
+ */
+interface PublishedTopic {
+    /** Unique identifier for the topic */
+    readonly id: string;
+    /** Display name */
+    readonly name: string;
+    /** URL-friendly slug for topic archive routing */
+    readonly slug: string;
+    /** Optional public description */
+    readonly description?: string;
+    /** Whether this is the article's primary topic */
+    readonly isPrimary: boolean;
+}
+/**
+ * Represents a published article with all necessary metadata for rendering
+ * on external blog platforms.
+ */
+interface PublishedArticle {
+    /** Unique identifier for the article */
+    readonly id: string;
+    /** URL-friendly slug for routing */
+    readonly slug: string;
+    /** Article title/headline */
+    readonly title: string;
+    /** Brief excerpt/summary for meta descriptions and previews */
+    readonly excerpt: string;
+    /** Full article content in markdown format */
+    readonly content: string;
+    /** Estimated reading time in seconds */
+    readonly readingSeconds: number;
+    /** Word count for analytics */
+    readonly wordCount: number;
+    /** Publication date as ISO 8601 string */
+    readonly publishedAt: string;
+    /** Last updated date as ISO 8601 string */
+    readonly updatedAt: string;
+    /** Author information (can be null for anonymous posts) */
+    readonly author: PublishedAuthor | null;
+    /** Site information */
+    readonly site: PublishedSite;
+    /** Optional post-article call-to-action */
+    readonly cta?: PublishedArticleCta;
+    /** Public topic taxonomy assigned to the article */
+    readonly topics?: readonly PublishedTopic[];
+    /** Featured image URL (optional) */
+    readonly featuredImage?: string;
+    /** Alt text for featured image */
+    readonly featuredImageAlt?: string;
+    /** Caption displayed with the featured image */
+    readonly featuredImageCaption?: string;
+    /** Credit text displayed with the featured image */
+    readonly featuredImageCreditText?: string;
+    /** Optional URL for the featured image credit */
+    readonly featuredImageCreditUrl?: string;
+    /** Featured image R2 key for CDN optimization (optional) */
+    readonly featuredImageKey?: string;
+    /** SEO meta tags */
+    readonly meta: {
+        /** Meta title (defaults to article title if not provided) */
+        readonly title?: string;
+        /** Meta description (defaults to excerpt if not provided) */
+        readonly description?: string;
+        /** Canonical URL for SEO */
+        readonly canonicalUrl?: string;
+        /** Keywords for SEO */
+        readonly keywords: readonly string[];
+        /** Open Graph image URL */
+        readonly ogImage?: string;
+    };
+    /** Article version for optimistic locking */
+    readonly version: number;
+}
+/**
+ * Payload structure for publishing operations.
+ * Used when sending publish/unpublish requests to blog platforms.
+ */
+interface PublishPayload {
+    /** The article to publish */
+    readonly article: PublishedArticle;
+    /** Idempotency key to prevent duplicate operations */
+    readonly idempotencyKey: string;
+    /** Optional slug override (defaults to article.slug) */
+    readonly slug?: string;
+    /** Optional meta description override (defaults to article.excerpt) */
+    readonly metaDescription?: string;
+    /** Platform-specific configuration */
+    readonly platformConfig?: Record<string, unknown>;
+    /** Whether this is a dry run (validation only) */
+    readonly dryRun?: boolean;
+}
+/**
+ * Result structure returned from publishing operations.
+ */
+interface PublishResult {
+    /** Whether the operation was successful */
+    readonly success: boolean;
+    /** The published article URL if successful */
+    readonly url?: string;
+    /** Platform-specific post ID */
+    readonly platformPostId?: string;
+    /** Publication timestamp as ISO 8601 string */
+    readonly publishedAt?: string;
+    /** Error information if unsuccessful */
+    readonly error?: {
+        /** Error code (PUB001-PUB011) */
+        readonly code: string;
+        /** Human-readable error message */
+        readonly message: string;
+        /** Additional error details */
+        readonly details?: Record<string, unknown>;
+    };
+    /** Validation warnings (for dry runs or minor issues) */
+    readonly warnings?: readonly string[];
+    /** Idempotency key used for this operation */
+    readonly idempotencyKey: string;
+}
+
+export type { PublishedTopic as P, PublishedArticle as a, PublishedSite as b, PublishedAuthor as c, PublishedNewsletterSettings as d, PublishedArticleCta as e, PublishResult as f, PublishPayload as g, PublishedAuthorSocialLinks as h };

package/dist/index.d.mts

@@ -1,16 +1,17 @@
-import { PublishedArticle, PublishedSite, PublishedNewsletterSettings, PublishedAuthor, PublishResult, PublishedTopic } from './types/index.mjs';
-export { PublishPayload, PublishedAuthorSocialLinks } from './types/index.mjs';
+import { a as PublishedArticle, b as PublishedSite, d as PublishedNewsletterSettings, e as PublishedArticleCta, c as PublishedAuthor, f as PublishResult, P as PublishedTopic } from './index-Dr8HaKGm.mjs';
+export { g as PublishPayload, h as PublishedAuthorSocialLinks } from './index-Dr8HaKGm.mjs';
 import * as React from 'react';
 import { CSSProperties, ReactElement } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
 import { ClassValue } from 'clsx';
+export { RelatedArticleCandidate, RelatedFeaturedArticlesOptions, getRelatedFeaturedArticles } from './lib/related-articles.mjs';
 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';
+import { C as CanonicalUrlOptions } from './sitemap-Dbl4CUGI.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-Dbl4CUGI.mjs';
 
 interface BlogTheme {
     accentColor?: string;
@@ -118,14 +119,10 @@ interface ArticlePageProps {
   };
   basePath?: string;
   theme?: BlogTheme;
-  postArticleCta?: {
-    title: string;
-    description?: string;
-    href: string;
-    label: string;
-  };
+  postArticleCta?: PublishedArticleCta;
   newsletter?: PublishedNewsletterSettings;
   newsletterPreviewMode?: boolean;
+  articles?: PublishedArticle[];
   relatedArticles?: PublishedArticle[];
   showShareLinks?: boolean;
 }

package/dist/index.d.ts

@@ -1,16 +1,17 @@
-import { PublishedArticle, PublishedSite, PublishedNewsletterSettings, PublishedAuthor, PublishResult, PublishedTopic } from './types/index.js';
-export { PublishPayload, PublishedAuthorSocialLinks } from './types/index.js';
+import { a as PublishedArticle, b as PublishedSite, d as PublishedNewsletterSettings, e as PublishedArticleCta, c as PublishedAuthor, f as PublishResult, P as PublishedTopic } from './index-Dr8HaKGm.js';
+export { g as PublishPayload, h as PublishedAuthorSocialLinks } from './index-Dr8HaKGm.js';
 import * as React from 'react';
 import { CSSProperties, ReactElement } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
 import { ClassValue } from 'clsx';
+export { RelatedArticleCandidate, RelatedFeaturedArticlesOptions, getRelatedFeaturedArticles } from './lib/related-articles.js';
 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-BPTdXb9C.js';
-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-BPTdXb9C.js';
+import { C as CanonicalUrlOptions } from './sitemap-BmCh8BpN.js';
+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-BmCh8BpN.js';
 
 interface BlogTheme {
     accentColor?: string;
@@ -118,14 +119,10 @@ interface ArticlePageProps {
   };
   basePath?: string;
   theme?: BlogTheme;
-  postArticleCta?: {
-    title: string;
-    description?: string;
-    href: string;
-    label: string;
-  };
+  postArticleCta?: PublishedArticleCta;
   newsletter?: PublishedNewsletterSettings;
   newsletterPreviewMode?: boolean;
+  articles?: PublishedArticle[];
   relatedArticles?: PublishedArticle[];
   showShareLinks?: boolean;
 }