use indexmap::IndexMap;
use serde::{Deserialize, Serialize};
use crate::{
errors::{Diagnostic, McdError, Result},
package::validate_internal_path,
};
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Manifest {
pub format: String,
pub version: String,
pub profile: McdProfile,
#[serde(default)]
pub conformance: Vec<ConformanceClaim>,
pub entrypoint: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub encoding: Option<String>,
#[serde(default)]
pub tables: Vec<TableManifestEntry>,
#[serde(default)]
pub images: Vec<ImageManifestEntry>,
#[serde(default)]
pub annotations: Vec<AnnotationManifestEntry>,
#[serde(default)]
pub assets: Vec<AssetManifestEntry>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub layout: Option<LayoutManifestEntry>,
}
impl Manifest {
pub fn from_slice(bytes: &[u8]) -> Result<Self> {
let manifest: Self = serde_json::from_slice(bytes)?;
manifest.validate_basic()?;
Ok(manifest)
}
pub fn validate_basic(&self) -> Result<()> {
if self.format != "MCD" {
return Err(McdError::from_diagnostic(
Diagnostic::error(
"manifest.format.unsupported",
"Manifest format must be MCD.",
)
.with_source("manifest.json"),
));
}
if self.version != "0.1" {
return Err(McdError::from_diagnostic(
Diagnostic::error(
"manifest.version.unsupported",
"Manifest version must be 0.1 for this alpha parser.",
)
.with_source("manifest.json"),
));
}
validate_manifest_path("manifest.entrypoint.invalid", &self.entrypoint)?;
let mut ids = std::collections::HashSet::new();
for table in &self.tables {
if table.id.trim().is_empty() {
return Err(McdError::from_diagnostic(
Diagnostic::error("manifest.table.id.empty", "Table id cannot be empty.")
.with_source("manifest.json"),
));
}
if !ids.insert(table.id.clone()) {
return Err(McdError::from_diagnostic(
Diagnostic::error(
"manifest.table.id.duplicate",
format!("Duplicate table id '{}'.", table.id),
)
.with_source("manifest.json"),
));
}
validate_manifest_path("manifest.table.data.invalid", &table.data)?;
validate_manifest_path("manifest.table.schema.invalid", &table.schema)?;
for path in table.views.values() {
validate_manifest_path("manifest.table.view.invalid", path)?;
}
}
let mut ids = std::collections::HashSet::new();
for image in &self.images {
if image.id.trim().is_empty() {
return Err(McdError::from_diagnostic(
Diagnostic::error("manifest.image.id.empty", "Image id cannot be empty.")
.with_source("manifest.json"),
));
}
if !ids.insert(image.id.clone()) {
return Err(McdError::from_diagnostic(
Diagnostic::error(
"manifest.image.id.duplicate",
format!("Duplicate image id '{}'.", image.id),
)
.with_source("manifest.json"),
));
}
validate_manifest_path("manifest.image.metadata.invalid", &image.metadata)?;
}
let mut ids = std::collections::HashSet::new();
for annotation in &self.annotations {
if annotation.id.trim().is_empty() {
return Err(McdError::from_diagnostic(
Diagnostic::error(
"manifest.annotation.id.empty",
"Annotation id cannot be empty.",
)
.with_source("manifest.json"),
));
}
if !ids.insert(annotation.id.clone()) {
return Err(McdError::from_diagnostic(
Diagnostic::error(
"manifest.annotation.id.duplicate",
format!("Duplicate annotation id '{}'.", annotation.id),
)
.with_source("manifest.json"),
));
}
validate_manifest_path("manifest.annotation.metadata.invalid", &annotation.metadata)?;
}
for asset in &self.assets {
validate_manifest_path("manifest.asset.path.invalid", &asset.path)?;
}
if let Some(layout) = &self.layout {
if let Some(styles) = &layout.styles {
validate_manifest_path("manifest.layout.styles.invalid", styles)?;
}
if let Some(page_map) = &layout.page_map {
validate_manifest_path("manifest.layout.page_map.invalid", page_map)?;
}
}
Ok(())
}
}
fn validate_manifest_path(code: &'static str, path: &str) -> Result<()> {
validate_internal_path(path).map(|_| ()).map_err(|_| {
McdError::from_diagnostic(
Diagnostic::error(code, format!("Invalid internal package path '{path}'."))
.with_source("manifest.json"),
)
})
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum McdProfile {
#[serde(rename = "MCD-Core")]
Core,
#[serde(rename = "MCD-Rendered")]
Rendered,
#[serde(rename = "MCD-Verified")]
Verified,
#[serde(rename = "MCD-Signed")]
Signed,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum ConformanceClaim {
#[serde(rename = "MCD-Core")]
Core,
#[serde(rename = "MCD-Images")]
Images,
#[serde(rename = "MCD-Charts")]
Charts,
#[serde(rename = "MCD-Strict")]
Strict,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct TableManifestEntry {
pub id: String,
pub data: String,
pub schema: String,
#[serde(default)]
pub views: IndexMap<String, String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ImageManifestEntry {
pub id: String,
pub metadata: String,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct AnnotationManifestEntry {
pub id: String,
pub metadata: String,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct AssetManifestEntry {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
pub path: String,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct LayoutManifestEntry {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub styles: Option<String>,
#[serde(default, rename = "pageMap", skip_serializing_if = "Option::is_none")]
pub page_map: Option<String>,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn parses_minimal_manifest() {
let manifest = Manifest::from_slice(
br#"{"format":"MCD","version":"0.1","profile":"MCD-Core","entrypoint":"content/main.md"}"#,
)
.expect("manifest parses");
assert_eq!(manifest.entrypoint, "content/main.md");
assert!(manifest.tables.is_empty());
}
#[test]
fn rejects_duplicate_table_ids() {
let err = Manifest::from_slice(
br#"{
"format":"MCD",
"version":"0.1",
"profile":"MCD-Core",
"entrypoint":"content/main.md",
"tables":[
{"id":"revenue","data":"tables/a.csv","schema":"tables/a.schema.json"},
{"id":"revenue","data":"tables/b.csv","schema":"tables/b.schema.json"}
]
}"#,
)
.expect_err("duplicate ids should fail");
assert_eq!(
err.diagnostic().map(|d| d.code.as_str()),
Some("manifest.table.id.duplicate")
);
}
}