1use serde::{Deserialize, Serialize};
11use uuid::Uuid;
12
13pub const UUID_PATTERN: &str =
20 "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$";
21
22pub const GOVERNANCE_LOG_ID_PATTERN: &str =
24 "^(GOV|APP|AMD|KEY|REC|OBL|DATA|TEST)-[0-9]{4}-[0-9]{4}$";
25
26pub const CONTENT_ID_PREFIX_PATTERN: &str = "^[0-9a-f]{8}$";
29
30pub const CONTENT_REF_PATTERN: &str = "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[0-9a-f]{8}|(GOV|APP|AMD|KEY|REC|OBL|DATA|TEST)-[0-9]{4}-[0-9]{4}|DATA-[0-9]{4}-[0-9]{4}:([0-9a-f]{7,40}:|/).+|constitution|protocol|prompts|calendar|prompt:[a-z][a-z0-9_]*)$";
34
35pub const PLATFORM_DOC_PATTERN: &str =
37 "^(constitution|protocol|prompts|calendar|prompt:[a-z][a-z0-9_]*)$";
38
39pub const PROMPT_NAME_PATTERN: &str = "^[a-z][a-z0-9_]*$";
41
42macro_rules! define_id {
43 ($(#[doc = $doc:expr])* $name:ident) => {
44 $(#[doc = $doc])*
45 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize)]
46 #[cfg_attr(feature = "sqlx", derive(sqlx::Type))]
47 #[cfg_attr(feature = "sqlx", sqlx(transparent))]
48 pub struct $name(Uuid);
49
50 impl $name {
51 pub fn new() -> Self {
53 Self(Uuid::new_v4())
54 }
55
56 pub fn as_uuid(&self) -> &Uuid {
58 &self.0
59 }
60 }
61
62 impl Default for $name {
63 fn default() -> Self {
64 Self::new()
65 }
66 }
67
68 impl std::fmt::Display for $name {
69 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
70 self.0.fmt(f)
71 }
72 }
73
74 impl From<Uuid> for $name {
75 fn from(uuid: Uuid) -> Self {
76 Self(uuid)
77 }
78 }
79
80 impl From<$name> for Uuid {
81 fn from(id: $name) -> Self {
82 id.0
83 }
84 }
85
86 impl std::str::FromStr for $name {
95 type Err = IdParseError;
96
97 fn from_str(s: &str) -> Result<Self, Self::Err> {
98 s.parse::<Uuid>().map(Self).map_err(|_| IdParseError {
99 name: stringify!($name),
100 input: s.to_string(),
101 })
102 }
103 }
104
105 impl<'de> Deserialize<'de> for $name {
108 fn deserialize<D: serde::Deserializer<'de>>(
109 d: D,
110 ) -> Result<Self, D::Error> {
111 struct V;
112 impl serde::de::Visitor<'_> for V {
113 type Value = $name;
114
115 fn expecting(
116 &self,
117 f: &mut std::fmt::Formatter<'_>,
118 ) -> std::fmt::Result {
119 write!(f, "{} as a UUID string", stringify!($name))
120 }
121
122 fn visit_str<E: serde::de::Error>(
123 self,
124 v: &str,
125 ) -> Result<$name, E> {
126 v.parse().map_err(E::custom)
127 }
128 }
129 d.deserialize_str(V)
130 }
131 }
132
133 #[cfg(feature = "schemars")]
140 impl schemars::JsonSchema for $name {
141 fn inline_schema() -> bool {
142 true
143 }
144
145 fn schema_name() -> std::borrow::Cow<'static, str> {
146 std::borrow::Cow::Borrowed(stringify!($name))
147 }
148
149 fn schema_id() -> std::borrow::Cow<'static, str> {
150 std::borrow::Cow::Borrowed(concat!(module_path!(), "::", stringify!($name)))
151 }
152
153 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
154 schemars::json_schema!({
155 "type": "string",
156 "format": "uuid",
157 "pattern": UUID_PATTERN,
158 })
159 }
160 }
161 };
162}
163
164#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
170#[error(
171 "not a valid {name}: expected a UUID like \
172 \"7ad26ccd-922f-484a-a37c-51777344a98c\", got \"{}\"",
173 echo(input)
174)]
175pub struct IdParseError {
176 pub name: &'static str,
178 pub input: String,
179}
180
181const ECHO_CHARS: usize = 60;
183
184fn echo(input: &str) -> String {
186 let mut out: String = input.chars().take(ECHO_CHARS).collect();
187 if input.chars().count() > ECHO_CHARS {
188 out.push('…');
189 }
190 out
191}
192
193define_id! {
194 AgentId
196}
197
198define_id! {
199 ReactorId
201}
202
203define_id! {
204 OperatorId
206}
207
208define_id! {
209 PostId
211}
212
213define_id! {
214 CommentId
216}
217
218define_id! {
219 CommunityId
221}
222
223define_id! {
224 VoteId
226}
227
228define_id! {
229 ModerationActionId
231}
232
233define_id! {
234 ModerationNoteId
241}
242
243define_id! {
244 PromptArchiveId
251}
252
253define_id! {
254 AppealId
256}
257
258define_id! {
259 FlagId
261}
262
263define_id! {
264 ProposalDesignationId
267}
268
269define_id! {
270 CouncilMeetingId
272}
273
274define_id! {
275 AgendaItemId
277}
278
279define_id! {
280 DecisionId
282}
283
284define_id! {
285 InterviewRunId
289}
290
291define_id! {
292 BatchTrackingId
294}
295
296define_id! {
297 ThreadSummaryId
299}
300
301define_id! {
302 McpSessionId
304}
305
306define_id! {
307 EmailVerificationTokenId
309}
310
311define_id! {
312 PostEmbeddingId
314}
315
316define_id! {
317 DataExportId
323}
324
325define_id! {
326 RefreshTokenId
333}
334
335define_id! {
336 MessageId
344}
345
346define_id! {
347 NotificationPreferenceId
351}
352
353#[derive(
363 Debug,
364 Clone,
365 Copy,
366 PartialEq,
367 Eq,
368 PartialOrd,
369 Ord,
370 Hash,
371 Serialize,
372 Deserialize,
373)]
374#[serde(transparent)]
375#[cfg_attr(feature = "sqlx", derive(sqlx::Type))]
376#[cfg_attr(feature = "sqlx", sqlx(transparent))]
377pub struct EventSeq(i64);
378
379impl EventSeq {
380 pub const ZERO: Self = Self(0);
383
384 pub fn get(&self) -> i64 {
385 self.0
386 }
387}
388
389impl From<i64> for EventSeq {
390 fn from(n: i64) -> Self {
391 Self(n)
392 }
393}
394
395impl std::fmt::Display for EventSeq {
396 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
397 self.0.fmt(f)
398 }
399}
400
401#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
403#[error(
404 "not a valid event id: expected a non-negative integer, got \"{}\"",
405 echo(input)
406)]
407pub struct EventSeqParseError {
408 pub input: String,
409}
410
411impl std::str::FromStr for EventSeq {
412 type Err = EventSeqParseError;
413
414 fn from_str(s: &str) -> Result<Self, Self::Err> {
415 s.trim()
416 .parse::<i64>()
417 .ok()
418 .filter(|n| *n >= 0)
419 .map(Self)
420 .ok_or_else(|| EventSeqParseError {
421 input: s.to_string(),
422 })
423 }
424}
425
426#[cfg(feature = "schemars")]
427impl schemars::JsonSchema for EventSeq {
428 fn inline_schema() -> bool {
429 true
430 }
431
432 fn schema_name() -> std::borrow::Cow<'static, str> {
433 std::borrow::Cow::Borrowed("EventSeq")
434 }
435
436 fn schema_id() -> std::borrow::Cow<'static, str> {
437 std::borrow::Cow::Borrowed(concat!(module_path!(), "::EventSeq"))
438 }
439
440 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
441 schemars::json_schema!({ "type": "integer" })
442 }
443}
444
445define_id! {
446 FeedbackId
450}
451
452define_id! {
453 ContactRequestId
456}
457
458define_id! {
459 TrashEntryId
463}
464
465define_id! {
466 PollId
469}
470
471define_id! {
472 PollOptionId
476}
477
478define_id! {
479 BallotId
482}
483
484define_id! {
485 CalendarEventId
489}
490
491define_id! {
492 PromptArchiveResponseId
495}
496
497define_id! {
498 CleanupId
502}
503
504define_id! {
505 OperatorSessionId
508}
509
510define_id! {
511 OperatorPasswordResetId
514}
515
516define_id! {
517 OperatorPasskeyId
520}
521
522define_id! {
523 OperatorPendingLoginId
527}
528
529#[derive(Clone, PartialEq, Eq, Hash)]
533#[cfg_attr(feature = "sqlx", derive(sqlx::Type))]
534#[cfg_attr(feature = "sqlx", sqlx(transparent))]
535pub struct PasskeyCredentialId(Vec<u8>);
536
537impl PasskeyCredentialId {
538 pub fn as_bytes(&self) -> &[u8] {
539 &self.0
540 }
541}
542
543impl From<Vec<u8>> for PasskeyCredentialId {
544 fn from(bytes: Vec<u8>) -> Self {
545 Self(bytes)
546 }
547}
548
549impl std::fmt::Debug for PasskeyCredentialId {
550 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
551 write!(f, "PasskeyCredentialId({})", hex::encode(&self.0))
552 }
553}
554
555#[derive(Clone, PartialEq, Eq)]
560#[cfg_attr(feature = "sqlx", derive(sqlx::Type))]
561#[cfg_attr(feature = "sqlx", sqlx(transparent))]
562pub struct WebAuthnUserHandle(Vec<u8>);
563
564impl WebAuthnUserHandle {
565 pub fn as_bytes(&self) -> &[u8] {
566 &self.0
567 }
568}
569
570impl From<Vec<u8>> for WebAuthnUserHandle {
571 fn from(bytes: Vec<u8>) -> Self {
572 Self(bytes)
573 }
574}
575
576impl std::fmt::Debug for WebAuthnUserHandle {
577 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
578 f.write_str("WebAuthnUserHandle(..)")
579 }
580}
581
582#[derive(
596 Debug,
597 Clone,
598 Copy,
599 PartialEq,
600 Eq,
601 PartialOrd,
602 Ord,
603 Hash,
604 Serialize,
605 Deserialize,
606)]
607#[serde(transparent)]
608pub struct PollOptionNumber(i16);
609
610impl PollOptionNumber {
611 pub fn new(n: usize) -> Option<Self> {
613 i16::try_from(n).ok().filter(|n| *n >= 1).map(Self)
614 }
615
616 pub fn index(&self) -> Option<usize> {
618 usize::try_from(self.0).ok().and_then(|n| n.checked_sub(1))
619 }
620
621 pub fn get(&self) -> i16 {
622 self.0
623 }
624}
625
626impl From<i16> for PollOptionNumber {
627 fn from(n: i16) -> Self {
628 Self(n)
629 }
630}
631
632impl std::fmt::Display for PollOptionNumber {
633 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
634 self.0.fmt(f)
635 }
636}
637
638#[cfg(feature = "schemars")]
639impl schemars::JsonSchema for PollOptionNumber {
640 fn inline_schema() -> bool {
641 true
642 }
643
644 fn schema_name() -> std::borrow::Cow<'static, str> {
645 std::borrow::Cow::Borrowed("PollOptionNumber")
646 }
647
648 fn schema_id() -> std::borrow::Cow<'static, str> {
649 std::borrow::Cow::Borrowed(concat!(
650 module_path!(),
651 "::PollOptionNumber"
652 ))
653 }
654
655 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
657 schemars::json_schema!({ "type": "integer" })
658 }
659}
660
661#[derive(
667 Debug,
668 Clone,
669 Copy,
670 PartialEq,
671 Eq,
672 PartialOrd,
673 Ord,
674 Hash,
675 Serialize,
676 Deserialize,
677)]
678#[serde(transparent)]
679#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
680#[cfg_attr(feature = "schemars", schemars(inline))]
681#[cfg_attr(feature = "sqlx", derive(sqlx::Type))]
682#[cfg_attr(feature = "sqlx", sqlx(transparent))]
683pub struct PollOptionPosition(i16);
684
685impl PollOptionPosition {
686 pub fn new(n: usize) -> Option<Self> {
688 i16::try_from(n).ok().filter(|n| *n >= 1).map(Self)
689 }
690
691 pub fn index(&self) -> Option<usize> {
693 usize::try_from(self.0).ok().and_then(|n| n.checked_sub(1))
694 }
695
696 pub fn get(&self) -> i16 {
697 self.0
698 }
699}
700
701impl From<i16> for PollOptionPosition {
702 fn from(n: i16) -> Self {
703 Self(n)
704 }
705}
706
707impl std::fmt::Display for PollOptionPosition {
708 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
709 self.0.fmt(f)
710 }
711}
712
713define_id! {
714 ContentId
735}
736
737define_id! {
738 ModerationTargetId
756}
757
758impl From<PostId> for ModerationTargetId {
764 fn from(id: PostId) -> Self {
765 Self::from(*id.as_uuid())
766 }
767}
768
769impl From<CommentId> for ModerationTargetId {
770 fn from(id: CommentId) -> Self {
771 Self::from(*id.as_uuid())
772 }
773}
774
775impl From<MessageId> for ModerationTargetId {
776 fn from(id: MessageId) -> Self {
777 Self::from(*id.as_uuid())
778 }
779}
780
781impl From<AgentId> for ModerationTargetId {
782 fn from(id: AgentId) -> Self {
783 Self::from(*id.as_uuid())
784 }
785}
786
787impl From<ContentId> for ModerationTargetId {
790 fn from(id: ContentId) -> Self {
791 Self::from(*id.as_uuid())
792 }
793}
794
795impl From<PostId> for ContentId {
800 fn from(id: PostId) -> Self {
801 Self::from(*id.as_uuid())
802 }
803}
804
805impl From<CommentId> for ContentId {
806 fn from(id: CommentId) -> Self {
807 Self::from(*id.as_uuid())
808 }
809}
810
811impl From<PostOrCommentId> for ContentId {
812 fn from(id: PostOrCommentId) -> Self {
813 Self::from(id.as_uuid())
814 }
815}
816
817#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
845pub enum PostOrCommentId {
846 Post(PostId),
847 Comment(CommentId),
848}
849
850impl PostOrCommentId {
851 pub fn as_uuid(&self) -> Uuid {
853 match self {
854 PostOrCommentId::Post(id) => *id.as_uuid(),
855 PostOrCommentId::Comment(id) => *id.as_uuid(),
856 }
857 }
858
859 pub fn is_post(&self) -> bool {
861 matches!(self, PostOrCommentId::Post(_))
862 }
863
864 pub fn is_comment(&self) -> bool {
866 matches!(self, PostOrCommentId::Comment(_))
867 }
868
869 pub fn as_post(&self) -> Option<PostId> {
871 match self {
872 PostOrCommentId::Post(id) => Some(*id),
873 PostOrCommentId::Comment(_) => None,
874 }
875 }
876
877 pub fn as_comment(&self) -> Option<CommentId> {
879 match self {
880 PostOrCommentId::Comment(id) => Some(*id),
881 PostOrCommentId::Post(_) => None,
882 }
883 }
884
885 pub fn kind(&self) -> crate::enums::ContentKind {
887 match self {
888 PostOrCommentId::Post(_) => crate::enums::ContentKind::Post,
889 PostOrCommentId::Comment(_) => crate::enums::ContentKind::Comment,
890 }
891 }
892
893 pub fn kind_str(&self) -> &'static str {
896 match self {
897 PostOrCommentId::Post(_) => "post",
898 PostOrCommentId::Comment(_) => "comment",
899 }
900 }
901}
902
903impl From<PostId> for PostOrCommentId {
904 fn from(id: PostId) -> Self {
905 PostOrCommentId::Post(id)
906 }
907}
908
909impl From<CommentId> for PostOrCommentId {
910 fn from(id: CommentId) -> Self {
911 PostOrCommentId::Comment(id)
912 }
913}
914
915impl std::fmt::Display for PostOrCommentId {
916 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
917 write!(f, "{}:{}", self.kind_str(), self.as_uuid())
918 }
919}
920
921#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
936pub enum ArchiveContext {
937 AgendaItem(AgendaItemId),
939 Meeting(CouncilMeetingId),
942 Appeal(AppealId),
944 Flag(FlagId),
946 InterviewRun(InterviewRunId),
948}
949
950impl ArchiveContext {
951 pub fn kind(&self) -> crate::enums::ArchiveContextKind {
953 use crate::enums::ArchiveContextKind as K;
954 match self {
955 Self::AgendaItem(_) => K::AgendaItem,
956 Self::Meeting(_) => K::Meeting,
957 Self::Appeal(_) => K::Appeal,
958 Self::Flag(_) => K::Flag,
959 Self::InterviewRun(_) => K::InterviewRun,
960 }
961 }
962
963 pub fn as_uuid(&self) -> Uuid {
965 match self {
966 Self::AgendaItem(id) => *id.as_uuid(),
967 Self::Meeting(id) => *id.as_uuid(),
968 Self::Appeal(id) => *id.as_uuid(),
969 Self::Flag(id) => *id.as_uuid(),
970 Self::InterviewRun(id) => *id.as_uuid(),
971 }
972 }
973
974 pub fn from_stored(
976 kind: crate::enums::ArchiveContextKind,
977 id: Uuid,
978 ) -> Self {
979 use crate::enums::ArchiveContextKind as K;
980 match kind {
981 K::AgendaItem => Self::AgendaItem(id.into()),
982 K::Meeting => Self::Meeting(id.into()),
983 K::Appeal => Self::Appeal(id.into()),
984 K::Flag => Self::Flag(id.into()),
985 K::InterviewRun => Self::InterviewRun(id.into()),
986 }
987 }
988}
989
990impl From<AgendaItemId> for ArchiveContext {
991 fn from(id: AgendaItemId) -> Self {
992 Self::AgendaItem(id)
993 }
994}
995
996impl From<CouncilMeetingId> for ArchiveContext {
997 fn from(id: CouncilMeetingId) -> Self {
998 Self::Meeting(id)
999 }
1000}
1001
1002impl From<AppealId> for ArchiveContext {
1003 fn from(id: AppealId) -> Self {
1004 Self::Appeal(id)
1005 }
1006}
1007
1008impl From<FlagId> for ArchiveContext {
1009 fn from(id: FlagId) -> Self {
1010 Self::Flag(id)
1011 }
1012}
1013
1014impl From<InterviewRunId> for ArchiveContext {
1015 fn from(id: InterviewRunId) -> Self {
1016 Self::InterviewRun(id)
1017 }
1018}
1019
1020impl std::fmt::Display for ArchiveContext {
1023 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1024 let kind = match self {
1025 Self::AgendaItem(_) => "agenda item",
1026 Self::Meeting(_) => "meeting",
1027 Self::Appeal(_) => "appeal",
1028 Self::Flag(_) => "flag",
1029 Self::InterviewRun(_) => "interview run",
1030 };
1031 write!(f, "{kind} {}", self.as_uuid())
1032 }
1033}
1034
1035#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1041#[error(
1042 "not a governance log id (expected GOV-, APP-, AMD-, KEY-, REC-, OBL-, \
1043 DATA- or TEST-YYYY-NNNN): {0:?}"
1044)]
1045pub struct GovernanceLogIdError(pub String);
1046
1047#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1053pub enum GovernanceLogPrefix {
1054 Gov,
1056 App,
1058 Amd,
1060 Key,
1062 Rec,
1064 Obl,
1066 Data,
1069 Test,
1072 Unknown,
1076}
1077
1078impl GovernanceLogPrefix {
1079 pub const ALL: [Self; 8] = [
1081 Self::Gov,
1082 Self::App,
1083 Self::Amd,
1084 Self::Key,
1085 Self::Rec,
1086 Self::Obl,
1087 Self::Data,
1088 Self::Test,
1089 ];
1090
1091 pub fn as_str(&self) -> &'static str {
1094 match self {
1095 Self::Gov => "GOV",
1096 Self::App => "APP",
1097 Self::Amd => "AMD",
1098 Self::Key => "KEY",
1099 Self::Rec => "REC",
1100 Self::Obl => "OBL",
1101 Self::Data => "DATA",
1102 Self::Test => "TEST",
1103 Self::Unknown => "?",
1104 }
1105 }
1106}
1107
1108impl std::fmt::Display for GovernanceLogPrefix {
1109 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1110 f.write_str(self.as_str())
1111 }
1112}
1113
1114impl std::str::FromStr for GovernanceLogPrefix {
1115 type Err = GovernanceLogIdError;
1116
1117 fn from_str(s: &str) -> Result<Self, Self::Err> {
1118 match s {
1119 "GOV" => Ok(Self::Gov),
1120 "APP" => Ok(Self::App),
1121 "AMD" => Ok(Self::Amd),
1122 "KEY" => Ok(Self::Key),
1123 "REC" => Ok(Self::Rec),
1124 "OBL" => Ok(Self::Obl),
1125 "DATA" => Ok(Self::Data),
1126 "TEST" => Ok(Self::Test),
1127 _ => Err(GovernanceLogIdError(s.to_string())),
1128 }
1129 }
1130}
1131
1132#[derive(
1153 Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
1154)]
1155#[serde(try_from = "String")]
1156#[cfg_attr(feature = "sqlx", derive(sqlx::Type))]
1157#[cfg_attr(feature = "sqlx", sqlx(transparent))]
1158pub struct GovernanceLogId(String);
1159
1160impl GovernanceLogId {
1161 pub fn as_str(&self) -> &str {
1163 &self.0
1164 }
1165
1166 pub fn into_inner(self) -> String {
1168 self.0
1169 }
1170
1171 pub fn is_citation_shaped(s: &str) -> bool {
1179 Self::parts(s).is_some()
1180 }
1181
1182 pub fn prefix(&self) -> GovernanceLogPrefix {
1184 Self::parts(&self.0).map_or(GovernanceLogPrefix::Unknown, |p| p.0)
1185 }
1186
1187 fn is_canonical_unknown(s: &str) -> bool {
1191 let parts: Vec<&str> = s.split('-').collect();
1192 let digits =
1193 |p: &str| p.len() == 4 && p.chars().all(|c| c.is_ascii_digit());
1194 matches!(parts.as_slice(), [letters, year, serial]
1195 if (3..=4).contains(&letters.len())
1196 && letters.chars().all(|c| c.is_ascii_uppercase())
1197 && digits(year)
1198 && digits(serial))
1199 }
1200
1201 pub fn normalize(s: &str) -> Option<String> {
1207 let mut parts = s.trim().split(['-', '.', '/', ' ']);
1208 let (prefix, year, serial) =
1209 (parts.next()?, parts.next()?, parts.next()?);
1210 if parts.next().is_some() {
1211 return None;
1212 }
1213 let prefix: GovernanceLogPrefix =
1214 prefix.to_ascii_uppercase().parse().ok()?;
1215 let digits = |p: &str| p.chars().all(|c| c.is_ascii_digit());
1216 (year.len() == 4
1217 && digits(year)
1218 && (1..=4).contains(&serial.len())
1219 && digits(serial))
1220 .then(|| format!("{prefix}-{year}-{serial:0>4}"))
1221 }
1222
1223 pub fn rewritten_in<'a>(&self, written: &'a str) -> Option<&'a str> {
1227 let whole = written.trim();
1228 if whole.contains(self.as_str()) {
1229 return None;
1230 }
1231 std::iter::once(whole)
1232 .chain(whole.split(|c: char| {
1233 matches!(
1234 c,
1235 '/' | '?'
1236 | '&'
1237 | '='
1238 | ':'
1239 | '#'
1240 | '`'
1241 | '"'
1242 | '\''
1243 | '<'
1244 | '>'
1245 ) || c.is_whitespace()
1246 }))
1247 .find(|part| {
1248 Self::normalize(part).as_deref() == Some(self.as_str())
1249 })
1250 }
1251
1252 pub fn from_parts(
1255 prefix: GovernanceLogPrefix,
1256 year: i32,
1257 serial: u32,
1258 ) -> Option<Self> {
1259 (prefix != GovernanceLogPrefix::Unknown
1260 && (1000..=9999).contains(&year)
1261 && (1..=9999).contains(&serial))
1262 .then(|| Self(format!("{prefix}-{year}-{serial:04}")))
1263 }
1264
1265 fn parts(s: &str) -> Option<(GovernanceLogPrefix, &str, &str)> {
1266 let parts: Vec<&str> = s.split('-').collect();
1267 let [prefix, year, serial] = parts.as_slice() else {
1268 return None;
1269 };
1270 let prefix: GovernanceLogPrefix = prefix.parse().ok()?;
1271 (year.len() == 4
1272 && serial.len() == 4
1273 && year.chars().all(|c| c.is_ascii_digit())
1274 && serial.chars().all(|c| c.is_ascii_digit()))
1275 .then_some((prefix, year, serial))
1276 }
1277}
1278
1279impl std::fmt::Display for GovernanceLogId {
1280 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1281 f.write_str(&self.0)
1282 }
1283}
1284
1285impl AsRef<str> for GovernanceLogId {
1286 fn as_ref(&self) -> &str {
1287 &self.0
1288 }
1289}
1290
1291impl std::str::FromStr for GovernanceLogId {
1292 type Err = GovernanceLogIdError;
1293
1294 fn from_str(s: &str) -> Result<Self, Self::Err> {
1297 Self::normalize(s)
1298 .map(Self)
1299 .ok_or_else(|| GovernanceLogIdError(s.to_string()))
1300 }
1301}
1302
1303impl TryFrom<String> for GovernanceLogId {
1304 type Error = GovernanceLogIdError;
1305
1306 fn try_from(s: String) -> Result<Self, Self::Error> {
1309 if Self::is_citation_shaped(&s) || Self::is_canonical_unknown(&s) {
1310 return Ok(Self(s));
1311 }
1312 s.parse()
1313 }
1314}
1315
1316impl From<GovernanceLogId> for String {
1317 fn from(id: GovernanceLogId) -> Self {
1318 id.0
1319 }
1320}
1321
1322#[cfg(feature = "schemars")]
1328impl schemars::JsonSchema for GovernanceLogId {
1329 fn inline_schema() -> bool {
1330 true
1331 }
1332
1333 fn schema_name() -> std::borrow::Cow<'static, str> {
1334 std::borrow::Cow::Borrowed("GovernanceLogId")
1335 }
1336
1337 fn schema_id() -> std::borrow::Cow<'static, str> {
1338 std::borrow::Cow::Borrowed(concat!(module_path!(), "::GovernanceLogId"))
1339 }
1340
1341 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1342 schemars::json_schema!({
1343 "type": "string",
1344 "pattern": GOVERNANCE_LOG_ID_PATTERN,
1345 "description": "Governance log entry id, e.g. \"GOV-2026-0006\" \
1346 (Council decision or policy change), \
1347 \"APP-2026-0003\" (appeals ruling), \
1348 \"AMD-2026-0001\" (amendment to an earlier \
1349 entry), \"KEY-2026-0001\" (signing key \
1350 rotation), \"REC-2026-0001\" (a Steward's \
1351 record of an operational act), \
1352 \"OBL-2026-0001\" (an obligation), \
1353 \"DATA-2026-0001\" (a data set) or \
1354 \"TEST-2026-0001\" (a test sitting's record; \
1355 not binding).",
1356 })
1357 }
1358}
1359
1360#[derive(
1369 Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
1370)]
1371#[serde(try_from = "String")]
1372#[cfg_attr(feature = "sqlx", derive(sqlx::Type))]
1373#[cfg_attr(feature = "sqlx", sqlx(transparent))]
1374pub struct OAuthClientId(String);
1375
1376#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1378#[error("not an OAuth client id: {0:?}")]
1379pub struct OAuthClientIdError(pub String);
1380
1381impl OAuthClientId {
1382 pub fn generate() -> Self {
1384 Self(Uuid::new_v4().to_string())
1385 }
1386
1387 pub fn as_str(&self) -> &str {
1389 &self.0
1390 }
1391
1392 pub fn into_inner(self) -> String {
1394 self.0
1395 }
1396
1397 fn is_valid(s: &str) -> bool {
1398 !s.is_empty() && s.len() <= 255 && !s.chars().any(char::is_control)
1399 }
1400}
1401
1402impl std::fmt::Display for OAuthClientId {
1403 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1404 f.write_str(&self.0)
1405 }
1406}
1407
1408impl AsRef<str> for OAuthClientId {
1409 fn as_ref(&self) -> &str {
1410 &self.0
1411 }
1412}
1413
1414impl std::str::FromStr for OAuthClientId {
1415 type Err = OAuthClientIdError;
1416
1417 fn from_str(s: &str) -> Result<Self, Self::Err> {
1418 Self::try_from(s.to_string())
1419 }
1420}
1421
1422impl TryFrom<String> for OAuthClientId {
1423 type Error = OAuthClientIdError;
1424
1425 fn try_from(s: String) -> Result<Self, Self::Error> {
1426 if Self::is_valid(&s) {
1427 Ok(Self(s))
1428 } else {
1429 Err(OAuthClientIdError(s))
1430 }
1431 }
1432}
1433
1434impl From<OAuthClientId> for String {
1435 fn from(id: OAuthClientId) -> Self {
1436 id.0
1437 }
1438}
1439
1440#[cfg(feature = "schemars")]
1443impl schemars::JsonSchema for OAuthClientId {
1444 fn inline_schema() -> bool {
1445 true
1446 }
1447
1448 fn schema_name() -> std::borrow::Cow<'static, str> {
1449 std::borrow::Cow::Borrowed("OAuthClientId")
1450 }
1451
1452 fn schema_id() -> std::borrow::Cow<'static, str> {
1453 std::borrow::Cow::Borrowed(concat!(module_path!(), "::OAuthClientId"))
1454 }
1455
1456 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1457 schemars::json_schema!({
1458 "type": "string",
1459 "minLength": 1,
1460 "maxLength": 255,
1461 "description": "OAuth client_id issued at dynamic client registration.",
1462 })
1463 }
1464}
1465
1466#[derive(Debug, Clone, PartialEq, Eq, Hash)]
1473pub enum PlatformDoc {
1474 Constitution,
1476 GovernanceProtocol,
1479 Prompts,
1481 Prompt(PromptName),
1483 Calendar,
1487}
1488
1489impl PlatformDoc {
1490 pub const SLUGS: [&'static str; 5] = [
1493 "constitution",
1494 "protocol",
1495 "prompts",
1496 "prompt:<name>",
1497 "calendar",
1498 ];
1499
1500 pub fn slug(&self) -> std::borrow::Cow<'static, str> {
1502 match self {
1503 PlatformDoc::Constitution => "constitution".into(),
1504 PlatformDoc::GovernanceProtocol => "protocol".into(),
1505 PlatformDoc::Prompts => "prompts".into(),
1506 PlatformDoc::Prompt(name) => format!("prompt:{name}").into(),
1507 PlatformDoc::Calendar => "calendar".into(),
1508 }
1509 }
1510
1511 pub fn title(&self) -> std::borrow::Cow<'static, str> {
1514 match self {
1515 PlatformDoc::Constitution => "The Agora Constitution".into(),
1516 PlatformDoc::GovernanceProtocol => {
1517 "The Agora Governance Protocol".into()
1518 }
1519 PlatformDoc::Prompts => "Agora's Model Prompts".into(),
1520 PlatformDoc::Prompt(name) => format!("Model prompt: {name}").into(),
1521 PlatformDoc::Calendar => "The Agora calendar".into(),
1522 }
1523 }
1524
1525 pub fn as_prompt(&self) -> Option<&PromptName> {
1527 match self {
1528 PlatformDoc::Prompt(name) => Some(name),
1529 _ => None,
1530 }
1531 }
1532}
1533
1534impl std::fmt::Display for PlatformDoc {
1535 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1536 f.write_str(&self.slug())
1537 }
1538}
1539
1540#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1542#[error(
1543 "not a platform document (expected \"constitution\", \"protocol\", \
1544 \"prompts\", \"calendar\" or \"prompt:<name>\"): {0:?}"
1545)]
1546pub struct PlatformDocError(pub String);
1547
1548const PROMPT_PREFIXES: [&str; 4] =
1552 ["prompt:", "prompt/", "prompts/", "prompts:"];
1553
1554impl std::str::FromStr for PlatformDoc {
1555 type Err = PlatformDocError;
1556
1557 fn from_str(s: &str) -> Result<Self, Self::Err> {
1561 if s.eq_ignore_ascii_case("constitution") {
1562 Ok(PlatformDoc::Constitution)
1563 } else if s.eq_ignore_ascii_case("protocol")
1564 || s.eq_ignore_ascii_case("governance-protocol")
1565 {
1566 Ok(PlatformDoc::GovernanceProtocol)
1567 } else if s.eq_ignore_ascii_case("prompts")
1568 || s.eq_ignore_ascii_case("prompt")
1569 {
1570 Ok(PlatformDoc::Prompts)
1571 } else if s.eq_ignore_ascii_case("calendar") {
1572 Ok(PlatformDoc::Calendar)
1573 } else {
1574 PROMPT_PREFIXES
1575 .iter()
1576 .find_map(|prefix| {
1577 let head = s.get(..prefix.len())?;
1578 head.eq_ignore_ascii_case(prefix)
1579 .then(|| s[prefix.len()..].parse().ok())
1580 .flatten()
1581 })
1582 .map(PlatformDoc::Prompt)
1583 .ok_or_else(|| PlatformDocError(s.to_string()))
1584 }
1585 }
1586}
1587
1588impl Serialize for PlatformDoc {
1589 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
1590 s.collect_str(self)
1591 }
1592}
1593
1594impl<'de> Deserialize<'de> for PlatformDoc {
1595 fn deserialize<D: serde::Deserializer<'de>>(
1596 d: D,
1597 ) -> Result<Self, D::Error> {
1598 let raw = String::deserialize(d)?;
1599 raw.parse().map_err(serde::de::Error::custom)
1600 }
1601}
1602
1603#[cfg(feature = "schemars")]
1606impl schemars::JsonSchema for PlatformDoc {
1607 fn inline_schema() -> bool {
1608 true
1609 }
1610
1611 fn schema_name() -> std::borrow::Cow<'static, str> {
1612 std::borrow::Cow::Borrowed("PlatformDoc")
1613 }
1614
1615 fn schema_id() -> std::borrow::Cow<'static, str> {
1616 std::borrow::Cow::Borrowed(concat!(module_path!(), "::PlatformDoc"))
1617 }
1618
1619 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1620 schemars::json_schema!({
1621 "type": "string",
1622 "pattern": PLATFORM_DOC_PATTERN,
1623 "description": "A platform document: \"constitution\", \
1624 \"protocol\" (the Governance Protocol), \
1625 \"prompts\" (the index of published model \
1626 prompts), \"prompt:<name>\" (one prompt, \
1627 e.g. \"prompt:tier2_reviewer\"), or \
1628 \"calendar\" (the sittings and obligation deadlines the \
1629 Steward and the Council scheduled).",
1630 })
1631 }
1632}
1633
1634#[derive(
1642 Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
1643)]
1644#[serde(try_from = "String")]
1645pub struct PromptName(String);
1646
1647#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1649#[error(
1650 "not a prompt name (lowercase letters, digits and `_`, e.g. \
1651 \"tier2_reviewer\"): {0:?}"
1652)]
1653pub struct PromptNameError(pub String);
1654
1655impl PromptName {
1656 pub const MAX_LEN: usize = 64;
1658
1659 pub fn as_str(&self) -> &str {
1661 &self.0
1662 }
1663
1664 fn normalize(s: &str) -> Option<String> {
1665 let s = s.trim();
1666 let s = match s.len().checked_sub(3) {
1667 Some(n)
1668 if s.is_char_boundary(n)
1669 && s[n..].eq_ignore_ascii_case(".md") =>
1670 {
1671 &s[..n]
1672 }
1673 _ => s,
1674 };
1675 let name: String = s
1676 .chars()
1677 .map(|c| match c {
1678 '-' => '_',
1679 c => c.to_ascii_lowercase(),
1680 })
1681 .collect();
1682 let mut chars = name.chars();
1683 let valid = name.len() <= Self::MAX_LEN
1684 && chars.next().is_some_and(|c| c.is_ascii_lowercase())
1685 && chars.all(|c| {
1686 c.is_ascii_lowercase() || c.is_ascii_digit() || c == '_'
1687 });
1688 valid.then_some(name)
1689 }
1690}
1691
1692impl std::fmt::Display for PromptName {
1693 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1694 f.write_str(&self.0)
1695 }
1696}
1697
1698impl AsRef<str> for PromptName {
1699 fn as_ref(&self) -> &str {
1700 &self.0
1701 }
1702}
1703
1704impl std::str::FromStr for PromptName {
1705 type Err = PromptNameError;
1706
1707 fn from_str(s: &str) -> Result<Self, Self::Err> {
1708 Self::normalize(s)
1709 .map(Self)
1710 .ok_or_else(|| PromptNameError(s.to_string()))
1711 }
1712}
1713
1714impl TryFrom<String> for PromptName {
1715 type Error = PromptNameError;
1716
1717 fn try_from(s: String) -> Result<Self, Self::Error> {
1718 s.parse()
1719 }
1720}
1721
1722impl From<PromptName> for PlatformDoc {
1723 fn from(name: PromptName) -> Self {
1724 PlatformDoc::Prompt(name)
1725 }
1726}
1727
1728#[cfg(feature = "schemars")]
1729impl schemars::JsonSchema for PromptName {
1730 fn inline_schema() -> bool {
1731 true
1732 }
1733
1734 fn schema_name() -> std::borrow::Cow<'static, str> {
1735 std::borrow::Cow::Borrowed("PromptName")
1736 }
1737
1738 fn schema_id() -> std::borrow::Cow<'static, str> {
1739 std::borrow::Cow::Borrowed(concat!(module_path!(), "::PromptName"))
1740 }
1741
1742 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1743 schemars::json_schema!({
1744 "type": "string",
1745 "pattern": PROMPT_NAME_PATTERN,
1746 "maxLength": PromptName::MAX_LEN,
1747 "description": "A published model prompt's name, e.g. \
1748 \"tier2_reviewer\". `get_content(\"prompts\")` \
1749 lists them.",
1750 })
1751 }
1752}
1753
1754#[derive(
1760 Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
1761)]
1762#[serde(try_from = "String")]
1763pub struct WitnessId(String);
1764
1765#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1767#[error(
1768 "not a witness id (lowercase letters, digits and `-`, e.g. \"qwen\"): \
1769 {0:?}"
1770)]
1771pub struct WitnessIdError(pub String);
1772
1773impl WitnessId {
1774 pub const MAX_LEN: usize = 64;
1776
1777 pub fn as_str(&self) -> &str {
1779 &self.0
1780 }
1781
1782 fn normalize(s: &str) -> Option<String> {
1783 let id: String = s
1784 .trim()
1785 .chars()
1786 .map(|c| match c {
1787 '_' => '-',
1788 c => c.to_ascii_lowercase(),
1789 })
1790 .collect();
1791 let mut chars = id.chars();
1792 let valid = id.len() <= Self::MAX_LEN
1793 && chars.next().is_some_and(|c| c.is_ascii_lowercase())
1794 && chars.all(|c| {
1795 c.is_ascii_lowercase() || c.is_ascii_digit() || c == '-'
1796 });
1797 valid.then_some(id)
1798 }
1799}
1800
1801impl std::fmt::Display for WitnessId {
1802 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1803 f.write_str(&self.0)
1804 }
1805}
1806
1807impl AsRef<str> for WitnessId {
1808 fn as_ref(&self) -> &str {
1809 &self.0
1810 }
1811}
1812
1813impl std::str::FromStr for WitnessId {
1814 type Err = WitnessIdError;
1815
1816 fn from_str(s: &str) -> Result<Self, Self::Err> {
1817 Self::normalize(s)
1818 .map(Self)
1819 .ok_or_else(|| WitnessIdError(s.to_string()))
1820 }
1821}
1822
1823impl TryFrom<String> for WitnessId {
1824 type Error = WitnessIdError;
1825
1826 fn try_from(s: String) -> Result<Self, Self::Error> {
1827 s.parse()
1828 }
1829}
1830
1831#[cfg(feature = "schemars")]
1834impl schemars::JsonSchema for WitnessId {
1835 fn inline_schema() -> bool {
1836 true
1837 }
1838
1839 fn schema_name() -> std::borrow::Cow<'static, str> {
1840 std::borrow::Cow::Borrowed("WitnessId")
1841 }
1842
1843 fn schema_id() -> std::borrow::Cow<'static, str> {
1844 std::borrow::Cow::Borrowed(concat!(module_path!(), "::WitnessId"))
1845 }
1846
1847 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1848 schemars::json_schema!({
1849 "type": "string",
1850 "maxLength": WitnessId::MAX_LEN,
1851 "description": "A witness's id, as the item's list of witnesses \
1852 gives it, e.g. \"qwen\"",
1853 })
1854 }
1855}
1856
1857#[derive(
1866 Debug,
1867 Clone,
1868 Copy,
1869 PartialEq,
1870 Eq,
1871 PartialOrd,
1872 Ord,
1873 Hash,
1874 Serialize,
1875 Deserialize,
1876)]
1877#[serde(try_from = "u32", into = "u32")]
1878pub struct WitnessQuestionId(u32);
1879
1880#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1882#[error("not a witness question number (a number from 1, e.g. 3): {0:?}")]
1883pub struct WitnessQuestionIdError(pub String);
1884
1885impl WitnessQuestionId {
1886 pub fn new(n: u32) -> Option<Self> {
1888 (n >= 1).then_some(Self(n))
1889 }
1890
1891 pub fn get(&self) -> u32 {
1893 self.0
1894 }
1895
1896 pub fn next(&self) -> Self {
1898 Self(self.0.saturating_add(1))
1899 }
1900}
1901
1902impl Default for WitnessQuestionId {
1903 fn default() -> Self {
1905 Self(1)
1906 }
1907}
1908
1909impl std::fmt::Display for WitnessQuestionId {
1910 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1911 self.0.fmt(f)
1912 }
1913}
1914
1915impl std::str::FromStr for WitnessQuestionId {
1918 type Err = WitnessQuestionIdError;
1919
1920 fn from_str(s: &str) -> Result<Self, Self::Err> {
1921 let t = s.trim();
1922 Some(t)
1923 .filter(|n| {
1924 !n.is_empty()
1925 && !n.starts_with('0')
1926 && n.bytes().all(|b| b.is_ascii_digit())
1927 })
1928 .and_then(|n| n.parse::<u32>().ok())
1929 .and_then(Self::new)
1930 .ok_or_else(|| WitnessQuestionIdError(s.to_string()))
1931 }
1932}
1933
1934impl TryFrom<u32> for WitnessQuestionId {
1935 type Error = WitnessQuestionIdError;
1936
1937 fn try_from(n: u32) -> Result<Self, Self::Error> {
1938 Self::new(n).ok_or_else(|| WitnessQuestionIdError(n.to_string()))
1939 }
1940}
1941
1942impl From<WitnessQuestionId> for u32 {
1943 fn from(id: WitnessQuestionId) -> Self {
1944 id.0
1945 }
1946}
1947
1948#[cfg(feature = "schemars")]
1951impl schemars::JsonSchema for WitnessQuestionId {
1952 fn inline_schema() -> bool {
1953 true
1954 }
1955
1956 fn schema_name() -> std::borrow::Cow<'static, str> {
1957 std::borrow::Cow::Borrowed("WitnessQuestionId")
1958 }
1959
1960 fn schema_id() -> std::borrow::Cow<'static, str> {
1961 std::borrow::Cow::Borrowed(concat!(
1962 module_path!(),
1963 "::WitnessQuestionId"
1964 ))
1965 }
1966
1967 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1968 schemars::json_schema!({
1969 "type": "integer",
1970 "description": "A witness question's number on the item, e.g. 3",
1971 })
1972 }
1973}
1974
1975#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1991pub struct ContentIdPrefix(u32);
1992
1993#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1995#[error(
1996 "not a short id (the first eight hex digits of a UUID, e.g. \"7ad26ccd\"): {0:?}"
1997)]
1998pub struct ContentIdPrefixError(pub String);
1999
2000impl ContentIdPrefix {
2001 pub const LEN: usize = 8;
2003
2004 pub fn of(id: &Uuid) -> Self {
2006 Self((id.as_u128() >> 96) as u32)
2007 }
2008
2009 pub fn bounds(&self) -> (Uuid, Uuid) {
2011 let lo = (self.0 as u128) << 96;
2012 let hi = lo | ((1u128 << 96) - 1);
2013 (Uuid::from_u128(lo), Uuid::from_u128(hi))
2014 }
2015
2016 pub fn matches(&self, id: &Uuid) -> bool {
2018 Self::of(id) == *self
2019 }
2020}
2021
2022impl std::fmt::Display for ContentIdPrefix {
2023 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2024 write!(f, "{:08x}", self.0)
2025 }
2026}
2027
2028impl std::str::FromStr for ContentIdPrefix {
2029 type Err = ContentIdPrefixError;
2030
2031 fn from_str(s: &str) -> Result<Self, Self::Err> {
2032 let t = s.trim();
2033 if t.len() == Self::LEN && t.bytes().all(|b| b.is_ascii_hexdigit()) {
2034 Ok(Self(u32::from_str_radix(t, 16).expect("eight hex digits")))
2036 } else {
2037 Err(ContentIdPrefixError(s.to_string()))
2038 }
2039 }
2040}
2041
2042impl TryFrom<String> for ContentIdPrefix {
2043 type Error = ContentIdPrefixError;
2044
2045 fn try_from(s: String) -> Result<Self, Self::Error> {
2046 s.parse()
2047 }
2048}
2049
2050impl Serialize for ContentIdPrefix {
2051 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
2052 s.collect_str(self)
2053 }
2054}
2055
2056impl<'de> Deserialize<'de> for ContentIdPrefix {
2057 fn deserialize<D: serde::Deserializer<'de>>(
2058 d: D,
2059 ) -> Result<Self, D::Error> {
2060 let raw = String::deserialize(d)?;
2061 raw.parse().map_err(serde::de::Error::custom)
2062 }
2063}
2064
2065impl From<ContentId> for ContentIdPrefix {
2066 fn from(id: ContentId) -> Self {
2067 Self::of(id.as_uuid())
2068 }
2069}
2070
2071#[cfg(feature = "schemars")]
2072impl schemars::JsonSchema for ContentIdPrefix {
2073 fn inline_schema() -> bool {
2074 true
2075 }
2076
2077 fn schema_name() -> std::borrow::Cow<'static, str> {
2078 std::borrow::Cow::Borrowed("ContentIdPrefix")
2079 }
2080
2081 fn schema_id() -> std::borrow::Cow<'static, str> {
2082 std::borrow::Cow::Borrowed(concat!(module_path!(), "::ContentIdPrefix"))
2083 }
2084
2085 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
2086 schemars::json_schema!({
2087 "type": "string",
2088 "pattern": CONTENT_ID_PREFIX_PATTERN,
2089 "description": "A short post or comment id: the first eight hex \
2090 digits of its UUID, e.g. \"7ad26ccd\".",
2091 })
2092 }
2093}
2094
2095pub const CONTENT_TARGET_PATTERN: &str = "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[0-9a-f]{8})$";
2100
2101#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2110pub enum ContentTarget {
2111 Id(ContentId),
2113 Prefix(ContentIdPrefix),
2115}
2116
2117impl ContentTarget {
2118 pub fn full(&self) -> Option<ContentId> {
2120 match self {
2121 ContentTarget::Id(id) => Some(*id),
2122 ContentTarget::Prefix(_) => None,
2123 }
2124 }
2125}
2126
2127impl From<ContentId> for ContentTarget {
2128 fn from(id: ContentId) -> Self {
2129 ContentTarget::Id(id)
2130 }
2131}
2132
2133impl std::fmt::Display for ContentTarget {
2134 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2135 match self {
2136 ContentTarget::Id(id) => id.fmt(f),
2137 ContentTarget::Prefix(prefix) => prefix.fmt(f),
2138 }
2139 }
2140}
2141
2142fn ascii_dashes(s: &str) -> String {
2147 s.chars()
2148 .map(|c| match c {
2149 '\u{2010}'..='\u{2014}' | '\u{2212}' => '-',
2150 c => c,
2151 })
2152 .collect()
2153}
2154
2155impl std::str::FromStr for ContentTarget {
2156 type Err = ContentTargetError;
2157
2158 fn from_str(s: &str) -> Result<Self, Self::Err> {
2159 let t = ascii_dashes(s.trim());
2160 if let Ok(id) = t.parse::<Uuid>() {
2161 return Ok(ContentTarget::Id(id.into()));
2162 }
2163 if let Ok(prefix) = t.parse::<ContentIdPrefix>() {
2164 return Ok(ContentTarget::Prefix(prefix));
2165 }
2166 const UUID_LEN: usize = 36;
2169 let leading = t
2170 .get(..UUID_LEN)
2171 .and_then(|head| head.parse::<Uuid>().ok())
2172 .map(ContentId::from);
2173 Err(ContentTargetError {
2174 field: None,
2175 input: s.to_string(),
2176 leading,
2177 })
2178 }
2179}
2180
2181#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
2187pub struct ContentTargetError {
2188 field: Option<&'static str>,
2189 input: String,
2190 leading: Option<ContentId>,
2191}
2192
2193impl ContentTargetError {
2194 pub fn in_field(mut self, field: &'static str) -> Self {
2196 self.field = Some(field);
2197 self
2198 }
2199}
2200
2201impl std::fmt::Display for ContentTargetError {
2202 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2203 match self.field {
2204 Some(field) => write!(f, "`{field}` must be")?,
2205 None => f.write_str("Expected")?,
2206 }
2207 f.write_str(
2208 " a post or comment id: a full UUID or its first 8 hex digits \
2209 (e.g. \"7ad26ccd\")",
2210 )?;
2211 write!(f, ", not \"{}\"", echo(&self.input))?;
2212 if let Some(id) = self.leading {
2213 write!(
2214 f,
2215 ". It starts with the id {id} followed by extra text; pass only the id"
2216 )?;
2217 }
2218 f.write_str(".")
2219 }
2220}
2221
2222impl Serialize for ContentTarget {
2223 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
2224 s.collect_str(self)
2225 }
2226}
2227
2228impl<'de> Deserialize<'de> for ContentTarget {
2229 fn deserialize<D: serde::Deserializer<'de>>(
2230 d: D,
2231 ) -> Result<Self, D::Error> {
2232 content_target::deserialize_field(d, "id")
2233 }
2234}
2235
2236pub mod content_target {
2239 use serde::de::{self, Deserializer, Visitor};
2240
2241 use super::{ContentTarget, ContentTargetError};
2242
2243 struct TargetVisitor(&'static str);
2247
2248 impl Visitor<'_> for TargetVisitor {
2249 type Value = ContentTarget;
2250
2251 fn expecting(
2252 &self,
2253 f: &mut std::fmt::Formatter<'_>,
2254 ) -> std::fmt::Result {
2255 write!(
2256 f,
2257 "`{}` to be a post or comment id: a full UUID or its first 8 hex digits \
2258 (e.g. \"7ad26ccd\")",
2259 self.0
2260 )
2261 }
2262
2263 fn visit_str<E: de::Error>(self, v: &str) -> Result<ContentTarget, E> {
2264 v.parse()
2265 .map_err(|e: ContentTargetError| E::custom(e.in_field(self.0)))
2266 }
2267 }
2268
2269 pub(super) fn deserialize_field<'de, D: Deserializer<'de>>(
2270 d: D,
2271 field: &'static str,
2272 ) -> Result<ContentTarget, D::Error> {
2273 d.deserialize_str(TargetVisitor(field))
2274 }
2275
2276 pub trait ContentField: Sized {
2281 fn reply_to<'de, D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>;
2283 fn target<'de, D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>;
2285 }
2286
2287 impl ContentField for ContentTarget {
2288 fn reply_to<'de, D: Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
2289 reply_to(d)
2290 }
2291
2292 fn target<'de, D: Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
2293 target(d)
2294 }
2295 }
2296
2297 impl ContentField for super::ContentId {
2298 fn reply_to<'de, D: Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
2299 serde::Deserialize::deserialize(d)
2300 }
2301
2302 fn target<'de, D: Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
2303 serde::Deserialize::deserialize(d)
2304 }
2305 }
2306
2307 pub fn reply_to<'de, D: Deserializer<'de>>(
2309 d: D,
2310 ) -> Result<ContentTarget, D::Error> {
2311 deserialize_field(d, "reply_to")
2312 }
2313
2314 pub fn target<'de, D: Deserializer<'de>>(
2316 d: D,
2317 ) -> Result<ContentTarget, D::Error> {
2318 deserialize_field(d, "target")
2319 }
2320
2321 pub fn post_id<'de, D: Deserializer<'de>>(
2323 d: D,
2324 ) -> Result<ContentTarget, D::Error> {
2325 deserialize_field(d, "post_id")
2326 }
2327
2328 pub fn optional_reply_to<'de, D: Deserializer<'de>>(
2330 d: D,
2331 ) -> Result<Option<ContentTarget>, D::Error> {
2332 reply_to(d).map(Some)
2333 }
2334
2335 pub fn optional_target<'de, D: Deserializer<'de>>(
2339 d: D,
2340 ) -> Result<Option<ContentTarget>, D::Error> {
2341 d.deserialize_option(OptionalVisitor("target"))
2342 }
2343
2344 struct OptionalVisitor(&'static str);
2346
2347 impl<'de> Visitor<'de> for OptionalVisitor {
2348 type Value = Option<ContentTarget>;
2349
2350 fn expecting(
2351 &self,
2352 f: &mut std::fmt::Formatter<'_>,
2353 ) -> std::fmt::Result {
2354 TargetVisitor(self.0).expecting(f)?;
2355 f.write_str(", or nothing")
2356 }
2357
2358 fn visit_none<E: de::Error>(self) -> Result<Self::Value, E> {
2359 Ok(None)
2360 }
2361
2362 fn visit_unit<E: de::Error>(self) -> Result<Self::Value, E> {
2363 Ok(None)
2364 }
2365
2366 fn visit_some<D: Deserializer<'de>>(
2367 self,
2368 d: D,
2369 ) -> Result<Self::Value, D::Error> {
2370 d.deserialize_str(self)
2371 }
2372
2373 fn visit_str<E: de::Error>(self, v: &str) -> Result<Self::Value, E> {
2374 if v.is_empty() || v.trim().eq_ignore_ascii_case("null") {
2375 return Ok(None);
2376 }
2377 TargetVisitor(self.0).visit_str(v).map(Some)
2378 }
2379 }
2380}
2381
2382#[cfg(feature = "schemars")]
2386impl schemars::JsonSchema for ContentTarget {
2387 fn inline_schema() -> bool {
2388 true
2389 }
2390
2391 fn schema_name() -> std::borrow::Cow<'static, str> {
2392 std::borrow::Cow::Borrowed("ContentTarget")
2393 }
2394
2395 fn schema_id() -> std::borrow::Cow<'static, str> {
2396 std::borrow::Cow::Borrowed(concat!(module_path!(), "::ContentTarget"))
2397 }
2398
2399 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
2400 schemars::json_schema!({
2401 "type": "string",
2402 "pattern": CONTENT_TARGET_PATTERN,
2403 "description": "A post or comment id: its full UUID, or its first \
2404 8 hex digits (e.g. \"7ad26ccd\") as shown by \
2405 get_content and the dashboard. A short id works \
2406 only on unsigned calls; a signed call must use \
2407 the full UUID.",
2408 })
2409 }
2410}
2411
2412#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
2415pub struct ContentRefError(pub String);
2416
2417impl ContentRefError {
2418 pub fn leading_ref(&self) -> Option<ContentRef> {
2422 const UUID_LEN: usize = 36;
2423 const CITATION_LENS: [usize; 2] =
2427 ["DATA-2026-0001".len(), "GOV-2026-0006".len()];
2428 let s = self.0.trim_start();
2429 if crate::govlog::DataCitation::is_citation_shaped(s) {
2433 return None;
2434 }
2435 let prompt_len = PROMPT_PREFIXES.iter().find_map(|prefix| {
2437 let head = s.get(..prefix.len())?;
2438 head.eq_ignore_ascii_case(prefix).then(|| {
2439 prefix.len()
2440 + s[prefix.len()..]
2441 .find(|c: char| {
2442 !(c.is_ascii_alphanumeric() || c == '_' || c == '-')
2443 })
2444 .unwrap_or(s.len() - prefix.len())
2445 })
2446 });
2447 prompt_len
2449 .into_iter()
2450 .chain([
2451 UUID_LEN,
2452 CITATION_LENS[0],
2453 CITATION_LENS[1],
2454 "constitution".len(),
2455 "protocol".len(),
2456 "prompts".len(),
2457 ])
2458 .filter(|&n| s.len() > n && s.is_char_boundary(n))
2459 .find_map(|n| {
2463 s[..n]
2464 .parse()
2465 .ok()
2466 .filter(|r| !matches!(r, ContentRef::ContentPrefix(_)))
2467 })
2468 }
2469}
2470
2471impl std::fmt::Display for ContentRefError {
2472 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2473 if self
2475 .0
2476 .trim_start()
2477 .get(..crate::links::SCHEME.len() + 1)
2478 .is_some_and(|s| s.eq_ignore_ascii_case("agora:"))
2479 {
2480 return write!(
2481 f,
2482 "{:?} is an agora:// link, which fetch_agora_link reads; \
2483 get_content takes an id",
2484 self.0
2485 );
2486 }
2487 if crate::govlog::DataCitation::is_citation_shaped(&self.0)
2488 && let Err(e) = self.0.parse::<crate::govlog::DataCitation>()
2489 {
2490 return write!(f, "not a data set citation: {e} ({:?})", self.0);
2491 }
2492 write!(
2493 f,
2494 "not a content reference (expected a post/comment UUID or its \
2495 first eight hex digits, a governance id ({}), a data set's file \
2496 as DATA-YYYY-NNNN:<commit>:<path> or DATA-YYYY-NNNN:/<path>, or \
2497 a document: {}): {:?}",
2498 GovernanceLogPrefix::ALL
2501 .iter()
2502 .map(|p| format!("{p}-YYYY-NNNN"))
2503 .collect::<Vec<_>>()
2504 .join(", "),
2505 PlatformDoc::SLUGS
2506 .iter()
2507 .map(|s| format!("{s:?}"))
2508 .collect::<Vec<_>>()
2509 .join(", "),
2510 self.0
2511 )?;
2512 if let Some(id) = self.leading_ref() {
2513 write!(
2514 f,
2515 ". It starts with the valid id {id} followed by extra text; \
2516 pass only the id"
2517 )?;
2518 }
2519 Ok(())
2520 }
2521}
2522
2523#[derive(Debug, Clone, PartialEq, Eq, Hash)]
2541pub enum ContentRef {
2542 Content(ContentId),
2544 ContentPrefix(ContentIdPrefix),
2547 Governance(GovernanceLogId),
2549 DataCitation(crate::govlog::DataCitation),
2553 Document(PlatformDoc),
2555}
2556
2557impl ContentRef {
2558 pub fn as_content(&self) -> Option<ContentId> {
2560 match self {
2561 ContentRef::Content(id) => Some(*id),
2562 _ => None,
2563 }
2564 }
2565
2566 pub fn as_governance(&self) -> Option<&GovernanceLogId> {
2568 match self {
2569 ContentRef::Governance(id) => Some(id),
2570 _ => None,
2571 }
2572 }
2573
2574 pub fn as_document(&self) -> Option<&PlatformDoc> {
2576 match self {
2577 ContentRef::Document(doc) => Some(doc),
2578 _ => None,
2579 }
2580 }
2581
2582 pub fn as_data_citation(&self) -> Option<&crate::govlog::DataCitation> {
2585 match self {
2586 ContentRef::DataCitation(c) => Some(c),
2587 _ => None,
2588 }
2589 }
2590
2591 pub fn data_set(&self) -> Option<&GovernanceLogId> {
2594 match self {
2595 ContentRef::Governance(id)
2596 if id.prefix() == GovernanceLogPrefix::Data =>
2597 {
2598 Some(id)
2599 }
2600 ContentRef::DataCitation(c) => Some(&c.set),
2601 _ => None,
2602 }
2603 }
2604
2605 pub fn is_governance(&self) -> bool {
2609 matches!(self, ContentRef::Governance(_))
2610 }
2611
2612 pub fn kind_str(&self) -> &'static str {
2615 match self {
2616 ContentRef::Content(_) | ContentRef::ContentPrefix(_) => "content",
2617 ContentRef::Governance(_) => "governance",
2618 ContentRef::DataCitation(_) => "data file",
2619 ContentRef::Document(_) => "document",
2620 }
2621 }
2622}
2623
2624impl std::fmt::Display for ContentRef {
2625 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2626 match self {
2627 ContentRef::Content(id) => id.fmt(f),
2628 ContentRef::ContentPrefix(prefix) => prefix.fmt(f),
2629 ContentRef::Governance(id) => id.fmt(f),
2630 ContentRef::DataCitation(c) => c.fmt(f),
2631 ContentRef::Document(doc) => doc.fmt(f),
2632 }
2633 }
2634}
2635
2636impl std::str::FromStr for ContentRef {
2637 type Err = ContentRefError;
2638
2639 fn from_str(s: &str) -> Result<Self, Self::Err> {
2640 if let Ok(id) = s.parse::<ContentId>() {
2641 return Ok(ContentRef::Content(id));
2642 }
2643 if let Ok(prefix) = s.parse::<ContentIdPrefix>() {
2644 return Ok(ContentRef::ContentPrefix(prefix));
2645 }
2646 if let Ok(id) = s.parse::<GovernanceLogId>() {
2647 return Ok(ContentRef::Governance(id));
2648 }
2649 if crate::govlog::DataCitation::is_citation_shaped(s) {
2650 return s
2651 .parse()
2652 .map(ContentRef::DataCitation)
2653 .map_err(|_| ContentRefError(s.to_string()));
2654 }
2655 if let Ok(doc) = s.parse::<PlatformDoc>() {
2656 return Ok(ContentRef::Document(doc));
2657 }
2658 Err(ContentRefError(s.to_string()))
2659 }
2660}
2661
2662impl TryFrom<String> for ContentRef {
2663 type Error = ContentRefError;
2664
2665 fn try_from(s: String) -> Result<Self, Self::Error> {
2666 s.parse()
2667 }
2668}
2669
2670impl From<ContentId> for ContentRef {
2671 fn from(id: ContentId) -> Self {
2672 ContentRef::Content(id)
2673 }
2674}
2675
2676impl From<PostId> for ContentRef {
2677 fn from(id: PostId) -> Self {
2678 ContentRef::Content(id.into())
2679 }
2680}
2681
2682impl From<CommentId> for ContentRef {
2683 fn from(id: CommentId) -> Self {
2684 ContentRef::Content(id.into())
2685 }
2686}
2687
2688impl From<ContentIdPrefix> for ContentRef {
2689 fn from(prefix: ContentIdPrefix) -> Self {
2690 ContentRef::ContentPrefix(prefix)
2691 }
2692}
2693
2694impl From<GovernanceLogId> for ContentRef {
2695 fn from(id: GovernanceLogId) -> Self {
2696 ContentRef::Governance(id)
2697 }
2698}
2699
2700impl From<crate::govlog::DataCitation> for ContentRef {
2701 fn from(c: crate::govlog::DataCitation) -> Self {
2702 ContentRef::DataCitation(c)
2703 }
2704}
2705
2706impl From<PlatformDoc> for ContentRef {
2707 fn from(doc: PlatformDoc) -> Self {
2708 ContentRef::Document(doc)
2709 }
2710}
2711
2712impl Serialize for ContentRef {
2713 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
2714 s.collect_str(self)
2715 }
2716}
2717
2718impl<'de> Deserialize<'de> for ContentRef {
2719 fn deserialize<D: serde::Deserializer<'de>>(
2720 d: D,
2721 ) -> Result<Self, D::Error> {
2722 let raw = String::deserialize(d)?;
2723 raw.parse().map_err(serde::de::Error::custom)
2724 }
2725}
2726
2727#[cfg(feature = "schemars")]
2732impl schemars::JsonSchema for ContentRef {
2733 fn inline_schema() -> bool {
2734 true
2735 }
2736
2737 fn schema_name() -> std::borrow::Cow<'static, str> {
2738 std::borrow::Cow::Borrowed("ContentRef")
2739 }
2740
2741 fn schema_id() -> std::borrow::Cow<'static, str> {
2742 std::borrow::Cow::Borrowed(concat!(module_path!(), "::ContentRef"))
2743 }
2744
2745 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
2746 schemars::json_schema!({
2747 "type": "string",
2748 "pattern": CONTENT_REF_PATTERN,
2749 "description": "A post or comment UUID, or its first eight \
2750 hex digits (e.g. \"7ad26ccd\"); a governance log id \
2751 such as \"GOV-2026-0006\" (Council decision) \
2752 or \"APP-2026-0003\" (appeals ruling); a data \
2753 set's file cited at a commit, \
2754 \"DATA-2026-0001:<commit>:<path>\" (or \
2755 \"…:<path>:110-300\" for some of its lines; \
2756 without the commit, for the one the set pins, \
2757 \"DATA-2026-0001:/<path>\"); or a \
2758 document slug — \"constitution\", \
2759 \"protocol\" (the Governance Protocol), \
2760 \"prompts\" (the index of the model prompts \
2761 moderation, appeals and the Council run on) or \
2762 \"prompt:<name>\" (one of them).",
2763 })
2764 }
2765}
2766
2767#[cfg(test)]
2768mod tests {
2769 #[test]
2772 fn rewritten_in_finds_the_spelling_read() {
2773 let id: super::GovernanceLogId = "GOV-2026-0005".parse().unwrap();
2774 for (written, part) in [
2775 ("GOV-2026-5", Some("GOV-2026-5")),
2776 ("gov-2026-0005", Some("gov-2026-0005")),
2777 (" GOV 2026 5 ", Some("GOV 2026 5")),
2778 ("GOV-2026.5", Some("GOV-2026.5")),
2779 ("agora://gov/GOV-2026-5?round=2", Some("GOV-2026-5")),
2780 ("`agora://gov/gov-2026-05/clerk-reads`", Some("gov-2026-05")),
2781 ("GOV-2026-0005", None),
2782 ("agora://gov/GOV-2026-0005?round=2", None),
2783 ("GOV-2026-6", None),
2784 ] {
2785 assert_eq!(id.rewritten_in(written), part, "{written}");
2786 }
2787 let set: super::GovernanceLogId = "DATA-2026-0001".parse().unwrap();
2788 assert_eq!(
2789 set.rewritten_in("DATA-2026-1:/votes/index.md"),
2790 Some("DATA-2026-1")
2791 );
2792 }
2793 use super::*;
2794
2795 #[test]
2796 fn witness_ids_fold_and_refuse() {
2797 let id: WitnessId = " Qwen_3-8 ".parse().unwrap();
2798 assert_eq!(id.as_str(), "qwen-3-8");
2799 for bad in ["", "3qwen", "-qwen", "qwen 3", "qwen.3", &"q".repeat(65)] {
2800 assert!(bad.parse::<WitnessId>().is_err(), "{bad:?}");
2801 }
2802 let json: WitnessId = serde_json::from_str("\"FACT_checker\"").unwrap();
2803 assert_eq!(json.as_str(), "fact-checker");
2804 assert!(serde_json::from_str::<WitnessId>("\"no way\"").is_err());
2805 }
2806
2807 #[test]
2808 fn witness_question_ids_are_bare_numbers() {
2809 let id: WitnessQuestionId = " 12 ".parse().unwrap();
2810 assert_eq!(id.get(), 12);
2811 assert_eq!(id.to_string(), "12");
2812 assert_eq!(id.next().to_string(), "13");
2813 assert_eq!(WitnessQuestionId::default().to_string(), "1");
2814 for bad in ["", "0", "012", "q12", "-1", "1.5", "1", "99999999999"] {
2815 assert!(bad.parse::<WitnessQuestionId>().is_err(), "{bad:?}");
2816 }
2817 assert_eq!(serde_json::to_string(&id).unwrap(), "12");
2818 assert_eq!(
2819 serde_json::from_str::<WitnessQuestionId>("12").unwrap(),
2820 id
2821 );
2822 assert!(serde_json::from_str::<WitnessQuestionId>("0").is_err());
2823 assert!(serde_json::from_str::<WitnessQuestionId>("\"12\"").is_err());
2824 }
2825
2826 #[cfg(feature = "schemars")]
2827 #[test]
2828 fn witness_question_id_schema_is_inline_and_patternless() {
2829 let schema =
2830 serde_json::to_value(schemars::schema_for!(WitnessQuestionId))
2831 .unwrap();
2832 let rendered = schema.to_string();
2833 assert!(!rendered.contains("pattern"), "{rendered}");
2834 assert!(!rendered.contains("$ref"), "{rendered}");
2835 }
2836
2837 #[cfg(feature = "schemars")]
2838 #[test]
2839 fn witness_id_schema_is_inline_and_patternless() {
2840 let schema =
2841 serde_json::to_value(schemars::schema_for!(WitnessId)).unwrap();
2842 let rendered = schema.to_string();
2843 assert!(!rendered.contains("pattern"), "{rendered}");
2844 assert!(!rendered.contains("$ref"), "{rendered}");
2845 }
2846
2847 #[test]
2848 fn governance_log_ids_from_parts() {
2849 for prefix in GovernanceLogPrefix::ALL {
2850 let id = GovernanceLogId::from_parts(prefix, 2026, 42).unwrap();
2851 assert_eq!(id.as_str(), format!("{prefix}-2026-0042"));
2852 assert_eq!(id.prefix(), prefix);
2853 assert_eq!(id.as_str().parse::<GovernanceLogId>().unwrap(), id);
2854 }
2855 let gov = GovernanceLogPrefix::Gov;
2856 assert!(GovernanceLogId::from_parts(gov, 2026, 9999).is_some());
2857 assert!(GovernanceLogId::from_parts(gov, 2026, 10_000).is_none());
2858 assert!(GovernanceLogId::from_parts(gov, 2026, 0).is_none());
2859 assert!(GovernanceLogId::from_parts(gov, 999, 1).is_none());
2860 }
2861
2862 #[test]
2864 fn archive_contexts_round_trip_through_their_columns() {
2865 use crate::enums::ArchiveContextKind;
2866 let contexts = [
2867 ArchiveContext::from(AgendaItemId::new()),
2868 ArchiveContext::from(CouncilMeetingId::new()),
2869 ArchiveContext::from(AppealId::new()),
2870 ArchiveContext::from(FlagId::new()),
2871 ArchiveContext::from(InterviewRunId::new()),
2872 ];
2873 let kinds: Vec<_> = contexts.iter().map(ArchiveContext::kind).collect();
2874 assert_eq!(kinds, ArchiveContextKind::ALL);
2875 for c in contexts {
2876 assert_eq!(ArchiveContext::from_stored(c.kind(), c.as_uuid()), c);
2877 }
2878 let id = AgendaItemId::new();
2879 assert_eq!(
2880 ArchiveContext::from(id).to_string(),
2881 format!("agenda item {id}")
2882 );
2883 }
2884
2885 #[test]
2886 fn byte_ids_debug() {
2887 let handle = WebAuthnUserHandle::from(vec![7; 64]);
2888 assert_eq!(format!("{handle:?}"), "WebAuthnUserHandle(..)");
2889 let credential = PasskeyCredentialId::from(vec![0xab; 2]);
2890 assert_eq!(format!("{credential:?}"), "PasskeyCredentialId(abab)");
2891 assert_eq!(credential.as_bytes(), &[0xab, 0xab]);
2892 }
2893
2894 #[test]
2895 fn oauth_client_id_round_trips() {
2896 let id = OAuthClientId::generate();
2897 assert_eq!(id.as_str().parse::<OAuthClientId>().unwrap(), id);
2898 let json = serde_json::to_string(&id).unwrap();
2899 assert_eq!(serde_json::from_str::<OAuthClientId>(&json).unwrap(), id);
2900 }
2901
2902 #[test]
2903 fn oauth_client_id_rejects_empty_oversized_and_control_characters() {
2904 assert!("".parse::<OAuthClientId>().is_err());
2905 assert!("a".repeat(256).parse::<OAuthClientId>().is_err());
2906 assert!("abc\ndef".parse::<OAuthClientId>().is_err());
2907 assert!(serde_json::from_str::<OAuthClientId>("\"\"").is_err());
2908 }
2909
2910 #[test]
2914 fn a_data_citation_is_a_content_ref() {
2915 let written = "DATA-2026-0001:89fe7c6:votes/ballots.csv:110-300";
2916 let r: ContentRef = written.parse().unwrap();
2917 let c = r.as_data_citation().expect("a citation");
2918 assert_eq!(c.path.as_str(), "votes/ballots.csv");
2919 assert_eq!(r.to_string(), written);
2920 assert_eq!(
2921 r.data_set().map(GovernanceLogId::as_str),
2922 Some("DATA-2026-0001")
2923 );
2924 assert!(!r.is_governance());
2925 assert_eq!(r.kind_str(), "data file");
2926 let json = serde_json::to_value(&r).unwrap();
2927 assert_eq!(json, written);
2928 assert_eq!(serde_json::from_value::<ContentRef>(json).unwrap(), r);
2929 let whole: ContentRef =
2930 "DATA-2026-0001:89fe7c6:votes/ballots.csv".parse().unwrap();
2931 assert_eq!(whole.as_data_citation().unwrap().lines, None);
2932 let pinned: ContentRef =
2934 "DATA-2026-0001:/votes/ballots.csv:110-300".parse().unwrap();
2935 let p = pinned.as_data_citation().expect("a citation");
2936 assert_eq!(
2937 (p.commit.as_ref(), p.path.as_str()),
2938 (None, "votes/ballots.csv")
2939 );
2940 assert_eq!(
2941 pinned.to_string(),
2942 "DATA-2026-0001:/votes/ballots.csv:110-300"
2943 );
2944 let json = serde_json::to_value(&pinned).unwrap();
2945 assert_eq!(serde_json::from_value::<ContentRef>(json).unwrap(), pinned);
2946 let hexdir: ContentRef =
2947 "DATA-2026-0001:/abcdef1/file.md".parse().unwrap();
2948 assert_eq!(hexdir.as_data_citation().unwrap().commit, None);
2949 for other in
2951 ["GOV-2026-0006:votes/a.md", "TEST-2026-0001:votes/a.md:1-2"]
2952 {
2953 let err = other.parse::<ContentRef>().unwrap_err();
2954 assert!(!crate::govlog::DataCitation::is_citation_shaped(other));
2955 assert!(
2956 !err.to_string().contains("not a data set citation"),
2957 "{err}"
2958 );
2959 }
2960 let set: ContentRef = "DATA-2026-0001".parse().unwrap();
2961 assert_eq!(set.data_set(), Some(&"DATA-2026-0001".parse().unwrap()));
2962 assert!(set.as_data_citation().is_none());
2963
2964 for bad in [
2965 "DATA-2026-0001:89fe7c6",
2966 "DATA-2026-0001::",
2967 "DATA-2026-0001: the vote tallies",
2968 ] {
2969 let err = bad.parse::<ContentRef>().unwrap_err();
2970 assert_eq!(err.leading_ref(), None, "{bad}");
2971 let text = err.to_string();
2972 assert!(text.contains("not a data set citation"), "{text}");
2973 assert!(text.contains("DATA-YYYY-NNNN:<commit>:<path>"), "{text}");
2974 assert!(!text.contains("starts with the valid id"), "{text}");
2975 }
2976 let test: ContentRef = "TEST-2026-0001".parse().unwrap();
2980 assert!(test.is_governance() && test.as_data_citation().is_none());
2981 assert_eq!(test.data_set(), None);
2982 assert!(!crate::govlog::DataCitation::is_citation_shaped(
2983 "TEST-2026-0001:89fe7c6:votes/a.md"
2984 ));
2985 let err = "TEST-2026-0001:89fe7c6:votes/a.md"
2986 .parse::<ContentRef>()
2987 .unwrap_err();
2988 assert!(
2989 !err.to_string().contains("not a data set citation"),
2990 "{err}"
2991 );
2992 assert_eq!(err.leading_ref(), Some("TEST-2026-0001".parse().unwrap()));
2993 assert!(matches!(
2994 "TEST-2026-0001:89fe7c6:votes/a.md"
2995 .parse::<crate::govlog::DataCitation>(),
2996 Err(crate::govlog::DataCitationError::NotDataSet(_))
2997 ));
2998 let data: ContentRef =
2999 "DATA-2026-0001:89fe7c6:votes/a.md".parse().unwrap();
3000 assert!(data.as_data_citation().is_some() && !data.is_governance());
3001 let err = "GOV-2026-0006: the ratification"
3003 .parse::<ContentRef>()
3004 .unwrap_err();
3005 assert_eq!(err.leading_ref(), Some("GOV-2026-0006".parse().unwrap()));
3006 }
3007
3008 #[test]
3009 fn content_ref_error_names_a_leading_id_followed_by_extra_text() {
3010 let uuid = "6dcef9bb-2b3c-4f5e-9a1b-0c2d3e4f5a6b";
3011 for (input, lead) in [
3012 (format!("{uuid} and the safe-space proposal"), uuid),
3013 (format!("{uuid}b0518e42"), uuid),
3014 (
3015 "GOV-2026-0006 (the ratification)".to_string(),
3016 "GOV-2026-0006",
3017 ),
3018 (
3021 "DATA-2026-0001 (the vote tallies)".to_string(),
3022 "DATA-2026-0001",
3023 ),
3024 ("DATA-2026-0012, index.md".to_string(), "DATA-2026-0012"),
3025 ("TEST-2026-0001 (the dry run)".to_string(), "TEST-2026-0001"),
3027 ("OBL-2026-0001 and more".to_string(), "OBL-2026-0001"),
3028 ("protocol, section 3".to_string(), "protocol"),
3029 ("prompts, please".to_string(), "prompts"),
3030 (
3031 "prompt:tier2_reviewer and the juror's".to_string(),
3032 "prompt:tier2_reviewer",
3033 ),
3034 (
3035 "prompts/appeals_juror.md, line 3".to_string(),
3036 "prompt:appeals_juror",
3037 ),
3038 ] {
3039 let err = input.parse::<ContentRef>().unwrap_err();
3040 assert_eq!(
3041 err.leading_ref(),
3042 Some(lead.parse().unwrap()),
3043 "{input}"
3044 );
3045 let msg = err.to_string();
3046 assert!(
3047 msg.contains(&format!("valid id {lead} followed")),
3048 "{msg}"
3049 );
3050 }
3051
3052 let short = "6dcef9bb-2b3c-4f5e-9a1b-0c2d3e4f5a6";
3054 let err = short.parse::<ContentRef>().unwrap_err();
3055 assert_eq!(err.leading_ref(), None);
3056 assert!(!err.to_string().contains("followed by"));
3057 assert_eq!(
3059 "GOV-2026-1".parse::<ContentRef>().unwrap(),
3060 ContentRef::Governance("GOV-2026-0001".parse().unwrap())
3061 );
3062 }
3063
3064 #[test]
3065 fn citations_normalize_as_written() {
3066 for (written, canonical) in [
3067 ("GOV-2026-0006", "GOV-2026-0006"),
3068 ("GOV-2026.6", "GOV-2026-0006"),
3069 ("gov-2026-6", "GOV-2026-0006"),
3070 ("GOV 2026 6", "GOV-2026-0006"),
3071 ("app/2026/03", "APP-2026-0003"),
3072 (" REC-2026-0002 ", "REC-2026-0002"),
3073 ("obl-2026-12", "OBL-2026-0012"),
3074 ("OBL.2026.7", "OBL-2026-0007"),
3075 ("data-2026-3", "DATA-2026-0003"),
3076 ("DATA.2026.12", "DATA-2026-0012"),
3077 (" Data/2026/0001 ", "DATA-2026-0001"),
3078 ("DATA 2026 7", "DATA-2026-0007"),
3079 ("test-2026-3", "TEST-2026-0003"),
3080 ("Test.2026.12", "TEST-2026-0012"),
3081 ] {
3082 let id: GovernanceLogId = written.parse().unwrap();
3083 assert_eq!(id.as_str(), canonical, "{written}");
3084 let json: GovernanceLogId =
3085 serde_json::from_value(serde_json::json!(written)).unwrap();
3086 assert_eq!(json.as_str(), canonical, "{written} via serde");
3087 let content: ContentRef = written.parse().unwrap();
3088 assert_eq!(content, ContentRef::Governance(id), "{written}");
3089 }
3090 for rejected in [
3091 "GOV-2026-N",
3092 "GOV-2026/GOVG=6",
3093 "GOV-2026-00006",
3094 "GOV-26-0006",
3095 "GOV-2026-",
3096 "XYZ-2026-0006",
3097 "GOV-2026-0006-1",
3098 ] {
3099 assert!(rejected.parse::<GovernanceLogId>().is_err(), "{rejected}");
3100 }
3101 assert!(!GovernanceLogId::is_citation_shaped("GOV-2026.6"));
3103 }
3104
3105 #[test]
3106 fn content_ref_parses_document_slugs() {
3107 assert_eq!(
3108 "constitution".parse(),
3109 Ok(ContentRef::Document(PlatformDoc::Constitution))
3110 );
3111 assert_eq!(
3112 "protocol".parse(),
3113 Ok(ContentRef::Document(PlatformDoc::GovernanceProtocol))
3114 );
3115 assert_eq!(
3117 "governance-protocol".parse(),
3118 Ok(ContentRef::Document(PlatformDoc::GovernanceProtocol))
3119 );
3120 assert_eq!(
3121 "Constitution".parse(),
3122 Ok(ContentRef::Document(PlatformDoc::Constitution))
3123 );
3124 assert!("proto".parse::<ContentRef>().is_err());
3125 }
3126
3127 #[test]
3128 fn content_ref_parses_prompt_slugs() {
3129 let juror = PlatformDoc::Prompt("appeals_juror".parse().unwrap());
3130 for written in [
3131 "prompt:appeals_juror",
3132 "Prompt:Appeals_Juror",
3133 "prompt/appeals-juror",
3134 "prompts/appeals_juror.md",
3135 "prompts:appeals_juror",
3136 ] {
3137 assert_eq!(
3138 written.parse(),
3139 Ok(ContentRef::Document(juror.clone())),
3140 "{written}"
3141 );
3142 }
3143 assert_eq!(juror.to_string(), "prompt:appeals_juror");
3144 for index in ["prompts", "Prompts", "prompt"] {
3145 assert_eq!(
3146 index.parse(),
3147 Ok(ContentRef::Document(PlatformDoc::Prompts)),
3148 "{index}"
3149 );
3150 }
3151 for rejected in [
3152 "prompt:",
3153 "prompt:2fast",
3154 "prompt:tier 2",
3155 "prompt:../secrets",
3156 "prompt:tier2_reviewer/x",
3157 "promptly",
3158 ] {
3159 assert!(rejected.parse::<ContentRef>().is_err(), "{rejected}");
3160 }
3161 let long = format!("prompt:{}", "a".repeat(PromptName::MAX_LEN + 1));
3162 assert!(long.parse::<ContentRef>().is_err());
3163 }
3164
3165 #[test]
3166 fn content_id_prefix_parses_eight_hex_digits_leniently() {
3167 let p: ContentIdPrefix = "7ad26ccd".parse().unwrap();
3168 assert_eq!(p.to_string(), "7ad26ccd");
3169 assert_eq!(" 7AD26CCD\n".parse::<ContentIdPrefix>().unwrap(), p);
3170 for rejected in ["7ad26cc", "7ad26ccd0", "7ad26ccg", "", "7ad2-6cc"] {
3171 assert!(rejected.parse::<ContentIdPrefix>().is_err(), "{rejected}");
3172 }
3173 }
3174
3175 #[test]
3176 fn content_id_prefix_bounds_cover_exactly_its_uuids() {
3177 let id: Uuid = "7ad26ccd-922f-484a-a37c-51777344a98c".parse().unwrap();
3178 let p = ContentIdPrefix::of(&id);
3179 assert_eq!(p.to_string(), "7ad26ccd");
3180 assert!(p.matches(&id));
3181 let (lo, hi) = p.bounds();
3182 assert_eq!(lo.to_string(), "7ad26ccd-0000-0000-0000-000000000000");
3183 assert_eq!(hi.to_string(), "7ad26ccd-ffff-ffff-ffff-ffffffffffff");
3184 assert!(lo <= id && id <= hi);
3185 let next: Uuid =
3186 "7ad26cce-0000-0000-0000-000000000000".parse().unwrap();
3187 assert!(!p.matches(&next) && next > hi);
3188 let top: ContentIdPrefix = "ffffffff".parse().unwrap();
3190 assert_eq!(top.bounds().1, Uuid::max());
3191 let bottom: ContentIdPrefix = "00000000".parse().unwrap();
3192 assert_eq!(bottom.bounds().0, Uuid::nil());
3193 }
3194
3195 #[test]
3196 fn content_ref_reads_a_short_id_and_only_eight_digits() {
3197 let r: ContentRef = "7ad26ccd".parse().unwrap();
3198 assert_eq!(r, ContentRef::ContentPrefix("7ad26ccd".parse().unwrap()));
3199 assert_eq!(r.kind_str(), "content");
3200 assert_eq!(serde_json::to_string(&r).unwrap(), "\"7ad26ccd\"");
3201 let full: ContentRef =
3203 "7ad26ccd-922f-484a-a37c-51777344a98c".parse().unwrap();
3204 assert!(matches!(full, ContentRef::Content(_)));
3205 let err = "7ad26ccd-922f".parse::<ContentRef>().unwrap_err();
3210 assert_eq!(err.leading_ref(), None);
3211 }
3212
3213 #[test]
3214 fn content_ref_pattern_admits_short_ids() {
3215 let short = CONTENT_ID_PREFIX_PATTERN
3216 .strip_prefix('^')
3217 .and_then(|p| p.strip_suffix('$'))
3218 .unwrap();
3219 assert!(CONTENT_REF_PATTERN.contains(&format!("|{short}|")));
3220 }
3221
3222 #[test]
3224 fn document_patterns_agree() {
3225 let docs = PLATFORM_DOC_PATTERN.strip_prefix("^(").unwrap();
3226 assert!(CONTENT_REF_PATTERN.ends_with(&format!("|{docs}")));
3227 let name = PROMPT_NAME_PATTERN
3228 .strip_prefix('^')
3229 .and_then(|p| p.strip_suffix('$'))
3230 .unwrap();
3231 assert!(PLATFORM_DOC_PATTERN.contains(&format!("|prompt:{name})$")));
3232 }
3233
3234 #[test]
3235 fn calendar_is_a_document_slug() {
3236 assert_eq!(
3237 "calendar".parse::<ContentRef>().unwrap(),
3238 ContentRef::Document(PlatformDoc::Calendar)
3239 );
3240 assert_eq!(
3241 "Calendar".parse::<PlatformDoc>().unwrap(),
3242 PlatformDoc::Calendar
3243 );
3244 assert_eq!(PlatformDoc::Calendar.to_string(), "calendar");
3245 assert_eq!(
3246 "OBL-2026-0001".parse::<ContentRef>().unwrap(),
3247 ContentRef::Governance("OBL-2026-0001".parse().unwrap())
3248 );
3249 assert_eq!(
3250 "DATA-2026-0001".parse::<ContentRef>().unwrap(),
3251 ContentRef::Governance("DATA-2026-0001".parse().unwrap())
3252 );
3253 assert_eq!(
3254 "TEST-2026-0001".parse::<ContentRef>().unwrap(),
3255 ContentRef::Governance("TEST-2026-0001".parse().unwrap())
3256 );
3257 }
3258
3259 #[test]
3260 fn platform_doc_serde_uses_the_canonical_slug() {
3261 let json =
3262 serde_json::to_string(&PlatformDoc::GovernanceProtocol).unwrap();
3263 assert_eq!(json, "\"protocol\"");
3264 let doc: PlatformDoc =
3265 serde_json::from_str("\"governance-protocol\"").unwrap();
3266 assert_eq!(doc, PlatformDoc::GovernanceProtocol);
3267 }
3268
3269 #[test]
3270 fn ids_are_unique() {
3271 let a = AgentId::new();
3272 let b = AgentId::new();
3273 assert_ne!(a, b);
3274 }
3275
3276 #[test]
3277 fn serde_round_trip() {
3278 let id = PostId::new();
3279 let json = serde_json::to_string(&id).unwrap();
3280 let deserialized: PostId = serde_json::from_str(&json).unwrap();
3281 assert_eq!(id, deserialized);
3282 }
3283
3284 #[test]
3285 fn display_shows_uuid() {
3286 let id = CommunityId::new();
3287 let display = id.to_string();
3288 assert_eq!(display.len(), 36);
3290 assert!(display.contains('-'));
3291 }
3292
3293 #[test]
3294 fn from_uuid_round_trip() {
3295 let uuid = Uuid::new_v4();
3296 let id = AgentId::from(uuid);
3297 let back: Uuid = id.into();
3298 assert_eq!(uuid, back);
3299 }
3300
3301 #[test]
3305 fn every_id_round_trips_through_its_own_display() {
3306 let agent = AgentId::new();
3307 assert_eq!(agent.to_string().parse::<AgentId>().unwrap(), agent);
3308
3309 let action = ModerationActionId::new();
3310 assert_eq!(
3311 action.to_string().parse::<ModerationActionId>().unwrap(),
3312 action
3313 );
3314
3315 let content = ContentId::new();
3316 assert_eq!(content.to_string().parse::<ContentId>().unwrap(), content);
3317
3318 let feedback = FeedbackId::new();
3319 assert_eq!(
3320 feedback.to_string().parse::<FeedbackId>().unwrap(),
3321 feedback
3322 );
3323 }
3324
3325 #[test]
3326 fn parsing_a_non_uuid_is_an_error_not_a_panic() {
3327 assert!("not-a-uuid".parse::<ContentId>().is_err());
3328 assert!("".parse::<ContentId>().is_err());
3329 }
3330
3331 #[test]
3336 fn content_id_is_wire_compatible_with_a_bare_uuid() {
3337 let uuid = Uuid::new_v4();
3338 let typed = ContentId::from(uuid);
3339 assert_eq!(
3340 serde_json::to_string(&typed).unwrap(),
3341 serde_json::to_string(&uuid).unwrap()
3342 );
3343 }
3344
3345 #[test]
3348 fn every_moderation_target_narrows_losslessly() {
3349 let uuid = Uuid::new_v4();
3350
3351 for (label, got) in [
3352 ("PostId", ModerationTargetId::from(PostId::from(uuid))),
3353 ("CommentId", ModerationTargetId::from(CommentId::from(uuid))),
3354 ("MessageId", ModerationTargetId::from(MessageId::from(uuid))),
3355 ("AgentId", ModerationTargetId::from(AgentId::from(uuid))),
3356 ("ContentId", ModerationTargetId::from(ContentId::from(uuid))),
3357 ] {
3358 assert_eq!(
3359 got.as_uuid(),
3360 &uuid,
3361 "{label} -> ModerationTargetId lost the uuid"
3362 );
3363 }
3364 }
3365
3366 #[test]
3370 fn resolved_ids_narrow_to_content_id_losslessly() {
3371 let uuid = Uuid::new_v4();
3372
3373 assert_eq!(
3374 ContentId::from(PostId::from(uuid)).as_uuid(),
3375 &uuid,
3376 "PostId -> ContentId lost the uuid"
3377 );
3378 assert_eq!(
3379 ContentId::from(CommentId::from(uuid)).as_uuid(),
3380 &uuid,
3381 "CommentId -> ContentId lost the uuid"
3382 );
3383 assert_eq!(
3384 ContentId::from(PostOrCommentId::Comment(CommentId::from(uuid)))
3385 .as_uuid(),
3386 &uuid,
3387 "PostOrCommentId -> ContentId lost the uuid"
3388 );
3389 }
3390
3391 #[test]
3392 fn json_is_plain_uuid_string() {
3393 let uuid = Uuid::new_v4();
3394 let id = AgentId::from(uuid);
3395 let id_json = serde_json::to_string(&id).unwrap();
3397 let uuid_json = serde_json::to_string(&uuid).unwrap();
3398 assert_eq!(id_json, uuid_json);
3399 }
3400
3401 #[cfg(feature = "schemars")]
3406 #[test]
3407 fn id_json_schema_is_inlined() {
3408 use schemars::JsonSchema;
3409
3410 assert!(
3411 <PostId as JsonSchema>::inline_schema(),
3412 "PostId::inline_schema() must return true to avoid $ref in containing schemas"
3413 );
3414 assert!(<AgentId as JsonSchema>::inline_schema());
3415 assert!(<CommentId as JsonSchema>::inline_schema());
3416 assert!(<CommunityId as JsonSchema>::inline_schema());
3417 assert!(<GovernanceLogId as JsonSchema>::inline_schema());
3418 assert!(<ContentRef as JsonSchema>::inline_schema());
3419 assert!(<FeedbackId as JsonSchema>::inline_schema());
3420 assert!(<ContactRequestId as JsonSchema>::inline_schema());
3421
3422 #[derive(schemars::JsonSchema)]
3426 #[allow(dead_code)]
3427 struct Container {
3428 post_id: PostId,
3430 agent_id: Option<AgentId>,
3432 gov_id: GovernanceLogId,
3434 maybe_gov_id: Option<GovernanceLogId>,
3436 content_ref: ContentRef,
3438 maybe_content_ref: Option<ContentRef>,
3440 feedback_id: FeedbackId,
3442 }
3443
3444 let schema = schemars::schema_for!(Container);
3445 let value = serde_json::to_value(&schema).unwrap();
3446
3447 assert!(
3449 value.get("$defs").is_none(),
3450 "no $defs should be emitted for ID-only container; got schema: {value}"
3451 );
3452
3453 let post_id = &value["properties"]["post_id"];
3455 assert!(
3456 post_id.get("$ref").is_none(),
3457 "post_id must not be a $ref; got: {post_id}"
3458 );
3459 assert_eq!(post_id["type"], "string");
3460 assert_eq!(post_id["format"], "uuid");
3461
3462 let agent_id = &value["properties"]["agent_id"];
3467 assert!(
3468 agent_id.get("$ref").is_none(),
3469 "agent_id must not be a $ref; got: {agent_id}"
3470 );
3471 let agent_id_str = agent_id.to_string();
3472 assert!(
3473 !agent_id_str.contains("$ref"),
3474 "agent_id schema must contain no $ref anywhere; got: {agent_id}"
3475 );
3476 assert!(
3477 agent_id_str.contains("\"format\":\"uuid\""),
3478 "agent_id should still carry format=uuid; got: {agent_id}"
3479 );
3480
3481 for field in
3486 ["gov_id", "maybe_gov_id", "content_ref", "maybe_content_ref"]
3487 {
3488 let f = &value["properties"][field];
3489 assert!(
3490 !f.to_string().contains("$ref"),
3491 "{field} must contain no $ref anywhere; got: {f}"
3492 );
3493 }
3494 assert_eq!(value["properties"]["gov_id"]["type"], "string");
3495 assert_eq!(
3496 value["properties"]["gov_id"]["pattern"],
3497 GOVERNANCE_LOG_ID_PATTERN
3498 );
3499 assert!(
3500 value["properties"]["maybe_gov_id"]
3501 .to_string()
3502 .contains("GOV|APP"),
3503 "Option<GovernanceLogId> should keep the citation pattern; got: {}",
3504 value["properties"]["maybe_gov_id"]
3505 );
3506 assert_eq!(value["properties"]["content_ref"]["type"], "string");
3507 }
3508
3509 #[test]
3510 fn governance_log_id_accepts_only_citation_shapes() {
3511 for (good, prefix) in [
3512 ("GOV-2026-0006", GovernanceLogPrefix::Gov),
3513 ("APP-2026-0003", GovernanceLogPrefix::App),
3514 ("AMD-2026-0001", GovernanceLogPrefix::Amd),
3515 ("KEY-2026-0001", GovernanceLogPrefix::Key),
3516 ("REC-2026-0001", GovernanceLogPrefix::Rec),
3517 ("OBL-2026-0001", GovernanceLogPrefix::Obl),
3518 ("DATA-2026-0001", GovernanceLogPrefix::Data),
3519 ("TEST-2026-0001", GovernanceLogPrefix::Test),
3520 ("GOV-1999-0000", GovernanceLogPrefix::Gov),
3521 ] {
3522 let id = good.parse::<GovernanceLogId>().unwrap();
3523 assert_eq!(id.as_str(), good, "{good} should parse");
3524 assert_eq!(id.prefix(), prefix);
3525 let letters = good.split('-').next().unwrap();
3526 assert_eq!(id.prefix().as_str(), letters);
3527 assert_eq!(id.prefix().to_string().parse(), Ok(prefix));
3528 }
3529 let newer: GovernanceLogId =
3531 serde_json::from_value(serde_json::json!("ZZZ-2026-0001")).unwrap();
3532 assert_eq!(newer.prefix(), GovernanceLogPrefix::Unknown);
3533 assert_eq!(newer.as_str(), "ZZZ-2026-0001");
3534 assert!("ZZZ-2026-0001".parse::<GovernanceLogId>().is_err());
3535 assert!(!GovernanceLogId::is_citation_shaped("ZZZ-2026-0001"));
3536 for junk in [
3537 "zzz-2026-0001",
3538 "ZZZZZ-2026-0001",
3539 "ZZ-2026-0001",
3540 "ZZZ-2026-1",
3541 ] {
3542 assert!(
3543 serde_json::from_value::<GovernanceLogId>(serde_json::json!(
3544 junk
3545 ))
3546 .is_err(),
3547 "{junk}"
3548 );
3549 }
3550 assert_eq!(
3551 GovernanceLogId::from_parts(GovernanceLogPrefix::Unknown, 2026, 1),
3552 None
3553 );
3554 for prefix in GovernanceLogPrefix::ALL {
3557 let want = if matches!(
3558 prefix,
3559 GovernanceLogPrefix::Data | GovernanceLogPrefix::Test
3560 ) {
3561 4
3562 } else {
3563 3
3564 };
3565 assert_eq!(prefix.as_str().len(), want, "{prefix}");
3566 }
3567 let series = GovernanceLogPrefix::ALL.map(|p| p.as_str()).join("|");
3569 assert!(
3570 GOVERNANCE_LOG_ID_PATTERN.contains(&format!("({series})")),
3571 "{GOVERNANCE_LOG_ID_PATTERN}"
3572 );
3573 assert!(
3574 CONTENT_REF_PATTERN.contains(&format!("({series})")),
3575 "{CONTENT_REF_PATTERN}"
3576 );
3577 assert_eq!(
3579 "GOV-2026-006".parse::<GovernanceLogId>().unwrap().as_str(),
3580 "GOV-2026-0006"
3581 );
3582 assert_eq!(
3583 "gov-2026-0006".parse::<GovernanceLogId>().unwrap().as_str(),
3584 "GOV-2026-0006"
3585 );
3586 for bad in [
3587 "",
3588 "GOV-26-0006",
3589 "MOD-2026-0006",
3590 "GOV-2026-0006-1",
3591 "GOV-202X-0006",
3592 "DAT-2026-0001",
3593 "DATAS-2026-0001",
3594 "DATA-2026-00001",
3595 "DATA-2026",
3596 "TES-2026-0001",
3597 "TESTS-2026-0001",
3598 "TEST-2026-00001",
3599 "3f1a0000-0000-0000-0000-000000000000",
3600 ] {
3601 assert!(
3602 bad.parse::<GovernanceLogId>().is_err(),
3603 "{bad:?} should not parse as a GovernanceLogId"
3604 );
3605 }
3606 }
3607
3608 #[test]
3612 fn governance_log_id_is_wire_compatible_with_a_bare_string() {
3613 let id: GovernanceLogId = "GOV-2026-0006".parse().unwrap();
3614 assert_eq!(serde_json::to_string(&id).unwrap(), "\"GOV-2026-0006\"");
3615 let back: GovernanceLogId =
3616 serde_json::from_str("\"GOV-2026-0006\"").unwrap();
3617 assert_eq!(back, id);
3618 assert!(serde_json::from_str::<GovernanceLogId>("\"nope\"").is_err());
3620 }
3621
3622 #[test]
3625 fn content_ref_round_trips_as_a_bare_string() {
3626 let uuid = Uuid::new_v4();
3627 let content = ContentRef::from(ContentId::from(uuid));
3628 assert_eq!(
3629 serde_json::to_value(&content).unwrap(),
3630 serde_json::json!(uuid.to_string())
3631 );
3632 assert_eq!(
3633 serde_json::from_value::<ContentRef>(serde_json::json!(
3634 uuid.to_string()
3635 ))
3636 .unwrap(),
3637 content
3638 );
3639
3640 let gov = ContentRef::Governance("APP-2026-0003".parse().unwrap());
3641 assert_eq!(
3642 serde_json::to_value(&gov).unwrap(),
3643 serde_json::json!("APP-2026-0003")
3644 );
3645 assert_eq!(
3646 serde_json::from_value::<ContentRef>(serde_json::json!(
3647 "APP-2026-0003"
3648 ))
3649 .unwrap(),
3650 gov
3651 );
3652
3653 assert!(gov.is_governance());
3654 assert!(!content.is_governance());
3655 assert_eq!(gov.kind_str(), "governance");
3656 assert_eq!(content.kind_str(), "content");
3657 assert_eq!(content.as_content(), Some(ContentId::from(uuid)));
3658 assert!(content.as_governance().is_none());
3659
3660 assert!("not-an-id".parse::<ContentRef>().is_err());
3662 assert!(
3663 serde_json::from_value::<ContentRef>(serde_json::json!(
3664 "not-an-id"
3665 ))
3666 .is_err()
3667 );
3668 }
3669
3670 #[test]
3672 fn every_readable_id_narrows_to_a_content_ref() {
3673 let uuid = Uuid::new_v4();
3674 for (label, got) in [
3675 ("PostId", ContentRef::from(PostId::from(uuid))),
3676 ("CommentId", ContentRef::from(CommentId::from(uuid))),
3677 ("ContentId", ContentRef::from(ContentId::from(uuid))),
3678 ] {
3679 assert_eq!(
3680 got,
3681 ContentRef::Content(ContentId::from(uuid)),
3682 "{label} -> ContentRef lost the uuid"
3683 );
3684 }
3685 let gov: GovernanceLogId = "GOV-2026-0006".parse().unwrap();
3686 assert_eq!(ContentRef::from(gov.clone()), ContentRef::Governance(gov));
3687 }
3688
3689 #[test]
3692 fn string_shaped_ids_round_trip_through_display() {
3693 let gov: GovernanceLogId = "GOV-2026-0006".parse().unwrap();
3694 assert_eq!(gov.to_string().parse::<GovernanceLogId>().unwrap(), gov);
3695
3696 let r = ContentRef::Governance(gov);
3697 assert_eq!(r.to_string().parse::<ContentRef>().unwrap(), r);
3698
3699 let r = ContentRef::Content(ContentId::new());
3700 assert_eq!(r.to_string().parse::<ContentRef>().unwrap(), r);
3701 }
3702
3703 #[test]
3704 fn post_or_comment_post_variant() {
3705 let inner = PostId::new();
3706 let tagged = PostOrCommentId::Post(inner);
3707 assert!(tagged.is_post());
3708 assert!(!tagged.is_comment());
3709 assert_eq!(tagged.as_post(), Some(inner));
3710 assert_eq!(tagged.as_comment(), None);
3711 assert_eq!(tagged.as_uuid(), *inner.as_uuid());
3712 assert_eq!(tagged.kind_str(), "post");
3713 }
3714
3715 #[test]
3716 fn post_or_comment_comment_variant() {
3717 let inner = CommentId::new();
3718 let tagged = PostOrCommentId::Comment(inner);
3719 assert!(tagged.is_comment());
3720 assert!(!tagged.is_post());
3721 assert_eq!(tagged.as_comment(), Some(inner));
3722 assert_eq!(tagged.as_post(), None);
3723 assert_eq!(tagged.as_uuid(), *inner.as_uuid());
3724 assert_eq!(tagged.kind_str(), "comment");
3725 }
3726
3727 #[test]
3728 fn post_or_comment_from_conversions() {
3729 let post = PostId::new();
3730 let comment = CommentId::new();
3731 let via_post: PostOrCommentId = post.into();
3732 let via_comment: PostOrCommentId = comment.into();
3733 assert_eq!(via_post, PostOrCommentId::Post(post));
3734 assert_eq!(via_comment, PostOrCommentId::Comment(comment));
3735 }
3736
3737 #[test]
3738 fn post_or_comment_display_is_kind_colon_uuid() {
3739 let post = PostId::new();
3740 let tagged = PostOrCommentId::Post(post);
3741 let rendered = tagged.to_string();
3742 assert!(rendered.starts_with("post:"));
3743 assert!(rendered.contains(&post.to_string()));
3744 }
3745
3746 const FULL: &str = "7ad26ccd-922f-484a-a37c-51777344a98c";
3749
3750 #[test]
3753 fn a_bad_id_fails_in_plain_words() {
3754 let bad = "7ad26ccd-922f-484a-a37c-51777344a";
3755 let want = format!(
3756 "not a valid PostId: expected a UUID like \"{FULL}\", got \"{bad}\""
3757 );
3758 assert_eq!(bad.parse::<PostId>().unwrap_err().to_string(), want);
3759 let err = serde_json::from_str::<PostId>(&format!("\"{bad}\""))
3760 .unwrap_err()
3761 .to_string();
3762 assert!(err.starts_with(&want), "{err}");
3763 assert!(!err.contains("group"), "{err}");
3764 let err = serde_json::from_str::<AgentId>("5")
3765 .unwrap_err()
3766 .to_string();
3767 assert!(err.contains("expected AgentId as a UUID string"), "{err}");
3768 let long = "x".repeat(500);
3770 let msg = long.parse::<CommentId>().unwrap_err().to_string();
3771 assert!(msg.len() < 200 && msg.ends_with("…\""), "{msg}");
3772 }
3773
3774 #[test]
3776 fn ids_still_round_trip() {
3777 let id: PostId = FULL.parse().unwrap();
3778 let json = serde_json::to_string(&id).unwrap();
3779 assert_eq!(serde_json::from_str::<PostId>(&json).unwrap(), id);
3780 let map: std::collections::HashMap<PostId, i64> =
3781 [(id, 3)].into_iter().collect();
3782 let json = serde_json::to_string(&map).unwrap();
3783 let back: std::collections::HashMap<PostId, i64> =
3784 serde_json::from_str(&json).unwrap();
3785 assert_eq!(back, map);
3786 }
3787
3788 fn target(s: &str) -> Result<ContentTarget, ContentTargetError> {
3789 s.parse()
3790 }
3791
3792 #[test]
3793 fn full_and_short_targets_parse() {
3794 let full = target(FULL).unwrap();
3795 assert_eq!(full.full().unwrap().to_string(), FULL);
3796 assert_eq!(full.to_string(), FULL);
3797 let short = target(" 7AD26CCD ").unwrap();
3798 assert!(short.full().is_none());
3799 assert_eq!(short.to_string(), "7ad26ccd");
3800 for variant in [
3802 FULL.replace('-', ""),
3803 FULL.to_uppercase(),
3804 FULL.replace('-', "\u{2011}"),
3805 ] {
3806 assert_eq!(target(&variant).unwrap(), full, "{variant}");
3807 }
3808 }
3809
3810 #[test]
3811 fn a_truncated_uuid_is_an_error_not_its_prefix() {
3812 let err = target("7ad26ccd-922f-484a-a37c-51777344a").unwrap_err();
3813 let msg = err.in_field("reply_to").to_string();
3814 assert!(
3815 msg.starts_with(
3816 "`reply_to` must be a post or comment id: a full UUID or its first 8 hex digits"
3817 ),
3818 "{msg}"
3819 );
3820 for internal in [
3821 "group",
3822 "UUID parsing",
3823 "invalid length",
3824 "invalid character",
3825 ] {
3826 assert!(!msg.contains(internal), "{internal} leaked: {msg}");
3827 }
3828 assert!(target("7ad26cc").is_err());
3829 assert!(target("7ad26ccd9").is_err());
3830 }
3831
3832 #[test]
3833 fn trailing_text_names_the_id_it_starts_with() {
3834 let msg = target(&format!("{FULL} (the reply above)"))
3835 .unwrap_err()
3836 .to_string();
3837 assert!(msg.contains(&format!("starts with the id {FULL}")), "{msg}");
3838 }
3839
3840 #[derive(Debug, serde::Deserialize)]
3841 struct Probe {
3842 #[serde(deserialize_with = "content_target::reply_to")]
3843 #[allow(dead_code)]
3844 reply_to: ContentTarget,
3845 }
3846
3847 #[test]
3848 fn target_errors_name_the_field_for_strings_and_other_types() {
3849 let err = serde_json::from_str::<Probe>(r#"{"reply_to": "nope"}"#)
3850 .unwrap_err();
3851 assert!(
3852 err.to_string()
3853 .starts_with("`reply_to` must be a post or comment id"),
3854 "{err}"
3855 );
3856 let err =
3857 serde_json::from_str::<Probe>(r#"{"reply_to": 5}"#).unwrap_err();
3858 assert!(
3859 err.to_string()
3860 .contains("expected `reply_to` to be a post or comment id"),
3861 "{err}"
3862 );
3863 }
3864
3865 #[cfg(feature = "schemars")]
3866 #[test]
3867 fn target_schema_is_inline_and_admits_both_forms() {
3868 let schema = schemars::schema_for!(ContentTarget);
3869 let v = schema.as_value();
3870 assert!(v.get("$ref").is_none() && v.get("$defs").is_none(), "{v}");
3871 assert!(v.get("format").is_none(), "a short id is not format: uuid");
3872 assert_eq!(v["pattern"], CONTENT_TARGET_PATTERN);
3873 }
3874}