@openvtc/trust-tasks 0.28.1 → 0.28.2
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 +201 -0
- package/dist/_runtime/document.d.ts +13 -0
- package/dist/_runtime/document.d.ts.map +1 -1
- package/dist/_runtime/document.js +17 -2
- package/dist/_runtime/document.js.map +1 -1
- package/dist/_runtime/index.d.ts +1 -1
- package/dist/_runtime/index.d.ts.map +1 -1
- package/dist/_runtime/index.js +1 -1
- package/dist/_runtime/index.js.map +1 -1
- package/dist/auth/step-up/approve-request/0.5/payload.d.ts +3 -3
- package/dist/auth/step-up/approve-request/0.5/payload.js +1 -1
- package/dist/auth/step-up/approve-response/0.1/payload.d.ts +4 -4
- package/dist/auth/step-up/approve-response/0.1/payload.js +1 -1
- package/dist/auth/step-up/approve-response/0.2/payload.d.ts +4 -4
- package/dist/auth/step-up/approve-response/0.2/payload.js +1 -1
- package/dist/auth/step-up/approve-response/0.3/payload.d.ts +4 -4
- package/dist/auth/step-up/approve-response/0.3/payload.js +1 -1
- package/dist/auth/step-up/approve-response/0.4/payload.d.ts +4 -4
- package/dist/auth/step-up/approve-response/0.4/payload.js +1 -1
- package/dist/auth/step-up/approve-response/0.5/payload.d.ts +4 -4
- package/dist/auth/step-up/approve-response/0.5/payload.js +1 -1
- package/dist/auth/step-up/approve-response/0.6/payload.d.ts +14 -2
- package/dist/auth/step-up/approve-response/0.6/payload.d.ts.map +1 -1
- package/dist/auth/step-up/approve-response/0.6/payload.js +1 -1
- package/dist/auth/step-up/approve-response/0.6/payload.js.map +1 -1
- package/dist/auth/step-up/approve-response/0.7/payload.d.ts +988 -0
- package/dist/auth/step-up/approve-response/0.7/payload.d.ts.map +1 -0
- package/dist/auth/step-up/approve-response/0.7/payload.js +566 -0
- package/dist/auth/step-up/approve-response/0.7/payload.js.map +1 -0
- package/dist/auth/step-up/approver/attest/0.1/payload.d.ts +3 -3
- package/dist/auth/step-up/approver/attest/0.1/payload.js +1 -1
- package/dist/index.d.ts +15 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -1
- package/dist/rooms/owner/group/remove/0.1/payload.d.ts +4 -4
- package/dist/rooms/owner/group/remove/0.1/payload.js +1 -1
- package/dist/rooms/owner/group/remove/0.2/payload.d.ts +4 -4
- package/dist/rooms/owner/group/remove/0.2/payload.js +1 -1
- package/dist/rooms/owner/group/remove/0.3/payload.d.ts +14 -2
- package/dist/rooms/owner/group/remove/0.3/payload.d.ts.map +1 -1
- package/dist/rooms/owner/group/remove/0.3/payload.js +1 -1
- package/dist/rooms/owner/group/remove/0.3/payload.js.map +1 -1
- package/dist/rooms/owner/group/remove/0.4/payload.d.ts +634 -0
- package/dist/rooms/owner/group/remove/0.4/payload.d.ts.map +1 -0
- package/dist/rooms/owner/group/remove/0.4/payload.js +331 -0
- package/dist/rooms/owner/group/remove/0.4/payload.js.map +1 -0
- package/dist/task-consent/decision/0.2/payload.d.ts +5 -5
- package/dist/task-consent/decision/0.2/payload.js +2 -2
- package/dist/vtc/install/claim/finish/0.2/payload.d.ts +4 -4
- package/dist/vtc/install/claim/finish/0.2/payload.d.ts.map +1 -1
- package/dist/vtc/install/claim/finish/0.2/payload.js +1 -1
- package/dist/vtc/install/claim/finish/0.2/payload.js.map +1 -1
- package/dist/vtc/install/claim/passkey/finish/0.1/payload.d.ts +306 -0
- package/dist/vtc/install/claim/passkey/finish/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/install/claim/passkey/finish/0.1/payload.js +175 -0
- package/dist/vtc/install/claim/passkey/finish/0.1/payload.js.map +1 -0
- package/dist/vtc/install/claim/passkey/start/0.1/payload.d.ts +302 -0
- package/dist/vtc/install/claim/passkey/start/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/install/claim/passkey/start/0.1/payload.js +172 -0
- package/dist/vtc/install/claim/passkey/start/0.1/payload.js.map +1 -0
- package/dist/vtc/install/claim/start/0.2/payload.d.ts +4 -4
- package/dist/vtc/install/claim/start/0.2/payload.d.ts.map +1 -1
- package/dist/vtc/install/claim/start/0.2/payload.js +1 -1
- package/dist/vtc/install/claim/start/0.2/payload.js.map +1 -1
- package/dist/vtc/members/role/set/0.1/payload.d.ts +1867 -0
- package/dist/vtc/members/role/set/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/members/role/set/0.1/payload.js +1060 -0
- package/dist/vtc/members/role/set/0.1/payload.js.map +1 -0
- package/package.json +1 -1
- package/src/_runtime/document.ts +18 -2
- package/src/_runtime/index.ts +1 -0
- package/src/auth/step-up/approve-request/0.5/payload.ts +2 -2
- package/src/auth/step-up/approve-response/0.1/payload.ts +5 -5
- package/src/auth/step-up/approve-response/0.2/payload.ts +5 -5
- package/src/auth/step-up/approve-response/0.3/payload.ts +5 -5
- package/src/auth/step-up/approve-response/0.4/payload.ts +5 -5
- package/src/auth/step-up/approve-response/0.5/payload.ts +5 -5
- package/src/auth/step-up/approve-response/0.6/payload.ts +15 -3
- package/src/auth/step-up/approve-response/0.7/payload.ts +664 -0
- package/src/auth/step-up/approver/attest/0.1/payload.ts +2 -2
- package/src/index.ts +15 -0
- package/src/rooms/owner/group/remove/0.1/payload.ts +5 -5
- package/src/rooms/owner/group/remove/0.2/payload.ts +5 -5
- package/src/rooms/owner/group/remove/0.3/payload.ts +15 -3
- package/src/rooms/owner/group/remove/0.4/payload.ts +442 -0
- package/src/task-consent/decision/0.2/payload.ts +3 -3
- package/src/vtc/install/claim/finish/0.2/payload.ts +5 -5
- package/src/vtc/install/claim/passkey/finish/0.1/payload.ts +228 -0
- package/src/vtc/install/claim/passkey/start/0.1/payload.ts +225 -0
- package/src/vtc/install/claim/start/0.2/payload.ts +5 -5
- package/src/vtc/members/role/set/0.1/payload.ts +1142 -0
|
@@ -11,7 +11,7 @@ import type { Ext } from "../../../../../_shared/components.js";
|
|
|
11
11
|
*/
|
|
12
12
|
export interface AuthStepUpApproverAttestPayload {
|
|
13
13
|
/**
|
|
14
|
-
* What the statement attests. `stepUp`: a re-authentication bound to one operation (carried in auth/step-up/approve-response/0.
|
|
14
|
+
* What the statement attests. `stepUp`: a re-authentication bound to one operation (carried in auth/step-up/approve-response/0.7). `decision`: the factor backing a consent decision (carried in task-consent/decision/0.2 `evidence`). `enrol`: proof of possession of the approver key at enrolment. Signed, so a statement made for one use is refused at another.
|
|
15
15
|
*/
|
|
16
16
|
purpose: "stepUp" | "decision" | "enrol";
|
|
17
17
|
/**
|
|
@@ -89,7 +89,7 @@ export const PAYLOAD_SCHEMA = {
|
|
|
89
89
|
"decision",
|
|
90
90
|
"enrol"
|
|
91
91
|
],
|
|
92
|
-
"description": "What the statement attests. `stepUp`: a re-authentication bound to one operation (carried in auth/step-up/approve-response/0.
|
|
92
|
+
"description": "What the statement attests. `stepUp`: a re-authentication bound to one operation (carried in auth/step-up/approve-response/0.7). `decision`: the factor backing a consent decision (carried in task-consent/decision/0.2 `evidence`). `enrol`: proof of possession of the approver key at enrolment. Signed, so a statement made for one use is refused at another."
|
|
93
93
|
},
|
|
94
94
|
"subject": {
|
|
95
95
|
"type": "string",
|
package/src/index.ts
CHANGED
|
@@ -292,6 +292,9 @@ export import AuthStepUpApproveResponse_v0_5 = _AuthStepUpApproveResponse_v0_5;
|
|
|
292
292
|
import * as _AuthStepUpApproveResponse_v0_6 from "./auth/step-up/approve-response/0.6/payload.js";
|
|
293
293
|
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
294
294
|
export import AuthStepUpApproveResponse_v0_6 = _AuthStepUpApproveResponse_v0_6;
|
|
295
|
+
import * as _AuthStepUpApproveResponse_v0_7 from "./auth/step-up/approve-response/0.7/payload.js";
|
|
296
|
+
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
297
|
+
export import AuthStepUpApproveResponse_v0_7 = _AuthStepUpApproveResponse_v0_7;
|
|
295
298
|
import * as _ApproverShared_v0_1 from "./auth/step-up/approver/_shared/0.1/approver.js";
|
|
296
299
|
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
297
300
|
export import ApproverShared_v0_1 = _ApproverShared_v0_1;
|
|
@@ -1792,6 +1795,9 @@ export import RoomsOwnerGroupRemove_v0_2 = _RoomsOwnerGroupRemove_v0_2;
|
|
|
1792
1795
|
import * as _RoomsOwnerGroupRemove_v0_3 from "./rooms/owner/group/remove/0.3/payload.js";
|
|
1793
1796
|
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
1794
1797
|
export import RoomsOwnerGroupRemove_v0_3 = _RoomsOwnerGroupRemove_v0_3;
|
|
1798
|
+
import * as _RoomsOwnerGroupRemove_v0_4 from "./rooms/owner/group/remove/0.4/payload.js";
|
|
1799
|
+
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
1800
|
+
export import RoomsOwnerGroupRemove_v0_4 = _RoomsOwnerGroupRemove_v0_4;
|
|
1795
1801
|
import * as _RoomsOwnerGroupRenew_v0_1 from "./rooms/owner/group/renew/0.1/payload.js";
|
|
1796
1802
|
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
1797
1803
|
export import RoomsOwnerGroupRenew_v0_1 = _RoomsOwnerGroupRenew_v0_1;
|
|
@@ -3206,6 +3212,12 @@ export import VtcInstallClaimFinish_v0_2 = _VtcInstallClaimFinish_v0_2;
|
|
|
3206
3212
|
import * as _VtcInstallClaimFinish_v0_3 from "./vtc/install/claim/finish/0.3/payload.js";
|
|
3207
3213
|
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
3208
3214
|
export import VtcInstallClaimFinish_v0_3 = _VtcInstallClaimFinish_v0_3;
|
|
3215
|
+
import * as _VtcInstallClaimPasskeyFinish_v0_1 from "./vtc/install/claim/passkey/finish/0.1/payload.js";
|
|
3216
|
+
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
3217
|
+
export import VtcInstallClaimPasskeyFinish_v0_1 = _VtcInstallClaimPasskeyFinish_v0_1;
|
|
3218
|
+
import * as _VtcInstallClaimPasskeyStart_v0_1 from "./vtc/install/claim/passkey/start/0.1/payload.js";
|
|
3219
|
+
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
3220
|
+
export import VtcInstallClaimPasskeyStart_v0_1 = _VtcInstallClaimPasskeyStart_v0_1;
|
|
3209
3221
|
import * as _VtcInstallClaimStart_v0_1 from "./vtc/install/claim/start/0.1/payload.js";
|
|
3210
3222
|
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
3211
3223
|
export import VtcInstallClaimStart_v0_1 = _VtcInstallClaimStart_v0_1;
|
|
@@ -3347,6 +3359,9 @@ export import VtcMembersRenew_v0_1 = _VtcMembersRenew_v0_1;
|
|
|
3347
3359
|
import * as _VtcMembersRequestVmc_v0_1 from "./vtc/members/request-vmc/0.1/payload.js";
|
|
3348
3360
|
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
3349
3361
|
export import VtcMembersRequestVmc_v0_1 = _VtcMembersRequestVmc_v0_1;
|
|
3362
|
+
import * as _VtcMembersRoleSet_v0_1 from "./vtc/members/role/set/0.1/payload.js";
|
|
3363
|
+
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
3364
|
+
export import VtcMembersRoleSet_v0_1 = _VtcMembersRoleSet_v0_1;
|
|
3350
3365
|
import * as _VtcMembersRotateChallenge_v0_1 from "./vtc/members/rotate-challenge/0.1/payload.js";
|
|
3351
3366
|
/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
|
|
3352
3367
|
export import VtcMembersRotateChallenge_v0_1 = _VtcMembersRotateChallenge_v0_1;
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
import type { Ext } from "../../../../../_shared/components.js";
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
/** @deprecated superseded by rooms/owner/group/remove/0.
|
|
9
|
+
/** @deprecated superseded by rooms/owner/group/remove/0.4 */
|
|
10
10
|
export interface RoomsOwnerGroupRemovePayload {
|
|
11
11
|
/**
|
|
12
12
|
* The room whose group loses a member. The recipient MUST hold its group.
|
|
@@ -32,7 +32,7 @@ export interface RoomsOwnerGroupRemovePayload {
|
|
|
32
32
|
/**
|
|
33
33
|
* Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.1#response. The room's new epoch, which the removed member holds no key for.
|
|
34
34
|
*
|
|
35
|
-
* @deprecated superseded by rooms/owner/group/remove/0.
|
|
35
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
36
36
|
*/
|
|
37
37
|
export interface RoomsOwnerGroupRemoveResponsePayload {
|
|
38
38
|
/**
|
|
@@ -70,12 +70,12 @@ export const EXTENDS: string | null = null;
|
|
|
70
70
|
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
71
71
|
* Versions").
|
|
72
72
|
*/
|
|
73
|
-
export const DEPRECATION: string | null = "superseded by rooms/owner/group/remove/0.
|
|
73
|
+
export const DEPRECATION: string | null = "superseded by rooms/owner/group/remove/0.4";
|
|
74
74
|
|
|
75
75
|
/**
|
|
76
76
|
* Stable alias for this specification's request payload shape.
|
|
77
77
|
*
|
|
78
|
-
* @deprecated superseded by rooms/owner/group/remove/0.
|
|
78
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
79
79
|
*/
|
|
80
80
|
export type Payload = RoomsOwnerGroupRemovePayload;
|
|
81
81
|
|
|
@@ -85,7 +85,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/owner/group/
|
|
|
85
85
|
/**
|
|
86
86
|
* Stable alias for this specification's success-response payload shape.
|
|
87
87
|
*
|
|
88
|
-
* @deprecated superseded by rooms/owner/group/remove/0.
|
|
88
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
89
89
|
*/
|
|
90
90
|
export type Response = RoomsOwnerGroupRemoveResponsePayload;
|
|
91
91
|
|
|
@@ -9,7 +9,7 @@ import type { DigestMultibase, Ext, RevocationHead } from "../../../../../_share
|
|
|
9
9
|
/**
|
|
10
10
|
* A room's owner asks their own agent to remove a member: withdraw every credential the room gave them, at its host at once, and then remove their leaf from the room's MLS group and advance its epoch. 0.2 adds the withdrawal, made first.
|
|
11
11
|
*
|
|
12
|
-
* @deprecated superseded by rooms/owner/group/remove/0.
|
|
12
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
13
13
|
*/
|
|
14
14
|
export interface RoomsOwnerGroupRemovePayload {
|
|
15
15
|
/**
|
|
@@ -58,7 +58,7 @@ export interface RoomsOwnerGroupRemovePayload {
|
|
|
58
58
|
/**
|
|
59
59
|
* Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.2#response. The revocation list in force at the host, and the room's new epoch, which the removed member holds no key for.
|
|
60
60
|
*
|
|
61
|
-
* @deprecated superseded by rooms/owner/group/remove/0.
|
|
61
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
62
62
|
*/
|
|
63
63
|
export interface RoomsOwnerGroupRemoveResponsePayload {
|
|
64
64
|
/**
|
|
@@ -118,12 +118,12 @@ export const EXTENDS: string | null = null;
|
|
|
118
118
|
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
119
119
|
* Versions").
|
|
120
120
|
*/
|
|
121
|
-
export const DEPRECATION: string | null = "superseded by rooms/owner/group/remove/0.
|
|
121
|
+
export const DEPRECATION: string | null = "superseded by rooms/owner/group/remove/0.4";
|
|
122
122
|
|
|
123
123
|
/**
|
|
124
124
|
* Stable alias for this specification's request payload shape.
|
|
125
125
|
*
|
|
126
|
-
* @deprecated superseded by rooms/owner/group/remove/0.
|
|
126
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
127
127
|
*/
|
|
128
128
|
export type Payload = RoomsOwnerGroupRemovePayload;
|
|
129
129
|
|
|
@@ -133,7 +133,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/owner/group/
|
|
|
133
133
|
/**
|
|
134
134
|
* Stable alias for this specification's success-response payload shape.
|
|
135
135
|
*
|
|
136
|
-
* @deprecated superseded by rooms/owner/group/remove/0.
|
|
136
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
137
137
|
*/
|
|
138
138
|
export type Response = RoomsOwnerGroupRemoveResponsePayload;
|
|
139
139
|
|
|
@@ -8,6 +8,8 @@ import type { DigestMultibase, Ext, RevocationHead } from "../../../../../_share
|
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
10
|
* A room's owner asks their own agent to remove a member: withdraw every credential the room gave them, at its host at once, and then remove their leaf from the room's MLS group and advance its epoch. 0.2 adds the withdrawal, made first.
|
|
11
|
+
*
|
|
12
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
11
13
|
*/
|
|
12
14
|
export interface RoomsOwnerGroupRemovePayload {
|
|
13
15
|
/**
|
|
@@ -55,6 +57,8 @@ export interface RoomsOwnerGroupRemovePayload {
|
|
|
55
57
|
}
|
|
56
58
|
/**
|
|
57
59
|
* Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.3#response. The revocation list in force at the host, and the room's new epoch, which the removed member holds no key for.
|
|
60
|
+
*
|
|
61
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
58
62
|
*/
|
|
59
63
|
export interface RoomsOwnerGroupRemoveResponsePayload {
|
|
60
64
|
/**
|
|
@@ -114,15 +118,23 @@ export const EXTENDS: string | null = null;
|
|
|
114
118
|
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
115
119
|
* Versions").
|
|
116
120
|
*/
|
|
117
|
-
export const DEPRECATION: string | null =
|
|
121
|
+
export const DEPRECATION: string | null = "superseded by rooms/owner/group/remove/0.4";
|
|
118
122
|
|
|
119
|
-
/**
|
|
123
|
+
/**
|
|
124
|
+
* Stable alias for this specification's request payload shape.
|
|
125
|
+
*
|
|
126
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
127
|
+
*/
|
|
120
128
|
export type Payload = RoomsOwnerGroupRemovePayload;
|
|
121
129
|
|
|
122
130
|
/** Trust Task response type URI (request type URI + "#response"). */
|
|
123
131
|
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/owner/group/remove/0.3#response" as const;
|
|
124
132
|
|
|
125
|
-
/**
|
|
133
|
+
/**
|
|
134
|
+
* Stable alias for this specification's success-response payload shape.
|
|
135
|
+
*
|
|
136
|
+
* @deprecated superseded by rooms/owner/group/remove/0.4
|
|
137
|
+
*/
|
|
126
138
|
export type Response = RoomsOwnerGroupRemoveResponsePayload;
|
|
127
139
|
|
|
128
140
|
/**
|
|
@@ -0,0 +1,442 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/rooms/owner/group/remove/0.4/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import type { DigestMultibase, Ext, RevocationHead } from "../../../../../_shared/components.js";
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* A room's owner asks their own agent to remove a member from a sealed room: on an attributed room withdraw every credential the room gave them, at its host at once, and on either sealed tier remove their leaf from the room's MLS group and advance its epoch. 0.4 removes a private room's member from the group, withdrawing nothing, where 0.2 and 0.3 refused.
|
|
11
|
+
*/
|
|
12
|
+
export interface RoomsOwnerGroupRemovePayload {
|
|
13
|
+
/**
|
|
14
|
+
* The room whose group loses a member. The recipient MUST hold its group and a signing key for it.
|
|
15
|
+
*/
|
|
16
|
+
roomId: string;
|
|
17
|
+
/**
|
|
18
|
+
* The room's host, as a DID: where the withdrawal, if any, is delivered first and the room's epoch advances.
|
|
19
|
+
*/
|
|
20
|
+
host: string;
|
|
21
|
+
/**
|
|
22
|
+
* Any other host serving the room, as DIDs. On a room that is not private, each is delivered the withdrawal too: a host that does not hold it honours the member's credentials still. Unused on a private room.
|
|
23
|
+
*
|
|
24
|
+
* @maxItems 7
|
|
25
|
+
*/
|
|
26
|
+
mirrors?:
|
|
27
|
+
| []
|
|
28
|
+
| [string]
|
|
29
|
+
| [string, string]
|
|
30
|
+
| [string, string, string]
|
|
31
|
+
| [string, string, string, string]
|
|
32
|
+
| [string, string, string, string, string]
|
|
33
|
+
| [string, string, string, string, string, string]
|
|
34
|
+
| [string, string, string, string, string, string, string];
|
|
35
|
+
/**
|
|
36
|
+
* The DID whose leaf is removed and, on a room that is not private, whose credentials the room withdraws. Never the recipient's own leaf.
|
|
37
|
+
*/
|
|
38
|
+
member: string;
|
|
39
|
+
/**
|
|
40
|
+
* Which held key signs the room's revocation list as the room, named explicitly as for rooms/owner/revoke. Required unless the room is private, whose removal signs nothing as the room: a request naming none for any other room is refused with noSigningKey.
|
|
41
|
+
*/
|
|
42
|
+
signingKeyId?: string;
|
|
43
|
+
/**
|
|
44
|
+
* OPTIONAL. When the last credential the room issued `member` expires, after which the withdrawal can be dropped from the room's list. Unused on a private room.
|
|
45
|
+
*/
|
|
46
|
+
until?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Why, carried to the host's epoch advance. Untrusted and attributed to its author: it MUST NOT carry personal data or a credential. Never put into the revocation list.
|
|
49
|
+
*/
|
|
50
|
+
reason?: string;
|
|
51
|
+
/**
|
|
52
|
+
* Ecosystem-defined extension members per SPEC.md §4.5.1.
|
|
53
|
+
*/
|
|
54
|
+
ext?: Ext;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.4#response. Whether the member was withdrawn at the host, the revocation list in force there when they were, and the room's new epoch, which the removed member holds no key for.
|
|
58
|
+
*/
|
|
59
|
+
export interface RoomsOwnerGroupRemoveResponsePayload {
|
|
60
|
+
/**
|
|
61
|
+
* The room.
|
|
62
|
+
*/
|
|
63
|
+
roomId: string;
|
|
64
|
+
/**
|
|
65
|
+
* Who was removed.
|
|
66
|
+
*/
|
|
67
|
+
member: string;
|
|
68
|
+
/**
|
|
69
|
+
* Whether the member's credentials were withdrawn at the host. True on an attributed room, with `revocation` and `revokedAt`; false on a private room, whose host cannot be told whom to refuse: the member's credentials stay valid there until they expire, and only a reset of every credential (rooms/owner/revoke, a `room` entry) withdraws them. A surface MUST NOT report false as a withdrawal.
|
|
70
|
+
*/
|
|
71
|
+
withdrawn: boolean;
|
|
72
|
+
/**
|
|
73
|
+
* The revocation list carrying the withdrawal, as `host` accepted it. Present exactly when `withdrawn` is true.
|
|
74
|
+
*/
|
|
75
|
+
revocation?: RevocationHead;
|
|
76
|
+
/**
|
|
77
|
+
* The withdrawal's `revokedAt`: credentials the room issued `member` before it are refused, and fresh ones issued after it are not. Present only when `withdrawn` is true.
|
|
78
|
+
*/
|
|
79
|
+
revokedAt?: string;
|
|
80
|
+
/**
|
|
81
|
+
* The room epoch after the removal, as the host recorded it.
|
|
82
|
+
*/
|
|
83
|
+
epoch: number;
|
|
84
|
+
/**
|
|
85
|
+
* Mirrors that did not confirm the withdrawal. Each still honours the member's credentials until the list is delivered — with rooms/owner/revoke and no `withdraw`. Absent when every mirror confirmed. Never present when `withdrawn` is false.
|
|
86
|
+
*
|
|
87
|
+
* @maxItems 7
|
|
88
|
+
*/
|
|
89
|
+
mirrorsPending?:
|
|
90
|
+
| []
|
|
91
|
+
| [string]
|
|
92
|
+
| [string, string]
|
|
93
|
+
| [string, string, string]
|
|
94
|
+
| [string, string, string, string]
|
|
95
|
+
| [string, string, string, string, string]
|
|
96
|
+
| [string, string, string, string, string, string]
|
|
97
|
+
| [string, string, string, string, string, string, string];
|
|
98
|
+
ext?: Ext;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
102
|
+
export type { DigestMultibase, Ext, RevocationHead };
|
|
103
|
+
|
|
104
|
+
/** Trust Task type URI. */
|
|
105
|
+
export const TYPE_URI = "https://trusttasks.org/spec/rooms/owner/group/remove/0.4" as const;
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* The earlier version of this specification that this one declares it
|
|
109
|
+
* extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
|
|
110
|
+
* `null`. Only the direct declaration — follow the chain with
|
|
111
|
+
* `extendsChain` / `readForSpec`.
|
|
112
|
+
*/
|
|
113
|
+
export const EXTENDS: string | null = null;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* Why this version is deprecated, or `null` while it is current. A
|
|
117
|
+
* superseded or retired version is still supported, and is withdrawn from
|
|
118
|
+
* this package in a later scheduled batch (SPEC "Superseded and Withdrawn
|
|
119
|
+
* Versions").
|
|
120
|
+
*/
|
|
121
|
+
export const DEPRECATION: string | null = null;
|
|
122
|
+
|
|
123
|
+
/** Stable alias for this specification's request payload shape. */
|
|
124
|
+
export type Payload = RoomsOwnerGroupRemovePayload;
|
|
125
|
+
|
|
126
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
127
|
+
export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/owner/group/remove/0.4#response" as const;
|
|
128
|
+
|
|
129
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
130
|
+
export type Response = RoomsOwnerGroupRemoveResponsePayload;
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* This specification's payload schema, as a value.
|
|
134
|
+
*
|
|
135
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
136
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
137
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
138
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
139
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
140
|
+
*/
|
|
141
|
+
export const PAYLOAD_SCHEMA = {
|
|
142
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
143
|
+
"$id": "https://trusttasks.org/spec/rooms/owner/group/remove/0.4",
|
|
144
|
+
"title": "Rooms Owner Group Remove — payload",
|
|
145
|
+
"description": "A room's owner asks their own agent to remove a member from a sealed room: on an attributed room withdraw every credential the room gave them, at its host at once, and on either sealed tier remove their leaf from the room's MLS group and advance its epoch. 0.4 removes a private room's member from the group, withdrawing nothing, where 0.2 and 0.3 refused.",
|
|
146
|
+
"type": "object",
|
|
147
|
+
"additionalProperties": false,
|
|
148
|
+
"required": [
|
|
149
|
+
"roomId",
|
|
150
|
+
"host",
|
|
151
|
+
"member"
|
|
152
|
+
],
|
|
153
|
+
"properties": {
|
|
154
|
+
"roomId": {
|
|
155
|
+
"type": "string",
|
|
156
|
+
"minLength": 1,
|
|
157
|
+
"maxLength": 512,
|
|
158
|
+
"description": "The room whose group loses a member. The recipient MUST hold its group and a signing key for it."
|
|
159
|
+
},
|
|
160
|
+
"host": {
|
|
161
|
+
"type": "string",
|
|
162
|
+
"pattern": "^did:",
|
|
163
|
+
"maxLength": 2048,
|
|
164
|
+
"description": "The room's host, as a DID: where the withdrawal, if any, is delivered first and the room's epoch advances."
|
|
165
|
+
},
|
|
166
|
+
"mirrors": {
|
|
167
|
+
"type": "array",
|
|
168
|
+
"maxItems": 7,
|
|
169
|
+
"uniqueItems": true,
|
|
170
|
+
"items": {
|
|
171
|
+
"type": "string",
|
|
172
|
+
"pattern": "^did:",
|
|
173
|
+
"maxLength": 2048
|
|
174
|
+
},
|
|
175
|
+
"description": "Any other host serving the room, as DIDs. On a room that is not private, each is delivered the withdrawal too: a host that does not hold it honours the member's credentials still. Unused on a private room."
|
|
176
|
+
},
|
|
177
|
+
"member": {
|
|
178
|
+
"type": "string",
|
|
179
|
+
"pattern": "^did:",
|
|
180
|
+
"maxLength": 2048,
|
|
181
|
+
"description": "The DID whose leaf is removed and, on a room that is not private, whose credentials the room withdraws. Never the recipient's own leaf."
|
|
182
|
+
},
|
|
183
|
+
"signingKeyId": {
|
|
184
|
+
"type": "string",
|
|
185
|
+
"minLength": 1,
|
|
186
|
+
"maxLength": 256,
|
|
187
|
+
"description": "Which held key signs the room's revocation list as the room, named explicitly as for rooms/owner/revoke. Required unless the room is private, whose removal signs nothing as the room: a request naming none for any other room is refused with noSigningKey."
|
|
188
|
+
},
|
|
189
|
+
"until": {
|
|
190
|
+
"type": "string",
|
|
191
|
+
"format": "date-time",
|
|
192
|
+
"description": "OPTIONAL. When the last credential the room issued `member` expires, after which the withdrawal can be dropped from the room's list. Unused on a private room."
|
|
193
|
+
},
|
|
194
|
+
"reason": {
|
|
195
|
+
"type": "string",
|
|
196
|
+
"minLength": 1,
|
|
197
|
+
"maxLength": 500,
|
|
198
|
+
"description": "Why, carried to the host's epoch advance. Untrusted and attributed to its author: it MUST NOT carry personal data or a credential. Never put into the revocation list."
|
|
199
|
+
},
|
|
200
|
+
"ext": {
|
|
201
|
+
"$ref": "#/$defs/Ext",
|
|
202
|
+
"description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
"$defs": {
|
|
206
|
+
"Response": {
|
|
207
|
+
"$anchor": "response",
|
|
208
|
+
"title": "Rooms Owner Group Remove — response payload",
|
|
209
|
+
"description": "Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.4#response. Whether the member was withdrawn at the host, the revocation list in force there when they were, and the room's new epoch, which the removed member holds no key for.",
|
|
210
|
+
"type": "object",
|
|
211
|
+
"additionalProperties": false,
|
|
212
|
+
"required": [
|
|
213
|
+
"roomId",
|
|
214
|
+
"member",
|
|
215
|
+
"withdrawn",
|
|
216
|
+
"epoch"
|
|
217
|
+
],
|
|
218
|
+
"properties": {
|
|
219
|
+
"roomId": {
|
|
220
|
+
"type": "string",
|
|
221
|
+
"minLength": 1,
|
|
222
|
+
"maxLength": 512,
|
|
223
|
+
"description": "The room."
|
|
224
|
+
},
|
|
225
|
+
"member": {
|
|
226
|
+
"type": "string",
|
|
227
|
+
"pattern": "^did:",
|
|
228
|
+
"maxLength": 2048,
|
|
229
|
+
"description": "Who was removed."
|
|
230
|
+
},
|
|
231
|
+
"withdrawn": {
|
|
232
|
+
"type": "boolean",
|
|
233
|
+
"description": "Whether the member's credentials were withdrawn at the host. True on an attributed room, with `revocation` and `revokedAt`; false on a private room, whose host cannot be told whom to refuse: the member's credentials stay valid there until they expire, and only a reset of every credential (rooms/owner/revoke, a `room` entry) withdraws them. A surface MUST NOT report false as a withdrawal."
|
|
234
|
+
},
|
|
235
|
+
"revocation": {
|
|
236
|
+
"$ref": "#/$defs/RevocationHead",
|
|
237
|
+
"description": "The revocation list carrying the withdrawal, as `host` accepted it. Present exactly when `withdrawn` is true."
|
|
238
|
+
},
|
|
239
|
+
"revokedAt": {
|
|
240
|
+
"type": "string",
|
|
241
|
+
"format": "date-time",
|
|
242
|
+
"description": "The withdrawal's `revokedAt`: credentials the room issued `member` before it are refused, and fresh ones issued after it are not. Present only when `withdrawn` is true."
|
|
243
|
+
},
|
|
244
|
+
"epoch": {
|
|
245
|
+
"type": "integer",
|
|
246
|
+
"minimum": 2,
|
|
247
|
+
"description": "The room epoch after the removal, as the host recorded it."
|
|
248
|
+
},
|
|
249
|
+
"mirrorsPending": {
|
|
250
|
+
"type": "array",
|
|
251
|
+
"maxItems": 7,
|
|
252
|
+
"items": {
|
|
253
|
+
"type": "string",
|
|
254
|
+
"pattern": "^did:",
|
|
255
|
+
"maxLength": 2048
|
|
256
|
+
},
|
|
257
|
+
"description": "Mirrors that did not confirm the withdrawal. Each still honours the member's credentials until the list is delivered — with rooms/owner/revoke and no `withdraw`. Absent when every mirror confirmed. Never present when `withdrawn` is false."
|
|
258
|
+
},
|
|
259
|
+
"ext": {
|
|
260
|
+
"$ref": "#/$defs/Ext"
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
},
|
|
264
|
+
"Ext": {
|
|
265
|
+
"title": "Ext",
|
|
266
|
+
"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.",
|
|
267
|
+
"type": "object",
|
|
268
|
+
"minProperties": 1,
|
|
269
|
+
"additionalProperties": true,
|
|
270
|
+
"propertyNames": {
|
|
271
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
272
|
+
}
|
|
273
|
+
},
|
|
274
|
+
"RevocationHead": {
|
|
275
|
+
"title": "RevocationHead",
|
|
276
|
+
"type": "object",
|
|
277
|
+
"additionalProperties": false,
|
|
278
|
+
"required": [
|
|
279
|
+
"sequence",
|
|
280
|
+
"digest"
|
|
281
|
+
],
|
|
282
|
+
"description": "Which `RevocationList` a party holds, without its entries: comparable between the room's key holder and a host, and between two hosts, without disclosing whom the room withdrew.",
|
|
283
|
+
"properties": {
|
|
284
|
+
"sequence": {
|
|
285
|
+
"type": "integer",
|
|
286
|
+
"minimum": 1,
|
|
287
|
+
"description": "The list's `sequence`."
|
|
288
|
+
},
|
|
289
|
+
"digest": {
|
|
290
|
+
"$ref": "#/$defs/DigestMultibase",
|
|
291
|
+
"description": "SHA-256 multihash of the list's RFC 8785 (JCS) canonicalization, `proof` included. Two parties holding one sequence with different digests have been given two lists the room signed at one sequence."
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
},
|
|
295
|
+
"DigestMultibase": {
|
|
296
|
+
"title": "DigestMultibase",
|
|
297
|
+
"description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
|
|
298
|
+
"type": "string",
|
|
299
|
+
"minLength": 16,
|
|
300
|
+
"pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
|
|
301
|
+
"examples": [
|
|
302
|
+
"zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
|
|
303
|
+
]
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
} as const;
|
|
307
|
+
|
|
308
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
309
|
+
export const RESPONSE_PAYLOAD_SCHEMA = {
|
|
310
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
311
|
+
"$ref": "#/$defs/Response",
|
|
312
|
+
"$defs": {
|
|
313
|
+
"Response": {
|
|
314
|
+
"$anchor": "response",
|
|
315
|
+
"title": "Rooms Owner Group Remove — response payload",
|
|
316
|
+
"description": "Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.4#response. Whether the member was withdrawn at the host, the revocation list in force there when they were, and the room's new epoch, which the removed member holds no key for.",
|
|
317
|
+
"type": "object",
|
|
318
|
+
"additionalProperties": false,
|
|
319
|
+
"required": [
|
|
320
|
+
"roomId",
|
|
321
|
+
"member",
|
|
322
|
+
"withdrawn",
|
|
323
|
+
"epoch"
|
|
324
|
+
],
|
|
325
|
+
"properties": {
|
|
326
|
+
"roomId": {
|
|
327
|
+
"type": "string",
|
|
328
|
+
"minLength": 1,
|
|
329
|
+
"maxLength": 512,
|
|
330
|
+
"description": "The room."
|
|
331
|
+
},
|
|
332
|
+
"member": {
|
|
333
|
+
"type": "string",
|
|
334
|
+
"pattern": "^did:",
|
|
335
|
+
"maxLength": 2048,
|
|
336
|
+
"description": "Who was removed."
|
|
337
|
+
},
|
|
338
|
+
"withdrawn": {
|
|
339
|
+
"type": "boolean",
|
|
340
|
+
"description": "Whether the member's credentials were withdrawn at the host. True on an attributed room, with `revocation` and `revokedAt`; false on a private room, whose host cannot be told whom to refuse: the member's credentials stay valid there until they expire, and only a reset of every credential (rooms/owner/revoke, a `room` entry) withdraws them. A surface MUST NOT report false as a withdrawal."
|
|
341
|
+
},
|
|
342
|
+
"revocation": {
|
|
343
|
+
"$ref": "#/$defs/RevocationHead",
|
|
344
|
+
"description": "The revocation list carrying the withdrawal, as `host` accepted it. Present exactly when `withdrawn` is true."
|
|
345
|
+
},
|
|
346
|
+
"revokedAt": {
|
|
347
|
+
"type": "string",
|
|
348
|
+
"format": "date-time",
|
|
349
|
+
"description": "The withdrawal's `revokedAt`: credentials the room issued `member` before it are refused, and fresh ones issued after it are not. Present only when `withdrawn` is true."
|
|
350
|
+
},
|
|
351
|
+
"epoch": {
|
|
352
|
+
"type": "integer",
|
|
353
|
+
"minimum": 2,
|
|
354
|
+
"description": "The room epoch after the removal, as the host recorded it."
|
|
355
|
+
},
|
|
356
|
+
"mirrorsPending": {
|
|
357
|
+
"type": "array",
|
|
358
|
+
"maxItems": 7,
|
|
359
|
+
"items": {
|
|
360
|
+
"type": "string",
|
|
361
|
+
"pattern": "^did:",
|
|
362
|
+
"maxLength": 2048
|
|
363
|
+
},
|
|
364
|
+
"description": "Mirrors that did not confirm the withdrawal. Each still honours the member's credentials until the list is delivered — with rooms/owner/revoke and no `withdraw`. Absent when every mirror confirmed. Never present when `withdrawn` is false."
|
|
365
|
+
},
|
|
366
|
+
"ext": {
|
|
367
|
+
"$ref": "#/$defs/Ext"
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
},
|
|
371
|
+
"Ext": {
|
|
372
|
+
"title": "Ext",
|
|
373
|
+
"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.",
|
|
374
|
+
"type": "object",
|
|
375
|
+
"minProperties": 1,
|
|
376
|
+
"additionalProperties": true,
|
|
377
|
+
"propertyNames": {
|
|
378
|
+
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"RevocationHead": {
|
|
382
|
+
"title": "RevocationHead",
|
|
383
|
+
"type": "object",
|
|
384
|
+
"additionalProperties": false,
|
|
385
|
+
"required": [
|
|
386
|
+
"sequence",
|
|
387
|
+
"digest"
|
|
388
|
+
],
|
|
389
|
+
"description": "Which `RevocationList` a party holds, without its entries: comparable between the room's key holder and a host, and between two hosts, without disclosing whom the room withdrew.",
|
|
390
|
+
"properties": {
|
|
391
|
+
"sequence": {
|
|
392
|
+
"type": "integer",
|
|
393
|
+
"minimum": 1,
|
|
394
|
+
"description": "The list's `sequence`."
|
|
395
|
+
},
|
|
396
|
+
"digest": {
|
|
397
|
+
"$ref": "#/$defs/DigestMultibase",
|
|
398
|
+
"description": "SHA-256 multihash of the list's RFC 8785 (JCS) canonicalization, `proof` included. Two parties holding one sequence with different digests have been given two lists the room signed at one sequence."
|
|
399
|
+
}
|
|
400
|
+
}
|
|
401
|
+
},
|
|
402
|
+
"DigestMultibase": {
|
|
403
|
+
"title": "DigestMultibase",
|
|
404
|
+
"description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
|
|
405
|
+
"type": "string",
|
|
406
|
+
"minLength": 16,
|
|
407
|
+
"pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
|
|
408
|
+
"examples": [
|
|
409
|
+
"zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
|
|
410
|
+
]
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
} as const;
|
|
414
|
+
|
|
415
|
+
/**
|
|
416
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
417
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
418
|
+
* per-specification and cannot be derived from the document alone, and
|
|
419
|
+
* item 2 needs the schema this carries.
|
|
420
|
+
*/
|
|
421
|
+
export const SPEC = {
|
|
422
|
+
typeUri: TYPE_URI,
|
|
423
|
+
isBearer: false,
|
|
424
|
+
isProofRequired: true,
|
|
425
|
+
isRecipientRequired: true,
|
|
426
|
+
isIssuedAtRequired: true,
|
|
427
|
+
payloadSchema: PAYLOAD_SCHEMA,
|
|
428
|
+
} as const;
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
432
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
433
|
+
* parties (§7.3 item 5).
|
|
434
|
+
*/
|
|
435
|
+
export const RESPONSE_SPEC = {
|
|
436
|
+
typeUri: RESPONSE_TYPE_URI,
|
|
437
|
+
isBearer: false,
|
|
438
|
+
isProofRequired: true,
|
|
439
|
+
isRecipientRequired: true,
|
|
440
|
+
isIssuedAtRequired: true,
|
|
441
|
+
payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
|
|
442
|
+
} as const;
|