@openvtc/trust-tasks 0.28.24 → 0.28.26

package/src/vta/memory/put/0.3/payload.ts

@@ -0,0 +1,379 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/memory/put/0.3/payload.schema.json
+ */
+
+import type { Ext, MemoryExpectedVersion, MemoryKey, MemoryPurpose, MemoryValue, MemoryVersion, Purpose_AclV0_3 as Purpose, Purpose_AclV0_31, Purpose_AclV0_32 } from "../../../../_shared/components.js";
+
+
+/**
+ * Store one memory item at its `(contextId, key)` address. `expectedVersion` makes the write conditional: a positive value requires the item to be at exactly that version, and zero requires that no live item exists.
+ */
+export interface VTAMemoryPutPayload {
+  /**
+   * The VTA context the item is scoped to; the isolation boundary.
+   */
+  contextId: string;
+  key: MemoryKey;
+  value: MemoryValue;
+  /**
+   * Optional precondition. Omit for a last-writer-wins upsert, as in 0.1. Supply the version a prior read returned to make the write conditional; supply 0 to create only.
+   */
+  expectedVersion?: MemoryExpectedVersion;
+  /**
+   * OPTIONAL. The one purpose the caller will use the content this request discloses for (VTI-ACL-103). Granted only as the caller's ACL entry grants it; a purpose the entry does not grant is refused with `purposeNotGranted`. May be omitted where the entry lists exactly one purpose, or states `any`.
+   */
+  purpose?: MemoryPurpose;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * Success response to vta/memory/put. Type https://trusttasks.org/spec/vta/memory/put/0.3#response. A failed precondition is not a success: it is a trust-task-error carrying vta/memory/put:versionConflict, whose details carry the maintainer's current version and value.
+ */
+export interface VTAMemoryPutResponsePayload {
+  /**
+   * Echoed from the request.
+   */
+  contextId: string;
+  key: MemoryKey;
+  /**
+   * The version this write took. Supply it as `expectedVersion` on the next write to chain conditional updates without an intervening read.
+   */
+  version: MemoryVersion;
+  /**
+   * True when no live item existed at the key beforehand — including when the key held a tombstone, since a tombstone is not a live item.
+   */
+  wasCreated: boolean;
+  /**
+   * When the write was applied.
+   */
+  updatedAt: string;
+  /**
+   * Size of the stored value in bytes as the maintainer measured it against its per-item cap.
+   */
+  valueBytes?: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, MemoryExpectedVersion, MemoryKey, MemoryPurpose, MemoryValue, MemoryVersion, Purpose, Purpose_AclV0_31, Purpose_AclV0_32 };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/memory/put/0.3" 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 = "0.2";
+
+/**
+ * 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 = VTAMemoryPutPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/memory/put/0.3#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAMemoryPutResponsePayload;
+
+/**
+ * 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/memory/put/0.3",
+  "title": "VTA Memory Put — payload",
+  "description": "Store one memory item at its `(contextId, key)` address. `expectedVersion` makes the write conditional: a positive value requires the item to be at exactly that version, and zero requires that no live item exists.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "key",
+    "value"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The VTA context the item is scoped to; the isolation boundary."
+    },
+    "key": {
+      "$ref": "#/$defs/MemoryKey"
+    },
+    "value": {
+      "$ref": "#/$defs/MemoryValue"
+    },
+    "expectedVersion": {
+      "$ref": "#/$defs/MemoryExpectedVersion",
+      "description": "Optional precondition. Omit for a last-writer-wins upsert, as in 0.1. Supply the version a prior read returned to make the write conditional; supply 0 to create only."
+    },
+    "purpose": {
+      "$ref": "#/$defs/MemoryPurpose",
+      "description": "OPTIONAL. The one purpose the caller will use the content this request discloses for (VTI-ACL-103). Granted only as the caller's ACL entry grants it; a purpose the entry does not grant is refused with `purposeNotGranted`. May be omitted where the entry lists exactly one purpose, or states `any`."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Memory Put — response payload",
+      "description": "Success response to vta/memory/put. Type https://trusttasks.org/spec/vta/memory/put/0.3#response. A failed precondition is not a success: it is a trust-task-error carrying vta/memory/put:versionConflict, whose details carry the maintainer's current version and value.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contextId",
+        "key",
+        "version",
+        "wasCreated",
+        "updatedAt"
+      ],
+      "properties": {
+        "contextId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Echoed from the request."
+        },
+        "key": {
+          "$ref": "#/$defs/MemoryKey"
+        },
+        "version": {
+          "$ref": "#/$defs/MemoryVersion",
+          "description": "The version this write took. Supply it as `expectedVersion` on the next write to chain conditional updates without an intervening read."
+        },
+        "wasCreated": {
+          "type": "boolean",
+          "description": "True when no live item existed at the key beforehand — including when the key held a tombstone, since a tombstone is not a live item."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the write was applied."
+        },
+        "valueBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Size of the stored value in bytes as the maintainer measured it against its per-item cap."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "MemoryVersion": {
+      "title": "MemoryVersion",
+      "description": "A value of the context's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "MemoryKey": {
+      "title": "MemoryKey",
+      "description": "Agent-chosen identifier for an item within a context. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `vta/memory/list` is a byte-prefix comparison over the UTF-8 encoding. Agents SHOULD use `/`-delimited hierarchical keys (`contact/billing`, `preference/timezone`) so that `prefix` can address a family of items, but the delimiter is a convention between an agent and itself. A key is content as well as an address: a key naming a person, a condition or a dispute discloses something to anyone who can list the context, even without its value.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "pattern": "^[^\\u0000]+$"
+    },
+    "MemoryPurpose": {
+      "title": "MemoryPurpose",
+      "description": "The one purpose for which the caller will use the memory content a request discloses (VTI-ACL-103): a name registered in the VTI specification's purpose registry (`personalisation`, `taskExecution`, `analytics`, `modelTraining`) or an absolute IRI. The VTA grants it only if the caller's ACL entry does — `any` grants every purpose but `modelTraining` — refuses it otherwise (`purposeNotGranted`), and records it in the audit record of the read. Optional where the entry lists exactly one purpose (that one applies) or states `any` (the read is recorded as for no stated purpose).",
+      "$ref": "#/$defs/Purpose"
+    },
+    "Purpose": {
+      "title": "Purpose",
+      "description": "What content is used for: a lowerCamelCase name registered in the VTI specification's purpose registry (Appendix H) — `personalisation`, `taskExecution`, `analytics`, `modelTraining` at the time of writing — or an absolute IRI naming a purpose defined elsewhere, such as a purpose of the W3C Data Privacy Vocabulary (`https://w3id.org/dpv#ServicePersonalisation`). Compared by exact string equality: a consumer MUST NOT treat a purpose it does not recognise as equal to any other, and grants only a request naming exactly a listed purpose (VTI-ACL-109). A registered name is never an IRI, because it contains no `:`.",
+      "type": "string",
+      "maxLength": 2048,
+      "anyOf": [
+        {
+          "pattern": "^[a-z][a-zA-Z0-9]{0,63}$"
+        },
+        {
+          "pattern": "^[a-zA-Z][a-zA-Z0-9+.-]*:[^\\s]+$"
+        }
+      ]
+    },
+    "MemoryExpectedVersion": {
+      "title": "MemoryExpectedVersion",
+      "description": "Optimistic-concurrency precondition on a write. A positive value requires that the item's current `version` equals it exactly. Zero means \"create only\" — the write applies only if no LIVE item exists at the key. A tombstone is not a live item, so `expectedVersion: 0` succeeds over one; the created item takes the context's next counter value, which is necessarily greater than the tombstone's.",
+      "type": "integer",
+      "minimum": 0
+    },
+    "MemoryValue": {
+      "title": "MemoryValue",
+      "description": "The remembered text: a fact, a summary, a preference. Opaque to the maintainer, which stores it as given and never interprets, rewrites or summarises it. The maintainer enforces a documented per-item cap on its size (see `vta/memory/put`).",
+      "type": "string"
+    }
+  }
+} 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 Memory Put — response payload",
+      "description": "Success response to vta/memory/put. Type https://trusttasks.org/spec/vta/memory/put/0.3#response. A failed precondition is not a success: it is a trust-task-error carrying vta/memory/put:versionConflict, whose details carry the maintainer's current version and value.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contextId",
+        "key",
+        "version",
+        "wasCreated",
+        "updatedAt"
+      ],
+      "properties": {
+        "contextId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Echoed from the request."
+        },
+        "key": {
+          "$ref": "#/$defs/MemoryKey"
+        },
+        "version": {
+          "$ref": "#/$defs/MemoryVersion",
+          "description": "The version this write took. Supply it as `expectedVersion` on the next write to chain conditional updates without an intervening read."
+        },
+        "wasCreated": {
+          "type": "boolean",
+          "description": "True when no live item existed at the key beforehand — including when the key held a tombstone, since a tombstone is not a live item."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the write was applied."
+        },
+        "valueBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Size of the stored value in bytes as the maintainer measured it against its per-item cap."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "MemoryVersion": {
+      "title": "MemoryVersion",
+      "description": "A value of the context's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "MemoryKey": {
+      "title": "MemoryKey",
+      "description": "Agent-chosen identifier for an item within a context. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `vta/memory/list` is a byte-prefix comparison over the UTF-8 encoding. Agents SHOULD use `/`-delimited hierarchical keys (`contact/billing`, `preference/timezone`) so that `prefix` can address a family of items, but the delimiter is a convention between an agent and itself. A key is content as well as an address: a key naming a person, a condition or a dispute discloses something to anyone who can list the context, even without its value.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "pattern": "^[^\\u0000]+$"
+    },
+    "MemoryPurpose": {
+      "title": "MemoryPurpose",
+      "description": "The one purpose for which the caller will use the memory content a request discloses (VTI-ACL-103): a name registered in the VTI specification's purpose registry (`personalisation`, `taskExecution`, `analytics`, `modelTraining`) or an absolute IRI. The VTA grants it only if the caller's ACL entry does — `any` grants every purpose but `modelTraining` — refuses it otherwise (`purposeNotGranted`), and records it in the audit record of the read. Optional where the entry lists exactly one purpose (that one applies) or states `any` (the read is recorded as for no stated purpose).",
+      "$ref": "#/$defs/Purpose"
+    },
+    "Purpose": {
+      "title": "Purpose",
+      "description": "What content is used for: a lowerCamelCase name registered in the VTI specification's purpose registry (Appendix H) — `personalisation`, `taskExecution`, `analytics`, `modelTraining` at the time of writing — or an absolute IRI naming a purpose defined elsewhere, such as a purpose of the W3C Data Privacy Vocabulary (`https://w3id.org/dpv#ServicePersonalisation`). Compared by exact string equality: a consumer MUST NOT treat a purpose it does not recognise as equal to any other, and grants only a request naming exactly a listed purpose (VTI-ACL-109). A registered name is never an IRI, because it contains no `:`.",
+      "type": "string",
+      "maxLength": 2048,
+      "anyOf": [
+        {
+          "pattern": "^[a-z][a-zA-Z0-9]{0,63}$"
+        },
+        {
+          "pattern": "^[a-zA-Z][a-zA-Z0-9+.-]*:[^\\s]+$"
+        }
+      ]
+    },
+    "MemoryExpectedVersion": {
+      "title": "MemoryExpectedVersion",
+      "description": "Optimistic-concurrency precondition on a write. A positive value requires that the item's current `version` equals it exactly. Zero means \"create only\" — the write applies only if no LIVE item exists at the key. A tombstone is not a live item, so `expectedVersion: 0` succeeds over one; the created item takes the context's next counter value, which is necessarily greater than the tombstone's.",
+      "type": "integer",
+      "minimum": 0
+    },
+    "MemoryValue": {
+      "title": "MemoryValue",
+      "description": "The remembered text: a fact, a summary, a preference. Opaque to the maintainer, which stores it as given and never interprets, rewrites or summarises it. The maintainer enforces a documented per-item cap on its size (see `vta/memory/put`).",
+      "type": "string"
+    }
+  }
+} 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;