@d-i-t-a/reader 1.11.0-beta.7 → 1.12.0-alpha.3

package/dist/index.d.ts

@@ -32,6 +32,7 @@ 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 currentSettings(): Promise<{
     appearance: string;
     fontFamily: string;
@@ -66,6 +67,8 @@ 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 lineUp(): void;
+export declare function lineDown(): void;
 export declare function hideLayer(layer: any): void;
 export declare function showLayer(layer: any): void;
 export declare function clearDefinitions(): Promise<void>;
@@ -73,4 +76,7 @@ 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 enableLineFocus(): Promise<void>;
+export declare function lineFocus(active: boolean): Promise<void>;
+export declare function disableLineFocus(): void;
 export declare function load(config: ReaderConfig): Promise<any>;

package/dist/modules/AnnotationModule.d.ts

@@ -57,10 +57,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): Promise<Annotation>;
+    saveAnnotation(highlight: IHighlight, iframehref: any): Promise<Annotation>;
     getAnnotations(): Promise<any>;
     showHighlights(): Promise<void>;
-    drawHighlights(): Promise<void>;
+    drawHighlights(iframeIndex: any, iframehref: string): Promise<void>;
     private createTree;
     private handleAnnotationLinkClick;
     private handleAnnotationLinkDeleteClick;

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

@@ -8,6 +8,7 @@ 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 ID_LINEFOCUS_CONTAINER = "R2_ID_LINEFOCUS_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";
@@ -46,8 +47,7 @@ export interface TextHighlighterConfig extends TextHighlighterProperties {
 }
 export default class TextHighlighter {
     private options;
-    private delegate;
-    private lastSelectedHighlight;
+    private readonly delegate;
     properties: TextHighlighterProperties;
     private api;
     private hasEventListener;
@@ -102,22 +102,6 @@ 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
@@ -128,8 +112,8 @@ export default class TextHighlighter {
         preventDefault: () => void;
         stopPropagation: () => void;
     }): boolean;
-    bindEvents(el: any, _scope: any, hasEventListener: boolean): void;
-    unbindEvents(el: any, _scope: any): void;
+    bindEvents(iframeIndex: number, hasEventListener: boolean): void;
+    unbindEvents(iframeIndex: number): void;
     /**
      * Permanently disables highlighting.
      * Unbinds events and remove context element class.
@@ -139,9 +123,9 @@ export default class TextHighlighter {
     initializeToolbox(): void;
     toolboxMode(mode: "colors" | "edit" | "add" | "action"): void;
     toolboxHide(): void;
-    toolboxShowDelayed(): void;
-    snapSelectionToWord(): any;
-    toolboxShow(): void;
+    toolboxShowDelayed(iframeIndex: number): void;
+    snapSelectionToWord(iframeIndex: number): any;
+    toolboxShow(iframeIndex: number): void;
     isSelectionMenuOpen: boolean;
     selectionMenuOpened: (() => void) & {
         clear(): void;
@@ -152,21 +136,21 @@ export default class TextHighlighter {
     selection: ((text: any, selection: any) => void) & {
         clear(): void;
     };
-    toolboxPlacement(): void;
-    toolboxHandler(): void;
+    toolboxPlacement(iframeIndex: number): void;
+    toolboxHandler(iframeIndex: number): void;
     /**
      * Highlights current range.
      * @param {boolean} keepRange - Don't remove range after highlighting. Default: false.
      * @param marker
      * @memberof TextHighlighter
      */
-    doHighlight(keepRange?: boolean, marker?: AnnotationMarker): void;
-    speak(): void;
-    stopReadAloud(): void;
-    speakAll(): void;
-    callbackComplete(): void;
-    get visibleTextRects(): HTMLElementRect[];
-    doneSpeaking(reload?: boolean): void;
+    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;
     /**
      * Normalizes highlights. Ensures that highlighting is done with use of the smallest possible number of
      * wrapping HTML elements.
@@ -177,13 +161,6 @@ 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.
@@ -229,20 +206,20 @@ export default class TextHighlighter {
     };
     static hexToRgbA(hex: string): string;
     static hexToRgbAWithOpacity(hex: string, opacity: number): string;
-    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;
+    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;
     isIOS(): boolean;
     isAndroid(): boolean;
-    getScrollingElement: (documant: Document) => Element;
-    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;
-    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;
+    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;
 }
 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
+    Popup = 4,
+    Lines = 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/navigator/IFrameNavigator.d.ts

@@ -16,6 +16,7 @@ import ReaderModule from "../modules/ReaderModule";
 import { TTSModuleConfig } from "../modules/TTS/TTSSettings";
 import PageBreakModule 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 {
@@ -85,6 +86,7 @@ export interface ReaderRights {
     enableTTS?: boolean;
     enableSearch?: boolean;
     enableDefinitions?: boolean;
+    enableLineFocus?: boolean;
     enableContentProtection?: boolean;
     enableMaterial?: boolean;
     enableTimeline?: boolean;
@@ -106,6 +108,7 @@ export interface ReaderConfig {
     tts?: TTSModuleConfig;
     search?: SearchModuleConfig;
     define?: DefinitionsModuleConfig;
+    lineFocus?: LineFocusModuleConfig;
     protection?: ContentProtectionModuleConfig;
     mediaOverlays?: MediaOverlayModuleConfig;
     annotations?: AnnotationModuleConfig;
@@ -130,6 +133,7 @@ export default class IFrameNavigator implements Navigator {
     ttsModule?: ReaderModule;
     searchModule?: SearchModule;
     definitionsModule?: DefinitionsModule;
+    lineFocusModule?: LineFocusModule;
     contentProtectionModule?: ContentProtectionModule;
     highlighter?: TextHighlighter;
     timelineModule?: TimelineModule;