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

package/src/util/browserSniffing.js

@@ -7,7 +7,17 @@
  * @return {boolean}
  */
 export function isChrome(userAgent = navigator.userAgent, vendor = navigator.vendor) {
-  return /chrome/i.test(userAgent) && /google inc/i.test(vendor);
+  return /chrome/i.test(userAgent) && /google inc/i.test(vendor) && !isEdge(userAgent);
+}
+
+/**
+ * Checks whether the current browser is a Edge browser
+ * See https://learn.microsoft.com/en-us/microsoft-edge/web-platform/user-agent-guidance
+ * @param {string} [userAgent]
+ * @return {boolean}
+ */
+export function isEdge(userAgent = navigator.userAgent) {
+  return /chrome/i.test(userAgent) && /\bEdg(e|A|iOS)?\b/i.test(userAgent);
 }
 
 /**
@@ -28,3 +38,34 @@ export function isFirefox(userAgent = navigator.userAgent) {
 export function isSafari(userAgent = 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 on android
+ * @param {string} [userAgent]
+ * @return {boolean}
+ */
+export function isAndroid(userAgent = navigator.userAgent) {
+  return /android/i.test(userAgent);
+}
+
+/**
+ * Checks whether the current browser is Samsung Internet
+ * https://stackoverflow.com/a/40684162/2317712
+ * @param {string} [userAgent]
+ * @return {boolean}
+ */
+export function isSamsungInternet(userAgent = navigator.userAgent) {
+  return /SamsungBrowser/i.test(userAgent);
+}

package/src/util/cache.js

@@ -0,0 +1,20 @@
+/**
+ * @template T
+ */
+export class Cache {
+  constructor(maxSize = 10) {
+    this.maxSize = maxSize;
+    /** @type {T[]} */
+    this.entries = [];
+  }
+
+  /**
+   * @param {T} entry
+   */
+  add(entry) {
+    if (this.entries.length >= this.maxSize) {
+      this.entries.shift();
+    }
+    this.entries.push(entry);
+  }
+}

package/src/util/docCookies.js

@@ -9,6 +9,22 @@
  *  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(doc = document) {
+  try {
+    doc.cookie;
+    return false;
+  } catch (e) {
+    return true;
+  }
+}
+
+const COOKIES_BLOCKED = areCookiesBlocked();
+
 /**
  * Get specific key's value stored in cookie
  *
@@ -17,7 +33,7 @@
  * @returns {string|null}
  */
 export function getItem(sKey) {
-  if (!sKey) return null;
+  if (COOKIES_BLOCKED || !sKey) return null;
 
   return decodeURIComponent(
     // eslint-disable-next-line no-useless-escape
@@ -34,9 +50,11 @@ export function getItem(sKey) {
  * @param {string} [sDomain] domain name
  * @param {boolean} [bSecure]
  *
- * @returns {true}
+ * @returns {boolean}
  */
 export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
+  if (COOKIES_BLOCKED) return false;
+
   document.cookie = encodeURIComponent(sKey) + '=' + encodeURIComponent(sValue)
   + (vEnd ? `; expires=${vEnd.toUTCString()}` : '')
   + (sDomain ? `; domain=${sDomain}` : '')
@@ -56,6 +74,7 @@ export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
  * @returns {boolean}
  */
 export function removeItem(sKey, sPath, sDomain) {
+  if (COOKIES_BLOCKED) return false;
   // eslint-disable-next-line
   if (!hasItem(sKey)) return false;
 

package/src/util/dom.js

@@ -0,0 +1,88 @@
+// @ts-check
+import { clamp } from '../BookReader/utils.js';
+
+/**
+ * Walks up the DOM tree starting at (but not including) the given element,
+ * returning the nearest ancestor that can actually scroll its overflow.
+ * @param {Element} el
+ * @return {Element | null}
+ */
+export function findScrollableAncestor(el) {
+  let current = el.parentElement;
+  while (current) {
+    const style = getComputedStyle(current);
+    const canScrollY = (style.overflowY === 'auto' || style.overflowY === 'scroll') && current.scrollHeight > current.clientHeight;
+    const canScrollX = (style.overflowX === 'auto' || style.overflowX === 'scroll') && current.scrollWidth > current.clientWidth;
+    if (canScrollY || canScrollX) return current;
+    current = current.parentElement;
+  }
+  return null;
+}
+
+/**
+ * Computes the scroll offset for a single axis needed to align an element
+ * within a container, per the same semantics as scrollIntoView's block/inline.
+ * @param {number} elStart
+ * @param {number} elEnd
+ * @param {number} containerStart
+ * @param {number} containerEnd
+ * @param {number} currentScroll
+ * @param {'start' | 'center' | 'end' | 'nearest'} align
+ * @return {number}
+ */
+function computeAxisScroll(elStart, elEnd, containerStart, containerEnd, currentScroll, align) {
+  let delta = 0;
+  switch (align) {
+  case 'start':
+    delta = elStart - containerStart;
+    break;
+  case 'end':
+    delta = elEnd - containerEnd;
+    break;
+  case 'center':
+    delta = (elStart + elEnd) / 2 - (containerStart + containerEnd) / 2;
+    break;
+  case 'nearest':
+  default:
+    if (elStart < containerStart) delta = elStart - containerStart;
+    else if (elEnd > containerEnd) delta = elEnd - containerEnd;
+    break;
+  }
+  return currentScroll + delta;
+}
+
+/**
+ * Scrolls the given element into view within a single scroll container.
+ *
+ * Unlike the native `Element.scrollIntoView`, this never walks up and scrolls
+ * every scrollable ancestor in turn (which can otherwise unexpectedly move
+ * the whole page) — it only ever adjusts the scroll position of one
+ * container: either the one explicitly passed in, or the nearest scrollable
+ * ancestor found via {@link findScrollableAncestor}.
+ * @param {Element} el
+ * @param {object} [options]
+ * @param {'auto' | 'smooth'} [options.behavior]
+ * @param {'start' | 'center' | 'end' | 'nearest'} [options.block]
+ * @param {'start' | 'center' | 'end' | 'nearest'} [options.inline]
+ * @param {Element} [options.scrollContainer] The scrollable element whose
+ *   scroll position should be adjusted. Defaults to `findScrollableAncestor(el)`.
+ */
+export function singleScrollIntoView(el, options) {
+  const { block = 'start', inline = 'nearest', behavior = 'auto', scrollContainer = findScrollableAncestor(el) } = options || {};
+  if (!scrollContainer) {
+    el.scrollIntoView({ block, inline, behavior });
+    return;
+  }
+
+  const containerRect = scrollContainer.getBoundingClientRect();
+  const elRect = el.getBoundingClientRect();
+
+  const top = computeAxisScroll(elRect.top, elRect.bottom, containerRect.top, containerRect.bottom, scrollContainer.scrollTop, block);
+  const left = computeAxisScroll(elRect.left, elRect.right, containerRect.left, containerRect.right, scrollContainer.scrollLeft, inline);
+
+  scrollContainer.scrollTo({
+    top: clamp(top, 0, scrollContainer.scrollHeight - scrollContainer.clientHeight),
+    left: clamp(left, 0, scrollContainer.scrollWidth - scrollContainer.clientWidth),
+    behavior,
+  });
+}

package/src/util/generators.js

@@ -0,0 +1,89 @@
+// @ts-check
+
+/**
+ * @template T
+ * Get the i-th element of an iterable
+ * @param {Iterable<T>} iterable
+ * @param {number} index
+ */
+export function genAt(iterable, index) {
+  let i = 0;
+  for (const x of iterable) {
+    if (i == index) return x;
+    i++;
+  }
+  return undefined;
+}
+
+/**
+ * @template T
+ * Generator version of filter
+ * @param {Iterable<T>} iterable
+ * @param {function(T): boolean} fn
+ */
+export function* genFilter(iterable, fn) {
+  for (const x of iterable) {
+    if (fn(x)) yield x;
+  }
+}
+
+/**
+ * @template TFrom, TTo
+ * Generator version of map
+ * @param {Iterable<TFrom>} gen
+ * @param {function(TFrom): TTo} fn
+ * @returns {Iterable<TTo>}
+ */
+export function* genMap(gen, fn) {
+  for (const x of gen) yield fn(x);
+}
+
+/**
+ * @template T
+ * Generator that provides a sliding window of 3 elements,
+ * prev, current, and next.
+ * @param {Iterable<T>} gen
+ * @returns {Iterable<[T | undefined, T, T | undefined]>}
+ */
+export function* lookAroundWindow(gen) {
+  let prev = undefined;
+  let cur = undefined;
+  let next = undefined;
+  for (const x of gen) {
+    if (typeof cur !== 'undefined') {
+      next = x;
+      yield [prev, cur, next];
+    }
+    prev = cur;
+    cur = x;
+    next = undefined;
+  }
+
+  if (typeof cur !== 'undefined') {
+    yield [prev, cur, next];
+  }
+}
+
+/**
+ * @template T1, T2
+ * Lazy zip implementation to avoid importing lodash
+ * Expects iterators to be of the same length
+ * @param {Iterable<T1>} gen1
+ * @param {Iterable<T2>} gen2
+ * @returns {Iterable<[T1, T2]>}
+ */
+export function* zip(gen1, gen2) {
+  const it1 = gen1[Symbol.iterator]();
+  const it2 = gen2[Symbol.iterator]();
+  while (true) {
+    const r1 = it1.next();
+    const r2 = it2.next();
+    if (r1.done && r2.done) {
+      return;
+    }
+    if (r1.done || r2.done) {
+      throw new Error('zip: one of the iterators is done');
+    }
+    yield [r1.value, r2.value];
+  }
+}

package/src/util/lit.js

@@ -0,0 +1,15 @@
+import { css } from 'lit';
+
+/**
+ * Convert an SVG string to a data URL usable in CSS
+ * @param {import('lit').TemplateResult} svgTemplate - The SVG template to convert
+ * @returns {import('lit').CSSResult}
+ */
+export function svgToDataUrl(svgTemplate) {
+  // No clue why, on prod the template from the close icon comes in as a class instead of a TemplateResult.
+  // Might be a discrepancy with lit versions.
+  if (svgTemplate.prototype) svgTemplate = svgTemplate.prototype.render();
+
+  const svgString = svgTemplate.strings[0];
+  return css([`data:image/svg+xml;base64,${btoa(svgString.replace(/\n/g, ' '))}`]);
+}

package/src/util/strings.js

@@ -5,10 +5,21 @@
  * supported list of filters)
  **/
 
+/**
+ * Count whitespace-delimited words in a string.
+ * @param {string} text
+ * @return {number}
+ */
+export function countWords(text) {
+  const matches = text.match(/\S+/g);
+  return matches ? matches.length : 0;
+}
+
 /**
  * @param {StringWithVars|String} template
  * @param { {[varName: string]: { toString: () => string} } } vars
  * @param { {[varName: string]: { toString: () => string} } } [overrides]
+ * @returns {StringWithVars|string}
  */
 export function applyVariables(template, vars, overrides = {}, possibleFilters = APPLY_FILTERS) {
   return template?.replace(/\{\{([^}]*?)\}\}/g, ($0, $1) => {

package/.babelrc

@@ -1,12 +0,0 @@
-{
-    "presets": [
-        [
-            "@babel/preset-env",
-            {
-                "targets": "> 2%, ie 11, edge 14, samsung > 9, OperaMini all, UCAndroid > 12",
-                "useBuiltIns": "usage",
-                "corejs": 3
-            }
-        ]
-    ]
-}

package/.dependabot/config.yml

@@ -1,6 +0,0 @@
-version: 1
-
-update_configs:
-  - package_manager: "javascript"
-    directory: "/"
-    update_schedule: "monthly"

package/.eslintrc.js

@@ -1,50 +0,0 @@
-module.exports = {
-  "env": {
-    "browser": true,
-    "jquery": true,
-    "es6": true,
-    "node": true,
-    "jest": true
-  },
-  "plugins": [
-    "testcafe"
-  ],
-  "extends": [
-    "eslint:recommended",
-    "plugin:testcafe/recommended"
-  ],
-  "globals": {
-    // Browser API
-    "MediaMetadata": "readonly"
-  },
-  "parserOptions": {
-    "ecmaVersion": 2020,
-    "sourceType": "module"
-  },
-  "rules": {
-    "comma-dangle": ["error", "only-multiline"],
-    "semi": ["error", "always"],
-    "space-before-blocks": ["error"],
-    "keyword-spacing": [2, {"before": true, "after": true}],
-    "indent": ["error", 2],
-    "no-console": "off", // Used too often behind `debug` options; not dealing with this now
-    "no-empty": ["error", { "allowEmptyCatch": true }],
-    "no-trailing-spaces": ["error"],
-    "no-unused-vars": ["error", { "vars": "all", "args": "none", "ignoreRestSiblings": false }], // set args:none; this is generally more annoying than useful
-    "no-var": ["error"],
-    "prefer-const": ["error"],
-    "space-infix-ops": ["error", { "int32Hint": false }],
-    "eol-last": ["error", "always"]
-  },
-  "overrides": [
-    { // TODO; these should be cleaned up as well
-      "files": [
-        "src/BookReader.js",
-        "src/dragscrollable-br.js"
-      ],
-      "rules": {
-        "no-var": ["off"],
-      }
-    },
-  ],
-};

package/.gitattributes

@@ -1,2 +0,0 @@
-# Build files
-BookReader/**/* binary

package/.github/ISSUE_TEMPLATE/bug.md

@@ -1,32 +0,0 @@
----
-name: Bug
-about: A general problem with website functionality
-title: ''
-labels: Bug
-assignees: ''
-
----
-
-**Description**
-
-> What problem are we solving? What does the experience look like today? What are the symptoms? How can one reproduce the problem?
-
-**Evidence / Screenshot (if possible)**
-
-> Include evidence of the problem or provide a screenshot.
-
-**Expectation**
-
-> What should be happening? What will it look like / how will it behave when fixed?
-
-**Context**
-
-> What operating system? What browser type and version?
-
-**Proposal & Constraints**
-
-> What is the proposed solution / implementation? Is there a precedent of this approach succeeding elsewhere?
-
-**Stakeholders**
-
-> @-tag any stakeholders of this bug

package/.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,30 +0,0 @@
----
-name: Feature Request
-about: A request for an entirely new feature
-title: ''
-labels: Feature Request
-assignees: ''
-
----
-
-**Context**
-
-> Is your feature request related to a problem? What is the motivation for implementing this feature?
-
-**Proposal & Constraints**
-
-> What is the proposed solution / implementation? Is there a precedent for this approach succeeding elsewhere?
-
-> Which suggestions or requirements should be considered for how this feature needs to appear or be implemented?
-
-**Additional Resources**
-
-> Add any other screenshots or assets related to the feature request.
-
-**Success Metrics**
-
-> How will you know if this change is successful? What specific metrics are relevant and how do you expect them to change?
-
-**Stakeholders**
-
-> @-tag stakeholders of this feature

package/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -1,15 +0,0 @@
-**Description**
-
-> What does this PR achieve? Is it a feature/bugfix/refactor? Does it close an Issue? If so, use `Closes #<issue number>`.
-
-**Technical**
-
-> What should be noted about the implementation?
-
-**Testing**
-
-> What steps should the reviewer take to verify this PR resolves the issue?
-
-**Screenshots/Videos**
-
-> Add a screenshot or video/GIF if the fix can be seen visually. This is helpful for reviewers to get context for the fix.

package/.github/workflows/node.js.yml

@@ -1,37 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v1
-      with:
-        node-version: 14.x
-    - uses: actions/cache@v2
-      with:
-        # Caching node_modules isn't recommended because it can break across
-        # Node versions and won't work with npm ci (See https://github.com/actions/cache/blob/main/examples.md#node---npm )
-        # But we pin the node version, and we don't update it that often anyways. And 
-        # we don't use `npm ci` specifically to try to get faster CI flows. So caching
-        # `node_modules` directly.
-        path: 'node_modules'
-        key: ${{ runner.os }}-node-${{ hashFiles('package*.json') }}
-    - run: npm install
-    - run: npm run build
-    - run: npm run lint
-    - run: npm run test
-    - run: npm run codecov
-    # Travis machines usually have 2 cores (see https://docs.travis-ci.com/user/reference/overview/#virtualisation-environment-vs-operating-system )
-    # Quarantine mode (sigh) to catch unstable tests (see https://devexpress.github.io/testcafe/documentation/guides/basic-guides/run-tests.html#quarantine-mode )
-    - run: BASE_URL=http://127.0.0.1:8000/BookReaderDemo/ npx testcafe --concurrency 2 --quarantine-mode

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

@@ -1,47 +0,0 @@
-# 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
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 14
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 14
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish --tag next
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 14
-          registry-url: https://npm.pkg.github.com/
-      - run: npm ci
-      - run: npm publish --tag next
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.testcaferc.json

@@ -1,5 +0,0 @@
-{
-  "appCommand": "npm run serve",
-  "browsers": ["chrome:headless", "firefox:headless"],
-  "src": ["tests/e2e/**/*test.js"]
-}