@d-i-t-a/reader 3.0.0-alpha.14 → 3.0.0-alpha.16

package/dist/types/model/user-settings/UserSettings.d.ts

@@ -1,6 +1,7 @@
 import Store from "../../store/Store";
 import { UserProperties, UserProperty, UserSettingsIncrementable } from "./UserProperties";
-import { Injectable, NavigatorAPI } from "../../navigator/EpubNavigator";
+import { Injectable } from "../../navigator/EpubNavigator";
+import type { NavigatorAPI } from "../../navigator/types";
 import BookView from "../../views/BookView";
 export interface UserSettingsConfig {
     /** Store to save the user's selections in. */

package/dist/types/model/v3/Publication.d.ts

@@ -25,7 +25,7 @@ export declare class Publication {
      * Returns null if the JSON cannot be parsed.
      */
     static fromJSON(json: any, url: URL): Publication | null;
-    static fromUrl(url: URL, requestConfig?: RequestConfig): Promise<Publication>;
+    static fromUrl(url: URL, requestConfig: RequestConfig | undefined, fetcher: import("../../fetcher/Fetcher").Fetcher): Promise<Publication>;
     get metadata(): import("@readium/shared").Metadata;
     get readingOrder(): Link[];
     get resources(): Link[];
@@ -50,8 +50,8 @@ export declare class Publication {
     getTOCItemAbsolute(href: string): Link | undefined;
     getTOCItem(href: string): Link | undefined;
     positionsByHref(href: string): Locator[];
-    autoGeneratePositions(requestConfig?: RequestConfig, getContentBytesLength?: GetContentBytesLength): Promise<void>;
-    fetchPositionsFromService(href: string, requestConfig?: RequestConfig): Promise<void>;
-    fetchWeightsFromService(href: string, requestConfig?: RequestConfig): Promise<void>;
+    autoGeneratePositions(requestConfig: RequestConfig | undefined, getContentBytesLength: GetContentBytesLength): Promise<void>;
+    fetchPositionsFromService(href: string, fetcher: import("../../fetcher/Fetcher").Fetcher): Promise<void>;
+    fetchWeightsFromService(href: string, fetcher: import("../../fetcher/Fetcher").Fetcher): Promise<void>;
     private limitedTOC;
 }

package/dist/types/modules/ModuleHost.d.ts

@@ -5,7 +5,8 @@ import { Publication } from "../model/v3";
 import { ReaderModule } from "./ReaderModule";
 import type { ReaderEventMap } from "../utils/Events";
 import type { NavigatorFeatureKey, NavigatorFeatureMap } from "./NavigatorFeatureMap";
-import { IFrameAttributes, NavigatorAPI, ReaderRights, RequestConfig, SampleRead } from "../navigator/EpubNavigator";
+import { IFrameAttributes, RequestConfig, SampleRead } from "../navigator/EpubNavigator";
+import type { NavigatorAPI, ReaderRights } from "../navigator/types";
 import { UserSettings } from "../model/user-settings/UserSettings";
 import { TextHighlighter } from "./highlight/TextHighlighter";
 /**
@@ -17,6 +18,7 @@ export interface ModuleHost {
     readonly settings: UserSettings;
     readonly rights: Partial<ReaderRights>;
     readonly api?: Partial<NavigatorAPI>;
+    readonly fetcher: import("../fetcher/Fetcher").Fetcher;
     readonly mainElement: HTMLElement;
     readonly headerMenu?: HTMLElement | null;
     goTo(locator: Locator): void | Promise<void>;

package/dist/types/modules/ModuleRegistry.d.ts

@@ -1,7 +1,7 @@
 import { ReaderModule } from "./ReaderModule";
 import type { ModuleHost } from "./ModuleHost";
 import type { NavigatorFeatureKey, NavigatorFeatureMap } from "./NavigatorFeatureMap";
-import type { ReaderRights } from "../navigator/EpubNavigator";
+import type { ReaderRights } from "../navigator/types";
 /**
  * Registry for reader feature modules.
  *

package/dist/types/modules/ReaderModule.d.ts

@@ -1,5 +1,5 @@
 import type { ModuleHost } from "./ModuleHost";
-import type { ReaderRights } from "../navigator/EpubNavigator";
+import type { ReaderRights } from "../navigator/types";
 import type { NavigatorFeatureKey } from "./NavigatorFeatureMap";
 /**
  * Enum-like constant for navigator host types.

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

@@ -50,7 +50,6 @@ export declare class SearchModule implements ReaderModule<EpubModuleHost>, ISear
     goToSearchIndex(href: string, index: number, current: boolean): Promise<void>;
     private handleSearchBook;
     searchBook(term: string): Promise<any>;
-    decodeBase64(base64: any): string;
     searchChapter(term: string): Promise<any>;
     drawSearch(): void;
     handleResize(): Promise<void>;

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

@@ -22,27 +22,10 @@ import { DefinitionsModuleConfig } from "../modules/epub/search/DefinitionsModul
 import { LineFocusModuleConfig } from "../modules/epub/LineFocusModule";
 import { CitationModuleConfig } from "../modules/epub/CitationModule";
 import { ConsumptionModuleConfig } from "../modules/epub/ConsumptionModule";
-export type GetContent = (href: string) => Promise<string>;
-export type GetContentBytesLength = (href: string, requestConfig?: RequestConfig) => Promise<number>;
-export interface RequestConfig extends RequestInit {
-    encoded?: boolean;
-}
-export interface NavigatorAPI {
-    updateSettings?: (settings: Record<string, unknown>) => Promise<void>;
-    getContent: GetContent;
-    getContentBytesLength: GetContentBytesLength;
-    resourceReady?: () => void;
-    resourceAtStart?: () => void;
-    resourceAtEnd?: () => void;
-    resourceFitsScreen?: () => void;
-    updateCurrentLocation?: (locator: import("../model/Locator").ReadingPosition) => Promise<void>;
-    positionInfo?: (locator: import("../model/Locator").Locator) => void;
-    chapterInfo?: (title: string | undefined) => void;
-    keydownFallthrough?: (event: KeyboardEvent | undefined) => void;
-    clickThrough?: (event: MouseEvent | TouchEvent) => void;
-    direction?: (dir: string) => void;
-    onError?: (e: Error) => void;
-}
+import type { GetContent, GetContentBytesLength, RequestConfig } from "../fetcher/types";
+import type { NavigatorAPI, ReaderRights, Injectable } from "./types";
+export type { GetContent, GetContentBytesLength, RequestConfig };
+export type { NavigatorAPI, ReaderRights, Injectable, InjectableContext, StyleInjectable, ScriptInjectable, InlineStyleInjectable, InlineScriptInjectable, } from "./types";
 export interface IFrameAttributes {
     margin: number;
     navHeight?: number;
@@ -70,6 +53,19 @@ export interface EpubNavigatorConfig {
     services?: PublicationServices;
     sample?: SampleRead;
     requestConfig?: RequestConfig;
+    /**
+     * Pre-built Fetcher to use for content loading. If provided, the
+     * navigator uses this instead of constructing its own HttpFetcher
+     * from requestConfig. Used when opening .epub files (ZipFetcher)
+     * or when the integrator wants full control over the content pipeline.
+     */
+    fetcher?: import("../fetcher/Fetcher").Fetcher;
+    /**
+     * Blob URL manager for ZIP-based content. Rewrites resource references
+     * (images, CSS, fonts) to blob URLs so document.write() iframes can
+     * load them. Only needed when opening .epub files directly.
+     */
+    blobUrlManager?: import("../fetcher/BlobUrlManager").BlobUrlManager;
     modules: Array<ReaderModule<any> | undefined>;
     highlighter: TextHighlighter;
 }
@@ -83,34 +79,6 @@ export interface SampleRead {
     popup?: string;
     minimum?: number;
 }
-export interface Injectable {
-    type: string;
-    url?: string;
-    r2after?: boolean;
-    r2before?: boolean;
-    r2default?: boolean;
-    fontFamily?: string;
-    systemFont?: boolean;
-    appearance?: string;
-    async?: boolean;
-}
-export interface ReaderRights {
-    enableBookmarks: boolean;
-    enableAnnotations: boolean;
-    enableTTS: boolean;
-    enableSearch: boolean;
-    enableDefinitions: boolean;
-    enableContentProtection: boolean;
-    enableTimeline: boolean;
-    autoGeneratePositions: boolean;
-    enableMediaOverlays: boolean;
-    enablePageBreaks: boolean;
-    enableLineFocus: boolean;
-    customKeyboardEvents: boolean;
-    enableHistory: boolean;
-    enableCitations: boolean;
-    enableConsumption: boolean;
-}
 export interface ReaderUI {
     settings: UserSettingsUIConfig;
 }
@@ -125,7 +93,23 @@ export interface InitialAnnotations {
 export interface ReaderConfig {
     /** Pre-parsed publication manifest JSON — if omitted the manifest is fetched from `url`. */
     publication?: Record<string, unknown>;
-    url: URL;
+    /**
+     * Manifest URL (webpub from server). Required unless `epub` is provided.
+     */
+    url?: URL;
+    /**
+     * Open an .epub file directly — no server/streamer needed.
+     * The reader parses the EPUB client-side (container.xml → OPF → manifest)
+     * and serves content from the ZIP via ZipFetcher.
+     *
+     * Accepts:
+     * - `File` or `Blob` — local file from drag-drop, file picker, IndexedDB
+     * - `ArrayBuffer` — raw bytes already in memory
+     * - `URL` or `string` — URL to a hosted .epub file (fetched automatically)
+     *
+     * Mutually exclusive with `url` (webpub manifest) — provide one or the other.
+     */
+    epub?: File | Blob | ArrayBuffer | URL | string;
     userSettings?: Partial<import("../model/user-settings/UserSettings").InitialUserSettings>;
     initialAnnotations?: InitialAnnotations;
     lastReadingPosition?: import("../model/Locator").ReadingPosition;
@@ -171,6 +155,9 @@ export declare class EpubNavigator extends VisualNavigator implements EpubModule
     mainElement: HTMLElement;
     publication: Publication;
     highlighter?: TextHighlighter;
+    private _fetcher;
+    private _blobUrlManager?;
+    get fetcher(): import("../fetcher/Fetcher").Fetcher;
     supports(feature: NavigatorFeatureName): boolean;
     private fxlZoomKeyHandler;
     private getFxlCurrentScale;
@@ -239,8 +226,10 @@ export declare class EpubNavigator extends VisualNavigator implements EpubModule
     sample?: SampleRead;
     requestConfig?: RequestConfig;
     private didInitKeyboardEventHandler;
+    /** Owns the lifecycle of `Injectable` items across iframe loads. */
+    private injectableManager;
     static create(config: EpubNavigatorConfig): Promise<EpubNavigator>;
-    protected constructor(settings: UserSettings, annotator: Annotator | undefined, initialLastReadingPosition: ReadingPosition | undefined, publication: Publication, api?: Partial<NavigatorAPI>, rights?: Partial<ReaderRights>, tts?: Partial<TTSModuleConfig>, injectables?: Array<Injectable>, attributes?: IFrameAttributes, services?: PublicationServices, sample?: SampleRead, requestConfig?: RequestConfig, highlighter?: TextHighlighter, modules?: Array<ReaderModule<any> | undefined>);
+    protected constructor(settings: UserSettings, annotator: Annotator | undefined, initialLastReadingPosition: ReadingPosition | undefined, publication: Publication, api?: Partial<NavigatorAPI>, rights?: Partial<ReaderRights>, tts?: Partial<TTSModuleConfig>, injectables?: Array<Injectable>, attributes?: IFrameAttributes, services?: PublicationServices, sample?: SampleRead, requestConfig?: RequestConfig, highlighter?: TextHighlighter, modules?: Array<ReaderModule<any> | undefined>, fetcher?: import("../fetcher/Fetcher").Fetcher, blobUrlManager?: import("../fetcher/BlobUrlManager").BlobUrlManager);
     stop(): void;
     spreads: HTMLDivElement;
     firstSpread: HTMLDivElement;
@@ -258,7 +247,6 @@ export declare class EpubNavigator extends VisualNavigator implements EpubModule
     private updateBookView;
     private loadManifest;
     private handleIFrameLoad;
-    private injectInjectablesIntoIframeHead;
     /**
      * Displays standard error UI.
      */
@@ -317,9 +305,11 @@ export declare class EpubNavigator extends VisualNavigator implements EpubModule
     private hideIframeContents;
     private hideLoadingMessage;
     private saveCurrentReadingPosition;
+    /**
+     * Create a `<base>` element for the iframe's document. Used by `prepareDoc`
+     * to anchor relative URLs in chapter content to the resource's href.
+     */
     private static createBase;
-    private static createCssLink;
-    private static createJavascriptLink;
     activateMarker(id: any, position: any): void;
     deactivateMarker(): void;
     showLayer(layer: any): void;

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

@@ -0,0 +1,32 @@
+import type { Publication } from "../model/v3";
+import type { UserSettings } from "../model/user-settings/UserSettings";
+import type { Injectable } from "./types";
+/**
+ * Owns `Injectable` insertion into chapter iframes.
+ *
+ * All variants are injected into the parsed chapter HTML's `<head>` *before*
+ * `document.write()` — they end up in the iframe as if they were part of the
+ * original document, so the browser loads them in parallel with the body. No
+ * flash of unstyled content, no post-load round trip; the iframe's own `load`
+ * event covers readiness.
+ *
+ * Blob content is converted to a runtime object URL and revoked when the
+ * iframe navigates to the next chapter or the reader stops.
+ */
+export declare class InjectableManager {
+    private readonly publication;
+    private readonly settings;
+    /** Per-iframe object URLs created from `Blob` content. Revoked on cleanup. */
+    private objectUrlRegistry;
+    constructor(publication: Publication, settings: UserSettings);
+    /**
+     * Inject into the parsed chapter HTML's head. Mutates `doc` in place.
+     */
+    injectStaticIntoDoc(doc: Document, iframe: HTMLIFrameElement, injectables: Injectable[] | undefined, resourceHref: string): void;
+    /**
+     * Revoke any object URLs allocated for `iframe` during injection. Called
+     * on chapter navigation (before the iframe loads new content) and on
+     * reader stop. Safe to call when the iframe has no registrations.
+     */
+    cleanupForIframe(iframe: HTMLIFrameElement): void;
+}

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

@@ -7,7 +7,7 @@ import Annotator from "../store/Annotator";
 import Store from "../store/Store";
 import { PDFDocumentProxy, AnnotationEditorType } from "pdfjs-dist";
 import { EventBus, PDFFindController, PDFLinkService, PDFViewer, ScrollMode, SpreadMode } from "pdfjs-dist/web/pdf_viewer.mjs";
-import { NavigatorAPI, ReaderRights } from "./EpubNavigator";
+import type { NavigatorAPI, ReaderRights } from "./types";
 export { SpreadMode, ScrollMode, AnnotationEditorType };
 export interface PDFNavigatorConfig {
     mainElement: HTMLElement;
@@ -80,6 +80,8 @@ export declare class PDFNavigator extends VisualNavigator implements PDFModuleHo
     get viewStore(): Store | undefined;
     get annotator(): Annotator | undefined;
     get currentResourceLink(): import("../model/v3").Link | undefined;
+    private _fetcher;
+    get fetcher(): import("../fetcher/Fetcher").Fetcher;
     private resizeTimeout;
     static create(config: PDFNavigatorConfig): Promise<PDFNavigator>;
     protected constructor(settings: UserSettings, publication: Publication, api?: Partial<NavigatorAPI>, workerSrc?: string, annotator?: Annotator, initialLastReadingPosition?: ReadingPosition, viewStore?: Store, rights?: Partial<ReaderRights>, modules?: Array<import("../modules/ReaderModule").ReaderModule<any> | undefined>);

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

@@ -8,7 +8,7 @@ import { ReaderModule } from "../modules/ReaderModule";
 import { ModuleRegistry } from "../modules/ModuleRegistry";
 import { ModuleAccessors } from "../modules/ModuleAccessors";
 import type { NavigatorFeatureKey, NavigatorFeatureMap } from "../modules/NavigatorFeatureMap";
-import type { ReaderRights } from "./EpubNavigator";
+import type { ReaderRights } from "./types";
 /**
  * Typed feature names for navigator capability queries.
  */

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

@@ -0,0 +1,166 @@
+import type { GetContent, GetContentBytesLength } from "../fetcher/types";
+import type { Publication } from "../model/v3";
+/**
+ * Callbacks the integrator can supply for the reader to emit state changes
+ * and delegate resource loading. Shared by EpubNavigator and PDFNavigator.
+ */
+export interface NavigatorAPI {
+    updateSettings?: (settings: Record<string, unknown>) => Promise<void>;
+    getContent: GetContent;
+    getContentBytesLength: GetContentBytesLength;
+    resourceReady?: () => void;
+    resourceAtStart?: () => void;
+    resourceAtEnd?: () => void;
+    resourceFitsScreen?: () => void;
+    updateCurrentLocation?: (locator: import("../model/Locator").ReadingPosition) => Promise<void>;
+    positionInfo?: (locator: import("../model/Locator").Locator) => void;
+    chapterInfo?: (title: string | undefined) => void;
+    keydownFallthrough?: (event: KeyboardEvent | undefined) => void;
+    clickThrough?: (event: MouseEvent | TouchEvent) => void;
+    direction?: (dir: string) => void;
+    onError?: (e: Error) => void;
+}
+/**
+ * Context passed to an injectable's `when` predicate. Lets integrators gate
+ * per-resource / per-publication without us pre-computing a lot of metadata.
+ *
+ * `doc` is the parsed chapter XHTML document, provided for content inspection
+ * (detect math, language, tables, publisher classes, etc.). Treat it as
+ * read-only: mutations land in the written iframe and bypass the Injectable
+ * API contract. Use injectables for injection, not `when`.
+ */
+export interface InjectableContext {
+    publication: Publication;
+    /** href of the resource about to be loaded into the iframe */
+    resourceHref: string;
+    /** Parsed XHTML document of the chapter. Read-only by convention. */
+    doc: Document;
+}
+/**
+ * Shared optional fields on every Injectable variant.
+ */
+interface BaseInjectable {
+    /**
+     * If provided, the injectable is skipped when this returns false.
+     * Evaluated once per iframe load. Useful for per-resource or per-publication
+     * gating that the `injectables` / `injectablesFixed` array split can't express.
+     */
+    when?: (ctx: InjectableContext) => boolean;
+    /**
+     * Extra HTML attributes to set on the injected `<link>` / `<script>` /
+     * `<style>` element. Useful for CSP `nonce`, SRI `integrity`, `crossorigin`,
+     * `media` queries on link tags, `data-*` attributes, etc.
+     */
+    attributes?: Record<string, string>;
+}
+/**
+ * Inject a stylesheet as a `<link rel="stylesheet">` pointing at a URL, or
+ * as a Blob converted to an object URL at runtime.
+ *
+ * One of `url` or `blob` is required.
+ */
+export interface StyleInjectable extends BaseInjectable {
+    type: "style";
+    url?: string;
+    blob?: Blob;
+    /** ReadiumCSS: inject before all other styles (first in head). */
+    r2before?: boolean;
+    /** ReadiumCSS: inject as the default stylesheet (second in head). */
+    r2default?: boolean;
+    /** ReadiumCSS: inject after all other styles (last in head). */
+    r2after?: boolean;
+    /**
+     * Registers the font family with the reader's font picker. `UserSettings`
+     * calls `addFont(fontFamily)` at init to extend the selectable list; the
+     * navigator calls `initAddedFont()` after this stylesheet loads to refresh
+     * the UI. The stylesheet should declare `@font-face` for this family.
+     */
+    fontFamily?: string;
+    /**
+     * System font declaration — no URL needed, the font is available on the
+     * user's OS. Registers the family in the picker without loading a stylesheet.
+     */
+    systemFont?: boolean;
+    /**
+     * Registers an appearance name with the reader's appearance selector.
+     * `UserSettings` calls `addAppearance(appearance)` at init; the navigator
+     * calls `initAddedAppearance()` after this stylesheet loads. Typically set
+     * on an `r2after` stylesheet that declares the appearance's custom properties.
+     */
+    appearance?: string;
+}
+/**
+ * Inject a JS file as a `<script>` element pointing at a URL, or as a Blob
+ * converted to an object URL at runtime.
+ *
+ * One of `url` or `blob` is required.
+ */
+export interface ScriptInjectable extends BaseInjectable {
+    type: "script";
+    url?: string;
+    blob?: Blob;
+    /** Load script asynchronously. */
+    async?: boolean;
+    /** Render as `<script type="module">`. */
+    module?: boolean;
+}
+/**
+ * Inject inline CSS — no HTTP round-trip. Rendered as a `<style>` element with
+ * `source` as its text content.
+ */
+export interface InlineStyleInjectable extends BaseInjectable {
+    type: "style-inline";
+    source: string;
+    /** ReadiumCSS: inject before all other styles (first in head). */
+    r2before?: boolean;
+    /** ReadiumCSS: inject as the default stylesheet (second in head). */
+    r2default?: boolean;
+    /** ReadiumCSS: inject after all other styles (last in head). */
+    r2after?: boolean;
+}
+/**
+ * Inject inline JS — no HTTP round-trip. Rendered as a `<script>` element with
+ * `source` as its text content.
+ */
+export interface InlineScriptInjectable extends BaseInjectable {
+    type: "script-inline";
+    source: string;
+    /** Load script asynchronously. */
+    async?: boolean;
+    /** Render as `<script type="module">`. */
+    module?: boolean;
+}
+/**
+ * Injectable — discriminated union keyed on `type`. Passed to the navigator
+ * via `ReaderConfig.injectables` (and `injectablesFixed` for fixed-layout
+ * publications). Every item in the chosen array is evaluated per iframe load.
+ *
+ * All variants inject into the iframe `<head>`. Integrators needing DOM
+ * behaviour (click listeners, popup UI, glossary, analytics) write a normal
+ * `type: "script"` injectable whose content attaches its own handlers inside
+ * the iframe — the v2.5 pattern used by `injectables/click/click.ts` and
+ * `injectables/mui/script.js`, unchanged.
+ */
+export type Injectable = StyleInjectable | ScriptInjectable | InlineStyleInjectable | InlineScriptInjectable;
+/**
+ * Feature toggles gating which modules are loaded and which reader
+ * capabilities are exposed. Shared by EpubNavigator and PDFNavigator.
+ */
+export interface ReaderRights {
+    enableBookmarks: boolean;
+    enableAnnotations: boolean;
+    enableTTS: boolean;
+    enableSearch: boolean;
+    enableDefinitions: boolean;
+    enableContentProtection: boolean;
+    enableTimeline: boolean;
+    autoGeneratePositions: boolean;
+    enableMediaOverlays: boolean;
+    enablePageBreaks: boolean;
+    enableLineFocus: boolean;
+    customKeyboardEvents: boolean;
+    enableHistory: boolean;
+    enableCitations: boolean;
+    enableConsumption: boolean;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-i-t-a/reader",
-  "version": "3.0.0-alpha.14",
+  "version": "3.0.0-alpha.16",
   "description": "A viewer application for EPUB files.",
   "repository": "https://github.com/d-i-t-a/R2D2BC",
   "license": "Apache-2.0",
@@ -45,6 +45,7 @@
     "debounce": "^2.0.0",
     "devtools-detector": "^2.0.14",
     "eventemitter3": "^5.0.1",
+    "fflate": "^0.8.2",
     "jscrypto": "^1.0.3",
     "lodash": "^4.17.21",
     "loglevel": "^1.8.0",