API reference
Ridu APIs, package by package.
Browse application authoring, runtime, Fetch SDK, protocol, admin extension, migration, storage, plugin, and CLI APIs across 37 modules and 3,338 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
riduConfigure a Ridu application, start its server, and define access rules.
coreApplication settings and server APIs, also available from the root ridu package.
fieldDefine fields, add validation and permissions, customize their inputs, and reuse field groups.
operationRead values in field callbacks, report validation errors, and return changes from hooks.
queryBuild filters, refer to fields by path, sort results, and choose which relationships to load.
schemaInspect Ridu's resolved collections and fields, and work with resource, field, and locale identifiers.
storeBuild and read document values for the local API and hooks. This package also defines the interfaces database adapters implement.
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.
@riducms/plugin-graphqlThe statically bundled admin GraphQL playground paired with the Go GraphQL plugin.
TypeScript packages
@riducms/sdkThe generated-contract-aware Fetch client for browser and server applications.
@riducms/sveltekitSvelteKit integration: direct browser requests to Ridu, server rendering, and one session owner.
@riducms/protocolGenerated wire contracts and runtime guards shared by the SDK and admin.
@riducms/pluginBuild custom Svelte components, register admin plugins, and work with field forms.
@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.