anki_bridge 0.10.2

/*
* The MIT License (MIT)
*
* Copyright (c) 2025 Daniél Kerkmann <daniel@kerkmann.dev>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
use serde::Serialize;
use std::collections::HashMap;

use crate::AnkiRequest;
use crate::entities::NoteId;

/// Parameters for the "updateNote" action.
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
pub struct UpdateNoteRequest {
    /// The note to update.
    pub note: UpdateNoteEntry,
}

#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
pub struct UpdateNoteEntry {
    /// ID of the note to update.
    ///
    /// A [CardId](crate::entities::CardId) can also be used.
    pub id: NoteId,
    /// New fields for the note. Leave empty to keep the old fields. Fields that are not already
    /// part of the note will not be added.
    #[serde(serialize_with = "crate::serialize::hashmap")]
    pub fields: HashMap<String, String>,
    /// New tags for the note. Leave as `None` to keep the old tags. An empty list will remove all
    /// tags from the note.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tags: Option<Vec<String>>,
}

impl AnkiRequest for UpdateNoteRequest {
    type Response = ();

    const ACTION: &'static str = "updateNote";
    const VERSION: u8 = 6;
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_serialize() {
        let request = UpdateNoteRequest {
            note: UpdateNoteEntry {
                id: 1514547547030,
                fields: HashMap::from([
                    ("Front".to_string(), "new front content".to_string()),
                    ("Back".to_string(), "new back content".to_string()),
                ]),
                tags: Some(vec!["new".to_string(), "tags".to_string()]),
            },
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "note": {
    "id": 1514547547030,
    "fields": {
      "Back": "new back content",
      "Front": "new front content"
    },
    "tags": [
      "new",
      "tags"
    ]
  }
}"#
        );
    }

    #[test]
    fn test_serialize_no_fields() {
        let request = UpdateNoteRequest {
            note: UpdateNoteEntry {
                id: 1514547547030,
                fields: HashMap::new(),
                ..Default::default()
            },
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "note": {
    "id": 1514547547030,
    "fields": {}
  }
}"#
        );
    }

    #[test]
    fn test_serialize_no_tags() {
        let request = UpdateNoteRequest {
            note: UpdateNoteEntry {
                id: 1514547547030,
                tags: None,
                ..Default::default()
            },
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "note": {
    "id": 1514547547030,
    "fields": {}
  }
}"#
        );
    }
}