@d-i-t-a/reader 2.1.8 → 2.1.11-beta.1

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

@@ -0,0 +1,39 @@
+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 {
+    progressTracked: any;
+    actionTracked: any;
+}
+export interface ConsumptionModuleProperties {
+    enableTrackingActions?: boolean;
+    actions?: Action[];
+    enableTrackingProgress?: boolean;
+}
+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;
+    startLocator?: Locator;
+    lastLocator?: Locator;
+    private constructor();
+    static create(config: ConsumptionModuleConfig): Promise<ConsumptionModule>;
+    protected start(): Promise<void>;
+    stop(): Promise<void>;
+    trackAction(locator: Locator, action: Action): Promise<void>;
+    startProgress(locator: Locator): Promise<void>;
+    continueProgress(locator: Locator): Promise<void>;
+    endProgress(): Promise<void>;
+}

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

@@ -20,8 +20,8 @@ export declare class HistoryModule implements ReaderModule {
     private properties;
     private historyForwardAnchorElement;
     private historyBackAnchorElement;
-    private historyCurrentIndex;
-    private history;
+    historyCurrentIndex: number;
+    history: Array<Locator>;
     private constructor();
     static create(config: HistoryModuleConfig): Promise<HistoryModule>;
     stop(): Promise<void>;
@@ -29,6 +29,8 @@ export declare class HistoryModule implements ReaderModule {
     setup(): void;
     push(locator: Locator, history: boolean): Promise<void>;
     protected start(): Promise<void>;
-    private handleHistoryForwardClick;
+    handleHistoryForwardClick(event: MouseEvent): Promise<void>;
+    historyForward(): Promise<void>;
     private handleHistoryBackClick;
+    historyBack(): Promise<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;
     /**
@@ -102,6 +103,14 @@ export default class D2Reader {
     get bookmarks(): any;
     /** Current Annotations */
     get annotations(): any;
+    /** History */
+    get history(): Locator[] | undefined;
+    /** Current index of history */
+    get historyCurrentIndex(): number | undefined;
+    /** History Back */
+    historyBack: () => Promise<void | undefined>;
+    /** History Forward */
+    historyForward: () => Promise<void | undefined>;
     /**
      * Search
      */

package/package.json

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