feat(jsonrpc): generate OpenRPC definitions

Frando · link2xt · commit 5b435d11c724 · 2023-05-21T22:11:07.000Z
When running `cargo test` in the deltachat-jsonrpc folder, a new file `openrpc/openrpc.json` will be created with an [OpenRPC](https://spec.open-rpc.org/) definition. It can be copy-pasted into the [OpenRPC playground](https://playground.open-rpc.org/) and used to generate clients in other languages.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/deltachat-ffi/Cargo.toml b/deltachat-ffi/Cargo.toml
@@ -25,7 +25,7 @@ anyhow = "1"
 thiserror = "1"
 rand = "0.8"
 once_cell = "1.17.0"
-yerpc = { version = "0.4.4", features = ["anyhow_expose"] }
+yerpc = { version = "0.5.1", features = ["anyhow_expose"] }
 
 [features]
 default = ["vendored"]
diff --git a/deltachat-jsonrpc/Cargo.toml b/deltachat-jsonrpc/Cargo.toml
@@ -15,13 +15,14 @@ required-features = ["webserver"]
 anyhow = "1"
 deltachat = { path = ".." }
 num-traits = "0.2"
+schemars = "0.8.11"
 serde = { version = "1.0", features = ["derive"] }
 tempfile = "3.3.0"
 log = "0.4"
 async-channel = { version = "1.8.0" }
 futures = { version = "0.3.28" }
 serde_json = "1.0.96"
-yerpc = { version = "0.4.4", features = ["anyhow_expose"] }
+yerpc = { version = "0.5.1", features = ["anyhow_expose", "openrpc"] }
 typescript-type-def = { version = "0.5.5", features = ["json_value"] }
 tokio = { version = "1.28.0" }
 sanitize-filename = "0.4"
diff --git a/deltachat-jsonrpc/src/api/mod.rs b/deltachat-jsonrpc/src/api/mod.rs
@@ -144,7 +144,11 @@ impl CommandApi {
     }
 }
 
-#[rpc(all_positional, ts_outdir = "typescript/generated")]
+#[rpc(
+    all_positional,
+    ts_outdir = "typescript/generated",
+    openrpc_outdir = "openrpc"
+)]
 impl CommandApi {
     /// Test function.
     async fn sleep(&self, delay: f64) {
diff --git a/deltachat-jsonrpc/src/api/types/account.rs b/deltachat-jsonrpc/src/api/types/account.rs
@@ -6,7 +6,7 @@ use typescript_type_def::TypeDef;
 
 use super::color_int_to_hex_string;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(tag = "type")]
 pub enum Account {
     #[serde(rename_all = "camelCase")]
diff --git a/deltachat-jsonrpc/src/api/types/chat.rs b/deltachat-jsonrpc/src/api/types/chat.rs
@@ -13,7 +13,7 @@ use typescript_type_def::TypeDef;
 use super::color_int_to_hex_string;
 use super::contact::ContactObject;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct FullChat {
     id: u32,
@@ -121,7 +121,7 @@ impl FullChat {
 /// - can_send
 ///
 /// used when you only need the basic metadata of a chat like type, name, profile picture
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct BasicChat {
     id: u32,
@@ -166,7 +166,7 @@ impl BasicChat {
     }
 }
 
-#[derive(Clone, Serialize, Deserialize, TypeDef)]
+#[derive(Clone, Serialize, Deserialize, TypeDef, schemars::JsonSchema)]
 pub enum MuteDuration {
     NotMuted,
     Forever,
@@ -191,7 +191,7 @@ impl MuteDuration {
     }
 }
 
-#[derive(Clone, Serialize, Deserialize, TypeDef)]
+#[derive(Clone, Serialize, Deserialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "ChatVisibility")]
 pub enum JSONRPCChatVisibility {
     Normal,
diff --git a/deltachat-jsonrpc/src/api/types/chat_list.rs b/deltachat-jsonrpc/src/api/types/chat_list.rs
@@ -8,13 +8,16 @@ use deltachat::{
     chatlist::Chatlist,
 };
 use num_traits::cast::ToPrimitive;
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 use typescript_type_def::TypeDef;
 
 use super::color_int_to_hex_string;
 use super::message::MessageViewtype;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Deserialize, Serialize, TypeDef, schemars::JsonSchema)]
+pub struct ChatListEntry(pub u32, pub u32);
+
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(tag = "type")]
 pub enum ChatListItemFetchResult {
     #[serde(rename_all = "camelCase")]
diff --git a/deltachat-jsonrpc/src/api/types/contact.rs b/deltachat-jsonrpc/src/api/types/contact.rs
@@ -6,7 +6,7 @@ use typescript_type_def::TypeDef;
 
 use super::color_int_to_hex_string;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "Contact", rename_all = "camelCase")]
 pub struct ContactObject {
     address: String,
diff --git a/deltachat-jsonrpc/src/api/types/events.rs b/deltachat-jsonrpc/src/api/types/events.rs
@@ -2,7 +2,7 @@ use deltachat::{Event as CoreEvent, EventType as CoreEventType};
 use serde::Serialize;
 use typescript_type_def::TypeDef;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct Event {
     /// Event payload.
@@ -21,7 +21,7 @@ impl From<CoreEvent> for Event {
     }
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(tag = "type")]
 pub enum EventType {
     /// The library-user may write an informational string to the log.
diff --git a/deltachat-jsonrpc/src/api/types/http.rs b/deltachat-jsonrpc/src/api/types/http.rs
@@ -2,7 +2,7 @@ use deltachat::net::HttpResponse as CoreHttpResponse;
 use serde::Serialize;
 use typescript_type_def::TypeDef;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 pub struct HttpResponse {
     /// base64-encoded response body.
     blob: String,
diff --git a/deltachat-jsonrpc/src/api/types/location.rs b/deltachat-jsonrpc/src/api/types/location.rs
@@ -2,7 +2,7 @@ use deltachat::location::Location;
 use serde::Serialize;
 use typescript_type_def::TypeDef;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "Location", rename_all = "camelCase")]
 pub struct JsonrpcLocation {
     pub location_id: u32,
diff --git a/deltachat-jsonrpc/src/api/types/message.rs b/deltachat-jsonrpc/src/api/types/message.rs
@@ -10,23 +10,22 @@ use deltachat::message::MsgId;
 use deltachat::message::Viewtype;
 use deltachat::reaction::get_msg_reactions;
 use num_traits::cast::ToPrimitive;
-use serde::Deserialize;
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 use typescript_type_def::TypeDef;
 
 use super::color_int_to_hex_string;
 use super::contact::ContactObject;
 use super::reactions::JSONRPCReactions;
 use super::webxdc::WebxdcMessageInfo;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase", tag = "variant")]
 pub enum MessageLoadResult {
     Message(MessageObject),
     LoadingError { error: String },
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "Message", rename_all = "camelCase")]
 pub struct MessageObject {
     id: u32,
@@ -86,7 +85,7 @@ pub struct MessageObject {
     reactions: Option<JSONRPCReactions>,
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(tag = "kind")]
 enum MessageQuote {
     JustText {
@@ -238,7 +237,7 @@ impl MessageObject {
     }
 }
 
-#[derive(Serialize, Deserialize, TypeDef)]
+#[derive(Serialize, Deserialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "Viewtype")]
 pub enum MessageViewtype {
     Unknown,
@@ -314,7 +313,7 @@ impl From<MessageViewtype> for Viewtype {
     }
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 pub enum DownloadState {
     Done,
     Available,
@@ -333,7 +332,7 @@ impl From<download::DownloadState> for DownloadState {
     }
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 pub enum SystemMessageType {
     Unknown,
     GroupNameChanged,
@@ -388,7 +387,7 @@ impl From<deltachat::mimeparser::SystemMessage> for SystemMessageType {
     }
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct MessageNotificationInfo {
     id: u32,
@@ -446,7 +445,7 @@ impl MessageNotificationInfo {
     }
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct MessageSearchResult {
     id: u32,
@@ -507,7 +506,7 @@ impl MessageSearchResult {
     }
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase", rename = "MessageListItem", tag = "kind")]
 pub enum JSONRPCMessageListItem {
     Message {
@@ -533,7 +532,7 @@ impl From<ChatItem> for JSONRPCMessageListItem {
     }
 }
 
-#[derive(Deserialize, TypeDef)]
+#[derive(Deserialize, Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct MessageData {
     pub text: Option<String>,
@@ -545,7 +544,7 @@ pub struct MessageData {
     pub quoted_message_id: Option<u32>,
 }
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct MessageReadReceipt {
     pub contact_id: u32,
diff --git a/deltachat-jsonrpc/src/api/types/provider_info.rs b/deltachat-jsonrpc/src/api/types/provider_info.rs
@@ -3,7 +3,7 @@ use num_traits::cast::ToPrimitive;
 use serde::Serialize;
 use typescript_type_def::TypeDef;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct ProviderInfo {
     pub before_login_hint: String,
diff --git a/deltachat-jsonrpc/src/api/types/qr.rs b/deltachat-jsonrpc/src/api/types/qr.rs
@@ -2,7 +2,7 @@ use deltachat::qr::Qr;
 use serde::Serialize;
 use typescript_type_def::TypeDef;
 
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "Qr", rename_all = "camelCase")]
 #[serde(tag = "type")]
 pub enum QrObject {
diff --git a/deltachat-jsonrpc/src/api/types/reactions.rs b/deltachat-jsonrpc/src/api/types/reactions.rs
@@ -6,7 +6,7 @@ use serde::Serialize;
 use typescript_type_def::TypeDef;
 
 /// A single reaction emoji.
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "Reaction", rename_all = "camelCase")]
 pub struct JSONRPCReaction {
     /// Emoji.
@@ -20,7 +20,7 @@ pub struct JSONRPCReaction {
 }
 
 /// Structure representing all reactions to a particular message.
-#[derive(Serialize, TypeDef)]
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "Reactions", rename_all = "camelCase")]
 pub struct JSONRPCReactions {
     /// Map from a contact to it's reaction to message.
diff --git a/deltachat-jsonrpc/src/api/types/webxdc.rs b/deltachat-jsonrpc/src/api/types/webxdc.rs
diff --git a/deltachat-rpc-server/Cargo.toml b/deltachat-rpc-server/Cargo.toml

Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,11 @@ impl CommandApi {`
`144`	`144`	`}`
`145`	`145`	`}`
`146`	`146`
`147`		`-#[rpc(all_positional, ts_outdir = "typescript/generated")]`
	`147`	`+#[rpc(`
	`148`	`+ all_positional,`
	`149`	`+ ts_outdir = "typescript/generated",`
	`150`	`+ openrpc_outdir = "openrpc"`
	`151`	`+)]`
`148`	`152`	`impl CommandApi {`
`149`	`153`	`/// Test function.`
`150`	`154`	`async fn sleep(&self, delay: f64) {`
Original file line number	Diff line number	Diff line change
`@@ -10,23 +10,22 @@ use deltachat::message::MsgId;`
`10`	`10`	`use deltachat::message::Viewtype;`
`11`	`11`	`use deltachat::reaction::get_msg_reactions;`
`12`	`12`	`use num_traits::cast::ToPrimitive;`
`13`		`-use serde::Deserialize;`
`14`		`-use serde::Serialize;`
	`13`	`+use serde::{Deserialize, Serialize};`
`15`	`14`	`use typescript_type_def::TypeDef;`
`16`	`15`
`17`	`16`	`use super::color_int_to_hex_string;`
`18`	`17`	`use super::contact::ContactObject;`
`19`	`18`	`use super::reactions::JSONRPCReactions;`
`20`	`19`	`use super::webxdc::WebxdcMessageInfo;`
`21`	`20`
`22`		`-#[derive(Serialize, TypeDef)]`
	`21`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`23`	`22`	`#[serde(rename_all = "camelCase", tag = "variant")]`
`24`	`23`	`pub enum MessageLoadResult {`
`25`	`24`	`Message(MessageObject),`
`26`	`25`	`LoadingError { error: String },`
`27`	`26`	`}`
`28`	`27`
`29`		`-#[derive(Serialize, TypeDef)]`
	`28`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`30`	`29`	`#[serde(rename = "Message", rename_all = "camelCase")]`
`31`	`30`	`pub struct MessageObject {`
`32`	`31`	`id: u32,`
`@@ -86,7 +85,7 @@ pub struct MessageObject {`
`86`	`85`	`reactions: Option<JSONRPCReactions>,`
`87`	`86`	`}`
`88`	`87`
`89`		`-#[derive(Serialize, TypeDef)]`
	`88`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`90`	`89`	`#[serde(tag = "kind")]`
`91`	`90`	`enum MessageQuote {`
`92`	`91`	`JustText {`
`@@ -238,7 +237,7 @@ impl MessageObject {`
`238`	`237`	`}`
`239`	`238`	`}`
`240`	`239`
`241`		`-#[derive(Serialize, Deserialize, TypeDef)]`
	`240`	`+#[derive(Serialize, Deserialize, TypeDef, schemars::JsonSchema)]`
`242`	`241`	`#[serde(rename = "Viewtype")]`
`243`	`242`	`pub enum MessageViewtype {`
`244`	`243`	`Unknown,`
`@@ -314,7 +313,7 @@ impl From<MessageViewtype> for Viewtype {`
`314`	`313`	`}`
`315`	`314`	`}`
`316`	`315`
`317`		`-#[derive(Serialize, TypeDef)]`
	`316`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`318`	`317`	`pub enum DownloadState {`
`319`	`318`	`Done,`
`320`	`319`	`Available,`
`@@ -333,7 +332,7 @@ impl From<download::DownloadState> for DownloadState {`
`333`	`332`	`}`
`334`	`333`	`}`
`335`	`334`
`336`		`-#[derive(Serialize, TypeDef)]`
	`335`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`337`	`336`	`pub enum SystemMessageType {`
`338`	`337`	`Unknown,`
`339`	`338`	`GroupNameChanged,`
`@@ -388,7 +387,7 @@ impl From<deltachat::mimeparser::SystemMessage> for SystemMessageType {`
`388`	`387`	`}`
`389`	`388`	`}`
`390`	`389`
`391`		`-#[derive(Serialize, TypeDef)]`
	`390`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`392`	`391`	`#[serde(rename_all = "camelCase")]`
`393`	`392`	`pub struct MessageNotificationInfo {`
`394`	`393`	`id: u32,`
`@@ -446,7 +445,7 @@ impl MessageNotificationInfo {`
`446`	`445`	`}`
`447`	`446`	`}`
`448`	`447`
`449`		`-#[derive(Serialize, TypeDef)]`
	`448`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`450`	`449`	`#[serde(rename_all = "camelCase")]`
`451`	`450`	`pub struct MessageSearchResult {`
`452`	`451`	`id: u32,`
`@@ -507,7 +506,7 @@ impl MessageSearchResult {`
`507`	`506`	`}`
`508`	`507`	`}`
`509`	`508`
`510`		`-#[derive(Serialize, TypeDef)]`
	`509`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`511`	`510`	`#[serde(rename_all = "camelCase", rename = "MessageListItem", tag = "kind")]`
`512`	`511`	`pub enum JSONRPCMessageListItem {`
`513`	`512`	`Message {`
`@@ -533,7 +532,7 @@ impl From<ChatItem> for JSONRPCMessageListItem {`
`533`	`532`	`}`
`534`	`533`	`}`
`535`	`534`
`536`		`-#[derive(Deserialize, TypeDef)]`
	`535`	`+#[derive(Deserialize, Serialize, TypeDef, schemars::JsonSchema)]`
`537`	`536`	`#[serde(rename_all = "camelCase")]`
`538`	`537`	`pub struct MessageData {`
`539`	`538`	`pub text: Option<String>,`
`@@ -545,7 +544,7 @@ pub struct MessageData {`
`545`	`544`	`pub quoted_message_id: Option<u32>,`
`546`	`545`	`}`
`547`	`546`
`548`		`-#[derive(Serialize, TypeDef)]`
	`547`	`+#[derive(Serialize, TypeDef, schemars::JsonSchema)]`
`549`	`548`	`#[serde(rename_all = "camelCase")]`
`550`	`549`	`pub struct MessageReadReceipt {`
`551`	`550`	`pub contact_id: u32,`