@internetarchive/bookreader 5.0.0-6-14 → 5.0.0-60

Sign up to get free protection for your applications and to get access to all the features.
Files changed (271) hide show
  1. package/.eslintrc.js +17 -15
  2. package/.github/workflows/node.js.yml +72 -10
  3. package/.github/workflows/npm-publish.yml +6 -20
  4. package/.testcaferc.js +10 -0
  5. package/BookReader/BookReader.css +241 -140
  6. package/BookReader/BookReader.js +1 -1
  7. package/BookReader/BookReader.js.LICENSE.txt +24 -20
  8. package/BookReader/BookReader.js.map +1 -1
  9. package/BookReader/ia-bookreader-bundle.js +1519 -0
  10. package/BookReader/ia-bookreader-bundle.js.LICENSE.txt +17 -0
  11. package/BookReader/ia-bookreader-bundle.js.map +1 -0
  12. package/BookReader/icons/close-circle-dark.svg +1 -0
  13. package/BookReader/icons/magnify-minus.svg +1 -1
  14. package/BookReader/icons/magnify-plus.svg +1 -1
  15. package/BookReader/icons/pause.svg +1 -1
  16. package/BookReader/icons/playback-speed.svg +1 -1
  17. package/BookReader/icons/read-aloud.svg +1 -1
  18. package/BookReader/icons/voice.svg +1 -0
  19. package/BookReader/images/BRicons.svg +2 -2
  20. package/BookReader/images/books_graphic.svg +1 -1
  21. package/BookReader/images/icon_book.svg +1 -1
  22. package/BookReader/images/icon_gear.svg +1 -1
  23. package/BookReader/images/icon_info.svg +1 -1
  24. package/BookReader/images/icon_playback-rate.svg +1 -1
  25. package/BookReader/images/icon_search_button.svg +1 -1
  26. package/BookReader/images/icon_share.svg +1 -1
  27. package/BookReader/images/icon_speaker.svg +1 -1
  28. package/BookReader/images/icon_speaker_open.svg +1 -1
  29. package/BookReader/images/marker_chap-off.svg +1 -1
  30. package/BookReader/images/marker_chap-on.svg +1 -1
  31. package/BookReader/images/marker_srch-on.svg +1 -1
  32. package/BookReader/jquery-3.js +2 -0
  33. package/BookReader/jquery-3.js.LICENSE.txt +24 -0
  34. package/BookReader/plugins/plugin.archive_analytics.js +1 -1
  35. package/BookReader/plugins/plugin.archive_analytics.js.map +1 -1
  36. package/BookReader/plugins/plugin.autoplay.js +1 -1
  37. package/BookReader/plugins/plugin.autoplay.js.map +1 -1
  38. package/BookReader/plugins/plugin.chapters.js +1 -1
  39. package/BookReader/plugins/plugin.chapters.js.map +1 -1
  40. package/BookReader/plugins/plugin.iframe.js +1 -1
  41. package/BookReader/plugins/plugin.iframe.js.map +1 -1
  42. package/BookReader/plugins/plugin.mobile_nav.js +1 -1
  43. package/BookReader/plugins/plugin.mobile_nav.js.map +1 -1
  44. package/BookReader/plugins/plugin.resume.js +1 -1
  45. package/BookReader/plugins/plugin.resume.js.map +1 -1
  46. package/BookReader/plugins/plugin.search.js +1 -1
  47. package/BookReader/plugins/plugin.search.js.map +1 -1
  48. package/BookReader/plugins/plugin.text_selection.js +1 -1
  49. package/BookReader/plugins/plugin.text_selection.js.map +1 -1
  50. package/BookReader/plugins/plugin.tts.js +1 -1
  51. package/BookReader/plugins/plugin.tts.js.map +1 -1
  52. package/BookReader/plugins/plugin.url.js +1 -1
  53. package/BookReader/plugins/plugin.url.js.map +1 -1
  54. package/BookReader/plugins/plugin.vendor-fullscreen.js +1 -1
  55. package/BookReader/plugins/plugin.vendor-fullscreen.js.map +1 -1
  56. package/BookReader/webcomponents-bundle.js +3 -0
  57. package/BookReader/webcomponents-bundle.js.LICENSE.txt +9 -0
  58. package/BookReader/webcomponents-bundle.js.map +1 -0
  59. package/BookReaderDemo/BookReaderDemo.css +14 -1
  60. package/BookReaderDemo/BookReaderJSAutoplay.js +4 -1
  61. package/BookReaderDemo/BookReaderJSSimple.js +1 -0
  62. package/BookReaderDemo/IADemoBr.js +147 -0
  63. package/BookReaderDemo/demo-advanced.html +2 -2
  64. package/BookReaderDemo/demo-autoplay.html +2 -1
  65. package/BookReaderDemo/demo-embed-iframe-src.html +2 -1
  66. package/BookReaderDemo/demo-fullscreen-mobile.html +2 -1
  67. package/BookReaderDemo/demo-fullscreen.html +2 -1
  68. package/BookReaderDemo/demo-iiif.html +2 -1
  69. package/BookReaderDemo/demo-internetarchive.html +84 -17
  70. package/BookReaderDemo/demo-multiple.html +2 -1
  71. package/BookReaderDemo/demo-preview-pages.html +2 -1
  72. package/BookReaderDemo/demo-simple.html +2 -1
  73. package/BookReaderDemo/demo-vendor-fullscreen.html +2 -1
  74. package/BookReaderDemo/ia-multiple-volumes-manifest.js +170 -0
  75. package/BookReaderDemo/immersion-1up.html +2 -1
  76. package/BookReaderDemo/immersion-mode.html +2 -1
  77. package/BookReaderDemo/toggle_controls.html +2 -1
  78. package/BookReaderDemo/view_mode.html +2 -1
  79. package/BookReaderDemo/viewmode-cycle.html +2 -3
  80. package/CHANGELOG.md +244 -0
  81. package/README.md +14 -1
  82. package/babel.config.js +19 -0
  83. package/codecov.yml +6 -0
  84. package/index.html +3 -0
  85. package/jsconfig.json +19 -0
  86. package/netlify.toml +5 -0
  87. package/package.json +70 -59
  88. package/renovate.json +52 -0
  89. package/scripts/preversion.js +4 -1
  90. package/src/BookNavigator/assets/bookmark-colors.js +1 -1
  91. package/src/BookNavigator/assets/button-base.js +9 -2
  92. package/src/BookNavigator/assets/ia-logo.js +17 -0
  93. package/src/BookNavigator/assets/icon_checkmark.js +1 -1
  94. package/src/BookNavigator/assets/icon_close.js +1 -1
  95. package/src/BookNavigator/assets/icon_sort_asc.js +5 -0
  96. package/src/BookNavigator/assets/icon_sort_desc.js +5 -0
  97. package/src/BookNavigator/assets/icon_sort_neutral.js +5 -0
  98. package/src/BookNavigator/assets/icon_volumes.js +11 -0
  99. package/src/BookNavigator/book-navigator.js +585 -0
  100. package/src/BookNavigator/bookmarks/bookmark-button.js +3 -2
  101. package/src/BookNavigator/bookmarks/bookmark-edit.js +3 -4
  102. package/src/BookNavigator/bookmarks/bookmarks-list.js +2 -3
  103. package/src/BookNavigator/bookmarks/bookmarks-loginCTA.js +3 -8
  104. package/src/BookNavigator/bookmarks/bookmarks-provider.js +27 -17
  105. package/src/BookNavigator/bookmarks/ia-bookmarks.js +116 -67
  106. package/src/BookNavigator/delete-modal-actions.js +1 -1
  107. package/src/BookNavigator/downloads/downloads-provider.js +36 -21
  108. package/src/BookNavigator/downloads/downloads.js +41 -25
  109. package/src/BookNavigator/search/search-provider.js +80 -28
  110. package/src/BookNavigator/search/search-results.js +34 -25
  111. package/src/BookNavigator/sharing.js +27 -0
  112. package/src/BookNavigator/visual-adjustments/visual-adjustments-provider.js +11 -10
  113. package/src/BookNavigator/visual-adjustments/visual-adjustments.js +3 -3
  114. package/src/BookNavigator/volumes/volumes-provider.js +111 -0
  115. package/src/BookNavigator/volumes/volumes.js +188 -0
  116. package/src/BookReader/BookModel.js +59 -30
  117. package/src/BookReader/DebugConsole.js +3 -3
  118. package/src/BookReader/DragScrollable.js +233 -0
  119. package/src/BookReader/Mode1Up.js +56 -351
  120. package/src/BookReader/Mode1UpLit.js +391 -0
  121. package/src/BookReader/Mode2Up.js +73 -1318
  122. package/src/BookReader/Mode2UpLit.js +781 -0
  123. package/src/BookReader/ModeCoordinateSpace.js +29 -0
  124. package/src/BookReader/ModeSmoothZoom.js +211 -0
  125. package/src/BookReader/ModeThumb.js +17 -11
  126. package/src/BookReader/Navbar/Navbar.js +10 -36
  127. package/src/BookReader/PageContainer.js +69 -6
  128. package/src/BookReader/ReduceSet.js +1 -1
  129. package/src/BookReader/Toolbar/Toolbar.js +10 -37
  130. package/src/BookReader/events.js +2 -0
  131. package/src/BookReader/options.js +24 -2
  132. package/src/BookReader/utils/HTMLDimensionsCacher.js +44 -0
  133. package/src/BookReader/utils/ScrollClassAdder.js +31 -0
  134. package/src/BookReader/utils.js +108 -13
  135. package/src/BookReader.js +481 -828
  136. package/src/assets/icons/close-circle-dark.svg +1 -0
  137. package/src/assets/icons/magnify-minus.svg +3 -7
  138. package/src/assets/icons/magnify-plus.svg +3 -7
  139. package/src/assets/icons/voice.svg +1 -0
  140. package/src/css/_BRBookmarks.scss +1 -1
  141. package/src/css/_BRComponent.scss +1 -1
  142. package/src/css/_BRmain.scss +33 -0
  143. package/src/css/_BRnav.scss +4 -26
  144. package/src/css/_BRpages.scss +147 -40
  145. package/src/css/_BRsearch.scss +25 -11
  146. package/src/css/_TextSelection.scss +16 -17
  147. package/src/css/_colorbox.scss +2 -2
  148. package/src/css/_controls.scss +17 -5
  149. package/src/css/_icons.scss +7 -1
  150. package/src/ia-bookreader/ia-bookreader.js +224 -0
  151. package/src/plugins/plugin.archive_analytics.js +3 -3
  152. package/src/plugins/plugin.autoplay.js +4 -9
  153. package/src/plugins/plugin.chapters.js +28 -35
  154. package/src/plugins/plugin.mobile_nav.js +11 -10
  155. package/src/plugins/plugin.resume.js +3 -3
  156. package/src/plugins/plugin.text_selection.js +32 -41
  157. package/src/plugins/plugin.vendor-fullscreen.js +4 -4
  158. package/src/plugins/search/plugin.search.js +179 -103
  159. package/src/plugins/search/view.js +59 -44
  160. package/src/plugins/tts/AbstractTTSEngine.js +46 -37
  161. package/src/plugins/tts/FestivalTTSEngine.js +13 -14
  162. package/src/plugins/tts/PageChunk.js +15 -21
  163. package/src/plugins/tts/PageChunkIterator.js +8 -12
  164. package/src/plugins/tts/WebTTSEngine.js +87 -71
  165. package/src/plugins/tts/plugin.tts.js +94 -125
  166. package/src/plugins/tts/utils.js +0 -25
  167. package/src/plugins/url/UrlPlugin.js +193 -0
  168. package/src/plugins/{plugin.url.js → url/plugin.url.js} +45 -16
  169. package/src/util/docCookies.js +21 -2
  170. package/tests/e2e/README.md +37 -0
  171. package/tests/e2e/autoplay.test.js +2 -2
  172. package/tests/e2e/base.test.js +7 -7
  173. package/tests/e2e/helpers/base.js +28 -23
  174. package/tests/e2e/helpers/debug.js +1 -1
  175. package/tests/e2e/helpers/desktopSearch.js +14 -13
  176. package/tests/e2e/helpers/mobileSearch.js +3 -3
  177. package/tests/e2e/helpers/params.js +17 -0
  178. package/tests/e2e/helpers/rightToLeft.js +4 -10
  179. package/tests/e2e/models/Navigation.js +13 -4
  180. package/tests/e2e/rightToLeft.test.js +4 -5
  181. package/tests/e2e/viewmode.test.js +40 -33
  182. package/tests/jest/BookNavigator/book-navigator.test.js +658 -0
  183. package/tests/jest/BookNavigator/bookmarks/bookmark-button.test.js +43 -0
  184. package/tests/{karma → jest}/BookNavigator/bookmarks/bookmark-edit.test.js +25 -26
  185. package/tests/{karma → jest}/BookNavigator/bookmarks/bookmarks-list.test.js +41 -42
  186. package/tests/jest/BookNavigator/bookmarks/ia-bookmarks.test.js +45 -0
  187. package/tests/jest/BookNavigator/downloads/downloads-provider.test.js +67 -0
  188. package/tests/jest/BookNavigator/downloads/downloads.test.js +53 -0
  189. package/tests/jest/BookNavigator/search/search-provider.test.js +167 -0
  190. package/tests/{karma/BookNavigator → jest/BookNavigator/search}/search-results.test.js +104 -60
  191. package/tests/jest/BookNavigator/sharing/sharing-provider.test.js +49 -0
  192. package/tests/jest/BookNavigator/visual-adjustments.test.js +200 -0
  193. package/tests/jest/BookNavigator/volumes/volumes-provider.test.js +184 -0
  194. package/tests/jest/BookNavigator/volumes/volumes.test.js +97 -0
  195. package/tests/{BookReader → jest/BookReader}/BookModel.test.js +59 -14
  196. package/tests/jest/BookReader/BookReaderPublicFunctions.test.js +193 -0
  197. package/tests/{BookReader → jest/BookReader}/DebugConsole.test.js +1 -1
  198. package/tests/{BookReader → jest/BookReader}/ImageCache.test.js +4 -4
  199. package/tests/jest/BookReader/Mode1UpLit.test.js +73 -0
  200. package/tests/jest/BookReader/Mode2Up.test.js +98 -0
  201. package/tests/jest/BookReader/Mode2UpLit.test.js +190 -0
  202. package/tests/jest/BookReader/ModeCoordinateSpace.test.js +16 -0
  203. package/tests/jest/BookReader/ModeSmoothZoom.test.js +175 -0
  204. package/tests/jest/BookReader/ModeThumb.test.js +71 -0
  205. package/tests/{BookReader → jest/BookReader}/Navbar/Navbar.test.js +10 -10
  206. package/tests/{BookReader → jest/BookReader}/PageContainer.test.js +88 -6
  207. package/tests/{BookReader → jest/BookReader}/ReduceSet.test.js +1 -1
  208. package/tests/{BookReader → jest/BookReader}/Toolbar/Toolbar.test.js +2 -2
  209. package/tests/jest/BookReader/utils/HTMLDimensionsCacher.test.js +59 -0
  210. package/tests/jest/BookReader/utils/ScrollClassAdder.test.js +49 -0
  211. package/tests/{BookReader → jest/BookReader}/utils/classes.test.js +1 -1
  212. package/tests/jest/BookReader/utils.test.js +217 -0
  213. package/tests/jest/BookReader.keyboard.test.js +190 -0
  214. package/tests/{BookReader.options.test.js → jest/BookReader.options.test.js} +9 -1
  215. package/tests/{BookReader.test.js → jest/BookReader.test.js} +26 -37
  216. package/tests/{plugins → jest/plugins}/plugin.archive_analytics.test.js +2 -2
  217. package/tests/{plugins → jest/plugins}/plugin.autoplay.test.js +4 -4
  218. package/tests/{plugins → jest/plugins}/plugin.chapters.test.js +10 -11
  219. package/tests/{plugins → jest/plugins}/plugin.iframe.test.js +2 -2
  220. package/tests/{plugins → jest/plugins}/plugin.mobile_nav.test.js +5 -5
  221. package/tests/{plugins → jest/plugins}/plugin.resume.test.js +3 -3
  222. package/tests/{plugins → jest/plugins}/plugin.text_selection.test.js +39 -47
  223. package/tests/{plugins → jest/plugins}/plugin.vendor-fullscreen.test.js +2 -2
  224. package/tests/{plugins → jest/plugins}/search/plugin.search.test.js +57 -47
  225. package/tests/{plugins → jest/plugins}/search/plugin.search.view.test.js +35 -6
  226. package/tests/{plugins → jest/plugins}/tts/AbstractTTSEngine.test.js +9 -9
  227. package/tests/{plugins → jest/plugins}/tts/FestivalTTSEngine.test.js +4 -4
  228. package/tests/{plugins → jest/plugins}/tts/PageChunk.test.js +1 -1
  229. package/tests/{plugins → jest/plugins}/tts/PageChunkIterator.test.js +3 -3
  230. package/tests/{plugins → jest/plugins}/tts/WebTTSEngine.test.js +47 -1
  231. package/tests/{plugins → jest/plugins}/tts/utils.test.js +1 -60
  232. package/tests/jest/plugins/url/UrlPlugin.test.js +190 -0
  233. package/tests/{plugins → jest/plugins/url}/plugin.url.test.js +53 -14
  234. package/tests/jest/setup.js +3 -0
  235. package/tests/{util → jest/util}/browserSniffing.test.js +1 -1
  236. package/tests/jest/util/docCookies.test.js +24 -0
  237. package/tests/{util → jest/util}/strings.test.js +1 -1
  238. package/tests/{utils.js → jest/utils.js} +38 -0
  239. package/webpack.config.js +11 -5
  240. package/.babelrc +0 -12
  241. package/.dependabot/config.yml +0 -6
  242. package/.testcaferc.json +0 -5
  243. package/BookReader/bookreader-component-bundle.js +0 -1450
  244. package/BookReader/bookreader-component-bundle.js.LICENSE.txt +0 -38
  245. package/BookReader/bookreader-component-bundle.js.map +0 -1
  246. package/BookReader/jquery-1.10.1.js +0 -2
  247. package/BookReader/jquery-1.10.1.js.LICENSE.txt +0 -24
  248. package/BookReader/plugins/plugin.menu_toggle.js +0 -2
  249. package/BookReader/plugins/plugin.menu_toggle.js.map +0 -1
  250. package/BookReaderDemo/bookreader-template-bundle.js +0 -7178
  251. package/BookReaderDemo/demo-plugin-menu-toggle.html +0 -34
  252. package/karma.conf.js +0 -23
  253. package/src/BookNavigator/BookModel.js +0 -14
  254. package/src/BookNavigator/BookNavigator.js +0 -438
  255. package/src/BookNavigator/assets/book-loader.js +0 -27
  256. package/src/BookNavigator/br-fullscreen-mgr.js +0 -83
  257. package/src/BookNavigator/search/a-search-result.js +0 -55
  258. package/src/BookReaderComponent/BookReaderComponent.js +0 -112
  259. package/src/ItemNavigator/ItemNavigator.js +0 -372
  260. package/src/ItemNavigator/providers/sharing.js +0 -29
  261. package/src/dragscrollable-br.js +0 -261
  262. package/src/plugins/menu_toggle/plugin.menu_toggle.js +0 -324
  263. package/tests/BookReader/BookReaderPublicFunctions.test.js +0 -171
  264. package/tests/BookReader/Mode1Up.test.js +0 -164
  265. package/tests/BookReader/Mode2Up.test.js +0 -247
  266. package/tests/BookReader/utils.test.js +0 -109
  267. package/tests/e2e/ia-production/ia-prod-base.js +0 -17
  268. package/tests/karma/BookNavigator/book-navigator.test.js +0 -132
  269. package/tests/karma/BookNavigator/visual-adjustments.test.js +0 -201
  270. package/tests/plugins/menu_toggle/plugin.menu_toggle.test.js +0 -68
  271. package/tests/util/docCookies.test.js +0 -15
@@ -1,171 +0,0 @@
1
- import BookReader from '../../src/BookReader';
2
-
3
- beforeAll(() => {
4
- global.alert = jest.fn();
5
- })
6
- afterEach(() => {
7
- jest.restoreAllMocks();
8
- });
9
-
10
- describe('BookReader.prototype.toggleFullscreen', () => {
11
- test('uses `isFullscreen` to check fullscreen state', () => {
12
- const isFSmock = jest.fn();
13
- isFSmock.mockReturnValueOnce(false);
14
- const br = new BookReader();
15
- br.mode = br.constMode1up;
16
- br.enterFullscreen = jest.fn();
17
- br.isFullscreen = isFSmock;
18
-
19
- br.toggleFullscreen();
20
- expect(br.isFullscreen).toHaveBeenCalled();
21
- expect(br.isFullscreen).toHaveBeenCalled();
22
- });
23
-
24
- test('will always emit an event', () => {
25
- const br = new BookReader();
26
- br.mode = br.constMode1up;
27
- br.enterFullscreen = jest.fn();
28
- br.trigger = jest.fn();
29
- br.refs.$brContainer = {
30
- css: jest.fn(),
31
- animate: jest.fn()
32
- }
33
-
34
- br.toggleFullscreen();
35
- expect(br.enterFullscreen).toHaveBeenCalled();
36
- });
37
-
38
- test('will start with opening fullscreen', () => {
39
- const br = new BookReader();
40
- br.mode = br.constMode1up;
41
- br.enterFullscreen = jest.fn();
42
-
43
- br.toggleFullscreen();
44
- expect(br.enterFullscreen).toHaveBeenCalled();
45
- });
46
-
47
- test('will close fullscreen if BookReader is in fullscreen', () => {
48
- const br = new BookReader();
49
- br.mode = br.constMode1up;
50
- br.exitFullScreen = jest.fn();
51
- br.isFullscreenActive = true;
52
-
53
- br.toggleFullscreen();
54
- expect(br.exitFullScreen).toHaveBeenCalled();
55
- });
56
- });
57
-
58
- describe('BookReader.prototype.enterFullscreen', () => {
59
- test('will bind `_fullscreenCloseHandler` by default', () => {
60
- const br = new BookReader();
61
- br.mode = br.constMode1up;
62
- br.switchMode = jest.fn();
63
- br.updateBrClasses = jest.fn();
64
- br.refs.$brContainer = {
65
- css: jest.fn(),
66
- animate: jest.fn(),
67
- };
68
- expect(br._fullscreenCloseHandler).toBeUndefined();
69
-
70
- br.enterFullscreen();
71
- expect(br._fullscreenCloseHandler).toBeDefined();
72
- });
73
-
74
- test('fires certain events when called', () => {
75
- const br = new BookReader();
76
- br.mode = br.constMode1up;
77
- br.switchMode = jest.fn();
78
- br.updateBrClasses = jest.fn();
79
- br.trigger = jest.fn();
80
- br.resize = jest.fn();
81
- br.jumpToIndex = jest.fn();
82
- const animateMock = (options, speed, style, callback) => {
83
- callback();
84
- };
85
- br.refs.$brContainer = {
86
- css: jest.fn(),
87
- animate: animateMock,
88
- };
89
-
90
- br.enterFullscreen();
91
- expect(br.switchMode).toHaveBeenCalledTimes(1);
92
- expect(br.updateBrClasses).toHaveBeenCalledTimes(0); // book nav's fullscreen manager will set these classes
93
- expect(br.trigger).toHaveBeenCalledTimes(1);
94
- expect(br.resize).toHaveBeenCalledTimes(1);
95
- expect(br.jumpToIndex).toHaveBeenCalledTimes(1);
96
- });
97
- });
98
-
99
- describe('BookReader.prototype.exitFullScreen', () => {
100
- test('fires certain events when called', () => {
101
- const br = new BookReader();
102
- br.mode = br.constMode1up;
103
- br.switchMode = jest.fn();
104
- br.updateBrClasses = jest.fn();
105
- br.trigger = jest.fn();
106
- br.resize = jest.fn();
107
- const animateMock = (options, speed, style, callback) => {
108
- callback();
109
- };
110
- br.refs.$brContainer = {
111
- css: jest.fn(),
112
- animate: animateMock,
113
- };
114
- br.exitFullScreen();
115
- expect(br.switchMode).toHaveBeenCalledTimes(1);
116
- expect(br.updateBrClasses).toHaveBeenCalledTimes(1);
117
- expect(br.trigger).toHaveBeenCalledTimes(1);
118
- expect(br.resize).toHaveBeenCalledTimes(1);
119
- });
120
- });
121
-
122
- describe('BookReader.prototype.trigger', () => {
123
- test('fires custom event', () => {
124
- const br = new BookReader();
125
- global.br = br;
126
- global.dispatchEvent = jest.fn();
127
-
128
- const props = {bar: 1};
129
- br.trigger('foo', props);
130
- expect(global.dispatchEvent.mock.calls.length).toBe(1);
131
- });
132
- });
133
-
134
- describe('`BookReader.prototype.prev`', () => {
135
- const br = new BookReader();
136
- global.br = br;
137
- br.trigger = jest.fn();
138
- br.flipBackToIndex = jest.fn();
139
- br.jumpToIndex = jest.fn();
140
-
141
- test('does not take action if user is on front page', () => {
142
- br.firstIndex = 0;
143
- br.prev();
144
- expect(br.trigger.mock.calls.length).toBe(0);
145
- expect(br.flipBackToIndex.mock.calls.length).toBe(0);
146
- expect(br.jumpToIndex.mock.calls.length).toBe(0);
147
- });
148
-
149
- describe('2up mode', () => {
150
- test('fires event and turns the page', () => {
151
- br.firstIndex = 10;
152
- br.mode = br.constMode2up;
153
- br.prev();
154
- expect(br.jumpToIndex.mock.calls.length).toBe(0); // <-- does not get called
155
- expect(br.trigger.mock.calls.length).toBe(1);
156
- expect(br.flipBackToIndex.mock.calls.length).toBe(1);
157
- });
158
- })
159
-
160
- describe('non 2up mode', () => {
161
- test('jumps to provided index', () => {
162
- br.firstIndex = 100;
163
- br.mode = br.constMode1up;
164
- br.prev();
165
- expect(br.jumpToIndex.mock.calls.length).toBe(1); // <-- gets called
166
- expect(br.trigger.mock.calls.length).toBe(1); // <-- gets called by `jumpToIndex` internally
167
- expect(br.flipBackToIndex.mock.calls.length).toBe(1); // <-- gets called by `jumpToIndex` internally
168
- })
169
- });
170
- });
171
-
@@ -1,164 +0,0 @@
1
- import sinon from 'sinon';
2
- import { deepCopy } from '../utils.js';
3
- import { Mode1Up } from '../../src/BookReader/Mode1Up.js'
4
- import { BookModel } from '../../src/BookReader/BookModel.js';
5
- import { DEFAULT_OPTIONS } from '../../src/BookReader/options.js';
6
- const DEFAULT_PPI = DEFAULT_OPTIONS.ppi;
7
-
8
- /** @type {BookReaderOptions['data']} */
9
- const SAMPLE_DATA = [
10
- [
11
- { width: 123, height: 123, uri: 'https://archive.org/image0.jpg', pageNum: '1' },
12
- ],
13
- [
14
- { width: 123, height: 123, uri: 'https://archive.org/image1.jpg', pageNum: '2' },
15
- { width: 123, height: 123, uri: 'https://archive.org/image2.jpg', pageNum: '3' },
16
- ],
17
- [
18
- { width: 123, height: 123, uri: 'https://archive.org/image3.jpg', pageNum: '4' },
19
- { width: 123, height: 123, uri: 'https://archive.org/image4.jpg', pageNum: '5' },
20
- ],
21
- [
22
- { width: 123, height: 123, uri: 'https://archive.org/image5.jpg', pageNum: '6' },
23
- ],
24
- ];
25
-
26
- describe('pagesWithBounds', () => {
27
- test('Works with empty book', () => {
28
- const br = { data: [] };
29
- const book = new BookModel(br);
30
- const mode = new Mode1Up(br, book);
31
- expect(Array.from(mode.pagesWithBounds())).toHaveLength(0);
32
- });
33
-
34
- test('Iterates all pages', () => {
35
- const br = { data: SAMPLE_DATA };
36
- const book = new BookModel(br);
37
- const mode = new Mode1Up(br, book);
38
- expect(Array.from(mode.pagesWithBounds())).toHaveLength(6);
39
- });
40
-
41
- test('Computes bounds', () => {
42
- const br = { data: SAMPLE_DATA };
43
- const book = new BookModel(br);
44
- const mode = new Mode1Up(br, book);
45
- const x = Array.from(mode.pagesWithBounds());
46
- expect(x.map(({top, bottom}) => [top, bottom].map(x => x.toFixed(1)))).toEqual([
47
- ['0.0', '24.6'],
48
- ['44.6', '69.2'],
49
- ['89.2', '113.8'],
50
- ['133.8', '158.4'],
51
- ['178.4', '203.0'],
52
- ['223.0', '247.6'],
53
- ]);
54
- });
55
- });
56
-
57
- describe('boundIntersection', () => {
58
- const f = Mode1Up.boundIntersection;
59
- test('Exactly equal', () => {
60
- expect(f({top: 0, bottom: 10}, {top: 0, bottom: 10})).toBe(1);
61
- });
62
-
63
- test('A contains B', () => {
64
- expect(f({top: 0, bottom: 10}, {top: 1, bottom: 2})).toBe(0.1);
65
- });
66
- test('A boundary contains B', () => {
67
- expect(f({top: 0, bottom: 10}, {top: 0, bottom: 2})).toBe(0.2);
68
- });
69
- test('A contains top part of B', () => {
70
- expect(f({top: 0, bottom: 10}, {top: 5, bottom: 15})).toBeCloseTo(5 / 15);
71
- });
72
- test('A contains bottom part of B', () => {
73
- expect(f({top: 5, bottom: 10}, {top: 0, bottom: 6})).toBe(0.1);
74
- });
75
- test('A entirely above B', () => {
76
- expect(f({top: 0, bottom: 10}, {top: 20, bottom: 30})).toBe(0);
77
- });
78
- test('A entirely below B', () => {
79
- expect(f({top: 20, bottom: 30}, {top: 0, bottom: 10})).toBe(0);
80
- });
81
- });
82
-
83
- describe('physicalInchesToDisplayPixels', () => {
84
- test('0 case', () => {
85
- const f = Mode1Up.prototype.physicalInchesToDisplayPixels;
86
- expect(f(0, 1, 100)).toBe(0);
87
- });
88
- test('Misc case', () => {
89
- const f = Mode1Up.prototype.physicalInchesToDisplayPixels;
90
- expect(f(1, 1, 100)).toBe(100);
91
- expect(f(1, 2, 100)).toBe(50);
92
- expect(f(1, 1, 78)).toBe(78);
93
- });
94
- });
95
-
96
- describe('calculateViewDimensions', () => {
97
- test('Padding added for each page', () => {
98
- const br = { data: SAMPLE_DATA };
99
- const book = new BookModel(br);
100
- const mode = new Mode1Up(br, book);
101
- const pageSizeIn = 123 / DEFAULT_PPI;
102
- const dims = mode.calculateViewDimensions(1, 2.5);
103
- expect(dims.width).toBeCloseTo(mode.physicalInchesToDisplayPixels(pageSizeIn, 1));
104
- expect(dims.height).toBeCloseTo(mode.physicalInchesToDisplayPixels(6 * pageSizeIn + 5 * 2.5, 1));
105
- });
106
-
107
- test('Reduction factor applied to each page/spacing individually', () => {
108
- const br = { data: SAMPLE_DATA };
109
- const book = new BookModel(br);
110
- const mode = new Mode1Up(br, book);
111
- const pageSizeIn = 123 / DEFAULT_PPI;
112
- const dims = mode.calculateViewDimensions(2, 5);
113
- expect(dims.width).toBeCloseTo(mode.physicalInchesToDisplayPixels(pageSizeIn, 2));
114
- expect(dims.height).toBeCloseTo(mode.physicalInchesToDisplayPixels(6 * pageSizeIn + 5 * 5, 2));
115
- });
116
-
117
- test('Uses maximal width', () => {
118
- const br = { data: deepCopy(SAMPLE_DATA) };
119
- br.data.flat().forEach((page, i) => page.width = i);
120
- const book = new BookModel(br);
121
- const mode = new Mode1Up(br, book);
122
- expect(mode.calculateViewDimensions().width).toBe(mode.physicalInchesToDisplayPixels(5 / DEFAULT_PPI));
123
- });
124
- });
125
-
126
- describe('centerY', () => {
127
- test('Computes the scroll position of the center of the screen', () => {
128
- const $container = $(`
129
- <div style="height: 500px">
130
- <div style="height: 2500px" />
131
- </div>`);
132
- $container.scrollTop(1000);
133
- expect(Mode1Up.prototype.centerY($container)).toBe(1250);
134
- });
135
-
136
- test('Handles no scroll', () => {
137
- const $container = $(`
138
- <div style="height: 1280px">
139
- <div style="height: 500px" />
140
- </div>`);
141
- expect(Mode1Up.prototype.centerY($container)).toBe(640);
142
- });
143
- });
144
-
145
- describe('centerX', () => {
146
- test('Pages narrower than viewport', () => {
147
- const $container = $(`<div style="width: 800px; height: 800px" />`);
148
- const $pagesContainer = $(`<div style="width: 500px; height: 1600px" />`)
149
- .appendTo($container);
150
- // clientWidth doesn't work in jsdom, so stub it
151
- sinon.stub($container, 'prop').returns(800);
152
- expect(Mode1Up.prototype.centerX($container, $pagesContainer)).toBe(500);
153
- });
154
-
155
- test('Pages wider than viewport', () => {
156
- const $container = $(`<div style="width: 800px; height: 800px; overflow: scroll;" />`);
157
- const $pagesContainer = $(`<div style="width: 1200px; height: 1600px" />`)
158
- .appendTo($container);
159
- $container.scrollLeft(10);
160
- // clientWidth doesn't work in jsdom, so stub it
161
- sinon.stub($container, 'prop').returns(800);
162
- expect(Mode1Up.prototype.centerX($container, $pagesContainer)).toBe(410);
163
- });
164
- });
@@ -1,247 +0,0 @@
1
-
2
- import sinon from 'sinon';
3
- import { deepCopy } from '../utils.js';
4
- import BookReader from '../../src/BookReader.js';
5
- /** @typedef {import('../../src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
6
-
7
- beforeAll(() => {
8
- global.alert = jest.fn();
9
- })
10
- afterEach(() => {
11
- jest.restoreAllMocks();
12
- sinon.restore();
13
- });
14
-
15
- /** @type {BookReaderOptions['data']} */
16
- const SAMPLE_DATA = [
17
- [
18
- { width: 123, height: 123, uri: 'https://archive.org/image0.jpg', pageNum: '1' },
19
- ],
20
- [
21
- { width: 123, height: 123, uri: 'https://archive.org/image1.jpg', pageNum: '2' },
22
- { width: 123, height: 123, uri: 'https://archive.org/image2.jpg', pageNum: '3' },
23
- ],
24
- [
25
- { width: 123, height: 123, uri: 'https://archive.org/image3.jpg', pageNum: '4' },
26
- { width: 123, height: 123, uri: 'https://archive.org/image4.jpg', pageNum: '5' },
27
- ],
28
- [
29
- { width: 123, height: 123, uri: 'https://archive.org/image5.jpg', pageNum: '6' },
30
- ],
31
- ];
32
-
33
-
34
- describe('zoom', () => {
35
- const br = new BookReader({ data: SAMPLE_DATA });
36
- br.init();
37
-
38
- const stopAnim = sinon.spy(br, 'stopFlipAnimations');
39
- const resizeSpread = sinon.spy(br._modes.mode2Up, 'resizeSpread');
40
- br._modes.mode2Up.zoom('in');
41
-
42
- test('stops animations when zooming', () => {
43
- expect(stopAnim.callCount).toBe(1);
44
- });
45
- test('always redraws when zooming', () => {
46
- expect(resizeSpread.callCount).toBe(0);
47
- });
48
- });
49
-
50
- describe('prefetch', () => {
51
- test('loads nearby pages', () => {
52
- const br = new BookReader({ data: SAMPLE_DATA });
53
- const mode2Up = br._modes.mode2Up;
54
- br.init();
55
- mode2Up.prefetch();
56
- expect(Object.keys(mode2Up.pageContainers).length).toBeGreaterThan(2);
57
- });
58
-
59
- test('works when at end of book', () => {
60
- const br = new BookReader({ data: SAMPLE_DATA });
61
- const mode2Up = br._modes.mode2Up;
62
- br.init();
63
- br.jumpToIndex(-1);
64
- mode2Up.prefetch();
65
- expect(Object.keys(mode2Up.pageContainers).length).toBeGreaterThan(2);
66
- });
67
-
68
- test('skips consecutive unviewables', () => {
69
- const data = deepCopy(SAMPLE_DATA);
70
- data[1].forEach(page => page.viewable = false);
71
- const br = new BookReader({ data });
72
- const mode2Up = br._modes.mode2Up;
73
- br.init();
74
- mode2Up.prefetch();
75
- expect(mode2Up.pageContainers).not.toContain(2);
76
- });
77
- });
78
-
79
- describe('draw 2up leaves', () => {
80
- test('calls `drawLeafs` on init as default', () => {
81
- const br = new BookReader({ data: SAMPLE_DATA });
82
- const drawLeafs = sinon.spy(br._modes.mode2Up, 'drawLeafs');
83
-
84
- br.init();
85
- expect(drawLeafs.callCount).toBe(1);
86
- })
87
-
88
- test('sets `this.displayedIndices`', () => {
89
- const extremelyWrongValueForDisplayedIndices = null;
90
- const br = new BookReader({ data: SAMPLE_DATA });
91
-
92
- br.init();
93
- br.displayedIndices = extremelyWrongValueForDisplayedIndices;
94
- expect(br.displayedIndices).toBe(extremelyWrongValueForDisplayedIndices);
95
-
96
- br._modes.mode2Up.drawLeafs();
97
-
98
- expect(br.displayedIndices).not.toBe(extremelyWrongValueForDisplayedIndices);
99
- expect(br.displayedIndices.length).toBe(2); // is array
100
- expect(br.displayedIndices).toEqual([-1, 0]); // default to starting index on right, placeholder for left
101
- })
102
- });
103
-
104
- describe('resizeSpread', () => {
105
- test('only resizes spread', () => {
106
- const br = new BookReader({ data: SAMPLE_DATA });
107
- br.init();
108
- const resizeBRcontainer = sinon.spy(br, 'resizeBRcontainer');
109
- const calculateSpreadSize = sinon.spy(br._modes.mode2Up, 'calculateSpreadSize');
110
- const drawLeafs = sinon.spy(br._modes.mode2Up, 'drawLeafs');
111
- const centerView = sinon.spy(br._modes.mode2Up, 'centerView');
112
-
113
- br._modes.mode2Up.resizeSpread();
114
- expect(drawLeafs.callCount).toBe(0); // no draw
115
- expect(resizeBRcontainer.callCount).toBe(1);
116
- expect(calculateSpreadSize.callCount).toBe(1);
117
- expect(centerView.callCount).toBe(1);
118
- });
119
- });
120
-
121
- describe('2up Container sizing', () => {
122
- test('baseLeafCss', () => {
123
- const br = new BookReader({ data: SAMPLE_DATA });
124
- br.init();
125
- br.calculateSpreadSize();
126
- expect(Object.keys(br._modes.mode2Up.baseLeafCss)).toEqual(['position', 'right', 'top', 'zIndex']);
127
- });
128
- test('heightCss', () => {
129
- const br = new BookReader({ data: SAMPLE_DATA });
130
- br.init();
131
- br.calculateSpreadSize();
132
- const heightStub = 1000;
133
- br.twoPage.height = heightStub;
134
- expect(Object.keys(br._modes.mode2Up.heightCss)).toEqual(['height']);
135
- expect(br._modes.mode2Up.heightCss).toEqual({height: `${heightStub}px`});
136
- });
137
- describe('left side', () => {
138
- const br = new BookReader({ data: SAMPLE_DATA });
139
- br.init();
140
- br.calculateSpreadSize();
141
-
142
- test('leftLeafCss', () => {
143
- expect(Object.keys(br._modes.mode2Up.leftLeafCss)).toEqual([
144
- 'position',
145
- 'right',
146
- 'top',
147
- 'zIndex',
148
- 'height',
149
- 'left',
150
- 'width',
151
- ]);
152
- });
153
- test('leafEdgeLCss', () => {
154
- expect(Object.keys(br._modes.mode2Up.leafEdgeLCss)).toEqual([
155
- 'height',
156
- 'width',
157
- 'left',
158
- 'top',
159
- 'border'
160
- ]);
161
- });
162
- });
163
- describe('right side', () => {
164
- const br = new BookReader({ data: SAMPLE_DATA });
165
- br.init();
166
- br.calculateSpreadSize();
167
-
168
- test('rightLeafCss', () => {
169
- expect(Object.keys(br._modes.mode2Up.rightLeafCss)).toEqual([
170
- 'position',
171
- 'right',
172
- 'top',
173
- 'zIndex',
174
- 'height',
175
- 'left',
176
- 'width',
177
- ]);
178
- });
179
- test('leafEdgeRCss', () => {
180
- expect(Object.keys(br._modes.mode2Up.leafEdgeRCss)).toEqual([
181
- 'height',
182
- 'width',
183
- 'left',
184
- 'top',
185
- 'border'
186
- ]);
187
- });
188
- });
189
- describe('full width container, overlay + spine', () => {
190
- test('mainContainerCss', () => {
191
- const br = new BookReader({ data: SAMPLE_DATA });
192
- br.init();
193
- br.calculateSpreadSize();
194
-
195
- expect(Object.keys(br._modes.mode2Up.mainContainerCss)).toEqual(['height', 'width', 'position']);
196
- });
197
- test('spreadCoverCss', () => {
198
- const br = new BookReader({ data: SAMPLE_DATA });
199
- br.init();
200
- br.calculateSpreadSize();
201
- expect(Object.keys(br._modes.mode2Up.spreadCoverCss)).toEqual(['width', 'height', 'visibility']);
202
- });
203
- test('spineCss', () => {
204
- const br = new BookReader({ data: SAMPLE_DATA });
205
- br.init();
206
- br.calculateSpreadSize();
207
- expect(Object.keys(br._modes.mode2Up.spineCss)).toEqual(['width', 'height', 'left', 'top']);
208
- });
209
- });
210
- });
211
-
212
- describe('prepareTwoPageView', () => {
213
- describe('drawing spread', () => {
214
- test('always draws new spread if `drawNewSpread` is true ', () => {
215
- const br = new BookReader({ data: SAMPLE_DATA });
216
- const mode2Up = br._modes.mode2Up;
217
- br.init();
218
- const drawLeafs = sinon.spy(mode2Up, 'drawLeafs');
219
- const resizeSpread = sinon.spy(mode2Up, 'resizeSpread');
220
- const calculateSpreadSize = sinon.spy(mode2Up, 'calculateSpreadSize');
221
- const prunePageContainers = sinon.spy(mode2Up, 'prunePageContainers');
222
- const prefetch = sinon.spy(mode2Up, 'prefetch');
223
- const bindGestures = sinon.spy(br, 'bindGestures');
224
- const centerView = sinon.spy(mode2Up, 'centerView');
225
- const preparePopUp = sinon.spy(mode2Up, 'preparePopUp');
226
- const updateBrClasses = sinon.spy(br, 'updateBrClasses');
227
-
228
- br.prepareTwoPageView(undefined, undefined, true);
229
- expect(prefetch.callCount).toBe(1);
230
-
231
- expect(resizeSpread.callCount).toBe(0);
232
- expect(drawLeafs.callCount).toBe(1);
233
- expect(calculateSpreadSize.callCount).toBe(1);
234
- expect(prunePageContainers.callCount).toBe(1);
235
- expect(bindGestures.callCount).toBe(1);
236
- expect(centerView.callCount).toBe(1);
237
- expect(preparePopUp.callCount).toBe(1);
238
- expect(updateBrClasses.callCount).toBe(1);
239
- });
240
- });
241
- });
242
-
243
- test('uses ImageCache', () => {
244
- const br = new BookReader({ data: SAMPLE_DATA });
245
- br.init();
246
- expect(Object.keys(br.imageCache.cache).length).toBeGreaterThan(2);
247
- });
@@ -1,109 +0,0 @@
1
- import sinon from 'sinon';
2
- import {
3
- clamp,
4
- cssPercentage,
5
- debounce,
6
- decodeURIComponentPlus,
7
- encodeURIComponentPlus,
8
- escapeHTML,
9
- polyfillCustomEvent,
10
- PolyfilledCustomEvent,
11
- sleep,
12
- } from '../../src/BookReader/utils.js';
13
-
14
- test('clamp function returns Math.min(Math.max(value, min), max)', () => {
15
- expect(clamp(2,1,3)).toEqual(2);
16
- });
17
-
18
- test('calculate a percentage suitable for CSS', () => {
19
- expect(cssPercentage(2,1)).toEqual('200%');
20
- });
21
-
22
- test('escapeHTML function which replaces the string', () => {
23
- expect(escapeHTML('Me & You')).toEqual('Me &amp; You');
24
- expect(escapeHTML('Me > You')).toEqual('Me &gt; You');
25
- expect(escapeHTML('Me < You')).toEqual('Me &lt; You');
26
- expect(escapeHTML('Me " You')).toEqual('Me &quot; You');
27
- });
28
-
29
- test('Decodes a URI component and converts + to emptyStr', () => {
30
- expect(decodeURIComponentPlus("https%3A%2F%2Farchive.org%2Fskr+")).toEqual("https://archive.org/skr ");
31
- expect(decodeURIComponentPlus("%3Fx%3D+test")).toEqual("?x= test");
32
- });
33
-
34
- test('Encodes a URI component and converts emptyStr to +', () => {
35
- expect(encodeURIComponentPlus("?x=test ")).toEqual("%3Fx%3Dtest+");
36
- expect(encodeURIComponentPlus("ABC abc 123")).toEqual("ABC+abc+123");
37
- });
38
-
39
- let clock;
40
-
41
- beforeEach(() => {
42
- clock = sinon.useFakeTimers();
43
- });
44
-
45
- afterEach(() => {
46
- clock.restore();
47
- });
48
-
49
- test('testing debounce', () => {
50
- const func = jest.fn();
51
- const debouncedFunc = debounce(func, 1000);
52
- // Call it immediately
53
- debouncedFunc();
54
- expect(func).toHaveBeenCalledTimes(0); // func not called
55
-
56
- // Call it several times with 500ms between each call
57
- for (let i = 0; i < 10; i++) {
58
- clock.tick(500);
59
- debouncedFunc();
60
- }
61
- expect(func).toHaveBeenCalledTimes(0); // func not called
62
-
63
- // wait 1000ms
64
- clock.tick(1000);
65
- expect(func).toHaveBeenCalledTimes(1); // func called
66
- });
67
-
68
-
69
- describe('polyfillCustomEvent', () => {
70
- test('Overrides when missing', () => {
71
- const win = {};
72
- polyfillCustomEvent(win);
73
- expect(win).toHaveProperty('CustomEvent');
74
- });
75
-
76
- test('Overrides when not a function', () => {
77
- const win = { CustomEvent: {} };
78
- polyfillCustomEvent(win);
79
- expect(typeof win.CustomEvent).toBe('function');
80
- });
81
- });
82
-
83
- describe('PolyfilledCustomEvent', () => {
84
- test('Can be called as a constructor', () => {
85
- new PolyfilledCustomEvent('foo');
86
- });
87
-
88
- test('Calls deprecated browser methods', () => {
89
- const createEventSpy = sinon.spy(document, 'createEvent');
90
- const initCustomEventSpy = sinon.spy(CustomEvent.prototype, 'initCustomEvent');
91
- new PolyfilledCustomEvent('foo');
92
- expect(createEventSpy.callCount).toBe(1);
93
- expect(initCustomEventSpy.callCount).toBe(1);
94
- });
95
- });
96
-
97
- describe('sleep', () => {
98
- test('can set sleep in ms', async () => {
99
- jest.useFakeTimers();
100
-
101
- const sleepTimeMS = 11;
102
- await sleep(sleepTimeMS);
103
-
104
- expect(setTimeout).toHaveBeenCalledTimes(1);
105
- expect(setTimeout).toHaveBeenLastCalledWith(undefined, sleepTimeMS);
106
-
107
- jest.clearAllTimers();
108
- });
109
- });