@d-i-t-a/reader 2.0.0-beta.1 → 2.0.0-beta.10

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

@@ -1,39 +1,43 @@
-import Publication from "../../model/Publication";
-import IFrameNavigator from "../../navigator/IFrameNavigator";
-import ReaderModule from "../ReaderModule";
-import TextHighlighter from "../highlight/TextHighlighter";
+import { Publication } from "../../model/Publication";
+import { IFrameNavigator } from "../../navigator/IFrameNavigator";
+import { ReaderModule } from "../ReaderModule";
+import { IHighlight } from "../highlight/common/highlight";
+import { ISelectionInfo } from "../highlight/common/selection";
+import { TextHighlighter } from "../highlight/TextHighlighter";
 export interface SearchModuleAPI {
 }
 export interface SearchModuleProperties {
     color?: string;
     current?: string;
+    hideLayer?: boolean;
 }
 export interface SearchModuleConfig extends SearchModuleProperties {
     api?: SearchModuleAPI;
     publication: Publication;
-    headerMenu: HTMLElement;
+    headerMenu?: HTMLElement | null;
     delegate: IFrameNavigator;
     highlighter: TextHighlighter;
 }
-export default class SearchModule implements ReaderModule {
+export declare class SearchModule implements ReaderModule {
     private properties;
-    private api;
+    private api?;
     private publication;
-    private readonly headerMenu;
+    private readonly headerMenu?;
     private delegate;
     private searchInput;
     private searchGo;
     private currentChapterSearchResult;
     private bookSearchResult;
-    private currentHighlights;
-    private highlighter;
+    private currentSearchHighlights;
+    private highlighter?;
     static create(config: SearchModuleConfig): Promise<SearchModule>;
     private constructor();
     stop(): Promise<void>;
     protected start(): Promise<void>;
     private handleSearch;
     handleSearchChapter(index?: number): Promise<void>;
-    searchAndPaintChapter(term: string, index: number, callback: (result: any) => any): Promise<void>;
+    searchAndPaintChapter(term: string, index: number | undefined, callback: (result: any) => any): Promise<void>;
+    createSearchHighlight(selectionInfo: ISelectionInfo, color: string): IHighlight;
     clearSearch(): void;
     search(term: string, current: boolean): Promise<any>;
     goToSearchID(href: string, index: number, current: boolean): Promise<void>;
@@ -47,8 +51,8 @@ export default class SearchModule implements ReaderModule {
     paginate(items: Array<any>, page: number, per_page: number): {
         page: number;
         per_page: number;
-        pre_page: number;
-        next_page: number;
+        pre_page: number | undefined;
+        next_page: number | undefined;
         total: number;
         total_pages: number;
         data: any[];

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

@@ -11,4 +11,4 @@ export interface ISearchResult {
 }
 export declare function escapeRegExp(str: string): string;
 export declare const reset: () => void;
-export declare function searchDocDomSeek(searchInput: string, doc: Document, href: string, title: string): Promise<ISearchResult[]>;
+export declare function searchDocDomSeek(searchInput: string, doc: Document | null, href: string, title: string, fullWordSearch?: boolean): Promise<ISearchResult[]>;

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

@@ -1,20 +1,25 @@
+/// <reference types="node" />
 import Navigator from "./Navigator";
 import Annotator from "../store/Annotator";
-import Publication from "../model/Publication";
+import { Publication } from "../model/Publication";
 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 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 { 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 { ReaderModule } from "../modules/ReaderModule";
 import { TTSModuleConfig } from "../modules/TTS/TTSSettings";
-import PageBreakModule from "../modules/pagebreak/PageBreakModule";
+import { PageBreakModuleConfig } from "../modules/pagebreak/PageBreakModule";
+import { PageBreakModule } from "../modules/pagebreak/PageBreakModule";
+import { DefinitionsModule, DefinitionsModuleConfig } from "../modules/search/DefinitionsModule";
+import EventEmitter from "events";
+import LineFocusModule, { LineFocusModuleConfig } from "../modules/linefocus/LineFocusModule";
 export declare type GetContent = (href: string) => Promise<string>;
 export declare type GetContentBytesLength = (href: string) => Promise<number>;
 export interface NavigatorAPI {
@@ -26,6 +31,7 @@ export interface NavigatorAPI {
     resourceAtEnd: any;
     resourceFitsScreen: any;
     updateCurrentLocation: any;
+    onError?: (e: Error) => void;
 }
 export interface UpLinkConfig {
     url?: URL;
@@ -41,20 +47,20 @@ export interface IFrameAttributes {
 }
 export interface IFrameNavigatorConfig {
     mainElement: HTMLElement;
-    headerMenu: HTMLElement;
-    footerMenu: HTMLElement;
+    headerMenu?: HTMLElement | null;
+    footerMenu?: HTMLElement | null;
     publication: Publication;
     settings: UserSettings;
     annotator?: Annotator;
     upLink?: UpLinkConfig;
     initialLastReadingPosition?: ReadingPosition;
-    rights?: ReaderRights;
+    rights: ReaderRights;
     material?: ReaderUI;
     api?: NavigatorAPI;
     tts?: TTSModuleConfig;
     injectables: Array<Injectable>;
-    attributes: IFrameAttributes;
-    services: PublicationServices;
+    attributes?: IFrameAttributes;
+    services?: PublicationServices;
     sample?: SampleRead;
 }
 export interface PublicationServices {
@@ -79,15 +85,18 @@ export interface Injectable {
     async?: boolean;
 }
 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;
+    enableMaterial: boolean;
+    enableTimeline: boolean;
+    autoGeneratePositions: boolean;
+    enableMediaOverlays: boolean;
+    enablePageBreaks: boolean;
+    enableLineFocus: boolean;
 }
 export interface ReaderUI {
     settings: UserSettingsUIConfig;
@@ -103,10 +112,13 @@ export interface ReaderConfig {
     api?: NavigatorAPI;
     tts?: TTSModuleConfig;
     search?: SearchModuleConfig;
+    define?: DefinitionsModuleConfig;
     protection?: ContentProtectionModuleConfig;
     mediaOverlays?: MediaOverlayModuleConfig;
+    pagebreak?: PageBreakModuleConfig;
     annotations?: AnnotationModuleConfig;
     bookmarks?: BookmarkModuleConfig;
+    lineFocus?: LineFocusModuleConfig;
     highlighter?: TextHighlighterConfig;
     injectables: Array<Injectable>;
     injectablesFixed: Array<Injectable>;
@@ -116,21 +128,23 @@ export interface ReaderConfig {
     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?: ReaderModule;
     searchModule?: SearchModule;
+    definitionsModule?: DefinitionsModule;
     contentProtectionModule?: ContentProtectionModule;
     highlighter?: TextHighlighter;
     timelineModule?: TimelineModule;
     pageBreakModule?: PageBreakModule;
     mediaOverlayModule?: MediaOverlayModule;
+    lineFocusModule?: LineFocusModule;
     sideNavExpanded: boolean;
     material: boolean;
     mTabs: Array<any>;
@@ -147,7 +161,7 @@ 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;
@@ -185,21 +199,21 @@ 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;
-    sample: SampleRead;
+    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 | null, upLinkConfig: UpLinkConfig | null, initialLastReadingPosition: ReadingPosition | null, publication: Publication, material: any, api: NavigatorAPI, rights: ReaderRights, tts: TTSModuleConfig, injectables: Array<Injectable>, attributes: IFrameAttributes, services: PublicationServices, sample: SampleRead);
+    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>;
@@ -210,6 +224,9 @@ export default class IFrameNavigator implements Navigator {
     private loadManifest;
     private handleIFrameLoad;
     private injectInjectablesIntoIframeHead;
+    /**
+     * Displays standard error UI.
+     */
     private abortOnError;
     private tryAgain;
     private precessContentForIframe;
@@ -230,8 +247,8 @@ export default class IFrameNavigator implements Navigator {
     resumeReadAlong(): void;
     totalResources(): number;
     mostRecentNavigatedTocItem(): string;
-    currentResource(): number;
-    currentLink(): Array<Link>;
+    currentResource(): number | undefined;
+    currentLink(): Array<Link | undefined>;
     tableOfContents(): any;
     readingOrder(): any;
     atStart(): boolean;
@@ -244,7 +261,7 @@ 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;
@@ -252,8 +269,8 @@ export default class IFrameNavigator implements Navigator {
     private handleInternalLink;
     private handleNumberOfIframes;
     handleResize(): Promise<void>;
-    updatePositionInfo(save?: boolean): Promise<void>;
-    savePosition: (() => Promise<void>) & {
+    updatePositionInfo(save?: boolean): void;
+    savePosition: (() => void) & {
         clear(): void;
     };
     private handlePreviousChapterClick;
@@ -273,6 +290,8 @@ export default class IFrameNavigator implements Navigator {
     private static createBase;
     private static createCssLink;
     private static createJavascriptLink;
-    activateMarker(id: any): void;
+    activateMarker(id: any, position: any): void;
     deactivateMarker(): void;
+    showLayer(layer: any): void;
+    hideLayer(layer: any): void;
 }

package/dist/types/reader.d.ts

@@ -1,22 +1,12 @@
-import { Locator } from "./model/Locator";
+import { Annotation, Bookmark, Locator } from "./model/Locator";
 import { UserSettingsIncrementable } from "./model/user-settings/UserProperties";
 import { UserSettings } from "./model/user-settings/UserSettings";
-import AnnotationModule from "./modules/AnnotationModule";
-import BookmarkModule from "./modules/BookmarkModule";
-import TextHighlighter from "./modules/highlight/TextHighlighter";
-import MediaOverlayModule from "./modules/mediaoverlays/MediaOverlayModule";
-import { MediaOverlaySettings, IMediaOverlayUserSettings, MediaOverlayIncrementable } from "./modules/mediaoverlays/MediaOverlaySettings";
-import TimelineModule from "./modules/positions/TimelineModule";
-import ContentProtectionModule from "./modules/protection/ContentProtectionModule";
-import SearchModule from "./modules/search/SearchModule";
-import { ITTSUserSettings, TTSIncrementable, TTSSettings } from "./modules/TTS/TTSSettings";
-import IFrameNavigator, { IFrameAttributes, ReaderConfig } from "./navigator/IFrameNavigator";
-import PageBreakModule from "./modules/pagebreak/PageBreakModule";
-import ReaderModule from "./modules/ReaderModule";
+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
@@ -25,57 +15,97 @@ import ReaderModule from "./modules/ReaderModule";
  *  - Testing
  */
 export default class D2Reader {
-    readonly settings: UserSettings;
-    readonly ttsSettings: TTSSettings;
-    readonly navigator: IFrameNavigator;
-    readonly highlighter: TextHighlighter;
-    readonly bookmarkModule: BookmarkModule;
-    readonly annotationModule?: AnnotationModule;
-    readonly ttsModule?: ReaderModule;
-    readonly searchModule?: SearchModule;
-    readonly contentProtectionModule?: ContentProtectionModule;
-    readonly timelineModule?: TimelineModule;
-    readonly mediaOverlaySettings?: MediaOverlaySettings;
-    readonly mediaOverlayModule?: MediaOverlayModule;
-    readonly pageBreakModule?: PageBreakModule;
+    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 constructor();
+    addEventListener(): void;
     /**
      * The async builder.
      */
-    static build(initialConfig: ReaderConfig): Promise<D2Reader>;
+    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>;
-    saveBookmarkPlus: () => Promise<void>;
-    deleteBookmark: (bookmark: any) => Promise<any>;
-    deleteAnnotation: (highlight: any) => Promise<any>;
-    addAnnotation: (highlight: any) => Promise<any>;
-    hideAnnotationLayer: () => void;
-    showAnnotationLayer: () => void;
-    activateMarker: (id: any) => void;
+    /** 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;
-    tableOfContents: () => Promise<any>;
-    readingOrder: () => Promise<any>;
-    bookmarks: () => Promise<any>;
-    annotations: () => Promise<any>;
+    /**
+     * 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>;
@@ -83,16 +113,14 @@ export default class D2Reader {
     /**
      * Resources
      */
-    currentResource: () => number;
-    mostRecentNavigatedTocItem: () => string;
-    totalResources: () => number;
+    get currentResource(): number | undefined;
+    get mostRecentNavigatedTocItem(): string;
+    get totalResources(): number;
+    get publicationLanguage(): string[];
     /**
      * Settings
      */
-    get publicationLanguage(): string[];
-    resetUserSettings: () => Promise<void>;
-    applyUserSettings: (userSettings: Partial<UserSettings>) => Promise<void>;
-    currentSettings: () => {
+    get currentSettings(): {
         appearance: string;
         fontFamily: string;
         textAlignment: string;
@@ -104,6 +132,8 @@ export default class D2Reader {
         pageMargins: number;
         lineHeight: number;
     };
+    resetUserSettings: () => Promise<void>;
+    applyUserSettings: (userSettings: Partial<UserSettings>) => Promise<void>;
     scroll: (value: boolean) => Promise<void>;
     private isTTSIncrementable;
     private isMOIncrementable;
@@ -125,11 +155,16 @@ export default class D2Reader {
      * TTS Settings
      */
     resetTTSSettings: () => void;
-    applyTTSSettings: (ttsSettings: ITTSUserSettings) => void;
-    applyTTSSetting: (key: string, value: any) => void;
-    applyPreferredVoice: (value: string) => void;
+    applyTTSSettings: (ttsSettings: Partial<ITTSUserSettings>) => Promise<void>;
+    /**
+     * Disabled
+     */
+    applyPreferredVoice: (value: string) => Promise<void>;
+    /**
+     * Media Overlay Settings
+     */
     resetMediaOverlaySettings: () => Promise<void>;
-    applyMediaOverlaySettings: (settings: IMediaOverlayUserSettings) => Promise<void>;
+    applyMediaOverlaySettings: (settings: Partial<IMediaOverlayUserSettings>) => Promise<void>;
     /**
      * Navigation
      * @TODO : These should return promises that complete when they are done.
@@ -138,18 +173,24 @@ export default class D2Reader {
     get positions(): any;
     goTo: (locator: Locator) => Promise<void>;
     goToPosition: (value: number) => Promise<void>;
-    nextResource: () => Promise<void>;
-    previousResource: () => Promise<void>;
+    nextResource: () => void;
+    previousResource: () => void;
     nextPage: () => Promise<void>;
     previousPage: () => Promise<void>;
-    atStart: () => Promise<boolean>;
-    atEnd: () => Promise<boolean>;
-    snapToElement: (value: HTMLElement) => 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

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

@@ -1,23 +1,22 @@
 import { ReadingPosition } from "../model/Locator";
 import { IHighlight } from "../modules/highlight/common/highlight";
-import { IReadiumIFrameWindow } from "../modules/highlight/renderer/iframe/state";
 interface Annotator {
-    initLastReadingPosition(position: ReadingPosition): Promise<void>;
-    getLastReadingPosition(): Promise<any>;
-    saveLastReadingPosition(position: any): Promise<void>;
-    initBookmarks(list: any): Promise<any>;
-    saveBookmark(bookmark: any): Promise<any>;
-    deleteBookmark(bookmark: any): Promise<any>;
-    getBookmarks(href?: string): Promise<any>;
-    locatorExists(locator: any, type: AnnotationType): Promise<any>;
-    initAnnotations(list: any): Promise<any>;
-    saveAnnotation(annotation: any): Promise<any>;
-    deleteAnnotation(id: any): Promise<any>;
-    deleteSelectedAnnotation(annotation: any): Promise<any>;
-    getAnnotations(): Promise<any>;
-    getAnnotation(annotation: IHighlight): Promise<any>;
-    getAnnotationByID(id: string): Promise<any>;
-    getAnnotationPosition(id: any, iframeWin: IReadiumIFrameWindow): Promise<any>;
+    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,

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

@@ -1,7 +1,6 @@
 import Annotator, { AnnotationType } from "./Annotator";
 import Store from "./Store";
 import { ReadingPosition } from "../model/Locator";
-import { IReadiumIFrameWindow } from "../modules/highlight/renderer/iframe/state";
 import { IHighlight } from "../modules/highlight/common/highlight";
 export interface LocalAnnotatorConfig {
     store: Store;
@@ -13,20 +12,20 @@ export default class LocalAnnotator implements Annotator {
     private static readonly BOOKMARKS;
     private static readonly ANNOTATIONS;
     constructor(config: LocalAnnotatorConfig);
-    getLastReadingPosition(): Promise<any>;
-    initLastReadingPosition(position: ReadingPosition): Promise<void>;
-    saveLastReadingPosition(position: any): Promise<void>;
-    initBookmarks(list: any): Promise<any>;
-    saveBookmark(bookmark: any): Promise<any>;
-    locatorExists(locator: any, type: AnnotationType): Promise<any>;
-    deleteBookmark(bookmark: any): Promise<any>;
-    getBookmarks(href?: string): Promise<any>;
-    initAnnotations(list: any): Promise<any>;
-    saveAnnotation(annotation: any): Promise<any>;
-    deleteAnnotation(id: any): Promise<any>;
-    deleteSelectedAnnotation(annotation: any): Promise<any>;
-    getAnnotations(): Promise<any>;
-    getAnnotationPosition(id: any, iframeWin: IReadiumIFrameWindow): Promise<any>;
-    getAnnotation(highlight: IHighlight): Promise<any>;
-    getAnnotationByID(id: string): Promise<any>;
+    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/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/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

@@ -1,6 +1,6 @@
 interface Store {
-    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;
 }
 export default Store;