@openvtc/trust-tasks 0.28.10 → 0.28.12

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

@@ -0,0 +1,457 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/audit/list/0.1/payload.schema.json
+ */
+import type { AuditEvent, Did_VtnV0_1 as Did, EntryState, Ext } from "../../../../_shared/components.js";
+/**
+ * An administrator's request for the network's audit trail. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNAuditListPayload {
+    /**
+     * Only events for this entry.
+     */
+    did?: Did;
+    /**
+     * Only the most recent this many matching events. Absent means all.
+     */
+    limit?: number;
+    ext?: Ext;
+}
+/**
+ * The matching audit events, oldest first.
+ */
+export interface VTNAuditListResponsePayload {
+    /**
+     * The events, oldest first.
+     */
+    events: AuditEvent[];
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AuditEvent, Did, EntryState, Ext };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtn/audit/list/0.1";
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export declare const EXTENDS: string | null;
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTNAuditListPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtn/audit/list/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNAuditListResponsePayload;
+/**
+ * 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/vtn/audit/list/0.1";
+    readonly title: "VTN Audit — List — payload";
+    readonly description: "An administrator's request for the network's audit trail. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly [];
+    readonly properties: {
+        readonly did: {
+            readonly $ref: "#/$defs/Did";
+            readonly description: "Only events for this entry.";
+        };
+        readonly limit: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 1000;
+            readonly description: "Only the most recent this many matching events. Absent means all.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Audit — List — response payload";
+            readonly description: "The matching audit events, oldest first.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["events"];
+            readonly properties: {
+                readonly events: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/AuditEvent";
+                    };
+                    readonly description: "The events, oldest first.";
+                };
+                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 AuditEvent: {
+            readonly description: "One change to the published set, as the audit trail records it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["occurredAt", "did", "event", "to", "actor"];
+            readonly properties: {
+                readonly occurredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When it happened.";
+                };
+                readonly did: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The entry it happened to.";
+                };
+                readonly event: {
+                    readonly type: "string";
+                    readonly enum: readonly ["list", "acknowledge", "repudiate", "suspend", "reinstate", "remove", "depart", "update"];
+                    readonly description: "What happened.";
+                };
+                readonly to: {
+                    readonly $ref: "#/$defs/EntryState";
+                    readonly description: "The entry's state afterwards.";
+                };
+                readonly actor: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "Who did it: an administrator, or the listed party.";
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly maxLength: 1000;
+                    readonly description: "The reason given, if any.";
+                };
+            };
+        };
+        readonly Did: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "A DID.";
+        };
+        readonly EntryState: {
+            readonly type: "string";
+            readonly enum: readonly ["listed", "acknowledged", "repudiated", "suspended", "removed", "departed"];
+            readonly description: "`listed`: the network lists the party and the party has not answered; this is never membership (VTI-VTN-013). `acknowledged`: the party acknowledged the network's grant; it is a member. `repudiated`: the party rejected the listing. `suspended`: the network suspended the membership; reversible. `removed`: the network ended the entry. `departed`: the party left, by repudiating the grant.";
+        };
+    };
+};
+/** 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: "VTN Audit — List — response payload";
+            readonly description: "The matching audit events, oldest first.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["events"];
+            readonly properties: {
+                readonly events: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/AuditEvent";
+                    };
+                    readonly description: "The events, oldest first.";
+                };
+                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 AuditEvent: {
+            readonly description: "One change to the published set, as the audit trail records it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["occurredAt", "did", "event", "to", "actor"];
+            readonly properties: {
+                readonly occurredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When it happened.";
+                };
+                readonly did: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The entry it happened to.";
+                };
+                readonly event: {
+                    readonly type: "string";
+                    readonly enum: readonly ["list", "acknowledge", "repudiate", "suspend", "reinstate", "remove", "depart", "update"];
+                    readonly description: "What happened.";
+                };
+                readonly to: {
+                    readonly $ref: "#/$defs/EntryState";
+                    readonly description: "The entry's state afterwards.";
+                };
+                readonly actor: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "Who did it: an administrator, or the listed party.";
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly maxLength: 1000;
+                    readonly description: "The reason given, if any.";
+                };
+            };
+        };
+        readonly Did: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "A DID.";
+        };
+        readonly EntryState: {
+            readonly type: "string";
+            readonly enum: readonly ["listed", "acknowledged", "repudiated", "suspended", "removed", "departed"];
+            readonly description: "`listed`: the network lists the party and the party has not answered; this is never membership (VTI-VTN-013). `acknowledged`: the party acknowledged the network's grant; it is a member. `repudiated`: the party rejected the listing. `suspended`: the network suspended the membership; reversible. `removed`: the network ended the entry. `departed`: the party left, by repudiating the grant.";
+        };
+    };
+};
+/**
+ * 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/vtn/audit/list/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtn/audit/list/0.1";
+        readonly title: "VTN Audit — List — payload";
+        readonly description: "An administrator's request for the network's audit trail. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly [];
+        readonly properties: {
+            readonly did: {
+                readonly $ref: "#/$defs/Did";
+                readonly description: "Only events for this entry.";
+            };
+            readonly limit: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 1000;
+                readonly description: "Only the most recent this many matching events. Absent means all.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Audit — List — response payload";
+                readonly description: "The matching audit events, oldest first.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["events"];
+                readonly properties: {
+                    readonly events: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/AuditEvent";
+                        };
+                        readonly description: "The events, oldest first.";
+                    };
+                    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 AuditEvent: {
+                readonly description: "One change to the published set, as the audit trail records it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["occurredAt", "did", "event", "to", "actor"];
+                readonly properties: {
+                    readonly occurredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When it happened.";
+                    };
+                    readonly did: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The entry it happened to.";
+                    };
+                    readonly event: {
+                        readonly type: "string";
+                        readonly enum: readonly ["list", "acknowledge", "repudiate", "suspend", "reinstate", "remove", "depart", "update"];
+                        readonly description: "What happened.";
+                    };
+                    readonly to: {
+                        readonly $ref: "#/$defs/EntryState";
+                        readonly description: "The entry's state afterwards.";
+                    };
+                    readonly actor: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "Who did it: an administrator, or the listed party.";
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly maxLength: 1000;
+                        readonly description: "The reason given, if any.";
+                    };
+                };
+            };
+            readonly Did: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "A DID.";
+            };
+            readonly EntryState: {
+                readonly type: "string";
+                readonly enum: readonly ["listed", "acknowledged", "repudiated", "suspended", "removed", "departed"];
+                readonly description: "`listed`: the network lists the party and the party has not answered; this is never membership (VTI-VTN-013). `acknowledged`: the party acknowledged the network's grant; it is a member. `repudiated`: the party rejected the listing. `suspended`: the network suspended the membership; reversible. `removed`: the network ended the entry. `departed`: the party left, by repudiating the grant.";
+            };
+        };
+    };
+};
+/**
+ * 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/vtn/audit/list/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    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: "VTN Audit — List — response payload";
+                readonly description: "The matching audit events, oldest first.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["events"];
+                readonly properties: {
+                    readonly events: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/AuditEvent";
+                        };
+                        readonly description: "The events, oldest first.";
+                    };
+                    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 AuditEvent: {
+                readonly description: "One change to the published set, as the audit trail records it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["occurredAt", "did", "event", "to", "actor"];
+                readonly properties: {
+                    readonly occurredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When it happened.";
+                    };
+                    readonly did: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The entry it happened to.";
+                    };
+                    readonly event: {
+                        readonly type: "string";
+                        readonly enum: readonly ["list", "acknowledge", "repudiate", "suspend", "reinstate", "remove", "depart", "update"];
+                        readonly description: "What happened.";
+                    };
+                    readonly to: {
+                        readonly $ref: "#/$defs/EntryState";
+                        readonly description: "The entry's state afterwards.";
+                    };
+                    readonly actor: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "Who did it: an administrator, or the listed party.";
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly maxLength: 1000;
+                        readonly description: "The reason given, if any.";
+                    };
+                };
+            };
+            readonly Did: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "A DID.";
+            };
+            readonly EntryState: {
+                readonly type: "string";
+                readonly enum: readonly ["listed", "acknowledged", "repudiated", "suspended", "removed", "departed"];
+                readonly description: "`listed`: the network lists the party and the party has not answered; this is never membership (VTI-VTN-013). `acknowledged`: the party acknowledged the network's grant; it is a member. `repudiated`: the party rejected the listing. `suspended`: the network suspended the membership; reversible. `removed`: the network ended the entry. `departed`: the party left, by repudiating the grant.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vtn/audit/list/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,IAAI,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAGzG;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;IACV;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC;AAEjD,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,gDAAyD,CAAC;AAElF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAE1C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,yDAAkE,CAAC;AAEpG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,2BAA2B,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6HjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyG1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}