@openvtc/trust-tasks 0.21.10 → 0.21.12

package/src/vtc/relationships/restore/0.1/payload.ts

@@ -0,0 +1,307 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/relationships/restore/0.1/payload.schema.json
+ */
+
+import type { Ext, InForce, LifecycleReason } from "../../../../_shared/components.js";
+
+
+/**
+ * Restore one published relationship edge. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCRelationshipsRestorePayload {
+  /**
+   * The relationship (VRC) id, as vtc/relationships/list returns it.
+   */
+  id: string;
+  reason?: LifecycleReason;
+  ext?: Ext;
+}
+export interface VTCRelationshipsRestoreResponsePayload {
+  /**
+   * Echoed.
+   */
+  id: string;
+  state: InForce;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, InForce, LifecycleReason };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/restore/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRelationshipsRestorePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/restore/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRelationshipsRestoreResponsePayload;
+
+/**
+ * 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/relationships/restore/0.1",
+  "title": "VTC Relationships — Restore — payload",
+  "description": "Restore one published relationship edge. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+      "description": "The relationship (VRC) id, as vtc/relationships/list returns it."
+    },
+    "reason": {
+      "$ref": "#/$defs/LifecycleReason"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Relationships — Restore — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "state"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+          "description": "Echoed."
+        },
+        "state": {
+          "$ref": "#/$defs/InForce"
+        },
+        "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-]+)+$"
+      }
+    },
+    "InForce": {
+      "title": "InForce",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "state"
+      ],
+      "description": "Whether the edge is in force now, and if not, why not — the edge's resolved state, which is not the same thing as the event just recorded: restoring an edge whose `validUntil` passed while it was suspended records the restoration and still resolves `expired`. Exactly the members its `state` names are present.",
+      "properties": {
+        "state": {
+          "type": "string",
+          "enum": [
+            "yes",
+            "notYetValid",
+            "expired",
+            "suspended",
+            "superseded",
+            "withdrawn",
+            "indeterminate"
+          ],
+          "description": "`yes`: inside its window, nothing standing against it. `notYetValid`: its `validFrom` has not arrived. `expired`: its `validUntil` has passed. `suspended`: temporarily ineffective — the only non-`yes` state a lifecycle event can reverse. `superseded`: displaced by a later credential. `withdrawn`: terminal. `indeterminate`: the credential's own window could not be read, so no honest answer is available."
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `notYetValid`."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `expired`."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `suspended`: when the standing suspension was recorded."
+        },
+        "at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `superseded` and `withdrawn`."
+        },
+        "by": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "Present for `superseded`: the digest of the credential that displaced it."
+        },
+        "reason": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 500,
+          "description": "Present for `indeterminate`: why the window could not be read. Written by the community."
+        }
+      }
+    },
+    "LifecycleReason": {
+      "title": "LifecycleReason",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Why the edge was suspended or restored, stored verbatim on the lifecycle event. Free text written by the caller — the edge's issuer or a moderating administrator — and read by the counterparty and by administrators; retained with the edge. Untrusted, attributed to its author wherever rendered, and never read by the community's state machine."
+    }
+  }
+} 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 Relationships — Restore — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "state"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+          "description": "Echoed."
+        },
+        "state": {
+          "$ref": "#/$defs/InForce"
+        },
+        "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-]+)+$"
+      }
+    },
+    "InForce": {
+      "title": "InForce",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "state"
+      ],
+      "description": "Whether the edge is in force now, and if not, why not — the edge's resolved state, which is not the same thing as the event just recorded: restoring an edge whose `validUntil` passed while it was suspended records the restoration and still resolves `expired`. Exactly the members its `state` names are present.",
+      "properties": {
+        "state": {
+          "type": "string",
+          "enum": [
+            "yes",
+            "notYetValid",
+            "expired",
+            "suspended",
+            "superseded",
+            "withdrawn",
+            "indeterminate"
+          ],
+          "description": "`yes`: inside its window, nothing standing against it. `notYetValid`: its `validFrom` has not arrived. `expired`: its `validUntil` has passed. `suspended`: temporarily ineffective — the only non-`yes` state a lifecycle event can reverse. `superseded`: displaced by a later credential. `withdrawn`: terminal. `indeterminate`: the credential's own window could not be read, so no honest answer is available."
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `notYetValid`."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `expired`."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `suspended`: when the standing suspension was recorded."
+        },
+        "at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `superseded` and `withdrawn`."
+        },
+        "by": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "Present for `superseded`: the digest of the credential that displaced it."
+        },
+        "reason": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 500,
+          "description": "Present for `indeterminate`: why the window could not be read. Written by the community."
+        }
+      }
+    },
+    "LifecycleReason": {
+      "title": "LifecycleReason",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Why the edge was suspended or restored, stored verbatim on the lifecycle event. Free text written by the caller — the edge's issuer or a moderating administrator — and read by the counterparty and by administrators; retained with the edge. Untrusted, attributed to its author wherever rendered, and never read by the community's state machine."
+    }
+  }
+} 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/relationships/suspend/0.1/payload.ts

@@ -0,0 +1,307 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/relationships/suspend/0.1/payload.schema.json
+ */
+
+import type { Ext, InForce, LifecycleReason } from "../../../../_shared/components.js";
+
+
+/**
+ * Suspend one published relationship edge. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCRelationshipsSuspendPayload {
+  /**
+   * The relationship (VRC) id, as vtc/relationships/list returns it.
+   */
+  id: string;
+  reason?: LifecycleReason;
+  ext?: Ext;
+}
+export interface VTCRelationshipsSuspendResponsePayload {
+  /**
+   * Echoed.
+   */
+  id: string;
+  state: InForce;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, InForce, LifecycleReason };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/suspend/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRelationshipsSuspendPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/suspend/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRelationshipsSuspendResponsePayload;
+
+/**
+ * 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/relationships/suspend/0.1",
+  "title": "VTC Relationships — Suspend — payload",
+  "description": "Suspend one published relationship edge. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+      "description": "The relationship (VRC) id, as vtc/relationships/list returns it."
+    },
+    "reason": {
+      "$ref": "#/$defs/LifecycleReason"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Relationships — Suspend — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "state"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+          "description": "Echoed."
+        },
+        "state": {
+          "$ref": "#/$defs/InForce"
+        },
+        "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-]+)+$"
+      }
+    },
+    "InForce": {
+      "title": "InForce",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "state"
+      ],
+      "description": "Whether the edge is in force now, and if not, why not — the edge's resolved state, which is not the same thing as the event just recorded: restoring an edge whose `validUntil` passed while it was suspended records the restoration and still resolves `expired`. Exactly the members its `state` names are present.",
+      "properties": {
+        "state": {
+          "type": "string",
+          "enum": [
+            "yes",
+            "notYetValid",
+            "expired",
+            "suspended",
+            "superseded",
+            "withdrawn",
+            "indeterminate"
+          ],
+          "description": "`yes`: inside its window, nothing standing against it. `notYetValid`: its `validFrom` has not arrived. `expired`: its `validUntil` has passed. `suspended`: temporarily ineffective — the only non-`yes` state a lifecycle event can reverse. `superseded`: displaced by a later credential. `withdrawn`: terminal. `indeterminate`: the credential's own window could not be read, so no honest answer is available."
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `notYetValid`."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `expired`."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `suspended`: when the standing suspension was recorded."
+        },
+        "at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `superseded` and `withdrawn`."
+        },
+        "by": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "Present for `superseded`: the digest of the credential that displaced it."
+        },
+        "reason": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 500,
+          "description": "Present for `indeterminate`: why the window could not be read. Written by the community."
+        }
+      }
+    },
+    "LifecycleReason": {
+      "title": "LifecycleReason",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Why the edge was suspended or restored, stored verbatim on the lifecycle event. Free text written by the caller — the edge's issuer or a moderating administrator — and read by the counterparty and by administrators; retained with the edge. Untrusted, attributed to its author wherever rendered, and never read by the community's state machine."
+    }
+  }
+} 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 Relationships — Suspend — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "state"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+          "description": "Echoed."
+        },
+        "state": {
+          "$ref": "#/$defs/InForce"
+        },
+        "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-]+)+$"
+      }
+    },
+    "InForce": {
+      "title": "InForce",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "state"
+      ],
+      "description": "Whether the edge is in force now, and if not, why not — the edge's resolved state, which is not the same thing as the event just recorded: restoring an edge whose `validUntil` passed while it was suspended records the restoration and still resolves `expired`. Exactly the members its `state` names are present.",
+      "properties": {
+        "state": {
+          "type": "string",
+          "enum": [
+            "yes",
+            "notYetValid",
+            "expired",
+            "suspended",
+            "superseded",
+            "withdrawn",
+            "indeterminate"
+          ],
+          "description": "`yes`: inside its window, nothing standing against it. `notYetValid`: its `validFrom` has not arrived. `expired`: its `validUntil` has passed. `suspended`: temporarily ineffective — the only non-`yes` state a lifecycle event can reverse. `superseded`: displaced by a later credential. `withdrawn`: terminal. `indeterminate`: the credential's own window could not be read, so no honest answer is available."
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `notYetValid`."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `expired`."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `suspended`: when the standing suspension was recorded."
+        },
+        "at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present for `superseded` and `withdrawn`."
+        },
+        "by": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "Present for `superseded`: the digest of the credential that displaced it."
+        },
+        "reason": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 500,
+          "description": "Present for `indeterminate`: why the window could not be read. Written by the community."
+        }
+      }
+    },
+    "LifecycleReason": {
+      "title": "LifecycleReason",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Why the edge was suspended or restored, stored verbatim on the lifecycle event. Free text written by the caller — the edge's issuer or a moderating administrator — and read by the counterparty and by administrators; retained with the edge. Untrusted, attributed to its author wherever rendered, and never read by the community's state machine."
+    }
+  }
+} 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;