@d-i-t-a/reader 2.1.0-alpha.2 → 2.1.0-beta.2

package/dist/{navigator → types/navigator}/IFrameNavigator.d.ts

@@ -1,30 +1,38 @@
 import Navigator from "./Navigator";
 import Annotator from "../store/Annotator";
 import { Publication } from "../model/Publication";
-import EventHandler from "../utils/EventHandler";
 import { Locator, ReadingPosition } from "../model/Locator";
 import { UserSettings, UserSettingsUIConfig } from "../model/user-settings/UserSettings";
-import BookmarkModule, { BookmarkModuleConfig } from "../modules/BookmarkModule";
-import AnnotationModule, { AnnotationModuleConfig } from "../modules/AnnotationModule";
-import TTSModule, { TTSModuleConfig } from "../modules/TTS/TTSModule";
-import SearchModule, { SearchModuleConfig } from "../modules/search/SearchModule";
-import ContentProtectionModule, { ContentProtectionModuleConfig } from "../modules/protection/ContentProtectionModule";
-import TextHighlighter, { TextHighlighterConfig } from "../modules/highlight/TextHighlighter";
-import TimelineModule from "../modules/positions/TimelineModule";
-import TouchEventHandler from "../utils/TouchEventHandler";
-import KeyboardEventHandler from "../utils/KeyboardEventHandler";
+import { BookmarkModule, BookmarkModuleConfig } from "../modules/BookmarkModule";
+import { AnnotationModule, AnnotationModuleConfig } from "../modules/AnnotationModule";
+import { SearchModule, SearchModuleConfig } from "../modules/search/SearchModule";
+import { ContentProtectionModule, ContentProtectionModuleConfig } from "../modules/protection/ContentProtectionModule";
+import { TextHighlighter, TextHighlighterConfig } from "../modules/highlight/TextHighlighter";
+import { TimelineModule } from "../modules/positions/TimelineModule";
 import BookView from "../views/BookView";
-import MediaOverlayModule, { MediaOverlayModuleConfig } from "../modules/mediaoverlays/MediaOverlayModule";
+import { MediaOverlayModule, MediaOverlayModuleConfig } from "../modules/mediaoverlays/MediaOverlayModule";
 import { D2Link, Link } from "../model/Link";
+import { ReaderModule } from "../modules/ReaderModule";
+import { TTSModuleConfig } from "../modules/TTS/TTSSettings";
+import { PageBreakModuleConfig } from "../modules/pagebreak/PageBreakModule";
+import { PageBreakModule } from "../modules/pagebreak/PageBreakModule";
+import { DefinitionsModule, DefinitionsModuleConfig } from "../modules/search/DefinitionsModule";
+import EventEmitter from "eventemitter3";
+import LineFocusModule, { LineFocusModuleConfig } from "../modules/linefocus/LineFocusModule";
+import { HistoryModule } from "../modules/history/HistoryModule";
+import CitationModule, { CitationModuleConfig } from "../modules/citation/CitationModule";
 export declare type GetContent = (href: string) => Promise<string>;
+export declare type GetContentBytesLength = (href: string) => Promise<number>;
 export interface NavigatorAPI {
     updateSettings: any;
     getContent: GetContent;
+    getContentBytesLength: GetContentBytesLength;
     resourceReady: any;
     resourceAtStart: any;
     resourceAtEnd: any;
     resourceFitsScreen: any;
     updateCurrentLocation: any;
+    onError?: (e: Error) => void;
 }
 export interface UpLinkConfig {
     url?: URL;
@@ -36,31 +44,36 @@ export interface IFrameAttributes {
     navHeight?: number;
     iframePaddingTop?: number;
     bottomInfoHeight?: number;
+    sideNavPosition?: "left" | "right";
 }
 export interface IFrameNavigatorConfig {
     mainElement: HTMLElement;
-    headerMenu: HTMLElement;
-    footerMenu: HTMLElement;
+    headerMenu?: HTMLElement | null;
+    footerMenu?: HTMLElement | null;
     publication: Publication;
     settings: UserSettings;
     annotator?: Annotator;
-    eventHandler?: EventHandler;
-    touchEventHandler?: TouchEventHandler;
-    keyboardEventHandler?: KeyboardEventHandler;
     upLink?: UpLinkConfig;
     initialLastReadingPosition?: ReadingPosition;
-    rights?: ReaderRights;
+    rights: ReaderRights;
     material?: ReaderUI;
-    api: NavigatorAPI;
-    tts: TTSModuleConfig;
+    api?: NavigatorAPI;
+    tts?: TTSModuleConfig;
     injectables: Array<Injectable>;
-    attributes: IFrameAttributes;
-    services: PublicationServices;
+    attributes?: IFrameAttributes;
+    services?: PublicationServices;
+    sample?: SampleRead;
 }
 export interface PublicationServices {
     positions?: URL;
     weight?: URL;
 }
+export interface SampleRead {
+    isSampleRead?: boolean;
+    limit?: number;
+    popup?: string;
+    minimum?: number;
+}
 export interface Injectable {
     type: string;
     url?: string;
@@ -72,20 +85,21 @@ export interface Injectable {
     appearance?: string;
     async?: boolean;
 }
-export interface SelectionMenuItem {
-    id: string;
-    callback: any;
-}
 export interface ReaderRights {
-    enableBookmarks?: boolean;
-    enableAnnotations?: boolean;
-    enableTTS?: boolean;
-    enableSearch?: boolean;
-    enableContentProtection?: boolean;
-    enableMaterial?: boolean;
-    enableTimeline?: boolean;
-    autoGeneratePositions?: boolean;
-    enableMediaOverlays?: boolean;
+    enableBookmarks: boolean;
+    enableAnnotations: boolean;
+    enableTTS: boolean;
+    enableSearch: boolean;
+    enableDefinitions: boolean;
+    enableContentProtection: boolean;
+    enableTimeline: boolean;
+    autoGeneratePositions: boolean;
+    enableMediaOverlays: boolean;
+    enablePageBreaks: boolean;
+    enableLineFocus: boolean;
+    customKeyboardEvents: boolean;
+    enableHistory: boolean;
+    enableCitations: boolean;
 }
 export interface ReaderUI {
     settings: UserSettingsUIConfig;
@@ -101,38 +115,44 @@ export interface ReaderConfig {
     api?: NavigatorAPI;
     tts?: TTSModuleConfig;
     search?: SearchModuleConfig;
+    define?: DefinitionsModuleConfig;
     protection?: ContentProtectionModuleConfig;
     mediaOverlays?: MediaOverlayModuleConfig;
+    pagebreak?: PageBreakModuleConfig;
     annotations?: AnnotationModuleConfig;
     bookmarks?: BookmarkModuleConfig;
+    lineFocus?: LineFocusModuleConfig;
+    citations?: CitationModuleConfig;
     highlighter?: TextHighlighterConfig;
     injectables: Array<Injectable>;
     injectablesFixed: Array<Injectable>;
     useLocalStorage?: boolean;
     attributes?: IFrameAttributes;
     services?: PublicationServices;
+    sample?: SampleRead;
 }
 /** Class that shows webpub resources in an iframe, with navigation controls outside the iframe. */
-export default class IFrameNavigator implements Navigator {
+export declare class IFrameNavigator extends EventEmitter implements Navigator {
     iframes: Array<HTMLIFrameElement>;
-    currentTocUrl: string;
-    headerMenu: HTMLElement;
+    currentTocUrl: string | undefined;
+    headerMenu?: HTMLElement | null;
     mainElement: HTMLElement;
     publication: Publication;
     bookmarkModule?: BookmarkModule;
     annotationModule?: AnnotationModule;
-    ttsModule?: TTSModule;
+    ttsModule?: ReaderModule;
     searchModule?: SearchModule;
+    definitionsModule?: DefinitionsModule;
     contentProtectionModule?: ContentProtectionModule;
     highlighter?: TextHighlighter;
     timelineModule?: TimelineModule;
+    pageBreakModule?: PageBreakModule;
     mediaOverlayModule?: MediaOverlayModule;
+    lineFocusModule?: LineFocusModule;
+    historyModule?: HistoryModule;
+    citationModule?: CitationModule;
     sideNavExpanded: boolean;
     material: boolean;
-    mTabs: Array<any>;
-    mDropdowns: Array<any>;
-    mCollapsibles: Array<any>;
-    mSidenav: any;
     currentChapterLink: D2Link;
     currentSpreadLinks: {
         left?: D2Link;
@@ -143,10 +163,11 @@ export default class IFrameNavigator implements Navigator {
     private previousChapterLink;
     settings: UserSettings;
     private readonly annotator;
-    view: BookView | null;
+    view: BookView;
     private readonly eventHandler;
     private readonly touchEventHandler;
     private readonly keyboardEventHandler;
+    private readonly sampleReadEventHandler;
     private readonly upLinkConfig;
     private upLink;
     private nextChapterBottomAnchorElement;
@@ -159,18 +180,13 @@ export default class IFrameNavigator implements Navigator {
     private landmarksView;
     private landmarksSection;
     private pageListView;
-    private goToPageView;
-    private goToPageNumberInput;
-    private goToPageNumberButton;
-    private bookmarksControl;
-    private bookmarksView;
     private links;
     private linksTopLeft;
     private linksBottom;
     private linksMiddle;
     private tocView;
     private loadingMessage;
-    private errorMessage;
+    errorMessage: HTMLDivElement;
     private tryAgainButton;
     private goBackButton;
     private infoTop;
@@ -183,48 +199,51 @@ export default class IFrameNavigator implements Navigator {
     private newElementId;
     private isBeingStyled;
     private isLoading;
-    private readonly initialLastReadingPosition;
-    api: NavigatorAPI;
+    private readonly initialLastReadingPosition?;
+    api?: NavigatorAPI;
     rights: ReaderRights;
-    tts: TTSModuleConfig;
-    injectables: Array<Injectable>;
-    attributes: IFrameAttributes;
-    services: PublicationServices;
-    static create(config: IFrameNavigatorConfig): Promise<any>;
-    protected constructor(settings: UserSettings, annotator: Annotator | null, eventHandler: EventHandler | null, touchEventHandler: TouchEventHandler | null, keyboardEventHandler: KeyboardEventHandler | null, upLinkConfig: UpLinkConfig | null, initialLastReadingPosition: ReadingPosition | null, publication: Publication, material: any, api: NavigatorAPI, rights: ReaderRights, tts: TTSModuleConfig, injectables: Array<Injectable>, attributes: IFrameAttributes, services: PublicationServices);
-    stop(): Promise<void>;
+    tts?: TTSModuleConfig;
+    injectables?: Array<Injectable>;
+    attributes?: IFrameAttributes;
+    services?: PublicationServices;
+    sample?: SampleRead;
+    private didInitKeyboardEventHandler;
+    static create(config: IFrameNavigatorConfig): Promise<IFrameNavigator>;
+    protected constructor(settings: UserSettings, annotator: Annotator | undefined, upLinkConfig: UpLinkConfig | undefined, initialLastReadingPosition: ReadingPosition | undefined, publication: Publication, material: any, api?: NavigatorAPI, rights?: ReaderRights, tts?: TTSModuleConfig, injectables?: Array<Injectable>, attributes?: IFrameAttributes, services?: PublicationServices, sample?: SampleRead);
+    stop(): void;
     spreads: HTMLDivElement;
     firstSpread: HTMLDivElement;
-    protected start(mainElement: HTMLElement, headerMenu: HTMLElement, footerMenu: HTMLElement): Promise<void>;
+    protected start(mainElement: HTMLElement, headerMenu?: HTMLElement | null, footerMenu?: HTMLElement | null): Promise<void>;
     timeout: any;
     onResize: () => void;
     reload: () => Promise<void>;
     private setupEvents;
-    private setupModalFocusTrap;
-    private goToPageNumber;
     isScrolling: boolean;
     private updateBookView;
     private loadManifest;
     private handleIFrameLoad;
+    private injectInjectablesIntoIframeHead;
+    /**
+     * Displays standard error UI.
+     */
     private abortOnError;
     private tryAgain;
     private precessContentForIframe;
     private static goBack;
-    private static isDisplayed;
-    private static showElement;
-    private static hideElement;
-    private hideModal;
-    private toggleDisplay;
     private handleEditClick;
     get hasMediaOverlays(): boolean;
     startReadAloud(): void;
-    stopReadAloud(ttsOnly?: boolean): void;
+    startReadAlong(): void;
+    stopReadAloud(): void;
+    stopReadAlong(): void;
     pauseReadAloud(): void;
+    pauseReadAlong(): void;
     resumeReadAloud(): void;
+    resumeReadAlong(): void;
     totalResources(): number;
     mostRecentNavigatedTocItem(): string;
-    currentResource(): number;
-    currentLink(): Array<Link>;
+    currentResource(): number | undefined;
+    currentLink(): Array<Link | undefined>;
     tableOfContents(): any;
     readingOrder(): any;
     atStart(): boolean;
@@ -237,21 +256,23 @@ export default class IFrameNavigator implements Navigator {
     currentLocator(): Locator;
     positions(): any;
     goToPosition(position: number): void;
-    snapToElement(element: HTMLElement): void;
+    snapToSelector(selector: any): void;
     applyAttributes(attributes: IFrameAttributes): void;
     private handlePreviousPageClick;
     private handleNextPageClick;
     private handleClickThrough;
     private handleInternalLink;
     private handleNumberOfIframes;
-    private handleResize;
-    updatePositionInfo(): void;
+    handleResize(): Promise<void>;
+    updatePositionInfo(save?: boolean): void;
+    savePosition: (() => void) & {
+        clear(): void;
+    };
     private handlePreviousChapterClick;
     private handleNextChapterClick;
-    private hideBookmarksOnEscape;
     private hideView;
     private setActiveTOCItem;
-    navigate(locator: Locator): void;
+    navigate(locator: Locator, history?: boolean): Promise<void>;
     checkResourcePosition: (() => void) & {
         clear(): void;
     };
@@ -263,4 +284,8 @@ export default class IFrameNavigator implements Navigator {
     private static createBase;
     private static createCssLink;
     private static createJavascriptLink;
+    activateMarker(id: any, position: any): void;
+    deactivateMarker(): void;
+    showLayer(layer: any): void;
+    hideLayer(layer: any): void;
 }

package/dist/types/reader.d.ts

@@ -0,0 +1,202 @@
+import { Annotation, Bookmark, Locator } from "./model/Locator";
+import { UserSettingsIncrementable } from "./model/user-settings/UserProperties";
+import { UserSettings } from "./model/user-settings/UserSettings";
+import { IMediaOverlayUserSettings, MediaOverlayIncrementable } from "./modules/mediaoverlays/MediaOverlaySettings";
+import { ITTSUserSettings, TTSIncrementable } from "./modules/TTS/TTSSettings";
+import { IFrameAttributes, ReaderConfig } from "./navigator/IFrameNavigator";
+/**
+ * A class that, once instantiated using the public `.build` method,
+ * is the primary interface into the D2 Reader.
+ * @TODO :
+ *  - Type all function arguments
+ *  - DEV logger
+ *  - Default config
+ *  - Different types for initial config and final config
+ *  - Testing
+ */
+export default class D2Reader {
+    private readonly settings;
+    private readonly navigator;
+    private readonly highlighter;
+    private readonly bookmarkModule?;
+    private readonly annotationModule?;
+    private readonly ttsSettings?;
+    private readonly ttsModule?;
+    private readonly searchModule?;
+    private readonly definitionsModule?;
+    private readonly contentProtectionModule?;
+    private readonly timelineModule?;
+    private readonly mediaOverlaySettings?;
+    private readonly mediaOverlayModule?;
+    private readonly pageBreakModule?;
+    private readonly lineFocusModule?;
+    private readonly historyModule?;
+    private readonly citationModule?;
+    private constructor();
+    addEventListener(): void;
+    /**
+     * The async builder.
+     */
+    static load(initialConfig: ReaderConfig): Promise<D2Reader>;
+    /**
+     * Read Aloud
+     */
+    /** Start TTS Read Aloud */
+    startReadAloud: () => void;
+    /** Start TTS Read Aloud */
+    stopReadAloud: () => void;
+    /** Start TTS Read Aloud */
+    pauseReadAloud: () => void;
+    /** Start TTS Read Aloud */
+    resumeReadAloud: () => void;
+    /**
+     * Read Along
+     */
+    /** Start Media Overlay Read Along */
+    startReadAlong: () => void;
+    /** Stop Media Overlay Read Along */
+    stopReadAlong: () => void;
+    /** Pause Media Overlay Read Along */
+    pauseReadAlong: () => void;
+    /** Resume Media Overlay Read Along */
+    resumeReadAlong: () => void;
+    get hasMediaOverlays(): boolean;
+    /**
+     * Bookmarks and annotations
+     */
+    /** Save bookmark by progression */
+    saveBookmark: () => Promise<any>;
+    /** Save bookmark by annotation */
+    saveBookmarkPlus: () => Promise<any>;
+    /** Delete bookmark */
+    deleteBookmark: (bookmark: Bookmark) => Promise<any>;
+    /** Delete annotation */
+    deleteAnnotation: (highlight: Annotation) => Promise<any>;
+    /** Add annotation */
+    addAnnotation: (highlight: Annotation) => Promise<any>;
+    /** Hide Annotation Layer */
+    hideAnnotationLayer: () => void | undefined;
+    /** Show Annotation Layer */
+    showAnnotationLayer: () => void | undefined;
+    /** Hide  Layer */
+    hideLayer: (layer: any) => void;
+    /** Show  Layer */
+    showLayer: (layer: any) => void;
+    /** Activate Marker <br>
+     * Activated Marker will be used for active annotation creation */
+    activateMarker: (id: string, position: string) => void;
+    /** Deactivate Marker */
+    deactivateMarker: () => void;
+    /**
+     * Definitions
+     */
+    /** Clear current definitions */
+    clearDefinitions: () => Promise<void>;
+    /** Add newt definition */
+    addDefinition: (definition: any) => Promise<void>;
+    /** Table of Contents */
+    get tableOfContents(): any;
+    /** Reading Order or Spine */
+    get readingOrder(): any;
+    /** Current Bookmarks */
+    get bookmarks(): any;
+    /** Current Annotations */
+    get annotations(): any;
+    /**
+     * Search
+     */
+    /** Search by term and current resource or entire book <br>
+     * current = true, will search only current resource <br>
+     * current = false, will search entire publication */
+    search: (term: string, current: boolean) => Promise<any>;
+    goToSearchIndex: (href: string, index: number, current: boolean) => Promise<void>;
+    goToSearchID: (href: string, index: number, current: boolean) => Promise<void>;
+    clearSearch: () => Promise<void>;
+    /**
+     * Resources
+     */
+    get currentResource(): number | undefined;
+    get mostRecentNavigatedTocItem(): string;
+    get totalResources(): number;
+    get publicationLanguage(): string[];
+    /**
+     * Settings
+     */
+    get currentSettings(): {
+        appearance: string;
+        fontFamily: string;
+        textAlignment: string;
+        columnCount: string;
+        verticalScroll: boolean;
+        fontSize: number;
+        wordSpacing: number;
+        letterSpacing: number;
+        pageMargins: number;
+        lineHeight: number;
+    };
+    resetUserSettings: () => Promise<void>;
+    applyUserSettings: (userSettings: Partial<UserSettings>) => Promise<void>;
+    scroll: (value: boolean) => Promise<void>;
+    private isTTSIncrementable;
+    private isMOIncrementable;
+    /**
+     * Used to increase anything that can be increased,
+     * such as pitch, rate, volume, fontSize
+     */
+    increase: (incremental: UserSettingsIncrementable | TTSIncrementable | MediaOverlayIncrementable) => Promise<void>;
+    /**
+     * Used to decrease anything that can be decreased,
+     * such as pitch, rate, volume, fontSize
+     */
+    decrease: (incremental: UserSettingsIncrementable | TTSIncrementable | MediaOverlayIncrementable) => Promise<void>;
+    /**
+     * Publisher?
+     * Disabled
+     */
+    /**
+     * TTS Settings
+     */
+    resetTTSSettings: () => void;
+    applyTTSSettings: (ttsSettings: Partial<ITTSUserSettings>) => Promise<void>;
+    /**
+     * Disabled
+     */
+    applyPreferredVoice: (value: string) => Promise<void>;
+    /**
+     * Media Overlay Settings
+     */
+    resetMediaOverlaySettings: () => Promise<void>;
+    applyMediaOverlaySettings: (settings: Partial<IMediaOverlayUserSettings>) => Promise<void>;
+    /**
+     * Navigation
+     * @TODO : These should return promises that complete when they are done.
+     */
+    get currentLocator(): Locator;
+    get positions(): any;
+    goTo: (locator: Locator) => Promise<void>;
+    goToPosition: (value: number) => Promise<void>;
+    nextResource: () => void;
+    previousResource: () => void;
+    nextPage: () => Promise<void>;
+    previousPage: () => Promise<void>;
+    get atStart(): boolean;
+    get atEnd(): boolean;
+    snapToSelector: (selector: any) => Promise<void>;
+    /**
+     * You have attributes in the reader when you initialize it. You can set margin, navigationHeight etc...
+     * This is in case you change the attributes after initializing the reader.
+     */
+    applyAttributes: (value: IFrameAttributes) => void;
+    applyLineFocusSettings(userSettings: any): Promise<void>;
+    lineUp(): void;
+    lineDown(): void;
+    enableLineFocus(): Promise<void>;
+    lineFocus(active: boolean): Promise<void>;
+    disableLineFocus(): void;
+    /**
+     * Destructor:
+     * Only used in react applications because when they re-visit the page
+     * it tried to create a new reader, which interfered with the first one.
+     */
+    stop: () => void;
+}

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

@@ -0,0 +1,25 @@
+import { ReadingPosition } from "../model/Locator";
+import { IHighlight } from "../modules/highlight/common/highlight";
+interface Annotator {
+    initLastReadingPosition(position: ReadingPosition): any;
+    getLastReadingPosition(): any;
+    saveLastReadingPosition(position: any): any;
+    initBookmarks(list: any): any;
+    saveBookmark(bookmark: any): any;
+    deleteBookmark(bookmark: any): any;
+    getBookmarks(href?: string): any;
+    locatorExists(locator: any, type: AnnotationType): any;
+    initAnnotations(list: any): any;
+    saveAnnotation(annotation: any): any;
+    deleteAnnotation(id: any): any;
+    deleteSelectedAnnotation(annotation: any): any;
+    getAnnotations(): any;
+    getAnnotation(annotation: IHighlight): any;
+    getAnnotationByID(id: string): any;
+    getAnnotationPosition(id: any, iframeWin: any): any;
+}
+export declare enum AnnotationType {
+    Bookmark = 0,
+    Annotation = 1
+}
+export default Annotator;

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

@@ -0,0 +1,31 @@
+import Annotator, { AnnotationType } from "./Annotator";
+import Store from "./Store";
+import { ReadingPosition } from "../model/Locator";
+import { IHighlight } from "../modules/highlight/common/highlight";
+export interface LocalAnnotatorConfig {
+    store: Store;
+}
+/** Annotator that stores annotations locally, in the browser. */
+export default class LocalAnnotator implements Annotator {
+    private readonly store;
+    private static readonly LAST_READING_POSITION;
+    private static readonly BOOKMARKS;
+    private static readonly ANNOTATIONS;
+    constructor(config: LocalAnnotatorConfig);
+    getLastReadingPosition(): any;
+    initLastReadingPosition(position: ReadingPosition): void;
+    saveLastReadingPosition(position: any): void;
+    initBookmarks(list: any): any;
+    saveBookmark(bookmark: any): any;
+    locatorExists(locator: any, type: AnnotationType): any | null;
+    deleteBookmark(bookmark: any): any;
+    getBookmarks(href?: string): any;
+    initAnnotations(list: any): any;
+    saveAnnotation(annotation: any): any;
+    deleteAnnotation(id: any): any;
+    deleteSelectedAnnotation(annotation: any): any;
+    getAnnotations(): any;
+    getAnnotationPosition(id: any, iframeWin: any): any;
+    getAnnotation(highlight: IHighlight): any;
+    getAnnotationByID(id: string): any;
+}

package/dist/{store → types/store}/LocalStorageStore.d.ts

@@ -14,7 +14,7 @@ export default class LocalStorageStore implements Store {
     private readonly useLocalStorage;
     constructor(config: LocalStorageStoreConfig);
     private getLocalStorageKey;
-    get(key: string): Promise<any | null>;
-    set(key: string, value: any): Promise<void>;
-    remove(key: string): Promise<void>;
+    get(key: string): any | null;
+    set(key: string, value: any): void;
+    remove(key: string): void;
 }

package/dist/{store → types/store}/MemoryStore.d.ts

@@ -3,7 +3,7 @@ import Store from "./Store";
 export default class MemoryStore implements Store {
     private readonly store;
     constructor();
-    get(key: string): Promise<string | null>;
-    set(key: string, value: string): Promise<void>;
-    remove(key: string): Promise<void>;
+    get(key: string): string | null;
+    set(key: string, value: string): void;
+    remove(key: string): void;
 }

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

@@ -0,0 +1,6 @@
+interface Store {
+    get(key: string): any | null;
+    set(key: string, value: any): void;
+    remove(key: string): void;
+}
+export default Store;

package/dist/types/utils/EventHandler.d.ts

@@ -0,0 +1,23 @@
+import { IFrameNavigator } from "../navigator/IFrameNavigator";
+import { Popup } from "../modules/search/Popup";
+export declare function addEventListenerOptional(element: any, eventType: string, eventListener: any): void;
+export declare function removeEventListenerOptional(element: any, eventType: string, eventListener: any): void;
+export default class EventHandler {
+    navigator: IFrameNavigator;
+    popup: Popup;
+    constructor(navigator: IFrameNavigator);
+    onInternalLink: (event: UIEvent) => void;
+    onClickThrough: (event: UIEvent) => void;
+    setupEvents(element: HTMLElement | Document | null): void;
+    private checkForLink;
+    private linkInPublication;
+    /**
+     *
+     * This function checks the user clicked link inside the iframe
+     * against the readingOrder list, it is an internal link if found.
+     *
+     */
+    private isReadingOrderInternal;
+    private isResourceInternal;
+    private handleLinks;
+}

package/dist/{utils → types/utils}/HTMLUtilities.d.ts

@@ -1,15 +1,15 @@
 /** Returns a single element matching the selector within the parentElement,
     or null if no element matches. */
-export declare function findElement(parentElement: Element | Document, selector: string): Element | null;
+export declare function findElement(parentElement: Element | Document, selector: string): any | null;
 /** Returns a single element matching the selector within the parent element,
     or throws an exception if no element matches. */
-export declare function findRequiredElement(parentElement: Element | Document, selector: string): Element;
+export declare function findRequiredElement(parentElement: Element | Document, selector: string): any;
 /** Returns a single element matching the selector within the parentElement in the iframe context,
     or null if no element matches. */
 export declare function findIframeElement(parentElement: Document | null, selector: string): Element | null;
 /** Returns a single element matching the selector within the parent element in an iframe context,
         or throws an exception if no element matches. */
-export declare function findRequiredIframeElement(parentElement: Document | null, selector: string): Element;
+export declare function findRequiredIframeElement(parentElement: Document, selector: string): Element;
 /** Sets an attribute and its value for an HTML element */
 export declare function setAttr(element: HTMLElement, attr: string, value: string): void;
 /** Removes an attribute for an HTML element */