@openvtc/trust-tasks 0.9.0 → 0.11.0

package/dist/vta/webvh/dids/get/1.0/payload.js

@@ -0,0 +1,282 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/dids/get/1.0/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/get/1.0";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/get/1.0#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/webvh/dids/get/1.0",
+    "title": "VTA WebVH DIDs Get — payload",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "did"
+    ],
+    "properties": {
+        "did": {
+            "type": "string",
+            "minLength": 1
+        },
+        "includeLog": {
+            "type": "boolean",
+            "default": false,
+            "description": "Return the DID's log as well as the record. The log is the DID's whole history and can be large; it is also the only thing a verifier can check the current document against, so a consumer auditing a DID asks for it."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA WebVH DIDs Get — response payload",
+            "description": "Success response to vta/webvh/dids/get. Type https://trusttasks.org/spec/vta/webvh/dids/get/1.0#response.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "record"
+            ],
+            "properties": {
+                "record": {
+                    "$ref": "#/$defs/WebvhDidRecord"
+                },
+                "log": {
+                    "type": "string",
+                    "description": "The DID log, present only when `includeLog` was true. Its absence means it was not asked for — never that the DID has no history."
+                },
+                "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-]+)+$"
+            }
+        },
+        "WebvhDidRecord": {
+            "title": "WebvhDidRecord",
+            "description": "A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "serverId",
+                "mnemonic",
+                "scid",
+                "contextId",
+                "portable",
+                "logEntryCount",
+                "createdAt",
+                "updatedAt"
+            ],
+            "properties": {
+                "did": {
+                    "type": "string",
+                    "description": "The DID, e.g. `did:webvh:<scid>:example.com:alice`."
+                },
+                "serverId": {
+                    "type": "string",
+                    "description": "Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with."
+                },
+                "mnemonic": {
+                    "type": "string",
+                    "description": "The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical."
+                },
+                "scid": {
+                    "type": "string",
+                    "description": "Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place."
+                },
+                "contextId": {
+                    "type": "string",
+                    "description": "Context this DID belongs to. Deleting that context destroys this DID."
+                },
+                "portable": {
+                    "type": "boolean",
+                    "description": "Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry."
+                },
+                "logEntryCount": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Number of entries in the log."
+                },
+                "preRotationCount": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "default": 0,
+                    "description": "Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance."
+                },
+                "nextFragmentId": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "default": 1,
+                    "description": "Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key."
+                },
+                "createdAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "updatedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        }
+    }
+};
+/** 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 WebVH DIDs Get — response payload",
+            "description": "Success response to vta/webvh/dids/get. Type https://trusttasks.org/spec/vta/webvh/dids/get/1.0#response.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "record"
+            ],
+            "properties": {
+                "record": {
+                    "$ref": "#/$defs/WebvhDidRecord"
+                },
+                "log": {
+                    "type": "string",
+                    "description": "The DID log, present only when `includeLog` was true. Its absence means it was not asked for — never that the DID has no history."
+                },
+                "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-]+)+$"
+            }
+        },
+        "WebvhDidRecord": {
+            "title": "WebvhDidRecord",
+            "description": "A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "serverId",
+                "mnemonic",
+                "scid",
+                "contextId",
+                "portable",
+                "logEntryCount",
+                "createdAt",
+                "updatedAt"
+            ],
+            "properties": {
+                "did": {
+                    "type": "string",
+                    "description": "The DID, e.g. `did:webvh:<scid>:example.com:alice`."
+                },
+                "serverId": {
+                    "type": "string",
+                    "description": "Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with."
+                },
+                "mnemonic": {
+                    "type": "string",
+                    "description": "The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical."
+                },
+                "scid": {
+                    "type": "string",
+                    "description": "Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place."
+                },
+                "contextId": {
+                    "type": "string",
+                    "description": "Context this DID belongs to. Deleting that context destroys this DID."
+                },
+                "portable": {
+                    "type": "boolean",
+                    "description": "Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry."
+                },
+                "logEntryCount": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Number of entries in the log."
+                },
+                "preRotationCount": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "default": 0,
+                    "description": "Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance."
+                },
+                "nextFragmentId": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "default": 1,
+                    "description": "Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key."
+                },
+                "createdAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "updatedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        }
+    }
+};
+/**
+ * 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,
+    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,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vta/webvh/dids/get/1.0/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vta/webvh/dids/get/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwEH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,oDAA6D,CAAC;AAKtF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,6DAAsE,CAAC;AAKxG;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,oDAAoD;IAC3D,OAAO,EAAE,8BAA8B;IACvC,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,KAAK;KACN;IACD,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;SACf;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,KAAK;YAChB,aAAa,EAAE,yNAAyN;SACzO;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,uCAAuC;YAChD,aAAa,EAAE,2GAA2G;YAC1H,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,wBAAwB;iBACjC;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,mIAAmI;iBACnJ;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,gBAAgB,EAAE;YAChB,OAAO,EAAE,gBAAgB;YACzB,aAAa,EAAE,gJAAgJ;YAC/J,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,UAAU;gBACV,UAAU;gBACV,MAAM;gBACN,WAAW;gBACX,UAAU;gBACV,eAAe;gBACf,WAAW;gBACX,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,qDAAqD;iBACrE;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,qIAAqI;iBACrJ;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,iHAAiH;iBACjI;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,+LAA+L;iBAC/M;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,uEAAuE;iBACvF;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,iOAAiO;iBACjP;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,+BAA+B;iBAC/C;gBACD,kBAAkB,EAAE;oBAClB,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,qNAAqN;iBACrO;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,0HAA0H;iBAC1I;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;iBACtB;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;iBACtB;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;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,uCAAuC;YAChD,aAAa,EAAE,2GAA2G;YAC1H,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,wBAAwB;iBACjC;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,mIAAmI;iBACnJ;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,gBAAgB,EAAE;YAChB,OAAO,EAAE,gBAAgB;YACzB,aAAa,EAAE,gJAAgJ;YAC/J,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,UAAU;gBACV,UAAU;gBACV,MAAM;gBACN,WAAW;gBACX,UAAU;gBACV,eAAe;gBACf,WAAW;gBACX,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,qDAAqD;iBACrE;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,qIAAqI;iBACrJ;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,iHAAiH;iBACjI;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,+LAA+L;iBAC/M;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,uEAAuE;iBACvF;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,iOAAiO;iBACjP;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,+BAA+B;iBAC/C;gBACD,kBAAkB,EAAE;oBAClB,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,qNAAqN;iBACrO;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,0HAA0H;iBAC1I;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;iBACtB;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;iBACtB;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;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,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,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}