@internetarchive/bookreader 5.0.0-18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (428) hide show
  1. package/.eslintrc.js +58 -0
  2. package/.gitattributes +2 -0
  3. package/.github/ISSUE_TEMPLATE/bug.md +32 -0
  4. package/.github/ISSUE_TEMPLATE/feature-request.md +30 -0
  5. package/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +15 -0
  6. package/.github/dependabot.yml +8 -0
  7. package/.github/workflows/node.js.yml +37 -0
  8. package/.github/workflows/npm-publish.yml +47 -0
  9. package/.testcaferc.json +5 -0
  10. package/BookReader/BookReader.css +2983 -0
  11. package/BookReader/BookReader.js +3 -0
  12. package/BookReader/BookReader.js.LICENSE.txt +117 -0
  13. package/BookReader/BookReader.js.map +1 -0
  14. package/BookReader/bookreader-component-bundle.js +1436 -0
  15. package/BookReader/bookreader-component-bundle.js.LICENSE.txt +27 -0
  16. package/BookReader/bookreader-component-bundle.js.map +1 -0
  17. package/BookReader/icons/1up.svg +1 -0
  18. package/BookReader/icons/2up.svg +1 -0
  19. package/BookReader/icons/advance.svg +3 -0
  20. package/BookReader/icons/chevron-right.svg +1 -0
  21. package/BookReader/icons/close-circle-dark.svg +1 -0
  22. package/BookReader/icons/close-circle.svg +1 -0
  23. package/BookReader/icons/fullscreen.svg +1 -0
  24. package/BookReader/icons/fullscreen_exit.svg +1 -0
  25. package/BookReader/icons/hamburger.svg +1 -0
  26. package/BookReader/icons/left-arrow.svg +1 -0
  27. package/BookReader/icons/magnify-minus.svg +1 -0
  28. package/BookReader/icons/magnify-plus.svg +1 -0
  29. package/BookReader/icons/magnify.svg +1 -0
  30. package/BookReader/icons/pause.svg +1 -0
  31. package/BookReader/icons/play.svg +1 -0
  32. package/BookReader/icons/playback-speed.svg +1 -0
  33. package/BookReader/icons/read-aloud.svg +1 -0
  34. package/BookReader/icons/review.svg +3 -0
  35. package/BookReader/icons/thumbnails.svg +1 -0
  36. package/BookReader/icons/volume-full.svg +1 -0
  37. package/BookReader/images/BRicons.png +0 -0
  38. package/BookReader/images/BRicons.svg +5 -0
  39. package/BookReader/images/BRicons_ia.png +0 -0
  40. package/BookReader/images/back_pages.png +0 -0
  41. package/BookReader/images/book_bottom_icon.png +0 -0
  42. package/BookReader/images/book_down_icon.png +0 -0
  43. package/BookReader/images/book_left_icon.png +0 -0
  44. package/BookReader/images/book_leftmost_icon.png +0 -0
  45. package/BookReader/images/book_right_icon.png +0 -0
  46. package/BookReader/images/book_rightmost_icon.png +0 -0
  47. package/BookReader/images/book_top_icon.png +0 -0
  48. package/BookReader/images/book_up_icon.png +0 -0
  49. package/BookReader/images/books_graphic.svg +1 -0
  50. package/BookReader/images/booksplit.png +0 -0
  51. package/BookReader/images/control_pause_icon.png +0 -0
  52. package/BookReader/images/control_play_icon.png +0 -0
  53. package/BookReader/images/embed_icon.png +0 -0
  54. package/BookReader/images/icon-home-ia.png +0 -0
  55. package/BookReader/images/icon_OL-logo-xs.png +0 -0
  56. package/BookReader/images/icon_alert-xs.png +0 -0
  57. package/BookReader/images/icon_book.svg +1 -0
  58. package/BookReader/images/icon_bookmark.svg +1 -0
  59. package/BookReader/images/icon_close-pop.png +0 -0
  60. package/BookReader/images/icon_download.png +0 -0
  61. package/BookReader/images/icon_gear.svg +1 -0
  62. package/BookReader/images/icon_hamburger.svg +1 -0
  63. package/BookReader/images/icon_home.png +0 -0
  64. package/BookReader/images/icon_home.svg +1 -0
  65. package/BookReader/images/icon_home_ia.png +0 -0
  66. package/BookReader/images/icon_indicator.png +0 -0
  67. package/BookReader/images/icon_info.svg +1 -0
  68. package/BookReader/images/icon_one_page.svg +1 -0
  69. package/BookReader/images/icon_pause.svg +1 -0
  70. package/BookReader/images/icon_play.svg +1 -0
  71. package/BookReader/images/icon_playback-rate.svg +1 -0
  72. package/BookReader/images/icon_return.png +0 -0
  73. package/BookReader/images/icon_search_button.svg +1 -0
  74. package/BookReader/images/icon_share.svg +1 -0
  75. package/BookReader/images/icon_skip-ahead.svg +1 -0
  76. package/BookReader/images/icon_skip-back.svg +2 -0
  77. package/BookReader/images/icon_speaker.svg +1 -0
  78. package/BookReader/images/icon_speaker_open.svg +1 -0
  79. package/BookReader/images/icon_thumbnails.svg +1 -0
  80. package/BookReader/images/icon_toc.svg +1 -0
  81. package/BookReader/images/icon_two_pages.svg +1 -0
  82. package/BookReader/images/icon_zoomer.png +0 -0
  83. package/BookReader/images/loading.gif +0 -0
  84. package/BookReader/images/logo_icon.png +0 -0
  85. package/BookReader/images/marker_chap-off.png +0 -0
  86. package/BookReader/images/marker_chap-off.svg +1 -0
  87. package/BookReader/images/marker_chap-off_ia.png +0 -0
  88. package/BookReader/images/marker_chap-on.png +0 -0
  89. package/BookReader/images/marker_chap-on.svg +1 -0
  90. package/BookReader/images/marker_srch-on.svg +1 -0
  91. package/BookReader/images/marker_srchchap-off.png +0 -0
  92. package/BookReader/images/marker_srchchap-on.png +0 -0
  93. package/BookReader/images/nav_control-dn.png +0 -0
  94. package/BookReader/images/nav_control-dn_ia.png +0 -0
  95. package/BookReader/images/nav_control-up.png +0 -0
  96. package/BookReader/images/nav_control-up_ia.png +0 -0
  97. package/BookReader/images/nav_control.png +0 -0
  98. package/BookReader/images/one_page_mode_icon.png +0 -0
  99. package/BookReader/images/paper-badge.png +0 -0
  100. package/BookReader/images/print_icon.png +0 -0
  101. package/BookReader/images/progressbar.gif +0 -0
  102. package/BookReader/images/right_edges.png +0 -0
  103. package/BookReader/images/slider.png +0 -0
  104. package/BookReader/images/slider_ia.png +0 -0
  105. package/BookReader/images/thumbnail_mode_icon.png +0 -0
  106. package/BookReader/images/transparent.png +0 -0
  107. package/BookReader/images/two_page_mode_icon.png +0 -0
  108. package/BookReader/images/zoom_in_icon.png +0 -0
  109. package/BookReader/images/zoom_out_icon.png +0 -0
  110. package/BookReader/jquery-1.10.1.js +2 -0
  111. package/BookReader/jquery-1.10.1.js.LICENSE.txt +24 -0
  112. package/BookReader/plugins/plugin.archive_analytics.js +2 -0
  113. package/BookReader/plugins/plugin.archive_analytics.js.map +1 -0
  114. package/BookReader/plugins/plugin.autoplay.js +2 -0
  115. package/BookReader/plugins/plugin.autoplay.js.map +1 -0
  116. package/BookReader/plugins/plugin.chapters.js +2 -0
  117. package/BookReader/plugins/plugin.chapters.js.map +1 -0
  118. package/BookReader/plugins/plugin.iframe.js +2 -0
  119. package/BookReader/plugins/plugin.iframe.js.map +1 -0
  120. package/BookReader/plugins/plugin.mobile_nav.js +2 -0
  121. package/BookReader/plugins/plugin.mobile_nav.js.map +1 -0
  122. package/BookReader/plugins/plugin.resume.js +2 -0
  123. package/BookReader/plugins/plugin.resume.js.map +1 -0
  124. package/BookReader/plugins/plugin.search.js +2 -0
  125. package/BookReader/plugins/plugin.search.js.map +1 -0
  126. package/BookReader/plugins/plugin.text_selection.js +2 -0
  127. package/BookReader/plugins/plugin.text_selection.js.map +1 -0
  128. package/BookReader/plugins/plugin.tts.js +3 -0
  129. package/BookReader/plugins/plugin.tts.js.LICENSE.txt +27 -0
  130. package/BookReader/plugins/plugin.tts.js.map +1 -0
  131. package/BookReader/plugins/plugin.url.js +2 -0
  132. package/BookReader/plugins/plugin.url.js.map +1 -0
  133. package/BookReader/plugins/plugin.vendor-fullscreen.js +2 -0
  134. package/BookReader/plugins/plugin.vendor-fullscreen.js.map +1 -0
  135. package/BookReaderDemo/BookReaderDemo.css +41 -0
  136. package/BookReaderDemo/BookReaderJSAdvanced.js +115 -0
  137. package/BookReaderDemo/BookReaderJSAutoplay.js +56 -0
  138. package/BookReaderDemo/BookReaderJSSimple.js +55 -0
  139. package/BookReaderDemo/IIIFBookReader.js +207 -0
  140. package/BookReaderDemo/assets/v5/Bookreader-logo-cool-grad.svg +1 -0
  141. package/BookReaderDemo/assets/v5/Bookreader-logo-flat.svg +1 -0
  142. package/BookReaderDemo/assets/v5/Bookreader-logo-hex-cool-grad.png +0 -0
  143. package/BookReaderDemo/assets/v5/Bookreader-logo-hex-flat.png +0 -0
  144. package/BookReaderDemo/assets/v5/Bookreader-logo-lines.png +0 -0
  145. package/BookReaderDemo/assets/v5/Bookreader-logo-lines.svg +1 -0
  146. package/BookReaderDemo/assets/v5/Bookreader-logo-warm.svg +1 -0
  147. package/BookReaderDemo/assets/v5/bookreader-logo-renders@1x.png +0 -0
  148. package/BookReaderDemo/assets/v5/bookreader-logo-renders@2x.png +0 -0
  149. package/BookReaderDemo/assets/v5/bookreader-v5-screenshot.png +0 -0
  150. package/BookReaderDemo/bookreader-template-bundle.js +7178 -0
  151. package/BookReaderDemo/demo-advanced.html +32 -0
  152. package/BookReaderDemo/demo-autoplay.html +38 -0
  153. package/BookReaderDemo/demo-embed-iframe-src.html +84 -0
  154. package/BookReaderDemo/demo-embed.html +26 -0
  155. package/BookReaderDemo/demo-fullscreen-mobile.html +36 -0
  156. package/BookReaderDemo/demo-fullscreen.html +33 -0
  157. package/BookReaderDemo/demo-iiif.html +34 -0
  158. package/BookReaderDemo/demo-iiif.js +26 -0
  159. package/BookReaderDemo/demo-internetarchive.html +74 -0
  160. package/BookReaderDemo/demo-multiple.html +43 -0
  161. package/BookReaderDemo/demo-preview-pages.html +1092 -0
  162. package/BookReaderDemo/demo-simple.html +34 -0
  163. package/BookReaderDemo/demo-vendor-fullscreen.html +36 -0
  164. package/BookReaderDemo/immersion-1up.html +64 -0
  165. package/BookReaderDemo/immersion-mode.html +35 -0
  166. package/BookReaderDemo/toggle_controls.html +53 -0
  167. package/BookReaderDemo/view_mode.html +39 -0
  168. package/BookReaderDemo/viewmode-cycle.html +41 -0
  169. package/CHANGELOG.md +540 -0
  170. package/CONTRIBUTING.md +7 -0
  171. package/LICENSE +661 -0
  172. package/README.md +205 -0
  173. package/babel.config.js +18 -0
  174. package/codecov.yml +17 -0
  175. package/index.html +31 -0
  176. package/jsconfig.json +14 -0
  177. package/karma.conf.js +23 -0
  178. package/package.json +129 -0
  179. package/screenshot.png +0 -0
  180. package/scripts/postversion.js +10 -0
  181. package/scripts/preversion.js +14 -0
  182. package/scripts/version.js +26 -0
  183. package/src/BookNavigator/BookModel.js +14 -0
  184. package/src/BookNavigator/BookNavigator.js +468 -0
  185. package/src/BookNavigator/assets/book-loader.js +27 -0
  186. package/src/BookNavigator/assets/bookmark-colors.js +15 -0
  187. package/src/BookNavigator/assets/button-base.js +61 -0
  188. package/src/BookNavigator/assets/icon_checkmark.js +6 -0
  189. package/src/BookNavigator/assets/icon_close.js +3 -0
  190. package/src/BookNavigator/assets/icon_sort_asc.js +5 -0
  191. package/src/BookNavigator/assets/icon_sort_desc.js +5 -0
  192. package/src/BookNavigator/assets/icon_sort_neutral.js +5 -0
  193. package/src/BookNavigator/assets/icon_volumes.js +11 -0
  194. package/src/BookNavigator/bookmarks/bookmark-button.js +64 -0
  195. package/src/BookNavigator/bookmarks/bookmark-edit.js +215 -0
  196. package/src/BookNavigator/bookmarks/bookmarks-list.js +285 -0
  197. package/src/BookNavigator/bookmarks/bookmarks-loginCTA.js +28 -0
  198. package/src/BookNavigator/bookmarks/bookmarks-provider.js +53 -0
  199. package/src/BookNavigator/bookmarks/ia-bookmarks.js +500 -0
  200. package/src/BookNavigator/br-fullscreen-mgr.js +83 -0
  201. package/src/BookNavigator/delete-modal-actions.js +49 -0
  202. package/src/BookNavigator/downloads/downloads-provider.js +76 -0
  203. package/src/BookNavigator/downloads/downloads.js +138 -0
  204. package/src/BookNavigator/search/a-search-result.js +55 -0
  205. package/src/BookNavigator/search/search-provider.js +180 -0
  206. package/src/BookNavigator/search/search-results.js +360 -0
  207. package/src/BookNavigator/visual-adjustments/visual-adjustments-provider.js +93 -0
  208. package/src/BookNavigator/visual-adjustments/visual-adjustments.js +280 -0
  209. package/src/BookNavigator/volumes/volumes-provider.js +83 -0
  210. package/src/BookNavigator/volumes/volumes.js +178 -0
  211. package/src/BookReader/BookModel.js +518 -0
  212. package/src/BookReader/DebugConsole.js +54 -0
  213. package/src/BookReader/ImageCache.js +116 -0
  214. package/src/BookReader/Mode1Up.js +90 -0
  215. package/src/BookReader/Mode1UpLit.js +434 -0
  216. package/src/BookReader/Mode2Up.js +1372 -0
  217. package/src/BookReader/ModeSmoothZoom.js +177 -0
  218. package/src/BookReader/ModeThumb.js +336 -0
  219. package/src/BookReader/Navbar/Navbar.js +339 -0
  220. package/src/BookReader/PageContainer.js +120 -0
  221. package/src/BookReader/ReduceSet.js +26 -0
  222. package/src/BookReader/Toolbar/Toolbar.js +384 -0
  223. package/src/BookReader/events.js +20 -0
  224. package/src/BookReader/options.js +320 -0
  225. package/src/BookReader/utils/HTMLDimensionsCacher.js +44 -0
  226. package/src/BookReader/utils/classes.js +36 -0
  227. package/src/BookReader/utils.js +240 -0
  228. package/src/BookReader.js +2546 -0
  229. package/src/BookReaderComponent/BookReaderComponent.js +112 -0
  230. package/src/ItemNavigator/ItemNavigator.js +376 -0
  231. package/src/ItemNavigator/providers/sharing.js +33 -0
  232. package/src/assets/icons/1up.svg +12 -0
  233. package/src/assets/icons/2up.svg +15 -0
  234. package/src/assets/icons/advance.svg +26 -0
  235. package/src/assets/icons/chevron-right.svg +1 -0
  236. package/src/assets/icons/close-circle-dark.svg +1 -0
  237. package/src/assets/icons/close-circle.svg +1 -0
  238. package/src/assets/icons/fullscreen.svg +17 -0
  239. package/src/assets/icons/fullscreen_exit.svg +17 -0
  240. package/src/assets/icons/hamburger.svg +15 -0
  241. package/src/assets/icons/left-arrow.svg +12 -0
  242. package/src/assets/icons/magnify-minus.svg +16 -0
  243. package/src/assets/icons/magnify-plus.svg +17 -0
  244. package/src/assets/icons/magnify.svg +15 -0
  245. package/src/assets/icons/pause.svg +23 -0
  246. package/src/assets/icons/play.svg +22 -0
  247. package/src/assets/icons/playback-speed.svg +34 -0
  248. package/src/assets/icons/read-aloud.svg +22 -0
  249. package/src/assets/icons/review.svg +22 -0
  250. package/src/assets/icons/thumbnails.svg +17 -0
  251. package/src/assets/icons/volume-full.svg +22 -0
  252. package/src/assets/images/BRicons.png +0 -0
  253. package/src/assets/images/BRicons.svg +94 -0
  254. package/src/assets/images/BRicons_ia.png +0 -0
  255. package/src/assets/images/back_pages.png +0 -0
  256. package/src/assets/images/book_bottom_icon.png +0 -0
  257. package/src/assets/images/book_down_icon.png +0 -0
  258. package/src/assets/images/book_left_icon.png +0 -0
  259. package/src/assets/images/book_leftmost_icon.png +0 -0
  260. package/src/assets/images/book_right_icon.png +0 -0
  261. package/src/assets/images/book_rightmost_icon.png +0 -0
  262. package/src/assets/images/book_top_icon.png +0 -0
  263. package/src/assets/images/book_up_icon.png +0 -0
  264. package/src/assets/images/books_graphic.svg +177 -0
  265. package/src/assets/images/booksplit.png +0 -0
  266. package/src/assets/images/control_pause_icon.png +0 -0
  267. package/src/assets/images/control_play_icon.png +0 -0
  268. package/src/assets/images/embed_icon.png +0 -0
  269. package/src/assets/images/icon-home-ia.png +0 -0
  270. package/src/assets/images/icon_OL-logo-xs.png +0 -0
  271. package/src/assets/images/icon_alert-xs.png +0 -0
  272. package/src/assets/images/icon_book.svg +12 -0
  273. package/src/assets/images/icon_bookmark.svg +12 -0
  274. package/src/assets/images/icon_close-pop.png +0 -0
  275. package/src/assets/images/icon_download.png +0 -0
  276. package/src/assets/images/icon_gear.svg +14 -0
  277. package/src/assets/images/icon_hamburger.svg +20 -0
  278. package/src/assets/images/icon_home.png +0 -0
  279. package/src/assets/images/icon_home.svg +21 -0
  280. package/src/assets/images/icon_home_ia.png +0 -0
  281. package/src/assets/images/icon_indicator.png +0 -0
  282. package/src/assets/images/icon_info.svg +11 -0
  283. package/src/assets/images/icon_one_page.svg +8 -0
  284. package/src/assets/images/icon_pause.svg +1 -0
  285. package/src/assets/images/icon_play.svg +1 -0
  286. package/src/assets/images/icon_playback-rate.svg +15 -0
  287. package/src/assets/images/icon_return.png +0 -0
  288. package/src/assets/images/icon_search_button.svg +8 -0
  289. package/src/assets/images/icon_share.svg +9 -0
  290. package/src/assets/images/icon_skip-ahead.svg +6 -0
  291. package/src/assets/images/icon_skip-back.svg +13 -0
  292. package/src/assets/images/icon_speaker.svg +18 -0
  293. package/src/assets/images/icon_speaker_open.svg +10 -0
  294. package/src/assets/images/icon_thumbnails.svg +12 -0
  295. package/src/assets/images/icon_toc.svg +5 -0
  296. package/src/assets/images/icon_two_pages.svg +9 -0
  297. package/src/assets/images/icon_zoomer.png +0 -0
  298. package/src/assets/images/loading.gif +0 -0
  299. package/src/assets/images/logo_icon.png +0 -0
  300. package/src/assets/images/marker_chap-off.png +0 -0
  301. package/src/assets/images/marker_chap-off.svg +11 -0
  302. package/src/assets/images/marker_chap-off_ia.png +0 -0
  303. package/src/assets/images/marker_chap-on.png +0 -0
  304. package/src/assets/images/marker_chap-on.svg +11 -0
  305. package/src/assets/images/marker_srch-on.svg +11 -0
  306. package/src/assets/images/marker_srchchap-off.png +0 -0
  307. package/src/assets/images/marker_srchchap-on.png +0 -0
  308. package/src/assets/images/nav_control-dn.png +0 -0
  309. package/src/assets/images/nav_control-dn_ia.png +0 -0
  310. package/src/assets/images/nav_control-up.png +0 -0
  311. package/src/assets/images/nav_control-up_ia.png +0 -0
  312. package/src/assets/images/nav_control.png +0 -0
  313. package/src/assets/images/one_page_mode_icon.png +0 -0
  314. package/src/assets/images/paper-badge.png +0 -0
  315. package/src/assets/images/print_icon.png +0 -0
  316. package/src/assets/images/progressbar.gif +0 -0
  317. package/src/assets/images/right_edges.png +0 -0
  318. package/src/assets/images/slider.png +0 -0
  319. package/src/assets/images/slider_ia.png +0 -0
  320. package/src/assets/images/thumbnail_mode_icon.png +0 -0
  321. package/src/assets/images/transparent.png +0 -0
  322. package/src/assets/images/two_page_mode_icon.png +0 -0
  323. package/src/assets/images/zoom_in_icon.png +0 -0
  324. package/src/assets/images/zoom_out_icon.png +0 -0
  325. package/src/css/BookReader.scss +89 -0
  326. package/src/css/_BRBookmarks.scss +29 -0
  327. package/src/css/_BRComponent.scss +13 -0
  328. package/src/css/_BRfloat.scss +197 -0
  329. package/src/css/_BRicon.scss +48 -0
  330. package/src/css/_BRmain.scss +251 -0
  331. package/src/css/_BRnav.scss +382 -0
  332. package/src/css/_BRpages.scss +139 -0
  333. package/src/css/_BRsearch.scss +226 -0
  334. package/src/css/_BRtoolbar.scss +84 -0
  335. package/src/css/_BRvendor.scss +5 -0
  336. package/src/css/_MobileNav.scss +194 -0
  337. package/src/css/_TextSelection.scss +32 -0
  338. package/src/css/_colorbox.scss +52 -0
  339. package/src/css/_controls.scss +244 -0
  340. package/src/css/_icons.scss +121 -0
  341. package/src/dragscrollable-br.js +261 -0
  342. package/src/jquery-wrapper.js +4 -0
  343. package/src/plugins/plugin.archive_analytics.js +86 -0
  344. package/src/plugins/plugin.autoplay.js +129 -0
  345. package/src/plugins/plugin.chapters.js +251 -0
  346. package/src/plugins/plugin.iframe.js +48 -0
  347. package/src/plugins/plugin.mobile_nav.js +287 -0
  348. package/src/plugins/plugin.resume.js +68 -0
  349. package/src/plugins/plugin.text_selection.js +291 -0
  350. package/src/plugins/plugin.url.js +198 -0
  351. package/src/plugins/plugin.vendor-fullscreen.js +247 -0
  352. package/src/plugins/search/plugin.search.js +439 -0
  353. package/src/plugins/search/view.js +440 -0
  354. package/src/plugins/tts/AbstractTTSEngine.js +242 -0
  355. package/src/plugins/tts/FestivalTTSEngine.js +169 -0
  356. package/src/plugins/tts/PageChunk.js +107 -0
  357. package/src/plugins/tts/PageChunkIterator.js +163 -0
  358. package/src/plugins/tts/WebTTSEngine.js +352 -0
  359. package/src/plugins/tts/plugin.tts.js +335 -0
  360. package/src/plugins/tts/tooltip_dict.js +15 -0
  361. package/src/plugins/tts/utils.js +91 -0
  362. package/src/util/browserSniffing.js +30 -0
  363. package/src/util/debouncer.js +26 -0
  364. package/src/util/docCookies.js +67 -0
  365. package/src/util/strings.js +34 -0
  366. package/tests/BookReader/BookModel.test.js +312 -0
  367. package/tests/BookReader/BookReaderPublicFunctions.test.js +164 -0
  368. package/tests/BookReader/DebugConsole.test.js +25 -0
  369. package/tests/BookReader/ImageCache.test.js +150 -0
  370. package/tests/BookReader/Mode1UpLit.test.js +87 -0
  371. package/tests/BookReader/Mode2Up.test.js +245 -0
  372. package/tests/BookReader/ModeSmoothZoom.test.js +149 -0
  373. package/tests/BookReader/Navbar/Navbar.test.js +169 -0
  374. package/tests/BookReader/PageContainer.test.js +187 -0
  375. package/tests/BookReader/ReduceSet.test.js +38 -0
  376. package/tests/BookReader/Toolbar/Toolbar.test.js +26 -0
  377. package/tests/BookReader/utils/HTMLDimensionsCacher.test.js +59 -0
  378. package/tests/BookReader/utils/classes.test.js +88 -0
  379. package/tests/BookReader/utils.test.js +136 -0
  380. package/tests/BookReader.options.test.js +39 -0
  381. package/tests/BookReader.test.js +301 -0
  382. package/tests/e2e/README.md +75 -0
  383. package/tests/e2e/autoplay.test.js +13 -0
  384. package/tests/e2e/base.test.js +35 -0
  385. package/tests/e2e/helpers/base.js +263 -0
  386. package/tests/e2e/helpers/debug.js +13 -0
  387. package/tests/e2e/helpers/desktopSearch.js +72 -0
  388. package/tests/e2e/helpers/mobileSearch.js +85 -0
  389. package/tests/e2e/helpers/mockSearch.js +93 -0
  390. package/tests/e2e/helpers/rightToLeft.js +29 -0
  391. package/tests/e2e/ia-production/ia-prod-base.js +17 -0
  392. package/tests/e2e/models/BookReader.js +11 -0
  393. package/tests/e2e/models/Navigation.js +56 -0
  394. package/tests/e2e/rightToLeft.test.js +20 -0
  395. package/tests/e2e/viewmode.test.js +37 -0
  396. package/tests/karma/BookNavigator/book-navigator.test.js +180 -0
  397. package/tests/karma/BookNavigator/bookmarks/bookmark-edit.test.js +133 -0
  398. package/tests/karma/BookNavigator/bookmarks/bookmarks-list.test.js +222 -0
  399. package/tests/karma/BookNavigator/downloads/downloads-provider.test.js +64 -0
  400. package/tests/karma/BookNavigator/downloads/downloads.test.js +54 -0
  401. package/tests/karma/BookNavigator/search/search-provider.test.js +23 -0
  402. package/tests/karma/BookNavigator/search/search-results.test.js +240 -0
  403. package/tests/karma/BookNavigator/sharing/sharing-provider.test.js +40 -0
  404. package/tests/karma/BookNavigator/visual-adjustments.test.js +201 -0
  405. package/tests/karma/BookNavigator/volumes/volumes-provider.test.js +160 -0
  406. package/tests/karma/BookNavigator/volumes/volumes.test.js +98 -0
  407. package/tests/plugins/plugin.archive_analytics.test.js +23 -0
  408. package/tests/plugins/plugin.autoplay.test.js +52 -0
  409. package/tests/plugins/plugin.chapters.test.js +130 -0
  410. package/tests/plugins/plugin.iframe.test.js +42 -0
  411. package/tests/plugins/plugin.mobile_nav.test.js +66 -0
  412. package/tests/plugins/plugin.resume.test.js +98 -0
  413. package/tests/plugins/plugin.text_selection.test.js +193 -0
  414. package/tests/plugins/plugin.url.test.js +129 -0
  415. package/tests/plugins/plugin.vendor-fullscreen.test.js +65 -0
  416. package/tests/plugins/search/plugin.search.test.js +173 -0
  417. package/tests/plugins/search/plugin.search.view.test.js +106 -0
  418. package/tests/plugins/tts/AbstractTTSEngine.test.js +153 -0
  419. package/tests/plugins/tts/FestivalTTSEngine.test.js +59 -0
  420. package/tests/plugins/tts/PageChunk.test.js +57 -0
  421. package/tests/plugins/tts/PageChunkIterator.test.js +179 -0
  422. package/tests/plugins/tts/WebTTSEngine.test.js +126 -0
  423. package/tests/plugins/tts/utils.test.js +133 -0
  424. package/tests/util/browserSniffing.test.js +56 -0
  425. package/tests/util/docCookies.test.js +15 -0
  426. package/tests/util/strings.test.js +63 -0
  427. package/tests/utils.js +80 -0
  428. package/webpack.config.js +85 -0
@@ -0,0 +1,301 @@
1
+
2
+ import BookReader from '../src/BookReader.js';
3
+ import '../src/plugins/plugin.resume.js';
4
+ import '../src/plugins/plugin.url.js';
5
+
6
+ let br;
7
+ beforeAll(() => {
8
+ document.body.innerHTML = '<div id="BookReader">';
9
+ br = new BookReader();
10
+ });
11
+
12
+ afterEach(() => {
13
+ jest.clearAllMocks();
14
+ });
15
+
16
+ test('has registered PostInit events', () => {
17
+ expect(BookReader.eventNames.PostInit).toBeTruthy();
18
+ });
19
+
20
+ test('has registered zoom events', () => {
21
+ expect(BookReader.eventNames.zoomIn).toBeTruthy();
22
+ expect(BookReader.eventNames.zoomOut).toBeTruthy();
23
+ });
24
+
25
+ test('has registered view type selected events', () => {
26
+ expect(BookReader.eventNames['1PageViewSelected']).toBeTruthy();
27
+ expect(BookReader.eventNames['2PageViewSelected']).toBeTruthy();
28
+ expect(BookReader.eventNames['3PageViewSelected']).toBeTruthy();
29
+ });
30
+
31
+ test('has registered fullscreen toggle event', () => {
32
+ expect(BookReader.eventNames.fullscreenToggled).toBeTruthy();
33
+ });
34
+
35
+ test('checks cookie when initParams called', () => {
36
+ br.getResumeValue = jest.fn(() => 15);
37
+ br.urlReadFragment = jest.fn(() => '');
38
+
39
+ const params = br.initParams();
40
+ expect(br.getResumeValue).toHaveBeenCalledTimes(1);
41
+ expect(params.init).toBe(true);
42
+ expect(params.index).toBe(15);
43
+ expect(params.fragmentChange).toBe(true);
44
+ });
45
+
46
+ test('does not check cookie when initParams called', () => {
47
+ br.getResumeValue = jest.fn(() => null);
48
+ br.urlReadFragment = jest.fn(() => '');
49
+ br.options.enablePageResume = false;
50
+
51
+ const params = br.initParams();
52
+ expect(br.getResumeValue).toHaveBeenCalledTimes(0);
53
+ expect(params.init).toBe(true);
54
+ expect(params.index).toBe(0);
55
+ expect(params.fragmentChange).toBe(false);
56
+ });
57
+
58
+ test('gets index from fragment when both fragment and cookie when InitParams called', () => {
59
+ br.getResumeValue = jest.fn(() => 15);
60
+ br.urlReadFragment = jest.fn(() => 'page/n4');
61
+ br.options.enablePageResume = true;
62
+
63
+ const params = br.initParams();
64
+ expect(br.getResumeValue).toHaveBeenCalledTimes(1);
65
+ expect(params.init).toBe(true);
66
+ expect(params.index).toBe(4);
67
+ expect(params.fragmentChange).toBe(true);
68
+ });
69
+
70
+ test('sets prevReadMode when init called', () => {
71
+ br.init();
72
+ expect(br.prevReadMode).toBeTruthy();
73
+ });
74
+
75
+ // Default behavior same in
76
+ // BookReader.prototype.drawLeafsThumbnail
77
+ // BookReader.prototype.getPrevReadMode
78
+ test('sets prevPageMode if initial mode is thumb', () => {
79
+ br.urlReadFragment = jest.fn(() => 'page/n4/mode/thumb');
80
+
81
+ br.init();
82
+ expect(br.prevReadMode).toBe(BookReader.constMode1up);
83
+ });
84
+
85
+ test('calls switchMode with init option when init called', () => {
86
+ br.switchMode = jest.fn();
87
+
88
+ br.init();
89
+ expect(br.switchMode.mock.calls[0][1])
90
+ .toHaveProperty('init', true);
91
+ });
92
+
93
+ test('has suppressFragmentChange true when init with no input', () => {
94
+ br.getResumeValue = jest.fn(() => null);
95
+ br.urlReadFragment = jest.fn(() => '');
96
+ br.urlReadHashFragment = jest.fn(() => '');
97
+ br.switchMode = jest.fn();
98
+
99
+ br.init();
100
+ expect(br.switchMode.mock.calls[0][1])
101
+ .toHaveProperty('suppressFragmentChange', true);
102
+ });
103
+
104
+ test('has suppressFragmentChange false when init with cookie', () => {
105
+ br.getResumeValue = jest.fn(() => 5);
106
+ br.urlReadFragment = jest.fn(() => '');
107
+ br.switchMode = jest.fn();
108
+
109
+ br.init();
110
+ expect(br.switchMode.mock.calls[0][1])
111
+ .toHaveProperty('suppressFragmentChange', false);
112
+ });
113
+
114
+ test('has suppressFragmentChange false when init with fragment', () => {
115
+ br.getResumeValue = jest.fn(() => null);
116
+ br.urlReadFragment = jest.fn(() => 'mode/1up');
117
+ br.switchMode = jest.fn();
118
+
119
+ br.init();
120
+ expect(br.switchMode.mock.calls[0][1])
121
+ .toHaveProperty('suppressFragmentChange', false);
122
+ });
123
+
124
+ test('has suppressFragmentChange false when init with hash fragment', () => {
125
+ br.getResumeValue = jest.fn(() => null);
126
+ br.urlReadFragment = jest.fn(() => '');
127
+ br.urlReadHashFragment = jest.fn(() => 'mode/1up');
128
+ br.switchMode = jest.fn();
129
+ br.options.urlMode = 'history',
130
+
131
+ br.init();
132
+ expect(br.switchMode.mock.calls[0][1])
133
+ .toHaveProperty('suppressFragmentChange', false);
134
+ });
135
+
136
+ test('adds q= term to urlMode=history query string', () => {
137
+ expect(br.queryStringFromParams(
138
+ { search: 'test value' },
139
+ 'name=value',
140
+ 'history'
141
+ )).toBe('?name=value&q=test+value');
142
+ });
143
+
144
+ test('replaces q= term in urlMode=history query string', () => {
145
+ expect(br.queryStringFromParams(
146
+ { search: 'test+value' },
147
+ 'q=foo&a=1&b=2&c=3',
148
+ 'history'
149
+ )).toBe('?q=test%2Bvalue&a=1&b=2&c=3');
150
+ });
151
+
152
+ test('does not add q= term to urlMode=hash query string', () => {
153
+ expect(br.queryStringFromParams(
154
+ { search: 'test value' },
155
+ 'name=value',
156
+ 'hash'
157
+ )).toBe('?name=value');
158
+ });
159
+
160
+ test('_getPageURISrcset with 0 page book', () => {
161
+ br._models.book.getNumLeafs = jest.fn(() => 0);
162
+ br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
163
+ br.init();
164
+ expect(br._getPageURISrcset(5, undefined, undefined)).toBe("");
165
+ });
166
+
167
+ test('_getPageURISrcset with negative index', () => {
168
+ br._models.book.getNumLeafs = jest.fn(() => 0);
169
+ br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
170
+ br.init();
171
+ expect(br._getPageURISrcset(-7, undefined, undefined)).toBe("");
172
+ });
173
+
174
+ test('_getPageURISrcset with 0 elements in srcset', () => {
175
+ br._models.book.getNumLeafs = jest.fn(() => 30);
176
+ br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
177
+ br.init();
178
+ expect(br._getPageURISrcset(5, 1, undefined)).toBe("");
179
+ });
180
+
181
+ test('_getPageURISrcset with 2 elements in srcset', () => {
182
+ br._models.book.getNumLeafs = jest.fn(() => 30);
183
+ br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
184
+ br.init();
185
+ expect(br._getPageURISrcset(5, 5, undefined)).toBe("correctURL.png&scale=2 2x, correctURL.png&scale=1 4x");
186
+ });
187
+
188
+ test('_getPageURISrcset with the most elements in srcset', () => {
189
+ br._models.book.getNumLeafs = jest.fn(() => 30);
190
+ br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
191
+ br.init();
192
+ expect(br._getPageURISrcset(5, 35, undefined)).toBe("correctURL.png&scale=16 2x, correctURL.png&scale=8 4x, correctURL.png&scale=4 8x, correctURL.png&scale=2 16x, correctURL.png&scale=1 32x");
193
+ });
194
+
195
+ describe('quantizeReduce', () => {
196
+ const quantizeReduce = BookReader.prototype.quantizeReduce;
197
+ const SAMPLE_FACTORS = [
198
+ { reduce: 0.5 },
199
+ { reduce: 1 },
200
+ { reduce: 2 },
201
+ { reduce: 3 },
202
+ { reduce: 4 },
203
+ { reduce: 6 },
204
+ ];
205
+ test('Number larger than max', () => {
206
+ expect(quantizeReduce(10, SAMPLE_FACTORS)).toBe(6);
207
+ });
208
+
209
+ test('Number lower than max', () => {
210
+ expect(quantizeReduce(0.25, SAMPLE_FACTORS)).toBe(0.5);
211
+ });
212
+
213
+ test('Number directly between two reduction factors chooses first factor', () => {
214
+ expect(quantizeReduce(5, SAMPLE_FACTORS)).toBe(4);
215
+ });
216
+
217
+ test('Exact match', () => {
218
+ expect(quantizeReduce(2, SAMPLE_FACTORS)).toBe(2);
219
+ });
220
+
221
+ test('Closer to a lower boundary', () => {
222
+ expect(quantizeReduce(1.115, SAMPLE_FACTORS)).toBe(1);
223
+ });
224
+
225
+ test('Closer to an upper bound', () => {
226
+ expect(quantizeReduce(1.95, SAMPLE_FACTORS)).toBe(2);
227
+ });
228
+
229
+ test('Only one reduction factor', () => {
230
+ expect(quantizeReduce(17, [{reduce: 10}])).toBe(10);
231
+ });
232
+ });
233
+
234
+
235
+ describe('nextReduce', () => {
236
+ describe('Test matrix', () => {
237
+ const nextReduce = BookReader.prototype.nextReduce;
238
+ const SAMPLE_FACTORS = [
239
+ { reduce: 0.5 },
240
+ { reduce: 1 },
241
+ { reduce: 2 },
242
+ { reduce: 3 },
243
+ { reduce: 3.3, autofit: "width" },
244
+ { reduce: 4 },
245
+ { reduce: 6 },
246
+ { reduce: 6.1, autofit: "height" },
247
+ // auto doesn't get read by nextReduce (bug)
248
+ // It looks like width/height are set for 1up, and auto is set for 2up,
249
+ // and neither is set for thumb
250
+ { reduce: 6.2, autofit: "auto" }
251
+ ];
252
+
253
+ const currentReduces = [
254
+ { name: 'Exact match', value: 2 },
255
+ { name: 'In-between', value: 4.5 },
256
+ { name: '< Min', value: 0.25 },
257
+ { name: '> Max', value: 10 },
258
+
259
+ { name: '= Min', value: 0.5 },
260
+ { name: '= Max', value: 6.2 },
261
+ ];
262
+
263
+ const directions = [ 'in', 'out', 'width', 'height', 'auto' ];
264
+
265
+ const expectations = [
266
+ // currentReduces <->
267
+ // v^ directions
268
+ /* 2, 4.5, 0.25, 10, 0.5, 6.2 */
269
+ /* in */ [ 1, 4, 0.5, 6.2, 0.5, 6.1 ],
270
+ /* out */ [ 3, 6, 0.5, 6.2, 1, 6.2 ],
271
+ /* width */ [ 3.3, 3.3, 3.3, 3.3, 3.3, 3.3 ],
272
+ /* height */ [ 6.1, 6.1, 6.1, 6.1, 6.1, 6.1 ],
273
+ /* auto */ [ 6.2, 6.2, 6.2, 6.2, 6.2, 6.2 ],
274
+ ];
275
+
276
+ for (const [y, row] of expectations.entries()) {
277
+ for (const [x, expectedValue] of row.entries()) {
278
+ test(`${currentReduces[x].name} ${directions[y]}`, () => {
279
+ expect(nextReduce(currentReduces[x].value, directions[y], SAMPLE_FACTORS).reduce)
280
+ .toBe(expectedValue);
281
+ });
282
+ }
283
+ }
284
+ });
285
+
286
+ describe('No matching reduction', () => {
287
+ const nextReduce = BookReader.prototype.nextReduce;
288
+ const SAMPLE_FACTORS = [
289
+ { reduce: 0.5 },
290
+ { reduce: 1 },
291
+ { reduce: 2 },
292
+ { reduce: 3 },
293
+ ];
294
+
295
+ test('Returns first reduction when no match found', () => {
296
+ expect(nextReduce(2, 'width', SAMPLE_FACTORS).reduce).toBe(0.5);
297
+ expect(nextReduce(2, 'height', SAMPLE_FACTORS).reduce).toBe(0.5);
298
+ expect(nextReduce(2, 'auto', SAMPLE_FACTORS).reduce).toBe(0.5);
299
+ });
300
+ });
301
+ });
@@ -0,0 +1,75 @@
1
+ # TestCafe End to End (e2e) Testing
2
+
3
+ ## Running
4
+
5
+ To run all tests in all browsers currently specified, run
6
+
7
+ `npm run test:e2e`
8
+
9
+ The list of browsers TestCafe will attempt to use are stored in
10
+ `.testcaferc.json`.
11
+
12
+ The test runner will pick up any file within the tests/e2e directory or
13
+ subdirectories that ends in `test.js`. If you would like to abstract some code
14
+ and place it alongside the test fixtures, as long as the file name does not
15
+ end in this suffix, the test runner won't pick it up and attempt to set up a
16
+ test fixture.
17
+
18
+ ### Testing a specific browser
19
+
20
+ To run all tests in one or more specified browsers, supply the names of the
21
+ application executables after the command above. For example, if you only want
22
+ to run tests in Chrome, run `npm run test:e2e chrome`. To run
23
+ in both Chrome and Safari, run `npm run test:e2e chrome,safari`.
24
+
25
+ ### Testing in Chrome using device emulation
26
+
27
+ You can specify device presets or specify custom parameters for Chrome's
28
+ device emulation when starting tests. For example:
29
+
30
+ `npm run test:e2e "chrome:emulation:width=414;height=736;mobile=true;orientation=vertical;touch=true"`
31
+
32
+ ### Testing on remote devices
33
+
34
+ If you need to run tests on other devices like a phone, tablet, or other
35
+ computer, you can specify the number of browsers on the remote devices you'd
36
+ like to connect to the test runner. For example, to test Chrome on both a
37
+ phone and tablet, you'd specify '2' remote browsers. If you're only testing
38
+ on a phone, but are testing in Chrome and Safari, you'd also specify '2'.
39
+
40
+ `npm test:e2e remote:2`
41
+
42
+ This will provide you with a URL that you then visit in each browser. The URL
43
+ will look something like `http://127.0.0.1:52902/browser/connect`.
44
+
45
+ ### Running a specific fixture
46
+
47
+ To run a particular fixture, add the path to the file at the end of your arguments list.
48
+
49
+ `npm run test:e2e chrome tests/e2e/example.test.js`
50
+
51
+ ## Pending (skip) tests
52
+
53
+ You can skip any tests by calling the method `.skip` on the test object rather
54
+ than call the test function directly. If you have a test definition like:
55
+
56
+ ```
57
+ test('Subnav opened when primary nav category clicked', async (t) => {
58
+ const textsTophat = Selector('.row.texts');
59
+ await t.expect(await textsTophat.visible).notOk();
60
+ await t.click('[data-top-kind=texts]');
61
+ await t.expect(await textsTophat.visible).ok();
62
+ });
63
+ ```
64
+
65
+ You would skip it by changing the `test` call to `test.skip`.
66
+
67
+ ## Running only one test
68
+
69
+ Similarly, you can use the `.only` method to skip all other tests and only run
70
+ the one specified.
71
+
72
+ ```
73
+ test.only('Subnav opened when primary nav category clicked', async (t) => {
74
+ ```
75
+
@@ -0,0 +1,13 @@
1
+ import { ClientFunction } from 'testcafe';
2
+
3
+ const { BASE_URL } = process.env;
4
+ const getLocationHref = ClientFunction(() => window.location.href.toString());
5
+ const FLIP_SPEED = 1000;
6
+ const FIRST_PAGE_DELAY = 2000;
7
+
8
+ fixture `Autoplay plugin`.page `${BASE_URL}demo-autoplay.html`;
9
+
10
+ test('page auto-advances after allotted flip speed and delay', async t => {
11
+ await t.wait(2 * FLIP_SPEED + FIRST_PAGE_DELAY);
12
+ await t.expect(getLocationHref()).match(/page\/n3/);
13
+ });
@@ -0,0 +1,35 @@
1
+ import { runBaseTests } from './helpers/base';
2
+ import BookReader from './models/BookReader';
3
+ import { runDesktopSearchTests } from './helpers/desktopSearch';
4
+ // import { runMobileSearchTests } from './helpers/mobileSearch';
5
+
6
+
7
+ const { BASE_URL } = process.env;
8
+ const OCAIDS = [
9
+ 'theworksofplato01platiala',
10
+ // Removed because failing test 'Canonical URL with cookie shows paramters'
11
+ // in tests/e2e/helpers/base.js
12
+ // Cookie path should be:
13
+ // /BookReaderDemo/demo-ia-olivertwist.html
14
+ // Cookie path is:
15
+ // /BookReaderDemo/demo-ia-olivertwist.html/page/n13/mode/2up
16
+ // 'demo-ia-olivertwist.html',
17
+ ];
18
+ const DEMO_PATH = 'demo-internetarchive.html?ocaid=';
19
+
20
+ OCAIDS.forEach(ocaid => {
21
+ const url = `${BASE_URL}${DEMO_PATH }${ocaid}`;
22
+
23
+ fixture `Base Tests for: ${ocaid}`.page `${url}`;
24
+ runBaseTests(new BookReader());
25
+
26
+ fixture `Desktop Search Tests for: ${ocaid}`
27
+ .page `${url}`;
28
+ runDesktopSearchTests(new BookReader());
29
+
30
+ // fixture `Mobile Search Tests for: ${ocaid}`
31
+ // .page `${url}`
32
+ // runMobileSearchTests(new BookReader());
33
+
34
+
35
+ });
@@ -0,0 +1,263 @@
1
+ import { ClientFunction, Selector } from 'testcafe';
2
+
3
+ const PAGE_FLIP_WAIT_TIME = 1000;
4
+
5
+ const getHash = ClientFunction(() => document.location.hash);
6
+ const getUrl = ClientFunction(() => window.location.href);
7
+
8
+ /**
9
+ * Check URL page parameter in # and path
10
+ */
11
+ const isPageInUrl = ClientFunction(() => {
12
+ const hash = document.location.hash;
13
+ if (hash) {
14
+ return hash.indexOf('#page/') > -1;
15
+ } else {
16
+ return window.location.href.indexOf('/page/') > -1;
17
+ }
18
+ });
19
+
20
+ /**
21
+ * Check URL mode parameter in # and path
22
+ *
23
+ * @param mode '1up', '2up', 'thumb'
24
+ */
25
+ const isModeInUrl = ClientFunction((mode) => {
26
+ const hash = document.location.hash;
27
+ if (hash) {
28
+ return hash.indexOf('/mode/' + mode) > -1;
29
+ } else {
30
+ return window.location.href.indexOf('/mode/' + mode) > -1;
31
+ }
32
+ });
33
+
34
+ /**
35
+ * Runs all expected base tests for BookReader
36
+ *
37
+ * @param { import('../models/BookReader').default } br - Model
38
+ */
39
+ export function runBaseTests (br) {
40
+ test('On load, pages fit fully inside of the BookReader™', async t => {
41
+ await t.expect(br.shell.visible).ok();
42
+ await t.expect(br.BRcontainer.visible).ok();
43
+
44
+ const shellHeight = await br.shell.getBoundingClientRectProperty('height');
45
+ const bookHeight = await br.BRcontainer.getBoundingClientRectProperty('height');
46
+ await t.expect(bookHeight).lte(shellHeight, 'images do not get cropped vertically');
47
+
48
+ const shellWidth = await br.shell.getBoundingClientRectProperty('width');
49
+ const bookWidth = await br.BRcontainer.getBoundingClientRectProperty('width');
50
+ await t.expect(bookWidth).lte(shellWidth, 'images do not get cropped horizontally');
51
+ });
52
+
53
+ test('nav menu displays properly', async t => {
54
+ const { nav } = br;
55
+
56
+ await t.expect(nav.desktop.goLeft.visible).ok();
57
+ await t.expect(nav.desktop.goRight.visible).ok();
58
+ await t.expect(nav.desktop.mode1Up.visible).ok();
59
+ await t.expect(nav.desktop.mode2Up.visible).ok();
60
+ await t.expect(nav.desktop.modeThumb.visible).ok();
61
+ await t.expect(nav.desktop.zoomIn.visible).ok();
62
+ await t.expect(nav.desktop.zoomOut.visible).ok();
63
+ await t.expect(nav.desktop.fullScreen.visible).ok();
64
+ });
65
+
66
+ test("Canonical URL has no initial parameters", async t => {
67
+ // Initial URL has no params
68
+ await t.expect(getHash()).eql('');
69
+ // Initial URL has no page/ mode/
70
+ await t.expect(getUrl()).notContains('#page/');
71
+ await t.expect(getUrl()).notContains('/page/');
72
+ await t.expect(getUrl()).notContains('/mode/');
73
+ });
74
+
75
+ // Need to disable page caching to have cookies persist in test
76
+ test.disablePageCaching('Canonical URL shows parameters if cookie set', async t => {
77
+ const { nav } = br;
78
+
79
+ // Check if uses plugin.resume.js
80
+ const usesResume = ClientFunction(() => {
81
+ const hasResumePlugin = typeof(br.getResumeValue) !== "undefined";
82
+ const hasResumeValue = hasResumePlugin ? br.getResumeValue() : false;
83
+ return hasResumeValue;
84
+ });
85
+
86
+ // Store initial URL
87
+ const initialUrl = await getUrl();
88
+
89
+ // Set Cookie by page navigation, wait for cookie
90
+ await t.click(nav.desktop.goNext);
91
+ await t.wait(PAGE_FLIP_WAIT_TIME);
92
+
93
+ // reload canonical URL, wait for URL change
94
+ await t.navigateTo(initialUrl);
95
+ await t.wait(PAGE_FLIP_WAIT_TIME);
96
+
97
+ if (await usesResume()) {
98
+ await t.expect(isPageInUrl()).eql(true, initialUrl);
99
+ await t.expect(isModeInUrl('2up')).eql(true, initialUrl);
100
+ } else {
101
+ // No plugin, no br-resume cookie
102
+ await t.expect(getUrl()).notContains('#page/');
103
+ await t.expect(getUrl()).notContains('/page/');
104
+ await t.expect(getUrl()).notContains('/mode/');
105
+ }
106
+ });
107
+
108
+ test('2up mode - Clicking `Previous page` changes the page', async t => {
109
+ const { nav, BRcontainer} = br;
110
+
111
+ // Go to next page, so we can go previous if at front cover
112
+ await t.click(nav.desktop.goNext);
113
+ await t.wait(PAGE_FLIP_WAIT_TIME);
114
+ await t.click(nav.desktop.goNext);
115
+ await t.wait(PAGE_FLIP_WAIT_TIME);
116
+
117
+ const onLoadBrState = BRcontainer.child(0);
118
+ const initialImages = onLoadBrState.find('img');
119
+ const origImg1Src = await initialImages.nth(0).getAttribute('src');
120
+ const origImg2Src = await initialImages.nth(-1).getAttribute('src');
121
+
122
+ await t.click(nav.desktop.goPrev);
123
+ await t.wait(PAGE_FLIP_WAIT_TIME);
124
+
125
+ const nextBrState = Selector('.BRcontainer').child(0);
126
+ const prevImages = nextBrState.find('img');
127
+ const prevImg1Src = await prevImages.nth(0).getAttribute('src');
128
+ const prevImg2Src = await prevImages.nth(-1).getAttribute('src');
129
+
130
+ // we aren't showing the same image in both leaves
131
+ await t.expect(origImg1Src).notEql(origImg2Src);
132
+
133
+ // we are showing new pages
134
+ await t.expect(prevImg1Src).notEql(origImg1Src);
135
+ await t.expect(prevImg1Src).notEql(origImg2Src);
136
+ await t.expect(prevImg2Src).notEql(origImg1Src);
137
+ await t.expect(prevImg2Src).notEql(origImg2Src);
138
+
139
+ // we aren't showing the same image in the new pages
140
+ await t.expect(prevImg1Src).notEql(prevImg2Src);
141
+ });
142
+
143
+ test('2up mode - Clicking `Next page` changes the page', async t => {
144
+ // Note: this will fail on a R to L book if at front cover
145
+ const { nav, BRcontainer} = br;
146
+ // Flip away from cover
147
+ await t.click(nav.desktop.goNext);
148
+ await t.wait(PAGE_FLIP_WAIT_TIME);
149
+
150
+ const onLoadBrState = BRcontainer.child(0);
151
+ const initialImages = onLoadBrState.find('img');
152
+ const origImg1Src = await initialImages.nth(0).getAttribute('src');
153
+ const origImg2Src = await initialImages.nth(-1).getAttribute('src');
154
+
155
+ await t.click(nav.desktop.goNext);
156
+ await t.wait(PAGE_FLIP_WAIT_TIME);
157
+
158
+ const nextBrState = Selector('.BRcontainer').child(0);
159
+ const nextImages = nextBrState.find('img');
160
+ const nextImg1Src = await nextImages.nth(0).getAttribute('src');
161
+ const nextImg2Src = await nextImages.nth(-1).getAttribute('src');
162
+
163
+ // we are showing new pages
164
+ await t.expect(nextImg1Src).notEql(origImg1Src);
165
+ await t.expect(nextImg1Src).notEql(origImg2Src);
166
+ await t.expect(nextImg2Src).notEql(origImg1Src);
167
+ await t.expect(nextImg2Src).notEql(origImg2Src);
168
+
169
+ // we aren't showing the same image in the new pages
170
+ await t.expect(nextImg1Src).notEql(nextImg2Src);
171
+ });
172
+
173
+ test('Clicking `page flip buttons` updates location', async t => {
174
+ const { nav } = br;
175
+ // Page navigation creates params
176
+ await t.click(nav.desktop.goNext);
177
+ await t.expect(isPageInUrl()).eql(true);
178
+ await t.expect(isModeInUrl('2up')).eql(true);
179
+
180
+ await t.click(nav.desktop.goPrev);
181
+ await t.expect(isPageInUrl()).eql(true);
182
+ await t.expect(isModeInUrl('2up')).eql(true);
183
+ });
184
+
185
+ test('Clicking `2 page view` brings up 2 pages at a time', async t => {
186
+ const { nav } = br;
187
+ await t.click(nav.desktop.mode2Up);
188
+ await t.expect(Selector('.BRpagecontainer').count).eql(2);
189
+ });
190
+
191
+ test('Clicking `1 page view` brings up 1 at a time', async t => {
192
+ const { nav } = br;
193
+ await t.click(nav.desktop.mode1Up);
194
+
195
+ // Flip away from cover
196
+ await t.click(nav.desktop.goNext);
197
+ await t.wait(PAGE_FLIP_WAIT_TIME);
198
+
199
+ // we usually pre-fetch the page in question & the 2 after it
200
+ await t.expect(Selector('.BRpagecontainer').count).gte(3);
201
+ });
202
+
203
+ test('Clicking `thumbnail view` brings up all of the page thumbnails', async t => {
204
+ const { nav } = br;
205
+ await t.click(nav.desktop.modeThumb);
206
+ await t.expect(Selector('.BRpagecontainer').count).gte(3);
207
+ });
208
+
209
+ test('Clicking `zoom out` makes book smaller', async t => {
210
+ const { nav, BRcontainer } = br;
211
+ const book = BRcontainer.child(0);
212
+
213
+ await t.expect(br.BRcontainer.visible).ok();
214
+ await t.expect(book.visible).ok();
215
+ await t.expect(nav.desktop.zoomOut.visible).ok();
216
+
217
+ const initialBookHeight = await book.getBoundingClientRectProperty('height');
218
+ const initialBookWidth = await book.getBoundingClientRectProperty('width');
219
+
220
+ await t.click(nav.desktop.zoomOut);
221
+
222
+ const zoomOutBookHeight = await book.getBoundingClientRectProperty('height');
223
+ const zoomOutBookWidth = await book.getBoundingClientRectProperty('width');
224
+
225
+ await t.expect(zoomOutBookHeight).lte(initialBookHeight);
226
+ await t.expect(zoomOutBookWidth).lte(initialBookWidth);
227
+ });
228
+
229
+ test('Clicking `zoom in` makes book larger', async t => {
230
+ const { nav, BRcontainer } = br;
231
+
232
+ const book = await BRcontainer.child(0);
233
+
234
+ await t.expect(BRcontainer.visible).ok();
235
+ await t.expect(book.visible).ok();
236
+ await t.expect(nav.desktop.zoomIn.visible).ok();
237
+
238
+ const initialBookHeight = await book.getBoundingClientRectProperty('height');
239
+ const initialBookWidth = await book.getBoundingClientRectProperty('width');
240
+
241
+ await t.click(nav.desktop.zoomIn);
242
+
243
+ const zoomInBookHeight = await book.getBoundingClientRectProperty('height');
244
+ const zoomIntBookWidth = await book.getBoundingClientRectProperty('width');
245
+
246
+ await t.expect(zoomInBookHeight).gt(initialBookHeight);
247
+ await t.expect(zoomIntBookWidth).gt(initialBookWidth);
248
+ });
249
+
250
+ test('Clicking `full screen button` and BookReader fills browser window', async (t) => {
251
+ const { nav, BRcontainer } = br;
252
+ const windowWidth = await ClientFunction(() => window.innerWidth)();
253
+
254
+ // initial in-page
255
+ await t.expect(BRcontainer.getBoundingClientRectProperty('width')).lte(windowWidth);
256
+ await t.click(nav.desktop.fullScreen);
257
+ // full screen
258
+ await t.expect(BRcontainer.getBoundingClientRectProperty('width')).eql(windowWidth);
259
+ await t.click(nav.desktop.fullScreen);
260
+ // in-page
261
+ await t.expect(BRcontainer.getBoundingClientRectProperty('width')).lte(windowWidth);
262
+ });
263
+ }