kittycad 0.4.10

A fully generated & opinionated API client for the KittyCAD API.
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
#[cfg(not(feature = "js"))]
use futures::TryStreamExt;
use pretty_assertions::assert_eq;
use tokio_tungstenite::tungstenite::Message as WsMsg;

use crate::types::{ModelingCmd, PathSegment, Point3D, WebSocketRequest::ModelingCmdReq};

#[test]
fn test_mlcopilot_server_message_serde_roundtrip() {
    use pretty_assertions::assert_eq;
    use serde_json::json;

    use crate::types::{MlCopilotServerMessage, MlToolResult, ReasoningMessage};

    // Delta
    let msg = MlCopilotServerMessage::Delta {
        delta: "hello".to_string(),
    };
    let expected = json!({
        "delta": { "delta": "hello" }
    });
    let ser = serde_json::to_value(&msg).unwrap();
    assert_eq!(ser, expected);
    let de: MlCopilotServerMessage = serde_json::from_value(expected.clone()).unwrap();
    assert_eq!(de, msg);

    // Tool output (TextToCad)
    let msg = MlCopilotServerMessage::ToolOutput {
        result: MlToolResult::TextToCad {
            error: None,
            outputs: None,
            project_name: Some("proj".into()),
            status_code: 0,
        },
    };
    let expected = json!({
        "tool_output": {
            "result": {
                "type": "text_to_cad",
                "status_code": 0,
                "project_name": "proj"
            }
        }
    });
    let ser = serde_json::to_value(&msg).unwrap();
    assert_eq!(ser, expected);
    let de: MlCopilotServerMessage = serde_json::from_value(expected.clone()).unwrap();
    assert_eq!(de, msg);

    // Error
    let msg = MlCopilotServerMessage::Error {
        detail: "boom".into(),
    };
    let expected = json!({
        "error": { "detail": "boom" }
    });
    let ser = serde_json::to_value(&msg).unwrap();
    assert_eq!(ser, expected);
    let de: MlCopilotServerMessage = serde_json::from_value(expected.clone()).unwrap();
    assert_eq!(de, msg);

    // Info
    let msg = MlCopilotServerMessage::Info {
        text: "note".into(),
    };
    let expected = json!({
        "info": { "text": "note" }
    });
    let ser = serde_json::to_value(&msg).unwrap();
    assert_eq!(ser, expected);
    let de: MlCopilotServerMessage = serde_json::from_value(expected.clone()).unwrap();
    assert_eq!(de, msg);

    // Reasoning (text)
    let msg = MlCopilotServerMessage::Reasoning(ReasoningMessage::Text {
        content: "thinking".into(),
    });
    let expected = json!({
        "reasoning": { "type": "text", "content": "thinking" }
    });
    let ser = serde_json::to_value(&msg).unwrap();
    assert_eq!(ser, expected);
    let de: MlCopilotServerMessage = serde_json::from_value(expected.clone()).unwrap();
    assert_eq!(de, msg);

    // End of stream (with whole_response)
    let msg = MlCopilotServerMessage::EndOfStream {
        whole_response: Some("done".into()),
        started_at: None,
        completed_at: None,
        conversation_id: None,
        id: None,
    };
    let expected = json!({
        "end_of_stream": { "whole_response": "done" }
    });
    let ser = serde_json::to_value(&msg).unwrap();
    assert_eq!(ser, expected);
    let de: MlCopilotServerMessage = serde_json::from_value(expected).unwrap();
    assert_eq!(de, msg);
}

fn test_client(test_name: &str) -> Option<crate::Client> {
    let has_token = std::env::var("KITTYCAD_API_TOKEN")
        .ok()
        .filter(|token| !token.is_empty())
        .or_else(|| {
            std::env::var("ZOO_API_TOKEN")
                .ok()
                .filter(|token| !token.is_empty())
        })
        .is_some();

    if !has_token {
        eprintln!("skipping {test_name}: set KITTYCAD_API_TOKEN or ZOO_API_TOKEN");
        return None;
    }

    Some(crate::Client::new_from_env())
}

fn one_of_fixture() -> crate::types::AsyncApiCallOutput {
    serde_json::from_str(include_str!("../tests/one_of.json")).unwrap()
}

fn kittycad_coord_system() -> crate::types::System {
    crate::types::System {
        forward: crate::types::AxisDirectionPair {
            axis: crate::types::Axis::Y,
            direction: crate::types::Direction::Negative,
        },
        up: crate::types::AxisDirectionPair {
            axis: crate::types::Axis::Z,
            direction: crate::types::Direction::Positive,
        },
    }
}

async fn create_async_file_conversion(client: &crate::Client) -> crate::types::FileConversion {
    let body = include_bytes!("../../assets/in_obj.obj");
    let conversion_params = crate::types::ConversionParams {
        output_format: crate::types::OutputFormat3D::Step {
            coords: Some(kittycad_coord_system()),
            created: None,
            presentation: None,
            units: None,
        },
        src_format: crate::types::InputFormat3D::Obj {
            coords: kittycad_coord_system(),
            units: crate::types::UnitLength::Mm,
        },
    };

    let mut form = reqwest::multipart::Form::new();
    let mut json_part =
        reqwest::multipart::Part::text(serde_json::to_string(&conversion_params).unwrap());
    json_part = json_part.file_name("body.json");
    json_part = json_part.mime_str("application/json").unwrap();
    form = form.part("body", json_part);

    let mut file_part = reqwest::multipart::Part::bytes(body.to_vec());
    file_part = file_part.file_name("in_obj.obj");
    file_part = file_part.mime_str("application/octet-stream").unwrap();
    form = form.part("file", file_part);

    let response = client
        .client
        .request(
            http::Method::POST,
            format!("{}/{}", client.base_url, "file/conversion"),
        )
        .bearer_auth(&client.token)
        .header(reqwest::header::CACHE_CONTROL, "no-cache")
        .multipart(form)
        .send()
        .await
        .unwrap();

    let status = response.status();
    let text = response.text().await.unwrap_or_default();
    if !status.is_success() {
        panic!("create_async_file_conversion failed with status {status}: {text}");
    }

    serde_json::from_str(&text).unwrap()
}

#[cfg(not(feature = "js"))]
#[tokio::test]
async fn test_list_org_members_stream() {
    let Some(client) = test_client("test_list_org_members_stream") else {
        return;
    };

    let orgs = client.orgs();
    let mut stream = orgs.list_members_stream(None, None, None);

    let mut members: Vec<crate::types::OrgMember> = Default::default();
    loop {
        match stream.try_next().await {
            Ok(Some(item)) => {
                members.push(item);
            }
            Ok(None) => {
                break;
            }
            Err(err) => {
                panic!("{}", err);
            }
        }
    }

    assert!(!members.is_empty());
}

#[tokio::test]
async fn test_create_file_conversion() {
    let Some(client) = test_client("test_create_file_conversion") else {
        return;
    };
    let body = include_bytes!("../../assets/in_obj.obj");

    let conversion = client
        .file()
        .create_conversion(
            crate::types::FileExportFormat::Step,
            crate::types::FileImportFormat::Obj,
            &body.to_vec().into(),
        )
        .await
        .unwrap();

    assert!(conversion.outputs.is_some());
    assert!(!conversion.outputs.unwrap().is_empty());

    assert_eq!(conversion.src_format, crate::types::FileImportFormat::Obj);
    assert_eq!(conversion.status, crate::types::ApiCallStatus::Completed);
}

#[tokio::test]
async fn test_create_file_volume() {
    let Some(client) = test_client("test_create_file_volume") else {
        return;
    };
    let body = include_bytes!("../../assets/in_obj.obj");

    let result = client
        .file()
        .create_volume(
            Some(crate::types::UnitVolume::M3),
            crate::types::FileImportFormat::Obj,
            &body.to_vec().into(),
        )
        .await
        .unwrap();

    assert_eq!(result.volume.map(|x| (x * 1000000.0).round()), Some(0.0));

    assert_eq!(result.src_format, crate::types::FileImportFormat::Obj);
    assert_eq!(result.status, crate::types::ApiCallStatus::Completed);
}

#[tokio::test]
async fn test_get_status_of_async_operation() {
    let Some(client) = test_client("test_get_status_of_async_operation") else {
        return;
    };
    let conversion = create_async_file_conversion(&client).await;

    let result = client
        .api_calls()
        .get_async_operation(conversion.id)
        .await
        .unwrap();

    match result {
        crate::types::AsyncApiCallOutput::FileConversion { id, .. } => {
            assert_eq!(id, conversion.id);
        }
        other => panic!("expected file_conversion result, got {other:?}"),
    }
}

#[tokio::test]
async fn serialize_one_of() {
    let result = one_of_fixture();

    expectorate::assert_contents(
        "tests/one_of.json",
        &serde_json::to_string_pretty(&result).unwrap(),
    );
}

#[cfg(feature = "tabled")]
#[tokio::test]
async fn tabled_one_of() {
    let result = one_of_fixture();

    expectorate::assert_contents(
        "tests/tabled_one_of.txt",
        &tabled::Table::new(vec![result]).to_string(),
    );
}

#[tokio::test]
#[cfg(not(feature = "js"))]
async fn test_stream() {
    let Some(client) = test_client("test_stream") else {
        return;
    };

    let limit = 2;
    let api_calls = client.api_calls();
    let mut stream = api_calls.user_list_stream(Some(limit), None);

    let mut ids: Vec<String> = Default::default();
    loop {
        match stream.try_next().await {
            Ok(Some(item)) => {
                // Make sure we are not repeating items.
                if !ids.contains(&item.id.to_string()) {
                    ids.push(item.id.to_string());
                }
                if ids.len() > (limit * 20) as usize {
                    break;
                }
            }
            Ok(None) => {
                break;
            }
            Err(err) => panic!("{}", err),
        }
    }
}

#[test]
fn test_empty_phone_number() {
    let user_info = crate::types::UpdateUser {
        first_name: Some("John".to_string()),
        last_name: Some("Doe".to_string()),
        phone: Default::default(),
        company: Some("Example Company".to_string()),
        github: Some("@example-company".to_string()),
        discord: Some("@example-company".to_string()),
        image: "".to_string(),
        is_onboarded: Default::default(),
        username: None,
    };

    assert_eq!(
        serde_json::to_string_pretty(&user_info).unwrap(),
        r#"{
  "company": "Example Company",
  "discord": "@example-company",
  "first_name": "John",
  "github": "@example-company",
  "image": "",
  "last_name": "Doe"
}"#
    );

    let user_info_str = r#"{"first_name":"John","last_name":"Doe","company":"Example Company","github":"@example-company","discord":"@example-company","image": ""}"#;
    assert_eq!(
        serde_json::from_str::<crate::types::UpdateUser>(user_info_str).unwrap(),
        user_info
    );

    let billing_info = crate::types::BillingInfo {
        name: Some("John".to_string()),
        phone: Default::default(),
        address: None,
    };

    assert_eq!(
        serde_json::to_string_pretty(&billing_info).unwrap(),
        r#"{
  "name": "John"
}"#
    );

    let billing_info_str = r#"{"name":"John"}"#;
    assert_eq!(
        serde_json::from_str::<crate::types::BillingInfo>(billing_info_str).unwrap(),
        billing_info
    );
}

#[tokio::test]
async fn test_user_self() {
    let Some(client) = test_client("test_user_self") else {
        return;
    };

    let _result = client.users().get_self().await.unwrap();
}

#[tokio::test]
async fn test_modeling_websocket() {
    use futures::{SinkExt, StreamExt};
    use uuid::Uuid;

    let Some(client) = test_client("test_modeling_websocket") else {
        return;
    };

    let ws = match client
        .modeling()
        .commands_ws(crate::modeling::CommandsWsParams::default())
        .await
    {
        Ok((ws, _headers)) => ws,
        Err(crate::types::error::Error::UnexpectedResponse(resp)) => {
            let txt = resp.text().await.unwrap();
            panic!("Failed to connect to modeling websocket: {txt}");
        }
        err => panic!("Failed to connect to modeling websocket: {err:?}"),
    };
    let (mut write, mut read) = tokio_tungstenite::WebSocketStream::from_raw_socket(
        ws,
        tokio_tungstenite::tungstenite::protocol::Role::Client,
        None,
    )
    .await
    .split();

    // Start a path
    let path_id = Uuid::new_v4();
    write
        .send(WsMsg::Text(
            serde_json::to_string(&ModelingCmdReq {
                cmd: ModelingCmd::StartPath {},
                cmd_id: path_id,
            })
            .unwrap()
            .into(),
        ))
        .await
        .unwrap();

    // Draw the path in a triangle shape.
    let points = [
        Point3D {
            x: 1.0,
            y: 0.0,
            z: 0.0,
        },
        Point3D {
            x: 0.0,
            y: 1.0,
            z: 0.0,
        },
        Point3D {
            x: 0.0,
            y: 0.0,
            z: 0.0,
        },
    ];
    for point in points {
        write
            .send(WsMsg::Text(
                serde_json::to_string(&ModelingCmdReq {
                    cmd: ModelingCmd::ExtendPath {
                        path: path_id,
                        segment: PathSegment::Line {
                            end: point,
                            relative: false,
                        },
                        label: None,
                    },
                    cmd_id: Uuid::new_v4(),
                })
                .unwrap()
                .into(),
            ))
            .await
            .unwrap();
    }

    // Finish sending
    drop(write);

    // Get Websocket messages from API server
    let num_modeling_cmds = 1;
    let mut text_resps = 0;
    while let Some(msg) = read.next().await {
        match msg.unwrap() {
            WsMsg::Text(resp) => {
                eprintln!("Got a websocket response: {resp}");
                text_resps += 1;
                if text_resps == num_modeling_cmds {
                    break;
                }
            }
            // MDN says that when you're writing a Websocket server, "You might also get a pong
            // without ever sending a ping; ignore this if it happens."
            // See <https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#pings_and_pongs_the_heartbeat_of_websockets>
            WsMsg::Pong(_) => {}
            other => {
                panic!("Unexpected websocket message from server: {other}")
            }
        }
    }
}