@internetarchive/bookreader 5.0.0-47 → 5.0.0-48-alpha1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-47",
+  "version": "5.0.0-48-alpha1",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",
@@ -47,11 +47,11 @@
     "@babel/plugin-proposal-decorators": "7.17.9",
     "@babel/preset-env": "7.16.11",
     "@open-wc/testing-helpers": "^2.1.3",
-    "@types/jest": "^29.0.3",
+    "@types/jest": "^29.1.1",
     "@webcomponents/webcomponentsjs": "^2.6.0",
     "babel-loader": "8.2.5",
     "codecov": "^3.8.3",
-    "concurrently": "7.2.2",
+    "concurrently": "7.4.0",
     "core-js": "3.22.3",
     "cpx2": "4.2.0",
     "eslint": "^7.32.0",
@@ -60,8 +60,8 @@
     "hammerjs": "^2.0.8",
     "http-server": "14.1.1",
     "iso-language-codes": "1.1.0",
-    "jest": "^29.0.3",
-    "jest-environment-jsdom": "^29.0.3",
+    "jest": "^29.1.2",
+    "jest-environment-jsdom": "^29.1.2",
     "jquery": "3.6.1",
     "jquery-colorbox": "1.6.4",
     "jquery-ui": "1.12.1",

package/src/BookNavigator/downloads/downloads-provider.js

@@ -2,41 +2,11 @@ import { html } from 'lit';
 import '@internetarchive/icon-dl/icon-dl';
 import './downloads';
 
-const menuBase = {
-  pdf: {
-    type: 'Encrypted Adobe PDF',
-    url: '#',
-    note: 'PDF files contain high quality images of pages.',
-  },
-  lcppdf: {
-    type: 'Get LCP PDF',
-    url: '#',
-    note: 'PDF files contain high quality images of pages.',
-  },
-  lcpepub: {
-    type: 'Get LCP ePub',
-    url: '#',
-    note: 'ePub files are smaller in size, but may contain errors.',
-  },
-  epub: {
-    type: 'Encrypted Adobe ePub',
-    url: '#',
-    note: 'ePub files are smaller in size, but may contain errors.',
-  },
-};
-
-const publicMenuBase = {
-  pdf: "PDF",
-  epub: "ePub",
-  lcppdf: "LCP PDF",
-  lcpepub: "LCP ePub",
-};
-
 export default class DownloadsProvider {
 
   constructor({ bookreader }) {
     this.icon = html`<ia-icon-dl style="width: var(--iconWidth); height: var(--iconHeight);"></ia-icon-dl>`;
-    this.label = 'Downloadable files';
+    this.label = 'Read offline';
     this.menuDetails = '';
     this.downloads = [];
     this.id = 'downloads';
@@ -54,23 +24,21 @@ export default class DownloadsProvider {
   }
 
   /**
-   * Generates Download Menu Info for available types
-   * sets global `downloads`
+   * Restructures available download type data for the renderer
+   * Sets global `downloads`
    * @param  availableTypes
    */
   computeAvailableTypes(availableTypes = []) {
     const menuData = availableTypes.reduce((found, incoming = []) => {
       const [ type = '', link = '' ] = incoming;
-      const formattedType = type.toLowerCase();
-      const downloadOption = menuBase[formattedType] || null;
-
-      if (downloadOption) {
-        const menuButtonText = this.isBookProtected ? menuBase[formattedType].type : publicMenuBase[formattedType];
-        const menuInfo = Object.assign({}, downloadOption, { url: link,  type: menuButtonText});
-        found.push(menuInfo);
+      if (!type) return found;
+      let formattedType = type.toLowerCase();
+      if ((formattedType === 'pdf' || formattedType === 'epub') && this.isBookProtected) {
+        formattedType = `adobe${formattedType}`;
       }
+      found[formattedType] = link;
       return found;
-    }, []);
+    }, {});
 
     this.downloads = menuData;
   }

package/src/BookNavigator/downloads/downloads.js

@@ -1,5 +1,6 @@
 import { css, html, LitElement, nothing } from 'lit';
 import buttonStyles from '../assets/button-base.js';
+
 export class IABookDownloads extends LitElement {
   static get properties() {
     return {
@@ -18,6 +19,26 @@ export class IABookDownloads extends LitElement {
     this.isBookProtected = false;
   }
 
+  render() {
+    return html`
+      ${this.header}
+      ${this.loanExpiryMessage}
+      ${this.renderDownloadOptions()}
+    `;
+  }
+
+  get header() {
+    if (!this.renderHeader) {
+      return nothing;
+    }
+    return html`
+      <header>
+        <h3>Read offline</h3>
+        ${this.formatsCount}
+      </header>
+    `;
+  }
+
   get formatsCount() {
     const count = this.downloads.length;
     return count ? html`<p>${count} format${count > 1 ? 's' : ''}</p>` : html``;
@@ -30,65 +51,80 @@ export class IABookDownloads extends LitElement {
   }
 
   renderDownloadOptions() {
-    return this.downloads.map(option => (
-      html`
-        <li>
-          <a class="ia-button link primary" href="${option.url}">Get ${option.type}</a>
-          ${option.note ? html`<p>${option.note}</p>` : html``}
-        </li>
-      `
-    ));
-  }
-
-  /**
-   * checks if downloads list contains an LCP option
-   * @return {boolean}
-   */
-  get hasLCPOption() {
-    const regex = /^(LCP)/g;
-    const lcpAvailable = this.downloads.some(option => option.type?.match(regex));
-    return lcpAvailable;
-  }
-
-  get header() {
-    if (!this.renderHeader) {
-      return nothing;
-    }
+    const downloadOptions = [];
+    ['pdf', 'epub', 'lcppdf', 'lcpepub', 'adobepdf', 'adobeepub'].forEach(format => {
+      if (this.downloads[format]) {
+        downloadOptions.push(this.downloadOption(format, this.downloads[format]));
+      }
+    });
     return html`
-      <header>
-        <h3>Downloadable files</h3>
-        ${this.formatsCount}
-      </header>
+      <ul>
+        ${downloadOptions}
+      </ul>
     `;
   }
 
-  get accessProtectedBook() {
+  downloadOption(format, link) {
+    if (/^adobe/.test(format)) {
+      return html`
+        <li>
+          <a
+            href="${link}"
+            data-event-click-tracking="BookReader|Download-${format}"
+          >${this.menuText[format].linkText}</a>
+          ${this.menuText[format].message ?? nothing}
+        </li>
+      `;
+    }
     return html`
-      <p>To access downloaded books, you need Adobe-compliant software on your device. The Internet Archive will administer this loan, but Adobe may also collect some information.</p>
-      <a class="ia-button external primary" href="https://www.adobe.com/solutions/ebook/digital-editions/download.html" rel="noopener noreferrer" target="_blank">Install Adobe Digital Editions</a>
+      <li>
+        <a class="ia-button link primary"
+          href="${link}"
+          data-event-click-tracking="BookReader|Download-${format}"
+        >${this.menuText[format].linkText}</a>
+        ${this.menuText[format].message ? html`<p>${this.menuText[format].message}</p>` : nothing}
+      </li>
     `;
   }
 
-  get installSimplyEAldikoThoriumMsg() {
+  get menuText() {
+    return {
+      pdf: {
+        linkText: 'Get high-resolution PDF',
+        message: html``,
+      },
+      epub: {
+        linkText: 'Get text-based ebook',
+        message: html`Smaller size. May contain some errors.`,
+      },
+      lcppdf: {
+        linkText: 'Get high-resolution PDF',
+        message: this.lcpNote,
+      },
+      lcpepub: {
+        linkText: 'Get text-based ebook',
+        message: html`Smaller size. May contain some errors. ${this.lcpNote}`,
+      },
+      adobepdf: {
+        linkText:'Get legacy Adobe DRM PDF version here.',
+        message: this.adobeNote,
+      },
+      adobeepub: {
+        linkText: 'Get legacy Adobe DRM EPUB version here.',
+        message: this.adobeNote,
+      },
+    };
+  };
+  
+  get lcpNote() {
     return html`
-    <p>For LCP downloads, make sure you have SimplyE or Aldiko Next installed on mobile or Thorium on desktop.</p>
-    <ul>
-      <li><a href="https://librarysimplified.org/simplye/" rel="noopener noreferrer nofollow" target="_blank">Install SimplyE</a></li>
-      <li><a href="https://www.demarque.com/en-aldiko" rel="noopener noreferrer nofollow" target="_blank">Install Aldiko</a></li>
-      <li><a href="https://www.edrlab.org/software/thorium-reader/" rel="noopener noreferrer nofollow" target="_blank">Install Thorium</a></li>
-    </ul>
-  `;
+      Requires having an LCP-compatible e-reader installed like Aldiko Next (<a href="https://apps.apple.com/us/app/aldiko-next/id1476410111">iOS</a>, <a href="https://play.google.com/store/apps/details?id=com.aldiko.android">Android</a>) or <a href="https://www.edrlab.org/software/thorium-reader/">Thorium</a>.
+    `;
   }
 
-  render() {
+  get adobeNote() {
     return html`
-      ${this.header}
-      ${this.loanExpiryMessage}
-      <ul>${this.renderDownloadOptions()}</ul>
-      ${this.hasLCPOption
-      ? this.installSimplyEAldikoThoriumMsg
-      : (this.isBookProtected ? this.accessProtectedBook : nothing)
-      }
+      Requires a compatible e-reader like <a hef="https://www.adobe.com/solutions/ebook/digital-editions.html">Adobe Digital Editions</a>.
     `;
   }