@ue-shed/protocol 0.7.1 → 0.9.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 (100) hide show
  1. package/contracts/cameras/authoring/v1/README.md +63 -0
  2. package/contracts/cameras/authoring/v1/approval.schema.json +106 -0
  3. package/contracts/cameras/authoring/v1/arrangement.schema.json +1807 -0
  4. package/contracts/cameras/authoring/v1/bridge-request.schema.json +11077 -0
  5. package/contracts/cameras/authoring/v1/bridge-response.schema.json +10523 -0
  6. package/contracts/cameras/authoring/v1/command.schema.json +4115 -0
  7. package/contracts/cameras/authoring/v1/document.schema.json +4421 -0
  8. package/contracts/cameras/authoring/v1/panel-event.schema.json +4891 -0
  9. package/contracts/cameras/authoring/v1/panel-state.schema.json +3560 -0
  10. package/contracts/cameras/authoring/v1/recipe.schema.json +340 -0
  11. package/contracts/cameras/authoring/v1/visibility-preset.schema.json +205 -0
  12. package/contracts/cameras/map-tile/v1/README.md +4 -1
  13. package/contracts/cameras/map-tile/v1/capture-operation.schema.json +1643 -30
  14. package/contracts/cameras/map-tile/v1/capture-request.schema.json +497 -48
  15. package/contracts/cameras/map-tile/v1/capture-response.schema.json +1405 -96
  16. package/contracts/cameras/map-tile/v1/manifest.schema.json +1782 -110
  17. package/contracts/cameras/map-tile/v1/plan.schema.json +394 -200
  18. package/contracts/cameras/map-tile/v1/release-result.schema.json +7 -2
  19. package/contracts/cameras/provisioning/v1/provision-request.schema.json +663 -141
  20. package/contracts/cameras/render/v1/README.md +6 -0
  21. package/contracts/cameras/render/v1/begin-result.schema.json +173 -0
  22. package/contracts/cameras/render/v1/capabilities.schema.json +46 -0
  23. package/contracts/cameras/render/v1/fixtures/invalid-session-editor-previews-type.json +41 -0
  24. package/contracts/cameras/render/v1/fixtures/session-editor-previews.json +41 -0
  25. package/contracts/cameras/render/v1/fixtures/session-scene-capture-editor-previews.json +40 -0
  26. package/contracts/cameras/render/v1/frame-evidence.schema.json +262 -0
  27. package/contracts/cameras/render/v1/frame-status.schema.json +271 -0
  28. package/contracts/cameras/render/v1/policy.schema.json +165 -0
  29. package/contracts/cameras/render/v1/review-inspection-result.schema.json +285 -0
  30. package/contracts/cameras/render/v1/session-request.schema.json +173 -0
  31. package/contracts/cameras/review/v1/README.md +6 -0
  32. package/contracts/cameras/review/v1/capture-request.schema.json +221 -3
  33. package/contracts/cameras/review/v1/capture-response.schema.json +3692 -0
  34. package/contracts/cameras/review/v1/fixtures/capture-authored.json +205 -0
  35. package/contracts/core/v1/WINDOW-ACTIVATION.md +21 -0
  36. package/contracts/core/v1/window-activation-request.schema.json +20 -0
  37. package/contracts/core/v1/window-activation-result.schema.json +49 -0
  38. package/contracts/editor-world/v1/README.md +27 -0
  39. package/contracts/editor-world/v1/operation.schema.json +761 -0
  40. package/contracts/editor-world/v1/state.schema.json +92 -0
  41. package/contracts/uasset-io/v1/README.md +24 -0
  42. package/contracts/uasset-io/v1/event.schema.json +2642 -290
  43. package/contracts/uasset-io/v1/fixtures/invalid/inspect-string-table-nonstring-metadata.json +53 -0
  44. package/contracts/uasset-io/v1/fixtures/invalid/level-sequence-version.json +43 -0
  45. package/contracts/uasset-io/v1/fixtures/invalid/negative-instanced-size.json +97 -0
  46. package/contracts/uasset-io/v1/fixtures/invalid/non-string-metadata.json +97 -0
  47. package/contracts/uasset-io/v1/fixtures/invalid/unknown-native-value.json +97 -0
  48. package/contracts/uasset-io/v1/fixtures/valid/blueprint-request.json +15 -3
  49. package/contracts/uasset-io/v1/fixtures/valid/blueprint-result-event.json +22 -5
  50. package/contracts/uasset-io/v1/fixtures/valid/extract-text-string-table-occurrence-result-event.json +30 -0
  51. package/contracts/uasset-io/v1/fixtures/valid/inspect-native-result-event.json +97 -0
  52. package/contracts/uasset-io/v1/fixtures/valid/inspect-string-table-metadata-result-event.json +53 -0
  53. package/contracts/uasset-io/v1/fixtures/valid/level-sequence-request.json +18 -0
  54. package/contracts/uasset-io/v1/fixtures/valid/level-sequence-result-event.json +43 -0
  55. package/contracts/uasset-io/v1/request.schema.json +14 -0
  56. package/contracts/world/preparation/v1/fixtures/invalid-contract-version.json +10 -0
  57. package/contracts/world/preparation/v1/fixtures/invalid-extra-field.json +11 -0
  58. package/contracts/world/preparation/v1/fixtures/invalid-negative-budget.json +37 -0
  59. package/contracts/world/preparation/v1/fixtures/invalid-region-negative-extent.json +40 -0
  60. package/contracts/world/preparation/v1/fixtures/valid-actor-context.json +37 -0
  61. package/contracts/world/preparation/v1/fixtures/valid-describe.json +10 -0
  62. package/contracts/world/preparation/v1/request.schema.json +897 -0
  63. package/contracts/world/preparation/v1/response.schema.json +449 -0
  64. package/dist/blueprint-graph.d.ts +332 -8
  65. package/dist/blueprint-graph.d.ts.map +1 -1
  66. package/dist/blueprint-graph.js +42 -3
  67. package/dist/blueprint-graph.js.map +1 -1
  68. package/dist/cameras.d.ts +16 -12
  69. package/dist/cameras.d.ts.map +1 -1
  70. package/dist/cameras.js +1 -0
  71. package/dist/cameras.js.map +1 -1
  72. package/dist/companion.d.ts +6 -0
  73. package/dist/companion.d.ts.map +1 -1
  74. package/dist/companion.js +3 -0
  75. package/dist/companion.js.map +1 -1
  76. package/dist/editor-window-activation.d.ts +16 -0
  77. package/dist/editor-window-activation.d.ts.map +1 -0
  78. package/dist/editor-window-activation.js +19 -0
  79. package/dist/editor-window-activation.js.map +1 -0
  80. package/dist/editor-world-control.d.ts +125 -0
  81. package/dist/editor-world-control.d.ts.map +1 -1
  82. package/dist/editor-world-control.js +25 -0
  83. package/dist/editor-world-control.js.map +1 -1
  84. package/dist/index.d.ts +2 -0
  85. package/dist/index.d.ts.map +1 -1
  86. package/dist/index.js +2 -0
  87. package/dist/index.js.map +1 -1
  88. package/dist/level-sequence.d.ts +1315 -0
  89. package/dist/level-sequence.d.ts.map +1 -0
  90. package/dist/level-sequence.js +204 -0
  91. package/dist/level-sequence.js.map +1 -0
  92. package/dist/uasset-inspection.d.ts +128 -55
  93. package/dist/uasset-inspection.d.ts.map +1 -1
  94. package/dist/uasset-inspection.js +39 -2
  95. package/dist/uasset-inspection.js.map +1 -1
  96. package/dist/uasset-io.d.ts +1302 -9
  97. package/dist/uasset-io.d.ts.map +1 -1
  98. package/dist/uasset-io.js +4 -0
  99. package/dist/uasset-io.js.map +1 -1
  100. package/package.json +1 -1
package/contracts/world/preparation/v1/response.schema.json ADDED
@@ -0,0 +1,449 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://ue-shed.dev/contracts/world/preparation/v1/response.schema.json",
4
+ "anyOf": [
5
+ {
6
+ "type": "object",
7
+ "properties": {
8
+ "status": {
9
+ "type": "string",
10
+ "enum": ["described"]
11
+ },
12
+ "world": {
13
+ "type": "object",
14
+ "properties": {
15
+ "worldId": {
16
+ "type": "string",
17
+ "allOf": [
18
+ {
19
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
20
+ }
21
+ ]
22
+ },
23
+ "mapPath": {
24
+ "type": "string",
25
+ "allOf": [
26
+ {
27
+ "minLength": 1
28
+ },
29
+ {
30
+ "maxLength": 1024
31
+ }
32
+ ]
33
+ },
34
+ "projectName": {
35
+ "type": "string",
36
+ "allOf": [
37
+ {
38
+ "minLength": 1
39
+ },
40
+ {
41
+ "maxLength": 1024
42
+ }
43
+ ]
44
+ },
45
+ "partitioned": {
46
+ "type": "boolean"
47
+ },
48
+ "streamingEnabled": {
49
+ "type": "boolean"
50
+ }
51
+ },
52
+ "required": [
53
+ "worldId",
54
+ "mapPath",
55
+ "projectName",
56
+ "partitioned",
57
+ "streamingEnabled"
58
+ ],
59
+ "additionalProperties": false
60
+ }
61
+ },
62
+ "required": ["status", "world"],
63
+ "additionalProperties": false
64
+ },
65
+ {
66
+ "type": "object",
67
+ "properties": {
68
+ "status": {
69
+ "type": "string",
70
+ "enum": ["planned", "ready", "blocked", "released"]
71
+ },
72
+ "world": {
73
+ "type": "object",
74
+ "properties": {
75
+ "worldId": {
76
+ "type": "string",
77
+ "allOf": [
78
+ {
79
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
80
+ }
81
+ ]
82
+ },
83
+ "mapPath": {
84
+ "type": "string",
85
+ "allOf": [
86
+ {
87
+ "minLength": 1
88
+ },
89
+ {
90
+ "maxLength": 1024
91
+ }
92
+ ]
93
+ },
94
+ "projectName": {
95
+ "type": "string",
96
+ "allOf": [
97
+ {
98
+ "minLength": 1
99
+ },
100
+ {
101
+ "maxLength": 1024
102
+ }
103
+ ]
104
+ },
105
+ "partitioned": {
106
+ "type": "boolean"
107
+ },
108
+ "streamingEnabled": {
109
+ "type": "boolean"
110
+ }
111
+ },
112
+ "required": [
113
+ "worldId",
114
+ "mapPath",
115
+ "projectName",
116
+ "partitioned",
117
+ "streamingEnabled"
118
+ ],
119
+ "additionalProperties": false
120
+ },
121
+ "leaseId": {
122
+ "type": "string",
123
+ "allOf": [
124
+ {
125
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
126
+ }
127
+ ]
128
+ },
129
+ "revision": {
130
+ "type": "integer",
131
+ "allOf": [
132
+ {
133
+ "minimum": 0,
134
+ "maximum": 1000000
135
+ }
136
+ ]
137
+ },
138
+ "regions": {
139
+ "type": "array",
140
+ "items": {
141
+ "type": "object",
142
+ "properties": {
143
+ "center": {
144
+ "type": "object",
145
+ "properties": {
146
+ "x": {
147
+ "type": "number"
148
+ },
149
+ "y": {
150
+ "type": "number"
151
+ },
152
+ "z": {
153
+ "type": "number"
154
+ }
155
+ },
156
+ "required": ["x", "y", "z"],
157
+ "additionalProperties": false
158
+ },
159
+ "extent": {
160
+ "type": "object",
161
+ "properties": {
162
+ "x": {
163
+ "type": "number",
164
+ "allOf": [
165
+ {
166
+ "minimum": 0,
167
+ "maximum": 10000000
168
+ }
169
+ ]
170
+ },
171
+ "y": {
172
+ "type": "number",
173
+ "allOf": [
174
+ {
175
+ "minimum": 0,
176
+ "maximum": 10000000
177
+ }
178
+ ]
179
+ },
180
+ "z": {
181
+ "type": "number",
182
+ "allOf": [
183
+ {
184
+ "minimum": 0,
185
+ "maximum": 10000000
186
+ }
187
+ ]
188
+ }
189
+ },
190
+ "required": ["x", "y", "z"],
191
+ "additionalProperties": false
192
+ }
193
+ },
194
+ "required": ["center", "extent"],
195
+ "additionalProperties": false
196
+ },
197
+ "allOf": [
198
+ {
199
+ "maxItems": 64
200
+ }
201
+ ]
202
+ },
203
+ "actors": {
204
+ "type": "array",
205
+ "items": {
206
+ "type": "object",
207
+ "properties": {
208
+ "actorGuid": {
209
+ "type": "string",
210
+ "allOf": [
211
+ {
212
+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
213
+ }
214
+ ]
215
+ },
216
+ "containerId": {
217
+ "type": "string",
218
+ "allOf": [
219
+ {
220
+ "minLength": 1
221
+ },
222
+ {
223
+ "maxLength": 1024
224
+ }
225
+ ]
226
+ },
227
+ "label": {
228
+ "type": "string"
229
+ },
230
+ "classPath": {
231
+ "type": "string",
232
+ "allOf": [
233
+ {
234
+ "minLength": 1
235
+ },
236
+ {
237
+ "maxLength": 1024
238
+ }
239
+ ]
240
+ },
241
+ "region": {
242
+ "anyOf": [
243
+ {
244
+ "type": "object",
245
+ "properties": {
246
+ "center": {
247
+ "type": "object",
248
+ "properties": {
249
+ "x": {
250
+ "type": "number"
251
+ },
252
+ "y": {
253
+ "type": "number"
254
+ },
255
+ "z": {
256
+ "type": "number"
257
+ }
258
+ },
259
+ "required": ["x", "y", "z"],
260
+ "additionalProperties": false
261
+ },
262
+ "extent": {
263
+ "type": "object",
264
+ "properties": {
265
+ "x": {
266
+ "type": "number",
267
+ "allOf": [
268
+ {
269
+ "minimum": 0
270
+ }
271
+ ]
272
+ },
273
+ "y": {
274
+ "type": "number",
275
+ "allOf": [
276
+ {
277
+ "minimum": 0
278
+ }
279
+ ]
280
+ },
281
+ "z": {
282
+ "type": "number",
283
+ "allOf": [
284
+ {
285
+ "minimum": 0
286
+ }
287
+ ]
288
+ }
289
+ },
290
+ "required": ["x", "y", "z"],
291
+ "additionalProperties": false
292
+ }
293
+ },
294
+ "required": ["center", "extent"],
295
+ "additionalProperties": false
296
+ },
297
+ {
298
+ "type": "null"
299
+ }
300
+ ]
301
+ },
302
+ "spatiallyLoaded": {
303
+ "type": "boolean"
304
+ },
305
+ "loaded": {
306
+ "type": "boolean"
307
+ },
308
+ "registered": {
309
+ "type": "boolean"
310
+ },
311
+ "visible": {
312
+ "type": "boolean"
313
+ },
314
+ "dependency": {
315
+ "type": "boolean"
316
+ }
317
+ },
318
+ "required": [
319
+ "actorGuid",
320
+ "containerId",
321
+ "label",
322
+ "classPath",
323
+ "region",
324
+ "spatiallyLoaded",
325
+ "loaded",
326
+ "registered",
327
+ "visible",
328
+ "dependency"
329
+ ],
330
+ "additionalProperties": false
331
+ },
332
+ "allOf": [
333
+ {
334
+ "maxItems": 100000
335
+ }
336
+ ]
337
+ },
338
+ "issues": {
339
+ "type": "array",
340
+ "items": {
341
+ "type": "object",
342
+ "properties": {
343
+ "code": {
344
+ "type": "string",
345
+ "allOf": [
346
+ {
347
+ "minLength": 1
348
+ },
349
+ {
350
+ "maxLength": 1024
351
+ }
352
+ ]
353
+ },
354
+ "subject": {
355
+ "type": "string",
356
+ "allOf": [
357
+ {
358
+ "minLength": 1
359
+ },
360
+ {
361
+ "maxLength": 1024
362
+ }
363
+ ]
364
+ },
365
+ "message": {
366
+ "type": "string",
367
+ "allOf": [
368
+ {
369
+ "minLength": 1
370
+ },
371
+ {
372
+ "maxLength": 1024
373
+ }
374
+ ]
375
+ }
376
+ },
377
+ "required": ["code", "subject", "message"],
378
+ "additionalProperties": false
379
+ },
380
+ "allOf": [
381
+ {
382
+ "maxItems": 128
383
+ }
384
+ ]
385
+ },
386
+ "renderReadiness": {
387
+ "type": "string",
388
+ "enum": ["not_assessed"]
389
+ }
390
+ },
391
+ "required": [
392
+ "status",
393
+ "world",
394
+ "leaseId",
395
+ "revision",
396
+ "regions",
397
+ "actors",
398
+ "issues",
399
+ "renderReadiness"
400
+ ],
401
+ "additionalProperties": false
402
+ },
403
+ {
404
+ "type": "object",
405
+ "properties": {
406
+ "status": {
407
+ "type": "string",
408
+ "enum": ["failed"]
409
+ },
410
+ "code": {
411
+ "type": "string",
412
+ "allOf": [
413
+ {
414
+ "minLength": 1
415
+ },
416
+ {
417
+ "maxLength": 1024
418
+ }
419
+ ]
420
+ },
421
+ "message": {
422
+ "type": "string",
423
+ "allOf": [
424
+ {
425
+ "minLength": 1
426
+ },
427
+ {
428
+ "maxLength": 1024
429
+ }
430
+ ]
431
+ },
432
+ "recovery": {
433
+ "type": "string",
434
+ "allOf": [
435
+ {
436
+ "minLength": 1
437
+ },
438
+ {
439
+ "maxLength": 1024
440
+ }
441
+ ]
442
+ }
443
+ },
444
+ "required": ["status", "code", "message", "recovery"],
445
+ "additionalProperties": false
446
+ }
447
+ ],
448
+ "$defs": {}
449
+ }