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

package/src/plugins/plugin.mobile_nav.js

@@ -1,287 +0,0 @@
-/* global BookReader */
-/**
- * Adds mobile navigation at responsive breakpoint
- */
-
-import * as utils from '../BookReader/utils.js';
-import 'jquery.mmenu/dist/js/jquery.mmenu.min.js';
-import 'jquery.mmenu/dist/addons/navbars/jquery.mmenu.navbars.min.js';
-
-//contains all filters and labels for checkboxs
-const FILTERLIST = [
-  {
-    filter: "grayscale(100%)",
-    label: "Grayscale"
-  },
-  {
-    filter: "brightness(120%)",
-    label: "High brightness"
-  },
-  {
-    filter: "invert(100%)",
-    label: "Inverted (dark mode)"
-  },
-  {
-    filter: "contrast(120%)",
-    label: "High contrast"
-  },
-];
-
-jQuery.extend(BookReader.defaultOptions, {
-  enableMobileNav: true,
-  mobileNavTitle: 'Internet Archive',
-  mobileNavFullscreenOnly: false,
-});
-
-BookReader.prototype.setup = (function(super_) {
-  return function (options) {
-    super_.call(this, options);
-
-    this.enableMobileNav = options.enableMobileNav;
-    this.mobileNavTitle = options.mobileNavTitle;
-    this.mobileNavFullscreenOnly = options.mobileNavFullscreenOnly;
-
-    this.refs.$mmenu = null;
-  };
-})(BookReader.prototype.setup);
-
-
-// Extend initToolbar
-BookReader.prototype.initToolbar = (function (super_) {
-  return function (mode, ui) {
-    let $mmenuEl;
-    if (this.enableMobileNav) {
-      const $drawerEl = this.buildMobileDrawerElement();
-      this.refs.$br.append($drawerEl);
-
-      // Render info into mobile info before mmenu
-      this.buildInfoDiv(this.$('.BRmobileInfo'));
-      this.buildShareDiv(this.$('.BRmobileShare'));
-
-      $mmenuEl = $drawerEl;
-      $mmenuEl.mmenu({
-        navbars: [
-          { "position": "top" },
-        ],
-        navbar: {
-          add: true,
-          title: this.mobileNavTitle,
-          titleLink: 'panel'
-        },
-        extensions: [ "panelshadow" ],
-      }, {
-        offCanvas: {
-          wrapPageIfNeeded: false,
-          zposition: 'next',
-          pageSelector: this.el,
-        }
-      });
-
-      const $BRpageviewField = $mmenuEl.find('.BRpageviewValue');
-      $mmenuEl.data('mmenu').bind('opened', () => {
-        // Update "Link to this page view" link
-        if ($BRpageviewField.length) {
-          $BRpageviewField.val(window.location.href);
-        }
-      });
-
-      //apply filters when checkboxs clicked
-      $drawerEl.find('.BRcheckbox-filters').click(() => applyFilters($drawerEl, this));
-
-      // Bind mobile switch buttons
-      $drawerEl.find('.DrawerLayoutButton.one_page_mode').click(
-        () => this.switchMode(this.constMode1up));
-      $drawerEl.find('.DrawerLayoutButton.two_page_mode').click(
-        () => this.switchMode(this.constMode2up));
-      $drawerEl.find('.DrawerLayoutButton.thumbnail_mode').click(
-        () => this.switchMode(this.constModeThumb));
-
-      if (this.mobileNavFullscreenOnly) {
-        $(document.body).addClass('BRbodyMobileNavEnabledFullscreen');
-      } else {
-        $(document.body).addClass('BRbodyMobileNavEnabled');
-      }
-
-      this.refs.$mmenu = $mmenuEl;
-
-    }
-
-    // Call the parent method at the end, because it binds events to DOM
-    super_.apply(this, arguments);
-
-
-    if (this.enableMobileNav) {
-      // Need to bind more, console after toolbar is initialized
-      this.$('.BRmobileHamburger').click(() => {
-        if ($mmenuEl.data('mmenu').getInstance().vars.opened) {
-          $mmenuEl.data('mmenu').close();
-        } else {
-          $mmenuEl.data('mmenu').open();
-          this.trigger("mobileNavOpen");
-        }
-      });
-
-
-      const closeMobileMenu = (e) => {
-        // Need to close the mobile menu to reset DOM & Style
-        // driven by menu plugin
-        const width = $( window ).width();
-        const mobileMenuIsOpen = $mmenuEl.data('mmenu').getInstance().vars.opened;
-        // $brBreakPointMobile: 800px;
-        if (mobileMenuIsOpen && (width >= 800)) {
-          $mmenuEl.data('mmenu').close ();
-        }
-      };
-
-      window.addEventListener('resize', utils.debounce(closeMobileMenu, 900));
-    }
-  };
-})(BookReader.prototype.initToolbar);
-
-
-BookReader.prototype.buildToolbarElement = (function (super_) {
-  return function () {
-    const $el = super_.call(this);
-    if (this.enableMobileNav) {
-      const escapedTitle = BookReader.util.escapeHTML(this.bookTitle);
-      const toolbar = `
-        <span class="BRmobileHamburgerWrapper">
-          <button class="BRmobileHamburger"></button>
-          <span class="BRtoolbarMobileTitle" title="${escapedTitle}">${escapedTitle}</span>
-        </span>
-      `;
-      $el
-        .addClass('responsive')
-        .prepend($(toolbar));
-    }
-    return $el;
-  };
-})(BookReader.prototype.buildToolbarElement);
-
-/**
- * This method builds the html for the mobile drawer. It can be decorated to
- * extend the default drawer.
- * @return {jqueryElement}
- */
-BookReader.prototype.buildMobileDrawerElement = function() {
-  let experimentalHtml = '';
-  //builds filters checkbox html
-  if (this.enableExperimentalControls) {
-    experimentalHtml = `
-        <p class="DrawerSettingsTitle">Visual Adjustment</p>
-        <div class="BRcheckbox-group-filters">
-        `;
-    FILTERLIST.forEach( (el, i) => {
-      const checkboxHtml = `
-          <input type="checkbox" class="BRcheckbox-filters" id="filter${i}">
-          <label for="filter${i}" class="BRcheckbox-label-filters">${el.label}</label><br>
-        
-      `;
-      experimentalHtml = experimentalHtml.concat(checkboxHtml);
-    });
-    experimentalHtml = experimentalHtml.concat("</div>");
-  }
-
-
-  const settingsSection = `
-    <span>
-        <span class="DrawerIconWrapper">
-          <img class="DrawerIcon" src="${`${this.imagesBaseURL}icon_gear.svg`}" alt="settings-icon"/>
-        </span>
-        Settings
-    </span>
-    <div class=DrawerSettingsWrapper>
-        <div class="DrawerSettingsLayoutWrapper">
-          <button class="DrawerLayoutButton one_page_mode">
-            <img src="${this.imagesBaseURL}icon_one_page.svg" alt="Single Page"/>
-            <br>
-            One Page
-          </button>
-          <button class="DrawerLayoutButton two_page_mode TwoPagesButton">
-            <img src="${this.imagesBaseURL}icon_two_pages.svg" alt="Two Pages"/>
-            <br>
-            Two Pages
-          </button>
-          <button class="DrawerLayoutButton thumbnail_mode">
-            <img src="${this.imagesBaseURL}icon_thumbnails.svg" alt="Thumbnails"/>
-            <br>
-            Thumbnails
-          </button>
-        </div>
-        <br>
-        <div class="DrawerSettingsTitle">Zoom</div>
-        <button class='BRicon zoom_out'></button>
-        <button class='BRicon zoom_in'></button>
-        <br style="clear:both"><br><br>
-        ${experimentalHtml}
-    </div>
-  `;
-  const moreInfo = `
-    <span>
-        <span class="DrawerIconWrapper ">
-            <img class="DrawerIcon" src="${this.imagesBaseURL}icon_info.svg" alt="info-icon"/>
-        </span>
-        About This Book
-    </span>
-    <div class="BRmobileInfo"></div>
-  `;
-  const share = `
-    <span>
-      <span class="DrawerIconWrapper">
-        <img class="DrawerIcon" src="${this.imagesBaseURL}icon_share.svg" alt="info-share"/>
-      </span>
-      Share This Book
-    </span>
-    <div class="BRmobileShare"></div>
-  `;
-  const navMenu = `
-    <nav id="BRmobileMenu" class="BRmobileMenu">
-      <ul>
-        <li class="BRmobileMenu__settings">${settingsSection}</li>
-        <li class="BRmobileMenu__moreInfoRow">${moreInfo}</li>
-        <li class="BRmobileMenu__share">${share}</li>
-      </ul>
-    </nav>
-  `;
-
-  const $el = $(navMenu);
-  return $el;
-};
-
-/**
- * Mmenu moves itself out side of the root BookReader element, so we need to
- * include it in the scoped $ function.
- */
-BookReader.prototype.$ = (function (super_) {
-  return function (arg) {
-    let $results = super_.call(this, arg);
-    if (this.refs.$mmenu) {
-      $results = $results.add(this.refs.$mmenu.find(arg));
-    }
-    return $results;
-  };
-})(BookReader.prototype.$);
-
-/**
-* Dynamically creates styles combining different filters for BookReaders imgs
-* based on filters checkbox
-*/
-const applyFilters = (drawerEl, br) => {
-  let filterStr = "";
-
-  $('.BRcheckbox-filters').each(
-    (i, el) => {
-      br.refs.$br.removeClass("filter-applied");
-      if ($(el).is(':checked')) {
-        br.refs.$br.addClass($(el).attr("filter-applied"));
-        filterStr = filterStr + FILTERLIST[i].filter;
-      }
-    }
-  );
-  const filtersSheet = $("#filtersStyle")[0] || document.createElement('style');
-  filtersSheet.id = "filtersStyle";
-  filtersSheet.innerHTML = `.BRpagecontainer  img {
-            filter: ${filterStr};
-            -webkit-filter: ${filterStr};}`;
-  document.body.appendChild(filtersSheet);
-};

package/tests/BookReader/BookModel.test.js

@@ -1,312 +0,0 @@
-import sinon from 'sinon';
-import { deepCopy } from '../utils.js';
-import { BookModel } from '../../src/BookReader/BookModel.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('getMedianPageSize', () => {
-  test('handles single page data', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA.slice(0, 1) });
-    expect(bm.getMedianPageSize()).toEqual({ width: 123, height: 123 });
-  });
-
-  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 });
-    expect(bm.getMedianPageSize()).toEqual({ width: 200, height: 2200 });
-  });
-
-
-  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 });
-    expect(bm.getMedianPageSize()).toEqual({ width: 300, height: 2300 });
-  });
-
-  test('caches result', () => {
-    const bm = new BookModel({ data: SAMPLE_DATA });
-    const firstResult = bm.getMedianPageSize();
-    expect(bm.getMedianPageSize()).toBe(firstResult);
-    expect(bm.getMedianPageSize()).toBe(firstResult);
-    expect(bm.getMedianPageSize()).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();
-    });
-  });
-});