@internetarchive/collection-browser 2.3.0 → 2.4.0

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