Something went wrong. Try again.
A lexicon-driven AppView for ATProto.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484use serde::{Deserialize, Serialize};use serde_json::Value;
// ---------------------------------------------------------------------------// Lexicon types// ---------------------------------------------------------------------------
#[derive(Serialize)]pub(super) struct LexiconSummary { pub(super) id: String, pub(super) revision: i32, pub(super) lexicon_type: String, pub(super) backfill: bool, pub(super) action: Option<String>, pub(super) target_collection: Option<String>, pub(super) source: String, pub(super) authority_did: Option<String>, pub(super) last_fetched_at: Option<String>, pub(super) created_at: String, pub(super) updated_at: String, /// For record-type lexicons: the `properties` object from `defs.main.record`. #[serde(skip_serializing_if = "Option::is_none")] pub(super) record_schema: Option<Value>, pub(super) token_cost: Option<i32>,}
#[derive(Deserialize)]pub(super) struct UploadLexiconBody { pub(super) lexicon_json: Value, #[serde(default = "default_backfill")] pub(super) backfill: bool, pub(super) target_collection: Option<String>, pub(super) action: Option<String>, pub(super) token_cost: Option<i32>,}
fn default_backfill() -> bool { true}
// ---------------------------------------------------------------------------// Stats types// ---------------------------------------------------------------------------
#[derive(Serialize)]pub(super) struct StatsResponse { pub(super) total_records: i64, pub(super) collections: Vec<CollectionStat>,}
#[derive(Serialize)]pub(super) struct CollectionStat { pub(super) collection: String, pub(super) count: i64,}
// ---------------------------------------------------------------------------// Backfill types// ---------------------------------------------------------------------------
#[derive(Deserialize, Clone)]pub(super) struct CreateBackfillBody { pub(super) collection: Option<String>, pub(super) did: Option<String>,}
#[derive(Serialize)]pub(crate) struct BackfillJob { pub(crate) id: String, pub(crate) collection: Option<String>, pub(crate) did: Option<String>, pub(crate) status: String, pub(crate) stage: String, pub(crate) total_repos: Option<i32>, pub(crate) resolved_repos: Option<i32>, pub(crate) processed_repos: Option<i32>, pub(crate) total_records: Option<i32>, pub(crate) error: Option<String>, pub(crate) started_at: Option<String>, pub(crate) completed_at: Option<String>, pub(crate) created_at: String,}
// ---------------------------------------------------------------------------// Backfill event types// ---------------------------------------------------------------------------
#[derive(Clone, Debug, Serialize)]#[serde(tag = "type", rename_all = "snake_case")]pub enum BackfillEvent { RepoDiscovered { job_id: String, did: String, }, RepoResolved { job_id: String, did: String, pds_endpoint: String, }, RepoFetched { job_id: String, did: String, pds_endpoint: String, records_fetched: i32, }, JobCounters { job_id: String, total_repos: Option<i32>, resolved_repos: Option<i32>, processed_repos: Option<i32>, total_records: Option<i32>, }, JobStageChanged { job_id: String, stage: String, }, JobCompleted { job_id: String, status: String, error: Option<String>, },}
// ---------------------------------------------------------------------------// Backfill detail response types// ---------------------------------------------------------------------------
#[derive(Serialize)]pub(crate) struct BackfillRepoEntry { pub(crate) did: String, pub(crate) pds_endpoint: Option<String>, pub(crate) status: String, pub(crate) records_fetched: i32,}
#[derive(Serialize)]pub(crate) struct BackfillReposResponse { pub(crate) repos: Vec<BackfillRepoEntry>, pub(crate) cursor: Option<String>,}
#[derive(Serialize)]pub(crate) struct PdsSummaryEntry { pub(crate) pds_endpoint: String, pub(crate) total_repos: i32, pub(crate) completed_repos: i32, pub(crate) total_records: i32,}
#[derive(Serialize)]pub(crate) struct PdsSummaryResponse { pub(crate) pds_endpoints: Vec<PdsSummaryEntry>,}
// ---------------------------------------------------------------------------// Network lexicon types// ---------------------------------------------------------------------------
#[derive(Deserialize)]pub(super) struct AddNetworkLexiconBody { pub(super) nsid: String, pub(super) target_collection: Option<String>,}
#[derive(Serialize)]pub(super) struct NetworkLexiconSummary { pub(super) nsid: String, pub(super) authority_did: String, pub(super) target_collection: Option<String>, pub(super) last_fetched_at: Option<String>, pub(super) created_at: String,}
// ---------------------------------------------------------------------------// User management types// ---------------------------------------------------------------------------
#[derive(Deserialize)]pub(super) struct CreateUserBody { pub(super) did: String, pub(super) template: Option<super::permissions::Template>, pub(super) permissions: Option<Vec<String>>,}
#[derive(Serialize)]pub(super) struct UserSummary { pub(super) id: String, pub(super) did: String, pub(super) is_super: bool, pub(super) permissions: Vec<String>, pub(super) created_at: String, pub(super) last_used_at: Option<String>,}
// ---------------------------------------------------------------------------// API key types// ---------------------------------------------------------------------------
#[derive(Deserialize)]pub(super) struct CreateApiKeyBody { pub(super) name: String, pub(super) permissions: Vec<String>,}
#[derive(Serialize)]pub(super) struct ApiKeySummary { pub(super) id: String, pub(super) name: String, pub(super) key_prefix: String, pub(super) permissions: Vec<String>, pub(super) created_at: String, pub(super) last_used_at: Option<String>, pub(super) revoked_at: Option<String>,}
#[derive(Serialize)]pub(super) struct CreateApiKeyResponse { pub(super) id: String, pub(super) name: String, pub(super) key: String, pub(super) key_prefix: String, pub(super) permissions: Vec<String>,}
// ---------------------------------------------------------------------------// Script variable types// ---------------------------------------------------------------------------
#[derive(Serialize)]pub(super) struct ScriptVariableSummary { pub(super) key: String, pub(super) preview: String, pub(super) created_at: String, pub(super) updated_at: String,}
#[derive(Deserialize)]pub(super) struct UpsertScriptVariableBody { pub(super) key: String, pub(super) value: String,}
// ---------------------------------------------------------------------------// Labeler subscription types// ---------------------------------------------------------------------------
#[derive(Deserialize)]pub(super) struct AddLabelerBody { pub(super) did: String,}
#[derive(Serialize)]pub(super) struct LabelerSummary { pub(super) did: String, pub(super) status: String, pub(super) cursor: Option<i64>, pub(super) created_at: String, pub(super) updated_at: String,}
#[derive(Deserialize)]pub(super) struct UpdateLabelerBody { pub(super) status: String,}
// ---------------------------------------------------------------------------// Settings types// ---------------------------------------------------------------------------
#[derive(Serialize)]pub(super) struct SettingEntry { pub(super) key: String, pub(super) value: String, pub(super) source: String,}
#[derive(Deserialize)]pub(super) struct UpsertSettingBody { pub(super) value: String,}
// ---------------------------------------------------------------------------// User permission / transfer types// ---------------------------------------------------------------------------
#[derive(Deserialize)]pub(super) struct UpdatePermissionsBody { #[serde(default)] pub(super) grant: Vec<String>, #[serde(default)] pub(super) revoke: Vec<String>,}
#[derive(Deserialize)]pub(super) struct TransferSuperBody { pub(super) target_user_id: String,}
// ---------------------------------------------------------------------------// Plugin types// ---------------------------------------------------------------------------
#[derive(Serialize)]pub(super) struct PluginsListResponse { pub(super) plugins: Vec<PluginSummary>, pub(super) encryption_configured: bool,}
#[derive(Serialize)]pub(super) struct PluginSummary { pub(super) id: String, pub(super) name: String, pub(super) version: String, pub(super) source: String, pub(super) url: Option<String>, pub(super) sha256: Option<String>, pub(super) enabled: bool, pub(super) auth_type: String, pub(super) required_secrets: Vec<SecretDefinition>, /// Whether all required secrets have been configured pub(super) secrets_configured: bool, pub(super) loaded_at: Option<String>, #[serde(default)] pub(super) update_available: bool, #[serde(skip_serializing_if = "Option::is_none")] pub(super) latest_version: Option<String>, #[serde(default)] pub(super) pending_releases: Vec<crate::plugin::official_registry::ReleaseEntry>,}
#[derive(Serialize)]pub(super) struct OfficialPluginSummary { pub(super) id: String, pub(super) name: String, pub(super) description: Option<String>, pub(super) icon_url: Option<String>, pub(super) latest_version: String, pub(super) manifest_url: String,}
#[derive(Serialize)]pub(super) struct OfficialPluginsListResponse { pub(super) plugins: Vec<OfficialPluginSummary>, pub(super) last_refreshed_at: Option<String>,}
#[derive(Deserialize, Default)]pub(super) struct ReloadPluginBody { #[serde(default)] pub(super) url: Option<String>,}
#[derive(Deserialize)]pub(super) struct AddPluginBody { pub(super) url: String, pub(super) sha256: Option<String>,}
#[derive(Deserialize)]pub(super) struct PreviewPluginBody { pub(super) url: String,}
#[derive(Serialize)]pub(super) struct SecretDefinition { pub(super) key: String, pub(super) name: String, #[serde(skip_serializing_if = "Option::is_none")] pub(super) description: Option<String>,}
#[derive(Serialize)]pub(super) struct PluginPreviewResponse { pub(super) id: String, pub(super) name: String, pub(super) version: String, pub(super) description: Option<String>, pub(super) icon_url: Option<String>, pub(super) auth_type: String, pub(super) required_secrets: Vec<SecretDefinition>, pub(super) manifest_url: String, pub(super) wasm_url: String,}
#[derive(Serialize)]pub(super) struct PluginSecretsResponse { pub(super) plugin_id: String, pub(super) secrets: std::collections::HashMap<String, String>,}
#[derive(Deserialize)]pub(super) struct UpdatePluginSecretsBody { pub(super) secrets: std::collections::HashMap<String, String>,}
// ---------------------------------------------------------------------------// Domain types// ---------------------------------------------------------------------------
#[derive(Serialize)]pub(super) struct DomainResponse { pub(super) id: String, pub(super) url: String, pub(super) is_primary: bool, pub(super) created_at: String, pub(super) updated_at: String,}
#[derive(Deserialize)]pub(super) struct CreateDomainBody { pub(super) url: String,}
// ---------------------------------------------------------------------------// API client types// ---------------------------------------------------------------------------
#[derive(Deserialize)]pub(super) struct CreateApiClientBody { pub(super) name: String, pub(super) client_id_url: String, pub(super) client_uri: String, pub(super) redirect_uris: Vec<String>, #[serde(default = "default_scopes")] pub(super) scopes: String, pub(super) rate_limit_capacity: Option<i32>, pub(super) rate_limit_refill_rate: Option<f64>, #[serde(default = "default_client_type")] pub(super) client_type: String, pub(super) allowed_origins: Option<Vec<String>>,}
fn default_scopes() -> String { "atproto".to_string()}
fn default_client_type() -> String { "confidential".to_string()}
#[derive(Deserialize)]pub(super) struct UpdateApiClientBody { pub(super) name: Option<String>, pub(super) client_uri: Option<String>, pub(super) redirect_uris: Option<Vec<String>>, pub(super) scopes: Option<String>, pub(super) allowed_origins: Option<Option<Vec<String>>>, pub(super) rate_limit_capacity: Option<Option<i32>>, pub(super) rate_limit_refill_rate: Option<Option<f64>>, pub(super) is_active: Option<bool>,}
#[derive(Serialize)]pub(super) struct ApiClientSummary { pub(super) id: String, pub(super) client_key: String, pub(super) name: String, pub(super) client_id_url: String, pub(super) client_uri: String, pub(super) redirect_uris: Vec<String>, pub(super) scopes: String, pub(super) client_type: String, pub(super) allowed_origins: Option<Vec<String>>, pub(super) rate_limit_capacity: Option<i32>, pub(super) rate_limit_refill_rate: Option<f64>, pub(super) is_active: bool, pub(super) created_by: String, pub(super) created_at: String, pub(super) updated_at: String, pub(super) parent_client_id: Option<String>, pub(super) owner_did: Option<String>,}
#[derive(Serialize)]pub(crate) struct CreateApiClientResponse { pub(crate) id: String, pub(crate) client_key: String, #[serde(skip_serializing_if = "Option::is_none")] pub(crate) client_secret: Option<String>, pub(crate) name: String, pub(crate) client_id_url: String, pub(crate) client_type: String,}