@dreamboard-games/sdk 0.4.0-alpha.11 → 0.4.0-alpha.13

package/REFERENCE.md

@@ -48,7 +48,7 @@ _No JSDoc summary is available yet._
 
 ```ts
 const DREAMBOARD_SDK_PACKAGES: {
-  readonly "@dreamboard-games/sdk": "0.4.0-alpha.11";
+  readonly "@dreamboard-games/sdk": "0.4.0-alpha.13";
 };
 ```
 
@@ -57,7 +57,7 @@ _No JSDoc summary is available yet._
 ### DREAMBOARD_SDK_VERSION
 
 ```ts
-const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.11";
+const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.13";
 ```
 
 _No JSDoc summary is available yet._
@@ -96,7 +96,7 @@ _No JSDoc summary is available yet._
 
 ```ts
 const DREAMBOARD_SDK_PACKAGES: {
-  readonly "@dreamboard-games/sdk": "0.4.0-alpha.11";
+  readonly "@dreamboard-games/sdk": "0.4.0-alpha.13";
 };
 ```
 
@@ -105,7 +105,7 @@ _No JSDoc summary is available yet._
 ### DREAMBOARD_SDK_VERSION
 
 ```ts
-const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.11";
+const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.13";
 ```
 
 _No JSDoc summary is available yet._
@@ -20868,6 +20868,14 @@ type ClientParamSchemaMap = Readonly<
 
 _No JSDoc summary is available yet._
 
+### createGameUiContract
+
+```ts
+function createGameUiContract(...args: never[]): unknown;
+```
+
+_No JSDoc summary is available yet._
+
 ### createWorkspaceUIContract
 
 ```ts
@@ -20971,6 +20979,224 @@ interface GameTurnState<
 
 _No JSDoc summary is available yet._
 
+### GameUiBoardSurface
+
+```ts
+type GameUiBoardSurface<
+  Manifest extends GameUiManifestTypes,
+  _Board extends Manifest["BoardBaseId"] = Manifest["BoardBaseId"],
+> = WorkspaceBoardSurface<
+  Manifest["SpaceId"],
+  Manifest["EdgeId"],
+  Manifest["VertexId"],
+  Manifest["SpaceId"]
+> & {
+  readonly __board?: _Board;
+};
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiCardCollectionSurface
+
+```ts
+type GameUiCardCollectionSurface<
+  Manifest extends GameUiManifestTypes,
+  Zones extends readonly Manifest["ZoneId"][] = readonly Manifest["ZoneId"][],
+> = {
+  readonly Collection: ZoneCardsComponent<Manifest>;
+  readonly Card: ZoneCardComponent<Manifest>;
+  readonly slot: {
+    readonly card: GameUiInteractionSlot & {
+      readonly __zones?: Zones;
+    };
+  };
+};
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiContract
+
+```ts
+type GameUiContract<Game, Manifest extends GameUiManifestTypes> = UiRegistry<
+  Game,
+  Manifest
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiGameRootState
+
+```ts
+type GameUiGameRootState<
+  Game,
+  Manifest extends GameUiManifestTypes,
+> = GameRenderState<
+  GameUiView<Game>,
+  Manifest["PlayerId"],
+  GameUiPhaseName<Game>
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiHandSurface
+
+```ts
+type GameUiHandSurface = ...;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiInteractionDescriptor
+
+```ts
+type GameUiInteractionDescriptor<
+  Game,
+  Key extends GameUiInteractionKey<Game>,
+> = InteractionDescriptor<Key>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiInteractionFormSurface
+
+```ts
+type GameUiInteractionFormSurface = ...;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiInteractionKey
+
+```ts
+type GameUiInteractionKey<Game> = {
+  [Phase in GameUiPhaseName<Game>]: `${Phase}.${GameUiInteractionIdForPhase<Game, Phase>}`;
+}[GameUiPhaseName<Game>];
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiInteractionParamsOf
+
+```ts
+type GameUiInteractionParamsOf<
+  Game,
+  Key extends GameUiInteractionKey<Game>,
+> = ClientParamsOfInteractionOfDefinition<
+  Game,
+  PhaseOfInteractionKey<Game, Key>,
+  IdOfInteractionKey<Game, Key>
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiInteractionRoutes
+
+```ts
+type GameUiInteractionRoutes<Game> = Partial<{
+  [Key in GameUiInteractionKey<Game>]: {
+    readonly collect: {
+      [Input in GameUiInteractionInputKeys<Game, Key>]: GameUiCollectorSlot<
+        Game,
+        Key,
+        Input
+      >;
+    };
+  };
+}>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiManifestTypes
+
+```ts
+interface GameUiManifestTypes { ... }
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiMe
+
+```ts
+type GameUiMe<Manifest extends GameUiManifestTypes> = GameMeState<
+  Manifest["PlayerId"]
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiPhaseName
+
+```ts
+type GameUiPhaseName<Game> = PhaseNamesOfDefinition<Game>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiPileSurface
+
+```ts
+type GameUiPileSurface<Manifest extends GameUiManifestTypes> = {
+  readonly Pile: ZoneCardsComponent<Manifest>;
+  readonly Card: ZoneCardComponent<Manifest>;
+};
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiPlayers
+
+```ts
+type GameUiPlayers<Manifest extends GameUiManifestTypes> = GamePlayersState<
+  Manifest["PlayerId"]
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiTurn
+
+```ts
+type GameUiTurn<Game, Manifest extends GameUiManifestTypes> = GameTurnState<
+  Manifest["PlayerId"],
+  GameUiPhaseName<Game>
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiView
+
+```ts
+type GameUiView<Game> =
+  Extract<"player", GameUiViewName<Game>> extends never
+    ? never
+    : ViewOfDefinition<Game, Extract<"player", GameUiViewName<Game>>>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameUiViewName
+
+```ts
+type GameUiViewName<Game> = ViewNamesOfDefinition<Game>;
+```
+
+_No JSDoc summary is available yet._
+
+### GameWorkspaceUI
+
+```ts
+type GameWorkspaceUI = ...;
+```
+
+_No JSDoc summary is available yet._
+
 ### ResourceCounterComponents
 
 ```ts
@@ -21853,8 +22079,8 @@ _No JSDoc summary is available yet._
 
 ```ts
 function compareUIParityObservations(
-  expected: UIParityObservationV1,
-  actual: UIParityObservationV1,
+  expected: UIParityObservation,
+  actual: UIParityObservation,
 ): UIParityComparisonResult;
 ```
 
@@ -21986,7 +22212,22 @@ function createUIParityObservationFromFixture({
   fixtureDigest,
   screenshotsByStepId,
   diagnostics,
-}: CreateUIParityObservationFromFixtureOptions): UIParityObservationV1;
+}: CreateUIParityObservationFromFixtureOptions): UIParityObservation;
+```
+
+_No JSDoc summary is available yet._
+
+### CreateUIParityObservationFromFixtureOptions
+
+```ts
+interface CreateUIParityObservationFromFixtureOptions {
+  readonly fixture: UIScenarioFixture;
+  readonly sdkCandidateDigest: string;
+  readonly environment: UIParityObservationEnvironment;
+  readonly fixtureDigest?: string;
+  readonly screenshotsByStepId?: Readonly<Record<string, string>>;
+  readonly diagnostics?: readonly UIParityDiagnostic[];
+}
 ```
 
 _No JSDoc summary is available yet._
@@ -22404,10 +22645,26 @@ function isStaleContractArtifactError(
 
 _No JSDoc summary is available yet._
 
-### parseUIParityObservationV1
+### parseUIParityObservation
+
+```ts
+function parseUIParityObservation(value: unknown): UIParityObservation;
+```
+
+_No JSDoc summary is available yet._
+
+### parseUIParityRealHostReceipt
 
 ```ts
-function parseUIParityObservationV1(value: unknown): UIParityObservationV1;
+function parseUIParityRealHostReceipt(value: unknown): UIParityRealHostReceipt;
+```
+
+_No JSDoc summary is available yet._
+
+### parseUIParityRunInput
+
+```ts
+function parseUIParityRunInput(value: unknown): UIParityRunInput;
 ```
 
 _No JSDoc summary is available yet._
@@ -23192,6 +23449,184 @@ declare const uiFixtureProtocolStepSchema: ...;
 
 _No JSDoc summary is available yet._
 
+### UIParityArtifactReference
+
+```ts
+interface UIParityArtifactReference {
+  readonly path: string;
+  readonly sha256: string;
+}
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityComparisonFailure
+
+```ts
+interface UIParityComparisonFailure {
+  readonly code: UIParityFailureCode;
+  readonly message: string;
+  readonly path: string;
+  readonly expected: unknown;
+  readonly actual: unknown;
+  readonly checkpointIndex?: number;
+  readonly stepId?: string;
+}
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityComparisonResult
+
+```ts
+type UIParityComparisonResult =
+  | {
+      readonly ok: true;
+    }
+  | {
+      readonly ok: false;
+      readonly failure: UIParityComparisonFailure;
+    };
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityDiagnostic
+
+```ts
+interface UIParityDiagnostic {
+  readonly code: string;
+  readonly message: string;
+}
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityFailureCode
+
+```ts
+type UIParityFailureCode =
+  | "candidate-mismatch"
+  | "fixture-source-mismatch"
+  | "protocol-mismatch"
+  | "interaction-resolution-mismatch"
+  | "preparation-mismatch"
+  | "draft-mismatch"
+  | "submission-mismatch"
+  | "projection-mismatch"
+  | "semantic-snapshot-mismatch"
+  | "visual-mismatch"
+  | "host-setup-failure";
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityObservation
+
+```ts
+interface UIParityObservation { ... }
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityObservationCheckpoint
+
+```ts
+interface UIParityObservationCheckpoint { ... }
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityObservationEnvironment
+
+```ts
+interface UIParityObservationEnvironment {
+  readonly project: string;
+  readonly viewport: UIParityViewport;
+}
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityObservationProvenance
+
+```ts
+interface UIParityObservationProvenance {
+  readonly kind:
+    | "fixture-expectation"
+    | "source-workbench"
+    | "packed-real-host";
+  readonly evidence?: string;
+}
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityRealHostReceipt
+
+```ts
+interface UIParityRealHostReceipt { ... }
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityReceiptComparison
+
+```ts
+interface UIParityReceiptComparison {
+  readonly scenarioId: string;
+  readonly actual: string;
+  readonly comparison: string;
+  readonly evidence?: string;
+}
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityRunInput
+
+```ts
+interface UIParityRunInput {
+  readonly schemaVersion: 2;
+  readonly sdk: {
+    readonly tarball: UIParityArtifactReference;
+  };
+  readonly referenceBundle: UIParityArtifactReference;
+  readonly fixtureBundle: {
+    readonly index: UIParityArtifactReference;
+    readonly scenarios: readonly UIParityRunScenario[];
+  };
+  readonly project: string;
+}
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityRunScenario
+
+```ts
+interface UIParityRunScenario {
+  readonly id: string;
+  readonly fixture: UIParityArtifactReference;
+  readonly renderModule: UIParityArtifactReference;
+  readonly expectation: UIParityArtifactReference;
+  readonly source: UIParityArtifactReference;
+}
+```
+
+_No JSDoc summary is available yet._
+
+### UIParityViewport
+
+```ts
+interface UIParityViewport {
+  readonly width: number;
+  readonly height: number;
+}
+```
+
+_No JSDoc summary is available yet._
+
 ### UIReplayExecution
 
 ```ts

package/dist/authoring/index.js

@@ -7,9 +7,9 @@ import {
   materializeManifest,
   projectAuthoringAdapter,
   validateManifest
-} from "../chunk-3OY46H7D.js";
-import "../chunk-CP3BF3B2.js";
-import "../chunk-SACZWUA6.js";
+} from "../chunk-OFIDC7DJ.js";
+import "../chunk-THWT4V3Z.js";
+import "../chunk-HIH6Y4FA.js";
 import "../chunk-PZ5AY32C.js";
 export {
   GENERATED_WORKSPACE_PATHS,

package/dist/authoring-compiler.js

@@ -1,10 +1,10 @@
 import {
   materializeWorkspace
-} from "./chunk-THTFQZZ3.js";
-import "./chunk-3OY46H7D.js";
+} from "./chunk-42HQLHVA.js";
+import "./chunk-OFIDC7DJ.js";
 import "./chunk-UNVCT5Z7.js";
-import "./chunk-CP3BF3B2.js";
-import "./chunk-SACZWUA6.js";
+import "./chunk-THWT4V3Z.js";
+import "./chunk-HIH6Y4FA.js";
 import "./chunk-PZ5AY32C.js";
 export {
   materializeWorkspace

package/dist/authoring-materialize-cli.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 import {
   materializeWorkspace
-} from "./chunk-THTFQZZ3.js";
-import "./chunk-3OY46H7D.js";
+} from "./chunk-42HQLHVA.js";
+import "./chunk-OFIDC7DJ.js";
 import "./chunk-UNVCT5Z7.js";
-import "./chunk-CP3BF3B2.js";
-import "./chunk-SACZWUA6.js";
+import "./chunk-THWT4V3Z.js";
+import "./chunk-HIH6Y4FA.js";
 import "./chunk-PZ5AY32C.js";
 
 // src/authoring-materialize-cli.ts

package/dist/{chunk-THTFQZZ3.js → chunk-42HQLHVA.js}

@@ -1,12 +1,12 @@
 import {
   generateWorkspaceArtifacts
-} from "./chunk-3OY46H7D.js";
+} from "./chunk-OFIDC7DJ.js";
 import {
   compareReferenceGameCanonicalStrings
 } from "./chunk-UNVCT5Z7.js";
 import {
   WORKSPACE_CODEGEN_OWNERSHIP
-} from "./chunk-SACZWUA6.js";
+} from "./chunk-HIH6Y4FA.js";
 
 // src/authoring/materialize-workspace.ts
 import { createHash, randomUUID } from "crypto";
@@ -166,4 +166,4 @@ async function isFile(filePath) {
 export {
   materializeWorkspace
 };
-//# sourceMappingURL=chunk-THTFQZZ3.js.map
+//# sourceMappingURL=chunk-42HQLHVA.js.map

package/dist/{chunk-RP6QDQGI.js → chunk-7JBPOJOF.js}

@@ -34,6 +34,9 @@ import {
 import {
   useAuthoredPluginGameplayFrameSelector
 } from "./chunk-B33RRZ4O.js";
+import {
+  createClientParamSchemasByPhase
+} from "./chunk-5XTAQ4EQ.js";
 
 // src/runtime/workspace-contract/index.ts
 import { Fragment, createElement as createElement6 } from "react";
@@ -769,6 +772,47 @@ function createZoneNamespace(ctx) {
   };
 }
 
+// src/runtime/workspace-contract/game-ui-contract.ts
+function createGameUiContract(options) {
+  const uiContract = {
+    interactions: {},
+    inputs: {},
+    prompts: {},
+    promptOptions: {},
+    players: {},
+    zones: {},
+    cards: {},
+    phases: {},
+    boardTargets: {}
+  };
+  const clientParamSchemasByPhase = createClientParamSchemasByPhase(
+    options.game
+  );
+  const formInputKeysForInteraction = (interaction) => {
+    const [phase, id] = interaction.split(".", 2);
+    const phaseSpec = phase ? options.game.phases?.[phase] : void 0;
+    const phaseRecord = phaseSpec;
+    const spec = (id ? phaseRecord?.interactions?.[id] : void 0) ?? (id ? phaseRecord?.cardActions?.[id] : void 0) ?? (id === "submit" ? phaseRecord?.submit : void 0);
+    return new Set(
+      Object.entries(spec?.inputs ?? {}).filter(
+        ([, collector]) => collector.kind === "form" || collector.kind === "prompt"
+      ).map(([input]) => input)
+    );
+  };
+  const UI2 = createWorkspaceUIContract({
+    uiContract,
+    clientParamSchemasByPhase,
+    formInputKeysForInteraction,
+    resourceIds: options.resourceIds,
+    resourcePresentationById: options.resourcePresentationById,
+    hexStaticBoards: options.hexStaticBoards,
+    squareStaticBoards: options.squareStaticBoards,
+    cardIdFromZoneCard: (card) => card.id,
+    zoneIdFromZoneCard: (card) => card.zone
+  });
+  return { uiContract, UI: UI2, clientParamSchemasByPhase };
+}
+
 // src/runtime/workspace-contract/index.ts
 function createWorkspaceUIContract(options) {
   const baseUI = createDreamboardUI(options.uiContract);
@@ -872,6 +916,7 @@ function createWorkspaceUIContract(options) {
 }
 
 export {
+  createGameUiContract,
   createWorkspaceUIContract
 };
-//# sourceMappingURL=chunk-RP6QDQGI.js.map
+//# sourceMappingURL=chunk-7JBPOJOF.js.map