@internetarchive/bookreader 5.0.0-93 → 5.0.0-95

package/.github/workflows/npm-publish.yml

@@ -1,5 +1,5 @@
 # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+# For more information see: https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-nodejs-packages
 
 name: Node.js Package
 
@@ -8,18 +8,7 @@ on:
     types: [created]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npm ci
-      - run: npm test
-
   publish-npm:
-    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -28,6 +17,7 @@ jobs:
           node-version: 20
           registry-url: https://registry.npmjs.org/
       - run: npm ci
+      - run: npm run build
       - run: npm publish --tag next
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/BookReaderDemo/IADemoBr.js

@@ -45,23 +45,6 @@ BookReader.optionOverrides.imagesBaseURL = '/BookReader/images/';
 const initializeBookReader = (brManifest) => {
   console.log('initializeBookReader', brManifest);
 
-  const {bookPath, subPrefix} = brManifest.data.brOptions;
-  let path = bookPath;
-  const subPrefixWithSlash = `/${subPrefix}`;
-  if (bookPath.length - bookPath.lastIndexOf(subPrefixWithSlash) == subPrefixWithSlash.length) {
-    path = bookPath.substr(0, bookPath.length - subPrefixWithSlash.length);
-  }
-
-  const searchInsideUrl = '//{{server}}/fulltext/inside.php?' + [
-    'item_id={{bookId|urlencode}}',
-    'doc={{subPrefix|urlencode}}',
-    'q={{query|urlencode}}',
-    // This endpoint doesn't expect the path to be url encoded
-    `path=${encodeURIComponent(path).replace(/%2F/g, '/')}`,
-    'pre_tag={{preTag|urlencode}}',
-    'post_tag={{postTag|urlencode}}',
-  ].join('&');
-
   const options = {
     el: '#BookReader',
     /* Url plugin - IA uses History mode for URL */
@@ -74,6 +57,7 @@ const initializeBookReader = (brManifest) => {
     // urlTrackedParams: ['page', 'search', 'mode'],
     /* End url plugin */
     enableBookTitleLink: false,
+    bookUri: `https://archive.org/details/${ocaid}`,
     bookUrlText: null,
     startFullscreen: openFullImmersionTheater,
     // leaving this option commented out bc we change given user agent on archive.org
@@ -86,16 +70,9 @@ const initializeBookReader = (brManifest) => {
     /* End multiple volumes */
     enableBookmarks: true, // turn this on
     enableFSLogoShortcut: true,
-
-    // TMP: To be replaced once BookReaderJSIA is updated to provide
-    // these in the right spot.
     plugins: {
       search: {
-        enabled: true,
         initialSearchTerm: searchTerm ? searchTerm : '',
-        searchInsideUrl,
-        preTag: brManifest.data.brOptions.searchInsidePreTag,
-        postTag: brManifest.data.brOptions.searchInsidePostTag,
       },
     },
   };

package/BookReaderDemo/demo-internetarchive.html

@@ -30,6 +30,7 @@
     <script src="../BookReader/plugins/plugin.resume.js"></script>
     <script src="../BookReader/plugins/plugin.archive_analytics.js"></script>
     <script src="../BookReader/plugins/plugin.text_selection.js"></script>
+    <script src="../BookReader/plugins/plugin.experiments.js"></script>
 
     <script type="module" src="../BookReader/ia-bookreader-bundle.js"></script>
 

package/CHANGELOG.md

@@ -1,5 +1,23 @@
+# 5.0.0-95
+- Breaking change: Remove BookReader/ build directory from repo @cdrini
+  - This pattern has become increasingly rare (even jQuery is no longer doing this). If someone was relying on this somehow, you should be able to achieve the same effect using unpkg, or jsdelivr, or similar, eg:
+    - https://unpkg.com/@internetarchive/bookreader@5.0.0-94/BookReader/BookReader.js
+    - https://cdn.jsdelivr.net/npm/@internetarchive/bookreader@5.0.0-94/BookReader/BookReader.js
+    - And so on.
+
+# 5.0.0-94
+- Refactor: Make bookreader package type: module @cdrini
+- Fix: Search icon being fetched from wrong path @cdrini
+- Refactor: Move BookReader._plugins -> BookReader.plugins , making it public @cdrini
+- Feature: Add length restrictions for protected text selection @cdrini
+- Extend BR to work correctly with Hypothesis @cdrini
+  - Creates new experiments plugin, with a Hypothesis experiment
+  - Adds no `bookUri` option for saving Hypothesis annotations
+  - Adds new public HTML attributes to the PageContainer DOM, `data-index` for `PageIndex`, and `data-page-num` for `PageNumString`
+  - Improves some of BookReader's public APIs. BookReader.bind/unbind are now deprecated in favor of BookReader.on/off
+
 # 5.0.0-93
-- Fix: Clicking on search result not making request_page requst correctly @cdrini
+- Fix: Clicking on search result not making request_page request correctly @cdrini
 
 # 5.0.0-92
 - Refactor: Migrate search plugin to BookReaderPlugin system @cdrini

package/README.md

@@ -147,8 +147,6 @@ The Fragment Change message is sent to the parent window when the embedded BookR
 
 The source JavaScript is written in ES6 (located in the `src/js` directory) and in ES5 (located in `BookReader`). `npm run serve-dev` starts an auto-reloading dev server, that builds js/css that has been edited at `localhost:8000`.
 
-Until the next major version bump, we have to store the build files inside the repo to maintain backwards compatibility. Please _DO NOT_ include these files in your PR. Anything in the `BookReader/` directory should not be committed.
-
 ### Developing icons
 To see local icon package changes in bookreader, you'll need to install core-js into the icon package and link into bookreader.
 

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-93",
+  "version": "5.0.0-95",
   "description": "The Internet Archive BookReader.",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/internetarchive/bookreader.git"
@@ -58,6 +59,7 @@
     "eslint-plugin-no-jquery": "^2.7.0",
     "eslint-plugin-testcafe": "^0.2.1",
     "http-server": "14.1.1",
+    "hypothesis": "^1.1627.0",
     "interactjs": "^1.10.18",
     "iso-language-codes": "1.1.0",
     "jest": "29.7.0",
@@ -99,16 +101,18 @@
     "preversion": "npm run test && node scripts/preversion.js",
     "version": "node scripts/version.js",
     "postversion": "node scripts/postversion.js",
-    "build": "npm run clean && npx concurrently --group npm:build-js npm:build-css npm:build-assets",
+    "build": "npm run clean && npx concurrently --group npm:build-js npm:build-css npm:build-assets npm:build-hypothesis",
     "build-assets": "npx cpx \"src/assets/**/*\" BookReader && npx svgo -f BookReader/icons && npx svgo -f BookReader/images",
     "build-assets:watch": "npx cpx --watch --verbose \"src/assets/**/*\" BookReader",
+    "build-hypothesis": "npx cpx \"node_modules/hypothesis/**/*\" BookReader/hypothesis",
+    "build-hypothesis:watch": "npx cpx --watch --verbose \"node_modules/hypothesis/**/*\" BookReader/hypothesis",
     "build-js": "npx webpack",
     "build-js:watch": "npx webpack --mode=development --watch",
     "build-css": "npx sass --no-source-map ./src/css/BookReader.scss ./BookReader/BookReader.css",
     "build-css:watch": "npx sass --watch --no-source-map ./src/css/BookReader.scss ./BookReader/BookReader.css",
     "clean": "rm -r BookReader/ || true",
-    "lint": "npx eslint src/ tests/ *.js",
-    "lint:fix": "npx eslint --fix src/ tests/ *.js",
+    "lint": "npx eslint src/ tests/ *.js *.cjs",
+    "lint:fix": "npx eslint --fix src/ tests/ *.js *.cjs",
     "serve": "npx http-server . --port=8000",
     "serve-live": "npx live-server . --cors --port=8000 --watch=index.html,BookReader,BookReaderDemo",
     "serve-dev": "env NODE_ENV='development' npm run build-css && env NODE_ENV='development' npx concurrently --kill-others npm:serve-live npm:build-*:watch",

package/scripts/postversion.js

@@ -1,5 +1,6 @@
-const fs = require('fs');
-const { version: NEW_VERSION } = require('../package.json');
+import fs from 'fs';
+import PACKAGE_JSON from '../package.json' assert { type: 'json' };
+const NEW_VERSION = PACKAGE_JSON.version;
 
 const tag = `v${NEW_VERSION}`;
 const releaseBody = fs.readFileSync('CHANGELOG.md').toString()

package/scripts/preversion.js

@@ -1,4 +1,6 @@
-const { version: OLD_VERSION } = require('../package.json');
+import PACKAGE_JSON from '../package.json' assert { type: 'json' };
+
+const OLD_VERSION = PACKAGE_JSON.version;
 const OLD_RELEASE_URL = `https://api.github.com/repos/internetarchive/bookreader/releases/tags/v${OLD_VERSION}`;
 
 async function main() {

package/scripts/version.js

@@ -1,6 +1,7 @@
-const fs = require('fs');
-const { execSync } = require('child_process');
-const { version: NEW_VERSION } = require('../package.json');
+import fs from 'fs';
+import { execSync } from 'child_process';
+import PACKAGE_JSON from '../package.json' assert { type: 'json' };
+const NEW_VERSION = PACKAGE_JSON.version;
 
 async function main() {
     // Update the changelog
@@ -18,9 +19,6 @@ async function main() {
 
     // build
     execSync('npm run build', { stdio: "inherit" });
-
-    // Add build files
-    execSync('git add ./BookReader');
 }
 
 main().then(() => process.exit());

package/src/BookNavigator/book-navigator.js

@@ -10,6 +10,7 @@ import BookmarksProvider from './bookmarks/bookmarks-provider.js';
 import SharingProvider from './sharing.js';
 import ViewableFilesProvider from './viewable-files.js';
 import iaLogo from './assets/ia-logo.js';
+import { sortBy } from '../BookReader/utils.js';
 /** @typedef {import('@/src/BookReader.js').default} BookReader */
 
 const events = {
@@ -51,7 +52,20 @@ export class BookNavigator extends LitElement {
     this.isAdmin = false;
     this.lendingInitialized = false;
     this.lendingStatus = {};
-    this.menuProviders = {};
+    this.menuProviders = {
+      /** @type {BookmarksProvider} */
+      bookmarks: null,
+      /** @type {SearchProvider} */
+      search: null,
+      /** @type {DownloadProvider} */
+      downloads: null,
+      /** @type {VisualAdjustmentProvider} */
+      visualAdjustments: null,
+      /** @type {SharingProvider} */
+      share: null,
+      /** @type {ViewableFilesProvider} */
+      volumes: null,
+    };
     this.menuShortcuts = [];
     this.signedIn = false;
     /** @type {ModalManager} */
@@ -73,6 +87,10 @@ export class BookNavigator extends LitElement {
       'chapters',
       'search',
       'bookmarks',
+      'downloads',
+      'visualAdjustments',
+      'share',
+      'experiments',
     ];
   }
 
@@ -313,14 +331,20 @@ export class BookNavigator extends LitElement {
    * Sets order of menu and emits custom event when done
    */
   updateMenuContents() {
-    const {
-      search, downloads, visualAdjustments, share, bookmarks, volumes, chapters,
-    } = this.menuProviders;
-    const availableMenus = [volumes, chapters, search, bookmarks, visualAdjustments, share].filter((menu) => !!menu);
+    const availableMenus = sortBy(
+      Object.entries(this.menuProviders)
+        .filter(([id, menu]) => !!menu)
+        .filter(([id, menu]) => {
+          return id === 'downloads' ? this.shouldShowDownloadsMenu() : true;
+        }),
+      ([id, menu]) => {
+        const index = this.shortcutOrder.indexOf(id);
+        return index === -1 ? this.shortcutOrder.length : index;
+      },
+    ).map(([id, menu]) => menu);
 
     if (this.shouldShowDownloadsMenu()) {
-      downloads?.update(this.downloadableTypes);
-      availableMenus.splice(-2, 0, downloads);
+      this.menuProviders.downloads?.update(this.downloadableTypes);
     }
 
     const event = new CustomEvent(
@@ -387,11 +411,13 @@ export class BookNavigator extends LitElement {
    * the id in each iteration over the shortcutOrder array.
    */
   sortMenuShortcuts() {
-    this.menuShortcuts = this.shortcutOrder.reduce((shortcuts, id) => {
-      const menu = this.menuShortcuts.find((m) => m.id === id);
-      if (menu) { shortcuts.push(menu); }
-      return shortcuts;
-    }, []);
+    this.menuShortcuts = sortBy(
+      this.menuShortcuts,
+      (shortcut) => {
+        const index = this.shortcutOrder.indexOf(shortcut.id);
+        return index === -1 ? this.shortcutOrder.length : index;
+      },
+    );
   }
 
   emitMenuShortcutsUpdated() {

package/src/BookNavigator/downloads/downloads-provider.js

@@ -1,6 +1,6 @@
 import { html } from 'lit';
-import '@internetarchive/icon-dl/icon-dl';
-import './downloads';
+import '@internetarchive/icon-dl/icon-dl.js';
+import './downloads.js';
 
 const menuBase = {
   pdf: {

package/src/BookNavigator/search/search-provider.js

@@ -1,7 +1,7 @@
 // @ts-check
 import { html, nothing } from 'lit';
-import '@internetarchive/icon-search/icon-search';
-import './search-results';
+import '@internetarchive/icon-search/icon-search.js';
+import './search-results.js';
 /** @typedef {import('@/src/plugins/search/plugin.search.js').SearchInsideMatch} SearchInsideMatch */
 /** @typedef {import('@/src/plugins/search/plugin.search.js').SearchInsideResults} SearchInsideResults */
 /** @typedef {import('@/src/BookReader.js').default} BookReader */
@@ -143,7 +143,7 @@ export default class SearchProvider {
   }
 
   searchCanceledInMenu() {
-    this.bookreader._plugins.search.cancelSearchRequest();
+    this.bookreader.plugins.search.cancelSearchRequest();
   }
 
   onSearchResultsCleared() {
@@ -155,7 +155,7 @@ export default class SearchProvider {
       errorMessage: '',
     };
     this.updateMenu({ openMenu: false });
-    this.bookreader._plugins.search.searchView.clearSearchFieldAndResults(false);
+    this.bookreader.plugins.search.searchView.clearSearchFieldAndResults(false);
     if (this.bookreader.urlPlugin) {
       this.updateSearchInUrl();
     }
@@ -204,6 +204,6 @@ export default class SearchProvider {
    * @param {{ detail: {match: SearchInsideMatch} }} param0
    */
   onSearchResultsClicked({ detail }) {
-    this.bookreader._plugins.search.jumpToMatch(detail.match.matchIndex);
+    this.bookreader.plugins.search.jumpToMatch(detail.match.matchIndex);
   }
 }

package/src/BookNavigator/search/search-results.js

@@ -1,7 +1,7 @@
 /* eslint-disable class-methods-use-this */
 import { unsafeHTML } from 'lit/directives/unsafe-html.js';
 import { css, html, LitElement, nothing } from 'lit';
-import '@internetarchive/ia-activity-indicator/ia-activity-indicator';
+import '@internetarchive/ia-activity-indicator/ia-activity-indicator.js';
 import checkmarkIcon from '../assets/icon_checkmark.js';
 import closeIcon from '../assets/icon_close.js';
 import buttonCSS from '../assets/button-base.js';

package/src/BookNavigator/sharing.js

@@ -1,6 +1,6 @@
 import { html } from 'lit';
-import { iauxShareIcon } from '@internetarchive/ia-item-navigator/dist/src/menus/share-panel';
-import '@internetarchive/ia-item-navigator/dist/src/menus/share-panel';
+import { iauxShareIcon } from '@internetarchive/ia-item-navigator/dist/src/menus/share-panel.js';
+import '@internetarchive/ia-item-navigator/dist/src/menus/share-panel.js';
 
 export default class SharingProvider {
   constructor({

package/src/BookNavigator/viewable-files.js

@@ -1,7 +1,7 @@
 import { html } from 'lit';
 
-import { viewableFilesIcon  } from '@internetarchive/ia-item-navigator/dist/src/menus/viewable-files';
-import '@internetarchive/ia-item-navigator/dist/src/menus/viewable-files';
+import { viewableFilesIcon  } from '@internetarchive/ia-item-navigator/dist/src/menus/viewable-files.js';
+import '@internetarchive/ia-item-navigator/dist/src/menus/viewable-files.js';
 
 /**
  * * @typedef { 'title_asc' | 'title_desc' | 'default'} SortTypesT

package/src/BookNavigator/visual-adjustments/visual-adjustments-provider.js

@@ -1,6 +1,6 @@
 import { html } from 'lit';
-import '@internetarchive/icon-visual-adjustment/icon-visual-adjustment';
-import './visual-adjustments';
+import '@internetarchive/icon-visual-adjustment/icon-visual-adjustment.js';
+import './visual-adjustments.js';
 
 const visualAdjustmentOptions = [{
   id: 'brightness',
@@ -45,7 +45,7 @@ export default class VisualAdjustmentsProvider {
     this.icon = html`<ia-icon-visual-adjustment style="width: var(--iconWidth); height: var(--iconHeight);"></ia-icon-visual-adjustment>`;
     this.label = 'Visual Adjustments';
     this.menuDetails = this.updateOptionsCount();
-    this.id = 'adjustment';
+    this.id = 'visualAdjustments';
     this.component = html`
       <ia-book-visual-adjustments
         .options=${visualAdjustmentOptions}

package/src/BookNavigator/visual-adjustments/visual-adjustments.js

@@ -2,8 +2,8 @@ import { css, html, LitElement } from "lit";
 import { repeat } from "lit/directives/repeat.js";
 import { nothing } from "lit";
 import checkmarkIcon from '../assets/icon_checkmark.js';
-import "@internetarchive/icon-magnify-minus/icon-magnify-minus";
-import "@internetarchive/icon-magnify-plus/icon-magnify-plus";
+import "@internetarchive/icon-magnify-minus/icon-magnify-minus.js";
+import "@internetarchive/icon-magnify-plus/icon-magnify-plus.js";
 
 const namespacedEvent = (eventName) => `visualAdjustment${eventName}`;
 

package/src/BookReader.js

@@ -37,10 +37,10 @@ import { Toolbar } from './BookReader/Toolbar/Toolbar.js';
 import { BookModel } from './BookReader/BookModel.js';
 import { Mode1Up } from './BookReader/Mode1Up.js';
 import { Mode2Up } from './BookReader/Mode2Up.js';
-import { ModeThumb } from './BookReader/ModeThumb';
+import { ModeThumb } from './BookReader/ModeThumb.js';
 import { ImageCache } from './BookReader/ImageCache.js';
 import { PageContainer } from './BookReader/PageContainer.js';
-import { NAMED_REDUCE_SETS } from './BookReader/ReduceSet';
+import { NAMED_REDUCE_SETS } from './BookReader/ReduceSet.js';
 
 /**
  * BookReader
@@ -134,7 +134,7 @@ BookReader.prototype.setup = function(options) {
   this.bookPath = options.bookPath;
 
   // Construct the usual plugins first to get type hints
-  this._plugins = {
+  this.plugins = {
     archiveAnalytics: BookReader.PLUGINS.archiveAnalytics ? new BookReader.PLUGINS.archiveAnalytics(this) : null,
     autoplay: BookReader.PLUGINS.autoplay ? new BookReader.PLUGINS.autoplay(this) : null,
     chapters: BookReader.PLUGINS.chapters ? new BookReader.PLUGINS.chapters(this) : null,
@@ -145,18 +145,18 @@ BookReader.prototype.setup = function(options) {
   };
 
   // Delete anything that's null
-  for (const [pluginName, plugin] of Object.entries(this._plugins)) {
-    if (!plugin) delete this._plugins[pluginName];
+  for (const [pluginName, plugin] of Object.entries(this.plugins)) {
+    if (!plugin) delete this.plugins[pluginName];
   }
 
   // Now construct the rest of the plugins
   for (const [pluginName, PluginClass] of Object.entries(BookReader.PLUGINS)) {
-    if (this._plugins[pluginName] || !PluginClass) continue;
-    this._plugins[pluginName] = new PluginClass(this);
+    if (this.plugins[pluginName] || !PluginClass) continue;
+    this.plugins[pluginName] = new PluginClass(this);
   }
 
   // And call setup on them
-  for (const [pluginName, plugin] of Object.entries(this._plugins)) {
+  for (const [pluginName, plugin] of Object.entries(this.plugins)) {
     try {
       plugin.setup(this.options.plugins?.[pluginName] ?? {});
       // Write the options back; this way the plugin is the source of truth,
@@ -167,9 +167,9 @@ BookReader.prototype.setup = function(options) {
     }
   }
 
-  if (this._plugins.search?.options.enabled) {
+  if (this.plugins.search?.options.enabled) {
     // Expose the search method for convenience / backward compat
-    this.search = this._plugins.search.search.bind(this._plugins.search);
+    this.search = this.plugins.search.search.bind(this.plugins.search);
   }
 
   /** @type {number} @deprecated some past iterations set this */
@@ -426,9 +426,9 @@ BookReader.prototype.initParams = function() {
   }
 
   // Check for Resume plugin
-  if (this._plugins.resume?.options.enabled) {
+  if (this.plugins.resume?.options.enabled) {
     // Check cookies
-    const val = this._plugins.resume.getResumeValue();
+    const val = this.plugins.resume.getResumeValue();
     if (val !== null) {
       // If page index different from default
       if (params.index !== val) {
@@ -462,8 +462,8 @@ BookReader.prototype.initParams = function() {
   }
 
   // Check for Search plugin
-  if (this._plugins.search?.options.enabled) {
-    const sp = this._plugins.search;
+  if (this.plugins.search?.options.enabled) {
+    const sp = this.plugins.search;
     // Go to first result only if no default or URL page
     sp.options.goToFirstResult = !params.pageFound;
 
@@ -619,7 +619,7 @@ BookReader.prototype.init = function() {
     const $navBar = this.initNavbar();
 
     // extend navbar with plugins
-    for (const plugin of Object.values(this._plugins)) {
+    for (const plugin of Object.values(this.plugins)) {
       plugin.extendNavBar($navBar);
     }
   }
@@ -660,7 +660,7 @@ BookReader.prototype.init = function() {
   }
 
   // If not searching, set to allow on-going fragment changes
-  if (!this._plugins.search?.options.initialSearchTerm) {
+  if (!this.plugins.search?.options.initialSearchTerm) {
     this.suppressFragmentChange = false;
   }
 
@@ -669,7 +669,7 @@ BookReader.prototype.init = function() {
   }
 
   // Init plugins
-  for (const [pluginName, plugin] of Object.entries(this._plugins)) {
+  for (const [pluginName, plugin] of Object.entries(this.plugins)) {
     try {
       plugin.init();
     }
@@ -702,14 +702,28 @@ BookReader.prototype.trigger = function(name, props = this) {
   $(document).trigger(eventName, props);
 };
 
-BookReader.prototype.bind = function(name, callback) {
+BookReader.prototype.on = function(name, callback) {
   $(document).on('BookReader:' + name, callback);
 };
 
-BookReader.prototype.unbind = function(name, callback) {
+BookReader.prototype.off = function(name, callback) {
   $(document).off('BookReader:' + name, callback);
 };
 
+/**
+ * @deprecated Use .on and .off instead
+ */
+BookReader.prototype.bind = function(name, callback) {
+  return this.on(name, callback);
+};
+
+/**
+ * @deprecated Use .on and .off instead
+ */
+BookReader.prototype.unbind = function(name, callback) {
+  return this.off(name, callback);
+};
+
 /**
  * Resizes based on the container width and height
  */
@@ -874,7 +888,7 @@ BookReader.prototype._createPageContainer = function(index) {
   });
 
   // Call plugin handlers
-  for (const plugin of Object.values(this._plugins)) {
+  for (const plugin of Object.values(this.plugins)) {
     plugin._configurePageContainer(pageContainer);
   }
 
@@ -927,7 +941,7 @@ BookReader.prototype.zoom = function(direction) {
   } else {
     this.activeMode.zoom('out');
   }
-  this._plugins.textSelection?.stopPageFlip(this.refs.$brContainer);
+  this.plugins.textSelection?.stopPageFlip(this.refs.$brContainer);
   return;
 };
 
@@ -1105,7 +1119,7 @@ BookReader.prototype.getPrevReadMode = function(mode) {
 
 /**
  * Switches the mode (eg 1up 2up thumb)
- * @param {number}
+ * @param {number|'1up' | '2up' | 'thumb'}
  * @param {object} [options]
  * @param {boolean} [options.suppressFragmentChange = false]
  * @param {boolean} [options.onInit = false] - this
@@ -1118,6 +1132,18 @@ BookReader.prototype.switchMode = function(
     pageFound = false,
   } = {},
 ) {
+  if (typeof mode === 'string') {
+    mode = {
+      '1up': this.constMode1up,
+      '2up': this.constMode2up,
+      'thumb': this.constModeThumb,
+    }[mode];
+  }
+
+  if (!mode) {
+    throw new Error(`Invalid mode: ${mode}`);
+  }
+
   // Skip checks before init() complete
   if (this.init.initComplete) {
     if (mode === this.mode) {
@@ -1162,7 +1188,7 @@ BookReader.prototype.switchMode = function(
   const eventName = mode + 'PageViewSelected';
   this.trigger(BookReader.eventNames[eventName]);
 
-  this._plugins.textSelection?.stopPageFlip(this.refs.$brContainer);
+  this.plugins.textSelection?.stopPageFlip(this.refs.$brContainer);
 };
 
 BookReader.prototype.updateBrClasses = function() {
@@ -1234,7 +1260,7 @@ BookReader.prototype.enterFullscreen = async function(bindKeyboardControls = tru
   }
   this.jumpToIndex(currentIndex);
 
-  this._plugins.textSelection?.stopPageFlip(this.refs.$brContainer);
+  this.plugins.textSelection?.stopPageFlip(this.refs.$brContainer);
   // Add "?view=theater"
   this.trigger(BookReader.eventNames.fragmentChange);
   // trigger event here, so that animations,
@@ -1280,7 +1306,7 @@ BookReader.prototype.exitFullScreen = async function () {
     await this.activeMode.mode1UpLit.updateComplete;
   }
 
-  this._plugins.textSelection?.stopPageFlip(this.refs.$brContainer);
+  this.plugins.textSelection?.stopPageFlip(this.refs.$brContainer);
   // Remove "?view=theater"
   this.trigger(BookReader.eventNames.fragmentChange);
   this.refs.$br.removeClass('BRfullscreenAnimation');
@@ -1324,7 +1350,7 @@ BookReader.prototype.updateFirstIndex = function(
   // If there's an initial search we stop suppressing global URL changes
   // when local suppression ends
   // This seems to correctly handle multiple calls during mode/1up
-  if (this._plugins.search.options.initialSearchTerm && !suppressFragmentChange) {
+  if (this.plugins.search?.options.initialSearchTerm && !suppressFragmentChange) {
     this.suppressFragmentChange = false;
   }
 
@@ -1601,7 +1627,7 @@ BookReader.prototype.bindNavigationHandlers = function() {
     });
 
   // Call _bindNavigationHandlers on the plugins
-  for (const plugin of Object.values(this._plugins)) {
+  for (const plugin of Object.values(this.plugins)) {
     plugin._bindNavigationHandlers();
   }
 };
@@ -1653,8 +1679,8 @@ BookReader.prototype.updateFromParams = function(params) {
   // process /search
   // @deprecated for urlMode 'history'
   // Continues to work for urlMode 'hash'
-  if (this._plugins.search?.enabled && 'undefined' != typeof(params.search)) {
-    if (this._plugins.search.searchTerm !== params.search) {
+  if (this.plugins.search?.enabled && 'undefined' != typeof(params.search)) {
+    if (this.plugins.search.searchTerm !== params.search) {
       this.$('.BRsearchInput').val(params.search);
     }
   }
@@ -1858,8 +1884,8 @@ BookReader.prototype.paramsFromCurrent = function() {
     params.view = fullscreenView;
   }
   // Search
-  if (this._plugins.search?.enabled) {
-    params.search = this._plugins.search.searchTerm;
+  if (this.plugins.search?.enabled) {
+    params.search = this.plugins.search.searchTerm;
   }
 
   return params;