@d-i-t-a/reader 2.4.9 → 2.5.0

package/dist/types/reader.d.ts

@@ -34,7 +34,7 @@ export default class D2Reader {
     private readonly citationModule?;
     private readonly consumptionModule?;
     private constructor();
-    addEventListener(): void;
+    addEventListener(event: string, handler: (...args: any[]) => void): void;
     /**
      * The async builder.
      */
@@ -75,6 +75,16 @@ export default class D2Reader {
     deleteAnnotation: (highlight: Annotation) => Promise<any>;
     /** Add annotation */
     addAnnotation: (highlight: Annotation) => Promise<any>;
+    /**
+     * Update annotation
+     *
+     * This should be used only when the add/delete of the annotation note
+     * is not directly handled in the `addAnnotation`/`addCommentToAnnotation`
+     * callback defined in the configuration of the D2Reader.load() method
+     *  */
+    updateAnnotation: (highlight: Annotation) => Promise<any>;
+    /** Change highlighter color to a specific HEX string */
+    changeHighlighterColor: (color: string) => void;
     /** Hide Annotation Layer */
     hideAnnotationLayer: () => void | undefined;
     /** Show Annotation Layer */
@@ -107,7 +117,7 @@ export default class D2Reader {
     get bookmarks(): any;
     /** Current Annotations */
     get annotations(): any;
-    get publicationLayout(): any;
+    get publicationLayout(): "fixed" | "reflowable";
     /** History */
     get history(): Locator[] | undefined;
     /** Current index of history */
@@ -129,10 +139,10 @@ export default class D2Reader {
     /**
      * Resources
      */
-    get currentResource(): any;
+    get currentResource(): number | undefined;
     get mostRecentNavigatedTocItem(): string | false;
-    get totalResources(): any;
-    get publicationLanguage(): any;
+    get totalResources(): number;
+    get publicationLanguage(): string[];
     /**
      * Settings
      */
@@ -148,6 +158,12 @@ export default class D2Reader {
         letterSpacing: number;
         pageMargins: number;
         lineHeight: number;
+        bodyHyphens: boolean;
+        paraSpacing: number;
+        paraIndent: number;
+        typeScale: number;
+        backgroundColor: string;
+        textColor: string;
     };
     resetUserSettings: () => Promise<void>;
     applyUserSettings: (userSettings: Partial<UserSettings>) => Promise<void>;
@@ -186,10 +202,10 @@ export default class D2Reader {
      * Navigation
      * @TODO : These should return promises that complete when they are done.
      */
-    get currentLocator(): any;
+    get currentLocator(): Locator;
     get positions(): any;
     goTo: (locator: Locator) => Promise<void>;
-    goToPosition: (value: number) => Promise<any>;
+    goToPosition: (value: number) => Promise<void>;
     goToPage: (page: number) => Promise<void>;
     fitToPage: () => void;
     fitToWidth: () => void;

package/dist/types/store/Annotator.d.ts

@@ -1,27 +1,31 @@
-import { ReadingPosition } from "../model/Locator";
+import { Annotation, Bookmark, ReadingPosition } from "../model/Locator";
 import { IHighlight } from "../modules/highlight/common/highlight";
+import { ISelectionInfo } from "../modules/highlight/common/selection";
 interface Annotator {
-    initLastReadingPosition(position: ReadingPosition): any;
-    getLastReadingPosition(): any;
-    saveLastReadingPosition(position: any): any;
-    initBookmarks(list: any): any;
-    saveBookmark(bookmark: any): any;
-    deleteBookmark(bookmark: any): any;
-    getBookmarks(href?: string): any;
-    locatorExists(locator: any, type: AnnotationType): any;
-    initAnnotations(list: any): any;
-    saveAnnotation(annotation: any): any;
-    deleteAnnotation(id: any): any;
-    deleteSelectedAnnotation(annotation: any): any;
-    getAnnotations(): any;
-    getAnnotationsByChapter(chapter: string): any;
-    getAnnotation(annotation: IHighlight): any;
-    getAnnotationByID(id: string): any;
-    getAnnotationPosition(id: any, iframeWin: any): any;
-    getAnnotationElement(id: any, iframeWin: any): any;
-    saveTemporarySelectionInfo(selectionInfo: any): any;
-    getTemporarySelectionInfo(doc: any): any;
-    deleteTemporarySelectionInfo(): any;
+    initLastReadingPosition(position: ReadingPosition): void;
+    getLastReadingPosition(): ReadingPosition | null;
+    saveLastReadingPosition(position: ReadingPosition | string): void;
+    initBookmarks(list: Bookmark[] | string): Bookmark[];
+    saveBookmark(bookmark: Bookmark): Bookmark;
+    deleteBookmark(bookmark: Bookmark): Bookmark;
+    getBookmarks(href?: string): Bookmark[];
+    locatorExists(locator: Bookmark, type: AnnotationType): Bookmark | null;
+    initAnnotations(list: Annotation[] | string): Annotation[];
+    saveAnnotation(annotation: Annotation): Annotation;
+    deleteAnnotation(id: string): string;
+    deleteSelectedAnnotation(annotation: Annotation): Annotation;
+    getAnnotations(): Annotation[];
+    getAnnotationsByChapter(chapter: string): Annotation[];
+    getAnnotation(annotation: IHighlight): Annotation | null;
+    getAnnotationByID(id: string): Annotation | null;
+    /** Returns the pixel top offset of the annotation highlight element, or null if not found. */
+    getAnnotationPosition(id: string, iframeWin: Window): number | null;
+    /** Returns the highlight DOM element for an annotation, or null if not found. */
+    getAnnotationElement(id: string, iframeWin: Window): HTMLElement | null;
+    saveTemporarySelectionInfo(selectionInfo: ISelectionInfo): void;
+    /** Returns the reconstituted selection info with a live Range, or null. */
+    getTemporarySelectionInfo(doc: Document | null): ISelectionInfo | null;
+    deleteTemporarySelectionInfo(): void;
 }
 export declare enum AnnotationType {
     Bookmark = 0,

package/dist/types/store/LocalAnnotator.d.ts

@@ -2,6 +2,7 @@ import Annotator, { AnnotationType } from "./Annotator";
 import Store from "./Store";
 import { ReadingPosition } from "../model/Locator";
 import { IHighlight } from "../modules/highlight/common/highlight";
+import { ISelectionInfo } from "../modules/highlight/common/selection";
 export interface LocalAnnotatorConfig {
     store: Store;
 }
@@ -22,16 +23,16 @@ export default class LocalAnnotator implements Annotator {
     deleteBookmark(bookmark: any): any;
     getBookmarks(href?: string): any;
     initAnnotations(list: any): any;
-    saveTemporarySelectionInfo(selectionInfo: any): void;
-    getTemporarySelectionInfo(doc: any): any;
+    saveTemporarySelectionInfo(selectionInfo: ISelectionInfo): void;
+    getTemporarySelectionInfo(doc: Document | null): ISelectionInfo | null;
     deleteTemporarySelectionInfo(): void;
     saveAnnotation(annotation: any): any;
     deleteAnnotation(id: any): any;
     deleteSelectedAnnotation(annotation: any): any;
     getAnnotations(): any;
     getAnnotationsByChapter(chapter: string): any;
-    getAnnotationPosition(id: any, iframeWin: any): any;
-    getAnnotationElement(id: any, iframeWin: any): any;
+    getAnnotationPosition(id: string, iframeWin: Window): number | null;
+    getAnnotationElement(id: string, iframeWin: Window): HTMLElement | null;
     getAnnotation(highlight: IHighlight): any;
     getAnnotationByID(id: string): any;
 }

package/dist/types/store/LocalStorageStore.d.ts

@@ -1,9 +1,9 @@
 import Store from "./Store";
 export interface LocalStorageStoreConfig {
-    /** String to prepend to keys in localStorage. If the same prefix is shared
-          across LocalStorageStores on the same domain, they will have the same
-          value for each key. */
-    prefix: string;
+    /** String (or URL, which is coerced via .toString()) to prepend to keys in
+     *  localStorage. If the same prefix is shared across LocalStorageStores on
+     *  the same domain, they will have the same value for each key. */
+    prefix: string | URL;
     useLocalStorage: boolean;
     useStorageType: string | undefined;
 }

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

@@ -19,8 +19,6 @@ export default class EventHandler {
      */
     private isReadingOrderInternal;
     private isResourceInternal;
-    clicks: number;
-    clickTimer: any;
-    dblClickTimeSpan: number;
+    private clickTimeout;
     private handleLinks;
 }

package/dist/types/views/BookView.d.ts

@@ -31,5 +31,6 @@ interface BookView {
     goToNextPage?(): void;
     getCurrentPage(): number;
     getPageCount(): number;
+    padOddColumns?(): void;
 }
 export default BookView;

package/dist/types/views/ReflowableBookView.d.ts

@@ -51,4 +51,11 @@ export default class ReflowableBookView implements BookView {
     private setLeftColumnsWidth;
     get scrollingElement(): Element;
     get scrollWidth(): number;
+    /**
+     * In multi-column paginated mode, if the content produces an odd number
+     * of CSS columns the last page will only show one column and navigation
+     * may skip it. This injects an invisible spacer to force an even column
+     * count so every page is full.
+     */
+    padOddColumns(): boolean;
 }

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@d-i-t-a/reader",
-  "version": "2.4.9",
+  "version": "2.5.0",
   "description": "A viewer application for EPUB files.",
   "repository": "https://github.com/d-i-t-a/R2D2BC",
   "license": "Apache-2.0",
   "main": "dist/esm/index.js",
   "typings": "dist/types/index.d.ts",
+  "targets": {
+    "main": false
+  },
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -21,30 +24,35 @@
     "sass:release": "sass --style=compressed src/styles/sass/:dist",
     "examples": "npx ts-node examples/server.ts",
     "lint": "eslint '*/**/*.{js,ts,tsx}' --fix",
-    "example:react": "parcel examples/react/index.html --dist-dir parcel-dist"
+    "example:clean": "rm -rf parcel-dist .parcel-cache",
+    "example:react": "npm run example:clean && parcel examples/react/index.html --dist-dir parcel-dist",
+    "example:vue": "npm run example:clean && parcel examples/vue/index.html --dist-dir parcel-dist --no-hmr",
+    "example:angular": "npm run example:clean && parcel examples/angular/index.html --dist-dir parcel-dist",
+    "example:nextjs": "npm run example:clean && parcel examples/nextjs/index.html --dist-dir parcel-dist",
+    "example:remix": "npm run example:clean && parcel examples/remix/index.html --dist-dir parcel-dist",
+    "example:pdf": "npm run build && npx ts-node examples/pdf/serve.ts",
+    "example:vanilla": "npm run build && npx ts-node examples/vanilla/serve.ts",
+    "format": "prettier --write src/",
+    "format:check": "prettier --check src/",
+    "test": "vitest run",
+    "test:watch": "vitest"
   },
   "dependencies": {
-    "@babel/plugin-proposal-private-property-in-object": "^7.21.11",
-    "@types/pdfjs-dist": "^2.7.4",
-    "@types/sass": "^1.43.1",
-    "browserslist-useragent": "^4.0.0",
+    "browserslist-useragent-regexp": "^4.1.0",
     "cssesc": "^3.0.0",
-    "detect-browser": "^5.2.0",
+    "debounce": "^2.0.0",
     "devtools-detector": "^2.0.14",
     "eventemitter3": "^5.0.1",
     "jscrypto": "^1.0.3",
-    "lodash.clonedeep": "^4.5.0",
+    "lodash": "^4.17.21",
     "loglevel": "^1.8.0",
-    "mark.js": "^8.11.1",
-    "pdfjs-dist": "2.14.305",
-    "promise-polyfill": "^8.2.0",
-    "r2-shared-js": "^1.0.51",
+    "pdfjs-dist": "^5.5.207",
+    "r2-shared-js": "^1.0.82",
     "recursive-readdir": "^2.2.2",
     "sanitize-html": "^2.3.3",
-    "sass": "^1.54.4",
-    "sentence-splitter": "^5.0.0",
+    "ta-json-x": "^2.5.3",
     "util": "^0.12.4",
-    "whatwg-fetch": "^3.6.2"
+    "uuid": "^11.0.0"
   },
   "browserslist": {
     "production": [
@@ -59,39 +67,30 @@
     ]
   },
   "devDependencies": {
+    "@babel/plugin-proposal-private-property-in-object": "^7.21.11",
     "@parcel/transformer-sass": "^2.7.0",
     "@parcel/transformer-typescript-tsc": "^2.7.0",
-    "@types/chai": "^4.2.15",
-    "@types/copy": "^0.3.1",
+    "@parcel/transformer-vue": "^2.16.4",
     "@types/cssesc": "^3.0.0",
     "@types/debounce": "^3.0.0",
-    "@types/express": "^4.17.12",
-    "@types/jquery": "^3.5.5",
-    "@types/mark.js": "^8.11.5",
-    "@types/mocha": "^10.0.1",
-    "@types/pako": "^2.0.0",
-    "@types/parse5": "^7.0.0",
-    "@types/promise-polyfill": "^6.0.5",
+    "@types/express": "^5.0.6",
+    "@types/glob": "^8.1.0",
+    "@types/lodash": "^4.17.0",
     "@types/react": "^18.2.31",
     "@types/react-dom": "^18.2.14",
     "@types/rimraf": "^4.0.5",
-    "@types/sanitize-html": "^2.9.0",
-    "@types/uuid": "^9.0.4",
-    "@typescript-eslint/eslint-plugin": "^7.0.1",
-    "@typescript-eslint/parser": "^7.0.1",
+    "@types/sanitize-html": "^2.13.0",
+    "@types/sass": "^1.43.1",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.1",
+    "@typescript-eslint/parser": "^8.0.1",
     "ansi-regex": ">=5.0.1",
     "babel-eslint": "^10.1.0",
     "braces": ">=3.0.2",
-    "browserslist-useragent-regexp": "^4.1.0",
     "buffer": "^6.0.3",
-    "chai": "^5.0.3",
     "chalk": "^4.1.2",
-    "chokidar": "^3.5.2",
-    "copy": "^0.3.2",
-    "debounce": "^2.0.0",
-    "dita-streamer-js": "^1.1.3",
-    "ecstatic": "^4.1.4",
-    "esbuild": "^0.20.0",
+    "chokidar": "^4.0.1",
+    "esbuild": "^0.27.2",
     "eslint": "^8.52.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-config-react-app": "^7.0.1",
@@ -100,41 +99,33 @@
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-react": "^7.33.2",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "express": "^4.17.1",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "express": "^5.2.1",
+    "glob": "^13.0.6",
     "json-schema": ">=0.4.0",
-    "minimist": "^1.2.6",
-    "mocha": "^10.2.0",
-    "moment": "^2.29.3",
-    "npm-force-resolutions": "0.0.10",
     "parcel": "^2.7.0",
     "parcel-config-precache-manifest": "^0.0.4",
-    "parcel-plugin-static-files-copy": "^2.6.0",
     "parcel-reporter-static-files-copy": "^1.4.0",
-    "path-parse": "^1.0.7",
-    "prettier": "^3.0.3",
+    "prettier": "^3.3.3",
     "process": "^0.11.10",
-    "rangy": "^1.3.0",
+    "r2-streamer-js": "^1.0.51",
     "react": "^18.2.0",
-    "react-app-polyfill": "^3.0.0",
     "react-dom": "^18.2.0",
-    "regenerator-runtime": "^0.14.0",
-    "rimraf": "^5.0.5",
-    "sinon": "^17.0.0",
-    "ta-json-x": "^2.5.3",
+    "rimraf": "^6.0.1",
+    "sass": "^1.54.4",
     "tar": ">=6.1.9",
-    "ts-loader": "^9.4.4",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.25.1",
-    "typedoc-plugin-rename-defaults": "^0.7.0",
-    "typescript": "5.3.3",
-    "urijs": "^1.19.11"
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-rename-defaults": "^0.7.3",
+    "typescript": "5.9.3",
+    "vitest": "^4.0.18",
+    "vue": "^3.5.30"
   },
   "files": [
     "dist"
   ],
   "resolutions": {
-    "braces": "3.0.2"
+    "braces": "3.0.3"
   },
   "prettier": {
     "printWidth": 80,