@freedome/protocol 1.1.0 → 1.2.0
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 +6 -0
- package/dist/index.cjs +140 -7
- package/dist/index.d.cts +2209 -112
- package/dist/index.d.ts +2209 -112
- package/dist/index.js +140 -7
- package/dist/validate.cjs +526 -0
- package/dist/validate.js +526 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.2.0 (2026-11-17)
|
|
4
|
+
|
|
5
|
+
- `ProtocolVersions.contract` (1.2.0): the freedome_contract release this package implements; `ProtocolVersions.assistant`
|
|
6
|
+
(1.2.0): the first contract with the assistant operations below.
|
|
7
|
+
- Types and tables generated from `freedome_contract` 1.2.0, additive: `listAssistantConfirmations`, `refuseAssistantConfirmation`, `getAssistantLink`, `approveAssistantLink`, `endAssistantLink`, with `AssistantConfirmation`, `AssistantLink`, `AssistantLinkSession`.
|
|
8
|
+
|
|
3
9
|
## 1.1.0 (2026-11-07)
|
|
4
10
|
|
|
5
11
|
- Types and tables generated from `freedome_contract` 1.1.0 (`api/1.1`), additive: `pauseAudioSession`, `resumeAudioSession`,
|
package/dist/index.cjs
CHANGED
|
@@ -166,6 +166,13 @@ var ProtocolVersions = {
|
|
|
166
166
|
* new members.
|
|
167
167
|
*/
|
|
168
168
|
audioControl: new SemVer(1, 1, 0),
|
|
169
|
+
/** First contract with the person's side of the assistant (confirmations, the link). An older server answers 404. */
|
|
170
|
+
assistant: new SemVer(1, 2, 0),
|
|
171
|
+
/**
|
|
172
|
+
* The freedome_contract release this package was generated from and implements (`contract/contract.lock.json`).
|
|
173
|
+
* Compare it with a server's `contractVersion` to tell which side is newer, e.g. for an About screen. Added in 1.2.0.
|
|
174
|
+
*/
|
|
175
|
+
contract: new SemVer(1, 2, 0),
|
|
169
176
|
/** Whether a `.dome` of [v] can be read (same major; newer minors keep unknown keys). */
|
|
170
177
|
canReadDome: (v) => v.major === 1
|
|
171
178
|
};
|
|
@@ -263,9 +270,9 @@ var DomeTopics = {
|
|
|
263
270
|
|
|
264
271
|
// src/generated/contract.ts
|
|
265
272
|
var CONTRACT = {
|
|
266
|
-
label: "v1.
|
|
267
|
-
bundle: "freedome-contract-1.
|
|
268
|
-
sha256: "
|
|
273
|
+
label: "v1.2.0",
|
|
274
|
+
bundle: "freedome-contract-1.2.0.tar.gz",
|
|
275
|
+
sha256: "27a9c4aa46a82485459269ebeb973c8a86e746c3e4f20d4aefe9c56291a4549d"
|
|
269
276
|
};
|
|
270
277
|
|
|
271
278
|
// src/generated/mediaserver-operations.ts
|
|
@@ -309,6 +316,15 @@ var Operations = {
|
|
|
309
316
|
],
|
|
310
317
|
requestContentTypes: []
|
|
311
318
|
},
|
|
319
|
+
approveAssistantLink: {
|
|
320
|
+
id: "approveAssistantLink",
|
|
321
|
+
method: "POST",
|
|
322
|
+
path: "/assistant/link/approvals",
|
|
323
|
+
scope: "playback:control",
|
|
324
|
+
tags: ["assistant"],
|
|
325
|
+
params: [],
|
|
326
|
+
requestContentTypes: ["application/json"]
|
|
327
|
+
},
|
|
312
328
|
approvePairing: {
|
|
313
329
|
id: "approvePairing",
|
|
314
330
|
method: "POST",
|
|
@@ -670,6 +686,15 @@ var Operations = {
|
|
|
670
686
|
],
|
|
671
687
|
requestContentTypes: []
|
|
672
688
|
},
|
|
689
|
+
endAssistantLink: {
|
|
690
|
+
id: "endAssistantLink",
|
|
691
|
+
method: "DELETE",
|
|
692
|
+
path: "/assistant/link/sessions/{sessionId}",
|
|
693
|
+
scope: "playback:control",
|
|
694
|
+
tags: ["assistant"],
|
|
695
|
+
params: [{ name: "sessionId", in: "path", required: true }],
|
|
696
|
+
requestContentTypes: []
|
|
697
|
+
},
|
|
673
698
|
exchangeCloudToken: {
|
|
674
699
|
id: "exchangeCloudToken",
|
|
675
700
|
method: "POST",
|
|
@@ -756,6 +781,15 @@ var Operations = {
|
|
|
756
781
|
],
|
|
757
782
|
requestContentTypes: []
|
|
758
783
|
},
|
|
784
|
+
getAssistantLink: {
|
|
785
|
+
id: "getAssistantLink",
|
|
786
|
+
method: "GET",
|
|
787
|
+
path: "/assistant/link",
|
|
788
|
+
scope: "playback:control",
|
|
789
|
+
tags: ["assistant"],
|
|
790
|
+
params: [],
|
|
791
|
+
requestContentTypes: []
|
|
792
|
+
},
|
|
759
793
|
getAudio: {
|
|
760
794
|
id: "getAudio",
|
|
761
795
|
method: "GET",
|
|
@@ -1296,6 +1330,18 @@ var Operations = {
|
|
|
1296
1330
|
],
|
|
1297
1331
|
requestContentTypes: []
|
|
1298
1332
|
},
|
|
1333
|
+
listAssistantConfirmations: {
|
|
1334
|
+
id: "listAssistantConfirmations",
|
|
1335
|
+
method: "GET",
|
|
1336
|
+
path: "/assistant/confirmations",
|
|
1337
|
+
scope: "playback:control",
|
|
1338
|
+
tags: ["assistant"],
|
|
1339
|
+
params: [
|
|
1340
|
+
{ name: "limit", in: "query", required: false },
|
|
1341
|
+
{ name: "cursor", in: "query", required: false }
|
|
1342
|
+
],
|
|
1343
|
+
requestContentTypes: []
|
|
1344
|
+
},
|
|
1299
1345
|
listAudioDevices: {
|
|
1300
1346
|
id: "listAudioDevices",
|
|
1301
1347
|
method: "GET",
|
|
@@ -2027,6 +2073,15 @@ var Operations = {
|
|
|
2027
2073
|
params: [],
|
|
2028
2074
|
requestContentTypes: ["application/json"]
|
|
2029
2075
|
},
|
|
2076
|
+
refuseAssistantConfirmation: {
|
|
2077
|
+
id: "refuseAssistantConfirmation",
|
|
2078
|
+
method: "POST",
|
|
2079
|
+
path: "/assistant/confirmations/{confirmationId}/refuse",
|
|
2080
|
+
scope: "playback:control",
|
|
2081
|
+
tags: ["assistant"],
|
|
2082
|
+
params: [{ name: "confirmationId", in: "path", required: true }],
|
|
2083
|
+
requestContentTypes: []
|
|
2084
|
+
},
|
|
2030
2085
|
registerClient: {
|
|
2031
2086
|
id: "registerClient",
|
|
2032
2087
|
method: "POST",
|
|
@@ -2437,6 +2492,24 @@ var CloudOperations = {
|
|
|
2437
2492
|
params: [],
|
|
2438
2493
|
requestContentTypes: ["application/json"]
|
|
2439
2494
|
},
|
|
2495
|
+
claimDossier: {
|
|
2496
|
+
id: "claimDossier",
|
|
2497
|
+
method: "POST",
|
|
2498
|
+
path: "/dossiers/self/claim",
|
|
2499
|
+
scope: "any",
|
|
2500
|
+
tags: ["dossier"],
|
|
2501
|
+
params: [{ name: "X-Dossier-Code", in: "header", required: true }],
|
|
2502
|
+
requestContentTypes: []
|
|
2503
|
+
},
|
|
2504
|
+
consentDossier: {
|
|
2505
|
+
id: "consentDossier",
|
|
2506
|
+
method: "POST",
|
|
2507
|
+
path: "/dossiers/self/consent",
|
|
2508
|
+
scope: "anon",
|
|
2509
|
+
tags: ["dossier"],
|
|
2510
|
+
params: [{ name: "X-Dossier-Code", in: "header", required: true }],
|
|
2511
|
+
requestContentTypes: ["application/json"]
|
|
2512
|
+
},
|
|
2440
2513
|
createAccountApiKey: {
|
|
2441
2514
|
id: "createAccountApiKey",
|
|
2442
2515
|
method: "POST",
|
|
@@ -2561,6 +2634,27 @@ var CloudOperations = {
|
|
|
2561
2634
|
params: [{ name: "sessionId", in: "path", required: true }],
|
|
2562
2635
|
requestContentTypes: []
|
|
2563
2636
|
},
|
|
2637
|
+
deleteDossierAttachment: {
|
|
2638
|
+
id: "deleteDossierAttachment",
|
|
2639
|
+
method: "DELETE",
|
|
2640
|
+
path: "/dossiers/self/attachments/{attachmentId}",
|
|
2641
|
+
scope: "anon",
|
|
2642
|
+
tags: ["dossier"],
|
|
2643
|
+
params: [
|
|
2644
|
+
{ name: "attachmentId", in: "path", required: true },
|
|
2645
|
+
{ name: "X-Dossier-Code", in: "header", required: true }
|
|
2646
|
+
],
|
|
2647
|
+
requestContentTypes: []
|
|
2648
|
+
},
|
|
2649
|
+
deleteDossierSelf: {
|
|
2650
|
+
id: "deleteDossierSelf",
|
|
2651
|
+
method: "DELETE",
|
|
2652
|
+
path: "/dossiers/self",
|
|
2653
|
+
scope: "anon",
|
|
2654
|
+
tags: ["dossier"],
|
|
2655
|
+
params: [{ name: "X-Dossier-Code", in: "header", required: true }],
|
|
2656
|
+
requestContentTypes: []
|
|
2657
|
+
},
|
|
2564
2658
|
deleteOrg: {
|
|
2565
2659
|
id: "deleteOrg",
|
|
2566
2660
|
method: "DELETE",
|
|
@@ -2636,6 +2730,15 @@ var CloudOperations = {
|
|
|
2636
2730
|
params: [],
|
|
2637
2731
|
requestContentTypes: ["application/json"]
|
|
2638
2732
|
},
|
|
2733
|
+
exportDossierSelf: {
|
|
2734
|
+
id: "exportDossierSelf",
|
|
2735
|
+
method: "GET",
|
|
2736
|
+
path: "/dossiers/self/export",
|
|
2737
|
+
scope: "anon",
|
|
2738
|
+
tags: ["dossier"],
|
|
2739
|
+
params: [{ name: "X-Dossier-Code", in: "header", required: true }],
|
|
2740
|
+
requestContentTypes: []
|
|
2741
|
+
},
|
|
2639
2742
|
forgotPassword: {
|
|
2640
2743
|
id: "forgotPassword",
|
|
2641
2744
|
method: "POST",
|
|
@@ -2663,6 +2766,27 @@ var CloudOperations = {
|
|
|
2663
2766
|
params: [{ name: "itemId", in: "path", required: true }],
|
|
2664
2767
|
requestContentTypes: []
|
|
2665
2768
|
},
|
|
2769
|
+
getDossierAttachment: {
|
|
2770
|
+
id: "getDossierAttachment",
|
|
2771
|
+
method: "GET",
|
|
2772
|
+
path: "/dossiers/self/attachments/{attachmentId}",
|
|
2773
|
+
scope: "anon",
|
|
2774
|
+
tags: ["dossier"],
|
|
2775
|
+
params: [
|
|
2776
|
+
{ name: "attachmentId", in: "path", required: true },
|
|
2777
|
+
{ name: "X-Dossier-Code", in: "header", required: true }
|
|
2778
|
+
],
|
|
2779
|
+
requestContentTypes: []
|
|
2780
|
+
},
|
|
2781
|
+
getDossierSelf: {
|
|
2782
|
+
id: "getDossierSelf",
|
|
2783
|
+
method: "GET",
|
|
2784
|
+
path: "/dossiers/self",
|
|
2785
|
+
scope: "anon",
|
|
2786
|
+
tags: ["dossier"],
|
|
2787
|
+
params: [{ name: "X-Dossier-Code", in: "header", required: true }],
|
|
2788
|
+
requestContentTypes: []
|
|
2789
|
+
},
|
|
2666
2790
|
getEnrollmentRequest: {
|
|
2667
2791
|
id: "getEnrollmentRequest",
|
|
2668
2792
|
method: "GET",
|
|
@@ -3083,6 +3207,15 @@ var CloudOperations = {
|
|
|
3083
3207
|
params: [],
|
|
3084
3208
|
requestContentTypes: ["application/json"]
|
|
3085
3209
|
},
|
|
3210
|
+
uploadDossierAttachment: {
|
|
3211
|
+
id: "uploadDossierAttachment",
|
|
3212
|
+
method: "POST",
|
|
3213
|
+
path: "/dossiers/self/attachments",
|
|
3214
|
+
scope: "anon",
|
|
3215
|
+
tags: ["dossier"],
|
|
3216
|
+
params: [{ name: "X-Dossier-Code", in: "header", required: true }],
|
|
3217
|
+
requestContentTypes: ["multipart/form-data"]
|
|
3218
|
+
},
|
|
3086
3219
|
verifyEmail: {
|
|
3087
3220
|
id: "verifyEmail",
|
|
3088
3221
|
method: "POST",
|
|
@@ -3521,13 +3654,13 @@ var ProblemCodes = [
|
|
|
3521
3654
|
// src/generated/asyncapi.ts
|
|
3522
3655
|
var AsyncApiCatalogue = {
|
|
3523
3656
|
"cloud-socketio": {
|
|
3524
|
-
version: "1.
|
|
3657
|
+
version: "1.2.0",
|
|
3525
3658
|
messages: ["event", "join"],
|
|
3526
3659
|
channels: ["v1"],
|
|
3527
3660
|
operations: ["emitJoin", "receiveEvent"]
|
|
3528
3661
|
},
|
|
3529
3662
|
"socketio-legacy": {
|
|
3530
|
-
version: "1.
|
|
3663
|
+
version: "1.2.0",
|
|
3531
3664
|
messages: [
|
|
3532
3665
|
"brightness",
|
|
3533
3666
|
"clear-integration",
|
|
@@ -3561,7 +3694,7 @@ var AsyncApiCatalogue = {
|
|
|
3561
3694
|
]
|
|
3562
3695
|
},
|
|
3563
3696
|
socketio: {
|
|
3564
|
-
version: "1.
|
|
3697
|
+
version: "1.2.0",
|
|
3565
3698
|
messages: ["ack", "bye", "call", "event", "resync", "subscribe", "unsubscribe", "welcome"],
|
|
3566
3699
|
channels: ["v1"],
|
|
3567
3700
|
operations: [
|
|
@@ -3575,7 +3708,7 @@ var AsyncApiCatalogue = {
|
|
|
3575
3708
|
]
|
|
3576
3709
|
},
|
|
3577
3710
|
ws: {
|
|
3578
|
-
version: "1.
|
|
3711
|
+
version: "1.2.0",
|
|
3579
3712
|
messages: [
|
|
3580
3713
|
"bye",
|
|
3581
3714
|
"call",
|