@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
@@ -11,14 +11,22 @@
11
11
  "additionalProperties": false,
12
12
  "required": ["name", "version"],
13
13
  "properties": {
14
- "name": { "const": "ue-shed-review-capture" },
14
+ "name": {
15
+ "const": "ue-shed-review-capture"
16
+ },
15
17
  "version": {
16
18
  "type": "object",
17
19
  "additionalProperties": false,
18
20
  "required": ["major", "minor"],
19
21
  "properties": {
20
- "major": { "const": 1 },
21
- "minor": { "type": "integer", "minimum": 0, "maximum": 5 }
22
+ "major": {
23
+ "const": 1
24
+ },
25
+ "minor": {
26
+ "type": "integer",
27
+ "minimum": 0,
28
+ "maximum": 6
29
+ }
22
30
  }
23
31
  }
24
32
  }
@@ -27,10 +35,17 @@
27
35
  "type": "string",
28
36
  "format": "uuid",
29
37
  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
30
- "not": { "const": "00000000-0000-0000-0000-000000000000" }
38
+ "not": {
39
+ "const": "00000000-0000-0000-0000-000000000000"
40
+ }
41
+ },
42
+ "viewId": {
43
+ "$ref": "#/$defs/safeId"
44
+ },
45
+ "expectedMapPath": {
46
+ "type": "string",
47
+ "minLength": 1
31
48
  },
32
- "viewId": { "$ref": "#/$defs/safeId" },
33
- "expectedMapPath": { "type": "string", "minLength": 1 },
34
49
  "subject": {
35
50
  "oneOf": [
36
51
  {
@@ -38,11 +53,15 @@
38
53
  "additionalProperties": false,
39
54
  "required": ["kind", "actorGuid"],
40
55
  "properties": {
41
- "kind": { "const": "actor_guid" },
56
+ "kind": {
57
+ "const": "actor_guid"
58
+ },
42
59
  "actorGuid": {
43
60
  "type": "string",
44
61
  "pattern": "^[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$",
45
- "not": { "const": "00000000-00000000-00000000-00000000" }
62
+ "not": {
63
+ "const": "00000000-00000000-00000000-00000000"
64
+ }
46
65
  },
47
66
  "lastKnownActorPath": {
48
67
  "type": "string",
@@ -50,7 +69,10 @@
50
69
  "maxLength": 4096,
51
70
  "pattern": "^/Game/"
52
71
  },
53
- "diagnosticLabel": { "type": "string", "minLength": 1 }
72
+ "diagnosticLabel": {
73
+ "type": "string",
74
+ "minLength": 1
75
+ }
54
76
  }
55
77
  },
56
78
  {
@@ -58,14 +80,19 @@
58
80
  "additionalProperties": false,
59
81
  "required": ["kind", "actorPath"],
60
82
  "properties": {
61
- "kind": { "const": "actor_path" },
83
+ "kind": {
84
+ "const": "actor_path"
85
+ },
62
86
  "actorPath": {
63
87
  "type": "string",
64
88
  "minLength": 7,
65
89
  "maxLength": 4096,
66
90
  "pattern": "^/Game/"
67
91
  },
68
- "diagnosticLabel": { "type": "string", "minLength": 1 }
92
+ "diagnosticLabel": {
93
+ "type": "string",
94
+ "minLength": 1
95
+ }
69
96
  }
70
97
  },
71
98
  {
@@ -73,8 +100,12 @@
73
100
  "additionalProperties": false,
74
101
  "required": ["kind", "bounds"],
75
102
  "properties": {
76
- "kind": { "const": "oriented_bounds" },
77
- "bounds": { "$ref": "#/$defs/bounds" }
103
+ "kind": {
104
+ "const": "oriented_bounds"
105
+ },
106
+ "bounds": {
107
+ "$ref": "#/$defs/bounds"
108
+ }
78
109
  }
79
110
  }
80
111
  ]
@@ -84,11 +115,23 @@
84
115
  "additionalProperties": false,
85
116
  "required": ["aspectRatio", "fieldOfViewDegrees", "location", "projection", "rotation"],
86
117
  "properties": {
87
- "aspectRatio": { "const": "16:9" },
88
- "fieldOfViewDegrees": { "type": "number", "minimum": 5, "maximum": 170 },
89
- "projection": { "const": "perspective" },
90
- "location": { "$ref": "#/$defs/vector" },
91
- "rotation": { "$ref": "#/$defs/rotation" }
118
+ "aspectRatio": {
119
+ "const": "16:9"
120
+ },
121
+ "fieldOfViewDegrees": {
122
+ "type": "number",
123
+ "minimum": 5,
124
+ "maximum": 170
125
+ },
126
+ "projection": {
127
+ "const": "perspective"
128
+ },
129
+ "location": {
130
+ "$ref": "#/$defs/vector"
131
+ },
132
+ "rotation": {
133
+ "$ref": "#/$defs/rotation"
134
+ }
92
135
  }
93
136
  },
94
137
  "resolution": {
@@ -96,13 +139,30 @@
96
139
  "additionalProperties": false,
97
140
  "required": ["width", "height"],
98
141
  "properties": {
99
- "width": { "type": "integer", "minimum": 160, "maximum": 3840 },
100
- "height": { "type": "integer", "minimum": 90, "maximum": 2160 }
142
+ "width": {
143
+ "type": "integer",
144
+ "minimum": 160,
145
+ "maximum": 3840
146
+ },
147
+ "height": {
148
+ "type": "integer",
149
+ "minimum": 90,
150
+ "maximum": 2160
151
+ }
101
152
  }
102
153
  },
103
- "assessment": { "$ref": "#/$defs/assessment" },
104
- "clearCompanion": { "$ref": "#/$defs/clearCompanion" },
105
- "viewpoint": { "$ref": "#/$defs/viewpoint" }
154
+ "assessment": {
155
+ "$ref": "#/$defs/assessment"
156
+ },
157
+ "clearCompanion": {
158
+ "$ref": "#/$defs/clearCompanion"
159
+ },
160
+ "viewpoint": {
161
+ "$ref": "#/$defs/viewpoint"
162
+ },
163
+ "renderPolicy": {
164
+ "$ref": "../../render/v1/policy.schema.json"
165
+ }
106
166
  },
107
167
  "allOf": [
108
168
  {
@@ -110,33 +170,59 @@
110
170
  "properties": {
111
171
  "contract": {
112
172
  "properties": {
113
- "version": { "properties": { "minor": { "enum": [2, 3, 4, 5] } } }
173
+ "version": {
174
+ "properties": {
175
+ "minor": {
176
+ "enum": [2, 3, 4, 5, 6]
177
+ }
178
+ }
179
+ }
114
180
  }
115
181
  }
116
182
  }
117
183
  },
118
- "then": { "required": ["assessment", "viewpoint"] },
119
- "else": { "required": ["approvedPose"] }
184
+ "then": {
185
+ "required": ["assessment", "viewpoint"]
186
+ },
187
+ "else": {
188
+ "required": ["approvedPose"]
189
+ }
120
190
  },
121
191
  {
122
192
  "if": {
123
193
  "properties": {
124
194
  "contract": {
125
195
  "properties": {
126
- "version": { "properties": { "minor": { "enum": [4, 5] } } }
196
+ "version": {
197
+ "properties": {
198
+ "minor": {
199
+ "enum": [4, 5, 6]
200
+ }
201
+ }
202
+ }
127
203
  }
128
204
  }
129
205
  }
130
206
  },
131
- "then": { "required": ["clearCompanion"] },
132
- "else": { "not": { "required": ["clearCompanion"] } }
207
+ "then": {
208
+ "required": ["clearCompanion"]
209
+ },
210
+ "else": {
211
+ "not": {
212
+ "required": ["clearCompanion"]
213
+ }
214
+ }
133
215
  },
134
216
  {
135
217
  "if": {
136
218
  "properties": {
137
219
  "subject": {
138
220
  "required": ["kind"],
139
- "properties": { "kind": { "const": "actor_guid" } }
221
+ "properties": {
222
+ "kind": {
223
+ "const": "actor_guid"
224
+ }
225
+ }
140
226
  }
141
227
  }
142
228
  },
@@ -144,23 +230,63 @@
144
230
  "properties": {
145
231
  "contract": {
146
232
  "properties": {
147
- "version": { "properties": { "minor": { "const": 5 } } }
233
+ "version": {
234
+ "properties": {
235
+ "minor": {
236
+ "enum": [5, 6]
237
+ }
238
+ }
239
+ }
148
240
  }
149
241
  }
150
242
  }
151
243
  }
244
+ },
245
+ {
246
+ "if": {
247
+ "properties": {
248
+ "contract": {
249
+ "properties": {
250
+ "version": {
251
+ "properties": {
252
+ "minor": {
253
+ "const": 6
254
+ }
255
+ }
256
+ }
257
+ }
258
+ }
259
+ }
260
+ },
261
+ "then": {
262
+ "required": ["renderPolicy"]
263
+ },
264
+ "else": {
265
+ "not": {
266
+ "required": ["renderPolicy"]
267
+ }
268
+ }
152
269
  }
153
270
  ],
154
271
  "$defs": {
155
- "safeId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" },
272
+ "safeId": {
273
+ "type": "string",
274
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
275
+ },
156
276
  "vector": {
157
277
  "type": "object",
158
278
  "additionalProperties": false,
159
279
  "required": ["x", "y", "z"],
160
280
  "properties": {
161
- "x": { "type": "number" },
162
- "y": { "type": "number" },
163
- "z": { "type": "number" }
281
+ "x": {
282
+ "type": "number"
283
+ },
284
+ "y": {
285
+ "type": "number"
286
+ },
287
+ "z": {
288
+ "type": "number"
289
+ }
164
290
  }
165
291
  },
166
292
  "rotation": {
@@ -168,9 +294,15 @@
168
294
  "additionalProperties": false,
169
295
  "required": ["pitch", "yaw", "roll"],
170
296
  "properties": {
171
- "pitch": { "type": "number" },
172
- "yaw": { "type": "number" },
173
- "roll": { "type": "number" }
297
+ "pitch": {
298
+ "type": "number"
299
+ },
300
+ "yaw": {
301
+ "type": "number"
302
+ },
303
+ "roll": {
304
+ "type": "number"
305
+ }
174
306
  }
175
307
  },
176
308
  "bounds": {
@@ -178,9 +310,15 @@
178
310
  "additionalProperties": false,
179
311
  "required": ["center", "extent", "rotation"],
180
312
  "properties": {
181
- "center": { "$ref": "#/$defs/vector" },
182
- "extent": { "$ref": "#/$defs/vector" },
183
- "rotation": { "$ref": "#/$defs/rotation" }
313
+ "center": {
314
+ "$ref": "#/$defs/vector"
315
+ },
316
+ "extent": {
317
+ "$ref": "#/$defs/vector"
318
+ },
319
+ "rotation": {
320
+ "$ref": "#/$defs/rotation"
321
+ }
184
322
  }
185
323
  },
186
324
  "assessment": {
@@ -189,22 +327,34 @@
189
327
  "type": "object",
190
328
  "additionalProperties": false,
191
329
  "required": ["method"],
192
- "properties": { "method": { "const": "automatic" } }
330
+ "properties": {
331
+ "method": {
332
+ "const": "automatic"
333
+ }
334
+ }
193
335
  },
194
336
  {
195
337
  "type": "object",
196
338
  "additionalProperties": false,
197
339
  "required": ["method", "samplePreset"],
198
340
  "properties": {
199
- "method": { "const": "ray_samples" },
200
- "samplePreset": { "enum": ["sparse", "standard", "dense"] }
341
+ "method": {
342
+ "const": "ray_samples"
343
+ },
344
+ "samplePreset": {
345
+ "enum": ["sparse", "standard", "dense"]
346
+ }
201
347
  }
202
348
  },
203
349
  {
204
350
  "type": "object",
205
351
  "additionalProperties": false,
206
352
  "required": ["method"],
207
- "properties": { "method": { "enum": ["subject_mask", "depth_compare"] } }
353
+ "properties": {
354
+ "method": {
355
+ "enum": ["subject_mask", "depth_compare"]
356
+ }
357
+ }
208
358
  }
209
359
  ]
210
360
  },
@@ -214,15 +364,23 @@
214
364
  "type": "object",
215
365
  "additionalProperties": false,
216
366
  "required": ["status"],
217
- "properties": { "status": { "const": "not_requested" } }
367
+ "properties": {
368
+ "status": {
369
+ "const": "not_requested"
370
+ }
371
+ }
218
372
  },
219
373
  {
220
374
  "type": "object",
221
375
  "additionalProperties": false,
222
376
  "required": ["status", "strategy"],
223
377
  "properties": {
224
- "status": { "const": "requested" },
225
- "strategy": { "const": "isolate_target" }
378
+ "status": {
379
+ "const": "requested"
380
+ },
381
+ "strategy": {
382
+ "const": "isolate_target"
383
+ }
226
384
  }
227
385
  },
228
386
  {
@@ -242,8 +400,12 @@
242
400
  "pattern": "^/Game/"
243
401
  }
244
402
  },
245
- "status": { "const": "requested" },
246
- "strategy": { "const": "hide_explicit" }
403
+ "status": {
404
+ "const": "requested"
405
+ },
406
+ "strategy": {
407
+ "const": "hide_explicit"
408
+ }
247
409
  }
248
410
  }
249
411
  ]
@@ -255,8 +417,12 @@
255
417
  "additionalProperties": false,
256
418
  "required": ["kind", "approvedPose"],
257
419
  "properties": {
258
- "kind": { "const": "world_fixed" },
259
- "approvedPose": { "$ref": "#/$defs/pose" }
420
+ "kind": {
421
+ "const": "world_fixed"
422
+ },
423
+ "approvedPose": {
424
+ "$ref": "#/$defs/pose"
425
+ }
260
426
  }
261
427
  },
262
428
  {
@@ -264,15 +430,23 @@
264
430
  "additionalProperties": false,
265
431
  "required": ["kind", "relativePose", "targetSnapshot"],
266
432
  "properties": {
267
- "kind": { "const": "target_relative" },
268
- "relativePose": { "$ref": "#/$defs/pose" },
433
+ "kind": {
434
+ "const": "target_relative"
435
+ },
436
+ "relativePose": {
437
+ "$ref": "#/$defs/pose"
438
+ },
269
439
  "targetSnapshot": {
270
440
  "type": "object",
271
441
  "additionalProperties": false,
272
442
  "required": ["location", "rotation"],
273
443
  "properties": {
274
- "location": { "$ref": "#/$defs/vector" },
275
- "rotation": { "$ref": "#/$defs/rotation" }
444
+ "location": {
445
+ "$ref": "#/$defs/vector"
446
+ },
447
+ "rotation": {
448
+ "$ref": "#/$defs/rotation"
449
+ }
276
450
  }
277
451
  }
278
452
  }
@@ -284,11 +458,23 @@
284
458
  "additionalProperties": false,
285
459
  "required": ["aspectRatio", "fieldOfViewDegrees", "location", "projection", "rotation"],
286
460
  "properties": {
287
- "aspectRatio": { "const": "16:9" },
288
- "fieldOfViewDegrees": { "type": "number", "minimum": 5, "maximum": 170 },
289
- "projection": { "const": "perspective" },
290
- "location": { "$ref": "#/$defs/vector" },
291
- "rotation": { "$ref": "#/$defs/rotation" }
461
+ "aspectRatio": {
462
+ "const": "16:9"
463
+ },
464
+ "fieldOfViewDegrees": {
465
+ "type": "number",
466
+ "minimum": 5,
467
+ "maximum": 170
468
+ },
469
+ "projection": {
470
+ "const": "perspective"
471
+ },
472
+ "location": {
473
+ "$ref": "#/$defs/vector"
474
+ },
475
+ "rotation": {
476
+ "$ref": "#/$defs/rotation"
477
+ }
292
478
  }
293
479
  }
294
480
  }