@openvtc/trust-tasks 0.21.11 → 0.21.13

package/src/vtc/schemas/delete/0.1/payload.ts

@@ -0,0 +1,170 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/schemas/delete/0.1/payload.schema.json
+ */
+
+import type { CredentialTypeUri, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Remove one registry entry. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCSchemasDeletePayload {
+  typeUri: CredentialTypeUri;
+  ext?: Ext;
+}
+export interface VTCSchemasDeleteResponsePayload {
+  typeUri: CredentialTypeUri;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CredentialTypeUri, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/schemas/delete/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCSchemasDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/schemas/delete/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCSchemasDeleteResponsePayload;
+
+/**
+ * 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/schemas/delete/0.1",
+  "title": "VTC Schemas — Delete — payload",
+  "description": "Remove one registry entry. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "typeUri"
+  ],
+  "properties": {
+    "typeUri": {
+      "$ref": "#/$defs/CredentialTypeUri"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Schemas — Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "typeUri"
+      ],
+      "properties": {
+        "typeUri": {
+          "$ref": "#/$defs/CredentialTypeUri"
+        },
+        "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-]+)+$"
+      }
+    },
+    "CredentialTypeUri": {
+      "title": "CredentialTypeUri",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "A credential type URI — the W3C `type` value or the SD-JWT-VC `vct` a credential of this type carries. The registry's primary key, compared as an exact string after surrounding whitespace is trimmed. Bounded at 512 bytes because it keys the community's storage."
+    }
+  }
+} 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 Schemas — Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "typeUri"
+      ],
+      "properties": {
+        "typeUri": {
+          "$ref": "#/$defs/CredentialTypeUri"
+        },
+        "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-]+)+$"
+      }
+    },
+    "CredentialTypeUri": {
+      "title": "CredentialTypeUri",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "A credential type URI — the W3C `type` value or the SD-JWT-VC `vct` a credential of this type carries. The registry's primary key, compared as an exact string after surrounding whitespace is trimmed. Bounded at 512 bytes because it keys the community's storage."
+    }
+  }
+} 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/vtc/schemas/list/0.1/payload.ts

@@ -0,0 +1,344 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/schemas/list/0.1/payload.schema.json
+ */
+
+import type { CredentialTypeUri, DtgType, Ext, SchemaDescription, SchemaKind, SchemaSummary } from "../../../../_shared/components.js";
+
+
+/**
+ * Page through the community's schema registry, optionally one half of it. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCSchemasListPayload {
+  kind?: SchemaKind;
+  /**
+   * Opaque continuation token from a previous page's `nextCursor`.
+   */
+  cursor?: string;
+  /**
+   * Page size. The community chooses when absent (50 in the reference implementation).
+   */
+  limit?: number;
+  ext?: Ext;
+}
+export interface VTCSchemasListResponsePayload {
+  /**
+   * @maxItems 100
+   */
+  items: SchemaSummary[];
+  /**
+   * Present when more entries remain; pass it as `cursor`.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CredentialTypeUri, DtgType, Ext, SchemaDescription, SchemaKind, SchemaSummary };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/schemas/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCSchemasListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/schemas/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCSchemasListResponsePayload;
+
+/**
+ * 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/schemas/list/0.1",
+  "title": "VTC Schemas — List — payload",
+  "description": "Page through the community's schema registry, optionally one half of it. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "kind": {
+      "$ref": "#/$defs/SchemaKind"
+    },
+    "cursor": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "description": "Opaque continuation token from a previous page's `nextCursor`."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 100,
+      "description": "Page size. The community chooses when absent (50 in the reference implementation)."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Schemas — List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/SchemaSummary"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024,
+          "description": "Present when more entries remain; pass it as `cursor`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "SchemaSummary": {
+      "title": "SchemaSummary",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "typeUri",
+        "kind",
+        "hasCredentialSchema",
+        "createdAt",
+        "createdByDid"
+      ],
+      "description": "One registered credential type as a listing reports it: every member of `SchemaEntry` except the `credentialSchema` body, which vtc/schemas/show returns.",
+      "properties": {
+        "typeUri": {
+          "$ref": "#/$defs/CredentialTypeUri"
+        },
+        "dtgType": {
+          "$ref": "#/$defs/DtgType"
+        },
+        "kind": {
+          "$ref": "#/$defs/SchemaKind"
+        },
+        "description": {
+          "$ref": "#/$defs/SchemaDescription"
+        },
+        "hasCredentialSchema": {
+          "type": "boolean",
+          "description": "Whether the entry carries a `credentialSchema`. True tells a caller that vtc/schemas/show has a body to return."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When this entry was last registered."
+        },
+        "createdByDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The administrator who last registered the entry."
+        }
+      }
+    },
+    "SchemaDescription": {
+      "title": "SchemaDescription",
+      "type": "string",
+      "maxLength": 1024,
+      "description": "An administrator's description of the entry, shown in administration surfaces. Free text written by the registering administrator and read by other administrators; untrusted, attributed to `createdByDid` wherever it is rendered, and never read by the community's own logic."
+    },
+    "SchemaKind": {
+      "title": "SchemaKind",
+      "type": "string",
+      "enum": [
+        "issues",
+        "accepts"
+      ],
+      "description": "Which half of the registry an entry is on. `issues`: the community mints credentials of this type, and issuance refuses a type not registered as `issues`. `accepts`: the community recognises credentials of this type as evidence, and an Accepts criterion may reference only a registered type."
+    },
+    "DtgType": {
+      "title": "DtgType",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z][A-Za-z0-9]*$",
+      "description": "The DTG credential catalog type the entry binds to, e.g. `MembershipCredential`. Absent for a community-defined endorsement type that maps onto the generic `EndorsementCredential`."
+    },
+    "CredentialTypeUri": {
+      "title": "CredentialTypeUri",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "A credential type URI — the W3C `type` value or the SD-JWT-VC `vct` a credential of this type carries. The registry's primary key, compared as an exact string after surrounding whitespace is trimmed. Bounded at 512 bytes because it keys the community's storage."
+    }
+  }
+} 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 Schemas — List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/SchemaSummary"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024,
+          "description": "Present when more entries remain; pass it as `cursor`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "SchemaSummary": {
+      "title": "SchemaSummary",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "typeUri",
+        "kind",
+        "hasCredentialSchema",
+        "createdAt",
+        "createdByDid"
+      ],
+      "description": "One registered credential type as a listing reports it: every member of `SchemaEntry` except the `credentialSchema` body, which vtc/schemas/show returns.",
+      "properties": {
+        "typeUri": {
+          "$ref": "#/$defs/CredentialTypeUri"
+        },
+        "dtgType": {
+          "$ref": "#/$defs/DtgType"
+        },
+        "kind": {
+          "$ref": "#/$defs/SchemaKind"
+        },
+        "description": {
+          "$ref": "#/$defs/SchemaDescription"
+        },
+        "hasCredentialSchema": {
+          "type": "boolean",
+          "description": "Whether the entry carries a `credentialSchema`. True tells a caller that vtc/schemas/show has a body to return."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When this entry was last registered."
+        },
+        "createdByDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The administrator who last registered the entry."
+        }
+      }
+    },
+    "SchemaDescription": {
+      "title": "SchemaDescription",
+      "type": "string",
+      "maxLength": 1024,
+      "description": "An administrator's description of the entry, shown in administration surfaces. Free text written by the registering administrator and read by other administrators; untrusted, attributed to `createdByDid` wherever it is rendered, and never read by the community's own logic."
+    },
+    "SchemaKind": {
+      "title": "SchemaKind",
+      "type": "string",
+      "enum": [
+        "issues",
+        "accepts"
+      ],
+      "description": "Which half of the registry an entry is on. `issues`: the community mints credentials of this type, and issuance refuses a type not registered as `issues`. `accepts`: the community recognises credentials of this type as evidence, and an Accepts criterion may reference only a registered type."
+    },
+    "DtgType": {
+      "title": "DtgType",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z][A-Za-z0-9]*$",
+      "description": "The DTG credential catalog type the entry binds to, e.g. `MembershipCredential`. Absent for a community-defined endorsement type that maps onto the generic `EndorsementCredential`."
+    },
+    "CredentialTypeUri": {
+      "title": "CredentialTypeUri",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "A credential type URI — the W3C `type` value or the SD-JWT-VC `vct` a credential of this type carries. The registry's primary key, compared as an exact string after surrounding whitespace is trimmed. Bounded at 512 bytes because it keys the community's storage."
+    }
+  }
+} 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;