@ue-shed/protocol 0.6.0 → 0.7.1

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/review-realization-request.schema.json ADDED
@@ -0,0 +1,417 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://ue-shed.dev/contracts/cameras/render/v1/review-realization-request.schema.json",
4
+ "type": "object",
5
+ "properties": {
6
+ "contract": {
7
+ "type": "object",
8
+ "properties": {
9
+ "name": {
10
+ "type": "string",
11
+ "enum": ["ue-shed-review-render-stages"]
12
+ },
13
+ "version": {
14
+ "type": "object",
15
+ "properties": {
16
+ "major": {
17
+ "type": "number",
18
+ "enum": [1]
19
+ },
20
+ "minor": {
21
+ "type": "number",
22
+ "enum": [0]
23
+ }
24
+ },
25
+ "required": ["major", "minor"],
26
+ "additionalProperties": false
27
+ }
28
+ },
29
+ "required": ["name", "version"],
30
+ "additionalProperties": false
31
+ },
32
+ "viewpoint": {
33
+ "anyOf": [
34
+ {
35
+ "type": "object",
36
+ "properties": {
37
+ "approvedPose": {
38
+ "type": "object",
39
+ "properties": {
40
+ "aspectRatio": {
41
+ "type": "string",
42
+ "enum": ["16:9"]
43
+ },
44
+ "fieldOfViewDegrees": {
45
+ "type": "number",
46
+ "allOf": [
47
+ {
48
+ "minimum": 5,
49
+ "maximum": 170
50
+ }
51
+ ]
52
+ },
53
+ "location": {
54
+ "type": "object",
55
+ "properties": {
56
+ "x": {
57
+ "type": "number"
58
+ },
59
+ "y": {
60
+ "type": "number"
61
+ },
62
+ "z": {
63
+ "type": "number"
64
+ }
65
+ },
66
+ "required": ["x", "y", "z"],
67
+ "additionalProperties": false
68
+ },
69
+ "projection": {
70
+ "type": "string",
71
+ "enum": ["perspective"]
72
+ },
73
+ "rotation": {
74
+ "type": "object",
75
+ "properties": {
76
+ "pitch": {
77
+ "type": "number"
78
+ },
79
+ "roll": {
80
+ "type": "number"
81
+ },
82
+ "yaw": {
83
+ "type": "number"
84
+ }
85
+ },
86
+ "required": ["pitch", "roll", "yaw"],
87
+ "additionalProperties": false
88
+ }
89
+ },
90
+ "required": [
91
+ "aspectRatio",
92
+ "fieldOfViewDegrees",
93
+ "location",
94
+ "projection",
95
+ "rotation"
96
+ ],
97
+ "additionalProperties": false
98
+ },
99
+ "kind": {
100
+ "type": "string",
101
+ "enum": ["world_fixed"]
102
+ }
103
+ },
104
+ "required": ["approvedPose", "kind"],
105
+ "additionalProperties": false
106
+ },
107
+ {
108
+ "type": "object",
109
+ "properties": {
110
+ "kind": {
111
+ "type": "string",
112
+ "enum": ["target_relative"]
113
+ },
114
+ "relativePose": {
115
+ "type": "object",
116
+ "properties": {
117
+ "aspectRatio": {
118
+ "type": "string",
119
+ "enum": ["16:9"]
120
+ },
121
+ "fieldOfViewDegrees": {
122
+ "type": "number",
123
+ "allOf": [
124
+ {
125
+ "minimum": 5,
126
+ "maximum": 170
127
+ }
128
+ ]
129
+ },
130
+ "location": {
131
+ "type": "object",
132
+ "properties": {
133
+ "x": {
134
+ "type": "number"
135
+ },
136
+ "y": {
137
+ "type": "number"
138
+ },
139
+ "z": {
140
+ "type": "number"
141
+ }
142
+ },
143
+ "required": ["x", "y", "z"],
144
+ "additionalProperties": false
145
+ },
146
+ "projection": {
147
+ "type": "string",
148
+ "enum": ["perspective"]
149
+ },
150
+ "rotation": {
151
+ "type": "object",
152
+ "properties": {
153
+ "pitch": {
154
+ "type": "number"
155
+ },
156
+ "roll": {
157
+ "type": "number"
158
+ },
159
+ "yaw": {
160
+ "type": "number"
161
+ }
162
+ },
163
+ "required": ["pitch", "roll", "yaw"],
164
+ "additionalProperties": false
165
+ }
166
+ },
167
+ "required": [
168
+ "aspectRatio",
169
+ "fieldOfViewDegrees",
170
+ "location",
171
+ "projection",
172
+ "rotation"
173
+ ],
174
+ "additionalProperties": false
175
+ },
176
+ "targetSnapshot": {
177
+ "type": "object",
178
+ "properties": {
179
+ "location": {
180
+ "type": "object",
181
+ "properties": {
182
+ "x": {
183
+ "type": "number"
184
+ },
185
+ "y": {
186
+ "type": "number"
187
+ },
188
+ "z": {
189
+ "type": "number"
190
+ }
191
+ },
192
+ "required": ["x", "y", "z"],
193
+ "additionalProperties": false
194
+ },
195
+ "rotation": {
196
+ "type": "object",
197
+ "properties": {
198
+ "pitch": {
199
+ "type": "number"
200
+ },
201
+ "roll": {
202
+ "type": "number"
203
+ },
204
+ "yaw": {
205
+ "type": "number"
206
+ }
207
+ },
208
+ "required": ["pitch", "roll", "yaw"],
209
+ "additionalProperties": false
210
+ }
211
+ },
212
+ "required": ["location", "rotation"],
213
+ "additionalProperties": false
214
+ }
215
+ },
216
+ "required": ["kind", "relativePose", "targetSnapshot"],
217
+ "additionalProperties": false
218
+ }
219
+ ]
220
+ },
221
+ "subject": {
222
+ "anyOf": [
223
+ {
224
+ "anyOf": [
225
+ {
226
+ "type": "object",
227
+ "properties": {
228
+ "actorGuid": {
229
+ "type": "string",
230
+ "allOf": [
231
+ {
232
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
233
+ }
234
+ ]
235
+ },
236
+ "diagnosticLabel": {
237
+ "anyOf": [
238
+ {
239
+ "type": "string",
240
+ "allOf": [
241
+ {
242
+ "minLength": 1
243
+ }
244
+ ]
245
+ },
246
+ {
247
+ "type": "null"
248
+ }
249
+ ]
250
+ },
251
+ "kind": {
252
+ "type": "string",
253
+ "enum": ["actor_guid"]
254
+ },
255
+ "lastKnownActorPath": {
256
+ "anyOf": [
257
+ {
258
+ "type": "string",
259
+ "allOf": [
260
+ {
261
+ "minLength": 7
262
+ },
263
+ {
264
+ "maxLength": 4096
265
+ },
266
+ {
267
+ "pattern": "^\\/Game\\/"
268
+ }
269
+ ]
270
+ },
271
+ {
272
+ "type": "null"
273
+ }
274
+ ]
275
+ }
276
+ },
277
+ "required": ["actorGuid", "kind"],
278
+ "additionalProperties": false
279
+ },
280
+ {
281
+ "type": "object",
282
+ "properties": {
283
+ "actorPath": {
284
+ "type": "string",
285
+ "allOf": [
286
+ {
287
+ "minLength": 7
288
+ },
289
+ {
290
+ "maxLength": 4096
291
+ },
292
+ {
293
+ "pattern": "^\\/Game\\/"
294
+ }
295
+ ]
296
+ },
297
+ "diagnosticLabel": {
298
+ "anyOf": [
299
+ {
300
+ "type": "string",
301
+ "allOf": [
302
+ {
303
+ "minLength": 1
304
+ }
305
+ ]
306
+ },
307
+ {
308
+ "type": "null"
309
+ }
310
+ ]
311
+ },
312
+ "kind": {
313
+ "type": "string",
314
+ "enum": ["actor_path"]
315
+ }
316
+ },
317
+ "required": ["actorPath", "kind"],
318
+ "additionalProperties": false
319
+ }
320
+ ]
321
+ },
322
+ {
323
+ "type": "object",
324
+ "properties": {
325
+ "bounds": {
326
+ "type": "object",
327
+ "properties": {
328
+ "center": {
329
+ "type": "object",
330
+ "properties": {
331
+ "x": {
332
+ "type": "number"
333
+ },
334
+ "y": {
335
+ "type": "number"
336
+ },
337
+ "z": {
338
+ "type": "number"
339
+ }
340
+ },
341
+ "required": ["x", "y", "z"],
342
+ "additionalProperties": false
343
+ },
344
+ "extent": {
345
+ "type": "object",
346
+ "properties": {
347
+ "x": {
348
+ "type": "number",
349
+ "allOf": [
350
+ {
351
+ "minimum": 0
352
+ }
353
+ ]
354
+ },
355
+ "y": {
356
+ "type": "number",
357
+ "allOf": [
358
+ {
359
+ "minimum": 0
360
+ }
361
+ ]
362
+ },
363
+ "z": {
364
+ "type": "number",
365
+ "allOf": [
366
+ {
367
+ "minimum": 0
368
+ }
369
+ ]
370
+ }
371
+ },
372
+ "required": ["x", "y", "z"],
373
+ "additionalProperties": false
374
+ },
375
+ "rotation": {
376
+ "type": "object",
377
+ "properties": {
378
+ "pitch": {
379
+ "type": "number"
380
+ },
381
+ "roll": {
382
+ "type": "number"
383
+ },
384
+ "yaw": {
385
+ "type": "number"
386
+ }
387
+ },
388
+ "required": ["pitch", "roll", "yaw"],
389
+ "additionalProperties": false
390
+ }
391
+ },
392
+ "required": ["center", "extent", "rotation"],
393
+ "additionalProperties": false
394
+ },
395
+ "kind": {
396
+ "type": "string",
397
+ "enum": ["oriented_bounds"]
398
+ }
399
+ },
400
+ "required": ["bounds", "kind"],
401
+ "additionalProperties": false
402
+ }
403
+ ]
404
+ },
405
+ "expectedMapPath": {
406
+ "type": "string",
407
+ "allOf": [
408
+ {
409
+ "minLength": 1
410
+ }
411
+ ]
412
+ }
413
+ },
414
+ "required": ["contract", "viewpoint", "subject", "expectedMapPath"],
415
+ "additionalProperties": false,
416
+ "$defs": {}
417
+ }