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;

/// Parameters for the "canAddNotes" action.
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
pub struct CanAddNotesRequest {
    /// List of notes to check.
    pub notes: Vec<CanAddNotesEntry>,
}

#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CanAddNotesEntry {
    /// Name of the deck where the note will be added.
    pub deck_name: String,
    /// Name of the model inside the deck where the note will be added.
    pub model_name: String,
    /// Fields available in the note.
    #[serde(serialize_with = "crate::serialize::hashmap")]
    pub fields: HashMap<String, String>,
    /// The tags of the note.
    pub tags: Vec<String>,
}

impl AnkiRequest for CanAddNotesRequest {
    type Response = Vec<bool>;

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

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

    #[test]
    fn test_serialize() {
        let request = CanAddNotesRequest {
            notes: vec![
                CanAddNotesEntry {
                    deck_name: "Default".to_string(),
                    model_name: "Basic".to_string(),
                    fields: HashMap::from([
                        (
                            "Front".to_string(),
                            "Why do programmers prefer dark mode?".to_string(),
                        ),
                        (
                            "Back".to_string(),
                            "Because light attracts bugs".to_string(),
                        ),
                    ]),
                    tags: vec!["yomichan".to_string()],
                },
                CanAddNotesEntry {
                    deck_name: "Default".to_string(),
                    model_name: "Basic".to_string(),
                    fields: HashMap::from([
                        (
                            "Front".to_string(),
                            "What do you call a cat that writes code?".to_string(),
                        ),
                        ("Back".to_string(), "A purr-ogrammer".to_string()),
                    ]),
                    tags: vec!["yomichan".to_string()],
                },
            ],
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "notes": [
    {
      "deckName": "Default",
      "modelName": "Basic",
      "fields": {
        "Back": "Because light attracts bugs",
        "Front": "Why do programmers prefer dark mode?"
      },
      "tags": [
        "yomichan"
      ]
    },
    {
      "deckName": "Default",
      "modelName": "Basic",
      "fields": {
        "Back": "A purr-ogrammer",
        "Front": "What do you call a cat that writes code?"
      },
      "tags": [
        "yomichan"
      ]
    }
  ]
}"#
        );
    }

    #[test]
    fn test_deserialize() {
        let json = "[true, false]";
        let response: <CanAddNotesRequest as AnkiRequest>::Response =
            serde_json::from_str(json).unwrap();

        assert_eq!(response, vec![true, false]);
    }
}