@openvtc/trust-tasks 0.21.4 → 0.21.5

package/src/did-management/identity/list/0.1/payload.ts

@@ -0,0 +1,335 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/identity/list/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface IdentityListPayload {
+  ext?: Ext;
+}
+export interface IdentityListResponsePayload {
+  /**
+   * Every generation the service still honours, newest first. Exactly one is current. Empty when the service holds no rotating identity.
+   */
+  generations: {
+    generationId: number;
+    did: string;
+    /**
+     * True for the generation the DID document currently advertises.
+     */
+    current: boolean;
+    /**
+     * Verification-method id of the generation's signing key, as the DID document names it. Public; never key material.
+     */
+    signingKeyId: string;
+    keyAgreementKeyId: string;
+    /**
+     * The mediator the generation was reached through. Absent for one reached without a mediator.
+     */
+    mediatorDid?: string;
+    transports: {
+      tsp: boolean;
+      didcomm: boolean;
+    };
+    createdAt: string;
+    /**
+     * When the generation stopped being current. Absent on the current one.
+     */
+    retiredAt?: string;
+    /**
+     * When the service stops honouring it and drops its key material. Absent on the current one.
+     */
+    expiresAt?: string;
+  }[];
+  /**
+   * How long a generation superseded now would keep being honoured.
+   */
+  rotationGraceSeconds: number;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/identity/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = IdentityListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/identity/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = IdentityListResponsePayload;
+
+/**
+ * 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/did-management/identity/list/0.1",
+  "title": "Identity List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Identity List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "generations",
+        "rotationGraceSeconds"
+      ],
+      "properties": {
+        "generations": {
+          "type": "array",
+          "description": "Every generation the service still honours, newest first. Exactly one is current. Empty when the service holds no rotating identity.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "generationId",
+              "did",
+              "current",
+              "signingKeyId",
+              "keyAgreementKeyId",
+              "transports",
+              "createdAt"
+            ],
+            "properties": {
+              "generationId": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "did": {
+                "type": "string",
+                "minLength": 1
+              },
+              "current": {
+                "type": "boolean",
+                "description": "True for the generation the DID document currently advertises."
+              },
+              "signingKeyId": {
+                "type": "string",
+                "minLength": 1,
+                "description": "Verification-method id of the generation's signing key, as the DID document names it. Public; never key material."
+              },
+              "keyAgreementKeyId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "mediatorDid": {
+                "type": "string",
+                "description": "The mediator the generation was reached through. Absent for one reached without a mediator."
+              },
+              "transports": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "tsp",
+                  "didcomm"
+                ],
+                "properties": {
+                  "tsp": {
+                    "type": "boolean"
+                  },
+                  "didcomm": {
+                    "type": "boolean"
+                  }
+                }
+              },
+              "createdAt": {
+                "type": "string",
+                "format": "date-time"
+              },
+              "retiredAt": {
+                "type": "string",
+                "format": "date-time",
+                "description": "When the generation stopped being current. Absent on the current one."
+              },
+              "expiresAt": {
+                "type": "string",
+                "format": "date-time",
+                "description": "When the service stops honouring it and drops its key material. Absent on the current one."
+              }
+            }
+          }
+        },
+        "rotationGraceSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How long a generation superseded now would keep being honoured."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/** 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": "Identity List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "generations",
+        "rotationGraceSeconds"
+      ],
+      "properties": {
+        "generations": {
+          "type": "array",
+          "description": "Every generation the service still honours, newest first. Exactly one is current. Empty when the service holds no rotating identity.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "generationId",
+              "did",
+              "current",
+              "signingKeyId",
+              "keyAgreementKeyId",
+              "transports",
+              "createdAt"
+            ],
+            "properties": {
+              "generationId": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "did": {
+                "type": "string",
+                "minLength": 1
+              },
+              "current": {
+                "type": "boolean",
+                "description": "True for the generation the DID document currently advertises."
+              },
+              "signingKeyId": {
+                "type": "string",
+                "minLength": 1,
+                "description": "Verification-method id of the generation's signing key, as the DID document names it. Public; never key material."
+              },
+              "keyAgreementKeyId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "mediatorDid": {
+                "type": "string",
+                "description": "The mediator the generation was reached through. Absent for one reached without a mediator."
+              },
+              "transports": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "tsp",
+                  "didcomm"
+                ],
+                "properties": {
+                  "tsp": {
+                    "type": "boolean"
+                  },
+                  "didcomm": {
+                    "type": "boolean"
+                  }
+                }
+              },
+              "createdAt": {
+                "type": "string",
+                "format": "date-time"
+              },
+              "retiredAt": {
+                "type": "string",
+                "format": "date-time",
+                "description": "When the generation stopped being current. Absent on the current one."
+              },
+              "expiresAt": {
+                "type": "string",
+                "format": "date-time",
+                "description": "When the service stops honouring it and drops its key material. Absent on the current one."
+              }
+            }
+          }
+        },
+        "rotationGraceSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How long a generation superseded now would keep being honoured."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/**
+ * 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,
+} as const;
+
+/**
+ * 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,
+} as const;

package/src/did-management/identity/retire/0.1/payload.ts

@@ -0,0 +1,175 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/identity/retire/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface IdentityRetirePayload {
+  /**
+   * The superseded generation to stop honouring now.
+   */
+  generationId: number;
+  ext?: Ext;
+}
+export interface IdentityRetireResponsePayload {
+  generationId: number;
+  /**
+   * When the generation's key material was dropped from the running service.
+   */
+  droppedAt: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/identity/retire/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = IdentityRetirePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/identity/retire/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = IdentityRetireResponsePayload;
+
+/**
+ * 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/did-management/identity/retire/0.1",
+  "title": "Identity Retire — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "generationId"
+  ],
+  "properties": {
+    "generationId": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "The superseded generation to stop honouring now."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Identity Retire — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "generationId",
+        "droppedAt"
+      ],
+      "properties": {
+        "generationId": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "droppedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the generation's key material was dropped from the running service."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/** 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": "Identity Retire — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "generationId",
+        "droppedAt"
+      ],
+      "properties": {
+        "generationId": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "droppedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the generation's key material was dropped from the running service."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/**
+ * 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: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * 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: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/did-management/registry/admin-register/0.1/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/did-management/registry/admin-register/0.1/payload.schema.json
  */
 
-import type { Ext, ServiceInstance } from "../../../../_shared/components.js";
+import type { Ext, ServiceInstance_DidManagementV0_1 as ServiceInstance } from "../../../../_shared/components.js";
 
 
 export interface RegistryAdminRegisterPayload {