@d-i-t-a/reader 2.2.2 → 2.3.0

package/dist/types/modules/AnnotationModule.d.ts

@@ -23,7 +23,6 @@ export interface AnnotationModuleConfig extends AnnotationModuleProperties {
     headerMenu?: HTMLElement | null;
     rights: Partial<ReaderRights>;
     publication: Publication;
-    delegate: IFrameNavigator;
     initialAnnotations?: any;
     api?: AnnotationModuleAPI;
     highlighter: TextHighlighter;
@@ -37,13 +36,13 @@ export declare class AnnotationModule implements ReaderModule {
     private readonly headerMenu?;
     private readonly highlighter?;
     private readonly initialAnnotations;
-    private delegate;
+    navigator: IFrameNavigator;
     properties?: AnnotationModuleProperties;
     api?: AnnotationModuleAPI;
     activeAnnotationMarkerId?: string;
     activeAnnotationMarkerPosition?: string;
     static create(config: AnnotationModuleConfig): Promise<AnnotationModule>;
-    constructor(annotator: Annotator, rights: Partial<ReaderRights>, publication: Publication, delegate: IFrameNavigator, initialAnnotations: any, properties: AnnotationModuleProperties, highlighter: TextHighlighter, api?: AnnotationModuleAPI, headerMenu?: HTMLElement | null);
+    constructor(annotator: Annotator, rights: Partial<ReaderRights>, publication: Publication, initialAnnotations: any, properties: AnnotationModuleProperties, highlighter: TextHighlighter, api?: AnnotationModuleAPI, headerMenu?: HTMLElement | null);
     stop(): Promise<void>;
     protected start(): Promise<void>;
     private hide;

package/dist/types/modules/BookmarkModule.d.ts

@@ -16,7 +16,6 @@ export interface BookmarkModuleConfig extends BookmarkModuleProperties {
     headerMenu?: HTMLElement | null;
     rights: Partial<ReaderRights>;
     publication: Publication;
-    delegate: IFrameNavigator;
     initialAnnotations?: any;
     properties?: BookmarkModuleProperties;
     api?: BookmarkModuleAPI;
@@ -29,11 +28,11 @@ export declare class BookmarkModule implements ReaderModule {
     private sideNavSectionBookmarks;
     private readonly headerMenu?;
     private readonly initialAnnotations;
-    private delegate;
+    navigator: IFrameNavigator;
     private readonly properties;
     private readonly api?;
     static create(config: BookmarkModuleConfig): Promise<any>;
-    constructor(annotator: Annotator, rights: Partial<ReaderRights>, publication: Publication, delegate: IFrameNavigator, properties: BookmarkModuleProperties, initialAnnotations?: any, api?: BookmarkModuleAPI, headerMenu?: HTMLElement | null);
+    constructor(annotator: Annotator, rights: Partial<ReaderRights>, publication: Publication, properties: BookmarkModuleProperties, initialAnnotations?: any, api?: BookmarkModuleAPI, headerMenu?: HTMLElement | null);
     stop(): void;
     protected start(): Promise<void>;
     handleResize(): Promise<void>;

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

@@ -10,7 +10,7 @@ export declare class TTSModule2 implements ReaderModule {
     private clean;
     private rights;
     private readonly highlighter;
-    private delegate;
+    navigator: IFrameNavigator;
     private body;
     private hasEventListener;
     private readonly headerMenu?;
@@ -30,7 +30,7 @@ export declare class TTSModule2 implements ReaderModule {
     speakPause(): void;
     speakResume(): void;
     static create(config: TTSModuleConfig): Promise<TTSModule2>;
-    constructor(delegate: IFrameNavigator, tts: TTSSettings, rights: Partial<ReaderRights>, highlighter: TextHighlighter, properties: TTSModuleProperties, api?: TTSModuleAPI, headerMenu?: HTMLElement | null);
+    constructor(tts: TTSSettings, rights: Partial<ReaderRights>, highlighter: TextHighlighter, properties: TTSModuleProperties, api?: TTSModuleAPI, headerMenu?: HTMLElement | null);
     protected start(): Promise<void>;
     userScrolled: boolean;
     scrollPartial: boolean;

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

@@ -1,6 +1,6 @@
 import Store from "../../store/Store";
 import { UserProperty, UserProperties } from "../../model/user-settings/UserProperties";
-import { IFrameNavigator, ReaderRights } from "../../navigator/IFrameNavigator";
+import { ReaderRights } from "../../navigator/IFrameNavigator";
 import { TextHighlighter } from "../highlight/TextHighlighter";
 export interface TTSModuleAPI {
     started: any;
@@ -20,7 +20,6 @@ export interface TTSModuleProperties {
     hideLayer?: boolean;
 }
 export interface TTSModuleConfig extends TTSModuleProperties {
-    delegate: IFrameNavigator;
     rights: Partial<ReaderRights>;
     tts: TTSSettings;
     highlighter: TextHighlighter;

package/dist/types/modules/citation/CitationModule.d.ts

@@ -30,13 +30,12 @@ export interface CitationModuleAPI {
 }
 export interface CitationModuleConfig extends CitationModuleProperties {
     publication: Publication;
-    delegate: IFrameNavigator;
     highlighter: TextHighlighter;
     api?: CitationModuleAPI;
 }
 export default class CitationModule implements ReaderModule {
     private publication;
-    private delegate;
+    navigator: IFrameNavigator;
     private properties;
     private readonly highlighter?;
     api?: CitationModuleAPI;

package/dist/types/modules/consumption/ConsumptionModule.d.ts

@@ -20,20 +20,25 @@ export interface ConsumptionModuleProperties {
     idleTimeout?: number;
     responseTimeout?: number;
 }
+export interface ReadingSession {
+    time: any;
+    firstLocator: Locator;
+    lastLocator: Locator;
+    progress: any;
+}
 export interface ConsumptionModuleConfig extends ConsumptionModuleProperties {
     publication: Publication;
-    delegate: IFrameNavigator;
     properties?: ConsumptionModuleProperties;
     api?: ConsumptionModuleAPI;
 }
 export declare class ConsumptionModule implements ReaderModule {
-    private delegate;
+    navigator: IFrameNavigator;
     private publication;
     private properties;
     api?: ConsumptionModuleAPI;
     startResearchTimer?: Date;
     researchSessionId: any;
-    readingSessions: any[];
+    readingSessions: ReadingSession[];
     readingSessionsInterval: any;
     startReadingTimer: Date;
     firstReadingLocator: Locator;

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

@@ -48,13 +48,12 @@ export interface TextHighlighterProperties {
     selectionMenuItems?: Array<SelectionMenuItem>;
 }
 export interface TextHighlighterConfig extends TextHighlighterProperties {
-    delegate: IFrameNavigator;
     api?: TextSelectorAPI;
     layerSettings: LayerSettings;
 }
 export declare class TextHighlighter {
     private options;
-    private readonly delegate;
+    navigator: IFrameNavigator;
     layerSettings: LayerSettings;
     private lastSelectedHighlight?;
     properties: TextHighlighterProperties;

package/dist/types/modules/history/HistoryModule.d.ts

@@ -8,13 +8,12 @@ export interface HistoryModuleProperties {
 }
 export interface HistoryModuleConfig extends HistoryModuleProperties {
     annotator: Annotator;
-    delegate: IFrameNavigator;
     headerMenu?: HTMLElement | null;
     publication: Publication;
 }
 export declare class HistoryModule implements ReaderModule {
     readonly annotator: Annotator | null;
-    private delegate;
+    navigator: IFrameNavigator;
     private readonly headerMenu?;
     private publication;
     private properties;

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

@@ -12,13 +12,12 @@ export interface LineFocusModuleProperties {
 export interface LineFocusModuleConfig extends LineFocusModuleProperties {
     api?: LineFocusModuleAPI;
     publication: Publication;
-    delegate: IFrameNavigator;
     highlighter: TextHighlighter;
 }
 export default class LineFocusModule implements ReaderModule {
     properties: LineFocusModuleProperties;
     api?: LineFocusModuleAPI;
-    private delegate;
+    navigator: IFrameNavigator;
     private highlighter;
     private hasEventListener;
     lines: Array<HTMLElement>;
@@ -33,6 +32,7 @@ export default class LineFocusModule implements ReaderModule {
     private constructor();
     stop(): Promise<void>;
     protected start(): Promise<void>;
+    initialize(): Promise<unknown>;
     private keydown;
     private keyup;
     handleResize(): void;

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

@@ -23,13 +23,12 @@ export interface MediaOverlayModuleProperties {
 }
 export interface MediaOverlayModuleConfig extends MediaOverlayModuleProperties {
     publication: Publication;
-    delegate: IFrameNavigator;
     settings: MediaOverlaySettings;
     api?: MediaOverlayModuleAPI;
 }
 export declare class MediaOverlayModule implements ReaderModule {
     private publication;
-    private delegate;
+    navigator: IFrameNavigator;
     private audioElement;
     settings: MediaOverlaySettings;
     private properties;

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

@@ -7,12 +7,11 @@ export interface PageBreakModuleProperties {
     hideLayer?: boolean;
 }
 export interface PageBreakModuleConfig extends PageBreakModuleProperties {
-    delegate: IFrameNavigator;
     headerMenu?: HTMLElement | null;
     publication: Publication;
 }
 export declare class PageBreakModule implements ReaderModule {
-    private delegate;
+    navigator: IFrameNavigator;
     private readonly headerMenu?;
     private publication;
     private properties;

package/dist/types/modules/positions/TimelineModule.d.ts

@@ -3,11 +3,10 @@ import { IFrameNavigator } from "../../navigator/IFrameNavigator";
 import { ReaderModule } from "../ReaderModule";
 export interface TimelineModuleConfig {
     publication: Publication;
-    delegate: IFrameNavigator;
 }
 export declare class TimelineModule implements ReaderModule {
     private publication;
-    private delegate;
+    navigator: IFrameNavigator;
     private timelineContainer;
     private positionSlider;
     static create(config: TimelineModuleConfig): Promise<TimelineModule>;

package/dist/types/modules/protection/ContentProtectionModule.d.ts

@@ -18,7 +18,6 @@ export interface ContentProtectionModuleProperties {
     supportedBrowsers: string[];
 }
 export interface ContentProtectionModuleConfig extends Partial<ContentProtectionModuleProperties> {
-    delegate: IFrameNavigator;
     api?: ContentProtectionModuleAPI;
 }
 export interface ContentProtectionModuleAPI {
@@ -36,7 +35,7 @@ interface ContentProtectionRect {
 }
 export declare class ContentProtectionModule implements ReaderModule {
     private rects;
-    private delegate;
+    navigator: IFrameNavigator;
     properties?: ContentProtectionModuleProperties;
     private hasEventListener;
     private isHacked;
@@ -46,7 +45,7 @@ export declare class ContentProtectionModule implements ReaderModule {
     citation: boolean;
     static setupPreloadProtection(config: Partial<ContentProtectionModuleConfig>): Promise<void>;
     static create(config: ContentProtectionModuleConfig): Promise<ContentProtectionModule>;
-    constructor(delegate: IFrameNavigator, properties?: ContentProtectionModuleProperties);
+    constructor(properties?: ContentProtectionModuleProperties);
     private static startInspectorProtection;
     private static isCurrentBrowserSupported;
     protected start(): Promise<void>;

package/dist/types/modules/sampleread/SampleReadEventHandler.d.ts

@@ -1,7 +1,7 @@
 import { IFrameNavigator } from "../../navigator/IFrameNavigator";
 export default class SampleReadEventHandler {
-    delegate: IFrameNavigator;
-    constructor(delegate: IFrameNavigator);
+    navigator: IFrameNavigator;
+    constructor(navigator: IFrameNavigator);
     enforceSampleRead: ((position: any) => void) & {
         clear(): void;
     };

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

@@ -24,14 +24,13 @@ export interface DefinitionsModuleProperties {
 export interface DefinitionsModuleConfig extends DefinitionsModuleProperties {
     api?: DefinitionsModuleAPI;
     publication: Publication;
-    delegate: IFrameNavigator;
     highlighter: TextHighlighter;
 }
 export declare class DefinitionsModule implements ReaderModule {
     properties: DefinitionsModuleProperties;
     api?: DefinitionsModuleAPI;
     private publication;
-    private delegate;
+    navigator: IFrameNavigator;
     private currentChapterPopupResult;
     private currentPopupHighlights;
     private highlighter;

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

@@ -15,7 +15,6 @@ export interface SearchModuleConfig extends SearchModuleProperties {
     api?: SearchModuleAPI;
     publication: Publication;
     headerMenu?: HTMLElement | null;
-    delegate: IFrameNavigator;
     highlighter: TextHighlighter;
 }
 export declare class SearchModule implements ReaderModule {
@@ -23,7 +22,7 @@ export declare class SearchModule implements ReaderModule {
     private api?;
     private publication;
     private readonly headerMenu?;
-    private delegate;
+    navigator: IFrameNavigator;
     private searchInput;
     private searchGo;
     private currentChapterSearchResult;

package/dist/types/navigator/IFrameNavigator.d.ts

@@ -60,6 +60,8 @@ export interface IFrameNavigatorConfig {
     services?: PublicationServices;
     sample?: SampleRead;
     requestConfig?: RequestConfig;
+    modules: ReaderModule[];
+    highlighter: TextHighlighter;
 }
 export interface PublicationServices {
     positions?: URL;
@@ -207,7 +209,7 @@ export declare class IFrameNavigator extends EventEmitter implements Navigator {
     requestConfig?: RequestConfig;
     private didInitKeyboardEventHandler;
     static create(config: IFrameNavigatorConfig): Promise<IFrameNavigator>;
-    protected constructor(settings: UserSettings, annotator: Annotator | undefined, initialLastReadingPosition: ReadingPosition | undefined, publication: Publication, api?: Partial<NavigatorAPI>, rights?: Partial<ReaderRights>, tts?: Partial<TTSModuleConfig>, injectables?: Array<Injectable>, attributes?: IFrameAttributes, services?: PublicationServices, sample?: SampleRead, requestConfig?: RequestConfig);
+    protected constructor(settings: UserSettings, annotator: Annotator | undefined, initialLastReadingPosition: ReadingPosition | undefined, publication: Publication, api?: Partial<NavigatorAPI>, rights?: Partial<ReaderRights>, tts?: Partial<TTSModuleConfig>, injectables?: Array<Injectable>, attributes?: IFrameAttributes, services?: PublicationServices, sample?: SampleRead, requestConfig?: RequestConfig, highlighter?: TextHighlighter, modules?: ReaderModule[]);
     stop(): void;
     spreads: HTMLDivElement;
     firstSpread: HTMLDivElement;

package/dist/types/views/BookView.d.ts

@@ -6,7 +6,7 @@ interface BookView {
     iframe: Element;
     sideMargin: number;
     height: number;
-    delegate: IFrameNavigator;
+    navigator: IFrameNavigator;
     attributes?: IFrameAttributes;
     setMode?(scroll: boolean): any;
     isScrollMode(): any;

package/dist/types/views/FixedBookView.d.ts

@@ -2,7 +2,7 @@ import { IFrameNavigator, IFrameAttributes } from "../navigator/IFrameNavigator"
 import BookView from "./BookView";
 export default class FixedBookView implements BookView {
     layout: string;
-    delegate: IFrameNavigator;
+    navigator: IFrameNavigator;
     name: string;
     label: string;
     iframe: HTMLIFrameElement;

package/dist/types/views/ReflowableBookView.d.ts

@@ -7,7 +7,7 @@ export default class ReflowableBookView implements BookView {
     private readonly USERSETTINGS;
     private readonly store;
     private scrollMode;
-    delegate: IFrameNavigator;
+    navigator: IFrameNavigator;
     constructor(store: Store);
     setMode(scroll: boolean): void;
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-i-t-a/reader",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "A viewer application for EPUB files.",
   "repository": "https://github.com/d-i-t-a/R2D2BC",
   "license": "Apache-2.0",