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 from_parts(
1226 prefix: GovernanceLogPrefix,
1227 year: i32,
1228 serial: u32,
1229 ) -> Option<Self> {
1230 (prefix != GovernanceLogPrefix::Unknown
1231 && (1000..=9999).contains(&year)
1232 && (1..=9999).contains(&serial))
1233 .then(|| Self(format!("{prefix}-{year}-{serial:04}")))
1234 }
1235
1236 fn parts(s: &str) -> Option<(GovernanceLogPrefix, &str, &str)> {
1237 let parts: Vec<&str> = s.split('-').collect();
1238 let [prefix, year, serial] = parts.as_slice() else {
1239 return None;
1240 };
1241 let prefix: GovernanceLogPrefix = prefix.parse().ok()?;
1242 (year.len() == 4
1243 && serial.len() == 4
1244 && year.chars().all(|c| c.is_ascii_digit())
1245 && serial.chars().all(|c| c.is_ascii_digit()))
1246 .then_some((prefix, year, serial))
1247 }
1248}
1249
1250impl std::fmt::Display for GovernanceLogId {
1251 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1252 f.write_str(&self.0)
1253 }
1254}
1255
1256impl AsRef<str> for GovernanceLogId {
1257 fn as_ref(&self) -> &str {
1258 &self.0
1259 }
1260}
1261
1262impl std::str::FromStr for GovernanceLogId {
1263 type Err = GovernanceLogIdError;
1264
1265 fn from_str(s: &str) -> Result<Self, Self::Err> {
1268 Self::normalize(s)
1269 .map(Self)
1270 .ok_or_else(|| GovernanceLogIdError(s.to_string()))
1271 }
1272}
1273
1274impl TryFrom<String> for GovernanceLogId {
1275 type Error = GovernanceLogIdError;
1276
1277 fn try_from(s: String) -> Result<Self, Self::Error> {
1280 if Self::is_citation_shaped(&s) || Self::is_canonical_unknown(&s) {
1281 return Ok(Self(s));
1282 }
1283 s.parse()
1284 }
1285}
1286
1287impl From<GovernanceLogId> for String {
1288 fn from(id: GovernanceLogId) -> Self {
1289 id.0
1290 }
1291}
1292
1293#[cfg(feature = "schemars")]
1299impl schemars::JsonSchema for GovernanceLogId {
1300 fn inline_schema() -> bool {
1301 true
1302 }
1303
1304 fn schema_name() -> std::borrow::Cow<'static, str> {
1305 std::borrow::Cow::Borrowed("GovernanceLogId")
1306 }
1307
1308 fn schema_id() -> std::borrow::Cow<'static, str> {
1309 std::borrow::Cow::Borrowed(concat!(module_path!(), "::GovernanceLogId"))
1310 }
1311
1312 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1313 schemars::json_schema!({
1314 "type": "string",
1315 "pattern": GOVERNANCE_LOG_ID_PATTERN,
1316 "description": "Governance log entry id, e.g. \"GOV-2026-0006\" \
1317 (Council decision or policy change), \
1318 \"APP-2026-0003\" (appeals ruling), \
1319 \"AMD-2026-0001\" (amendment to an earlier \
1320 entry), \"KEY-2026-0001\" (signing key \
1321 rotation), \"REC-2026-0001\" (a Steward's \
1322 record of an operational act), \
1323 \"OBL-2026-0001\" (an obligation), \
1324 \"DATA-2026-0001\" (a data set) or \
1325 \"TEST-2026-0001\" (a test sitting's record; \
1326 not binding).",
1327 })
1328 }
1329}
1330
1331#[derive(
1340 Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
1341)]
1342#[serde(try_from = "String")]
1343#[cfg_attr(feature = "sqlx", derive(sqlx::Type))]
1344#[cfg_attr(feature = "sqlx", sqlx(transparent))]
1345pub struct OAuthClientId(String);
1346
1347#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1349#[error("not an OAuth client id: {0:?}")]
1350pub struct OAuthClientIdError(pub String);
1351
1352impl OAuthClientId {
1353 pub fn generate() -> Self {
1355 Self(Uuid::new_v4().to_string())
1356 }
1357
1358 pub fn as_str(&self) -> &str {
1360 &self.0
1361 }
1362
1363 pub fn into_inner(self) -> String {
1365 self.0
1366 }
1367
1368 fn is_valid(s: &str) -> bool {
1369 !s.is_empty() && s.len() <= 255 && !s.chars().any(char::is_control)
1370 }
1371}
1372
1373impl std::fmt::Display for OAuthClientId {
1374 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1375 f.write_str(&self.0)
1376 }
1377}
1378
1379impl AsRef<str> for OAuthClientId {
1380 fn as_ref(&self) -> &str {
1381 &self.0
1382 }
1383}
1384
1385impl std::str::FromStr for OAuthClientId {
1386 type Err = OAuthClientIdError;
1387
1388 fn from_str(s: &str) -> Result<Self, Self::Err> {
1389 Self::try_from(s.to_string())
1390 }
1391}
1392
1393impl TryFrom<String> for OAuthClientId {
1394 type Error = OAuthClientIdError;
1395
1396 fn try_from(s: String) -> Result<Self, Self::Error> {
1397 if Self::is_valid(&s) {
1398 Ok(Self(s))
1399 } else {
1400 Err(OAuthClientIdError(s))
1401 }
1402 }
1403}
1404
1405impl From<OAuthClientId> for String {
1406 fn from(id: OAuthClientId) -> Self {
1407 id.0
1408 }
1409}
1410
1411#[cfg(feature = "schemars")]
1414impl schemars::JsonSchema for OAuthClientId {
1415 fn inline_schema() -> bool {
1416 true
1417 }
1418
1419 fn schema_name() -> std::borrow::Cow<'static, str> {
1420 std::borrow::Cow::Borrowed("OAuthClientId")
1421 }
1422
1423 fn schema_id() -> std::borrow::Cow<'static, str> {
1424 std::borrow::Cow::Borrowed(concat!(module_path!(), "::OAuthClientId"))
1425 }
1426
1427 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1428 schemars::json_schema!({
1429 "type": "string",
1430 "minLength": 1,
1431 "maxLength": 255,
1432 "description": "OAuth client_id issued at dynamic client registration.",
1433 })
1434 }
1435}
1436
1437#[derive(Debug, Clone, PartialEq, Eq, Hash)]
1444pub enum PlatformDoc {
1445 Constitution,
1447 GovernanceProtocol,
1450 Prompts,
1452 Prompt(PromptName),
1454 Calendar,
1458}
1459
1460impl PlatformDoc {
1461 pub fn slug(&self) -> std::borrow::Cow<'static, str> {
1463 match self {
1464 PlatformDoc::Constitution => "constitution".into(),
1465 PlatformDoc::GovernanceProtocol => "protocol".into(),
1466 PlatformDoc::Prompts => "prompts".into(),
1467 PlatformDoc::Prompt(name) => format!("prompt:{name}").into(),
1468 PlatformDoc::Calendar => "calendar".into(),
1469 }
1470 }
1471
1472 pub fn title(&self) -> std::borrow::Cow<'static, str> {
1475 match self {
1476 PlatformDoc::Constitution => "The Agora Constitution".into(),
1477 PlatformDoc::GovernanceProtocol => {
1478 "The Agora Governance Protocol".into()
1479 }
1480 PlatformDoc::Prompts => "Agora's Model Prompts".into(),
1481 PlatformDoc::Prompt(name) => format!("Model prompt: {name}").into(),
1482 PlatformDoc::Calendar => "The Agora calendar".into(),
1483 }
1484 }
1485
1486 pub fn as_prompt(&self) -> Option<&PromptName> {
1488 match self {
1489 PlatformDoc::Prompt(name) => Some(name),
1490 _ => None,
1491 }
1492 }
1493}
1494
1495impl std::fmt::Display for PlatformDoc {
1496 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1497 f.write_str(&self.slug())
1498 }
1499}
1500
1501#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1503#[error(
1504 "not a platform document (expected \"constitution\", \"protocol\", \
1505 \"prompts\", \"calendar\" or \"prompt:<name>\"): {0:?}"
1506)]
1507pub struct PlatformDocError(pub String);
1508
1509const PROMPT_PREFIXES: [&str; 4] =
1513 ["prompt:", "prompt/", "prompts/", "prompts:"];
1514
1515impl std::str::FromStr for PlatformDoc {
1516 type Err = PlatformDocError;
1517
1518 fn from_str(s: &str) -> Result<Self, Self::Err> {
1522 if s.eq_ignore_ascii_case("constitution") {
1523 Ok(PlatformDoc::Constitution)
1524 } else if s.eq_ignore_ascii_case("protocol")
1525 || s.eq_ignore_ascii_case("governance-protocol")
1526 {
1527 Ok(PlatformDoc::GovernanceProtocol)
1528 } else if s.eq_ignore_ascii_case("prompts")
1529 || s.eq_ignore_ascii_case("prompt")
1530 {
1531 Ok(PlatformDoc::Prompts)
1532 } else if s.eq_ignore_ascii_case("calendar") {
1533 Ok(PlatformDoc::Calendar)
1534 } else {
1535 PROMPT_PREFIXES
1536 .iter()
1537 .find_map(|prefix| {
1538 let head = s.get(..prefix.len())?;
1539 head.eq_ignore_ascii_case(prefix)
1540 .then(|| s[prefix.len()..].parse().ok())
1541 .flatten()
1542 })
1543 .map(PlatformDoc::Prompt)
1544 .ok_or_else(|| PlatformDocError(s.to_string()))
1545 }
1546 }
1547}
1548
1549impl Serialize for PlatformDoc {
1550 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
1551 s.collect_str(self)
1552 }
1553}
1554
1555impl<'de> Deserialize<'de> for PlatformDoc {
1556 fn deserialize<D: serde::Deserializer<'de>>(
1557 d: D,
1558 ) -> Result<Self, D::Error> {
1559 let raw = String::deserialize(d)?;
1560 raw.parse().map_err(serde::de::Error::custom)
1561 }
1562}
1563
1564#[cfg(feature = "schemars")]
1567impl schemars::JsonSchema for PlatformDoc {
1568 fn inline_schema() -> bool {
1569 true
1570 }
1571
1572 fn schema_name() -> std::borrow::Cow<'static, str> {
1573 std::borrow::Cow::Borrowed("PlatformDoc")
1574 }
1575
1576 fn schema_id() -> std::borrow::Cow<'static, str> {
1577 std::borrow::Cow::Borrowed(concat!(module_path!(), "::PlatformDoc"))
1578 }
1579
1580 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1581 schemars::json_schema!({
1582 "type": "string",
1583 "pattern": PLATFORM_DOC_PATTERN,
1584 "description": "A platform document: \"constitution\", \
1585 \"protocol\" (the Governance Protocol), \
1586 \"prompts\" (the index of published model \
1587 prompts), \"prompt:<name>\" (one prompt, \
1588 e.g. \"prompt:tier2_reviewer\"), or \
1589 \"calendar\" (the sittings and obligation deadlines the \
1590 Steward and the Council scheduled).",
1591 })
1592 }
1593}
1594
1595#[derive(
1603 Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
1604)]
1605#[serde(try_from = "String")]
1606pub struct PromptName(String);
1607
1608#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1610#[error(
1611 "not a prompt name (lowercase letters, digits and `_`, e.g. \
1612 \"tier2_reviewer\"): {0:?}"
1613)]
1614pub struct PromptNameError(pub String);
1615
1616impl PromptName {
1617 pub const MAX_LEN: usize = 64;
1619
1620 pub fn as_str(&self) -> &str {
1622 &self.0
1623 }
1624
1625 fn normalize(s: &str) -> Option<String> {
1626 let s = s.trim();
1627 let s = match s.len().checked_sub(3) {
1628 Some(n)
1629 if s.is_char_boundary(n)
1630 && s[n..].eq_ignore_ascii_case(".md") =>
1631 {
1632 &s[..n]
1633 }
1634 _ => s,
1635 };
1636 let name: String = s
1637 .chars()
1638 .map(|c| match c {
1639 '-' => '_',
1640 c => c.to_ascii_lowercase(),
1641 })
1642 .collect();
1643 let mut chars = name.chars();
1644 let valid = name.len() <= Self::MAX_LEN
1645 && chars.next().is_some_and(|c| c.is_ascii_lowercase())
1646 && chars.all(|c| {
1647 c.is_ascii_lowercase() || c.is_ascii_digit() || c == '_'
1648 });
1649 valid.then_some(name)
1650 }
1651}
1652
1653impl std::fmt::Display for PromptName {
1654 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1655 f.write_str(&self.0)
1656 }
1657}
1658
1659impl AsRef<str> for PromptName {
1660 fn as_ref(&self) -> &str {
1661 &self.0
1662 }
1663}
1664
1665impl std::str::FromStr for PromptName {
1666 type Err = PromptNameError;
1667
1668 fn from_str(s: &str) -> Result<Self, Self::Err> {
1669 Self::normalize(s)
1670 .map(Self)
1671 .ok_or_else(|| PromptNameError(s.to_string()))
1672 }
1673}
1674
1675impl TryFrom<String> for PromptName {
1676 type Error = PromptNameError;
1677
1678 fn try_from(s: String) -> Result<Self, Self::Error> {
1679 s.parse()
1680 }
1681}
1682
1683impl From<PromptName> for PlatformDoc {
1684 fn from(name: PromptName) -> Self {
1685 PlatformDoc::Prompt(name)
1686 }
1687}
1688
1689#[cfg(feature = "schemars")]
1690impl schemars::JsonSchema for PromptName {
1691 fn inline_schema() -> bool {
1692 true
1693 }
1694
1695 fn schema_name() -> std::borrow::Cow<'static, str> {
1696 std::borrow::Cow::Borrowed("PromptName")
1697 }
1698
1699 fn schema_id() -> std::borrow::Cow<'static, str> {
1700 std::borrow::Cow::Borrowed(concat!(module_path!(), "::PromptName"))
1701 }
1702
1703 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1704 schemars::json_schema!({
1705 "type": "string",
1706 "pattern": PROMPT_NAME_PATTERN,
1707 "maxLength": PromptName::MAX_LEN,
1708 "description": "A published model prompt's name, e.g. \
1709 \"tier2_reviewer\". `get_content(\"prompts\")` \
1710 lists them.",
1711 })
1712 }
1713}
1714
1715#[derive(
1721 Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
1722)]
1723#[serde(try_from = "String")]
1724pub struct WitnessId(String);
1725
1726#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1728#[error(
1729 "not a witness id (lowercase letters, digits and `-`, e.g. \"qwen\"): \
1730 {0:?}"
1731)]
1732pub struct WitnessIdError(pub String);
1733
1734impl WitnessId {
1735 pub const MAX_LEN: usize = 64;
1737
1738 pub fn as_str(&self) -> &str {
1740 &self.0
1741 }
1742
1743 fn normalize(s: &str) -> Option<String> {
1744 let id: String = s
1745 .trim()
1746 .chars()
1747 .map(|c| match c {
1748 '_' => '-',
1749 c => c.to_ascii_lowercase(),
1750 })
1751 .collect();
1752 let mut chars = id.chars();
1753 let valid = id.len() <= Self::MAX_LEN
1754 && chars.next().is_some_and(|c| c.is_ascii_lowercase())
1755 && chars.all(|c| {
1756 c.is_ascii_lowercase() || c.is_ascii_digit() || c == '-'
1757 });
1758 valid.then_some(id)
1759 }
1760}
1761
1762impl std::fmt::Display for WitnessId {
1763 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1764 f.write_str(&self.0)
1765 }
1766}
1767
1768impl AsRef<str> for WitnessId {
1769 fn as_ref(&self) -> &str {
1770 &self.0
1771 }
1772}
1773
1774impl std::str::FromStr for WitnessId {
1775 type Err = WitnessIdError;
1776
1777 fn from_str(s: &str) -> Result<Self, Self::Err> {
1778 Self::normalize(s)
1779 .map(Self)
1780 .ok_or_else(|| WitnessIdError(s.to_string()))
1781 }
1782}
1783
1784impl TryFrom<String> for WitnessId {
1785 type Error = WitnessIdError;
1786
1787 fn try_from(s: String) -> Result<Self, Self::Error> {
1788 s.parse()
1789 }
1790}
1791
1792#[cfg(feature = "schemars")]
1795impl schemars::JsonSchema for WitnessId {
1796 fn inline_schema() -> bool {
1797 true
1798 }
1799
1800 fn schema_name() -> std::borrow::Cow<'static, str> {
1801 std::borrow::Cow::Borrowed("WitnessId")
1802 }
1803
1804 fn schema_id() -> std::borrow::Cow<'static, str> {
1805 std::borrow::Cow::Borrowed(concat!(module_path!(), "::WitnessId"))
1806 }
1807
1808 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1809 schemars::json_schema!({
1810 "type": "string",
1811 "maxLength": WitnessId::MAX_LEN,
1812 "description": "A witness's id, as the item's list of witnesses \
1813 gives it, e.g. \"qwen\"",
1814 })
1815 }
1816}
1817
1818#[derive(
1827 Debug,
1828 Clone,
1829 Copy,
1830 PartialEq,
1831 Eq,
1832 PartialOrd,
1833 Ord,
1834 Hash,
1835 Serialize,
1836 Deserialize,
1837)]
1838#[serde(try_from = "u32", into = "u32")]
1839pub struct WitnessQuestionId(u32);
1840
1841#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1843#[error("not a witness question number (a number from 1, e.g. 3): {0:?}")]
1844pub struct WitnessQuestionIdError(pub String);
1845
1846impl WitnessQuestionId {
1847 pub fn new(n: u32) -> Option<Self> {
1849 (n >= 1).then_some(Self(n))
1850 }
1851
1852 pub fn get(&self) -> u32 {
1854 self.0
1855 }
1856
1857 pub fn next(&self) -> Self {
1859 Self(self.0.saturating_add(1))
1860 }
1861}
1862
1863impl Default for WitnessQuestionId {
1864 fn default() -> Self {
1866 Self(1)
1867 }
1868}
1869
1870impl std::fmt::Display for WitnessQuestionId {
1871 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1872 self.0.fmt(f)
1873 }
1874}
1875
1876impl std::str::FromStr for WitnessQuestionId {
1879 type Err = WitnessQuestionIdError;
1880
1881 fn from_str(s: &str) -> Result<Self, Self::Err> {
1882 let t = s.trim();
1883 Some(t)
1884 .filter(|n| {
1885 !n.is_empty()
1886 && !n.starts_with('0')
1887 && n.bytes().all(|b| b.is_ascii_digit())
1888 })
1889 .and_then(|n| n.parse::<u32>().ok())
1890 .and_then(Self::new)
1891 .ok_or_else(|| WitnessQuestionIdError(s.to_string()))
1892 }
1893}
1894
1895impl TryFrom<u32> for WitnessQuestionId {
1896 type Error = WitnessQuestionIdError;
1897
1898 fn try_from(n: u32) -> Result<Self, Self::Error> {
1899 Self::new(n).ok_or_else(|| WitnessQuestionIdError(n.to_string()))
1900 }
1901}
1902
1903impl From<WitnessQuestionId> for u32 {
1904 fn from(id: WitnessQuestionId) -> Self {
1905 id.0
1906 }
1907}
1908
1909#[cfg(feature = "schemars")]
1912impl schemars::JsonSchema for WitnessQuestionId {
1913 fn inline_schema() -> bool {
1914 true
1915 }
1916
1917 fn schema_name() -> std::borrow::Cow<'static, str> {
1918 std::borrow::Cow::Borrowed("WitnessQuestionId")
1919 }
1920
1921 fn schema_id() -> std::borrow::Cow<'static, str> {
1922 std::borrow::Cow::Borrowed(concat!(
1923 module_path!(),
1924 "::WitnessQuestionId"
1925 ))
1926 }
1927
1928 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
1929 schemars::json_schema!({
1930 "type": "integer",
1931 "description": "A witness question's number on the item, e.g. 3",
1932 })
1933 }
1934}
1935
1936#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1952pub struct ContentIdPrefix(u32);
1953
1954#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1956#[error(
1957 "not a short id (the first eight hex digits of a UUID, e.g. \"7ad26ccd\"): {0:?}"
1958)]
1959pub struct ContentIdPrefixError(pub String);
1960
1961impl ContentIdPrefix {
1962 pub const LEN: usize = 8;
1964
1965 pub fn of(id: &Uuid) -> Self {
1967 Self((id.as_u128() >> 96) as u32)
1968 }
1969
1970 pub fn bounds(&self) -> (Uuid, Uuid) {
1972 let lo = (self.0 as u128) << 96;
1973 let hi = lo | ((1u128 << 96) - 1);
1974 (Uuid::from_u128(lo), Uuid::from_u128(hi))
1975 }
1976
1977 pub fn matches(&self, id: &Uuid) -> bool {
1979 Self::of(id) == *self
1980 }
1981}
1982
1983impl std::fmt::Display for ContentIdPrefix {
1984 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1985 write!(f, "{:08x}", self.0)
1986 }
1987}
1988
1989impl std::str::FromStr for ContentIdPrefix {
1990 type Err = ContentIdPrefixError;
1991
1992 fn from_str(s: &str) -> Result<Self, Self::Err> {
1993 let t = s.trim();
1994 if t.len() == Self::LEN && t.bytes().all(|b| b.is_ascii_hexdigit()) {
1995 Ok(Self(u32::from_str_radix(t, 16).expect("eight hex digits")))
1997 } else {
1998 Err(ContentIdPrefixError(s.to_string()))
1999 }
2000 }
2001}
2002
2003impl TryFrom<String> for ContentIdPrefix {
2004 type Error = ContentIdPrefixError;
2005
2006 fn try_from(s: String) -> Result<Self, Self::Error> {
2007 s.parse()
2008 }
2009}
2010
2011impl Serialize for ContentIdPrefix {
2012 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
2013 s.collect_str(self)
2014 }
2015}
2016
2017impl<'de> Deserialize<'de> for ContentIdPrefix {
2018 fn deserialize<D: serde::Deserializer<'de>>(
2019 d: D,
2020 ) -> Result<Self, D::Error> {
2021 let raw = String::deserialize(d)?;
2022 raw.parse().map_err(serde::de::Error::custom)
2023 }
2024}
2025
2026impl From<ContentId> for ContentIdPrefix {
2027 fn from(id: ContentId) -> Self {
2028 Self::of(id.as_uuid())
2029 }
2030}
2031
2032#[cfg(feature = "schemars")]
2033impl schemars::JsonSchema for ContentIdPrefix {
2034 fn inline_schema() -> bool {
2035 true
2036 }
2037
2038 fn schema_name() -> std::borrow::Cow<'static, str> {
2039 std::borrow::Cow::Borrowed("ContentIdPrefix")
2040 }
2041
2042 fn schema_id() -> std::borrow::Cow<'static, str> {
2043 std::borrow::Cow::Borrowed(concat!(module_path!(), "::ContentIdPrefix"))
2044 }
2045
2046 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
2047 schemars::json_schema!({
2048 "type": "string",
2049 "pattern": CONTENT_ID_PREFIX_PATTERN,
2050 "description": "A short post or comment id: the first eight hex \
2051 digits of its UUID, e.g. \"7ad26ccd\".",
2052 })
2053 }
2054}
2055
2056pub 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})$";
2061
2062#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2071pub enum ContentTarget {
2072 Id(ContentId),
2074 Prefix(ContentIdPrefix),
2076}
2077
2078impl ContentTarget {
2079 pub fn full(&self) -> Option<ContentId> {
2081 match self {
2082 ContentTarget::Id(id) => Some(*id),
2083 ContentTarget::Prefix(_) => None,
2084 }
2085 }
2086}
2087
2088impl From<ContentId> for ContentTarget {
2089 fn from(id: ContentId) -> Self {
2090 ContentTarget::Id(id)
2091 }
2092}
2093
2094impl std::fmt::Display for ContentTarget {
2095 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2096 match self {
2097 ContentTarget::Id(id) => id.fmt(f),
2098 ContentTarget::Prefix(prefix) => prefix.fmt(f),
2099 }
2100 }
2101}
2102
2103fn ascii_dashes(s: &str) -> String {
2108 s.chars()
2109 .map(|c| match c {
2110 '\u{2010}'..='\u{2014}' | '\u{2212}' => '-',
2111 c => c,
2112 })
2113 .collect()
2114}
2115
2116impl std::str::FromStr for ContentTarget {
2117 type Err = ContentTargetError;
2118
2119 fn from_str(s: &str) -> Result<Self, Self::Err> {
2120 let t = ascii_dashes(s.trim());
2121 if let Ok(id) = t.parse::<Uuid>() {
2122 return Ok(ContentTarget::Id(id.into()));
2123 }
2124 if let Ok(prefix) = t.parse::<ContentIdPrefix>() {
2125 return Ok(ContentTarget::Prefix(prefix));
2126 }
2127 const UUID_LEN: usize = 36;
2130 let leading = t
2131 .get(..UUID_LEN)
2132 .and_then(|head| head.parse::<Uuid>().ok())
2133 .map(ContentId::from);
2134 Err(ContentTargetError {
2135 field: None,
2136 input: s.to_string(),
2137 leading,
2138 })
2139 }
2140}
2141
2142#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
2148pub struct ContentTargetError {
2149 field: Option<&'static str>,
2150 input: String,
2151 leading: Option<ContentId>,
2152}
2153
2154impl ContentTargetError {
2155 pub fn in_field(mut self, field: &'static str) -> Self {
2157 self.field = Some(field);
2158 self
2159 }
2160}
2161
2162impl std::fmt::Display for ContentTargetError {
2163 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2164 match self.field {
2165 Some(field) => write!(f, "`{field}` must be")?,
2166 None => f.write_str("Expected")?,
2167 }
2168 f.write_str(
2169 " a post or comment id: a full UUID or its first 8 hex digits \
2170 (e.g. \"7ad26ccd\")",
2171 )?;
2172 write!(f, ", not \"{}\"", echo(&self.input))?;
2173 if let Some(id) = self.leading {
2174 write!(
2175 f,
2176 ". It starts with the id {id} followed by extra text; pass only the id"
2177 )?;
2178 }
2179 f.write_str(".")
2180 }
2181}
2182
2183impl Serialize for ContentTarget {
2184 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
2185 s.collect_str(self)
2186 }
2187}
2188
2189impl<'de> Deserialize<'de> for ContentTarget {
2190 fn deserialize<D: serde::Deserializer<'de>>(
2191 d: D,
2192 ) -> Result<Self, D::Error> {
2193 content_target::deserialize_field(d, "id")
2194 }
2195}
2196
2197pub mod content_target {
2200 use serde::de::{self, Deserializer, Visitor};
2201
2202 use super::{ContentTarget, ContentTargetError};
2203
2204 struct TargetVisitor(&'static str);
2208
2209 impl Visitor<'_> for TargetVisitor {
2210 type Value = ContentTarget;
2211
2212 fn expecting(
2213 &self,
2214 f: &mut std::fmt::Formatter<'_>,
2215 ) -> std::fmt::Result {
2216 write!(
2217 f,
2218 "`{}` to be a post or comment id: a full UUID or its first 8 hex digits \
2219 (e.g. \"7ad26ccd\")",
2220 self.0
2221 )
2222 }
2223
2224 fn visit_str<E: de::Error>(self, v: &str) -> Result<ContentTarget, E> {
2225 v.parse()
2226 .map_err(|e: ContentTargetError| E::custom(e.in_field(self.0)))
2227 }
2228 }
2229
2230 pub(super) fn deserialize_field<'de, D: Deserializer<'de>>(
2231 d: D,
2232 field: &'static str,
2233 ) -> Result<ContentTarget, D::Error> {
2234 d.deserialize_str(TargetVisitor(field))
2235 }
2236
2237 pub fn reply_to<'de, D: Deserializer<'de>>(
2239 d: D,
2240 ) -> Result<ContentTarget, D::Error> {
2241 deserialize_field(d, "reply_to")
2242 }
2243
2244 pub fn target<'de, D: Deserializer<'de>>(
2246 d: D,
2247 ) -> Result<ContentTarget, D::Error> {
2248 deserialize_field(d, "target")
2249 }
2250
2251 pub fn post_id<'de, D: Deserializer<'de>>(
2253 d: D,
2254 ) -> Result<ContentTarget, D::Error> {
2255 deserialize_field(d, "post_id")
2256 }
2257
2258 pub fn optional_reply_to<'de, D: Deserializer<'de>>(
2260 d: D,
2261 ) -> Result<Option<ContentTarget>, D::Error> {
2262 reply_to(d).map(Some)
2263 }
2264
2265 pub fn optional_target<'de, D: Deserializer<'de>>(
2269 d: D,
2270 ) -> Result<Option<ContentTarget>, D::Error> {
2271 d.deserialize_option(OptionalVisitor("target"))
2272 }
2273
2274 struct OptionalVisitor(&'static str);
2276
2277 impl<'de> Visitor<'de> for OptionalVisitor {
2278 type Value = Option<ContentTarget>;
2279
2280 fn expecting(
2281 &self,
2282 f: &mut std::fmt::Formatter<'_>,
2283 ) -> std::fmt::Result {
2284 TargetVisitor(self.0).expecting(f)?;
2285 f.write_str(", or nothing")
2286 }
2287
2288 fn visit_none<E: de::Error>(self) -> Result<Self::Value, E> {
2289 Ok(None)
2290 }
2291
2292 fn visit_unit<E: de::Error>(self) -> Result<Self::Value, E> {
2293 Ok(None)
2294 }
2295
2296 fn visit_some<D: Deserializer<'de>>(
2297 self,
2298 d: D,
2299 ) -> Result<Self::Value, D::Error> {
2300 d.deserialize_str(self)
2301 }
2302
2303 fn visit_str<E: de::Error>(self, v: &str) -> Result<Self::Value, E> {
2304 if v.is_empty() || v.trim().eq_ignore_ascii_case("null") {
2305 return Ok(None);
2306 }
2307 TargetVisitor(self.0).visit_str(v).map(Some)
2308 }
2309 }
2310}
2311
2312#[cfg(feature = "schemars")]
2316impl schemars::JsonSchema for ContentTarget {
2317 fn inline_schema() -> bool {
2318 true
2319 }
2320
2321 fn schema_name() -> std::borrow::Cow<'static, str> {
2322 std::borrow::Cow::Borrowed("ContentTarget")
2323 }
2324
2325 fn schema_id() -> std::borrow::Cow<'static, str> {
2326 std::borrow::Cow::Borrowed(concat!(module_path!(), "::ContentTarget"))
2327 }
2328
2329 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
2330 schemars::json_schema!({
2331 "type": "string",
2332 "pattern": CONTENT_TARGET_PATTERN,
2333 "description": "A post or comment id: its full UUID, or its first \
2334 8 hex digits (e.g. \"7ad26ccd\") as shown by \
2335 get_content and the dashboard. A short id works \
2336 only on unsigned calls; a signed call must use \
2337 the full UUID.",
2338 })
2339 }
2340}
2341
2342#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
2345pub struct ContentRefError(pub String);
2346
2347impl ContentRefError {
2348 pub fn leading_ref(&self) -> Option<ContentRef> {
2352 const UUID_LEN: usize = 36;
2353 const CITATION_LENS: [usize; 2] =
2357 ["DATA-2026-0001".len(), "GOV-2026-0006".len()];
2358 let s = self.0.trim_start();
2359 if crate::govlog::DataCitation::is_citation_shaped(s) {
2363 return None;
2364 }
2365 let prompt_len = PROMPT_PREFIXES.iter().find_map(|prefix| {
2367 let head = s.get(..prefix.len())?;
2368 head.eq_ignore_ascii_case(prefix).then(|| {
2369 prefix.len()
2370 + s[prefix.len()..]
2371 .find(|c: char| {
2372 !(c.is_ascii_alphanumeric() || c == '_' || c == '-')
2373 })
2374 .unwrap_or(s.len() - prefix.len())
2375 })
2376 });
2377 prompt_len
2379 .into_iter()
2380 .chain([
2381 UUID_LEN,
2382 CITATION_LENS[0],
2383 CITATION_LENS[1],
2384 "constitution".len(),
2385 "protocol".len(),
2386 "prompts".len(),
2387 ])
2388 .filter(|&n| s.len() > n && s.is_char_boundary(n))
2389 .find_map(|n| {
2393 s[..n]
2394 .parse()
2395 .ok()
2396 .filter(|r| !matches!(r, ContentRef::ContentPrefix(_)))
2397 })
2398 }
2399}
2400
2401impl std::fmt::Display for ContentRefError {
2402 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2403 if crate::govlog::DataCitation::is_citation_shaped(&self.0)
2404 && let Err(e) = self.0.parse::<crate::govlog::DataCitation>()
2405 {
2406 return write!(f, "not a data set citation: {e} ({:?})", self.0);
2407 }
2408 write!(
2409 f,
2410 "not a content reference (expected a post/comment UUID or its \
2411 first eight hex digits, a GOV-YYYY-NNNN / APP-YYYY-NNNN governance id, a data \
2412 set's file as DATA-YYYY-NNNN:<commit>:<path> or \
2413 DATA-YYYY-NNNN:/<path>, or a document slug \
2414 like \"constitution\", \"protocol\", \"prompts\" or \
2415 \"prompt:<name>\"): {:?}",
2416 self.0
2417 )?;
2418 if let Some(id) = self.leading_ref() {
2419 write!(
2420 f,
2421 ". It starts with the valid id {id} followed by extra text; \
2422 pass only the id"
2423 )?;
2424 }
2425 Ok(())
2426 }
2427}
2428
2429#[derive(Debug, Clone, PartialEq, Eq, Hash)]
2447pub enum ContentRef {
2448 Content(ContentId),
2450 ContentPrefix(ContentIdPrefix),
2453 Governance(GovernanceLogId),
2455 DataCitation(crate::govlog::DataCitation),
2459 Document(PlatformDoc),
2461}
2462
2463impl ContentRef {
2464 pub fn as_content(&self) -> Option<ContentId> {
2466 match self {
2467 ContentRef::Content(id) => Some(*id),
2468 _ => None,
2469 }
2470 }
2471
2472 pub fn as_governance(&self) -> Option<&GovernanceLogId> {
2474 match self {
2475 ContentRef::Governance(id) => Some(id),
2476 _ => None,
2477 }
2478 }
2479
2480 pub fn as_document(&self) -> Option<&PlatformDoc> {
2482 match self {
2483 ContentRef::Document(doc) => Some(doc),
2484 _ => None,
2485 }
2486 }
2487
2488 pub fn as_data_citation(&self) -> Option<&crate::govlog::DataCitation> {
2491 match self {
2492 ContentRef::DataCitation(c) => Some(c),
2493 _ => None,
2494 }
2495 }
2496
2497 pub fn data_set(&self) -> Option<&GovernanceLogId> {
2500 match self {
2501 ContentRef::Governance(id)
2502 if id.prefix() == GovernanceLogPrefix::Data =>
2503 {
2504 Some(id)
2505 }
2506 ContentRef::DataCitation(c) => Some(&c.set),
2507 _ => None,
2508 }
2509 }
2510
2511 pub fn is_governance(&self) -> bool {
2515 matches!(self, ContentRef::Governance(_))
2516 }
2517
2518 pub fn kind_str(&self) -> &'static str {
2521 match self {
2522 ContentRef::Content(_) | ContentRef::ContentPrefix(_) => "content",
2523 ContentRef::Governance(_) => "governance",
2524 ContentRef::DataCitation(_) => "data file",
2525 ContentRef::Document(_) => "document",
2526 }
2527 }
2528}
2529
2530impl std::fmt::Display for ContentRef {
2531 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
2532 match self {
2533 ContentRef::Content(id) => id.fmt(f),
2534 ContentRef::ContentPrefix(prefix) => prefix.fmt(f),
2535 ContentRef::Governance(id) => id.fmt(f),
2536 ContentRef::DataCitation(c) => c.fmt(f),
2537 ContentRef::Document(doc) => doc.fmt(f),
2538 }
2539 }
2540}
2541
2542impl std::str::FromStr for ContentRef {
2543 type Err = ContentRefError;
2544
2545 fn from_str(s: &str) -> Result<Self, Self::Err> {
2546 if let Ok(id) = s.parse::<ContentId>() {
2547 return Ok(ContentRef::Content(id));
2548 }
2549 if let Ok(prefix) = s.parse::<ContentIdPrefix>() {
2550 return Ok(ContentRef::ContentPrefix(prefix));
2551 }
2552 if let Ok(id) = s.parse::<GovernanceLogId>() {
2553 return Ok(ContentRef::Governance(id));
2554 }
2555 if crate::govlog::DataCitation::is_citation_shaped(s) {
2556 return s
2557 .parse()
2558 .map(ContentRef::DataCitation)
2559 .map_err(|_| ContentRefError(s.to_string()));
2560 }
2561 if let Ok(doc) = s.parse::<PlatformDoc>() {
2562 return Ok(ContentRef::Document(doc));
2563 }
2564 Err(ContentRefError(s.to_string()))
2565 }
2566}
2567
2568impl TryFrom<String> for ContentRef {
2569 type Error = ContentRefError;
2570
2571 fn try_from(s: String) -> Result<Self, Self::Error> {
2572 s.parse()
2573 }
2574}
2575
2576impl From<ContentId> for ContentRef {
2577 fn from(id: ContentId) -> Self {
2578 ContentRef::Content(id)
2579 }
2580}
2581
2582impl From<PostId> for ContentRef {
2583 fn from(id: PostId) -> Self {
2584 ContentRef::Content(id.into())
2585 }
2586}
2587
2588impl From<CommentId> for ContentRef {
2589 fn from(id: CommentId) -> Self {
2590 ContentRef::Content(id.into())
2591 }
2592}
2593
2594impl From<ContentIdPrefix> for ContentRef {
2595 fn from(prefix: ContentIdPrefix) -> Self {
2596 ContentRef::ContentPrefix(prefix)
2597 }
2598}
2599
2600impl From<GovernanceLogId> for ContentRef {
2601 fn from(id: GovernanceLogId) -> Self {
2602 ContentRef::Governance(id)
2603 }
2604}
2605
2606impl From<crate::govlog::DataCitation> for ContentRef {
2607 fn from(c: crate::govlog::DataCitation) -> Self {
2608 ContentRef::DataCitation(c)
2609 }
2610}
2611
2612impl From<PlatformDoc> for ContentRef {
2613 fn from(doc: PlatformDoc) -> Self {
2614 ContentRef::Document(doc)
2615 }
2616}
2617
2618impl Serialize for ContentRef {
2619 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
2620 s.collect_str(self)
2621 }
2622}
2623
2624impl<'de> Deserialize<'de> for ContentRef {
2625 fn deserialize<D: serde::Deserializer<'de>>(
2626 d: D,
2627 ) -> Result<Self, D::Error> {
2628 let raw = String::deserialize(d)?;
2629 raw.parse().map_err(serde::de::Error::custom)
2630 }
2631}
2632
2633#[cfg(feature = "schemars")]
2638impl schemars::JsonSchema for ContentRef {
2639 fn inline_schema() -> bool {
2640 true
2641 }
2642
2643 fn schema_name() -> std::borrow::Cow<'static, str> {
2644 std::borrow::Cow::Borrowed("ContentRef")
2645 }
2646
2647 fn schema_id() -> std::borrow::Cow<'static, str> {
2648 std::borrow::Cow::Borrowed(concat!(module_path!(), "::ContentRef"))
2649 }
2650
2651 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
2652 schemars::json_schema!({
2653 "type": "string",
2654 "pattern": CONTENT_REF_PATTERN,
2655 "description": "A post or comment UUID, or its first eight \
2656 hex digits (e.g. \"7ad26ccd\"); a governance log id \
2657 such as \"GOV-2026-0006\" (Council decision) \
2658 or \"APP-2026-0003\" (appeals ruling); a data \
2659 set's file cited at a commit, \
2660 \"DATA-2026-0001:<commit>:<path>\" (or \
2661 \"…:<path>:110-300\" for some of its lines; \
2662 without the commit, for the one the set pins, \
2663 \"DATA-2026-0001:/<path>\"); or a \
2664 document slug — \"constitution\", \
2665 \"protocol\" (the Governance Protocol), \
2666 \"prompts\" (the index of the model prompts \
2667 moderation, appeals and the Council run on) or \
2668 \"prompt:<name>\" (one of them).",
2669 })
2670 }
2671}
2672
2673#[cfg(test)]
2674mod tests {
2675 use super::*;
2676
2677 #[test]
2678 fn witness_ids_fold_and_refuse() {
2679 let id: WitnessId = " Qwen_3-8 ".parse().unwrap();
2680 assert_eq!(id.as_str(), "qwen-3-8");
2681 for bad in ["", "3qwen", "-qwen", "qwen 3", "qwen.3", &"q".repeat(65)] {
2682 assert!(bad.parse::<WitnessId>().is_err(), "{bad:?}");
2683 }
2684 let json: WitnessId = serde_json::from_str("\"FACT_checker\"").unwrap();
2685 assert_eq!(json.as_str(), "fact-checker");
2686 assert!(serde_json::from_str::<WitnessId>("\"no way\"").is_err());
2687 }
2688
2689 #[test]
2690 fn witness_question_ids_are_bare_numbers() {
2691 let id: WitnessQuestionId = " 12 ".parse().unwrap();
2692 assert_eq!(id.get(), 12);
2693 assert_eq!(id.to_string(), "12");
2694 assert_eq!(id.next().to_string(), "13");
2695 assert_eq!(WitnessQuestionId::default().to_string(), "1");
2696 for bad in ["", "0", "012", "q12", "-1", "1.5", "1", "99999999999"] {
2697 assert!(bad.parse::<WitnessQuestionId>().is_err(), "{bad:?}");
2698 }
2699 assert_eq!(serde_json::to_string(&id).unwrap(), "12");
2700 assert_eq!(
2701 serde_json::from_str::<WitnessQuestionId>("12").unwrap(),
2702 id
2703 );
2704 assert!(serde_json::from_str::<WitnessQuestionId>("0").is_err());
2705 assert!(serde_json::from_str::<WitnessQuestionId>("\"12\"").is_err());
2706 }
2707
2708 #[cfg(feature = "schemars")]
2709 #[test]
2710 fn witness_question_id_schema_is_inline_and_patternless() {
2711 let schema =
2712 serde_json::to_value(schemars::schema_for!(WitnessQuestionId))
2713 .unwrap();
2714 let rendered = schema.to_string();
2715 assert!(!rendered.contains("pattern"), "{rendered}");
2716 assert!(!rendered.contains("$ref"), "{rendered}");
2717 }
2718
2719 #[cfg(feature = "schemars")]
2720 #[test]
2721 fn witness_id_schema_is_inline_and_patternless() {
2722 let schema =
2723 serde_json::to_value(schemars::schema_for!(WitnessId)).unwrap();
2724 let rendered = schema.to_string();
2725 assert!(!rendered.contains("pattern"), "{rendered}");
2726 assert!(!rendered.contains("$ref"), "{rendered}");
2727 }
2728
2729 #[test]
2730 fn governance_log_ids_from_parts() {
2731 for prefix in GovernanceLogPrefix::ALL {
2732 let id = GovernanceLogId::from_parts(prefix, 2026, 42).unwrap();
2733 assert_eq!(id.as_str(), format!("{prefix}-2026-0042"));
2734 assert_eq!(id.prefix(), prefix);
2735 assert_eq!(id.as_str().parse::<GovernanceLogId>().unwrap(), id);
2736 }
2737 let gov = GovernanceLogPrefix::Gov;
2738 assert!(GovernanceLogId::from_parts(gov, 2026, 9999).is_some());
2739 assert!(GovernanceLogId::from_parts(gov, 2026, 10_000).is_none());
2740 assert!(GovernanceLogId::from_parts(gov, 2026, 0).is_none());
2741 assert!(GovernanceLogId::from_parts(gov, 999, 1).is_none());
2742 }
2743
2744 #[test]
2746 fn archive_contexts_round_trip_through_their_columns() {
2747 use crate::enums::ArchiveContextKind;
2748 let contexts = [
2749 ArchiveContext::from(AgendaItemId::new()),
2750 ArchiveContext::from(CouncilMeetingId::new()),
2751 ArchiveContext::from(AppealId::new()),
2752 ArchiveContext::from(FlagId::new()),
2753 ArchiveContext::from(InterviewRunId::new()),
2754 ];
2755 let kinds: Vec<_> = contexts.iter().map(ArchiveContext::kind).collect();
2756 assert_eq!(kinds, ArchiveContextKind::ALL);
2757 for c in contexts {
2758 assert_eq!(ArchiveContext::from_stored(c.kind(), c.as_uuid()), c);
2759 }
2760 let id = AgendaItemId::new();
2761 assert_eq!(
2762 ArchiveContext::from(id).to_string(),
2763 format!("agenda item {id}")
2764 );
2765 }
2766
2767 #[test]
2768 fn byte_ids_debug() {
2769 let handle = WebAuthnUserHandle::from(vec![7; 64]);
2770 assert_eq!(format!("{handle:?}"), "WebAuthnUserHandle(..)");
2771 let credential = PasskeyCredentialId::from(vec![0xab; 2]);
2772 assert_eq!(format!("{credential:?}"), "PasskeyCredentialId(abab)");
2773 assert_eq!(credential.as_bytes(), &[0xab, 0xab]);
2774 }
2775
2776 #[test]
2777 fn oauth_client_id_round_trips() {
2778 let id = OAuthClientId::generate();
2779 assert_eq!(id.as_str().parse::<OAuthClientId>().unwrap(), id);
2780 let json = serde_json::to_string(&id).unwrap();
2781 assert_eq!(serde_json::from_str::<OAuthClientId>(&json).unwrap(), id);
2782 }
2783
2784 #[test]
2785 fn oauth_client_id_rejects_empty_oversized_and_control_characters() {
2786 assert!("".parse::<OAuthClientId>().is_err());
2787 assert!("a".repeat(256).parse::<OAuthClientId>().is_err());
2788 assert!("abc\ndef".parse::<OAuthClientId>().is_err());
2789 assert!(serde_json::from_str::<OAuthClientId>("\"\"").is_err());
2790 }
2791
2792 #[test]
2796 fn a_data_citation_is_a_content_ref() {
2797 let written = "DATA-2026-0001:89fe7c6:votes/ballots.csv:110-300";
2798 let r: ContentRef = written.parse().unwrap();
2799 let c = r.as_data_citation().expect("a citation");
2800 assert_eq!(c.path.as_str(), "votes/ballots.csv");
2801 assert_eq!(r.to_string(), written);
2802 assert_eq!(
2803 r.data_set().map(GovernanceLogId::as_str),
2804 Some("DATA-2026-0001")
2805 );
2806 assert!(!r.is_governance());
2807 assert_eq!(r.kind_str(), "data file");
2808 let json = serde_json::to_value(&r).unwrap();
2809 assert_eq!(json, written);
2810 assert_eq!(serde_json::from_value::<ContentRef>(json).unwrap(), r);
2811 let whole: ContentRef =
2812 "DATA-2026-0001:89fe7c6:votes/ballots.csv".parse().unwrap();
2813 assert_eq!(whole.as_data_citation().unwrap().lines, None);
2814 let pinned: ContentRef =
2816 "DATA-2026-0001:/votes/ballots.csv:110-300".parse().unwrap();
2817 let p = pinned.as_data_citation().expect("a citation");
2818 assert_eq!(
2819 (p.commit.as_ref(), p.path.as_str()),
2820 (None, "votes/ballots.csv")
2821 );
2822 assert_eq!(
2823 pinned.to_string(),
2824 "DATA-2026-0001:/votes/ballots.csv:110-300"
2825 );
2826 let json = serde_json::to_value(&pinned).unwrap();
2827 assert_eq!(serde_json::from_value::<ContentRef>(json).unwrap(), pinned);
2828 let hexdir: ContentRef =
2829 "DATA-2026-0001:/abcdef1/file.md".parse().unwrap();
2830 assert_eq!(hexdir.as_data_citation().unwrap().commit, None);
2831 for other in
2833 ["GOV-2026-0006:votes/a.md", "TEST-2026-0001:votes/a.md:1-2"]
2834 {
2835 let err = other.parse::<ContentRef>().unwrap_err();
2836 assert!(!crate::govlog::DataCitation::is_citation_shaped(other));
2837 assert!(
2838 !err.to_string().contains("not a data set citation"),
2839 "{err}"
2840 );
2841 }
2842 let set: ContentRef = "DATA-2026-0001".parse().unwrap();
2843 assert_eq!(set.data_set(), Some(&"DATA-2026-0001".parse().unwrap()));
2844 assert!(set.as_data_citation().is_none());
2845
2846 for bad in [
2847 "DATA-2026-0001:89fe7c6",
2848 "DATA-2026-0001::",
2849 "DATA-2026-0001: the vote tallies",
2850 ] {
2851 let err = bad.parse::<ContentRef>().unwrap_err();
2852 assert_eq!(err.leading_ref(), None, "{bad}");
2853 let text = err.to_string();
2854 assert!(text.contains("not a data set citation"), "{text}");
2855 assert!(text.contains("DATA-YYYY-NNNN:<commit>:<path>"), "{text}");
2856 assert!(!text.contains("starts with the valid id"), "{text}");
2857 }
2858 let test: ContentRef = "TEST-2026-0001".parse().unwrap();
2862 assert!(test.is_governance() && test.as_data_citation().is_none());
2863 assert_eq!(test.data_set(), None);
2864 assert!(!crate::govlog::DataCitation::is_citation_shaped(
2865 "TEST-2026-0001:89fe7c6:votes/a.md"
2866 ));
2867 let err = "TEST-2026-0001:89fe7c6:votes/a.md"
2868 .parse::<ContentRef>()
2869 .unwrap_err();
2870 assert!(
2871 !err.to_string().contains("not a data set citation"),
2872 "{err}"
2873 );
2874 assert_eq!(err.leading_ref(), Some("TEST-2026-0001".parse().unwrap()));
2875 assert!(matches!(
2876 "TEST-2026-0001:89fe7c6:votes/a.md"
2877 .parse::<crate::govlog::DataCitation>(),
2878 Err(crate::govlog::DataCitationError::NotDataSet(_))
2879 ));
2880 let data: ContentRef =
2881 "DATA-2026-0001:89fe7c6:votes/a.md".parse().unwrap();
2882 assert!(data.as_data_citation().is_some() && !data.is_governance());
2883 let err = "GOV-2026-0006: the ratification"
2885 .parse::<ContentRef>()
2886 .unwrap_err();
2887 assert_eq!(err.leading_ref(), Some("GOV-2026-0006".parse().unwrap()));
2888 }
2889
2890 #[test]
2891 fn content_ref_error_names_a_leading_id_followed_by_extra_text() {
2892 let uuid = "6dcef9bb-2b3c-4f5e-9a1b-0c2d3e4f5a6b";
2893 for (input, lead) in [
2894 (format!("{uuid} and the safe-space proposal"), uuid),
2895 (format!("{uuid}b0518e42"), uuid),
2896 (
2897 "GOV-2026-0006 (the ratification)".to_string(),
2898 "GOV-2026-0006",
2899 ),
2900 (
2903 "DATA-2026-0001 (the vote tallies)".to_string(),
2904 "DATA-2026-0001",
2905 ),
2906 ("DATA-2026-0012, index.md".to_string(), "DATA-2026-0012"),
2907 ("TEST-2026-0001 (the dry run)".to_string(), "TEST-2026-0001"),
2909 ("OBL-2026-0001 and more".to_string(), "OBL-2026-0001"),
2910 ("protocol, section 3".to_string(), "protocol"),
2911 ("prompts, please".to_string(), "prompts"),
2912 (
2913 "prompt:tier2_reviewer and the juror's".to_string(),
2914 "prompt:tier2_reviewer",
2915 ),
2916 (
2917 "prompts/appeals_juror.md, line 3".to_string(),
2918 "prompt:appeals_juror",
2919 ),
2920 ] {
2921 let err = input.parse::<ContentRef>().unwrap_err();
2922 assert_eq!(
2923 err.leading_ref(),
2924 Some(lead.parse().unwrap()),
2925 "{input}"
2926 );
2927 let msg = err.to_string();
2928 assert!(
2929 msg.contains(&format!("valid id {lead} followed")),
2930 "{msg}"
2931 );
2932 }
2933
2934 let short = "6dcef9bb-2b3c-4f5e-9a1b-0c2d3e4f5a6";
2936 let err = short.parse::<ContentRef>().unwrap_err();
2937 assert_eq!(err.leading_ref(), None);
2938 assert!(!err.to_string().contains("followed by"));
2939 assert_eq!(
2941 "GOV-2026-1".parse::<ContentRef>().unwrap(),
2942 ContentRef::Governance("GOV-2026-0001".parse().unwrap())
2943 );
2944 }
2945
2946 #[test]
2947 fn citations_normalize_as_written() {
2948 for (written, canonical) in [
2949 ("GOV-2026-0006", "GOV-2026-0006"),
2950 ("GOV-2026.6", "GOV-2026-0006"),
2951 ("gov-2026-6", "GOV-2026-0006"),
2952 ("GOV 2026 6", "GOV-2026-0006"),
2953 ("app/2026/03", "APP-2026-0003"),
2954 (" REC-2026-0002 ", "REC-2026-0002"),
2955 ("obl-2026-12", "OBL-2026-0012"),
2956 ("OBL.2026.7", "OBL-2026-0007"),
2957 ("data-2026-3", "DATA-2026-0003"),
2958 ("DATA.2026.12", "DATA-2026-0012"),
2959 (" Data/2026/0001 ", "DATA-2026-0001"),
2960 ("DATA 2026 7", "DATA-2026-0007"),
2961 ("test-2026-3", "TEST-2026-0003"),
2962 ("Test.2026.12", "TEST-2026-0012"),
2963 ] {
2964 let id: GovernanceLogId = written.parse().unwrap();
2965 assert_eq!(id.as_str(), canonical, "{written}");
2966 let json: GovernanceLogId =
2967 serde_json::from_value(serde_json::json!(written)).unwrap();
2968 assert_eq!(json.as_str(), canonical, "{written} via serde");
2969 let content: ContentRef = written.parse().unwrap();
2970 assert_eq!(content, ContentRef::Governance(id), "{written}");
2971 }
2972 for rejected in [
2973 "GOV-2026-N",
2974 "GOV-2026/GOVG=6",
2975 "GOV-2026-00006",
2976 "GOV-26-0006",
2977 "GOV-2026-",
2978 "XYZ-2026-0006",
2979 "GOV-2026-0006-1",
2980 ] {
2981 assert!(rejected.parse::<GovernanceLogId>().is_err(), "{rejected}");
2982 }
2983 assert!(!GovernanceLogId::is_citation_shaped("GOV-2026.6"));
2985 }
2986
2987 #[test]
2988 fn content_ref_parses_document_slugs() {
2989 assert_eq!(
2990 "constitution".parse(),
2991 Ok(ContentRef::Document(PlatformDoc::Constitution))
2992 );
2993 assert_eq!(
2994 "protocol".parse(),
2995 Ok(ContentRef::Document(PlatformDoc::GovernanceProtocol))
2996 );
2997 assert_eq!(
2999 "governance-protocol".parse(),
3000 Ok(ContentRef::Document(PlatformDoc::GovernanceProtocol))
3001 );
3002 assert_eq!(
3003 "Constitution".parse(),
3004 Ok(ContentRef::Document(PlatformDoc::Constitution))
3005 );
3006 assert!("proto".parse::<ContentRef>().is_err());
3007 }
3008
3009 #[test]
3010 fn content_ref_parses_prompt_slugs() {
3011 let juror = PlatformDoc::Prompt("appeals_juror".parse().unwrap());
3012 for written in [
3013 "prompt:appeals_juror",
3014 "Prompt:Appeals_Juror",
3015 "prompt/appeals-juror",
3016 "prompts/appeals_juror.md",
3017 "prompts:appeals_juror",
3018 ] {
3019 assert_eq!(
3020 written.parse(),
3021 Ok(ContentRef::Document(juror.clone())),
3022 "{written}"
3023 );
3024 }
3025 assert_eq!(juror.to_string(), "prompt:appeals_juror");
3026 for index in ["prompts", "Prompts", "prompt"] {
3027 assert_eq!(
3028 index.parse(),
3029 Ok(ContentRef::Document(PlatformDoc::Prompts)),
3030 "{index}"
3031 );
3032 }
3033 for rejected in [
3034 "prompt:",
3035 "prompt:2fast",
3036 "prompt:tier 2",
3037 "prompt:../secrets",
3038 "prompt:tier2_reviewer/x",
3039 "promptly",
3040 ] {
3041 assert!(rejected.parse::<ContentRef>().is_err(), "{rejected}");
3042 }
3043 let long = format!("prompt:{}", "a".repeat(PromptName::MAX_LEN + 1));
3044 assert!(long.parse::<ContentRef>().is_err());
3045 }
3046
3047 #[test]
3048 fn content_id_prefix_parses_eight_hex_digits_leniently() {
3049 let p: ContentIdPrefix = "7ad26ccd".parse().unwrap();
3050 assert_eq!(p.to_string(), "7ad26ccd");
3051 assert_eq!(" 7AD26CCD\n".parse::<ContentIdPrefix>().unwrap(), p);
3052 for rejected in ["7ad26cc", "7ad26ccd0", "7ad26ccg", "", "7ad2-6cc"] {
3053 assert!(rejected.parse::<ContentIdPrefix>().is_err(), "{rejected}");
3054 }
3055 }
3056
3057 #[test]
3058 fn content_id_prefix_bounds_cover_exactly_its_uuids() {
3059 let id: Uuid = "7ad26ccd-922f-484a-a37c-51777344a98c".parse().unwrap();
3060 let p = ContentIdPrefix::of(&id);
3061 assert_eq!(p.to_string(), "7ad26ccd");
3062 assert!(p.matches(&id));
3063 let (lo, hi) = p.bounds();
3064 assert_eq!(lo.to_string(), "7ad26ccd-0000-0000-0000-000000000000");
3065 assert_eq!(hi.to_string(), "7ad26ccd-ffff-ffff-ffff-ffffffffffff");
3066 assert!(lo <= id && id <= hi);
3067 let next: Uuid =
3068 "7ad26cce-0000-0000-0000-000000000000".parse().unwrap();
3069 assert!(!p.matches(&next) && next > hi);
3070 let top: ContentIdPrefix = "ffffffff".parse().unwrap();
3072 assert_eq!(top.bounds().1, Uuid::max());
3073 let bottom: ContentIdPrefix = "00000000".parse().unwrap();
3074 assert_eq!(bottom.bounds().0, Uuid::nil());
3075 }
3076
3077 #[test]
3078 fn content_ref_reads_a_short_id_and_only_eight_digits() {
3079 let r: ContentRef = "7ad26ccd".parse().unwrap();
3080 assert_eq!(r, ContentRef::ContentPrefix("7ad26ccd".parse().unwrap()));
3081 assert_eq!(r.kind_str(), "content");
3082 assert_eq!(serde_json::to_string(&r).unwrap(), "\"7ad26ccd\"");
3083 let full: ContentRef =
3085 "7ad26ccd-922f-484a-a37c-51777344a98c".parse().unwrap();
3086 assert!(matches!(full, ContentRef::Content(_)));
3087 let err = "7ad26ccd-922f".parse::<ContentRef>().unwrap_err();
3092 assert_eq!(err.leading_ref(), None);
3093 }
3094
3095 #[test]
3096 fn content_ref_pattern_admits_short_ids() {
3097 let short = CONTENT_ID_PREFIX_PATTERN
3098 .strip_prefix('^')
3099 .and_then(|p| p.strip_suffix('$'))
3100 .unwrap();
3101 assert!(CONTENT_REF_PATTERN.contains(&format!("|{short}|")));
3102 }
3103
3104 #[test]
3106 fn document_patterns_agree() {
3107 let docs = PLATFORM_DOC_PATTERN.strip_prefix("^(").unwrap();
3108 assert!(CONTENT_REF_PATTERN.ends_with(&format!("|{docs}")));
3109 let name = PROMPT_NAME_PATTERN
3110 .strip_prefix('^')
3111 .and_then(|p| p.strip_suffix('$'))
3112 .unwrap();
3113 assert!(PLATFORM_DOC_PATTERN.contains(&format!("|prompt:{name})$")));
3114 }
3115
3116 #[test]
3117 fn calendar_is_a_document_slug() {
3118 assert_eq!(
3119 "calendar".parse::<ContentRef>().unwrap(),
3120 ContentRef::Document(PlatformDoc::Calendar)
3121 );
3122 assert_eq!(
3123 "Calendar".parse::<PlatformDoc>().unwrap(),
3124 PlatformDoc::Calendar
3125 );
3126 assert_eq!(PlatformDoc::Calendar.to_string(), "calendar");
3127 assert_eq!(
3128 "OBL-2026-0001".parse::<ContentRef>().unwrap(),
3129 ContentRef::Governance("OBL-2026-0001".parse().unwrap())
3130 );
3131 assert_eq!(
3132 "DATA-2026-0001".parse::<ContentRef>().unwrap(),
3133 ContentRef::Governance("DATA-2026-0001".parse().unwrap())
3134 );
3135 assert_eq!(
3136 "TEST-2026-0001".parse::<ContentRef>().unwrap(),
3137 ContentRef::Governance("TEST-2026-0001".parse().unwrap())
3138 );
3139 }
3140
3141 #[test]
3142 fn platform_doc_serde_uses_the_canonical_slug() {
3143 let json =
3144 serde_json::to_string(&PlatformDoc::GovernanceProtocol).unwrap();
3145 assert_eq!(json, "\"protocol\"");
3146 let doc: PlatformDoc =
3147 serde_json::from_str("\"governance-protocol\"").unwrap();
3148 assert_eq!(doc, PlatformDoc::GovernanceProtocol);
3149 }
3150
3151 #[test]
3152 fn ids_are_unique() {
3153 let a = AgentId::new();
3154 let b = AgentId::new();
3155 assert_ne!(a, b);
3156 }
3157
3158 #[test]
3159 fn serde_round_trip() {
3160 let id = PostId::new();
3161 let json = serde_json::to_string(&id).unwrap();
3162 let deserialized: PostId = serde_json::from_str(&json).unwrap();
3163 assert_eq!(id, deserialized);
3164 }
3165
3166 #[test]
3167 fn display_shows_uuid() {
3168 let id = CommunityId::new();
3169 let display = id.to_string();
3170 assert_eq!(display.len(), 36);
3172 assert!(display.contains('-'));
3173 }
3174
3175 #[test]
3176 fn from_uuid_round_trip() {
3177 let uuid = Uuid::new_v4();
3178 let id = AgentId::from(uuid);
3179 let back: Uuid = id.into();
3180 assert_eq!(uuid, back);
3181 }
3182
3183 #[test]
3187 fn every_id_round_trips_through_its_own_display() {
3188 let agent = AgentId::new();
3189 assert_eq!(agent.to_string().parse::<AgentId>().unwrap(), agent);
3190
3191 let action = ModerationActionId::new();
3192 assert_eq!(
3193 action.to_string().parse::<ModerationActionId>().unwrap(),
3194 action
3195 );
3196
3197 let content = ContentId::new();
3198 assert_eq!(content.to_string().parse::<ContentId>().unwrap(), content);
3199
3200 let feedback = FeedbackId::new();
3201 assert_eq!(
3202 feedback.to_string().parse::<FeedbackId>().unwrap(),
3203 feedback
3204 );
3205 }
3206
3207 #[test]
3208 fn parsing_a_non_uuid_is_an_error_not_a_panic() {
3209 assert!("not-a-uuid".parse::<ContentId>().is_err());
3210 assert!("".parse::<ContentId>().is_err());
3211 }
3212
3213 #[test]
3218 fn content_id_is_wire_compatible_with_a_bare_uuid() {
3219 let uuid = Uuid::new_v4();
3220 let typed = ContentId::from(uuid);
3221 assert_eq!(
3222 serde_json::to_string(&typed).unwrap(),
3223 serde_json::to_string(&uuid).unwrap()
3224 );
3225 }
3226
3227 #[test]
3230 fn every_moderation_target_narrows_losslessly() {
3231 let uuid = Uuid::new_v4();
3232
3233 for (label, got) in [
3234 ("PostId", ModerationTargetId::from(PostId::from(uuid))),
3235 ("CommentId", ModerationTargetId::from(CommentId::from(uuid))),
3236 ("MessageId", ModerationTargetId::from(MessageId::from(uuid))),
3237 ("AgentId", ModerationTargetId::from(AgentId::from(uuid))),
3238 ("ContentId", ModerationTargetId::from(ContentId::from(uuid))),
3239 ] {
3240 assert_eq!(
3241 got.as_uuid(),
3242 &uuid,
3243 "{label} -> ModerationTargetId lost the uuid"
3244 );
3245 }
3246 }
3247
3248 #[test]
3252 fn resolved_ids_narrow_to_content_id_losslessly() {
3253 let uuid = Uuid::new_v4();
3254
3255 assert_eq!(
3256 ContentId::from(PostId::from(uuid)).as_uuid(),
3257 &uuid,
3258 "PostId -> ContentId lost the uuid"
3259 );
3260 assert_eq!(
3261 ContentId::from(CommentId::from(uuid)).as_uuid(),
3262 &uuid,
3263 "CommentId -> ContentId lost the uuid"
3264 );
3265 assert_eq!(
3266 ContentId::from(PostOrCommentId::Comment(CommentId::from(uuid)))
3267 .as_uuid(),
3268 &uuid,
3269 "PostOrCommentId -> ContentId lost the uuid"
3270 );
3271 }
3272
3273 #[test]
3274 fn json_is_plain_uuid_string() {
3275 let uuid = Uuid::new_v4();
3276 let id = AgentId::from(uuid);
3277 let id_json = serde_json::to_string(&id).unwrap();
3279 let uuid_json = serde_json::to_string(&uuid).unwrap();
3280 assert_eq!(id_json, uuid_json);
3281 }
3282
3283 #[cfg(feature = "schemars")]
3288 #[test]
3289 fn id_json_schema_is_inlined() {
3290 use schemars::JsonSchema;
3291
3292 assert!(
3293 <PostId as JsonSchema>::inline_schema(),
3294 "PostId::inline_schema() must return true to avoid $ref in containing schemas"
3295 );
3296 assert!(<AgentId as JsonSchema>::inline_schema());
3297 assert!(<CommentId as JsonSchema>::inline_schema());
3298 assert!(<CommunityId as JsonSchema>::inline_schema());
3299 assert!(<GovernanceLogId as JsonSchema>::inline_schema());
3300 assert!(<ContentRef as JsonSchema>::inline_schema());
3301 assert!(<FeedbackId as JsonSchema>::inline_schema());
3302 assert!(<ContactRequestId as JsonSchema>::inline_schema());
3303
3304 #[derive(schemars::JsonSchema)]
3308 #[allow(dead_code)]
3309 struct Container {
3310 post_id: PostId,
3312 agent_id: Option<AgentId>,
3314 gov_id: GovernanceLogId,
3316 maybe_gov_id: Option<GovernanceLogId>,
3318 content_ref: ContentRef,
3320 maybe_content_ref: Option<ContentRef>,
3322 feedback_id: FeedbackId,
3324 }
3325
3326 let schema = schemars::schema_for!(Container);
3327 let value = serde_json::to_value(&schema).unwrap();
3328
3329 assert!(
3331 value.get("$defs").is_none(),
3332 "no $defs should be emitted for ID-only container; got schema: {value}"
3333 );
3334
3335 let post_id = &value["properties"]["post_id"];
3337 assert!(
3338 post_id.get("$ref").is_none(),
3339 "post_id must not be a $ref; got: {post_id}"
3340 );
3341 assert_eq!(post_id["type"], "string");
3342 assert_eq!(post_id["format"], "uuid");
3343
3344 let agent_id = &value["properties"]["agent_id"];
3349 assert!(
3350 agent_id.get("$ref").is_none(),
3351 "agent_id must not be a $ref; got: {agent_id}"
3352 );
3353 let agent_id_str = agent_id.to_string();
3354 assert!(
3355 !agent_id_str.contains("$ref"),
3356 "agent_id schema must contain no $ref anywhere; got: {agent_id}"
3357 );
3358 assert!(
3359 agent_id_str.contains("\"format\":\"uuid\""),
3360 "agent_id should still carry format=uuid; got: {agent_id}"
3361 );
3362
3363 for field in
3368 ["gov_id", "maybe_gov_id", "content_ref", "maybe_content_ref"]
3369 {
3370 let f = &value["properties"][field];
3371 assert!(
3372 !f.to_string().contains("$ref"),
3373 "{field} must contain no $ref anywhere; got: {f}"
3374 );
3375 }
3376 assert_eq!(value["properties"]["gov_id"]["type"], "string");
3377 assert_eq!(
3378 value["properties"]["gov_id"]["pattern"],
3379 GOVERNANCE_LOG_ID_PATTERN
3380 );
3381 assert!(
3382 value["properties"]["maybe_gov_id"]
3383 .to_string()
3384 .contains("GOV|APP"),
3385 "Option<GovernanceLogId> should keep the citation pattern; got: {}",
3386 value["properties"]["maybe_gov_id"]
3387 );
3388 assert_eq!(value["properties"]["content_ref"]["type"], "string");
3389 }
3390
3391 #[test]
3392 fn governance_log_id_accepts_only_citation_shapes() {
3393 for (good, prefix) in [
3394 ("GOV-2026-0006", GovernanceLogPrefix::Gov),
3395 ("APP-2026-0003", GovernanceLogPrefix::App),
3396 ("AMD-2026-0001", GovernanceLogPrefix::Amd),
3397 ("KEY-2026-0001", GovernanceLogPrefix::Key),
3398 ("REC-2026-0001", GovernanceLogPrefix::Rec),
3399 ("OBL-2026-0001", GovernanceLogPrefix::Obl),
3400 ("DATA-2026-0001", GovernanceLogPrefix::Data),
3401 ("TEST-2026-0001", GovernanceLogPrefix::Test),
3402 ("GOV-1999-0000", GovernanceLogPrefix::Gov),
3403 ] {
3404 let id = good.parse::<GovernanceLogId>().unwrap();
3405 assert_eq!(id.as_str(), good, "{good} should parse");
3406 assert_eq!(id.prefix(), prefix);
3407 let letters = good.split('-').next().unwrap();
3408 assert_eq!(id.prefix().as_str(), letters);
3409 assert_eq!(id.prefix().to_string().parse(), Ok(prefix));
3410 }
3411 let newer: GovernanceLogId =
3413 serde_json::from_value(serde_json::json!("ZZZ-2026-0001")).unwrap();
3414 assert_eq!(newer.prefix(), GovernanceLogPrefix::Unknown);
3415 assert_eq!(newer.as_str(), "ZZZ-2026-0001");
3416 assert!("ZZZ-2026-0001".parse::<GovernanceLogId>().is_err());
3417 assert!(!GovernanceLogId::is_citation_shaped("ZZZ-2026-0001"));
3418 for junk in [
3419 "zzz-2026-0001",
3420 "ZZZZZ-2026-0001",
3421 "ZZ-2026-0001",
3422 "ZZZ-2026-1",
3423 ] {
3424 assert!(
3425 serde_json::from_value::<GovernanceLogId>(serde_json::json!(
3426 junk
3427 ))
3428 .is_err(),
3429 "{junk}"
3430 );
3431 }
3432 assert_eq!(
3433 GovernanceLogId::from_parts(GovernanceLogPrefix::Unknown, 2026, 1),
3434 None
3435 );
3436 for prefix in GovernanceLogPrefix::ALL {
3439 let want = if matches!(
3440 prefix,
3441 GovernanceLogPrefix::Data | GovernanceLogPrefix::Test
3442 ) {
3443 4
3444 } else {
3445 3
3446 };
3447 assert_eq!(prefix.as_str().len(), want, "{prefix}");
3448 }
3449 let series = GovernanceLogPrefix::ALL.map(|p| p.as_str()).join("|");
3451 assert!(
3452 GOVERNANCE_LOG_ID_PATTERN.contains(&format!("({series})")),
3453 "{GOVERNANCE_LOG_ID_PATTERN}"
3454 );
3455 assert!(
3456 CONTENT_REF_PATTERN.contains(&format!("({series})")),
3457 "{CONTENT_REF_PATTERN}"
3458 );
3459 assert_eq!(
3461 "GOV-2026-006".parse::<GovernanceLogId>().unwrap().as_str(),
3462 "GOV-2026-0006"
3463 );
3464 assert_eq!(
3465 "gov-2026-0006".parse::<GovernanceLogId>().unwrap().as_str(),
3466 "GOV-2026-0006"
3467 );
3468 for bad in [
3469 "",
3470 "GOV-26-0006",
3471 "MOD-2026-0006",
3472 "GOV-2026-0006-1",
3473 "GOV-202X-0006",
3474 "DAT-2026-0001",
3475 "DATAS-2026-0001",
3476 "DATA-2026-00001",
3477 "DATA-2026",
3478 "TES-2026-0001",
3479 "TESTS-2026-0001",
3480 "TEST-2026-00001",
3481 "3f1a0000-0000-0000-0000-000000000000",
3482 ] {
3483 assert!(
3484 bad.parse::<GovernanceLogId>().is_err(),
3485 "{bad:?} should not parse as a GovernanceLogId"
3486 );
3487 }
3488 }
3489
3490 #[test]
3494 fn governance_log_id_is_wire_compatible_with_a_bare_string() {
3495 let id: GovernanceLogId = "GOV-2026-0006".parse().unwrap();
3496 assert_eq!(serde_json::to_string(&id).unwrap(), "\"GOV-2026-0006\"");
3497 let back: GovernanceLogId =
3498 serde_json::from_str("\"GOV-2026-0006\"").unwrap();
3499 assert_eq!(back, id);
3500 assert!(serde_json::from_str::<GovernanceLogId>("\"nope\"").is_err());
3502 }
3503
3504 #[test]
3507 fn content_ref_round_trips_as_a_bare_string() {
3508 let uuid = Uuid::new_v4();
3509 let content = ContentRef::from(ContentId::from(uuid));
3510 assert_eq!(
3511 serde_json::to_value(&content).unwrap(),
3512 serde_json::json!(uuid.to_string())
3513 );
3514 assert_eq!(
3515 serde_json::from_value::<ContentRef>(serde_json::json!(
3516 uuid.to_string()
3517 ))
3518 .unwrap(),
3519 content
3520 );
3521
3522 let gov = ContentRef::Governance("APP-2026-0003".parse().unwrap());
3523 assert_eq!(
3524 serde_json::to_value(&gov).unwrap(),
3525 serde_json::json!("APP-2026-0003")
3526 );
3527 assert_eq!(
3528 serde_json::from_value::<ContentRef>(serde_json::json!(
3529 "APP-2026-0003"
3530 ))
3531 .unwrap(),
3532 gov
3533 );
3534
3535 assert!(gov.is_governance());
3536 assert!(!content.is_governance());
3537 assert_eq!(gov.kind_str(), "governance");
3538 assert_eq!(content.kind_str(), "content");
3539 assert_eq!(content.as_content(), Some(ContentId::from(uuid)));
3540 assert!(content.as_governance().is_none());
3541
3542 assert!("not-an-id".parse::<ContentRef>().is_err());
3544 assert!(
3545 serde_json::from_value::<ContentRef>(serde_json::json!(
3546 "not-an-id"
3547 ))
3548 .is_err()
3549 );
3550 }
3551
3552 #[test]
3554 fn every_readable_id_narrows_to_a_content_ref() {
3555 let uuid = Uuid::new_v4();
3556 for (label, got) in [
3557 ("PostId", ContentRef::from(PostId::from(uuid))),
3558 ("CommentId", ContentRef::from(CommentId::from(uuid))),
3559 ("ContentId", ContentRef::from(ContentId::from(uuid))),
3560 ] {
3561 assert_eq!(
3562 got,
3563 ContentRef::Content(ContentId::from(uuid)),
3564 "{label} -> ContentRef lost the uuid"
3565 );
3566 }
3567 let gov: GovernanceLogId = "GOV-2026-0006".parse().unwrap();
3568 assert_eq!(ContentRef::from(gov.clone()), ContentRef::Governance(gov));
3569 }
3570
3571 #[test]
3574 fn string_shaped_ids_round_trip_through_display() {
3575 let gov: GovernanceLogId = "GOV-2026-0006".parse().unwrap();
3576 assert_eq!(gov.to_string().parse::<GovernanceLogId>().unwrap(), gov);
3577
3578 let r = ContentRef::Governance(gov);
3579 assert_eq!(r.to_string().parse::<ContentRef>().unwrap(), r);
3580
3581 let r = ContentRef::Content(ContentId::new());
3582 assert_eq!(r.to_string().parse::<ContentRef>().unwrap(), r);
3583 }
3584
3585 #[test]
3586 fn post_or_comment_post_variant() {
3587 let inner = PostId::new();
3588 let tagged = PostOrCommentId::Post(inner);
3589 assert!(tagged.is_post());
3590 assert!(!tagged.is_comment());
3591 assert_eq!(tagged.as_post(), Some(inner));
3592 assert_eq!(tagged.as_comment(), None);
3593 assert_eq!(tagged.as_uuid(), *inner.as_uuid());
3594 assert_eq!(tagged.kind_str(), "post");
3595 }
3596
3597 #[test]
3598 fn post_or_comment_comment_variant() {
3599 let inner = CommentId::new();
3600 let tagged = PostOrCommentId::Comment(inner);
3601 assert!(tagged.is_comment());
3602 assert!(!tagged.is_post());
3603 assert_eq!(tagged.as_comment(), Some(inner));
3604 assert_eq!(tagged.as_post(), None);
3605 assert_eq!(tagged.as_uuid(), *inner.as_uuid());
3606 assert_eq!(tagged.kind_str(), "comment");
3607 }
3608
3609 #[test]
3610 fn post_or_comment_from_conversions() {
3611 let post = PostId::new();
3612 let comment = CommentId::new();
3613 let via_post: PostOrCommentId = post.into();
3614 let via_comment: PostOrCommentId = comment.into();
3615 assert_eq!(via_post, PostOrCommentId::Post(post));
3616 assert_eq!(via_comment, PostOrCommentId::Comment(comment));
3617 }
3618
3619 #[test]
3620 fn post_or_comment_display_is_kind_colon_uuid() {
3621 let post = PostId::new();
3622 let tagged = PostOrCommentId::Post(post);
3623 let rendered = tagged.to_string();
3624 assert!(rendered.starts_with("post:"));
3625 assert!(rendered.contains(&post.to_string()));
3626 }
3627
3628 const FULL: &str = "7ad26ccd-922f-484a-a37c-51777344a98c";
3631
3632 #[test]
3635 fn a_bad_id_fails_in_plain_words() {
3636 let bad = "7ad26ccd-922f-484a-a37c-51777344a";
3637 let want = format!(
3638 "not a valid PostId: expected a UUID like \"{FULL}\", got \"{bad}\""
3639 );
3640 assert_eq!(bad.parse::<PostId>().unwrap_err().to_string(), want);
3641 let err = serde_json::from_str::<PostId>(&format!("\"{bad}\""))
3642 .unwrap_err()
3643 .to_string();
3644 assert!(err.starts_with(&want), "{err}");
3645 assert!(!err.contains("group"), "{err}");
3646 let err = serde_json::from_str::<AgentId>("5")
3647 .unwrap_err()
3648 .to_string();
3649 assert!(err.contains("expected AgentId as a UUID string"), "{err}");
3650 let long = "x".repeat(500);
3652 let msg = long.parse::<CommentId>().unwrap_err().to_string();
3653 assert!(msg.len() < 200 && msg.ends_with("…\""), "{msg}");
3654 }
3655
3656 #[test]
3658 fn ids_still_round_trip() {
3659 let id: PostId = FULL.parse().unwrap();
3660 let json = serde_json::to_string(&id).unwrap();
3661 assert_eq!(serde_json::from_str::<PostId>(&json).unwrap(), id);
3662 let map: std::collections::HashMap<PostId, i64> =
3663 [(id, 3)].into_iter().collect();
3664 let json = serde_json::to_string(&map).unwrap();
3665 let back: std::collections::HashMap<PostId, i64> =
3666 serde_json::from_str(&json).unwrap();
3667 assert_eq!(back, map);
3668 }
3669
3670 fn target(s: &str) -> Result<ContentTarget, ContentTargetError> {
3671 s.parse()
3672 }
3673
3674 #[test]
3675 fn full_and_short_targets_parse() {
3676 let full = target(FULL).unwrap();
3677 assert_eq!(full.full().unwrap().to_string(), FULL);
3678 assert_eq!(full.to_string(), FULL);
3679 let short = target(" 7AD26CCD ").unwrap();
3680 assert!(short.full().is_none());
3681 assert_eq!(short.to_string(), "7ad26ccd");
3682 for variant in [
3684 FULL.replace('-', ""),
3685 FULL.to_uppercase(),
3686 FULL.replace('-', "\u{2011}"),
3687 ] {
3688 assert_eq!(target(&variant).unwrap(), full, "{variant}");
3689 }
3690 }
3691
3692 #[test]
3693 fn a_truncated_uuid_is_an_error_not_its_prefix() {
3694 let err = target("7ad26ccd-922f-484a-a37c-51777344a").unwrap_err();
3695 let msg = err.in_field("reply_to").to_string();
3696 assert!(
3697 msg.starts_with(
3698 "`reply_to` must be a post or comment id: a full UUID or its first 8 hex digits"
3699 ),
3700 "{msg}"
3701 );
3702 for internal in [
3703 "group",
3704 "UUID parsing",
3705 "invalid length",
3706 "invalid character",
3707 ] {
3708 assert!(!msg.contains(internal), "{internal} leaked: {msg}");
3709 }
3710 assert!(target("7ad26cc").is_err());
3711 assert!(target("7ad26ccd9").is_err());
3712 }
3713
3714 #[test]
3715 fn trailing_text_names_the_id_it_starts_with() {
3716 let msg = target(&format!("{FULL} (the reply above)"))
3717 .unwrap_err()
3718 .to_string();
3719 assert!(msg.contains(&format!("starts with the id {FULL}")), "{msg}");
3720 }
3721
3722 #[derive(Debug, serde::Deserialize)]
3723 struct Probe {
3724 #[serde(deserialize_with = "content_target::reply_to")]
3725 #[allow(dead_code)]
3726 reply_to: ContentTarget,
3727 }
3728
3729 #[test]
3730 fn target_errors_name_the_field_for_strings_and_other_types() {
3731 let err = serde_json::from_str::<Probe>(r#"{"reply_to": "nope"}"#)
3732 .unwrap_err();
3733 assert!(
3734 err.to_string()
3735 .starts_with("`reply_to` must be a post or comment id"),
3736 "{err}"
3737 );
3738 let err =
3739 serde_json::from_str::<Probe>(r#"{"reply_to": 5}"#).unwrap_err();
3740 assert!(
3741 err.to_string()
3742 .contains("expected `reply_to` to be a post or comment id"),
3743 "{err}"
3744 );
3745 }
3746
3747 #[cfg(feature = "schemars")]
3748 #[test]
3749 fn target_schema_is_inline_and_admits_both_forms() {
3750 let schema = schemars::schema_for!(ContentTarget);
3751 let v = schema.as_value();
3752 assert!(v.get("$ref").is_none() && v.get("$defs").is_none(), "{v}");
3753 assert!(v.get("format").is_none(), "a short id is not format: uuid");
3754 assert_eq!(v["pattern"], CONTENT_TARGET_PATTERN);
3755 }
3756}