# 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.

## Trust boundary

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`](#protocol_name) | constant | Logical ABI identifier for diagnostics (not a `plugin.toml` field). |
| [`MAX_RPC_LINE_BYTES`](#max_rpc_line_bytes) | constant | Maximum length of one framed bridge line in bytes (including newline). |

## Re-exports

- [`bookclerk_plugin_abi::Abridgement`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#abridgement)
- [`bookclerk_plugin_abi::AccountCredential`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#accountcredential)
- [`bookclerk_plugin_abi::AuthenticateUserParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#authenticateuserparams)
- [`bookclerk_plugin_abi::Brand`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#brand)
- [`bookclerk_plugin_abi::CatalogCapabilities`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#catalogcapabilities)
- [`bookclerk_plugin_abi::CatalogDetail`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#catalogdetail)
- [`bookclerk_plugin_abi::CatalogDetailParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#catalogdetailparams)
- [`bookclerk_plugin_abi::CatalogField`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#catalogfield)
- [`bookclerk_plugin_abi::CatalogHit`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#cataloghit)
- [`bookclerk_plugin_abi::CatalogHits`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#cataloghits)
- [`bookclerk_plugin_abi::CatalogSort`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#catalogsort)
- [`bookclerk_plugin_abi::ChapterKind`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#chapterkind)
- [`bookclerk_plugin_abi::ChapterMarker`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#chaptermarker)
- [`bookclerk_plugin_abi::CliArg`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#cliarg)
- [`bookclerk_plugin_abi::CliArgKind`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#cliargkind)
- [`bookclerk_plugin_abi::CliArgSpec`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#cliargspec)
- [`bookclerk_plugin_abi::CliCommandSpec`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#clicommandspec)
- [`bookclerk_plugin_abi::CliInvokeParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#cliinvokeparams)
- [`bookclerk_plugin_abi::CliInvokeResult`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#cliinvokeresult)
- [`bookclerk_plugin_abi::CliSchema`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#clischema)
- [`bookclerk_plugin_abi::ConfigOption`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#configoption)
- [`bookclerk_plugin_abi::ConfigOptionValue`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#configoptionvalue)
- [`bookclerk_plugin_abi::Credit`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#credit)
- [`bookclerk_plugin_abi::CreditLevel`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#creditlevel)
- [`bookclerk_plugin_abi::CreditRole`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#creditrole)
- [`bookclerk_plugin_abi::EventPollResult`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#eventpollresult)
- [`bookclerk_plugin_abi::ExpandCandidatesParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#expandcandidatesparams)
- [`bookclerk_plugin_abi::Explicitness`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#explicitness)
- [`bookclerk_plugin_abi::ExpressionKind`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#expressionkind)
- [`bookclerk_plugin_abi::ExternalUser`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#externaluser)
- [`bookclerk_plugin_abi::FetchOptions`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#fetchoptions)
- [`bookclerk_plugin_abi::FetchTitleParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#fetchtitleparams)
- [`bookclerk_plugin_abi::FetchedFile`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#fetchedfile)
- [`bookclerk_plugin_abi::FetchedFileRole`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#fetchedfilerole)
- [`bookclerk_plugin_abi::Identifier`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#identifier)
- [`bookclerk_plugin_abi::IdentifierScheme`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#identifierscheme)
- [`bookclerk_plugin_abi::ListDealsParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#listdealsparams)
- [`bookclerk_plugin_abi::ListeningProgress`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#listeningprogress)
- [`bookclerk_plugin_abi::LoginCompleteParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#logincompleteparams)
- [`bookclerk_plugin_abi::LoginParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#loginparams)
- [`bookclerk_plugin_abi::LoginResult`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#loginresult)
- [`bookclerk_plugin_abi::LoginStartResult`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#loginstartresult)
- [`bookclerk_plugin_abi::MediaKind`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#mediakind)
- [`bookclerk_plugin_abi::MediaSupport`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#mediasupport)
- [`bookclerk_plugin_abi::OfferedAacProfile`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#offeredaacprofile)
- [`bookclerk_plugin_abi::OfferedCodec`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#offeredcodec)
- [`bookclerk_plugin_abi::OutputLocalContextDto`](/docs/internals/crates/bookclerk_plugin_abi/kind/index.md#outputlocalcontextdto)
- [`bookclerk_plugin_abi::OutputS3ContextDto`](/docs/internals/crates/bookclerk_plugin_abi/kind/index.md#outputs3contextdto)
- [`bookclerk_plugin_abi::PlainFetch`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#plainfetch)
- [`bookclerk_plugin_abi::PortalAuthMode`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#portalauthmode)
- [`bookclerk_plugin_abi::PurchaseHint`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#purchasehint)
- [`bookclerk_plugin_abi::PurchaseHintParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#purchasehintparams)
- [`bookclerk_plugin_abi::PurchaseHintResult`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#purchasehintresult)
- [`bookclerk_plugin_abi::PurchaseHintsParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#purchasehintsparams)
- [`bookclerk_plugin_abi::PurchaseHintsResult`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#purchasehintsresult)
- [`bookclerk_plugin_abi::QualityOffer`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#qualityoffer)
- [`bookclerk_plugin_abi::QualityOffersParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#qualityoffersparams)
- [`bookclerk_plugin_abi::QualityOffersResult`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#qualityoffersresult)
- [`bookclerk_plugin_abi::RevokeAccountParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#revokeaccountparams)
- [`bookclerk_plugin_abi::S3CredentialsDto`](/docs/internals/crates/bookclerk_plugin_abi/kind/index.md#s3credentialsdto)
- [`bookclerk_plugin_abi::ScanBook`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#scanbook)
- [`bookclerk_plugin_abi::ScanLibraryParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#scanlibraryparams)
- [`bookclerk_plugin_abi::ScanPage`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#scanpage)
- [`bookclerk_plugin_abi::ScanParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#scanparams)
- [`bookclerk_plugin_abi::SearchCatalogParams`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#searchcatalogparams)
- [`bookclerk_plugin_abi::SeriesEntry`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#seriesentry)
- [`bookclerk_plugin_abi::SourceAccount`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#sourceaccount)
- [`bookclerk_plugin_abi::SourceAccounts`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#sourceaccounts)
- [`bookclerk_plugin_abi::SyncListeningResult`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#synclisteningresult)
- [`bookclerk_plugin_abi::TitleQualityOffer`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#titlequalityoffer)
- [`bookclerk_plugin_abi::WorkKind`](/docs/internals/crates/bookclerk_plugin_abi/generated/index.md#workkind)

## Constants

### PROTOCOL_NAME

```rust
pub const PROTOCOL_NAME: &str = "workers-rpc";
```

Logical ABI identifier for diagnostics (not a `plugin.toml` field).

Manifests advertise compatibility via `api_version` only.

### MAX_RPC_LINE_BYTES

```rust
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.
