#tauri-plugin #graphql #ipc #type-safe #graphql-schema #requests #javascript

tauri-plugin-graphql

A plugin for Tauri that enables type-safe IPC through GraphQL

10 releases (4 stable)

2.1.0 Jan 10, 2023
2.0.1 Sep 22, 2022
1.0.0 Jun 16, 2022
0.2.4 May 25, 2022
0.1.0 Mar 30, 2022

#1208 in Web programming

MIT license

71KB
343 lines

Tauri Plugin graphql

Crates.io Documentation MIT licensed

A plugin for Tauri that enables type-safe IPC through GraphQL.

Install

Rust

[dependencies]
tauri-plugin-graphql = "2.0.0"

JavaScript

The only client-side adapter currently is tauri-plugin-graphql-urql, a custom exchange for urql. If you need adapters for other GraphQL clients, open a PR!

Package Version (click for changelogs)
tauri-plugin-graphql-urql urql adapter version

Usage

You need to register the plugin giving it a async_graphql::Schema. This schema will be used to fulfill requests.

use async_graphql::{Schema, Object, EmptySubscription, EmptyMutation, Result as GraphQLResult, SimpleObject};

#[derive(SimpleObject, Debug, Clone)]
struct ListItem {
    id: i32,
    text: String
}

impl ListItem {
    pub fn new(text: String) -> Self {
        Self {
            id: rand::random::<i32>(),
            text
        }
    }
}

struct Query;

#[Object]
impl Query {
    async fn list(&self) -> GraphQLResult<Vec<ListItem>> {
        let item = vec![
            ListItem::new("foo".to_string()),
            ListItem::new("bar".to_string())
        ];

        Ok(item)
    }
}

fn main() {
    let schema = Schema::new(
        Query,
        EmptyMutation,
        EmptySubscription,
    );

    tauri::Builder::default()
        .plugin(tauri_plugin_graphql::init(schema))
        .run(tauri::generate_context!())
        .expect("failed to run app");
}

Contributing

If you want to help out, there are a few areas that need improvement:

  • Client Adapters - Currently, only a urql adapter exists; having adapters for more client libraries would be very nice.

PRs are welcome!

License

MIT © Jonas Kruckenberg

Dependencies

~25–67MB
~1M SLoC