@internetarchive/bookreader 5.0.0-6-multiple-files → 5.0.0-60
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.
- package/.eslintrc.js +17 -15
- package/.github/workflows/node.js.yml +77 -6
- package/.github/workflows/npm-publish.yml +6 -20
- package/.testcaferc.js +10 -0
- package/BookReader/BookReader.css +241 -377
- package/BookReader/BookReader.js +2 -21564
- package/BookReader/BookReader.js.LICENSE.txt +24 -20
- package/BookReader/BookReader.js.map +1 -1
- package/BookReader/ia-bookreader-bundle.js +1519 -0
- package/BookReader/ia-bookreader-bundle.js.LICENSE.txt +17 -0
- package/BookReader/ia-bookreader-bundle.js.map +1 -0
- package/BookReader/icons/1up.svg +1 -12
- package/BookReader/icons/2up.svg +1 -15
- package/BookReader/icons/advance.svg +3 -26
- package/BookReader/icons/chevron-right.svg +1 -1
- package/BookReader/icons/close-circle-dark.svg +1 -0
- package/BookReader/icons/close-circle.svg +1 -1
- package/BookReader/icons/fullscreen.svg +1 -17
- package/BookReader/icons/fullscreen_exit.svg +1 -17
- package/BookReader/icons/hamburger.svg +1 -15
- package/BookReader/icons/left-arrow.svg +1 -12
- package/BookReader/icons/magnify-minus.svg +1 -16
- package/BookReader/icons/magnify-plus.svg +1 -17
- package/BookReader/icons/magnify.svg +1 -15
- package/BookReader/icons/pause.svg +1 -23
- package/BookReader/icons/play.svg +1 -22
- package/BookReader/icons/playback-speed.svg +1 -34
- package/BookReader/icons/read-aloud.svg +1 -22
- package/BookReader/icons/review.svg +3 -22
- package/BookReader/icons/thumbnails.svg +1 -17
- package/BookReader/icons/voice.svg +1 -0
- package/BookReader/icons/volume-full.svg +1 -22
- package/BookReader/images/BRicons.svg +5 -94
- package/BookReader/images/books_graphic.svg +1 -177
- package/BookReader/images/icon_book.svg +1 -12
- package/BookReader/images/icon_bookmark.svg +1 -12
- package/BookReader/images/icon_gear.svg +1 -14
- package/BookReader/images/icon_hamburger.svg +1 -20
- package/BookReader/images/icon_home.svg +1 -21
- package/BookReader/images/icon_info.svg +1 -11
- package/BookReader/images/icon_one_page.svg +1 -8
- package/BookReader/images/icon_pause.svg +1 -1
- package/BookReader/images/icon_play.svg +1 -1
- package/BookReader/images/icon_playback-rate.svg +1 -15
- package/BookReader/images/icon_search_button.svg +1 -8
- package/BookReader/images/icon_share.svg +1 -9
- package/BookReader/images/icon_skip-ahead.svg +1 -6
- package/BookReader/images/icon_skip-back.svg +2 -13
- package/BookReader/images/icon_speaker.svg +1 -18
- package/BookReader/images/icon_speaker_open.svg +1 -10
- package/BookReader/images/icon_thumbnails.svg +1 -12
- package/BookReader/images/icon_toc.svg +1 -5
- package/BookReader/images/icon_two_pages.svg +1 -9
- package/BookReader/images/marker_chap-off.svg +1 -11
- package/BookReader/images/marker_chap-on.svg +1 -11
- package/BookReader/images/marker_srch-on.svg +1 -11
- package/BookReader/jquery-3.js +2 -0
- package/BookReader/jquery-3.js.LICENSE.txt +24 -0
- package/BookReader/plugins/plugin.archive_analytics.js +1 -172
- package/BookReader/plugins/plugin.archive_analytics.js.map +1 -1
- package/BookReader/plugins/plugin.autoplay.js +1 -165
- package/BookReader/plugins/plugin.autoplay.js.map +1 -1
- package/BookReader/plugins/plugin.chapters.js +1 -304
- package/BookReader/plugins/plugin.chapters.js.map +1 -1
- package/BookReader/plugins/plugin.iframe.js +1 -74
- package/BookReader/plugins/plugin.iframe.js.map +1 -1
- package/BookReader/plugins/plugin.mobile_nav.js +1 -334
- package/BookReader/plugins/plugin.mobile_nav.js.map +1 -1
- package/BookReader/plugins/plugin.resume.js +1 -368
- package/BookReader/plugins/plugin.resume.js.map +1 -1
- package/BookReader/plugins/plugin.search.js +1 -1420
- package/BookReader/plugins/plugin.search.js.map +1 -1
- package/BookReader/plugins/plugin.text_selection.js +1 -1080
- package/BookReader/plugins/plugin.text_selection.js.map +1 -1
- package/BookReader/plugins/plugin.tts.js +2 -9193
- package/BookReader/plugins/plugin.tts.js.map +1 -1
- package/BookReader/plugins/plugin.url.js +1 -269
- package/BookReader/plugins/plugin.url.js.map +1 -1
- package/BookReader/plugins/plugin.vendor-fullscreen.js +1 -379
- package/BookReader/plugins/plugin.vendor-fullscreen.js.map +1 -1
- package/BookReader/webcomponents-bundle.js +3 -0
- package/BookReader/webcomponents-bundle.js.LICENSE.txt +9 -0
- package/BookReader/webcomponents-bundle.js.map +1 -0
- package/BookReaderDemo/BookReaderDemo.css +14 -1
- package/BookReaderDemo/BookReaderJSAutoplay.js +4 -1
- package/BookReaderDemo/BookReaderJSSimple.js +1 -0
- package/BookReaderDemo/IADemoBr.js +147 -0
- package/BookReaderDemo/demo-advanced.html +2 -2
- package/BookReaderDemo/demo-autoplay.html +2 -1
- package/BookReaderDemo/demo-embed-iframe-src.html +2 -1
- package/BookReaderDemo/demo-fullscreen-mobile.html +2 -1
- package/BookReaderDemo/demo-fullscreen.html +2 -1
- package/BookReaderDemo/demo-iiif.html +2 -1
- package/BookReaderDemo/demo-internetarchive.html +84 -17
- package/BookReaderDemo/demo-multiple.html +2 -1
- package/BookReaderDemo/demo-preview-pages.html +2 -1
- package/BookReaderDemo/demo-simple.html +2 -1
- package/BookReaderDemo/demo-vendor-fullscreen.html +2 -1
- package/BookReaderDemo/ia-multiple-volumes-manifest.js +170 -0
- package/BookReaderDemo/immersion-1up.html +2 -1
- package/BookReaderDemo/immersion-mode.html +2 -1
- package/BookReaderDemo/toggle_controls.html +2 -1
- package/BookReaderDemo/view_mode.html +2 -1
- package/BookReaderDemo/viewmode-cycle.html +2 -3
- package/CHANGELOG.md +246 -0
- package/README.md +14 -1
- package/babel.config.js +19 -0
- package/codecov.yml +6 -0
- package/index.html +3 -0
- package/jsconfig.json +19 -0
- package/netlify.toml +5 -0
- package/package.json +70 -59
- package/renovate.json +52 -0
- package/scripts/preversion.js +4 -1
- package/src/BookNavigator/assets/bookmark-colors.js +1 -1
- package/src/BookNavigator/assets/button-base.js +9 -2
- package/src/BookNavigator/assets/ia-logo.js +17 -0
- package/src/BookNavigator/assets/icon_checkmark.js +1 -1
- package/src/BookNavigator/assets/icon_close.js +1 -1
- package/src/BookNavigator/assets/icon_sort_asc.js +5 -0
- package/src/BookNavigator/assets/{icon_sort_ascending.js → icon_sort_desc.js} +2 -2
- package/src/BookNavigator/assets/icon_sort_neutral.js +5 -0
- package/src/BookNavigator/assets/icon_volumes.js +11 -0
- package/src/BookNavigator/book-navigator.js +585 -0
- package/src/BookNavigator/bookmarks/bookmark-button.js +3 -2
- package/src/BookNavigator/bookmarks/bookmark-edit.js +3 -4
- package/src/BookNavigator/bookmarks/bookmarks-list.js +2 -3
- package/src/BookNavigator/bookmarks/bookmarks-loginCTA.js +3 -8
- package/src/BookNavigator/bookmarks/bookmarks-provider.js +27 -17
- package/src/BookNavigator/bookmarks/ia-bookmarks.js +116 -67
- package/src/BookNavigator/delete-modal-actions.js +1 -1
- package/src/BookNavigator/downloads/downloads-provider.js +36 -21
- package/src/BookNavigator/downloads/downloads.js +41 -25
- package/src/BookNavigator/search/search-provider.js +80 -28
- package/src/BookNavigator/search/search-results.js +34 -25
- package/src/BookNavigator/sharing.js +27 -0
- package/src/BookNavigator/visual-adjustments/visual-adjustments-provider.js +11 -10
- package/src/BookNavigator/visual-adjustments/visual-adjustments.js +3 -3
- package/src/BookNavigator/volumes/volumes-provider.js +88 -53
- package/src/BookNavigator/volumes/volumes.js +41 -14
- package/src/BookReader/BookModel.js +59 -30
- package/src/BookReader/DebugConsole.js +3 -3
- package/src/BookReader/DragScrollable.js +233 -0
- package/src/BookReader/Mode1Up.js +56 -351
- package/src/BookReader/Mode1UpLit.js +391 -0
- package/src/BookReader/Mode2Up.js +73 -1318
- package/src/BookReader/Mode2UpLit.js +781 -0
- package/src/BookReader/ModeCoordinateSpace.js +29 -0
- package/src/BookReader/ModeSmoothZoom.js +211 -0
- package/src/BookReader/ModeThumb.js +17 -11
- package/src/BookReader/Navbar/Navbar.js +10 -36
- package/src/BookReader/PageContainer.js +69 -6
- package/src/BookReader/ReduceSet.js +1 -1
- package/src/BookReader/Toolbar/Toolbar.js +10 -37
- package/src/BookReader/events.js +2 -0
- package/src/BookReader/options.js +24 -2
- package/src/BookReader/utils/HTMLDimensionsCacher.js +44 -0
- package/src/BookReader/utils/ScrollClassAdder.js +31 -0
- package/src/BookReader/utils.js +108 -13
- package/src/BookReader.js +480 -825
- package/src/assets/icons/close-circle-dark.svg +1 -0
- package/src/assets/icons/magnify-minus.svg +3 -7
- package/src/assets/icons/magnify-plus.svg +3 -7
- package/src/assets/icons/voice.svg +1 -0
- package/src/css/BookReader.scss +0 -12
- package/src/css/_BRBookmarks.scss +1 -1
- package/src/css/_BRComponent.scss +1 -1
- package/src/css/_BRmain.scss +33 -24
- package/src/css/_BRnav.scss +4 -26
- package/src/css/_BRpages.scss +147 -40
- package/src/css/_BRsearch.scss +25 -216
- package/src/css/_TextSelection.scss +16 -17
- package/src/css/_colorbox.scss +2 -2
- package/src/css/_controls.scss +17 -5
- package/src/css/_icons.scss +7 -1
- package/src/ia-bookreader/ia-bookreader.js +224 -0
- package/src/plugins/plugin.archive_analytics.js +3 -3
- package/src/plugins/plugin.autoplay.js +4 -9
- package/src/plugins/plugin.chapters.js +28 -35
- package/src/plugins/plugin.mobile_nav.js +11 -10
- package/src/plugins/plugin.resume.js +3 -3
- package/src/plugins/plugin.text_selection.js +32 -41
- package/src/plugins/plugin.vendor-fullscreen.js +4 -4
- package/src/plugins/search/plugin.search.js +179 -116
- package/src/plugins/search/view.js +63 -179
- package/src/plugins/tts/AbstractTTSEngine.js +46 -37
- package/src/plugins/tts/FestivalTTSEngine.js +13 -14
- package/src/plugins/tts/PageChunk.js +15 -21
- package/src/plugins/tts/PageChunkIterator.js +8 -12
- package/src/plugins/tts/WebTTSEngine.js +87 -71
- package/src/plugins/tts/plugin.tts.js +94 -125
- package/src/plugins/tts/utils.js +0 -25
- package/src/plugins/url/UrlPlugin.js +193 -0
- package/src/plugins/{plugin.url.js → url/plugin.url.js} +45 -16
- package/src/util/docCookies.js +21 -2
- package/tests/e2e/README.md +37 -0
- package/tests/e2e/autoplay.test.js +2 -2
- package/tests/e2e/base.test.js +7 -7
- package/tests/e2e/helpers/base.js +28 -23
- package/tests/e2e/helpers/debug.js +1 -1
- package/tests/e2e/helpers/desktopSearch.js +14 -13
- package/tests/e2e/helpers/mobileSearch.js +3 -3
- package/tests/e2e/helpers/params.js +17 -0
- package/tests/e2e/helpers/rightToLeft.js +4 -10
- package/tests/e2e/models/Navigation.js +13 -4
- package/tests/e2e/rightToLeft.test.js +4 -5
- package/tests/e2e/viewmode.test.js +40 -33
- package/tests/jest/BookNavigator/book-navigator.test.js +658 -0
- package/tests/jest/BookNavigator/bookmarks/bookmark-button.test.js +43 -0
- package/tests/{karma → jest}/BookNavigator/bookmarks/bookmark-edit.test.js +25 -26
- package/tests/{karma → jest}/BookNavigator/bookmarks/bookmarks-list.test.js +41 -42
- package/tests/jest/BookNavigator/bookmarks/ia-bookmarks.test.js +45 -0
- package/tests/jest/BookNavigator/downloads/downloads-provider.test.js +67 -0
- package/tests/jest/BookNavigator/downloads/downloads.test.js +53 -0
- package/tests/jest/BookNavigator/search/search-provider.test.js +167 -0
- package/tests/{karma/BookNavigator → jest/BookNavigator/search}/search-results.test.js +104 -60
- package/tests/jest/BookNavigator/sharing/sharing-provider.test.js +49 -0
- package/tests/jest/BookNavigator/visual-adjustments.test.js +200 -0
- package/tests/jest/BookNavigator/volumes/volumes-provider.test.js +184 -0
- package/tests/jest/BookNavigator/volumes/volumes.test.js +97 -0
- package/tests/{BookReader → jest/BookReader}/BookModel.test.js +59 -14
- package/tests/jest/BookReader/BookReaderPublicFunctions.test.js +193 -0
- package/tests/{BookReader → jest/BookReader}/DebugConsole.test.js +1 -1
- package/tests/{BookReader → jest/BookReader}/ImageCache.test.js +4 -4
- package/tests/jest/BookReader/Mode1UpLit.test.js +73 -0
- package/tests/jest/BookReader/Mode2Up.test.js +98 -0
- package/tests/jest/BookReader/Mode2UpLit.test.js +190 -0
- package/tests/jest/BookReader/ModeCoordinateSpace.test.js +16 -0
- package/tests/jest/BookReader/ModeSmoothZoom.test.js +175 -0
- package/tests/jest/BookReader/ModeThumb.test.js +71 -0
- package/tests/{BookReader → jest/BookReader}/Navbar/Navbar.test.js +10 -10
- package/tests/{BookReader → jest/BookReader}/PageContainer.test.js +88 -6
- package/tests/{BookReader → jest/BookReader}/ReduceSet.test.js +1 -1
- package/tests/{BookReader → jest/BookReader}/Toolbar/Toolbar.test.js +2 -2
- package/tests/jest/BookReader/utils/HTMLDimensionsCacher.test.js +59 -0
- package/tests/jest/BookReader/utils/ScrollClassAdder.test.js +49 -0
- package/tests/{BookReader → jest/BookReader}/utils/classes.test.js +1 -1
- package/tests/jest/BookReader/utils.test.js +217 -0
- package/tests/jest/BookReader.keyboard.test.js +190 -0
- package/tests/{BookReader.options.test.js → jest/BookReader.options.test.js} +9 -1
- package/tests/{BookReader.test.js → jest/BookReader.test.js} +26 -37
- package/tests/{plugins → jest/plugins}/plugin.archive_analytics.test.js +2 -2
- package/tests/{plugins → jest/plugins}/plugin.autoplay.test.js +4 -4
- package/tests/{plugins → jest/plugins}/plugin.chapters.test.js +10 -11
- package/tests/{plugins → jest/plugins}/plugin.iframe.test.js +2 -2
- package/tests/{plugins → jest/plugins}/plugin.mobile_nav.test.js +5 -5
- package/tests/{plugins → jest/plugins}/plugin.resume.test.js +3 -3
- package/tests/{plugins → jest/plugins}/plugin.text_selection.test.js +39 -47
- package/tests/{plugins → jest/plugins}/plugin.vendor-fullscreen.test.js +2 -2
- package/tests/{plugins → jest/plugins}/search/plugin.search.test.js +63 -47
- package/tests/{plugins → jest/plugins}/search/plugin.search.view.test.js +35 -6
- package/tests/{plugins → jest/plugins}/tts/AbstractTTSEngine.test.js +9 -9
- package/tests/{plugins → jest/plugins}/tts/FestivalTTSEngine.test.js +4 -4
- package/tests/{plugins → jest/plugins}/tts/PageChunk.test.js +1 -1
- package/tests/{plugins → jest/plugins}/tts/PageChunkIterator.test.js +3 -3
- package/tests/{plugins → jest/plugins}/tts/WebTTSEngine.test.js +47 -1
- package/tests/{plugins → jest/plugins}/tts/utils.test.js +1 -60
- package/tests/jest/plugins/url/UrlPlugin.test.js +190 -0
- package/tests/{plugins → jest/plugins/url}/plugin.url.test.js +53 -14
- package/tests/jest/setup.js +3 -0
- package/tests/{util → jest/util}/browserSniffing.test.js +1 -1
- package/tests/jest/util/docCookies.test.js +24 -0
- package/tests/{util → jest/util}/strings.test.js +1 -1
- package/tests/{utils.js → jest/utils.js} +38 -0
- package/webpack.config.js +11 -5
- package/.babelrc +0 -12
- package/.dependabot/config.yml +0 -6
- package/.testcaferc.json +0 -5
- package/BookReader/bookreader-component-bundle.js +0 -14312
- package/BookReader/bookreader-component-bundle.js.LICENSE.txt +0 -38
- package/BookReader/bookreader-component-bundle.js.map +0 -1
- package/BookReader/icons/sort-ascending.svg +0 -1
- package/BookReader/icons/sort-descending.svg +0 -1
- package/BookReader/jquery-1.10.1.js +0 -108
- package/BookReader/jquery-1.10.1.js.LICENSE.txt +0 -24
- package/BookReader/plugins/plugin.menu_toggle.js +0 -369
- package/BookReader/plugins/plugin.menu_toggle.js.map +0 -1
- package/BookReaderDemo/bookreader-template-bundle.js +0 -7178
- package/BookReaderDemo/demo-plugin-menu-toggle.html +0 -34
- package/karma.conf.js +0 -23
- package/src/BookNavigator/BookModel.js +0 -14
- package/src/BookNavigator/BookNavigator.js +0 -452
- package/src/BookNavigator/assets/book-loader.js +0 -27
- package/src/BookNavigator/assets/icon_sort_descending.js +0 -5
- package/src/BookNavigator/br-fullscreen-mgr.js +0 -83
- package/src/BookNavigator/search/a-search-result.js +0 -55
- package/src/BookReaderComponent/BookReaderComponent.js +0 -112
- package/src/ItemNavigator/ItemNavigator.js +0 -372
- package/src/ItemNavigator/providers/sharing.js +0 -29
- package/src/assets/icons/sort-ascending.svg +0 -1
- package/src/assets/icons/sort-descending.svg +0 -1
- package/src/dragscrollable-br.js +0 -261
- package/src/plugins/menu_toggle/plugin.menu_toggle.js +0 -324
- package/tests/BookReader/BookReaderPublicFunctions.test.js +0 -171
- package/tests/BookReader/Mode1Up.test.js +0 -164
- package/tests/BookReader/Mode2Up.test.js +0 -247
- package/tests/BookReader/utils.test.js +0 -109
- package/tests/e2e/ia-production/ia-prod-base.js +0 -17
- package/tests/karma/BookNavigator/book-navigator.test.js +0 -132
- package/tests/karma/BookNavigator/visual-adjustments.test.js +0 -201
- package/tests/karma/BookNavigator/volumes.test.js +0 -101
- package/tests/plugins/menu_toggle/plugin.menu_toggle.test.js +0 -68
- package/tests/util/docCookies.test.js +0 -15
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
export class UrlPlugin {
|
|
2
|
+
constructor(options = {}) {
|
|
3
|
+
this.bookReaderOptions = options;
|
|
4
|
+
|
|
5
|
+
// the canonical order of elements is important in the path and query string
|
|
6
|
+
this.urlSchema = [
|
|
7
|
+
{ name: 'page', position: 'path', default: 'n0' },
|
|
8
|
+
{ name: 'mode', position: 'path', default: '2up' },
|
|
9
|
+
{ name: 'search', position: 'path', deprecated_for: 'q' },
|
|
10
|
+
{ name: 'q', position: 'query_param' },
|
|
11
|
+
{ name: 'sort', position: 'query_param' },
|
|
12
|
+
{ name: 'view', position: 'query_param' },
|
|
13
|
+
{ name: 'admin', position: 'query_param' },
|
|
14
|
+
];
|
|
15
|
+
|
|
16
|
+
this.urlState = {};
|
|
17
|
+
this.urlMode = this.bookReaderOptions.urlMode || 'hash';
|
|
18
|
+
this.urlHistoryBasePath = this.bookReaderOptions.urlHistoryBasePath || '/';
|
|
19
|
+
this.urlLocationPollId = null;
|
|
20
|
+
this.oldLocationHash = null;
|
|
21
|
+
this.oldUserHash = null;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Parse JSON object URL state to string format
|
|
26
|
+
* Arrange path names in an order that it is positioned on the urlSchema
|
|
27
|
+
* @param {Object} urlState
|
|
28
|
+
* @returns {string}
|
|
29
|
+
*/
|
|
30
|
+
urlStateToUrlString(urlState) {
|
|
31
|
+
const searchParams = new URLSearchParams();
|
|
32
|
+
const pathParams = {};
|
|
33
|
+
|
|
34
|
+
Object.keys(urlState).forEach(key => {
|
|
35
|
+
let schema = this.urlSchema.find(schema => schema.name === key);
|
|
36
|
+
if (schema?.deprecated_for) {
|
|
37
|
+
schema = this.urlSchema.find(schemaKey => schemaKey.name === schema.deprecated_for);
|
|
38
|
+
}
|
|
39
|
+
if (schema?.position == 'path') {
|
|
40
|
+
pathParams[schema?.name] = urlState[key];
|
|
41
|
+
} else {
|
|
42
|
+
searchParams.append(schema?.name || key, urlState[key]);
|
|
43
|
+
}
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
const strPathParams = this.urlSchema
|
|
47
|
+
.filter(s => s.position == 'path')
|
|
48
|
+
.map(schema => pathParams[schema.name] ? `${schema.name}/${pathParams[schema.name]}` : '')
|
|
49
|
+
.join('/');
|
|
50
|
+
|
|
51
|
+
// replace consecutive slashes with a single slash + remove trailing slashes
|
|
52
|
+
const strStrippedTrailingSlash = `${strPathParams.replace(/\/+/g, '/').replace(/\/+$/, '')}`;
|
|
53
|
+
const concatenatedPath = `${strStrippedTrailingSlash}?${searchParams.toString()}`;
|
|
54
|
+
return searchParams.toString() ? concatenatedPath : `${strStrippedTrailingSlash}`;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Parse string URL and add it in the current urlState
|
|
59
|
+
* Example:
|
|
60
|
+
* /page/n7/mode/2up => {page: 'n7', mode: '2up'}
|
|
61
|
+
* /page/n7/mode/2up/search/hello => {page: 'n7', mode: '2up', q: 'hello'}
|
|
62
|
+
* @param {string} urlString
|
|
63
|
+
* @returns {object}
|
|
64
|
+
*/
|
|
65
|
+
urlStringToUrlState(urlString) {
|
|
66
|
+
const urlState = {};
|
|
67
|
+
|
|
68
|
+
// Fetch searchParams from given {str}
|
|
69
|
+
// Note: whole URL path is needed for URL parsing
|
|
70
|
+
const urlPath = new URL(urlString, 'http://example.com');
|
|
71
|
+
const urlSearchParamsObj = Object.fromEntries(urlPath.searchParams.entries());
|
|
72
|
+
const splitUrlMatches = urlPath.pathname.match(/[^\\/]+\/[^\\/]+/g);
|
|
73
|
+
const urlStrSplitSlashObj = splitUrlMatches ? Object.fromEntries(splitUrlMatches.map(x => x.split('/'))) : {};
|
|
74
|
+
|
|
75
|
+
const doesKeyExists = (_object, _key) => {
|
|
76
|
+
return Object.keys(_object).some(value => value == _key);
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
// Add path objects to urlState
|
|
80
|
+
this.urlSchema
|
|
81
|
+
.filter(schema => schema.position == 'path')
|
|
82
|
+
.forEach(schema => {
|
|
83
|
+
const hasPropertyKey = doesKeyExists(urlStrSplitSlashObj, schema.name);
|
|
84
|
+
const hasDeprecatedKey = doesKeyExists(schema, 'deprecated_for') && hasPropertyKey;
|
|
85
|
+
|
|
86
|
+
if (hasDeprecatedKey) {
|
|
87
|
+
urlState[schema.deprecated_for] = urlStrSplitSlashObj[schema.name];
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
if (hasPropertyKey) {
|
|
92
|
+
urlState[schema.name] = urlStrSplitSlashObj[schema.name];
|
|
93
|
+
return;
|
|
94
|
+
}
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
// Add searchParams to urlState
|
|
98
|
+
Object.entries(urlSearchParamsObj).forEach(([key, value]) => {
|
|
99
|
+
urlState[key] = value;
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
return urlState;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Add or update key-value to the urlState
|
|
107
|
+
* @param {string} key
|
|
108
|
+
* @param {string} val
|
|
109
|
+
*/
|
|
110
|
+
setUrlParam(key, value) {
|
|
111
|
+
this.urlState[key] = value;
|
|
112
|
+
|
|
113
|
+
this.pushToAddressBar();
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Delete key-value to the urlState
|
|
118
|
+
* @param {string} key
|
|
119
|
+
*/
|
|
120
|
+
removeUrlParam(key) {
|
|
121
|
+
delete this.urlState[key];
|
|
122
|
+
|
|
123
|
+
this.pushToAddressBar();
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Get key-value from the urlState
|
|
128
|
+
* @param {string} key
|
|
129
|
+
* @return {string}
|
|
130
|
+
*/
|
|
131
|
+
getUrlParam(key) {
|
|
132
|
+
return this.urlState[key];
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Push URL params to addressbar
|
|
137
|
+
*/
|
|
138
|
+
pushToAddressBar() {
|
|
139
|
+
const urlStrPath = this.urlStateToUrlString(this.urlState);
|
|
140
|
+
const concatenatedPath = urlStrPath !== '/' ? urlStrPath : '';
|
|
141
|
+
if (this.urlMode == 'history') {
|
|
142
|
+
if (!window.history || !window.history.replaceState) {
|
|
143
|
+
this.options.urlMode = 'hash';
|
|
144
|
+
} else {
|
|
145
|
+
const newUrlPath = `${this.urlHistoryBasePath}${concatenatedPath}`.trim().replace(/(\/+)/g, '/');
|
|
146
|
+
try {
|
|
147
|
+
window.history.replaceState({}, null, newUrlPath);
|
|
148
|
+
} catch (e) {
|
|
149
|
+
// DOMException on Chrome when in sandboxed iframe
|
|
150
|
+
this.urlMode = 'hash';
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
if (this.urlMode == 'hash') {
|
|
156
|
+
window.location.replace('#' + concatenatedPath);
|
|
157
|
+
}
|
|
158
|
+
this.oldLocationHash = urlStrPath;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Get the url and check if it has changed
|
|
163
|
+
* If it was changeed, update the urlState
|
|
164
|
+
*/
|
|
165
|
+
listenForHashChanges() {
|
|
166
|
+
this.oldLocationHash = window.location.hash.substr(1);
|
|
167
|
+
if (this.urlLocationPollId) {
|
|
168
|
+
clearInterval(this.urlLocationPollId);
|
|
169
|
+
this.urlLocationPollId = null;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
// check if the URL changes
|
|
173
|
+
const updateHash = () => {
|
|
174
|
+
const newFragment = window.location.hash.substr(1);
|
|
175
|
+
const hasFragmentChange = newFragment != this.oldLocationHash;
|
|
176
|
+
|
|
177
|
+
if (!hasFragmentChange) { return; }
|
|
178
|
+
|
|
179
|
+
this.urlState = this.urlStringToUrlState(newFragment);
|
|
180
|
+
};
|
|
181
|
+
this.urlLocationPollId = setInterval(updateHash, 500);
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* Will read either the hash or URL and return the bookreader fragment
|
|
186
|
+
*/
|
|
187
|
+
pullFromAddressBar (location = window.location) {
|
|
188
|
+
const path = this.urlMode === 'history'
|
|
189
|
+
? (location.pathname.substr(this.urlHistoryBasePath.length) + location.search)
|
|
190
|
+
: location.hash.substr(1);
|
|
191
|
+
this.urlState = this.urlStringToUrlState(path);
|
|
192
|
+
}
|
|
193
|
+
}
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
/* global BookReader */
|
|
2
|
+
|
|
3
|
+
import { UrlPlugin } from "./UrlPlugin";
|
|
4
|
+
|
|
2
5
|
/**
|
|
3
6
|
* Plugin for URL management in BookReader
|
|
4
7
|
* Note read more about the url "fragment" here:
|
|
@@ -22,7 +25,7 @@ jQuery.extend(BookReader.defaultOptions, {
|
|
|
22
25
|
urlHistoryBasePath: '/',
|
|
23
26
|
|
|
24
27
|
/** Only these params will be reflected onto the URL */
|
|
25
|
-
urlTrackedParams: ['page', 'search', 'mode', 'region', 'highlight'],
|
|
28
|
+
urlTrackedParams: ['page', 'search', 'mode', 'region', 'highlight', 'view'],
|
|
26
29
|
|
|
27
30
|
/** If true, don't update the URL when `page == n0 (eg "/page/n0")` */
|
|
28
31
|
urlTrackIndex0: false,
|
|
@@ -50,7 +53,7 @@ BookReader.prototype.init = (function(super_) {
|
|
|
50
53
|
this.bind(BookReader.eventNames.PostInit, () => {
|
|
51
54
|
const { updateWindowTitle, urlMode } = this.options;
|
|
52
55
|
if (updateWindowTitle) {
|
|
53
|
-
document.title = this.shortTitle(50);
|
|
56
|
+
document.title = this.shortTitle(this.bookTitle, 50);
|
|
54
57
|
}
|
|
55
58
|
if (urlMode === 'hash') {
|
|
56
59
|
this.urlStartLocationPolling();
|
|
@@ -86,7 +89,7 @@ BookReader.prototype.urlStartLocationPolling = function() {
|
|
|
86
89
|
this.oldLocationHash = this.urlReadFragment();
|
|
87
90
|
|
|
88
91
|
if (this.locationPollId) {
|
|
89
|
-
clearInterval(this.
|
|
92
|
+
clearInterval(this.locationPollId);
|
|
90
93
|
this.locationPollId = null;
|
|
91
94
|
}
|
|
92
95
|
|
|
@@ -110,7 +113,7 @@ BookReader.prototype.urlStartLocationPolling = function() {
|
|
|
110
113
|
updateParams();
|
|
111
114
|
}
|
|
112
115
|
this.oldUserHash = newFragment;
|
|
113
|
-
}
|
|
116
|
+
};
|
|
114
117
|
|
|
115
118
|
this.locationPollId = setInterval(updateHash, 500);
|
|
116
119
|
};
|
|
@@ -121,7 +124,7 @@ BookReader.prototype.urlStartLocationPolling = function() {
|
|
|
121
124
|
*/
|
|
122
125
|
BookReader.prototype.urlUpdateFragment = function() {
|
|
123
126
|
const allParams = this.paramsFromCurrent();
|
|
124
|
-
const {
|
|
127
|
+
const { urlTrackIndex0, urlTrackedParams } = this.options;
|
|
125
128
|
|
|
126
129
|
if (!urlTrackIndex0
|
|
127
130
|
&& (typeof(allParams.index) !== 'undefined')
|
|
@@ -134,32 +137,39 @@ BookReader.prototype.urlUpdateFragment = function() {
|
|
|
134
137
|
if (paramName in allParams) {
|
|
135
138
|
validParams[paramName] = allParams[paramName];
|
|
136
139
|
}
|
|
137
|
-
return validParams
|
|
140
|
+
return validParams;
|
|
138
141
|
}, {});
|
|
139
142
|
|
|
140
|
-
const newFragment = this.fragmentFromParams(params, urlMode);
|
|
143
|
+
const newFragment = this.fragmentFromParams(params, this.options.urlMode);
|
|
141
144
|
const currFragment = this.urlReadFragment();
|
|
142
145
|
const currQueryString = this.getLocationSearch();
|
|
143
|
-
const newQueryString = this.queryStringFromParams(params, currQueryString, urlMode);
|
|
146
|
+
const newQueryString = this.queryStringFromParams(params, currQueryString, this.options.urlMode);
|
|
144
147
|
if (currFragment === newFragment && currQueryString === newQueryString) {
|
|
145
148
|
return;
|
|
146
149
|
}
|
|
147
150
|
|
|
148
|
-
if (urlMode === 'history') {
|
|
149
|
-
if (window.history
|
|
151
|
+
if (this.options.urlMode === 'history') {
|
|
152
|
+
if (!window.history || !window.history.replaceState) {
|
|
153
|
+
this.options.urlMode = 'hash';
|
|
154
|
+
} else {
|
|
150
155
|
const baseWithoutSlash = this.options.urlHistoryBasePath.replace(/\/+$/, '');
|
|
151
156
|
const newFragmentWithSlash = newFragment === '' ? '' : `/${newFragment}`;
|
|
152
157
|
|
|
153
158
|
const newUrlPath = `${baseWithoutSlash}${newFragmentWithSlash}${newQueryString}`;
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
159
|
+
try {
|
|
160
|
+
window.history.replaceState({}, null, newUrlPath);
|
|
161
|
+
this.oldLocationHash = newFragment + newQueryString;
|
|
162
|
+
} catch (e) {
|
|
163
|
+
// DOMException on Chrome when in sandboxed iframe
|
|
164
|
+
this.options.urlMode = 'hash';
|
|
165
|
+
}
|
|
157
166
|
}
|
|
158
|
-
}
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
if (this.options.urlMode === 'hash') {
|
|
159
170
|
const newQueryStringSearch = this.urlParamsFiltersOnlySearch(this.readQueryString());
|
|
160
171
|
window.location.replace('#' + newFragment + newQueryStringSearch);
|
|
161
172
|
this.oldLocationHash = newFragment + newQueryStringSearch;
|
|
162
|
-
|
|
163
173
|
}
|
|
164
174
|
};
|
|
165
175
|
|
|
@@ -173,7 +183,7 @@ BookReader.prototype.urlUpdateFragment = function() {
|
|
|
173
183
|
BookReader.prototype.urlParamsFiltersOnlySearch = function(url) {
|
|
174
184
|
const params = new URLSearchParams(url);
|
|
175
185
|
return params.has('q') ? `?${new URLSearchParams({ q: params.get('q') })}` : '';
|
|
176
|
-
}
|
|
186
|
+
};
|
|
177
187
|
|
|
178
188
|
|
|
179
189
|
/**
|
|
@@ -196,3 +206,22 @@ BookReader.prototype.urlReadFragment = function() {
|
|
|
196
206
|
BookReader.prototype.urlReadHashFragment = function() {
|
|
197
207
|
return window.location.hash.substr(1);
|
|
198
208
|
};
|
|
209
|
+
export class BookreaderUrlPlugin extends BookReader {
|
|
210
|
+
init() {
|
|
211
|
+
if (this.options.enableUrlPlugin) {
|
|
212
|
+
this.urlPlugin = new UrlPlugin(this.options);
|
|
213
|
+
this.bind(BookReader.eventNames.PostInit, () => {
|
|
214
|
+
const { urlMode } = this.options;
|
|
215
|
+
|
|
216
|
+
if (urlMode === 'hash') {
|
|
217
|
+
this.urlPlugin.listenForHashChanges();
|
|
218
|
+
}
|
|
219
|
+
});
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
super.init();
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
window.BookReader = BookreaderUrlPlugin;
|
|
227
|
+
export default BookreaderUrlPlugin;
|
package/src/util/docCookies.js
CHANGED
|
@@ -9,6 +9,22 @@
|
|
|
9
9
|
* http://www.gnu.org/licenses/gpl-3.0-standalone.html
|
|
10
10
|
*/
|
|
11
11
|
|
|
12
|
+
/**
|
|
13
|
+
* Check to see if the browser has cookies enabled.
|
|
14
|
+
* Accessing document.cookies errors if eg iframe with sandbox enabled.
|
|
15
|
+
* @returns {boolean}
|
|
16
|
+
*/
|
|
17
|
+
export function areCookiesBlocked(doc = document) {
|
|
18
|
+
try {
|
|
19
|
+
doc.cookie;
|
|
20
|
+
return false;
|
|
21
|
+
} catch (e) {
|
|
22
|
+
return true;
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
const COOKIES_BLOCKED = areCookiesBlocked();
|
|
27
|
+
|
|
12
28
|
/**
|
|
13
29
|
* Get specific key's value stored in cookie
|
|
14
30
|
*
|
|
@@ -17,7 +33,7 @@
|
|
|
17
33
|
* @returns {string|null}
|
|
18
34
|
*/
|
|
19
35
|
export function getItem(sKey) {
|
|
20
|
-
if (!sKey) return null;
|
|
36
|
+
if (COOKIES_BLOCKED || !sKey) return null;
|
|
21
37
|
|
|
22
38
|
return decodeURIComponent(
|
|
23
39
|
// eslint-disable-next-line no-useless-escape
|
|
@@ -34,9 +50,11 @@ export function getItem(sKey) {
|
|
|
34
50
|
* @param {string} [sDomain] domain name
|
|
35
51
|
* @param {boolean} [bSecure]
|
|
36
52
|
*
|
|
37
|
-
* @returns {
|
|
53
|
+
* @returns {boolean}
|
|
38
54
|
*/
|
|
39
55
|
export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
|
|
56
|
+
if (COOKIES_BLOCKED) return false;
|
|
57
|
+
|
|
40
58
|
document.cookie = encodeURIComponent(sKey) + '=' + encodeURIComponent(sValue)
|
|
41
59
|
+ (vEnd ? `; expires=${vEnd.toUTCString()}` : '')
|
|
42
60
|
+ (sDomain ? `; domain=${sDomain}` : '')
|
|
@@ -56,6 +74,7 @@ export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
|
|
|
56
74
|
* @returns {boolean}
|
|
57
75
|
*/
|
|
58
76
|
export function removeItem(sKey, sPath, sDomain) {
|
|
77
|
+
if (COOKIES_BLOCKED) return false;
|
|
59
78
|
// eslint-disable-next-line
|
|
60
79
|
if (!hasItem(sKey)) return false;
|
|
61
80
|
|
package/tests/e2e/README.md
CHANGED
|
@@ -48,6 +48,43 @@ To run a particular fixture, add the path to the file at the end of your argumen
|
|
|
48
48
|
|
|
49
49
|
`npm run test:e2e chrome tests/e2e/example.test.js`
|
|
50
50
|
|
|
51
|
+
### Testing netlify or archive.org
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
BASE_URL='https://lucid-poitras-9a1249.netlify.app' npx testcafe
|
|
55
|
+
BASE_URL='https://archive.org' npx testcafe
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Testing any OCAID
|
|
59
|
+
|
|
60
|
+
For OCAIDs you should pick the specific test file to run, since things like autoplay tests won't work. The main tests are in `base.test.js`.
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
OCAIDS='goody,goodytwoshoes00newyiala' npx testcafe tests/e2e/base.test.js
|
|
64
|
+
OCAIDS='goody,goodytwoshoes00newyiala' BASE_URL='https://archive.org' npx testcafe tests/e2e/base.test.js
|
|
65
|
+
|
|
66
|
+
# right to left book; note this also runs the base tests
|
|
67
|
+
OCAIDS='gendaitankashu00meijuoft' BASE_URL='https://archive.org' npx testcafe tests/e2e/rightToLeft.test.js
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Running tests with browserstack
|
|
71
|
+
|
|
72
|
+
Note these can only test a public url, so you either need to create a draft PR and use the netlify link, or use ngrok to publish your dev server's port.
|
|
73
|
+
|
|
74
|
+
Note: Windows users, there is a bug that prevents spaces in the browser field when using `npx`, so you'll need to have `testcafe` globally installed, and run it without `npx`. (See https://github.com/DevExpress/testcafe/issues/6600 ). Or, you can add browserstack browsers the `.testcaferc.js` file.
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
# Set auth; find yours at https://www.browserstack.com/accounts/settings
|
|
78
|
+
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
|
|
79
|
+
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
|
|
80
|
+
|
|
81
|
+
BASE_URL='https://archive.org' OCAIDS='goody,goodytwoshoes00newyiala' npx testcafe 'browserstack:iPad Pro 12.9 2018@15' tests/e2e/base.test.js
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
See a list of available browsers with `npx testcafe -b browserstack`. Note there are some browsers which appear to not work for some reason (eg `browserstack:iPad Mini 4@9.3`).
|
|
85
|
+
|
|
86
|
+
Read more about other options/etc at the browserstack docs: https://www.browserstack.com/docs/automate/selenium/getting-started/nodejs/testcafe .
|
|
87
|
+
|
|
51
88
|
## Pending (skip) tests
|
|
52
89
|
|
|
53
90
|
You can skip any tests by calling the method `.skip` on the test object rather
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { ClientFunction } from 'testcafe';
|
|
2
|
+
import params from './helpers/params';
|
|
2
3
|
|
|
3
|
-
const { BASE_URL } = process.env;
|
|
4
4
|
const getLocationHref = ClientFunction(() => window.location.href.toString());
|
|
5
5
|
const FLIP_SPEED = 1000;
|
|
6
6
|
const FIRST_PAGE_DELAY = 2000;
|
|
7
7
|
|
|
8
|
-
fixture `Autoplay plugin`.page `${
|
|
8
|
+
fixture `Autoplay plugin`.page `${params.baseUrl}/BookReaderDemo/demo-autoplay.html`;
|
|
9
9
|
|
|
10
10
|
test('page auto-advances after allotted flip speed and delay', async t => {
|
|
11
11
|
await t.wait(2 * FLIP_SPEED + FIRST_PAGE_DELAY);
|
package/tests/e2e/base.test.js
CHANGED
|
@@ -2,10 +2,9 @@ import { runBaseTests } from './helpers/base';
|
|
|
2
2
|
import BookReader from './models/BookReader';
|
|
3
3
|
import { runDesktopSearchTests } from './helpers/desktopSearch';
|
|
4
4
|
// import { runMobileSearchTests } from './helpers/mobileSearch';
|
|
5
|
+
import params from './helpers/params';
|
|
5
6
|
|
|
6
|
-
|
|
7
|
-
const { BASE_URL } = process.env;
|
|
8
|
-
const OCAIDS = [
|
|
7
|
+
const ocaids = params.ocaids || [
|
|
9
8
|
'theworksofplato01platiala',
|
|
10
9
|
// Removed because failing test 'Canonical URL with cookie shows paramters'
|
|
11
10
|
// in tests/e2e/helpers/base.js
|
|
@@ -15,18 +14,19 @@ const OCAIDS = [
|
|
|
15
14
|
// /BookReaderDemo/demo-ia-olivertwist.html/page/n13/mode/2up
|
|
16
15
|
// 'demo-ia-olivertwist.html',
|
|
17
16
|
];
|
|
18
|
-
const DEMO_PATH = 'demo-internetarchive.html?ocaid='
|
|
19
17
|
|
|
20
|
-
|
|
21
|
-
const url =
|
|
18
|
+
ocaids.forEach(ocaid => {
|
|
19
|
+
const url = params.getArchiveUrl(ocaid);
|
|
22
20
|
|
|
23
21
|
fixture `Base Tests for: ${ocaid}`.page `${url}`;
|
|
24
22
|
runBaseTests(new BookReader());
|
|
25
23
|
|
|
24
|
+
|
|
26
25
|
fixture `Desktop Search Tests for: ${ocaid}`
|
|
27
|
-
.page `${url}
|
|
26
|
+
.page `${url}`;
|
|
28
27
|
runDesktopSearchTests(new BookReader());
|
|
29
28
|
|
|
29
|
+
// Todo: deprecated, will remove once mmenu is removed.
|
|
30
30
|
// fixture `Mobile Search Tests for: ${ocaid}`
|
|
31
31
|
// .page `${url}`
|
|
32
32
|
// runMobileSearchTests(new BookReader());
|
|
@@ -96,7 +96,7 @@ export function runBaseTests (br) {
|
|
|
96
96
|
|
|
97
97
|
if (await usesResume()) {
|
|
98
98
|
await t.expect(isPageInUrl()).eql(true, initialUrl);
|
|
99
|
-
await t.expect(isModeInUrl('2up')).eql(true, initialUrl)
|
|
99
|
+
await t.expect(isModeInUrl('2up')).eql(true, initialUrl);
|
|
100
100
|
} else {
|
|
101
101
|
// No plugin, no br-resume cookie
|
|
102
102
|
await t.expect(getUrl()).notContains('#page/');
|
|
@@ -138,7 +138,7 @@ export function runBaseTests (br) {
|
|
|
138
138
|
|
|
139
139
|
// we aren't showing the same image in the new pages
|
|
140
140
|
await t.expect(prevImg1Src).notEql(prevImg2Src);
|
|
141
|
-
})
|
|
141
|
+
});
|
|
142
142
|
|
|
143
143
|
test('2up mode - Clicking `Next page` changes the page', async t => {
|
|
144
144
|
// Note: this will fail on a R to L book if at front cover
|
|
@@ -168,7 +168,7 @@ export function runBaseTests (br) {
|
|
|
168
168
|
|
|
169
169
|
// we aren't showing the same image in the new pages
|
|
170
170
|
await t.expect(nextImg1Src).notEql(nextImg2Src);
|
|
171
|
-
})
|
|
171
|
+
});
|
|
172
172
|
|
|
173
173
|
test('Clicking `page flip buttons` updates location', async t => {
|
|
174
174
|
const { nav } = br;
|
|
@@ -182,15 +182,21 @@ export function runBaseTests (br) {
|
|
|
182
182
|
await t.expect(isModeInUrl('2up')).eql(true);
|
|
183
183
|
});
|
|
184
184
|
|
|
185
|
-
test('Clicking `2 page view` brings up
|
|
185
|
+
test('Clicking `2 page view` brings up cur page + caching', async t => {
|
|
186
186
|
const { nav } = br;
|
|
187
187
|
await t.click(nav.desktop.mode2Up);
|
|
188
|
-
await t.expect(Selector('.BRpagecontainer').count).eql(
|
|
188
|
+
await t.expect(Selector('.BRpagecontainer.BRpage-visible').count).eql(1);
|
|
189
|
+
await t.expect(Selector('.BRpagecontainer').count).eql(3);
|
|
189
190
|
});
|
|
190
191
|
|
|
191
192
|
test('Clicking `1 page view` brings up 1 at a time', async t => {
|
|
192
193
|
const { nav } = br;
|
|
193
194
|
await t.click(nav.desktop.mode1Up);
|
|
195
|
+
|
|
196
|
+
// Flip away from cover
|
|
197
|
+
await t.click(nav.desktop.goNext);
|
|
198
|
+
await t.wait(PAGE_FLIP_WAIT_TIME);
|
|
199
|
+
|
|
194
200
|
// we usually pre-fetch the page in question & the 2 after it
|
|
195
201
|
await t.expect(Selector('.BRpagecontainer').count).gte(3);
|
|
196
202
|
});
|
|
@@ -202,41 +208,40 @@ export function runBaseTests (br) {
|
|
|
202
208
|
});
|
|
203
209
|
|
|
204
210
|
test('Clicking `zoom out` makes book smaller', async t => {
|
|
205
|
-
const { nav
|
|
206
|
-
const
|
|
211
|
+
const { nav } = br;
|
|
212
|
+
const page = Selector('.BRpagecontainer.BRpage-visible');
|
|
207
213
|
|
|
208
214
|
await t.expect(br.BRcontainer.visible).ok();
|
|
209
|
-
await t.expect(
|
|
215
|
+
await t.expect(page.visible).ok();
|
|
210
216
|
await t.expect(nav.desktop.zoomOut.visible).ok();
|
|
211
217
|
|
|
212
|
-
const initialBookHeight = await
|
|
213
|
-
const initialBookWidth = await
|
|
218
|
+
const initialBookHeight = await page.getBoundingClientRectProperty('height');
|
|
219
|
+
const initialBookWidth = await page.getBoundingClientRectProperty('width');
|
|
214
220
|
|
|
215
221
|
await t.click(nav.desktop.zoomOut);
|
|
216
222
|
|
|
217
|
-
const zoomOutBookHeight = await
|
|
218
|
-
const zoomOutBookWidth = await
|
|
223
|
+
const zoomOutBookHeight = await page.getBoundingClientRectProperty('height');
|
|
224
|
+
const zoomOutBookWidth = await page.getBoundingClientRectProperty('width');
|
|
219
225
|
|
|
220
|
-
await t.expect(zoomOutBookHeight).
|
|
221
|
-
await t.expect(zoomOutBookWidth).
|
|
226
|
+
await t.expect(zoomOutBookHeight).lt(initialBookHeight);
|
|
227
|
+
await t.expect(zoomOutBookWidth).lt(initialBookWidth);
|
|
222
228
|
});
|
|
223
229
|
|
|
224
230
|
test('Clicking `zoom in` makes book larger', async t => {
|
|
225
|
-
const { nav
|
|
226
|
-
|
|
227
|
-
const book = await BRcontainer.child(0);
|
|
231
|
+
const { nav } = br;
|
|
232
|
+
const page = Selector('.BRpagecontainer.BRpage-visible');
|
|
228
233
|
|
|
229
|
-
await t.expect(BRcontainer.visible).ok();
|
|
230
|
-
await t.expect(
|
|
234
|
+
await t.expect(br.BRcontainer.visible).ok();
|
|
235
|
+
await t.expect(page.visible).ok();
|
|
231
236
|
await t.expect(nav.desktop.zoomIn.visible).ok();
|
|
232
237
|
|
|
233
|
-
const initialBookHeight = await
|
|
234
|
-
const initialBookWidth = await
|
|
238
|
+
const initialBookHeight = await page.getBoundingClientRectProperty('height');
|
|
239
|
+
const initialBookWidth = await page.getBoundingClientRectProperty('width');
|
|
235
240
|
|
|
236
241
|
await t.click(nav.desktop.zoomIn);
|
|
237
242
|
|
|
238
|
-
const zoomInBookHeight = await
|
|
239
|
-
const zoomIntBookWidth = await
|
|
243
|
+
const zoomInBookHeight = await page.getBoundingClientRectProperty('height');
|
|
244
|
+
const zoomIntBookWidth = await page.getBoundingClientRectProperty('width');
|
|
240
245
|
|
|
241
246
|
await t.expect(zoomInBookHeight).gt(initialBookHeight);
|
|
242
247
|
await t.expect(zoomIntBookWidth).gt(initialBookWidth);
|
|
@@ -19,14 +19,15 @@ export function runDesktopSearchTests(br) {
|
|
|
19
19
|
const nav = br.nav;
|
|
20
20
|
|
|
21
21
|
//assuring that the search bar is enabled
|
|
22
|
-
await t.expect(nav.desktop.
|
|
22
|
+
await t.expect(nav.desktop.searchIcon.visible).ok();
|
|
23
|
+
await t.click(nav.desktop.searchIcon);
|
|
23
24
|
|
|
24
25
|
//testing search for a word found in the book
|
|
25
|
-
await t
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
await t.
|
|
29
|
-
|
|
26
|
+
await t.selectText(nav.desktop.searchBox).pressKey('delete');
|
|
27
|
+
// FIXME: Why is it only typing every other letter?!?!
|
|
28
|
+
await t.typeText(nav.desktop.searchBox, TEST_TEXT_FOUND.split('').join('_'));
|
|
29
|
+
await t.pressKey('enter');
|
|
30
|
+
|
|
30
31
|
await t.expect(nav.desktop.searchPin.exists).ok();
|
|
31
32
|
await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').exists).ok();
|
|
32
33
|
await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').innerText).contains(TEST_TEXT_FOUND);
|
|
@@ -43,7 +44,7 @@ export function runDesktopSearchTests(br) {
|
|
|
43
44
|
await t.expect(getPageUrl()).contains(PAGE_FIRST_RESULT);
|
|
44
45
|
|
|
45
46
|
//checks highlight on result page is visible
|
|
46
|
-
const highlight = br.shell.find(".
|
|
47
|
+
const highlight = br.shell.find(".searchHiliteLayer rect");
|
|
47
48
|
await t.expect(highlight.visible).ok();
|
|
48
49
|
|
|
49
50
|
});
|
|
@@ -54,14 +55,14 @@ export function runDesktopSearchTests(br) {
|
|
|
54
55
|
const nav = br.nav;
|
|
55
56
|
|
|
56
57
|
//assuring that the search bar is enabled
|
|
57
|
-
await t.expect(nav.desktop.
|
|
58
|
+
await t.expect(nav.desktop.searchIcon.visible).ok();
|
|
59
|
+
await t.click(nav.desktop.searchIcon);
|
|
58
60
|
|
|
59
61
|
//testing search for a word not found in the book
|
|
60
|
-
await t
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
await t.
|
|
64
|
-
await t.click((nav.desktop.searchBox).child('.BRsearchSubmit'));
|
|
62
|
+
await t.selectText(nav.desktop.searchBox).pressKey('delete');
|
|
63
|
+
// FIXME: Why is it only typing every other letter?!?!
|
|
64
|
+
await t.typeText(nav.desktop.searchBox, TEST_TEXT_NOT_FOUND.split('').join('_'));
|
|
65
|
+
await t.pressKey('enter');
|
|
65
66
|
await t.expect(nav.desktop.searchPin.child('.BRquery').child('div').withText(TEST_TEXT_NOT_FOUND).exists).notOk();
|
|
66
67
|
|
|
67
68
|
const getPageUrl = ClientFunction(() => window.location.href.toString());
|
|
@@ -15,7 +15,7 @@ export function runMobileSearchTests(br) {
|
|
|
15
15
|
|
|
16
16
|
test
|
|
17
17
|
.requestHooks(mockFound)('Mobile search - successful search', async t => {
|
|
18
|
-
await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true})
|
|
18
|
+
await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true});
|
|
19
19
|
const nav = br.nav.mobile;
|
|
20
20
|
|
|
21
21
|
//opening side menu and search
|
|
@@ -47,7 +47,7 @@ export function runMobileSearchTests(br) {
|
|
|
47
47
|
await t.expect(getPageUrl()).contains(PAGE_FIRST_RESULT);
|
|
48
48
|
|
|
49
49
|
//checks highlight on result page is visible
|
|
50
|
-
const highlight = br.shell.find(".
|
|
50
|
+
const highlight = br.shell.find(".searchHiliteLayer rect");
|
|
51
51
|
await t.expect(highlight.visible).ok();
|
|
52
52
|
|
|
53
53
|
await t.maximizeWindow();
|
|
@@ -55,7 +55,7 @@ export function runMobileSearchTests(br) {
|
|
|
55
55
|
|
|
56
56
|
test
|
|
57
57
|
.requestHooks(mockNotFound)('Mobile search - unsuccessful search', async t => {
|
|
58
|
-
await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true})
|
|
58
|
+
await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true});
|
|
59
59
|
const nav = br.nav.mobile;
|
|
60
60
|
|
|
61
61
|
//opening side menu and search
|