@openvtc/trust-tasks 0.28.23 → 0.28.24

package/dist/vta/memory/get/0.1/payload.d.ts

@@ -0,0 +1,646 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/memory/get/0.1/payload.schema.json
+ */
+import type { Ext, MemoryKey, MemoryRecord, MemoryValue, MemoryVersion } from "../../../../_shared/components.js";
+/**
+ * Recall up to 256 named memory items from one context in a single round trip. The read an agent makes when it knows what it needs, and the one whose audit record says exactly which items it saw.
+ */
+export interface VTAMemoryGetPayload {
+    /**
+     * The VTA context the items are scoped to; the isolation boundary.
+     */
+    contextId: string;
+    /**
+     * The keys to recall. Duplicates are refused rather than deduplicated, because a caller that sent one did not mean to and would otherwise never find out.
+     *
+     * @minItems 1
+     * @maxItems 256
+     */
+    keys: [MemoryKey, ...MemoryKey[]];
+    /**
+     * Defaults to false. When true, a key holding a tombstone yields an item with `deleted: true` rather than appearing in `missing`.
+     */
+    includeDeleted?: boolean;
+    /**
+     * Ecosystem-defined extension members per SPEC.md §4.5.1.
+     */
+    ext?: Ext;
+}
+/**
+ * Success response to vta/memory/get. Type https://trusttasks.org/spec/vta/memory/get/0.1#response. Every requested key appears in exactly one of `items`, `missing` or `deferred`, so a caller can account for all of them without comparing sets itself.
+ */
+export interface VTAMemoryGetResponsePayload {
+    /**
+     * The items found, each with its `value` (a tombstone has none), in the order the keys were requested. May be empty.
+     */
+    items: MemoryRecord[];
+    /**
+     * Requested keys holding no item — and, unless `includeDeleted` was set, keys holding only a tombstone. Reported rather than silently omitted.
+     */
+    missing: MemoryKey[];
+    /**
+     * Requested keys the maintainer did not evaluate because the response had reached its size budget. The caller re-requests exactly these. A deferred key was not read, and a maintainer MUST NOT record it as read.
+     */
+    deferred?: MemoryKey[];
+    /**
+     * 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, MemoryKey, MemoryRecord, MemoryValue, MemoryVersion };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vta/memory/get/0.1";
+/**
+ * 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 declare const EXTENDS: string | 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 declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAMemoryGetPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/memory/get/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAMemoryGetResponsePayload;
+/**
+ * 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vta/memory/get/0.1";
+    readonly title: "VTA Memory Get — payload";
+    readonly description: "Recall up to 256 named memory items from one context in a single round trip. The read an agent makes when it knows what it needs, and the one whose audit record says exactly which items it saw.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["contextId", "keys"];
+    readonly properties: {
+        readonly contextId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "The VTA context the items are scoped to; the isolation boundary.";
+        };
+        readonly keys: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly maxItems: 256;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly $ref: "#/$defs/MemoryKey";
+            };
+            readonly description: "The keys to recall. Duplicates are refused rather than deduplicated, because a caller that sent one did not mean to and would otherwise never find out.";
+        };
+        readonly includeDeleted: {
+            readonly type: "boolean";
+            readonly description: "Defaults to false. When true, a key holding a tombstone yields an item with `deleted: true` rather than appearing in `missing`.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+            readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA Memory Get — response payload";
+            readonly description: "Success response to vta/memory/get. Type https://trusttasks.org/spec/vta/memory/get/0.1#response. Every requested key appears in exactly one of `items`, `missing` or `deferred`, so a caller can account for all of them without comparing sets itself.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["items", "missing"];
+            readonly properties: {
+                readonly items: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/MemoryRecord";
+                    };
+                    readonly description: "The items found, each with its `value` (a tombstone has none), in the order the keys were requested. May be empty.";
+                };
+                readonly missing: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/MemoryKey";
+                    };
+                    readonly description: "Requested keys holding no item — and, unless `includeDeleted` was set, keys holding only a tombstone. Reported rather than silently omitted.";
+                };
+                readonly deferred: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/MemoryKey";
+                    };
+                    readonly description: "Requested keys the maintainer did not evaluate because the response had reached its size budget. The caller re-requests exactly these. A deferred key was not read, and a maintainer MUST NOT record it as read.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                    readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly MemoryKey: {
+            readonly title: "MemoryKey";
+            readonly 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.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 512;
+            readonly pattern: "^[^\\u0000]+$";
+        };
+        readonly MemoryRecord: {
+            readonly title: "MemoryRecord";
+            readonly description: "A memory item as the maintainer holds it. `value` is absent in two distinct situations and a consumer MUST NOT conflate them: the item is a tombstone (`deleted` is true), or the caller asked for a metadata-only view (`vta/memory/list` without `includeValues`). This is why `deleted` is required rather than defaulted — a consumer that infers deletion from an absent value gets the tombstone case wrong exactly when convergence depends on it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["contextId", "key", "version", "deleted", "updatedAt"];
+            readonly properties: {
+                readonly contextId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The VTA context the item is scoped to; the isolation boundary.";
+                };
+                readonly key: {
+                    readonly $ref: "#/$defs/MemoryKey";
+                };
+                readonly version: {
+                    readonly $ref: "#/$defs/MemoryVersion";
+                    readonly description: "The context counter value this item's most recent write took. Supply it as `expectedVersion` on the next write to make that write conditional on nothing having changed in between.";
+                };
+                readonly value: {
+                    readonly $ref: "#/$defs/MemoryValue";
+                    readonly description: "The remembered text. Absent when this is a tombstone or a metadata-only view.";
+                };
+                readonly valueBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Size of the stored value in bytes over its UTF-8 encoding, as the maintainer measures it for the per-item cap. Present in metadata-only views so a consumer can decide what to fetch without fetching it; absent on a tombstone.";
+                };
+                readonly deleted: {
+                    readonly type: "boolean";
+                    readonly description: "True when this is a tombstone: the item was deleted, and this entry exists so that a consumer syncing incrementally learns of the deletion. Tombstones are reaped after the maintainer's retention window; see `vta/memory/list`.";
+                };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the item was first created at this key. MAY be absent on a tombstone whose body has been discarded, and on an item written before the maintainer kept versions.";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the write that produced this `version` was applied. For a tombstone, when the delete was applied.";
+                };
+                readonly deletedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the item was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.";
+                };
+            };
+        };
+        readonly MemoryValue: {
+            readonly title: "MemoryValue";
+            readonly 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`).";
+            readonly type: "string";
+        };
+        readonly MemoryVersion: {
+            readonly title: "MemoryVersion";
+            readonly description: "A value of the context's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.";
+            readonly type: "integer";
+            readonly minimum: 1;
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA Memory Get — response payload";
+            readonly description: "Success response to vta/memory/get. Type https://trusttasks.org/spec/vta/memory/get/0.1#response. Every requested key appears in exactly one of `items`, `missing` or `deferred`, so a caller can account for all of them without comparing sets itself.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["items", "missing"];
+            readonly properties: {
+                readonly items: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/MemoryRecord";
+                    };
+                    readonly description: "The items found, each with its `value` (a tombstone has none), in the order the keys were requested. May be empty.";
+                };
+                readonly missing: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/MemoryKey";
+                    };
+                    readonly description: "Requested keys holding no item — and, unless `includeDeleted` was set, keys holding only a tombstone. Reported rather than silently omitted.";
+                };
+                readonly deferred: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/MemoryKey";
+                    };
+                    readonly description: "Requested keys the maintainer did not evaluate because the response had reached its size budget. The caller re-requests exactly these. A deferred key was not read, and a maintainer MUST NOT record it as read.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                    readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly MemoryKey: {
+            readonly title: "MemoryKey";
+            readonly 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.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 512;
+            readonly pattern: "^[^\\u0000]+$";
+        };
+        readonly MemoryRecord: {
+            readonly title: "MemoryRecord";
+            readonly description: "A memory item as the maintainer holds it. `value` is absent in two distinct situations and a consumer MUST NOT conflate them: the item is a tombstone (`deleted` is true), or the caller asked for a metadata-only view (`vta/memory/list` without `includeValues`). This is why `deleted` is required rather than defaulted — a consumer that infers deletion from an absent value gets the tombstone case wrong exactly when convergence depends on it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["contextId", "key", "version", "deleted", "updatedAt"];
+            readonly properties: {
+                readonly contextId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The VTA context the item is scoped to; the isolation boundary.";
+                };
+                readonly key: {
+                    readonly $ref: "#/$defs/MemoryKey";
+                };
+                readonly version: {
+                    readonly $ref: "#/$defs/MemoryVersion";
+                    readonly description: "The context counter value this item's most recent write took. Supply it as `expectedVersion` on the next write to make that write conditional on nothing having changed in between.";
+                };
+                readonly value: {
+                    readonly $ref: "#/$defs/MemoryValue";
+                    readonly description: "The remembered text. Absent when this is a tombstone or a metadata-only view.";
+                };
+                readonly valueBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Size of the stored value in bytes over its UTF-8 encoding, as the maintainer measures it for the per-item cap. Present in metadata-only views so a consumer can decide what to fetch without fetching it; absent on a tombstone.";
+                };
+                readonly deleted: {
+                    readonly type: "boolean";
+                    readonly description: "True when this is a tombstone: the item was deleted, and this entry exists so that a consumer syncing incrementally learns of the deletion. Tombstones are reaped after the maintainer's retention window; see `vta/memory/list`.";
+                };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the item was first created at this key. MAY be absent on a tombstone whose body has been discarded, and on an item written before the maintainer kept versions.";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the write that produced this `version` was applied. For a tombstone, when the delete was applied.";
+                };
+                readonly deletedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the item was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.";
+                };
+            };
+        };
+        readonly MemoryValue: {
+            readonly title: "MemoryValue";
+            readonly 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`).";
+            readonly type: "string";
+        };
+        readonly MemoryVersion: {
+            readonly title: "MemoryVersion";
+            readonly description: "A value of the context's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.";
+            readonly type: "integer";
+            readonly minimum: 1;
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vta/memory/get/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vta/memory/get/0.1";
+        readonly title: "VTA Memory Get — payload";
+        readonly description: "Recall up to 256 named memory items from one context in a single round trip. The read an agent makes when it knows what it needs, and the one whose audit record says exactly which items it saw.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["contextId", "keys"];
+        readonly properties: {
+            readonly contextId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "The VTA context the items are scoped to; the isolation boundary.";
+            };
+            readonly keys: {
+                readonly type: "array";
+                readonly minItems: 1;
+                readonly maxItems: 256;
+                readonly uniqueItems: true;
+                readonly items: {
+                    readonly $ref: "#/$defs/MemoryKey";
+                };
+                readonly description: "The keys to recall. Duplicates are refused rather than deduplicated, because a caller that sent one did not mean to and would otherwise never find out.";
+            };
+            readonly includeDeleted: {
+                readonly type: "boolean";
+                readonly description: "Defaults to false. When true, a key holding a tombstone yields an item with `deleted: true` rather than appearing in `missing`.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+                readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA Memory Get — response payload";
+                readonly description: "Success response to vta/memory/get. Type https://trusttasks.org/spec/vta/memory/get/0.1#response. Every requested key appears in exactly one of `items`, `missing` or `deferred`, so a caller can account for all of them without comparing sets itself.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["items", "missing"];
+                readonly properties: {
+                    readonly items: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/MemoryRecord";
+                        };
+                        readonly description: "The items found, each with its `value` (a tombstone has none), in the order the keys were requested. May be empty.";
+                    };
+                    readonly missing: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/MemoryKey";
+                        };
+                        readonly description: "Requested keys holding no item — and, unless `includeDeleted` was set, keys holding only a tombstone. Reported rather than silently omitted.";
+                    };
+                    readonly deferred: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/MemoryKey";
+                        };
+                        readonly description: "Requested keys the maintainer did not evaluate because the response had reached its size budget. The caller re-requests exactly these. A deferred key was not read, and a maintainer MUST NOT record it as read.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                        readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly MemoryKey: {
+                readonly title: "MemoryKey";
+                readonly 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.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 512;
+                readonly pattern: "^[^\\u0000]+$";
+            };
+            readonly MemoryRecord: {
+                readonly title: "MemoryRecord";
+                readonly description: "A memory item as the maintainer holds it. `value` is absent in two distinct situations and a consumer MUST NOT conflate them: the item is a tombstone (`deleted` is true), or the caller asked for a metadata-only view (`vta/memory/list` without `includeValues`). This is why `deleted` is required rather than defaulted — a consumer that infers deletion from an absent value gets the tombstone case wrong exactly when convergence depends on it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["contextId", "key", "version", "deleted", "updatedAt"];
+                readonly properties: {
+                    readonly contextId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The VTA context the item is scoped to; the isolation boundary.";
+                    };
+                    readonly key: {
+                        readonly $ref: "#/$defs/MemoryKey";
+                    };
+                    readonly version: {
+                        readonly $ref: "#/$defs/MemoryVersion";
+                        readonly description: "The context counter value this item's most recent write took. Supply it as `expectedVersion` on the next write to make that write conditional on nothing having changed in between.";
+                    };
+                    readonly value: {
+                        readonly $ref: "#/$defs/MemoryValue";
+                        readonly description: "The remembered text. Absent when this is a tombstone or a metadata-only view.";
+                    };
+                    readonly valueBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Size of the stored value in bytes over its UTF-8 encoding, as the maintainer measures it for the per-item cap. Present in metadata-only views so a consumer can decide what to fetch without fetching it; absent on a tombstone.";
+                    };
+                    readonly deleted: {
+                        readonly type: "boolean";
+                        readonly description: "True when this is a tombstone: the item was deleted, and this entry exists so that a consumer syncing incrementally learns of the deletion. Tombstones are reaped after the maintainer's retention window; see `vta/memory/list`.";
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the item was first created at this key. MAY be absent on a tombstone whose body has been discarded, and on an item written before the maintainer kept versions.";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the write that produced this `version` was applied. For a tombstone, when the delete was applied.";
+                    };
+                    readonly deletedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the item was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.";
+                    };
+                };
+            };
+            readonly MemoryValue: {
+                readonly title: "MemoryValue";
+                readonly 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`).";
+                readonly type: "string";
+            };
+            readonly MemoryVersion: {
+                readonly title: "MemoryVersion";
+                readonly description: "A value of the context's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.";
+                readonly type: "integer";
+                readonly minimum: 1;
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vta/memory/get/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA Memory Get — response payload";
+                readonly description: "Success response to vta/memory/get. Type https://trusttasks.org/spec/vta/memory/get/0.1#response. Every requested key appears in exactly one of `items`, `missing` or `deferred`, so a caller can account for all of them without comparing sets itself.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["items", "missing"];
+                readonly properties: {
+                    readonly items: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/MemoryRecord";
+                        };
+                        readonly description: "The items found, each with its `value` (a tombstone has none), in the order the keys were requested. May be empty.";
+                    };
+                    readonly missing: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/MemoryKey";
+                        };
+                        readonly description: "Requested keys holding no item — and, unless `includeDeleted` was set, keys holding only a tombstone. Reported rather than silently omitted.";
+                    };
+                    readonly deferred: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/MemoryKey";
+                        };
+                        readonly description: "Requested keys the maintainer did not evaluate because the response had reached its size budget. The caller re-requests exactly these. A deferred key was not read, and a maintainer MUST NOT record it as read.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                        readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly MemoryKey: {
+                readonly title: "MemoryKey";
+                readonly 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.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 512;
+                readonly pattern: "^[^\\u0000]+$";
+            };
+            readonly MemoryRecord: {
+                readonly title: "MemoryRecord";
+                readonly description: "A memory item as the maintainer holds it. `value` is absent in two distinct situations and a consumer MUST NOT conflate them: the item is a tombstone (`deleted` is true), or the caller asked for a metadata-only view (`vta/memory/list` without `includeValues`). This is why `deleted` is required rather than defaulted — a consumer that infers deletion from an absent value gets the tombstone case wrong exactly when convergence depends on it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["contextId", "key", "version", "deleted", "updatedAt"];
+                readonly properties: {
+                    readonly contextId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The VTA context the item is scoped to; the isolation boundary.";
+                    };
+                    readonly key: {
+                        readonly $ref: "#/$defs/MemoryKey";
+                    };
+                    readonly version: {
+                        readonly $ref: "#/$defs/MemoryVersion";
+                        readonly description: "The context counter value this item's most recent write took. Supply it as `expectedVersion` on the next write to make that write conditional on nothing having changed in between.";
+                    };
+                    readonly value: {
+                        readonly $ref: "#/$defs/MemoryValue";
+                        readonly description: "The remembered text. Absent when this is a tombstone or a metadata-only view.";
+                    };
+                    readonly valueBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Size of the stored value in bytes over its UTF-8 encoding, as the maintainer measures it for the per-item cap. Present in metadata-only views so a consumer can decide what to fetch without fetching it; absent on a tombstone.";
+                    };
+                    readonly deleted: {
+                        readonly type: "boolean";
+                        readonly description: "True when this is a tombstone: the item was deleted, and this entry exists so that a consumer syncing incrementally learns of the deletion. Tombstones are reaped after the maintainer's retention window; see `vta/memory/list`.";
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the item was first created at this key. MAY be absent on a tombstone whose body has been discarded, and on an item written before the maintainer kept versions.";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the write that produced this `version` was applied. For a tombstone, when the delete was applied.";
+                    };
+                    readonly deletedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the item was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.";
+                    };
+                };
+            };
+            readonly MemoryValue: {
+                readonly title: "MemoryValue";
+                readonly 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`).";
+                readonly type: "string";
+            };
+            readonly MemoryVersion: {
+                readonly title: "MemoryVersion";
+                readonly description: "A value of the context's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.";
+                readonly type: "integer";
+                readonly minimum: 1;
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vta/memory/get/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vta/memory/get/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAGlH;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,IAAI,EAAE,CAAC,SAAS,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;IAClC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;IACvB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;AAEzE,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,gDAAyD,CAAC;AAElF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAE1C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,yDAAkE,CAAC;AAEpG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,2BAA2B,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgKjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+H1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}