@openvtc/trust-tasks 0.10.0 → 0.11.0

package/dist/vta/services/rollback/1.0/payload.d.ts

@@ -0,0 +1,438 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/rollback/1.0/payload.schema.json
+ */
+/**
+ * Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.
+ */
+export type ServiceKind = "didcomm" | "rest" | "tsp" | "webauthn";
+/**
+ * Request payload for vta/services/rollback. Reverts a transport to its previous advertised settings by writing a NEW log entry — the history is append-only, so a rollback is a forward step that restores an earlier state, never an erasure of what happened.
+ */
+export interface VTAServicesRollbackPayload {
+    service: ServiceKind;
+    ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+    [k: string]: unknown | undefined;
+}
+/**
+ * Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.0#response.
+ */
+export interface VTAServicesRollbackResponsePayload {
+    result: ServiceMutationResult;
+    ext?: Ext;
+}
+/**
+ * The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.
+ */
+export interface ServiceMutationResult {
+    /**
+     * Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.
+     */
+    logEntryVersionId: string;
+    /**
+     * RFC 3339 instant the change took effect — the same instant stamped on the new log entry.
+     */
+    effectiveAt: string;
+    /**
+     * Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.
+     */
+    drainUntil?: string;
+    /**
+     * The mediator being drained, when `drainUntil` is present.
+     */
+    drainingMediator?: string;
+    /**
+     * The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.
+     */
+    vtaDid?: string;
+    /**
+     * True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.
+     */
+    serverless?: boolean;
+    ext?: Ext;
+}
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vta/services/rollback/1.0";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAServicesRollbackPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/services/rollback/1.0#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAServicesRollbackResponsePayload;
+/**
+ * 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/services/rollback/1.0";
+    readonly title: "VTA Services — Rollback — payload";
+    readonly description: "Request payload for vta/services/rollback. Reverts a transport to its previous advertised settings by writing a NEW log entry — the history is append-only, so a rollback is a forward step that restores an earlier state, never an erasure of what happened.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["service"];
+    readonly properties: {
+        readonly service: {
+            readonly $ref: "#/$defs/ServiceKind";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA Services — Rollback — response payload";
+            readonly description: "Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.0#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["result"];
+            readonly properties: {
+                readonly result: {
+                    readonly $ref: "#/$defs/ServiceMutationResult";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        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-]+)+$";
+            };
+        };
+        readonly ServiceMutationResult: {
+            readonly title: "ServiceMutationResult";
+            readonly description: "The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["logEntryVersionId", "effectiveAt"];
+            readonly properties: {
+                readonly logEntryVersionId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.";
+                };
+                readonly effectiveAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "RFC 3339 instant the change took effect — the same instant stamped on the new log entry.";
+                };
+                readonly drainUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.";
+                };
+                readonly drainingMediator: {
+                    readonly type: "string";
+                    readonly description: "The mediator being drained, when `drainUntil` is present.";
+                };
+                readonly vtaDid: {
+                    readonly type: "string";
+                    readonly description: "The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.";
+                };
+                readonly serverless: {
+                    readonly type: "boolean";
+                    readonly description: "True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.";
+                    readonly default: false;
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly ServiceKind: {
+            readonly title: "ServiceKind";
+            readonly description: "Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.";
+            readonly type: "string";
+            readonly enum: readonly ["didcomm", "rest", "tsp", "webauthn"];
+        };
+    };
+};
+/** 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 Services — Rollback — response payload";
+            readonly description: "Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.0#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["result"];
+            readonly properties: {
+                readonly result: {
+                    readonly $ref: "#/$defs/ServiceMutationResult";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        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-]+)+$";
+            };
+        };
+        readonly ServiceMutationResult: {
+            readonly title: "ServiceMutationResult";
+            readonly description: "The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["logEntryVersionId", "effectiveAt"];
+            readonly properties: {
+                readonly logEntryVersionId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.";
+                };
+                readonly effectiveAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "RFC 3339 instant the change took effect — the same instant stamped on the new log entry.";
+                };
+                readonly drainUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.";
+                };
+                readonly drainingMediator: {
+                    readonly type: "string";
+                    readonly description: "The mediator being drained, when `drainUntil` is present.";
+                };
+                readonly vtaDid: {
+                    readonly type: "string";
+                    readonly description: "The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.";
+                };
+                readonly serverless: {
+                    readonly type: "boolean";
+                    readonly description: "True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.";
+                    readonly default: false;
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly ServiceKind: {
+            readonly title: "ServiceKind";
+            readonly description: "Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.";
+            readonly type: "string";
+            readonly enum: readonly ["didcomm", "rest", "tsp", "webauthn"];
+        };
+    };
+};
+/**
+ * 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/services/rollback/1.0";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vta/services/rollback/1.0";
+        readonly title: "VTA Services — Rollback — payload";
+        readonly description: "Request payload for vta/services/rollback. Reverts a transport to its previous advertised settings by writing a NEW log entry — the history is append-only, so a rollback is a forward step that restores an earlier state, never an erasure of what happened.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["service"];
+        readonly properties: {
+            readonly service: {
+                readonly $ref: "#/$defs/ServiceKind";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA Services — Rollback — response payload";
+                readonly description: "Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.0#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["result"];
+                readonly properties: {
+                    readonly result: {
+                        readonly $ref: "#/$defs/ServiceMutationResult";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            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-]+)+$";
+                };
+            };
+            readonly ServiceMutationResult: {
+                readonly title: "ServiceMutationResult";
+                readonly description: "The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["logEntryVersionId", "effectiveAt"];
+                readonly properties: {
+                    readonly logEntryVersionId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.";
+                    };
+                    readonly effectiveAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "RFC 3339 instant the change took effect — the same instant stamped on the new log entry.";
+                    };
+                    readonly drainUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.";
+                    };
+                    readonly drainingMediator: {
+                        readonly type: "string";
+                        readonly description: "The mediator being drained, when `drainUntil` is present.";
+                    };
+                    readonly vtaDid: {
+                        readonly type: "string";
+                        readonly description: "The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.";
+                    };
+                    readonly serverless: {
+                        readonly type: "boolean";
+                        readonly description: "True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.";
+                        readonly default: false;
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly ServiceKind: {
+                readonly title: "ServiceKind";
+                readonly description: "Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.";
+                readonly type: "string";
+                readonly enum: readonly ["didcomm", "rest", "tsp", "webauthn"];
+            };
+        };
+    };
+};
+/**
+ * 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/services/rollback/1.0#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: 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 Services — Rollback — response payload";
+                readonly description: "Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.0#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["result"];
+                readonly properties: {
+                    readonly result: {
+                        readonly $ref: "#/$defs/ServiceMutationResult";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            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-]+)+$";
+                };
+            };
+            readonly ServiceMutationResult: {
+                readonly title: "ServiceMutationResult";
+                readonly description: "The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["logEntryVersionId", "effectiveAt"];
+                readonly properties: {
+                    readonly logEntryVersionId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.";
+                    };
+                    readonly effectiveAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "RFC 3339 instant the change took effect — the same instant stamped on the new log entry.";
+                    };
+                    readonly drainUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.";
+                    };
+                    readonly drainingMediator: {
+                        readonly type: "string";
+                        readonly description: "The mediator being drained, when `drainUntil` is present.";
+                    };
+                    readonly vtaDid: {
+                        readonly type: "string";
+                        readonly description: "The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.";
+                    };
+                    readonly serverless: {
+                        readonly type: "boolean";
+                        readonly description: "True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.";
+                        readonly default: false;
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly ServiceKind: {
+                readonly title: "ServiceKind";
+                readonly description: "Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.";
+                readonly type: "string";
+                readonly enum: readonly ["didcomm", "rest", "tsp", "webauthn"];
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vta/services/rollback/1.0/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vta/services/rollback/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,UAAU,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,WAAW,CAAC;IACrB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AACD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,MAAM,EAAE,qBAAqB,CAAC;IAC9B,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,uDAAgE,CAAC;AAEzF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAEjD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,gEAAyE,CAAC;AAE3G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,kCAAkC,CAAC;AAE1D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsGjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuF1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAMP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAMhB,CAAC"}