chore(workspace): Rust workspace R0 — builder image, core crate (JS-compatible JSON, report contracts, facade), wasm facade, core-wasm package with proofs
This commit is contained in:
1 parent
5fec0654d3
commit
2a38fa37b5
39 files changed
+1913
-1
No files matched your search
@@ -0,0 +1,9 @@
|
||||
//! Data contracts of the core.
|
||||
//!
|
||||
//! R0 carries the Report v3 reference types (sheet reference, zone, vertebra) to prove the
|
||||
//! serialisation rules against the current Zod schemas; the full contracts and the rules
|
||||
//! arrive at R2 (review Part VI.2).
|
||||
|
||||
pub mod report;
|
||||
|
||||
pub use report::{LateralSide, ReportZone, SheetRef, Unresolved, Vertebra};
|
||||
@@ -0,0 +1,137 @@
|
||||
//! Report v3 reference types (`packages/domain/src/report/v3.ts`), field order as the Zod
|
||||
//! schemas declare it. Optional fields are absent when unset and nullable fields are `null`
|
||||
//! (review I.2): the serde attributes below are the contract, not a convenience.
|
||||
|
||||
use serde::de::Error as _;
|
||||
use serde::{Deserialize, Deserializer, Serialize, Serializer};
|
||||
#[cfg(feature = "ts")]
|
||||
use ts_rs::TS;
|
||||
|
||||
/// Reference of the anatomical sheet a report was written against (`Report.sheet`).
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[cfg_attr(feature = "ts", derive(TS), ts(export))]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct SheetRef {
|
||||
pub sheet_id: String,
|
||||
/// Database version id once the sheet lives in the database; `null` for a bundled draft.
|
||||
pub version_id: Option<String>,
|
||||
/// sha256 of the document file the report was written against.
|
||||
pub document_sha256: String,
|
||||
}
|
||||
|
||||
/// Side of a bilateral zone.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[cfg_attr(feature = "ts", derive(TS), ts(export))]
|
||||
#[serde(rename_all = "lowercase")]
|
||||
pub enum LateralSide {
|
||||
Left,
|
||||
Right,
|
||||
}
|
||||
|
||||
/// One vertebra of a spine zone: the region code and the 1-based index in that region.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[cfg_attr(feature = "ts", derive(TS), ts(export))]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Vertebra {
|
||||
pub region: String,
|
||||
pub index: u32,
|
||||
}
|
||||
|
||||
/// A zone of an observation. Unknown keys are ignored on input, as the Zod schema strips
|
||||
/// them; optional fields are written only when set.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
|
||||
#[cfg_attr(feature = "ts", derive(TS), ts(export))]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ReportZone {
|
||||
pub annotation_id: String,
|
||||
pub view_id: String,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
#[cfg_attr(feature = "ts", ts(optional))]
|
||||
pub side: Option<LateralSide>,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
#[cfg_attr(feature = "ts", ts(optional))]
|
||||
pub vertebrae: Option<Vec<Vertebra>>,
|
||||
/// Annotation name at selection time (or legacy name at migration).
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
#[cfg_attr(feature = "ts", ts(optional))]
|
||||
pub label_fr_snapshot: Option<String>,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
#[cfg_attr(feature = "ts", ts(optional))]
|
||||
pub label_en_snapshot: Option<String>,
|
||||
/// Set by the migration when the legacy id has no canonical annotation.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
#[cfg_attr(feature = "ts", ts(optional, type = "true"))]
|
||||
pub unresolved: Option<Unresolved>,
|
||||
}
|
||||
|
||||
/// The literal `true` flag of a zone or finding the sheet cannot place
|
||||
/// (`z.literal(true).optional()` in Zod).
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
|
||||
pub struct Unresolved;
|
||||
|
||||
impl Serialize for Unresolved {
|
||||
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
|
||||
serializer.serialize_bool(true)
|
||||
}
|
||||
}
|
||||
|
||||
impl<'de> Deserialize<'de> for Unresolved {
|
||||
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
|
||||
if bool::deserialize(deserializer)? {
|
||||
Ok(Unresolved)
|
||||
} else {
|
||||
Err(D::Error::custom(
|
||||
"unresolved must be the literal true when present",
|
||||
))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::json::to_js_pretty;
|
||||
|
||||
#[test]
|
||||
fn optional_fields_are_absent_and_nullable_fields_are_null() {
|
||||
let zone = ReportZone {
|
||||
annotation_id: "hip".to_owned(),
|
||||
view_id: "main".to_owned(),
|
||||
..ReportZone::default()
|
||||
};
|
||||
let Ok(text) = to_js_pretty(&zone) else {
|
||||
panic!("serialisation failed");
|
||||
};
|
||||
assert_eq!(
|
||||
text,
|
||||
"{\n \"annotationId\": \"hip\",\n \"viewId\": \"main\"\n}"
|
||||
);
|
||||
|
||||
let sheet = SheetRef {
|
||||
sheet_id: "faunosteo-cheval".to_owned(),
|
||||
version_id: None,
|
||||
document_sha256: "0".repeat(64),
|
||||
};
|
||||
let Ok(text) = to_js_pretty(&sheet) else {
|
||||
panic!("serialisation failed");
|
||||
};
|
||||
assert!(text.contains("\"versionId\": null"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unresolved_accepts_true_only() {
|
||||
let parsed: Result<ReportZone, _> =
|
||||
serde_json::from_str(r#"{"annotationId":"a","viewId":"v","unresolved":true}"#);
|
||||
assert_eq!(parsed.ok().and_then(|z| z.unresolved), Some(Unresolved));
|
||||
let refused: Result<ReportZone, _> =
|
||||
serde_json::from_str(r#"{"annotationId":"a","viewId":"v","unresolved":false}"#);
|
||||
assert!(refused.is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unknown_keys_are_ignored_like_the_zod_strip_schema() {
|
||||
let parsed: Result<ReportZone, _> =
|
||||
serde_json::from_str(r#"{"annotationId":"a","viewId":"v","extra":1}"#);
|
||||
assert!(parsed.is_ok());
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user