@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
package/contracts/cameras/render/v1/begin-result.schema.json CHANGED
@@ -20,6 +20,173 @@
20
20
  "resolvedPolicy": {
21
21
  "type": "object",
22
22
  "properties": {
23
+ "visibility": {
24
+ "type": "object",
25
+ "properties": {
26
+ "hide": {
27
+ "type": "array",
28
+ "items": {
29
+ "type": "object",
30
+ "properties": {
31
+ "locator": {
32
+ "anyOf": [
33
+ {
34
+ "type": "object",
35
+ "properties": {
36
+ "kind": {
37
+ "type": "string",
38
+ "enum": ["actor_path"]
39
+ },
40
+ "actorPath": {
41
+ "type": "string",
42
+ "allOf": [
43
+ {
44
+ "pattern": "^\\/Game\\/"
45
+ },
46
+ {
47
+ "maxLength": 4096
48
+ }
49
+ ]
50
+ }
51
+ },
52
+ "required": ["kind", "actorPath"],
53
+ "additionalProperties": false
54
+ },
55
+ {
56
+ "type": "object",
57
+ "properties": {
58
+ "kind": {
59
+ "type": "string",
60
+ "enum": ["actor_guid"]
61
+ },
62
+ "actorGuid": {
63
+ "type": "string",
64
+ "allOf": [
65
+ {
66
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
67
+ }
68
+ ]
69
+ },
70
+ "lastKnownActorPath": {
71
+ "type": "string",
72
+ "allOf": [
73
+ {
74
+ "maxLength": 4096
75
+ }
76
+ ]
77
+ }
78
+ },
79
+ "required": [
80
+ "kind",
81
+ "actorGuid",
82
+ "lastKnownActorPath"
83
+ ],
84
+ "additionalProperties": false
85
+ }
86
+ ]
87
+ },
88
+ "label": {
89
+ "type": "string",
90
+ "allOf": [
91
+ {
92
+ "maxLength": 256
93
+ }
94
+ ]
95
+ }
96
+ },
97
+ "required": ["locator", "label"],
98
+ "additionalProperties": false
99
+ },
100
+ "allOf": [
101
+ {
102
+ "maxItems": 256
103
+ }
104
+ ]
105
+ },
106
+ "protect": {
107
+ "type": "array",
108
+ "items": {
109
+ "type": "object",
110
+ "properties": {
111
+ "locator": {
112
+ "anyOf": [
113
+ {
114
+ "type": "object",
115
+ "properties": {
116
+ "kind": {
117
+ "type": "string",
118
+ "enum": ["actor_path"]
119
+ },
120
+ "actorPath": {
121
+ "type": "string",
122
+ "allOf": [
123
+ {
124
+ "pattern": "^\\/Game\\/"
125
+ },
126
+ {
127
+ "maxLength": 4096
128
+ }
129
+ ]
130
+ }
131
+ },
132
+ "required": ["kind", "actorPath"],
133
+ "additionalProperties": false
134
+ },
135
+ {
136
+ "type": "object",
137
+ "properties": {
138
+ "kind": {
139
+ "type": "string",
140
+ "enum": ["actor_guid"]
141
+ },
142
+ "actorGuid": {
143
+ "type": "string",
144
+ "allOf": [
145
+ {
146
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
147
+ }
148
+ ]
149
+ },
150
+ "lastKnownActorPath": {
151
+ "type": "string",
152
+ "allOf": [
153
+ {
154
+ "maxLength": 4096
155
+ }
156
+ ]
157
+ }
158
+ },
159
+ "required": [
160
+ "kind",
161
+ "actorGuid",
162
+ "lastKnownActorPath"
163
+ ],
164
+ "additionalProperties": false
165
+ }
166
+ ]
167
+ },
168
+ "label": {
169
+ "type": "string",
170
+ "allOf": [
171
+ {
172
+ "maxLength": 256
173
+ }
174
+ ]
175
+ }
176
+ },
177
+ "required": ["locator", "label"],
178
+ "additionalProperties": false
179
+ },
180
+ "allOf": [
181
+ {
182
+ "maxItems": 256
183
+ }
184
+ ]
185
+ }
186
+ },
187
+ "required": ["hide", "protect"],
188
+ "additionalProperties": false
189
+ },
23
190
  "renderer": {
24
191
  "anyOf": [
25
192
  {
package/contracts/cameras/render/v1/capabilities.schema.json CHANGED
@@ -3,6 +3,31 @@
3
3
  "$id": "https://ue-shed.dev/contracts/cameras/render/v1/capabilities.schema.json",
4
4
  "type": "object",
5
5
  "properties": {
6
+ "authoredVisibility": {
7
+ "type": "object",
8
+ "properties": {
9
+ "version": {
10
+ "type": "number",
11
+ "enum": [1]
12
+ },
13
+ "maximumActorsPerList": {
14
+ "type": "number",
15
+ "enum": [256]
16
+ },
17
+ "geometry": {
18
+ "type": "string",
19
+ "enum": ["loaded_non_nanite_opaque_static_mesh_actors"]
20
+ },
21
+ "viewport": {
22
+ "type": "boolean"
23
+ },
24
+ "sceneCapture": {
25
+ "type": "boolean"
26
+ }
27
+ },
28
+ "required": ["version", "maximumActorsPerList", "geometry", "viewport", "sceneCapture"],
29
+ "additionalProperties": false
30
+ },
6
31
  "contract": {
7
32
  "type": "object",
8
33
  "properties": {
package/contracts/cameras/render/v1/frame-evidence.schema.json CHANGED
@@ -3,6 +3,79 @@
3
3
  "$id": "https://ue-shed.dev/contracts/cameras/render/v1/frame-evidence.schema.json",
4
4
  "type": "object",
5
5
  "properties": {
6
+ "visibilityDiagnostics": {
7
+ "type": "array",
8
+ "items": {
9
+ "type": "object",
10
+ "properties": {
11
+ "locator": {
12
+ "anyOf": [
13
+ {
14
+ "type": "object",
15
+ "properties": {
16
+ "kind": {
17
+ "type": "string",
18
+ "enum": ["actor_path"]
19
+ },
20
+ "actorPath": {
21
+ "type": "string",
22
+ "allOf": [
23
+ {
24
+ "pattern": "^\\/Game\\/"
25
+ },
26
+ {
27
+ "maxLength": 4096
28
+ }
29
+ ]
30
+ }
31
+ },
32
+ "required": ["kind", "actorPath"],
33
+ "additionalProperties": false
34
+ },
35
+ {
36
+ "type": "object",
37
+ "properties": {
38
+ "kind": {
39
+ "type": "string",
40
+ "enum": ["actor_guid"]
41
+ },
42
+ "actorGuid": {
43
+ "type": "string",
44
+ "allOf": [
45
+ {
46
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
47
+ }
48
+ ]
49
+ },
50
+ "lastKnownActorPath": {
51
+ "type": "string",
52
+ "allOf": [
53
+ {
54
+ "maxLength": 4096
55
+ }
56
+ ]
57
+ }
58
+ },
59
+ "required": ["kind", "actorGuid", "lastKnownActorPath"],
60
+ "additionalProperties": false
61
+ }
62
+ ]
63
+ },
64
+ "status": {
65
+ "type": "string",
66
+ "enum": ["resolved", "missing_or_unloaded", "ambiguous", "unsupported"]
67
+ },
68
+ "actorPath": {
69
+ "type": "string"
70
+ },
71
+ "message": {
72
+ "type": "string"
73
+ }
74
+ },
75
+ "required": ["locator", "status", "actorPath", "message"],
76
+ "additionalProperties": false
77
+ }
78
+ },
6
79
  "editorState": {
7
80
  "type": "object",
8
81
  "properties": {
@@ -129,6 +202,173 @@
129
202
  "policy": {
130
203
  "type": "object",
131
204
  "properties": {
205
+ "visibility": {
206
+ "type": "object",
207
+ "properties": {
208
+ "hide": {
209
+ "type": "array",
210
+ "items": {
211
+ "type": "object",
212
+ "properties": {
213
+ "locator": {
214
+ "anyOf": [
215
+ {
216
+ "type": "object",
217
+ "properties": {
218
+ "kind": {
219
+ "type": "string",
220
+ "enum": ["actor_path"]
221
+ },
222
+ "actorPath": {
223
+ "type": "string",
224
+ "allOf": [
225
+ {
226
+ "pattern": "^\\/Game\\/"
227
+ },
228
+ {
229
+ "maxLength": 4096
230
+ }
231
+ ]
232
+ }
233
+ },
234
+ "required": ["kind", "actorPath"],
235
+ "additionalProperties": false
236
+ },
237
+ {
238
+ "type": "object",
239
+ "properties": {
240
+ "kind": {
241
+ "type": "string",
242
+ "enum": ["actor_guid"]
243
+ },
244
+ "actorGuid": {
245
+ "type": "string",
246
+ "allOf": [
247
+ {
248
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
249
+ }
250
+ ]
251
+ },
252
+ "lastKnownActorPath": {
253
+ "type": "string",
254
+ "allOf": [
255
+ {
256
+ "maxLength": 4096
257
+ }
258
+ ]
259
+ }
260
+ },
261
+ "required": [
262
+ "kind",
263
+ "actorGuid",
264
+ "lastKnownActorPath"
265
+ ],
266
+ "additionalProperties": false
267
+ }
268
+ ]
269
+ },
270
+ "label": {
271
+ "type": "string",
272
+ "allOf": [
273
+ {
274
+ "maxLength": 256
275
+ }
276
+ ]
277
+ }
278
+ },
279
+ "required": ["locator", "label"],
280
+ "additionalProperties": false
281
+ },
282
+ "allOf": [
283
+ {
284
+ "maxItems": 256
285
+ }
286
+ ]
287
+ },
288
+ "protect": {
289
+ "type": "array",
290
+ "items": {
291
+ "type": "object",
292
+ "properties": {
293
+ "locator": {
294
+ "anyOf": [
295
+ {
296
+ "type": "object",
297
+ "properties": {
298
+ "kind": {
299
+ "type": "string",
300
+ "enum": ["actor_path"]
301
+ },
302
+ "actorPath": {
303
+ "type": "string",
304
+ "allOf": [
305
+ {
306
+ "pattern": "^\\/Game\\/"
307
+ },
308
+ {
309
+ "maxLength": 4096
310
+ }
311
+ ]
312
+ }
313
+ },
314
+ "required": ["kind", "actorPath"],
315
+ "additionalProperties": false
316
+ },
317
+ {
318
+ "type": "object",
319
+ "properties": {
320
+ "kind": {
321
+ "type": "string",
322
+ "enum": ["actor_guid"]
323
+ },
324
+ "actorGuid": {
325
+ "type": "string",
326
+ "allOf": [
327
+ {
328
+ "pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
329
+ }
330
+ ]
331
+ },
332
+ "lastKnownActorPath": {
333
+ "type": "string",
334
+ "allOf": [
335
+ {
336
+ "maxLength": 4096
337
+ }
338
+ ]
339
+ }
340
+ },
341
+ "required": [
342
+ "kind",
343
+ "actorGuid",
344
+ "lastKnownActorPath"
345
+ ],
346
+ "additionalProperties": false
347
+ }
348
+ ]
349
+ },
350
+ "label": {
351
+ "type": "string",
352
+ "allOf": [
353
+ {
354
+ "maxLength": 256
355
+ }
356
+ ]
357
+ }
358
+ },
359
+ "required": ["locator", "label"],
360
+ "additionalProperties": false
361
+ },
362
+ "allOf": [
363
+ {
364
+ "maxItems": 256
365
+ }
366
+ ]
367
+ }
368
+ },
369
+ "required": ["hide", "protect"],
370
+ "additionalProperties": false
371
+ },
132
372
  "renderer": {
133
373
  "anyOf": [
134
374
  {