docs(02-05): complete UI integration plan - avatars, greetings, companion area

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-29 12:17:08 +02:00
parent 57a929bc1a
commit 3ad53bc1f6
4 changed files with 143 additions and 13 deletions
@@ -0,0 +1,128 @@
+---
+phase: 02-gemini-integration-asset-pipeline
+plan: 05
+subsystem: ui
+tags: [vite-assets, companion, avatar, greeting, fallback]
+
+requires:
+  - phase: 02-03
+    provides: "Generated avatar PNGs in src/assets/companions/"
+  - phase: 02-04
+    provides: "getGreeting() companion text function with API/fallback"
+provides:
+  - "Avatar images displayed on welcome screen companion cards"
+  - "Companion greeting with avatar on forest screen for returning users"
+  - "Companion avatar visible in lesson screen"
+  - "Emoji fallback when avatar images fail to load"
+affects: [03-lesson-phases, 04-forest-rewards]
+
+tech-stack:
+  added: []
+  patterns: ["Vite static import for PNG asset URL resolution", "onerror img fallback to emoji span"]
+
+key-files:
+  created:
+    - src/vite-env.d.ts
+  modified:
+    - src/companion/characters.ts
+    - src/ui/screens.ts
+    - src/app.ts
+    - src/styles/main.css
+    - index.html
+    - src/companion/fallbacks.ts
+
+key-decisions:
+  - "Vite static imports for avatar PNGs (hashed URLs in production builds)"
+  - "onerror handler hides img and shows emoji fallback for graceful degradation"
+  - "Greeting text fetched async after avatar shown immediately"
+
+patterns-established:
+  - "Avatar fallback: img with onerror hiding img and showing sibling emoji span"
+  - "Companion area: reusable .companion-area CSS class for avatar+text layouts"
+
+requirements-completed: [ASST-03, ASST-04]
+
+duration: 3min
+completed: 2026-03-29
+---
+
+# Phase 02 Plan 05: UI Integration Summary
+
+**Welcome screen avatar images via Vite static imports with emoji fallback, companion greeting on forest screen, and companion avatar in lesson screen**
+
+## Performance
+
+- **Duration:** 3 min
+- **Started:** 2026-03-29T10:13:07Z
+- **Completed:** 2026-03-29T10:16:07Z
+- **Tasks:** 3 (2 auto + 1 checkpoint auto-approved)
+- **Files modified:** 7
+
+## Accomplishments
+- Welcome screen companion cards now show real generated avatar PNGs instead of emoji
+- Forest screen displays companion avatar with AI-generated or fallback greeting text for returning users
+- Lesson screen shows companion avatar above the typing exercise area
+- Emoji fallback via onerror handler ensures graceful degradation when images fail
+
+## Task Commits
+
+Each task was committed atomically:
+
+1. **Task 1: Add avatar URLs to companion definitions and update welcome screen** - `2cf7687` (feat)
+2. **Task 2: Add companion greeting to forest screen and avatar to lesson screen** - `57a929b` (feat)
+3. **Task 3: Visual verification of Phase 2 integration** - auto-approved checkpoint, no separate commit
+
+## Files Created/Modified
+- `src/vite-env.d.ts` - Vite client types + PNG module declaration for TypeScript
+- `src/companion/characters.ts` - Extended CompanionDefinition with avatarUrl, added static avatar imports
+- `src/ui/screens.ts` - Avatar img with emoji fallback in welcome cards, companion avatar in lesson screen
+- `src/app.ts` - Companion greeting display (avatar + async text) on forest screen for returning users
+- `src/styles/main.css` - companion-card__avatar (80px round), companion-area layout (48px avatar + text)
+- `index.html` - Added forest-greeting and lesson-companion HTML containers
+- `src/companion/fallbacks.ts` - Fixed noUncheckedIndexedAccess errors with nullish coalescing
+
+## Decisions Made
+- Used Vite static imports (import ... from "*.png") for avatar URLs to get hashed URLs in production builds
+- onerror handler on img hides broken image and shows emoji sibling as fallback (per D-06)
+- Greeting text fetched asynchronously; avatar shows immediately while text loads
+- Lesson screen shows avatar only (no companion text per D-14 -- Phase 3 adds letter intros)
+
+## Deviations from Plan
+
+### Auto-fixed Issues
+
+**1. [Rule 3 - Blocking] Added vite-env.d.ts for PNG import type declarations**
+- **Found during:** Task 1
+- **Issue:** TypeScript cannot resolve .png imports without type declarations
+- **Fix:** Created src/vite-env.d.ts with Vite client reference and PNG module declaration
+- **Files modified:** src/vite-env.d.ts
+- **Verification:** tsc --noEmit passes for new imports
+- **Committed in:** 2cf7687 (Task 1 commit)
+
+**2. [Rule 3 - Blocking] Fixed noUncheckedIndexedAccess errors in fallbacks.ts**
+- **Found during:** Task 2
+- **Issue:** Pre-existing TS errors in fallbacks.ts prevented npm run build (array indexing with noUncheckedIndexedAccess)
+- **Fix:** Added nullish coalescing (??) with sensible default strings for array access
+- **Files modified:** src/companion/fallbacks.ts
+- **Verification:** npm run build succeeds
+- **Committed in:** 57a929b (Task 2 commit)
+
+---
+
+**Total deviations:** 2 auto-fixed (2 blocking)
+**Impact on plan:** Both fixes necessary for build to succeed. No scope creep.
+
+## Issues Encountered
+None beyond the auto-fixed blocking issues.
+
+## User Setup Required
+None - no external service configuration required.
+
+## Next Phase Readiness
+- Phase 02 (Gemini Integration + Asset Pipeline) is now complete
+- All companion avatars, greetings, and visual integration are wired up
+- Ready for Phase 03 (lesson phases with letter introductions, forest rewards)
+
+---
+*Phase: 02-gemini-integration-asset-pipeline*
+*Completed: 2026-03-29*