Technical Reference
Complete technical reference for SveltyCMS — API endpoints, system architecture, security model, database adapters, and UI components.
Look up a contract here. If you have not used the product yet, start at Concepts and Getting started. Architecture explains why the engine is shaped this way; read the page for the change you are making.
📚 Reference Sections
📡 API Reference
The complete programmatic surface of SveltyCMS — Remote Functions, REST, GraphQL, Real-Time Event Streams, and the Local SDK for server-to-server communication. 15 documents covering every handler, response format, and authentication pattern.
Key topics: Collections API, Auth & SCIM 2.0, Media API, System & Setup, GraphQL, Tokens, Utility endpoints
🏗️ System Architecture
The architectural blueprint of SveltyCMS — from the Svelte 5 (Runes) reactive engine to the DB-agnostic adapter pattern. 45+ documents covering the core engine, lifecycle, modules, and design decisions.
Key topics: Server hooks & middleware, initialization workflow, state management, content system, plugin architecture, e-commerce, multilingual i18n, telemetry
🛡️ Security Reference
Security architecture and hardening guide — authentication, authorization, cryptography, and defense-in-depth patterns. 12 documents covering all security layers.
Key topics: Authentication system, login security, content security policy, field-level access control, widget security, incident response, quantum security
🗄️ Database Reference
Database adapter implementations and architecture — the unified query abstraction powering all four production engines. 10 documents covering infrastructure, resilience, and per-adapter implementation details.
Key topics: Core infrastructure, database methods, performance architecture, SQLite, PostgreSQL, MongoDB, MariaDB implementations
🧩 Components Reference
UI component architecture for the collection display system — entry lists, field editors, widget loaders, and supporting UI. Page shells and the native controls in src/components/ui are Native UI.
Key topics: entry-list, fields, widget-loader, translation-status, revision-diff-modal, schedule-modal, workflow-actions
🔗 Quick Navigation
| Section | Documents | Primary Audience |
|---|---|---|
| API | 15 | Developers, Integrators |
| Architecture | 45 | Architects, Developers |
| Security | 12 | Security Engineers, Admins |
| Database | 10 | DevOps, Backend Developers |
| Components | 11 | Frontend Developers |
Next Steps
- Start with the API Reference for integration work
- Review the System Architecture to understand the full pipeline
- Check the Security Reference for hardening your deployment
- See Database Reference for adapter selection and configuration
- Browse Components Reference for UI architecture details