@fayz-ai/plugin-blog 0.1.0

package/src/index.ts

@@ -0,0 +1,80 @@
+import { createElement, type FC, type ReactNode } from 'react'
+import type { PluginManifest } from '@fayz-ai/core'
+import { createSafeDataProvider } from '@fayz-ai/core'
+import { resolveConfig, type BlogPluginOptions } from './config'
+import { createMockBlogProvider } from './data/mock'
+import { createSupabaseBlogProvider } from './data/supabase'
+import { BlogProvider, type BlogContextValue } from './context'
+import { BlogList } from './components/BlogList'
+import { PostDetail } from './components/PostDetail'
+
+// ---------------------------------------------------------------------------
+// @fayz-ai/plugin-blog — website-surface blog/articles plugin.
+//
+// First real consumer of scaffolds:['website']. Ships public routes (/blog,
+// /blog/:slug) + data hooks (useBlogPosts/usePost). A bespoke host site feeds
+// its own card markup from the hooks and mounts the routes inside its chrome.
+// See createBlogPlugin's return: a { manifest, Provider } bundle the host reads
+// uniformly (manifest.routes for mounting, Provider for the app-root context).
+// ---------------------------------------------------------------------------
+
+export interface BlogWebsitePlugin {
+  /** Standard plugin manifest (routes + metadata). */
+  manifest: PluginManifest
+  /** App-root context provider, pre-bound to this plugin's resolved provider/config. */
+  Provider: FC<{ children: ReactNode }>
+  /** The resolved data provider (exposed for advanced host wiring/tests). */
+  dataProvider: BlogContextValue['provider']
+}
+
+export function createBlogPlugin(options?: BlogPluginOptions): BlogWebsitePlugin {
+  const config = resolveConfig(options)
+  const provider =
+    options?.dataProvider ??
+    createSafeDataProvider(
+      () => createSupabaseBlogProvider(),
+      () => createMockBlogProvider({ seed: options?.seed, defaultAuthor: options?.defaultAuthor }),
+    )
+
+  const value: BlogContextValue = { provider, config }
+  const Provider: FC<{ children: ReactNode }> = ({ children }) =>
+    createElement(BlogProvider, { value, children })
+  Provider.displayName = 'BlogPluginProvider'
+
+  const manifest: PluginManifest = {
+    id: 'blog',
+    name: 'Blog',
+    icon: 'Newspaper',
+    version: '0.1.0',
+    scope: options?.scope ?? 'universal',
+    verticalId: options?.verticalId,
+    scaffolds: ['website', 'landing_page'],
+    defaultEnabled: true,
+    dependencies: [],
+    declaredFeatures: [{ id: 'blog', label: 'Blog', group: 'Attract' }],
+    // Host owns website nav; no admin nav in M1.
+    navigation: [],
+    routes: [
+      { path: config.basePath, component: BlogList, guard: 'public' },
+      { path: `${config.basePath}/:slug`, component: PostDetail, guard: 'public' },
+    ],
+    widgets: [],
+  }
+
+  return { manifest, Provider, dataProvider: provider }
+}
+
+// Public API
+export type { BlogPluginOptions, ResolvedBlogConfig } from './config'
+export type { BlogPost, BlogListQuery, BlogAuthor } from './types'
+export type { BlogDataProvider } from './data/types'
+export { createMockBlogProvider, createSupabaseBlogProvider } from './data'
+export type { BlogSeed, BlogSeedPost } from './data/mock'
+export { BlogProvider, useBlogContext } from './context'
+export type { BlogContextValue } from './context'
+export { useBlogPosts, usePost } from './hooks'
+export type { UseBlogPostsResult, UsePostResult } from './hooks'
+export { BlogList } from './components/BlogList'
+export { PostDetail } from './components/PostDetail'
+export { PostCard } from './components/PostCard'
+export { AuthorAvatar } from './components/AuthorAvatar'

package/src/seo.ts

@@ -0,0 +1,63 @@
+import { absoluteUrl, breadcrumbJsonLd, organizationJsonLd } from '@fayz-ai/core'
+import type { BlogPost } from './types'
+
+// ---------------------------------------------------------------------------
+// Blog-specific schema.org builders. The head-manager mechanics (useSeo /
+// applySeo / meta+OG+Twitter) live in @fayz-ai/core — this only owns the
+// domain shapes (BlogPosting, Blog) that plug into core's SeoConfig.jsonLd.
+// ---------------------------------------------------------------------------
+
+/** Absolute canonical URL for a post. */
+export function postUrl(basePath: string, slug: string): string {
+  return absoluteUrl(`${basePath}/${slug}`)
+}
+
+/** schema.org BlogPosting + BreadcrumbList for an article page. */
+export function articleJsonLd(post: BlogPost, opts: { basePath: string; siteName: string }): Array<Record<string, unknown>> {
+  const url = postUrl(opts.basePath, post.slug)
+  const posting: Record<string, unknown> = {
+    '@context': 'https://schema.org',
+    '@type': 'BlogPosting',
+    headline: post.title,
+    description: post.excerpt,
+    image: post.image ? [post.image] : undefined,
+    articleSection: post.tag,
+    mainEntityOfPage: { '@type': 'WebPage', '@id': url },
+    author: {
+      '@type': 'Person',
+      name: post.author.name,
+      ...(post.author.role ? { jobTitle: post.author.role } : {}),
+    },
+    ...(post.publishedAt ? { datePublished: post.publishedAt, dateModified: post.publishedAt } : {}),
+    ...(opts.siteName ? { publisher: organizationJsonLd(opts.siteName) } : {}),
+  }
+  const breadcrumb = breadcrumbJsonLd([
+    { name: 'Blog', url: absoluteUrl(opts.basePath) },
+    { name: post.title, url },
+  ])
+  return [posting, breadcrumb]
+}
+
+/** schema.org Blog + post list for the listing page. */
+export function blogJsonLd(posts: BlogPost[], opts: { basePath: string; siteName: string; title: string }): Array<Record<string, unknown>> {
+  return [
+    {
+      '@context': 'https://schema.org',
+      '@type': 'Blog',
+      name: opts.title,
+      url: absoluteUrl(opts.basePath),
+      ...(opts.siteName ? { publisher: organizationJsonLd(opts.siteName) } : {}),
+      blogPost: posts.map((p) => ({
+        '@type': 'BlogPosting',
+        headline: p.title,
+        url: postUrl(opts.basePath, p.slug),
+        image: p.image,
+        author: { '@type': 'Person', name: p.author.name },
+        ...(p.publishedAt ? { datePublished: p.publishedAt } : {}),
+      })),
+    },
+  ]
+}
+
+// Re-export the generic hook so blog components import SEO from one place.
+export { useSeo } from '@fayz-ai/core'

package/src/types.ts

@@ -0,0 +1,45 @@
+// ---------------------------------------------------------------------------
+// Blog domain types. Deliberately presentation-agnostic: a host site maps these
+// into its own card markup, and the plugin's default components render them with
+// semantic Tailwind tokens so they inherit the host theme.
+// ---------------------------------------------------------------------------
+
+/** Medium-inspired author byline shown on cards and article pages. */
+export interface BlogAuthor {
+  name: string
+  /** Avatar image URL; a name-initial is shown as fallback. */
+  avatarUrl?: string
+  /** Short role/handle under the name (e.g. "Cirurgião-Dentista"). */
+  role?: string
+  /** One-line bio for the "about the author" block on the article page. */
+  bio?: string
+}
+
+export interface BlogPost {
+  /** URL-safe identifier used for the /blog/:slug detail route. */
+  slug: string
+  title: string
+  /** Short summary shown on cards / list. */
+  excerpt: string
+  /** Full article body. Plain text or lightweight markdown (paragraphs split on blank lines). */
+  body: string
+  /** Category / topic label (e.g. "Periodontia"). */
+  tag: string
+  /** Human-readable reading time (e.g. "5 min"). */
+  readTime: string
+  /** Human-readable publish date (e.g. "Janeiro 2025"). */
+  date: string
+  /** Machine date (ISO 8601) for SEO/JSON-LD datePublished. Optional. */
+  publishedAt?: string
+  /** Cover image URL. */
+  image: string
+  /** Byline author. Filled from the plugin's defaultAuthor when a post omits it. */
+  author: BlogAuthor
+}
+
+export interface BlogListQuery {
+  /** Cap the number of posts returned (e.g. the home teaser shows 3). */
+  limit?: number
+  /** Filter by tag. */
+  tag?: string
+}