dreamboard 0.1.7 → 0.1.9

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

@@ -1,206 +1,50 @@
-# dreamboard
+# Dreamboard CLI
 
-Dreamboard CLI for working with Dreamboard games from your own editor/tooling.
+Dreamboard CLI supports three main workflows:
 
-Dreamboard is built to take you from napkin sketch to playable prototype without the paper cuts:
-
-- Describe the game you want to make.
-- Generate the rules, components, and scaffolding.
-- Playtest instantly with a frictionless lobby and live iteration loops.
-
-The platform’s core promise is the same one described on the landing page: digital prototyping for everyone, with AI helping you move from idea to playable faster.
+- Authoring: `dreamboard sync`, `dreamboard compile`, `dreamboard pull`
+- Interactive verification: `dreamboard dev`
+- Scripted verification: `dreamboard test generate`, `dreamboard test run`
 
 ## Install
 
-Published npm package:
-
 ```bash
 npm install -g dreamboard
-```
-
-The published CLI targets Node 20+.
-
-## Why Dreamboard
-
-- `Describe`: start from theme, mechanics, and player experience instead of boilerplate setup.
-- `Generate`: Dreamboard handles the sandbox primitives like turns, hands, and structured scaffolding.
-- `Playtest`: share a live prototype instead of printing fresh paper every time a rule changes.
-- `Iterate live`: keep testing momentum by changing values and flows without resetting the whole process.
-
-## Authentication
-
-Use browser login:
-
-```bash
 dreamboard login
 ```
 
-The published CLI stores your refreshable session in:
-
-```bash
-~/.dreamboard/config.json
-```
-
-That stored session includes the refresh token the CLI needs to renew access automatically. Direct JWT injection is intentionally not part of the published CLI flow.
-
-## Source Checkout Setup
-
-For local source-checkout development, install workspace dependencies with pnpm and keep Bun available for local embedded-harness workflows:
-
-```bash
-pnpm install
-```
-
-Playwright (for `dreamboard run`):
-
-```bash
-npx playwright install
-```
-
-## Commands
-
-Create a new game:
-
-```bash
-dreamboard new my-game --description "A trick-taking card game"
-```
-
-Clone an existing game:
+## Create a game
 
 ```bash
-dreamboard clone my-game
+dreamboard new my-game --description "A short game description"
+cd my-game
 ```
 
-Sync local authored changes and regenerate scaffolded files:
+## Iterate
 
 ```bash
 dreamboard sync
-dreamboard sync --update-sdk
-```
-
-If the remote has advanced unexpectedly, reconcile authored changes explicitly with:
-
-```bash
-dreamboard pull
-```
-
-Compile the current authored head:
-
-```bash
 dreamboard compile
-dreamboard compile --skip-local-check
-```
-
-Inspect local vs remote state:
-
-```bash
-dreamboard status
-dreamboard status --json
-```
-
-Run the game locally (server-compiled UI):
-
-```bash
-dreamboard run
-dreamboard run --players 4
-dreamboard run --seed 1337
-dreamboard run --new-session
-```
-
-If no successful compile exists for the current authored state yet, `dreamboard run` will ask you to run `dreamboard compile` first.
-By default, the CLI uses `manifest.json`'s `playerConfig.minPlayers` to decide how many seats to create.
-
-`dreamboard run` now defaults to a wait-and-observe loop when no scenario is provided:
-
-1. Reuse the previous active session (`--resume` defaults to true) unless `--new-session` is set.
-2. Subscribe to session SSE events.
-3. Exit when `YOUR_TURN` (default `--until`) or `GAME_ENDED` is received.
-4. Persist artifacts in `.dreamboard/run/`:
-   - `session.json`
-   - `events.ndjson`
-   - `latest-your-turn.json`
-   - `last-run-summary.json`
-
-`dreamboard run` is deterministic-by-default for new sessions: if `--seed` is not provided, it uses `1337`.
-
-Useful flags:
-
-- `--until YOUR_TURN|GAME_ENDED|ANY`
-- `--observe-events turns|all` (default `turns`; persist `YOUR_TURN` and `ACTION_REJECTED` messages)
-- `--seed <int>` (deterministic RNG seed for new sessions, default `1337`)
-- `--timeout-ms <ms>`
-- `--max-events <count>`
-- `--screenshot` (capture one Playwright screenshot for the selected run session)
-- `--output <path>`
-- `--delay <ms>`
-- `--width <px>`
-- `--height <px>`
-- `--scenario-driver api|ui` (default `api`)
-
-Playwright launch is now optional:
-
-1. It is launched when `--scenario-driver ui` is used.
-2. It is launched when `--screenshot` is used.
-3. Default API scenarios (`--scenario` with `--scenario-driver api`) do not require Playwright.
-4. Pure observe runs (`dreamboard run` without scenario/screenshot) do not require a browser session.
-
-## Scenario Files
-
-`dreamboard run --scenario <file>` supports scenario JSON (API driver by default):
-
-```json
-{
-  "steps": [
-    {
-      "playerId": "player-1",
-      "actionType": "playCard",
-      "parameters": { "cardId": "hearts-7" },
-      "turns": 1
-    },
-    {
-      "playerId": "player-1",
-      "actionType": "endTurn",
-      "parameters": {},
-      "turns": 1
-    }
-  ]
-}
-```
-
-`playerId` is required on every scenario step. The CLI executes all steps in order per invocation:
-
-```bash
-dreamboard run
-dreamboard run --scenario path/to/scenario.json
-dreamboard run --scenario path/to/scenario.json --scenario-driver ui
+dreamboard dev
 ```
 
-If there is no current `.dreamboard/run/latest-your-turn.json` for the active session (for example with `--new-session`), `dreamboard run --scenario ...` first observes SSE until it receives the initial `YOUR_TURN`, then starts executing scenario steps.
-
-API-driven scenarios are strict per step: after each `submitAction`, the CLI waits for either `ACTION_EXECUTED` or `ACTION_REJECTED`. On rejection, it stops immediately with `stopReason=scenario_rejected`.
-
-Screenshots are saved to `.dreamboard/screenshots/` by default. The CLI captures the same session selected by `--resume` / `--new-session`.
+`dreamboard dev` starts the local iframe host for the current project while gameplay continues on the backend.
 
-To capture a screenshot during observe or scenario runs:
+## Test
 
 ```bash
-dreamboard run --screenshot
-dreamboard run --scenario path/to/scenario.json --screenshot
-dreamboard run --screenshot --output ./shot.png --delay 1500 --width 1440 --height 900
+dreamboard test generate
+dreamboard test run
+dreamboard test run --scenario test/scenarios/example.scenario.ts
 ```
 
-## Notes
+Scenario assertions must use the projection-only API from `test/testing-types.ts`:
 
-- Project state lives in `.dreamboard/project.json`.
-- Snapshots for `status` are stored in `.dreamboard/snapshot.json`.
-- Published/public CLI installs target Node 20+ and support remote workflows.
-- Published/public CLI builds are production-only; they do not support environment overrides or direct JWT injection.
-- Local embedded-harness testing remains Bun-only and requires a source checkout with local backend support.
-- Internal source-checkout builds may expose extra auth and environment helpers, but those are not part of the published CLI contract.
+- `players()`
+- `state()`
+- `view(playerId)`
+- `expect`
 
-## Skill Source
+## Scaffold ownership
 
-- Public skill source lives under `skills/dreamboard/`.
-- `dreamboard new` installs the bundled skill into `.agents/skills/dreamboard/` in the generated game project.
-- The Node helper script for run-artifact inspection is `.agents/skills/dreamboard/scripts/events-extract.mjs`.
-- Public GitHub repo for the CLI is [dreamboard-games/dreamboard-cli](https://github.com/dreamboard-games/dreamboard-cli).
+Framework-owned static scaffold files are restored by `dreamboard sync`. Generated projects no longer expose wire-format message typings.