@openvtc/trust-tasks 0.28.11 → 0.28.13

package/src/vta/collection/list/0.1/payload.ts

@@ -0,0 +1,500 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/collection/list/0.1/payload.schema.json
+ */
+
+import type { Claim, CollectionEntry, Collector, ContextId_VtaCollectionV0_1 as ContextId, Did_NotificationsV0_1 as Did, Ext, NotCollectedReason } from "../../../../_shared/components.js";
+
+
+/**
+ * A client with standing in a trust context lists, for every identifier there that its VTA collects for unless a client has claimed it, who collects for it now: the VTA, a claimant — with the claim's end and whether it can be renewed — or nobody, and why (VTI-NTF-091). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTACollectionListPayload {
+  contextId: ContextId;
+  /**
+   * Only this identifier.
+   */
+  identifier?: Did;
+  /**
+   * Only identifiers with this collector — `none`, for instance, to find the identifiers nobody collects for.
+   */
+  collector?: Collector;
+  /**
+   * An opaque cursor from a previous response's `nextCursor`, for the same filters. The VTA refuses one it did not issue.
+   */
+  cursor?: string;
+  /**
+   * The most items to return.
+   */
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * One page of the identifiers that match.
+ */
+export interface VTACollectionListResponsePayload {
+  items: CollectionEntry[];
+  /**
+   * Present when more items remain; absent on the last page.
+   */
+  nextCursor?: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Claim, CollectionEntry, Collector, ContextId, Did, Ext, NotCollectedReason };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/collection/list/0.1" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTACollectionListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/collection/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTACollectionListResponsePayload;
+
+/**
+ * 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/vta/collection/list/0.1",
+  "title": "VTA Collection — List — payload",
+  "description": "A client with standing in a trust context lists, for every identifier there that its VTA collects for unless a client has claimed it, who collects for it now: the VTA, a claimant — with the claim's end and whether it can be renewed — or nobody, and why (VTI-NTF-091). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId"
+  ],
+  "properties": {
+    "contextId": {
+      "$ref": "#/$defs/ContextId"
+    },
+    "identifier": {
+      "$ref": "#/$defs/Did",
+      "description": "Only this identifier."
+    },
+    "collector": {
+      "$ref": "#/$defs/Collector",
+      "description": "Only identifiers with this collector — `none`, for instance, to find the identifiers nobody collects for."
+    },
+    "cursor": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "An opaque cursor from a previous response's `nextCursor`, for the same filters. The VTA refuses one it did not issue."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 200,
+      "description": "The most items to return."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Collection — List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "description": "One page of the identifiers that match.",
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/CollectionEntry"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Present when more items remain; absent on the last page."
+        }
+      }
+    },
+    "CollectionEntry": {
+      "title": "CollectionEntry",
+      "description": "The collection state of one identifier. `claim` is present exactly when `collector` is `client`, and `notCollectedReason` exactly when it is `none`.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "identifier",
+        "collector"
+      ],
+      "properties": {
+        "identifier": {
+          "$ref": "#/$defs/Did"
+        },
+        "collector": {
+          "$ref": "#/$defs/Collector"
+        },
+        "claim": {
+          "$ref": "#/$defs/Claim"
+        },
+        "notCollectedReason": {
+          "$ref": "#/$defs/NotCollectedReason"
+        }
+      },
+      "dependentSchemas": {
+        "claim": {
+          "properties": {
+            "collector": {
+              "const": "client"
+            }
+          }
+        },
+        "notCollectedReason": {
+          "properties": {
+            "collector": {
+              "const": "none"
+            }
+          }
+        },
+        "collector": {
+          "anyOf": [
+            {
+              "properties": {
+                "collector": {
+                  "const": "vta"
+                }
+              },
+              "not": {
+                "anyOf": [
+                  {
+                    "required": [
+                      "claim"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "notCollectedReason"
+                    ]
+                  }
+                ]
+              }
+            },
+            {
+              "required": [
+                "claim"
+              ]
+            },
+            {
+              "required": [
+                "notCollectedReason"
+              ]
+            }
+          ]
+        }
+      }
+    },
+    "NotCollectedReason": {
+      "title": "NotCollectedReason",
+      "description": "Why nobody collects for an identifier the VTA would otherwise collect for: `limit`, the VTA is at the bound it states on the number of identifiers it collects for (VTI-NTF-088); `conflict`, another connection for the identifier kept closing the VTA's, and the VTA stopped after the bound it states until the conflict is resolved (VTI-NTF-085). `disabled`, the VTA's operator has not enabled collection by default (VTI-NTF-093), so the VTA collects for no identifier a client has not claimed.",
+      "type": "string",
+      "enum": [
+        "limit",
+        "conflict",
+        "disabled"
+      ]
+    },
+    "Claim": {
+      "title": "Claim",
+      "description": "A collection claim in force for one identifier: the client that is its collector, when the claim ends, and whether the claimant may still renew it. A claim released by a party other than its claimant, or whose claimant's access control entry no longer gives it standing in the context, is not renewable and still ends at `endsAt`, because the claimant is still connected until its own clock tells it to stop (VTI-NTF-084).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claimant",
+        "endsAt",
+        "renewable"
+      ],
+      "properties": {
+        "claimant": {
+          "$ref": "#/$defs/Did",
+          "description": "The client holding the claim: the subject of the access control entry it was granted to."
+        },
+        "endsAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the claim ends unless renewed. The claimant stops collecting before this instant less its clock-skew tolerance; the VTA resumes no earlier than this instant plus its own (VTI-NTF-083, VTI-NTF-084)."
+        },
+        "renewable": {
+          "type": "boolean",
+          "description": "Whether the claimant may renew the claim with vta/collection/claim before it ends."
+        }
+      }
+    },
+    "Did": {
+      "title": "Did",
+      "description": "A DID.",
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:\\S+$"
+    },
+    "Collector": {
+      "title": "Collector",
+      "description": "Who collects for an identifier: `vta`, the VTA itself; `client`, the claimant of a collection claim in force; or `none`, nobody, for the reason given in `notCollectedReason`.",
+      "type": "string",
+      "enum": [
+        "vta",
+        "client",
+        "none"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "ContextId": {
+      "title": "ContextId",
+      "description": "The trust context the identifier belongs to.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    }
+  }
+} 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": "VTA Collection — List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "description": "One page of the identifiers that match.",
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/CollectionEntry"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Present when more items remain; absent on the last page."
+        }
+      }
+    },
+    "CollectionEntry": {
+      "title": "CollectionEntry",
+      "description": "The collection state of one identifier. `claim` is present exactly when `collector` is `client`, and `notCollectedReason` exactly when it is `none`.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "identifier",
+        "collector"
+      ],
+      "properties": {
+        "identifier": {
+          "$ref": "#/$defs/Did"
+        },
+        "collector": {
+          "$ref": "#/$defs/Collector"
+        },
+        "claim": {
+          "$ref": "#/$defs/Claim"
+        },
+        "notCollectedReason": {
+          "$ref": "#/$defs/NotCollectedReason"
+        }
+      },
+      "dependentSchemas": {
+        "claim": {
+          "properties": {
+            "collector": {
+              "const": "client"
+            }
+          }
+        },
+        "notCollectedReason": {
+          "properties": {
+            "collector": {
+              "const": "none"
+            }
+          }
+        },
+        "collector": {
+          "anyOf": [
+            {
+              "properties": {
+                "collector": {
+                  "const": "vta"
+                }
+              },
+              "not": {
+                "anyOf": [
+                  {
+                    "required": [
+                      "claim"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "notCollectedReason"
+                    ]
+                  }
+                ]
+              }
+            },
+            {
+              "required": [
+                "claim"
+              ]
+            },
+            {
+              "required": [
+                "notCollectedReason"
+              ]
+            }
+          ]
+        }
+      }
+    },
+    "NotCollectedReason": {
+      "title": "NotCollectedReason",
+      "description": "Why nobody collects for an identifier the VTA would otherwise collect for: `limit`, the VTA is at the bound it states on the number of identifiers it collects for (VTI-NTF-088); `conflict`, another connection for the identifier kept closing the VTA's, and the VTA stopped after the bound it states until the conflict is resolved (VTI-NTF-085). `disabled`, the VTA's operator has not enabled collection by default (VTI-NTF-093), so the VTA collects for no identifier a client has not claimed.",
+      "type": "string",
+      "enum": [
+        "limit",
+        "conflict",
+        "disabled"
+      ]
+    },
+    "Claim": {
+      "title": "Claim",
+      "description": "A collection claim in force for one identifier: the client that is its collector, when the claim ends, and whether the claimant may still renew it. A claim released by a party other than its claimant, or whose claimant's access control entry no longer gives it standing in the context, is not renewable and still ends at `endsAt`, because the claimant is still connected until its own clock tells it to stop (VTI-NTF-084).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claimant",
+        "endsAt",
+        "renewable"
+      ],
+      "properties": {
+        "claimant": {
+          "$ref": "#/$defs/Did",
+          "description": "The client holding the claim: the subject of the access control entry it was granted to."
+        },
+        "endsAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the claim ends unless renewed. The claimant stops collecting before this instant less its clock-skew tolerance; the VTA resumes no earlier than this instant plus its own (VTI-NTF-083, VTI-NTF-084)."
+        },
+        "renewable": {
+          "type": "boolean",
+          "description": "Whether the claimant may renew the claim with vta/collection/claim before it ends."
+        }
+      }
+    },
+    "Did": {
+      "title": "Did",
+      "description": "A DID.",
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:\\S+$"
+    },
+    "Collector": {
+      "title": "Collector",
+      "description": "Who collects for an identifier: `vta`, the VTA itself; `client`, the claimant of a collection claim in force; or `none`, nobody, for the reason given in `notCollectedReason`.",
+      "type": "string",
+      "enum": [
+        "vta",
+        "client",
+        "none"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "ContextId": {
+      "title": "ContextId",
+      "description": "The trust context the identifier belongs to.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    }
+  }
+} 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;