@internetarchive/bookreader 5.0.0-4 → 5.0.0-40-a1

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 (228) hide show
  1. package/.eslintrc.js +17 -15
  2. package/.github/workflows/node.js.yml +75 -4
  3. package/.github/workflows/npm-publish.yml +2 -16
  4. package/.testcaferc.js +10 -0
  5. package/BookReader/BookReader.css +83 -323
  6. package/BookReader/BookReader.js +1 -1
  7. package/BookReader/BookReader.js.LICENSE.txt +24 -0
  8. package/BookReader/BookReader.js.map +1 -1
  9. package/BookReader/ia-bookreader-bundle.js +1623 -0
  10. package/BookReader/{bookreader-component-bundle.js.LICENSE.txt → ia-bookreader-bundle.js.LICENSE.txt} +14 -10
  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/voice.svg +1 -0
  16. package/BookReader/plugins/plugin.archive_analytics.js +1 -1
  17. package/BookReader/plugins/plugin.archive_analytics.js.map +1 -1
  18. package/BookReader/plugins/plugin.autoplay.js +1 -1
  19. package/BookReader/plugins/plugin.autoplay.js.map +1 -1
  20. package/BookReader/plugins/plugin.chapters.js +1 -1
  21. package/BookReader/plugins/plugin.chapters.js.map +1 -1
  22. package/BookReader/plugins/plugin.iframe.js +1 -1
  23. package/BookReader/plugins/plugin.iframe.js.map +1 -1
  24. package/BookReader/plugins/plugin.mobile_nav.js +1 -1
  25. package/BookReader/plugins/plugin.mobile_nav.js.map +1 -1
  26. package/BookReader/plugins/plugin.resume.js +1 -1
  27. package/BookReader/plugins/plugin.resume.js.map +1 -1
  28. package/BookReader/plugins/plugin.search.js +1 -1
  29. package/BookReader/plugins/plugin.search.js.map +1 -1
  30. package/BookReader/plugins/plugin.text_selection.js +1 -1
  31. package/BookReader/plugins/plugin.text_selection.js.map +1 -1
  32. package/BookReader/plugins/plugin.tts.js +1 -1
  33. package/BookReader/plugins/plugin.tts.js.map +1 -1
  34. package/BookReader/plugins/plugin.url.js +1 -1
  35. package/BookReader/plugins/plugin.url.js.map +1 -1
  36. package/BookReader/plugins/plugin.vendor-fullscreen.js +1 -1
  37. package/BookReader/plugins/plugin.vendor-fullscreen.js.map +1 -1
  38. package/BookReader/webcomponents-bundle.js +3 -0
  39. package/BookReader/webcomponents-bundle.js.LICENSE.txt +9 -0
  40. package/BookReader/webcomponents-bundle.js.map +1 -0
  41. package/BookReaderDemo/BookReaderDemo.css +14 -1
  42. package/BookReaderDemo/IADemoBr.js +120 -0
  43. package/BookReaderDemo/demo-advanced.html +1 -1
  44. package/BookReaderDemo/demo-autoplay.html +1 -0
  45. package/BookReaderDemo/demo-embed-iframe-src.html +1 -0
  46. package/BookReaderDemo/demo-fullscreen-mobile.html +1 -0
  47. package/BookReaderDemo/demo-fullscreen.html +1 -0
  48. package/BookReaderDemo/demo-iiif.html +1 -0
  49. package/BookReaderDemo/demo-internetarchive.html +74 -17
  50. package/BookReaderDemo/demo-multiple.html +1 -0
  51. package/BookReaderDemo/demo-preview-pages.html +1 -0
  52. package/BookReaderDemo/demo-simple.html +1 -0
  53. package/BookReaderDemo/demo-vendor-fullscreen.html +1 -0
  54. package/BookReaderDemo/ia-multiple-volumes-manifest.js +170 -0
  55. package/BookReaderDemo/immersion-1up.html +1 -0
  56. package/BookReaderDemo/immersion-mode.html +1 -0
  57. package/BookReaderDemo/toggle_controls.html +1 -0
  58. package/BookReaderDemo/view_mode.html +1 -0
  59. package/BookReaderDemo/viewmode-cycle.html +1 -2
  60. package/CHANGELOG.md +166 -0
  61. package/README.md +14 -1
  62. package/babel.config.js +18 -0
  63. package/codecov.yml +6 -0
  64. package/index.html +3 -0
  65. package/jsconfig.json +19 -0
  66. package/package.json +62 -47
  67. package/renovate.json +43 -0
  68. package/src/BookNavigator/assets/bookmark-colors.js +1 -1
  69. package/src/BookNavigator/assets/button-base.js +9 -2
  70. package/src/BookNavigator/assets/ia-logo.js +17 -0
  71. package/src/BookNavigator/assets/icon_checkmark.js +1 -1
  72. package/src/BookNavigator/assets/icon_close.js +1 -1
  73. package/src/BookNavigator/assets/icon_sort_asc.js +5 -0
  74. package/src/BookNavigator/assets/icon_sort_desc.js +5 -0
  75. package/src/BookNavigator/assets/icon_sort_neutral.js +5 -0
  76. package/src/BookNavigator/assets/icon_volumes.js +11 -0
  77. package/src/BookNavigator/book-navigator.js +556 -0
  78. package/src/BookNavigator/bookmarks/bookmark-button.js +3 -2
  79. package/src/BookNavigator/bookmarks/bookmark-edit.js +4 -4
  80. package/src/BookNavigator/bookmarks/bookmarks-list.js +3 -3
  81. package/src/BookNavigator/bookmarks/bookmarks-loginCTA.js +3 -8
  82. package/src/BookNavigator/bookmarks/bookmarks-provider.js +23 -12
  83. package/src/BookNavigator/bookmarks/ia-bookmarks.js +98 -62
  84. package/src/BookNavigator/delete-modal-actions.js +1 -1
  85. package/src/BookNavigator/downloads/downloads-provider.js +23 -17
  86. package/src/BookNavigator/downloads/downloads.js +17 -25
  87. package/src/BookNavigator/search/a-search-result.js +3 -3
  88. package/src/BookNavigator/search/search-provider.js +57 -24
  89. package/src/BookNavigator/search/search-results.js +8 -20
  90. package/src/BookNavigator/sharing.js +27 -0
  91. package/src/BookNavigator/visual-adjustments/visual-adjustments-provider.js +11 -13
  92. package/src/BookNavigator/visual-adjustments/visual-adjustments.js +4 -3
  93. package/src/BookNavigator/volumes/volumes-provider.js +114 -0
  94. package/src/BookNavigator/volumes/volumes.js +188 -0
  95. package/src/BookReader/DebugConsole.js +3 -3
  96. package/src/BookReader/DragScrollable.js +233 -0
  97. package/src/BookReader/Mode1Up.js +51 -351
  98. package/src/BookReader/Mode1UpLit.js +441 -0
  99. package/src/BookReader/Mode2Up.js +104 -71
  100. package/src/BookReader/ModeSmoothZoom.js +179 -0
  101. package/src/BookReader/ModeThumb.js +16 -8
  102. package/src/BookReader/Navbar/Navbar.js +2 -31
  103. package/src/BookReader/PageContainer.js +57 -6
  104. package/src/BookReader/ReduceSet.js +1 -1
  105. package/src/BookReader/Toolbar/Toolbar.js +7 -7
  106. package/src/BookReader/options.js +10 -0
  107. package/src/BookReader/utils/HTMLDimensionsCacher.js +44 -0
  108. package/src/BookReader/utils/ScrollClassAdder.js +31 -0
  109. package/src/BookReader/utils.js +68 -13
  110. package/src/BookReader.js +375 -289
  111. package/src/assets/icons/close-circle-dark.svg +1 -0
  112. package/src/assets/icons/magnify-minus.svg +3 -7
  113. package/src/assets/icons/magnify-plus.svg +3 -7
  114. package/src/assets/icons/voice.svg +1 -0
  115. package/src/css/BookReader.scss +0 -12
  116. package/src/css/_BRComponent.scss +1 -1
  117. package/src/css/_BRmain.scss +19 -24
  118. package/src/css/_BRnav.scss +4 -26
  119. package/src/css/_BRpages.scss +35 -0
  120. package/src/css/_BRsearch.scss +11 -215
  121. package/src/css/_TextSelection.scss +14 -17
  122. package/src/css/_colorbox.scss +2 -2
  123. package/src/css/_controls.scss +16 -3
  124. package/src/css/_icons.scss +6 -0
  125. package/src/ia-bookreader/ia-bookreader.js +224 -0
  126. package/src/plugins/plugin.chapters.js +26 -33
  127. package/src/plugins/plugin.mobile_nav.js +11 -10
  128. package/src/plugins/plugin.resume.js +3 -3
  129. package/src/plugins/plugin.text_selection.js +26 -39
  130. package/src/plugins/plugin.vendor-fullscreen.js +4 -4
  131. package/src/plugins/search/plugin.search.js +106 -107
  132. package/src/plugins/search/view.js +50 -163
  133. package/src/plugins/tts/AbstractTTSEngine.js +46 -37
  134. package/src/plugins/tts/FestivalTTSEngine.js +12 -13
  135. package/src/plugins/tts/PageChunk.js +15 -21
  136. package/src/plugins/tts/PageChunkIterator.js +8 -12
  137. package/src/plugins/tts/WebTTSEngine.js +64 -68
  138. package/src/plugins/tts/plugin.tts.js +79 -108
  139. package/src/plugins/url/UrlPlugin.js +184 -0
  140. package/src/plugins/{plugin.url.js → url/plugin.url.js} +28 -6
  141. package/tests/e2e/README.md +37 -0
  142. package/tests/e2e/autoplay.test.js +2 -2
  143. package/tests/e2e/base.test.js +7 -7
  144. package/tests/e2e/helpers/base.js +8 -3
  145. package/tests/e2e/helpers/debug.js +1 -1
  146. package/tests/e2e/helpers/desktopSearch.js +14 -13
  147. package/tests/e2e/helpers/mobileSearch.js +3 -3
  148. package/tests/e2e/helpers/params.js +17 -0
  149. package/tests/e2e/models/Navigation.js +12 -3
  150. package/tests/e2e/rightToLeft.test.js +4 -5
  151. package/tests/e2e/viewmode.test.js +38 -33
  152. package/tests/{BookReader → jest/BookReader}/BookModel.test.js +3 -3
  153. package/tests/jest/BookReader/BookReaderPublicFunctions.test.js +176 -0
  154. package/tests/{BookReader → jest/BookReader}/DebugConsole.test.js +1 -1
  155. package/tests/{BookReader → jest/BookReader}/ImageCache.test.js +4 -4
  156. package/tests/jest/BookReader/Mode1UpLit.test.js +88 -0
  157. package/tests/{BookReader → jest/BookReader}/Mode2Up.test.js +5 -7
  158. package/tests/jest/BookReader/ModeSmoothZoom.test.js +149 -0
  159. package/tests/jest/BookReader/ModeThumb.test.js +71 -0
  160. package/tests/{BookReader → jest/BookReader}/Navbar/Navbar.test.js +7 -7
  161. package/tests/{BookReader → jest/BookReader}/PageContainer.test.js +79 -6
  162. package/tests/{BookReader → jest/BookReader}/ReduceSet.test.js +1 -1
  163. package/tests/{BookReader → jest/BookReader}/Toolbar/Toolbar.test.js +2 -2
  164. package/tests/jest/BookReader/utils/HTMLDimensionsCacher.test.js +59 -0
  165. package/tests/jest/BookReader/utils/ScrollClassAdder.test.js +49 -0
  166. package/tests/{BookReader → jest/BookReader}/utils/classes.test.js +1 -1
  167. package/tests/jest/BookReader/utils.test.js +136 -0
  168. package/tests/jest/BookReader.keyboard.test.js +190 -0
  169. package/tests/{BookReader.options.test.js → jest/BookReader.options.test.js} +9 -1
  170. package/tests/{BookReader.test.js → jest/BookReader.test.js} +20 -4
  171. package/tests/{plugins → jest/plugins}/plugin.archive_analytics.test.js +2 -2
  172. package/tests/{plugins → jest/plugins}/plugin.autoplay.test.js +2 -2
  173. package/tests/{plugins → jest/plugins}/plugin.chapters.test.js +8 -8
  174. package/tests/{plugins → jest/plugins}/plugin.iframe.test.js +2 -2
  175. package/tests/{plugins → jest/plugins}/plugin.mobile_nav.test.js +5 -5
  176. package/tests/{plugins → jest/plugins}/plugin.resume.test.js +3 -3
  177. package/tests/{plugins → jest/plugins}/plugin.text_selection.test.js +39 -47
  178. package/tests/{plugins → jest/plugins}/plugin.vendor-fullscreen.test.js +2 -2
  179. package/tests/{plugins → jest/plugins}/search/plugin.search.test.js +24 -25
  180. package/tests/{plugins → jest/plugins}/search/plugin.search.view.test.js +6 -6
  181. package/tests/{plugins → jest/plugins}/tts/AbstractTTSEngine.test.js +6 -6
  182. package/tests/{plugins → jest/plugins}/tts/FestivalTTSEngine.test.js +4 -4
  183. package/tests/{plugins → jest/plugins}/tts/PageChunk.test.js +1 -1
  184. package/tests/{plugins → jest/plugins}/tts/PageChunkIterator.test.js +3 -3
  185. package/tests/{plugins → jest/plugins}/tts/WebTTSEngine.test.js +1 -1
  186. package/tests/{plugins → jest/plugins}/tts/utils.test.js +3 -3
  187. package/tests/jest/plugins/url/UrlPlugin.test.js +190 -0
  188. package/tests/{plugins → jest/plugins/url}/plugin.url.test.js +33 -14
  189. package/tests/{util → jest/util}/browserSniffing.test.js +1 -1
  190. package/tests/{util → jest/util}/docCookies.test.js +1 -1
  191. package/tests/{util → jest/util}/strings.test.js +1 -1
  192. package/tests/{utils.js → jest/utils.js} +38 -0
  193. package/tests/karma/BookNavigator/book-navigator.test.js +501 -0
  194. package/tests/karma/BookNavigator/bookmarks/bookmark-button.test.js +44 -0
  195. package/tests/karma/BookNavigator/bookmarks/bookmark-edit.test.js +1 -3
  196. package/tests/karma/BookNavigator/bookmarks/bookmarks-list.test.js +3 -4
  197. package/tests/karma/BookNavigator/bookmarks/ia-bookmarks.test.js +57 -0
  198. package/tests/karma/BookNavigator/downloads/downloads-provider.test.js +67 -0
  199. package/tests/karma/BookNavigator/downloads/downloads.test.js +54 -0
  200. package/tests/karma/BookNavigator/search/search-provider.test.js +123 -0
  201. package/tests/karma/BookNavigator/{search-results.test.js → search/search-results.test.js} +1 -4
  202. package/tests/karma/BookNavigator/sharing/sharing-provider.test.js +49 -0
  203. package/tests/karma/BookNavigator/visual-adjustments.test.js +0 -2
  204. package/tests/karma/BookNavigator/volumes/volumes-provider.test.js +184 -0
  205. package/tests/karma/BookNavigator/volumes/volumes.test.js +98 -0
  206. package/webpack.config.js +10 -4
  207. package/.babelrc +0 -12
  208. package/.dependabot/config.yml +0 -6
  209. package/.testcaferc.json +0 -5
  210. package/BookReader/bookreader-component-bundle.js +0 -1450
  211. package/BookReader/bookreader-component-bundle.js.map +0 -1
  212. package/BookReader/plugins/plugin.menu_toggle.js +0 -2
  213. package/BookReader/plugins/plugin.menu_toggle.js.map +0 -1
  214. package/BookReaderDemo/bookreader-template-bundle.js +0 -7178
  215. package/BookReaderDemo/demo-plugin-menu-toggle.html +0 -34
  216. package/src/BookNavigator/BookModel.js +0 -14
  217. package/src/BookNavigator/BookNavigator.js +0 -435
  218. package/src/BookNavigator/assets/book-loader.js +0 -27
  219. package/src/BookNavigator/br-fullscreen-mgr.js +0 -83
  220. package/src/BookReaderComponent/BookReaderComponent.js +0 -112
  221. package/src/ItemNavigator/ItemNavigator.js +0 -372
  222. package/src/ItemNavigator/providers/sharing.js +0 -29
  223. package/src/dragscrollable-br.js +0 -261
  224. package/src/plugins/menu_toggle/plugin.menu_toggle.js +0 -324
  225. package/tests/BookReader/BookReaderPublicFunctions.test.js +0 -171
  226. package/tests/BookReader/Mode1Up.test.js +0 -164
  227. package/tests/BookReader/utils.test.js +0 -109
  228. package/tests/plugins/menu_toggle/plugin.menu_toggle.test.js +0 -68
package/BookReaderDemo/demo-plugin-menu-toggle.html DELETED
@@ -1,34 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <title>bookreader demo</title>
5
-
6
- <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
7
- <meta name="apple-mobile-web-app-capable" content="yes">
8
-
9
- <!-- JS dependencies -->
10
- <script src="../BookReader/jquery-1.10.1.js"></script>
11
-
12
-
13
- <!-- BookReader and plugins -->
14
- <link rel="stylesheet" href="../BookReader/BookReader.css"/>
15
- <script src="../BookReader/BookReader.js"></script>
16
- <script type="text/javascript" src="../BookReader/plugins/plugin.url.js"></script>
17
- <script type="text/javascript" src="../BookReader/plugins/plugin.menu_toggle.js"></script>
18
-
19
- <!-- Custom CSS overrides -->
20
- <link rel="stylesheet" href="BookReaderDemo.css"/>
21
- </head>
22
- <body>
23
- <div id="BookReader">
24
- Internet Archive BookReader Demo<br/>
25
- plugin: Fullscreen menu toggle<br/>
26
- <noscript>
27
- <p>
28
- The BookReader requires JavaScript to be enabled. Please check that your browser supports JavaScript and that it is enabled in the browser settings. You can also try one of the <a href="https://archive.org/details/goodytwoshoes00newyiala"> other formats of the book</a>.
29
- </p>
30
- </noscript>
31
- </div>
32
- <script type="text/javascript" src="BookReaderJSAdvanced.js"></script>
33
- </body>
34
- </html>
package/src/BookNavigator/BookModel.js DELETED
@@ -1,14 +0,0 @@
1
- export class Book {
2
- constructor() {
3
- this.metadata = {};
4
- this.isRestricted = null;
5
- }
6
-
7
- setMetadata(itemMetadata) {
8
- this.metadata = itemMetadata;
9
- }
10
-
11
- setRestriction(isRestricted) {
12
- this.isRestricted = isRestricted;
13
- }
14
- }
package/src/BookNavigator/BookNavigator.js DELETED
@@ -1,435 +0,0 @@
1
- import { css, html, LitElement } from 'lit-element';
2
- import { nothing } from 'lit-html';
3
- import SearchProvider from './search/search-provider.js';
4
- import DownloadProvider from './downloads/downloads-provider.js';
5
- import VisualAdjustmentProvider from './visual-adjustments/visual-adjustments-provider.js';
6
- import BookmarksProvider from './bookmarks/bookmarks-provider.js';
7
- import SharingProvider from '../ItemNavigator/providers/sharing.js';
8
- import BRFullscreenMgr from './br-fullscreen-mgr.js';
9
- import { Book } from './BookModel.js';
10
- import bookLoader from './assets/book-loader.js';
11
-
12
- const events = {
13
- menuUpdated: 'menuUpdated',
14
- updateSideMenu: 'updateSideMenu',
15
- PostInit: 'PostInit',
16
- ViewportInFullScreen: 'ViewportInFullScreen',
17
- };
18
- export class BookNavigator extends LitElement {
19
- static get properties() {
20
- return {
21
- book: { type: Object },
22
- pageContainerSelector: { type: String },
23
- brWidth: { type: Number },
24
- bookReaderLoaded: { type: Boolean },
25
- bookreader: { type: Object },
26
- downloadableTypes: { type: Array },
27
- isAdmin: { type: Boolean },
28
- lendingInitialized: { type: Boolean },
29
- lendingStatus: { type: Object },
30
- menuProviders: { type: Object },
31
- menuShortcuts: { type: Array },
32
- sideMenuOpen: { type: Boolean },
33
- signedIn: { type: Boolean },
34
- };
35
- }
36
-
37
- constructor() {
38
- super();
39
- this.book = {};
40
- this.pageContainerSelector = '.BRcontainer';
41
- this.brWidth = 0;
42
- this.bookReaderCannotLoad = false;
43
- this.bookReaderLoaded = false;
44
- this.bookreader = null;
45
- this.downloadableTypes = [];
46
- this.isAdmin = false;
47
- this.lendingInitialized = false;
48
- this.lendingStatus = {};
49
- this.menuProviders = {};
50
- this.menuShortcuts = [];
51
- this.sideMenuOpen = false;
52
- this.signedIn = false;
53
-
54
- // Untracked properties
55
- this.fullscreenMgr = null;
56
- this.brResizeObserver = null;
57
- this.model = new Book();
58
- this.shortcutOrder = ['volumes', 'search', 'bookmarks'];
59
- }
60
-
61
- firstUpdated() {
62
- this.model.setMetadata(this.book);
63
- this.bindEventListeners();
64
- this.emitPostInit();
65
- }
66
-
67
- updated(changed) {
68
- if (!this.bookreader) {
69
- return;
70
- }
71
- const isFirstSideMenuUpdate = changed.has('sideMenuOpen') && (changed.get('sideMenuOpen') === undefined);
72
- if (!isFirstSideMenuUpdate && changed.has('sideMenuOpen')) {
73
- // realign image
74
- this.bookreader.resize();
75
- const curIndex = this.bookreader.currentIndex();
76
- this.bookreader.jumpToIndex(curIndex);
77
- }
78
- }
79
-
80
- /**
81
- * Global event emitter for when Book Navigator loads
82
- */
83
- emitPostInit() {
84
- // emit global event when book nav has loaded with current bookreader selector
85
- this.dispatchEvent(new CustomEvent(`BrBookNav:${events.PostInit}`, {
86
- detail: { brSelector: this.bookreader?.el },
87
- bubbles: true,
88
- composed: true,
89
- }));
90
- }
91
-
92
- /**
93
- * Instantiates books submenus & their update callbacks
94
- *
95
- * NOTE: we are doing our best to scope bookreader's instance.
96
- * If your submenu provider uses a bookreader instance to read, manually
97
- * manipulate BookReader, please update the navigator's instance of it
98
- * to keep it in sync.
99
- */
100
- initializeBookSubmenus() {
101
- this.menuProviders = {
102
- search: new SearchProvider(
103
- (brInstance = null) => {
104
- if (brInstance) {
105
- /* refresh br instance reference */
106
- this.bookreader = brInstance;
107
- }
108
- this.updateMenuContents();
109
- if (this.brWidth >= 640) { /* open side search menu */
110
- this.openSideSearchMenu();
111
- }
112
- },
113
- this.bookreader,
114
- ),
115
- downloads: new DownloadProvider(),
116
- visualAdjustments: new VisualAdjustmentProvider({
117
- onOptionChange: (event, brInstance = null) => {
118
- if (brInstance) {
119
- /* refresh br instance reference */
120
- this.bookreader = brInstance;
121
- }
122
- this.updateMenuContents();
123
- },
124
- bookContainerSelector: this.pageContainerSelector,
125
- bookreader: this.bookreader,
126
- }),
127
- share: new SharingProvider(this.book.metadata, this.baseHost, this.itemType),
128
- bookmarks: new BookmarksProvider(this.bookmarksOptions, this.bookreader)
129
- };
130
-
131
- this.addMenuShortcut('search'); /* start with search as a shortcut */
132
- this.updateMenuContents();
133
- }
134
-
135
- /** gets element that houses the bookreader in light dom */
136
- get mainBRContainer() {
137
- return document.querySelector(this.bookreader.el);
138
- }
139
-
140
- get bookmarksOptions() {
141
- const referrerStr = `referer=${encodeURIComponent(location.href)}`
142
- return {
143
- loginUrl: `https://${this.baseHost}/account/login?${referrerStr}`,
144
- displayMode: this.signedIn ? 'bookmarks' : 'login',
145
- showItemNavigatorModal: this.showItemNavigatorModal.bind(this),
146
- closeItemNavigatorModal: this.closeItemNavigatorModal.bind(this),
147
- onBookmarksChanged: (bookmarks) => {
148
- const method = Object.keys(bookmarks).length ? 'add' : 'remove';
149
- this[`${method}MenuShortcut`]('bookmarks');
150
- this.updateMenuContents();
151
- },
152
- };
153
- }
154
-
155
- /**
156
- * Open side search menu
157
- */
158
- openSideSearchMenu() {
159
- const event = new CustomEvent(
160
- events.updateSideMenu, {
161
- detail: { menuId: 'search', action: 'open' },
162
- },
163
- );
164
- this.dispatchEvent(event);
165
- }
166
-
167
- /**
168
- * Sets order of menu and emits custom event when done
169
- */
170
- updateMenuContents() {
171
- const {
172
- search, downloads, visualAdjustments, share, bookmarks,
173
- } = this.menuProviders;
174
- const availableMenus = [search, bookmarks, visualAdjustments, share].filter((menu) => !!menu);
175
-
176
- if (this.shouldShowDownloadsMenu()) {
177
- downloads.update(this.downloadableTypes);
178
- availableMenus.splice(1, 0, downloads);
179
- }
180
-
181
- const event = new CustomEvent(
182
- events.menuUpdated, {
183
- detail: availableMenus,
184
- },
185
- );
186
- this.dispatchEvent(event);
187
- }
188
-
189
- /**
190
- * Confirms if we should show the downloads menu
191
- * @returns {bool}
192
- */
193
- shouldShowDownloadsMenu() {
194
- if (this.model.isRestricted === false) { return true; }
195
- if (this.isAdmin) { return true; }
196
- const { user_loan_record = {} } = this.lendingStatus;
197
- const hasNoLoanRecord = Array.isArray(user_loan_record); /* (bc PHP assoc. arrays) */
198
-
199
- if (hasNoLoanRecord) { return false; }
200
-
201
- const hasValidLoan = user_loan_record.type && (user_loan_record.type !== 'SESSION_LOAN');
202
- return hasValidLoan;
203
- }
204
-
205
- /**
206
- * Adds a provider object to the menuShortcuts array property if it isn't
207
- * already added. menuShortcuts are then sorted by shortcutOrder and
208
- * a menuShortcutsUpdated event is emitted.
209
- *
210
- * @param {string} menuId - a string matching the id property of a provider
211
- */
212
- addMenuShortcut(menuId) {
213
- if (this.menuShortcuts.find((m) => m.id === menuId)) { return; }
214
-
215
- this.menuShortcuts.push(this.menuProviders[menuId]);
216
- this.sortMenuShortcuts();
217
- this.emitMenuShortcutsUpdated();
218
- }
219
-
220
- /**
221
- * Removes a provider object from the menuShortcuts array and emits a
222
- * menuShortcutsUpdated event.
223
- *
224
- * @param {string} menuId - a string matching the id property of a provider
225
- */
226
- removeMenuShortcut(menuId) {
227
- this.menuShortcuts = this.menuShortcuts.filter((m) => m.id !== menuId);
228
- this.emitMenuShortcutsUpdated();
229
- }
230
-
231
- /**
232
- * Sorts the menuShortcuts property by comparing each provider's id to
233
- * the id in each iteration over the shortcutOrder array.
234
- */
235
- sortMenuShortcuts() {
236
- this.menuShortcuts = this.shortcutOrder.reduce((shortcuts, id) => {
237
- const menu = this.menuShortcuts.find((m) => m.id === id);
238
- if (menu) { shortcuts.push(menu); }
239
- return shortcuts;
240
- }, []);
241
- }
242
-
243
- emitMenuShortcutsUpdated() {
244
- const event = new CustomEvent('menuShortcutsUpdated', {
245
- detail: this.menuShortcuts,
246
- });
247
- this.dispatchEvent(event);
248
- }
249
-
250
- /**
251
- * Core bookreader event handler registry
252
- *
253
- * NOTE: we are trying to keep bookreader's instance in scope
254
- * Please update Book Navigator's instance reference of it to keep it current
255
- */
256
- bindEventListeners() {
257
- window.addEventListener('BookReader:PostInit', (e) => {
258
- this.bookreader = e.detail.props;
259
- this.bookReaderLoaded = true;
260
- this.bookReaderCannotLoad = false;
261
- this.fullscreenMgr = new BRFullscreenMgr(this.bookreader.el);
262
-
263
- this.initializeBookSubmenus();
264
- setTimeout(() => this.bookreader.resize(), 0);
265
- this.brResizeObserver = new ResizeObserver((elements) => this.reactToBrResize(elements));
266
- this.brResizeObserver.observe(this.mainBRContainer);
267
- });
268
- window.addEventListener('BookReader:fullscreenToggled', (event) => {
269
- const { detail: { props: brInstance = null } } = event;
270
- if (brInstance) {
271
- this.bookreader = brInstance;
272
- }
273
- this.manageFullScreenBehavior(event);
274
- }, { passive: true });
275
- window.addEventListener('BookReader:ToggleSearchMenu', (event) => {
276
- this.dispatchEvent(new CustomEvent(events.updateSideMenu, {
277
- detail: { menuId: 'search', action: 'toggle' },
278
- }));
279
- });
280
- window.addEventListener('LendingFlow:PostInit', ({ detail }) => {
281
- const {
282
- downloadTypesAvailable, lendingStatus, isAdmin, previewType,
283
- } = detail;
284
- this.lendingInitialized = true;
285
- this.downloadableTypes = downloadTypesAvailable;
286
- this.lendingStatus = lendingStatus;
287
- this.isAdmin = isAdmin;
288
- this.bookReaderCannotLoad = previewType === 'singlePagePreview';
289
- });
290
- window.addEventListener('BRJSIA:PostInit', ({ detail }) => {
291
- const { isRestricted, downloadURLs } = detail;
292
- this.bookReaderLoaded = true;
293
- this.downloadableTypes = downloadURLs;
294
- this.model.setRestriction(isRestricted);
295
- });
296
- }
297
-
298
- /**
299
- * Uses resize observer to fire BookReader's `resize` functionality
300
- * We do not want to trigger resize IF:
301
- * - book animation is happening
302
- * - book is in fullscreen (fullscreen is handled separately)
303
- *
304
- * @param { Object } entries - resize observer entries
305
- */
306
- reactToBrResize(entries = []) {
307
- const startBrWidth = this.brWidth;
308
- const { animating } = this.bookreader;
309
-
310
- entries.forEach(({ contentRect, target }) => {
311
- if (target === this.mainBRContainer) {
312
- this.brWidth = contentRect.width;
313
- }
314
- });
315
- setTimeout(() => {
316
- if (startBrWidth && !animating) {
317
- this.bookreader.resize();
318
- }
319
- }, 0);
320
- }
321
-
322
- /**
323
- * Manages Fullscreen behavior
324
- * This makes sure that controls are _always_ in view
325
- * We need this to accommodate LOAN BAR during fullscreen
326
- */
327
- manageFullScreenBehavior() {
328
- this.emitFullScreenState();
329
-
330
- if (!this.bookreader.isFullscreen()) {
331
- this.fullscreenMgr.teardown();
332
- } else {
333
- this.fullscreenMgr.setup(this.bookreader);
334
- }
335
- }
336
-
337
- /**
338
- * Intercepts and relays fullscreen toggle events
339
- */
340
- emitFullScreenState() {
341
- const isFullScreen = this.bookreader.isFullscreen();
342
- const event = new CustomEvent('ViewportInFullScreen', {
343
- detail: { isFullScreen },
344
- });
345
- this.dispatchEvent(event);
346
- }
347
-
348
- emitShowItemNavigatorModal(e) {
349
- this.dispatchEvent(new CustomEvent('showItemNavigatorModal', {
350
- detail: e.detail,
351
- }));
352
- }
353
-
354
- emitCloseItemNavigatorModal() {
355
- this.dispatchEvent(new CustomEvent('closeItemNavigatorModal'));
356
- }
357
-
358
- showItemNavigatorModal(e) {
359
- this.emitShowItemNavigatorModal(e);
360
- }
361
-
362
- closeItemNavigatorModal() {
363
- this.emitCloseItemNavigatorModal();
364
- }
365
-
366
- get loader() {
367
- const loader = html`
368
- <div class="book-loader">${bookLoader}<div>
369
- <h3>Loading viewer</h3>
370
- `;
371
- return !this.bookReaderLoaded ? loader : nothing;
372
- }
373
-
374
- get loadingClass() {
375
- return !this.bookReaderLoaded ? 'loading' : '';
376
- }
377
-
378
- get itemImage() {
379
- const url = `https://${this.baseHost}/services/img/${this.book.metadata.identifier}`;
380
- return html`<img src="${url}" alt="cover image for ${this.book.metadata.identifier}">`;
381
- }
382
-
383
- render() {
384
- const placeholder = this.bookReaderCannotLoad ? this.itemImage : this.loader;
385
- return html`<div id="book-navigator" class="${this.loadingClass}">
386
- ${placeholder}
387
- <slot name="bookreader"></slot>
388
- </div>
389
- `;
390
- }
391
-
392
- static get styles() {
393
- return css`
394
- #book-navigator.loading {
395
- display: flex;
396
- align-items: center;
397
- justify-content: center;
398
- min-height: 30vh;
399
- }
400
-
401
- #book-navigator .book-loader {
402
- width: 30%;
403
- margin: auto;
404
- text-align: center;
405
- color: var(--primaryTextColor);
406
- }
407
-
408
- .book-loader svg {
409
- display: block;
410
- width: 60%;
411
- max-width: 100px;
412
- height: auto;
413
- margin: auto;
414
- }
415
-
416
- svg * {
417
- fill: var(--primaryTextColor);
418
- }
419
-
420
- svg .ring {
421
- animation: rotate 1.3s infinite linear;
422
- transform-origin: 50px 50px;
423
- transform-box: fill-box;
424
- }
425
-
426
- @keyframes rotate {
427
- 0% {
428
- transform: rotate(-360deg);
429
- }
430
- }
431
- `
432
- }
433
- }
434
-
435
- customElements.define('book-navigator', BookNavigator);
package/src/BookNavigator/assets/book-loader.js DELETED
@@ -1,27 +0,0 @@
1
- import { html } from 'lit-element';
2
-
3
- export default html`
4
- <svg
5
- height="100"
6
- viewBox="0 0 100 100"
7
- width="100"
8
- xmlns="http://www.w3.org/2000/svg"
9
- aria-labelledby="bookreader-loading"
10
- >
11
- <title id="bookreader-loading">Currently loading viewer.</title>
12
- <desc>Please wait while we load book reader.</desc>
13
- <g fill="#333" fill-rule="evenodd" class="book-icon">
14
- <g transform="matrix(1 0 0 -1 28 67.362264)">
15
- <path d="m44.71698 31.6981124v-29.99320678s-18.0956599.30735848-18.6322637-.7171698c-.0633962-.12226414-1.890566-.59207545-2.9745282-.59207545-1.3228302 0-3.5122641 0-4.1286791.74547168-.9707547 1.17452827-18.82811278.71660375-18.82811278.71660375v30.040754l1.83849052.7867924.29094339-28.48188608s15.94981097.15339622 17.09094297-1.10716978c.8145283-.90056602 4.997547-.91641507 5.3450942-.3526415.9611321 1.55716977 14.7101883 1.31716978 17.6077354 1.45981128l.3266038 28.22830118z"/>
16
- <path d="m40.1129424 33.5957539h-12.8337733c-1.8690565 0-3.1098112-.7545283-3.9299999-1.6279245v-26.70452764l1.2362264-.00792453c.4584906.72962262 3.0922641 1.39415091 3.0922641 1.39415091h10.1298111s1.0381131.01754717 1.5141509.47377357c.5643396.54056602.7913207 1.36981129.7913207 1.36981129z"/>
17
- <path d="m17.3354713 33.5957539h-12.8337733v-25.37660316s0-.75283017.49358489-1.14113205c.52867924-.41433961 1.3415094-.42849055 1.3415094-.42849055h10.59905631s2.2075471-.52698112 3.0928301-1.39415091l1.2.00792453v26.74245214c-.8201886.8581132-2.0530188 1.59-3.8932074 1.59"/>
18
- </g>
19
- <path
20
- class="ring"
21
- d="m17.8618849 11.6970233c18.5864635-15.59603144 45.6875867-15.59603102 64.2740497.000001 1.9271446 1.6170806 2.1785128 4.4902567.5614466 6.4174186-1.6170661 1.9271618-4.4902166 2.1785323-6.4173612.5614517-15.1996922-12.75416882-37.3625282-12.75416916-52.5622206-.000001-15.19969387 12.7541707-19.04823077 34.5805019-9.1273354 51.7641499 9.9208955 17.183646 30.7471499 24.7638499 49.3923323 17.9774983 18.6451823-6.7863521 29.7266014-25.9801026 26.2811129-45.5206248-.436848-2.4775114 1.2174186-4.8400696 3.6949079-5.2769215 2.4774893-.4368518 4.8400264 1.2174296 5.2768744 3.694941 4.2132065 23.8945096-9.3373563 47.3649806-32.137028 55.6634567-22.799672 8.2984758-48.2663986-.9707372-60.39785211-21.9832155-12.1314534-21.012481-7.42539173-47.7021198 11.16107351-63.2981544z"
22
- fill-rule="nonzero"
23
- />
24
- </g>
25
- </svg>
26
- `;
27
-
package/src/BookNavigator/br-fullscreen-mgr.js DELETED
@@ -1,83 +0,0 @@
1
- import Debouncer from '../util/debouncer';
2
-
3
- /**
4
- * Manages fullscreen size
5
- * so that bookreader chrome is always visible
6
- * This is a shim to hold us until we update loan bar
7
- * https://drive.google.com/drive/folders/1Ym9FDMZPiM4EbNh3NU-_2h8kizIYaLWt
8
- */
9
- export default class BRFullscreenMgr {
10
- constructor(brSelector = '#BookReader') {
11
- this.debounceTime = 250;
12
- this.savedScrollY = 0;
13
- this.savedScrollX = 0;
14
- this.brSelector = brSelector;
15
-
16
- this.setup = this.setup.bind(this);
17
- this.teardown = this.teardown.bind(this);
18
- this.resizeBookReaderContainer = this.resizeBookReaderContainer.bind(this);
19
-
20
- this.handleResizeEvent = this.handleResizeEvent.bind(this);
21
-
22
- this.handleBookReaderHeight = new Debouncer(
23
- this.resizeBookReaderContainer, this.debounceTime, this,
24
- );
25
- }
26
-
27
- get brDom() {
28
- return document.querySelector(this.brSelector);
29
- }
30
-
31
- /**
32
- * Sets bookreader height
33
- * & adds resize, orientationchange listeners
34
- * & passes captured scroll positions
35
- *
36
- * @param {object} brInstance
37
- */
38
- setup(brInstance) {
39
- this.bookreader = brInstance;
40
-
41
- this.resizeBookReaderContainer();
42
- window.addEventListener('resize', this.handleResizeEvent);
43
- }
44
-
45
- /**
46
- * Resets BookReader height
47
- * & removes event handlers, resets captured scroll positions
48
- */
49
- teardown() {
50
- this.brDom.setAttribute('style', '');
51
- window.removeEventListener('resize', this.handleResizeEvent);
52
- window.scrollTo(this.savedScrollX, this.savedScrollY);
53
- this.savedScrollX = 0;
54
- this.savedScrollY = 0;
55
- }
56
-
57
- /**
58
- * Event listener for resize & orientationchange
59
- */
60
- handleResizeEvent() {
61
- this.handleBookReaderHeight.execute();
62
- }
63
-
64
- /**
65
- * Calculates & sets BookReader's needed height to
66
- * take the loan bar into account
67
- * + appends fullscreen classes to DOM
68
- */
69
- resizeBookReaderContainer() {
70
- const { scrollX, scrollY } = window;
71
- this.savedScrollX = scrollX;
72
- this.savedScrollY = scrollY;
73
- this.bookreader.updateBrClasses();
74
-
75
- const loanbar = document.querySelector('.BookReaderMessage');
76
- const loanbarHeight = loanbar?.offsetHeight ?? 0;
77
- const windowHeight = window.innerHeight;
78
- const newHeight = `${(windowHeight - loanbarHeight)}px`;
79
- this.brDom.style.height = newHeight;
80
- this.brDom.style.top = loanbarHeight;
81
- window.scrollTo(0, 0);
82
- }
83
- }