//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vta/contexts/did-templates/create`. Version: `1.0`.
#[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())
}
}
}
///Authored template shape: a DID document with `{TOKEN}` placeholders plus the variable contract the VTA's renderer enforces.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "DidTemplate",
/// "description": "Authored template shape: a DID document with `{TOKEN}` placeholders plus the variable contract the VTA's renderer enforces.",
/// "type": "object",
/// "required": [
/// "document",
/// "kind",
/// "name",
/// "schemaVersion"
/// ],
/// "properties": {
/// "defaults": {
/// "description": "Hints for CLI / setup wizards (e.g. preRotationCount, portable, addMediatorService).",
/// "type": "object",
/// "additionalProperties": true
/// },
/// "description": {
/// "description": "Human-readable description of what the template provisions.",
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "document": {
/// "description": "The DID document body with `{TOKEN}` placeholders. `document.id` MUST contain the `{DID}` placeholder. Every `{TOKEN}` MUST be declared in requiredVars/optionalVars or be a reserved ambient name.",
/// "type": "object"
/// },
/// "kind": {
/// "description": "Classification hint, e.g. `mediator`, `did-host-http`, `app`. Drives downstream provisioning behaviour.",
/// "type": "string",
/// "minLength": 1
/// },
/// "methods": {
/// "description": "DID methods this template targets, e.g. [\"webvh\", \"web\"] for a hosted DID or [\"key\"] for a did:key.",
/// "type": "array",
/// "items": {
/// "type": "string"
/// }
/// },
/// "name": {
/// "description": "Template id within its scope. Lowercase alphanumeric and hyphen only.",
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 1,
/// "pattern": "^[a-z0-9-]+$"
/// },
/// "optionalVars": {
/// "description": "Variables with default values, keyed by variable name.",
/// "type": "object",
/// "additionalProperties": true
/// },
/// "requiredVars": {
/// "description": "Variables the caller MUST supply at render time. MUST NOT include reserved ambient names (DID, SIGNING_KEY_MB, KA_KEY_MB, VTA_DID, VTA_URL, CONTEXT_ID, CONTEXT_DID, NOW).",
/// "type": "array",
/// "items": {
/// "type": "string"
/// }
/// },
/// "schemaVersion": {
/// "description": "Template schema version. Currently always 1.",
/// "type": "integer",
/// "const": 1
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct DidTemplate {
///Hints for CLI / setup wizards (e.g. preRotationCount, portable, addMediatorService).
#[serde(default, skip_serializing_if = "::serde_json::Map::is_empty")]
pub defaults: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
///Human-readable description of what the template provisions.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub description: ::std::option::Option<::std::string::String>,
///The DID document body with `{TOKEN}` placeholders. `document.id` MUST contain the `{DID}` placeholder. Every `{TOKEN}` MUST be declared in requiredVars/optionalVars or be a reserved ambient name.
pub document: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
///Classification hint, e.g. `mediator`, `did-host-http`, `app`. Drives downstream provisioning behaviour.
pub kind: DidTemplateKind,
///DID methods this template targets, e.g. ["webvh", "web"] for a hosted DID or ["key"] for a did:key.
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub methods: ::std::vec::Vec<::std::string::String>,
///Template id within its scope. Lowercase alphanumeric and hyphen only.
pub name: DidTemplateName,
///Variables with default values, keyed by variable name.
#[serde(
rename = "optionalVars",
default,
skip_serializing_if = "::serde_json::Map::is_empty"
)]
pub optional_vars: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
///Variables the caller MUST supply at render time. MUST NOT include reserved ambient names (DID, SIGNING_KEY_MB, KA_KEY_MB, VTA_DID, VTA_URL, CONTEXT_ID, CONTEXT_DID, NOW).
#[serde(
rename = "requiredVars",
default,
skip_serializing_if = "::std::vec::Vec::is_empty"
)]
pub required_vars: ::std::vec::Vec<::std::string::String>,
///Template schema version. Currently always 1.
#[serde(rename = "schemaVersion")]
pub schema_version: i64,
}
///Classification hint, e.g. `mediator`, `did-host-http`, `app`. Drives downstream provisioning behaviour.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Classification hint, e.g. `mediator`, `did-host-http`, `app`. Drives downstream provisioning behaviour.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct DidTemplateKind(::std::string::String);
impl ::std::ops::Deref for DidTemplateKind {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<DidTemplateKind> for ::std::string::String {
fn from(value: DidTemplateKind) -> Self {
value.0
}
}
impl ::std::str::FromStr for DidTemplateKind {
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 DidTemplateKind {
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 DidTemplateKind {
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 DidTemplateKind {
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 DidTemplateKind {
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())
})
}
}
///Template id within its scope. Lowercase alphanumeric and hyphen only.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Template id within its scope. Lowercase alphanumeric and hyphen only.",
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 1,
/// "pattern": "^[a-z0-9-]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct DidTemplateName(::std::string::String);
impl ::std::ops::Deref for DidTemplateName {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<DidTemplateName> for ::std::string::String {
fn from(value: DidTemplateName) -> Self {
value.0
}
}
impl ::std::str::FromStr for DidTemplateName {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 64usize {
return Err("longer than 64 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^[a-z0-9-]+$").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[a-z0-9-]+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for DidTemplateName {
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 DidTemplateName {
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 DidTemplateName {
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 DidTemplateName {
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())
})
}
}
///Create a new DID template scoped to a context on a VTA. Gated on the context's admin (or super-admin). The template's own `name` is the resource id within the context scope; the VTA refuses duplicates (use update to replace). The success response is the persisted DidTemplateRecord.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/vta/contexts/did-templates/create/1.0",
/// "title": "Payload",
/// "description": "Create a new DID template scoped to a context on a VTA. Gated on the context's admin (or super-admin). The template's own `name` is the resource id within the context scope; the VTA refuses duplicates (use update to replace). The success response is the persisted DidTemplateRecord.",
/// "type": "object",
/// "required": [
/// "contextId",
/// "template"
/// ],
/// "properties": {
/// "contextId": {
/// "description": "The context the template is scoped to.",
/// "type": "string",
/// "minLength": 1
/// },
/// "ext": {
/// "description": "Ecosystem-defined extension members per SPEC.md §4.5.1.",
/// "$ref": "#/definitions/Ext"
/// },
/// "template": {
/// "description": "Full template document to store. Validated against the v1 template schema before persistence; an invalid shape is rejected with the framework's `malformedRequest`.",
/// "$ref": "#/definitions/DidTemplate"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Payload {
///The context the template is scoped to.
#[serde(rename = "contextId")]
pub context_id: PayloadContextId,
///Ecosystem-defined extension members per SPEC.md §4.5.1.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Full template document to store. Validated against the v1 template schema before persistence; an invalid shape is rejected with the framework's `malformedRequest`.
pub template: DidTemplate,
}
///The context the template is scoped to.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The context the template is scoped to.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadContextId(::std::string::String);
impl ::std::ops::Deref for PayloadContextId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadContextId> for ::std::string::String {
fn from(value: PayloadContextId) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadContextId {
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 PayloadContextId {
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 PayloadContextId {
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 PayloadContextId {
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 PayloadContextId {
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 persisted DidTemplateRecord. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by get/update.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "The persisted DidTemplateRecord. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by get/update.",
/// "type": "object",
/// "required": [
/// "createdAt",
/// "createdBy",
/// "document",
/// "kind",
/// "name",
/// "schemaVersion",
/// "scope",
/// "updatedAt"
/// ],
/// "properties": {
/// "createdAt": {
/// "description": "UTC unix-epoch seconds the template was first stored.",
/// "type": "integer"
/// },
/// "createdBy": {
/// "description": "DID of the admin who last wrote the template.",
/// "type": "string"
/// },
/// "defaults": {
/// "type": "object",
/// "additionalProperties": true
/// },
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "document": {
/// "type": "object"
/// },
/// "kind": {
/// "type": "string",
/// "minLength": 1
/// },
/// "methods": {
/// "type": "array",
/// "items": {
/// "type": "string"
/// }
/// },
/// "name": {
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 1,
/// "pattern": "^[a-z0-9-]+$"
/// },
/// "optionalVars": {
/// "type": "object",
/// "additionalProperties": true
/// },
/// "requiredVars": {
/// "type": "array",
/// "items": {
/// "type": "string"
/// }
/// },
/// "schemaVersion": {
/// "type": "integer",
/// "const": 1
/// },
/// "scope": {
/// "description": "Resolved scope of the stored template.",
/// "$ref": "#/definitions/Scope"
/// },
/// "updatedAt": {
/// "description": "UTC unix-epoch seconds of the last write.",
/// "type": "integer"
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Response {
///UTC unix-epoch seconds the template was first stored.
#[serde(rename = "createdAt")]
pub created_at: i64,
///DID of the admin who last wrote the template.
#[serde(rename = "createdBy")]
pub created_by: ::std::string::String,
#[serde(default, skip_serializing_if = "::serde_json::Map::is_empty")]
pub defaults: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub description: ::std::option::Option<::std::string::String>,
pub document: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
pub kind: ResponseKind,
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub methods: ::std::vec::Vec<::std::string::String>,
pub name: ResponseName,
#[serde(
rename = "optionalVars",
default,
skip_serializing_if = "::serde_json::Map::is_empty"
)]
pub optional_vars: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
#[serde(
rename = "requiredVars",
default,
skip_serializing_if = "::std::vec::Vec::is_empty"
)]
pub required_vars: ::std::vec::Vec<::std::string::String>,
#[serde(rename = "schemaVersion")]
pub schema_version: i64,
///Resolved scope of the stored template.
pub scope: Scope,
///UTC unix-epoch seconds of the last write.
#[serde(rename = "updatedAt")]
pub updated_at: i64,
}
///`ResponseKind`
///
/// <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 ResponseKind(::std::string::String);
impl ::std::ops::Deref for ResponseKind {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseKind> for ::std::string::String {
fn from(value: ResponseKind) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseKind {
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 ResponseKind {
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 ResponseKind {
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 ResponseKind {
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 ResponseKind {
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())
})
}
}
///`ResponseName`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 1,
/// "pattern": "^[a-z0-9-]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseName(::std::string::String);
impl ::std::ops::Deref for ResponseName {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseName> for ::std::string::String {
fn from(value: ResponseName) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseName {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 64usize {
return Err("longer than 64 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^[a-z0-9-]+$").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[a-z0-9-]+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResponseName {
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 ResponseName {
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 ResponseName {
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 ResponseName {
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())
})
}
}
///Where a stored template lives. Tagged by `type`.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Scope",
/// "description": "Where a stored template lives. Tagged by `type`.",
/// "type": "object",
/// "oneOf": [
/// {
/// "title": "Builtin",
/// "type": "object",
/// "required": [
/// "type"
/// ],
/// "properties": {
/// "type": {
/// "const": "builtin"
/// }
/// },
/// "additionalProperties": false
/// },
/// {
/// "title": "Global",
/// "type": "object",
/// "required": [
/// "type"
/// ],
/// "properties": {
/// "type": {
/// "const": "global"
/// }
/// },
/// "additionalProperties": false
/// },
/// {
/// "title": "Context",
/// "type": "object",
/// "required": [
/// "contextId",
/// "type"
/// ],
/// "properties": {
/// "contextId": {
/// "type": "string",
/// "minLength": 1
/// },
/// "type": {
/// "const": "context"
/// }
/// },
/// "additionalProperties": false
/// }
/// ]
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(tag = "type", content = "contextId")]
pub enum Scope {
#[serde(rename = "builtin")]
Builtin,
#[serde(rename = "global")]
Global,
///Context
#[serde(rename = "context")]
Context(ScopeContextId),
}
impl ::std::convert::From<ScopeContextId> for Scope {
fn from(value: ScopeContextId) -> Self {
Self::Context(value)
}
}
///`ScopeContextId`
///
/// <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 ScopeContextId(::std::string::String);
impl ::std::ops::Deref for ScopeContextId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ScopeContextId> for ::std::string::String {
fn from(value: ScopeContextId) -> Self {
value.0
}
}
impl ::std::str::FromStr for ScopeContextId {
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 ScopeContextId {
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 ScopeContextId {
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 ScopeContextId {
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 ScopeContextId {
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())
})
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/vta/contexts/did-templates/create/1.0";
const IS_PROOF_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
}
impl crate::Payload for Response {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/vta/contexts/did-templates/create/1.0#response";
const IS_PROOF_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
}
#[cfg(feature = "validate")]
impl crate::validate::ValidatedPayload for Payload {
const SCHEMA_JSON: &'static str = "{\n \"$defs\": {\n \"DidTemplate\": {\n \"additionalProperties\": false,\n \"description\": \"Authored template shape: a DID document with `{TOKEN}` placeholders plus the variable contract the VTA's renderer enforces.\",\n \"properties\": {\n \"defaults\": {\n \"additionalProperties\": true,\n \"description\": \"Hints for CLI / setup wizards (e.g. preRotationCount, portable, addMediatorService).\",\n \"type\": \"object\"\n },\n \"description\": {\n \"description\": \"Human-readable description of what the template provisions.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"document\": {\n \"description\": \"The DID document body with `{TOKEN}` placeholders. `document.id` MUST contain the `{DID}` placeholder. Every `{TOKEN}` MUST be declared in requiredVars/optionalVars or be a reserved ambient name.\",\n \"type\": \"object\"\n },\n \"kind\": {\n \"description\": \"Classification hint, e.g. `mediator`, `did-host-http`, `app`. Drives downstream provisioning behaviour.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"methods\": {\n \"description\": \"DID methods this template targets, e.g. [\\\"webvh\\\", \\\"web\\\"] for a hosted DID or [\\\"key\\\"] for a did:key.\",\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"name\": {\n \"description\": \"Template id within its scope. Lowercase alphanumeric and hyphen only.\",\n \"maxLength\": 64,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9-]+$\",\n \"type\": \"string\"\n },\n \"optionalVars\": {\n \"additionalProperties\": true,\n \"description\": \"Variables with default values, keyed by variable name.\",\n \"type\": \"object\"\n },\n \"requiredVars\": {\n \"description\": \"Variables the caller MUST supply at render time. MUST NOT include reserved ambient names (DID, SIGNING_KEY_MB, KA_KEY_MB, VTA_DID, VTA_URL, CONTEXT_ID, CONTEXT_DID, NOW).\",\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"schemaVersion\": {\n \"const\": 1,\n \"description\": \"Template schema version. Currently always 1.\",\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"schemaVersion\",\n \"name\",\n \"kind\",\n \"document\"\n ],\n \"title\": \"DidTemplate\",\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 \"description\": \"The persisted DidTemplateRecord. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by get/update.\",\n \"properties\": {\n \"createdAt\": {\n \"description\": \"UTC unix-epoch seconds the template was first stored.\",\n \"type\": \"integer\"\n },\n \"createdBy\": {\n \"description\": \"DID of the admin who last wrote the template.\",\n \"type\": \"string\"\n },\n \"defaults\": {\n \"additionalProperties\": true,\n \"type\": \"object\"\n },\n \"description\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"document\": {\n \"type\": \"object\"\n },\n \"kind\": {\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"methods\": {\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"name\": {\n \"maxLength\": 64,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9-]+$\",\n \"type\": \"string\"\n },\n \"optionalVars\": {\n \"additionalProperties\": true,\n \"type\": \"object\"\n },\n \"requiredVars\": {\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"schemaVersion\": {\n \"const\": 1,\n \"type\": \"integer\"\n },\n \"scope\": {\n \"$ref\": \"#/$defs/Scope\",\n \"description\": \"Resolved scope of the stored template.\"\n },\n \"updatedAt\": {\n \"description\": \"UTC unix-epoch seconds of the last write.\",\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"schemaVersion\",\n \"name\",\n \"kind\",\n \"document\",\n \"scope\",\n \"createdAt\",\n \"updatedAt\",\n \"createdBy\"\n ],\n \"title\": \"VTA Context DID-Template Create — response payload\",\n \"type\": \"object\"\n },\n \"Scope\": {\n \"description\": \"Where a stored template lives. Tagged by `type`.\",\n \"oneOf\": [\n {\n \"additionalProperties\": false,\n \"properties\": {\n \"type\": {\n \"const\": \"builtin\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"title\": \"Builtin\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"properties\": {\n \"type\": {\n \"const\": \"global\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"title\": \"Global\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"properties\": {\n \"contextId\": {\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"type\": {\n \"const\": \"context\"\n }\n },\n \"required\": [\n \"type\",\n \"contextId\"\n ],\n \"title\": \"Context\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"Scope\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/vta/contexts/did-templates/create/1.0\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"Create a new DID template scoped to a context on a VTA. Gated on the context's admin (or super-admin). The template's own `name` is the resource id within the context scope; the VTA refuses duplicates (use update to replace). The success response is the persisted DidTemplateRecord.\",\n \"properties\": {\n \"contextId\": {\n \"description\": \"The context the template is scoped to.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\",\n \"description\": \"Ecosystem-defined extension members per SPEC.md §4.5.1.\"\n },\n \"template\": {\n \"$ref\": \"#/$defs/DidTemplate\",\n \"description\": \"Full template document to store. Validated against the v1 template schema before persistence; an invalid shape is rejected with the framework's `malformedRequest`.\"\n }\n },\n \"required\": [\n \"contextId\",\n \"template\"\n ],\n \"title\": \"VTA Context DID-Template Create — payload\",\n \"type\": \"object\"\n}\n";
}
#[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\": \"0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9\",\n \"type\": \"https://trusttasks.org/spec/vta/contexts/did-templates/create/1.0\",\n \"issuer\": \"did:web:admin.example\",\n \"recipient\": \"did:web:vta.example\",\n \"issuedAt\": \"2026-06-16T09:00:00Z\",\n \"payload\": {\n \"contextId\": \"primary\",\n \"template\": {\n \"schemaVersion\": 1,\n \"name\": \"messaging-bridge\",\n \"kind\": \"messaging-bridge\",\n \"description\": \"DIDComm messaging bridge host.\",\n \"methods\": [\"webvh\", \"web\"],\n \"requiredVars\": [\"MEDIATOR_DID\"],\n \"optionalVars\": { \"ACCEPT\": [\"didcomm/v2\"] },\n \"defaults\": { \"preRotationCount\": 2 },\n \"document\": {\n \"id\": \"{DID}\",\n \"verificationMethod\": [\n {\n \"id\": \"{DID}#{SIGNING_KEY_MB}\",\n \"type\": \"Multikey\",\n \"controller\": \"{DID}\",\n \"publicKeyMultibase\": \"{SIGNING_KEY_MB}\"\n }\n ],\n \"service\": [\n {\n \"id\": \"{DID}#didcomm\",\n \"type\": \"DIDCommMessaging\",\n \"serviceEndpoint\": { \"uri\": \"{MEDIATOR_DID}\", \"accept\": \"{ACCEPT}\" }\n }\n ]\n }\n }\n },\n \"proof\": {\n \"type\": \"DataIntegrityProof\",\n \"cryptosuite\": \"eddsa-rdfc-2022\",\n \"verificationMethod\": \"did:web:admin.example#key-1\",\n \"created\": \"2026-06-16T09: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 response_example_1() {
const JSON: &str = "{\n \"id\": \"1b2c3d4e-5f60-7182-93a4-b5c6d7e8f9a0\",\n \"type\": \"https://trusttasks.org/spec/vta/contexts/did-templates/create/1.0#response\",\n \"threadId\": \"0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9\",\n \"issuer\": \"did:web:vta.example\",\n \"recipient\": \"did:web:admin.example\",\n \"issuedAt\": \"2026-06-16T09:00:01Z\",\n \"payload\": {\n \"schemaVersion\": 1,\n \"name\": \"messaging-bridge\",\n \"kind\": \"messaging-bridge\",\n \"description\": \"DIDComm messaging bridge host.\",\n \"methods\": [\"webvh\", \"web\"],\n \"requiredVars\": [\"MEDIATOR_DID\"],\n \"optionalVars\": { \"ACCEPT\": [\"didcomm/v2\"] },\n \"defaults\": { \"preRotationCount\": 2 },\n \"document\": {\n \"id\": \"{DID}\",\n \"verificationMethod\": [\n {\n \"id\": \"{DID}#{SIGNING_KEY_MB}\",\n \"type\": \"Multikey\",\n \"controller\": \"{DID}\",\n \"publicKeyMultibase\": \"{SIGNING_KEY_MB}\"\n }\n ],\n \"service\": [\n {\n \"id\": \"{DID}#didcomm\",\n \"type\": \"DIDCommMessaging\",\n \"serviceEndpoint\": { \"uri\": \"{MEDIATOR_DID}\", \"accept\": \"{ACCEPT}\" }\n }\n ]\n },\n \"scope\": { \"type\": \"context\", \"contextId\": \"primary\" },\n \"createdAt\": 1781600401,\n \"updatedAt\": 1781600401,\n \"createdBy\": \"did:web:admin.example\"\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");
}
}