@readium/navigator 2.6.1 → 2.7.0-alpha.1

package/types/src/divina/preferences/DivinaPreferences.d.ts

@@ -0,0 +1,33 @@
+import { ConfigurablePreferences } from "../../preferences/Configurable.ts";
+import { RangeConfig } from "../../preferences/Types.ts";
+import { DivinaQuality } from "../DivinaVariantSelector.ts";
+/**
+ * Maximum width in pixels of the vertical strip in scrolled mode.
+ */
+export declare const stripWidthRangeConfig: RangeConfig;
+export interface IDivinaPreferences {
+    /** Background color behind the pages (equivalent of the EPUB page background theme) */
+    backgroundColor?: string | null;
+    /** Number of pixels to constrain the container width by (e.g. for docked panels) */
+    constraint?: number | null;
+    /** Image quality when the publication offers alternate resolutions */
+    quality?: DivinaQuality | null;
+    /** Display the publication as a vertical scroll instead of horizontal pages */
+    scrolled?: boolean | null;
+    /** Display two pages side-by-side on landscape viewports (paged mode only) */
+    spreads?: boolean | null;
+    /** Maximum width in pixels of the vertical strip in scrolled mode */
+    stripWidth?: number | null;
+}
+export declare class DivinaPreferences implements ConfigurablePreferences<DivinaPreferences> {
+    backgroundColor?: string | null;
+    constraint?: number | null;
+    quality?: DivinaQuality | null;
+    scrolled?: boolean | null;
+    spreads?: boolean | null;
+    stripWidth?: number | null;
+    constructor(preferences?: IDivinaPreferences);
+    static serialize(preferences: DivinaPreferences): string;
+    static deserialize(preferences: string): DivinaPreferences | null;
+    merging(other: DivinaPreferences): DivinaPreferences;
+}

package/types/src/divina/preferences/DivinaPreferencesEditor.d.ts

@@ -0,0 +1,20 @@
+import { Metadata } from "@readium/shared";
+import { IPreferencesEditor } from "../../preferences/PreferencesEditor.ts";
+import { BooleanPreference, EnumPreference, Preference, RangePreference } from "../../preferences/Preference.ts";
+import { DivinaQuality } from "../DivinaVariantSelector.ts";
+import { DivinaPreferences } from "./DivinaPreferences.ts";
+import { DivinaSettings } from "./DivinaSettings.ts";
+export declare class DivinaPreferencesEditor implements IPreferencesEditor {
+    preferences: DivinaPreferences;
+    private settings;
+    private metadata;
+    constructor(initialPreferences: DivinaPreferences, settings: DivinaSettings, metadata: Metadata);
+    clear(): void;
+    private updatePreference;
+    private get manifestScrolled();
+    get backgroundColor(): Preference<string>;
+    get quality(): EnumPreference<DivinaQuality>;
+    get scrolled(): BooleanPreference;
+    get spreads(): BooleanPreference;
+    get stripWidth(): RangePreference<number>;
+}

package/types/src/divina/preferences/DivinaSettings.d.ts

@@ -0,0 +1,26 @@
+import { ConfigurableSettings } from "../../preferences/Configurable.ts";
+import { DivinaQuality } from "../DivinaVariantSelector.ts";
+import { DivinaDefaults } from "./DivinaDefaults.ts";
+import { DivinaPreferences } from "./DivinaPreferences.ts";
+export interface IDivinaSettings {
+    backgroundColor?: string | null;
+    constraint?: number | null;
+    quality?: DivinaQuality | null;
+    scrolled?: boolean | null;
+    spreads?: boolean | null;
+    stripWidth?: number | null;
+}
+export declare class DivinaSettings implements ConfigurableSettings {
+    backgroundColor: string | null;
+    constraint: number;
+    quality: DivinaQuality;
+    scrolled: boolean;
+    spreads: boolean;
+    stripWidth: number;
+    /**
+     * @param manifestScrolled Whether the publication itself declares `layout: scrolled`.
+     * A natively scrolled publication (e.g. webtoon) cannot be switched to paged mode,
+     * while a fixed publication can be switched to scrolled by the user.
+     */
+    constructor(preferences: DivinaPreferences, defaults: DivinaDefaults, manifestScrolled: boolean);
+}

package/types/src/divina/preferences/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./DivinaDefaults.ts";
+export * from "./DivinaPreferences.ts";
+export * from "./DivinaPreferencesEditor.ts";
+export * from "./DivinaSettings.ts";

package/types/src/divina/protection/DivinaNavigatorProtector.d.ts

@@ -0,0 +1,14 @@
+import { NavigatorProtector } from "../../protection/NavigatorProtector.ts";
+import { IContentProtectionConfig } from "../../Navigator.ts";
+/**
+ * Content protection for the Divina navigator. Because Divina renders images
+ * directly in the host DOM (no iframes), the in-frame halves of the EPUB
+ * protection (copy and drag-and-drop blocking) must run host-side instead,
+ * like the audio navigator does.
+ */
+export declare class DivinaNavigatorProtector extends NavigatorProtector {
+    private dragAndDropProtector?;
+    private copyProtector?;
+    constructor(config?: IContentProtectionConfig);
+    destroy(): void;
+}

package/types/src/epub/EpubNavigator.d.ts

@@ -41,6 +41,7 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
     private readonly container;
     private readonly listeners;
     private framePool;
+    private _destroyed;
     private positions;
     private currentLocation;
     private lastLocationInView;
@@ -70,7 +71,7 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
     private reflowViewport;
     constructor(container: HTMLElement, pub: Publication, listeners: EpubNavigatorListeners, positions?: Locator[], initialPosition?: Locator | undefined, configuration?: EpubNavigatorConfiguration);
     static determineLayout(pub: Publication, scroll?: boolean): Layout;
-    load(): Promise<void>;
+    load(): Promise<unknown>;
     get settings(): Readonly<EpubSettings>;
     get preferencesEditor(): EpubPreferencesEditor;
     submitPreferences(preferences: EpubPreferences): Promise<void>;
@@ -128,6 +129,7 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
     private setLayout;
     get publication(): Publication;
     private loadLocator;
+    private completeLocator;
     go(locator: Locator, _: boolean, cb: (ok: boolean) => void): void;
     goLink(link: Link, animated: boolean, cb: (ok: boolean) => void): void;
 }

package/types/src/epub/frame/FrameBlobBuilder.d.ts

@@ -1,17 +1,20 @@
 import { Link, Publication } from "@readium/shared";
 import { Injector } from "../../injection/Injector.ts";
-export default class FrameBlobBuider {
-    private readonly item;
-    private readonly burl;
+export default class FrameBlobBuilder {
     private readonly pub;
+    private readonly baseURL;
+    private readonly item;
     private readonly cssProperties?;
     private readonly injector;
+    private currentUrl?;
+    private currentResource?;
     constructor(pub: Publication, baseURL: string, item: Link, options: {
         cssProperties?: {
             [key: string]: string;
         };
         injector?: Injector | null;
     });
+    reset(): void;
     build(fxl?: boolean): Promise<string>;
     private buildHtmlFrame;
     private buildImageFrame;

package/types/src/epub/frame/FramePoolManager.d.ts

@@ -16,6 +16,7 @@ export declare class FramePoolManager {
     private readonly injector;
     private readonly contentProtectionConfig;
     private readonly keyboardPeripheralsConfig;
+    private updateSequence;
     constructor(container: HTMLElement, positions: Locator[], cssProperties?: {
         [key: string]: string;
     }, injector?: Injector | null, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);

package/types/src/epub/fxl/FXLFrameManager.d.ts

@@ -5,6 +5,7 @@ import { FXLPeripherals } from "./FXLPeripherals.ts";
 import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../../Navigator.ts";
 export declare class FXLFrameManager {
     private frame;
+    private frameIsAppended;
     private loader;
     source: string;
     private comms;
@@ -17,6 +18,7 @@ export declare class FXLFrameManager {
     debugHref: string;
     private loadPromise;
     private showPromise;
+    private viewportSize;
     constructor(peripherals: FXLPeripherals, direction: ReadingProgression, debugHref: string, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
     load(modules: ModuleName[], source: string): Promise<Window>;
     loadPageSize(): {

package/types/src/epub/fxl/FXLFramePoolManager.d.ts

@@ -1,5 +1,5 @@
 import { ModuleName } from "@readium/navigator-html-injectables";
-import { Locator, Publication, Page, Link } from "@readium/shared";
+import { Locator, Publication, Page, Link, Layout } from "@readium/shared";
 import { FrameCommsListener } from "../frame/index.ts";
 import { FXLFrameManager } from "./FXLFrameManager.ts";
 import { FXLPeripherals } from "./FXLPeripherals.ts";
@@ -32,7 +32,8 @@ export declare class FXLFramePoolManager {
     private containerHeightCached;
     private resizeTimeout;
     readonly peripherals: FXLPeripherals;
-    constructor(container: HTMLElement, positions: Locator[], pub: Publication, injector?: Injector | null, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
+    constructor(container: HTMLElement, positions: Locator[], pub: Publication, _layout: Layout, // TODO: used by upcoming scrolled-layout support
+    injector?: Injector | null, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
     private _listener;
     set listener(listener: FrameCommsListener);
     get listener(): FrameCommsListener;
@@ -51,6 +52,9 @@ export declare class FXLFramePoolManager {
     get threshold(): number;
     get portrait(): boolean;
     updateSpineStyle(animate: boolean, fast?: boolean): void;
+    private bookScale;
+    private bookTranslate;
+    private bookTransform;
     updateBookStyle(initial?: boolean): void;
     /**
      * Go to slide with particular index

package/types/src/epub/fxl/FXLPeripherals.d.ts

@@ -26,6 +26,7 @@ export interface Zoomer {
         Y: number;
     };
 }
+export declare const isTypedOMSupported: () => boolean;
 export declare class FXLPeripherals {
     private readonly manager;
     private readonly coordinator;
@@ -68,6 +69,8 @@ export declare class FXLPeripherals {
      */
     touchendHandler(e: TouchEvent): void;
     private moveFrame;
+    private dragTranslate;
+    private dragTransform;
     /**
      * touchmove event handler
      */

package/types/src/index.d.ts

@@ -2,6 +2,7 @@ export * from './Navigator.ts';
 export * from './decorations/index.ts';
 export * from './webpub/index.ts';
 export * from './epub/index.ts';
+export * from './divina/index.ts';
 export * from './audio/index.ts';
 export * from './helpers/index.ts';
 export * from './preferences/index.ts';

package/types/src/peripherals/KeyboardPeripherals.d.ts

@@ -7,6 +7,7 @@ export interface KeyboardPeripheralOptions {
 export declare class KeyboardPeripherals {
     private keydownHandler?;
     private keyManager;
+    private readonly pagehideHandler;
     constructor(options?: KeyboardPeripheralOptions);
     private setupKeyboardPeripherals;
     destroy(): void;