@openvtc/trust-tasks 0.27.4 → 0.27.5

package/src/auth/step-up/approver/invite/0.2/payload.ts

@@ -0,0 +1,258 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/step-up/approver/invite/0.2/payload.schema.json
+ */
+
+import type { ApproverLabel, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * An administrator asks the relying party for a single-use invite, redeemed by the invited subject with a separately delivered claim code, to bind a step-up approver to that subject. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface AuthStepUpApproverInvitePayload {
+  /**
+   * The DID invited to bind a step-up approver. MUST be a subject the relying party recognises, and MUST NOT be the administrator issuing the invite.
+   */
+  subject: string;
+  /**
+   * A suggested label for the approver. The subject MAY override it at redeem/finish.
+   */
+  label?: ApproverLabel;
+  /**
+   * Seconds the invite stays redeemable. Default 900 (15 minutes). The relying party refuses more than 86400 (24 hours), or more than its own lower cap, with `ttlTooLong`.
+   */
+  ttlSeconds?: number;
+  ext?: Ext;
+}
+/**
+ * The issued invite. The claim code is returned only here.
+ */
+export interface AuthStepUpApproverInviteResponsePayload {
+  /**
+   * The relying party's identifier for the invite, for audit and administration. Not a redemption factor: it is neither the token nor derivable from it.
+   */
+  inviteId: string;
+  /**
+   * Where the invited subject redeems the invite. Carries the single-use token (≥128 bits). MUST NOT carry the claim code.
+   */
+  url: string;
+  /**
+   * A short code (≥40 bits) the invited subject types at redemption, returned exactly once. Delivered by the administrator over a different channel from `url`. The relying party stores only a slow hash of it.
+   */
+  claimCode: string;
+  /**
+   * When the invite stops being redeemable.
+   */
+  expiresAt: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ApproverLabel, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/auth/step-up/approver/invite/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthStepUpApproverInvitePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/step-up/approver/invite/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthStepUpApproverInviteResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/auth/step-up/approver/invite/0.2",
+  "title": "Auth — Step-up Approver Invite — payload",
+  "description": "An administrator asks the relying party for a single-use invite, redeemed by the invited subject with a separately delivered claim code, to bind a step-up approver to that subject. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "subject"
+  ],
+  "properties": {
+    "subject": {
+      "type": "string",
+      "pattern": "^did:",
+      "minLength": 5,
+      "maxLength": 2048,
+      "description": "The DID invited to bind a step-up approver. MUST be a subject the relying party recognises, and MUST NOT be the administrator issuing the invite."
+    },
+    "label": {
+      "$ref": "#/$defs/ApproverLabel",
+      "description": "A suggested label for the approver. The subject MAY override it at redeem/finish."
+    },
+    "ttlSeconds": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Seconds the invite stays redeemable. Default 900 (15 minutes). The relying party refuses more than 86400 (24 hours), or more than its own lower cap, with `ttlTooLong`."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth — Step-up Approver Invite — response payload",
+      "description": "The issued invite. The claim code is returned only here.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "inviteId",
+        "url",
+        "claimCode",
+        "expiresAt"
+      ],
+      "properties": {
+        "inviteId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The relying party's identifier for the invite, for audit and administration. Not a redemption factor: it is neither the token nor derivable from it."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "Where the invited subject redeems the invite. Carries the single-use token (≥128 bits). MUST NOT carry the claim code."
+        },
+        "claimCode": {
+          "type": "string",
+          "minLength": 8,
+          "maxLength": 64,
+          "description": "A short code (≥40 bits) the invited subject types at redemption, returned exactly once. Delivered by the administrator over a different channel from `url`. The relying party stores only a slow hash of it."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the invite stops being redeemable."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "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-]+)+$"
+      }
+    },
+    "ApproverLabel": {
+      "title": "ApproverLabel",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "description": "A human-readable name for where the approver lives — e.g. `Browser plugin — work laptop`. Chosen by the subject (or suggested by an inviter), untrusted, and attributed to its author wherever it is rendered. Absent rather than invented when none was chosen."
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth — Step-up Approver Invite — response payload",
+      "description": "The issued invite. The claim code is returned only here.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "inviteId",
+        "url",
+        "claimCode",
+        "expiresAt"
+      ],
+      "properties": {
+        "inviteId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The relying party's identifier for the invite, for audit and administration. Not a redemption factor: it is neither the token nor derivable from it."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "Where the invited subject redeems the invite. Carries the single-use token (≥128 bits). MUST NOT carry the claim code."
+        },
+        "claimCode": {
+          "type": "string",
+          "minLength": 8,
+          "maxLength": 64,
+          "description": "A short code (≥40 bits) the invited subject types at redemption, returned exactly once. Delivered by the administrator over a different channel from `url`. The relying party stores only a slow hash of it."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the invite stops being redeemable."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "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-]+)+$"
+      }
+    },
+    "ApproverLabel": {
+      "title": "ApproverLabel",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "description": "A human-readable name for where the approver lives — e.g. `Browser plugin — work laptop`. Chosen by the subject (or suggested by an inviter), untrusted, and attributed to its author wherever it is rendered. Absent rather than invented when none was chosen."
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/device/heartbeat/0.3/payload.ts

@@ -0,0 +1,271 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/device/heartbeat/0.3/payload.schema.json
+ */
+
+import type { Ext } from "../../../_shared/components.js";
+
+
+/**
+ * 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).
+ */
+export interface DeviceHeartbeatPayload {
+  /**
+   * Updated platform descriptor if it changed since registration (e.g. browser updated).
+   */
+  platform?: 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.
+   */
+  vaultSeq?: number;
+  ext?: Ext;
+}
+export interface DeviceHeartbeatResponsePayload {
+  /**
+   * Authoritative timestamp — consumers MAY use to detect clock drift.
+   */
+  respondedAt: string;
+  /**
+   * Operations the maintainer queued for this device while it was offline. The consumer MUST execute these in order before any other op.
+   */
+  queuedOperations?: QueuedOperation[];
+  /**
+   * Tells the consumer whether to call vault/sync.
+   */
+  syncHint?: "upToDate" | "syncDue" | "fullResyncRequired";
+  ext?: Ext;
+}
+export interface QueuedOperation {
+  /**
+   * Discriminator. The framework currently supports wipe; future versions may add others.
+   */
+  kind: "wipe" | "policyReload" | "configUpdate";
+  /**
+   * 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.
+   */
+  task: {
+    [k: string]: unknown | undefined;
+  };
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/device/heartbeat/0.3" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = DeviceHeartbeatPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/device/heartbeat/0.3#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = DeviceHeartbeatResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/device/heartbeat/0.3",
+  "title": "Device Heartbeat — 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",
+  "additionalProperties": false,
+  "properties": {
+    "platform": {
+      "type": "string",
+      "description": "Updated platform descriptor if it changed since registration (e.g. browser updated)."
+    },
+    "vaultSeq": {
+      "type": "integer",
+      "minimum": 0,
+      "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."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Device Heartbeat — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "respondedAt"
+      ],
+      "properties": {
+        "respondedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Authoritative timestamp — consumers MAY use to detect clock drift."
+        },
+        "queuedOperations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/QueuedOperation"
+          },
+          "description": "Operations the maintainer queued for this device while it was offline. The consumer MUST execute these in order before any other op."
+        },
+        "syncHint": {
+          "type": "string",
+          "enum": [
+            "upToDate",
+            "syncDue",
+            "fullResyncRequired"
+          ],
+          "description": "Tells the consumer whether to call vault/sync."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "QueuedOperation": {
+      "title": "QueuedOperation",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "task"
+      ],
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "wipe",
+            "policyReload",
+            "configUpdate"
+          ],
+          "description": "Discriminator. The framework currently supports wipe; future versions may add others."
+        },
+        "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."
+        }
+      }
+    },
+    "Ext": {
+      "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Device Heartbeat — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "respondedAt"
+      ],
+      "properties": {
+        "respondedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Authoritative timestamp — consumers MAY use to detect clock drift."
+        },
+        "queuedOperations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/QueuedOperation"
+          },
+          "description": "Operations the maintainer queued for this device while it was offline. The consumer MUST execute these in order before any other op."
+        },
+        "syncHint": {
+          "type": "string",
+          "enum": [
+            "upToDate",
+            "syncDue",
+            "fullResyncRequired"
+          ],
+          "description": "Tells the consumer whether to call vault/sync."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "QueuedOperation": {
+      "title": "QueuedOperation",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "task"
+      ],
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "wipe",
+            "policyReload",
+            "configUpdate"
+          ],
+          "description": "Discriminator. The framework currently supports wipe; future versions may add others."
+        },
+        "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."
+        }
+      }
+    },
+    "Ext": {
+      "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/did-management/_shared/0.2/service-instance.ts

@@ -14,4 +14,4 @@ export interface ServiceInstanceSharedDefinitionForTheDidManagementRegistryReads
  * The definitions this shared schema publishes, hoisted to one declaration each.
  * See "../../../_shared/components.js".
  */
-export type { ServiceInstance_DidManagementV0_2 as ServiceInstance, TransportObservation } from "../../../_shared/components.js";
+export type { ServiceInstance_DidManagementV0_2 as ServiceInstance, TransportObservation_DidManagementV0_2 as TransportObservation } from "../../../_shared/components.js";

package/src/did-management/_shared/0.3/registered-instance.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/_shared/0.3/registered-instance.schema.json
+ */
+
+/**
+ * 0.1's `service-instance` ServiceInstance with its one instant renamed to the registry's `<event>At` convention (`lastSeen` → `lastSeenAt`) and nothing else changed. Kept apart from `service-instance.schema.json`, the richer record the registry reads return, because re-pinning admin-register to that one would change its response beyond the rename. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface ServiceInstanceTheRegistryEntryDidManagementRegistryAdminRegisterReturns {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { RegisteredInstance } from "../../../_shared/components.js";

package/src/did-management/_shared/0.3/service-instance.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/_shared/0.3/service-instance.schema.json
+ */
+
+/**
+ * The control plane's record of one registered service instance, as an administrator reads it. 0.3 renames two instants to the registry's `<event>At` convention (`lastHealthCheck` → `lastHealthCheckAt`, `TransportObservation.at` → `observedAt`); 0.2 added what an operator needs to judge an instance's health and reachability — its service type, status, the transports it advertises and was last seen on, and the DID methods it can host. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface ServiceInstanceSharedDefinitionForTheDidManagementRegistryReads {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { ServiceInstance_DidManagementV0_3 as ServiceInstance, TransportObservation_DidManagementV0_3 as TransportObservation } from "../../../_shared/components.js";