@internetarchive/bookreader 5.0.0-56 → 5.0.0-58

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 5.0.0-58
+- Fix BookReader sometimes failing to load when starting in Mode1Up @cdrini
+- Update testing dependencies @cdrini
+
+# 5.0.0-57
+- Fix - do not show Download pane when there aren't any available @iisa
+
 # 5.0.0-56
 - Fix DOMException in sandboxed iframe in chrome @cdrini
 

package/babel.config.js

@@ -2,8 +2,11 @@ module.exports = {
   presets: [
     [
       "@babel/preset-env",
-      process.env.NODE_ENV == 'test' ? { targets: {esmodules: true} } : {
-        targets: "> 2%, ie 11, edge 14, samsung > 9, OperaMini all, UCAndroid > 12, Safari >= 9",
+      {
+        targets: (
+          process.env.NODE_ENV == 'test' ? {node: process.version} :
+            "> 2%, ie 11, edge 14, samsung > 9, OperaMini all, UCAndroid > 12, Safari >= 9"
+        ),
         useBuiltIns: "usage",
         corejs: 3
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-56",
+  "version": "5.0.0-58",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",
@@ -42,12 +42,12 @@
   },
   "devDependencies": {
     "@babel/core": "7.17.9",
-    "@babel/eslint-parser": "7.17.0",
+    "@babel/eslint-parser": "7.21.3",
     "@babel/plugin-proposal-class-properties": "7.16.7",
     "@babel/plugin-proposal-decorators": "7.17.9",
     "@babel/preset-env": "7.16.11",
-    "@open-wc/testing-helpers": "^2.1.4",
-    "@types/jest": "^29.4.0",
+    "@open-wc/testing-helpers": "^2.2.0",
+    "@types/jest": "^29.5.0",
     "@webcomponents/webcomponentsjs": "^2.6.0",
     "babel-loader": "8.2.5",
     "codecov": "^3.8.3",
@@ -60,7 +60,7 @@
     "hammerjs": "^2.0.8",
     "http-server": "14.1.1",
     "iso-language-codes": "1.1.0",
-    "jest": "^29.4.3",
+    "jest": "29.5.0",
     "jest-environment-jsdom": "^29.4.3",
     "jquery": "3.6.1",
     "jquery-colorbox": "1.6.4",
@@ -72,10 +72,10 @@
     "node-fetch": "3.2.10",
     "regenerator-runtime": "0.13.9",
     "sass": "1.52.1",
-    "sinon": "^15.0.1",
+    "sinon": "15.0.3",
     "soundmanager2": "2.97.20170602",
     "svgo": "2.8.0",
-    "testcafe": "^2.0.1",
+    "testcafe": "2.4.0",
     "testcafe-browser-provider-browserstack": "^1.13.2-alpha.1",
     "webpack": "5.51.1",
     "webpack-cli": "4.9.2"
@@ -89,7 +89,8 @@
       "^@/(.*)$": "<rootDir>/$1"
     },
     "setupFiles": [
-      "./src/jquery-wrapper.js"
+      "./src/jquery-wrapper.js",
+      "./tests/jest/setup.js"
     ],
     "roots": [
       "<rootDir>/src/",
@@ -118,7 +119,7 @@
     "test:e2e": "npm run build && npx testcafe",
     "test:e2e:dev": "npx testcafe --live --dev",
     "DOCS:update:test-deps": "If CI succeeds, these should be good to update",
-    "update:test-deps": "npm i @babel/eslint-parser@latest @open-wc/testing-helpers@latest @types/jest@latest codecov@latest eslint@latest eslint-plugin-testcafe@latest jest@latest sinon@latest testcafe@latest",
+    "update:test-deps": "npm i @babel/eslint-parser@latest @open-wc/testing-helpers@latest @types/jest@latest codecov@latest eslint@7 eslint-plugin-testcafe@latest jest@latest sinon@latest testcafe@latest",
     "DOCS:update:build-deps": "These can cause strange changes, so do an npm run build + check file size (git diff --stat), and check the site is as expected",
     "update:build-deps": "npm i @babel/core@latest @babel/preset-env@latest babel-loader@latest core-js@latest regenerator-runtime@latest sass@latest svgo@latest webpack@latest webpack-cli@latest",
     "codecov": "npx codecov"

package/src/BookNavigator/book-navigator.js

@@ -164,7 +164,6 @@ export class BookNavigator extends LitElement {
    */
   initializeBookSubmenus() {
     const providers = {
-      downloads: new DownloadProvider(this.baseProviderConfig),
       share: new SharingProvider(this.baseProviderConfig),
       visualAdjustments: new VisualAdjustmentProvider({
         ...this.baseProviderConfig,
@@ -175,6 +174,10 @@ export class BookNavigator extends LitElement {
       }),
     };
 
+    if (this.shouldShowDownloadsMenu()) {
+      providers.downloads = new DownloadProvider(this.baseProviderConfig);
+    }
+
     if (this.bookreader.options.enableSearch) {
       providers.search = new SearchProvider({
         ...this.baseProviderConfig,
@@ -325,6 +328,7 @@ export class BookNavigator extends LitElement {
    * @returns {bool}
    */
   shouldShowDownloadsMenu() {
+    if (!this.downloadableTypes.length) { return false; }
     if (this.bookIsRestricted === false) { return true; }
     if (this.isAdmin) { return true; }
     const { user_loan_record = {} } = this.lendingStatus;

package/src/BookReader/Mode1Up.js

@@ -58,6 +58,11 @@ export class Mode1Up {
         });
       }
       this.mode1UpLit.jumpToIndex(startLeaf);
+      setTimeout(() => {
+        // Must explicitly call updateVisibleRegion, since no
+        // scroll event seems to fire.
+        this.mode1UpLit.updateVisibleRegion();
+      });
     });
     this.br.updateBrClasses();
   }

package/src/BookReader/Mode1UpLit.js

@@ -203,9 +203,12 @@ export class Mode1UpLit extends LitElement {
     }
     if (changedProps.has('visiblePages')) {
       this.throttledUpdateRenderedPages();
-      this.br.displayedIndices = this.visiblePages.map(p => p.index);
-      this.br.updateFirstIndex(this.br.displayedIndices[0]);
-      this.br._components.navbar.updateNavIndexThrottled();
+      if (this.visiblePages.length) {
+        // unclear why this is ever really happening
+        this.br.displayedIndices = this.visiblePages.map(p => p.index);
+        this.br.updateFirstIndex(this.br.displayedIndices[0]);
+        this.br._components.navbar.updateNavIndexThrottled();
+      }
     }
     if (changedProps.has('scale')) {
       const oldVal = changedProps.get('scale');

package/tests/jest/BookNavigator/book-navigator.test.js

@@ -148,6 +148,9 @@ describe('<book-navigator>', () => {
         el.bookreader = brStub;
         await el.elementUpdated;
 
+        el.downloadableTypes = ['foo/bar'];
+        await el.elementUpdated;
+
         el.initializeBookSubmenus();
         await el.elementUpdated;
         const defaultMenus = Object.keys(el.menuProviders);
@@ -229,6 +232,27 @@ describe('<book-navigator>', () => {
         expect(baseConfigKeys).toContain('isAdmin');
         expect(baseConfigKeys).toContain('onProviderChange');
       });
+
+      test('Downloads panel - does not show if no available `downloadableTypes`', async () => {
+        const el = fixtureSync(container());
+        const $brContainer = document.createElement('div');
+        const brStub = {
+          resize: sinon.fake(),
+          currentIndex: sinon.fake(),
+          jumpToIndex: sinon.fake(),
+          options: {},
+          refs: {
+            $brContainer
+          }
+        };
+        el.bookreader = brStub;
+        await el.elementUpdated;
+
+        el.initializeBookSubmenus();
+        await el.elementUpdated;
+        const defaultMenus = Object.keys(el.menuProviders);
+        expect(defaultMenus.find(menu => menu === 'downloads')).toBeUndefined;
+      });
     });
 
     describe('Controlling Menu Side Panel & Shortcuts', () => {

package/tests/jest/setup.js

@@ -0,0 +1,3 @@
+process.on("unhandledRejection", (error) => {
+  throw error;
+});