trust-tasks-rs 0.1.0

Reference Rust library for the Trust Tasks framework — transport-agnostic, JSON-based descriptions of verifiable work between parties.
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
//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `acl/grant`. Version: `0.1`.
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
/// Error types.
pub mod error {
    /// Error from a `TryFrom` or `FromStr` implementation.
    pub struct ConversionError(::std::borrow::Cow<'static, str>);
    impl ::std::error::Error for ConversionError {}
    impl ::std::fmt::Display for ConversionError {
        fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
            ::std::fmt::Display::fmt(&self.0, f)
        }
    }
    impl ::std::fmt::Debug for ConversionError {
        fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
            ::std::fmt::Debug::fmt(&self.0, f)
        }
    }
    impl From<&'static str> for ConversionError {
        fn from(value: &'static str) -> Self {
            Self(value.into())
        }
    }
    impl From<String> for ConversionError {
        fn from(value: String) -> Self {
            Self(value.into())
        }
    }
}
///`AclEntry`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
///  "type": "object",
///  "required": [
///    "role",
///    "subject"
///  ],
///  "properties": {
///    "createdAt": {
///      "type": "string",
///      "format": "date-time"
///    },
///    "createdBy": {
///      "description": "VID of the party that originally added this entry.",
///      "type": "string"
///    },
///    "expiresAt": {
///      "description": "Optional time after which the entry is no longer effective.",
///      "type": "string",
///      "format": "date-time"
///    },
///    "label": {
///      "description": "Optional human-readable label.",
///      "type": "string"
///    },
///    "metadata": {
///      "description": "Ecosystem-defined extension members.",
///      "type": "object"
///    },
///    "role": {
///      "description": "Opaque role identifier interpreted by the ACL maintainer.",
///      "type": "string",
///      "minLength": 1
///    },
///    "scopes": {
///      "description": "Opaque scope identifiers (e.g. contexts, domains, resource prefixes).",
///      "type": "array",
///      "items": {
///        "type": "string",
///        "minLength": 1
///      }
///    },
///    "subject": {
///      "description": "VID of the party in the ACL.",
///      "type": "string"
///    },
///    "updatedAt": {
///      "type": "string",
///      "format": "date-time"
///    },
///    "updatedBy": {
///      "description": "VID of the party that last modified this entry.",
///      "type": "string"
///    }
///  },
///  "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct AclEntry {
    #[serde(
        rename = "createdAt",
        default,
        skip_serializing_if = "::std::option::Option::is_none"
    )]
    pub created_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
    ///VID of the party that originally added this entry.
    #[serde(
        rename = "createdBy",
        default,
        skip_serializing_if = "::std::option::Option::is_none"
    )]
    pub created_by: ::std::option::Option<::std::string::String>,
    ///Optional time after which the entry is no longer effective.
    #[serde(
        rename = "expiresAt",
        default,
        skip_serializing_if = "::std::option::Option::is_none"
    )]
    pub expires_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
    ///Optional human-readable label.
    #[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
    pub label: ::std::option::Option<::std::string::String>,
    ///Ecosystem-defined extension members.
    #[serde(default, skip_serializing_if = "::serde_json::Map::is_empty")]
    pub metadata: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
    ///Opaque role identifier interpreted by the ACL maintainer.
    pub role: AclEntryRole,
    ///Opaque scope identifiers (e.g. contexts, domains, resource prefixes).
    #[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
    pub scopes: ::std::vec::Vec<AclEntryScopesItem>,
    ///VID of the party in the ACL.
    pub subject: ::std::string::String,
    #[serde(
        rename = "updatedAt",
        default,
        skip_serializing_if = "::std::option::Option::is_none"
    )]
    pub updated_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
    ///VID of the party that last modified this entry.
    #[serde(
        rename = "updatedBy",
        default,
        skip_serializing_if = "::std::option::Option::is_none"
    )]
    pub updated_by: ::std::option::Option<::std::string::String>,
}
impl ::std::convert::From<&AclEntry> for AclEntry {
    fn from(value: &AclEntry) -> Self {
        value.clone()
    }
}
///Opaque role identifier interpreted by the ACL maintainer.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
///  "description": "Opaque role identifier interpreted by the ACL maintainer.",
///  "type": "string",
///  "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct AclEntryRole(::std::string::String);
impl ::std::ops::Deref for AclEntryRole {
    type Target = ::std::string::String;
    fn deref(&self) -> &::std::string::String {
        &self.0
    }
}
impl ::std::convert::From<AclEntryRole> for ::std::string::String {
    fn from(value: AclEntryRole) -> Self {
        value.0
    }
}
impl ::std::convert::From<&AclEntryRole> for AclEntryRole {
    fn from(value: &AclEntryRole) -> Self {
        value.clone()
    }
}
impl ::std::str::FromStr for AclEntryRole {
    type Err = self::error::ConversionError;
    fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
        if value.chars().count() < 1usize {
            return Err("shorter than 1 characters".into());
        }
        Ok(Self(value.to_string()))
    }
}
impl ::std::convert::TryFrom<&str> for AclEntryRole {
    type Error = self::error::ConversionError;
    fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
        value.parse()
    }
}
impl ::std::convert::TryFrom<&::std::string::String> for AclEntryRole {
    type Error = self::error::ConversionError;
    fn try_from(
        value: &::std::string::String,
    ) -> ::std::result::Result<Self, self::error::ConversionError> {
        value.parse()
    }
}
impl ::std::convert::TryFrom<::std::string::String> for AclEntryRole {
    type Error = self::error::ConversionError;
    fn try_from(
        value: ::std::string::String,
    ) -> ::std::result::Result<Self, self::error::ConversionError> {
        value.parse()
    }
}
impl<'de> ::serde::Deserialize<'de> for AclEntryRole {
    fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
    where
        D: ::serde::Deserializer<'de>,
    {
        ::std::string::String::deserialize(deserializer)?
            .parse()
            .map_err(|e: self::error::ConversionError| {
                <D::Error as ::serde::de::Error>::custom(e.to_string())
            })
    }
}
///`AclEntryScopesItem`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
///  "type": "string",
///  "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct AclEntryScopesItem(::std::string::String);
impl ::std::ops::Deref for AclEntryScopesItem {
    type Target = ::std::string::String;
    fn deref(&self) -> &::std::string::String {
        &self.0
    }
}
impl ::std::convert::From<AclEntryScopesItem> for ::std::string::String {
    fn from(value: AclEntryScopesItem) -> Self {
        value.0
    }
}
impl ::std::convert::From<&AclEntryScopesItem> for AclEntryScopesItem {
    fn from(value: &AclEntryScopesItem) -> Self {
        value.clone()
    }
}
impl ::std::str::FromStr for AclEntryScopesItem {
    type Err = self::error::ConversionError;
    fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
        if value.chars().count() < 1usize {
            return Err("shorter than 1 characters".into());
        }
        Ok(Self(value.to_string()))
    }
}
impl ::std::convert::TryFrom<&str> for AclEntryScopesItem {
    type Error = self::error::ConversionError;
    fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
        value.parse()
    }
}
impl ::std::convert::TryFrom<&::std::string::String> for AclEntryScopesItem {
    type Error = self::error::ConversionError;
    fn try_from(
        value: &::std::string::String,
    ) -> ::std::result::Result<Self, self::error::ConversionError> {
        value.parse()
    }
}
impl ::std::convert::TryFrom<::std::string::String> for AclEntryScopesItem {
    type Error = self::error::ConversionError;
    fn try_from(
        value: ::std::string::String,
    ) -> ::std::result::Result<Self, self::error::ConversionError> {
        value.parse()
    }
}
impl<'de> ::serde::Deserialize<'de> for AclEntryScopesItem {
    fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
    where
        D: ::serde::Deserializer<'de>,
    {
        ::std::string::String::deserialize(deserializer)?
            .parse()
            .map_err(|e: self::error::ConversionError| {
                <D::Error as ::serde::de::Error>::custom(e.to_string())
            })
    }
}
///`Payload`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
///  "$id": "https://trusttasks.org/spec/acl/grant/0.1",
///  "title": "Payload",
///  "type": "object",
///  "required": [
///    "entry"
///  ],
///  "properties": {
///    "entry": {
///      "description": "The AclEntry the producer wants the maintainer to hold for the subject (intent). The maintainer's response carries the realized AclEntry it now holds.",
///      "$ref": "#/definitions/AclEntry"
///    },
///    "reason": {
///      "description": "Optional human-readable rationale.",
///      "type": "string"
///    }
///  },
///  "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Payload {
    ///The AclEntry the producer wants the maintainer to hold for the subject (intent). The maintainer's response carries the realized AclEntry it now holds.
    pub entry: AclEntry,
    ///Optional human-readable rationale.
    #[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
    pub reason: ::std::option::Option<::std::string::String>,
}
impl ::std::convert::From<&Payload> for Payload {
    fn from(value: &Payload) -> Self {
        value.clone()
    }
}
///The success response to an acl/grant request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/acl/grant/0.1#response.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
///  "title": "Response",
///  "description": "The success response to an acl/grant request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/acl/grant/0.1#response.",
///  "type": "object",
///  "required": [
///    "entry"
///  ],
///  "properties": {
///    "entry": {
///      "description": "The canonical AclEntry the maintainer now holds for the subject.",
///      "$ref": "#/definitions/AclEntry"
///    }
///  },
///  "additionalProperties": false,
///  "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Response {
    ///The canonical AclEntry the maintainer now holds for the subject.
    pub entry: AclEntry,
}
impl ::std::convert::From<&Response> for Response {
    fn from(value: &Response) -> Self {
        value.clone()
    }
}
impl crate::Payload for Payload {
    const TYPE_URI: &'static str = "https://trusttasks.org/spec/acl/grant/0.1";
}
impl crate::Payload for Response {
    const TYPE_URI: &'static str = "https://trusttasks.org/spec/acl/grant/0.1#response";
}
#[cfg(feature = "validate")]
impl crate::validate::ValidatedPayload for Payload {
    const SCHEMA_JSON: &'static str = "{\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"$id\": \"https://trusttasks.org/spec/acl/grant/0.1\",\n  \"title\": \"ACL Grant — payload\",\n  \"type\": \"object\",\n  \"additionalProperties\": false,\n  \"required\": [\"entry\"],\n  \"properties\": {\n    \"entry\": {\n      \"description\": \"The AclEntry the producer wants the maintainer to hold for the subject (intent). The maintainer's response carries the realized AclEntry it now holds.\",\n      \"$ref\": \"#/$defs/AclEntry\"\n    },\n    \"reason\": {\n      \"type\": \"string\",\n      \"description\": \"Optional human-readable rationale.\"\n    }\n  },\n  \"$defs\": {\n    \"AclEntry\": {\n      \"type\": \"object\",\n      \"additionalProperties\": false,\n      \"required\": [\"subject\", \"role\"],\n      \"properties\": {\n        \"subject\":    { \"type\": \"string\", \"description\": \"VID of the party in the ACL.\" },\n        \"role\":       { \"type\": \"string\", \"minLength\": 1, \"description\": \"Opaque role identifier interpreted by the ACL maintainer.\" },\n        \"scopes\":     { \"type\": \"array\", \"items\": { \"type\": \"string\", \"minLength\": 1 }, \"description\": \"Opaque scope identifiers (e.g. contexts, domains, resource prefixes).\" },\n        \"label\":      { \"type\": \"string\", \"description\": \"Optional human-readable label.\" },\n        \"createdAt\":  { \"type\": \"string\", \"format\": \"date-time\" },\n        \"createdBy\":  { \"type\": \"string\", \"description\": \"VID of the party that originally added this entry.\" },\n        \"updatedAt\":  { \"type\": \"string\", \"format\": \"date-time\" },\n        \"updatedBy\":  { \"type\": \"string\", \"description\": \"VID of the party that last modified this entry.\" },\n        \"expiresAt\":  { \"type\": \"string\", \"format\": \"date-time\", \"description\": \"Optional time after which the entry is no longer effective.\" },\n        \"metadata\":   { \"type\": \"object\", \"description\": \"Ecosystem-defined extension members.\" }\n      }\n    },\n    \"Response\": {\n      \"$anchor\": \"response\",\n      \"title\": \"ACL Grant — response payload\",\n      \"description\": \"The success response to an acl/grant request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/acl/grant/0.1#response.\",\n      \"type\": \"object\",\n      \"additionalProperties\": false,\n      \"required\": [\"entry\"],\n      \"properties\": {\n        \"entry\": {\n          \"description\": \"The canonical AclEntry the maintainer now holds for the subject.\",\n          \"$ref\": \"#/$defs/AclEntry\"\n        }\n      }\n    }\n  }\n}\n";
}
#[cfg(test)]
mod conformance {
    //! Round-trip tests harvested from the spec's `spec.md`.
    #[test]
    fn request_example_1() {
        const JSON: &str = "{\n  \"id\": \"4f3c9e2a-1b81-4d3e-9b51-7a3c89e3d1f2\",\n  \"type\": \"https://trusttasks.org/spec/acl/grant/0.1\",\n  \"issuer\": \"did:web:org.example\",\n  \"recipient\": \"did:web:maintainer.example\",\n  \"issuedAt\": \"2026-05-16T10:00:00Z\",\n  \"payload\": {\n    \"entry\": {\n      \"subject\": \"did:web:alice.example\",\n      \"role\": \"admin\",\n      \"label\": \"Alice — primary admin\"\n    }\n  },\n  \"proof\": {\n    \"type\": \"DataIntegrityProof\",\n    \"cryptosuite\": \"eddsa-rdfc-2022\",\n    \"verificationMethod\": \"did:web:org.example#key-1\",\n    \"created\": \"2026-05-16T10:00:00Z\",\n    \"proofPurpose\": \"assertionMethod\",\n    \"proofValue\": \"z3kg...\"\n  }\n}\n";
        let doc: crate::TrustTask<super::Payload> =
            serde_json::from_str(JSON).expect("deserialize request example");
        let rendered = serde_json::to_value(&doc).expect("re-serialize");
        let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
        assert_eq!(rendered, expected, "request example failed round-trip");
    }
    #[test]
    fn request_example_2() {
        const JSON: &str = "{\n  \"id\": \"8a91c7b3-2e62-4a91-a3a4-9d61b75e2f01\",\n  \"type\": \"https://trusttasks.org/spec/acl/grant/0.1\",\n  \"issuer\": \"did:web:org.example\",\n  \"recipient\": \"did:web:maintainer.example\",\n  \"issuedAt\": \"2026-05-16T10:05:00Z\",\n  \"payload\": {\n    \"entry\": {\n      \"subject\": \"did:web:contractor.example\",\n      \"role\": \"member\",\n      \"scopes\": [\"context:project-alpha\"],\n      \"expiresAt\": \"2026-08-16T00:00:00Z\"\n    },\n    \"reason\": \"Six-month contractor engagement on project-alpha.\"\n  }\n}\n";
        let doc: crate::TrustTask<super::Payload> =
            serde_json::from_str(JSON).expect("deserialize request example");
        let rendered = serde_json::to_value(&doc).expect("re-serialize");
        let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
        assert_eq!(rendered, expected, "request example failed round-trip");
    }
    #[test]
    fn response_example_1() {
        const JSON: &str = "{\n  \"id\": \"5e3c9e2a-1b81-4d3e-9b51-7a3c89e3d1f3\",\n  \"type\": \"https://trusttasks.org/spec/acl/grant/0.1#response\",\n  \"threadId\": \"4f3c9e2a-1b81-4d3e-9b51-7a3c89e3d1f2\",\n  \"issuer\": \"did:web:maintainer.example\",\n  \"recipient\": \"did:web:org.example\",\n  \"issuedAt\": \"2026-05-16T10:00:01Z\",\n  \"payload\": {\n    \"entry\": {\n      \"subject\": \"did:web:alice.example\",\n      \"role\": \"admin\",\n      \"label\": \"Alice — primary admin\",\n      \"createdAt\": \"2026-05-16T10:00:01Z\",\n      \"createdBy\": \"did:web:org.example\"\n    }\n  },\n  \"proof\": {\n    \"type\": \"DataIntegrityProof\",\n    \"cryptosuite\": \"eddsa-rdfc-2022\",\n    \"verificationMethod\": \"did:web:maintainer.example#key-1\",\n    \"created\": \"2026-05-16T10:00:01Z\",\n    \"proofPurpose\": \"assertionMethod\",\n    \"proofValue\": \"z6ab...\"\n  }\n}\n";
        let doc: crate::TrustTask<super::Response> =
            serde_json::from_str(JSON).expect("deserialize response example");
        let rendered = serde_json::to_value(&doc).expect("re-serialize");
        let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
        assert_eq!(rendered, expected, "response example failed round-trip");
    }
}