@readium/navigator 2.11.1 → 2.12.0

package/types/src/readaloud/preferences/ReadAloudSettings.d.ts

@@ -0,0 +1,26 @@
+import type { GndRole } from "@readium/guided-navigation";
+import { ExtractionFormat, LanguageMode, Segmentation, SpeechSettings, VerbosityPreset } from "@readium/speech";
+import { ConfigurableSettings } from "../../preferences/Configurable.ts";
+import { ReadAloudDefaults } from "./ReadAloudDefaults.ts";
+import { ReadAloudAutoPause, ReadAloudDecorationStyle, ReadAloudPreferences } from "./ReadAloudPreferences.ts";
+export declare class ReadAloudSettings implements ConfigurableSettings {
+    format: ExtractionFormat;
+    inlineContextualization: boolean;
+    verbosity: VerbosityPreset;
+    skip: GndRole[];
+    contextualize: GndRole[];
+    language: LanguageMode;
+    segmentation: Segmentation;
+    pauseDuration: number;
+    autoPause: ReadAloudAutoPause;
+    speakInContentLanguage: boolean;
+    rate: number;
+    pitch: number;
+    volume: number;
+    utteranceStyle: ReadAloudDecorationStyle;
+    wordStyle: ReadAloudDecorationStyle;
+    /**
+     * @param speech The settings speech resolved for its own fields.
+     */
+    constructor(speech: SpeechSettings, preferences: ReadAloudPreferences, defaults: ReadAloudDefaults);
+}

package/types/src/readaloud/preferences/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ReadAloudDefaults.ts";
+export * from "./ReadAloudPreferences.ts";
+export * from "./ReadAloudPreferencesEditor.ts";
+export * from "./ReadAloudSettings.ts";

package/types/src/webpub/WebPubFrameManager.d.ts

@@ -31,6 +31,7 @@ export declare class WebPubFrameManager {
     }): void;
     get iframe(): HTMLIFrameElement;
     get realSize(): DOMRect;
+    get isDestroyed(): boolean;
     get window(): Window;
     get msg(): FrameComms | undefined;
     get ldr(): Loader<ModuleName> | undefined;

package/types/src/webpub/WebPubFramePoolManager.d.ts

@@ -28,5 +28,7 @@ export declare class WebPubFramePoolManager {
         [key: string]: string;
     }): void;
     get currentFrames(): (WebPubFrameManager | undefined)[];
+    /** The pooled frame of `href`, whether or not it's shown. */
+    _frameFor(href: string): WebPubFrameManager | undefined;
     get currentBounds(): DOMRect;
 }

package/types/src/webpub/WebPubNavigator.d.ts

@@ -1,7 +1,7 @@
 import { Link, Locator, Publication, ReadingProgression, Timeline, TimelineItem } from "@readium/shared";
 import { VisualNavigator, VisualNavigatorViewport, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
-import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
+import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, SuspiciousActivityEvent, TextLayout } from "@readium/navigator-html-injectables";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
 import { Decoration, DecorableNavigator, DecorationObserver, DecoratorConfig, DecorationStyleType } from "../decorations/index.ts";
 import { ManagerEventKey } from "../epub/EpubNavigator.ts";
@@ -67,6 +67,11 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     private _decorationHoverState;
     private _decorationActivationConsumed;
     private _decorationResizeSelectors;
+    private _textLayoutWatch?;
+    private _textLayoutFrame?;
+    private _navigationLocked;
+    private readonly _pointedPieceRequests;
+    private _pointedPieceRequestId;
     private webViewport;
     constructor(container: HTMLElement, pub: Publication, listeners: WebPubNavigatorListeners, initialPosition?: Locator | undefined, configuration?: WebPubNavigatorConfiguration);
     load(): Promise<void>;
@@ -83,7 +88,7 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
      */
     get _cframes(): (WebPubFrameManager | undefined)[];
     private get hasDisplayTransformability();
-    eventListener(key: CommsEventKey | ManagerEventKey, data: unknown): void;
+    eventListener(key: CommsEventKey | ManagerEventKey, data: unknown, sourceFrame?: WebPubFrameManager): void;
     private determineModules;
     private attachListener;
     private apply;
@@ -98,6 +103,24 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     applyDecorations(decorations: Decoration[], group: string): void;
     private _sendDecorationOps;
     private _reapplyDecorationsToCurrentFrame;
+    /**
+     * Reports where the text of `locators`, all in one resource, starts each line along the scroll axis,
+     * with the viewport. Reported again whenever that resource is scrolled or laid out again.
+     * Replaces any previous watch, and returns a function that stops this one.
+     */
+    watchTextLayout(locators: Locator[], cb: (layout: TextLayout) => void): () => void;
+    /**
+     * Locks or unlocks navigating in the content: scrolling and following its links.
+     * Calls to the navigator still move it.
+     */
+    lockNavigation(locked: boolean): void;
+    private _sendNavigationLock;
+    /**
+     * Returns the first of `pieces` under the point of `event`, else the first containing the element it targets,
+     * in the resource of the frame it comes from. Undefined when none does.
+     */
+    findPointedPiece(event: FrameClickEvent, pieces: Locator[]): Promise<Locator | undefined>;
+    private _watchTextLayoutInCurrentFrame;
     private _handleDecorationActivated;
     private _handleDecorationPointerEnter;
     private _handleDecorationPointerLeave;