rs-plugin-common-interfaces 0.31.0

Common description for plugin creation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use std::collections::HashMap;

use crate::domain::Relations;
use crate::domain::book::Book;
use crate::domain::episode::Episode;
use crate::domain::media::Media;
use crate::domain::movie::Movie;
use crate::domain::person::Person;
use crate::domain::serie::Serie;
use crate::PluginCredential;
use crate::request::RsGroupDownload;
use crate::{domain::rs_ids::RsIds, request::RsRequest};
use serde::{Deserialize, Serialize};
use strum_macros::EnumString;

#[derive(
    Debug, Serialize, Deserialize, Clone, PartialEq, strum_macros::Display, EnumString, Default,
)]
#[serde(rename_all = "camelCase")]
#[strum(serialize_all = "camelCase")]
pub enum RsLookupSourceResult {
    Requests(Vec<RsRequest>),
    GroupRequest(Vec<RsGroupDownload>),
    NotFound,
    #[default]
    NotApplicable,
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupPerson {
    pub name: Option<String>,
    pub ids: Option<RsIds>,
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupSerie {
    pub name: Option<String>,
    pub ids: Option<RsIds>,
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupSerieSeason {
    pub name: Option<String>,
    pub ids: Option<RsIds>,
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupEpisode {
    pub name: Option<String>,
    pub ids: Option<RsIds>,

    pub season: u32,
    pub number: Option<u32>,
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupBook {
    pub name: Option<String>,
    pub ids: Option<RsIds>,
}
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupSong {
    pub title: Option<String>,
    pub author: Option<String>,
    pub album: Option<String>,
    pub ids: Option<RsIds>,
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupMedia {
    pub search: Option<String>,
    pub ids: Option<RsIds>,
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupMovie {
    pub name: Option<String>,
    pub ids: Option<RsIds>,
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, strum_macros::Display, EnumString)]
#[serde(rename_all = "camelCase")]
#[strum(serialize_all = "camelCase")]
pub enum RsLookupQuery {
    Book(RsLookupBook),
    Media(RsLookupMedia),
    Episode(RsLookupEpisode),
    Movie(RsLookupMovie),
    Person(RsLookupPerson),
    Serie(RsLookupSerie),
    SerieSeason(RsLookupSerieSeason),
    Song(RsLookupSong),
}

#[derive(
    Debug, Serialize, Deserialize, Clone, PartialEq, strum_macros::Display, EnumString, Default,
)]
#[serde(rename_all = "camelCase")]
#[strum(serialize_all = "camelCase")]
pub enum RsLookupMetadataResult {
    Book(Book),
    Media(Media),
    Episode(Episode),
    Movie(Movie),
    Person(Person),
    Serie(Serie),
    #[default]
    None,
}

#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupMetadataResults {
    pub results: Vec<RsLookupMetadataResultWrapper>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub next_page_key: Option<String>,
    
}

#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupMetadataResultWrapper {
    pub metadata: RsLookupMetadataResult,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub relations: Option<Relations>,
    
}

#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct RsLookupWrapper {
    pub query: RsLookupQuery,
    pub credential: Option<PluginCredential>,
    pub params: Option<HashMap<String, String>>,
}