How payloadcms/payload works
Payload is an embeddable, extensible headless CMS and app framework. Its user-facing workflow is to manage content through the React admin, expose it through REST or GraphQL, and consume it in an application; the README also highlights authentication, drafts and versions, localization, rich text, access control, hooks, and live preview. The graph preserves those capabilities and sampled internal layers, but many runtime links remain unshown: arrows are limited to relationships evidenced by the README or sampled source index/excerpts.
Main entry points: types.ts Content Model · cloudStorage.ts Cloud File Versions · ui Admin UI · index.ts REST API
Components 24
Content and Admin
- Admin UI
packages/ui - Content Model
packages/payload/src/collections/config/types.ts - Rich Text
packages/richtext-lexical - Localization
packages/translations - Lifecycle Hooks
packages/payload/src/collections/config/types.ts - Drafts and Versions
packages/payload/src/versions/saveVersion.ts
API and Queries
- REST API
packages/next/src/routes/rest/index.ts - GraphQL API
packages/next/src/routes/graphql/handler.ts - Query Builder
packages/drizzle/src/queries/buildQuery.ts - Query Operators
packages/drizzle/src/queries/operatorMap.ts - Mongo Queries
packages/db-mongodb/src/queries/sanitizeQueryValue.ts
Auth and Access
- Auth Operations
packages/payload/src/auth/operations/me.ts - Token Refresh
packages/payload/src/auth/operations/refresh.ts - Access Control
packages/payload/src/collections/config/types.ts
Uploads and Versions
- Upload Paths
packages/payload/src/uploads/generateFilePathOrURL.ts - File Versioning
packages/payload/src/uploads/fileVersioning/fileOperationManager.ts - Stored Files
packages/payload/src/uploads/fileVersioning/storedFiles.ts - File Cleanup
packages/payload/src/uploads/fileVersioning/cleanup.ts - Transform Planning
packages/payload/src/uploads/transformers/planTransformerPipeline.ts - Cloud File Versions
packages/payload/src/uploads/fileVersioning/cloudStorage.ts
Extensions and Preview
- Plugins
packages - Live Preview
packages/live-preview-react/src/useLivePreview.ts
Other components
- Content User
- Frontend App
Connections 23
- Content User → Admin UI: manages content
README.md - Admin UI → Content Model: edits content
README.md - Content Model → Rich Text: supports editing
README.md - Content Model → Localization: supports localized content
README.md - Content Model → Lifecycle Hooks: configures hooks
README.md - Content Model → Access Control: configures access
README.md - Content Model → Drafts and Versions: supports drafts
README.md - Frontend App → REST API: requests content
README.md - Frontend App → GraphQL API: queries content
README.md - REST API → GraphQL API: routes via index
- REST API → Query Builder: queries through adapter
- Query Builder → Query Operators: uses operators
packages/drizzle/src/types.ts - Frontend App → Mongo Queries: queries database
- Content Model → Upload Paths: configures uploads
README.md - Cloud File Versions → File Versioning: runs file plan
packages/payload/src/uploads/fileVersioning/cloudStorage.ts - Cloud File Versions → Stored Files: collects file references
packages/payload/src/uploads/fileVersioning/cloudStorage.ts - Cloud File Versions → File Cleanup: schedules cleanup
packages/payload/src/uploads/fileVersioning/cloudStorage.ts - Cloud File Versions → Drafts and Versions: saves versions
packages/payload/src/uploads/fileVersioning/cloudStorage.ts - Frontend App → Transform Planning: plans transforms
- Admin UI → Live Preview: enables preview
README.md - Content Model → Plugins: extends through plugins
README.md - Content User → Auth Operations: authenticates
README.md - Auth Operations → Token Refresh: refreshes session