@internetarchive/collection-browser 2.7.7-alpha.2 → 2.7.7

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