@dreamboard-games/sdk 0.4.0-alpha.0 → 0.4.0-alpha.1

package/REFERENCE.md

@@ -47,7 +47,7 @@ _No JSDoc summary is available yet._
 
 ```ts
 const DREAMBOARD_SDK_PACKAGES: {
-  readonly "@dreamboard-games/sdk": "0.4.0-alpha.0";
+  readonly "@dreamboard-games/sdk": "0.4.0-alpha.1";
 };
 ```
 
@@ -56,7 +56,7 @@ _No JSDoc summary is available yet._
 ### DREAMBOARD_SDK_VERSION
 
 ```ts
-const DREAMBOARD_SDK_VERSION = "0.4.0-alpha.0";
+const DREAMBOARD_SDK_VERSION = "0.4.0-alpha.1";
 ```
 
 _No JSDoc summary is available yet._
@@ -95,7 +95,7 @@ _No JSDoc summary is available yet._
 
 ```ts
 const DREAMBOARD_SDK_PACKAGES: {
-  readonly "@dreamboard-games/sdk": "0.4.0-alpha.0";
+  readonly "@dreamboard-games/sdk": "0.4.0-alpha.1";
 };
 ```
 
@@ -104,7 +104,7 @@ _No JSDoc summary is available yet._
 ### DREAMBOARD_SDK_VERSION
 
 ```ts
-const DREAMBOARD_SDK_VERSION = "0.4.0-alpha.0";
+const DREAMBOARD_SDK_VERSION = "0.4.0-alpha.1";
 ```
 
 _No JSDoc summary is available yet._
@@ -2500,16 +2500,16 @@ _No JSDoc summary is available yet._
 ### GameStateOf
 
 ```ts
-type GameStateOf<Source> =
-  Source extends ReducerGameDefinition<
-    infer Contract,
-    infer Definitions,
-    infer _Views
-  >
+type GameStateOf<Source> = Source extends {
+  contract: infer Contract extends ReducerGameContractLike;
+  phases: infer Definitions;
+}
+  ? Definitions extends PhaseMapOf<Contract>
     ? ResolvedGameStateOf<Contract, Definitions>
-    : Source extends ReducerGameContract<any, any, any, any, any, any, any>
-      ? BaseGameStateOfContract<Source>
-      : never;
+    : never
+  : Source extends ReducerGameContract<any, any, any, any, any, any, any>
+    ? BaseGameStateOfContract<Source>
+    : never;
 ```
 
 _No JSDoc summary is available yet._
@@ -3789,7 +3789,19 @@ _No JSDoc summary is available yet._
 ### CardInputZoneIdsOfDefinition
 
 ```ts
-type CardInputZoneIdsOfDefinition = ...;
+type CardInputZoneIdsOfDefinition<
+  Definition,
+  PhaseName extends PhaseNamesOfDefinition<Definition>,
+  InteractionId extends InteractionIdOfDefinitionPhase<Definition, PhaseName>,
+  Input extends string,
+> =
+  InteractionSpecByNameOfDefinitionPhase<
+    Definition,
+    PhaseName,
+    InteractionId
+  > extends infer Spec
+    ? CardInputZoneIdsOfInteractionDefinition<Spec, Input>
+    : never;
 ```
 
 _No JSDoc summary is available yet._
@@ -4102,7 +4114,7 @@ _No JSDoc summary is available yet._
 
 ```ts
 type ContinuationResponseOf<Token> =
-  Token extends ContinuationToken<any, string, infer Response>
+  Token extends ContinuationToken<unknown, string, infer Response>
     ? Response
     : never;
 ```
@@ -4227,7 +4239,19 @@ _No JSDoc summary is available yet._
 ### DefaultedClientParamKeysOfInteractionOfDefinition
 
 ```ts
-type DefaultedClientParamKeysOfInteractionOfDefinition = ...;
+type DefaultedClientParamKeysOfInteractionOfDefinition<
+  Definition,
+  PhaseName extends PhaseNamesOfDefinition<Definition>,
+  InteractionId extends InteractionIdOfDefinitionPhase<Definition, PhaseName>,
+> =
+  InteractionSpecByNameOfDefinitionPhase<
+    Definition,
+    PhaseName,
+    InteractionId
+  > extends infer Spec
+    ? DefaultedClientCollectorKeys<CollectorsOfInteractionDefinition<Spec>> &
+        string
+    : never;
 ```
 
 _No JSDoc summary is available yet._
@@ -4494,16 +4518,16 @@ _No JSDoc summary is available yet._
 ### GameStateOf
 
 ```ts
-type GameStateOf<Source> =
-  Source extends ReducerGameDefinition<
-    infer Contract,
-    infer Definitions,
-    infer _Views
-  >
+type GameStateOf<Source> = Source extends {
+  contract: infer Contract extends ReducerGameContractLike;
+  phases: infer Definitions;
+}
+  ? Definitions extends PhaseMapOf<Contract>
     ? ResolvedGameStateOf<Contract, Definitions>
-    : Source extends ReducerGameContract<any, any, any, any, any, any, any>
-      ? BaseGameStateOfContract<Source>
-      : never;
+    : never
+  : Source extends ReducerGameContract<any, any, any, any, any, any, any>
+    ? BaseGameStateOfContract<Source>
+    : never;
 ```
 
 _No JSDoc summary is available yet._
@@ -4752,8 +4776,8 @@ _No JSDoc summary is available yet._
 ```ts
 type HiddenSchemaOfContract<Contract> =
   StateDefinitionOfContract<Contract> extends StateDefinition<
-    infer _PublicSchema,
-    infer _PrivateSchema,
+    SchemaLike<object>,
+    SchemaLike<object>,
     infer HiddenSchema
   >
     ? HiddenSchema
@@ -4914,7 +4938,19 @@ _No JSDoc summary is available yet._
 ### InputKeysWithCollectorKindOfDefinition
 
 ```ts
-type InputKeysWithCollectorKindOfDefinition = ...;
+type InputKeysWithCollectorKindOfDefinition<
+  Definition,
+  PhaseName extends PhaseNamesOfDefinition<Definition>,
+  InteractionId extends InteractionIdOfDefinitionPhase<Definition, PhaseName>,
+  Kind extends string,
+> =
+  InteractionSpecByNameOfDefinitionPhase<
+    Definition,
+    PhaseName,
+    InteractionId
+  > extends infer Spec
+    ? InputKeysWithCollectorKindOfInteractionDefinition<Spec, Kind>
+    : never;
 ```
 
 _No JSDoc summary is available yet._
@@ -5623,9 +5659,9 @@ _No JSDoc summary is available yet._
 ```ts
 type PrivateSchemaOfContract<Contract> =
   StateDefinitionOfContract<Contract> extends StateDefinition<
-    infer _PublicSchema,
+    SchemaLike<object>,
     infer PrivateSchema,
-    infer _HiddenSchema
+    SchemaLike<object>
   >
     ? PrivateSchema
     : never;
@@ -5690,8 +5726,8 @@ _No JSDoc summary is available yet._
 type PublicSchemaOfContract<Contract> =
   StateDefinitionOfContract<Contract> extends StateDefinition<
     infer PublicSchema,
-    infer _PrivateSchema,
-    infer _HiddenSchema
+    SchemaLike<object>,
+    SchemaLike<object>
   >
     ? PublicSchema
     : never;
@@ -6514,7 +6550,7 @@ _No JSDoc summary is available yet._
 
 ```ts
 interface RuntimeRecord {
-  [key: string]: RuntimePayload | undefined;
+  [key: string]: RuntimePayload;
 }
 ```
 
@@ -7907,11 +7943,9 @@ type ViewOfDefinition<
   Definition,
   ViewName extends ViewNamesOfDefinition<Definition>,
 > =
-  ViewDefinitionByName<Definition, ViewName> extends ViewDefinition<
-    infer _State,
-    infer _Manifest,
-    infer Projection
-  >
+  ViewDefinitionByName<Definition, ViewName> extends {
+    project: (...args: never[]) => infer Projection;
+  }
     ? Projection
     : never;
 ```
@@ -11787,19 +11821,6 @@ function useChromeSuppression(id: string, suppressed: boolean): void;
 
 _No JSDoc summary is available yet._
 
-### useHandLayout
-
-```ts
-function useHandLayout({
-  cardCount,
-  cardSize,
-  layout,
-  containerPadding,
-}: UseHandLayoutOptions): UseHandLayoutReturn;
-```
-
-Hook for managing hand layout calculations and interactions.
-
 ### UseHandLayoutOptions
 
 ```ts
@@ -11841,14 +11862,6 @@ function useMobileHandTrayActive(): boolean;
 
 Whether the mobile hand tray is currently presenting hands — i.e. the viewport is below the mobile breakpoint and at least one primary/auxiliary hand has registered. Authors can use this to drop redundant inline hand chrome (labels, framing) that the tray already provides, instead of guessing the breakpoint with a CSS media query. Returns `false` outside `<UI.Root>`.
 
-### usePanZoom
-
-```ts
-function usePanZoom(options?: UsePanZoomOptions): UsePanZoomReturn;
-```
-
-Hook for pan and zoom gestures on board components
-
 ### UsePanZoomOptions
 
 ```ts
@@ -15316,7 +15329,7 @@ _No JSDoc summary is available yet._
 ```ts
 function createWorkspaceUIContract<
   WorkspaceUI,
-  Contract extends UIContract$1,
+  Contract extends UIContract,
   Resource extends string,
   Card,
   HexBoards extends Record<string, unknown>,
@@ -15339,7 +15352,9 @@ _No JSDoc summary is available yet._
 ### DreamboardUIRegister
 
 ```ts
-interface DreamboardUIRegister {}
+interface DreamboardUIRegister {
+  readonly __dreamboardUIRegister?: never;
+}
 ```
 
 _No JSDoc summary is available yet._
@@ -17913,14 +17928,6 @@ _No JSDoc summary is available yet._
 
 ## @dreamboard-games/sdk/runtime/workspace-contract
 
-### a
-
-```ts
-interface a { ... }
-```
-
-_No JSDoc summary is available yet._
-
 ### BoardHexGridProps
 
 ```ts
@@ -17983,7 +17990,7 @@ _No JSDoc summary is available yet._
 ```ts
 function createWorkspaceUIContract<
   WorkspaceUI,
-  Contract extends UIContract$1,
+  Contract extends UIContract,
   Resource extends string,
   Card,
   HexBoards extends Record<string, unknown>,
@@ -17994,19 +18001,10 @@ function createWorkspaceUIContract<
 
 _No JSDoc summary is available yet._
 
-### D
-
-```ts
-interface DreamboardUIRegister {}
-```
-
-_No JSDoc summary is available yet._
-
 ### DreamboardUI
 
 ```ts
-type DreamboardUI<Contract extends UIContract = RegisteredUI> =
-  DreamboardUI$1<Contract>;
+interface DreamboardUI { ... }
 ```
 
 _No JSDoc summary is available yet._
@@ -18076,28 +18074,6 @@ interface GameTurnState<
 
 _No JSDoc summary is available yet._
 
-### P
-
-```ts
-function P({
-  children,
-  timeout,
-  loadingComponent,
-  errorComponent,
-  onDiagnostic,
-}: PluginRuntimeProps): react_jsx_runtime.JSX.Element;
-```
-
-PluginRuntime provides the RuntimeContext for plugin components.
-
-### R
-
-```ts
-type RegisteredUI = RegisteredUIContract;
-```
-
-_No JSDoc summary is available yet._
-
 ### ResourceCounterComponents
 
 ```ts
@@ -18116,11 +18092,16 @@ _No JSDoc summary is available yet._
 
 ```ts
 type TypedGame<
-  Contract extends UIContract,
+  _Contract extends UIContract,
   View = unknown,
-  Player extends string = string,
-  Phase extends string = string,
-> = TypedGame$1<Contract, View, Player, Phase>;
+  Player extends string = PlayerKey<_Contract>,
+  Phase extends string = PhaseKey<_Contract>,
+> = Omit<typeof Game, "Root"> & {
+  Root(props: GameRootProps<View, Player, Phase>): ReactElement;
+  Chrome(
+    props: GameChromeProps<View, Player, Phase, InteractionKey<_Contract>>,
+  ): ReactElement;
+};
 ```
 
 _No JSDoc summary is available yet._
@@ -18128,7 +18109,17 @@ _No JSDoc summary is available yet._
 ### UIContract
 
 ```ts
-type UIContract = UIContract$1;
+interface UIContract {
+  interactions?: UIContractBucket;
+  inputs?: UIContractBucket;
+  prompts?: UIContractBucket;
+  promptOptions?: UIContractBucket;
+  players?: UIContractBucket;
+  zones?: UIContractBucket;
+  cards?: UIContractBucket;
+  phases?: UIContractBucket;
+  boardTargets?: UIContractBucket;
+}
 ```
 
 _No JSDoc summary is available yet._
@@ -18654,6 +18645,48 @@ _No JSDoc summary is available yet._
 
 ## @dreamboard-games/sdk/testing
 
+### assertDeterministicUIScenarioFixture
+
+```ts
+function assertDeterministicUIScenarioFixture(
+  first: UIScenarioFixture,
+  second: UIScenarioFixture,
+): void;
+```
+
+_No JSDoc summary is available yet._
+
+### assertSupportedBrowserInteractionProtocol
+
+```ts
+function assertSupportedBrowserInteractionProtocol(version: string): void;
+```
+
+_No JSDoc summary is available yet._
+
+### assertUIStepExpectationSatisfied
+
+```ts
+function assertUIStepExpectationSatisfied(
+  stepId: string,
+  expected: UIStepExpectation,
+  actual: UIStepExpectation,
+): void;
+```
+
+_No JSDoc summary is available yet._
+
+### assertUniqueReplayIdentity
+
+```ts
+function assertUniqueReplayIdentity(
+  step: Pick<PortableSemanticReplayStep, "stepId" | "expectedIdentity">,
+  candidates: readonly UIReplayIdentityCandidate[],
+): UIReplayIdentityCandidate;
+```
+
+_No JSDoc summary is available yet._
+
 ### BaseContext
 
 ```ts
@@ -18691,6 +18724,50 @@ interface BaseDefinition {
 
 _No JSDoc summary is available yet._
 
+### canonicalizeUIFixtureJson
+
+```ts
+function canonicalizeUIFixtureJson(value: unknown): CanonicalJson;
+```
+
+_No JSDoc summary is available yet._
+
+### canonicalizeUIScenarioFixture
+
+```ts
+function canonicalizeUIScenarioFixture(
+  fixture: UIScenarioFixture,
+): UIScenarioFixture;
+```
+
+_No JSDoc summary is available yet._
+
+### canonicalUIFixtureJson
+
+```ts
+function canonicalUIFixtureJson(value: unknown): string;
+```
+
+_No JSDoc summary is available yet._
+
+### compileUIScenarioFixture
+
+```ts
+function compileUIScenarioFixture(
+  options: CompileUIScenarioFixtureOptions,
+): UIScenarioFixture;
+```
+
+_No JSDoc summary is available yet._
+
+### CompileUIScenarioFixtureOptions
+
+```ts
+interface CompileUIScenarioFixtureOptions { ... }
+```
+
+_No JSDoc summary is available yet._
+
 ### CreatedTestRuntime
 
 ```ts
@@ -18761,6 +18838,30 @@ function defineScenario<
 
 _No JSDoc summary is available yet._
 
+### digestUIFixtureJson
+
+```ts
+function digestUIFixtureJson(value: unknown): string;
+```
+
+_No JSDoc summary is available yet._
+
+### digestUIFixtureRequest
+
+```ts
+function digestUIFixtureRequest(request: UIReplayRequest): string;
+```
+
+_No JSDoc summary is available yet._
+
+### digestUIScenarioFixture
+
+```ts
+function digestUIScenarioFixture(fixture: UIScenarioFixture): string;
+```
+
+_No JSDoc summary is available yet._
+
 ### ExpectFn
 
 ```ts
@@ -18825,6 +18926,14 @@ type InteractionExplanationLike = ...;
 
 _No JSDoc summary is available yet._
 
+### isSha256Digest
+
+```ts
+function isSha256Digest(value: string): boolean;
+```
+
+_No JSDoc summary is available yet._
+
 ### isStaleContractArtifactError
 
 ```ts
@@ -18835,6 +18944,42 @@ function isStaleContractArtifactError(
 
 _No JSDoc summary is available yet._
 
+### parseUIScenarioFixture
+
+```ts
+function parseUIScenarioFixture(value: unknown): UIScenarioFixture;
+```
+
+_No JSDoc summary is available yet._
+
+### parseUIScenarioFixtureBundleIndex
+
+```ts
+function parseUIScenarioFixtureBundleIndex(
+  value: unknown,
+): UIScenarioFixtureBundleIndex;
+```
+
+_No JSDoc summary is available yet._
+
+### PortableSemanticReplayStep
+
+```ts
+type PortableSemanticReplayStep = z.infer<
+  typeof portableSemanticReplayStepSchema
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### portableSemanticReplayStepSchema
+
+```ts
+declare const portableSemanticReplayStepSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
 ### RejectionExpectation
 
 ```ts
@@ -18854,6 +18999,14 @@ interface ScenarioDefinition { ... }
 
 _No JSDoc summary is available yet._
 
+### serializeUIScenarioFixture
+
+```ts
+function serializeUIScenarioFixture(fixture: UIScenarioFixture): string;
+```
+
+_No JSDoc summary is available yet._
+
 ### SharedScenarioContext
 
 ```ts
@@ -18910,6 +19063,227 @@ type TestRunner = "reducer" | "remote" | "browser";
 
 _No JSDoc summary is available yet._
 
+### UI_SCENARIO_FIXTURE_BUNDLE_SCHEMA_VERSION
+
+```ts
+const UI_SCENARIO_FIXTURE_BUNDLE_SCHEMA_VERSION = 1;
+```
+
+_No JSDoc summary is available yet._
+
+### UI_SCENARIO_FIXTURE_SCHEMA_VERSION
+
+```ts
+const UI_SCENARIO_FIXTURE_SCHEMA_VERSION = 1;
+```
+
+_No JSDoc summary is available yet._
+
+### UI_SCENARIO_FIXTURE_SUPPORTED_BROWSER_PROTOCOL_MAJOR
+
+```ts
+const UI_SCENARIO_FIXTURE_SUPPORTED_BROWSER_PROTOCOL_MAJOR = 2;
+```
+
+_No JSDoc summary is available yet._
+
+### UIFixtureFrame
+
+```ts
+type UIFixtureFrame = Omit<z.infer<typeof uiFixtureFrameSchema>, "snapshot"> & {
+  readonly snapshot: PluginStateSnapshot$1;
+};
+```
+
+_No JSDoc summary is available yet._
+
+### uiFixtureFrameSchema
+
+```ts
+declare const uiFixtureFrameSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### uiFixturePluginStateSnapshotSchema
+
+```ts
+declare const uiFixturePluginStateSnapshotSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### UIFixtureTransportExchange
+
+```ts
+type UIFixtureTransportExchange = z.infer<
+  typeof uiFixtureTransportExchangeSchema
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### uiFixtureTransportExchangeSchema
+
+```ts
+declare const uiFixtureTransportExchangeSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### UIReplayExecution
+
+```ts
+type UIReplayExecution = z.infer<typeof uiReplayExecutionSchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### uiReplayExecutionSchema
+
+```ts
+declare const uiReplayExecutionSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### UIReplayIdentityCandidate
+
+```ts
+type UIReplayIdentityCandidate = UIResolvedReplayIdentity;
+```
+
+_No JSDoc summary is available yet._
+
+### UIReplayRequest
+
+```ts
+type UIReplayRequest =
+  | BrowserInteractionIntentRequest
+  | BrowserInteractionEffectRequest;
+```
+
+_No JSDoc summary is available yet._
+
+### uiReplayRequestSchema
+
+```ts
+declare const uiReplayRequestSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### UIResolvedReplayIdentity
+
+```ts
+type UIResolvedReplayIdentity = z.infer<typeof uiResolvedReplayIdentitySchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### uiResolvedReplayIdentitySchema
+
+```ts
+const uiResolvedReplayIdentitySchema: z.ZodObject<
+  {
+    stepId: z.ZodString;
+    surface: z.ZodString;
+    scopeId: z.ZodString;
+    interactionKey: z.ZodString;
+    interactionId: z.ZodString;
+    actuatorId: z.ZodString;
+    descriptorDigest: z.ZodOptional<z.ZodString>;
+    draftDigest: z.ZodOptional<z.ZodString>;
+  },
+  z.core.$strict
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### UIScenarioFixture
+
+```ts
+type UIScenarioFixture = Omit<
+  z.infer<typeof uiScenarioFixtureSchema>,
+  "frames" | "replay"
+> & {
+  readonly frames: readonly UIFixtureFrame[];
+  readonly replay: readonly UIScenarioReplayStep[];
+};
+```
+
+_No JSDoc summary is available yet._
+
+### UIScenarioFixtureBundleIndex
+
+```ts
+type UIScenarioFixtureBundleIndex = z.infer<
+  typeof uiScenarioFixtureBundleIndexSchema
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### uiScenarioFixtureBundleIndexSchema
+
+```ts
+declare const uiScenarioFixtureBundleIndexSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### uiScenarioFixtureSchema
+
+```ts
+declare const uiScenarioFixtureSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### UIScenarioReplayStep
+
+```ts
+type UIScenarioReplayStep = z.infer<typeof uiScenarioReplayStepSchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### uiScenarioReplayStepSchema
+
+```ts
+declare const uiScenarioReplayStepSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### UIStepExpectation
+
+```ts
+type UIStepExpectation = z.infer<typeof uiStepExpectationSchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### uiStepExpectationSchema
+
+```ts
+declare const uiStepExpectationSchema: z.ZodObject<
+  {
+    frameId: z.ZodOptional<z.ZodString>;
+    projectionDigest: z.ZodOptional<z.ZodString>;
+    semanticDigest: z.ZodOptional<z.ZodString>;
+    draftDigest: z.ZodOptional<z.ZodString>;
+    submissionDigest: z.ZodOptional<z.ZodString>;
+    focusedInteractionKey: z.ZodOptional<z.ZodString>;
+    visibleInteractionKeys: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  },
+  z.core.$strict
+>;
+```
+
+_No JSDoc summary is available yet._
+
 ## @dreamboard-games/sdk/browser-interaction
 
 ### actuatorIdentityKey
@@ -19196,7 +19570,13 @@ const browserInteractionEffectSchema: z.ZodObject<
     kind: z.ZodString;
   },
   z.core.$catchall<
-    z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>
+    z.ZodPreprocess<
+      z.ZodType<
+        RuntimeJson,
+        unknown,
+        z.core.$ZodTypeInternals<RuntimeJson, unknown>
+      >
+    >
   >
 >;
 ```