@openvtc/trust-tasks 0.21.11 → 0.21.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +76 -0
- package/dist/_framework/0.4/framework.d.ts +1 -1
- package/dist/_framework/0.4/framework.d.ts.map +1 -1
- package/dist/_shared/components.d.ts +371 -0
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/auth/_shared/0.1/signing-key.d.ts +16 -0
- package/dist/auth/_shared/0.1/signing-key.d.ts.map +1 -0
- package/dist/auth/_shared/0.1/signing-key.js +6 -0
- package/dist/auth/_shared/0.1/signing-key.js.map +1 -0
- package/dist/auth/signing-key/enroll/0.1/payload.d.ts +545 -0
- package/dist/auth/signing-key/enroll/0.1/payload.d.ts.map +1 -0
- package/dist/auth/signing-key/enroll/0.1/payload.js +307 -0
- package/dist/auth/signing-key/enroll/0.1/payload.js.map +1 -0
- package/dist/auth/signing-key/list/0.1/payload.d.ts +509 -0
- package/dist/auth/signing-key/list/0.1/payload.d.ts.map +1 -0
- package/dist/auth/signing-key/list/0.1/payload.js +289 -0
- package/dist/auth/signing-key/list/0.1/payload.js.map +1 -0
- package/dist/auth/signing-key/revoke/0.1/payload.d.ts +292 -0
- package/dist/auth/signing-key/revoke/0.1/payload.d.ts.map +1 -0
- package/dist/auth/signing-key/revoke/0.1/payload.js +167 -0
- package/dist/auth/signing-key/revoke/0.1/payload.js.map +1 -0
- package/dist/index.d.ts +39 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +39 -0
- package/dist/index.js.map +1 -1
- package/dist/vta/contexts/update-did/1.1/payload.d.ts +388 -0
- package/dist/vta/contexts/update-did/1.1/payload.d.ts.map +1 -0
- package/dist/vta/contexts/update-did/1.1/payload.js +227 -0
- package/dist/vta/contexts/update-did/1.1/payload.js.map +1 -0
- package/dist/vtc/_shared/0.1/community-presentation.d.ts +16 -0
- package/dist/vtc/_shared/0.1/community-presentation.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/community-presentation.js +6 -0
- package/dist/vtc/_shared/0.1/community-presentation.js.map +1 -0
- package/dist/vtc/_shared/0.1/relationship-lifecycle.d.ts +16 -0
- package/dist/vtc/_shared/0.1/relationship-lifecycle.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/relationship-lifecycle.js +6 -0
- package/dist/vtc/_shared/0.1/relationship-lifecycle.js.map +1 -0
- package/dist/vtc/_shared/0.1/schema-registry.d.ts +16 -0
- package/dist/vtc/_shared/0.1/schema-registry.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/schema-registry.js +6 -0
- package/dist/vtc/_shared/0.1/schema-registry.js.map +1 -0
- package/dist/vtc/_shared/0.1/vetting-auto-grant.d.ts +16 -0
- package/dist/vtc/_shared/0.1/vetting-auto-grant.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/vetting-auto-grant.js +6 -0
- package/dist/vtc/_shared/0.1/vetting-auto-grant.js.map +1 -0
- package/dist/vtc/_shared/0.1/website-transfer.d.ts +16 -0
- package/dist/vtc/_shared/0.1/website-transfer.d.ts.map +1 -0
- package/dist/vtc/_shared/0.1/website-transfer.js +6 -0
- package/dist/vtc/_shared/0.1/website-transfer.js.map +1 -0
- package/dist/vtc/community/branding/show/0.1/payload.d.ts +319 -0
- package/dist/vtc/community/branding/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/branding/show/0.1/payload.js +179 -0
- package/dist/vtc/community/branding/show/0.1/payload.js.map +1 -0
- package/dist/vtc/community/branding/update/0.1/payload.d.ts +328 -0
- package/dist/vtc/community/branding/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/branding/update/0.1/payload.js +185 -0
- package/dist/vtc/community/branding/update/0.1/payload.js.map +1 -0
- package/dist/vtc/community/join-discovery/show/0.1/payload.d.ts +267 -0
- package/dist/vtc/community/join-discovery/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/join-discovery/show/0.1/payload.js +157 -0
- package/dist/vtc/community/join-discovery/show/0.1/payload.js.map +1 -0
- package/dist/vtc/community/join-discovery/update/0.1/payload.d.ts +276 -0
- package/dist/vtc/community/join-discovery/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/join-discovery/update/0.1/payload.js +163 -0
- package/dist/vtc/community/join-discovery/update/0.1/payload.js.map +1 -0
- package/dist/vtc/community/requested-attributes/show/0.1/payload.d.ts +339 -0
- package/dist/vtc/community/requested-attributes/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/requested-attributes/show/0.1/payload.js +193 -0
- package/dist/vtc/community/requested-attributes/show/0.1/payload.js.map +1 -0
- package/dist/vtc/community/requested-attributes/update/0.1/payload.d.ts +348 -0
- package/dist/vtc/community/requested-attributes/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/community/requested-attributes/update/0.1/payload.js +199 -0
- package/dist/vtc/community/requested-attributes/update/0.1/payload.js.map +1 -0
- package/dist/vtc/join-requests/query/0.1/payload.d.ts +412 -0
- package/dist/vtc/join-requests/query/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/join-requests/query/0.1/payload.js +228 -0
- package/dist/vtc/join-requests/query/0.1/payload.js.map +1 -0
- package/dist/vtc/join-requests/vetting/show/0.1/payload.d.ts +1016 -0
- package/dist/vtc/join-requests/vetting/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/join-requests/vetting/show/0.1/payload.js +509 -0
- package/dist/vtc/join-requests/vetting/show/0.1/payload.js.map +1 -0
- package/dist/vtc/relationships/restore/0.1/payload.d.ts +462 -0
- package/dist/vtc/relationships/restore/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/relationships/restore/0.1/payload.js +270 -0
- package/dist/vtc/relationships/restore/0.1/payload.js.map +1 -0
- package/dist/vtc/relationships/suspend/0.1/payload.d.ts +462 -0
- package/dist/vtc/relationships/suspend/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/relationships/suspend/0.1/payload.js +270 -0
- package/dist/vtc/relationships/suspend/0.1/payload.js.map +1 -0
- package/dist/vtc/rooms/list/0.1/payload.d.ts +653 -0
- package/dist/vtc/rooms/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/rooms/list/0.1/payload.js +360 -0
- package/dist/vtc/rooms/list/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/accepts/delete/0.1/payload.d.ts +240 -0
- package/dist/vtc/schemas/accepts/delete/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/accepts/delete/0.1/payload.js +141 -0
- package/dist/vtc/schemas/accepts/delete/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/accepts/list/0.1/payload.d.ts +1214 -0
- package/dist/vtc/schemas/accepts/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/accepts/list/0.1/payload.js +681 -0
- package/dist/vtc/schemas/accepts/list/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/accepts/register/0.1/payload.d.ts +1165 -0
- package/dist/vtc/schemas/accepts/register/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/accepts/register/0.1/payload.js +665 -0
- package/dist/vtc/schemas/accepts/register/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/accepts/show/0.1/payload.d.ts +1144 -0
- package/dist/vtc/schemas/accepts/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/accepts/show/0.1/payload.js +655 -0
- package/dist/vtc/schemas/accepts/show/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/delete/0.1/payload.d.ts +240 -0
- package/dist/vtc/schemas/delete/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/delete/0.1/payload.js +141 -0
- package/dist/vtc/schemas/delete/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/list/0.1/payload.d.ts +541 -0
- package/dist/vtc/schemas/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/list/0.1/payload.js +300 -0
- package/dist/vtc/schemas/list/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/register/0.1/payload.d.ts +512 -0
- package/dist/vtc/schemas/register/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/register/0.1/payload.js +292 -0
- package/dist/vtc/schemas/register/0.1/payload.js.map +1 -0
- package/dist/vtc/schemas/show/0.1/payload.d.ts +484 -0
- package/dist/vtc/schemas/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/schemas/show/0.1/payload.js +279 -0
- package/dist/vtc/schemas/show/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/auto-grant/show/0.1/payload.d.ts +463 -0
- package/dist/vtc/vetting/auto-grant/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/auto-grant/show/0.1/payload.js +269 -0
- package/dist/vtc/vetting/auto-grant/show/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/auto-grant/update/0.1/payload.d.ts +491 -0
- package/dist/vtc/vetting/auto-grant/update/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/auto-grant/update/0.1/payload.js +282 -0
- package/dist/vtc/vetting/auto-grant/update/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/revocations/list/0.1/payload.d.ts +608 -0
- package/dist/vtc/vetting/revocations/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/revocations/list/0.1/payload.js +332 -0
- package/dist/vtc/vetting/revocations/list/0.1/payload.js.map +1 -0
- package/dist/vtc/vetting/vetters/grants/list/0.1/payload.d.ts +992 -0
- package/dist/vtc/vetting/vetters/grants/list/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/vetting/vetters/grants/list/0.1/payload.js +461 -0
- package/dist/vtc/vetting/vetters/grants/list/0.1/payload.js.map +1 -0
- package/dist/vtc/website/deploy/0.1/payload.d.ts +369 -0
- package/dist/vtc/website/deploy/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/deploy/0.1/payload.js +213 -0
- package/dist/vtc/website/deploy/0.1/payload.js.map +1 -0
- package/dist/vtc/website/files/show/0.1/payload.d.ts +455 -0
- package/dist/vtc/website/files/show/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/files/show/0.1/payload.js +247 -0
- package/dist/vtc/website/files/show/0.1/payload.js.map +1 -0
- package/dist/vtc/website/upload/abort/0.1/payload.d.ts +256 -0
- package/dist/vtc/website/upload/abort/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/upload/abort/0.1/payload.js +149 -0
- package/dist/vtc/website/upload/abort/0.1/payload.js.map +1 -0
- package/dist/vtc/website/upload/begin/0.1/payload.d.ts +658 -0
- package/dist/vtc/website/upload/begin/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/upload/begin/0.1/payload.js +375 -0
- package/dist/vtc/website/upload/begin/0.1/payload.js.map +1 -0
- package/dist/vtc/website/upload/chunk/0.1/payload.d.ts +447 -0
- package/dist/vtc/website/upload/chunk/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/upload/chunk/0.1/payload.js +253 -0
- package/dist/vtc/website/upload/chunk/0.1/payload.js.map +1 -0
- package/dist/vtc/website/upload/commit/0.1/payload.d.ts +603 -0
- package/dist/vtc/website/upload/commit/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/website/upload/commit/0.1/payload.js +337 -0
- package/dist/vtc/website/upload/commit/0.1/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_framework/0.4/framework.ts +1 -1
- package/src/_shared/components.ts +371 -0
- package/src/auth/_shared/0.1/signing-key.ts +17 -0
- package/src/auth/signing-key/enroll/0.1/payload.ts +349 -0
- package/src/auth/signing-key/list/0.1/payload.ts +323 -0
- package/src/auth/signing-key/revoke/0.1/payload.ts +204 -0
- package/src/index.ts +39 -0
- package/src/vta/contexts/update-did/1.1/payload.ts +256 -0
- package/src/vtc/_shared/0.1/community-presentation.ts +17 -0
- package/src/vtc/_shared/0.1/relationship-lifecycle.ts +17 -0
- package/src/vtc/_shared/0.1/schema-registry.ts +17 -0
- package/src/vtc/_shared/0.1/vetting-auto-grant.ts +17 -0
- package/src/vtc/_shared/0.1/website-transfer.ts +17 -0
- package/src/vtc/community/branding/show/0.1/payload.ts +207 -0
- package/src/vtc/community/branding/update/0.1/payload.ts +214 -0
- package/src/vtc/community/join-discovery/show/0.1/payload.ts +185 -0
- package/src/vtc/community/join-discovery/update/0.1/payload.ts +192 -0
- package/src/vtc/community/requested-attributes/show/0.1/payload.ts +221 -0
- package/src/vtc/community/requested-attributes/update/0.1/payload.ts +228 -0
- package/src/vtc/join-requests/query/0.1/payload.ts +285 -0
- package/src/vtc/join-requests/vetting/show/0.1/payload.ts +740 -0
- package/src/vtc/relationships/restore/0.1/payload.ts +307 -0
- package/src/vtc/relationships/suspend/0.1/payload.ts +307 -0
- package/src/vtc/rooms/list/0.1/payload.ts +449 -0
- package/src/vtc/schemas/accepts/delete/0.1/payload.ts +170 -0
- package/src/vtc/schemas/accepts/list/0.1/payload.ts +724 -0
- package/src/vtc/schemas/accepts/register/0.1/payload.ts +697 -0
- package/src/vtc/schemas/accepts/show/0.1/payload.ts +684 -0
- package/src/vtc/schemas/delete/0.1/payload.ts +170 -0
- package/src/vtc/schemas/list/0.1/payload.ts +344 -0
- package/src/vtc/schemas/register/0.1/payload.ts +325 -0
- package/src/vtc/schemas/show/0.1/payload.ts +308 -0
- package/src/vtc/vetting/auto-grant/show/0.1/payload.ts +297 -0
- package/src/vtc/vetting/auto-grant/update/0.1/payload.ts +316 -0
- package/src/vtc/vetting/revocations/list/0.1/payload.ts +416 -0
- package/src/vtc/vetting/vetters/grants/list/0.1/payload.ts +700 -0
- package/src/vtc/website/deploy/0.1/payload.ts +255 -0
- package/src/vtc/website/files/show/0.1/payload.ts +303 -0
- package/src/vtc/website/upload/abort/0.1/payload.ts +182 -0
- package/src/vtc/website/upload/begin/0.1/payload.ts +408 -0
- package/src/vtc/website/upload/chunk/0.1/payload.ts +295 -0
- package/src/vtc/website/upload/commit/0.1/payload.ts +385 -0
|
@@ -0,0 +1,412 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/join-requests/query/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { Ext } from "../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.
|
|
8
|
+
*/
|
|
9
|
+
export interface VTCJoinRequestsQueryPayload {
|
|
10
|
+
/**
|
|
11
|
+
* The holder the query is for — the prospective member whose agent will answer it.
|
|
12
|
+
*/
|
|
13
|
+
holderDid: string;
|
|
14
|
+
/**
|
|
15
|
+
* The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.
|
|
16
|
+
*/
|
|
17
|
+
criterionId: string;
|
|
18
|
+
ext?: Ext;
|
|
19
|
+
}
|
|
20
|
+
export interface VTCJoinRequestsQueryResponsePayload {
|
|
21
|
+
/**
|
|
22
|
+
* The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.
|
|
23
|
+
*/
|
|
24
|
+
threadId: string;
|
|
25
|
+
/**
|
|
26
|
+
* Echoed.
|
|
27
|
+
*/
|
|
28
|
+
holderDid: string;
|
|
29
|
+
query: CredentialQuery;
|
|
30
|
+
/**
|
|
31
|
+
* Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.
|
|
32
|
+
*/
|
|
33
|
+
delivered: boolean;
|
|
34
|
+
ext?: Ext;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.
|
|
38
|
+
*/
|
|
39
|
+
export interface CredentialQuery {
|
|
40
|
+
dcql_query: {};
|
|
41
|
+
nonce: string;
|
|
42
|
+
purpose: string;
|
|
43
|
+
[k: string]: unknown | undefined;
|
|
44
|
+
}
|
|
45
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
46
|
+
export type { Ext };
|
|
47
|
+
/** Trust Task type URI. */
|
|
48
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/join-requests/query/0.1";
|
|
49
|
+
/** Stable alias for this specification's request payload shape. */
|
|
50
|
+
export type Payload = VTCJoinRequestsQueryPayload;
|
|
51
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
52
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/join-requests/query/0.1#response";
|
|
53
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
54
|
+
export type Response = VTCJoinRequestsQueryResponsePayload;
|
|
55
|
+
/**
|
|
56
|
+
* This specification's payload schema, as a value.
|
|
57
|
+
*
|
|
58
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
59
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
60
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
61
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
62
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
63
|
+
*/
|
|
64
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
65
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
66
|
+
readonly $id: "https://trusttasks.org/spec/vtc/join-requests/query/0.1";
|
|
67
|
+
readonly title: "VTC Join Requests — Query — payload";
|
|
68
|
+
readonly description: "An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.";
|
|
69
|
+
readonly type: "object";
|
|
70
|
+
readonly additionalProperties: false;
|
|
71
|
+
readonly required: readonly ["holderDid", "criterionId"];
|
|
72
|
+
readonly properties: {
|
|
73
|
+
readonly holderDid: {
|
|
74
|
+
readonly type: "string";
|
|
75
|
+
readonly pattern: "^did:";
|
|
76
|
+
readonly minLength: 5;
|
|
77
|
+
readonly maxLength: 2048;
|
|
78
|
+
readonly description: "The holder the query is for — the prospective member whose agent will answer it.";
|
|
79
|
+
};
|
|
80
|
+
readonly criterionId: {
|
|
81
|
+
readonly type: "string";
|
|
82
|
+
readonly minLength: 1;
|
|
83
|
+
readonly maxLength: 128;
|
|
84
|
+
readonly description: "The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.";
|
|
85
|
+
};
|
|
86
|
+
readonly ext: {
|
|
87
|
+
readonly $ref: "#/$defs/Ext";
|
|
88
|
+
};
|
|
89
|
+
};
|
|
90
|
+
readonly $defs: {
|
|
91
|
+
readonly CredentialQuery: {
|
|
92
|
+
readonly title: "CredentialQuery";
|
|
93
|
+
readonly type: "object";
|
|
94
|
+
readonly additionalProperties: true;
|
|
95
|
+
readonly required: readonly ["dcql_query", "nonce", "purpose"];
|
|
96
|
+
readonly description: "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.";
|
|
97
|
+
readonly properties: {
|
|
98
|
+
readonly dcql_query: {
|
|
99
|
+
readonly type: "object";
|
|
100
|
+
};
|
|
101
|
+
readonly nonce: {
|
|
102
|
+
readonly type: "string";
|
|
103
|
+
readonly minLength: 1;
|
|
104
|
+
readonly maxLength: 512;
|
|
105
|
+
};
|
|
106
|
+
readonly purpose: {
|
|
107
|
+
readonly type: "string";
|
|
108
|
+
readonly minLength: 1;
|
|
109
|
+
readonly maxLength: 500;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
readonly Response: {
|
|
114
|
+
readonly $anchor: "response";
|
|
115
|
+
readonly title: "VTC Join Requests — Query — response payload";
|
|
116
|
+
readonly type: "object";
|
|
117
|
+
readonly additionalProperties: false;
|
|
118
|
+
readonly required: readonly ["threadId", "holderDid", "query", "delivered"];
|
|
119
|
+
readonly properties: {
|
|
120
|
+
readonly threadId: {
|
|
121
|
+
readonly type: "string";
|
|
122
|
+
readonly minLength: 1;
|
|
123
|
+
readonly maxLength: 256;
|
|
124
|
+
readonly description: "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.";
|
|
125
|
+
};
|
|
126
|
+
readonly holderDid: {
|
|
127
|
+
readonly type: "string";
|
|
128
|
+
readonly pattern: "^did:";
|
|
129
|
+
readonly maxLength: 2048;
|
|
130
|
+
readonly description: "Echoed.";
|
|
131
|
+
};
|
|
132
|
+
readonly query: {
|
|
133
|
+
readonly $ref: "#/$defs/CredentialQuery";
|
|
134
|
+
};
|
|
135
|
+
readonly delivered: {
|
|
136
|
+
readonly type: "boolean";
|
|
137
|
+
readonly description: "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.";
|
|
138
|
+
};
|
|
139
|
+
readonly ext: {
|
|
140
|
+
readonly $ref: "#/$defs/Ext";
|
|
141
|
+
};
|
|
142
|
+
};
|
|
143
|
+
};
|
|
144
|
+
readonly Ext: {
|
|
145
|
+
readonly title: "Ext";
|
|
146
|
+
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.";
|
|
147
|
+
readonly type: "object";
|
|
148
|
+
readonly minProperties: 1;
|
|
149
|
+
readonly additionalProperties: true;
|
|
150
|
+
readonly propertyNames: {
|
|
151
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
152
|
+
};
|
|
153
|
+
};
|
|
154
|
+
};
|
|
155
|
+
};
|
|
156
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
157
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
158
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
159
|
+
readonly $ref: "#/$defs/Response";
|
|
160
|
+
readonly $defs: {
|
|
161
|
+
readonly CredentialQuery: {
|
|
162
|
+
readonly title: "CredentialQuery";
|
|
163
|
+
readonly type: "object";
|
|
164
|
+
readonly additionalProperties: true;
|
|
165
|
+
readonly required: readonly ["dcql_query", "nonce", "purpose"];
|
|
166
|
+
readonly description: "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.";
|
|
167
|
+
readonly properties: {
|
|
168
|
+
readonly dcql_query: {
|
|
169
|
+
readonly type: "object";
|
|
170
|
+
};
|
|
171
|
+
readonly nonce: {
|
|
172
|
+
readonly type: "string";
|
|
173
|
+
readonly minLength: 1;
|
|
174
|
+
readonly maxLength: 512;
|
|
175
|
+
};
|
|
176
|
+
readonly purpose: {
|
|
177
|
+
readonly type: "string";
|
|
178
|
+
readonly minLength: 1;
|
|
179
|
+
readonly maxLength: 500;
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
};
|
|
183
|
+
readonly Response: {
|
|
184
|
+
readonly $anchor: "response";
|
|
185
|
+
readonly title: "VTC Join Requests — Query — response payload";
|
|
186
|
+
readonly type: "object";
|
|
187
|
+
readonly additionalProperties: false;
|
|
188
|
+
readonly required: readonly ["threadId", "holderDid", "query", "delivered"];
|
|
189
|
+
readonly properties: {
|
|
190
|
+
readonly threadId: {
|
|
191
|
+
readonly type: "string";
|
|
192
|
+
readonly minLength: 1;
|
|
193
|
+
readonly maxLength: 256;
|
|
194
|
+
readonly description: "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.";
|
|
195
|
+
};
|
|
196
|
+
readonly holderDid: {
|
|
197
|
+
readonly type: "string";
|
|
198
|
+
readonly pattern: "^did:";
|
|
199
|
+
readonly maxLength: 2048;
|
|
200
|
+
readonly description: "Echoed.";
|
|
201
|
+
};
|
|
202
|
+
readonly query: {
|
|
203
|
+
readonly $ref: "#/$defs/CredentialQuery";
|
|
204
|
+
};
|
|
205
|
+
readonly delivered: {
|
|
206
|
+
readonly type: "boolean";
|
|
207
|
+
readonly description: "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.";
|
|
208
|
+
};
|
|
209
|
+
readonly ext: {
|
|
210
|
+
readonly $ref: "#/$defs/Ext";
|
|
211
|
+
};
|
|
212
|
+
};
|
|
213
|
+
};
|
|
214
|
+
readonly Ext: {
|
|
215
|
+
readonly title: "Ext";
|
|
216
|
+
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.";
|
|
217
|
+
readonly type: "object";
|
|
218
|
+
readonly minProperties: 1;
|
|
219
|
+
readonly additionalProperties: true;
|
|
220
|
+
readonly propertyNames: {
|
|
221
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
};
|
|
225
|
+
};
|
|
226
|
+
/**
|
|
227
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
228
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
229
|
+
* per-specification and cannot be derived from the document alone, and
|
|
230
|
+
* item 2 needs the schema this carries.
|
|
231
|
+
*/
|
|
232
|
+
export declare const SPEC: {
|
|
233
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/join-requests/query/0.1";
|
|
234
|
+
readonly isBearer: false;
|
|
235
|
+
readonly isProofRequired: true;
|
|
236
|
+
readonly isRecipientRequired: true;
|
|
237
|
+
readonly isIssuedAtRequired: true;
|
|
238
|
+
readonly payloadSchema: {
|
|
239
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
240
|
+
readonly $id: "https://trusttasks.org/spec/vtc/join-requests/query/0.1";
|
|
241
|
+
readonly title: "VTC Join Requests — Query — payload";
|
|
242
|
+
readonly description: "An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.";
|
|
243
|
+
readonly type: "object";
|
|
244
|
+
readonly additionalProperties: false;
|
|
245
|
+
readonly required: readonly ["holderDid", "criterionId"];
|
|
246
|
+
readonly properties: {
|
|
247
|
+
readonly holderDid: {
|
|
248
|
+
readonly type: "string";
|
|
249
|
+
readonly pattern: "^did:";
|
|
250
|
+
readonly minLength: 5;
|
|
251
|
+
readonly maxLength: 2048;
|
|
252
|
+
readonly description: "The holder the query is for — the prospective member whose agent will answer it.";
|
|
253
|
+
};
|
|
254
|
+
readonly criterionId: {
|
|
255
|
+
readonly type: "string";
|
|
256
|
+
readonly minLength: 1;
|
|
257
|
+
readonly maxLength: 128;
|
|
258
|
+
readonly description: "The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.";
|
|
259
|
+
};
|
|
260
|
+
readonly ext: {
|
|
261
|
+
readonly $ref: "#/$defs/Ext";
|
|
262
|
+
};
|
|
263
|
+
};
|
|
264
|
+
readonly $defs: {
|
|
265
|
+
readonly CredentialQuery: {
|
|
266
|
+
readonly title: "CredentialQuery";
|
|
267
|
+
readonly type: "object";
|
|
268
|
+
readonly additionalProperties: true;
|
|
269
|
+
readonly required: readonly ["dcql_query", "nonce", "purpose"];
|
|
270
|
+
readonly description: "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.";
|
|
271
|
+
readonly properties: {
|
|
272
|
+
readonly dcql_query: {
|
|
273
|
+
readonly type: "object";
|
|
274
|
+
};
|
|
275
|
+
readonly nonce: {
|
|
276
|
+
readonly type: "string";
|
|
277
|
+
readonly minLength: 1;
|
|
278
|
+
readonly maxLength: 512;
|
|
279
|
+
};
|
|
280
|
+
readonly purpose: {
|
|
281
|
+
readonly type: "string";
|
|
282
|
+
readonly minLength: 1;
|
|
283
|
+
readonly maxLength: 500;
|
|
284
|
+
};
|
|
285
|
+
};
|
|
286
|
+
};
|
|
287
|
+
readonly Response: {
|
|
288
|
+
readonly $anchor: "response";
|
|
289
|
+
readonly title: "VTC Join Requests — Query — response payload";
|
|
290
|
+
readonly type: "object";
|
|
291
|
+
readonly additionalProperties: false;
|
|
292
|
+
readonly required: readonly ["threadId", "holderDid", "query", "delivered"];
|
|
293
|
+
readonly properties: {
|
|
294
|
+
readonly threadId: {
|
|
295
|
+
readonly type: "string";
|
|
296
|
+
readonly minLength: 1;
|
|
297
|
+
readonly maxLength: 256;
|
|
298
|
+
readonly description: "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.";
|
|
299
|
+
};
|
|
300
|
+
readonly holderDid: {
|
|
301
|
+
readonly type: "string";
|
|
302
|
+
readonly pattern: "^did:";
|
|
303
|
+
readonly maxLength: 2048;
|
|
304
|
+
readonly description: "Echoed.";
|
|
305
|
+
};
|
|
306
|
+
readonly query: {
|
|
307
|
+
readonly $ref: "#/$defs/CredentialQuery";
|
|
308
|
+
};
|
|
309
|
+
readonly delivered: {
|
|
310
|
+
readonly type: "boolean";
|
|
311
|
+
readonly description: "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.";
|
|
312
|
+
};
|
|
313
|
+
readonly ext: {
|
|
314
|
+
readonly $ref: "#/$defs/Ext";
|
|
315
|
+
};
|
|
316
|
+
};
|
|
317
|
+
};
|
|
318
|
+
readonly Ext: {
|
|
319
|
+
readonly title: "Ext";
|
|
320
|
+
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.";
|
|
321
|
+
readonly type: "object";
|
|
322
|
+
readonly minProperties: 1;
|
|
323
|
+
readonly additionalProperties: true;
|
|
324
|
+
readonly propertyNames: {
|
|
325
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
};
|
|
331
|
+
/**
|
|
332
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
333
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
334
|
+
* parties (§7.3 item 5).
|
|
335
|
+
*/
|
|
336
|
+
export declare const RESPONSE_SPEC: {
|
|
337
|
+
readonly typeUri: "https://trusttasks.org/spec/vtc/join-requests/query/0.1#response";
|
|
338
|
+
readonly isBearer: false;
|
|
339
|
+
readonly isProofRequired: true;
|
|
340
|
+
readonly isRecipientRequired: true;
|
|
341
|
+
readonly isIssuedAtRequired: true;
|
|
342
|
+
readonly payloadSchema: {
|
|
343
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
344
|
+
readonly $ref: "#/$defs/Response";
|
|
345
|
+
readonly $defs: {
|
|
346
|
+
readonly CredentialQuery: {
|
|
347
|
+
readonly title: "CredentialQuery";
|
|
348
|
+
readonly type: "object";
|
|
349
|
+
readonly additionalProperties: true;
|
|
350
|
+
readonly required: readonly ["dcql_query", "nonce", "purpose"];
|
|
351
|
+
readonly description: "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.";
|
|
352
|
+
readonly properties: {
|
|
353
|
+
readonly dcql_query: {
|
|
354
|
+
readonly type: "object";
|
|
355
|
+
};
|
|
356
|
+
readonly nonce: {
|
|
357
|
+
readonly type: "string";
|
|
358
|
+
readonly minLength: 1;
|
|
359
|
+
readonly maxLength: 512;
|
|
360
|
+
};
|
|
361
|
+
readonly purpose: {
|
|
362
|
+
readonly type: "string";
|
|
363
|
+
readonly minLength: 1;
|
|
364
|
+
readonly maxLength: 500;
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
};
|
|
368
|
+
readonly Response: {
|
|
369
|
+
readonly $anchor: "response";
|
|
370
|
+
readonly title: "VTC Join Requests — Query — response payload";
|
|
371
|
+
readonly type: "object";
|
|
372
|
+
readonly additionalProperties: false;
|
|
373
|
+
readonly required: readonly ["threadId", "holderDid", "query", "delivered"];
|
|
374
|
+
readonly properties: {
|
|
375
|
+
readonly threadId: {
|
|
376
|
+
readonly type: "string";
|
|
377
|
+
readonly minLength: 1;
|
|
378
|
+
readonly maxLength: 256;
|
|
379
|
+
readonly description: "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.";
|
|
380
|
+
};
|
|
381
|
+
readonly holderDid: {
|
|
382
|
+
readonly type: "string";
|
|
383
|
+
readonly pattern: "^did:";
|
|
384
|
+
readonly maxLength: 2048;
|
|
385
|
+
readonly description: "Echoed.";
|
|
386
|
+
};
|
|
387
|
+
readonly query: {
|
|
388
|
+
readonly $ref: "#/$defs/CredentialQuery";
|
|
389
|
+
};
|
|
390
|
+
readonly delivered: {
|
|
391
|
+
readonly type: "boolean";
|
|
392
|
+
readonly description: "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.";
|
|
393
|
+
};
|
|
394
|
+
readonly ext: {
|
|
395
|
+
readonly $ref: "#/$defs/Ext";
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
};
|
|
399
|
+
readonly Ext: {
|
|
400
|
+
readonly title: "Ext";
|
|
401
|
+
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.";
|
|
402
|
+
readonly type: "object";
|
|
403
|
+
readonly minProperties: 1;
|
|
404
|
+
readonly additionalProperties: true;
|
|
405
|
+
readonly propertyNames: {
|
|
406
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
407
|
+
};
|
|
408
|
+
};
|
|
409
|
+
};
|
|
410
|
+
};
|
|
411
|
+
};
|
|
412
|
+
//# sourceMappingURL=payload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vtc/join-requests/query/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAG7D;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,CAAC;AAEpB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,yDAAkE,CAAC;AAE3F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,2BAA2B,CAAC;AAElD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,kEAA2E,CAAC;AAE7G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,mCAAmC,CAAC;AAE3D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuGjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6E1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
|
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vtc/join-requests/query/0.1/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
/** Trust Task type URI. */
|
|
6
|
+
export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/query/0.1";
|
|
7
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
8
|
+
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/query/0.1#response";
|
|
9
|
+
/**
|
|
10
|
+
* This specification's payload schema, as a value.
|
|
11
|
+
*
|
|
12
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
13
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
14
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
15
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
16
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
17
|
+
*/
|
|
18
|
+
export const PAYLOAD_SCHEMA = {
|
|
19
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
20
|
+
"$id": "https://trusttasks.org/spec/vtc/join-requests/query/0.1",
|
|
21
|
+
"title": "VTC Join Requests — Query — payload",
|
|
22
|
+
"description": "An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.",
|
|
23
|
+
"type": "object",
|
|
24
|
+
"additionalProperties": false,
|
|
25
|
+
"required": [
|
|
26
|
+
"holderDid",
|
|
27
|
+
"criterionId"
|
|
28
|
+
],
|
|
29
|
+
"properties": {
|
|
30
|
+
"holderDid": {
|
|
31
|
+
"type": "string",
|
|
32
|
+
"pattern": "^did:",
|
|
33
|
+
"minLength": 5,
|
|
34
|
+
"maxLength": 2048,
|
|
35
|
+
"description": "The holder the query is for — the prospective member whose agent will answer it."
|
|
36
|
+
},
|
|
37
|
+
"criterionId": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"minLength": 1,
|
|
40
|
+
"maxLength": 128,
|
|
41
|
+
"description": "The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send."
|
|
42
|
+
},
|
|
43
|
+
"ext": {
|
|
44
|
+
"$ref": "#/$defs/Ext"
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
"$defs": {
|
|
48
|
+
"CredentialQuery": {
|
|
49
|
+
"title": "CredentialQuery",
|
|
50
|
+
"type": "object",
|
|
51
|
+
"additionalProperties": true,
|
|
52
|
+
"required": [
|
|
53
|
+
"dcql_query",
|
|
54
|
+
"nonce",
|
|
55
|
+
"purpose"
|
|
56
|
+
],
|
|
57
|
+
"description": "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.",
|
|
58
|
+
"properties": {
|
|
59
|
+
"dcql_query": {
|
|
60
|
+
"type": "object"
|
|
61
|
+
},
|
|
62
|
+
"nonce": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"minLength": 1,
|
|
65
|
+
"maxLength": 512
|
|
66
|
+
},
|
|
67
|
+
"purpose": {
|
|
68
|
+
"type": "string",
|
|
69
|
+
"minLength": 1,
|
|
70
|
+
"maxLength": 500
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
"Response": {
|
|
75
|
+
"$anchor": "response",
|
|
76
|
+
"title": "VTC Join Requests — Query — response payload",
|
|
77
|
+
"type": "object",
|
|
78
|
+
"additionalProperties": false,
|
|
79
|
+
"required": [
|
|
80
|
+
"threadId",
|
|
81
|
+
"holderDid",
|
|
82
|
+
"query",
|
|
83
|
+
"delivered"
|
|
84
|
+
],
|
|
85
|
+
"properties": {
|
|
86
|
+
"threadId": {
|
|
87
|
+
"type": "string",
|
|
88
|
+
"minLength": 1,
|
|
89
|
+
"maxLength": 256,
|
|
90
|
+
"description": "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it."
|
|
91
|
+
},
|
|
92
|
+
"holderDid": {
|
|
93
|
+
"type": "string",
|
|
94
|
+
"pattern": "^did:",
|
|
95
|
+
"maxLength": 2048,
|
|
96
|
+
"description": "Echoed."
|
|
97
|
+
},
|
|
98
|
+
"query": {
|
|
99
|
+
"$ref": "#/$defs/CredentialQuery"
|
|
100
|
+
},
|
|
101
|
+
"delivered": {
|
|
102
|
+
"type": "boolean",
|
|
103
|
+
"description": "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself."
|
|
104
|
+
},
|
|
105
|
+
"ext": {
|
|
106
|
+
"$ref": "#/$defs/Ext"
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
},
|
|
110
|
+
"Ext": {
|
|
111
|
+
"title": "Ext",
|
|
112
|
+
"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.",
|
|
113
|
+
"type": "object",
|
|
114
|
+
"minProperties": 1,
|
|
115
|
+
"additionalProperties": true,
|
|
116
|
+
"propertyNames": {
|
|
117
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
};
|
|
122
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
123
|
+
export const RESPONSE_PAYLOAD_SCHEMA = {
|
|
124
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
125
|
+
"$ref": "#/$defs/Response",
|
|
126
|
+
"$defs": {
|
|
127
|
+
"CredentialQuery": {
|
|
128
|
+
"title": "CredentialQuery",
|
|
129
|
+
"type": "object",
|
|
130
|
+
"additionalProperties": true,
|
|
131
|
+
"required": [
|
|
132
|
+
"dcql_query",
|
|
133
|
+
"nonce",
|
|
134
|
+
"purpose"
|
|
135
|
+
],
|
|
136
|
+
"description": "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.",
|
|
137
|
+
"properties": {
|
|
138
|
+
"dcql_query": {
|
|
139
|
+
"type": "object"
|
|
140
|
+
},
|
|
141
|
+
"nonce": {
|
|
142
|
+
"type": "string",
|
|
143
|
+
"minLength": 1,
|
|
144
|
+
"maxLength": 512
|
|
145
|
+
},
|
|
146
|
+
"purpose": {
|
|
147
|
+
"type": "string",
|
|
148
|
+
"minLength": 1,
|
|
149
|
+
"maxLength": 500
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
"Response": {
|
|
154
|
+
"$anchor": "response",
|
|
155
|
+
"title": "VTC Join Requests — Query — response payload",
|
|
156
|
+
"type": "object",
|
|
157
|
+
"additionalProperties": false,
|
|
158
|
+
"required": [
|
|
159
|
+
"threadId",
|
|
160
|
+
"holderDid",
|
|
161
|
+
"query",
|
|
162
|
+
"delivered"
|
|
163
|
+
],
|
|
164
|
+
"properties": {
|
|
165
|
+
"threadId": {
|
|
166
|
+
"type": "string",
|
|
167
|
+
"minLength": 1,
|
|
168
|
+
"maxLength": 256,
|
|
169
|
+
"description": "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it."
|
|
170
|
+
},
|
|
171
|
+
"holderDid": {
|
|
172
|
+
"type": "string",
|
|
173
|
+
"pattern": "^did:",
|
|
174
|
+
"maxLength": 2048,
|
|
175
|
+
"description": "Echoed."
|
|
176
|
+
},
|
|
177
|
+
"query": {
|
|
178
|
+
"$ref": "#/$defs/CredentialQuery"
|
|
179
|
+
},
|
|
180
|
+
"delivered": {
|
|
181
|
+
"type": "boolean",
|
|
182
|
+
"description": "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself."
|
|
183
|
+
},
|
|
184
|
+
"ext": {
|
|
185
|
+
"$ref": "#/$defs/Ext"
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
},
|
|
189
|
+
"Ext": {
|
|
190
|
+
"title": "Ext",
|
|
191
|
+
"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.",
|
|
192
|
+
"type": "object",
|
|
193
|
+
"minProperties": 1,
|
|
194
|
+
"additionalProperties": true,
|
|
195
|
+
"propertyNames": {
|
|
196
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
};
|
|
201
|
+
/**
|
|
202
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
203
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
204
|
+
* per-specification and cannot be derived from the document alone, and
|
|
205
|
+
* item 2 needs the schema this carries.
|
|
206
|
+
*/
|
|
207
|
+
export const SPEC = {
|
|
208
|
+
typeUri: TYPE_URI,
|
|
209
|
+
isBearer: false,
|
|
210
|
+
isProofRequired: true,
|
|
211
|
+
isRecipientRequired: true,
|
|
212
|
+
isIssuedAtRequired: true,
|
|
213
|
+
payloadSchema: PAYLOAD_SCHEMA,
|
|
214
|
+
};
|
|
215
|
+
/**
|
|
216
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
217
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
218
|
+
* parties (§7.3 item 5).
|
|
219
|
+
*/
|
|
220
|
+
export const RESPONSE_SPEC = {
|
|
221
|
+
typeUri: RESPONSE_TYPE_URI,
|
|
222
|
+
isBearer: false,
|
|
223
|
+
isProofRequired: true,
|
|
224
|
+
isRecipientRequired: true,
|
|
225
|
+
isIssuedAtRequired: true,
|
|
226
|
+
payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
|
|
227
|
+
};
|
|
228
|
+
//# sourceMappingURL=payload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vtc/join-requests/query/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAgDH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,yDAAkE,CAAC;AAK3F,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,kEAA2E,CAAC;AAK7G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,yDAAyD;IAChE,OAAO,EAAE,qCAAqC;IAC9C,aAAa,EAAE,4RAA4R;IAC3S,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,WAAW;QACX,aAAa;KACd;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,OAAO;YAClB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,kFAAkF;SAClG;QACD,aAAa,EAAE;YACb,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,2FAA2F;SAC3G;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,iBAAiB,EAAE;YACjB,OAAO,EAAE,iBAAiB;YAC1B,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,IAAI;YAC5B,UAAU,EAAE;gBACV,YAAY;gBACZ,OAAO;gBACP,SAAS;aACV;YACD,aAAa,EAAE,0aAA0a;YACzb,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;iBACjB;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;iBACjB;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;iBACjB;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,8CAA8C;YACvD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;gBACV,WAAW;gBACX,OAAO;gBACP,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,+LAA+L;iBAC/M;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,OAAO;oBAClB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,SAAS;iBACzB;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,yBAAyB;iBAClC;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,oPAAoP;iBACpQ;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,iBAAiB,EAAE;YACjB,OAAO,EAAE,iBAAiB;YAC1B,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,IAAI;YAC5B,UAAU,EAAE;gBACV,YAAY;gBACZ,OAAO;gBACP,SAAS;aACV;YACD,aAAa,EAAE,0aAA0a;YACzb,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;iBACjB;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;iBACjB;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;iBACjB;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,8CAA8C;YACvD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;gBACV,WAAW;gBACX,OAAO;gBACP,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,+LAA+L;iBAC/M;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,OAAO;oBAClB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,SAAS;iBACzB;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,yBAAyB;iBAClC;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,oPAAoP;iBACpQ;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}
|