@azlib/cms 0.7.1 → 0.8.0

package/README.md

@@ -392,6 +392,182 @@ console.log(`Remaining days: ${leaveReport.totalRemaining}`);
 
 ---
 
+## Built-in SEO & Metadata Plugin (`seoPlugin`)
+
+Automates dynamic XML sitemap generation, search engine `robots.txt`, OpenGraph/Twitter social cards, JSON-LD structured data, and content readability/SEO auditing.
+
+```typescript
+import {
+  createCMSEngine,
+  defineConfig,
+  seoPlugin,
+  getSeoService,
+} from "@azlib/cms";
+
+const config = defineConfig({
+  plugins: [
+    seoPlugin({
+      siteUrl: "https://example.com",
+      defaultTitle: "My Site",
+      titleTemplate: "%s | My Site",
+      autoExtendCollections: ["posts", "pages"], // Injects SEO fields into posts/pages
+    }),
+  ],
+});
+
+const cms = createCMSEngine(config);
+await cms.init();
+
+// Exposes REST endpoints:
+// GET /sitemap.xml
+// GET /robots.txt
+// GET /api/seo/metadata/:collection/:id
+// POST /api/seo/analyze
+```
+
+---
+
+## Built-in Search Indexing Plugin (`searchPlugin`)
+
+High-performance inverted-index full-text search with automatic real-time indexing across content create, update, publish, and delete hooks.
+
+```typescript
+import {
+  createCMSEngine,
+  defineConfig,
+  searchPlugin,
+  getSearchService,
+} from "@azlib/cms";
+
+const config = defineConfig({
+  plugins: [
+    searchPlugin({
+      enableAutoIndex: true, // Automatically updates search index on content mutations
+    }),
+  ],
+});
+
+const cms = createCMSEngine(config);
+await cms.init();
+
+const searchService = getSearchService(cms);
+const results = await searchService.search({ q: "microservices", limit: 10 });
+
+// Exposes REST endpoints:
+// GET /api/search?q=...&collections=...&limit=...
+// POST /api/search/reindex
+```
+
+---
+
+## Built-in Audit Log Plugin (`auditLogPlugin`)
+
+Immutable enterprise compliance logging tracking all mutations across content, media, taxonomies, options, and auth with field-level diffs.
+
+```typescript
+import {
+  createCMSEngine,
+  defineConfig,
+  auditLogPlugin,
+  getAuditLogService,
+} from "@azlib/cms";
+
+const config = defineConfig({
+  plugins: [auditLogPlugin()],
+});
+
+const cms = createCMSEngine(config);
+await cms.init();
+
+const auditService = getAuditLogService(cms);
+const history = await auditService.query({ action: "update", limit: 20 });
+
+// Exposes REST endpoints:
+// GET /api/audit-logs?action=...&actorId=...
+// GET /api/audit-logs/:id
+```
+
+---
+
+## Built-in Dynamic Forms Plugin (`formsPlugin`)
+
+Dynamic form schema builder with honeypot anti-spam protection, submission validation, and storage.
+
+```typescript
+import {
+  createCMSEngine,
+  defineConfig,
+  formsPlugin,
+  getFormsService,
+} from "@azlib/cms";
+
+const config = defineConfig({
+  plugins: [formsPlugin()],
+});
+
+const cms = createCMSEngine(config);
+await cms.init();
+
+const formsService = getFormsService(cms);
+await formsService.registerForm({
+  slug: "contact",
+  title: "Contact Us",
+  fields: [
+    { name: "fullName", label: "Full Name", type: "text", required: true },
+    { name: "email", label: "Email", type: "email", required: true },
+    { name: "message", label: "Message", type: "textarea", required: true },
+  ],
+});
+
+// Exposes REST endpoints:
+// GET /api/forms
+// GET /api/forms/:slug
+// POST /api/forms/:slug/submit
+// GET /api/forms/:slug/submissions
+// PUT /api/forms/submissions/:id/status
+```
+
+---
+
+## Built-in Frontend Cache & Revalidation Plugin (`revalidationPlugin`)
+
+On-demand cache invalidation and ISR revalidation (Next.js, Vercel, Cloudflare, Astro) dispatching HMAC-signed webhook requests.
+
+```typescript
+import {
+  createCMSEngine,
+  defineConfig,
+  revalidationPlugin,
+  getRevalidationService,
+} from "@azlib/cms";
+
+const config = defineConfig({
+  plugins: [
+    revalidationPlugin({
+      endpoints: [
+        {
+          url: "https://my-frontend.com/api/revalidate",
+          secret: process.env.REVALIDATION_SECRET,
+        },
+      ],
+      collectionPathMap: {
+        posts: (item) => [`/blog/${item.slug}`, "/blog"],
+      },
+    }),
+  ],
+});
+
+const cms = createCMSEngine(config);
+await cms.init();
+
+// Automatically derives tags and paths and notifies frontends with HMAC signature.
+// Exposes REST endpoints:
+// POST /api/revalidate
+// GET /api/revalidate/history
+```
+
+---
+
 ## License
 
 MIT © Google / azlib