@openvtc/trust-tasks 0.27.2 → 0.27.4

package/dist/keys/list/0.2/payload.d.ts

@@ -0,0 +1,627 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/keys/list/0.2/payload.schema.json
+ */
+import type { Ext, KeyOrigin, KeyRecord, KeyStatus, KeyType } from "../../../_shared/components.js";
+export interface KeysListPayload {
+    /**
+     * Return only keys in this lifecycle state. Omitted returns every state, including revoked keys.
+     */
+    status?: KeyStatus;
+    /**
+     * Return only keys filed under this scope.
+     */
+    contextId?: string;
+    /**
+     * An opaque continuation token from a previous response's `nextCursor`; a responder MUST NOT accept a cursor it did not issue.
+     */
+    cursor?: string;
+    /**
+     * The most items to return; the responder chooses a default and MAY return fewer, and MAY impose its own ceiling.
+     */
+    limit?: number;
+    /**
+     * Ecosystem-defined extension members per SPEC.md §4.5.1.
+     */
+    ext?: Ext;
+}
+/**
+ * The success response to a keys/list request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/keys/list/0.2#response.
+ */
+export interface KeysListResponsePayload {
+    /**
+     * The page of records, in the custodian's own order.
+     */
+    keys: KeyRecord[];
+    /**
+     * Opaque continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page. Its presence is what tells a key audit or rotation sweep it has not yet seen the whole set — a producer that stops while `nextCursor` is present has silently skipped every key past the page boundary.
+     */
+    nextCursor?: string;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, KeyOrigin, KeyRecord, KeyStatus, KeyType };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/keys/list/0.2";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = KeysListPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/keys/list/0.2#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = KeysListResponsePayload;
+/**
+ * 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/keys/list/0.2";
+    readonly title: "Keys List — payload";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly status: {
+            readonly $ref: "#/$defs/KeyStatus";
+            readonly description: "Return only keys in this lifecycle state. Omitted returns every state, including revoked keys.";
+        };
+        readonly contextId: {
+            readonly type: "string";
+            readonly description: "Return only keys filed under this scope.";
+        };
+        readonly cursor: {
+            readonly type: "string";
+            readonly description: "An opaque continuation token from a previous response's `nextCursor`; a responder MUST NOT accept a cursor it did not issue.";
+        };
+        readonly limit: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly description: "The most items to return; the responder chooses a default and MAY return fewer, and MAY impose its own ceiling.";
+        };
+        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: "Keys List — response payload";
+            readonly description: "The success response to a keys/list request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/keys/list/0.2#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["keys"];
+            readonly properties: {
+                readonly keys: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/KeyRecord";
+                    };
+                    readonly description: "The page of records, in the custodian's own order.";
+                };
+                readonly nextCursor: {
+                    readonly type: "string";
+                    readonly description: "Opaque continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page. Its presence is what tells a key audit or rotation sweep it has not yet seen the whole set — a producer that stops while `nextCursor` is present has silently skipped every key past the page boundary.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        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 KeyRecord: {
+            readonly title: "KeyRecord";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["keyId", "keyType", "status", "publicKey", "createdAt"];
+            readonly properties: {
+                readonly keyId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Maintainer-scoped identifier for the key. Stable for the key's lifetime except through an explicit `keys/rename`.";
+                };
+                readonly keyType: {
+                    readonly $ref: "#/$defs/KeyType";
+                };
+                readonly status: {
+                    readonly $ref: "#/$defs/KeyStatus";
+                };
+                readonly publicKey: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The public half, multibase-encoded. The private half is never carried by any keys/* response.";
+                };
+                readonly derivationPath: {
+                    readonly type: "string";
+                    readonly description: "Hierarchical-deterministic path the key was derived at, when `origin` is `derived`. Absent for imported keys, which have no path.";
+                };
+                readonly seedId: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Identifier of the seed the key was derived from, when the maintainer holds more than one. Absent for imported keys.";
+                };
+                readonly origin: {
+                    readonly $ref: "#/$defs/KeyOrigin";
+                };
+                readonly label: {
+                    readonly type: "string";
+                    readonly maxLength: 256;
+                    readonly description: "Optional human-readable label. Operator-facing only; carries no authorization meaning.";
+                };
+                readonly exportable: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the private half may be released to a caller. `false` means the custodian refuses every export of this key and can only be asked to *use* it — signing, key agreement — so the material never leaves. **Absence means the key may be exported.** That is the permissive reading, and it is deliberate: it is what every record written before this member existed already meant, so a custodian adding the member cannot silently retract access to keys its callers already hold. A consumer MUST NOT infer the converse — absence is not a statement that export was considered and allowed. Marking a key non-exportable does not make it unrecoverable: a custodian's own whole-store backup is a different mechanism from an export to a caller, and this member does not speak to it.";
+                    readonly $comment: "No JSON Schema `default` is declared here on purpose. A declared default is materialised by the generated bindings — the field becomes non-optional with a serde default — so an absent member reappears as an explicit `true` on re-serialisation, which breaks round-trip idempotence for every record written before this member existed. The permissive reading is stated in prose above, where a binding cannot act on it.";
+                };
+                readonly contextId: {
+                    readonly type: "string";
+                    readonly description: "Scope the key belongs to. **Absence is not 'every scope'** — a key with no context is reachable only by a caller with unrestricted authority over the maintainer, which is the more restrictive reading, and a consumer that treats absence as a wildcard inverts the guarantee.";
+                };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "RFC 3339 timestamp at which the key was created or imported.";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "RFC 3339 timestamp of the last change to the record (rename, revocation).";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly KeyOrigin: {
+            readonly title: "KeyOrigin";
+            readonly type: "string";
+            readonly enum: readonly ["derived", "imported", "internal"];
+            readonly description: "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.";
+            readonly default: "derived";
+        };
+        readonly KeyStatus: {
+            readonly title: "KeyStatus";
+            readonly type: "string";
+            readonly enum: readonly ["active", "revoked"];
+            readonly description: "Lifecycle state. Only an `active` key may be named in a signing request; a `revoked` key is retained so historic signatures remain attributable, and MUST NOT be reactivated.";
+        };
+        readonly KeyType: {
+            readonly title: "KeyType";
+            readonly type: "string";
+            readonly enum: readonly ["ed25519", "x25519", "p256", "mldsa44", "mldsa65"];
+            readonly description: "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support.";
+        };
+    };
+};
+/** 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: "Keys List — response payload";
+            readonly description: "The success response to a keys/list request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/keys/list/0.2#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["keys"];
+            readonly properties: {
+                readonly keys: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/KeyRecord";
+                    };
+                    readonly description: "The page of records, in the custodian's own order.";
+                };
+                readonly nextCursor: {
+                    readonly type: "string";
+                    readonly description: "Opaque continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page. Its presence is what tells a key audit or rotation sweep it has not yet seen the whole set — a producer that stops while `nextCursor` is present has silently skipped every key past the page boundary.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        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 KeyRecord: {
+            readonly title: "KeyRecord";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["keyId", "keyType", "status", "publicKey", "createdAt"];
+            readonly properties: {
+                readonly keyId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Maintainer-scoped identifier for the key. Stable for the key's lifetime except through an explicit `keys/rename`.";
+                };
+                readonly keyType: {
+                    readonly $ref: "#/$defs/KeyType";
+                };
+                readonly status: {
+                    readonly $ref: "#/$defs/KeyStatus";
+                };
+                readonly publicKey: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The public half, multibase-encoded. The private half is never carried by any keys/* response.";
+                };
+                readonly derivationPath: {
+                    readonly type: "string";
+                    readonly description: "Hierarchical-deterministic path the key was derived at, when `origin` is `derived`. Absent for imported keys, which have no path.";
+                };
+                readonly seedId: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Identifier of the seed the key was derived from, when the maintainer holds more than one. Absent for imported keys.";
+                };
+                readonly origin: {
+                    readonly $ref: "#/$defs/KeyOrigin";
+                };
+                readonly label: {
+                    readonly type: "string";
+                    readonly maxLength: 256;
+                    readonly description: "Optional human-readable label. Operator-facing only; carries no authorization meaning.";
+                };
+                readonly exportable: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the private half may be released to a caller. `false` means the custodian refuses every export of this key and can only be asked to *use* it — signing, key agreement — so the material never leaves. **Absence means the key may be exported.** That is the permissive reading, and it is deliberate: it is what every record written before this member existed already meant, so a custodian adding the member cannot silently retract access to keys its callers already hold. A consumer MUST NOT infer the converse — absence is not a statement that export was considered and allowed. Marking a key non-exportable does not make it unrecoverable: a custodian's own whole-store backup is a different mechanism from an export to a caller, and this member does not speak to it.";
+                    readonly $comment: "No JSON Schema `default` is declared here on purpose. A declared default is materialised by the generated bindings — the field becomes non-optional with a serde default — so an absent member reappears as an explicit `true` on re-serialisation, which breaks round-trip idempotence for every record written before this member existed. The permissive reading is stated in prose above, where a binding cannot act on it.";
+                };
+                readonly contextId: {
+                    readonly type: "string";
+                    readonly description: "Scope the key belongs to. **Absence is not 'every scope'** — a key with no context is reachable only by a caller with unrestricted authority over the maintainer, which is the more restrictive reading, and a consumer that treats absence as a wildcard inverts the guarantee.";
+                };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "RFC 3339 timestamp at which the key was created or imported.";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "RFC 3339 timestamp of the last change to the record (rename, revocation).";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly KeyOrigin: {
+            readonly title: "KeyOrigin";
+            readonly type: "string";
+            readonly enum: readonly ["derived", "imported", "internal"];
+            readonly description: "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.";
+            readonly default: "derived";
+        };
+        readonly KeyStatus: {
+            readonly title: "KeyStatus";
+            readonly type: "string";
+            readonly enum: readonly ["active", "revoked"];
+            readonly description: "Lifecycle state. Only an `active` key may be named in a signing request; a `revoked` key is retained so historic signatures remain attributable, and MUST NOT be reactivated.";
+        };
+        readonly KeyType: {
+            readonly title: "KeyType";
+            readonly type: "string";
+            readonly enum: readonly ["ed25519", "x25519", "p256", "mldsa44", "mldsa65"];
+            readonly description: "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support.";
+        };
+    };
+};
+/**
+ * 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/keys/list/0.2";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/keys/list/0.2";
+        readonly title: "Keys List — payload";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly status: {
+                readonly $ref: "#/$defs/KeyStatus";
+                readonly description: "Return only keys in this lifecycle state. Omitted returns every state, including revoked keys.";
+            };
+            readonly contextId: {
+                readonly type: "string";
+                readonly description: "Return only keys filed under this scope.";
+            };
+            readonly cursor: {
+                readonly type: "string";
+                readonly description: "An opaque continuation token from a previous response's `nextCursor`; a responder MUST NOT accept a cursor it did not issue.";
+            };
+            readonly limit: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly description: "The most items to return; the responder chooses a default and MAY return fewer, and MAY impose its own ceiling.";
+            };
+            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: "Keys List — response payload";
+                readonly description: "The success response to a keys/list request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/keys/list/0.2#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["keys"];
+                readonly properties: {
+                    readonly keys: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/KeyRecord";
+                        };
+                        readonly description: "The page of records, in the custodian's own order.";
+                    };
+                    readonly nextCursor: {
+                        readonly type: "string";
+                        readonly description: "Opaque continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page. Its presence is what tells a key audit or rotation sweep it has not yet seen the whole set — a producer that stops while `nextCursor` is present has silently skipped every key past the page boundary.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            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 KeyRecord: {
+                readonly title: "KeyRecord";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["keyId", "keyType", "status", "publicKey", "createdAt"];
+                readonly properties: {
+                    readonly keyId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Maintainer-scoped identifier for the key. Stable for the key's lifetime except through an explicit `keys/rename`.";
+                    };
+                    readonly keyType: {
+                        readonly $ref: "#/$defs/KeyType";
+                    };
+                    readonly status: {
+                        readonly $ref: "#/$defs/KeyStatus";
+                    };
+                    readonly publicKey: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The public half, multibase-encoded. The private half is never carried by any keys/* response.";
+                    };
+                    readonly derivationPath: {
+                        readonly type: "string";
+                        readonly description: "Hierarchical-deterministic path the key was derived at, when `origin` is `derived`. Absent for imported keys, which have no path.";
+                    };
+                    readonly seedId: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Identifier of the seed the key was derived from, when the maintainer holds more than one. Absent for imported keys.";
+                    };
+                    readonly origin: {
+                        readonly $ref: "#/$defs/KeyOrigin";
+                    };
+                    readonly label: {
+                        readonly type: "string";
+                        readonly maxLength: 256;
+                        readonly description: "Optional human-readable label. Operator-facing only; carries no authorization meaning.";
+                    };
+                    readonly exportable: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the private half may be released to a caller. `false` means the custodian refuses every export of this key and can only be asked to *use* it — signing, key agreement — so the material never leaves. **Absence means the key may be exported.** That is the permissive reading, and it is deliberate: it is what every record written before this member existed already meant, so a custodian adding the member cannot silently retract access to keys its callers already hold. A consumer MUST NOT infer the converse — absence is not a statement that export was considered and allowed. Marking a key non-exportable does not make it unrecoverable: a custodian's own whole-store backup is a different mechanism from an export to a caller, and this member does not speak to it.";
+                        readonly $comment: "No JSON Schema `default` is declared here on purpose. A declared default is materialised by the generated bindings — the field becomes non-optional with a serde default — so an absent member reappears as an explicit `true` on re-serialisation, which breaks round-trip idempotence for every record written before this member existed. The permissive reading is stated in prose above, where a binding cannot act on it.";
+                    };
+                    readonly contextId: {
+                        readonly type: "string";
+                        readonly description: "Scope the key belongs to. **Absence is not 'every scope'** — a key with no context is reachable only by a caller with unrestricted authority over the maintainer, which is the more restrictive reading, and a consumer that treats absence as a wildcard inverts the guarantee.";
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "RFC 3339 timestamp at which the key was created or imported.";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "RFC 3339 timestamp of the last change to the record (rename, revocation).";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly KeyOrigin: {
+                readonly title: "KeyOrigin";
+                readonly type: "string";
+                readonly enum: readonly ["derived", "imported", "internal"];
+                readonly description: "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.";
+                readonly default: "derived";
+            };
+            readonly KeyStatus: {
+                readonly title: "KeyStatus";
+                readonly type: "string";
+                readonly enum: readonly ["active", "revoked"];
+                readonly description: "Lifecycle state. Only an `active` key may be named in a signing request; a `revoked` key is retained so historic signatures remain attributable, and MUST NOT be reactivated.";
+            };
+            readonly KeyType: {
+                readonly title: "KeyType";
+                readonly type: "string";
+                readonly enum: readonly ["ed25519", "x25519", "p256", "mldsa44", "mldsa65"];
+                readonly description: "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support.";
+            };
+        };
+    };
+};
+/**
+ * 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/keys/list/0.2#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    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: "Keys List — response payload";
+                readonly description: "The success response to a keys/list request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/keys/list/0.2#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["keys"];
+                readonly properties: {
+                    readonly keys: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/KeyRecord";
+                        };
+                        readonly description: "The page of records, in the custodian's own order.";
+                    };
+                    readonly nextCursor: {
+                        readonly type: "string";
+                        readonly description: "Opaque continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page. Its presence is what tells a key audit or rotation sweep it has not yet seen the whole set — a producer that stops while `nextCursor` is present has silently skipped every key past the page boundary.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            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 KeyRecord: {
+                readonly title: "KeyRecord";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["keyId", "keyType", "status", "publicKey", "createdAt"];
+                readonly properties: {
+                    readonly keyId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Maintainer-scoped identifier for the key. Stable for the key's lifetime except through an explicit `keys/rename`.";
+                    };
+                    readonly keyType: {
+                        readonly $ref: "#/$defs/KeyType";
+                    };
+                    readonly status: {
+                        readonly $ref: "#/$defs/KeyStatus";
+                    };
+                    readonly publicKey: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The public half, multibase-encoded. The private half is never carried by any keys/* response.";
+                    };
+                    readonly derivationPath: {
+                        readonly type: "string";
+                        readonly description: "Hierarchical-deterministic path the key was derived at, when `origin` is `derived`. Absent for imported keys, which have no path.";
+                    };
+                    readonly seedId: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Identifier of the seed the key was derived from, when the maintainer holds more than one. Absent for imported keys.";
+                    };
+                    readonly origin: {
+                        readonly $ref: "#/$defs/KeyOrigin";
+                    };
+                    readonly label: {
+                        readonly type: "string";
+                        readonly maxLength: 256;
+                        readonly description: "Optional human-readable label. Operator-facing only; carries no authorization meaning.";
+                    };
+                    readonly exportable: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the private half may be released to a caller. `false` means the custodian refuses every export of this key and can only be asked to *use* it — signing, key agreement — so the material never leaves. **Absence means the key may be exported.** That is the permissive reading, and it is deliberate: it is what every record written before this member existed already meant, so a custodian adding the member cannot silently retract access to keys its callers already hold. A consumer MUST NOT infer the converse — absence is not a statement that export was considered and allowed. Marking a key non-exportable does not make it unrecoverable: a custodian's own whole-store backup is a different mechanism from an export to a caller, and this member does not speak to it.";
+                        readonly $comment: "No JSON Schema `default` is declared here on purpose. A declared default is materialised by the generated bindings — the field becomes non-optional with a serde default — so an absent member reappears as an explicit `true` on re-serialisation, which breaks round-trip idempotence for every record written before this member existed. The permissive reading is stated in prose above, where a binding cannot act on it.";
+                    };
+                    readonly contextId: {
+                        readonly type: "string";
+                        readonly description: "Scope the key belongs to. **Absence is not 'every scope'** — a key with no context is reachable only by a caller with unrestricted authority over the maintainer, which is the more restrictive reading, and a consumer that treats absence as a wildcard inverts the guarantee.";
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "RFC 3339 timestamp at which the key was created or imported.";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "RFC 3339 timestamp of the last change to the record (rename, revocation).";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly KeyOrigin: {
+                readonly title: "KeyOrigin";
+                readonly type: "string";
+                readonly enum: readonly ["derived", "imported", "internal"];
+                readonly description: "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.";
+                readonly default: "derived";
+            };
+            readonly KeyStatus: {
+                readonly title: "KeyStatus";
+                readonly type: "string";
+                readonly enum: readonly ["active", "revoked"];
+                readonly description: "Lifecycle state. Only an `active` key may be named in a signing request; a `revoked` key is retained so historic signatures remain attributable, and MUST NOT be reactivated.";
+            };
+            readonly KeyType: {
+                readonly title: "KeyType";
+                readonly type: "string";
+                readonly enum: readonly ["ed25519", "x25519", "p256", "mldsa44", "mldsa65"];
+                readonly description: "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/keys/list/0.2/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../src/keys/list/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAGpG,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;AAE9D,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,2CAAoD,CAAC;AAE7E,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,eAAe,CAAC;AAEtC,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,oDAA6D,CAAC;AAE/F,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,uBAAuB,CAAC;AAE/C;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwKjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8I1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}