Initial Commit
This commit is contained in:
@@ -0,0 +1,80 @@
|
||||
# OpenSpec Change: enterprise-gaming-react-dialogue
|
||||
|
||||
- **Change ID**: enterprise-gaming-react-dialogue
|
||||
- **Package**: `@suaveplan/react-dialogue`
|
||||
- **Category**: gaming/react
|
||||
- **Target path**: `gaming/react/react-dialogue`
|
||||
- **Status**: PROPOSED
|
||||
- **Date**: 2026-04-24
|
||||
- **Reference spec**: `/mnt/s/web/suaveplan/enterprise/react-dialogue.md`
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Deliver `@suaveplan/react-dialogue` on the genesis branch from scratch at enterprise quality. The package is the headless React layer around `@suaveplan/dialogue`. A `DialogueUIStateManager` wraps a `ConversationSession`; `useDialogue()` provides access via `useSyncExternalStore`; typed components display the current node text, speaker name, typewriter text animation, and choice buttons with condition-gated disabled state. Genesis adds Storybook stories, Vitest DOM tests, and 100% coverage.
|
||||
|
||||
---
|
||||
|
||||
## Current-state audit (genesis)
|
||||
|
||||
Package does not exist on genesis yet — fresh build.
|
||||
|
||||
---
|
||||
|
||||
## Available workspace deps on genesis
|
||||
|
||||
| Package | Role |
|
||||
|---|---|
|
||||
| `@suaveplan/dialogue` (`workspace:^`) | `ConversationSession`, `DialogueTree` |
|
||||
| `@suaveplan/events` (`workspace:^`) | Dialogue event subscriptions |
|
||||
| `react` (`catalog:react`) | React 18 |
|
||||
|
||||
---
|
||||
|
||||
## Public API surface
|
||||
|
||||
```ts
|
||||
function createDialogueUIStateManager(session: ConversationSession): DialogueUIStateManager
|
||||
function useDialogue(): DialogueUIState
|
||||
|
||||
// Components
|
||||
function DialogueBox(props: DialogueBoxProps): JSX.Element // speaker + text
|
||||
function DialogueChoices(props: DialogueChoicesProps): JSX.Element // choice buttons
|
||||
function TypewriterText(props: TypewriterTextProps): JSX.Element // animated reveal
|
||||
function SpeakerPortrait(props: SpeakerPortraitProps): JSX.Element // optional avatar
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## File layout
|
||||
|
||||
```text
|
||||
gaming/react/react-dialogue/
|
||||
package.json
|
||||
tsconfig.json
|
||||
vitest.config.ts
|
||||
src/
|
||||
index.ts
|
||||
types/common.ts
|
||||
types/common.md
|
||||
state/
|
||||
dialogue-ui-state-manager.ts
|
||||
dialogue-ui-state-manager.md
|
||||
dialogue-ui-state-manager.test.ts
|
||||
hooks/
|
||||
use-dialogue.ts
|
||||
use-dialogue.md
|
||||
use-dialogue.test.ts
|
||||
components/
|
||||
dialogue-box/ (tsx + md + test + stories + index)
|
||||
dialogue-choices/ (tsx + md + test + stories + index)
|
||||
typewriter-text/ (tsx + md + test + stories + index)
|
||||
speaker-portrait/ (tsx + md + test + stories + index)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Impact
|
||||
|
||||
**Downstream**: game apps compose dialogue UI over R3F scene. Prerequisites: `@suaveplan/dialogue`, `@suaveplan/events`, react.
|
||||
36
openspec/changes/enterprise-gaming-react-dialogue/tasks.md
Normal file
36
openspec/changes/enterprise-gaming-react-dialogue/tasks.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Tasks: enterprise-gaming-react-dialogue
|
||||
|
||||
## 0. Pre-flight (non-negotiable)
|
||||
|
||||
- [ ] 0.1 Confirm clean working tree (`git status` reports nothing) and no in-flight worktrees with uncommitted work (`git worktree list` then `git status` in each)
|
||||
- [ ] 0.2 If any worktrees exist under `.claude/worktrees/`, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (`git worktree remove`) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
|
||||
- [ ] 0.3 Confirm the package set in `MANIFEST.md` matches `find packages -maxdepth 3 -name package.json` count. Drift here means a prior change archived without regenerating the manifest.
|
||||
|
||||
## Phase 1 — Scaffold
|
||||
|
||||
- [ ] Create `gaming/react/react-dialogue/` (`@suaveplan/react-dialogue`, `0.1.0`, `sideEffects: false`)
|
||||
- [ ] `tsconfig.json`, `vitest.config.ts`
|
||||
|
||||
## Phase 2 — Types
|
||||
|
||||
- [ ] `src/types/common.ts` + `common.md`
|
||||
|
||||
## Phase 3 — Dialogue UI state manager + hook
|
||||
|
||||
- [ ] State manager wraps `ConversationSession`, exposes current node + available choices
|
||||
- [ ] `useDialogue` hook
|
||||
- [ ] Tests + docs for both
|
||||
|
||||
## Phase 4 — Components
|
||||
|
||||
- [ ] `TypewriterText` — character-by-character reveal with configurable speed
|
||||
- [ ] `DialogueBox` — speaker name + TypewriterText + skip button
|
||||
- [ ] `DialogueChoices` — list of choice buttons, disabled for unavailable, hidden for hidden
|
||||
- [ ] `SpeakerPortrait` — img with fallback initials
|
||||
- [ ] Tests + Storybook stories for each
|
||||
|
||||
## Phase 5 — Pre-publish gate
|
||||
|
||||
- [ ] `bunx turbo lint typecheck test --filter=@suaveplan/react-dialogue` green
|
||||
- [ ] 100% coverage
|
||||
- [ ] Publish: `bun scripts/publish.ts --package @suaveplan/react-dialogue`
|
||||
Reference in New Issue
Block a user