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

package/dist/modules/syncnarration/SyncSettings.d.ts

@@ -1,67 +0,0 @@
-import Store from "../../store/Store";
-import { UserProperty, UserProperties } from "../../model/user-settings/UserProperties";
-import { SynchronizedNarrationModuleAPI, SynchronizedNarrationModuleProperties } from "./SynchronizedNarrationModule";
-export declare const R2_MO_CLASS_ACTIVE = "r2-mo-active";
-export declare class SYNCREFS {
-    static readonly COLOR_REF = "color";
-    static readonly AUTO_SCROLL_REF = "autoscroll";
-    static readonly AUTO_TURN_REF = "autoturn";
-    static readonly VOLUME_REF = "volume";
-    static readonly COLOR_KEY: string;
-    static readonly AUTO_SCROLL_KEY: string;
-    static readonly AUTO_TURN_KEY: string;
-    static readonly VOLUME_KEY: string;
-}
-export interface SyncConfig {
-    store: Store;
-    initialSyncSettings: SynchronizedNarrationModuleProperties;
-    headerMenu: HTMLElement;
-    api: SynchronizedNarrationModuleAPI;
-}
-export interface ISyncUserSettings {
-    color?: string;
-    autoScroll?: boolean;
-    autoTurn?: boolean;
-    volume?: number;
-    playing?: boolean;
-    wait?: number;
-}
-export declare class SyncSettings implements ISyncUserSettings {
-    private readonly store;
-    private readonly SYNCSETTINGS;
-    color: string;
-    autoScroll: boolean;
-    autoTurn: boolean;
-    volume: number;
-    playing: boolean;
-    wait: number;
-    userProperties: UserProperties;
-    private settingsChangeCallback;
-    private settingsView;
-    private readonly headerMenu;
-    private volumeButtons;
-    private speechAutoScroll;
-    private speechAutoTurn;
-    private speechVolume;
-    private readonly api;
-    static create(config: SyncConfig): Promise<any>;
-    protected constructor(store: Store, headerMenu: HTMLElement, api: SynchronizedNarrationModuleAPI);
-    stop(): Promise<void>;
-    private initialise;
-    private reset;
-    private initializeSelections;
-    setControls(): void;
-    private renderControls;
-    onSettingsChange(callback: () => void): void;
-    private setupEvents;
-    private storeProperty;
-    private updateUserSettings;
-    private getSyncSettings;
-    private saveProperty;
-    getProperty(name: string): Promise<UserProperty>;
-    resetSyncSettings(): Promise<void>;
-    applySyncSettings(syncSettings: ISyncUserSettings): Promise<void>;
-    applySyncSetting(key: any, value: any): Promise<void>;
-    increase(incremental: string): Promise<void>;
-    decrease(incremental: string): Promise<void>;
-}

package/dist/modules/syncnarration/SynchronizedNarrationModule.d.ts

@@ -1,81 +0,0 @@
-import { Publication } from "../../model/Publication";
-import IFrameNavigator from "../../navigator/IFrameNavigator";
-import ReaderModule from "../ReaderModule";
-import { Link } from "../../model/Link";
-import { MediaOverlayNode } from "../../model/MediaOverlayNode";
-import { SyncSettings } from "./SyncSettings";
-export interface SynchronizedNarrationModuleAPI {
-    started: any;
-    stopped: any;
-    paused: any;
-    resumed: any;
-    finished: any;
-    updateSettings: any;
-}
-export interface SynchronizedNarrationModuleProperties {
-    color?: string;
-    autoScroll?: boolean;
-    autoTurn?: boolean;
-    volume?: number;
-    wait?: number;
-}
-export interface SynchronizedNarrationModuleConfig extends SynchronizedNarrationModuleProperties {
-    publication: Publication;
-    delegate: IFrameNavigator;
-    api: SynchronizedNarrationModuleAPI;
-    settings: SyncSettings;
-}
-export declare enum MediaOverlaysStateEnum {
-    PAUSED = "PAUSED",
-    PLAYING = "PLAYING",
-    STOPPED = "STOPPED"
-}
-export default class SynchronizedNarrationModule implements ReaderModule {
-    private publication;
-    private delegate;
-    private audioElement;
-    private settings;
-    private play;
-    private pause;
-    static create(config: SynchronizedNarrationModuleConfig): Promise<SynchronizedNarrationModule>;
-    private constructor();
-    stop(): Promise<void>;
-    protected start(): Promise<void>;
-    _currentAudioBegin: number | undefined;
-    _currentAudioEnd: number | undefined;
-    currentLinks: Array<Link>;
-    currentLinkIndex: number;
-    initializeResource(links: Array<Link>): Promise<void>;
-    private playLink;
-    startReadAloud(): Promise<void>;
-    stopReadAloud(): void;
-    pauseReadAloud(): void;
-    resumeReadAloud(): Promise<void>;
-    findDepthFirstTextAudioPair(textHref: string, mo: MediaOverlayNode, textFragmentIDChain: Array<string | null> | undefined): MediaOverlayNode | undefined | null;
-    ontimeupdate: (ev: Event) => Promise<void>;
-    ensureOnTimeUpdate: (remove: boolean) => void;
-    _mediaOverlaysPlaybackRate: number;
-    _currentAudioUrl: string | undefined;
-    _previousAudioUrl: string | undefined;
-    _previousAudioEnd: number | undefined;
-    _mediaOverlayRoot: MediaOverlayNode | undefined;
-    _mediaOverlayTextAudioPair: MediaOverlayNode | undefined;
-    _mediaOverlayTextId: string | undefined;
-    _mediaOverlayTextHref: string | undefined;
-    _mediaOverlayActive: boolean;
-    _mediaOverlaysListener: ((mediaOverlaysState: MediaOverlaysStateEnum) => void) | undefined;
-    mediaOverlaysListen(mediaOverlaysListener: (mediaOverlaysState: MediaOverlaysStateEnum) => void): void;
-    mediaOverlaysNext(escape?: boolean): void;
-    mediaOverlaysStop(stayActive?: boolean): void;
-    pid: string;
-    findNextTextAudioPair(mo: MediaOverlayNode, moToMatch: MediaOverlayNode, previousMo: {
-        prev: MediaOverlayNode | undefined;
-    }, escape: boolean): MediaOverlayNode | undefined | null;
-    playMediaOverlaysAudio(moTextAudioPair: MediaOverlayNode, begin: number | undefined, end: number | undefined): Promise<void>;
-    mediaOverlaysPause(): void;
-    moHighlight(href: string | undefined, id: string | undefined): void;
-    _timeoutAutoNext: number | undefined;
-    ensureKillAutoNextTimeout(): void;
-    playMediaOverlays(textHref: string, rootMo: MediaOverlayNode, textFragmentIDChain: Array<string | null> | undefined): Promise<void>;
-    initialize(): Promise<void>;
-}

package/dist/reader.js.LICENSE.txt

@@ -1,66 +0,0 @@
-/*!
- * Materialize v1.0.0 (http://materializecss.com)
- * Copyright 2014-2017 Materialize
- * MIT License (https://raw.githubusercontent.com/Dogfalo/materialize/master/LICENSE)
- */
-
-/*!
- * is-plain-object <https://github.com/jonschlinkert/is-plain-object>
- *
- * Copyright (c) 2014-2017, Jon Schlinkert.
- * Released under the MIT License.
- */
-
-/*! *****************************************************************************
-Copyright (C) Microsoft. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-***************************************************************************** */
-
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-/*! cash-dom 1.3.5, https://github.com/kenwheeler/cash @license MIT */
-
-/*! https://mths.be/cssesc v3.0.0 by @mathias */
-
-/**
- * Get time in ms
- * @license https://raw.github.com/jashkenas/underscore/master/LICENSE
- * @type {function}
- * @return {number}
- */
-
-/**
- * Returns a function, that, when invoked, will only be triggered at most once
- * during a given window of time. Normally, the throttled function will run
- * as much as it can, without ever going more than once per `wait` duration;
- * but if you'd like to disable the execution on the leading edge, pass
- * `{leading: false}`. To disable execution on the trailing edge, ditto.
- * @license https://raw.github.com/jashkenas/underscore/master/LICENSE
- * @param {function} func
- * @param {number} wait
- * @param {Object=} options
- * @returns {Function}
- */

package/dist/store/Annotator.d.ts

@@ -1,25 +0,0 @@
-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>;
-    getAnnotationPosition(id: any, iframeWin: IReadiumIFrameWindow): Promise<any>;
-}
-export declare enum AnnotationType {
-    Bookmark = 0,
-    Annotation = 1
-}
-export default Annotator;

package/dist/store/LocalAnnotator.d.ts

@@ -1,31 +0,0 @@
-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;
-}
-/** 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(): 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>;
-}

package/dist/store/Store.d.ts

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

package/dist/utils/EventHandler.d.ts

@@ -1,9 +0,0 @@
-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 {
-    onInternalLink: (event: UIEvent) => void;
-    onClickThrough: (event: UIEvent) => void;
-    setupEvents(element: HTMLElement | Document | null): void;
-    private checkForLink;
-    private handleLinks;
-}

package/dist/utils/HTMLTemplates.d.ts

@@ -1,4 +0,0 @@
-export declare const simpleUpLinkTemplate: (href: string, _label: string, ariaLabel: string) => string;
-export declare const defaultUpLinkTemplate: (href: string, label: string, ariaLabel: string) => string;
-export declare const readerLoading: string;
-export declare const readerError: string;

package/dist/utils/KeyboardEventHandler.d.ts

@@ -1,7 +0,0 @@
-import IFrameNavigator from "../navigator/IFrameNavigator";
-export default class KeyboardEventHandler {
-    delegate: IFrameNavigator;
-    onBackwardSwipe: (event: UIEvent) => void;
-    onForwardSwipe: (event: UIEvent) => void;
-    setupEvents: (element: HTMLElement | Document) => void;
-}

package/dist/utils/decodeURI.d.ts

@@ -1 +0,0 @@
-export declare function tryDecodeURI(url: string | undefined): string | null;