@hypersoniclabs/helix-sdk 0.1.1 → 0.1.9

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 (120) hide show
  1. package/README.md +954 -2
  2. package/dist/action-surface.d.ts +182 -0
  3. package/dist/action-surface.js +1032 -0
  4. package/dist/action-surface.js.map +1 -0
  5. package/dist/camera.d.ts +78 -0
  6. package/dist/camera.js +640 -0
  7. package/dist/camera.js.map +1 -0
  8. package/dist/dev-shell/criteria.d.ts +46 -0
  9. package/dist/dev-shell/criteria.js +98 -0
  10. package/dist/dev-shell/criteria.js.map +1 -0
  11. package/dist/dev-shell/index.d.ts +189 -0
  12. package/dist/dev-shell/index.js +287 -0
  13. package/dist/dev-shell/index.js.map +1 -0
  14. package/dist/dev-shell/keys.d.ts +14 -0
  15. package/dist/dev-shell/keys.js +78 -0
  16. package/dist/dev-shell/keys.js.map +1 -0
  17. package/dist/dev-shell/simulator.d.ts +436 -0
  18. package/dist/dev-shell/simulator.js +1634 -0
  19. package/dist/dev-shell/simulator.js.map +1 -0
  20. package/dist/dev-shell/state.d.ts +148 -0
  21. package/dist/dev-shell/state.js +196 -0
  22. package/dist/dev-shell/state.js.map +1 -0
  23. package/dist/device-definition-resolver.d.ts +34 -0
  24. package/dist/device-definition-resolver.js +172 -0
  25. package/dist/device-definition-resolver.js.map +1 -0
  26. package/dist/device-trial.d.ts +3 -0
  27. package/dist/device-trial.js +132 -0
  28. package/dist/device-trial.js.map +1 -0
  29. package/dist/devices.d.ts +228 -0
  30. package/dist/devices.js +198 -0
  31. package/dist/devices.js.map +1 -0
  32. package/dist/dreamerAudio.d.ts +126 -0
  33. package/dist/dreamerAudio.js +135 -0
  34. package/dist/dreamerAudio.js.map +1 -0
  35. package/dist/generated/runtime-contract.d.ts +15529 -0
  36. package/dist/generated/runtime-contract.js +20470 -0
  37. package/dist/generated/runtime-contract.js.map +1 -0
  38. package/dist/index.d.ts +364 -3
  39. package/dist/index.js +1954 -13
  40. package/dist/index.js.map +1 -1
  41. package/dist/interaction-mode.d.ts +172 -0
  42. package/dist/interaction-mode.js +553 -0
  43. package/dist/interaction-mode.js.map +1 -0
  44. package/dist/internal/avatar-pose.d.ts +25 -0
  45. package/dist/internal/avatar-pose.js +46 -0
  46. package/dist/internal/avatar-pose.js.map +1 -0
  47. package/dist/internal/keyed-collection.d.ts +2 -0
  48. package/dist/internal/keyed-collection.js +12 -0
  49. package/dist/internal/keyed-collection.js.map +1 -0
  50. package/dist/internal/vehicle-detach-action.d.ts +2 -0
  51. package/dist/internal/vehicle-detach-action.js +6 -0
  52. package/dist/internal/vehicle-detach-action.js.map +1 -0
  53. package/dist/matchmaking.d.ts +433 -0
  54. package/dist/matchmaking.js +1487 -0
  55. package/dist/matchmaking.js.map +1 -0
  56. package/dist/materials.d.ts +122 -0
  57. package/dist/materials.js +217 -0
  58. package/dist/materials.js.map +1 -0
  59. package/dist/multiplayer-accessors.d.ts +100 -0
  60. package/dist/multiplayer-accessors.js +200 -0
  61. package/dist/multiplayer-accessors.js.map +1 -0
  62. package/dist/multiplayer-contract/avatar-pose.d.ts +112 -0
  63. package/dist/multiplayer-contract/avatar-pose.js +250 -0
  64. package/dist/multiplayer-contract/avatar-pose.js.map +1 -0
  65. package/dist/multiplayer-contract/credential.d.ts +80 -0
  66. package/dist/multiplayer-contract/credential.js +5 -0
  67. package/dist/multiplayer-contract/credential.js.map +1 -0
  68. package/dist/multiplayer-contract/final-rest.d.ts +66 -0
  69. package/dist/multiplayer-contract/final-rest.js +38 -0
  70. package/dist/multiplayer-contract/final-rest.js.map +1 -0
  71. package/dist/multiplayer-contract/index.d.ts +20 -0
  72. package/dist/multiplayer-contract/index.js +41 -0
  73. package/dist/multiplayer-contract/index.js.map +1 -0
  74. package/dist/multiplayer-contract/messages.d.ts +731 -0
  75. package/dist/multiplayer-contract/messages.js +237 -0
  76. package/dist/multiplayer-contract/messages.js.map +1 -0
  77. package/dist/multiplayer-contract/room.d.ts +177 -0
  78. package/dist/multiplayer-contract/room.js +17 -0
  79. package/dist/multiplayer-contract/room.js.map +1 -0
  80. package/dist/multiplayer-contract/state.d.ts +241 -0
  81. package/dist/multiplayer-contract/state.js +15 -0
  82. package/dist/multiplayer-contract/state.js.map +1 -0
  83. package/dist/multiplayer-final-rest.d.ts +32 -0
  84. package/dist/multiplayer-final-rest.js +217 -0
  85. package/dist/multiplayer-final-rest.js.map +1 -0
  86. package/dist/multiplayer.d.ts +624 -0
  87. package/dist/multiplayer.js +2503 -0
  88. package/dist/multiplayer.js.map +1 -0
  89. package/dist/package.json +3 -0
  90. package/dist/protocol.d.ts +859 -1
  91. package/dist/protocol.js +117 -5
  92. package/dist/protocol.js.map +1 -1
  93. package/dist/runtime-contract/index.d.ts +15 -0
  94. package/dist/runtime-contract/index.js +12 -0
  95. package/dist/runtime-contract/index.js.map +1 -0
  96. package/dist/server-clock.d.ts +25 -0
  97. package/dist/server-clock.js +88 -0
  98. package/dist/server-clock.js.map +1 -0
  99. package/dist/tsconfig.build.tsbuildinfo +1 -1
  100. package/dist/universal-vehicles.d.ts +111 -0
  101. package/dist/universal-vehicles.js +2 -0
  102. package/dist/universal-vehicles.js.map +1 -0
  103. package/dist/vault.d.ts +562 -0
  104. package/dist/vault.js +365 -0
  105. package/dist/vault.js.map +1 -0
  106. package/dist/vehicle-specialty-placement.d.ts +28 -0
  107. package/dist/vehicle-specialty-placement.js +154 -0
  108. package/dist/vehicle-specialty-placement.js.map +1 -0
  109. package/dist/vehicle-specialty-transport.d.ts +78 -0
  110. package/dist/vehicle-specialty-transport.js +183 -0
  111. package/dist/vehicle-specialty-transport.js.map +1 -0
  112. package/dist/voice.d.ts +229 -0
  113. package/dist/voice.js +1348 -0
  114. package/dist/voice.js.map +1 -0
  115. package/generated/runtime-contract/helix-runtime-contract.json +13332 -0
  116. package/generated/runtime-contract/known-answer.json +20471 -0
  117. package/generated/runtime-contract/known-answer.schema.json +630 -0
  118. package/generated/runtime-contract/runtime-contract.schema.json +607 -0
  119. package/generated/runtime-contract/unreal/HelixRuntimeContract.generated.h +908 -0
  120. package/package.json +44 -5
@@ -0,0 +1,607 @@
1
+ {
2
+ "$defs": {
3
+ "event": {
4
+ "additionalProperties": false,
5
+ "properties": {
6
+ "name": {
7
+ "minLength": 1,
8
+ "type": "string"
9
+ },
10
+ "owner": {
11
+ "minLength": 1,
12
+ "type": "string"
13
+ },
14
+ "payload": {
15
+ "minLength": 1,
16
+ "type": "string"
17
+ }
18
+ },
19
+ "required": [
20
+ "name",
21
+ "payload",
22
+ "owner"
23
+ ],
24
+ "type": "object"
25
+ },
26
+ "factory": {
27
+ "additionalProperties": false,
28
+ "properties": {
29
+ "input": {
30
+ "type": "string"
31
+ },
32
+ "output": {
33
+ "minLength": 1,
34
+ "type": "string"
35
+ },
36
+ "scope": {
37
+ "minLength": 1,
38
+ "type": "string"
39
+ },
40
+ "signature": {
41
+ "minLength": 1,
42
+ "type": "string"
43
+ }
44
+ },
45
+ "required": [
46
+ "signature",
47
+ "input",
48
+ "output",
49
+ "scope"
50
+ ],
51
+ "type": "object"
52
+ },
53
+ "gap": {
54
+ "additionalProperties": false,
55
+ "properties": {
56
+ "id": {
57
+ "minLength": 1,
58
+ "type": "string"
59
+ },
60
+ "publicMethod": {
61
+ "type": [
62
+ "string",
63
+ "null"
64
+ ]
65
+ },
66
+ "status": {
67
+ "enum": [
68
+ "unavailable",
69
+ "correction_required"
70
+ ]
71
+ }
72
+ },
73
+ "required": [
74
+ "id",
75
+ "status",
76
+ "publicMethod"
77
+ ],
78
+ "type": "object"
79
+ },
80
+ "method": {
81
+ "additionalProperties": false,
82
+ "allOf": [
83
+ {
84
+ "if": {
85
+ "properties": {
86
+ "availability": {
87
+ "enum": [
88
+ "unavailable",
89
+ "correction_required"
90
+ ]
91
+ }
92
+ }
93
+ },
94
+ "then": {
95
+ "required": [
96
+ "correction"
97
+ ]
98
+ }
99
+ }
100
+ ],
101
+ "properties": {
102
+ "authority": {
103
+ "enum": [
104
+ "client",
105
+ "shell_player",
106
+ "platform",
107
+ "world_server",
108
+ "profile_dependent"
109
+ ]
110
+ },
111
+ "availability": {
112
+ "enum": [
113
+ "available",
114
+ "conditional",
115
+ "unavailable",
116
+ "correction_required"
117
+ ]
118
+ },
119
+ "correction": {
120
+ "type": "string"
121
+ },
122
+ "credentials": {
123
+ "items": {
124
+ "type": "string"
125
+ },
126
+ "type": "array",
127
+ "uniqueItems": true
128
+ },
129
+ "errors": {
130
+ "items": {
131
+ "minLength": 1,
132
+ "type": "string"
133
+ },
134
+ "minItems": 1,
135
+ "type": "array",
136
+ "uniqueItems": true
137
+ },
138
+ "idempotency": {
139
+ "minLength": 1,
140
+ "type": "string"
141
+ },
142
+ "input": {
143
+ "type": "string"
144
+ },
145
+ "output": {
146
+ "type": "string"
147
+ },
148
+ "profilePolicies": {
149
+ "additionalProperties": {
150
+ "$ref": "#/$defs/profilePolicy"
151
+ },
152
+ "type": "object"
153
+ },
154
+ "profiles": {
155
+ "items": {
156
+ "enum": [
157
+ "client",
158
+ "preview",
159
+ "listen",
160
+ "managed_server"
161
+ ]
162
+ },
163
+ "type": "array",
164
+ "uniqueItems": true
165
+ },
166
+ "receipt": {
167
+ "minLength": 1,
168
+ "type": "string"
169
+ },
170
+ "requiredCapabilities": {
171
+ "items": {
172
+ "type": "string"
173
+ },
174
+ "type": "array",
175
+ "uniqueItems": true
176
+ },
177
+ "runtimeBindings": {
178
+ "additionalProperties": false,
179
+ "properties": {
180
+ "unreal": {
181
+ "$ref": "#/$defs/runtimeBinding"
182
+ },
183
+ "web": {
184
+ "$ref": "#/$defs/runtimeBinding"
185
+ }
186
+ },
187
+ "required": [
188
+ "web",
189
+ "unreal"
190
+ ],
191
+ "type": "object"
192
+ },
193
+ "signature": {
194
+ "minLength": 1,
195
+ "type": "string"
196
+ },
197
+ "transportOwner": {
198
+ "enum": [
199
+ "local",
200
+ "shell",
201
+ "direct",
202
+ "network_provider",
203
+ "voice_provider"
204
+ ]
205
+ }
206
+ },
207
+ "required": [
208
+ "signature",
209
+ "input",
210
+ "output",
211
+ "availability",
212
+ "profiles",
213
+ "transportOwner",
214
+ "authority",
215
+ "requiredCapabilities",
216
+ "credentials",
217
+ "idempotency",
218
+ "errors",
219
+ "profilePolicies",
220
+ "runtimeBindings"
221
+ ],
222
+ "type": "object"
223
+ },
224
+ "namespace": {
225
+ "additionalProperties": false,
226
+ "properties": {
227
+ "handles": {
228
+ "type": "object"
229
+ },
230
+ "methods": {
231
+ "additionalProperties": {
232
+ "$ref": "#/$defs/method"
233
+ },
234
+ "minProperties": 1,
235
+ "type": "object"
236
+ }
237
+ },
238
+ "required": [
239
+ "methods"
240
+ ],
241
+ "type": "object"
242
+ },
243
+ "nonEmptyObject": {
244
+ "minProperties": 1,
245
+ "type": "object"
246
+ },
247
+ "profilePolicy": {
248
+ "additionalProperties": false,
249
+ "allOf": [
250
+ {
251
+ "if": {
252
+ "properties": {
253
+ "availability": {
254
+ "enum": [
255
+ "unavailable",
256
+ "correction_required"
257
+ ]
258
+ }
259
+ }
260
+ },
261
+ "then": {
262
+ "required": [
263
+ "correction"
264
+ ]
265
+ }
266
+ }
267
+ ],
268
+ "properties": {
269
+ "authority": {
270
+ "enum": [
271
+ "client",
272
+ "shell_player",
273
+ "platform",
274
+ "world_server",
275
+ "profile_dependent"
276
+ ]
277
+ },
278
+ "availability": {
279
+ "enum": [
280
+ "available",
281
+ "conditional",
282
+ "unavailable",
283
+ "correction_required"
284
+ ]
285
+ },
286
+ "correction": {
287
+ "minLength": 1,
288
+ "type": "string"
289
+ },
290
+ "credentials": {
291
+ "items": {
292
+ "type": "string"
293
+ },
294
+ "type": "array",
295
+ "uniqueItems": true
296
+ },
297
+ "idempotency": {
298
+ "minLength": 1,
299
+ "type": "string"
300
+ },
301
+ "receipt": {
302
+ "minLength": 1,
303
+ "type": "string"
304
+ },
305
+ "requiredCapabilities": {
306
+ "items": {
307
+ "type": "string"
308
+ },
309
+ "type": "array",
310
+ "uniqueItems": true
311
+ },
312
+ "transportOwner": {
313
+ "enum": [
314
+ "local",
315
+ "shell",
316
+ "direct",
317
+ "network_provider",
318
+ "voice_provider"
319
+ ]
320
+ }
321
+ },
322
+ "required": [
323
+ "availability",
324
+ "transportOwner",
325
+ "authority",
326
+ "requiredCapabilities",
327
+ "credentials",
328
+ "idempotency"
329
+ ],
330
+ "type": "object"
331
+ },
332
+ "publicApi": {
333
+ "additionalProperties": false,
334
+ "properties": {
335
+ "entryPoint": {
336
+ "const": "src/index.ts"
337
+ },
338
+ "exports": {
339
+ "items": {
340
+ "$ref": "#/$defs/publicExport"
341
+ },
342
+ "minItems": 1,
343
+ "type": "array"
344
+ }
345
+ },
346
+ "required": [
347
+ "entryPoint",
348
+ "exports"
349
+ ],
350
+ "type": "object"
351
+ },
352
+ "publicExport": {
353
+ "additionalProperties": false,
354
+ "properties": {
355
+ "category": {
356
+ "enum": [
357
+ "runtime_facade",
358
+ "standalone_tooling",
359
+ "multiplayer_handle_type",
360
+ "implementation_symbol"
361
+ ]
362
+ },
363
+ "declarations": {
364
+ "items": {
365
+ "additionalProperties": false,
366
+ "properties": {
367
+ "declaration": {
368
+ "minLength": 1,
369
+ "type": "string"
370
+ },
371
+ "kind": {
372
+ "minLength": 1,
373
+ "type": "string"
374
+ },
375
+ "source": {
376
+ "pattern": "^src/",
377
+ "type": "string"
378
+ }
379
+ },
380
+ "required": [
381
+ "kind",
382
+ "source",
383
+ "declaration"
384
+ ],
385
+ "type": "object"
386
+ },
387
+ "minItems": 1,
388
+ "type": "array"
389
+ },
390
+ "kind": {
391
+ "enum": [
392
+ "value",
393
+ "type",
394
+ "value_and_type"
395
+ ]
396
+ },
397
+ "name": {
398
+ "minLength": 1,
399
+ "type": "string"
400
+ }
401
+ },
402
+ "required": [
403
+ "name",
404
+ "kind",
405
+ "category",
406
+ "declarations"
407
+ ],
408
+ "type": "object"
409
+ },
410
+ "runtimeBinding": {
411
+ "additionalProperties": false,
412
+ "allOf": [
413
+ {
414
+ "if": {
415
+ "properties": {
416
+ "availability": {
417
+ "enum": [
418
+ "unavailable",
419
+ "correction_required"
420
+ ]
421
+ }
422
+ }
423
+ },
424
+ "then": {
425
+ "properties": {
426
+ "bindable": {
427
+ "const": false
428
+ }
429
+ },
430
+ "required": [
431
+ "correction"
432
+ ]
433
+ }
434
+ }
435
+ ],
436
+ "properties": {
437
+ "availability": {
438
+ "enum": [
439
+ "available",
440
+ "conditional",
441
+ "unavailable",
442
+ "correction_required"
443
+ ]
444
+ },
445
+ "bindable": {
446
+ "type": "boolean"
447
+ },
448
+ "correction": {
449
+ "minLength": 1,
450
+ "type": "string"
451
+ }
452
+ },
453
+ "required": [
454
+ "availability",
455
+ "bindable"
456
+ ],
457
+ "type": "object"
458
+ }
459
+ },
460
+ "$id": "https://helixgame.com/schemas/runtime-contract.generated.schema.json",
461
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
462
+ "additionalProperties": false,
463
+ "properties": {
464
+ "$schema": {
465
+ "const": "./runtime-contract.schema.json"
466
+ },
467
+ "authorityProfiles": {
468
+ "$ref": "#/$defs/nonEmptyObject"
469
+ },
470
+ "availabilityMeanings": {
471
+ "$ref": "#/$defs/nonEmptyObject"
472
+ },
473
+ "capabilities": {
474
+ "type": "object"
475
+ },
476
+ "contractVersion": {
477
+ "minimum": 1,
478
+ "type": "integer"
479
+ },
480
+ "digest": {
481
+ "pattern": "^sha256:[0-9a-f]{64}$",
482
+ "type": "string"
483
+ },
484
+ "events": {
485
+ "items": {
486
+ "$ref": "#/$defs/event"
487
+ },
488
+ "type": "array"
489
+ },
490
+ "knownGaps": {
491
+ "items": {
492
+ "$ref": "#/$defs/gap"
493
+ },
494
+ "type": "array"
495
+ },
496
+ "namespaces": {
497
+ "additionalProperties": {
498
+ "$ref": "#/$defs/namespace"
499
+ },
500
+ "minProperties": 1,
501
+ "type": "object"
502
+ },
503
+ "publicApi": {
504
+ "$ref": "#/$defs/publicApi"
505
+ },
506
+ "purchaseStatusMeanings": {
507
+ "$ref": "#/$defs/nonEmptyObject"
508
+ },
509
+ "schema": {
510
+ "const": "helix.runtime-contract"
511
+ },
512
+ "sdk": {
513
+ "additionalProperties": false,
514
+ "properties": {
515
+ "multiplayerContractVersion": {
516
+ "minimum": 1,
517
+ "type": "integer"
518
+ },
519
+ "package": {
520
+ "type": "string"
521
+ },
522
+ "packageVersion": {
523
+ "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+",
524
+ "type": "string"
525
+ },
526
+ "protocolVersion": {
527
+ "minimum": 1,
528
+ "type": "integer"
529
+ }
530
+ },
531
+ "required": [
532
+ "package",
533
+ "packageVersion",
534
+ "protocolVersion",
535
+ "multiplayerContractVersion"
536
+ ],
537
+ "type": "object"
538
+ },
539
+ "source": {
540
+ "additionalProperties": false,
541
+ "properties": {
542
+ "branch": {
543
+ "minLength": 1,
544
+ "type": "string"
545
+ },
546
+ "commit": {
547
+ "pattern": "^[0-9a-f]{40}$",
548
+ "type": "string"
549
+ },
550
+ "fileDigests": {
551
+ "$comment": "sha256 of every audited source file, as it must exist on disk. This is what the contract is an audit OF. `commit` is provenance only: a commit pin cannot survive a squash merge, and its failure lands on the integration branch rather than in the PR that caused it.",
552
+ "additionalProperties": {
553
+ "pattern": "^sha256:[0-9a-f]{64}$",
554
+ "type": "string"
555
+ },
556
+ "minProperties": 1,
557
+ "type": "object"
558
+ },
559
+ "repository": {
560
+ "minLength": 1,
561
+ "type": "string"
562
+ }
563
+ },
564
+ "required": [
565
+ "repository",
566
+ "branch",
567
+ "commit",
568
+ "fileDigests"
569
+ ],
570
+ "type": "object"
571
+ },
572
+ "stableErrors": {
573
+ "$ref": "#/$defs/nonEmptyObject"
574
+ },
575
+ "standaloneFactories": {
576
+ "additionalProperties": {
577
+ "$ref": "#/$defs/factory"
578
+ },
579
+ "minProperties": 1,
580
+ "type": "object"
581
+ },
582
+ "types": {
583
+ "type": "object"
584
+ }
585
+ },
586
+ "required": [
587
+ "schema",
588
+ "contractVersion",
589
+ "source",
590
+ "sdk",
591
+ "authorityProfiles",
592
+ "capabilities",
593
+ "availabilityMeanings",
594
+ "stableErrors",
595
+ "purchaseStatusMeanings",
596
+ "events",
597
+ "types",
598
+ "publicApi",
599
+ "namespaces",
600
+ "standaloneFactories",
601
+ "knownGaps",
602
+ "$schema",
603
+ "digest"
604
+ ],
605
+ "title": "HELIX generated engine-neutral runtime contract",
606
+ "type": "object"
607
+ }