From 6e8d5412d8935bf767425c9e6c6adc19e7f19031 Mon Sep 17 00:00:00 2001 From: Seongho Bae Date: Sun, 23 Aug 2026 12:46:29 +0000 Subject: [PATCH] feat(workspace): name tonight's first transition on the map Name the changing part when corroborated, the owned transition cue, the labeled section, and the time so the next action is obvious. Open moves to the matching rendered map section. Do not invent a change from lyric, count, groove, setup, simplification, overlap, or range copy. --- AGENTS.md | 1 + ARCHITECTURE.md | 1 + CHANGELOG.md | 1 + CLAUDE.md | 2 +- .../FirstTransitionCallout.particle.test.tsx | 51 +++ ...tTransitionCallout.reduced-motion.test.tsx | 43 +++ .../workspace/FirstTransitionCallout.test.tsx | 221 ++++++++++++ .../workspace/FirstTransitionCallout.tsx | 139 ++++++++ .../src/features/workspace/Workspace.test.tsx | 23 ++ .../src/features/workspace/Workspace.tsx | 11 +- ...firstTransition.inherited-metadata.test.ts | 89 +++++ .../workspace/firstTransition.test.ts | 236 +++++++++++++ .../src/features/workspace/firstTransition.ts | 314 ++++++++++++++++++ apps/desktop/src/i18n/index.test.ts | 49 ++- apps/desktop/src/i18n/index.ts | 36 +- apps/desktop/src/locales/en/common.json | 10 +- apps/desktop/src/locales/ko/common.json | 10 +- apps/desktop/vite.config.ts | 4 +- docs/design-system/component-contract.md | 1 + ...uced-motion-first-transition-navigation.md | 14 + 20 files changed, 1248 insertions(+), 8 deletions(-) create mode 100644 apps/desktop/src/features/workspace/FirstTransitionCallout.particle.test.tsx create mode 100644 apps/desktop/src/features/workspace/FirstTransitionCallout.reduced-motion.test.tsx create mode 100644 apps/desktop/src/features/workspace/FirstTransitionCallout.test.tsx create mode 100644 apps/desktop/src/features/workspace/FirstTransitionCallout.tsx create mode 100644 apps/desktop/src/features/workspace/firstTransition.inherited-metadata.test.ts create mode 100644 apps/desktop/src/features/workspace/firstTransition.test.ts create mode 100644 apps/desktop/src/features/workspace/firstTransition.ts create mode 100644 docs/doctoring/reduced-motion-first-transition-navigation.md diff --git a/AGENTS.md b/AGENTS.md index fca448ce9..85dc12b50 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -83,6 +83,7 @@ This section applies to any agent (Claude, Codex, Cursor, opencode, ...) working - Keep UI and analysis engine decoupled through shared contracts. - Prefer minimal, test-first changes for production code. - Prefer practical, friendly, rehearsal-first wording over academic or authority-heavy language. +- Name tonight's first transition with the changing part when an active role is corroborated, the owned transition cue, the labeled section, and the time so the next action is obvious. - Do not reduce the product to a chord analyzer when form, timing, player coordination, simplification, and setup cues are the real rehearsal blockers. - Do not frame usability as a reason to accept weak analysis quality; BandScope should aim for both easy use and high accuracy. diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 3302a6fc3..b62d224b4 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -5,6 +5,7 @@ Last updated: 2026-03-11 ## Brand source - Product identity, UX tone, copy rules, and prioritization tie-breakers live in `docs/brand-story.md`. +- The mounted workspace copy for tonight's first transition must name the changing part when corroborated, the owned transition cue, the labeled section, and the time so the next action is obvious. Open moves to the matching rendered map section. Do not invent a change from lyric, count, groove, setup, simplification, overlap, or range copy. - Future PRDs, TRDs, onboarding copy, empty states, error messages, and marketing copy should use that document as the single brand source of truth. ## Security source diff --git a/CHANGELOG.md b/CHANGELOG.md index eea696893..80ec5dd0d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ ### Added - Display the analyzed song tempo (BPM) as a badge in the rehearsal workspace. +- Name tonight's first transition in the mounted rehearsal workspace so the room can catch the change together; the Open action moves to the matching rendered map section, while inherited or accessor-backed runtime metadata remains guidance-only instead of becoming navigation authority. - 각 합주 역할(Role)별 개인 연습 진행도를 0~100% 범위로 기록 및 시각화할 수 있는 연습 진척도(`practiceProgress`) 트래커 기능 추가. UI 컨트롤(슬라이더 및 +/- 버튼)과 한/영 다국어 지원 포함. ## [0.1.3] - 2026-04-29 diff --git a/CLAUDE.md b/CLAUDE.md index 82c2c704a..10fca37cf 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -51,7 +51,7 @@ BandScope is a local-first desktop app for rehearsal prep: it turns a song into Three layers, decoupled through shared contracts: -- `apps/desktop` — Tauri 2 + Vite + React 19 shell (Tailwind 4, Base UI, Storybook). Feature screens live in `src/features/` (home, workspace, chords, ranges, player, settings). `src/lib/analysis.ts` and `src/lib/job_runner.ts` call typed Tauri IPC commands, with a browser fallback that serves demo data when not running inside Tauri. +- `apps/desktop` — Tauri 2 + Vite + React 19 shell (Tailwind 4, Base UI, Storybook). Feature screens live in `src/features/` (home, workspace, chords, ranges, player, settings). The mounted workspace names tonight's first transition and opens the matching rendered map section. Do not invent a change from lyric, count, groove, setup, simplification, overlap, or range copy. `src/lib/analysis.ts` and `src/lib/job_runner.ts` call typed Tauri IPC commands, with a browser fallback that serves demo data when not running inside Tauri. - `apps/desktop/src-tauri/src/main.rs` — the Rust orchestration boundary. Tauri commands (`start_analysis_job`, `get_analysis_job_status`, `select_local_audio_source`, `import_youtube_url`) validate untrusted input (project IDs, file paths, URLs) and spawn the Python engine as a subprocess. There is no loopback HTTP listener and no network path for local analysis. - `services/analysis-engine` — Python package `bandscope_analysis` (librosa/numpy). Entry point `cli.py` reads a JSON job request on stdin and prints a structured job-status JSON envelope on stdout (`--progress-jsonl` streams progress lines). `api.py` orchestrates the pipeline across the `separation`, `sections`, `roles`, `chords`, `ranges`, `temporal`, `transcription`, and `youtube` modules. diff --git a/apps/desktop/src/features/workspace/FirstTransitionCallout.particle.test.tsx b/apps/desktop/src/features/workspace/FirstTransitionCallout.particle.test.tsx new file mode 100644 index 000000000..4c3b3cfa0 --- /dev/null +++ b/apps/desktop/src/features/workspace/FirstTransitionCallout.particle.test.tsx @@ -0,0 +1,51 @@ +import { fireEvent, render, screen } from "@testing-library/react"; +import { createDemoRehearsalSong } from "@bandscope/shared-types"; +import { afterEach, describe, expect, it, vi } from "vitest"; +import { FirstTransitionCallout } from "./FirstTransitionCallout"; + +describe("FirstTransitionCallout Korean role copy", () => { + afterEach(() => { + vi.unstubAllGlobals(); + }); + + it("keeps vowel-ending dynamic role names particle-safe before and after the transition action", () => { + vi.stubGlobal("navigator", { language: "ko-KR" }); + const song = createDemoRehearsalSong(); + const seed = song.sections[0]!; + seed.roles = [ + { + ...seed.roles[0]!, + id: "piano", + name: "피아노", + rehearsalPriority: "high", + cue: { kind: "transition", value: "픽업 직전까지 붙잡으세요." } + } + ]; + seed.partGraph = [{ role_id: "piano", is_active: true, handoff_to: [], handoff_from: [] }]; + + const grid = document.createElement("div"); + grid.dataset.testid = "song-structure-grid"; + grid.setAttribute("role", "region"); + grid.setAttribute("aria-label", "Scrollable song structure timeline"); + const target = document.createElement("div"); + target.dataset.sectionIndex = "0"; + Object.defineProperty(target, "scrollIntoView", { + configurable: true, + value: vi.fn() + }); + grid.appendChild(target); + document.body.appendChild(grid); + + render(); + + expect(screen.getByText("0:10 벌스에서 피아노 파트가 바뀝니다.")).toBeTruthy(); + expect(screen.queryByText(/피아노이/)).toBeNull(); + + fireEvent.click(screen.getByRole("button", { name: "0:10 피아노 전환 위치 열기" })); + + expect(screen.getByText("0:10에서 피아노 파트 전환을 잡으세요. 끝까지 붙잡으세요.")).toBeTruthy(); + expect(screen.queryByText(/피아노과/)).toBeNull(); + + grid.remove(); + }); +}); diff --git a/apps/desktop/src/features/workspace/FirstTransitionCallout.reduced-motion.test.tsx b/apps/desktop/src/features/workspace/FirstTransitionCallout.reduced-motion.test.tsx new file mode 100644 index 000000000..87c200191 --- /dev/null +++ b/apps/desktop/src/features/workspace/FirstTransitionCallout.reduced-motion.test.tsx @@ -0,0 +1,43 @@ +import { fireEvent, render, screen } from "@testing-library/react"; +import { createDemoRehearsalSong } from "@bandscope/shared-types"; +import { afterEach, describe, expect, it, vi } from "vitest"; +import { FirstTransitionCallout } from "./FirstTransitionCallout"; + +describe("FirstTransitionCallout reduced motion", () => { + afterEach(() => { + vi.unstubAllGlobals(); + }); + + it("scrolls immediately when the operating system requests reduced motion", () => { + vi.stubGlobal("matchMedia", (query: string) => ({ + matches: query === "(prefers-reduced-motion: reduce)", + media: query, + onchange: null, + addListener: vi.fn(), + removeListener: vi.fn(), + addEventListener: vi.fn(), + removeEventListener: vi.fn(), + dispatchEvent: vi.fn() + })); + + const grid = document.createElement("div"); + grid.dataset.testid = "song-structure-grid"; + grid.setAttribute("role", "region"); + grid.setAttribute("aria-label", "Scrollable song structure timeline"); + const target = document.createElement("div"); + target.dataset.sectionIndex = "0"; + const scrollIntoView = vi.fn(); + Object.defineProperty(target, "scrollIntoView", { + configurable: true, + value: scrollIntoView + }); + grid.appendChild(target); + document.body.appendChild(grid); + + render(); + fireEvent.click(screen.getByRole("button", { name: "Open Bass Guitar transition at 0:10" })); + expect(scrollIntoView).toHaveBeenCalledWith({ block: "nearest", behavior: "auto" }); + + grid.remove(); + }); +}); diff --git a/apps/desktop/src/features/workspace/FirstTransitionCallout.test.tsx b/apps/desktop/src/features/workspace/FirstTransitionCallout.test.tsx new file mode 100644 index 000000000..7c9b44e9d --- /dev/null +++ b/apps/desktop/src/features/workspace/FirstTransitionCallout.test.tsx @@ -0,0 +1,221 @@ +import { fireEvent, render, screen } from "@testing-library/react"; +import { createDemoRehearsalSong, type RehearsalSong } from "@bandscope/shared-types"; +import { afterEach, describe, expect, it, vi } from "vitest"; +import { FirstTransitionCallout } from "./FirstTransitionCallout"; + +function songWithTransition() { + return createDemoRehearsalSong(); +} + +function appendSongStructureTarget(ariaLabel = "Scrollable song structure timeline") { + const timeline = document.createElement("div"); + timeline.setAttribute("role", "region"); + timeline.setAttribute("aria-label", ariaLabel); + const grid = document.createElement("div"); + grid.dataset.testid = "song-structure-grid"; + const target = document.createElement("div"); + target.dataset.sectionIndex = "0"; + const scrollIntoView = vi.fn(); + Object.defineProperty(target, "scrollIntoView", { + configurable: true, + value: scrollIntoView + }); + grid.appendChild(target); + timeline.appendChild(grid); + document.body.appendChild(timeline); + return { grid: timeline, scrollIntoView }; +} + +describe("FirstTransitionCallout", () => { + afterEach(() => { + vi.unstubAllGlobals(); + }); + + it("contains a malformed runtime song root instead of crashing the callout", () => { + render(); + + expect( + screen.getByText("No transition yet. Stay on tonight's map until a part names the change.") + ).toBeTruthy(); + }); + + it("contains a hostile song identity accessor instead of crashing the callout", () => { + const song = songWithTransition(); + Object.defineProperty(song, "id", { + configurable: true, + enumerable: true, + get() { + throw new Error("hostile song id getter"); + } + }); + + expect(() => render()).not.toThrow(); + expect(screen.getByRole("button", { name: "Open Bass Guitar transition at 0:10" })).toBeTruthy(); + }); + + it("resets armed guidance when accessor-id songs change with the same transition signature", () => { + const firstSong = songWithTransition(); + const nextSong = songWithTransition(); + for (const song of [firstSong, nextSong]) { + Object.defineProperty(song, "id", { + configurable: true, + enumerable: true, + get() { + throw new Error("hostile song id getter"); + } + }); + } + const { grid } = appendSongStructureTarget(); + const { rerender } = render(); + + fireEvent.click(screen.getByRole("button", { name: "Open Bass Guitar transition at 0:10" })); + expect(screen.getByText(/Catch the change with Bass Guitar at 0:10. Hold through together./)).toBeTruthy(); + + rerender(); + + expect(screen.getByText("Bass Guitar changes in the verse at 0:10.")).toBeTruthy(); + expect(screen.queryByText(/Catch the change with Bass Guitar at 0:10. Hold through together./)).toBeNull(); + + grid.remove(); + }); + + it("names the first transition as map navigation, scrolls to its rendered section, and arms that action", () => { + const { grid, scrollIntoView } = appendSongStructureTarget(); + + render(); + + expect(screen.getByText("Hold through the pickup before the downbeat.")).toBeTruthy(); + const action = screen.getByRole("button", { + name: "Open Bass Guitar transition at 0:10" + }); + expect(action).toBeTruthy(); + fireEvent.click(action); + expect(scrollIntoView).toHaveBeenCalledWith({ block: "nearest", behavior: "smooth" }); + expect(screen.getByText(/Catch the change with Bass Guitar at 0:10. Hold through together./)).toBeTruthy(); + + grid.remove(); + }); + + it("keeps map navigation stable when the renderer accessible name is localized", () => { + const { grid, scrollIntoView } = appendSongStructureTarget("스크롤 가능한 곡 구조 타임라인"); + + render(); + + fireEvent.click(screen.getByRole("button", { name: "Open Bass Guitar transition at 0:10" })); + + expect(scrollIntoView).toHaveBeenCalledWith({ block: "nearest", behavior: "smooth" }); + expect(screen.getByText(/Catch the change with Bass Guitar at 0:10. Hold through together./)).toBeTruthy(); + + grid.remove(); + }); + + it("does not claim map navigation completed when the rendered section target is missing", () => { + render(); + + fireEvent.click(screen.getByRole("button", { name: "Open Bass Guitar transition at 0:10" })); + + expect(screen.getByText("Bass Guitar changes in the verse at 0:10.")).toBeTruthy(); + expect(screen.queryByText(/Catch the change with Bass Guitar at 0:10. Hold through together./)).toBeNull(); + }); + + it("navigates by renderer-owned section position instead of untrusted analysis ids", () => { + const song = songWithTransition(); + song.sections[0]!.id = "analysis section / duplicate"; + const { grid, scrollIntoView } = appendSongStructureTarget(); + + render(); + + fireEvent.click(screen.getByRole("button", { name: "Open Bass Guitar transition at 0:10" })); + expect(scrollIntoView).toHaveBeenCalledWith({ block: "nearest", behavior: "smooth" }); + + grid.remove(); + }); + + it("scopes map navigation to the song-structure renderer when another surface reuses an index", () => { + const decoy = document.createElement("div"); + decoy.dataset.sectionIndex = "0"; + const decoyScrollIntoView = vi.fn(); + Object.defineProperty(decoy, "scrollIntoView", { + configurable: true, + value: decoyScrollIntoView + }); + document.body.appendChild(decoy); + const { grid, scrollIntoView } = appendSongStructureTarget(); + + render(); + + fireEvent.click(screen.getByRole("button", { name: "Open Bass Guitar transition at 0:10" })); + + expect(decoyScrollIntoView).not.toHaveBeenCalled(); + expect(scrollIntoView).toHaveBeenCalledWith({ block: "nearest", behavior: "smooth" }); + + decoy.remove(); + grid.remove(); + }); + + it("shows fresh guidance when the first transition changes or returns later", () => { + const initialSong = songWithTransition(); + const { grid } = appendSongStructureTarget(); + const { rerender } = render(); + fireEvent.click(screen.getByRole("button", { name: "Open Bass Guitar transition at 0:10" })); + expect(screen.getByText(/Catch the change with Bass Guitar at 0:10. Hold through together./)).toBeTruthy(); + + const nextSong = songWithTransition(); + nextSong.id = "next-song"; + nextSong.sections[0]!.timeRange = { start: 20, end: 40 }; + rerender(); + expect(screen.getByText("Bass Guitar changes in the verse at 0:20.")).toBeTruthy(); + + grid.remove(); + }); + + it("keeps an unavailable transition guidance-only", () => { + const song = songWithTransition(); + for (const role of song.sections[0]!.roles) { + role.cue = { kind: "lyric", value: "city lights" }; + } + render(); + expect(screen.queryByRole("button")).toBeNull(); + expect( + screen.getByText("No transition yet. Stay on tonight's map until a part names the change.") + ).toBeTruthy(); + }); + + it("names a band-wide transition when no part carries it", () => { + const song = songWithTransition(); + for (const node of song.sections[0]!.partGraph) { + node.is_active = false; + } + const { grid, scrollIntoView } = appendSongStructureTarget(); + render(); + const action = screen.getByRole("button", { name: "Open the first transition at 0:10" }); + expect(screen.getByText("The band changes in the verse at 0:10.")).toBeTruthy(); + fireEvent.click(action); + expect(scrollIntoView).toHaveBeenCalledWith({ block: "nearest", behavior: "smooth" }); + expect(screen.getByText("Catch the change at 0:10. Hold through together.")).toBeTruthy(); + grid.remove(); + }); + + it("localizes the transition form label instead of exposing its raw enum in Korean copy", () => { + vi.stubGlobal("navigator", { language: "ko-KR" }); + const song = songWithTransition(); + song.sections[0]!.roles[0]!.name = "베이스 기타"; + song.sections[0]!.roles[1]!.rehearsalPriority = "low"; + song.sections[0]!.roles[2]!.rehearsalPriority = "low"; + + render(); + + expect(screen.getByText("0:10 벌스에서 베이스 기타 파트가 바뀝니다.")).toBeTruthy(); + expect(screen.queryByText(/verse에서/)).toBeNull(); + }); + + it("renders the owned transition cue as a text node instead of template syntax", () => { + const song = songWithTransition(); + song.sections[0]!.roles[0]!.cue = { kind: "transition", value: "Hold {role} at {at}" }; + song.sections[0]!.roles[1]!.cue = { kind: "count", value: "Enter on beat 2 after the pickup." }; + song.sections[0]!.roles[2]!.cue = { kind: "lyric", value: "city lights" }; + render(); + expect(screen.getByText("Hold {role} at {at}")).toBeTruthy(); + expect(screen.queryByText("Hold Bass Guitar at 0:10")).toBeNull(); + }); +}); diff --git a/apps/desktop/src/features/workspace/FirstTransitionCallout.tsx b/apps/desktop/src/features/workspace/FirstTransitionCallout.tsx new file mode 100644 index 000000000..868a886d2 --- /dev/null +++ b/apps/desktop/src/features/workspace/FirstTransitionCallout.tsx @@ -0,0 +1,139 @@ +import { useEffect, useState } from "react"; +import type { RehearsalSong } from "@bandscope/shared-types"; +import { Button } from "@/components/ui/button"; +import { + createTranslator, + detectPreferredLocale, + translateSectionFormLabel +} from "../../i18n"; +import { formatTransitionTime, resolveFirstTransition } from "./firstTransition"; + +/** Props for the first-transition rehearsal callout. */ +export interface FirstTransitionCalloutProps { + song: RehearsalSong; +} + +type TransitionCopyValues = Readonly>; + +type OpenedTransition = Readonly<{ + songIdentity: unknown; + sectionId: string; + sectionIndex: number; + holdingRoleId: string | null; + atSeconds: number; +}>; + +/** Interpolate transition placeholders once so rehearsal data is never rescanned as template syntax. */ +function formatTransitionCopy(template: string, values: TransitionCopyValues): string { + return template.replace(/\{(role|section|at)\}/g, (placeholder) => { + const key = placeholder.slice(1, -1) as keyof TransitionCopyValues; + return values[key] ?? placeholder; + }); +} + +/** Use immediate scrolling when the operating system requests reduced motion. */ +function preferredTransitionScrollBehavior(): ScrollBehavior { + return typeof window.matchMedia === "function" && + window.matchMedia("(prefers-reduced-motion: reduce)").matches + ? "auto" + : "smooth"; +} + +/** Name tonight's first transition and open the matching rendered map section. */ +export function FirstTransitionCallout({ song }: FirstTransitionCalloutProps) { + const locale = detectPreferredLocale(); + const t = createTranslator(locale); + const songIdentity: unknown = song; + const runtimeSong = song as unknown as Partial | null; + const transition = resolveFirstTransition(song); + const transitionSectionIndex = + transition && Array.isArray(runtimeSong?.sections) + ? runtimeSong.sections.indexOf(transition.section) + : -1; + const [openedTransition, setOpenedTransition] = useState(null); + + useEffect(() => { + setOpenedTransition(null); + }, [songIdentity, transitionSectionIndex, transition?.section.id, transition?.holdingRole?.id, transition?.atSeconds]); + + if (!transition) { + return ( + + ); + } + + const opened = + openedTransition !== null && + openedTransition.songIdentity === songIdentity && + openedTransition.sectionId === transition.section.id && + openedTransition.sectionIndex === transitionSectionIndex && + openedTransition.holdingRoleId === (transition.holdingRole?.id ?? null) && + openedTransition.atSeconds === transition.atSeconds; + const at = formatTransitionTime(transition.atSeconds); + const copyValues: TransitionCopyValues = { + role: transition.holdingRole?.name ?? "", + section: translateSectionFormLabel(locale, transition.section.label), + at + }; + const hasRole = transition.holdingRole !== null; + const actionLabel = formatTransitionCopy( + t(hasRole ? "firstTransitionOpenAction" : "firstTransitionOpenActionBand"), + copyValues + ); + const body = formatTransitionCopy( + t(hasRole ? "firstTransitionBody" : "firstTransitionBodyBand"), + copyValues + ); + const armed = formatTransitionCopy( + t(hasRole ? "firstTransitionArmed" : "firstTransitionArmedBand"), + copyValues + ); + + return ( + + ); +} diff --git a/apps/desktop/src/features/workspace/Workspace.test.tsx b/apps/desktop/src/features/workspace/Workspace.test.tsx index a3da5ffe6..94b111244 100644 --- a/apps/desktop/src/features/workspace/Workspace.test.tsx +++ b/apps/desktop/src/features/workspace/Workspace.test.tsx @@ -270,4 +270,27 @@ describe("Workspace", () => { expect(screen.getByText("합주 우선순위")).toBeTruthy(); expect(screen.getByText("역할과 화성")).toBeTruthy(); }); + + it("names tonight's first transition as workspace navigation", () => { + const song = createDemoRehearsalSong(); + + render(); + + const target = screen.getByTestId("song-structure-grid").children.item(0); + expect(target).toBeTruthy(); + const scrollIntoView = vi.fn(); + Object.defineProperty(target!, "scrollIntoView", { + configurable: true, + value: scrollIntoView + }); + + expect(screen.getAllByText("Hold through the pickup before the downbeat.").length).toBeGreaterThan(0); + const action = screen.getByRole("button", { + name: "Open Bass Guitar transition at 0:10" + }); + expect(action).toBeTruthy(); + fireEvent.click(action); + expect(scrollIntoView).toHaveBeenCalledWith({ block: "nearest", behavior: "smooth" }); + expect(screen.getByText(/Catch the change with Bass Guitar at 0:10. Hold through together./)).toBeTruthy(); + }); }); diff --git a/apps/desktop/src/features/workspace/Workspace.tsx b/apps/desktop/src/features/workspace/Workspace.tsx index 71546b524..36410a8aa 100644 --- a/apps/desktop/src/features/workspace/Workspace.tsx +++ b/apps/desktop/src/features/workspace/Workspace.tsx @@ -4,6 +4,7 @@ import { RoleSwitcher } from "./RoleSwitcher"; import { SectionRoadmap } from "./SectionRoadmap"; import { GrooveMap } from "./GrooveMap"; import { PracticeProgress } from "./PracticeProgress"; +import { FirstTransitionCallout } from "./FirstTransitionCallout"; import { createTranslator, detectPreferredLocale } from "../../i18n"; import { generateCueSheetCsv, generateChartSummaryJson, generateMetadataHandoffJson, sanitizeFilename } from "../../lib/export"; import { Button } from "@/components/ui/button"; @@ -90,8 +91,12 @@ const SongStructure = memo(function SongStructure({ sections, t }: { sections: R data-testid="song-structure-grid" style={{ gridTemplateColumns: `repeat(${Math.max(1, sections.length)}, minmax(8rem, 1fr))` }} > - {sections.map((section) => ( -
+ {sections.map((section, sectionIndex) => ( +

{section.label} · {formatTimelineTime(section.timeRange.start)}–{formatTimelineTime(section.timeRange.end)}

@@ -331,6 +336,8 @@ export function Workspace({ song, sourceBootstrap = null, onSongUpdate }: Worksp
+ +
diff --git a/apps/desktop/src/features/workspace/firstTransition.inherited-metadata.test.ts b/apps/desktop/src/features/workspace/firstTransition.inherited-metadata.test.ts new file mode 100644 index 000000000..7a285287e --- /dev/null +++ b/apps/desktop/src/features/workspace/firstTransition.inherited-metadata.test.ts @@ -0,0 +1,89 @@ +import { createDemoRehearsalSong } from "@bandscope/shared-types"; +import { describe, expect, it } from "vitest"; +import { resolveFirstTransition } from "./firstTransition"; + +function songWithTransition() { + const song = createDemoRehearsalSong(); + const section = structuredClone(song.sections[0]!); + section.id = "transition-own"; + section.roles = [ + { + ...section.roles[0]!, + cue: { kind: "transition", value: "Hold through the pickup before the downbeat." } + } + ]; + song.sections = [section]; + return { song, section }; +} + +describe("resolveFirstTransition inherited metadata", () => { + it("rejects a song or section whose required metadata is inherited", () => { + const { song, section } = songWithTransition(); + const inheritedSong = Object.create({ sections: song.sections }) as typeof song; + expect(resolveFirstTransition(inheritedSong)).toBeNull(); + + const inheritedSection = Object.create(section) as typeof section; + song.sections = [inheritedSection]; + expect(resolveFirstTransition(song)).toBeNull(); + }); + + it("rejects inherited timing fields", () => { + const { song, section } = songWithTransition(); + section.timeRange = Object.create({ start: 10, end: 30 }) as typeof section.timeRange; + expect(resolveFirstTransition(song)).toBeNull(); + }); + + it("contains exceptions from own runtime accessors instead of trusting them", () => { + const { song, section } = songWithTransition(); + Object.defineProperty(section.roles[0]!, "cue", { + configurable: true, + enumerable: true, + get() { + throw new Error("hostile cue getter"); + } + }); + + expect(() => resolveFirstTransition(song)).not.toThrow(); + expect(resolveFirstTransition(song)).toBeNull(); + }); + + it("does not treat own accessors as stable transition identity authority", () => { + const { song, section } = songWithTransition(); + Object.defineProperty(section, "id", { + configurable: true, + enumerable: true, + get() { + return "transition-own"; + } + }); + + expect(resolveFirstTransition(song)).toBeNull(); + }); + + it("does not let inherited cue metadata establish the change", () => { + const { song, section } = songWithTransition(); + section.roles[0]!.cue = Object.create({ + kind: "transition", + value: "Inherited hold" + }) as typeof section.roles[0]["cue"]; + expect(resolveFirstTransition(song)).toBeNull(); + }); + + it("does not let inherited role or graph metadata establish the holding part", () => { + const { song, section } = songWithTransition(); + const node = section.partGraph[0]!; + section.partGraph = [Object.create(node) as typeof node]; + + const resolved = resolveFirstTransition(song); + expect(resolved?.section.id).toBe("transition-own"); + expect(resolved?.holdingRole).toBeNull(); + expect(resolved?.hint).toBe("Hold through the pickup before the downbeat."); + }); + + it("rejects arrays masquerading as section records", () => { + const { song, section } = songWithTransition(); + const arraySection = Object.assign([], section) as unknown as typeof section; + song.sections = [arraySection]; + expect(resolveFirstTransition(song)).toBeNull(); + }); +}); diff --git a/apps/desktop/src/features/workspace/firstTransition.test.ts b/apps/desktop/src/features/workspace/firstTransition.test.ts new file mode 100644 index 000000000..096a5902e --- /dev/null +++ b/apps/desktop/src/features/workspace/firstTransition.test.ts @@ -0,0 +1,236 @@ +import { describe, expect, it } from "vitest"; +import { MAX_SECTION_TIME_SECONDS, createDemoRehearsalSong } from "@bandscope/shared-types"; +import { formatTransitionTime, resolveFirstTransition } from "./firstTransition"; + +function withTransitionSection( + overrides: { + id?: string; + start?: number; + end?: number; + hint?: string; + label?: "intro" | "verse" | "chorus" | "bridge" | "outro" | "tag"; + roleId?: string; + roleName?: string; + priority?: "low" | "medium" | "high"; + isActive?: boolean; + } = {} +) { + const song = createDemoRehearsalSong(); + const verse = song.sections[0]!; + const section = structuredClone(verse); + section.id = overrides.id ?? "verse-transition"; + section.label = overrides.label ?? "verse"; + section.groove = "Straight eighths with a late snare feel"; + section.timeRange = { start: overrides.start ?? 10, end: overrides.end ?? 30 }; + const roleId = overrides.roleId ?? "bass-guitar"; + section.roles = [ + { + ...verse.roles[0]!, + id: roleId, + name: overrides.roleName ?? "Bass Guitar", + rehearsalPriority: overrides.priority ?? "high", + cue: { + kind: "transition", + value: overrides.hint ?? "Hold through the pickup before the downbeat." + }, + overlapWarnings: [], + setupNote: "Keep the attack short so the verse breathes.", + simplification: "Stay on roots if the chorus entrance gets muddy." + } + ]; + section.partGraph = [ + { + role_id: roleId, + is_active: overrides.isActive ?? true, + handoff_to: [], + handoff_from: [] + } + ]; + song.sections = [section]; + return song; +} + +describe("resolveFirstTransition", () => { + it("picks the demo song's earliest named transition and the part that carries it", () => { + const resolved = resolveFirstTransition(createDemoRehearsalSong()); + expect(resolved?.section.id).toBe("verse-1"); + expect(resolved?.holdingRole?.id).toBe("bass-guitar"); + expect(resolved?.atSeconds).toBe(10); + expect(resolved?.hint).toBe("Hold through the pickup before the downbeat."); + expect(formatTransitionTime(resolved?.atSeconds ?? -1)).toBe("0:10"); + expect(formatTransitionTime(Number.NaN)).toBe("0:00"); + expect(formatTransitionTime(-4)).toBe("0:00"); + }); + + it("does not invent a change from lyric, count, groove, setup, simplification, overlap, or range copy", () => { + const song = withTransitionSection({ hint: " " }); + song.sections[0]!.groove = "Straight eighths with a late snare feel"; + song.sections[0]!.roles[0]!.setupNote = "Keep the attack short so the verse breathes."; + song.sections[0]!.roles[0]!.simplification = "Stay on roots if the chorus entrance gets muddy."; + song.sections[0]!.roles[0]!.cue = { kind: "lyric", value: "Hold through the pickup." }; + song.sections[0]!.roles[0]!.overlapWarnings = [ + "Density warning: competing with Keyboard Left Hand in low register." + ]; + song.sections[0]!.roles[0]!.range = { lowestNote: "C#2", highestNote: "E3" }; + expect(resolveFirstTransition(song)).toBeNull(); + + song.sections[0]!.roles[0]!.cue = { kind: "count", value: "Enter on beat 2 after the pickup." }; + expect(resolveFirstTransition(song)).toBeNull(); + }); + + it("does not treat an empty or whitespace transition cue as a named change", () => { + expect(resolveFirstTransition(withTransitionSection({ hint: "" }))).toBeNull(); + expect(resolveFirstTransition(withTransitionSection({ hint: " \n\t " }))).toBeNull(); + }); + + it("prefers the earlier of two named transitions", () => { + const song = withTransitionSection({ id: "verse-late", start: 40, end: 56, roleId: "keys-right" }); + const earlier = structuredClone(song.sections[0]!); + earlier.id = "verse-early"; + earlier.roles = [ + { + ...earlier.roles[0]!, + id: "bass-guitar", + name: "Bass Guitar", + rehearsalPriority: "medium", + cue: { kind: "transition", value: "Hold the floor through the pickup." } + } + ]; + earlier.timeRange = { start: 8, end: 24 }; + earlier.partGraph = [{ role_id: "bass-guitar", is_active: true, handoff_to: [], handoff_from: [] }]; + song.sections = [song.sections[0]!, earlier]; + + const resolved = resolveFirstTransition(song); + expect(resolved?.section.id).toBe("verse-early"); + expect(resolved?.holdingRole?.id).toBe("bass-guitar"); + expect(resolved?.hint).toBe("Hold the floor through the pickup."); + expect(resolved?.atSeconds).toBe(8); + }); + + it("breaks same-time transition ties with locale-independent id ordering", () => { + const song = withTransitionSection({ id: "ä-transition", start: 10, end: 26 }); + const ascii = structuredClone(song.sections[0]!); + ascii.id = "z-transition"; + song.sections = [song.sections[0]!, ascii]; + + expect(resolveFirstTransition(song)?.section.id).toBe("z-transition"); + }); + + it("breaks equal-priority role ties with locale-independent id ordering", () => { + const song = withTransitionSection({ roleId: "ä-role", roleName: "Umlaut role", priority: "high" }); + const section = song.sections[0]!; + const asciiRole = { + ...section.roles[0]!, + id: "z-role", + name: "ASCII role", + cue: { kind: "transition" as const, value: "ASCII hold" } + }; + section.roles = [section.roles[0]!, asciiRole]; + section.partGraph = [ + { role_id: "ä-role", is_active: true, handoff_to: [], handoff_from: [] }, + { role_id: "z-role", is_active: true, handoff_to: [], handoff_from: [] } + ]; + + expect(resolveFirstTransition(song)?.holdingRole?.id).toBe("z-role"); + }); + + it("keeps a band-wide transition when no active ranked role carries it", () => { + const song = withTransitionSection({ isActive: false }); + const resolved = resolveFirstTransition(song); + expect(resolved?.section.id).toBe("verse-transition"); + expect(resolved?.holdingRole).toBeNull(); + expect(resolved?.hint).toBe("Hold through the pickup before the downbeat."); + }); + + it("skips a transition whose rehearsal window is unbounded", () => { + expect(resolveFirstTransition(withTransitionSection({ start: Number.NaN, end: 30 }))).toBeNull(); + }); + + it("skips a transition whose end precedes its start", () => { + expect(resolveFirstTransition(withTransitionSection({ start: 30, end: 10 }))).toBeNull(); + }); + + it("skips a zero-length transition window", () => { + expect(resolveFirstTransition(withTransitionSection({ start: 10, end: 10 }))).toBeNull(); + }); + + it("skips a transition whose endpoint overflows the shared timing bound", () => { + expect( + resolveFirstTransition( + withTransitionSection({ + start: MAX_SECTION_TIME_SECONDS, + end: MAX_SECTION_TIME_SECONDS + 1 + }) + ) + ).toBeNull(); + }); + + it("returns null for a non-object song root", () => { + expect(resolveFirstTransition(null as never)).toBeNull(); + }); + + it("returns null when the runtime section collection is sparse", () => { + const song = withTransitionSection(); + const sparseSections: typeof song.sections = new Array(2); + sparseSections[1] = song.sections[0]!; + song.sections = sparseSections; + expect(resolveFirstTransition(song)).toBeNull(); + }); + + it("keeps the transition band-wide when role identities are duplicated", () => { + const song = withTransitionSection(); + const role = song.sections[0]!.roles[0]!; + song.sections[0]!.roles = [role, { ...role }]; + song.sections[0]!.partGraph = [ + { role_id: role.id, is_active: true, handoff_to: [], handoff_from: [] }, + { role_id: role.id, is_active: true, handoff_to: [], handoff_from: [] } + ]; + const resolved = resolveFirstTransition(song); + expect(resolved?.section.id).toBe("verse-transition"); + expect(resolved?.holdingRole).toBeNull(); + }); + + it("bounds the transition hint to 180 Unicode code points", () => { + const song = withTransitionSection({ hint: `${"a".repeat(200)}` }); + const resolved = resolveFirstTransition(song); + expect(resolved?.hint.length).toBe(180); + }); + + it("does not split a Unicode surrogate pair at the hint boundary", () => { + const song = withTransitionSection({ hint: `${"a".repeat(179)}😀tail` }); + const resolved = resolveFirstTransition(song); + expect(Array.from(resolved?.hint ?? "")).toHaveLength(180); + expect(resolved?.hint.endsWith("😀")).toBe(true); + }); + + it("skips non-object roles while keeping a later owned transition", () => { + const song = withTransitionSection(); + const validRole = song.sections[0]!.roles[0]!; + song.sections[0]!.roles = [42 as never, validRole]; + const resolved = resolveFirstTransition(song); + expect(resolved?.holdingRole?.id).toBe("bass-guitar"); + expect(resolved?.hint).toBe("Hold through the pickup before the downbeat."); + }); + + it("keeps a deterministic winner when two named transitions share time and id", () => { + const song = withTransitionSection({ id: "shared-id", start: 10, end: 26 }); + const twin = structuredClone(song.sections[0]!); + song.sections = [song.sections[0]!, twin]; + const resolved = resolveFirstTransition(song); + expect(resolved?.section.id).toBe("shared-id"); + expect(resolved?.atSeconds).toBe(10); + }); + + it("contains throws from untrusted runtime property access", () => { + const song = withTransitionSection(); + const hostile = new Proxy(song, { + get(target, prop, receiver) { + if (prop === "sections") { + throw new Error("hostile sections"); + } + return Reflect.get(target, prop, receiver); + } + }); + expect(resolveFirstTransition(hostile as typeof song)).toBeNull(); + }); +}); diff --git a/apps/desktop/src/features/workspace/firstTransition.ts b/apps/desktop/src/features/workspace/firstTransition.ts new file mode 100644 index 000000000..169064135 --- /dev/null +++ b/apps/desktop/src/features/workspace/firstTransition.ts @@ -0,0 +1,314 @@ +import { + MAX_SECTION_TIME_SECONDS, + type CueAnchor, + type RehearsalRole, + type RehearsalSection, + type RehearsalSong +} from "@bandscope/shared-types"; + +const PRIORITY_RANK = { high: 0, medium: 1, low: 2 } as const; +const MAX_TRANSITION_CHARACTERS = 180; + +/** Tonight's first named transition: the earliest owned change and the part that carries it. */ +export type FirstTransition = { + section: RehearsalSection; + holdingRole: RehearsalRole | null; + atSeconds: number; + hint: string; +}; + +/** Format a non-negative transition time as m:ss for rehearsal copy. */ +export function formatTransitionTime(totalSeconds: number): string { + const safeSeconds = Number.isFinite(totalSeconds) && totalSeconds >= 0 ? totalSeconds : 0; + const minutes = Math.floor(safeSeconds / 60); + const seconds = Math.floor(safeSeconds % 60) + .toString() + .padStart(2, "0"); + return `${minutes}:${seconds}`; +} + +/** Compare opaque ids by Unicode code units so tie-breaking never depends on host locale. */ +function compareStableId(left: string, right: string): number { + if (left < right) { + return -1; + } + if (left > right) { + return 1; + } + return 0; +} + +/** Return whether an untrusted runtime value can be inspected as a record. */ +function isRuntimeObject(value: unknown): value is object { + return value !== null && typeof value === "object" && !Array.isArray(value); +} + +/** Return whether a runtime record owns a stable data property rather than inherited/accessor state. */ +function hasOwnData(value: object, key: PropertyKey): boolean { + const descriptor = Object.getOwnPropertyDescriptor(value, key); + return descriptor !== undefined && Object.prototype.hasOwnProperty.call(descriptor, "value"); +} + +/** Return whether every numeric index is an own data element in a bounded runtime array. */ +function isDenseRuntimeArray(value: unknown): value is unknown[] { + if (!Array.isArray(value)) { + return false; + } + const length = Number(value.length); + if (!Number.isSafeInteger(length) || length < 0 || length > 0xffffffff) { + return false; + } + for (let index = 0; index < length; index += 1) { + if (!hasOwnData(value, index)) { + return false; + } + } + return true; +} + +/** Bound buyer-visible text by Unicode code points without splitting a surrogate pair. */ +function truncateCodePoints(value: string, maximum: number): string { + let codePoints = 0; + let endIndex = 0; + for (const character of value) { + if (codePoints >= maximum) { + break; + } + endIndex += character.length; + codePoints += 1; + } + return endIndex === value.length ? value : value.slice(0, endIndex); +} + +/** Return a bounded owned transition cue, or null when the field cannot be shown. */ +function ownedTransitionHint(role: RehearsalRole): string | null { + if (!hasOwnData(role, "cue")) { + return null; + } + const cue = role.cue as Partial | null; + if ( + !isRuntimeObject(cue) || + !hasOwnData(cue, "kind") || + !hasOwnData(cue, "value") || + cue.kind !== "transition" || + typeof cue.value !== "string" + ) { + return null; + } + const hint = cue.value.trim(); + if (hint.length === 0) { + return null; + } + return truncateCodePoints(hint, MAX_TRANSITION_CHARACTERS); +} + +/** Return true when the role has safe owned identity/copy and ranked rehearsal priority. */ +function hasRankedPriority(role: RehearsalRole): boolean { + return ( + hasOwnData(role, "id") && + typeof role.id === "string" && + role.id.trim().length > 0 && + hasOwnData(role, "name") && + typeof role.name === "string" && + role.name.trim().length > 0 && + hasOwnData(role, "rehearsalPriority") && + Object.prototype.hasOwnProperty.call(PRIORITY_RANK, role.rehearsalPriority) + ); +} + +/** Return whether a section owns a bounded, positive-length integer rehearsal window. */ +function hasBoundedTimeRange(section: RehearsalSection): boolean { + if (!hasOwnData(section, "timeRange")) { + return false; + } + const timeRange = section.timeRange as Partial | null; + if ( + !isRuntimeObject(timeRange) || + !hasOwnData(timeRange, "start") || + !hasOwnData(timeRange, "end") + ) { + return false; + } + + const start = timeRange.start ?? -1; + const end = timeRange.end ?? -1; + return ( + Number.isInteger(start) && + start >= 0 && + start <= MAX_SECTION_TIME_SECONDS && + Number.isInteger(end) && + end > start && + end <= MAX_SECTION_TIME_SECONDS + ); +} + +/** Return safe identities that appear more than once in one section-local collection. */ +function repeatedIds(ids: string[]): Set { + const seen = new Set(); + const repeated = new Set(); + for (const id of ids) { + if (seen.has(id)) { + repeated.add(id); + } else { + seen.add(id); + } + } + return repeated; +} + +/** Prefer the highest-priority ranked role, then a locale-independent stable id order. */ +function pickHighestPriorityRole(roles: RehearsalRole[]): RehearsalRole | null { + if (roles.length === 0) { + return null; + } + return ( + [...roles].sort((left, right) => { + const rankDelta = PRIORITY_RANK[left.rehearsalPriority] - PRIORITY_RANK[right.rehearsalPriority]; + if (rankDelta !== 0) { + return rankDelta; + } + return compareStableId(left.id, right.id); + })[0] ?? null + ); +} + +/** Return ranked roles whose unique graph node is explicitly active. */ +function rankedActiveRoles(section: RehearsalSection): RehearsalRole[] { + if ( + !hasOwnData(section, "roles") || + !hasOwnData(section, "partGraph") || + !isDenseRuntimeArray(section.roles) || + !isDenseRuntimeArray(section.partGraph) + ) { + return []; + } + + const safeRoleIds = section.roles + .filter( + (role) => + isRuntimeObject(role) && + hasOwnData(role, "id") && + typeof role.id === "string" && + role.id.trim().length > 0 + ) + .map((role) => role.id); + const safeGraphRoleIds = section.partGraph + .filter( + (node) => + isRuntimeObject(node) && + hasOwnData(node, "role_id") && + typeof node.role_id === "string" && + node.role_id.trim().length > 0 + ) + .map((node) => node.role_id); + const repeatedRoleIds = repeatedIds(safeRoleIds); + const repeatedGraphRoleIds = repeatedIds(safeGraphRoleIds); + const activeIds = new Set( + section.partGraph + .filter( + (node) => + isRuntimeObject(node) && + hasOwnData(node, "is_active") && + node.is_active === true && + hasOwnData(node, "role_id") && + typeof node.role_id === "string" && + node.role_id.trim().length > 0 && + !repeatedGraphRoleIds.has(node.role_id) + ) + .map((node) => node.role_id) + ); + + return section.roles.filter( + (role) => + isRuntimeObject(role) && + hasRankedPriority(role) && + !repeatedRoleIds.has(role.id) && + activeIds.has(role.id) + ); +} + +/** Return the first owned transition string on a section, preferring the holding part. */ +function sectionTransitionHint( + section: RehearsalSection, + holdingRole: RehearsalRole | null +): string | null { + if (holdingRole) { + const fromHolder = ownedTransitionHint(holdingRole); + if (fromHolder !== null) { + return fromHolder; + } + } + if (!hasOwnData(section, "roles") || !isDenseRuntimeArray(section.roles)) { + return null; + } + for (const role of section.roles) { + if (!isRuntimeObject(role)) { + continue; + } + const hint = ownedTransitionHint(role); + if (hint !== null) { + return hint; + } + } + return null; +} + +/** Resolve a transition after the runtime root has passed its structural boundary checks. */ +function resolveSafeFirstTransition(song: RehearsalSong): FirstTransition | null { + if ( + !isRuntimeObject(song) || + !hasOwnData(song, "sections") || + !isDenseRuntimeArray(song.sections) + ) { + return null; + } + + const candidates = song.sections + .filter( + (section) => + isRuntimeObject(section) && + hasOwnData(section, "label") && + typeof section.label === "string" && + section.label.trim().length > 0 && + hasOwnData(section, "id") && + typeof section.id === "string" && + section.id.trim().length > 0 && + hasBoundedTimeRange(section) && + sectionTransitionHint(section, null) !== null + ) + .sort((left, right) => { + if (left.timeRange.start !== right.timeRange.start) { + return left.timeRange.start - right.timeRange.start; + } + return compareStableId(left.id, right.id); + }); + + const section = candidates[0]; + if (!section) { + return null; + } + + const holdingRole = pickHighestPriorityRole( + rankedActiveRoles(section).filter((role) => ownedTransitionHint(role) !== null) + ); + const hint = sectionTransitionHint(section, holdingRole); + if (hint === null) { + return null; + } + + return { + section, + holdingRole, + atSeconds: section.timeRange.start, + hint + }; +} + +/** Return the first named transition, or null when untrusted runtime metadata cannot be read safely. */ +export function resolveFirstTransition(song: RehearsalSong): FirstTransition | null { + try { + return resolveSafeFirstTransition(song); + } catch { + return null; + } +} diff --git a/apps/desktop/src/i18n/index.test.ts b/apps/desktop/src/i18n/index.test.ts index dc49a0a25..6796d093c 100644 --- a/apps/desktop/src/i18n/index.test.ts +++ b/apps/desktop/src/i18n/index.test.ts @@ -1,5 +1,5 @@ import { describe, it, expect, vi, afterEach } from "vitest"; -import { createTranslator, detectPreferredLocale } from "./index"; +import { createTranslator, detectPreferredLocale, translateSectionFormLabel } from "./index"; import koCommon from "../locales/ko/common.json"; describe("i18n", () => { @@ -75,4 +75,51 @@ describe("i18n", () => { } }); }); + + describe("translateSectionFormLabel", () => { + it("localizes every supported section form label for Korean rehearsal copy", () => { + expect( + [ + "intro", + "verse", + "pre-chorus", + "chorus", + "bridge", + "outro", + "tag", + "pickup", + "stop", + "handoff" + ].map((label) => translateSectionFormLabel("ko", label as never)) + ).toEqual([ + "인트로", + "벌스", + "프리코러스", + "코러스", + "브리지", + "아웃트로", + "태그", + "픽업", + "스톱", + "핸드오프" + ]); + }); + + it("preserves every supported English section form label", () => { + expect(translateSectionFormLabel("en", "verse")).toBe("verse"); + expect(translateSectionFormLabel("en", "outro")).toBe("outro"); + }); + + it("does not treat inherited object keys as localized section labels", () => { + const inheritedKey = "toString" as never; + expect(translateSectionFormLabel("ko", inheritedKey)).toBe("toString"); + }); + + it("keeps Korean first-transition next-action copy particle-safe", () => { + const t = createTranslator("ko"); + expect(t("firstTransitionOpenAction")).toBe("{at} {role} 전환 위치 열기"); + expect(t("firstTransitionBody")).toBe("{at} {section}에서 {role} 파트가 바뀝니다."); + expect(t("firstTransitionArmed")).toBe("{at}에서 {role} 파트 전환을 잡으세요. 끝까지 붙잡으세요."); + }); + }); }); diff --git a/apps/desktop/src/i18n/index.ts b/apps/desktop/src/i18n/index.ts index 1a9f471f0..352eff65e 100644 --- a/apps/desktop/src/i18n/index.ts +++ b/apps/desktop/src/i18n/index.ts @@ -1,3 +1,4 @@ +import type { SectionFormLabel } from "@bandscope/shared-types"; import enCommon from "../locales/en/common.json"; import koCommon from "../locales/ko/common.json"; @@ -11,13 +12,46 @@ const dictionaries = { ko: koCommon } as const; -/** Documented. */ +const sectionFormLabels: Readonly>>> = { + en: { + intro: "intro", + verse: "verse", + "pre-chorus": "pre-chorus", + chorus: "chorus", + bridge: "bridge", + outro: "outro", + tag: "tag", + pickup: "pickup", + stop: "stop", + handoff: "handoff" + }, + ko: { + intro: "인트로", + verse: "벌스", + "pre-chorus": "프리코러스", + chorus: "코러스", + bridge: "브리지", + outro: "아웃트로", + tag: "태그", + pickup: "픽업", + stop: "스톱", + handoff: "핸드오프" + } +}; + +/** Create a locale-aware translation lookup that falls back to English copy. */ export function createTranslator(locale: Locale = "en") { return function t(key: TranslationKey): string { return dictionaries[locale][key] ?? dictionaries.en[key]; }; } +/** Return the localized display label for a supported rehearsal section form. */ +export function translateSectionFormLabel(locale: Locale, label: SectionFormLabel): string { + const labels = sectionFormLabels[locale] as Readonly>; + return Object.prototype.hasOwnProperty.call(labels, label) ? labels[label] : String(label); +} + /** Documented. */ export function detectPreferredLocale(): Locale { if (typeof navigator !== "undefined" && navigator.language?.toLowerCase().startsWith("ko")) { diff --git a/apps/desktop/src/locales/en/common.json b/apps/desktop/src/locales/en/common.json index 39f716d50..2b04df818 100644 --- a/apps/desktop/src/locales/en/common.json +++ b/apps/desktop/src/locales/en/common.json @@ -148,5 +148,13 @@ "practiceProgressRegionLabel": "Practice Progress", "practiceProgressLabel": "Practice Progress", "decreasePracticeProgressLabel": "Decrease progress", - "increasePracticeProgressLabel": "Increase progress" + "increasePracticeProgressLabel": "Increase progress", + "firstTransitionLabel": "Tonight's first transition", + "firstTransitionOpenAction": "Open {role} transition at {at}", + "firstTransitionOpenActionBand": "Open the first transition at {at}", + "firstTransitionBody": "{role} changes in the {section} at {at}.", + "firstTransitionBodyBand": "The band changes in the {section} at {at}.", + "firstTransitionArmed": "Catch the change with {role} at {at}. Hold through together.", + "firstTransitionArmedBand": "Catch the change at {at}. Hold through together.", + "firstTransitionUnavailable": "No transition yet. Stay on tonight's map until a part names the change." } diff --git a/apps/desktop/src/locales/ko/common.json b/apps/desktop/src/locales/ko/common.json index 371884abb..734c370f9 100644 --- a/apps/desktop/src/locales/ko/common.json +++ b/apps/desktop/src/locales/ko/common.json @@ -148,5 +148,13 @@ "practiceProgressRegionLabel": "연습 진척도", "practiceProgressLabel": "연습 진척도", "decreasePracticeProgressLabel": "진척도 감소", - "increasePracticeProgressLabel": "진척도 증가" + "increasePracticeProgressLabel": "진척도 증가", + "firstTransitionLabel": "오늘 첫 전환", + "firstTransitionOpenAction": "{at} {role} 전환 위치 열기", + "firstTransitionOpenActionBand": "{at} 첫 전환 위치 열기", + "firstTransitionBody": "{at} {section}에서 {role} 파트가 바뀝니다.", + "firstTransitionBodyBand": "밴드가 {at} {section}에서 바뀝니다.", + "firstTransitionArmed": "{at}에서 {role} 파트 전환을 잡으세요. 끝까지 붙잡으세요.", + "firstTransitionArmedBand": "{at}에서 전환을 잡으세요. 끝까지 붙잡으세요.", + "firstTransitionUnavailable": "아직 전환이 없습니다. 파트가 변화를 표시할 때까지 오늘 지도에 머무르세요." } diff --git a/apps/desktop/vite.config.ts b/apps/desktop/vite.config.ts index f1db6f2b8..c543975c2 100644 --- a/apps/desktop/vite.config.ts +++ b/apps/desktop/vite.config.ts @@ -25,7 +25,9 @@ export default defineConfig({ "src/i18n/index.ts", "src/features/score/ScoreViewer.tsx", "src/features/score/ScoreView.tsx", - "src/features/score/scoreStorage.ts" + "src/features/score/scoreStorage.ts", + "src/features/workspace/firstTransition.ts", + "src/features/workspace/FirstTransitionCallout.tsx" ], thresholds: { lines: 90, diff --git a/docs/design-system/component-contract.md b/docs/design-system/component-contract.md index 22602c313..cc733efe8 100644 --- a/docs/design-system/component-contract.md +++ b/docs/design-system/component-contract.md @@ -32,6 +32,7 @@ The authoritative Figma view is `31 Component Contract Catalog`. This file mirro | Section Roadmap Card | https://www.figma.com/design/zthWmqfNKUgJBECvv002Qk/Bandscope-Design-System-v1?node-id=19-402 | `apps/desktop/src/features/workspace/SectionRoadmap.tsx` | Use `song`, `activeRole`, and optional `onSongUpdate`; avoid rebuilding its internal card layout. | | Song Structure Timeline | https://www.figma.com/design/zthWmqfNKUgJBECvv002Qk/Bandscope-Design-System-v1?node-id=19-457 | `apps/desktop/src/features/workspace/Workspace.tsx` | Feature-local `SongStructure({ sections, t })` memo component; not exported. | | Groove Map | https://www.figma.com/design/zthWmqfNKUgJBECvv002Qk/Bandscope-Design-System-v1?node-id=19-526 | `apps/desktop/src/features/workspace/GrooveMap.tsx` | Use `notes?: TranscriptionNote[]` and `isLoading?: boolean`; preserve scrollable region semantics and note labels. | +| First Transition Callout | workspace next-action pattern | `apps/desktop/src/features/workspace/FirstTransitionCallout.tsx` | Name the changing part when an active graph node corroborates it, the owned `cue.kind === "transition"` text, the labeled section start, and the time. Do not invent a change from lyric, count, groove, setup, simplification, overlap, range copy, or empty/whitespace cues. Open scrolls the renderer-owned song-structure section. Keep the unavailable state guidance-only. Distinct from first-lyric, first-count-in, first-overlap, first-groove, first-simplification, and first-range work. | | Source Control Stack | https://www.figma.com/design/zthWmqfNKUgJBECvv002Qk/Bandscope-Design-System-v1?node-id=19-655 | `apps/desktop/src/App.tsx` | Feature-local source controls for local audio, YouTube URL import, project actions, and Start Analysis; keep before metrics at 375px. | | Export Action Group | https://www.figma.com/design/zthWmqfNKUgJBECvv002Qk/Bandscope-Design-System-v1?node-id=19-731 | `apps/desktop/src/features/workspace/Workspace.tsx` | Feature-local export buttons call `handleExportCueSheet`, `handleExportChart`, and `handleExportHandoff`. | | Workspace State Matrix | https://www.figma.com/design/zthWmqfNKUgJBECvv002Qk/Bandscope-Design-System-v1?node-id=99-560 | `apps/desktop/src/features/workspace/WorkspaceStates.tsx`, `apps/desktop/src/App.tsx` | Whole-workspace empty, loading, error, and ready state routing; use before changing `renderWorkspaceState()`. | diff --git a/docs/doctoring/reduced-motion-first-transition-navigation.md b/docs/doctoring/reduced-motion-first-transition-navigation.md new file mode 100644 index 000000000..b14f044c9 --- /dev/null +++ b/docs/doctoring/reduced-motion-first-transition-navigation.md @@ -0,0 +1,14 @@ +# Reduced-motion first-transition navigation + +Workspace map navigation for tonight's first transition follows the operating-system reduced-motion preference. + +When `prefers-reduced-motion: reduce` matches, `FirstTransitionCallout` scrolls the renderer-owned song-structure section with `behavior: "auto"`. Otherwise it uses `behavior: "smooth"`. + +This is a presentation contract only. Transition resolution and analysis-id isolation stay unchanged. + +## Security Notes + +- Untrusted input: song, section, time-range, role, cue kind/value, and section-local graph metadata are runtime data; inherited properties and arrays masquerading as record metadata are not authority. +- Trust boundary: transition resolution accepts required fields only when the inspected record owns them, while renderer-owned song-structure children remain the only navigation targets; analysis `section.id` is never DOM-ID authority. The owned `cue.kind === "transition"` string is rendered as a text node and is never rescanned as template syntax. Lyric, count, groove, setup, simplification, overlap, and range copy cannot invent a change. +- Mitigations: runtime record guards reject arrays, dense collections require own indexed elements, required metadata fields must be own properties, `matchMedia` is read-only, scroll targets come from renderer child index, copy interpolation runs once, and the transition hint is bounded to 180 Unicode code points. +- Test points: inherited song/section/timing/role/graph/cue metadata is rejected, array-backed section records are rejected, reduced-motion scroll uses `auto`, and default motion uses `smooth`.