@ue-shed/protocol 0.5.1 → 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 (102) hide show
  1. package/contracts/cameras/map-tile/v1/README.md +27 -6
  2. package/contracts/cameras/map-tile/v1/capture-operation.schema.json +69 -0
  3. package/contracts/cameras/map-tile/v1/capture-request.schema.json +2 -1
  4. package/contracts/cameras/map-tile/v1/capture-response.schema.json +97 -25
  5. package/contracts/cameras/map-tile/v1/fixtures/capture-operation-finished-valid.json +41 -0
  6. package/contracts/cameras/map-tile/v1/fixtures/capture-operation-progress-valid.json +13 -0
  7. package/contracts/cameras/map-tile/v1/fixtures/capture-operation-running-valid.json +5 -0
  8. package/contracts/cameras/map-tile/v1/fixtures/capture-request-lit-valid.json +59 -0
  9. package/contracts/cameras/map-tile/v1/fixtures/readiness-blocked.json +11 -0
  10. package/contracts/cameras/map-tile/v1/fixtures/readiness-ready.json +7 -0
  11. package/contracts/cameras/map-tile/v1/fixtures/selection-ready.json +21 -0
  12. package/contracts/cameras/map-tile/v1/fixtures/selection-unavailable.json +6 -0
  13. package/contracts/cameras/map-tile/v1/inspection.md +16 -0
  14. package/contracts/cameras/map-tile/v1/manifest.schema.json +136 -37
  15. package/contracts/cameras/map-tile/v1/plan.schema.json +132 -35
  16. package/contracts/cameras/map-tile/v1/readiness.schema.json +39 -0
  17. package/contracts/cameras/map-tile/v1/release-result.schema.json +12 -0
  18. package/contracts/cameras/map-tile/v1/selection.schema.json +105 -0
  19. package/contracts/cameras/render/v1/README.md +33 -0
  20. package/contracts/cameras/render/v1/begin-result.schema.json +712 -0
  21. package/contracts/cameras/render/v1/capabilities.schema.json +201 -0
  22. package/contracts/cameras/render/v1/end-result.schema.json +185 -0
  23. package/contracts/cameras/render/v1/fixtures/frame-orthographic.json +31 -0
  24. package/contracts/cameras/render/v1/fixtures/frame-perspective.json +31 -0
  25. package/contracts/cameras/render/v1/fixtures/invalid-frame-mixed-projection.json +32 -0
  26. package/contracts/cameras/render/v1/fixtures/invalid-frame-size.json +31 -0
  27. package/contracts/cameras/render/v1/fixtures/invalid-session-backend-fields.json +40 -0
  28. package/contracts/cameras/render/v1/fixtures/invalid-session-budget.json +39 -0
  29. package/contracts/cameras/render/v1/fixtures/invalid-session-future.json +39 -0
  30. package/contracts/cameras/render/v1/fixtures/session-camera-regions.json +51 -0
  31. package/contracts/cameras/render/v1/fixtures/session-editor-viewport.json +40 -0
  32. package/contracts/cameras/render/v1/fixtures/session-scene-capture.json +39 -0
  33. package/contracts/cameras/render/v1/frame-evidence.schema.json +771 -0
  34. package/contracts/cameras/render/v1/frame-request.schema.json +219 -0
  35. package/contracts/cameras/render/v1/frame-status.schema.json +1076 -0
  36. package/contracts/cameras/render/v1/policy.schema.json +510 -0
  37. package/contracts/cameras/render/v1/preflight.schema.json +68 -0
  38. package/contracts/cameras/render/v1/review-inspection-request.schema.json +342 -0
  39. package/contracts/cameras/render/v1/review-inspection-result.schema.json +2030 -0
  40. package/contracts/cameras/render/v1/review-realization-request.schema.json +417 -0
  41. package/contracts/cameras/render/v1/review-realization-result.schema.json +454 -0
  42. package/contracts/cameras/render/v1/session-request.schema.json +617 -0
  43. package/contracts/cameras/review/v1/README.md +7 -0
  44. package/contracts/cameras/review/v1/capture-request.schema.json +247 -61
  45. package/contracts/cameras/review/v1/capture-response.schema.json +820 -192
  46. package/contracts/core/v1/producer-identity.schema.json +44 -0
  47. package/contracts/niagara/preview/v1/common.schema.json +224 -30
  48. package/contracts/niagara/preview/v1/fixtures/background-manifest.json +136 -0
  49. package/contracts/niagara/preview/v1/fixtures/background-receipt.json +112 -0
  50. package/contracts/niagara/preview/v1/fixtures/background-request.json +39 -0
  51. package/contracts/niagara/preview/v1/fixtures/progress.json +8 -0
  52. package/contracts/niagara/preview/v1/fixtures/scene-manifest.json +108 -0
  53. package/contracts/niagara/preview/v1/fixtures/scene-receipt.json +84 -0
  54. package/contracts/niagara/preview/v1/fixtures/scene-request.json +25 -0
  55. package/contracts/niagara/preview/v1/manifest.schema.json +110 -25
  56. package/contracts/niagara/preview/v1/progress.schema.json +37 -0
  57. package/contracts/niagara/preview/v1/receipt.schema.json +75 -16
  58. package/contracts/niagara/preview/v1/request.schema.json +20 -5
  59. package/contracts/niagara/preview/v1/session.md +25 -0
  60. package/contracts/observatory/v1/actor-metadata.schema.json +33 -0
  61. package/contracts/uasset-io/v1/README.md +26 -1
  62. package/contracts/uasset-io/v1/event.schema.json +511 -1
  63. package/contracts/uasset-io/v1/fixtures/invalid/project-index-count-empty-filters.json +23 -0
  64. package/contracts/uasset-io/v1/fixtures/invalid/project-index-dictionary-page-negative-index.json +35 -0
  65. package/contracts/uasset-io/v1/fixtures/valid/blueprint-request.json +6 -0
  66. package/contracts/uasset-io/v1/fixtures/valid/blueprint-result-event.json +58 -0
  67. package/contracts/uasset-io/v1/fixtures/valid/project-index-count-request.json +32 -0
  68. package/contracts/uasset-io/v1/fixtures/valid/project-index-count-result-event.json +20 -0
  69. package/contracts/uasset-io/v1/fixtures/valid/project-index-dictionary-page-result-event.json +35 -0
  70. package/contracts/uasset-io/v1/fixtures/valid/project-index-dictionary-query-request.json +26 -0
  71. package/contracts/uasset-io/v1/request.schema.json +174 -0
  72. package/dist/authoring-review.d.ts +36 -36
  73. package/dist/authoring.d.ts +45 -45
  74. package/dist/authoring.d.ts.map +1 -1
  75. package/dist/blueprint-graph.d.ts +628 -0
  76. package/dist/blueprint-graph.d.ts.map +1 -0
  77. package/dist/blueprint-graph.js +111 -0
  78. package/dist/blueprint-graph.js.map +1 -0
  79. package/dist/companion.d.ts +34 -3
  80. package/dist/companion.d.ts.map +1 -1
  81. package/dist/companion.js +11 -0
  82. package/dist/companion.js.map +1 -1
  83. package/dist/editor-asset-navigation.d.ts +12 -12
  84. package/dist/editor-play-session.d.ts +6 -6
  85. package/dist/editor-world-control.d.ts +8 -8
  86. package/dist/index.d.ts +1 -0
  87. package/dist/index.d.ts.map +1 -1
  88. package/dist/index.js +1 -0
  89. package/dist/index.js.map +1 -1
  90. package/dist/saved-world.d.ts +20 -14
  91. package/dist/saved-world.d.ts.map +1 -1
  92. package/dist/saved-world.js +1 -0
  93. package/dist/saved-world.js.map +1 -1
  94. package/dist/uasset-inspection.d.ts +6 -5
  95. package/dist/uasset-inspection.d.ts.map +1 -1
  96. package/dist/uasset-inspection.js +1 -1
  97. package/dist/uasset-inspection.js.map +1 -1
  98. package/dist/uasset-io.d.ts +648 -129
  99. package/dist/uasset-io.d.ts.map +1 -1
  100. package/dist/uasset-io.js +51 -1
  101. package/dist/uasset-io.js.map +1 -1
  102. package/package.json +1 -1
package/contracts/cameras/render/v1/review-realization-result.schema.json ADDED
@@ -0,0 +1,454 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://ue-shed.dev/contracts/cameras/render/v1/review-realization-result.schema.json",
4
+ "anyOf": [
5
+ {
6
+ "type": "object",
7
+ "properties": {
8
+ "status": {
9
+ "type": "string",
10
+ "enum": ["resolved"]
11
+ },
12
+ "pose": {
13
+ "type": "object",
14
+ "properties": {
15
+ "aspectRatio": {
16
+ "type": "string",
17
+ "enum": ["16:9"]
18
+ },
19
+ "fieldOfViewDegrees": {
20
+ "type": "number",
21
+ "allOf": [
22
+ {
23
+ "minimum": 5,
24
+ "maximum": 170
25
+ }
26
+ ]
27
+ },
28
+ "location": {
29
+ "type": "object",
30
+ "properties": {
31
+ "x": {
32
+ "type": "number"
33
+ },
34
+ "y": {
35
+ "type": "number"
36
+ },
37
+ "z": {
38
+ "type": "number"
39
+ }
40
+ },
41
+ "required": ["x", "y", "z"],
42
+ "additionalProperties": false
43
+ },
44
+ "projection": {
45
+ "type": "string",
46
+ "enum": ["perspective"]
47
+ },
48
+ "rotation": {
49
+ "type": "object",
50
+ "properties": {
51
+ "pitch": {
52
+ "type": "number"
53
+ },
54
+ "roll": {
55
+ "type": "number"
56
+ },
57
+ "yaw": {
58
+ "type": "number"
59
+ }
60
+ },
61
+ "required": ["pitch", "roll", "yaw"],
62
+ "additionalProperties": false
63
+ }
64
+ },
65
+ "required": [
66
+ "aspectRatio",
67
+ "fieldOfViewDegrees",
68
+ "location",
69
+ "projection",
70
+ "rotation"
71
+ ],
72
+ "additionalProperties": false
73
+ },
74
+ "resolvedSubject": {
75
+ "anyOf": [
76
+ {
77
+ "type": "object",
78
+ "properties": {
79
+ "kind": {
80
+ "type": "string",
81
+ "enum": ["unresolved_actor"]
82
+ },
83
+ "subject": {
84
+ "anyOf": [
85
+ {
86
+ "type": "object",
87
+ "properties": {
88
+ "actorGuid": {
89
+ "type": "string",
90
+ "allOf": [
91
+ {
92
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
93
+ }
94
+ ]
95
+ },
96
+ "diagnosticLabel": {
97
+ "anyOf": [
98
+ {
99
+ "type": "string",
100
+ "allOf": [
101
+ {
102
+ "minLength": 1
103
+ }
104
+ ]
105
+ },
106
+ {
107
+ "type": "null"
108
+ }
109
+ ]
110
+ },
111
+ "kind": {
112
+ "type": "string",
113
+ "enum": ["actor_guid"]
114
+ },
115
+ "lastKnownActorPath": {
116
+ "anyOf": [
117
+ {
118
+ "type": "string",
119
+ "allOf": [
120
+ {
121
+ "minLength": 7
122
+ },
123
+ {
124
+ "maxLength": 4096
125
+ },
126
+ {
127
+ "pattern": "^\\/Game\\/"
128
+ }
129
+ ]
130
+ },
131
+ {
132
+ "type": "null"
133
+ }
134
+ ]
135
+ }
136
+ },
137
+ "required": ["actorGuid", "kind"],
138
+ "additionalProperties": false
139
+ },
140
+ {
141
+ "type": "object",
142
+ "properties": {
143
+ "actorPath": {
144
+ "type": "string",
145
+ "allOf": [
146
+ {
147
+ "minLength": 7
148
+ },
149
+ {
150
+ "maxLength": 4096
151
+ },
152
+ {
153
+ "pattern": "^\\/Game\\/"
154
+ }
155
+ ]
156
+ },
157
+ "diagnosticLabel": {
158
+ "anyOf": [
159
+ {
160
+ "type": "string",
161
+ "allOf": [
162
+ {
163
+ "minLength": 1
164
+ }
165
+ ]
166
+ },
167
+ {
168
+ "type": "null"
169
+ }
170
+ ]
171
+ },
172
+ "kind": {
173
+ "type": "string",
174
+ "enum": ["actor_path"]
175
+ }
176
+ },
177
+ "required": ["actorPath", "kind"],
178
+ "additionalProperties": false
179
+ }
180
+ ]
181
+ },
182
+ "reason": {
183
+ "type": "string",
184
+ "allOf": [
185
+ {
186
+ "minLength": 1
187
+ }
188
+ ]
189
+ }
190
+ },
191
+ "required": ["kind", "subject", "reason"],
192
+ "additionalProperties": false
193
+ },
194
+ {
195
+ "type": "object",
196
+ "properties": {
197
+ "actorGuid": {
198
+ "type": "string",
199
+ "allOf": [
200
+ {
201
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
202
+ }
203
+ ]
204
+ },
205
+ "actorPath": {
206
+ "type": "string",
207
+ "allOf": [
208
+ {
209
+ "minLength": 7
210
+ },
211
+ {
212
+ "maxLength": 4096
213
+ },
214
+ {
215
+ "pattern": "^\\/Game\\/"
216
+ }
217
+ ]
218
+ },
219
+ "kind": {
220
+ "type": "string",
221
+ "enum": ["actor_guid"]
222
+ },
223
+ "transform": {
224
+ "type": "object",
225
+ "properties": {
226
+ "location": {
227
+ "type": "object",
228
+ "properties": {
229
+ "x": {
230
+ "type": "number"
231
+ },
232
+ "y": {
233
+ "type": "number"
234
+ },
235
+ "z": {
236
+ "type": "number"
237
+ }
238
+ },
239
+ "required": ["x", "y", "z"],
240
+ "additionalProperties": false
241
+ },
242
+ "rotation": {
243
+ "type": "object",
244
+ "properties": {
245
+ "pitch": {
246
+ "type": "number"
247
+ },
248
+ "roll": {
249
+ "type": "number"
250
+ },
251
+ "yaw": {
252
+ "type": "number"
253
+ }
254
+ },
255
+ "required": ["pitch", "roll", "yaw"],
256
+ "additionalProperties": false
257
+ }
258
+ },
259
+ "required": ["location", "rotation"],
260
+ "additionalProperties": false
261
+ }
262
+ },
263
+ "required": ["actorGuid", "actorPath", "kind", "transform"],
264
+ "additionalProperties": false
265
+ },
266
+ {
267
+ "type": "object",
268
+ "properties": {
269
+ "actorPath": {
270
+ "type": "string",
271
+ "allOf": [
272
+ {
273
+ "minLength": 7
274
+ },
275
+ {
276
+ "maxLength": 4096
277
+ },
278
+ {
279
+ "pattern": "^\\/Game\\/"
280
+ }
281
+ ]
282
+ },
283
+ "kind": {
284
+ "type": "string",
285
+ "enum": ["actor_path"]
286
+ },
287
+ "transform": {
288
+ "type": "object",
289
+ "properties": {
290
+ "location": {
291
+ "type": "object",
292
+ "properties": {
293
+ "x": {
294
+ "type": "number"
295
+ },
296
+ "y": {
297
+ "type": "number"
298
+ },
299
+ "z": {
300
+ "type": "number"
301
+ }
302
+ },
303
+ "required": ["x", "y", "z"],
304
+ "additionalProperties": false
305
+ },
306
+ "rotation": {
307
+ "type": "object",
308
+ "properties": {
309
+ "pitch": {
310
+ "type": "number"
311
+ },
312
+ "roll": {
313
+ "type": "number"
314
+ },
315
+ "yaw": {
316
+ "type": "number"
317
+ }
318
+ },
319
+ "required": ["pitch", "roll", "yaw"],
320
+ "additionalProperties": false
321
+ }
322
+ },
323
+ "required": ["location", "rotation"],
324
+ "additionalProperties": false
325
+ }
326
+ },
327
+ "required": ["actorPath", "kind", "transform"],
328
+ "additionalProperties": false
329
+ },
330
+ {
331
+ "type": "object",
332
+ "properties": {
333
+ "bounds": {
334
+ "type": "object",
335
+ "properties": {
336
+ "center": {
337
+ "type": "object",
338
+ "properties": {
339
+ "x": {
340
+ "type": "number"
341
+ },
342
+ "y": {
343
+ "type": "number"
344
+ },
345
+ "z": {
346
+ "type": "number"
347
+ }
348
+ },
349
+ "required": ["x", "y", "z"],
350
+ "additionalProperties": false
351
+ },
352
+ "extent": {
353
+ "type": "object",
354
+ "properties": {
355
+ "x": {
356
+ "type": "number",
357
+ "allOf": [
358
+ {
359
+ "minimum": 0
360
+ }
361
+ ]
362
+ },
363
+ "y": {
364
+ "type": "number",
365
+ "allOf": [
366
+ {
367
+ "minimum": 0
368
+ }
369
+ ]
370
+ },
371
+ "z": {
372
+ "type": "number",
373
+ "allOf": [
374
+ {
375
+ "minimum": 0
376
+ }
377
+ ]
378
+ }
379
+ },
380
+ "required": ["x", "y", "z"],
381
+ "additionalProperties": false
382
+ },
383
+ "rotation": {
384
+ "type": "object",
385
+ "properties": {
386
+ "pitch": {
387
+ "type": "number"
388
+ },
389
+ "roll": {
390
+ "type": "number"
391
+ },
392
+ "yaw": {
393
+ "type": "number"
394
+ }
395
+ },
396
+ "required": ["pitch", "roll", "yaw"],
397
+ "additionalProperties": false
398
+ }
399
+ },
400
+ "required": ["center", "extent", "rotation"],
401
+ "additionalProperties": false
402
+ },
403
+ "kind": {
404
+ "type": "string",
405
+ "enum": ["oriented_bounds"]
406
+ }
407
+ },
408
+ "required": ["bounds", "kind"],
409
+ "additionalProperties": false
410
+ }
411
+ ]
412
+ }
413
+ },
414
+ "required": ["status", "pose"],
415
+ "additionalProperties": false
416
+ },
417
+ {
418
+ "type": "object",
419
+ "properties": {
420
+ "status": {
421
+ "type": "string",
422
+ "enum": ["failed"]
423
+ },
424
+ "code": {
425
+ "type": "string",
426
+ "allOf": [
427
+ {
428
+ "minLength": 1
429
+ }
430
+ ]
431
+ },
432
+ "message": {
433
+ "type": "string",
434
+ "allOf": [
435
+ {
436
+ "minLength": 1
437
+ }
438
+ ]
439
+ },
440
+ "recovery": {
441
+ "type": "string",
442
+ "allOf": [
443
+ {
444
+ "minLength": 1
445
+ }
446
+ ]
447
+ }
448
+ },
449
+ "required": ["status", "code", "message", "recovery"],
450
+ "additionalProperties": false
451
+ }
452
+ ],
453
+ "$defs": {}
454
+ }