anki_bridge 0.10.2

/*
* The MIT License (MIT)
*
* Copyright (c) 2023 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::{Deserialize, Serialize};

use crate::AnkiRequest;
use crate::entities::CardId;

/// Parameters for the Card Browser dialog.
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct GuiBrowseRequest {
    /// The search query for the Card Browser dialog.
    pub query: String,
    /// Specifies how the cards shown in the _Card Browser_ should be reordered.
    pub reorder_cards: Option<GuiBrowseReorderCards>,
}

#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct GuiBrowseReorderCards {
    pub order: GuiBrowseReorderCardsOrder,
    pub column_id: String,
}

#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum GuiBrowseReorderCardsOrder {
    #[default]
    Ascending,
    Descending,
}

impl AnkiRequest for GuiBrowseRequest {
    type Response = Vec<CardId>;

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

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

    #[test]
    fn test_serialize() {
        let request = GuiBrowseRequest {
            query: "deck:current".to_string(),
            reorder_cards: Some(GuiBrowseReorderCards {
                order: GuiBrowseReorderCardsOrder::Descending,
                column_id: "noteCrt".to_string(),
            }),
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "query": "deck:current",
  "reorderCards": {
    "order": "descending",
    "columnId": "noteCrt"
  }
}"#
        );
    }

    #[test]
    fn test_deserialize() {
        let json = "[1494723142483, 1494703460437, 1494703479525]";
        let response: Vec<usize> = serde_json::from_str(json).unwrap();

        assert_eq!(response, vec![1494723142483, 1494703460437, 1494703479525]);
    }
}