@internetarchive/ia-book-actions 0.0.29-alpha1 → 0.0.29-alpha3

package/demo/index.html

@@ -87,7 +87,6 @@
 
   <script type="module">
     /* eslint-disable */
-
     import '../src/ia-book-actions.js';
     import {
       defaultLendingStatus,
@@ -127,33 +126,16 @@
     iaBookActions.lendingBarPostInit = lendingBarPostInit;
     iaBookActions.tokenDelay = 2000; // 2 seconds
     iaBookActions.returnUrl = 'https://openlibrary.org';
-    // iaBookActions.localCache = localCache;
-    iaBookActions.autoRenewTimeConfig = {
+    iaBookActions.localCache = localCache;
+    iaBookActions.autoRenewConfig = {
       totalTime: 60, // 60 second = 1 min
-      autoRenewCheckerAtLast: 10, // totalTime - 10th minute
-      autoRenewVisitedInLast: 15, // within last 15 second/minute 
+      autoCheckAt: 55, // totalTime - 10th minute
+      FlippedInLast: 15, // within last 15 second/minute 
     };
 
     let lendingStatus1 = iaBookActions.lendingStatus;
     let secondsLeftOnLoan = 60;
 
-    document.querySelector('#flip-page').addEventListener('click', async (e) => {
-      try {
-        // set pageFlipTime time in localStorage
-        await localCache.set({
-          key: `${identifier}-pageFlipTime`,
-          value: new Date(), // current time
-        })
-
-        // dispatch event to say book page has flipped
-        document.querySelector("ia-book-actions").dispatchEvent(
-          new CustomEvent("bookPageFlip", {
-            detail: { bookPageChange: true },
-          })
-        );
-      } catch (error) {}
-    });
-
     document.querySelectorAll('.titleBar input[type=checkbox]').forEach((item) => {
       item.addEventListener('click', (e) => {
         if (e.target.checked) {
@@ -244,6 +226,7 @@
             await localCache.set({
               key: `${identifier}-loanTime`,
               value: new Date(), // current time
+              ttl: parseInt(iaBookActions.autoRenewConfig.totalTime),
             })
 
             await localCache.delete(`${identifier}-pageFlipTime`);
@@ -330,9 +313,6 @@
             <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><button id="flip-page">Flip page</button></td>
-          </tr>
           <tr>
             <td class="userState">
               <label><input type="checkbox" name="user" value="isAdmin" />isAdmin</label>

package/package.json

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

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

@@ -29,6 +29,7 @@ export class CollapsibleActionGroup extends ActionsHandler {
       disabled: { type: Boolean },
       returnUrl: { type: String },
       browseAgainNow: { type: Boolean },
+      autoRenewConfig: { type: Object },
     };
   }
 
@@ -49,6 +50,7 @@ export class CollapsibleActionGroup extends ActionsHandler {
     this.disabled = false;
     this.returnUrl = '';
     this.browseAgainNow = false;
+    this.autoRenewConfig = {};
   }
 
   updated(changed) {

package/src/components/timer-countdown.js

@@ -4,7 +4,7 @@ export default class TimerCountdown extends LitElement {
   static get properties() {
     return {
       time: { type: Number },
-      autoRenewCheckerAtLast: { type: Number },
+      autoCheckAt: { type: Number },
       resetTimerCountdown: { type: Boolean },
     };
   }
@@ -12,7 +12,7 @@ export default class TimerCountdown extends LitElement {
   constructor() {
     super();
     this.time = 60;
-    this.autoRenewCheckerAtLast = 0;
+    this.autoCheckAt = 0;
     this.timerInterval = undefined;
     this.resetTimerCountdown = false;
   }
@@ -37,11 +37,12 @@ export default class TimerCountdown extends LitElement {
       this.time -= 1;
 
       // execute 50th minute check
-      if (this.time === this.autoRenewCheckerAtLast) {
+      if (this.time === this.autoCheckAt) {
         this.dispatchEvent(
-          new CustomEvent('autoReturnWarning', {
+          new CustomEvent('autoRenewAttempt', {
             detail: {
-              remainingT: this.time
+              remainingT: this.time,
+              bookPageChange: false,
             },
             bubbles: true,
             composed: true,

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

@@ -19,10 +19,10 @@ export default class ActionsHandler extends LitElement {
     this.identifier = '';
     this.ajaxTimeout = 6000;
     this.returnUrl = '';
+    this.autoRenewConfig = {};
 
     this.localCache = new LocalCache({
       namespace: '1HourLoanStorage',
-      defaultTTL: 1 * 30,  // 0.5 minute
     });
 
     this.bindEvents();
@@ -37,8 +37,6 @@ export default class ActionsHandler extends LitElement {
   }
 
   async bindEvents() {
-    // console.log(await this.localCache.get('loanTime'));
-
     this.addEventListener('browseBook', ({ detail }) => {
       this.handleBrowseIt();
       this.setConsecutiveLoanCounts();
@@ -54,9 +52,8 @@ export default class ActionsHandler extends LitElement {
     });
 
     this.addEventListener('autoBrowseBook', ({ detail }) => {
-      console.log('book has be renewed for you. thank you!!!');
+      console.log('auto renew handlerExecuted!!');
       this.handleAutoBrowseIt();
-      // this.setConsecutiveLoanCounts();
       const { category, action } = detail.event;
       this.sendEvent(category, action);
     });
@@ -320,6 +317,7 @@ export default class ActionsHandler extends LitElement {
       await this.localCache.set({
         key: `${this.identifier}-loanTime`,
         value: new Date(), // current time
+        ttl: parseInt(this.autoRenewConfig.totalTime),
       })
 
       await this.localCache.delete(`${this.identifier}-pageFlipTime`);

package/src/core/services/one-hour-auto-renew.js

@@ -1,97 +1,113 @@
-import { nothing } from 'lit';
-
 import ActionsHandlerService from './actions-handler/actions-handler-service.js';
-import * as Cookies from './doc-cookies.js';
 
 /**
- * This class is used to create loan token for borrowed books
+ * This class is used to determine if use is eligible for auto renew loan.
  *
  * ActionsHandlerService is a function being used to execute
  */
 export class OneHourAutoRenew {
-  constructor(pageClick, identifier, localCache, autoRenewTimeConfig) {
+  constructor(pageClick, identifier, localCache, autoRenewConfig, userHasBrowsed) {
     this.pageClick = pageClick;
     this.identifier = identifier;
     this.localCache = localCache;
-    this.autoRenewTimeConfig = autoRenewTimeConfig; // callback function to be called after loan token is created
-
-    this.autoReturnMessage = 'This book will be automatically returned in 15 seconds unless you turn a page.';
-    this.autoRenewMessage = 'This book has been renewed for another hour.';
-
+    this.autoRenewConfig = autoRenewConfig;
+    this.userHasBrowsed = userHasBrowsed;
 
+    // private props
     this.resultRes = {
-      toastTexts: '',
+      toastTexts: null,
       hideToast: true,
+      renewNow: false,
     };
 
-    return this.dd();
+    // messages for auto return machenism
+    this.autoRenewMessage = 'This book has been renewed for another hour.';
+    this.autoReturnMessage = 'This book has been auto-returned due to inactivity.';
+    this.autoReturnWarning = 'This book will be auto-returned in 10 minutes unless you turn a page.';
+
+    return this.handleBookAutoRenew();
   }
 
-  async dd() {
+  async handleBookAutoRenew() {
     try {
-      const currentDate = new Date();
-
-      const {
-        totalTime, // 60
-        autoRenewCheckerAtLast, // 50
-        autoRenewVisitedInLast, // 15
-      } = this.autoRenewTimeConfig;
-
-      const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
-      const lastPageFlipTime = await this.localCache.get(`${this.identifier}-pageFlipTime`);
-
-      const lastFlipTimeFrame = await this.changeTime(
-        currentDate,
-        autoRenewVisitedInLast,
-        'sub'
-      ); // 15 seconds
-
-      console.log(lastPageFlipTime, lastFlipTimeFrame)
-
       // if page is not flipped in last 15 minutes,
       // instantaly renew it if user viewed new page in last 10 minutes
-      if (this.pageClick === true) {
-        const lastTimeFrame = await this.changeTime(
-          loanTime,
-          totalTime - autoRenewCheckerAtLast,
-          'add'
-        ); // 50 seconds
+      if (this.pageClick) {
         console.log('page flipped!')
+        this.setPageFlippedTime();
+        return this.userFlippedBookPage(); // user clicked on page
+      } else {
+        console.log('auto checker!')
+        return this.autoCheckerTimer(); // auto checker at 50th minute
+      }
 
-        if (currentDate >= lastTimeFrame) {
-          console.log('1 YES NOW BORROW IT AGAIN NOW!');
-          this.toastTexts = this.autoRenewMessage;
-          this.hideToast = false;
-        }
+    } catch (error) {
+      console.log(error)
+    }
+  }
 
-        return nothing // early return
-      }
+  async setPageFlippedTime() {
+    // set pageFlipTime time in localStorage
+    await this.localCache.set({
+      key: `${this.identifier}-pageFlipTime`,
+      value: new Date(), // current time
+      ttl: parseInt(this.autoRenewConfig.totalTime),
+    })
+  }
 
-      console.log(lastPageFlipTime, lastFlipTimeFrame)
-      if (lastPageFlipTime === undefined) { // not viewed
-        console.log('2 DON\'T BORROW IT!');
-        this.resultRes.toastTexts = this.autoReturnMessage;
-        this.resultRes.hideToast = false;
-      } else if (lastPageFlipTime >= lastFlipTimeFrame) { // viewed in last time frame
-        console.log('3 YES BORROW IT AGAIN!');
-        this.resultRes.toastTexts = this.autoRenewMessage;
-        this.resultRes.hideToast = false;
-        this.toastTexts = this.autoRenewMessage;
-        // this.browseAgainNow = true;
-        this.hideToast = false;
-        // await this.browseHasRenew();
-      } else if (lastPageFlipTime <= lastFlipTimeFrame) { // viewed but not in last time frame
-        console.log('4 DON\'T BORROW IT!');
-        this.resultRes.toastTexts = this.autoReturnMessage;
-        this.resultRes.hideToast = false;
-      }
+  async userFlippedBookPage() {
+    const {
+      totalTime, // 60
+      autoCheckAt, // 50
+    } = this.autoRenewConfig;
+    const currentDate = new Date();
+    const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
+
+    const lastTimeFrame = await this.changeTime(
+      loanTime,
+      totalTime - autoCheckAt,
+      'add'
+    ); // 50 seconds
+
+    if (currentDate >= lastTimeFrame) {
+      console.log('1 YES NOW BORROW IT AGAIN NOW!');
+      this.resultRes.toastTexts = this.autoRenewMessage;
+      this.resultRes.browseAgainNow = true;
+      this.resultRes.hideToast = false;
+      this.resultRes.renewNow = true;
+    }
 
-      // console.log(this.resultRes)
-      return this.resultRes;
+    return this.resultRes;
+  }
 
-    } catch (error) {
-      console.log(error)
+  async autoCheckerTimer() {
+    const currentDate = new Date();
+    const { FlippedInLast } = this.autoRenewConfig;
+    const lastPageFlipTime = await this.localCache.get(`${this.identifier}-pageFlipTime`);
+
+    // last 15 min if used flipped a page.
+    const lastFlipTimeFrame = await this.changeTime(
+      currentDate,
+      FlippedInLast,
+      'sub'
+    ); // 15 seconds
+
+    if (lastPageFlipTime === undefined || lastPageFlipTime <= lastFlipTimeFrame) { // not viewed
+      console.log('2 not viewed, warning message!');
+      this.resultRes.toastTexts = this.autoReturnWarning;
+      this.resultRes.hideToast = false;
+    } else if (lastPageFlipTime >= lastFlipTimeFrame) { // viewed in last time frame
+      console.log('3 viewed, auto renew and message!');
+      this.resultRes.toastTexts = this.autoRenewMessage;
+      this.resultRes.browseAgainNow = true;
+      this.resultRes.hideToast = false;
+      this.resultRes.renewNow = true;
+
+      // delete pageFlipTime when book is auto renew at nth minute
+      await this.localCache.delete(`${this.identifier}-pageFlipTime`);
     }
+
+    return this.resultRes;
   }
 
   async changeTime(date, minutes, op) {
@@ -104,6 +120,7 @@ export class OneHourAutoRenew {
     return new Date(date.getTime() + minutes * 1000);
   }
 
+
   sendEvent(eventCategory, eventAction) {
     window?.archive_analytics?.send_event(
       eventCategory,

package/src/ia-book-actions.js

@@ -45,7 +45,7 @@ export default class IABookActions extends LitElement {
       remainingTime: { type: Number },
       resetTimerCountdown: { type: Boolean },
       localCache: { type: Object },
-      autoRenewTimeConfig: { type: Object },
+      autoRenewConfig: { type: Object },
       browseAgainNow: { type: Boolean },
     };
   }
@@ -67,10 +67,9 @@ export default class IABookActions extends LitElement {
     this.modal = undefined;
     this.tokenDelay = 120000; // 2 minutes
     this.localCache = new LocalCache({
-      namespace: '1HourLoanStorage',
-      defaultTTL: 1 * 60,  // 1 minute
+      namespace: '1HourLoanStorage'
     }),
-    this.autoRenewTimeConfig = {},
+    this.autoRenewConfig = {},
 
     // private props
     this.primaryActions = [];
@@ -82,41 +81,9 @@ export default class IABookActions extends LitElement {
     this.consecutiveLoanCounts = 1; // consecutive loan count
     this.browseAgainNow = false;
     this.browserTimer = undefined;
-
-    // show toast-message for auto return message
     this.hideToast = true;
-    this.autoReturnMessage = 'This book will be automatically returned in 15 seconds unless you turn a page.';
-    this.autoRenewMessage = 'This book has been renewed for another hour.';
-
-    // dispatched this event from timer-countdown 
-    this.addEventListener('autoReturnWarning', event => {
-      // const dd = this.autoRenew1 = new OneHourAutoRenew(
-      //   event.detail.bookPageChange,
-      //   this.identifier,
-      //   this.localCache,
-      //   this.autoRenewTimeConfig,
-      // );
-      // this.toastTexts = dd.resultRes.toastTexts;
-      // this.hideToast = dd.resultRes.hideToast;
-      this.handleBookAutoRenew(event);
-    });
-
-    // dispatched this event from bookreader side 
-    this.addEventListener('bookPageFlip', event => {
-      // console.log(e)
-      // const dd = this.autoRenew1 = new OneHourAutoRenew(
-      //   event.detail.bookPageChange,
-      //   this.identifier,
-      //   this.localCache,
-      //   this.autoRenewTimeConfig,
-      // );
-      // this.toastTexts = dd.resultRes.toastTexts;
-      // this.hideToast = dd.resultRes.hideToast;
-      // console.log(dd.resultRes)
-      this.handleBookAutoRenew(event);
-      // this.browseAgainNow = true;
-    });
 
+    this.bindAutoRenewEvent();
     this.resetTimerCountdown = false;
   }
 
@@ -148,6 +115,29 @@ export default class IABookActions extends LitElement {
     }
   }
 
+  bindAutoRenewEvent() {
+    // dispatched this event from timer-countdown 
+    this.addEventListener('autoRenewAttempt', async event => {
+      const isPageFlipped = event.detail.bookPageChange;
+
+      const dd = await new OneHourAutoRenew(
+        isPageFlipped,
+        this.identifier,
+        this.localCache,
+        this.autoRenewConfig,
+        this.lendingStatus.user_has_browsed && !this.lendingStatus.browsingExpired
+      );
+
+      this.toastTexts = dd.toastTexts;
+      this.hideToast = dd.hideToast;
+      this.browseAgainNow = dd.renewNow;
+      if (this.browseAgainNow) {
+        await this.browseHasRenew();
+      }
+      // this.handleBookAutoRenew(event);
+    });
+  }
+
   async browseHasExpired() {
     const currStatus = { ...this.lendingStatus, browsingExpired: true };
     this.lendingStatus = currStatus;
@@ -157,7 +147,7 @@ export default class IABookActions extends LitElement {
     await this.localCache.delete(`${this.identifier}-pageFlipTime`);
 
     // show message after browsed book is expired.
-    this.toastTexts = 'This book has been automatically returned due to inactivity.';
+    this.toastTexts = this.autoReturnMessage;
   }
 
   async browseHasRenew() {
@@ -174,14 +164,13 @@ export default class IABookActions extends LitElement {
 
   startBrowseTimer() {
     clearTimeout(this.browserTimer);
+
     const {
       browsingExpired,
       user_has_browsed,
       secondsLeftOnLoan,
     } = this.lendingStatus;
-    console.log(this.lendingStatus);
     if (!user_has_browsed || browsingExpired) {
-      console.log('attempted renew');
       return;
     }
 
@@ -192,83 +181,6 @@ export default class IABookActions extends LitElement {
     }, timeLeft);
   }
 
-  async handleBookAutoRenew(event) {
-    try {
-      const bookPageChange = event.detail.bookPageChange;
-      const currentDate = new Date();
-
-      const {
-        totalTime, // 60
-        autoRenewCheckerAtLast, // 50
-        autoRenewVisitedInLast, // 15
-      } = this.autoRenewTimeConfig;
-
-      const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
-      const lastPageFlipTime = await this.localCache.get(`${this.identifier}-pageFlipTime`);
-
-      const lastFlipTimeFrame = await this.changeTime(
-        currentDate,
-        autoRenewVisitedInLast,
-        'sub'
-      ); // 15 seconds
-
-      console.log(lastPageFlipTime, lastFlipTimeFrame)
-
-      // if page is not flipped in last 15 minutes,
-      // instantaly renew it if user viewed new page in last 10 minutes
-      if (bookPageChange === true) {
-        const lastTimeFrame = await this.changeTime(
-          loanTime,
-          totalTime - autoRenewCheckerAtLast,
-          'add'
-        ); // 50 seconds
-        console.log('page flipped!')
-
-        if (currentDate >= lastTimeFrame) {
-          console.log('1 YES NOW BORROW IT AGAIN NOW!');
-          this.toastTexts = this.autoRenewMessage;
-          this.browseAgainNow = true;
-          this.hideToast = false;
-          await this.browseHasRenew();
-        }
-
-        return nothing // early return
-      }
-
-      console.log(lastPageFlipTime, lastFlipTimeFrame)
-      if (lastPageFlipTime === undefined) { // not viewed
-        console.log('2 DON\'T BORROW IT!');
-        this.toastTexts = this.autoReturnMessage;
-        this.hideToast = false;
-      } else if (lastPageFlipTime >= lastFlipTimeFrame) { // viewed in last time frame
-        console.log('3 YES BORROW IT AGAIN!');
-        this.toastTexts = this.autoRenewMessage;
-        this.browseAgainNow = true;
-        this.hideToast = false;
-        await this.browseHasRenew();
-      } else if (lastPageFlipTime <= lastFlipTimeFrame) { // viewed but not in last time frame
-        console.log('4 DON\'T BORROW IT!');
-        this.toastTexts = this.autoReturnMessage;
-        this.hideToast = false;
-      } else {
-        this.browseAgainNow = true;
-        console.log('5 YES NOW BORROW IT AGAIN NOW!');
-      }
-    } catch (error) {
-      console.log(error)
-    }
-  }
-
-  async changeTime(date, minutes, op) {
-    if (date === undefined) return undefined;
-    
-    if (op === 'sub') {
-      return new Date(date.getTime() - minutes * 1000);
-    }
-
-    return new Date(date.getTime() + minutes * 1000);
-  }
-
   /** SharedObserver resize handler */
   handleResize(entry) {
     // if you are observing multiple targets,
@@ -379,7 +291,7 @@ export default class IABookActions extends LitElement {
     return this.borrowType === 'browsed'
       ? html`<timer-countdown
           time=${Number(this.remainingTime)}
-          .autoRenewCheckerAtLast=${this.autoRenewTimeConfig.autoRenewCheckerAtLast}
+          .autoCheckAt=${this.autoRenewConfig.autoCheckAt}
           ?resetTimerCountdown=${this.resetTimerCountdown}
         ></timer-countdown>`
       : nothing;
@@ -397,6 +309,7 @@ export default class IABookActions extends LitElement {
 
   get bookActionBar() {
     return html`
+      <button @click=${() => this.pageFlipEvent()}>Page Flip</button>
       <collapsible-action-group
         .userid=${this.userid}
         .identifier=${this.identifier}
@@ -407,6 +320,7 @@ export default class IABookActions extends LitElement {
         .borrowType=${this.borrowType}
         .returnUrl=${this.returnUrl}
         .autoRenew=${this.autoRenew}
+        .autoRenewConfig=${this.autoRenewConfig}
         ?hasAdminAccess=${this.hasAdminAccess}
         ?disabled=${this.disableActionGroup}
         ?browseAgainNow=${this.browseAgainNow}
@@ -419,6 +333,18 @@ export default class IABookActions extends LitElement {
     `;
   }
 
+  // will move this function to bookreader...
+  async pageFlipEvent() {
+    try {
+      // dispatch event to say book page has flipped
+      document.querySelector("ia-book-actions").dispatchEvent(
+        new CustomEvent("autoRenewAttempt", {
+          detail: { bookPageChange: true },
+        })
+      );
+    } catch (error) { console.log(error) }
+  }
+
   /**
    * enable access of borrowed/browsed books
    */