@d-i-t-a/reader 2.5.1 → 3.0.0-alpha.2

package/dist/types/model/Link.d.ts

@@ -1,11 +1,9 @@
-import { Link as R2Link } from "r2-shared-js/dist/es6-es2015/src/models/publication-link";
-export declare class D2Link {
-    href: string;
-    type?: string;
-    title?: string;
-}
-export declare class Link extends R2Link {
-    contentLength?: number;
-    contentWeight?: number;
-}
+/**
+ * @deprecated Import from "./v3/Link" instead. This file re-exports for backwards compatibility.
+ */
+export { Link, D2Link, Links } from "./v3/Link";
+/**
+ * @deprecated No longer needed — @readium/shared uses camelCase natively.
+ * Kept for backwards compatibility with code that calls convertAndCamel().
+ */
 export declare function convertAndCamel(o: any): any;

package/dist/types/model/Locator.d.ts

@@ -1,41 +1,4 @@
-import { IHighlight } from "../modules/highlight/common/highlight";
-export interface Locator {
-    href: string;
-    type?: string;
-    title?: string;
-    locations: Locations;
-    text?: LocatorText;
-    displayInfo?: any;
-}
-export interface LocatorText {
-    after?: string;
-    before?: string;
-    highlight?: string;
-}
-export interface Locations {
-    fragment?: string;
-    progression?: number;
-    position?: number;
-    totalProgression?: number;
-    remainingPositions?: number;
-    totalRemainingPositions?: number;
-}
-export interface ReadingPosition extends Locator {
-    created: Date;
-}
-export interface Bookmark extends Locator {
-    id?: any;
-    created: Date;
-}
-export declare enum AnnotationMarker {
-    Highlight = 0,
-    Underline = 1,
-    Bookmark = 2,
-    Custom = 3,
-    Comment = 4
-}
-export interface Annotation extends Locator {
-    id?: any;
-    created: Date;
-    highlight?: IHighlight;
-}
+/**
+ * @deprecated Import from "./v3/Locator" instead. This file re-exports for backwards compatibility.
+ */
+export { Locator, LocatorText, Locations, ReadingPosition, Bookmark, Annotation, AnnotationMarker, } from "./v3/Locator";

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

@@ -1,51 +1,4 @@
-import { Locator } from "./Locator";
-import { Link } from "./Link";
-import { Publication as R2Publication } from "r2-shared-js/dist/es6-es2015/src/models/publication";
-import { Link as R2Link } from "r2-shared-js/dist/es6-es2015/src/models/publication-link";
-import { GetContentBytesLength, RequestConfig } from "../navigator/IFrameNavigator";
-import { SampleRead } from "../navigator/IFrameNavigator";
-export declare class Publication extends R2Publication {
-    manifestUrl: URL;
-    positions: Array<Locator>;
-    sample?: SampleRead;
-    /**
-     * Initialize a publication from a manifest URL
-     */
-    static fromUrl(url: URL, requestConfig?: RequestConfig): Promise<Publication>;
-    get readingOrder(): Link[];
-    get resources(): Link[];
-    get tableOfContents(): R2Link[];
-    private limitedTOC;
-    get landmarks(): R2Link[];
-    get pageList(): R2Link[] | undefined;
-    get isFixedLayout(): boolean;
-    get isReflowable(): boolean;
-    get layout(): "fixed" | "reflowable";
-    get hasMediaOverlays(): boolean;
-    getStartLink(): Link | undefined;
-    getPreviousSpineItem(href: string): Link | undefined;
-    getNextSpineItem(href: string): Link | undefined;
-    getSpineItem(href: string): Link | undefined;
-    getSpineIndex(href: string): number | undefined;
-    getAbsoluteHref(href: string): string;
-    getRelativeHref(href: string): string;
-    getTOCItemAbsolute(href: string): Link | undefined;
-    getTOCItem(href: string): Link | undefined;
-    /**
-     * positionsByHref
-     */
-    positionsByHref(href: string): Locator[];
-    /**
-     * Fetches the contents to build up the positions manually,
-     * at least for fluid layout pubs
-     */
-    autoGeneratePositions(requestConfig?: RequestConfig, getContentBytesLength?: GetContentBytesLength): Promise<void>;
-    /**
-     * Fetches the positions from a given service href
-     */
-    fetchPositionsFromService(href: string, requestConfig?: RequestConfig): Promise<void>;
-    /**
-     * Fetches weights from a given service href
-     */
-    fetchWeightsFromService(href: string, requestConfig?: RequestConfig): Promise<void>;
-}
+/**
+ * @deprecated Import from "./v3/Publication" instead. This file re-exports for backwards compatibility.
+ */
+export { Publication } from "./v3/Publication";

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

@@ -0,0 +1,42 @@
+import { Link as ReadiumLink, Links as ReadiumLinks } from "@readium/shared";
+/**
+ * Simple link interface for external use.
+ */
+export interface D2Link {
+    href: string;
+    type?: string;
+    title?: string;
+}
+/**
+ * R2D2BC Link — extends @readium/shared Link with R2D2BC extensions.
+ *
+ * All property access uses camelCase directly (href, type, title, etc.).
+ * No Proxy, no PascalCase compat layer — clean code.
+ *
+ * R2D2BC extensions: contentLength, contentWeight, mediaOverlayNode
+ */
+export declare class Link extends ReadiumLink {
+    /** Byte size of the resource (used for position calculation) */
+    contentLength?: number;
+    /** Percentage weight for reading progression */
+    contentWeight?: number;
+    /** Parsed media overlay node (set by MediaOverlayModule after fetching SMIL) */
+    mediaOverlayNode?: any;
+    /**
+     * Media overlay URL from link properties.
+     */
+    /**
+     * Media overlay URL from link properties.
+     * The manifest JSON uses hyphenated key "media-overlay".
+     */
+    get mediaOverlay(): string | undefined;
+    /**
+     * Decoded href (URL-decoded).
+     */
+    get hrefDecoded(): string | undefined;
+    /**
+     * Rels as array (convenience — @readium/shared uses Set).
+     */
+    get relArray(): string[];
+}
+export { ReadiumLinks as Links };

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

@@ -0,0 +1,55 @@
+import { IHighlight } from "../../modules/highlight/common/highlight";
+/**
+ * Locator model aligned with the Readium Locator spec.
+ * https://github.com/readium/architecture/tree/master/models/locators
+ *
+ * R2D2BC extensions (remainingPositions, totalRemainingPositions, displayInfo)
+ * are preserved for backwards compatibility.
+ */
+export interface Locator {
+    href: string;
+    type?: string;
+    title?: string;
+    locations: Locations;
+    text?: LocatorText;
+    /** @deprecated R2D2BC extension — may be removed in a future version */
+    displayInfo?: any;
+}
+export interface LocatorText {
+    after?: string;
+    before?: string;
+    highlight?: string;
+}
+export interface Locations {
+    /** Fragment identifier (TOC, page lists, landmarks) */
+    fragment?: string;
+    /** Progression in the resource expressed as a percentage (0–1) */
+    progression?: number;
+    /** An index in the publication (>= 1) */
+    position?: number;
+    /** Progression in the publication expressed as a percentage (0–1) */
+    totalProgression?: number;
+    /** R2D2BC extension: remaining positions in current resource */
+    remainingPositions?: number;
+    /** R2D2BC extension: remaining positions in publication */
+    totalRemainingPositions?: number;
+}
+export interface ReadingPosition extends Locator {
+    created: Date;
+}
+export interface Bookmark extends Locator {
+    id?: any;
+    created: Date;
+}
+export declare enum AnnotationMarker {
+    Highlight = 0,
+    Underline = 1,
+    Bookmark = 2,
+    Custom = 3,
+    Comment = 4
+}
+export interface Annotation extends Locator {
+    id?: any;
+    created: Date;
+    highlight?: IHighlight;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * Media Overlay Node for SMIL-based synchronized audio+text.
+ *
+ * @readium/shared only provides MediaOverlay metadata (activeClass, playbackActiveClass).
+ * The full SMIL overlay tree (Text, Audio, Children, Role) is an R2D2BC model
+ * because the ts-toolkit doesn't implement media overlay playback.
+ */
+export declare class MediaOverlayNode {
+    /** Text fragment reference (e.g., "chapter1.xhtml#para1") */
+    Text?: string;
+    /** Audio file reference (e.g., "audio/chapter1.mp3#t=0,5.5") */
+    Audio?: string;
+    /** Child overlay nodes (for nested SMIL structures) */
+    Children?: MediaOverlayNode[];
+    /** Semantic roles (e.g., ["bodymatter", "chapter"]) */
+    Role?: string[];
+    /** Whether this node has been initialized/loaded */
+    initialized?: boolean;
+    /**
+     * Deserialize a MediaOverlayNode from plain JSON.
+     * Replaces the old TaJsonDeserialize<MediaOverlayNode> approach.
+     */
+    static deserialize(json: any): MediaOverlayNode | undefined;
+    /**
+     * Serialize to plain JSON.
+     */
+    serialize(): any;
+}

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

@@ -0,0 +1,51 @@
+import { Manifest } from "@readium/shared";
+import { Locator } from "./Locator";
+import { Link } from "./Link";
+import { GetContentBytesLength, RequestConfig, SampleRead } from "../../navigator/IFrameNavigator";
+/**
+ * R2D2BC Publication — wraps @readium/shared Manifest with
+ * all R2D2BC-specific extensions (positions, sample read, spine helpers).
+ *
+ * No Proxies. Clean property access. All camelCase.
+ */
+export declare class Publication {
+    readonly manifest: Manifest;
+    manifestUrl: URL;
+    positions: Array<Locator>;
+    sample?: SampleRead;
+    /** Cached converted links — extensions persist across accesses */
+    private _readingOrder?;
+    private _resources?;
+    private _toc?;
+    private _links?;
+    constructor(manifest: Manifest, manifestUrl: URL);
+    static fromUrl(url: URL, requestConfig?: RequestConfig): Promise<Publication>;
+    get metadata(): import("@readium/shared").Metadata;
+    get readingOrder(): Link[];
+    get resources(): Link[];
+    get tableOfContents(): Link[];
+    get landmarks(): Link[];
+    get pageList(): Link[];
+    get links(): Link[];
+    get isFixedLayout(): boolean;
+    get isReflowable(): boolean;
+    get layout(): "fixed" | "reflowable";
+    get hasMediaOverlays(): boolean;
+    get publicationLanguages(): string[] | undefined;
+    get publicationTitle(): any;
+    get publicationReadingProgression(): string | undefined;
+    getStartLink(): Link | undefined;
+    getPreviousSpineItem(href: string): Link | undefined;
+    getNextSpineItem(href: string): Link | undefined;
+    getSpineItem(href: string): Link | undefined;
+    getSpineIndex(href: string): number | undefined;
+    getAbsoluteHref(href: string): string;
+    getRelativeHref(href: string): string;
+    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>;
+    private limitedTOC;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * v3 Model Layer
+ *
+ * Built on @readium/shared instead of r2-shared-js + ta-json-x.
+ * All models use plain JSON deserialization (no decorators).
+ * PascalCase compatibility getters provided for backwards compat.
+ */
+export { Publication } from "./Publication";
+export { Link, D2Link, Links } from "./Link";
+export { Locator, LocatorText, Locations, ReadingPosition, Bookmark, Annotation, AnnotationMarker, } from "./Locator";
+export { MediaOverlayNode } from "./MediaOverlayNode";

package/dist/types/modules/mediaoverlays/MediaOverlayModule.d.ts

@@ -2,7 +2,7 @@ import { Publication } from "../../model/Publication";
 import { IFrameNavigator } from "../../navigator/IFrameNavigator";
 import { ReaderModule } from "../ReaderModule";
 import { Link } from "../../model/Link";
-import { MediaOverlayNode } from "r2-shared-js/dist/es6-es2015/src/models/media-overlay";
+import { MediaOverlayNode } from "../../model/v3/MediaOverlayNode";
 import { MediaOverlaySettings } from "./MediaOverlaySettings";
 export interface MediaOverlayModuleAPI {
     started: any;

package/dist/types/modules/search/searchWithDomSeek.d.ts

@@ -5,10 +5,10 @@ export interface ISearchResult {
     textBefore: string;
     textAfter: string;
     href: string;
-    title: string;
+    title: string | undefined;
     uuid: string;
     highlight?: any;
 }
 export declare function escapeRegExp(str: string): string;
 export declare const reset: () => void;
-export declare function searchDocDomSeek(searchInput: string, doc: Document | null, href: string, title: string, fullWordSearch?: boolean): Promise<ISearchResult[]>;
+export declare function searchDocDomSeek(searchInput: string, doc: Document | null, href: string, title: string | undefined, fullWordSearch?: boolean): Promise<ISearchResult[]>;

package/dist/types/reader.d.ts

@@ -142,7 +142,7 @@ export default class D2Reader {
     get currentResource(): number | undefined;
     get mostRecentNavigatedTocItem(): string | false;
     get totalResources(): number;
-    get publicationLanguage(): string[];
+    get publicationLanguage(): string[] | undefined;
     /**
      * Settings
      */
@@ -170,7 +170,7 @@ export default class D2Reader {
     scroll: (value: boolean, direction?: string) => Promise<void>;
     private isTTSIncrementable;
     private isMOIncrementable;
-    /**
+    w: any; /**
      * Used to increase anything that can be increased,
      * such as pitch, rate, volume, fontSize
      */

package/dist/types/utils/JsonUtil.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @deprecated ta-json-x is removed in v3. These functions now use
+ * @readium/shared's built-in deserialize/serialize methods or plain JSON.
+ *
+ * Kept for backwards compatibility with code that calls TaJsonDeserialize/TaJsonSerialize.
+ */
 export interface IStringMap {
     [key: string]: string;
 }
@@ -8,7 +14,17 @@ export interface JsonMap {
 }
 export interface JsonArray extends Array<AnyJson> {
 }
-type TConstructor<T> = new (value?: any) => T;
-export declare function TaJsonDeserialize<T>(json: any, type: TConstructor<T>): T;
+/**
+ * @deprecated Use Manifest.deserialize(), Link.deserialize(), etc. from @readium/shared directly.
+ *
+ * This wrapper now calls the type's static deserialize() if available,
+ * otherwise falls back to Object.assign for simple types.
+ */
+export declare function TaJsonDeserialize<T>(json: any, type: {
+    new (...args: any[]): T;
+    deserialize?: (json: any) => T | undefined;
+}): T;
+/**
+ * @deprecated Use the object's serialize() method directly.
+ */
 export declare function TaJsonSerialize<T>(obj: T): JsonMap;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-i-t-a/reader",
-  "version": "2.5.1",
+  "version": "3.0.0-alpha.2",
   "description": "A viewer application for EPUB files.",
   "repository": "https://github.com/d-i-t-a/R2D2BC",
   "license": "Apache-2.0",
@@ -38,6 +38,7 @@
     "test:watch": "vitest"
   },
   "dependencies": {
+    "@readium/shared": "^2.1.5",
     "browserslist-useragent-regexp": "^4.1.0",
     "cssesc": "^3.0.0",
     "debounce": "^2.0.0",
@@ -47,10 +48,8 @@
     "lodash": "^4.17.21",
     "loglevel": "^1.8.0",
     "pdfjs-dist": "^5.5.207",
-    "r2-shared-js": "^1.0.82",
     "recursive-readdir": "^2.2.2",
     "sanitize-html": "^2.3.3",
-    "ta-json-x": "^2.5.3",
     "util": "^0.12.4",
     "uuid": "^11.0.0"
   },