V2 enabled strict null check (#316)

* Enabled strict null check * Cleanup sample implementations * makes findRequiredElement & findElement generic and make sure it's an instance if HTMLElement * non optional internal rights, this is a minor change but seems to fulfill the issue. * hide position slider if no positions available. * several lines focus position fixes
d-i-t-a · Jan 22, 2022 · f80f13a · f80f13a
1 parent 2a4e881
commit f80f13a
Show file tree

Hide file tree

Showing 55 changed files with 4,513 additions and 4,607 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/D2Reader.html b/docs/classes/D2Reader.html
diff --git a/docs/modules.html b/docs/modules.html
@@ -1,3 +1,3 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@d-i-t-a/reader</title><meta name="description" content="Documentation for @d-i-t-a/reader"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@d-i-t-a/reader</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@d-i-t-a/reader</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/D2Reader.html" class="tsd-kind-icon">D2<wbr/>Reader</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#load" class="tsd-kind-icon">load</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a id="load" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> load</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>initialConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReaderConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="classes/D2Reader.html" class="tsd-signature-type" data-tsd-kind="Class">D2Reader</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/d-i-t-a/R2D2BC/blob/14a117d/src/index.ts#L25">index.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@d-i-t-a/reader</title><meta name="description" content="Documentation for @d-i-t-a/reader"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@d-i-t-a/reader</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@d-i-t-a/reader</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/D2Reader.html" class="tsd-kind-icon">D2<wbr/>Reader</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#load" class="tsd-kind-icon">load</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a id="load" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> load</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>initialConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReaderConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="classes/D2Reader.html" class="tsd-signature-type" data-tsd-kind="Class">D2Reader</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/d-i-t-a/R2D2BC/blob/7420fdc/src/index.ts#L25">index.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>for interop with &lt;script&gt; based usage</p>
 </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>initialConfig: <span class="tsd-signature-type">ReaderConfig</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="classes/D2Reader.html" class="tsd-signature-type" data-tsd-kind="Class">D2Reader</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/D2Reader.html" class="tsd-kind-icon">D2<wbr/>Reader</a></li><li class="tsd-kind-function"><a href="modules.html#load" class="tsd-kind-icon">load</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
diff --git a/examples/react/index.tsx b/examples/react/index.tsx
@@ -25,11 +25,11 @@ const App = () => {
   }, []);
 
   function scroll() {
-    reader.scroll(true);
+    reader?.scroll(true);
     didUpdate();
   }
   function paginate() {
-    reader.scroll(false);
+    reader?.scroll(false);
     didUpdate();
   }
 

diff --git a/examples/react/tsconfig.json b/examples/react/tsconfig.json
@@ -34,9 +34,9 @@
     "sourceMap": true,
     "declaration": true,
     "preserveConstEnums": true,
-    "strictNullChecks": false,
+    "strictNullChecks": true,
     "target": "es6",
     "skipLibCheck": true,
     "jsx": "react",
   },
-}
+}
diff --git a/injectables/tsconfig.json b/injectables/tsconfig.json
@@ -35,8 +35,8 @@
     "sourceMap": true,
     "declaration": true,
     "preserveConstEnums": true,
-    "strictNullChecks": false,
+    "strictNullChecks": true,
     "target": "es6",
     "esModuleInterop": true
   },
-}
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -17,7 +17,6 @@
     "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": "npx ts-node examples/server.ts",
     "lint": "eslint '*/**/*.{js,ts,tsx}' --fix",
@@ -74,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",
@@ -84,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",
@@ -95,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",
@@ -111,16 +114,12 @@
     "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",
-    "glob-parent": ">=5.1.2",
-    "tar": ">=6.1.9",
-    "ecstatic": ">=4.1.3",
-    "ansi-regex": ">=5.0.1",
-    "json-schema": ">=0.4.0"
+    "typescript": "^4.2.3"
   },
   "files": [
     "dist"

diff --git a/src/model/Link.ts b/src/model/Link.ts
@@ -21,7 +21,7 @@ import { Link as R2Link } from "r2-shared-js/dist/es6-es2015/src/models/publicat
 import { JsonObject } from "ta-json-x";
 
 export class D2Link {
-  href?: string;
+  href: string;
   type?: string;
   title?: string;
 }