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

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

@@ -17,6 +17,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/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,11 +22,8 @@ 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;
-}
+import type { GetContent, GetContentBytesLength, RequestConfig } from "../fetcher/types";
+export type { GetContent, GetContentBytesLength, RequestConfig };
 export interface NavigatorAPI {
     updateSettings?: (settings: Record<string, unknown>) => Promise<void>;
     getContent: GetContent;
@@ -70,6 +67,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,15 +93,60 @@ export interface SampleRead {
     popup?: string;
     minimum?: number;
 }
+/**
+ * Self-contained CSS or JS injected into every chapter iframe.
+ *
+ * Injectables are the integrator's additions — NOT content from the EPUB.
+ * They're loaded via `<link>` / `<script>` elements in the iframe head,
+ * independently of the Fetcher pipeline and the module system.
+ *
+ * Use injectables for:
+ * - **ReadiumCSS** — reading system stylesheets (r2before, r2default, r2after)
+ * - **Custom fonts** — `@font-face` stylesheets or system font declarations
+ * - **Custom styles** — integrator branding, popup/popover CSS, icon fonts
+ * - **Scripts** — self-contained libraries (MathJax, KaTeX, analytics)
+ *
+ * Use modules instead when you need the reader's API (fetcher, publication,
+ * navigation state, events, settings).
+ *
+ * Categories:
+ *
+ * ReadiumCSS (order matters):
+ *   `{ type: "style", url: "...ReadiumCSS-before.css", r2before: true }`
+ *   `{ type: "style", url: "...ReadiumCSS-default.css", r2default: true }`
+ *   `{ type: "style", url: "...ReadiumCSS-after.css", r2after: true }`
+ *
+ * Custom font (file):
+ *   `{ type: "style", url: ".../opendyslexic.css", fontFamily: "opendyslexic" }`
+ *
+ * Custom font (system):
+ *   `{ type: "style", fontFamily: "Courier", systemFont: true }`
+ *
+ * Custom style:
+ *   `{ type: "style", url: ".../style.css" }`
+ *
+ * Script:
+ *   `{ type: "script", url: "https://cdn.../MathJax.js" }`
+ *   `{ type: "script", url: ".../analytics.js", async: true }`
+ */
 export interface Injectable {
-    type: string;
+    /** `"style"` for CSS, `"script"` for JS. */
+    type: "style" | "script";
+    /** URL to the CSS or JS file. Required unless `systemFont` is true. */
     url?: string;
-    r2after?: boolean;
+    /** 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;
+    /** Font family name — registers this font in the reader's font selector. */
     fontFamily?: string;
+    /** System font — no URL needed, the font is available on the user's OS. */
     systemFont?: boolean;
+    /** Appearance name — registers a custom appearance with the r2after stylesheet. */
     appearance?: string;
+    /** Load script asynchronously (only applies to `type: "script"`). */
     async?: boolean;
 }
 export interface ReaderRights {
@@ -125,7 +180,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 +242,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;
@@ -240,7 +314,7 @@ export declare class EpubNavigator extends VisualNavigator implements EpubModule
     requestConfig?: RequestConfig;
     private didInitKeyboardEventHandler;
     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;

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

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-i-t-a/reader",
-  "version": "3.0.0-alpha.14",
+  "version": "3.0.0-alpha.15",
   "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",