@dreamboard-games/sdk 0.4.0-alpha.10 → 0.4.0-alpha.11
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.
- package/REFERENCE.md +1194 -74
- package/dist/authoring/index.js +2 -2
- package/dist/authoring-compiler.js +3 -3
- package/dist/authoring-materialize-cli.js +3 -3
- package/dist/{chunk-PJXXQ7IE.js → chunk-3OY46H7D.js} +2 -2
- package/dist/{chunk-GMOBG7Y7.js → chunk-B33RRZ4O.js} +5 -5
- package/dist/{chunk-GMOBG7Y7.js.map → chunk-B33RRZ4O.js.map} +1 -1
- package/dist/{chunk-X7GPD5TR.js → chunk-CP3BF3B2.js} +2 -2
- package/dist/{chunk-X7GPD5TR.js.map → chunk-CP3BF3B2.js.map} +1 -1
- package/dist/{chunk-QQNL4WTX.js → chunk-FBQNCOPQ.js} +122 -61
- package/dist/chunk-FBQNCOPQ.js.map +1 -0
- package/dist/{chunk-PIZEWMKV.js → chunk-HRWI2DIJ.js} +2 -2
- package/dist/{chunk-UC2UXAC6.js → chunk-MPVC2SU6.js} +2 -2
- package/dist/{chunk-NGYFBNBP.js → chunk-NQTXQWUP.js} +15 -85
- package/dist/chunk-NQTXQWUP.js.map +1 -0
- package/dist/{chunk-M4PZ6PEY.js → chunk-RP6QDQGI.js} +6 -6
- package/dist/{chunk-QWWAGWAI.js → chunk-RU3Z5J6V.js} +5 -5
- package/dist/{chunk-26IRD573.js → chunk-THTFQZZ3.js} +2 -2
- package/dist/{chunk-6P3IO3FF.js → chunk-WAQUD4IG.js} +16 -38
- package/dist/chunk-WAQUD4IG.js.map +1 -0
- package/dist/{chunk-2TRZSZGD.js → chunk-YOLIZMXR.js} +7 -10
- package/dist/chunk-YOLIZMXR.js.map +1 -0
- package/dist/{components-BPzsSRs8.d.ts → components-D5GO-0FJ.d.ts} +1 -1
- package/dist/{definitions-BTaUEJ0t.d.ts → definitions-BezxXhhP.d.ts} +2 -2
- package/dist/digest.d.ts +8 -0
- package/dist/{index-CWzWpQzM.d.ts → index-CRfZ21dM.d.ts} +1 -1
- package/dist/index.js +2 -2
- package/dist/package-set.d.ts +2 -2
- package/dist/package-set.js +2 -2
- package/dist/plugin-runtime-contract.d.ts +18 -0
- package/dist/plugin-runtime-contract.js +94 -0
- package/dist/plugin-runtime-contract.js.map +1 -0
- package/dist/{protocol-B2LWcqB4.d.ts → protocol-Bcas2Xa8.d.ts} +46 -47
- package/dist/reducer/advanced.d.ts +5 -4
- package/dist/reducer-contract.js +3 -3
- package/dist/reducer.d.ts +6 -5
- package/dist/reducer.js.map +1 -1
- package/dist/runtime/primitives.d.ts +3 -3
- package/dist/runtime/primitives.js +5 -5
- package/dist/runtime/runtime-api.d.ts +1 -1
- package/dist/runtime/workspace-contract.d.ts +4 -4
- package/dist/runtime/workspace-contract.js +6 -6
- package/dist/{runtime-B_w9AO2n.d.ts → runtime-BhuaOkIL.d.ts} +7 -26
- package/dist/{runtime-api-xCWLMQRT.d.ts → runtime-api-CgPuEVeF.d.ts} +2 -13
- package/dist/runtime.d.ts +7 -7
- package/dist/runtime.js +16 -16
- package/dist/schema.d.ts +410 -0
- package/dist/testing-compiler.d.ts +4 -3
- package/dist/testing-runtime.d.ts +6 -5
- package/dist/testing-runtime.js +2 -2
- package/dist/testing.d.ts +29 -34
- package/dist/testing.js +38 -69
- package/dist/testing.js.map +1 -1
- package/dist/{types-CYZqg_Hn.d.ts → types-B-FI0jrx.d.ts} +1 -1
- package/dist/{types-_zfC_7CD.d.ts → types-CR9yEmXt.d.ts} +4 -5
- package/dist/ui/components.d.ts +3 -2
- package/dist/ui/components.js +1 -1
- package/dist/ui/plugin-styles.css +1 -1
- package/dist/{ui-contract-CUC7Lyoc.d.ts → ui-contract-BC4JpysE.d.ts} +2 -6
- package/dist/ui.d.ts +4 -3
- package/dist/ui.js +2 -2
- package/dist/{views-DE2eZxPz.d.ts → views-BbCGDuCs.d.ts} +1 -1
- package/package.json +7 -2
- package/dist/chunk-2TRZSZGD.js.map +0 -1
- package/dist/chunk-6P3IO3FF.js.map +0 -1
- package/dist/chunk-NGYFBNBP.js.map +0 -1
- package/dist/chunk-QQNL4WTX.js.map +0 -1
- /package/dist/{chunk-PJXXQ7IE.js.map → chunk-3OY46H7D.js.map} +0 -0
- /package/dist/{chunk-PIZEWMKV.js.map → chunk-HRWI2DIJ.js.map} +0 -0
- /package/dist/{chunk-UC2UXAC6.js.map → chunk-MPVC2SU6.js.map} +0 -0
- /package/dist/{chunk-M4PZ6PEY.js.map → chunk-RP6QDQGI.js.map} +0 -0
- /package/dist/{chunk-QWWAGWAI.js.map → chunk-RU3Z5J6V.js.map} +0 -0
- /package/dist/{chunk-26IRD573.js.map → chunk-THTFQZZ3.js.map} +0 -0
package/REFERENCE.md
CHANGED
|
@@ -48,7 +48,7 @@ _No JSDoc summary is available yet._
|
|
|
48
48
|
|
|
49
49
|
```ts
|
|
50
50
|
const DREAMBOARD_SDK_PACKAGES: {
|
|
51
|
-
readonly "@dreamboard-games/sdk": "0.4.0-alpha.
|
|
51
|
+
readonly "@dreamboard-games/sdk": "0.4.0-alpha.11";
|
|
52
52
|
};
|
|
53
53
|
```
|
|
54
54
|
|
|
@@ -57,7 +57,7 @@ _No JSDoc summary is available yet._
|
|
|
57
57
|
### DREAMBOARD_SDK_VERSION
|
|
58
58
|
|
|
59
59
|
```ts
|
|
60
|
-
const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.
|
|
60
|
+
const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.11";
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
_No JSDoc summary is available yet._
|
|
@@ -96,7 +96,7 @@ _No JSDoc summary is available yet._
|
|
|
96
96
|
|
|
97
97
|
```ts
|
|
98
98
|
const DREAMBOARD_SDK_PACKAGES: {
|
|
99
|
-
readonly "@dreamboard-games/sdk": "0.4.0-alpha.
|
|
99
|
+
readonly "@dreamboard-games/sdk": "0.4.0-alpha.11";
|
|
100
100
|
};
|
|
101
101
|
```
|
|
102
102
|
|
|
@@ -105,7 +105,7 @@ _No JSDoc summary is available yet._
|
|
|
105
105
|
### DREAMBOARD_SDK_VERSION
|
|
106
106
|
|
|
107
107
|
```ts
|
|
108
|
-
const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.
|
|
108
|
+
const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.11";
|
|
109
109
|
```
|
|
110
110
|
|
|
111
111
|
_No JSDoc summary is available yet._
|
|
@@ -130,6 +130,1169 @@ type DreamboardSdkPackageSet = {
|
|
|
130
130
|
|
|
131
131
|
_No JSDoc summary is available yet._
|
|
132
132
|
|
|
133
|
+
## @dreamboard-games/sdk/plugin-runtime-contract
|
|
134
|
+
|
|
135
|
+
### ActionInteractionDescriptor
|
|
136
|
+
|
|
137
|
+
```ts
|
|
138
|
+
type ActionInteractionDescriptor<Interaction extends string = string> =
|
|
139
|
+
InteractionDescriptorBase<Interaction> & {
|
|
140
|
+
readonly kind: "action";
|
|
141
|
+
};
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
_No JSDoc summary is available yet._
|
|
145
|
+
|
|
146
|
+
### ActionSetVersionInput
|
|
147
|
+
|
|
148
|
+
```ts
|
|
149
|
+
type ActionSetVersionInput = {
|
|
150
|
+
readonly version: number;
|
|
151
|
+
readonly availableInteractions: readonly InteractionDescriptor[];
|
|
152
|
+
};
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
_No JSDoc summary is available yet._
|
|
156
|
+
|
|
157
|
+
### BoardStaticProjectionSchema
|
|
158
|
+
|
|
159
|
+
```ts
|
|
160
|
+
const BoardStaticProjectionSchema: z.ZodObject<
|
|
161
|
+
{
|
|
162
|
+
view: z.ZodType<
|
|
163
|
+
RuntimeJson,
|
|
164
|
+
unknown,
|
|
165
|
+
z.core.$ZodTypeInternals<RuntimeJson, unknown>
|
|
166
|
+
>;
|
|
167
|
+
hash: z.ZodOptional<z.ZodString>;
|
|
168
|
+
manifestVersion: z.ZodOptional<z.ZodString>;
|
|
169
|
+
},
|
|
170
|
+
z.core.$strict
|
|
171
|
+
>;
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
_No JSDoc summary is available yet._
|
|
175
|
+
|
|
176
|
+
### canonicalizePluginRuntimeJson
|
|
177
|
+
|
|
178
|
+
```ts
|
|
179
|
+
function canonicalizePluginRuntimeJson(value: unknown): CanonicalJson;
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
_No JSDoc summary is available yet._
|
|
183
|
+
|
|
184
|
+
### CanonicalJson
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
type CanonicalJson =
|
|
188
|
+
| null
|
|
189
|
+
| boolean
|
|
190
|
+
| number
|
|
191
|
+
| string
|
|
192
|
+
| CanonicalJson[]
|
|
193
|
+
| {
|
|
194
|
+
[key: string]: CanonicalJson;
|
|
195
|
+
};
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
_No JSDoc summary is available yet._
|
|
199
|
+
|
|
200
|
+
### computePluginActionSetVersion
|
|
201
|
+
|
|
202
|
+
```ts
|
|
203
|
+
function computePluginActionSetVersion(input: ActionSetVersionInput): string;
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
_No JSDoc summary is available yet._
|
|
207
|
+
|
|
208
|
+
### createPluginProtocolEnvelopeSchema
|
|
209
|
+
|
|
210
|
+
```ts
|
|
211
|
+
function createPluginProtocolEnvelopeSchema<Payload>(
|
|
212
|
+
payloadSchema: z.ZodType<Payload>,
|
|
213
|
+
): z.ZodType<PluginProtocolEnvelope<Payload>>;
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
_No JSDoc summary is available yet._
|
|
217
|
+
|
|
218
|
+
### digestPluginCommandRequest
|
|
219
|
+
|
|
220
|
+
```ts
|
|
221
|
+
function digestPluginCommandRequest(command: SubmitInteractionCommand): string;
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
_No JSDoc summary is available yet._
|
|
225
|
+
|
|
226
|
+
### digestPluginGameplayFrame
|
|
227
|
+
|
|
228
|
+
```ts
|
|
229
|
+
function digestPluginGameplayFrame(frame: PluginGameplayFrame): string;
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
_No JSDoc summary is available yet._
|
|
233
|
+
|
|
234
|
+
### digestPluginRuntimeJson
|
|
235
|
+
|
|
236
|
+
```ts
|
|
237
|
+
function digestPluginRuntimeJson(value: unknown): string;
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
_No JSDoc summary is available yet._
|
|
241
|
+
|
|
242
|
+
### DREAMBOARD_PLUGIN_PROTOCOL
|
|
243
|
+
|
|
244
|
+
```ts
|
|
245
|
+
const DREAMBOARD_PLUGIN_PROTOCOL: "dreamboard-plugin";
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
_No JSDoc summary is available yet._
|
|
249
|
+
|
|
250
|
+
### DREAMBOARD_PLUGIN_PROTOCOL_VERSION
|
|
251
|
+
|
|
252
|
+
```ts
|
|
253
|
+
const DREAMBOARD_PLUGIN_PROTOCOL_VERSION: 4;
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
_No JSDoc summary is available yet._
|
|
257
|
+
|
|
258
|
+
### encodeCanonicalPluginRuntimeJson
|
|
259
|
+
|
|
260
|
+
```ts
|
|
261
|
+
function encodeCanonicalPluginRuntimeJson(value: unknown): string;
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
_No JSDoc summary is available yet._
|
|
265
|
+
|
|
266
|
+
### GameEvent
|
|
267
|
+
|
|
268
|
+
```ts
|
|
269
|
+
type GameEvent = SystemActionEvent;
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
_No JSDoc summary is available yet._
|
|
273
|
+
|
|
274
|
+
### GameEventDetail
|
|
275
|
+
|
|
276
|
+
```ts
|
|
277
|
+
interface GameEventDetail {
|
|
278
|
+
readonly label: string;
|
|
279
|
+
readonly value: string | number | boolean;
|
|
280
|
+
}
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
_No JSDoc summary is available yet._
|
|
284
|
+
|
|
285
|
+
### GameEventDetailSchema
|
|
286
|
+
|
|
287
|
+
```ts
|
|
288
|
+
const GameEventDetailSchema: z.ZodObject<
|
|
289
|
+
{
|
|
290
|
+
label: z.ZodString;
|
|
291
|
+
value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
|
|
292
|
+
},
|
|
293
|
+
z.core.$strict
|
|
294
|
+
>;
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
_No JSDoc summary is available yet._
|
|
298
|
+
|
|
299
|
+
### GameEventSchema
|
|
300
|
+
|
|
301
|
+
```ts
|
|
302
|
+
declare const GameEventSchema: z.ZodDiscriminatedUnion<
|
|
303
|
+
[
|
|
304
|
+
z.ZodObject<
|
|
305
|
+
{
|
|
306
|
+
kind: z.ZodLiteral<"systemAction">;
|
|
307
|
+
procedureId: z.ZodString;
|
|
308
|
+
title: z.ZodString;
|
|
309
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
310
|
+
details: z.ZodOptional<
|
|
311
|
+
z.ZodArray<
|
|
312
|
+
z.ZodObject<
|
|
313
|
+
{
|
|
314
|
+
label: z.ZodString;
|
|
315
|
+
value: z.ZodUnion<
|
|
316
|
+
readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]
|
|
317
|
+
>;
|
|
318
|
+
},
|
|
319
|
+
z.core.$strict
|
|
320
|
+
>
|
|
321
|
+
>
|
|
322
|
+
>;
|
|
323
|
+
},
|
|
324
|
+
z.core.$strict
|
|
325
|
+
>,
|
|
326
|
+
],
|
|
327
|
+
"kind"
|
|
328
|
+
>;
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
_No JSDoc summary is available yet._
|
|
332
|
+
|
|
333
|
+
### GameOutcome
|
|
334
|
+
|
|
335
|
+
```ts
|
|
336
|
+
interface GameOutcome<Player extends string = string> {
|
|
337
|
+
readonly reason: {
|
|
338
|
+
readonly code: string;
|
|
339
|
+
readonly message?: string;
|
|
340
|
+
};
|
|
341
|
+
readonly standings: readonly OutcomeStanding<Player>[];
|
|
342
|
+
}
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
_No JSDoc summary is available yet._
|
|
346
|
+
|
|
347
|
+
### GameOutcomeSchema
|
|
348
|
+
|
|
349
|
+
```ts
|
|
350
|
+
declare const GameOutcomeSchema: ...;
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
_No JSDoc summary is available yet._
|
|
354
|
+
|
|
355
|
+
### GameplayBasis
|
|
356
|
+
|
|
357
|
+
```ts
|
|
358
|
+
interface GameplayBasis {
|
|
359
|
+
readonly generation: number;
|
|
360
|
+
readonly version: number;
|
|
361
|
+
readonly actionSetVersion: string;
|
|
362
|
+
readonly perspectivePlayerId: PlayerId;
|
|
363
|
+
}
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
_No JSDoc summary is available yet._
|
|
367
|
+
|
|
368
|
+
### GameplayBasisSchema
|
|
369
|
+
|
|
370
|
+
```ts
|
|
371
|
+
const GameplayBasisSchema: z.ZodObject<
|
|
372
|
+
{
|
|
373
|
+
generation: z.ZodNumber;
|
|
374
|
+
version: z.ZodNumber;
|
|
375
|
+
actionSetVersion: z.ZodString;
|
|
376
|
+
perspectivePlayerId: z.ZodString;
|
|
377
|
+
},
|
|
378
|
+
z.core.$strict
|
|
379
|
+
>;
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
_No JSDoc summary is available yet._
|
|
383
|
+
|
|
384
|
+
### HostToPluginEnvelope
|
|
385
|
+
|
|
386
|
+
```ts
|
|
387
|
+
type HostToPluginEnvelope = PluginProtocolEnvelope<HostToPluginPayload>;
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
_No JSDoc summary is available yet._
|
|
391
|
+
|
|
392
|
+
### HostToPluginEnvelopeSchema
|
|
393
|
+
|
|
394
|
+
```ts
|
|
395
|
+
const HostToPluginEnvelopeSchema: z.ZodType<
|
|
396
|
+
PluginProtocolEnvelope<HostToPluginPayload>,
|
|
397
|
+
unknown,
|
|
398
|
+
z.core.$ZodTypeInternals<PluginProtocolEnvelope<HostToPluginPayload>, unknown>
|
|
399
|
+
>;
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
_No JSDoc summary is available yet._
|
|
403
|
+
|
|
404
|
+
### HostToPluginPayload
|
|
405
|
+
|
|
406
|
+
```ts
|
|
407
|
+
type HostToPluginPayload =
|
|
408
|
+
| {
|
|
409
|
+
readonly type: "runtime.init";
|
|
410
|
+
readonly session: PluginSessionDescriptor;
|
|
411
|
+
}
|
|
412
|
+
| {
|
|
413
|
+
readonly type: "gameplay.frame";
|
|
414
|
+
readonly frame: PluginGameplayFrame;
|
|
415
|
+
}
|
|
416
|
+
| InteractionResult;
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
_No JSDoc summary is available yet._
|
|
420
|
+
|
|
421
|
+
### HostToPluginPayloadSchema
|
|
422
|
+
|
|
423
|
+
```ts
|
|
424
|
+
const HostToPluginPayloadSchema: z.ZodType<HostToPluginPayload>;
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
_No JSDoc summary is available yet._
|
|
428
|
+
|
|
429
|
+
### InputDomain
|
|
430
|
+
|
|
431
|
+
```ts
|
|
432
|
+
interface InputDomain {
|
|
433
|
+
readonly type: string;
|
|
434
|
+
readonly selection?: InputSelection;
|
|
435
|
+
readonly dependencies?: InputDomainDependencies;
|
|
436
|
+
readonly [key: string]:
|
|
437
|
+
| RuntimeJson
|
|
438
|
+
| InputSelection
|
|
439
|
+
| InputDomainDependencies
|
|
440
|
+
| undefined;
|
|
441
|
+
}
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
_No JSDoc summary is available yet._
|
|
445
|
+
|
|
446
|
+
### InputDomainDependencies
|
|
447
|
+
|
|
448
|
+
```ts
|
|
449
|
+
type InputDomainDependencies =
|
|
450
|
+
| {
|
|
451
|
+
readonly mode: "eager";
|
|
452
|
+
readonly dependentCases: readonly InputDomainDependencyCase[];
|
|
453
|
+
}
|
|
454
|
+
| {
|
|
455
|
+
readonly mode: "lazy";
|
|
456
|
+
readonly dependsOn: readonly string[];
|
|
457
|
+
readonly resolver: {
|
|
458
|
+
readonly interactionKey?: string;
|
|
459
|
+
readonly inputKey: string;
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
_No JSDoc summary is available yet._
|
|
465
|
+
|
|
466
|
+
### InputDomainDependenciesSchema
|
|
467
|
+
|
|
468
|
+
```ts
|
|
469
|
+
declare const InputDomainDependenciesSchema: ...;
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
_No JSDoc summary is available yet._
|
|
473
|
+
|
|
474
|
+
### InputDomainDependencyCase
|
|
475
|
+
|
|
476
|
+
```ts
|
|
477
|
+
interface InputDomainDependencyCase {
|
|
478
|
+
readonly when: Readonly<Record<string, string>>;
|
|
479
|
+
readonly domain: InputDomain;
|
|
480
|
+
}
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
_No JSDoc summary is available yet._
|
|
484
|
+
|
|
485
|
+
### InputDomainSchema
|
|
486
|
+
|
|
487
|
+
```ts
|
|
488
|
+
declare const InputDomainSchema: ...;
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
_No JSDoc summary is available yet._
|
|
492
|
+
|
|
493
|
+
### InputSelection
|
|
494
|
+
|
|
495
|
+
```ts
|
|
496
|
+
type InputSelection =
|
|
497
|
+
| {
|
|
498
|
+
readonly mode: "single";
|
|
499
|
+
}
|
|
500
|
+
| {
|
|
501
|
+
readonly mode: "many";
|
|
502
|
+
readonly min: number;
|
|
503
|
+
readonly max?: number;
|
|
504
|
+
readonly distinct?: boolean;
|
|
505
|
+
};
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
_No JSDoc summary is available yet._
|
|
509
|
+
|
|
510
|
+
### InteractionAvailability
|
|
511
|
+
|
|
512
|
+
```ts
|
|
513
|
+
type InteractionAvailability =
|
|
514
|
+
| {
|
|
515
|
+
readonly status: "available";
|
|
516
|
+
}
|
|
517
|
+
| {
|
|
518
|
+
readonly status: "notYourTurn";
|
|
519
|
+
readonly reason: string;
|
|
520
|
+
}
|
|
521
|
+
| {
|
|
522
|
+
readonly status: "insufficientResources";
|
|
523
|
+
readonly reason: string;
|
|
524
|
+
readonly missingResources: Readonly<Record<string, number>>;
|
|
525
|
+
}
|
|
526
|
+
| {
|
|
527
|
+
readonly status: "blocked";
|
|
528
|
+
readonly reason: string;
|
|
529
|
+
readonly code?: string;
|
|
530
|
+
};
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
_No JSDoc summary is available yet._
|
|
534
|
+
|
|
535
|
+
### InteractionAvailabilitySchema
|
|
536
|
+
|
|
537
|
+
```ts
|
|
538
|
+
declare const InteractionAvailabilitySchema: ...;
|
|
539
|
+
```
|
|
540
|
+
|
|
541
|
+
_No JSDoc summary is available yet._
|
|
542
|
+
|
|
543
|
+
### InteractionChoiceOption
|
|
544
|
+
|
|
545
|
+
```ts
|
|
546
|
+
interface InteractionChoiceOption {
|
|
547
|
+
readonly value: string | null;
|
|
548
|
+
readonly label: string;
|
|
549
|
+
readonly icon?: string;
|
|
550
|
+
readonly badge?: string;
|
|
551
|
+
readonly description?: string;
|
|
552
|
+
readonly disabled?: boolean;
|
|
553
|
+
readonly disabledReason?: string;
|
|
554
|
+
}
|
|
555
|
+
```
|
|
556
|
+
|
|
557
|
+
_No JSDoc summary is available yet._
|
|
558
|
+
|
|
559
|
+
### InteractionCommitPolicy
|
|
560
|
+
|
|
561
|
+
```ts
|
|
562
|
+
interface InteractionCommitPolicy {
|
|
563
|
+
readonly mode: "manual" | "autoWhenReady";
|
|
564
|
+
}
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
_No JSDoc summary is available yet._
|
|
568
|
+
|
|
569
|
+
### InteractionCommitPolicySchema
|
|
570
|
+
|
|
571
|
+
```ts
|
|
572
|
+
const InteractionCommitPolicySchema: z.ZodDiscriminatedUnion<
|
|
573
|
+
[
|
|
574
|
+
z.ZodObject<
|
|
575
|
+
{
|
|
576
|
+
mode: z.ZodLiteral<"manual">;
|
|
577
|
+
},
|
|
578
|
+
z.core.$strict
|
|
579
|
+
>,
|
|
580
|
+
z.ZodObject<
|
|
581
|
+
{
|
|
582
|
+
mode: z.ZodLiteral<"autoWhenReady">;
|
|
583
|
+
},
|
|
584
|
+
z.core.$strict
|
|
585
|
+
>,
|
|
586
|
+
],
|
|
587
|
+
"mode"
|
|
588
|
+
>;
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
_No JSDoc summary is available yet._
|
|
592
|
+
|
|
593
|
+
### InteractionContext
|
|
594
|
+
|
|
595
|
+
```ts
|
|
596
|
+
interface InteractionContext {
|
|
597
|
+
readonly to: string;
|
|
598
|
+
readonly title?: string;
|
|
599
|
+
readonly payload?: Readonly<Record<string, RuntimeJson>>;
|
|
600
|
+
readonly options?: readonly InteractionContextOption[];
|
|
601
|
+
}
|
|
602
|
+
```
|
|
603
|
+
|
|
604
|
+
_No JSDoc summary is available yet._
|
|
605
|
+
|
|
606
|
+
### InteractionContextOption
|
|
607
|
+
|
|
608
|
+
```ts
|
|
609
|
+
interface InteractionContextOption {
|
|
610
|
+
readonly id: string;
|
|
611
|
+
readonly label?: string;
|
|
612
|
+
}
|
|
613
|
+
```
|
|
614
|
+
|
|
615
|
+
_No JSDoc summary is available yet._
|
|
616
|
+
|
|
617
|
+
### InteractionContextSchema
|
|
618
|
+
|
|
619
|
+
```ts
|
|
620
|
+
declare const InteractionContextSchema: z.ZodObject<
|
|
621
|
+
{
|
|
622
|
+
to: z.ZodString;
|
|
623
|
+
title: z.ZodOptional<z.ZodString>;
|
|
624
|
+
payload: z.ZodOptional<
|
|
625
|
+
z.ZodRecord<
|
|
626
|
+
z.ZodString,
|
|
627
|
+
z.ZodType<
|
|
628
|
+
RuntimeJson,
|
|
629
|
+
unknown,
|
|
630
|
+
z.core.$ZodTypeInternals<RuntimeJson, unknown>
|
|
631
|
+
>
|
|
632
|
+
>
|
|
633
|
+
>;
|
|
634
|
+
options: z.ZodOptional<
|
|
635
|
+
z.ZodArray<
|
|
636
|
+
z.ZodObject<
|
|
637
|
+
{ id: z.ZodString; label: z.ZodOptional<z.ZodString> },
|
|
638
|
+
z.core.$strict
|
|
639
|
+
>
|
|
640
|
+
>
|
|
641
|
+
>;
|
|
642
|
+
},
|
|
643
|
+
z.core.$strict
|
|
644
|
+
>;
|
|
645
|
+
```
|
|
646
|
+
|
|
647
|
+
_No JSDoc summary is available yet._
|
|
648
|
+
|
|
649
|
+
### InteractionDescriptor
|
|
650
|
+
|
|
651
|
+
```ts
|
|
652
|
+
type InteractionDescriptor<Interaction extends string = string> =
|
|
653
|
+
| ActionInteractionDescriptor<Interaction>
|
|
654
|
+
| PromptInteractionDescriptor<Interaction>;
|
|
655
|
+
```
|
|
656
|
+
|
|
657
|
+
_No JSDoc summary is available yet._
|
|
658
|
+
|
|
659
|
+
### InteractionDescriptorSchema
|
|
660
|
+
|
|
661
|
+
```ts
|
|
662
|
+
const InteractionDescriptorSchema: z.ZodType<InteractionDescriptor>;
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
_No JSDoc summary is available yet._
|
|
666
|
+
|
|
667
|
+
### InteractionDiagnosticReason
|
|
668
|
+
|
|
669
|
+
```ts
|
|
670
|
+
interface InteractionDiagnosticReason {
|
|
671
|
+
readonly ruleId: string;
|
|
672
|
+
readonly errorCode: string;
|
|
673
|
+
}
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
_No JSDoc summary is available yet._
|
|
677
|
+
|
|
678
|
+
### InteractionInputDescriptor
|
|
679
|
+
|
|
680
|
+
```ts
|
|
681
|
+
interface InteractionInputDescriptor {
|
|
682
|
+
readonly key: string;
|
|
683
|
+
readonly kind: string;
|
|
684
|
+
readonly domain: InputDomain;
|
|
685
|
+
readonly defaultValue?: RuntimeJson;
|
|
686
|
+
}
|
|
687
|
+
```
|
|
688
|
+
|
|
689
|
+
_No JSDoc summary is available yet._
|
|
690
|
+
|
|
691
|
+
### InteractionInputDescriptorSchema
|
|
692
|
+
|
|
693
|
+
```ts
|
|
694
|
+
declare const InteractionInputDescriptorSchema: ...;
|
|
695
|
+
```
|
|
696
|
+
|
|
697
|
+
_No JSDoc summary is available yet._
|
|
698
|
+
|
|
699
|
+
### InteractionResult
|
|
700
|
+
|
|
701
|
+
```ts
|
|
702
|
+
type InteractionResult =
|
|
703
|
+
| {
|
|
704
|
+
readonly type: "interaction.result";
|
|
705
|
+
readonly clientActionId: string;
|
|
706
|
+
readonly accepted: true;
|
|
707
|
+
}
|
|
708
|
+
| {
|
|
709
|
+
readonly type: "interaction.result";
|
|
710
|
+
readonly clientActionId: string;
|
|
711
|
+
readonly accepted: false;
|
|
712
|
+
readonly errorCode: string;
|
|
713
|
+
readonly message?: string;
|
|
714
|
+
};
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
_No JSDoc summary is available yet._
|
|
718
|
+
|
|
719
|
+
### InteractionResultSchema
|
|
720
|
+
|
|
721
|
+
```ts
|
|
722
|
+
declare const InteractionResultSchema: z.ZodDiscriminatedUnion<
|
|
723
|
+
[
|
|
724
|
+
z.ZodObject<
|
|
725
|
+
{
|
|
726
|
+
type: z.ZodLiteral<"interaction.result">;
|
|
727
|
+
clientActionId: z.ZodString;
|
|
728
|
+
accepted: z.ZodLiteral<true>;
|
|
729
|
+
},
|
|
730
|
+
z.core.$strict
|
|
731
|
+
>,
|
|
732
|
+
z.ZodObject<
|
|
733
|
+
{
|
|
734
|
+
type: z.ZodLiteral<"interaction.result">;
|
|
735
|
+
clientActionId: z.ZodString;
|
|
736
|
+
accepted: z.ZodLiteral<false>;
|
|
737
|
+
errorCode: z.ZodString;
|
|
738
|
+
message: z.ZodOptional<z.ZodString>;
|
|
739
|
+
},
|
|
740
|
+
z.core.$strict
|
|
741
|
+
>,
|
|
742
|
+
],
|
|
743
|
+
"accepted"
|
|
744
|
+
>;
|
|
745
|
+
```
|
|
746
|
+
|
|
747
|
+
_No JSDoc summary is available yet._
|
|
748
|
+
|
|
749
|
+
### materializePluginGameplayFrame
|
|
750
|
+
|
|
751
|
+
```ts
|
|
752
|
+
function materializePluginGameplayFrame(
|
|
753
|
+
input: MaterializePluginGameplayFrameInput,
|
|
754
|
+
): v;
|
|
755
|
+
```
|
|
756
|
+
|
|
757
|
+
_No JSDoc summary is available yet._
|
|
758
|
+
|
|
759
|
+
### MaterializePluginGameplayFrameInput
|
|
760
|
+
|
|
761
|
+
```ts
|
|
762
|
+
interface MaterializePluginGameplayFrameInput {
|
|
763
|
+
readonly currentPhase: string | null;
|
|
764
|
+
readonly activePlayers: readonly P[];
|
|
765
|
+
readonly dynamicProjection: M;
|
|
766
|
+
readonly staticProjection?: R | null;
|
|
767
|
+
readonly perspectivePlayerId: P;
|
|
768
|
+
readonly generation: number;
|
|
769
|
+
readonly version: number;
|
|
770
|
+
readonly actionSetVersion: string;
|
|
771
|
+
}
|
|
772
|
+
```
|
|
773
|
+
|
|
774
|
+
_No JSDoc summary is available yet._
|
|
775
|
+
|
|
776
|
+
### OutcomeResult
|
|
777
|
+
|
|
778
|
+
```ts
|
|
779
|
+
type OutcomeResult = "win" | "draw" | "loss" | "eliminated";
|
|
780
|
+
```
|
|
781
|
+
|
|
782
|
+
_No JSDoc summary is available yet._
|
|
783
|
+
|
|
784
|
+
### OutcomeScoreComponent
|
|
785
|
+
|
|
786
|
+
```ts
|
|
787
|
+
interface OutcomeScoreComponent {
|
|
788
|
+
readonly id: string;
|
|
789
|
+
readonly label: string;
|
|
790
|
+
readonly value: number;
|
|
791
|
+
}
|
|
792
|
+
```
|
|
793
|
+
|
|
794
|
+
_No JSDoc summary is available yet._
|
|
795
|
+
|
|
796
|
+
### OutcomeStanding
|
|
797
|
+
|
|
798
|
+
```ts
|
|
799
|
+
interface OutcomeStanding<Player extends string = string> {
|
|
800
|
+
readonly playerId: Player;
|
|
801
|
+
readonly rank: number;
|
|
802
|
+
readonly result: OutcomeResult;
|
|
803
|
+
readonly score?: number;
|
|
804
|
+
readonly scoreBreakdown?: readonly OutcomeScoreComponent[];
|
|
805
|
+
readonly tieBreaks?: readonly OutcomeTieBreak[];
|
|
806
|
+
}
|
|
807
|
+
```
|
|
808
|
+
|
|
809
|
+
_No JSDoc summary is available yet._
|
|
810
|
+
|
|
811
|
+
### OutcomeTieBreak
|
|
812
|
+
|
|
813
|
+
```ts
|
|
814
|
+
interface OutcomeTieBreak {
|
|
815
|
+
readonly id: string;
|
|
816
|
+
readonly label: string;
|
|
817
|
+
readonly value: number | string;
|
|
818
|
+
}
|
|
819
|
+
```
|
|
820
|
+
|
|
821
|
+
_No JSDoc summary is available yet._
|
|
822
|
+
|
|
823
|
+
### parseHostToPluginEnvelope
|
|
824
|
+
|
|
825
|
+
```ts
|
|
826
|
+
function parseHostToPluginEnvelope(
|
|
827
|
+
value: unknown,
|
|
828
|
+
): PluginProtocolEnvelope<HostToPluginPayload>;
|
|
829
|
+
```
|
|
830
|
+
|
|
831
|
+
_No JSDoc summary is available yet._
|
|
832
|
+
|
|
833
|
+
### parsePluginGameplayFrame
|
|
834
|
+
|
|
835
|
+
```ts
|
|
836
|
+
function parsePluginGameplayFrame(value: unknown): PluginGameplayFrame;
|
|
837
|
+
```
|
|
838
|
+
|
|
839
|
+
_No JSDoc summary is available yet._
|
|
840
|
+
|
|
841
|
+
### parsePluginSessionDescriptor
|
|
842
|
+
|
|
843
|
+
```ts
|
|
844
|
+
function parsePluginSessionDescriptor(value: unknown): PluginSessionDescriptor;
|
|
845
|
+
```
|
|
846
|
+
|
|
847
|
+
_No JSDoc summary is available yet._
|
|
848
|
+
|
|
849
|
+
### parsePluginToHostEnvelope
|
|
850
|
+
|
|
851
|
+
```ts
|
|
852
|
+
function parsePluginToHostEnvelope(
|
|
853
|
+
value: unknown,
|
|
854
|
+
): PluginProtocolEnvelope<PluginToHostPayload>;
|
|
855
|
+
```
|
|
856
|
+
|
|
857
|
+
_No JSDoc summary is available yet._
|
|
858
|
+
|
|
859
|
+
### PlayerId
|
|
860
|
+
|
|
861
|
+
```ts
|
|
862
|
+
type PlayerId = string;
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
_No JSDoc summary is available yet._
|
|
866
|
+
|
|
867
|
+
### PluginGameplayFrame
|
|
868
|
+
|
|
869
|
+
```ts
|
|
870
|
+
interface PluginGameplayFrame { ... }
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
_No JSDoc summary is available yet._
|
|
874
|
+
|
|
875
|
+
### PluginGameplayFrameSchema
|
|
876
|
+
|
|
877
|
+
```ts
|
|
878
|
+
const PluginGameplayFrameSchema: z.ZodType<PluginGameplayFrame>;
|
|
879
|
+
```
|
|
880
|
+
|
|
881
|
+
_No JSDoc summary is available yet._
|
|
882
|
+
|
|
883
|
+
### PluginPlayerSummary
|
|
884
|
+
|
|
885
|
+
```ts
|
|
886
|
+
interface PluginPlayerSummary {
|
|
887
|
+
readonly playerId: PlayerId;
|
|
888
|
+
readonly displayName: string;
|
|
889
|
+
readonly color?: string;
|
|
890
|
+
}
|
|
891
|
+
```
|
|
892
|
+
|
|
893
|
+
_No JSDoc summary is available yet._
|
|
894
|
+
|
|
895
|
+
### PluginPlayerSummarySchema
|
|
896
|
+
|
|
897
|
+
```ts
|
|
898
|
+
const PluginPlayerSummarySchema: z.ZodObject<
|
|
899
|
+
{
|
|
900
|
+
playerId: z.ZodString;
|
|
901
|
+
displayName: z.ZodString;
|
|
902
|
+
color: z.ZodOptional<z.ZodString>;
|
|
903
|
+
},
|
|
904
|
+
z.core.$strict
|
|
905
|
+
>;
|
|
906
|
+
```
|
|
907
|
+
|
|
908
|
+
_No JSDoc summary is available yet._
|
|
909
|
+
|
|
910
|
+
### PluginProtocolEnvelope
|
|
911
|
+
|
|
912
|
+
```ts
|
|
913
|
+
interface PluginProtocolEnvelope<Payload> {
|
|
914
|
+
readonly protocol: typeof DREAMBOARD_PLUGIN_PROTOCOL;
|
|
915
|
+
readonly version: typeof DREAMBOARD_PLUGIN_PROTOCOL_VERSION;
|
|
916
|
+
readonly channelId: string;
|
|
917
|
+
/** Delivery order only. It is not a game revision. */
|
|
918
|
+
readonly sequence: number;
|
|
919
|
+
readonly payload: Payload;
|
|
920
|
+
}
|
|
921
|
+
```
|
|
922
|
+
|
|
923
|
+
_No JSDoc summary is available yet._
|
|
924
|
+
|
|
925
|
+
### PluginProtocolFrame
|
|
926
|
+
|
|
927
|
+
```ts
|
|
928
|
+
interface PluginProtocolFrame {
|
|
929
|
+
readonly id: string;
|
|
930
|
+
readonly frame: PluginGameplayFrame;
|
|
931
|
+
readonly projectionDigest: string;
|
|
932
|
+
}
|
|
933
|
+
```
|
|
934
|
+
|
|
935
|
+
_No JSDoc summary is available yet._
|
|
936
|
+
|
|
937
|
+
### PluginProtocolFrameSchema
|
|
938
|
+
|
|
939
|
+
```ts
|
|
940
|
+
const PluginProtocolFrameSchema: z.ZodObject<
|
|
941
|
+
{
|
|
942
|
+
id: z.ZodString;
|
|
943
|
+
frame: z.ZodType<
|
|
944
|
+
PluginGameplayFrame<unknown, string, string, string>,
|
|
945
|
+
unknown,
|
|
946
|
+
z.core.$ZodTypeInternals<
|
|
947
|
+
PluginGameplayFrame<unknown, string, string, string>,
|
|
948
|
+
unknown
|
|
949
|
+
>
|
|
950
|
+
>;
|
|
951
|
+
projectionDigest: z.ZodString;
|
|
952
|
+
},
|
|
953
|
+
z.core.$strict
|
|
954
|
+
>;
|
|
955
|
+
```
|
|
956
|
+
|
|
957
|
+
_No JSDoc summary is available yet._
|
|
958
|
+
|
|
959
|
+
### PluginProtocolStep
|
|
960
|
+
|
|
961
|
+
```ts
|
|
962
|
+
type PluginProtocolStep =
|
|
963
|
+
| {
|
|
964
|
+
readonly id: string;
|
|
965
|
+
readonly kind: "host.frame";
|
|
966
|
+
readonly frameId: string;
|
|
967
|
+
}
|
|
968
|
+
| {
|
|
969
|
+
readonly id: string;
|
|
970
|
+
readonly kind: "client.submit";
|
|
971
|
+
readonly fromFrameId: string;
|
|
972
|
+
readonly requestDigest: string;
|
|
973
|
+
readonly response: InteractionResult;
|
|
974
|
+
};
|
|
975
|
+
```
|
|
976
|
+
|
|
977
|
+
_No JSDoc summary is available yet._
|
|
978
|
+
|
|
979
|
+
### PluginProtocolStepSchema
|
|
980
|
+
|
|
981
|
+
```ts
|
|
982
|
+
declare const PluginProtocolStepSchema: ...;
|
|
983
|
+
```
|
|
984
|
+
|
|
985
|
+
_No JSDoc summary is available yet._
|
|
986
|
+
|
|
987
|
+
### PluginProtocolTape
|
|
988
|
+
|
|
989
|
+
```ts
|
|
990
|
+
interface PluginProtocolTape {
|
|
991
|
+
readonly session: PluginSessionDescriptor;
|
|
992
|
+
readonly frames: readonly PluginProtocolFrame[];
|
|
993
|
+
readonly steps: readonly PluginProtocolStep[];
|
|
994
|
+
}
|
|
995
|
+
```
|
|
996
|
+
|
|
997
|
+
_No JSDoc summary is available yet._
|
|
998
|
+
|
|
999
|
+
### PluginProtocolTapeSchema
|
|
1000
|
+
|
|
1001
|
+
```ts
|
|
1002
|
+
const PluginProtocolTapeSchema: z.ZodType<PluginProtocolTape>;
|
|
1003
|
+
```
|
|
1004
|
+
|
|
1005
|
+
_No JSDoc summary is available yet._
|
|
1006
|
+
|
|
1007
|
+
### PluginSessionDescriptor
|
|
1008
|
+
|
|
1009
|
+
```ts
|
|
1010
|
+
interface PluginSessionDescriptor {
|
|
1011
|
+
readonly sessionId: string;
|
|
1012
|
+
/** Turn order is the order of this array. */
|
|
1013
|
+
readonly players: readonly PluginPlayerSummary[];
|
|
1014
|
+
}
|
|
1015
|
+
```
|
|
1016
|
+
|
|
1017
|
+
_No JSDoc summary is available yet._
|
|
1018
|
+
|
|
1019
|
+
### PluginSessionDescriptorSchema
|
|
1020
|
+
|
|
1021
|
+
```ts
|
|
1022
|
+
const PluginSessionDescriptorSchema: z.ZodObject<
|
|
1023
|
+
{
|
|
1024
|
+
sessionId: z.ZodString;
|
|
1025
|
+
players: z.ZodArray<
|
|
1026
|
+
z.ZodObject<
|
|
1027
|
+
{
|
|
1028
|
+
playerId: z.ZodString;
|
|
1029
|
+
displayName: z.ZodString;
|
|
1030
|
+
color: z.ZodOptional<z.ZodString>;
|
|
1031
|
+
},
|
|
1032
|
+
z.core.$strict
|
|
1033
|
+
>
|
|
1034
|
+
>;
|
|
1035
|
+
},
|
|
1036
|
+
z.core.$strict
|
|
1037
|
+
>;
|
|
1038
|
+
```
|
|
1039
|
+
|
|
1040
|
+
_No JSDoc summary is available yet._
|
|
1041
|
+
|
|
1042
|
+
### PluginToHostEnvelope
|
|
1043
|
+
|
|
1044
|
+
```ts
|
|
1045
|
+
type PluginToHostEnvelope = PluginProtocolEnvelope<PluginToHostPayload>;
|
|
1046
|
+
```
|
|
1047
|
+
|
|
1048
|
+
_No JSDoc summary is available yet._
|
|
1049
|
+
|
|
1050
|
+
### PluginToHostEnvelopeSchema
|
|
1051
|
+
|
|
1052
|
+
```ts
|
|
1053
|
+
declare const PluginToHostEnvelopeSchema: ...;
|
|
1054
|
+
```
|
|
1055
|
+
|
|
1056
|
+
_No JSDoc summary is available yet._
|
|
1057
|
+
|
|
1058
|
+
### PluginToHostPayload
|
|
1059
|
+
|
|
1060
|
+
```ts
|
|
1061
|
+
type PluginToHostPayload = ...;
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
_No JSDoc summary is available yet._
|
|
1065
|
+
|
|
1066
|
+
### PluginToHostPayloadSchema
|
|
1067
|
+
|
|
1068
|
+
```ts
|
|
1069
|
+
declare const PluginToHostPayloadSchema: ...;
|
|
1070
|
+
```
|
|
1071
|
+
|
|
1072
|
+
_No JSDoc summary is available yet._
|
|
1073
|
+
|
|
1074
|
+
### ProjectedGameEvent
|
|
1075
|
+
|
|
1076
|
+
```ts
|
|
1077
|
+
type ProjectedGameEvent = GameEvent & {
|
|
1078
|
+
readonly version: number;
|
|
1079
|
+
readonly index: number;
|
|
1080
|
+
};
|
|
1081
|
+
```
|
|
1082
|
+
|
|
1083
|
+
_No JSDoc summary is available yet._
|
|
1084
|
+
|
|
1085
|
+
### ProjectedGameEventSchema
|
|
1086
|
+
|
|
1087
|
+
```ts
|
|
1088
|
+
declare const ProjectedGameEventSchema: ...;
|
|
1089
|
+
```
|
|
1090
|
+
|
|
1091
|
+
_No JSDoc summary is available yet._
|
|
1092
|
+
|
|
1093
|
+
### PromptInteractionDescriptor
|
|
1094
|
+
|
|
1095
|
+
```ts
|
|
1096
|
+
type PromptInteractionDescriptor<Interaction extends string = string> =
|
|
1097
|
+
InteractionDescriptorBase<Interaction> & {
|
|
1098
|
+
readonly kind: "prompt";
|
|
1099
|
+
readonly context: InteractionContext;
|
|
1100
|
+
};
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
_No JSDoc summary is available yet._
|
|
1104
|
+
|
|
1105
|
+
### ReducerBoardStaticProjection
|
|
1106
|
+
|
|
1107
|
+
```ts
|
|
1108
|
+
interface ReducerBoardStaticProjection {
|
|
1109
|
+
readonly view: RuntimeJson;
|
|
1110
|
+
readonly hash?: string;
|
|
1111
|
+
readonly manifestVersion?: string;
|
|
1112
|
+
}
|
|
1113
|
+
```
|
|
1114
|
+
|
|
1115
|
+
_No JSDoc summary is available yet._
|
|
1116
|
+
|
|
1117
|
+
### ReducerSeatProjectionBundle
|
|
1118
|
+
|
|
1119
|
+
```ts
|
|
1120
|
+
interface ReducerSeatProjectionBundle { ... }
|
|
1121
|
+
```
|
|
1122
|
+
|
|
1123
|
+
_No JSDoc summary is available yet._
|
|
1124
|
+
|
|
1125
|
+
### RuntimeJson
|
|
1126
|
+
|
|
1127
|
+
```ts
|
|
1128
|
+
type RuntimeJson =
|
|
1129
|
+
| null
|
|
1130
|
+
| boolean
|
|
1131
|
+
| number
|
|
1132
|
+
| string
|
|
1133
|
+
| RuntimeJson[]
|
|
1134
|
+
| {
|
|
1135
|
+
[key: string]: RuntimeJson;
|
|
1136
|
+
};
|
|
1137
|
+
```
|
|
1138
|
+
|
|
1139
|
+
_No JSDoc summary is available yet._
|
|
1140
|
+
|
|
1141
|
+
### RuntimeJsonSchema
|
|
1142
|
+
|
|
1143
|
+
```ts
|
|
1144
|
+
const RuntimeJsonSchema: z.ZodType<RuntimeJson>;
|
|
1145
|
+
```
|
|
1146
|
+
|
|
1147
|
+
_No JSDoc summary is available yet._
|
|
1148
|
+
|
|
1149
|
+
### SeatProjectionBundleSchema
|
|
1150
|
+
|
|
1151
|
+
```ts
|
|
1152
|
+
declare const SeatProjectionBundleSchema: ...;
|
|
1153
|
+
```
|
|
1154
|
+
|
|
1155
|
+
_No JSDoc summary is available yet._
|
|
1156
|
+
|
|
1157
|
+
### SimultaneousPhaseSnapshot
|
|
1158
|
+
|
|
1159
|
+
```ts
|
|
1160
|
+
interface SimultaneousPhaseSnapshot {
|
|
1161
|
+
readonly phaseName: string;
|
|
1162
|
+
readonly interactionId: string;
|
|
1163
|
+
readonly actorIds: readonly PlayerId[];
|
|
1164
|
+
readonly sealedPlayerIds: readonly PlayerId[];
|
|
1165
|
+
readonly pendingPlayerIds: readonly PlayerId[];
|
|
1166
|
+
}
|
|
1167
|
+
```
|
|
1168
|
+
|
|
1169
|
+
_No JSDoc summary is available yet._
|
|
1170
|
+
|
|
1171
|
+
### SimultaneousPhaseSnapshotSchema
|
|
1172
|
+
|
|
1173
|
+
```ts
|
|
1174
|
+
const SimultaneousPhaseSnapshotSchema: z.ZodObject<
|
|
1175
|
+
{
|
|
1176
|
+
phaseName: z.ZodString;
|
|
1177
|
+
interactionId: z.ZodString;
|
|
1178
|
+
actorIds: z.ZodArray<z.ZodString>;
|
|
1179
|
+
sealedPlayerIds: z.ZodArray<z.ZodString>;
|
|
1180
|
+
pendingPlayerIds: z.ZodArray<z.ZodString>;
|
|
1181
|
+
},
|
|
1182
|
+
z.core.$strict
|
|
1183
|
+
>;
|
|
1184
|
+
```
|
|
1185
|
+
|
|
1186
|
+
_No JSDoc summary is available yet._
|
|
1187
|
+
|
|
1188
|
+
### SubmitInteractionCommand
|
|
1189
|
+
|
|
1190
|
+
```ts
|
|
1191
|
+
interface SubmitInteractionCommand {
|
|
1192
|
+
readonly type: "interaction.submit";
|
|
1193
|
+
readonly clientActionId: string;
|
|
1194
|
+
readonly basis: GameplayBasis;
|
|
1195
|
+
readonly interactionId: string;
|
|
1196
|
+
readonly params: RuntimeJson;
|
|
1197
|
+
}
|
|
1198
|
+
```
|
|
1199
|
+
|
|
1200
|
+
_No JSDoc summary is available yet._
|
|
1201
|
+
|
|
1202
|
+
### SubmitInteractionCommandSchema
|
|
1203
|
+
|
|
1204
|
+
```ts
|
|
1205
|
+
declare const SubmitInteractionCommandSchema: z.ZodObject<
|
|
1206
|
+
{
|
|
1207
|
+
type: z.ZodLiteral<"interaction.submit">;
|
|
1208
|
+
clientActionId: z.ZodString;
|
|
1209
|
+
basis: z.ZodObject<
|
|
1210
|
+
{
|
|
1211
|
+
generation: z.ZodNumber;
|
|
1212
|
+
version: z.ZodNumber;
|
|
1213
|
+
actionSetVersion: z.ZodString;
|
|
1214
|
+
perspectivePlayerId: z.ZodString;
|
|
1215
|
+
},
|
|
1216
|
+
z.core.$strict
|
|
1217
|
+
>;
|
|
1218
|
+
interactionId: z.ZodString;
|
|
1219
|
+
params: z.ZodType<
|
|
1220
|
+
RuntimeJson,
|
|
1221
|
+
unknown,
|
|
1222
|
+
z.core.$ZodTypeInternals<RuntimeJson, unknown>
|
|
1223
|
+
>;
|
|
1224
|
+
},
|
|
1225
|
+
z.core.$strict
|
|
1226
|
+
>;
|
|
1227
|
+
```
|
|
1228
|
+
|
|
1229
|
+
_No JSDoc summary is available yet._
|
|
1230
|
+
|
|
1231
|
+
### SystemActionEvent
|
|
1232
|
+
|
|
1233
|
+
```ts
|
|
1234
|
+
interface SystemActionEvent {
|
|
1235
|
+
readonly kind: "systemAction";
|
|
1236
|
+
readonly procedureId: string;
|
|
1237
|
+
readonly title: string;
|
|
1238
|
+
readonly summary?: string;
|
|
1239
|
+
readonly details?: readonly GameEventDetail[];
|
|
1240
|
+
}
|
|
1241
|
+
```
|
|
1242
|
+
|
|
1243
|
+
_No JSDoc summary is available yet._
|
|
1244
|
+
|
|
1245
|
+
### SystemActionEventSchema
|
|
1246
|
+
|
|
1247
|
+
```ts
|
|
1248
|
+
const SystemActionEventSchema: z.ZodObject<
|
|
1249
|
+
{
|
|
1250
|
+
kind: z.ZodLiteral<"systemAction">;
|
|
1251
|
+
procedureId: z.ZodString;
|
|
1252
|
+
title: z.ZodString;
|
|
1253
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
1254
|
+
details: z.ZodOptional<
|
|
1255
|
+
z.ZodArray<
|
|
1256
|
+
z.ZodObject<
|
|
1257
|
+
{
|
|
1258
|
+
label: z.ZodString;
|
|
1259
|
+
value: z.ZodUnion<
|
|
1260
|
+
readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]
|
|
1261
|
+
>;
|
|
1262
|
+
},
|
|
1263
|
+
z.core.$strict
|
|
1264
|
+
>
|
|
1265
|
+
>
|
|
1266
|
+
>;
|
|
1267
|
+
},
|
|
1268
|
+
z.core.$strict
|
|
1269
|
+
>;
|
|
1270
|
+
```
|
|
1271
|
+
|
|
1272
|
+
_No JSDoc summary is available yet._
|
|
1273
|
+
|
|
1274
|
+
### ZoneHandlesSnapshot
|
|
1275
|
+
|
|
1276
|
+
```ts
|
|
1277
|
+
interface ZoneHandlesSnapshot<Interaction extends string = string> {
|
|
1278
|
+
readonly cardIds: readonly string[];
|
|
1279
|
+
readonly cardViewsById: Readonly<Record<string, string>>;
|
|
1280
|
+
readonly playableByCardId: Readonly<
|
|
1281
|
+
Record<string, readonly InteractionDescriptor<Interaction>[]>
|
|
1282
|
+
>;
|
|
1283
|
+
}
|
|
1284
|
+
```
|
|
1285
|
+
|
|
1286
|
+
_No JSDoc summary is available yet._
|
|
1287
|
+
|
|
1288
|
+
### ZoneHandlesSnapshotSchema
|
|
1289
|
+
|
|
1290
|
+
```ts
|
|
1291
|
+
const ZoneHandlesSnapshotSchema: z.ZodType<ZoneHandlesSnapshot>;
|
|
1292
|
+
```
|
|
1293
|
+
|
|
1294
|
+
_No JSDoc summary is available yet._
|
|
1295
|
+
|
|
133
1296
|
## @dreamboard-games/sdk/reference-games
|
|
134
1297
|
|
|
135
1298
|
### canonicalizeReferenceGameSourcePayload
|
|
@@ -2923,13 +4086,7 @@ _No JSDoc summary is available yet._
|
|
|
2923
4086
|
### GameOutcome
|
|
2924
4087
|
|
|
2925
4088
|
```ts
|
|
2926
|
-
type GameOutcome<
|
|
2927
|
-
reason: {
|
|
2928
|
-
code: string;
|
|
2929
|
-
message?: string;
|
|
2930
|
-
};
|
|
2931
|
-
standings: readonly OutcomeStanding<PlayerId>[];
|
|
2932
|
-
};
|
|
4089
|
+
type GameOutcome<Player extends string = string> = d<Player>;
|
|
2933
4090
|
```
|
|
2934
4091
|
|
|
2935
4092
|
_No JSDoc summary is available yet._
|
|
@@ -3092,7 +4249,7 @@ A state-preserving transformation.
|
|
|
3092
4249
|
### OutcomeResult
|
|
3093
4250
|
|
|
3094
4251
|
```ts
|
|
3095
|
-
type OutcomeResult =
|
|
4252
|
+
type OutcomeResult = O;
|
|
3096
4253
|
```
|
|
3097
4254
|
|
|
3098
4255
|
_No JSDoc summary is available yet._
|
|
@@ -3100,11 +4257,7 @@ _No JSDoc summary is available yet._
|
|
|
3100
4257
|
### OutcomeScoreComponent
|
|
3101
4258
|
|
|
3102
4259
|
```ts
|
|
3103
|
-
type OutcomeScoreComponent =
|
|
3104
|
-
id: string;
|
|
3105
|
-
label: string;
|
|
3106
|
-
value: number;
|
|
3107
|
-
};
|
|
4260
|
+
type OutcomeScoreComponent = s;
|
|
3108
4261
|
```
|
|
3109
4262
|
|
|
3110
4263
|
_No JSDoc summary is available yet._
|
|
@@ -3112,14 +4265,7 @@ _No JSDoc summary is available yet._
|
|
|
3112
4265
|
### OutcomeStanding
|
|
3113
4266
|
|
|
3114
4267
|
```ts
|
|
3115
|
-
type OutcomeStanding<
|
|
3116
|
-
playerId: PlayerId;
|
|
3117
|
-
rank: number;
|
|
3118
|
-
result: OutcomeResult;
|
|
3119
|
-
score?: number;
|
|
3120
|
-
scoreBreakdown?: readonly OutcomeScoreComponent[];
|
|
3121
|
-
tieBreaks?: readonly OutcomeTieBreak[];
|
|
3122
|
-
};
|
|
4268
|
+
type OutcomeStanding<Player extends string = string> = t<Player>;
|
|
3123
4269
|
```
|
|
3124
4270
|
|
|
3125
4271
|
_No JSDoc summary is available yet._
|
|
@@ -3127,11 +4273,7 @@ _No JSDoc summary is available yet._
|
|
|
3127
4273
|
### OutcomeTieBreak
|
|
3128
4274
|
|
|
3129
4275
|
```ts
|
|
3130
|
-
type OutcomeTieBreak =
|
|
3131
|
-
id: string;
|
|
3132
|
-
label: string;
|
|
3133
|
-
value: number | string;
|
|
3134
|
-
};
|
|
4276
|
+
type OutcomeTieBreak = u;
|
|
3135
4277
|
```
|
|
3136
4278
|
|
|
3137
4279
|
_No JSDoc summary is available yet._
|
|
@@ -5077,13 +6219,7 @@ _No JSDoc summary is available yet._
|
|
|
5077
6219
|
### GameOutcome
|
|
5078
6220
|
|
|
5079
6221
|
```ts
|
|
5080
|
-
type GameOutcome<
|
|
5081
|
-
reason: {
|
|
5082
|
-
code: string;
|
|
5083
|
-
message?: string;
|
|
5084
|
-
};
|
|
5085
|
-
standings: readonly OutcomeStanding<PlayerId>[];
|
|
5086
|
-
};
|
|
6222
|
+
type GameOutcome<Player extends string = string> = d<Player>;
|
|
5087
6223
|
```
|
|
5088
6224
|
|
|
5089
6225
|
_No JSDoc summary is available yet._
|
|
@@ -5925,7 +7061,7 @@ _No JSDoc summary is available yet._
|
|
|
5925
7061
|
### OutcomeResult
|
|
5926
7062
|
|
|
5927
7063
|
```ts
|
|
5928
|
-
type OutcomeResult =
|
|
7064
|
+
type OutcomeResult = O;
|
|
5929
7065
|
```
|
|
5930
7066
|
|
|
5931
7067
|
_No JSDoc summary is available yet._
|
|
@@ -5933,11 +7069,7 @@ _No JSDoc summary is available yet._
|
|
|
5933
7069
|
### OutcomeScoreComponent
|
|
5934
7070
|
|
|
5935
7071
|
```ts
|
|
5936
|
-
type OutcomeScoreComponent =
|
|
5937
|
-
id: string;
|
|
5938
|
-
label: string;
|
|
5939
|
-
value: number;
|
|
5940
|
-
};
|
|
7072
|
+
type OutcomeScoreComponent = s;
|
|
5941
7073
|
```
|
|
5942
7074
|
|
|
5943
7075
|
_No JSDoc summary is available yet._
|
|
@@ -5945,14 +7077,7 @@ _No JSDoc summary is available yet._
|
|
|
5945
7077
|
### OutcomeStanding
|
|
5946
7078
|
|
|
5947
7079
|
```ts
|
|
5948
|
-
type OutcomeStanding<
|
|
5949
|
-
playerId: PlayerId;
|
|
5950
|
-
rank: number;
|
|
5951
|
-
result: OutcomeResult;
|
|
5952
|
-
score?: number;
|
|
5953
|
-
scoreBreakdown?: readonly OutcomeScoreComponent[];
|
|
5954
|
-
tieBreaks?: readonly OutcomeTieBreak[];
|
|
5955
|
-
};
|
|
7080
|
+
type OutcomeStanding<Player extends string = string> = t<Player>;
|
|
5956
7081
|
```
|
|
5957
7082
|
|
|
5958
7083
|
_No JSDoc summary is available yet._
|
|
@@ -5960,11 +7085,7 @@ _No JSDoc summary is available yet._
|
|
|
5960
7085
|
### OutcomeTieBreak
|
|
5961
7086
|
|
|
5962
7087
|
```ts
|
|
5963
|
-
type OutcomeTieBreak =
|
|
5964
|
-
id: string;
|
|
5965
|
-
label: string;
|
|
5966
|
-
value: number | string;
|
|
5967
|
-
};
|
|
7088
|
+
type OutcomeTieBreak = u;
|
|
5968
7089
|
```
|
|
5969
7090
|
|
|
5970
7091
|
_No JSDoc summary is available yet._
|
|
@@ -17028,11 +18149,10 @@ _No JSDoc summary is available yet._
|
|
|
17028
18149
|
|
|
17029
18150
|
```ts
|
|
17030
18151
|
interface PluginRuntimeClient {
|
|
17031
|
-
getSession():
|
|
18152
|
+
getSession(): E | null;
|
|
17032
18153
|
subscribeSession(listener: () => void): () => void;
|
|
17033
|
-
getFrame():
|
|
18154
|
+
getFrame(): v | null;
|
|
17034
18155
|
subscribeFrame(listener: () => void): () => void;
|
|
17035
|
-
validateInteraction(interactionId: string, params: unknown): Promise<M>;
|
|
17036
18156
|
submitInteraction(interactionId: string, params: unknown): Promise<void>;
|
|
17037
18157
|
disconnect(): void;
|
|
17038
18158
|
}
|
|
@@ -17066,7 +18186,7 @@ _No JSDoc summary is available yet._
|
|
|
17066
18186
|
```ts
|
|
17067
18187
|
interface PluginTransport {
|
|
17068
18188
|
start(onMessage: (message: H) => void): () => void;
|
|
17069
|
-
send(message:
|
|
18189
|
+
send(message: J): void;
|
|
17070
18190
|
}
|
|
17071
18191
|
```
|
|
17072
18192
|
|
|
@@ -20755,7 +21875,7 @@ _No JSDoc summary is available yet._
|
|
|
20755
21875
|
```ts
|
|
20756
21876
|
interface CompilePluginProtocolTapeOptions {
|
|
20757
21877
|
readonly trace: ReducerScenarioTrace;
|
|
20758
|
-
readonly session:
|
|
21878
|
+
readonly session: E;
|
|
20759
21879
|
}
|
|
20760
21880
|
```
|
|
20761
21881
|
|
|
@@ -20809,7 +21929,7 @@ _No JSDoc summary is available yet._
|
|
|
20809
21929
|
|
|
20810
21930
|
```ts
|
|
20811
21931
|
interface CreateFixtureHostHarnessOptions {
|
|
20812
|
-
readonly tape:
|
|
21932
|
+
readonly tape: B;
|
|
20813
21933
|
readonly strict?: boolean;
|
|
20814
21934
|
readonly latencyMs?: number;
|
|
20815
21935
|
readonly channelId?: string;
|
|
@@ -20927,9 +22047,10 @@ _No JSDoc summary is available yet._
|
|
|
20927
22047
|
function digestUIFixtureTransportRequest(request: {
|
|
20928
22048
|
readonly operation: "validate" | "submit";
|
|
20929
22049
|
readonly basis?: {
|
|
20930
|
-
readonly
|
|
22050
|
+
readonly generation: number;
|
|
22051
|
+
readonly version: number;
|
|
20931
22052
|
readonly actionSetVersion: string;
|
|
20932
|
-
readonly perspectivePlayerId: string
|
|
22053
|
+
readonly perspectivePlayerId: string;
|
|
20933
22054
|
};
|
|
20934
22055
|
readonly interactionId?: string;
|
|
20935
22056
|
readonly payload?: unknown;
|
|
@@ -21063,7 +22184,6 @@ interface FixtureHostEvent {
|
|
|
21063
22184
|
readonly atMs: number;
|
|
21064
22185
|
readonly kind:
|
|
21065
22186
|
| "frame-sent"
|
|
21066
|
-
| "validate-received"
|
|
21067
22187
|
| "submit-received"
|
|
21068
22188
|
| "ack-received"
|
|
21069
22189
|
| "ready-received"
|
|
@@ -21082,7 +22202,7 @@ _No JSDoc summary is available yet._
|
|
|
21082
22202
|
```ts
|
|
21083
22203
|
interface FixtureHostHarness {
|
|
21084
22204
|
readonly transport: PluginTransport;
|
|
21085
|
-
readonly tape:
|
|
22205
|
+
readonly tape: B;
|
|
21086
22206
|
reset(): void;
|
|
21087
22207
|
flush(): Promise<void>;
|
|
21088
22208
|
advanceHost(): Promise<void>;
|
|
@@ -21343,7 +22463,7 @@ _No JSDoc summary is available yet._
|
|
|
21343
22463
|
### PluginProtocolTape
|
|
21344
22464
|
|
|
21345
22465
|
```ts
|
|
21346
|
-
type PluginProtocolTape =
|
|
22466
|
+
type PluginProtocolTape = B;
|
|
21347
22467
|
```
|
|
21348
22468
|
|
|
21349
22469
|
_No JSDoc summary is available yet._
|
|
@@ -21352,9 +22472,9 @@ _No JSDoc summary is available yet._
|
|
|
21352
22472
|
|
|
21353
22473
|
```ts
|
|
21354
22474
|
const pluginProtocolTapeSchema: z.ZodType<
|
|
21355
|
-
|
|
22475
|
+
B,
|
|
21356
22476
|
unknown,
|
|
21357
|
-
z.core.$ZodTypeInternals<
|
|
22477
|
+
z.core.$ZodTypeInternals<B, unknown>
|
|
21358
22478
|
>;
|
|
21359
22479
|
```
|
|
21360
22480
|
|
|
@@ -22008,7 +23128,7 @@ _No JSDoc summary is available yet._
|
|
|
22008
23128
|
### UI_SCENARIO_FIXTURE_PLUGIN_RUNTIME_PROTOCOL
|
|
22009
23129
|
|
|
22010
23130
|
```ts
|
|
22011
|
-
const UI_SCENARIO_FIXTURE_PLUGIN_RUNTIME_PROTOCOL:
|
|
23131
|
+
const UI_SCENARIO_FIXTURE_PLUGIN_RUNTIME_PROTOCOL: 4;
|
|
22012
23132
|
```
|
|
22013
23133
|
|
|
22014
23134
|
_No JSDoc summary is available yet._
|
|
@@ -22032,7 +23152,7 @@ _No JSDoc summary is available yet._
|
|
|
22032
23152
|
### UIFixtureFrame
|
|
22033
23153
|
|
|
22034
23154
|
```ts
|
|
22035
|
-
type UIFixtureFrame =
|
|
23155
|
+
type UIFixtureFrame = y;
|
|
22036
23156
|
```
|
|
22037
23157
|
|
|
22038
23158
|
_No JSDoc summary is available yet._
|
|
@@ -22044,9 +23164,9 @@ const uiFixtureFrameSchema: z.ZodObject<
|
|
|
22044
23164
|
{
|
|
22045
23165
|
id: z.ZodString;
|
|
22046
23166
|
frame: z.ZodType<
|
|
22047
|
-
|
|
23167
|
+
v<unknown, string, string, string>,
|
|
22048
23168
|
unknown,
|
|
22049
|
-
z.core.$ZodTypeInternals<
|
|
23169
|
+
z.core.$ZodTypeInternals<v<unknown, string, string, string>, unknown>
|
|
22050
23170
|
>;
|
|
22051
23171
|
projectionDigest: z.ZodString;
|
|
22052
23172
|
},
|
|
@@ -22059,7 +23179,7 @@ _No JSDoc summary is available yet._
|
|
|
22059
23179
|
### UIFixtureProtocolStep
|
|
22060
23180
|
|
|
22061
23181
|
```ts
|
|
22062
|
-
type UIFixtureProtocolStep =
|
|
23182
|
+
type UIFixtureProtocolStep = z$1;
|
|
22063
23183
|
```
|
|
22064
23184
|
|
|
22065
23185
|
_No JSDoc summary is available yet._
|