@openvtc/trust-tasks 0.21.4 → 0.21.6

package/src/auth/revoke-session/0.2/payload.ts

@@ -0,0 +1,268 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/revoke-session/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../_shared/components.js";
+
+
+/**
+ * Invalidate one named session, every session of the producer, or every session of a named subject the producer may manage. The auth service drops the targeted session(s); any future use of their access or refresh tokens MUST fail. Exactly one of `sessionId`, `all` and `subject` is present.
+ */
+export type AuthRevokeSession = {
+  /**
+   * The session to revoke. Mutually exclusive with `all` and `subject`.
+   */
+  sessionId?: string;
+  /**
+   * When true, revoke every active session the consumer holds for the producer's own subject — equivalent to `subject` naming the producer. `false` targets nothing and is refused as malformedRequest; it stays schema-valid only because 0.1 admitted it. Mutually exclusive with `sessionId` and `subject`.
+   */
+  all?: boolean;
+  /**
+   * Revoke every active session the consumer holds for this subject. The producer's own identifier, or a subject whose access the producer could withdraw under the consumer's access-control policy — see Authorization. Mutually exclusive with `sessionId` and `all`.
+   */
+  subject?: string;
+  /**
+   * Optional human-readable rationale (e.g. "logout", "device-lost", "access-withdrawn"). Surfaced in audit logs; the framework imposes no vocabulary.
+   */
+  reason?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+} & {
+  [k: string]: unknown | undefined;
+};
+
+/**
+ * Acknowledgement carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/revoke-session/0.2#response.
+ */
+export interface AuthRevokeSessionResponsePayload {
+  /**
+   * Number of sessions this request invalidated. Zero is a valid outcome: the named session was already gone, or the subject held no active sessions.
+   */
+  revokedCount: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** 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/auth/revoke-session/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthRevokeSession;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/revoke-session/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthRevokeSessionResponsePayload;
+
+/**
+ * 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/revoke-session/0.2",
+  "title": "Auth — Revoke Session",
+  "description": "Invalidate one named session, every session of the producer, or every session of a named subject the producer may manage. The auth service drops the targeted session(s); any future use of their access or refresh tokens MUST fail. Exactly one of `sessionId`, `all` and `subject` is present.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "sessionId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The session to revoke. Mutually exclusive with `all` and `subject`."
+    },
+    "all": {
+      "type": "boolean",
+      "description": "When true, revoke every active session the consumer holds for the producer's own subject — equivalent to `subject` naming the producer. `false` targets nothing and is refused as malformedRequest; it stays schema-valid only because 0.1 admitted it. Mutually exclusive with `sessionId` and `subject`."
+    },
+    "subject": {
+      "type": "string",
+      "pattern": "^did:",
+      "maxLength": 2048,
+      "description": "Revoke every active session the consumer holds for this subject. The producer's own identifier, or a subject whose access the producer could withdraw under the consumer's access-control policy — see Authorization. Mutually exclusive with `sessionId` and `all`."
+    },
+    "reason": {
+      "type": "string",
+      "maxLength": 1024,
+      "description": "Optional human-readable rationale (e.g. \"logout\", \"device-lost\", \"access-withdrawn\"). Surfaced in audit logs; the framework imposes no vocabulary."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "oneOf": [
+    {
+      "required": [
+        "sessionId"
+      ],
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "all"
+            ]
+          },
+          {
+            "required": [
+              "subject"
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "required": [
+        "all"
+      ],
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "sessionId"
+            ]
+          },
+          {
+            "required": [
+              "subject"
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "required": [
+        "subject"
+      ],
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "sessionId"
+            ]
+          },
+          {
+            "required": [
+              "all"
+            ]
+          }
+        ]
+      }
+    }
+  ],
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth Revoke Session — response payload",
+      "description": "Acknowledgement carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/revoke-session/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "revokedCount"
+      ],
+      "properties": {
+        "revokedCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of sessions this request invalidated. Zero is a valid outcome: the named session was already gone, or the subject held no active sessions."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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": "Auth Revoke Session — response payload",
+      "description": "Acknowledgement carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/revoke-session/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "revokedCount"
+      ],
+      "properties": {
+        "revokedCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of sessions this request invalidated. Zero is a valid outcome: the named session was already gone, or the subject held no active sessions."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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: 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/auth/step-up/start/0.1/payload.ts

@@ -0,0 +1,287 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/step-up/start/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface AuthStepUpStartPayload {
+  /**
+   * The relying-party session to elevate.
+   */
+  sessionId: string;
+  /**
+   * The assurance level the holder wants the session raised to. Absent means the relying party's own next level above the session's current one.
+   */
+  targetAcr?: string;
+  ext?: Ext;
+}
+export interface AuthStepUpStartResponsePayload {
+  /**
+   * A complete, signed auth/step-up/approve-request/0.3 document for this session: issuer the relying party, recipient the approver. The approver verifies it on its own terms; the framework-level envelope members are modelled here so none are lost on receipt, but `payload` and `proof` are carried opaque (unpacked and re-validated by that spec, not by this one) so the proof survives.
+   */
+  approveRequest: {
+    id: string;
+    type: "https://trusttasks.org/spec/auth/step-up/approve-request/0.3";
+    threadId?: string;
+    issuer: string;
+    recipient: string;
+    issuedAt?: string;
+    expiresAt?: string;
+    /**
+     * The auth/step-up/approve-request/0.3 payload, opaque here — see that spec for its shape.
+     */
+    payload: {
+      [k: string]: unknown | undefined;
+    };
+    /**
+     * A W3C Data Integrity proof (SPEC §4.7), opaque here — the approver verifies it on its own terms.
+     */
+    proof: {};
+    ext?: Ext;
+  };
+  ext?: Ext;
+}
+
+/** 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/auth/step-up/start/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthStepUpStartPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/step-up/start/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthStepUpStartResponsePayload;
+
+/**
+ * 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/start/0.1",
+  "title": "Auth Step-up Start — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "sessionId"
+  ],
+  "properties": {
+    "sessionId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "The relying-party session to elevate."
+    },
+    "targetAcr": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The assurance level the holder wants the session raised to. Absent means the relying party's own next level above the session's current one."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth Step-up Start — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "approveRequest"
+      ],
+      "properties": {
+        "approveRequest": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "A complete, signed auth/step-up/approve-request/0.3 document for this session: issuer the relying party, recipient the approver. The approver verifies it on its own terms; the framework-level envelope members are modelled here so none are lost on receipt, but `payload` and `proof` are carried opaque (unpacked and re-validated by that spec, not by this one) so the proof survives.",
+          "required": [
+            "id",
+            "type",
+            "issuer",
+            "recipient",
+            "payload",
+            "proof"
+          ],
+          "properties": {
+            "id": {
+              "type": "string",
+              "minLength": 1
+            },
+            "type": {
+              "const": "https://trusttasks.org/spec/auth/step-up/approve-request/0.3"
+            },
+            "threadId": {
+              "type": "string",
+              "minLength": 1
+            },
+            "issuer": {
+              "type": "string",
+              "minLength": 1
+            },
+            "recipient": {
+              "type": "string",
+              "minLength": 1
+            },
+            "issuedAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "expiresAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "payload": {
+              "description": "The auth/step-up/approve-request/0.3 payload, opaque here — see that spec for its shape."
+            },
+            "proof": {
+              "type": "object",
+              "description": "A W3C Data Integrity proof (SPEC §4.7), opaque here — the approver verifies it on its own terms."
+            },
+            "ext": {
+              "$ref": "#/$defs/Ext"
+            }
+          }
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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 Start — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "approveRequest"
+      ],
+      "properties": {
+        "approveRequest": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "A complete, signed auth/step-up/approve-request/0.3 document for this session: issuer the relying party, recipient the approver. The approver verifies it on its own terms; the framework-level envelope members are modelled here so none are lost on receipt, but `payload` and `proof` are carried opaque (unpacked and re-validated by that spec, not by this one) so the proof survives.",
+          "required": [
+            "id",
+            "type",
+            "issuer",
+            "recipient",
+            "payload",
+            "proof"
+          ],
+          "properties": {
+            "id": {
+              "type": "string",
+              "minLength": 1
+            },
+            "type": {
+              "const": "https://trusttasks.org/spec/auth/step-up/approve-request/0.3"
+            },
+            "threadId": {
+              "type": "string",
+              "minLength": 1
+            },
+            "issuer": {
+              "type": "string",
+              "minLength": 1
+            },
+            "recipient": {
+              "type": "string",
+              "minLength": 1
+            },
+            "issuedAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "expiresAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "payload": {
+              "description": "The auth/step-up/approve-request/0.3 payload, opaque here — see that spec for its shape."
+            },
+            "proof": {
+              "type": "object",
+              "description": "A W3C Data Integrity proof (SPEC §4.7), opaque here — the approver verifies it on its own terms."
+            },
+            "ext": {
+              "$ref": "#/$defs/Ext"
+            }
+          }
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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/did-management/_shared/0.1/service-instance.ts

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

package/src/did-management/_shared/0.2/metrics-snapshot.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/_shared/0.2/metrics-snapshot.schema.json
+ */
+
+/**
+ * A point-in-time read of a service's own operational counters, gauges and histograms — the shape a Trust Task returns in place of a Prometheus `/metrics` endpoint. Deliberately generic: any service in this ecosystem can reuse it for its own `server/metrics`-shaped task, not only a DID hosting service. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface MetricsSnapshotSharedDefinitionForAServiceSOperationalMetrics {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { Histogram, HistogramBucket, Metric, MetricsSnapshot } from "../../../_shared/components.js";

package/src/did-management/_shared/0.2/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.2/service-instance.schema.json
+ */
+
+/**
+ * The control plane's record of one registered service instance, as an administrator reads it. 0.2 adds 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_2 as ServiceInstance, TransportObservation } from "../../../_shared/components.js";