Rust crates

Development These docs follow the development version and change with every merge.

Last updated View as Markdown

Generated from rustdoc JSON for the Bookclerk workspace's libraries. To write a native plugin, use the Rust plugin SDK.

Plugin interface

The plugin ABI, the plugin.toml manifest and the plugin author CLI.

Crate Description
bookclerk_plugin_abi Authoritative Bookclerk plugin Workers RPC ABI (schema + shared types)
bookclerk_plugin_manifest plugin.toml parse, validate, and canonical format (no host deps)
bookclerk_plugin_tools Bookclerk plugin author CLI (bookclerk-plugin: check / fmt / sync-embed / package / smoke / test)

Plugins

First-party plugins: databases, destinations, sources and integrations.

Crate Description
bookclerk_plugin_ai_embedder Text-embedding model plugin: runs cut ONNX embedding models from language row packs inside the plugin jail
bookclerk_plugin_database_d1 Optional Cloudflare D1 library database plugin (Workers RPC guest)
bookclerk_plugin_database_postgres Optional PostgreSQL library database plugin (Workers RPC guest)
bookclerk_plugin_database_sqlite Platform SQLite library database plugin (Workers RPC guest)
bookclerk_plugin_destination_b2 Backblaze B2 output plugin: native guest for Bookclerk
bookclerk_plugin_destination_local Local filesystem output plugin: Workers RPC guest for Bookclerk
bookclerk_plugin_destination_r2 Cloudflare R2 output plugin: Workers RPC guest for Bookclerk
bookclerk_plugin_destination_s3 S3 / MinIO output plugin: Workers RPC guest for Bookclerk
bookclerk_plugin_source_audible Audible storefront plugin guest (jailed native binary)
bookclerk_plugin_source_chirp Chirp source plugin: native storefront guest binary
bookclerk_plugin_source_graphicaudio GraphicAudio source plugin: native storefront guest binary
bookclerk_plugin_source_libro Libro.fm source plugin: native storefront guest binary

Host internals

The crates the hosts are built from. Not a stable API.

Crate Description
bookclerk_acquire End-to-end acquire pipeline: license, download, decrypt, store
bookclerk_archive Bounded, sans-IO extraction of uploaded ZIP and tar archives: entry path policy, size and ratio limits, and the report the media worker returns
bookclerk_audible_catalog Unauthenticated Audible catalog HTTP (search, genres, ratings, reviews) shared by the Audible guest and host enrichment
bookclerk_config Bookclerk settings, paths, and naming template config
bookclerk_cover Cover image pipeline: sniff, decode under limits, resize and re-encode untrusted cover art as JPEG
bookclerk_db_exec Neutral SQL executor and transaction injects for database guests
bookclerk_db_guest First-party database guest session workers (SeaORM proxy, host IR envelopes)
bookclerk_db_testkit Contract conformance test kit: capability profiles, begin refusal, fault injection and the database adapter conformance suite
bookclerk_demo_seed Fills a fresh hosted-demo library with a second member, their books, wishlist and offline branch
bookclerk_discover Recommendations, embeddings, listening sync, and title request helpers
bookclerk_enrich Source-agnostic Audible metadata enrichment (catalog search, metadata providers, confidence scoring)
bookclerk_intake Groups a drop folder's listing into items and decides when each has settled, without IO
bookclerk_integrations Outbound integration framework (traits, registry, portal, claim tickets)
bookclerk_keystore OS keychain access for the Bookclerk library key: Keychain Services, Credential Manager and Secret Service
bookclerk_libav Decoders-only FFmpeg (AC-3/E-AC-3, WMA, AMR) for the confined media worker
bookclerk_library Library database schema, migrations, and book records
bookclerk_media Clear-media packaging: remux, metadata fix-up, and MP3 encode (no DRM)
bookclerk_migrate Import/export classic Libation Files and native Bookclerk backups
bookclerk_model_pack Layout of an embedding model on disk: the model description, the cut graph, the tokenizer and the token-row packs per language
bookclerk_mp4 ISO-BMFF container plumbing shared by media packaging and store plugins (no cryptography)
bookclerk_naming Port of Libation's NamingTemplate tag-template engine (Chardonnay parity)
bookclerk_node_client Branch-node client: enrollment, the pinned owner socket, heartbeats, claimed work, token write-back, wakes and resume
bookclerk_node_proto Branch-node protocol: node API frames, handshake signatures, key checks, and sealed boxes
bookclerk_onnxruntime Pin and fetch of the ONNX Runtime shared library the model plugin loads
bookclerk_player_api Sans-IO request parsers, response shapes and Socket.io framing of the host's /player API for audiobook player apps
bookclerk_player_engine Native playback for the desktop window: speed change, rate conversion and one-track playback over PCM from the media worker
bookclerk_plugin_catalog Registry-neutral plugin discovery, manifests, and secure install
bookclerk_plugin_host External plugin host: discovery, spawn, consent, and workerd-fronted guests
bookclerk_resolve Sans-IO resolver that maps store listings to FRBR works, expressions and editions
bookclerk_sandbox Portable, unprivileged process confinement (Landlock/seccomp, Seatbelt, AppContainer)
bookclerk_scan_delta Hash-based scan deltas for first-party storefronts with no change feed, kept in the plugin's own database
bookclerk_search Full-text search over library works (Tantivy)
bookclerk_sentencepiece Safe wrapper over the SentencePiece Lite tokenizer runtime, built from the pinned sources under third_party/sentencepiece-lite
bookclerk_source Host-side ContentSource trait and source registry; re-exports the storefront types guests share
bookclerk_storage Pluggable local, S3 (feature s3) and B2 (feature b2) storage backends for acquired audiobooks
bookclerk_storefront Types storefront guests share with the host: DTOs, ABI conversions and listing helpers, with no database, ORM or OpenAPI dependencies
bookclerk_tags Sans-IO readers for metadata embedded in audiobook files (MP4, ID3, FLAC, Ogg) and the tag worker's frames
bookclerk_tls The one rustls crypto provider and HTTP client TLS settings for the Bookclerk hosts
bookclerk_tray In-process system tray for bookclerkd (opens the web UI in a browser)
bookclerk_window_policy What the desktop window's custom scheme lets a page reach: origin and path refusals, header rewrite, navigation
bookclerk_workerd Jailed workerd isolate launcher for Bookclerk script plugins
bookclerkd Bookclerk daemon: scheduled scan, auto-acquire, HTTP control plane

Development and testing

Build tooling, test suites and examples.

Crate Description
bookclerk_dev Cargo alias dispatcher: build, stage, and run Bookclerk with external plugins
bookclerk_plugin_e2e End-to-end suite against a staged first-party plugin installation
bookclerk_plugin_echo_native_rust Reference Echo integration (native Rust / BookclerkPlugin)
bookclerk_plugin_echo_workerd_rust Echo integration — workerd Rust/Wasm guest (JSON dispatch + JS WorkerEntrypoint)

Generated from Cargo.toml at main · View as Markdown