@ue-shed/protocol 0.1.0-rc.1

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 (72) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +35 -0
  3. package/contracts/asset-audits/v1/texture-preview.schema.json +74 -0
  4. package/contracts/authoring/README.md +25 -0
  5. package/contracts/authoring/v1/apply-request.schema.json +568 -0
  6. package/contracts/authoring/v1/apply-result.schema.json +1165 -0
  7. package/contracts/authoring/v1/save-request.schema.json +53 -0
  8. package/contracts/authoring/v1/save-result.schema.json +77 -0
  9. package/contracts/authoring/v1/table-list.schema.json +48 -0
  10. package/contracts/authoring/v1/table-snapshot.schema.json +497 -0
  11. package/contracts/authoring/v2/table-snapshot.schema.json +950 -0
  12. package/contracts/cameras/review/v1/README.md +39 -0
  13. package/contracts/cameras/review/v1/capture-request.schema.json +92 -0
  14. package/contracts/cameras/review/v1/capture-response.schema.json +158 -0
  15. package/contracts/cameras/review/v1/fixtures/capture-failure.json +13 -0
  16. package/contracts/cameras/review/v1/fixtures/capture-legacy.json +17 -0
  17. package/contracts/cameras/review/v1/fixtures/capture-projected.json +33 -0
  18. package/contracts/cameras/review/v1/fixtures/capture-request-valid.json +21 -0
  19. package/contracts/cameras/review/v1/fixtures/capture-unprojectable.json +22 -0
  20. package/contracts/cameras/review/v1/fixtures/invalid-capture-request-bad-fov.json +21 -0
  21. package/contracts/cameras/review/v1/fixtures/invalid-capture-response-projected-without-margins.json +27 -0
  22. package/contracts/cameras/review/v1/fixtures/invalid-selection-unknown-code.json +11 -0
  23. package/contracts/cameras/review/v1/fixtures/selection-selected.json +15 -0
  24. package/contracts/cameras/review/v1/fixtures/selection-subject-not-found.json +11 -0
  25. package/contracts/cameras/review/v1/selection-response.schema.json +103 -0
  26. package/contracts/cameras/v1/README.md +33 -0
  27. package/contracts/editor-session/v1/README.md +11 -0
  28. package/contracts/editor-session/v1/command-response.schema.json +44 -0
  29. package/contracts/editor-session/v1/fixtures/command-accepted.json +6 -0
  30. package/contracts/editor-session/v1/fixtures/command-already-satisfied.json +6 -0
  31. package/contracts/editor-session/v1/fixtures/command-rejected.json +9 -0
  32. package/contracts/editor-session/v1/fixtures/state-paused.json +4 -0
  33. package/contracts/editor-session/v1/fixtures/state-running.json +4 -0
  34. package/contracts/editor-session/v1/fixtures/state-starting.json +4 -0
  35. package/contracts/editor-session/v1/fixtures/state-stopped.json +4 -0
  36. package/contracts/editor-session/v1/fixtures/state-stopping.json +4 -0
  37. package/contracts/editor-session/v1/state-response.schema.json +64 -0
  38. package/contracts/observatory/v1/README.md +78 -0
  39. package/contracts/observatory/v1/fixtures/bad-magic-then-valid.bin +0 -0
  40. package/contracts/observatory/v1/fixtures/fragmented-concat.bin +0 -0
  41. package/contracts/observatory/v1/fixtures/heartbeat.bin +0 -0
  42. package/contracts/observatory/v1/fixtures/mismatched-payload-length.bin +0 -0
  43. package/contracts/observatory/v1/fixtures/oversized-record-count.bin +0 -0
  44. package/contracts/observatory/v1/fixtures/reset.bin +0 -0
  45. package/contracts/observatory/v1/fixtures/truncated.bin +0 -0
  46. package/contracts/observatory/v1/fixtures/two-records.bin +0 -0
  47. package/contracts/observatory/v1/fixtures/unsupported-version.bin +0 -0
  48. package/dist/authoring-review.d.ts +679 -0
  49. package/dist/authoring-review.d.ts.map +1 -0
  50. package/dist/authoring-review.js +90 -0
  51. package/dist/authoring-review.js.map +1 -0
  52. package/dist/authoring.d.ts +889 -0
  53. package/dist/authoring.d.ts.map +1 -0
  54. package/dist/authoring.js +350 -0
  55. package/dist/authoring.js.map +1 -0
  56. package/dist/cameras.d.ts +184 -0
  57. package/dist/cameras.d.ts.map +1 -0
  58. package/dist/cameras.js +72 -0
  59. package/dist/cameras.js.map +1 -0
  60. package/dist/companion.d.ts +33 -0
  61. package/dist/companion.d.ts.map +1 -0
  62. package/dist/companion.js +18 -0
  63. package/dist/companion.js.map +1 -0
  64. package/dist/editor-play-session.d.ts +278 -0
  65. package/dist/editor-play-session.d.ts.map +1 -0
  66. package/dist/editor-play-session.js +56 -0
  67. package/dist/editor-play-session.js.map +1 -0
  68. package/dist/index.d.ts +146 -0
  69. package/dist/index.d.ts.map +1 -0
  70. package/dist/index.js +106 -0
  71. package/dist/index.js.map +1 -0
  72. package/package.json +45 -0
package/contracts/authoring/v1/save-request.schema.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$defs": {
4
+ "AuthoringSaveRequest": {
5
+ "type": "object",
6
+ "required": ["contract", "objectPaths", "requestId"],
7
+ "properties": {
8
+ "contract": {
9
+ "type": "object",
10
+ "required": ["name", "version"],
11
+ "properties": {
12
+ "name": {
13
+ "type": "string",
14
+ "enum": ["unreal-authoring-save"]
15
+ },
16
+ "version": {
17
+ "type": "object",
18
+ "required": ["major", "minor"],
19
+ "properties": {
20
+ "major": {
21
+ "type": "number",
22
+ "enum": [1]
23
+ },
24
+ "minor": {
25
+ "$ref": "#/$defs/NonNegativeInt"
26
+ }
27
+ },
28
+ "additionalProperties": false
29
+ }
30
+ },
31
+ "additionalProperties": false
32
+ },
33
+ "objectPaths": {
34
+ "type": "array",
35
+ "items": {
36
+ "type": "string"
37
+ }
38
+ },
39
+ "requestId": {
40
+ "type": "string"
41
+ }
42
+ },
43
+ "additionalProperties": false
44
+ },
45
+ "NonNegativeInt": {
46
+ "type": "integer",
47
+ "description": "an integer",
48
+ "title": "int",
49
+ "minimum": 0
50
+ }
51
+ },
52
+ "$ref": "#/$defs/AuthoringSaveRequest"
53
+ }
package/contracts/authoring/v1/save-result.schema.json ADDED
@@ -0,0 +1,77 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$defs": {
4
+ "AuthoringSaveResult": {
5
+ "type": "object",
6
+ "required": ["contract", "packages", "requestId", "status"],
7
+ "properties": {
8
+ "contract": {
9
+ "type": "object",
10
+ "required": ["name", "version"],
11
+ "properties": {
12
+ "name": {
13
+ "type": "string",
14
+ "enum": ["unreal-authoring-save"]
15
+ },
16
+ "version": {
17
+ "type": "object",
18
+ "required": ["major", "minor"],
19
+ "properties": {
20
+ "major": {
21
+ "type": "number",
22
+ "enum": [1]
23
+ },
24
+ "minor": {
25
+ "$ref": "#/$defs/NonNegativeInt"
26
+ }
27
+ },
28
+ "additionalProperties": false
29
+ }
30
+ },
31
+ "additionalProperties": false
32
+ },
33
+ "packages": {
34
+ "type": "array",
35
+ "items": {
36
+ "type": "object",
37
+ "required": ["objectPath", "packageName", "retrySafe", "status"],
38
+ "properties": {
39
+ "message": {
40
+ "type": "string"
41
+ },
42
+ "objectPath": {
43
+ "type": "string"
44
+ },
45
+ "packageName": {
46
+ "type": "string"
47
+ },
48
+ "retrySafe": {
49
+ "type": "boolean"
50
+ },
51
+ "status": {
52
+ "type": "string",
53
+ "enum": ["saved", "failed"]
54
+ }
55
+ },
56
+ "additionalProperties": false
57
+ }
58
+ },
59
+ "requestId": {
60
+ "type": "string"
61
+ },
62
+ "status": {
63
+ "type": "string",
64
+ "enum": ["complete", "partial", "failed"]
65
+ }
66
+ },
67
+ "additionalProperties": false
68
+ },
69
+ "NonNegativeInt": {
70
+ "type": "integer",
71
+ "description": "an integer",
72
+ "title": "int",
73
+ "minimum": 0
74
+ }
75
+ },
76
+ "$ref": "#/$defs/AuthoringSaveResult"
77
+ }
package/contracts/authoring/v1/table-list.schema.json ADDED
@@ -0,0 +1,48 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$defs": {
4
+ "AuthoringTableList": {
5
+ "type": "object",
6
+ "required": ["contract", "objectPaths"],
7
+ "properties": {
8
+ "contract": {
9
+ "type": "object",
10
+ "required": ["name", "version"],
11
+ "properties": {
12
+ "name": {
13
+ "type": "string",
14
+ "enum": ["unreal-authoring-table-list"]
15
+ },
16
+ "version": {
17
+ "type": "object",
18
+ "required": ["major", "minor"],
19
+ "properties": {
20
+ "major": {
21
+ "type": "number",
22
+ "enum": [1]
23
+ },
24
+ "minor": {
25
+ "$ref": "#/$defs/NonNegativeInt"
26
+ }
27
+ },
28
+ "additionalProperties": false
29
+ }
30
+ },
31
+ "additionalProperties": false
32
+ },
33
+ "objectPaths": {
34
+ "type": "array",
35
+ "items": { "type": "string" }
36
+ }
37
+ },
38
+ "additionalProperties": false
39
+ },
40
+ "NonNegativeInt": {
41
+ "type": "integer",
42
+ "description": "an integer",
43
+ "title": "int",
44
+ "minimum": 0
45
+ }
46
+ },
47
+ "$ref": "#/$defs/AuthoringTableList"
48
+ }
package/contracts/authoring/v1/table-snapshot.schema.json ADDED
@@ -0,0 +1,497 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$defs": {
4
+ "AuthoringTableSnapshotV1": {
5
+ "type": "object",
6
+ "required": ["contract", "authority", "completeness", "table", "diagnostics"],
7
+ "properties": {
8
+ "contract": {
9
+ "type": "object",
10
+ "required": ["name", "version"],
11
+ "properties": {
12
+ "name": {
13
+ "type": "string",
14
+ "enum": ["unreal-authoring"]
15
+ },
16
+ "version": {
17
+ "type": "object",
18
+ "required": ["major", "minor"],
19
+ "properties": {
20
+ "major": {
21
+ "type": "number",
22
+ "enum": [1]
23
+ },
24
+ "minor": {
25
+ "$ref": "#/$defs/NonNegativeInt"
26
+ }
27
+ },
28
+ "additionalProperties": false
29
+ }
30
+ },
31
+ "additionalProperties": false
32
+ },
33
+ "authority": {
34
+ "anyOf": [
35
+ {
36
+ "type": "object",
37
+ "required": ["kind", "packageName"],
38
+ "properties": {
39
+ "kind": {
40
+ "type": "string",
41
+ "enum": ["project_files"]
42
+ },
43
+ "packageName": {
44
+ "type": "string"
45
+ }
46
+ },
47
+ "additionalProperties": false
48
+ },
49
+ {
50
+ "type": "object",
51
+ "required": ["kind", "producerId", "sessionId"],
52
+ "properties": {
53
+ "kind": {
54
+ "type": "string",
55
+ "enum": ["live_editor"]
56
+ },
57
+ "producerId": {
58
+ "type": "string"
59
+ },
60
+ "sessionId": {
61
+ "type": "string"
62
+ }
63
+ },
64
+ "additionalProperties": false
65
+ }
66
+ ]
67
+ },
68
+ "completeness": {
69
+ "type": "string",
70
+ "enum": ["complete", "partial"]
71
+ },
72
+ "table": {
73
+ "type": "object",
74
+ "required": ["kind", "objectPath", "rowStruct", "parentTables", "rows"],
75
+ "properties": {
76
+ "kind": {
77
+ "type": "string",
78
+ "enum": ["data_table", "composite_data_table"]
79
+ },
80
+ "objectPath": {
81
+ "type": "string"
82
+ },
83
+ "rowStruct": {
84
+ "type": "string"
85
+ },
86
+ "parentTables": {
87
+ "type": "array",
88
+ "items": {
89
+ "type": "string"
90
+ }
91
+ },
92
+ "rows": {
93
+ "type": "array",
94
+ "items": {
95
+ "type": "object",
96
+ "required": ["id", "name", "fields"],
97
+ "properties": {
98
+ "id": {
99
+ "type": "string"
100
+ },
101
+ "name": {
102
+ "type": "string"
103
+ },
104
+ "fields": {
105
+ "type": "array",
106
+ "items": {
107
+ "$ref": "#/$defs/AuthoringFieldValue"
108
+ }
109
+ }
110
+ },
111
+ "additionalProperties": false
112
+ }
113
+ }
114
+ },
115
+ "additionalProperties": false
116
+ },
117
+ "diagnostics": {
118
+ "type": "array",
119
+ "items": {
120
+ "type": "object",
121
+ "required": ["code", "message"],
122
+ "properties": {
123
+ "code": {
124
+ "type": "string"
125
+ },
126
+ "message": {
127
+ "type": "string"
128
+ },
129
+ "path": {
130
+ "type": "string"
131
+ }
132
+ },
133
+ "additionalProperties": false
134
+ }
135
+ }
136
+ },
137
+ "additionalProperties": false
138
+ },
139
+ "NonNegativeInt": {
140
+ "type": "integer",
141
+ "description": "an integer",
142
+ "title": "int",
143
+ "minimum": 0
144
+ },
145
+ "AuthoringFieldValue": {
146
+ "type": "object",
147
+ "required": ["name", "typeName", "value"],
148
+ "properties": {
149
+ "name": {
150
+ "type": "string"
151
+ },
152
+ "typeName": {
153
+ "type": "string"
154
+ },
155
+ "value": {
156
+ "$ref": "#/$defs/AuthoringValue"
157
+ }
158
+ },
159
+ "additionalProperties": false
160
+ },
161
+ "AuthoringValue": {
162
+ "anyOf": [
163
+ {
164
+ "type": "object",
165
+ "properties": {
166
+ "kind": {
167
+ "type": "string",
168
+ "enum": ["bool"]
169
+ },
170
+ "value": {
171
+ "type": "boolean"
172
+ }
173
+ },
174
+ "required": ["kind", "value"],
175
+ "additionalProperties": false
176
+ },
177
+ {
178
+ "type": "object",
179
+ "properties": {
180
+ "kind": {
181
+ "type": "string",
182
+ "enum": ["int"]
183
+ },
184
+ "value": {
185
+ "type": "string"
186
+ }
187
+ },
188
+ "required": ["kind", "value"],
189
+ "additionalProperties": false
190
+ },
191
+ {
192
+ "type": "object",
193
+ "properties": {
194
+ "kind": {
195
+ "type": "string",
196
+ "enum": ["uint"]
197
+ },
198
+ "value": {
199
+ "type": "string"
200
+ }
201
+ },
202
+ "required": ["kind", "value"],
203
+ "additionalProperties": false
204
+ },
205
+ {
206
+ "type": "object",
207
+ "properties": {
208
+ "kind": {
209
+ "type": "string",
210
+ "enum": ["float"]
211
+ },
212
+ "value": {
213
+ "anyOf": [
214
+ {
215
+ "type": "number"
216
+ },
217
+ {
218
+ "type": "string",
219
+ "enum": ["nan", "infinity", "-infinity"]
220
+ }
221
+ ]
222
+ }
223
+ },
224
+ "required": ["kind", "value"],
225
+ "additionalProperties": false
226
+ },
227
+ {
228
+ "type": "object",
229
+ "properties": {
230
+ "kind": {
231
+ "type": "string",
232
+ "enum": ["double"]
233
+ },
234
+ "value": {
235
+ "anyOf": [
236
+ {
237
+ "type": "number"
238
+ },
239
+ {
240
+ "type": "string",
241
+ "enum": ["nan", "infinity", "-infinity"]
242
+ }
243
+ ]
244
+ }
245
+ },
246
+ "required": ["kind", "value"],
247
+ "additionalProperties": false
248
+ },
249
+ {
250
+ "type": "object",
251
+ "properties": {
252
+ "kind": {
253
+ "type": "string",
254
+ "enum": ["name"]
255
+ },
256
+ "value": {
257
+ "type": "string"
258
+ }
259
+ },
260
+ "required": ["kind", "value"],
261
+ "additionalProperties": false
262
+ },
263
+ {
264
+ "type": "object",
265
+ "properties": {
266
+ "kind": {
267
+ "type": "string",
268
+ "enum": ["enum"]
269
+ },
270
+ "value": {
271
+ "type": "string"
272
+ }
273
+ },
274
+ "required": ["kind", "value"],
275
+ "additionalProperties": false
276
+ },
277
+ {
278
+ "type": "object",
279
+ "properties": {
280
+ "kind": {
281
+ "type": "string",
282
+ "enum": ["string"]
283
+ },
284
+ "value": {
285
+ "type": "string"
286
+ }
287
+ },
288
+ "required": ["kind", "value"],
289
+ "additionalProperties": false
290
+ },
291
+ {
292
+ "type": "object",
293
+ "properties": {
294
+ "kind": {
295
+ "type": "string",
296
+ "enum": ["text"]
297
+ },
298
+ "value": {
299
+ "type": "string"
300
+ }
301
+ },
302
+ "required": ["kind", "value"],
303
+ "additionalProperties": false
304
+ },
305
+ {
306
+ "type": "object",
307
+ "properties": {
308
+ "kind": {
309
+ "type": "string",
310
+ "enum": ["guid"]
311
+ },
312
+ "value": {
313
+ "type": "string"
314
+ }
315
+ },
316
+ "required": ["kind", "value"],
317
+ "additionalProperties": false
318
+ },
319
+ {
320
+ "type": "object",
321
+ "properties": {
322
+ "kind": {
323
+ "type": "string",
324
+ "enum": ["soft_object_path"]
325
+ },
326
+ "value": {
327
+ "type": "string"
328
+ }
329
+ },
330
+ "required": ["kind", "value"],
331
+ "additionalProperties": false
332
+ },
333
+ {
334
+ "type": "object",
335
+ "properties": {
336
+ "kind": {
337
+ "type": "string",
338
+ "enum": ["object_ref"]
339
+ },
340
+ "value": {
341
+ "anyOf": [
342
+ {
343
+ "type": "string"
344
+ },
345
+ {
346
+ "type": "null"
347
+ }
348
+ ]
349
+ }
350
+ },
351
+ "required": ["kind", "value"],
352
+ "additionalProperties": false
353
+ },
354
+ {
355
+ "type": "object",
356
+ "properties": {
357
+ "kind": {
358
+ "type": "string",
359
+ "enum": ["row_reference"]
360
+ },
361
+ "rowName": {
362
+ "type": "string"
363
+ },
364
+ "tableObjectPath": {
365
+ "anyOf": [
366
+ {
367
+ "type": "string"
368
+ },
369
+ {
370
+ "type": "null"
371
+ }
372
+ ]
373
+ }
374
+ },
375
+ "required": ["kind", "rowName", "tableObjectPath"],
376
+ "additionalProperties": false
377
+ },
378
+ {
379
+ "type": "object",
380
+ "properties": {
381
+ "kind": {
382
+ "type": "string",
383
+ "enum": ["vector"]
384
+ },
385
+ "x": {
386
+ "type": "number"
387
+ },
388
+ "y": {
389
+ "type": "number"
390
+ },
391
+ "z": {
392
+ "type": "number"
393
+ }
394
+ },
395
+ "required": ["kind", "x", "y", "z"],
396
+ "additionalProperties": false
397
+ },
398
+ {
399
+ "type": "object",
400
+ "properties": {
401
+ "kind": {
402
+ "type": "string",
403
+ "enum": ["array"]
404
+ },
405
+ "values": {
406
+ "type": "array",
407
+ "items": {
408
+ "$ref": "#/$defs/AuthoringValue"
409
+ }
410
+ }
411
+ },
412
+ "required": ["kind", "values"],
413
+ "additionalProperties": false
414
+ },
415
+ {
416
+ "type": "object",
417
+ "properties": {
418
+ "kind": {
419
+ "type": "string",
420
+ "enum": ["set"]
421
+ },
422
+ "values": {
423
+ "type": "array",
424
+ "items": {
425
+ "$ref": "#/$defs/AuthoringValue"
426
+ }
427
+ }
428
+ },
429
+ "required": ["kind", "values"],
430
+ "additionalProperties": false
431
+ },
432
+ {
433
+ "type": "object",
434
+ "properties": {
435
+ "kind": {
436
+ "type": "string",
437
+ "enum": ["map"]
438
+ },
439
+ "entries": {
440
+ "type": "array",
441
+ "items": {
442
+ "type": "object",
443
+ "properties": {
444
+ "key": {
445
+ "$ref": "#/$defs/AuthoringValue"
446
+ },
447
+ "value": {
448
+ "$ref": "#/$defs/AuthoringValue"
449
+ }
450
+ },
451
+ "required": ["key", "value"],
452
+ "additionalProperties": false
453
+ }
454
+ }
455
+ },
456
+ "required": ["kind", "entries"],
457
+ "additionalProperties": false
458
+ },
459
+ {
460
+ "type": "object",
461
+ "properties": {
462
+ "kind": {
463
+ "type": "string",
464
+ "enum": ["struct"]
465
+ },
466
+ "fields": {
467
+ "type": "array",
468
+ "items": {
469
+ "$ref": "#/$defs/AuthoringFieldValue"
470
+ }
471
+ }
472
+ },
473
+ "required": ["kind", "fields"],
474
+ "additionalProperties": false
475
+ },
476
+ {
477
+ "type": "object",
478
+ "properties": {
479
+ "byteSize": {
480
+ "$ref": "#/$defs/NonNegativeInt"
481
+ },
482
+ "kind": {
483
+ "type": "string",
484
+ "enum": ["unsupported"]
485
+ },
486
+ "reason": {
487
+ "type": "string"
488
+ }
489
+ },
490
+ "required": ["byteSize", "kind", "reason"],
491
+ "additionalProperties": false
492
+ }
493
+ ]
494
+ }
495
+ },
496
+ "$ref": "#/$defs/AuthoringTableSnapshotV1"
497
+ }