turul-a2a-types 0.1.17

Ergonomic Rust types for the A2A Protocol v1.0
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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
use serde::{Deserialize, Serialize};
use turul_a2a_proto as pb;

use crate::artifact::Artifact;
use crate::error::A2aTypeError;
use crate::message::Message;

/// A2A task states — type-safe wrapper over proto TaskState.
///
/// Excludes `UNSPECIFIED` which is not a valid application state.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum TaskState {
    Submitted,
    Working,
    Completed,
    Failed,
    Canceled,
    InputRequired,
    Rejected,
    AuthRequired,
}

impl TaskState {
    /// Returns whether transitioning from `self` to `next` is valid per the A2A spec.
    pub fn can_transition_to(&self, next: TaskState) -> bool {
        crate::state_machine::validate_transition(*self, next).is_ok()
    }

    /// Returns `true` if this is a terminal state (no further transitions allowed).
    pub fn is_terminal(&self) -> bool {
        crate::state_machine::is_terminal(*self)
    }
}

impl TryFrom<pb::TaskState> for TaskState {
    type Error = A2aTypeError;

    fn try_from(value: pb::TaskState) -> Result<Self, Self::Error> {
        match value {
            pb::TaskState::Submitted => Ok(Self::Submitted),
            pb::TaskState::Working => Ok(Self::Working),
            pb::TaskState::Completed => Ok(Self::Completed),
            pb::TaskState::Failed => Ok(Self::Failed),
            pb::TaskState::Canceled => Ok(Self::Canceled),
            pb::TaskState::InputRequired => Ok(Self::InputRequired),
            pb::TaskState::Rejected => Ok(Self::Rejected),
            pb::TaskState::AuthRequired => Ok(Self::AuthRequired),
            pb::TaskState::Unspecified => Err(A2aTypeError::InvalidState),
        }
    }
}

impl From<TaskState> for pb::TaskState {
    fn from(value: TaskState) -> Self {
        match value {
            TaskState::Submitted => pb::TaskState::Submitted,
            TaskState::Working => pb::TaskState::Working,
            TaskState::Completed => pb::TaskState::Completed,
            TaskState::Failed => pb::TaskState::Failed,
            TaskState::Canceled => pb::TaskState::Canceled,
            TaskState::InputRequired => pb::TaskState::InputRequired,
            TaskState::Rejected => pb::TaskState::Rejected,
            TaskState::AuthRequired => pb::TaskState::AuthRequired,
        }
    }
}

impl TryFrom<i32> for TaskState {
    type Error = A2aTypeError;

    fn try_from(value: i32) -> Result<Self, Self::Error> {
        let proto_state = pb::TaskState::try_from(value).map_err(|_| A2aTypeError::InvalidState)?;
        Self::try_from(proto_state)
    }
}

/// Ergonomic wrapper over proto `TaskStatus`.
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct TaskStatus {
    pub(crate) inner: pb::TaskStatus,
}

impl TaskStatus {
    pub fn new(state: TaskState) -> Self {
        Self {
            inner: pb::TaskStatus {
                state: pb::TaskState::from(state).into(),
                message: None,
                timestamp: None,
            },
        }
    }

    pub fn with_message(mut self, message: Message) -> Self {
        self.inner.message = Some(message.into_proto());
        self
    }

    pub fn state(&self) -> Result<TaskState, A2aTypeError> {
        let proto_state =
            pb::TaskState::try_from(self.inner.state).map_err(|_| A2aTypeError::InvalidState)?;
        TaskState::try_from(proto_state)
    }

    pub fn as_proto(&self) -> &pb::TaskStatus {
        &self.inner
    }

    pub fn into_proto(self) -> pb::TaskStatus {
        self.inner
    }
}

impl TryFrom<pb::TaskStatus> for TaskStatus {
    type Error = A2aTypeError;

    fn try_from(inner: pb::TaskStatus) -> Result<Self, Self::Error> {
        // Validate state is not UNSPECIFIED
        let proto_state =
            pb::TaskState::try_from(inner.state).map_err(|_| A2aTypeError::InvalidState)?;
        if proto_state == pb::TaskState::Unspecified {
            return Err(A2aTypeError::InvalidState);
        }
        Ok(Self { inner })
    }
}

impl From<TaskStatus> for pb::TaskStatus {
    fn from(status: TaskStatus) -> Self {
        status.inner
    }
}

impl Serialize for TaskStatus {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        self.inner.serialize(serializer)
    }
}

impl<'de> Deserialize<'de> for TaskStatus {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let proto = pb::TaskStatus::deserialize(deserializer)?;
        TaskStatus::try_from(proto).map_err(serde::de::Error::custom)
    }
}

/// Ergonomic wrapper over proto `Task`.
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct Task {
    pub(crate) inner: pb::Task,
}

impl Task {
    pub fn new(id: impl Into<String>, status: TaskStatus) -> Self {
        Self {
            inner: pb::Task {
                id: id.into(),
                context_id: String::new(),
                status: Some(status.into_proto()),
                artifacts: vec![],
                history: vec![],
                metadata: None,
            },
        }
    }

    pub fn with_context_id(mut self, context_id: impl Into<String>) -> Self {
        self.inner.context_id = context_id.into();
        self
    }

    pub fn id(&self) -> &str {
        &self.inner.id
    }

    pub fn context_id(&self) -> &str {
        &self.inner.context_id
    }

    pub fn status(&self) -> Option<TaskStatus> {
        self.inner
            .status
            .clone()
            .and_then(|s| TaskStatus::try_from(s).ok())
    }

    pub fn history(&self) -> &[pb::Message] {
        &self.inner.history
    }

    pub fn artifacts(&self) -> &[pb::Artifact] {
        &self.inner.artifacts
    }

    pub fn append_message(&mut self, message: Message) {
        self.inner.history.push(message.into_proto());
    }

    pub fn append_artifact(&mut self, artifact: Artifact) {
        self.inner.artifacts.push(artifact.into_proto());
    }

    /// Merge an artifact using A2A streaming append semantics.
    ///
    /// - `append = true`: if an artifact with the same `artifactId` is
    ///   already on the task, extend its `parts` with the incoming parts
    ///   (same as a streaming-chunk continuation). Otherwise, append as
    ///   a new entry.
    /// - `append = false`: append unconditionally (new entry or caller
    ///   tolerates duplicate ids).
    ///
    /// The `last_chunk` flag is transport-only metadata
    /// — it is not persisted on the task. It is accepted here so callers
    /// can keep the signature symmetric with the streaming wire event
    /// payload and not drop the parameter separately.
    ///
    /// This mirrors the server storage append-artifact semantics so that
    /// in-memory task mutations and the storage layer converge on the
    /// same view. The storage trait lives in the server crate; this
    /// helper is the dependency-free equivalent for wrapper callers.
    pub fn merge_artifact(&mut self, artifact: Artifact, append: bool, _last_chunk: bool) {
        if append {
            let target_id = artifact.as_proto().artifact_id.clone();
            if let Some(existing) = self
                .inner
                .artifacts
                .iter_mut()
                .find(|a| a.artifact_id == target_id)
            {
                existing.parts.extend(artifact.into_proto().parts);
                return;
            }
        }
        self.append_artifact(artifact);
    }

    /// Set the task's status. This is the low-level escape hatch —
    /// prefer `complete()`, `fail()`, etc. for common transitions.
    pub fn set_status(&mut self, status: TaskStatus) {
        self.inner.status = Some(status.into_proto());
    }

    /// Mark the task as completed.
    pub fn complete(&mut self) {
        self.set_status(TaskStatus::new(TaskState::Completed));
    }

    /// Mark the task as failed with an optional message.
    pub fn fail(&mut self, message: impl Into<String>) {
        let msg = Message::new(
            uuid::Uuid::now_v7().to_string(),
            crate::Role::Agent,
            vec![crate::Part::text(message)],
        );
        self.set_status(TaskStatus::new(TaskState::Failed).with_message(msg));
    }

    /// Add a text artifact to the task.
    pub fn push_text_artifact(
        &mut self,
        artifact_id: impl Into<String>,
        name: impl Into<String>,
        text: impl Into<String>,
    ) {
        let artifact = Artifact::new(artifact_id, vec![crate::Part::text(text)]).with_name(name);
        self.append_artifact(artifact);
    }

    pub fn as_proto(&self) -> &pb::Task {
        &self.inner
    }

    pub fn as_proto_mut(&mut self) -> &mut pb::Task {
        &mut self.inner
    }

    pub fn into_proto(self) -> pb::Task {
        self.inner
    }
}

impl TryFrom<pb::Task> for Task {
    type Error = A2aTypeError;

    fn try_from(inner: pb::Task) -> Result<Self, Self::Error> {
        if inner.id.is_empty() {
            return Err(A2aTypeError::MissingField("id"));
        }
        // Status is REQUIRED per proto field_behavior
        let status = inner
            .status
            .as_ref()
            .ok_or(A2aTypeError::MissingField("status"))?;
        let proto_state =
            pb::TaskState::try_from(status.state).map_err(|_| A2aTypeError::InvalidState)?;
        if proto_state == pb::TaskState::Unspecified {
            return Err(A2aTypeError::InvalidState);
        }
        Ok(Self { inner })
    }
}

impl From<Task> for pb::Task {
    fn from(task: Task) -> Self {
        task.inner
    }
}

impl Serialize for Task {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        self.inner.serialize(serializer)
    }
}

impl<'de> Deserialize<'de> for Task {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let proto = pb::Task::deserialize(deserializer)?;
        Task::try_from(proto).map_err(serde::de::Error::custom)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::message::{Part, Role};

    #[test]
    fn try_from_proto_all_valid_states() {
        assert_eq!(
            TaskState::try_from(pb::TaskState::Submitted).unwrap(),
            TaskState::Submitted
        );
        assert_eq!(
            TaskState::try_from(pb::TaskState::Working).unwrap(),
            TaskState::Working
        );
        assert_eq!(
            TaskState::try_from(pb::TaskState::Completed).unwrap(),
            TaskState::Completed
        );
        assert_eq!(
            TaskState::try_from(pb::TaskState::Failed).unwrap(),
            TaskState::Failed
        );
        assert_eq!(
            TaskState::try_from(pb::TaskState::Canceled).unwrap(),
            TaskState::Canceled
        );
        assert_eq!(
            TaskState::try_from(pb::TaskState::InputRequired).unwrap(),
            TaskState::InputRequired
        );
        assert_eq!(
            TaskState::try_from(pb::TaskState::Rejected).unwrap(),
            TaskState::Rejected
        );
        assert_eq!(
            TaskState::try_from(pb::TaskState::AuthRequired).unwrap(),
            TaskState::AuthRequired
        );
    }

    #[test]
    fn try_from_proto_unspecified_is_error() {
        assert!(TaskState::try_from(pb::TaskState::Unspecified).is_err());
    }

    #[test]
    fn into_proto_round_trip() {
        for state in [
            TaskState::Submitted,
            TaskState::Working,
            TaskState::Completed,
            TaskState::Failed,
            TaskState::Canceled,
            TaskState::InputRequired,
            TaskState::Rejected,
            TaskState::AuthRequired,
        ] {
            let proto: pb::TaskState = state.into();
            let back = TaskState::try_from(proto).unwrap();
            assert_eq!(back, state);
        }
    }

    #[test]
    fn try_from_i32() {
        assert_eq!(TaskState::try_from(1i32).unwrap(), TaskState::Submitted);
        assert_eq!(TaskState::try_from(2i32).unwrap(), TaskState::Working);
        assert!(TaskState::try_from(0i32).is_err()); // UNSPECIFIED
        assert!(TaskState::try_from(99i32).is_err()); // unknown
    }

    #[test]
    fn can_transition_to_delegates_to_state_machine() {
        assert!(TaskState::Submitted.can_transition_to(TaskState::Working));
        assert!(!TaskState::Submitted.can_transition_to(TaskState::Completed));
        assert!(!TaskState::Completed.can_transition_to(TaskState::Working));
    }

    #[test]
    fn is_terminal_delegates() {
        assert!(!TaskState::Working.is_terminal());
        assert!(TaskState::Completed.is_terminal());
    }

    // TaskStatus tests

    #[test]
    fn task_status_constructor() {
        let status = TaskStatus::new(TaskState::Working);
        assert_eq!(status.state().unwrap(), TaskState::Working);
    }

    #[test]
    fn task_status_with_message() {
        let msg = crate::Message::new("s-msg", Role::Agent, vec![Part::text("working")]);
        let status = TaskStatus::new(TaskState::Working).with_message(msg);
        assert!(status.as_proto().message.is_some());
    }

    #[test]
    fn task_status_try_from_proto_rejects_unspecified() {
        let proto = pb::TaskStatus {
            state: pb::TaskState::Unspecified.into(),
            message: None,
            timestamp: None,
        };
        assert!(TaskStatus::try_from(proto).is_err());
    }

    #[test]
    fn task_status_serde_round_trip() {
        let status = TaskStatus::new(TaskState::Submitted);
        let json = serde_json::to_string(&status).unwrap();
        let back: TaskStatus = serde_json::from_str(&json).unwrap();
        assert_eq!(back.state().unwrap(), TaskState::Submitted);
    }

    // Task tests

    #[test]
    fn task_constructor() {
        let task = Task::new("t-1", TaskStatus::new(TaskState::Submitted)).with_context_id("ctx-1");
        assert_eq!(task.id(), "t-1");
        assert_eq!(task.context_id(), "ctx-1");
        assert_eq!(
            task.status().unwrap().state().unwrap(),
            TaskState::Submitted
        );
    }

    #[test]
    fn task_append_history_and_artifacts() {
        let mut task = Task::new("t-2", TaskStatus::new(TaskState::Working));
        task.append_message(crate::Message::new(
            "m-1",
            Role::User,
            vec![Part::text("hi")],
        ));
        task.append_artifact(crate::Artifact::new("a-1", vec![Part::text("result")]));
        assert_eq!(task.history().len(), 1);
        assert_eq!(task.artifacts().len(), 1);
    }

    #[test]
    fn task_merge_artifact_append_true_extends_existing_by_id() {
        let mut task = Task::new("t-merge-1", TaskStatus::new(TaskState::Working));
        task.append_artifact(crate::Artifact::new("a-1", vec![Part::text("chunk-1")]));

        task.merge_artifact(
            crate::Artifact::new("a-1", vec![Part::text("chunk-2")]),
            true,
            false,
        );

        assert_eq!(
            task.artifacts().len(),
            1,
            "same-id append must not duplicate"
        );
        assert_eq!(task.artifacts()[0].parts.len(), 2);
    }

    #[test]
    fn task_merge_artifact_append_true_no_match_adds_new() {
        let mut task = Task::new("t-merge-2", TaskStatus::new(TaskState::Working));
        task.append_artifact(crate::Artifact::new("a-1", vec![Part::text("x")]));

        task.merge_artifact(
            crate::Artifact::new("a-2", vec![Part::text("y")]),
            true,
            false,
        );

        assert_eq!(task.artifacts().len(), 2);
    }

    #[test]
    fn task_merge_artifact_append_false_always_appends() {
        let mut task = Task::new("t-merge-3", TaskStatus::new(TaskState::Working));
        task.append_artifact(crate::Artifact::new("a-1", vec![Part::text("x")]));

        task.merge_artifact(
            crate::Artifact::new("a-1", vec![Part::text("y")]),
            false,
            true,
        );

        assert_eq!(
            task.artifacts().len(),
            2,
            "append=false does not merge by id"
        );
    }

    #[test]
    fn task_try_from_proto_rejects_empty_id() {
        let proto = pb::Task {
            id: String::new(),
            context_id: String::new(),
            status: Some(pb::TaskStatus {
                state: pb::TaskState::Submitted.into(),
                message: None,
                timestamp: None,
            }),
            artifacts: vec![],
            history: vec![],
            metadata: None,
        };
        assert!(Task::try_from(proto).is_err());
    }

    #[test]
    fn task_try_from_proto_rejects_missing_status() {
        // Status is REQUIRED per proto field_behavior
        let proto = pb::Task {
            id: "t-no-status".to_string(),
            context_id: String::new(),
            status: None,
            artifacts: vec![],
            history: vec![],
            metadata: None,
        };
        assert!(Task::try_from(proto).is_err());
    }

    #[test]
    fn task_try_from_proto_rejects_unspecified_state() {
        let proto = pb::Task {
            id: "t-bad".to_string(),
            context_id: String::new(),
            status: Some(pb::TaskStatus {
                state: pb::TaskState::Unspecified.into(),
                message: None,
                timestamp: None,
            }),
            artifacts: vec![],
            history: vec![],
            metadata: None,
        };
        assert!(Task::try_from(proto).is_err());
    }

    #[test]
    fn task_serde_round_trip() {
        let task = Task::new("t-rt", TaskStatus::new(TaskState::Working)).with_context_id("ctx-rt");
        let json = serde_json::to_string(&task).unwrap();
        let back: Task = serde_json::from_str(&json).unwrap();
        assert_eq!(back.id(), "t-rt");
        assert_eq!(back.context_id(), "ctx-rt");
    }

    // Task helper tests

    #[test]
    fn task_complete_sets_completed_status() {
        let mut task = Task::new("h-1", TaskStatus::new(TaskState::Submitted));
        task.complete();
        assert_eq!(
            task.status().unwrap().state().unwrap(),
            TaskState::Completed
        );
    }

    #[test]
    fn task_fail_sets_failed_status_with_message() {
        let mut task = Task::new("h-2", TaskStatus::new(TaskState::Submitted));
        task.fail("something went wrong");
        let status = task.status().unwrap();
        assert_eq!(status.state().unwrap(), TaskState::Failed);
        // Status should have a message
        assert!(status.as_proto().message.is_some());
    }

    #[test]
    fn task_set_status_generic() {
        let mut task = Task::new("h-3", TaskStatus::new(TaskState::Submitted));
        task.set_status(TaskStatus::new(TaskState::Working));
        assert_eq!(task.status().unwrap().state().unwrap(), TaskState::Working);
    }

    #[test]
    fn task_push_text_artifact() {
        let mut task = Task::new("h-4", TaskStatus::new(TaskState::Submitted));
        task.push_text_artifact("art-1", "Result", "hello world");
        assert_eq!(task.artifacts().len(), 1);
        assert_eq!(task.artifacts()[0].artifact_id, "art-1");
        assert_eq!(task.artifacts()[0].name, "Result");
        assert_eq!(task.artifacts()[0].parts.len(), 1);
    }
}