@dreamboard-games/sdk 0.4.0-alpha.6 → 0.4.0-alpha.8

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.5";
+  readonly "@dreamboard-games/sdk": "0.4.0-alpha.7";
 };
 ```
 
@@ -56,7 +56,7 @@ _No JSDoc summary is available yet._
 ### DREAMBOARD_SDK_VERSION
 
 ```ts
-const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.5";
+const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.7";
 ```
 
 _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.5";
+  readonly "@dreamboard-games/sdk": "0.4.0-alpha.7";
 };
 ```
 
@@ -104,7 +104,7 @@ _No JSDoc summary is available yet._
 ### DREAMBOARD_SDK_VERSION
 
 ```ts
-const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.5";
+const DREAMBOARD_SDK_VERSION: "0.4.0-alpha.7";
 ```
 
 _No JSDoc summary is available yet._
@@ -129,6 +129,340 @@ type DreamboardSdkPackageSet = {
 
 _No JSDoc summary is available yet._
 
+## @dreamboard-games/sdk/reference-games
+
+### canonicalizeReferenceGameSourcePayload
+
+```ts
+function canonicalizeReferenceGameSourcePayload(
+  payload: ReferenceGameSourceManifestPayload,
+): CanonicalReferenceGameJson;
+```
+
+_No JSDoc summary is available yet._
+
+### computeReferenceGameSourceDigest
+
+```ts
+function computeReferenceGameSourceDigest(
+  payload: ReferenceGameSourceManifestPayload,
+): `sha256:${string}`;
+```
+
+_No JSDoc summary is available yet._
+
+### isPackageableReferenceGame
+
+```ts
+function isPackageableReferenceGame(game: ReferenceGameManifestV3): boolean;
+```
+
+_No JSDoc summary is available yet._
+
+### parseReferenceGameManifestV3
+
+```ts
+function parseReferenceGameManifestV3(value: unknown): ReferenceGameManifestV3;
+```
+
+_No JSDoc summary is available yet._
+
+### parseReferenceGameSourceManifest
+
+```ts
+function parseReferenceGameSourceManifest(
+  value: unknown,
+): ReferenceGameSourceManifest;
+```
+
+_No JSDoc summary is available yet._
+
+### REFERENCE_GAME_MANIFEST_SCHEMA_VERSION
+
+```ts
+const REFERENCE_GAME_MANIFEST_SCHEMA_VERSION = 3;
+```
+
+_No JSDoc summary is available yet._
+
+### REFERENCE_GAME_SOURCE_MANIFEST_SCHEMA_VERSION
+
+```ts
+const REFERENCE_GAME_SOURCE_MANIFEST_SCHEMA_VERSION = 2;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameDemoRelease
+
+```ts
+type ReferenceGameDemoRelease = z.infer<typeof referenceGameDemoReleaseSchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameDemoReleaseSchema
+
+```ts
+declare const referenceGameDemoReleaseSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameManifestV3
+
+```ts
+type ReferenceGameManifestV3 = z.infer<typeof referenceGameManifestV3Schema>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameManifestV3Schema
+
+```ts
+declare const referenceGameManifestV3Schema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameRights
+
+```ts
+type ReferenceGameRights = z.infer<typeof referenceGameRightsSchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameRightsSchema
+
+```ts
+declare const referenceGameRightsSchema: z.ZodObject<
+  {
+    mechanicsProvenance: z.ZodString;
+    sourceCode: z.ZodString;
+    codeLicense: z.ZodString;
+    ruleText: z.ZodString;
+    artwork: z.ZodString;
+    assetLicenseManifest: z.ZodString;
+    thirdPartyMarks: z.ZodArray<z.ZodString>;
+    reviewStatus: z.ZodLiteral<"approved">;
+    reviewedBy: z.ZodString;
+    reviewedAt: z.ZodString;
+  },
+  z.core.$strict
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameSdkPolicy
+
+```ts
+type ReferenceGameSdkPolicy = z.infer<typeof referenceGameSdkPolicySchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameSdkPolicySchema
+
+```ts
+const referenceGameSdkPolicySchema: z.ZodObject<
+  {
+    dependency: z.ZodLiteral<"@dreamboard-games/sdk">;
+    versionPolicy: z.ZodLiteral<"exact">;
+  },
+  z.core.$strict
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameSha256DigestSchema
+
+```ts
+const referenceGameSha256DigestSchema: z.ZodString;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameSourceEntry
+
+```ts
+type ReferenceGameSourceEntry = z.infer<typeof referenceGameSourceEntrySchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameSourceEntrySchema
+
+```ts
+declare const referenceGameSourceEntrySchema: z.ZodObject<
+  {
+    id: z.ZodString;
+    root: z.ZodString;
+    sourceSha256: z.ZodString;
+    packageJsonSha256: z.ZodString;
+    lockfileSha256: z.ZodString;
+    sdkSpecifier: z.ZodString;
+    manifest: z.ZodString;
+    reducer: z.ZodString;
+    ui: z.ZodString;
+    behaviorScenarios: z.ZodArray<z.ZodString>;
+    uiScenarios: z.ZodArray<z.ZodString>;
+    mechanics: z.ZodArray<z.ZodString>;
+    readFirst: z.ZodArray<z.ZodString>;
+  },
+  z.core.$strict
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameSourceManifest
+
+```ts
+type ReferenceGameSourceManifest = z.infer<
+  typeof referenceGameSourceManifestSchema
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameSourceManifestPayload
+
+```ts
+type ReferenceGameSourceManifestPayload = z.infer<
+  typeof referenceGameSourceManifestPayloadSchema
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameSourceManifestPayloadSchema
+
+```ts
+declare const referenceGameSourceManifestPayloadSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameSourceManifestSchema
+
+```ts
+declare const referenceGameSourceManifestSchema: ...;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameSourceObject
+
+```ts
+type ReferenceGameSourceObject = z.infer<
+  typeof referenceGameSourceObjectSchema
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameSourceObjectSchema
+
+```ts
+const referenceGameSourceObjectSchema: z.ZodObject<
+  {
+    path: z.ZodString;
+    sha256: z.ZodString;
+    byteLength: z.ZodNumber;
+  },
+  z.core.$strict
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameSourceProvenance
+
+```ts
+type ReferenceGameSourceProvenance = z.infer<
+  typeof referenceGameSourceProvenanceSchema
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameSourceProvenanceSchema
+
+```ts
+const referenceGameSourceProvenanceSchema: z.ZodDiscriminatedUnion<
+  [
+    z.ZodObject<
+      {
+        kind: z.ZodLiteral<"worktree">;
+      },
+      z.core.$strict
+    >,
+    z.ZodObject<
+      {
+        kind: z.ZodLiteral<"git">;
+        repository: z.ZodLiteral<"dreamboard-games/dreamboard-sdk">;
+        revision: z.ZodString;
+      },
+      z.core.$strict
+    >,
+  ],
+  "kind"
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameTeaching
+
+```ts
+type ReferenceGameTeaching = z.infer<typeof referenceGameTeachingSchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameTeachingSchema
+
+```ts
+const referenceGameTeachingSchema: z.ZodObject<
+  {
+    whatThisTeaches: z.ZodArray<z.ZodString>;
+    whenToCopyThisPattern: z.ZodArray<z.ZodString>;
+    readFirst: z.ZodArray<z.ZodString>;
+  },
+  z.core.$strict
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### ReferenceGameWorkspace
+
+```ts
+type ReferenceGameWorkspace = z.infer<typeof referenceGameWorkspaceSchema>;
+```
+
+_No JSDoc summary is available yet._
+
+### referenceGameWorkspaceSchema
+
+```ts
+const referenceGameWorkspaceSchema: z.ZodObject<
+  {
+    manifest: z.ZodString;
+    reducer: z.ZodString;
+    ui: z.ZodString;
+    behaviorScenarios: z.ZodArray<z.ZodString>;
+    uiScenarios: z.ZodArray<z.ZodString>;
+  },
+  z.core.$strict
+>;
+```
+
+_No JSDoc summary is available yet._
+
 ## @dreamboard-games/sdk/types
 
 ### ActionDefinition
@@ -2258,13 +2592,23 @@ function defineEffect(...args: never[]): unknown;
 
 _No JSDoc summary is available yet._
 
+### defineEmptyView
+
+```ts
+function defineEmptyView<
+  Contract extends AnyReducerGameContract,
+>(): EmptyViewDefinition<ContractState<Contract>, ContractManifest<Contract>>;
+```
+
+_No JSDoc summary is available yet._
+
 ### defineGame
 
 ```ts
 function defineGame<
   const Contract extends AnyReducerGameContract,
   Definitions extends PhaseMapOf<Contract>,
-  Views extends ViewMapOf<Contract> = Record<string, never>,
+  Views extends ViewMapOf<Contract>,
 >(
   definition: { contract: Contract } & Omit<
     ReducerGameDefinition<NoInfer<Contract>, Definitions, Views>,
@@ -2336,6 +2680,49 @@ function definePhaseStage<
 
 _No JSDoc summary is available yet._
 
+### definePlayerView
+
+```ts
+function definePlayerView<Contract extends AnyReducerGameContract>(): <
+  SharedProjection = unknown,
+  Projection = unknown,
+>(
+  definition: PlayerViewDefinition<
+    ContractState<Contract>,
+    ContractManifest<Contract>,
+    SharedProjection,
+    Projection
+  >,
+) => PlayerViewDefinition<
+  ContractState<Contract>,
+  ContractManifest<Contract>,
+  SharedProjection,
+  Projection
+>;
+```
+
+_No JSDoc summary is available yet._
+
+### defineSharedView
+
+```ts
+function defineSharedView<Contract extends AnyReducerGameContract>(): <
+  Projection,
+>(
+  definition: SharedViewDefinition<
+    ContractState<Contract>,
+    ContractManifest<Contract>,
+    Projection
+  >,
+) => SharedViewDefinition<
+  ContractState<Contract>,
+  ContractManifest<Contract>,
+  Projection
+>;
+```
+
+_No JSDoc summary is available yet._
+
 ### defineStage
 
 ```ts
@@ -2359,7 +2746,7 @@ function defineStaticView<Contract extends AnyReducerGameContract>(): <
 ) => StaticViewDefinition<ExactManifestContractOf<Contract>, Projection>;
 ```
 
-Factory for the session-scoped static view (see {@link StaticViewDefinition}). Kept separate from {@link defineView} because the argument shape is structurally different: it exposes only the manifest and generated static queries, with no `state`, `playerId`, `runtime`, `fx`, `ops`, or `accept/reject`. That shape is what prevents authors from accidentally projecting per-tick state into the once-per-session payload.
+Factory for the session-scoped static view (see {@link StaticViewDefinition}). Kept separate from dynamic view helpers because the argument shape is structurally different: it exposes only the manifest and generated static queries, with no `state`, `playerId`, `runtime`, `fx`, `ops`, or `accept/reject`. That shape is what prevents authors from accidentally projecting per-tick state into the once-per-session payload.
 
 ### defineStepPhase
 
@@ -2369,24 +2756,6 @@ function defineStepPhase(...args: never[]): unknown;
 
 _No JSDoc summary is available yet._
 
-### defineView
-
-```ts
-function defineView<Contract extends AnyReducerGameContract>(): <Projection>(
-  definition: ViewDefinition<
-    ContractState<Contract>,
-    ContractManifest<Contract>,
-    Projection
-  >,
-) => ViewDefinition<
-  ContractState<Contract>,
-  ContractManifest<Contract>,
-  Projection
->;
-```
-
-_No JSDoc summary is available yet._
-
 ### DependencyValues
 
 ```ts
@@ -3075,6 +3444,23 @@ type ReducerPhaseDefinition<
 
 _No JSDoc summary is available yet._
 
+### ReducerPlayerViewDefinition
+
+```ts
+type ReducerPlayerViewDefinition<
+  Contract extends AnyReducerGameContract,
+  SharedProjection = unknown,
+  Projection = unknown,
+> = PlayerViewDefinition<
+  ContractState<Contract>,
+  ContractManifest<Contract>,
+  SharedProjection,
+  Projection
+>;
+```
+
+_No JSDoc summary is available yet._
+
 ### ReducerReject
 
 ```ts
@@ -3095,6 +3481,21 @@ type ReducerResult<State> = ReducerAccept<State> | ReducerReject;
 
 _No JSDoc summary is available yet._
 
+### ReducerSharedViewDefinition
+
+```ts
+type ReducerSharedViewDefinition<
+  Contract extends AnyReducerGameContract,
+  Projection = unknown,
+> = SharedViewDefinition<
+  ContractState<Contract>,
+  ContractManifest<Contract>,
+  Projection
+>;
+```
+
+_No JSDoc summary is available yet._
+
 ### ReducerStateBase
 
 ```ts
@@ -3129,21 +3530,6 @@ type ReducerValidationResult =
 
 _No JSDoc summary is available yet._
 
-### ReducerViewDefinition
-
-```ts
-type ReducerViewDefinition<
-  Contract extends AnyReducerGameContract,
-  Projection = unknown,
-> = ViewDefinition<
-  ContractState<Contract>,
-  ContractManifest<Contract>,
-  Projection
->;
-```
-
-_No JSDoc summary is available yet._
-
 ### rngInput
 
 ```ts
@@ -4545,6 +4931,23 @@ type EffectTypeTag = "rollDie" | "shuffleSharedZone" | "shufflePlayerZone";
 
 Marker tag attached by `defineEffect` to every effect spec. `fx.effect` uses `type` to dispatch to the right wire-effect builder.
 
+### EmptyViewDefinition
+
+```ts
+type EmptyViewDefinition<
+  State extends {
+    table: RuntimeTableRecord;
+    flow: {
+      currentPhase: string;
+    };
+  },
+  Manifest extends ManifestContract<TableOfState<State>>,
+> = SharedViewDefinition<State, Manifest, Record<string, never>> &
+  PlayerViewDefinition<State, Manifest, unknown, Record<string, never>>;
+```
+
+_No JSDoc summary is available yet._
+
 ### ErrorCodeOfContract
 
 ```ts
@@ -5792,6 +6195,14 @@ type PlayerPhaseDefinition = ...;
 
 _No JSDoc summary is available yet._
 
+### PlayerViewDefinition
+
+```ts
+type PlayerViewDefinition = ...;
+```
+
+_No JSDoc summary is available yet._
+
 ### PlayerZoneIdOfManifest
 
 ```ts
@@ -7292,6 +7703,30 @@ type SetupSelectionOfManifest<Manifest> = {
 
 _No JSDoc summary is available yet._
 
+### SharedViewDefinition
+
+```ts
+type SharedViewDefinition<
+  State extends {
+    table: RuntimeTableRecord;
+    flow: {
+      currentPhase: string;
+    };
+  },
+  Manifest extends ManifestContract<TableOfState<State>>,
+  Projection = unknown,
+> = {
+  project: (
+    args: ActionContext<State, Manifest> &
+      RuntimeHelpers<State> & {
+        state: State;
+      },
+  ) => Projection;
+};
+```
+
+_No JSDoc summary is available yet._
+
 ### SharedZoneIdOfManifest
 
 ```ts
@@ -8078,14 +8513,6 @@ type VertexTypeIdOfManifest<Manifest> = Manifest extends {
 
 _No JSDoc summary is available yet._
 
-### ViewDefinition
-
-```ts
-type ViewDefinition = ...;
-```
-
-_No JSDoc summary is available yet._
-
 ### ViewDefinitionByName
 
 ```ts
@@ -8100,14 +8527,23 @@ _No JSDoc summary is available yet._
 ### ViewMapOf
 
 ```ts
-type ViewMapOf<Contract> = Record<
-  string,
-  ViewDefinition<
+type ViewMapOf<
+  Contract,
+  SharedProjection = unknown,
+  PlayerProjection = unknown,
+> = {
+  shared: SharedViewDefinition<
     BaseGameStateOfContract<Contract>,
     ManifestContractOf<Contract>,
-    unknown
-  >
->;
+    SharedProjection
+  >;
+  player: PlayerViewDefinition<
+    BaseGameStateOfContract<Contract>,
+    ManifestContractOf<Contract>,
+    SharedProjection,
+    PlayerProjection
+  >;
+};
 ```
 
 _No JSDoc summary is available yet._
@@ -8143,9 +8579,9 @@ _No JSDoc summary is available yet._
 
 ```ts
 type ViewsOfDefinition<Definition> = Definition extends {
-  views?: infer Views;
+  views: infer Views;
 }
-  ? NonNullable<Views>
+  ? Views
   : never;
 ```
 
@@ -19892,10 +20328,7 @@ _No JSDoc summary is available yet._
 ### GENERATED_WORKSPACE_PATH_PATTERNS
 
 ```ts
-const GENERATED_WORKSPACE_PATH_PATTERNS: {
-  prefix: string;
-  suffix: string;
-}[];
+const GENERATED_WORKSPACE_PATH_PATTERNS: readonly GeneratedWorkspacePathPattern[];
 ```
 
 _No JSDoc summary is available yet._
@@ -21213,6 +21646,75 @@ declare const uiStepExpectationSchema: z.ZodObject<
 
 _No JSDoc summary is available yet._
 
+## @dreamboard-games/sdk/testing-runtime
+
+### CandidateVerificationBase
+
+```ts
+type CandidateVerificationBase =
+  | BaseStateArtifact
+  | (BaseDefinition & Partial<BaseStateArtifact>);
+```
+
+_No JSDoc summary is available yet._
+
+### CandidateVerificationInput
+
+```ts
+type CandidateVerificationInput = ...;
+```
+
+_No JSDoc summary is available yet._
+
+### CandidateVerificationResult
+
+```ts
+type CandidateVerificationResult = {
+  readonly status: "passed" | "failed";
+  readonly scenarioSummary: {
+    readonly total: number;
+    readonly passed: number;
+    readonly failed: number;
+    readonly scenarios: readonly CandidateVerificationScenarioResult[];
+  };
+};
+```
+
+_No JSDoc summary is available yet._
+
+### CandidateVerificationScenario
+
+```ts
+type CandidateVerificationScenario = ScenarioDefinition;
+```
+
+_No JSDoc summary is available yet._
+
+### CandidateVerificationScenarioResult
+
+```ts
+type CandidateVerificationScenarioResult = {
+  readonly id: string;
+  readonly status: "passed" | "failed";
+  readonly diagnostic?: {
+    readonly kind: "assertion";
+    readonly message: string;
+  };
+};
+```
+
+_No JSDoc summary is available yet._
+
+### runCandidateVerification
+
+```ts
+function runCandidateVerification(
+  input: CandidateVerificationInput,
+): Promise<CandidateVerificationResult>;
+```
+
+_No JSDoc summary is available yet._
+
 ## @dreamboard-games/sdk/browser-interaction
 
 ### actuatorIdentityKey