@ue-shed/protocol 0.6.0 → 0.7.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.
Files changed (33) hide show
  1. package/contracts/cameras/map-tile/v1/README.md +7 -0
  2. package/contracts/cameras/map-tile/v1/capture-response.schema.json +97 -25
  3. package/contracts/cameras/map-tile/v1/manifest.schema.json +136 -37
  4. package/contracts/cameras/map-tile/v1/plan.schema.json +132 -36
  5. package/contracts/cameras/map-tile/v1/release-result.schema.json +12 -0
  6. package/contracts/cameras/render/v1/README.md +33 -0
  7. package/contracts/cameras/render/v1/begin-result.schema.json +712 -0
  8. package/contracts/cameras/render/v1/capabilities.schema.json +201 -0
  9. package/contracts/cameras/render/v1/end-result.schema.json +185 -0
  10. package/contracts/cameras/render/v1/fixtures/frame-orthographic.json +31 -0
  11. package/contracts/cameras/render/v1/fixtures/frame-perspective.json +31 -0
  12. package/contracts/cameras/render/v1/fixtures/invalid-frame-mixed-projection.json +32 -0
  13. package/contracts/cameras/render/v1/fixtures/invalid-frame-size.json +31 -0
  14. package/contracts/cameras/render/v1/fixtures/invalid-session-backend-fields.json +40 -0
  15. package/contracts/cameras/render/v1/fixtures/invalid-session-budget.json +39 -0
  16. package/contracts/cameras/render/v1/fixtures/invalid-session-future.json +39 -0
  17. package/contracts/cameras/render/v1/fixtures/session-camera-regions.json +51 -0
  18. package/contracts/cameras/render/v1/fixtures/session-editor-viewport.json +40 -0
  19. package/contracts/cameras/render/v1/fixtures/session-scene-capture.json +39 -0
  20. package/contracts/cameras/render/v1/frame-evidence.schema.json +771 -0
  21. package/contracts/cameras/render/v1/frame-request.schema.json +219 -0
  22. package/contracts/cameras/render/v1/frame-status.schema.json +1076 -0
  23. package/contracts/cameras/render/v1/policy.schema.json +510 -0
  24. package/contracts/cameras/render/v1/preflight.schema.json +68 -0
  25. package/contracts/cameras/render/v1/review-inspection-request.schema.json +342 -0
  26. package/contracts/cameras/render/v1/review-inspection-result.schema.json +2030 -0
  27. package/contracts/cameras/render/v1/review-realization-request.schema.json +417 -0
  28. package/contracts/cameras/render/v1/review-realization-result.schema.json +454 -0
  29. package/contracts/cameras/render/v1/session-request.schema.json +617 -0
  30. package/contracts/cameras/review/v1/README.md +7 -0
  31. package/contracts/cameras/review/v1/capture-request.schema.json +247 -61
  32. package/contracts/cameras/review/v1/capture-response.schema.json +820 -192
  33. package/package.json +1 -1
package/contracts/cameras/render/v1/frame-evidence.schema.json ADDED
@@ -0,0 +1,771 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://ue-shed.dev/contracts/cameras/render/v1/frame-evidence.schema.json",
4
+ "type": "object",
5
+ "properties": {
6
+ "editorState": {
7
+ "type": "object",
8
+ "properties": {
9
+ "mapPackageDirtyBefore": {
10
+ "type": "boolean"
11
+ },
12
+ "mapPackageDirtyAfter": {
13
+ "type": "boolean"
14
+ }
15
+ },
16
+ "required": ["mapPackageDirtyBefore", "mapPackageDirtyAfter"],
17
+ "additionalProperties": false
18
+ },
19
+ "camera": {
20
+ "type": "object",
21
+ "properties": {
22
+ "location": {
23
+ "type": "object",
24
+ "properties": {
25
+ "x": {
26
+ "type": "number"
27
+ },
28
+ "y": {
29
+ "type": "number"
30
+ },
31
+ "z": {
32
+ "type": "number"
33
+ }
34
+ },
35
+ "required": ["x", "y", "z"],
36
+ "additionalProperties": false
37
+ },
38
+ "rotation": {
39
+ "type": "object",
40
+ "properties": {
41
+ "pitch": {
42
+ "type": "number"
43
+ },
44
+ "roll": {
45
+ "type": "number"
46
+ },
47
+ "yaw": {
48
+ "type": "number"
49
+ }
50
+ },
51
+ "required": ["pitch", "roll", "yaw"],
52
+ "additionalProperties": false
53
+ },
54
+ "projection": {
55
+ "anyOf": [
56
+ {
57
+ "type": "object",
58
+ "properties": {
59
+ "kind": {
60
+ "type": "string",
61
+ "enum": ["perspective"]
62
+ },
63
+ "horizontalFieldOfView": {
64
+ "type": "number",
65
+ "allOf": [
66
+ {
67
+ "minimum": 5,
68
+ "maximum": 170
69
+ }
70
+ ]
71
+ }
72
+ },
73
+ "required": ["kind", "horizontalFieldOfView"],
74
+ "additionalProperties": false
75
+ },
76
+ {
77
+ "type": "object",
78
+ "properties": {
79
+ "kind": {
80
+ "type": "string",
81
+ "enum": ["orthographic"]
82
+ },
83
+ "width": {
84
+ "type": "number",
85
+ "allOf": [
86
+ {
87
+ "exclusiveMinimum": 0
88
+ },
89
+ {
90
+ "maximum": 1000000000
91
+ }
92
+ ]
93
+ }
94
+ },
95
+ "required": ["kind", "width"],
96
+ "additionalProperties": false
97
+ }
98
+ ]
99
+ }
100
+ },
101
+ "required": ["location", "rotation", "projection"],
102
+ "additionalProperties": false
103
+ },
104
+ "size": {
105
+ "type": "object",
106
+ "properties": {
107
+ "width": {
108
+ "type": "integer",
109
+ "allOf": [
110
+ {
111
+ "minimum": 16,
112
+ "maximum": 16384
113
+ }
114
+ ]
115
+ },
116
+ "height": {
117
+ "type": "integer",
118
+ "allOf": [
119
+ {
120
+ "minimum": 16,
121
+ "maximum": 16384
122
+ }
123
+ ]
124
+ }
125
+ },
126
+ "required": ["width", "height"],
127
+ "additionalProperties": false
128
+ },
129
+ "policy": {
130
+ "type": "object",
131
+ "properties": {
132
+ "renderer": {
133
+ "anyOf": [
134
+ {
135
+ "type": "object",
136
+ "properties": {
137
+ "kind": {
138
+ "type": "string",
139
+ "enum": ["editor_viewport"]
140
+ },
141
+ "strategy": {
142
+ "type": "string",
143
+ "enum": ["high_resolution_screenshot"]
144
+ },
145
+ "profile": {
146
+ "type": "string",
147
+ "enum": ["lit", "observation"]
148
+ },
149
+ "vignette": {
150
+ "type": "string",
151
+ "enum": ["project", "disabled"]
152
+ },
153
+ "fog": {
154
+ "type": "boolean"
155
+ },
156
+ "volumetricFog": {
157
+ "type": "boolean"
158
+ }
159
+ },
160
+ "required": [
161
+ "kind",
162
+ "strategy",
163
+ "profile",
164
+ "vignette",
165
+ "fog",
166
+ "volumetricFog"
167
+ ],
168
+ "additionalProperties": false
169
+ },
170
+ {
171
+ "type": "object",
172
+ "properties": {
173
+ "kind": {
174
+ "type": "string",
175
+ "enum": ["scene_capture"]
176
+ },
177
+ "profile": {
178
+ "type": "string",
179
+ "enum": [
180
+ "full_fidelity",
181
+ "seam_stable",
182
+ "scene_capture_defaults",
183
+ "observation"
184
+ ]
185
+ },
186
+ "lodDistanceScale": {
187
+ "type": "number",
188
+ "allOf": [
189
+ {
190
+ "minimum": 0.1,
191
+ "maximum": 100
192
+ }
193
+ ]
194
+ },
195
+ "fog": {
196
+ "type": "boolean"
197
+ },
198
+ "volumetricFog": {
199
+ "type": "boolean"
200
+ }
201
+ },
202
+ "required": [
203
+ "kind",
204
+ "profile",
205
+ "lodDistanceScale",
206
+ "fog",
207
+ "volumetricFog"
208
+ ],
209
+ "additionalProperties": false
210
+ }
211
+ ]
212
+ },
213
+ "exposure": {
214
+ "anyOf": [
215
+ {
216
+ "type": "object",
217
+ "properties": {
218
+ "mode": {
219
+ "type": "string",
220
+ "enum": ["project_auto"]
221
+ }
222
+ },
223
+ "required": ["mode"],
224
+ "additionalProperties": false
225
+ },
226
+ {
227
+ "type": "object",
228
+ "properties": {
229
+ "mode": {
230
+ "type": "string",
231
+ "enum": ["fixed_ev100"]
232
+ },
233
+ "ev100": {
234
+ "type": "number",
235
+ "allOf": [
236
+ {
237
+ "minimum": -20,
238
+ "maximum": 30
239
+ }
240
+ ]
241
+ },
242
+ "compensation": {
243
+ "type": "string",
244
+ "enum": ["project"]
245
+ }
246
+ },
247
+ "required": ["mode", "ev100", "compensation"],
248
+ "additionalProperties": false
249
+ },
250
+ {
251
+ "type": "object",
252
+ "properties": {
253
+ "mode": {
254
+ "type": "string",
255
+ "enum": ["meter_once"]
256
+ },
257
+ "referenceCamera": {
258
+ "type": "object",
259
+ "properties": {
260
+ "location": {
261
+ "type": "object",
262
+ "properties": {
263
+ "x": {
264
+ "type": "number"
265
+ },
266
+ "y": {
267
+ "type": "number"
268
+ },
269
+ "z": {
270
+ "type": "number"
271
+ }
272
+ },
273
+ "required": ["x", "y", "z"],
274
+ "additionalProperties": false
275
+ },
276
+ "rotation": {
277
+ "type": "object",
278
+ "properties": {
279
+ "pitch": {
280
+ "type": "number"
281
+ },
282
+ "roll": {
283
+ "type": "number"
284
+ },
285
+ "yaw": {
286
+ "type": "number"
287
+ }
288
+ },
289
+ "required": ["pitch", "roll", "yaw"],
290
+ "additionalProperties": false
291
+ },
292
+ "projection": {
293
+ "anyOf": [
294
+ {
295
+ "type": "object",
296
+ "properties": {
297
+ "kind": {
298
+ "type": "string",
299
+ "enum": ["perspective"]
300
+ },
301
+ "horizontalFieldOfView": {
302
+ "type": "number",
303
+ "allOf": [
304
+ {
305
+ "minimum": 5,
306
+ "maximum": 170
307
+ }
308
+ ]
309
+ }
310
+ },
311
+ "required": ["kind", "horizontalFieldOfView"],
312
+ "additionalProperties": false
313
+ },
314
+ {
315
+ "type": "object",
316
+ "properties": {
317
+ "kind": {
318
+ "type": "string",
319
+ "enum": ["orthographic"]
320
+ },
321
+ "width": {
322
+ "type": "number",
323
+ "allOf": [
324
+ {
325
+ "exclusiveMinimum": 0
326
+ },
327
+ {
328
+ "maximum": 1000000000
329
+ }
330
+ ]
331
+ }
332
+ },
333
+ "required": ["kind", "width"],
334
+ "additionalProperties": false
335
+ }
336
+ ]
337
+ }
338
+ },
339
+ "required": ["location", "rotation", "projection"],
340
+ "additionalProperties": false
341
+ },
342
+ "referenceSize": {
343
+ "type": "object",
344
+ "properties": {
345
+ "width": {
346
+ "type": "integer",
347
+ "allOf": [
348
+ {
349
+ "minimum": 16,
350
+ "maximum": 16384
351
+ }
352
+ ]
353
+ },
354
+ "height": {
355
+ "type": "integer",
356
+ "allOf": [
357
+ {
358
+ "minimum": 16,
359
+ "maximum": 16384
360
+ }
361
+ ]
362
+ }
363
+ },
364
+ "required": ["width", "height"],
365
+ "additionalProperties": false
366
+ },
367
+ "minimumFrames": {
368
+ "type": "integer",
369
+ "allOf": [
370
+ {
371
+ "minimum": 1,
372
+ "maximum": 4096
373
+ }
374
+ ]
375
+ }
376
+ },
377
+ "required": [
378
+ "mode",
379
+ "referenceCamera",
380
+ "referenceSize",
381
+ "minimumFrames"
382
+ ],
383
+ "additionalProperties": false
384
+ }
385
+ ]
386
+ },
387
+ "settling": {
388
+ "type": "object",
389
+ "properties": {
390
+ "minimumFrames": {
391
+ "type": "integer",
392
+ "allOf": [
393
+ {
394
+ "minimum": 1,
395
+ "maximum": 4096
396
+ }
397
+ ]
398
+ },
399
+ "timeoutMs": {
400
+ "type": "integer",
401
+ "allOf": [
402
+ {
403
+ "minimum": 1000,
404
+ "maximum": 900000
405
+ }
406
+ ]
407
+ },
408
+ "initialView": {
409
+ "type": "object",
410
+ "properties": {
411
+ "camera": {
412
+ "type": "object",
413
+ "properties": {
414
+ "location": {
415
+ "type": "object",
416
+ "properties": {
417
+ "x": {
418
+ "type": "number"
419
+ },
420
+ "y": {
421
+ "type": "number"
422
+ },
423
+ "z": {
424
+ "type": "number"
425
+ }
426
+ },
427
+ "required": ["x", "y", "z"],
428
+ "additionalProperties": false
429
+ },
430
+ "rotation": {
431
+ "type": "object",
432
+ "properties": {
433
+ "pitch": {
434
+ "type": "number"
435
+ },
436
+ "roll": {
437
+ "type": "number"
438
+ },
439
+ "yaw": {
440
+ "type": "number"
441
+ }
442
+ },
443
+ "required": ["pitch", "roll", "yaw"],
444
+ "additionalProperties": false
445
+ },
446
+ "projection": {
447
+ "anyOf": [
448
+ {
449
+ "type": "object",
450
+ "properties": {
451
+ "kind": {
452
+ "type": "string",
453
+ "enum": ["perspective"]
454
+ },
455
+ "horizontalFieldOfView": {
456
+ "type": "number",
457
+ "allOf": [
458
+ {
459
+ "minimum": 5,
460
+ "maximum": 170
461
+ }
462
+ ]
463
+ }
464
+ },
465
+ "required": ["kind", "horizontalFieldOfView"],
466
+ "additionalProperties": false
467
+ },
468
+ {
469
+ "type": "object",
470
+ "properties": {
471
+ "kind": {
472
+ "type": "string",
473
+ "enum": ["orthographic"]
474
+ },
475
+ "width": {
476
+ "type": "number",
477
+ "allOf": [
478
+ {
479
+ "exclusiveMinimum": 0
480
+ },
481
+ {
482
+ "maximum": 1000000000
483
+ }
484
+ ]
485
+ }
486
+ },
487
+ "required": ["kind", "width"],
488
+ "additionalProperties": false
489
+ }
490
+ ]
491
+ }
492
+ },
493
+ "required": ["location", "rotation", "projection"],
494
+ "additionalProperties": false
495
+ },
496
+ "size": {
497
+ "type": "object",
498
+ "properties": {
499
+ "width": {
500
+ "type": "integer",
501
+ "allOf": [
502
+ {
503
+ "minimum": 16,
504
+ "maximum": 16384
505
+ }
506
+ ]
507
+ },
508
+ "height": {
509
+ "type": "integer",
510
+ "allOf": [
511
+ {
512
+ "minimum": 16,
513
+ "maximum": 16384
514
+ }
515
+ ]
516
+ }
517
+ },
518
+ "required": ["width", "height"],
519
+ "additionalProperties": false
520
+ },
521
+ "minimumFrames": {
522
+ "type": "integer",
523
+ "allOf": [
524
+ {
525
+ "minimum": 1,
526
+ "maximum": 4096
527
+ }
528
+ ]
529
+ }
530
+ },
531
+ "required": ["camera", "size", "minimumFrames"],
532
+ "additionalProperties": false
533
+ }
534
+ },
535
+ "required": ["minimumFrames", "timeoutMs"],
536
+ "additionalProperties": false
537
+ },
538
+ "time": {
539
+ "type": "string",
540
+ "enum": ["live_editor", "freeze_materials_and_ticks"]
541
+ },
542
+ "preparation": {
543
+ "type": "object",
544
+ "properties": {
545
+ "geometry": {
546
+ "anyOf": [
547
+ {
548
+ "type": "object",
549
+ "properties": {
550
+ "mode": {
551
+ "type": "string",
552
+ "enum": ["preserve_loading"]
553
+ }
554
+ },
555
+ "required": ["mode"],
556
+ "additionalProperties": false
557
+ },
558
+ {
559
+ "type": "object",
560
+ "properties": {
561
+ "mode": {
562
+ "type": "string",
563
+ "enum": ["camera_regions"]
564
+ },
565
+ "maximumRegions": {
566
+ "type": "integer",
567
+ "allOf": [
568
+ {
569
+ "minimum": 1,
570
+ "maximum": 64
571
+ }
572
+ ]
573
+ },
574
+ "extent": {
575
+ "type": "object",
576
+ "properties": {
577
+ "x": {
578
+ "type": "number",
579
+ "allOf": [
580
+ {
581
+ "minimum": 0,
582
+ "maximum": 10000000
583
+ }
584
+ ]
585
+ },
586
+ "y": {
587
+ "type": "number",
588
+ "allOf": [
589
+ {
590
+ "minimum": 0,
591
+ "maximum": 10000000
592
+ }
593
+ ]
594
+ },
595
+ "z": {
596
+ "type": "number",
597
+ "allOf": [
598
+ {
599
+ "minimum": 0,
600
+ "maximum": 10000000
601
+ }
602
+ ]
603
+ }
604
+ },
605
+ "required": ["x", "y", "z"],
606
+ "additionalProperties": false
607
+ }
608
+ },
609
+ "required": ["mode", "maximumRegions", "extent"],
610
+ "additionalProperties": false
611
+ }
612
+ ]
613
+ },
614
+ "dataLayers": {
615
+ "type": "array",
616
+ "items": {
617
+ "type": "object",
618
+ "properties": {
619
+ "assetPath": {
620
+ "type": "string",
621
+ "allOf": [
622
+ {
623
+ "pattern": "^\\/[A-Za-z0-9_./-]+$"
624
+ },
625
+ {
626
+ "maxLength": 1024
627
+ }
628
+ ]
629
+ },
630
+ "loaded": {
631
+ "type": "boolean"
632
+ },
633
+ "visible": {
634
+ "type": "boolean"
635
+ }
636
+ },
637
+ "required": ["assetPath", "loaded", "visible"],
638
+ "additionalProperties": false
639
+ },
640
+ "allOf": [
641
+ {
642
+ "maxItems": 64
643
+ }
644
+ ]
645
+ }
646
+ },
647
+ "required": ["geometry", "dataLayers"],
648
+ "additionalProperties": false
649
+ }
650
+ },
651
+ "required": ["renderer", "exposure", "settling", "time", "preparation"],
652
+ "additionalProperties": false
653
+ },
654
+ "exposureEV100": {
655
+ "anyOf": [
656
+ {
657
+ "type": "number"
658
+ },
659
+ {
660
+ "type": "null"
661
+ }
662
+ ]
663
+ },
664
+ "preparation": {
665
+ "type": "object",
666
+ "properties": {
667
+ "status": {
668
+ "type": "string",
669
+ "enum": ["preserved", "ready", "partial"]
670
+ },
671
+ "regionsHeld": {
672
+ "type": "integer",
673
+ "allOf": [
674
+ {
675
+ "minimum": 0,
676
+ "maximum": 64
677
+ }
678
+ ]
679
+ },
680
+ "dataLayersApplied": {
681
+ "type": "integer",
682
+ "allOf": [
683
+ {
684
+ "minimum": 0,
685
+ "maximum": 64
686
+ }
687
+ ]
688
+ },
689
+ "limitations": {
690
+ "type": "array",
691
+ "items": {
692
+ "type": "string",
693
+ "allOf": [
694
+ {
695
+ "minLength": 1
696
+ },
697
+ {
698
+ "maxLength": 1024
699
+ }
700
+ ]
701
+ }
702
+ }
703
+ },
704
+ "required": ["status", "regionsHeld", "dataLayersApplied", "limitations"],
705
+ "additionalProperties": false
706
+ },
707
+ "settling": {
708
+ "type": "object",
709
+ "properties": {
710
+ "renderedFrames": {
711
+ "type": "integer",
712
+ "allOf": [
713
+ {
714
+ "minimum": 0,
715
+ "maximum": 1000000
716
+ }
717
+ ]
718
+ },
719
+ "elapsedMs": {
720
+ "type": "number",
721
+ "allOf": [
722
+ {
723
+ "minimum": 0
724
+ }
725
+ ]
726
+ },
727
+ "convergence": {
728
+ "type": "string",
729
+ "enum": ["not_assessed"]
730
+ }
731
+ },
732
+ "required": ["renderedFrames", "elapsedMs", "convergence"],
733
+ "additionalProperties": false
734
+ },
735
+ "engineVersion": {
736
+ "type": "string",
737
+ "allOf": [
738
+ {
739
+ "minLength": 1
740
+ },
741
+ {
742
+ "maxLength": 1024
743
+ }
744
+ ]
745
+ },
746
+ "pluginVersion": {
747
+ "type": "string",
748
+ "allOf": [
749
+ {
750
+ "minLength": 1
751
+ },
752
+ {
753
+ "maxLength": 1024
754
+ }
755
+ ]
756
+ }
757
+ },
758
+ "required": [
759
+ "editorState",
760
+ "camera",
761
+ "size",
762
+ "policy",
763
+ "exposureEV100",
764
+ "preparation",
765
+ "settling",
766
+ "engineVersion",
767
+ "pluginVersion"
768
+ ],
769
+ "additionalProperties": false,
770
+ "$defs": {}
771
+ }