@openvtc/trust-tasks 0.28.9 → 0.28.11

package/dist/vtn/audit/list/0.1/payload.js

@@ -0,0 +1,292 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/audit/list/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export 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 const EXTENDS = 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 const DEPRECATION = null;
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtn/audit/list/0.1#response";
+/**
+ * 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 const PAYLOAD_SCHEMA = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://trusttasks.org/spec/vtn/audit/list/0.1",
+    "title": "VTN Audit — List — payload",
+    "description": "An administrator's request for the network's audit trail. The outer document members are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {
+        "did": {
+            "$ref": "#/$defs/Did",
+            "description": "Only events for this entry."
+        },
+        "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 1000,
+            "description": "Only the most recent this many matching events. Absent means all."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTN Audit — List — response payload",
+            "description": "The matching audit events, oldest first.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "events"
+            ],
+            "properties": {
+                "events": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/AuditEvent"
+                    },
+                    "description": "The events, oldest first."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Ext": {
+            "title": "Ext",
+            "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.",
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": true,
+            "propertyNames": {
+                "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+            }
+        },
+        "AuditEvent": {
+            "description": "One change to the published set, as the audit trail records it.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "occurredAt",
+                "did",
+                "event",
+                "to",
+                "actor"
+            ],
+            "properties": {
+                "occurredAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When it happened."
+                },
+                "did": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The entry it happened to."
+                },
+                "event": {
+                    "type": "string",
+                    "enum": [
+                        "list",
+                        "acknowledge",
+                        "repudiate",
+                        "suspend",
+                        "reinstate",
+                        "remove",
+                        "depart",
+                        "update"
+                    ],
+                    "description": "What happened."
+                },
+                "to": {
+                    "$ref": "#/$defs/EntryState",
+                    "description": "The entry's state afterwards."
+                },
+                "actor": {
+                    "$ref": "#/$defs/Did",
+                    "description": "Who did it: an administrator, or the listed party."
+                },
+                "reason": {
+                    "type": "string",
+                    "maxLength": 1000,
+                    "description": "The reason given, if any."
+                }
+            }
+        },
+        "Did": {
+            "type": "string",
+            "pattern": "^did:[a-z0-9]+:.+$",
+            "maxLength": 2048,
+            "description": "A DID."
+        },
+        "EntryState": {
+            "type": "string",
+            "enum": [
+                "listed",
+                "acknowledged",
+                "repudiated",
+                "suspended",
+                "removed",
+                "departed"
+            ],
+            "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 const RESPONSE_PAYLOAD_SCHEMA = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$ref": "#/$defs/Response",
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTN Audit — List — response payload",
+            "description": "The matching audit events, oldest first.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "events"
+            ],
+            "properties": {
+                "events": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/AuditEvent"
+                    },
+                    "description": "The events, oldest first."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Ext": {
+            "title": "Ext",
+            "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.",
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": true,
+            "propertyNames": {
+                "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+            }
+        },
+        "AuditEvent": {
+            "description": "One change to the published set, as the audit trail records it.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "occurredAt",
+                "did",
+                "event",
+                "to",
+                "actor"
+            ],
+            "properties": {
+                "occurredAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When it happened."
+                },
+                "did": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The entry it happened to."
+                },
+                "event": {
+                    "type": "string",
+                    "enum": [
+                        "list",
+                        "acknowledge",
+                        "repudiate",
+                        "suspend",
+                        "reinstate",
+                        "remove",
+                        "depart",
+                        "update"
+                    ],
+                    "description": "What happened."
+                },
+                "to": {
+                    "$ref": "#/$defs/EntryState",
+                    "description": "The entry's state afterwards."
+                },
+                "actor": {
+                    "$ref": "#/$defs/Did",
+                    "description": "Who did it: an administrator, or the listed party."
+                },
+                "reason": {
+                    "type": "string",
+                    "maxLength": 1000,
+                    "description": "The reason given, if any."
+                }
+            }
+        },
+        "Did": {
+            "type": "string",
+            "pattern": "^did:[a-z0-9]+:.+$",
+            "maxLength": 2048,
+            "description": "A DID."
+        },
+        "EntryState": {
+            "type": "string",
+            "enum": [
+                "listed",
+                "acknowledged",
+                "repudiated",
+                "suspended",
+                "removed",
+                "departed"
+            ],
+            "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 const SPEC = {
+    typeUri: TYPE_URI,
+    isBearer: false,
+    isProofRequired: true,
+    isRecipientRequired: true,
+    isIssuedAtRequired: false,
+    payloadSchema: PAYLOAD_SCHEMA,
+};
+/**
+ * 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 const RESPONSE_SPEC = {
+    typeUri: RESPONSE_TYPE_URI,
+    isBearer: false,
+    isProofRequired: true,
+    isRecipientRequired: true,
+    isIssuedAtRequired: false,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vtn/audit/list/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vtn/audit/list/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiCH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,gDAAyD,CAAC;AAElF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAkB,IAAI,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAkB,IAAI,CAAC;AAK/C,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,yDAAkE,CAAC;AAKpG;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,gDAAgD;IACvD,OAAO,EAAE,4BAA4B;IACrC,aAAa,EAAE,8HAA8H;IAC7I,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE,EAAE;IACd,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,6BAA6B;SAC7C;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,IAAI;YACf,aAAa,EAAE,mEAAmE;SACnF;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,qCAAqC;YAC9C,aAAa,EAAE,0CAA0C;YACzD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,oBAAoB;qBAC7B;oBACD,aAAa,EAAE,2BAA2B;iBAC3C;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,YAAY,EAAE;YACZ,aAAa,EAAE,iEAAiE;YAChF,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,KAAK;gBACL,OAAO;gBACP,IAAI;gBACJ,OAAO;aACR;YACD,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,mBAAmB;iBACnC;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,2BAA2B;iBAC3C;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,MAAM;wBACN,aAAa;wBACb,WAAW;wBACX,SAAS;wBACT,WAAW;wBACX,QAAQ;wBACR,QAAQ;wBACR,QAAQ;qBACT;oBACD,aAAa,EAAE,gBAAgB;iBAChC;gBACD,IAAI,EAAE;oBACJ,MAAM,EAAE,oBAAoB;oBAC5B,aAAa,EAAE,+BAA+B;iBAC/C;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,oDAAoD;iBACpE;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,2BAA2B;iBAC3C;aACF;SACF;QACD,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,QAAQ;SACxB;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,QAAQ;gBACR,cAAc;gBACd,YAAY;gBACZ,WAAW;gBACX,SAAS;gBACT,UAAU;aACX;YACD,aAAa,EAAE,sYAAsY;SACtZ;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,qCAAqC;YAC9C,aAAa,EAAE,0CAA0C;YACzD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,oBAAoB;qBAC7B;oBACD,aAAa,EAAE,2BAA2B;iBAC3C;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,YAAY,EAAE;YACZ,aAAa,EAAE,iEAAiE;YAChF,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,KAAK;gBACL,OAAO;gBACP,IAAI;gBACJ,OAAO;aACR;YACD,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,mBAAmB;iBACnC;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,2BAA2B;iBAC3C;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,MAAM;wBACN,aAAa;wBACb,WAAW;wBACX,SAAS;wBACT,WAAW;wBACX,QAAQ;wBACR,QAAQ;wBACR,QAAQ;qBACT;oBACD,aAAa,EAAE,gBAAgB;iBAChC;gBACD,IAAI,EAAE;oBACJ,MAAM,EAAE,oBAAoB;oBAC5B,aAAa,EAAE,+BAA+B;iBAC/C;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,oDAAoD;iBACpE;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,2BAA2B;iBAC3C;aACF;SACF;QACD,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,QAAQ;SACxB;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,QAAQ;gBACR,cAAc;gBACd,YAAY;gBACZ,WAAW;gBACX,SAAS;gBACT,UAAU;aACX;YACD,aAAa,EAAE,sYAAsY;SACtZ;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}