@openvtc/trust-tasks 0.27.3 → 0.27.4

package/src/vtc/auth/recognise/0.3/payload.ts

@@ -0,0 +1,233 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/auth/recognise/0.3/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface VTCAuthRecognisePayload {
+  /**
+   * A holder-signed W3C Verifiable Presentation embedding the foreign membership credential (`MembershipCredential`) and role credential (a Verifiable Authority Credential, `AuthorityCredential`, conferring `role:<name>` at the foreign community's DID) in `verifiableCredential`.
+   *
+   * The holder proof MUST use `proofPurpose: authentication`, MUST commit to the single-use `nonce` issued by `vtc/auth/recognise/challenge`, and MUST name the recognising community's DID as `domain`. A consumer MUST verify the holder proof, verify each embedded credential's issuer proof, and refuse unless the presentation's holder is the credentials' subject.
+   */
+  presentation: {};
+  ext?: Ext;
+}
+export interface VTCAuthRecogniseResponsePayload {
+  /**
+   * A cross-community session id (xc-<uuid>), distinguishing it from local-member sessions.
+   */
+  sessionId: string;
+  data: {
+    accessToken: string;
+    /**
+     * The access token's expiry, as an RFC 3339 date-time, clamped to min(local default, earliest of the vec/vmc validUntil).
+     */
+    accessExpiresAt: string;
+    foreignIssuerDid: string;
+    /**
+     * The LOCAL role from cross_community_roles policy — not the foreign role.
+     */
+    mappedRole: string;
+  };
+  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/vtc/auth/recognise/0.3" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAuthRecognisePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/auth/recognise/0.3#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAuthRecogniseResponsePayload;
+
+/**
+ * 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/vtc/auth/recognise/0.3",
+  "title": "VTC Auth Recognise — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "presentation"
+  ],
+  "properties": {
+    "presentation": {
+      "type": "object",
+      "description": "A holder-signed W3C Verifiable Presentation embedding the foreign membership credential (`MembershipCredential`) and role credential (a Verifiable Authority Credential, `AuthorityCredential`, conferring `role:<name>` at the foreign community's DID) in `verifiableCredential`.\n\nThe holder proof MUST use `proofPurpose: authentication`, MUST commit to the single-use `nonce` issued by `vtc/auth/recognise/challenge`, and MUST name the recognising community's DID as `domain`. A consumer MUST verify the holder proof, verify each embedded credential's issuer proof, and refuse unless the presentation's holder is the credentials' subject."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Auth Recognise — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sessionId",
+        "data"
+      ],
+      "properties": {
+        "sessionId": {
+          "type": "string",
+          "pattern": "^xc-",
+          "description": "A cross-community session id (xc-<uuid>), distinguishing it from local-member sessions."
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "accessToken",
+            "accessExpiresAt",
+            "foreignIssuerDid",
+            "mappedRole"
+          ],
+          "properties": {
+            "accessToken": {
+              "type": "string"
+            },
+            "accessExpiresAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "The access token's expiry, as an RFC 3339 date-time, clamped to min(local default, earliest of the vec/vmc validUntil)."
+            },
+            "foreignIssuerDid": {
+              "type": "string"
+            },
+            "mappedRole": {
+              "type": "string",
+              "description": "The LOCAL role from cross_community_roles policy — not the foreign role."
+            }
+          }
+        },
+        "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": "VTC Auth Recognise — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sessionId",
+        "data"
+      ],
+      "properties": {
+        "sessionId": {
+          "type": "string",
+          "pattern": "^xc-",
+          "description": "A cross-community session id (xc-<uuid>), distinguishing it from local-member sessions."
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "accessToken",
+            "accessExpiresAt",
+            "foreignIssuerDid",
+            "mappedRole"
+          ],
+          "properties": {
+            "accessToken": {
+              "type": "string"
+            },
+            "accessExpiresAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "The access token's expiry, as an RFC 3339 date-time, clamped to min(local default, earliest of the vec/vmc validUntil)."
+            },
+            "foreignIssuerDid": {
+              "type": "string"
+            },
+            "mappedRole": {
+              "type": "string",
+              "description": "The LOCAL role from cross_community_roles policy — not the foreign role."
+            }
+          }
+        },
+        "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: false,
+  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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vtc/auth/recognise/challenge/0.2/payload.ts

@@ -0,0 +1,168 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/auth/recognise/challenge/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+export interface VTCAuthRecogniseChallengePayload {
+  ext?: Ext;
+}
+export interface VTCAuthRecogniseChallengeResponsePayload {
+  /**
+   * Single-use, unpredictable value to bind into the presentation. Consumed on first use regardless of verdict.
+   */
+  nonce: string;
+  /**
+   * The instant, as an RFC 3339 date-time, after which the nonce is refused.
+   */
+  expiresAt: string;
+  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/vtc/auth/recognise/challenge/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAuthRecogniseChallengePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/auth/recognise/challenge/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAuthRecogniseChallengeResponsePayload;
+
+/**
+ * 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/vtc/auth/recognise/challenge/0.2",
+  "title": "VTC Auth Recognise Challenge — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Auth Recognise Challenge — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "nonce",
+        "expiresAt"
+      ],
+      "properties": {
+        "nonce": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Single-use, unpredictable value to bind into the presentation. Consumed on first use regardless of verdict."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The instant, as an RFC 3339 date-time, after which the nonce is refused."
+        },
+        "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": "VTC Auth Recognise Challenge — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "nonce",
+        "expiresAt"
+      ],
+      "properties": {
+        "nonce": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Single-use, unpredictable value to bind into the presentation. Consumed on first use regardless of verdict."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The instant, as an RFC 3339 date-time, after which the nonce is refused."
+        },
+        "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: false,
+  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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;