@internetarchive/bookreader 5.0.0-48-alpha2 → 5.0.0-48

package/BookReaderDemo/IADemoBr.js

@@ -82,6 +82,8 @@ const initializeBookReader = (brManifest) => {
   // we expect this at the global level
   BookReaderJSIAinit(brManifest.data, options);
 
+  const isRestricted = brManifest.data.isRestricted;
+  window.dispatchEvent(new CustomEvent('contextmenu', { detail: { isRestricted } }));
   if (customAutoflipParams.autoflip) {
     br.autoToggle(customAutoflipParams);
   }

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 5.0.0-48
+- Fix: move analytics to sample bucket @iisa
+- Dev: update dependencies (concurrently, jest) @renovate
+
 # 5.0.0-47
 - Fix: XSS vulnerability in search results @latonv
 - Dev: Update jQuery to v3 **BREAKING** @cdrini

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-48-alpha2",
+  "version": "5.0.0-48",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",

package/src/BookNavigator/book-navigator.js

@@ -449,10 +449,10 @@ export class BookNavigator extends LitElement {
   /** Display an element's context menu */
   manageContextMenuVisibility(e) {
     if (window.archive_analytics) {
-      window.archive_analytics?.send_event_no_sampling(
+      window.archive_analytics?.send_event(
         'BookReader',
         `contextmenu-${this.bookIsRestricted ? 'restricted' : 'unrestricted'}`,
-        e.target.classList.value
+        e.target?.classList?.value
       );
     }
     if (!this.bookIsRestricted) {

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

@@ -2,16 +2,46 @@ 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 = 'Read offline';
+    this.label = 'Downloadable files';
     this.menuDetails = '';
     this.downloads = [];
     this.id = 'downloads';
     this.component = '';
-    this.isBookProtected = bookreader?.options?.protected ?? false;
+    this.isBookProtected = bookreader?.options?.isProtected || false;
   }
 
   update(downloadTypes) {
@@ -24,21 +54,23 @@ export default class DownloadsProvider {
   }
 
   /**
-   * Restructures available download type data for the renderer
-   * Sets global `downloads`
+   * Generates Download Menu Info for available types
+   * sets global `downloads`
    * @param  availableTypes
    */
   computeAvailableTypes(availableTypes = []) {
     const menuData = availableTypes.reduce((found, incoming = []) => {
       const [ type = '', link = '' ] = incoming;
-      if (!type) return found;
-      let formattedType = type.toLowerCase();
-      if ((formattedType === 'pdf' || formattedType === 'epub') && this.isBookProtected) {
-        formattedType = `adobe${formattedType}`;
+      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);
       }
-      found[formattedType] = link;
       return found;
-    }, {});
+    }, []);
 
     this.downloads = menuData;
   }

package/src/BookNavigator/downloads/downloads.js

@@ -1,6 +1,5 @@
 import { css, html, LitElement, nothing } from 'lit';
 import buttonStyles from '../assets/button-base.js';
-
 export class IABookDownloads extends LitElement {
   static get properties() {
     return {
@@ -19,26 +18,6 @@ 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``;
@@ -51,80 +30,65 @@ export class IABookDownloads extends LitElement {
   }
 
   renderDownloadOptions() {
-    const downloadOptions = [];
-    ['pdf', 'epub', 'lcppdf', 'lcpepub', 'adobepdf', 'adobeepub'].forEach(format => {
-      if (this.downloads[format]) {
-        downloadOptions.push(this.downloadOption(format, this.downloads[format]));
-      }
-    });
-    return html`
-      <ul>
-        ${downloadOptions}
-      </ul>
-    `;
-  }
-
-  downloadOption(format, link) {
-    if (/^adobe/.test(format)) {
-      return html`
+    return this.downloads.map(option => (
+      html`
         <li>
-          <a
-            href="${link}"
-            data-event-click-tracking="BookReader|Download-${format}"
-          >${this.menuText[format].linkText}</a>
-          ${this.menuText[format].message ?? nothing}
+          <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;
     }
     return html`
-      <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>
+      <header>
+        <h3>Downloadable files</h3>
+        ${this.formatsCount}
+      </header>
     `;
   }
 
-  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() {
+  get accessProtectedBook() {
     return html`
-      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>.
+      <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>
     `;
   }
 
-  get adobeNote() {
+  get installSimplyEAldikoThoriumMsg() {
+    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>
+  `;
+  }
+
+  render() {
     return html`
-      Requires a compatible e-reader like <a hef="https://www.adobe.com/solutions/ebook/digital-editions.html">Adobe Digital Editions</a>.
+      ${this.header}
+      ${this.loanExpiryMessage}
+      <ul>${this.renderDownloadOptions()}</ul>
+      ${this.hasLCPOption
+      ? this.installSimplyEAldikoThoriumMsg
+      : (this.isBookProtected ? this.accessProtectedBook : nothing)
+      }
     `;
   }
 

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

@@ -104,7 +104,7 @@ export default class VolumesProvider {
     if (!window.archive_analytics) {
       return;
     }
-    window.archive_analytics?.send_event_no_sampling(
+    window.archive_analytics?.send_event(
       'BookReader',
       `VolumesSort|${orderBy}`,
       window.location.path,

package/tests/jest/BookNavigator/book-navigator.test.js

@@ -46,6 +46,13 @@ window.ResizeObserver = class ResizeObserver {
   disconnect = sinon.fake()
 };
 
+beforeEach(() => {
+  window.archive_analytics = {
+    send_event_no_sampling: sinon.fake(),
+    send_event: sinon.fake()
+  };
+});
+
 afterEach(() => {
   window.br = null;
   fixtureCleanup();
@@ -516,8 +523,6 @@ describe('<book-navigator>', () => {
   describe('Handles Restricted Books', () => {
     describe('contextMenu is prevented when book is restricted', () => {
       it('watches on `div.BRscreen`', async () => {
-        window.archive_analytics = { send_event_no_sampling: sinon.fake() };
-
         const el = fixtureSync(container());
         const brStub = {
           options: { restricted: true },
@@ -529,9 +534,8 @@ describe('<book-navigator>', () => {
         const elSpy = sinon.spy(el.manageContextMenuVisibility);
         await el.elementUpdated;
 
-        expect(window.archive_analytics.send_event_no_sampling.called).toEqual(
-          false
-        );
+        expect(window.archive_analytics.send_event_no_sampling.called).toEqual(false);
+        expect(window.archive_analytics.send_event.called).toEqual(false);
         expect(elSpy.called).toEqual(false);
 
         const body = document.querySelector('body');
@@ -550,14 +554,13 @@ describe('<book-navigator>', () => {
 
         // analytics fires
         expect(window.archive_analytics.send_event_no_sampling.called).toEqual(
-          true
+          false
         );
+        expect(window.archive_analytics.send_event.called).toEqual(true);
         // we prevent default
         expect(preventDefaultSpy.called).toEqual(true);
       });
       it('watches on `img.BRpageimage`', async () => {
-        window.archive_analytics = { send_event_no_sampling: sinon.fake() };
-
         const el = fixtureSync(container());
         const brStub = {
           options: { restricted: true },
@@ -568,9 +571,8 @@ describe('<book-navigator>', () => {
 
         await el.elementUpdated;
 
-        expect(window.archive_analytics.send_event_no_sampling.called).toEqual(
-          false
-        );
+        expect(window.archive_analytics.send_event_no_sampling.called).toEqual(false);
+        expect(window.archive_analytics.send_event.called).toEqual(false);
 
         const body = document.querySelector('body');
         // const element stub for img.BRpageimage
@@ -586,14 +588,13 @@ describe('<book-navigator>', () => {
         imgBRpageimage.dispatchEvent(contextMenuEvent);
 
         // analytics fires
-        expect(window.archive_analytics.send_event_no_sampling.called).toEqual(true);
+        expect(window.archive_analytics.send_event_no_sampling.called).toEqual(false);
+        expect(window.archive_analytics.send_event.called).toEqual(true);
         // we prevent default
         expect(preventDefaultSpy.called).toEqual(true);
       });
     });
     it('Allows unrestricted books access to context menu', async () => {
-      window.archive_analytics = { send_event_no_sampling: sinon.fake() };
-
       const el = fixtureSync(container());
       const brStub = {
         options: { restricted: false },
@@ -607,6 +608,8 @@ describe('<book-navigator>', () => {
       expect(window.archive_analytics.send_event_no_sampling.called).toEqual(
         false
       );
+      expect(window.archive_analytics.send_event.called).toEqual(false);
+
 
       const body = document.querySelector('body');
       // const element stub for img.BRpageimage
@@ -622,7 +625,8 @@ describe('<book-navigator>', () => {
       imgBRpageimage.dispatchEvent(contextMenuEvent);
 
       // analytics fires
-      expect(window.archive_analytics.send_event_no_sampling.called).toEqual(true);
+      expect(window.archive_analytics.send_event_no_sampling.called).toEqual(false);
+      expect(window.archive_analytics.send_event.called).toEqual(true);
       // we do not prevent default
       expect(preventDefaultSpy.called).toEqual(false);
     });