@d-i-t-a/reader 1.10.0 → 1.11.0-beta.5

package/dist/index.d.ts

@@ -1,12 +1,19 @@
 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;
+/**
+ * Read Along
+ */
+export declare function startReadAlong(): void;
+export declare function stopReadAlong(): void;
+export declare function pauseReadAlong(): void;
+export declare function resumeReadAlong(): void;
 export declare function startReadAloud(): void;
 export declare function stopReadAloud(): void;
 export declare function pauseReadAloud(): void;
 export declare function resumeReadAloud(): void;
+export declare function saveBookmarkPlus(): void;
 export declare function saveBookmark(): Promise<any>;
 export declare function deleteBookmark(bookmark: any): Promise<any>;
 export declare function deleteAnnotation(highlight: any): Promise<any>;
@@ -57,5 +64,9 @@ export declare function currentLocator(): Locator;
 export declare function positions(): any;
 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 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/injectables/footnotes/footnotes.js.LICENSE.txt

@@ -0,0 +1,6 @@
+/*!
+ * is-plain-object <https://github.com/jonschlinkert/is-plain-object>
+ *
+ * Copyright (c) 2014-2017, Jon Schlinkert.
+ * Released under the MIT License.
+ */

package/dist/model/Locator.d.ts

@@ -29,29 +29,14 @@ export interface Bookmark extends Locator {
 }
 export declare enum AnnotationMarker {
     Highlight = 0,
-    Underline = 1
+    Underline = 1,
+    Bookmark = 2,
+    Custom = 3
 }
 export interface Annotation extends Locator {
     id?: any;
     created: Date;
     highlight?: IHighlight;
-    marker: AnnotationMarker;
-    color: string;
-}
-export interface ISelectionInfo {
-    rangeInfo: IRangeInfo;
-    cleanText: string;
-    rawText: string;
-    color: string;
-    range: Range;
-}
-export interface IRangeInfo {
-    startContainerElementCssSelector: string;
-    startContainerChildTextNodeIndex: number;
-    startOffset: number;
-    endContainerElementCssSelector: string;
-    endContainerChildTextNodeIndex: number;
-    endOffset: number;
 }
 export interface ChapterWeight {
     chapterHref: string;

package/dist/modules/AnnotationModule.d.ts

@@ -4,11 +4,12 @@ import { Publication } from "../model/Publication";
 import TextHighlighter from "./highlight/TextHighlighter";
 import ReaderModule from "./ReaderModule";
 import { IHighlight } from "./highlight/common/highlight";
-import { Annotation, AnnotationMarker } from "../model/Locator";
+import { Annotation } from "../model/Locator";
 export declare type Highlight = (highlight: Annotation) => Promise<Annotation>;
 export interface AnnotationModuleAPI {
     addAnnotation: Highlight;
     deleteAnnotation: Highlight;
+    updateAnnotation: Highlight;
     selectedAnnotation: Highlight;
 }
 export interface AnnotationModuleProperties {
@@ -25,7 +26,7 @@ export interface AnnotationModuleConfig extends AnnotationModuleProperties {
     highlighter: TextHighlighter;
 }
 export default class AnnotationModule implements ReaderModule {
-    private readonly annotator;
+    readonly annotator: Annotator | null;
     private rights;
     private publication;
     private highlightsView;
@@ -35,25 +36,35 @@ 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>;
     protected start(): Promise<void>;
-    handleResize(): void;
+    private hide;
+    private show;
+    hideAnnotationLayer(): void;
+    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>;
     deleteAnnotation(highlight: Annotation): Promise<any>;
     addAnnotation(highlight: Annotation): Promise<any>;
     deleteHighlight(highlight: Annotation): Promise<any>;
     deleteSelectedHighlight(highlight: Annotation): Promise<any>;
-    saveAnnotation(highlight: IHighlight, marker: AnnotationMarker): Promise<any>;
+    updateAnnotation(highlight: Annotation): Promise<any>;
+    saveAnnotation(highlight: IHighlight): Promise<Annotation>;
     getAnnotations(): Promise<any>;
     showHighlights(): Promise<void>;
-    drawHighlights(search?: boolean): Promise<void>;
+    drawHighlights(): Promise<void>;
     private createTree;
     private handleAnnotationLinkClick;
     private handleAnnotationLinkDeleteClick;
     private static readableTimestamp;
     getAnnotation(highlight: IHighlight): Promise<any>;
+    getAnnotationByID(id: string): Promise<any>;
 }

package/dist/modules/BookmarkModule.d.ts

@@ -2,7 +2,8 @@ import Annotator from "../store/Annotator";
 import IFrameNavigator, { ReaderRights } from "../navigator/IFrameNavigator";
 import { Publication } from "../model/Publication";
 import ReaderModule from "./ReaderModule";
-import { Bookmark } from "../model/Locator";
+import { Annotation, Bookmark } from "../model/Locator";
+import { IHighlight } from "./highlight/common/highlight";
 export interface BookmarkModuleAPI {
     addBookmark: (bookmark: Bookmark) => Promise<Bookmark>;
     deleteBookmark: (bookmark: Bookmark) => Promise<Bookmark>;
@@ -35,12 +36,22 @@ export default class BookmarkModule implements ReaderModule {
     constructor(annotator: Annotator, headerMenu: HTMLElement, rights: ReaderRights, publication: Publication, delegate: IFrameNavigator, initialAnnotations?: any | null, properties?: BookmarkModuleProperties | null, api?: BookmarkModuleAPI | null);
     stop(): Promise<void>;
     protected start(): Promise<void>;
+    handleResize(): Promise<void>;
+    initialize(): Promise<unknown>;
     deleteBookmark(bookmark: Bookmark): Promise<any>;
+    saveBookmarkPlus(): void;
     saveBookmark(): Promise<any>;
+    private addBookmarkPlus;
+    saveAnnotation(highlight: IHighlight): Promise<Annotation>;
     getBookmarks(): Promise<any>;
     showBookmarks(): Promise<void>;
+    drawBookmarks(): Promise<void>;
+    deleteSelectedHighlight(highlight: Annotation): Promise<any>;
+    deleteLocalHighlight(id: any): Promise<any>;
     private createTree;
     private handleAnnotationLinkClick;
     private handleAnnotationLinkDeleteClick;
     private static readableTimestamp;
+    getAnnotation(highlight: IHighlight): Promise<any>;
+    getAnnotationByID(id: string): Promise<any>;
 }

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

@@ -1,33 +1,8 @@
 import ReaderModule from "../ReaderModule";
-import { ISelectionInfo } from "../../model/Locator";
-import { TTSSettings, TTSVoice } from "./TTSSettings";
+import { TTSModuleAPI, TTSModuleConfig, TTSModuleProperties, TTSSettings } from "./TTSSettings";
 import IFrameNavigator, { ReaderRights } from "../../navigator/IFrameNavigator";
 import TextHighlighter from "../highlight/TextHighlighter";
-export interface TTSModuleAPI {
-    started: any;
-    stopped: any;
-    paused: any;
-    resumed: any;
-    finished: any;
-    updateSettings: any;
-}
-export interface TTSModuleProperties {
-    enableSplitter?: boolean;
-    color?: string;
-    autoScroll?: boolean;
-    rate?: number;
-    pitch?: number;
-    volume?: number;
-    voice?: TTSVoice;
-}
-export interface TTSModuleConfig extends TTSModuleProperties {
-    delegate: IFrameNavigator;
-    headerMenu: HTMLElement;
-    rights: ReaderRights;
-    tts: TTSSettings;
-    highlighter: TextHighlighter;
-    api: TTSModuleAPI;
-}
+import { ISelectionInfo } from "../highlight/common/selection";
 export default class TTSModule implements ReaderModule {
     private tts;
     private splittingResult;

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

@@ -0,0 +1,73 @@
+import ReaderModule from "../ReaderModule";
+import { TTSModuleAPI, TTSModuleConfig, TTSModuleProperties, TTSSettings } from "./TTSSettings";
+import IFrameNavigator, { ReaderRights } from "../../navigator/IFrameNavigator";
+import TextHighlighter from "../highlight/TextHighlighter";
+import { IHighlight } from "../highlight/common/highlight";
+import { ISelectionInfo } from "../highlight/common/selection";
+export default class TTSModule2 implements ReaderModule {
+    private tts;
+    private voices;
+    private clean;
+    private rights;
+    private readonly highlighter;
+    private delegate;
+    private body;
+    private hasEventListener;
+    private readonly headerMenu;
+    private readonly properties;
+    private readonly api;
+    initialize(body: any): void;
+    private click;
+    private initVoices;
+    cancel(): void;
+    index: number;
+    speak(selectionInfo: ISelectionInfo | undefined, partial: boolean, callback: () => void): Promise<any>;
+    speakPlay(): void;
+    speakPause(): void;
+    speakResume(): void;
+    static create(config: TTSModuleConfig): Promise<TTSModule2>;
+    constructor(delegate: IFrameNavigator, tts: TTSSettings, headerMenu: HTMLElement, rights: ReaderRights, highlighter: TextHighlighter, properties?: TTSModuleProperties | null, api?: TTSModuleAPI | null);
+    protected start(): Promise<void>;
+    userScrolled: boolean;
+    private wheel;
+    stop(): Promise<void>;
+    generateTtsQueue(rootElement: Element, splitSentences: boolean): ITtsQueueItem[];
+    findTtsQueueItemIndex(ttsQueue: ITtsQueueItem[], element: Element, startTextNode: Node | undefined, startTextNodeOffset: number, rootElem: Element): number;
+    speaking: boolean;
+    restartIndex: number;
+    private restart;
+    startTTSSession(ttsQueue: ITtsQueueItem[], ttsQueueIndexStart: number): void;
+    ttsPlayQueueIndex(ttsQueueIndex: number, ttsQueue: any): void;
+    ttsQueueIndex: number;
+    ttsQueue: any;
+    ttsPlayQueueIndexDebounced: ((ttsQueueIndex: number, ttsQueue: any) => void) & {
+        clear(): void;
+    };
+    updateTTSInfo(ttsQueueItem: any, charIndex: number, charLength: number, utteranceText: string | undefined): string | undefined;
+    _ttsQueueItemHighlightsWord: IHighlight | undefined;
+    wrapHighlightWord(ttsQueueItemRef: ITtsQueueItemReference, utteranceText: string, charIndex: number, charLength: number, word: string, start: number, end: number): void;
+}
+export interface ITtsQueueItem {
+    dir: string | undefined;
+    lang: string | undefined;
+    parentElement: Element;
+    textNodes: Node[];
+    combinedText: string;
+    combinedTextSentences: string[] | undefined;
+    combinedTextSentencesRangeBegin: number[] | undefined;
+    combinedTextSentencesRangeEnd: number[] | undefined;
+}
+export interface ITtsQueueItemReference {
+    item: ITtsQueueItem;
+    iArray: number;
+    iSentence: number;
+    iGlobal: number;
+}
+export declare function getLanguage(el: Element): string | undefined;
+export declare function getDirection(el: Element): string | undefined;
+export declare function combineTextNodes(textNodes: Node[], skipNormalize?: boolean): string;
+export declare function normalizeHtmlText(str: string): string;
+export declare function normalizeText(str: string): string;
+export declare function getTtsQueueItemRef(items: ITtsQueueItem[], index: number): ITtsQueueItemReference | undefined;
+export declare function getTtsQueueLength(items: ITtsQueueItem[]): number;
+export declare function getTtsQueueItemRefText(obj: ITtsQueueItemReference): string;

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

@@ -1,6 +1,32 @@
 import Store from "../../store/Store";
 import { UserProperty, UserProperties } from "../../model/user-settings/UserProperties";
-import { TTSModuleAPI, TTSModuleProperties } from "./TTSModule";
+import IFrameNavigator, { ReaderRights } from "../../navigator/IFrameNavigator";
+import TextHighlighter from "../highlight/TextHighlighter";
+export interface TTSModuleAPI {
+    started: any;
+    stopped: any;
+    paused: any;
+    resumed: any;
+    finished: any;
+    updateSettings: any;
+}
+export interface TTSModuleProperties {
+    enableSplitter?: boolean;
+    color?: string;
+    autoScroll?: boolean;
+    rate?: number;
+    pitch?: number;
+    volume?: number;
+    voice?: TTSVoice;
+}
+export interface TTSModuleConfig extends TTSModuleProperties {
+    delegate: IFrameNavigator;
+    headerMenu: HTMLElement;
+    rights: ReaderRights;
+    tts: TTSSettings;
+    highlighter: TextHighlighter;
+    api: TTSModuleAPI;
+}
 export declare class TTSREFS {
     static readonly COLOR_REF = "color";
     static readonly AUTO_SCROLL_REF = "autoscroll";
@@ -45,10 +71,8 @@ export declare class TTSSettings implements ITTSUserSettings {
     volume: number;
     voice: TTSVoice;
     userProperties: UserProperties;
-    private rateButtons;
-    private pitchButtons;
-    private volumeButtons;
     private settingsChangeCallback;
+    private restartCallback;
     private settingsView;
     private readonly headerMenu;
     private speechRate;
@@ -66,7 +90,7 @@ export declare class TTSSettings implements ITTSUserSettings {
     setControls(): void;
     private renderControls;
     onSettingsChange(callback: () => void): void;
-    private setupEvents;
+    onRestart(callback: () => void): void;
     private storeProperty;
     private updateUserSettings;
     private getTTSSettings;

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,16 +1,26 @@
-import { IColor, IHighlight } from "./common/highlight";
+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, { SelectionMenuItem } from "../../navigator/IFrameNavigator";
+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 {
@@ -19,6 +29,14 @@ interface IWithRect {
 }
 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>;
 }
@@ -30,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>;
@@ -118,7 +137,7 @@ export default class TextHighlighter {
      */
     destroy(): void;
     initializeToolbox(): void;
-    toolboxMode(mode: "colors" | "edit" | "add"): void;
+    toolboxMode(mode: "colors" | "edit" | "add" | "action"): void;
     toolboxHide(): void;
     toolboxShowDelayed(): void;
     snapSelectionToWord(): any;
@@ -130,6 +149,9 @@ export default class TextHighlighter {
     selectionMenuClosed: (() => void) & {
         clear(): void;
     };
+    selection: ((text: any, selection: any) => void) & {
+        clear(): void;
+    };
     toolboxPlacement(): void;
     toolboxHandler(): void;
     /**
@@ -143,6 +165,7 @@ export default class TextHighlighter {
     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
@@ -180,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.
@@ -202,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
@@ -234,25 +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): 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): 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;
-    createHighlight(win: IReadiumIFrameWindow, selectionInfo: ISelectionInfo, color: IColor | undefined, pointerInteraction: boolean, marker: AnnotationMarker): IHighlight;
-    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 {};