Huang Xin
bfb85c2f68
* docs(reader): TTS-sync design spec for paragraph mode + RSVP (#3235) Hardened via brainstorming + /autoplan (CEO/Design/Eng dual-voice review). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(tts): emit canonical tts-position event from TTSController (#3235) Controller emits { cfi, kind, sectionIndex, sequence } alongside the existing tts-highlight-mark/-word events. Monotonic sequence lets downstream consumers (paragraph mode, RSVP — later slices) drop out-of-order positions. Additive; existing events untouched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(reader): containment+cursor CFI->index mappers for TTS sync (#3235) RSVPController.syncToCfi + setExternallyDriven: containment match (fixes mid-token skip), monotonic cursor + binary search (avoids O(N)-per-word jank, no per-word getCFI), -1/no-op on no match (no silent jump to word 0), timer suspension while externally driven. ParagraphIterator.findIndexByRange: hinted + binary-search containment mapper returning -1 on no match (never first()). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(tts): forward tts-position + tts-playback-state onto the app bus (#3235) useTTSControl republishes the controller's canonical tts-position (tagged with bookKey) via a dedicated listener — NOT inside the suppression-gated highlight handlers, so page-follow suppression can't silently desync the modes. Adds tts-playback-state (playing/paused/stopped) so RSVP can track playback without the hook-local isPlaying. Verified by extending the real-foliate-view browser harness. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(reader): paragraph mode follows TTS playback (#3235) When paragraph mode + TTS are both active, the focused paragraph follows the spoken position (sentence granularity, all engines). Section-generation contract (stash cross-section position, apply after the iterator re-inits); sync-focus path that does NOT arm isFocusingRef (avoids the relocate-eaten wrong-section paragraph-0 bug); stale-sequence drop; decouple on manual nav, re-engage on next playing. Start-alignment + visible indicator deferred to later slices. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(rsvp): speed reader follows TTS playback (#3235) Edge word-boundary voices: RSVP shows the spoken word via syncToCfi. Non-Edge (sentence-only) voices: sentence-paced estimator (clamp 60..600 wpm from voice rate, hold at +60 words cap, snap to first word on each new sentence mark). RSVP auto-advance suspended while TTS-driven. Decouple on manual nav via a rsvp-manual-nav signal; re-engage on next playing. Cross-section positions re-extract then apply. Pure decideRsvpTtsPosition helper unit-tested. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(reader): fixed-layout gate + ttsSyncStatus for TTS sync (#3235) Gate sync to reflowable books (D7): fixed-layout reports 'unsupported' and never engages. Both modes expose ttsSyncStatus (idle/following/syncing/ decoupled/unsupported) as the data source for the upcoming indicator. RSVPControl now forwardRef-exposes the status via an imperative handle. Cross-bookKey events ignored (regression-tested). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(reader): 'following audio' indicator for TTS sync (#3235) 5-state pill (following/syncing/decoupled, idle+unsupported render null) shown top-center in the paragraph overlay and as a status row in the RSVP overlay. Decoupled state is the tap-to-resume control; first decouple fires a one-time toast. eink-bordered, glyph+text (no color-only), RTL logical props, touch targets, safe-area top inset. RSVP 'plain' variant matches its themed surface; non-Edge shows '· estimated'. New i18n keys need extraction before merge. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(rsvp): in-overlay TTS toggle + audio-paced speed control (#3235) Voice-glyph audio toggle in the RSVP control row (trailing, by the gear) starts/ stops read-along from inside the full-screen overlay, start-aligned to the current word (range validated against the live doc). While TTS-driven, the WPM control shows a locked 'Audio pace' affordance that opens a compact rate picker; rate changes go through a new tts-set-rate bus event reusing the existing throttled setRate path. Pure buildRsvpTtsSpeakDetail helper unit-tested. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(reader): e2e paragraph mode follows TTS across a section boundary (#3235) Real <foliate-view> browser e2e: with paragraph mode active, the focused paragraph follows the TTS walk and re-targets to the new section after a Ch4->Ch5 boundary (proves no stuck wrong-section paragraph-0 / isFocusingRef trap). Asserts on the owning section of the current range. Test-only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * i18n(reader): translate TTS-sync strings across 33 locales (#3235) Following audio / · estimated / Resume audio / Stopped following audio / Play audio / Pause audio / Audio pace / Speed follows audio. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(reader): resolve TTS CFI anchors across iframe realms (#3235) RSVP and paragraph follow silently failed to track the spoken word: the CFI anchor from view.resolveCFI(...).anchor(doc) is a Range created in the book iframe's realm, so 'anchor instanceof Range' (top realm) was always false (cross-realm instanceof) -> resolveCfiToRange/applySyncCfi returned null -> syncToCfi never advanced. Add isRangeLike() duck-type (cloneRange is unique to Range) and use it at all 4 CFI-resolution sites. Confirmed live via CDP: before = syncToCfi false (frozen); after = exact word map + RSVP follows Edge TTS at ~171 wpm (audio pace). Unit tests reproduce the cross-realm anchor (jsdom is single-realm so the old code passed there but died in the app). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(rsvp): stop estimator/word fight + map transport to TTS play/pause (#3235) Two read-along refinements (verified live via CDP with Edge TTS): 1. No more jump-ahead-then-snap-back flashing. Word-boundary engines (Edge) emit BOTH sentence marks and word boundaries; RSVP was routing sentence -> the estimator (self-paces ~190xrate, up to +60 words ahead) while word positions snapped it back. Now once a word position is seen, sentence positions are ignored and any running estimator is stopped, so words alone drive RSVP. 2. The RSVP transport (center play/pause, Space, center-tap) maps to TTS play/pause while read-along is engaged (tts-toggle-play), instead of RSVP's own suspended timer. Pausing TTS keeps RSVP suspended (no runaway); a full stop releases it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(rsvp): keep indicator on pause + reach dict management from RSVP (#3235) - Pausing read-along no longer dismisses the 'following audio' indicator / 'Audio pace' lock (layout shift). New 'paused' sync status keeps the indicator row and WPM lock present while TTS is engaged-but-paused; only a full stop clears them. Verified live via CDP: pause keeps the layout, no shift. - Dict management is reachable from RSVP: the settings dialog is z-50, far below the full-screen RSVP overlay (z-[10000]), so it opened invisibly behind it. handleManageDictionary now exits RSVP first (position saved/resumable) so management shows over the reader. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(rsvp): show dict management over RSVP instead of exiting it (#3235) Per feedback: opening dictionary management from the RSVP lookup popup no longer closes the speed reader. The settings dialog is raised above the full-screen RSVP overlay (z-[10000] -> SettingsDialog !z-[10050]) so it shows on top, and RSVP's capture-phase keyboard handler bails while the settings dialog is open so its inputs accept Space and Escape closes settings (not RSVP). Verified live via CDP: management opens over RSVP, RSVP stays active behind it, Escape returns to it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(dict): only apply drag-handle margin compensation when the handle shows (#3235) The dictionary sheet header used -mt-4 to compensate for Dialog's drag handle, but that handle is sm:hidden (shown only below sm). On sm+ the handle is display:none, so -mt-4 pulled the header up into the top edge (broken layout when the lookup renders as a sheet on a short/wide window). Mirror the handle's breakpoint: -mt-4 sm:mt-0. Verified live via CDP. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(reader): in-mode TTS audio toggle for paragraph mode (#3235) Paragraph mode already follows TTS, but there was no way to start read-along from inside it. Add an audio toggle to the ParagraphBar (mirroring RSVP's): it starts TTS start-aligned to the focused paragraph (range validated live, + section index) and stops it. Track session-active vs playing so a pause keeps the indicator ('paused' status) instead of collapsing to idle. Pure buildParagraphTtsSpeakDetail helper unit-tested. Verified live via CDP: tapping the icon starts audio from the focused paragraph and the focus follows speech. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * feat(reader): highlight current TTS word/sentence in paragraph mode (#3235) Paragraph mode follows TTS by advancing the focused paragraph, but the spoken word wasn't highlighted within it like normal mode. The overlay renders a CLONE of the paragraph, so the iframe's TTS highlight isn't visible there — reproduce it on the clone with the CSS Custom Highlight API (no DOM mutation, spans inline boundaries natively, leaves the fade-in animation untouched). - TTSController already tags tts-position with kind word|sentence. The hook decides granularity: word boundaries (Edge) drive a per-word highlight; once seen, the coarse sentence event is skipped so the whole sentence doesn't flicker over the current word. Engines without word boundaries (WebSpeech/Native) fall back to the sentence highlight. - Offsets are computed relative to the paragraph start (so they map 1:1 onto the clone's text) and tagged with the paragraph index so a stale highlight never paints the wrong paragraph. Cleared on stop / section change / disabled. - The ::highlight() style mirrors the user's ttsHighlightOptions color+style. Pure helpers (offset math, word/sentence decision, css builder) unit-tested. Verified live via CDP: word highlight tracks Edge word-by-word and follows across paragraph boundaries (news -> ... -> ladies), matching the TTS color. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
125 lines
4.5 KiB
TypeScript
125 lines
4.5 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
||
import { ParagraphIterator } from '@/utils/paragraph';
|
||
|
||
const createDoc = (body: string): Document =>
|
||
new DOMParser().parseFromString(`<html><body>${body}</body></html>`, 'text/html');
|
||
|
||
describe('ParagraphIterator', () => {
|
||
it('skips whitespace-only paragraphs', async () => {
|
||
const doc = createDoc(`
|
||
<p>First</p>
|
||
<p> </p>
|
||
<p> </p>
|
||
<p></p>
|
||
<p><span> </span></p>
|
||
<p><br /></p>
|
||
<p>Second</p>
|
||
`);
|
||
|
||
const iterator = await ParagraphIterator.createAsync(doc, 1000);
|
||
|
||
expect(iterator.length).toBe(2);
|
||
expect(iterator.first()?.toString()).toContain('First');
|
||
expect(iterator.next()?.toString()).toContain('Second');
|
||
});
|
||
|
||
it('keeps paragraphs with non-text content', async () => {
|
||
const doc = createDoc(`
|
||
<p>Intro</p>
|
||
<p><img src="cover.png" alt="" /></p>
|
||
<p>Outro</p>
|
||
`);
|
||
|
||
const iterator = await ParagraphIterator.createAsync(doc, 1000);
|
||
|
||
expect(iterator.length).toBe(3);
|
||
|
||
iterator.first();
|
||
expect(iterator.current()?.toString()).toContain('Intro');
|
||
|
||
const imageRange = iterator.next();
|
||
const fragment = imageRange?.cloneContents();
|
||
expect(fragment?.querySelector('img')).not.toBeNull();
|
||
|
||
expect(iterator.next()?.toString()).toContain('Outro');
|
||
});
|
||
});
|
||
|
||
describe('ParagraphIterator.findIndexByRange', () => {
|
||
// Five compact, single-text-node blocks so indices map 1:1 to paragraphs.
|
||
const buildIterator = async () => {
|
||
const doc = createDoc(
|
||
`<p id="b0">Zero</p><p id="b1">One</p><p id="b2">Two</p><p id="b3">Three</p><p id="b4">Four</p>`,
|
||
);
|
||
const iterator = await ParagraphIterator.createAsync(doc, 1000);
|
||
return { doc, iterator };
|
||
};
|
||
|
||
// Builds a collapsed Range at `offset` inside the text node of paragraph `id`.
|
||
const pointInside = (doc: Document, id: string, offset = 0): Range => {
|
||
const el = doc.getElementById(id)!;
|
||
const textNode = el.firstChild!;
|
||
const range = doc.createRange();
|
||
range.setStart(textNode, offset);
|
||
range.setEnd(textNode, offset);
|
||
return range;
|
||
};
|
||
|
||
it('returns the index of the block that contains the target start (containment)', async () => {
|
||
const { doc, iterator } = await buildIterator();
|
||
// A point inside block 2's text must resolve to 2 (not 1 or 3).
|
||
const target = pointInside(doc, 'b2', 1);
|
||
expect(iterator.findIndexByRange(target)).toBe(2);
|
||
});
|
||
|
||
it('returns -1 (not 0) when the target is after the last block', async () => {
|
||
const { doc, iterator } = await buildIterator();
|
||
// Append a node AFTER the iterator is built so it belongs to no block and
|
||
// sits in document order past the last block's end.
|
||
const trailing = doc.createElement('span');
|
||
trailing.textContent = 'trailing';
|
||
doc.body.appendChild(trailing);
|
||
const range = doc.createRange();
|
||
range.setStart(trailing.firstChild!, 0);
|
||
range.collapse(true);
|
||
expect(iterator.findIndexByRange(range)).toBe(-1);
|
||
});
|
||
|
||
it('returns the nearest following block when the target falls in a gap', async () => {
|
||
const { doc, iterator } = await buildIterator();
|
||
// Insert a node between block 2 and block 3 AFTER the iterator is built so
|
||
// it sits in a genuine gap that no block range covers.
|
||
const gap = doc.createElement('span');
|
||
gap.textContent = 'gap';
|
||
doc.body.insertBefore(gap, doc.getElementById('b3'));
|
||
const range = doc.createRange();
|
||
range.setStart(gap.firstChild!, 0);
|
||
range.collapse(true);
|
||
// No block contains the gap point; the nearest following block is index 3.
|
||
expect(iterator.findIndexByRange(range)).toBe(3);
|
||
});
|
||
|
||
it('returns -1 when there are no blocks', async () => {
|
||
const doc = createDoc(`<div></div>`);
|
||
const iterator = await ParagraphIterator.createAsync(doc, 1000);
|
||
expect(iterator.length).toBe(0);
|
||
const range = doc.createRange();
|
||
range.setStart(doc.body, 0);
|
||
range.collapse(true);
|
||
expect(iterator.findIndexByRange(range)).toBe(-1);
|
||
});
|
||
|
||
it('resolves correctly with a correct hint (fast path)', async () => {
|
||
const { doc, iterator } = await buildIterator();
|
||
const target = pointInside(doc, 'b3', 0);
|
||
expect(iterator.findIndexByRange(target, 3)).toBe(3);
|
||
});
|
||
|
||
it('resolves correctly with a stale hint (binary-search fallback)', async () => {
|
||
const { doc, iterator } = await buildIterator();
|
||
const target = pointInside(doc, 'b1', 0);
|
||
// Hint points far away (block 4); must still resolve to 1.
|
||
expect(iterator.findIndexByRange(target, 4)).toBe(1);
|
||
});
|
||
});
|