//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `device/heartbeat`. 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())
}
}
}
///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<&Ext> for Ext {
fn from(value: &Ext) -> Self {
value.clone()
}
}
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::convert::From<&ExtKey> for ExtKey {
fn from(value: &ExtKey) -> Self {
value.clone()
}
}
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())
})
}
}
///Periodic check-in from a Companion or Service. Refreshes `lastSeenAt`, carries optional state digests, and gives the maintainer a chance to deliver queued operations (notably queued wipes for targets that were offline at issuance).
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/device/heartbeat/0.1",
/// "title": "Payload",
/// "description": "Periodic check-in from a Companion or Service. Refreshes `lastSeenAt`, carries optional state digests, and gives the maintainer a chance to deliver queued operations (notably queued wipes for targets that were offline at issuance).",
/// "type": "object",
/// "properties": {
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "platform": {
/// "description": "Updated platform descriptor if it changed since registration (e.g. browser updated).",
/// "type": "string"
/// },
/// "vaultSeq": {
/// "description": "Optional — consumer's current sync baseline. If the maintainer notices a gap (consumer is behind), the response can hint that a vault/sync is due.",
/// "type": "integer",
/// "minimum": 0.0
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Payload {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Updated platform descriptor if it changed since registration (e.g. browser updated).
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub platform: ::std::option::Option<::std::string::String>,
///Optional — consumer's current sync baseline. If the maintainer notices a gap (consumer is behind), the response can hint that a vault/sync is due.
#[serde(
rename = "vaultSeq",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub vault_seq: ::std::option::Option<u64>,
}
impl ::std::convert::From<&Payload> for Payload {
fn from(value: &Payload) -> Self {
value.clone()
}
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Default::default(),
platform: Default::default(),
vault_seq: Default::default(),
}
}
}
///`QueuedOperation`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "QueuedOperation",
/// "type": "object",
/// "required": [
/// "kind",
/// "task"
/// ],
/// "properties": {
/// "kind": {
/// "description": "Discriminator. The framework currently supports wipe; future versions may add others.",
/// "type": "string",
/// "enum": [
/// "wipe",
/// "policy-reload",
/// "config-update"
/// ]
/// },
/// "task": {
/// "description": "The full Trust Task document the consumer would have received if it had been online (e.g. a device/wipe/0.1 document). Consumer verifies and executes as if it had been received normally."
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct QueuedOperation {
///Discriminator. The framework currently supports wipe; future versions may add others.
pub kind: QueuedOperationKind,
///The full Trust Task document the consumer would have received if it had been online (e.g. a device/wipe/0.1 document). Consumer verifies and executes as if it had been received normally.
pub task: ::serde_json::Value,
}
impl ::std::convert::From<&QueuedOperation> for QueuedOperation {
fn from(value: &QueuedOperation) -> Self {
value.clone()
}
}
///Discriminator. The framework currently supports wipe; future versions may add others.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Discriminator. The framework currently supports wipe; future versions may add others.",
/// "type": "string",
/// "enum": [
/// "wipe",
/// "policy-reload",
/// "config-update"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
pub enum QueuedOperationKind {
#[serde(rename = "wipe")]
Wipe,
#[serde(rename = "policy-reload")]
PolicyReload,
#[serde(rename = "config-update")]
ConfigUpdate,
}
impl ::std::convert::From<&Self> for QueuedOperationKind {
fn from(value: &QueuedOperationKind) -> Self {
value.clone()
}
}
impl ::std::fmt::Display for QueuedOperationKind {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Wipe => f.write_str("wipe"),
Self::PolicyReload => f.write_str("policy-reload"),
Self::ConfigUpdate => f.write_str("config-update"),
}
}
}
impl ::std::str::FromStr for QueuedOperationKind {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"wipe" => Ok(Self::Wipe),
"policy-reload" => Ok(Self::PolicyReload),
"config-update" => Ok(Self::ConfigUpdate),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for QueuedOperationKind {
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 QueuedOperationKind {
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 QueuedOperationKind {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///`Response`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "type": "object",
/// "required": [
/// "serverTime"
/// ],
/// "properties": {
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "queuedOperations": {
/// "description": "Operations the maintainer queued for this device while it was offline. The consumer MUST execute these in order before any other op.",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/QueuedOperation"
/// }
/// },
/// "serverTime": {
/// "description": "Authoritative timestamp — consumers MAY use to detect clock drift.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "syncHint": {
/// "description": "Tells the consumer whether to call vault/sync.",
/// "type": "string",
/// "enum": [
/// "up-to-date",
/// "sync-due",
/// "full-resync-required"
/// ]
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Response {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Operations the maintainer queued for this device while it was offline. The consumer MUST execute these in order before any other op.
#[serde(
rename = "queuedOperations",
default,
skip_serializing_if = "::std::vec::Vec::is_empty"
)]
pub queued_operations: ::std::vec::Vec<QueuedOperation>,
///Authoritative timestamp — consumers MAY use to detect clock drift.
#[serde(rename = "serverTime")]
pub server_time: ::chrono::DateTime<::chrono::offset::Utc>,
///Tells the consumer whether to call vault/sync.
#[serde(
rename = "syncHint",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub sync_hint: ::std::option::Option<ResponseSyncHint>,
}
impl ::std::convert::From<&Response> for Response {
fn from(value: &Response) -> Self {
value.clone()
}
}
///Tells the consumer whether to call vault/sync.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Tells the consumer whether to call vault/sync.",
/// "type": "string",
/// "enum": [
/// "up-to-date",
/// "sync-due",
/// "full-resync-required"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
pub enum ResponseSyncHint {
#[serde(rename = "up-to-date")]
UpToDate,
#[serde(rename = "sync-due")]
SyncDue,
#[serde(rename = "full-resync-required")]
FullResyncRequired,
}
impl ::std::convert::From<&Self> for ResponseSyncHint {
fn from(value: &ResponseSyncHint) -> Self {
value.clone()
}
}
impl ::std::fmt::Display for ResponseSyncHint {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::UpToDate => f.write_str("up-to-date"),
Self::SyncDue => f.write_str("sync-due"),
Self::FullResyncRequired => f.write_str("full-resync-required"),
}
}
}
impl ::std::str::FromStr for ResponseSyncHint {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"up-to-date" => Ok(Self::UpToDate),
"sync-due" => Ok(Self::SyncDue),
"full-resync-required" => Ok(Self::FullResyncRequired),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for ResponseSyncHint {
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 ResponseSyncHint {
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 ResponseSyncHint {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/device/heartbeat/0.1";
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/device/heartbeat/0.1#response";
}
#[cfg(feature = "validate")]
impl crate::validate::ValidatedPayload for Payload {
const SCHEMA_JSON: &'static str = "{\n \"$defs\": {\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 \"QueuedOperation\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"kind\": {\n \"description\": \"Discriminator. The framework currently supports wipe; future versions may add others.\",\n \"enum\": [\n \"wipe\",\n \"policy-reload\",\n \"config-update\"\n ],\n \"type\": \"string\"\n },\n \"task\": {\n \"description\": \"The full Trust Task document the consumer would have received if it had been online (e.g. a device/wipe/0.1 document). Consumer verifies and executes as if it had been received normally.\"\n }\n },\n \"required\": [\n \"kind\",\n \"task\"\n ],\n \"title\": \"QueuedOperation\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"queuedOperations\": {\n \"description\": \"Operations the maintainer queued for this device while it was offline. The consumer MUST execute these in order before any other op.\",\n \"items\": {\n \"$ref\": \"#/$defs/QueuedOperation\"\n },\n \"type\": \"array\"\n },\n \"serverTime\": {\n \"description\": \"Authoritative timestamp — consumers MAY use to detect clock drift.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"syncHint\": {\n \"description\": \"Tells the consumer whether to call vault/sync.\",\n \"enum\": [\n \"up-to-date\",\n \"sync-due\",\n \"full-resync-required\"\n ],\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"serverTime\"\n ],\n \"title\": \"Device Heartbeat — response payload\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/device/heartbeat/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"Periodic check-in from a Companion or Service. Refreshes `lastSeenAt`, carries optional state digests, and gives the maintainer a chance to deliver queued operations (notably queued wipes for targets that were offline at issuance).\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"platform\": {\n \"description\": \"Updated platform descriptor if it changed since registration (e.g. browser updated).\",\n \"type\": \"string\"\n },\n \"vaultSeq\": {\n \"description\": \"Optional — consumer's current sync baseline. If the maintainer notices a gap (consumer is behind), the response can hint that a vault/sync is due.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n }\n },\n \"title\": \"Device Heartbeat — payload\",\n \"type\": \"object\"\n}\n";
}