@openvtc/trust-tasks 0.12.1 → 0.12.3

package/dist/vta/app-state/get/1.0/payload.d.ts

@@ -0,0 +1,611 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/app-state/get/1.0/payload.schema.json
+ */
+/**
+ * Scopes one application's records within a context, so several tools can share a context without colliding — `openvtc`, `cnm`, an agent runtime. The maintainer MUST NOT interpret the value; it is an opaque partition name. Namespaces are first-come and unreserved, so an application SHOULD pick a stable, specific one: a future per-namespace ACL would grant on this exact string, which makes renaming a namespace a migration rather than an edit.
+ */
+export type Namespace = string;
+/**
+ * Application-chosen identifier for a record within a namespace. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `list` is a byte-prefix comparison over the UTF-8 encoding. Applications SHOULD use `/`-delimited hierarchical keys (`community/acme`, `contact/z6Mk…`) so that `prefix` can address a record family, but the delimiter is a convention between an application and itself — the maintainer attaches no meaning to it.
+ */
+export type Key = string;
+/**
+ * The namespace counter value this record's most recent write took. Supply it as `expectedVersion` on the next write to make that write conditional on nothing having changed in between.
+ */
+export type Version = number;
+/**
+ * Read one application-state record by its `(contextId, namespace, key)` address. Returns the record with its value and its version; the version is what a subsequent conditional write supplies as `expectedVersion`.
+ */
+export interface VTAApplicationStateGetPayload {
+    /**
+     * The VTA context the record is scoped to; the isolation boundary.
+     */
+    contextId: string;
+    namespace: Namespace;
+    key: Key;
+    /**
+     * Defaults to false. When true, a tombstone at this address is returned as a record with `deleted: true` instead of being reported as absent. Lets a consumer distinguish "deleted, and here is the version that deleted it" from "never existed, or deleted so long ago the tombstone was reaped" — a distinction a repair path needs and a normal read does not.
+     */
+    includeDeleted?: boolean;
+    ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+    [k: string]: unknown | undefined;
+}
+/**
+ * Success response to vta/app-state/get. Type https://trusttasks.org/spec/vta/app-state/get/1.0#response. An absent record is not a success: it is reported as a trust-task-error carrying vta/app-state/get:notFound.
+ */
+export interface VTAApplicationStateGetResponsePayload {
+    record: AppStateRecord;
+    ext?: Ext1;
+}
+/**
+ * The record at the requested address, with its `value` populated (unless it is a tombstone returned under `includeDeleted`).
+ */
+export interface AppStateRecord {
+    /**
+     * The VTA context the record is scoped to; the isolation boundary.
+     */
+    contextId: string;
+    namespace: Namespace;
+    key: Key;
+    version: Version;
+    /**
+     * The stored JSON, in whatever shape the owning application chose. Any JSON value, including `null`. The maintainer neither validates nor interprets it. Absent when this is a tombstone or a metadata-only view — see this definition's description for why that is not the same as a null value.
+     */
+    value?: {
+        [k: string]: unknown | undefined;
+    };
+    /**
+     * Size of the stored value in bytes, measured as the maintainer measures it for the per-record cap (see `vta/app-state/put`). Present in metadata-only views so a consumer can decide what to fetch without fetching it; absent on a tombstone.
+     */
+    valueBytes?: number;
+    /**
+     * True when this is a tombstone: the record 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/app-state/list`.
+     */
+    deleted: boolean;
+    /**
+     * When the record was first created at this address. MAY be absent on a tombstone whose body has been discarded.
+     */
+    createdAt?: string;
+    /**
+     * When the write that produced this `version` was applied. For a tombstone, when the delete was applied.
+     */
+    updatedAt: string;
+    /**
+     * When the record was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.
+     */
+    deletedAt?: string;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext1 {
+    [k: string]: unknown | undefined;
+}
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vta/app-state/get/1.0";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAApplicationStateGetPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/app-state/get/1.0#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAApplicationStateGetResponsePayload;
+/**
+ * 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/app-state/get/1.0";
+    readonly title: "VTA Application State Get — payload";
+    readonly description: "Read one application-state record by its `(contextId, namespace, key)` address. Returns the record with its value and its version; the version is what a subsequent conditional write supplies as `expectedVersion`.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["contextId", "namespace", "key"];
+    readonly properties: {
+        readonly contextId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "The VTA context the record is scoped to; the isolation boundary.";
+        };
+        readonly namespace: {
+            readonly $ref: "#/$defs/Namespace";
+        };
+        readonly key: {
+            readonly $ref: "#/$defs/Key";
+        };
+        readonly includeDeleted: {
+            readonly type: "boolean";
+            readonly description: "Defaults to false. When true, a tombstone at this address is returned as a record with `deleted: true` instead of being reported as absent. Lets a consumer distinguish \"deleted, and here is the version that deleted it\" from \"never existed, or deleted so long ago the tombstone was reaped\" — a distinction a repair path needs and a normal read does not.";
+        };
+        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 Application State Get — response payload";
+            readonly description: "Success response to vta/app-state/get. Type https://trusttasks.org/spec/vta/app-state/get/1.0#response. An absent record is not a success: it is reported as a trust-task-error carrying vta/app-state/get:notFound.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["record"];
+            readonly properties: {
+                readonly record: {
+                    readonly $ref: "#/$defs/AppStateRecord";
+                    readonly description: "The record at the requested address, with its `value` populated (unless it is a tombstone returned under `includeDeleted`).";
+                };
+                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 AppStateRecord: {
+            readonly title: "AppStateRecord";
+            readonly description: "A record as the maintainer holds it. `value` is absent in three distinct situations and a consumer MUST NOT conflate them: the record is a tombstone (`deleted` is true); the caller asked for a metadata-only view (`list` without `includeValues`); or the value genuinely is the JSON literal `null`, in which case `value` is PRESENT and null. This is why `deleted` is required rather than defaulted — a consumer that has to infer 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", "namespace", "key", "version", "deleted", "updatedAt"];
+            readonly properties: {
+                readonly contextId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The VTA context the record is scoped to; the isolation boundary.";
+                };
+                readonly namespace: {
+                    readonly $ref: "#/$defs/Namespace";
+                };
+                readonly key: {
+                    readonly $ref: "#/$defs/Key";
+                };
+                readonly version: {
+                    readonly $ref: "#/$defs/Version";
+                    readonly description: "The namespace counter value this record'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 description: "The stored JSON, in whatever shape the owning application chose. Any JSON value, including `null`. The maintainer neither validates nor interprets it. Absent when this is a tombstone or a metadata-only view — see this definition's description for why that is not the same as a null value.";
+                };
+                readonly valueBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Size of the stored value in bytes, measured as the maintainer measures it for the per-record cap (see `vta/app-state/put`). 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 record 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/app-state/list`.";
+                };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the record was first created at this address. MAY be absent on a tombstone whose body has been discarded.";
+                };
+                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 record was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.";
+                };
+            };
+        };
+        readonly Version: {
+            readonly title: "Version";
+            readonly description: "A value of the namespace's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.";
+            readonly type: "integer";
+            readonly minimum: 1;
+        };
+        readonly Key: {
+            readonly title: "Key";
+            readonly description: "Application-chosen identifier for a record within a namespace. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `list` is a byte-prefix comparison over the UTF-8 encoding. Applications SHOULD use `/`-delimited hierarchical keys (`community/acme`, `contact/z6Mk…`) so that `prefix` can address a record family, but the delimiter is a convention between an application and itself — the maintainer attaches no meaning to it.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 512;
+            readonly pattern: "^[^\\u0000]+$";
+        };
+        readonly Namespace: {
+            readonly title: "Namespace";
+            readonly description: "Scopes one application's records within a context, so several tools can share a context without colliding — `openvtc`, `cnm`, an agent runtime. The maintainer MUST NOT interpret the value; it is an opaque partition name. Namespaces are first-come and unreserved, so an application SHOULD pick a stable, specific one: a future per-namespace ACL would grant on this exact string, which makes renaming a namespace a migration rather than an edit.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 64;
+            readonly pattern: "^[a-z][a-z0-9]*(-[a-z0-9]+)*$";
+        };
+    };
+};
+/** 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 Application State Get — response payload";
+            readonly description: "Success response to vta/app-state/get. Type https://trusttasks.org/spec/vta/app-state/get/1.0#response. An absent record is not a success: it is reported as a trust-task-error carrying vta/app-state/get:notFound.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["record"];
+            readonly properties: {
+                readonly record: {
+                    readonly $ref: "#/$defs/AppStateRecord";
+                    readonly description: "The record at the requested address, with its `value` populated (unless it is a tombstone returned under `includeDeleted`).";
+                };
+                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 AppStateRecord: {
+            readonly title: "AppStateRecord";
+            readonly description: "A record as the maintainer holds it. `value` is absent in three distinct situations and a consumer MUST NOT conflate them: the record is a tombstone (`deleted` is true); the caller asked for a metadata-only view (`list` without `includeValues`); or the value genuinely is the JSON literal `null`, in which case `value` is PRESENT and null. This is why `deleted` is required rather than defaulted — a consumer that has to infer 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", "namespace", "key", "version", "deleted", "updatedAt"];
+            readonly properties: {
+                readonly contextId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The VTA context the record is scoped to; the isolation boundary.";
+                };
+                readonly namespace: {
+                    readonly $ref: "#/$defs/Namespace";
+                };
+                readonly key: {
+                    readonly $ref: "#/$defs/Key";
+                };
+                readonly version: {
+                    readonly $ref: "#/$defs/Version";
+                    readonly description: "The namespace counter value this record'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 description: "The stored JSON, in whatever shape the owning application chose. Any JSON value, including `null`. The maintainer neither validates nor interprets it. Absent when this is a tombstone or a metadata-only view — see this definition's description for why that is not the same as a null value.";
+                };
+                readonly valueBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Size of the stored value in bytes, measured as the maintainer measures it for the per-record cap (see `vta/app-state/put`). 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 record 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/app-state/list`.";
+                };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the record was first created at this address. MAY be absent on a tombstone whose body has been discarded.";
+                };
+                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 record was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.";
+                };
+            };
+        };
+        readonly Version: {
+            readonly title: "Version";
+            readonly description: "A value of the namespace's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.";
+            readonly type: "integer";
+            readonly minimum: 1;
+        };
+        readonly Key: {
+            readonly title: "Key";
+            readonly description: "Application-chosen identifier for a record within a namespace. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `list` is a byte-prefix comparison over the UTF-8 encoding. Applications SHOULD use `/`-delimited hierarchical keys (`community/acme`, `contact/z6Mk…`) so that `prefix` can address a record family, but the delimiter is a convention between an application and itself — the maintainer attaches no meaning to it.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 512;
+            readonly pattern: "^[^\\u0000]+$";
+        };
+        readonly Namespace: {
+            readonly title: "Namespace";
+            readonly description: "Scopes one application's records within a context, so several tools can share a context without colliding — `openvtc`, `cnm`, an agent runtime. The maintainer MUST NOT interpret the value; it is an opaque partition name. Namespaces are first-come and unreserved, so an application SHOULD pick a stable, specific one: a future per-namespace ACL would grant on this exact string, which makes renaming a namespace a migration rather than an edit.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 64;
+            readonly pattern: "^[a-z][a-z0-9]*(-[a-z0-9]+)*$";
+        };
+    };
+};
+/**
+ * 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/app-state/get/1.0";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vta/app-state/get/1.0";
+        readonly title: "VTA Application State Get — payload";
+        readonly description: "Read one application-state record by its `(contextId, namespace, key)` address. Returns the record with its value and its version; the version is what a subsequent conditional write supplies as `expectedVersion`.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["contextId", "namespace", "key"];
+        readonly properties: {
+            readonly contextId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "The VTA context the record is scoped to; the isolation boundary.";
+            };
+            readonly namespace: {
+                readonly $ref: "#/$defs/Namespace";
+            };
+            readonly key: {
+                readonly $ref: "#/$defs/Key";
+            };
+            readonly includeDeleted: {
+                readonly type: "boolean";
+                readonly description: "Defaults to false. When true, a tombstone at this address is returned as a record with `deleted: true` instead of being reported as absent. Lets a consumer distinguish \"deleted, and here is the version that deleted it\" from \"never existed, or deleted so long ago the tombstone was reaped\" — a distinction a repair path needs and a normal read does not.";
+            };
+            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 Application State Get — response payload";
+                readonly description: "Success response to vta/app-state/get. Type https://trusttasks.org/spec/vta/app-state/get/1.0#response. An absent record is not a success: it is reported as a trust-task-error carrying vta/app-state/get:notFound.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["record"];
+                readonly properties: {
+                    readonly record: {
+                        readonly $ref: "#/$defs/AppStateRecord";
+                        readonly description: "The record at the requested address, with its `value` populated (unless it is a tombstone returned under `includeDeleted`).";
+                    };
+                    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 AppStateRecord: {
+                readonly title: "AppStateRecord";
+                readonly description: "A record as the maintainer holds it. `value` is absent in three distinct situations and a consumer MUST NOT conflate them: the record is a tombstone (`deleted` is true); the caller asked for a metadata-only view (`list` without `includeValues`); or the value genuinely is the JSON literal `null`, in which case `value` is PRESENT and null. This is why `deleted` is required rather than defaulted — a consumer that has to infer 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", "namespace", "key", "version", "deleted", "updatedAt"];
+                readonly properties: {
+                    readonly contextId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The VTA context the record is scoped to; the isolation boundary.";
+                    };
+                    readonly namespace: {
+                        readonly $ref: "#/$defs/Namespace";
+                    };
+                    readonly key: {
+                        readonly $ref: "#/$defs/Key";
+                    };
+                    readonly version: {
+                        readonly $ref: "#/$defs/Version";
+                        readonly description: "The namespace counter value this record'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 description: "The stored JSON, in whatever shape the owning application chose. Any JSON value, including `null`. The maintainer neither validates nor interprets it. Absent when this is a tombstone or a metadata-only view — see this definition's description for why that is not the same as a null value.";
+                    };
+                    readonly valueBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Size of the stored value in bytes, measured as the maintainer measures it for the per-record cap (see `vta/app-state/put`). 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 record 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/app-state/list`.";
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the record was first created at this address. MAY be absent on a tombstone whose body has been discarded.";
+                    };
+                    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 record was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.";
+                    };
+                };
+            };
+            readonly Version: {
+                readonly title: "Version";
+                readonly description: "A value of the namespace's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.";
+                readonly type: "integer";
+                readonly minimum: 1;
+            };
+            readonly Key: {
+                readonly title: "Key";
+                readonly description: "Application-chosen identifier for a record within a namespace. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `list` is a byte-prefix comparison over the UTF-8 encoding. Applications SHOULD use `/`-delimited hierarchical keys (`community/acme`, `contact/z6Mk…`) so that `prefix` can address a record family, but the delimiter is a convention between an application and itself — the maintainer attaches no meaning to it.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 512;
+                readonly pattern: "^[^\\u0000]+$";
+            };
+            readonly Namespace: {
+                readonly title: "Namespace";
+                readonly description: "Scopes one application's records within a context, so several tools can share a context without colliding — `openvtc`, `cnm`, an agent runtime. The maintainer MUST NOT interpret the value; it is an opaque partition name. Namespaces are first-come and unreserved, so an application SHOULD pick a stable, specific one: a future per-namespace ACL would grant on this exact string, which makes renaming a namespace a migration rather than an edit.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 64;
+                readonly pattern: "^[a-z][a-z0-9]*(-[a-z0-9]+)*$";
+            };
+        };
+    };
+};
+/**
+ * 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/app-state/get/1.0#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: 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 Application State Get — response payload";
+                readonly description: "Success response to vta/app-state/get. Type https://trusttasks.org/spec/vta/app-state/get/1.0#response. An absent record is not a success: it is reported as a trust-task-error carrying vta/app-state/get:notFound.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["record"];
+                readonly properties: {
+                    readonly record: {
+                        readonly $ref: "#/$defs/AppStateRecord";
+                        readonly description: "The record at the requested address, with its `value` populated (unless it is a tombstone returned under `includeDeleted`).";
+                    };
+                    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 AppStateRecord: {
+                readonly title: "AppStateRecord";
+                readonly description: "A record as the maintainer holds it. `value` is absent in three distinct situations and a consumer MUST NOT conflate them: the record is a tombstone (`deleted` is true); the caller asked for a metadata-only view (`list` without `includeValues`); or the value genuinely is the JSON literal `null`, in which case `value` is PRESENT and null. This is why `deleted` is required rather than defaulted — a consumer that has to infer 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", "namespace", "key", "version", "deleted", "updatedAt"];
+                readonly properties: {
+                    readonly contextId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The VTA context the record is scoped to; the isolation boundary.";
+                    };
+                    readonly namespace: {
+                        readonly $ref: "#/$defs/Namespace";
+                    };
+                    readonly key: {
+                        readonly $ref: "#/$defs/Key";
+                    };
+                    readonly version: {
+                        readonly $ref: "#/$defs/Version";
+                        readonly description: "The namespace counter value this record'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 description: "The stored JSON, in whatever shape the owning application chose. Any JSON value, including `null`. The maintainer neither validates nor interprets it. Absent when this is a tombstone or a metadata-only view — see this definition's description for why that is not the same as a null value.";
+                    };
+                    readonly valueBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Size of the stored value in bytes, measured as the maintainer measures it for the per-record cap (see `vta/app-state/put`). 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 record 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/app-state/list`.";
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the record was first created at this address. MAY be absent on a tombstone whose body has been discarded.";
+                    };
+                    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 record was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.";
+                    };
+                };
+            };
+            readonly Version: {
+                readonly title: "Version";
+                readonly description: "A value of the namespace's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.";
+                readonly type: "integer";
+                readonly minimum: 1;
+            };
+            readonly Key: {
+                readonly title: "Key";
+                readonly description: "Application-chosen identifier for a record within a namespace. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `list` is a byte-prefix comparison over the UTF-8 encoding. Applications SHOULD use `/`-delimited hierarchical keys (`community/acme`, `contact/z6Mk…`) so that `prefix` can address a record family, but the delimiter is a convention between an application and itself — the maintainer attaches no meaning to it.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 512;
+                readonly pattern: "^[^\\u0000]+$";
+            };
+            readonly Namespace: {
+                readonly title: "Namespace";
+                readonly description: "Scopes one application's records within a context, so several tools can share a context without colliding — `openvtc`, `cnm`, an agent runtime. The maintainer MUST NOT interpret the value; it is an opaque partition name. Namespaces are first-come and unreserved, so an application SHOULD pick a stable, specific one: a future per-namespace ACL would grant on this exact string, which makes renaming a namespace a migration rather than an edit.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 64;
+                readonly pattern: "^[a-z][a-z0-9]*(-[a-z0-9]+)*$";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vta/app-state/get/1.0/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vta/app-state/get/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AACzB;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,GAAG,CAAC;IACT;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AACD;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD,MAAM,EAAE,cAAc,CAAC;IACvB,GAAG,CAAC,EAAE,IAAI,CAAC;CACZ;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,GAAG,CAAC;IACT,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;KAClC,CAAC;IACF;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AACD;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AAED,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,mDAA4D,CAAC;AAErF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,6BAA6B,CAAC;AAEpD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,4DAAqE,CAAC;AAEvG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,qCAAqC,CAAC;AAE7D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiJjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmH1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAMP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAMhB,CAAC"}