@d-i-t-a/reader 3.0.0-alpha.6 → 3.0.0-alpha.8

package/dist/types/index.d.ts

@@ -5,6 +5,8 @@ export default D2Reader;
 export declare const load: typeof D2Reader.load;
 export { Link } from "./model/Link";
 export { Locator, Locations, LocatorText, ReadingPosition, Bookmark, Annotation, AnnotationMarker, } from "./model/Locator";
+export { ReaderEvent } from "./utils/Events";
+export type { ReaderEventName, ReaderEventMap } from "./utils/Events";
 export type { ReaderConfig, ReaderRights, NavigatorAPI, IFrameAttributes, Injectable, RequestConfig, SampleRead, PublicationServices, InitialAnnotations, } from "./navigator/IFrameNavigator";
 export type { IUserSettings, InitialUserSettings, } from "./model/user-settings/UserSettings";
 export type { UserSettingsIncrementable } from "./model/user-settings/UserProperties";

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

@@ -1,9 +1,11 @@
+export { Link, D2Link, Links } from "./v3/Link";
 /**
- * @deprecated Import from "./v3/Link" instead. This file re-exports for backwards compatibility.
+ * Converts @readium/shared objects to plain JSON-safe objects.
+ * Unwraps Links wrappers (.items), converts Sets to Arrays,
+ * and recursively processes nested objects.
  */
-export { Link, D2Link, Links } from "./v3/Link";
+export declare function toPlainObject(o: any): any;
 /**
- * @deprecated No longer needed — @readium/shared uses camelCase natively.
- * Kept for backwards compatibility with code that calls convertAndCamel().
+ * @deprecated Use toPlainObject() instead.
  */
-export declare function convertAndCamel(o: any): any;
+export declare const convertAndCamel: typeof toPlainObject;

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

@@ -19,6 +19,12 @@ export declare class Publication {
     private _toc?;
     private _links?;
     constructor(manifest: Manifest, manifestUrl: URL);
+    /**
+     * Create a Publication from a raw JSON object.
+     * Handles both RWPM (camelCase) and legacy (PascalCase) key formats.
+     * Returns null if the JSON cannot be parsed.
+     */
+    static fromJSON(json: any, url: URL): Publication | null;
     static fromUrl(url: URL, requestConfig?: RequestConfig): Promise<Publication>;
     get metadata(): import("@readium/shared").Metadata;
     get readingOrder(): Link[];

package/dist/types/modules/highlight/TextHighlighter.d.ts

@@ -167,7 +167,8 @@ export declare class TextHighlighter {
     isSelectionMenuOpen: boolean;
     selectionMenuOpened: debounce.DebouncedFunction<() => void>;
     selectionMenuClosed: debounce.DebouncedFunction<() => void>;
-    selection: debounce.DebouncedFunction<(text: any, selection: any) => void>;
+    /** @deprecated Selection callback now fires from selectionMenuOpened */
+    selection: debounce.DebouncedFunction<(_text: string, _selection: any) => void>;
     toolboxPlacement(): void;
     toolboxHandler(): void;
     /**

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

@@ -32,6 +32,7 @@ export declare class MediaOverlayModule implements ReaderModule {
     private audioElement;
     settings: MediaOverlaySettings;
     private properties;
+    private api?;
     private play;
     private pause;
     private currentAudioBegin;

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

@@ -0,0 +1,108 @@
+import { Locator, ReadingPosition, Bookmark, Annotation } from "../model/Locator";
+/**
+ * Typed event names for the R2D2BC reader.
+ *
+ * Both navigators and modules emit these events through the EventEmitter.
+ * Integrators can listen via:
+ *   reader.addEventListener("resource.ready", handler)
+ *   reader.addEventListener(ReaderEvent.ResourceReady, handler)
+ *
+ * All existing string event names are preserved for backwards compatibility.
+ */
+export declare const ReaderEvent: {
+    readonly ResourceReady: "resource.ready";
+    readonly ResourceStart: "resource.start";
+    readonly ResourceEnd: "resource.end";
+    readonly ResourceFits: "resource.fits";
+    readonly ResourceError: "resource.error";
+    readonly Direction: "direction";
+    readonly ChapterInfo: "chapterinfo";
+    readonly PositionInfo: "positioninfo";
+    readonly LocationChanged: "location.changed";
+    readonly Click: "click";
+    readonly KeyDown: "keydown";
+    readonly Error: "error";
+    readonly ReadAloudStarted: "readaloud.started";
+    readonly ReadAloudStopped: "readaloud.stopped";
+    readonly ReadAloudPaused: "readaloud.paused";
+    readonly ReadAloudResumed: "readaloud.resumed";
+    readonly ReadAloudFinished: "readaloud.finished";
+    readonly ReadAlongStarted: "readalong.started";
+    readonly ReadAlongStopped: "readalong.stopped";
+    readonly ReadAlongPaused: "readalong.paused";
+    readonly ReadAlongResumed: "readalong.resumed";
+    readonly ReadAlongFinished: "readalong.finished";
+    readonly BookmarkCreated: "bookmark.created";
+    readonly BookmarkDeleted: "bookmark.deleted";
+    readonly AnnotationCreated: "annotation.created";
+    readonly AnnotationDeleted: "annotation.deleted";
+    readonly AnnotationUpdated: "annotation.updated";
+    readonly AnnotationSelected: "annotation.selected";
+    readonly AnnotationCommentAdded: "annotation.comment.added";
+    readonly ToolboxOpened: "toolbox.opened";
+    readonly ToolboxClosed: "toolbox.closed";
+    readonly TextSelected: "text.selected";
+    readonly DefinitionSuccess: "definition.success";
+    readonly DefinitionClick: "definition.click";
+    readonly DefinitionVisible: "definition.visible";
+    readonly CitationCreated: "citation.created";
+    readonly CitationFailed: "citation.failed";
+    readonly InspectDetected: "inspect.detected";
+    readonly ActionTracked: "consumption.action";
+    readonly IdleSince: "consumption.idle";
+};
+export type ReaderEventName = (typeof ReaderEvent)[keyof typeof ReaderEvent];
+export interface ReaderEventMap {
+    [ReaderEvent.ResourceReady]: void;
+    [ReaderEvent.ResourceStart]: void;
+    [ReaderEvent.ResourceEnd]: void;
+    [ReaderEvent.ResourceFits]: void;
+    [ReaderEvent.ResourceError]: Error;
+    [ReaderEvent.Direction]: string;
+    [ReaderEvent.ChapterInfo]: string | undefined;
+    [ReaderEvent.PositionInfo]: Locator;
+    [ReaderEvent.LocationChanged]: ReadingPosition;
+    [ReaderEvent.Click]: MouseEvent | TouchEvent;
+    [ReaderEvent.KeyDown]: KeyboardEvent;
+    [ReaderEvent.Error]: Error;
+    [ReaderEvent.ReadAloudStarted]: string;
+    [ReaderEvent.ReadAloudStopped]: string;
+    [ReaderEvent.ReadAloudPaused]: string;
+    [ReaderEvent.ReadAloudResumed]: string;
+    [ReaderEvent.ReadAloudFinished]: string;
+    [ReaderEvent.ReadAlongStarted]: string;
+    [ReaderEvent.ReadAlongStopped]: string;
+    [ReaderEvent.ReadAlongPaused]: string;
+    [ReaderEvent.ReadAlongResumed]: string;
+    [ReaderEvent.ReadAlongFinished]: string;
+    [ReaderEvent.BookmarkCreated]: Bookmark;
+    [ReaderEvent.BookmarkDeleted]: Bookmark;
+    [ReaderEvent.AnnotationCreated]: Annotation;
+    [ReaderEvent.AnnotationDeleted]: Annotation;
+    [ReaderEvent.AnnotationUpdated]: Annotation;
+    [ReaderEvent.AnnotationSelected]: Annotation;
+    [ReaderEvent.AnnotationCommentAdded]: Annotation;
+    [ReaderEvent.ToolboxOpened]: string;
+    [ReaderEvent.ToolboxClosed]: string;
+    [ReaderEvent.TextSelected]: {
+        text: string;
+        selection: any;
+    };
+    [ReaderEvent.DefinitionSuccess]: any;
+    [ReaderEvent.DefinitionClick]: {
+        result: any;
+        highlight: any;
+    };
+    [ReaderEvent.DefinitionVisible]: {
+        item: any;
+        highlight: any;
+    };
+    [ReaderEvent.CitationCreated]: string;
+    [ReaderEvent.CitationFailed]: string;
+    [ReaderEvent.InspectDetected]: void;
+    [ReaderEvent.ActionTracked]: {
+        locator: Locator;
+        action: any;
+    };
+    [ReaderEvent.IdleSince]: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-i-t-a/reader",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0-alpha.8",
   "description": "A viewer application for EPUB files.",
   "repository": "https://github.com/d-i-t-a/R2D2BC",
   "license": "Apache-2.0",