Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f10c67a5ba | ||
|
|
9437272fe0 | ||
|
|
541e04b732 | ||
|
|
e9fd896934 | ||
|
|
29cdd19cab | ||
|
|
17cc6ed72c | ||
|
|
9d81c8ad27 | ||
|
|
7199b9d2d9 | ||
|
|
158bcf1468 | ||
|
|
fab9301b20 | ||
|
|
d653cfe489 | ||
|
|
228a2603e8 | ||
|
|
27ff8ba1ad | ||
|
|
4cfcefe6c3 | ||
|
|
8baccf3cd3 | ||
|
|
a9ca31e9bc | ||
|
|
64a1f0b8db | ||
|
|
5e5812bcaa | ||
|
|
9e09c8ae2a |
206
.claude/skills/browser-interactive-testing/SKILL.md
Normal file
206
.claude/skills/browser-interactive-testing/SKILL.md
Normal file
@@ -0,0 +1,206 @@
|
|||||||
|
---
|
||||||
|
name: browser-interactive-testing
|
||||||
|
description: >
|
||||||
|
This skill should be used when the user asks to "test a web page",
|
||||||
|
"take a screenshot of a site", "automate browser interaction",
|
||||||
|
"create a test report", "verify a page works", or mentions
|
||||||
|
rodney, showboat, headless Chrome testing, or browser automation.
|
||||||
|
version: 0.1.0
|
||||||
|
---
|
||||||
|
|
||||||
|
# Browser Interactive Testing
|
||||||
|
|
||||||
|
Test web pages interactively using **rodney** (headless Chrome automation) and document results with **showboat** (executable demo reports).
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Ensure `uv` is installed. If missing, instruct the user to run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Do NOT install rodney or showboat globally. Run them via `uvx`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvx rodney <command>
|
||||||
|
uvx showboat <command>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Rodney Quick Reference
|
||||||
|
|
||||||
|
### Start a browser session
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvx rodney start # Launch headless Chrome
|
||||||
|
uvx rodney start --show # Launch visible browser (for debugging)
|
||||||
|
uvx rodney connect host:port # Connect to existing Chrome with remote debugging
|
||||||
|
```
|
||||||
|
|
||||||
|
Use `--local` on all commands to scope the session to the current directory.
|
||||||
|
|
||||||
|
### Navigate and inspect
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvx rodney open "https://example.com"
|
||||||
|
uvx rodney waitload
|
||||||
|
uvx rodney title
|
||||||
|
uvx rodney url
|
||||||
|
uvx rodney text "h1"
|
||||||
|
uvx rodney html "#content"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Interact with elements
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvx rodney click "#submit-btn"
|
||||||
|
uvx rodney input "#email" "user@example.com"
|
||||||
|
uvx rodney select "#country" "US"
|
||||||
|
uvx rodney js "document.querySelector('#app').dataset.ready"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Assert and verify
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvx rodney assert "document.title" "My App" -m "Title must match"
|
||||||
|
uvx rodney exists ".error-banner"
|
||||||
|
uvx rodney visible "#loading-spinner"
|
||||||
|
uvx rodney count ".list-item"
|
||||||
|
```
|
||||||
|
|
||||||
|
Exit code `0` = pass, `1` = fail, `2` = error.
|
||||||
|
|
||||||
|
### Screenshots and cleanup
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvx rodney screenshot -w 1280 -h 720 page.png
|
||||||
|
uvx rodney screenshot-el "#chart" chart.png
|
||||||
|
uvx rodney stop
|
||||||
|
```
|
||||||
|
|
||||||
|
Run `uvx rodney --help` for the full command list, including tab management, navigation, waiting, accessibility tree inspection, and PDF export.
|
||||||
|
|
||||||
|
## Showboat Quick Reference
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvx showboat init report.md "Test Report Title"
|
||||||
|
uvx showboat note report.md "Description of what we are testing."
|
||||||
|
uvx showboat exec report.md bash "uvx rodney title --local"
|
||||||
|
uvx showboat image report.md ''
|
||||||
|
uvx showboat pop report.md # Remove last entry (fix mistakes)
|
||||||
|
uvx showboat verify report.md # Re-run all code blocks and diff
|
||||||
|
uvx showboat extract report.md # Print commands that recreate the document
|
||||||
|
```
|
||||||
|
|
||||||
|
Run `uvx showboat --help` for details on `--workdir`, `--output`, `--filename`, and stdin piping.
|
||||||
|
|
||||||
|
## Output Directory
|
||||||
|
|
||||||
|
Save all reports under `.agent-tests/` in the project root:
|
||||||
|
|
||||||
|
```
|
||||||
|
.agent-tests/
|
||||||
|
└── YYYY-MM-DD-<slug>/
|
||||||
|
├── report.md
|
||||||
|
└── screenshots/
|
||||||
|
```
|
||||||
|
|
||||||
|
Derive the slug from the test subject (e.g., `login-flow`, `homepage-layout`). Keep it lowercase, hyphen-separated, max ~30 chars. If a directory with the same date and slug already exists, append a numeric suffix (e.g., `tetris-game-2`) or choose a more specific slug (e.g., `tetris-controls` instead of reusing `tetris-game`).
|
||||||
|
|
||||||
|
### Setup Script
|
||||||
|
|
||||||
|
Run the bundled `scripts/setup.py` to create the directory, init the report, start the browser, and capture `DIR` in one step. Replace `<SKILL_DIR>` with the actual path to the directory containing this skill's files:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
DIR=$(python3 <SKILL_DIR>/scripts/setup.py "<slug>" "<Report Title>")
|
||||||
|
```
|
||||||
|
|
||||||
|
This single command:
|
||||||
|
1. Creates `.agent-tests/YYYY-MM-DD-<slug>/screenshots/`
|
||||||
|
2. Adds `.rodney/` to `.gitignore` (if `.gitignore` exists)
|
||||||
|
3. Runs `showboat init` for the report
|
||||||
|
4. Starts a browser (connects to existing, launches system Chrome/Chromium, or falls back to rodney's built-in launcher)
|
||||||
|
5. Prints the directory path to stdout (all status messages go to stderr)
|
||||||
|
|
||||||
|
After setup, `$DIR` is ready for use with all subsequent commands.
|
||||||
|
|
||||||
|
**Important:** The `--local` flag stores session data in `.rodney/` relative to the current working directory. Do NOT `cd` to a different directory during the session, or rodney will lose the connection. Use absolute paths for file arguments instead.
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
|
||||||
|
1. **Setup** — Run the setup script to create the dir, init the report, start the browser, and set `$DIR`
|
||||||
|
2. **Describe the test** — `uvx showboat note "$DIR/report.md" "Testing [subject] for [goals]."` so the report has context up front
|
||||||
|
3. **Open page** — `uvx showboat exec "$DIR/report.md" bash "uvx rodney open --local 'URL' && uvx rodney waitload --local"`
|
||||||
|
4. **Add a note** before each test group — Use a heading followed by a short explanation of what the tests in this section verify and why it matters. Use unique section titles; avoid duplicating headings within the same report.
|
||||||
|
```bash
|
||||||
|
uvx showboat note "$DIR/report.md" "## Keyboard Controls"
|
||||||
|
uvx showboat note "$DIR/report.md" "Verify arrow keys move and rotate the active piece, and that soft/hard drop work correctly."
|
||||||
|
```
|
||||||
|
5. **Run assertions** — Before each assertion, add a short `showboat note` explaining what it checks. Then wrap the `rodney assert` / `rodney js` call in `showboat exec`:
|
||||||
|
```bash
|
||||||
|
uvx showboat note "$DIR/report.md" "The left arrow key should move the piece one cell to the left."
|
||||||
|
uvx showboat exec "$DIR/report.md" bash "uvx rodney assert --local '...' '...' -m 'Piece moved left'"
|
||||||
|
```
|
||||||
|
6. **Capture screenshots** — Take the screenshot with `rodney screenshot`, then embed with `showboat image`. **Important:** `showboat image` resolves image paths relative to the current working directory, NOT relative to the report file. Always use absolute paths (`$DIR/screenshots/...`) in the markdown image reference to avoid "image file not found" errors:
|
||||||
|
```bash
|
||||||
|
uvx rodney screenshot --local -w 1280 -h 720 "$DIR/screenshots/01-initial-load.png"
|
||||||
|
uvx showboat image "$DIR/report.md" ""
|
||||||
|
```
|
||||||
|
Number screenshots sequentially (`01-`, `02-`, ...) and use descriptive filenames.
|
||||||
|
7. **Pop on failure** — If a command fails, run `showboat pop` then retry
|
||||||
|
8. **Stop browser** — `uvx rodney stop --local`
|
||||||
|
9. **Write summary** — Add a final `showboat note` with a summary section listing all pass/fail results and any bugs found. Every report must end with a summary.
|
||||||
|
10. **Verify report** — `uvx showboat verify "$DIR/report.md"`
|
||||||
|
|
||||||
|
### Best Practices
|
||||||
|
|
||||||
|
- Use `uvx rodney waitload` or `uvx rodney wait <selector>` before interacting with page content.
|
||||||
|
- Run `uvx showboat pop` immediately after a failed `exec` to keep the report clean.
|
||||||
|
- Prefer `rodney assert` for checks — clear exit codes and self-documenting output.
|
||||||
|
- Use `rodney js` only for complex checks or state manipulation that `assert` cannot express.
|
||||||
|
- Take screenshots at key stages (initial load, after interaction, error states) for visual evidence.
|
||||||
|
- Add a `showboat note` before each logical group of tests with a heading and a short explanation of what the section tests. Use unique heading titles — duplicate headings make the report confusing.
|
||||||
|
- Always end reports with a summary `showboat note` listing pass/fail results and any bugs found. This is required, not optional.
|
||||||
|
|
||||||
|
## Quoting Rules for `rodney js`
|
||||||
|
|
||||||
|
`rodney js` evaluates a single JS **expression** (not statements). Nested shell quoting with `showboat exec` causes most errors. Follow these rules strictly:
|
||||||
|
|
||||||
|
1. **Wrap multi-statement JS in an IIFE** — bare `const`, `let`, `for` fail at top level:
|
||||||
|
```bash
|
||||||
|
# WRONG
|
||||||
|
uvx rodney js --local 'const x = 1; x + 2'
|
||||||
|
# CORRECT
|
||||||
|
uvx rodney js --local '(function(){ var x = 1; return x + 2; })()'
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Use `var` instead of `const`/`let`** inside IIFEs to avoid strict-mode eval scoping issues.
|
||||||
|
|
||||||
|
3. **Direct `rodney js` calls** — use single quotes for the outer shell, double quotes inside JS:
|
||||||
|
```bash
|
||||||
|
uvx rodney js --local '(function(){ var el = document.querySelector("#app"); return el.textContent; })()'
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **Inside `showboat exec`** — use a heredoc with a **quoted delimiter** (`<<'JSEOF'`) to prevent all shell expansion (`$`, backticks, etc.):
|
||||||
|
```bash
|
||||||
|
uvx showboat exec "$DIR/report.md" bash "$(cat <<'JSEOF'
|
||||||
|
uvx rodney js --local '
|
||||||
|
(function(){
|
||||||
|
var x = score;
|
||||||
|
hardDrop();
|
||||||
|
return "before:" + x + ",after:" + score;
|
||||||
|
})()
|
||||||
|
'
|
||||||
|
JSEOF
|
||||||
|
)"
|
||||||
|
```
|
||||||
|
For simple one-liners, single quotes inside the double-quoted bash arg also work:
|
||||||
|
```bash
|
||||||
|
uvx showboat exec "$DIR/report.md" bash "uvx rodney js --local '(function(){ return String(score); })()'"
|
||||||
|
```
|
||||||
|
|
||||||
|
5. **Avoid without heredoc**: backticks, `$` signs, unescaped double quotes. The heredoc pattern avoids all of these.
|
||||||
|
|
||||||
|
6. **Prefer `rodney assert` over `rodney js`** when possible — separate arguments avoid quoting entirely.
|
||||||
|
|
||||||
|
7. **Pop after syntax errors** — always `showboat pop` before retrying to keep the report clean.
|
||||||
160
.claude/skills/browser-interactive-testing/scripts/setup.py
Normal file
160
.claude/skills/browser-interactive-testing/scripts/setup.py
Normal file
@@ -0,0 +1,160 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Set up a browser-interactive-testing session.
|
||||||
|
|
||||||
|
Creates the output directory, inits the showboat report, starts a browser,
|
||||||
|
and prints the DIR path. Automatically detects whether rodney can launch
|
||||||
|
its own Chromium or falls back to a system-installed browser.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import datetime
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import socket
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
|
REMOTE_DEBUG_PORT = 9222
|
||||||
|
|
||||||
|
|
||||||
|
def find_system_browser():
|
||||||
|
"""Return the path to a system Chrome/Chromium binary, or None."""
|
||||||
|
for name in ["chromium", "chromium-browser", "google-chrome", "google-chrome-stable"]:
|
||||||
|
path = shutil.which(name)
|
||||||
|
if path:
|
||||||
|
return path
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def port_listening(port):
|
||||||
|
"""Check if something is already listening on the given port."""
|
||||||
|
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
|
||||||
|
s.settimeout(1)
|
||||||
|
return s.connect_ex(("localhost", port)) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def try_connect(port):
|
||||||
|
"""Try to connect rodney to a browser on the given port. Returns True on success."""
|
||||||
|
result = subprocess.run(
|
||||||
|
["uvx", "rodney", "connect", "--local", f"localhost:{port}"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
if result.returncode == 0:
|
||||||
|
print(f"Connected to existing browser on port {port}", file=sys.stderr)
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def launch_system_browser(browser_path):
|
||||||
|
"""Launch a system browser with remote debugging and wait for it to be ready."""
|
||||||
|
subprocess.Popen(
|
||||||
|
[
|
||||||
|
browser_path,
|
||||||
|
"--headless",
|
||||||
|
"--disable-gpu",
|
||||||
|
f"--remote-debugging-port={REMOTE_DEBUG_PORT}",
|
||||||
|
"--no-sandbox",
|
||||||
|
],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
)
|
||||||
|
# Wait for the browser to start listening
|
||||||
|
for _ in range(20):
|
||||||
|
if port_listening(REMOTE_DEBUG_PORT):
|
||||||
|
return True
|
||||||
|
time.sleep(0.25)
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def start_browser():
|
||||||
|
"""Start a headless browser and connect rodney to it.
|
||||||
|
|
||||||
|
Strategy order (fastest path first):
|
||||||
|
1. Connect to an already-running browser on the debug port.
|
||||||
|
2. Launch a system Chrome/Chromium (avoids rodney's Chromium download,
|
||||||
|
which fails on some architectures like Linux ARM64).
|
||||||
|
3. Let rodney launch its own browser as a last resort.
|
||||||
|
"""
|
||||||
|
# Strategy 1: connect to an already-running browser
|
||||||
|
if port_listening(REMOTE_DEBUG_PORT) and try_connect(REMOTE_DEBUG_PORT):
|
||||||
|
return
|
||||||
|
|
||||||
|
# Strategy 2: launch a system browser (most reliable on Linux)
|
||||||
|
browser = find_system_browser()
|
||||||
|
if browser:
|
||||||
|
print(f"Launching system browser: {browser}", file=sys.stderr)
|
||||||
|
if launch_system_browser(browser):
|
||||||
|
if try_connect(REMOTE_DEBUG_PORT):
|
||||||
|
return
|
||||||
|
print("WARNING: system browser started but rodney could not connect", file=sys.stderr)
|
||||||
|
else:
|
||||||
|
print("WARNING: system browser did not start in time", file=sys.stderr)
|
||||||
|
|
||||||
|
# Strategy 3: let rodney try its built-in launcher
|
||||||
|
result = subprocess.run(
|
||||||
|
["uvx", "rodney", "start", "--local"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
if result.returncode == 0:
|
||||||
|
print("Browser started via rodney", file=sys.stderr)
|
||||||
|
return
|
||||||
|
|
||||||
|
print(
|
||||||
|
"ERROR: Could not start a browser. Tried:\n"
|
||||||
|
f" - Connecting to localhost:{REMOTE_DEBUG_PORT} (no browser found)\n"
|
||||||
|
f" - System browser: {browser or 'not found'}\n"
|
||||||
|
" - rodney start (failed)\n"
|
||||||
|
"Install chromium or google-chrome and try again.",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_gitignore_entry(entry):
|
||||||
|
"""Add entry to .gitignore if the file exists and the entry is missing."""
|
||||||
|
gitignore = ".gitignore"
|
||||||
|
if not os.path.isfile(gitignore):
|
||||||
|
return
|
||||||
|
with open(gitignore, "r") as f:
|
||||||
|
content = f.read()
|
||||||
|
# Check if the entry (with or without trailing slash/newline variations) is already present
|
||||||
|
lines = content.splitlines()
|
||||||
|
if any(line.strip() == entry or line.strip() == entry.rstrip("/") for line in lines):
|
||||||
|
return
|
||||||
|
# Append the entry
|
||||||
|
with open(gitignore, "a") as f:
|
||||||
|
if content and not content.endswith("\n"):
|
||||||
|
f.write("\n")
|
||||||
|
f.write(f"{entry}\n")
|
||||||
|
print(f"Added '{entry}' to .gitignore", file=sys.stderr)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
if len(sys.argv) < 3:
|
||||||
|
print(f"Usage: {sys.argv[0]} <slug> <report-title>", file=sys.stderr)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
slug = sys.argv[1]
|
||||||
|
title = sys.argv[2]
|
||||||
|
|
||||||
|
# Create output directory
|
||||||
|
d = f".agent-tests/{datetime.date.today()}-{slug}"
|
||||||
|
os.makedirs(f"{d}/screenshots", exist_ok=True)
|
||||||
|
|
||||||
|
# Ensure .rodney/ is in .gitignore (rodney stores session files there)
|
||||||
|
ensure_gitignore_entry(".rodney/")
|
||||||
|
|
||||||
|
# Init showboat report
|
||||||
|
subprocess.run(["uvx", "showboat", "init", f"{d}/report.md", title], check=True)
|
||||||
|
|
||||||
|
# Start browser
|
||||||
|
start_browser()
|
||||||
|
|
||||||
|
# Print the directory path (only real stdout, everything else goes to stderr)
|
||||||
|
print(d)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -12,3 +12,4 @@ Thumbs.db
|
|||||||
coverage/
|
coverage/
|
||||||
*.tsbuildinfo
|
*.tsbuildinfo
|
||||||
docs/agents/plans/
|
docs/agents/plans/
|
||||||
|
.rodney/
|
||||||
|
|||||||
@@ -125,9 +125,3 @@ The constitution (`.specify/memory/constitution.md`) governs all feature work:
|
|||||||
4. **MVP Baseline** — Say "MVP baseline does not include X", never permanent bans.
|
4. **MVP Baseline** — Say "MVP baseline does not include X", never permanent bans.
|
||||||
5. **Spec-driven features** — Features are described in living specs; evolve existing specs via `/integrate-issue`, create new ones via `/speckit.specify`. Bug fixes and tooling changes do not require specs.
|
5. **Spec-driven features** — Features are described in living specs; evolve existing specs via `/integrate-issue`, create new ones via `/speckit.specify`. Bug fixes and tooling changes do not require specs.
|
||||||
|
|
||||||
## Active Technologies
|
|
||||||
- TypeScript 5.8 (strict mode, `verbatimModuleSyntax`) + React 19, Vite 6, Tailwind CSS v4, Lucide Reac (005-player-characters)
|
|
||||||
- localStorage (new key `"initiative:player-characters"`) (005-player-characters)
|
|
||||||
|
|
||||||
## Recent Changes
|
|
||||||
- 005-player-characters: Added TypeScript 5.8 (strict mode, `verbatimModuleSyntax`) + React 19, Vite 6, Tailwind CSS v4, Lucide Reac
|
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ A local-first initiative tracker and encounter manager for tabletop RPGs (D&D 5e
|
|||||||
- **Encounter state** — HP, AC, conditions, concentration tracking with visual status indicators
|
- **Encounter state** — HP, AC, conditions, concentration tracking with visual status indicators
|
||||||
- **Bestiary integration** — import bestiary JSON sources, search creatures, and view full stat blocks
|
- **Bestiary integration** — import bestiary JSON sources, search creatures, and view full stat blocks
|
||||||
- **Player characters** — create reusable player character templates with name, AC, HP, color, and icon; search and add them to encounters with pre-filled stats; manage (edit/delete) from a dedicated panel
|
- **Player characters** — create reusable player character templates with name, AC, HP, color, and icon; search and add them to encounters with pre-filled stats; manage (edit/delete) from a dedicated panel
|
||||||
|
- **Undo/redo** — reverse any encounter action with Undo/Redo buttons or keyboard shortcuts (Ctrl+Z / Ctrl+Shift+Z, Cmd on Mac); history persists across page reloads
|
||||||
- **Persistent** — encounters survive page reloads via localStorage; bestiary data cached in IndexedDB; player characters stored independently
|
- **Persistent** — encounters survive page reloads via localStorage; bestiary data cached in IndexedDB; player characters stored independently
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="UTF-8" />
|
<meta charset="UTF-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover" />
|
||||||
<meta name="theme-color" content="#0e1a2e" />
|
<meta name="theme-color" content="#0e1a2e" />
|
||||||
<link rel="manifest" href="/manifest.json" />
|
<link rel="manifest" href="/manifest.json" />
|
||||||
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
|
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
|
||||||
|
|||||||
@@ -30,6 +30,13 @@ export function App() {
|
|||||||
const activeRowRef = useRef<HTMLDivElement>(null);
|
const activeRowRef = useRef<HTMLDivElement>(null);
|
||||||
const actionBarAnim = useActionBarAnimation(encounter.combatants.length);
|
const actionBarAnim = useActionBarAnimation(encounter.combatants.length);
|
||||||
|
|
||||||
|
// Close the side panel when the encounter becomes empty
|
||||||
|
useEffect(() => {
|
||||||
|
if (isEmpty) {
|
||||||
|
sidePanel.dismissPanel();
|
||||||
|
}
|
||||||
|
}, [isEmpty, sidePanel.dismissPanel]);
|
||||||
|
|
||||||
// Auto-scroll to active combatant when turn changes
|
// Auto-scroll to active combatant when turn changes
|
||||||
const activeIndex = encounter.activeIndex;
|
const activeIndex = encounter.activeIndex;
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
@@ -46,7 +53,10 @@ export function App() {
|
|||||||
<div className="relative mx-auto flex min-h-0 w-full flex-1 flex-col gap-3 sm:max-w-2xl sm:px-4">
|
<div className="relative mx-auto flex min-h-0 w-full flex-1 flex-col gap-3 sm:max-w-2xl sm:px-4">
|
||||||
{!!actionBarAnim.showTopBar && (
|
{!!actionBarAnim.showTopBar && (
|
||||||
<div
|
<div
|
||||||
className={cn("shrink-0 sm:pt-8", actionBarAnim.topBarClass)}
|
className={cn(
|
||||||
|
"shrink-0 pt-[env(safe-area-inset-top)] sm:pt-[max(env(safe-area-inset-top),2rem)]",
|
||||||
|
actionBarAnim.topBarClass,
|
||||||
|
)}
|
||||||
onAnimationEnd={actionBarAnim.onTopBarExitEnd}
|
onAnimationEnd={actionBarAnim.onTopBarExitEnd}
|
||||||
>
|
>
|
||||||
<TurnNavigation />
|
<TurnNavigation />
|
||||||
@@ -85,7 +95,10 @@ export function App() {
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div
|
<div
|
||||||
className={cn("shrink-0 sm:pb-8", actionBarAnim.settlingClass)}
|
className={cn(
|
||||||
|
"shrink-0 pb-[env(safe-area-inset-bottom)] sm:pb-[max(env(safe-area-inset-bottom),2rem)]",
|
||||||
|
actionBarAnim.settlingClass,
|
||||||
|
)}
|
||||||
onAnimationEnd={actionBarAnim.onSettleEnd}
|
onAnimationEnd={actionBarAnim.onSettleEnd}
|
||||||
>
|
>
|
||||||
<ActionBar
|
<ActionBar
|
||||||
|
|||||||
@@ -52,8 +52,14 @@ function mockContext(overrides: Partial<Encounter> = {}) {
|
|||||||
toggleCondition: vi.fn(),
|
toggleCondition: vi.fn(),
|
||||||
toggleConcentration: vi.fn(),
|
toggleConcentration: vi.fn(),
|
||||||
addFromBestiary: vi.fn(),
|
addFromBestiary: vi.fn(),
|
||||||
|
addMultipleFromBestiary: vi.fn(),
|
||||||
addFromPlayerCharacter: vi.fn(),
|
addFromPlayerCharacter: vi.fn(),
|
||||||
makeStore: vi.fn(),
|
makeStore: vi.fn(),
|
||||||
|
withUndo: vi.fn((action: () => unknown) => action()),
|
||||||
|
undo: vi.fn(),
|
||||||
|
redo: vi.fn(),
|
||||||
|
canUndo: false,
|
||||||
|
canRedo: false,
|
||||||
events: [],
|
events: [],
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import type { CreatureId, PlayerCharacter } from "@initiative/domain";
|
import type { PlayerCharacter } from "@initiative/domain";
|
||||||
import {
|
import {
|
||||||
Check,
|
Check,
|
||||||
Eye,
|
Eye,
|
||||||
@@ -10,19 +10,17 @@ import {
|
|||||||
Settings,
|
Settings,
|
||||||
Users,
|
Users,
|
||||||
} from "lucide-react";
|
} from "lucide-react";
|
||||||
import React, {
|
import React, { type RefObject, useCallback, useState } from "react";
|
||||||
type RefObject,
|
|
||||||
useCallback,
|
|
||||||
useDeferredValue,
|
|
||||||
useState,
|
|
||||||
} from "react";
|
|
||||||
import type { SearchResult } from "../contexts/bestiary-context.js";
|
import type { SearchResult } from "../contexts/bestiary-context.js";
|
||||||
import { useBestiaryContext } from "../contexts/bestiary-context.js";
|
|
||||||
import { useBulkImportContext } from "../contexts/bulk-import-context.js";
|
import { useBulkImportContext } from "../contexts/bulk-import-context.js";
|
||||||
import { useEncounterContext } from "../contexts/encounter-context.js";
|
import { useEncounterContext } from "../contexts/encounter-context.js";
|
||||||
import { useInitiativeRollsContext } from "../contexts/initiative-rolls-context.js";
|
import { useInitiativeRollsContext } from "../contexts/initiative-rolls-context.js";
|
||||||
import { usePlayerCharactersContext } from "../contexts/player-characters-context.js";
|
import {
|
||||||
import { useSidePanelContext } from "../contexts/side-panel-context.js";
|
creatureKey,
|
||||||
|
type QueuedCreature,
|
||||||
|
type SuggestionActions,
|
||||||
|
useActionBarState,
|
||||||
|
} from "../hooks/use-action-bar-state.js";
|
||||||
import { useLongPress } from "../hooks/use-long-press.js";
|
import { useLongPress } from "../hooks/use-long-press.js";
|
||||||
import { cn } from "../lib/utils.js";
|
import { cn } from "../lib/utils.js";
|
||||||
import { D20Icon } from "./d20-icon.js";
|
import { D20Icon } from "./d20-icon.js";
|
||||||
@@ -32,11 +30,6 @@ import { Button } from "./ui/button.js";
|
|||||||
import { Input } from "./ui/input.js";
|
import { Input } from "./ui/input.js";
|
||||||
import { OverflowMenu, type OverflowMenuItem } from "./ui/overflow-menu.js";
|
import { OverflowMenu, type OverflowMenuItem } from "./ui/overflow-menu.js";
|
||||||
|
|
||||||
interface QueuedCreature {
|
|
||||||
result: SearchResult;
|
|
||||||
count: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface ActionBarProps {
|
interface ActionBarProps {
|
||||||
inputRef?: RefObject<HTMLInputElement | null>;
|
inputRef?: RefObject<HTMLInputElement | null>;
|
||||||
autoFocus?: boolean;
|
autoFocus?: boolean;
|
||||||
@@ -44,8 +37,13 @@ interface ActionBarProps {
|
|||||||
onOpenSettings?: () => void;
|
onOpenSettings?: () => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
function creatureKey(r: SearchResult): string {
|
interface AddModeSuggestionsProps {
|
||||||
return `${r.source}:${r.name}`;
|
nameInput: string;
|
||||||
|
suggestions: SearchResult[];
|
||||||
|
pcMatches: PlayerCharacter[];
|
||||||
|
suggestionIndex: number;
|
||||||
|
queued: QueuedCreature | null;
|
||||||
|
actions: SuggestionActions;
|
||||||
}
|
}
|
||||||
|
|
||||||
function AddModeSuggestions({
|
function AddModeSuggestions({
|
||||||
@@ -54,34 +52,15 @@ function AddModeSuggestions({
|
|||||||
pcMatches,
|
pcMatches,
|
||||||
suggestionIndex,
|
suggestionIndex,
|
||||||
queued,
|
queued,
|
||||||
onDismiss,
|
actions,
|
||||||
onClickSuggestion,
|
}: Readonly<AddModeSuggestionsProps>) {
|
||||||
onSetSuggestionIndex,
|
|
||||||
onSetQueued,
|
|
||||||
onConfirmQueued,
|
|
||||||
onAddFromPlayerCharacter,
|
|
||||||
onClear,
|
|
||||||
}: Readonly<{
|
|
||||||
nameInput: string;
|
|
||||||
suggestions: SearchResult[];
|
|
||||||
pcMatches: PlayerCharacter[];
|
|
||||||
suggestionIndex: number;
|
|
||||||
queued: QueuedCreature | null;
|
|
||||||
onDismiss: () => void;
|
|
||||||
onClear: () => void;
|
|
||||||
onClickSuggestion: (result: SearchResult) => void;
|
|
||||||
onSetSuggestionIndex: (i: number) => void;
|
|
||||||
onSetQueued: (q: QueuedCreature | null) => void;
|
|
||||||
onConfirmQueued: () => void;
|
|
||||||
onAddFromPlayerCharacter?: (pc: PlayerCharacter) => void;
|
|
||||||
}>) {
|
|
||||||
return (
|
return (
|
||||||
<div className="card-glow absolute bottom-full z-50 mb-1 w-full max-w-xs rounded-lg border border-border bg-card">
|
<div className="card-glow absolute bottom-full z-50 mb-1 w-full max-w-xs rounded-lg border border-border bg-card">
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
className="flex w-full items-center gap-1.5 border-border border-b px-3 py-2 text-left text-accent text-sm hover:bg-accent/20"
|
className="flex w-full items-center gap-1.5 border-border border-b px-3 py-2 text-left text-accent text-sm hover:bg-accent/20"
|
||||||
onMouseDown={(e) => e.preventDefault()}
|
onMouseDown={(e) => e.preventDefault()}
|
||||||
onClick={onDismiss}
|
onClick={actions.dismiss}
|
||||||
>
|
>
|
||||||
<Plus className="h-3.5 w-3.5" />
|
<Plus className="h-3.5 w-3.5" />
|
||||||
<span className="flex-1">Add "{nameInput}" as custom</span>
|
<span className="flex-1">Add "{nameInput}" as custom</span>
|
||||||
@@ -108,8 +87,8 @@ function AddModeSuggestions({
|
|||||||
className="flex w-full items-center gap-2 px-3 py-1.5 text-left text-foreground text-sm hover:bg-hover-neutral-bg"
|
className="flex w-full items-center gap-2 px-3 py-1.5 text-left text-foreground text-sm hover:bg-hover-neutral-bg"
|
||||||
onMouseDown={(e) => e.preventDefault()}
|
onMouseDown={(e) => e.preventDefault()}
|
||||||
onClick={() => {
|
onClick={() => {
|
||||||
onAddFromPlayerCharacter?.(pc);
|
actions.addFromPlayerCharacter?.(pc);
|
||||||
onClear();
|
actions.clear();
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
{!!PcIcon && (
|
{!!PcIcon && (
|
||||||
@@ -145,8 +124,8 @@ function AddModeSuggestions({
|
|||||||
"hover:bg-hover-neutral-bg",
|
"hover:bg-hover-neutral-bg",
|
||||||
)}
|
)}
|
||||||
onMouseDown={(e) => e.preventDefault()}
|
onMouseDown={(e) => e.preventDefault()}
|
||||||
onClick={() => onClickSuggestion(result)}
|
onClick={() => actions.clickSuggestion(result)}
|
||||||
onMouseEnter={() => onSetSuggestionIndex(i)}
|
onMouseEnter={() => actions.setSuggestionIndex(i)}
|
||||||
>
|
>
|
||||||
<span>{result.name}</span>
|
<span>{result.name}</span>
|
||||||
<span className="flex items-center gap-1 text-muted-foreground text-xs">
|
<span className="flex items-center gap-1 text-muted-foreground text-xs">
|
||||||
@@ -159,9 +138,9 @@ function AddModeSuggestions({
|
|||||||
onClick={(e) => {
|
onClick={(e) => {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
if (queued.count <= 1) {
|
if (queued.count <= 1) {
|
||||||
onSetQueued(null);
|
actions.setQueued(null);
|
||||||
} else {
|
} else {
|
||||||
onSetQueued({
|
actions.setQueued({
|
||||||
...queued,
|
...queued,
|
||||||
count: queued.count - 1,
|
count: queued.count - 1,
|
||||||
});
|
});
|
||||||
@@ -179,7 +158,7 @@ function AddModeSuggestions({
|
|||||||
onMouseDown={(e) => e.preventDefault()}
|
onMouseDown={(e) => e.preventDefault()}
|
||||||
onClick={(e) => {
|
onClick={(e) => {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
onSetQueued({
|
actions.setQueued({
|
||||||
...queued,
|
...queued,
|
||||||
count: queued.count + 1,
|
count: queued.count + 1,
|
||||||
});
|
});
|
||||||
@@ -193,7 +172,7 @@ function AddModeSuggestions({
|
|||||||
onMouseDown={(e) => e.preventDefault()}
|
onMouseDown={(e) => e.preventDefault()}
|
||||||
onClick={(e) => {
|
onClick={(e) => {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
onConfirmQueued();
|
actions.confirmQueued();
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
<Check className="h-3.5 w-3.5" />
|
<Check className="h-3.5 w-3.5" />
|
||||||
@@ -214,6 +193,152 @@ function AddModeSuggestions({
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
interface BrowseSuggestionsProps {
|
||||||
|
suggestions: SearchResult[];
|
||||||
|
suggestionIndex: number;
|
||||||
|
onSelect: (result: SearchResult) => void;
|
||||||
|
onHover: (index: number) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
function BrowseSuggestions({
|
||||||
|
suggestions,
|
||||||
|
suggestionIndex,
|
||||||
|
onSelect,
|
||||||
|
onHover,
|
||||||
|
}: Readonly<BrowseSuggestionsProps>) {
|
||||||
|
if (suggestions.length === 0) return null;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="card-glow absolute bottom-full z-50 mb-1 w-full rounded-lg border border-border bg-card">
|
||||||
|
<ul className="max-h-48 overflow-y-auto py-1">
|
||||||
|
{suggestions.map((result, i) => (
|
||||||
|
<li key={creatureKey(result)}>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={cn(
|
||||||
|
"flex w-full items-center justify-between px-3 py-1.5 text-left text-sm",
|
||||||
|
i === suggestionIndex
|
||||||
|
? "bg-accent/20 text-foreground"
|
||||||
|
: "text-foreground hover:bg-hover-neutral-bg",
|
||||||
|
)}
|
||||||
|
onMouseDown={(e) => e.preventDefault()}
|
||||||
|
onClick={() => onSelect(result)}
|
||||||
|
onMouseEnter={() => onHover(i)}
|
||||||
|
>
|
||||||
|
<span>{result.name}</span>
|
||||||
|
<span className="text-muted-foreground text-xs">
|
||||||
|
{result.sourceDisplayName}
|
||||||
|
</span>
|
||||||
|
</button>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CustomStatFieldsProps {
|
||||||
|
customInit: string;
|
||||||
|
customAc: string;
|
||||||
|
customMaxHp: string;
|
||||||
|
onInitChange: (v: string) => void;
|
||||||
|
onAcChange: (v: string) => void;
|
||||||
|
onMaxHpChange: (v: string) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
function CustomStatFields({
|
||||||
|
customInit,
|
||||||
|
customAc,
|
||||||
|
customMaxHp,
|
||||||
|
onInitChange,
|
||||||
|
onAcChange,
|
||||||
|
onMaxHpChange,
|
||||||
|
}: Readonly<CustomStatFieldsProps>) {
|
||||||
|
return (
|
||||||
|
<div className="hidden items-center gap-2 sm:flex">
|
||||||
|
<Input
|
||||||
|
type="text"
|
||||||
|
inputMode="numeric"
|
||||||
|
value={customInit}
|
||||||
|
onChange={(e) => onInitChange(e.target.value)}
|
||||||
|
placeholder="Init"
|
||||||
|
className="w-16 text-center"
|
||||||
|
/>
|
||||||
|
<Input
|
||||||
|
type="text"
|
||||||
|
inputMode="numeric"
|
||||||
|
value={customAc}
|
||||||
|
onChange={(e) => onAcChange(e.target.value)}
|
||||||
|
placeholder="AC"
|
||||||
|
className="w-16 text-center"
|
||||||
|
/>
|
||||||
|
<Input
|
||||||
|
type="text"
|
||||||
|
inputMode="numeric"
|
||||||
|
value={customMaxHp}
|
||||||
|
onChange={(e) => onMaxHpChange(e.target.value)}
|
||||||
|
placeholder="MaxHP"
|
||||||
|
className="w-18 text-center"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function RollAllButton() {
|
||||||
|
const { hasCreatureCombatants, canRollAllInitiative } = useEncounterContext();
|
||||||
|
const { handleRollAllInitiative } = useInitiativeRollsContext();
|
||||||
|
|
||||||
|
const [menuPos, setMenuPos] = useState<{
|
||||||
|
x: number;
|
||||||
|
y: number;
|
||||||
|
} | null>(null);
|
||||||
|
|
||||||
|
const openMenu = useCallback((x: number, y: number) => {
|
||||||
|
setMenuPos({ x, y });
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const longPress = useLongPress(
|
||||||
|
useCallback(
|
||||||
|
(e: React.TouchEvent) => {
|
||||||
|
const touch = e.touches[0];
|
||||||
|
if (touch) openMenu(touch.clientX, touch.clientY);
|
||||||
|
},
|
||||||
|
[openMenu],
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!hasCreatureCombatants) return null;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<Button
|
||||||
|
type="button"
|
||||||
|
size="icon"
|
||||||
|
variant="ghost"
|
||||||
|
className="text-muted-foreground hover:text-hover-action"
|
||||||
|
onClick={() => handleRollAllInitiative()}
|
||||||
|
onContextMenu={(e) => {
|
||||||
|
e.preventDefault();
|
||||||
|
openMenu(e.clientX, e.clientY);
|
||||||
|
}}
|
||||||
|
{...longPress}
|
||||||
|
disabled={!canRollAllInitiative}
|
||||||
|
title="Roll all initiative"
|
||||||
|
aria-label="Roll all initiative"
|
||||||
|
>
|
||||||
|
<D20Icon className="h-6 w-6" />
|
||||||
|
</Button>
|
||||||
|
{!!menuPos && (
|
||||||
|
<RollModeMenu
|
||||||
|
position={menuPos}
|
||||||
|
onSelect={(mode) => handleRollAllInitiative(mode)}
|
||||||
|
onClose={() => setMenuPos(null)}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
function buildOverflowItems(opts: {
|
function buildOverflowItems(opts: {
|
||||||
onManagePlayers?: () => void;
|
onManagePlayers?: () => void;
|
||||||
onOpenSourceManager?: () => void;
|
onOpenSourceManager?: () => void;
|
||||||
@@ -262,252 +387,33 @@ export function ActionBar({
|
|||||||
onOpenSettings,
|
onOpenSettings,
|
||||||
}: Readonly<ActionBarProps>) {
|
}: Readonly<ActionBarProps>) {
|
||||||
const {
|
const {
|
||||||
addCombatant,
|
nameInput,
|
||||||
addFromBestiary,
|
suggestions,
|
||||||
addFromPlayerCharacter,
|
pcMatches,
|
||||||
hasCreatureCombatants,
|
suggestionIndex,
|
||||||
canRollAllInitiative,
|
queued,
|
||||||
} = useEncounterContext();
|
customInit,
|
||||||
const { search: bestiarySearch, isLoaded: bestiaryLoaded } =
|
customAc,
|
||||||
useBestiaryContext();
|
customMaxHp,
|
||||||
const { characters: playerCharacters } = usePlayerCharactersContext();
|
browseMode,
|
||||||
const { showBulkImport, showSourceManager, showCreature, panelView } =
|
bestiaryLoaded,
|
||||||
useSidePanelContext();
|
hasSuggestions,
|
||||||
const { handleRollAllInitiative } = useInitiativeRollsContext();
|
showBulkImport,
|
||||||
|
showSourceManager,
|
||||||
|
suggestionActions,
|
||||||
|
handleNameChange,
|
||||||
|
handleKeyDown,
|
||||||
|
handleBrowseKeyDown,
|
||||||
|
handleAdd,
|
||||||
|
handleBrowseSelect,
|
||||||
|
toggleBrowseMode,
|
||||||
|
setCustomInit,
|
||||||
|
setCustomAc,
|
||||||
|
setCustomMaxHp,
|
||||||
|
} = useActionBarState();
|
||||||
|
|
||||||
const { state: bulkImportState } = useBulkImportContext();
|
const { state: bulkImportState } = useBulkImportContext();
|
||||||
|
|
||||||
const handleAddFromBestiary = useCallback(
|
|
||||||
(result: SearchResult) => {
|
|
||||||
const creatureId = addFromBestiary(result);
|
|
||||||
if (creatureId && panelView.mode === "closed") {
|
|
||||||
showCreature(creatureId);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
[addFromBestiary, panelView.mode, showCreature],
|
|
||||||
);
|
|
||||||
|
|
||||||
const handleViewStatBlock = useCallback(
|
|
||||||
(result: SearchResult) => {
|
|
||||||
const slug = result.name
|
|
||||||
.toLowerCase()
|
|
||||||
.replaceAll(/[^a-z0-9]+/g, "-")
|
|
||||||
.replaceAll(/(^-|-$)/g, "");
|
|
||||||
const cId = `${result.source.toLowerCase()}:${slug}` as CreatureId;
|
|
||||||
showCreature(cId);
|
|
||||||
},
|
|
||||||
[showCreature],
|
|
||||||
);
|
|
||||||
|
|
||||||
const [nameInput, setNameInput] = useState("");
|
|
||||||
const [suggestions, setSuggestions] = useState<SearchResult[]>([]);
|
|
||||||
const [pcMatches, setPcMatches] = useState<PlayerCharacter[]>([]);
|
|
||||||
const deferredSuggestions = useDeferredValue(suggestions);
|
|
||||||
const deferredPcMatches = useDeferredValue(pcMatches);
|
|
||||||
const [suggestionIndex, setSuggestionIndex] = useState(-1);
|
|
||||||
const [queued, setQueued] = useState<QueuedCreature | null>(null);
|
|
||||||
const [customInit, setCustomInit] = useState("");
|
|
||||||
const [customAc, setCustomAc] = useState("");
|
|
||||||
const [customMaxHp, setCustomMaxHp] = useState("");
|
|
||||||
const [browseMode, setBrowseMode] = useState(false);
|
|
||||||
|
|
||||||
const clearCustomFields = () => {
|
|
||||||
setCustomInit("");
|
|
||||||
setCustomAc("");
|
|
||||||
setCustomMaxHp("");
|
|
||||||
};
|
|
||||||
|
|
||||||
const clearInput = () => {
|
|
||||||
setNameInput("");
|
|
||||||
setSuggestions([]);
|
|
||||||
setPcMatches([]);
|
|
||||||
setQueued(null);
|
|
||||||
setSuggestionIndex(-1);
|
|
||||||
};
|
|
||||||
|
|
||||||
const dismissSuggestions = () => {
|
|
||||||
setSuggestions([]);
|
|
||||||
setPcMatches([]);
|
|
||||||
setQueued(null);
|
|
||||||
setSuggestionIndex(-1);
|
|
||||||
};
|
|
||||||
|
|
||||||
const confirmQueued = () => {
|
|
||||||
if (!queued) return;
|
|
||||||
for (let i = 0; i < queued.count; i++) {
|
|
||||||
handleAddFromBestiary(queued.result);
|
|
||||||
}
|
|
||||||
clearInput();
|
|
||||||
};
|
|
||||||
|
|
||||||
const parseNum = (v: string): number | undefined => {
|
|
||||||
if (v.trim() === "") return undefined;
|
|
||||||
const n = Number(v);
|
|
||||||
return Number.isNaN(n) ? undefined : n;
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleAdd = (e: React.SubmitEvent<HTMLFormElement>) => {
|
|
||||||
e.preventDefault();
|
|
||||||
if (browseMode) return;
|
|
||||||
if (queued) {
|
|
||||||
confirmQueued();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (nameInput.trim() === "") return;
|
|
||||||
const opts: { initiative?: number; ac?: number; maxHp?: number } = {};
|
|
||||||
const init = parseNum(customInit);
|
|
||||||
const ac = parseNum(customAc);
|
|
||||||
const maxHp = parseNum(customMaxHp);
|
|
||||||
if (init !== undefined) opts.initiative = init;
|
|
||||||
if (ac !== undefined) opts.ac = ac;
|
|
||||||
if (maxHp !== undefined) opts.maxHp = maxHp;
|
|
||||||
addCombatant(nameInput, Object.keys(opts).length > 0 ? opts : undefined);
|
|
||||||
setNameInput("");
|
|
||||||
setSuggestions([]);
|
|
||||||
setPcMatches([]);
|
|
||||||
clearCustomFields();
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleBrowseSearch = (value: string) => {
|
|
||||||
setSuggestions(value.length >= 2 ? bestiarySearch(value) : []);
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleAddSearch = (value: string) => {
|
|
||||||
let newSuggestions: SearchResult[] = [];
|
|
||||||
let newPcMatches: PlayerCharacter[] = [];
|
|
||||||
if (value.length >= 2) {
|
|
||||||
newSuggestions = bestiarySearch(value);
|
|
||||||
setSuggestions(newSuggestions);
|
|
||||||
if (playerCharacters && playerCharacters.length > 0) {
|
|
||||||
const lower = value.toLowerCase();
|
|
||||||
newPcMatches = playerCharacters.filter((pc) =>
|
|
||||||
pc.name.toLowerCase().includes(lower),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
setPcMatches(newPcMatches);
|
|
||||||
} else {
|
|
||||||
setSuggestions([]);
|
|
||||||
setPcMatches([]);
|
|
||||||
}
|
|
||||||
if (newSuggestions.length > 0 || newPcMatches.length > 0) {
|
|
||||||
clearCustomFields();
|
|
||||||
}
|
|
||||||
if (queued) {
|
|
||||||
const qKey = creatureKey(queued.result);
|
|
||||||
const stillVisible = newSuggestions.some((s) => creatureKey(s) === qKey);
|
|
||||||
if (!stillVisible) {
|
|
||||||
setQueued(null);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleNameChange = (value: string) => {
|
|
||||||
setNameInput(value);
|
|
||||||
setSuggestionIndex(-1);
|
|
||||||
if (browseMode) {
|
|
||||||
handleBrowseSearch(value);
|
|
||||||
} else {
|
|
||||||
handleAddSearch(value);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleClickSuggestion = (result: SearchResult) => {
|
|
||||||
const key = creatureKey(result);
|
|
||||||
if (queued && creatureKey(queued.result) === key) {
|
|
||||||
setQueued({ ...queued, count: queued.count + 1 });
|
|
||||||
} else {
|
|
||||||
setQueued({ result, count: 1 });
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleEnter = () => {
|
|
||||||
if (queued) {
|
|
||||||
confirmQueued();
|
|
||||||
} else if (suggestionIndex >= 0) {
|
|
||||||
handleClickSuggestion(suggestions[suggestionIndex]);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const hasSuggestions =
|
|
||||||
deferredSuggestions.length > 0 || deferredPcMatches.length > 0;
|
|
||||||
|
|
||||||
const handleKeyDown = (e: React.KeyboardEvent) => {
|
|
||||||
if (!hasSuggestions) return;
|
|
||||||
|
|
||||||
if (e.key === "ArrowDown") {
|
|
||||||
e.preventDefault();
|
|
||||||
setSuggestionIndex((i) => (i < suggestions.length - 1 ? i + 1 : 0));
|
|
||||||
} else if (e.key === "ArrowUp") {
|
|
||||||
e.preventDefault();
|
|
||||||
setSuggestionIndex((i) => (i > 0 ? i - 1 : suggestions.length - 1));
|
|
||||||
} else if (e.key === "Enter") {
|
|
||||||
e.preventDefault();
|
|
||||||
handleEnter();
|
|
||||||
} else if (e.key === "Escape") {
|
|
||||||
dismissSuggestions();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleBrowseKeyDown = (e: React.KeyboardEvent) => {
|
|
||||||
if (e.key === "Escape") {
|
|
||||||
setBrowseMode(false);
|
|
||||||
clearInput();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (suggestions.length === 0) return;
|
|
||||||
if (e.key === "ArrowDown") {
|
|
||||||
e.preventDefault();
|
|
||||||
setSuggestionIndex((i) => (i < suggestions.length - 1 ? i + 1 : 0));
|
|
||||||
} else if (e.key === "ArrowUp") {
|
|
||||||
e.preventDefault();
|
|
||||||
setSuggestionIndex((i) => (i > 0 ? i - 1 : suggestions.length - 1));
|
|
||||||
} else if (e.key === "Enter" && suggestionIndex >= 0) {
|
|
||||||
e.preventDefault();
|
|
||||||
handleViewStatBlock(suggestions[suggestionIndex]);
|
|
||||||
setBrowseMode(false);
|
|
||||||
clearInput();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleBrowseSelect = (result: SearchResult) => {
|
|
||||||
handleViewStatBlock(result);
|
|
||||||
setBrowseMode(false);
|
|
||||||
clearInput();
|
|
||||||
};
|
|
||||||
|
|
||||||
const toggleBrowseMode = () => {
|
|
||||||
setBrowseMode((prev) => {
|
|
||||||
const next = !prev;
|
|
||||||
setSuggestionIndex(-1);
|
|
||||||
setQueued(null);
|
|
||||||
if (next) {
|
|
||||||
handleBrowseSearch(nameInput);
|
|
||||||
} else {
|
|
||||||
handleAddSearch(nameInput);
|
|
||||||
}
|
|
||||||
return next;
|
|
||||||
});
|
|
||||||
clearCustomFields();
|
|
||||||
};
|
|
||||||
|
|
||||||
const [rollAllMenuPos, setRollAllMenuPos] = useState<{
|
|
||||||
x: number;
|
|
||||||
y: number;
|
|
||||||
} | null>(null);
|
|
||||||
|
|
||||||
const openRollAllMenu = useCallback((x: number, y: number) => {
|
|
||||||
setRollAllMenuPos({ x, y });
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const rollAllLongPress = useLongPress(
|
|
||||||
useCallback(
|
|
||||||
(e: React.TouchEvent) => {
|
|
||||||
const touch = e.touches[0];
|
|
||||||
if (touch) openRollAllMenu(touch.clientX, touch.clientY);
|
|
||||||
},
|
|
||||||
[openRollAllMenu],
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
const overflowItems = buildOverflowItems({
|
const overflowItems = buildOverflowItems({
|
||||||
onManagePlayers,
|
onManagePlayers,
|
||||||
onOpenSourceManager: showSourceManager,
|
onOpenSourceManager: showSourceManager,
|
||||||
@@ -521,7 +427,7 @@ export function ActionBar({
|
|||||||
<div className="card-glow flex items-center gap-3 border-border border-t bg-card px-4 py-3 sm:rounded-lg sm:border">
|
<div className="card-glow flex items-center gap-3 border-border border-t bg-card px-4 py-3 sm:rounded-lg sm:border">
|
||||||
<form
|
<form
|
||||||
onSubmit={handleAdd}
|
onSubmit={handleAdd}
|
||||||
className="relative flex flex-1 items-center gap-2"
|
className="relative flex flex-1 flex-wrap items-center gap-3 sm:flex-nowrap"
|
||||||
>
|
>
|
||||||
<div className="flex-1">
|
<div className="flex-1">
|
||||||
<div className="relative max-w-xs">
|
<div className="relative max-w-xs">
|
||||||
@@ -559,110 +465,40 @@ export function ActionBar({
|
|||||||
)}
|
)}
|
||||||
</button>
|
</button>
|
||||||
)}
|
)}
|
||||||
{browseMode && deferredSuggestions.length > 0 && (
|
{!!browseMode && (
|
||||||
<div className="card-glow absolute bottom-full z-50 mb-1 w-full rounded-lg border border-border bg-card">
|
<BrowseSuggestions
|
||||||
<ul className="max-h-48 overflow-y-auto py-1">
|
suggestions={suggestions}
|
||||||
{deferredSuggestions.map((result, i) => (
|
suggestionIndex={suggestionIndex}
|
||||||
<li key={creatureKey(result)}>
|
onSelect={handleBrowseSelect}
|
||||||
<button
|
onHover={suggestionActions.setSuggestionIndex}
|
||||||
type="button"
|
/>
|
||||||
className={cn(
|
|
||||||
"flex w-full items-center justify-between px-3 py-1.5 text-left text-sm",
|
|
||||||
i === suggestionIndex
|
|
||||||
? "bg-accent/20 text-foreground"
|
|
||||||
: "text-foreground hover:bg-hover-neutral-bg",
|
|
||||||
)}
|
|
||||||
onMouseDown={(e) => e.preventDefault()}
|
|
||||||
onClick={() => handleBrowseSelect(result)}
|
|
||||||
onMouseEnter={() => setSuggestionIndex(i)}
|
|
||||||
>
|
|
||||||
<span>{result.name}</span>
|
|
||||||
<span className="text-muted-foreground text-xs">
|
|
||||||
{result.sourceDisplayName}
|
|
||||||
</span>
|
|
||||||
</button>
|
|
||||||
</li>
|
|
||||||
))}
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
)}
|
)}
|
||||||
{!browseMode && hasSuggestions && (
|
{!browseMode && hasSuggestions && (
|
||||||
<AddModeSuggestions
|
<AddModeSuggestions
|
||||||
nameInput={nameInput}
|
nameInput={nameInput}
|
||||||
suggestions={deferredSuggestions}
|
suggestions={suggestions}
|
||||||
pcMatches={deferredPcMatches}
|
pcMatches={pcMatches}
|
||||||
suggestionIndex={suggestionIndex}
|
suggestionIndex={suggestionIndex}
|
||||||
queued={queued}
|
queued={queued}
|
||||||
onDismiss={dismissSuggestions}
|
actions={suggestionActions}
|
||||||
onClear={clearInput}
|
|
||||||
onClickSuggestion={handleClickSuggestion}
|
|
||||||
onSetSuggestionIndex={setSuggestionIndex}
|
|
||||||
onSetQueued={setQueued}
|
|
||||||
onConfirmQueued={confirmQueued}
|
|
||||||
onAddFromPlayerCharacter={addFromPlayerCharacter}
|
|
||||||
/>
|
/>
|
||||||
)}
|
)}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{!browseMode && nameInput.length >= 2 && !hasSuggestions && (
|
{!browseMode && nameInput.length >= 2 && !hasSuggestions && (
|
||||||
<div className="flex items-center gap-2">
|
<CustomStatFields
|
||||||
<Input
|
customInit={customInit}
|
||||||
type="text"
|
customAc={customAc}
|
||||||
inputMode="numeric"
|
customMaxHp={customMaxHp}
|
||||||
value={customInit}
|
onInitChange={setCustomInit}
|
||||||
onChange={(e) => setCustomInit(e.target.value)}
|
onAcChange={setCustomAc}
|
||||||
placeholder="Init"
|
onMaxHpChange={setCustomMaxHp}
|
||||||
className="w-16 text-center"
|
/>
|
||||||
/>
|
|
||||||
<Input
|
|
||||||
type="text"
|
|
||||||
inputMode="numeric"
|
|
||||||
value={customAc}
|
|
||||||
onChange={(e) => setCustomAc(e.target.value)}
|
|
||||||
placeholder="AC"
|
|
||||||
className="w-16 text-center"
|
|
||||||
/>
|
|
||||||
<Input
|
|
||||||
type="text"
|
|
||||||
inputMode="numeric"
|
|
||||||
value={customMaxHp}
|
|
||||||
onChange={(e) => setCustomMaxHp(e.target.value)}
|
|
||||||
placeholder="MaxHP"
|
|
||||||
className="w-18 text-center"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
)}
|
)}
|
||||||
{!browseMode && nameInput.length >= 2 && !hasSuggestions && (
|
{!browseMode && nameInput.length >= 2 && !hasSuggestions && (
|
||||||
<Button type="submit">Add</Button>
|
<Button type="submit">Add</Button>
|
||||||
)}
|
)}
|
||||||
{!!hasCreatureCombatants && (
|
<RollAllButton />
|
||||||
<>
|
|
||||||
<Button
|
|
||||||
type="button"
|
|
||||||
size="icon"
|
|
||||||
variant="ghost"
|
|
||||||
className="text-muted-foreground hover:text-hover-action"
|
|
||||||
onClick={() => handleRollAllInitiative()}
|
|
||||||
onContextMenu={(e) => {
|
|
||||||
e.preventDefault();
|
|
||||||
openRollAllMenu(e.clientX, e.clientY);
|
|
||||||
}}
|
|
||||||
{...rollAllLongPress}
|
|
||||||
disabled={!canRollAllInitiative}
|
|
||||||
title="Roll all initiative"
|
|
||||||
aria-label="Roll all initiative"
|
|
||||||
>
|
|
||||||
<D20Icon className="h-6 w-6" />
|
|
||||||
</Button>
|
|
||||||
{!!rollAllMenuPos && (
|
|
||||||
<RollModeMenu
|
|
||||||
position={rollAllMenuPos}
|
|
||||||
onSelect={(mode) => handleRollAllInitiative(mode)}
|
|
||||||
onClose={() => setRollAllMenuPos(null)}
|
|
||||||
/>
|
|
||||||
)}
|
|
||||||
</>
|
|
||||||
)}
|
|
||||||
{overflowItems.length > 0 && <OverflowMenu items={overflowItems} />}
|
{overflowItems.length > 0 && <OverflowMenu items={overflowItems} />}
|
||||||
</form>
|
</form>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -112,7 +112,7 @@ function EditableName({
|
|||||||
onClick={startEditing}
|
onClick={startEditing}
|
||||||
title="Rename"
|
title="Rename"
|
||||||
aria-label="Rename"
|
aria-label="Rename"
|
||||||
className="inline-flex shrink-0 items-center rounded p-0.5 text-muted-foreground opacity-0 pointer-coarse:opacity-100 transition-colors transition-opacity hover:bg-hover-neutral-bg hover:text-hover-neutral focus:opacity-100 group-hover:opacity-100"
|
className="inline-flex pointer-coarse:w-auto w-0 shrink-0 items-center overflow-hidden pointer-coarse:overflow-visible rounded p-0.5 text-muted-foreground opacity-0 pointer-coarse:opacity-100 transition-all duration-150 hover:bg-hover-neutral-bg hover:text-hover-neutral focus:w-auto focus:overflow-visible focus:opacity-100 group-hover:w-auto group-hover:overflow-visible group-hover:opacity-100"
|
||||||
>
|
>
|
||||||
<Pencil size={14} />
|
<Pencil size={14} />
|
||||||
</button>
|
</button>
|
||||||
@@ -157,7 +157,7 @@ function MaxHpDisplay({
|
|||||||
inputMode="numeric"
|
inputMode="numeric"
|
||||||
value={draft}
|
value={draft}
|
||||||
placeholder="Max"
|
placeholder="Max"
|
||||||
className="h-7 w-[7ch] text-center text-sm tabular-nums"
|
className="h-7 w-[7ch] text-center tabular-nums"
|
||||||
onChange={(e) => setDraft(e.target.value)}
|
onChange={(e) => setDraft(e.target.value)}
|
||||||
onBlur={commit}
|
onBlur={commit}
|
||||||
onKeyDown={(e) => {
|
onKeyDown={(e) => {
|
||||||
@@ -272,7 +272,7 @@ function AcDisplay({
|
|||||||
inputMode="numeric"
|
inputMode="numeric"
|
||||||
value={draft}
|
value={draft}
|
||||||
placeholder="AC"
|
placeholder="AC"
|
||||||
className="h-7 w-[6ch] text-center text-sm tabular-nums"
|
className="h-7 w-[6ch] text-center tabular-nums"
|
||||||
onChange={(e) => setDraft(e.target.value)}
|
onChange={(e) => setDraft(e.target.value)}
|
||||||
onBlur={commit}
|
onBlur={commit}
|
||||||
onKeyDown={(e) => {
|
onKeyDown={(e) => {
|
||||||
@@ -348,7 +348,7 @@ function InitiativeDisplay({
|
|||||||
value={draft}
|
value={draft}
|
||||||
placeholder="--"
|
placeholder="--"
|
||||||
className={cn(
|
className={cn(
|
||||||
"h-7 w-full text-center text-sm tabular-nums",
|
"h-7 w-full text-center tabular-nums",
|
||||||
dimmed && "opacity-50",
|
dimmed && "opacity-50",
|
||||||
)}
|
)}
|
||||||
onChange={(e) => setDraft(e.target.value)}
|
onChange={(e) => setDraft(e.target.value)}
|
||||||
@@ -520,7 +520,7 @@ export function CombatantRow({
|
|||||||
isPulsing && "animate-concentration-pulse",
|
isPulsing && "animate-concentration-pulse",
|
||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
<div className="grid grid-cols-[2rem_3rem_auto_1fr_auto_2rem] items-center gap-1.5 py-2 sm:grid-cols-[2rem_3.5rem_auto_1fr_auto_2rem] sm:gap-3">
|
<div className="grid grid-cols-[2rem_3rem_auto_1fr_auto_2rem] items-center gap-1.5 py-3 sm:grid-cols-[2rem_3.5rem_auto_1fr_auto_2rem] sm:gap-3 sm:py-2">
|
||||||
{/* Concentration */}
|
{/* Concentration */}
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import {
|
import {
|
||||||
CONDITION_DEFINITIONS,
|
|
||||||
type ConditionId,
|
type ConditionId,
|
||||||
getConditionDescription,
|
getConditionDescription,
|
||||||
|
getConditionsForEdition,
|
||||||
} from "@initiative/domain";
|
} from "@initiative/domain";
|
||||||
import type { LucideIcon } from "lucide-react";
|
import type { LucideIcon } from "lucide-react";
|
||||||
import {
|
import {
|
||||||
@@ -17,7 +17,9 @@ import {
|
|||||||
Heart,
|
Heart,
|
||||||
Link,
|
Link,
|
||||||
Moon,
|
Moon,
|
||||||
|
ShieldMinus,
|
||||||
Siren,
|
Siren,
|
||||||
|
Snail,
|
||||||
Sparkles,
|
Sparkles,
|
||||||
ZapOff,
|
ZapOff,
|
||||||
} from "lucide-react";
|
} from "lucide-react";
|
||||||
@@ -41,6 +43,8 @@ const ICON_MAP: Record<string, LucideIcon> = {
|
|||||||
Droplet,
|
Droplet,
|
||||||
ArrowDown,
|
ArrowDown,
|
||||||
Link,
|
Link,
|
||||||
|
ShieldMinus,
|
||||||
|
Snail,
|
||||||
Sparkles,
|
Sparkles,
|
||||||
Moon,
|
Moon,
|
||||||
};
|
};
|
||||||
@@ -56,6 +60,7 @@ const COLOR_CLASSES: Record<string, string> = {
|
|||||||
slate: "text-slate-400",
|
slate: "text-slate-400",
|
||||||
green: "text-green-400",
|
green: "text-green-400",
|
||||||
indigo: "text-indigo-400",
|
indigo: "text-indigo-400",
|
||||||
|
sky: "text-sky-400",
|
||||||
};
|
};
|
||||||
|
|
||||||
interface ConditionPickerProps {
|
interface ConditionPickerProps {
|
||||||
@@ -110,6 +115,7 @@ export function ConditionPicker({
|
|||||||
}, [onClose]);
|
}, [onClose]);
|
||||||
|
|
||||||
const { edition } = useRulesEditionContext();
|
const { edition } = useRulesEditionContext();
|
||||||
|
const conditions = getConditionsForEdition(edition);
|
||||||
const active = new Set(activeConditions ?? []);
|
const active = new Set(activeConditions ?? []);
|
||||||
|
|
||||||
return createPortal(
|
return createPortal(
|
||||||
@@ -122,7 +128,7 @@ export function ConditionPicker({
|
|||||||
: { visibility: "hidden" as const }
|
: { visibility: "hidden" as const }
|
||||||
}
|
}
|
||||||
>
|
>
|
||||||
{CONDITION_DEFINITIONS.map((def) => {
|
{conditions.map((def) => {
|
||||||
const Icon = ICON_MAP[def.iconName];
|
const Icon = ICON_MAP[def.iconName];
|
||||||
if (!Icon) return null;
|
if (!Icon) return null;
|
||||||
const isActive = active.has(def.id);
|
const isActive = active.has(def.id);
|
||||||
|
|||||||
@@ -18,7 +18,9 @@ import {
|
|||||||
Link,
|
Link,
|
||||||
Moon,
|
Moon,
|
||||||
Plus,
|
Plus,
|
||||||
|
ShieldMinus,
|
||||||
Siren,
|
Siren,
|
||||||
|
Snail,
|
||||||
Sparkles,
|
Sparkles,
|
||||||
ZapOff,
|
ZapOff,
|
||||||
} from "lucide-react";
|
} from "lucide-react";
|
||||||
@@ -40,6 +42,8 @@ const ICON_MAP: Record<string, LucideIcon> = {
|
|||||||
Droplet,
|
Droplet,
|
||||||
ArrowDown,
|
ArrowDown,
|
||||||
Link,
|
Link,
|
||||||
|
ShieldMinus,
|
||||||
|
Snail,
|
||||||
Sparkles,
|
Sparkles,
|
||||||
Moon,
|
Moon,
|
||||||
};
|
};
|
||||||
@@ -55,6 +59,7 @@ const COLOR_CLASSES: Record<string, string> = {
|
|||||||
slate: "text-slate-400",
|
slate: "text-slate-400",
|
||||||
green: "text-green-400",
|
green: "text-green-400",
|
||||||
indigo: "text-indigo-400",
|
indigo: "text-indigo-400",
|
||||||
|
sky: "text-sky-400",
|
||||||
};
|
};
|
||||||
|
|
||||||
interface ConditionTagsProps {
|
interface ConditionTagsProps {
|
||||||
@@ -103,7 +108,7 @@ export function ConditionTags({
|
|||||||
type="button"
|
type="button"
|
||||||
title="Add condition"
|
title="Add condition"
|
||||||
aria-label="Add condition"
|
aria-label="Add condition"
|
||||||
className="inline-flex items-center rounded p-0.5 text-muted-foreground opacity-0 pointer-coarse:opacity-100 transition-colors transition-opacity hover:bg-hover-neutral-bg hover:text-hover-neutral focus:opacity-100 group-hover:opacity-100"
|
className="inline-flex pointer-coarse:w-auto w-0 items-center overflow-hidden pointer-coarse:overflow-visible rounded p-0.5 text-muted-foreground opacity-0 pointer-coarse:opacity-100 transition-all duration-150 hover:bg-hover-neutral-bg hover:text-hover-neutral focus:w-auto focus:overflow-visible focus:opacity-100 group-hover:w-auto group-hover:overflow-visible group-hover:opacity-100"
|
||||||
onClick={(e) => {
|
onClick={(e) => {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
onOpenPicker();
|
onOpenPicker();
|
||||||
|
|||||||
@@ -106,7 +106,7 @@ export function HpAdjustPopover({
|
|||||||
inputMode="numeric"
|
inputMode="numeric"
|
||||||
value={inputValue}
|
value={inputValue}
|
||||||
placeholder="HP"
|
placeholder="HP"
|
||||||
className="h-7 w-[7ch] text-center text-sm tabular-nums"
|
className="h-7 w-[7ch] text-center tabular-nums"
|
||||||
onChange={(e) => {
|
onChange={(e) => {
|
||||||
const v = e.target.value;
|
const v = e.target.value;
|
||||||
if (v === "" || DIGITS_ONLY_REGEX.test(v)) {
|
if (v === "" || DIGITS_ONLY_REGEX.test(v)) {
|
||||||
|
|||||||
@@ -1,11 +1,19 @@
|
|||||||
import { StepBack, StepForward, Trash2 } from "lucide-react";
|
import { Redo2, StepBack, StepForward, Trash2, Undo2 } from "lucide-react";
|
||||||
import { useEncounterContext } from "../contexts/encounter-context.js";
|
import { useEncounterContext } from "../contexts/encounter-context.js";
|
||||||
import { Button } from "./ui/button.js";
|
import { Button } from "./ui/button.js";
|
||||||
import { ConfirmButton } from "./ui/confirm-button.js";
|
import { ConfirmButton } from "./ui/confirm-button.js";
|
||||||
|
|
||||||
export function TurnNavigation() {
|
export function TurnNavigation() {
|
||||||
const { encounter, advanceTurn, retreatTurn, clearEncounter } =
|
const {
|
||||||
useEncounterContext();
|
encounter,
|
||||||
|
advanceTurn,
|
||||||
|
retreatTurn,
|
||||||
|
clearEncounter,
|
||||||
|
undo,
|
||||||
|
redo,
|
||||||
|
canUndo,
|
||||||
|
canRedo,
|
||||||
|
} = useEncounterContext();
|
||||||
|
|
||||||
const hasCombatants = encounter.combatants.length > 0;
|
const hasCombatants = encounter.combatants.length > 0;
|
||||||
const isAtStart = encounter.roundNumber === 1 && encounter.activeIndex === 0;
|
const isAtStart = encounter.roundNumber === 1 && encounter.activeIndex === 0;
|
||||||
@@ -24,6 +32,29 @@ export function TurnNavigation() {
|
|||||||
<StepBack className="h-5 w-5" />
|
<StepBack className="h-5 w-5" />
|
||||||
</Button>
|
</Button>
|
||||||
|
|
||||||
|
<div className="flex items-center gap-1">
|
||||||
|
<Button
|
||||||
|
variant="ghost"
|
||||||
|
size="icon"
|
||||||
|
onClick={undo}
|
||||||
|
disabled={!canUndo}
|
||||||
|
title="Undo"
|
||||||
|
aria-label="Undo"
|
||||||
|
>
|
||||||
|
<Undo2 className="h-4 w-4" />
|
||||||
|
</Button>
|
||||||
|
<Button
|
||||||
|
variant="ghost"
|
||||||
|
size="icon"
|
||||||
|
onClick={redo}
|
||||||
|
disabled={!canRedo}
|
||||||
|
title="Redo"
|
||||||
|
aria-label="Redo"
|
||||||
|
>
|
||||||
|
<Redo2 className="h-4 w-4" />
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
|
||||||
<div className="flex min-w-0 flex-1 items-center justify-center gap-2 text-sm">
|
<div className="flex min-w-0 flex-1 items-center justify-center gap-2 text-sm">
|
||||||
<span className="shrink-0 rounded-md bg-muted px-2 py-0.5 font-semibold text-foreground text-sm">
|
<span className="shrink-0 rounded-md bg-muted px-2 py-0.5 font-semibold text-foreground text-sm">
|
||||||
<span className="-mt-[3px] inline-block">
|
<span className="-mt-[3px] inline-block">
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ export const Input = ({
|
|||||||
<input
|
<input
|
||||||
ref={ref}
|
ref={ref}
|
||||||
className={cn(
|
className={cn(
|
||||||
"flex h-9 w-full rounded-md border border-input bg-transparent px-3 py-1 text-foreground text-sm shadow-sm transition-colors placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-primary disabled:cursor-not-allowed disabled:opacity-50",
|
"flex h-9 w-full rounded-md border border-input bg-transparent px-3 py-1 text-base text-foreground shadow-sm transition-colors placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-primary disabled:cursor-not-allowed disabled:opacity-50 sm:text-sm",
|
||||||
className,
|
className,
|
||||||
)}
|
)}
|
||||||
{...props}
|
{...props}
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { createContext, type ReactNode, useContext } from "react";
|
import { createContext, type ReactNode, useContext } from "react";
|
||||||
import { useEncounter } from "../hooks/use-encounter.js";
|
import { useEncounter } from "../hooks/use-encounter.js";
|
||||||
|
import { useUndoRedoShortcuts } from "../hooks/use-undo-redo-shortcuts.js";
|
||||||
|
|
||||||
type EncounterContextValue = ReturnType<typeof useEncounter>;
|
type EncounterContextValue = ReturnType<typeof useEncounter>;
|
||||||
|
|
||||||
@@ -7,6 +8,7 @@ const EncounterContext = createContext<EncounterContextValue | null>(null);
|
|||||||
|
|
||||||
export function EncounterProvider({ children }: { children: ReactNode }) {
|
export function EncounterProvider({ children }: { children: ReactNode }) {
|
||||||
const value = useEncounter();
|
const value = useEncounter();
|
||||||
|
useUndoRedoShortcuts(value.undo, value.redo, value.canUndo, value.canRedo);
|
||||||
return (
|
return (
|
||||||
<EncounterContext.Provider value={value}>
|
<EncounterContext.Provider value={value}>
|
||||||
{children}
|
{children}
|
||||||
|
|||||||
316
apps/web/src/hooks/use-action-bar-state.ts
Normal file
316
apps/web/src/hooks/use-action-bar-state.ts
Normal file
@@ -0,0 +1,316 @@
|
|||||||
|
import type { CreatureId, PlayerCharacter } from "@initiative/domain";
|
||||||
|
import { useCallback, useDeferredValue, useMemo, useState } from "react";
|
||||||
|
import type { SearchResult } from "../contexts/bestiary-context.js";
|
||||||
|
import { useBestiaryContext } from "../contexts/bestiary-context.js";
|
||||||
|
import { useEncounterContext } from "../contexts/encounter-context.js";
|
||||||
|
import { usePlayerCharactersContext } from "../contexts/player-characters-context.js";
|
||||||
|
import { useSidePanelContext } from "../contexts/side-panel-context.js";
|
||||||
|
|
||||||
|
export interface QueuedCreature {
|
||||||
|
result: SearchResult;
|
||||||
|
count: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SuggestionActions {
|
||||||
|
dismiss: () => void;
|
||||||
|
clear: () => void;
|
||||||
|
clickSuggestion: (result: SearchResult) => void;
|
||||||
|
setSuggestionIndex: (i: number) => void;
|
||||||
|
setQueued: (q: QueuedCreature | null) => void;
|
||||||
|
confirmQueued: () => void;
|
||||||
|
addFromPlayerCharacter?: (pc: PlayerCharacter) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function creatureKey(r: SearchResult): string {
|
||||||
|
return `${r.source}:${r.name}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useActionBarState() {
|
||||||
|
const {
|
||||||
|
addCombatant,
|
||||||
|
addFromBestiary,
|
||||||
|
addMultipleFromBestiary,
|
||||||
|
addFromPlayerCharacter,
|
||||||
|
} = useEncounterContext();
|
||||||
|
const { search: bestiarySearch, isLoaded: bestiaryLoaded } =
|
||||||
|
useBestiaryContext();
|
||||||
|
const { characters: playerCharacters } = usePlayerCharactersContext();
|
||||||
|
const { showBulkImport, showSourceManager, showCreature, panelView } =
|
||||||
|
useSidePanelContext();
|
||||||
|
|
||||||
|
const [nameInput, setNameInput] = useState("");
|
||||||
|
const [suggestions, setSuggestions] = useState<SearchResult[]>([]);
|
||||||
|
const [pcMatches, setPcMatches] = useState<PlayerCharacter[]>([]);
|
||||||
|
const deferredSuggestions = useDeferredValue(suggestions);
|
||||||
|
const deferredPcMatches = useDeferredValue(pcMatches);
|
||||||
|
const [suggestionIndex, setSuggestionIndex] = useState(-1);
|
||||||
|
const [queued, setQueued] = useState<QueuedCreature | null>(null);
|
||||||
|
const [customInit, setCustomInit] = useState("");
|
||||||
|
const [customAc, setCustomAc] = useState("");
|
||||||
|
const [customMaxHp, setCustomMaxHp] = useState("");
|
||||||
|
const [browseMode, setBrowseMode] = useState(false);
|
||||||
|
|
||||||
|
const clearCustomFields = () => {
|
||||||
|
setCustomInit("");
|
||||||
|
setCustomAc("");
|
||||||
|
setCustomMaxHp("");
|
||||||
|
};
|
||||||
|
|
||||||
|
const clearInput = useCallback(() => {
|
||||||
|
setNameInput("");
|
||||||
|
setSuggestions([]);
|
||||||
|
setPcMatches([]);
|
||||||
|
setQueued(null);
|
||||||
|
setSuggestionIndex(-1);
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const dismissSuggestions = useCallback(() => {
|
||||||
|
setSuggestions([]);
|
||||||
|
setPcMatches([]);
|
||||||
|
setQueued(null);
|
||||||
|
setSuggestionIndex(-1);
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const handleAddFromBestiary = useCallback(
|
||||||
|
(result: SearchResult) => {
|
||||||
|
const creatureId = addFromBestiary(result);
|
||||||
|
const isDesktop = globalThis.matchMedia("(min-width: 1024px)").matches;
|
||||||
|
if (creatureId && panelView.mode === "closed" && isDesktop) {
|
||||||
|
showCreature(creatureId);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
[addFromBestiary, panelView.mode, showCreature],
|
||||||
|
);
|
||||||
|
|
||||||
|
const handleViewStatBlock = useCallback(
|
||||||
|
(result: SearchResult) => {
|
||||||
|
const slug = result.name
|
||||||
|
.toLowerCase()
|
||||||
|
.replaceAll(/[^a-z0-9]+/g, "-")
|
||||||
|
.replaceAll(/(^-|-$)/g, "");
|
||||||
|
const cId = `${result.source.toLowerCase()}:${slug}` as CreatureId;
|
||||||
|
showCreature(cId);
|
||||||
|
},
|
||||||
|
[showCreature],
|
||||||
|
);
|
||||||
|
|
||||||
|
const confirmQueued = useCallback(() => {
|
||||||
|
if (!queued) return;
|
||||||
|
if (queued.count === 1) {
|
||||||
|
handleAddFromBestiary(queued.result);
|
||||||
|
} else {
|
||||||
|
const creatureId = addMultipleFromBestiary(queued.result, queued.count);
|
||||||
|
const isDesktop = globalThis.matchMedia("(min-width: 1024px)").matches;
|
||||||
|
if (creatureId && panelView.mode === "closed" && isDesktop) {
|
||||||
|
showCreature(creatureId);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
clearInput();
|
||||||
|
}, [
|
||||||
|
queued,
|
||||||
|
handleAddFromBestiary,
|
||||||
|
addMultipleFromBestiary,
|
||||||
|
panelView.mode,
|
||||||
|
showCreature,
|
||||||
|
clearInput,
|
||||||
|
]);
|
||||||
|
|
||||||
|
const parseNum = (v: string): number | undefined => {
|
||||||
|
if (v.trim() === "") return undefined;
|
||||||
|
const n = Number(v);
|
||||||
|
return Number.isNaN(n) ? undefined : n;
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleAdd = (e: React.SubmitEvent<HTMLFormElement>) => {
|
||||||
|
e.preventDefault();
|
||||||
|
if (browseMode) return;
|
||||||
|
if (queued) {
|
||||||
|
confirmQueued();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (nameInput.trim() === "") return;
|
||||||
|
const opts: { initiative?: number; ac?: number; maxHp?: number } = {};
|
||||||
|
const init = parseNum(customInit);
|
||||||
|
const ac = parseNum(customAc);
|
||||||
|
const maxHp = parseNum(customMaxHp);
|
||||||
|
if (init !== undefined) opts.initiative = init;
|
||||||
|
if (ac !== undefined) opts.ac = ac;
|
||||||
|
if (maxHp !== undefined) opts.maxHp = maxHp;
|
||||||
|
addCombatant(nameInput, Object.keys(opts).length > 0 ? opts : undefined);
|
||||||
|
setNameInput("");
|
||||||
|
setSuggestions([]);
|
||||||
|
setPcMatches([]);
|
||||||
|
clearCustomFields();
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleBrowseSearch = (value: string) => {
|
||||||
|
setSuggestions(value.length >= 2 ? bestiarySearch(value) : []);
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleAddSearch = (value: string) => {
|
||||||
|
let newSuggestions: SearchResult[] = [];
|
||||||
|
let newPcMatches: PlayerCharacter[] = [];
|
||||||
|
if (value.length >= 2) {
|
||||||
|
newSuggestions = bestiarySearch(value);
|
||||||
|
setSuggestions(newSuggestions);
|
||||||
|
if (playerCharacters && playerCharacters.length > 0) {
|
||||||
|
const lower = value.toLowerCase();
|
||||||
|
newPcMatches = playerCharacters.filter((pc) =>
|
||||||
|
pc.name.toLowerCase().includes(lower),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
setPcMatches(newPcMatches);
|
||||||
|
} else {
|
||||||
|
setSuggestions([]);
|
||||||
|
setPcMatches([]);
|
||||||
|
}
|
||||||
|
if (newSuggestions.length > 0 || newPcMatches.length > 0) {
|
||||||
|
clearCustomFields();
|
||||||
|
}
|
||||||
|
if (queued) {
|
||||||
|
const qKey = creatureKey(queued.result);
|
||||||
|
const stillVisible = newSuggestions.some((s) => creatureKey(s) === qKey);
|
||||||
|
if (!stillVisible) {
|
||||||
|
setQueued(null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleNameChange = (value: string) => {
|
||||||
|
setNameInput(value);
|
||||||
|
setSuggestionIndex(-1);
|
||||||
|
if (browseMode) {
|
||||||
|
handleBrowseSearch(value);
|
||||||
|
} else {
|
||||||
|
handleAddSearch(value);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleClickSuggestion = useCallback((result: SearchResult) => {
|
||||||
|
const key = creatureKey(result);
|
||||||
|
setQueued((prev) => {
|
||||||
|
if (prev && creatureKey(prev.result) === key) {
|
||||||
|
return { ...prev, count: prev.count + 1 };
|
||||||
|
}
|
||||||
|
return { result, count: 1 };
|
||||||
|
});
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const handleEnter = () => {
|
||||||
|
if (queued) {
|
||||||
|
confirmQueued();
|
||||||
|
} else if (suggestionIndex >= 0) {
|
||||||
|
handleClickSuggestion(suggestions[suggestionIndex]);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const hasSuggestions =
|
||||||
|
deferredSuggestions.length > 0 || deferredPcMatches.length > 0;
|
||||||
|
|
||||||
|
const handleKeyDown = (e: React.KeyboardEvent) => {
|
||||||
|
if (!hasSuggestions) return;
|
||||||
|
|
||||||
|
if (e.key === "ArrowDown") {
|
||||||
|
e.preventDefault();
|
||||||
|
setSuggestionIndex((i) => (i < suggestions.length - 1 ? i + 1 : 0));
|
||||||
|
} else if (e.key === "ArrowUp") {
|
||||||
|
e.preventDefault();
|
||||||
|
setSuggestionIndex((i) => (i > 0 ? i - 1 : suggestions.length - 1));
|
||||||
|
} else if (e.key === "Enter") {
|
||||||
|
e.preventDefault();
|
||||||
|
handleEnter();
|
||||||
|
} else if (e.key === "Escape") {
|
||||||
|
dismissSuggestions();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleBrowseKeyDown = (e: React.KeyboardEvent) => {
|
||||||
|
if (e.key === "Escape") {
|
||||||
|
setBrowseMode(false);
|
||||||
|
clearInput();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (suggestions.length === 0) return;
|
||||||
|
if (e.key === "ArrowDown") {
|
||||||
|
e.preventDefault();
|
||||||
|
setSuggestionIndex((i) => (i < suggestions.length - 1 ? i + 1 : 0));
|
||||||
|
} else if (e.key === "ArrowUp") {
|
||||||
|
e.preventDefault();
|
||||||
|
setSuggestionIndex((i) => (i > 0 ? i - 1 : suggestions.length - 1));
|
||||||
|
} else if (e.key === "Enter" && suggestionIndex >= 0) {
|
||||||
|
e.preventDefault();
|
||||||
|
handleViewStatBlock(suggestions[suggestionIndex]);
|
||||||
|
setBrowseMode(false);
|
||||||
|
clearInput();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleBrowseSelect = (result: SearchResult) => {
|
||||||
|
handleViewStatBlock(result);
|
||||||
|
setBrowseMode(false);
|
||||||
|
clearInput();
|
||||||
|
};
|
||||||
|
|
||||||
|
const toggleBrowseMode = () => {
|
||||||
|
setBrowseMode((prev) => {
|
||||||
|
const next = !prev;
|
||||||
|
setSuggestionIndex(-1);
|
||||||
|
setQueued(null);
|
||||||
|
if (next) {
|
||||||
|
handleBrowseSearch(nameInput);
|
||||||
|
} else {
|
||||||
|
handleAddSearch(nameInput);
|
||||||
|
}
|
||||||
|
return next;
|
||||||
|
});
|
||||||
|
clearCustomFields();
|
||||||
|
};
|
||||||
|
|
||||||
|
const suggestionActions: SuggestionActions = useMemo(
|
||||||
|
() => ({
|
||||||
|
dismiss: dismissSuggestions,
|
||||||
|
clear: clearInput,
|
||||||
|
clickSuggestion: handleClickSuggestion,
|
||||||
|
setSuggestionIndex,
|
||||||
|
setQueued,
|
||||||
|
confirmQueued,
|
||||||
|
addFromPlayerCharacter,
|
||||||
|
}),
|
||||||
|
[
|
||||||
|
dismissSuggestions,
|
||||||
|
clearInput,
|
||||||
|
handleClickSuggestion,
|
||||||
|
confirmQueued,
|
||||||
|
addFromPlayerCharacter,
|
||||||
|
],
|
||||||
|
);
|
||||||
|
|
||||||
|
return {
|
||||||
|
// State
|
||||||
|
nameInput,
|
||||||
|
suggestions: deferredSuggestions,
|
||||||
|
pcMatches: deferredPcMatches,
|
||||||
|
suggestionIndex,
|
||||||
|
queued,
|
||||||
|
customInit,
|
||||||
|
customAc,
|
||||||
|
customMaxHp,
|
||||||
|
browseMode,
|
||||||
|
bestiaryLoaded,
|
||||||
|
hasSuggestions,
|
||||||
|
showBulkImport,
|
||||||
|
showSourceManager,
|
||||||
|
|
||||||
|
// Actions
|
||||||
|
suggestionActions,
|
||||||
|
handleNameChange,
|
||||||
|
handleKeyDown,
|
||||||
|
handleBrowseKeyDown,
|
||||||
|
handleAdd,
|
||||||
|
handleBrowseSelect,
|
||||||
|
toggleBrowseMode,
|
||||||
|
setCustomInit,
|
||||||
|
setCustomAc,
|
||||||
|
setCustomMaxHp,
|
||||||
|
} as const;
|
||||||
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { useEffect } from "react";
|
import { useEffect, useRef } from "react";
|
||||||
import { useEncounterContext } from "../contexts/encounter-context.js";
|
import { useEncounterContext } from "../contexts/encounter-context.js";
|
||||||
import { useSidePanelContext } from "../contexts/side-panel-context.js";
|
import { useSidePanelContext } from "../contexts/side-panel-context.js";
|
||||||
|
|
||||||
@@ -8,10 +8,20 @@ export function useAutoStatBlock(): void {
|
|||||||
|
|
||||||
const activeCreatureId =
|
const activeCreatureId =
|
||||||
encounter.combatants[encounter.activeIndex]?.creatureId;
|
encounter.combatants[encounter.activeIndex]?.creatureId;
|
||||||
|
const prevActiveIndexRef = useRef(encounter.activeIndex);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (activeCreatureId && panelView.mode === "creature") {
|
const prevIndex = prevActiveIndexRef.current;
|
||||||
|
prevActiveIndexRef.current = encounter.activeIndex;
|
||||||
|
|
||||||
|
// Only auto-update when the active turn changes (advance/retreat),
|
||||||
|
// not when the panel mode changes (user clicking a different creature).
|
||||||
|
if (
|
||||||
|
encounter.activeIndex !== prevIndex &&
|
||||||
|
activeCreatureId &&
|
||||||
|
panelView.mode === "creature"
|
||||||
|
) {
|
||||||
updateCreature(activeCreatureId);
|
updateCreature(activeCreatureId);
|
||||||
}
|
}
|
||||||
}, [activeCreatureId, panelView.mode, updateCreature]);
|
}, [encounter.activeIndex, activeCreatureId, panelView.mode, updateCreature]);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,11 @@
|
|||||||
import type { EncounterStore } from "@initiative/application";
|
import type { EncounterStore, UndoRedoStore } from "@initiative/application";
|
||||||
import {
|
import {
|
||||||
addCombatantUseCase,
|
addCombatantUseCase,
|
||||||
adjustHpUseCase,
|
adjustHpUseCase,
|
||||||
advanceTurnUseCase,
|
advanceTurnUseCase,
|
||||||
clearEncounterUseCase,
|
clearEncounterUseCase,
|
||||||
editCombatantUseCase,
|
editCombatantUseCase,
|
||||||
|
redoUseCase,
|
||||||
removeCombatantUseCase,
|
removeCombatantUseCase,
|
||||||
retreatTurnUseCase,
|
retreatTurnUseCase,
|
||||||
setAcUseCase,
|
setAcUseCase,
|
||||||
@@ -13,20 +14,25 @@ import {
|
|||||||
setTempHpUseCase,
|
setTempHpUseCase,
|
||||||
toggleConcentrationUseCase,
|
toggleConcentrationUseCase,
|
||||||
toggleConditionUseCase,
|
toggleConditionUseCase,
|
||||||
|
undoUseCase,
|
||||||
} from "@initiative/application";
|
} from "@initiative/application";
|
||||||
import type {
|
import type {
|
||||||
BestiaryIndexEntry,
|
BestiaryIndexEntry,
|
||||||
CombatantId,
|
CombatantId,
|
||||||
|
CombatantInit,
|
||||||
ConditionId,
|
ConditionId,
|
||||||
CreatureId,
|
CreatureId,
|
||||||
DomainEvent,
|
DomainEvent,
|
||||||
Encounter,
|
Encounter,
|
||||||
PlayerCharacter,
|
PlayerCharacter,
|
||||||
|
UndoRedoState,
|
||||||
} from "@initiative/domain";
|
} from "@initiative/domain";
|
||||||
import {
|
import {
|
||||||
|
clearHistory,
|
||||||
combatantId,
|
combatantId,
|
||||||
isDomainError,
|
isDomainError,
|
||||||
creatureId as makeCreatureId,
|
creatureId as makeCreatureId,
|
||||||
|
pushUndo,
|
||||||
resolveCreatureName,
|
resolveCreatureName,
|
||||||
} from "@initiative/domain";
|
} from "@initiative/domain";
|
||||||
import { useCallback, useEffect, useRef, useState } from "react";
|
import { useCallback, useEffect, useRef, useState } from "react";
|
||||||
@@ -34,6 +40,10 @@ import {
|
|||||||
loadEncounter,
|
loadEncounter,
|
||||||
saveEncounter,
|
saveEncounter,
|
||||||
} from "../persistence/encounter-storage.js";
|
} from "../persistence/encounter-storage.js";
|
||||||
|
import {
|
||||||
|
loadUndoRedoStacks,
|
||||||
|
saveUndoRedoStacks,
|
||||||
|
} from "../persistence/undo-redo-storage.js";
|
||||||
|
|
||||||
const COMBATANT_ID_REGEX = /^c-(\d+)$/;
|
const COMBATANT_ID_REGEX = /^c-(\d+)$/;
|
||||||
|
|
||||||
@@ -61,43 +71,24 @@ function deriveNextId(encounter: Encounter): number {
|
|||||||
return max;
|
return max;
|
||||||
}
|
}
|
||||||
|
|
||||||
interface CombatantOpts {
|
|
||||||
initiative?: number;
|
|
||||||
ac?: number;
|
|
||||||
maxHp?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
function applyCombatantOpts(
|
|
||||||
makeStore: () => EncounterStore,
|
|
||||||
id: ReturnType<typeof combatantId>,
|
|
||||||
opts: CombatantOpts,
|
|
||||||
): DomainEvent[] {
|
|
||||||
const events: DomainEvent[] = [];
|
|
||||||
if (opts.maxHp !== undefined) {
|
|
||||||
const r = setHpUseCase(makeStore(), id, opts.maxHp);
|
|
||||||
if (!isDomainError(r)) events.push(...r);
|
|
||||||
}
|
|
||||||
if (opts.ac !== undefined) {
|
|
||||||
const r = setAcUseCase(makeStore(), id, opts.ac);
|
|
||||||
if (!isDomainError(r)) events.push(...r);
|
|
||||||
}
|
|
||||||
if (opts.initiative !== undefined) {
|
|
||||||
const r = setInitiativeUseCase(makeStore(), id, opts.initiative);
|
|
||||||
if (!isDomainError(r)) events.push(...r);
|
|
||||||
}
|
|
||||||
return events;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function useEncounter() {
|
export function useEncounter() {
|
||||||
const [encounter, setEncounter] = useState<Encounter>(initializeEncounter);
|
const [encounter, setEncounter] = useState<Encounter>(initializeEncounter);
|
||||||
const [events, setEvents] = useState<DomainEvent[]>([]);
|
const [events, setEvents] = useState<DomainEvent[]>([]);
|
||||||
|
const [undoRedoState, setUndoRedoState] =
|
||||||
|
useState<UndoRedoState>(loadUndoRedoStacks);
|
||||||
const encounterRef = useRef(encounter);
|
const encounterRef = useRef(encounter);
|
||||||
encounterRef.current = encounter;
|
encounterRef.current = encounter;
|
||||||
|
const undoRedoRef = useRef(undoRedoState);
|
||||||
|
undoRedoRef.current = undoRedoState;
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
saveEncounter(encounter);
|
saveEncounter(encounter);
|
||||||
}, [encounter]);
|
}, [encounter]);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
saveUndoRedoStacks(undoRedoState);
|
||||||
|
}, [undoRedoState]);
|
||||||
|
|
||||||
const makeStore = useCallback((): EncounterStore => {
|
const makeStore = useCallback((): EncounterStore => {
|
||||||
return {
|
return {
|
||||||
get: () => encounterRef.current,
|
get: () => encounterRef.current,
|
||||||
@@ -108,52 +99,68 @@ export function useEncounter() {
|
|||||||
};
|
};
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
|
const makeUndoRedoStore = useCallback((): UndoRedoStore => {
|
||||||
|
return {
|
||||||
|
get: () => undoRedoRef.current,
|
||||||
|
save: (s) => {
|
||||||
|
undoRedoRef.current = s;
|
||||||
|
setUndoRedoState(s);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const withUndo = useCallback(<T>(action: () => T): T => {
|
||||||
|
const snapshot = encounterRef.current;
|
||||||
|
const result = action();
|
||||||
|
if (!isDomainError(result)) {
|
||||||
|
const newState = pushUndo(undoRedoRef.current, snapshot);
|
||||||
|
undoRedoRef.current = newState;
|
||||||
|
setUndoRedoState(newState);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}, []);
|
||||||
|
|
||||||
const advanceTurn = useCallback(() => {
|
const advanceTurn = useCallback(() => {
|
||||||
const result = advanceTurnUseCase(makeStore());
|
const result = withUndo(() => advanceTurnUseCase(makeStore()));
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
}, [makeStore]);
|
}, [makeStore, withUndo]);
|
||||||
|
|
||||||
const retreatTurn = useCallback(() => {
|
const retreatTurn = useCallback(() => {
|
||||||
const result = retreatTurnUseCase(makeStore());
|
const result = withUndo(() => retreatTurnUseCase(makeStore()));
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
}, [makeStore]);
|
}, [makeStore, withUndo]);
|
||||||
|
|
||||||
const nextId = useRef(deriveNextId(encounter));
|
const nextId = useRef(deriveNextId(encounter));
|
||||||
|
|
||||||
const addCombatant = useCallback(
|
const addCombatant = useCallback(
|
||||||
(name: string, opts?: CombatantOpts) => {
|
(name: string, init?: CombatantInit) => {
|
||||||
const id = combatantId(`c-${++nextId.current}`);
|
const id = combatantId(`c-${++nextId.current}`);
|
||||||
const result = addCombatantUseCase(makeStore(), id, name);
|
const result = withUndo(() =>
|
||||||
|
addCombatantUseCase(makeStore(), id, name, init),
|
||||||
|
);
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (opts) {
|
|
||||||
const optEvents = applyCombatantOpts(makeStore, id, opts);
|
|
||||||
if (optEvents.length > 0) {
|
|
||||||
setEvents((prev) => [...prev, ...optEvents]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const removeCombatant = useCallback(
|
const removeCombatant = useCallback(
|
||||||
(id: CombatantId) => {
|
(id: CombatantId) => {
|
||||||
const result = removeCombatantUseCase(makeStore(), id);
|
const result = withUndo(() => removeCombatantUseCase(makeStore(), id));
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -161,12 +168,14 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const editCombatant = useCallback(
|
const editCombatant = useCallback(
|
||||||
(id: CombatantId, newName: string) => {
|
(id: CombatantId, newName: string) => {
|
||||||
const result = editCombatantUseCase(makeStore(), id, newName);
|
const result = withUndo(() =>
|
||||||
|
editCombatantUseCase(makeStore(), id, newName),
|
||||||
|
);
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -174,12 +183,14 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const setInitiative = useCallback(
|
const setInitiative = useCallback(
|
||||||
(id: CombatantId, value: number | undefined) => {
|
(id: CombatantId, value: number | undefined) => {
|
||||||
const result = setInitiativeUseCase(makeStore(), id, value);
|
const result = withUndo(() =>
|
||||||
|
setInitiativeUseCase(makeStore(), id, value),
|
||||||
|
);
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -187,12 +198,12 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const setHp = useCallback(
|
const setHp = useCallback(
|
||||||
(id: CombatantId, maxHp: number | undefined) => {
|
(id: CombatantId, maxHp: number | undefined) => {
|
||||||
const result = setHpUseCase(makeStore(), id, maxHp);
|
const result = withUndo(() => setHpUseCase(makeStore(), id, maxHp));
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -200,12 +211,12 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const adjustHp = useCallback(
|
const adjustHp = useCallback(
|
||||||
(id: CombatantId, delta: number) => {
|
(id: CombatantId, delta: number) => {
|
||||||
const result = adjustHpUseCase(makeStore(), id, delta);
|
const result = withUndo(() => adjustHpUseCase(makeStore(), id, delta));
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -213,12 +224,12 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const setTempHp = useCallback(
|
const setTempHp = useCallback(
|
||||||
(id: CombatantId, tempHp: number | undefined) => {
|
(id: CombatantId, tempHp: number | undefined) => {
|
||||||
const result = setTempHpUseCase(makeStore(), id, tempHp);
|
const result = withUndo(() => setTempHpUseCase(makeStore(), id, tempHp));
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -226,12 +237,12 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const setAc = useCallback(
|
const setAc = useCallback(
|
||||||
(id: CombatantId, value: number | undefined) => {
|
(id: CombatantId, value: number | undefined) => {
|
||||||
const result = setAcUseCase(makeStore(), id, value);
|
const result = withUndo(() => setAcUseCase(makeStore(), id, value));
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -239,12 +250,14 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const toggleCondition = useCallback(
|
const toggleCondition = useCallback(
|
||||||
(id: CombatantId, conditionId: ConditionId) => {
|
(id: CombatantId, conditionId: ConditionId) => {
|
||||||
const result = toggleConditionUseCase(makeStore(), id, conditionId);
|
const result = withUndo(() =>
|
||||||
|
toggleConditionUseCase(makeStore(), id, conditionId),
|
||||||
|
);
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -252,12 +265,14 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const toggleConcentration = useCallback(
|
const toggleConcentration = useCallback(
|
||||||
(id: CombatantId) => {
|
(id: CombatantId) => {
|
||||||
const result = toggleConcentrationUseCase(makeStore(), id);
|
const result = withUndo(() =>
|
||||||
|
toggleConcentrationUseCase(makeStore(), id),
|
||||||
|
);
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return;
|
return;
|
||||||
@@ -265,7 +280,7 @@ export function useEncounter() {
|
|||||||
|
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
const clearEncounter = useCallback(() => {
|
const clearEncounter = useCallback(() => {
|
||||||
@@ -275,12 +290,18 @@ export function useEncounter() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const cleared = clearHistory();
|
||||||
|
undoRedoRef.current = cleared;
|
||||||
|
setUndoRedoState(cleared);
|
||||||
|
|
||||||
nextId.current = 0;
|
nextId.current = 0;
|
||||||
setEvents((prev) => [...prev, ...result]);
|
setEvents((prev) => [...prev, ...result]);
|
||||||
}, [makeStore]);
|
}, [makeStore]);
|
||||||
|
|
||||||
const addFromBestiary = useCallback(
|
const addOneFromBestiary = useCallback(
|
||||||
(entry: BestiaryIndexEntry): CreatureId | null => {
|
(
|
||||||
|
entry: BestiaryIndexEntry,
|
||||||
|
): { cId: CreatureId; events: DomainEvent[] } | null => {
|
||||||
const store = makeStore();
|
const store = makeStore();
|
||||||
const existingNames = store.get().combatants.map((c) => c.name);
|
const existingNames = store.get().combatants.map((c) => c.name);
|
||||||
const { newName, renames } = resolveCreatureName(
|
const { newName, renames } = resolveCreatureName(
|
||||||
@@ -288,7 +309,6 @@ export function useEncounter() {
|
|||||||
existingNames,
|
existingNames,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Apply renames (e.g., "Goblin" → "Goblin 1")
|
|
||||||
for (const { from, to } of renames) {
|
for (const { from, to } of renames) {
|
||||||
const target = store.get().combatants.find((c) => c.name === from);
|
const target = store.get().combatants.find((c) => c.name === from);
|
||||||
if (target) {
|
if (target) {
|
||||||
@@ -296,50 +316,75 @@ export function useEncounter() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add combatant with resolved name
|
|
||||||
const id = combatantId(`c-${++nextId.current}`);
|
|
||||||
const addResult = addCombatantUseCase(makeStore(), id, newName);
|
|
||||||
if (isDomainError(addResult)) return null;
|
|
||||||
|
|
||||||
// Set HP
|
|
||||||
const hpResult = setHpUseCase(makeStore(), id, entry.hp);
|
|
||||||
if (!isDomainError(hpResult)) {
|
|
||||||
setEvents((prev) => [...prev, ...hpResult]);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set AC
|
|
||||||
if (entry.ac > 0) {
|
|
||||||
const acResult = setAcUseCase(makeStore(), id, entry.ac);
|
|
||||||
if (!isDomainError(acResult)) {
|
|
||||||
setEvents((prev) => [...prev, ...acResult]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Derive creatureId from source + name
|
|
||||||
const slug = entry.name
|
const slug = entry.name
|
||||||
.toLowerCase()
|
.toLowerCase()
|
||||||
.replaceAll(/[^a-z0-9]+/g, "-")
|
.replaceAll(/[^a-z0-9]+/g, "-")
|
||||||
.replaceAll(/(^-|-$)/g, "");
|
.replaceAll(/(^-|-$)/g, "");
|
||||||
const cId = makeCreatureId(`${entry.source.toLowerCase()}:${slug}`);
|
const cId = makeCreatureId(`${entry.source.toLowerCase()}:${slug}`);
|
||||||
|
|
||||||
// Set creatureId on the combatant (use store.save to keep ref in sync for batch calls)
|
const id = combatantId(`c-${++nextId.current}`);
|
||||||
const currentEncounter = store.get();
|
const result = addCombatantUseCase(makeStore(), id, newName, {
|
||||||
store.save({
|
maxHp: entry.hp,
|
||||||
...currentEncounter,
|
ac: entry.ac > 0 ? entry.ac : undefined,
|
||||||
combatants: currentEncounter.combatants.map((c) =>
|
creatureId: cId,
|
||||||
c.id === id ? { ...c, creatureId: cId } : c,
|
|
||||||
),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
setEvents((prev) => [...prev, ...addResult]);
|
if (isDomainError(result)) return null;
|
||||||
|
|
||||||
return cId;
|
return { cId, events: result };
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const addFromBestiary = useCallback(
|
||||||
|
(entry: BestiaryIndexEntry): CreatureId | null => {
|
||||||
|
const snapshot = encounterRef.current;
|
||||||
|
const added = addOneFromBestiary(entry);
|
||||||
|
|
||||||
|
if (!added) {
|
||||||
|
makeStore().save(snapshot);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const newState = pushUndo(undoRedoRef.current, snapshot);
|
||||||
|
undoRedoRef.current = newState;
|
||||||
|
setUndoRedoState(newState);
|
||||||
|
|
||||||
|
setEvents((prev) => [...prev, ...added.events]);
|
||||||
|
return added.cId;
|
||||||
|
},
|
||||||
|
[makeStore, addOneFromBestiary],
|
||||||
|
);
|
||||||
|
|
||||||
|
const addMultipleFromBestiary = useCallback(
|
||||||
|
(entry: BestiaryIndexEntry, count: number): CreatureId | null => {
|
||||||
|
const snapshot = encounterRef.current;
|
||||||
|
const allEvents: DomainEvent[] = [];
|
||||||
|
let lastCId: CreatureId | null = null;
|
||||||
|
|
||||||
|
for (let i = 0; i < count; i++) {
|
||||||
|
const added = addOneFromBestiary(entry);
|
||||||
|
if (!added) {
|
||||||
|
makeStore().save(snapshot);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
allEvents.push(...added.events);
|
||||||
|
lastCId = added.cId;
|
||||||
|
}
|
||||||
|
|
||||||
|
const newState = pushUndo(undoRedoRef.current, snapshot);
|
||||||
|
undoRedoRef.current = newState;
|
||||||
|
setUndoRedoState(newState);
|
||||||
|
|
||||||
|
setEvents((prev) => [...prev, ...allEvents]);
|
||||||
|
return lastCId;
|
||||||
|
},
|
||||||
|
[makeStore, addOneFromBestiary],
|
||||||
|
);
|
||||||
|
|
||||||
const addFromPlayerCharacter = useCallback(
|
const addFromPlayerCharacter = useCallback(
|
||||||
(pc: PlayerCharacter) => {
|
(pc: PlayerCharacter) => {
|
||||||
|
const snapshot = encounterRef.current;
|
||||||
const store = makeStore();
|
const store = makeStore();
|
||||||
const existingNames = store.get().combatants.map((c) => c.name);
|
const existingNames = store.get().combatants.map((c) => c.name);
|
||||||
const { newName, renames } = resolveCreatureName(pc.name, existingNames);
|
const { newName, renames } = resolveCreatureName(pc.name, existingNames);
|
||||||
@@ -352,44 +397,39 @@ export function useEncounter() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const id = combatantId(`c-${++nextId.current}`);
|
const id = combatantId(`c-${++nextId.current}`);
|
||||||
const addResult = addCombatantUseCase(makeStore(), id, newName);
|
const result = addCombatantUseCase(makeStore(), id, newName, {
|
||||||
if (isDomainError(addResult)) return;
|
maxHp: pc.maxHp,
|
||||||
|
ac: pc.ac > 0 ? pc.ac : undefined,
|
||||||
// Set HP
|
color: pc.color,
|
||||||
const hpResult = setHpUseCase(makeStore(), id, pc.maxHp);
|
icon: pc.icon,
|
||||||
if (!isDomainError(hpResult)) {
|
playerCharacterId: pc.id,
|
||||||
setEvents((prev) => [...prev, ...hpResult]);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set AC
|
|
||||||
if (pc.ac > 0) {
|
|
||||||
const acResult = setAcUseCase(makeStore(), id, pc.ac);
|
|
||||||
if (!isDomainError(acResult)) {
|
|
||||||
setEvents((prev) => [...prev, ...acResult]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set color, icon, and playerCharacterId on the combatant
|
|
||||||
const currentEncounter = store.get();
|
|
||||||
store.save({
|
|
||||||
...currentEncounter,
|
|
||||||
combatants: currentEncounter.combatants.map((c) =>
|
|
||||||
c.id === id
|
|
||||||
? {
|
|
||||||
...c,
|
|
||||||
color: pc.color,
|
|
||||||
icon: pc.icon,
|
|
||||||
playerCharacterId: pc.id,
|
|
||||||
}
|
|
||||||
: c,
|
|
||||||
),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
setEvents((prev) => [...prev, ...addResult]);
|
if (isDomainError(result)) {
|
||||||
|
store.save(snapshot);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const newState = pushUndo(undoRedoRef.current, snapshot);
|
||||||
|
undoRedoRef.current = newState;
|
||||||
|
setUndoRedoState(newState);
|
||||||
|
|
||||||
|
setEvents((prev) => [...prev, ...result]);
|
||||||
},
|
},
|
||||||
[makeStore],
|
[makeStore],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const undoAction = useCallback(() => {
|
||||||
|
undoUseCase(makeStore(), makeUndoRedoStore());
|
||||||
|
}, [makeStore, makeUndoRedoStore]);
|
||||||
|
|
||||||
|
const redoAction = useCallback(() => {
|
||||||
|
redoUseCase(makeStore(), makeUndoRedoStore());
|
||||||
|
}, [makeStore, makeUndoRedoStore]);
|
||||||
|
|
||||||
|
const canUndo = undoRedoState.undoStack.length > 0;
|
||||||
|
const canRedo = undoRedoState.redoStack.length > 0;
|
||||||
|
|
||||||
const hasTempHp = encounter.combatants.some(
|
const hasTempHp = encounter.combatants.some(
|
||||||
(c) => c.tempHp !== undefined && c.tempHp > 0,
|
(c) => c.tempHp !== undefined && c.tempHp > 0,
|
||||||
);
|
);
|
||||||
@@ -409,6 +449,8 @@ export function useEncounter() {
|
|||||||
hasTempHp,
|
hasTempHp,
|
||||||
hasCreatureCombatants,
|
hasCreatureCombatants,
|
||||||
canRollAllInitiative,
|
canRollAllInitiative,
|
||||||
|
canUndo,
|
||||||
|
canRedo,
|
||||||
advanceTurn,
|
advanceTurn,
|
||||||
retreatTurn,
|
retreatTurn,
|
||||||
addCombatant,
|
addCombatant,
|
||||||
@@ -423,7 +465,11 @@ export function useEncounter() {
|
|||||||
toggleCondition,
|
toggleCondition,
|
||||||
toggleConcentration,
|
toggleConcentration,
|
||||||
addFromBestiary,
|
addFromBestiary,
|
||||||
|
addMultipleFromBestiary,
|
||||||
addFromPlayerCharacter,
|
addFromPlayerCharacter,
|
||||||
|
undo: undoAction,
|
||||||
|
redo: redoAction,
|
||||||
makeStore,
|
makeStore,
|
||||||
|
withUndo,
|
||||||
} as const;
|
} as const;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ function rollDice(): number {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function useInitiativeRolls() {
|
export function useInitiativeRolls() {
|
||||||
const { encounter, makeStore } = useEncounterContext();
|
const { encounter, makeStore, withUndo } = useEncounterContext();
|
||||||
const { getCreature } = useBestiaryContext();
|
const { getCreature } = useBestiaryContext();
|
||||||
const { showCreature } = useSidePanelContext();
|
const { showCreature } = useSidePanelContext();
|
||||||
|
|
||||||
@@ -28,12 +28,8 @@ export function useInitiativeRolls() {
|
|||||||
(id: CombatantId, mode: RollMode = "normal") => {
|
(id: CombatantId, mode: RollMode = "normal") => {
|
||||||
const diceRolls: [number, ...number[]] =
|
const diceRolls: [number, ...number[]] =
|
||||||
mode === "normal" ? [rollDice()] : [rollDice(), rollDice()];
|
mode === "normal" ? [rollDice()] : [rollDice(), rollDice()];
|
||||||
const result = rollInitiativeUseCase(
|
const result = withUndo(() =>
|
||||||
makeStore(),
|
rollInitiativeUseCase(makeStore(), id, diceRolls, getCreature, mode),
|
||||||
id,
|
|
||||||
diceRolls,
|
|
||||||
getCreature,
|
|
||||||
mode,
|
|
||||||
);
|
);
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
setRollSingleSkipped(true);
|
setRollSingleSkipped(true);
|
||||||
@@ -43,22 +39,19 @@ export function useInitiativeRolls() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
[makeStore, getCreature, encounter.combatants, showCreature],
|
[makeStore, getCreature, withUndo, encounter.combatants, showCreature],
|
||||||
);
|
);
|
||||||
|
|
||||||
const handleRollAllInitiative = useCallback(
|
const handleRollAllInitiative = useCallback(
|
||||||
(mode: RollMode = "normal") => {
|
(mode: RollMode = "normal") => {
|
||||||
const result = rollAllInitiativeUseCase(
|
const result = withUndo(() =>
|
||||||
makeStore(),
|
rollAllInitiativeUseCase(makeStore(), rollDice, getCreature, mode),
|
||||||
rollDice,
|
|
||||||
getCreature,
|
|
||||||
mode,
|
|
||||||
);
|
);
|
||||||
if (!isDomainError(result) && result.skippedNoSource > 0) {
|
if (!isDomainError(result) && result.skippedNoSource > 0) {
|
||||||
setRollSkippedCount(result.skippedNoSource);
|
setRollSkippedCount(result.skippedNoSource);
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
[makeStore, getCreature],
|
[makeStore, getCreature, withUndo],
|
||||||
);
|
);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
|||||||
@@ -39,6 +39,9 @@ function resolve(pref: ThemePreference): ResolvedTheme {
|
|||||||
|
|
||||||
function applyTheme(resolved: ResolvedTheme): void {
|
function applyTheme(resolved: ResolvedTheme): void {
|
||||||
document.documentElement.dataset.theme = resolved;
|
document.documentElement.dataset.theme = resolved;
|
||||||
|
document
|
||||||
|
.querySelector('meta[name="theme-color"]')
|
||||||
|
?.setAttribute("content", resolved === "light" ? "#eeecea" : "#0e1a2e");
|
||||||
}
|
}
|
||||||
|
|
||||||
function notifyAll(): void {
|
function notifyAll(): void {
|
||||||
|
|||||||
42
apps/web/src/hooks/use-undo-redo-shortcuts.ts
Normal file
42
apps/web/src/hooks/use-undo-redo-shortcuts.ts
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
import { useEffect } from "react";
|
||||||
|
|
||||||
|
const SUPPRESSED_TAGS = new Set(["INPUT", "TEXTAREA", "SELECT"]);
|
||||||
|
|
||||||
|
function isTextInputFocused(): boolean {
|
||||||
|
const active = document.activeElement;
|
||||||
|
if (!active) return false;
|
||||||
|
if (SUPPRESSED_TAGS.has(active.tagName)) return true;
|
||||||
|
return active instanceof HTMLElement && active.isContentEditable;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isUndoShortcut(e: KeyboardEvent): boolean {
|
||||||
|
return (e.ctrlKey || e.metaKey) && e.key.toLowerCase() === "z" && !e.shiftKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isRedoShortcut(e: KeyboardEvent): boolean {
|
||||||
|
return (e.ctrlKey || e.metaKey) && e.key.toLowerCase() === "z" && e.shiftKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useUndoRedoShortcuts(
|
||||||
|
undo: () => void,
|
||||||
|
redo: () => void,
|
||||||
|
canUndo: boolean,
|
||||||
|
canRedo: boolean,
|
||||||
|
): void {
|
||||||
|
useEffect(() => {
|
||||||
|
function handleKeyDown(e: KeyboardEvent) {
|
||||||
|
if (isTextInputFocused()) return;
|
||||||
|
|
||||||
|
if (isUndoShortcut(e) && canUndo) {
|
||||||
|
e.preventDefault();
|
||||||
|
undo();
|
||||||
|
} else if (isRedoShortcut(e) && canRedo) {
|
||||||
|
e.preventDefault();
|
||||||
|
redo();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
document.addEventListener("keydown", handleKeyDown);
|
||||||
|
return () => document.removeEventListener("keydown", handleKeyDown);
|
||||||
|
}, [undo, redo, canUndo, canRedo]);
|
||||||
|
}
|
||||||
@@ -108,45 +108,44 @@ function isValidCombatantEntry(c: unknown): boolean {
|
|||||||
return typeof entry.id === "string" && typeof entry.name === "string";
|
return typeof entry.id === "string" && typeof entry.name === "string";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function rehydrateEncounter(parsed: unknown): Encounter | null {
|
||||||
|
if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed))
|
||||||
|
return null;
|
||||||
|
|
||||||
|
const obj = parsed as Record<string, unknown>;
|
||||||
|
|
||||||
|
if (!Array.isArray(obj.combatants)) return null;
|
||||||
|
if (typeof obj.activeIndex !== "number") return null;
|
||||||
|
if (typeof obj.roundNumber !== "number") return null;
|
||||||
|
|
||||||
|
const combatants = obj.combatants as unknown[];
|
||||||
|
|
||||||
|
// Handle empty encounter (cleared state) directly — createEncounter rejects empty arrays
|
||||||
|
if (combatants.length === 0) {
|
||||||
|
return {
|
||||||
|
combatants: [],
|
||||||
|
activeIndex: 0,
|
||||||
|
roundNumber: 1,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!combatants.every(isValidCombatantEntry)) return null;
|
||||||
|
|
||||||
|
const rehydrated = combatants.map(rehydrateCombatant);
|
||||||
|
|
||||||
|
const result = createEncounter(rehydrated, obj.activeIndex, obj.roundNumber);
|
||||||
|
if (isDomainError(result)) return null;
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
export function loadEncounter(): Encounter | null {
|
export function loadEncounter(): Encounter | null {
|
||||||
try {
|
try {
|
||||||
const raw = localStorage.getItem(STORAGE_KEY);
|
const raw = localStorage.getItem(STORAGE_KEY);
|
||||||
if (raw === null) return null;
|
if (raw === null) return null;
|
||||||
|
|
||||||
const parsed: unknown = JSON.parse(raw);
|
const parsed: unknown = JSON.parse(raw);
|
||||||
|
return rehydrateEncounter(parsed);
|
||||||
if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed))
|
|
||||||
return null;
|
|
||||||
|
|
||||||
const obj = parsed as Record<string, unknown>;
|
|
||||||
|
|
||||||
if (!Array.isArray(obj.combatants)) return null;
|
|
||||||
if (typeof obj.activeIndex !== "number") return null;
|
|
||||||
if (typeof obj.roundNumber !== "number") return null;
|
|
||||||
|
|
||||||
const combatants = obj.combatants as unknown[];
|
|
||||||
|
|
||||||
// Handle empty encounter (cleared state) directly — createEncounter rejects empty arrays
|
|
||||||
if (combatants.length === 0) {
|
|
||||||
return {
|
|
||||||
combatants: [],
|
|
||||||
activeIndex: 0,
|
|
||||||
roundNumber: 1,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!combatants.every(isValidCombatantEntry)) return null;
|
|
||||||
|
|
||||||
const rehydrated = combatants.map(rehydrateCombatant);
|
|
||||||
|
|
||||||
const result = createEncounter(
|
|
||||||
rehydrated,
|
|
||||||
obj.activeIndex,
|
|
||||||
obj.roundNumber,
|
|
||||||
);
|
|
||||||
if (isDomainError(result)) return null;
|
|
||||||
|
|
||||||
return result;
|
|
||||||
} catch {
|
} catch {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|||||||
45
apps/web/src/persistence/undo-redo-storage.ts
Normal file
45
apps/web/src/persistence/undo-redo-storage.ts
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
import type { Encounter, UndoRedoState } from "@initiative/domain";
|
||||||
|
import { EMPTY_UNDO_REDO_STATE } from "@initiative/domain";
|
||||||
|
import { rehydrateEncounter } from "./encounter-storage.js";
|
||||||
|
|
||||||
|
const UNDO_KEY = "initiative:encounter:undo";
|
||||||
|
const REDO_KEY = "initiative:encounter:redo";
|
||||||
|
|
||||||
|
export function saveUndoRedoStacks(state: UndoRedoState): void {
|
||||||
|
try {
|
||||||
|
localStorage.setItem(UNDO_KEY, JSON.stringify(state.undoStack));
|
||||||
|
localStorage.setItem(REDO_KEY, JSON.stringify(state.redoStack));
|
||||||
|
} catch {
|
||||||
|
// Silently swallow errors (quota exceeded, storage unavailable)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadStack(key: string): readonly Encounter[] {
|
||||||
|
try {
|
||||||
|
const raw = localStorage.getItem(key);
|
||||||
|
if (raw === null) return [];
|
||||||
|
|
||||||
|
const parsed: unknown = JSON.parse(raw);
|
||||||
|
if (!Array.isArray(parsed)) return [];
|
||||||
|
|
||||||
|
const valid: Encounter[] = [];
|
||||||
|
for (const entry of parsed) {
|
||||||
|
const rehydrated = rehydrateEncounter(entry);
|
||||||
|
if (rehydrated !== null) {
|
||||||
|
valid.push(rehydrated);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return valid;
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function loadUndoRedoStacks(): UndoRedoState {
|
||||||
|
const undoStack = loadStack(UNDO_KEY);
|
||||||
|
const redoStack = loadStack(REDO_KEY);
|
||||||
|
if (undoStack.length === 0 && redoStack.length === 0) {
|
||||||
|
return EMPTY_UNDO_REDO_STATE;
|
||||||
|
}
|
||||||
|
return { undoStack, redoStack };
|
||||||
|
}
|
||||||
@@ -8,7 +8,9 @@
|
|||||||
"!.specify",
|
"!.specify",
|
||||||
"!specs",
|
"!specs",
|
||||||
"!coverage",
|
"!coverage",
|
||||||
"!.pnpm-store"
|
"!.pnpm-store",
|
||||||
|
"!.rodney",
|
||||||
|
"!.agent-tests"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"assist": {
|
"assist": {
|
||||||
|
|||||||
20
docs/adr/000-template.md
Normal file
20
docs/adr/000-template.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# ADR-NNN: [Title]
|
||||||
|
|
||||||
|
**Date**: YYYY-MM-DD
|
||||||
|
**Status**: accepted | superseded | deprecated
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
What is the problem or situation that motivates this decision?
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
What did we decide, and why?
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
What other approaches were evaluated?
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
What are the trade-offs — both positive and negative?
|
||||||
45
docs/adr/001-errors-as-values.md
Normal file
45
docs/adr/001-errors-as-values.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# ADR-001: Errors as Values, Not Exceptions
|
||||||
|
|
||||||
|
**Date**: 2026-03-25
|
||||||
|
**Status**: accepted
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Domain functions need to communicate failure (invalid input, missing combatant, violated invariants). The standard JavaScript approach is to throw exceptions, but thrown exceptions are invisible to TypeScript's type system — nothing in a function's signature tells the caller that it can fail or what errors to expect.
|
||||||
|
|
||||||
|
This project's domain layer is designed to be pure and deterministic. Thrown exceptions break both properties: they alter control flow (a side effect) and make the function's output unpredictable from the caller's perspective.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
All domain functions return `SuccessType | DomainError` unions. `DomainError` is a plain data object with a `kind` discriminant, a machine-readable `code`, and a human-readable `message`:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface DomainError {
|
||||||
|
readonly kind: "domain-error";
|
||||||
|
readonly code: string;
|
||||||
|
readonly message: string;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Callers check results with the `isDomainError()` type guard before accessing success data. Errors are never thrown in the domain layer (adapter-layer code may throw for programmer errors like missing providers).
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
**Thrown exceptions** — the JavaScript default. Simpler to write (`throw new Error(...)`) but error paths are invisible to the type system. The caller has no compile-time indication that a function can fail, and `catch` blocks lose type information about which errors are possible. Would also make domain functions impure.
|
||||||
|
|
||||||
|
**Result wrapper types** (e.g., `neverthrow`, `ts-results`) — formalizes the pattern with `.map()`, `.unwrap()`, `.match()` methods. More ergonomic for chaining operations, but adds a library dependency and a layer of indirection. The project's use cases are simple enough (call domain function, check error, save or return) that raw unions are sufficient.
|
||||||
|
|
||||||
|
**Validation libraries** (Zod, io-ts) — useful for input parsing but don't cover domain logic errors like "combatant not found" or "no previous turn". Would only address a subset of the problem.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
**Positive:**
|
||||||
|
- Error handling is compiler-enforced. Forgetting to check for an error produces a type error when accessing success fields.
|
||||||
|
- Domain functions remain pure — they return data, never alter control flow.
|
||||||
|
- Error codes are stable, machine-readable identifiers that UI code can match on.
|
||||||
|
- Testing is straightforward: assert the return value, no try/catch in tests.
|
||||||
|
|
||||||
|
**Negative:**
|
||||||
|
- Every call site must check `isDomainError()` before proceeding. This is slightly more verbose than a try/catch that wraps multiple calls.
|
||||||
|
- Composing multiple fallible operations requires manual chaining (check error, then call next function). A Result wrapper would make this more ergonomic if the codebase grows significantly.
|
||||||
|
- Contributors familiar with JavaScript conventions may initially find the pattern unfamiliar.
|
||||||
46
docs/adr/002-domain-events-as-plain-data.md
Normal file
46
docs/adr/002-domain-events-as-plain-data.md
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
# ADR-002: Domain Events as Plain Data Objects
|
||||||
|
|
||||||
|
**Date**: 2026-03-25
|
||||||
|
**Status**: accepted
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Domain state transitions need to communicate what happened (not just the new state) so the UI layer can react — showing toasts, auto-scrolling, opening panels, etc. The project needs an event mechanism that stays consistent with the pure, deterministic domain core.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Domain events are plain data objects with a `type` string discriminant. They form a discriminated union (`DomainEvent`) of 18 event types. Events are returned alongside the new state from domain functions, not emitted through a pub/sub system:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Example event
|
||||||
|
{ type: "TurnAdvanced", previousCombatantId: "abc", newCombatantId: "def", roundNumber: 2 }
|
||||||
|
|
||||||
|
// Domain function returns both state and events
|
||||||
|
function advanceTurn(encounter: Encounter): { encounter: Encounter; events: DomainEvent[] } | DomainError
|
||||||
|
```
|
||||||
|
|
||||||
|
Events are consumed ephemerally by the UI layer and are not persisted.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
**Class-based events** (e.g., `class TurnAdvanced extends DomainEvent { ... }`) — common in OOP-style domain-driven design. Adds inheritance hierarchies, constructors, and `instanceof` checks. No benefit here: TypeScript's discriminated union narrowing (`switch (event.type)`) provides the same exhaustiveness checking without classes. Classes also can't be serialized/deserialized without custom logic.
|
||||||
|
|
||||||
|
**Event emitter / pub-sub** (Node `EventEmitter`, custom bus, RxJS) — events are broadcast and listeners subscribe. Decouples producers from consumers, but introduces implicit coupling (who's listening?), ordering concerns, and makes the domain impure (emitting is a side effect). Harder to test — you'd need to set up listeners and collect results instead of just asserting on a return value.
|
||||||
|
|
||||||
|
**Observable streams** (RxJS) — powerful for async event processing and composition. Massive overkill for this use case: events are synchronous, produced one batch at a time, and consumed immediately. Would add a significant dependency and conceptual overhead.
|
||||||
|
|
||||||
|
**No events** (just compare old and new state) — the UI could diff states to determine what changed. Works for simple cases, but can't express intent (did HP drop because of damage or because max HP was lowered?) and gets unwieldy as the state model grows.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
**Positive:**
|
||||||
|
- Events are serializable (JSON-compatible). If the project ever adds undo/redo or event logging, no changes to the event format are needed.
|
||||||
|
- TypeScript's `switch (event.type)` provides exhaustiveness checking — the compiler warns if a new event type is added but not handled.
|
||||||
|
- No framework coupling. Events are just data; any consumer (React, a test, a CLI) can process them identically.
|
||||||
|
- Domain functions remain pure — events are returned, not emitted.
|
||||||
|
- Testing is trivial: assert that `result.events` contains the expected objects.
|
||||||
|
|
||||||
|
**Negative:**
|
||||||
|
- Events are currently consumed and discarded. There is no event log, replay, or undo capability. The architecture supports it, but it's not built.
|
||||||
|
- Adding a new event type requires updating the `DomainEvent` union, which touches a central file. This is intentional (forces explicit acknowledgment) but adds friction.
|
||||||
|
- No built-in mechanism for event handlers to communicate back (e.g., "veto this event"). Events are informational, not transactional.
|
||||||
53
docs/adr/003-branded-types-for-identity.md
Normal file
53
docs/adr/003-branded-types-for-identity.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# ADR-003: Branded Types for Identity Safety
|
||||||
|
|
||||||
|
**Date**: 2026-03-25
|
||||||
|
**Status**: accepted
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
The domain model has multiple entity types with string-based identifiers: combatants, creatures, and player characters. All IDs are strings at runtime (UUIDs or slug-based), making it easy to accidentally pass one ID type where another is expected. Such bugs are silent — the code compiles, runs, and only fails at runtime when a lookup returns `undefined` or mutates the wrong entity.
|
||||||
|
|
||||||
|
TypeScript's structural type system treats all `string` values as interchangeable, so a plain `string` type alias provides no protection.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Identity types use TypeScript branded types — a `string` intersected with a phantom `readonly __brand` property that exists only at the type level:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
type CombatantId = string & { readonly __brand: "CombatantId" };
|
||||||
|
type CreatureId = string & { readonly __brand: "CreatureId" };
|
||||||
|
type PlayerCharacterId = string & { readonly __brand: "PlayerCharacterId" };
|
||||||
|
```
|
||||||
|
|
||||||
|
Each type has a factory function that casts a plain string into the branded type:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
function combatantId(id: string): CombatantId {
|
||||||
|
return id as CombatantId;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `__brand` property is never assigned at runtime — it's a compile-time-only construct. The cast in the factory is the single point where the type system is "convinced" that the string carries the brand.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
**Plain `string` type aliases** (`type CombatantId = string`) — provides documentation value but zero type safety. TypeScript treats the alias as fully interchangeable with `string` and with all other string aliases. This is what most TypeScript codebases do, accepting the risk of ID confusion.
|
||||||
|
|
||||||
|
**Opaque types via unique symbols** (`declare const brand: unique symbol; type CombatantId = string & { [brand]: void }`) — stricter than the `__brand` approach because the symbol is truly unique and unexportable. Slightly more boilerplate and harder to read. The simpler `__brand` string approach provides sufficient safety for this codebase's scale.
|
||||||
|
|
||||||
|
**Wrapper classes** (`class CombatantId { constructor(public readonly value: string) {} }`) — provides nominal typing naturally, but introduces runtime overhead (object allocation, `.value` access everywhere), breaks JSON serialization, and doesn't play well with the project's preference for plain data over classes.
|
||||||
|
|
||||||
|
**Runtime validation** (check ID format at every function boundary) — catches errors at runtime but not at compile time. Adds overhead and doesn't prevent the bug from being written in the first place.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
**Positive:**
|
||||||
|
- Passing a `CreatureId` where a `CombatantId` is expected produces a compile-time error — the bug is caught before the code runs.
|
||||||
|
- Zero runtime cost. The brand is erased during compilation; at runtime, IDs are plain strings.
|
||||||
|
- JSON serialization works naturally — no custom serializers needed for persistence or network transport.
|
||||||
|
- Factory functions (`combatantId()`, `creatureId()`) serve as explicit construction points, making it clear where IDs originate.
|
||||||
|
|
||||||
|
**Negative:**
|
||||||
|
- The `as CombatantId` cast in factory functions is an escape hatch from the type system. If misused (casting arbitrary strings elsewhere), the safety guarantee is undermined. In practice, casts are confined to factory functions and adapter-layer deserialization.
|
||||||
|
- The `__brand` property appears in IDE autocomplete and hover tooltips, which can be confusing for developers unfamiliar with the pattern.
|
||||||
|
- Branded types are a community convention, not a TypeScript language feature. There is no official syntax or standard library support.
|
||||||
42
docs/adr/004-on-demand-bestiary-loading.md
Normal file
42
docs/adr/004-on-demand-bestiary-loading.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# ADR-004: On-Demand Bestiary Loading via Compact Index and IndexedDB Cache
|
||||||
|
|
||||||
|
**Date**: 2026-03-25
|
||||||
|
**Status**: accepted
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
The application integrates a D&D creature bestiary containing 3,300+ creatures from the 5etools dataset. The full bestiary data (stat blocks, traits, actions, spellcasting) is several megabytes of JSON. Bundling it directly into the application would create two problems: a large initial download for every user, and the distribution of copyrighted game content as part of the application bundle.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
The bestiary is split into two tiers:
|
||||||
|
|
||||||
|
1. **Compact search index** (`data/bestiary/index.json`, ~350KB) — shipped with the application bundle. Contains only the fields needed for search and display in the autocomplete dropdown: name, source, AC, HP, DEX, CR, initiative proficiency, size, and type. Field names are abbreviated (`n`, `s`, `ac`, `hp`, `dx`, `cr`, `ip`, `sz`, `tp`) to minimize file size. Generated offline by `scripts/generate-bestiary-index.mjs` from a local clone of the 5etools repository.
|
||||||
|
|
||||||
|
2. **On-demand source data** — full creature stat blocks are fetched per-source when a user first needs them (e.g., when viewing a stat block or adding a creature with HP/AC pre-fill). Fetched data is cached in IndexedDB (`initiative-bestiary` database) via the `idb` library, with an in-memory Map fallback when IndexedDB is unavailable. Users can also upload source files directly or bulk-import all sources.
|
||||||
|
|
||||||
|
The application never bundles or redistributes the full creature data. Users fetch it themselves from their own configured source URLs.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
**Bundle all bestiary data** — simplest approach, used during early development. Eliminated because it would distribute copyrighted content in the application bundle and inflate the initial download by several megabytes. Most users only need a fraction of the available sources.
|
||||||
|
|
||||||
|
**Server-side API** — a backend service could serve creature data on demand. This would keep the client lightweight and solve the bundle size concern, but the copyright issue remains — we would still be distributing copyrighted content, just from a server instead of a bundle. It also contradicts the project's local-first, single-user, no-backend architecture and would require hosting infrastructure and a network dependency for basic functionality.
|
||||||
|
|
||||||
|
**Service Worker with lazy caching** — fetch and cache bestiary data transparently via a Service Worker. More complex to implement and debug than explicit IndexedDB caching. The explicit approach gives users visibility and control over which sources are cached (via the source manager UI).
|
||||||
|
|
||||||
|
**localStorage for caching** — simpler API than IndexedDB, but localStorage has a ~5MB limit per origin, which is insufficient for multiple bestiary sources. IndexedDB has no practical storage limit.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
**Positive:**
|
||||||
|
- The application does not distribute copyrighted game content. Users fetch data from their own sources.
|
||||||
|
- Initial bundle stays small (~350KB for the search index). The full bestiary data is only downloaded when needed and then cached locally.
|
||||||
|
- Offline capability: once sources are cached in IndexedDB, creature data is available without network access.
|
||||||
|
- Users have explicit control over cached sources (import, clear, manage via UI).
|
||||||
|
|
||||||
|
**Negative:**
|
||||||
|
- First-time use requires fetching source data before full stat blocks are available. The bulk import feature mitigates this but requires an initial download.
|
||||||
|
- The search index must be regenerated manually when the upstream 5etools dataset changes. In practice this is infrequent (new D&D source books release a few times per year), so a manual process triggered by a new book release is sufficient at this scale.
|
||||||
|
- Two separate data representations (compact index vs full source) must be kept conceptually in sync. A creature that appears in the index but whose source hasn't been fetched will show limited information until the source is cached.
|
||||||
|
- IndexedDB adds adapter complexity (async API, database versioning, migration handling) compared to the synchronous localStorage used for encounter persistence.
|
||||||
58
docs/adr/005-all-quality-gates-at-pre-commit.md
Normal file
58
docs/adr/005-all-quality-gates-at-pre-commit.md
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
# ADR-005: All Quality Gates at Pre-Commit
|
||||||
|
|
||||||
|
**Date**: 2026-03-25
|
||||||
|
**Status**: accepted
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
This project is developed primarily through agentic coding — AI coding agents generate and modify code under human supervision. Agents are highly productive but can drift from established conventions, introduce subtle style inconsistencies, or produce code that compiles but doesn't meet the project's quality standards.
|
||||||
|
|
||||||
|
The conventional approach in most software projects is to keep pre-commit hooks lightweight (formatting, maybe linting) and defer heavier checks (tests, type checking, coverage, copy-paste detection) to CI pipelines. This optimizes for developer speed at commit time.
|
||||||
|
|
||||||
|
However, when working with AI agents, the dynamics are different. Agents iterate quickly and can fix issues immediately — but only if they receive feedback immediately. A failing CI pipeline minutes later breaks the feedback loop: the agent's context has moved on, and the human must re-engage to address the failure.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
All quality gates run at pre-commit via Lefthook, as a single sequential `pnpm check` command. No gate may exist only as a CI step or as a manual process. The full gate sequence is:
|
||||||
|
|
||||||
|
1. `pnpm audit --audit-level=high` — security vulnerability scan
|
||||||
|
2. `knip` — unused code detection
|
||||||
|
3. `biome check .` — linting and formatting (50+ rules)
|
||||||
|
4. `oxlint --tsconfig ... --type-aware` — type-aware linting
|
||||||
|
5. `check-lint-ignores.mjs` — caps biome-ignore directives
|
||||||
|
6. `check-cn-classnames.mjs` — bans template-literal classNames
|
||||||
|
7. `check-component-props.mjs` — max 8 props per component
|
||||||
|
8. `tsc --build` — TypeScript type checking
|
||||||
|
9. `vitest run` — tests with per-path coverage thresholds
|
||||||
|
10. `jscpd` — copy-paste detection
|
||||||
|
|
||||||
|
Layer boundary enforcement runs as a Vitest test within step 9.
|
||||||
|
|
||||||
|
This takes ~8 seconds on the current codebase. Every commit is guaranteed to pass all checks.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
**Lightweight pre-commit, full checks in CI** — the industry default. Pre-commit runs only formatting and basic linting; tests, type checking, and coverage run in a CI pipeline. This is faster at commit time but creates a delayed feedback loop. For agentic coding workflows, this delay is costly: the agent produces a commit, moves on, and the CI failure arrives minutes later when context has shifted. The human must re-engage the agent with the failure context, losing the tight iteration loop.
|
||||||
|
|
||||||
|
**No pre-commit hooks, CI only** — maximum commit speed, all enforcement in CI. Risks accumulating multiple broken commits before issues surface. Particularly problematic with agents that commit frequently.
|
||||||
|
|
||||||
|
**Selective pre-commit (fast checks only)** — run formatting, linting, and type checking at pre-commit; defer tests and coverage to CI as a compromise. Still breaks the feedback loop for test failures and coverage regressions, which are the checks most likely to catch agent-introduced bugs.
|
||||||
|
|
||||||
|
**Per-change hooks (e.g., Claude Code hooks)** — run checks after every file edit or tool call, not just at commit time. This is an even tighter feedback loop than pre-commit: the agent learns about a violation seconds after introducing it, before more code is written on top of it. Claude Code supports hooks that trigger on events like `PostToolUse`, which could run linting or type checking after every file write.
|
||||||
|
|
||||||
|
However, running the full gate after every edit breaks test-driven workflows: writing a test before its implementation, or updating implementation before updating tests, produces intermediate states that legitimately fail type checking or tests. Scoping hooks to only fast, non-breaking checks (formatting, linting) would avoid this, but splits the gate into two tiers — adding complexity for unclear benefit when pre-commit already catches everything within ~8 seconds.
|
||||||
|
|
||||||
|
Pre-commit is the current sweet spot: tight enough that agents get feedback in the same context window, but not so tight that it interferes with red-green-refactor or incremental editing. Per-change hooks remain a future option if the codebase grows to a point where pre-commit becomes too slow.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
**Positive:**
|
||||||
|
- Early backpressure in short feedback loops. Agents receive immediate, comprehensive feedback on every commit attempt. If a check fails, the agent can fix it in the same context window, maintaining continuity.
|
||||||
|
- Every commit on `main` is guaranteed to pass all quality gates. There is no state where "it compiled but the tests are broken" or "formatting drifted."
|
||||||
|
- No CI/local divergence. The same checks run everywhere, eliminating "works on my machine" or "CI caught something pre-commit didn't."
|
||||||
|
- Enforces discipline incrementally: each commit is small, clean, and complete rather than "I'll fix the tests later."
|
||||||
|
|
||||||
|
**Negative:**
|
||||||
|
- ~8 seconds per commit attempt. This is acceptable for the current codebase size but will grow with the test suite. If it exceeds ~15 seconds, selective pre-commit with CI for the rest may become necessary.
|
||||||
|
- Developers (or agents) cannot make quick "WIP" or "checkpoint" commits without passing all gates. This is intentional — every commit should be a valid state — but it prevents some workflows like committing broken code to switch branches.
|
||||||
|
- The sequential chain means a failure in step 1 (audit) prevents discovering failures in step 9 (tests). In practice, this rarely matters because failures are fixed immediately and the chain is re-run.
|
||||||
@@ -3,7 +3,8 @@
|
|||||||
"packageManager": "pnpm@10.32.1+sha512.a706938f0e89ac1456b6563eab4edf1d1faf3368d1191fc5c59790e96dc918e4456ab2e67d613de1043d2e8c81f87303e6b40d4ffeca9df15ef1ad567348f2be",
|
"packageManager": "pnpm@10.32.1+sha512.a706938f0e89ac1456b6563eab4edf1d1faf3368d1191fc5c59790e96dc918e4456ab2e67d613de1043d2e8c81f87303e6b40d4ffeca9df15ef1ad567348f2be",
|
||||||
"pnpm": {
|
"pnpm": {
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"undici": ">=7.24.0"
|
"undici": ">=7.24.0",
|
||||||
|
"picomatch": ">=4.0.4"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import {
|
import {
|
||||||
addCombatant,
|
addCombatant,
|
||||||
type CombatantId,
|
type CombatantId,
|
||||||
|
type CombatantInit,
|
||||||
type DomainError,
|
type DomainError,
|
||||||
type DomainEvent,
|
type DomainEvent,
|
||||||
isDomainError,
|
isDomainError,
|
||||||
@@ -11,9 +12,10 @@ export function addCombatantUseCase(
|
|||||||
store: EncounterStore,
|
store: EncounterStore,
|
||||||
id: CombatantId,
|
id: CombatantId,
|
||||||
name: string,
|
name: string,
|
||||||
|
init?: CombatantInit,
|
||||||
): DomainEvent[] | DomainError {
|
): DomainEvent[] | DomainError {
|
||||||
const encounter = store.get();
|
const encounter = store.get();
|
||||||
const result = addCombatant(encounter, id, name);
|
const result = addCombatant(encounter, id, name, init);
|
||||||
|
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
return result;
|
return result;
|
||||||
|
|||||||
@@ -10,7 +10,9 @@ export type {
|
|||||||
BestiarySourceCache,
|
BestiarySourceCache,
|
||||||
EncounterStore,
|
EncounterStore,
|
||||||
PlayerCharacterStore,
|
PlayerCharacterStore,
|
||||||
|
UndoRedoStore,
|
||||||
} from "./ports.js";
|
} from "./ports.js";
|
||||||
|
export { redoUseCase } from "./redo-use-case.js";
|
||||||
export { removeCombatantUseCase } from "./remove-combatant-use-case.js";
|
export { removeCombatantUseCase } from "./remove-combatant-use-case.js";
|
||||||
export { retreatTurnUseCase } from "./retreat-turn-use-case.js";
|
export { retreatTurnUseCase } from "./retreat-turn-use-case.js";
|
||||||
export {
|
export {
|
||||||
@@ -24,3 +26,4 @@ export { setInitiativeUseCase } from "./set-initiative-use-case.js";
|
|||||||
export { setTempHpUseCase } from "./set-temp-hp-use-case.js";
|
export { setTempHpUseCase } from "./set-temp-hp-use-case.js";
|
||||||
export { toggleConcentrationUseCase } from "./toggle-concentration-use-case.js";
|
export { toggleConcentrationUseCase } from "./toggle-concentration-use-case.js";
|
||||||
export { toggleConditionUseCase } from "./toggle-condition-use-case.js";
|
export { toggleConditionUseCase } from "./toggle-condition-use-case.js";
|
||||||
|
export { undoUseCase } from "./undo-use-case.js";
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import type {
|
|||||||
CreatureId,
|
CreatureId,
|
||||||
Encounter,
|
Encounter,
|
||||||
PlayerCharacter,
|
PlayerCharacter,
|
||||||
|
UndoRedoState,
|
||||||
} from "@initiative/domain";
|
} from "@initiative/domain";
|
||||||
|
|
||||||
export interface EncounterStore {
|
export interface EncounterStore {
|
||||||
@@ -19,3 +20,8 @@ export interface PlayerCharacterStore {
|
|||||||
getAll(): PlayerCharacter[];
|
getAll(): PlayerCharacter[];
|
||||||
save(characters: PlayerCharacter[]): void;
|
save(characters: PlayerCharacter[]): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface UndoRedoStore {
|
||||||
|
get(): UndoRedoState;
|
||||||
|
save(state: UndoRedoState): void;
|
||||||
|
}
|
||||||
|
|||||||
24
packages/application/src/redo-use-case.ts
Normal file
24
packages/application/src/redo-use-case.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import {
|
||||||
|
type DomainError,
|
||||||
|
type Encounter,
|
||||||
|
isDomainError,
|
||||||
|
redo,
|
||||||
|
} from "@initiative/domain";
|
||||||
|
import type { EncounterStore, UndoRedoStore } from "./ports.js";
|
||||||
|
|
||||||
|
export function redoUseCase(
|
||||||
|
encounterStore: EncounterStore,
|
||||||
|
undoRedoStore: UndoRedoStore,
|
||||||
|
): Encounter | DomainError {
|
||||||
|
const current = encounterStore.get();
|
||||||
|
const state = undoRedoStore.get();
|
||||||
|
const result = redo(state, current);
|
||||||
|
|
||||||
|
if (isDomainError(result)) {
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
encounterStore.save(result.encounter);
|
||||||
|
undoRedoStore.save(result.state);
|
||||||
|
return result.encounter;
|
||||||
|
}
|
||||||
24
packages/application/src/undo-use-case.ts
Normal file
24
packages/application/src/undo-use-case.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import {
|
||||||
|
type DomainError,
|
||||||
|
type Encounter,
|
||||||
|
isDomainError,
|
||||||
|
undo,
|
||||||
|
} from "@initiative/domain";
|
||||||
|
import type { EncounterStore, UndoRedoStore } from "./ports.js";
|
||||||
|
|
||||||
|
export function undoUseCase(
|
||||||
|
encounterStore: EncounterStore,
|
||||||
|
undoRedoStore: UndoRedoStore,
|
||||||
|
): Encounter | DomainError {
|
||||||
|
const current = encounterStore.get();
|
||||||
|
const state = undoRedoStore.get();
|
||||||
|
const result = undo(state, current);
|
||||||
|
|
||||||
|
if (isDomainError(result)) {
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
encounterStore.save(result.encounter);
|
||||||
|
undoRedoStore.save(result.state);
|
||||||
|
return result.encounter;
|
||||||
|
}
|
||||||
@@ -1,13 +1,18 @@
|
|||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it } from "vitest";
|
||||||
import { addCombatant } from "../add-combatant.js";
|
import { addCombatant, type CombatantInit } from "../add-combatant.js";
|
||||||
|
import { creatureId } from "../creature-types.js";
|
||||||
|
import { playerCharacterId } from "../player-character-types.js";
|
||||||
import type { Combatant, Encounter } from "../types.js";
|
import type { Combatant, Encounter } from "../types.js";
|
||||||
import { combatantId, isDomainError } from "../types.js";
|
import { combatantId, isDomainError } from "../types.js";
|
||||||
import { expectDomainError } from "./test-helpers.js";
|
import { expectDomainError } from "./test-helpers.js";
|
||||||
|
|
||||||
// --- Helpers ---
|
// --- Helpers ---
|
||||||
|
|
||||||
function makeCombatant(name: string): Combatant {
|
function makeCombatant(
|
||||||
return { id: combatantId(name), name };
|
name: string,
|
||||||
|
overrides?: Partial<Combatant>,
|
||||||
|
): Combatant {
|
||||||
|
return { id: combatantId(name), name, ...overrides };
|
||||||
}
|
}
|
||||||
|
|
||||||
const A = makeCombatant("A");
|
const A = makeCombatant("A");
|
||||||
@@ -22,8 +27,13 @@ function enc(
|
|||||||
return { combatants, activeIndex, roundNumber };
|
return { combatants, activeIndex, roundNumber };
|
||||||
}
|
}
|
||||||
|
|
||||||
function successResult(encounter: Encounter, id: string, name: string) {
|
function successResult(
|
||||||
const result = addCombatant(encounter, combatantId(id), name);
|
encounter: Encounter,
|
||||||
|
id: string,
|
||||||
|
name: string,
|
||||||
|
init?: CombatantInit,
|
||||||
|
) {
|
||||||
|
const result = addCombatant(encounter, combatantId(id), name, init);
|
||||||
if (isDomainError(result)) {
|
if (isDomainError(result)) {
|
||||||
throw new Error(`Expected success, got error: ${result.message}`);
|
throw new Error(`Expected success, got error: ${result.message}`);
|
||||||
}
|
}
|
||||||
@@ -190,4 +200,152 @@ describe("addCombatant", () => {
|
|||||||
expect(encounter.combatants[1]).toEqual(B);
|
expect(encounter.combatants[1]).toEqual(B);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("with CombatantInit", () => {
|
||||||
|
it("creates combatant with maxHp and currentHp set to maxHp", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const { encounter } = successResult(e, "orc", "Orc", {
|
||||||
|
maxHp: 15,
|
||||||
|
});
|
||||||
|
const c = encounter.combatants[0];
|
||||||
|
expect(c.maxHp).toBe(15);
|
||||||
|
expect(c.currentHp).toBe(15);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("creates combatant with ac", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const { encounter } = successResult(e, "orc", "Orc", {
|
||||||
|
ac: 13,
|
||||||
|
});
|
||||||
|
expect(encounter.combatants[0].ac).toBe(13);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("creates combatant with initiative and sorts into position", () => {
|
||||||
|
const hi = makeCombatant("Hi", { initiative: 20 });
|
||||||
|
const lo = makeCombatant("Lo", { initiative: 10 });
|
||||||
|
const e = enc([hi, lo]);
|
||||||
|
|
||||||
|
const { encounter } = successResult(e, "mid", "Mid", {
|
||||||
|
initiative: 15,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(encounter.combatants.map((c) => c.name)).toEqual([
|
||||||
|
"Hi",
|
||||||
|
"Mid",
|
||||||
|
"Lo",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects invalid maxHp (non-integer)", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const result = addCombatant(e, combatantId("x"), "X", {
|
||||||
|
maxHp: 1.5,
|
||||||
|
});
|
||||||
|
expectDomainError(result, "invalid-max-hp");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects invalid maxHp (zero)", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const result = addCombatant(e, combatantId("x"), "X", {
|
||||||
|
maxHp: 0,
|
||||||
|
});
|
||||||
|
expectDomainError(result, "invalid-max-hp");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects invalid ac (negative)", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const result = addCombatant(e, combatantId("x"), "X", {
|
||||||
|
ac: -1,
|
||||||
|
});
|
||||||
|
expectDomainError(result, "invalid-ac");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects invalid initiative (non-integer)", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const result = addCombatant(e, combatantId("x"), "X", {
|
||||||
|
initiative: 3.5,
|
||||||
|
});
|
||||||
|
expectDomainError(result, "invalid-initiative");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("creates combatant with creatureId", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const cId = creatureId("srd:goblin");
|
||||||
|
const { encounter } = successResult(e, "gob", "Goblin", {
|
||||||
|
creatureId: cId,
|
||||||
|
});
|
||||||
|
expect(encounter.combatants[0].creatureId).toBe(cId);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("creates combatant with color and icon", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const { encounter } = successResult(e, "pc", "Aria", {
|
||||||
|
color: "blue",
|
||||||
|
icon: "sword",
|
||||||
|
});
|
||||||
|
const c = encounter.combatants[0];
|
||||||
|
expect(c.color).toBe("blue");
|
||||||
|
expect(c.icon).toBe("sword");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("creates combatant with playerCharacterId", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const pcId = playerCharacterId("pc-1");
|
||||||
|
const { encounter } = successResult(e, "pc", "Aria", {
|
||||||
|
playerCharacterId: pcId,
|
||||||
|
});
|
||||||
|
expect(encounter.combatants[0].playerCharacterId).toBe(pcId);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("creates combatant with all init fields", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const cId = creatureId("srd:orc");
|
||||||
|
const pcId = playerCharacterId("pc-1");
|
||||||
|
const { encounter } = successResult(e, "orc", "Orc", {
|
||||||
|
maxHp: 15,
|
||||||
|
ac: 13,
|
||||||
|
initiative: 12,
|
||||||
|
creatureId: cId,
|
||||||
|
color: "red",
|
||||||
|
icon: "axe",
|
||||||
|
playerCharacterId: pcId,
|
||||||
|
});
|
||||||
|
const c = encounter.combatants[0];
|
||||||
|
expect(c.maxHp).toBe(15);
|
||||||
|
expect(c.currentHp).toBe(15);
|
||||||
|
expect(c.ac).toBe(13);
|
||||||
|
expect(c.initiative).toBe(12);
|
||||||
|
expect(c.creatureId).toBe(cId);
|
||||||
|
expect(c.color).toBe("red");
|
||||||
|
expect(c.icon).toBe("axe");
|
||||||
|
expect(c.playerCharacterId).toBe(pcId);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("CombatantAdded event includes init", () => {
|
||||||
|
const e = enc([]);
|
||||||
|
const { events } = successResult(e, "orc", "Orc", {
|
||||||
|
maxHp: 15,
|
||||||
|
ac: 13,
|
||||||
|
});
|
||||||
|
expect(events[0]).toMatchObject({
|
||||||
|
type: "CombatantAdded",
|
||||||
|
init: { maxHp: 15, ac: 13 },
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("preserves activeIndex through initiative sort", () => {
|
||||||
|
const hi = makeCombatant("Hi", { initiative: 20 });
|
||||||
|
const lo = makeCombatant("Lo", { initiative: 10 });
|
||||||
|
// Lo is active (index 1)
|
||||||
|
const e = enc([hi, lo], 1);
|
||||||
|
|
||||||
|
const { encounter } = successResult(e, "mid", "Mid", {
|
||||||
|
initiative: 15,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Lo should still be active after sort
|
||||||
|
const loIdx = encounter.combatants.findIndex((c) => c.name === "Lo");
|
||||||
|
expect(encounter.activeIndex).toBe(loIdx);
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { describe, expect, it } from "vitest";
|
|||||||
import {
|
import {
|
||||||
CONDITION_DEFINITIONS,
|
CONDITION_DEFINITIONS,
|
||||||
getConditionDescription,
|
getConditionDescription,
|
||||||
|
getConditionsForEdition,
|
||||||
} from "../conditions.js";
|
} from "../conditions.js";
|
||||||
|
|
||||||
function findCondition(id: string) {
|
function findCondition(id: string) {
|
||||||
@@ -25,13 +26,27 @@ describe("getConditionDescription", () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("every condition has both descriptions", () => {
|
it("universal conditions have both descriptions", () => {
|
||||||
for (const def of CONDITION_DEFINITIONS) {
|
const universal = CONDITION_DEFINITIONS.filter(
|
||||||
|
(d) => d.edition === undefined,
|
||||||
|
);
|
||||||
|
expect(universal.length).toBeGreaterThan(0);
|
||||||
|
for (const def of universal) {
|
||||||
expect(def.description).toBeTruthy();
|
expect(def.description).toBeTruthy();
|
||||||
expect(def.description5e).toBeTruthy();
|
expect(def.description5e).toBeTruthy();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("edition-specific conditions have their edition description", () => {
|
||||||
|
const sapped = findCondition("sapped");
|
||||||
|
expect(sapped.description).toBeTruthy();
|
||||||
|
expect(sapped.edition).toBe("5.5e");
|
||||||
|
|
||||||
|
const slowed = findCondition("slowed");
|
||||||
|
expect(slowed.description).toBeTruthy();
|
||||||
|
expect(slowed.edition).toBe("5.5e");
|
||||||
|
});
|
||||||
|
|
||||||
it("conditions with identical rules share the same text", () => {
|
it("conditions with identical rules share the same text", () => {
|
||||||
const blinded = findCondition("blinded");
|
const blinded = findCondition("blinded");
|
||||||
expect(blinded.description).toBe(blinded.description5e);
|
expect(blinded.description).toBe(blinded.description5e);
|
||||||
@@ -42,3 +57,26 @@ describe("getConditionDescription", () => {
|
|||||||
expect(exhaustion.description).not.toBe(exhaustion.description5e);
|
expect(exhaustion.description).not.toBe(exhaustion.description5e);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("getConditionsForEdition", () => {
|
||||||
|
it("includes sapped and slowed for 5.5e", () => {
|
||||||
|
const conditions = getConditionsForEdition("5.5e");
|
||||||
|
const ids = conditions.map((d) => d.id);
|
||||||
|
expect(ids).toContain("sapped");
|
||||||
|
expect(ids).toContain("slowed");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("excludes sapped and slowed for 5e", () => {
|
||||||
|
const conditions = getConditionsForEdition("5e");
|
||||||
|
const ids = conditions.map((d) => d.id);
|
||||||
|
expect(ids).not.toContain("sapped");
|
||||||
|
expect(ids).not.toContain("slowed");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("includes universal conditions for both editions", () => {
|
||||||
|
const ids5e = getConditionsForEdition("5e").map((d) => d.id);
|
||||||
|
const ids55e = getConditionsForEdition("5.5e").map((d) => d.id);
|
||||||
|
expect(ids5e).toContain("blinded");
|
||||||
|
expect(ids55e).toContain("blinded");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
124
packages/domain/src/__tests__/undo-redo.test.ts
Normal file
124
packages/domain/src/__tests__/undo-redo.test.ts
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import type { Encounter } from "../types.js";
|
||||||
|
import { isDomainError } from "../types.js";
|
||||||
|
import {
|
||||||
|
clearHistory,
|
||||||
|
EMPTY_UNDO_REDO_STATE,
|
||||||
|
pushUndo,
|
||||||
|
redo,
|
||||||
|
undo,
|
||||||
|
} from "../undo-redo.js";
|
||||||
|
|
||||||
|
function enc(roundNumber = 1, activeIndex = 0): Encounter {
|
||||||
|
return { combatants: [], activeIndex, roundNumber };
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("pushUndo", () => {
|
||||||
|
it("adds a snapshot to the undo stack", () => {
|
||||||
|
const result = pushUndo(EMPTY_UNDO_REDO_STATE, enc(1));
|
||||||
|
expect(result.undoStack).toHaveLength(1);
|
||||||
|
expect(result.undoStack[0]).toEqual(enc(1));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("clears the redo stack", () => {
|
||||||
|
const state = {
|
||||||
|
undoStack: [enc(1)],
|
||||||
|
redoStack: [enc(2)],
|
||||||
|
};
|
||||||
|
const result = pushUndo(state, enc(3));
|
||||||
|
expect(result.redoStack).toHaveLength(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("caps the undo stack at 50, dropping the oldest", () => {
|
||||||
|
const undoStack = Array.from({ length: 50 }, (_, i) => enc(i + 1));
|
||||||
|
const state = { undoStack, redoStack: [] };
|
||||||
|
const result = pushUndo(state, enc(51));
|
||||||
|
expect(result.undoStack).toHaveLength(50);
|
||||||
|
expect(result.undoStack[0]).toEqual(enc(2));
|
||||||
|
expect(result.undoStack[49]).toEqual(enc(51));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("undo", () => {
|
||||||
|
it("pops from undo stack and pushes current to redo stack", () => {
|
||||||
|
const state = { undoStack: [enc(1)], redoStack: [] };
|
||||||
|
const result = undo(state, enc(2));
|
||||||
|
expect(isDomainError(result)).toBe(false);
|
||||||
|
if (isDomainError(result)) return;
|
||||||
|
expect(result.encounter).toEqual(enc(1));
|
||||||
|
expect(result.state.undoStack).toHaveLength(0);
|
||||||
|
expect(result.state.redoStack).toEqual([enc(2)]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns domain error when undo stack is empty", () => {
|
||||||
|
const result = undo(EMPTY_UNDO_REDO_STATE, enc(1));
|
||||||
|
expect(isDomainError(result)).toBe(true);
|
||||||
|
if (!isDomainError(result)) return;
|
||||||
|
expect(result.code).toBe("nothing-to-undo");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("pops the most recent entry (last in stack)", () => {
|
||||||
|
const state = { undoStack: [enc(1), enc(2), enc(3)], redoStack: [] };
|
||||||
|
const result = undo(state, enc(4));
|
||||||
|
expect(isDomainError(result)).toBe(false);
|
||||||
|
if (isDomainError(result)) return;
|
||||||
|
expect(result.encounter).toEqual(enc(3));
|
||||||
|
expect(result.state.undoStack).toEqual([enc(1), enc(2)]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("redo", () => {
|
||||||
|
it("pops from redo stack and pushes current to undo stack", () => {
|
||||||
|
const state = { undoStack: [], redoStack: [enc(1)] };
|
||||||
|
const result = redo(state, enc(2));
|
||||||
|
expect(isDomainError(result)).toBe(false);
|
||||||
|
if (isDomainError(result)) return;
|
||||||
|
expect(result.encounter).toEqual(enc(1));
|
||||||
|
expect(result.state.redoStack).toHaveLength(0);
|
||||||
|
expect(result.state.undoStack).toEqual([enc(2)]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns domain error when redo stack is empty", () => {
|
||||||
|
const result = redo(EMPTY_UNDO_REDO_STATE, enc(1));
|
||||||
|
expect(isDomainError(result)).toBe(true);
|
||||||
|
if (!isDomainError(result)) return;
|
||||||
|
expect(result.code).toBe("nothing-to-redo");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("pops the most recent entry (last in stack)", () => {
|
||||||
|
const state = { undoStack: [], redoStack: [enc(1), enc(2), enc(3)] };
|
||||||
|
const result = redo(state, enc(4));
|
||||||
|
expect(isDomainError(result)).toBe(false);
|
||||||
|
if (isDomainError(result)) return;
|
||||||
|
expect(result.encounter).toEqual(enc(3));
|
||||||
|
expect(result.state.redoStack).toEqual([enc(1), enc(2)]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("undo-then-redo roundtrip", () => {
|
||||||
|
it("returns the exact same encounter after undo then redo", () => {
|
||||||
|
const original = enc(5);
|
||||||
|
const current = enc(6);
|
||||||
|
const afterPush = pushUndo(EMPTY_UNDO_REDO_STATE, original);
|
||||||
|
|
||||||
|
const undoResult = undo(afterPush, current);
|
||||||
|
expect(isDomainError(undoResult)).toBe(false);
|
||||||
|
if (isDomainError(undoResult)) return;
|
||||||
|
|
||||||
|
expect(undoResult.encounter).toEqual(original);
|
||||||
|
|
||||||
|
const redoResult = redo(undoResult.state, undoResult.encounter);
|
||||||
|
expect(isDomainError(redoResult)).toBe(false);
|
||||||
|
if (isDomainError(redoResult)) return;
|
||||||
|
|
||||||
|
expect(redoResult.encounter).toEqual(current);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("clearHistory", () => {
|
||||||
|
it("empties both stacks", () => {
|
||||||
|
const result = clearHistory();
|
||||||
|
expect(result.undoStack).toHaveLength(0);
|
||||||
|
expect(result.redoStack).toHaveLength(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,24 +1,94 @@
|
|||||||
|
import type { CreatureId } from "./creature-types.js";
|
||||||
import type { DomainEvent } from "./events.js";
|
import type { DomainEvent } from "./events.js";
|
||||||
import type { CombatantId, DomainError, Encounter } from "./types.js";
|
import { sortByInitiative } from "./initiative-sort.js";
|
||||||
|
import type { PlayerCharacterId } from "./player-character-types.js";
|
||||||
|
import type {
|
||||||
|
Combatant,
|
||||||
|
CombatantId,
|
||||||
|
DomainError,
|
||||||
|
Encounter,
|
||||||
|
} from "./types.js";
|
||||||
|
|
||||||
|
export interface CombatantInit {
|
||||||
|
readonly maxHp?: number;
|
||||||
|
readonly ac?: number;
|
||||||
|
readonly initiative?: number;
|
||||||
|
readonly creatureId?: CreatureId;
|
||||||
|
readonly color?: string;
|
||||||
|
readonly icon?: string;
|
||||||
|
readonly playerCharacterId?: PlayerCharacterId;
|
||||||
|
}
|
||||||
|
|
||||||
export interface AddCombatantSuccess {
|
export interface AddCombatantSuccess {
|
||||||
readonly encounter: Encounter;
|
readonly encounter: Encounter;
|
||||||
readonly events: DomainEvent[];
|
readonly events: DomainEvent[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function validateInit(init: CombatantInit): DomainError | undefined {
|
||||||
|
if (
|
||||||
|
init.maxHp !== undefined &&
|
||||||
|
(!Number.isInteger(init.maxHp) || init.maxHp < 1)
|
||||||
|
) {
|
||||||
|
return {
|
||||||
|
kind: "domain-error",
|
||||||
|
code: "invalid-max-hp",
|
||||||
|
message: `Max HP must be a positive integer, got ${init.maxHp}`,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (init.ac !== undefined && (!Number.isInteger(init.ac) || init.ac < 0)) {
|
||||||
|
return {
|
||||||
|
kind: "domain-error",
|
||||||
|
code: "invalid-ac",
|
||||||
|
message: `AC must be a non-negative integer, got ${init.ac}`,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (init.initiative !== undefined && !Number.isInteger(init.initiative)) {
|
||||||
|
return {
|
||||||
|
kind: "domain-error",
|
||||||
|
code: "invalid-initiative",
|
||||||
|
message: `Initiative must be an integer, got ${init.initiative}`,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildCombatant(
|
||||||
|
id: CombatantId,
|
||||||
|
name: string,
|
||||||
|
init?: CombatantInit,
|
||||||
|
): Combatant {
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
name,
|
||||||
|
...(init?.maxHp !== undefined && {
|
||||||
|
maxHp: init.maxHp,
|
||||||
|
currentHp: init.maxHp,
|
||||||
|
}),
|
||||||
|
...(init?.ac !== undefined && { ac: init.ac }),
|
||||||
|
...(init?.initiative !== undefined && { initiative: init.initiative }),
|
||||||
|
...(init?.creatureId !== undefined && { creatureId: init.creatureId }),
|
||||||
|
...(init?.color !== undefined && { color: init.color }),
|
||||||
|
...(init?.icon !== undefined && { icon: init.icon }),
|
||||||
|
...(init?.playerCharacterId !== undefined && {
|
||||||
|
playerCharacterId: init.playerCharacterId,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Pure function that adds a combatant to the end of an encounter's list.
|
* Pure function that adds a combatant to the end of an encounter's list.
|
||||||
*
|
*
|
||||||
* FR-001: Accepts an Encounter, CombatantId, and name; returns next state + events.
|
* FR-001: Accepts an Encounter, CombatantId, and name; returns next state + events.
|
||||||
* FR-002: Appends new combatant to end of combatants list.
|
* FR-002: Appends new combatant to end of combatants list.
|
||||||
* FR-004: Rejects empty/whitespace-only names with DomainError.
|
* FR-004: Rejects empty/whitespace-only names with DomainError.
|
||||||
* FR-005: Does not alter activeIndex or roundNumber.
|
* FR-005: Does not alter activeIndex or roundNumber (unless initiative triggers sort).
|
||||||
* FR-006: Events returned as values, not dispatched via side effects.
|
* FR-006: Events returned as values, not dispatched via side effects.
|
||||||
*/
|
*/
|
||||||
export function addCombatant(
|
export function addCombatant(
|
||||||
encounter: Encounter,
|
encounter: Encounter,
|
||||||
id: CombatantId,
|
id: CombatantId,
|
||||||
name: string,
|
name: string,
|
||||||
|
init?: CombatantInit,
|
||||||
): AddCombatantSuccess | DomainError {
|
): AddCombatantSuccess | DomainError {
|
||||||
const trimmed = name.trim();
|
const trimmed = name.trim();
|
||||||
|
|
||||||
@@ -30,12 +100,35 @@ export function addCombatant(
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
const position = encounter.combatants.length;
|
if (init) {
|
||||||
|
const error = validateInit(init);
|
||||||
|
if (error) return error;
|
||||||
|
}
|
||||||
|
|
||||||
|
const newCombatant = buildCombatant(id, trimmed, init);
|
||||||
|
let combatants: readonly Combatant[] = [
|
||||||
|
...encounter.combatants,
|
||||||
|
newCombatant,
|
||||||
|
];
|
||||||
|
let activeIndex = encounter.activeIndex;
|
||||||
|
|
||||||
|
if (init?.initiative !== undefined) {
|
||||||
|
const activeCombatantId =
|
||||||
|
encounter.combatants.length > 0
|
||||||
|
? encounter.combatants[encounter.activeIndex].id
|
||||||
|
: id;
|
||||||
|
|
||||||
|
const result = sortByInitiative(combatants, activeCombatantId);
|
||||||
|
combatants = result.sorted;
|
||||||
|
activeIndex = result.activeIndex;
|
||||||
|
}
|
||||||
|
|
||||||
|
const position = combatants.findIndex((c) => c.id === id);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
encounter: {
|
encounter: {
|
||||||
combatants: [...encounter.combatants, { id, name: trimmed }],
|
combatants,
|
||||||
activeIndex: encounter.activeIndex,
|
activeIndex,
|
||||||
roundNumber: encounter.roundNumber,
|
roundNumber: encounter.roundNumber,
|
||||||
},
|
},
|
||||||
events: [
|
events: [
|
||||||
@@ -44,6 +137,7 @@ export function addCombatant(
|
|||||||
combatantId: id,
|
combatantId: id,
|
||||||
name: trimmed,
|
name: trimmed,
|
||||||
position,
|
position,
|
||||||
|
init,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -12,6 +12,8 @@ export type ConditionId =
|
|||||||
| "poisoned"
|
| "poisoned"
|
||||||
| "prone"
|
| "prone"
|
||||||
| "restrained"
|
| "restrained"
|
||||||
|
| "sapped"
|
||||||
|
| "slowed"
|
||||||
| "stunned"
|
| "stunned"
|
||||||
| "unconscious";
|
| "unconscious";
|
||||||
|
|
||||||
@@ -24,6 +26,8 @@ export interface ConditionDefinition {
|
|||||||
readonly description5e: string;
|
readonly description5e: string;
|
||||||
readonly iconName: string;
|
readonly iconName: string;
|
||||||
readonly color: string;
|
readonly color: string;
|
||||||
|
/** When set, the condition only appears in this edition's picker. */
|
||||||
|
readonly edition?: RulesEdition;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getConditionDescription(
|
export function getConditionDescription(
|
||||||
@@ -159,6 +163,26 @@ export const CONDITION_DEFINITIONS: readonly ConditionDefinition[] = [
|
|||||||
iconName: "Link",
|
iconName: "Link",
|
||||||
color: "neutral",
|
color: "neutral",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
id: "sapped",
|
||||||
|
label: "Sapped",
|
||||||
|
description:
|
||||||
|
"Disadvantage on next attack roll before the start of your next turn. (Weapon Mastery: Sap)",
|
||||||
|
description5e: "",
|
||||||
|
iconName: "ShieldMinus",
|
||||||
|
color: "amber",
|
||||||
|
edition: "5.5e",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "slowed",
|
||||||
|
label: "Slowed",
|
||||||
|
description:
|
||||||
|
"Speed reduced by 10 ft. until the start of your next turn. (Weapon Mastery: Slow)",
|
||||||
|
description5e: "",
|
||||||
|
iconName: "Snail",
|
||||||
|
color: "sky",
|
||||||
|
edition: "5.5e",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
id: "stunned",
|
id: "stunned",
|
||||||
label: "Stunned",
|
label: "Stunned",
|
||||||
@@ -184,3 +208,11 @@ export const CONDITION_DEFINITIONS: readonly ConditionDefinition[] = [
|
|||||||
export const VALID_CONDITION_IDS: ReadonlySet<string> = new Set(
|
export const VALID_CONDITION_IDS: ReadonlySet<string> = new Set(
|
||||||
CONDITION_DEFINITIONS.map((d) => d.id),
|
CONDITION_DEFINITIONS.map((d) => d.id),
|
||||||
);
|
);
|
||||||
|
|
||||||
|
export function getConditionsForEdition(
|
||||||
|
edition: RulesEdition,
|
||||||
|
): readonly ConditionDefinition[] {
|
||||||
|
return CONDITION_DEFINITIONS.filter(
|
||||||
|
(d) => d.edition === undefined || d.edition === edition,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
import type { ConditionId } from "./conditions.js";
|
import type { ConditionId } from "./conditions.js";
|
||||||
|
import type { CreatureId } from "./creature-types.js";
|
||||||
import type { PlayerCharacterId } from "./player-character-types.js";
|
import type { PlayerCharacterId } from "./player-character-types.js";
|
||||||
import type { CombatantId } from "./types.js";
|
import type { CombatantId } from "./types.js";
|
||||||
|
|
||||||
@@ -19,6 +20,15 @@ export interface CombatantAdded {
|
|||||||
readonly combatantId: CombatantId;
|
readonly combatantId: CombatantId;
|
||||||
readonly name: string;
|
readonly name: string;
|
||||||
readonly position: number;
|
readonly position: number;
|
||||||
|
readonly init?: {
|
||||||
|
readonly maxHp?: number;
|
||||||
|
readonly ac?: number;
|
||||||
|
readonly initiative?: number;
|
||||||
|
readonly creatureId?: CreatureId;
|
||||||
|
readonly color?: string;
|
||||||
|
readonly icon?: string;
|
||||||
|
readonly playerCharacterId?: PlayerCharacterId;
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface CombatantRemoved {
|
export interface CombatantRemoved {
|
||||||
|
|||||||
@@ -1,4 +1,8 @@
|
|||||||
export { type AddCombatantSuccess, addCombatant } from "./add-combatant.js";
|
export {
|
||||||
|
type AddCombatantSuccess,
|
||||||
|
addCombatant,
|
||||||
|
type CombatantInit,
|
||||||
|
} from "./add-combatant.js";
|
||||||
export { type AdjustHpSuccess, adjustHp } from "./adjust-hp.js";
|
export { type AdjustHpSuccess, adjustHp } from "./adjust-hp.js";
|
||||||
export { advanceTurn } from "./advance-turn.js";
|
export { advanceTurn } from "./advance-turn.js";
|
||||||
export { resolveCreatureName } from "./auto-number.js";
|
export { resolveCreatureName } from "./auto-number.js";
|
||||||
@@ -11,6 +15,7 @@ export {
|
|||||||
type ConditionDefinition,
|
type ConditionDefinition,
|
||||||
type ConditionId,
|
type ConditionId,
|
||||||
getConditionDescription,
|
getConditionDescription,
|
||||||
|
getConditionsForEdition,
|
||||||
type RulesEdition,
|
type RulesEdition,
|
||||||
VALID_CONDITION_IDS,
|
VALID_CONDITION_IDS,
|
||||||
} from "./conditions.js";
|
} from "./conditions.js";
|
||||||
@@ -116,3 +121,11 @@ export {
|
|||||||
type Encounter,
|
type Encounter,
|
||||||
isDomainError,
|
isDomainError,
|
||||||
} from "./types.js";
|
} from "./types.js";
|
||||||
|
export {
|
||||||
|
clearHistory,
|
||||||
|
EMPTY_UNDO_REDO_STATE,
|
||||||
|
pushUndo,
|
||||||
|
redo,
|
||||||
|
type UndoRedoState,
|
||||||
|
undo,
|
||||||
|
} from "./undo-redo.js";
|
||||||
|
|||||||
35
packages/domain/src/initiative-sort.ts
Normal file
35
packages/domain/src/initiative-sort.ts
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
import type { Combatant, CombatantId } from "./types.js";
|
||||||
|
|
||||||
|
interface Indexed {
|
||||||
|
readonly c: Combatant;
|
||||||
|
readonly i: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
function compareByInitiative(a: Indexed, b: Indexed): number {
|
||||||
|
const aHas = a.c.initiative !== undefined;
|
||||||
|
const bHas = b.c.initiative !== undefined;
|
||||||
|
if (aHas && bHas) {
|
||||||
|
const diff = b.c.initiative - a.c.initiative;
|
||||||
|
return diff === 0 ? a.i - b.i : diff;
|
||||||
|
}
|
||||||
|
if (aHas && !bHas) return -1;
|
||||||
|
if (!aHas && bHas) return 1;
|
||||||
|
return a.i - b.i;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stable-sorts combatants by initiative (descending), preserving relative
|
||||||
|
* order for ties and for combatants without initiative. Returns the sorted
|
||||||
|
* list and the new activeIndex that tracks the given active combatant
|
||||||
|
* through the reorder.
|
||||||
|
*/
|
||||||
|
export function sortByInitiative(
|
||||||
|
combatants: readonly Combatant[],
|
||||||
|
activeCombatantId: CombatantId,
|
||||||
|
): { sorted: readonly Combatant[]; activeIndex: number } {
|
||||||
|
const indexed = combatants.map((c, i) => ({ c, i }));
|
||||||
|
indexed.sort(compareByInitiative);
|
||||||
|
const sorted = indexed.map(({ c }) => c);
|
||||||
|
const idx = sorted.findIndex((c) => c.id === activeCombatantId);
|
||||||
|
return { sorted, activeIndex: idx === -1 ? 0 : idx };
|
||||||
|
}
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
import type { DomainEvent } from "./events.js";
|
import type { DomainEvent } from "./events.js";
|
||||||
|
import { sortByInitiative } from "./initiative-sort.js";
|
||||||
import type { CombatantId, DomainError, Encounter } from "./types.js";
|
import type { CombatantId, DomainError, Encounter } from "./types.js";
|
||||||
|
|
||||||
export interface SetInitiativeSuccess {
|
export interface SetInitiativeSuccess {
|
||||||
@@ -44,45 +45,21 @@ export function setInitiative(
|
|||||||
const target = encounter.combatants[targetIdx];
|
const target = encounter.combatants[targetIdx];
|
||||||
const previousValue = target.initiative;
|
const previousValue = target.initiative;
|
||||||
|
|
||||||
// Record active combatant's id before reorder
|
|
||||||
const activeCombatantId =
|
|
||||||
encounter.combatants.length > 0
|
|
||||||
? encounter.combatants[encounter.activeIndex].id
|
|
||||||
: undefined;
|
|
||||||
|
|
||||||
// Create new combatants array with updated initiative
|
// Create new combatants array with updated initiative
|
||||||
const updated = encounter.combatants.map((c) =>
|
const updated = encounter.combatants.map((c) =>
|
||||||
c.id === combatantId ? { ...c, initiative: value } : c,
|
c.id === combatantId ? { ...c, initiative: value } : c,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Stable sort: initiative descending, undefined last
|
// Record active combatant's id before reorder
|
||||||
const indexed = updated.map((c, i) => ({ c, i }));
|
const activeCombatantId =
|
||||||
indexed.sort((a, b) => {
|
encounter.combatants.length > 0
|
||||||
const aHas = a.c.initiative !== undefined;
|
? encounter.combatants[encounter.activeIndex].id
|
||||||
const bHas = b.c.initiative !== undefined;
|
: combatantId;
|
||||||
|
|
||||||
if (aHas && bHas) {
|
const { sorted, activeIndex: newActiveIndex } = sortByInitiative(
|
||||||
const aInit = a.c.initiative as number;
|
updated,
|
||||||
const bInit = b.c.initiative as number;
|
activeCombatantId,
|
||||||
const diff = bInit - aInit;
|
);
|
||||||
return diff === 0 ? a.i - b.i : diff;
|
|
||||||
}
|
|
||||||
if (aHas && !bHas) return -1;
|
|
||||||
if (!aHas && bHas) return 1;
|
|
||||||
// Both undefined — preserve relative order
|
|
||||||
return a.i - b.i;
|
|
||||||
});
|
|
||||||
|
|
||||||
const sorted = indexed.map(({ c }) => c);
|
|
||||||
|
|
||||||
// Find active combatant's new index
|
|
||||||
let newActiveIndex = encounter.activeIndex;
|
|
||||||
if (activeCombatantId !== undefined) {
|
|
||||||
const idx = sorted.findIndex((c) => c.id === activeCombatantId);
|
|
||||||
if (idx !== -1) {
|
|
||||||
newActiveIndex = idx;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
encounter: {
|
encounter: {
|
||||||
|
|||||||
70
packages/domain/src/undo-redo.ts
Normal file
70
packages/domain/src/undo-redo.ts
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
import type { DomainError, Encounter } from "./types.js";
|
||||||
|
|
||||||
|
export interface UndoRedoState {
|
||||||
|
readonly undoStack: readonly Encounter[];
|
||||||
|
readonly redoStack: readonly Encounter[];
|
||||||
|
}
|
||||||
|
|
||||||
|
const MAX_UNDO_STACK = 50;
|
||||||
|
|
||||||
|
export const EMPTY_UNDO_REDO_STATE: UndoRedoState = {
|
||||||
|
undoStack: [],
|
||||||
|
redoStack: [],
|
||||||
|
};
|
||||||
|
|
||||||
|
export function pushUndo(
|
||||||
|
state: UndoRedoState,
|
||||||
|
snapshot: Encounter,
|
||||||
|
): UndoRedoState {
|
||||||
|
const newStack = [...state.undoStack, snapshot];
|
||||||
|
if (newStack.length > MAX_UNDO_STACK) {
|
||||||
|
newStack.shift();
|
||||||
|
}
|
||||||
|
return { undoStack: newStack, redoStack: [] };
|
||||||
|
}
|
||||||
|
|
||||||
|
export function undo(
|
||||||
|
state: UndoRedoState,
|
||||||
|
currentEncounter: Encounter,
|
||||||
|
): { state: UndoRedoState; encounter: Encounter } | DomainError {
|
||||||
|
if (state.undoStack.length === 0) {
|
||||||
|
return {
|
||||||
|
kind: "domain-error",
|
||||||
|
code: "nothing-to-undo",
|
||||||
|
message: "Nothing to undo",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
const restored = state.undoStack.at(-1) as Encounter;
|
||||||
|
return {
|
||||||
|
state: {
|
||||||
|
undoStack: state.undoStack.slice(0, -1),
|
||||||
|
redoStack: [...state.redoStack, currentEncounter],
|
||||||
|
},
|
||||||
|
encounter: restored,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function redo(
|
||||||
|
state: UndoRedoState,
|
||||||
|
currentEncounter: Encounter,
|
||||||
|
): { state: UndoRedoState; encounter: Encounter } | DomainError {
|
||||||
|
if (state.redoStack.length === 0) {
|
||||||
|
return {
|
||||||
|
kind: "domain-error",
|
||||||
|
code: "nothing-to-redo",
|
||||||
|
message: "Nothing to redo",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
const restored = state.redoStack.at(-1) as Encounter;
|
||||||
|
return {
|
||||||
|
state: {
|
||||||
|
undoStack: [...state.undoStack, currentEncounter],
|
||||||
|
redoStack: state.redoStack.slice(0, -1),
|
||||||
|
},
|
||||||
|
encounter: restored,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function clearHistory(): UndoRedoState {
|
||||||
|
return EMPTY_UNDO_REDO_STATE;
|
||||||
|
}
|
||||||
31
pnpm-lock.yaml
generated
31
pnpm-lock.yaml
generated
@@ -6,6 +6,7 @@ settings:
|
|||||||
|
|
||||||
overrides:
|
overrides:
|
||||||
undici: '>=7.24.0'
|
undici: '>=7.24.0'
|
||||||
|
picomatch: '>=4.0.4'
|
||||||
|
|
||||||
importers:
|
importers:
|
||||||
|
|
||||||
@@ -1082,7 +1083,7 @@ packages:
|
|||||||
resolution: {integrity: sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==}
|
resolution: {integrity: sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==}
|
||||||
engines: {node: '>=12.0.0'}
|
engines: {node: '>=12.0.0'}
|
||||||
peerDependencies:
|
peerDependencies:
|
||||||
picomatch: ^3 || ^4
|
picomatch: '>=4.0.4'
|
||||||
peerDependenciesMeta:
|
peerDependenciesMeta:
|
||||||
picomatch:
|
picomatch:
|
||||||
optional: true
|
optional: true
|
||||||
@@ -1507,12 +1508,8 @@ packages:
|
|||||||
picocolors@1.1.1:
|
picocolors@1.1.1:
|
||||||
resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==}
|
resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==}
|
||||||
|
|
||||||
picomatch@2.3.1:
|
picomatch@4.0.4:
|
||||||
resolution: {integrity: sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==}
|
resolution: {integrity: sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==}
|
||||||
engines: {node: '>=8.6'}
|
|
||||||
|
|
||||||
picomatch@4.0.3:
|
|
||||||
resolution: {integrity: sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==}
|
|
||||||
engines: {node: '>=12'}
|
engines: {node: '>=12'}
|
||||||
|
|
||||||
postcss@8.5.8:
|
postcss@8.5.8:
|
||||||
@@ -2663,9 +2660,9 @@ snapshots:
|
|||||||
dependencies:
|
dependencies:
|
||||||
walk-up-path: 4.0.0
|
walk-up-path: 4.0.0
|
||||||
|
|
||||||
fdir@6.5.0(picomatch@4.0.3):
|
fdir@6.5.0(picomatch@4.0.4):
|
||||||
optionalDependencies:
|
optionalDependencies:
|
||||||
picomatch: 4.0.3
|
picomatch: 4.0.4
|
||||||
|
|
||||||
fill-range@7.1.1:
|
fill-range@7.1.1:
|
||||||
dependencies:
|
dependencies:
|
||||||
@@ -2865,7 +2862,7 @@ snapshots:
|
|||||||
minimist: 1.2.8
|
minimist: 1.2.8
|
||||||
oxc-resolver: 11.19.1
|
oxc-resolver: 11.19.1
|
||||||
picocolors: 1.1.1
|
picocolors: 1.1.1
|
||||||
picomatch: 4.0.3
|
picomatch: 4.0.4
|
||||||
smol-toml: 1.6.0
|
smol-toml: 1.6.0
|
||||||
strip-json-comments: 5.0.3
|
strip-json-comments: 5.0.3
|
||||||
typescript: 5.9.3
|
typescript: 5.9.3
|
||||||
@@ -3002,7 +2999,7 @@ snapshots:
|
|||||||
micromatch@4.0.8:
|
micromatch@4.0.8:
|
||||||
dependencies:
|
dependencies:
|
||||||
braces: 3.0.3
|
braces: 3.0.3
|
||||||
picomatch: 2.3.1
|
picomatch: 4.0.4
|
||||||
|
|
||||||
mimic-fn@2.1.0: {}
|
mimic-fn@2.1.0: {}
|
||||||
|
|
||||||
@@ -3100,9 +3097,7 @@ snapshots:
|
|||||||
|
|
||||||
picocolors@1.1.1: {}
|
picocolors@1.1.1: {}
|
||||||
|
|
||||||
picomatch@2.3.1: {}
|
picomatch@4.0.4: {}
|
||||||
|
|
||||||
picomatch@4.0.3: {}
|
|
||||||
|
|
||||||
postcss@8.5.8:
|
postcss@8.5.8:
|
||||||
dependencies:
|
dependencies:
|
||||||
@@ -3315,8 +3310,8 @@ snapshots:
|
|||||||
|
|
||||||
tinyglobby@0.2.15:
|
tinyglobby@0.2.15:
|
||||||
dependencies:
|
dependencies:
|
||||||
fdir: 6.5.0(picomatch@4.0.3)
|
fdir: 6.5.0(picomatch@4.0.4)
|
||||||
picomatch: 4.0.3
|
picomatch: 4.0.4
|
||||||
|
|
||||||
tinyrainbow@3.1.0: {}
|
tinyrainbow@3.1.0: {}
|
||||||
|
|
||||||
@@ -3356,7 +3351,7 @@ snapshots:
|
|||||||
vite@8.0.1(@types/node@25.3.3)(jiti@2.6.1)(yaml@2.8.3):
|
vite@8.0.1(@types/node@25.3.3)(jiti@2.6.1)(yaml@2.8.3):
|
||||||
dependencies:
|
dependencies:
|
||||||
lightningcss: 1.32.0
|
lightningcss: 1.32.0
|
||||||
picomatch: 4.0.3
|
picomatch: 4.0.4
|
||||||
postcss: 8.5.8
|
postcss: 8.5.8
|
||||||
rolldown: 1.0.0-rc.10
|
rolldown: 1.0.0-rc.10
|
||||||
tinyglobby: 0.2.15
|
tinyglobby: 0.2.15
|
||||||
@@ -3380,7 +3375,7 @@ snapshots:
|
|||||||
magic-string: 0.30.21
|
magic-string: 0.30.21
|
||||||
obug: 2.1.1
|
obug: 2.1.1
|
||||||
pathe: 2.0.3
|
pathe: 2.0.3
|
||||||
picomatch: 4.0.3
|
picomatch: 4.0.4
|
||||||
std-env: 4.0.0
|
std-env: 4.0.0
|
||||||
tinybench: 2.9.0
|
tinybench: 2.9.0
|
||||||
tinyexec: 1.0.4
|
tinyexec: 1.0.4
|
||||||
|
|||||||
35
specs/037-undo-redo/checklists/requirements.md
Normal file
35
specs/037-undo-redo/checklists/requirements.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
# Specification Quality Checklist: Undo/Redo
|
||||||
|
|
||||||
|
**Purpose**: Validate specification completeness and quality before proceeding to planning
|
||||||
|
**Created**: 2026-03-26
|
||||||
|
**Feature**: [spec.md](../spec.md)
|
||||||
|
|
||||||
|
## Content Quality
|
||||||
|
|
||||||
|
- [x] No implementation details (languages, frameworks, APIs)
|
||||||
|
- [x] Focused on user value and business needs
|
||||||
|
- [x] Written for non-technical stakeholders
|
||||||
|
- [x] All mandatory sections completed
|
||||||
|
|
||||||
|
## Requirement Completeness
|
||||||
|
|
||||||
|
- [x] No [NEEDS CLARIFICATION] markers remain
|
||||||
|
- [x] Requirements are testable and unambiguous
|
||||||
|
- [x] Success criteria are measurable
|
||||||
|
- [x] Success criteria are technology-agnostic (no implementation details)
|
||||||
|
- [x] All acceptance scenarios are defined
|
||||||
|
- [x] Edge cases are identified
|
||||||
|
- [x] Scope is clearly bounded
|
||||||
|
- [x] Dependencies and assumptions identified
|
||||||
|
|
||||||
|
## Feature Readiness
|
||||||
|
|
||||||
|
- [x] All functional requirements have clear acceptance criteria
|
||||||
|
- [x] User scenarios cover primary flows
|
||||||
|
- [x] Feature meets measurable outcomes defined in Success Criteria
|
||||||
|
- [x] No implementation details leak into specification
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- All items pass. The spec references "memento pattern" and "localStorage" — these are architectural intent from the issue itself, not implementation leakage. The spec describes *what* (snapshot-based history, persisted to local storage) not *how* (no code structure, no framework APIs).
|
||||||
|
- The "Assumptions" section documents the localStorage sizing assumption and the dependency on #15 being resolved.
|
||||||
83
specs/037-undo-redo/data-model.md
Normal file
83
specs/037-undo-redo/data-model.md
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
# Data Model: Undo/Redo
|
||||||
|
|
||||||
|
**Feature**: 037-undo-redo
|
||||||
|
**Date**: 2026-03-26
|
||||||
|
|
||||||
|
## Entities
|
||||||
|
|
||||||
|
### UndoRedoState
|
||||||
|
|
||||||
|
Represents the complete undo/redo history for an encounter session.
|
||||||
|
|
||||||
|
| Field | Type | Description |
|
||||||
|
|-------|------|-------------|
|
||||||
|
| undoStack | Encounter[] | Ordered list of encounter snapshots, most recent last. Max 50 entries. |
|
||||||
|
| redoStack | Encounter[] | Ordered list of encounter snapshots accumulated by undo operations. Cleared on any new action. |
|
||||||
|
|
||||||
|
### Encounter (existing, unchanged)
|
||||||
|
|
||||||
|
Each stack entry is a full `Encounter` snapshot as defined in `packages/domain/src/types.ts`. No schema changes to the encounter type.
|
||||||
|
|
||||||
|
| Field | Type | Description |
|
||||||
|
|-------|------|-------------|
|
||||||
|
| combatants | Combatant[] | Ordered list of combatants |
|
||||||
|
| activeIndex | number | Index of the active combatant |
|
||||||
|
| roundNumber | number | Current round number |
|
||||||
|
|
||||||
|
## State Transitions
|
||||||
|
|
||||||
|
### pushUndo(state, snapshot) -> UndoRedoState
|
||||||
|
|
||||||
|
Push a snapshot onto the undo stack. If the stack exceeds 50 entries, drop the oldest (index 0). Clear the redo stack.
|
||||||
|
|
||||||
|
**Precondition**: snapshot is a valid Encounter
|
||||||
|
**Postcondition**: undoStack length <= 50, redoStack is empty
|
||||||
|
|
||||||
|
### undo(state, currentEncounter) -> { state: UndoRedoState, encounter: Encounter } | DomainError
|
||||||
|
|
||||||
|
Pop the most recent snapshot from the undo stack. Push the current encounter onto the redo stack. Return the popped snapshot as the new current encounter.
|
||||||
|
|
||||||
|
**Precondition**: undoStack is non-empty
|
||||||
|
**Postcondition**: undoStack length decremented by 1, redoStack length incremented by 1
|
||||||
|
**Error**: "nothing-to-undo" if undoStack is empty
|
||||||
|
|
||||||
|
### redo(state, currentEncounter) -> { state: UndoRedoState, encounter: Encounter } | DomainError
|
||||||
|
|
||||||
|
Pop the most recent snapshot from the redo stack. Push the current encounter onto the undo stack. Return the popped snapshot as the new current encounter.
|
||||||
|
|
||||||
|
**Precondition**: redoStack is non-empty
|
||||||
|
**Postcondition**: redoStack length decremented by 1, undoStack length incremented by 1
|
||||||
|
**Error**: "nothing-to-redo" if redoStack is empty
|
||||||
|
|
||||||
|
### clearHistory() -> UndoRedoState
|
||||||
|
|
||||||
|
Reset both stacks to empty. Used when the encounter is cleared.
|
||||||
|
|
||||||
|
**Postcondition**: undoStack and redoStack are both empty
|
||||||
|
|
||||||
|
## Persistence
|
||||||
|
|
||||||
|
### Storage Keys
|
||||||
|
|
||||||
|
| Key | Content | Format |
|
||||||
|
|-----|---------|--------|
|
||||||
|
| `initiative:encounter:undo` | Undo stack | JSON array of serialized Encounter objects |
|
||||||
|
| `initiative:encounter:redo` | Redo stack | JSON array of serialized Encounter objects |
|
||||||
|
|
||||||
|
### Serialization
|
||||||
|
|
||||||
|
Stacks are serialized as JSON arrays of `Encounter` objects, identical to the existing encounter serialization format. On load, each entry is validated using the same rehydration logic as `loadEncounter()`.
|
||||||
|
|
||||||
|
### Failure Modes
|
||||||
|
|
||||||
|
- **localStorage quota exceeded**: Stacks continue in-memory; persistence is best-effort. Silently swallow write errors (matching existing encounter persistence pattern).
|
||||||
|
- **Corrupt data on load**: Start with empty stacks. Log no error (matching existing pattern).
|
||||||
|
- **Schema mismatch after upgrade**: Invalid entries are dropped during rehydration; stacks may be shorter than persisted but never contain invalid data.
|
||||||
|
|
||||||
|
## Invariants
|
||||||
|
|
||||||
|
1. `undoStack.length <= 50` at all times
|
||||||
|
2. `redoStack` is empty after any non-undo/redo action
|
||||||
|
3. `undoStack.length + redoStack.length` represents the total history depth (not capped as a whole — redo can grow up to 50 if all actions are undone)
|
||||||
|
4. Each stack entry is a valid, complete `Encounter` snapshot
|
||||||
|
5. Undo followed by redo returns the encounter to the exact same state
|
||||||
71
specs/037-undo-redo/plan.md
Normal file
71
specs/037-undo-redo/plan.md
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
# Implementation Plan: Undo/Redo
|
||||||
|
|
||||||
|
**Branch**: `037-undo-redo` | **Date**: 2026-03-26 | **Spec**: [spec.md](spec.md)
|
||||||
|
**Input**: Feature specification from `/specs/037-undo-redo/spec.md`
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Add undo/redo capability for all encounter state changes using the memento pattern. Before each state transition, the current `Encounter` is pushed to an undo stack (capped at 50 entries). Undo restores the previous snapshot and pushes the current state to a redo stack; any new action clears the redo stack. Stacks are persisted to localStorage. Triggered via UI buttons (disabled when empty) and keyboard shortcuts (Ctrl+Z / Ctrl+Shift+Z, Cmd on Mac), suppressed during text input focus.
|
||||||
|
|
||||||
|
## Technical Context
|
||||||
|
|
||||||
|
**Language/Version**: TypeScript 5.8 (strict mode, `verbatimModuleSyntax`)
|
||||||
|
**Primary Dependencies**: React 19, Vite 6, Tailwind CSS v4, Lucide React (icons)
|
||||||
|
**Storage**: localStorage (existing key `"initiative:encounter"`, new keys for undo/redo stacks)
|
||||||
|
**Testing**: Vitest (v8 coverage)
|
||||||
|
**Target Platform**: Web browser (desktop + mobile)
|
||||||
|
**Project Type**: Web application (monorepo: `apps/web` + `packages/domain` + `packages/application`)
|
||||||
|
**Performance Goals**: Undo/redo operations complete in < 1 second (per SC-001)
|
||||||
|
**Constraints**: Undo stack capped at 50 snapshots; localStorage quota is best-effort
|
||||||
|
**Scale/Scope**: Encounters have tens of combatants; 50 snapshots of ~2-5 KB each = ~100-250 KB
|
||||||
|
|
||||||
|
## Constitution Check
|
||||||
|
|
||||||
|
*GATE: Must pass before Phase 0 research. Re-check after Phase 1 design.*
|
||||||
|
|
||||||
|
| Principle | Status | Notes |
|
||||||
|
|-----------|--------|-------|
|
||||||
|
| I. Deterministic Domain Core | PASS | Stack management (push, pop, cap) is pure logic with no I/O. Domain functions remain unchanged. |
|
||||||
|
| II. Layered Architecture | PASS | Stack operations are pure functions in domain. Persistence is in the adapter layer (localStorage). Hook orchestrates via application pattern. |
|
||||||
|
| II-A. Context-Based State Flow | PASS | Undo/redo state exposed via existing EncounterContext. No new props needed on components beyond the context consumer. |
|
||||||
|
| III. Clarification-First | PASS | No ambiguities remain; issue #16 and spec fully define behavior. |
|
||||||
|
| IV. Escalation Gates | PASS | All requirements come from the spec; no scope expansion. |
|
||||||
|
| V. MVP Baseline Language | PASS | No permanent bans introduced. |
|
||||||
|
| VI. No Gameplay Rules | PASS | Undo/redo is infrastructure, not gameplay. |
|
||||||
|
|
||||||
|
**Result**: All gates pass. No violations to justify.
|
||||||
|
|
||||||
|
## Project Structure
|
||||||
|
|
||||||
|
### Documentation (this feature)
|
||||||
|
|
||||||
|
```text
|
||||||
|
specs/037-undo-redo/
|
||||||
|
├── plan.md # This file
|
||||||
|
├── research.md # Phase 0 output
|
||||||
|
├── data-model.md # Phase 1 output
|
||||||
|
├── quickstart.md # Phase 1 output
|
||||||
|
└── tasks.md # Phase 2 output (/speckit.tasks)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Source Code (repository root)
|
||||||
|
|
||||||
|
```text
|
||||||
|
packages/domain/src/
|
||||||
|
├── undo-redo.ts # Pure stack operations (push, pop, cap, clear)
|
||||||
|
├── __tests__/undo-redo.test.ts # Unit tests for stack operations
|
||||||
|
|
||||||
|
packages/application/src/
|
||||||
|
├── undo-use-case.ts # Orchestrates undo via EncounterStore + UndoRedoStore
|
||||||
|
├── redo-use-case.ts # Orchestrates redo via EncounterStore + UndoRedoStore
|
||||||
|
├── ports.ts # Extended with UndoRedoStore port interface
|
||||||
|
|
||||||
|
apps/web/src/
|
||||||
|
├── hooks/use-encounter.ts # Modified: wrap actions with snapshot capture, expose undo/redo
|
||||||
|
├── persistence/undo-redo-storage.ts # localStorage save/load for undo/redo stacks
|
||||||
|
├── contexts/encounter-context.tsx # Modified: expose undo/redo + stack emptiness flags
|
||||||
|
├── components/turn-navigation.tsx # Modified: add undo/redo buttons (inboard of turn step buttons)
|
||||||
|
├── hooks/use-undo-redo-shortcuts.ts # Keyboard shortcut handler (Ctrl+Z, Ctrl+Shift+Z)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Structure Decision**: Follows existing layered architecture. Pure stack operations in domain, use cases in application, persistence and UI in web adapter. No new packages or structural changes needed.
|
||||||
53
specs/037-undo-redo/quickstart.md
Normal file
53
specs/037-undo-redo/quickstart.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# Quickstart: Undo/Redo
|
||||||
|
|
||||||
|
**Feature**: 037-undo-redo
|
||||||
|
**Date**: 2026-03-26
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This feature adds undo/redo to all encounter state changes using the memento (snapshot) pattern. Each action captures the pre-action encounter state onto an undo stack. Undo restores the previous state; redo re-applies an undone state.
|
||||||
|
|
||||||
|
## Implementation Layers
|
||||||
|
|
||||||
|
### Domain (`packages/domain/src/undo-redo.ts`)
|
||||||
|
|
||||||
|
Pure functions for stack management:
|
||||||
|
- `pushUndo(state, snapshot)` — push snapshot, cap at 50, clear redo
|
||||||
|
- `undo(state, currentEncounter)` — pop undo, push current to redo
|
||||||
|
- `redo(state, currentEncounter)` — pop redo, push current to undo
|
||||||
|
- `clearHistory()` — reset both stacks
|
||||||
|
|
||||||
|
All functions take and return immutable data. No I/O.
|
||||||
|
|
||||||
|
### Application (`packages/application/src/`)
|
||||||
|
|
||||||
|
Use cases that orchestrate domain calls via store ports:
|
||||||
|
- `undoUseCase(encounterStore, undoRedoStore)` — execute undo
|
||||||
|
- `redoUseCase(encounterStore, undoRedoStore)` — execute redo
|
||||||
|
|
||||||
|
New port interface `UndoRedoStore` in `ports.ts`:
|
||||||
|
- `get(): UndoRedoState`
|
||||||
|
- `save(state: UndoRedoState): void`
|
||||||
|
|
||||||
|
### Web Adapter (`apps/web/src/`)
|
||||||
|
|
||||||
|
**Hook (`use-encounter.ts`)**: Wraps every action callback to capture pre-action snapshot. Exposes `undo()`, `redo()`, `canUndo`, `canRedo`.
|
||||||
|
|
||||||
|
**Persistence (`persistence/undo-redo-storage.ts`)**: Save/load undo/redo stacks to localStorage keys `"initiative:encounter:undo"` and `"initiative:encounter:redo"`.
|
||||||
|
|
||||||
|
**UI (`components/turn-navigation.tsx`)**: Undo/Redo buttons in the top bar, inboard of the turn step buttons, disabled when stack is empty.
|
||||||
|
|
||||||
|
**Keyboard (`hooks/use-undo-redo-shortcuts.ts`)**: Global keydown listener for Ctrl+Z / Ctrl+Shift+Z (Cmd on Mac). Suppressed when text input has focus.
|
||||||
|
|
||||||
|
## Key Design Decisions
|
||||||
|
|
||||||
|
1. **Memento over Command**: Full encounter snapshots, not inverse events. Simpler at encounter scale (~2-5 KB per snapshot).
|
||||||
|
2. **Capture in hook, not domain**: Snapshot capture happens in the adapter layer. Domain and application layers are unaware of undo/redo.
|
||||||
|
3. **React state for stacks**: Enables reactive button disabled states without manual re-render triggers.
|
||||||
|
4. **Clear is not undoable**: Both stacks reset on encounter clear (per spec).
|
||||||
|
|
||||||
|
## Testing Strategy
|
||||||
|
|
||||||
|
- **Domain tests**: Pure function tests for stack operations (push, pop, cap, clear, undo/redo roundtrip).
|
||||||
|
- **Application tests**: Use case tests with mock stores.
|
||||||
|
- **Integration**: Spec acceptance scenarios mapped to test cases (undo restores state, redo reapplies, new action clears redo, keyboard suppression during input focus).
|
||||||
82
specs/037-undo-redo/research.md
Normal file
82
specs/037-undo-redo/research.md
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
# Research: Undo/Redo for Encounter Actions
|
||||||
|
|
||||||
|
**Feature**: 037-undo-redo
|
||||||
|
**Date**: 2026-03-26
|
||||||
|
|
||||||
|
## Decision 1: Undo/Redo Strategy — Memento (Snapshots) vs Command (Events)
|
||||||
|
|
||||||
|
**Decision**: Memento pattern — store full `Encounter` snapshots.
|
||||||
|
|
||||||
|
**Rationale**:
|
||||||
|
- The `Encounter` type is small (tens of combatants, ~2-5 KB serialized). Storing 50 snapshots costs ~100-250 KB in memory and localStorage — negligible.
|
||||||
|
- The codebase already serializes/deserializes full encounters for localStorage persistence. Reuse is straightforward.
|
||||||
|
- All domain state transitions are pure functions returning new `Encounter` objects. Each action naturally produces a "before" snapshot (the current state) and an "after" snapshot (the result).
|
||||||
|
- The command/event approach would require inverse operations for every domain function, including compound operations like initiative re-sorting. This complexity is not justified at encounter scale.
|
||||||
|
- The existing event system captures `previousValue`/`newValue` pairs but lacks full combatant snapshots for structural changes (add/remove with initiative reordering). Extending events would be more work than snapshots for no practical benefit.
|
||||||
|
|
||||||
|
**Alternatives considered**:
|
||||||
|
- **Command pattern (inverse events)**: More memory-efficient per entry but significantly more complex. Requires implementing and testing inverse operations for all 18+ domain transitions. Rejected because the complexity outweighs the memory savings at encounter scale.
|
||||||
|
- **Hybrid (events for simple, snapshots for structural)**: Rejected because mixed strategies increase implementation and debugging complexity.
|
||||||
|
|
||||||
|
## Decision 2: Stack Storage Location
|
||||||
|
|
||||||
|
**Decision**: Store undo/redo stacks in React state within `useEncounter`, persisted to localStorage via dedicated keys.
|
||||||
|
|
||||||
|
**Rationale**:
|
||||||
|
- Matches the existing persistence pattern: encounter state lives in React state and is synced to localStorage via `useEffect`.
|
||||||
|
- Using `useState` (not `useRef`) ensures React re-renders when stack emptiness changes, keeping button disabled states reactive.
|
||||||
|
- Dedicated localStorage keys (`"initiative:encounter:undo"`, `"initiative:encounter:redo"`) avoid coupling stack persistence with encounter persistence.
|
||||||
|
|
||||||
|
**Alternatives considered**:
|
||||||
|
- **useRef for stacks**: Would avoid re-renders on every push/pop, but then button disabled states wouldn't update reactively. Would need manual `forceUpdate` or separate boolean state — more complex for no clear benefit.
|
||||||
|
- **Single localStorage key with encounter**: Rejected because it couples concerns and makes the encounter storage format backward-incompatible.
|
||||||
|
|
||||||
|
## Decision 3: Snapshot Capture Point
|
||||||
|
|
||||||
|
**Decision**: Capture the pre-action encounter snapshot inside each action callback in `useEncounter`, before calling the use case.
|
||||||
|
|
||||||
|
**Rationale**:
|
||||||
|
- Each action callback in `useEncounter` already calls `makeStore()` which accesses the current encounter via `encounterRef.current`. The snapshot is naturally available at this point.
|
||||||
|
- Capturing at the hook level (not the use case level) keeps the domain and application layers unchanged — undo/redo is purely an adapter concern.
|
||||||
|
- Failed actions (domain errors) should NOT push to the undo stack, so the capture must happen conditionally after confirming the action succeeded.
|
||||||
|
|
||||||
|
**Alternatives considered**:
|
||||||
|
- **Capture inside use cases**: Would require changing the application layer API to return the pre-action state. Violates layered architecture — use cases shouldn't know about undo.
|
||||||
|
- **Capture via store wrapper**: Could intercept `store.save()` to capture the previous state. Elegant but makes the flow harder to follow and debug. Rejected in favor of explicit capture.
|
||||||
|
|
||||||
|
## Decision 4: Keyboard Shortcut Suppression Strategy
|
||||||
|
|
||||||
|
**Decision**: Check `document.activeElement` tag name and `contentEditable` attribute. Suppress encounter undo/redo when focus is on `INPUT`, `TEXTAREA`, or `contentEditable` elements.
|
||||||
|
|
||||||
|
**Rationale**:
|
||||||
|
- Simple and reliable. The app uses standard HTML form elements for text input.
|
||||||
|
- No `contentEditable` elements currently exist, but checking for them is defensive and low-cost.
|
||||||
|
- The check happens in the `keydown` event handler before dispatching to undo/redo.
|
||||||
|
|
||||||
|
**Alternatives considered**:
|
||||||
|
- **Capture phase with stopPropagation**: Overly complex for this use case.
|
||||||
|
- **Custom focus tracking via context**: Would require every input to register/unregister. Too invasive.
|
||||||
|
|
||||||
|
## Decision 5: UI Placement for Undo/Redo Buttons
|
||||||
|
|
||||||
|
**Decision**: Place undo/redo buttons in the `TurnNavigation` component (top bar), inboard of the turn step buttons. Turn navigation (Previous/Next Turn) stays as the outermost buttons; Undo/Redo sits between Previous Turn and the center info area.
|
||||||
|
|
||||||
|
**Rationale**:
|
||||||
|
- `TurnNavigation` is the primary command bar for encounter-level actions (advance/retreat turn, clear encounter). Undo/redo are encounter-level actions.
|
||||||
|
- Placing them in the top bar keeps them always visible when the encounter is active.
|
||||||
|
- Turn navigation stays outermost because it's the most frequently used control during live combat. Undo/redo is secondary.
|
||||||
|
|
||||||
|
**Alternatives considered**:
|
||||||
|
- **ActionBar (bottom bar)**: Already crowded with combatant management controls (search, add, roll initiative). Undo/redo would be buried.
|
||||||
|
- **Floating buttons**: Unconventional for this app's design language.
|
||||||
|
|
||||||
|
## Decision 6: Clear Encounter and Undo Stack
|
||||||
|
|
||||||
|
**Decision**: Clearing the encounter resets both undo and redo stacks. Clear is not undoable.
|
||||||
|
|
||||||
|
**Rationale**:
|
||||||
|
- Per spec (FR-010 and edge case). Clear is an intentionally destructive "reset" action. Making it undoable would create confusion about what "fresh start" means.
|
||||||
|
- The existing clear encounter flow already has a confirmation dialog, providing sufficient protection against accidents.
|
||||||
|
|
||||||
|
**Alternatives considered**:
|
||||||
|
- **Make clear undoable**: Would require keeping the pre-clear state in a special recovery slot. Adds complexity for a scenario already guarded by confirmation. Rejected per spec.
|
||||||
123
specs/037-undo-redo/spec.md
Normal file
123
specs/037-undo-redo/spec.md
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
# Feature Specification: Undo/Redo
|
||||||
|
|
||||||
|
**Feature Branch**: `037-undo-redo`
|
||||||
|
**Created**: 2026-03-26
|
||||||
|
**Status**: Draft
|
||||||
|
**Input**: Gitea issue #16 — Undo/redo for encounter actions
|
||||||
|
|
||||||
|
## User Scenarios & Testing *(mandatory)*
|
||||||
|
|
||||||
|
### User Story 1 - Undo a Mistake (Priority: P1)
|
||||||
|
|
||||||
|
A DM accidentally removes the wrong combatant, changes HP incorrectly, or advances the turn too early. They press an undo button (or keyboard shortcut) and the encounter returns to exactly the state it was in before that action.
|
||||||
|
|
||||||
|
**Why this priority**: Mistakes during live combat are stressful and time-sensitive. Undo is the core value proposition — without it, the DM must manually reconstruct state, which disrupts the game.
|
||||||
|
|
||||||
|
**Independent Test**: Can be fully tested by performing any encounter action, pressing undo, and verifying the encounter matches its pre-action state.
|
||||||
|
|
||||||
|
**Acceptance Scenarios**:
|
||||||
|
|
||||||
|
1. **Given** an encounter with 3 combatants, **When** the user removes a combatant and clicks Undo, **Then** the removed combatant reappears in the same position with all its stats intact.
|
||||||
|
2. **Given** a combatant with 30/45 HP, **When** the user adjusts HP to 20/45 and presses Undo, **Then** the combatant's HP returns to 30/45.
|
||||||
|
3. **Given** an encounter on round 3 turn 2, **When** the user advances the turn and presses Undo, **Then** the encounter returns to round 3 turn 2.
|
||||||
|
4. **Given** the undo stack is empty, **When** the user looks at the Undo button, **Then** it appears disabled and cannot be activated.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### User Story 2 - Redo an Undone Action (Priority: P2)
|
||||||
|
|
||||||
|
A DM presses undo but then realizes the original action was correct. They press redo to restore the undone change rather than re-entering it manually.
|
||||||
|
|
||||||
|
**Why this priority**: Redo complements undo — without it, undoing too far forces manual re-entry. Lower priority than undo because redo is used less frequently.
|
||||||
|
|
||||||
|
**Independent Test**: Can be tested by performing an action, undoing it, then redoing it, and verifying the state matches the post-action state.
|
||||||
|
|
||||||
|
**Acceptance Scenarios**:
|
||||||
|
|
||||||
|
1. **Given** the user has undone an HP adjustment, **When** they click Redo, **Then** the HP adjustment is reapplied exactly.
|
||||||
|
2. **Given** the user has undone two actions, **When** they click Redo twice, **Then** both actions are reapplied in order.
|
||||||
|
3. **Given** the user has undone an action and then performs a new action, **When** they look at the Redo button, **Then** it is disabled (the redo stack was cleared by the new action).
|
||||||
|
4. **Given** the redo stack is empty, **When** the user looks at the Redo button, **Then** it appears disabled and cannot be activated.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### User Story 3 - Keyboard Shortcuts (Priority: P3)
|
||||||
|
|
||||||
|
A DM who prefers keyboard interaction can undo with Ctrl+Z (Cmd+Z on Mac) and redo with Ctrl+Shift+Z (Cmd+Shift+Z on Mac) without reaching for buttons.
|
||||||
|
|
||||||
|
**Why this priority**: Keyboard shortcuts are a convenience layer. The feature is fully usable via buttons alone, so shortcuts are an enhancement.
|
||||||
|
|
||||||
|
**Independent Test**: Can be tested by pressing the keyboard shortcut and verifying the same behavior as the button.
|
||||||
|
|
||||||
|
**Acceptance Scenarios**:
|
||||||
|
|
||||||
|
1. **Given** the undo stack has entries, **When** the user presses Ctrl+Z (Cmd+Z on Mac), **Then** the most recent action is undone.
|
||||||
|
2. **Given** the redo stack has entries, **When** the user presses Ctrl+Shift+Z (Cmd+Shift+Z on Mac), **Then** the most recent undo is redone.
|
||||||
|
3. **Given** an input field or textarea has focus, **When** the user presses Ctrl+Z, **Then** the browser's native text undo fires instead of encounter undo.
|
||||||
|
4. **Given** no input has focus and the undo stack is empty, **When** the user presses Ctrl+Z, **Then** nothing happens.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### User Story 4 - Undo History Survives Refresh (Priority: P4)
|
||||||
|
|
||||||
|
A DM refreshes the page (or the browser restores the tab) and can still undo/redo recent actions, so history is not lost to accidental navigation.
|
||||||
|
|
||||||
|
**Why this priority**: Persistence is important for reliability but is secondary to the core undo/redo mechanics working correctly in-session.
|
||||||
|
|
||||||
|
**Independent Test**: Can be tested by performing actions, refreshing the page, and verifying the undo/redo buttons reflect the pre-refresh stack state.
|
||||||
|
|
||||||
|
**Acceptance Scenarios**:
|
||||||
|
|
||||||
|
1. **Given** the user has performed 5 actions, **When** they refresh the page, **Then** the undo stack contains 5 entries and undo works correctly.
|
||||||
|
2. **Given** the user has undone 2 of 5 actions, **When** they refresh the page, **Then** the undo stack has 3 entries and the redo stack has 2 entries.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Edge Cases
|
||||||
|
|
||||||
|
- What happens when the undo stack reaches 50 entries? The oldest entry is dropped silently; the user can still undo the 50 most recent actions.
|
||||||
|
- What happens when the user clears the encounter? Both undo and redo stacks are reset to empty; there is no way to undo a clear.
|
||||||
|
- What happens when the user performs a new action after undoing? The redo stack is cleared entirely; the new action becomes the latest history entry.
|
||||||
|
- What happens if localStorage is full and the stacks cannot be persisted? The stacks continue to work in-memory for the current session; persistence is best-effort.
|
||||||
|
- What happens if persisted stack data is corrupt or invalid on load? The stacks start empty; the encounter itself loads normally from its own storage.
|
||||||
|
|
||||||
|
## Requirements *(mandatory)*
|
||||||
|
|
||||||
|
### Functional Requirements
|
||||||
|
|
||||||
|
- **FR-001**: System MUST capture a snapshot of the current encounter state before each state transition and push it onto the undo stack.
|
||||||
|
- **FR-002**: System MUST cap the undo stack at 50 entries, dropping the oldest entry when the cap is exceeded.
|
||||||
|
- **FR-003**: When the user triggers undo, system MUST restore the encounter to the most recent snapshot from the undo stack and push the current state onto the redo stack.
|
||||||
|
- **FR-004**: When the user triggers redo, system MUST restore the encounter to the most recent snapshot from the redo stack and push the current state onto the undo stack.
|
||||||
|
- **FR-005**: When the user performs any new encounter action (not undo/redo), system MUST clear the redo stack.
|
||||||
|
- **FR-006**: System MUST persist the undo and redo stacks to localStorage and restore them on page load.
|
||||||
|
- **FR-007**: System MUST display Undo and Redo buttons in the UI that are disabled when their respective stacks are empty.
|
||||||
|
- **FR-008**: System MUST support Ctrl+Z / Cmd+Z for undo and Ctrl+Shift+Z / Cmd+Shift+Z for redo.
|
||||||
|
- **FR-009**: System MUST suppress encounter undo/redo keyboard shortcuts when an input, textarea, or other text-editable element has focus, allowing native browser text editing behavior.
|
||||||
|
- **FR-010**: When the encounter is cleared, system MUST reset both undo and redo stacks to empty.
|
||||||
|
- **FR-011**: Undo/redo MUST operate on the full encounter snapshot (memento pattern), not on individual field changes.
|
||||||
|
|
||||||
|
### Key Entities
|
||||||
|
|
||||||
|
- **Undo Stack**: An ordered collection of encounter snapshots (most recent last), capped at 50 entries. Each entry is a complete encounter state captured before a state transition.
|
||||||
|
- **Redo Stack**: An ordered collection of encounter snapshots accumulated by undo operations. Cleared when any new (non-undo/redo) action occurs.
|
||||||
|
|
||||||
|
## Success Criteria *(mandatory)*
|
||||||
|
|
||||||
|
### Measurable Outcomes
|
||||||
|
|
||||||
|
- **SC-001**: Users can reverse any single encounter action within 1 second via button or keyboard shortcut.
|
||||||
|
- **SC-002**: Users can undo and redo up to 50 sequential actions without data loss or state corruption.
|
||||||
|
- **SC-003**: Undo/redo history is preserved across page refresh with no user intervention.
|
||||||
|
- **SC-004**: Keyboard shortcuts do not interfere with native text editing in input fields.
|
||||||
|
|
||||||
|
## Assumptions
|
||||||
|
|
||||||
|
- The encounter data structure is small enough (tens of combatants) that storing 50 full snapshots in memory and localStorage is practical.
|
||||||
|
- The dependency on #15 (atomic addCombatant) is resolved, so each user action maps to exactly one snapshot.
|
||||||
|
- Player character template state is managed separately and is not part of the undo/redo scope — only encounter state is tracked.
|
||||||
|
- "Clear encounter" is an intentionally destructive action that should not be undoable, matching user expectations for a "reset" operation.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
- **#15 (Atomic addCombatant)**: Required so compound operations (add from bestiary, add from player character) produce a single state transition and thus a single undo entry.
|
||||||
159
specs/037-undo-redo/tasks.md
Normal file
159
specs/037-undo-redo/tasks.md
Normal file
@@ -0,0 +1,159 @@
|
|||||||
|
# Tasks: Undo/Redo
|
||||||
|
|
||||||
|
**Input**: Design documents from `/specs/037-undo-redo/`
|
||||||
|
**Prerequisites**: plan.md, spec.md, research.md, data-model.md, quickstart.md
|
||||||
|
|
||||||
|
**Tests**: Domain tests included (pure function testing is standard for this project per CLAUDE.md).
|
||||||
|
|
||||||
|
**Organization**: Tasks are grouped by user story to enable independent implementation and testing of each story.
|
||||||
|
|
||||||
|
## Format: `[ID] [P?] [Story] Description`
|
||||||
|
|
||||||
|
- **[P]**: Can run in parallel (different files, no dependencies)
|
||||||
|
- **[Story]**: Which user story this task belongs to (e.g., US1, US2, US3)
|
||||||
|
- Include exact file paths in descriptions
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 1: Foundational (Domain + Application Layer)
|
||||||
|
|
||||||
|
**Purpose**: Pure domain logic and application ports that all user stories depend on
|
||||||
|
|
||||||
|
**CRITICAL**: No user story work can begin until this phase is complete
|
||||||
|
|
||||||
|
- [x] T001 Define `UndoRedoState` type and pure stack functions (`pushUndo`, `undo`, `redo`, `clearHistory`) in `packages/domain/src/undo-redo.ts`. All functions take and return immutable data per data-model.md state transitions. Cap undo stack at 50 entries (drop oldest). Return `DomainError` for empty-stack operations.
|
||||||
|
- [x] T002 Add unit tests for all stack functions in `packages/domain/src/__tests__/undo-redo.test.ts`. Cover: push adds to stack, cap at 50 drops oldest, push clears redo stack, undo pops and moves to redo, redo pops and moves to undo, undo on empty returns error, redo on empty returns error, clearHistory empties both, undo-then-redo roundtrip returns exact same encounter. Application use case tests are not needed separately — the use cases are thin orchestration and their logic is fully covered by domain tests + integration via the hook.
|
||||||
|
- [x] T003 [P] Add `UndoRedoStore` port interface (`get(): UndoRedoState`, `save(state: UndoRedoState): void`) to `packages/application/src/ports.ts`.
|
||||||
|
- [x] T004 [P] Implement `undoUseCase(encounterStore, undoRedoStore)` in `packages/application/src/undo-use-case.ts`. Calls domain `undo()` with current encounter, saves resulting encounter to encounterStore and resulting state to undoRedoStore.
|
||||||
|
- [x] T005 [P] Implement `redoUseCase(encounterStore, undoRedoStore)` in `packages/application/src/redo-use-case.ts`. Same pattern as undo but calls domain `redo()`.
|
||||||
|
|
||||||
|
**Checkpoint**: Domain logic and use cases complete. All pure functions tested. Ready for adapter layer.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 2: User Story 1 - Undo a Mistake (Priority: P1) MVP
|
||||||
|
|
||||||
|
**Goal**: User can undo any encounter action via a button in the top bar.
|
||||||
|
|
||||||
|
**Independent Test**: Perform any encounter action (add combatant, adjust HP, advance turn), click Undo, verify encounter returns to pre-action state. Undo button is disabled when stack is empty.
|
||||||
|
|
||||||
|
### Implementation for User Story 1
|
||||||
|
|
||||||
|
- [x] T006 [US1] Add undo/redo state management to `apps/web/src/hooks/use-encounter.ts`: add `UndoRedoState` to hook state (initialized empty), create `makeUndoRedoStore()` factory (same pattern as `makeStore()`), create a `withUndo` wrapper function that captures the pre-action encounter snapshot and calls `pushUndo` on the undo/redo state after a successful action. Wrap all existing action callbacks with `withUndo`.
|
||||||
|
- [x] T007 [US1] Add `undo` callback to `apps/web/src/hooks/use-encounter.ts` that calls `undoUseCase` and updates both encounter and undo/redo state. Expose `canUndo: boolean` (derived from undo stack length > 0).
|
||||||
|
- [x] T008 [US1] Update `apps/web/src/contexts/encounter-context.tsx` to expose `undo`, `canUndo` from the encounter hook return type.
|
||||||
|
- [x] T009 [US1] Add Undo button to `apps/web/src/components/turn-navigation.tsx`, placed inboard of (to the right of) the Previous Turn button. Use `Undo2` icon from Lucide React. Button is disabled when `canUndo` is false. Calls `undo()` from encounter context on click.
|
||||||
|
|
||||||
|
**Checkpoint**: Undo works for all encounter actions via button. Redo not yet available.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 3: User Story 2 - Redo an Undone Action (Priority: P2)
|
||||||
|
|
||||||
|
**Goal**: User can redo an undone action via a button. New actions clear the redo stack.
|
||||||
|
|
||||||
|
**Independent Test**: Perform an action, undo it, click Redo, verify state matches post-action. Then perform a new action and verify Redo button becomes disabled.
|
||||||
|
|
||||||
|
### Implementation for User Story 2
|
||||||
|
|
||||||
|
- [x] T010 [US2] Add `redo` callback to `apps/web/src/hooks/use-encounter.ts` that calls `redoUseCase` and updates both encounter and undo/redo state. Expose `canRedo: boolean` (derived from redo stack length > 0). Verify that `pushUndo` (called by `withUndo` wrapper from T006) already clears the redo stack per domain logic — no additional work needed for FR-005.
|
||||||
|
- [x] T011 [US2] Update `apps/web/src/contexts/encounter-context.tsx` to expose `redo`, `canRedo` from the encounter hook return type.
|
||||||
|
- [x] T012 [US2] Add Redo button to `apps/web/src/components/turn-navigation.tsx`, placed next to the Undo button (both inboard of turn step buttons). Use `Redo2` icon from Lucide React. Button is disabled when `canRedo` is false. Calls `redo()` from encounter context on click.
|
||||||
|
|
||||||
|
**Checkpoint**: Full undo/redo via buttons. Keyboard shortcuts and persistence not yet available.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 4: User Story 3 - Keyboard Shortcuts (Priority: P3)
|
||||||
|
|
||||||
|
**Goal**: Ctrl+Z / Cmd+Z triggers undo; Ctrl+Shift+Z / Cmd+Shift+Z triggers redo. Suppressed when text input has focus.
|
||||||
|
|
||||||
|
**Independent Test**: Press Ctrl+Z with no input focused — encounter undoes. Focus an input field, press Ctrl+Z — browser native text undo fires. Press Ctrl+Shift+Z — encounter redoes.
|
||||||
|
|
||||||
|
### Implementation for User Story 3
|
||||||
|
|
||||||
|
- [x] T013 [US3] Create `apps/web/src/hooks/use-undo-redo-shortcuts.ts`. Register a `keydown` event listener on `document`. Detect Ctrl+Z / Cmd+Z (undo) and Ctrl+Shift+Z / Cmd+Shift+Z (redo). Before dispatching, check `document.activeElement` — suppress if tag is `INPUT`, `TEXTAREA`, `SELECT`, or element has `contentEditable`. Call `preventDefault()` only when handling the shortcut. Accept `undo`, `redo`, `canUndo`, `canRedo` as parameters.
|
||||||
|
- [x] T014 [US3] Wire `useUndoRedoShortcuts` into the encounter provider layer. Call the hook from inside `EncounterProvider` in `apps/web/src/contexts/encounter-context.tsx` (or from `App.tsx` if context structure makes that cleaner), passing undo/redo callbacks and flags from the encounter hook.
|
||||||
|
|
||||||
|
**Checkpoint**: Full undo/redo via buttons and keyboard shortcuts.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 5: User Story 4 - Undo History Survives Refresh (Priority: P4)
|
||||||
|
|
||||||
|
**Goal**: Undo/redo stacks persist to localStorage and restore on page load.
|
||||||
|
|
||||||
|
**Independent Test**: Perform 5 actions, refresh the page, verify undo button is enabled and clicking it 5 times restores each previous state.
|
||||||
|
|
||||||
|
### Implementation for User Story 4
|
||||||
|
|
||||||
|
- [x] T015 [P] [US4] Create `apps/web/src/persistence/undo-redo-storage.ts`. Implement `saveUndoRedoStacks(undoStack, redoStack)` and `loadUndoRedoStacks()`. Use localStorage keys `"initiative:encounter:undo"` and `"initiative:encounter:redo"`. Reuse existing encounter rehydration/validation logic from `encounter-storage.ts` for each stack entry. Silently swallow write errors (quota exceeded). Return empty stacks on corrupt/invalid data.
|
||||||
|
- [x] T016 [US4] Integrate persistence into `apps/web/src/hooks/use-encounter.ts`: initialize undo/redo state from `loadUndoRedoStacks()` on mount. Add a `useEffect` that calls `saveUndoRedoStacks()` whenever undo/redo state changes (same pattern as existing encounter persistence).
|
||||||
|
|
||||||
|
**Checkpoint**: Full feature complete — undo/redo via buttons, keyboard shortcuts, persisted across refresh.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 6: Polish & Cross-Cutting Concerns
|
||||||
|
|
||||||
|
**Purpose**: Edge cases and quality gates
|
||||||
|
|
||||||
|
- [x] T017 Ensure clear encounter resets undo/redo stacks in `apps/web/src/hooks/use-encounter.ts`. In the `clearEncounter` callback, call `clearHistory()` on the undo/redo state after clearing the encounter. Verify this also clears persisted stacks via the useEffect.
|
||||||
|
- [x] T018 Run `pnpm check` and fix any lint, type, coverage, or unused-code issues. Ensure layer boundary check passes (domain must not import from web/application, application must not import from web).
|
||||||
|
- [x] T019 Update README.md to document undo/redo capability (buttons + keyboard shortcuts). Per constitution, user-facing feature changes MUST be reflected in README.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Dependencies & Execution Order
|
||||||
|
|
||||||
|
### Phase Dependencies
|
||||||
|
|
||||||
|
- **Foundational (Phase 1)**: No dependencies — can start immediately
|
||||||
|
- **US1 Undo (Phase 2)**: Depends on Foundational completion
|
||||||
|
- **US2 Redo (Phase 3)**: Depends on US1 (undo must exist before redo makes sense)
|
||||||
|
- **US3 Shortcuts (Phase 4)**: Depends on US2 (needs both undo and redo callbacks)
|
||||||
|
- **US4 Persistence (Phase 5)**: Depends on US1 (needs undo/redo state to exist). Can run in parallel with US2/US3 if needed.
|
||||||
|
- **Polish (Phase 6)**: Depends on all user stories being complete
|
||||||
|
|
||||||
|
### Within Foundational Phase
|
||||||
|
|
||||||
|
- T001 (domain functions) must complete before T002 (tests)
|
||||||
|
- T003 (port) must complete before T004/T005 (use cases import `UndoRedoStore` from ports.ts)
|
||||||
|
- T004 (undo use case) and T005 (redo use case) can run in parallel after T001 + T003
|
||||||
|
|
||||||
|
### Parallel Opportunities
|
||||||
|
|
||||||
|
- T004, T005 can run in parallel (different files, depend on T001 + T003)
|
||||||
|
- T015 (persistence storage) can run in parallel with any Phase 3-4 work (different file)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Strategy
|
||||||
|
|
||||||
|
### MVP First (User Story 1 Only)
|
||||||
|
|
||||||
|
1. Complete Phase 1: Foundational (domain + application)
|
||||||
|
2. Complete Phase 2: User Story 1 (undo via button)
|
||||||
|
3. **STOP and VALIDATE**: Test undo independently with all encounter actions
|
||||||
|
4. Demo if ready — undo alone delivers significant value
|
||||||
|
|
||||||
|
### Incremental Delivery
|
||||||
|
|
||||||
|
1. Foundational → Domain logic tested, ready for integration
|
||||||
|
2. Add US1 (Undo) → Button works → Validate independently
|
||||||
|
3. Add US2 (Redo) → Both buttons work → Validate independently
|
||||||
|
4. Add US3 (Shortcuts) → Keyboard works → Validate independently
|
||||||
|
5. Add US4 (Persistence) → Refresh-safe → Validate independently
|
||||||
|
6. Polish → Quality gates pass → Ready to merge
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- [P] tasks = different files, no dependencies
|
||||||
|
- [Story] label maps task to specific user story for traceability
|
||||||
|
- US2 (Redo) depends on US1 (Undo) — redo is meaningless without undo
|
||||||
|
- US3 (Shortcuts) and US4 (Persistence) are independent of each other but both need US1
|
||||||
|
- The `withUndo` wrapper in T006 is the key integration point — it captures snapshots for ALL existing actions in one place
|
||||||
|
- Domain tests (T002) validate all invariants from data-model.md
|
||||||
|
- Commit after each phase checkpoint
|
||||||
Reference in New Issue
Block a user