@freedome/protocol 1.0.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 +13 -0
- package/dist/index.cjs +186 -8
- package/dist/index.d.cts +2754 -158
- package/dist/index.d.ts +2754 -158
- package/dist/index.js +186 -8
- package/dist/validate.cjs +4590 -0
- package/dist/validate.js +4590 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
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
|
+
|
|
9
|
+
## 1.1.0 (2026-11-07)
|
|
10
|
+
|
|
11
|
+
- Types and tables generated from `freedome_contract` 1.1.0 (`api/1.1`), additive: `pauseAudioSession`, `resumeAudioSession`,
|
|
12
|
+
`startAudioDeviceSweep`, `roleZones`, the generator's `multi`, the calibration job's `sweep`.
|
|
13
|
+
- `ProtocolVersions.audioControl`: the first contract with them.
|
|
14
|
+
- `/validate` knows `api/1.1`; `api/1.0` stays, for the cloud schemas and documents that name it.
|
|
15
|
+
|
|
3
16
|
## 1.0.0 (2026-11-06)
|
|
4
17
|
|
|
5
18
|
- Types and tables generated from `freedome_contract` 1.0.0.
|
package/dist/index.cjs
CHANGED
|
@@ -160,6 +160,19 @@ var ProtocolVersions = {
|
|
|
160
160
|
domeFormat: new SemVer(1, 1, 0),
|
|
161
161
|
/** API majors understood (`/api/v1`). */
|
|
162
162
|
apiMajors: [1],
|
|
163
|
+
/**
|
|
164
|
+
* First contract version with pause / resume of audio sessions, the device sweep, `roleZones` and the generator's
|
|
165
|
+
* `multi` block. A server reports its own in `contractVersion` of `getInfo`; a 1.0 server answers 404, or 422 for the
|
|
166
|
+
* new members.
|
|
167
|
+
*/
|
|
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),
|
|
163
176
|
/** Whether a `.dome` of [v] can be read (same major; newer minors keep unknown keys). */
|
|
164
177
|
canReadDome: (v) => v.major === 1
|
|
165
178
|
};
|
|
@@ -257,9 +270,9 @@ var DomeTopics = {
|
|
|
257
270
|
|
|
258
271
|
// src/generated/contract.ts
|
|
259
272
|
var CONTRACT = {
|
|
260
|
-
label: "v1.
|
|
261
|
-
bundle: "freedome-contract-1.
|
|
262
|
-
sha256: "
|
|
273
|
+
label: "v1.2.0",
|
|
274
|
+
bundle: "freedome-contract-1.2.0.tar.gz",
|
|
275
|
+
sha256: "27a9c4aa46a82485459269ebeb973c8a86e746c3e4f20d4aefe9c56291a4549d"
|
|
263
276
|
};
|
|
264
277
|
|
|
265
278
|
// src/generated/mediaserver-operations.ts
|
|
@@ -303,6 +316,15 @@ var Operations = {
|
|
|
303
316
|
],
|
|
304
317
|
requestContentTypes: []
|
|
305
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
|
+
},
|
|
306
328
|
approvePairing: {
|
|
307
329
|
id: "approvePairing",
|
|
308
330
|
method: "POST",
|
|
@@ -664,6 +686,15 @@ var Operations = {
|
|
|
664
686
|
],
|
|
665
687
|
requestContentTypes: []
|
|
666
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
|
+
},
|
|
667
698
|
exchangeCloudToken: {
|
|
668
699
|
id: "exchangeCloudToken",
|
|
669
700
|
method: "POST",
|
|
@@ -750,6 +781,15 @@ var Operations = {
|
|
|
750
781
|
],
|
|
751
782
|
requestContentTypes: []
|
|
752
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
|
+
},
|
|
753
793
|
getAudio: {
|
|
754
794
|
id: "getAudio",
|
|
755
795
|
method: "GET",
|
|
@@ -1290,6 +1330,18 @@ var Operations = {
|
|
|
1290
1330
|
],
|
|
1291
1331
|
requestContentTypes: []
|
|
1292
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
|
+
},
|
|
1293
1345
|
listAudioDevices: {
|
|
1294
1346
|
id: "listAudioDevices",
|
|
1295
1347
|
method: "GET",
|
|
@@ -1760,6 +1812,19 @@ var Operations = {
|
|
|
1760
1812
|
],
|
|
1761
1813
|
requestContentTypes: []
|
|
1762
1814
|
},
|
|
1815
|
+
pauseAudioSession: {
|
|
1816
|
+
id: "pauseAudioSession",
|
|
1817
|
+
method: "POST",
|
|
1818
|
+
path: "/venues/{venueId}/audio/sessions/{sessionId}/pause",
|
|
1819
|
+
scope: "audio:control",
|
|
1820
|
+
tags: ["audio"],
|
|
1821
|
+
params: [
|
|
1822
|
+
{ name: "venueId", in: "path", required: true },
|
|
1823
|
+
{ name: "sessionId", in: "path", required: true },
|
|
1824
|
+
{ name: "Idempotency-Key", in: "header", required: false }
|
|
1825
|
+
],
|
|
1826
|
+
requestContentTypes: []
|
|
1827
|
+
},
|
|
1763
1828
|
pauseScenarioSession: {
|
|
1764
1829
|
id: "pauseScenarioSession",
|
|
1765
1830
|
method: "POST",
|
|
@@ -2008,6 +2073,15 @@ var Operations = {
|
|
|
2008
2073
|
params: [],
|
|
2009
2074
|
requestContentTypes: ["application/json"]
|
|
2010
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
|
+
},
|
|
2011
2085
|
registerClient: {
|
|
2012
2086
|
id: "registerClient",
|
|
2013
2087
|
method: "POST",
|
|
@@ -2051,6 +2125,19 @@ var Operations = {
|
|
|
2051
2125
|
],
|
|
2052
2126
|
requestContentTypes: []
|
|
2053
2127
|
},
|
|
2128
|
+
resumeAudioSession: {
|
|
2129
|
+
id: "resumeAudioSession",
|
|
2130
|
+
method: "POST",
|
|
2131
|
+
path: "/venues/{venueId}/audio/sessions/{sessionId}/resume",
|
|
2132
|
+
scope: "audio:control",
|
|
2133
|
+
tags: ["audio"],
|
|
2134
|
+
params: [
|
|
2135
|
+
{ name: "venueId", in: "path", required: true },
|
|
2136
|
+
{ name: "sessionId", in: "path", required: true },
|
|
2137
|
+
{ name: "Idempotency-Key", in: "header", required: false }
|
|
2138
|
+
],
|
|
2139
|
+
requestContentTypes: []
|
|
2140
|
+
},
|
|
2054
2141
|
resumeScenarioSession: {
|
|
2055
2142
|
id: "resumeScenarioSession",
|
|
2056
2143
|
method: "POST",
|
|
@@ -2189,6 +2276,19 @@ var Operations = {
|
|
|
2189
2276
|
params: [{ name: "Idempotency-Key", in: "header", required: false }],
|
|
2190
2277
|
requestContentTypes: ["application/json"]
|
|
2191
2278
|
},
|
|
2279
|
+
startAudioDeviceSweep: {
|
|
2280
|
+
id: "startAudioDeviceSweep",
|
|
2281
|
+
method: "POST",
|
|
2282
|
+
path: "/venues/{venueId}/audio/devices/{deviceId}/sweep",
|
|
2283
|
+
scope: "audio:calibrate",
|
|
2284
|
+
tags: ["audio"],
|
|
2285
|
+
params: [
|
|
2286
|
+
{ name: "venueId", in: "path", required: true },
|
|
2287
|
+
{ name: "deviceId", in: "path", required: true },
|
|
2288
|
+
{ name: "Idempotency-Key", in: "header", required: false }
|
|
2289
|
+
],
|
|
2290
|
+
requestContentTypes: ["application/json"]
|
|
2291
|
+
},
|
|
2192
2292
|
startAudioSession: {
|
|
2193
2293
|
id: "startAudioSession",
|
|
2194
2294
|
method: "POST",
|
|
@@ -2392,6 +2492,24 @@ var CloudOperations = {
|
|
|
2392
2492
|
params: [],
|
|
2393
2493
|
requestContentTypes: ["application/json"]
|
|
2394
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
|
+
},
|
|
2395
2513
|
createAccountApiKey: {
|
|
2396
2514
|
id: "createAccountApiKey",
|
|
2397
2515
|
method: "POST",
|
|
@@ -2516,6 +2634,27 @@ var CloudOperations = {
|
|
|
2516
2634
|
params: [{ name: "sessionId", in: "path", required: true }],
|
|
2517
2635
|
requestContentTypes: []
|
|
2518
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
|
+
},
|
|
2519
2658
|
deleteOrg: {
|
|
2520
2659
|
id: "deleteOrg",
|
|
2521
2660
|
method: "DELETE",
|
|
@@ -2591,6 +2730,15 @@ var CloudOperations = {
|
|
|
2591
2730
|
params: [],
|
|
2592
2731
|
requestContentTypes: ["application/json"]
|
|
2593
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
|
+
},
|
|
2594
2742
|
forgotPassword: {
|
|
2595
2743
|
id: "forgotPassword",
|
|
2596
2744
|
method: "POST",
|
|
@@ -2618,6 +2766,27 @@ var CloudOperations = {
|
|
|
2618
2766
|
params: [{ name: "itemId", in: "path", required: true }],
|
|
2619
2767
|
requestContentTypes: []
|
|
2620
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
|
+
},
|
|
2621
2790
|
getEnrollmentRequest: {
|
|
2622
2791
|
id: "getEnrollmentRequest",
|
|
2623
2792
|
method: "GET",
|
|
@@ -3038,6 +3207,15 @@ var CloudOperations = {
|
|
|
3038
3207
|
params: [],
|
|
3039
3208
|
requestContentTypes: ["application/json"]
|
|
3040
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
|
+
},
|
|
3041
3219
|
verifyEmail: {
|
|
3042
3220
|
id: "verifyEmail",
|
|
3043
3221
|
method: "POST",
|
|
@@ -3382,7 +3560,7 @@ var Scopes = {
|
|
|
3382
3560
|
"audio:control": "audio mode / gain / zones / devices / sessions / generator / sources",
|
|
3383
3561
|
"displays:control": "test patterns, identify, power",
|
|
3384
3562
|
"calibration:run": "visual calibration jobs and sidecars",
|
|
3385
|
-
"audio:calibrate": "audio calibration jobs (audio-room, audio-speaker-check)",
|
|
3563
|
+
"audio:calibrate": "audio calibration jobs (audio-room, audio-speaker-check) and device sweeps",
|
|
3386
3564
|
"venues:write": "venues, displays config, speaker layout, device pairing / binding",
|
|
3387
3565
|
"gateways:manage": "gateways, OSC send",
|
|
3388
3566
|
"system:read": "system status, logs, config (redacted), diagnostics, clients, jobs of others",
|
|
@@ -3476,13 +3654,13 @@ var ProblemCodes = [
|
|
|
3476
3654
|
// src/generated/asyncapi.ts
|
|
3477
3655
|
var AsyncApiCatalogue = {
|
|
3478
3656
|
"cloud-socketio": {
|
|
3479
|
-
version: "1.
|
|
3657
|
+
version: "1.2.0",
|
|
3480
3658
|
messages: ["event", "join"],
|
|
3481
3659
|
channels: ["v1"],
|
|
3482
3660
|
operations: ["emitJoin", "receiveEvent"]
|
|
3483
3661
|
},
|
|
3484
3662
|
"socketio-legacy": {
|
|
3485
|
-
version: "1.
|
|
3663
|
+
version: "1.2.0",
|
|
3486
3664
|
messages: [
|
|
3487
3665
|
"brightness",
|
|
3488
3666
|
"clear-integration",
|
|
@@ -3516,7 +3694,7 @@ var AsyncApiCatalogue = {
|
|
|
3516
3694
|
]
|
|
3517
3695
|
},
|
|
3518
3696
|
socketio: {
|
|
3519
|
-
version: "1.
|
|
3697
|
+
version: "1.2.0",
|
|
3520
3698
|
messages: ["ack", "bye", "call", "event", "resync", "subscribe", "unsubscribe", "welcome"],
|
|
3521
3699
|
channels: ["v1"],
|
|
3522
3700
|
operations: [
|
|
@@ -3530,7 +3708,7 @@ var AsyncApiCatalogue = {
|
|
|
3530
3708
|
]
|
|
3531
3709
|
},
|
|
3532
3710
|
ws: {
|
|
3533
|
-
version: "1.
|
|
3711
|
+
version: "1.2.0",
|
|
3534
3712
|
messages: [
|
|
3535
3713
|
"bye",
|
|
3536
3714
|
"call",
|