@internetarchive/collection-browser 1.13.0-alpha2 → 1.14.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 (287) hide show
  1. package/.editorconfig +29 -29
  2. package/.github/workflows/ci.yml +26 -26
  3. package/.github/workflows/gh-pages-main.yml +39 -39
  4. package/.github/workflows/npm-publish.yml +39 -39
  5. package/.github/workflows/pr-preview.yml +38 -38
  6. package/.husky/pre-commit +4 -4
  7. package/LICENSE +661 -661
  8. package/README.md +83 -83
  9. package/dist/index.d.ts +9 -9
  10. package/dist/index.js +9 -9
  11. package/dist/src/app-root.d.ts +64 -54
  12. package/dist/src/app-root.js +320 -293
  13. package/dist/src/app-root.js.map +1 -1
  14. package/dist/src/assets/img/icons/arrow-left.d.ts +2 -2
  15. package/dist/src/assets/img/icons/arrow-left.js +2 -2
  16. package/dist/src/assets/img/icons/arrow-right.d.ts +2 -2
  17. package/dist/src/assets/img/icons/arrow-right.js +2 -2
  18. package/dist/src/assets/img/icons/chevron.d.ts +2 -2
  19. package/dist/src/assets/img/icons/chevron.js +2 -2
  20. package/dist/src/assets/img/icons/contract.d.ts +2 -2
  21. package/dist/src/assets/img/icons/contract.js +2 -2
  22. package/dist/src/assets/img/icons/empty-query.d.ts +2 -2
  23. package/dist/src/assets/img/icons/empty-query.js +2 -2
  24. package/dist/src/assets/img/icons/expand.d.ts +2 -2
  25. package/dist/src/assets/img/icons/expand.js +2 -2
  26. package/dist/src/assets/img/icons/eye-closed.d.ts +2 -2
  27. package/dist/src/assets/img/icons/eye-closed.js +2 -2
  28. package/dist/src/assets/img/icons/eye.d.ts +2 -2
  29. package/dist/src/assets/img/icons/eye.js +2 -2
  30. package/dist/src/assets/img/icons/favorite-filled.d.ts +1 -1
  31. package/dist/src/assets/img/icons/favorite-filled.js +2 -2
  32. package/dist/src/assets/img/icons/login-required.d.ts +1 -1
  33. package/dist/src/assets/img/icons/login-required.js +2 -2
  34. package/dist/src/assets/img/icons/mediatype/account.d.ts +1 -1
  35. package/dist/src/assets/img/icons/mediatype/account.js +2 -2
  36. package/dist/src/assets/img/icons/mediatype/audio.d.ts +1 -1
  37. package/dist/src/assets/img/icons/mediatype/audio.js +2 -2
  38. package/dist/src/assets/img/icons/mediatype/collection.d.ts +1 -1
  39. package/dist/src/assets/img/icons/mediatype/collection.js +2 -2
  40. package/dist/src/assets/img/icons/mediatype/data.d.ts +1 -1
  41. package/dist/src/assets/img/icons/mediatype/data.js +2 -2
  42. package/dist/src/assets/img/icons/mediatype/etree.d.ts +1 -1
  43. package/dist/src/assets/img/icons/mediatype/etree.js +2 -2
  44. package/dist/src/assets/img/icons/mediatype/film.d.ts +1 -1
  45. package/dist/src/assets/img/icons/mediatype/film.js +2 -2
  46. package/dist/src/assets/img/icons/mediatype/images.d.ts +1 -1
  47. package/dist/src/assets/img/icons/mediatype/images.js +2 -2
  48. package/dist/src/assets/img/icons/mediatype/radio.d.ts +1 -1
  49. package/dist/src/assets/img/icons/mediatype/radio.js +2 -2
  50. package/dist/src/assets/img/icons/mediatype/software.d.ts +1 -1
  51. package/dist/src/assets/img/icons/mediatype/software.js +2 -2
  52. package/dist/src/assets/img/icons/mediatype/texts.d.ts +1 -1
  53. package/dist/src/assets/img/icons/mediatype/texts.js +2 -2
  54. package/dist/src/assets/img/icons/mediatype/tv.d.ts +1 -1
  55. package/dist/src/assets/img/icons/mediatype/tv.js +2 -2
  56. package/dist/src/assets/img/icons/mediatype/video.d.ts +1 -1
  57. package/dist/src/assets/img/icons/mediatype/video.js +2 -2
  58. package/dist/src/assets/img/icons/mediatype/web.d.ts +1 -1
  59. package/dist/src/assets/img/icons/mediatype/web.js +2 -2
  60. package/dist/src/assets/img/icons/null-result.d.ts +2 -2
  61. package/dist/src/assets/img/icons/null-result.js +2 -2
  62. package/dist/src/assets/img/icons/restricted.d.ts +1 -1
  63. package/dist/src/assets/img/icons/restricted.js +2 -2
  64. package/dist/src/assets/img/icons/reviews.d.ts +1 -1
  65. package/dist/src/assets/img/icons/reviews.js +2 -2
  66. package/dist/src/assets/img/icons/upload.d.ts +1 -1
  67. package/dist/src/assets/img/icons/upload.js +2 -2
  68. package/dist/src/assets/img/icons/views.d.ts +1 -1
  69. package/dist/src/assets/img/icons/views.js +2 -2
  70. package/dist/src/circular-activity-indicator.d.ts +5 -5
  71. package/dist/src/circular-activity-indicator.js +17 -17
  72. package/dist/src/collection-browser.d.ts +522 -473
  73. package/dist/src/collection-browser.js +1846 -1697
  74. package/dist/src/collection-browser.js.map +1 -1
  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 +20 -20
  78. package/dist/src/collection-facets/facets-template.js +152 -152
  79. package/dist/src/collection-facets/more-facets-content.d.ts +77 -77
  80. package/dist/src/collection-facets/more-facets-content.js +359 -359
  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 +104 -103
  86. package/dist/src/collection-facets.js +511 -498
  87. package/dist/src/collection-facets.js.map +1 -1
  88. package/dist/src/empty-placeholder.d.ts +23 -23
  89. package/dist/src/empty-placeholder.js +74 -74
  90. package/dist/src/expanded-date-picker.d.ts +43 -43
  91. package/dist/src/expanded-date-picker.js +109 -109
  92. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  93. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  94. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  95. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  96. package/dist/src/manage/manage-bar.d.ts +26 -0
  97. package/dist/src/manage/manage-bar.js +147 -0
  98. package/dist/src/manage/manage-bar.js.map +1 -0
  99. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  100. package/dist/src/mediatype/mediatype-config.js +85 -85
  101. package/dist/src/models.d.ts +164 -163
  102. package/dist/src/models.js +269 -269
  103. package/dist/src/models.js.map +1 -1
  104. package/dist/src/restoration-state-handler.d.ts +70 -70
  105. package/dist/src/restoration-state-handler.js +355 -355
  106. package/dist/src/sort-filter-bar/alpha-bar-tooltip.d.ts +6 -6
  107. package/dist/src/sort-filter-bar/alpha-bar-tooltip.js +24 -24
  108. package/dist/src/sort-filter-bar/alpha-bar.d.ts +21 -21
  109. package/dist/src/sort-filter-bar/alpha-bar.js +128 -128
  110. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  111. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  112. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  113. package/dist/src/sort-filter-bar/img/list.js +2 -2
  114. package/dist/src/sort-filter-bar/img/sort-toggle-disabled.d.ts +1 -1
  115. package/dist/src/sort-filter-bar/img/sort-toggle-disabled.js +2 -2
  116. package/dist/src/sort-filter-bar/img/sort-toggle-down.d.ts +1 -1
  117. package/dist/src/sort-filter-bar/img/sort-toggle-down.js +2 -2
  118. package/dist/src/sort-filter-bar/img/sort-toggle-up.d.ts +1 -1
  119. package/dist/src/sort-filter-bar/img/sort-toggle-up.js +2 -2
  120. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  121. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  122. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  123. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  124. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +208 -208
  125. package/dist/src/sort-filter-bar/sort-filter-bar.js +637 -637
  126. package/dist/src/styles/item-image-styles.d.ts +8 -8
  127. package/dist/src/styles/item-image-styles.js +9 -9
  128. package/dist/src/styles/sr-only.d.ts +1 -1
  129. package/dist/src/styles/sr-only.js +2 -2
  130. package/dist/src/tiles/base-tile-component.d.ts +18 -18
  131. package/dist/src/tiles/base-tile-component.js +59 -59
  132. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  133. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  134. package/dist/src/tiles/grid/account-tile.d.ts +18 -18
  135. package/dist/src/tiles/grid/account-tile.js +72 -72
  136. package/dist/src/tiles/grid/collection-tile.d.ts +15 -15
  137. package/dist/src/tiles/grid/collection-tile.js +80 -80
  138. package/dist/src/tiles/grid/item-tile.d.ts +27 -27
  139. package/dist/src/tiles/grid/item-tile.js +134 -134
  140. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.d.ts +1 -1
  141. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.js +8 -8
  142. package/dist/src/tiles/grid/tile-stats.d.ts +11 -11
  143. package/dist/src/tiles/grid/tile-stats.js +48 -48
  144. package/dist/src/tiles/hover/hover-pane-controller.d.ts +219 -219
  145. package/dist/src/tiles/hover/hover-pane-controller.js +352 -352
  146. package/dist/src/tiles/hover/tile-hover-pane.d.ts +15 -15
  147. package/dist/src/tiles/hover/tile-hover-pane.js +38 -38
  148. package/dist/src/tiles/image-block.d.ts +17 -17
  149. package/dist/src/tiles/image-block.js +72 -72
  150. package/dist/src/tiles/item-image.d.ts +35 -35
  151. package/dist/src/tiles/item-image.js +117 -117
  152. package/dist/src/tiles/list/tile-list-compact-header.d.ts +6 -6
  153. package/dist/src/tiles/list/tile-list-compact-header.js +38 -38
  154. package/dist/src/tiles/list/tile-list-compact.d.ts +15 -15
  155. package/dist/src/tiles/list/tile-list-compact.js +114 -114
  156. package/dist/src/tiles/list/tile-list.d.ts +46 -46
  157. package/dist/src/tiles/list/tile-list.js +298 -298
  158. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  159. package/dist/src/tiles/mediatype-icon.js +47 -47
  160. package/dist/src/tiles/overlay/icon-overlay.d.ts +10 -10
  161. package/dist/src/tiles/overlay/icon-overlay.js +40 -40
  162. package/dist/src/tiles/overlay/icon-text-overlay.d.ts +9 -9
  163. package/dist/src/tiles/overlay/icon-text-overlay.js +38 -38
  164. package/dist/src/tiles/overlay/text-overlay.d.ts +10 -10
  165. package/dist/src/tiles/overlay/text-overlay.js +42 -42
  166. package/dist/src/tiles/text-snippet-block.d.ts +27 -27
  167. package/dist/src/tiles/text-snippet-block.js +73 -73
  168. package/dist/src/tiles/tile-dispatcher.d.ts +63 -50
  169. package/dist/src/tiles/tile-dispatcher.js +255 -187
  170. package/dist/src/tiles/tile-dispatcher.js.map +1 -1
  171. package/dist/src/tiles/tile-display-value-provider.d.ts +43 -43
  172. package/dist/src/tiles/tile-display-value-provider.js +80 -80
  173. package/dist/src/utils/analytics-events.d.ts +25 -25
  174. package/dist/src/utils/analytics-events.js +27 -27
  175. package/dist/src/utils/array-equals.d.ts +4 -4
  176. package/dist/src/utils/array-equals.js +10 -10
  177. package/dist/src/utils/format-count.d.ts +7 -7
  178. package/dist/src/utils/format-count.js +76 -76
  179. package/dist/src/utils/format-date.d.ts +2 -2
  180. package/dist/src/utils/format-date.js +25 -25
  181. package/dist/src/utils/format-unit-size.d.ts +2 -2
  182. package/dist/src/utils/format-unit-size.js +33 -33
  183. package/dist/src/utils/local-date-from-utc.d.ts +9 -9
  184. package/dist/src/utils/local-date-from-utc.js +15 -15
  185. package/dist/src/utils/sha1.d.ts +2 -2
  186. package/dist/src/utils/sha1.js +8 -8
  187. package/dist/test/collection-browser.test.d.ts +1 -1
  188. package/dist/test/collection-browser.test.js +1122 -979
  189. package/dist/test/collection-browser.test.js.map +1 -1
  190. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  191. package/dist/test/collection-facets/facets-template.test.js +134 -134
  192. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  193. package/dist/test/collection-facets/more-facets-content.test.js +133 -133
  194. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  195. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  196. package/dist/test/collection-facets/toggle-switch.test.d.ts +1 -1
  197. package/dist/test/collection-facets/toggle-switch.test.js +73 -73
  198. package/dist/test/collection-facets.test.d.ts +2 -2
  199. package/dist/test/collection-facets.test.js +682 -682
  200. package/dist/test/empty-placeholder.test.d.ts +1 -1
  201. package/dist/test/empty-placeholder.test.js +63 -63
  202. package/dist/test/expanded-date-picker.test.d.ts +1 -1
  203. package/dist/test/expanded-date-picker.test.js +95 -95
  204. package/dist/test/icon-overlay.test.d.ts +1 -1
  205. package/dist/test/icon-overlay.test.js +24 -24
  206. package/dist/test/image-block.test.d.ts +1 -1
  207. package/dist/test/image-block.test.js +48 -48
  208. package/dist/test/item-image.test.d.ts +1 -1
  209. package/dist/test/item-image.test.js +86 -84
  210. package/dist/test/item-image.test.js.map +1 -1
  211. package/dist/test/manage/manage-bar.test.d.ts +1 -0
  212. package/dist/test/manage/manage-bar.test.js +73 -0
  213. package/dist/test/manage/manage-bar.test.js.map +1 -0
  214. package/dist/test/mediatype-config.test.d.ts +1 -1
  215. package/dist/test/mediatype-config.test.js +16 -16
  216. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  217. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  218. package/dist/test/mocks/mock-collection-name-cache.d.ts +9 -9
  219. package/dist/test/mocks/mock-collection-name-cache.js +17 -17
  220. package/dist/test/mocks/mock-search-responses.d.ts +21 -21
  221. package/dist/test/mocks/mock-search-responses.js +709 -707
  222. package/dist/test/mocks/mock-search-responses.js.map +1 -1
  223. package/dist/test/mocks/mock-search-service.d.ts +15 -15
  224. package/dist/test/mocks/mock-search-service.js +50 -50
  225. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  226. package/dist/test/restoration-state-handler.test.js +270 -270
  227. package/dist/test/sort-filter-bar/alpha-bar-tooltip.test.d.ts +1 -1
  228. package/dist/test/sort-filter-bar/alpha-bar-tooltip.test.js +12 -12
  229. package/dist/test/sort-filter-bar/alpha-bar.test.d.ts +1 -1
  230. package/dist/test/sort-filter-bar/alpha-bar.test.js +73 -73
  231. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  232. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +378 -378
  233. package/dist/test/text-overlay.test.d.ts +1 -1
  234. package/dist/test/text-overlay.test.js +48 -48
  235. package/dist/test/text-snippet-block.test.d.ts +1 -1
  236. package/dist/test/text-snippet-block.test.js +57 -57
  237. package/dist/test/tile-stats.test.d.ts +1 -1
  238. package/dist/test/tile-stats.test.js +33 -33
  239. package/dist/test/tiles/grid/account-tile.test.d.ts +1 -1
  240. package/dist/test/tiles/grid/account-tile.test.js +76 -76
  241. package/dist/test/tiles/grid/collection-tile.test.d.ts +1 -1
  242. package/dist/test/tiles/grid/collection-tile.test.js +73 -73
  243. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  244. package/dist/test/tiles/grid/item-tile.test.js +254 -254
  245. package/dist/test/tiles/hover/hover-pane-controller.test.d.ts +1 -1
  246. package/dist/test/tiles/hover/hover-pane-controller.test.js +258 -257
  247. package/dist/test/tiles/hover/hover-pane-controller.test.js.map +1 -1
  248. package/dist/test/tiles/hover/tile-hover-pane.test.d.ts +1 -1
  249. package/dist/test/tiles/hover/tile-hover-pane.test.js +13 -13
  250. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  251. package/dist/test/tiles/list/tile-list-compact.test.js +143 -143
  252. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  253. package/dist/test/tiles/list/tile-list.test.js +242 -242
  254. package/dist/test/tiles/tile-dispatcher.test.d.ts +1 -1
  255. package/dist/test/tiles/tile-dispatcher.test.js +107 -67
  256. package/dist/test/tiles/tile-dispatcher.test.js.map +1 -1
  257. package/dist/test/tiles/tile-display-value-provider.test.d.ts +1 -1
  258. package/dist/test/tiles/tile-display-value-provider.test.js +141 -141
  259. package/dist/test/utils/array-equals.test.d.ts +1 -1
  260. package/dist/test/utils/array-equals.test.js +26 -26
  261. package/dist/test/utils/format-count.test.d.ts +1 -1
  262. package/dist/test/utils/format-count.test.js +23 -23
  263. package/dist/test/utils/format-date.test.d.ts +1 -1
  264. package/dist/test/utils/format-date.test.js +17 -17
  265. package/dist/test/utils/format-unit-size.test.d.ts +1 -1
  266. package/dist/test/utils/format-unit-size.test.js +17 -17
  267. package/dist/test/utils/local-date-from-utc.test.d.ts +1 -1
  268. package/dist/test/utils/local-date-from-utc.test.js +26 -26
  269. package/local.archive.org.cert +86 -86
  270. package/local.archive.org.key +27 -27
  271. package/package.json +2 -2
  272. package/renovate.json +6 -6
  273. package/src/app-root.ts +29 -0
  274. package/src/collection-browser.ts +197 -23
  275. package/src/collection-facets.ts +13 -1
  276. package/src/manage/manage-bar.ts +151 -0
  277. package/src/models.ts +1 -0
  278. package/src/tiles/tile-dispatcher.ts +71 -5
  279. package/test/collection-browser.test.ts +198 -1
  280. package/test/item-image.test.ts +2 -0
  281. package/test/manage/manage-bar.test.ts +107 -0
  282. package/test/mocks/mock-search-responses.ts +2 -0
  283. package/test/tiles/hover/hover-pane-controller.test.ts +1 -0
  284. package/test/tiles/tile-dispatcher.test.ts +52 -0
  285. package/tsconfig.json +21 -21
  286. package/web-dev-server.config.mjs +30 -30
  287. package/web-test-runner.config.mjs +41 -41
@@ -1,473 +1,522 @@
1
- import { LitElement, PropertyValues, TemplateResult } from 'lit';
2
- import type { InfiniteScrollerCellProviderInterface } from '@internetarchive/infinite-scroller';
3
- import { CollectionExtraInfo, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
4
- import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
5
- import '@internetarchive/infinite-scroller';
6
- import type { CollectionNameCacheInterface } from '@internetarchive/collection-name-cache';
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 './tiles/tile-dispatcher';
11
- import './tiles/collection-browser-loading-tile';
12
- import './sort-filter-bar/sort-filter-bar';
13
- import './collection-facets';
14
- import './circular-activity-indicator';
15
- import './sort-filter-bar/sort-filter-bar';
16
- import { SelectedFacets, SortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails } from './models';
17
- import { RestorationStateHandlerInterface } from './restoration-state-handler';
18
- import './empty-placeholder';
19
- export declare class CollectionBrowser extends LitElement implements InfiniteScrollerCellProviderInterface, SharedResizeObserverResizeHandlerInterface {
20
- baseNavigationUrl?: string;
21
- baseImageUrl: string;
22
- searchService?: SearchServiceInterface;
23
- searchType: SearchType;
24
- withinCollection?: string;
25
- baseQuery?: string;
26
- displayMode?: CollectionDisplayMode;
27
- sortParam: SortParam | null;
28
- selectedSort: SortField;
29
- selectedTitleFilter: string | null;
30
- selectedCreatorFilter: string | null;
31
- sortDirection: SortDirection | null;
32
- pageSize: number;
33
- resizeObserver?: SharedResizeObserverInterface;
34
- currentPage?: number;
35
- minSelectedDate?: string;
36
- maxSelectedDate?: string;
37
- selectedFacets?: SelectedFacets;
38
- showHistogramDatePicker: boolean;
39
- collectionPagePath: string;
40
- collectionInfo?: CollectionExtraInfo;
41
- parentCollections: string[];
42
- /** describes where this component is being used */
43
- searchContext: string;
44
- collectionNameCache?: CollectionNameCacheInterface;
45
- pageContext: CollectionBrowserContext;
46
- restorationStateHandler: RestorationStateHandlerInterface;
47
- mobileBreakpoint: number;
48
- loggedIn: boolean;
49
- modalManager?: ModalManagerInterface;
50
- featureFeedbackService?: FeatureFeedbackServiceInterface;
51
- recaptchaManager?: RecaptchaManagerInterface;
52
- /**
53
- * If item management UI active
54
- */
55
- isManageView: boolean;
56
- /**
57
- * The page that the consumer wants to load.
58
- */
59
- private initialPageNumber;
60
- /**
61
- * This the the number of pages that we want to show.
62
- *
63
- * The data isn't necessarily loaded for all of the pages, but this lets us
64
- * know how many cells we should render.
65
- */
66
- private pagesToRender;
67
- /**
68
- * Whether the initial page fetch for a new query is currently in progress.
69
- */
70
- private searchResultsLoading;
71
- private facetsLoading;
72
- private fullYearAggregationLoading;
73
- private aggregations?;
74
- private fullYearsHistogramAggregation;
75
- private totalResults?;
76
- private queryErrorMessage?;
77
- private mobileView;
78
- private mobileFacetsVisible;
79
- private contentWidth?;
80
- private defaultSortField;
81
- private defaultSortDirection;
82
- private placeholderType;
83
- private prefixFilterCountMap;
84
- private contentContainer;
85
- private leftColumn?;
86
- private collectionFacets?;
87
- private analyticsHandler?;
88
- /**
89
- * When we're animated scrolling to the page, we don't want to fetch
90
- * all of the pages as it scrolls so this lets us know if we're scrolling
91
- */
92
- private isScrollingToCell;
93
- /**
94
- * When we've reached the end of the data, stop trying to fetch more
95
- */
96
- private endOfDataReached;
97
- /**
98
- * When page width resizes from desktop to mobile, set true to
99
- * disable expand/collapse transition when loading.
100
- */
101
- private isResizeToMobile;
102
- private leftColIntersectionObserver?;
103
- private facetsIntersectionObserver?;
104
- private placeholderCellTemplate;
105
- private tileModelAtCellIndex;
106
- private get sortFilterQueries();
107
- private get estimatedTileCount();
108
- /**
109
- * The results per page so we can paginate.
110
- *
111
- * This allows us to start in the middle of the search results and
112
- * fetch data before or after the current page. If we don't have a key
113
- * for the previous/next page, we'll fetch the next/previous page to populate it
114
- */
115
- private dataSource;
116
- private infiniteScroller;
117
- private sessionIdGenPromise?;
118
- /**
119
- * Returns a promise resolving to a unique string that persists for the current browser session.
120
- * Used in generating unique IDs for search requests, so that multiple requests coming from the
121
- * same browser session can be identified.
122
- */
123
- private getSessionId;
124
- /**
125
- * Go to the given page of results
126
- *
127
- * @param pageNumber
128
- */
129
- goToPage(pageNumber: number): Promise<void>;
130
- /**
131
- * Clears all selected/negated facets, date ranges, and letter filters.
132
- *
133
- * By default, the current sort field/direction are not cleared,
134
- * but this can be overridden by setting the `sort` option to `true`.
135
- *
136
- * Similarly, it is possible to finely control what is cleared by
137
- * setting any of the `facets`, `dateRange`, or `letterFilters` flags
138
- * in the options object.
139
- */
140
- clearFilters({ facets, dateRange, letterFilters, sort, }?: {
141
- facets?: boolean | undefined;
142
- dateRange?: boolean | undefined;
143
- letterFilters?: boolean | undefined;
144
- sort?: boolean | undefined;
145
- }): void;
146
- /**
147
- * Returns true if the current value of `this.selectedFacets` contains
148
- * any facet buckets than have been selected or negated, or false otherwise.
149
- */
150
- private get hasCheckedFacets();
151
- /**
152
- * Returns true if there are any currently selected/negated facet buckets,
153
- * any selected date range, or any selected letter filters. False otherwise.
154
- *
155
- * Ignores sorting options.
156
- */
157
- private get hasActiveFilters();
158
- render(): TemplateResult<1>;
159
- private setPlaceholderType;
160
- private get emptyPlaceholderTemplate();
161
- /**
162
- * Top-level template for rendering the left (facets) and right (results) columns.
163
- */
164
- private get collectionBrowserTemplate();
165
- /**
166
- * Template for either the mobile or desktop version of the left column, depending
167
- * on current component state.
168
- */
169
- private get leftColumnTemplate();
170
- /**
171
- * Template for the mobile version of the "left column" (which in this case, appears
172
- * *above* the search results rather than beside them), for rendering the
173
- * accordion-style facets.
174
- */
175
- private get mobileLeftColumnTemplate();
176
- /**
177
- * Template for the desktop version of the left column, displaying the facets sidebar.
178
- */
179
- private get desktopLeftColumnTemplate();
180
- /**
181
- * Template for the "X Results" count at the top of the search results.
182
- * Changes to the "Searching..." label if the search results are still loading.
183
- */
184
- private get resultsCountTemplate();
185
- /**
186
- * Template for the right column of the collection browser, where the result
187
- * tiles and sort/filter bar are shown.
188
- */
189
- private get rightColumnTemplate();
190
- private get infiniteScrollerTemplate();
191
- private get infiniteScrollerClasses();
192
- private get sortFilterBarTemplate();
193
- private userChangedSort;
194
- private sendSortByAnalytics;
195
- private selectedSortChanged;
196
- private displayModeChanged;
197
- /**
198
- * Returns a query clause identifying the currently selected title filter,
199
- * e.g., `firstTitle:X`.
200
- */
201
- private get titleQuery();
202
- /**
203
- * Returns a query clause identifying the currently selected creator filter,
204
- * e.g., `firstCreator:X`.
205
- */
206
- private get creatorQuery();
207
- /**
208
- * Send Analytics when sorting by title's first letter
209
- * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
210
- */
211
- private sendFilterByTitleAnalytics;
212
- /**
213
- * Send Analytics when filtering by creator's first letter
214
- * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
215
- */
216
- private sendFilterByCreatorAnalytics;
217
- /**
218
- * Handler for changes to which letter is selected in the title alphabet bar.
219
- */
220
- private titleLetterSelected;
221
- /**
222
- * Handler for changes to which letter is selected in the creator alphabet bar.
223
- */
224
- private creatorLetterSelected;
225
- /**
226
- * The full template for how the facets should be structured in mobile view,
227
- * including the collapsible container (with header) and the facets themselves.
228
- */
229
- private get mobileFacetsTemplate();
230
- /**
231
- * The template for the facets component alone, without any surrounding wrappers.
232
- */
233
- private get facetsTemplate();
234
- /**
235
- * The HTML template for the "Clear all filters" button, or `nothing` if no
236
- * filters are currently active.
237
- *
238
- * @param mobile Whether to style/shorten the button for mobile view
239
- */
240
- private clearFiltersBtnTemplate;
241
- private get loadingTemplate();
242
- private get listHeaderTemplate();
243
- private histogramDateRangeUpdated;
244
- private get dateRangeQueryClause();
245
- firstUpdated(): void;
246
- updated(changed: PropertyValues): void;
247
- disconnectedCallback(): void;
248
- handleResize(entry: ResizeObserverEntry): void;
249
- /**
250
- * Sets up listeners for events that may require updating the left column height.
251
- */
252
- private setupLeftColumnScrollListeners;
253
- /**
254
- * Sets up listeners to control whether the facet sidebar shows its bottom fade-out.
255
- * Note this uses a separate IntersectionObserver from the left column, because we
256
- * don't need granular intersection thresholds for this.
257
- */
258
- private setupFacetsScrollListeners;
259
- /**
260
- * Updates the height of the left column according to its position on the page.
261
- * Arrow function ensures proper `this` binding.
262
- */
263
- private updateLeftColumnHeight;
264
- /**
265
- * Toggles whether the fade-out is visible at the bottom of the facets.
266
- * It should only be visible if the facets are not scrolled to the bottom.
267
- * Arrow function ensures proper `this` binding.
268
- */
269
- private updateFacetFadeOut;
270
- private emitBaseQueryChanged;
271
- private emitSearchTypeChanged;
272
- private emitTabChanged;
273
- private disconnectResizeObserver;
274
- private setupResizeObserver;
275
- /**
276
- * When the visible cells change from the infinite scroller, we want to emit
277
- * which page is currently visible so the consumer can update its UI or the URL
278
- *
279
- * @param e
280
- * @returns
281
- */
282
- private visibleCellsChanged;
283
- private initialQueryChangeHappened;
284
- private historyPopOccurred;
285
- private previousQueryKey?;
286
- /**
287
- * Internal property to store the `resolve` function for the most recent
288
- * `initialSearchComplete` promise, allowing us to resolve it at the appropriate time.
289
- */
290
- private _initialSearchCompleteResolver;
291
- /**
292
- * Internal property to store the private value backing the `initialSearchComplete` getter.
293
- */
294
- private _initialSearchCompletePromise;
295
- /**
296
- * A Promise which, after each query change, resolves once the fetches for the initial
297
- * search have completed. Waits for *both* the hits and aggregations fetches to finish.
298
- *
299
- * Ensure you await this component's `updateComplete` promise before awaiting this
300
- * one, to ensure you do not await an obsolete promise from the previous update.
301
- */
302
- get initialSearchComplete(): Promise<boolean>;
303
- private handleQueryChange;
304
- private setupStateRestorationObserver;
305
- private boundNavigationHandler?;
306
- private historyNavigationHandler;
307
- private restoreState;
308
- private persistState;
309
- private doInitialPageFetch;
310
- private emitSearchResultsLoadingChanged;
311
- /**
312
- * Produces a compact unique ID for a search request that can help with debugging
313
- * on the backend by making related requests easier to trace through different services.
314
- * (e.g., tying the hits/aggregations requests for the same page back to a single hash).
315
- *
316
- * @param params The search service parameters for the request
317
- * @param kind The kind of request (hits-only, aggregations-only, or both)
318
- * @returns A Promise resolving to the uid to apply to the request
319
- */
320
- private requestUID;
321
- /**
322
- * Constructs a search service FilterMap object from the combination of
323
- * all the currently-applied filters. This includes any facets, letter
324
- * filters, and date range.
325
- */
326
- private get filterMap();
327
- /** The full query, including year facets and date range clauses */
328
- private get fullQuery();
329
- /**
330
- * Generates a query string for the given facets
331
- *
332
- * Example: `mediatype:("collection" OR "audio" OR -"etree") AND year:("2000" OR "2001")`
333
- */
334
- private get facetQuery();
335
- /**
336
- * Builds an OR-joined facet clause for the given facet name and values.
337
- *
338
- * E.g., for name `subject` and values
339
- * `{ foo: { state: 'selected' }, bar: { state: 'hidden' } }`
340
- * this will produce the clause
341
- * `subject:("foo" OR -"bar")`.
342
- *
343
- * @param facetName The facet type (e.g., 'collection')
344
- * @param facetValues The facet buckets, mapped by their keys
345
- */
346
- private buildFacetClause;
347
- /**
348
- * Handles some special pre-request normalization steps for certain facet types
349
- * that require them.
350
- *
351
- * @param facetName The name of the facet type (e.g., 'language')
352
- * @param facetValues An array of values for that facet type
353
- */
354
- private prepareFacetForFetch;
355
- /**
356
- * Takes an array of facet clauses, and combines them into a
357
- * full AND-joined facet query string. Empty clauses are ignored.
358
- */
359
- private joinFacetClauses;
360
- facetsChanged(e: CustomEvent<SelectedFacets>): void;
361
- facetClickHandler({ detail: { key, state: facetState, negative }, }: CustomEvent<FacetEventDetails>): void;
362
- private fetchFacets;
363
- private scrollToPage;
364
- /**
365
- * Whether sorting by relevance makes sense for the current state.
366
- * Currently equivalent to having a non-empty query.
367
- */
368
- private get isRelevanceSortAvailable();
369
- /**
370
- * Whether a search may be performed in the current state of the component.
371
- * This is only true if the search service is defined, and either
372
- * (a) a non-empty query is set, or
373
- * (b) we are on a collection page in metadata search mode.
374
- */
375
- private get canPerformSearch();
376
- /**
377
- * Additional params to pass to the search service if targeting a collection page,
378
- * or null otherwise.
379
- */
380
- private get collectionParams();
381
- /**
382
- * The query key is a string that uniquely identifies the current search.
383
- * It consists of:
384
- * - The current base query
385
- * - The current collection
386
- * - The current search type
387
- * - Any currently-applied facets
388
- * - Any currently-applied date range
389
- * - Any currently-applied prefix filters
390
- * - The current sort options
391
- *
392
- * This lets us keep track of queries so we don't persist data that's
393
- * no longer relevant.
394
- */
395
- private get pageFetchQueryKey();
396
- /**
397
- * Similar to `pageFetchQueryKey` above, but excludes sort fields since they
398
- * are not relevant in determining aggregation queries.
399
- */
400
- private get facetFetchQueryKey();
401
- private pageFetchesInProgress;
402
- /**
403
- * Fetches one or more pages of results and updates the data source.
404
- *
405
- * @param pageNumber The page number to fetch
406
- * @param numInitialPages If this is an initial page fetch (`pageNumber = 1`),
407
- * specifies how many pages to batch together in one request. Ignored
408
- * if `pageNumber != 1`, defaulting to a single page.
409
- */
410
- fetchPage(pageNumber: number, numInitialPages?: number): Promise<void>;
411
- private preloadCollectionNames;
412
- /**
413
- * Applies any default sort option for the current collection, by checking
414
- * for one in the collection's metadata. If none is found, defaults to sorting
415
- * descending by:
416
- * - Date Favorited for fav-* collections
417
- * - Weekly views for all other collections
418
- */
419
- private applyDefaultCollectionSort;
420
- /**
421
- * This is useful for determining whether we need to reload the scroller.
422
- *
423
- * When the fetch completes, we need to reload the scroller if the cells for that
424
- * page are visible, but if the page is not currenlty visible, we don't need to reload
425
- */
426
- private get currentVisiblePageNumbers();
427
- /**
428
- * Update the datasource from the fetch response
429
- *
430
- * @param pageNumber
431
- * @param results
432
- */
433
- private updateDataSource;
434
- /**
435
- * Returns the input string, but removing one set of quotes from all instances of
436
- * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
437
- * URL-encoded.
438
- *
439
- * This should be a temporary measure to address the fact that the __href__ field
440
- * sometimes acquires extra quotation marks during query rewriting. Once there is a
441
- * full Lucene parser in place that handles quoted queries correctly, this can likely
442
- * be removed.
443
- */
444
- private collapseRepeatedQuotes;
445
- /** Fetches the aggregation buckets for the given prefix filter type. */
446
- private fetchPrefixFilterBuckets;
447
- /** Fetches and caches the prefix filter counts for the given filter type. */
448
- private updatePrefixFilterCounts;
449
- /**
450
- * Fetches and caches the prefix filter counts for the current sort type,
451
- * provided it is one that permits prefix filtering. (If not, this does nothing).
452
- */
453
- private updatePrefixFiltersForCurrentSort;
454
- /**
455
- * Clears the cached letter counts for both title and creator, and
456
- * fetches a new set of counts for whichever of them is the currently
457
- * selected sort option (which may be neither).
458
- *
459
- * Call this whenever the counts are invalidated (e.g., by a query change).
460
- */
461
- private refreshLetterCounts;
462
- /**
463
- * Callback when a result is selected
464
- */
465
- resultSelected(event: CustomEvent<TileModel>): void;
466
- cellForIndex(index: number): TemplateResult | undefined;
467
- /**
468
- * When the user scrolls near to the bottom of the page, fetch the next page
469
- * increase the number of pages to render and start fetching data for the new page
470
- */
471
- private scrollThresholdReached;
472
- static get styles(): import("lit").CSSResult[];
473
- }
1
+ import { LitElement, PropertyValues, TemplateResult } from 'lit';
2
+ import type { InfiniteScrollerCellProviderInterface } from '@internetarchive/infinite-scroller';
3
+ import { CollectionExtraInfo, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
4
+ import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
5
+ import '@internetarchive/infinite-scroller';
6
+ import type { CollectionNameCacheInterface } from '@internetarchive/collection-name-cache';
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 './tiles/tile-dispatcher';
11
+ import './tiles/collection-browser-loading-tile';
12
+ import './sort-filter-bar/sort-filter-bar';
13
+ import './manage/manage-bar';
14
+ import './collection-facets';
15
+ import './circular-activity-indicator';
16
+ import { SelectedFacets, SortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails } from './models';
17
+ import { RestorationStateHandlerInterface } from './restoration-state-handler';
18
+ import './empty-placeholder';
19
+ export declare class CollectionBrowser extends LitElement implements InfiniteScrollerCellProviderInterface, SharedResizeObserverResizeHandlerInterface {
20
+ baseNavigationUrl?: string;
21
+ baseImageUrl: string;
22
+ searchService?: SearchServiceInterface;
23
+ searchType: SearchType;
24
+ withinCollection?: string;
25
+ baseQuery?: string;
26
+ displayMode?: CollectionDisplayMode;
27
+ sortParam: SortParam | null;
28
+ selectedSort: SortField;
29
+ selectedTitleFilter: string | null;
30
+ selectedCreatorFilter: string | null;
31
+ sortDirection: SortDirection | null;
32
+ pageSize: number;
33
+ resizeObserver?: SharedResizeObserverInterface;
34
+ currentPage?: number;
35
+ minSelectedDate?: string;
36
+ maxSelectedDate?: string;
37
+ selectedFacets?: SelectedFacets;
38
+ showHistogramDatePicker: boolean;
39
+ collectionPagePath: string;
40
+ collectionInfo?: CollectionExtraInfo;
41
+ parentCollections: string[];
42
+ /** describes where this component is being used */
43
+ searchContext: string;
44
+ collectionNameCache?: CollectionNameCacheInterface;
45
+ pageContext: CollectionBrowserContext;
46
+ restorationStateHandler: RestorationStateHandlerInterface;
47
+ mobileBreakpoint: number;
48
+ loggedIn: boolean;
49
+ modalManager?: ModalManagerInterface;
50
+ featureFeedbackService?: FeatureFeedbackServiceInterface;
51
+ recaptchaManager?: RecaptchaManagerInterface;
52
+ /**
53
+ * If item management UI active
54
+ */
55
+ isManageView: boolean;
56
+ /**
57
+ * The page that the consumer wants to load.
58
+ */
59
+ private initialPageNumber;
60
+ /**
61
+ * This the the number of pages that we want to show.
62
+ *
63
+ * The data isn't necessarily loaded for all of the pages, but this lets us
64
+ * know how many cells we should render.
65
+ */
66
+ private pagesToRender;
67
+ /**
68
+ * Whether the initial page fetch for a new query is currently in progress.
69
+ */
70
+ private searchResultsLoading;
71
+ private facetsLoading;
72
+ private fullYearAggregationLoading;
73
+ private aggregations?;
74
+ private fullYearsHistogramAggregation;
75
+ private totalResults?;
76
+ private queryErrorMessage?;
77
+ private mobileView;
78
+ private mobileFacetsVisible;
79
+ private contentWidth?;
80
+ private defaultSortField;
81
+ private defaultSortDirection;
82
+ private placeholderType;
83
+ private prefixFilterCountMap;
84
+ private contentContainer;
85
+ private leftColumn?;
86
+ private collectionFacets?;
87
+ private analyticsHandler?;
88
+ /**
89
+ * When we're animated scrolling to the page, we don't want to fetch
90
+ * all of the pages as it scrolls so this lets us know if we're scrolling
91
+ */
92
+ private isScrollingToCell;
93
+ /**
94
+ * When we've reached the end of the data, stop trying to fetch more
95
+ */
96
+ private endOfDataReached;
97
+ /**
98
+ * When page width resizes from desktop to mobile, set true to
99
+ * disable expand/collapse transition when loading.
100
+ */
101
+ private isResizeToMobile;
102
+ private leftColIntersectionObserver?;
103
+ private facetsIntersectionObserver?;
104
+ private placeholderCellTemplate;
105
+ private tileModelAtCellIndex;
106
+ private get sortFilterQueries();
107
+ private get estimatedTileCount();
108
+ /**
109
+ * The results per page so we can paginate.
110
+ *
111
+ * This allows us to start in the middle of the search results and
112
+ * fetch data before or after the current page. If we don't have a key
113
+ * for the previous/next page, we'll fetch the next/previous page to populate it
114
+ */
115
+ private dataSource;
116
+ /**
117
+ * How many tiles to offset the data source by, to account for any removed tiles.
118
+ */
119
+ private tileModelOffset;
120
+ private infiniteScroller;
121
+ private sessionIdGenPromise?;
122
+ /**
123
+ * Returns a promise resolving to a unique string that persists for the current browser session.
124
+ * Used in generating unique IDs for search requests, so that multiple requests coming from the
125
+ * same browser session can be identified.
126
+ */
127
+ private getSessionId;
128
+ /**
129
+ * Go to the given page of results
130
+ *
131
+ * @param pageNumber
132
+ */
133
+ goToPage(pageNumber: number): Promise<void>;
134
+ /**
135
+ * Clears all selected/negated facets, date ranges, and letter filters.
136
+ *
137
+ * By default, the current sort field/direction are not cleared,
138
+ * but this can be overridden by setting the `sort` option to `true`.
139
+ *
140
+ * Similarly, it is possible to finely control what is cleared by
141
+ * setting any of the `facets`, `dateRange`, or `letterFilters` flags
142
+ * in the options object.
143
+ */
144
+ clearFilters({ facets, dateRange, letterFilters, sort, }?: {
145
+ facets?: boolean | undefined;
146
+ dateRange?: boolean | undefined;
147
+ letterFilters?: boolean | undefined;
148
+ sort?: boolean | undefined;
149
+ }): void;
150
+ /**
151
+ * Returns true if the current value of `this.selectedFacets` contains
152
+ * any facet buckets than have been selected or negated, or false otherwise.
153
+ */
154
+ private get hasCheckedFacets();
155
+ /**
156
+ * Returns true if there are any currently selected/negated facet buckets,
157
+ * any selected date range, or any selected letter filters. False otherwise.
158
+ *
159
+ * Ignores sorting options.
160
+ */
161
+ private get hasActiveFilters();
162
+ render(): TemplateResult<1>;
163
+ private setPlaceholderType;
164
+ private get emptyPlaceholderTemplate();
165
+ /**
166
+ * Top-level template for rendering the left (facets) and right (results) columns.
167
+ */
168
+ private get collectionBrowserTemplate();
169
+ /**
170
+ * Template for either the mobile or desktop version of the left column, depending
171
+ * on current component state.
172
+ */
173
+ private get leftColumnTemplate();
174
+ /**
175
+ * Template for the mobile version of the "left column" (which in this case, appears
176
+ * *above* the search results rather than beside them), for rendering the
177
+ * accordion-style facets.
178
+ */
179
+ private get mobileLeftColumnTemplate();
180
+ /**
181
+ * Template for the desktop version of the left column, displaying the facets sidebar.
182
+ */
183
+ private get desktopLeftColumnTemplate();
184
+ /**
185
+ * Template for the "X Results" count at the top of the search results.
186
+ * Changes to the "Searching..." label if the search results are still loading.
187
+ */
188
+ private get resultsCountTemplate();
189
+ /**
190
+ * Template for the right column of the collection browser, where the result
191
+ * tiles and sort/filter bar are shown.
192
+ */
193
+ private get rightColumnTemplate();
194
+ private get infiniteScrollerTemplate();
195
+ private get infiniteScrollerClasses();
196
+ private get sortFilterBarTemplate();
197
+ private get manageBarTemplate();
198
+ /**
199
+ * Handler for when the user requests to remove all checked items via the manage bar.
200
+ * Emits an `itemRemovalRequested` event with all checked tile models.
201
+ */
202
+ private handleRemoveItems;
203
+ /**
204
+ * Removes all tile models that are currently checked & adjusts the paging
205
+ * of the data source to account for any new gaps in the data.
206
+ */
207
+ removeCheckedTiles(): void;
208
+ /**
209
+ * Checks every tile's management checkbox
210
+ */
211
+ checkAllTiles(): void;
212
+ /**
213
+ * Unchecks every tile's management checkbox
214
+ */
215
+ uncheckAllTiles(): void;
216
+ /**
217
+ * Applies the given map function to all of the tile models in every page of the data
218
+ * source. This method updates the data source object in immutable fashion.
219
+ *
220
+ * @param mapFn A callback function to apply on each tile model, as with Array.map
221
+ */
222
+ private mapDataSource;
223
+ /**
224
+ * An array of all the tile models whose management checkboxes are checked
225
+ */
226
+ get checkedTileModels(): TileModel[];
227
+ /**
228
+ * An array of all the tile models whose management checkboxes are unchecked
229
+ */
230
+ get uncheckedTileModels(): TileModel[];
231
+ /**
232
+ * Returns a flattened, filtered array of all the tile models in the data source
233
+ * for which the given predicate returns a truthy value.
234
+ *
235
+ * @param predicate A callback function to apply on each tile model, as with Array.filter
236
+ * @returns A filtered array of tile models satisfying the predicate
237
+ */
238
+ private getFilteredTileModels;
239
+ private userChangedSort;
240
+ private sendSortByAnalytics;
241
+ private selectedSortChanged;
242
+ private displayModeChanged;
243
+ /**
244
+ * Returns a query clause identifying the currently selected title filter,
245
+ * e.g., `firstTitle:X`.
246
+ */
247
+ private get titleQuery();
248
+ /**
249
+ * Returns a query clause identifying the currently selected creator filter,
250
+ * e.g., `firstCreator:X`.
251
+ */
252
+ private get creatorQuery();
253
+ /**
254
+ * Send Analytics when sorting by title's first letter
255
+ * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
256
+ */
257
+ private sendFilterByTitleAnalytics;
258
+ /**
259
+ * Send Analytics when filtering by creator's first letter
260
+ * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
261
+ */
262
+ private sendFilterByCreatorAnalytics;
263
+ /**
264
+ * Handler for changes to which letter is selected in the title alphabet bar.
265
+ */
266
+ private titleLetterSelected;
267
+ /**
268
+ * Handler for changes to which letter is selected in the creator alphabet bar.
269
+ */
270
+ private creatorLetterSelected;
271
+ /**
272
+ * The full template for how the facets should be structured in mobile view,
273
+ * including the collapsible container (with header) and the facets themselves.
274
+ */
275
+ private get mobileFacetsTemplate();
276
+ /**
277
+ * The template for the facets component alone, without any surrounding wrappers.
278
+ */
279
+ private get facetsTemplate();
280
+ /**
281
+ * The HTML template for the "Clear all filters" button, or `nothing` if no
282
+ * filters are currently active.
283
+ *
284
+ * @param mobile Whether to style/shorten the button for mobile view
285
+ */
286
+ private clearFiltersBtnTemplate;
287
+ private get loadingTemplate();
288
+ private get listHeaderTemplate();
289
+ private histogramDateRangeUpdated;
290
+ private get dateRangeQueryClause();
291
+ /**
292
+ * Emits an event indicating a change in whether the manage mode is shown.
293
+ */
294
+ private emitManageModeChangedEvent;
295
+ firstUpdated(): void;
296
+ updated(changed: PropertyValues): void;
297
+ disconnectedCallback(): void;
298
+ handleResize(entry: ResizeObserverEntry): void;
299
+ /**
300
+ * Sets up listeners for events that may require updating the left column height.
301
+ */
302
+ private setupLeftColumnScrollListeners;
303
+ /**
304
+ * Sets up listeners to control whether the facet sidebar shows its bottom fade-out.
305
+ * Note this uses a separate IntersectionObserver from the left column, because we
306
+ * don't need granular intersection thresholds for this.
307
+ */
308
+ private setupFacetsScrollListeners;
309
+ /**
310
+ * Updates the height of the left column according to its position on the page.
311
+ * Arrow function ensures proper `this` binding.
312
+ */
313
+ private updateLeftColumnHeight;
314
+ /**
315
+ * Toggles whether the fade-out is visible at the bottom of the facets.
316
+ * It should only be visible if the facets are not scrolled to the bottom.
317
+ * Arrow function ensures proper `this` binding.
318
+ */
319
+ private updateFacetFadeOut;
320
+ private emitBaseQueryChanged;
321
+ private emitSearchTypeChanged;
322
+ private disconnectResizeObserver;
323
+ private setupResizeObserver;
324
+ /**
325
+ * When the visible cells change from the infinite scroller, we want to emit
326
+ * which page is currently visible so the consumer can update its UI or the URL
327
+ *
328
+ * @param e
329
+ * @returns
330
+ */
331
+ private visibleCellsChanged;
332
+ private initialQueryChangeHappened;
333
+ private historyPopOccurred;
334
+ private previousQueryKey?;
335
+ /**
336
+ * Internal property to store the `resolve` function for the most recent
337
+ * `initialSearchComplete` promise, allowing us to resolve it at the appropriate time.
338
+ */
339
+ private _initialSearchCompleteResolver;
340
+ /**
341
+ * Internal property to store the private value backing the `initialSearchComplete` getter.
342
+ */
343
+ private _initialSearchCompletePromise;
344
+ /**
345
+ * A Promise which, after each query change, resolves once the fetches for the initial
346
+ * search have completed. Waits for *both* the hits and aggregations fetches to finish.
347
+ *
348
+ * Ensure you await this component's `updateComplete` promise before awaiting this
349
+ * one, to ensure you do not await an obsolete promise from the previous update.
350
+ */
351
+ get initialSearchComplete(): Promise<boolean>;
352
+ private handleQueryChange;
353
+ private setupStateRestorationObserver;
354
+ private boundNavigationHandler?;
355
+ private historyNavigationHandler;
356
+ private restoreState;
357
+ private persistState;
358
+ private doInitialPageFetch;
359
+ private emitSearchResultsLoadingChanged;
360
+ /**
361
+ * Produces a compact unique ID for a search request that can help with debugging
362
+ * on the backend by making related requests easier to trace through different services.
363
+ * (e.g., tying the hits/aggregations requests for the same page back to a single hash).
364
+ *
365
+ * @param params The search service parameters for the request
366
+ * @param kind The kind of request (hits-only, aggregations-only, or both)
367
+ * @returns A Promise resolving to the uid to apply to the request
368
+ */
369
+ private requestUID;
370
+ /**
371
+ * Constructs a search service FilterMap object from the combination of
372
+ * all the currently-applied filters. This includes any facets, letter
373
+ * filters, and date range.
374
+ */
375
+ private get filterMap();
376
+ /** The full query, including year facets and date range clauses */
377
+ private get fullQuery();
378
+ /**
379
+ * Generates a query string for the given facets
380
+ *
381
+ * Example: `mediatype:("collection" OR "audio" OR -"etree") AND year:("2000" OR "2001")`
382
+ */
383
+ private get facetQuery();
384
+ /**
385
+ * Builds an OR-joined facet clause for the given facet name and values.
386
+ *
387
+ * E.g., for name `subject` and values
388
+ * `{ foo: { state: 'selected' }, bar: { state: 'hidden' } }`
389
+ * this will produce the clause
390
+ * `subject:("foo" OR -"bar")`.
391
+ *
392
+ * @param facetName The facet type (e.g., 'collection')
393
+ * @param facetValues The facet buckets, mapped by their keys
394
+ */
395
+ private buildFacetClause;
396
+ /**
397
+ * Handles some special pre-request normalization steps for certain facet types
398
+ * that require them.
399
+ *
400
+ * @param facetName The name of the facet type (e.g., 'language')
401
+ * @param facetValues An array of values for that facet type
402
+ */
403
+ private prepareFacetForFetch;
404
+ /**
405
+ * Takes an array of facet clauses, and combines them into a
406
+ * full AND-joined facet query string. Empty clauses are ignored.
407
+ */
408
+ private joinFacetClauses;
409
+ facetsChanged(e: CustomEvent<SelectedFacets>): void;
410
+ facetClickHandler({ detail: { key, state: facetState, negative }, }: CustomEvent<FacetEventDetails>): void;
411
+ private fetchFacets;
412
+ private scrollToPage;
413
+ /**
414
+ * Whether sorting by relevance makes sense for the current state.
415
+ * Currently equivalent to having a non-empty query.
416
+ */
417
+ private get isRelevanceSortAvailable();
418
+ /**
419
+ * Whether a search may be performed in the current state of the component.
420
+ * This is only true if the search service is defined, and either
421
+ * (a) a non-empty query is set, or
422
+ * (b) we are on a collection page in metadata search mode.
423
+ */
424
+ private get canPerformSearch();
425
+ /**
426
+ * Additional params to pass to the search service if targeting a collection page,
427
+ * or null otherwise.
428
+ */
429
+ private get collectionParams();
430
+ /**
431
+ * The query key is a string that uniquely identifies the current search.
432
+ * It consists of:
433
+ * - The current base query
434
+ * - The current collection
435
+ * - The current search type
436
+ * - Any currently-applied facets
437
+ * - Any currently-applied date range
438
+ * - Any currently-applied prefix filters
439
+ * - The current sort options
440
+ *
441
+ * This lets us keep track of queries so we don't persist data that's
442
+ * no longer relevant.
443
+ */
444
+ private get pageFetchQueryKey();
445
+ /**
446
+ * Similar to `pageFetchQueryKey` above, but excludes sort fields since they
447
+ * are not relevant in determining aggregation queries.
448
+ */
449
+ private get facetFetchQueryKey();
450
+ private pageFetchesInProgress;
451
+ /**
452
+ * Fetches one or more pages of results and updates the data source.
453
+ *
454
+ * @param pageNumber The page number to fetch
455
+ * @param numInitialPages If this is an initial page fetch (`pageNumber = 1`),
456
+ * specifies how many pages to batch together in one request. Ignored
457
+ * if `pageNumber != 1`, defaulting to a single page.
458
+ */
459
+ fetchPage(pageNumber: number, numInitialPages?: number): Promise<void>;
460
+ private preloadCollectionNames;
461
+ /**
462
+ * Applies any default sort option for the current collection, by checking
463
+ * for one in the collection's metadata. If none is found, defaults to sorting
464
+ * descending by:
465
+ * - Date Favorited for fav-* collections
466
+ * - Weekly views for all other collections
467
+ */
468
+ private applyDefaultCollectionSort;
469
+ /**
470
+ * This is useful for determining whether we need to reload the scroller.
471
+ *
472
+ * When the fetch completes, we need to reload the scroller if the cells for that
473
+ * page are visible, but if the page is not currenlty visible, we don't need to reload
474
+ */
475
+ private get currentVisiblePageNumbers();
476
+ /**
477
+ * Update the datasource from the fetch response
478
+ *
479
+ * @param pageNumber
480
+ * @param results
481
+ */
482
+ private updateDataSource;
483
+ /**
484
+ * Returns the input string, but removing one set of quotes from all instances of
485
+ * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
486
+ * URL-encoded.
487
+ *
488
+ * This should be a temporary measure to address the fact that the __href__ field
489
+ * sometimes acquires extra quotation marks during query rewriting. Once there is a
490
+ * full Lucene parser in place that handles quoted queries correctly, this can likely
491
+ * be removed.
492
+ */
493
+ private collapseRepeatedQuotes;
494
+ /** Fetches the aggregation buckets for the given prefix filter type. */
495
+ private fetchPrefixFilterBuckets;
496
+ /** Fetches and caches the prefix filter counts for the given filter type. */
497
+ private updatePrefixFilterCounts;
498
+ /**
499
+ * Fetches and caches the prefix filter counts for the current sort type,
500
+ * provided it is one that permits prefix filtering. (If not, this does nothing).
501
+ */
502
+ private updatePrefixFiltersForCurrentSort;
503
+ /**
504
+ * Clears the cached letter counts for both title and creator, and
505
+ * fetches a new set of counts for whichever of them is the currently
506
+ * selected sort option (which may be neither).
507
+ *
508
+ * Call this whenever the counts are invalidated (e.g., by a query change).
509
+ */
510
+ private refreshLetterCounts;
511
+ /**
512
+ * Callback when a result is selected
513
+ */
514
+ resultSelected(event: CustomEvent<TileModel>): void;
515
+ cellForIndex(index: number): TemplateResult | undefined;
516
+ /**
517
+ * When the user scrolls near to the bottom of the page, fetch the next page
518
+ * increase the number of pages to render and start fetching data for the new page
519
+ */
520
+ private scrollThresholdReached;
521
+ static get styles(): import("lit").CSSResult[];
522
+ }