@internetarchive/ia-book-actions 0.1.2 → 0.1.3-alpha2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.1.2",
+  "version": "0.1.3-alpha2",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",

package/src/components/timer-countdown.js

@@ -31,12 +31,6 @@ export default class TimerCountdown extends LitElement {
      */
     this.loanRenewAtLast = 0;
 
-    /**
-     * setInterval executed interval
-     * @type {number}
-     */
-    this.timerInterval = undefined;
-
     /**
      * delay seconds in setInterval function
      * @type {number}
@@ -45,12 +39,13 @@ export default class TimerCountdown extends LitElement {
   }
 
   disconnectedCallback() {
-    clearInterval(this.timerInterval);
+    window?.IALendingIntervals?.clearTimerCountdown();
   }
 
   updated(changed) {
     if (changed.has('secondsLeftOnLoan') && this.secondsLeftOnLoan > 0) {
-      clearInterval(this.timerInterval);
+      this.disconnectedCallback();
+
       this.timerCountdown();
     }
   }
@@ -59,10 +54,21 @@ export default class TimerCountdown extends LitElement {
     // - let just execute setInterval in every 1 minute
     this.timerExecutionSeconds = 60;
 
-    this.timerInterval = setInterval(() => {
+    /**
+     * set interval in window object
+     * @see ia-lending-intervals.js
+     */
+    window.IALendingIntervals.timerCountdown = setInterval(() => {
       this.secondsLeftOnLoan -= this.timerExecutionSeconds;
       const secondsLeft = Math.round(this.secondsLeftOnLoan);
 
+      console.log(
+        'timeLeftInSec',
+        secondsLeft,
+        ' ||| timeLeftInMin',
+        Math.ceil(secondsLeft / 60)
+      );
+
       /**
        * execute from last 10th minute to 0th minute
        * - 10th - to check if user has viewed
@@ -84,7 +90,7 @@ export default class TimerCountdown extends LitElement {
 
       // clear interval
       if (secondsLeft <= 60) {
-        clearInterval(this.timerInterval);
+        this.disconnectedCallback();
         window?.Sentry?.captureMessage(sentryLogs.clearOneHourTimer);
       }
     }, this.timerExecutionSeconds * 1000);
@@ -111,8 +117,8 @@ export default class TimerCountdown extends LitElement {
   render() {
     return html`
       <svg
-        width="16"
-        height="16"
+        width="14"
+        height="14"
         viewBox="0 0 100 100"
         xmlns="http://www.w3.org/2000/svg"
       >

package/src/core/config/ia-lending-intervals.js

@@ -0,0 +1,35 @@
+/**
+ * Collection of methods for managing intervals for lending system
+ *
+ * There are mainly two intervals being used
+ * - tokenPoller :- used to create_token for borrowed book
+ * - timerCountdown :- reponsible for loan-auto-renew and auto returned warning message
+ *
+ * @see TimerCountdown::timerCountdown function
+ * @see LoanTokenPoller::bookAccessed function
+ *
+ * @type {Object}
+ */
+window.IALendingIntervals = {
+  /**
+   * clear interval for create_token api
+   */
+  clearTokenPoller: () => {
+    window.clearInterval(window?.IALendingIntervals?.tokenPoller);
+  },
+
+  /**
+   * clear interval for graphic timer for one-hour loan renew
+   */
+  clearTimerCountdown: () => {
+    window.clearInterval(window.IALendingIntervals.timerCountdown);
+  },
+
+  /**
+   * clear all intervals being used acros lending system
+   */
+  clearAll: () => {
+    window.clearInterval(window?.IALendingIntervals?.tokenPoller);
+    window.clearInterval(window?.IALendingIntervals?.timerCountdown);
+  },
+};

package/src/core/services/loan-renew-helper.js

@@ -13,7 +13,8 @@ export class LoanRenewHelper {
     this.loanRenewTimeConfig = loanRenewTimeConfig;
 
     // messages for auto return machenism
-    this.loanRenewMessage = 'This book has been renewed for 1 hour.';
+    this.loanRenewMessage =
+      'This book has been renewed for #time #unitsOfTime.';
     this.loanReturnWarning =
       'This book will be automatically returned in #time #unitsOfTime unless you turn a page.';
 
@@ -117,7 +118,7 @@ export class LoanRenewHelper {
    * @returns {String} // texts will be appear in toast template
    */
   getMessageTexts(texts, secondsLeft) {
-    const unitOfTime = 'minute';
+    let unitOfTime = 'minute';
 
     let toastTexts = texts;
     let timeLeft = secondsLeft;
@@ -125,6 +126,12 @@ export class LoanRenewHelper {
     // convert time from second to minute
     timeLeft = Math.ceil(timeLeft / 60);
 
+    // convert time from minute to hour
+    if (timeLeft > 59) {
+      timeLeft = 1; // 1 hour
+      unitOfTime = 'hour';
+    }
+
     // replace #time variable with remaining time
     toastTexts = toastTexts?.replace(/#time/, timeLeft);
 

package/src/core/services/loan-token-poller.js

@@ -20,17 +20,8 @@ export class LoanTokenPoller {
     this.bookAccessed();
   }
 
-  disconnectedInterval() {
-    clearInterval(this.loanTokenInterval);
-    this.loanTokenInterval = undefined;
-
-    // temporary disabling sentry notice
-    // as message is informational, not critical nor an error.
-    // also, as of 11/28/2022, JS build maps are not working properly on petabox
-    // and as a result, this comment is not properly grouped.
-    // if (window.Sentry) {
-    //   window?.Sentry?.captureMessage('loan token interval cleared');
-    // }
+  disconnectedCallback() {
+    window?.IALendingIntervals?.clearTokenPoller();
   }
 
   async bookAccessed() {
@@ -59,7 +50,11 @@ export class LoanTokenPoller {
       // - we don't want to fetch token on interval
       // - the initial token is enough to set cookies for reading book and readaloud features
       if (this.borrowType !== 'adminBorrowed') {
-        this.loanTokenInterval = setInterval(() => {
+        /**
+         * set interval in window object
+         * @see ia-lending-intervals.js
+         */
+        window.IALendingIntervals.tokenPoller = setInterval(() => {
           this.handleLoanTokenPoller();
         }, this.pollerDelay * 1000);
       }
@@ -77,7 +72,7 @@ export class LoanTokenPoller {
       );
 
       // if book is not browsed, just clear token polling interval
-      this.disconnectedInterval(); // stop token fetch api
+      this.disconnectedCallback();
     }
   }
 
@@ -95,7 +90,6 @@ export class LoanTokenPoller {
       identifier: this.identifier,
       action,
       error: data => {
-        this.disconnectedInterval(); // stop token fetch api
         this.errorCallback({ detail: { action, data } });
 
         // send error to Sentry

package/src/ia-book-actions.js

@@ -11,6 +11,7 @@ import './components/book-title-bar.js';
 import './components/text-group.js';
 import './components/info-icon.js';
 import './components/timer-countdown.js';
+import './core/config/ia-lending-intervals.js';
 
 import { GetLendingActions } from './core/services/get-lending-actions.js';
 import { mobileContainerWidth } from './core/config/constants.js';
@@ -102,7 +103,9 @@ export default class IABookActions extends LitElement {
   }
 
   disconnectedCallback() {
-    this.tokenPoller?.disconnectedInterval();
+    // clear all intervals for lending system
+    window?.IALendingIntervals?.clearAll();
+
     window?.Sentry?.captureMessage(sentryLogs.disconnectedCallback);
     this.disconnectResizeObserver();
   }
@@ -197,7 +200,8 @@ export default class IABookActions extends LitElement {
       if (!this.tokenPoller) {
         window?.Sentry?.captureMessage(sentryLogs.bookWasExpired);
       }
-      this.tokenPoller?.disconnectedInterval();
+      window?.IALendingIntervals?.clearAll();
+
       /** Global event - always fire */
       this.dispatchEvent(
         new Event(events.browseExpired, {
@@ -336,7 +340,11 @@ export default class IABookActions extends LitElement {
 
     // if secondsLeft < 60, consider it 1 minute
     let { secondsLeft } = this.loanRenewResult;
-    secondsLeft = secondsLeft > 60 ? secondsLeft : 60;
+    if (secondsLeft === undefined) {
+      secondsLeft = this.lendingStatus.secondsLeftOnLoan;
+    } else {
+      secondsLeft = secondsLeft > 60 ? secondsLeft : 60;
+    }
 
     const config = new ToastConfig();
     config.dismisOnClick = true;
@@ -385,7 +393,7 @@ export default class IABookActions extends LitElement {
    * Execute when loan is expired
    */
   async browseHasExpired() {
-    this.tokenPoller?.disconnectedInterval();
+    window?.IALendingIntervals?.clearAll();
 
     const currStatus = { ...this.lendingStatus, browsingExpired: true };
     this.lendingStatus = currStatus;
@@ -495,11 +503,11 @@ export default class IABookActions extends LitElement {
    */
   async handleLoanAutoRenewed() {
     if (this.loanRenewResult.renewNow) {
-      this.tokenPoller?.disconnectedInterval();
+      window?.IALendingIntervals?.clearAll();
 
       this.suppressToast = false;
-      await this.showToastMessage();
       await this.browseHasRenew();
+      await this.showToastMessage();
       await this.resetTimerCountState();
 
       window?.Sentry?.captureMessage(`${sentryLogs.bookHasRenewed}`);
@@ -519,10 +527,6 @@ export default class IABookActions extends LitElement {
    * @see LoanTokenPoller
    */
   startLoanTokenPoller() {
-    if (this.tokenPoller) {
-      window?.Sentry?.captureMessage(sentryLogs.clearTokenPoller);
-      this.tokenPoller?.disconnectedInterval();
-    }
     const successCallback = () => {
       this.lendingBarPostInit();
     };
@@ -572,6 +576,9 @@ export default class IABookActions extends LitElement {
     // toggle activity loader
     this.handleToggleActionGroup();
 
+    // clear all intervals for lending system when error occured
+    window?.IALendingIntervals?.clearAll();
+
     const action = event?.detail?.action;
     const errorMsg = event?.detail?.data?.error;
 
@@ -581,8 +588,6 @@ export default class IABookActions extends LitElement {
     // - clear tokenPoller interval
     // - set user_has_browsed to `false`
     if (action === 'create_token') {
-      this.tokenPoller?.disconnectedInterval();
-
       const currStatus = {
         ...this.lendingStatus,
         user_has_browsed: false,

package/demo/with-bookreader.html

@@ -1,146 +0,0 @@
-<!doctype html>
-<html lang="en-GB">
-
-<head>
-  <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
-  <style>
-    html {
-      font-size: 10px;
-      /* This is to match petabox's base font size */
-    }
-    body {
-      margin: 0;
-      text-align: center;
-      font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
-    }
-    #demo {
-      height: 50px;
-    }
-    ia-book-actions {
-      --white: #fff;
-      --black: #000;
-      --primaryBGColor: var(--black);
-      --secondaryBGColor: #222;
-      --tertiaryBGColor: #333;
-      --primaryTextColor:  var(--white);
-      --primaryCTAFill: #194880;
-      --primaryCTABorder: #c5d1df;
-      --secondaryCTAFill: #333;
-      --secondaryCTABorder: #999;
-      --secondaryCTAFillRGB: 51, 51, 51;
-      --primaryErrorCTAFill: #e51c26;
-      --primaryErrorCTABorder: #f8c6c8;
-      --primaryCTAFillRGB: 25, 72, 128;
-      --primaryErrorCTAFillRGB: 229, 28, 38;
-      --primaryDisableCTAFill: #767676;
-    }
-
-    fieldset {
-      width: fit-content;
-      margin-top: 50px;
-    }
-    fieldset legend {
-      text-align: left;
-      font-size: 12px;
-    }
-    td {
-      color: white;
-      font-size: 14px;
-      border-radius: 5%;
-      display: table-cell;
-      text-align: initial;
-      margin: 5px 0;
-      width: max-content;
-      display: block;
-    }
-    label {
-      padding: 10px;
-      display: block;
-      cursor: pointer;
-      margin: 2px;
-      background: #4e545a;
-      border-radius: 10px;
-    }
-    input[type="radio"], input[type="checkbox"] {
-      margin-top: 0;
-      vertical-align: middle;
-    }
-
-    .initial td {
-      float: left;
-      margin: 2px;
-    }
-
-    body.modal-manager-open {
-      overflow: hidden;
-    }
-  
-    modal-manager[mode='closed'] {
-      display: none;
-    }
-  </style>
-</head>
-
-<body>
-  <ia-bookreader class="focus-on-child-only" signedin="" fullscreen="">
-    <div slot="header">
-      <ia-book-actions></ia-book-actions>
-    </div>
-    <div slot="main">
-      <div id="BookReader"></div>
-    </div>
-  </ia-bookreader>
-
-
-  <script type="module">
-    /* eslint-disable */
-    import '@internetarchive/bookreader';
-    import '@internetarchive/bookreader/BookReader/jquery-1.10.1.js';
-    import '@internetarchive/bookreader/BookReader/BookReader.js';
-    import '../src/ia-book-actions.js';
-    import {
-      defaultLendingStatus,
-      canBrowseAndBorrow,
-    } from '../src/assets/data/lending-get-status-service.js';
-    import { ModalConfig } from '@internetarchive/modal-manager';
-
-    const userid = '@neeraj-archive';
-    const identifier = 'naturalhistoryof00unse_4111';
-    let bwbPurchaseUrl = 'https://www.betterworldbooks.com/product/detail/cambridge-ancient-hist-v04-0521044863';
-
-    let iaBookActions = document.querySelector('ia-book-actions');
-
-    // for debugging
-    window.iaBookActions = iaBookActions;
-
-    const modalConfig = new ModalConfig();
-    modalConfig.headerColor = '#d9534f';
-
-    let lendingBarPostInit = function lendingBarPostInit() {
-      setTimeout(function() {
-        console.log('executed', 'br.init()');
-      }, 100);
-    }
-
-    // set defaultLendingStatus for unavailable (without borrowables) book
-    iaBookActions.userid = userid;
-    iaBookActions.identifier = identifier;
-    iaBookActions.bookTitle = 'Contemporary Black biography. Volume 39 : profiles from the interContemporary Black biography. Volume 39';
-    iaBookActions.lendingStatus = canBrowseAndBorrow;
-    iaBookActions.bwbPurchaseUrl = '';
-    iaBookActions.modalConfig = modalConfig;
-    iaBookActions.lendingBarPostInit = lendingBarPostInit;
-    iaBookActions.tokenDelay = 2000; // 2 seconds
-    iaBookActions.returnUrl = 'https://openlibrary.org';
-
-    let lendingStatus1 = iaBookActions.lendingStatus;
-
-    const manifest = await fetch('https://ia801302.us.archive.org/BookReader/BookReaderJSIA.php?id=goody&itemPath=/29/items/goody&server=ia801302.us.archive.org&format=jsonp&subPrefix=goody&requestUri=/details/goody/mode/1up%3Fview%3Dtheater%26ui%3Dembed%26wrapper%3Dfalse');
-
-    console.log('manifest ****', manifest).then(res => res.json());
-  </script>
-
-  </div>
-</body>
-</html>