81 lines
2.7 KiB
Markdown
81 lines
2.7 KiB
Markdown
# OpenSpec Change: enterprise-api-plugin-cms
|
|
|
|
- **Change ID**: enterprise-api-plugin-cms
|
|
- **Package**: `@suaveplan/api-plugin-cms`
|
|
- **Category**: api/content
|
|
- **Target path**: `api/content/api-plugin-cms`
|
|
- **Status**: PROPOSED
|
|
- **Date**: 2026-04-24
|
|
- **Reference spec**: `/mnt/s/web/suaveplan/enterprise/api-plugin-cms.md`
|
|
|
|
---
|
|
|
|
## Summary
|
|
|
|
Deliver `@suaveplan/api-plugin-cms` on the genesis branch from scratch at enterprise quality. Headless CMS plugin: content types (dynamic schema via Zod), content entries (CRUD with draft/published/archived states), versioning with full revision history, media management (upload + metadata via `@suaveplan/mime`), localization hooks, and a search index bridge to `@suaveplan/api-plugin-search`. Routes under `/cms`. Per-table SurrealQL. Typed events: `cms:entry:published`, `cms:entry:archived`, `cms:media:uploaded`.
|
|
|
|
---
|
|
|
|
## 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/api-plugin-search` (`workspace:^`) | Search index |
|
|
| `@suaveplan/mime` (`workspace:^`) | MIME detection for uploads |
|
|
| `@suaveplan/events` (`workspace:^`) | Event bus |
|
|
| `@suaveplan/error` (`workspace:^`) | `CmsError` hierarchy |
|
|
| `@suaveplan/audit-logging` (`workspace:^`) | Publish/archive audit |
|
|
| `@suaveplan/rate-limiter` (`workspace:^`) | Rate limits |
|
|
| `hono` + `@hono/zod-openapi` + `zod` | Routes |
|
|
| `@opentelemetry/api` | OTel |
|
|
|
|
---
|
|
|
|
## Public API surface
|
|
|
|
```ts
|
|
function createCmsPlugin(config?: CmsPluginConfig): PluginDescriptor
|
|
|
|
// Services: ContentTypeService, ContentEntryService, MediaService, RevisionService
|
|
// Routes: /cms/content-types, /cms/entries, /cms/entries/:id,
|
|
// /cms/entries/:id/publish, /cms/entries/:id/revisions, /cms/media
|
|
```
|
|
|
|
### Error codes
|
|
|
|
```ts
|
|
type CmsErrorCode =
|
|
| "CMS_TYPE_NOT_FOUND"
|
|
| "CMS_ENTRY_NOT_FOUND"
|
|
| "CMS_ENTRY_LOCKED"
|
|
| "CMS_MEDIA_NOT_FOUND"
|
|
| "CMS_INVALID_CONTENT_TYPE"
|
|
| "CMS_SCHEMA_VALIDATION_FAILED"
|
|
```
|
|
|
|
---
|
|
|
|
## File layout
|
|
|
|
```text
|
|
api/content/api-plugin-cms/
|
|
package.json tsconfig.json vitest.config.ts
|
|
surql/ (content_type, content_entry, content_revision, media tables)
|
|
src/
|
|
index.ts events.ts types/ errors/ schemas/
|
|
services/content-type/ services/content-entry/
|
|
services/media/ services/revision/
|
|
routes/content-types/ routes/entries/ routes/media/
|
|
tests/integration.test.ts
|
|
```
|
|
|
|
---
|
|
|
|
## Impact
|
|
|
|
Prerequisites: `@suaveplan/api`, `@suaveplan/api-plugin-auth`, `@suaveplan/api-plugin-database`, `@suaveplan/api-plugin-search`, `@suaveplan/mime`.
|