@internetarchive/collection-browser 2.7.5-alpha.3 → 2.7.5-alpha1

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