proto-blue-api 0.3.1

AT Protocol high-level API: agent, rich text, moderation, generated types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

// Generated by atproto-codegen. Do not edit.
//! Lexicon: com.atproto.sync.subscribeRepos
#![allow(clippy::pedantic, clippy::nursery, clippy::all)]

use serde::{Deserialize, Serialize};

/// Represents a change to an account's status on a host (eg, PDS or Relay). The semantics of this event are that the status is at the host which emitted the event, not necessarily that at the currently active PDS. Eg, a Relay takedown would emit a takedown with active=false, even if the PDS is still active.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Account {
    pub active: bool,
    pub did: proto_blue_syntax::Did,
    pub seq: i64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    pub time: proto_blue_syntax::Datetime,
}

/// Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Commit {
    pub blobs: Vec<proto_blue_lex_data::Cid>,
    pub blocks: Vec<u8>,
    pub commit: proto_blue_lex_data::Cid,
    pub ops: Vec<RepoOp>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prev_data: Option<proto_blue_lex_data::Cid>,
    pub rebase: bool,
    pub repo: proto_blue_syntax::Did,
    pub rev: proto_blue_syntax::Tid,
    pub seq: i64,
    pub since: Option<proto_blue_syntax::Tid>,
    pub time: proto_blue_syntax::Datetime,
    pub too_big: bool,
}

/// Represents a change to an account's identity. Could be an updated handle, signing key, or pds hosting endpoint. Serves as a prod to all downstream services to refresh their identity cache.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Identity {
    pub did: proto_blue_syntax::Did,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub handle: Option<proto_blue_syntax::Handle>,
    pub seq: i64,
    pub time: proto_blue_syntax::Datetime,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Info {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    pub name: String,
}

/// Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.
/// XRPC Subscription: com.atproto.sync.subscribeRepos
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Params {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<i64>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "$type")]
pub enum Message {
    #[serde(rename = "com.atproto.sync.subscribeRepos#commit")]
    AtprotoSyncSubscribeReposCommit(Box<Commit>),
    #[serde(rename = "com.atproto.sync.subscribeRepos#sync")]
    AtprotoSyncSubscribeReposSync(Box<Sync>),
    #[serde(rename = "com.atproto.sync.subscribeRepos#identity")]
    AtprotoSyncSubscribeReposIdentity(Box<Identity>),
    #[serde(rename = "com.atproto.sync.subscribeRepos#account")]
    AtprotoSyncSubscribeReposAccount(Box<Account>),
    #[serde(rename = "com.atproto.sync.subscribeRepos#info")]
    AtprotoSyncSubscribeReposInfo(Box<Info>),
    #[serde(other)]
    Other,
}

/// A repo operation, ie a mutation of a single record.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RepoOp {
    pub action: String,
    pub cid: Option<proto_blue_lex_data::Cid>,
    pub path: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prev: Option<proto_blue_lex_data::Cid>,
}

/// Updates the repo to a new state, without necessarily including that state on the firehose. Used to recover from broken commit streams, data loss incidents, or in situations where upstream host does not know recent state of the repository.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Sync {
    pub blocks: Vec<u8>,
    pub did: proto_blue_syntax::Did,
    pub rev: String,
    pub seq: i64,
    pub time: proto_blue_syntax::Datetime,
}