ultimo 0.5.0

Modern Rust web framework with automatic TypeScript client generation
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

//! Golden-file test for derived TypeScript client generation.
//! Run with: cargo test -p ultimo --features client-gen --test client_gen

#![cfg(feature = "client-gen")]

use ultimo::rpc::{RpcMode, RpcRegistry, TS};

#[derive(serde::Serialize, serde::Deserialize, TS)]
struct CreateUserInput {
    name: String,
    email: String,
}

#[derive(serde::Serialize, serde::Deserialize, TS)]
struct User {
    id: u32,
    name: String,
    email: String,
    tags: Vec<String>,
    nickname: Option<String>,
}

#[test]
fn rest_client_has_derived_types_and_signatures() {
    let rpc = RpcRegistry::new_with_mode(RpcMode::Rest);
    rpc.mutation("createUser", |input: CreateUserInput| async move {
        Ok(User {
            id: 1,
            name: input.name,
            email: input.email,
            tags: vec![],
            nickname: None,
        })
    });

    let client = rpc.generate_typescript_client();

    // Signature uses the derived named types.
    assert!(
        client.contains("async createUser(params: CreateUserInput): Promise<User>"),
        "signature missing:\n{client}"
    );

    // Both interfaces are declared with their real shapes.
    assert!(
        client.contains("type CreateUserInput = "),
        "input decl missing:\n{client}"
    );
    assert!(
        client.contains("type User = "),
        "output decl missing:\n{client}"
    );
    assert!(client.contains("email: string"));
    assert!(client.contains("tags: Array<string>"));
    assert!(client.contains("nickname: string | null"));

    // No dangling/hardcoded interface.
    assert!(!client.contains("export interface User"));
}