@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/apply-request.schema.json ADDED
@@ -0,0 +1,568 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$defs": {
4
+ "AuthoringApplyRequest": {
5
+ "type": "object",
6
+ "required": ["contract", "operationId", "tables", "commands"],
7
+ "properties": {
8
+ "contract": {
9
+ "type": "object",
10
+ "required": ["name", "version"],
11
+ "properties": {
12
+ "name": {
13
+ "type": "string",
14
+ "enum": ["unreal-authoring-apply"]
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
+ "operationId": {
34
+ "type": "string"
35
+ },
36
+ "tables": {
37
+ "type": "array",
38
+ "items": {
39
+ "type": "object",
40
+ "required": ["expectedFingerprint", "objectPath"],
41
+ "properties": {
42
+ "expectedFingerprint": {
43
+ "type": "string"
44
+ },
45
+ "objectPath": {
46
+ "type": "string"
47
+ }
48
+ },
49
+ "additionalProperties": false
50
+ }
51
+ },
52
+ "commands": {
53
+ "type": "array",
54
+ "items": {
55
+ "type": "object",
56
+ "required": ["body", "id", "tableObjectPath"],
57
+ "properties": {
58
+ "body": {
59
+ "$ref": "#/$defs/AuthoringCommand"
60
+ },
61
+ "id": {
62
+ "type": "string"
63
+ },
64
+ "tableObjectPath": {
65
+ "type": "string"
66
+ }
67
+ },
68
+ "additionalProperties": false
69
+ }
70
+ }
71
+ },
72
+ "additionalProperties": false
73
+ },
74
+ "NonNegativeInt": {
75
+ "type": "integer",
76
+ "description": "an integer",
77
+ "title": "int",
78
+ "minimum": 0
79
+ },
80
+ "AuthoringCommand": {
81
+ "anyOf": [
82
+ {
83
+ "type": "object",
84
+ "required": ["fieldName", "kind", "newValue", "oldValue", "rowId"],
85
+ "properties": {
86
+ "fieldName": {
87
+ "type": "string"
88
+ },
89
+ "kind": {
90
+ "type": "string",
91
+ "enum": ["set_cell"]
92
+ },
93
+ "newValue": {
94
+ "$ref": "#/$defs/AuthoringValue"
95
+ },
96
+ "oldValue": {
97
+ "$ref": "#/$defs/AuthoringValue"
98
+ },
99
+ "rowId": {
100
+ "type": "string"
101
+ }
102
+ },
103
+ "additionalProperties": false
104
+ },
105
+ {
106
+ "type": "object",
107
+ "required": ["atIndex", "kind", "row"],
108
+ "properties": {
109
+ "atIndex": {
110
+ "$ref": "#/$defs/NonNegativeInt"
111
+ },
112
+ "kind": {
113
+ "type": "string",
114
+ "enum": ["add_row"]
115
+ },
116
+ "row": {
117
+ "type": "object",
118
+ "required": ["id", "name", "fields"],
119
+ "properties": {
120
+ "id": {
121
+ "type": "string"
122
+ },
123
+ "name": {
124
+ "type": "string"
125
+ },
126
+ "fields": {
127
+ "type": "array",
128
+ "items": {
129
+ "$ref": "#/$defs/AuthoringFieldValue"
130
+ }
131
+ }
132
+ },
133
+ "additionalProperties": false
134
+ }
135
+ },
136
+ "additionalProperties": false
137
+ },
138
+ {
139
+ "type": "object",
140
+ "required": ["atIndex", "kind", "row"],
141
+ "properties": {
142
+ "atIndex": {
143
+ "$ref": "#/$defs/NonNegativeInt"
144
+ },
145
+ "kind": {
146
+ "type": "string",
147
+ "enum": ["remove_row"]
148
+ },
149
+ "row": {
150
+ "type": "object",
151
+ "required": ["id", "name", "fields"],
152
+ "properties": {
153
+ "id": {
154
+ "type": "string"
155
+ },
156
+ "name": {
157
+ "type": "string"
158
+ },
159
+ "fields": {
160
+ "type": "array",
161
+ "items": {
162
+ "$ref": "#/$defs/AuthoringFieldValue"
163
+ }
164
+ }
165
+ },
166
+ "additionalProperties": false
167
+ }
168
+ },
169
+ "additionalProperties": false
170
+ },
171
+ {
172
+ "type": "object",
173
+ "required": ["kind", "newName", "oldName", "rowId"],
174
+ "properties": {
175
+ "kind": {
176
+ "type": "string",
177
+ "enum": ["rename_row"]
178
+ },
179
+ "newName": {
180
+ "type": "string"
181
+ },
182
+ "oldName": {
183
+ "type": "string"
184
+ },
185
+ "rowId": {
186
+ "type": "string"
187
+ }
188
+ },
189
+ "additionalProperties": false
190
+ },
191
+ {
192
+ "type": "object",
193
+ "required": ["kind", "newOrder", "oldOrder"],
194
+ "properties": {
195
+ "kind": {
196
+ "type": "string",
197
+ "enum": ["reorder_rows"]
198
+ },
199
+ "newOrder": {
200
+ "type": "array",
201
+ "items": {
202
+ "type": "string"
203
+ }
204
+ },
205
+ "oldOrder": {
206
+ "type": "array",
207
+ "items": {
208
+ "type": "string"
209
+ }
210
+ }
211
+ },
212
+ "additionalProperties": false
213
+ }
214
+ ]
215
+ },
216
+ "AuthoringValue": {
217
+ "anyOf": [
218
+ {
219
+ "type": "object",
220
+ "properties": {
221
+ "kind": {
222
+ "type": "string",
223
+ "enum": ["bool"]
224
+ },
225
+ "value": {
226
+ "type": "boolean"
227
+ }
228
+ },
229
+ "required": ["kind", "value"],
230
+ "additionalProperties": false
231
+ },
232
+ {
233
+ "type": "object",
234
+ "properties": {
235
+ "kind": {
236
+ "type": "string",
237
+ "enum": ["int"]
238
+ },
239
+ "value": {
240
+ "type": "string"
241
+ }
242
+ },
243
+ "required": ["kind", "value"],
244
+ "additionalProperties": false
245
+ },
246
+ {
247
+ "type": "object",
248
+ "properties": {
249
+ "kind": {
250
+ "type": "string",
251
+ "enum": ["uint"]
252
+ },
253
+ "value": {
254
+ "type": "string"
255
+ }
256
+ },
257
+ "required": ["kind", "value"],
258
+ "additionalProperties": false
259
+ },
260
+ {
261
+ "type": "object",
262
+ "properties": {
263
+ "kind": {
264
+ "type": "string",
265
+ "enum": ["float"]
266
+ },
267
+ "value": {
268
+ "anyOf": [
269
+ {
270
+ "type": "number"
271
+ },
272
+ {
273
+ "type": "string",
274
+ "enum": ["nan", "infinity", "-infinity"]
275
+ }
276
+ ]
277
+ }
278
+ },
279
+ "required": ["kind", "value"],
280
+ "additionalProperties": false
281
+ },
282
+ {
283
+ "type": "object",
284
+ "properties": {
285
+ "kind": {
286
+ "type": "string",
287
+ "enum": ["double"]
288
+ },
289
+ "value": {
290
+ "anyOf": [
291
+ {
292
+ "type": "number"
293
+ },
294
+ {
295
+ "type": "string",
296
+ "enum": ["nan", "infinity", "-infinity"]
297
+ }
298
+ ]
299
+ }
300
+ },
301
+ "required": ["kind", "value"],
302
+ "additionalProperties": false
303
+ },
304
+ {
305
+ "type": "object",
306
+ "properties": {
307
+ "kind": {
308
+ "type": "string",
309
+ "enum": ["name"]
310
+ },
311
+ "value": {
312
+ "type": "string"
313
+ }
314
+ },
315
+ "required": ["kind", "value"],
316
+ "additionalProperties": false
317
+ },
318
+ {
319
+ "type": "object",
320
+ "properties": {
321
+ "kind": {
322
+ "type": "string",
323
+ "enum": ["enum"]
324
+ },
325
+ "value": {
326
+ "type": "string"
327
+ }
328
+ },
329
+ "required": ["kind", "value"],
330
+ "additionalProperties": false
331
+ },
332
+ {
333
+ "type": "object",
334
+ "properties": {
335
+ "kind": {
336
+ "type": "string",
337
+ "enum": ["string"]
338
+ },
339
+ "value": {
340
+ "type": "string"
341
+ }
342
+ },
343
+ "required": ["kind", "value"],
344
+ "additionalProperties": false
345
+ },
346
+ {
347
+ "type": "object",
348
+ "properties": {
349
+ "kind": {
350
+ "type": "string",
351
+ "enum": ["text"]
352
+ },
353
+ "value": {
354
+ "type": "string"
355
+ }
356
+ },
357
+ "required": ["kind", "value"],
358
+ "additionalProperties": false
359
+ },
360
+ {
361
+ "type": "object",
362
+ "properties": {
363
+ "kind": {
364
+ "type": "string",
365
+ "enum": ["guid"]
366
+ },
367
+ "value": {
368
+ "type": "string"
369
+ }
370
+ },
371
+ "required": ["kind", "value"],
372
+ "additionalProperties": false
373
+ },
374
+ {
375
+ "type": "object",
376
+ "properties": {
377
+ "kind": {
378
+ "type": "string",
379
+ "enum": ["soft_object_path"]
380
+ },
381
+ "value": {
382
+ "type": "string"
383
+ }
384
+ },
385
+ "required": ["kind", "value"],
386
+ "additionalProperties": false
387
+ },
388
+ {
389
+ "type": "object",
390
+ "properties": {
391
+ "kind": {
392
+ "type": "string",
393
+ "enum": ["object_ref"]
394
+ },
395
+ "value": {
396
+ "anyOf": [
397
+ {
398
+ "type": "string"
399
+ },
400
+ {
401
+ "type": "null"
402
+ }
403
+ ]
404
+ }
405
+ },
406
+ "required": ["kind", "value"],
407
+ "additionalProperties": false
408
+ },
409
+ {
410
+ "type": "object",
411
+ "properties": {
412
+ "kind": {
413
+ "type": "string",
414
+ "enum": ["row_reference"]
415
+ },
416
+ "rowName": {
417
+ "type": "string"
418
+ },
419
+ "tableObjectPath": {
420
+ "anyOf": [
421
+ {
422
+ "type": "string"
423
+ },
424
+ {
425
+ "type": "null"
426
+ }
427
+ ]
428
+ }
429
+ },
430
+ "required": ["kind", "rowName", "tableObjectPath"],
431
+ "additionalProperties": false
432
+ },
433
+ {
434
+ "type": "object",
435
+ "properties": {
436
+ "kind": {
437
+ "type": "string",
438
+ "enum": ["vector"]
439
+ },
440
+ "x": {
441
+ "type": "number"
442
+ },
443
+ "y": {
444
+ "type": "number"
445
+ },
446
+ "z": {
447
+ "type": "number"
448
+ }
449
+ },
450
+ "required": ["kind", "x", "y", "z"],
451
+ "additionalProperties": false
452
+ },
453
+ {
454
+ "type": "object",
455
+ "properties": {
456
+ "kind": {
457
+ "type": "string",
458
+ "enum": ["array"]
459
+ },
460
+ "values": {
461
+ "type": "array",
462
+ "items": {
463
+ "$ref": "#/$defs/AuthoringValue"
464
+ }
465
+ }
466
+ },
467
+ "required": ["kind", "values"],
468
+ "additionalProperties": false
469
+ },
470
+ {
471
+ "type": "object",
472
+ "properties": {
473
+ "kind": {
474
+ "type": "string",
475
+ "enum": ["set"]
476
+ },
477
+ "values": {
478
+ "type": "array",
479
+ "items": {
480
+ "$ref": "#/$defs/AuthoringValue"
481
+ }
482
+ }
483
+ },
484
+ "required": ["kind", "values"],
485
+ "additionalProperties": false
486
+ },
487
+ {
488
+ "type": "object",
489
+ "properties": {
490
+ "kind": {
491
+ "type": "string",
492
+ "enum": ["map"]
493
+ },
494
+ "entries": {
495
+ "type": "array",
496
+ "items": {
497
+ "type": "object",
498
+ "properties": {
499
+ "key": {
500
+ "$ref": "#/$defs/AuthoringValue"
501
+ },
502
+ "value": {
503
+ "$ref": "#/$defs/AuthoringValue"
504
+ }
505
+ },
506
+ "required": ["key", "value"],
507
+ "additionalProperties": false
508
+ }
509
+ }
510
+ },
511
+ "required": ["kind", "entries"],
512
+ "additionalProperties": false
513
+ },
514
+ {
515
+ "type": "object",
516
+ "properties": {
517
+ "kind": {
518
+ "type": "string",
519
+ "enum": ["struct"]
520
+ },
521
+ "fields": {
522
+ "type": "array",
523
+ "items": {
524
+ "$ref": "#/$defs/AuthoringFieldValue"
525
+ }
526
+ }
527
+ },
528
+ "required": ["kind", "fields"],
529
+ "additionalProperties": false
530
+ },
531
+ {
532
+ "type": "object",
533
+ "properties": {
534
+ "byteSize": {
535
+ "$ref": "#/$defs/NonNegativeInt"
536
+ },
537
+ "kind": {
538
+ "type": "string",
539
+ "enum": ["unsupported"]
540
+ },
541
+ "reason": {
542
+ "type": "string"
543
+ }
544
+ },
545
+ "required": ["byteSize", "kind", "reason"],
546
+ "additionalProperties": false
547
+ }
548
+ ]
549
+ },
550
+ "AuthoringFieldValue": {
551
+ "type": "object",
552
+ "required": ["name", "typeName", "value"],
553
+ "properties": {
554
+ "name": {
555
+ "type": "string"
556
+ },
557
+ "typeName": {
558
+ "type": "string"
559
+ },
560
+ "value": {
561
+ "$ref": "#/$defs/AuthoringValue"
562
+ }
563
+ },
564
+ "additionalProperties": false
565
+ }
566
+ },
567
+ "$ref": "#/$defs/AuthoringApplyRequest"
568
+ }