@internetarchive/ia-book-actions 0.0.7-1 → 0.0.7-2

package/README.md

@@ -1,69 +1,115 @@
-[![Build Status](https://travis-ci.com/internetarchive/iaux-your-webcomponent.svg?branch=master)](https://travis-ci.com/internetarchive/iaux-your-webcomponent) [![codecov](https://codecov.io/gh/internetarchive/iaux-your-webcomponent/branch/master/graph/badge.svg)](https://codecov.io/gh/internetarchive/iaux-your-webcomponent)
+# Component for lendable and embed items
 
-# Internet Archive Javascript WebComponent Template
+The book action button component build on LitElement with support for custom content and light DOM elements.
 
-This is a base template for creating Javascript WebComponents. It is based off of the [Open WebComponents generator](https://open-wc.org/docs/development/generator/) with some IA-specific customizations and some development niceities.
-
-## Usage
-
-1. Click the "Use this Template" button in GitHub to create a new repository based on this one.
-2. Clone your new repo and update the things below.
-
-### Things to update in your copy
-1. Remove this section
-2. Search for the strings `your-webcomponent` and `YourWebComponent` and those are most of the spots that need to be updated.
-3. `README.md` (this file). Update the readme in general, but also the badge URLs
-4. `package.json` Update the name and description
-5. Rename the `your-webcomponent.ts` and its associated `.test` file
-6. Update `.travis.yml` with the proper secure key. See the [Travis docs](https://blog.travis-ci.com/2014-03-13-slack-notifications/) for more information.
-
-## Local Demo with `web-dev-server`
+## Installation
 ```bash
-yarn start
+yarn install --save @internetarchive/ia-book-actions
 ```
-To run a local development server that serves the basic demo located in `demo/index.html`
 
-## Testing with Web Test Runner
-To run the suite of Web Test Runner tests, run
-```bash
-yarn run test
+## Usage of Book Actions
+```html
+<!-- index.html -->
+<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;
+  }
+</style>
+
+<ia-book-actions></ia-book-actions>
+
+<script type="module">
+    import '@internetarchive/ia-book-actions.js';
+    import { ModalConfig } from '@internetarchive/modal-manager';
+    import {
+      defaultLendingStatus,
+      canBrowseAndBorrow,
+    } from '../src/assets/data/lending-get-status-service.js';
+
+    let iaBookActions = document.querySelector('ia-book-actions');
+    iaBookActions.userid = '@neeraj-archive';
+    iaBookActions.identifier = 'naturalhistoryof00unse_4111';
+    iaBookActions.bookTitle = 'This is test title for any book';
+    iaBookActions.lendingStatus = {}; // lendinStatus in json
+    iaBookActions.bwbPurchaseUrl = 'https://bwb.com/produce/123';
+    iaBookActions.barType = ''; // title|action
+</script>
 ```
 
-To run the tests in watch mode (for &lt;abbr title=&#34;test driven development&#34;&gt;TDD&lt;/abbr&gt;, for example), run
+![Book Action Bar](./assets/ia-book-action-screen.png "Book Action Bar Demo")
 
-```bash
-yarn run test:watch
+## Usage of Book Title
+```html
+<!-- along with above properties, set barType to 'title' -->
+<script type="module">
+  iaBookActions.barType = 'title'; // title|action
+</script>
 ```
+![Book Title Bar](./assets/ia-book-title-screen.png "Book Title Bar Demo")
 
-## Linting with ESLint, Prettier, and Types
-To scan the project for linting errors, run
-```bash
-yarn run lint
-```
+### Config Options
 
-You can lint with ESLint and Prettier individually as well
-```bash
-yarn run lint:eslint
+All of the config options:
+
+```javascript
+let iaBookActions = document.querySelector('ia-book-actions');
+const modalConfig = new ModalConfig(); // to show info/error modal 
+
+// set defaultLendingStatus for unavailable (without borrowables) book
+iaBookActions.userid = '@jack';
+iaBookActions.identifier = 'jack-sparrow';
+iaBookActions.bookTitle = 'Contemporary Black biography. Volume 39 : profiles from the interContemporary Black biography. Volume 39';
+iaBookActions.lendingStatus = {active_borrows: 0, active_browses: 0}, // complete lendingStatus object
+iaBookActions.bwbPurchaseUrl = ''; // BWB purchase URl if any 
+iaBookActions.barType = '';
+iaBookActions.modalConfig = modalConfig;
 ```
+
+# Development
+
+## Prerequisite
 ```bash
-yarn run lint:prettier
+yarn install
 ```
 
-To automatically fix many linting errors, run
+## Start Development Server
 ```bash
-yarn run format
+yarn start
 ```
 
-You can format using ESLint and Prettier individually as well
+## Testing
 ```bash
-yarn run format:eslint
+yarn test
 ```
+
+## Linting
 ```bash
-yarn run format:prettier
+yarn lint
 ```
-
-## Tooling configs
-
-For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
-
-If you customize the configuration a lot, you can consider moving them to individual files.

package/demo/index.html

@@ -76,13 +76,9 @@
       overflow: hidden;
     }
   
-    modal-manager {
+    modal-manager[mode='closed'] {
       display: none;
     }
-  
-    modal-manager[mode='open'] {
-      display: block;
-    }
   </style>
 </head>
 

package/package.json

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

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

@@ -66,20 +66,23 @@ export class CollapsibleActionGroup extends ActionsHandler {
   /* emit custom event to fetch loan token */
   emitEnableBookAccess() {
     // send consecutiveLoanCounts for browsed books only.
-    // for borrowed books, we just send [Counts-1]
-    if (this.borrowType === 'browsed') {
+    if (this.borrowType === 'browsing') {
       this.consecutiveLoanCounts =
         localStorage.getItem('consecutive-loan-count') ?? 1;
     }
 
+    // event category and action for browsing book access
+    const eventCategory = `${this.borrowType}BookAccess`;
+    const eventAction = `${
+      this.borrowType === 'browsing' ? 'BrowseCounts-' : 'Counts-'
+    }${this.consecutiveLoanCounts}`;
+
     this.dispatchEvent(
       new CustomEvent('enableBookAccess', {
         detail: {
           event: {
-            category: `${this.borrowType}BookAccess`, // browsedBookAccess | borrowedBookAccess
-            action: `${
-              this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
-            }${this.consecutiveLoanCounts}`, // (BrowseCounts-1|Counts-X)
+            category: eventCategory, // brosingBookAccess | borrowingBookAccess
+            action: eventAction, // (BrowseCounts-N|Counts-N)
           },
           borrowType: this.borrowType,
         },

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

@@ -13,12 +13,10 @@ export default function ActionsHandlerService(options) {
     ...options,
   };
 
-  let baseHost = '';
-  if (window.location.pathname === '/demo/') {
-    baseHost = `/demo/`;
-  } else {
-    baseHost = `/services/loans/loan`;
-  }
+  let baseHost = '/services/loans/loan';
+  const location = window?.location;
+
+  if (location?.pathname === '/demo/') baseHost = `/demo/`;
 
   let formData = new FormData();
   formData.append('action', option.action);
@@ -29,18 +27,17 @@ export default function ActionsHandlerService(options) {
     body: formData,
   })
     .then(response => {
-      let shouldReturnError =
-        window.location.href.indexOf('?error=true') !== -1;
+      let shouldReturnError = location?.href?.indexOf('?error=true') !== -1;
       const tokenError = 'loan token not found. please try again later.';
       const borrowError =
         'This book is not available to borrow at this time. Please try again later.';
 
       // return error reponse if query param has ?error=true param...
       const erroneousActions = ['browse_book', 'borrow_book', 'create_token'];
-      if (shouldReturnError && erroneousActions.includes(option.action)) {
+      if (shouldReturnError && erroneousActions.includes(option?.action)) {
         return {
           success: false,
-          error: option.action === 'create_token' ? tokenError : borrowError,
+          error: option?.action === 'create_token' ? tokenError : borrowError,
         };
       }
 
@@ -58,7 +55,7 @@ export default function ActionsHandlerService(options) {
     })
     .then(data => {
       // `data` is the parsed version of the JSON returned from the above endpoint.
-      if (!data.error) {
+      if (!data?.error) {
         option?.success(data);
       } else {
         option?.error(data);

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

@@ -17,7 +17,7 @@ export default class ActionsHandler extends LitElement {
     this.ajaxTimeout = 6000;
     this.loanTokenPollingDelay =
       window.location.pathname === '/demo/' ? 2000 : 120000; // 120000 ms = 2 min
-    this.loanTokenInterval = null;
+    this.loanTokenInterval = undefined;
     this.bindEvents();
   }
 
@@ -105,8 +105,6 @@ export default class ActionsHandler extends LitElement {
 
       // fetch loan token for browsed/borrowed book and set an interval
       if (borrowType) {
-        console.log('token poll started...');
-
         this.loanTokenInterval = setInterval(() => {
           this.handleLoanTokenPoller();
         }, this.loanTokenPollingDelay);
@@ -122,7 +120,7 @@ export default class ActionsHandler extends LitElement {
 
   handleBrowseIt() {
     const context = 'browse_book';
-    this.ActionError(context);
+    this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
       action: context,
@@ -131,14 +129,14 @@ export default class ActionsHandler extends LitElement {
         this.handleReadItNow();
       },
       error: data => {
-        this.ActionError(context, data);
+        this.dispatchActionError(context, data);
       },
     });
   }
 
   handleReturnIt() {
     const context = 'return_loan';
-    this.ActionError(context);
+    this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
       action: context,
@@ -148,14 +146,14 @@ export default class ActionsHandler extends LitElement {
         URLHelper.goToUrl(`/details/${this.identifier}`, true);
       },
       error: data => {
-        this.ActionError(context, data);
+        this.dispatchActionError(context, data);
       },
     });
   }
 
   handleBorrowIt() {
     const context = 'borrow_book';
-    this.ActionError(context);
+    this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
       action: context,
@@ -164,14 +162,14 @@ export default class ActionsHandler extends LitElement {
         this.handleReadItNow();
       },
       error: data => {
-        this.ActionError(context, data);
+        this.dispatchActionError(context, data);
       },
     });
   }
 
   handleReserveIt() {
     const context = 'join_waitlist';
-    this.ActionError(context);
+    this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
       action: context,
@@ -180,14 +178,14 @@ export default class ActionsHandler extends LitElement {
         URLHelper.goToUrl(URLHelper.getRedirectUrl(), true);
       },
       error: data => {
-        this.ActionError(context, data);
+        this.dispatchActionError(context, data);
       },
     });
   }
 
   handleRemoveFromWaitingList() {
     const context = 'leave_waitlist';
-    this.ActionError(context);
+    this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
       action: context,
@@ -196,7 +194,7 @@ export default class ActionsHandler extends LitElement {
         URLHelper.goToUrl(URLHelper.getRedirectUrl(), true);
       },
       error: data => {
-        this.ActionError(context, data);
+        this.dispatchActionError(context, data);
       },
     });
   }
@@ -207,13 +205,13 @@ export default class ActionsHandler extends LitElement {
       identifier: this.identifier,
       action: context,
       error: data => {
-        this.ActionError(context, data);
+        this.dispatchActionError(context, data);
         clearInterval(this.loanTokenInterval); // stop token fetch api
       },
     });
   }
 
-  ActionError(context, data = {}) {
+  dispatchActionError(context, data = {}) {
     this.dispatchEvent(
       new CustomEvent('lendingActionError', {
         detail: { context, data },
@@ -221,6 +219,10 @@ export default class ActionsHandler extends LitElement {
     );
   }
 
+  dispatchToggleActionGroup() {
+    this.dispatchEvent(new CustomEvent('toggleActionGroup'));
+  }
+
   handleLoginOk() {
     /* eslint class-methods-use-this: "off" */
     const target = `/account/login?referer=${encodeURIComponent(

package/src/core/services/get-lending-actions.js

@@ -75,9 +75,9 @@ export default class GetLendingActions {
     const disableBorrow = lendingStatus.loanCount >= lendingStatus.maxLoans;
 
     let primaryTitleText = '';
-    let isBrowsed =
+    let isBrowsing =
       lendingStatus.user_has_browsed && !lendingStatus.browsingExpired;
-    if (isBrowsed) {
+    if (isBrowsing) {
       primaryTitleText = this.getBrowseCountdownTitle();
     } else {
       primaryTitleText = `Your loan of this book has ${lendingStatus.daysLeftOnLoan} days left.`;
@@ -96,7 +96,7 @@ export default class GetLendingActions {
         this.actionsConfig.adminAccessConfig(),
         this.actionsConfig.purchaseConfig(),
       ],
-      borrowType: isBrowsed ? 'browsed' : 'borrowed',
+      borrowType: isBrowsing ? 'browsing' : 'borrowing',
     };
   }
 

package/src/ia-book-actions.js

@@ -10,8 +10,6 @@ import './components/text-group.js';
 import './components/info-icon.js';
 
 import GetLendingActions from './core/services/get-lending-actions.js';
-import getRealTimeLendingStatus from './core/services/get-realtime-lending-status.js';
-
 import { mobileContainerWidth } from './core/config/constants.js';
 
 export default class IABookActions extends LitElement {
@@ -26,7 +24,6 @@ export default class IABookActions extends LitElement {
       barType: { type: String },
       sharedObserver: { attribute: false },
       disableActionGroup: { type: Boolean },
-      modalConfig: { type: Object },
     };
   }
 
@@ -46,8 +43,6 @@ export default class IABookActions extends LitElement {
     this.secondaryActions = [];
     this.lendingOptions = {};
     this.disableActionGroup = false;
-    this.modalConfig = {};
-    this.realtimeInternal = 0; // store intervalID
   }
 
   disconnectedCallback() {
@@ -60,25 +55,7 @@ export default class IABookActions extends LitElement {
       this.setupResizeObserver();
     }
 
-    if (!Object.keys(this.modalConfig).length) {
-      this.modalConfig = new ModalConfig();
-      this.modalConfig.headerColor = '#d9534f';
-    }
     this.setupLendingToolbarActions();
-
-    // fetch latest lending status after an internal
-    if (
-      this.lendingStatus.user_has_browsed ||
-      this.lendingStatus.user_has_borrowed
-    ) {
-      this.realtimeInternal = setInterval(() => {
-        const latestLendingStatus = getRealTimeLendingStatus(
-          'naturalhistoryof00unse_4'
-        );
-        console.log(latestLendingStatus);
-        if (latestLendingStatus) this.lendingStatus = latestLendingStatus;
-      }, 30000); // 60000 ms = 1 min
-    }
   }
 
   updated(changed) {
@@ -167,8 +144,8 @@ export default class IABookActions extends LitElement {
     });
 
     this.borrowType = actions.borrowType;
-    if (this.borrowType === 'browsed') {
-      // start timer for browsed.
+    if (this.borrowType === 'browsing') {
+      // start timer for browsing.
       // when browse is completed, we shows browse-again button
       this.startBrowseTimer();
     }
@@ -202,6 +179,7 @@ export default class IABookActions extends LitElement {
         ?hasAdminAccess=${this.hasAdminAccess}
         ?disabled=${this.disableActionGroup}
         @lendingActionError=${this.handleLendingActionError}
+        @toggleActionGroup=${this.handleToggleActionGroup}
       >
       </collapsible-action-group>
       ${this.textGroupTemplate} ${this.infoIconTemplate}
@@ -209,17 +187,32 @@ export default class IABookActions extends LitElement {
   }
 
   /*
-   * handle lending errors occure on different operation like
+   * custom event handler to toggle action group visibility
+   *
+   * @event IABookActions#toggleActionGroup
+   */
+  handleToggleActionGroup() {
+    this.disableActionGroup = !this.disableActionGroup;
+  }
+
+  /*
+   * handle lending errors occure during different operation like
    * browse book, borrow book, borrowed book token etc...
+   *
+   * @event IABookActions#lendingActionError
+   * @param {Object} event - The employee who is responsible for the project
+   * @param {string} event.detail.context - action when error occurred like 'browseBook', 'borrowBook'
+   * @param {string} event.detail.data.error - error message
    */
-  handleLendingActionError(e) {
+  handleLendingActionError(event) {
+    console.log(event?.detail?.data);
     // toggle activity loader
-    this.disableActionGroup = !this.disableActionGroup;
+    this.handleToggleActionGroup();
 
-    const context = e?.detail?.context;
-    const errorMsg = e?.detail?.data?.error;
+    const context = event?.detail?.context;
+    const errorMsg = event?.detail?.data?.error;
 
-    if (errorMsg) this.showErrorModal(context, errorMsg);
+    if (errorMsg) this.showErrorModal(errorMsg);
 
     // update action bar state if book is not available to browse or borrow.
     if (errorMsg && errorMsg.match(/not available to borrow/gm)) {
@@ -240,24 +233,22 @@ export default class IABookActions extends LitElement {
   }
 
   /* show error message if something went wrong */
-  async showErrorModal(context, errorMsg) {
-    // add modal-manager in DOM to show alert message
-    this.modal = document.createElement('modal-manager');
-    this.modal.id = 'action-bar-modal';
-    await document.body.appendChild(this.modal);
+  async showErrorModal(errorMsg) {
+    this.disableActionGroup = false;
 
-    // fallback if <modal-manager> is not found!
+    this.modal = document.querySelector('#action-bar-modal');
     if (!this.modal) {
-      alert(errorMsg);
-      return;
+      this.modal = document.createElement('modal-manager');
+      this.modal.id = 'action-bar-modal';
     }
-
-    this.disableActionGroup = false;
-    this.modalConfig.title = 'Lending error';
-    this.modalConfig.message = errorMsg;
+    await document.body.appendChild(this.modal);
 
     this.modal.showModal({
-      config: this.modalConfig,
+      config: new ModalConfig({
+        title: 'Lending error',
+        message: errorMsg,
+        headerColor: '#d9534f',
+      }),
     });
   }
 

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

@@ -87,7 +87,7 @@ describe('<collapsible-action-group>', () => {
 });
 
 describe('fetch loan token and localStorage for browsed/borrowsed book', () => {
-  beforeEach(() => {
+  afterEach(() => {
     const localStorageMock = {
       getItem: Sinon.spy(),
       setItem: Sinon.spy(),

package/src/core/services/get-realtime-lending-status.js

@@ -1,31 +0,0 @@
-/*
- * Helper function to fetch real-time lending status
- */
-export default function getRealTimeLendingStatus(identifier) {
-  let url = `https://ia-petabox-neeraj.archive.org/services/book/lending-info.php?identifier=${identifier}`;
-
-  if (window.location.pathname === '/demo/') {
-    url = ''; // change URL to prevent error on localhost
-  }
-
-  fetch(url)
-    .then(response => {
-      // return { response_code: '400', data: 'error happened' };
-      return response.json();
-    })
-    .then(response => {
-      console.log(response);
-      if (response?.response_code === 200) {
-        const lendingInfo = response?.body?.data?.lendingInfo;
-        let newLendingInfo = lendingInfo;
-        const newLendingStatus = lendingInfo?.lendingStatus;
-        newLendingInfo = { ...newLendingInfo, ...newLendingStatus };
-        newLendingInfo.lendingStatus = '';
-        return newLendingInfo;
-      }
-      return null;
-    })
-    .catch(response => {
-      return response;
-    });
-}