@internetarchive/bookreader 5.0.0-63 → 5.0.0-64

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 5.0.0-64
+- Dev: update dependencies @renovate
+- Dev: update build step @cdrini
+- Fix: Search inside option for {{{/}}} + http support @cdrini
+
 # 5.0.0-63
 Fix: Don't limit autoFit zoom to real world size @cdrini
 Dev: Update test deps @cdrini

package/babel.config.js

@@ -11,9 +11,10 @@ module.exports = {
     ]
   ],
   plugins: [
-    ["@babel/plugin-proposal-decorators", {decoratorsBeforeExport: true}],
-    ["@babel/plugin-proposal-class-properties", {loose: true}],
-    ["@babel/plugin-proposal-private-property-in-object", { loose: true }],
-    ["@babel/plugin-proposal-private-methods", { loose: true }],
+    ["@babel/plugin-proposal-decorators", {
+      version: "2018-09",
+      decoratorsBeforeExport: true
+    }],
+    ["@babel/plugin-proposal-class-properties"],
   ]
 };

package/netlify.toml

@@ -1,3 +1,7 @@
+[build.environment]
+  # Keep in sync with CI in .github/workflows/node.js.yml
+  NODE_VERSION = "16"
+
 [[headers]]
   # Define which paths this specific [[headers]] block will cover.
   for = "/BookReader/*"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-63",
+  "version": "5.0.0-64",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",
@@ -41,19 +41,19 @@
     "lit": "^2.5.0"
   },
   "devDependencies": {
-    "@babel/core": "7.17.9",
+    "@babel/core": "7.22.5",
     "@babel/eslint-parser": "7.21.8",
-    "@babel/plugin-proposal-class-properties": "7.16.7",
-    "@babel/plugin-proposal-decorators": "7.17.9",
-    "@babel/preset-env": "7.16.11",
-    "@open-wc/testing-helpers": "^2.2.1",
+    "@babel/plugin-proposal-class-properties": "7.18.6",
+    "@babel/plugin-proposal-decorators": "7.22.5",
+    "@babel/preset-env": "7.22.5",
+    "@open-wc/testing-helpers": "^2.3.0",
     "@types/jest": "29.5.2",
     "@webcomponents/webcomponentsjs": "^2.6.0",
-    "babel-loader": "8.2.5",
+    "babel-loader": "9.1.2",
     "codecov": "^3.8.3",
     "concurrently": "7.4.0",
-    "core-js": "3.22.3",
-    "cpx2": "4.2.0",
+    "core-js": "3.30.2",
+    "cpx2": "4.2.3",
     "eslint": "^7.32.0",
     "eslint-plugin-no-jquery": "^2.7.0",
     "eslint-plugin-testcafe": "^0.2.1",
@@ -70,15 +70,15 @@
     "jquery.mmenu": "5.6.5",
     "live-server": "1.2.2",
     "node-fetch": "3.2.10",
-    "regenerator-runtime": "0.13.9",
-    "sass": "1.52.1",
+    "regenerator-runtime": "0.13.11",
+    "sass": "1.63.3",
     "sinon": "15.1.0",
     "soundmanager2": "2.97.20170602",
-    "svgo": "2.8.0",
+    "svgo": "3.0.2",
     "testcafe": "2.6.2",
     "testcafe-browser-provider-browserstack": "^1.13.2-alpha.1",
-    "webpack": "5.51.1",
-    "webpack-cli": "4.9.2"
+    "webpack": "5.86.0",
+    "webpack-cli": "5.1.4"
   },
   "jest": {
     "testEnvironment": "jsdom",
@@ -121,7 +121,7 @@
     "DOCS:update:test-deps": "If CI succeeds, these should be good to update",
     "update:test-deps": "npm i @babel/eslint-parser@latest @open-wc/testing-helpers@latest @types/jest@latest codecov@latest eslint@7 eslint-plugin-testcafe@latest jest@latest sinon@latest testcafe@latest",
     "DOCS:update:build-deps": "These can cause strange changes, so do an npm run build + check file size (git diff --stat), and check the site is as expected",
-    "update:build-deps": "npm i @babel/core@latest @babel/preset-env@latest babel-loader@latest core-js@latest regenerator-runtime@latest sass@latest svgo@latest webpack@latest webpack-cli@latest",
+    "update:build-deps": "npm i @babel/core@latest @babel/preset-env@latest @babel/plugin-proposal-class-properties@latest @babel/plugin-proposal-decorators@latest babel-loader@latest core-js@latest regenerator-runtime@latest sass@latest svgo@latest webpack@latest webpack-cli@latest",
     "codecov": "npx codecov"
   }
 }

package/src/BookNavigator/search/search-results.js

@@ -1,5 +1,4 @@
 /* eslint-disable class-methods-use-this */
-import { escapeHTML } from '../../BookReader/utils.js';
 import { unsafeHTML } from 'lit/directives/unsafe-html.js';
 import { css, html, LitElement, nothing } from 'lit';
 import '@internetarchive/ia-activity-indicator/ia-activity-indicator';
@@ -146,12 +145,7 @@ export class IABookSearchResults extends LitElement {
               ${match.cover ? html`<img src="${match.cover}" />` : nothing}
               <h4>${match.title || nothing}</h4>
               <p class="page-num">Page ${match.displayPageNumber}</p>
-              <p>
-                ${
-                  // [^] matches any character, including line breaks
-                  unsafeHTML(escapeHTML(match.text).replace(/{{{([^]+?)}}}/g, '<mark>$1</mark>'))
-                }
-              </p>
+              <p>${unsafeHTML(match.html)}</p>
             </li>
           `)}
       </ul>

package/src/BookReader/utils.js

@@ -278,3 +278,13 @@ export function promisifyEvent(target, eventType) {
     target.addEventListener(eventType, resolver);
   });
 }
+
+/**
+ * Escapes regex special characters in a string. Allows for safe usage in regexes.
+ * Src: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions
+ * @param {string} string
+ * @returns {string}
+ */
+export function escapeRegExp(string) {
+  return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+}

package/src/css/_BRnav.scss

@@ -77,8 +77,8 @@
 }
 
 @keyframes fadeUp {
-  from { opacity: 0; transform: translateY(10px); }
-  to { opacity: 1; transform: translateY(0); }
+  from { opacity: 0; translate: 0 10px; }
+  to { opacity: 1; translate: 0 0; }
 }
 
 .BRfooter {

package/src/css/_BRsearch.scss

@@ -1,26 +1,45 @@
+@mixin ellipsis-lines($lines: 4) {
+  display: -webkit-box;
+  -webkit-line-clamp: $lines;
+  -webkit-box-orient: vertical;
+  overflow: hidden;
+}
+
 %timeline-tooltip {
   display: none;
   position: absolute;
   bottom: calc(100% + 5px);
   left: 50%;
   transform: translateX(-50%);
-  width: 230px;
+  width: 350px;
+  max-width: 100vw;
   padding: 12px 14px;
+  padding-bottom: 10px;
   color: $tooltipText;
-  font-weight: bold;
   background: $tooltipBG;
   box-shadow: 0 2px 4px rgba(0, 0, 0, .5);
+  border-radius: 4px;
+  animation: fadeUp 0.2s;
+
+  // Disable text selection
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  -o-user-select: none;
+  user-select: none;
+
+  // Create a triangle under the tooltip using clip-path
+  // This makes it possible to move the mouse onto the tooltip
   &:after {
-    display: none;
     position: absolute;
-    top: 100%;
+    content: "";
+    bottom: -9px;
     left: 50%;
+    margin-left: -1px;
     transform: translateX(-50%);
-    content: "";
-    border: 7px solid transparent;
-    border-width: 7px 4px;
-    border-bottom: none;
-    border-top-color: $tooltipBG;
+    width: 30px;
+    height: 10px;
+    clip-path: polygon(0 0, 100% 0, 50% 100%);
   }
 }
 
@@ -105,7 +124,16 @@
   }
   .BRquery {
     @extend %timeline-tooltip;
-    b {
+    main {
+      @include ellipsis-lines(4);
+      margin-bottom: 6px;
+    }
+    footer {
+      text-align: center;
+      font-weight: bold;
+      font-size: 0.9em;
+    }
+    mark {
       color: $searchResultText;
       font-weight: bold;
       background-color: $searchResultBG;

package/src/plugins/search/plugin.search.js

@@ -27,6 +27,7 @@
 import { poll } from '../../BookReader/utils.js';
 import { renderBoxesInPageContainerLayer } from '../../BookReader/PageContainer.js';
 import SearchView from './view.js';
+import { marshallSearchResults } from './utils.js';
 /** @typedef {import('../../BookReader/PageContainer').PageContainer} PageContainer */
 /** @typedef {import('../../BookReader/BookModel').PageIndex} PageIndex */
 /** @typedef {import('../../BookReader/BookModel').LeafNum} LeafNum */
@@ -38,7 +39,10 @@ jQuery.extend(BookReader.defaultOptions, {
   subPrefix: '',
   bookPath: '',
   enableSearch: true,
+  searchInsideProtocol: 'https',
   searchInsideUrl: '/fulltext/inside.php',
+  searchInsidePreTag: '{{{',
+  searchInsidePostTag: '}}}',
   initialSearchTerm: null,
 });
 
@@ -170,7 +174,7 @@ BookReader.prototype.search = async function(term = '', overrides = {}) {
 
   // Remove the port and userdir
   const serverPath = this.server.replace(/:.+/, '');
-  const baseUrl = `https://${serverPath}${this.searchInsideUrl}?`;
+  const baseUrl = `${this.options.searchInsideProtocol}://${serverPath}${this.searchInsideUrl}?`;
 
   // Remove subPrefix from end of path
   let path = this.bookPath;
@@ -184,6 +188,8 @@ BookReader.prototype.search = async function(term = '', overrides = {}) {
     doc: this.subPrefix,
     path,
     q: term,
+    pre_tag: this.options.searchInsidePreTag,
+    post_tag: this.options.searchInsidePostTag,
   };
 
   // NOTE that the API does not expect / (slashes) to be encoded. (%2F) won't work
@@ -261,6 +267,7 @@ BookReader.prototype.cancelSearchRequest = function () {
  * @typedef {object} SearchInsideMatch
  * @property {number} matchIndex This is a fake field! Not part of the API response. It is added by the JS.
  * @property {string} displayPageNumber (fake field) The page number as it should be displayed in the UI.
+ * @property {string} html (computed field) The html-escaped raw html to display in the UI.
  * @property {string} text
  * @property {Array<{ page: number, boxes: SearchInsideMatchBox[] }>} par
  */
@@ -272,25 +279,6 @@ BookReader.prototype.cancelSearchRequest = function () {
  * @property {boolean} indexed
  */
 
-/**
- * Attach some fields to search inside results
- * @param {SearchInsideResults} results
- * @param {(pageNum: LeafNum) => PageNumString} displayPageNumberFn
- */
-export function marshallSearchResults(results, displayPageNumberFn) {
-  // Attach matchIndex to a few things to make it easier to identify
-  // an active/selected match
-  for (const [index, match] of results.matches.entries()) {
-    match.matchIndex = index;
-    match.displayPageNumber = displayPageNumberFn(match.par[0].page);
-    for (const par of match.par) {
-      for (const box of par.boxes) {
-        box.matchIndex = index;
-      }
-    }
-  }
-}
-
 /**
  * Search Results return handler
  * @param {SearchInsideResults} results
@@ -298,7 +286,12 @@ export function marshallSearchResults(results, displayPageNumberFn) {
  * @param {boolean} options.goToFirstResult
  */
 BookReader.prototype.BRSearchCallback = function(results, options) {
-  marshallSearchResults(results, pageNum => this.book.getPageNum(this.book.leafNumToIndex(pageNum)));
+  marshallSearchResults(
+    results,
+    pageNum => this.book.getPageNum(this.book.leafNumToIndex(pageNum)),
+    this.options.searchInsidePreTag,
+    this.options.searchInsidePostTag,
+  );
   this.searchResults = results || [];
 
   this.updateSearchHilites();

package/src/plugins/search/utils.js

@@ -0,0 +1,43 @@
+import { escapeHTML, escapeRegExp } from '../../BookReader/utils.js';
+
+/**
+ * @param {string} match
+ * @param {string} preTag
+ * @param {string} postTag
+ * @returns {string}
+ */
+export function renderMatch(match, preTag, postTag) {
+  // Search results are returned as a text blob with the hits wrapped in
+  // triple mustaches. Hits occasionally include text beyond the search
+  // term, so everything within the staches is captured and wrapped.
+  const preTagRe = escapeRegExp(escapeHTML(preTag));
+  const postTagRe = escapeRegExp(escapeHTML(postTag));
+  // [^] matches any character, including line breaks
+  const regex = new RegExp(`${preTagRe}([^]+?)${postTagRe}`, 'g');
+  return escapeHTML(match)
+    .replace(regex, '<mark>$1</mark>')
+    // Fix trailing hyphens. This over-corrects but is net useful.
+    .replace(/(\b)- /g, '$1');
+}
+
+/**
+ * Attach some fields to search inside results
+ * @param {SearchInsideResults} results
+ * @param {(pageNum: LeafNum) => PageNumString} displayPageNumberFn
+ * @param {string} preTag
+ * @param {string} postTag
+ */
+export function marshallSearchResults(results, displayPageNumberFn, preTag, postTag) {
+  // Attach matchIndex to a few things to make it easier to identify
+  // an active/selected match
+  for (const [index, match] of results.matches.entries()) {
+    match.matchIndex = index;
+    match.displayPageNumber = displayPageNumberFn(match.par[0].page);
+    match.html = renderMatch(match.text, preTag, postTag);
+    for (const par of match.par) {
+      for (const box of par.boxes) {
+        box.matchIndex = index;
+      }
+    }
+  }
+}

package/src/plugins/search/view.js

@@ -1,5 +1,3 @@
-import { escapeHTML } from "../../BookReader/utils.js";
-
 class SearchView {
   /**
    * @param {object} params
@@ -11,11 +9,6 @@ class SearchView {
    */
   constructor({ br, searchCancelledCallback = () => {} }) {
     this.br = br;
-
-    // Search results are returned as a text blob with the hits wrapped in
-    // triple mustaches. Hits occasionally include text beyond the search
-    // term, so everything within the staches is captured and wrapped.
-    this.matcher = new RegExp('{{{([^]+?)}}}', 'g'); // [^] matches any character, including line breaks
     this.matches = [];
     this.cacheDOMElements();
     this.bindEvents();
@@ -230,26 +223,20 @@ class SearchView {
    */
   renderPins(matches) {
     matches.forEach((match) => {
-      const queryString = match.text;
       const pageIndex = this.br.book.leafNumToIndex(match.par[0].page);
       const uiStringSearch = "Search result"; // i18n
-
       const percentThrough = this.br.constructor.util.cssPercentage(pageIndex, this.br.book.getNumLeafs() - 1);
 
-      const escapedQueryString = escapeHTML(queryString);
-      const queryStringWithB = escapedQueryString.replace(this.matcher, '<b>$1</b>');
-
-      let queryStringWithBTruncated = '';
-
-      if (queryString.length > 100) {
-        queryStringWithBTruncated = queryString.replace(/^(.{100}[^\s]*).*/, "$1");
-
-        // If truncating, we must escape *after* truncation occurs (but before wrapping in <b>)
-        queryStringWithBTruncated = escapeHTML(queryStringWithBTruncated)
-          .replace(this.matcher, '<b>$1</b>')
-          + '...';
+      let html = match.html;
+      if (html.length > 200) {
+        const start = Math.max(0, html.indexOf('<mark>') - 100);
+        if (start != 0) {
+          html = '…' + match.html
+            .substring(start)
+            // Make sure at word boundary though
+            .replace(/^\S+/, '');
+        }
       }
-
       // draw marker
       $('<div>')
         .addClass('BRsearch')
@@ -259,8 +246,8 @@ class SearchView {
         .attr('title', uiStringSearch)
         .append(`
           <div class="BRquery">
-            <div>${queryStringWithBTruncated || queryStringWithB}</div>
-            <div>Page ${match.displayPageNumber}</div>
+            <main>${html}</main>
+            <footer>Page ${match.displayPageNumber}</footer>
           </div>
         `)
         .appendTo(this.br.$('.BRnavline'))

package/tests/e2e/helpers/desktopSearch.js

@@ -29,8 +29,8 @@ export function runDesktopSearchTests(br) {
       await t.pressKey('enter');
 
       await t.expect(nav.desktop.searchPin.exists).ok();
-      await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').exists).ok();
-      await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').innerText).contains(TEST_TEXT_FOUND);
+      await t.expect(nav.desktop.searchPin.child('.BRquery').child('main').exists).ok();
+      await t.expect(nav.desktop.searchPin.child('.BRquery').child('main').innerText).contains(TEST_TEXT_FOUND);
       await t.expect(nav.desktop.searchNavigation.exists).ok();
       await t.expect(nav.desktop.searchNavigation.find('[data-id="resultsCount"]').exists).ok();
       await t.expect(nav.desktop.searchNavigation.find('[data-id="resultsCount"]').innerText).contains(SEARCH_MATCHES_LENGTH);
@@ -63,7 +63,7 @@ export function runDesktopSearchTests(br) {
       // FIXME: Why is it only typing every other letter?!?!
       await t.typeText(nav.desktop.searchBox, TEST_TEXT_NOT_FOUND.split('').join('_'));
       await t.pressKey('enter');
-      await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').withText(TEST_TEXT_NOT_FOUND).exists).notOk();
+      await t.expect(nav.desktop.searchPin.child('.BRquery').child('main').withText(TEST_TEXT_NOT_FOUND).exists).notOk();
 
       const getPageUrl = ClientFunction(() => window.location.href.toString());
       await t.expect(getPageUrl()).contains(TEST_TEXT_NOT_FOUND);

package/tests/jest/BookNavigator/search/search-results.test.js

@@ -5,6 +5,7 @@ import {
 } from '@open-wc/testing-helpers';
 import sinon from 'sinon';
 import { IABookSearchResults } from '@/src/BookNavigator/search/search-results.js';
+import { marshallSearchResults } from '@/src/plugins/search/utils.js';
 
 const container = (results = [], query = '') => (
   html`<ia-book-search-results .results=${results} .query=${query}></ia-book-search-results>`
@@ -43,9 +44,11 @@ const results = [{
     l: 432,
     page_height: 5357,
     page: 86,
-  }],
+  }]
 }];
 
+marshallSearchResults({ matches: results }, () => '', '{{{', '}}}');
+
 const resultWithScript = [{
   text: `foo bar <script>const msg = 'test' + ' failure'; document.write(msg);</script> {{{${searchQuery}}}} baz`,
   cover: '//placehold.it/30x44',
@@ -65,6 +68,8 @@ const resultWithScript = [{
   }],
 }];
 
+marshallSearchResults({ matches: resultWithScript }, () => '', '{{{', '}}}');
+
 describe('<ia-book-search-results>', () => {
   afterEach(() => {
     sinon.restore();

package/tests/jest/BookReader/utils.test.js

@@ -7,6 +7,7 @@ import {
   decodeURIComponentPlus,
   encodeURIComponentPlus,
   escapeHTML,
+  escapeRegExp,
   getActiveElement,
   isInputActive,
   poll,
@@ -215,3 +216,14 @@ describe('promisifyEvent', () => {
     expect(resolveSpy.callCount).toBe(1);
   });
 });
+
+describe('escapeRegex', () => {
+  test('Escapes regex', () => {
+    expect(escapeRegExp('.*')).toBe('\\.\\*');
+    expect(escapeRegExp('foo')).toBe('foo');
+    expect(escapeRegExp('foo.bar')).toBe('foo\\.bar');
+    expect(escapeRegExp('{{{')).toBe('\\{\\{\\{');
+    expect(escapeRegExp('')).toBe('');
+    expect(escapeRegExp('https://example.com')).toBe('https://example\\.com');
+  });
+});

package/tests/jest/plugins/search/plugin.search.test.js

@@ -1,7 +1,7 @@
 import BookReader from '@/src/BookReader.js';
-import '@/src/plugins/plugin.mobile_nav.js';
-import { marshallSearchResults } from '@/src/plugins/search/plugin.search.js';
+import '@/src/plugins/search/plugin.search.js';
 import { deepCopy } from '../../utils.js';
+import { DUMMY_RESULTS } from './utils.js';
 
 jest.mock('@/src/plugins/search/view.js');
 
@@ -14,28 +14,6 @@ const triggeredEvents = () => {
   });
 };
 
-const DUMMY_RESULTS = {
-  ia: "adventuresofoli00dick",
-  q: "child",
-  indexed: true,
-  page_count: 644,
-  body_length: 666,
-  leaf0_missing: false,
-  matches: [{
-    text: 'For a long; time after it was ushered into this world of sorrow and trouble, by the parish surgeon, it remained a matter of considerable doubt wliether the {{{child}}} Avould survi^ e to bear any name at all; in which case it is somewhat more than probable that these memoirs would never have appeared; or, if they had, that being comprised within a couple of pages, they would have possessed the inestimable meiit of being the most concise and faithful specimen of biography, extant in the literature of any age or country.',
-    par: [{
-      boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
-      b: 2535,
-      t: 1942,
-      page_width: 1790,
-      r: 1598,
-      l: 50,
-      page_height: 2940,
-      page: 37
-    }]
-  }]
-};
-
 beforeEach(() => {
   $.ajax = jest.fn().mockImplementation(() => {
     // return from:
@@ -165,18 +143,3 @@ describe('Plugin: Search', () => {
     expect(triggeredEvents()).toContain(`${namespace}SearchCallbackEmpty`);
   });
 });
-
-describe('marshallSearchResults', () => {
-  test('Adds match index', () => {
-    const results = deepCopy(DUMMY_RESULTS);
-    marshallSearchResults(results, x => x.toString());
-    expect(results.matches[0]).toHaveProperty('matchIndex', 0);
-    expect(results.matches[0].par[0].boxes[0]).toHaveProperty('matchIndex', 0);
-  });
-
-  test('Adds display page number', () => {
-    const results = deepCopy(DUMMY_RESULTS);
-    marshallSearchResults(results, x => `n${x}`);
-    expect(results.matches[0]).toHaveProperty('displayPageNumber', 'n37');
-  });
-});

package/tests/jest/plugins/search/plugin.search.view.test.js

@@ -2,6 +2,7 @@
 import BookReader from '@/src/BookReader.js';
 import '@/src/plugins/plugin.mobile_nav.js';
 import '@/src/plugins/search/plugin.search.js';
+import { marshallSearchResults } from '@/src/plugins/search/utils.js';
 import '@/src/plugins/search/view.js';
 
 let br;
@@ -27,6 +28,8 @@ const results = {
     }]
   }]
 };
+
+marshallSearchResults(results, () => '', '{{{', '}}}');
 const resultWithScript = {
   ia: "adventuresofoli00dick",
   q: "child",
@@ -48,6 +51,8 @@ const resultWithScript = {
     }]
   }]
 };
+
+marshallSearchResults(resultWithScript, () => '', '{{{', '}}}');
 beforeEach(() => {
   $.ajax = jest.fn().mockImplementation(() => {
     // return from:

package/tests/jest/plugins/search/utils.js

@@ -0,0 +1,25 @@
+import { marshallSearchResults } from "@/src/plugins/search/utils";
+
+export const DUMMY_RESULTS = {
+  ia: "adventuresofoli00dick",
+  q: "child",
+  indexed: true,
+  page_count: 644,
+  body_length: 666,
+  leaf0_missing: false,
+  matches: [{
+    text: 'For a long; time after it was ushered into this world of sorrow and trouble, by the parish surgeon, it remained a matter of considerable doubt wliether the {{{child}}} Avould survi^ e to bear any name at all; in which case it is somewhat more than probable that these memoirs would never have appeared; or, if they had, that being comprised within a couple of pages, they would have possessed the inestimable meiit of being the most concise and faithful specimen of biography, extant in the literature of any age or country.',
+    par: [{
+      boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
+      b: 2535,
+      t: 1942,
+      page_width: 1790,
+      r: 1598,
+      l: 50,
+      page_height: 2940,
+      page: 37
+    }]
+  }]
+};
+
+marshallSearchResults(DUMMY_RESULTS, () => '', '{{{', '}}}');

package/tests/jest/plugins/search/utils.test.js

@@ -0,0 +1,29 @@
+import { marshallSearchResults, renderMatch } from '@/src/plugins/search/utils.js';
+import { deepCopy } from '@/tests/jest/utils.js';
+import { DUMMY_RESULTS } from './utils.js';
+
+describe('renderMatch', () => {
+  test('Supports custom pre/post tags', () => {
+    const matchText = DUMMY_RESULTS.matches[0].text
+      .replace(/\{\{\{/g, '<IA_FTS_MATCH>')
+      .replace(/\}\}\}/g, '</IA_FTS_MATCH>');
+    const html = renderMatch(matchText, '<IA_FTS_MATCH>', '</IA_FTS_MATCH>');
+    expect(html).toContain('<mark>');
+    expect(html).toContain('</mark>');
+  });
+});
+
+describe('marshallSearchResults', () => {
+  test('Adds match index', () => {
+    const results = deepCopy(DUMMY_RESULTS);
+    marshallSearchResults(results, x => x.toString(), '{{{', '}}}');
+    expect(results.matches[0]).toHaveProperty('matchIndex', 0);
+    expect(results.matches[0].par[0].boxes[0]).toHaveProperty('matchIndex', 0);
+  });
+
+  test('Adds display page number', () => {
+    const results = deepCopy(DUMMY_RESULTS);
+    marshallSearchResults(results, x => `n${x}`, '{{{', '}}}');
+    expect(results.matches[0]).toHaveProperty('displayPageNumber', 'n37');
+  });
+});