@d-i-t-a/reader 1.11.0-beta.8 → 1.11.1

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;

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,19 @@ 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"
+}
 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 +47,12 @@ export interface TextHighlighterProperties {
 export interface TextHighlighterConfig extends TextHighlighterProperties {
     delegate: IFrameNavigator;
     api: TextSelectorAPI;
+    layerSettings: LayerSettings;
 }
 export default class TextHighlighter {
     private options;
-    private delegate;
+    private readonly delegate;
+    layerSettings: LayerSettings;
     private lastSelectedHighlight;
     properties: TextHighlighterProperties;
     private api;
@@ -230,18 +236,19 @@ 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;
+    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;
+    getScrollingElement: (doc: Document) => Element;
     processMouseEvent(win: any, ev: MouseEvent): Promise<void>;
-    ensureHighlightsContainer(win: any, id: string): HTMLElement;
-    hideAllhighlights(_documant: Document): void;
-    destroyAllhighlights(documant: Document): 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(documant: Document, id: string): 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;
 }

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

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

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

@@ -1,35 +0,0 @@
-export declare const ROOT_CLASS_REDUCE_MOTION = "r2-reduce-motion";
-export declare const ROOT_CLASS_NO_FOOTNOTES = "r2-no-popup-foonotes";
-export declare const POPUP_DIALOG_CLASS = "r2-popup-dialog";
-export declare const FOOTNOTES_CONTAINER_CLASS = "r2-footnote-container";
-export declare const FOOTNOTES_CLOSE_BUTTON_CLASS = "r2-footnote-close";
-export declare const FOOTNOTE_FORCE_SHOW = "r2-footnote-force-show";
-export declare const footnotesCssStyles: string;
-export declare const TTS_ID_PREVIOUS = "r2-tts-previous";
-export declare const TTS_ID_NEXT = "r2-tts-next";
-export declare const TTS_ID_SLIDER = "r2-tts-slider";
-export declare const TTS_ID_ACTIVE_WORD = "r2-tts-active-word";
-export declare const TTS_ID_ACTIVE_UTTERANCE = "r2-tts-active-utterance";
-export declare const TTS_CLASS_UTTERANCE = "r2-tts-utterance";
-export declare const TTS_ID_CONTAINER = "r2-tts-txt";
-export declare const TTS_ID_INFO = "r2-tts-info";
-export declare const TTS_NAV_BUTTON_CLASS = "r2-tts-button";
-export declare const TTS_ID_SPEAKING_DOC_ELEMENT = "r2-tts-speaking-el";
-export declare const TTS_CLASS_INJECTED_SPAN = "r2-tts-speaking-txt";
-export declare const TTS_CLASS_INJECTED_SUBSPAN = "r2-tts-speaking-word";
-export declare const TTS_ID_INJECTED_PARENT = "r2-tts-speaking-txt-parent";
-export declare const TTS_POPUP_DIALOG_CLASS = "r2-tts-popup-dialog";
-export declare const ttsCssStyles: string;
-export declare const ROOT_CLASS_INVISIBLE_MASK = "r2-visibility-mask";
-export declare const visibilityMaskCssStyles: string;
-export declare const ROOT_CLASS_KEYBOARD_INTERACT = "r2-keyboard-interact";
-export declare const CSS_CLASS_NO_FOCUS_OUTLINE = "r2-no-focus-outline";
-export declare const focusCssStyles: string;
-export declare const targetCssStyles = "\n@keyframes readium2ElectronAnimation_TARGET {\n    0% {\n    }\n    100% {\n        outline: inherit;\n    }\n}\n:root[style] *:target,\n:root *:target {\n    outline-color: green !important;\n    outline-style: solid !important;\n    outline-width: 2px !important;\n    outline-offset: 2px !important;\n\n    animation-name: readium2ElectronAnimation_TARGET;\n    animation-duration: 3s;\n    animation-delay: 1s;\n    animation-fill-mode: forwards;\n    animation-timing-function: linear;\n}\n:root[style] *.r2-no-target-outline:target,\n:root *.r2-no-target-outline:target {\n    outline: inherit !important;\n}\n";
-export declare const selectionCssStyles = "\n:root[style] ::selection,\n:root ::selection {\nbackground: rgb(155, 179, 240) !important;\ncolor: black !important;\n}\n\n:root[style*=\"readium-night-on\"] ::selection {\nbackground: rgb(100, 122, 177) !important;\ncolor: white !important;\n}\n";
-export declare const scrollBarCssStyles = "\n::-webkit-scrollbar-button {\nheight: 0px !important;\nwidth: 0px !important;\n}\n\n::-webkit-scrollbar-corner {\nbackground: transparent !important;\n}\n\n/*::-webkit-scrollbar-track-piece {\nbackground: red;\n} */\n\n::-webkit-scrollbar {\nwidth:  14px;\nheight: 14px;\n}\n\n::-webkit-scrollbar-thumb {\nbackground: #727272;\nbackground-clip: padding-box !important;\nborder: 3px solid transparent !important;\nborder-radius: 30px;\n}\n\n::-webkit-scrollbar-thumb:hover {\nbackground: #4d4d4d;\n}\n\n::-webkit-scrollbar-track {\nbox-shadow: inset 0 0 3px rgba(40, 40, 40, 0.2);\nbackground: #dddddd;\nbox-sizing: content-box;\n}\n\n::-webkit-scrollbar-track:horizontal {\nborder-top: 1px solid silver;\n}\n::-webkit-scrollbar-track:vertical {\nborder-left: 1px solid silver;\n}\n\n:root[style*=\"readium-night-on\"] ::-webkit-scrollbar-thumb {\nbackground: #a4a4a4;\nborder: 3px solid #545454;\n}\n\n:root[style*=\"readium-night-on\"] ::-webkit-scrollbar-thumb:hover {\nbackground: #dedede;\n}\n\n:root[style*=\"readium-night-on\"] ::-webkit-scrollbar-track {\nbackground: #545454;\n}\n\n:root[style*=\"readium-night-on\"] ::-webkit-scrollbar-track:horizontal {\nborder-top: 1px solid black;\n}\n:root[style*=\"readium-night-on\"] ::-webkit-scrollbar-track:vertical {\nborder-left: 1px solid black;\n}";
-export declare const readPosCssStylesAttr1 = "data-readium2-read-pos1";
-export declare const readPosCssStylesAttr2 = "data-readium2-read-pos2";
-export declare const readPosCssStylesAttr3 = "data-readium2-read-pos3";
-export declare const readPosCssStylesAttr4 = "data-readium2-read-pos4";
-export declare const readPosCssStyles: string;

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

@@ -19,7 +19,7 @@ export interface DefinitionsModuleProperties {
     definitions: Definition[];
     color?: string;
     fullWordSearch?: boolean;
-    api?: DefinitionsModuleAPI;
+    hideLayer?: boolean;
 }
 export interface DefinitionsModuleConfig extends DefinitionsModuleProperties {
     api: DefinitionsModuleAPI;
@@ -44,9 +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/navigator/IFrameNavigator.d.ts

@@ -14,7 +14,7 @@ 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";
 export declare type GetContent = (href: string) => Promise<string>;
 export declare type GetContentBytesLength = (href: string) => Promise<number>;
@@ -90,6 +90,7 @@ export interface ReaderRights {
     enableTimeline?: boolean;
     autoGeneratePositions?: boolean;
     enableMediaOverlays?: boolean;
+    enablePageBreaks?: boolean;
 }
 export interface ReaderUI {
     settings: UserSettingsUIConfig;
@@ -108,6 +109,7 @@ export interface ReaderConfig {
     define?: DefinitionsModuleConfig;
     protection?: ContentProtectionModuleConfig;
     mediaOverlays?: MediaOverlayModuleConfig;
+    pagebreak?: PageBreakModuleConfig;
     annotations?: AnnotationModuleConfig;
     bookmarks?: BookmarkModuleConfig;
     highlighter?: TextHighlighterConfig;