@internetarchive/collection-browser 1.8.0 → 1.9.0-alpha2

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