@readium/navigator 2.1.0 → 2.2.0

package/types/src/epub/preferences/EpubSettings.d.ts

@@ -1,5 +1,5 @@
 import { ConfigurableSettings } from "../../preferences/Configurable";
-import { TextAlignment, Theme } from "../../preferences/Types";
+import { TextAlignment } from "../../preferences/Types";
 import { EpubDefaults } from "./EpubDefaults";
 import { EpubPreferences } from "./EpubPreferences";
 export interface IEpubSettings {
@@ -39,7 +39,6 @@ export interface IEpubSettings {
     textAlign?: TextAlignment | null;
     textColor?: string | null;
     textNormalization?: boolean | null;
-    theme?: Theme | null;
     visitedColor?: string | null;
     wordSpacing?: number | null;
 }
@@ -80,7 +79,6 @@ export declare class EpubSettings implements ConfigurableSettings {
     textAlign: TextAlignment | null;
     textColor: string | null;
     textNormalization: boolean | null;
-    theme: Theme | null;
     visitedColor: string | null;
     wordSpacing: number | null;
     constructor(preferences: EpubPreferences, defaults: EpubDefaults);

package/types/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from './Navigator';
+export * from './webpub';
 export * from './epub';
 export * from './audio';
 export * from './helpers';

package/types/src/preferences/Types.d.ts

@@ -4,11 +4,6 @@ export declare enum TextAlignment {
     right = "right",
     justify = "justify"
 }
-export declare enum Theme {
-    sepia = "sepia",
-    night = "night",
-    custom = "custom"
-}
 export type RangeConfig = {
     range: [number, number];
     step: number;

package/types/src/web/WebPubBlobBuilder.d.ts

@@ -0,0 +1,10 @@
+import { Link, Publication } from "@readium/shared";
+export declare class WebPubBlobBuilder {
+    private readonly item;
+    private readonly publication;
+    constructor(publication: Publication, item: Link);
+    build(): Promise<string>;
+    private buildHtmlFrame;
+    private serializeAsHTML;
+    private hasExecutable;
+}

package/types/src/web/WebPubFrameManager.d.ts

@@ -0,0 +1,20 @@
+import { Loader } from "../../../navigator-html-injectables/src/Loader";
+import { FrameComms } from "../../../navigator/src/epub/frame/FrameComms";
+export declare class WebPubFrameManager {
+    private frame;
+    private loader;
+    readonly source: string;
+    private comms;
+    private destroyed;
+    private currModules;
+    constructor(source: string);
+    load(modules?: string[]): Promise<Window>;
+    destroy(): Promise<void>;
+    get iframe(): HTMLIFrameElement;
+    get realSize(): DOMRect;
+    get window(): Window;
+    get atLeft(): boolean;
+    get atRight(): boolean;
+    get msg(): FrameComms | undefined;
+    get ldr(): Loader<import("../../../navigator-html-injectables/src/modules/ModuleLibrary").ModuleName> | undefined;
+}

package/types/src/web/WebPubNavigator.d.ts

@@ -0,0 +1,48 @@
+import { Link, Locator, Publication, ReadingProgression } from "@readium/shared";
+import { VisualNavigator, VisualNavigatorViewport } from "../Navigator";
+import { BasicTextSelection, FrameClickEvent } from '@readium/navigator-html-injectables';
+export interface WebPubNavigatorListeners {
+    frameLoaded: (wnd: Window) => void;
+    positionChanged: (locator: Locator) => void;
+    tap?: (e: FrameClickEvent) => boolean;
+    click?: (e: FrameClickEvent) => boolean;
+    zoom?: (scale: number) => void;
+    scroll?: (delta: number) => void;
+    customEvent?: (key: string, data: unknown) => void;
+    handleLocator?: (locator: Locator) => boolean;
+    textSelected?: (selection: BasicTextSelection) => void;
+}
+export declare class WebPubNavigator extends VisualNavigator {
+    private readonly pub;
+    private readonly container;
+    private readonly listeners;
+    private frameManager;
+    private currentIndex;
+    private currentLocation;
+    private currentBlobUrl;
+    private webViewport;
+    constructor(container: HTMLElement, pub: Publication, listeners?: Partial<WebPubNavigatorListeners>, initialPosition?: Locator | undefined);
+    load(): Promise<void>;
+    private eventListener;
+    private attachListener;
+    private apply;
+    destroy(): void;
+    private changeResource;
+    private updateViewport;
+    private syncLocation;
+    goBackward(_animated: boolean, cb: (ok: boolean) => void): void;
+    goForward(_animated: boolean, cb: (ok: boolean) => void): void;
+    get currentLocator(): Locator;
+    get viewport(): VisualNavigatorViewport;
+    get isScrollStart(): boolean;
+    get isScrollEnd(): boolean;
+    get canGoBackward(): boolean;
+    get canGoForward(): boolean;
+    get readingProgression(): ReadingProgression;
+    get publication(): Publication;
+    private loadLocator;
+    go(locator: Locator, _animated: boolean, cb: (ok: boolean) => void): void;
+    goLink(link: Link, _animated: boolean, cb: (ok: boolean) => void): void;
+    private frameUpdate;
+    private createCurrentLocator;
+}

package/types/src/web/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./WebPubNavigator";
+export * from "./WebPubBlobBuilder";
+export * from "./WebPubFrameManager";

package/types/src/webpub/WebPubBlobBuilder.d.ts

@@ -0,0 +1,12 @@
+import { Link, Publication } from "@readium/shared";
+export declare class WebPubBlobBuilder {
+    private readonly item;
+    private readonly burl;
+    private readonly pub;
+    constructor(pub: Publication, baseURL: string, item: Link);
+    build(): Promise<string>;
+    private buildHtmlFrame;
+    private hasExecutable;
+    private finalizeDOM;
+    private serializeAsHTML;
+}

package/types/src/webpub/WebPubFrameManager.d.ts

@@ -0,0 +1,20 @@
+import { Loader, ModuleName } from "@readium/navigator-html-injectables";
+import { FrameComms } from "../epub/frame/FrameComms";
+export declare class WebPubFrameManager {
+    private frame;
+    private loader;
+    readonly source: string;
+    private comms;
+    private destroyed;
+    private currModules;
+    constructor(source: string);
+    load(modules?: ModuleName[]): Promise<Window>;
+    destroy(): Promise<void>;
+    hide(): Promise<void>;
+    show(atProgress?: number): Promise<void>;
+    get iframe(): HTMLIFrameElement;
+    get realSize(): DOMRect;
+    get window(): Window;
+    get msg(): FrameComms | undefined;
+    get ldr(): Loader<ModuleName> | undefined;
+}

package/types/src/webpub/WebPubFramePoolManager.d.ts

@@ -0,0 +1,16 @@
+import { ModuleName } from "@readium/navigator-html-injectables";
+import { Locator, Publication } from "@readium/shared";
+import { WebPubFrameManager } from "./WebPubFrameManager";
+export declare class WebPubFramePoolManager {
+    private readonly container;
+    private _currentFrame;
+    private readonly pool;
+    private readonly blobs;
+    private readonly inprogress;
+    private currentBaseURL;
+    constructor(container: HTMLElement);
+    destroy(): Promise<void>;
+    update(pub: Publication, locator: Locator, modules: ModuleName[]): Promise<void>;
+    get currentFrames(): (WebPubFrameManager | undefined)[];
+    get currentBounds(): DOMRect;
+}

package/types/src/webpub/WebPubNavigator.d.ts

@@ -0,0 +1,50 @@
+import { Link, Locator, Publication, ReadingProgression } from "@readium/shared";
+import { VisualNavigator, VisualNavigatorViewport } from "../Navigator";
+import { BasicTextSelection, CommsEventKey, FrameClickEvent } from "@readium/navigator-html-injectables";
+import { ManagerEventKey } from "../epub/EpubNavigator";
+export interface WebPubNavigatorListeners {
+    frameLoaded: (wnd: Window) => void;
+    positionChanged: (locator: Locator) => void;
+    tap: (e: FrameClickEvent) => boolean;
+    click: (e: FrameClickEvent) => boolean;
+    zoom: (scale: number) => void;
+    scroll: (delta: number) => void;
+    customEvent: (key: string, data: unknown) => void;
+    handleLocator: (locator: Locator) => boolean;
+    textSelected: (selection: BasicTextSelection) => void;
+}
+declare class WebPubNavigator extends VisualNavigator {
+    private readonly pub;
+    private readonly container;
+    private readonly listeners;
+    private framePool;
+    private currentIndex;
+    private currentLocation;
+    private webViewport;
+    constructor(container: HTMLElement, pub: Publication, listeners: WebPubNavigatorListeners, initialPosition?: Locator | undefined);
+    load(): Promise<void>;
+    eventListener(key: CommsEventKey | ManagerEventKey, data: unknown): void;
+    private determineModules;
+    private attachListener;
+    private apply;
+    destroy(): Promise<void>;
+    private changeResource;
+    private updateViewport;
+    private syncLocation;
+    goBackward(_animated: boolean, cb: (ok: boolean) => void): void;
+    goForward(_animated: boolean, cb: (ok: boolean) => void): void;
+    get currentLocator(): Locator;
+    get viewport(): VisualNavigatorViewport;
+    get isScrollStart(): boolean;
+    get isScrollEnd(): boolean;
+    get canGoBackward(): boolean;
+    get canGoForward(): boolean;
+    get readingProgression(): ReadingProgression;
+    get publication(): Publication;
+    private loadLocator;
+    go(locator: Locator, _: boolean, cb: (ok: boolean) => void): void;
+    goLink(link: Link, animated: boolean, cb: (ok: boolean) => void): void;
+    private createCurrentLocator;
+}
+export declare const ExperimentalWebPubNavigator: typeof WebPubNavigator;
+export {};

package/types/src/webpub/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./WebPubNavigator";
+export * from "./WebPubBlobBuilder";
+export * from "./WebPubFrameManager";
+export * from "./WebPubFramePoolManager";