@internetarchive/collection-browser 2.7.12 → 2.7.13

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 (318) hide show
  1. package/.editorconfig +29 -29
  2. package/.husky/pre-commit +4 -4
  3. package/LICENSE +661 -661
  4. package/README.md +83 -83
  5. package/dist/index.d.ts +13 -13
  6. package/dist/index.js +13 -13
  7. package/dist/src/app-root.d.ts +107 -107
  8. package/dist/src/app-root.js +531 -531
  9. package/dist/src/assets/img/icons/arrow-left.d.ts +2 -2
  10. package/dist/src/assets/img/icons/arrow-left.js +2 -2
  11. package/dist/src/assets/img/icons/arrow-right.d.ts +2 -2
  12. package/dist/src/assets/img/icons/arrow-right.js +2 -2
  13. package/dist/src/assets/img/icons/chevron.d.ts +2 -2
  14. package/dist/src/assets/img/icons/chevron.js +2 -2
  15. package/dist/src/assets/img/icons/contract.d.ts +2 -2
  16. package/dist/src/assets/img/icons/contract.js +2 -2
  17. package/dist/src/assets/img/icons/empty-query.d.ts +2 -2
  18. package/dist/src/assets/img/icons/empty-query.js +2 -2
  19. package/dist/src/assets/img/icons/expand.d.ts +2 -2
  20. package/dist/src/assets/img/icons/expand.js +2 -2
  21. package/dist/src/assets/img/icons/eye-closed.d.ts +2 -2
  22. package/dist/src/assets/img/icons/eye-closed.js +2 -2
  23. package/dist/src/assets/img/icons/eye.d.ts +2 -2
  24. package/dist/src/assets/img/icons/eye.js +2 -2
  25. package/dist/src/assets/img/icons/favorite-filled.d.ts +1 -1
  26. package/dist/src/assets/img/icons/favorite-filled.js +2 -2
  27. package/dist/src/assets/img/icons/favorite-unfilled.d.ts +1 -1
  28. package/dist/src/assets/img/icons/favorite-unfilled.js +2 -2
  29. package/dist/src/assets/img/icons/filter.d.ts +2 -2
  30. package/dist/src/assets/img/icons/filter.js +2 -2
  31. package/dist/src/assets/img/icons/login-required.d.ts +1 -1
  32. package/dist/src/assets/img/icons/login-required.js +2 -2
  33. package/dist/src/assets/img/icons/mediatype/account.d.ts +1 -1
  34. package/dist/src/assets/img/icons/mediatype/account.js +2 -2
  35. package/dist/src/assets/img/icons/mediatype/audio.d.ts +1 -1
  36. package/dist/src/assets/img/icons/mediatype/audio.js +2 -2
  37. package/dist/src/assets/img/icons/mediatype/collection.d.ts +1 -1
  38. package/dist/src/assets/img/icons/mediatype/collection.js +2 -2
  39. package/dist/src/assets/img/icons/mediatype/data.d.ts +1 -1
  40. package/dist/src/assets/img/icons/mediatype/data.js +2 -2
  41. package/dist/src/assets/img/icons/mediatype/etree.d.ts +1 -1
  42. package/dist/src/assets/img/icons/mediatype/etree.js +2 -2
  43. package/dist/src/assets/img/icons/mediatype/film.d.ts +1 -1
  44. package/dist/src/assets/img/icons/mediatype/film.js +2 -2
  45. package/dist/src/assets/img/icons/mediatype/images.d.ts +1 -1
  46. package/dist/src/assets/img/icons/mediatype/images.js +2 -2
  47. package/dist/src/assets/img/icons/mediatype/radio.d.ts +1 -1
  48. package/dist/src/assets/img/icons/mediatype/radio.js +2 -2
  49. package/dist/src/assets/img/icons/mediatype/search.d.ts +1 -1
  50. package/dist/src/assets/img/icons/mediatype/search.js +2 -2
  51. package/dist/src/assets/img/icons/mediatype/software.d.ts +1 -1
  52. package/dist/src/assets/img/icons/mediatype/software.js +2 -2
  53. package/dist/src/assets/img/icons/mediatype/texts.d.ts +1 -1
  54. package/dist/src/assets/img/icons/mediatype/texts.js +2 -2
  55. package/dist/src/assets/img/icons/mediatype/tv.d.ts +1 -1
  56. package/dist/src/assets/img/icons/mediatype/tv.js +2 -2
  57. package/dist/src/assets/img/icons/mediatype/video.d.ts +1 -1
  58. package/dist/src/assets/img/icons/mediatype/video.js +2 -2
  59. package/dist/src/assets/img/icons/mediatype/web.d.ts +1 -1
  60. package/dist/src/assets/img/icons/mediatype/web.js +2 -2
  61. package/dist/src/assets/img/icons/null-result.d.ts +2 -2
  62. package/dist/src/assets/img/icons/null-result.js +2 -2
  63. package/dist/src/assets/img/icons/restricted.d.ts +1 -1
  64. package/dist/src/assets/img/icons/restricted.js +2 -2
  65. package/dist/src/assets/img/icons/reviews.d.ts +1 -1
  66. package/dist/src/assets/img/icons/reviews.js +2 -2
  67. package/dist/src/assets/img/icons/upload.d.ts +1 -1
  68. package/dist/src/assets/img/icons/upload.js +2 -2
  69. package/dist/src/assets/img/icons/views.d.ts +1 -1
  70. package/dist/src/assets/img/icons/views.js +2 -2
  71. package/dist/src/circular-activity-indicator.d.ts +5 -5
  72. package/dist/src/circular-activity-indicator.js +17 -17
  73. package/dist/src/collection-browser.d.ts +606 -606
  74. package/dist/src/collection-browser.js +1677 -1677
  75. package/dist/src/collection-facets/facet-row.d.ts +30 -30
  76. package/dist/src/collection-facets/facet-row.js +118 -118
  77. package/dist/src/collection-facets/facet-tombstone-row.d.ts +5 -5
  78. package/dist/src/collection-facets/facet-tombstone-row.js +15 -15
  79. package/dist/src/collection-facets/facets-template.d.ts +13 -13
  80. package/dist/src/collection-facets/facets-template.js +44 -44
  81. package/dist/src/collection-facets/more-facets-content.d.ts +106 -106
  82. package/dist/src/collection-facets/more-facets-content.js +407 -407
  83. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  84. package/dist/src/collection-facets/more-facets-pagination.js +196 -196
  85. package/dist/src/collection-facets/smart-facets/dedupe.d.ts +10 -10
  86. package/dist/src/collection-facets/smart-facets/dedupe.js +33 -33
  87. package/dist/src/collection-facets/smart-facets/heuristics/browser-language-heuristic.d.ts +5 -5
  88. package/dist/src/collection-facets/smart-facets/heuristics/browser-language-heuristic.js +23 -23
  89. package/dist/src/collection-facets/smart-facets/heuristics/query-keywords-heuristic.d.ts +5 -5
  90. package/dist/src/collection-facets/smart-facets/heuristics/query-keywords-heuristic.js +44 -44
  91. package/dist/src/collection-facets/smart-facets/heuristics/wikidata-heuristic.d.ts +5 -5
  92. package/dist/src/collection-facets/smart-facets/heuristics/wikidata-heuristic.js +172 -172
  93. package/dist/src/collection-facets/smart-facets/models.d.ts +26 -26
  94. package/dist/src/collection-facets/smart-facets/models.js +1 -1
  95. package/dist/src/collection-facets/smart-facets/smart-facet-bar.d.ts +31 -31
  96. package/dist/src/collection-facets/smart-facets/smart-facet-bar.js +240 -240
  97. package/dist/src/collection-facets/smart-facets/smart-facet-button.d.ts +11 -11
  98. package/dist/src/collection-facets/smart-facets/smart-facet-button.js +86 -86
  99. package/dist/src/collection-facets/smart-facets/smart-facet-dropdown.d.ts +16 -16
  100. package/dist/src/collection-facets/smart-facets/smart-facet-dropdown.js +100 -100
  101. package/dist/src/collection-facets/smart-facets/smart-facet-equals.d.ts +2 -2
  102. package/dist/src/collection-facets/smart-facets/smart-facet-equals.js +12 -12
  103. package/dist/src/collection-facets/smart-facets/smart-facet-heuristics.d.ts +5 -5
  104. package/dist/src/collection-facets/smart-facets/smart-facet-heuristics.js +15 -15
  105. package/dist/src/collection-facets/toggle-switch.d.ts +41 -41
  106. package/dist/src/collection-facets/toggle-switch.js +94 -94
  107. package/dist/src/collection-facets.d.ts +103 -103
  108. package/dist/src/collection-facets.js +522 -522
  109. package/dist/src/data-source/collection-browser-data-source-interface.d.ts +245 -245
  110. package/dist/src/data-source/collection-browser-data-source-interface.js +1 -1
  111. package/dist/src/data-source/collection-browser-data-source.d.ts +377 -377
  112. package/dist/src/data-source/collection-browser-data-source.js +1004 -1001
  113. package/dist/src/data-source/collection-browser-data-source.js.map +1 -1
  114. package/dist/src/data-source/collection-browser-query-state.d.ts +44 -44
  115. package/dist/src/data-source/collection-browser-query-state.js +1 -1
  116. package/dist/src/data-source/models.d.ts +28 -28
  117. package/dist/src/data-source/models.js +8 -8
  118. package/dist/src/empty-placeholder.d.ts +23 -23
  119. package/dist/src/empty-placeholder.js +79 -79
  120. package/dist/src/expanded-date-picker.d.ts +43 -43
  121. package/dist/src/expanded-date-picker.js +109 -109
  122. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  123. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  124. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  125. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  126. package/dist/src/manage/manage-bar.d.ts +58 -58
  127. package/dist/src/manage/manage-bar.js +159 -159
  128. package/dist/src/manage/remove-items-modal-content.d.ts +9 -9
  129. package/dist/src/manage/remove-items-modal-content.js +34 -34
  130. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  131. package/dist/src/mediatype/mediatype-config.js +91 -91
  132. package/dist/src/models.d.ts +228 -228
  133. package/dist/src/models.js +401 -401
  134. package/dist/src/restoration-state-handler.d.ts +70 -70
  135. package/dist/src/restoration-state-handler.js +363 -363
  136. package/dist/src/sort-filter-bar/alpha-bar-tooltip.d.ts +6 -6
  137. package/dist/src/sort-filter-bar/alpha-bar-tooltip.js +24 -24
  138. package/dist/src/sort-filter-bar/alpha-bar.d.ts +21 -21
  139. package/dist/src/sort-filter-bar/alpha-bar.js +128 -128
  140. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  141. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  142. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  143. package/dist/src/sort-filter-bar/img/list.js +2 -2
  144. package/dist/src/sort-filter-bar/img/sort-toggle-disabled.d.ts +1 -1
  145. package/dist/src/sort-filter-bar/img/sort-toggle-disabled.js +2 -2
  146. package/dist/src/sort-filter-bar/img/sort-toggle-down.d.ts +1 -1
  147. package/dist/src/sort-filter-bar/img/sort-toggle-down.js +2 -2
  148. package/dist/src/sort-filter-bar/img/sort-toggle-up.d.ts +1 -1
  149. package/dist/src/sort-filter-bar/img/sort-toggle-up.js +2 -2
  150. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  151. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  152. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  153. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  154. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +223 -223
  155. package/dist/src/sort-filter-bar/sort-filter-bar.js +697 -697
  156. package/dist/src/styles/ia-button.d.ts +2 -2
  157. package/dist/src/styles/ia-button.js +17 -17
  158. package/dist/src/styles/item-image-styles.d.ts +8 -8
  159. package/dist/src/styles/item-image-styles.js +9 -9
  160. package/dist/src/styles/sr-only.d.ts +1 -1
  161. package/dist/src/styles/sr-only.js +2 -2
  162. package/dist/src/tiles/base-tile-component.d.ts +19 -19
  163. package/dist/src/tiles/base-tile-component.js +64 -64
  164. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  165. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  166. package/dist/src/tiles/grid/account-tile.d.ts +18 -18
  167. package/dist/src/tiles/grid/account-tile.js +72 -72
  168. package/dist/src/tiles/grid/collection-tile.d.ts +15 -15
  169. package/dist/src/tiles/grid/collection-tile.js +80 -80
  170. package/dist/src/tiles/grid/item-tile.d.ts +34 -34
  171. package/dist/src/tiles/grid/item-tile.js +158 -158
  172. package/dist/src/tiles/grid/search-tile.d.ts +10 -10
  173. package/dist/src/tiles/grid/search-tile.js +51 -51
  174. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.d.ts +1 -1
  175. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.js +8 -8
  176. package/dist/src/tiles/grid/tile-stats.d.ts +11 -11
  177. package/dist/src/tiles/grid/tile-stats.js +53 -53
  178. package/dist/src/tiles/hover/hover-pane-controller.d.ts +219 -219
  179. package/dist/src/tiles/hover/hover-pane-controller.js +352 -352
  180. package/dist/src/tiles/hover/tile-hover-pane.d.ts +18 -18
  181. package/dist/src/tiles/hover/tile-hover-pane.js +69 -69
  182. package/dist/src/tiles/image-block.d.ts +18 -18
  183. package/dist/src/tiles/image-block.js +89 -89
  184. package/dist/src/tiles/item-image.d.ts +39 -39
  185. package/dist/src/tiles/item-image.js +154 -154
  186. package/dist/src/tiles/list/tile-list-compact-header.d.ts +6 -6
  187. package/dist/src/tiles/list/tile-list-compact-header.js +38 -38
  188. package/dist/src/tiles/list/tile-list-compact.d.ts +19 -19
  189. package/dist/src/tiles/list/tile-list-compact.js +122 -122
  190. package/dist/src/tiles/list/tile-list.d.ts +54 -54
  191. package/dist/src/tiles/list/tile-list.js +323 -323
  192. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  193. package/dist/src/tiles/mediatype-icon.js +47 -47
  194. package/dist/src/tiles/overlay/icon-overlay.d.ts +8 -8
  195. package/dist/src/tiles/overlay/icon-overlay.js +25 -25
  196. package/dist/src/tiles/overlay/text-overlay.d.ts +9 -9
  197. package/dist/src/tiles/overlay/text-overlay.js +31 -31
  198. package/dist/src/tiles/review-block.d.ts +12 -12
  199. package/dist/src/tiles/review-block.js +56 -56
  200. package/dist/src/tiles/text-snippet-block.d.ts +27 -27
  201. package/dist/src/tiles/text-snippet-block.js +73 -73
  202. package/dist/src/tiles/tile-dispatcher.d.ts +64 -64
  203. package/dist/src/tiles/tile-dispatcher.js +230 -230
  204. package/dist/src/tiles/tile-display-value-provider.d.ts +47 -47
  205. package/dist/src/tiles/tile-display-value-provider.js +94 -94
  206. package/dist/src/utils/analytics-events.d.ts +28 -28
  207. package/dist/src/utils/analytics-events.js +30 -30
  208. package/dist/src/utils/array-equals.d.ts +4 -4
  209. package/dist/src/utils/array-equals.js +10 -10
  210. package/dist/src/utils/collapse-repeated-quotes.d.ts +11 -11
  211. package/dist/src/utils/collapse-repeated-quotes.js +13 -13
  212. package/dist/src/utils/facet-utils.d.ts +83 -83
  213. package/dist/src/utils/facet-utils.js +145 -145
  214. package/dist/src/utils/format-count.d.ts +7 -7
  215. package/dist/src/utils/format-count.js +76 -76
  216. package/dist/src/utils/format-date.d.ts +2 -2
  217. package/dist/src/utils/format-date.js +27 -27
  218. package/dist/src/utils/format-unit-size.d.ts +2 -2
  219. package/dist/src/utils/format-unit-size.js +33 -33
  220. package/dist/src/utils/local-date-from-utc.d.ts +9 -9
  221. package/dist/src/utils/local-date-from-utc.js +15 -15
  222. package/dist/src/utils/log.d.ts +7 -7
  223. package/dist/src/utils/log.js +15 -15
  224. package/dist/src/utils/resolve-mediatype.d.ts +8 -8
  225. package/dist/src/utils/resolve-mediatype.js +23 -23
  226. package/dist/src/utils/sha1.d.ts +2 -2
  227. package/dist/src/utils/sha1.js +8 -8
  228. package/dist/test/collection-browser.test.d.ts +1 -1
  229. package/dist/test/collection-browser.test.js +1308 -1308
  230. package/dist/test/collection-facets/facet-row.test.d.ts +1 -1
  231. package/dist/test/collection-facets/facet-row.test.js +227 -227
  232. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  233. package/dist/test/collection-facets/facets-template.test.js +91 -91
  234. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  235. package/dist/test/collection-facets/more-facets-content.test.js +141 -141
  236. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  237. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  238. package/dist/test/collection-facets/toggle-switch.test.d.ts +1 -1
  239. package/dist/test/collection-facets/toggle-switch.test.js +73 -73
  240. package/dist/test/collection-facets.test.d.ts +2 -2
  241. package/dist/test/collection-facets.test.js +690 -690
  242. package/dist/test/data-source/collection-browser-data-source.test.d.ts +1 -1
  243. package/dist/test/data-source/collection-browser-data-source.test.js +89 -89
  244. package/dist/test/empty-placeholder.test.d.ts +1 -1
  245. package/dist/test/empty-placeholder.test.js +63 -63
  246. package/dist/test/expanded-date-picker.test.d.ts +1 -1
  247. package/dist/test/expanded-date-picker.test.js +95 -95
  248. package/dist/test/icon-overlay.test.d.ts +1 -1
  249. package/dist/test/icon-overlay.test.js +24 -24
  250. package/dist/test/image-block.test.d.ts +1 -1
  251. package/dist/test/image-block.test.js +107 -107
  252. package/dist/test/item-image.test.d.ts +1 -1
  253. package/dist/test/item-image.test.js +85 -85
  254. package/dist/test/manage/manage-bar.test.d.ts +2 -2
  255. package/dist/test/manage/manage-bar.test.js +100 -100
  256. package/dist/test/manage/remove-items-modal-content.test.d.ts +1 -1
  257. package/dist/test/manage/remove-items-modal-content.test.js +45 -45
  258. package/dist/test/mediatype-config.test.d.ts +1 -1
  259. package/dist/test/mediatype-config.test.js +16 -16
  260. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  261. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  262. package/dist/test/mocks/mock-search-responses.d.ts +25 -25
  263. package/dist/test/mocks/mock-search-responses.js +942 -942
  264. package/dist/test/mocks/mock-search-service.d.ts +15 -15
  265. package/dist/test/mocks/mock-search-service.js +54 -54
  266. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  267. package/dist/test/restoration-state-handler.test.js +270 -270
  268. package/dist/test/review-block.test.d.ts +1 -1
  269. package/dist/test/review-block.test.js +44 -44
  270. package/dist/test/sort-filter-bar/alpha-bar-tooltip.test.d.ts +1 -1
  271. package/dist/test/sort-filter-bar/alpha-bar-tooltip.test.js +12 -12
  272. package/dist/test/sort-filter-bar/alpha-bar.test.d.ts +1 -1
  273. package/dist/test/sort-filter-bar/alpha-bar.test.js +73 -73
  274. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  275. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +426 -426
  276. package/dist/test/text-overlay.test.d.ts +1 -1
  277. package/dist/test/text-overlay.test.js +38 -38
  278. package/dist/test/text-snippet-block.test.d.ts +1 -1
  279. package/dist/test/text-snippet-block.test.js +57 -57
  280. package/dist/test/tile-stats.test.d.ts +1 -1
  281. package/dist/test/tile-stats.test.js +81 -81
  282. package/dist/test/tiles/grid/account-tile.test.d.ts +1 -1
  283. package/dist/test/tiles/grid/account-tile.test.js +76 -76
  284. package/dist/test/tiles/grid/collection-tile.test.d.ts +1 -1
  285. package/dist/test/tiles/grid/collection-tile.test.js +73 -73
  286. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  287. package/dist/test/tiles/grid/item-tile.test.js +312 -312
  288. package/dist/test/tiles/grid/search-tile.test.d.ts +1 -1
  289. package/dist/test/tiles/grid/search-tile.test.js +51 -51
  290. package/dist/test/tiles/hover/hover-pane-controller.test.d.ts +1 -1
  291. package/dist/test/tiles/hover/hover-pane-controller.test.js +259 -259
  292. package/dist/test/tiles/hover/tile-hover-pane.test.d.ts +1 -1
  293. package/dist/test/tiles/hover/tile-hover-pane.test.js +56 -56
  294. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  295. package/dist/test/tiles/list/tile-list-compact.test.js +143 -143
  296. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  297. package/dist/test/tiles/list/tile-list.test.js +297 -297
  298. package/dist/test/tiles/tile-dispatcher.test.d.ts +1 -1
  299. package/dist/test/tiles/tile-dispatcher.test.js +100 -100
  300. package/dist/test/tiles/tile-display-value-provider.test.d.ts +1 -1
  301. package/dist/test/tiles/tile-display-value-provider.test.js +141 -141
  302. package/dist/test/utils/array-equals.test.d.ts +1 -1
  303. package/dist/test/utils/array-equals.test.js +26 -26
  304. package/dist/test/utils/format-count.test.d.ts +1 -1
  305. package/dist/test/utils/format-count.test.js +23 -23
  306. package/dist/test/utils/format-date.test.d.ts +1 -1
  307. package/dist/test/utils/format-date.test.js +30 -30
  308. package/dist/test/utils/format-unit-size.test.d.ts +1 -1
  309. package/dist/test/utils/format-unit-size.test.js +17 -17
  310. package/dist/test/utils/local-date-from-utc.test.d.ts +1 -1
  311. package/dist/test/utils/local-date-from-utc.test.js +26 -26
  312. package/local.archive.org.cert +86 -86
  313. package/local.archive.org.key +27 -27
  314. package/package.json +1 -1
  315. package/renovate.json +6 -6
  316. package/src/data-source/collection-browser-data-source.ts +5 -1
  317. package/web-dev-server.config.mjs +30 -30
  318. package/web-test-runner.config.mjs +41 -41
@@ -1,606 +1,606 @@
1
- import { LitElement, PropertyValues, TemplateResult } from 'lit';
2
- import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
3
- import type { InfiniteScrollerCellProviderInterface } from '@internetarchive/infinite-scroller';
4
- import { CollectionExtraInfo, PageElementName, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
5
- import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
6
- import '@internetarchive/infinite-scroller';
7
- import type { ModalManagerInterface } from '@internetarchive/modal-manager';
8
- import type { FeatureFeedbackServiceInterface } from '@internetarchive/feature-feedback';
9
- import type { RecaptchaManagerInterface } from '@internetarchive/recaptcha-manager';
10
- import { SelectedFacets, SortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails, FacetLoadStrategy } from './models';
11
- import { RestorationStateHandlerInterface } from './restoration-state-handler';
12
- import type { CollectionBrowserQueryState, CollectionBrowserSearchInterface } from './data-source/collection-browser-query-state';
13
- import type { CollectionBrowserDataSourceInterface } from './data-source/collection-browser-data-source-interface';
14
- import './empty-placeholder';
15
- import './tiles/tile-dispatcher';
16
- import './tiles/collection-browser-loading-tile';
17
- import './sort-filter-bar/sort-filter-bar';
18
- import './manage/manage-bar';
19
- import './collection-facets';
20
- import './circular-activity-indicator';
21
- import './collection-facets/smart-facets/smart-facet-bar';
22
- export declare class CollectionBrowser extends LitElement implements InfiniteScrollerCellProviderInterface, SharedResizeObserverResizeHandlerInterface, CollectionBrowserSearchInterface {
23
- baseNavigationUrl?: string;
24
- baseImageUrl: string;
25
- searchService?: SearchServiceInterface;
26
- /**
27
- * Which backend should be targeted by searches (e.g., metadata or FTS)
28
- */
29
- searchType: SearchType;
30
- /**
31
- * The identifier of the collection that searches should be performed within
32
- */
33
- withinCollection?: string;
34
- /**
35
- * The identifier (e.g., @person) of the user whose profile is being searched within
36
- */
37
- withinProfile?: string;
38
- /**
39
- * Which section of the profile page searches are for (e.g., uploads, reviews, ...)
40
- */
41
- profileElement?: PageElementName;
42
- /**
43
- * The base query to use for all searches, updated to match the current user query.
44
- */
45
- baseQuery?: string;
46
- /**
47
- * Which mode to display result tiles in (grid, extended list, or compact list)
48
- */
49
- displayMode?: CollectionDisplayMode;
50
- selectedSort: SortField;
51
- selectedTitleFilter: string | null;
52
- selectedCreatorFilter: string | null;
53
- sortDirection: SortDirection | null;
54
- defaultSortField: Exclude<SortField, SortField.default>;
55
- defaultSortDirection: SortDirection | null;
56
- pageSize: number;
57
- currentPage?: number;
58
- minSelectedDate?: string;
59
- maxSelectedDate?: string;
60
- selectedFacets?: SelectedFacets;
61
- showSmartFacetBar: boolean;
62
- /**
63
- * Whether to show the date picker (above the facets)
64
- */
65
- showHistogramDatePicker: boolean;
66
- /**
67
- * Whether placeholder views should be suppressed. If true, searches that produce an
68
- * error or empty result set will simply show a blank results view instead of a placeholder.
69
- */
70
- suppressPlaceholders: boolean;
71
- /**
72
- * Whether the result count text should be suppressed.
73
- * If true, no "X Results" message will be shown.
74
- */
75
- suppressResultCount: boolean;
76
- /**
77
- * Whether the scrolling result view should be suppressed entirely.
78
- * If true, no infinite scroller (and thus no result tiles) will be rendered.
79
- */
80
- suppressResultTiles: boolean;
81
- /**
82
- * Whether to suppress persistence of the query to the URL.
83
- * If true, the `query` param will not be added to the URL or updated on query changes.
84
- */
85
- suppressURLQuery: boolean;
86
- /**
87
- * Whether to suppress display of the sort bar.
88
- * If true, the entire sort bar (incl. display modes) will be omitted from rendering.
89
- */
90
- suppressSortBar: boolean;
91
- /**
92
- * Whether to suppress showing the display mode options in the sort bar.
93
- * If true, those options will be omitted (though the rest of the sort bar may still render).
94
- */
95
- suppressDisplayModes: boolean;
96
- /**
97
- * What strategy to use for when/whether to load facet data for a search.
98
- *
99
- * Defaults to `eager`, always loading facets immediately alongside search results.
100
- *
101
- * To eliminate facets that are never seen, this can be reduced to `lazy-mobile`, which
102
- * will delay loading facets in the mobile view until the "Filters" accordion is opened.
103
- * Facets are still loaded eagerly when viewing the desktop layout.
104
- *
105
- * To further reduce facet requests for patrons who do not need to use them, this can be
106
- * again reduced to `opt-in`, which will also require desktop users to explicitly request
107
- * that they be loaded (in addition to the lazy mobile behavior described above).
108
- *
109
- * To entirely suppress facets from being loaded, this may be set to `off`.
110
- */
111
- facetLoadStrategy: FacetLoadStrategy;
112
- facetPaneVisible: boolean;
113
- clearResultsOnEmptyQuery: boolean;
114
- collectionPagePath: string;
115
- /** describes where this component is being used */
116
- searchContext: string;
117
- pageContext: CollectionBrowserContext;
118
- restorationStateHandler: RestorationStateHandlerInterface;
119
- mobileBreakpoint: number;
120
- loggedIn: boolean;
121
- resizeObserver?: SharedResizeObserverInterface;
122
- modalManager?: ModalManagerInterface;
123
- featureFeedbackService?: FeatureFeedbackServiceInterface;
124
- recaptchaManager?: RecaptchaManagerInterface;
125
- /**
126
- * If item management UI active
127
- */
128
- isManageView: boolean;
129
- manageViewLabel: string;
130
- /** Whether to replace the default sort options with a slot for customization (default: false) */
131
- enableSortOptionsSlot: boolean;
132
- /** Whether to display a smart results carousel above the full results */
133
- showSmartResults: boolean;
134
- /**
135
- * The maximum number of pages we will load when a privileged user clicks
136
- * the "Manage" button on the search page. Limited to 15 pages.
137
- */
138
- maxPagesToManage: number;
139
- /**
140
- * The results per page so we can paginate.
141
- *
142
- * This allows us to start in the middle of the search results and
143
- * fetch data before or after the current page. If we don't have a key
144
- * for the previous/next page, we'll fetch the next/previous page to populate it
145
- */
146
- dataSource: CollectionBrowserDataSourceInterface;
147
- /**
148
- * The page that the consumer wants to load.
149
- */
150
- initialPageNumber: number;
151
- /**
152
- * This the the number of pages that we want to show.
153
- *
154
- * The data isn't necessarily loaded for all of the pages, but this lets us
155
- * know how many cells we should render.
156
- */
157
- private pagesToRender;
158
- /**
159
- * Whether the initial page fetch for a new query is currently in progress.
160
- */
161
- private searchResultsLoading;
162
- private facetsLoading;
163
- private totalResults?;
164
- private mobileView;
165
- private collapsibleFacetsVisible;
166
- private contentWidth?;
167
- private placeholderType;
168
- private contentContainer;
169
- private leftColumn?;
170
- private collectionFacets?;
171
- private manageBar?;
172
- analyticsHandler?: AnalyticsManagerInterface;
173
- /** Whether layout size analytics have been sent already. */
174
- private layoutSizeAnalyticsSent;
175
- /**
176
- * When we're animated scrolling to the page, we don't want to fetch
177
- * all of the pages as it scrolls so this lets us know if we're scrolling
178
- */
179
- private isScrollingToCell;
180
- /**
181
- * When page width resizes from desktop to mobile, set true to
182
- * disable expand/collapse transition when loading.
183
- */
184
- private isResizeToMobile;
185
- /**
186
- * Flag indicating that a new data source is currently being installed.
187
- * During the install, any URL persistence operation should replace the current entry
188
- * instead of creating a new one.
189
- */
190
- private dataSourceInstallInProgress;
191
- private leftColIntersectionObserver?;
192
- private facetsIntersectionObserver?;
193
- private placeholderCellTemplate;
194
- constructor();
195
- private tileModelAtCellIndex;
196
- private get estimatedTileCount();
197
- private infiniteScroller?;
198
- private sessionIdGenPromise?;
199
- /**
200
- * Returns a promise resolving to a unique string that persists for the current browser session.
201
- * Used in generating unique IDs for search requests, so that multiple requests coming from the
202
- * same browser session can be identified.
203
- */
204
- getSessionId(): Promise<string>;
205
- /**
206
- * Go to the given page of results
207
- *
208
- * @param pageNumber
209
- */
210
- goToPage(pageNumber: number): Promise<void>;
211
- /**
212
- * Sets the state for whether the initial set of search results is loading in.
213
- */
214
- setSearchResultsLoading(loading: boolean): void;
215
- /**
216
- * Sets the state for whether facet data is loading in
217
- */
218
- setFacetsLoading(loading: boolean): void;
219
- /**
220
- * Sets the total number of results to be displayed for the current search
221
- */
222
- setTotalResultCount(totalResults: number): void;
223
- /**
224
- * Clears all selected/negated facets, date ranges, and letter filters.
225
- *
226
- * By default, the current sort field/direction are not cleared,
227
- * but this can be overridden by setting the `sort` option to `true`.
228
- *
229
- * Similarly, it is possible to finely control what is cleared by
230
- * setting any of the `facets`, `dateRange`, or `letterFilters` flags
231
- * in the options object.
232
- */
233
- clearFilters({ facets, dateRange, letterFilters, sort, }?: {
234
- facets?: boolean | undefined;
235
- dateRange?: boolean | undefined;
236
- letterFilters?: boolean | undefined;
237
- sort?: boolean | undefined;
238
- }): void;
239
- /**
240
- * Returns true if the current value of `this.selectedFacets` contains
241
- * any facet buckets than have been selected or negated, or false otherwise.
242
- */
243
- private get hasCheckedFacets();
244
- /**
245
- * Returns true if there are any currently selected/negated facet buckets,
246
- * any selected date range, or any selected letter filters. False otherwise.
247
- *
248
- * Ignores sorting options.
249
- */
250
- private get hasActiveFilters();
251
- willUpdate(): void;
252
- render(): TemplateResult<1>;
253
- /**
254
- * Determines what type of placeholder content should be shown instead of result tiles, if applicable.
255
- * The placeholders indicate states where we have no results to show, which could be the result of:
256
- * - No query is set (on the search page)
257
- * - No results were returned for the most recent search
258
- * - The collection being searched within has no viewable items
259
- * - An error occurred on the most recent search attempt
260
- */
261
- private setPlaceholderType;
262
- /**
263
- * Template for the placeholder content to show when no results are available.
264
- */
265
- private get emptyPlaceholderTemplate();
266
- /**
267
- * Top-level template for rendering the left (facets) and right (results) columns.
268
- */
269
- private get collectionBrowserTemplate();
270
- /**
271
- * Template for either the mobile or desktop version of the left column, depending
272
- * on current component state.
273
- */
274
- private get leftColumnTemplate();
275
- /**
276
- * Template for the mobile version of the "left column" (which in this case, appears
277
- * *above* the search results rather than beside them), for rendering the
278
- * accordion-style facets.
279
- */
280
- private get mobileLeftColumnTemplate();
281
- /**
282
- * Template for the desktop version of the left column, displaying the facets sidebar.
283
- */
284
- private get desktopLeftColumnTemplate();
285
- /**
286
- * Slot which is placed at top of the facets area for user-profile page
287
- * - mainly used to render userlists
288
- */
289
- private get facetTopViewSlot();
290
- /**
291
- * Template for the "X Results" count at the top of the search results.
292
- * Changes to the "Searching..." label if the search results are still loading.
293
- */
294
- private get resultsCountTemplate();
295
- /**
296
- * Template for the right column of the collection browser, where the result
297
- * tiles and sort/filter bar are shown.
298
- */
299
- private get rightColumnTemplate();
300
- /**
301
- * Template for the infinite scroller widget that contains the result tiles.
302
- */
303
- private get infiniteScrollerTemplate();
304
- /**
305
- * Produces a `classMap` indicating which classes the infinite scroller should have
306
- * given the current display mode & placeholder case.
307
- */
308
- private get infiniteScrollerClasses();
309
- /**
310
- * Template for the sort & filtering bar that appears atop the search results.
311
- */
312
- private get sortFilterBarTemplate();
313
- /**
314
- * Template for the manage bar UI that appears atop the search results when we are
315
- * showing the management view. This generally replaces the sort bar when present.
316
- */
317
- private get manageBarTemplate();
318
- /**
319
- * Handler for when the user requests to remove all checked items via the manage bar.
320
- * Emits an `itemRemovalRequested` event with all checked tile models.
321
- */
322
- private handleRemoveItems;
323
- /**
324
- * Handler when user request to bulk edit from /search/ page
325
- */
326
- private handleManageItems;
327
- /**
328
- * Handler to show processing modal while removing item
329
- */
330
- showRemoveItemsProcessingModal(): void;
331
- /**
332
- * Handler to show error modal when item removal failed
333
- */
334
- showRemoveItemsErrorModal(): void;
335
- /**
336
- * Removes all tile models that are currently checked & adjusts the paging
337
- * of the data source to account for any new gaps in the data.
338
- */
339
- removeCheckedTiles(): void;
340
- /**
341
- * Handler for when the user changes the selected sort option or direction.
342
- */
343
- private userChangedSort;
344
- /**
345
- * Fires an analytics event for sorting changes.
346
- * @param prevSortDirection Which sort direction was previously set.
347
- */
348
- private sendSortByAnalytics;
349
- /**
350
- * Handler for when the selected sort option is updated, whether by the user
351
- * themselves or programmatically.
352
- */
353
- private selectedSortChanged;
354
- /**
355
- * An object representing the current sort field & direction.
356
- */
357
- get sortParam(): SortParam | null;
358
- /**
359
- * An object representing the default sort field & direction, if none are explicitly set.
360
- */
361
- get defaultSortParam(): SortParam | null;
362
- /**
363
- * Handler for when the display mode option is changed (grid/list/compact-list views).
364
- */
365
- private displayModeChanged;
366
- /**
367
- * Returns a query clause identifying the currently selected title filter,
368
- * e.g., `firstTitle:X`.
369
- */
370
- private get titleQuery();
371
- /**
372
- * Returns a query clause identifying the currently selected creator filter,
373
- * e.g., `firstCreator:X`.
374
- */
375
- private get creatorQuery();
376
- /**
377
- * Send Analytics when sorting by title's first letter
378
- * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
379
- */
380
- private sendFilterByTitleAnalytics;
381
- /**
382
- * Send Analytics when filtering by creator's first letter
383
- * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
384
- */
385
- private sendFilterByCreatorAnalytics;
386
- /**
387
- * Handler for changes to which letter is selected in the title alphabet bar.
388
- */
389
- private titleLetterSelected;
390
- /**
391
- * Handler for changes to which letter is selected in the creator alphabet bar.
392
- */
393
- private creatorLetterSelected;
394
- /**
395
- * The full template for how the facets should be structured in mobile view,
396
- * including the collapsible container (with header) and the facets themselves.
397
- */
398
- private get mobileFacetsTemplate();
399
- /**
400
- * The template for the facets component alone, without any surrounding wrappers.
401
- */
402
- private get facetsTemplate();
403
- /**
404
- * The HTML template for the "Clear all filters" button, or `nothing` if no
405
- * filters are currently active.
406
- *
407
- * @param mobile Whether to style/shorten the button for mobile view
408
- */
409
- private clearFiltersBtnTemplate;
410
- /**
411
- * Template for the table header content that appears atop the compact list view.
412
- */
413
- private get listHeaderTemplate();
414
- /**
415
- * Handler for when the date picker's date range is changed.
416
- */
417
- private histogramDateRangeUpdated;
418
- /**
419
- * The Lucene query corresponding to the current date range.
420
- */
421
- private get dateRangeQueryClause();
422
- /**
423
- * Emits an event indicating a change in whether the manage mode is shown.
424
- */
425
- private emitManageModeChangedEvent;
426
- /**
427
- * Installs a new data source component and associated query state parameters into
428
- * this component, causing it to efficiently update its views to represent the
429
- * newly-provided data. In this way, one can reuse a single instance of
430
- * <collection-browser> to handle multiple different sets of search results on
431
- * a single page, each set of results being loaded & updated by its own data
432
- * source.
433
- *
434
- * @param dataSource The data source component containing (or prepared to fetch)
435
- * the tile data to be displayed.
436
- * @param queryState The new query-related state that this component should
437
- * represent, such as the search query, sort option, and any filters applied.
438
- */
439
- installDataSourceAndQueryState(dataSource: CollectionBrowserDataSourceInterface, queryState: CollectionBrowserQueryState): Promise<void>;
440
- firstUpdated(): void;
441
- /**
442
- * Determines the initial size of the content container and whether or not
443
- * the mobile layout should be used.
444
- */
445
- setInitialSize(): void;
446
- /**
447
- * Fires an analytics event indicating which type of layout was rendered:
448
- * mobile or desktop.
449
- */
450
- private sendLayoutSizeAnalytics;
451
- updated(changed: PropertyValues): void;
452
- connectedCallback(): void;
453
- disconnectedCallback(): void;
454
- handleResize(entry: ResizeObserverEntry): void;
455
- /**
456
- * Ensures that if we have new results from the data source that are not yet
457
- * displayed in the infinite scroller, that they are immediately reflected
458
- * in the tile count.
459
- */
460
- private ensureAvailableTilesDisplayed;
461
- /**
462
- * Updates the data source with the current state of facet readiness for loading,
463
- * so that they will begin to load in at the appropriate time according to the
464
- * current facet loading strategy.
465
- */
466
- private updateFacetReadiness;
467
- /**
468
- * Sets up listeners for events that may require updating the left column height.
469
- */
470
- private setupLeftColumnScrollListeners;
471
- /**
472
- * Sets up listeners to control whether the facet sidebar shows its bottom fade-out.
473
- * Note this uses a separate IntersectionObserver from the left column, because we
474
- * don't need granular intersection thresholds for this.
475
- */
476
- private setupFacetsScrollListeners;
477
- /**
478
- * Updates the height of the left column according to its position on the page.
479
- * Arrow function ensures proper `this` binding.
480
- */
481
- private updateLeftColumnHeight;
482
- /**
483
- * Toggles whether the fade-out is visible at the bottom of the facets.
484
- * It should only be visible if the facets are not scrolled to the bottom.
485
- * Arrow function ensures proper `this` binding.
486
- */
487
- private updateFacetFadeOut;
488
- /**
489
- * Emits a `baseQueryChanged` event indicating an update to the search query.
490
- */
491
- private emitBaseQueryChanged;
492
- /**
493
- * Emits a `searchTypeChanged` event indicating an update to the search type
494
- * (e.g., metadata vs. full-text).
495
- */
496
- private emitSearchTypeChanged;
497
- /**
498
- * Emits a `queryStateChanged` event indicating that one or more of this component's
499
- * properties have changed in a way that could affect the set of search results.
500
- */
501
- emitQueryStateChanged(): void;
502
- /**
503
- * Emits an `emptyResults` event indicating that we have received an empty result set
504
- * for the most recent query.
505
- */
506
- emitEmptyResults(): void;
507
- private disconnectResizeObserver;
508
- private setupResizeObserver;
509
- /**
510
- * When the visible cells change from the infinite scroller, we want to emit
511
- * which page is currently visible so the consumer can update its UI or the URL
512
- *
513
- * @param e
514
- * @returns
515
- */
516
- private visibleCellsChanged;
517
- private initialQueryChangeHappened;
518
- private historyPopOccurred;
519
- private previousQueryKey?;
520
- /**
521
- * A Promise which, after each query change, resolves once the fetches for the initial
522
- * search have completed. Waits for *both* the hits and aggregations fetches to finish.
523
- *
524
- * Ensure you await this component's `updateComplete` promise before awaiting this
525
- * one, to ensure you do not await an obsolete promise from the previous update.
526
- */
527
- get initialSearchComplete(): Promise<boolean>;
528
- /**
529
- * Handler for whenever the component's properties change in a way that may require
530
- * fetching new results.
531
- */
532
- private handleQueryChange;
533
- private setupStateRestorationObserver;
534
- private boundNavigationHandler?;
535
- private historyNavigationHandler;
536
- private restoreState;
537
- private persistState;
538
- /**
539
- * Emits a `searchResultsLoadingChanged` event indicating that our loading state has
540
- * changed (either we have started loading new results, or we have finished loading them).
541
- */
542
- private emitSearchResultsLoadingChanged;
543
- /**
544
- * Handler for when the set of selected facets changes.
545
- */
546
- facetsChanged(e: CustomEvent<SelectedFacets>): void;
547
- /**
548
- * Handler for when any facet is selected/unselected/hidden/unhidden.
549
- * Fires analytics indicating the type of facet event that took place.
550
- */
551
- facetClickHandler({ detail: { facetType, bucket, negative }, }: CustomEvent<FacetEventDetails>): void;
552
- private scrollToPage;
553
- /**
554
- * Whether sorting by relevance makes sense for the current state.
555
- * Currently equivalent to having a non-empty query.
556
- */
557
- private get isRelevanceSortAvailable();
558
- /**
559
- * Sets the total number of tiles displayed in the infinite scroller.
560
- */
561
- setTileCount(count: number): void;
562
- /**
563
- * Applies any default sort option for the current collection, by checking
564
- * for one in the collection's metadata. If none is found, defaults to sorting
565
- * descending by:
566
- * - Date Favorited for fav-* collections
567
- * - Weekly views for all other collections
568
- */
569
- applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
570
- /**
571
- * Applies the default sort option for the current profile element
572
- */
573
- applyDefaultProfileSort(): void;
574
- /**
575
- * This is useful for determining whether we need to reload the scroller.
576
- *
577
- * When the fetch completes, we need to reload the scroller if the cells for that
578
- * page are visible, but if the page is not currenlty visible, we don't need to reload
579
- */
580
- get currentVisiblePageNumbers(): number[];
581
- /**
582
- * Refreshes all visible result cells in the infinite scroller.
583
- */
584
- refreshVisibleResults(): void;
585
- /**
586
- * Callback when a result is selected
587
- */
588
- resultSelected(event: CustomEvent<TileModel>): void;
589
- cellForIndex(index: number): TemplateResult | undefined;
590
- /**
591
- * When the user scrolls near to the bottom of the page, fetch the next page
592
- * increase the number of pages to render and start fetching data for the new page
593
- */
594
- private scrollThresholdReached;
595
- /**
596
- * Fetches search results for privileged users when in manage view.
597
- *
598
- * This method:
599
- * 1. Checks if we're in search context with > 100 results and not currently loading
600
- * 2. Resets the datasource pagination state
601
- * 3. Fetches first page with limit based on maxPagesToManage threshold
602
- * 4. Reloads the infinite scroller to display new results
603
- */
604
- private fetchManagableSearchResults;
605
- static get styles(): import("lit").CSSResult[];
606
- }
1
+ import { LitElement, PropertyValues, TemplateResult } from 'lit';
2
+ import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
3
+ import type { InfiniteScrollerCellProviderInterface } from '@internetarchive/infinite-scroller';
4
+ import { CollectionExtraInfo, PageElementName, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
5
+ import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
6
+ import '@internetarchive/infinite-scroller';
7
+ import type { ModalManagerInterface } from '@internetarchive/modal-manager';
8
+ import type { FeatureFeedbackServiceInterface } from '@internetarchive/feature-feedback';
9
+ import type { RecaptchaManagerInterface } from '@internetarchive/recaptcha-manager';
10
+ import { SelectedFacets, SortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails, FacetLoadStrategy } from './models';
11
+ import { RestorationStateHandlerInterface } from './restoration-state-handler';
12
+ import type { CollectionBrowserQueryState, CollectionBrowserSearchInterface } from './data-source/collection-browser-query-state';
13
+ import type { CollectionBrowserDataSourceInterface } from './data-source/collection-browser-data-source-interface';
14
+ import './empty-placeholder';
15
+ import './tiles/tile-dispatcher';
16
+ import './tiles/collection-browser-loading-tile';
17
+ import './sort-filter-bar/sort-filter-bar';
18
+ import './manage/manage-bar';
19
+ import './collection-facets';
20
+ import './circular-activity-indicator';
21
+ import './collection-facets/smart-facets/smart-facet-bar';
22
+ export declare class CollectionBrowser extends LitElement implements InfiniteScrollerCellProviderInterface, SharedResizeObserverResizeHandlerInterface, CollectionBrowserSearchInterface {
23
+ baseNavigationUrl?: string;
24
+ baseImageUrl: string;
25
+ searchService?: SearchServiceInterface;
26
+ /**
27
+ * Which backend should be targeted by searches (e.g., metadata or FTS)
28
+ */
29
+ searchType: SearchType;
30
+ /**
31
+ * The identifier of the collection that searches should be performed within
32
+ */
33
+ withinCollection?: string;
34
+ /**
35
+ * The identifier (e.g., @person) of the user whose profile is being searched within
36
+ */
37
+ withinProfile?: string;
38
+ /**
39
+ * Which section of the profile page searches are for (e.g., uploads, reviews, ...)
40
+ */
41
+ profileElement?: PageElementName;
42
+ /**
43
+ * The base query to use for all searches, updated to match the current user query.
44
+ */
45
+ baseQuery?: string;
46
+ /**
47
+ * Which mode to display result tiles in (grid, extended list, or compact list)
48
+ */
49
+ displayMode?: CollectionDisplayMode;
50
+ selectedSort: SortField;
51
+ selectedTitleFilter: string | null;
52
+ selectedCreatorFilter: string | null;
53
+ sortDirection: SortDirection | null;
54
+ defaultSortField: Exclude<SortField, SortField.default>;
55
+ defaultSortDirection: SortDirection | null;
56
+ pageSize: number;
57
+ currentPage?: number;
58
+ minSelectedDate?: string;
59
+ maxSelectedDate?: string;
60
+ selectedFacets?: SelectedFacets;
61
+ showSmartFacetBar: boolean;
62
+ /**
63
+ * Whether to show the date picker (above the facets)
64
+ */
65
+ showHistogramDatePicker: boolean;
66
+ /**
67
+ * Whether placeholder views should be suppressed. If true, searches that produce an
68
+ * error or empty result set will simply show a blank results view instead of a placeholder.
69
+ */
70
+ suppressPlaceholders: boolean;
71
+ /**
72
+ * Whether the result count text should be suppressed.
73
+ * If true, no "X Results" message will be shown.
74
+ */
75
+ suppressResultCount: boolean;
76
+ /**
77
+ * Whether the scrolling result view should be suppressed entirely.
78
+ * If true, no infinite scroller (and thus no result tiles) will be rendered.
79
+ */
80
+ suppressResultTiles: boolean;
81
+ /**
82
+ * Whether to suppress persistence of the query to the URL.
83
+ * If true, the `query` param will not be added to the URL or updated on query changes.
84
+ */
85
+ suppressURLQuery: boolean;
86
+ /**
87
+ * Whether to suppress display of the sort bar.
88
+ * If true, the entire sort bar (incl. display modes) will be omitted from rendering.
89
+ */
90
+ suppressSortBar: boolean;
91
+ /**
92
+ * Whether to suppress showing the display mode options in the sort bar.
93
+ * If true, those options will be omitted (though the rest of the sort bar may still render).
94
+ */
95
+ suppressDisplayModes: boolean;
96
+ /**
97
+ * What strategy to use for when/whether to load facet data for a search.
98
+ *
99
+ * Defaults to `eager`, always loading facets immediately alongside search results.
100
+ *
101
+ * To eliminate facets that are never seen, this can be reduced to `lazy-mobile`, which
102
+ * will delay loading facets in the mobile view until the "Filters" accordion is opened.
103
+ * Facets are still loaded eagerly when viewing the desktop layout.
104
+ *
105
+ * To further reduce facet requests for patrons who do not need to use them, this can be
106
+ * again reduced to `opt-in`, which will also require desktop users to explicitly request
107
+ * that they be loaded (in addition to the lazy mobile behavior described above).
108
+ *
109
+ * To entirely suppress facets from being loaded, this may be set to `off`.
110
+ */
111
+ facetLoadStrategy: FacetLoadStrategy;
112
+ facetPaneVisible: boolean;
113
+ clearResultsOnEmptyQuery: boolean;
114
+ collectionPagePath: string;
115
+ /** describes where this component is being used */
116
+ searchContext: string;
117
+ pageContext: CollectionBrowserContext;
118
+ restorationStateHandler: RestorationStateHandlerInterface;
119
+ mobileBreakpoint: number;
120
+ loggedIn: boolean;
121
+ resizeObserver?: SharedResizeObserverInterface;
122
+ modalManager?: ModalManagerInterface;
123
+ featureFeedbackService?: FeatureFeedbackServiceInterface;
124
+ recaptchaManager?: RecaptchaManagerInterface;
125
+ /**
126
+ * If item management UI active
127
+ */
128
+ isManageView: boolean;
129
+ manageViewLabel: string;
130
+ /** Whether to replace the default sort options with a slot for customization (default: false) */
131
+ enableSortOptionsSlot: boolean;
132
+ /** Whether to display a smart results carousel above the full results */
133
+ showSmartResults: boolean;
134
+ /**
135
+ * The maximum number of pages we will load when a privileged user clicks
136
+ * the "Manage" button on the search page. Limited to 15 pages.
137
+ */
138
+ maxPagesToManage: number;
139
+ /**
140
+ * The results per page so we can paginate.
141
+ *
142
+ * This allows us to start in the middle of the search results and
143
+ * fetch data before or after the current page. If we don't have a key
144
+ * for the previous/next page, we'll fetch the next/previous page to populate it
145
+ */
146
+ dataSource: CollectionBrowserDataSourceInterface;
147
+ /**
148
+ * The page that the consumer wants to load.
149
+ */
150
+ initialPageNumber: number;
151
+ /**
152
+ * This the the number of pages that we want to show.
153
+ *
154
+ * The data isn't necessarily loaded for all of the pages, but this lets us
155
+ * know how many cells we should render.
156
+ */
157
+ private pagesToRender;
158
+ /**
159
+ * Whether the initial page fetch for a new query is currently in progress.
160
+ */
161
+ private searchResultsLoading;
162
+ private facetsLoading;
163
+ private totalResults?;
164
+ private mobileView;
165
+ private collapsibleFacetsVisible;
166
+ private contentWidth?;
167
+ private placeholderType;
168
+ private contentContainer;
169
+ private leftColumn?;
170
+ private collectionFacets?;
171
+ private manageBar?;
172
+ analyticsHandler?: AnalyticsManagerInterface;
173
+ /** Whether layout size analytics have been sent already. */
174
+ private layoutSizeAnalyticsSent;
175
+ /**
176
+ * When we're animated scrolling to the page, we don't want to fetch
177
+ * all of the pages as it scrolls so this lets us know if we're scrolling
178
+ */
179
+ private isScrollingToCell;
180
+ /**
181
+ * When page width resizes from desktop to mobile, set true to
182
+ * disable expand/collapse transition when loading.
183
+ */
184
+ private isResizeToMobile;
185
+ /**
186
+ * Flag indicating that a new data source is currently being installed.
187
+ * During the install, any URL persistence operation should replace the current entry
188
+ * instead of creating a new one.
189
+ */
190
+ private dataSourceInstallInProgress;
191
+ private leftColIntersectionObserver?;
192
+ private facetsIntersectionObserver?;
193
+ private placeholderCellTemplate;
194
+ constructor();
195
+ private tileModelAtCellIndex;
196
+ private get estimatedTileCount();
197
+ private infiniteScroller?;
198
+ private sessionIdGenPromise?;
199
+ /**
200
+ * Returns a promise resolving to a unique string that persists for the current browser session.
201
+ * Used in generating unique IDs for search requests, so that multiple requests coming from the
202
+ * same browser session can be identified.
203
+ */
204
+ getSessionId(): Promise<string>;
205
+ /**
206
+ * Go to the given page of results
207
+ *
208
+ * @param pageNumber
209
+ */
210
+ goToPage(pageNumber: number): Promise<void>;
211
+ /**
212
+ * Sets the state for whether the initial set of search results is loading in.
213
+ */
214
+ setSearchResultsLoading(loading: boolean): void;
215
+ /**
216
+ * Sets the state for whether facet data is loading in
217
+ */
218
+ setFacetsLoading(loading: boolean): void;
219
+ /**
220
+ * Sets the total number of results to be displayed for the current search
221
+ */
222
+ setTotalResultCount(totalResults: number): void;
223
+ /**
224
+ * Clears all selected/negated facets, date ranges, and letter filters.
225
+ *
226
+ * By default, the current sort field/direction are not cleared,
227
+ * but this can be overridden by setting the `sort` option to `true`.
228
+ *
229
+ * Similarly, it is possible to finely control what is cleared by
230
+ * setting any of the `facets`, `dateRange`, or `letterFilters` flags
231
+ * in the options object.
232
+ */
233
+ clearFilters({ facets, dateRange, letterFilters, sort, }?: {
234
+ facets?: boolean | undefined;
235
+ dateRange?: boolean | undefined;
236
+ letterFilters?: boolean | undefined;
237
+ sort?: boolean | undefined;
238
+ }): void;
239
+ /**
240
+ * Returns true if the current value of `this.selectedFacets` contains
241
+ * any facet buckets than have been selected or negated, or false otherwise.
242
+ */
243
+ private get hasCheckedFacets();
244
+ /**
245
+ * Returns true if there are any currently selected/negated facet buckets,
246
+ * any selected date range, or any selected letter filters. False otherwise.
247
+ *
248
+ * Ignores sorting options.
249
+ */
250
+ private get hasActiveFilters();
251
+ willUpdate(): void;
252
+ render(): TemplateResult<1>;
253
+ /**
254
+ * Determines what type of placeholder content should be shown instead of result tiles, if applicable.
255
+ * The placeholders indicate states where we have no results to show, which could be the result of:
256
+ * - No query is set (on the search page)
257
+ * - No results were returned for the most recent search
258
+ * - The collection being searched within has no viewable items
259
+ * - An error occurred on the most recent search attempt
260
+ */
261
+ private setPlaceholderType;
262
+ /**
263
+ * Template for the placeholder content to show when no results are available.
264
+ */
265
+ private get emptyPlaceholderTemplate();
266
+ /**
267
+ * Top-level template for rendering the left (facets) and right (results) columns.
268
+ */
269
+ private get collectionBrowserTemplate();
270
+ /**
271
+ * Template for either the mobile or desktop version of the left column, depending
272
+ * on current component state.
273
+ */
274
+ private get leftColumnTemplate();
275
+ /**
276
+ * Template for the mobile version of the "left column" (which in this case, appears
277
+ * *above* the search results rather than beside them), for rendering the
278
+ * accordion-style facets.
279
+ */
280
+ private get mobileLeftColumnTemplate();
281
+ /**
282
+ * Template for the desktop version of the left column, displaying the facets sidebar.
283
+ */
284
+ private get desktopLeftColumnTemplate();
285
+ /**
286
+ * Slot which is placed at top of the facets area for user-profile page
287
+ * - mainly used to render userlists
288
+ */
289
+ private get facetTopViewSlot();
290
+ /**
291
+ * Template for the "X Results" count at the top of the search results.
292
+ * Changes to the "Searching..." label if the search results are still loading.
293
+ */
294
+ private get resultsCountTemplate();
295
+ /**
296
+ * Template for the right column of the collection browser, where the result
297
+ * tiles and sort/filter bar are shown.
298
+ */
299
+ private get rightColumnTemplate();
300
+ /**
301
+ * Template for the infinite scroller widget that contains the result tiles.
302
+ */
303
+ private get infiniteScrollerTemplate();
304
+ /**
305
+ * Produces a `classMap` indicating which classes the infinite scroller should have
306
+ * given the current display mode & placeholder case.
307
+ */
308
+ private get infiniteScrollerClasses();
309
+ /**
310
+ * Template for the sort & filtering bar that appears atop the search results.
311
+ */
312
+ private get sortFilterBarTemplate();
313
+ /**
314
+ * Template for the manage bar UI that appears atop the search results when we are
315
+ * showing the management view. This generally replaces the sort bar when present.
316
+ */
317
+ private get manageBarTemplate();
318
+ /**
319
+ * Handler for when the user requests to remove all checked items via the manage bar.
320
+ * Emits an `itemRemovalRequested` event with all checked tile models.
321
+ */
322
+ private handleRemoveItems;
323
+ /**
324
+ * Handler when user request to bulk edit from /search/ page
325
+ */
326
+ private handleManageItems;
327
+ /**
328
+ * Handler to show processing modal while removing item
329
+ */
330
+ showRemoveItemsProcessingModal(): void;
331
+ /**
332
+ * Handler to show error modal when item removal failed
333
+ */
334
+ showRemoveItemsErrorModal(): void;
335
+ /**
336
+ * Removes all tile models that are currently checked & adjusts the paging
337
+ * of the data source to account for any new gaps in the data.
338
+ */
339
+ removeCheckedTiles(): void;
340
+ /**
341
+ * Handler for when the user changes the selected sort option or direction.
342
+ */
343
+ private userChangedSort;
344
+ /**
345
+ * Fires an analytics event for sorting changes.
346
+ * @param prevSortDirection Which sort direction was previously set.
347
+ */
348
+ private sendSortByAnalytics;
349
+ /**
350
+ * Handler for when the selected sort option is updated, whether by the user
351
+ * themselves or programmatically.
352
+ */
353
+ private selectedSortChanged;
354
+ /**
355
+ * An object representing the current sort field & direction.
356
+ */
357
+ get sortParam(): SortParam | null;
358
+ /**
359
+ * An object representing the default sort field & direction, if none are explicitly set.
360
+ */
361
+ get defaultSortParam(): SortParam | null;
362
+ /**
363
+ * Handler for when the display mode option is changed (grid/list/compact-list views).
364
+ */
365
+ private displayModeChanged;
366
+ /**
367
+ * Returns a query clause identifying the currently selected title filter,
368
+ * e.g., `firstTitle:X`.
369
+ */
370
+ private get titleQuery();
371
+ /**
372
+ * Returns a query clause identifying the currently selected creator filter,
373
+ * e.g., `firstCreator:X`.
374
+ */
375
+ private get creatorQuery();
376
+ /**
377
+ * Send Analytics when sorting by title's first letter
378
+ * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
379
+ */
380
+ private sendFilterByTitleAnalytics;
381
+ /**
382
+ * Send Analytics when filtering by creator's first letter
383
+ * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
384
+ */
385
+ private sendFilterByCreatorAnalytics;
386
+ /**
387
+ * Handler for changes to which letter is selected in the title alphabet bar.
388
+ */
389
+ private titleLetterSelected;
390
+ /**
391
+ * Handler for changes to which letter is selected in the creator alphabet bar.
392
+ */
393
+ private creatorLetterSelected;
394
+ /**
395
+ * The full template for how the facets should be structured in mobile view,
396
+ * including the collapsible container (with header) and the facets themselves.
397
+ */
398
+ private get mobileFacetsTemplate();
399
+ /**
400
+ * The template for the facets component alone, without any surrounding wrappers.
401
+ */
402
+ private get facetsTemplate();
403
+ /**
404
+ * The HTML template for the "Clear all filters" button, or `nothing` if no
405
+ * filters are currently active.
406
+ *
407
+ * @param mobile Whether to style/shorten the button for mobile view
408
+ */
409
+ private clearFiltersBtnTemplate;
410
+ /**
411
+ * Template for the table header content that appears atop the compact list view.
412
+ */
413
+ private get listHeaderTemplate();
414
+ /**
415
+ * Handler for when the date picker's date range is changed.
416
+ */
417
+ private histogramDateRangeUpdated;
418
+ /**
419
+ * The Lucene query corresponding to the current date range.
420
+ */
421
+ private get dateRangeQueryClause();
422
+ /**
423
+ * Emits an event indicating a change in whether the manage mode is shown.
424
+ */
425
+ private emitManageModeChangedEvent;
426
+ /**
427
+ * Installs a new data source component and associated query state parameters into
428
+ * this component, causing it to efficiently update its views to represent the
429
+ * newly-provided data. In this way, one can reuse a single instance of
430
+ * <collection-browser> to handle multiple different sets of search results on
431
+ * a single page, each set of results being loaded & updated by its own data
432
+ * source.
433
+ *
434
+ * @param dataSource The data source component containing (or prepared to fetch)
435
+ * the tile data to be displayed.
436
+ * @param queryState The new query-related state that this component should
437
+ * represent, such as the search query, sort option, and any filters applied.
438
+ */
439
+ installDataSourceAndQueryState(dataSource: CollectionBrowserDataSourceInterface, queryState: CollectionBrowserQueryState): Promise<void>;
440
+ firstUpdated(): void;
441
+ /**
442
+ * Determines the initial size of the content container and whether or not
443
+ * the mobile layout should be used.
444
+ */
445
+ setInitialSize(): void;
446
+ /**
447
+ * Fires an analytics event indicating which type of layout was rendered:
448
+ * mobile or desktop.
449
+ */
450
+ private sendLayoutSizeAnalytics;
451
+ updated(changed: PropertyValues): void;
452
+ connectedCallback(): void;
453
+ disconnectedCallback(): void;
454
+ handleResize(entry: ResizeObserverEntry): void;
455
+ /**
456
+ * Ensures that if we have new results from the data source that are not yet
457
+ * displayed in the infinite scroller, that they are immediately reflected
458
+ * in the tile count.
459
+ */
460
+ private ensureAvailableTilesDisplayed;
461
+ /**
462
+ * Updates the data source with the current state of facet readiness for loading,
463
+ * so that they will begin to load in at the appropriate time according to the
464
+ * current facet loading strategy.
465
+ */
466
+ private updateFacetReadiness;
467
+ /**
468
+ * Sets up listeners for events that may require updating the left column height.
469
+ */
470
+ private setupLeftColumnScrollListeners;
471
+ /**
472
+ * Sets up listeners to control whether the facet sidebar shows its bottom fade-out.
473
+ * Note this uses a separate IntersectionObserver from the left column, because we
474
+ * don't need granular intersection thresholds for this.
475
+ */
476
+ private setupFacetsScrollListeners;
477
+ /**
478
+ * Updates the height of the left column according to its position on the page.
479
+ * Arrow function ensures proper `this` binding.
480
+ */
481
+ private updateLeftColumnHeight;
482
+ /**
483
+ * Toggles whether the fade-out is visible at the bottom of the facets.
484
+ * It should only be visible if the facets are not scrolled to the bottom.
485
+ * Arrow function ensures proper `this` binding.
486
+ */
487
+ private updateFacetFadeOut;
488
+ /**
489
+ * Emits a `baseQueryChanged` event indicating an update to the search query.
490
+ */
491
+ private emitBaseQueryChanged;
492
+ /**
493
+ * Emits a `searchTypeChanged` event indicating an update to the search type
494
+ * (e.g., metadata vs. full-text).
495
+ */
496
+ private emitSearchTypeChanged;
497
+ /**
498
+ * Emits a `queryStateChanged` event indicating that one or more of this component's
499
+ * properties have changed in a way that could affect the set of search results.
500
+ */
501
+ emitQueryStateChanged(): void;
502
+ /**
503
+ * Emits an `emptyResults` event indicating that we have received an empty result set
504
+ * for the most recent query.
505
+ */
506
+ emitEmptyResults(): void;
507
+ private disconnectResizeObserver;
508
+ private setupResizeObserver;
509
+ /**
510
+ * When the visible cells change from the infinite scroller, we want to emit
511
+ * which page is currently visible so the consumer can update its UI or the URL
512
+ *
513
+ * @param e
514
+ * @returns
515
+ */
516
+ private visibleCellsChanged;
517
+ private initialQueryChangeHappened;
518
+ private historyPopOccurred;
519
+ private previousQueryKey?;
520
+ /**
521
+ * A Promise which, after each query change, resolves once the fetches for the initial
522
+ * search have completed. Waits for *both* the hits and aggregations fetches to finish.
523
+ *
524
+ * Ensure you await this component's `updateComplete` promise before awaiting this
525
+ * one, to ensure you do not await an obsolete promise from the previous update.
526
+ */
527
+ get initialSearchComplete(): Promise<boolean>;
528
+ /**
529
+ * Handler for whenever the component's properties change in a way that may require
530
+ * fetching new results.
531
+ */
532
+ private handleQueryChange;
533
+ private setupStateRestorationObserver;
534
+ private boundNavigationHandler?;
535
+ private historyNavigationHandler;
536
+ private restoreState;
537
+ private persistState;
538
+ /**
539
+ * Emits a `searchResultsLoadingChanged` event indicating that our loading state has
540
+ * changed (either we have started loading new results, or we have finished loading them).
541
+ */
542
+ private emitSearchResultsLoadingChanged;
543
+ /**
544
+ * Handler for when the set of selected facets changes.
545
+ */
546
+ facetsChanged(e: CustomEvent<SelectedFacets>): void;
547
+ /**
548
+ * Handler for when any facet is selected/unselected/hidden/unhidden.
549
+ * Fires analytics indicating the type of facet event that took place.
550
+ */
551
+ facetClickHandler({ detail: { facetType, bucket, negative }, }: CustomEvent<FacetEventDetails>): void;
552
+ private scrollToPage;
553
+ /**
554
+ * Whether sorting by relevance makes sense for the current state.
555
+ * Currently equivalent to having a non-empty query.
556
+ */
557
+ private get isRelevanceSortAvailable();
558
+ /**
559
+ * Sets the total number of tiles displayed in the infinite scroller.
560
+ */
561
+ setTileCount(count: number): void;
562
+ /**
563
+ * Applies any default sort option for the current collection, by checking
564
+ * for one in the collection's metadata. If none is found, defaults to sorting
565
+ * descending by:
566
+ * - Date Favorited for fav-* collections
567
+ * - Weekly views for all other collections
568
+ */
569
+ applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
570
+ /**
571
+ * Applies the default sort option for the current profile element
572
+ */
573
+ applyDefaultProfileSort(): void;
574
+ /**
575
+ * This is useful for determining whether we need to reload the scroller.
576
+ *
577
+ * When the fetch completes, we need to reload the scroller if the cells for that
578
+ * page are visible, but if the page is not currenlty visible, we don't need to reload
579
+ */
580
+ get currentVisiblePageNumbers(): number[];
581
+ /**
582
+ * Refreshes all visible result cells in the infinite scroller.
583
+ */
584
+ refreshVisibleResults(): void;
585
+ /**
586
+ * Callback when a result is selected
587
+ */
588
+ resultSelected(event: CustomEvent<TileModel>): void;
589
+ cellForIndex(index: number): TemplateResult | undefined;
590
+ /**
591
+ * When the user scrolls near to the bottom of the page, fetch the next page
592
+ * increase the number of pages to render and start fetching data for the new page
593
+ */
594
+ private scrollThresholdReached;
595
+ /**
596
+ * Fetches search results for privileged users when in manage view.
597
+ *
598
+ * This method:
599
+ * 1. Checks if we're in search context with > 100 results and not currently loading
600
+ * 2. Resets the datasource pagination state
601
+ * 3. Fetches first page with limit based on maxPagesToManage threshold
602
+ * 4. Reloads the infinite scroller to display new results
603
+ */
604
+ private fetchManagableSearchResults;
605
+ static get styles(): import("lit").CSSResult[];
606
+ }