bookclerk_plugin_abi::plugin_capnp
Generated Cap'n Proto RPC interfaces (schema/plugin.capnp).
Included at crate root because capnpc emits crate::plugin_capnp paths.
scalar_limitsplugin_errorobject_metadataobject_infolist_optionslist_pagebyte_rangeread_optionswrite_optionsput_resultcopy_resultmove_optionsmove_resultkey_pairmove_many_targetmove_many_requestkey_outcomemove_many_pagedelete_many_resulthead_many_resulttranslate_keys_resultchanges_requestobject_changechanges_pageplugin_describeoptionaloidc_client_templateoidc_clients_okoidc_clients_replyextensible_configbindingsnetwork_grantsetting_network_grantentrypointsentrypoints_replyjob_invocationcompleted_outcomeretryable_outcomerejected_outcomecancelled_outcomesuspended_outcomejob_outcomedomain_eventevent_ackevent_retryevent_rejectevent_dead_letterevent_suspendedevent_resultevent_batchevent_batch_replyevent_read_requestevent_read_pageevent_read_replyjob_controllerhead_okhead_replylist_replyget_okget_replyput_replycopy_replymove_replymove_many_replydelete_many_replyhead_many_replytranslate_keys_replychanges_replyempty_replypull_okpull_replyopen_okopen_replydescribe_replyhandle_replyhealth_okhealth_replyadapter_session_replyguest_database_replybyte_sourceorigin_responseorigin_fetch_replydestinationsourceprogress_sinkcancellationjob_runnerevent_consumerevent_publishernamed_databasescheduled_handlerqueue_consumerqueue_producernamed_queuekv_namespacenamed_kvsocketssocket_handleroriginingresswebhookswebhook_handlercontent_sourceremote_libraryplugin_clioidcmetadata_providercover_fetchermetadata_filesnotifiernotification_raiserai_modelsai_runnerjson_enumevent_consumer_specplugin_capabilitiescatalog_capabilitiesbrandconfig_optionconfig_option_valuecli_schemacli_command_speccli_arg_speccli_argcli_invoke_paramscli_invoke_resultcli_schema_replycli_invoke_replydatabase_adapter_configdiagnose_resultdiagnose_replysource_accountlogin_paramslogin_resultlogin_start_resultlogin_complete_paramslogin_replylogin_start_replyaccount_credentialscan_paramsmedia_supportidentifiercreditseries_entryscan_bookscan_pagescan_replyfetch_optionsfetch_title_paramsfetched_filechapter_markerplain_fetchfetch_title_replysource_accountssource_accounts_replysearch_catalog_paramsexpand_candidates_paramspurchase_hint_paramslist_deals_paramscatalog_detail_paramsrevoke_account_paramscatalog_hitcatalog_hitscatalog_hits_replycatalog_detailcatalog_detail_replypurchase_hintpurchase_hint_resultpriced_recordpurchase_hint_replypurchase_hints_paramspurchase_hints_resultpurchase_hints_replyquality_offerquality_offers_paramstitle_quality_offerquality_offers_resultquality_offers_replyscan_library_paramsauthenticate_user_paramsexternal_userexternal_user_replyevent_poll_resultevent_poll_replylistening_progresssync_listening_resultsync_listening_replyplugin_eventpublish_okpublish_replyinvocationqueue_messagequeue_batchqueue_retryqueue_resultqueue_batch_okqueue_batch_replyqueue_send_messagequeue_send_okqueue_send_replykv_put_optionskv_get_okkv_get_replykv_put_okkv_delete_okkv_put_replykv_delete_replykv_list_optionskv_list_keykv_list_okkv_list_replyscheduled_controllermetadata_lookup_paramsmetadata_search_paramsmetadata_chapters_paramsmetadata_recordmetadata_recordsmetadata_records_replymetadata_chaptermetadata_chaptersmetadata_chapters_replycover_fetch_paramscover_conditioncover_imagecover_imagescover_images_replymetadata_file_recordmetadata_file_parse_paramsmetadata_file_parsedmetadata_file_parse_replymetadata_audio_filemetadata_file_render_paramsmetadata_file_renderedmetadata_file_render_replynotification_fieldnotification_messagenotify_destinationnotify_send_paramsnotify_sentnotify_send_replynotify_validate_paramsnotify_validatednotify_validate_replynotify_raise_paramsnotify_raisednotify_raise_replyai_modelai_model_listai_models_replyai_embed_textai_text_embeddings_inputai_text_embeddings_outputai_inputai_outputai_run_paramsai_run_okai_run_replysocket_framesocket_headersocket_auto_responsesocket_connect_requestsocket_infosocket_connect_replysocket_listsocket_list_replysocket_message_replysocket_message_oksocket_messagesocket_closedorigin_headerorigin_requestingress_startedingress_start_replywebhook_urlwebhook_url_replywebhook_pull_requestwebhook_headerwebhook_deliverywebhook_pull_pagewebhook_pull_replyingress_healthingress_health_replywebhook_ack_requestwebhook_delivereddb_valuedb_columndb_rowdb_statementexecute_requestsql_spantext_collate_siteinteger_arith_sitephysical_accessresolved_assignmentnamed_sql_typecolumn_referenceoptional_column_referenceforeign_key_constrainttable_constraintcreate_table_schemaschema_createschema_actionresolved_statementadapter_receiptadapter_statementadapter_execute_requeststatement_resultdb_timingexecute_replyexecute_result_replyexecute_stream_headexecute_stream_statementexecute_stream_frameexecute_stream_replydb_capabilitiesdb_bootstrap_replydb_bootstrapdb_capabilities_replydatabaseidentity_high_wateridentity_export_replyuser_relations_replyadapter_database_sessionguest_databaseplugin_migration_opplugin_migrationplugin_migrations_okplugin_migrations_replyplugin_worker
pub enum ObjectChangeKind {
Changed = 0,
Upserted = 1,
Removed = 2,
}
Implements: Clone, Copy, Debug, Eq, From<ObjectChangeKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum SettingNetworkKind {
Fetch = 0,
Tcp = 1,
}
Implements: Clone, Copy, Debug, Eq, From<SettingNetworkKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum SettingGrantState {
Approved = 0,
Pending = 1,
Unset = 2,
Invalid = 3,
}
Implements: Clone, Copy, Debug, Eq, From<SettingGrantState>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum PluginErrorCode {
InvalidParams = 0,
Unauthorized = 1,
Forbidden = 2,
NotFound = 3,
Unavailable = 4,
Unsupported = 5,
Internal = 6,
PayloadTooLarge = 7,
DeadlineExceeded = 8,
InvalidCursor = 9,
Cancelled = 10,
Conflict = 11,
LimitExceeded = 12,
RateLimited = 13,
NetworkNotGranted = 14,
}
Implements: Clone, Copy, Debug, Eq, From<PluginErrorCode>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum Entrypoint {
Storefront = 0,
Storage = 1,
DatabaseAdapter = 2,
RemoteLibrary = 3,
Cli = 4,
Oidc = 5,
Metadata = 6,
Covers = 7,
MetadataFiles = 8,
Notifier = 9,
Ingress = 10,
Ai = 11,
}
Implements: Clone, Copy, Debug, Eq, From<Entrypoint>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum PortalAuthMode {
Unspecified = 0,
Password = 1,
Oauth = 2,
}
Implements: Clone, Copy, Debug, Eq, From<PortalAuthMode>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum CliArgKind {
String = 0,
Bool = 1,
Int = 2,
Path = 3,
}
Implements: Clone, Copy, Debug, Eq, From<CliArgKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum WorkKind {
Unspecified = 0,
Book = 1,
Podcast = 2,
}
Implements: Clone, Copy, Debug, Eq, From<WorkKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum ExpressionKind {
Unspecified = 0,
Text = 1,
Narration = 2,
Dramatisation = 3,
Graphic = 4,
OriginalAudio = 5,
}
Implements: Clone, Copy, Debug, Eq, From<ExpressionKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum MediaKind {
Unspecified = 0,
Audio = 1,
Ebook = 2,
Print = 3,
}
Implements: Clone, Copy, Debug, Eq, From<MediaKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum IdentifierScheme {
Isbn = 0,
Asin = 1,
OpenLibraryEdition = 2,
OpenLibraryWork = 3,
}
Implements: Clone, Copy, Debug, Eq, From<IdentifierScheme>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum CreditRole {
Author = 0,
Narrator = 1,
Translator = 2,
Editor = 3,
Illustrator = 4,
Publisher = 5,
Host = 6,
Cast = 7,
Adaptor = 8,
}
Implements: Clone, Copy, Debug, Eq, From<CreditRole>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum CreditLevel {
RoleDefault = 0,
Work = 1,
Expression = 2,
Edition = 3,
}
Implements: Clone, Copy, Debug, Eq, From<CreditLevel>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum FetchedFileRole {
Unspecified = 0,
Part = 1,
Whole = 2,
Cover = 3,
}
Implements: Clone, Copy, Debug, Eq, From<FetchedFileRole>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum ChapterKind {
Unknown = 0,
Chapters = 1,
Tracks = 2,
}
Implements: Clone, Copy, Debug, Eq, From<ChapterKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum CatalogSort {
Relevance = 0,
Popularity = 1,
Rating = 2,
Title = 3,
Author = 4,
}
Implements: Clone, Copy, Debug, Eq, From<CatalogSort>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum CatalogField {
Any = 0,
Author = 1,
Narrator = 2,
Series = 3,
Genre = 4,
}
Implements: Clone, Copy, Debug, Eq, From<CatalogField>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum PriceLookup {
Unspecified = 0,
Product = 1,
Isbn = 2,
Asin = 3,
Title = 4,
}
Implements: Clone, Copy, Debug, Eq, From<PriceLookup>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum Abridgement {
Unknown = 0,
Unabridged = 1,
Abridged = 2,
}
Implements: Clone, Copy, Debug, Eq, From<Abridgement>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum Explicitness {
Unknown = 0,
Clean = 1,
Explicit = 2,
}
Implements: Clone, Copy, Debug, Eq, From<Explicitness>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum OfferedCodec {
Unknown = 0,
Aac = 1,
Alac = 2,
Flac = 3,
Mp3 = 4,
Opus = 5,
Vorbis = 6,
Eac3 = 7,
Ac4 = 8,
}
Implements: Clone, Copy, Debug, Eq, From<OfferedCodec>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum OfferedAacProfile {
Unknown = 0,
Lc = 1,
He = 2,
HeV2 = 3,
Xhe = 4,
}
Implements: Clone, Copy, Debug, Eq, From<OfferedAacProfile>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum MetadataField {
Title = 0,
Subtitle = 1,
Description = 2,
Publisher = 3,
PublishedAt = 4,
Language = 5,
Genres = 6,
Tags = 7,
Abridgement = 8,
ExpressionKind = 9,
Identifiers = 10,
Credits = 11,
Series = 12,
Chapters = 13,
Duration = 14,
Explicitness = 15,
}
Implements: Clone, Copy, Debug, Eq, From<MetadataField>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum NotificationSeverity {
Info = 0,
Warning = 1,
Critical = 2,
}
Implements: Clone, Copy, Debug, Eq, From<NotificationSeverity>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum NotificationAudience {
Operational = 0,
Patron = 1,
Account = 2,
}
Implements: Clone, Copy, Debug, Eq, From<NotificationAudience>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum NotificationAlertAction {
None = 0,
Trigger = 1,
Resolve = 2,
}
Implements: Clone, Copy, Debug, Eq, From<NotificationAlertAction>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum NotifyDestinationKind {
Channel = 0,
Personal = 1,
}
Implements: Clone, Copy, Debug, Eq, From<NotifyDestinationKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum AiTask {
TextEmbeddings = 0,
}
Implements: Clone, Copy, Debug, Eq, From<AiTask>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum AiTextRole {
Document = 0,
Query = 1,
}
Implements: Clone, Copy, Debug, Eq, From<AiTextRole>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum DbType {
Unspecified = 0,
Bool = 1,
Int64 = 2,
Float64 = 3,
Text = 4,
Bytes = 5,
}
Implements: Clone, Copy, Debug, Eq, From<DbType>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum DbStatementKind {
Execute = 0,
Select = 1,
Returning = 2,
}
Implements: Clone, Copy, Debug, Eq, From<DbStatementKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum DbResultSelection {
Discard = 0,
AffectedRows = 1,
Rows = 2,
}
Implements: Clone, Copy, Debug, Eq, From<DbResultSelection>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum IsolationReq {
AtomicBatch = 0,
NestedSavepoint = 1,
ConsistentSnapshot = 2,
}
Implements: Clone, Copy, Debug, Eq, From<IsolationReq>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum ResolvedSqlType {
Integer = 0,
Real = 1,
Text = 2,
Blob = 3,
Boolean = 4,
Null = 5,
}
Implements: Clone, Copy, Debug, Eq, From<ResolvedSqlType>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub enum IntegerArithKind {
Add = 0,
Sub = 1,
Mul = 2,
Abs = 3,
}
Implements: Clone, Copy, Debug, Eq, From<IntegerArithKind>, HasTypeId, Introspect, PartialEq, TryFrom<u16>
pub const API_VERSION: u32 = 3;
pub const MAX_SCALAR_BYTES: u32 = 262144;
pub const MAX_STREAM_WINDOW_BYTES: u32 = 1048576;
pub const MAX_LIST_PAGE: u32 = 256;
pub const MAX_BATCH_KEYS: u32 = 256;
pub const MAX_CHANGES_PAGE: u32 = 256;
pub const MAX_CHANGES_CURSOR_BYTES: u32 = 4096;
pub const MAX_CHECKPOINT_BYTES: u32 = 65536;
pub const MAX_SCAN_PAGE_BOOKS: u32 = 500;
pub const MAX_SCAN_CURSOR_BYTES: u32 = 4096;
pub const MAX_REFRESHED_CREDENTIAL_BYTES: u32 = 65536;
pub const MAX_EVENT_CURSOR_BYTES: u32 = 512;
pub const MAX_IDENTIFIER_BYTES: u32 = 64;
pub const MAX_CRON_BYTES: u32 = 128;
pub const MAX_CONFIG_PAYLOAD_BYTES: u32 = 65536;
pub const MAX_EVENT_PAYLOAD_BYTES: u32 = 65536;
pub const MAX_KV_VALUE_BYTES: u32 = 1048576;
pub const MAX_COVER_URLS: u32 = 32;
pub const MAX_COVER_BYTES: u32 = 10485760;
pub const MAX_COVER_HEADER_BYTES: u32 = 1024;
pub const MAX_METADATA_FILE_BYTES: u32 = 262144;
pub const MAX_METADATA_FILE_DESCRIPTION_BYTES: u32 = 65536;
pub const MAX_METADATA_FILE_TEXT_BYTES: u32 = 1024;
pub const MAX_METADATA_FILE_LIST_ENTRIES: u32 = 256;
pub const MAX_METADATA_FILE_CHAPTERS: u32 = 2000;
pub const MAX_NOTIFICATION_TITLE_BYTES: u32 = 256;
pub const MAX_NOTIFICATION_TEXT_BYTES: u32 = 16384;
pub const MAX_NOTIFICATION_HTML_BYTES: u32 = 65536;
pub const MAX_NOTIFICATION_FIELDS: u32 = 25;
pub const MAX_NOTIFICATION_FIELD_BYTES: u32 = 1024;
pub const MAX_NOTIFIER_ADDRESS_BYTES: u32 = 4096;
pub const MAX_AI_MODEL_NAME_BYTES: u32 = 192;
pub const MAX_AI_MODELS: u32 = 64;
pub const MAX_AI_EMBED_TEXTS: u32 = 64;
pub const MAX_AI_EMBED_TEXT_BYTES: u32 = 16384;
pub const MAX_AI_EMBED_DIMENSIONS: u32 = 4096;
pub const MAX_AI_LANGUAGES: u32 = 64;
pub const MAX_METADATA_AUDIO_FILES: u32 = 4096;
pub const MAX_KV_KEY_BYTES: u32 = 512;
pub const MAX_SOCKET_FRAME_BYTES: u32 = 262144;
pub const MAX_SOCKET_ATTACHMENT_BYTES: u32 = 2048;
pub const MAX_SOCKETS_PER_INSTANCE: u32 = 8;
pub const MAX_SOCKET_AUTO_RESPONSES: u32 = 4;
pub const MAX_SOCKET_AUTO_RESPONSE_BYTES: u32 = 256;
pub const MAX_SOCKET_URL_BYTES: u32 = 2048;
pub const MAX_SOCKET_HEADERS: u32 = 16;
pub const MAX_ORIGIN_HEADERS: u32 = 128;
pub const MAX_ORIGIN_HEADER_BYTES: u32 = 65536;
pub const MAX_ORIGIN_TARGET_BYTES: u32 = 8192;
pub const MAX_INGRESS_ORIGIN_BYTES: u32 = 253;
pub const MAX_WEBHOOK_PULL_BATCH: u32 = 100;
pub const MAX_WEBHOOK_LEASE_ID_BYTES: u32 = 128;
pub const MAX_WEBHOOK_VISIBILITY_MS: u32 = 43200000;
pub const MAX_WEBHOOK_BODY_BYTES: u32 = 1048576;
pub const MAX_WEBHOOK_HEADERS: u32 = 16;
pub const MAX_WEBHOOK_NAME_BYTES: u32 = 32;
pub const MAX_WEBHOOK_HEADER_VALUE_BYTES: u32 = 8192;
pub const MAX_KV_METADATA_BYTES: u32 = 1024;
pub const MAX_NETWORK_GRANT_ENTRIES: u32 = 256;
pub const MAX_PLUGIN_MIGRATION_OPS: u32 = 256;
pub const MAX_PLUGIN_MIGRATION_TOTAL_OPS: u32 = 2048;
pub const MAX_PLUGIN_MIGRATION_REGISTRATION_BYTES: u32 = 262144;
pub const FEATURE_SCALAR_LIMITS: &str = "rpc.scalarLimits";
pub const FEATURE_STREAMS: &str = "rpc.streams";
pub const FEATURE_STORAGE_COPY: &str = "storage.copy";
pub const FEATURE_STORAGE_MOVE: &str = "storage.move";
pub const FEATURE_STORAGE_MOVE_MANY: &str = "storage.moveMany";
pub const FEATURE_STORAGE_DELETE_MANY: &str = "storage.deleteMany";
pub const FEATURE_STORAGE_HEAD_MANY: &str = "storage.headMany";
pub const FEATURE_STORAGE_CONDITIONAL_WRITE: &str = "storage.conditionalWrite";
pub const FEATURE_STORAGE_CHANGES: &str = "storage.changes";
pub const FEATURE_STORAGE_TRANSLATE_KEYS: &str = "storage.translateKeys";
Generated from crates/bookclerk-plugin-abi at main · View as Markdown