@openvtc/trust-tasks 0.19.5 → 0.19.7

package/src/vtc/registry/records/list/0.1/payload.ts

@@ -0,0 +1,407 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/registry/records/list/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+export interface VTCRegistryRecordsListPayload {
+  /**
+   * Filter to records about this entity.
+   */
+  entityId?: string;
+  /**
+   * Filter to records asserted by this authority.
+   */
+  authorityId?: string;
+  /**
+   * Filter to records for this action.
+   */
+  action?: string;
+  /**
+   * Filter to records for this resource.
+   */
+  resource?: string;
+  /**
+   * Which view to enumerate. Defaults to `registry`.
+   */
+  source?: "registry" | "local";
+  /**
+   * Opaque continuation token from a previous page's `nextCursor`.
+   */
+  cursor?: string;
+  /**
+   * Page size; the maintainer clamps to 1..=200 (default 50).
+   */
+  limit?: number;
+  ext?: Ext;
+}
+export interface VTCRegistryRecordsListResponsePayload {
+  /**
+   * The matching records, in the maintainer's stable enumeration order.
+   */
+  items: Record[];
+  /**
+   * Which view these items came from, echoed so a consumer never has to infer it from the request it thinks it sent.
+   */
+  source: "registry" | "local";
+  /**
+   * Continuation token for the next page, or null when this is the last.
+   */
+  nextCursor?: string | null;
+  ext?: Ext;
+}
+export interface Record {
+  /**
+   * The entity the record is about.
+   */
+  entityId: string;
+  /**
+   * The authority asserting it.
+   */
+  authorityId: string;
+  /**
+   * The action the assertion covers.
+   */
+  action: string;
+  /**
+   * The resource the assertion covers.
+   */
+  resource: string;
+  /**
+   * Record discriminator, as the trust registry states it.
+   */
+  recordType: string;
+  /**
+   * Present on recognition records: whether the action+resource is recognised. Absent on other record types — absent is not `false`.
+   */
+  recognized?: boolean | null;
+  /**
+   * Present on authorization records: whether the action+resource authorization is confirmed. Absent on other record types — absent is not `false`.
+   */
+  authorized?: boolean | null;
+  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/registry/records/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRegistryRecordsListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/registry/records/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRegistryRecordsListResponsePayload;
+
+/**
+ * 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/registry/records/list/0.1",
+  "title": "VTC Registry Records List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "entityId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Filter to records about this entity."
+    },
+    "authorityId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Filter to records asserted by this authority."
+    },
+    "action": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Filter to records for this action."
+    },
+    "resource": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Filter to records for this resource."
+    },
+    "source": {
+      "$ref": "#/$defs/Source",
+      "description": "Which view to enumerate. Defaults to `registry`."
+    },
+    "cursor": {
+      "type": "string",
+      "description": "Opaque continuation token from a previous page's `nextCursor`."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 200,
+      "description": "Page size; the maintainer clamps to 1..=200 (default 50)."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Source": {
+      "type": "string",
+      "enum": [
+        "registry",
+        "local"
+      ],
+      "description": "`registry` enumerates the trust registry itself; `local` enumerates the community's own record of what it published. They are different questions and a consumer MUST NOT treat one as a cache of the other."
+    },
+    "Record": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entityId",
+        "authorityId",
+        "action",
+        "resource",
+        "recordType"
+      ],
+      "properties": {
+        "entityId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The entity the record is about."
+        },
+        "authorityId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The authority asserting it."
+        },
+        "action": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The action the assertion covers."
+        },
+        "resource": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The resource the assertion covers."
+        },
+        "recordType": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Record discriminator, as the trust registry states it."
+        },
+        "recognized": {
+          "type": [
+            "boolean",
+            "null"
+          ],
+          "description": "Present on recognition records: whether the action+resource is recognised. Absent on other record types — absent is not `false`."
+        },
+        "authorized": {
+          "type": [
+            "boolean",
+            "null"
+          ],
+          "description": "Present on authorization records: whether the action+resource authorization is confirmed. Absent on other record types — absent is not `false`."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Registry Records List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items",
+        "source"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Record"
+          },
+          "description": "The matching records, in the maintainer's stable enumeration order."
+        },
+        "source": {
+          "$ref": "#/$defs/Source",
+          "description": "Which view these items came from, echoed so a consumer never has to infer it from the request it thinks it sent."
+        },
+        "nextCursor": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Continuation token for the next page, or null when this is the last."
+        },
+        "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": {
+    "Source": {
+      "type": "string",
+      "enum": [
+        "registry",
+        "local"
+      ],
+      "description": "`registry` enumerates the trust registry itself; `local` enumerates the community's own record of what it published. They are different questions and a consumer MUST NOT treat one as a cache of the other."
+    },
+    "Record": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entityId",
+        "authorityId",
+        "action",
+        "resource",
+        "recordType"
+      ],
+      "properties": {
+        "entityId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The entity the record is about."
+        },
+        "authorityId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The authority asserting it."
+        },
+        "action": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The action the assertion covers."
+        },
+        "resource": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The resource the assertion covers."
+        },
+        "recordType": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Record discriminator, as the trust registry states it."
+        },
+        "recognized": {
+          "type": [
+            "boolean",
+            "null"
+          ],
+          "description": "Present on recognition records: whether the action+resource is recognised. Absent on other record types — absent is not `false`."
+        },
+        "authorized": {
+          "type": [
+            "boolean",
+            "null"
+          ],
+          "description": "Present on authorization records: whether the action+resource authorization is confirmed. Absent on other record types — absent is not `false`."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Registry Records List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items",
+        "source"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Record"
+          },
+          "description": "The matching records, in the maintainer's stable enumeration order."
+        },
+        "source": {
+          "$ref": "#/$defs/Source",
+          "description": "Which view these items came from, echoed so a consumer never has to infer it from the request it thinks it sent."
+        },
+        "nextCursor": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Continuation token for the next page, or null when this is the last."
+        },
+        "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: 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;

package/src/vtc/registry/sync-jobs/discard/0.1/payload.ts

@@ -0,0 +1,184 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/registry/sync-jobs/discard/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * Delete an abandoned trust-registry reconciliation job without dispatching it. The registry's record for that member is left exactly as it is.
+ */
+export interface VTCRegistrySyncJobsDiscardPayload {
+  /**
+   * The job to delete, from `vtc/registry/sync-jobs/list`. Required and single: discard is irreversible, so there is deliberately no bulk form.
+   */
+  jobId: string;
+  ext?: Ext;
+}
+export interface VTCRegistrySyncJobsDiscardResponsePayload {
+  /**
+   * The deleted job, echoed.
+   */
+  jobId: string;
+  /**
+   * The member whose pending change was dropped. Returned because the caller is discarding by identifier and this names what it actually cost.
+   */
+  memberDid: 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/registry/sync-jobs/discard/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRegistrySyncJobsDiscardPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/registry/sync-jobs/discard/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRegistrySyncJobsDiscardResponsePayload;
+
+/**
+ * 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/registry/sync-jobs/discard/0.1",
+  "title": "VTC Registry Sync Jobs Discard — payload",
+  "description": "Delete an abandoned trust-registry reconciliation job without dispatching it. The registry's record for that member is left exactly as it is.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "jobId"
+  ],
+  "properties": {
+    "jobId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The job to delete, from `vtc/registry/sync-jobs/list`. Required and single: discard is irreversible, so there is deliberately no bulk form."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Registry Sync Jobs Discard — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobId",
+        "memberDid"
+      ],
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The deleted job, echoed."
+        },
+        "memberDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member whose pending change was dropped. Returned because the caller is discarding by identifier and this names what it actually cost."
+        },
+        "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 Registry Sync Jobs Discard — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobId",
+        "memberDid"
+      ],
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The deleted job, echoed."
+        },
+        "memberDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member whose pending change was dropped. Returned because the caller is discarding by identifier and this names what it actually cost."
+        },
+        "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;