@openvtc/trust-tasks 0.8.2 → 0.9.0

package/dist/audit/list/0.1/payload.d.ts

@@ -120,16 +120,465 @@ export type Payload = AuditListPayload;
 export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/audit/list/0.1#response";
 /** Stable alias for this specification's success-response payload shape. */
 export type Response = AuditListResponsePayload;
+/**
+ * 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/audit/list/0.1";
+    readonly title: "Audit List — payload";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly from: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly description: "Return only entries recorded at or after this time.";
+        };
+        readonly to: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly description: "Return only entries recorded strictly before this time.";
+        };
+        readonly action: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Return only entries whose `action` equals this value.";
+        };
+        readonly actor: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Return only entries whose `actor` DID equals this value. Matches on the plaintext; redacted entries are not returned by an actor filter.";
+        };
+        readonly outcome: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Return only entries whose `outcome` equals this value.";
+        };
+        readonly contextId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Return only entries in this trust context.";
+        };
+        readonly pageSize: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 1000;
+            readonly description: "Maximum entries to return in this page.";
+        };
+        readonly cursor: {
+            readonly type: "string";
+            readonly description: "Opaque continuation token from a previous response's `cursor`. Encodes the position to resume from; a maintainer SHOULD sign it so it cannot be forged to skip entries. Treated as invalid (see errorCodes) if it fails to verify — e.g. minted before an audit-key rotation. A consumer that supplies a `cursor` MUST NOT also change the filters, which are bound into the cursor's position.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Audit List — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["entries", "truncated"];
+            readonly properties: {
+                readonly entries: {
+                    readonly type: "array";
+                    readonly description: "The matching audit entries, newest first.";
+                    readonly items: {
+                        readonly $ref: "#/$defs/AuditEnvelope";
+                    };
+                };
+                readonly truncated: {
+                    readonly type: "boolean";
+                    readonly description: "True when more entries match beyond this page — `cursor` is then present to fetch them.";
+                };
+                readonly cursor: {
+                    readonly type: "string";
+                    readonly description: "Opaque continuation token for the next page. Present iff `truncated` is true.";
+                };
+                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 AuditEnvelope: {
+            readonly $anchor: "auditEnvelope";
+            readonly title: "AuditEnvelope";
+            readonly description: "One entry in an append-only audit log. Only eventId/recordedAt/action are universal; every other field is populated by maintainers that track it. `prevHash`/`entryHash` are present on hash-chained logs (see audit/verify) and absent otherwise. Principal DIDs are plaintext and MAY be absent when a right-to-be-forgotten redaction has nulled them after the fact.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["eventId", "recordedAt", "action"];
+            readonly properties: {
+                readonly eventId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Stable identifier for this event. Also the tie-breaker component of a cursor's position key.";
+                };
+                readonly recordedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Wall-clock time the entry was written. The primary ordering key.";
+                };
+                readonly action: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.";
+                };
+                readonly outcome: {
+                    readonly type: "string";
+                    readonly description: "How the operation resolved. Typically `success` or `denied`; a maintainer MAY use others. Absent for events that have no pass/fail sense.";
+                };
+                readonly actor: {
+                    readonly type: readonly ["string", "null"];
+                    readonly description: "DID of the principal that performed the action. `null` when a right-to-be-forgotten redaction has removed the plaintext; a maintainer that keeps a keyed hash of the actor for correlation carries it in `ext`, not here.";
+                };
+                readonly target: {
+                    readonly type: readonly ["string", "null"];
+                    readonly description: "DID of the principal the action acted upon, when the event has one. `null`/absent for events whose target is the maintainer itself. Same redaction semantics as `actor`.";
+                };
+                readonly contextId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Trust context the event occurred in, for a maintainer that partitions its log per context.";
+                };
+                readonly schemaVersion: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Envelope-shape version at the maintainer, for consumers that need to reason about wire-shape evolution.";
+                };
+                readonly prevHash: {
+                    readonly $ref: "#/$defs/DigestMultibase";
+                    readonly description: "Hash-chain link: the `entryHash` of the immediately-preceding entry. Present only on chained logs; its integrity is what audit/verify checks. Multibase-encoded multihash over the RFC 8785 (JCS) canonicalization of the predecessor's immutable content — the same derivation as `entryHash`, so a verifier recomputes both the same way.";
+                };
+                readonly entryHash: {
+                    readonly $ref: "#/$defs/DigestMultibase";
+                    readonly description: "Hash-chain commitment over this entry's immutable content. The next entry's `prevHash` points here. Multibase-encoded multihash over the RFC 8785 (JCS) canonicalization of that content; the canonicalization is what makes the commitment reproducible by a verifier that did not write the entry.";
+                };
+                readonly detail: {
+                    readonly type: "object";
+                    readonly description: "Event-specific payload, keyed by `action`. Opaque to the framework; a consumer that does not recognise the action treats it as an unstructured record.";
+                    readonly additionalProperties: true;
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly DigestMultibase: {
+            readonly title: "DigestMultibase";
+            readonly description: "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.";
+            readonly type: "string";
+            readonly minLength: 16;
+            readonly pattern: "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$";
+            readonly examples: readonly ["zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"];
+        };
+    };
+};
+/** 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: "Audit List — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["entries", "truncated"];
+            readonly properties: {
+                readonly entries: {
+                    readonly type: "array";
+                    readonly description: "The matching audit entries, newest first.";
+                    readonly items: {
+                        readonly $ref: "#/$defs/AuditEnvelope";
+                    };
+                };
+                readonly truncated: {
+                    readonly type: "boolean";
+                    readonly description: "True when more entries match beyond this page — `cursor` is then present to fetch them.";
+                };
+                readonly cursor: {
+                    readonly type: "string";
+                    readonly description: "Opaque continuation token for the next page. Present iff `truncated` is true.";
+                };
+                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 AuditEnvelope: {
+            readonly $anchor: "auditEnvelope";
+            readonly title: "AuditEnvelope";
+            readonly description: "One entry in an append-only audit log. Only eventId/recordedAt/action are universal; every other field is populated by maintainers that track it. `prevHash`/`entryHash` are present on hash-chained logs (see audit/verify) and absent otherwise. Principal DIDs are plaintext and MAY be absent when a right-to-be-forgotten redaction has nulled them after the fact.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["eventId", "recordedAt", "action"];
+            readonly properties: {
+                readonly eventId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Stable identifier for this event. Also the tie-breaker component of a cursor's position key.";
+                };
+                readonly recordedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Wall-clock time the entry was written. The primary ordering key.";
+                };
+                readonly action: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.";
+                };
+                readonly outcome: {
+                    readonly type: "string";
+                    readonly description: "How the operation resolved. Typically `success` or `denied`; a maintainer MAY use others. Absent for events that have no pass/fail sense.";
+                };
+                readonly actor: {
+                    readonly type: readonly ["string", "null"];
+                    readonly description: "DID of the principal that performed the action. `null` when a right-to-be-forgotten redaction has removed the plaintext; a maintainer that keeps a keyed hash of the actor for correlation carries it in `ext`, not here.";
+                };
+                readonly target: {
+                    readonly type: readonly ["string", "null"];
+                    readonly description: "DID of the principal the action acted upon, when the event has one. `null`/absent for events whose target is the maintainer itself. Same redaction semantics as `actor`.";
+                };
+                readonly contextId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Trust context the event occurred in, for a maintainer that partitions its log per context.";
+                };
+                readonly schemaVersion: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Envelope-shape version at the maintainer, for consumers that need to reason about wire-shape evolution.";
+                };
+                readonly prevHash: {
+                    readonly $ref: "#/$defs/DigestMultibase";
+                    readonly description: "Hash-chain link: the `entryHash` of the immediately-preceding entry. Present only on chained logs; its integrity is what audit/verify checks. Multibase-encoded multihash over the RFC 8785 (JCS) canonicalization of the predecessor's immutable content — the same derivation as `entryHash`, so a verifier recomputes both the same way.";
+                };
+                readonly entryHash: {
+                    readonly $ref: "#/$defs/DigestMultibase";
+                    readonly description: "Hash-chain commitment over this entry's immutable content. The next entry's `prevHash` points here. Multibase-encoded multihash over the RFC 8785 (JCS) canonicalization of that content; the canonicalization is what makes the commitment reproducible by a verifier that did not write the entry.";
+                };
+                readonly detail: {
+                    readonly type: "object";
+                    readonly description: "Event-specific payload, keyed by `action`. Opaque to the framework; a consumer that does not recognise the action treats it as an unstructured record.";
+                    readonly additionalProperties: true;
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly DigestMultibase: {
+            readonly title: "DigestMultibase";
+            readonly description: "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.";
+            readonly type: "string";
+            readonly minLength: 16;
+            readonly pattern: "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$";
+            readonly examples: readonly ["zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"];
+        };
+    };
+};
 /**
  * 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.
+ * 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/audit/list/0.1";
     readonly isBearer: false;
     readonly isProofRequired: true;
     readonly isRecipientRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/audit/list/0.1";
+        readonly title: "Audit List — payload";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly from: {
+                readonly type: "string";
+                readonly format: "date-time";
+                readonly description: "Return only entries recorded at or after this time.";
+            };
+            readonly to: {
+                readonly type: "string";
+                readonly format: "date-time";
+                readonly description: "Return only entries recorded strictly before this time.";
+            };
+            readonly action: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "Return only entries whose `action` equals this value.";
+            };
+            readonly actor: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "Return only entries whose `actor` DID equals this value. Matches on the plaintext; redacted entries are not returned by an actor filter.";
+            };
+            readonly outcome: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "Return only entries whose `outcome` equals this value.";
+            };
+            readonly contextId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "Return only entries in this trust context.";
+            };
+            readonly pageSize: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 1000;
+                readonly description: "Maximum entries to return in this page.";
+            };
+            readonly cursor: {
+                readonly type: "string";
+                readonly description: "Opaque continuation token from a previous response's `cursor`. Encodes the position to resume from; a maintainer SHOULD sign it so it cannot be forged to skip entries. Treated as invalid (see errorCodes) if it fails to verify — e.g. minted before an audit-key rotation. A consumer that supplies a `cursor` MUST NOT also change the filters, which are bound into the cursor's position.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Audit List — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["entries", "truncated"];
+                readonly properties: {
+                    readonly entries: {
+                        readonly type: "array";
+                        readonly description: "The matching audit entries, newest first.";
+                        readonly items: {
+                            readonly $ref: "#/$defs/AuditEnvelope";
+                        };
+                    };
+                    readonly truncated: {
+                        readonly type: "boolean";
+                        readonly description: "True when more entries match beyond this page — `cursor` is then present to fetch them.";
+                    };
+                    readonly cursor: {
+                        readonly type: "string";
+                        readonly description: "Opaque continuation token for the next page. Present iff `truncated` is true.";
+                    };
+                    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 AuditEnvelope: {
+                readonly $anchor: "auditEnvelope";
+                readonly title: "AuditEnvelope";
+                readonly description: "One entry in an append-only audit log. Only eventId/recordedAt/action are universal; every other field is populated by maintainers that track it. `prevHash`/`entryHash` are present on hash-chained logs (see audit/verify) and absent otherwise. Principal DIDs are plaintext and MAY be absent when a right-to-be-forgotten redaction has nulled them after the fact.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["eventId", "recordedAt", "action"];
+                readonly properties: {
+                    readonly eventId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Stable identifier for this event. Also the tie-breaker component of a cursor's position key.";
+                    };
+                    readonly recordedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Wall-clock time the entry was written. The primary ordering key.";
+                    };
+                    readonly action: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.";
+                    };
+                    readonly outcome: {
+                        readonly type: "string";
+                        readonly description: "How the operation resolved. Typically `success` or `denied`; a maintainer MAY use others. Absent for events that have no pass/fail sense.";
+                    };
+                    readonly actor: {
+                        readonly type: readonly ["string", "null"];
+                        readonly description: "DID of the principal that performed the action. `null` when a right-to-be-forgotten redaction has removed the plaintext; a maintainer that keeps a keyed hash of the actor for correlation carries it in `ext`, not here.";
+                    };
+                    readonly target: {
+                        readonly type: readonly ["string", "null"];
+                        readonly description: "DID of the principal the action acted upon, when the event has one. `null`/absent for events whose target is the maintainer itself. Same redaction semantics as `actor`.";
+                    };
+                    readonly contextId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Trust context the event occurred in, for a maintainer that partitions its log per context.";
+                    };
+                    readonly schemaVersion: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Envelope-shape version at the maintainer, for consumers that need to reason about wire-shape evolution.";
+                    };
+                    readonly prevHash: {
+                        readonly $ref: "#/$defs/DigestMultibase";
+                        readonly description: "Hash-chain link: the `entryHash` of the immediately-preceding entry. Present only on chained logs; its integrity is what audit/verify checks. Multibase-encoded multihash over the RFC 8785 (JCS) canonicalization of the predecessor's immutable content — the same derivation as `entryHash`, so a verifier recomputes both the same way.";
+                    };
+                    readonly entryHash: {
+                        readonly $ref: "#/$defs/DigestMultibase";
+                        readonly description: "Hash-chain commitment over this entry's immutable content. The next entry's `prevHash` points here. Multibase-encoded multihash over the RFC 8785 (JCS) canonicalization of that content; the canonicalization is what makes the commitment reproducible by a verifier that did not write the entry.";
+                    };
+                    readonly detail: {
+                        readonly type: "object";
+                        readonly description: "Event-specific payload, keyed by `action`. Opaque to the framework; a consumer that does not recognise the action treats it as an unstructured record.";
+                        readonly additionalProperties: true;
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly DigestMultibase: {
+                readonly title: "DigestMultibase";
+                readonly description: "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.";
+                readonly type: "string";
+                readonly minLength: 16;
+                readonly pattern: "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$";
+                readonly examples: readonly ["zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"];
+            };
+        };
+    };
 };
 /**
  * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
@@ -141,5 +590,119 @@ export declare const RESPONSE_SPEC: {
     readonly isBearer: false;
     readonly isProofRequired: true;
     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: "Audit List — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["entries", "truncated"];
+                readonly properties: {
+                    readonly entries: {
+                        readonly type: "array";
+                        readonly description: "The matching audit entries, newest first.";
+                        readonly items: {
+                            readonly $ref: "#/$defs/AuditEnvelope";
+                        };
+                    };
+                    readonly truncated: {
+                        readonly type: "boolean";
+                        readonly description: "True when more entries match beyond this page — `cursor` is then present to fetch them.";
+                    };
+                    readonly cursor: {
+                        readonly type: "string";
+                        readonly description: "Opaque continuation token for the next page. Present iff `truncated` is true.";
+                    };
+                    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 AuditEnvelope: {
+                readonly $anchor: "auditEnvelope";
+                readonly title: "AuditEnvelope";
+                readonly description: "One entry in an append-only audit log. Only eventId/recordedAt/action are universal; every other field is populated by maintainers that track it. `prevHash`/`entryHash` are present on hash-chained logs (see audit/verify) and absent otherwise. Principal DIDs are plaintext and MAY be absent when a right-to-be-forgotten redaction has nulled them after the fact.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["eventId", "recordedAt", "action"];
+                readonly properties: {
+                    readonly eventId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Stable identifier for this event. Also the tie-breaker component of a cursor's position key.";
+                    };
+                    readonly recordedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Wall-clock time the entry was written. The primary ordering key.";
+                    };
+                    readonly action: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.";
+                    };
+                    readonly outcome: {
+                        readonly type: "string";
+                        readonly description: "How the operation resolved. Typically `success` or `denied`; a maintainer MAY use others. Absent for events that have no pass/fail sense.";
+                    };
+                    readonly actor: {
+                        readonly type: readonly ["string", "null"];
+                        readonly description: "DID of the principal that performed the action. `null` when a right-to-be-forgotten redaction has removed the plaintext; a maintainer that keeps a keyed hash of the actor for correlation carries it in `ext`, not here.";
+                    };
+                    readonly target: {
+                        readonly type: readonly ["string", "null"];
+                        readonly description: "DID of the principal the action acted upon, when the event has one. `null`/absent for events whose target is the maintainer itself. Same redaction semantics as `actor`.";
+                    };
+                    readonly contextId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Trust context the event occurred in, for a maintainer that partitions its log per context.";
+                    };
+                    readonly schemaVersion: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Envelope-shape version at the maintainer, for consumers that need to reason about wire-shape evolution.";
+                    };
+                    readonly prevHash: {
+                        readonly $ref: "#/$defs/DigestMultibase";
+                        readonly description: "Hash-chain link: the `entryHash` of the immediately-preceding entry. Present only on chained logs; its integrity is what audit/verify checks. Multibase-encoded multihash over the RFC 8785 (JCS) canonicalization of the predecessor's immutable content — the same derivation as `entryHash`, so a verifier recomputes both the same way.";
+                    };
+                    readonly entryHash: {
+                        readonly $ref: "#/$defs/DigestMultibase";
+                        readonly description: "Hash-chain commitment over this entry's immutable content. The next entry's `prevHash` points here. Multibase-encoded multihash over the RFC 8785 (JCS) canonicalization of that content; the canonicalization is what makes the commitment reproducible by a verifier that did not write the entry.";
+                    };
+                    readonly detail: {
+                        readonly type: "object";
+                        readonly description: "Event-specific payload, keyed by `action`. Opaque to the framework; a consumer that does not recognise the action treats it as an unstructured record.";
+                        readonly additionalProperties: true;
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly DigestMultibase: {
+                readonly title: "DigestMultibase";
+                readonly description: "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.";
+                readonly type: "string";
+                readonly minLength: 16;
+                readonly pattern: "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$";
+                readonly examples: readonly ["zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"];
+            };
+        };
+    };
 };
 //# sourceMappingURL=payload.d.ts.map

package/dist/audit/list/0.1/payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../src/audit/list/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AACD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;KAClC,CAAC;IACF,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,4CAAqD,CAAC;AAE9E,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,gBAAgB,CAAC;AAEvC,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,qDAA8D,CAAC;AAEhG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,wBAAwB,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,IAAI;;;;;CAKP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC"}
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../src/audit/list/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AACD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;KAClC,CAAC;IACF,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,4CAAqD,CAAC;AAE9E,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,gBAAgB,CAAC;AAEvC,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,qDAA8D,CAAC;AAEhG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,wBAAwB,CAAC;AAEhD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgLjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgI1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAMP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAMhB,CAAC"}