@internetarchive/collection-browser 2.3.0 → 2.4.0

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 (299) hide show
  1. package/.editorconfig +29 -29
  2. package/.husky/pre-commit +4 -4
  3. package/LICENSE +661 -661
  4. package/README.md +83 -83
  5. package/dist/index.d.ts +12 -12
  6. package/dist/index.js +12 -12
  7. package/dist/src/app-root.d.ts +91 -91
  8. package/dist/src/app-root.js +487 -487
  9. package/dist/src/assets/img/icons/arrow-left.d.ts +2 -2
  10. package/dist/src/assets/img/icons/arrow-left.js +2 -2
  11. package/dist/src/assets/img/icons/arrow-right.d.ts +2 -2
  12. package/dist/src/assets/img/icons/arrow-right.js +2 -2
  13. package/dist/src/assets/img/icons/chevron.d.ts +2 -2
  14. package/dist/src/assets/img/icons/chevron.js +2 -2
  15. package/dist/src/assets/img/icons/contract.d.ts +2 -2
  16. package/dist/src/assets/img/icons/contract.js +2 -2
  17. package/dist/src/assets/img/icons/empty-query.d.ts +2 -2
  18. package/dist/src/assets/img/icons/empty-query.js +2 -2
  19. package/dist/src/assets/img/icons/expand.d.ts +2 -2
  20. package/dist/src/assets/img/icons/expand.js +2 -2
  21. package/dist/src/assets/img/icons/eye-closed.d.ts +2 -2
  22. package/dist/src/assets/img/icons/eye-closed.js +2 -2
  23. package/dist/src/assets/img/icons/eye.d.ts +2 -2
  24. package/dist/src/assets/img/icons/eye.js +2 -2
  25. package/dist/src/assets/img/icons/favorite-filled.d.ts +1 -1
  26. package/dist/src/assets/img/icons/favorite-filled.js +2 -2
  27. package/dist/src/assets/img/icons/favorite-unfilled.d.ts +1 -1
  28. package/dist/src/assets/img/icons/favorite-unfilled.js +2 -2
  29. package/dist/src/assets/img/icons/login-required.d.ts +1 -1
  30. package/dist/src/assets/img/icons/login-required.js +2 -2
  31. package/dist/src/assets/img/icons/mediatype/account.d.ts +1 -1
  32. package/dist/src/assets/img/icons/mediatype/account.js +2 -2
  33. package/dist/src/assets/img/icons/mediatype/audio.d.ts +1 -1
  34. package/dist/src/assets/img/icons/mediatype/audio.js +2 -2
  35. package/dist/src/assets/img/icons/mediatype/collection.d.ts +1 -1
  36. package/dist/src/assets/img/icons/mediatype/collection.js +2 -2
  37. package/dist/src/assets/img/icons/mediatype/data.d.ts +1 -1
  38. package/dist/src/assets/img/icons/mediatype/data.js +2 -2
  39. package/dist/src/assets/img/icons/mediatype/etree.d.ts +1 -1
  40. package/dist/src/assets/img/icons/mediatype/etree.js +2 -2
  41. package/dist/src/assets/img/icons/mediatype/film.d.ts +1 -1
  42. package/dist/src/assets/img/icons/mediatype/film.js +2 -2
  43. package/dist/src/assets/img/icons/mediatype/images.d.ts +1 -1
  44. package/dist/src/assets/img/icons/mediatype/images.js +2 -2
  45. package/dist/src/assets/img/icons/mediatype/radio.d.ts +1 -1
  46. package/dist/src/assets/img/icons/mediatype/radio.js +2 -2
  47. package/dist/src/assets/img/icons/mediatype/search.d.ts +1 -1
  48. package/dist/src/assets/img/icons/mediatype/search.js +2 -2
  49. package/dist/src/assets/img/icons/mediatype/software.d.ts +1 -1
  50. package/dist/src/assets/img/icons/mediatype/software.js +2 -2
  51. package/dist/src/assets/img/icons/mediatype/texts.d.ts +1 -1
  52. package/dist/src/assets/img/icons/mediatype/texts.js +2 -2
  53. package/dist/src/assets/img/icons/mediatype/tv.d.ts +1 -1
  54. package/dist/src/assets/img/icons/mediatype/tv.js +2 -2
  55. package/dist/src/assets/img/icons/mediatype/video.d.ts +1 -1
  56. package/dist/src/assets/img/icons/mediatype/video.js +2 -2
  57. package/dist/src/assets/img/icons/mediatype/web.d.ts +1 -1
  58. package/dist/src/assets/img/icons/mediatype/web.js +2 -2
  59. package/dist/src/assets/img/icons/null-result.d.ts +2 -2
  60. package/dist/src/assets/img/icons/null-result.js +2 -2
  61. package/dist/src/assets/img/icons/restricted.d.ts +1 -1
  62. package/dist/src/assets/img/icons/restricted.js +2 -2
  63. package/dist/src/assets/img/icons/reviews.d.ts +1 -1
  64. package/dist/src/assets/img/icons/reviews.js +2 -2
  65. package/dist/src/assets/img/icons/upload.d.ts +1 -1
  66. package/dist/src/assets/img/icons/upload.js +2 -2
  67. package/dist/src/assets/img/icons/views.d.ts +1 -1
  68. package/dist/src/assets/img/icons/views.js +2 -2
  69. package/dist/src/circular-activity-indicator.d.ts +5 -5
  70. package/dist/src/circular-activity-indicator.js +17 -17
  71. package/dist/src/collection-browser.d.ts +466 -466
  72. package/dist/src/collection-browser.js +1475 -1475
  73. package/dist/src/collection-facets/facet-row.d.ts +30 -30
  74. package/dist/src/collection-facets/facet-row.js +114 -114
  75. package/dist/src/collection-facets/facet-tombstone-row.d.ts +5 -5
  76. package/dist/src/collection-facets/facet-tombstone-row.js +15 -15
  77. package/dist/src/collection-facets/facets-template.d.ts +17 -17
  78. package/dist/src/collection-facets/facets-template.js +114 -114
  79. package/dist/src/collection-facets/more-facets-content.d.ts +74 -74
  80. package/dist/src/collection-facets/more-facets-content.js +360 -360
  81. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  82. package/dist/src/collection-facets/more-facets-pagination.js +196 -196
  83. package/dist/src/collection-facets/toggle-switch.d.ts +41 -41
  84. package/dist/src/collection-facets/toggle-switch.js +94 -94
  85. package/dist/src/collection-facets.d.ts +103 -103
  86. package/dist/src/collection-facets.js +510 -510
  87. package/dist/src/data-source/collection-browser-data-source-interface.d.ts +241 -241
  88. package/dist/src/data-source/collection-browser-data-source-interface.js +1 -1
  89. package/dist/src/data-source/collection-browser-data-source.d.ts +378 -378
  90. package/dist/src/data-source/collection-browser-data-source.js +985 -985
  91. package/dist/src/data-source/collection-browser-query-state.d.ts +43 -43
  92. package/dist/src/data-source/collection-browser-query-state.js +1 -1
  93. package/dist/src/data-source/models.d.ts +28 -28
  94. package/dist/src/data-source/models.js +8 -8
  95. package/dist/src/empty-placeholder.d.ts +23 -23
  96. package/dist/src/empty-placeholder.js +74 -74
  97. package/dist/src/expanded-date-picker.d.ts +43 -43
  98. package/dist/src/expanded-date-picker.js +109 -109
  99. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  100. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  101. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  102. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  103. package/dist/src/manage/manage-bar.d.ts +30 -30
  104. package/dist/src/manage/manage-bar.js +61 -61
  105. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  106. package/dist/src/mediatype/mediatype-config.js +91 -91
  107. package/dist/src/models.d.ts +209 -209
  108. package/dist/src/models.js +381 -381
  109. package/dist/src/restoration-state-handler.d.ts +70 -70
  110. package/dist/src/restoration-state-handler.js +357 -357
  111. package/dist/src/sort-filter-bar/alpha-bar-tooltip.d.ts +6 -6
  112. package/dist/src/sort-filter-bar/alpha-bar-tooltip.js +24 -24
  113. package/dist/src/sort-filter-bar/alpha-bar.d.ts +21 -21
  114. package/dist/src/sort-filter-bar/alpha-bar.js +128 -128
  115. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  116. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  117. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  118. package/dist/src/sort-filter-bar/img/list.js +2 -2
  119. package/dist/src/sort-filter-bar/img/sort-toggle-disabled.d.ts +1 -1
  120. package/dist/src/sort-filter-bar/img/sort-toggle-disabled.js +2 -2
  121. package/dist/src/sort-filter-bar/img/sort-toggle-down.d.ts +1 -1
  122. package/dist/src/sort-filter-bar/img/sort-toggle-down.js +2 -2
  123. package/dist/src/sort-filter-bar/img/sort-toggle-up.d.ts +1 -1
  124. package/dist/src/sort-filter-bar/img/sort-toggle-up.js +2 -2
  125. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  126. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  127. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  128. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  129. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +222 -222
  130. package/dist/src/sort-filter-bar/sort-filter-bar.js +696 -696
  131. package/dist/src/styles/ia-button.d.ts +2 -2
  132. package/dist/src/styles/ia-button.js +16 -16
  133. package/dist/src/styles/item-image-styles.d.ts +8 -8
  134. package/dist/src/styles/item-image-styles.js +9 -9
  135. package/dist/src/styles/sr-only.d.ts +1 -1
  136. package/dist/src/styles/sr-only.js +2 -2
  137. package/dist/src/tiles/base-tile-component.d.ts +19 -19
  138. package/dist/src/tiles/base-tile-component.js +63 -63
  139. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  140. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  141. package/dist/src/tiles/grid/account-tile.d.ts +18 -18
  142. package/dist/src/tiles/grid/account-tile.js +72 -72
  143. package/dist/src/tiles/grid/collection-tile.d.ts +15 -15
  144. package/dist/src/tiles/grid/collection-tile.js +80 -80
  145. package/dist/src/tiles/grid/item-tile.d.ts +30 -30
  146. package/dist/src/tiles/grid/item-tile.js +149 -149
  147. package/dist/src/tiles/grid/search-tile.d.ts +10 -10
  148. package/dist/src/tiles/grid/search-tile.js +51 -51
  149. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.d.ts +1 -1
  150. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.js +8 -8
  151. package/dist/src/tiles/grid/tile-stats.d.ts +11 -11
  152. package/dist/src/tiles/grid/tile-stats.js +53 -53
  153. package/dist/src/tiles/hover/hover-pane-controller.d.ts +219 -219
  154. package/dist/src/tiles/hover/hover-pane-controller.js +354 -352
  155. package/dist/src/tiles/hover/hover-pane-controller.js.map +1 -1
  156. package/dist/src/tiles/hover/tile-hover-pane.d.ts +18 -15
  157. package/dist/src/tiles/hover/tile-hover-pane.js +127 -47
  158. package/dist/src/tiles/hover/tile-hover-pane.js.map +1 -1
  159. package/dist/src/tiles/image-block.d.ts +17 -17
  160. package/dist/src/tiles/image-block.js +74 -74
  161. package/dist/src/tiles/image-block.js.map +1 -1
  162. package/dist/src/tiles/item-image.d.ts +39 -39
  163. package/dist/src/tiles/item-image.js +154 -154
  164. package/dist/src/tiles/list/tile-list-compact-header.d.ts +6 -6
  165. package/dist/src/tiles/list/tile-list-compact-header.js +38 -38
  166. package/dist/src/tiles/list/tile-list-compact.d.ts +15 -15
  167. package/dist/src/tiles/list/tile-list-compact.js +114 -114
  168. package/dist/src/tiles/list/tile-list.d.ts +50 -50
  169. package/dist/src/tiles/list/tile-list.js +315 -315
  170. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  171. package/dist/src/tiles/mediatype-icon.js +47 -47
  172. package/dist/src/tiles/overlay/icon-overlay.d.ts +10 -10
  173. package/dist/src/tiles/overlay/icon-overlay.js +40 -40
  174. package/dist/src/tiles/overlay/icon-text-overlay.d.ts +9 -9
  175. package/dist/src/tiles/overlay/icon-text-overlay.js +38 -38
  176. package/dist/src/tiles/overlay/text-overlay.d.ts +10 -10
  177. package/dist/src/tiles/overlay/text-overlay.js +42 -42
  178. package/dist/src/tiles/review-block.d.ts +12 -12
  179. package/dist/src/tiles/review-block.js +56 -56
  180. package/dist/src/tiles/text-snippet-block.d.ts +27 -27
  181. package/dist/src/tiles/text-snippet-block.js +73 -73
  182. package/dist/src/tiles/tile-dispatcher.d.ts +64 -64
  183. package/dist/src/tiles/tile-dispatcher.js +229 -229
  184. package/dist/src/tiles/tile-display-value-provider.d.ts +47 -47
  185. package/dist/src/tiles/tile-display-value-provider.js +94 -94
  186. package/dist/src/utils/analytics-events.d.ts +28 -28
  187. package/dist/src/utils/analytics-events.js +30 -30
  188. package/dist/src/utils/array-equals.d.ts +4 -4
  189. package/dist/src/utils/array-equals.js +10 -10
  190. package/dist/src/utils/collapse-repeated-quotes.d.ts +11 -11
  191. package/dist/src/utils/collapse-repeated-quotes.js +13 -13
  192. package/dist/src/utils/format-count.d.ts +7 -7
  193. package/dist/src/utils/format-count.js +76 -76
  194. package/dist/src/utils/format-date.d.ts +2 -2
  195. package/dist/src/utils/format-date.js +25 -25
  196. package/dist/src/utils/format-unit-size.d.ts +2 -2
  197. package/dist/src/utils/format-unit-size.js +33 -33
  198. package/dist/src/utils/local-date-from-utc.d.ts +9 -9
  199. package/dist/src/utils/local-date-from-utc.js +15 -15
  200. package/dist/src/utils/log.d.ts +7 -7
  201. package/dist/src/utils/log.js +15 -15
  202. package/dist/src/utils/resolve-mediatype.d.ts +8 -8
  203. package/dist/src/utils/resolve-mediatype.js +23 -23
  204. package/dist/src/utils/sha1.d.ts +2 -2
  205. package/dist/src/utils/sha1.js +8 -8
  206. package/dist/test/collection-browser.test.d.ts +1 -1
  207. package/dist/test/collection-browser.test.js +1293 -1293
  208. package/dist/test/collection-facets/facet-row.test.d.ts +1 -1
  209. package/dist/test/collection-facets/facet-row.test.js +203 -203
  210. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  211. package/dist/test/collection-facets/facets-template.test.js +105 -105
  212. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  213. package/dist/test/collection-facets/more-facets-content.test.js +139 -139
  214. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  215. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  216. package/dist/test/collection-facets/toggle-switch.test.d.ts +1 -1
  217. package/dist/test/collection-facets/toggle-switch.test.js +73 -73
  218. package/dist/test/collection-facets.test.d.ts +2 -2
  219. package/dist/test/collection-facets.test.js +652 -652
  220. package/dist/test/data-source/collection-browser-data-source.test.d.ts +1 -1
  221. package/dist/test/data-source/collection-browser-data-source.test.js +89 -89
  222. package/dist/test/empty-placeholder.test.d.ts +1 -1
  223. package/dist/test/empty-placeholder.test.js +63 -63
  224. package/dist/test/expanded-date-picker.test.d.ts +1 -1
  225. package/dist/test/expanded-date-picker.test.js +95 -95
  226. package/dist/test/icon-overlay.test.d.ts +1 -1
  227. package/dist/test/icon-overlay.test.js +24 -24
  228. package/dist/test/image-block.test.d.ts +1 -1
  229. package/dist/test/image-block.test.js +48 -48
  230. package/dist/test/item-image.test.d.ts +1 -1
  231. package/dist/test/item-image.test.js +85 -85
  232. package/dist/test/manage/manage-bar.test.d.ts +1 -1
  233. package/dist/test/manage/manage-bar.test.js +81 -81
  234. package/dist/test/mediatype-config.test.d.ts +1 -1
  235. package/dist/test/mediatype-config.test.js +16 -16
  236. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  237. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  238. package/dist/test/mocks/mock-search-responses.d.ts +24 -24
  239. package/dist/test/mocks/mock-search-responses.js +860 -860
  240. package/dist/test/mocks/mock-search-service.d.ts +15 -15
  241. package/dist/test/mocks/mock-search-service.js +53 -53
  242. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  243. package/dist/test/restoration-state-handler.test.js +270 -270
  244. package/dist/test/review-block.test.d.ts +1 -1
  245. package/dist/test/review-block.test.js +44 -44
  246. package/dist/test/sort-filter-bar/alpha-bar-tooltip.test.d.ts +1 -1
  247. package/dist/test/sort-filter-bar/alpha-bar-tooltip.test.js +12 -12
  248. package/dist/test/sort-filter-bar/alpha-bar.test.d.ts +1 -1
  249. package/dist/test/sort-filter-bar/alpha-bar.test.js +73 -73
  250. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  251. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +426 -426
  252. package/dist/test/text-overlay.test.d.ts +1 -1
  253. package/dist/test/text-overlay.test.js +48 -48
  254. package/dist/test/text-snippet-block.test.d.ts +1 -1
  255. package/dist/test/text-snippet-block.test.js +57 -57
  256. package/dist/test/tile-stats.test.d.ts +1 -1
  257. package/dist/test/tile-stats.test.js +81 -81
  258. package/dist/test/tiles/grid/account-tile.test.d.ts +1 -1
  259. package/dist/test/tiles/grid/account-tile.test.js +76 -76
  260. package/dist/test/tiles/grid/collection-tile.test.d.ts +1 -1
  261. package/dist/test/tiles/grid/collection-tile.test.js +73 -73
  262. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  263. package/dist/test/tiles/grid/item-tile.test.js +312 -312
  264. package/dist/test/tiles/grid/search-tile.test.d.ts +1 -1
  265. package/dist/test/tiles/grid/search-tile.test.js +51 -51
  266. package/dist/test/tiles/hover/hover-pane-controller.test.d.ts +1 -1
  267. package/dist/test/tiles/hover/hover-pane-controller.test.js +259 -259
  268. package/dist/test/tiles/hover/tile-hover-pane.test.d.ts +1 -1
  269. package/dist/test/tiles/hover/tile-hover-pane.test.js +56 -13
  270. package/dist/test/tiles/hover/tile-hover-pane.test.js.map +1 -1
  271. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  272. package/dist/test/tiles/list/tile-list-compact.test.js +143 -143
  273. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  274. package/dist/test/tiles/list/tile-list.test.js +297 -297
  275. package/dist/test/tiles/tile-dispatcher.test.d.ts +1 -1
  276. package/dist/test/tiles/tile-dispatcher.test.js +100 -100
  277. package/dist/test/tiles/tile-display-value-provider.test.d.ts +1 -1
  278. package/dist/test/tiles/tile-display-value-provider.test.js +141 -141
  279. package/dist/test/utils/array-equals.test.d.ts +1 -1
  280. package/dist/test/utils/array-equals.test.js +26 -26
  281. package/dist/test/utils/format-count.test.d.ts +1 -1
  282. package/dist/test/utils/format-count.test.js +23 -23
  283. package/dist/test/utils/format-date.test.d.ts +1 -1
  284. package/dist/test/utils/format-date.test.js +17 -17
  285. package/dist/test/utils/format-unit-size.test.d.ts +1 -1
  286. package/dist/test/utils/format-unit-size.test.js +17 -17
  287. package/dist/test/utils/local-date-from-utc.test.d.ts +1 -1
  288. package/dist/test/utils/local-date-from-utc.test.js +26 -26
  289. package/local.archive.org.cert +86 -86
  290. package/local.archive.org.key +27 -27
  291. package/package.json +1 -1
  292. package/renovate.json +6 -6
  293. package/src/tiles/hover/hover-pane-controller.ts +2 -0
  294. package/src/tiles/hover/tile-hover-pane.ts +100 -11
  295. package/src/tiles/image-block.ts +1 -1
  296. package/test/tiles/hover/tile-hover-pane.test.ts +61 -0
  297. package/tsconfig.json +21 -21
  298. package/web-dev-server.config.mjs +30 -30
  299. package/web-test-runner.config.mjs +41 -41
@@ -1,986 +1,986 @@
1
- import { FilterConstraint, FilterMapBuilder, SearchType, } from '@internetarchive/search-service';
2
- import { prefixFilterAggregationKeys, TileModel, SortField, SORT_OPTIONS, } from '../models';
3
- import { FACETLESS_PAGE_ELEMENTS } from './models';
4
- import { sha1 } from '../utils/sha1';
5
- import { log } from '../utils/log';
6
- export class CollectionBrowserDataSource {
7
- // eslint-disable-next-line no-useless-constructor
8
- constructor(
9
- /** The host element to which this controller should attach listeners */
10
- host,
11
- /** Default size of result pages */
12
- pageSize = 50) {
13
- this.host = host;
14
- this.pageSize = pageSize;
15
- /**
16
- * All pages of tile models that have been fetched so far, indexed by their page
17
- * number (with the first being page 1).
18
- */
19
- this.pages = {};
20
- /**
21
- * Tile offset to apply when looking up tiles in the pages, in order to maintain
22
- * page alignment after tiles are removed.
23
- */
24
- this.offset = 0;
25
- /**
26
- * Total number of tile models stored in this data source's pages
27
- */
28
- this.numTileModels = 0;
29
- /**
30
- * A set of fetch IDs that are valid for the current query state
31
- */
32
- this.fetchesInProgress = new Set();
33
- /**
34
- * A record of the query key used for the last search.
35
- * If this changes, we need to load new results.
36
- */
37
- this.previousQueryKey = '';
38
- /**
39
- * Whether the initial page of search results for the current query state
40
- * is presently being fetched.
41
- */
42
- this.searchResultsLoading = false;
43
- /**
44
- * Whether the facets (aggregations) for the current query state are
45
- * presently being fetched.
46
- */
47
- this.facetsLoading = false;
48
- /**
49
- * Whether the facets are actually visible -- if not, then we can delay any facet
50
- * fetches until they become visible.
51
- */
52
- this.facetsReadyToLoad = false;
53
- /**
54
- * Whether further query changes should be ignored and not trigger fetches
55
- */
56
- this.suppressFetches = false;
57
- /**
58
- * @inheritdoc
59
- */
60
- this.totalResults = 0;
61
- /**
62
- * @inheritdoc
63
- */
64
- this.endOfDataReached = false;
65
- /**
66
- * @inheritdoc
67
- */
68
- this.queryInitialized = false;
69
- /**
70
- * @inheritdoc
71
- */
72
- this.collectionTitles = new Map();
73
- /**
74
- * @inheritdoc
75
- */
76
- this.parentCollections = [];
77
- /**
78
- * @inheritdoc
79
- */
80
- this.prefixFilterCountMap = {};
81
- /**
82
- * Internal property to store the private value backing the `initialSearchComplete` getter.
83
- */
84
- this._initialSearchCompletePromise = new Promise(res => {
85
- this._initialSearchCompleteResolver = res;
86
- });
87
- /**
88
- * @inheritdoc
89
- */
90
- this.checkAllTiles = () => {
91
- this.map(model => {
92
- const cloned = model.clone();
93
- cloned.checked = true;
94
- return cloned;
95
- });
96
- };
97
- /**
98
- * @inheritdoc
99
- */
100
- this.uncheckAllTiles = () => {
101
- this.map(model => {
102
- const cloned = model.clone();
103
- cloned.checked = false;
104
- return cloned;
105
- });
106
- };
107
- /**
108
- * @inheritdoc
109
- */
110
- this.removeCheckedTiles = () => {
111
- // To make sure our data source remains page-aligned, we will offset our data source by
112
- // the number of removed tiles, so that we can just add the offset when the infinite
113
- // scroller queries for cell contents.
114
- // This only matters while we're still viewing the same set of results. If the user changes
115
- // their query/filters/sort, then the data source is overwritten and the offset cleared.
116
- const { checkedTileModels, uncheckedTileModels } = this;
117
- const numChecked = checkedTileModels.length;
118
- if (numChecked === 0)
119
- return;
120
- this.offset += numChecked;
121
- const newPages = {};
122
- // Which page the remaining tile models start on, post-offset
123
- let offsetPageNumber = Math.floor(this.offset / this.pageSize) + 1;
124
- let indexOnPage = this.offset % this.pageSize;
125
- // Fill the pages up to that point with empty models
126
- for (let page = 1; page <= offsetPageNumber; page += 1) {
127
- const remainingHidden = this.offset - this.pageSize * (page - 1);
128
- const offsetCellsOnPage = Math.min(this.pageSize, remainingHidden);
129
- newPages[page] = Array(offsetCellsOnPage).fill(undefined);
130
- }
131
- // Shift all the remaining tiles into their new positions in the data source
132
- for (const model of uncheckedTileModels) {
133
- if (!newPages[offsetPageNumber])
134
- newPages[offsetPageNumber] = [];
135
- newPages[offsetPageNumber].push(model);
136
- indexOnPage += 1;
137
- if (indexOnPage >= this.pageSize) {
138
- offsetPageNumber += 1;
139
- indexOnPage = 0;
140
- }
141
- }
142
- // Swap in the new pages
143
- this.pages = newPages;
144
- this.numTileModels -= numChecked;
145
- this.totalResults -= numChecked;
146
- this.host.setTileCount(this.size);
147
- this.host.setTotalResultCount(this.totalResults);
148
- this.requestHostUpdate();
149
- this.refreshVisibleResults();
150
- };
151
- // Just setting some property values
152
- }
153
- /**
154
- * @inheritdoc
155
- */
156
- get initialSearchComplete() {
157
- return this._initialSearchCompletePromise;
158
- }
159
- hostConnected() {
160
- this.setSearchResultsLoading(this.searchResultsLoading);
161
- this.setFacetsLoading(this.facetsLoading);
162
- }
163
- hostUpdate() {
164
- // This reactive controller hook is run whenever the host component (collection-browser) performs an update.
165
- // We check whether the host's state has changed in a way which should trigger a reset & new results fetch.
166
- // Only the currently-installed data source should react to the update
167
- if (!this.activeOnHost)
168
- return;
169
- // Copy loading states onto the host
170
- this.setSearchResultsLoading(this.searchResultsLoading);
171
- this.setFacetsLoading(this.facetsLoading);
172
- // Can't perform searches without a search service
173
- if (!this.host.searchService)
174
- return;
175
- // We should only reset if part of the full query state has changed
176
- const queryKeyChanged = this.pageFetchQueryKey !== this.previousQueryKey;
177
- if (!queryKeyChanged)
178
- return;
179
- // We should only reset if either:
180
- // (a) our state permits a valid search, or
181
- // (b) we have a blank query that we want to show empty results for
182
- const shouldShowEmptyQueryResults = this.host.clearResultsOnEmptyQuery && this.host.baseQuery === '';
183
- if (!(this.canPerformSearch || shouldShowEmptyQueryResults))
184
- return;
185
- if (this.activeOnHost)
186
- this.host.emitQueryStateChanged();
187
- this.handleQueryChange();
188
- }
189
- /**
190
- * Returns whether this data source is the one currently installed on the host component.
191
- */
192
- get activeOnHost() {
193
- return this.host.dataSource === this;
194
- }
195
- /**
196
- * @inheritdoc
197
- */
198
- get size() {
199
- return this.numTileModels;
200
- }
201
- /**
202
- * @inheritdoc
203
- */
204
- reset() {
205
- log('Resetting CB data source');
206
- this.pages = {};
207
- this.aggregations = {};
208
- this.yearHistogramAggregation = undefined;
209
- this.pageElements = undefined;
210
- this.parentCollections = [];
211
- this.queryErrorMessage = undefined;
212
- this.offset = 0;
213
- this.numTileModels = 0;
214
- this.endOfDataReached = false;
215
- this.queryInitialized = false;
216
- this.facetsLoading = false;
217
- // Invalidate any fetches in progress
218
- this.fetchesInProgress.clear();
219
- this.setTotalResultCount(0);
220
- this.requestHostUpdate();
221
- }
222
- /**
223
- * @inheritdoc
224
- */
225
- addPage(pageNum, pageTiles) {
226
- this.pages[pageNum] = pageTiles;
227
- this.numTileModels += pageTiles.length;
228
- this.requestHostUpdate();
229
- }
230
- /**
231
- * @inheritdoc
232
- */
233
- addMultiplePages(firstPageNum, tiles) {
234
- const numPages = Math.ceil(tiles.length / this.pageSize);
235
- for (let i = 0; i < numPages; i += 1) {
236
- const pageStartIndex = this.pageSize * i;
237
- this.addPage(firstPageNum + i, tiles.slice(pageStartIndex, pageStartIndex + this.pageSize));
238
- }
239
- const visiblePages = this.host.currentVisiblePageNumbers;
240
- const needsReload = visiblePages.some(page => page >= firstPageNum && page <= firstPageNum + numPages);
241
- if (needsReload) {
242
- this.refreshVisibleResults();
243
- }
244
- }
245
- /**
246
- * @inheritdoc
247
- */
248
- getPage(pageNum) {
249
- return this.pages[pageNum];
250
- }
251
- /**
252
- * @inheritdoc
253
- */
254
- getAllPages() {
255
- return this.pages;
256
- }
257
- /**
258
- * @inheritdoc
259
- */
260
- hasPage(pageNum) {
261
- return !!this.pages[pageNum];
262
- }
263
- /**
264
- * @inheritdoc
265
- */
266
- getTileModelAt(index) {
267
- var _a, _b;
268
- const offsetIndex = index + this.offset;
269
- const expectedPageNum = Math.floor(offsetIndex / this.pageSize) + 1;
270
- const expectedIndexOnPage = offsetIndex % this.pageSize;
271
- let page = 1;
272
- let tilesSeen = 0;
273
- while (tilesSeen <= offsetIndex) {
274
- if (!this.pages[page]) {
275
- // If we encounter a missing page, either we're past all the results or the page data is sparse.
276
- // So just return the tile at the expected position if it exists.
277
- return (_a = this.pages[expectedPageNum]) === null || _a === void 0 ? void 0 : _a[expectedIndexOnPage];
278
- }
279
- if (tilesSeen + this.pages[page].length > offsetIndex) {
280
- return this.pages[page][offsetIndex - tilesSeen];
281
- }
282
- tilesSeen += this.pages[page].length;
283
- page += 1;
284
- }
285
- return (_b = this.pages[expectedPageNum]) === null || _b === void 0 ? void 0 : _b[expectedIndexOnPage];
286
- }
287
- /**
288
- * @inheritdoc
289
- */
290
- indexOf(tile) {
291
- return Object.values(this.pages).flat().indexOf(tile) - this.offset;
292
- }
293
- /**
294
- * @inheritdoc
295
- */
296
- getPageSize() {
297
- return this.pageSize;
298
- }
299
- /**
300
- * @inheritdoc
301
- */
302
- setPageSize(pageSize) {
303
- this.reset();
304
- this.pageSize = pageSize;
305
- }
306
- /**
307
- * @inheritdoc
308
- */
309
- setTotalResultCount(count) {
310
- this.totalResults = count;
311
- if (this.activeOnHost) {
312
- this.host.setTotalResultCount(count);
313
- }
314
- }
315
- /**
316
- * @inheritdoc
317
- */
318
- setFetchesSuppressed(suppressed) {
319
- this.suppressFetches = suppressed;
320
- }
321
- /**
322
- * @inheritdoc
323
- */
324
- async handleQueryChange() {
325
- // Don't react to the change if fetches are suppressed for this data source
326
- if (this.suppressFetches)
327
- return;
328
- this.reset();
329
- // Reset the `initialSearchComplete` promise with a new value for the imminent search
330
- this._initialSearchCompletePromise = new Promise(res => {
331
- this._initialSearchCompleteResolver = res;
332
- });
333
- // Fire the initial page & facet requests
334
- this.queryInitialized = true;
335
- await Promise.all([
336
- this.doInitialPageFetch(),
337
- this.canFetchFacets ? this.fetchFacets() : null,
338
- ]);
339
- // Resolve the `initialSearchComplete` promise for this search
340
- this._initialSearchCompleteResolver(true);
341
- }
342
- /**
343
- * @inheritdoc
344
- */
345
- async handleFacetReadinessChange(ready) {
346
- const facetsBecameReady = !this.facetsReadyToLoad && ready;
347
- this.facetsReadyToLoad = ready;
348
- const lazyLoadFacets = ['lazy-mobile', 'opt-in'].includes(this.host.facetLoadStrategy);
349
- const needsFetch = lazyLoadFacets && facetsBecameReady && this.canFetchFacets;
350
- if (needsFetch) {
351
- this.fetchFacets();
352
- }
353
- }
354
- /**
355
- * Whether the data source & its host are in a state where a facet request should be fired.
356
- * (i.e., they aren't suppressed or already loading, etc.)
357
- */
358
- get canFetchFacets() {
359
- var _a;
360
- // Don't fetch facets if they are suppressed entirely or not required for the current profile page element
361
- if (this.host.facetLoadStrategy === 'off')
362
- return false;
363
- if (FACETLESS_PAGE_ELEMENTS.includes(this.host.profileElement))
364
- return false;
365
- // If facets are to be lazy-loaded, don't fetch them if they are not going to be visible anyway
366
- // (wait until they become visible instead)
367
- if (this.host.facetLoadStrategy !== 'eager' && !this.facetsReadyToLoad)
368
- return false;
369
- // Don't fetch facets again if they are already fetched or pending
370
- const facetsAlreadyFetched = Object.keys((_a = this.aggregations) !== null && _a !== void 0 ? _a : {}).length > 0;
371
- if (this.facetsLoading || facetsAlreadyFetched)
372
- return false;
373
- return true;
374
- }
375
- /**
376
- * @inheritdoc
377
- */
378
- map(callback) {
379
- this.pages = Object.fromEntries(Object.entries(this.pages).map(([page, tileModels]) => [
380
- page,
381
- tileModels.map((model, index, array) => model ? callback(model, index, array) : model),
382
- ]));
383
- this.requestHostUpdate();
384
- this.refreshVisibleResults();
385
- }
386
- /**
387
- * @inheritdoc
388
- */
389
- get checkedTileModels() {
390
- return this.getFilteredTileModels(model => model.checked);
391
- }
392
- /**
393
- * @inheritdoc
394
- */
395
- get uncheckedTileModels() {
396
- return this.getFilteredTileModels(model => !model.checked);
397
- }
398
- /**
399
- * Returns a flattened, filtered array of all the tile models in the data source
400
- * for which the given predicate returns a truthy value.
401
- *
402
- * @param predicate A callback function to apply on each tile model, as with Array.filter
403
- * @returns A filtered array of tile models satisfying the predicate
404
- */
405
- getFilteredTileModels(predicate) {
406
- return Object.values(this.pages)
407
- .flat()
408
- .filter((model, index, array) => model ? predicate(model, index, array) : false);
409
- }
410
- /**
411
- * @inheritdoc
412
- */
413
- get canPerformSearch() {
414
- var _a;
415
- if (!this.host.searchService)
416
- return false;
417
- const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
418
- const hasNonEmptyQuery = !!trimmedQuery;
419
- const isCollectionSearch = !!this.host.withinCollection;
420
- const isProfileSearch = !!this.host.withinProfile;
421
- const hasProfileElement = !!this.host.profileElement;
422
- const isMetadataSearch = this.host.searchType === SearchType.METADATA;
423
- // Metadata searches within a collection/profile are allowed to have no query.
424
- // Otherwise, a non-empty query must be set.
425
- return (hasNonEmptyQuery ||
426
- (isCollectionSearch && isMetadataSearch) ||
427
- (isProfileSearch && hasProfileElement && isMetadataSearch));
428
- }
429
- /**
430
- * Sets the state for whether the initial set of search results for the
431
- * current query is loading
432
- */
433
- setSearchResultsLoading(loading) {
434
- this.searchResultsLoading = loading;
435
- if (this.activeOnHost) {
436
- this.host.setSearchResultsLoading(loading);
437
- }
438
- }
439
- /**
440
- * Sets the state for whether the facets for a query is loading
441
- */
442
- setFacetsLoading(loading) {
443
- this.facetsLoading = loading;
444
- if (this.activeOnHost) {
445
- this.host.setFacetsLoading(loading);
446
- }
447
- }
448
- /**
449
- * Requests that the host perform an update, provided this data
450
- * source is actively installed on it.
451
- */
452
- requestHostUpdate() {
453
- if (this.activeOnHost) {
454
- this.host.requestUpdate();
455
- }
456
- }
457
- /**
458
- * Requests that the host refresh its visible tiles, provided this
459
- * data source is actively installed on it.
460
- */
461
- refreshVisibleResults() {
462
- if (this.activeOnHost) {
463
- this.host.refreshVisibleResults();
464
- }
465
- }
466
- /**
467
- * The query key is a string that uniquely identifies the current search.
468
- * It consists of:
469
- * - The current base query
470
- * - The current collection/profile target & page element
471
- * - The current search type
472
- * - Any currently-applied facets
473
- * - Any currently-applied date range
474
- * - Any currently-applied prefix filters
475
- * - The current sort options
476
- *
477
- * This lets us internally keep track of queries so we don't persist data that's
478
- * no longer relevant. Not meant to be human-readable.
479
- */
480
- get pageFetchQueryKey() {
481
- var _a, _b, _c;
482
- const profileKey = `pf;${this.host.withinProfile}--pe;${this.host.profileElement}`;
483
- const pageTarget = (_a = this.host.withinCollection) !== null && _a !== void 0 ? _a : profileKey;
484
- const sortField = (_b = this.host.selectedSort) !== null && _b !== void 0 ? _b : 'none';
485
- const sortDirection = (_c = this.host.sortDirection) !== null && _c !== void 0 ? _c : 'none';
486
- return `fq:${this.fullQuery}-pt:${pageTarget}-st:${this.host.searchType}-sf:${sortField}-sd:${sortDirection}`;
487
- }
488
- /**
489
- * Similar to `pageFetchQueryKey` above, but excludes sort fields since they
490
- * are not relevant in determining aggregation queries.
491
- */
492
- get facetFetchQueryKey() {
493
- var _a;
494
- const profileKey = `pf;${this.host.withinProfile}--pe;${this.host.profileElement}`;
495
- const pageTarget = (_a = this.host.withinCollection) !== null && _a !== void 0 ? _a : profileKey;
496
- return `fq:${this.fullQuery}-pt:${pageTarget}-st:${this.host.searchType}`;
497
- }
498
- /**
499
- * Constructs a search service FilterMap object from the combination of
500
- * all the currently-applied filters. This includes any facets, letter
501
- * filters, and date range.
502
- */
503
- get filterMap() {
504
- const builder = new FilterMapBuilder();
505
- // Add the date range, if applicable
506
- if (this.host.minSelectedDate) {
507
- builder.addFilter('year', this.host.minSelectedDate, FilterConstraint.GREATER_OR_EQUAL);
508
- }
509
- if (this.host.maxSelectedDate) {
510
- builder.addFilter('year', this.host.maxSelectedDate, FilterConstraint.LESS_OR_EQUAL);
511
- }
512
- // Add any selected facets
513
- if (this.host.selectedFacets) {
514
- for (const [facetName, facetValues] of Object.entries(this.host.selectedFacets)) {
515
- const { name, values } = this.prepareFacetForFetch(facetName, facetValues);
516
- for (const [value, bucket] of Object.entries(values)) {
517
- let constraint;
518
- if (bucket.state === 'selected') {
519
- constraint = FilterConstraint.INCLUDE;
520
- }
521
- else if (bucket.state === 'hidden') {
522
- constraint = FilterConstraint.EXCLUDE;
523
- }
524
- if (constraint) {
525
- builder.addFilter(name, value, constraint);
526
- }
527
- }
528
- }
529
- }
530
- // Add any letter filters
531
- if (this.host.selectedTitleFilter) {
532
- builder.addFilter('firstTitle', this.host.selectedTitleFilter, FilterConstraint.INCLUDE);
533
- }
534
- if (this.host.selectedCreatorFilter) {
535
- builder.addFilter('firstCreator', this.host.selectedCreatorFilter, FilterConstraint.INCLUDE);
536
- }
537
- const filterMap = builder.build();
538
- return filterMap;
539
- }
540
- /**
541
- * Produces a compact unique ID for a search request that can help with debugging
542
- * on the backend by making related requests easier to trace through different services.
543
- * (e.g., tying the hits/aggregations requests for the same page back to a single hash).
544
- *
545
- * @param params The search service parameters for the request
546
- * @param kind The kind of request (hits-only, aggregations-only, or both)
547
- * @returns A Promise resolving to the uid to apply to the request
548
- */
549
- async requestUID(params, kind) {
550
- var _a;
551
- const paramsToHash = JSON.stringify({
552
- pageType: params.pageType,
553
- pageTarget: params.pageTarget,
554
- query: params.query,
555
- fields: params.fields,
556
- filters: params.filters,
557
- sort: params.sort,
558
- searchType: this.host.searchType,
559
- });
560
- const fullQueryHash = (await sha1(paramsToHash)).slice(0, 20); // First 80 bits of SHA-1 are plenty for this
561
- const sessionId = (await this.host.getSessionId()).slice(0, 20); // Likewise
562
- const page = (_a = params.page) !== null && _a !== void 0 ? _a : 0;
563
- const kindPrefix = kind.charAt(0); // f = full, h = hits, a = aggregations
564
- const currentTime = Date.now();
565
- return `R:${fullQueryHash}-S:${sessionId}-P:${page}-K:${kindPrefix}-T:${currentTime}`;
566
- }
567
- /**
568
- * @inheritdoc
569
- */
570
- get pageSpecifierParams() {
571
- if (this.host.withinCollection) {
572
- return {
573
- pageType: 'collection_details',
574
- pageTarget: this.host.withinCollection,
575
- };
576
- }
577
- if (this.host.withinProfile) {
578
- return {
579
- pageType: 'account_details',
580
- pageTarget: this.host.withinProfile,
581
- pageElements: this.host.profileElement
582
- ? [this.host.profileElement]
583
- : [],
584
- };
585
- }
586
- return null;
587
- }
588
- /**
589
- * The full query, including year facets and date range clauses
590
- */
591
- get fullQuery() {
592
- var _a, _b;
593
- let fullQuery = (_b = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim()) !== null && _b !== void 0 ? _b : '';
594
- const { facetQuery, dateRangeQueryClause, sortFilterQueries } = this;
595
- if (facetQuery) {
596
- fullQuery += ` AND ${facetQuery}`;
597
- }
598
- if (dateRangeQueryClause) {
599
- fullQuery += ` AND ${dateRangeQueryClause}`;
600
- }
601
- if (sortFilterQueries) {
602
- fullQuery += ` AND ${sortFilterQueries}`;
603
- }
604
- return fullQuery.trim();
605
- }
606
- /**
607
- * Generates a query string representing the current set of applied facets
608
- *
609
- * Example: `mediatype:("collection" OR "audio" OR -"etree") AND year:("2000" OR "2001")`
610
- */
611
- get facetQuery() {
612
- var _a;
613
- if (!this.host.selectedFacets)
614
- return undefined;
615
- const facetClauses = [];
616
- for (const [facetName, facetValues] of Object.entries(this.host.selectedFacets)) {
617
- facetClauses.push(this.buildFacetClause(facetName, facetValues));
618
- }
619
- return (_a = this.joinFacetClauses(facetClauses)) === null || _a === void 0 ? void 0 : _a.trim();
620
- }
621
- get dateRangeQueryClause() {
622
- if (!this.host.minSelectedDate || !this.host.maxSelectedDate) {
623
- return undefined;
624
- }
625
- return `year:[${this.host.minSelectedDate} TO ${this.host.maxSelectedDate}]`;
626
- }
627
- get sortFilterQueries() {
628
- const queries = [this.titleQuery, this.creatorQuery];
629
- return queries.filter(q => q).join(' AND ');
630
- }
631
- /**
632
- * Returns a query clause identifying the currently selected title filter,
633
- * e.g., `firstTitle:X`.
634
- */
635
- get titleQuery() {
636
- return this.host.selectedTitleFilter
637
- ? `firstTitle:${this.host.selectedTitleFilter}`
638
- : undefined;
639
- }
640
- /**
641
- * Returns a query clause identifying the currently selected creator filter,
642
- * e.g., `firstCreator:X`.
643
- */
644
- get creatorQuery() {
645
- return this.host.selectedCreatorFilter
646
- ? `firstCreator:${this.host.selectedCreatorFilter}`
647
- : undefined;
648
- }
649
- /**
650
- * Builds an OR-joined facet clause for the given facet name and values.
651
- *
652
- * E.g., for name `subject` and values
653
- * `{ foo: { state: 'selected' }, bar: { state: 'hidden' } }`
654
- * this will produce the clause
655
- * `subject:("foo" OR -"bar")`.
656
- *
657
- * @param facetName The facet type (e.g., 'collection')
658
- * @param facetValues The facet buckets, mapped by their keys
659
- */
660
- buildFacetClause(facetName, facetValues) {
661
- const { name: facetQueryName, values } = this.prepareFacetForFetch(facetName, facetValues);
662
- const facetEntries = Object.entries(values);
663
- if (facetEntries.length === 0)
664
- return '';
665
- const facetValuesArray = [];
666
- for (const [key, facetData] of facetEntries) {
667
- const plusMinusPrefix = facetData.state === 'hidden' ? '-' : '';
668
- facetValuesArray.push(`${plusMinusPrefix}"${key}"`);
669
- }
670
- const valueQuery = facetValuesArray.join(` OR `);
671
- return `${facetQueryName}:(${valueQuery})`;
672
- }
673
- /**
674
- * Handles some special pre-request normalization steps for certain facet types
675
- * that require them.
676
- *
677
- * @param facetName The name of the facet type (e.g., 'language')
678
- * @param facetValues An array of values for that facet type
679
- */
680
- prepareFacetForFetch(facetName, facetValues) {
681
- // eslint-disable-next-line prefer-const
682
- let [normalizedName, normalizedValues] = [facetName, facetValues];
683
- // The full "search engine" name of the lending field is "lending___status"
684
- if (facetName === 'lending') {
685
- normalizedName = 'lending___status';
686
- }
687
- return {
688
- name: normalizedName,
689
- values: normalizedValues,
690
- };
691
- }
692
- /**
693
- * Takes an array of facet clauses, and combines them into a
694
- * full AND-joined facet query string. Empty clauses are ignored.
695
- */
696
- joinFacetClauses(facetClauses) {
697
- const nonEmptyFacetClauses = facetClauses.filter(clause => clause.length > 0);
698
- return nonEmptyFacetClauses.length > 0
699
- ? `(${nonEmptyFacetClauses.join(' AND ')})`
700
- : undefined;
701
- }
702
- /**
703
- * Fires a backend request to fetch a set of aggregations (representing UI facets) for
704
- * the current search state.
705
- */
706
- async fetchFacets() {
707
- var _a, _b, _c, _d, _e, _f, _g, _h, _j;
708
- const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
709
- if (!this.canPerformSearch)
710
- return;
711
- const { facetFetchQueryKey } = this;
712
- if (this.fetchesInProgress.has(facetFetchQueryKey))
713
- return;
714
- this.fetchesInProgress.add(facetFetchQueryKey);
715
- this.setFacetsLoading(true);
716
- const sortParams = this.host.sortParam ? [this.host.sortParam] : [];
717
- const params = {
718
- ...this.pageSpecifierParams,
719
- query: trimmedQuery || '',
720
- rows: 0,
721
- filters: this.filterMap,
722
- // Fetch a few extra buckets beyond the 6 we show, in case some get suppressed
723
- aggregationsSize: 10,
724
- // Note: we don't need an aggregations param to fetch the default aggregations from the PPS.
725
- // The default aggregations for the search_results page type should be what we need here.
726
- };
727
- params.uid = await this.requestUID({ ...params, sort: sortParams }, 'aggregations');
728
- const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
729
- const success = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success;
730
- // This is checking to see if the query has changed since the data was fetched.
731
- // If so, we just want to discard this set of aggregations because they are
732
- // likely no longer valid for the newer query.
733
- const queryChangedSinceFetch = !this.fetchesInProgress.has(facetFetchQueryKey);
734
- this.fetchesInProgress.delete(facetFetchQueryKey);
735
- if (queryChangedSinceFetch)
736
- return;
737
- if (!success) {
738
- const errorMsg = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _c === void 0 ? void 0 : _c.message;
739
- const detailMsg = (_e = (_d = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _d === void 0 ? void 0 : _d.details) === null || _e === void 0 ? void 0 : _e.message;
740
- if (!errorMsg && !detailMsg) {
741
- // @ts-ignore: Property 'Sentry' does not exist on type 'Window & typeof globalThis'
742
- (_g = (_f = window === null || window === void 0 ? void 0 : window.Sentry) === null || _f === void 0 ? void 0 : _f.captureMessage) === null || _g === void 0 ? void 0 : _g.call(_f, 'Missing or malformed facet response from backend', 'error');
743
- }
744
- this.setFacetsLoading(false);
745
- return;
746
- }
747
- const { aggregations, collectionTitles } = success.response;
748
- this.aggregations = aggregations;
749
- if (collectionTitles) {
750
- for (const [id, title] of Object.entries(collectionTitles)) {
751
- this.collectionTitles.set(id, title);
752
- }
753
- }
754
- this.yearHistogramAggregation =
755
- (_j = (_h = success === null || success === void 0 ? void 0 : success.response) === null || _h === void 0 ? void 0 : _h.aggregations) === null || _j === void 0 ? void 0 : _j.year_histogram;
756
- this.setFacetsLoading(false);
757
- this.requestHostUpdate();
758
- }
759
- /**
760
- * Performs the initial page fetch(es) for the current search state.
761
- */
762
- async doInitialPageFetch() {
763
- this.setSearchResultsLoading(true);
764
- // Try to batch 2 initial page requests when possible
765
- await this.fetchPage(this.host.initialPageNumber, 2);
766
- }
767
- /**
768
- * Fetches one or more pages of results and updates the data source.
769
- *
770
- * @param pageNumber The page number to fetch
771
- * @param numInitialPages If this is an initial page fetch (`pageNumber = 1`),
772
- * specifies how many pages to batch together in one request. Ignored
773
- * if `pageNumber != 1`, defaulting to a single page.
774
- */
775
- async fetchPage(pageNumber, numInitialPages = 1) {
776
- var _a, _b, _c, _d, _e, _f, _g, _h, _j;
777
- const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
778
- if (!this.canPerformSearch)
779
- return;
780
- // if we already have data, don't fetch again
781
- if (this.hasPage(pageNumber))
782
- return;
783
- if (this.endOfDataReached)
784
- return;
785
- // Batch multiple initial page requests together if needed (e.g., can request
786
- // pages 1 and 2 together in a single request).
787
- let numPages = pageNumber === 1 ? numInitialPages : 1;
788
- const numRows = this.pageSize * numPages;
789
- // if a fetch is already in progress for this query and page, don't fetch again
790
- const { pageFetchQueryKey } = this;
791
- const currentPageKey = `${pageFetchQueryKey}-p:${pageNumber}`;
792
- if (this.fetchesInProgress.has(currentPageKey))
793
- return;
794
- for (let i = 0; i < numPages; i += 1) {
795
- this.fetchesInProgress.add(`${pageFetchQueryKey}-p:${pageNumber + i}`);
796
- }
797
- this.previousQueryKey = pageFetchQueryKey;
798
- let sortParams = this.host.sortParam ? [this.host.sortParam] : [];
799
- // TODO eventually the PPS should handle these defaults natively
800
- const isDefaultProfileSort = this.host.withinProfile && this.host.selectedSort === SortField.default;
801
- if (isDefaultProfileSort && this.host.defaultSortParam) {
802
- const sortOption = SORT_OPTIONS[this.host.defaultSortParam.field];
803
- if (sortOption.searchServiceKey) {
804
- sortParams = [
805
- {
806
- field: sortOption.searchServiceKey,
807
- direction: 'desc',
808
- },
809
- ];
810
- }
811
- }
812
- const params = {
813
- ...this.pageSpecifierParams,
814
- query: trimmedQuery || '',
815
- page: pageNumber,
816
- rows: numRows,
817
- sort: sortParams,
818
- filters: this.filterMap,
819
- aggregations: { omit: true },
820
- };
821
- params.uid = await this.requestUID(params, 'hits');
822
- log('=== FIRING PAGE REQUEST ===', params);
823
- const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
824
- log('=== RECEIVED PAGE RESPONSE IN CB ===', searchResponse);
825
- const success = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success;
826
- // This is checking to see if the fetch has been invalidated since it was fired off.
827
- // If so, we just want to discard the response since it is for an obsolete query state.
828
- if (!this.fetchesInProgress.has(currentPageKey))
829
- return;
830
- for (let i = 0; i < numPages; i += 1) {
831
- this.fetchesInProgress.delete(`${pageFetchQueryKey}-p:${pageNumber + i}`);
832
- }
833
- if (!success) {
834
- const errorMsg = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _c === void 0 ? void 0 : _c.message;
835
- const detailMsg = (_e = (_d = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _d === void 0 ? void 0 : _d.details) === null || _e === void 0 ? void 0 : _e.message;
836
- this.queryErrorMessage = `${errorMsg !== null && errorMsg !== void 0 ? errorMsg : ''}${detailMsg ? `; ${detailMsg}` : ''}`;
837
- if (!this.queryErrorMessage) {
838
- this.queryErrorMessage = 'Missing or malformed response from backend';
839
- // @ts-ignore: Property 'Sentry' does not exist on type 'Window & typeof globalThis'
840
- (_g = (_f = window === null || window === void 0 ? void 0 : window.Sentry) === null || _f === void 0 ? void 0 : _f.captureMessage) === null || _g === void 0 ? void 0 : _g.call(_f, this.queryErrorMessage, 'error');
841
- }
842
- this.setSearchResultsLoading(false);
843
- this.requestHostUpdate();
844
- return;
845
- }
846
- this.setTotalResultCount(success.response.totalResults - this.offset);
847
- if (this.activeOnHost && this.totalResults === 0) {
848
- // display event to offshoot when result count is zero.
849
- this.host.emitEmptyResults();
850
- }
851
- this.sessionContext = success.sessionContext;
852
- if (this.host.withinCollection) {
853
- this.collectionExtraInfo = success.response.collectionExtraInfo;
854
- // For collections, we want the UI to respect the default sort option
855
- // which can be specified in metadata, or otherwise assumed to be week:desc
856
- if (this.activeOnHost) {
857
- this.host.applyDefaultCollectionSort(this.collectionExtraInfo);
858
- }
859
- if (this.collectionExtraInfo) {
860
- this.parentCollections = [].concat((_j = (_h = this.collectionExtraInfo.public_metadata) === null || _h === void 0 ? void 0 : _h.collection) !== null && _j !== void 0 ? _j : []);
861
- }
862
- }
863
- else if (this.host.withinProfile) {
864
- this.accountExtraInfo = success.response.accountExtraInfo;
865
- this.pageElements = success.response.pageElements;
866
- }
867
- const { results, collectionTitles } = success.response;
868
- if (results && results.length > 0) {
869
- // Load any collection titles present on the response into the cache,
870
- // or queue up preload fetches for them if none were present.
871
- if (collectionTitles) {
872
- for (const [id, title] of Object.entries(collectionTitles)) {
873
- this.collectionTitles.set(id, title);
874
- }
875
- }
876
- // Update the data source for each returned page.
877
- // For loans and web archives, we must account for receiving more pages than we asked for.
878
- if (this.host.profileElement === 'lending' ||
879
- this.host.profileElement === 'web_archives') {
880
- numPages = Math.ceil(results.length / this.pageSize);
881
- this.endOfDataReached = true;
882
- if (this.activeOnHost)
883
- this.host.setTileCount(this.totalResults);
884
- }
885
- for (let i = 0; i < numPages; i += 1) {
886
- const pageStartIndex = this.pageSize * i;
887
- this.addFetchedResultsToDataSource(pageNumber + i, results.slice(pageStartIndex, pageStartIndex + this.pageSize));
888
- }
889
- }
890
- // When we reach the end of the data, we can set the infinite scroller's
891
- // item count to the real total number of results (rather than the
892
- // temporary estimates based on pages rendered so far).
893
- if (this.size >= this.totalResults || results.length === 0) {
894
- this.endOfDataReached = true;
895
- if (this.activeOnHost)
896
- this.host.setTileCount(this.size);
897
- }
898
- this.setSearchResultsLoading(false);
899
- this.requestHostUpdate();
900
- }
901
- /**
902
- * Update the datasource from the fetch response
903
- *
904
- * @param pageNumber
905
- * @param results
906
- */
907
- addFetchedResultsToDataSource(pageNumber, results) {
908
- const tiles = [];
909
- results === null || results === void 0 ? void 0 : results.forEach(result => {
910
- if (!result.identifier)
911
- return;
912
- tiles.push(new TileModel(result));
913
- });
914
- this.addPage(pageNumber, tiles);
915
- const visiblePages = this.host.currentVisiblePageNumbers;
916
- const needsReload = visiblePages.includes(pageNumber);
917
- if (needsReload) {
918
- this.refreshVisibleResults();
919
- }
920
- }
921
- /**
922
- * Fetches the aggregation buckets for the given prefix filter type.
923
- */
924
- async fetchPrefixFilterBuckets(filterType) {
925
- var _a, _b, _c, _d, _e, _f, _g;
926
- const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
927
- if (!this.canPerformSearch)
928
- return [];
929
- const filterAggregationKey = prefixFilterAggregationKeys[filterType];
930
- const sortParams = this.host.sortParam ? [this.host.sortParam] : [];
931
- const params = {
932
- ...this.pageSpecifierParams,
933
- query: trimmedQuery || '',
934
- rows: 0,
935
- filters: this.filterMap,
936
- // Only fetch the firstTitle or firstCreator aggregation
937
- aggregations: { simpleParams: [filterAggregationKey] },
938
- // Fetch all 26 letter buckets
939
- aggregationsSize: 26,
940
- };
941
- params.uid = await this.requestUID({ ...params, sort: sortParams }, 'aggregations');
942
- const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
943
- return ((_g = (_f = (_e = (_d = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success) === null || _c === void 0 ? void 0 : _c.response) === null || _d === void 0 ? void 0 : _d.aggregations) === null || _e === void 0 ? void 0 : _e[filterAggregationKey]) === null || _f === void 0 ? void 0 : _f.buckets) !== null && _g !== void 0 ? _g : []);
944
- }
945
- /**
946
- * Fetches and caches the prefix filter counts for the given filter type.
947
- */
948
- async updatePrefixFilterCounts(filterType) {
949
- const { facetFetchQueryKey } = this;
950
- const buckets = await this.fetchPrefixFilterBuckets(filterType);
951
- // Don't update the filter counts for an outdated query (if it has been changed
952
- // since we sent the request)
953
- const queryChangedSinceFetch = facetFetchQueryKey !== this.facetFetchQueryKey;
954
- if (queryChangedSinceFetch)
955
- return;
956
- // Unpack the aggregation buckets into a simple map like { 'A': 50, 'B': 25, ... }
957
- this.prefixFilterCountMap = { ...this.prefixFilterCountMap }; // Clone the object to trigger an update
958
- this.prefixFilterCountMap[filterType] = buckets.reduce((acc, bucket) => {
959
- acc[bucket.key.toUpperCase()] = bucket.doc_count;
960
- return acc;
961
- }, {});
962
- this.requestHostUpdate();
963
- }
964
- /**
965
- * @inheritdoc
966
- */
967
- async updatePrefixFiltersForCurrentSort() {
968
- if (['title', 'creator'].includes(this.host.selectedSort)) {
969
- const filterType = this.host.selectedSort;
970
- if (!this.prefixFilterCountMap[filterType]) {
971
- this.updatePrefixFilterCounts(filterType);
972
- }
973
- }
974
- }
975
- /**
976
- * @inheritdoc
977
- */
978
- refreshLetterCounts() {
979
- if (Object.keys(this.prefixFilterCountMap).length > 0) {
980
- this.prefixFilterCountMap = {};
981
- }
982
- this.updatePrefixFiltersForCurrentSort();
983
- this.requestHostUpdate();
984
- }
985
- }
1
+ import { FilterConstraint, FilterMapBuilder, SearchType, } from '@internetarchive/search-service';
2
+ import { prefixFilterAggregationKeys, TileModel, SortField, SORT_OPTIONS, } from '../models';
3
+ import { FACETLESS_PAGE_ELEMENTS } from './models';
4
+ import { sha1 } from '../utils/sha1';
5
+ import { log } from '../utils/log';
6
+ export class CollectionBrowserDataSource {
7
+ // eslint-disable-next-line no-useless-constructor
8
+ constructor(
9
+ /** The host element to which this controller should attach listeners */
10
+ host,
11
+ /** Default size of result pages */
12
+ pageSize = 50) {
13
+ this.host = host;
14
+ this.pageSize = pageSize;
15
+ /**
16
+ * All pages of tile models that have been fetched so far, indexed by their page
17
+ * number (with the first being page 1).
18
+ */
19
+ this.pages = {};
20
+ /**
21
+ * Tile offset to apply when looking up tiles in the pages, in order to maintain
22
+ * page alignment after tiles are removed.
23
+ */
24
+ this.offset = 0;
25
+ /**
26
+ * Total number of tile models stored in this data source's pages
27
+ */
28
+ this.numTileModels = 0;
29
+ /**
30
+ * A set of fetch IDs that are valid for the current query state
31
+ */
32
+ this.fetchesInProgress = new Set();
33
+ /**
34
+ * A record of the query key used for the last search.
35
+ * If this changes, we need to load new results.
36
+ */
37
+ this.previousQueryKey = '';
38
+ /**
39
+ * Whether the initial page of search results for the current query state
40
+ * is presently being fetched.
41
+ */
42
+ this.searchResultsLoading = false;
43
+ /**
44
+ * Whether the facets (aggregations) for the current query state are
45
+ * presently being fetched.
46
+ */
47
+ this.facetsLoading = false;
48
+ /**
49
+ * Whether the facets are actually visible -- if not, then we can delay any facet
50
+ * fetches until they become visible.
51
+ */
52
+ this.facetsReadyToLoad = false;
53
+ /**
54
+ * Whether further query changes should be ignored and not trigger fetches
55
+ */
56
+ this.suppressFetches = false;
57
+ /**
58
+ * @inheritdoc
59
+ */
60
+ this.totalResults = 0;
61
+ /**
62
+ * @inheritdoc
63
+ */
64
+ this.endOfDataReached = false;
65
+ /**
66
+ * @inheritdoc
67
+ */
68
+ this.queryInitialized = false;
69
+ /**
70
+ * @inheritdoc
71
+ */
72
+ this.collectionTitles = new Map();
73
+ /**
74
+ * @inheritdoc
75
+ */
76
+ this.parentCollections = [];
77
+ /**
78
+ * @inheritdoc
79
+ */
80
+ this.prefixFilterCountMap = {};
81
+ /**
82
+ * Internal property to store the private value backing the `initialSearchComplete` getter.
83
+ */
84
+ this._initialSearchCompletePromise = new Promise(res => {
85
+ this._initialSearchCompleteResolver = res;
86
+ });
87
+ /**
88
+ * @inheritdoc
89
+ */
90
+ this.checkAllTiles = () => {
91
+ this.map(model => {
92
+ const cloned = model.clone();
93
+ cloned.checked = true;
94
+ return cloned;
95
+ });
96
+ };
97
+ /**
98
+ * @inheritdoc
99
+ */
100
+ this.uncheckAllTiles = () => {
101
+ this.map(model => {
102
+ const cloned = model.clone();
103
+ cloned.checked = false;
104
+ return cloned;
105
+ });
106
+ };
107
+ /**
108
+ * @inheritdoc
109
+ */
110
+ this.removeCheckedTiles = () => {
111
+ // To make sure our data source remains page-aligned, we will offset our data source by
112
+ // the number of removed tiles, so that we can just add the offset when the infinite
113
+ // scroller queries for cell contents.
114
+ // This only matters while we're still viewing the same set of results. If the user changes
115
+ // their query/filters/sort, then the data source is overwritten and the offset cleared.
116
+ const { checkedTileModels, uncheckedTileModels } = this;
117
+ const numChecked = checkedTileModels.length;
118
+ if (numChecked === 0)
119
+ return;
120
+ this.offset += numChecked;
121
+ const newPages = {};
122
+ // Which page the remaining tile models start on, post-offset
123
+ let offsetPageNumber = Math.floor(this.offset / this.pageSize) + 1;
124
+ let indexOnPage = this.offset % this.pageSize;
125
+ // Fill the pages up to that point with empty models
126
+ for (let page = 1; page <= offsetPageNumber; page += 1) {
127
+ const remainingHidden = this.offset - this.pageSize * (page - 1);
128
+ const offsetCellsOnPage = Math.min(this.pageSize, remainingHidden);
129
+ newPages[page] = Array(offsetCellsOnPage).fill(undefined);
130
+ }
131
+ // Shift all the remaining tiles into their new positions in the data source
132
+ for (const model of uncheckedTileModels) {
133
+ if (!newPages[offsetPageNumber])
134
+ newPages[offsetPageNumber] = [];
135
+ newPages[offsetPageNumber].push(model);
136
+ indexOnPage += 1;
137
+ if (indexOnPage >= this.pageSize) {
138
+ offsetPageNumber += 1;
139
+ indexOnPage = 0;
140
+ }
141
+ }
142
+ // Swap in the new pages
143
+ this.pages = newPages;
144
+ this.numTileModels -= numChecked;
145
+ this.totalResults -= numChecked;
146
+ this.host.setTileCount(this.size);
147
+ this.host.setTotalResultCount(this.totalResults);
148
+ this.requestHostUpdate();
149
+ this.refreshVisibleResults();
150
+ };
151
+ // Just setting some property values
152
+ }
153
+ /**
154
+ * @inheritdoc
155
+ */
156
+ get initialSearchComplete() {
157
+ return this._initialSearchCompletePromise;
158
+ }
159
+ hostConnected() {
160
+ this.setSearchResultsLoading(this.searchResultsLoading);
161
+ this.setFacetsLoading(this.facetsLoading);
162
+ }
163
+ hostUpdate() {
164
+ // This reactive controller hook is run whenever the host component (collection-browser) performs an update.
165
+ // We check whether the host's state has changed in a way which should trigger a reset & new results fetch.
166
+ // Only the currently-installed data source should react to the update
167
+ if (!this.activeOnHost)
168
+ return;
169
+ // Copy loading states onto the host
170
+ this.setSearchResultsLoading(this.searchResultsLoading);
171
+ this.setFacetsLoading(this.facetsLoading);
172
+ // Can't perform searches without a search service
173
+ if (!this.host.searchService)
174
+ return;
175
+ // We should only reset if part of the full query state has changed
176
+ const queryKeyChanged = this.pageFetchQueryKey !== this.previousQueryKey;
177
+ if (!queryKeyChanged)
178
+ return;
179
+ // We should only reset if either:
180
+ // (a) our state permits a valid search, or
181
+ // (b) we have a blank query that we want to show empty results for
182
+ const shouldShowEmptyQueryResults = this.host.clearResultsOnEmptyQuery && this.host.baseQuery === '';
183
+ if (!(this.canPerformSearch || shouldShowEmptyQueryResults))
184
+ return;
185
+ if (this.activeOnHost)
186
+ this.host.emitQueryStateChanged();
187
+ this.handleQueryChange();
188
+ }
189
+ /**
190
+ * Returns whether this data source is the one currently installed on the host component.
191
+ */
192
+ get activeOnHost() {
193
+ return this.host.dataSource === this;
194
+ }
195
+ /**
196
+ * @inheritdoc
197
+ */
198
+ get size() {
199
+ return this.numTileModels;
200
+ }
201
+ /**
202
+ * @inheritdoc
203
+ */
204
+ reset() {
205
+ log('Resetting CB data source');
206
+ this.pages = {};
207
+ this.aggregations = {};
208
+ this.yearHistogramAggregation = undefined;
209
+ this.pageElements = undefined;
210
+ this.parentCollections = [];
211
+ this.queryErrorMessage = undefined;
212
+ this.offset = 0;
213
+ this.numTileModels = 0;
214
+ this.endOfDataReached = false;
215
+ this.queryInitialized = false;
216
+ this.facetsLoading = false;
217
+ // Invalidate any fetches in progress
218
+ this.fetchesInProgress.clear();
219
+ this.setTotalResultCount(0);
220
+ this.requestHostUpdate();
221
+ }
222
+ /**
223
+ * @inheritdoc
224
+ */
225
+ addPage(pageNum, pageTiles) {
226
+ this.pages[pageNum] = pageTiles;
227
+ this.numTileModels += pageTiles.length;
228
+ this.requestHostUpdate();
229
+ }
230
+ /**
231
+ * @inheritdoc
232
+ */
233
+ addMultiplePages(firstPageNum, tiles) {
234
+ const numPages = Math.ceil(tiles.length / this.pageSize);
235
+ for (let i = 0; i < numPages; i += 1) {
236
+ const pageStartIndex = this.pageSize * i;
237
+ this.addPage(firstPageNum + i, tiles.slice(pageStartIndex, pageStartIndex + this.pageSize));
238
+ }
239
+ const visiblePages = this.host.currentVisiblePageNumbers;
240
+ const needsReload = visiblePages.some(page => page >= firstPageNum && page <= firstPageNum + numPages);
241
+ if (needsReload) {
242
+ this.refreshVisibleResults();
243
+ }
244
+ }
245
+ /**
246
+ * @inheritdoc
247
+ */
248
+ getPage(pageNum) {
249
+ return this.pages[pageNum];
250
+ }
251
+ /**
252
+ * @inheritdoc
253
+ */
254
+ getAllPages() {
255
+ return this.pages;
256
+ }
257
+ /**
258
+ * @inheritdoc
259
+ */
260
+ hasPage(pageNum) {
261
+ return !!this.pages[pageNum];
262
+ }
263
+ /**
264
+ * @inheritdoc
265
+ */
266
+ getTileModelAt(index) {
267
+ var _a, _b;
268
+ const offsetIndex = index + this.offset;
269
+ const expectedPageNum = Math.floor(offsetIndex / this.pageSize) + 1;
270
+ const expectedIndexOnPage = offsetIndex % this.pageSize;
271
+ let page = 1;
272
+ let tilesSeen = 0;
273
+ while (tilesSeen <= offsetIndex) {
274
+ if (!this.pages[page]) {
275
+ // If we encounter a missing page, either we're past all the results or the page data is sparse.
276
+ // So just return the tile at the expected position if it exists.
277
+ return (_a = this.pages[expectedPageNum]) === null || _a === void 0 ? void 0 : _a[expectedIndexOnPage];
278
+ }
279
+ if (tilesSeen + this.pages[page].length > offsetIndex) {
280
+ return this.pages[page][offsetIndex - tilesSeen];
281
+ }
282
+ tilesSeen += this.pages[page].length;
283
+ page += 1;
284
+ }
285
+ return (_b = this.pages[expectedPageNum]) === null || _b === void 0 ? void 0 : _b[expectedIndexOnPage];
286
+ }
287
+ /**
288
+ * @inheritdoc
289
+ */
290
+ indexOf(tile) {
291
+ return Object.values(this.pages).flat().indexOf(tile) - this.offset;
292
+ }
293
+ /**
294
+ * @inheritdoc
295
+ */
296
+ getPageSize() {
297
+ return this.pageSize;
298
+ }
299
+ /**
300
+ * @inheritdoc
301
+ */
302
+ setPageSize(pageSize) {
303
+ this.reset();
304
+ this.pageSize = pageSize;
305
+ }
306
+ /**
307
+ * @inheritdoc
308
+ */
309
+ setTotalResultCount(count) {
310
+ this.totalResults = count;
311
+ if (this.activeOnHost) {
312
+ this.host.setTotalResultCount(count);
313
+ }
314
+ }
315
+ /**
316
+ * @inheritdoc
317
+ */
318
+ setFetchesSuppressed(suppressed) {
319
+ this.suppressFetches = suppressed;
320
+ }
321
+ /**
322
+ * @inheritdoc
323
+ */
324
+ async handleQueryChange() {
325
+ // Don't react to the change if fetches are suppressed for this data source
326
+ if (this.suppressFetches)
327
+ return;
328
+ this.reset();
329
+ // Reset the `initialSearchComplete` promise with a new value for the imminent search
330
+ this._initialSearchCompletePromise = new Promise(res => {
331
+ this._initialSearchCompleteResolver = res;
332
+ });
333
+ // Fire the initial page & facet requests
334
+ this.queryInitialized = true;
335
+ await Promise.all([
336
+ this.doInitialPageFetch(),
337
+ this.canFetchFacets ? this.fetchFacets() : null,
338
+ ]);
339
+ // Resolve the `initialSearchComplete` promise for this search
340
+ this._initialSearchCompleteResolver(true);
341
+ }
342
+ /**
343
+ * @inheritdoc
344
+ */
345
+ async handleFacetReadinessChange(ready) {
346
+ const facetsBecameReady = !this.facetsReadyToLoad && ready;
347
+ this.facetsReadyToLoad = ready;
348
+ const lazyLoadFacets = ['lazy-mobile', 'opt-in'].includes(this.host.facetLoadStrategy);
349
+ const needsFetch = lazyLoadFacets && facetsBecameReady && this.canFetchFacets;
350
+ if (needsFetch) {
351
+ this.fetchFacets();
352
+ }
353
+ }
354
+ /**
355
+ * Whether the data source & its host are in a state where a facet request should be fired.
356
+ * (i.e., they aren't suppressed or already loading, etc.)
357
+ */
358
+ get canFetchFacets() {
359
+ var _a;
360
+ // Don't fetch facets if they are suppressed entirely or not required for the current profile page element
361
+ if (this.host.facetLoadStrategy === 'off')
362
+ return false;
363
+ if (FACETLESS_PAGE_ELEMENTS.includes(this.host.profileElement))
364
+ return false;
365
+ // If facets are to be lazy-loaded, don't fetch them if they are not going to be visible anyway
366
+ // (wait until they become visible instead)
367
+ if (this.host.facetLoadStrategy !== 'eager' && !this.facetsReadyToLoad)
368
+ return false;
369
+ // Don't fetch facets again if they are already fetched or pending
370
+ const facetsAlreadyFetched = Object.keys((_a = this.aggregations) !== null && _a !== void 0 ? _a : {}).length > 0;
371
+ if (this.facetsLoading || facetsAlreadyFetched)
372
+ return false;
373
+ return true;
374
+ }
375
+ /**
376
+ * @inheritdoc
377
+ */
378
+ map(callback) {
379
+ this.pages = Object.fromEntries(Object.entries(this.pages).map(([page, tileModels]) => [
380
+ page,
381
+ tileModels.map((model, index, array) => model ? callback(model, index, array) : model),
382
+ ]));
383
+ this.requestHostUpdate();
384
+ this.refreshVisibleResults();
385
+ }
386
+ /**
387
+ * @inheritdoc
388
+ */
389
+ get checkedTileModels() {
390
+ return this.getFilteredTileModels(model => model.checked);
391
+ }
392
+ /**
393
+ * @inheritdoc
394
+ */
395
+ get uncheckedTileModels() {
396
+ return this.getFilteredTileModels(model => !model.checked);
397
+ }
398
+ /**
399
+ * Returns a flattened, filtered array of all the tile models in the data source
400
+ * for which the given predicate returns a truthy value.
401
+ *
402
+ * @param predicate A callback function to apply on each tile model, as with Array.filter
403
+ * @returns A filtered array of tile models satisfying the predicate
404
+ */
405
+ getFilteredTileModels(predicate) {
406
+ return Object.values(this.pages)
407
+ .flat()
408
+ .filter((model, index, array) => model ? predicate(model, index, array) : false);
409
+ }
410
+ /**
411
+ * @inheritdoc
412
+ */
413
+ get canPerformSearch() {
414
+ var _a;
415
+ if (!this.host.searchService)
416
+ return false;
417
+ const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
418
+ const hasNonEmptyQuery = !!trimmedQuery;
419
+ const isCollectionSearch = !!this.host.withinCollection;
420
+ const isProfileSearch = !!this.host.withinProfile;
421
+ const hasProfileElement = !!this.host.profileElement;
422
+ const isMetadataSearch = this.host.searchType === SearchType.METADATA;
423
+ // Metadata searches within a collection/profile are allowed to have no query.
424
+ // Otherwise, a non-empty query must be set.
425
+ return (hasNonEmptyQuery ||
426
+ (isCollectionSearch && isMetadataSearch) ||
427
+ (isProfileSearch && hasProfileElement && isMetadataSearch));
428
+ }
429
+ /**
430
+ * Sets the state for whether the initial set of search results for the
431
+ * current query is loading
432
+ */
433
+ setSearchResultsLoading(loading) {
434
+ this.searchResultsLoading = loading;
435
+ if (this.activeOnHost) {
436
+ this.host.setSearchResultsLoading(loading);
437
+ }
438
+ }
439
+ /**
440
+ * Sets the state for whether the facets for a query is loading
441
+ */
442
+ setFacetsLoading(loading) {
443
+ this.facetsLoading = loading;
444
+ if (this.activeOnHost) {
445
+ this.host.setFacetsLoading(loading);
446
+ }
447
+ }
448
+ /**
449
+ * Requests that the host perform an update, provided this data
450
+ * source is actively installed on it.
451
+ */
452
+ requestHostUpdate() {
453
+ if (this.activeOnHost) {
454
+ this.host.requestUpdate();
455
+ }
456
+ }
457
+ /**
458
+ * Requests that the host refresh its visible tiles, provided this
459
+ * data source is actively installed on it.
460
+ */
461
+ refreshVisibleResults() {
462
+ if (this.activeOnHost) {
463
+ this.host.refreshVisibleResults();
464
+ }
465
+ }
466
+ /**
467
+ * The query key is a string that uniquely identifies the current search.
468
+ * It consists of:
469
+ * - The current base query
470
+ * - The current collection/profile target & page element
471
+ * - The current search type
472
+ * - Any currently-applied facets
473
+ * - Any currently-applied date range
474
+ * - Any currently-applied prefix filters
475
+ * - The current sort options
476
+ *
477
+ * This lets us internally keep track of queries so we don't persist data that's
478
+ * no longer relevant. Not meant to be human-readable.
479
+ */
480
+ get pageFetchQueryKey() {
481
+ var _a, _b, _c;
482
+ const profileKey = `pf;${this.host.withinProfile}--pe;${this.host.profileElement}`;
483
+ const pageTarget = (_a = this.host.withinCollection) !== null && _a !== void 0 ? _a : profileKey;
484
+ const sortField = (_b = this.host.selectedSort) !== null && _b !== void 0 ? _b : 'none';
485
+ const sortDirection = (_c = this.host.sortDirection) !== null && _c !== void 0 ? _c : 'none';
486
+ return `fq:${this.fullQuery}-pt:${pageTarget}-st:${this.host.searchType}-sf:${sortField}-sd:${sortDirection}`;
487
+ }
488
+ /**
489
+ * Similar to `pageFetchQueryKey` above, but excludes sort fields since they
490
+ * are not relevant in determining aggregation queries.
491
+ */
492
+ get facetFetchQueryKey() {
493
+ var _a;
494
+ const profileKey = `pf;${this.host.withinProfile}--pe;${this.host.profileElement}`;
495
+ const pageTarget = (_a = this.host.withinCollection) !== null && _a !== void 0 ? _a : profileKey;
496
+ return `fq:${this.fullQuery}-pt:${pageTarget}-st:${this.host.searchType}`;
497
+ }
498
+ /**
499
+ * Constructs a search service FilterMap object from the combination of
500
+ * all the currently-applied filters. This includes any facets, letter
501
+ * filters, and date range.
502
+ */
503
+ get filterMap() {
504
+ const builder = new FilterMapBuilder();
505
+ // Add the date range, if applicable
506
+ if (this.host.minSelectedDate) {
507
+ builder.addFilter('year', this.host.minSelectedDate, FilterConstraint.GREATER_OR_EQUAL);
508
+ }
509
+ if (this.host.maxSelectedDate) {
510
+ builder.addFilter('year', this.host.maxSelectedDate, FilterConstraint.LESS_OR_EQUAL);
511
+ }
512
+ // Add any selected facets
513
+ if (this.host.selectedFacets) {
514
+ for (const [facetName, facetValues] of Object.entries(this.host.selectedFacets)) {
515
+ const { name, values } = this.prepareFacetForFetch(facetName, facetValues);
516
+ for (const [value, bucket] of Object.entries(values)) {
517
+ let constraint;
518
+ if (bucket.state === 'selected') {
519
+ constraint = FilterConstraint.INCLUDE;
520
+ }
521
+ else if (bucket.state === 'hidden') {
522
+ constraint = FilterConstraint.EXCLUDE;
523
+ }
524
+ if (constraint) {
525
+ builder.addFilter(name, value, constraint);
526
+ }
527
+ }
528
+ }
529
+ }
530
+ // Add any letter filters
531
+ if (this.host.selectedTitleFilter) {
532
+ builder.addFilter('firstTitle', this.host.selectedTitleFilter, FilterConstraint.INCLUDE);
533
+ }
534
+ if (this.host.selectedCreatorFilter) {
535
+ builder.addFilter('firstCreator', this.host.selectedCreatorFilter, FilterConstraint.INCLUDE);
536
+ }
537
+ const filterMap = builder.build();
538
+ return filterMap;
539
+ }
540
+ /**
541
+ * Produces a compact unique ID for a search request that can help with debugging
542
+ * on the backend by making related requests easier to trace through different services.
543
+ * (e.g., tying the hits/aggregations requests for the same page back to a single hash).
544
+ *
545
+ * @param params The search service parameters for the request
546
+ * @param kind The kind of request (hits-only, aggregations-only, or both)
547
+ * @returns A Promise resolving to the uid to apply to the request
548
+ */
549
+ async requestUID(params, kind) {
550
+ var _a;
551
+ const paramsToHash = JSON.stringify({
552
+ pageType: params.pageType,
553
+ pageTarget: params.pageTarget,
554
+ query: params.query,
555
+ fields: params.fields,
556
+ filters: params.filters,
557
+ sort: params.sort,
558
+ searchType: this.host.searchType,
559
+ });
560
+ const fullQueryHash = (await sha1(paramsToHash)).slice(0, 20); // First 80 bits of SHA-1 are plenty for this
561
+ const sessionId = (await this.host.getSessionId()).slice(0, 20); // Likewise
562
+ const page = (_a = params.page) !== null && _a !== void 0 ? _a : 0;
563
+ const kindPrefix = kind.charAt(0); // f = full, h = hits, a = aggregations
564
+ const currentTime = Date.now();
565
+ return `R:${fullQueryHash}-S:${sessionId}-P:${page}-K:${kindPrefix}-T:${currentTime}`;
566
+ }
567
+ /**
568
+ * @inheritdoc
569
+ */
570
+ get pageSpecifierParams() {
571
+ if (this.host.withinCollection) {
572
+ return {
573
+ pageType: 'collection_details',
574
+ pageTarget: this.host.withinCollection,
575
+ };
576
+ }
577
+ if (this.host.withinProfile) {
578
+ return {
579
+ pageType: 'account_details',
580
+ pageTarget: this.host.withinProfile,
581
+ pageElements: this.host.profileElement
582
+ ? [this.host.profileElement]
583
+ : [],
584
+ };
585
+ }
586
+ return null;
587
+ }
588
+ /**
589
+ * The full query, including year facets and date range clauses
590
+ */
591
+ get fullQuery() {
592
+ var _a, _b;
593
+ let fullQuery = (_b = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim()) !== null && _b !== void 0 ? _b : '';
594
+ const { facetQuery, dateRangeQueryClause, sortFilterQueries } = this;
595
+ if (facetQuery) {
596
+ fullQuery += ` AND ${facetQuery}`;
597
+ }
598
+ if (dateRangeQueryClause) {
599
+ fullQuery += ` AND ${dateRangeQueryClause}`;
600
+ }
601
+ if (sortFilterQueries) {
602
+ fullQuery += ` AND ${sortFilterQueries}`;
603
+ }
604
+ return fullQuery.trim();
605
+ }
606
+ /**
607
+ * Generates a query string representing the current set of applied facets
608
+ *
609
+ * Example: `mediatype:("collection" OR "audio" OR -"etree") AND year:("2000" OR "2001")`
610
+ */
611
+ get facetQuery() {
612
+ var _a;
613
+ if (!this.host.selectedFacets)
614
+ return undefined;
615
+ const facetClauses = [];
616
+ for (const [facetName, facetValues] of Object.entries(this.host.selectedFacets)) {
617
+ facetClauses.push(this.buildFacetClause(facetName, facetValues));
618
+ }
619
+ return (_a = this.joinFacetClauses(facetClauses)) === null || _a === void 0 ? void 0 : _a.trim();
620
+ }
621
+ get dateRangeQueryClause() {
622
+ if (!this.host.minSelectedDate || !this.host.maxSelectedDate) {
623
+ return undefined;
624
+ }
625
+ return `year:[${this.host.minSelectedDate} TO ${this.host.maxSelectedDate}]`;
626
+ }
627
+ get sortFilterQueries() {
628
+ const queries = [this.titleQuery, this.creatorQuery];
629
+ return queries.filter(q => q).join(' AND ');
630
+ }
631
+ /**
632
+ * Returns a query clause identifying the currently selected title filter,
633
+ * e.g., `firstTitle:X`.
634
+ */
635
+ get titleQuery() {
636
+ return this.host.selectedTitleFilter
637
+ ? `firstTitle:${this.host.selectedTitleFilter}`
638
+ : undefined;
639
+ }
640
+ /**
641
+ * Returns a query clause identifying the currently selected creator filter,
642
+ * e.g., `firstCreator:X`.
643
+ */
644
+ get creatorQuery() {
645
+ return this.host.selectedCreatorFilter
646
+ ? `firstCreator:${this.host.selectedCreatorFilter}`
647
+ : undefined;
648
+ }
649
+ /**
650
+ * Builds an OR-joined facet clause for the given facet name and values.
651
+ *
652
+ * E.g., for name `subject` and values
653
+ * `{ foo: { state: 'selected' }, bar: { state: 'hidden' } }`
654
+ * this will produce the clause
655
+ * `subject:("foo" OR -"bar")`.
656
+ *
657
+ * @param facetName The facet type (e.g., 'collection')
658
+ * @param facetValues The facet buckets, mapped by their keys
659
+ */
660
+ buildFacetClause(facetName, facetValues) {
661
+ const { name: facetQueryName, values } = this.prepareFacetForFetch(facetName, facetValues);
662
+ const facetEntries = Object.entries(values);
663
+ if (facetEntries.length === 0)
664
+ return '';
665
+ const facetValuesArray = [];
666
+ for (const [key, facetData] of facetEntries) {
667
+ const plusMinusPrefix = facetData.state === 'hidden' ? '-' : '';
668
+ facetValuesArray.push(`${plusMinusPrefix}"${key}"`);
669
+ }
670
+ const valueQuery = facetValuesArray.join(` OR `);
671
+ return `${facetQueryName}:(${valueQuery})`;
672
+ }
673
+ /**
674
+ * Handles some special pre-request normalization steps for certain facet types
675
+ * that require them.
676
+ *
677
+ * @param facetName The name of the facet type (e.g., 'language')
678
+ * @param facetValues An array of values for that facet type
679
+ */
680
+ prepareFacetForFetch(facetName, facetValues) {
681
+ // eslint-disable-next-line prefer-const
682
+ let [normalizedName, normalizedValues] = [facetName, facetValues];
683
+ // The full "search engine" name of the lending field is "lending___status"
684
+ if (facetName === 'lending') {
685
+ normalizedName = 'lending___status';
686
+ }
687
+ return {
688
+ name: normalizedName,
689
+ values: normalizedValues,
690
+ };
691
+ }
692
+ /**
693
+ * Takes an array of facet clauses, and combines them into a
694
+ * full AND-joined facet query string. Empty clauses are ignored.
695
+ */
696
+ joinFacetClauses(facetClauses) {
697
+ const nonEmptyFacetClauses = facetClauses.filter(clause => clause.length > 0);
698
+ return nonEmptyFacetClauses.length > 0
699
+ ? `(${nonEmptyFacetClauses.join(' AND ')})`
700
+ : undefined;
701
+ }
702
+ /**
703
+ * Fires a backend request to fetch a set of aggregations (representing UI facets) for
704
+ * the current search state.
705
+ */
706
+ async fetchFacets() {
707
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
708
+ const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
709
+ if (!this.canPerformSearch)
710
+ return;
711
+ const { facetFetchQueryKey } = this;
712
+ if (this.fetchesInProgress.has(facetFetchQueryKey))
713
+ return;
714
+ this.fetchesInProgress.add(facetFetchQueryKey);
715
+ this.setFacetsLoading(true);
716
+ const sortParams = this.host.sortParam ? [this.host.sortParam] : [];
717
+ const params = {
718
+ ...this.pageSpecifierParams,
719
+ query: trimmedQuery || '',
720
+ rows: 0,
721
+ filters: this.filterMap,
722
+ // Fetch a few extra buckets beyond the 6 we show, in case some get suppressed
723
+ aggregationsSize: 10,
724
+ // Note: we don't need an aggregations param to fetch the default aggregations from the PPS.
725
+ // The default aggregations for the search_results page type should be what we need here.
726
+ };
727
+ params.uid = await this.requestUID({ ...params, sort: sortParams }, 'aggregations');
728
+ const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
729
+ const success = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success;
730
+ // This is checking to see if the query has changed since the data was fetched.
731
+ // If so, we just want to discard this set of aggregations because they are
732
+ // likely no longer valid for the newer query.
733
+ const queryChangedSinceFetch = !this.fetchesInProgress.has(facetFetchQueryKey);
734
+ this.fetchesInProgress.delete(facetFetchQueryKey);
735
+ if (queryChangedSinceFetch)
736
+ return;
737
+ if (!success) {
738
+ const errorMsg = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _c === void 0 ? void 0 : _c.message;
739
+ const detailMsg = (_e = (_d = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _d === void 0 ? void 0 : _d.details) === null || _e === void 0 ? void 0 : _e.message;
740
+ if (!errorMsg && !detailMsg) {
741
+ // @ts-ignore: Property 'Sentry' does not exist on type 'Window & typeof globalThis'
742
+ (_g = (_f = window === null || window === void 0 ? void 0 : window.Sentry) === null || _f === void 0 ? void 0 : _f.captureMessage) === null || _g === void 0 ? void 0 : _g.call(_f, 'Missing or malformed facet response from backend', 'error');
743
+ }
744
+ this.setFacetsLoading(false);
745
+ return;
746
+ }
747
+ const { aggregations, collectionTitles } = success.response;
748
+ this.aggregations = aggregations;
749
+ if (collectionTitles) {
750
+ for (const [id, title] of Object.entries(collectionTitles)) {
751
+ this.collectionTitles.set(id, title);
752
+ }
753
+ }
754
+ this.yearHistogramAggregation =
755
+ (_j = (_h = success === null || success === void 0 ? void 0 : success.response) === null || _h === void 0 ? void 0 : _h.aggregations) === null || _j === void 0 ? void 0 : _j.year_histogram;
756
+ this.setFacetsLoading(false);
757
+ this.requestHostUpdate();
758
+ }
759
+ /**
760
+ * Performs the initial page fetch(es) for the current search state.
761
+ */
762
+ async doInitialPageFetch() {
763
+ this.setSearchResultsLoading(true);
764
+ // Try to batch 2 initial page requests when possible
765
+ await this.fetchPage(this.host.initialPageNumber, 2);
766
+ }
767
+ /**
768
+ * Fetches one or more pages of results and updates the data source.
769
+ *
770
+ * @param pageNumber The page number to fetch
771
+ * @param numInitialPages If this is an initial page fetch (`pageNumber = 1`),
772
+ * specifies how many pages to batch together in one request. Ignored
773
+ * if `pageNumber != 1`, defaulting to a single page.
774
+ */
775
+ async fetchPage(pageNumber, numInitialPages = 1) {
776
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
777
+ const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
778
+ if (!this.canPerformSearch)
779
+ return;
780
+ // if we already have data, don't fetch again
781
+ if (this.hasPage(pageNumber))
782
+ return;
783
+ if (this.endOfDataReached)
784
+ return;
785
+ // Batch multiple initial page requests together if needed (e.g., can request
786
+ // pages 1 and 2 together in a single request).
787
+ let numPages = pageNumber === 1 ? numInitialPages : 1;
788
+ const numRows = this.pageSize * numPages;
789
+ // if a fetch is already in progress for this query and page, don't fetch again
790
+ const { pageFetchQueryKey } = this;
791
+ const currentPageKey = `${pageFetchQueryKey}-p:${pageNumber}`;
792
+ if (this.fetchesInProgress.has(currentPageKey))
793
+ return;
794
+ for (let i = 0; i < numPages; i += 1) {
795
+ this.fetchesInProgress.add(`${pageFetchQueryKey}-p:${pageNumber + i}`);
796
+ }
797
+ this.previousQueryKey = pageFetchQueryKey;
798
+ let sortParams = this.host.sortParam ? [this.host.sortParam] : [];
799
+ // TODO eventually the PPS should handle these defaults natively
800
+ const isDefaultProfileSort = this.host.withinProfile && this.host.selectedSort === SortField.default;
801
+ if (isDefaultProfileSort && this.host.defaultSortParam) {
802
+ const sortOption = SORT_OPTIONS[this.host.defaultSortParam.field];
803
+ if (sortOption.searchServiceKey) {
804
+ sortParams = [
805
+ {
806
+ field: sortOption.searchServiceKey,
807
+ direction: 'desc',
808
+ },
809
+ ];
810
+ }
811
+ }
812
+ const params = {
813
+ ...this.pageSpecifierParams,
814
+ query: trimmedQuery || '',
815
+ page: pageNumber,
816
+ rows: numRows,
817
+ sort: sortParams,
818
+ filters: this.filterMap,
819
+ aggregations: { omit: true },
820
+ };
821
+ params.uid = await this.requestUID(params, 'hits');
822
+ log('=== FIRING PAGE REQUEST ===', params);
823
+ const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
824
+ log('=== RECEIVED PAGE RESPONSE IN CB ===', searchResponse);
825
+ const success = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success;
826
+ // This is checking to see if the fetch has been invalidated since it was fired off.
827
+ // If so, we just want to discard the response since it is for an obsolete query state.
828
+ if (!this.fetchesInProgress.has(currentPageKey))
829
+ return;
830
+ for (let i = 0; i < numPages; i += 1) {
831
+ this.fetchesInProgress.delete(`${pageFetchQueryKey}-p:${pageNumber + i}`);
832
+ }
833
+ if (!success) {
834
+ const errorMsg = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _c === void 0 ? void 0 : _c.message;
835
+ const detailMsg = (_e = (_d = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _d === void 0 ? void 0 : _d.details) === null || _e === void 0 ? void 0 : _e.message;
836
+ this.queryErrorMessage = `${errorMsg !== null && errorMsg !== void 0 ? errorMsg : ''}${detailMsg ? `; ${detailMsg}` : ''}`;
837
+ if (!this.queryErrorMessage) {
838
+ this.queryErrorMessage = 'Missing or malformed response from backend';
839
+ // @ts-ignore: Property 'Sentry' does not exist on type 'Window & typeof globalThis'
840
+ (_g = (_f = window === null || window === void 0 ? void 0 : window.Sentry) === null || _f === void 0 ? void 0 : _f.captureMessage) === null || _g === void 0 ? void 0 : _g.call(_f, this.queryErrorMessage, 'error');
841
+ }
842
+ this.setSearchResultsLoading(false);
843
+ this.requestHostUpdate();
844
+ return;
845
+ }
846
+ this.setTotalResultCount(success.response.totalResults - this.offset);
847
+ if (this.activeOnHost && this.totalResults === 0) {
848
+ // display event to offshoot when result count is zero.
849
+ this.host.emitEmptyResults();
850
+ }
851
+ this.sessionContext = success.sessionContext;
852
+ if (this.host.withinCollection) {
853
+ this.collectionExtraInfo = success.response.collectionExtraInfo;
854
+ // For collections, we want the UI to respect the default sort option
855
+ // which can be specified in metadata, or otherwise assumed to be week:desc
856
+ if (this.activeOnHost) {
857
+ this.host.applyDefaultCollectionSort(this.collectionExtraInfo);
858
+ }
859
+ if (this.collectionExtraInfo) {
860
+ this.parentCollections = [].concat((_j = (_h = this.collectionExtraInfo.public_metadata) === null || _h === void 0 ? void 0 : _h.collection) !== null && _j !== void 0 ? _j : []);
861
+ }
862
+ }
863
+ else if (this.host.withinProfile) {
864
+ this.accountExtraInfo = success.response.accountExtraInfo;
865
+ this.pageElements = success.response.pageElements;
866
+ }
867
+ const { results, collectionTitles } = success.response;
868
+ if (results && results.length > 0) {
869
+ // Load any collection titles present on the response into the cache,
870
+ // or queue up preload fetches for them if none were present.
871
+ if (collectionTitles) {
872
+ for (const [id, title] of Object.entries(collectionTitles)) {
873
+ this.collectionTitles.set(id, title);
874
+ }
875
+ }
876
+ // Update the data source for each returned page.
877
+ // For loans and web archives, we must account for receiving more pages than we asked for.
878
+ if (this.host.profileElement === 'lending' ||
879
+ this.host.profileElement === 'web_archives') {
880
+ numPages = Math.ceil(results.length / this.pageSize);
881
+ this.endOfDataReached = true;
882
+ if (this.activeOnHost)
883
+ this.host.setTileCount(this.totalResults);
884
+ }
885
+ for (let i = 0; i < numPages; i += 1) {
886
+ const pageStartIndex = this.pageSize * i;
887
+ this.addFetchedResultsToDataSource(pageNumber + i, results.slice(pageStartIndex, pageStartIndex + this.pageSize));
888
+ }
889
+ }
890
+ // When we reach the end of the data, we can set the infinite scroller's
891
+ // item count to the real total number of results (rather than the
892
+ // temporary estimates based on pages rendered so far).
893
+ if (this.size >= this.totalResults || results.length === 0) {
894
+ this.endOfDataReached = true;
895
+ if (this.activeOnHost)
896
+ this.host.setTileCount(this.size);
897
+ }
898
+ this.setSearchResultsLoading(false);
899
+ this.requestHostUpdate();
900
+ }
901
+ /**
902
+ * Update the datasource from the fetch response
903
+ *
904
+ * @param pageNumber
905
+ * @param results
906
+ */
907
+ addFetchedResultsToDataSource(pageNumber, results) {
908
+ const tiles = [];
909
+ results === null || results === void 0 ? void 0 : results.forEach(result => {
910
+ if (!result.identifier)
911
+ return;
912
+ tiles.push(new TileModel(result));
913
+ });
914
+ this.addPage(pageNumber, tiles);
915
+ const visiblePages = this.host.currentVisiblePageNumbers;
916
+ const needsReload = visiblePages.includes(pageNumber);
917
+ if (needsReload) {
918
+ this.refreshVisibleResults();
919
+ }
920
+ }
921
+ /**
922
+ * Fetches the aggregation buckets for the given prefix filter type.
923
+ */
924
+ async fetchPrefixFilterBuckets(filterType) {
925
+ var _a, _b, _c, _d, _e, _f, _g;
926
+ const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
927
+ if (!this.canPerformSearch)
928
+ return [];
929
+ const filterAggregationKey = prefixFilterAggregationKeys[filterType];
930
+ const sortParams = this.host.sortParam ? [this.host.sortParam] : [];
931
+ const params = {
932
+ ...this.pageSpecifierParams,
933
+ query: trimmedQuery || '',
934
+ rows: 0,
935
+ filters: this.filterMap,
936
+ // Only fetch the firstTitle or firstCreator aggregation
937
+ aggregations: { simpleParams: [filterAggregationKey] },
938
+ // Fetch all 26 letter buckets
939
+ aggregationsSize: 26,
940
+ };
941
+ params.uid = await this.requestUID({ ...params, sort: sortParams }, 'aggregations');
942
+ const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
943
+ return ((_g = (_f = (_e = (_d = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success) === null || _c === void 0 ? void 0 : _c.response) === null || _d === void 0 ? void 0 : _d.aggregations) === null || _e === void 0 ? void 0 : _e[filterAggregationKey]) === null || _f === void 0 ? void 0 : _f.buckets) !== null && _g !== void 0 ? _g : []);
944
+ }
945
+ /**
946
+ * Fetches and caches the prefix filter counts for the given filter type.
947
+ */
948
+ async updatePrefixFilterCounts(filterType) {
949
+ const { facetFetchQueryKey } = this;
950
+ const buckets = await this.fetchPrefixFilterBuckets(filterType);
951
+ // Don't update the filter counts for an outdated query (if it has been changed
952
+ // since we sent the request)
953
+ const queryChangedSinceFetch = facetFetchQueryKey !== this.facetFetchQueryKey;
954
+ if (queryChangedSinceFetch)
955
+ return;
956
+ // Unpack the aggregation buckets into a simple map like { 'A': 50, 'B': 25, ... }
957
+ this.prefixFilterCountMap = { ...this.prefixFilterCountMap }; // Clone the object to trigger an update
958
+ this.prefixFilterCountMap[filterType] = buckets.reduce((acc, bucket) => {
959
+ acc[bucket.key.toUpperCase()] = bucket.doc_count;
960
+ return acc;
961
+ }, {});
962
+ this.requestHostUpdate();
963
+ }
964
+ /**
965
+ * @inheritdoc
966
+ */
967
+ async updatePrefixFiltersForCurrentSort() {
968
+ if (['title', 'creator'].includes(this.host.selectedSort)) {
969
+ const filterType = this.host.selectedSort;
970
+ if (!this.prefixFilterCountMap[filterType]) {
971
+ this.updatePrefixFilterCounts(filterType);
972
+ }
973
+ }
974
+ }
975
+ /**
976
+ * @inheritdoc
977
+ */
978
+ refreshLetterCounts() {
979
+ if (Object.keys(this.prefixFilterCountMap).length > 0) {
980
+ this.prefixFilterCountMap = {};
981
+ }
982
+ this.updatePrefixFiltersForCurrentSort();
983
+ this.requestHostUpdate();
984
+ }
985
+ }
986
986
  //# sourceMappingURL=collection-browser-data-source.js.map