@openvtc/trust-tasks 0.21.11 → 0.21.13

package/dist/vtc/relationships/suspend/0.1/payload.d.ts

@@ -0,0 +1,462 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/relationships/suspend/0.1/payload.schema.json
+ */
+import type { Ext, InForce, LifecycleReason } from "../../../../_shared/components.js";
+/**
+ * Suspend one published relationship edge. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCRelationshipsSuspendPayload {
+    /**
+     * The relationship (VRC) id, as vtc/relationships/list returns it.
+     */
+    id: string;
+    reason?: LifecycleReason;
+    ext?: Ext;
+}
+export interface VTCRelationshipsSuspendResponsePayload {
+    /**
+     * Echoed.
+     */
+    id: string;
+    state: InForce;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, InForce, LifecycleReason };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/relationships/suspend/0.1";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRelationshipsSuspendPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/relationships/suspend/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRelationshipsSuspendResponsePayload;
+/**
+ * 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/vtc/relationships/suspend/0.1";
+    readonly title: "VTC Relationships — Suspend — payload";
+    readonly description: "Suspend one published relationship edge. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["id"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
+            readonly description: "The relationship (VRC) id, as vtc/relationships/list returns it.";
+        };
+        readonly reason: {
+            readonly $ref: "#/$defs/LifecycleReason";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Relationships — Suspend — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["id", "state"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
+                    readonly description: "Echoed.";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/InForce";
+                };
+                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 InForce: {
+            readonly title: "InForce";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["state"];
+            readonly description: "Whether the edge is in force now, and if not, why not — the edge's resolved state, which is not the same thing as the event just recorded: restoring an edge whose `validUntil` passed while it was suspended records the restoration and still resolves `expired`. Exactly the members its `state` names are present.";
+            readonly properties: {
+                readonly state: {
+                    readonly type: "string";
+                    readonly enum: readonly ["yes", "notYetValid", "expired", "suspended", "superseded", "withdrawn", "indeterminate"];
+                    readonly description: "`yes`: inside its window, nothing standing against it. `notYetValid`: its `validFrom` has not arrived. `expired`: its `validUntil` has passed. `suspended`: temporarily ineffective — the only non-`yes` state a lifecycle event can reverse. `superseded`: displaced by a later credential. `withdrawn`: terminal. `indeterminate`: the credential's own window could not be read, so no honest answer is available.";
+                };
+                readonly validFrom: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present for `notYetValid`.";
+                };
+                readonly validUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present for `expired`.";
+                };
+                readonly since: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present for `suspended`: when the standing suspension was recorded.";
+                };
+                readonly at: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present for `superseded` and `withdrawn`.";
+                };
+                readonly by: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 256;
+                    readonly description: "Present for `superseded`: the digest of the credential that displaced it.";
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 500;
+                    readonly description: "Present for `indeterminate`: why the window could not be read. Written by the community.";
+                };
+            };
+        };
+        readonly LifecycleReason: {
+            readonly title: "LifecycleReason";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 500;
+            readonly description: "Why the edge was suspended or restored, stored verbatim on the lifecycle event. Free text written by the caller — the edge's issuer or a moderating administrator — and read by the counterparty and by administrators; retained with the edge. Untrusted, attributed to its author wherever rendered, and never read by the community's state machine.";
+        };
+    };
+};
+/** 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: "VTC Relationships — Suspend — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["id", "state"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
+                    readonly description: "Echoed.";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/InForce";
+                };
+                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 InForce: {
+            readonly title: "InForce";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["state"];
+            readonly description: "Whether the edge is in force now, and if not, why not — the edge's resolved state, which is not the same thing as the event just recorded: restoring an edge whose `validUntil` passed while it was suspended records the restoration and still resolves `expired`. Exactly the members its `state` names are present.";
+            readonly properties: {
+                readonly state: {
+                    readonly type: "string";
+                    readonly enum: readonly ["yes", "notYetValid", "expired", "suspended", "superseded", "withdrawn", "indeterminate"];
+                    readonly description: "`yes`: inside its window, nothing standing against it. `notYetValid`: its `validFrom` has not arrived. `expired`: its `validUntil` has passed. `suspended`: temporarily ineffective — the only non-`yes` state a lifecycle event can reverse. `superseded`: displaced by a later credential. `withdrawn`: terminal. `indeterminate`: the credential's own window could not be read, so no honest answer is available.";
+                };
+                readonly validFrom: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present for `notYetValid`.";
+                };
+                readonly validUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present for `expired`.";
+                };
+                readonly since: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present for `suspended`: when the standing suspension was recorded.";
+                };
+                readonly at: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present for `superseded` and `withdrawn`.";
+                };
+                readonly by: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 256;
+                    readonly description: "Present for `superseded`: the digest of the credential that displaced it.";
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 500;
+                    readonly description: "Present for `indeterminate`: why the window could not be read. Written by the community.";
+                };
+            };
+        };
+        readonly LifecycleReason: {
+            readonly title: "LifecycleReason";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 500;
+            readonly description: "Why the edge was suspended or restored, stored verbatim on the lifecycle event. Free text written by the caller — the edge's issuer or a moderating administrator — and read by the counterparty and by administrators; retained with the edge. Untrusted, attributed to its author wherever rendered, and never read by the community's state machine.";
+        };
+    };
+};
+/**
+ * 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/vtc/relationships/suspend/0.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/vtc/relationships/suspend/0.1";
+        readonly title: "VTC Relationships — Suspend — payload";
+        readonly description: "Suspend one published relationship edge. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["id"];
+        readonly properties: {
+            readonly id: {
+                readonly type: "string";
+                readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
+                readonly description: "The relationship (VRC) id, as vtc/relationships/list returns it.";
+            };
+            readonly reason: {
+                readonly $ref: "#/$defs/LifecycleReason";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Relationships — Suspend — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "state"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
+                        readonly description: "Echoed.";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/InForce";
+                    };
+                    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 InForce: {
+                readonly title: "InForce";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["state"];
+                readonly description: "Whether the edge is in force now, and if not, why not — the edge's resolved state, which is not the same thing as the event just recorded: restoring an edge whose `validUntil` passed while it was suspended records the restoration and still resolves `expired`. Exactly the members its `state` names are present.";
+                readonly properties: {
+                    readonly state: {
+                        readonly type: "string";
+                        readonly enum: readonly ["yes", "notYetValid", "expired", "suspended", "superseded", "withdrawn", "indeterminate"];
+                        readonly description: "`yes`: inside its window, nothing standing against it. `notYetValid`: its `validFrom` has not arrived. `expired`: its `validUntil` has passed. `suspended`: temporarily ineffective — the only non-`yes` state a lifecycle event can reverse. `superseded`: displaced by a later credential. `withdrawn`: terminal. `indeterminate`: the credential's own window could not be read, so no honest answer is available.";
+                    };
+                    readonly validFrom: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present for `notYetValid`.";
+                    };
+                    readonly validUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present for `expired`.";
+                    };
+                    readonly since: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present for `suspended`: when the standing suspension was recorded.";
+                    };
+                    readonly at: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present for `superseded` and `withdrawn`.";
+                    };
+                    readonly by: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 256;
+                        readonly description: "Present for `superseded`: the digest of the credential that displaced it.";
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 500;
+                        readonly description: "Present for `indeterminate`: why the window could not be read. Written by the community.";
+                    };
+                };
+            };
+            readonly LifecycleReason: {
+                readonly title: "LifecycleReason";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 500;
+                readonly description: "Why the edge was suspended or restored, stored verbatim on the lifecycle event. Free text written by the caller — the edge's issuer or a moderating administrator — and read by the counterparty and by administrators; retained with the edge. Untrusted, attributed to its author wherever rendered, and never read by the community's state machine.";
+            };
+        };
+    };
+};
+/**
+ * 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/vtc/relationships/suspend/0.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: "VTC Relationships — Suspend — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "state"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
+                        readonly description: "Echoed.";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/InForce";
+                    };
+                    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 InForce: {
+                readonly title: "InForce";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["state"];
+                readonly description: "Whether the edge is in force now, and if not, why not — the edge's resolved state, which is not the same thing as the event just recorded: restoring an edge whose `validUntil` passed while it was suspended records the restoration and still resolves `expired`. Exactly the members its `state` names are present.";
+                readonly properties: {
+                    readonly state: {
+                        readonly type: "string";
+                        readonly enum: readonly ["yes", "notYetValid", "expired", "suspended", "superseded", "withdrawn", "indeterminate"];
+                        readonly description: "`yes`: inside its window, nothing standing against it. `notYetValid`: its `validFrom` has not arrived. `expired`: its `validUntil` has passed. `suspended`: temporarily ineffective — the only non-`yes` state a lifecycle event can reverse. `superseded`: displaced by a later credential. `withdrawn`: terminal. `indeterminate`: the credential's own window could not be read, so no honest answer is available.";
+                    };
+                    readonly validFrom: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present for `notYetValid`.";
+                    };
+                    readonly validUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present for `expired`.";
+                    };
+                    readonly since: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present for `suspended`: when the standing suspension was recorded.";
+                    };
+                    readonly at: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present for `superseded` and `withdrawn`.";
+                    };
+                    readonly by: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 256;
+                        readonly description: "Present for `superseded`: the digest of the credential that displaced it.";
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 500;
+                        readonly description: "Present for `indeterminate`: why the window could not be read. Written by the community.";
+                    };
+                };
+            };
+            readonly LifecycleReason: {
+                readonly title: "LifecycleReason";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 500;
+                readonly description: "Why the edge was suspended or restored, stored verbatim on the lifecycle event. Free text written by the caller — the edge's issuer or a moderating administrator — and read by the counterparty and by administrators; retained with the edge. Untrusted, attributed to its author wherever rendered, and never read by the community's state machine.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vtc/relationships/suspend/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vtc/relationships/suspend/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAGvF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,OAAO,CAAC;IACf,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;AAE9C,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,2DAAoE,CAAC;AAE7F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,8BAA8B,CAAC;AAErD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,oEAA6E,CAAC;AAE/G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,sCAAsC,CAAC;AAE9D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqG1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}