bookclerk_plugin_sdk::protocol
Shared role method names and typed method payloads.
Audience: guest authors who need the Cap'n Proto method parameter / result
structs (generated from schema/plugin.capnp) without depending on host
crates. Wire types live in bookclerk_plugin_abi; this module re-exports
them for a stable SDK import path.
External plugins are untrusted relative to the host. The host must never
hand them library.db, master.key, or the Bookclerk files-dir root. Plugins
receive only a scoped plugin_data_dir / cache_dir, and credentials are
host-mediated (login returns a blob the host seals; scan and fetch receive
that blob from the host). Scan returns book DTOs for the host to upsert.
Prefer product docs under docs/plugins/README.md for jail / capability rules.
| Item | Kind | Summary |
|---|---|---|
PROTOCOL_NAME |
constant | Logical ABI identifier for diagnostics (not a plugin.toml field). |
MAX_RPC_LINE_BYTES |
constant | Maximum length of one framed bridge line in bytes (including newline). |
bookclerk_plugin_abi::Abridgementbookclerk_plugin_abi::AccountCredentialbookclerk_plugin_abi::AuthenticateUserParamsbookclerk_plugin_abi::Brandbookclerk_plugin_abi::CatalogCapabilitiesbookclerk_plugin_abi::CatalogDetailbookclerk_plugin_abi::CatalogDetailParamsbookclerk_plugin_abi::CatalogFieldbookclerk_plugin_abi::CatalogHitbookclerk_plugin_abi::CatalogHitsbookclerk_plugin_abi::CatalogSortbookclerk_plugin_abi::ChapterKindbookclerk_plugin_abi::ChapterMarkerbookclerk_plugin_abi::CliArgbookclerk_plugin_abi::CliArgKindbookclerk_plugin_abi::CliArgSpecbookclerk_plugin_abi::CliCommandSpecbookclerk_plugin_abi::CliInvokeParamsbookclerk_plugin_abi::CliInvokeResultbookclerk_plugin_abi::CliSchemabookclerk_plugin_abi::ConfigOptionbookclerk_plugin_abi::ConfigOptionValuebookclerk_plugin_abi::Creditbookclerk_plugin_abi::CreditLevelbookclerk_plugin_abi::CreditRolebookclerk_plugin_abi::EventPollResultbookclerk_plugin_abi::ExpandCandidatesParamsbookclerk_plugin_abi::Explicitnessbookclerk_plugin_abi::ExpressionKindbookclerk_plugin_abi::ExternalUserbookclerk_plugin_abi::FetchOptionsbookclerk_plugin_abi::FetchTitleParamsbookclerk_plugin_abi::FetchedFilebookclerk_plugin_abi::FetchedFileRolebookclerk_plugin_abi::Identifierbookclerk_plugin_abi::IdentifierSchemebookclerk_plugin_abi::ListDealsParamsbookclerk_plugin_abi::ListeningProgressbookclerk_plugin_abi::LoginCompleteParamsbookclerk_plugin_abi::LoginParamsbookclerk_plugin_abi::LoginResultbookclerk_plugin_abi::LoginStartResultbookclerk_plugin_abi::MediaKindbookclerk_plugin_abi::MediaSupportbookclerk_plugin_abi::OfferedAacProfilebookclerk_plugin_abi::OfferedCodecbookclerk_plugin_abi::OutputLocalContextDtobookclerk_plugin_abi::OutputS3ContextDtobookclerk_plugin_abi::PlainFetchbookclerk_plugin_abi::PortalAuthModebookclerk_plugin_abi::PurchaseHintbookclerk_plugin_abi::PurchaseHintParamsbookclerk_plugin_abi::PurchaseHintResultbookclerk_plugin_abi::PurchaseHintsParamsbookclerk_plugin_abi::PurchaseHintsResultbookclerk_plugin_abi::QualityOfferbookclerk_plugin_abi::QualityOffersParamsbookclerk_plugin_abi::QualityOffersResultbookclerk_plugin_abi::RevokeAccountParamsbookclerk_plugin_abi::S3CredentialsDtobookclerk_plugin_abi::ScanBookbookclerk_plugin_abi::ScanLibraryParamsbookclerk_plugin_abi::ScanPagebookclerk_plugin_abi::ScanParamsbookclerk_plugin_abi::SearchCatalogParamsbookclerk_plugin_abi::SeriesEntrybookclerk_plugin_abi::SourceAccountbookclerk_plugin_abi::SourceAccountsbookclerk_plugin_abi::SyncListeningResultbookclerk_plugin_abi::TitleQualityOfferbookclerk_plugin_abi::WorkKind
pub const PROTOCOL_NAME: &str = "workers-rpc";
Logical ABI identifier for diagnostics (not a plugin.toml field).
Manifests advertise compatibility via api_version only.
pub const MAX_RPC_LINE_BYTES: usize = _;
Maximum length of one framed bridge line in bytes (including newline).
Used by the workerd bridge framing. Currently 16 MiB.
Generated from crates/bookclerk-plugin-sdk at main · View as Markdown