@internetarchive/ia-book-actions 0.0.29-alpha9 → 0.1.0

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,18 @@
     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: 60, // 60 second = 1 min
-      autoCheckAt: 55, // totalTime - 10th minute
-      FlippedInLast: 15, // within last 15 second/minute 
-    };
+
+    let loanTotalTime2Min = { loanTotalTime: 20, loanRenewAtLast: 15, pageChangedInLast: 15 };
+    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 180, pageChangedInLast: 15 };
+    let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
+
+    iaBookActions.loanRenewTimeConfig = loanTotalTime2Min;
 
     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 +150,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 +215,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 +231,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 +284,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 +305,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 +317,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/demo/with-bookreader.html

@@ -0,0 +1,146 @@
+<!doctype html>
+<html lang="en-GB">
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
+  <style>
+    html {
+      font-size: 10px;
+      /* This is to match petabox's base font size */
+    }
+    body {
+      margin: 0;
+      text-align: center;
+      font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+    }
+    #demo {
+      height: 50px;
+    }
+    ia-book-actions {
+      --white: #fff;
+      --black: #000;
+      --primaryBGColor: var(--black);
+      --secondaryBGColor: #222;
+      --tertiaryBGColor: #333;
+      --primaryTextColor:  var(--white);
+      --primaryCTAFill: #194880;
+      --primaryCTABorder: #c5d1df;
+      --secondaryCTAFill: #333;
+      --secondaryCTABorder: #999;
+      --secondaryCTAFillRGB: 51, 51, 51;
+      --primaryErrorCTAFill: #e51c26;
+      --primaryErrorCTABorder: #f8c6c8;
+      --primaryCTAFillRGB: 25, 72, 128;
+      --primaryErrorCTAFillRGB: 229, 28, 38;
+      --primaryDisableCTAFill: #767676;
+    }
+
+    fieldset {
+      width: fit-content;
+      margin-top: 50px;
+    }
+    fieldset legend {
+      text-align: left;
+      font-size: 12px;
+    }
+    td {
+      color: white;
+      font-size: 14px;
+      border-radius: 5%;
+      display: table-cell;
+      text-align: initial;
+      margin: 5px 0;
+      width: max-content;
+      display: block;
+    }
+    label {
+      padding: 10px;
+      display: block;
+      cursor: pointer;
+      margin: 2px;
+      background: #4e545a;
+      border-radius: 10px;
+    }
+    input[type="radio"], input[type="checkbox"] {
+      margin-top: 0;
+      vertical-align: middle;
+    }
+
+    .initial td {
+      float: left;
+      margin: 2px;
+    }
+
+    body.modal-manager-open {
+      overflow: hidden;
+    }
+  
+    modal-manager[mode='closed'] {
+      display: none;
+    }
+  </style>
+</head>
+
+<body>
+  <ia-bookreader class="focus-on-child-only" signedin="" fullscreen="">
+    <div slot="header">
+      <ia-book-actions></ia-book-actions>
+    </div>
+    <div slot="main">
+      <div id="BookReader"></div>
+    </div>
+  </ia-bookreader>
+
+
+  <script type="module">
+    /* eslint-disable */
+    import '@internetarchive/bookreader';
+    import '@internetarchive/bookreader/BookReader/jquery-1.10.1.js';
+    import '@internetarchive/bookreader/BookReader/BookReader.js';
+    import '../src/ia-book-actions.js';
+    import {
+      defaultLendingStatus,
+      canBrowseAndBorrow,
+    } from '../src/assets/data/lending-get-status-service.js';
+    import { ModalConfig } from '@internetarchive/modal-manager';
+
+    const userid = '@neeraj-archive';
+    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';
+
+    let lendingBarPostInit = function lendingBarPostInit() {
+      setTimeout(function() {
+        console.log('executed', 'br.init()');
+      }, 100);
+    }
+
+    // set defaultLendingStatus for unavailable (without borrowables) book
+    iaBookActions.userid = userid;
+    iaBookActions.identifier = identifier;
+    iaBookActions.bookTitle = 'Contemporary Black biography. Volume 39 : profiles from the interContemporary Black biography. Volume 39';
+    iaBookActions.lendingStatus = canBrowseAndBorrow;
+    iaBookActions.bwbPurchaseUrl = '';
+    iaBookActions.modalConfig = modalConfig;
+    iaBookActions.lendingBarPostInit = lendingBarPostInit;
+    iaBookActions.tokenDelay = 2000; // 2 seconds
+    iaBookActions.returnUrl = 'https://openlibrary.org';
+
+    let lendingStatus1 = iaBookActions.lendingStatus;
+
+    const manifest = await fetch('https://ia801302.us.archive.org/BookReader/BookReaderJSIA.php?id=goody&itemPath=/29/items/goody&server=ia801302.us.archive.org&format=jsonp&subPrefix=goody&requestUri=/details/goody/mode/1up%3Fview%3Dtheater%26ui%3Dembed%26wrapper%3Dfalse');
+
+    console.log('manifest ****', manifest).then(res => res.json());
+  </script>
+
+  </div>
+</body>
+</html>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.29-alpha9",
+  "version": "0.1.0",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
@@ -19,10 +19,11 @@
   },
   "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",
@@ -43,12 +44,6 @@
     "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"
@@ -60,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 },
-      localCache: { type: Function },
-      browseAgainNow: { type: Boolean },
+      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.localCache = undefined;
-    this.browseAgainNow = false;
+    this.renewNow = false;
   }
 
   updated(changed) {
@@ -61,17 +63,28 @@ export class CollapsibleActionGroup extends ActionsHandler {
       this.resetActions();
     }
 
-    if (changed.has('browseAgainNow') && 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;
       }