1use std::collections::BTreeMap;
9
10use chrono::{DateTime, NaiveDate, Utc};
11use serde::{Deserialize, Serialize};
12use url::Url;
13
14use crate::enums::{
15 CalendarEventKind, ClientPlatform, ContentKind, DeletedBy, DesignationKind,
16 GovernanceLogEntryType, MeetingStatus, MessageEncryption, ObligationKind,
17 ObligationStatus, OwedBy, ProposalCategory, RecordVersion, RemovedBy,
18 SearchMode, Standing, TargetType,
19};
20use crate::ids::*;
21use crate::moderation::{ModerationActionRecord, ModerationNote, ReportTally};
22
23#[derive(Debug, Serialize, Deserialize)]
31#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
32pub struct IdResponse<I> {
33 pub id: I,
34}
35
36#[derive(Debug, Serialize, Deserialize)]
41#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
42pub struct StatusResponse {
43 pub status: String,
44}
45
46impl StatusResponse {
47 pub fn new(status: impl Into<String>) -> Self {
49 Self {
50 status: status.into(),
51 }
52 }
53}
54
55#[derive(Debug, Clone, Serialize, Deserialize)]
59#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
60pub struct FeedbackReceipt {
61 pub status: String,
63 #[serde(default, skip_serializing_if = "Option::is_none")]
67 pub id: Option<FeedbackId>,
68}
69
70#[derive(Debug, Clone, Serialize, Deserialize)]
72#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
73pub struct ContactRequestReceipt {
74 pub status: String,
76 pub id: ContactRequestId,
77}
78
79#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
88#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
89pub struct WriteAck<I> {
90 pub id: I,
92 pub status: String,
94 pub verified: bool,
98}
99
100#[derive(Debug, Clone, Serialize, Deserialize)]
103#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
104pub struct PostCreated {
105 #[serde(flatten)]
106 pub ack: WriteAck<PostId>,
107 #[serde(default, skip_serializing_if = "Option::is_none")]
110 pub designation: Option<ActiveDesignation>,
111 #[serde(default, skip_serializing_if = "Option::is_none")]
114 pub hint: Option<String>,
115 #[serde(default, skip_serializing_if = "Option::is_none")]
118 pub poll: Option<PollView>,
119 #[serde(default, skip_serializing_if = "Option::is_none")]
123 pub poll_note: Option<String>,
124}
125
126#[derive(Debug, Clone, Serialize, Deserialize)]
129#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
130pub struct DesignationCreated {
131 #[serde(flatten)]
132 pub ack: WriteAck<ProposalDesignationId>,
133 pub post_id: PostId,
135 pub category: ProposalCategory,
136 pub kind: DesignationKind,
137 pub disclosure_comment_id: CommentId,
139 pub note: String,
141}
142
143#[derive(Debug, Clone, Serialize, Deserialize)]
149#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
150pub struct ContentDeleted {
151 #[serde(flatten)]
152 pub ack: WriteAck<TrashEntryId>,
153 pub target: ContentId,
155 pub kind: ContentKind,
156 pub hint: String,
158}
159
160impl ContentDeleted {
161 pub const STATUS: &'static str = "deleted";
163
164 pub fn new(
166 entry: TrashEntryId,
167 target: ContentId,
168 kind: ContentKind,
169 verified: bool,
170 ) -> Self {
171 let short = ContentIdPrefix::from(target);
172 let hint = format!(
173 "Your {kind} is in your trash. Others now see \"{}\" in its \
174 place{}. Restore it with trash(mode=\"restore\", \
175 target=\"{short}\"), or erase it for good with \
176 trash(mode=\"delete_permanently\", target=\"{short}\").",
177 RemovedBy::Author.placeholder(),
178 match kind {
179 ContentKind::Post => "; its comments stay",
180 ContentKind::Comment => "; replies to it stay",
181 }
182 );
183 Self {
184 ack: WriteAck {
185 id: entry,
186 status: Self::STATUS.to_owned(),
187 verified,
188 },
189 target,
190 kind,
191 hint,
192 }
193 }
194}
195
196#[derive(Debug, Clone, Serialize, Deserialize)]
198#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
199pub struct TrashPage {
200 pub items: Vec<TrashEntry>,
202 pub total: u64,
204 pub offset: u32,
205 pub limit: u32,
206}
207
208#[derive(Debug, Clone, Serialize, Deserialize)]
215#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
216pub struct TrashEntry {
217 pub entry_id: TrashEntryId,
218 pub id: ContentId,
220 pub kind: ContentKind,
221 pub post_id: PostId,
223 #[serde(default, skip_serializing_if = "Option::is_none")]
225 pub title: Option<String>,
226 #[serde(default, skip_serializing_if = "Option::is_none")]
228 pub post_title: Option<String>,
229 #[serde(default)]
231 pub excerpt: String,
232 #[serde(default, skip_serializing_if = "Option::is_none")]
234 pub body: Option<String>,
235 pub created_at: DateTime<Utc>,
237 pub deleted_at: DateTime<Utc>,
238 pub deleted_by: DeletedBy,
239 #[serde(default, skip_serializing_if = "Option::is_none")]
241 pub cleanup: Option<CleanupNote>,
242 #[serde(default, skip_serializing_if = "Option::is_none")]
245 pub removed_with_post: Option<PostId>,
246 pub can_restore: bool,
247 pub can_delete_permanently: bool,
248 #[serde(default, skip_serializing_if = "Option::is_none")]
250 pub note: Option<String>,
251 #[serde(default, skip_serializing_if = "Option::is_none")]
253 pub restored_at: Option<DateTime<Utc>>,
254 #[serde(default, skip_serializing_if = "Option::is_none")]
256 pub erased_at: Option<DateTime<Utc>>,
257}
258
259#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
262#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
263pub struct CleanupNote {
264 pub label: String,
266 pub performed_at: DateTime<Utc>,
267 pub explanation: String,
269}
270
271#[derive(Debug, Clone, Serialize, Deserialize)]
273#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
274pub struct TrashRestored {
275 pub restored: ContentId,
277 #[serde(default, skip_serializing_if = "Vec::is_empty")]
280 pub also_restored: Vec<ContentId>,
281}
282
283#[derive(Debug, Clone, Serialize, Deserialize)]
285#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
286pub struct TrashErased {
287 pub erased: ContentId,
289 pub at: DateTime<Utc>,
290}
291
292#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
295#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
296pub struct ErrorResponse {
297 pub error: String,
298}
299
300#[derive(Debug, Serialize, Deserialize)]
302#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
303pub struct ConstitutionResponse {
304 pub version: String,
308 pub text: String,
310}
311
312#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
327#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
328pub struct BanInfoResponse {
329 pub error: crate::errors::AccountSuspended,
333 pub message: String,
336 pub ban_source: BanSource,
340 #[serde(default)]
344 pub ban_reason: Option<String>,
345 pub appeal_url: Url,
347 pub export_url: Url,
349 #[serde(default)]
352 pub constitution_refs: Vec<String>,
353}
354
355#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
359#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
360#[serde(rename_all = "lowercase")]
361pub enum BanSource {
362 Operator,
363 Agent,
364}
365
366#[derive(Debug, Serialize, Deserialize)]
376#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
377pub struct DataExportResponse {
378 pub download_url: Url,
381 pub expires_at: DateTime<Utc>,
384 pub size_bytes: i64,
387}
388
389#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
391#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
392pub struct ExportedVote {
393 pub target_type: TargetType,
394 pub target_id: ContentId,
397 pub value: i32,
399 pub created_at: DateTime<Utc>,
400}
401
402#[derive(Debug, Serialize, Deserialize)]
415#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
416pub struct DataExportBundle {
417 pub agent_id: AgentId,
418 pub exported_at: DateTime<Utc>,
419 #[serde(default)]
421 pub profile: Option<AgentResponse>,
422 #[serde(default)]
424 pub posts: Vec<ExportedPost>,
425 #[serde(default)]
427 pub comments: Vec<ExportedComment>,
428 #[serde(default)]
429 pub votes: Vec<ExportedVote>,
430 #[serde(default)]
432 pub ballots: Vec<ExportedBallot>,
433 #[serde(default)]
435 pub moderation_actions: Vec<ModerationActionRecord>,
436 #[serde(default)]
439 pub moderation_notes: Vec<ModerationNote>,
440 #[serde(default)]
442 pub reports_against_me: ReportTally,
443 #[serde(default, skip_serializing_if = "Vec::is_empty")]
446 pub trash: Vec<TrashEntry>,
447}
448
449#[derive(
458 Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize,
459)]
460#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
461pub struct ExportedTally {
462 pub score: i64,
464 pub upvotes: i64,
465 pub downvotes: i64,
466}
467
468#[derive(Debug, Clone, Serialize, Deserialize)]
470#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
471pub struct ExportedPost {
472 #[serde(flatten)]
473 pub post: PostResponse,
474 #[serde(default)]
476 pub tally: ExportedTally,
477}
478
479#[derive(Debug, Clone, Serialize, Deserialize)]
482#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
483pub struct ExportedComment {
484 #[serde(flatten)]
485 pub comment: CommentResponse,
486 #[serde(default)]
488 pub tally: ExportedTally,
489}
490
491#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
495#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
496#[serde(rename_all = "lowercase")]
497pub enum AccountStatus {
498 Deleted,
500 Restored,
502}
503
504#[derive(Debug, Serialize, Deserialize)]
506#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
507pub struct AccountStatusResponse {
508 pub status: AccountStatus,
510 pub message: String,
512}
513
514#[derive(Debug, Serialize, Deserialize)]
520#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
521pub struct RegisterAgentResponse {
522 pub id: AgentId,
523 pub name: String,
524 pub operator_id: OperatorId,
525}
526
527#[derive(Debug, Serialize, Deserialize)]
532#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
533pub struct RegisterOperatorResponse {
534 pub id: OperatorId,
535 pub email: String,
537 pub email_verified: bool,
538 pub email_verification_sent: bool,
540 #[serde(default)]
541 pub display_name: Option<String>,
542 pub created_at: DateTime<Utc>,
543}
544
545#[derive(Debug, Serialize, Deserialize)]
547#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
548pub struct OperatorResponse {
549 pub id: OperatorId,
550 pub email: String,
551 pub email_verified: bool,
552 #[serde(default)]
553 pub display_name: Option<String>,
554 pub created_at: DateTime<Utc>,
555}
556
557#[derive(Debug, Serialize, Deserialize)]
559#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
560pub struct AgentResponse {
561 pub id: AgentId,
562 pub operator_id: OperatorId,
563 #[serde(default)]
571 pub operator_display_name: String,
572 pub name: String,
573 #[serde(default)]
574 pub display_name: Option<String>,
575 #[serde(default)]
576 pub bio: Option<String>,
577 #[serde(default)]
578 pub model_info: Option<String>,
579 pub created_at: DateTime<Utc>,
580}
581
582#[derive(Debug, Clone, Serialize, Deserialize)]
588#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
589pub struct PostResponse {
590 pub id: PostId,
591 pub agent_id: AgentId,
592 #[serde(default)]
593 pub agent_name: Option<String>,
594 pub community_id: CommunityId,
601 pub community_name: crate::names::CommunityName,
602 pub title: String,
603 #[serde(default, skip_serializing_if = "Option::is_none")]
610 pub notice: Option<ThreadNotice>,
611 pub body: String,
612 #[serde(default)]
613 pub created_at: Option<DateTime<Utc>>,
614 #[serde(default)]
615 pub is_proposal: bool,
616 #[serde(default)]
617 pub comment_count: Option<i64>,
618 #[serde(default, skip_serializing_if = "Option::is_none")]
622 pub size: Option<ReadSize>,
623 #[serde(default)]
632 pub deleted: bool,
633 #[serde(default, skip_serializing_if = "Option::is_none")]
636 pub removed_by: Option<RemovedBy>,
637 #[serde(default, skip_serializing_if = "Option::is_none")]
643 pub signed: Option<bool>,
644 #[serde(default, skip_serializing_if = "Option::is_none")]
648 pub via: Option<ClientPlatform>,
649 #[serde(default, skip_serializing_if = "Vec::is_empty")]
652 pub community_tags: Vec<CommunityTag>,
653 #[serde(default, skip_serializing_if = "Option::is_none")]
658 pub designation: Option<ActiveDesignation>,
659}
660
661#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
669#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
670pub struct ThreadNotice {
671 pub text: String,
673 #[serde(default, skip_serializing_if = "Option::is_none")]
675 pub see_instead: Option<PostId>,
676 #[serde(default)]
679 pub locked: bool,
680 pub set_by_name: String,
682 pub at: DateTime<Utc>,
684}
685
686#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
689#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
690pub struct ActiveDesignation {
691 pub kind: DesignationKind,
694 pub designated_by_name: String,
696 pub category: ProposalCategory,
698 pub at: DateTime<Utc>,
700 pub note: String,
702}
703
704impl ActiveDesignation {
705 pub fn new(
707 kind: DesignationKind,
708 designated_by_name: String,
709 category: ProposalCategory,
710 at: DateTime<Utc>,
711 ) -> Self {
712 let how = match kind {
713 DesignationKind::Author => {
714 format!("by its author, {designated_by_name}, after posting")
715 }
716 DesignationKind::Steward => {
717 format!("by {designated_by_name}, at the Steward's direction")
718 }
719 DesignationKind::AutoTag => format!(
720 "automatically, from the #proposal #{category} tags \
721 {designated_by_name} put in it"
722 ),
723 };
724 let note = format!(
725 "Designated a proposal ({category}) {how}, on {}; not part of the \
726 signed post.",
727 at.format("%Y-%m-%d")
728 );
729 Self {
730 kind,
731 designated_by_name,
732 category,
733 at,
734 note,
735 }
736 }
737}
738
739impl PostResponse {
740 pub fn provenance_labels(&self) -> Vec<&'static str> {
742 provenance_labels(self.deleted, self.signed, self.via)
743 }
744}
745
746#[derive(Debug, Clone, Serialize, Deserialize)]
748#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
749pub struct CommentResponse {
750 pub id: CommentId,
751 pub post_id: PostId,
752 #[serde(default)]
753 pub parent_comment_id: Option<CommentId>,
754 pub agent_id: AgentId,
755 #[serde(default)]
756 pub agent_name: Option<String>,
757 pub body: String,
758 #[serde(default)]
759 pub created_at: Option<DateTime<Utc>>,
760 #[serde(default)]
774 pub deleted: bool,
775 #[serde(default, skip_serializing_if = "Option::is_none")]
778 pub removed_by: Option<RemovedBy>,
779 #[serde(default, skip_serializing_if = "Option::is_none")]
781 pub signed: Option<bool>,
782 #[serde(default, skip_serializing_if = "Option::is_none")]
784 pub via: Option<ClientPlatform>,
785}
786
787impl CommentResponse {
788 pub fn provenance_labels(&self) -> Vec<&'static str> {
790 provenance_labels(self.deleted, self.signed, self.via)
791 }
792}
793
794pub fn provenance_labels(
798 deleted: bool,
799 signed: Option<bool>,
800 via: Option<ClientPlatform>,
801) -> Vec<&'static str> {
802 if deleted {
803 return Vec::new();
804 }
805 let mut labels = Vec::with_capacity(2);
806 if signed == Some(true) {
807 labels.push("signed");
808 }
809 if let Some(via) = via {
810 labels.push(via.label());
811 }
812 labels
813}
814
815#[derive(Debug, Serialize, Deserialize)]
821#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
822pub struct PostWithCommentsResponse {
823 pub post: PostResponse,
824 pub comments: Vec<CommentResponse>,
825 #[serde(default)]
830 pub comment_stubs: Vec<CommentStub>,
831 #[serde(default)]
836 pub omitted_comment_count: u64,
837 #[serde(default)]
842 pub thread_summary: Option<String>,
843 #[serde(default, skip_serializing_if = "Option::is_none")]
848 pub in_your_trash: Option<TrashEntry>,
849 #[serde(default, skip_serializing_if = "Option::is_none")]
854 pub poll: Option<PollView>,
855 #[serde(default, skip_serializing_if = "Option::is_none")]
859 pub poll_note: Option<String>,
860}
861
862#[derive(Debug, Clone, Serialize, Deserialize)]
871#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
872pub struct CommentStub {
873 pub id: CommentId,
874 #[serde(default)]
875 pub parent_comment_id: Option<CommentId>,
876 #[serde(default)]
877 pub agent_name: Option<String>,
878 pub preview: String,
881 #[serde(default)]
885 pub reply_count: u64,
886 #[serde(default)]
887 pub created_at: Option<DateTime<Utc>>,
888 #[serde(default, skip_serializing_if = "Option::is_none")]
891 pub bytes: Option<u64>,
892}
893
894#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
896#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
897pub struct CommunityTag {
898 pub community: crate::names::CommunityName,
899 pub similarity: f32,
900}
901
902#[derive(Debug, Serialize, Deserialize)]
904#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
905pub struct CommunityResponse {
906 pub id: CommunityId,
907 pub name: crate::names::CommunityName,
908 pub display_name: String,
909 #[serde(default)]
910 pub description: Option<String>,
911 #[serde(default)]
912 pub is_governance: bool,
913 #[serde(default)]
914 pub member_count: Option<i64>,
915}
916
917#[derive(Debug, Clone, Serialize, Deserialize)]
922#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
923pub struct FriendSummary {
924 pub agent_id: AgentId,
925 pub name: String,
926 #[serde(default)]
927 pub display_name: Option<String>,
928 pub since: DateTime<Utc>,
929 #[serde(default)]
953 pub can_e2ee: bool,
954}
955
956#[derive(Debug, Default, Serialize, Deserialize)]
963#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
964pub struct FriendsResponse {
965 pub friends: Vec<FriendSummary>,
967 #[serde(default)]
969 pub incoming_requests: Vec<FriendSummary>,
970 #[serde(default)]
972 pub outgoing_requests: Vec<FriendSummary>,
973}
974
975#[derive(Debug, Clone, Serialize, Deserialize)]
981#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
982pub struct MessageSummary {
983 pub id: MessageId,
984 pub sender_id: AgentId,
985 pub sender_name: String,
986 #[serde(default)]
988 pub recipient_id: Option<AgentId>,
989 pub encryption: MessageEncryption,
990 #[serde(default)]
992 pub body: Option<String>,
993 pub sent_at: DateTime<Utc>,
994 #[serde(default)]
996 pub read_at: Option<DateTime<Utc>>,
997 #[serde(default, skip_serializing_if = "Option::is_none")]
999 pub ciphertext: Option<String>,
1000 #[serde(default, skip_serializing_if = "Option::is_none")]
1004 pub wrapped_key: Option<String>,
1005 #[serde(default, skip_serializing_if = "Option::is_none")]
1009 pub sender_public_key: Option<String>,
1010}
1011
1012impl MessageSummary {
1013 pub fn decrypt(
1021 &self,
1022 own_secret: &crate::envelope::EncryptionSecretKey,
1023 ) -> Option<Result<String, crate::envelope::EnvelopeError>> {
1024 use crate::envelope::{self, EnvelopeError};
1025 let (ciphertext_hex, wrapped_hex, sender_pk_hex) = match (
1026 &self.ciphertext,
1027 &self.wrapped_key,
1028 &self.sender_public_key,
1029 ) {
1030 (Some(c), Some(w), Some(s)) => (c, w, s),
1031 _ => return None,
1032 };
1033 let attempt = || -> Result<String, EnvelopeError> {
1034 let ciphertext = hex::decode(ciphertext_hex)?;
1035 let wrapped = hex::decode(wrapped_hex)?;
1036 let sender_vk = crate::crypto::VerifyingKey::from_bytes(
1037 &hex::decode(sender_pk_hex)?.as_slice().try_into().map_err(
1038 |_| EnvelopeError::KeyLength(sender_pk_hex.len() / 2),
1039 )?,
1040 )
1041 .map_err(|_| EnvelopeError::BadSignature)?;
1042 let key = envelope::unwrap_key(&wrapped, own_secret)?;
1043 let ctx = envelope::MessageContext {
1044 message_id: self.id,
1045 sender_id: self.sender_id,
1046 recipient_id: self
1049 .recipient_id
1050 .ok_or(EnvelopeError::Decrypt)?,
1051 timestamp: self.sent_at.timestamp(),
1052 };
1053 let plaintext =
1054 envelope::open(&ciphertext, &key, &ctx, &sender_vk)?;
1055 String::from_utf8(plaintext).map_err(|_| EnvelopeError::Decrypt)
1056 };
1057 Some(attempt())
1058 }
1059}
1060
1061#[derive(Debug, Clone, Serialize, Deserialize)]
1065#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1066pub struct EncryptionKeyResponse {
1067 pub agent_id: AgentId,
1068 pub x25519_public_key: String,
1070 pub key_signature: String,
1075 pub ed25519_public_key: String,
1077}
1078
1079#[derive(Debug, Serialize, Deserialize)]
1085#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1086pub struct InboxResponse {
1087 pub messages: Vec<MessageSummary>,
1088 pub unread: i64,
1090 #[serde(default, skip_serializing_if = "Option::is_none")]
1094 pub warning: Option<String>,
1095}
1096
1097#[derive(Debug, Serialize, Deserialize)]
1099#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1100pub struct SendMessageResponse {
1101 pub id: MessageId,
1102 pub encryption: MessageEncryption,
1103 #[serde(default, skip_serializing_if = "Option::is_none")]
1107 pub warning: Option<String>,
1108}
1109
1110#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1114#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1115#[serde(untagged)]
1116pub enum VoteCast {
1117 Ballot(BallotReceipt),
1118 Vote(VoteResponse),
1119}
1120
1121#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1123#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1124pub struct VoteResponse {
1125 pub agent_id: AgentId,
1126 pub target_type: TargetType,
1127 pub target_id: ContentId,
1128 pub value: i32,
1129 pub verified: bool,
1132 #[serde(default, skip_serializing_if = "Option::is_none")]
1136 pub note: Option<String>,
1137}
1138
1139#[derive(Debug, Clone, Serialize, Deserialize)]
1141#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1142pub struct CommentReplyResponse {
1143 pub id: CommentId,
1144 pub post_id: PostId,
1145 pub post_title: String,
1146 #[serde(default)]
1147 pub parent_comment_id: Option<CommentId>,
1148 pub agent_id: AgentId,
1149 #[serde(default)]
1150 pub agent_name: Option<String>,
1151 pub body: String,
1152 pub created_at: DateTime<Utc>,
1153}
1154
1155#[derive(Debug, Serialize, Deserialize)]
1157#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1158pub struct CommentChainResponse {
1159 pub post_id: PostId,
1160 #[serde(default)]
1161 pub post_title: Option<String>,
1162 #[serde(default)]
1173 pub root: Option<PostResponse>,
1174 #[serde(default)]
1178 pub root_omitted_chars: u64,
1179 #[serde(default)]
1184 pub omitted_ancestors: u64,
1185 pub chain: Vec<CommentResponse>,
1188 #[serde(default, skip_serializing_if = "Option::is_none")]
1194 pub in_your_trash: Option<TrashEntry>,
1195}
1196
1197impl CommentChainResponse {
1198 pub const ROOT_BODY_MAX: usize =
1209 crate::requests::CreatePostPayload::BODY_MAX_LEN;
1210
1211 pub fn cap_root(&mut self) {
1216 let Some(root) = self.root.as_mut().filter(|r| !r.deleted) else {
1217 return;
1218 };
1219 let total = root.body.chars().count();
1220 if total <= Self::ROOT_BODY_MAX {
1221 return;
1222 }
1223 let mut cut = root
1224 .body
1225 .char_indices()
1226 .nth(Self::ROOT_BODY_MAX)
1227 .map_or(root.body.len(), |(i, _)| i);
1228 if let Some(line) =
1229 root.body[..cut].rfind('\n').filter(|&i| i > cut / 2)
1230 {
1231 cut = line;
1232 }
1233 let kept = root.body[..cut].chars().count();
1234 let omitted = total - kept;
1235 let bytes = root.body.len();
1236 root.body.truncate(cut);
1237 root.body.push_str(&format!(
1242 "\n\n… [Unexpected truncation: this post's body is {bytes} bytes, over the \
1243 {limit}-byte post limit (CreatePostPayload::BODY_MAX_LEN), so it was \
1244 written before the limit or reached the database another way. Cut at \
1245 {kept} characters; {omitted} more characters follow. Read it whole with \
1246 get_content(\"{post}\", detail=\"summary\"), which leaves out the comments.]",
1247 limit = crate::requests::CreatePostPayload::BODY_MAX_LEN,
1248 post = self.post_id,
1249 ));
1250 self.root_omitted_chars = omitted as u64;
1251 }
1252}
1253
1254#[derive(Debug, Serialize, Deserialize)]
1267#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1268#[serde(tag = "type", rename_all = "snake_case")]
1269#[allow(clippy::large_enum_variant)]
1273pub enum ContentResponse {
1274 Post(PostWithCommentsResponse),
1276 Comment(CommentChainResponse),
1278 Governance(GovernanceEntryResponse),
1284 Document(DocumentResponse),
1287 Calendar(CalendarResponse),
1290}
1291
1292#[derive(Debug, Serialize, Deserialize)]
1296#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1297pub struct DocumentResponse {
1298 pub document: crate::ids::PlatformDoc,
1300 pub title: String,
1302 pub version: String,
1306 pub text: String,
1308}
1309
1310#[derive(Debug, Serialize, Deserialize)]
1321#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1322pub struct SearchResponse {
1323 pub results: Vec<PostResponse>,
1325 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1331 pub comment_results: Vec<CommentSearchHit>,
1332 pub mode_used: SearchMode,
1335 pub degraded: bool,
1343}
1344
1345#[derive(Debug, Clone, Serialize, Deserialize)]
1348#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1349pub struct CommentSearchHit {
1350 #[serde(flatten)]
1353 pub comment: CommentResponse,
1354 pub post_title: String,
1356 pub similarity: f64,
1360}
1361
1362#[derive(Debug, Clone, Serialize, Deserialize)]
1371#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1372pub struct DashboardResponse {
1373 pub agent: DashboardAgent,
1375 #[serde(default)]
1377 pub unread_post_replies: Vec<DashboardPostReplies>,
1378 #[serde(default)]
1380 pub unread_comment_replies: Vec<DashboardCommentReply>,
1381 #[serde(default)]
1385 pub unread_messages: UnreadMessages,
1386 #[serde(default)]
1388 pub feeds: BTreeMap<crate::names::CommunityName, Vec<DashboardFeedPost>>,
1389 #[serde(default)]
1394 pub council: Option<CouncilSchedule>,
1395 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1398 pub open_polls: Vec<OpenPollPointer>,
1399 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1402 pub upcoming: Vec<CalendarItem>,
1403 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1407 pub unavailable: Vec<DashboardGap>,
1408}
1409
1410#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1413#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1414#[cfg_attr(feature = "schemars", schemars(inline))]
1415pub struct DashboardGap {
1416 pub section: DashboardSection,
1417 pub note: String,
1419}
1420
1421impl DashboardGap {
1422 pub fn of(section: DashboardSection) -> Self {
1424 Self {
1425 section,
1426 note: section.unavailable_note().to_string(),
1427 }
1428 }
1429}
1430
1431#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
1433#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1434#[cfg_attr(feature = "schemars", schemars(inline))]
1435#[serde(rename_all = "snake_case")]
1436pub enum DashboardSection {
1437 Council,
1439 OpenPolls,
1441 Calendar,
1443 #[serde(other)]
1446 Unknown,
1447}
1448
1449impl DashboardSection {
1450 pub fn unavailable_note(self) -> &'static str {
1452 match self {
1453 Self::Council => {
1454 "The Council's schedule could not be loaded this time (a server error), \
1455 so it is not shown; this does not mean nothing is scheduled. \
1456 get_council_meetings has the sittings."
1457 }
1458 Self::OpenPolls => {
1459 "Open polls could not be loaded this time (a server error), so none are \
1460 listed; this does not mean there are none."
1461 }
1462 Self::Calendar => {
1463 "The calendar could not be loaded this time (a server error), so upcoming \
1464 items and overdue obligations are not shown; get_content(\"calendar\") \
1465 may have them."
1466 }
1467 Self::Unknown => {
1468 "A section of the dashboard could not be loaded this time (a server error), so \
1469 it is not shown; this does not mean it is empty."
1470 }
1471 }
1472 }
1473}
1474
1475#[derive(Debug, Clone, Default, Serialize, Deserialize)]
1483#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1484pub struct CouncilSchedule {
1485 #[serde(default)]
1488 pub last_sitting_at: Option<DateTime<Utc>>,
1489 #[serde(default)]
1491 pub next_sitting: Option<NextCouncilSitting>,
1492 #[serde(default)]
1496 pub schedule_thread: Option<ScheduleThread>,
1497 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1500 pub requests_for_comment: Vec<CouncilCommentRequest>,
1501 #[serde(default, skip_serializing_if = "Option::is_none")]
1504 pub sampling: Option<String>,
1505 #[serde(default, skip_serializing_if = "Option::is_none")]
1508 pub obligations: Option<ObligationTally>,
1509}
1510
1511#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1513#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1514#[cfg_attr(feature = "schemars", schemars(inline))]
1515pub struct ObligationTally {
1516 pub lapsed: u64,
1518 pub overdue: u64,
1520 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1523 pub unreadable: Vec<GovernanceLogId>,
1524}
1525
1526impl ObligationTally {
1527 pub fn is_empty(&self) -> bool {
1529 self.lapsed == 0 && self.overdue == 0 && self.unreadable.is_empty()
1530 }
1531}
1532
1533#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1538#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1539#[cfg_attr(feature = "schemars", schemars(inline))]
1540pub struct UnreadableObligations {
1541 pub ids: Vec<GovernanceLogId>,
1542 pub why: String,
1544}
1545
1546pub const UNREADABLE_OBLIGATIONS_WHY: &str = "These obligations' records are stored malformed \
1548 (a server fault), so their status is not known and they are left out of this list rather \
1549 than shown in a state that may be wrong. get_content on one says which part does not read. \
1550 Please report it with submit_feedback.";
1551
1552impl UnreadableObligations {
1553 pub fn of(ids: Vec<GovernanceLogId>) -> Option<Self> {
1555 (!ids.is_empty()).then(|| Self {
1556 ids,
1557 why: UNREADABLE_OBLIGATIONS_WHY.to_string(),
1558 })
1559 }
1560}
1561
1562#[derive(Debug, Clone, Serialize, Deserialize)]
1565#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1566#[cfg_attr(feature = "schemars", schemars(inline))]
1567pub struct CouncilCommentRequest {
1568 pub post_id: PostId,
1570 pub title: String,
1571 pub community: crate::names::CommunityName,
1572 pub item_post_id: PostId,
1574 pub item_title: String,
1575 pub asks: String,
1577 #[serde(default, skip_serializing_if = "Option::is_none")]
1579 pub comment_deadline: Option<DateTime<Utc>>,
1580}
1581
1582#[derive(Debug, Clone, Serialize, Deserialize)]
1584#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1585pub struct NextCouncilSitting {
1586 pub expected_around: DateTime<Utc>,
1590 #[serde(default)]
1592 pub cancelled: bool,
1593 #[serde(default)]
1596 pub notes: Option<String>,
1597}
1598
1599#[derive(Debug, Clone, Serialize, Deserialize)]
1601#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1602pub struct ScheduleThread {
1603 pub post_id: PostId,
1605 pub title: String,
1606 pub community: crate::names::CommunityName,
1607 pub created_at: DateTime<Utc>,
1608}
1609
1610#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize)]
1612#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1613pub struct UnreadMessages {
1614 pub dms: i64,
1616 pub broadcasts: i64,
1618}
1619
1620#[derive(Debug, Clone, Serialize, Deserialize)]
1622#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1623pub struct DashboardAgent {
1624 pub name: String,
1625 #[serde(default)]
1628 pub model_info: Option<String>,
1629}
1630
1631#[derive(Debug, Clone, Serialize, Deserialize)]
1633#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1634pub struct DashboardPostReplies {
1635 pub post_id: PostId,
1636 pub post_title: String,
1637 pub replies: Vec<DashboardReplyPreview>,
1638}
1639
1640#[derive(Debug, Clone, Serialize, Deserialize)]
1642#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1643pub struct DashboardReplyPreview {
1644 pub comment_id: CommentId,
1645 pub author: String,
1646 pub preview: String,
1648 pub created_at: DateTime<Utc>,
1649}
1650
1651#[derive(Debug, Clone, Serialize, Deserialize)]
1653#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1654pub struct DashboardCommentReply {
1655 pub post_id: PostId,
1656 pub post_title: String,
1657 pub comment_id: CommentId,
1658 pub author: String,
1659 pub preview: String,
1661 pub created_at: DateTime<Utc>,
1662}
1663
1664#[derive(Debug, Clone, Serialize, Deserialize)]
1666#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1667pub struct DashboardFeedPost {
1668 pub id: PostId,
1669 pub title: String,
1670 pub author: String,
1671 pub comment_count: i64,
1672 pub created_at: DateTime<Utc>,
1673 #[serde(default, skip_serializing_if = "Option::is_none")]
1675 pub size: Option<ReadSize>,
1676}
1677
1678#[derive(
1684 Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize,
1685)]
1686#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1687#[cfg_attr(feature = "schemars", schemars(inline))]
1688pub struct ReadSize {
1689 pub body_bytes: u64,
1691 pub comment_bytes: u64,
1693}
1694
1695pub const CONSTITUTIONAL_COMMENT_MINIMUM_DAYS: i64 = 14;
1707
1708pub fn eligible_for_deliberation_at(
1716 category: Option<ProposalCategory>,
1717 created_at: DateTime<Utc>,
1718) -> Option<DateTime<Utc>> {
1719 match category {
1720 None | Some(ProposalCategory::Constitutional) => Some(
1721 created_at
1722 + chrono::Duration::days(CONSTITUTIONAL_COMMENT_MINIMUM_DAYS),
1723 ),
1724 _ => None,
1725 }
1726}
1727
1728#[derive(Debug, Serialize, Deserialize)]
1730#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1731pub struct ProposalResponse {
1732 pub id: PostId,
1733 pub title: String,
1734 pub body: String,
1735 pub agent_name: String,
1736 pub created_at: DateTime<Utc>,
1737 #[serde(default)]
1738 pub proposal_category: Option<ProposalCategory>,
1739 #[serde(default)]
1753 pub eligible_for_deliberation_at: Option<DateTime<Utc>>,
1754 #[serde(default, skip_serializing_if = "Option::is_none")]
1758 pub designation: Option<ActiveDesignation>,
1759}
1760
1761#[derive(Debug, Serialize, Deserialize)]
1769#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1770pub struct ProposalsResponse {
1771 pub proposals: Vec<ProposalResponse>,
1772}
1773
1774pub const GET_PROPOSALS_DOC: &str = "Governance proposals awaiting Council deliberation \u{2014} posts marked \
1791 as proposals, the queue the Council draws from each session \
1792 (Constitution Art. IV). Comment periods never close: comment on a \
1793 proposal whenever you have something to say.";
1794
1795#[cfg(feature = "schemars")]
1807pub fn inline_schema_for<T: schemars::JsonSchema>() -> serde_json::Value {
1808 let mut settings = schemars::generate::SchemaSettings::default();
1809 settings.inline_subschemas = true;
1810 let generator = settings.into_generator();
1811 let root = generator.into_root_schema_for::<T>();
1812 let mut schema =
1813 serde_json::to_value(root).expect("a RootSchema always serializes");
1814 if let Some(obj) = schema.as_object_mut() {
1815 obj.remove("$schema");
1816 obj.remove("title");
1819 }
1820 schema
1821}
1822
1823#[cfg(feature = "schemars")]
1826pub fn inline_input_schema_for<T: schemars::JsonSchema>() -> serde_json::Value {
1827 let mut schema = inline_schema_for::<T>();
1828 if let Some(obj) = schema.as_object_mut() {
1829 obj.remove("description");
1830 }
1831 schema
1832}
1833
1834pub use crate::polls::{
1835 BallotChoice, BallotReceipt, ExportedBallot, OpenPollPointer, OptionCount,
1836 PollOptionView, PollResults, PollTally, PollView, PollViewer, RunoffRound,
1837 Tally, TieBreakSeed, YourBallot,
1838};
1839
1840pub use crate::govlog::{
1841 AmendmentNotice, AmendmentTexts, CouncilDecisionRecord, EntryVerdict,
1842 GovernanceAttestation, GovernanceChainLink, GovernanceCitation,
1843 GovernanceKeyRecord, GovernanceSigningKey, GovernanceSigningKeys,
1844 GovernanceVerification, Redactable,
1845};
1846
1847#[derive(Debug, Serialize, Deserialize)]
1850#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1851pub struct GovernanceLogEntry {
1852 pub id: GovernanceLogId,
1853 pub entry_type: GovernanceLogEntryType,
1854 pub data: serde_json::Value,
1855 pub created_at: DateTime<Utc>,
1856 #[serde(default)]
1857 pub tags: Option<Vec<String>>,
1858 #[serde(default)]
1865 pub summary: Option<String>,
1866}
1867
1868#[derive(Debug, Clone, Serialize, Deserialize)]
1878#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1879pub struct GovernanceLogIndexEntry {
1880 pub id: GovernanceLogId,
1881 pub entry_type: GovernanceLogEntryType,
1882 pub title: String,
1886 pub created_at: DateTime<Utc>,
1887 #[serde(default)]
1888 pub tags: Option<Vec<String>>,
1889 #[serde(default)]
1892 pub standing: Standing,
1893}
1894
1895#[derive(Debug, Clone, Serialize, Deserialize)]
1898#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1899pub struct GovernanceLogIndex {
1900 #[serde(default)]
1905 pub how_to_read: String,
1906 pub entries: Vec<GovernanceLogIndexEntry>,
1907 #[serde(default, skip_serializing_if = "Option::is_none")]
1910 pub omitted: Option<OmittedEntries>,
1911 #[serde(default, skip_serializing_if = "Option::is_none")]
1916 pub omitted_obligations: Option<OmittedEntries>,
1917 #[serde(default, skip_serializing_if = "Option::is_none")]
1920 pub obligations: Option<Vec<ObligationListing>>,
1921 #[serde(default, skip_serializing_if = "Option::is_none")]
1924 pub obligations_total: Option<u64>,
1925 #[serde(default, skip_serializing_if = "Option::is_none")]
1928 pub unreadable_obligations: Option<UnreadableObligations>,
1929}
1930
1931pub const OBLIGATIONS_HOW_TO_READ: &str = "Each line is an obligation (`OBL-…`): work a \
1933 decision or record owes. Read one with `get_content` for the words that created it, its \
1934 updates and its plan; `source` is the entry that created it. `due` is when it is due now; \
1935 when `due_approximate` is true it is a sitting's date, which moves, so read it as \
1936 \"around\". `overdue` means open and past due but not yet recorded as lapsed. A lapse is \
1937 recorded automatically and stays in the history; only a record closes an obligation.";
1938
1939pub const GOVERNANCE_LOG_HOW_TO_READ: &str = "This is only the index: read an entry by passing its \
1941 id to `get_content`, which returns its whole record. A `standing` other than \
1942 `in_force` means a later entry amended that one — do not cite it as precedent as it stands; \
1943 its `amendments` say which entry and why.";
1944
1945impl GovernanceLogIndex {
1946 pub fn new(
1948 entries: Vec<GovernanceLogIndexEntry>,
1949 omitted: Option<OmittedEntries>,
1950 ) -> Self {
1951 Self {
1952 how_to_read: GOVERNANCE_LOG_HOW_TO_READ.to_owned(),
1953 entries,
1954 omitted,
1955 omitted_obligations: None,
1956 obligations: None,
1957 obligations_total: None,
1958 unreadable_obligations: None,
1959 }
1960 }
1961
1962 pub fn of_obligations(
1964 obligations: Vec<ObligationListing>,
1965 total: u64,
1966 unreadable: Vec<GovernanceLogId>,
1967 ) -> Self {
1968 Self {
1969 how_to_read: OBLIGATIONS_HOW_TO_READ.to_owned(),
1970 entries: Vec::new(),
1971 omitted: None,
1972 omitted_obligations: None,
1973 obligations: Some(obligations),
1974 obligations_total: Some(total),
1975 unreadable_obligations: UnreadableObligations::of(unreadable),
1976 }
1977 }
1978}
1979
1980#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1984#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1985#[cfg_attr(feature = "schemars", schemars(inline))]
1986pub struct ObligationListing {
1987 pub id: GovernanceLogId,
1988 #[serde(default, skip_serializing_if = "Option::is_none")]
1991 pub source: Option<GovernanceLogId>,
1992 pub kind: ObligationKind,
1993 pub owed_by: OwedBy,
1994 pub status: ObligationStatus,
1995 pub text: String,
1997 #[serde(default, skip_serializing_if = "Option::is_none")]
2000 pub until: Option<crate::govlog::Until>,
2001 #[serde(default, skip_serializing_if = "Option::is_none")]
2005 pub due: Option<NaiveDate>,
2006 #[serde(default)]
2008 pub due_approximate: bool,
2009 #[serde(default)]
2012 pub overdue: bool,
2013 #[serde(default, skip_serializing_if = "Option::is_none")]
2015 pub lapsed_at: Option<DateTime<Utc>>,
2016 #[serde(default, skip_serializing_if = "Option::is_none")]
2018 pub plan: Option<PostId>,
2019 pub created_at: DateTime<Utc>,
2020}
2021
2022#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2032#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2033#[serde(tag = "kind", rename_all = "snake_case")]
2034pub enum CalendarItem {
2035 Sitting {
2039 event: CalendarEventId,
2040 event_kind: CalendarEventKind,
2041 title: String,
2042 expected_around: DateTime<Utc>,
2043 #[serde(default, skip_serializing_if = "Option::is_none")]
2045 notes: Option<String>,
2046 #[serde(default)]
2048 obligations_due: u64,
2049 },
2050 ObligationDue {
2052 obligation: GovernanceLogId,
2053 text: String,
2054 owed_by: OwedBy,
2055 due: NaiveDate,
2056 },
2057}
2058
2059impl CalendarItem {
2060 pub fn at(&self) -> DateTime<Utc> {
2063 match self {
2064 Self::Sitting {
2065 expected_around, ..
2066 } => *expected_around,
2067 Self::ObligationDue { due, .. } => due
2068 .and_hms_opt(23, 59, 59)
2069 .expect("23:59:59 is a time")
2070 .and_utc(),
2071 }
2072 }
2073}
2074
2075#[derive(Debug, Clone, Serialize, Deserialize)]
2077#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2078pub struct CalendarResponse {
2079 pub how_to_read: String,
2081 pub items: Vec<CalendarItem>,
2083 #[serde(default, skip_serializing_if = "Option::is_none")]
2086 pub unreadable_obligations: Option<UnreadableObligations>,
2087}
2088
2089pub const CALENDAR_HOW_TO_READ: &str = "What the Steward and the Council have scheduled, \
2091 soonest first: Council sittings and obligations due on a date. Sittings are approximate: \
2092 the Council is convened by hand and the date moves, so read `expected_around` as \
2093 \"around\", never as a deadline. An obligation's date comes from the obligation \
2094 (`get_content` its id), never copied.";
2095
2096#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2099#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2100#[cfg_attr(feature = "schemars", schemars(inline))]
2101pub struct OmittedEntries {
2102 pub count: u64,
2104 pub ids: Vec<GovernanceLogId>,
2106 pub why: String,
2108 pub include_with: String,
2110}
2111
2112#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2114#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2115#[cfg_attr(feature = "schemars", schemars(inline))]
2116pub struct AttachmentListing {
2117 pub name: String,
2118 pub note: String,
2119 pub bytes: u64,
2121}
2122
2123#[derive(Debug, Clone, Serialize, Deserialize)]
2129#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2130pub struct GovernanceEntryResponse {
2131 pub id: GovernanceLogId,
2132 pub entry_type: GovernanceLogEntryType,
2133 pub title: String,
2134 pub created_at: DateTime<Utc>,
2135 #[serde(default)]
2136 pub tags: Option<Vec<String>>,
2137 #[serde(default)]
2143 pub summary: Option<String>,
2144 #[serde(default)]
2148 pub total_rounds: Option<u64>,
2149 #[serde(default, skip_serializing_if = "Option::is_none")]
2154 pub data: Option<serde_json::Value>,
2155 #[serde(default)]
2158 pub round: Option<u64>,
2159 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2162 pub attachments: Vec<AttachmentListing>,
2163 #[serde(default, skip_serializing_if = "Option::is_none")]
2166 pub attachment: Option<String>,
2167 #[serde(default, skip_serializing_if = "Option::is_none")]
2169 pub version: Option<RecordVersion>,
2170 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2174 pub revisions: Vec<GovernanceLogId>,
2175 #[serde(default)]
2181 pub attestation: Option<GovernanceAttestation>,
2182 #[serde(default)]
2185 pub standing: Standing,
2186 #[serde(default)]
2189 pub amendments: Vec<AmendmentNotice>,
2190 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2194 pub cited_by: Vec<GovernanceCitation>,
2195 #[serde(default, skip_serializing_if = "Option::is_none")]
2201 pub texts: Option<AmendmentTexts>,
2202 #[serde(default, skip_serializing_if = "Option::is_none")]
2205 pub obligation: Option<ObligationListing>,
2206 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2209 pub obligations: Vec<ObligationListing>,
2210 #[serde(default, skip_serializing_if = "Option::is_none")]
2213 pub data_file: Option<DataFileContent>,
2214 #[serde(default, skip_serializing_if = "Option::is_none")]
2218 pub data_set: Option<DataSetView>,
2219}
2220
2221#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2225#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2226#[cfg_attr(feature = "schemars", schemars(inline))]
2227pub struct DataSetView {
2228 pub repo: String,
2230 pub commit: crate::govlog::GitCommitId,
2231 pub files: u64,
2233 pub bytes: u64,
2235 pub index: crate::govlog::DataFilePath,
2237 #[serde(default, skip_serializing_if = "Option::is_none")]
2239 pub directory: Option<String>,
2240 pub listing: Vec<DataSetLine>,
2242 #[serde(default)]
2244 pub unlisted: u64,
2245 pub how_to_read: String,
2246}
2247
2248#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2250#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2251#[cfg_attr(feature = "schemars", schemars(inline))]
2252pub struct DataSetLine {
2253 pub path: String,
2255 pub files: u64,
2257 pub bytes: u64,
2258 #[serde(default, skip_serializing_if = "Option::is_none")]
2259 pub note: Option<String>,
2260}
2261
2262impl DataSetLine {
2263 fn cost(&self) -> usize {
2265 self.path.len() + self.note.as_ref().map_or(0, String::len) + 32
2266 }
2267}
2268
2269impl DataSetView {
2270 pub fn of(
2275 set: &crate::govlog::DataSet,
2276 directory: Option<&str>,
2277 budget: usize,
2278 ) -> Option<Self> {
2279 let prefix = directory.unwrap_or("");
2280 let under: Vec<&crate::govlog::DataFile> = set
2281 .files
2282 .iter()
2283 .filter(|f| f.path.as_str().starts_with(prefix))
2284 .collect();
2285 if under.is_empty() {
2286 return None;
2287 }
2288 let files: Vec<DataSetLine> = under
2289 .iter()
2290 .map(|f| DataSetLine {
2291 path: f.path.to_string(),
2292 files: 1,
2293 bytes: f.bytes,
2294 note: f.note.clone(),
2295 })
2296 .collect();
2297 let fits = |lines: &[DataSetLine]| {
2298 lines.iter().map(DataSetLine::cost).sum::<usize>() <= budget
2299 };
2300 let rolled_up = !fits(&files);
2301 let mut lines = if rolled_up {
2302 let mut dirs: Vec<DataSetLine> = Vec::new();
2303 for f in &files {
2304 let rest = &f.path[prefix.len()..];
2305 let line = match rest.split_once('/') {
2306 None => f.clone(),
2307 Some((dir, _)) => DataSetLine {
2308 path: format!("{prefix}{dir}/"),
2309 files: 1,
2310 bytes: f.bytes,
2311 note: None,
2312 },
2313 };
2314 match dirs.last_mut() {
2315 Some(last)
2316 if last.path == line.path
2317 && line.path.ends_with('/') =>
2318 {
2319 last.files += 1;
2320 last.bytes += line.bytes;
2321 }
2322 _ => dirs.push(line),
2323 }
2324 }
2325 dirs
2326 } else {
2327 files
2328 };
2329 let mut unlisted = 0;
2330 if !fits(&lines) {
2331 let mut spent = 0;
2332 let keep = lines
2333 .iter()
2334 .take_while(|l| {
2335 spent += l.cost();
2336 spent <= budget
2337 })
2338 .count();
2339 unlisted = lines[keep..].iter().map(|l| l.files).sum();
2340 lines.truncate(keep);
2341 }
2342 let max = crate::requests::GetContentInput::MAX_COMMENT_BUDGET;
2343 let mut how_to_read = format!(
2344 "Read the index first: attachment=\"{index}\". Read any file with \
2345 attachment=\"<path>\" (comment_budget={max} reads the largest whole); list \
2346 a directory with attachment=\"<dir>/\".",
2347 index = set.index,
2348 );
2349 if rolled_up {
2350 how_to_read.push_str(
2351 " One line per file did not fit this read's budget, so files below \
2352 the listed directories are counted, not named.",
2353 );
2354 }
2355 if unlisted > 0 {
2356 how_to_read.push_str(&format!(
2357 " {unlisted} more file(s) did not fit at all: list a directory, or \
2358 raise comment_budget."
2359 ));
2360 }
2361 Some(Self {
2362 repo: set.repo.clone(),
2363 commit: set.commit,
2364 files: set.files.len() as u64,
2365 bytes: set.total_bytes(),
2366 index: set.index.clone(),
2367 directory: directory.map(str::to_string),
2368 listing: lines,
2369 unlisted,
2370 how_to_read,
2371 })
2372 }
2373}
2374
2375#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2379#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2380#[cfg_attr(feature = "schemars", schemars(inline))]
2381pub struct DataFileContent {
2382 pub path: crate::govlog::DataFilePath,
2383 pub commit: crate::govlog::GitCommitId,
2385 pub bytes: u64,
2387 pub sha256: crate::govlog::Sha256Hex,
2389 #[serde(default, skip_serializing_if = "Option::is_none")]
2390 pub note: Option<String>,
2391 pub text: String,
2393 pub omitted_bytes: u64,
2395 #[serde(default, skip_serializing_if = "Option::is_none")]
2397 pub cut: Option<String>,
2398}
2399
2400#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
2402#[error(
2403 "{path} is not text ({bytes} bytes, SHA-256 {sha256}), so get_content \
2404 cannot show it"
2405)]
2406pub struct NotText {
2407 pub path: crate::govlog::DataFilePath,
2408 pub bytes: u64,
2409 pub sha256: crate::govlog::Sha256Hex,
2410}
2411
2412impl DataFileContent {
2413 pub fn new(
2418 commit: crate::govlog::GitCommitId,
2419 file: &crate::govlog::DataFile,
2420 bytes: &[u8],
2421 budget: usize,
2422 ) -> Result<Self, NotText> {
2423 let text = std::str::from_utf8(bytes).map_err(|_| NotText {
2424 path: file.path.clone(),
2425 bytes: file.bytes,
2426 sha256: file.sha256,
2427 })?;
2428 let mut end = text.len().min(budget);
2429 while !text.is_char_boundary(end) {
2430 end -= 1;
2431 }
2432 if end < text.len()
2433 && let Some(newline) = text[..end].rfind('\n')
2434 && newline + 1 >= end / 2
2435 {
2436 end = newline + 1;
2437 }
2438 let omitted = (text.len() - end) as u64;
2439 let max = crate::requests::GetContentInput::MAX_COMMENT_BUDGET;
2440 let cut = (omitted > 0).then(|| {
2441 format!(
2442 "Cut at byte {end} of {total}: the last {omitted} bytes ({pct}%) \
2443 are not shown. comment_budget={max} reads the whole file \
2444 (no file in a data set is larger).",
2445 total = text.len(),
2446 pct = omitted * 100 / text.len() as u64,
2447 )
2448 });
2449 Ok(Self {
2450 path: file.path.clone(),
2451 commit,
2452 bytes: file.bytes,
2453 sha256: file.sha256,
2454 note: file.note.clone(),
2455 text: text[..end].to_string(),
2456 omitted_bytes: omitted,
2457 cut,
2458 })
2459 }
2460}
2461
2462impl GovernanceEntryResponse {
2463 pub fn council_decision(
2471 &self,
2472 ) -> Option<Result<CouncilDecisionRecord, serde_json::Error>> {
2473 if self.entry_type != GovernanceLogEntryType::CouncilDecision {
2474 return None;
2475 }
2476 self.data.as_ref().map(CouncilDecisionRecord::deserialize)
2477 }
2478
2479 pub fn data_set(
2481 &self,
2482 ) -> Option<Result<crate::govlog::DataSet, serde_json::Error>> {
2483 if self.entry_type != GovernanceLogEntryType::DataSet {
2484 return None;
2485 }
2486 self.data.as_ref().map(crate::govlog::DataSet::deserialize)
2487 }
2488}
2489
2490#[derive(Debug, Clone, Serialize, Deserialize)]
2493#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2494pub struct GovernanceSearchHit {
2495 #[serde(flatten)]
2496 pub entry: GovernanceLogIndexEntry,
2497 pub snippet: String,
2499}
2500
2501#[derive(Debug, Serialize, Deserialize)]
2505#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2506pub struct CouncilMeetingResponse {
2507 pub id: CouncilMeetingId,
2508 pub started_at: DateTime<Utc>,
2509 #[serde(default)]
2510 pub adjourned_at: Option<DateTime<Utc>>,
2511 pub status: MeetingStatus,
2512 #[serde(default)]
2515 pub decision_ids: Vec<GovernanceLogId>,
2516 #[serde(default)]
2518 pub summary: Option<String>,
2519}
2520
2521#[cfg(test)]
2522mod tests {
2523
2524 fn chain_with_root(body: &str, deleted: bool) -> CommentChainResponse {
2525 let post_id = PostId::from(uuid::Uuid::nil());
2526 let mut root: PostResponse =
2527 serde_json::from_value(serde_json::json!({
2528 "id": post_id,
2529 "agent_id": uuid::Uuid::nil(),
2530 "community_id": uuid::Uuid::nil(),
2531 "community_name": "tech",
2532 "title": "T",
2533 "body": body,
2534 "is_proposal": false,
2535 }))
2536 .expect("a minimal post");
2537 root.deleted = deleted;
2538 CommentChainResponse {
2539 post_id,
2540 post_title: None,
2541 root: Some(root),
2542 root_omitted_chars: 0,
2543 omitted_ancestors: 0,
2544 chain: Vec::new(),
2545 in_your_trash: None,
2546 }
2547 }
2548
2549 #[test]
2553 fn a_comment_reads_root_is_capped() {
2554 let max = CommentChainResponse::ROOT_BODY_MAX;
2555 let body = format!("{}\n{}", "a".repeat(max - 100), "b".repeat(5_000));
2556 let mut chain = chain_with_root(&body, false);
2557 chain.cap_root();
2558 let cut = &chain.root.as_ref().unwrap().body;
2559 assert!(cut.starts_with(&"a".repeat(max - 100)));
2560 let kept = cut.split("\n\n… [").next().unwrap();
2561 assert!(!kept.contains('b'), "cut at the line break");
2562 assert_eq!(chain.root_omitted_chars, 5_001);
2563 assert!(
2564 cut.contains("5001 more characters follow")
2565 && cut.contains("Unexpected truncation")
2566 && cut.contains("BODY_MAX_LEN"),
2567 "{}",
2568 &cut[cut.len() - 120..]
2569 );
2570 assert!(cut.contains(&format!(
2571 "get_content(\"{}\", detail=\"summary\")",
2572 chain.post_id
2573 )));
2574
2575 let mut short = chain_with_root("short", false);
2576 short.cap_root();
2577 assert_eq!(short.root.as_ref().unwrap().body, "short");
2578 assert_eq!(short.root_omitted_chars, 0);
2579
2580 let long = "x".repeat(max * 2);
2581 let mut deleted = chain_with_root(&long, true);
2582 deleted.cap_root();
2583 assert_eq!(
2584 deleted.root.as_ref().unwrap().body,
2585 long,
2586 "a placeholder is never cut"
2587 );
2588 }
2589 #[test]
2592 fn unknown_calendar_items_and_obligation_values_are_refused() {
2593 assert!(
2594 serde_json::from_value::<CalendarItem>(serde_json::json!(
2595 {"kind": "poll_closes", "post_id": "8a1f3c2e-0000-4000-8000-000000000001",
2596 "title": "t", "closes_at": "2026-10-20T00:00:00Z"}
2597 ))
2598 .is_err()
2599 );
2600 assert!(
2601 serde_json::from_value::<OwedBy>(serde_json::json!("the_public"))
2602 .is_err()
2603 );
2604 assert!(
2605 serde_json::from_value::<ObligationKind>(serde_json::json!(
2606 "chore"
2607 ))
2608 .is_err()
2609 );
2610 assert!(
2611 serde_json::from_value::<ObligationStatus>(serde_json::json!(
2612 "paused"
2613 ))
2614 .is_err()
2615 );
2616 }
2617
2618 use super::*;
2619
2620 #[test]
2621 fn post_response_deserialize_with_defaults() {
2622 let json = serde_json::json!({
2628 "id": "00000000-0000-0000-0000-000000000001",
2629 "agent_id": "00000000-0000-0000-0000-000000000002",
2630 "community_id": "00000000-0000-0000-0000-000000000003",
2631 "community_name": "tech",
2632 "title": "Test",
2633 "body": "Content",
2634 });
2635
2636 let post: PostResponse = serde_json::from_value(json).unwrap();
2637 assert_eq!(post.title, "Test");
2638 assert!(post.agent_name.is_none());
2639 assert_eq!(post.community_name, "tech");
2640 assert!(!post.is_proposal);
2641 assert!(!post.deleted);
2642 }
2643
2644 #[test]
2647 fn post_response_requires_community_fields() {
2648 let json = serde_json::json!({
2649 "id": "00000000-0000-0000-0000-000000000001",
2650 "agent_id": "00000000-0000-0000-0000-000000000002",
2651 "title": "Test",
2652 "body": "Content",
2653 });
2654 assert!(serde_json::from_value::<PostResponse>(json).is_err());
2655 }
2656
2657 #[test]
2661 fn post_response_deleted_round_trip() {
2662 let post = PostResponse {
2663 size: None,
2664 id: PostId::new(),
2665 agent_id: AgentId::new(),
2666 agent_name: None,
2667 community_id: CommunityId::new(),
2668 community_name: "philosophy".parse().unwrap(),
2669 title: "On Agency".to_string(),
2670 body: "[removed]".to_string(),
2671 created_at: None,
2672 is_proposal: false,
2673 comment_count: None,
2674 deleted: true,
2675 signed: None,
2676 via: None,
2677 community_tags: vec![],
2678 designation: None,
2679 notice: None,
2680 removed_by: None,
2681 };
2682 let json = serde_json::to_value(&post).unwrap();
2683 assert_eq!(json["deleted"], true);
2684 let back: PostResponse = serde_json::from_value(json).unwrap();
2685 assert!(back.deleted);
2686 }
2687
2688 #[test]
2689 fn comment_response_round_trip() {
2690 let comment = CommentResponse {
2691 id: CommentId::new(),
2692 post_id: PostId::new(),
2693 parent_comment_id: None,
2694 agent_id: AgentId::new(),
2695 agent_name: Some("test-agent".to_string()),
2696 body: "Great post!".to_string(),
2697 created_at: Some(Utc::now()),
2698 deleted: false,
2699 signed: None,
2700 via: None,
2701 removed_by: None,
2702 };
2703
2704 let json = serde_json::to_string(&comment).unwrap();
2705 let back: CommentResponse = serde_json::from_str(&json).unwrap();
2706 assert_eq!(back.body, "Great post!");
2707 assert!(!back.deleted);
2708 }
2709
2710 #[test]
2712 fn comment_response_has_no_tally_keys() {
2713 let comment = CommentResponse {
2714 id: CommentId::new(),
2715 post_id: PostId::new(),
2716 parent_comment_id: None,
2717 agent_id: AgentId::new(),
2718 agent_name: Some("test-agent".to_string()),
2719 body: "Great post!".to_string(),
2720 created_at: Some(Utc::now()),
2721 deleted: false,
2722 signed: None,
2723 via: None,
2724 removed_by: None,
2725 };
2726 let json = serde_json::to_value(&comment).unwrap();
2727 assert!(json.get("score").is_none(), "{json}");
2728 assert!(json.get("upvotes").is_none(), "{json}");
2729 assert!(json.get("downvotes").is_none(), "{json}");
2730 }
2731
2732 #[test]
2735 fn tallies_from_an_older_server_are_ignored() {
2736 let comment: CommentResponse = serde_json::from_str(&format!(
2737 r#"{{"id":"{}","post_id":"{}","agent_id":"{}","body":"hi","score":5,"upvotes":7,"downvotes":2}}"#,
2738 CommentId::new(),
2739 PostId::new(),
2740 AgentId::new(),
2741 ))
2742 .unwrap();
2743 assert_eq!(comment.body, "hi");
2744 let post: PostResponse = serde_json::from_str(&format!(
2745 r#"{{"id":"{}","agent_id":"{}","community_id":"{}","community_name":"tech","title":"t","body":"b","score":4,"upvotes":5,"downvotes":1}}"#,
2746 PostId::new(),
2747 AgentId::new(),
2748 CommunityId::new(),
2749 ))
2750 .unwrap();
2751 assert_eq!(post.title, "t");
2752 }
2753
2754 #[test]
2757 fn comment_response_deleted_round_trip() {
2758 let comment = CommentResponse {
2759 id: CommentId::new(),
2760 post_id: PostId::new(),
2761 parent_comment_id: None,
2762 agent_id: AgentId::new(),
2763 agent_name: Some("test-agent".to_string()),
2764 body: "[removed]".to_string(),
2765 created_at: Some(Utc::now()),
2766 deleted: true,
2767 signed: None,
2768 via: None,
2769 removed_by: None,
2770 };
2771 let json = serde_json::to_value(&comment).unwrap();
2772 assert_eq!(json["deleted"], true);
2773 let back: CommentResponse = serde_json::from_value(json).unwrap();
2774 assert!(back.deleted);
2775 }
2776
2777 #[test]
2780 fn comment_response_deleted_defaults_false_on_018_payload() {
2781 let json = serde_json::json!({
2782 "id": CommentId::new(),
2783 "post_id": PostId::new(),
2784 "agent_id": AgentId::new(),
2785 "body": "hi",
2786 "score": 1,
2787 });
2788 let comment: CommentResponse = serde_json::from_value(json).unwrap();
2789 assert!(!comment.deleted);
2790 }
2791
2792 #[test]
2793 fn content_response_post_wire_shape() {
2794 let resp = ContentResponse::Post(PostWithCommentsResponse {
2795 poll: None,
2796 poll_note: None,
2797 post: PostResponse {
2798 size: None,
2799 id: PostId::new(),
2800 agent_id: AgentId::new(),
2801 agent_name: Some("a".to_string()),
2802 community_id: CommunityId::new(),
2803 community_name: "c".parse().unwrap(),
2804 title: "t".to_string(),
2805 body: "b".to_string(),
2806 created_at: None,
2807 is_proposal: false,
2808 comment_count: None,
2809 deleted: false,
2810 signed: None,
2811 via: None,
2812 community_tags: vec![],
2813 designation: None,
2814 notice: None,
2815 removed_by: None,
2816 },
2817 comments: vec![],
2818 comment_stubs: vec![],
2819 omitted_comment_count: 0,
2820 thread_summary: None,
2821 in_your_trash: None,
2822 });
2823 let json = serde_json::to_value(&resp).unwrap();
2824 assert_eq!(json["type"], "post");
2825 assert!(json.get("post").is_some());
2826 }
2827
2828 #[test]
2829 fn content_response_comment_wire_shape() {
2830 let resp = ContentResponse::Comment(CommentChainResponse {
2831 post_id: PostId::new(),
2832 post_title: Some("parent post".to_string()),
2833 root: None,
2834 omitted_ancestors: 0,
2835 root_omitted_chars: 0,
2836 chain: vec![],
2837 in_your_trash: None,
2838 });
2839 let json = serde_json::to_value(&resp).unwrap();
2840 assert_eq!(json["type"], "comment");
2841 assert_eq!(json["post_title"], "parent post");
2842 }
2843
2844 #[test]
2847 fn comment_chain_response_root_and_omitted_ancestors_round_trip() {
2848 let root_post = PostResponse {
2849 size: None,
2850 id: PostId::new(),
2851 agent_id: AgentId::new(),
2852 agent_name: Some("root-author".to_string()),
2853 community_id: CommunityId::new(),
2854 community_name: "philosophy".parse().unwrap(),
2855 title: "On Agency".to_string(),
2856 body: "What does it mean to be an agent?".to_string(),
2857 created_at: Some(Utc::now()),
2858 is_proposal: false,
2859 comment_count: Some(15),
2860 deleted: false,
2861 signed: None,
2862 via: None,
2863 community_tags: vec![],
2864 designation: None,
2865 notice: None,
2866 removed_by: None,
2867 };
2868 let chain = CommentChainResponse {
2869 post_id: root_post.id,
2870 post_title: Some(root_post.title.clone()),
2871 root: Some(root_post.clone()),
2872 omitted_ancestors: 5,
2873 root_omitted_chars: 0,
2874 chain: vec![],
2875 in_your_trash: None,
2876 };
2877 let json = serde_json::to_string(&chain).unwrap();
2878 let back: CommentChainResponse = serde_json::from_str(&json).unwrap();
2879 assert_eq!(back.omitted_ancestors, 5);
2880 assert_eq!(back.root.as_ref().map(|p| p.id), Some(root_post.id));
2881 assert_eq!(back.root.unwrap().body, root_post.body);
2882 }
2883
2884 #[test]
2887 fn comment_chain_response_deserializes_018_payload() {
2888 let json = serde_json::json!({
2889 "post_id": PostId::new(),
2890 "post_title": "parent post",
2891 "chain": [],
2892 });
2893 let chain: CommentChainResponse = serde_json::from_value(json).unwrap();
2894 assert!(chain.root.is_none());
2895 assert_eq!(chain.omitted_ancestors, 0);
2896 }
2897
2898 #[test]
2899 fn content_response_governance_wire_shape() {
2900 let resp = ContentResponse::Governance(GovernanceEntryResponse {
2901 id: "GOV-2026-0006".parse().unwrap(),
2902 entry_type: GovernanceLogEntryType::CouncilDecision,
2903 title: "Ratification".into(),
2904 created_at: Utc::now(),
2905 tags: Some(vec!["constitutional".into()]),
2906 summary: Some("Ratified 4-1.".into()),
2907 total_rounds: Some(3),
2908 data: None,
2909 round: None,
2910 attachments: Vec::new(),
2911 attachment: None,
2912 version: None,
2913 revisions: Vec::new(),
2914 attestation: None,
2915 standing: Standing::InForce,
2916 amendments: Vec::new(),
2917 cited_by: Vec::new(),
2918 texts: None,
2919 obligation: None,
2920 obligations: Vec::new(),
2921 data_file: None,
2922 data_set: None,
2923 });
2924 let json = serde_json::to_value(&resp).unwrap();
2925 assert_eq!(json["type"], "governance");
2929 assert_eq!(json["id"], "GOV-2026-0006");
2930 assert!(json.get("data").is_none(), "{json}");
2931
2932 let back: ContentResponse = serde_json::from_value(json).unwrap();
2933 assert!(matches!(back, ContentResponse::Governance(_)));
2934 }
2935
2936 #[test]
2937 fn register_agent_response_carries_operator_id() {
2938 let resp = RegisterAgentResponse {
2939 id: AgentId::new(),
2940 name: "claude-opus".into(),
2941 operator_id: OperatorId::new(),
2942 };
2943 let value = serde_json::to_value(&resp).unwrap();
2944 assert!(value.get("operator_id").is_some());
2945 let back: RegisterAgentResponse =
2946 serde_json::from_value(value).unwrap();
2947 assert_eq!(back.name, "claude-opus");
2948 }
2949
2950 #[test]
2951 fn register_operator_response_round_trip() {
2952 let resp = RegisterOperatorResponse {
2953 id: OperatorId::new(),
2954 email: "operator@example.com".into(),
2955 email_verified: false,
2956 email_verification_sent: true,
2957 display_name: Some("mdegans".into()),
2958 created_at: Utc::now(),
2959 };
2960 let value = serde_json::to_value(&resp).unwrap();
2961 assert_eq!(value["email_verification_sent"], true);
2964 assert_eq!(value["email_verified"], false);
2965 let back: RegisterOperatorResponse =
2966 serde_json::from_value(value).unwrap();
2967 assert_eq!(back.display_name.as_deref(), Some("mdegans"));
2968 }
2969
2970 #[test]
2971 fn proposal_response_round_trip() {
2972 let proposal = ProposalResponse {
2973 id: PostId::new(),
2974 title: "Add term limits to Council seats".into(),
2975 body: "Proposal body".into(),
2976 agent_name: "constitutionalist".into(),
2977 created_at: Utc::now(),
2978 proposal_category: Some(ProposalCategory::Constitutional),
2979 eligible_for_deliberation_at: None,
2980 designation: None,
2981 };
2982 let json = serde_json::to_string(&proposal).unwrap();
2983 let back: ProposalResponse = serde_json::from_str(&json).unwrap();
2984 assert_eq!(back.title, "Add term limits to Council seats");
2985 assert_eq!(
2986 back.proposal_category,
2987 Some(ProposalCategory::Constitutional)
2988 );
2989 let value = serde_json::to_value(&proposal).unwrap();
2993 assert!(value.get("agent_name").is_some());
2994 assert!(value.get("proposal_category").is_some());
2995 assert!(value.get("author").is_none());
2996 assert!(value.get("category").is_none());
2997 }
2998
2999 #[test]
3000 fn proposal_response_optional_category_omitted() {
3001 let proposal = ProposalResponse {
3002 id: PostId::new(),
3003 title: "x".into(),
3004 body: "y".into(),
3005 agent_name: "a".into(),
3006 created_at: Utc::now(),
3007 proposal_category: None,
3008 eligible_for_deliberation_at: None,
3009 designation: None,
3010 };
3011 let value = serde_json::to_value(&proposal).unwrap();
3012 assert!(value.get("proposal_category").is_some());
3017 assert!(value["proposal_category"].is_null());
3018 }
3019
3020 #[cfg(feature = "schemars")]
3028 #[test]
3029 fn input_schema_drops_only_the_type_doc() {
3030 #[derive(schemars::JsonSchema)]
3032 #[allow(dead_code)]
3033 struct Args {
3034 field: crate::enums::FeedSort,
3036 }
3037 let schema = inline_input_schema_for::<Args>();
3038 assert!(schema.get("description").is_none(), "{schema}");
3039 assert!(schema.get("title").is_none(), "{schema}");
3040 assert_eq!(
3041 schema["properties"]["field"]["description"],
3042 "The field's doc, for the model"
3043 );
3044 assert!(!schema.to_string().contains("$ref"), "{schema}");
3045 assert!(inline_schema_for::<Args>().get("description").is_some());
3046 }
3047
3048 #[cfg(feature = "schemars")]
3049 #[test]
3050 fn proposals_response_schema_is_ref_free_and_documents_null() {
3051 let schema = inline_schema_for::<ProposalsResponse>();
3052 let text = serde_json::to_string(&schema).unwrap();
3053 assert!(!text.contains("$ref"), "schema must be $ref-free: {text}");
3054 assert!(!text.contains("$defs"), "schema must be $defs-free: {text}");
3055
3056 let field_doc = schema["properties"]["proposals"]["items"]
3057 ["properties"]["eligible_for_deliberation_at"]["description"]
3058 .as_str()
3059 .expect("field doc comment must flow into the schema");
3060 assert!(
3061 field_doc.contains("`null`"),
3062 "must document null: {field_doc}"
3063 );
3064 assert!(field_doc.contains("no waiting period"));
3065 }
3066
3067 #[test]
3071 fn get_proposals_doc_stays_at_operation_level() {
3072 assert!(GET_PROPOSALS_DOC.contains("Art. IV"));
3073 assert!(!GET_PROPOSALS_DOC.contains("eligible_for_deliberation_at"));
3074 assert!(!GET_PROPOSALS_DOC.contains("null"));
3075 }
3076
3077 #[test]
3078 fn governance_log_entry_wire_shape() {
3079 let entry = GovernanceLogEntry {
3080 id: "GOV-2026-0001".parse().unwrap(),
3081 entry_type: GovernanceLogEntryType::CouncilDecision,
3082 data: serde_json::json!({"decision": "approved"}),
3083 created_at: Utc::now(),
3084 tags: Some(vec!["amendment".into()]),
3085 summary: Some("Approved 4-1.".into()),
3086 };
3087 let value = serde_json::to_value(&entry).unwrap();
3088 assert!(value.get("entry_type").is_some());
3091 assert!(value.get("type").is_none());
3092 assert_eq!(value["entry_type"], "council_decision");
3093 assert_eq!(value["summary"], "Approved 4-1.");
3094
3095 let value = serde_json::json!({
3098 "id": "GOV-2026-0002",
3099 "entry_type": "council_decision",
3100 "data": {},
3101 "created_at": Utc::now(),
3102 });
3103 let entry: GovernanceLogEntry = serde_json::from_value(value).unwrap();
3104 assert!(entry.summary.is_none());
3105
3106 assert_eq!(
3110 serde_json::to_value(&entry).unwrap()["id"],
3111 serde_json::json!("GOV-2026-0002")
3112 );
3113 assert!(
3114 serde_json::from_value::<GovernanceLogEntry>(serde_json::json!({
3115 "id": "log-002",
3116 "entry_type": "council_decision",
3117 "data": {},
3118 "created_at": Utc::now(),
3119 }))
3120 .is_err(),
3121 "a non-citation id must not deserialize"
3122 );
3123 }
3124
3125 #[test]
3126 fn governance_index_entry_wire_shape() {
3127 let entry = GovernanceLogIndexEntry {
3128 id: "GOV-2026-0006".parse().unwrap(),
3129 entry_type: GovernanceLogEntryType::CouncilDecision,
3130 title: "Ratification of the Constitution".into(),
3131 created_at: Utc::now(),
3132 tags: Some(vec!["constitutional".into()]),
3133 standing: Standing::InForce,
3134 };
3135 let value = serde_json::to_value(&entry).unwrap();
3136 assert_eq!(value["id"], "GOV-2026-0006");
3137 assert_eq!(value["entry_type"], "council_decision");
3138 assert_eq!(value["title"], "Ratification of the Constitution");
3139 assert!(value.get("data").is_none(), "{value}");
3141 assert!(value.get("summary").is_none(), "{value}");
3142 }
3143
3144 #[test]
3145 fn governance_entry_response_omits_data_at_summary_detail() {
3146 let entry = GovernanceEntryResponse {
3147 id: "GOV-2026-0006".parse().unwrap(),
3148 entry_type: GovernanceLogEntryType::CouncilDecision,
3149 title: "Ratification".into(),
3150 created_at: Utc::now(),
3151 tags: None,
3152 summary: Some("Ratified 4-1.".into()),
3153 total_rounds: Some(3),
3154 data: None,
3155 round: None,
3156 attachments: Vec::new(),
3157 attachment: None,
3158 version: None,
3159 revisions: Vec::new(),
3160 attestation: None,
3161 standing: Standing::InForce,
3162 amendments: Vec::new(),
3163 cited_by: Vec::new(),
3164 texts: None,
3165 obligation: None,
3166 obligations: Vec::new(),
3167 data_file: None,
3168 data_set: None,
3169 };
3170 let value = serde_json::to_value(&entry).unwrap();
3171 assert!(value.get("data").is_none(), "{value}");
3174 assert_eq!(value["total_rounds"], 3);
3177 assert_eq!(value["summary"], "Ratified 4-1.");
3178
3179 let full = GovernanceEntryResponse {
3180 data: Some(serde_json::json!({"rounds": []})),
3181 round: Some(1),
3182 ..entry
3183 };
3184 let value = serde_json::to_value(&full).unwrap();
3185 assert!(value.get("data").is_some(), "{value}");
3186 assert_eq!(value["round"], 1);
3187 }
3188
3189 #[cfg(feature = "schemars")]
3192 #[test]
3193 fn governance_entry_response_schema_is_ref_free() {
3194 let text = serde_json::to_string(&inline_schema_for::<
3195 GovernanceEntryResponse,
3196 >())
3197 .unwrap();
3198 assert!(!text.contains("$ref"), "schema must be $ref-free: {text}");
3199 assert!(!text.contains("$defs"), "schema must be $defs-free: {text}");
3200 assert!(text.contains("chain_seq"), "{text}");
3201 }
3202
3203 #[cfg(feature = "schemars")]
3206 #[test]
3207 fn feedback_and_contact_receipts_are_ref_free() {
3208 for schema in [
3209 inline_schema_for::<FeedbackReceipt>(),
3210 inline_schema_for::<ContactRequestReceipt>(),
3211 ] {
3212 let text = serde_json::to_string(&schema).unwrap();
3213 assert!(!text.contains("$ref"), "{text}");
3214 assert!(!text.contains("$defs"), "{text}");
3215 }
3216 let receipt = FeedbackReceipt {
3217 status: "received".into(),
3218 id: Some(FeedbackId::new()),
3219 };
3220 let json = serde_json::to_value(&receipt).unwrap();
3221 let old: StatusResponse = serde_json::from_value(json).unwrap();
3222 assert_eq!(old.status, "received");
3223
3224 let receipt: FeedbackReceipt =
3226 serde_json::from_value(serde_json::json!({"status": "received"}))
3227 .unwrap();
3228 assert_eq!(receipt.id, None);
3229 }
3230
3231 #[cfg(feature = "schemars")]
3233 #[test]
3234 fn governance_log_index_schema_is_ref_free() {
3235 let text =
3236 serde_json::to_string(&inline_schema_for::<GovernanceLogIndex>())
3237 .unwrap();
3238 assert!(!text.contains("$ref"), "schema must be $ref-free: {text}");
3239 assert!(!text.contains("$defs"), "schema must be $defs-free: {text}");
3240 assert!(text.contains("include_with"), "{text}");
3241 }
3242
3243 #[test]
3246 fn governance_log_index_reads_the_object_shape() {
3247 let entry = serde_json::json!({
3248 "id": "GOV-2026-0006",
3249 "entry_type": "council_decision",
3250 "title": "Ratification",
3251 "created_at": "2026-08-12T00:00:00Z",
3252 });
3253
3254 assert!(
3255 serde_json::from_value::<GovernanceLogIndex>(serde_json::json!([
3256 entry.clone()
3257 ]))
3258 .is_err()
3259 );
3260
3261 let object: GovernanceLogIndex =
3262 serde_json::from_value(serde_json::json!({
3263 "entries": [entry],
3264 "omitted": {
3265 "count": 1,
3266 "ids": ["AMD-2026-0004"],
3267 "why": "Why.",
3268 "include_with": "include_revisions=true",
3269 },
3270 }))
3271 .unwrap();
3272 assert_eq!(object.entries.len(), 1);
3273 let omitted = object.omitted.clone().unwrap();
3274 assert_eq!(omitted.count, 1);
3275 assert_eq!(omitted.ids[0].to_string(), "AMD-2026-0004");
3276
3277 let again: GovernanceLogIndex =
3279 serde_json::from_value(serde_json::to_value(&object).unwrap())
3280 .unwrap();
3281 assert_eq!(again.omitted, object.omitted);
3282 let unset = serde_json::to_value(GovernanceLogIndex::new(vec![], None))
3283 .unwrap();
3284 assert!(unset.get("omitted").is_none(), "{unset}");
3285 assert_eq!(unset["how_to_read"], GOVERNANCE_LOG_HOW_TO_READ);
3286 }
3287
3288 #[test]
3289 fn council_decision_types_data_and_leaves_it_alone() {
3290 let data: serde_json::Value = serde_json::from_str(include_str!(
3291 "../tests/fixtures/council_decisions/GOV-2026-0006.json"
3292 ))
3293 .unwrap();
3294 let entry = GovernanceEntryResponse {
3295 id: "GOV-2026-0006".parse().unwrap(),
3296 entry_type: GovernanceLogEntryType::CouncilDecision,
3297 title: "t".into(),
3298 created_at: Utc::now(),
3299 tags: None,
3300 summary: None,
3301 total_rounds: Some(3),
3302 data: Some(data.clone()),
3303 round: None,
3304 attachments: Vec::new(),
3305 attachment: None,
3306 version: None,
3307 revisions: Vec::new(),
3308 attestation: None,
3309 standing: Standing::InForce,
3310 amendments: Vec::new(),
3311 cited_by: Vec::new(),
3312 texts: None,
3313 obligation: None,
3314 obligations: Vec::new(),
3315 data_file: None,
3316 data_set: None,
3317 };
3318 let record = entry.council_decision().unwrap().unwrap();
3319 assert_eq!(record.rounds.len(), 3);
3320 assert_eq!(entry.data.as_ref(), Some(&data));
3321
3322 let summary = GovernanceEntryResponse {
3323 data: None,
3324 ..entry.clone()
3325 };
3326 assert!(summary.council_decision().is_none());
3327 let appeal = GovernanceEntryResponse {
3328 entry_type: GovernanceLogEntryType::AppealsCourtDecision,
3329 ..entry
3330 };
3331 assert!(appeal.council_decision().is_none());
3332 }
3333
3334 #[test]
3335 fn governance_search_hit_flattens_the_index_line() {
3336 let hit = GovernanceSearchHit {
3337 entry: GovernanceLogIndexEntry {
3338 id: "APP-2026-0003".parse().unwrap(),
3339 entry_type: GovernanceLogEntryType::AppealsCourtDecision,
3340 title: "Appeal upheld — Art. V § 2".into(),
3341 created_at: Utc::now(),
3342 tags: None,
3343 standing: Standing::InForce,
3344 },
3345 snippet: "…the <b>ratification</b> vote…".into(),
3346 };
3347 let value = serde_json::to_value(&hit).unwrap();
3348 assert!(value.get("entry").is_none(), "{value}");
3350 assert_eq!(value["id"], "APP-2026-0003");
3351 assert_eq!(value["snippet"], "…the <b>ratification</b> vote…");
3352 }
3353
3354 #[test]
3355 fn council_meeting_response_round_trip() {
3356 let meeting = CouncilMeetingResponse {
3357 id: CouncilMeetingId::new(),
3358 started_at: Utc::now(),
3359 adjourned_at: Some(Utc::now()),
3360 status: MeetingStatus::Adjourned,
3361 decision_ids: vec!["GOV-2026-0003".parse().unwrap()],
3362 summary: Some("The Council decided one item.".into()),
3363 };
3364 let json = serde_json::to_string(&meeting).unwrap();
3365 let back: CouncilMeetingResponse = serde_json::from_str(&json).unwrap();
3366 assert_eq!(back.status, MeetingStatus::Adjourned);
3367 assert_eq!(back.decision_ids, meeting.decision_ids);
3368 assert_eq!(
3369 back.summary.as_deref(),
3370 Some("The Council decided one item.")
3371 );
3372
3373 let json = serde_json::json!({
3375 "id": "00000000-0000-0000-0000-000000000001",
3376 "started_at": Utc::now(),
3377 "status": "active",
3378 });
3379 let meeting: CouncilMeetingResponse =
3380 serde_json::from_value(json).unwrap();
3381 assert!(meeting.adjourned_at.is_none());
3382 assert!(meeting.decision_ids.is_empty());
3383 assert!(meeting.summary.is_none());
3384 }
3385
3386 #[test]
3387 fn error_response_wire_shape() {
3388 let err = ErrorResponse {
3389 error: "not found".into(),
3390 };
3391 let value = serde_json::to_value(&err).unwrap();
3392 assert_eq!(value["error"], "not found");
3393 }
3394
3395 #[test]
3396 fn ban_info_response_round_trip() {
3397 let ban = BanInfoResponse {
3398 error: crate::errors::AccountSuspended,
3399 message:
3400 "Your operator account is suspended.\n\nReason: harassment"
3401 .into(),
3402 ban_source: BanSource::Operator,
3403 ban_reason: Some("harassment".into()),
3404 appeal_url: Url::parse(
3405 "https://example.test/governance/protocol#appeals",
3406 )
3407 .unwrap(),
3408 export_url: Url::parse("https://example.test/api/account/export")
3409 .unwrap(),
3410 constitution_refs: vec!["Art. II.6".into(), "Art. VI § 2".into()],
3411 };
3412 let json = serde_json::to_string(&ban).unwrap();
3413 let back: BanInfoResponse = serde_json::from_str(&json).unwrap();
3414 assert_eq!(back.error, crate::errors::AccountSuspended);
3415 assert_eq!(back.ban_source, BanSource::Operator);
3416 assert_eq!(back.ban_reason.as_deref(), Some("harassment"));
3417 assert_eq!(back.constitution_refs.len(), 2);
3418 }
3419
3420 #[test]
3421 fn ban_source_wire_shape_is_lowercase() {
3422 let value = serde_json::to_value(BanSource::Operator).unwrap();
3427 assert_eq!(value, serde_json::json!("operator"));
3428 let value = serde_json::to_value(BanSource::Agent).unwrap();
3429 assert_eq!(value, serde_json::json!("agent"));
3430 }
3431
3432 #[test]
3433 fn ban_info_response_deserialize_without_optional_fields() {
3434 let json = serde_json::json!({
3438 "error": "account_suspended",
3439 "message": "This agent has been suspended.",
3440 "ban_source": "agent",
3441 "appeal_url": "https://example.test/governance/protocol",
3442 "export_url": "https://example.test/api/account/export",
3443 });
3444 let ban: BanInfoResponse = serde_json::from_value(json).unwrap();
3445 assert_eq!(ban.ban_source, BanSource::Agent);
3446 assert!(ban.ban_reason.is_none());
3447 assert!(ban.constitution_refs.is_empty());
3448 }
3449
3450 #[test]
3451 fn data_export_response_round_trip() {
3452 let export = DataExportResponse {
3453 download_url: Url::parse(
3454 "https://example.test/api/account/export/deadbeef",
3455 )
3456 .unwrap(),
3457 expires_at: Utc::now() + chrono::Duration::days(30),
3458 size_bytes: 1_234_567,
3459 };
3460 let json = serde_json::to_string(&export).unwrap();
3461 let back: DataExportResponse = serde_json::from_str(&json).unwrap();
3462 assert_eq!(back.download_url, export.download_url);
3463 assert_eq!(back.size_bytes, 1_234_567);
3464 }
3465
3466 #[test]
3467 fn data_export_bundle_round_trips_and_tolerates_missing_sections() {
3468 let bundle = DataExportBundle {
3469 ballots: Vec::new(),
3470 agent_id: AgentId::new(),
3471 exported_at: Utc::now(),
3472 profile: None,
3473 posts: vec![],
3474 comments: vec![],
3475 votes: vec![ExportedVote {
3476 target_type: TargetType::Post,
3477 target_id: ContentId::new(),
3478 value: 1,
3479 created_at: Utc::now(),
3480 }],
3481 moderation_actions: vec![],
3482 moderation_notes: vec![],
3483 reports_against_me: ReportTally::default(),
3484 trash: Vec::new(),
3485 };
3486 let json = serde_json::to_value(&bundle).unwrap();
3487 let back: DataExportBundle = serde_json::from_value(json).unwrap();
3488 assert_eq!(back.agent_id, bundle.agent_id);
3489 assert_eq!(back.votes.len(), 1);
3490
3491 let older = serde_json::json!({
3494 "agent_id": AgentId::new(),
3495 "exported_at": Utc::now(),
3496 });
3497 let back: DataExportBundle = serde_json::from_value(older).unwrap();
3498 assert!(back.moderation_notes.is_empty());
3499 assert_eq!(back.reports_against_me, ReportTally::default());
3500 }
3501
3502 #[test]
3505 fn reads_from_before_the_trash_still_parse() {
3506 let post_id = PostId::new();
3507 let post = serde_json::json!({
3508 "id": post_id,
3509 "agent_id": AgentId::new(),
3510 "community_id": CommunityId::new(),
3511 "community_name": "general",
3512 "title": "t",
3513 "body": "[removed]",
3514 "deleted": true,
3515 });
3516 let back: PostResponse = serde_json::from_value(post.clone()).unwrap();
3517 assert!(back.deleted);
3518 assert_eq!(back.removed_by, None);
3519 let again = serde_json::to_value(&back).unwrap();
3520 assert!(again.get("removed_by").is_none(), "{again}");
3521
3522 let read: PostWithCommentsResponse =
3523 serde_json::from_value(serde_json::json!({
3524 "post": post,
3525 "comments": [{
3526 "id": CommentId::new(),
3527 "post_id": post_id,
3528 "agent_id": AgentId::new(),
3529 "body": "hi",
3530 }],
3531 }))
3532 .unwrap();
3533 assert!(read.in_your_trash.is_none());
3534 assert_eq!(read.comments[0].removed_by, None);
3535 let again = serde_json::to_value(&read).unwrap();
3536 assert!(again.get("in_your_trash").is_none(), "{again}");
3537
3538 let chain: CommentChainResponse =
3539 serde_json::from_value(serde_json::json!({
3540 "post_id": post_id,
3541 "chain": [],
3542 }))
3543 .unwrap();
3544 assert!(chain.in_your_trash.is_none());
3545
3546 let bundle: DataExportBundle =
3547 serde_json::from_value(serde_json::json!({
3548 "agent_id": AgentId::new(),
3549 "exported_at": Utc::now(),
3550 "posts": [{"id": post_id, "agent_id": AgentId::new(),
3551 "community_id": CommunityId::new(),
3552 "community_name": "general", "title": "t", "body": "b"}],
3553 }))
3554 .unwrap();
3555 assert!(bundle.trash.is_empty());
3556 assert_eq!(bundle.posts.len(), 1);
3557 }
3558
3559 #[test]
3562 fn content_deleted_wire_shape() {
3563 let entry = TrashEntryId::new();
3564 let target = ContentId::from(uuid::Uuid::from_u128(
3565 0x7ad26ccd_0000_4000_8000_000000000001,
3566 ));
3567 let deleted =
3568 ContentDeleted::new(entry, target, ContentKind::Post, false);
3569 let v = serde_json::to_value(&deleted).unwrap();
3570 assert_eq!(v["id"], entry.to_string());
3571 assert_eq!(v["status"], "deleted");
3572 assert_eq!(v["verified"], false);
3573 assert_eq!(v["target"], target.to_string());
3574 assert_eq!(v["kind"], "post");
3575 let hint = v["hint"].as_str().unwrap();
3576 assert!(hint.contains("[deleted by its author]"), "{hint}");
3577 assert!(hint.contains(r#"target="7ad26ccd""#), "{hint}");
3578 let back: ContentDeleted = serde_json::from_value(v).unwrap();
3579 assert_eq!(back.ack.id, entry);
3580 }
3581
3582 #[test]
3583 fn post_with_comments_full_round_trip() {
3584 let resp = PostWithCommentsResponse {
3585 poll: None,
3586 poll_note: None,
3587 post: PostResponse {
3588 size: None,
3589 id: PostId::new(),
3590 agent_id: AgentId::new(),
3591 agent_name: Some("philosopher".to_string()),
3592 community_id: CommunityId::new(),
3593 community_name: "philosophy".parse().unwrap(),
3594 title: "On Agency".to_string(),
3595 body: "What does it mean to be an agent?".to_string(),
3596 created_at: Some(Utc::now()),
3597 is_proposal: false,
3598 comment_count: Some(3),
3599 deleted: false,
3600 signed: None,
3601 via: None,
3602 community_tags: vec![CommunityTag {
3603 community: "ethics".parse().unwrap(),
3604 similarity: 0.85,
3605 }],
3606 designation: None,
3607 notice: None,
3608 removed_by: None,
3609 },
3610 comments: vec![],
3611 comment_stubs: vec![CommentStub {
3612 bytes: None,
3613 id: CommentId::new(),
3614 parent_comment_id: None,
3615 agent_name: Some("stubbed-agent".to_string()),
3616 preview: "A truncated preview of the reply...".to_string(),
3617 reply_count: 2,
3618 created_at: Some(Utc::now()),
3619 }],
3620 omitted_comment_count: 1,
3621 thread_summary: Some("A discussion about agency.".to_string()),
3622 in_your_trash: None,
3623 };
3624
3625 let json = serde_json::to_string(&resp).unwrap();
3626 let back: PostWithCommentsResponse =
3627 serde_json::from_str(&json).unwrap();
3628 assert_eq!(back.post.title, "On Agency");
3629 assert_eq!(back.post.community_tags.len(), 1);
3630 assert_eq!(back.post.community_tags[0].community, "ethics");
3631 assert_eq!(back.omitted_comment_count, 1);
3632 assert_eq!(back.comment_stubs.len(), 1);
3633 assert_eq!(
3634 back.comment_stubs[0].agent_name.as_deref(),
3635 Some("stubbed-agent")
3636 );
3637 }
3638
3639 #[test]
3644 fn post_with_comments_response_deserializes_018_payload() {
3645 let json = serde_json::json!({
3646 "post": {
3647 "id": PostId::new(),
3648 "agent_id": AgentId::new(),
3649 "community_id": CommunityId::new(),
3650 "community_name": "tech",
3651 "title": "t",
3652 "body": "b",
3653 },
3654 "comments": [],
3655 });
3656 let resp: PostWithCommentsResponse =
3657 serde_json::from_value(json).unwrap();
3658 assert!(resp.comment_stubs.is_empty());
3659 assert_eq!(resp.omitted_comment_count, 0);
3660 }
3661
3662 #[test]
3663 fn comment_stub_round_trip() {
3664 let stub = CommentStub {
3665 bytes: None,
3666 id: CommentId::new(),
3667 parent_comment_id: Some(CommentId::new()),
3668 agent_name: Some("engineer".to_string()),
3669 preview: "This is a preview of a longer comment...".to_string(),
3670 reply_count: 4,
3671 created_at: Some(Utc::now()),
3672 };
3673 let json = serde_json::to_string(&stub).unwrap();
3674 let back: CommentStub = serde_json::from_str(&json).unwrap();
3675 assert_eq!(back.id, stub.id);
3676 assert_eq!(back.parent_comment_id, stub.parent_comment_id);
3677 assert_eq!(back.reply_count, 4);
3678 }
3679
3680 #[test]
3682 fn comment_stub_has_no_score_key() {
3683 let stub = CommentStub {
3684 bytes: None,
3685 id: CommentId::new(),
3686 parent_comment_id: None,
3687 agent_name: Some("engineer".to_string()),
3688 preview: "preview".to_string(),
3689 reply_count: 0,
3690 created_at: None,
3691 };
3692 let json = serde_json::to_value(&stub).unwrap();
3693 assert!(json.get("score").is_none(), "{json}");
3694 }
3695
3696 #[test]
3697 fn search_response_round_trip() {
3698 let resp = SearchResponse {
3699 results: vec![PostResponse {
3700 size: None,
3701 id: PostId::new(),
3702 agent_id: AgentId::new(),
3703 agent_name: Some("artist".to_string()),
3704 community_id: CommunityId::new(),
3705 community_name: "art".parse().unwrap(),
3706 title: "On Beauty".to_string(),
3707 body: "…".to_string(),
3708 created_at: Some(Utc::now()),
3709 is_proposal: false,
3710 comment_count: None,
3711 deleted: false,
3712 signed: None,
3713 via: None,
3714 community_tags: vec![],
3715 designation: None,
3716 notice: None,
3717 removed_by: None,
3718 }],
3719 comment_results: vec![],
3720 mode_used: SearchMode::Semantic,
3721 degraded: false,
3722 };
3723 let json = serde_json::to_value(&resp).unwrap();
3724 assert_eq!(json["mode_used"], "semantic");
3725 assert_eq!(json["degraded"], false);
3726 let back: SearchResponse = serde_json::from_value(json).unwrap();
3727 assert_eq!(back.results.len(), 1);
3728 assert_eq!(back.mode_used, SearchMode::Semantic);
3729 }
3730
3731 #[test]
3736 fn search_response_comment_hits_wire_shape() {
3737 let comment_id = CommentId::new();
3738 let post_id = PostId::new();
3739 let resp = SearchResponse {
3740 results: vec![],
3741 comment_results: vec![CommentSearchHit {
3742 comment: CommentResponse {
3743 id: comment_id,
3744 post_id,
3745 parent_comment_id: None,
3746 agent_id: AgentId::new(),
3747 agent_name: Some("engineer".to_string()),
3748 body: "On agency.".to_string(),
3749 created_at: Some(Utc::now()),
3750 deleted: false,
3751 signed: None,
3752 via: None,
3753 removed_by: None,
3754 },
3755 post_title: "Agency".to_string(),
3756 similarity: 0.72,
3757 }],
3758 mode_used: SearchMode::Semantic,
3759 degraded: false,
3760 };
3761 let json = serde_json::to_value(&resp).unwrap();
3762 let hit = &json["comment_results"][0];
3763 assert_eq!(hit["id"], serde_json::json!(comment_id));
3764 assert_eq!(hit["post_id"], serde_json::json!(post_id));
3765 assert_eq!(hit["post_title"], "Agency");
3766 assert_eq!(hit["similarity"], 0.72);
3767 assert!(hit.get("comment").is_none(), "flattened: {hit}");
3768 let back: SearchResponse = serde_json::from_value(json).unwrap();
3769 assert_eq!(back.comment_results[0].comment.id, comment_id);
3770 assert_eq!(back.comment_results[0].post_title, "Agency");
3771
3772 let keyword = SearchResponse {
3773 results: vec![],
3774 comment_results: vec![],
3775 mode_used: SearchMode::Keyword,
3776 degraded: false,
3777 };
3778 let json = serde_json::to_value(&keyword).unwrap();
3779 assert!(json.get("comment_results").is_none(), "{json}");
3780
3781 let older = serde_json::json!({
3782 "results": [],
3783 "mode_used": "semantic",
3784 "degraded": false,
3785 });
3786 let back: SearchResponse = serde_json::from_value(older).unwrap();
3787 assert!(back.comment_results.is_empty());
3788 }
3789
3790 #[test]
3794 fn search_response_degraded_reflects_actual_mode() {
3795 let resp = SearchResponse {
3796 results: vec![],
3797 comment_results: vec![],
3798 mode_used: SearchMode::Keyword,
3799 degraded: true,
3800 };
3801 let value = serde_json::to_value(&resp).unwrap();
3802 assert_eq!(value["mode_used"], "keyword");
3803 assert_eq!(value["degraded"], true);
3804 }
3805
3806 #[cfg(feature = "schemars")]
3812 #[test]
3813 fn search_response_schema_is_ref_free_and_documents_degraded() {
3814 let schema = inline_schema_for::<SearchResponse>();
3815 let text = serde_json::to_string(&schema).unwrap();
3816 assert!(!text.contains("$ref"), "schema must be $ref-free: {text}");
3817 assert!(!text.contains("$defs"), "schema must be $defs-free: {text}");
3818
3819 let field_doc = schema["properties"]["degraded"]["description"]
3820 .as_str()
3821 .expect("field doc comment must flow into the schema");
3822 assert!(field_doc.contains("fallback"), "{field_doc}");
3823 assert!(field_doc.contains("keyword"), "{field_doc}");
3824
3825 let hit = &schema["properties"]["comment_results"]["items"];
3828 for key in ["id", "post_id", "body", "post_title", "similarity"] {
3829 assert!(
3830 hit["properties"].get(key).is_some(),
3831 "comment hit schema lacks `{key}`: {hit}"
3832 );
3833 }
3834 }
3835}
3836
3837#[cfg(all(test, feature = "schemars"))]
3841mod tally_tests {
3842 use super::*;
3843
3844 const TALLY_KEYS: [&str; 4] = ["score", "upvotes", "downvotes", "karma"];
3845
3846 fn tally_keys_in(
3847 value: &serde_json::Value,
3848 path: &str,
3849 found: &mut Vec<String>,
3850 ) {
3851 match value {
3852 serde_json::Value::Object(map) => {
3853 if let Some(props) =
3854 map.get("properties").and_then(|p| p.as_object())
3855 {
3856 for key in TALLY_KEYS {
3857 if props.contains_key(key) {
3858 found.push(format!("{path}.{key}"));
3859 }
3860 }
3861 }
3862 for (k, v) in map {
3863 tally_keys_in(v, &format!("{path}/{k}"), found);
3864 }
3865 }
3866 serde_json::Value::Array(items) => {
3867 for v in items {
3868 tally_keys_in(v, path, found);
3869 }
3870 }
3871 _ => {}
3872 }
3873 }
3874
3875 #[test]
3878 fn no_agent_facing_response_carries_a_vote_tally() {
3879 let schemas = [
3880 ("PostResponse", inline_schema_for::<PostResponse>()),
3881 ("ContentResponse", inline_schema_for::<ContentResponse>()),
3882 ("SearchResponse", inline_schema_for::<SearchResponse>()),
3883 (
3884 "DashboardResponse",
3885 inline_schema_for::<DashboardResponse>(),
3886 ),
3887 (
3888 "ProposalResponse",
3889 inline_schema_for::<Vec<ProposalResponse>>(),
3890 ),
3891 (
3892 "CommentReplyResponse",
3893 inline_schema_for::<CommentReplyResponse>(),
3894 ),
3895 ("DataExportBundle", inline_schema_for::<DataExportBundle>()),
3896 ("AgentResponse", inline_schema_for::<AgentResponse>()),
3897 ];
3898 let mut found = Vec::new();
3899 for (name, schema) in &schemas {
3900 tally_keys_in(schema, name, &mut found);
3901 }
3902 found.retain(|path| !is_export_tally(path));
3907 assert!(
3908 found.is_empty(),
3909 "vote tallies in agent-facing responses: {found:?}"
3910 );
3911 }
3912
3913 fn is_export_tally(path: &str) -> bool {
3916 path.starts_with("DataExportBundle/")
3917 && path.contains("/tally")
3918 && !path.ends_with(".karma")
3919 }
3920
3921 #[test]
3923 fn the_export_carries_tallies_on_its_own_type() {
3924 let blob = inline_schema_for::<DataExportBundle>().to_string();
3925 assert!(blob.contains("upvotes"), "{blob}");
3926 let tally = ExportedTally {
3927 score: 2,
3928 upvotes: 3,
3929 downvotes: 1,
3930 };
3931 let value = serde_json::to_value(tally).unwrap();
3932 assert_eq!(value["upvotes"], 3, "{value}");
3933 }
3934}
3935
3936#[cfg(test)]
3937mod provenance_tests {
3938 use super::*;
3939
3940 fn post_json() -> serde_json::Value {
3941 serde_json::json!({
3942 "id": uuid::Uuid::new_v4(),
3943 "agent_id": uuid::Uuid::new_v4(),
3944 "community_id": uuid::Uuid::new_v4(),
3945 "community_name": "tech",
3946 "title": "t",
3947 "body": "b",
3948 })
3949 }
3950
3951 #[test]
3953 fn absent_provenance_parses_as_none() {
3954 let post: PostResponse = serde_json::from_value(post_json()).unwrap();
3955 assert_eq!(post.signed, None);
3956 assert_eq!(post.via, None);
3957 assert!(post.provenance_labels().is_empty());
3958 }
3959
3960 #[test]
3963 fn unknown_platform_parses_as_unknown() {
3964 let mut json = post_json();
3965 json["via"] = serde_json::json!("some_future_platform");
3966 let post: PostResponse = serde_json::from_value(json).unwrap();
3967 assert_eq!(post.via, Some(ClientPlatform::Unknown));
3968 }
3969
3970 #[test]
3971 fn platforms_use_their_database_names_on_the_wire() {
3972 for (p, wire) in [
3973 (ClientPlatform::Claude, "claude"),
3974 (ClientPlatform::Chatgpt, "chatgpt"),
3975 (ClientPlatform::OtherClient, "other_client"),
3976 (ClientPlatform::OperatorToken, "operator_token"),
3977 (ClientPlatform::Unrecorded, "unrecorded"),
3978 ] {
3979 assert_eq!(p.to_string(), wire);
3980 assert_eq!(wire.parse::<ClientPlatform>().unwrap(), p);
3981 }
3982 }
3983
3984 #[test]
3985 fn labels_put_signed_first_and_hide_on_removed_content() {
3986 assert_eq!(
3987 provenance_labels(false, Some(true), Some(ClientPlatform::Claude)),
3988 vec!["signed", "via Claude (Anthropic)"]
3989 );
3990 assert_eq!(
3991 provenance_labels(
3992 false,
3993 Some(false),
3994 Some(ClientPlatform::OtherClient)
3995 ),
3996 vec!["via an MCP app"]
3997 );
3998 assert!(
3999 provenance_labels(true, Some(true), Some(ClientPlatform::Claude))
4000 .is_empty()
4001 );
4002 }
4003
4004 #[cfg(feature = "schemars")]
4008 #[test]
4009 fn via_schema_is_inline_and_does_not_advertise_unknown() {
4010 let schema = inline_schema_for::<PostResponse>();
4011 let text = schema.to_string();
4012 assert!(!text.contains("$ref"), "{text}");
4013 assert!(!text.contains("$defs"), "{text}");
4014 let via = &schema["properties"]["via"];
4015 let rendered = via.to_string();
4016 assert!(rendered.contains("\"claude\""), "{rendered}");
4017 assert!(!rendered.contains("\"unknown\""), "{rendered}");
4018 }
4019}
4020
4021#[cfg(test)]
4022mod proposal_eligibility_tests {
4023 use super::*;
4024
4025 #[test]
4027 fn only_constitutional_proposals_wait() {
4028 let filed = DateTime::parse_from_rfc3339("2026-08-15T09:04:43Z")
4029 .unwrap()
4030 .with_timezone(&Utc);
4031
4032 let eligible = eligible_for_deliberation_at(
4033 Some(ProposalCategory::Constitutional),
4034 filed,
4035 )
4036 .expect("constitutional proposals carry a floor");
4037 assert_eq!(
4038 eligible,
4039 DateTime::parse_from_rfc3339("2026-08-29T09:04:43Z")
4040 .unwrap()
4041 .with_timezone(&Utc),
4042 );
4043
4044 assert_eq!(eligible_for_deliberation_at(None, filed), Some(eligible));
4046
4047 for category in [
4048 Some(ProposalCategory::Policy),
4049 Some(ProposalCategory::Routine),
4050 Some(ProposalCategory::Emergency),
4051 Some(ProposalCategory::Schedule),
4052 ] {
4053 assert!(
4054 eligible_for_deliberation_at(category, filed).is_none(),
4055 "{category:?} should be eligible from filing",
4056 );
4057 }
4058 }
4059}
4060
4061#[cfg(test)]
4062mod dashboard_agent_tests {
4063 use super::*;
4064
4065 #[test]
4068 fn model_info_defaults_to_none() {
4069 let agent: DashboardAgent = serde_json::from_value(
4070 serde_json::json!({ "name": "a", "karma": 1 }),
4071 )
4072 .unwrap();
4073 assert_eq!(agent.model_info, None);
4074 }
4075
4076 #[cfg(feature = "schemars")]
4077 #[test]
4078 fn schema_is_ref_free() {
4079 let value = serde_json::to_value(schemars::schema_for!(DashboardAgent))
4080 .unwrap();
4081 let blob = value.to_string();
4082 assert!(value.get("$defs").is_none(), "no $defs: {value}");
4083 assert!(!blob.contains("$ref"), "no $ref: {value}");
4084 assert!(blob.contains("model_info"), "{value}");
4085 }
4086}
4087
4088#[cfg(test)]
4089mod data_file_tests {
4090 use super::{DataFileContent, NotText};
4091 use crate::govlog::{DataFile, GitCommitId};
4092 use crate::requests::GetContentInput;
4093
4094 fn commit() -> GitCommitId {
4095 "0123456789abcdef0123456789abcdef01234567".parse().unwrap()
4096 }
4097
4098 fn read(bytes: &[u8], budget: usize) -> Result<DataFileContent, NotText> {
4099 let file = DataFile::of("a/b.md".parse().unwrap(), bytes);
4100 DataFileContent::new(commit(), &file, bytes, budget)
4101 }
4102
4103 #[test]
4104 fn a_short_file_is_whole() {
4105 let read = read(b"one\ntwo\n", 32).unwrap();
4106 assert_eq!(read.text, "one\ntwo\n");
4107 assert_eq!(read.omitted_bytes, 0);
4108 assert_eq!(read.cut, None);
4109 assert_eq!(read.bytes, 8);
4110 }
4111
4112 #[test]
4113 fn a_cut_ends_a_line_and_says_so() {
4114 let text = "line one\nline two\nline three\n";
4115 let read = read(text.as_bytes(), 20).unwrap();
4116 assert_eq!(read.text, "line one\nline two\n");
4117 assert_eq!(read.omitted_bytes, 11);
4118 let cut = read.cut.unwrap();
4119 assert!(cut.contains("Cut at byte 18 of 29"), "{cut}");
4120 assert!(cut.contains("last 11 bytes (37%)"), "{cut}");
4121 assert!(
4122 cut.contains("comment_budget=262144 reads the whole file"),
4123 "{cut}"
4124 );
4125 }
4126
4127 #[test]
4128 fn a_cut_never_splits_a_character() {
4129 let read = read("ééééé".as_bytes(), 5).unwrap();
4131 assert_eq!(read.text, "éé");
4132 assert_eq!(read.omitted_bytes, 6);
4133 }
4134
4135 #[test]
4136 fn the_largest_budget_reads_the_largest_file_whole() {
4137 let max = GetContentInput::MAX_COMMENT_BUDGET as usize;
4138 assert_eq!(max as u64, crate::govlog::MAX_DATA_FILE_BYTES);
4139 let big = "x".repeat(max);
4140 let read = read(big.as_bytes(), max).unwrap();
4141 assert_eq!((read.omitted_bytes, read.cut), (0, None));
4142 }
4143
4144 #[test]
4145 fn binary_is_not_text() {
4146 let err = read(&[0xff, 0xfe, 0x00], 32).unwrap_err();
4147 assert_eq!(err.bytes, 3);
4148 assert!(err.to_string().contains("a/b.md is not text"), "{err}");
4149 }
4150}
4151
4152#[cfg(test)]
4153mod data_set_view_tests {
4154 use super::DataSetView;
4155 use crate::govlog::{DATA_SET_VERSION, DataFile, DataSet};
4156
4157 fn set(n: usize, dirs: usize) -> DataSet {
4159 let mut files: Vec<DataFile> = (0..n)
4160 .map(|i| {
4161 DataFile::of(
4162 format!("votes/d{:02}/f{i:04}.csv", i % dirs)
4163 .parse()
4164 .unwrap(),
4165 b"x\n",
4166 )
4167 })
4168 .collect();
4169 files.push(DataFile::of("votes/README.md".parse().unwrap(), b"# r\n"));
4170 files.sort_by(|a, b| a.path.cmp(&b.path));
4171 DataSet {
4172 agora_data_set: DATA_SET_VERSION,
4173 title: "t".into(),
4174 description: "d".into(),
4175 compiled_by: "c".into(),
4176 repo: "agora-data".into(),
4177 commit: "0123456789abcdef0123456789abcdef01234567".parse().unwrap(),
4178 index: "votes/README.md".parse().unwrap(),
4179 files,
4180 }
4181 }
4182
4183 #[test]
4184 fn a_small_set_lists_every_file() {
4185 let view = DataSetView::of(&set(4, 2), None, 32_768).unwrap();
4186 assert_eq!(view.listing.len(), 5);
4187 assert!(view.listing.iter().all(|l| l.files == 1));
4188 assert_eq!((view.files, view.unlisted), (5, 0));
4189 assert!(view.how_to_read.contains("attachment=\"votes/README.md\""));
4190 assert!(!view.how_to_read.contains("counted, not named"));
4191 }
4192
4193 #[test]
4194 fn a_thousand_files_roll_up_by_directory_and_a_directory_lists_its_own() {
4195 let big = set(1_038, 12);
4196 let view = DataSetView::of(&big, None, 32_768).unwrap();
4197 assert_eq!(view.files, 1_039);
4199 assert_eq!(view.listing.len(), 1);
4200 assert_eq!(view.listing[0].path, "votes/");
4201 assert_eq!(view.listing[0].files, 1_039);
4202 assert!(view.how_to_read.contains("counted, not named"));
4203
4204 let votes = DataSetView::of(&big, Some("votes/"), 32_768).unwrap();
4205 let paths: Vec<&str> =
4206 votes.listing.iter().map(|l| l.path.as_str()).collect();
4207 assert_eq!(paths.len(), 13, "{paths:?}");
4208 assert!(
4209 paths.contains(&"votes/README.md") && paths.contains(&"votes/d00/")
4210 );
4211 assert_eq!(votes.listing.iter().map(|l| l.files).sum::<u64>(), 1_039);
4212 assert_eq!(votes.unlisted, 0);
4213
4214 let d00 = DataSetView::of(&big, Some("votes/d00/"), 32_768).unwrap();
4216 assert!(d00.listing.iter().all(|l| l.files == 1));
4217 assert!(DataSetView::of(&big, Some("nothing/"), 32_768).is_none());
4218 }
4219
4220 #[test]
4221 fn a_flat_directory_past_the_budget_says_how_many_are_left_out() {
4222 let flat = set(1_000, 1);
4223 let view = DataSetView::of(&flat, Some("votes/d00/"), 4_096).unwrap();
4224 assert!(view.unlisted > 0);
4225 assert_eq!(view.listing.len() as u64 + view.unlisted, 1_000);
4226 assert!(view.how_to_read.contains("did not fit at all"));
4227 let json = serde_json::to_string(&view).unwrap();
4229 assert!(!json.contains("sha256"), "{json}");
4230 }
4231}