Add tests for table_of_contents option

Author: cdrini

src/BookReader/options.js

@@ -180,6 +180,9 @@ export const DEFAULT_OPTIONS = {
    */
   data: [],
 
+  /** @type {import('../plugins/plugin.chapters.js').TocEntry[]} */
+  table_of_contents: null,
+
   /** Advanced methods for page rendering */
   /** @type {() => number} */
   getNumLeafs: null,

src/plugins/plugin.chapters.js

@@ -14,8 +14,6 @@ import '@internetarchive/icon-toc/icon-toc';
 jQuery.extend(BookReader.defaultOptions, {
   olHost: 'https://openlibrary.org',
   enableChaptersPlugin: true,
-  /** @type {TocEntry[]} */
-  table_of_contents: null,
   bookId: '',
 });
 
@@ -47,8 +45,8 @@ BookReader.prototype._chapterInit = async function() {
     this._tocEntries = rawTableOfContents
       .map(rawTOCEntry => (Object.assign({}, rawTOCEntry, {
         pageIndex: (
-          rawTOCEntry.pagenum ? this.book.getPageIndex(rawTOCEntry.pagenum) :
-            rawTOCEntry.leaf ? this.book.leafNumToIndex(rawTOCEntry.leaf) :
+          typeof(rawTOCEntry.leaf) == 'number' ? this.book.leafNumToIndex(rawTOCEntry.leaf) :
+            rawTOCEntry.pagenum ? this.book.getPageIndex(rawTOCEntry.pagenum) :
               undefined
         ),
       })));

tests/jest/plugins/plugin.chapters.test.js

@@ -4,7 +4,9 @@ import BookReader from "@/src/BookReader.js";
 import "@/src/plugins/plugin.chapters.js";
 import { BookModel } from "@/src/BookReader/BookModel";
 import { deepCopy } from "../utils";
+/** @typedef {import('@/src/plugins/plugin.chapters').TocEntry} TocEntry  */
 
+/** @type {TocEntry[]} */
 const SAMPLE_TOC = [{
   "pagenum": "3",
   "level": 1,
@@ -34,23 +36,34 @@ const SAMPLE_TOC = [{
   "pageIndex": 40,
 }];
 
+/** @type {TocEntry[]} */
 const SAMPLE_TOC_UNDEF = [
   {
-    "pagenum": "undefined",
     "level": 1,
     "label": "CHAPTER I",
     "type": { "key": "/type/toc_item" },
     "title": "THE COUNTRY AND THE MISSION 1",
   },
   {
-    "pagenum": "undefined",
     "level": 1,
     "label": "CHAPTER II",
     "type": { "key": "/type/toc_item" },
     "title": "THE COUNTRY AND THE MISSION 2",
   },
 ];
 
+/** @type {TocEntry[]} */
+const SAMPLE_TOC_OPTION = [
+  {
+    "level": 1,
+    "title": "THE COUNTRY AND THE MISSION 1",
+  },
+  {
+    "level": 1,
+    "title": "THE COUNTRY AND THE MISSION 2",
+  },
+];
+
 afterEach(() => {
   sinon.restore();
 });
@@ -92,14 +105,49 @@ describe("BRChaptersPlugin", () => {
         },
         getOpenLibraryRecord: async () => ({
           "title": "The Adventures of Sherlock Holmes",
-          "table_of_contents": deepCopy(SAMPLE_TOC_UNDEF),
+          "table_of_contents": deepCopy(SAMPLE_TOC_OPTION),
           "ocaid": "adventureofsherl0000unse",
         }),
         _chaptersRender: sinon.stub(),
       };
       await BookReader.prototype._chapterInit.call(fakeBR);
       expect(fakeBR._chaptersRender.callCount).toBe(1);
     });
+
+    test("does not fetch open library record if table of contents in options", async () => {
+      const fakeBR = {
+        options: {
+          table_of_contents: deepCopy(SAMPLE_TOC_UNDEF),
+        },
+        bind: sinon.stub(),
+        getOpenLibraryRecord: sinon.stub(),
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR.getOpenLibraryRecord.callCount).toBe(0);
+      expect(fakeBR._chaptersRender.callCount).toBe(1);
+    });
+
+    test("converts leafs and pagenums to page index", async () => {
+      const table_of_contents = deepCopy(SAMPLE_TOC_UNDEF);
+      table_of_contents[0].leaf = 0;
+      table_of_contents[1].pagenum = '17';
+      const fakeBR = {
+        options: {
+          table_of_contents,
+        },
+        bind: sinon.stub(),
+        book: {
+          leafNumToIndex: (leaf) => leaf + 1,
+          getPageIndex: (str) => parseFloat(str),
+        },
+        _chaptersRender: sinon.stub(),
+      };
+      await BookReader.prototype._chapterInit.call(fakeBR);
+      expect(fakeBR._chaptersRender.callCount).toBe(1);
+      expect(fakeBR._tocEntries[0].pageIndex).toBe(1);
+      expect(fakeBR._tocEntries[1].pageIndex).toBe(17);
+    });
   });
 
   describe('_chaptersRender', () => {