@internetarchive/ia-book-actions 0.1.3-alpha1 → 0.1.4-alpha1

package/demo/index.html

@@ -135,7 +135,7 @@
     let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 180, pageChangedInLast: 15 };
     let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
 
-    iaBookActions.loanRenewTimeConfig = loanTotalTime1Hour;
+    iaBookActions.loanRenewTimeConfig = loanTotalTime2Min;
 
     let lendingStatus1 = iaBookActions.lendingStatus;
     let secondsLeftOnLoan = iaBookActions.loanRenewTimeConfig.loanTotalTime;
@@ -150,6 +150,23 @@
       });
     });
 
+    window.addEventListener('BookReader:userAction', () => {
+      if (this.borrowType === 'browsed') {
+        this.suppressToast = false;
+        this.autoLoanRenewChecker(true);
+      }
+
+      return nothing;
+    });
+
+    document.querySelector('.brControlClick').addEventListener('click', () => {
+      window.dispatchEvent(new CustomEvent('BookReader:userAction', {
+        bubbles: true,
+        composed: true,
+        detail: { props },
+      }));
+    });
+    
     document.querySelectorAll('.errorEnable input[type=checkbox]').forEach((item) => {
       if (window.location.href.indexOf('?error=true') !== -1) {
         item.checked = true;
@@ -311,6 +328,9 @@
             <td>
               <button class="pageChangedEvent">Page Change Event</button>
             </td>
+            <td>
+              <button class="brControlClick">Br Controls</button>
+            </td>
           </tr>
         </table>
     </fieldset>

package/package.json

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

package/src/assets/styles/ia-button.js

@@ -36,7 +36,7 @@ export default css`
     align-items: center;
     transition: all 0.1s ease 0s;
     vertical-align: middle;
-    padding: 0 1rem;
+    padding: 0 3rem;
     outline-color: ${whiteColor};
     outline-offset: -4px;
     user-select: none;

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,30 +39,37 @@ 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();
     }
   }
 
   timerCountdown() {
     // - let just execute setInterval in every 1 minute
-    this.timerExecutionSeconds = 60;
+    this.timerExecutionSeconds = 1;
 
-    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(
+        new Date().toLocaleTimeString(),
         'timeLeftInSec',
         secondsLeft,
         ' ||| timeLeftInMin',
         Math.ceil(secondsLeft / 60)
       );
+
       /**
        * execute from last 10th minute to 0th minute
        * - 10th - to check if user has viewed
@@ -90,7 +91,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);

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/actions-config.js

@@ -166,7 +166,7 @@ export default class ActionsConfig {
 
     return {
       id: 'purchaseBook',
-      text: 'Purchase at',
+      text: 'Purchase at ',
       subText: 'Better World Books',
       title: 'Purchase',
       url: this.bwbPurchaseUrl,

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

@@ -126,8 +126,8 @@ export class LoanRenewHelper {
     // convert time from second to minute
     timeLeft = Math.ceil(timeLeft / 60);
 
-    // convert minute to hour
-    if (timeLeft === 60) {
+    // convert time from minute to hour
+    if (timeLeft > 59) {
       timeLeft = 1; // 1 hour
       unitOfTime = 'hour';
     }

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, {
@@ -267,7 +271,7 @@ export default class IABookActions extends LitElement {
     /**
      * detect click-event on document to close toast-template
      */
-    document.addEventListener('click', e => {
+    window.addEventListener('click', e => {
       if (this.loanRenewHelper && this.loanRenewResult.secondsLeft > 0) {
         this.suppressToast = true;
       }
@@ -389,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;
@@ -499,7 +503,7 @@ export default class IABookActions extends LitElement {
    */
   async handleLoanAutoRenewed() {
     if (this.loanRenewResult.renewNow) {
-      this.tokenPoller?.disconnectedInterval();
+      window?.IALendingIntervals?.clearAll();
 
       this.suppressToast = false;
       await this.browseHasRenew();
@@ -523,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();
     };
@@ -576,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;
 
@@ -585,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,