@internetarchive/bookreader 5.0.0-88-alpha.11 → 5.0.0-89

package/dist/esm/plugins/url/plugin.url.js

@@ -1,212 +0,0 @@
-/* global BookReader */
-
-import { UrlPlugin } from "./UrlPlugin";
-
-/**
- * Plugin for URL management in BookReader
- * Note read more about the url "fragment" here:
- * https://openlibrary.org/dev/docs/bookurls
- */
-
-jQuery.extend(BookReader.defaultOptions, {
-  enableUrlPlugin: true,
-  bookId: '',
-  /** @type {string} Defaults can be a urlFragment string */
-  defaults: null,
-  updateWindowTitle: false,
-  /** @type {'history' | 'hash'} */
-  urlMode: 'hash',
-  /**
-   * When using 'history' mode, this part of the URL is kept constant
-   * @example /details/plato/
-   */
-  urlHistoryBasePath: '/',
-  /** Only these params will be reflected onto the URL */
-  urlTrackedParams: ['page', 'search', 'mode', 'region', 'highlight', 'view'],
-  /** If true, don't update the URL when `page == n0 (eg "/page/n0")` */
-  urlTrackIndex0: false
-});
-
-/** @override */
-BookReader.prototype.setup = function (super_) {
-  return function (options) {
-    super_.call(this, options);
-    this.bookId = options.bookId;
-    this.defaults = options.defaults;
-    this.locationPollId = null;
-    this.oldLocationHash = null;
-    this.oldUserHash = null;
-  };
-}(BookReader.prototype.setup);
-
-/** @override */
-BookReader.prototype.init = function (super_) {
-  return function () {
-    if (this.options.enableUrlPlugin) {
-      this.bind(BookReader.eventNames.PostInit, () => {
-        var {
-          updateWindowTitle,
-          urlMode
-        } = this.options;
-        if (updateWindowTitle) {
-          document.title = this.shortTitle(this.bookTitle, 50);
-        }
-        if (urlMode === 'hash') {
-          this.urlStartLocationPolling();
-        }
-      });
-      this.bind(BookReader.eventNames.fragmentChange, this.urlUpdateFragment.bind(this));
-    }
-    super_.call(this);
-  };
-}(BookReader.prototype.init);
-
-/**
- * Returns a shortened version of the title with the maximum number of characters
- * @param {number} maximumCharacters
- * @return {string}
- */
-BookReader.prototype.shortTitle = function (maximumCharacters) {
-  if (this.bookTitle.length < maximumCharacters) {
-    return this.bookTitle;
-  }
-  var title = "".concat(this.bookTitle.substr(0, maximumCharacters - 3), "...");
-  return title;
-};
-
-/**
- * Starts polling of window.location to see hash fragment changes
- */
-BookReader.prototype.urlStartLocationPolling = function () {
-  this.oldLocationHash = this.urlReadFragment();
-  if (this.locationPollId) {
-    clearInterval(this.locationPollId);
-    this.locationPollId = null;
-  }
-  var updateHash = () => {
-    var newFragment = this.urlReadFragment();
-    var hasFragmentChange = newFragment != this.oldLocationHash && newFragment != this.oldUserHash;
-    if (!hasFragmentChange) {
-      return;
-    }
-    var params = this.paramsFromFragment(newFragment);
-    var updateParams = () => this.updateFromParams(params);
-    this.trigger(BookReader.eventNames.stop);
-    if (this.animating) {
-      // Queue change if animating
-      if (this.autoStop) this.autoStop();
-      this.animationFinishedCallback = updateParams;
-    } else {
-      // update immediately
-      updateParams();
-    }
-    this.oldUserHash = newFragment;
-  };
-  this.locationPollId = setInterval(updateHash, 500);
-};
-
-/**
- * Update URL from the current parameters.
- * Call this instead of manually using window.location.replace
- */
-BookReader.prototype.urlUpdateFragment = function () {
-  var allParams = this.paramsFromCurrent();
-  var {
-    urlTrackIndex0,
-    urlTrackedParams
-  } = this.options;
-  if (!urlTrackIndex0 && typeof allParams.index !== 'undefined' && allParams.index === 0) {
-    delete allParams.index;
-    delete allParams.page;
-  }
-  var params = urlTrackedParams.reduce((validParams, paramName) => {
-    if (paramName in allParams) {
-      validParams[paramName] = allParams[paramName];
-    }
-    return validParams;
-  }, {});
-  var newFragment = this.fragmentFromParams(params, this.options.urlMode);
-  var currFragment = this.urlReadFragment();
-  var currQueryString = this.getLocationSearch();
-  var newQueryString = this.queryStringFromParams(params, currQueryString, this.options.urlMode);
-  if (currFragment === newFragment && currQueryString === newQueryString) {
-    return;
-  }
-  if (this.options.urlMode === 'history') {
-    if (!window.history || !window.history.replaceState) {
-      this.options.urlMode = 'hash';
-    } else {
-      var baseWithoutSlash = this.options.urlHistoryBasePath.replace(/\/+$/, '');
-      var newFragmentWithSlash = newFragment === '' ? '' : "/".concat(newFragment);
-      var newUrlPath = "".concat(baseWithoutSlash).concat(newFragmentWithSlash).concat(newQueryString);
-      try {
-        window.history.replaceState({}, null, newUrlPath);
-        this.oldLocationHash = newFragment + newQueryString;
-      } catch (e) {
-        // DOMException on Chrome when in sandboxed iframe
-        this.options.urlMode = 'hash';
-      }
-    }
-  }
-  if (this.options.urlMode === 'hash') {
-    var newQueryStringSearch = this.urlParamsFiltersOnlySearch(this.readQueryString());
-    window.location.replace('#' + newFragment + newQueryStringSearch);
-    this.oldLocationHash = newFragment + newQueryStringSearch;
-  }
-};
-
-/**
- * @private
- * Filtering query parameters to select only book search param (?q=foo)
-   This needs to be updated/URL system modified if future query params are to be added
- * @param {string} url
- * @return {string}
- * */
-BookReader.prototype.urlParamsFiltersOnlySearch = function (url) {
-  var params = new URLSearchParams(url);
-  return params.has('q') ? "?".concat(new URLSearchParams({
-    q: params.get('q')
-  })) : '';
-};
-
-/**
- * Will read either the hash or URL and return the bookreader fragment
- * @return {string}
- */
-BookReader.prototype.urlReadFragment = function () {
-  var {
-    urlMode,
-    urlHistoryBasePath
-  } = this.options;
-  if (urlMode === 'history') {
-    return window.location.pathname.substr(urlHistoryBasePath.length);
-  } else {
-    return window.location.hash.substr(1);
-  }
-};
-
-/**
- * Will read the hash return the bookreader fragment
- * @return {string}
- */
-BookReader.prototype.urlReadHashFragment = function () {
-  return window.location.hash.substr(1);
-};
-export class BookreaderUrlPlugin extends BookReader {
-  init() {
-    if (this.options.enableUrlPlugin) {
-      this.urlPlugin = new UrlPlugin(this.options);
-      this.bind(BookReader.eventNames.PostInit, () => {
-        var {
-          urlMode
-        } = this.options;
-        if (urlMode === 'hash') {
-          this.urlPlugin.listenForHashChanges();
-        }
-      });
-    }
-    super.init();
-  }
-}
-window.BookReader = BookreaderUrlPlugin;
-export default BookreaderUrlPlugin;

package/dist/esm/util/browserSniffing.js

@@ -1,56 +0,0 @@
-/**
- * Checks whether the current browser is a Chrome/Chromium browser
- * Code from https://stackoverflow.com/a/4565120/2317712
- * @param {string} [userAgent]
- * @param {string} [vendor]
- * @return {boolean}
- */
-export function isChrome() {
-  var userAgent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : navigator.userAgent;
-  var vendor = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : navigator.vendor;
-  return /chrome/i.test(userAgent) && /google inc/i.test(vendor);
-}
-
-/**
- * Checks whether the current browser is firefox
- * @param {string} [userAgent]
- * @return {boolean}
- */
-export function isFirefox() {
-  var userAgent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : navigator.userAgent;
-  return /firefox/i.test(userAgent);
-}
-
-/**
- * Checks whether the current browser is safari
- * https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent#Browser_Name
- * @param {string} [userAgent]
- * @return {boolean}
- */
-export function isSafari() {
-  var userAgent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : navigator.userAgent;
-  return /safari/i.test(userAgent) && !/chrome|chromium/i.test(userAgent);
-}
-
-/**
- * Checks whether the current browser is iOS (and hence iOS webkit)
- * @return {boolean}
- */
-export function isIOS() {
-  // We can't just check the userAgent because as of iOS 13,
-  // the userAgent is the same as desktop Safari because
-  // they wanted iPad's to be served the same version of websites
-  // as desktops.
-  return 'ongesturestart' in window && navigator.maxTouchPoints > 0;
-}
-
-/**
- * Checks whether the current browser is Samsung Internet
- * https://stackoverflow.com/a/40684162/2317712
- * @param {string} [userAgent]
- * @return {boolean}
- */
-export function isSamsungInternet() {
-  var userAgent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : navigator.userAgent;
-  return /SamsungBrowser/i.test(userAgent);
-}

package/dist/esm/util/debouncer.js

@@ -1,25 +0,0 @@
-/**
- * Wait until some time has passed before executing a callback.
- *
- * @param {Function} callback
- * @param {Number}   threshhold - in milliseconds
- * @param {*}        context    - will be bound to callback as its "this" value
- */
-class Debouncer {
-  constructor(callback) {
-    var threshhold = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 250;
-    var context = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
-    this.callback = callback;
-    this.threshhold = threshhold;
-    this.context = context;
-    this.deferTimeout = undefined;
-  }
-  execute() {
-    clearTimeout(this.deferTimeout);
-    this.deferTimeout = setTimeout(this.executeCallback.bind(this), this.threshhold);
-  }
-  executeCallback() {
-    this.callback.apply(this.context);
-  }
-}
-export { Debouncer as default };

package/dist/esm/util/docCookies.js

@@ -1,75 +0,0 @@
-/**
- * Helper module use to get, set and remove item from cookie
- *
- * See more:
- *  https://developer.mozilla.org/en-US/docs/Web/API/document.cookie
- *  https://developer.mozilla.org/User:fusionchess
- *  https://github.com/madmurphy/cookies.js
- *  This framework is released under the GNU Public License, version 3 or later.
- *  http://www.gnu.org/licenses/gpl-3.0-standalone.html
- */
-
-/**
- * Check to see if the browser has cookies enabled.
- * Accessing document.cookies errors if eg iframe with sandbox enabled.
- * @returns {boolean}
- */
-export function areCookiesBlocked() {
-  var doc = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document;
-  try {
-    doc.cookie;
-    return false;
-  } catch (e) {
-    return true;
-  }
-}
-var COOKIES_BLOCKED = areCookiesBlocked();
-
-/**
- * Get specific key's value stored in cookie
- *
- * @param {string} sKey
- *
- * @returns {string|null}
- */
-export function getItem(sKey) {
-  if (COOKIES_BLOCKED || !sKey) return null;
-  return decodeURIComponent(
-  // eslint-disable-next-line no-useless-escape
-  document.cookie.replace(new RegExp('(?:(?:^|.*;)\\s*' + encodeURIComponent(sKey).replace(/[\-\.\+\*]/g, '\\$&') + '\\s*\\=\\s*([^;]*).*$)|^.*$'), '$1')) || null;
-}
-
-/**
- * Set specific key's value in cookie
- *
- * @param {string} sKey cookie name
- * @param {string} sValue cookie value
- * @param {string} [vEnd] expire|max-age
- * @param {string} [sPath] path of current item
- * @param {string} [sDomain] domain name
- * @param {boolean} [bSecure]
- *
- * @returns {boolean}
- */
-export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
-  if (COOKIES_BLOCKED) return false;
-  document.cookie = encodeURIComponent(sKey) + '=' + encodeURIComponent(sValue) + (vEnd ? "; expires=".concat(vEnd.toUTCString()) : '') + (sDomain ? "; domain=".concat(sDomain) : '') + (sPath ? "; path=".concat(sPath) : '') + (bSecure ? "; secure" : '');
-  return true;
-}
-
-/**
- * BROKEN Remove specific key's value from cookie
- * @fixme hasItem isn't even implemented! This will always error.
- * @param {string} sKey cookie name
- * @param {string} [sPath] path of current item
- * @param {string} [sDomain]
- *
- * @returns {boolean}
- */
-export function removeItem(sKey, sPath, sDomain) {
-  if (COOKIES_BLOCKED) return false;
-  // eslint-disable-next-line
-  if (!hasItem(sKey)) return false;
-  document.cookie = encodeURIComponent(sKey) + "=; expires=Thu, 01 Jan 1970 00:00:00 GMT" + (sDomain ? "; domain=".concat(sDomain) : '') + (sPath ? "; path=".concat(sPath) : '');
-  return true;
-}

package/dist/esm/util/strings.js

@@ -1,34 +0,0 @@
-/**
- * @typedef {String} StringWithVars
- * A template string with {{foo}} style variables
- * Also supports filters, like {{bookPath|urlencode}} (See APPLY_FILTERS for the
- * supported list of filters)
- **/
-
-/**
- * @param {StringWithVars|String} template
- * @param { {[varName: string]: { toString: () => string} } } vars
- * @param { {[varName: string]: { toString: () => string} } } [overrides]
- */
-export function applyVariables(template, vars) {
-  var overrides = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-  var possibleFilters = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : APPLY_FILTERS;
-  return template === null || template === void 0 ? void 0 : template.replace(/\{\{([^}]*?)\}\}/g, ($0, $1) => {
-    if (!$1) return $0;
-    /** @type {string} */
-    var expression = $1;
-    var [varName, ...filterNames] = expression.split('|').map(x => x.trim());
-    var defined = varName in overrides || varName in vars;
-
-    // If it's not defined, don't expand it at all
-    if (!defined) return $0;
-    var value = varName in overrides ? overrides[varName] : varName in vars ? vars[varName] : null;
-    var filters = filterNames.map(n => possibleFilters[n]);
-    return filters.reduce((acc, cur) => cur(acc), value && value.toString());
-  });
-}
-
-/** @type { {[filterName: String]:( string => string)} } */
-export var APPLY_FILTERS = {
-  urlencode: encodeURIComponent
-};

package/index.js

@@ -1,2 +0,0 @@
-export { default as BookReader } from './src/BookReader.js';
-export { IaBookReader } from './src/ia-bookreader/ia-bookreader.js';