@openvtc/trust-tasks 0.28.17 → 0.28.18

package/dist/vta/collection/settings/show/0.1/payload.d.ts

@@ -0,0 +1,437 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/collection/settings/show/0.1/payload.schema.json
+ */
+import type { CollectionSetting, ContextId_VtaCollectionV0_1 as ContextId, Did_NotificationsV0_1 as Did, Ext } from "../../../../../_shared/components.js";
+/**
+ * A client with standing in a trust context reads whether its VTA collects by default for that context's identifiers no client has claimed, who last changed that and when, and whether the VTA's operator has suspended collection by default for every context (VTI-NTF-096). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTACollectionSettingsShowPayload {
+    /**
+     * The trust context whose setting to read.
+     */
+    contextId: ContextId;
+    ext?: Ext;
+}
+/**
+ * The context's setting as the VTA holds and applies it.
+ */
+export interface VTACollectionSettingsShowResponsePayload {
+    setting: CollectionSetting;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CollectionSetting, ContextId, Did, Ext };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vta/collection/settings/show/0.1";
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export declare const EXTENDS: string | null;
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTACollectionSettingsShowPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/collection/settings/show/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTACollectionSettingsShowResponsePayload;
+/**
+ * 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/collection/settings/show/0.1";
+    readonly title: "VTA Collection — Settings — Show — payload";
+    readonly description: "A client with standing in a trust context reads whether its VTA collects by default for that context's identifiers no client has claimed, who last changed that and when, and whether the VTA's operator has suspended collection by default for every context (VTI-NTF-096). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["contextId"];
+    readonly properties: {
+        readonly contextId: {
+            readonly $ref: "#/$defs/ContextId";
+            readonly description: "The trust context whose setting to read.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA Collection — Settings — Show — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["setting"];
+            readonly description: "The context's setting as the VTA holds and applies it.";
+            readonly properties: {
+                readonly setting: {
+                    readonly $ref: "#/$defs/CollectionSetting";
+                };
+            };
+        };
+        readonly CollectionSetting: {
+            readonly title: "CollectionSetting";
+            readonly description: "Whether the VTA collects by default for the identifiers of one trust context that no client has claimed (VTI-NTF-094 – VTI-NTF-098), and who last changed that. The VTA collects for them exactly when `collectByDefault` is true and `suspendedByOperator` is false. `changedBy` and `changedAt` are present together, and both absent while the setting has never been changed.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["contextId", "collectByDefault", "suspendedByOperator"];
+            readonly properties: {
+                readonly contextId: {
+                    readonly $ref: "#/$defs/ContextId";
+                    readonly description: "The trust context the setting belongs to. It applies to that context's identifiers alone, not to its ancestors' or descendants' (VTI-NTF-094).";
+                };
+                readonly collectByDefault: {
+                    readonly type: "boolean";
+                    readonly description: "The context's own setting: true unless a party with administrative authority over the context has disabled it (VTI-NTF-094, VTI-NTF-095). The VTA keeps it across restarts.";
+                };
+                readonly suspendedByOperator: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the VTA's operator has suspended collection by default for every context (VTI-NTF-098). While true, the VTA collects for no unclaimed identifier here whatever `collectByDefault` says, and does not change it; once lifted, `collectByDefault` applies again. Always false at a VTA that offers its operator no suspension.";
+                };
+                readonly changedBy: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The subject of the access control entry that last changed `collectByDefault` (VTI-NTF-096).";
+                };
+                readonly changedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When `collectByDefault` was last changed.";
+                };
+            };
+            readonly dependentSchemas: {
+                readonly changedBy: {
+                    readonly required: readonly ["changedAt"];
+                };
+                readonly changedAt: {
+                    readonly required: readonly ["changedBy"];
+                };
+            };
+        };
+        readonly Did: {
+            readonly title: "Did";
+            readonly description: "A DID.";
+            readonly type: "string";
+            readonly minLength: 8;
+            readonly maxLength: 2048;
+            readonly pattern: "^did:[a-z0-9]+:\\S+$";
+        };
+        readonly ContextId: {
+            readonly title: "ContextId";
+            readonly description: "The trust context the identifier belongs to.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+        };
+        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 Collection — Settings — Show — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["setting"];
+            readonly description: "The context's setting as the VTA holds and applies it.";
+            readonly properties: {
+                readonly setting: {
+                    readonly $ref: "#/$defs/CollectionSetting";
+                };
+            };
+        };
+        readonly CollectionSetting: {
+            readonly title: "CollectionSetting";
+            readonly description: "Whether the VTA collects by default for the identifiers of one trust context that no client has claimed (VTI-NTF-094 – VTI-NTF-098), and who last changed that. The VTA collects for them exactly when `collectByDefault` is true and `suspendedByOperator` is false. `changedBy` and `changedAt` are present together, and both absent while the setting has never been changed.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["contextId", "collectByDefault", "suspendedByOperator"];
+            readonly properties: {
+                readonly contextId: {
+                    readonly $ref: "#/$defs/ContextId";
+                    readonly description: "The trust context the setting belongs to. It applies to that context's identifiers alone, not to its ancestors' or descendants' (VTI-NTF-094).";
+                };
+                readonly collectByDefault: {
+                    readonly type: "boolean";
+                    readonly description: "The context's own setting: true unless a party with administrative authority over the context has disabled it (VTI-NTF-094, VTI-NTF-095). The VTA keeps it across restarts.";
+                };
+                readonly suspendedByOperator: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the VTA's operator has suspended collection by default for every context (VTI-NTF-098). While true, the VTA collects for no unclaimed identifier here whatever `collectByDefault` says, and does not change it; once lifted, `collectByDefault` applies again. Always false at a VTA that offers its operator no suspension.";
+                };
+                readonly changedBy: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The subject of the access control entry that last changed `collectByDefault` (VTI-NTF-096).";
+                };
+                readonly changedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When `collectByDefault` was last changed.";
+                };
+            };
+            readonly dependentSchemas: {
+                readonly changedBy: {
+                    readonly required: readonly ["changedAt"];
+                };
+                readonly changedAt: {
+                    readonly required: readonly ["changedBy"];
+                };
+            };
+        };
+        readonly Did: {
+            readonly title: "Did";
+            readonly description: "A DID.";
+            readonly type: "string";
+            readonly minLength: 8;
+            readonly maxLength: 2048;
+            readonly pattern: "^did:[a-z0-9]+:\\S+$";
+        };
+        readonly ContextId: {
+            readonly title: "ContextId";
+            readonly description: "The trust context the identifier belongs to.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+        };
+        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/collection/settings/show/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vta/collection/settings/show/0.1";
+        readonly title: "VTA Collection — Settings — Show — payload";
+        readonly description: "A client with standing in a trust context reads whether its VTA collects by default for that context's identifiers no client has claimed, who last changed that and when, and whether the VTA's operator has suspended collection by default for every context (VTI-NTF-096). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["contextId"];
+        readonly properties: {
+            readonly contextId: {
+                readonly $ref: "#/$defs/ContextId";
+                readonly description: "The trust context whose setting to read.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA Collection — Settings — Show — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["setting"];
+                readonly description: "The context's setting as the VTA holds and applies it.";
+                readonly properties: {
+                    readonly setting: {
+                        readonly $ref: "#/$defs/CollectionSetting";
+                    };
+                };
+            };
+            readonly CollectionSetting: {
+                readonly title: "CollectionSetting";
+                readonly description: "Whether the VTA collects by default for the identifiers of one trust context that no client has claimed (VTI-NTF-094 – VTI-NTF-098), and who last changed that. The VTA collects for them exactly when `collectByDefault` is true and `suspendedByOperator` is false. `changedBy` and `changedAt` are present together, and both absent while the setting has never been changed.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["contextId", "collectByDefault", "suspendedByOperator"];
+                readonly properties: {
+                    readonly contextId: {
+                        readonly $ref: "#/$defs/ContextId";
+                        readonly description: "The trust context the setting belongs to. It applies to that context's identifiers alone, not to its ancestors' or descendants' (VTI-NTF-094).";
+                    };
+                    readonly collectByDefault: {
+                        readonly type: "boolean";
+                        readonly description: "The context's own setting: true unless a party with administrative authority over the context has disabled it (VTI-NTF-094, VTI-NTF-095). The VTA keeps it across restarts.";
+                    };
+                    readonly suspendedByOperator: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the VTA's operator has suspended collection by default for every context (VTI-NTF-098). While true, the VTA collects for no unclaimed identifier here whatever `collectByDefault` says, and does not change it; once lifted, `collectByDefault` applies again. Always false at a VTA that offers its operator no suspension.";
+                    };
+                    readonly changedBy: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The subject of the access control entry that last changed `collectByDefault` (VTI-NTF-096).";
+                    };
+                    readonly changedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When `collectByDefault` was last changed.";
+                    };
+                };
+                readonly dependentSchemas: {
+                    readonly changedBy: {
+                        readonly required: readonly ["changedAt"];
+                    };
+                    readonly changedAt: {
+                        readonly required: readonly ["changedBy"];
+                    };
+                };
+            };
+            readonly Did: {
+                readonly title: "Did";
+                readonly description: "A DID.";
+                readonly type: "string";
+                readonly minLength: 8;
+                readonly maxLength: 2048;
+                readonly pattern: "^did:[a-z0-9]+:\\S+$";
+            };
+            readonly ContextId: {
+                readonly title: "ContextId";
+                readonly description: "The trust context the identifier belongs to.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+            };
+            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/collection/settings/show/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    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 Collection — Settings — Show — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["setting"];
+                readonly description: "The context's setting as the VTA holds and applies it.";
+                readonly properties: {
+                    readonly setting: {
+                        readonly $ref: "#/$defs/CollectionSetting";
+                    };
+                };
+            };
+            readonly CollectionSetting: {
+                readonly title: "CollectionSetting";
+                readonly description: "Whether the VTA collects by default for the identifiers of one trust context that no client has claimed (VTI-NTF-094 – VTI-NTF-098), and who last changed that. The VTA collects for them exactly when `collectByDefault` is true and `suspendedByOperator` is false. `changedBy` and `changedAt` are present together, and both absent while the setting has never been changed.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["contextId", "collectByDefault", "suspendedByOperator"];
+                readonly properties: {
+                    readonly contextId: {
+                        readonly $ref: "#/$defs/ContextId";
+                        readonly description: "The trust context the setting belongs to. It applies to that context's identifiers alone, not to its ancestors' or descendants' (VTI-NTF-094).";
+                    };
+                    readonly collectByDefault: {
+                        readonly type: "boolean";
+                        readonly description: "The context's own setting: true unless a party with administrative authority over the context has disabled it (VTI-NTF-094, VTI-NTF-095). The VTA keeps it across restarts.";
+                    };
+                    readonly suspendedByOperator: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the VTA's operator has suspended collection by default for every context (VTI-NTF-098). While true, the VTA collects for no unclaimed identifier here whatever `collectByDefault` says, and does not change it; once lifted, `collectByDefault` applies again. Always false at a VTA that offers its operator no suspension.";
+                    };
+                    readonly changedBy: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The subject of the access control entry that last changed `collectByDefault` (VTI-NTF-096).";
+                    };
+                    readonly changedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When `collectByDefault` was last changed.";
+                    };
+                };
+                readonly dependentSchemas: {
+                    readonly changedBy: {
+                        readonly required: readonly ["changedAt"];
+                    };
+                    readonly changedAt: {
+                        readonly required: readonly ["changedBy"];
+                    };
+                };
+            };
+            readonly Did: {
+                readonly title: "Did";
+                readonly description: "A DID.";
+                readonly type: "string";
+                readonly minLength: 8;
+                readonly maxLength: 2048;
+                readonly pattern: "^did:[a-z0-9]+:\\S+$";
+            };
+            readonly ContextId: {
+                readonly title: "ContextId";
+                readonly description: "The trust context the identifier belongs to.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+            };
+            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/collection/settings/show/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vta/collection/settings/show/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,2BAA2B,IAAI,SAAS,EAAE,qBAAqB,IAAI,GAAG,EAAE,GAAG,EAAE,MAAM,sCAAsC,CAAC;AAG3J;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACvD,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED,kHAAkH;AAClH,YAAY,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAEvD,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,8DAAuE,CAAC;AAEhG;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,gCAAgC,CAAC;AAEvD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,uEAAgF,CAAC;AAElH,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,wCAAwC,CAAC;AAEhE;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2GjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2F1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}