2.5 KiB
2.5 KiB
OpenSpec Change: enterprise-api-plugin-site
- Change ID: enterprise-api-plugin-site
- Package:
@suaveplan/api-plugin-site - Category: api/content
- Target path:
api/content/api-plugin-site - Status: PROPOSED
- Date: 2026-04-24
- Reference spec:
/mnt/s/web/suaveplan/enterprise/api-plugin-site.md
Summary
Deliver @suaveplan/api-plugin-site on the genesis branch from scratch at enterprise quality. Site management plugin: multi-site configuration (custom domains, SSL status, theme/branding), page tree (parent/child hierarchy, SEO metadata, canonical URLs), navigation menus, redirect rules, sitemap generation via @suaveplan/sitemap, and robots.txt management. Routes under /sites. Per-table SurrealQL. Typed events: site:published, site:domain:changed, site:page:created.
Available workspace deps on genesis
| Package | Role |
|---|---|
@suaveplan/api (workspace:^) |
definePlugin |
@suaveplan/api-shared (workspace:^) |
Helpers |
@suaveplan/api-plugin-auth (workspace:^) |
requireAuth, requireRole |
@suaveplan/api-plugin-database (workspace:^) |
SurrealDB |
@suaveplan/sitemap (workspace:^) |
Sitemap XML generation |
@suaveplan/domain-normalizer (workspace:^) |
Domain validation |
@suaveplan/events (workspace:^) |
Event bus |
@suaveplan/error (workspace:^) |
SiteError hierarchy |
@suaveplan/audit-logging (workspace:^) |
Site change audit |
hono + @hono/zod-openapi + zod |
Routes |
@opentelemetry/api |
OTel |
Public API surface
function createSitePlugin(config?: SitePluginConfig): PluginDescriptor
// Services: SiteService, PageService, NavigationService, RedirectService, SitemapService
// Routes: /sites, /sites/:id, /sites/:id/pages, /sites/:id/navigation,
// /sites/:id/redirects, /sites/:id/sitemap.xml, /sites/:id/robots.txt
Error codes
type SiteErrorCode =
| "SITE_NOT_FOUND"
| "SITE_DOMAIN_TAKEN"
| "SITE_PAGE_NOT_FOUND"
| "SITE_REDIRECT_LOOP"
| "SITE_SLUG_CONFLICT"
File layout
api/content/api-plugin-site/
package.json tsconfig.json vitest.config.ts
surql/ (site, page, navigation_menu, redirect tables)
src/
index.ts events.ts types/ errors/
services/site/ services/page/ services/navigation/
services/redirect/ services/sitemap/
routes/sites/
tests/integration.test.ts
Impact
Prerequisites: @suaveplan/api, @suaveplan/api-plugin-auth, @suaveplan/api-plugin-database, @suaveplan/sitemap, @suaveplan/domain-normalizer.