@internetarchive/bookreader 5.0.0-12-fixsorting-8 → 5.0.0-120

package/src/BookReader/Toolbar/Toolbar.js

@@ -53,12 +53,17 @@ export class Toolbar {
         $('<a>')
           .attr({href: br.bookUrl, title: br.bookUrlTitle})
           .addClass('BRreturn')
-          .html(br.bookUrlText || br.bookTitle)
+          .html(br.bookUrlText || br.bookTitle),
       );
     } else if (br.bookTitle) {
       $titleSectionEl.append(br.bookUrlText || br.bookTitle);
     }
 
+    // Call _bindNavigationHandlers on the plugins
+    for (const plugin of Object.values(br.plugins)) {
+      plugin._configureToolbar(br.refs.$BRtoolbar);
+    }
+
     // const $hamburger = br.refs.$BRtoolbar.find('BRtoolbarHamburger');
     return br.refs.$BRtoolbar;
   }
@@ -75,8 +80,6 @@ export class Toolbar {
     br.$('.BRnavCntl').addClass('BRup');
     br.$('.pause').hide();
 
-    this.updateToolbarZoom(br.reduce); // Pretty format
-
     // We build in mode 2
     br.refs.$BRtoolbar.append();
 
@@ -115,7 +118,7 @@ export class Toolbar {
       onLoad: () => {
         br.trigger(EVENTS.stop);
         br.$('.BRpageviewValue').val(window.location.href);
-      }
+      },
     });
     br.$('.info').colorbox({
       inline: true,
@@ -123,35 +126,10 @@ export class Toolbar {
       href: br.$('.BRinfo'),
       onLoad: () => {
         br.trigger(EVENTS.stop);
-      }
+      },
     });
   }
 
-  /**
-   * @deprecated
-   * @todo .BRzoom doesn't exist anywhere, so this is likely dead code
-   * Update the displayed zoom factor based on reduction factor
-   * @param {number} reduce
-   */
-  updateToolbarZoom(reduce) {
-    const { br } = this;
-    // $$$ TODO preserve zoom/fit for each mode
-    const autofit = br.mode == br.constMode2up ? br.twoPage.autofit : br.onePage.autofit;
-    /** @type {string} */
-    let value;
-    if (autofit) {
-      value = autofit.slice(0,1).toUpperCase() + autofit.slice(1);
-    } else {
-      value = (100 / reduce)
-        .toFixed(2)
-        // Strip trailing zeroes and decimal if all zeroes
-        .replace(/0+$/,'')
-        .replace(/\.$/,'')
-        + '%';
-    }
-    br.$('.BRzoom').text(value);
-  }
-
   /**
    * @param {JQuery} $shareDiv
    */
@@ -212,11 +190,11 @@ export class Toolbar {
     $form.appendTo($shareDiv);
 
     $form.find('.fieldset-embed input').on('change', event => {
-      const form = $(event.target).parents('form:first');
+      const form = $(event.target).parents('form').first();
       const params = {};
       params.mode = $(form.find('.fieldset-embed input[name=pages]:checked')).val();
       if (form.find('.fieldset-embed input[name=thispage]').prop('checked')) {
-        params.page = br.getPageNum(br.currentIndex());
+        params.page = br.book.getPageNum(br.currentIndex());
       }
 
       if (br.getEmbedCode) {
@@ -232,20 +210,20 @@ export class Toolbar {
     // Bind share buttons
 
     // Use url without hashes
-    $form.find('.facebook-share-button').click(() => {
+    $form.find('.facebook-share-button').on("click", () => {
       const params = $.param({ u: this._getSocialShareUrl() });
       const url = 'https://www.facebook.com/sharer.php?' + params;
       createPopup(url, 600, 400, 'Share');
     });
-    $form.find('.twitter-share-button').click(() => {
+    $form.find('.twitter-share-button').on("click", () => {
       const params = $.param({
         url: this._getSocialShareUrl(),
-        text: br.bookTitle
+        text: br.bookTitle,
       });
       const url = 'https://twitter.com/intent/tweet?' + params;
       createPopup(url, 600, 400, 'Share');
     });
-    $form.find('.email-share-button').click(() => {
+    $form.find('.email-share-button').on("click", () => {
       const body = `${br.bookTitle}\n\n${this._getSocialShareUrl()}`;
       window.location.href = `mailto:?subject=${encodeURI(br.bookTitle)}&body=${encodeURI(body)}`;
     });
@@ -331,11 +309,11 @@ export class Toolbar {
   }
 }
 
-export function blankInfoDiv() {
+function blankInfoDiv() {
   return $(`
     <div class="BRfloat BRinfo">
       <div class="BRfloatHead">About this book
-        <button class="floatShut" href="javascript:;" onclick="$.fn.colorbox.close();"><span class="shift">Close</span></button>
+        <button class="floatShut" href="javascript:;" onclick="$.fn.colorbox.close();"><span class="br-colorbox-shift">Close</span></button>
       </div>
       <div class="BRfloatBody">
         <div class="BRfloatCover"></div>
@@ -351,12 +329,12 @@ export function blankInfoDiv() {
     </div>`);
 }
 
-export function blankShareDiv() {
+function blankShareDiv() {
   return $(`
     <div class="BRfloat BRshare">
       <div class="BRfloatHead">
         Share
-        <button class="floatShut" href="javascript:;" onclick="$.fn.colorbox.close();"><span class="shift">Close</span></button>
+        <button class="floatShut" href="javascript:;" onclick="$.fn.colorbox.close();"><span class="br-colorbox-shift">Close</span></button>
       </div>
     </div>`);
 }

package/src/BookReader/events.js

@@ -3,11 +3,12 @@ export const EVENTS = {
   /** Indicates that the fragment (a serialization of the reader
    * state) has changed. */
   fragmentChange: 'fragmentChange',
+  pageChanged: 'pageChanged',
+  beforePageChanged: 'beforePageChanged',
   PostInit: 'PostInit',
   stop: 'stop',
   resize: 'resize',
-  // nav events:
-  navToggled: 'navToggled',
+  userAction: 'userAction', // event to know if user is actively reading
   // menu click events
   fullscreenToggled: 'fullscreenToggled',
   zoomOut: 'zoomOut',
@@ -16,5 +17,4 @@ export const EVENTS = {
   '2PageViewSelected': '2PageViewSelected',
   /* currently 3 represents thumbnail view */
   '3PageViewSelected': '3PageViewSelected',
-  mobileNavOpen: 'mobileNavOpen',
 };

package/src/BookReader/options.js

@@ -1,5 +1,8 @@
+// @ts-check
 /** @typedef {import('./BookModel.js').PageNumString} PageNumString */
 /** @typedef {import('./BookModel.js').LeafNum} LeafNum */
+/** @typedef {import('./BookModel.js').PageModel} PageModel */
+/** @typedef {import('./BookModel.js').PageIndex} PageIndex */
 
 export const DEFAULT_OPTIONS = {
   /**
@@ -25,9 +28,13 @@ export const DEFAULT_OPTIONS = {
   thumbMaxLoading: 4,
   /** spacing between thumbnails */
   thumbPadding: 10,
+  /** min zoom in columns */
+  thumbMinZoomColumns: 2,
+  /** max zoom out columns */
+  thumbMaxZoomColumns: 8,
 
   /** @type {number | 'fast' | 'slow'} speed for flip animation */
-  flipSpeed: 'fast',
+  flipSpeed: 400,
 
   showToolbar: true,
   showNavbar: true,
@@ -61,7 +68,7 @@ export const DEFAULT_OPTIONS = {
     {reduce: 2, autofit: null},
     {reduce: 3, autofit: null},
     {reduce: 4, autofit: null},
-    {reduce: 6, autofit: null}
+    {reduce: 6, autofit: null},
   ],
 
   /** Object to hold parameters related to 1up mode */
@@ -79,7 +86,7 @@ export const DEFAULT_OPTIONS = {
     /** Width of book spine  $$$ consider sizing based on book length */
     bookSpineDivWidth: 64,
     /** @type {AutoFitValues} */
-    autofit: 'auto'
+    autofit: 'auto',
   },
 
   onePageMinBreakpoint: 800,
@@ -92,6 +99,11 @@ export const DEFAULT_OPTIONS = {
   /** @type {string} */
   bookUrlTitle: null,
   enableBookTitleLink: true,
+  /**
+   * @type {string} A globally unique URI for the book. This is used to
+   * save data like annotations the user makes to the book.
+   */
+  bookUri: null,
   /**
    * @type {string} language in ISO 639-1 (PRIVATE: Will also
    * handle language name in English, native name, 639-2/T, or 639-2/B . (archive.org books
@@ -118,7 +130,7 @@ export const DEFAULT_OPTIONS = {
   enableExperimentalControls: false,
 
   /** CSS selectors */
-  /** Where BookReader mounts to */
+  /** @type {string | HTMLElement} Where BookReader mounts to; a CSS selector or an element */
   el: '#BookReader',
 
   /** @type {'lr' | 'rl'} Page progression */
@@ -136,8 +148,26 @@ export const DEFAULT_OPTIONS = {
    * but going forward we'll keep them here.
    **/
   plugins: {
-    /** @type {import('../plugins/plugin.text_selection.js').TextSelectionPluginOptions} */
-    textSelection: null,
+    /** @type {Partial<import('../plugins/plugin.archive_analytics.js').ArchiveAnalyticsPlugin['options'>]}*/
+    archiveAnalytics: {},
+    /** @type {Partial<import('../plugins/plugin.autoplay.js').AutoplayPlugin['options'>]}*/
+    autoplay: {},
+    /** @type {Partial<import('../plugins/plugin.chapters.js').ChaptersPlugin['options']>} */
+    chapters: {},
+    /** @type {Partial<import('../plugins/plugin.experiments.js').ExperimentsPlugin['options']>} */
+    experiments: {},
+    /** @type {Partial<import('../plugins/plugin.iiif.js').IiifPlugin['options']>} */
+    iiif: {},
+    /** @type {Partial<import('../plugins/plugin.resume.js').ResumePlugin['options']>} */
+    resume: {},
+    /** @type {Partial<import('../plugins/search/plugin.search.js').SearchPlugin['options']>} */
+    search: {},
+    /** @type {Partial<import('../plugins/plugin.text_selection.js').TextSelectionPlugin['options']>} */
+    textSelection: {},
+    /** @type {Partial<import('../plugins/translate/plugin.translate.js').TranslatePlugin['options']>} */
+    translate: {},
+    /** @type {Partial<import('../plugins/tts/plugin.tts.js').TtsPlugin['options']>} */
+    tts: {},
   },
 
   /**
@@ -176,15 +206,39 @@ export const DEFAULT_OPTIONS = {
    */
   data: [],
 
-  /** Advanced methods for page rendering */
+  /** @type {import('../plugins/plugin.chapters.js').TocEntry[]} */
+  table_of_contents: null,
+
+  /**
+   * Advanced methods for page rendering.
+   * All option functions have their `this` object set to the BookReader instance.
+   **/
+
   /** @type {() => number} */
   getNumLeafs: null,
   /** @type {(index: number) => number} */
   getPageWidth: null,
   /** @type {(index: number) => number} */
   getPageHeight: null,
-  /** @type {(index: number, reduce: number, rotate: number) => *} */
+  /** @type {(index: number, reduce: number, rotate: number) => string} */
   getPageURI: null,
+  /** @type {(page: PageModel) => Promise<PageIndex[]> | PageIndex[]} */
+  requestPage(page) {
+    return [];
+  },
+  /** @type {(textFragment: import('../util/TextSelectionManager.js').BookReaderTextFragment) => Promise<boolean> | boolean} */
+  verifyTextFragment(textFragment) {
+    return true;
+  },
+
+  /**
+   * @type {(img: HTMLImageElement, uri: string) => Promise<void> | void}
+   * Render the page URI into the image element. Perform any necessary preloading,
+   * authentication, etc.
+   */
+  renderPageURI(img, uri) {
+    img.src = uri;
+  },
 
   /**
    * @type {(index: number) => 'L' | 'R'}
@@ -214,35 +268,41 @@ export const DEFAULT_OPTIONS = {
   getEmbedCode: null,
 
   controls: {
+    toggleSlider: {
+      visible: true,
+      label: 'Toggle page controls',
+      className: 'toggle_slider',
+      iconClassName: 'toggle-slider',
+    },
     bookLeft: {
       visible: true,
       label: 'Flip left',
       className: 'book_left',
-      iconClassName: 'left-arrow'
+      iconClassName: 'left-arrow',
     },
     bookRight: {
       visible: true,
       label: 'Flip right',
       className: 'book_right',
-      iconClassName: 'left-arrow hflip'
+      iconClassName: 'left-arrow hflip',
     },
     onePage: {
       visible: true,
       label: 'One-page view',
       className: 'onepg',
-      iconClassName: 'onepg'
+      iconClassName: 'onepg',
     },
     twoPage: {
       visible: true,
       label: 'Two-page view',
       className: 'twopg',
-      iconClassName: 'twopg'
+      iconClassName: 'twopg',
     },
     thumbnail: {
       visible: true,
       label: 'Thumbnail view',
       className: 'thumb',
-      iconClassName: 'thumb'
+      iconClassName: 'thumb',
     },
     viewmode: {
       visible: true,
@@ -253,19 +313,19 @@ export const DEFAULT_OPTIONS = {
       visible: true,
       label: 'Zoom out',
       className: 'zoom_out',
-      iconClassName: 'magnify'
+      iconClassName: 'magnify',
     },
     zoomIn: {
       visible: true,
       label: 'Zoom in',
       className: 'zoom_in',
-      iconClassName: 'magnify plus'
+      iconClassName: 'magnify plus',
     },
     fullScreen: {
       visible: true,
-      label: 'Toggle fullscreen',
+      label: 'Go fullscreen',
       className: 'full',
-      iconClassName: 'fullscreen'
+      iconClassName: 'fullscreen',
     },
   },
 
@@ -275,6 +335,12 @@ export const DEFAULT_OPTIONS = {
    */
   startFullscreen: false,
 
+  /**
+   * @type {Boolean}
+   * will show logo at fullscreen mode
+  */
+  enableFSLogoShortcut: false,
+
   /**
    * @type {Boolean}
    * On init, by default, we want to handle resizing bookreader
@@ -288,9 +354,24 @@ export const DEFAULT_OPTIONS = {
    * On init, by default, we want to use srcSet for images
    */
   useSrcSet: false,
+
+  /**
+   * @type {string}
+   * Path to the image to display when a page is unviewable (i.e. when
+   * displaying a preview of a book).
+   *
+   * Relative to the imagesBaseURL if a relative path is specified.
+   */
+  unviewablePageURI: './unviewable_page.png',
 };
 
-/** @typedef {'width' | 'height' | 'auto' | 'none'} AutoFitValues */
+/**
+ * @typedef {'width' | 'height' | 'auto' | 'none'} AutoFitValues
+ * - width: fill the width of the container
+ * - height: fill the height of the container
+ * - auto: fill the width or height of the container, whichever is smaller
+ * - none: do not autofit
+ **/
 
 /**
  * @typedef {object} ReductionFactor
@@ -318,3 +399,9 @@ export const DEFAULT_OPTIONS = {
 
 /** @typedef {typeof DEFAULT_OPTIONS} BookReaderOptions */
 
+/**
+ * Thrown when an error occurs while parsing options.
+ * Potentially recoverable and non-halting.
+ */
+export class OptionsParseError extends Error {
+}

package/src/BookReader/utils/HTMLDimensionsCacher.js

@@ -0,0 +1,44 @@
+// @ts-check
+import { debounce } from '../utils.js';
+
+/**
+ * Computing these things repeatedly is expensive (the browser needs to
+ * do a lot of computations/redrawing to make sure these are correct),
+ * so we store them here, and only recompute them when necessary:
+ * - window resize could have cause the container to change size
+ * - zoom could have cause scrollbars to appear/disappear, changing
+ *   the client size.
+ */
+export class HTMLDimensionsCacher {
+  clientWidth = 100;
+  clientHeight = 100;
+
+  boundingClientRect = { top: 0, left: 0 };
+
+  /**
+   * @param {HTMLElement} element
+   */
+  constructor(element) {
+    /** @type {HTMLElement} */
+    this.element = element;
+  }
+
+  updateClientSizes = () => {
+    const bc = this.element.getBoundingClientRect();
+    this.clientWidth = this.element.clientWidth;
+    this.clientHeight = this.element.clientHeight;
+    this.boundingClientRect.top = bc.top;
+    this.boundingClientRect.left = bc.left;
+  }
+  debouncedUpdateClientSizes = debounce(this.updateClientSizes, 150, false);
+
+  /** @param {EventTarget} win */
+  attachResizeListener(win = window) {
+    win.addEventListener('resize', this.debouncedUpdateClientSizes);
+  }
+
+  /** @param {EventTarget} win */
+  detachResizeListener(win = window) {
+    win.removeEventListener('resize', this.debouncedUpdateClientSizes);
+  }
+}

package/src/BookReader/utils/ScrollClassAdder.js

@@ -0,0 +1,31 @@
+/** Adds a class while the given element is experiencing scrolling */
+export class ScrollClassAdder {
+  /**
+   * @param {HTMLElement} element
+   * @param {string} className
+   */
+  constructor(element, className) {
+    /** @type {HTMLElement} */
+    this.element = element;
+    /** @type {string} */
+    this.className = className;
+    this.timeout = null;
+  }
+
+  attach() {
+    this.element.addEventListener('scroll', this.onScroll);
+  }
+
+  detach() {
+    this.element.removeEventListener('scroll', this.onScroll);
+  }
+
+  onScroll = () => {
+    this.element.classList.add(this.className);
+    clearTimeout(this.timeout);
+    // TODO: Also remove class on mousemove, touch, click, etc.
+    this.timeout = setTimeout(() => {
+      this.element.classList.remove(this.className);
+    }, 600);
+  }
+}

package/src/BookReader/utils/SelectionObserver.js

@@ -0,0 +1,72 @@
+// @ts-check
+/**
+ * Like `Selection.isCollapsed`, but checks the ranges too. WebKit reports
+ * `isCollapsed` as true for any selection inside a shadow root, even when
+ * it has text.
+ * https://bugs.webkit.org/show_bug.cgi?id=281587
+ * @param {Selection} selection
+ * @returns {boolean}
+ */
+export function isSelectionCollapsed(selection) {
+  if (!selection.isCollapsed) return false;
+  for (let i = 0; i < selection.rangeCount; i++) {
+    if (!selection.getRangeAt(i).collapsed) return false;
+  }
+  return true;
+}
+
+export class SelectionObserver {
+  selecting = false;
+  startedInSelector = false;
+  /** @type {HTMLElement} */
+  target = null;
+  /** @type {Node | null} */
+  lastKnownFocusNode = null;
+
+  /**
+   * @param {string} selector
+   * @param {function('started' | 'cleared' | 'changed', HTMLElement): any} handler
+   */
+  constructor(selector, handler) {
+    this.selector = selector;
+    this.handler = handler;
+  }
+
+  attach() {
+    // We can't just use selectstart, because safari on iOS just
+    // randomly decides when to fire it 😤
+    // document.addEventListener("selectstart", this._onSelectStart);
+    // This has to be on document :/
+    document.addEventListener("selectionchange", this._onSelectionChange);
+  }
+
+  detach() {
+    document.removeEventListener("selectionchange", this._onSelectionChange);
+  }
+
+  _onSelectionChange = () => {
+    const sel = window.getSelection();
+    if (!sel) return;
+    const isCollapsed = isSelectionCollapsed(sel);
+
+    if (!this.selecting && sel.toString()) {
+      const target = $(sel.anchorNode).closest(this.selector)[0];
+      if (!target) return;
+      this.target = target;
+      this.selecting = true;
+      this.lastKnownFocusNode = sel.focusNode;
+      this.handler('started', this.target);
+    }
+
+    if (this.selecting && this.lastKnownFocusNode != sel.focusNode && sel.toString() && !isCollapsed) {
+      this.lastKnownFocusNode = sel.focusNode;
+      this.handler('changed', this.target);
+    }
+
+    if (this.selecting && (isCollapsed || !sel.toString() || !$(sel.anchorNode).closest(this.selector)[0])) {
+      this.selecting = false;
+      this.lastKnownFocusNode = null;
+      this.handler('cleared', this.target);
+    }
+  };
+}

package/src/BookReader/utils/classes.js

@@ -31,6 +31,6 @@ export function exposeOverrideable(FromClass, fromMethod, fromTransform, ToClass
         return overrideFn.apply(newThis, arguments);
       };
       wrapper = overrideFn;
-    }
+    },
   });
 }