@internetarchive/ia-book-actions 0.0.29-alpha39 → 0.0.29-alpha40

package/demo/index.html

@@ -120,6 +120,7 @@
     // set defaultLendingStatus for unavailable (without borrowables) book
     let iaBookActions = document.querySelector('ia-book-actions');
 
+
     iaBookActions.userid = userid;
     iaBookActions.identifier = identifier;
     iaBookActions.bookTitle = 'Contemporary Black biography. Volume 39 : profiles from the interContemporary Black biography. Volume 39';
@@ -132,15 +133,15 @@
     iaBookActions.localCache = localCache;
 
     let isDevBox = true;
-    iaBookActions.loanRenewConfig = {
-      totalTime: isDevBox ? 13 : 3600, // 60 second = 1 min
-      autoCheckAt: isDevBox ? 10 : 3540, // at last 10th minute
+    iaBookActions.loanRenewTimeConfig = {
+      loanTotalTime: isDevBox ? 13 : 3600, // 60 second = 1 min
+      loanRenewAtLast: isDevBox ? 10 : 3540, // at last 10th minute
       pageChangedInLast: isDevBox ? 5 : 900, // within last 15 second/minute
       isDevBox: isDevBox,
     };
 
     let lendingStatus1 = iaBookActions.lendingStatus;
-    let secondsLeftOnLoan = iaBookActions.loanRenewConfig.totalTime;
+    let secondsLeftOnLoan = iaBookActions.loanRenewTimeConfig.loanTotalTime;
 
     document.querySelectorAll('.titleBar input[type=checkbox]').forEach((item) => {
       item.addEventListener('click', (e) => {
@@ -217,7 +218,7 @@
             await localCache.set({
               key: `${identifier}-loanTime`,
               value: new Date(), // current time
-              ttl: Number(iaBookActions.loanRenewConfig.totalTime),
+              ttl: Number(iaBookActions.loanRenewTimeConfig.loanTotalTime),
             });
 
             await localCache.delete(`${identifier}-pageChangedTime`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.29-alpha39",
+  "version": "0.0.29-alpha40",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@internetarchive/icon-info": "^1.2.6",
     "@internetarchive/local-cache": "^0.2.0",
-    "@internetarchive/modal-manager": "^0.2.6",
+    "@internetarchive/modal-manager": "^0.2.8",
     "@internetarchive/shared-resize-observer": "^0.2.0",
-    "@internetarchive/toast-manager": "0.0.1-alpha9",
+    "@internetarchive/toast-manager": "0.1.0",
     "lit": "^2.5.0"
   },
   "devDependencies": {
@@ -45,10 +45,10 @@
   },
   "eslintConfig": {
     "rules": {
-      "no-console": "off",
-      "no-unused-expressions": "off",
-      "class-methods-use-this": "off",
-      "lit-a11y/click-events-have-key-events": "off"
+      "no-console": "warn",
+      "no-unused-expressions": "warn",
+      "class-methods-use-this": "warn",
+      "lit-a11y/click-events-have-key-events": "warn"
     },
     "extends": [
       "@open-wc/eslint-config",
@@ -60,7 +60,9 @@
     "arrowParens": "avoid"
   },
   "husky": {
-    "hooks": {}
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
   },
   "lint-staged": {
     "*.js": [

package/src/components/timer-countdown.js

@@ -4,15 +4,31 @@ import { sentryLogs } from '../core/config/sentry-events.js';
 export default class TimerCountdown extends LitElement {
   static get properties() {
     return {
-      timeLeftOnLoan: { type: Number },
-      loanRenewConfig: { type: Object },
+      secondsLeftOnLoan: { type: Number }, // in seconds
+      loanRenewAtLast: { type: Number }, // in seconds
+      isDevBox: { type: Boolean },
     };
   }
 
   constructor() {
     super();
-    this.timeLeftOnLoan = 0;
-    this.loanRenewConfig = {};
+
+    /**
+     * seconds left in current time
+     * @type {number}
+     */
+    this.secondsLeftOnLoan = 0;
+
+    /**
+     * at the remaining time, we attempt to renew current loan
+     * @type {number}
+     */
+    this.loanRenewAtLast = 0;
+
+    /**
+     * @type {boolean}
+     */
+    this.isDevBox = false;
 
     // private props
     this.timerInterval = undefined;
@@ -23,44 +39,44 @@ export default class TimerCountdown extends LitElement {
   }
 
   updated(changed) {
-    if (changed.has('timeLeftOnLoan') && this.timeLeftOnLoan > 0) {
+    if (changed.has('secondsLeftOnLoan') && this.secondsLeftOnLoan > 0) {
       clearInterval(this.timerInterval);
       this.timerCountdown();
     }
   }
 
   timerCountdown() {
-    // execute interval in each second in-case of dev environment
-    this.timerInterval = setInterval(
-      () => {
-        this.timeLeftOnLoan -= this.loanRenewConfig.isDevBox ? 1 : 60;
-        const timeLeft = Math.round(this.timeLeftOnLoan);
-
-        // execute from last 10th minute to 0th minute
-        // - 10th - to check if user has viewed
-        // - till 0th - to show warning msg with remaining time to auto returned
-        if (timeLeft <= this.loanRenewConfig.autoCheckAt) {
-          this.dispatchEvent(
-            new CustomEvent('IABookActions:loanRenew', {
-              detail: {
-                hasPageChanged: false,
-                timeLeft,
-              },
-              bubbles: true,
-              composed: true,
-            })
-          );
-        }
+    // in-case of isDevBox, execute timer in each second instead of 60
+    const timerIntervalSeconds = this.isDevBox ? 1 : 60;
 
-        // clear interval
-        if (timeLeft <= 1) {
-          clearInterval(this.timerInterval);
-          window?.Sentry?.captureMessage(sentryLogs.clearOneHourTimer);
-          console.log(sentryLogs.clearOneHourTimer);
-        }
-      },
-      this.loanRenewConfig.isDevBox ? 1000 : 60000
-    );
+    this.timerInterval = setInterval(() => {
+      // if this.isDevBox, just reduce seconds by 1 instead of 60 (1 min)
+      this.secondsLeftOnLoan -= timerIntervalSeconds;
+      const secondsLeft = Math.round(this.secondsLeftOnLoan);
+
+      // execute from last 10th minute to 0th minute
+      // - 10th - to check if user has viewed
+      // - till 0th - to show warning msg with remaining time to auto expired
+      if (secondsLeft <= this.loanRenewAtLast) {
+        this.dispatchEvent(
+          new CustomEvent('IABookActions:loanRenew', {
+            detail: {
+              hasPageChanged: false,
+              secondsLeft,
+            },
+            bubbles: true,
+            composed: true,
+          })
+        );
+      }
+
+      // clear interval
+      if (secondsLeft <= 1) {
+        clearInterval(this.timerInterval);
+        window?.Sentry?.captureMessage(sentryLogs.clearOneHourTimer);
+        console.log(sentryLogs.clearOneHourTimer);
+      }
+    }, timerIntervalSeconds * 1000);
   }
 
   render() {
@@ -73,14 +89,15 @@ export default class TimerCountdown extends LitElement {
       >
         <circle class="circle" cx="50" cy="50" r="50" />
       </svg>
-      <span>${Math.round(this.timeLeftOnLoan)}</span>
+      <span class="sr-only"></span>
+      <span>${Math.round(this.secondsLeftOnLoan)}</span>
     `;
   }
 
   static get styles() {
     const white = css`var(--white, #fff)`;
-    const timerSecondsLeft = css`var(--timerSeconds, 6000s)`;
-    const timerStrokeLeft = css`var(--timerStroke, 315)`;
+    const timerSecondsLeft = css`var(--secondsLeftOnLoan, 6000s)`; //
+    const timerStrokeLeft = css`var(--strokeLeftOnLoan, 315)`;
 
     return css`
       :host {

package/src/core/config/sentry-events.js

@@ -1,5 +1,5 @@
 /**
- * Analytics categories and events. Used when building actions in
+ * sentry logs/messages we send for different actions....
  */
 export const sentryLogs = {
   disconnectedCallback: 'IABookActions:disconnectedCallback',
@@ -13,7 +13,7 @@ export const sentryLogs = {
     'IABookActions:startLoanTokenPoller - clearing token poller interval',
   clearOneHourTimer:
     'IABookActions:timerCountdown - one-hour timer interval cleared',
-  enableBookAccess: 'IABookActions:enableBookAccess',
+  bookAccessed: 'IABookActions:bookAccessed',
   handleLoanTokenPoller: 'IABookActions:handleLoanTokenPoller',
   setConsecutiveLoanCounts: 'IABookActions:setConsecutiveLoanCounts',
   actionsHandlerService: 'IABookActions:actionsHandlerService',

package/src/core/services/actions-config.js

@@ -36,7 +36,7 @@ export default class ActionsConfig {
   firstBrowseConfig() {
     return {
       id: 'browseBook',
-      text: 'Borrow', // changed texts from 'Borrow for 1 hour' to 'Borrow'
+      text: 'Borrow',
       className: 'primary',
       analyticsEvent: {
         category: this.analyticsCategories.preview,
@@ -48,7 +48,7 @@ export default class ActionsConfig {
   browseAgainConfig() {
     return {
       id: 'browseBookAgain',
-      text: 'Borrow', // changed texts fro 'Borrow again' to 'Borrow'
+      text: 'Borrow',
       className: 'primary',
       analyticsEvent: {
         category: this.analyticsCategories.browse,

package/src/core/services/actions-handler/actions-handler.js

@@ -17,7 +17,12 @@ import * as Cookies from '../doc-cookies.js';
 export default class ActionsHandler extends LitElement {
   constructor() {
     super();
-    this.ajaxTimeout = 6; // in seconds
+
+    /**
+     * wait untill borrow is complete, then refresh the page
+     * @type {number}
+     */
+    this.waitUntillBorrowComplete = 6; // in seconds
 
     this.bindEvents();
   }
@@ -126,7 +131,6 @@ export default class ActionsHandler extends LitElement {
       action,
       identifier: this.identifier,
       success: data => {
-        // success analytics by isa?
         this.setBrowseTimeSession();
         this.dispatchEvent(
           new CustomEvent('loanAutoRenewed', {
@@ -264,7 +268,7 @@ export default class ActionsHandler extends LitElement {
     // redirection on details page after 5 seconds because borrowing book takes time to create item creation.
     setTimeout(() => {
       URLHelper.goToUrl(redirectTo, true);
-    }, this.ajaxTimeout * 1000);
+    }, this.waitUntillBorrowComplete * 1000);
   }
 
   // save consecutive loan count for borrow
@@ -297,14 +301,15 @@ export default class ActionsHandler extends LitElement {
    */
   async setBrowseTimeSession() {
     try {
-      const { totalTime } = this.loanRenewConfig;
-      const expireDate = new Date(new Date().getTime() + totalTime * 1000);
+      const expireDate = new Date(
+        new Date().getTime() + this.loanTotalTime * 1000
+      );
 
       // set a value
       await this.localCache.set({
         key: `${this.identifier}-loanTime`,
         value: expireDate,
-        ttl: Number(totalTime),
+        ttl: Number(this.loanTotalTime),
       });
 
       // delete pageChangedTime when book is auto renew at nth minute

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

@@ -4,11 +4,11 @@ import { nothing } from 'lit';
  * This class is used to determine if use is eligible for auto renew loan.
  */
 export class LoanRenewHelper {
-  constructor(hasPageChanged, identifier, localCache, loanRenewConfig) {
+  constructor(hasPageChanged, identifier, localCache, loanRenewTimeConfig) {
     this.hasPageChanged = hasPageChanged;
     this.identifier = identifier;
     this.localCache = localCache;
-    this.loanRenewConfig = loanRenewConfig;
+    this.loanRenewTimeConfig = loanRenewTimeConfig;
 
     // messages for auto return machenism
     this.loanRenewMessage = 'This book has been renewed for 1 hour.';
@@ -44,15 +44,15 @@ export class LoanRenewHelper {
    */
   async pageChanged() {
     const {
-      totalTime, // 60
-      autoCheckAt, // 50
-    } = this.loanRenewConfig;
+      loanTotalTime, // 60
+      loanRenewAtLast, // 50
+    } = this.loanRenewTimeConfig;
     const currentTime = new Date();
     const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
 
     const lastTimeFrame = this.changeTime(
       loanTime,
-      totalTime - autoCheckAt,
+      loanTotalTime - loanRenewAtLast,
       'add'
     );
 
@@ -74,7 +74,7 @@ export class LoanRenewHelper {
    * @returns {this.result}
    */
   async autoChecker() {
-    const { pageChangedInLast } = this.loanRenewConfig;
+    const { pageChangedInLast } = this.loanRenewTimeConfig;
     const pageChangedTime = await this.localCache.get(
       `${this.identifier}-pageChangedTime`
     );
@@ -108,7 +108,7 @@ export class LoanRenewHelper {
     await this.localCache.set({
       key: `${this.identifier}-pageChangedTime`,
       value: new Date(), // current time
-      ttl: Number(this.loanRenewConfig.totalTime),
+      ttl: Number(this.loanRenewTimeConfig.loanTotalTime),
     });
   }
 
@@ -146,18 +146,18 @@ export class LoanRenewHelper {
    * Helper function to get time difference
    *
    * @param {Date} date
-   * @param {Number} minutes
-   * @param {String} op
+   * @param {Number} seconds
+   * @param {String} op - like sub, add, mul, sub
    *
    * @returns {Object} Date
    */
-  changeTime(date, minutes, op) {
+  changeTime(date, seconds, op) {
     if (date === undefined) return null;
 
     if (op === 'sub') {
-      return new Date(date.getTime() - minutes * 1000);
+      return new Date(date.getTime() - seconds * 1000);
     }
 
-    return new Date(date.getTime() + minutes * 1000);
+    return new Date(date.getTime() + seconds * 1000);
   }
 }

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

@@ -17,7 +17,7 @@ export class LoanTokenPoller {
     this.pollerDelay = pollerDelay; // value in seconds
 
     this.loanTokenInterval = undefined;
-    this.enableBookAccess();
+    this.bookAccessed();
   }
 
   disconnectedInterval() {
@@ -33,7 +33,7 @@ export class LoanTokenPoller {
     // }
   }
 
-  async enableBookAccess() {
+  async bookAccessed() {
     let consecutiveLoanCounts = 1;
 
     if (this.borrowType) {
@@ -73,7 +73,7 @@ export class LoanTokenPoller {
       this.sendEvent(category, action);
     } else {
       window?.Sentry?.captureMessage(
-        `${sentryLogs.enableBookAccess} - not borrowed`
+        `${sentryLogs.bookAccessed} - not borrowed`
       );
 
       // if book is not browsed, just clear token polling interval

package/src/ia-book-actions.js

@@ -42,7 +42,7 @@ export default class IABookActions extends LitElement {
       modal: { Object },
       tokenDelay: { type: Number },
       localCache: { type: Object },
-      loanRenewConfig: { type: Object },
+      loanRenewTimeConfig: { type: Object },
       loanRenewResult: { type: Object },
     };
   }
@@ -71,30 +71,34 @@ export default class IABookActions extends LitElement {
     this.lendingOptions = {};
     this.borrowType = ''; // (browsed|borrowed)
     this.consecutiveLoanCounts = 1; // consecutive loan count
+    this.suppressToast = false;
+    this.browseTimer = undefined;
 
     /**
-     * contains loan renew time config
-     * - totalTime:- number of seconds a loan should last
-     * - autoCheckAt:- check for loan renew at last
-     * - pageChangedInLast: consider loan renew eligible in last
-     * - isDevBox:- it just for testing purpose
+     * contains one hour auto-loan-renew time configuration
+     *
+     * @type {object} loanRenewTimeConfig
+     * @property {number} loanTotalTime - number of seconds a loan should last
+     * @property {number} loanRenewAtLast - check for loan renew at last
+     * @property {number} pageChangedInLast - consider loan renew eligible if viewed new page
+     * @property {boolean} isDevBox - testing flag
      */
-    this.loanRenewConfig = {};
-    this.suppressToast = false;
-    this.browseTimer = undefined;
+    this.loanRenewTimeConfig = {};
 
     /**
-     * contains loan auto-renew response
-     * - texts:- texts messages need to show in toast message
-     * - renewNow:- key to determine if need to renew now
-     * - timeLeft:- number of seconds left in active loan
+     * contains one hour auto-loan-renew response
+     *
+     * @type {object} loanRenewResult
+     * @property {string} texts - texts messages need to show in toast message
+     * @property {boolean} renewNow - key to determine if need to renew now
+     * @property {number} secondsLeft - seconds left in active loan
      */
-    this.loanRenewResult = {
-      texts: null,
-      renewNow: false,
-      timeLeft: 0,
-    };
+    this.loanRenewResult = { texts: '', renewNow: false, secondsLeft: 0 };
 
+    /**
+     * need showdowRoot opened for resetTimerCountState
+     * @see IABookActions::resetTimerCountState
+     */
     this._shadowRoot = this.attachShadow({ mode: 'open' });
   }
 
@@ -210,7 +214,6 @@ export default class IABookActions extends LitElement {
 
     if (this.borrowType === 'browsed') {
       // start timer for browsed.
-      // when browse is completed, we shows browse-again button
       this.startBrowseTimer();
     }
 
@@ -236,6 +239,8 @@ export default class IABookActions extends LitElement {
       () => {
         this.startLoanTokenPoller();
       },
+
+      // if book is renew while reading, let's wait to execute create-token api
       this.loanRenewResult.renewNow ? this.tokenDelay * 1000 : 100
     );
   }
@@ -243,8 +248,9 @@ export default class IABookActions extends LitElement {
   /**
    * Bind 1 hour loan auto renew event,
    * There are two events we want to use,
-   * 1. BookReader:pageChanged - dispatched from bookreader side
-   * 2. IABookActions:loanRenew - dispatched from timer-countdown component
+   * 1. BookReader:userAction - dispatched from bookreader side
+   * 2. click event to refresh the page when book is auto expired
+   * 3. IABookActions:loanRenew - dispatched from timer-countdown component
    */
   bindLoanRenewEvents() {
     /**
@@ -260,10 +266,10 @@ export default class IABookActions extends LitElement {
     });
 
     /**
-     * Detech click-event on document to close toast-template
+     * detect click-event on document to close toast-template
      */
     document.addEventListener('click', e => {
-      if (this.loanRenewHelper && this.loanRenewResult.timeLeft > 0) {
+      if (this.loanRenewHelper && this.loanRenewResult.secondsLeft > 0) {
         console.log('clicked-outside');
         this.suppressToast = true;
       }
@@ -281,13 +287,14 @@ export default class IABookActions extends LitElement {
      * this event dispatched from timer-countdown component for:
      * 1. user turned book page after showing auto-returned warning message
      * 2. show warning message having remaining time
+     * @see TimerCountdown::timerCountdown
      */
     this.addEventListener('IABookActions:loanRenew', async event => {
       await this.autoLoanRenewChecker(false);
 
       // show warning message with remaining time to auto returned it.
       if (this.loanRenewResult.renewNow === false) {
-        this.loanRenewResult.timeLeft = event.detail.timeLeft;
+        this.loanRenewResult.secondsLeft = event.detail.secondsLeft;
         this.showToastMessage();
       }
     });
@@ -295,6 +302,7 @@ export default class IABookActions extends LitElement {
 
   /**
    * To determine if need to be renewed browsed book
+   * @see LoanRenewHelper
    *
    * @param {Boolean} hasPageChanged
    */
@@ -303,7 +311,7 @@ export default class IABookActions extends LitElement {
       hasPageChanged,
       this.identifier,
       this.localCache,
-      this.loanRenewConfig
+      this.loanRenewTimeConfig
     );
 
     await this.loanRenewHelper.handleLoanRenew();
@@ -312,9 +320,9 @@ export default class IABookActions extends LitElement {
 
   /**
    * Show toast messages on some specific loan renew features. e.g.
-   * - show success msg when book is auto renewed
-   * - show success msg when book is auto returned
-   * - show warninig msg when book is about to auto returned
+   * - show message when book is auto renewed
+   * - show message when book is expired
+   * - show message having remaining time when book is about to auto returned
    */
   async showToastMessage() {
     if (this.suppressToast) return;
@@ -329,11 +337,12 @@ export default class IABookActions extends LitElement {
     await iaBookActions.appendChild(toastTemplate);
 
     const config = new ToastConfig();
+    config.dismisOnClick = true;
     config.texts = this.loanRenewHelper?.getMessageTexts(
       this.loanRenewResult.texts,
-      this.loanRenewResult.timeLeft
+      this.loanRenewResult.secondsLeft
     );
-    config.dismisOnClick = true;
+
     toastTemplate.showToast({
       config,
     });
@@ -404,14 +413,14 @@ export default class IABookActions extends LitElement {
 
     const secondsLeft = Number(this.lendingStatus.secondsLeftOnLoan);
     const strokeDashOffset =
-      (secondsLeft / this.loanRenewConfig.totalTime) * 315;
+      (secondsLeft / this.loanRenewTimeConfig.loanTotalTime) * 315;
 
     // set seconds left in loan expire
-    timerCountdown.style?.setProperty('--timerSeconds', `${secondsLeft}s`);
+    timerCountdown.style?.setProperty('--secondsLeftOnLoan', `${secondsLeft}s`);
 
     // set circle stroke offset left in loan expire
     timerCountdown.style?.setProperty(
-      '--timerStroke',
+      '--strokeLeftOnLoan',
       `${Number(strokeDashOffset)}` // the perimeter of the circle = (π * 2 * radius)
     );
 
@@ -444,8 +453,9 @@ export default class IABookActions extends LitElement {
   get timerCountdownTemplate() {
     return this.borrowType === 'browsed'
       ? html`<timer-countdown
-          .timeLeftOnLoan=${Number(this.lendingStatus.secondsLeftOnLoan)}
-          .loanRenewConfig=${this.loanRenewConfig}
+          .secondsLeftOnLoan=${Number(this.lendingStatus.secondsLeftOnLoan)}
+          .loanRenewAtLast=${this.loanRenewTimeConfig.loanRenewAtLast}
+          .isDevBox=${this.loanRenewTimeConfig.isDevBox}
         ></timer-countdown>`
       : nothing;
   }
@@ -462,7 +472,7 @@ export default class IABookActions extends LitElement {
         .borrowType=${this.borrowType}
         .returnUrl=${this.returnUrl}
         .localCache=${this.localCache}
-        .loanRenewConfig=${this.loanRenewConfig}
+        .loanTotalTime=${this.loanRenewTimeConfig.loanTotalTime}
         ?hasAdminAccess=${this.hasAdminAccess}
         ?disabled=${this.disableActionGroup}
         ?renewNow=${this.loanRenewResult.renewNow}
@@ -492,7 +502,9 @@ export default class IABookActions extends LitElement {
       await this.resetTimerCountState();
 
       window?.Sentry?.captureMessage(`${sentryLogs.bookHasRenewed}`);
+      // analytics?? for consecutive renew.....
 
+      // testing console....
       console.log(sentryLogs.bookHasRenewed, {
         loanRenewResult: this.loanRenewResult,
         browseHasRenew: this.lendingStatus.secondsLeftOnLoan,
@@ -503,6 +515,7 @@ export default class IABookActions extends LitElement {
 
   /**
    * enable access of borrowed/browsed books
+   * @see LoanTokenPoller
    */
   startLoanTokenPoller() {
     if (this.tokenPoller) {

package/test/components/timer-countdown.test.js

@@ -1,20 +1,20 @@
 import { html, fixture, expect, aTimeout } from '@open-wc/testing';
 import '../../src/components/timer-countdown.js';
 
-const container = ({ timeLeftOnLoan, loanRenewConfig } = {}) =>
+const container = ({ secondsLeftOnLoan, loanRenewTimeConfig } = {}) =>
   html`<timer-countdown
-    .timeLeftOnLoan=${timeLeftOnLoan}
-    .loanRenewConfig=${loanRenewConfig}
+    .secondsLeftOnLoan=${secondsLeftOnLoan}
+    .loanRenewTimeConfig=${loanRenewTimeConfig}
   ></timer-countdown>`;
 
 describe('<timer-countdown>', () => {
   it('timer interval is undefined when loan is expired', async () => {
     const el = await fixture(
       container({
-        timeLeftOnLoan: 0, // in seconds
-        loanRenewConfig: {
-          totalTime: 14, // in seconds
-          autoCheckAt: 5, // in seconds
+        secondsLeftOnLoan: 0, // in seconds
+        loanRenewTimeConfig: {
+          loanTotalTime: 14, // in seconds
+          loanRenewAtLast: 5, // in seconds
           pageChangedInLast: 5, // in seconds
           isDevBox: true,
         },
@@ -28,10 +28,10 @@ describe('<timer-countdown>', () => {
   it('timer interval is not undefined when loan is active', async () => {
     const el = await fixture(
       container({
-        timeLeftOnLoan: 2, // in seconds
-        loanRenewConfig: {
-          totalTime: 14, // in seconds
-          autoCheckAt: 5, // in seconds
+        secondsLeftOnLoan: 2, // in seconds
+        loanRenewTimeConfig: {
+          loanTotalTime: 14, // in seconds
+          loanRenewAtLast: 5, // in seconds
           pageChangedInLast: 5, // in seconds
           isDevBox: true,
         },
@@ -41,7 +41,7 @@ describe('<timer-countdown>', () => {
     await aTimeout(1900);
     await el.updateComplete;
 
-    expect(el.timeLeftOnLoan).to.equal(1);
+    expect(el.secondsLeftOnLoan).to.equal(2);
     expect(el.timerInterval).to.not.be.undefined;
   });
 });

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

@@ -4,9 +4,9 @@ import { LocalCache } from '@internetarchive/local-cache';
 import { LoanRenewHelper } from '../../../src/core/services/loan-renew-helper.js';
 
 const identifier = 'booBar';
-const loanRenewConfig = {
-  totalTime: 13,
-  autoCheckAt: 10,
+const loanRenewTimeConfig = {
+  loanTotalTime: 13,
+  loanRenewAtLast: 10,
   pageChangedInLast: 12,
   isDevBox: true,
 };
@@ -19,8 +19,10 @@ const localCache = new LocalCache({
 beforeEach(async () => {
   await localCache.set({
     key: `${identifier}-loanTime`,
-    value: new Date(new Date().getTime() + loanRenewConfig.totalTime * 1000),
-    ttl: Number(loanRenewConfig.totalTime),
+    value: new Date(
+      new Date().getTime() + loanRenewTimeConfig.loanTotalTime * 1000
+    ),
+    ttl: Number(loanRenewTimeConfig.loanTotalTime),
   });
 });
 
@@ -31,14 +33,14 @@ describe('Loan Renew Determine', () => {
     await localCache.set({
       key: `${identifier}-pageChangedTime`,
       value: new Date(), // current time
-      ttl: Number(loanRenewConfig.totalTime),
+      ttl: Number(loanRenewTimeConfig.loanTotalTime),
     });
 
     const loanRenewHelper = new LoanRenewHelper(
       true, // hasPageChanged
       identifier,
       localCache,
-      loanRenewConfig
+      loanRenewTimeConfig
     );
     await loanRenewHelper.handleLoanRenew();
 
@@ -49,7 +51,7 @@ describe('Loan Renew Determine', () => {
     await localCache.set({
       key: `${identifier}-pageChangedTime`,
       value: new Date(), // current time
-      ttl: Number(loanRenewConfig.totalTime),
+      ttl: Number(loanRenewTimeConfig.loanTotalTime),
     });
 
     await aTimeout(1500);
@@ -58,7 +60,7 @@ describe('Loan Renew Determine', () => {
       false, // timer-countdown event
       identifier,
       localCache,
-      loanRenewConfig
+      loanRenewTimeConfig
     );
     await loanRenewHelper.handleLoanRenew();
 
@@ -70,12 +72,12 @@ describe('Loan Renew Determine', () => {
       false,
       identifier,
       localCache,
-      loanRenewConfig
+      loanRenewTimeConfig
     );
 
     const toastMsg = loanRenewHelper.getMessageTexts(
       loanRenewHelper.loanReturnWarning,
-      '65'
+      '65' // in seconds
     );
 
     expect(toastMsg).to.be.equal(

package/test/ia-book-actions.test.js

@@ -241,9 +241,9 @@ describe('Browsing expired status', () => {
     expect(el.primaryActions[1].text).to.equal('Print Disability Access');
 
     // default params of one-hour loan renew
-    expect(el.loanRenewResult.texts).to.equal(null);
+    expect(el.loanRenewResult.texts).to.equal('');
     expect(el.loanRenewResult.renewNow).to.equal(false);
-    expect(el.loanRenewResult.timeLeft).to.equal(0);
+    expect(el.loanRenewResult.secondsLeft).to.equal(0);
   });
 
   it('Book is browsing and going to expire after 1 second', async () => {
@@ -272,7 +272,7 @@ describe('Browsing expired status', () => {
 
     //   // book has been expired
     expect(el.loanRenewResult.renewNow).to.equal(false);
-    expect(el.loanRenewResult.timeLeft).to.equal(0);
+    expect(el.loanRenewResult.secondsLeft).to.equal(0);
     expect(el.loanRenewResult.texts).to.equal(
       'This book has been automatically returned due to inactivity.'
     );
@@ -332,7 +332,7 @@ describe('Auto renew one hour loan', () => {
     el.loanRenewResult = {
       texts: 'This book has been renewed for 1 hour.',
       renewNow: true,
-      timeLeft: 10,
+      secondsLeft: 10,
     };
 
     await localCache.set({
@@ -350,11 +350,11 @@ describe('Auto renew one hour loan', () => {
     await aTimeout(1500); // wait for 1.5 second
     await el.updateComplete;
 
-    expect(el.loanRenewResult.timeLeft).to.equal(10);
-    expect(el.loanRenewResult.renewNow).to.equal(true);
     expect(el.loanRenewResult.texts).to.equal(
       'This book has been renewed for 1 hour.'
     );
+    expect(el.loanRenewResult.renewNow).to.equal(true);
+    expect(el.loanRenewResult.secondsLeft).to.equal(10);
   });
 });