API reference
Ridu APIs, package by package.
Browse application authoring, runtime, Fetch SDK, protocol, admin extension, migration, storage, plugin, and CLI APIs across 34 modules and 2,186 searchable symbols. Press / to search.
New to Ridu? Start with the task-oriented guides, then use this catalog for signatures, defaults, errors, and focused examples.
Go packages
riduThe ergonomic application facade for config, startup, and access decisions.
coreApplication contracts and the operation runtime behind the root facade.
fieldType-safe field builders and presentation options. Incompatible options fail at Go compile time; semantic issues are reported by ridu.Resolve.
queryImmutable filters, validated document paths, stable sorting, and relationship population controls.
schemaThe immutable generated schema manifest, stable identifiers, and advanced generator/plugin contracts.
storeAdvanced adapter contracts for transactional documents, auth, preferences, locks, publishing, uploads, and durable tasks.
storageObject-storage contracts used by upload collections. Implement this package only when the official local and S3 backends do not fit.
migrationAdvanced, database-independent vocabulary for immutable and reviewable migration artifacts.
migration/payloadOptional public import boundary for normalized Payload CMS exports; source-specific database extraction is deliberately out of scope.
protocol (Go)Advanced stable REST wire envelopes shared by the HTTP runtime, generators, SDK, admin, and transport tests.
plugintestStable backend conformance tests for third-party compiled Ridu plugins.
conformanceReusable behavioral qualification suites for Ridu store adapters.
Official adapters
postgresThe official PostgreSQL store, safe development schema sync, and immutable production migration runner.
sqliteThe official embedded SQLite store and its immutable, reversible migration lifecycle.
mongodbThe official replica-set MongoDB store, additive development index synchronization, and immutable forward-only migration lifecycle.
storage/localDurable filesystem object storage for development and single-host deployments.
storage/s3Dependency-free S3-compatible object storage with SigV4 requests and signed private reads.
Official plugins
graphqlAn optional manifest-generated GraphQL transport over Ridu’s operation engine; importing it is what links the GraphQL runtime.
mcpAn optional authenticated, read-only Model Context Protocol transport over explicitly selected Ridu content.
richtextA paired, versioned Lexical field with authoring for portable content, references, uploads, and blocks.
seoPayload-familiar search metadata fields, authenticated draft-aware generators, and a paired Svelte admin.
formbuilderPayload-familiar dynamic form definitions, server-validated submissions, notifications, uploads, and payment callbacks.
@riducms/plugin-richtextThe statically bundled Svelte/Lexical half of the rich-text plugin.
@riducms/plugin-seoThe statically bundled Svelte authoring half of the official SEO plugin.
@riducms/plugin-form-builderFramework-neutral public form helpers plus a separately exported static admin pairing.
TypeScript packages
@riducms/sdkThe generated-contract-aware Fetch client for browser and server applications.
@riducms/protocolGenerated wire contracts and runtime guards shared by the SDK and admin.
@riducms/pluginStatic Svelte 5 extension contracts for generated admins and plugin packages.
@riducms/buildBuild-time Vite, Svelte 5, and UnoCSS conventions for generated admins and plugin libraries.
@riducms/uiShared Svelte 5 interaction primitives and class composition for the admin and static plugins.
@riducms/adminThe framework-owned Svelte admin mount contract and public admin client surface.
@riducms/translationsTyped admin translations, language negotiation, plurals, and Intl formatting.
@riducms/cli/runProgrammatic Node launcher for invoking the platform-specific Ridu CLI binary.