@d-i-t-a/reader 1.12.0-alpha.1 → 1.12.0-beta.5

package/dist/index.d.ts

@@ -32,6 +32,12 @@ export declare function totalResources(): number;
 export declare function publicationLanguage(): string[];
 export declare function resetUserSettings(): Promise<void>;
 export declare function applyUserSettings(userSettings: any): Promise<void>;
+export declare function applyLineFocusSettings(userSettings: any): Promise<void>;
+export declare function lineUp(): void;
+export declare function lineDown(): void;
+export declare function enableLineFocus(): Promise<void>;
+export declare function lineFocus(active: boolean): Promise<void>;
+export declare function disableLineFocus(): void;
 export declare function currentSettings(): Promise<{
     appearance: string;
     fontFamily: string;
@@ -66,6 +72,10 @@ 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;

package/dist/modules/AnnotationModule.d.ts

@@ -14,6 +14,7 @@ export interface AnnotationModuleAPI {
 }
 export interface AnnotationModuleProperties {
     initialAnnotationColor: string;
+    hideLayer?: boolean;
 }
 export interface AnnotationModuleConfig extends AnnotationModuleProperties {
     annotator: Annotator;
@@ -57,10 +58,10 @@ export default class AnnotationModule implements ReaderModule {
     deleteHighlight(highlight: Annotation): Promise<any>;
     deleteSelectedHighlight(highlight: Annotation): Promise<any>;
     updateAnnotation(highlight: Annotation): Promise<any>;
-    saveAnnotation(highlight: IHighlight, iframehref: any): Promise<Annotation>;
+    saveAnnotation(highlight: IHighlight): Promise<Annotation>;
     getAnnotations(): Promise<any>;
     showHighlights(): Promise<void>;
-    drawHighlights(iframeIndex: any, iframehref: string): Promise<void>;
+    drawHighlights(): Promise<void>;
     private createTree;
     private handleAnnotationLinkClick;
     private handleAnnotationLinkDeleteClick;

package/dist/modules/BookmarkModule.d.ts

@@ -10,15 +10,15 @@ export interface BookmarkModuleAPI {
     getBookmarks: Array<any>;
 }
 export interface BookmarkModuleProperties {
+    hideLayer?: boolean;
 }
-export interface BookmarkModuleConfig {
+export interface BookmarkModuleConfig extends BookmarkModuleProperties {
     annotator: Annotator;
     headerMenu: HTMLElement;
     rights: ReaderRights;
     publication: Publication;
     delegate: IFrameNavigator;
     initialAnnotations?: any;
-    properties: BookmarkModuleProperties;
     api: BookmarkModuleAPI;
 }
 export default class BookmarkModule implements ReaderModule {

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

@@ -18,6 +18,7 @@ export interface TTSModuleProperties {
     pitch?: number;
     volume?: number;
     voice?: TTSVoice;
+    hideLayer?: boolean;
 }
 export interface TTSModuleConfig extends TTSModuleProperties {
     delegate: IFrameNavigator;

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

@@ -0,0 +1,19 @@
+import Store from "../../store/Store";
+import { UserProperty, UserProperties } from "../../model/user-settings/UserProperties";
+export interface LayerConfig {
+    store: Store;
+}
+export interface ILayerSettings {
+}
+export declare class LayerSettings implements ILayerSettings {
+    private readonly store;
+    private readonly LAYERSETTINGS;
+    userProperties: UserProperties;
+    static create(config: LayerConfig): Promise<any>;
+    protected constructor(store: Store);
+    stop(): Promise<void>;
+    private initialize;
+    private getLayerSettings;
+    saveProperty(property: UserProperty): Promise<any>;
+    getProperty(name: string): Promise<UserProperty>;
+}

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

@@ -3,15 +3,20 @@ import { ISelectionInfo } from "./common/selection";
 import { IRectSimple } from "./common/rect-utils";
 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";
+import { LayerSettings } from "./LayerSettings";
+export declare enum HighlightContainer {
+    R2_ID_HIGHLIGHTS_CONTAINER = "R2_ID_HIGHLIGHTS_CONTAINER",
+    R2_ID_BOOKMAKRS_CONTAINER = "R2_ID_BOOKMAKRS_CONTAINER",
+    R2_ID_READALOUD_CONTAINER = "R2_ID_READALOUD_CONTAINER",
+    R2_ID_PAGEBREAK_CONTAINER = "R2_ID_PAGEBREAK_CONTAINER",
+    R2_ID_SEARCH_CONTAINER = "R2_ID_SEARCH_CONTAINER",
+    R2_ID_DEFINITIONS_CONTAINER = "R2_ID_DEFINITIONS_CONTAINER",
+    R2_ID_LINEFOCUS_CONTAINER = "R2_ID_LINEFOCUS_CONTAINER"
+}
 export declare const CLASS_HIGHLIGHT_CONTAINER = "R2_CLASS_HIGHLIGHT_CONTAINER";
+export declare const CLASS_HIGHLIGHT_BOUNDING_AREA = "R2_CLASS_HIGHLIGHT_BOUNDING_AREA";
 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;
@@ -43,10 +48,13 @@ export interface TextHighlighterProperties {
 export interface TextHighlighterConfig extends TextHighlighterProperties {
     delegate: IFrameNavigator;
     api: TextSelectorAPI;
+    layerSettings: LayerSettings;
 }
 export default class TextHighlighter {
     private options;
     private readonly delegate;
+    layerSettings: LayerSettings;
+    private lastSelectedHighlight;
     properties: TextHighlighterProperties;
     private api;
     private hasEventListener;
@@ -101,6 +109,22 @@ export default class TextHighlighter {
         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
@@ -111,8 +135,8 @@ export default class TextHighlighter {
         preventDefault: () => void;
         stopPropagation: () => void;
     }): boolean;
-    bindEvents(iframeIndex: number, hasEventListener: boolean): void;
-    unbindEvents(iframeIndex: number): void;
+    bindEvents(el: any, _scope: any, hasEventListener: boolean): void;
+    unbindEvents(el: any, _scope: any): void;
     /**
      * Permanently disables highlighting.
      * Unbinds events and remove context element class.
@@ -122,9 +146,9 @@ export default class TextHighlighter {
     initializeToolbox(): void;
     toolboxMode(mode: "colors" | "edit" | "add" | "action"): void;
     toolboxHide(): void;
-    toolboxShowDelayed(iframeIndex: number): void;
-    snapSelectionToWord(iframeIndex: number): any;
-    toolboxShow(iframeIndex: number): void;
+    toolboxShowDelayed(): void;
+    snapSelectionToWord(): any;
+    toolboxShow(): void;
     isSelectionMenuOpen: boolean;
     selectionMenuOpened: (() => void) & {
         clear(): void;
@@ -135,21 +159,21 @@ export default class TextHighlighter {
     selection: ((text: any, selection: any) => void) & {
         clear(): void;
     };
-    toolboxPlacement(iframeIndex: number): void;
-    toolboxHandler(iframeIndex: number): void;
+    toolboxPlacement(): void;
+    toolboxHandler(): void;
     /**
      * Highlights current range.
      * @param {boolean} keepRange - Don't remove range after highlighting. Default: false.
      * @param marker
      * @memberof TextHighlighter
      */
-    doHighlight(iframeIndex: number, keepRange?: boolean, marker?: AnnotationMarker): void;
-    speak(iframeIndex: number): void;
-    stopReadAloud(iframeIndex: number): void;
-    speakAll(iframeIndex: number): void;
-    callbackComplete(iframeIndex: number): void;
-    visibleTextRects(iframeIndex: number): HTMLElementRect[];
-    doneSpeaking(iframeIndex: number, reload?: boolean): void;
+    doHighlight(keepRange?: boolean, marker?: AnnotationMarker): void;
+    speak(): void;
+    stopReadAloud(): void;
+    speakAll(): void;
+    callbackComplete(): void;
+    get visibleTextRects(): HTMLElementRect[];
+    doneSpeaking(reload?: boolean): void;
     /**
      * Normalizes highlights. Ensures that highlighting is done with use of the smallest possible number of
      * wrapping HTML elements.
@@ -160,6 +184,13 @@ export default class TextHighlighter {
      * @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.
@@ -205,20 +236,21 @@ export default class TextHighlighter {
     };
     static hexToRgbA(hex: string): string;
     static hexToRgbAWithOpacity(hex: string, opacity: number): string;
-    resetHighlightBoundingStyle(highlightBounding: HTMLElement): void;
-    resetHighlightAreaStyle(highlightArea: HTMLElement, id_container: string, iframeIndex: number): void;
-    setHighlightAreaStyle(highlightAreas: Array<HTMLElement>, highlight: IHighlight, iframeIndex: number): void;
-    setAndResetSearchHighlight(highlight: any, highlights: any, iframeIndex: number): 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: (iframeDocument: Document) => Element;
-    processMouseEvent(iframeIndex: number, ev: MouseEvent): Promise<void>;
-    ensureHighlightsContainer(id: string, iframeIndex: number): HTMLElement;
-    hideAllHighlights(iframeIndex: number): void;
-    destroyAllHighlights(iframeIndex: number): void;
-    destroyHighlights(type: HighlightType, iframeIndex: number): void;
-    destroyHighlight(id: string, iframeIndex: number): void;
-    createHighlight(iframeIndex: 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(iframeIndex: number, highlight: IHighlight): HTMLDivElement | undefined;
+    getScrollingElement: (doc: Document) => Element;
+    processMouseEvent(win: any, ev: MouseEvent): Promise<void>;
+    ensureHighlightsContainer(win: any, id: string): Promise<HTMLElement>;
+    hideAllhighlights(doc: Document): void;
+    destroyAllhighlights(doc: Document): void;
+    removeAllChildNodes(parent: any): void;
+    destroyHighlights(type: HighlightType): void;
+    destroyHighlight(doc: Document, id: string): void;
+    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/common/highlight.d.ts

@@ -39,7 +39,8 @@ export declare enum HighlightType {
     Search = 1,
     ReadAloud = 2,
     PageBreak = 3,
-    Popup = 4
+    Definition = 4,
+    LineFocus = 5
 }
 export interface IHighlight {
     id: string;

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

@@ -6,9 +6,7 @@ export interface LineFocusModuleAPI {
 }
 export interface LineFocusModuleProperties {
     api?: LineFocusModuleAPI;
-    factor: number;
-    startIndex: number;
-    currentIndex: number;
+    lines: number;
 }
 export interface LineFocusModuleConfig extends LineFocusModuleProperties {
     api: LineFocusModuleAPI;
@@ -25,12 +23,15 @@ export default class LineFocusModule implements ReaderModule {
     index: number;
     isActive: boolean;
     isDebug: boolean;
+    lineFocusContainer: HTMLElement;
+    lineFocusTopBlinder: HTMLElement;
+    lineFocusBottomBlinder: HTMLElement;
     static create(config: LineFocusModuleConfig): Promise<LineFocusModule>;
     private constructor();
     stop(): Promise<void>;
     protected start(): Promise<void>;
     handleResize(): void;
-    enableLineFocus(): void;
+    enableLineFocus(): Promise<void>;
     disableLineFocus(): void;
     lineFocus(): void;
     currentLine(): void;

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

@@ -18,6 +18,7 @@ export interface MediaOverlayModuleProperties {
     autoTurn?: boolean;
     volume?: number;
     wait?: number;
+    hideLayer?: boolean;
 }
 export interface MediaOverlayModuleConfig extends MediaOverlayModuleProperties {
     publication: Publication;

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

@@ -3,7 +3,10 @@ import ReaderModule from "../ReaderModule";
 import { IHighlight } from "../highlight/common/highlight";
 import { ISelectionInfo } from "../highlight/common/selection";
 import { Publication } from "../../model/Publication";
-export interface PageBreakModuleConfig {
+export interface PageBreakModuleProperties {
+    hideLayer?: boolean;
+}
+export interface PageBreakModuleConfig extends PageBreakModuleProperties {
     delegate: IFrameNavigator;
     headerMenu: HTMLElement;
     publication: Publication;
@@ -12,6 +15,7 @@ export default class PageBreakModule implements ReaderModule {
     private delegate;
     private readonly headerMenu;
     private publication;
+    private properties;
     private goToPageView;
     private goToPageNumberInput;
     private goToPageNumberButton;

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

@@ -18,7 +18,8 @@ export interface Definition {
 export interface DefinitionsModuleProperties {
     definitions: Definition[];
     color?: string;
-    api?: DefinitionsModuleAPI;
+    fullWordSearch?: boolean;
+    hideLayer?: boolean;
 }
 export interface DefinitionsModuleConfig extends DefinitionsModuleProperties {
     api: DefinitionsModuleAPI;
@@ -43,7 +44,9 @@ export default class DefinitionsModule implements ReaderModule {
         clear(): void;
     };
     define(item: Definition): Promise<void>;
-    drawDefinitions(): void;
+    drawDefinitions(): Promise<void>;
     handleResize(): Promise<void>;
-    createPopupHighlight(selectionInfo: ISelectionInfo, item: Definition): IHighlight;
+    createDefinitionHighlight(selectionInfo: ISelectionInfo, item: Definition): IHighlight;
+    addDefinition(definition: any): Promise<void>;
+    clearDefinitions(): Promise<void>;
 }

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

@@ -9,6 +9,7 @@ export interface SearchModuleAPI {
 export interface SearchModuleProperties {
     color?: string;
     current?: string;
+    hideLayer?: boolean;
 }
 export interface SearchModuleConfig extends SearchModuleProperties {
     api: SearchModuleAPI;

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

@@ -11,4 +11,4 @@ export interface ISearchResult {
 }
 export declare function escapeRegExp(str: string): string;
 export declare const reset: () => void;
-export declare function searchDocDomSeek(searchInput: string, doc: Document, href: string, title: string): Promise<ISearchResult[]>;
+export declare function searchDocDomSeek(searchInput: string, doc: Document, href: string, title: string, fullWordSearch?: boolean): Promise<ISearchResult[]>;

package/dist/navigator/IFrameNavigator.d.ts

@@ -14,8 +14,9 @@ import MediaOverlayModule, { MediaOverlayModuleConfig } from "../modules/mediaov
 import { D2Link, Link } from "../model/Link";
 import ReaderModule from "../modules/ReaderModule";
 import { TTSModuleConfig } from "../modules/TTS/TTSSettings";
-import PageBreakModule from "../modules/pagebreak/PageBreakModule";
+import PageBreakModule, { PageBreakModuleConfig } from "../modules/pagebreak/PageBreakModule";
 import DefinitionsModule, { DefinitionsModuleConfig } from "../modules/search/DefinitionsModule";
+import LineFocusModule, { LineFocusModuleConfig } from "../modules/linefocus/LineFocusModule";
 export declare type GetContent = (href: string) => Promise<string>;
 export declare type GetContentBytesLength = (href: string) => Promise<number>;
 export interface NavigatorAPI {
@@ -90,6 +91,8 @@ export interface ReaderRights {
     enableTimeline?: boolean;
     autoGeneratePositions?: boolean;
     enableMediaOverlays?: boolean;
+    enablePageBreaks?: boolean;
+    enableLineFocus?: boolean;
 }
 export interface ReaderUI {
     settings: UserSettingsUIConfig;
@@ -108,8 +111,10 @@ export interface ReaderConfig {
     define?: DefinitionsModuleConfig;
     protection?: ContentProtectionModuleConfig;
     mediaOverlays?: MediaOverlayModuleConfig;
+    pagebreak?: PageBreakModuleConfig;
     annotations?: AnnotationModuleConfig;
     bookmarks?: BookmarkModuleConfig;
+    lineFocus?: LineFocusModuleConfig;
     highlighter?: TextHighlighterConfig;
     injectables: Array<Injectable>;
     injectablesFixed: Array<Injectable>;
@@ -135,6 +140,7 @@ export default class IFrameNavigator implements Navigator {
     timelineModule?: TimelineModule;
     pageBreakModule?: PageBreakModule;
     mediaOverlayModule?: MediaOverlayModule;
+    lineFocusModule?: LineFocusModule;
     sideNavExpanded: boolean;
     material: boolean;
     mTabs: Array<any>;
@@ -280,4 +286,6 @@ export default class IFrameNavigator implements Navigator {
     private static createJavascriptLink;
     activateMarker(id: any, position: any): void;
     deactivateMarker(): void;
+    showLayer(layer: any): void;
+    hideLayer(layer: any): void;
 }