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

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

@@ -0,0 +1,56 @@
+import { ReaderModule } from "../ReaderModule";
+import { Publication } from "../../model/Publication";
+import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { Locator } from "../../model/Locator";
+export declare enum Action {
+    BookmarkCreated = "BookmarkCreated",
+    HighlightCreated = "HighlightCreated"
+}
+export interface ConsumptionModuleAPI {
+    startResearchSession: any;
+    updateResearchSession: any;
+    endResearchSession: any;
+    idleSince: any;
+    actionTracked: any;
+}
+export interface ConsumptionModuleProperties {
+    enableTrackingSession?: boolean;
+    updateSessionInterval?: number;
+    enableTrackingActions?: boolean;
+    idleTimeout?: number;
+    responseTimeout?: number;
+}
+export interface ConsumptionModuleConfig extends ConsumptionModuleProperties {
+    publication: Publication;
+    delegate: IFrameNavigator;
+    properties?: ConsumptionModuleProperties;
+    api?: ConsumptionModuleAPI;
+}
+export declare class ConsumptionModule implements ReaderModule {
+    private delegate;
+    private publication;
+    private properties;
+    api?: ConsumptionModuleAPI;
+    startResearchTimer?: Date;
+    researchSessionId: any;
+    readingSessions: any[];
+    readingSessionsInterval: any;
+    startReadingTimer: Date;
+    firstReadingLocator: Locator;
+    lastReadingLocator: Locator;
+    private constructor();
+    static create(config: ConsumptionModuleConfig): Promise<ConsumptionModule>;
+    protected start(): Promise<void>;
+    stop(): Promise<void>;
+    initialize(): void;
+    trackAction(locator: Locator, action: Action): void;
+    startReadingSession(locator: Locator): void;
+    continueReadingSession(locator: Locator): void;
+    startResearchSession(): void;
+    updateResearchSession(): void;
+    endResearchSession(): void;
+    timer: any;
+    currSeconds: number;
+    startIdleTimer(): void;
+    resetTimer(): void;
+}

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

@@ -20,6 +20,7 @@ import EventEmitter from "eventemitter3";
 import LineFocusModule, { LineFocusModuleConfig } from "../modules/linefocus/LineFocusModule";
 import { HistoryModule } from "../modules/history/HistoryModule";
 import CitationModule, { CitationModuleConfig } from "../modules/citation/CitationModule";
+import { ConsumptionModule, ConsumptionModuleConfig } from "../modules/consumption/ConsumptionModule";
 export declare type GetContent = (href: string) => Promise<string>;
 export declare type GetContentBytesLength = (href: string, requestConfig?: RequestConfig) => Promise<number>;
 export interface RequestConfig extends RequestInit {
@@ -96,6 +97,7 @@ export interface ReaderRights {
     customKeyboardEvents: boolean;
     enableHistory: boolean;
     enableCitations: boolean;
+    enableConsumption: boolean;
 }
 export interface ReaderUI {
     settings: UserSettingsUIConfig;
@@ -118,6 +120,7 @@ export interface ReaderConfig {
     bookmarks?: Partial<BookmarkModuleConfig>;
     lineFocus?: Partial<LineFocusModuleConfig>;
     citations?: Partial<CitationModuleConfig>;
+    consumption?: Partial<ConsumptionModuleConfig>;
     highlighter?: Partial<TextHighlighterConfig>;
     injectables: Array<Injectable>;
     injectablesFixed?: Array<Injectable>;
@@ -147,6 +150,7 @@ export declare class IFrameNavigator extends EventEmitter implements Navigator {
     lineFocusModule?: LineFocusModule;
     historyModule?: HistoryModule;
     citationModule?: CitationModule;
+    consumptionModule?: ConsumptionModule;
     sideNavExpanded: boolean;
     currentChapterLink: D2Link;
     currentSpreadLinks: {

package/dist/types/reader.d.ts

@@ -32,6 +32,7 @@ export default class D2Reader {
     private readonly lineFocusModule?;
     private readonly historyModule?;
     private readonly citationModule?;
+    private readonly consumptionModule?;
     private constructor();
     addEventListener(): void;
     /**

package/dist/types/store/Annotator.d.ts

@@ -14,6 +14,7 @@ interface Annotator {
     deleteAnnotation(id: any): any;
     deleteSelectedAnnotation(annotation: any): any;
     getAnnotations(): any;
+    getAnnotationsByChapter(chapter: string): any;
     getAnnotation(annotation: IHighlight): any;
     getAnnotationByID(id: string): any;
     getAnnotationPosition(id: any, iframeWin: any): any;

package/dist/types/store/LocalAnnotator.d.ts

@@ -29,6 +29,7 @@ export default class LocalAnnotator implements Annotator {
     deleteAnnotation(id: any): any;
     deleteSelectedAnnotation(annotation: any): any;
     getAnnotations(): any;
+    getAnnotationsByChapter(chapter: string): any;
     getAnnotationPosition(id: any, iframeWin: any): any;
     getAnnotationElement(id: any, iframeWin: any): any;
     getAnnotation(highlight: IHighlight): any;

package/package.json

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