@d-i-t-a/reader 1.11.0-beta.2 → 1.11.0-beta.6

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import { ReaderConfig } from "./navigator/IFrameNavigator";
 import { Locator } from "./model/Locator";
-export declare const IS_DEV: boolean;
 export declare function unload(): Promise<void>;
 export declare function hasMediaOverlays(): boolean;
 /**
@@ -67,5 +66,11 @@ export declare function goToPosition(value: any): void;
 export declare function applyAttributes(value: any): void;
 export declare function hideAnnotationLayer(): void;
 export declare function showAnnotationLayer(): void;
+export declare function hideLayer(layer: any): void;
+export declare function showLayer(layer: any): void;
+export declare function clearDefinitions(): Promise<void>;
+export declare function addDefinition(definition: any): Promise<void>;
 export declare function snapToElement(value: any): void;
+export declare function activateMarker(id: any, position: any): void;
+export declare function deactivateMarker(): void;
 export declare function load(config: ReaderConfig): Promise<any>;

package/dist/modules/AnnotationModule.d.ts

@@ -36,6 +36,8 @@ export default class AnnotationModule implements ReaderModule {
     private delegate;
     properties: AnnotationModuleProperties;
     api: AnnotationModuleAPI;
+    activeAnnotationMarkerId?: string;
+    activeAnnotationMarkerPosition?: string;
     static create(config: AnnotationModuleConfig): Promise<AnnotationModule>;
     constructor(annotator: Annotator, headerMenu: HTMLElement, rights: ReaderRights, publication: Publication, delegate: IFrameNavigator, initialAnnotations: any | null, properties: AnnotationModuleProperties | null, api: AnnotationModuleAPI | null, highlighter: TextHighlighter);
     stop(): Promise<void>;
@@ -46,6 +48,7 @@ export default class AnnotationModule implements ReaderModule {
     showAnnotationLayer(): void;
     handleResize(): Promise<void>;
     initialize(): Promise<unknown>;
+    private click;
     scrollToHighlight(id: any): Promise<any>;
     updateLocalHighlight(annotation: Annotation): Promise<any>;
     deleteLocalHighlight(id: any): Promise<any>;

package/dist/modules/citations/CitationModule.d.ts

@@ -0,0 +1,37 @@
+import { Publication } from "../../model/Publication";
+import IFrameNavigator from "../../navigator/IFrameNavigator";
+import ReaderModule from "../ReaderModule";
+export declare enum CitationStyle {
+    Chicago = 0,
+    MLA = 1,
+    APA = 2
+}
+export declare enum ContributorType {
+    Author = "Author",
+    Editor = "Editor",
+    Translator = "Translator",
+    Compiler = "Compiler"
+}
+export interface CitationModuleProperties {
+    characters: number;
+    appName: string;
+    appLink: string;
+    library: string;
+    styles: string[];
+}
+export interface CitationModuleConfig extends CitationModuleProperties {
+    publication: Publication;
+    delegate: IFrameNavigator;
+}
+export default class CitationModule implements ReaderModule {
+    private publication;
+    private delegate;
+    private properties;
+    static create(config: CitationModuleConfig): Promise<CitationModule>;
+    private constructor();
+    stop(): Promise<void>;
+    protected start(): Promise<void>;
+    copyToClipboard(textToClipboard: any): void;
+    createElementForExecCommand(textToClipboard: any): HTMLDivElement;
+    selectContent(element: any): void;
+}

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

@@ -1,20 +1,26 @@
 import { HighlightType, IHighlight, IMarkerIcon, IPopupStyle, IStyle, SelectionMenuItem } from "./common/highlight";
 import { ISelectionInfo } from "./common/selection";
 import { IRectSimple } from "./common/rect-utils";
-import { IReadiumIFrameWindow } from "./renderer/iframe/state";
 import { AnnotationMarker } from "../../model/Locator";
 import IFrameNavigator from "../../navigator/IFrameNavigator";
 export declare const ID_HIGHLIGHTS_CONTAINER = "R2_ID_HIGHLIGHTS_CONTAINER";
 export declare const ID_READALOUD_CONTAINER = "R2_ID_READALOUD_CONTAINER";
 export declare const ID_PAGEBREAK_CONTAINER = "R2_ID_PAGEBREAK_CONTAINER";
 export declare const ID_SEARCH_CONTAINER = "R2_ID_SEARCH_CONTAINER";
+export declare const ID_POPUP_CONTAINER = "R2_ID_POPUP_CONTAINER";
 export declare const CLASS_HIGHLIGHT_CONTAINER = "R2_CLASS_HIGHLIGHT_CONTAINER";
 export declare const CLASS_HIGHLIGHT_AREA = "R2_CLASS_HIGHLIGHT_AREA";
 export declare const CLASS_HIGHLIGHT_ICON = "R2_CLASS_HIGHLIGHT_ICON";
 export declare const CLASS_HIGHLIGHT_BOUNDING_AREA = "R2_CLASS_HIGHLIGHT_BOUNDING_AREA";
+export declare const DEFAULT_BACKGROUND_COLOR: {
+    blue: number;
+    green: number;
+    red: number;
+};
 export interface TextSelectorAPI {
     selectionMenuOpen: any;
     selectionMenuClose: any;
+    selection: any;
 }
 export declare const _highlights: IHighlight[];
 interface IWithRect {
@@ -42,9 +48,10 @@ export default class TextHighlighter {
     private options;
     private delegate;
     private lastSelectedHighlight;
-    private properties;
+    properties: TextHighlighterProperties;
     private api;
     private hasEventListener;
+    activeAnnotationMarkerId?: string;
     static create(config: TextHighlighterConfig): Promise<any>;
     private constructor();
     initialize(): Promise<void>;
@@ -142,6 +149,9 @@ export default class TextHighlighter {
     selectionMenuClosed: (() => void) & {
         clear(): void;
     };
+    selection: ((text: any, selection: any) => void) & {
+        clear(): void;
+    };
     toolboxPlacement(): void;
     toolboxHandler(): void;
     /**
@@ -193,20 +203,6 @@ export default class TextHighlighter {
      * @memberof TextHighlighter
      */
     getColor(): string;
-    /**
-     * Returns highlights from given container.
-     * @param params
-     * @param {HTMLElement} [params.container] - return highlights from this element. Default: the element the
-     * highlighter is applied to.
-     * @param {boolean} [params.andSelf] - if set to true and container is a highlight itself, add container to
-     * returned results. Default: true.
-     * @param {boolean} [params.grouped] - if set to true, highlights are grouped in logical groups of highlights added
-     * in the same moment. Each group is an object which has got array of highlights, 'toString' method and 'timestamp'
-     * property. Default: false.
-     * @returns {Array} - array of highlights.
-     * @memberof TextHighlighter
-     */
-    getHighlights(params?: any): Array<any>;
     /**
      * Returns true if element is a highlight.
      * All highlights have 'data-highlighted' attribute.
@@ -215,20 +211,6 @@ export default class TextHighlighter {
      * @memberof TextHighlighter
      */
     isHighlight(el: any): boolean;
-    /**
-     * Serializes all highlights in the element the highlighter is applied to.
-     * @returns {string} - stringified JSON with highlights definition
-     * @memberof TextHighlighter
-     */
-    serializeHighlights(): string;
-    /**
-     * Deserializes highlights.
-     * @throws exception when can't parse JSON or JSON has invalid structure.
-     * @param {object} json - JSON object with highlights definition.
-     * @returns {Array} - array of deserialized highlights.
-     * @memberof TextHighlighter
-     */
-    deserializeHighlights(json: any): Array<any>;
     /**
      * Creates wrapper for highlights.
      * TextHighlighter instance calls this method each time it needs to create highlights and pass options retrieved
@@ -247,27 +229,20 @@ export default class TextHighlighter {
     };
     static hexToRgbA(hex: string): string;
     static hexToRgbAWithOpacity(hex: string, opacity: number): string;
-    resetHighlightBoundingStyle(_win: IReadiumIFrameWindow, highlightBounding: HTMLElement): void;
-    resetHighlightAreaStyle(_win: IReadiumIFrameWindow, highlightArea: HTMLElement, id_container: string): void;
-    setHighlightAreaStyle(_win: IReadiumIFrameWindow, highlightAreas: Array<HTMLElement>, highlight: IHighlight): void;
+    resetHighlightBoundingStyle(_win: any, highlightBounding: HTMLElement): void;
+    resetHighlightAreaStyle(_win: any, highlightArea: HTMLElement, id_container: string): void;
+    setHighlightAreaStyle(_win: any, highlightAreas: Array<HTMLElement>, highlight: IHighlight): void;
     setAndResetSearchHighlight(highlight: any, highlights: any): void;
     isIOS(): boolean;
     isAndroid(): boolean;
     getScrollingElement: (documant: Document) => Element;
-    processMouseEvent(win: IReadiumIFrameWindow, ev: MouseEvent): Promise<void>;
-    ensureHighlightsContainer(win: IReadiumIFrameWindow, id: string): HTMLElement;
+    processMouseEvent(win: any, ev: MouseEvent): Promise<void>;
+    ensureHighlightsContainer(win: any, id: string): HTMLElement;
     hideAllhighlights(_documant: Document): void;
     destroyAllhighlights(documant: Document): void;
     destroyHighlights(type: HighlightType): void;
     destroyHighlight(documant: Document, id: string): void;
-    recreateAllHighlightsRaw(win: IReadiumIFrameWindow): void;
-    recreateAllHighlightsDebounced: ((win: IReadiumIFrameWindow) => void) & {
-        clear(): void;
-    };
-    recreateAllHighlights(win: IReadiumIFrameWindow): void;
-    createSearchHighlight(selectionInfo: ISelectionInfo, color: string): IHighlight;
-    createPageBreakHighlight(selectionInfo: ISelectionInfo, title: string): IHighlight;
-    createHighlight(win: IReadiumIFrameWindow, selectionInfo: ISelectionInfo, color: string | undefined, pointerInteraction: boolean, marker: AnnotationMarker, icon?: IMarkerIcon | undefined, popup?: IPopupStyle | undefined, style?: IStyle | undefined, type?: HighlightType | undefined, prefix?: string | undefined): [IHighlight, HTMLDivElement];
-    createHighlightDom(win: IReadiumIFrameWindow, highlight: IHighlight): HTMLDivElement | undefined;
+    createHighlight(win: any, selectionInfo: ISelectionInfo, color: string | undefined, pointerInteraction: boolean, marker: AnnotationMarker, icon?: IMarkerIcon | undefined, popup?: IPopupStyle | undefined, style?: IStyle | undefined, type?: HighlightType | undefined, prefix?: string | undefined): [IHighlight, HTMLDivElement];
+    createHighlightDom(win: any, highlight: IHighlight): HTMLDivElement | undefined;
 }
 export {};

package/dist/modules/highlight/TextHighlighterFXL.d.ts

@@ -0,0 +1,278 @@
+import { HighlightType, IHighlight, IMarkerIcon, IPopupStyle, IStyle, SelectionMenuItem } from "./common/highlight";
+import { ISelectionInfo } from "./common/selection";
+import { IRectSimple } from "./common/rect-utils";
+import { IReadiumIFrameWindow } from "./renderer/iframe/state";
+import { AnnotationMarker } from "../../model/Locator";
+import IFrameNavigator from "../../navigator/IFrameNavigator";
+import { Definition } from "../search/DefinitionsModule";
+export declare const ID_HIGHLIGHTS_CONTAINER = "R2_ID_HIGHLIGHTS_CONTAINER";
+export declare const ID_READALOUD_CONTAINER = "R2_ID_READALOUD_CONTAINER";
+export declare const ID_POPUP_CONTAINER = "R2_ID_POPUP_CONTAINER";
+export declare const CLASS_HIGHLIGHT_CONTAINER = "R2_CLASS_HIGHLIGHT_CONTAINER";
+export declare const CLASS_HIGHLIGHT_AREA = "R2_CLASS_HIGHLIGHT_AREA";
+export declare const CLASS_HIGHLIGHT_ICON = "R2_CLASS_HIGHLIGHT_ICON";
+export declare const CLASS_HIGHLIGHT_BOUNDING_AREA = "R2_CLASS_HIGHLIGHT_BOUNDING_AREA";
+export declare const _highlights: IHighlight[];
+interface IWithRect {
+    rect: IRectSimple;
+    scale: number;
+}
+export interface TextSelectorAPI {
+    selectionMenuOpen: any;
+    selectionMenuClose: any;
+    selection: any;
+}
+export interface IHTMLDivElementWithRect extends HTMLDivElement, IWithRect {
+}
+export interface HTMLElementRect {
+    node: Element;
+    height: number;
+    top: number;
+    width: number;
+    left: number;
+    textContent: string;
+}
+export interface TextHighlighterProperties {
+    selectionMenuItems: Array<SelectionMenuItem>;
+}
+export interface TextHighlighterConfig extends TextHighlighterProperties {
+    delegate: IFrameNavigator;
+    api: TextSelectorAPI;
+}
+export default class TextHighlighterFXL {
+    private options;
+    private readonly delegate;
+    private lastSelectedHighlight;
+    properties: TextHighlighterProperties;
+    private api;
+    private hasEventListener;
+    activeAnnotationMarkerId?: string;
+    static create(config: TextHighlighterConfig): Promise<any>;
+    private constructor();
+    initialize(): Promise<void>;
+    /**
+     * Returns true if elements a i b have the same color.
+     * @param {Node} a
+     * @param {Node} b
+     * @returns {boolean}
+     */
+    haveSameColor(a: any, b: any): boolean;
+    /**
+     * Fills undefined values in obj with default properties with the same name from source object.
+     * @param {object} obj - target object
+     * @param {object} source - source object with default values
+     * @returns {object}
+     */
+    defaults(obj: {
+        [x: string]: any;
+    }, source: {
+        [x: string]: any;
+        color?: string;
+        highlightedClass?: string;
+        contextClass?: string;
+        onBeforeHighlight?: () => boolean;
+        onAfterHighlight?: () => void;
+        container?: any;
+        andSelf?: boolean;
+        grouped?: boolean;
+        hasOwnProperty?: any;
+    }): object;
+    /**
+     * Returns array without duplicated values.
+     * @param {Array} arr
+     * @returns {Array}
+     */
+    unique(arr: {
+        filter: (arg0: (value: any, idx: any, self: any) => boolean) => void;
+    }): void;
+    /**
+     * Takes range object as parameter and refines it boundaries
+     * @param range
+     * @returns {object} refined boundaries and initial state of highlighting algorithm.
+     */
+    refineRangeBoundaries(range: {
+        startContainer: any;
+        endContainer: any;
+        commonAncestorContainer: any;
+        endOffset: number;
+        startOffset: number;
+    }): object;
+    /**
+     * Sorts array of DOM elements by its depth in DOM tree.
+     * @param {HTMLElement[]} arr - array to sort.
+     * @param {boolean} descending - order of sort.
+     */
+    sortByDepth(arr: {
+        sort: (arg0: (a: any, b: any) => number) => void;
+    }, descending: boolean): void;
+    /**
+     * Groups given highlights by timestamp.
+     * @param {Array} highlights
+     * @returns {Array} Grouped highlights.
+     */
+    groupHighlights(highlights: {
+        forEach: (arg0: (hl: any) => void) => void;
+    }): Array<any>;
+    /**
+     * Utility functions to make DOM manipulation easier.
+     * @param {Node|HTMLElement} [el] - base DOM element to manipulate
+     * @returns {object}
+     */
+    dom(el?: any): any;
+    disableContext(e: {
+        preventDefault: () => void;
+        stopPropagation: () => void;
+    }): boolean;
+    bindEvents(el: any, _scope: any, hasEventListener: boolean): void;
+    unbindEvents(el: any, _scope: any): void;
+    /**
+     * Permanently disables highlighting.
+     * Unbinds events and remove context element class.
+     * @memberof TextHighlighter
+     */
+    destroy(): void;
+    initializeToolbox(): void;
+    toolboxMode(mode: "colors" | "edit" | "add" | "action"): void;
+    toolboxHide(): void;
+    toolboxShowDelayed(): void;
+    snapSelectionToWord(): any;
+    toolboxShow(): void;
+    isSelectionMenuOpen: boolean;
+    selectionMenuOpened: (() => void) & {
+        clear(): void;
+    };
+    selectionMenuClosed: (() => void) & {
+        clear(): void;
+    };
+    selection: ((text: any, selection: any) => void) & {
+        clear(): void;
+    };
+    toolboxPlacement(): void;
+    toolboxHandler(): void;
+    /**
+     * Highlights current range.
+     * @param {boolean} keepRange - Don't remove range after highlighting. Default: false.
+     * @param marker
+     * @memberof TextHighlighter
+     */
+    doHighlight(iframe: any, keepRange?: boolean, marker?: AnnotationMarker): void;
+    speak(iframe: any): void;
+    stopReadAloud(): void;
+    speakAll(iframe: any): void;
+    callbackComplete(): void;
+    visibleTextRects(iframe: any): HTMLElementRect[];
+    doneSpeaking(reload?: boolean): void;
+    /**
+     * Normalizes highlights. Ensures that highlighting is done with use of the smallest possible number of
+     * wrapping HTML elements.
+     * Flattens highlights structure and merges sibling highlights. Normalizes text nodes within highlights.
+     * @param {Array} highlights - highlights to normalize.
+     * @returns {Array} - array of normalized highlights. Order and number of returned highlights may be different than
+     * input highlights.
+     * @memberof TextHighlighter
+     */
+    normalizeHighlights(highlights: any): any;
+    /**
+     * Flattens highlights structure.
+     * Note: this method changes input highlights - their order and number after calling this method may change.
+     * @param {Array} highlights - highlights to flatten.
+     * @memberof TextHighlighter
+     */
+    flattenNestedHighlights(highlights: any): void;
+    /**
+     * Merges sibling highlights and normalizes descendant text nodes.
+     * Note: this method changes input highlights - their order and number after calling this method may change.
+     * @param highlights
+     * @memberof TextHighlighter
+     */
+    mergeSiblingHighlights(highlights: any): void;
+    /**
+     * Sets highlighting color.
+     * @param {string} color - valid CSS color.
+     * @memberof TextHighlighter
+     */
+    setColor(color: any): void;
+    /**
+     * Returns highlighting color.
+     * @returns {string}
+     * @memberof TextHighlighter
+     */
+    getColor(): string;
+    /**
+     * Returns highlights from given container.
+     * @param params
+     * @param {HTMLElement} [params.container] - return highlights from this element. Default: the element the
+     * highlighter is applied to.
+     * @param {boolean} [params.andSelf] - if set to true and container is a highlight itself, add container to
+     * returned results. Default: true.
+     * @param {boolean} [params.grouped] - if set to true, highlights are grouped in logical groups of highlights added
+     * in the same moment. Each group is an object which has got array of highlights, 'toString' method and 'timestamp'
+     * property. Default: false.
+     * @returns {Array} - array of highlights.
+     * @memberof TextHighlighter
+     */
+    getHighlights(iframe: any, params?: any): Array<any>;
+    /**
+     * Returns true if element is a highlight.
+     * All highlights have 'data-highlighted' attribute.
+     * @param el - element to check.
+     * @returns {boolean}
+     * @memberof TextHighlighter
+     */
+    isHighlight(el: any): boolean;
+    /**
+     * Serializes all highlights in the element the highlighter is applied to.
+     * @returns {string} - stringified JSON with highlights definition
+     * @memberof TextHighlighter
+     */
+    serializeHighlights(iframe: any): string;
+    /**
+     * Deserializes highlights.
+     * @throws exception when can't parse JSON or JSON has invalid structure.
+     * @param {object} json - JSON object with highlights definition.
+     * @returns {Array} - array of deserialized highlights.
+     * @memberof TextHighlighter
+     */
+    deserializeHighlights(iframe: any, json: any): Array<any>;
+    /**
+     * Creates wrapper for highlights.
+     * TextHighlighter instance calls this method each time it needs to create highlights and pass options retrieved
+     * in constructor.
+     * @returns {HTMLElement}
+     * @memberof TextHighlighter
+     * @static
+     */
+    createWrapper(): HTMLElement;
+    static isHexColor(hex: string): boolean;
+    static hexToRgbString(hex: string): any;
+    static hexToRgbChannels(hex: string): {
+        red: number;
+        green: number;
+        blue: number;
+    };
+    static hexToRgbA(hex: string): string;
+    static hexToRgbAWithOpacity(hex: string, opacity: number): string;
+    resetHighlightBoundingStyle(_win: IReadiumIFrameWindow, highlightBounding: HTMLElement): void;
+    resetHighlightAreaStyle(_win: IReadiumIFrameWindow, highlightArea: HTMLElement, id_container: string): void;
+    setHighlightAreaStyle(_win: IReadiumIFrameWindow, highlightAreas: Array<HTMLElement>, highlight: IHighlight): void;
+    isIOS(): boolean;
+    isAndroid(): boolean;
+    getScrollingElement: (documant: Document) => Element;
+    processMouseEvent(win: IReadiumIFrameWindow, ev: MouseEvent): Promise<void>;
+    ensureHighlightsContainer(win: IReadiumIFrameWindow, id: string): HTMLElement;
+    hideAllhighlights(_documant: Document): void;
+    destroyAllhighlights(documant: Document): void;
+    destroyHighlights(type: HighlightType): void;
+    destroyHighlight(documant: Document, id: string): void;
+    recreateAllHighlightsRaw(win: IReadiumIFrameWindow): void;
+    recreateAllHighlightsDebounced: ((win: IReadiumIFrameWindow) => void) & {
+        clear(): void;
+    };
+    recreateAllHighlights(win: IReadiumIFrameWindow): void;
+    createPopupHighlight(iframe: any, selectionInfo: ISelectionInfo, item: Definition): IHighlight;
+    createSearchHighlight(iframe: any, selectionInfo: ISelectionInfo, color: string): IHighlight;
+    createPageBreakHighlight(iframe: any, selectionInfo: ISelectionInfo, title: string): IHighlight;
+    createHighlight(win: IReadiumIFrameWindow, selectionInfo: ISelectionInfo, color: string | undefined, pointerInteraction: boolean, marker: AnnotationMarker, icon?: IMarkerIcon | undefined, popup?: IPopupStyle | undefined, style?: IStyle | undefined, type?: HighlightType | undefined, prefix?: string | undefined): [IHighlight, HTMLDivElement];
+    createHighlightDom(win: IReadiumIFrameWindow, highlight: IHighlight): HTMLDivElement | undefined;
+}
+export {};

package/dist/modules/highlight/common/highlight.d.ts

@@ -1,5 +1,6 @@
 import { ISelectionInfo } from "./selection";
 import { AnnotationMarker } from "../../../model/Locator";
+import { Definition } from "../../search/DefinitionsModule";
 export interface IColor {
     red: number;
     green: number;
@@ -37,7 +38,8 @@ export declare enum HighlightType {
     Annotation = 0,
     Search = 1,
     ReadAloud = 2,
-    PageBreak = 3
+    PageBreak = 3,
+    Popup = 4
 }
 export interface IHighlight {
     id: string;
@@ -50,6 +52,7 @@ export interface IHighlight {
     style?: IStyle | undefined;
     position?: number;
     note?: string | undefined;
+    definition?: Definition | undefined;
     type: HighlightType;
 }
 export interface SelectionMenuItem {

package/dist/modules/highlight/renderer/iframe/state.d.ts

@@ -5,9 +5,6 @@ export interface IReadiumIFrameWindowState {
     locationHashOverride: Element | undefined;
     locationHashOverrideInfo: IEventPayload_R2_EVENT_READING_LOCATION | undefined;
 }
-export interface IReadiumIFrameWindow extends Window {
-    READIUM2: IReadiumIFrameWindowState;
-}
 export interface IReadiumIFrameState {
     id: number;
     link: Link | undefined;

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

@@ -0,0 +1,43 @@
+import { Publication } from "../../model/Publication";
+import IFrameNavigator from "../../navigator/IFrameNavigator";
+import ReaderModule from "../ReaderModule";
+import TextHighlighter from "../highlight/TextHighlighter";
+export interface LineFocusModuleAPI {
+}
+export interface LineFocusModuleProperties {
+    api?: LineFocusModuleAPI;
+    factor: number;
+    startIndex: number;
+    currentIndex: number;
+}
+export interface LineFocusModuleConfig extends LineFocusModuleProperties {
+    api: LineFocusModuleAPI;
+    publication: Publication;
+    delegate: IFrameNavigator;
+    highlighter: TextHighlighter;
+}
+export default class LineFocusModule implements ReaderModule {
+    properties: LineFocusModuleProperties;
+    api: LineFocusModuleAPI;
+    private delegate;
+    private highlighter;
+    lines: Array<HTMLElement>;
+    index: number;
+    isActive: boolean;
+    isDebug: boolean;
+    static create(config: LineFocusModuleConfig): Promise<LineFocusModule>;
+    private constructor();
+    stop(): Promise<void>;
+    protected start(): Promise<void>;
+    handleResize(): void;
+    enableLineFocus(): void;
+    disableLineFocus(): void;
+    lineFocus(): void;
+    currentLine(): void;
+    lineDown(): void;
+    lineUp(): void;
+    almostEqual(a: number, b: number, tolerance: number): boolean;
+    findRects(parent: HTMLElement): any;
+    findTextNodes(parentElement: Element, nodes?: Array<Element>): Array<Element>;
+    measureTextNodes(node: Element): any;
+}

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

@@ -1,5 +1,7 @@
 import IFrameNavigator from "../../navigator/IFrameNavigator";
 import ReaderModule from "../ReaderModule";
+import { IHighlight } from "../highlight/common/highlight";
+import { ISelectionInfo } from "../highlight/common/selection";
 import { Publication } from "../../model/Publication";
 export interface PageBreakModuleConfig {
     delegate: IFrameNavigator;
@@ -20,4 +22,5 @@ export default class PageBreakModule implements ReaderModule {
     private goToPageNumber;
     handleResize(): Promise<void>;
     drawPageBreaks(): Promise<void>;
+    createPageBreakHighlight(selectionInfo: ISelectionInfo, title: string): IHighlight;
 }

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

@@ -0,0 +1,52 @@
+import { Publication } from "../../model/Publication";
+import IFrameNavigator from "../../navigator/IFrameNavigator";
+import ReaderModule from "../ReaderModule";
+import TextHighlighter from "../highlight/TextHighlighter";
+import { IHighlight } from "../highlight/common/highlight";
+import { ISelectionInfo } from "../highlight/common/selection";
+export interface DefinitionsModuleAPI {
+    success?: any;
+    click?: any;
+    visible?: any;
+}
+export interface Definition {
+    order: number;
+    terms: [string];
+    result?: number;
+    definition?: string;
+}
+export interface DefinitionsModuleProperties {
+    definitions: Definition[];
+    color?: string;
+    fullWordSearch?: boolean;
+    api?: DefinitionsModuleAPI;
+}
+export interface DefinitionsModuleConfig extends DefinitionsModuleProperties {
+    api: DefinitionsModuleAPI;
+    publication: Publication;
+    delegate: IFrameNavigator;
+    highlighter: TextHighlighter;
+}
+export default class DefinitionsModule implements ReaderModule {
+    properties: DefinitionsModuleProperties;
+    api: DefinitionsModuleAPI;
+    private publication;
+    private delegate;
+    private currentChapterPopupResult;
+    private currentPopupHighlights;
+    private highlighter;
+    static create(config: DefinitionsModuleConfig): Promise<DefinitionsModule>;
+    private constructor();
+    stop(): Promise<void>;
+    protected start(): Promise<void>;
+    searchAndPaint(item: Definition, callback: (result: any) => any): Promise<void>;
+    definitions: (() => Promise<void>) & {
+        clear(): void;
+    };
+    define(item: Definition): Promise<void>;
+    drawDefinitions(): void;
+    handleResize(): Promise<void>;
+    createPopupHighlight(selectionInfo: ISelectionInfo, item: Definition): IHighlight;
+    addDefinition(definition: any): Promise<void>;
+    clearDefinitions(): Promise<void>;
+}

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

@@ -0,0 +1,8 @@
+import IFrameNavigator from "../../navigator/IFrameNavigator";
+export default class Popup {
+    navigator: IFrameNavigator;
+    constructor(navigator: IFrameNavigator);
+    handleFootnote(link: HTMLLIElement, event: MouseEvent | TouchEvent): Promise<void>;
+    showPopup(element: any, event: MouseEvent | TouchEvent): void;
+    private getScrollingElement;
+}