@openvtc/trust-tasks 0.21.4 → 0.21.6

package/src/_shared/components.ts

@@ -2777,6 +2777,43 @@ export interface GitNamespace {
    */
   state: "pending" | "bound";
 }
+/**
+ * One histogram's distribution, in the Prometheus cumulative-bucket convention: each bucket's `count` includes every observation at or below its `le`.
+ */
+export interface Histogram {
+  /**
+   * The histogram's stable name (e.g. `did_hosting_resolve_seconds`).
+   */
+  name: string;
+  /**
+   * Dimensions the distribution is broken down by. Absent or empty when the histogram carries none.
+   */
+  labels?: {
+    [k: string]: string | undefined;
+  };
+  /**
+   * Total number of observations.
+   */
+  count: number;
+  /**
+   * Sum of all observed values.
+   */
+  sum: number;
+  /**
+   * Cumulative buckets, ordered by ascending `le`. Empty when the service exposes no bucket breakdown for this histogram — count and sum still apply. Always present, for the same reason as the snapshot's own arrays.
+   */
+  buckets: HistogramBucket[];
+}
+export interface HistogramBucket {
+  /**
+   * Upper bound of this bucket, inclusive. The final bucket conventionally reports the same value as the histogram's own `count` at whatever `le` the service treats as its ceiling.
+   */
+  le: number;
+  /**
+   * Number of observations at or below `le`.
+   */
+  count: number;
+}
 /**
  * OpenPGP-style ASCII-armored HPKE bundle — the existing OpenVTC sealed-transfer wire form (X25519-HKDF-SHA256 KEM + ChaCha20-Poly1305 AEAD, framed in armor with Bundle-Id / Digest-Algo headers and a CRC24 checksum). Producer assertion (`did-signed` / `attested` / `pinned-only`) is the integrity / authenticity anchor.
  *
@@ -2850,10 +2887,34 @@ export interface InvitationSummary {
    */
   revokedAt?: string;
 }
+export interface InviteSummary_AuthV0_1 {
+  /**
+   * Consumer-chosen opaque handle for the invite. It is NOT the invite token and MUST NOT be derivable into it; knowing it lets an administrator manage the invite, never redeem it.
+   */
+  inviteId: string;
+  /**
+   * The VID the invite binds a passkey to.
+   */
+  subject: string;
+  /**
+   * What the redeemed credential may authenticate, as in auth/passkey/enroll/invite.
+   */
+  purpose: "session" | "stepUp";
+  /**
+   * The role the invitee receives on redemption. Absent when the consumer applies its default role, and always absent for purpose stepUp.
+   */
+  role?: string;
+  createdAt: string;
+  expiresAt: string;
+  /**
+   * True when expiresAt has passed. An expired invite can no longer be redeemed; it is listed until the consumer's cleanup removes it.
+   */
+  expired: boolean;
+}
 /**
  * One outstanding or historical admin invite. Consumed rows are retained as audit history and cannot be revoked.
  */
-export interface InviteSummary {
+export interface InviteSummary_VtcV0_1 {
   /**
    * Unique invite identifier; the revoke target.
    */
@@ -3224,6 +3285,44 @@ export interface MessageMeta {
    */
   deliveredAt?: string;
 }
+/**
+ * One counter or gauge reading.
+ */
+export interface Metric {
+  /**
+   * The metric's stable name (e.g. `did_hosting_requests_total`). Implementation-defined; the framework imposes no vocabulary.
+   */
+  name: string;
+  /**
+   * The current reading.
+   */
+  value: number;
+  /**
+   * Dimensions the value is broken down by (e.g. `{"method": "resolve"}`). Absent or empty when the metric carries none.
+   */
+  labels?: {
+    [k: string]: string | undefined;
+  };
+}
+export interface MetricsSnapshot {
+  /**
+   * When the service read these values from its own instrumentation. Not the same as the envelope's issuedAt when a snapshot is cached briefly before answering.
+   */
+  takenAt: string;
+  /**
+   * Monotonically increasing totals (e.g. requests served, errors raised). Empty when the service exposes none. Always present, so a collector can tell "no counters" from "the field was dropped".
+   */
+  counters: Metric[];
+  /**
+   * Point-in-time values that can rise or fall (e.g. open connections, queue depth). Empty when the service exposes none. Always present, for the same reason as counters.
+   */
+  gauges: Metric[];
+  /**
+   * Distributions of observed values (e.g. request latency). Empty when the service exposes none. Always present, for the same reason as counters.
+   */
+  histograms: Histogram[];
+  ext?: Ext;
+}
 /**
  * One observed step in the life of one message at the mediator. Carries metadata only — never a message body.
  */
@@ -4474,7 +4573,7 @@ export interface SealedRecord {
    */
   epoch: number;
 }
-export interface ServiceInstance {
+export interface ServiceInstance_DidManagementV0_1 {
   /**
    * Stable identifier the control plane uses for this instance. SHOULD be derived from the instance's DID (e.g. `did:web:host.example` → `did_web_host_example`) so it survives restarts.
    */
@@ -4492,6 +4591,62 @@ export interface ServiceInstance {
   lastSeen?: string;
   ext?: Ext;
 }
+export interface ServiceInstance_DidManagementV0_2 {
+  /**
+   * Stable identifier the control plane uses for this instance. SHOULD be derived from the instance's DID so it survives restarts.
+   */
+  instanceId: string;
+  /**
+   * The instance's own DID — the identity its signed documents are verified against and the one the control plane addresses.
+   */
+  did: string;
+  /**
+   * `server` — a hosting server (edge) that resolves DIDs the control plane syncs to it. `witness` — a did:webvh witness. `watcher` — a did:webvh watcher that mirrors logs.
+   */
+  serviceType: "server" | "witness" | "watcher";
+  /**
+   * Operator-chosen display label. Untrusted free text.
+   */
+  label?: string;
+  /**
+   * The instance's public base URL, where it serves DID resolution. Absent when the instance registered without one.
+   */
+  publicUrl?: string;
+  /**
+   * The control plane's current verdict, from the instance's last answered health probe. `degraded` — answered late; `unreachable` — has not answered within the control plane's configured window.
+   */
+  status: "active" | "degraded" | "unreachable";
+  /**
+   * Hosting domains the instance has acknowledged serving. Always present — empty for an instance that serves none, which includes every `witness` and `watcher`.
+   */
+  servedDomains: string[];
+  /**
+   * DID methods the instance can host (e.g. `webvh`, `web`, `webs`), as it declared at registration.
+   */
+  enabledMethods?: string[];
+  /**
+   * `service[].type` values of the instance's DID document when the control plane last resolved it. Display only: nothing is routed on it. Absent when the document has not been resolved.
+   */
+  advertisedServices?: string[];
+  /**
+   * When `advertisedServices` was last resolved. Absent with it.
+   */
+  servicesCheckedAt?: string;
+  /**
+   * The last document the control plane received from this instance. Absent when it has received none.
+   */
+  lastInbound?: TransportObservation;
+  /**
+   * The last document the control plane delivered to this instance. Absent when it has delivered none.
+   */
+  lastOutbound?: TransportObservation;
+  /**
+   * When the instance last answered a health probe. Absent when it never has.
+   */
+  lastHealthCheck?: string;
+  registeredAt: string;
+  ext?: Ext;
+}
 /**
  * The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.
  */
@@ -4729,6 +4884,33 @@ export interface Sync {
    */
   drift: DriftItem[];
 }
+export interface SyncUpdate {
+  /**
+   * The slot path on its hosting domain (e.g. `alice`, `people/alice`, or `.well-known` for a root DID).
+   */
+  mnemonic: string;
+  /**
+   * The DID the log establishes. A replica MUST refuse a log that does not establish exactly this DID.
+   */
+  didId: string;
+  /**
+   * The slot's complete did.jsonl — one log entry per line — not a delta.
+   */
+  logContent: string;
+  /**
+   * The slot's did-witness.json. ABSENT means the slot holds no witness proofs: the replica MUST drop any witness proofs it holds for the slot. Absence never means "unchanged".
+   */
+  witnessContent?: string;
+  /**
+   * Number of entries in `logContent`, as the source counts them. A replica MUST refuse an update whose `logContent` does not contain exactly this many entries.
+   */
+  versionCount: number;
+  /**
+   * Whether the source has disabled the slot. A replica MUST stop serving a disabled slot and MUST resume only on an update carrying `false`.
+   */
+  disabled: boolean;
+  ext?: Ext;
+}
 /**
  * An access token (typically short-lived JWT) paired with an optional refresh token (typically long-lived opaque string). The shapes follow OAuth 2.0 (RFC 6749 §5.1) conventions but are not coupled to any particular OAuth profile.
  */
@@ -4775,6 +4957,13 @@ export interface TrafficOutcome {
    */
   detail?: string;
 }
+export interface TransportObservation {
+  /**
+   * The binding the document actually travelled on.
+   */
+  transport: "tsp" | "didcomm" | "https";
+  at: string;
+}
 export interface TrustRecord {
   entity_id: string;
   authority_id: string;
@@ -5343,6 +5532,25 @@ export interface WebvhServerRecord {
   updatedAt: string;
   ext?: Ext;
 }
+export interface WitnessKey {
+  /**
+   * The witness service's identifier for this identity. Opaque to the requester.
+   */
+  witnessId: string;
+  /**
+   * The witness identity's DID (for example a `did:key`) — the value a did:webvh log names in its `witness` parameter, and the controller of the key that signs its proofs.
+   */
+  did: string;
+  /**
+   * Operator-chosen display label. Untrusted free text. Absent when none was given.
+   */
+  label?: string;
+  createdAt: string;
+  /**
+   * How many witness proofs this identity has signed.
+   */
+  proofsSigned: number;
+}
 /**
  * The outcome of one write within a `vta/app-state/put-many` batch. Per-record rather than per-batch, because the default batch mode applies each write on its own merits: a caller flushing ten unrelated edits needs to know which one conflicted, not merely that something did.
  */

package/src/auth/_shared/0.1/passkey-invite.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/_shared/0.1/passkey-invite.schema.json
+ */
+
+/**
+ * What an administrator may read back about a passkey enrolment invite after issuing it. Deliberately omits the invite token, its URL and the claim code: an unredeemed token is a credential to bind a passkey to somebody else's VID, so it is disclosed once, at issuance, and never again.
+ */
+export interface AuthSharedPasskeyInviteSummary {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { InviteSummary_AuthV0_1 as InviteSummary } from "../../../_shared/components.js";

package/src/auth/passkey/enroll/invite/list/0.1/payload.ts

@@ -0,0 +1,266 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/passkey/enroll/invite/list/0.1/payload.schema.json
+ */
+
+import type { Ext, InviteSummary_AuthV0_1 as InviteSummary } from "../../../../../../_shared/components.js";
+
+
+export interface AuthPasskeyInviteListPayload {
+  /**
+   * When true, invites whose expiry has passed are listed too. Absent or false means only unexpired invites are listed.
+   */
+  includeExpired?: boolean;
+  ext?: Ext;
+}
+export interface AuthPasskeyInviteListResponsePayload {
+  /**
+   * Every unredeemed invite within the administrator's authority, newest first.
+   */
+  invites: InviteSummary[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, InviteSummary };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/auth/passkey/enroll/invite/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthPasskeyInviteListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/passkey/enroll/invite/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthPasskeyInviteListResponsePayload;
+
+/**
+ * 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/passkey/enroll/invite/list/0.1",
+  "title": "Auth Passkey Invite List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "includeExpired": {
+      "type": "boolean",
+      "description": "When true, invites whose expiry has passed are listed too. Absent or false means only unexpired invites are listed."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth Passkey Invite List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invites"
+      ],
+      "properties": {
+        "invites": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/InviteSummary"
+          },
+          "description": "Every unredeemed invite within the administrator's authority, newest first."
+        },
+        "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-]+)+$"
+      }
+    },
+    "InviteSummary": {
+      "$anchor": "inviteSummary",
+      "title": "InviteSummary",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "inviteId",
+        "subject",
+        "purpose",
+        "createdAt",
+        "expiresAt",
+        "expired"
+      ],
+      "properties": {
+        "inviteId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Consumer-chosen opaque handle for the invite. It is NOT the invite token and MUST NOT be derivable into it; knowing it lets an administrator manage the invite, never redeem it."
+        },
+        "subject": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The VID the invite binds a passkey to."
+        },
+        "purpose": {
+          "type": "string",
+          "enum": [
+            "session",
+            "stepUp"
+          ],
+          "description": "What the redeemed credential may authenticate, as in auth/passkey/enroll/invite."
+        },
+        "role": {
+          "type": "string",
+          "description": "The role the invitee receives on redemption. Absent when the consumer applies its default role, and always absent for purpose stepUp."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expired": {
+          "type": "boolean",
+          "description": "True when expiresAt has passed. An expired invite can no longer be redeemed; it is listed until the consumer's cleanup removes it."
+        }
+      }
+    }
+  }
+} 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 Passkey Invite List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invites"
+      ],
+      "properties": {
+        "invites": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/InviteSummary"
+          },
+          "description": "Every unredeemed invite within the administrator's authority, newest first."
+        },
+        "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-]+)+$"
+      }
+    },
+    "InviteSummary": {
+      "$anchor": "inviteSummary",
+      "title": "InviteSummary",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "inviteId",
+        "subject",
+        "purpose",
+        "createdAt",
+        "expiresAt",
+        "expired"
+      ],
+      "properties": {
+        "inviteId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Consumer-chosen opaque handle for the invite. It is NOT the invite token and MUST NOT be derivable into it; knowing it lets an administrator manage the invite, never redeem it."
+        },
+        "subject": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The VID the invite binds a passkey to."
+        },
+        "purpose": {
+          "type": "string",
+          "enum": [
+            "session",
+            "stepUp"
+          ],
+          "description": "What the redeemed credential may authenticate, as in auth/passkey/enroll/invite."
+        },
+        "role": {
+          "type": "string",
+          "description": "The role the invitee receives on redemption. Absent when the consumer applies its default role, and always absent for purpose stepUp."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expired": {
+          "type": "boolean",
+          "description": "True when expiresAt has passed. An expired invite can no longer be redeemed; it is listed until the consumer's cleanup removes it."
+        }
+      }
+    }
+  }
+} 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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;