@openvtc/trust-tasks 0.8.1 → 0.9.0

package/dist/vta/did-templates/get/2.0/payload.js

@@ -6,16 +6,351 @@
 export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/get/2.0";
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/get/2.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/did-templates/get/2.0",
+    "title": "VTA DID-Template Get — payload",
+    "description": "Fetch one DID template on a VTA by name. Omit `contextId` to read from the global scope (any authenticated caller); set it to read a template scoped to that context (requires access to the context). The success response is the persisted DidTemplateRecord.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "name"
+    ],
+    "properties": {
+        "contextId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Scope selector. Absent: the global scope. Present: the context the template is scoped to; the caller MUST have access to that context."
+        },
+        "name": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Template name to fetch within the selected scope."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext",
+            "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA DID-Template Get — response payload",
+            "description": "The persisted DidTemplateRecord. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by create/update.",
+            "$ref": "#/$defs/DidTemplateRecord"
+        },
+        "DidTemplateRecord": {
+            "title": "DidTemplateRecord",
+            "description": "A persisted template. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by get/create/update and carried per-item by list.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "schemaVersion",
+                "name",
+                "kind",
+                "document",
+                "scope",
+                "createdAt",
+                "updatedAt",
+                "createdBy"
+            ],
+            "properties": {
+                "schemaVersion": {
+                    "type": "integer",
+                    "const": 1
+                },
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 64,
+                    "pattern": "^[a-z0-9-]+$"
+                },
+                "kind": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "description": {
+                    "type": [
+                        "string",
+                        "null"
+                    ]
+                },
+                "methods": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "requiredVars": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "optionalVars": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "defaults": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "document": {
+                    "type": "object"
+                },
+                "scope": {
+                    "$ref": "#/$defs/Scope",
+                    "description": "Resolved scope of the stored template."
+                },
+                "createdAt": {
+                    "type": "integer",
+                    "description": "UTC unix-epoch seconds the template was first stored."
+                },
+                "updatedAt": {
+                    "type": "integer",
+                    "description": "UTC unix-epoch seconds of the last write."
+                },
+                "createdBy": {
+                    "type": "string",
+                    "description": "DID of the admin who last wrote the template."
+                }
+            }
+        },
+        "Scope": {
+            "title": "Scope",
+            "description": "Where a stored template lives. Tagged by `type`.",
+            "type": "object",
+            "oneOf": [
+                {
+                    "title": "Builtin",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "type"
+                    ],
+                    "properties": {
+                        "type": {
+                            "const": "builtin"
+                        }
+                    }
+                },
+                {
+                    "title": "Global",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "type"
+                    ],
+                    "properties": {
+                        "type": {
+                            "const": "global"
+                        }
+                    }
+                },
+                {
+                    "title": "Context",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "type",
+                        "contextId"
+                    ],
+                    "properties": {
+                        "type": {
+                            "const": "context"
+                        },
+                        "contextId": {
+                            "type": "string",
+                            "minLength": 1
+                        }
+                    }
+                }
+            ]
+        },
+        "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 DID-Template Get — response payload",
+            "description": "The persisted DidTemplateRecord. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by create/update.",
+            "$ref": "#/$defs/DidTemplateRecord"
+        },
+        "DidTemplateRecord": {
+            "title": "DidTemplateRecord",
+            "description": "A persisted template. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by get/create/update and carried per-item by list.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "schemaVersion",
+                "name",
+                "kind",
+                "document",
+                "scope",
+                "createdAt",
+                "updatedAt",
+                "createdBy"
+            ],
+            "properties": {
+                "schemaVersion": {
+                    "type": "integer",
+                    "const": 1
+                },
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 64,
+                    "pattern": "^[a-z0-9-]+$"
+                },
+                "kind": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "description": {
+                    "type": [
+                        "string",
+                        "null"
+                    ]
+                },
+                "methods": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "requiredVars": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "optionalVars": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "defaults": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "document": {
+                    "type": "object"
+                },
+                "scope": {
+                    "$ref": "#/$defs/Scope",
+                    "description": "Resolved scope of the stored template."
+                },
+                "createdAt": {
+                    "type": "integer",
+                    "description": "UTC unix-epoch seconds the template was first stored."
+                },
+                "updatedAt": {
+                    "type": "integer",
+                    "description": "UTC unix-epoch seconds of the last write."
+                },
+                "createdBy": {
+                    "type": "string",
+                    "description": "DID of the admin who last wrote the template."
+                }
+            }
+        },
+        "Scope": {
+            "title": "Scope",
+            "description": "Where a stored template lives. Tagged by `type`.",
+            "type": "object",
+            "oneOf": [
+                {
+                    "title": "Builtin",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "type"
+                    ],
+                    "properties": {
+                        "type": {
+                            "const": "builtin"
+                        }
+                    }
+                },
+                {
+                    "title": "Global",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "type"
+                    ],
+                    "properties": {
+                        "type": {
+                            "const": "global"
+                        }
+                    }
+                },
+                {
+                    "title": "Context",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "type",
+                        "contextId"
+                    ],
+                    "properties": {
+                        "type": {
+                            "const": "context"
+                        },
+                        "contextId": {
+                            "type": "string",
+                            "minLength": 1
+                        }
+                    }
+                }
+            ]
+        },
+        "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.
+ * 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`
@@ -27,5 +362,6 @@ export const RESPONSE_SPEC = {
     isBearer: false,
     isProofRequired: false,
     isRecipientRequired: true,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 };
 //# sourceMappingURL=payload.js.map

package/dist/vta/did-templates/get/2.0/payload.js.map

@@ -1 +1 @@
-{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vta/did-templates/get/2.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAqEH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,uDAAgE,CAAC;AAKzF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,gEAAyE,CAAC;AAK3G;;;;GAIG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;CACjB,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;CACjB,CAAC"}
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vta/did-templates/get/2.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAqEH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,uDAAgE,CAAC;AAKzF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,gEAAyE,CAAC;AAK3G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,uDAAuD;IAC9D,OAAO,EAAE,gCAAgC;IACzC,aAAa,EAAE,iQAAiQ;IAChR,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,MAAM;KACP;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,wIAAwI;SACxJ;QACD,MAAM,EAAE;YACN,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,mDAAmD;SACnE;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,yDAAyD;SACzE;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,yCAAyC;YAClD,aAAa,EAAE,oLAAoL;YACnM,MAAM,EAAE,2BAA2B;SACpC;QACD,mBAAmB,EAAE;YACnB,OAAO,EAAE,mBAAmB;YAC5B,aAAa,EAAE,0MAA0M;YACzN,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,eAAe;gBACf,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,OAAO;gBACP,WAAW;gBACX,WAAW;gBACX,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,eAAe,EAAE;oBACf,MAAM,EAAE,SAAS;oBACjB,OAAO,EAAE,CAAC;iBACX;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,EAAE;oBACf,SAAS,EAAE,cAAc;iBAC1B;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;iBACf;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE;wBACN,QAAQ;wBACR,MAAM;qBACP;iBACF;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;qBACjB;iBACF;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;qBACjB;iBACF;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,IAAI;iBAC7B;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,IAAI;iBAC7B;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;iBACjB;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,eAAe;oBACvB,aAAa,EAAE,wCAAwC;iBACxD;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,uDAAuD;iBACvE;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,2CAA2C;iBAC3D;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,+CAA+C;iBAC/D;aACF;SACF;QACD,OAAO,EAAE;YACP,OAAO,EAAE,OAAO;YAChB,aAAa,EAAE,kDAAkD;YACjE,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE;gBACP;oBACE,OAAO,EAAE,SAAS;oBAClB,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,KAAK;oBAC7B,UAAU,EAAE;wBACV,MAAM;qBACP;oBACD,YAAY,EAAE;wBACZ,MAAM,EAAE;4BACN,OAAO,EAAE,SAAS;yBACnB;qBACF;iBACF;gBACD;oBACE,OAAO,EAAE,QAAQ;oBACjB,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,KAAK;oBAC7B,UAAU,EAAE;wBACV,MAAM;qBACP;oBACD,YAAY,EAAE;wBACZ,MAAM,EAAE;4BACN,OAAO,EAAE,QAAQ;yBAClB;qBACF;iBACF;gBACD;oBACE,OAAO,EAAE,SAAS;oBAClB,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,KAAK;oBAC7B,UAAU,EAAE;wBACV,MAAM;wBACN,WAAW;qBACZ;oBACD,YAAY,EAAE;wBACZ,MAAM,EAAE;4BACN,OAAO,EAAE,SAAS;yBACnB;wBACD,WAAW,EAAE;4BACX,MAAM,EAAE,QAAQ;4BAChB,WAAW,EAAE,CAAC;yBACf;qBACF;iBACF;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;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,yCAAyC;YAClD,aAAa,EAAE,oLAAoL;YACnM,MAAM,EAAE,2BAA2B;SACpC;QACD,mBAAmB,EAAE;YACnB,OAAO,EAAE,mBAAmB;YAC5B,aAAa,EAAE,0MAA0M;YACzN,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,eAAe;gBACf,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,OAAO;gBACP,WAAW;gBACX,WAAW;gBACX,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,eAAe,EAAE;oBACf,MAAM,EAAE,SAAS;oBACjB,OAAO,EAAE,CAAC;iBACX;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,EAAE;oBACf,SAAS,EAAE,cAAc;iBAC1B;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;iBACf;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE;wBACN,QAAQ;wBACR,MAAM;qBACP;iBACF;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;qBACjB;iBACF;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;qBACjB;iBACF;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,IAAI;iBAC7B;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,IAAI;iBAC7B;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;iBACjB;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,eAAe;oBACvB,aAAa,EAAE,wCAAwC;iBACxD;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,uDAAuD;iBACvE;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,2CAA2C;iBAC3D;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,+CAA+C;iBAC/D;aACF;SACF;QACD,OAAO,EAAE;YACP,OAAO,EAAE,OAAO;YAChB,aAAa,EAAE,kDAAkD;YACjE,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE;gBACP;oBACE,OAAO,EAAE,SAAS;oBAClB,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,KAAK;oBAC7B,UAAU,EAAE;wBACV,MAAM;qBACP;oBACD,YAAY,EAAE;wBACZ,MAAM,EAAE;4BACN,OAAO,EAAE,SAAS;yBACnB;qBACF;iBACF;gBACD;oBACE,OAAO,EAAE,QAAQ;oBACjB,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,KAAK;oBAC7B,UAAU,EAAE;wBACV,MAAM;qBACP;oBACD,YAAY,EAAE;wBACZ,MAAM,EAAE;4BACN,OAAO,EAAE,QAAQ;yBAClB;qBACF;iBACF;gBACD;oBACE,OAAO,EAAE,SAAS;oBAClB,MAAM,EAAE,QAAQ;oBAChB,sBAAsB,EAAE,KAAK;oBAC7B,UAAU,EAAE;wBACV,MAAM;wBACN,WAAW;qBACZ;oBACD,YAAY,EAAE;wBACZ,MAAM,EAAE;4BACN,OAAO,EAAE,SAAS;yBACnB;wBACD,WAAW,EAAE;4BACX,MAAM,EAAE,QAAQ;4BAChB,WAAW,EAAE,CAAC;yBACf;qBACF;iBACF;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;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"}