Skip to main content

Properties

string
required
One-line summary of what the adapter connects to.
Environment variables and constructor-only configuration.
string
required
Named factory export from CatalogAdapter.packageName.
"vendor-official" | "official"
required
Catalog group used by the docs adapter listing.
string
Module specifier the factory is imported from, when the adapter ships on a subpath of CatalogAdapter.packageName. The package to install is still packageName. Defaults to packageName when omitted.
string
required
Display name.
string
required
NPM package that provides the adapter implementation.
readonly string[]
required
Runtime packages the adapter expects the consuming app to provide or install alongside it.
string
required
Stable catalog slug.
"platform" | "state"
required
Whether the adapter connects to a messaging platform or stores Chat SDK state.