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

package/demo/index.html

@@ -128,8 +128,8 @@
     iaBookActions.returnUrl = 'https://openlibrary.org';
     iaBookActions.localCache = localCache;
     iaBookActions.autoRenewConfig = {
-      totalTime: 20, // 60 second = 1 min
-      autoCheckAt: 15, // totalTime - 10th minute
+      totalTime: 60, // 60 second = 1 min
+      autoCheckAt: 55, // totalTime - 10th minute
       FlippedInLast: 15, // within last 15 second/minute 
     };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.29-alpha5",
+  "version": "0.0.29-alpha6",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
@@ -11,8 +11,8 @@
   },
   "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"
@@ -43,6 +43,12 @@
     "sinon": "^13.0.2"
   },
   "eslintConfig": {
+    "rules": {
+      "no-console": "off",
+      "no-unused-expressions": "off",
+      "class-methods-use-this": "off",
+      "lit-a11y/click-events-have-key-events": "off"
+    },
     "extends": [
       "@open-wc/eslint-config",
       "eslint-config-prettier"

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

@@ -28,8 +28,8 @@ export class CollapsibleActionGroup extends ActionsHandler {
       dropdownArrow: { type: String },
       disabled: { type: Boolean },
       returnUrl: { type: String },
+      localCache: { type: Function },
       browseAgainNow: { type: Boolean },
-      autoRenewConfig: { type: Object },
     };
   }
 
@@ -49,8 +49,8 @@ export class CollapsibleActionGroup extends ActionsHandler {
     this.loaderIcon = 'https://archive.org/upload/images/tree/loading.gif';
     this.disabled = false;
     this.returnUrl = '';
+    this.localCache = undefined;
     this.browseAgainNow = false;
-    this.autoRenewConfig = {};
   }
 
   updated(changed) {
@@ -61,11 +61,11 @@ export class CollapsibleActionGroup extends ActionsHandler {
       this.resetActions();
     }
 
-    if (this.browseAgainNow === true) {
+    if (changed.has('browseAgainNow') && this.browseAgainNow === true) {
       this.dispatchEvent(
         new CustomEvent('autoBrowseBook', {
           detail: {
-            event: { 'autoRenewed1Hour': 'browseBook' },
+            event: { autoRenewed1Hour: 'browseBook' },
           },
         })
       );

package/src/components/timer-countdown.js

@@ -11,33 +11,31 @@ export default class TimerCountdown extends LitElement {
 
   constructor() {
     super();
-    this.time = 60;
+    this.time = 0;
     this.autoCheckAt = 0;
     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('time') && this.time > 0) {
+      console.log('changed', this.time);
+
       clearInterval(this.timerInterval);
-      this.timerCountdown()
+      this.timerCountdown();
     }
   }
-  
+
   timerCountdown() {
     this.timerInterval = setInterval(() => {
       this.time -= 1;
 
       // execute 50th minute check
-      if (this.time === this.autoCheckAt) {
+      if (Math.round(this.time) === this.autoCheckAt) {
         this.dispatchEvent(
           new CustomEvent('autoRenewAttempt', {
             detail: {
@@ -51,18 +49,16 @@ export default class TimerCountdown extends LitElement {
       }
 
       if (this.time === 0) clearInterval(this.timerInterval);
-
     }, 1000);
   }
 
-
   render() {
     return html`<div id="countdown">
-    <div id="countdown-number">${this.time}</div>
-    <svg>
-      <circle r="18" cx="20" cy="20"></circle>
-    </svg>
-  </div>`
+      <div id="countdown-number">${Math.round(this.time)}</div>
+      <svg>
+        <circle r="18" cx="20" cy="20"></circle>
+      </svg>
+    </div>`;
   }
 
   static get styles() {
@@ -72,22 +68,13 @@ export default class TimerCountdown extends LitElement {
         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;
@@ -96,7 +83,7 @@ export default class TimerCountdown extends LitElement {
         height: 40px;
         transform: rotateY(-180deg) rotateZ(-90deg);
       }
-      
+
       svg circle {
         stroke-dasharray: 113px;
         stroke-dashoffset: 0px;
@@ -106,7 +93,7 @@ export default class TimerCountdown extends LitElement {
         fill: none;
         animation: countdown 60s linear infinite forwards;
       }
-      
+
       @keyframes countdown {
         from {
           stroke-dashoffset: 0px;

package/src/components/toast-message.js

@@ -22,8 +22,11 @@ export class ToastMessage extends LitElement {
           <span
             class="toast-message fade-in ${this.textClass}"
             title="Click/tap to close"
-            @click=${() => { this.dismisOnClick ? this.hideToast = true : nothing}}
-            >${this.texts}</span>
+            @click=${() => {
+              this.dismisOnClick ? (this.hideToast = true) : nothing;
+            }}
+            >${this.texts}</span
+          >
         `
       : nothing;
   }
@@ -34,14 +37,13 @@ export class ToastMessage extends LitElement {
     return css`
       :host {
         display: inline-block;
-        
       }
       .toast-message {
         z-index: 2;
         position: absolute;
         top: ${heightFromTop};
         font-size: 1.4rem;
-        font-family: "Helvetica Neue";
+        font-family: 'Helvetica Neue';
         color: #fff;
         left: 50%;
         background: #333;

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

@@ -1,6 +1,5 @@
 import { LitElement } from 'lit';
 
-import { LocalCache } from '@internetarchive/local-cache';
 import { URLHelper } from '../../config/url-helper.js';
 import ActionsHandlerService from './actions-handler-service.js';
 import * as Cookies from '../doc-cookies.js';
@@ -20,11 +19,6 @@ export default class ActionsHandler extends LitElement {
     this.ajaxTimeout = 6000;
     this.returnUrl = '';
     this.autoRenewConfig = {};
-
-    this.localCache = new LocalCache({
-      namespace: '1HourLoanStorage',
-    });
-
     this.bindEvents();
   }
 
@@ -112,7 +106,7 @@ export default class ActionsHandler extends LitElement {
   handleBrowseIt() {
     const action = 'browse_book';
     this.dispatchToggleActionGroup();
-    this.setBrowseTimeSession()
+    this.setBrowseTimeSession();
 
     ActionsHandlerService({
       action,
@@ -128,22 +122,20 @@ export default class ActionsHandler extends LitElement {
 
   handleAutoBrowseIt() {
     const action = 'renew_loan';
+    this.setBrowseTimeSession();
 
     ActionsHandlerService({
       action,
       identifier: this.identifier,
       success: () => {
-        console.log('success!');
+        // console.log('success!');
       },
       error: data => {
-        console.log(data);
-        console.log('error!');
         this.dispatchActionError(action, data);
       },
     });
   }
 
-  
   handleReturnIt() {
     const action = 'return_loan';
     this.dispatchToggleActionGroup();
@@ -294,17 +286,19 @@ export default class ActionsHandler extends LitElement {
     }
   }
 
-  async setBrowseTimeSession(_date = '') {
+  async setBrowseTimeSession() {
     try {
       // set a value
       await this.localCache.set({
         key: `${this.identifier}-loanTime`,
         value: new Date(), // current time
         ttl: Number(this.autoRenewConfig.totalTime),
-      })
+      });
 
       await this.localCache.delete(`${this.identifier}-pageFlipTime`);
-    } catch (error) {}
+    } catch (error) {
+      console.log(error);
+    }
   }
 
   deleteLoanCookies() {

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

@@ -1,13 +1,18 @@
-import ActionsHandlerService from './actions-handler/actions-handler-service.js';
+import { nothing } from 'lit';
 
 /**
  * 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, autoRenewConfig, userHasBrowsed) {
-    this.pageClick = pageClick;
+  constructor(
+    isPageClick,
+    identifier,
+    localCache,
+    autoRenewConfig,
+    userHasBrowsed
+  ) {
+    this.isPageClick = isPageClick;
     this.identifier = identifier;
     this.localCache = localCache;
     this.autoRenewConfig = autoRenewConfig;
@@ -15,14 +20,17 @@ export class OneHourAutoRenew {
 
     // 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.';
-    
+    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.';
+
     // private props
     this.resultRes = {
       toastTexts: this.autoReturnMessage,
       hideToast: true,
       renewNow: false,
+      browseAgainNow: false,
     };
 
     return this.handleBookAutoRenew();
@@ -30,20 +38,19 @@ export class OneHourAutoRenew {
 
   async handleBookAutoRenew() {
     try {
-      // if page is not flipped in last 15 minutes,
+      // if page is not clicked in last 15 minutes,
       // instantaly renew it if user viewed new page in last 10 minutes
-      if (this.pageClick) {
-        console.log('page flipped!')
-        this.setPageFlippedTime();
+      if (this.isPageClick) {
+        console.log('page flipped!!');
         return this.userFlippedBookPage(); // user clicked on page
-      } else {
-        console.log('auto checker!')
-        return this.autoCheckerTimer(); // auto checker at 50th minute
       }
-
+      console.log('auto checker!');
+      return this.autoCheckerTimer(); // auto checker at 50th minute
     } catch (error) {
-      console.log(error)
+      console.log(error);
     }
+
+    return nothing;
   }
 
   async setPageFlippedTime() {
@@ -52,7 +59,7 @@ export class OneHourAutoRenew {
       key: `${this.identifier}-pageFlipTime`,
       value: new Date(), // current time
       ttl: Number(this.autoRenewConfig.totalTime),
-    })
+    });
   }
 
   async userFlippedBookPage() {
@@ -60,53 +67,61 @@ export class OneHourAutoRenew {
       totalTime, // 60
       autoCheckAt, // 50
     } = this.autoRenewConfig;
-    const currentDate = new Date();
+    const currentTime = new Date();
     const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
 
-    const lastTimeFrame = await this.changeTime(
+    const lastTimeFrame = this.changeTime(
       loanTime,
       totalTime - autoCheckAt,
       'add'
     ); // 50 seconds
 
-    if (currentDate >= lastTimeFrame) {
+    if (currentTime >= 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;
+      this.resultRes.browseAgainNow = true;
 
       this.setNewBrowseTime();
+    } else {
+      console.log("can't autorenew this time!");
     }
 
+    this.setPageFlippedTime();
     return this.resultRes;
   }
 
   async autoCheckerTimer() {
-    const currentDate = new Date();
+    const currentTime = new Date();
     const { FlippedInLast } = this.autoRenewConfig;
-    const lastPageFlipTime = await this.localCache.get(`${this.identifier}-pageFlipTime`);
+    const lastPageFlipTime = await this.localCache.get(
+      `${this.identifier}-pageFlipTime`
+    );
 
     // last 15 min if used flipped a page.
-    const lastFlipTimeFrame = await this.changeTime(
-      currentDate,
+    const lastFlipTimeFrame = this.changeTime(
+      currentTime,
       FlippedInLast,
       'sub'
     ); // 15 seconds
 
-    if (lastPageFlipTime === undefined || lastPageFlipTime <= lastFlipTimeFrame) { // not viewed
+    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
+    } 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`);
       this.setNewBrowseTime();
     }
 
@@ -116,7 +131,7 @@ export class OneHourAutoRenew {
   async setNewBrowseTime() {
     try {
       // last 15 min if used flipped a page.
-      const expireDate = await this.changeTime(
+      const expireDate = this.changeTime(
         new Date(),
         this.autoRenewConfig.totalTime,
         'add'
@@ -127,15 +142,18 @@ export class OneHourAutoRenew {
         key: `${this.identifier}-loanTime`,
         value: expireDate, // expireDate time
         ttl: Number(this.autoRenewConfig.totalTime),
-      })
+      });
 
+      // delete pageFlipTime when book is auto renew at nth minute
       await this.localCache.delete(`${this.identifier}-pageFlipTime`);
-    } catch (error) {}
+    } catch (error) {
+      console.log(error);
+    }
   }
 
-  async changeTime(date, minutes, op) {
-    if (date === undefined) return undefined;
-    
+  changeTime(date, minutes, op) {
+    if (date === undefined) return nothing;
+
     if (op === 'sub') {
       return new Date(date.getTime() - minutes * 1000);
     }
@@ -143,7 +161,6 @@ 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

@@ -36,7 +36,6 @@ export default class IABookActions extends LitElement {
         attribute: false,
       },
       barType: { type: String },
-      autoRenew: { type: Boolean },
       sharedObserver: { attribute: false },
       disableActionGroup: { type: Boolean },
       modal: { Object },
@@ -61,16 +60,15 @@ export default class IABookActions extends LitElement {
     this.bwbPurchaseUrl = '';
     this.lendingBarPostInit = () => {};
     this.barType = 'action'; // 'title'|'action'
-    this.autoRenew = false;
     this.sharedObserver = undefined;
     this.disableActionGroup = false;
     this.modal = undefined;
     this.tokenDelay = 120000; // 2 minutes
     this.localCache = new LocalCache({
-      namespace: '1HourLoanStorage'
-    }),
-    this.autoRenewConfig = {},
-    this.autoRenewObj = undefined;
+      namespace: '1HourLoanStorage',
+    });
+    this.autoRenewConfig = {};
+    this.autoRenewRes = undefined;
 
     // private props
     this.primaryActions = [];
@@ -108,9 +106,6 @@ export default class IABookActions extends LitElement {
       this.update();
     }
 
-    if (changed.has('autoRenew')) {
-      this.resetTimerCountdown = true;
-    }
     if (changed.has('sharedObserver')) {
       this.disconnectResizeObserver();
       this.setupResizeObserver();
@@ -118,23 +113,27 @@ export default class IABookActions extends LitElement {
   }
 
   bindAutoRenewEvent() {
-    // dispatched this event from timer-countdown 
+    // dispatched this event from timer-countdown
     this.addEventListener('autoRenewAttempt', async event => {
-      const isPageFlipped = event.detail.bookPageChange;
+      const isPageClick = event.detail.bookPageChange;
 
-      this.autoRenewObj = await new OneHourAutoRenew(
-        isPageFlipped,
+      this.autoRenewRes = await new OneHourAutoRenew(
+        isPageClick,
         this.identifier,
         this.localCache,
         this.autoRenewConfig,
-        this.lendingStatus.user_has_browsed && !this.lendingStatus.browsingExpired
+        this.lendingStatus.user_has_browsed &&
+          !this.lendingStatus.browsingExpired
       );
+      console.log(this.autoRenewRes);
+
+      this.toastTexts = this.autoRenewRes.toastTexts;
+      this.hideToast = this.autoRenewRes.hideToast;
+      this.browseAgainNow = this.autoRenewRes.browseAgainNow;
 
-      this.toastTexts = this.autoRenewObj.toastTexts;
-      this.hideToast = this.autoRenewObj.hideToast;
-      this.browseAgainNow = this.autoRenewObj.renewNow;
       if (this.browseAgainNow) {
         await this.browseHasRenew();
+        // this.resetTimerCountdown = true;
       }
     });
   }
@@ -154,15 +153,16 @@ export default class IABookActions extends LitElement {
 
   async browseHasRenew() {
     const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
-    const secondsLeft =(loanTime - new Date()) / 1000; // different in seconds
+    const secondsLeft = (loanTime - new Date()) / 1000; // different in seconds
 
     const currStatus = {
       ...this.lendingStatus,
       user_has_browsed: true,
       browsingExpired: false,
-      secondsLeftOnLoan: Math.abs(Math.round(secondsLeft)),
+      secondsLeftOnLoan: secondsLeft,
     };
     this.lendingStatus = currStatus;
+    // this.performUpdate()
 
     this.startBrowseTimer();
   }
@@ -293,6 +293,7 @@ export default class IABookActions extends LitElement {
   }
 
   get timerCountdownTemplate() {
+    // console.log(this.borrowType, this.remainingTime, this.autoRenewConfig.autoCheckAt, this.resetTimerCountdown);
     return this.borrowType === 'browsed'
       ? html`<timer-countdown
           time=${Number(this.remainingTime)}
@@ -306,7 +307,7 @@ export default class IABookActions extends LitElement {
     return html`
       <toast-message
         .texts=${this.toastTexts}
-        ?dismisOnClick=${true}
+        ?dismisOnClick=${Boolean(true)}
         ?hideToast=${this.hideToast}
       ></toast-message>
     `;
@@ -314,7 +315,7 @@ export default class IABookActions extends LitElement {
 
   get bookActionBar() {
     return html`
-      <button @click=${() => this.pageFlipEvent()}>Page Flip</button>
+      <button @click=${() => this.pageFlipEvent}>Page Flip</button>
       <collapsible-action-group
         .userid=${this.userid}
         .identifier=${this.identifier}
@@ -324,7 +325,7 @@ export default class IABookActions extends LitElement {
         .width=${this.width}
         .borrowType=${this.borrowType}
         .returnUrl=${this.returnUrl}
-        .autoRenew=${this.autoRenew}
+        .localCache=${this.localCache}
         .autoRenewConfig=${this.autoRenewConfig}
         ?hasAdminAccess=${this.hasAdminAccess}
         ?disabled=${this.disableActionGroup}
@@ -339,15 +340,13 @@ 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) }
+  pageFlipEvent() {
+    // dispatch event to say book page has flipped
+    document.querySelector('ia-book-actions').dispatchEvent(
+      new CustomEvent('autoRenewAttempt', {
+        detail: { bookPageChange: true },
+      })
+    );
   }
 
   /**
@@ -516,7 +515,7 @@ export default class IABookActions extends LitElement {
       }
 
       toast-message {
-        --messageHeightFromTop: 18%;
+        --messageHeightFromTop: 14.5%;
       }
     `;
   }

package/src/assets/styles/timer-countdown.js

@@ -1,58 +0,0 @@
-import { css } from 'lit';
-
-export default timerCountDownStyle = 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;
-    }
-    to {
-      stroke-dashoffset: 113px;
-    }
-  }
-  .hidden {
-    display: none;
-  }
-  .visible {
-    display: inline-block;
-  }
-`;