@openvtc/trust-tasks 0.28.17 → 0.28.19

package/dist/vta/collection/settings/set/0.1/payload.js

@@ -0,0 +1,275 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/collection/settings/set/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/collection/settings/set/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/vta/collection/settings/set/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/vta/collection/settings/set/0.1",
+    "title": "VTA Collection — Settings — Set — payload",
+    "description": "A client with administrative authority over a trust context enables or disables collection by default there: whether its VTA collects for the context's identifiers that no client has claimed (VTI-NTF-094, VTI-NTF-095). The VTA stores the setting, applies it before it answers — disabling it stops collection and closes the VTA's connections for those identifiers — and records the change in its audit trail (VTI-NTF-096). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "contextId",
+        "collectByDefault"
+    ],
+    "properties": {
+        "contextId": {
+            "$ref": "#/$defs/ContextId",
+            "description": "The trust context whose setting to change. The change applies to that context's identifiers alone, not to its ancestors' or descendants' (VTI-NTF-094)."
+        },
+        "collectByDefault": {
+            "type": "boolean",
+            "description": "true to enable collection by default for the context, false to disable it."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA Collection — Settings — Set — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "setting",
+                "changed"
+            ],
+            "description": "The context's setting once the change has taken effect.",
+            "properties": {
+                "setting": {
+                    "$ref": "#/$defs/CollectionSetting"
+                },
+                "changed": {
+                    "type": "boolean",
+                    "description": "Whether this request changed the setting. False when the context already held the value asked for, in which case nothing changed but the record of the request (VTI-NTF-095)."
+                }
+            }
+        },
+        "CollectionSetting": {
+            "title": "CollectionSetting",
+            "description": "Whether the VTA collects by default for the identifiers of one trust context that no client has claimed (VTI-NTF-094 – VTI-NTF-098), and who last changed that. The VTA collects for them exactly when `collectByDefault` is true and `suspendedByOperator` is false. `changedBy` and `changedAt` are present together, and both absent while the setting has never been changed.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "contextId",
+                "collectByDefault",
+                "suspendedByOperator"
+            ],
+            "properties": {
+                "contextId": {
+                    "$ref": "#/$defs/ContextId",
+                    "description": "The trust context the setting belongs to. It applies to that context's identifiers alone, not to its ancestors' or descendants' (VTI-NTF-094)."
+                },
+                "collectByDefault": {
+                    "type": "boolean",
+                    "description": "The context's own setting: true unless a party with administrative authority over the context has disabled it (VTI-NTF-094, VTI-NTF-095). The VTA keeps it across restarts."
+                },
+                "suspendedByOperator": {
+                    "type": "boolean",
+                    "description": "Whether the VTA's operator has suspended collection by default for every context (VTI-NTF-098). While true, the VTA collects for no unclaimed identifier here whatever `collectByDefault` says, and does not change it; once lifted, `collectByDefault` applies again. Always false at a VTA that offers its operator no suspension."
+                },
+                "changedBy": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The subject of the access control entry that last changed `collectByDefault` (VTI-NTF-096)."
+                },
+                "changedAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When `collectByDefault` was last changed."
+                }
+            },
+            "dependentSchemas": {
+                "changedBy": {
+                    "required": [
+                        "changedAt"
+                    ]
+                },
+                "changedAt": {
+                    "required": [
+                        "changedBy"
+                    ]
+                }
+            }
+        },
+        "Did": {
+            "title": "Did",
+            "description": "A DID.",
+            "type": "string",
+            "minLength": 8,
+            "maxLength": 2048,
+            "pattern": "^did:[a-z0-9]+:\\S+$"
+        },
+        "ContextId": {
+            "title": "ContextId",
+            "description": "The trust context the identifier belongs to.",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+        },
+        "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-]+)+$"
+            }
+        }
+    }
+};
+/** 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": "VTA Collection — Settings — Set — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "setting",
+                "changed"
+            ],
+            "description": "The context's setting once the change has taken effect.",
+            "properties": {
+                "setting": {
+                    "$ref": "#/$defs/CollectionSetting"
+                },
+                "changed": {
+                    "type": "boolean",
+                    "description": "Whether this request changed the setting. False when the context already held the value asked for, in which case nothing changed but the record of the request (VTI-NTF-095)."
+                }
+            }
+        },
+        "CollectionSetting": {
+            "title": "CollectionSetting",
+            "description": "Whether the VTA collects by default for the identifiers of one trust context that no client has claimed (VTI-NTF-094 – VTI-NTF-098), and who last changed that. The VTA collects for them exactly when `collectByDefault` is true and `suspendedByOperator` is false. `changedBy` and `changedAt` are present together, and both absent while the setting has never been changed.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "contextId",
+                "collectByDefault",
+                "suspendedByOperator"
+            ],
+            "properties": {
+                "contextId": {
+                    "$ref": "#/$defs/ContextId",
+                    "description": "The trust context the setting belongs to. It applies to that context's identifiers alone, not to its ancestors' or descendants' (VTI-NTF-094)."
+                },
+                "collectByDefault": {
+                    "type": "boolean",
+                    "description": "The context's own setting: true unless a party with administrative authority over the context has disabled it (VTI-NTF-094, VTI-NTF-095). The VTA keeps it across restarts."
+                },
+                "suspendedByOperator": {
+                    "type": "boolean",
+                    "description": "Whether the VTA's operator has suspended collection by default for every context (VTI-NTF-098). While true, the VTA collects for no unclaimed identifier here whatever `collectByDefault` says, and does not change it; once lifted, `collectByDefault` applies again. Always false at a VTA that offers its operator no suspension."
+                },
+                "changedBy": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The subject of the access control entry that last changed `collectByDefault` (VTI-NTF-096)."
+                },
+                "changedAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When `collectByDefault` was last changed."
+                }
+            },
+            "dependentSchemas": {
+                "changedBy": {
+                    "required": [
+                        "changedAt"
+                    ]
+                },
+                "changedAt": {
+                    "required": [
+                        "changedBy"
+                    ]
+                }
+            }
+        },
+        "Did": {
+            "title": "Did",
+            "description": "A DID.",
+            "type": "string",
+            "minLength": 8,
+            "maxLength": 2048,
+            "pattern": "^did:[a-z0-9]+:\\S+$"
+        },
+        "ContextId": {
+            "title": "ContextId",
+            "description": "The trust context the identifier belongs to.",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+        },
+        "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-]+)+$"
+            }
+        }
+    }
+};
+/**
+ * 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: false,
+    isRecipientRequired: true,
+    isIssuedAtRequired: true,
+    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: false,
+    isRecipientRequired: true,
+    isIssuedAtRequired: true,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vta/collection/settings/set/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vta/collection/settings/set/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiCH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,6DAAsE,CAAC;AAE/F;;;;;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,sEAA+E,CAAC;AAKjH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,6DAA6D;IACpE,OAAO,EAAE,2CAA2C;IACpD,aAAa,EAAE,oiBAAoiB;IACnjB,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,WAAW;QACX,kBAAkB;KACnB;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,mBAAmB;YAC3B,aAAa,EAAE,yJAAyJ;SACzK;QACD,kBAAkB,EAAE;YAClB,MAAM,EAAE,SAAS;YACjB,aAAa,EAAE,4EAA4E;SAC5F;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,oDAAoD;YAC7D,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,SAAS;gBACT,SAAS;aACV;YACD,aAAa,EAAE,yDAAyD;YACxE,YAAY,EAAE;gBACZ,SAAS,EAAE;oBACT,MAAM,EAAE,2BAA2B;iBACpC;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,+KAA+K;iBAC/L;aACF;SACF;QACD,mBAAmB,EAAE;YACnB,OAAO,EAAE,mBAAmB;YAC5B,aAAa,EAAE,mXAAmX;YAClY,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,WAAW;gBACX,kBAAkB;gBAClB,qBAAqB;aACtB;YACD,YAAY,EAAE;gBACZ,WAAW,EAAE;oBACX,MAAM,EAAE,mBAAmB;oBAC3B,aAAa,EAAE,gJAAgJ;iBAChK;gBACD,kBAAkB,EAAE;oBAClB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,6KAA6K;iBAC7L;gBACD,qBAAqB,EAAE;oBACrB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,sUAAsU;iBACtV;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,6FAA6F;iBAC7G;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,2CAA2C;iBAC3D;aACF;YACD,kBAAkB,EAAE;gBAClB,WAAW,EAAE;oBACX,UAAU,EAAE;wBACV,WAAW;qBACZ;iBACF;gBACD,WAAW,EAAE;oBACX,UAAU,EAAE;wBACV,WAAW;qBACZ;iBACF;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,QAAQ;YACvB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,sBAAsB;SAClC;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,8CAA8C;YAC7D,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;SACjB;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;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,oDAAoD;YAC7D,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,SAAS;gBACT,SAAS;aACV;YACD,aAAa,EAAE,yDAAyD;YACxE,YAAY,EAAE;gBACZ,SAAS,EAAE;oBACT,MAAM,EAAE,2BAA2B;iBACpC;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,+KAA+K;iBAC/L;aACF;SACF;QACD,mBAAmB,EAAE;YACnB,OAAO,EAAE,mBAAmB;YAC5B,aAAa,EAAE,mXAAmX;YAClY,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,WAAW;gBACX,kBAAkB;gBAClB,qBAAqB;aACtB;YACD,YAAY,EAAE;gBACZ,WAAW,EAAE;oBACX,MAAM,EAAE,mBAAmB;oBAC3B,aAAa,EAAE,gJAAgJ;iBAChK;gBACD,kBAAkB,EAAE;oBAClB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,6KAA6K;iBAC7L;gBACD,qBAAqB,EAAE;oBACrB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,sUAAsU;iBACtV;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,6FAA6F;iBAC7G;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,2CAA2C;iBAC3D;aACF;YACD,kBAAkB,EAAE;gBAClB,WAAW,EAAE;oBACX,UAAU,EAAE;wBACV,WAAW;qBACZ;iBACF;gBACD,WAAW,EAAE;oBACX,UAAU,EAAE;wBACV,WAAW;qBACZ;iBACF;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,QAAQ;YACvB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,sBAAsB;SAClC;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,8CAA8C;YAC7D,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;SACjB;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;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}