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

package/dist/types-DcADVHe9.d.ts

@@ -0,0 +1,192 @@
+import { R as ReducerDiagnosticEvent, D as DispatchTraceSummaryEntry } from './diagnostics-1BWjRo6-.js';
+import { a as ReducerBundleContract, w as wire } from './index.d-DMASeF6M.js';
+
+type TestRunner = "reducer" | "remote" | "browser";
+type InteractionDescriptorLike = {
+    interactionId?: string;
+    surface?: string;
+    kind?: string;
+    availability?: InteractionAvailabilityLike;
+    context?: {
+        to?: string;
+    };
+} & Record<string, unknown>;
+type InteractionAvailabilityLike = {
+    status: "available";
+} | {
+    status: "notYourTurn";
+    reason: string;
+} | {
+    status: "insufficientResources";
+    reason: string;
+    missingResources?: Record<string, unknown>;
+} | {
+    status: "blocked";
+    reason: string;
+};
+type InteractionExplanationLike = {
+    interactionId: string;
+    phase: string;
+    step: string | null;
+    availability: "available" | "notYourTurn" | "wrongPhase" | "wrongStep" | "blocked";
+    rules: ReadonlyArray<{
+        ruleId: string;
+        outcome: "passed" | "failed" | "notEvaluated";
+        errorCode?: string;
+        message?: string;
+    }>;
+    actor: {
+        required: readonly string[];
+        playerIsActor: boolean;
+    };
+    inputs: ReadonlyArray<{
+        key: string;
+        kind: string;
+        eligibleCount: number | "lazy";
+    }>;
+};
+type SnapshotMatcherHandler = (name: string | undefined, actual: unknown) => void;
+type RejectionExpectation = {
+    errorCode?: string;
+    message?: string | RegExp;
+};
+type ExpectMatchers = {
+    toBe: (expected: unknown) => void;
+    toEqual: (expected: unknown) => void;
+    toMatchObject: (expected: Record<string, unknown>) => void;
+    toBeDefined: () => void;
+    toBeUndefined: () => void;
+    toBeNull: () => void;
+    toContain: (expected: unknown) => void;
+    toContainEqual: (expected: unknown) => void;
+    toHaveLength: (expected: number) => void;
+    toBeGreaterThan: (expected: number) => void;
+    toBeGreaterThanOrEqual: (expected: number) => void;
+    toThrow: (predicate?: string | RegExp | ((error: Error) => boolean)) => void;
+    toMatchSnapshot: (filename?: string) => void;
+    toRejectWith: (expected: RejectionExpectation) => Promise<void>;
+    toHaveInteraction: (interactionId: string, opts?: Partial<InteractionDescriptorLike>) => void;
+    toBeGatedBy: (reason: string, opts?: {
+        interactionId?: string;
+    }) => void;
+    toBeAvailable: (explanation?: InteractionExplanationLike) => void;
+    toBeActiveFor: (playerId: string, opts?: {
+        interactionId?: string;
+    }) => void;
+    not: {
+        toHaveInteraction: (interactionId: string) => void;
+    };
+};
+type ExpectFn = (actual: unknown) => ExpectMatchers;
+interface BaseContext<PlayerId extends string = string> {
+    game: {
+        start(): Promise<void>;
+        patchState?(mutator: (state: Record<string, unknown>) => void): Promise<void>;
+        submit(playerId: PlayerId, interactionId: string, params?: unknown): Promise<void>;
+    };
+    players(): readonly PlayerId[];
+    seat(index: number): PlayerId;
+}
+interface SharedScenarioContext<PlayerId extends string = string, StateName extends string = string, View = unknown, Descriptor extends InteractionDescriptorLike = InteractionDescriptorLike> extends BaseContext<PlayerId> {
+    state(): StateName;
+    view(playerId: PlayerId): View;
+    interactions(playerId: PlayerId): readonly Descriptor[];
+    explain(playerId: PlayerId, interactionId: string): InteractionExplanationLike;
+    diagnostics: {
+        readonly events: readonly ReducerDiagnosticEvent[];
+        readonly lastDispatch: {
+            submissionId: string;
+            trace: readonly DispatchTraceSummaryEntry[];
+        } | null;
+        clear(): void;
+    };
+    expect: ExpectFn;
+}
+interface BaseDefinition {
+    id: string;
+    seed?: number;
+    players?: number;
+    setupProfileId?: string | null;
+    extends?: string;
+    setup: (ctx: BaseContext) => void | Promise<void>;
+}
+interface ScenarioDefinition<Runners extends readonly TestRunner[] = readonly ["reducer"], PhaseName extends string = string, StageName extends string = string> {
+    id: string;
+    description?: string;
+    from: string;
+    runners?: Runners;
+    phase?: PhaseName;
+    stage?: StageName;
+    when: (ctx: SharedScenarioContext) => void | Promise<void>;
+    then: (ctx: SharedScenarioContext) => void | Promise<void>;
+}
+declare function defineBase<const Definition extends BaseDefinition>(definition: Definition): Definition;
+declare function defineScenario<const Runners extends readonly TestRunner[] = readonly ["reducer"], const PhaseName extends string = string, const StageName extends string = string>(definition: ScenarioDefinition<Runners, PhaseName, StageName>): ScenarioDefinition<Runners, PhaseName, StageName>;
+
+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[];
+    };
+};
+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>;
+}
+
+export { type BaseContext as B, type CreateReducerScenarioRunnerOptions as C, type ExpectFn as E, type InteractionAvailabilityLike as I, type ReducerScenarioBundle as R, type ScenarioDefinition as S, type TestRunner as T, type BaseDefinition as a, type ExpectMatchers as b, type InteractionDescriptorLike as c, type InteractionExplanationLike as d, type ReducerScenarioDiagnostic as e, type ReducerScenarioExchange as f, type ReducerScenarioFrame as g, type ReducerScenarioOperation as h, type ReducerScenarioRunner as i, type ReducerScenarioTrace as j, type ReducerScenarioViewer as k, type RejectionExpectation as l, type SharedScenarioContext as m, type SnapshotMatcherHandler as n, defineBase as o, defineScenario as p };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreamboard-games/sdk",
-  "version": "0.4.0-alpha.6",
+  "version": "0.4.0-alpha.7",
   "description": "Dreamboard SDK package set metadata and public facade",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,6 +16,11 @@
       "import": "./dist/package-set.js",
       "default": "./dist/package-set.js"
     },
+    "./reference-games": {
+      "types": "./dist/reference-games/index.d.ts",
+      "import": "./dist/reference-games/index.js",
+      "default": "./dist/reference-games/index.js"
+    },
     "./types": {
       "types": "./dist/types.d.ts",
       "import": "./dist/types.js",
@@ -94,6 +99,11 @@
       "import": "./dist/testing.js",
       "default": "./dist/testing.js"
     },
+    "./testing-runtime": {
+      "types": "./dist/testing-runtime.d.ts",
+      "import": "./dist/testing-runtime.js",
+      "default": "./dist/testing-runtime.js"
+    },
     "./browser-interaction": {
       "bun": "./src/browser-interaction.ts",
       "types": "./dist/browser-interaction.d.ts",
@@ -111,7 +121,7 @@
     "!tsconfig.tsbuildinfo"
   ],
   "scripts": {
-    "build": "pnpm --dir ../.. --filter @dreamboard-games/plugin-runtime-contract build && pnpm --dir ../.. authoring-metadata:generate && tsup && node ../../scripts/copy-sdk-private-dts.mjs && mkdir -p dist/ui && tailwindcss -i src/ui/plugin-styles.css -o dist/ui/plugin-styles.css --minify",
+    "build": "pnpm --dir ../.. --filter @dreamboard-games/sdk-types build && pnpm --dir ../.. --filter @dreamboard-games/plugin-runtime-contract build && pnpm --dir ../.. authoring-metadata:generate && tsup && node ../../scripts/copy-sdk-private-dts.mjs && mkdir -p dist/ui && tailwindcss -i src/ui/plugin-styles.css -o dist/ui/plugin-styles.css --minify",
     "typecheck": "tsc --noEmit",
     "lint": "eslint 'src/**/*.{ts,tsx}'",
     "storybook": "storybook dev -p 6006 --host 127.0.0.1 --no-open",
@@ -128,6 +138,7 @@
     "@radix-ui/react-select": "^2.3.1",
     "@radix-ui/react-slot": "^1.3.0",
     "@radix-ui/react-tooltip": "^1.2.10",
+    "@noble/hashes": "^2.2.0",
     "@use-gesture/react": "^10.3.1",
     "clsx": "^2.1.1",
     "lucide-react": "^1.20.0",