@openvtc/trust-tasks 0.19.3 → 0.19.5

package/dist/vta/webvh/dids/realign-keys/1.0/payload.d.ts

@@ -0,0 +1,484 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/dids/realign-keys/1.0/payload.schema.json
+ */
+import type { Ext } from "../../../../../_shared/components.js";
+/**
+ * Rename a did:webvh's key records so each is addressed by the verification-method identifier its published document declares. The payload names no identifier but the DID: every target is derived by the recipient from that DID's own document.
+ */
+export interface VTAWebVHDIDsRealignKeysPayload {
+    /**
+     * The DID whose key records are to be realigned. The only identifier the producer chooses.
+     */
+    did: string;
+    /**
+     * Compute and report the realignment without performing it. Absent reads as false.
+     */
+    dryRun?: boolean;
+    ext?: Ext;
+}
+/**
+ * Success response to vta/webvh/dids/realign-keys. Type https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response.
+ */
+export interface VTAWebVHDIDsRealignKeysResponsePayload {
+    did: string;
+    /**
+     * The renames performed, or in a dry run the ones that would be.
+     */
+    moved: ARecordRenamedOntoTheIdentifierItsKeyIsPublishedUnder[];
+    /**
+     * Verification-method identifiers whose record was already correct.
+     */
+    alreadyAligned: string[];
+    /**
+     * Verification-method identifiers the recipient holds no key for. Not a failure — a DID may publish a method whose private half lives elsewhere — but the difference between this being empty and not is the difference between the DID being consistent and merely unchanged.
+     */
+    unmatched: string[];
+    /**
+     * Where the recipient will allocate the next identifier it mints for this DID. Past everything the document already publishes, so a later rotation cannot reissue a published identifier under new key material.
+     */
+    nextFragmentId: number;
+    /**
+     * True when nothing was written. Echoed so a report is self-describing: a plan and a receipt are otherwise the same shape.
+     */
+    dryRun: boolean;
+    ext?: Ext;
+}
+export interface ARecordRenamedOntoTheIdentifierItsKeyIsPublishedUnder {
+    /**
+     * The identifier the record had.
+     */
+    from: string;
+    /**
+     * The verification-method identifier it takes.
+     */
+    to: string;
+    /**
+     * Multibase public half of the key, which is what identified the record. Reported so the producer can check the rename against the published document rather than trusting this report.
+     */
+    publicKey: string;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHDIDsRealignKeysPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHDIDsRealignKeysResponsePayload;
+/**
+ * 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0";
+    readonly title: "VTA WebVH DIDs Realign-Keys — payload";
+    readonly description: "Rename a did:webvh's key records so each is addressed by the verification-method identifier its published document declares. The payload names no identifier but the DID: every target is derived by the recipient from that DID's own document.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["did"];
+    readonly properties: {
+        readonly did: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "The DID whose key records are to be realigned. The only identifier the producer chooses.";
+        };
+        readonly dryRun: {
+            readonly type: "boolean";
+            readonly description: "Compute and report the realignment without performing it. Absent reads as false.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA WebVH DIDs Realign-Keys — response payload";
+            readonly description: "Success response to vta/webvh/dids/realign-keys. Type https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["did", "moved", "alreadyAligned", "unmatched", "nextFragmentId", "dryRun"];
+            readonly properties: {
+                readonly did: {
+                    readonly type: "string";
+                };
+                readonly moved: {
+                    readonly type: "array";
+                    readonly description: "The renames performed, or in a dry run the ones that would be.";
+                    readonly items: {
+                        readonly $ref: "#/$defs/RealignedKey";
+                    };
+                };
+                readonly alreadyAligned: {
+                    readonly type: "array";
+                    readonly description: "Verification-method identifiers whose record was already correct.";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly unmatched: {
+                    readonly type: "array";
+                    readonly description: "Verification-method identifiers the recipient holds no key for. Not a failure — a DID may publish a method whose private half lives elsewhere — but the difference between this being empty and not is the difference between the DID being consistent and merely unchanged.";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly nextFragmentId: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Where the recipient will allocate the next identifier it mints for this DID. Past everything the document already publishes, so a later rotation cannot reissue a published identifier under new key material.";
+                };
+                readonly dryRun: {
+                    readonly type: "boolean";
+                    readonly description: "True when nothing was written. Echoed so a report is self-describing: a plan and a receipt are otherwise the same shape.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly RealignedKey: {
+            readonly title: "A record renamed onto the identifier its key is published under";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["from", "to", "publicKey"];
+            readonly properties: {
+                readonly from: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The identifier the record had.";
+                };
+                readonly to: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The verification-method identifier it takes.";
+                };
+                readonly publicKey: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Multibase public half of the key, which is what identified the record. Reported so the producer can check the rename against the published document rather than trusting this report.";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA WebVH DIDs Realign-Keys — response payload";
+            readonly description: "Success response to vta/webvh/dids/realign-keys. Type https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["did", "moved", "alreadyAligned", "unmatched", "nextFragmentId", "dryRun"];
+            readonly properties: {
+                readonly did: {
+                    readonly type: "string";
+                };
+                readonly moved: {
+                    readonly type: "array";
+                    readonly description: "The renames performed, or in a dry run the ones that would be.";
+                    readonly items: {
+                        readonly $ref: "#/$defs/RealignedKey";
+                    };
+                };
+                readonly alreadyAligned: {
+                    readonly type: "array";
+                    readonly description: "Verification-method identifiers whose record was already correct.";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly unmatched: {
+                    readonly type: "array";
+                    readonly description: "Verification-method identifiers the recipient holds no key for. Not a failure — a DID may publish a method whose private half lives elsewhere — but the difference between this being empty and not is the difference between the DID being consistent and merely unchanged.";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly nextFragmentId: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Where the recipient will allocate the next identifier it mints for this DID. Past everything the document already publishes, so a later rotation cannot reissue a published identifier under new key material.";
+                };
+                readonly dryRun: {
+                    readonly type: "boolean";
+                    readonly description: "True when nothing was written. Echoed so a report is self-describing: a plan and a receipt are otherwise the same shape.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly RealignedKey: {
+            readonly title: "A record renamed onto the identifier its key is published under";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["from", "to", "publicKey"];
+            readonly properties: {
+                readonly from: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The identifier the record had.";
+                };
+                readonly to: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The verification-method identifier it takes.";
+                };
+                readonly publicKey: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Multibase public half of the key, which is what identified the record. Reported so the producer can check the rename against the published document rather than trusting this report.";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0";
+        readonly title: "VTA WebVH DIDs Realign-Keys — payload";
+        readonly description: "Rename a did:webvh's key records so each is addressed by the verification-method identifier its published document declares. The payload names no identifier but the DID: every target is derived by the recipient from that DID's own document.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["did"];
+        readonly properties: {
+            readonly did: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "The DID whose key records are to be realigned. The only identifier the producer chooses.";
+            };
+            readonly dryRun: {
+                readonly type: "boolean";
+                readonly description: "Compute and report the realignment without performing it. Absent reads as false.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA WebVH DIDs Realign-Keys — response payload";
+                readonly description: "Success response to vta/webvh/dids/realign-keys. Type https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["did", "moved", "alreadyAligned", "unmatched", "nextFragmentId", "dryRun"];
+                readonly properties: {
+                    readonly did: {
+                        readonly type: "string";
+                    };
+                    readonly moved: {
+                        readonly type: "array";
+                        readonly description: "The renames performed, or in a dry run the ones that would be.";
+                        readonly items: {
+                            readonly $ref: "#/$defs/RealignedKey";
+                        };
+                    };
+                    readonly alreadyAligned: {
+                        readonly type: "array";
+                        readonly description: "Verification-method identifiers whose record was already correct.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly unmatched: {
+                        readonly type: "array";
+                        readonly description: "Verification-method identifiers the recipient holds no key for. Not a failure — a DID may publish a method whose private half lives elsewhere — but the difference between this being empty and not is the difference between the DID being consistent and merely unchanged.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly nextFragmentId: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Where the recipient will allocate the next identifier it mints for this DID. Past everything the document already publishes, so a later rotation cannot reissue a published identifier under new key material.";
+                    };
+                    readonly dryRun: {
+                        readonly type: "boolean";
+                        readonly description: "True when nothing was written. Echoed so a report is self-describing: a plan and a receipt are otherwise the same shape.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly RealignedKey: {
+                readonly title: "A record renamed onto the identifier its key is published under";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["from", "to", "publicKey"];
+                readonly properties: {
+                    readonly from: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The identifier the record had.";
+                    };
+                    readonly to: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The verification-method identifier it takes.";
+                    };
+                    readonly publicKey: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Multibase public half of the key, which is what identified the record. Reported so the producer can check the rename against the published document rather than trusting this report.";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA WebVH DIDs Realign-Keys — response payload";
+                readonly description: "Success response to vta/webvh/dids/realign-keys. Type https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["did", "moved", "alreadyAligned", "unmatched", "nextFragmentId", "dryRun"];
+                readonly properties: {
+                    readonly did: {
+                        readonly type: "string";
+                    };
+                    readonly moved: {
+                        readonly type: "array";
+                        readonly description: "The renames performed, or in a dry run the ones that would be.";
+                        readonly items: {
+                            readonly $ref: "#/$defs/RealignedKey";
+                        };
+                    };
+                    readonly alreadyAligned: {
+                        readonly type: "array";
+                        readonly description: "Verification-method identifiers whose record was already correct.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly unmatched: {
+                        readonly type: "array";
+                        readonly description: "Verification-method identifiers the recipient holds no key for. Not a failure — a DID may publish a method whose private half lives elsewhere — but the difference between this being empty and not is the difference between the DID being consistent and merely unchanged.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly nextFragmentId: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Where the recipient will allocate the next identifier it mints for this DID. Past everything the document already publishes, so a later rotation cannot reissue a published identifier under new key material.";
+                    };
+                    readonly dryRun: {
+                        readonly type: "boolean";
+                        readonly description: "True when nothing was written. Echoed so a report is self-describing: a plan and a receipt are otherwise the same shape.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly RealignedKey: {
+                readonly title: "A record renamed onto the identifier its key is published under";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["from", "to", "publicKey"];
+                readonly properties: {
+                    readonly from: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The identifier the record had.";
+                    };
+                    readonly to: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The verification-method identifier it takes.";
+                    };
+                    readonly publicKey: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Multibase public half of the key, which is what identified the record. Reported so the producer can check the rename against the published document rather than trusting this report.";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vta/webvh/dids/realign-keys/1.0/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vta/webvh/dids/realign-keys/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,sCAAsC,CAAC;AAGhE;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,qDAAqD,EAAE,CAAC;IAC/D;;OAEG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,qDAAqD;IACpE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,CAAC;AAEpB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,6DAAsE,CAAC;AAE/F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,8BAA8B,CAAC;AAErD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,sEAA+E,CAAC;AAEjH,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,sCAAsC,CAAC;AAE9D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+F1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}