@dreamboard-games/sdk 0.4.0-alpha.7 → 0.4.0-alpha.9

package/dist/testing.d.ts

@@ -1,16 +1,20 @@
-import { n as SnapshotMatcherHandler, E as ExpectFn, d as InteractionExplanationLike, C as CreateReducerScenarioRunnerOptions, i as ReducerScenarioRunner, j as ReducerScenarioTrace } from './types-DcADVHe9.js';
-export { B as BaseContext, a as BaseDefinition, b as ExpectMatchers, I as InteractionAvailabilityLike, c as InteractionDescriptorLike, R as ReducerScenarioBundle, e as ReducerScenarioDiagnostic, f as ReducerScenarioExchange, g as ReducerScenarioFrame, h as ReducerScenarioOperation, k as ReducerScenarioViewer, l as RejectionExpectation, S as ScenarioDefinition, m as SharedScenarioContext, T as TestRunner, o as defineBase, p as defineScenario } from './types-DcADVHe9.js';
-import { R as ReducerDiagnosticEvent, D as DispatchTraceSummaryEntry } from './diagnostics-1BWjRo6-.js';
-import { w as wire, a as ReducerBundleContract } from './index.d-DMASeF6M.js';
-import { p, w, v, t, u } from './protocol-835hEGne.js';
-import { R as RuntimeAPI, V as ValidationResult } from './runtime-api-C6aWo9c0.js';
+import { D as SnapshotMatcherHandler, E as ExpectFn, m as ScenarioDefinitionGameLike, v as ScenarioReplayDefinition, h as ScenarioCheckpoint, i as ScenarioCommand } from './definitions-0kjPV9wh.js';
+export { A as AssertScenarioOptions, a as ExpectMatchers, I as InteractionAvailabilityLike, b as InteractionDescriptorLike, c as InteractionExplanationLike, R as RejectionExpectation, d as ReplayScenarioOptions, e as RuntimeParamsOfScenarioCommand, S as ScenarioActor, f as ScenarioAssertionContext, g as ScenarioAuthoring, j as ScenarioCommandOf, k as ScenarioCommandTraceEntry, l as ScenarioDefinition, n as ScenarioDefinitionValidationCode, o as ScenarioDefinitionValidationError, p as ScenarioDiagnostics, q as ScenarioFlowDiagnostics, r as ScenarioProbeAccepted, s as ScenarioProbeRejected, t as ScenarioProbeResult, u as ScenarioReplay, w as ScenarioReplayError, x as ScenarioReplayErrorOptions, y as ScenarioReplaySegment, z as ScenarioSchemaOutput, B as ScenarioSeatRef, C as ScenarioSetup, F as createScenarioAuthoring, G as toScenarioReplayDefinition } from './definitions-0kjPV9wh.js';
+import { R as ReducerDiagnosticEvent } from './diagnostics-DIi3ina7.js';
+import { g as ScenarioIdentity, f as PerspectiveSelector, e as InspectScenarioResult, P as PerspectiveRef, d as InspectNode, i as Sha256Digest, F as FlowDiagnostic, A as ActorRef, a as InspectEntropy, S as ScenarioDispatchTraceEntry } from './types-Bvptkukh.js';
+export { I as InspectAction, b as InspectInteraction, c as InspectInteractionInput, j as assertScenario, p as probeScenarioCommand, r as replayScenario } from './types-Bvptkukh.js';
+import { w as wire, a as ReducerBundleContract } from './index.d-C7Ztirg6.js';
 import { R as RuntimeJson } from './runtime-json-CQ9QbLZ5.js';
+import { v, t, u, p, w } from './protocol-B2LWcqB4.js';
 import { z } from 'zod';
 import { r as BrowserInteractionIntentRequest, l as BrowserInteractionEffectRequest } from './types-DJj5MJkl.js';
-import { b as PluginTransport, P as PluginRuntimeClient } from './types-aI4V9CWe.js';
+import { b as PluginTransport, P as PluginRuntimeClient } from './types-_zfC_7CD.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import react__default from 'react';
-export { S as StaleContractArtifactError, a as StaleContractArtifactErrorOptions, b as StaleContractArtifactKind, i as isStaleContractArtifactError } from './stale-contract-artifact-error-C5AaZPJ8.js';
+export { S as StaleContractArtifactError, a as StaleContractArtifactErrorOptions, b as StaleContractArtifactKind, i as isStaleContractArtifactError } from './stale-contract-artifact-error-XLaweZtF.js';
+import './views-DE2eZxPz.js';
+import './runtime-B_w9AO2n.js';
+import './types.js';
 
 type CreateExpectApiOptions = {
     matchSnapshot?: SnapshotMatcherHandler;
@@ -20,55 +24,169 @@ type CreateExpectApiOptions = {
 };
 declare function createExpectApi(options?: CreateExpectApiOptions): ExpectFn;
 
-type ReducerBundleLike = Pick<ReducerBundleContract, "projectSeatsDynamic" | "validateInput" | "dispatch"> & {
-    explainInteraction?: (input: {
-        state: wire.ReducerSessionState;
-        playerId: string;
-        interactionId: string;
-    }) => InteractionExplanationLike;
+/** A failed SDK matcher or probe expectation authored in `scenario.then`. */
+declare class ScenarioAssertionError extends Error {
+    readonly code: "SCENARIO_ASSERTION_FAILED";
+    constructor(message: string);
+}
+
+type InspectScenarioOptions<Game extends ScenarioDefinitionGameLike> = {
+    readonly game: Game;
+    readonly scenario: ScenarioReplayDefinition<Game>;
+    readonly identity: ScenarioIdentity;
+    readonly perspective: PerspectiveSelector;
+    readonly at?: ScenarioCheckpoint;
+    readonly seed?: number;
 };
-type DeepReadonly<T> = T extends (...args: readonly unknown[]) => unknown ? T : T extends readonly (infer Item)[] ? readonly DeepReadonly<Item>[] : T extends object ? {
-    readonly [Key in keyof T]: DeepReadonly<T[Key]>;
-} : T;
-type BaseStateArtifact = {
-    snapshot: DeepReadonly<wire.ReducerSessionState>;
-    fingerprint: {
-        players: number;
-        contractFingerprint?: string;
+declare function inspectScenario<const Game extends ScenarioDefinitionGameLike>(options: InspectScenarioOptions<Game>): Promise<InspectScenarioResult>;
+
+type ExploreTransitionResult = {
+    readonly schemaVersion: 1;
+    readonly mode: "transitions";
+    readonly scenario: ScenarioIdentity;
+    readonly perspective: PerspectiveRef;
+    readonly node: InspectNode;
+    readonly candidates: readonly {
+        readonly ordinal: number;
+        readonly command: ScenarioCommand;
+        readonly after: {
+            readonly checkpointDigest: Sha256Digest;
+            readonly flow: FlowDiagnostic;
+            readonly publicStateDigest: Sha256Digest;
+            readonly viewDigest: Sha256Digest;
+            readonly actions: readonly {
+                readonly actor: ActorRef;
+                readonly interactionId: string;
+            }[];
+            readonly entropy: InspectEntropy;
+            readonly dispatchTrace: readonly ScenarioDispatchTraceEntry[];
+        };
+    }[];
+    readonly omissions: readonly {
+        readonly actor: ActorRef;
+        readonly interactionId: string;
+        readonly code: "INPUT_DOMAIN_NOT_ENUMERABLE" | "INPUT_DOMAIN_BUDGET";
+        readonly inputKey?: string;
+    }[];
+    readonly page: {
+        readonly limit: number;
+        readonly evaluated: number;
+        readonly truncated: boolean;
+        readonly nextCursor: string | null;
     };
 };
-type CreateTestRuntimeOptions = {
-    baseId: string;
-    baseStates: Record<string, BaseStateArtifact>;
-    bundle: ReducerBundleLike;
-    phase?: string;
-    playerIds?: readonly string[];
-    sessionId?: string;
-    userId?: string | null;
-    gameId?: string;
-    displayNameByPlayerId?: Record<string, string>;
-    contractFingerprint?: string;
-    expectedBaseStateFingerprint?: string;
+type ExploreSeedResult = {
+    readonly schemaVersion: 1;
+    readonly mode: "seeds";
+    readonly scenario: ScenarioIdentity;
+    readonly perspective: PerspectiveRef;
+    readonly checkpoint: ScenarioCheckpoint;
+    readonly variants: readonly {
+        readonly seed: number;
+        readonly status: "replayed" | "rejected";
+        readonly checkpointDigest?: Sha256Digest;
+        readonly entropy?: InspectEntropy;
+        readonly observable?: {
+            readonly publicState: unknown;
+            readonly view: unknown;
+        };
+        readonly signature?: {
+            readonly phase: string;
+            readonly step: string | null;
+            readonly actions: readonly {
+                readonly seat: number;
+                readonly interactionId: string;
+                readonly concreteOptionCount: number | "lazy";
+            }[];
+        };
+        readonly rejection?: {
+            readonly segment: "given" | "when";
+            readonly sourceIndex: number;
+            readonly interactionId: string;
+            readonly errorCode: string;
+        };
+    }[];
+};
+type ExploreScenarioResult = ExploreTransitionResult | ExploreSeedResult;
+
+type SeedRange = {
+    readonly start: number;
+    readonly end: number;
+};
+type ExploreScenarioOptions<Game extends ScenarioDefinitionGameLike> = Omit<InspectScenarioOptions<Game>, "seed"> & {
+    readonly seed?: number;
+    readonly seedRange?: SeedRange;
+    readonly limit?: number;
+    readonly maxEvaluations?: number;
+    readonly cursor?: string;
 };
-type CreatedTestRuntime = {
-    runtime: RuntimeAPI;
-    getFrame(): p;
-    getSessionDescriptor(): w;
-    players(): readonly string[];
-    seat(index: number): string;
-    submit(playerId: string, interactionId: string, params?: unknown): Promise<void>;
-    validate(playerId: string, interactionId: string, params?: unknown): Promise<ValidationResult>;
-    explain(playerId: string, interactionId: string): InteractionExplanationLike;
-    diagnostics: {
-        readonly events: readonly ReducerDiagnosticEvent[];
-        readonly lastDispatch: {
-            submissionId: string;
-            trace: readonly DispatchTraceSummaryEntry[];
-        } | null;
-        clear(): void;
+declare function exploreScenario<const Game extends ScenarioDefinitionGameLike>(options: ExploreScenarioOptions<Game>): Promise<ExploreScenarioResult>;
+
+type ReducerScenarioBundle = Pick<ReducerBundleContract, "projectSeatsDynamic" | "validateInput" | "dispatch" | "projectStatic">;
+interface ReducerScenarioViewer {
+    readonly seatId: string;
+    readonly playerId: string;
+}
+interface ReducerScenarioFrame {
+    readonly id: string;
+    readonly reducerState: wire.ReducerSessionState;
+    readonly dynamicProjection: wire.SeatProjectionBundle;
+    readonly staticProjection?: wire.BoardStaticProjection | null;
+    readonly gameVersion: number;
+    readonly actionSetVersion: string;
+    readonly projectionDigest: string;
+}
+interface ReducerScenarioTrace {
+    readonly scenarioId: string;
+    readonly gameId: string;
+    readonly viewer: ReducerScenarioViewer;
+    readonly frames: readonly ReducerScenarioFrame[];
+    readonly exchanges: readonly ReducerScenarioExchange[];
+}
+type ReducerScenarioExchange = {
+    readonly id: string;
+    readonly operation: "validate";
+    readonly fromFrameId: string;
+    readonly input: wire.GameInput;
+    readonly result: wire.ReducerInputValidationResult;
+} | {
+    readonly id: string;
+    readonly operation: "submit";
+    readonly fromFrameId: string;
+    readonly input: wire.GameInput;
+    readonly result: {
+        readonly kind: "accepted";
+        readonly toFrameId: string;
+    } | {
+        readonly kind: "rejected";
+        readonly diagnostics: readonly ReducerScenarioDiagnostic[];
     };
 };
-declare function createTestRuntime(options: CreateTestRuntimeOptions): CreatedTestRuntime;
+interface ReducerScenarioDiagnostic {
+    readonly code: string;
+    readonly message: string;
+}
+type ReducerScenarioOperation = {
+    readonly id: string;
+    readonly operation: "validate";
+    readonly input: wire.GameInput;
+} | {
+    readonly id: string;
+    readonly operation: "submit";
+    readonly input: wire.GameInput;
+};
+interface CreateReducerScenarioRunnerOptions {
+    readonly scenarioId: string;
+    readonly gameId: string;
+    readonly initialState: wire.ReducerSessionState;
+    readonly bundle: ReducerScenarioBundle;
+    readonly viewer: ReducerScenarioViewer;
+    readonly playerIds: readonly string[];
+    readonly initialGameVersion?: number;
+}
+interface ReducerScenarioRunner {
+    run(operations: readonly ReducerScenarioOperation[]): Promise<ReducerScenarioTrace>;
+}
 
 declare function createReducerScenarioRunner(options: CreateReducerScenarioRunnerOptions): ReducerScenarioRunner;
 
@@ -120,9 +238,9 @@ declare const uiReplayRequestSchema: z.ZodUnion<readonly [z.ZodObject<{
     candidateValueKey: z.ZodOptional<z.ZodString>;
     actuatorKind: z.ZodOptional<z.ZodEnum<{
         fill: "fill";
-        pointer: "pointer";
-        keyboard: "keyboard";
         click: "click";
+        keyboard: "keyboard";
+        pointer: "pointer";
     }>>;
     allowDisabled: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strict>, z.ZodObject<{
@@ -186,9 +304,9 @@ declare const portableSemanticReplayStepSchema: z.ZodObject<{
         candidateValueKey: z.ZodOptional<z.ZodString>;
         actuatorKind: z.ZodOptional<z.ZodEnum<{
             fill: "fill";
-            pointer: "pointer";
-            keyboard: "keyboard";
             click: "click";
+            keyboard: "keyboard";
+            pointer: "pointer";
         }>>;
         allowDisabled: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strict>, z.ZodObject<{
@@ -253,9 +371,9 @@ declare const uiScenarioReplayStepSchema: z.ZodUnion<readonly [z.ZodObject<{
         candidateValueKey: z.ZodOptional<z.ZodString>;
         actuatorKind: z.ZodOptional<z.ZodEnum<{
             fill: "fill";
-            pointer: "pointer";
-            keyboard: "keyboard";
             click: "click";
+            keyboard: "keyboard";
+            pointer: "pointer";
         }>>;
         allowDisabled: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strict>, z.ZodObject<{
@@ -366,9 +484,9 @@ declare const uiScenarioFixtureSchema: z.ZodObject<{
             candidateValueKey: z.ZodOptional<z.ZodString>;
             actuatorKind: z.ZodOptional<z.ZodEnum<{
                 fill: "fill";
-                pointer: "pointer";
-                keyboard: "keyboard";
                 click: "click";
+                keyboard: "keyboard";
+                pointer: "pointer";
             }>>;
             allowDisabled: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strict>, z.ZodObject<{
@@ -698,4 +816,4 @@ declare function drag(options: DragReplayStepOptions): UIScenarioReplayStep;
 declare function submit(options: ReplayStepOptions): UIScenarioReplayStep;
 declare function assertStep(stepId: string, expect: UIStepExpectation): UIScenarioReplayStep;
 
-export { type CompilePluginProtocolTapeOptions, type CompileUIScenarioFixtureOptions, type CreateFixtureHostHarnessOptions, CreateReducerScenarioRunnerOptions, type CreateTestRuntimeOptions, type CreatedTestRuntime, type DeterministicIdFactory, ExpectFn, type FixtureEnvironmentInit, type FixtureHostEvent, type FixtureHostHarness, FixturePluginRuntime, InteractionExplanationLike, type PluginProtocolTape, type PortableSemanticReplayStep, type ProtocolUIScenarioAuthority, ReducerScenarioRunner, ReducerScenarioTrace, type ReducerUIScenarioAuthority, SnapshotMatcherHandler, type UIFixtureFrame, type UIFixtureProtocolStep, type UIReplayExecution, type UIReplayIdentityCandidate, type UIReplayRequest, type UIResolvedReplayIdentity, type UIScenarioAuthority, type UIScenarioAuthorityKind, type UIScenarioDefinition, type UIScenarioEnvironmentDefinition, type UIScenarioFixture, type UIScenarioFixtureBundleIndex, type UIScenarioReplayStep, type UIStepExpectation, UI_SCENARIO_FIXTURE_BUNDLE_SCHEMA_VERSION, UI_SCENARIO_FIXTURE_PLUGIN_RUNTIME_PROTOCOL, UI_SCENARIO_FIXTURE_SCHEMA_VERSION, UI_SCENARIO_FIXTURE_SUPPORTED_BROWSER_PROTOCOL_MAJOR, activate, assertDeterministicUIScenarioFixture, assertStep, assertSupportedBrowserInteractionProtocol, assertUIStepExpectationSatisfied, assertUniqueReplayIdentity, canonicalUIFixtureJson, canonicalizeUIFixtureJson, canonicalizeUIScenarioFixture, compareUIParityObservations, compilePluginProtocolTape, compileUIScenarioFixture, createDeterministicIdFactory, createExpectApi, createFixtureHostHarness, createReducerScenarioRunner, createTestRuntime, createUIParityObservationFromFixture, defaultFixtureEnvironmentInit, defineUIScenario, digestPluginProtocolTape, digestUIFixtureJson, digestUIFixtureRequest, digestUIFixtureTransportRequest, digestUIScenarioFixture, drag, fill, fixtureEnvironmentInitFor, isSha256Digest, parseUIParityObservationV1, parseUIScenarioFixture, parseUIScenarioFixtureBundleIndex, pluginProtocolTapeSchema, portableSemanticReplayStepSchema, press, serializeUIScenarioFixture, submit, uiFixtureFrameSchema, uiFixtureProtocolStepSchema, uiReplayExecutionSchema, uiReplayRequestSchema, uiResolvedReplayIdentitySchema, uiScenarioFixtureBundleIndexSchema, uiScenarioFixtureSchema, uiScenarioReplayStepSchema, uiStepExpectationSchema };
+export { ActorRef, type CompilePluginProtocolTapeOptions, type CompileUIScenarioFixtureOptions, type CreateFixtureHostHarnessOptions, type CreateReducerScenarioRunnerOptions, type DeterministicIdFactory, ExpectFn, type ExploreScenarioOptions, type ExploreScenarioResult, type ExploreSeedResult, type ExploreTransitionResult, type FixtureEnvironmentInit, type FixtureHostEvent, type FixtureHostHarness, FixturePluginRuntime, FlowDiagnostic, InspectEntropy, InspectNode, type InspectScenarioOptions, InspectScenarioResult, PerspectiveRef, PerspectiveSelector, type PluginProtocolTape, type PortableSemanticReplayStep, type ProtocolUIScenarioAuthority, type ReducerScenarioBundle, type ReducerScenarioDiagnostic, type ReducerScenarioExchange, type ReducerScenarioFrame, type ReducerScenarioOperation, type ReducerScenarioRunner, type ReducerScenarioTrace, type ReducerScenarioViewer, type ReducerUIScenarioAuthority, ScenarioAssertionError, ScenarioCheckpoint, ScenarioCommand, ScenarioDispatchTraceEntry, ScenarioIdentity, ScenarioReplayDefinition, Sha256Digest, SnapshotMatcherHandler, type UIFixtureFrame, type UIFixtureProtocolStep, type UIReplayExecution, type UIReplayIdentityCandidate, type UIReplayRequest, type UIResolvedReplayIdentity, type UIScenarioAuthority, type UIScenarioAuthorityKind, type UIScenarioDefinition, type UIScenarioEnvironmentDefinition, type UIScenarioFixture, type UIScenarioFixtureBundleIndex, type UIScenarioReplayStep, type UIStepExpectation, UI_SCENARIO_FIXTURE_BUNDLE_SCHEMA_VERSION, UI_SCENARIO_FIXTURE_PLUGIN_RUNTIME_PROTOCOL, UI_SCENARIO_FIXTURE_SCHEMA_VERSION, UI_SCENARIO_FIXTURE_SUPPORTED_BROWSER_PROTOCOL_MAJOR, activate, assertDeterministicUIScenarioFixture, assertStep, assertSupportedBrowserInteractionProtocol, assertUIStepExpectationSatisfied, assertUniqueReplayIdentity, canonicalUIFixtureJson, canonicalizeUIFixtureJson, canonicalizeUIScenarioFixture, compareUIParityObservations, compilePluginProtocolTape, compileUIScenarioFixture, createDeterministicIdFactory, createExpectApi, createFixtureHostHarness, createReducerScenarioRunner, createUIParityObservationFromFixture, defaultFixtureEnvironmentInit, defineUIScenario, digestPluginProtocolTape, digestUIFixtureJson, digestUIFixtureRequest, digestUIFixtureTransportRequest, digestUIScenarioFixture, drag, exploreScenario, fill, fixtureEnvironmentInitFor, inspectScenario, isSha256Digest, parseUIParityObservationV1, parseUIScenarioFixture, parseUIScenarioFixtureBundleIndex, pluginProtocolTapeSchema, portableSemanticReplayStepSchema, press, serializeUIScenarioFixture, submit, uiFixtureFrameSchema, uiFixtureProtocolStepSchema, uiReplayExecutionSchema, uiReplayRequestSchema, uiResolvedReplayIdentitySchema, uiScenarioFixtureBundleIndexSchema, uiScenarioFixtureSchema, uiScenarioReplayStepSchema, uiStepExpectationSchema };