//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vtc/join-requests/query`. 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())
}
}
}
///The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "CredentialQuery",
/// "description": "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.",
/// "type": "object",
/// "required": [
/// "dcql_query",
/// "nonce",
/// "purpose"
/// ],
/// "properties": {
/// "dcql_query": {
/// "type": "object"
/// },
/// "nonce": {
/// "type": "string",
/// "maxLength": 512,
/// "minLength": 1
/// },
/// "purpose": {
/// "type": "string",
/// "maxLength": 500,
/// "minLength": 1
/// }
/// },
/// "additionalProperties": true
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct CredentialQuery {
pub dcql_query: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
pub nonce: CredentialQueryNonce,
pub purpose: CredentialQueryPurpose,
}
impl CredentialQuery {
pub fn builder() -> builder::CredentialQuery {
Default::default()
}
}
///`CredentialQueryNonce`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "maxLength": 512,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct CredentialQueryNonce(::std::string::String);
impl ::std::ops::Deref for CredentialQueryNonce {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<CredentialQueryNonce> for ::std::string::String {
fn from(value: CredentialQueryNonce) -> Self {
value.0
}
}
impl ::std::str::FromStr for CredentialQueryNonce {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 512usize {
return Err("longer than 512 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for CredentialQueryNonce {
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 CredentialQueryNonce {
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 CredentialQueryNonce {
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 CredentialQueryNonce {
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())
})
}
}
///`CredentialQueryPurpose`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "maxLength": 500,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct CredentialQueryPurpose(::std::string::String);
impl ::std::ops::Deref for CredentialQueryPurpose {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<CredentialQueryPurpose> for ::std::string::String {
fn from(value: CredentialQueryPurpose) -> Self {
value.0
}
}
impl ::std::str::FromStr for CredentialQueryPurpose {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 500usize {
return Err("longer than 500 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for CredentialQueryPurpose {
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 CredentialQueryPurpose {
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 CredentialQueryPurpose {
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 CredentialQueryPurpose {
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())
})
}
}
///Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Ext",
/// "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
/// "type": "object",
/// "minProperties": 1,
/// "additionalProperties": true,
/// "propertyNames": {
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
/// }
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Ext(pub ::std::collections::HashMap<ExtKey, ::serde_json::Value>);
impl ::std::ops::Deref for Ext {
type Target = ::std::collections::HashMap<ExtKey, ::serde_json::Value>;
fn deref(&self) -> &::std::collections::HashMap<ExtKey, ::serde_json::Value> {
&self.0
}
}
impl ::std::convert::From<Ext> for ::std::collections::HashMap<ExtKey, ::serde_json::Value> {
fn from(value: Ext) -> Self {
value.0
}
}
impl ::std::convert::From<::std::collections::HashMap<ExtKey, ::serde_json::Value>> for Ext {
fn from(value: ::std::collections::HashMap<ExtKey, ::serde_json::Value>) -> Self {
Self(value)
}
}
///`ExtKey`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ExtKey(::std::string::String);
impl ::std::ops::Deref for ExtKey {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ExtKey> for ::std::string::String {
fn from(value: ExtKey) -> Self {
value.0
}
}
impl ::std::str::FromStr for ExtKey {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ExtKey {
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 ExtKey {
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 ExtKey {
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 ExtKey {
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())
})
}
}
///An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/vtc/join-requests/query/0.1",
/// "title": "Payload",
/// "description": "An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.",
/// "type": "object",
/// "required": [
/// "criterionId",
/// "holderDid"
/// ],
/// "properties": {
/// "criterionId": {
/// "description": "The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "holderDid": {
/// "description": "The holder the query is for — the prospective member whose agent will answer it.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 5,
/// "pattern": "^did:"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
///The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.
#[serde(rename = "criterionId")]
pub criterion_id: PayloadCriterionId,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///The holder the query is for — the prospective member whose agent will answer it.
#[serde(rename = "holderDid")]
pub holder_did: PayloadHolderDid,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadCriterionId(::std::string::String);
impl ::std::ops::Deref for PayloadCriterionId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadCriterionId> for ::std::string::String {
fn from(value: PayloadCriterionId) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadCriterionId {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 128usize {
return Err("longer than 128 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadCriterionId {
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 PayloadCriterionId {
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 PayloadCriterionId {
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 PayloadCriterionId {
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())
})
}
}
///The holder the query is for — the prospective member whose agent will answer it.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The holder the query is for — the prospective member whose agent will answer it.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 5,
/// "pattern": "^did:"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadHolderDid(::std::string::String);
impl ::std::ops::Deref for PayloadHolderDid {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadHolderDid> for ::std::string::String {
fn from(value: PayloadHolderDid) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadHolderDid {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 2048usize {
return Err("longer than 2048 characters".into());
}
if value.chars().count() < 5usize {
return Err("shorter than 5 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^did:").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadHolderDid {
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 PayloadHolderDid {
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 PayloadHolderDid {
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 PayloadHolderDid {
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())
})
}
}
///`Response`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "type": "object",
/// "required": [
/// "delivered",
/// "holderDid",
/// "query",
/// "threadId"
/// ],
/// "properties": {
/// "delivered": {
/// "description": "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.",
/// "type": "boolean"
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "holderDid": {
/// "description": "Echoed.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
/// },
/// "query": {
/// "$ref": "#/definitions/CredentialQuery"
/// },
/// "threadId": {
/// "description": "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.",
/// "type": "string",
/// "maxLength": 256,
/// "minLength": 1
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
///Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.
pub delivered: bool,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Echoed.
#[serde(rename = "holderDid")]
pub holder_did: ResponseHolderDid,
pub query: CredentialQuery,
///The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.
#[serde(rename = "threadId")]
pub thread_id: ResponseThreadId,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///Echoed.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Echoed.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseHolderDid(::std::string::String);
impl ::std::ops::Deref for ResponseHolderDid {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseHolderDid> for ::std::string::String {
fn from(value: ResponseHolderDid) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseHolderDid {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 2048usize {
return Err("longer than 2048 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^did:").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResponseHolderDid {
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 ResponseHolderDid {
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 ResponseHolderDid {
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 ResponseHolderDid {
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())
})
}
}
///The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.",
/// "type": "string",
/// "maxLength": 256,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseThreadId(::std::string::String);
impl ::std::ops::Deref for ResponseThreadId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseThreadId> for ::std::string::String {
fn from(value: ResponseThreadId) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseThreadId {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 256usize {
return Err("longer than 256 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResponseThreadId {
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 ResponseThreadId {
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 ResponseThreadId {
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 ResponseThreadId {
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())
})
}
}
/// Types for composing complex structures.
pub mod builder {
#[derive(Clone, Debug)]
pub struct CredentialQuery {
dcql_query: ::std::result::Result<
::serde_json::Map<::std::string::String, ::serde_json::Value>,
::std::string::String,
>,
nonce: ::std::result::Result<super::CredentialQueryNonce, ::std::string::String>,
purpose: ::std::result::Result<super::CredentialQueryPurpose, ::std::string::String>,
}
impl ::std::default::Default for CredentialQuery {
fn default() -> Self {
Self {
dcql_query: Err("no value supplied for dcql_query".to_string()),
nonce: Err("no value supplied for nonce".to_string()),
purpose: Err("no value supplied for purpose".to_string()),
}
}
}
impl CredentialQuery {
pub fn dcql_query<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<
::serde_json::Map<::std::string::String, ::serde_json::Value>,
>,
T::Error: ::std::fmt::Display,
{
self.dcql_query = value
.try_into()
.map_err(|e| format!("error converting supplied value for dcql_query: {e}"));
self
}
pub fn nonce<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::CredentialQueryNonce>,
T::Error: ::std::fmt::Display,
{
self.nonce = value
.try_into()
.map_err(|e| format!("error converting supplied value for nonce: {e}"));
self
}
pub fn purpose<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::CredentialQueryPurpose>,
T::Error: ::std::fmt::Display,
{
self.purpose = value
.try_into()
.map_err(|e| format!("error converting supplied value for purpose: {e}"));
self
}
}
impl ::std::convert::TryFrom<CredentialQuery> for super::CredentialQuery {
type Error = super::error::ConversionError;
fn try_from(
value: CredentialQuery,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
dcql_query: value.dcql_query?,
nonce: value.nonce?,
purpose: value.purpose?,
})
}
}
impl ::std::convert::From<super::CredentialQuery> for CredentialQuery {
fn from(value: super::CredentialQuery) -> Self {
Self {
dcql_query: Ok(value.dcql_query),
nonce: Ok(value.nonce),
purpose: Ok(value.purpose),
}
}
}
#[derive(Clone, Debug)]
pub struct Payload {
criterion_id: ::std::result::Result<super::PayloadCriterionId, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
holder_did: ::std::result::Result<super::PayloadHolderDid, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
criterion_id: Err("no value supplied for criterion_id".to_string()),
ext: Ok(Default::default()),
holder_did: Err("no value supplied for holder_did".to_string()),
}
}
}
impl Payload {
pub fn criterion_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PayloadCriterionId>,
T::Error: ::std::fmt::Display,
{
self.criterion_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for criterion_id: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn holder_did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PayloadHolderDid>,
T::Error: ::std::fmt::Display,
{
self.holder_did = value
.try_into()
.map_err(|e| format!("error converting supplied value for holder_did: {e}"));
self
}
}
impl ::std::convert::TryFrom<Payload> for super::Payload {
type Error = super::error::ConversionError;
fn try_from(value: Payload) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
criterion_id: value.criterion_id?,
ext: value.ext?,
holder_did: value.holder_did?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
criterion_id: Ok(value.criterion_id),
ext: Ok(value.ext),
holder_did: Ok(value.holder_did),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
delivered: ::std::result::Result<bool, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
holder_did: ::std::result::Result<super::ResponseHolderDid, ::std::string::String>,
query: ::std::result::Result<super::CredentialQuery, ::std::string::String>,
thread_id: ::std::result::Result<super::ResponseThreadId, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
delivered: Err("no value supplied for delivered".to_string()),
ext: Ok(Default::default()),
holder_did: Err("no value supplied for holder_did".to_string()),
query: Err("no value supplied for query".to_string()),
thread_id: Err("no value supplied for thread_id".to_string()),
}
}
}
impl Response {
pub fn delivered<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.delivered = value
.try_into()
.map_err(|e| format!("error converting supplied value for delivered: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn holder_did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResponseHolderDid>,
T::Error: ::std::fmt::Display,
{
self.holder_did = value
.try_into()
.map_err(|e| format!("error converting supplied value for holder_did: {e}"));
self
}
pub fn query<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::CredentialQuery>,
T::Error: ::std::fmt::Display,
{
self.query = value
.try_into()
.map_err(|e| format!("error converting supplied value for query: {e}"));
self
}
pub fn thread_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResponseThreadId>,
T::Error: ::std::fmt::Display,
{
self.thread_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for thread_id: {e}"));
self
}
}
impl ::std::convert::TryFrom<Response> for super::Response {
type Error = super::error::ConversionError;
fn try_from(value: Response) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
delivered: value.delivered?,
ext: value.ext?,
holder_did: value.holder_did?,
query: value.query?,
thread_id: value.thread_id?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
delivered: Ok(value.delivered),
ext: Ok(value.ext),
holder_did: Ok(value.holder_did),
query: Ok(value.query),
thread_id: Ok(value.thread_id),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vtc/join-requests/query/0.1";
const IS_PROOF_REQUIRED: bool = true;
const IS_ISSUED_AT_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\n \"$defs\": {\n \"CredentialQuery\": {\n \"additionalProperties\": true,\n \"description\": \"The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.\",\n \"properties\": {\n \"dcql_query\": {\n \"type\": \"object\"\n },\n \"nonce\": {\n \"maxLength\": 512,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"purpose\": {\n \"maxLength\": 500,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"dcql_query\",\n \"nonce\",\n \"purpose\"\n ],\n \"title\": \"CredentialQuery\",\n \"type\": \"object\"\n },\n \"Ext\": {\n \"additionalProperties\": true,\n \"description\": \"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"properties\": {\n \"delivered\": {\n \"description\": \"Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.\",\n \"type\": \"boolean\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"holderDid\": {\n \"description\": \"Echoed.\",\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"query\": {\n \"$ref\": \"#/$defs/CredentialQuery\"\n },\n \"threadId\": {\n \"description\": \"The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.\",\n \"maxLength\": 256,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"threadId\",\n \"holderDid\",\n \"query\",\n \"delivered\"\n ],\n \"title\": \"VTC Join Requests — Query — response payload\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/vtc/join-requests/query/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.\",\n \"properties\": {\n \"criterionId\": {\n \"description\": \"The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"holderDid\": {\n \"description\": \"The holder the query is for — the prospective member whose agent will answer it.\",\n \"maxLength\": 2048,\n \"minLength\": 5,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"holderDid\",\n \"criterionId\"\n ],\n \"title\": \"VTC Join Requests — Query — payload\",\n \"type\": \"object\"\n}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/vtc/join-requests/query/0.1#response";
const IS_PROOF_REQUIRED: bool = true;
const IS_ISSUED_AT_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\n \"$defs\": {\n \"CredentialQuery\": {\n \"additionalProperties\": true,\n \"description\": \"The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.\",\n \"properties\": {\n \"dcql_query\": {\n \"type\": \"object\"\n },\n \"nonce\": {\n \"maxLength\": 512,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"purpose\": {\n \"maxLength\": 500,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"dcql_query\",\n \"nonce\",\n \"purpose\"\n ],\n \"title\": \"CredentialQuery\",\n \"type\": \"object\"\n },\n \"Ext\": {\n \"additionalProperties\": true,\n \"description\": \"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"properties\": {\n \"delivered\": {\n \"description\": \"Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.\",\n \"type\": \"boolean\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"holderDid\": {\n \"description\": \"Echoed.\",\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"query\": {\n \"$ref\": \"#/$defs/CredentialQuery\"\n },\n \"threadId\": {\n \"description\": \"The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.\",\n \"maxLength\": 256,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"threadId\",\n \"holderDid\",\n \"query\",\n \"delivered\"\n ],\n \"title\": \"VTC Join Requests — Query — response payload\",\n \"type\": \"object\"\n }\n },\n \"$ref\": \"#/$defs/Response\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\"\n}\n",
);
}
impl crate::RequestPayload for Payload {
type Response = Response;
}
/// The extended error codes this specification declares (SPEC §7.3 item 9,
/// §8.5), in declaration order. Empty when it declares none.
pub const ERROR_CODES: &[crate::DeclaredErrorCode] = &[error_codes::CRITERION_NOT_FOUND];
/// One constant per extended error code this specification declares
/// (SPEC §7.3 item 9), named for its local part.
///
/// Emit these rather than a string literal: the code is read from the
/// specification, so it cannot name a code the specification never
/// declared.
pub mod error_codes {
/// `vtc/join-requests/query:criterionNotFound`
///
/// No Accepts criterion is registered under `criterionId`.
///
/// Declared `retryable: false`.
pub const CRITERION_NOT_FOUND: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vtc/join-requests/query:criterionNotFound",
retryable: false,
};
}
#[cfg(test)]
mod conformance {
//! Round-trip tests harvested from the spec's `spec.md`,
//! plus a `rejects_invalid_examples` test for any fixtures
//! in `payload.invalid-examples.json` (validate feature).
#[test]
fn request_example_1() {
const JSON: &str = "{\n \"id\": \"urn:uuid:00000000-0000-4000-8000-000000000001\",\n \"type\": \"https://trusttasks.org/spec/vtc/join-requests/query/0.1#request\",\n \"issuer\": \"did:example:administrator\",\n \"recipient\": \"did:example:community\",\n \"issuedAt\": \"2026-09-28T10:00:00Z\",\n \"threadId\": \"urn:uuid:00000000-0000-4000-8000-0000000001ff\",\n \"payload\": {\n \"holderDid\": \"did:example:prospect\",\n \"criterionId\": \"membership\"\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\": \"urn:uuid:00000000-0000-4000-8000-000000000002\",\n \"type\": \"https://trusttasks.org/spec/vtc/join-requests/query/0.1#response\",\n \"issuer\": \"did:example:community\",\n \"recipient\": \"did:example:administrator\",\n \"issuedAt\": \"2026-09-28T10:00:01Z\",\n \"threadId\": \"urn:uuid:00000000-0000-4000-8000-0000000001ff\",\n \"payload\": {\n \"threadId\": \"urn:uuid:9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\",\n \"holderDid\": \"did:example:prospect\",\n \"query\": {\n \"dcql_query\": {\n \"credentials\": [\n {\n \"id\": \"membership\",\n \"format\": \"vc+sd-jwt\",\n \"meta\": {\n \"vct_values\": [\n \"https://openvtc.org/credentials/MembershipCredential\"\n ]\n }\n }\n ]\n },\n \"nonce\": \"b3Blbi12dGMtY2hhbGxlbmdlLTAx\",\n \"purpose\": \"Show a membership credential from a partner community.\"\n },\n \"delivered\": true\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");
}
/// Each fixture in `payload.invalid-examples.json` MUST be
/// rejected by at least one of: serde deserialization, or
/// JSON-Schema validation under the `validate` feature. The
/// fixture file documents the producer-side bug class that
/// each payload exemplifies; this generated test pins it.
#[cfg(feature = "validate")]
#[test]
fn rejects_invalid_examples() {
use crate::validate::ValidatedPayload;
let fixtures: &[(&str, &str)] = &[
(
"Missing criterionId — the community sends the query of a registered criterion, never one the caller writes.",
"{\n \"holderDid\": \"did:example:prospect\"\n}",
),
(
"A caller-supplied DCQL query — the query is derived from the criterion.",
"{\n \"criterionId\": \"membership\",\n \"dcql_query\": {},\n \"holderDid\": \"did:example:prospect\"\n}",
),
(
"holderDid that is not a DID.",
"{\n \"criterionId\": \"membership\",\n \"holderDid\": \"prospect@example.org\"\n}",
),
];
for (i, (note, raw)) in fixtures.iter().enumerate() {
let value: serde_json::Value = match serde_json::from_str(raw) {
Ok(v) => v,
Err(_) => continue,
};
let serde_ok = serde_json::from_value::<super::Payload>(value.clone()).is_ok();
let schema_ok = super::Payload::validate_value(&value).is_ok();
assert!(
!(serde_ok && schema_ok),
"invalid-example #{} ({:?}) was accepted by both serde and JSON Schema; \
the fixture's stated failure class is no longer caught:\n{}",
i + 1,
note,
raw
);
}
}
/// Each `"variant": "response"` fixture in
/// `payload.invalid-examples.json` MUST be rejected as a
/// response payload by at least one of: serde deserialization
/// into `Response`, or JSON-Schema validation against the
/// `$anchor: "response"` sub-schema (validate feature).
#[cfg(feature = "validate")]
#[test]
fn rejects_invalid_response_examples() {
use crate::validate::ValidatedPayload;
let fixtures: &[(&str, &str)] = &[
(
"Response without `delivered` — the caller has to know whether to relay the query.",
"{\n \"holderDid\": \"did:example:prospect\",\n \"query\": {\n \"dcql_query\": {},\n \"nonce\": \"n\",\n \"purpose\": \"p\"\n },\n \"threadId\": \"urn:uuid:9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\"\n}",
),
(
"A query without a purpose — credential-exchange/query makes it mandatory.",
"{\n \"delivered\": false,\n \"holderDid\": \"did:example:prospect\",\n \"query\": {\n \"dcql_query\": {},\n \"nonce\": \"n\"\n },\n \"threadId\": \"t\"\n}",
),
];
for (i, (note, raw)) in fixtures.iter().enumerate() {
let value: serde_json::Value = match serde_json::from_str(raw) {
Ok(v) => v,
Err(_) => continue,
};
let serde_ok = serde_json::from_value::<super::Response>(value.clone()).is_ok();
let schema_ok = super::Response::validate_value(&value).is_ok();
assert!(
!(serde_ok && schema_ok),
"invalid response example #{} ({:?}) was accepted by both serde and JSON Schema; \
the fixture's stated failure class is no longer caught:\n{}",
i + 1,
note,
raw
);
}
}
}