zeal-sdk 1.0.5

Rust SDK for Zeal Integration Protocol (ZIP)
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
//! Orchestrator API for workflow management

use crate::errors::{Result, ZealError};
use crate::types::*;
use reqwest::Client;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ListWorkflowsParams {
    pub limit: Option<u32>,
    pub offset: Option<u32>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ListWorkflowsResponse {
    pub workflows: Vec<serde_json::Value>,
    pub total: u32,
    pub limit: u32,
    pub offset: u32,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WorkflowState {
    #[serde(rename = "workflowId")]
    pub workflow_id: String,
    #[serde(rename = "graphId")]
    pub graph_id: String,
    pub name: String,
    pub description: String,
    pub version: u32,
    pub state: WorkflowStateData,
    pub metadata: serde_json::Value,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WorkflowStateData {
    pub nodes: Vec<serde_json::Value>,
    pub connections: Vec<serde_json::Value>,
    pub groups: Vec<serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UpdateNodeRequest {
    #[serde(rename = "workflowId")]
    pub workflow_id: String,
    #[serde(rename = "graphId")]
    pub graph_id: Option<String>,
    pub properties: Option<HashMap<String, serde_json::Value>>,
    pub position: Option<Position>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UpdateNodeResponse {
    pub success: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeleteNodeResponse {
    pub success: bool,
    pub message: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConnectionResponse {
    #[serde(rename = "connectionId")]
    pub connection_id: String,
    pub connection: serde_json::Value,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateGroupRequest {
    #[serde(rename = "workflowId")]
    pub workflow_id: String,
    #[serde(rename = "graphId")]
    pub graph_id: Option<String>,
    pub title: String,
    #[serde(rename = "nodeIds")]
    pub node_ids: Vec<String>,
    pub color: Option<String>,
    pub description: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateGroupResponse {
    pub success: bool,
    #[serde(rename = "groupId")]
    pub group_id: String,
    pub group: serde_json::Value,
}

/// Orchestrator API for creating and managing workflows
pub struct OrchestratorAPI {
    base_url: String,
    client: Client,
}

impl OrchestratorAPI {
    /// Create a new Orchestrator API instance
    pub fn new(base_url: &str) -> Self {
        Self {
            base_url: base_url.to_string(),
            client: Client::new(),
        }
    }

    /// Create a new Orchestrator API instance with custom HTTP client
    pub fn with_client(base_url: &str, client: Client) -> Self {
        Self {
            base_url: base_url.to_string(),
            client,
        }
    }

    /// Create a new workflow
    pub async fn create_workflow(
        &self,
        request: CreateWorkflowRequest,
    ) -> Result<CreateWorkflowResponse> {
        let url = format!(
            "{}/api/zip/orchestrator/workflows",
            self.base_url.trim_end_matches('/')
        );

        let response = self
            .client
            .post(&url)
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to create workflow: {}", status),
                Some(error_text),
            ));
        }

        let workflow_response = response.json::<CreateWorkflowResponse>().await?;
        Ok(workflow_response)
    }

    /// List workflows
    pub async fn list_workflows(
        &self,
        params: Option<ListWorkflowsParams>,
    ) -> Result<ListWorkflowsResponse> {
        let mut url = format!(
            "{}/api/zip/orchestrator/workflows",
            self.base_url.trim_end_matches('/')
        );

        if let Some(params) = params {
            let mut query_params = Vec::new();
            if let Some(limit) = params.limit {
                query_params.push(format!("limit={}", limit));
            }
            if let Some(offset) = params.offset {
                query_params.push(format!("offset={}", offset));
            }
            if !query_params.is_empty() {
                url.push('?');
                url.push_str(&query_params.join("&"));
            }
        }

        let response = self.client.get(&url).send().await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to list workflows: {}", status),
                Some(error_text),
            ));
        }

        let workflows_response = response.json::<ListWorkflowsResponse>().await?;
        Ok(workflows_response)
    }

    /// Get workflow state
    pub async fn get_workflow_state(
        &self,
        workflow_id: &str,
        graph_id: Option<&str>,
    ) -> Result<WorkflowState> {
        let graph_id = graph_id.unwrap_or("main");
        let url = format!(
            "{}/api/zip/orchestrator/workflows/{}/state?graphId={}",
            self.base_url.trim_end_matches('/'),
            workflow_id,
            graph_id
        );

        let response = self.client.get(&url).send().await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to get workflow state: {}", status),
                Some(error_text),
            ));
        }

        let state = response.json::<WorkflowState>().await?;
        Ok(state)
    }

    /// Add a node to a workflow
    pub async fn add_node(&self, request: AddNodeRequest) -> Result<AddNodeResponse> {
        let url = format!(
            "{}/api/zip/orchestrator/nodes",
            self.base_url.trim_end_matches('/')
        );

        let response = self
            .client
            .post(&url)
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to add node: {}", status),
                Some(error_text),
            ));
        }

        let node_response = response.json::<AddNodeResponse>().await?;
        Ok(node_response)
    }

    /// Update node properties
    pub async fn update_node(
        &self,
        node_id: &str,
        updates: UpdateNodeRequest,
    ) -> Result<UpdateNodeResponse> {
        let url = format!(
            "{}/api/zip/orchestrator/nodes/{}",
            self.base_url.trim_end_matches('/'),
            node_id
        );

        let response = self
            .client
            .patch(&url)
            .header("Content-Type", "application/json")
            .json(&updates)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to update node: {}", status),
                Some(error_text),
            ));
        }

        let update_response = response.json::<UpdateNodeResponse>().await?;
        Ok(update_response)
    }

    /// Delete a node
    pub async fn delete_node(
        &self,
        node_id: &str,
        workflow_id: &str,
        graph_id: Option<&str>,
    ) -> Result<DeleteNodeResponse> {
        let graph_id = graph_id.unwrap_or("main");
        let url = format!(
            "{}/api/zip/orchestrator/nodes/{}?workflowId={}&graphId={}",
            self.base_url.trim_end_matches('/'),
            node_id,
            workflow_id,
            graph_id
        );

        let response = self.client.delete(&url).send().await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to delete node: {}", status),
                Some(error_text),
            ));
        }

        let delete_response = response.json::<DeleteNodeResponse>().await?;
        Ok(delete_response)
    }

    /// Connect two nodes
    pub async fn connect_nodes(&self, request: ConnectNodesRequest) -> Result<ConnectionResponse> {
        let url = format!(
            "{}/api/zip/orchestrator/connections",
            self.base_url.trim_end_matches('/')
        );

        let response = self
            .client
            .post(&url)
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to connect nodes: {}", status),
                Some(error_text),
            ));
        }

        let connection_response = response.json::<ConnectionResponse>().await?;
        Ok(connection_response)
    }

    /// Create a node group
    pub async fn create_group(&self, request: CreateGroupRequest) -> Result<CreateGroupResponse> {
        let url = format!(
            "{}/api/zip/orchestrator/groups",
            self.base_url.trim_end_matches('/')
        );

        let response = self
            .client
            .post(&url)
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to create group: {}", status),
                Some(error_text),
            ));
        }

        let group_response = response.json::<CreateGroupResponse>().await?;
        Ok(group_response)
    }

    /// Remove a connection between nodes
    pub async fn remove_connection(
        &self,
        request: RemoveConnectionRequest,
    ) -> Result<RemoveConnectionResponse> {
        let url = format!(
            "{}/api/zip/orchestrator/connections",
            self.base_url.trim_end_matches('/')
        );

        let response = self
            .client
            .delete(&url)
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to remove connection: {}", status),
                Some(error_text),
            ));
        }

        let remove_response = response.json::<RemoveConnectionResponse>().await?;
        Ok(remove_response)
    }

    /// Update group properties
    pub async fn update_group(&self, request: UpdateGroupRequest) -> Result<UpdateGroupResponse> {
        let url = format!(
            "{}/api/zip/orchestrator/groups",
            self.base_url.trim_end_matches('/')
        );

        let response = self
            .client
            .patch(&url)
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to update group: {}", status),
                Some(error_text),
            ));
        }

        let update_response = response.json::<UpdateGroupResponse>().await?;
        Ok(update_response)
    }

    /// Remove a group
    pub async fn remove_group(&self, request: RemoveGroupRequest) -> Result<RemoveGroupResponse> {
        let url = format!(
            "{}/api/zip/orchestrator/groups",
            self.base_url.trim_end_matches('/')
        );

        let response = self
            .client
            .delete(&url)
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(ZealError::api_error(
                status.as_u16(),
                format!("Failed to remove group: {}", status),
                Some(error_text),
            ));
        }

        let remove_response = response.json::<RemoveGroupResponse>().await?;
        Ok(remove_response)
    }
}