Skip to content

Imports ​

Every import path, grouped by what it does. The Install column is the command that makes the import available; everything else works the same whichever install it comes from.

Storage, documents, and assets backends are listed separately under Adapters.

Content ​

The interfaces every backend implements, and the JSON:API handlers that serve them over HTTP.

ImportInstallWhat it does
contentia/storagepnpm add contentiaStorageRepository: objects, folders, and atoms
contentia/documentspnpm add contentiaDocumentsRepository: documents with drafts, publishing, revisions
contentia/assetspnpm add contentiaAssetsRepository: media files with URLs and image variations
contentia/catalogpnpm add contentiaCatalogProvider: collections and their JSON Schemas
contentia/storage/apipnpm add contentiabuildJsonApi: a storage repository as a JSON:API handler
contentia/documents/apipnpm add contentiaA documents repository as a JSON:API handler
contentia/assets/apipnpm add contentiaAn assets repository as a JSON:API handler
contentia/catalog-apipnpm add contentiaCatalog settings as a JSON:API handler
contentia/json-apipnpm add contentiaShared JSON:API helpers, including the explicit allowAll policy

Catalogs ​

Where collection definitions come from.

ImportInstallWhat it does
contentia/catalog-conventionpnpm add contentiaCollections by convention: each collection is the folder with the same name. Defaults are created on first use, no seeding needed.
contentia/catalog-decappnpm add contentiaCollections derived from a Decap CMS config, so the server and the editor share one source of truth. Supports multi-folder and nested collections.
@contentia/aws/catalog-ddbpnpm add contentia @contentia/awsCatalog settings stored in DynamoDB

Serializers ​

Any serializer works with any storage adapter. Register one per file extension.

ImportInstallWhat it does
contentia/serializers/jsonpnpm add contentiaJSON
contentia/serializers/yamlpnpm add contentiaYAML
contentia/serializers/markdownpnpm add contentiaMarkdown with frontmatter
contentia/serializers/rawpnpm add contentiaRaw text or binary, stored as-is

Running tasks ​

Nothing to import: await a task (or call task.run({ onProgress })), and iterate a stream with for await or load it whole with stream.collect(). These work without Effect.

ImportInstallWhat it does
contentia/corepnpm add contentiaContentiaTask, ContentiaStream, shared types, and errors, for code that uses Effect directly

Errors ​

ImportInstallWhat it does
contentia/core/errorspnpm add contentiaEvery ContentiaError class. Commonly caught: NotFoundError, BadRequestError, ForbiddenError, LockConflictError, VersionMismatchError, EntryAlreadyExistsError, TooManyRequestsError
contentia/core/errors-extrapnpm add contentiaHTTP mapping for errors: ErrorCodeToStatusMap (error code to HTTP status), ErrorCodeToKeyMap, ErrorClasses

Serving and authentication ​

ImportInstallWhat it does
contentia/server/apipnpm add contentiacontentiaApi: documents, storage, and assets behind one authenticated endpoint
contentia/server/oauth2pnpm add contentiaA self-contained OAuth2 login server: PKCE, email and password, passkeys, TOTP two-factor
contentia/server/oauth2/i18npnpm add contentiaTranslations for the login pages (…/en, …/nl)
contentia/authpnpm add contentiaScopes (hasScope, requireScope, …), personal access tokens (mintPersonalAccessToken, hashToken, …), and resolveBearer
contentia/locks/in-processpnpm add contentiaInProcessLockManager: advisory document locks for a single server process
contentia/server/mcppnpm add contentia @modelcontextprotocol/sdkThe MCP server: exposes the API to AI agents with two tools, read_api_spec and api_request. The MCP SDK is an optional peer

See API Server for how these fit together.

Uploads ​

ImportInstallWhat it does
contentia/file-sanitizerpnpm add contentiaStrips privacy-sensitive metadata from PNG, GIF, WebP, and JPEG uploads, and scans for dangerous content (sanitizeFile, canSanitize)
contentia/sanitizerpnpm add contentiaThe Sanitizer interface assets repositories accept, for plugging in your own sanitizer

Integrations ​

ImportInstallWhat it does
@contentia/astropnpm add contentia @contentia/astroAstro integration: dev JSON:API, content hot reload, types
@contentia/astro/loaderpnpm add contentia @contentia/astroContent Layer loaders: documentsLoader(), objectsLoader(), contentiaCollections()
@contentia/astro/livepnpm add contentia @contentia/astroliveDocumentsLoader() for live collections and draft previews
@contentia/astro/apipnpm add contentia @contentia/astrocreateApiHandler: serve the API from an Astro route
@contentia/astro/testingpnpm add contentia @contentia/astroA fake LoaderContext for testing loaders without booting Astro
@contentia/vite-pluginpnpm add contentia @contentia/vite-pluginVite plugin: import content as ES modules at build time
@contentia/decappnpm add contentia @contentia/decap @laikacms/decap-cms reactDecap CMS backend: the Decap admin reads and writes entries and media through the Contentia API

Writing your own adapter ​

ImportInstallWhat it does
contentia/storage/testingpnpm add contentiaContract tests for StorageRepository implementations
contentia/documents/testingpnpm add contentiaContract tests for DocumentsRepository, plus InMemoryDocumentsRepository, a fast in-memory backend for tests
contentia/assets/testingpnpm add contentiaContract tests for AssetsRepository implementations

Utilities ​

ImportInstallWhat it does
contentia/core/utilitiespnpm add contentiaDependency-free helpers (memoize, lazy, Url, Header, Paths) that don't pull in Effect
contentia/core/types/*pnpm add contentiaIndividual type modules: datetime, mime-type, pagination, role, …
contentia/cryptopnpm add contentiaHashing, password hashing, constant-time comparison, randomness. Import contentia/crypto/<module> to pull in one part only
contentia/i18npnpm add contentiaShared UI strings: OK, Cancel, Save, … (…/en, …/nl)

Older dashed import names (contentia/storage-fs, contentia/storage-serializers-json, …) are aliases of the paths above and resolve to the same modules.