@d-i-t-a/reader 3.0.0-alpha.8 → 3.0.0-alpha.9

package/dist/types/index.d.ts

@@ -7,7 +7,10 @@ export { Link } from "./model/Link";
 export { Locator, Locations, LocatorText, ReadingPosition, Bookmark, Annotation, AnnotationMarker, } from "./model/Locator";
 export { ReaderEvent } from "./utils/Events";
 export type { ReaderEventName, ReaderEventMap } from "./utils/Events";
-export type { ReaderConfig, ReaderRights, NavigatorAPI, IFrameAttributes, Injectable, RequestConfig, SampleRead, PublicationServices, InitialAnnotations, } from "./navigator/IFrameNavigator";
+export { NavigatorFeature } from "./navigator/VisualNavigator";
+export type { NavigatorFeatureName } from "./navigator/VisualNavigator";
+export { EpubNavigator, IFrameNavigator } from "./navigator/EpubNavigator";
+export type { ReaderConfig, ReaderRights, NavigatorAPI, IFrameAttributes, Injectable, RequestConfig, SampleRead, PublicationServices, InitialAnnotations, EpubNavigatorConfig, IFrameNavigatorConfig, } from "./navigator/EpubNavigator";
 export type { IUserSettings, InitialUserSettings, } from "./model/user-settings/UserSettings";
 export type { UserSettingsIncrementable } from "./model/user-settings/UserProperties";
 export type { LocalStorageStoreConfig } from "./store/LocalStorageStore";

package/dist/types/model/user-settings/UserSettings.d.ts

@@ -1,6 +1,6 @@
 import Store from "../../store/Store";
 import { UserProperties, UserProperty, UserSettingsIncrementable } from "./UserProperties";
-import { Injectable, NavigatorAPI } from "../../navigator/IFrameNavigator";
+import { Injectable, NavigatorAPI } from "../../navigator/EpubNavigator";
 import BookView from "../../views/BookView";
 export interface UserSettingsConfig {
     /** Store to save the user's selections in. */

package/dist/types/model/v3/Publication.d.ts

@@ -1,7 +1,7 @@
 import { Manifest } from "@readium/shared";
 import { Locator } from "./Locator";
 import { Link } from "./Link";
-import { GetContentBytesLength, RequestConfig, SampleRead } from "../../navigator/IFrameNavigator";
+import { GetContentBytesLength, RequestConfig, SampleRead } from "../../navigator/EpubNavigator";
 /**
  * R2D2BC Publication — wraps @readium/shared Manifest with
  * all R2D2BC-specific extensions (positions, sample read, spine helpers).

package/dist/types/modules/AnnotationModule.d.ts

@@ -1,5 +1,5 @@
 import Annotator from "../store/Annotator";
-import { IFrameNavigator, ReaderRights } from "../navigator/IFrameNavigator";
+import { EpubNavigator, ReaderRights } from "../navigator/EpubNavigator";
 import { Publication } from "../model/Publication";
 import { TextHighlighter } from "./highlight/TextHighlighter";
 import { ReaderModule } from "./ReaderModule";
@@ -23,7 +23,7 @@ export interface AnnotationModuleConfig extends AnnotationModuleProperties {
     headerMenu?: HTMLElement | null;
     rights: Partial<ReaderRights>;
     publication: Publication;
-    initialAnnotations?: import("../navigator/IFrameNavigator").InitialAnnotations;
+    initialAnnotations?: import("../navigator/EpubNavigator").InitialAnnotations;
     api?: AnnotationModuleAPI;
     highlighter: TextHighlighter;
 }
@@ -36,7 +36,7 @@ export declare class AnnotationModule implements ReaderModule {
     private readonly headerMenu?;
     private readonly highlighter?;
     private readonly initialAnnotations?;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     properties?: AnnotationModuleProperties;
     api?: AnnotationModuleAPI;
     activeAnnotationMarkerId?: string;

package/dist/types/modules/BookmarkModule.d.ts

@@ -1,5 +1,5 @@
 import Annotator from "../store/Annotator";
-import { IFrameNavigator, ReaderRights } from "../navigator/IFrameNavigator";
+import { EpubNavigator, ReaderRights } from "../navigator/EpubNavigator";
 import { Publication } from "../model/Publication";
 import { ReaderModule } from "./ReaderModule";
 import { Annotation, Bookmark } from "../model/Locator";
@@ -16,7 +16,7 @@ export interface BookmarkModuleConfig extends BookmarkModuleProperties {
     headerMenu?: HTMLElement | null;
     rights: Partial<ReaderRights>;
     publication: Publication;
-    initialAnnotations?: import("../navigator/IFrameNavigator").InitialAnnotations;
+    initialAnnotations?: import("../navigator/EpubNavigator").InitialAnnotations;
     properties?: BookmarkModuleProperties;
     api?: BookmarkModuleAPI;
 }
@@ -28,7 +28,7 @@ export declare class BookmarkModule implements ReaderModule {
     private sideNavSectionBookmarks;
     private readonly headerMenu?;
     private readonly initialAnnotations?;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private readonly properties;
     private readonly api?;
     static create(config: BookmarkModuleConfig): Promise<any>;

package/dist/types/modules/TTS/TTSModule2.d.ts

@@ -1,6 +1,6 @@
 import { ReaderModule } from "../ReaderModule";
 import { TTSModuleAPI, TTSModuleConfig, TTSModuleProperties, TTSSettings } from "./TTSSettings";
-import { IFrameNavigator, ReaderRights } from "../../navigator/IFrameNavigator";
+import { EpubNavigator, ReaderRights } from "../../navigator/EpubNavigator";
 import { TextHighlighter } from "../highlight/TextHighlighter";
 import { IHighlight } from "../highlight/common/highlight";
 import debounce from "debounce";
@@ -11,7 +11,7 @@ export declare class TTSModule2 implements ReaderModule {
     private clean;
     private rights;
     private readonly highlighter;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private body;
     private hasEventListener;
     private readonly headerMenu?;

package/dist/types/modules/TTS/TTSSettings.d.ts

@@ -1,6 +1,6 @@
 import Store from "../../store/Store";
 import { UserProperty, UserProperties } from "../../model/user-settings/UserProperties";
-import { ReaderRights } from "../../navigator/IFrameNavigator";
+import { ReaderRights } from "../../navigator/EpubNavigator";
 import { TextHighlighter } from "../highlight/TextHighlighter";
 export interface TTSModuleAPI {
     started: any;

package/dist/types/modules/citation/CitationModule.d.ts

@@ -1,5 +1,5 @@
 import { Publication } from "../../model/Publication";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { ReaderModule } from "../ReaderModule";
 import { TextHighlighter } from "../highlight/TextHighlighter";
 export declare enum CitationStyle {
@@ -35,7 +35,7 @@ export interface CitationModuleConfig extends CitationModuleProperties {
 }
 export default class CitationModule implements ReaderModule {
     private publication;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private properties;
     private readonly highlighter?;
     api?: CitationModuleAPI;

package/dist/types/modules/consumption/ConsumptionModule.d.ts

@@ -1,6 +1,6 @@
 import { ReaderModule } from "../ReaderModule";
 import { Publication } from "../../model/Publication";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { Locator } from "../../model/Locator";
 export declare enum Action {
     BookmarkCreated = "BookmarkCreated",
@@ -32,7 +32,7 @@ export interface ConsumptionModuleConfig extends ConsumptionModuleProperties {
     api?: ConsumptionModuleAPI;
 }
 export declare class ConsumptionModule implements ReaderModule {
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private publication;
     private properties;
     api?: ConsumptionModuleAPI;

package/dist/types/modules/highlight/TextHighlighter.d.ts

@@ -3,7 +3,7 @@ import { HighlightType, IHighlight, IMarkerIcon, IPopupStyle, IStyle, SelectionM
 import { ISelectionInfo } from "./common/selection";
 import { IRectSimple } from "./common/rect-utils";
 import { AnnotationMarker } from "../../model/Locator";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { LayerSettings } from "./LayerSettings";
 export declare enum HighlightContainer {
     R2_ID_HIGHLIGHTS_CONTAINER = "R2_ID_HIGHLIGHTS_CONTAINER",
@@ -62,7 +62,7 @@ export interface TextHighlighterConfig extends TextHighlighterProperties {
 }
 export declare class TextHighlighter {
     private options;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     layerSettings: LayerSettings;
     private lastSelectedHighlight?;
     properties: TextHighlighterProperties;

package/dist/types/modules/history/HistoryModule.d.ts

@@ -1,4 +1,4 @@
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { ReaderModule } from "../ReaderModule";
 import { Locator } from "../../model/Locator";
 import { Publication } from "../../model/Publication";
@@ -13,7 +13,7 @@ export interface HistoryModuleConfig extends HistoryModuleProperties {
 }
 export declare class HistoryModule implements ReaderModule {
     readonly annotator: Annotator | null;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private readonly headerMenu?;
     private publication;
     private properties;

package/dist/types/modules/linefocus/LineFocusModule.d.ts

@@ -1,5 +1,5 @@
 import { Publication } from "../../model/Publication";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { ReaderModule } from "../ReaderModule";
 import { TextHighlighter } from "../highlight/TextHighlighter";
 export interface LineFocusModuleAPI {
@@ -17,7 +17,7 @@ export interface LineFocusModuleConfig extends LineFocusModuleProperties {
 export default class LineFocusModule implements ReaderModule {
     properties: LineFocusModuleProperties;
     api?: LineFocusModuleAPI;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private highlighter;
     private hasEventListener;
     lines: Array<HTMLElement>;

package/dist/types/modules/mediaoverlays/MediaOverlayModule.d.ts

@@ -1,5 +1,5 @@
 import { Publication } from "../../model/Publication";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { ReaderModule } from "../ReaderModule";
 import { Link } from "../../model/Link";
 import { MediaOverlayNode } from "../../model/v3/MediaOverlayNode";
@@ -28,7 +28,7 @@ export interface MediaOverlayModuleConfig extends MediaOverlayModuleProperties {
 }
 export declare class MediaOverlayModule implements ReaderModule {
     private publication;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private audioElement;
     settings: MediaOverlaySettings;
     private properties;
@@ -54,7 +54,7 @@ export declare class MediaOverlayModule implements ReaderModule {
     initialize(): Promise<void>;
     initializeResource(links: Array<Link | undefined>): Promise<void>;
     private playLink;
-    private bindClickHandler;
+    bindClickHandler(): void;
     private unbindClickHandler;
     private handleContentClick;
     startReadAloud(): Promise<void>;

package/dist/types/modules/pagebreak/PageBreakModule.d.ts

@@ -1,4 +1,4 @@
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { ReaderModule } from "../ReaderModule";
 import { IHighlight } from "../highlight/common/highlight";
 import { ISelectionInfo } from "../highlight/common/selection";
@@ -11,7 +11,7 @@ export interface PageBreakModuleConfig extends PageBreakModuleProperties {
     publication: Publication;
 }
 export declare class PageBreakModule implements ReaderModule {
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private readonly headerMenu?;
     private publication;
     private properties;

package/dist/types/modules/positions/TimelineModule.d.ts

@@ -1,12 +1,12 @@
 import { Publication } from "../../model/Publication";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { ReaderModule } from "../ReaderModule";
 export interface TimelineModuleConfig {
     publication: Publication;
 }
 export declare class TimelineModule implements ReaderModule {
     private publication;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private timelineContainer;
     private positionSlider;
     static create(config: TimelineModuleConfig): Promise<TimelineModule>;

package/dist/types/modules/protection/ContentProtectionModule.d.ts

@@ -1,5 +1,5 @@
 import { ReaderModule } from "../ReaderModule";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 export interface ContentProtectionModuleProperties {
     enforceSupportedBrowsers: boolean;
     enableEncryption: boolean;
@@ -36,7 +36,7 @@ interface ContentProtectionRect {
 }
 export declare class ContentProtectionModule implements ReaderModule {
     private rects;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     properties?: ContentProtectionModuleProperties;
     private hasEventListener;
     private isHacked;

package/dist/types/modules/sampleread/SampleReadEventHandler.d.ts

@@ -1,7 +1,7 @@
 import debounce from "debounce";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 export default class SampleReadEventHandler {
-    navigator: IFrameNavigator;
-    constructor(navigator: IFrameNavigator);
+    navigator: EpubNavigator;
+    constructor(navigator: EpubNavigator);
     enforceSampleRead: debounce.DebouncedFunction<(position: any) => void>;
 }

package/dist/types/modules/search/DefinitionsModule.d.ts

@@ -1,4 +1,4 @@
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { ReaderModule } from "../ReaderModule";
 import { TextHighlighter } from "../highlight/TextHighlighter";
 import { IHighlight } from "../highlight/common/highlight";
@@ -31,7 +31,7 @@ export declare class DefinitionsModule implements ReaderModule {
     properties: DefinitionsModuleProperties;
     api?: DefinitionsModuleAPI;
     private publication;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private currentChapterPopupResult;
     private currentPopupHighlights;
     private highlighter;

package/dist/types/modules/search/Popup.d.ts

@@ -1,7 +1,7 @@
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 export declare class Popup {
-    navigator: IFrameNavigator;
-    constructor(navigator: IFrameNavigator);
+    navigator: EpubNavigator;
+    constructor(navigator: EpubNavigator);
     handleFootnote(link: HTMLLIElement, event: MouseEvent | TouchEvent): Promise<void>;
     hidePopover(): Promise<void>;
     showPopover(link: HTMLElement, event: MouseEvent | TouchEvent): Promise<void>;

package/dist/types/modules/search/SearchModule.d.ts

@@ -1,5 +1,5 @@
 import { Publication } from "../../model/Publication";
-import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { EpubNavigator } from "../../navigator/EpubNavigator";
 import { ReaderModule } from "../ReaderModule";
 import { TextHighlighter } from "../highlight/TextHighlighter";
 import { IHighlight } from "../highlight/common/highlight";
@@ -22,7 +22,7 @@ export declare class SearchModule implements ReaderModule {
     private api?;
     private publication;
     private readonly headerMenu?;
-    navigator: IFrameNavigator;
+    navigator: EpubNavigator;
     private searchInput;
     private searchGo;
     private currentChapterSearchResult;

package/dist/types/navigator/{IFrameNavigator.d.ts → EpubNavigator.d.ts}

@@ -1,7 +1,7 @@
-import Navigator from "./Navigator";
+import { VisualNavigator, NavigatorFeatureName } from "./VisualNavigator";
 import Annotator from "../store/Annotator";
-import { Publication } from "../model/Publication";
-import { Locator, ReadingPosition } from "../model/Locator";
+import { Publication } from "../model/v3";
+import { Locator, ReadingPosition } from "../model/v3";
 import { UserSettings, UserSettingsUIConfig } from "../model/user-settings/UserSettings";
 import { BookmarkModule, BookmarkModuleConfig } from "../modules/BookmarkModule";
 import { AnnotationModule, AnnotationModuleConfig } from "../modules/AnnotationModule";
@@ -12,12 +12,11 @@ import { TimelineModule } from "../modules/positions/TimelineModule";
 import debounce from "debounce";
 import BookView from "../views/BookView";
 import { MediaOverlayModule, MediaOverlayModuleConfig } from "../modules/mediaoverlays/MediaOverlayModule";
-import { D2Link, Link } from "../model/Link";
+import { D2Link, Link } from "../model/v3";
 import { ReaderModule } from "../modules/ReaderModule";
 import { TTSModuleConfig } from "../modules/TTS/TTSSettings";
 import { PageBreakModule, PageBreakModuleConfig } from "../modules/pagebreak/PageBreakModule";
 import { DefinitionsModule, DefinitionsModuleConfig } from "../modules/search/DefinitionsModule";
-import EventEmitter from "eventemitter3";
 import LineFocusModule, { LineFocusModuleConfig } from "../modules/linefocus/LineFocusModule";
 import { HistoryModule } from "../modules/history/HistoryModule";
 import CitationModule, { CitationModuleConfig } from "../modules/citation/CitationModule";
@@ -54,7 +53,7 @@ export interface IFrameAttributes {
     /** Whether to show a drop shadow on fixed-layout spreads. Defaults to true. */
     fixedLayoutShadow?: boolean;
 }
-export interface IFrameNavigatorConfig {
+export interface EpubNavigatorConfig {
     mainElement: HTMLElement;
     headerMenu?: HTMLElement | null;
     footerMenu?: HTMLElement | null;
@@ -158,8 +157,8 @@ export interface ReaderConfig {
      */
     workerSrc?: string;
 }
-/** Class that shows webpub resources in an iframe, with navigation controls outside the iframe. */
-export declare class IFrameNavigator extends EventEmitter implements Navigator {
+/** EPUB navigator — renders spine items in iframes with navigation controls. */
+export declare class EpubNavigator extends VisualNavigator {
     iframes: Array<HTMLIFrameElement>;
     currentTocUrl: string | undefined;
     headerMenu?: HTMLElement | null;
@@ -179,6 +178,19 @@ export declare class IFrameNavigator extends EventEmitter implements Navigator {
     historyModule?: HistoryModule;
     citationModule?: CitationModule;
     consumptionModule?: ConsumptionModule;
+    supports(feature: NavigatorFeatureName): boolean;
+    private fxlZoomKeyHandler;
+    private getFxlCurrentScale;
+    fitToPage(): void;
+    zoomIn(): void;
+    zoomOut(): void;
+    private setFxlScale;
+    private updateFxlZoomContainer;
+    private fxlPanOverlay;
+    private fxlHandTool;
+    private setupFxlPan;
+    activateHand(): void;
+    deactivateHand(): void;
     sideNavExpanded: boolean;
     currentChapterLink: D2Link;
     currentSpreadLinks: {
@@ -234,11 +246,15 @@ export declare class IFrameNavigator extends EventEmitter implements Navigator {
     sample?: SampleRead;
     requestConfig?: RequestConfig;
     private didInitKeyboardEventHandler;
-    static create(config: IFrameNavigatorConfig): Promise<IFrameNavigator>;
+    static create(config: EpubNavigatorConfig): Promise<EpubNavigator>;
     protected constructor(settings: UserSettings, annotator: Annotator | undefined, initialLastReadingPosition: ReadingPosition | undefined, publication: Publication, api?: Partial<NavigatorAPI>, rights?: Partial<ReaderRights>, tts?: Partial<TTSModuleConfig>, injectables?: Array<Injectable>, attributes?: IFrameAttributes, services?: PublicationServices, sample?: SampleRead, requestConfig?: RequestConfig, highlighter?: TextHighlighter, modules?: Array<ReaderModule | undefined>);
     stop(): void;
     spreads: HTMLDivElement;
     firstSpread: HTMLDivElement;
+    private fxlScrollContainer;
+    private fxlZoomContainer;
+    private fxlContentWidth;
+    private fxlContentHeight;
     setDirection(direction?: string | null): void;
     protected start(mainElement: HTMLElement, headerMenu?: HTMLElement | null, footerMenu?: HTMLElement | null): Promise<void>;
     timeout: any;
@@ -316,3 +332,7 @@ export declare class IFrameNavigator extends EventEmitter implements Navigator {
     showLayer(layer: any): void;
     hideLayer(layer: any): void;
 }
+/** @deprecated Use EpubNavigator */
+export declare const IFrameNavigator: typeof EpubNavigator;
+/** @deprecated Use EpubNavigatorConfig */
+export type IFrameNavigatorConfig = EpubNavigatorConfig;

package/dist/types/navigator/Navigator.d.ts

@@ -1,5 +1,5 @@
 import { Locator } from "../model/Locator";
-import { IFrameAttributes } from "./IFrameNavigator";
+import { IFrameAttributes } from "./EpubNavigator";
 import { Publication } from "../model/Publication";
 import { Link } from "../model/Link";
 interface Navigator {
@@ -29,13 +29,13 @@ interface Navigator {
     totalResources(): number;
     currentLocator(): Locator;
     positions(): Locator[];
-    goTo(locator: Locator): void;
-    goToPosition(value: number): void;
-    goToPage(page: number): void;
-    nextResource(): void;
-    previousResource(): void;
-    nextPage(): void;
-    previousPage(): void;
+    goTo(locator: Locator): void | Promise<void>;
+    goToPosition(value: number): void | Promise<void>;
+    goToPage(page: number): void | Promise<void>;
+    nextResource(): void | Promise<void>;
+    previousResource(): void | Promise<void>;
+    nextPage(): void | Promise<void>;
+    previousPage(): void | Promise<void>;
     atStart?(): boolean;
     atEnd?(): boolean;
     snapToSelector?(selector: string): void;

package/dist/types/navigator/PDFNavigator.d.ts

@@ -1,13 +1,12 @@
-import EventEmitter from "eventemitter3";
-import Navigator from "./Navigator";
+import { VisualNavigator, NavigatorFeatureName } from "./VisualNavigator";
 import { UserSettings } from "../model/user-settings/UserSettings";
-import { Publication } from "../model/Publication";
-import { Bookmark, Locator, ReadingPosition } from "../model/Locator";
+import { Publication } from "../model/v3";
+import { Bookmark, Locator, ReadingPosition } from "../model/v3";
 import Annotator from "../store/Annotator";
 import Store from "../store/Store";
 import { AnnotationEditorType } from "pdfjs-dist";
 import { EventBus, ScrollMode, SpreadMode } from "pdfjs-dist/web/pdf_viewer.mjs";
-import { NavigatorAPI } from "./IFrameNavigator";
+import { NavigatorAPI } from "./EpubNavigator";
 export { SpreadMode, ScrollMode, AnnotationEditorType };
 export interface PDFNavigatorConfig {
     mainElement: HTMLElement;
@@ -37,10 +36,11 @@ export declare enum ScaleType {
     Page = 0,
     Width = 1
 }
-export declare class PDFNavigator extends EventEmitter implements Navigator {
+export declare class PDFNavigator extends VisualNavigator {
     readonly isPDF = true;
     settings: UserSettings;
     publication: Publication;
+    supports(feature: NavigatorFeatureName): boolean;
     headerMenu?: HTMLElement | null;
     footerMenu?: HTMLElement | null;
     mainElement: HTMLElement;

package/dist/types/navigator/VisualNavigator.d.ts

@@ -0,0 +1,91 @@
+import EventEmitter from "eventemitter3";
+import Navigator from "./Navigator";
+import { Locator } from "../model/v3";
+import { Publication } from "../model/v3";
+import { Link } from "../model/v3";
+import { IFrameAttributes } from "./EpubNavigator";
+/**
+ * Typed feature names for navigator capability queries.
+ */
+export declare const NavigatorFeature: {
+    readonly TTS: "tts";
+    readonly MediaOverlays: "mediaOverlays";
+    readonly Search: "search";
+    readonly Annotations: "annotations";
+    readonly Bookmarks: "bookmarks";
+    readonly Zoom: "zoom";
+    readonly LineFocus: "lineFocus";
+    readonly Definitions: "definitions";
+    readonly Citations: "citations";
+    readonly ContentProtection: "contentProtection";
+    readonly Consumption: "consumption";
+    readonly History: "history";
+    readonly Timeline: "timeline";
+};
+export type NavigatorFeatureName = (typeof NavigatorFeature)[keyof typeof NavigatorFeature];
+/**
+ * Abstract base class for all visual navigators.
+ *
+ * Extends EventEmitter for the event system.
+ * Implements the Navigator interface for backwards compatibility.
+ *
+ * Subclasses: EpubNavigator (reflowable + FXL), PDFNavigator (PDF.js),
+ * and future navigators (AudiobookNavigator, DiViNaNavigator).
+ */
+export declare abstract class VisualNavigator extends EventEmitter implements Navigator {
+    abstract publication: Publication;
+    abstract currentLocator(): Locator;
+    abstract positions(): Locator[];
+    abstract currentResource(): number | undefined;
+    abstract totalResources(): number;
+    abstract goTo(locator: Locator): void | Promise<void>;
+    abstract goToPosition(value: number): void | Promise<void>;
+    abstract goToPage(page: number): void | Promise<void>;
+    abstract nextPage(): void | Promise<void>;
+    abstract previousPage(): void | Promise<void>;
+    abstract nextResource(): void | Promise<void>;
+    abstract previousResource(): void | Promise<void>;
+    abstract atStart(): boolean;
+    abstract atEnd(): boolean;
+    abstract tableOfContents(): Link[];
+    abstract landmarks(): Link[];
+    abstract pageList(): Link[];
+    abstract readingOrder(): Link[];
+    abstract stop(): void;
+    /**
+     * Check if this navigator supports a given feature.
+     * Replaces instanceof checks in D2Reader.
+     */
+    supports(_feature: NavigatorFeatureName): boolean;
+    startReadAloud(): void;
+    stopReadAloud(): void;
+    pauseReadAloud(): void;
+    resumeReadAloud(): void;
+    startReadAlong(): void;
+    stopReadAlong(): void;
+    pauseReadAlong(): void;
+    resumeReadAlong(): void;
+    hideLayer(_layer: string): void;
+    showLayer(_layer: string): void;
+    activateMarker(_id: string, _position: string): void;
+    deactivateMarker(): void;
+    snapToSelector?(_selector: string): void;
+    applyAttributes?(_value: IFrameAttributes): void;
+    mostRecentNavigatedTocItem?(): string | undefined;
+    /**
+     * Navigate left — respects reading progression direction.
+     * In LTR: goes to previous page. In RTL: goes to next page.
+     */
+    goLeft(): void;
+    /**
+     * Navigate right — respects reading progression direction.
+     * In LTR: goes to next page. In RTL: goes to previous page.
+     */
+    goRight(): void;
+    fitToPage(): void;
+    fitToWidth(): void;
+    zoomIn(): void;
+    zoomOut(): void;
+    activateHand(): void;
+    deactivateHand(): void;
+}

package/dist/types/reader.d.ts

@@ -3,7 +3,7 @@ import { UserSettingsIncrementable } from "./model/user-settings/UserProperties"
 import { UserSettings } from "./model/user-settings/UserSettings";
 import { IMediaOverlayUserSettings, MediaOverlayIncrementable } from "./modules/mediaoverlays/MediaOverlaySettings";
 import { ITTSUserSettings, TTSIncrementable } from "./modules/TTS/TTSSettings";
-import { IFrameAttributes, ReaderConfig } from "./navigator/IFrameNavigator";
+import { IFrameAttributes, ReaderConfig } from "./navigator/EpubNavigator";
 /**
  * A class that, once instantiated using the public `.build` method,
  * is the primary interface into the D2 Reader.
@@ -44,11 +44,11 @@ export default class D2Reader {
      */
     /** Start TTS Read Aloud */
     startReadAloud: () => void;
-    /** Start TTS Read Aloud */
+    /** Stop TTS Read Aloud */
     stopReadAloud: () => void;
-    /** Start TTS Read Aloud */
+    /** Pause TTS Read Aloud */
     pauseReadAloud: () => void;
-    /** Start TTS Read Aloud */
+    /** Resume TTS Read Aloud */
     resumeReadAloud: () => void;
     /**
      * Read Along
@@ -90,14 +90,14 @@ export default class D2Reader {
     /** Show Annotation Layer */
     showAnnotationLayer: () => void | undefined;
     /** Hide  Layer */
-    hideLayer: (layer: any) => false | void;
+    hideLayer: (layer: any) => void;
     /** Show  Layer */
-    showLayer: (layer: any) => false | void;
+    showLayer: (layer: any) => void;
     /** Activate Marker <br>
      * Activated Marker will be used for active annotation creation */
-    activateMarker: (id: string, position: string) => false | void;
+    activateMarker: (id: string, position: string) => void;
     /** Deactivate Marker */
-    deactivateMarker: () => false | void;
+    deactivateMarker: () => void;
     /**
      * Definitions
      */
@@ -140,7 +140,7 @@ export default class D2Reader {
      * Resources
      */
     get currentResource(): number | undefined;
-    get mostRecentNavigatedTocItem(): string | false;
+    get mostRecentNavigatedTocItem(): string | undefined;
     get totalResources(): number;
     get publicationLanguage(): string[] | undefined;
     /**
@@ -170,7 +170,7 @@ export default class D2Reader {
     scroll: (value: boolean, direction?: string) => Promise<void>;
     private isTTSIncrementable;
     private isMOIncrementable;
-    w: any; /**
+    /**
      * Used to increase anything that can be increased,
      * such as pitch, rate, volume, fontSize
      */
@@ -203,7 +203,7 @@ export default class D2Reader {
      * @TODO : These should return promises that complete when they are done.
      */
     get currentLocator(): Locator;
-    get positions(): any;
+    get positions(): Locator[];
     goTo: (locator: Locator) => Promise<void>;
     goToPosition: (value: number) => Promise<void>;
     goToPage: (page: number) => Promise<void>;