feat: add media URLs to <entry> nodes (#1202)

Nickersoft · web-flow · commit 04c2307b005f · 2025-04-24T19:35:34.000-04:00
diff --git a/lib/src/format/json/pronunciation.rs b/lib/src/format/json/pronunciation.rs
@@ -12,5 +12,5 @@ pub struct PronunciationJSON {
     pub value: String,
 
     #[serde(skip_serializing_if = "Vec::is_empty")]
-    pub urls: Vec<MediaURLJSON>,
+    pub media: Vec<MediaURLJSON>,
 }
diff --git a/lib/src/format/md/pronunciation.rs b/lib/src/format/md/pronunciation.rs
@@ -19,9 +19,9 @@ pub fn write_pronunciation(
     lines.push(pron_text);
 
     // Add URLs as markdown links if they exist
-    if !pronunciation.urls.is_empty() {
+    if !pronunciation.media.is_empty() {
         let url_lines: Vec<String> = pronunciation
-            .urls
+            .media
             .iter()
             .map(|url| {
                 let desc = url.description.as_deref().unwrap_or("Audio");
diff --git a/lib/src/format/sql/pronunciations.rs b/lib/src/format/sql/pronunciations.rs
@@ -108,7 +108,7 @@ pub fn insert_pronunciation(
     );
 
     // Insert any URLs
-    for url in &pronunciation.urls {
+    for url in &pronunciation.media {
         let url_id = ID::default();
 
         builder.add_insert(
diff --git a/lib/src/models/entry.rs b/lib/src/models/entry.rs
@@ -2,7 +2,7 @@ use rkyv::{deserialize, to_bytes};
 
 use crate::{error::Error, serializable, Etymology};
 
-use super::EntryRef;
+use super::{EntryRef, MediaURL};
 
 serializable! {
   #[serde(rename = "entry")]
@@ -16,6 +16,9 @@ serializable! {
 
     #[serde(default, rename = "ety")]
     pub etymologies: Vec<Etymology>,
+
+    #[serde(default, rename = "media")]
+    pub media: Vec<MediaURL>,
   }
 }
 
diff --git a/lib/src/models/pronunciation.rs b/lib/src/models/pronunciation.rs
@@ -11,6 +11,6 @@ serializable! {
 
     #[serde(default, rename = "url")]
     #[serde(skip_serializing_if = "Vec::is_empty")]
-    pub urls: Vec<MediaURL>,
+    pub media: Vec<MediaURL>,
   }
 }
diff --git a/lib/tests/merge.rs b/lib/tests/merge.rs
@@ -13,6 +13,7 @@ mod merge_tests {
             name: None,
             entries: hash_map! {
               String::from("dog") => Entry {
+                media: vec![],
                 term: "dog".to_string(),
                 see_also: None,
                 etymologies: vec![
@@ -51,6 +52,7 @@ mod merge_tests {
             entries: hash_map! {
               "cat".to_string()=>
               Entry {
+                  media: vec![],
                   see_also: None,
                   term: "cat".to_string(),
                   etymologies: vec![Etymology {
@@ -88,6 +90,7 @@ mod merge_tests {
             entries: hash_map! {
               "dog".to_string() => Entry {
                   see_also: None,
+                  media: vec![],
                   term: "dog".to_string(),
                   etymologies: vec![Etymology {
                     id: None,
@@ -117,6 +120,7 @@ mod merge_tests {
               },
               "cat".to_string() => Entry {
                   see_also: None,
+                  media: vec![],
                   term: "cat".to_string(),
                   etymologies: vec![Etymology {
                     id: None,
diff --git a/lib/tests/pronunciation.rs b/lib/tests/pronunciation.rs
@@ -57,10 +57,10 @@ mod pronunciation_tests {
         let pronunciation = &entry.etymologies[0].pronunciations[0];
         assert!(matches!(pronunciation.kind, PronunciationKind::Pinyin));
         assert_eq!(pronunciation.value, "ni hao");
-        assert_eq!(pronunciation.urls.len(), 1);
-        assert_eq!(pronunciation.urls[0].src, "./audio.mp3");
+        assert_eq!(pronunciation.media.len(), 1);
+        assert_eq!(pronunciation.media[0].src, "./audio.mp3");
         assert_eq!(
-            pronunciation.urls[0].mime_type,
+            pronunciation.media[0].mime_type,
             Some("audio/mpeg".to_string())
         );
     }
@@ -81,8 +81,8 @@ mod pronunciation_tests {
         let pronunciation = &example.pronunciations[0];
         assert!(matches!(pronunciation.kind, PronunciationKind::IPA));
         assert_eq!(pronunciation.value, "həˈləʊ wɜːld");
-        assert_eq!(pronunciation.urls.len(), 1);
-        assert_eq!(pronunciation.urls[0].src, "./hello.mp3");
+        assert_eq!(pronunciation.media.len(), 1);
+        assert_eq!(pronunciation.media[0].src, "./hello.mp3");
     }
 
     #[test]
diff --git a/lib/tests/resolve.rs b/lib/tests/resolve.rs
@@ -15,6 +15,7 @@ mod resolve_tests {
             name: None,
             entries: hash_map! {
               String::from("dog") => Entry {
+                media: vec![],
                 term: "dog".to_string(),
                 see_also: None,
                 etymologies: vec![
diff --git a/lib/tests/tags.rs b/lib/tests/tags.rs
@@ -101,6 +101,7 @@ fn test_form_with_tags() {
 
     // Create an entry with the etymology
     let entry = Entry {
+        media: vec![],
         term: "word".to_string(),
         see_also: None,
         etymologies: vec![etymology],
diff --git a/lib/tests/translation.rs b/lib/tests/translation.rs
@@ -67,6 +67,7 @@ fn test_translation_in_entry() {
 
     // Create an entry with the etymology
     let entry = Entry {
+        media: vec![],
         term: "hello".to_string(),
         see_also: None,
         etymologies: vec![etymology],
diff --git a/node/index.d.ts b/node/index.d.ts
@@ -37,6 +37,7 @@ export interface Entry {
   term: string;
   seeAlso?: string;
   etymologies: Array<Etymology>;
+  media: Array<MediaURL>;
 }
 
 export interface Etymology {
@@ -106,7 +107,7 @@ export interface Note {
 export interface Pronunciation {
   kind: PronunciationKind;
   value: string;
-  urls: Array<MediaUrl>;
+  media: Array<MediaUrl>;
 }
 
 export declare const enum PronunciationKind {
diff --git a/node/src/types/entry.rs b/node/src/types/entry.rs
@@ -4,6 +4,7 @@ use structural_convert::StructuralConvert;
 use crate::utils::cast_error;
 
 use super::etymology::Etymology;
+use super::media_url::MediaURL;
 
 #[napi(object)]
 #[derive(StructuralConvert)]
@@ -12,6 +13,7 @@ pub struct Entry {
   pub term: String,
   pub see_also: Option<String>,
   pub etymologies: Vec<Etymology>,
+  pub media: Vec<MediaURL>,
 }
 
 pub fn from_archive(entry: &odict::ArchivedEntry) -> Result<Entry> {
diff --git a/node/src/types/pronunciation.rs b/node/src/types/pronunciation.rs
@@ -10,5 +10,5 @@ use super::pronunciation_kind::PronunciationKind;
 pub struct Pronunciation {
   pub kind: PronunciationKind,
   pub value: String,
-  pub urls: Vec<MediaURL>,
+  pub media: Vec<MediaURL>,
 }
diff --git a/node/tasks.toml b/node/tasks.toml
@@ -25,7 +25,7 @@ run = "pnpm --filter=\"@odict/node\" test -- "
 
 ["snapshot:node"]
 depends = ["setup:node", "build:node"]
-run = "pnpm --filter=\"@odict/node\" test -u -- "
+run = "pnpm --filter=\"@odict/node\" test -- -u "
 
 ["ci:node"]
 depends = ["setup:node"]
diff --git a/node/tests/__snapshots__/dictionary.spec.ts.snap b/node/tests/__snapshots__/dictionary.spec.ts.snap
@@ -44,6 +44,7 @@ exports[`Dictionary > can index and search a dictionary 1`] = `
         },
       },
     ],
+    "media": [],
     "term": "run",
   },
 ]
@@ -70,6 +71,7 @@ exports[`Dictionary > lookup > can split terms 1`] = `
           },
         },
       ],
+      "media": [],
       "term": "cat",
     },
   },
@@ -92,6 +94,7 @@ exports[`Dictionary > lookup > can split terms 1`] = `
           },
         },
       ],
+      "media": [],
       "term": "dog",
     },
   },
@@ -119,6 +122,7 @@ exports[`Dictionary > lookup > looks up terms properly 1`] = `
           },
         },
       ],
+      "media": [],
       "term": "cat",
     },
   },
@@ -149,6 +153,7 @@ exports[`Dictionary > should tokenize text and find entries 1`] = `
               },
             },
           ],
+          "media": [],
           "term": "你",
         },
       },
@@ -171,6 +176,7 @@ exports[`Dictionary > should tokenize text and find entries 1`] = `
               },
             },
           ],
+          "media": [],
           "term": "好",
         },
       },
@@ -211,6 +217,7 @@ exports[`Dictionary > should tokenize text and find entries 1`] = `
               },
             },
           ],
+          "media": [],
           "term": "你",
         },
       },
diff --git a/node/tests/pronunciation.spec.ts b/node/tests/pronunciation.spec.ts
@@ -27,8 +27,8 @@ describe("Pronunciation support", () => {
     expect(entry.etymologies[0].pronunciations.length).toBe(1);
     expect(entry.etymologies[0].pronunciations[0].kind).toBe(PronunciationKind.Pinyin);
     expect(entry.etymologies[0].pronunciations[0].value).toBe("ni hao");
-    expect(entry.etymologies[0].pronunciations[0].urls.length).toBe(1);
-    expect(entry.etymologies[0].pronunciations[0].urls[0].src).toBe("./audio.mp3");
+    expect(entry.etymologies[0].pronunciations[0].media.length).toBe(1);
+    expect(entry.etymologies[0].pronunciations[0].media[0].src).toBe("./audio.mp3");
   });
 
   it("should parse examples with pronunciations", async () => {
@@ -63,9 +63,9 @@ describe("Pronunciation support", () => {
     expect(example.pronunciations.length).toBe(1);
     expect(example.pronunciations[0].kind).toBe(PronunciationKind.IPA);
     expect(example.pronunciations[0].value).toBe("ɪɡˈzæmpl ˈsɛntəns");
-    expect(example.pronunciations[0].urls.length).toBe(1);
-    expect(example.pronunciations[0].urls[0].src).toBe("./example.mp3");
-    expect(example.pronunciations[0].urls[0].mimeType).toBe("audio/mpeg");
+    expect(example.pronunciations[0].media.length).toBe(1);
+    expect(example.pronunciations[0].media[0].src).toBe("./example.mp3");
+    expect(example.pronunciations[0].media[0].mimeType).toBe("audio/mpeg");
   });
 
   it("should handle multiple pronunciations for an entry", async () => {
diff --git a/python/src/types/entry.rs b/python/src/types/entry.rs
@@ -4,6 +4,7 @@ use structural_convert::StructuralConvert;
 use crate::utils::cast_error;
 
 use super::etymology::Etymology;
+use super::media_url::MediaURL;
 
 #[pyclass]
 #[derive(Debug, Clone, StructuralConvert)]
@@ -15,6 +16,8 @@ pub struct Entry {
     pub see_also: Option<String>,
     #[pyo3(get)]
     pub etymologies: Vec<Etymology>,
+    #[pyo3(get)]
+    pub media: Vec<MediaURL>,
 }
 
 #[pymethods]
diff --git a/python/src/types/pronunciation.rs b/python/src/types/pronunciation.rs
@@ -15,7 +15,7 @@ pub struct Pronunciation {
     pub value: String,
 
     #[pyo3(get)]
-    pub urls: Vec<MediaURL>,
+    pub media: Vec<MediaURL>,
 }
 
 #[pymethods]
@@ -25,25 +25,25 @@ impl Pronunciation {
         Self {
             kind: PronunciationKind::new(kind),
             value,
-            urls: Vec::new(),
+            media: Vec::new(),
         }
     }
 
-    pub fn add_url(&mut self, url: MediaURL) {
-        self.urls.push(url);
+    pub fn add_media(&mut self, url: MediaURL) {
+        self.media.push(url);
     }
 
     fn __repr__(&self) -> String {
         format!(
             "Pronunciation(kind='{}', value='{}', urls={})",
             self.kind,
             self.value,
-            if self.urls.is_empty() {
+            if self.media.is_empty() {
                 "[]".to_string()
             } else {
                 format!(
                     "[{}]",
-                    self.urls
+                    self.media
                         .iter()
                         .map(|url| url.to_string())
                         .collect::<Vec<_>>()
diff --git a/python/tests/__snapshots__/test_lookup.ambr b/python/tests/__snapshots__/test_lookup.ambr
@@ -1,26 +1,26 @@
 # serializer version: 1
 # name: test_index_and_search
   list([
-    Entry { term: "run", see_also: None, etymologies: [Etymology { id: None, pronunciations: [], description: Some("Latin root"), senses: [("n", Sense { pos: "n", lemma: None, definitions: [Left(Definition { id: None, value: "(vertebrates) To move swiftly", examples: [Example { value: "The dog runs after the cat.", translations: [], pronunciations: [] }, Example { value: "The horse ran away.", translations: [], pronunciations: [] }], notes: [] }), Left(Definition { id: None, value: "Act or instance of hurrying (to or from a place) (not necessarily by foot); dash or errand, trip.", examples: [], notes: [] }), Left(Definition { id: None, value: "A pleasure trip.", examples: [], notes: [] }), Left(Definition { id: None, value: "Flight, instance or period of fleeing.", examples: [], notes: [] }), Left(Definition { id: None, value: "Migration (of fish).", examples: [], notes: [] }), Left(Definition { id: None, value: "A group of fish that migrate, or ascend a river for the purpose of spawning.", examples: [], notes: [] })], tags: [], translations: [], forms: [] }), ("v", Sense { pos: "v", lemma: None, definitions: [Right(Group { id: None, description: "A number of verb senses", definitions: [Definition { id: None, value: "(vertebrates) To move swiftly (figuratively)", examples: [Example { value: "The dog runs after the cat.", translations: [], pronunciations: [] }, Example { value: "The horse ran away.", translations: [], pronunciations: [] }], notes: [] }, Definition { id: None, value: "(fluids) To flow.", examples: [], notes: [] }, Definition { id: None, value: "(nautical, of a vessel) To sail before the wind, in distinction from reaching or sailing close-hauled.", examples: [], notes: [] }, Definition { id: None, value: "(social) To carry out an activity.", examples: [], notes: [] }, Definition { id: None, value: "To extend or persist, statically or dynamically, through space or time.", examples: [], notes: [] }, Definition { id: None, value: "(transitive) To execute or carry out a plan, procedure or program.", examples: [], notes: [] }] })], tags: [], translations: [], forms: [] })] }] },
+    Entry { term: "run", see_also: None, etymologies: [Etymology { id: None, pronunciations: [], description: Some("Latin root"), senses: [("n", Sense { pos: "n", lemma: None, definitions: [Left(Definition { id: None, value: "(vertebrates) To move swiftly", examples: [Example { value: "The dog runs after the cat.", translations: [], pronunciations: [] }, Example { value: "The horse ran away.", translations: [], pronunciations: [] }], notes: [] }), Left(Definition { id: None, value: "Act or instance of hurrying (to or from a place) (not necessarily by foot); dash or errand, trip.", examples: [], notes: [] }), Left(Definition { id: None, value: "A pleasure trip.", examples: [], notes: [] }), Left(Definition { id: None, value: "Flight, instance or period of fleeing.", examples: [], notes: [] }), Left(Definition { id: None, value: "Migration (of fish).", examples: [], notes: [] }), Left(Definition { id: None, value: "A group of fish that migrate, or ascend a river for the purpose of spawning.", examples: [], notes: [] })], tags: [], translations: [], forms: [] }), ("v", Sense { pos: "v", lemma: None, definitions: [Right(Group { id: None, description: "A number of verb senses", definitions: [Definition { id: None, value: "(vertebrates) To move swiftly (figuratively)", examples: [Example { value: "The dog runs after the cat.", translations: [], pronunciations: [] }, Example { value: "The horse ran away.", translations: [], pronunciations: [] }], notes: [] }, Definition { id: None, value: "(fluids) To flow.", examples: [], notes: [] }, Definition { id: None, value: "(nautical, of a vessel) To sail before the wind, in distinction from reaching or sailing close-hauled.", examples: [], notes: [] }, Definition { id: None, value: "(social) To carry out an activity.", examples: [], notes: [] }, Definition { id: None, value: "To extend or persist, statically or dynamically, through space or time.", examples: [], notes: [] }, Definition { id: None, value: "(transitive) To execute or carry out a plan, procedure or program.", examples: [], notes: [] }] })], tags: [], translations: [], forms: [] })] }], media: [] },
   ])
 # ---
 # name: test_lookup
   list([
     LookupResult(
       directed_from=None,
-      entry=Entry { term: "cat", see_also: None, etymologies: [Etymology { id: None, pronunciations: [], description: Some("Latin root"), senses: [("n", Sense { pos: "n", lemma: None, definitions: [Left(Definition { id: None, value: "a cat", examples: [Example { value: "There goes a cat!", translations: [], pronunciations: [] }], notes: [Note { id: None, value: "Some definition note", examples: [Example { value: "Some example", translations: [], pronunciations: [] }] }] })], tags: [], translations: [], forms: [] })] }] },
+      entry=Entry { term: "cat", see_also: None, etymologies: [Etymology { id: None, pronunciations: [], description: Some("Latin root"), senses: [("n", Sense { pos: "n", lemma: None, definitions: [Left(Definition { id: None, value: "a cat", examples: [Example { value: "There goes a cat!", translations: [], pronunciations: [] }], notes: [Note { id: None, value: "Some definition note", examples: [Example { value: "Some example", translations: [], pronunciations: [] }] }] })], tags: [], translations: [], forms: [] })] }], media: [] },
     ),
   ])
 # ---
 # name: test_lookup_with_split
   list([
     LookupResult(
       directed_from=None,
-      entry=Entry { term: "cat", see_also: None, etymologies: [Etymology { id: None, pronunciations: [], description: Some("Latin root"), senses: [("n", Sense { pos: "n", lemma: None, definitions: [Left(Definition { id: None, value: "a cat", examples: [Example { value: "There goes a cat!", translations: [], pronunciations: [] }], notes: [Note { id: None, value: "Some definition note", examples: [Example { value: "Some example", translations: [], pronunciations: [] }] }] })], tags: [], translations: [], forms: [] })] }] },
+      entry=Entry { term: "cat", see_also: None, etymologies: [Etymology { id: None, pronunciations: [], description: Some("Latin root"), senses: [("n", Sense { pos: "n", lemma: None, definitions: [Left(Definition { id: None, value: "a cat", examples: [Example { value: "There goes a cat!", translations: [], pronunciations: [] }], notes: [Note { id: None, value: "Some definition note", examples: [Example { value: "Some example", translations: [], pronunciations: [] }] }] })], tags: [], translations: [], forms: [] })] }], media: [] },
     ),
     LookupResult(
       directed_from=None,
-      entry=Entry { term: "dog", see_also: None, etymologies: [Etymology { id: None, pronunciations: [], description: Some("Latin root"), senses: [("un", Sense { pos: "un", lemma: None, definitions: [Left(Definition { id: None, value: "a dog", examples: [], notes: [] })], tags: [], translations: [], forms: [] })] }] },
+      entry=Entry { term: "dog", see_also: None, etymologies: [Etymology { id: None, pronunciations: [], description: Some("Latin root"), senses: [("un", Sense { pos: "un", lemma: None, definitions: [Left(Definition { id: None, value: "a dog", examples: [], notes: [] })], tags: [], translations: [], forms: [] })] }], media: [] },
     ),
   ])
 # ---
diff --git a/python/tests/__snapshots__/test_tokenize.ambr b/python/tests/__snapshots__/test_tokenize.ambr
diff --git a/python/tests/test_pronunciation.py b/python/tests/test_pronunciation.py

Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,5 @@ pub struct PronunciationJSON {`
`12`	`12`	`pub value: String,`
`13`	`13`
`14`	`14`	`#[serde(skip_serializing_if = "Vec::is_empty")]`
`15`		`- pub urls: Vec<MediaURLJSON>,`
	`15`	`+ pub media: Vec<MediaURLJSON>,`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ use rkyv::{deserialize, to_bytes};`
`2`	`2`
`3`	`3`	`use crate::{error::Error, serializable, Etymology};`
`4`	`4`
`5`		`-use super::EntryRef;`
	`5`	`+use super::{EntryRef, MediaURL};`
`6`	`6`
`7`	`7`	`serializable! {`
`8`	`8`	`#[serde(rename = "entry")]`
`@@ -16,6 +16,9 @@ serializable! {`
`16`	`16`
`17`	`17`	`#[serde(default, rename = "ety")]`
`18`	`18`	`pub etymologies: Vec<Etymology>,`
	`19`	`+`
	`20`	`+ #[serde(default, rename = "media")]`
	`21`	`+ pub media: Vec<MediaURL>,`
`19`	`22`	`}`
`20`	`23`	`}`
`21`	`24`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,6 @@ serializable! {`
`11`	`11`
`12`	`12`	`#[serde(default, rename = "url")]`
`13`	`13`	`#[serde(skip_serializing_if = "Vec::is_empty")]`
`14`		`- pub urls: Vec<MediaURL>,`
	`14`	`+ pub media: Vec<MediaURL>,`
`15`	`15`	`}`
`16`	`16`	`}`