CMS Interfaces
Overview
The cms-back module ships several AntelopeJS interfaces. Each one is a separate contract with its own import subpath under @antelopejs-private/cms/interfaces/, and each has its own folder here.
A folder is a self-contained reference: it documents one interface, and every link inside it points at a sibling file in the same folder. When an interface is extracted into its own package, its folder moves with it verbatim.
These pages describe the contracts — the exact symbol names, options and return types. The DMS guide covers the same ground task by task, organised around what you are building.
The Interfaces
| Interface | What it is for | Import prefix |
|---|---|---|
| CMS | The core DMS contract: pages, modules, components, permissions, tenancy, hooks, realtime and quick actions. | @antelopejs-private/cms/interfaces/cms |
| CMS Auth | Authentication decorators, token and session handling, and the user and session tables. | @antelopejs-private/cms/interfaces/cms-auth |
| CMS Base | The component vocabulary: forms, tables, charts, layout, trees, data types and the shared prop types. | @antelopejs-private/cms/interfaces/cms-base |
| CMS HTML Render | Registering HTML templates and rendering them server-side. | @antelopejs-private/cms/interfaces/cms-html-render |
| CMS Notifications | Declaring notification categories and subjects, and building and sending notifications. | @antelopejs-private/cms/interfaces/cms-notifications |
| Job Locks | Running a job at most once across instances, backed by a database lock. | @antelopejs-private/cms/interfaces/job-locks |
Start with CMS and CMS Base: the first declares pages and the components they carry as serializable data, the second is the concrete set of components you fill those pages with. CMS Auth resolves a request to a user, which the CMS permission and tenant guards build on. The remaining three stand on their own and are used where you need them.
Several interfaces expose more than one subpath — the CMS interface splits its surface across /page, /component, /permissions and others, and CMS Auth publishes its tables under /db. Each introduction carries the map of its own subpaths.
How to Read a Folder
Every folder opens with 1.introduction.md. It gives you the overview, the key features, the AntelopeJS packages the interface depends on, one runnable quick-start example, and the list of the folder's other pages.
The numbered pages after it are topic pages, ordered so that reading them front to back builds up. Each one starts with an overview, then works through the surface task by task with a code example per section and a table for anything that takes options. Every topic page ends with a link to the next one, so you can also follow the folder straight through from the introduction.
Read a topic page on its own when you already know which surface you need. Symbols in an internal namespace are wiring between an interface and its implementation, and are not documented as part of the contract.