@readium/speech 0.9.2 → 0.10.0

package/README.md

@@ -40,7 +40,17 @@ We are now on the sixth phase: verbosity and prosody, in particular contextualiz
 
 ## Demos
 
-### [Voice selection with playback demo](https://readium.org/speech/demo)
+### [In-context demo](https://readium.org/speech/demo)
+
+In-context reading with seamless voice selection (grouped by region and sorted based on quality), and playback control, providing an optional read-along experience that integrates naturally with the content.
+
+A scenario picker switches between sample documents (a plain article, fixed-layout pages with cross-column sentences, word-level and letter-level positioned spans, combined FXL patterns, and Unicode look-alikes/ASCII imitations), each exercising a different extraction path.
+
+Settings include a verbosity selector (none/few/some/most) demonstrating [contextualization](docs/Preferences.md) — synthesized announcements spoken around content based on its role (entering/leaving a section, a footnote, a pullquote…) — a segmentation mode (structure/sentence), playback speed, and, for the read-along experience, independent highlight styles (highlight, underline, strikethrough, outline, text color, mask) and colors for the current utterance and the current word.
+
+A side panel shows the [Guided Navigation](docs/GuidedNavigation.md) object and the [utterances](docs/UtteranceExtraction.md) extracted from the current scenario, live, synced to playback as it progresses.
+
+### [Voice selection with playback demo](https://readium.org/speech/demo/voice-selection)
 
 - fetching a list of all available languages, translating them to the user's locale and sorting them based on these translations
 - returning a list of voices for a given language, grouped by region and sorted based on quality
@@ -49,14 +59,6 @@ We are now on the sixth phase: verbosity and prosody, in particular contextualiz
 - using the current Navigator for playback control
 - highlighting: as playback progresses, the current word/sentence is highlighted
 
-### [In-context demo](https://readium.org/speech/demo/article)
-
-In-context reading with seamless voice selection (grouped by region and sorted based on quality), and playback control, providing an optional read-along experience that integrates naturally with the content.
-
-Settings include a verbosity selector (none/few/some/most) demonstrating [contextualization](docs/Preferences.md) — synthesized announcements spoken around content based on its role (entering/leaving a section, a footnote, a pullquote…) — and, for the read-along experience, independent highlight styles (highlight, underline, strikethrough, outline, text color, mask) and colors for the current utterance and the current word.
-
-The panel alongside the article shows the [Guided Navigation](docs/GuidedNavigation.md) object and the [utterances](docs/UtteranceExtraction.md) extracted from it, live.
-
 ### [Extraction playground](https://readium.org/speech/demo/playground)
 
 Pick a sample piece of markup and watch it move through the whole pipeline:
@@ -182,8 +184,8 @@ The project includes demo applications that can be served locally:
    ```
 
 2. Open your browser to:
-   - [Voice selection demo](http://localhost:8080/demo)
-   - [In-context reading demo](http://localhost:8080/demo/article)
+   - [In-context reading demo](http://localhost:8080/demo)
+   - [Voice selection demo](http://localhost:8080/demo/voice-selection)
    - [Extraction playground](http://localhost:8080/demo/playground)
 
 ### ChromeOS Debugging

package/build/gnd/converter.d.ts

@@ -14,7 +14,10 @@ export declare class Converter {
     selectorPredicate: ((roles: GndRole[]) => boolean) | null;
     domRangeEnabled: boolean;
     textFragmentEnabled: boolean;
+    leafTextEnabled: boolean;
     docRoot: Document | null;
+    selectorRoot: Element | null;
+    selectorRootAnchor: string | null;
     private root;
     private current;
     private foldedCaptions;

package/build/gnd/domRangeGenerator.d.ts

@@ -6,4 +6,4 @@ export interface KnownSelector {
 export declare function generateDomRange(range: {
     first: [Text, number];
     last: [Text, number];
-}, docRoot: Document | null, known?: KnownSelector): DomRangeJSON | undefined;
+}, selectorRoot: Element | null, rootAnchor: string | null, known?: KnownSelector): DomRangeJSON | undefined;

package/build/gnd/object.d.ts

@@ -11,6 +11,10 @@ export interface ObjBuilder {
     children?: ObjBuilder[];
     description?: string;
 }
+export declare const ariaSubstitutedBuilders: WeakSet<ObjBuilder>;
+export declare const ariaSubstitutedNodes: WeakSet<GndObject>;
+export declare const substitutedOwnSelectorBuilders: WeakMap<ObjBuilder, string>;
+export declare const substitutedOwnSelectorNodes: WeakMap<GndObject, string>;
 export declare function isEmptyObj(o: ObjBuilder): boolean;
 /** A node being built up during the tree walk, before its final shape is known. */
 export declare class NavObject {

package/build/gnd/options.d.ts

@@ -1,4 +1,5 @@
 import { GndRole } from './types.js';
+export declare const leafTextRoleKeyword = "leaf-text";
 export interface TextrefOptions {
     roles?: boolean | GndRole[];
     domRange?: boolean;
@@ -9,6 +10,7 @@ export interface GndGenerationOptions {
 }
 export interface NormalizedTextrefOptions {
     predicate: ((roles: GndRole[]) => boolean) | null;
+    leafText: boolean;
     domRange: boolean;
     textFragment: boolean;
 }

package/build/gnd/selectorGenerator.d.ts

@@ -1,2 +1,3 @@
-export declare function selectorForElement(el: Element, docRoot: Document | null): string | undefined;
-export declare function textrefForSelector(selector: string | undefined): string | undefined;
+export declare function rootAnchorSelector(selectorRoot: Element | null): string | null;
+export declare function selectorForElement(el: Element, selectorRoot: Element | null, rootAnchor: string | null): string | undefined;
+export declare function textrefForSelector(selector: string | undefined, el: Element): string | undefined;

package/build/gnd/textrefFragment.d.ts

@@ -11,6 +11,7 @@ export interface DomRangeJSON {
         textNodeIndex: number;
         charOffset?: number;
     };
+    container?: string;
 }
 export declare function encodeDomRangeFragment(domRange: DomRangeJSON): string;
 export declare function decodeDomRangeFragment(textref: string | undefined): DomRangeJSON | undefined;
@@ -32,6 +33,7 @@ export interface DecodedTextref {
     };
     fragment?: string;
 }
+export declare function combineDomRangeTextrefs(first: DecodedTextref, last: DecodedTextref): DecodedTextref | undefined;
 export declare function decodeTextref(node: {
     id?: string;
     textref?: string;