@d-i-t-a/reader 1.11.0 → 1.11.3

package/dist/store/LocalPositions.d.ts

@@ -0,0 +1,18 @@
+import Store from "./Store";
+import Positions from "./Positions";
+export interface LocalAnnotatorConfig {
+    store: Store;
+}
+/** Annotator that stores annotations locally, in the browser. */
+export default class LocalPositions implements Positions {
+    private readonly store;
+    private static readonly POSITIONS;
+    private static readonly WEIGHT;
+    constructor(config: LocalAnnotatorConfig);
+    savePositions(positions: any): Promise<any>;
+    deletePositions(): Promise<any>;
+    getPositions(): Promise<any>;
+    saveWeights(weights: any): Promise<any>;
+    deleteWeights(): Promise<any>;
+    getWeights(): Promise<any>;
+}

package/dist/store/Positions.d.ts

@@ -0,0 +1,9 @@
+interface Positions {
+    savePositions(positions: any): Promise<any>;
+    deletePositions(): Promise<any>;
+    getPositions(): Promise<any>;
+    saveWeights(weights: any): Promise<any>;
+    deleteWeights(): Promise<any>;
+    getWeights(): Promise<any>;
+}
+export default Positions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-i-t-a/reader",
-  "version": "1.11.0",
+  "version": "1.11.3",
   "description": "A viewer application for EPUB files.",
   "repository": "https://github.com/d-i-t-a/R2D2BC",
   "license": "Apache-2.0",
@@ -21,7 +21,8 @@
     "streamed": "node \"./examples/streamed/server/server-cli.inlinesourcemap.js\" ./examples/streamed/epubs/",
     "clean": "rimraf node_modules lib dist examples/streamed/readers/viewer",
     "start": "http-server viewer",
-    "lint": "eslint '*/**/*.{js,ts,tsx}' --quiet --fix"
+    "lint": "eslint '*/**/*.{js,ts,tsx}' --quiet --fix",
+    "serve": "npm run build && npm run examples && npm run streamed"
   },
   "dependencies": {
     "browserslist-useragent": "^3.0.3",

package/NOTICE

@@ -1,20 +0,0 @@
-R2D2BC
-Copyright 2018-2020 DITA (AM Consulting LLC)
-
-This project bundles the following dependencies under the MIT license.
-See bundled license files for details.
-
-- Materialize | Copyright (c) 2014-2018 Materialize
-	-> in "styles/sass/materialize"
-
-This project bundles the following dependencies under the SIL Open Font License.
-See bundled license files for details.
-
-- OpenDyxslexic Font | Copyright (c) 12/2012 - 2019
-    -> in "viewer/fonts/opendyslexic"
-
-This project bundles the following dependencies under the BSD license.
-See bundled license files for details.
-
-- Readium-CSS | Copyright (c) 2017, Readium
-    -> in "viewer/readium-css"

package/dist/injectables/footnotes/footnotes.js.LICENSE.txt

@@ -1,6 +0,0 @@
-/*!
- * is-plain-object <https://github.com/jonschlinkert/is-plain-object>
- *
- * Copyright (c) 2014-2017, Jon Schlinkert.
- * Released under the MIT License.
- */

package/dist/modules/citations/CitationModule.d.ts

@@ -1,37 +0,0 @@
-import { Publication } from "../../model/Publication";
-import IFrameNavigator from "../../navigator/IFrameNavigator";
-import ReaderModule from "../ReaderModule";
-export declare enum CitationStyle {
-    Chicago = 0,
-    MLA = 1,
-    APA = 2
-}
-export declare enum ContributorType {
-    Author = "Author",
-    Editor = "Editor",
-    Translator = "Translator",
-    Compiler = "Compiler"
-}
-export interface CitationModuleProperties {
-    characters: number;
-    appName: string;
-    appLink: string;
-    library: string;
-    styles: string[];
-}
-export interface CitationModuleConfig extends CitationModuleProperties {
-    publication: Publication;
-    delegate: IFrameNavigator;
-}
-export default class CitationModule implements ReaderModule {
-    private publication;
-    private delegate;
-    private properties;
-    static create(config: CitationModuleConfig): Promise<CitationModule>;
-    private constructor();
-    stop(): Promise<void>;
-    protected start(): Promise<void>;
-    copyToClipboard(textToClipboard: any): void;
-    createElementForExecCommand(textToClipboard: any): HTMLDivElement;
-    selectContent(element: any): void;
-}

package/dist/modules/highlight/TextHighlighterFXL.d.ts

@@ -1,278 +0,0 @@
-import { HighlightType, IHighlight, IMarkerIcon, IPopupStyle, IStyle, SelectionMenuItem } from "./common/highlight";
-import { ISelectionInfo } from "./common/selection";
-import { IRectSimple } from "./common/rect-utils";
-import { IReadiumIFrameWindow } from "./renderer/iframe/state";
-import { AnnotationMarker } from "../../model/Locator";
-import IFrameNavigator from "../../navigator/IFrameNavigator";
-import { Definition } from "../search/DefinitionsModule";
-export declare const ID_HIGHLIGHTS_CONTAINER = "R2_ID_HIGHLIGHTS_CONTAINER";
-export declare const ID_READALOUD_CONTAINER = "R2_ID_READALOUD_CONTAINER";
-export declare const ID_POPUP_CONTAINER = "R2_ID_POPUP_CONTAINER";
-export declare const CLASS_HIGHLIGHT_CONTAINER = "R2_CLASS_HIGHLIGHT_CONTAINER";
-export declare const CLASS_HIGHLIGHT_AREA = "R2_CLASS_HIGHLIGHT_AREA";
-export declare const CLASS_HIGHLIGHT_ICON = "R2_CLASS_HIGHLIGHT_ICON";
-export declare const CLASS_HIGHLIGHT_BOUNDING_AREA = "R2_CLASS_HIGHLIGHT_BOUNDING_AREA";
-export declare const _highlights: IHighlight[];
-interface IWithRect {
-    rect: IRectSimple;
-    scale: number;
-}
-export interface TextSelectorAPI {
-    selectionMenuOpen: any;
-    selectionMenuClose: any;
-    selection: any;
-}
-export interface IHTMLDivElementWithRect extends HTMLDivElement, IWithRect {
-}
-export interface HTMLElementRect {
-    node: Element;
-    height: number;
-    top: number;
-    width: number;
-    left: number;
-    textContent: string;
-}
-export interface TextHighlighterProperties {
-    selectionMenuItems: Array<SelectionMenuItem>;
-}
-export interface TextHighlighterConfig extends TextHighlighterProperties {
-    delegate: IFrameNavigator;
-    api: TextSelectorAPI;
-}
-export default class TextHighlighterFXL {
-    private options;
-    private readonly delegate;
-    private lastSelectedHighlight;
-    properties: TextHighlighterProperties;
-    private api;
-    private hasEventListener;
-    activeAnnotationMarkerId?: string;
-    static create(config: TextHighlighterConfig): Promise<any>;
-    private constructor();
-    initialize(): Promise<void>;
-    /**
-     * Returns true if elements a i b have the same color.
-     * @param {Node} a
-     * @param {Node} b
-     * @returns {boolean}
-     */
-    haveSameColor(a: any, b: any): boolean;
-    /**
-     * Fills undefined values in obj with default properties with the same name from source object.
-     * @param {object} obj - target object
-     * @param {object} source - source object with default values
-     * @returns {object}
-     */
-    defaults(obj: {
-        [x: string]: any;
-    }, source: {
-        [x: string]: any;
-        color?: string;
-        highlightedClass?: string;
-        contextClass?: string;
-        onBeforeHighlight?: () => boolean;
-        onAfterHighlight?: () => void;
-        container?: any;
-        andSelf?: boolean;
-        grouped?: boolean;
-        hasOwnProperty?: any;
-    }): object;
-    /**
-     * Returns array without duplicated values.
-     * @param {Array} arr
-     * @returns {Array}
-     */
-    unique(arr: {
-        filter: (arg0: (value: any, idx: any, self: any) => boolean) => void;
-    }): void;
-    /**
-     * Takes range object as parameter and refines it boundaries
-     * @param range
-     * @returns {object} refined boundaries and initial state of highlighting algorithm.
-     */
-    refineRangeBoundaries(range: {
-        startContainer: any;
-        endContainer: any;
-        commonAncestorContainer: any;
-        endOffset: number;
-        startOffset: number;
-    }): object;
-    /**
-     * Sorts array of DOM elements by its depth in DOM tree.
-     * @param {HTMLElement[]} arr - array to sort.
-     * @param {boolean} descending - order of sort.
-     */
-    sortByDepth(arr: {
-        sort: (arg0: (a: any, b: any) => number) => void;
-    }, descending: boolean): void;
-    /**
-     * Groups given highlights by timestamp.
-     * @param {Array} highlights
-     * @returns {Array} Grouped highlights.
-     */
-    groupHighlights(highlights: {
-        forEach: (arg0: (hl: any) => void) => void;
-    }): Array<any>;
-    /**
-     * Utility functions to make DOM manipulation easier.
-     * @param {Node|HTMLElement} [el] - base DOM element to manipulate
-     * @returns {object}
-     */
-    dom(el?: any): any;
-    disableContext(e: {
-        preventDefault: () => void;
-        stopPropagation: () => void;
-    }): boolean;
-    bindEvents(el: any, _scope: any, hasEventListener: boolean): void;
-    unbindEvents(el: any, _scope: any): void;
-    /**
-     * Permanently disables highlighting.
-     * Unbinds events and remove context element class.
-     * @memberof TextHighlighter
-     */
-    destroy(): void;
-    initializeToolbox(): void;
-    toolboxMode(mode: "colors" | "edit" | "add" | "action"): void;
-    toolboxHide(): void;
-    toolboxShowDelayed(): void;
-    snapSelectionToWord(): any;
-    toolboxShow(): void;
-    isSelectionMenuOpen: boolean;
-    selectionMenuOpened: (() => void) & {
-        clear(): void;
-    };
-    selectionMenuClosed: (() => void) & {
-        clear(): void;
-    };
-    selection: ((text: any, selection: any) => void) & {
-        clear(): void;
-    };
-    toolboxPlacement(): void;
-    toolboxHandler(): void;
-    /**
-     * Highlights current range.
-     * @param {boolean} keepRange - Don't remove range after highlighting. Default: false.
-     * @param marker
-     * @memberof TextHighlighter
-     */
-    doHighlight(iframe: any, keepRange?: boolean, marker?: AnnotationMarker): void;
-    speak(iframe: any): void;
-    stopReadAloud(): void;
-    speakAll(iframe: any): void;
-    callbackComplete(): void;
-    visibleTextRects(iframe: any): HTMLElementRect[];
-    doneSpeaking(reload?: boolean): void;
-    /**
-     * Normalizes highlights. Ensures that highlighting is done with use of the smallest possible number of
-     * wrapping HTML elements.
-     * Flattens highlights structure and merges sibling highlights. Normalizes text nodes within highlights.
-     * @param {Array} highlights - highlights to normalize.
-     * @returns {Array} - array of normalized highlights. Order and number of returned highlights may be different than
-     * input highlights.
-     * @memberof TextHighlighter
-     */
-    normalizeHighlights(highlights: any): any;
-    /**
-     * Flattens highlights structure.
-     * Note: this method changes input highlights - their order and number after calling this method may change.
-     * @param {Array} highlights - highlights to flatten.
-     * @memberof TextHighlighter
-     */
-    flattenNestedHighlights(highlights: any): void;
-    /**
-     * Merges sibling highlights and normalizes descendant text nodes.
-     * Note: this method changes input highlights - their order and number after calling this method may change.
-     * @param highlights
-     * @memberof TextHighlighter
-     */
-    mergeSiblingHighlights(highlights: any): void;
-    /**
-     * Sets highlighting color.
-     * @param {string} color - valid CSS color.
-     * @memberof TextHighlighter
-     */
-    setColor(color: any): void;
-    /**
-     * Returns highlighting color.
-     * @returns {string}
-     * @memberof TextHighlighter
-     */
-    getColor(): string;
-    /**
-     * Returns highlights from given container.
-     * @param params
-     * @param {HTMLElement} [params.container] - return highlights from this element. Default: the element the
-     * highlighter is applied to.
-     * @param {boolean} [params.andSelf] - if set to true and container is a highlight itself, add container to
-     * returned results. Default: true.
-     * @param {boolean} [params.grouped] - if set to true, highlights are grouped in logical groups of highlights added
-     * in the same moment. Each group is an object which has got array of highlights, 'toString' method and 'timestamp'
-     * property. Default: false.
-     * @returns {Array} - array of highlights.
-     * @memberof TextHighlighter
-     */
-    getHighlights(iframe: any, params?: any): Array<any>;
-    /**
-     * Returns true if element is a highlight.
-     * All highlights have 'data-highlighted' attribute.
-     * @param el - element to check.
-     * @returns {boolean}
-     * @memberof TextHighlighter
-     */
-    isHighlight(el: any): boolean;
-    /**
-     * Serializes all highlights in the element the highlighter is applied to.
-     * @returns {string} - stringified JSON with highlights definition
-     * @memberof TextHighlighter
-     */
-    serializeHighlights(iframe: any): string;
-    /**
-     * Deserializes highlights.
-     * @throws exception when can't parse JSON or JSON has invalid structure.
-     * @param {object} json - JSON object with highlights definition.
-     * @returns {Array} - array of deserialized highlights.
-     * @memberof TextHighlighter
-     */
-    deserializeHighlights(iframe: any, json: any): Array<any>;
-    /**
-     * Creates wrapper for highlights.
-     * TextHighlighter instance calls this method each time it needs to create highlights and pass options retrieved
-     * in constructor.
-     * @returns {HTMLElement}
-     * @memberof TextHighlighter
-     * @static
-     */
-    createWrapper(): HTMLElement;
-    static isHexColor(hex: string): boolean;
-    static hexToRgbString(hex: string): any;
-    static hexToRgbChannels(hex: string): {
-        red: number;
-        green: number;
-        blue: number;
-    };
-    static hexToRgbA(hex: string): string;
-    static hexToRgbAWithOpacity(hex: string, opacity: number): string;
-    resetHighlightBoundingStyle(_win: IReadiumIFrameWindow, highlightBounding: HTMLElement): void;
-    resetHighlightAreaStyle(_win: IReadiumIFrameWindow, highlightArea: HTMLElement, id_container: string): void;
-    setHighlightAreaStyle(_win: IReadiumIFrameWindow, highlightAreas: Array<HTMLElement>, highlight: IHighlight): void;
-    isIOS(): boolean;
-    isAndroid(): boolean;
-    getScrollingElement: (documant: Document) => Element;
-    processMouseEvent(win: IReadiumIFrameWindow, ev: MouseEvent): Promise<void>;
-    ensureHighlightsContainer(win: IReadiumIFrameWindow, id: string): HTMLElement;
-    hideAllhighlights(_documant: Document): void;
-    destroyAllhighlights(documant: Document): void;
-    destroyHighlights(type: HighlightType): void;
-    destroyHighlight(documant: Document, id: string): void;
-    recreateAllHighlightsRaw(win: IReadiumIFrameWindow): void;
-    recreateAllHighlightsDebounced: ((win: IReadiumIFrameWindow) => void) & {
-        clear(): void;
-    };
-    recreateAllHighlights(win: IReadiumIFrameWindow): void;
-    createPopupHighlight(iframe: any, selectionInfo: ISelectionInfo, item: Definition): IHighlight;
-    createSearchHighlight(iframe: any, selectionInfo: ISelectionInfo, color: string): IHighlight;
-    createPageBreakHighlight(iframe: any, selectionInfo: ISelectionInfo, title: string): IHighlight;
-    createHighlight(win: IReadiumIFrameWindow, selectionInfo: ISelectionInfo, color: string | undefined, pointerInteraction: boolean, marker: AnnotationMarker, icon?: IMarkerIcon | undefined, popup?: IPopupStyle | undefined, style?: IStyle | undefined, type?: HighlightType | undefined, prefix?: string | undefined): [IHighlight, HTMLDivElement];
-    createHighlightDom(win: IReadiumIFrameWindow, highlight: IHighlight): HTMLDivElement | undefined;
-}
-export {};