@openvtc/trust-tasks 0.27.3 → 0.27.4

package/src/vtc/endorsements/list/0.2/payload.ts

@@ -0,0 +1,400 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/endorsements/list/0.2/payload.schema.json
+ */
+
+import type { CredentialId, CredentialReference, Endorsement, Ext } from "../../../../_shared/components.js";
+
+
+export interface VTCEndorsementsListPayload {
+  /**
+   * Filter to rows of this kind: a registered predicate IRI (statements whose `credentialSubject.predicate` it is), or `role:vetter`.
+   */
+  typeUri?: string;
+  /**
+   * Filter to endorsements about this subject.
+   */
+  subjectDid?: string;
+  /**
+   * Include revoked rows. Defaults to true — both live and revoked rows surface; consumers filter on revokedAt.
+   */
+  includeRevoked?: boolean;
+  /**
+   * An opaque continuation token from a previous response's `nextCursor`; a responder MUST NOT accept a cursor it did not issue.
+   */
+  cursor?: string;
+  /**
+   * The most items to return, at most 200; the responder chooses a default (50) and MAY return fewer.
+   */
+  limit?: number;
+  ext?: Ext;
+}
+export interface VTCEndorsementsListResponsePayload {
+  items: Endorsement[];
+  /**
+   * Continuation token for the next page; pass it back as `cursor`. Absent on the last page — never `null`.
+   */
+  nextCursor?: string;
+  /**
+   * Approximate total matching endorsements, when the maintainer can cheaply estimate it.
+   */
+  totalEstimate?: number | null;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CredentialId, CredentialReference, Endorsement, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/list/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCEndorsementsListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/endorsements/list/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCEndorsementsListResponsePayload;
+
+/**
+ * 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/endorsements/list/0.2",
+  "title": "VTC Endorsements List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "typeUri": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "Filter to rows of this kind: a registered predicate IRI (statements whose `credentialSubject.predicate` it is), or `role:vetter`."
+    },
+    "subjectDid": {
+      "type": "string",
+      "pattern": "^did:",
+      "description": "Filter to endorsements about this subject."
+    },
+    "includeRevoked": {
+      "type": "boolean",
+      "description": "Include revoked rows. Defaults to true — both live and revoked rows surface; consumers filter on revokedAt."
+    },
+    "cursor": {
+      "type": "string",
+      "description": "An opaque continuation token from a previous response's `nextCursor`; a responder MUST NOT accept a cursor it did not issue."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 200,
+      "description": "The most items to return, at most 200; the responder chooses a default (50) and MAY return fewer."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Endorsements List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Endorsement"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "description": "Continuation token for the next page; pass it back as `cursor`. Absent on the last page — never `null`."
+        },
+        "totalEstimate": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "description": "Approximate total matching endorsements, when the maintainer can cheaply estimate it."
+        },
+        "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-]+)+$"
+      }
+    },
+    "Endorsement": {
+      "$anchor": "endorsement",
+      "title": "Endorsement",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "endorsementId",
+        "typeUri",
+        "subjectDid",
+        "issued",
+        "statusListIndex"
+      ],
+      "properties": {
+        "endorsementId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Community-scoped identifier for this row. The name is legacy; it identifies a statement, and vtc/endorsements/revoke also takes the `endorsementId` of a role credential issued by vtc/vetting/vetters/grant."
+        },
+        "typeUri": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "What the row records. A registered predicate IRI: a statement (StatementCredential) whose `credentialSubject.predicate` it is — see vtc/endorsement-types/*. `role:vetter`: a vetter role credential (Verifiable Authority Credential) issued by vtc/vetting/vetters/grant. The reserved value is not an IRI, so it never collides with a registered predicate. A community's own identity check is a statement like any other, under `https://registry.trustoverip.org/dtg/vsc/vetted/1`."
+        },
+        "subjectDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "description": "DID of the statement's subject (becomes credentialSubject.id)."
+        },
+        "claim": {
+          "type": "object",
+          "description": "The attested claim body — the statement's `credentialSubject.object.value` — validated against the registered predicate's claimSchema when it declares one."
+        },
+        "issued": {
+          "$ref": "#/$defs/CredentialReference",
+          "description": "A pointer to the issued statement credential — its identifier and lifetime, not its bytes. `endorsements/issue` additionally returns the credential itself, because that is the one call whose caller has no other way to receive it."
+        },
+        "statusListIndex": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The statement's slot on the community's shared Revocation status list, referenced by its `credentialStatus`. Published, so a foreign verifier can check revocation without contacting this community."
+        },
+        "revokedAt": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "format": "date-time",
+          "description": "When the statement was revoked, or null while live."
+        }
+      }
+    },
+    "CredentialReference": {
+      "$anchor": "credentialReference",
+      "title": "CredentialReference",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "A pointer to an issued credential, without the credential itself.\n\nThe counterpart to IssuedCredential, for the far more common case of *reading about* a credential rather than being handed one. A listing that embedded the signed credential in every row would grow with the size of the credentials rather than the number of them — a page of fifty is megabytes — and a reader that only needs to know a credential exists, when it lapses, and how to revoke it does not need the bytes.\n\nThe holder can always fetch the credential itself by `credentialId`, and a verifier can check revocation from the row's status-list slot without either. Reach for IssuedCredential only at the moment of minting, where the caller has no other way to receive what was just made for them.",
+      "required": [
+        "credentialId"
+      ],
+      "properties": {
+        "credentialId": {
+          "$ref": "#/$defs/CredentialId"
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the credential was minted."
+        },
+        "expiresAt": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "format": "date-time",
+          "description": "When it lapses, or null when it does not."
+        }
+      }
+    },
+    "CredentialId": {
+      "$anchor": "credentialId",
+      "title": "CredentialId",
+      "description": "Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.",
+      "type": "string",
+      "minLength": 1
+    }
+  }
+} 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 Endorsements List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Endorsement"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "description": "Continuation token for the next page; pass it back as `cursor`. Absent on the last page — never `null`."
+        },
+        "totalEstimate": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "description": "Approximate total matching endorsements, when the maintainer can cheaply estimate it."
+        },
+        "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-]+)+$"
+      }
+    },
+    "Endorsement": {
+      "$anchor": "endorsement",
+      "title": "Endorsement",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "endorsementId",
+        "typeUri",
+        "subjectDid",
+        "issued",
+        "statusListIndex"
+      ],
+      "properties": {
+        "endorsementId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Community-scoped identifier for this row. The name is legacy; it identifies a statement, and vtc/endorsements/revoke also takes the `endorsementId` of a role credential issued by vtc/vetting/vetters/grant."
+        },
+        "typeUri": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "What the row records. A registered predicate IRI: a statement (StatementCredential) whose `credentialSubject.predicate` it is — see vtc/endorsement-types/*. `role:vetter`: a vetter role credential (Verifiable Authority Credential) issued by vtc/vetting/vetters/grant. The reserved value is not an IRI, so it never collides with a registered predicate. A community's own identity check is a statement like any other, under `https://registry.trustoverip.org/dtg/vsc/vetted/1`."
+        },
+        "subjectDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "description": "DID of the statement's subject (becomes credentialSubject.id)."
+        },
+        "claim": {
+          "type": "object",
+          "description": "The attested claim body — the statement's `credentialSubject.object.value` — validated against the registered predicate's claimSchema when it declares one."
+        },
+        "issued": {
+          "$ref": "#/$defs/CredentialReference",
+          "description": "A pointer to the issued statement credential — its identifier and lifetime, not its bytes. `endorsements/issue` additionally returns the credential itself, because that is the one call whose caller has no other way to receive it."
+        },
+        "statusListIndex": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The statement's slot on the community's shared Revocation status list, referenced by its `credentialStatus`. Published, so a foreign verifier can check revocation without contacting this community."
+        },
+        "revokedAt": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "format": "date-time",
+          "description": "When the statement was revoked, or null while live."
+        }
+      }
+    },
+    "CredentialReference": {
+      "$anchor": "credentialReference",
+      "title": "CredentialReference",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "A pointer to an issued credential, without the credential itself.\n\nThe counterpart to IssuedCredential, for the far more common case of *reading about* a credential rather than being handed one. A listing that embedded the signed credential in every row would grow with the size of the credentials rather than the number of them — a page of fifty is megabytes — and a reader that only needs to know a credential exists, when it lapses, and how to revoke it does not need the bytes.\n\nThe holder can always fetch the credential itself by `credentialId`, and a verifier can check revocation from the row's status-list slot without either. Reach for IssuedCredential only at the moment of minting, where the caller has no other way to receive what was just made for them.",
+      "required": [
+        "credentialId"
+      ],
+      "properties": {
+        "credentialId": {
+          "$ref": "#/$defs/CredentialId"
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the credential was minted."
+        },
+        "expiresAt": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "format": "date-time",
+          "description": "When it lapses, or null when it does not."
+        }
+      }
+    },
+    "CredentialId": {
+      "$anchor": "credentialId",
+      "title": "CredentialId",
+      "description": "Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.",
+      "type": "string",
+      "minLength": 1
+    }
+  }
+} 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;