@openvtc/trust-tasks 0.21.8 → 0.21.9

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

@@ -0,0 +1,433 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/rollback/1.1/payload.schema.json
+ */
+import type { Ext, RollbackResult, ServiceKind } from "../../../../_shared/components.js";
+/**
+ * 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;
+    /**
+     * Mediated transports only (`didcomm`, `tsp`): when the rollback moves the transport off its current mediator, how long that mediator keeps accepting delivery for correspondents still holding the current DID document. Refused for `rest` and `webauthn`. Absent takes the agent's default; ignored when the rollback leaves no mediator draining. The agent may raise a value below its floor to the floor — and does, over a request that arrived through the mediator being replaced — and one mediator carrying both mediated transports drains once for both, so read `drainUntil` in the result for the window actually applied.
+     */
+    drainTtlSecs?: number;
+    ext?: Ext;
+}
+/**
+ * Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.1#response.
+ */
+export interface VTAServicesRollbackResponsePayload {
+    result: RollbackResult;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, RollbackResult, ServiceKind };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vta/services/rollback/1.1";
+/** 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.1#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.1";
+    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 drainTtlSecs: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly description: "Mediated transports only (`didcomm`, `tsp`): when the rollback moves the transport off its current mediator, how long that mediator keeps accepting delivery for correspondents still holding the current DID document. Refused for `rest` and `webauthn`. Absent takes the agent's default; ignored when the rollback leaves no mediator draining. The agent may raise a value below its floor to the floor — and does, over a request that arrived through the mediator being replaced — and one mediator carrying both mediated transports drains once for both, so read `drainUntil` in the result for the window actually applied.";
+        };
+        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.1#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["result"];
+            readonly properties: {
+                readonly result: {
+                    readonly $ref: "#/$defs/RollbackResult";
+                };
+                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 RollbackResult: {
+            readonly title: "RollbackResult";
+            readonly description: "The outcome of a rollback. Distinct from ServiceMutationResult because a rollback can legitimately publish nothing: if the previous state already equals the current one there is no change to write, and `kind: \"noOp\"` says so with `logEntryVersionId` absent. Treating that as a failure would be wrong — the requested state holds — and treating it as an ordinary success would report a log entry that does not exist.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["kind"];
+            readonly properties: {
+                readonly kind: {
+                    readonly type: "string";
+                    readonly enum: readonly ["disabled", "enabled", "updated", "noOp"];
+                    readonly description: "What the rollback did. `disabled` re-disabled the transport, `enabled` re-advertised it at its prior settings, `updated` restored prior settings on an entry that stayed advertised, and `noOp` means the previous state already matched — nothing was written.";
+                };
+                readonly logEntryVersionId: {
+                    readonly type: "string";
+                    readonly description: "Version id of the log entry the rollback wrote. **Absent when `kind` is `noOp`**, and present otherwise.";
+                };
+                readonly effectiveAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "RFC 3339 instant the rollback took effect. Absent for `noOp`.";
+                };
+                readonly drainingMediator: {
+                    readonly type: "string";
+                    readonly description: "Present when rolling back DIDComm left a mediator draining.";
+                };
+                readonly drainUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When that drain completes.";
+                };
+                readonly vtaDid: {
+                    readonly type: "string";
+                    readonly description: "The agent's own DID.";
+                };
+                readonly serverless: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "True when the entry was written locally but not published — the operator must redeploy before any verifier sees it.";
+                };
+                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.1#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["result"];
+            readonly properties: {
+                readonly result: {
+                    readonly $ref: "#/$defs/RollbackResult";
+                };
+                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 RollbackResult: {
+            readonly title: "RollbackResult";
+            readonly description: "The outcome of a rollback. Distinct from ServiceMutationResult because a rollback can legitimately publish nothing: if the previous state already equals the current one there is no change to write, and `kind: \"noOp\"` says so with `logEntryVersionId` absent. Treating that as a failure would be wrong — the requested state holds — and treating it as an ordinary success would report a log entry that does not exist.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["kind"];
+            readonly properties: {
+                readonly kind: {
+                    readonly type: "string";
+                    readonly enum: readonly ["disabled", "enabled", "updated", "noOp"];
+                    readonly description: "What the rollback did. `disabled` re-disabled the transport, `enabled` re-advertised it at its prior settings, `updated` restored prior settings on an entry that stayed advertised, and `noOp` means the previous state already matched — nothing was written.";
+                };
+                readonly logEntryVersionId: {
+                    readonly type: "string";
+                    readonly description: "Version id of the log entry the rollback wrote. **Absent when `kind` is `noOp`**, and present otherwise.";
+                };
+                readonly effectiveAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "RFC 3339 instant the rollback took effect. Absent for `noOp`.";
+                };
+                readonly drainingMediator: {
+                    readonly type: "string";
+                    readonly description: "Present when rolling back DIDComm left a mediator draining.";
+                };
+                readonly drainUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When that drain completes.";
+                };
+                readonly vtaDid: {
+                    readonly type: "string";
+                    readonly description: "The agent's own DID.";
+                };
+                readonly serverless: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "True when the entry was written locally but not published — the operator must redeploy before any verifier sees it.";
+                };
+                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.1";
+    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/services/rollback/1.1";
+        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 drainTtlSecs: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: "Mediated transports only (`didcomm`, `tsp`): when the rollback moves the transport off its current mediator, how long that mediator keeps accepting delivery for correspondents still holding the current DID document. Refused for `rest` and `webauthn`. Absent takes the agent's default; ignored when the rollback leaves no mediator draining. The agent may raise a value below its floor to the floor — and does, over a request that arrived through the mediator being replaced — and one mediator carrying both mediated transports drains once for both, so read `drainUntil` in the result for the window actually applied.";
+            };
+            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.1#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["result"];
+                readonly properties: {
+                    readonly result: {
+                        readonly $ref: "#/$defs/RollbackResult";
+                    };
+                    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 RollbackResult: {
+                readonly title: "RollbackResult";
+                readonly description: "The outcome of a rollback. Distinct from ServiceMutationResult because a rollback can legitimately publish nothing: if the previous state already equals the current one there is no change to write, and `kind: \"noOp\"` says so with `logEntryVersionId` absent. Treating that as a failure would be wrong — the requested state holds — and treating it as an ordinary success would report a log entry that does not exist.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["kind"];
+                readonly properties: {
+                    readonly kind: {
+                        readonly type: "string";
+                        readonly enum: readonly ["disabled", "enabled", "updated", "noOp"];
+                        readonly description: "What the rollback did. `disabled` re-disabled the transport, `enabled` re-advertised it at its prior settings, `updated` restored prior settings on an entry that stayed advertised, and `noOp` means the previous state already matched — nothing was written.";
+                    };
+                    readonly logEntryVersionId: {
+                        readonly type: "string";
+                        readonly description: "Version id of the log entry the rollback wrote. **Absent when `kind` is `noOp`**, and present otherwise.";
+                    };
+                    readonly effectiveAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "RFC 3339 instant the rollback took effect. Absent for `noOp`.";
+                    };
+                    readonly drainingMediator: {
+                        readonly type: "string";
+                        readonly description: "Present when rolling back DIDComm left a mediator draining.";
+                    };
+                    readonly drainUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When that drain completes.";
+                    };
+                    readonly vtaDid: {
+                        readonly type: "string";
+                        readonly description: "The agent's own DID.";
+                    };
+                    readonly serverless: {
+                        readonly type: "boolean";
+                        readonly default: false;
+                        readonly description: "True when the entry was written locally but not published — the operator must redeploy before any verifier sees it.";
+                    };
+                    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.1#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 Services — Rollback — response payload";
+                readonly description: "Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.1#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["result"];
+                readonly properties: {
+                    readonly result: {
+                        readonly $ref: "#/$defs/RollbackResult";
+                    };
+                    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 RollbackResult: {
+                readonly title: "RollbackResult";
+                readonly description: "The outcome of a rollback. Distinct from ServiceMutationResult because a rollback can legitimately publish nothing: if the previous state already equals the current one there is no change to write, and `kind: \"noOp\"` says so with `logEntryVersionId` absent. Treating that as a failure would be wrong — the requested state holds — and treating it as an ordinary success would report a log entry that does not exist.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["kind"];
+                readonly properties: {
+                    readonly kind: {
+                        readonly type: "string";
+                        readonly enum: readonly ["disabled", "enabled", "updated", "noOp"];
+                        readonly description: "What the rollback did. `disabled` re-disabled the transport, `enabled` re-advertised it at its prior settings, `updated` restored prior settings on an entry that stayed advertised, and `noOp` means the previous state already matched — nothing was written.";
+                    };
+                    readonly logEntryVersionId: {
+                        readonly type: "string";
+                        readonly description: "Version id of the log entry the rollback wrote. **Absent when `kind` is `noOp`**, and present otherwise.";
+                    };
+                    readonly effectiveAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "RFC 3339 instant the rollback took effect. Absent for `noOp`.";
+                    };
+                    readonly drainingMediator: {
+                        readonly type: "string";
+                        readonly description: "Present when rolling back DIDComm left a mediator draining.";
+                    };
+                    readonly drainUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When that drain completes.";
+                    };
+                    readonly vtaDid: {
+                        readonly type: "string";
+                        readonly description: "The agent's own DID.";
+                    };
+                    readonly serverless: {
+                        readonly type: "boolean";
+                        readonly default: false;
+                        readonly description: "True when the entry was written locally but not published — the operator must redeploy before any verifier sees it.";
+                    };
+                    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.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vta/services/rollback/1.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAG1F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,MAAM,EAAE,cAAc,CAAC;IACvB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;AAEjD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmHjB,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"}