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

package/NOTICE

@@ -0,0 +1,20 @@
+R2D2BC
+Copyright 2018-2020 DITA (AM Consulting LLC)
+
+This project bundles the following dependencies under the MIT license.
+See bundled license files for details.
+
+- Materialize | Copyright (c) 2014-2018 Materialize
+	-> in "styles/sass/materialize"
+
+This project bundles the following dependencies under the SIL Open Font License.
+See bundled license files for details.
+
+- OpenDyxslexic Font | Copyright (c) 12/2012 - 2019
+    -> in "viewer/fonts/opendyslexic"
+
+This project bundles the following dependencies under the BSD license.
+See bundled license files for details.
+
+- Readium-CSS | Copyright (c) 2017, Readium
+    -> in "viewer/readium-css"

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/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;
@@ -46,7 +46,7 @@ export default class DefinitionsModule implements ReaderModule {
     define(item: Definition): Promise<void>;
     drawDefinitions(): 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;