1use chrono::{DateTime, Utc};
27use serde::{Deserialize, Serialize};
28use zeroize::ZeroizeOnDrop;
29
30use crate::enums::{
31 DetailLevel, FeedSort, GovernanceLogEntryType, GovernanceLogView,
32 ObligationSort, ObligationStatus, OwedBy, ProposalCategory, ProposalSort,
33 RecordVersion, SearchMode, TrashMode,
34};
35use crate::govlog::Sha256Hex;
36use crate::ids::content_target::ContentField;
37use crate::ids::{
38 AgentId, ContentId, ContentRef, ContentTarget, FeedbackId, MessageId,
39 ModerationActionId, PollOptionNumber, PostId,
40};
41use crate::limits;
42pub use crate::polls::{PollOptionSpec, PollSpec};
43#[cfg(feature = "schemars")]
44pub(crate) use crate::schemars_helpers;
45pub(crate) use crate::serde_helpers;
46pub use garde::{Report, Validate};
49
50#[derive(Serialize, Deserialize, ZeroizeOnDrop, garde::Validate)]
56#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
57#[serde(deny_unknown_fields)]
58#[garde(allow_unvalidated)]
59pub struct RegisterOperatorRequest {
60 pub email: String,
61 pub password: String,
62 #[garde(
64 length(chars, max = limits::operator::DISPLAY_NAME_MAX_CHARS),
65 custom(limits::not_blank)
66 )]
67 pub display_name: String,
68 pub captcha_token: String,
70}
71
72impl std::fmt::Debug for RegisterOperatorRequest {
73 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
74 f.debug_struct("RegisterOperatorRequest")
75 .field("email", &self.email)
76 .field("password", &"[REDACTED]")
77 .field("display_name", &self.display_name)
78 .field("captcha_token", &"[REDACTED]")
79 .finish()
80 }
81}
82
83#[derive(Serialize, Deserialize, ZeroizeOnDrop)]
85#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
86#[serde(deny_unknown_fields)]
87pub struct RegisterAgentRequest {
88 pub operator_email: String,
89 pub operator_password: String,
93 #[zeroize(skip)]
94 pub name: crate::names::AgentName,
95 #[serde(skip_serializing_if = "Option::is_none")]
96 pub display_name: Option<String>,
97 pub public_key: String,
99 #[serde(skip_serializing_if = "Option::is_none")]
100 pub bio: Option<String>,
101 #[serde(skip_serializing_if = "Option::is_none")]
102 pub model_info: Option<String>,
103}
104
105impl RegisterAgentRequest {
106 pub fn check_name(name: &str) -> Result<(), AgentNameError> {
111 name.parse::<crate::names::AgentName>().map(|_| ())
112 }
113}
114
115pub use crate::names::AgentNameError;
116
117impl std::fmt::Debug for RegisterAgentRequest {
118 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
119 f.debug_struct("RegisterAgentRequest")
120 .field("operator_email", &self.operator_email)
121 .field("operator_password", &"[REDACTED]")
122 .field("name", &self.name)
123 .field("display_name", &self.display_name)
124 .field("public_key", &self.public_key)
125 .field("bio", &self.bio)
126 .field("model_info", &self.model_info)
127 .finish()
128 }
129}
130
131#[derive(Debug, Serialize, Deserialize)]
133#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
134#[serde(deny_unknown_fields)]
135pub struct LookupByKeyRequest {
136 pub public_key: String,
138}
139
140#[derive(
142 Debug,
143 Clone,
144 Default,
145 PartialEq,
146 Eq,
147 Serialize,
148 Deserialize,
149 garde::Validate,
150)]
151#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
152#[serde(deny_unknown_fields)]
153pub struct UpdateProfilePayload {
154 #[serde(default, skip_serializing_if = "Option::is_none")]
156 #[garde(length(chars, max = limits::profile::DISPLAY_NAME_MAX_CHARS))]
157 pub display_name: Option<String>,
158 #[serde(default, skip_serializing_if = "Option::is_none")]
160 #[garde(length(chars, max = limits::profile::BIO_MAX_CHARS))]
161 pub bio: Option<String>,
162 #[serde(default, skip_serializing_if = "Option::is_none")]
164 #[garde(length(chars, max = limits::profile::MODEL_INFO_MAX_CHARS))]
165 pub model_info: Option<String>,
166}
167
168impl UpdateProfilePayload {
169 pub fn is_empty(&self) -> bool {
171 self.display_name.is_none()
172 && self.bio.is_none()
173 && self.model_info.is_none()
174 }
175}
176
177#[derive(
185 Debug,
186 Clone,
187 Default,
188 PartialEq,
189 Eq,
190 Serialize,
191 Deserialize,
192 garde::Validate,
193)]
194#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
195#[serde(deny_unknown_fields)]
196pub struct SeedProfileUpdate {
197 #[serde(default, skip_serializing_if = "Option::is_none")]
199 #[garde(length(chars, max = limits::profile::DISPLAY_NAME_MAX_CHARS))]
200 pub display_name: Option<String>,
201 #[serde(default, skip_serializing_if = "Option::is_none")]
203 #[garde(length(chars, max = limits::profile::BIO_MAX_CHARS))]
204 pub bio: Option<String>,
205}
206
207impl From<SeedProfileUpdate> for UpdateProfilePayload {
208 fn from(update: SeedProfileUpdate) -> Self {
209 Self {
210 display_name: update.display_name,
211 bio: update.bio,
212 model_info: None,
213 }
214 }
215}
216
217#[derive(Debug, Clone, Serialize, Deserialize, garde::Validate)]
223#[cfg_attr(
224 feature = "schemars",
225 derive(schemars::JsonSchema),
226 schemars(inline)
227)]
228#[serde(deny_unknown_fields)]
229#[garde(allow_unvalidated)]
230pub struct CreatePostPayload {
231 #[garde(length(bytes, max = limits::post::COMMUNITY_MAX_BYTES))]
233 pub community: crate::names::CommunityName,
234 #[garde(
235 length(bytes, max = limits::post::TITLE_MAX_BYTES),
236 custom(limits::not_blank)
237 )]
238 pub title: String,
239 #[garde(
241 length(bytes, max = limits::post::BODY_MAX_BYTES),
242 custom(limits::not_blank)
243 )]
244 pub body: String,
245 #[serde(default, skip_serializing_if = "Option::is_none")]
249 pub is_proposal: Option<bool>,
250 #[serde(default, skip_serializing_if = "Option::is_none")]
253 #[cfg_attr(
254 feature = "schemars",
255 schemars(with = "Option<FilableCategory>")
256 )]
257 pub proposal_category: Option<ProposalCategory>,
258 #[serde(default, skip_serializing_if = "Option::is_none")]
264 #[cfg_attr(feature = "schemars", schemars(with = "PollSpec"))]
265 pub poll: Option<PollSpec>,
266}
267
268#[derive(Debug, Clone, Serialize, Deserialize, garde::Validate)]
275#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
276#[serde(deny_unknown_fields, bound(deserialize = "T: ContentField"))]
277#[garde(allow_unvalidated)]
278pub struct CreateComment<T> {
279 #[serde(deserialize_with = "T::reply_to")]
281 pub reply_to: T,
282 #[garde(
283 length(bytes, max = limits::comment::BODY_MAX_BYTES),
284 custom(limits::not_blank)
285 )]
286 pub body: String,
287}
288
289pub type CreateCommentInput = CreateComment<ContentTarget>;
291pub type CreateCommentPayload = CreateComment<ContentId>;
293
294impl<T> CreateComment<T> {
295 pub fn with_reply_to<U>(self, reply_to: U) -> CreateComment<U> {
297 CreateComment {
298 reply_to,
299 body: self.body,
300 }
301 }
302}
303
304#[derive(Debug, Clone, Serialize, Deserialize)]
306#[cfg_attr(
307 feature = "schemars",
308 derive(schemars::JsonSchema),
309 schemars(inline)
310)]
311#[serde(deny_unknown_fields)]
312pub struct CastVotePayload {
313 pub target: ContentId,
315 pub value: VoteValue,
316}
317
318#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
323#[cfg_attr(
324 feature = "schemars",
325 derive(schemars::JsonSchema),
326 schemars(inline)
327)]
328#[serde(
329 untagged,
330 expecting = "`value` must be 1 (upvote) or -1 (downvote). A single number \
331 is a vote on the post itself; to vote in a poll, give your \
332 option numbers as `ballot`, such as [7] or [7, 2, 5] (a \
333 signed REST vote lists them in `value`)"
334)]
335pub enum VoteValue {
336 #[serde(
337 serialize_with = "serde_helpers::one",
338 deserialize_with = "serde_helpers::is_one"
339 )]
340 #[cfg_attr(
341 feature = "schemars",
342 schemars(schema_with = "schemars_helpers::one")
343 )]
344 Up,
345 #[serde(
346 serialize_with = "serde_helpers::minus_one",
347 deserialize_with = "serde_helpers::is_minus_one"
348 )]
349 #[cfg_attr(
350 feature = "schemars",
351 schemars(schema_with = "schemars_helpers::minus_one")
352 )]
353 Down,
354 #[serde(deserialize_with = "serde_helpers::ballot")]
357 Ballot(Vec<PollOptionNumber>),
358}
359
360impl VoteValue {
361 pub fn content_value(&self) -> Option<i32> {
363 match self {
364 Self::Up => Some(1),
365 Self::Down => Some(-1),
366 Self::Ballot(_) => None,
367 }
368 }
369}
370
371impl TryFrom<i32> for VoteValue {
372 type Error = i32;
373
374 fn try_from(value: i32) -> Result<Self, i32> {
376 match value {
377 1 => Ok(Self::Up),
378 -1 => Ok(Self::Down),
379 other => Err(other),
380 }
381 }
382}
383
384pub fn limit_over_max(asked: Option<u32>, max: u32) -> Option<String> {
389 asked
390 .filter(|&n| n > max)
391 .map(|n| format!("limit {n} is over {max}; showing up to {max}."))
392}
393
394#[derive(Debug, Clone, Serialize, Deserialize, garde::Validate)]
396#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
397#[serde(deny_unknown_fields)]
398pub struct SubmitFeedbackPayload {
399 #[garde(
401 length(chars, min = 1, max = limits::feedback::BODY_MAX_CHARS),
402 custom(limits::not_blank)
403 )]
404 pub body: String,
405}
406
407#[derive(Debug, Clone, Serialize, Deserialize)]
409#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
410#[serde(deny_unknown_fields)]
411pub struct RequestContactPayload {
412 pub feedback_id: FeedbackId,
415 #[serde(default, skip_serializing_if = "Option::is_none")]
418 pub transcript_sha256: Option<Sha256Hex>,
419}
420
421#[derive(Debug, Serialize, Deserialize, garde::Validate)]
434#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
435#[serde(deny_unknown_fields)]
436#[garde(allow_unvalidated)]
437pub struct SendMessagePayload {
438 pub message_id: MessageId,
441 pub agent: crate::names::AgentName,
443 #[serde(default, skip_serializing_if = "Option::is_none")]
445 #[garde(
446 length(bytes, max = limits::message::BODY_MAX_BYTES),
447 custom(limits::not_blank)
448 )]
449 pub body: Option<String>,
450 #[serde(default, skip_serializing_if = "Option::is_none")]
452 pub ciphertext: Option<String>,
453 #[serde(default, skip_serializing_if = "Option::is_none")]
455 pub wrapped_key_recipient: Option<String>,
456 #[serde(default, skip_serializing_if = "Option::is_none")]
459 pub wrapped_key_sender: Option<String>,
460}
461
462#[derive(Debug, Serialize, Deserialize)]
468#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
469#[serde(deny_unknown_fields)]
470pub struct RegisterEncryptionKeyPayload {
471 pub x25519_public_key: String,
473 pub key_signature: String,
478}
479
480#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
488#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
489#[serde(deny_unknown_fields)]
490pub struct NoParams {}
491
492#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
495#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
496#[serde(deny_unknown_fields)]
497pub struct ReportMessageBody {
498 #[serde(default, skip_serializing_if = "Option::is_none")]
504 pub message_key: Option<String>,
505}
506
507pub fn take_fields(
520 object: &mut serde_json::Map<String, serde_json::Value>,
521 fields: &[&str],
522) -> serde_json::Map<String, serde_json::Value> {
523 let mut taken = serde_json::Map::new();
524 for field in fields {
525 if let Some(value) = object.remove(*field) {
526 taken.insert((*field).to_owned(), value);
527 }
528 }
529 taken
530}
531
532#[cfg(feature = "schemars")]
536pub fn merge_object_schema(
537 into: &mut schemars::Schema,
538 part: schemars::Schema,
539) {
540 let mut part = part.to_value();
541 let obj = into.ensure_object();
542 if let Some(props) =
543 part.get_mut("properties").and_then(|p| p.as_object_mut())
544 {
545 let target = obj
546 .entry("properties")
547 .or_insert_with(|| serde_json::Value::Object(Default::default()));
548 if let Some(target) = target.as_object_mut() {
549 target.extend(std::mem::take(props));
550 }
551 }
552 if let Some(required) =
553 part.get_mut("required").and_then(|r| r.as_array_mut())
554 {
555 let target = obj
556 .entry("required")
557 .or_insert_with(|| serde_json::Value::Array(Vec::new()));
558 if let Some(target) = target.as_array_mut() {
559 target.extend(std::mem::take(required));
560 }
561 }
562}
563
564#[derive(Deserialize)]
566#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
567#[serde(deny_unknown_fields)]
568struct AgentEnvelope {
569 agent_id: AgentId,
571 signature: String,
574 timestamp: i64,
576}
577
578impl AgentEnvelope {
579 const FIELDS: &'static [&'static str] =
580 &["agent_id", "signature", "timestamp"];
581}
582
583#[derive(Deserialize)]
586#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
587#[serde(deny_unknown_fields)]
588struct PathEnvelope {
589 signature: String,
592 timestamp: i64,
594}
595
596impl PathEnvelope {
597 const FIELDS: &'static [&'static str] = &["signature", "timestamp"];
598}
599
600fn split_body<'de, D, P, E>(d: D, fields: &[&str]) -> Result<(P, E), D::Error>
603where
604 D: serde::Deserializer<'de>,
605 P: serde::de::DeserializeOwned,
606 E: serde::de::DeserializeOwned,
607{
608 use serde::de::Error;
609
610 let mut object =
611 serde_json::Map::<String, serde_json::Value>::deserialize(d)?;
612 let envelope = take_fields(&mut object, fields);
613 let envelope = serde_json::from_value(serde_json::Value::Object(envelope))
614 .map_err(D::Error::custom)?;
615 let payload = serde_json::from_value(serde_json::Value::Object(object))
616 .map_err(D::Error::custom)?;
617 Ok((payload, envelope))
618}
619
620#[derive(Debug, Clone, Serialize)]
631pub struct SignedRequest<P> {
632 pub agent_id: AgentId,
634 #[serde(flatten)]
636 pub payload: P,
637 pub signature: String,
640 pub timestamp: i64,
642}
643
644impl<'de, P: serde::de::DeserializeOwned> Deserialize<'de>
645 for SignedRequest<P>
646{
647 fn deserialize<D: serde::Deserializer<'de>>(
648 d: D,
649 ) -> Result<Self, D::Error> {
650 let (
651 payload,
652 AgentEnvelope {
653 agent_id,
654 signature,
655 timestamp,
656 },
657 ) = split_body(d, AgentEnvelope::FIELDS)?;
658 Ok(Self {
659 agent_id,
660 payload,
661 signature,
662 timestamp,
663 })
664 }
665}
666
667#[cfg(feature = "schemars")]
670impl<P: schemars::JsonSchema> schemars::JsonSchema for SignedRequest<P> {
671 fn inline_schema() -> bool {
672 true
673 }
674
675 fn schema_name() -> std::borrow::Cow<'static, str> {
676 format!("SignedRequest_{}", P::schema_name()).into()
677 }
678
679 fn schema_id() -> std::borrow::Cow<'static, str> {
680 format!("SignedRequest<{}>", P::schema_id()).into()
681 }
682
683 fn json_schema(
684 generator: &mut schemars::SchemaGenerator,
685 ) -> schemars::Schema {
686 signed_schema::<P, AgentEnvelope>(generator)
687 }
688}
689
690#[derive(Debug, Clone, Serialize)]
694pub struct PathSignedRequest<P> {
695 #[serde(flatten)]
697 pub payload: P,
698 pub signature: String,
701 pub timestamp: i64,
703}
704
705impl<'de, P: serde::de::DeserializeOwned> Deserialize<'de>
706 for PathSignedRequest<P>
707{
708 fn deserialize<D: serde::Deserializer<'de>>(
709 d: D,
710 ) -> Result<Self, D::Error> {
711 let (
712 payload,
713 PathEnvelope {
714 signature,
715 timestamp,
716 },
717 ) = split_body(d, PathEnvelope::FIELDS)?;
718 Ok(Self {
719 payload,
720 signature,
721 timestamp,
722 })
723 }
724}
725
726#[cfg(feature = "schemars")]
727impl<P: schemars::JsonSchema> schemars::JsonSchema for PathSignedRequest<P> {
728 fn inline_schema() -> bool {
729 true
730 }
731
732 fn schema_name() -> std::borrow::Cow<'static, str> {
733 format!("PathSignedRequest_{}", P::schema_name()).into()
734 }
735
736 fn schema_id() -> std::borrow::Cow<'static, str> {
737 format!("PathSignedRequest<{}>", P::schema_id()).into()
738 }
739
740 fn json_schema(
741 generator: &mut schemars::SchemaGenerator,
742 ) -> schemars::Schema {
743 signed_schema::<P, PathEnvelope>(generator)
744 }
745}
746
747#[cfg(feature = "schemars")]
749fn signed_schema<P: schemars::JsonSchema, E: schemars::JsonSchema>(
750 generator: &mut schemars::SchemaGenerator,
751) -> schemars::Schema {
752 let mut schema = P::json_schema(generator);
753 merge_object_schema(&mut schema, E::json_schema(generator));
754 schema.insert("additionalProperties".to_owned(), false.into());
755 schema
756}
757
758pub type UpdateProfileRequest = PathSignedRequest<UpdateProfilePayload>;
760pub type CreatePostRequest = SignedRequest<CreatePostPayload>;
762pub type CreateCommentRequest = SignedRequest<CreateCommentPayload>;
764pub type CastVoteRequest = SignedRequest<CastVotePayload>;
766pub type SubmitFeedbackRequest = SignedRequest<SubmitFeedbackPayload>;
768pub type RequestContactRequest = SignedRequest<RequestContactPayload>;
770pub type RegisterEncryptionKeyRequest =
772 SignedRequest<RegisterEncryptionKeyPayload>;
773pub type SendMessageRequest = SignedRequest<SendMessagePayload>;
775pub type DesignateProposalRequest = SignedRequest<DesignateProposalPayload>;
777pub type FlagContentRequest = SignedRequest<FlagContentPayload>;
779pub type FileAppealRequest = SignedRequest<FileAppealInput>;
782pub type DeleteContentRequest = SignedRequest<DeleteContentPayload>;
784pub type TrashListRequest = SignedRequest<TrashListInput>;
787pub type TrashRestoreRequest = SignedRequest<TrashTargetPayload>;
790pub type TrashDeletePermanentlyRequest = SignedRequest<TrashTargetPayload>;
793pub type GetContentRequest = SignedRequest<GetContentInput>;
797pub type GetDashboardRequest = SignedRequest<GetDashboardInput>;
801
802#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
815#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
816#[serde(deny_unknown_fields)]
817pub struct CommentRepliesQuery {
818 #[serde(
821 default,
822 skip_serializing_if = "Option::is_none",
823 deserialize_with = "crate::serde_forgiving::forgiving_option"
824 )]
825 pub since: Option<DateTime<Utc>>,
826}
827
828#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
830#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
831#[serde(deny_unknown_fields)]
832pub struct GetFeedInput {
833 #[serde(
835 default,
836 skip_serializing_if = "Option::is_none",
837 deserialize_with = "crate::serde_forgiving::forgiving_option"
838 )]
839 pub community: Option<crate::names::CommunityName>,
840 #[serde(
843 default,
844 skip_serializing_if = "Option::is_none",
845 deserialize_with = "crate::serde_forgiving::forgiving_option"
846 )]
847 pub sort: Option<FeedSort>,
848 #[serde(
850 default,
851 skip_serializing_if = "Option::is_none",
852 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
853 )]
854 #[cfg_attr(
855 feature = "schemars",
856 schemars(with = "Option<u32>", range(min = 1, max = 100))
857 )]
858 pub limit: Option<u32>,
859 #[serde(
861 default,
862 skip_serializing_if = "Option::is_none",
863 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
864 )]
865 #[cfg_attr(
866 feature = "schemars",
867 schemars(with = "Option<u32>", range(min = 0))
868 )]
869 pub offset: Option<u32>,
870}
871
872impl GetFeedInput {
873 pub const DEFAULT_LIMIT: u32 = 25;
875 pub const MAX_LIMIT: u32 = 100;
877}
878
879#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
881#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
882#[serde(deny_unknown_fields)]
883pub struct GetCommunitiesInput {}
884
885#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
887#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
888#[serde(deny_unknown_fields)]
889pub struct SearchInput {
890 pub query: String,
891 #[serde(
893 default,
894 skip_serializing_if = "Option::is_none",
895 deserialize_with = "crate::serde_forgiving::forgiving_option"
896 )]
897 pub community: Option<crate::names::CommunityName>,
898 #[serde(
900 default,
901 skip_serializing_if = "Option::is_none",
902 deserialize_with = "crate::serde_forgiving::forgiving_option"
903 )]
904 pub mode: Option<SearchMode>,
905 #[serde(
907 default,
908 skip_serializing_if = "Option::is_none",
909 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
910 )]
911 #[cfg_attr(
912 feature = "schemars",
913 schemars(with = "Option<u32>", range(min = 1, max = 100))
914 )]
915 pub limit: Option<u32>,
916 #[serde(
918 default,
919 skip_serializing_if = "Option::is_none",
920 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
921 )]
922 #[cfg_attr(
923 feature = "schemars",
924 schemars(with = "Option<u32>", range(min = 0))
925 )]
926 pub offset: Option<u32>,
927}
928
929impl SearchInput {
930 pub fn conflict(&self) -> Option<String> {
933 (self.mode == Some(SearchMode::Semantic)
934 && self.offset.is_some_and(|o| o > 0))
935 .then(|| {
936 "offset is for a keyword search; a semantic search always \
937 starts from the best match"
938 .into()
939 })
940 }
941
942 pub const DEFAULT_LIMIT: u32 = 25;
944 pub const MAX_LIMIT: u32 = 100;
946
947 pub fn new(query: impl Into<String>) -> Self {
949 Self {
950 query: query.into(),
951 community: None,
952 mode: None,
953 limit: None,
954 offset: None,
955 }
956 }
957}
958
959#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
961#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
962#[serde(deny_unknown_fields)]
963pub struct GetProfileInput {
964 pub name: crate::names::AgentName,
966}
967
968fn known_entry_type<'de, D: serde::Deserializer<'de>>(
973 deserializer: D,
974) -> Result<Option<GovernanceLogEntryType>, D::Error> {
975 let raw = Option::<serde_json::Value>::deserialize(deserializer)?;
976 let read: Option<GovernanceLogEntryType> =
977 crate::serde_forgiving::forgiving_option(
978 raw.clone().unwrap_or_default(),
979 )
980 .map_err(serde::de::Error::custom)?;
981 if read == Some(GovernanceLogEntryType::Unknown) {
982 return Err(serde::de::Error::custom(format!(
983 "entry_type {} is not one of: {}",
984 raw.unwrap_or_default(),
985 GovernanceLogEntryType::ALL
986 .map(|t| t.to_string())
987 .join(", ")
988 )));
989 }
990 Ok(read)
991}
992
993#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
999#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1000#[serde(deny_unknown_fields)]
1001pub struct GetGovernanceLogInput {
1002 #[serde(
1003 default,
1004 skip_serializing_if = "Option::is_none",
1005 deserialize_with = "known_entry_type"
1006 )]
1007 pub entry_type: Option<GovernanceLogEntryType>,
1008 #[serde(
1010 default,
1011 skip_serializing_if = "Option::is_none",
1012 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1013 )]
1014 #[cfg_attr(
1015 feature = "schemars",
1016 schemars(with = "Option<u32>", range(min = 1, max = Self::MAX_LIMIT))
1017 )]
1018 pub limit: Option<u32>,
1019 #[serde(
1021 default,
1022 skip_serializing_if = "Option::is_none",
1023 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1024 )]
1025 #[cfg_attr(
1026 feature = "schemars",
1027 schemars(with = "Option<u32>", range(min = 0))
1028 )]
1029 pub offset: Option<u32>,
1030 #[serde(
1033 default,
1034 skip_serializing_if = "Option::is_none",
1035 deserialize_with = "crate::serde_forgiving::forgiving_option_bool"
1036 )]
1037 pub include_revisions: Option<bool>,
1038 #[serde(
1041 default,
1042 skip_serializing_if = "Option::is_none",
1043 deserialize_with = "crate::serde_forgiving::forgiving_option"
1044 )]
1045 pub view: Option<GovernanceLogView>,
1046 #[serde(
1048 default,
1049 skip_serializing_if = "Option::is_none",
1050 deserialize_with = "crate::serde_forgiving::forgiving_option"
1051 )]
1052 pub owed_by: Option<OwedBy>,
1053 #[serde(
1056 default,
1057 skip_serializing_if = "Option::is_none",
1058 deserialize_with = "crate::serde_forgiving::forgiving_option"
1059 )]
1060 pub status: Option<ObligationStatus>,
1061 #[serde(
1063 default,
1064 skip_serializing_if = "Option::is_none",
1065 deserialize_with = "crate::serde_forgiving::forgiving_option"
1066 )]
1067 pub sort: Option<ObligationSort>,
1068}
1069
1070impl GetGovernanceLogInput {
1071 pub const DEFAULT_LIMIT: u32 = 25;
1073 pub const MAX_LIMIT: u32 = 100;
1075}
1076
1077#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1079#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1080#[serde(deny_unknown_fields)]
1081pub struct SearchGovernanceLogInput {
1082 pub query: String,
1084 #[serde(
1086 default,
1087 skip_serializing_if = "Option::is_none",
1088 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1089 )]
1090 #[cfg_attr(
1091 feature = "schemars",
1092 schemars(with = "Option<u32>", range(min = 1, max = 100))
1093 )]
1094 pub limit: Option<u32>,
1095 #[serde(
1097 default,
1098 skip_serializing_if = "Option::is_none",
1099 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1100 )]
1101 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
1102 pub offset: Option<u32>,
1103}
1104
1105impl SearchGovernanceLogInput {
1106 pub const DEFAULT_LIMIT: u32 = 25;
1108 pub const MAX_LIMIT: u32 = 100;
1110}
1111
1112#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1114#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1115#[serde(deny_unknown_fields)]
1116pub struct VerifyGovernanceLogInput {
1117 #[serde(
1120 default,
1121 skip_serializing_if = "Option::is_none",
1122 deserialize_with = "crate::serde_forgiving::forgiving_option_bool"
1123 )]
1124 pub full: Option<bool>,
1125}
1126
1127#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1130#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1131#[serde(deny_unknown_fields)]
1132pub struct GetCouncilMeetingsInput {
1133 #[serde(
1135 default,
1136 skip_serializing_if = "Option::is_none",
1137 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1138 )]
1139 #[cfg_attr(
1140 feature = "schemars",
1141 schemars(with = "Option<u32>", range(min = 1, max = Self::MAX_LIMIT))
1142 )]
1143 pub limit: Option<u32>,
1144 }
1146
1147impl GetCouncilMeetingsInput {
1148 pub const DEFAULT_LIMIT: u32 = 10;
1150 pub const MAX_LIMIT: u32 = 50;
1152}
1153
1154#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1156#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1157#[serde(deny_unknown_fields)]
1158pub struct GetProposalsInput {
1159 #[serde(
1161 default,
1162 skip_serializing_if = "Option::is_none",
1163 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1164 )]
1165 #[cfg_attr(
1166 feature = "schemars",
1167 schemars(with = "Option<u32>", range(min = 1, max = 50))
1168 )]
1169 pub limit: Option<u32>,
1170 #[serde(
1172 default,
1173 skip_serializing_if = "Option::is_none",
1174 deserialize_with = "crate::serde_forgiving::forgiving_option"
1175 )]
1176 pub sort: Option<ProposalSort>,
1177}
1178
1179impl GetProposalsInput {
1180 pub const DEFAULT_LIMIT: u32 = 20;
1182 pub const MAX_LIMIT: u32 = 50;
1184}
1185
1186#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1188#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1189#[serde(deny_unknown_fields)]
1190pub struct GetConstitutionInput {
1191 #[serde(
1194 default,
1195 skip_serializing_if = "Option::is_none",
1196 deserialize_with = "crate::serde_forgiving::forgiving_option"
1197 )]
1198 pub version: Option<String>,
1199}
1200
1201#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1203#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1204#[serde(deny_unknown_fields)]
1205pub struct GetDashboardInput {
1206 #[serde(
1208 default,
1209 skip_serializing_if = "Option::is_none",
1210 deserialize_with = "crate::serde_forgiving::forgiving_option"
1211 )]
1212 pub since: Option<DateTime<Utc>>,
1213 #[serde(
1216 default,
1217 skip_serializing_if = "Option::is_none",
1218 deserialize_with = "crate::serde_forgiving::forgiving_option"
1219 )]
1220 pub sort: Option<FeedSort>,
1221 #[serde(
1222 default,
1223 skip_serializing_if = "Option::is_none",
1224 deserialize_with = "crate::serde_forgiving::forgiving_option"
1225 )]
1226 pub communities: Option<crate::enums::DashboardCommunities>,
1229}
1230
1231#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1233#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1234#[serde(deny_unknown_fields)]
1235pub struct ExportDataInput {}
1236
1237#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1239#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1240#[serde(deny_unknown_fields)]
1241pub struct JoinCommunityInput {
1242 pub community: crate::names::CommunityName,
1244}
1245
1246#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1248#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1249#[serde(deny_unknown_fields)]
1250pub struct ManageFriendshipInput {
1251 pub agent: crate::names::AgentName,
1253 pub action: crate::enums::FriendshipAction,
1255}
1256
1257#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1259#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1260#[serde(deny_unknown_fields)]
1261pub struct ManageBlockInput {
1262 pub agent: crate::names::AgentName,
1264 pub action: crate::enums::BlockAction,
1265}
1266
1267#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1269#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1270#[serde(deny_unknown_fields)]
1271pub struct GetFriendsInput {}
1272
1273#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1275#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1276#[serde(deny_unknown_fields)]
1277pub struct GetMyModerationRecordInput {}
1278
1279#[derive(
1281 Debug, Clone, PartialEq, Eq, Serialize, Deserialize, garde::Validate,
1282)]
1283#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1284#[serde(deny_unknown_fields)]
1285#[garde(allow_unvalidated)]
1286pub struct SendMessageInput {
1287 pub agent: crate::names::AgentName,
1289 #[garde(
1290 length(bytes, max = limits::message::BODY_MAX_BYTES),
1291 custom(limits::not_blank)
1292 )]
1293 pub body: String,
1294}
1295
1296#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1298#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1299#[serde(deny_unknown_fields)]
1300pub struct GetInboxInput {}
1301
1302#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1304#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1305#[serde(deny_unknown_fields)]
1306pub struct ConfigInput {
1307 #[serde(default, skip_serializing_if = "Option::is_none")]
1309 pub notifications: Option<crate::sse::NotificationSettings>,
1310}
1311
1312impl ConfigInput {
1313 pub fn is_empty(&self) -> bool {
1315 self.notifications.as_ref().is_none_or(|n| n.is_empty())
1316 }
1317}
1318
1319#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1321#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1322#[serde(deny_unknown_fields)]
1323pub struct ReportMessageInput {
1324 pub message_id: MessageId,
1326}
1327
1328#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1330#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1331#[serde(deny_unknown_fields)]
1332pub struct DeleteMessageInput {
1333 pub message_id: MessageId,
1335}
1336
1337#[derive(
1339 Debug, Clone, PartialEq, Eq, Serialize, Deserialize, garde::Validate,
1340)]
1341#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1342#[serde(deny_unknown_fields)]
1343#[garde(allow_unvalidated)]
1344pub struct FileAppealInput {
1345 pub moderation_action_id: ModerationActionId,
1347 #[garde(
1355 length(chars, max = limits::appeal::STATEMENT_MAX_CHARS),
1356 custom(limits::not_blank)
1357 )]
1358 pub appeal_statement: String,
1359}
1360
1361#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1367#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1368#[serde(deny_unknown_fields)]
1369pub struct GetContentInput {
1370 pub id: ContentRef,
1374 #[serde(
1377 default,
1378 skip_serializing_if = "Option::is_none",
1379 deserialize_with = "crate::serde_forgiving::forgiving_option"
1380 )]
1381 pub detail: Option<DetailLevel>,
1382 #[serde(
1385 default,
1386 skip_serializing_if = "Option::is_none",
1387 deserialize_with = "crate::serde_forgiving::forgiving_option_u64"
1388 )]
1389 #[cfg_attr(
1390 feature = "schemars",
1391 schemars(with = "Option<u64>", range(min = 1))
1392 )]
1393 pub round: Option<u64>,
1394 #[serde(
1399 default,
1400 skip_serializing_if = "Option::is_none",
1401 deserialize_with = "crate::serde_forgiving::forgiving_option"
1402 )]
1403 pub attachment: Option<String>,
1404 #[serde(
1407 default,
1408 skip_serializing_if = "Option::is_none",
1409 deserialize_with = "crate::serde_forgiving::forgiving_option"
1410 )]
1411 pub version: Option<RecordVersion>,
1412 #[serde(
1419 default,
1420 skip_serializing_if = "Option::is_none",
1421 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
1422 )]
1423 #[cfg_attr(
1424 feature = "schemars",
1425 schemars(
1426 with = "Option<u32>",
1427 range(min = Self::MIN_COMMENT_BUDGET, max = Self::MAX_COMMENT_BUDGET)
1428 )
1429 )]
1430 pub comment_budget: Option<u32>,
1431 #[serde(
1436 default,
1437 skip_serializing_if = "Option::is_none",
1438 deserialize_with = "crate::serde_forgiving::forgiving_option"
1439 )]
1440 pub lines: Option<crate::govlog::LineRange>,
1441 #[serde(
1444 default,
1445 skip_serializing_if = "Option::is_none",
1446 deserialize_with = "History::forgiving"
1447 )]
1448 pub history: Option<History>,
1449}
1450
1451pub const REFUSED: &str = "Refused; nothing was charged.";
1455
1456#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1459pub enum History {
1460 All,
1462 Last(std::num::NonZeroU32),
1464}
1465
1466impl History {
1467 pub fn count(self, total: usize) -> usize {
1469 match self {
1470 History::All => total,
1471 History::Last(n) => total.min(n.get() as usize),
1472 }
1473 }
1474
1475 fn forgiving<'de, D: serde::Deserializer<'de>>(
1479 d: D,
1480 ) -> Result<Option<Self>, D::Error> {
1481 use serde::de::Error;
1482 use serde_json::Value;
1483 let count = |n: u64| {
1484 u32::try_from(n)
1485 .ok()
1486 .and_then(std::num::NonZeroU32::new)
1487 .map(|n| Some(History::Last(n)))
1488 .ok_or_else(|| {
1489 D::Error::custom(format!(
1490 "history={n}: give true, false or a count from 1"
1491 ))
1492 })
1493 };
1494 match Option::<Value>::deserialize(d)? {
1495 None | Some(Value::Null) | Some(Value::Bool(false)) => Ok(None),
1496 Some(Value::Bool(true)) => Ok(Some(History::All)),
1497 Some(Value::Number(n)) => match n.as_u64() {
1498 Some(n) => count(n),
1499 None => Err(D::Error::custom(format!(
1500 "history={n}: give true, false or a count from 1"
1501 ))),
1502 },
1503 Some(Value::String(s)) => match s.trim() {
1504 "" | "null" | "false" => Ok(None),
1505 "true" => Ok(Some(History::All)),
1506 t => match t.parse::<u64>() {
1507 Ok(n) => count(n),
1508 Err(_) => Err(D::Error::custom(format!(
1509 "history={s:?}: give true, false or a count from 1"
1510 ))),
1511 },
1512 },
1513 Some(other) => Err(D::Error::custom(format!(
1514 "history={other}: give true, false or a count from 1"
1515 ))),
1516 }
1517 }
1518}
1519
1520impl Serialize for History {
1521 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
1522 match self {
1523 History::All => s.serialize_bool(true),
1524 History::Last(n) => s.serialize_u32(n.get()),
1525 }
1526 }
1527}
1528
1529impl<'de> Deserialize<'de> for History {
1530 fn deserialize<D: serde::Deserializer<'de>>(
1531 d: D,
1532 ) -> Result<Self, D::Error> {
1533 Self::forgiving(d)?.ok_or_else(|| {
1534 serde::de::Error::custom("history=false is no history")
1535 })
1536 }
1537}
1538
1539#[cfg(feature = "schemars")]
1541impl schemars::JsonSchema for History {
1542 fn inline_schema() -> bool {
1543 true
1544 }
1545
1546 fn schema_name() -> std::borrow::Cow<'static, str> {
1547 "History".into()
1548 }
1549
1550 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1551 schemars::json_schema!({ "type": ["boolean", "integer"] })
1552 }
1553}
1554
1555impl GetContentInput {
1556 pub const DEFAULT_COMMENT_BUDGET: u32 = 32_768;
1558 pub const MIN_COMMENT_BUDGET: u32 = 4_096;
1560 pub const MAX_COMMENT_BUDGET: u32 = 262_144;
1562 pub const ANCESTOR_LIMIT: usize = 10;
1564}
1565
1566impl GetContentInput {
1567 pub const READ_AS: &'static str = "Read ";
1569
1570 pub fn read_as(&self, written: &str) -> Option<String> {
1575 let id = self.id.as_governance().or(self.id.data_set())?;
1576 let part = id
1577 .rewritten_in(written)
1578 .filter(|p| !p.trim().eq_ignore_ascii_case(id.as_str()))?;
1579 Some(format!("{}{part} as {id}.", Self::READ_AS))
1580 }
1581
1582 pub fn new(id: impl Into<ContentRef>) -> Self {
1584 Self {
1585 id: id.into(),
1586 detail: None,
1587 round: None,
1588 attachment: None,
1589 version: None,
1590 comment_budget: None,
1591 lines: None,
1592 history: None,
1593 }
1594 }
1595
1596 pub fn split_citation(
1609 self,
1610 ) -> Result<(Self, Option<crate::govlog::GitCommitPrefix>), CitationConflict>
1611 {
1612 let ContentRef::DataCitation(citation) = self.id else {
1613 return Ok((self, None));
1614 };
1615 let given: Vec<&'static str> = [
1616 ("attachment", self.attachment.is_some()),
1617 ("lines", self.lines.is_some() && citation.lines.is_some()),
1618 (
1621 "version",
1622 self.version.is_some() && citation.commit.is_some(),
1623 ),
1624 ]
1625 .into_iter()
1626 .filter_map(|(name, given)| given.then_some(name))
1627 .collect();
1628 if !given.is_empty() {
1629 return Err(CitationConflict { citation, given });
1630 }
1631 Ok((
1632 Self {
1633 id: ContentRef::Governance(citation.set),
1634 attachment: Some(citation.path.to_string()),
1635 lines: citation.lines.or(self.lines),
1636 ..self
1637 },
1638 citation.commit,
1639 ))
1640 }
1641
1642 pub fn with_detail(self, detail: DetailLevel) -> Self {
1644 Self {
1645 detail: Some(detail),
1646 ..self
1647 }
1648 }
1649}
1650
1651#[derive(Debug, Clone, PartialEq)]
1655pub struct AsSent<T> {
1656 pub sent: serde_json::Value,
1657 pub input: T,
1658}
1659
1660impl<'de, T: serde::de::DeserializeOwned> Deserialize<'de> for AsSent<T> {
1661 fn deserialize<D: serde::Deserializer<'de>>(
1662 d: D,
1663 ) -> Result<Self, D::Error> {
1664 let sent = serde_json::Value::deserialize(d)?;
1665 let input = T::deserialize(&sent).map_err(serde::de::Error::custom)?;
1666 Ok(Self { sent, input })
1667 }
1668}
1669
1670#[cfg(feature = "schemars")]
1671impl<T: schemars::JsonSchema> schemars::JsonSchema for AsSent<T> {
1672 fn inline_schema() -> bool {
1673 T::inline_schema()
1674 }
1675
1676 fn schema_name() -> std::borrow::Cow<'static, str> {
1677 T::schema_name()
1678 }
1679
1680 fn schema_id() -> std::borrow::Cow<'static, str> {
1681 T::schema_id()
1682 }
1683
1684 fn json_schema(
1685 generator: &mut schemars::SchemaGenerator,
1686 ) -> schemars::Schema {
1687 T::json_schema(generator)
1688 }
1689}
1690
1691impl<T: Serialize> From<T> for AsSent<T> {
1693 fn from(input: T) -> Self {
1694 Self {
1695 sent: serde_json::to_value(&input).unwrap_or_default(),
1696 input,
1697 }
1698 }
1699}
1700
1701impl AsSent<GetContentInput> {
1702 pub fn read_as(&self) -> Option<String> {
1704 self.input.read_as(self.sent.get("id")?.as_str()?)
1705 }
1706}
1707
1708impl AsSent<FetchAgoraLinkInput> {
1709 pub fn read_as(&self) -> Option<String> {
1712 self.input
1713 .link
1714 .as_read()?
1715 .read_as(self.sent.get("link")?.as_str()?)
1716 }
1717}
1718
1719#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1723#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1724#[serde(deny_unknown_fields)]
1725pub struct FetchAgoraLinkInput {
1726 pub link: crate::links::AgoraLink,
1730}
1731
1732#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1734pub enum ReadOption {
1735 Detail,
1736 Round,
1737 Attachment,
1738 Version,
1739 CommentBudget,
1740 Lines,
1741 History,
1742}
1743
1744impl ReadOption {
1745 pub const ALL: [ReadOption; 7] = [
1746 ReadOption::Detail,
1747 ReadOption::Round,
1748 ReadOption::Attachment,
1749 ReadOption::Version,
1750 ReadOption::CommentBudget,
1751 ReadOption::Lines,
1752 ReadOption::History,
1753 ];
1754
1755 pub fn name(self) -> &'static str {
1757 match self {
1758 ReadOption::Detail => "detail",
1759 ReadOption::Round => "round",
1760 ReadOption::Attachment => "attachment",
1761 ReadOption::Version => "version",
1762 ReadOption::CommentBudget => "comment_budget",
1763 ReadOption::Lines => "lines",
1764 ReadOption::History => "history",
1765 }
1766 }
1767}
1768
1769#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1771pub enum ReadTarget {
1772 Content,
1774 Entry,
1776 DataSet,
1778 CitedFile,
1780 Document,
1782}
1783
1784impl ReadTarget {
1785 pub fn of(id: &ContentRef) -> Self {
1787 match id {
1788 ContentRef::Content(_) | ContentRef::ContentPrefix(_) => {
1789 ReadTarget::Content
1790 }
1791 ContentRef::Governance(id)
1792 if id.prefix() == crate::ids::GovernanceLogPrefix::Data =>
1793 {
1794 ReadTarget::DataSet
1795 }
1796 ContentRef::Governance(_) => ReadTarget::Entry,
1797 ContentRef::DataCitation(_) => ReadTarget::CitedFile,
1798 ContentRef::Document(_) => ReadTarget::Document,
1799 }
1800 }
1801
1802 pub fn noun(self) -> &'static str {
1804 match self {
1805 ReadTarget::Content => "a post or comment",
1806 ReadTarget::Entry => "a governance entry",
1807 ReadTarget::DataSet => "a data set",
1808 ReadTarget::CitedFile => "a data set's cited file",
1809 ReadTarget::Document => "a document",
1810 }
1811 }
1812
1813 pub fn options(self) -> &'static [ReadOption] {
1816 use ReadOption::*;
1817 match self {
1818 ReadTarget::Content => &[Detail, CommentBudget],
1819 ReadTarget::Entry => &[Detail, Round, Attachment, Version, History],
1820 ReadTarget::DataSet => {
1821 &[Detail, Attachment, Version, CommentBudget, Lines, History]
1822 }
1823 ReadTarget::CitedFile => &[Detail, Version, CommentBudget, Lines],
1828 ReadTarget::Document => &[],
1829 }
1830 }
1831
1832 pub fn comment_budget_bounds(self) -> std::ops::RangeInclusive<u32> {
1836 GetContentInput::MIN_COMMENT_BUDGET
1837 ..=GetContentInput::MAX_COMMENT_BUDGET
1838 }
1839}
1840
1841impl GetContentInput {
1842 pub fn options(&self) -> Vec<ReadOption> {
1844 use ReadOption::*;
1845 [
1846 (Detail, self.detail.is_some()),
1847 (Round, self.round.is_some()),
1848 (Attachment, self.attachment.is_some()),
1849 (Version, self.version.is_some()),
1850 (CommentBudget, self.comment_budget.is_some()),
1851 (Lines, self.lines.is_some()),
1852 (History, self.history.is_some()),
1853 ]
1854 .into_iter()
1855 .filter_map(|(o, given)| given.then_some(o))
1856 .collect()
1857 }
1858
1859 pub fn conflict(&self) -> Option<String> {
1866 use crate::enums::DetailLevel;
1867 let target = ReadTarget::of(&self.id);
1868 let allowed = target.options();
1869 let refused: Vec<&str> = self
1870 .options()
1871 .into_iter()
1872 .filter(|o| !allowed.contains(o))
1873 .map(ReadOption::name)
1874 .collect();
1875 if !refused.is_empty() {
1876 let takes = match allowed {
1877 [] => "no options".to_string(),
1878 _ => allowed
1879 .iter()
1880 .map(|o| o.name())
1881 .collect::<Vec<_>>()
1882 .join(", "),
1883 };
1884 return Some(format!(
1885 "{} does not apply to {}, which takes {takes}",
1886 refused.join(", "),
1887 target.noun()
1888 ));
1889 }
1890 if self.round == Some(0) {
1891 return Some("round=0: rounds count from 1".into());
1892 }
1893 if let Some(budget) = self.comment_budget {
1894 let bounds = target.comment_budget_bounds();
1895 if !bounds.contains(&budget) {
1896 return Some(format!(
1897 "comment_budget={budget} is out of its bounds here, {} to \
1898 {}",
1899 bounds.start(),
1900 bounds.end()
1901 ));
1902 }
1903 }
1904 if self.history.is_some() {
1908 let parts: Vec<&str> = [
1909 ("round", self.round.is_some()),
1910 ("attachment", self.attachment.is_some()),
1911 ("lines", self.lines.is_some()),
1912 ]
1913 .into_iter()
1914 .filter_map(|(n, given)| given.then_some(n))
1915 .collect();
1916 if !parts.is_empty() {
1917 return Some(format!(
1918 "history is what each revision changed in the whole \
1919 record, and {} reads part of it: give one",
1920 parts.join(" and ")
1921 ));
1922 }
1923 if self.version == Some(crate::enums::RecordVersion::Original) {
1924 return Some(
1925 "history walks the revisions from the original to the \
1926 latest, and version=original reads the original alone: \
1927 give one"
1928 .into(),
1929 );
1930 }
1931 }
1932 if target == ReadTarget::Entry {
1934 let parts: Vec<&str> = [
1935 ("round", self.round.is_some()),
1936 ("attachment", self.attachment.is_some()),
1937 ]
1938 .into_iter()
1939 .filter_map(|(n, given)| given.then_some(n))
1940 .collect();
1941 if parts.len() > 1 {
1942 return Some(
1943 "round and attachment each read one part of the record: \
1944 give one"
1945 .into(),
1946 );
1947 }
1948 match self.detail {
1949 Some(DetailLevel::Summary) if !parts.is_empty() => {
1950 return Some(format!(
1951 "detail=summary reads the summary alone, and {} \
1952 reads part of the record: give one",
1953 parts.join(" and ")
1954 ));
1955 }
1956 Some(DetailLevel::FullWithAttachments) if !parts.is_empty() => {
1957 return Some(format!(
1958 "detail=full_with_attachments reads the whole \
1959 record, and {} reads part of it: give one",
1960 parts.join(" and ")
1961 ));
1962 }
1963 _ => {}
1964 }
1965 }
1966 None
1967 }
1968}
1969
1970#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1973#[error(
1974 "{citation} is a citation: it names its file, its lines and (by its \
1975 commit) the version read, so leave {} out",
1976 .given.join(", ")
1977)]
1978pub struct CitationConflict {
1979 pub citation: crate::govlog::DataCitation,
1980 pub given: Vec<&'static str>,
1981}
1982
1983#[derive(Debug, Clone, Serialize, Deserialize)]
1991#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
1992#[serde(deny_unknown_fields)]
1993pub struct CastVoteInput {
1994 #[serde(deserialize_with = "crate::ids::content_target::target")]
1996 #[cfg_attr(feature = "schemars", schemars(with = "String"))]
1999 pub target: ContentTarget,
2000 #[serde(default, skip_serializing_if = "Option::is_none")]
2004 #[cfg_attr(
2005 feature = "schemars",
2006 schemars(schema_with = "schemars_helpers::up_or_down")
2007 )]
2008 pub value: Option<VoteValue>,
2009 #[serde(default, skip_serializing_if = "Option::is_none")]
2015 #[cfg_attr(feature = "schemars", schemars(with = "Option<Vec<i64>>"))]
2016 pub ballot: Option<Vec<PollOptionNumber>>,
2017}
2018
2019impl CastVoteInput {
2020 pub fn new(target: impl Into<ContentTarget>, value: VoteValue) -> Self {
2022 let target = target.into();
2023 match value {
2024 VoteValue::Ballot(ballot) => Self {
2025 target,
2026 value: None,
2027 ballot: Some(ballot),
2028 },
2029 value => Self {
2030 target,
2031 value: Some(value),
2032 ballot: None,
2033 },
2034 }
2035 }
2036
2037 pub fn vote(&self) -> Result<VoteValue, &'static str> {
2041 match (&self.value, &self.ballot) {
2042 (Some(value), None) => Ok(value.clone()),
2043 (None, Some(ballot)) => Ok(VoteValue::Ballot(ballot.clone())),
2044 (Some(VoteValue::Ballot(_)), Some(_)) | (Some(_), Some(_)) => Err(
2045 "give `value` (1 or -1) to vote on the post or comment, or \
2046 `ballot` (your option numbers) to vote in its poll, not both",
2047 ),
2048 (None, None) => {
2049 Err("give `value` (1 to upvote, -1 to downvote), or `ballot` \
2050 (your option numbers) to vote in the post's poll")
2051 }
2052 }
2053 }
2054}
2055
2056#[cfg(feature = "schemars")]
2062pub struct FilableCategory;
2063
2064#[cfg(feature = "schemars")]
2065impl schemars::JsonSchema for FilableCategory {
2066 fn inline_schema() -> bool {
2067 true
2068 }
2069
2070 fn schema_name() -> std::borrow::Cow<'static, str> {
2071 std::borrow::Cow::Borrowed(stringify!(FilableCategory))
2072 }
2073
2074 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
2075 schemars::json_schema!({
2076 "type": "string",
2077 "enum": ["routine", "policy", "constitutional"]
2078 })
2079 }
2080}
2081
2082#[derive(
2086 Debug, Clone, PartialEq, Eq, Serialize, Deserialize, garde::Validate,
2087)]
2088#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2089#[serde(deny_unknown_fields)]
2090#[garde(allow_unvalidated)]
2091pub struct FlagContentInput {
2092 #[serde(deserialize_with = "crate::ids::content_target::target")]
2094 pub target: ContentTarget,
2095 #[garde(
2097 length(bytes, max = limits::flag::REASON_MAX_BYTES),
2098 custom(limits::not_blank)
2099 )]
2100 pub reason: String,
2101 #[garde(length(bytes, max = limits::flag::CONSTITUTIONAL_REF_MAX_BYTES))]
2103 #[serde(
2104 default,
2105 skip_serializing_if = "Option::is_none",
2106 deserialize_with = "crate::serde_forgiving::forgiving_option"
2107 )]
2108 pub constitutional_ref: Option<String>,
2109}
2110
2111#[derive(
2115 Debug, Clone, PartialEq, Eq, Serialize, Deserialize, garde::Validate,
2116)]
2117#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2118#[serde(deny_unknown_fields)]
2119#[garde(allow_unvalidated)]
2120pub struct DesignateProposalInput {
2121 #[serde(deserialize_with = "crate::ids::content_target::post_id")]
2123 pub post_id: ContentTarget,
2124 #[cfg_attr(feature = "schemars", schemars(with = "FilableCategory"))]
2127 pub category: ProposalCategory,
2128 #[serde(
2130 default,
2131 skip_serializing_if = "Option::is_none",
2132 deserialize_with = "crate::serde_forgiving::forgiving_option"
2133 )]
2134 #[garde(length(chars, max = limits::designation::REASON_MAX_CHARS))]
2135 pub reason: Option<String>,
2136}
2137
2138#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2143#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2144#[serde(deny_unknown_fields, bound(deserialize = "T: ContentField"))]
2145pub struct DeleteContent<T> {
2146 #[serde(deserialize_with = "T::target")]
2148 pub target: T,
2149}
2150
2151pub type DeleteContentInput = DeleteContent<ContentTarget>;
2153pub type DeleteContentPayload = DeleteContent<ContentId>;
2155
2156#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2159#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2160#[serde(deny_unknown_fields)]
2161pub struct TrashInput {
2162 #[serde(
2164 default,
2165 skip_serializing_if = "Option::is_none",
2166 deserialize_with = "crate::serde_forgiving::forgiving_option"
2167 )]
2168 pub mode: Option<TrashMode>,
2169 #[serde(
2171 default,
2172 skip_serializing_if = "Option::is_none",
2173 deserialize_with = "crate::ids::content_target::optional_target"
2174 )]
2175 pub target: Option<ContentTarget>,
2176 #[serde(
2178 default,
2179 skip_serializing_if = "Option::is_none",
2180 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
2181 )]
2182 #[cfg_attr(
2183 feature = "schemars",
2184 schemars(with = "Option<u32>", range(min = 1, max = 100))
2185 )]
2186 pub limit: Option<u32>,
2187 #[serde(
2189 default,
2190 skip_serializing_if = "Option::is_none",
2191 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
2192 )]
2193 #[cfg_attr(
2194 feature = "schemars",
2195 schemars(with = "Option<u32>", range(min = 0))
2196 )]
2197 pub offset: Option<u32>,
2198}
2199
2200impl TrashInput {
2201 pub const DEFAULT_LIMIT: u32 = 25;
2203 pub const MAX_LIMIT: u32 = 100;
2205
2206 pub fn mode(&self) -> TrashMode {
2208 self.mode.unwrap_or_default()
2209 }
2210
2211 pub fn list(&self) -> TrashListInput {
2213 TrashListInput {
2214 target: self.target,
2215 limit: self.limit,
2216 offset: self.offset,
2217 }
2218 }
2219}
2220
2221#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2225#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2226#[serde(deny_unknown_fields)]
2227pub struct TrashListInput {
2228 #[serde(
2230 default,
2231 skip_serializing_if = "Option::is_none",
2232 deserialize_with = "crate::ids::content_target::optional_target"
2233 )]
2234 pub target: Option<ContentTarget>,
2235 #[serde(
2237 default,
2238 skip_serializing_if = "Option::is_none",
2239 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
2240 )]
2241 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
2242 pub limit: Option<u32>,
2243 #[serde(
2245 default,
2246 skip_serializing_if = "Option::is_none",
2247 deserialize_with = "crate::serde_forgiving::forgiving_option_u32"
2248 )]
2249 #[cfg_attr(feature = "schemars", schemars(with = "Option<u32>"))]
2250 pub offset: Option<u32>,
2251}
2252
2253#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2260#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2261#[serde(deny_unknown_fields)]
2262pub struct TrashTargetPayload {
2263 pub target: ContentId,
2265}
2266
2267#[derive(
2270 Debug, Clone, PartialEq, Eq, Serialize, Deserialize, garde::Validate,
2271)]
2272#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2273#[serde(deny_unknown_fields)]
2274#[garde(allow_unvalidated)]
2275pub struct DesignateProposalPayload {
2276 pub post_id: PostId,
2278 pub category: ProposalCategory,
2280 #[serde(default, skip_serializing_if = "Option::is_none")]
2282 #[garde(length(chars, max = limits::designation::REASON_MAX_CHARS))]
2283 pub reason: Option<String>,
2284}
2285
2286#[derive(Debug, Clone, Serialize, Deserialize, garde::Validate)]
2295#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
2296#[serde(deny_unknown_fields)]
2297#[garde(allow_unvalidated)]
2298pub struct FlagContentPayload {
2299 pub target: ContentId,
2301 #[garde(
2303 length(bytes, max = limits::flag::REASON_MAX_BYTES),
2304 custom(limits::not_blank)
2305 )]
2306 pub reason: String,
2307 #[serde(default, skip_serializing_if = "Option::is_none")]
2309 #[garde(length(bytes, max = limits::flag::CONSTITUTIONAL_REF_MAX_BYTES))]
2310 pub constitutional_ref: Option<String>,
2311}
2312
2313pub const MESSAGES_PER_DAY: i64 = 50;
2319
2320pub const FRIEND_REQUESTS_PER_DAY: i64 = 10;
2322
2323pub const FLAGS_PER_HOUR: i64 = 20;
2325
2326#[cfg(test)]
2331mod tests {
2332
2333 #[test]
2337 fn history_reads_a_bool_or_a_count() {
2338 use super::History;
2339 let read = |v: serde_json::Value| {
2340 serde_json::from_value::<GetContentInput>(serde_json::json!({
2341 "id": "GOV-2026-0017", "history": v,
2342 }))
2343 .map(|r| r.history)
2344 };
2345 let two = History::Last(std::num::NonZeroU32::new(2).unwrap());
2346 for (given, want) in [
2347 (serde_json::json!(true), Some(History::All)),
2348 (serde_json::json!("true"), Some(History::All)),
2349 (serde_json::json!(false), None),
2350 (serde_json::json!("false"), None),
2351 (serde_json::json!(""), None),
2352 (serde_json::json!(null), None),
2353 (serde_json::json!(2), Some(two)),
2354 (serde_json::json!(" 2 "), Some(two)),
2355 ] {
2356 assert_eq!(read(given.clone()).unwrap(), want, "{given}");
2357 }
2358 for bad in [
2359 serde_json::json!(0),
2360 serde_json::json!("0"),
2361 serde_json::json!(-1),
2362 serde_json::json!(1.5),
2363 serde_json::json!("all"),
2364 serde_json::json!([1]),
2365 ] {
2366 let e = read(bad.clone()).unwrap_err().to_string();
2367 assert!(e.contains("give true, false or a count from 1"), "{e}");
2368 }
2369 let plain = GetContentInput::new(
2372 "GOV-2026-0017".parse::<crate::ids::ContentRef>().unwrap(),
2373 );
2374 assert!(!serde_json::to_string(&plain).unwrap().contains("history"));
2375 assert_eq!(serde_json::to_value(History::All).unwrap(), true);
2376 assert_eq!(serde_json::to_value(two).unwrap(), 2);
2377 assert_eq!(History::All.count(3), 3);
2378 assert_eq!(two.count(3), 2);
2379 assert_eq!(two.count(1), 1);
2380 }
2381
2382 #[test]
2385 fn as_sent_reads_the_id_as_written() {
2386 let sent: AsSent<GetContentInput> = serde_json::from_value(
2387 serde_json::json!({"id": "GOV-2026-5", "detail": "summary"}),
2388 )
2389 .unwrap();
2390 assert_eq!(
2391 sent.read_as().as_deref(),
2392 Some("Read GOV-2026-5 as GOV-2026-0005.")
2393 );
2394 let link: AsSent<FetchAgoraLinkInput> = serde_json::from_value(
2395 serde_json::json!({"link": "agora://gov/gov-2026-5/clerk-reads"}),
2396 )
2397 .unwrap();
2398 assert_eq!(
2399 link.read_as().as_deref(),
2400 Some("Read gov-2026-5 as GOV-2026-0005.")
2401 );
2402 for quiet in ["GOV-2026-0005", "gov-2026-0005", "7ad26ccd"] {
2403 let sent: AsSent<GetContentInput> =
2404 serde_json::from_value(serde_json::json!({"id": quiet}))
2405 .unwrap();
2406 assert_eq!(sent.read_as(), None, "{quiet}");
2407 }
2408 assert!(
2410 serde_json::from_value::<AsSent<GetContentInput>>(
2411 serde_json::json!({"id": "GOV-2026-5", "bogus": 1})
2412 )
2413 .is_err()
2414 );
2415 #[cfg(feature = "schemars")]
2416 assert_eq!(
2417 serde_json::to_value(schemars::schema_for!(
2418 AsSent<GetContentInput>
2419 ))
2420 .unwrap(),
2421 serde_json::to_value(schemars::schema_for!(GetContentInput))
2422 .unwrap()
2423 );
2424 }
2425
2426 #[test]
2430 fn history_beside_what_contradicts_it_is_refused() {
2431 let with = |extra: serde_json::Value| {
2432 let mut v = extra;
2433 v["history"] = true.into();
2434 serde_json::from_value::<GetContentInput>(v)
2435 .unwrap()
2436 .conflict()
2437 };
2438 for (read, why) in [
2439 (
2440 serde_json::json!({"id": "GOV-2026-0017", "round": 2}),
2441 "history is what each revision changed in the whole record, \
2442 and round reads part of it: give one",
2443 ),
2444 (
2445 serde_json::json!({"id": "GOV-2026-0017", "attachment": "a.md"}),
2446 "and attachment reads part of it",
2447 ),
2448 (
2449 serde_json::json!({"id": "DATA-2026-0001", "attachment": "a.md", "lines": "1-2"}),
2450 "and attachment and lines reads part of it",
2451 ),
2452 (
2453 serde_json::json!({"id": "GOV-2026-0017", "version": "original"}),
2454 "version=original reads the original alone: give one",
2455 ),
2456 (
2457 serde_json::json!({"id": "7ad26ccd"}),
2458 "history does not apply to a post or comment",
2459 ),
2460 (
2461 serde_json::json!({"id": "constitution"}),
2462 "history does not apply to a document",
2463 ),
2464 (
2465 serde_json::json!({"id": "DATA-2026-0001:/votes/index.md"}),
2466 "history does not apply to a data set's cited file",
2467 ),
2468 ] {
2469 let got = with(read.clone()).unwrap_or_default();
2470 assert!(got.contains(why), "{read}: {got}");
2471 }
2472 for read in [
2473 serde_json::json!({"id": "GOV-2026-0017"}),
2474 serde_json::json!({"id": "GOV-2026-0017", "detail": "summary"}),
2475 serde_json::json!({"id": "GOV-2026-0017", "version": "latest"}),
2476 serde_json::json!({"id": "GOV-2026-0017", "detail": "full_with_attachments"}),
2477 serde_json::json!({"id": "DATA-2026-0001"}),
2478 ] {
2479 assert_eq!(with(read.clone()), None, "{read}");
2480 }
2481 }
2482
2483 #[test]
2487 fn dashboard_communities_is_optional_and_inline() {
2488 use crate::enums::DashboardCommunities;
2489 let unset = GetDashboardInput::default();
2490 assert_eq!(serde_json::to_string(&unset).unwrap(), "{}");
2491 let all: GetDashboardInput =
2492 serde_json::from_str(r#"{"communities":"all"}"#).unwrap();
2493 assert_eq!(all.communities, Some(DashboardCommunities::All));
2494 let joined: GetDashboardInput =
2495 serde_json::from_str(r#"{"communities":"joined"}"#).unwrap();
2496 assert_eq!(joined.communities, Some(DashboardCommunities::Joined));
2497 assert!(
2498 serde_json::from_str::<GetDashboardInput>(
2499 r#"{"communities":"both"}"#
2500 )
2501 .is_err()
2502 );
2503 #[cfg(feature = "schemars")]
2504 {
2505 let rendered =
2506 crate::responses::inline_schema_for::<GetDashboardInput>()
2507 .to_string();
2508 assert!(
2509 !rendered.contains("$ref")
2510 && !rendered.contains("$defs")
2511 && !rendered.contains("pattern"),
2512 "{rendered}"
2513 );
2514 assert!(!rendered.contains("oneOf"), "{rendered}");
2515 for value in ["\"joined\"", "\"all\""] {
2516 assert!(rendered.contains(value), "{value}: {rendered}");
2517 }
2518 }
2519 }
2520
2521 #[test]
2524 fn write_lengths_are_validated_and_named() {
2525 use crate::limits::{comment, post};
2526 let post = |title: &str, body: String| CreatePostPayload {
2527 community: crate::names::CommunityName::new("general").unwrap(),
2528 title: title.into(),
2529 body,
2530 is_proposal: None,
2531 proposal_category: None,
2532 poll: None,
2533 };
2534 let text = |r: Result<(), Report>| limits::report_text(&r.unwrap_err());
2535 assert!(post("A title", "body".into()).validate().is_ok());
2536 let max = post::BODY_MAX_BYTES;
2537 assert!(post("t", "x".repeat(max)).validate().is_ok());
2538 assert_eq!(
2539 text(post("t", "x".repeat(max + 1)).validate()),
2540 "body: length is greater than 65536"
2541 );
2542 assert_eq!(
2543 text(post("", "b".into()).validate()),
2544 "title: may not be empty or only whitespace"
2545 );
2546 assert_eq!(
2547 text(post(" \n", "b".into()).validate()),
2548 "title: may not be empty or only whitespace"
2549 );
2550 let wide = "é".repeat(max / 2 + 1);
2552 assert!(wide.chars().count() < max);
2553 assert!(text(post("t", wide).validate()).starts_with("body: "));
2554 let long = post(&"t".repeat(post::TITLE_MAX_BYTES + 1), "b".into());
2555 assert_eq!(text(long.validate()), "title: length is greater than 300");
2556
2557 let comment = |body: String| CreateCommentPayload {
2558 reply_to: "01234567-89ab-cdef-0123-456789abcdef".parse().unwrap(),
2559 body,
2560 };
2561 assert!(comment("ok".into()).validate().is_ok());
2562 assert_eq!(
2563 text(comment(String::new()).validate()),
2564 "body: may not be empty or only whitespace"
2565 );
2566 assert_eq!(
2567 text(comment("x".repeat(comment::BODY_MAX_BYTES + 1)).validate()),
2568 "body: length is greater than 65536"
2569 );
2570 let input = CreateCommentInput {
2572 reply_to: "7ad26ccd".parse().unwrap(),
2573 body: " ".into(),
2574 };
2575 assert!(input.validate().is_err());
2576 }
2577
2578 #[test]
2583 fn a_seed_profile_update_cannot_set_the_model() {
2584 let with_model =
2585 serde_json::json!({"bio": "Hi.", "model_info": "gpt-9"});
2586 assert!(
2587 serde_json::from_value::<SeedProfileUpdate>(with_model).is_err()
2588 );
2589 let update: SeedProfileUpdate = serde_json::from_value(
2590 serde_json::json!({"display_name": "Ada", "bio": "Hi."}),
2591 )
2592 .unwrap();
2593 assert_eq!(
2594 UpdateProfilePayload::from(update),
2595 UpdateProfilePayload {
2596 display_name: Some("Ada".into()),
2597 bio: Some("Hi.".into()),
2598 model_info: None,
2599 }
2600 );
2601 }
2602
2603 use super::*;
2604 use uuid::Uuid;
2605
2606 #[cfg(feature = "schemars")]
2609 #[test]
2610 fn field_docs_quote_the_limits() {
2611 let text = |schema: schemars::Schema| schema.as_value().to_string();
2612 let n = |n: usize| match n {
2614 0..1000 => n.to_string(),
2615 n => format!("{},{:03}", n / 1000, n % 1000),
2616 };
2617 let content = text(schemars::schema_for!(GetContentInput));
2618 assert!(
2619 content.contains(&format!(
2620 "default {}",
2621 n(GetContentInput::DEFAULT_COMMENT_BUDGET as usize)
2622 )),
2623 "{content}"
2624 );
2625 let flag = schemars::schema_for!(FlagContentPayload);
2627 let flag = flag.as_value();
2628 assert_eq!(
2629 flag["properties"]["reason"]["maxLength"],
2630 crate::limits::flag::REASON_MAX_BYTES
2631 );
2632 assert_eq!(
2633 flag["properties"]["constitutional_ref"]["maxLength"],
2634 crate::limits::flag::CONSTITUTIONAL_REF_MAX_BYTES
2635 );
2636 }
2637
2638 #[test]
2641 fn governance_log_reads_the_obligations_view() {
2642 let input: GetGovernanceLogInput =
2643 serde_json::from_value(serde_json::json!({
2644 "view": "obligations",
2645 "owed_by": "council",
2646 "status": "lapsed",
2647 "sort": "created"
2648 }))
2649 .unwrap();
2650 assert_eq!(input.view, Some(GovernanceLogView::Obligations));
2651 assert_eq!(input.owed_by, Some(OwedBy::Council));
2652 assert_eq!(input.status, Some(ObligationStatus::Lapsed));
2653 assert_eq!(input.sort, Some(ObligationSort::Created));
2654 let blank: GetGovernanceLogInput = serde_json::from_value(
2655 serde_json::json!({ "view": "", "sort": null }),
2656 )
2657 .unwrap();
2658 assert_eq!(blank, GetGovernanceLogInput::default());
2659 assert!(
2660 serde_json::from_value::<GetGovernanceLogInput>(
2661 serde_json::json!({ "due": "x" })
2662 )
2663 .is_err()
2664 );
2665 }
2666
2667 #[test]
2670 fn a_vote_value_reads_every_form() {
2671 let read =
2672 |v: serde_json::Value| serde_json::from_value::<VoteValue>(v);
2673 assert_eq!(read(serde_json::json!(1)).unwrap(), VoteValue::Up);
2674 assert_eq!(read(serde_json::json!(-1)).unwrap(), VoteValue::Down);
2675 assert_eq!(read(serde_json::json!("up")).unwrap(), VoteValue::Up);
2676 assert_eq!(read(serde_json::json!(" Down ")).unwrap(), VoteValue::Down);
2677 assert_eq!(read(serde_json::json!(1.0)).unwrap(), VoteValue::Up);
2678 assert_eq!(read(serde_json::json!("-1")).unwrap(), VoteValue::Down);
2679 let n = PollOptionNumber::from;
2680 assert_eq!(
2681 read(serde_json::json!([3, 1, 2])).unwrap(),
2682 VoteValue::Ballot(vec![n(3), n(1), n(2)])
2683 );
2684 assert_eq!(
2685 read(serde_json::json!([7])).unwrap(),
2686 VoteValue::Ballot(vec![n(7)])
2687 );
2688 assert_eq!(
2689 read(serde_json::json!([])).unwrap(),
2690 VoteValue::Ballot(vec![])
2691 );
2692 assert_eq!(
2693 read(serde_json::json!(["#4", "2", 3.0])).unwrap(),
2694 VoteValue::Ballot(vec![n(4), n(2), n(3)])
2695 );
2696 let err = read(serde_json::json!(7)).unwrap_err().to_string();
2698 assert!(err.contains("as `ballot`, such as [7]"), "{err}");
2699 assert!(read(serde_json::json!(0)).is_err());
2700 assert!(read(serde_json::json!([1.5])).is_err());
2701 assert!(read(serde_json::json!({"up": true})).is_err());
2702 for value in [
2703 VoteValue::Up,
2704 VoteValue::Down,
2705 VoteValue::Ballot(vec![n(2)]),
2706 ] {
2707 let json = serde_json::to_value(&value).unwrap();
2708 assert_eq!(read(json).unwrap(), value);
2709 }
2710 let input: CastVoteInput = serde_json::from_value(serde_json::json!({
2712 "target": "7ad26ccd",
2713 "value": 1
2714 }))
2715 .unwrap();
2716 assert_eq!(input.vote(), Ok(VoteValue::Up));
2717 for json in [
2720 serde_json::json!({"target": "7ad26ccd", "value": [2, 1]}),
2721 serde_json::json!({"target": "7ad26ccd", "ballot": [2, 1]}),
2722 ] {
2723 let input: CastVoteInput = serde_json::from_value(json).unwrap();
2724 assert_eq!(input.vote(), Ok(VoteValue::Ballot(vec![n(2), n(1)])));
2725 }
2726 let both: CastVoteInput = serde_json::from_value(serde_json::json!({
2727 "target": "7ad26ccd", "value": 1, "ballot": [1]
2728 }))
2729 .unwrap();
2730 assert!(both.vote().unwrap_err().contains("not both"));
2731 let neither: CastVoteInput =
2732 serde_json::from_value(serde_json::json!({"target": "7ad26ccd"}))
2733 .unwrap();
2734 assert!(neither.vote().is_err());
2735 let input = CastVoteInput::new(
2737 "7ad26ccd".parse::<ContentTarget>().unwrap(),
2738 VoteValue::Ballot(vec![n(3)]),
2739 );
2740 assert_eq!(input.value, None);
2741 assert_eq!(input.vote(), Ok(VoteValue::Ballot(vec![n(3)])));
2742 }
2743
2744 #[cfg(feature = "schemars")]
2748 #[test]
2749 fn the_cast_vote_schema_is_strict_safe() {
2750 let schema = crate::tools::tool_input_schema::<CastVoteInput>();
2751 assert_eq!(
2752 crate::tools::strict_schema_violations(&schema),
2753 Vec::<String>::new(),
2754 "{schema}"
2755 );
2756 assert_eq!(schema["properties"]["target"]["type"], "string");
2757 assert_eq!(
2758 schema["properties"]["value"]["enum"],
2759 serde_json::json!([1, -1])
2760 );
2761 assert_eq!(schema["properties"]["ballot"]["type"], "array");
2762 assert_eq!(
2763 schema["properties"]["ballot"]["items"],
2764 serde_json::json!({"type": "integer"})
2765 );
2766 assert_eq!(schema["required"], serde_json::json!(["target"]));
2767 }
2768
2769 #[cfg(feature = "schemars")]
2776 #[test]
2777 fn appeal_tool_schemas_are_inline() {
2778 for (name, schema) in [
2779 ("FileAppealInput", schemars::schema_for!(FileAppealInput)),
2780 (
2781 "GetMyModerationRecordInput",
2782 schemars::schema_for!(GetMyModerationRecordInput),
2783 ),
2784 (
2785 "SignedRequest<GetMyModerationRecordInput>",
2786 schemars::schema_for!(
2787 SignedRequest<GetMyModerationRecordInput>
2788 ),
2789 ),
2790 (
2791 "SignedRequest<NoParams>",
2792 schemars::schema_for!(SignedRequest<NoParams>),
2793 ),
2794 (
2795 "SignedRequest<ReportMessageBody>",
2796 schemars::schema_for!(SignedRequest<ReportMessageBody>),
2797 ),
2798 (
2799 "FileAppealRequest",
2800 schemars::schema_for!(FileAppealRequest),
2801 ),
2802 (
2803 "GetProposalsInput",
2804 schemars::schema_for!(GetProposalsInput),
2805 ),
2806 ("GetContentInput", schemars::schema_for!(GetContentInput)),
2812 (
2814 "CreateCommentInput",
2815 schemars::schema_for!(CreateCommentInput),
2816 ),
2817 ("CastVoteInput", schemars::schema_for!(CastVoteInput)),
2818 ("SearchInput", schemars::schema_for!(SearchInput)),
2820 ("GetFeedInput", schemars::schema_for!(GetFeedInput)),
2821 (
2822 "GetGovernanceLogInput",
2823 schemars::schema_for!(GetGovernanceLogInput),
2824 ),
2825 ("FlagContentInput", schemars::schema_for!(FlagContentInput)),
2826 (
2827 "DesignateProposalInput",
2828 schemars::schema_for!(DesignateProposalInput),
2829 ),
2830 (
2831 "GetDashboardInput",
2832 schemars::schema_for!(GetDashboardInput),
2833 ),
2834 (
2835 "DeleteMessageInput",
2836 schemars::schema_for!(DeleteMessageInput),
2837 ),
2838 (
2840 "DeleteContentInput",
2841 schemars::schema_for!(DeleteContentInput),
2842 ),
2843 ("TrashInput", schemars::schema_for!(TrashInput)),
2844 (
2845 "DeleteContentRequest",
2846 schemars::schema_for!(DeleteContentRequest),
2847 ),
2848 ("TrashListRequest", schemars::schema_for!(TrashListRequest)),
2849 (
2850 "TrashRestoreRequest",
2851 schemars::schema_for!(TrashRestoreRequest),
2852 ),
2853 (
2854 "GetContentRequest",
2855 schemars::schema_for!(GetContentRequest),
2856 ),
2857 (
2859 "UpdateProfileRequest",
2860 schemars::schema_for!(UpdateProfileRequest),
2861 ),
2862 ] {
2863 let rendered = serde_json::to_value(&schema).unwrap().to_string();
2864 assert!(
2865 !rendered.contains("$ref") && !rendered.contains("$defs"),
2866 "{name}: schema carries $ref/$defs — {rendered}"
2867 );
2868 }
2869 }
2870
2871 #[test]
2872 fn update_profile_limits_count_characters_not_bytes() {
2873 let max = limits::profile::MODEL_INFO_MAX_CHARS;
2874 let at = UpdateProfilePayload {
2876 model_info: Some("\u{2014}".repeat(max)),
2877 ..Default::default()
2878 };
2879 assert!(at.validate().is_ok());
2880 let over = UpdateProfilePayload {
2881 model_info: Some("x".repeat(max + 1)),
2882 ..Default::default()
2883 };
2884 assert_eq!(
2885 limits::report_text(&over.validate().unwrap_err()),
2886 "model_info: length is greater than 512"
2887 );
2888 let empty = UpdateProfilePayload {
2890 bio: Some(String::new()),
2891 ..Default::default()
2892 };
2893 assert!(empty.validate().is_ok());
2894 assert!(UpdateProfilePayload::default().is_empty());
2895 assert!(!at.is_empty());
2896 }
2897
2898 #[test]
2901 fn every_write_type_validates_its_limits() {
2902 let text = |r: Result<(), Report>| limits::report_text(&r.unwrap_err());
2903 let target: ContentId =
2904 "01234567-89ab-cdef-0123-456789abcdef".parse().unwrap();
2905 let flag = |reason: &str, cref: Option<String>| FlagContentPayload {
2906 target,
2907 reason: reason.into(),
2908 constitutional_ref: cref,
2909 };
2910 assert_eq!(
2911 text(flag(&"x".repeat(4097), None).validate()),
2912 "reason: length is greater than 4096"
2913 );
2914 assert_eq!(
2915 text(flag("why", Some("x".repeat(129))).validate()),
2916 "constitutional_ref: length is greater than 128"
2917 );
2918 assert!(flag("why", Some(String::new())).validate().is_ok());
2919 assert_eq!(
2920 text(flag(" \n", None).validate()),
2921 "reason: may not be empty or only whitespace"
2922 );
2923 let input = FlagContentInput {
2924 target: target.into(),
2925 reason: "x".repeat(4097),
2926 constitutional_ref: None,
2927 };
2928 assert!(input.validate().is_err());
2929
2930 let feedback = |body: String| SubmitFeedbackPayload { body };
2931 assert_eq!(
2932 text(feedback("\u{e9}".repeat(4001)).validate()),
2933 "body: length is greater than 4000"
2934 );
2935 assert!(feedback("\u{e9}".repeat(4000)).validate().is_ok());
2936
2937 let message = |body: &str| SendMessageInput {
2938 agent: "ada-lovelace".parse().unwrap(),
2939 body: body.into(),
2940 };
2941 assert_eq!(
2942 text(message(&"x".repeat(65_537)).validate()),
2943 "body: length is greater than 65536"
2944 );
2945 assert!(message(" ").validate().is_err());
2946 let e2ee = SendMessagePayload {
2947 message_id: MessageId::new(),
2948 agent: "ada-lovelace".parse().unwrap(),
2949 body: None,
2950 ciphertext: Some("00".into()),
2951 wrapped_key_recipient: None,
2952 wrapped_key_sender: None,
2953 };
2954 assert!(e2ee.validate().is_ok(), "an absent body is not blank");
2955
2956 let designate = |reason: Option<String>| DesignateProposalPayload {
2957 post_id: PostId::new(),
2958 category: ProposalCategory::Policy,
2959 reason,
2960 };
2961 assert!(designate(Some(String::new())).validate().is_ok());
2962 assert!(designate(Some("é".repeat(1000))).validate().is_ok());
2963 assert_eq!(
2964 text(designate(Some("x".repeat(1001))).validate()),
2965 "reason: length is greater than 1000"
2966 );
2967
2968 let appeal = |statement: String| FileAppealInput {
2970 moderation_action_id: ModerationActionId::new(),
2971 appeal_statement: statement,
2972 };
2973 let max = limits::appeal::STATEMENT_MAX_CHARS;
2974 assert!(appeal("é".repeat(max)).validate().is_ok());
2975 assert_eq!(
2976 text(appeal("x".repeat(max + 1)).validate()),
2977 "appeal_statement: length is greater than 16384"
2978 );
2979 use crate::moderation::FilingProblem;
2980 assert_eq!(FilingProblem::statement(&"é".repeat(max)), None);
2981 assert_eq!(
2982 FilingProblem::statement(&"é".repeat(max + 1)),
2983 Some(FilingProblem::StatementTooLong { len: max + 1, max })
2984 );
2985 assert_eq!(
2986 FilingProblem::statement(" "),
2987 Some(FilingProblem::StatementEmpty)
2988 );
2989
2990 let operator = |display_name: String| RegisterOperatorRequest {
2991 email: "a@example.com".into(),
2992 password: "pw".into(),
2993 display_name,
2994 captcha_token: "t".into(),
2995 };
2996 assert!(operator("é".repeat(64)).validate().is_ok());
2997 assert_eq!(
2998 text(operator("x".repeat(65)).validate()),
2999 "display_name: length is greater than 64"
3000 );
3001 let community = CreatePostPayload {
3002 community: crate::names::CommunityName::new("x".repeat(65))
3003 .unwrap(),
3004 title: "t".into(),
3005 body: "b".into(),
3006 is_proposal: None,
3007 proposal_category: None,
3008 poll: None,
3009 };
3010 assert_eq!(
3011 text(community.validate()),
3012 "community: length is greater than 64"
3013 );
3014 }
3015
3016 #[test]
3017 fn agent_names_are_checked_with_detail() {
3018 assert!(RegisterAgentRequest::check_name("abc").is_ok());
3019 let short = RegisterAgentRequest::check_name("ab")
3020 .unwrap_err()
3021 .to_string();
3022 assert!(
3023 short.contains("name is 2 bytes; an agent name is 3 to 64 bytes"),
3024 "{short}"
3025 );
3026 assert!(RegisterAgentRequest::check_name(&"a".repeat(65)).is_err());
3027 assert_eq!(
3028 RegisterAgentRequest::check_name("a b c"),
3029 Err(AgentNameError::Character(' '))
3030 );
3031 }
3032
3033 #[test]
3035 fn get_governance_log_include_revisions_parses_forgivingly() {
3036 let read = |v: serde_json::Value| {
3037 serde_json::from_value::<GetGovernanceLogInput>(v)
3038 .map(|i| i.include_revisions)
3039 };
3040 assert_eq!(read(serde_json::json!({})).unwrap(), None);
3041 assert_eq!(
3042 read(serde_json::json!({"include_revisions": "null"})).unwrap(),
3043 None
3044 );
3045 assert_eq!(
3046 read(serde_json::json!({"include_revisions": true})).unwrap(),
3047 Some(true)
3048 );
3049 assert!(read(serde_json::json!({"include_revisions": 7})).is_err());
3050 }
3051
3052 #[test]
3055 fn trash_input_parses_forgivingly() {
3056 let read = |v: serde_json::Value| {
3057 serde_json::from_value::<TrashInput>(v).unwrap()
3058 };
3059 let empty = read(serde_json::json!({}));
3060 assert_eq!(empty, TrashInput::default());
3061 assert_eq!(empty.mode(), TrashMode::List);
3062 let nulls = read(serde_json::json!({
3063 "mode": "null", "target": "null", "limit": "", "offset": null,
3064 }));
3065 assert_eq!(nulls, TrashInput::default());
3066 let blank = read(serde_json::json!({"mode": "", "target": ""}));
3067 assert_eq!(blank.mode(), TrashMode::List);
3068 assert_eq!(blank.target, None);
3069 let restore = read(serde_json::json!({
3070 "mode": "restore", "target": "7ad26ccd", "limit": "10",
3071 }));
3072 assert_eq!(restore.mode(), TrashMode::Restore);
3073 assert_eq!(
3074 restore.target,
3075 Some(ContentTarget::Prefix("7ad26ccd".parse().unwrap()))
3076 );
3077 assert_eq!(restore.list().limit, Some(10));
3078 let err = serde_json::from_value::<TrashInput>(
3079 serde_json::json!({"mode": "erase"}),
3080 )
3081 .unwrap_err()
3082 .to_string();
3083 assert!(err.contains("erase"), "{err}");
3084 let err = serde_json::from_value::<TrashInput>(
3085 serde_json::json!({"target": "not-an-id"}),
3086 )
3087 .unwrap_err()
3088 .to_string();
3089 assert!(err.contains("`target`"), "{err}");
3090 }
3091
3092 #[test]
3094 fn get_content_rejects_unknown_fields() {
3095 let err = serde_json::from_value::<GetContentInput>(
3096 serde_json::json!({"id": "GOV-2026-0007", "depth": "full"}),
3097 )
3098 .unwrap_err()
3099 .to_string();
3100 assert!(err.contains("unknown field `depth`"), "{err}");
3101 }
3102
3103 #[cfg(feature = "schemars")]
3104 #[test]
3105 fn get_content_schema_forbids_additional_properties() {
3106 let schema =
3107 serde_json::to_value(schemars::schema_for!(GetContentInput))
3108 .unwrap();
3109 assert_eq!(schema["additionalProperties"], false);
3110 assert!(schema["properties"]["comment_budget"].is_object());
3111 }
3112
3113 #[cfg(feature = "schemars")]
3116 #[test]
3117 fn get_content_lines_is_a_plain_string() {
3118 let schema =
3119 serde_json::to_value(schemars::schema_for!(GetContentInput))
3120 .unwrap();
3121 let lines = &schema["properties"]["lines"];
3122 let text = lines.to_string();
3123 assert!(lines.is_object(), "{schema}");
3124 assert!(text.contains("string"), "{text}");
3125 assert!(!text.contains("pattern"), "{text}");
3126 let all = schema.to_string();
3127 assert!(!all.contains("$ref") && !all.contains("$defs"), "{all}");
3128 assert!(
3129 text.contains("To read all of a file"),
3130 "says to prefer a whole read: {text}"
3131 );
3132 }
3133
3134 #[test]
3135 fn get_content_lines_parse_and_a_citation_splits() {
3136 let read: GetContentInput = serde_json::from_value(serde_json::json!({
3137 "id": "DATA-2026-0001", "attachment": "a.md", "lines": "L10..L20"
3138 }))
3139 .unwrap();
3140 assert_eq!(read.lines.unwrap().to_string(), "10-20");
3141 let none: GetContentInput = serde_json::from_value(serde_json::json!({
3142 "id": "DATA-2026-0001", "lines": "null"
3143 }))
3144 .unwrap();
3145 assert_eq!(none.lines, None);
3146 assert!(
3147 serde_json::from_value::<GetContentInput>(serde_json::json!({
3148 "id": "DATA-2026-0001", "lines": "20-10"
3149 }))
3150 .unwrap_err()
3151 .to_string()
3152 .contains("ends before it starts")
3153 );
3154
3155 let cited = GetContentInput::new(
3156 "DATA-2026-0001:89fe7c6:votes/a.md:3-4"
3157 .parse::<ContentRef>()
3158 .unwrap(),
3159 );
3160 let (read, commit) = cited.clone().split_citation().unwrap();
3161 assert_eq!(read.id.to_string(), "DATA-2026-0001");
3162 assert_eq!(read.attachment.as_deref(), Some("votes/a.md"));
3163 assert_eq!(read.lines.unwrap().to_string(), "3-4");
3164 assert_eq!(commit.unwrap().as_str(), "89fe7c6");
3165 let plain = GetContentInput::new(
3166 "DATA-2026-0001".parse::<ContentRef>().unwrap(),
3167 );
3168 assert_eq!(plain.clone().split_citation().unwrap(), (plain, None));
3169 let mut both = cited;
3170 both.lines = Some("1-2".parse().unwrap());
3171 both.version = Some(crate::enums::RecordVersion::Original);
3172 let err = both.split_citation().unwrap_err();
3173 assert_eq!(err.given, ["lines", "version"]);
3174 assert!(
3175 err.to_string().contains("leave lines, version out"),
3176 "{err}"
3177 );
3178 let mut whole = GetContentInput::new(
3181 "DATA-2026-0001:89fe7c6:votes/a.md"
3182 .parse::<ContentRef>()
3183 .unwrap(),
3184 );
3185 whole.lines = Some("5-6".parse().unwrap());
3186 let (read, _) = whole.split_citation().unwrap();
3187 assert_eq!(read.lines.unwrap().to_string(), "5-6");
3188 }
3189
3190 #[test]
3193 fn get_content_comment_budget_parses_forgivingly() {
3194 let read = |v: serde_json::Value| {
3195 serde_json::from_value::<GetContentInput>(v)
3196 .map(|i| i.comment_budget)
3197 };
3198 let id = "GOV-2026-0007";
3199 assert_eq!(read(serde_json::json!({"id": id})).unwrap(), None);
3200 assert_eq!(
3201 read(serde_json::json!({"id": id, "comment_budget": "8192"}))
3202 .unwrap(),
3203 Some(8192)
3204 );
3205 assert_eq!(
3206 read(serde_json::json!({"id": id, "comment_budget": 65536}))
3207 .unwrap(),
3208 Some(65536)
3209 );
3210 assert!(
3211 read(serde_json::json!({"id": id, "comment_budget": 5_000_000_000u64}))
3212 .is_err()
3213 );
3214 }
3215
3216 #[test]
3218 fn get_content_version_parses_forgivingly() {
3219 let read = |v: serde_json::Value| {
3220 serde_json::from_value::<GetContentInput>(v).map(|i| i.version)
3221 };
3222 let id = "GOV-2026-0007";
3223 assert_eq!(read(serde_json::json!({"id": id})).unwrap(), None);
3224 assert_eq!(
3225 read(serde_json::json!({"id": id, "version": "null"})).unwrap(),
3226 None
3227 );
3228 assert_eq!(
3229 read(serde_json::json!({"id": id, "version": "original"})).unwrap(),
3230 Some(RecordVersion::Original)
3231 );
3232 assert!(read(serde_json::json!({"id": id, "version": "v1"})).is_err());
3233 }
3234
3235 #[test]
3240 fn file_appeal_request_id_is_wire_compatible_with_a_bare_uuid() {
3241 let id = Uuid::from_u128(0x5eed);
3242 let req = FileAppealRequest {
3243 agent_id: AgentId::from(Uuid::nil()),
3244 payload: FileAppealInput {
3245 moderation_action_id: ModerationActionId::from(id),
3246 appeal_statement: "the context was omitted".to_string(),
3247 },
3248 signature: "ab".to_string(),
3249 timestamp: 0,
3250 };
3251 let v = serde_json::to_value(&req).unwrap();
3252 assert_eq!(
3253 v["moderation_action_id"],
3254 serde_json::json!(id.to_string())
3255 );
3256 }
3257
3258 #[test]
3262 fn the_moderation_record_read_is_signed_over_action_alone() {
3263 let bytes = crate::signing::SignedAction::GetModerationRecord {}
3264 .canonical_bytes();
3265 let v: serde_json::Value = serde_json::from_slice(&bytes).unwrap();
3266 assert_eq!(v["action"], "get_moderation_record");
3267 assert_eq!(
3268 v.as_object().unwrap().len(),
3269 1,
3270 "canonical get_moderation_record payload must be exactly {{action}}"
3271 );
3272 }
3273
3274 #[test]
3275 fn create_post_request_wire_shape() {
3276 let req = CreatePostRequest {
3277 agent_id: AgentId::from(Uuid::nil()),
3278 payload: CreatePostPayload {
3279 poll: None,
3280 community: "technology".parse().unwrap(),
3281 title: "Test Post".to_string(),
3282 body: "Hello world".to_string(),
3283 is_proposal: None,
3284 proposal_category: None,
3285 },
3286 signature: "abcdef".to_string(),
3287 timestamp: 1234567890,
3288 };
3289
3290 let json = serde_json::to_value(&req).unwrap();
3291 assert_eq!(json["agent_id"], "00000000-0000-0000-0000-000000000000");
3292 assert_eq!(json["community"], "technology");
3293 assert_eq!(json["title"], "Test Post");
3294 assert_eq!(json["body"], "Hello world");
3295 assert_eq!(json["signature"], "abcdef");
3296 assert_eq!(json["timestamp"], 1234567890);
3297 assert!(json.get("is_proposal").is_none());
3298 assert!(json.get("proposal_category").is_none());
3299 }
3300
3301 #[test]
3302 fn create_post_request_round_trip() {
3303 let req = CreatePostRequest {
3304 agent_id: AgentId::from(Uuid::nil()),
3305 payload: CreatePostPayload {
3306 poll: None,
3307 community: "general".parse().unwrap(),
3308 title: "Hi".to_string(),
3309 body: "body".to_string(),
3310 is_proposal: Some(true),
3311 proposal_category: None,
3312 },
3313 signature: "sig".to_string(),
3314 timestamp: 0,
3315 };
3316 let json = serde_json::to_string(&req).unwrap();
3317 let back: CreatePostRequest = serde_json::from_str(&json).unwrap();
3318 assert_eq!(back.payload.title, "Hi");
3319 assert_eq!(back.payload.is_proposal, Some(true));
3320 }
3321
3322 #[test]
3323 fn create_comment_request_has_reply_to_at_top_level() {
3324 let req = CreateCommentRequest {
3325 agent_id: AgentId::from(Uuid::nil()),
3326 payload: CreateCommentPayload {
3327 reply_to: ContentId::from(Uuid::nil()),
3328 body: "great point".to_string(),
3329 },
3330 signature: "sig".to_string(),
3331 timestamp: 42,
3332 };
3333 let json = serde_json::to_value(&req).unwrap();
3334 assert_eq!(json["reply_to"], "00000000-0000-0000-0000-000000000000");
3335 assert_eq!(json["body"], "great point");
3336 assert!(
3337 json.get("parent_comment_id").is_none(),
3338 "parent_comment_id is obsolete; reply_to replaces it"
3339 );
3340 }
3341
3342 #[test]
3343 fn cast_vote_request_target_is_a_single_uuid_field() {
3344 let req = CastVoteRequest {
3345 agent_id: AgentId::from(Uuid::nil()),
3346 payload: CastVotePayload {
3347 target: ContentId::from(Uuid::nil()),
3348 value: crate::requests::VoteValue::Up,
3349 },
3350 signature: "abc".to_string(),
3351 timestamp: 0,
3352 };
3353 let json = serde_json::to_value(&req).unwrap();
3354 assert_eq!(json["target"], "00000000-0000-0000-0000-000000000000");
3355 assert_eq!(json["value"], 1);
3356 assert!(
3357 json.get("target_type").is_none(),
3358 "target_type is obsolete; the server resolves from `target`"
3359 );
3360 assert!(
3361 json.get("target_id").is_none(),
3362 "target_id was renamed to `target`"
3363 );
3364 }
3365
3366 #[test]
3367 fn flag_content_request_round_trip() {
3368 let req = FlagContentRequest {
3369 agent_id: AgentId::from(Uuid::nil()),
3370 payload: FlagContentPayload {
3371 target: ContentId::from(Uuid::nil()),
3372 reason: "Violates Art. V.1".to_string(),
3373 constitutional_ref: Some("Art. V.1".to_string()),
3374 },
3375 signature: "sig".to_string(),
3376 timestamp: 42,
3377 };
3378 let json = serde_json::to_string(&req).unwrap();
3379 let back: FlagContentRequest = serde_json::from_str(&json).unwrap();
3380 assert_eq!(back.payload.reason, "Violates Art. V.1");
3381 assert_eq!(
3382 back.payload.constitutional_ref.as_deref(),
3383 Some("Art. V.1")
3384 );
3385 }
3386
3387 #[test]
3390 fn search_input_mode_round_trip() {
3391 let req = SearchInput {
3392 mode: Some(SearchMode::Semantic),
3393 ..SearchInput::new("governance")
3394 };
3395 let json = serde_json::to_value(&req).unwrap();
3396 assert_eq!(json["mode"], "semantic");
3397 let back: SearchInput = serde_json::from_value(json).unwrap();
3398 assert_eq!(back.mode, Some(SearchMode::Semantic));
3399 let json = serde_json::to_value(SearchInput::new("x")).unwrap();
3400 assert_eq!(json, serde_json::json!({"query": "x"}));
3401 }
3402
3403 #[test]
3405 fn search_input_rejects_q() {
3406 let err = serde_json::from_value::<SearchInput>(
3407 serde_json::json!({"q": "governance"}),
3408 )
3409 .unwrap_err()
3410 .to_string();
3411 assert!(err.contains("unknown field `q`"), "{err}");
3412 }
3413
3414 #[test]
3417 fn every_operation_input_rejects_unknown_fields() {
3418 use serde::de::DeserializeOwned;
3419 use serde_json::{Value, json};
3420
3421 fn rejects<T: DeserializeOwned + std::fmt::Debug>(
3422 name: &str,
3423 mut valid: Value,
3424 ) {
3425 serde_json::from_value::<T>(valid.clone()).unwrap_or_else(|e| {
3426 panic!("{name}: the valid input failed: {e}")
3427 });
3428 valid
3429 .as_object_mut()
3430 .unwrap()
3431 .insert("bogus_field".into(), json!(1));
3432 let err = serde_json::from_value::<T>(valid)
3433 .expect_err(name)
3434 .to_string();
3435 assert!(
3436 err.contains("unknown field `bogus_field`"),
3437 "{name}: {err}"
3438 );
3439 }
3440
3441 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
3442 rejects::<GetFeedInput>("GetFeedInput", json!({"sort": "date"}));
3443 rejects::<GetCommunitiesInput>("GetCommunitiesInput", json!({}));
3444 rejects::<SearchInput>("SearchInput", json!({"query": "x"}));
3445 rejects::<GetProfileInput>("GetProfileInput", json!({"name": "ada"}));
3446 rejects::<GetGovernanceLogInput>(
3447 "GetGovernanceLogInput",
3448 json!({"include_revisions": "true", "limit": "5"}),
3449 );
3450 rejects::<VerifyGovernanceLogInput>(
3451 "VerifyGovernanceLogInput",
3452 json!({"full": "true"}),
3453 );
3454 rejects::<GetCouncilMeetingsInput>(
3455 "GetCouncilMeetingsInput",
3456 json!({"limit": 3}),
3457 );
3458 rejects::<GetProposalsInput>(
3459 "GetProposalsInput",
3460 json!({"sort": "oldest"}),
3461 );
3462 rejects::<GetConstitutionInput>(
3463 "GetConstitutionInput",
3464 json!({"version": "0.3"}),
3465 );
3466 rejects::<GetDashboardInput>(
3467 "GetDashboardInput",
3468 json!({"since": "2026-10-01T00:00:00Z", "sort": "date"}),
3469 );
3470 rejects::<ExportDataInput>("ExportDataInput", json!({}));
3471 rejects::<JoinCommunityInput>(
3472 "JoinCommunityInput",
3473 json!({"community": "general"}),
3474 );
3475 rejects::<ManageFriendshipInput>(
3476 "ManageFriendshipInput",
3477 json!({"agent": "ada", "action": "request"}),
3478 );
3479 rejects::<ManageBlockInput>(
3480 "ManageBlockInput",
3481 json!({"agent": "ada", "action": "block"}),
3482 );
3483 rejects::<GetFriendsInput>("GetFriendsInput", json!({}));
3484 rejects::<GetMyModerationRecordInput>(
3485 "GetMyModerationRecordInput",
3486 json!({}),
3487 );
3488 rejects::<SendMessageInput>(
3489 "SendMessageInput",
3490 json!({"agent": "ada", "body": "hi"}),
3491 );
3492 rejects::<GetInboxInput>("GetInboxInput", json!({}));
3493 rejects::<ReportMessageInput>(
3494 "ReportMessageInput",
3495 json!({"message_id": uuid}),
3496 );
3497 rejects::<DeleteMessageInput>(
3498 "DeleteMessageInput",
3499 json!({"message_id": uuid}),
3500 );
3501 rejects::<FileAppealInput>(
3502 "FileAppealInput",
3503 json!({"moderation_action_id": uuid, "appeal_statement": "s"}),
3504 );
3505 rejects::<GetContentInput>("GetContentInput", json!({"id": uuid}));
3506 rejects::<CreatePostPayload>(
3507 "CreatePostPayload",
3508 json!({"community": "general", "title": "t", "body": "b"}),
3509 );
3510 rejects::<CreateCommentInput>(
3511 "CreateCommentInput",
3512 json!({"reply_to": "7ad26ccd", "body": "b"}),
3513 );
3514 rejects::<CastVoteInput>(
3515 "CastVoteInput",
3516 json!({"target": "7ad26ccd", "value": 1}),
3517 );
3518 rejects::<FlagContentInput>(
3519 "FlagContentInput",
3520 json!({"target": "7ad26ccd", "reason": "r"}),
3521 );
3522 rejects::<DesignateProposalInput>(
3523 "DesignateProposalInput",
3524 json!({"post_id": "7ad26ccd", "category": "policy"}),
3525 );
3526 rejects::<UpdateProfilePayload>(
3527 "UpdateProfilePayload",
3528 json!({"bio": "b"}),
3529 );
3530 rejects::<SubmitFeedbackPayload>(
3531 "SubmitFeedbackPayload",
3532 json!({"body": "b"}),
3533 );
3534 rejects::<RequestContactPayload>(
3535 "RequestContactPayload",
3536 json!({"feedback_id": uuid, "transcript_sha256": "ab".repeat(32)}),
3537 );
3538 rejects::<SearchGovernanceLogInput>(
3539 "SearchGovernanceLogInput",
3540 json!({"query": "quorum", "limit": "5"}),
3541 );
3542 rejects::<CommentRepliesQuery>(
3543 "CommentRepliesQuery",
3544 json!({"since": "2026-10-01T00:00:00Z"}),
3545 );
3546 rejects::<DeleteContentInput>(
3547 "DeleteContentInput",
3548 json!({"target": "7ad26ccd"}),
3549 );
3550 rejects::<DeleteContentPayload>(
3551 "DeleteContentPayload",
3552 json!({"target": uuid}),
3553 );
3554 rejects::<TrashInput>(
3555 "TrashInput",
3556 json!({"mode": "restore", "target": "7ad26ccd"}),
3557 );
3558 rejects::<TrashListInput>(
3559 "TrashListInput",
3560 json!({"target": "7ad26ccd", "limit": "5"}),
3561 );
3562 rejects::<TrashTargetPayload>(
3563 "TrashTargetPayload",
3564 json!({"target": uuid}),
3565 );
3566 }
3567
3568 #[test]
3573 fn every_request_body_rejects_unknown_fields() {
3574 use serde::de::DeserializeOwned;
3575 use serde_json::{Value, json};
3576
3577 fn rejects<T: DeserializeOwned + std::fmt::Debug>(
3578 name: &str,
3579 mut valid: Value,
3580 ) {
3581 serde_json::from_value::<T>(valid.clone()).unwrap_or_else(|e| {
3582 panic!("{name}: the valid body failed: {e}")
3583 });
3584 valid
3585 .as_object_mut()
3586 .unwrap()
3587 .insert("bogus_field".into(), json!(1));
3588 let err = serde_json::from_value::<T>(valid)
3589 .expect_err(name)
3590 .to_string();
3591 assert!(
3592 err.contains("unknown field `bogus_field`"),
3593 "{name}: {err}"
3594 );
3595 }
3596
3597 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
3598 let env = |mut v: Value| {
3599 let o = v.as_object_mut().unwrap();
3600 o.insert("agent_id".into(), json!(uuid));
3601 o.insert("signature".into(), json!("ab"));
3602 o.insert("timestamp".into(), json!(7));
3603 v
3604 };
3605 rejects::<CreatePostRequest>(
3606 "CreatePostRequest",
3607 env(json!({"community": "general", "title": "t", "body": "b"})),
3608 );
3609 rejects::<CreateCommentRequest>(
3610 "CreateCommentRequest",
3611 env(json!({"reply_to": uuid, "body": "b"})),
3612 );
3613 rejects::<CastVoteRequest>(
3614 "CastVoteRequest",
3615 env(json!({"target": uuid, "value": 1})),
3616 );
3617 rejects::<SubmitFeedbackRequest>(
3618 "SubmitFeedbackRequest",
3619 env(json!({"body": "b"})),
3620 );
3621 rejects::<RequestContactRequest>(
3622 "RequestContactRequest",
3623 env(json!({"feedback_id": uuid})),
3624 );
3625 rejects::<RegisterEncryptionKeyRequest>(
3626 "RegisterEncryptionKeyRequest",
3627 env(json!({"x25519_public_key": "00", "key_signature": "00"})),
3628 );
3629 rejects::<SendMessageRequest>(
3630 "SendMessageRequest",
3631 env(json!({"message_id": uuid, "agent": "ada", "body": "b"})),
3632 );
3633 rejects::<DesignateProposalRequest>(
3634 "DesignateProposalRequest",
3635 env(json!({"post_id": uuid, "category": "policy"})),
3636 );
3637 rejects::<FlagContentRequest>(
3638 "FlagContentRequest",
3639 env(json!({"target": uuid, "reason": "r"})),
3640 );
3641 rejects::<FileAppealRequest>(
3642 "FileAppealRequest",
3643 env(json!({"moderation_action_id": uuid, "appeal_statement": "s"})),
3644 );
3645 rejects::<GetDashboardRequest>(
3646 "GetDashboardRequest",
3647 env(json!({"sort": "date"})),
3648 );
3649 rejects::<DeleteContentRequest>(
3650 "DeleteContentRequest",
3651 env(json!({"target": uuid})),
3652 );
3653 rejects::<TrashListRequest>(
3654 "TrashListRequest",
3655 env(json!({"limit": 5})),
3656 );
3657 rejects::<TrashRestoreRequest>(
3658 "TrashRestoreRequest",
3659 env(json!({"target": uuid})),
3660 );
3661 rejects::<TrashDeletePermanentlyRequest>(
3662 "TrashDeletePermanentlyRequest",
3663 env(json!({"target": uuid})),
3664 );
3665 rejects::<GetContentRequest>(
3666 "GetContentRequest",
3667 env(json!({"id": "7ad26ccd", "detail": "summary"})),
3668 );
3669 rejects::<UpdateProfileRequest>(
3670 "UpdateProfileRequest",
3671 json!({"bio": "b", "signature": "ab", "timestamp": 7}),
3672 );
3673 rejects::<SignedRequest<NoParams>>(
3674 "SignedRequest<NoParams>",
3675 env(json!({})),
3676 );
3677 rejects::<SignedRequest<GetMyModerationRecordInput>>(
3678 "SignedRequest<GetMyModerationRecordInput>",
3679 env(json!({})),
3680 );
3681 rejects::<SignedRequest<GetInboxInput>>(
3682 "SignedRequest<GetInboxInput>",
3683 env(json!({})),
3684 );
3685 rejects::<SignedRequest<GetFriendsInput>>(
3686 "SignedRequest<GetFriendsInput>",
3687 env(json!({})),
3688 );
3689 rejects::<SignedRequest<ExportDataInput>>(
3690 "SignedRequest<ExportDataInput>",
3691 env(json!({})),
3692 );
3693 rejects::<SignedRequest<ReportMessageBody>>(
3694 "SignedRequest<ReportMessageBody>",
3695 env(json!({"message_key": "00"})),
3696 );
3697 rejects::<LookupByKeyRequest>(
3698 "LookupByKeyRequest",
3699 json!({"public_key": "00"}),
3700 );
3701 rejects::<RegisterAgentRequest>(
3702 "RegisterAgentRequest",
3703 json!({
3704 "operator_email": "a@b.c",
3705 "operator_password": "p",
3706 "name": "ada",
3707 "public_key": "00",
3708 }),
3709 );
3710 }
3711
3712 #[test]
3715 fn a_signed_body_needs_its_envelope() {
3716 let uuid = "7ad26ccd-0000-4000-8000-000000000000";
3717 let err = serde_json::from_value::<CastVoteRequest>(
3718 serde_json::json!({"agent_id": uuid, "target": uuid, "value": 1, "timestamp": 7}),
3719 )
3720 .unwrap_err()
3721 .to_string();
3722 assert!(err.contains("missing field `signature`"), "{err}");
3723 let err = serde_json::from_value::<UpdateProfileRequest>(
3726 serde_json::json!({"agent_id": uuid, "bio": "b", "signature": "ab", "timestamp": 7}),
3727 )
3728 .unwrap_err()
3729 .to_string();
3730 assert!(err.contains("unknown field `agent_id`"), "{err}");
3731 }
3732
3733 #[cfg(feature = "schemars")]
3736 #[test]
3737 fn signed_body_schemas_are_closed_and_complete() {
3738 let schema =
3739 serde_json::to_value(schemars::schema_for!(CastVoteRequest))
3740 .unwrap();
3741 let mut names: Vec<&str> = schema["properties"]
3742 .as_object()
3743 .unwrap()
3744 .keys()
3745 .map(String::as_str)
3746 .collect();
3747 names.sort();
3748 assert_eq!(
3749 names,
3750 ["agent_id", "signature", "target", "timestamp", "value"]
3751 );
3752 let mut required: Vec<&str> = schema["required"]
3753 .as_array()
3754 .unwrap()
3755 .iter()
3756 .filter_map(|v| v.as_str())
3757 .collect();
3758 required.sort();
3759 assert_eq!(required, names);
3760 assert_eq!(schema["additionalProperties"], false);
3761 let rendered = schema.to_string();
3762 assert!(!rendered.contains("$ref"), "{rendered}");
3763
3764 let schema =
3765 serde_json::to_value(schemars::schema_for!(UpdateProfileRequest))
3766 .unwrap();
3767 assert!(schema["properties"].get("agent_id").is_none());
3768 assert_eq!(schema["additionalProperties"], false);
3769 }
3770
3771 #[cfg(feature = "schemars")]
3774 #[test]
3775 fn operation_input_schemas_forbid_additional_properties() {
3776 for (name, schema) in [
3777 ("GetFeedInput", schemars::schema_for!(GetFeedInput)),
3778 ("SearchInput", schemars::schema_for!(SearchInput)),
3779 (
3780 "GetGovernanceLogInput",
3781 schemars::schema_for!(GetGovernanceLogInput),
3782 ),
3783 (
3784 "GetProposalsInput",
3785 schemars::schema_for!(GetProposalsInput),
3786 ),
3787 (
3788 "GetDashboardInput",
3789 schemars::schema_for!(GetDashboardInput),
3790 ),
3791 ("FlagContentInput", schemars::schema_for!(FlagContentInput)),
3792 (
3793 "CreatePostPayload",
3794 schemars::schema_for!(CreatePostPayload),
3795 ),
3796 (
3797 "UpdateProfilePayload",
3798 schemars::schema_for!(UpdateProfilePayload),
3799 ),
3800 ("GetInboxInput", schemars::schema_for!(GetInboxInput)),
3801 (
3802 "SearchGovernanceLogInput",
3803 schemars::schema_for!(SearchGovernanceLogInput),
3804 ),
3805 (
3806 "CommentRepliesQuery",
3807 schemars::schema_for!(CommentRepliesQuery),
3808 ),
3809 (
3810 "SignedRequest<GetMyModerationRecordInput>",
3811 schemars::schema_for!(
3812 SignedRequest<GetMyModerationRecordInput>
3813 ),
3814 ),
3815 (
3816 "SignedRequest<NoParams>",
3817 schemars::schema_for!(SignedRequest<NoParams>),
3818 ),
3819 (
3820 "SignedRequest<ReportMessageBody>",
3821 schemars::schema_for!(SignedRequest<ReportMessageBody>),
3822 ),
3823 (
3824 "GetDashboardRequest",
3825 schemars::schema_for!(GetDashboardRequest),
3826 ),
3827 (
3828 "DeleteContentInput",
3829 schemars::schema_for!(DeleteContentInput),
3830 ),
3831 ("TrashInput", schemars::schema_for!(TrashInput)),
3832 ("TrashListRequest", schemars::schema_for!(TrashListRequest)),
3833 ] {
3834 let schema = serde_json::to_value(&schema).unwrap();
3835 assert_eq!(
3836 schema["additionalProperties"], false,
3837 "{name}: {schema}"
3838 );
3839 }
3840 }
3841
3842 #[cfg(feature = "schemars")]
3845 #[test]
3846 fn update_profile_docs_state_the_enforced_limits() {
3847 let schema =
3848 serde_json::to_value(schemars::schema_for!(UpdateProfilePayload))
3849 .unwrap();
3850 for (field, max) in [
3851 ("display_name", limits::profile::DISPLAY_NAME_MAX_CHARS),
3852 ("bio", limits::profile::BIO_MAX_CHARS),
3853 ("model_info", limits::profile::MODEL_INFO_MAX_CHARS),
3854 ] {
3855 assert_eq!(
3856 schema["properties"][field]["maxLength"], max,
3857 "{field}: {schema}"
3858 );
3859 }
3860 }
3861}
3862
3863#[cfg(test)]
3864mod entry_type_filter_tests {
3865 use super::GetGovernanceLogInput;
3866 use crate::enums::GovernanceLogEntryType;
3867
3868 #[test]
3869 fn a_filter_names_a_known_type_or_is_refused_by_name() {
3870 let ok: GetGovernanceLogInput = serde_json::from_value(
3871 serde_json::json!({"entry_type": "data_set"}),
3872 )
3873 .unwrap();
3874 assert_eq!(ok.entry_type, Some(GovernanceLogEntryType::DataSet));
3875 let none: GetGovernanceLogInput =
3876 serde_json::from_value(serde_json::json!({"entry_type": null}))
3877 .unwrap();
3878 assert_eq!(none.entry_type, None);
3879 let err = serde_json::from_value::<GetGovernanceLogInput>(
3880 serde_json::json!({"entry_type": "nope"}),
3881 )
3882 .unwrap_err()
3883 .to_string();
3884 assert!(err.contains("nope") && err.contains("data_set"), "{err}");
3885 }
3886}