@d-i-t-a/reader 2.0.0-beta.3 → 2.0.0-beta.7

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

@@ -1,15 +1,15 @@
 /** Returns a single element matching the selector within the parentElement,
     or null if no element matches. */
-export declare function findElement(parentElement: Element | Document, selector: string): HTMLElement | null;
+export declare function findElement(parentElement: Element | Document, selector: string): any | null;
 /** Returns a single element matching the selector within the parent element,
     or throws an exception if no element matches. */
-export declare function findRequiredElement(parentElement: Element | Document, selector: string): HTMLElement;
+export declare function findRequiredElement(parentElement: Element | Document, selector: string): any;
 /** Returns a single element matching the selector within the parentElement in the iframe context,
     or null if no element matches. */
 export declare function findIframeElement(parentElement: Document | null, selector: string): Element | null;
 /** Returns a single element matching the selector within the parent element in an iframe context,
         or throws an exception if no element matches. */
-export declare function findRequiredIframeElement(parentElement: Document | null, selector: string): Element;
+export declare function findRequiredIframeElement(parentElement: Document, selector: string): Element;
 /** Sets an attribute and its value for an HTML element */
 export declare function setAttr(element: HTMLElement, attr: string, value: string): void;
 /** Removes an attribute for an HTML element */

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

@@ -1,7 +1,7 @@
 export declare const WIDTH_ATTR: number;
 export declare const HEIGHT_ATTR: number;
 export declare const VIEWBOX_ATTR: string;
-export declare const iconTemplateColored: (id: string, title: string, path: string, classAttr: string, size: number, fill: string) => string;
+export declare const iconTemplateColored: (id: string, title: string, path: string, classAttr: string | undefined, size: number, fill: string) => string;
 export declare const icons: {
     error: string;
     home: string;

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

@@ -1,9 +1,9 @@
-import IFrameNavigator from "../navigator/IFrameNavigator";
+import { IFrameNavigator } from "../navigator/IFrameNavigator";
 export default class KeyboardEventHandler {
     delegate: IFrameNavigator;
     onBackwardSwipe: (event: UIEvent) => void;
     onForwardSwipe: (event: UIEvent) => void;
-    setupEvents: (element: HTMLElement | Document) => void;
+    setupEvents: (element: HTMLElement | Document | null) => void;
     focusin: (element: HTMLElement | Document) => void;
     keydown: (element: HTMLElement | Document) => void;
 }

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

@@ -4,5 +4,5 @@ export default class TouchEventHandler {
     private static readonly SLOW_SWIPE_MS;
     onBackwardSwipe: (event: UIEvent) => void;
     onForwardSwipe: (event: UIEvent) => void;
-    setupEvents: (element: HTMLElement | Document) => void;
+    setupEvents: (element: HTMLElement | Document | null) => void;
 }

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

@@ -1,4 +1,4 @@
-import IFrameNavigator, { IFrameAttributes } from "../navigator/IFrameNavigator";
+import { IFrameNavigator, IFrameAttributes } from "../navigator/IFrameNavigator";
 interface BookView {
     layout: string;
     name: string;
@@ -7,7 +7,7 @@ interface BookView {
     sideMargin: number;
     height: number;
     delegate: IFrameNavigator;
-    attributes: IFrameAttributes;
+    attributes?: IFrameAttributes;
     setMode?(scroll: boolean): any;
     isScrollMode(): any;
     isPaginated(): any;
@@ -25,8 +25,8 @@ interface BookView {
     goToFragment(fragment: string): void;
     goToCssSelector(cssSelector: string): void;
     snap(element: HTMLElement | null, relative?: boolean): void;
-    atStart?(): boolean;
-    atEnd?(): boolean;
+    atStart(): boolean;
+    atEnd(): boolean;
     goToPreviousPage?(): void;
     goToNextPage?(): void;
     getCurrentPage(): number;

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

@@ -1,9 +1,7 @@
-import Store from "../store/Store";
-import IFrameNavigator, { IFrameAttributes } from "../navigator/IFrameNavigator";
+import { IFrameNavigator, IFrameAttributes } from "../navigator/IFrameNavigator";
 import BookView from "./BookView";
 export default class FixedBookView implements BookView {
     layout: string;
-    constructor(_store: Store);
     delegate: IFrameNavigator;
     name: string;
     label: string;
@@ -25,4 +23,6 @@ export default class FixedBookView implements BookView {
     setSize(): void;
     isPaginated(): boolean;
     isScrollMode(): boolean;
+    atEnd(): boolean;
+    atStart(): boolean;
 }

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

@@ -1,7 +1,7 @@
 import { UserProperty } from "../model/user-settings/UserProperties";
 import Store from "../store/Store";
 import BookView from "./BookView";
-import IFrameNavigator, { IFrameAttributes } from "../navigator/IFrameNavigator";
+import { IFrameAttributes, IFrameNavigator } from "../navigator/IFrameNavigator";
 export default class ReflowableBookView implements BookView {
     layout: string;
     private readonly USERSETTINGS;
@@ -32,7 +32,7 @@ export default class ReflowableBookView implements BookView {
     getPageCount(): number;
     isPaginated(): boolean;
     isScrollMode(): boolean;
-    getProperty(name: string): Promise<UserProperty>;
+    getProperty(name: string): Promise<UserProperty | null>;
     getScreenHeight(): number;
     setIframeHeight(iframe: any): void;
     protected hasFixedScrollWidth: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-i-t-a/reader",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.7",
   "description": "A viewer application for EPUB files.",
   "repository": "https://github.com/d-i-t-a/R2D2BC",
   "license": "Apache-2.0",
@@ -17,9 +17,8 @@
     "clean": "rimraf node_modules dist parcel-dist .parcel-cache",
     "dev": "ts-node -T build.ts -w",
     "build": "ts-node -T build.ts",
-    "start": "node dev-server.js",
     "sass": "node-sass --source-map true src/styles/sass/ -o dist/",
-    "examples": "node --loader ts-node/esm examples/server.ts",
+    "examples": "npx ts-node examples/server.ts",
     "lint": "eslint '*/**/*.{js,ts,tsx}' --fix",
     "example:react": "parcel examples/react/index.html --dist-dir parcel-dist"
   },
@@ -27,14 +26,15 @@
     "browserslist-useragent": "^3.0.3",
     "cssesc": "^3.0.0",
     "detect-browser": "^5.2.0",
-    "devtools-detector": "^2.0.3",
+    "devtools-detector": "^2.0.6",
     "jscrypto": "0.0.1",
+    "lodash.clonedeep": "^4.5.0",
     "mark.js": "^8.11.1",
     "promise-polyfill": "^8.2.0",
-    "sentence-splitter": "^3.2.1",
-    "lodash.clonedeep": "^4.5.0",
     "r2-shared-js": "^1.0.51",
+    "recursive-readdir": "^2.2.2",
     "sanitize-html": "^2.3.3",
+    "sentence-splitter": "^3.2.1",
     "util": "^0.12.4",
     "whatwg-fetch": "^3.6.2"
   },
@@ -73,6 +73,7 @@
     "@types/uuid": "^8.3.0",
     "@typescript-eslint/eslint-plugin": "^4.21.0",
     "@typescript-eslint/parser": "^4.21.0",
+    "ansi-regex": ">=5.0.1",
     "babel-eslint": "^10.1.0",
     "braces": ">=3.0.2",
     "browserslist-useragent-regexp": "^3.0.0",
@@ -83,6 +84,7 @@
     "cpx": "^1.2.1",
     "debounce": "^1.2.1",
     "dita-streamer-js": "^1.1.1",
+    "ecstatic": ">=4.1.3",
     "esbuild": "^0.12.11",
     "eslint": "^7.23.0",
     "eslint-config-prettier": "^8.1.0",
@@ -94,6 +96,8 @@
     "eslint-plugin-react": "^7.23.2",
     "eslint-plugin-react-hooks": "^4.2.0",
     "express": "^4.17.1",
+    "glob-parent": ">=5.1.2",
+    "json-schema": ">=0.4.0",
     "materialize-css": "^1.0.0",
     "minimist": ">=1.2.5",
     "mocha": "^8.3.2",
@@ -110,8 +114,11 @@
     "rimraf": "^3.0.2",
     "sinon": "^10.0.0",
     "ta-json-x": "^2.5.3",
+    "tar": ">=6.1.9",
     "ts-loader": "^8.0.18",
-    "ts-node": "^10.0.0",
+    "ts-node": "^10.4.0",
+    "typedoc": "^0.22.5",
+    "typedoc-plugin-rename-defaults": "^0.4.0",
     "typescript": "^4.2.3"
   },
   "files": [