@internetarchive/bookreader 5.0.0-93 → 5.0.0-95

package/src/BookReader/utils.js

@@ -1,300 +0,0 @@
-/**
- * Bind mouse handlers
- * Disable mouse click to avoid selected/highlighted page images
- * @param {JQuery} jObject
- */
-export function disableSelect(jObject) {
-  // $$$ check here for right-click and don't disable.  Also use jQuery style
-  //     for stopping propagation. See https://bugs.edge.launchpad.net/gnubook/+bug/362626
-  jObject.bind('mousedown', () => false);
-  // Special hack for IE7
-  jObject[0].onselectstart = () => false;
-}
-
-/**
- * @param {number} value
- * @param {number} min
- * @param {number} max
- * @return {number}
- */
-export function clamp(value, min, max) {
-  return Math.min(Math.max(value, min), max);
-}
-
-/**
- * Given value and maximum, calculate a percentage suitable for CSS
- * @param {number} value
- * @param {number} max
- * @return {string}
- */
-export function cssPercentage(value, max) {
-  return ((value / max) * 100) + '%';
-}
-
-/**
- * @param {*} value
- * @param {Array} array
- * @return {boolean}
- */
-export function notInArray(value, array) {
-  return !array.includes(value);
-}
-
-/**
- * Determines the active element, going into shadow doms.
- * @return {Element}
- */
-export function getActiveElement(doc = document, recurseShadowDom = true) {
-  const activeElement = doc.activeElement;
-  if (recurseShadowDom && activeElement?.shadowRoot) {
-    return getActiveElement(activeElement.shadowRoot, true);
-  }
-  return activeElement;
-}
-
-/** Check if an input field/textarea is active. Also checks shadow DOMs. */
-export function isInputActive(doc = document) {
-  const activeEl = getActiveElement(doc);
-  return activeEl?.tagName == "INPUT" || activeEl?.tagName == "TEXTAREA";
-}
-
-/**
- * @param {HTMLIFrameElement} iframe
- * @return {Document}
- */
-export function getIFrameDocument(iframe) {
-// Adapted from http://xkr.us/articles/dom/iframe-document/
-  const outer = iframe.contentWindow || iframe.contentDocument;
-  return outer.document || outer;
-}
-
-/**
- * @param {string} str
- * @return {string}
- */
-export function escapeHTML(str) {
-  return str.replace(/&/g,'&')
-    .replace(/>/g,'>')
-    .replace(/</g,'&lt;')
-    .replace(/"/g,'&quot;');
-}
-
-/**
- * Decodes a URI component and converts '+' to ' '
- * @param {string} value
- * @return {string}
- */
-export function decodeURIComponentPlus(value) {
-  return decodeURIComponent(value).replace(/\+/g, ' ');
-}
-
-/**
- * Encodes a URI component and converts ' ' to '+'
- * @param {string|number|boolean} value
- * @return {string};
- */
-export function encodeURIComponentPlus(value) {
-  return encodeURIComponent(value).replace(/%20/g, '+');
-}
-
-/**
- * @template {Function} T
- * Returns a function, that, as long as it continues to be invoked, will not
- * be triggered. The function will be called after it stops being called for
- * N milliseconds. If `immediate` is passed, trigger the function on the
- * leading edge, instead of the trailing.
- * @see https://davidwalsh.name/javascript-debounce-function
- *
- * @param {T} func
- * @param {number} wait
- * @param {boolean} immediate
- * @return {T}
- */
-export function debounce(func, wait, immediate) {
-  let timeout;
-  return function() {
-    const context = this;
-    const args = arguments;
-    const later = () => {
-      timeout = null;
-      if (!immediate) func.apply(context, args);
-    };
-    const callNow = immediate && !timeout;
-    clearTimeout(timeout);
-    timeout = setTimeout(later, wait);
-    if (callNow) func.apply(context, args);
-  };
-}
-
-/**
- * @template T
- * Throttle function
- * @see https://remysharp.com/2010/07/21/throttling-function-calls
- * @param {T} fn
- * @param {number} threshold
- * @param {boolean} delay
- * @return {T}
- */
-export function throttle(fn, threshold, delay) {
-  threshold || (threshold = 250);
-  let last;
-  let deferTimer;
-  if (delay) last = +new Date;
-  return function () {
-    const context = this;
-    const now = +new Date;
-    const args = arguments;
-    if (last && now < last + threshold) {
-      // hold on to it
-      clearTimeout(deferTimer);
-      deferTimer = setTimeout(() => {
-        last = now;
-        fn.apply(context, args);
-      }, threshold);
-    } else {
-      last = now;
-      fn.apply(context, args);
-    }
-  };
-}
-
-/**
- * FIXME we need a better way to do this :/ This is not automatically poly-filled by
- * core-js https://github.com/zloirock/core-js/issues/354
- * @param {Window} window
- */
-export function polyfillCustomEvent(window) {
-  if (typeof window.CustomEvent === "function") return false;
-  window.CustomEvent = PolyfilledCustomEvent;
-}
-
-/**
- * https://caniuse.com/customevent has issues on older browsers where it can't be
- * called as a constructor, so we have to use older methods.
- * @param {String} eventName
- * @return {CustomEvent}
- */
-export function PolyfilledCustomEvent(eventName, {bubbles = false, cancelable = false, detail = null} = {}) {
-  const event = document.createEvent('CustomEvent');
-  event.initCustomEvent(eventName, bubbles, cancelable, detail);
-  return event;
-}
-
-/*
- * Returns the number pixels something should be rendered at to be ~1n on the users
- * screen when measured with a ruler.
- */
-export function calcScreenDPI() {
-  const el = document.createElement('div');
-  el.style.width = '1in';
-  document.body.appendChild(el);
-  const dpi = el.offsetWidth;
-  document.body.removeChild(el);
-
-  // Do you believe in magic... numbers? We tested on some devices, and the displayed
-  // size of `width: 1in` was less than desired. On @pezvi's mac, it was ~75% ; on
-  // @cdrini's laptop it was ~85%. Since we want to avoid things appearing too small,
-  // let's just use a multiplier of 1.25
-  const screenDPI = dpi * 1.25;
-  // This will return 0 in testing; never want it to be 0!
-  return screenDPI == 0 ? 100 : screenDPI;
-}
-
-/**
- * @param {number[]} nums
- * @returns {number}
- */
-export function sum(nums) {
-  return nums.reduce((cur, acc) => cur + acc, 0);
-}
-
-/**
- * @template T
- * @param {Generator<T>} gen
- * @returns {T[]}
- */
-export function genToArray(gen) {
-  const result = [];
-  for (const item of gen) {
-    result.push(item);
-  }
-  return result;
-}
-
-/**
- * Check if arrays contain the same elements. Does reference comparison.
- * @param {Array} arr1
- * @param {Array} arr2
- */
-export function arrEquals(arr1, arr2) {
-  return arr1.length == arr2.length && arr1.every((x, i) => x == arr2[i]);
-}
-
-/**
- * Check if array has changed; namely to be used with lit's property.hasChanged
- * @param {Array} [arr1]
- * @param {Array} [arr2]
- */
-export function arrChanged(arr1, arr2) {
-  return arr1 && arr2 && !arrEquals(arr1, arr2);
-}
-
-/**
- * Waits the provided number of ms and then resolves with a promise
- * @param {number} ms
- **/
-export async function sleep(ms) {
-  return new Promise(resolve => setTimeout(resolve, ms));
-}
-
-/**
- * @template T
- * @param {function(): T} fn
- * @param {Object} options
- * @param {function(T): boolean} [options.until]
- * @return {T | undefined}
- */
-export async function poll(fn, { step = 50, timeout = 500, until = val => Boolean(val), _sleep = sleep } = {}) {
-  const startTime = Date.now();
-  while (Date.now() - startTime < timeout) {
-    const result = fn();
-    if (until(result)) return result;
-    await _sleep(step);
-  }
-}
-
-/**
- * Convert a EventTarget style event into a promise
- * @param {EventTarget} target
- * @param {string} eventType
- * @return {Promise<Event>}
- */
-export function promisifyEvent(target, eventType) {
-  return new Promise(res => {
-    const resolver = ev => {
-      target.removeEventListener(eventType, resolver);
-      res(ev);
-    };
-    target.addEventListener(eventType, resolver);
-  });
-}
-
-/**
- * Escapes regex special characters in a string. Allows for safe usage in regexes.
- * Src: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions
- * @param {string} string
- * @returns {string}
- */
-export function escapeRegExp(string) {
-  return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
-}
-
-/**
- * @param {number | 'fast' | 'slow' | string} speed
- * Parsing of the jquery animation speed; see https://api.jquery.com/animate/
- */
-export function parseAnimationSpeed(speed) {
-  if (speed === 'slow') return 600;
-  if (speed === 'fast') return 200;
-  return parseInt(speed, 10);
-}

package/tests/jest/BookReader/BookModel.test.js

@@ -1,372 +0,0 @@
-import sinon from 'sinon';
-import { deepCopy } from '../utils.js';
-import { BookModel } from '@/src/BookReader/BookModel.js';
-import { NAMED_REDUCE_SETS } from '@/src/BookReader/ReduceSet.js';
-/** @typedef {import('@/src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
-
-afterEach(() => {
-  sinon.restore();
-});
-
-/** @type {BookReaderOptions['data']} */
-const SAMPLE_DATA = [
-  [
-    { width: 123, height: 123, uri: 'https://archive.org/image0.jpg', pageNum: '1' },
-  ],
-  [
-    { width: 123, height: 123, uri: 'https://archive.org/image1.jpg', pageNum: '2' },
-    { width: 123, height: 123, uri: 'https://archive.org/image2.jpg', pageNum: '3' },
-  ],
-  [
-    { width: 123, height: 123, uri: 'https://archive.org/image3.jpg', pageNum: '4' },
-  ],
-];
-
-describe('getMedianPageSizeInches', () => {
-  test('handles single page data', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA.slice(0, 1), options: {ppi: 10} });
-    expect(bm.getMedianPageSizeInches()).toEqual({ width: 12.3, height: 12.3 });
-  });
-
-  test('handles odd pages data', () => {
-    const sizes = [
-      {width: 300, height: 2200},
-      {width: 200, height: 2100},
-      {width: 100, height: 2300},
-    ];
-    const data = deepCopy(SAMPLE_DATA);
-    delete data[2];
-    Object.assign(data[0][0], sizes[0]);
-    Object.assign(data[1][0], sizes[1]);
-    Object.assign(data[1][1], sizes[2]);
-    const bm = new BookModel({ data, options: {ppi: 10} });
-    expect(bm.getMedianPageSizeInches()).toEqual({ width: 20, height: 220 });
-  });
-
-
-  test('handles even pages data', () => {
-    const sizes = [
-      {width: 300, height: 2200},
-      {width: 200, height: 2100},
-      {width: 100, height: 2300},
-      {width: 400, height: 2400},
-    ];
-    const data = deepCopy(SAMPLE_DATA);
-    Object.assign(data[0][0], sizes[0]);
-    Object.assign(data[1][0], sizes[1]);
-    Object.assign(data[1][1], sizes[2]);
-    Object.assign(data[2][0], sizes[3]);
-    const bm = new BookModel({ data, options: {ppi: 10} });
-    expect(bm.getMedianPageSizeInches()).toEqual({ width: 30, height: 230 });
-  });
-
-  test('does not lexicographic sort for median', () => {
-    const sizes = [
-      {width: 100, height: 100},
-      {width: 20, height: 20},
-      {width: 30, height: 30},
-    ];
-    const data = deepCopy(SAMPLE_DATA);
-    delete data[2];
-    Object.assign(data[0][0], sizes[0]);
-    Object.assign(data[1][0], sizes[1]);
-    Object.assign(data[1][1], sizes[2]);
-    const bm = new BookModel({ data, options: {ppi: 10} });
-    expect(bm.getMedianPageSizeInches()).toEqual({ width: 3, height: 3 });
-  });
-
-  test('caches result', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    const firstResult = bm.getMedianPageSizeInches();
-    expect(bm.getMedianPageSizeInches()).toBe(firstResult);
-    expect(bm.getMedianPageSizeInches()).toBe(firstResult);
-    expect(bm.getMedianPageSizeInches()).toBe(firstResult);
-  });
-});
-
-describe('getPageIndices', () => {
-  test('handles unique indices', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getPageIndices('1')).toEqual([0]);
-  });
-
-  test('handles invalid indices', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getPageIndices('foo')).toEqual([]);
-    expect(bm.getPageIndices('123')).toEqual([]);
-  });
-
-  test('handles non-unique indices', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    data[0][0].pageNum = '2';
-    const bm = new BookModel({ data });
-    expect(bm.getPageIndices('2')).toEqual([0, 1]);
-  });
-
-  test('handles n-prefixed pages', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    data[0][0].pageNum = 'n0';
-    const bm = new BookModel({ data });
-    expect(bm.getPageIndices('n0')).toEqual([0]);
-  });
-});
-
-test('getPageName', () => {
-  const bm = new BookModel({ data: SAMPLE_DATA });
-  expect(bm.getPageName(0)).toEqual('Page 1');
-  expect(bm.getPageName(1)).toEqual('Page 2');
-});
-
-describe('numLeafs', () => {
-  test('reads from data', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getNumLeafs()).toBe(4);
-  });
-
-  test('numLeafs can be overriden', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA, numLeafs: 12 });
-    expect(bm.getNumLeafs()).toBe(12);
-  });
-});
-
-test('getPageNum', () => {
-  const bm = new BookModel({ data: SAMPLE_DATA });
-  expect(bm.getPageNum(0)).toBe('1');
-});
-
-test('getPageProp gets values from correct document', () => {
-  const bm = new BookModel({ data: SAMPLE_DATA });
-  expect(bm.getPageProp(1, 'uri')).toBe(SAMPLE_DATA[1][0].uri);
-});
-
-describe('getSpreadIndices', () => {
-  test('Works for left to right text', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA, pageProgression: 'lr' });
-    expect(bm.getSpreadIndices(1)).toEqual([1, 2]);
-    expect(bm.getSpreadIndices(2)).toEqual([1, 2]);
-  });
-});
-
-describe('leafNumToIndex', () => {
-  test('returns input if no leafNum in data', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.leafNumToIndex(1)).toBe(1);
-    expect(bm.leafNumToIndex(2)).toBe(2);
-    expect(bm.leafNumToIndex(3)).toBe(3);
-  });
-
-  test('returns true index when leafNum does not point to index', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    for (const spread of data) {
-      for (const page of spread) {
-        page.leafNum = parseFloat(page.pageNum) + 2;
-      }
-    }
-
-    const bm = new BookModel({ data });
-    expect(bm.leafNumToIndex(3)).toBe(0);
-  });
-});
-
-describe('parsePageString', () => {
-  test('handles leaf-prefixed PageString', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    for (const spread of data) {
-      for (const page of spread) {
-        page.leafNum = parseFloat(page.pageNum) + 2;
-      }
-    }
-
-    const bm = new BookModel({ data });
-    expect(bm.parsePageString('leaf3')).toBe(0);
-  });
-});
-
-describe('pagesIterator', () => {
-  test('Goes through all pages', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    let i = 0;
-    for (const page of bm.pagesIterator()) {
-      expect(page.index).toBe(i++);
-    }
-  });
-
-  test('Can combine unviewables', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    // add some more pages
-    data.splice(2, 0, deepCopy(data[0]));
-    data[1].forEach(page => page.viewable = false);
-    const bm = new BookModel({ data });
-    for (const page of bm.pagesIterator({combineConsecutiveUnviewables: true})) {
-      expect(page.isConsecutiveUnviewable).toBe(false);
-    }
-  });
-});
-
-describe('_getDataFlattened', () => {
-  test('Assigns correct page sides', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm._getDataFlattened().map(page => page.pageSide)).toEqual(['R', 'L', 'R', 'L']);
-  });
-
-  test('Memoized based on data length', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    const bm = new BookModel({ data });
-    const firstResult = bm._getDataFlattened();
-    expect(bm._getDataFlattened()).toBe(firstResult);
-    expect(bm._getDataFlattened()).toBe(firstResult);
-    bm.br.data = data.slice(0, 1);
-    expect(bm._getDataFlattened()).not.toBe(firstResult);
-  });
-
-  test('Assigns unviewablesStart', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    data.slice(1, -1)
-      .forEach(spread => spread.forEach(page => {
-        page.viewable = false;
-      }));
-    const bm = new BookModel({ data });
-    const pages = bm._getDataFlattened();
-    expect(pages[0].unviewablesStart).toBeUndefined();
-    expect(pages[1].unviewablesStart).toBe(1);
-    expect(pages[2].unviewablesStart).toBe(1);
-    expect(pages[3].unviewablesStart).toBeUndefined();
-  });
-});
-
-describe('getPage', () => {
-  test('loops around by default', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getPage(-1).index).toBe(3);
-    expect(bm.getPage(-2).index).toBe(2);
-    expect(bm.getPage(-3).index).toBe(1);
-    expect(bm.getPage(4).index).toBe(0);
-    expect(bm.getPage(5).index).toBe(1);
-  });
-
-  test('does not loop if loop=false', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getPage(-1, false)).toBeUndefined();
-    expect(bm.getPage(-2, false)).toBeUndefined();
-    expect(bm.getPage(4, false)).toBeUndefined();
-    expect(bm.getPage(5, false)).toBeUndefined();
-  });
-});
-
-describe('PageModel', () => {
-  test('constructor copies fields from book model', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    const spy = sinon.spy(bm, 'getPageWidth');
-    const page = bm.getPage(0);
-    expect(spy.callCount).toBe(1);
-    expect(page.width).toBe(SAMPLE_DATA[0][0].width);
-  });
-
-  test('prev at start of book returns null', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getPage(0).prev).toBeUndefined();
-  });
-
-  test('prev to return previous', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getPage(1).prev.index).toBe(0);
-    expect(bm.getPage(3).prev.prev.index).toBe(1);
-  });
-
-  test('next at end of book returns null', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getPage(-1).next).toBeUndefined();
-  });
-
-  test('next to return next page', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm.getPage(0).next.index).toBe(1);
-    expect(bm.getPage(1).next.next.index).toBe(3);
-  });
-
-  describe('findNext combineConsecutiveUnviewables=true', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    // add some more pages
-    data.splice(2, 0, deepCopy(data[0]));
-    data[1].forEach(page => page.viewable = false);
-
-    const bm = new BookModel({ data });
-
-    test('does not skip the first unviewable page', () => {
-      expect(bm.getPage(0).findNext({ combineConsecutiveUnviewables: true }).index).toBe(1);
-    });
-
-    test('skips consecutive unviewables', () => {
-      expect(bm.getPage(1).findNext({ combineConsecutiveUnviewables: true }).index).toBe(3);
-    });
-
-    test('at end is undefined', () => {
-      expect(bm.getPage(-1).findNext({ combineConsecutiveUnviewables: true })).toBeUndefined();
-    });
-  });
-
-  describe('findPrev', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    // add some more pages
-    data.splice(2, 0, deepCopy(data[0]));
-    data[1].forEach(page => page.viewable = false);
-
-    const bm = new BookModel({ data });
-
-    test('works if called on first unviewable', () => {
-      expect(bm.getPage(1).findPrev({ combineConsecutiveUnviewables: true }).index).toBe(0);
-    });
-
-    test('works if called within unviewable chunk', () => {
-      expect(bm.getPage(2).findPrev({ combineConsecutiveUnviewables: true }).index).toBe(1);
-    });
-
-    test('at start is undefined', () => {
-      expect(bm.getPage(0).findPrev({ combineConsecutiveUnviewables: true })).toBeUndefined();
-    });
-  });
-
-  describe('findLeft/findRight', () => {
-    const data = deepCopy(SAMPLE_DATA);
-
-    test('Calls findNext/findPrev based on progression', () => {
-      const bm = new BookModel({ data });
-      const page = bm.getPage(0);
-      const findNextStub = sinon.stub(page, 'findNext');
-      const findPrevStub = sinon.stub(page, 'findPrev');
-      bm.pageProgression = 'lr';
-      page.findLeft();
-      expect(findPrevStub.callCount).toBe(1);
-      expect(findNextStub.callCount).toBe(0);
-      page.findRight();
-      expect(findPrevStub.callCount).toBe(1);
-      expect(findNextStub.callCount).toBe(1);
-      bm.pageProgression = 'rl';
-      page.findLeft();
-      expect(findPrevStub.callCount).toBe(1);
-      expect(findNextStub.callCount).toBe(2);
-      page.findRight();
-      expect(findPrevStub.callCount).toBe(2);
-      expect(findNextStub.callCount).toBe(2);
-    });
-  });
-
-  describe('getURISrcSet', () => {
-    const data = deepCopy(SAMPLE_DATA);
-    const bm = new BookModel({ data, reduceSet: NAMED_REDUCE_SETS.pow2 });
-    bm.getPageURI = (index, scale, rotate) => `correctURL.png?scale=${scale}`;
-    const page = bm.getPage(0);
-
-    test('with 0 elements in srcset', () => {
-      expect(page.getURISrcSet(1)).toBe("");
-    });
-
-    test('with 2 elements in srcset', () => {
-      expect(page.getURISrcSet(5)).toBe("correctURL.png?scale=2 2x, correctURL.png?scale=1 4x");
-    });
-
-    test('with the most elements in srcset', () => {
-      expect(page.getURISrcSet(35)).toBe("correctURL.png?scale=16 2x, correctURL.png?scale=8 4x, correctURL.png?scale=4 8x, correctURL.png?scale=2 16x, correctURL.png?scale=1 32x");
-    });
-  });
-});