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

package/dist/testing.d.ts

@@ -1,12 +1,12 @@
 import { R as ReducerDiagnosticEvent, D as DispatchTraceSummaryEntry } from './stale-contract-artifact-error-BelRiIDR.js';
 export { S as StaleContractArtifactError, b as StaleContractArtifactErrorOptions, c as StaleContractArtifactKind, i as isStaleContractArtifactError } from './stale-contract-artifact-error-BelRiIDR.js';
-import { w as wire, a as ReducerBundleContract } from './index.d-BL3bT5lt.js';
-import { o, v, u, s, t } from './protocol-BP193lva.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 { R as RuntimeJson } from './runtime-json-CQ9QbLZ5.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-CYeN0wLK.js';
+import { b as PluginTransport, P as PluginRuntimeClient } from './types-aI4V9CWe.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import react__default from 'react';
 
@@ -172,8 +172,8 @@ type CreateTestRuntimeOptions = {
 };
 type CreatedTestRuntime = {
     runtime: RuntimeAPI;
-    getFrame(): o;
-    getSessionDescriptor(): v;
+    getFrame(): p;
+    getSessionDescriptor(): w;
     players(): readonly string[];
     seat(index: number): string;
     submit(playerId: string, interactionId: string, params?: unknown): Promise<void>;
@@ -264,7 +264,7 @@ declare const UI_SCENARIO_FIXTURE_SUPPORTED_BROWSER_PROTOCOL_MAJOR = 3;
 declare const UI_SCENARIO_FIXTURE_PLUGIN_RUNTIME_PROTOCOL: 3;
 declare const uiFixtureFrameSchema: z.ZodObject<{
     id: z.ZodString;
-    frame: z.ZodType<o<unknown, string, string, string>, unknown, z.core.$ZodTypeInternals<o<unknown, string, string, string>, unknown>>;
+    frame: z.ZodType<p<unknown, string, string, string>, unknown, z.core.$ZodTypeInternals<p<unknown, string, string, string>, unknown>>;
     projectionDigest: z.ZodString;
 }, z.core.$strict>;
 declare const uiFixtureProtocolStepSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -294,7 +294,7 @@ declare const uiFixtureProtocolStepSchema: z.ZodDiscriminatedUnion<[z.ZodObject<
         message: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>], "accepted">;
 }, z.core.$strict>], "kind">;
-declare const pluginProtocolTapeSchema: z.ZodType<u, unknown, z.core.$ZodTypeInternals<u, unknown>>;
+declare const pluginProtocolTapeSchema: z.ZodType<v, unknown, z.core.$ZodTypeInternals<v, unknown>>;
 declare const uiReplayRequestSchema: z.ZodUnion<readonly [z.ZodObject<{
     surface: z.ZodString;
     scopeId: z.ZodOptional<z.ZodString>;
@@ -519,6 +519,7 @@ declare const uiScenarioFixtureSchema: z.ZodObject<{
         renderModule: z.ZodString;
         renderModuleDigest: z.ZodString;
         sourceDigest: z.ZodString;
+        sourceFiles: z.ZodOptional<z.ZodArray<z.ZodString>>;
     }, z.core.$strict>;
     viewer: z.ZodObject<{
         seatId: z.ZodString;
@@ -536,7 +537,7 @@ declare const uiScenarioFixtureSchema: z.ZodObject<{
             phone: "phone";
         }>>;
     }, z.core.$strict>;
-    protocol: z.ZodType<u, unknown, z.core.$ZodTypeInternals<u, unknown>>;
+    protocol: z.ZodType<v, unknown, z.core.$ZodTypeInternals<v, unknown>>;
     replay: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         stepId: z.ZodString;
         requestDigest: z.ZodString;
@@ -645,9 +646,9 @@ type UIStepExpectation = z.infer<typeof uiStepExpectationSchema>;
 type UIResolvedReplayIdentity = z.infer<typeof uiResolvedReplayIdentitySchema>;
 type PortableSemanticReplayStep = z.infer<typeof portableSemanticReplayStepSchema>;
 type UIScenarioReplayStep = z.infer<typeof uiScenarioReplayStepSchema>;
-type UIFixtureFrame = s;
-type UIFixtureProtocolStep = t;
-type PluginProtocolTape = u;
+type UIFixtureFrame = t;
+type UIFixtureProtocolStep = u;
+type PluginProtocolTape = v;
 type UIScenarioFixture = Omit<z.infer<typeof uiScenarioFixtureSchema>, "protocol" | "replay"> & {
     readonly protocol: PluginProtocolTape;
     readonly replay: readonly UIScenarioReplayStep[];
@@ -657,6 +658,40 @@ declare function parseUIScenarioFixture(value: unknown): UIScenarioFixture;
 declare function parseUIScenarioFixtureBundleIndex(value: unknown): UIScenarioFixtureBundleIndex;
 declare function assertSupportedBrowserInteractionProtocol(version: string): void;
 
+type UIScenarioAuthorityKind = "protocol" | "reducer";
+interface UIScenarioEnvironmentDefinition {
+    readonly viewport?: "desktop" | "tablet" | "phone";
+    readonly browsers?: readonly ("chromium" | "webkit")[];
+    readonly input?: readonly ("mouse" | "touch" | "keyboard")[];
+}
+interface ProtocolUIScenarioAuthority {
+    readonly kind: "protocol";
+    readonly tape: PluginProtocolTape;
+}
+interface ReducerUIScenarioAuthority {
+    readonly kind: "reducer";
+    readonly referenceGame: unknown;
+    readonly coverage: unknown;
+    readonly bundle: unknown;
+    readonly initialState: unknown;
+    readonly viewer: unknown;
+    readonly playerIds?: readonly string[];
+    readonly operations: readonly unknown[];
+}
+type UIScenarioAuthority = ProtocolUIScenarioAuthority | ReducerUIScenarioAuthority;
+interface UIScenarioDefinition {
+    readonly id: string;
+    readonly title?: string;
+    readonly contracts: readonly string[];
+    readonly capabilities: readonly string[];
+    readonly sourceFiles: readonly string[];
+    readonly environment?: UIScenarioEnvironmentDefinition;
+    readonly authority: UIScenarioAuthority;
+    readonly replay: readonly UIScenarioReplayStep[];
+}
+
+declare function defineUIScenario<const TScenario extends UIScenarioDefinition>(scenario: TScenario): Readonly<TScenario>;
+
 type CanonicalJson = null | boolean | number | string | readonly CanonicalJson[] | {
     readonly [key: string]: CanonicalJson;
 };
@@ -707,6 +742,10 @@ interface UIParityObservationCheckpointV1 {
     readonly submissionDigest?: string;
     readonly screenshot?: string;
 }
+interface UIParityObservationProvenanceV1 {
+    readonly kind: "fixture-expectation" | "source-workbench" | "packed-real-host";
+    readonly evidence?: string;
+}
 interface UIParityObservationV1 {
     readonly schemaVersion: 1;
     readonly scenarioId: string;
@@ -715,6 +754,7 @@ interface UIParityObservationV1 {
     readonly pluginRuntimeProtocol: 3;
     readonly browserInteractionProtocol: string;
     readonly environment: UIParityObservationEnvironmentV1;
+    readonly provenance: UIParityObservationProvenanceV1;
     readonly checkpoints: readonly UIParityObservationCheckpointV1[];
     readonly diagnostics: readonly UIParityDiagnosticV1[];
 }
@@ -757,7 +797,7 @@ interface FixtureHostEvent {
 }
 interface FixtureHostHarness {
     readonly transport: PluginTransport;
-    readonly tape: u;
+    readonly tape: v;
     reset(): void;
     flush(): Promise<void>;
     advanceHost(): Promise<void>;
@@ -766,7 +806,7 @@ interface FixtureHostHarness {
     assertConsumed(): void;
 }
 interface CreateFixtureHostHarnessOptions {
-    readonly tape: u;
+    readonly tape: v;
     readonly strict?: boolean;
     readonly latencyMs?: number;
     readonly channelId?: string;
@@ -783,7 +823,7 @@ declare function FixturePluginRuntime({ harness, runtime, children, }: {
 
 interface CompilePluginProtocolTapeOptions {
     readonly trace: ReducerScenarioTrace;
-    readonly session: v;
+    readonly session: w;
 }
 declare function compilePluginProtocolTape(options: CompilePluginProtocolTapeOptions): PluginProtocolTape;
 
@@ -821,4 +861,27 @@ declare function assertDeterministicUIScenarioFixture(first: UIScenarioFixture,
 declare function assertUniqueReplayIdentity(step: Pick<PortableSemanticReplayStep, "stepId" | "expectedIdentity">, candidates: readonly UIReplayIdentityCandidate[]): UIReplayIdentityCandidate;
 declare function assertUIStepExpectationSatisfied(stepId: string, expected: UIStepExpectation, actual: UIStepExpectation): void;
 
-export { type BaseContext, type BaseDefinition, type CompilePluginProtocolTapeOptions, type CompileUIScenarioFixtureOptions, type CreateFixtureHostHarnessOptions, type CreateReducerScenarioRunnerOptions, type CreateTestRuntimeOptions, type CreatedTestRuntime, type DeterministicIdFactory, type ExpectFn, type ExpectMatchers, type FixtureEnvironmentInit, type FixtureHostEvent, type FixtureHostHarness, FixturePluginRuntime, type InteractionAvailabilityLike, type InteractionDescriptorLike, type InteractionExplanationLike, type PluginProtocolTape, type PortableSemanticReplayStep, type ReducerScenarioBundle, type ReducerScenarioDiagnostic, type ReducerScenarioExchange, type ReducerScenarioFrame, type ReducerScenarioOperation, type ReducerScenarioRunner, type ReducerScenarioTrace, type ReducerScenarioViewer, type RejectionExpectation, type ScenarioDefinition, type SharedScenarioContext, type SnapshotMatcherHandler, type TestRunner, type UIFixtureFrame, type UIFixtureProtocolStep, type UIReplayExecution, type UIReplayIdentityCandidate, type UIReplayRequest, type UIResolvedReplayIdentity, 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, assertDeterministicUIScenarioFixture, assertSupportedBrowserInteractionProtocol, assertUIStepExpectationSatisfied, assertUniqueReplayIdentity, canonicalUIFixtureJson, canonicalizeUIFixtureJson, canonicalizeUIScenarioFixture, compareUIParityObservations, compilePluginProtocolTape, compileUIScenarioFixture, createDeterministicIdFactory, createExpectApi, createFixtureHostHarness, createReducerScenarioRunner, createTestRuntime, createUIParityObservationFromFixture, defaultFixtureEnvironmentInit, defineBase, defineScenario, digestPluginProtocolTape, digestUIFixtureJson, digestUIFixtureRequest, digestUIFixtureTransportRequest, digestUIScenarioFixture, fixtureEnvironmentInitFor, isSha256Digest, parseUIParityObservationV1, parseUIScenarioFixture, parseUIScenarioFixtureBundleIndex, pluginProtocolTapeSchema, portableSemanticReplayStepSchema, serializeUIScenarioFixture, uiFixtureFrameSchema, uiFixtureProtocolStepSchema, uiReplayExecutionSchema, uiReplayRequestSchema, uiResolvedReplayIdentitySchema, uiScenarioFixtureBundleIndexSchema, uiScenarioFixtureSchema, uiScenarioReplayStepSchema, uiStepExpectationSchema };
+type ReplayRequest = PortableSemanticReplayStep["resolve"];
+type DragTarget = Extract<PortableSemanticReplayStep["execute"], {
+    kind: "drag";
+}>["target"];
+interface ReplayStepOptions {
+    readonly stepId: string;
+    readonly resolve: ReplayRequest;
+    readonly expect: UIStepExpectation;
+    readonly expectedIdentity?: UIResolvedReplayIdentity;
+}
+interface FillReplayStepOptions extends ReplayStepOptions {
+    readonly value: string;
+}
+interface DragReplayStepOptions extends ReplayStepOptions {
+    readonly target: DragTarget;
+}
+declare function activate(options: ReplayStepOptions): UIScenarioReplayStep;
+declare function fill(options: FillReplayStepOptions): UIScenarioReplayStep;
+declare function press(options: ReplayStepOptions): UIScenarioReplayStep;
+declare function drag(options: DragReplayStepOptions): UIScenarioReplayStep;
+declare function submit(options: ReplayStepOptions): UIScenarioReplayStep;
+declare function assertStep(stepId: string, expect: UIStepExpectation): UIScenarioReplayStep;
+
+export { type BaseContext, type BaseDefinition, type CompilePluginProtocolTapeOptions, type CompileUIScenarioFixtureOptions, type CreateFixtureHostHarnessOptions, type CreateReducerScenarioRunnerOptions, type CreateTestRuntimeOptions, type CreatedTestRuntime, type DeterministicIdFactory, type ExpectFn, type ExpectMatchers, type FixtureEnvironmentInit, type FixtureHostEvent, type FixtureHostHarness, FixturePluginRuntime, type InteractionAvailabilityLike, type InteractionDescriptorLike, type InteractionExplanationLike, type PluginProtocolTape, type PortableSemanticReplayStep, type ProtocolUIScenarioAuthority, type ReducerScenarioBundle, type ReducerScenarioDiagnostic, type ReducerScenarioExchange, type ReducerScenarioFrame, type ReducerScenarioOperation, type ReducerScenarioRunner, type ReducerScenarioTrace, type ReducerScenarioViewer, type ReducerUIScenarioAuthority, type RejectionExpectation, type ScenarioDefinition, type SharedScenarioContext, type SnapshotMatcherHandler, type TestRunner, 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, defineBase, defineScenario, 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 };

package/dist/testing.js

@@ -5,7 +5,7 @@ import {
 import {
   PluginRuntimeBoundary,
   createPluginRuntimeClient
-} from "./chunk-K5ZRJTZZ.js";
+} from "./chunk-PAPIAMYX.js";
 import {
   DREAMBOARD_PLUGIN_PROTOCOL,
   DREAMBOARD_PLUGIN_PROTOCOL_VERSION,
@@ -14,12 +14,12 @@ import {
   PluginProtocolTapeSchema,
   computePluginActionSetVersion,
   materializePluginGameplayFrame
-} from "./chunk-O6M6PN4E.js";
+} from "./chunk-UUQNOGZV.js";
 import {
   BROWSER_INTERACTION_ACTUATOR_KINDS,
   DREAMBOARD_BROWSER_INTERACTION_PROTOCOL_VERSION,
   browserInteractionEffectSchema
-} from "./chunk-WUIVY2KE.js";
+} from "./chunk-WHR5UW3F.js";
 import {
   RuntimeJsonSchema
 } from "./chunk-PF7L4BMG.js";
@@ -488,6 +488,7 @@ function buildPluginFrame(options) {
       simultaneousPhase: projection.simultaneousPhase ?? null
     },
     availableInteractions,
+    recentEvents: [],
     zones
   };
 }
@@ -519,7 +520,7 @@ function createTestRuntime(options) {
   };
   let version = 0;
   let submissionCounter = 0;
-  let currentPlayerId = playerIds[0] ?? "";
+  const currentPlayerId = playerIds[0] ?? "";
   const diagnosticEvents = [];
   let lastDispatch = null;
   const toReadySessionState = (frame) => ({
@@ -558,7 +559,7 @@ function createTestRuntime(options) {
       message: result.message
     };
   };
-  const submit = async (playerId, interactionId, params = {}) => {
+  const submit2 = async (playerId, interactionId, params = {}) => {
     submissionCounter += 1;
     const submissionId = `sub-${submissionCounter}`;
     diagnosticEvents.push({
@@ -620,7 +621,7 @@ function createTestRuntime(options) {
   };
   const runtime = {
     validateInteraction: (interactionId, params) => validate(currentPlayerId, interactionId, params),
-    submitInteraction: (interactionId, params) => submit(currentPlayerId, interactionId, params),
+    submitInteraction: (interactionId, params) => submit2(currentPlayerId, interactionId, params),
     getSessionState: () => lastSessionState,
     disconnect: () => void 0
   };
@@ -637,7 +638,7 @@ function createTestRuntime(options) {
       }
       return playerIds[index];
     },
-    submit,
+    submit: submit2,
     validate,
     explain,
     diagnostics: {
@@ -857,6 +858,11 @@ function readFlowState2(state) {
   };
 }
 
+// src/testing/ui-scenario/define-ui-scenario.ts
+function defineUIScenario(scenario) {
+  return Object.freeze(scenario);
+}
+
 // src/testing/ui-fixture/parity.ts
 var topLevelComparisons = [
   { path: "scenarioId", code: "fixture-source-mismatch" },
@@ -942,6 +948,9 @@ function createUIParityObservationFromFixture({
     pluginRuntimeProtocol: fixture.pluginRuntimeProtocol,
     browserInteractionProtocol: fixture.browserInteractionProtocol,
     environment,
+    provenance: {
+      kind: "fixture-expectation"
+    },
     checkpoints,
     diagnostics
   };
@@ -966,6 +975,16 @@ function parseUIParityObservationV1(value) {
   const viewport = assertRecord(environment.viewport, "environment.viewport");
   assertNumber(viewport.width, "environment.viewport.width");
   assertNumber(viewport.height, "environment.viewport.height");
+  const provenance = assertRecord(
+    observation.provenance,
+    "observation.provenance"
+  );
+  if (provenance.kind !== "fixture-expectation" && provenance.kind !== "source-workbench" && provenance.kind !== "packed-real-host") {
+    throw new Error(
+      "observation.provenance.kind must identify fixture, source Workbench, or packed real-host measurement."
+    );
+  }
+  assertOptionalString(provenance.evidence, "observation.provenance.evidence");
   const checkpoints = assertArray(observation.checkpoints, "checkpoints");
   for (let index = 0; index < checkpoints.length; index += 1) {
     const checkpoint = assertRecord(
@@ -1679,7 +1698,8 @@ var uiScenarioFixtureSchema = z.object({
     uiContractFingerprint: nonEmptyStringSchema,
     renderModule: nonEmptyStringSchema,
     renderModuleDigest: digestSchema,
-    sourceDigest: digestSchema
+    sourceDigest: digestSchema,
+    sourceFiles: z.array(nonEmptyStringSchema).optional()
   }).strict(),
   viewer: z.object({
     seatId: nonEmptyStringSchema,
@@ -1919,6 +1939,40 @@ function assertUIStepExpectationSatisfied(stepId, expected, actual) {
     }
   }
 }
+
+// src/testing/ui-scenario/replay-builders.ts
+function semanticStep(options, execute) {
+  return {
+    stepId: options.stepId,
+    requestDigest: digestUIFixtureRequest(options.resolve),
+    resolve: options.resolve,
+    execute,
+    expectedIdentity: options.expectedIdentity,
+    expect: options.expect
+  };
+}
+function activate(options) {
+  return semanticStep(options, { kind: "activate" });
+}
+function fill(options) {
+  return semanticStep(options, { kind: "fill", value: options.value });
+}
+function press(options) {
+  return activate(options);
+}
+function drag(options) {
+  return semanticStep(options, { kind: "drag", target: options.target });
+}
+function submit(options) {
+  return activate(options);
+}
+function assertStep(stepId, expect) {
+  return {
+    stepId,
+    kind: "assert",
+    expect
+  };
+}
 export {
   FixturePluginRuntime,
   StaleContractArtifactError,
@@ -1926,7 +1980,9 @@ export {
   UI_SCENARIO_FIXTURE_PLUGIN_RUNTIME_PROTOCOL,
   UI_SCENARIO_FIXTURE_SCHEMA_VERSION,
   UI_SCENARIO_FIXTURE_SUPPORTED_BROWSER_PROTOCOL_MAJOR,
+  activate,
   assertDeterministicUIScenarioFixture,
+  assertStep,
   assertSupportedBrowserInteractionProtocol,
   assertUIStepExpectationSatisfied,
   assertUniqueReplayIdentity,
@@ -1945,11 +2001,14 @@ export {
   defaultFixtureEnvironmentInit,
   defineBase,
   defineScenario,
+  defineUIScenario,
   digestPluginProtocolTape,
   digestUIFixtureJson,
   digestUIFixtureRequest,
   digestUIFixtureTransportRequest,
   digestUIScenarioFixture,
+  drag,
+  fill,
   fixtureEnvironmentInitFor,
   isSha256Digest,
   isStaleContractArtifactError,
@@ -1958,7 +2017,9 @@ export {
   parseUIScenarioFixtureBundleIndex,
   pluginProtocolTapeSchema,
   portableSemanticReplayStepSchema,
+  press,
   serializeUIScenarioFixture,
+  submit,
   uiFixtureFrameSchema,
   uiFixtureProtocolStepSchema,
   uiReplayExecutionSchema,