@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/dist/index.js CHANGED
@@ -108,6 +108,19 @@ var ProtocolVersions = {
108
108
  domeFormat: new SemVer(1, 1, 0),
109
109
  /** API majors understood (`/api/v1`). */
110
110
  apiMajors: [1],
111
+ /**
112
+ * First contract version with pause / resume of audio sessions, the device sweep, `roleZones` and the generator's
113
+ * `multi` block. A server reports its own in `contractVersion` of `getInfo`; a 1.0 server answers 404, or 422 for the
114
+ * new members.
115
+ */
116
+ audioControl: new SemVer(1, 1, 0),
117
+ /** First contract with the person's side of the assistant (confirmations, the link). An older server answers 404. */
118
+ assistant: new SemVer(1, 2, 0),
119
+ /**
120
+ * The freedome_contract release this package was generated from and implements (`contract/contract.lock.json`).
121
+ * Compare it with a server's `contractVersion` to tell which side is newer, e.g. for an About screen. Added in 1.2.0.
122
+ */
123
+ contract: new SemVer(1, 2, 0),
111
124
  /** Whether a `.dome` of [v] can be read (same major; newer minors keep unknown keys). */
112
125
  canReadDome: (v) => v.major === 1
113
126
  };
@@ -205,9 +218,9 @@ var DomeTopics = {
205
218
 
206
219
  // src/generated/contract.ts
207
220
  var CONTRACT = {
208
- label: "v1.0.0",
209
- bundle: "freedome-contract-1.0.0.tar.gz",
210
- sha256: "7cd2668450d65266521fa7285f74846271d1dca1695418543490bc8db491d225"
221
+ label: "v1.2.0",
222
+ bundle: "freedome-contract-1.2.0.tar.gz",
223
+ sha256: "27a9c4aa46a82485459269ebeb973c8a86e746c3e4f20d4aefe9c56291a4549d"
211
224
  };
212
225
 
213
226
  // src/generated/mediaserver-operations.ts
@@ -251,6 +264,15 @@ var Operations = {
251
264
  ],
252
265
  requestContentTypes: []
253
266
  },
267
+ approveAssistantLink: {
268
+ id: "approveAssistantLink",
269
+ method: "POST",
270
+ path: "/assistant/link/approvals",
271
+ scope: "playback:control",
272
+ tags: ["assistant"],
273
+ params: [],
274
+ requestContentTypes: ["application/json"]
275
+ },
254
276
  approvePairing: {
255
277
  id: "approvePairing",
256
278
  method: "POST",
@@ -612,6 +634,15 @@ var Operations = {
612
634
  ],
613
635
  requestContentTypes: []
614
636
  },
637
+ endAssistantLink: {
638
+ id: "endAssistantLink",
639
+ method: "DELETE",
640
+ path: "/assistant/link/sessions/{sessionId}",
641
+ scope: "playback:control",
642
+ tags: ["assistant"],
643
+ params: [{ name: "sessionId", in: "path", required: true }],
644
+ requestContentTypes: []
645
+ },
615
646
  exchangeCloudToken: {
616
647
  id: "exchangeCloudToken",
617
648
  method: "POST",
@@ -698,6 +729,15 @@ var Operations = {
698
729
  ],
699
730
  requestContentTypes: []
700
731
  },
732
+ getAssistantLink: {
733
+ id: "getAssistantLink",
734
+ method: "GET",
735
+ path: "/assistant/link",
736
+ scope: "playback:control",
737
+ tags: ["assistant"],
738
+ params: [],
739
+ requestContentTypes: []
740
+ },
701
741
  getAudio: {
702
742
  id: "getAudio",
703
743
  method: "GET",
@@ -1238,6 +1278,18 @@ var Operations = {
1238
1278
  ],
1239
1279
  requestContentTypes: []
1240
1280
  },
1281
+ listAssistantConfirmations: {
1282
+ id: "listAssistantConfirmations",
1283
+ method: "GET",
1284
+ path: "/assistant/confirmations",
1285
+ scope: "playback:control",
1286
+ tags: ["assistant"],
1287
+ params: [
1288
+ { name: "limit", in: "query", required: false },
1289
+ { name: "cursor", in: "query", required: false }
1290
+ ],
1291
+ requestContentTypes: []
1292
+ },
1241
1293
  listAudioDevices: {
1242
1294
  id: "listAudioDevices",
1243
1295
  method: "GET",
@@ -1708,6 +1760,19 @@ var Operations = {
1708
1760
  ],
1709
1761
  requestContentTypes: []
1710
1762
  },
1763
+ pauseAudioSession: {
1764
+ id: "pauseAudioSession",
1765
+ method: "POST",
1766
+ path: "/venues/{venueId}/audio/sessions/{sessionId}/pause",
1767
+ scope: "audio:control",
1768
+ tags: ["audio"],
1769
+ params: [
1770
+ { name: "venueId", in: "path", required: true },
1771
+ { name: "sessionId", in: "path", required: true },
1772
+ { name: "Idempotency-Key", in: "header", required: false }
1773
+ ],
1774
+ requestContentTypes: []
1775
+ },
1711
1776
  pauseScenarioSession: {
1712
1777
  id: "pauseScenarioSession",
1713
1778
  method: "POST",
@@ -1956,6 +2021,15 @@ var Operations = {
1956
2021
  params: [],
1957
2022
  requestContentTypes: ["application/json"]
1958
2023
  },
2024
+ refuseAssistantConfirmation: {
2025
+ id: "refuseAssistantConfirmation",
2026
+ method: "POST",
2027
+ path: "/assistant/confirmations/{confirmationId}/refuse",
2028
+ scope: "playback:control",
2029
+ tags: ["assistant"],
2030
+ params: [{ name: "confirmationId", in: "path", required: true }],
2031
+ requestContentTypes: []
2032
+ },
1959
2033
  registerClient: {
1960
2034
  id: "registerClient",
1961
2035
  method: "POST",
@@ -1999,6 +2073,19 @@ var Operations = {
1999
2073
  ],
2000
2074
  requestContentTypes: []
2001
2075
  },
2076
+ resumeAudioSession: {
2077
+ id: "resumeAudioSession",
2078
+ method: "POST",
2079
+ path: "/venues/{venueId}/audio/sessions/{sessionId}/resume",
2080
+ scope: "audio:control",
2081
+ tags: ["audio"],
2082
+ params: [
2083
+ { name: "venueId", in: "path", required: true },
2084
+ { name: "sessionId", in: "path", required: true },
2085
+ { name: "Idempotency-Key", in: "header", required: false }
2086
+ ],
2087
+ requestContentTypes: []
2088
+ },
2002
2089
  resumeScenarioSession: {
2003
2090
  id: "resumeScenarioSession",
2004
2091
  method: "POST",
@@ -2137,6 +2224,19 @@ var Operations = {
2137
2224
  params: [{ name: "Idempotency-Key", in: "header", required: false }],
2138
2225
  requestContentTypes: ["application/json"]
2139
2226
  },
2227
+ startAudioDeviceSweep: {
2228
+ id: "startAudioDeviceSweep",
2229
+ method: "POST",
2230
+ path: "/venues/{venueId}/audio/devices/{deviceId}/sweep",
2231
+ scope: "audio:calibrate",
2232
+ tags: ["audio"],
2233
+ params: [
2234
+ { name: "venueId", in: "path", required: true },
2235
+ { name: "deviceId", in: "path", required: true },
2236
+ { name: "Idempotency-Key", in: "header", required: false }
2237
+ ],
2238
+ requestContentTypes: ["application/json"]
2239
+ },
2140
2240
  startAudioSession: {
2141
2241
  id: "startAudioSession",
2142
2242
  method: "POST",
@@ -2340,6 +2440,24 @@ var CloudOperations = {
2340
2440
  params: [],
2341
2441
  requestContentTypes: ["application/json"]
2342
2442
  },
2443
+ claimDossier: {
2444
+ id: "claimDossier",
2445
+ method: "POST",
2446
+ path: "/dossiers/self/claim",
2447
+ scope: "any",
2448
+ tags: ["dossier"],
2449
+ params: [{ name: "X-Dossier-Code", in: "header", required: true }],
2450
+ requestContentTypes: []
2451
+ },
2452
+ consentDossier: {
2453
+ id: "consentDossier",
2454
+ method: "POST",
2455
+ path: "/dossiers/self/consent",
2456
+ scope: "anon",
2457
+ tags: ["dossier"],
2458
+ params: [{ name: "X-Dossier-Code", in: "header", required: true }],
2459
+ requestContentTypes: ["application/json"]
2460
+ },
2343
2461
  createAccountApiKey: {
2344
2462
  id: "createAccountApiKey",
2345
2463
  method: "POST",
@@ -2464,6 +2582,27 @@ var CloudOperations = {
2464
2582
  params: [{ name: "sessionId", in: "path", required: true }],
2465
2583
  requestContentTypes: []
2466
2584
  },
2585
+ deleteDossierAttachment: {
2586
+ id: "deleteDossierAttachment",
2587
+ method: "DELETE",
2588
+ path: "/dossiers/self/attachments/{attachmentId}",
2589
+ scope: "anon",
2590
+ tags: ["dossier"],
2591
+ params: [
2592
+ { name: "attachmentId", in: "path", required: true },
2593
+ { name: "X-Dossier-Code", in: "header", required: true }
2594
+ ],
2595
+ requestContentTypes: []
2596
+ },
2597
+ deleteDossierSelf: {
2598
+ id: "deleteDossierSelf",
2599
+ method: "DELETE",
2600
+ path: "/dossiers/self",
2601
+ scope: "anon",
2602
+ tags: ["dossier"],
2603
+ params: [{ name: "X-Dossier-Code", in: "header", required: true }],
2604
+ requestContentTypes: []
2605
+ },
2467
2606
  deleteOrg: {
2468
2607
  id: "deleteOrg",
2469
2608
  method: "DELETE",
@@ -2539,6 +2678,15 @@ var CloudOperations = {
2539
2678
  params: [],
2540
2679
  requestContentTypes: ["application/json"]
2541
2680
  },
2681
+ exportDossierSelf: {
2682
+ id: "exportDossierSelf",
2683
+ method: "GET",
2684
+ path: "/dossiers/self/export",
2685
+ scope: "anon",
2686
+ tags: ["dossier"],
2687
+ params: [{ name: "X-Dossier-Code", in: "header", required: true }],
2688
+ requestContentTypes: []
2689
+ },
2542
2690
  forgotPassword: {
2543
2691
  id: "forgotPassword",
2544
2692
  method: "POST",
@@ -2566,6 +2714,27 @@ var CloudOperations = {
2566
2714
  params: [{ name: "itemId", in: "path", required: true }],
2567
2715
  requestContentTypes: []
2568
2716
  },
2717
+ getDossierAttachment: {
2718
+ id: "getDossierAttachment",
2719
+ method: "GET",
2720
+ path: "/dossiers/self/attachments/{attachmentId}",
2721
+ scope: "anon",
2722
+ tags: ["dossier"],
2723
+ params: [
2724
+ { name: "attachmentId", in: "path", required: true },
2725
+ { name: "X-Dossier-Code", in: "header", required: true }
2726
+ ],
2727
+ requestContentTypes: []
2728
+ },
2729
+ getDossierSelf: {
2730
+ id: "getDossierSelf",
2731
+ method: "GET",
2732
+ path: "/dossiers/self",
2733
+ scope: "anon",
2734
+ tags: ["dossier"],
2735
+ params: [{ name: "X-Dossier-Code", in: "header", required: true }],
2736
+ requestContentTypes: []
2737
+ },
2569
2738
  getEnrollmentRequest: {
2570
2739
  id: "getEnrollmentRequest",
2571
2740
  method: "GET",
@@ -2986,6 +3155,15 @@ var CloudOperations = {
2986
3155
  params: [],
2987
3156
  requestContentTypes: ["application/json"]
2988
3157
  },
3158
+ uploadDossierAttachment: {
3159
+ id: "uploadDossierAttachment",
3160
+ method: "POST",
3161
+ path: "/dossiers/self/attachments",
3162
+ scope: "anon",
3163
+ tags: ["dossier"],
3164
+ params: [{ name: "X-Dossier-Code", in: "header", required: true }],
3165
+ requestContentTypes: ["multipart/form-data"]
3166
+ },
2989
3167
  verifyEmail: {
2990
3168
  id: "verifyEmail",
2991
3169
  method: "POST",
@@ -3330,7 +3508,7 @@ var Scopes = {
3330
3508
  "audio:control": "audio mode / gain / zones / devices / sessions / generator / sources",
3331
3509
  "displays:control": "test patterns, identify, power",
3332
3510
  "calibration:run": "visual calibration jobs and sidecars",
3333
- "audio:calibrate": "audio calibration jobs (audio-room, audio-speaker-check)",
3511
+ "audio:calibrate": "audio calibration jobs (audio-room, audio-speaker-check) and device sweeps",
3334
3512
  "venues:write": "venues, displays config, speaker layout, device pairing / binding",
3335
3513
  "gateways:manage": "gateways, OSC send",
3336
3514
  "system:read": "system status, logs, config (redacted), diagnostics, clients, jobs of others",
@@ -3424,13 +3602,13 @@ var ProblemCodes = [
3424
3602
  // src/generated/asyncapi.ts
3425
3603
  var AsyncApiCatalogue = {
3426
3604
  "cloud-socketio": {
3427
- version: "1.0.0",
3605
+ version: "1.2.0",
3428
3606
  messages: ["event", "join"],
3429
3607
  channels: ["v1"],
3430
3608
  operations: ["emitJoin", "receiveEvent"]
3431
3609
  },
3432
3610
  "socketio-legacy": {
3433
- version: "1.0.0",
3611
+ version: "1.2.0",
3434
3612
  messages: [
3435
3613
  "brightness",
3436
3614
  "clear-integration",
@@ -3464,7 +3642,7 @@ var AsyncApiCatalogue = {
3464
3642
  ]
3465
3643
  },
3466
3644
  socketio: {
3467
- version: "1.0.0",
3645
+ version: "1.2.0",
3468
3646
  messages: ["ack", "bye", "call", "event", "resync", "subscribe", "unsubscribe", "welcome"],
3469
3647
  channels: ["v1"],
3470
3648
  operations: [
@@ -3478,7 +3656,7 @@ var AsyncApiCatalogue = {
3478
3656
  ]
3479
3657
  },
3480
3658
  ws: {
3481
- version: "1.0.0",
3659
+ version: "1.2.0",
3482
3660
  messages: [
3483
3661
  "bye",
3484
3662
  "call",