@internetarchive/ia-book-actions 0.0.29-alpha5 → 0.0.29-alpha50

package/demo/index.html

@@ -15,7 +15,7 @@
       font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
     }
     #demo {
-      height: 50px;
+      height: 100px;
     }
     ia-book-actions {
       --white: #fff;
@@ -72,6 +72,10 @@
       margin: 2px;
     }
 
+    fieldset {
+      display: inline-grid;
+    }
+
     body.modal-manager-open {
       overflow: hidden;
     }
@@ -87,6 +91,7 @@
 
   <script type="module">
     /* eslint-disable */
+
     import '../src/ia-book-actions.js';
     import {
       defaultLendingStatus,
@@ -96,7 +101,7 @@
     import { LocalCache } from '@internetarchive/local-cache';
 
     const localCache = new LocalCache({
-      namespace: '1HourLoanStorage',
+      namespace: 'loanRenew',
       defaultTTL: 1 * 60,  // 1 minute
     });
 
@@ -104,10 +109,6 @@
     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';
@@ -117,6 +118,8 @@
     }
 
     // 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';
@@ -124,17 +127,20 @@
     iaBookActions.bwbPurchaseUrl = '';
     iaBookActions.modalConfig = modalConfig;
     iaBookActions.lendingBarPostInit = lendingBarPostInit;
-    iaBookActions.tokenDelay = 2000; // 2 seconds
+    iaBookActions.tokenDelay = 2; // 2 seconds
     iaBookActions.returnUrl = 'https://openlibrary.org';
     iaBookActions.localCache = localCache;
-    iaBookActions.autoRenewConfig = {
-      totalTime: 20, // 60 second = 1 min
-      autoCheckAt: 15, // totalTime - 10th minute
-      FlippedInLast: 15, // within last 15 second/minute 
+
+    let isDevBox = true;
+    iaBookActions.loanRenewTimeConfig = {
+      loanTotalTime: isDevBox ? 15 : 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.autoRenewConfig.totalTime;
+    let secondsLeftOnLoan = iaBookActions.loanRenewTimeConfig.loanTotalTime;
 
     document.querySelectorAll('.titleBar input[type=checkbox]').forEach((item) => {
       item.addEventListener('click', (e) => {
@@ -146,21 +152,6 @@
       });
     });
 
-    document.querySelectorAll('.autoRenew input[type=checkbox]').forEach((item) => {
-      item.addEventListener('click', (e) => {
-        if (e.target.checked) {
-          iaBookActions.autoRenew = true;
-          iaBookActions.resetTimerCountdown = true;
-          lendingStatus1.secondsLeftOnLoan = secondsLeftOnLoan;
-        } else {
-          iaBookActions.autoRenew = false;
-        }
-
-        let lending = {...defaultLendingStatus, ...lendingStatus1};
-        iaBookActions.lendingStatus = lending;
-      });
-    });
-
     document.querySelectorAll('.errorEnable input[type=checkbox]').forEach((item) => {
       if (window.location.href.indexOf('?error=true') !== -1) {
         item.checked = true;
@@ -226,10 +217,10 @@
             await localCache.set({
               key: `${identifier}-loanTime`,
               value: new Date(), // current time
-              ttl: Number(iaBookActions.autoRenewConfig.totalTime),
-            })
+              ttl: Number(iaBookActions.loanRenewTimeConfig.loanTotalTime),
+            });
 
-            await localCache.delete(`${identifier}-pageFlipTime`);
+            await localCache.delete(`${identifier}-pageChangedTime`);
           } catch (error) {}
           
         } else if(e.target.value === 'browsingExpired') {
@@ -242,8 +233,11 @@
           lendingStatus1.user_has_browsed = false;
         }
 
-        let lending = {...defaultLendingStatus, ...lendingStatus1};
-        iaBookActions.lendingStatus = lending;
+        // wait for a while
+        setTimeout(() => {
+          let lending = {...defaultLendingStatus, ...lendingStatus1};
+          iaBookActions.lendingStatus = lending;
+        }, 10);
       });
     });
 
@@ -292,6 +286,17 @@
         iaBookActions.bwbPurchaseUrl = bwbPurchaseUrl;
       })
     });
+
+    document.querySelector('.pageChangedEvent').addEventListener('click', () => {
+      // dispatch event to say book page has flipped
+      document.querySelector('ia-book-actions').dispatchEvent(
+        new CustomEvent('BookReader:userAction', {
+          detail: {},
+          bubbles: true,
+          composed: true,
+        })
+      );
+    })
 </script>
 
   <div>
@@ -302,6 +307,9 @@
             <td class="titleBar">
               <label><input type="checkbox" name="title" value="title" />Title Bar</label>
             </td>
+            <td>
+              <button class="pageChangedEvent">Page Change Event</button>
+            </td>
           </tr>
         </table>
     </fieldset>
@@ -311,7 +319,6 @@
         <table class="initial">
           <tr colspan='5'>
             <td class="errorEnable"><label><input type="checkbox" name="errorEnable" value="errorEnable" />Do you want to see error response?</label></td>
-            <td class="autoRenew"><label><input type="checkbox" name="autoRenew" value="autoRenew" />Do you want to auto-renew 1 hour</label></td>
           </tr>
           <tr>
             <td class="userState">

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.29-alpha5",
+  "version": "0.0.29-alpha50",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
@@ -11,18 +11,19 @@
   },
   "scripts": {
     "start": "web-dev-server",
-    "lint": "eslint --ext .js",
-    "format": "eslint --ext .js,",
+    "lint": "eslint --ext .js,.html . --ignore-path .gitignore && prettier \"**/*.js\" --check --ignore-path .gitignore",
+    "format": "eslint --ext .js,.html . --fix --ignore-path .gitignore && prettier \"**/*.js\" --write --ignore-path .gitignore",
     "test": "yarn run lint && yarn test:fast",
     "test:fast": "web-test-runner --coverage --playwright --browsers chromium firefox webkit",
     "test:watch": "web-test-runner --watch --playwright --browsers chromium firefox webkit"
   },
   "dependencies": {
     "@internetarchive/icon-info": "^1.2.6",
-    "@internetarchive/local-cache": "^0.2.0",
-    "@internetarchive/modal-manager": "^0.2.1",
+    "@internetarchive/local-cache": "^0.2.1",
+    "@internetarchive/modal-manager": "^0.2.8",
     "@internetarchive/shared-resize-observer": "^0.2.0",
-    "lit": "^2.2.1"
+    "@internetarchive/toast-manager": "0.1.0",
+    "lit": "^2.5.0"
   },
   "devDependencies": {
     "@open-wc/eslint-config": "^4.2.0",
@@ -54,6 +55,7 @@
   },
   "husky": {
     "hooks": {
+      "pre-commit": "lint-staged"
     }
   },
   "lint-staged": {

package/src/assets/data/lending-get-status-service.js

@@ -100,7 +100,7 @@ export const canBrowseAndBorrow = {
   // userid: "",
   bookUrl: '/details/practicalorganic00plim',
   daysLeftOnLoan: 0,
-  isAdmin: false,
+  isAdmin: true,
   isArchiveOrgLending: true,
   isAvailable: false,
   isAvailableForBrowsing: false,

package/src/assets/styles/collapsible-action-group.js

@@ -12,6 +12,7 @@ export default css`
   }
   .actiongroup {
     display: flex;
+    margin-right: 10px;
   }
   .action-buttons {
     display: inline-flex;
@@ -33,12 +34,12 @@ export default css`
   }
   .primary {
     background-color: ${whiteColor};
+    margin-right: 4px;
   }
   .primary,
   .secondary {
     position: relative;
     border-radius: 5px;
-    margin: 0 3px;
   }
   .primary .initial {
     border-radius: 4px 0 0 4px;

package/src/components/collapsible-action-group.js

@@ -9,6 +9,10 @@ import CollapsibleActionGroupStyle from '../assets/styles/collapsible-action-gro
 
 import { tabletContainerWidth } from '../core/config/constants.js';
 import { purchaseIcon } from '../assets/data/purchase.js';
+import {
+  analyticsCategories,
+  analyticsActions,
+} from '../core/config/analytics-event-and-category.js';
 import {
   dropdownOpened,
   dropdownClosed,
@@ -28,8 +32,7 @@ export class CollapsibleActionGroup extends ActionsHandler {
       dropdownArrow: { type: String },
       disabled: { type: Boolean },
       returnUrl: { type: String },
-      browseAgainNow: { type: Boolean },
-      autoRenewConfig: { type: Object },
+      renewNow: { type: Boolean },
     };
   }
 
@@ -49,8 +52,7 @@ export class CollapsibleActionGroup extends ActionsHandler {
     this.loaderIcon = 'https://archive.org/upload/images/tree/loading.gif';
     this.disabled = false;
     this.returnUrl = '';
-    this.browseAgainNow = false;
-    this.autoRenewConfig = {};
+    this.renewNow = false;
   }
 
   updated(changed) {
@@ -61,17 +63,28 @@ export class CollapsibleActionGroup extends ActionsHandler {
       this.resetActions();
     }
 
-    if (this.browseAgainNow === true) {
-      this.dispatchEvent(
-        new CustomEvent('autoBrowseBook', {
-          detail: {
-            event: { 'autoRenewed1Hour': 'browseBook' },
-          },
-        })
-      );
+    if (changed.has('renewNow') && this.renewNow === true) {
+      this.dispatchLoanRenewEvent();
     }
   }
 
+  // dispatch this event to loan renew handler
+  dispatchLoanRenewEvent() {
+    const { category, action } = {
+      category: analyticsCategories.browse,
+      action: analyticsActions.browseLoanRenew,
+    };
+
+    // listen in action-handler.js to execute ajax call on petabox.
+    this.dispatchEvent(
+      new CustomEvent('loanRenew', {
+        detail: {
+          event: { category, action },
+        },
+      })
+    );
+  }
+
   /**
    * merge primaryActions and secondaryActions into dropdown
    */

package/src/components/info-icon.js

@@ -43,21 +43,12 @@ export class InfoIcon extends LitElement {
         vertical-align: middle;
         --iconFillColor: white;
       }
-      .more-info-icon {
-        margin-left: 10px;
-      }
       .more-info-icon img {
         width: 24px;
         height: 24px;
         vertical-align: middle;
         background: white;
       }
-      .more-info-icon.mobile {
-        position: absolute;
-        top: 4px;
-        right: 55px;
-        margin-top: 15px;
-      }
       .hidden {
         display: none;
       }

package/src/components/text-group.js

@@ -26,7 +26,7 @@ export class TextGroup extends LitElement {
         display: inline-block;
       }
       .variable-texts {
-        margin-left: 10px;
+        margin-right: 10px;
         vertical-align: middle;
         font-size: 1.7rem;
       }

package/src/components/timer-countdown.js

@@ -1,48 +1,68 @@
 import { html, css, LitElement } from 'lit';
+import { sentryLogs } from '../core/config/sentry-events.js';
 
 export default class TimerCountdown extends LitElement {
   static get properties() {
     return {
-      time: { type: Number },
-      autoCheckAt: { type: Number },
-      resetTimerCountdown: { type: Boolean },
+      secondsLeftOnLoan: { type: Number }, // in seconds
+      loanRenewAtLast: { type: Number }, // in seconds
+      isDevBox: { type: Boolean },
     };
   }
 
   constructor() {
     super();
-    this.time = 60;
-    this.autoCheckAt = 0;
+
+    /**
+     * 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;
-    this.resetTimerCountdown = false;
   }
 
   disconnectedCallback() {
-    clearInterval(this.timerInterval)
-  }
-
-  firstUpdated() {
-    this.timerCountdown();
+    clearInterval(this.timerInterval);
   }
 
   updated(changed) {
-    if (changed.has('resetTimerCountdown')) {
+    if (changed.has('secondsLeftOnLoan') && this.secondsLeftOnLoan > 0) {
       clearInterval(this.timerInterval);
-      this.timerCountdown()
+      this.timerCountdown();
     }
   }
-  
+
   timerCountdown() {
+    // in-case of isDevBox, execute timer in each second instead of 60
+    const timerIntervalSeconds = this.isDevBox ? 1 : 60;
+
     this.timerInterval = setInterval(() => {
-      this.time -= 1;
+      // if this.isDevBox, just reduce seconds by 1 instead of 60 (1 min)
+      this.secondsLeftOnLoan -= timerIntervalSeconds;
+      const secondsLeft = Math.round(this.secondsLeftOnLoan);
 
-      // execute 50th minute check
-      if (this.time === this.autoCheckAt) {
+      // 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('autoRenewAttempt', {
+          new CustomEvent('IABookActions:loanRenew', {
             detail: {
-              remainingT: this.time,
-              bookPageChange: false,
+              hasPageChanged: false,
+              secondsLeft,
             },
             bubbles: true,
             composed: true,
@@ -50,76 +70,100 @@ export default class TimerCountdown extends LitElement {
         );
       }
 
-      if (this.time === 0) clearInterval(this.timerInterval);
-
-    }, 1000);
+      // clear interval
+      if (secondsLeft <= 1) {
+        clearInterval(this.timerInterval);
+        window?.Sentry?.captureMessage(sentryLogs.clearOneHourTimer);
+      }
+    }, timerIntervalSeconds * 1000);
   }
 
+  /**
+   * get remaining time with timeunit
+   *
+   * @memberof TimerCountdown
+   * @return string
+   */
+  get remainingTime() {
+    let unitOfTime = 'second';
+    let timeLeft = Math.round(this.secondsLeftOnLoan);
+
+    if (this.isDevBox) {
+      return `${timeLeft} seconds`;
+    }
+
+    if (timeLeft > 60) {
+      unitOfTime = 'minute';
+      timeLeft = Math.floor(timeLeft / 60);
+    }
+
+    return timeLeft !== 1
+      ? `${timeLeft} ${unitOfTime}s`
+      : `${timeLeft} ${unitOfTime}`;
+  }
 
   render() {
-    return html`<div id="countdown">
-    <div id="countdown-number">${this.time}</div>
-    <svg>
-      <circle r="18" cx="20" cy="20"></circle>
-    </svg>
-  </div>`
+    return html`
+      <svg
+        width="16"
+        height="16"
+        viewBox="0 0 100 100"
+        xmlns="http://www.w3.org/2000/svg"
+      >
+        <circle class="circle" cx="50" cy="50" r="50" />
+      </svg>
+      <span class="sr-only">${this.remainingTime}</span>
+      <span>${this.remainingTime}</span>
+    `;
   }
 
   static get styles() {
+    const white = css`var(--white, #fff)`;
+    const timerSecondsLeft = css`var(--secondsLeftOnLoan, 6000s)`; //
+    const timerStrokeLeft = css`var(--strokeLeftOnLoan, 315)`;
+
     return css`
       :host {
         right: 5px;
-        font-size: 14px;
-        position: absolute;
-      }
-      #countdown1 {
-        position: relative;
-        margin: auto;
-        margin-top: 100px;
-        height: 40px;
-        width: 40px;
-        text-align: center;
-      }
-      
-      #countdown-number {
-        color: white;
-        display: inline-block;
-        line-height: 40px;
-        margin-right: 12px;
-      }
-      
-      svg {
         position: absolute;
-        top: 0;
-        right: 0;
-        width: 40px;
-        height: 40px;
-        transform: rotateY(-180deg) rotateZ(-90deg);
-      }
-      
-      svg circle {
-        stroke-dasharray: 113px;
-        stroke-dashoffset: 0px;
-        stroke-linecap: round;
-        stroke-width: 3px;
-        stroke: white;
-        fill: none;
-        animation: countdown 60s linear infinite forwards;
       }
-      
-      @keyframes countdown {
-        from {
-          stroke-dashoffset: 0px;
+
+      @keyframes circletimer {
+        0% {
+          stroke-dashoffset: ${timerStrokeLeft};
+          stroke-dasharray: 315;
         }
-        to {
-          stroke-dashoffset: 113px;
+        100% {
+          stroke-dashoffset: 0;
+          stroke-dasharray: 315;
         }
       }
-      .hidden {
-        display: none;
+
+      svg {
+        background-color: ${white};
+        border-radius: 50px;
+        border: 2px solid ${white};
+        transform: rotateZ(-90deg);
       }
-      .visible {
-        display: inline-block;
+
+      svg .circle {
+        stroke: #000;
+        stroke-width: 100px;
+        fill: ${white};
+        stroke-dashoffset: 315;
+        stroke-dasharray: 0;
+        animation: ${timerSecondsLeft} circletimer linear;
+      }
+
+      .sr-only {
+        position: absolute;
+        left: -9999px;
+        width: 1px;
+        height: 1px;
+        margin: 0;
+        padding: 0;
+        border: none;
+        overflow: hidden;
       }
     `;
   }

package/src/core/config/analytics-event-and-category.js

@@ -13,6 +13,7 @@ export const analyticsCategories = {
 export const analyticsActions = {
   browse: 'Borrow-1Hour',
   browseAgain: 'Borrow-Again',
+  browseLoanRenew: 'Borrow-Loan-Renew',
   borrow: 'Borrow-14Days',
   waitlistJoin: 'JoinWaitlist',
   waitlistLeave: 'LeaveWaitlist',

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

@@ -0,0 +1,20 @@
+/**
+ * sentry logs/messages we send for different actions....
+ */
+export const sentryLogs = {
+  disconnectedCallback: 'IABookActions:disconnectedCallback',
+  bookHasRenewed:
+    'IABookActions:handleLoanAutoRenewed - book has renewed for next one hour',
+  browseHasExpired:
+    'IABookActions:browseHasExpired - one-hour loan has been expired',
+  bookWasExpired:
+    'IABookActions:setupLendingToolbarActions - book was expired at intial, no tokenPoller',
+  clearTokenPoller:
+    'IABookActions:startLoanTokenPoller - clearing token poller interval',
+  clearOneHourTimer:
+    'IABookActions:timerCountdown - one-hour timer interval cleared',
+  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 for 1 hour',
+      text: 'Borrow',
       className: 'primary',
       analyticsEvent: {
         category: this.analyticsCategories.preview,
@@ -48,7 +48,7 @@ export default class ActionsConfig {
   browseAgainConfig() {
     return {
       id: 'browseBookAgain',
-      text: 'Borrow again',
+      text: 'Borrow',
       className: 'primary',
       analyticsEvent: {
         category: this.analyticsCategories.browse,

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

@@ -1,4 +1,5 @@
 /* eslint-disable */
+import { sentryLogs } from '../../config/sentry-events.js';
 
 /**
  * Helper to call loan service
@@ -64,7 +65,9 @@ export default async function ActionsHandlerService(options) {
           option?.error(data);
         }
       });
-  } catch (err) {
-    window?.Sentry?.captureException(err);
+  } catch (error) {
+    window?.Sentry?.captureException(
+      `${sentryLogs.actionsHandlerService} - Error: ${error}`
+    );
   }
 }