@internetarchive/ia-book-actions 1.4.1-alpha2 → 1.4.2

package/.claude/settings.local.json

@@ -0,0 +1,16 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(yarn outdated *)",
+      "Bash(gh pr *)",
+      "Bash(git log *)",
+      "mcp__plugin_atlassian_atlassian__getAccessibleAtlassianResources",
+      "Bash(npm view *)",
+      "mcp__plugin_atlassian_atlassian__searchJiraIssuesUsingJql",
+      "Bash(xargs -I {} basename {})",
+      "Bash(npm info *)",
+      "mcp__plugin_atlassian_atlassian__getJiraIssue",
+      "mcp__plugin_atlassian_atlassian__getJiraProjectIssueTypesMetadata"
+    ]
+  }
+}

package/.github/workflows/ci.yml

@@ -11,16 +11,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v3
+    - uses: actions/checkout@v4.1.1
+    - uses: actions/setup-node@v4.0.2
       with:
-        node-version: 16.x
+        node-version: 20.x
 
     - name: Install dependencies
       run: yarn install
 
-    # - name: Run tests
-    #   run: yarn run test
+    - name: Run tests
+      run: yarn run test
 
-    # - name: Upload reports
-    #   run: npx codecov
+    - uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

package/.github/workflows/pr-preview.yml

@@ -14,24 +14,47 @@ on:
 
 concurrency: preview-${{ github.ref }}
 
+env:
+  PREVIEW_BRANCH: gh-pages
 jobs:
   deploy-preview:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 20.x
+      - uses: actions/setup-node@v4
 
       - name: Install and Build
         run: |
           yarn install
           yarn prepare:ghpages
+
       # Reference: https://github.com/rossjrw/pr-preview-action
       - name: Deploy preview
         uses: rossjrw/pr-preview-action@v1
+        id: preview-step
         with:
           source-dir: ./ghpages/
           umbrella-dir: pr
+          preview-branch: ${{ env.PREVIEW_BRANCH }}
+          comment: false
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: steps.preview-step.outputs.deployment-action == 'deploy'
+        with:
+          header: pr-preview
+          message: |
+            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
+            :---:
+            | <p></p> :rocket: View preview at <br> ${{ steps.preview-step.outputs.preview-url }} <br><br>
+            | <h6>Built to branch [`${{ env.PREVIEW_BRANCH }}`](${{ github.server_url }}/${{ github.repository }}/tree/${{ env.PREVIEW_BRANCH }}) at ${{ steps.preview-step.outputs.action-start-time }}. <br> Preview will be ready when the [GitHub Pages deployment](${{ github.server_url }}/${{ github.repository }}/deployments) is complete. <br><br> </h6>
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: steps.preview-step.outputs.deployment-action == 'remove'
+        with:
+          header: pr-preview
+          message: |
+            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
+            :---:
+            Preview removed because the pull request was closed.
+            ${{ steps.preview-step.outputs.action-start-time }}

package/README.md

@@ -1,12 +1,21 @@
-# Component for lendable and embed items
 
-The book action button component build on LitElement with support for custom content and light DOM elements.
+![Build Status](https://github.com/internetarchive/iaux-book-actions/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/internetarchive/iaux-book-actions/branch/main/graph/badge.svg?token=ZOYRJ2BV9W)](https://codecov.io/gh/internetarchive/iaux-book-actions)
+
+# Internet Archive Book Lending Actions
+
+This WebComponent, built using the [IA Typescript WebComponent Template](https://github.com/internetarchive/iaux-typescript-wc-template), provides support for Bookreader actions for borrowable books on Internet Archive. It extends the [Open WebComponents generator](https://open-wc.org/docs/development/generator/) with Internet Archive-specific features and developer tools.
 
 ## Installation
 ```bash
 yarn install --save @internetarchive/ia-book-actions
 ```
 
+## Local Demo with `web-dev-server`
+```bash
+yarn start
+```
+To run a local development server that serves the basic demo located in `index.html`
+
 ## Usage of Book Actions
 ```html
 <!-- index.html -->

package/index.html

@@ -134,12 +134,12 @@
     iaBookActions.bwbPurchaseUrl = '';
     iaBookActions.modalConfig = modalConfig;
     iaBookActions.lendingBarPostInit = lendingBarPostInit;
-    iaBookActions.tokenDelay = 2; // 2 seconds
-    iaBookActions.timerExecutionSeconds = 2 // 4 seconds
+    iaBookActions.tokenDelay = 10; // seconds
+    iaBookActions.timerExecutionSeconds = 3 // seconds
     iaBookActions.returnUrl = '';
     iaBookActions.localCache = localCache;
 
-    let loanTotalTime2Min = { loanTotalTime: 60, loanRenewAtLast: 55, pageChangedInLast: 5 };
+    let loanTotalTime2Min = { loanTotalTime: 120, loanRenewAtLast: 110, pageChangedInLast: 30 };
     let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 240, pageChangedInLast: 60 };
     let loanTotalTime10Min = { loanTotalTime: 600, loanRenewAtLast: 480, pageChangedInLast: 120 };
     let loanTotalTime30Min = { loanTotalTime: 1800, loanRenewAtLast: 1500, pageChangedInLast: 600 };

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "1.4.1-alpha2",
   "description": "Bookreader actions for borrowable book",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/internetarchive/iaux-account-settings.git"
+  },
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
+  "version": "1.4.2",
   "main": "index.js",
   "module": "index.js",
   "publishConfig": {
@@ -15,28 +19,28 @@
     "prepare": "rimraf dist && husky install",
     "lint": "eslint --ext \"./src/*.js\",.html . --ignore-path .gitignore && prettier \"./src/*.js\" --check --ignore-path .gitignore",
     "format": "eslint --ext \"./src/*.js\",.html . --fix --ignore-path .gitignore && prettier \"./src/*.js\" --write --ignore-path .gitignore",
-    "test": "yarn run lint && yarn test:fast",
-    "test:fast": "web-test-runner --coverage --playwright --browsers chromium firefox webkit",
+    "test": "yarn run format && yarn run lint && yarn test:fast --coverage",
+    "test:fast": "web-test-runner",
     "test:watch": "web-test-runner --watch --playwright --browsers chromium firefox webkit",
     "deploy": "yarn run deploy:run -e $(git branch --show-current)",
     "deploy:run": "yarn run prepare:ghpages && touch ghpages/.nojekyll && yarn run deploy:gh",
     "deploy:gh": "gh-pages -t -d ghpages -m \"Build for $(git log --pretty=format:\"%h %an %ai %s\" -n1) [skip ci]\""
   },
   "dependencies": {
-    "@internetarchive/icon-info": "1.3.5",
+    "@internetarchive/icon-info": "^1.4.1",
     "@internetarchive/local-cache": "^0.2.1",
-    "@internetarchive/modal-manager": "2.0.0",
+    "@internetarchive/modal-manager": "^2.0.0",
     "@internetarchive/shared-resize-observer": "^0.2.0",
     "install-deps": "^1.1.0",
-    "lit": "^2.8.0"
+    "lit": "^2.8.0 || ^3.3.2"
   },
   "devDependencies": {
     "@open-wc/eslint-config": "^4.2.0",
-    "@open-wc/testing": "^2.0.0",
-    "@web/dev-server": "^0.1.1",
-    "@web/dev-server-esbuild": "^0.2.16",
-    "@web/test-runner": "^0.11.7",
-    "@web/test-runner-playwright": "^0.8.8",
+    "@open-wc/testing": "^4.0.0",
+    "@web/dev-server": "^0.4.6",
+    "@web/dev-server-esbuild": "^1.0.5",
+    "@web/test-runner": "^0.20.2",
+    "@web/test-runner-playwright": "^0.11.1",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-import": "^2.22.1",

package/src/ia-book-actions.js

@@ -120,7 +120,12 @@ export default class IABookActions extends LitElement {
      * @property {boolean} renewNow - key to determine if need to renew now
      * @property {number} secondsLeft - seconds left in active loan
      */
-    this.loanRenewResult = { texts: '', renewNow: false, secondsLeft: 0, renewType: '' };
+    this.loanRenewResult = {
+      texts: '',
+      renewNow: false,
+      secondsLeft: 0,
+      renewType: '',
+    };
   }
 
   disconnectedCallback() {
@@ -535,11 +540,8 @@ export default class IABookActions extends LitElement {
   async startBrowseTimer() {
     window?.IALendingIntervals?.clearBrowseExpireTimeout();
 
-    const {
-      browsingExpired,
-      user_has_browsed,
-      secondsLeftOnLoan,
-    } = this.lendingStatus;
+    const { browsingExpired, user_has_browsed, secondsLeftOnLoan } =
+      this.lendingStatus;
 
     if (!user_has_browsed || browsingExpired) {
       log('startBrowseTimer --- !user_has_browsed || browsingExpired', {

package/web-test-runner.config.mjs

@@ -3,7 +3,7 @@
 export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
   files: 'test/**/*.test.js',
   nodeResolve: true,
-  watch: true,
+  watch: false,
 
   /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
   esbuildTarget: 'auto',