@dreamboard-games/testing 0.1.0

package/LICENSE

@@ -0,0 +1,89 @@
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality through different kinds of interfaces or for different technical platforms.  Applications can compete with services, libraries with plugins, frameworks with development tools, and so on, even if they're written in different programming languages or for different computer architectures.  Goods and services compete even when provided free of charge.  If you market a product as a practical substitute for the software or another product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does not compete, but the licensor or any of its affiliates brings your product into competition by providing a new version of the software or another product using the software, you may continue using versions of the software available under these terms beforehand to provide your competing product, but not any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product or service that the licensor or any of its affiliates has stopped providing, unless the licensor includes a plain-text line beginning with `Licensor Line of Business:` with the software that mentions that line of business.  For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of business developing the software or using the software to provide a product, the buyer can also enforce [Noncompete](#noncompete) for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+A **product** can be a good or service, or a combination of them.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all its affiliates.
+
+**Affiliates** means the other organizations than an organization has control over, is under the control of, or is under common control with.
+
+**Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/NOTICE

@@ -0,0 +1 @@
+Required Notice: Copyright Dreamboard Games.

package/README.md

@@ -0,0 +1,176 @@
+# @dreamboard/testing
+
+Reducer-native authored testing helpers for Dreamboard workspaces.
+
+The package provides:
+
+- `defineBase(...)` and `defineScenario(...)` identity helpers
+- inherited base composition via `extends`
+- matcher construction via `createExpectApi(...)`
+- rejection assertions via `toRejectWith({ errorCode })`
+- descriptor matchers such as `toHaveInteraction(...)`,
+  `toBeGatedBy(...)`, and `toBeActiveFor(...)`
+- `createTestRuntime(...)` for backend-free UI tests against real reducer
+  state
+
+---
+
+## Matchers reference
+
+`createExpectApi()` returns an `expect` function that exposes a chainable
+matcher surface. All matchers throw synchronously on mismatch, except
+`toRejectWith(...)` which returns a promise.
+
+### Value matchers
+
+| Matcher                             | Purpose                                      |
+| ----------------------------------- | -------------------------------------------- |
+| `toBe(expected)`                    | Strict equality (`===`)                      |
+| `toEqual(expected)`                 | Deep equality                                |
+| `toMatchObject(partial)`            | Deep partial match against an object tree    |
+| `toBeDefined()` / `toBeUndefined()` | Presence checks                              |
+| `toBeNull()`                        | Null check                                   |
+| `toContain(expected)`               | Array or string containment                  |
+| `toContainEqual(expected)`          | Array containment by deep equality           |
+| `toHaveLength(n)`                   | Length check on arrays and strings           |
+| `toBeGreaterThanOrEqual(n)`         | Numeric ordering                             |
+| `toThrow(predicate?)`               | Synchronous throw assertion                  |
+| `toMatchSnapshot(filename?)`        | Delegates to the configured snapshot handler |
+
+### Rejection matcher
+
+```ts
+await expect(() =>
+  game.submit(seat(1), "placeThingCard", {
+    cardId: "a-dog",
+    ringId: "ring-1",
+  }),
+).toRejectWith({ errorCode: "CARD_NOT_IN_HAND" });
+```
+
+`toRejectWith` awaits the function (or promise) and asserts the thrown
+error carries the named `errorCode`. An optional `message` (string or
+`RegExp`) can further constrain the rejection.
+
+### Descriptor matchers
+
+Descriptor matchers operate on the interaction descriptors returned by
+`interactions(playerId)` in a scenario context.
+
+```ts
+expect(interactions(seat(0))).toHaveInteraction("judgePlacement", {
+  kind: "prompt",
+});
+
+expect(interactions(seat(1))).not.toHaveInteraction("judgePlacement");
+
+expect(interactions(seat(0))).toBeActiveFor(seat(0), {
+  interactionId: "judgePlacement",
+});
+
+expect(interactions(seat(1))).toBeGatedBy("NOT_YOUR_TURN", {
+  interactionId: "placeThingCard",
+});
+```
+
+When asserting against a single descriptor (for example, one returned
+from a lookup), the `opts.interactionId` argument can be omitted:
+
+```ts
+const descriptor = interactions(seat(0)).find(
+  (entry) => entry.interactionId === "judgePlacement",
+);
+expect(descriptor).toBeActiveFor(seat(0));
+```
+
+---
+
+## Authorization invariants — rewritten descriptor scenario
+
+The rewritten `reject-non-knower-cannot-judge` scenario in
+`examples/things-in-rings/test/scenarios/` demonstrates how descriptor
+matchers replace ad-hoc inspection of `context.to` and
+`unavailableReason`:
+
+```ts
+import { defineScenario } from "../testing-types";
+
+export default defineScenario({
+  id: "reject-non-knower-cannot-judge",
+  description:
+    "Only the knower can act during judgeRings, so the pending card remains in place",
+  from: "after-first-placement",
+  phase: "judgeRings",
+  when: async ({ game, seat, expect }) => {
+    const placer = seat(1);
+    await expect(() =>
+      game.submit(placer, "judgePlacement", { decision: "ring-1" }),
+    ).toRejectWith({ errorCode: "prompt-not-owned" });
+  },
+  then: ({ state, interactions, expect, seat }) => {
+    const knowerId = seat(0);
+    const placerId = seat(1);
+
+    expect(state()).toBe("judgeRings");
+
+    // Descriptor must exist for the knower with the right kind.
+    expect(interactions(knowerId)).toHaveInteraction("judgePlacement", {
+      kind: "prompt",
+    });
+
+    // Descriptor must be active (available) for the knower.
+    expect(interactions(knowerId)).toBeActiveFor(knowerId, {
+      interactionId: "judgePlacement",
+    });
+
+    // Descriptor must be absent for non-knowers.
+    expect(interactions(placerId)).not.toHaveInteraction("judgePlacement");
+  },
+});
+```
+
+The previous variant of this scenario inspected descriptor shapes
+inline. The matcher-driven version encodes the same invariants —
+"prompt exists", "prompt is active for the knower", "prompt is absent
+for others" — without leaking descriptor layout into the scenario body.
+
+---
+
+## `createTestRuntime` for backend-free UI tests
+
+`createTestRuntime` returns a runtime object compatible with `ui-sdk`'s
+`RuntimeAPI` plus snapshot/subscription helpers. The canonical harness
+for a plugin component renders it inside `RuntimeProvider` and
+`PluginStateProvider`:
+
+```tsx
+import { PluginStateProvider, RuntimeProvider } from "@dreamboard/ui-sdk";
+import { createTestRuntime } from "./testing-types";
+
+const rt = createTestRuntime({
+  baseId: "initial-turn",
+  phase: "placeThing",
+  controllingPlayerId: "player-1",
+});
+
+const markup = renderToString(
+  <RuntimeProvider runtime={rt.runtime}>
+    <PluginStateProvider>
+      <MyPluginComponent />
+    </PluginStateProvider>
+  </RuntimeProvider>,
+);
+
+await rt.submit(rt.seat(1), "placeThingCard", {
+  cardId: "a-diamond",
+  ringId: "ring-1",
+});
+
+// After submit, a fresh snapshot flows through the store and any
+// subsequent render reflects the updated gameplay state.
+```
+
+Internally `createTestRuntime` drives `packages/ui-host-runtime`'s
+unified session store via `applyGameplaySnapshotLocal(...)`, so
+`useIsMyTurn`, inbox/interaction hooks, and submit-driven rerenders
+behave as they do in production, without a backend connection.

package/dist/index.d.ts

@@ -0,0 +1,121 @@
+import { ReducerBundleContract } from '@dreamboard/reducer-contract/bundle';
+import * as Wire from '@dreamboard/reducer-contract/wire';
+import { PluginStateSnapshot } from '@dreamboard/ui-sdk/reducer';
+import { RuntimeAPI, PluginSessionState, ValidationResult } from '@dreamboard/ui-sdk';
+
+type TestRunner = "reducer" | "embedded" | "browser";
+type InteractionDescriptorLike = {
+    interactionId?: string;
+    surface?: string;
+    kind?: string;
+    available?: boolean;
+    unavailableReason?: string;
+    context?: {
+        to?: string;
+    };
+} & Record<string, unknown>;
+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;
+    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;
+    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>;
+        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[];
+    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 CreateExpectApiOptions = {
+    matchSnapshot?: SnapshotMatcherHandler;
+};
+declare function createExpectApi(options?: CreateExpectApiOptions): ExpectFn;
+
+type ReducerBundleLike = Pick<ReducerBundleContract, "projectSeatsDynamic" | "projectStatic" | "validateInput" | "dispatch">;
+type BaseStateArtifact = {
+    snapshot: Wire.ReducerSessionState;
+    fingerprint: {
+        players: number;
+    };
+};
+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>;
+};
+type CreatedTestRuntime = {
+    runtime: RuntimeAPI & {
+        getSnapshot(): PluginStateSnapshot;
+        subscribeToState(listener: (state: PluginStateSnapshot) => void): () => void;
+        _subscribeToSessionState(listener: (state: PluginSessionState) => void): () => void;
+    };
+    getSnapshot(): PluginStateSnapshot;
+    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>;
+    setControllingPlayer(playerId: string): void;
+};
+declare function createTestRuntime(options: CreateTestRuntimeOptions): CreatedTestRuntime;
+
+export { type BaseContext, type BaseDefinition, type CreateTestRuntimeOptions, type CreatedTestRuntime, type ExpectFn, type ExpectMatchers, type InteractionDescriptorLike, type RejectionExpectation, type ScenarioDefinition, type SharedScenarioContext, type SnapshotMatcherHandler, type TestRunner, createExpectApi, createTestRuntime, defineBase, defineScenario };