@ue-shed/protocol 0.7.0 → 0.8.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 (79) hide show
  1. package/contracts/cameras/authoring/v1/README.md +50 -0
  2. package/contracts/cameras/authoring/v1/approval.schema.json +106 -0
  3. package/contracts/cameras/authoring/v1/arrangement.schema.json +1801 -0
  4. package/contracts/cameras/authoring/v1/bridge-request.schema.json +10862 -0
  5. package/contracts/cameras/authoring/v1/bridge-response.schema.json +10323 -0
  6. package/contracts/cameras/authoring/v1/command.schema.json +4109 -0
  7. package/contracts/cameras/authoring/v1/document.schema.json +4409 -0
  8. package/contracts/cameras/authoring/v1/panel-event.schema.json +4885 -0
  9. package/contracts/cameras/authoring/v1/panel-state.schema.json +3548 -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 +1621 -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 +1383 -96
  16. package/contracts/cameras/map-tile/v1/manifest.schema.json +1760 -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/begin-result.schema.json +167 -0
  21. package/contracts/cameras/render/v1/capabilities.schema.json +25 -0
  22. package/contracts/cameras/render/v1/frame-evidence.schema.json +240 -0
  23. package/contracts/cameras/render/v1/frame-status.schema.json +249 -0
  24. package/contracts/cameras/render/v1/policy.schema.json +159 -0
  25. package/contracts/cameras/render/v1/review-inspection-result.schema.json +263 -0
  26. package/contracts/cameras/render/v1/session-request.schema.json +167 -0
  27. package/contracts/cameras/review/v1/README.md +6 -0
  28. package/contracts/cameras/review/v1/capture-request.schema.json +221 -3
  29. package/contracts/cameras/review/v1/capture-response.schema.json +3648 -0
  30. package/contracts/cameras/review/v1/fixtures/capture-authored.json +205 -0
  31. package/contracts/core/v1/WINDOW-ACTIVATION.md +21 -0
  32. package/contracts/core/v1/window-activation-request.schema.json +20 -0
  33. package/contracts/core/v1/window-activation-result.schema.json +49 -0
  34. package/contracts/editor-world/v1/README.md +27 -0
  35. package/contracts/editor-world/v1/operation.schema.json +761 -0
  36. package/contracts/editor-world/v1/state.schema.json +92 -0
  37. package/contracts/uasset-io/v1/event.schema.json +613 -171
  38. package/contracts/uasset-io/v1/fixtures/invalid/inspect-string-table-nonstring-metadata.json +53 -0
  39. package/contracts/uasset-io/v1/fixtures/invalid/negative-instanced-size.json +97 -0
  40. package/contracts/uasset-io/v1/fixtures/invalid/non-string-metadata.json +97 -0
  41. package/contracts/uasset-io/v1/fixtures/invalid/unknown-native-value.json +97 -0
  42. package/contracts/uasset-io/v1/fixtures/valid/extract-text-string-table-occurrence-result-event.json +30 -0
  43. package/contracts/uasset-io/v1/fixtures/valid/inspect-native-result-event.json +97 -0
  44. package/contracts/uasset-io/v1/fixtures/valid/inspect-string-table-metadata-result-event.json +53 -0
  45. package/contracts/world/preparation/v1/fixtures/invalid-contract-version.json +10 -0
  46. package/contracts/world/preparation/v1/fixtures/invalid-extra-field.json +11 -0
  47. package/contracts/world/preparation/v1/fixtures/invalid-negative-budget.json +37 -0
  48. package/contracts/world/preparation/v1/fixtures/invalid-region-negative-extent.json +40 -0
  49. package/contracts/world/preparation/v1/fixtures/valid-actor-context.json +37 -0
  50. package/contracts/world/preparation/v1/fixtures/valid-describe.json +10 -0
  51. package/contracts/world/preparation/v1/request.schema.json +897 -0
  52. package/contracts/world/preparation/v1/response.schema.json +449 -0
  53. package/dist/cameras.d.ts +16 -12
  54. package/dist/cameras.d.ts.map +1 -1
  55. package/dist/cameras.js +1 -0
  56. package/dist/cameras.js.map +1 -1
  57. package/dist/companion.d.ts +6 -0
  58. package/dist/companion.d.ts.map +1 -1
  59. package/dist/companion.js +3 -0
  60. package/dist/companion.js.map +1 -1
  61. package/dist/editor-window-activation.d.ts +16 -0
  62. package/dist/editor-window-activation.d.ts.map +1 -0
  63. package/dist/editor-window-activation.js +19 -0
  64. package/dist/editor-window-activation.js.map +1 -0
  65. package/dist/editor-world-control.d.ts +125 -0
  66. package/dist/editor-world-control.d.ts.map +1 -1
  67. package/dist/editor-world-control.js +25 -0
  68. package/dist/editor-world-control.js.map +1 -1
  69. package/dist/index.d.ts +1 -0
  70. package/dist/index.d.ts.map +1 -1
  71. package/dist/index.js +1 -0
  72. package/dist/index.js.map +1 -1
  73. package/dist/uasset-inspection.d.ts +112 -55
  74. package/dist/uasset-inspection.d.ts.map +1 -1
  75. package/dist/uasset-inspection.js +29 -0
  76. package/dist/uasset-inspection.js.map +1 -1
  77. package/dist/uasset-io.d.ts +54 -0
  78. package/dist/uasset-io.d.ts.map +1 -1
  79. package/package.json +1 -1
@@ -1,69 +1,518 @@
1
1
  {
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://ue-shed.dev/contracts/cameras/map-tile/v1/capture-request.schema.json",
4
- "title": "UE Shed bounded map tile capture request v1.0",
5
4
  "type": "object",
6
- "additionalProperties": false,
7
- "required": [
8
- "capture",
9
- "contract",
10
- "correlationId",
11
- "expectedMapPath",
12
- "gutterPixels",
13
- "operationId",
14
- "planId",
15
- "runId",
16
- "tilePixelSize",
17
- "tiles"
18
- ],
19
5
  "properties": {
20
- "capture": { "$ref": "plan.schema.json#/$defs/capturePolicy" },
6
+ "capture": {
7
+ "type": "object",
8
+ "properties": {
9
+ "visibility": {
10
+ "type": "object",
11
+ "properties": {
12
+ "hide": {
13
+ "type": "array",
14
+ "items": {
15
+ "type": "object",
16
+ "properties": {
17
+ "locator": {
18
+ "anyOf": [
19
+ {
20
+ "type": "object",
21
+ "properties": {
22
+ "kind": {
23
+ "type": "string",
24
+ "enum": ["actor_path"]
25
+ },
26
+ "actorPath": {
27
+ "type": "string",
28
+ "allOf": [
29
+ {
30
+ "pattern": "^\\/Game\\/"
31
+ },
32
+ {
33
+ "maxLength": 4096
34
+ }
35
+ ]
36
+ }
37
+ },
38
+ "required": ["kind", "actorPath"],
39
+ "additionalProperties": false
40
+ },
41
+ {
42
+ "type": "object",
43
+ "properties": {
44
+ "kind": {
45
+ "type": "string",
46
+ "enum": ["actor_guid"]
47
+ },
48
+ "actorGuid": {
49
+ "type": "string",
50
+ "allOf": [
51
+ {
52
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
53
+ }
54
+ ]
55
+ },
56
+ "lastKnownActorPath": {
57
+ "type": "string",
58
+ "allOf": [
59
+ {
60
+ "maxLength": 4096
61
+ }
62
+ ]
63
+ }
64
+ },
65
+ "required": [
66
+ "kind",
67
+ "actorGuid",
68
+ "lastKnownActorPath"
69
+ ],
70
+ "additionalProperties": false
71
+ }
72
+ ]
73
+ },
74
+ "label": {
75
+ "type": "string",
76
+ "allOf": [
77
+ {
78
+ "maxLength": 256
79
+ }
80
+ ]
81
+ }
82
+ },
83
+ "required": ["locator", "label"],
84
+ "additionalProperties": false
85
+ },
86
+ "allOf": [
87
+ {
88
+ "maxItems": 256
89
+ }
90
+ ]
91
+ },
92
+ "protect": {
93
+ "type": "array",
94
+ "items": {
95
+ "type": "object",
96
+ "properties": {
97
+ "locator": {
98
+ "anyOf": [
99
+ {
100
+ "type": "object",
101
+ "properties": {
102
+ "kind": {
103
+ "type": "string",
104
+ "enum": ["actor_path"]
105
+ },
106
+ "actorPath": {
107
+ "type": "string",
108
+ "allOf": [
109
+ {
110
+ "pattern": "^\\/Game\\/"
111
+ },
112
+ {
113
+ "maxLength": 4096
114
+ }
115
+ ]
116
+ }
117
+ },
118
+ "required": ["kind", "actorPath"],
119
+ "additionalProperties": false
120
+ },
121
+ {
122
+ "type": "object",
123
+ "properties": {
124
+ "kind": {
125
+ "type": "string",
126
+ "enum": ["actor_guid"]
127
+ },
128
+ "actorGuid": {
129
+ "type": "string",
130
+ "allOf": [
131
+ {
132
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
133
+ }
134
+ ]
135
+ },
136
+ "lastKnownActorPath": {
137
+ "type": "string",
138
+ "allOf": [
139
+ {
140
+ "maxLength": 4096
141
+ }
142
+ ]
143
+ }
144
+ },
145
+ "required": [
146
+ "kind",
147
+ "actorGuid",
148
+ "lastKnownActorPath"
149
+ ],
150
+ "additionalProperties": false
151
+ }
152
+ ]
153
+ },
154
+ "label": {
155
+ "type": "string",
156
+ "allOf": [
157
+ {
158
+ "maxLength": 256
159
+ }
160
+ ]
161
+ }
162
+ },
163
+ "required": ["locator", "label"],
164
+ "additionalProperties": false
165
+ },
166
+ "allOf": [
167
+ {
168
+ "maxItems": 256
169
+ }
170
+ ]
171
+ }
172
+ },
173
+ "required": ["hide", "protect"],
174
+ "additionalProperties": false
175
+ },
176
+ "dataLayers": {
177
+ "anyOf": [
178
+ {
179
+ "type": "object",
180
+ "properties": {
181
+ "mode": {
182
+ "type": "string",
183
+ "enum": ["unchanged"]
184
+ }
185
+ },
186
+ "required": ["mode"],
187
+ "additionalProperties": false
188
+ },
189
+ {
190
+ "type": "object",
191
+ "properties": {
192
+ "mode": {
193
+ "type": "string",
194
+ "enum": ["explicit"]
195
+ },
196
+ "states": {
197
+ "type": "array",
198
+ "items": {
199
+ "type": "object",
200
+ "properties": {
201
+ "name": {
202
+ "type": "string",
203
+ "allOf": [
204
+ {
205
+ "minLength": 1
206
+ },
207
+ {
208
+ "maxLength": 1024
209
+ }
210
+ ]
211
+ },
212
+ "state": {
213
+ "type": "string",
214
+ "enum": ["unloaded", "loaded", "activated"]
215
+ }
216
+ },
217
+ "required": ["name", "state"],
218
+ "additionalProperties": false
219
+ },
220
+ "allOf": [
221
+ {
222
+ "maxItems": 64
223
+ }
224
+ ]
225
+ }
226
+ },
227
+ "required": ["mode", "states"],
228
+ "additionalProperties": false
229
+ }
230
+ ]
231
+ },
232
+ "orientation": {
233
+ "type": "object",
234
+ "properties": {
235
+ "pitch": {
236
+ "type": "number",
237
+ "enum": [-90]
238
+ },
239
+ "roll": {
240
+ "type": "number",
241
+ "enum": [0]
242
+ },
243
+ "yaw": {
244
+ "type": "number",
245
+ "enum": [0]
246
+ }
247
+ },
248
+ "required": ["pitch", "roll", "yaw"],
249
+ "additionalProperties": false
250
+ },
251
+ "render": {
252
+ "type": "object",
253
+ "properties": {
254
+ "exposureEV100": {
255
+ "type": "number",
256
+ "allOf": [
257
+ {
258
+ "minimum": -20,
259
+ "maximum": 30
260
+ }
261
+ ]
262
+ },
263
+ "effects": {
264
+ "type": "object",
265
+ "properties": {
266
+ "fog": {
267
+ "type": "boolean"
268
+ },
269
+ "volumetricFog": {
270
+ "type": "boolean"
271
+ }
272
+ },
273
+ "required": ["fog", "volumetricFog"],
274
+ "additionalProperties": false
275
+ },
276
+ "lodDistanceScaleByZoom": {
277
+ "type": "array",
278
+ "items": {
279
+ "type": "number",
280
+ "allOf": [
281
+ {
282
+ "minimum": 0.1,
283
+ "maximum": 100
284
+ }
285
+ ]
286
+ },
287
+ "allOf": [
288
+ {
289
+ "minItems": 1
290
+ },
291
+ {
292
+ "maxItems": 24
293
+ }
294
+ ]
295
+ },
296
+ "lodPolicy": {
297
+ "type": "string",
298
+ "enum": ["natural", "fixed_lod_zero", "per_level_distance_scale"]
299
+ },
300
+ "profile": {
301
+ "type": "string",
302
+ "enum": [
303
+ "full_fidelity",
304
+ "seam_stable",
305
+ "scene_capture_defaults",
306
+ "observation"
307
+ ]
308
+ }
309
+ },
310
+ "required": ["effects", "lodPolicy", "profile"],
311
+ "additionalProperties": false
312
+ },
313
+ "z": {
314
+ "type": "number"
315
+ }
316
+ },
317
+ "required": ["dataLayers", "orientation", "render", "z"],
318
+ "additionalProperties": false
319
+ },
21
320
  "captureBackend": {
321
+ "type": "string",
22
322
  "enum": ["lit_camera_tiles", "scene_capture_tiles", "viewport_high_resolution"]
23
323
  },
24
- "overviewBounds": { "$ref": "plan.schema.json#/$defs/bounds" },
324
+ "overviewBounds": {
325
+ "type": "object",
326
+ "properties": {
327
+ "minX": {
328
+ "type": "number"
329
+ },
330
+ "minY": {
331
+ "type": "number"
332
+ },
333
+ "maxX": {
334
+ "type": "number"
335
+ },
336
+ "maxY": {
337
+ "type": "number"
338
+ }
339
+ },
340
+ "required": ["minX", "minY", "maxX", "maxY"],
341
+ "additionalProperties": false
342
+ },
25
343
  "contract": {
26
344
  "type": "object",
27
- "additionalProperties": false,
28
- "required": ["name", "version"],
29
345
  "properties": {
30
- "name": { "const": "ue-shed-map-tile-capture" },
31
- "version": { "$ref": "plan.schema.json#/$defs/version" }
32
- }
346
+ "name": {
347
+ "type": "string",
348
+ "enum": ["ue-shed-map-tile-capture"]
349
+ },
350
+ "version": {
351
+ "type": "object",
352
+ "properties": {
353
+ "major": {
354
+ "type": "number",
355
+ "enum": [1]
356
+ },
357
+ "minor": {
358
+ "type": "number",
359
+ "enum": [0, 1, 2]
360
+ }
361
+ },
362
+ "required": ["major", "minor"],
363
+ "additionalProperties": false
364
+ }
365
+ },
366
+ "required": ["name", "version"],
367
+ "additionalProperties": false
368
+ },
369
+ "correlationId": {
370
+ "type": "string",
371
+ "allOf": [
372
+ {
373
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
374
+ }
375
+ ]
376
+ },
377
+ "expectedMapPath": {
378
+ "type": "string",
379
+ "allOf": [
380
+ {
381
+ "pattern": "^\\/[A-Za-z0-9_./-]+$"
382
+ }
383
+ ]
384
+ },
385
+ "gutterPixels": {
386
+ "type": "integer",
387
+ "allOf": [
388
+ {
389
+ "minimum": 0,
390
+ "maximum": 32
391
+ }
392
+ ]
393
+ },
394
+ "operationId": {
395
+ "type": "string",
396
+ "allOf": [
397
+ {
398
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
399
+ }
400
+ ]
401
+ },
402
+ "planId": {
403
+ "type": "string",
404
+ "allOf": [
405
+ {
406
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
407
+ }
408
+ ]
409
+ },
410
+ "runId": {
411
+ "type": "string",
412
+ "allOf": [
413
+ {
414
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
415
+ }
416
+ ]
417
+ },
418
+ "tilePixelSize": {
419
+ "type": "integer",
420
+ "allOf": [
421
+ {
422
+ "minimum": 64,
423
+ "maximum": 4096
424
+ }
425
+ ]
33
426
  },
34
- "correlationId": { "$ref": "plan.schema.json#/$defs/id" },
35
- "expectedMapPath": { "type": "string", "pattern": "^/[A-Za-z0-9_./-]+$" },
36
- "gutterPixels": { "type": "integer", "minimum": 0, "maximum": 32 },
37
- "operationId": { "$ref": "plan.schema.json#/$defs/id" },
38
- "planId": { "$ref": "plan.schema.json#/$defs/id" },
39
- "runId": { "$ref": "plan.schema.json#/$defs/id" },
40
- "tilePixelSize": { "type": "integer", "minimum": 64, "maximum": 4096 },
41
427
  "tiles": {
42
428
  "type": "array",
43
- "minItems": 1,
44
- "maxItems": 64,
45
429
  "items": {
46
430
  "type": "object",
47
- "additionalProperties": false,
48
- "required": ["key", "unitsPerPixel", "worldBounds"],
49
431
  "properties": {
50
- "key": { "$ref": "#/$defs/tileKey" },
51
- "unitsPerPixel": { "type": "number", "exclusiveMinimum": 0 },
52
- "worldBounds": { "$ref": "plan.schema.json#/$defs/bounds" }
432
+ "key": {
433
+ "type": "object",
434
+ "properties": {
435
+ "zoom": {
436
+ "type": "integer",
437
+ "allOf": [
438
+ {
439
+ "minimum": 0
440
+ }
441
+ ]
442
+ },
443
+ "row": {
444
+ "type": "integer",
445
+ "allOf": [
446
+ {
447
+ "minimum": 0
448
+ }
449
+ ]
450
+ },
451
+ "column": {
452
+ "type": "integer",
453
+ "allOf": [
454
+ {
455
+ "minimum": 0
456
+ }
457
+ ]
458
+ }
459
+ },
460
+ "required": ["zoom", "row", "column"],
461
+ "additionalProperties": false
462
+ },
463
+ "unitsPerPixel": {
464
+ "type": "number",
465
+ "allOf": [
466
+ {
467
+ "exclusiveMinimum": 0
468
+ }
469
+ ]
470
+ },
471
+ "worldBounds": {
472
+ "type": "object",
473
+ "properties": {
474
+ "minX": {
475
+ "type": "number"
476
+ },
477
+ "minY": {
478
+ "type": "number"
479
+ },
480
+ "maxX": {
481
+ "type": "number"
482
+ },
483
+ "maxY": {
484
+ "type": "number"
485
+ }
486
+ },
487
+ "required": ["minX", "minY", "maxX", "maxY"],
488
+ "additionalProperties": false
489
+ }
490
+ },
491
+ "required": ["key", "unitsPerPixel", "worldBounds"],
492
+ "additionalProperties": false
493
+ },
494
+ "allOf": [
495
+ {
496
+ "minItems": 1
497
+ },
498
+ {
499
+ "maxItems": 64
53
500
  }
54
- }
501
+ ]
55
502
  }
56
503
  },
57
- "$defs": {
58
- "tileKey": {
59
- "type": "object",
60
- "additionalProperties": false,
61
- "required": ["zoom", "row", "column"],
62
- "properties": {
63
- "zoom": { "type": "integer", "minimum": 0 },
64
- "row": { "type": "integer", "minimum": 0 },
65
- "column": { "type": "integer", "minimum": 0 }
66
- }
67
- }
68
- }
504
+ "required": [
505
+ "capture",
506
+ "contract",
507
+ "correlationId",
508
+ "expectedMapPath",
509
+ "gutterPixels",
510
+ "operationId",
511
+ "planId",
512
+ "runId",
513
+ "tilePixelSize",
514
+ "tiles"
515
+ ],
516
+ "additionalProperties": false,
517
+ "$defs": {}
69
518
  }