@internetarchive/collection-browser 2.5.2 → 2.6.1

package/dist/src/collection-browser.d.ts

@@ -1,564 +1,564 @@
-import { LitElement, PropertyValues, TemplateResult } from 'lit';
-import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
-import type { InfiniteScrollerCellProviderInterface } from '@internetarchive/infinite-scroller';
-import { CollectionExtraInfo, PageElementName, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
-import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
-import '@internetarchive/infinite-scroller';
-import type { ModalManagerInterface } from '@internetarchive/modal-manager';
-import type { FeatureFeedbackServiceInterface } from '@internetarchive/feature-feedback';
-import type { RecaptchaManagerInterface } from '@internetarchive/recaptcha-manager';
-import { SelectedFacets, SortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails, FacetLoadStrategy } from './models';
-import { RestorationStateHandlerInterface } from './restoration-state-handler';
-import type { CollectionBrowserQueryState, CollectionBrowserSearchInterface } from './data-source/collection-browser-query-state';
-import type { CollectionBrowserDataSourceInterface } from './data-source/collection-browser-data-source-interface';
-import './empty-placeholder';
-import './tiles/tile-dispatcher';
-import './tiles/collection-browser-loading-tile';
-import './sort-filter-bar/sort-filter-bar';
-import './manage/manage-bar';
-import './collection-facets';
-import './circular-activity-indicator';
-export declare class CollectionBrowser extends LitElement implements InfiniteScrollerCellProviderInterface, SharedResizeObserverResizeHandlerInterface, CollectionBrowserSearchInterface {
-    baseNavigationUrl?: string;
-    baseImageUrl: string;
-    searchService?: SearchServiceInterface;
-    /**
-     * Which backend should be targeted by searches (e.g., metadata or FTS)
-     */
-    searchType: SearchType;
-    /**
-     * The identifier of the collection that searches should be performed within
-     */
-    withinCollection?: string;
-    /**
-     * The identifier (e.g., @person) of the user whose profile is being searched within
-     */
-    withinProfile?: string;
-    /**
-     * Which section of the profile page searches are for (e.g., uploads, reviews, ...)
-     */
-    profileElement?: PageElementName;
-    /**
-     * The base query to use for all searches, updated to match the current user query.
-     */
-    baseQuery?: string;
-    /**
-     * Which mode to display result tiles in (grid, extended list, or compact list)
-     */
-    displayMode?: CollectionDisplayMode;
-    defaultSortParam: SortParam | null;
-    selectedSort: SortField;
-    selectedTitleFilter: string | null;
-    selectedCreatorFilter: string | null;
-    sortDirection: SortDirection | null;
-    pageSize: number;
-    currentPage?: number;
-    minSelectedDate?: string;
-    maxSelectedDate?: string;
-    selectedFacets?: SelectedFacets;
-    /**
-     * Whether to show the date picker (above the facets)
-     */
-    showHistogramDatePicker: boolean;
-    /**
-     * Whether placeholder views should be suppressed. If true, searches that produce an
-     * error or empty result set will simply show a blank results view instead of a placeholder.
-     */
-    suppressPlaceholders: boolean;
-    /**
-     * Whether the result count text should be suppressed.
-     * If true, no "X Results" message will be shown.
-     */
-    suppressResultCount: boolean;
-    /**
-     * Whether the scrolling result view should be suppressed entirely.
-     * If true, no infinite scroller (and thus no result tiles) will be rendered.
-     */
-    suppressResultTiles: boolean;
-    /**
-     * Whether to suppress persistence of the query to the URL.
-     * If true, the `query` param will not be added to the URL or updated on query changes.
-     */
-    suppressURLQuery: boolean;
-    /**
-     * Whether to suppress display of the sort bar.
-     * If true, the entire sort bar (incl. display modes) will be omitted from rendering.
-     */
-    suppressSortBar: boolean;
-    /**
-     * Whether to suppress showing the display mode options in the sort bar.
-     * If true, those options will be omitted (though the rest of the sort bar may still render).
-     */
-    suppressDisplayModes: boolean;
-    /**
-     * What strategy to use for when/whether to load facet data for a search.
-     *
-     * Defaults to `eager`, always loading facets immediately alongside search results.
-     *
-     * To eliminate facets that are never seen, this can be reduced to `lazy-mobile`, which
-     * will delay loading facets in the mobile view until the "Filters" accordion is opened.
-     * Facets are still loaded eagerly when viewing the desktop layout.
-     *
-     * To further reduce facet requests for patrons who do not need to use them, this can be
-     * again reduced to `opt-in`, which will also require desktop users to explicitly request
-     * that they be loaded (in addition to the lazy mobile behavior described above).
-     *
-     * To entirely suppress facets from being loaded, this may be set to `off`.
-     */
-    facetLoadStrategy: FacetLoadStrategy;
-    clearResultsOnEmptyQuery: boolean;
-    collectionPagePath: string;
-    /** describes where this component is being used */
-    searchContext: string;
-    pageContext: CollectionBrowserContext;
-    restorationStateHandler: RestorationStateHandlerInterface;
-    mobileBreakpoint: number;
-    loggedIn: boolean;
-    resizeObserver?: SharedResizeObserverInterface;
-    modalManager?: ModalManagerInterface;
-    featureFeedbackService?: FeatureFeedbackServiceInterface;
-    recaptchaManager?: RecaptchaManagerInterface;
-    /**
-     * If item management UI active
-     */
-    isManageView: boolean;
-    manageViewLabel: string;
-    /** Whether to replace the default sort options with a slot for customization (default: false) */
-    enableSortOptionsSlot: boolean;
-    /**
-     * The results per page so we can paginate.
-     *
-     * This allows us to start in the middle of the search results and
-     * fetch data before or after the current page. If we don't have a key
-     * for the previous/next page, we'll fetch the next/previous page to populate it
-     */
-    dataSource: CollectionBrowserDataSourceInterface;
-    /**
-     * The page that the consumer wants to load.
-     */
-    initialPageNumber: number;
-    /**
-     * This the the number of pages that we want to show.
-     *
-     * The data isn't necessarily loaded for all of the pages, but this lets us
-     * know how many cells we should render.
-     */
-    private pagesToRender;
-    /**
-     * Whether the initial page fetch for a new query is currently in progress.
-     */
-    private searchResultsLoading;
-    private facetsLoading;
-    private totalResults?;
-    private mobileView;
-    private collapsibleFacetsVisible;
-    private contentWidth?;
-    private defaultSortField;
-    private defaultSortDirection;
-    private placeholderType;
-    private contentContainer;
-    private leftColumn?;
-    private collectionFacets?;
-    analyticsHandler?: AnalyticsManagerInterface;
-    /** Whether layout size analytics have been sent already. */
-    private layoutSizeAnalyticsSent;
-    /**
-     * When we're animated scrolling to the page, we don't want to fetch
-     * all of the pages as it scrolls so this lets us know if we're scrolling
-     */
-    private isScrollingToCell;
-    /**
-     * When page width resizes from desktop to mobile, set true to
-     * disable expand/collapse transition when loading.
-     */
-    private isResizeToMobile;
-    /**
-     * Flag indicating that a new data source is currently being installed.
-     * During the install, any URL persistence operation should replace the current entry
-     * instead of creating a new one.
-     */
-    private dataSourceInstallInProgress;
-    private leftColIntersectionObserver?;
-    private facetsIntersectionObserver?;
-    private placeholderCellTemplate;
-    constructor();
-    private tileModelAtCellIndex;
-    private get estimatedTileCount();
-    private infiniteScroller?;
-    private sessionIdGenPromise?;
-    /**
-     * Returns a promise resolving to a unique string that persists for the current browser session.
-     * Used in generating unique IDs for search requests, so that multiple requests coming from the
-     * same browser session can be identified.
-     */
-    getSessionId(): Promise<string>;
-    /**
-     * Go to the given page of results
-     *
-     * @param pageNumber
-     */
-    goToPage(pageNumber: number): Promise<void>;
-    /**
-     * Sets the state for whether the initial set of search results is loading in.
-     */
-    setSearchResultsLoading(loading: boolean): void;
-    /**
-     * Sets the state for whether facet data is loading in
-     */
-    setFacetsLoading(loading: boolean): void;
-    /**
-     * Sets the total number of results to be displayed for the current search
-     */
-    setTotalResultCount(totalResults: number): void;
-    /**
-     * Clears all selected/negated facets, date ranges, and letter filters.
-     *
-     * By default, the current sort field/direction are not cleared,
-     * but this can be overridden by setting the `sort` option to `true`.
-     *
-     * Similarly, it is possible to finely control what is cleared by
-     * setting any of the `facets`, `dateRange`, or `letterFilters` flags
-     * in the options object.
-     */
-    clearFilters({ facets, dateRange, letterFilters, sort, }?: {
-        facets?: boolean | undefined;
-        dateRange?: boolean | undefined;
-        letterFilters?: boolean | undefined;
-        sort?: boolean | undefined;
-    }): void;
-    /**
-     * Returns true if the current value of `this.selectedFacets` contains
-     * any facet buckets than have been selected or negated, or false otherwise.
-     */
-    private get hasCheckedFacets();
-    /**
-     * Returns true if there are any currently selected/negated facet buckets,
-     * any selected date range, or any selected letter filters. False otherwise.
-     *
-     * Ignores sorting options.
-     */
-    private get hasActiveFilters();
-    willUpdate(): void;
-    render(): TemplateResult<1>;
-    /**
-     * Determines what type of placeholder content should be shown instead of result tiles, if applicable.
-     * The placeholders indicate states where we have no results to show, which could be the result of:
-     *  - No query is set (on the search page)
-     *  - No results were returned for the most recent search
-     *  - The collection being searched within has no viewable items
-     *  - An error occurred on the most recent search attempt
-     */
-    private setPlaceholderType;
-    /**
-     * Template for the placeholder content to show when no results are available.
-     */
-    private get emptyPlaceholderTemplate();
-    /**
-     * Top-level template for rendering the left (facets) and right (results) columns.
-     */
-    private get collectionBrowserTemplate();
-    /**
-     * Template for either the mobile or desktop version of the left column, depending
-     * on current component state.
-     */
-    private get leftColumnTemplate();
-    /**
-     * Template for the mobile version of the "left column" (which in this case, appears
-     * *above* the search results rather than beside them), for rendering the
-     * accordion-style facets.
-     */
-    private get mobileLeftColumnTemplate();
-    /**
-     * Template for the desktop version of the left column, displaying the facets sidebar.
-     */
-    private get desktopLeftColumnTemplate();
-    /**
-     * Slot which is placed at top of the facets area for user-profile page
-     * - mainly used to render userlists
-     */
-    private get facetTopViewSlot();
-    /**
-     * Template for the "X Results" count at the top of the search results.
-     * Changes to the "Searching..." label if the search results are still loading.
-     */
-    private get resultsCountTemplate();
-    /**
-     * Template for the right column of the collection browser, where the result
-     * tiles and sort/filter bar are shown.
-     */
-    private get rightColumnTemplate();
-    /**
-     * Template for the infinite scroller widget that contains the result tiles.
-     */
-    private get infiniteScrollerTemplate();
-    /**
-     * Produces a `classMap` indicating which classes the infinite scroller should have
-     * given the current display mode & placeholder case.
-     */
-    private get infiniteScrollerClasses();
-    /**
-     * Template for the sort & filtering bar that appears atop the search results.
-     */
-    private get sortFilterBarTemplate();
-    /**
-     * Template for the manage bar UI that appears atop the search results when we are
-     * showing the management view. This generally replaces the sort bar when present.
-     */
-    private get manageBarTemplate();
-    /**
-     * Handler for when the user requests to remove all checked items via the manage bar.
-     * Emits an `itemRemovalRequested` event with all checked tile models.
-     */
-    private handleRemoveItems;
-    /**
-     * Removes all tile models that are currently checked & adjusts the paging
-     * of the data source to account for any new gaps in the data.
-     */
-    removeCheckedTiles(): void;
-    /**
-     * Handler for when the user changes the selected sort option or direction.
-     */
-    private userChangedSort;
-    /**
-     * Fires an analytics event for sorting changes.
-     * @param prevSortDirection Which sort direction was previously set.
-     */
-    private sendSortByAnalytics;
-    /**
-     * Handler for when the selected sort option is updated, whether by the user
-     * themselves or programmatically.
-     */
-    private selectedSortChanged;
-    /**
-     * An object representing the current sort field & direction.
-     */
-    get sortParam(): SortParam | null;
-    /**
-     * Handler for when the display mode option is changed (grid/list/compact-list views).
-     */
-    private displayModeChanged;
-    /**
-     * Returns a query clause identifying the currently selected title filter,
-     * e.g., `firstTitle:X`.
-     */
-    private get titleQuery();
-    /**
-     * Returns a query clause identifying the currently selected creator filter,
-     * e.g., `firstCreator:X`.
-     */
-    private get creatorQuery();
-    /**
-     * Send Analytics when sorting by title's first letter
-     * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
-     */
-    private sendFilterByTitleAnalytics;
-    /**
-     * Send Analytics when filtering by creator's first letter
-     * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
-     */
-    private sendFilterByCreatorAnalytics;
-    /**
-     * Handler for changes to which letter is selected in the title alphabet bar.
-     */
-    private titleLetterSelected;
-    /**
-     * Handler for changes to which letter is selected in the creator alphabet bar.
-     */
-    private creatorLetterSelected;
-    /**
-     * The full template for how the facets should be structured in mobile view,
-     * including the collapsible container (with header) and the facets themselves.
-     */
-    private get mobileFacetsTemplate();
-    /**
-     * The template for the facets component alone, without any surrounding wrappers.
-     */
-    private get facetsTemplate();
-    /**
-     * The HTML template for the "Clear all filters" button, or `nothing` if no
-     * filters are currently active.
-     *
-     * @param mobile Whether to style/shorten the button for mobile view
-     */
-    private clearFiltersBtnTemplate;
-    /**
-     * Template for the table header content that appears atop the compact list view.
-     */
-    private get listHeaderTemplate();
-    /**
-     * Handler for when the date picker's date range is changed.
-     */
-    private histogramDateRangeUpdated;
-    /**
-     * The Lucene query corresponding to the current date range.
-     */
-    private get dateRangeQueryClause();
-    /**
-     * Emits an event indicating a change in whether the manage mode is shown.
-     */
-    private emitManageModeChangedEvent;
-    /**
-     * Installs a new data source component and associated query state parameters into
-     * this component, causing it to efficiently update its views to represent the
-     * newly-provided data. In this way, one can reuse a single instance of
-     * <collection-browser> to handle multiple different sets of search results on
-     * a single page, each set of results being loaded & updated by its own data
-     * source.
-     *
-     * @param dataSource The data source component containing (or prepared to fetch)
-     * the tile data to be displayed.
-     * @param queryState The new query-related state that this component should
-     * represent, such as the search query, sort option, and any filters applied.
-     */
-    installDataSourceAndQueryState(dataSource: CollectionBrowserDataSourceInterface, queryState: CollectionBrowserQueryState): Promise<void>;
-    firstUpdated(): void;
-    /**
-     * Determines the initial size of the content container and whether or not
-     * the mobile layout should be used.
-     */
-    setInitialSize(): void;
-    /**
-     * Fires an analytics event indicating which type of layout was rendered:
-     * mobile or desktop.
-     */
-    private sendLayoutSizeAnalytics;
-    updated(changed: PropertyValues): void;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    handleResize(entry: ResizeObserverEntry): void;
-    /**
-     * Updates the data source with the current state of facet readiness for loading,
-     * so that they will begin to load in at the appropriate time according to the
-     * current facet loading strategy.
-     */
-    private updateFacetReadiness;
-    /**
-     * Sets up listeners for events that may require updating the left column height.
-     */
-    private setupLeftColumnScrollListeners;
-    /**
-     * Sets up listeners to control whether the facet sidebar shows its bottom fade-out.
-     * Note this uses a separate IntersectionObserver from the left column, because we
-     * don't need granular intersection thresholds for this.
-     */
-    private setupFacetsScrollListeners;
-    /**
-     * Updates the height of the left column according to its position on the page.
-     * Arrow function ensures proper `this` binding.
-     */
-    private updateLeftColumnHeight;
-    /**
-     * Toggles whether the fade-out is visible at the bottom of the facets.
-     * It should only be visible if the facets are not scrolled to the bottom.
-     * Arrow function ensures proper `this` binding.
-     */
-    private updateFacetFadeOut;
-    /**
-     * Emits a `baseQueryChanged` event indicating an update to the search query.
-     */
-    private emitBaseQueryChanged;
-    /**
-     * Emits a `searchTypeChanged` event indicating an update to the search type
-     * (e.g., metadata vs. full-text).
-     */
-    private emitSearchTypeChanged;
-    /**
-     * Emits a `queryStateChanged` event indicating that one or more of this component's
-     * properties have changed in a way that could affect the set of search results.
-     */
-    emitQueryStateChanged(): void;
-    /**
-     * Emits an `emptyResults` event indicating that we have received an empty result set
-     * for the most recent query.
-     */
-    emitEmptyResults(): void;
-    private disconnectResizeObserver;
-    private setupResizeObserver;
-    /**
-     * When the visible cells change from the infinite scroller, we want to emit
-     * which page is currently visible so the consumer can update its UI or the URL
-     *
-     * @param e
-     * @returns
-     */
-    private visibleCellsChanged;
-    private initialQueryChangeHappened;
-    private historyPopOccurred;
-    private previousQueryKey?;
-    /**
-     * A Promise which, after each query change, resolves once the fetches for the initial
-     * search have completed. Waits for *both* the hits and aggregations fetches to finish.
-     *
-     * Ensure you await this component's `updateComplete` promise before awaiting this
-     * one, to ensure you do not await an obsolete promise from the previous update.
-     */
-    get initialSearchComplete(): Promise<boolean>;
-    /**
-     * Handler for whenever the component's properties change in a way that may require
-     * fetching new results.
-     */
-    private handleQueryChange;
-    private setupStateRestorationObserver;
-    private boundNavigationHandler?;
-    private historyNavigationHandler;
-    private restoreState;
-    private persistState;
-    /**
-     * Emits a `searchResultsLoadingChanged` event indicating that our loading state has
-     * changed (either we have started loading new results, or we have finished loading them).
-     */
-    private emitSearchResultsLoadingChanged;
-    /**
-     * Handler for when the set of selected facets changes.
-     */
-    facetsChanged(e: CustomEvent<SelectedFacets>): void;
-    /**
-     * Handler for when any facet is selected/unselected/hidden/unhidden.
-     * Fires analytics indicating the type of facet event that took place.
-     */
-    facetClickHandler({ detail: { facetType, bucket, negative }, }: CustomEvent<FacetEventDetails>): void;
-    private scrollToPage;
-    /**
-     * Whether sorting by relevance makes sense for the current state.
-     * Currently equivalent to having a non-empty query.
-     */
-    private get isRelevanceSortAvailable();
-    /**
-     * Sets the total number of tiles displayed in the infinite scroller.
-     */
-    setTileCount(count: number): void;
-    /**
-     * Applies any default sort option for the current collection, by checking
-     * for one in the collection's metadata. If none is found, defaults to sorting
-     * descending by:
-     *  - Date Favorited for fav-* collections
-     *  - Weekly views for all other collections
-     */
-    applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
-    /**
-     * Applies the default sort option for the current profile element
-     */
-    applyDefaultProfileSort(): void;
-    /**
-     * This is useful for determining whether we need to reload the scroller.
-     *
-     * When the fetch completes, we need to reload the scroller if the cells for that
-     * page are visible, but if the page is not currenlty visible, we don't need to reload
-     */
-    get currentVisiblePageNumbers(): number[];
-    /**
-     * Refreshes all visible result cells in the infinite scroller.
-     */
-    refreshVisibleResults(): void;
-    /**
-     * Callback when a result is selected
-     */
-    resultSelected(event: CustomEvent<TileModel>): void;
-    cellForIndex(index: number): TemplateResult | undefined;
-    /**
-     * When the user scrolls near to the bottom of the page, fetch the next page
-     * increase the number of pages to render and start fetching data for the new page
-     */
-    private scrollThresholdReached;
-    static get styles(): import("lit").CSSResult[];
-}
+import { LitElement, PropertyValues, TemplateResult } from 'lit';
+import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
+import type { InfiniteScrollerCellProviderInterface } from '@internetarchive/infinite-scroller';
+import { CollectionExtraInfo, PageElementName, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
+import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
+import '@internetarchive/infinite-scroller';
+import type { ModalManagerInterface } from '@internetarchive/modal-manager';
+import type { FeatureFeedbackServiceInterface } from '@internetarchive/feature-feedback';
+import type { RecaptchaManagerInterface } from '@internetarchive/recaptcha-manager';
+import { SelectedFacets, SortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails, FacetLoadStrategy } from './models';
+import { RestorationStateHandlerInterface } from './restoration-state-handler';
+import type { CollectionBrowserQueryState, CollectionBrowserSearchInterface } from './data-source/collection-browser-query-state';
+import type { CollectionBrowserDataSourceInterface } from './data-source/collection-browser-data-source-interface';
+import './empty-placeholder';
+import './tiles/tile-dispatcher';
+import './tiles/collection-browser-loading-tile';
+import './sort-filter-bar/sort-filter-bar';
+import './manage/manage-bar';
+import './collection-facets';
+import './circular-activity-indicator';
+export declare class CollectionBrowser extends LitElement implements InfiniteScrollerCellProviderInterface, SharedResizeObserverResizeHandlerInterface, CollectionBrowserSearchInterface {
+    baseNavigationUrl?: string;
+    baseImageUrl: string;
+    searchService?: SearchServiceInterface;
+    /**
+     * Which backend should be targeted by searches (e.g., metadata or FTS)
+     */
+    searchType: SearchType;
+    /**
+     * The identifier of the collection that searches should be performed within
+     */
+    withinCollection?: string;
+    /**
+     * The identifier (e.g., @person) of the user whose profile is being searched within
+     */
+    withinProfile?: string;
+    /**
+     * Which section of the profile page searches are for (e.g., uploads, reviews, ...)
+     */
+    profileElement?: PageElementName;
+    /**
+     * The base query to use for all searches, updated to match the current user query.
+     */
+    baseQuery?: string;
+    /**
+     * Which mode to display result tiles in (grid, extended list, or compact list)
+     */
+    displayMode?: CollectionDisplayMode;
+    defaultSortParam: SortParam | null;
+    selectedSort: SortField;
+    selectedTitleFilter: string | null;
+    selectedCreatorFilter: string | null;
+    sortDirection: SortDirection | null;
+    pageSize: number;
+    currentPage?: number;
+    minSelectedDate?: string;
+    maxSelectedDate?: string;
+    selectedFacets?: SelectedFacets;
+    /**
+     * Whether to show the date picker (above the facets)
+     */
+    showHistogramDatePicker: boolean;
+    /**
+     * Whether placeholder views should be suppressed. If true, searches that produce an
+     * error or empty result set will simply show a blank results view instead of a placeholder.
+     */
+    suppressPlaceholders: boolean;
+    /**
+     * Whether the result count text should be suppressed.
+     * If true, no "X Results" message will be shown.
+     */
+    suppressResultCount: boolean;
+    /**
+     * Whether the scrolling result view should be suppressed entirely.
+     * If true, no infinite scroller (and thus no result tiles) will be rendered.
+     */
+    suppressResultTiles: boolean;
+    /**
+     * Whether to suppress persistence of the query to the URL.
+     * If true, the `query` param will not be added to the URL or updated on query changes.
+     */
+    suppressURLQuery: boolean;
+    /**
+     * Whether to suppress display of the sort bar.
+     * If true, the entire sort bar (incl. display modes) will be omitted from rendering.
+     */
+    suppressSortBar: boolean;
+    /**
+     * Whether to suppress showing the display mode options in the sort bar.
+     * If true, those options will be omitted (though the rest of the sort bar may still render).
+     */
+    suppressDisplayModes: boolean;
+    /**
+     * What strategy to use for when/whether to load facet data for a search.
+     *
+     * Defaults to `eager`, always loading facets immediately alongside search results.
+     *
+     * To eliminate facets that are never seen, this can be reduced to `lazy-mobile`, which
+     * will delay loading facets in the mobile view until the "Filters" accordion is opened.
+     * Facets are still loaded eagerly when viewing the desktop layout.
+     *
+     * To further reduce facet requests for patrons who do not need to use them, this can be
+     * again reduced to `opt-in`, which will also require desktop users to explicitly request
+     * that they be loaded (in addition to the lazy mobile behavior described above).
+     *
+     * To entirely suppress facets from being loaded, this may be set to `off`.
+     */
+    facetLoadStrategy: FacetLoadStrategy;
+    clearResultsOnEmptyQuery: boolean;
+    collectionPagePath: string;
+    /** describes where this component is being used */
+    searchContext: string;
+    pageContext: CollectionBrowserContext;
+    restorationStateHandler: RestorationStateHandlerInterface;
+    mobileBreakpoint: number;
+    loggedIn: boolean;
+    resizeObserver?: SharedResizeObserverInterface;
+    modalManager?: ModalManagerInterface;
+    featureFeedbackService?: FeatureFeedbackServiceInterface;
+    recaptchaManager?: RecaptchaManagerInterface;
+    /**
+     * If item management UI active
+     */
+    isManageView: boolean;
+    manageViewLabel: string;
+    /** Whether to replace the default sort options with a slot for customization (default: false) */
+    enableSortOptionsSlot: boolean;
+    /**
+     * The results per page so we can paginate.
+     *
+     * This allows us to start in the middle of the search results and
+     * fetch data before or after the current page. If we don't have a key
+     * for the previous/next page, we'll fetch the next/previous page to populate it
+     */
+    dataSource: CollectionBrowserDataSourceInterface;
+    /**
+     * The page that the consumer wants to load.
+     */
+    initialPageNumber: number;
+    /**
+     * This the the number of pages that we want to show.
+     *
+     * The data isn't necessarily loaded for all of the pages, but this lets us
+     * know how many cells we should render.
+     */
+    private pagesToRender;
+    /**
+     * Whether the initial page fetch for a new query is currently in progress.
+     */
+    private searchResultsLoading;
+    private facetsLoading;
+    private totalResults?;
+    private mobileView;
+    private collapsibleFacetsVisible;
+    private contentWidth?;
+    private defaultSortField;
+    private defaultSortDirection;
+    private placeholderType;
+    private contentContainer;
+    private leftColumn?;
+    private collectionFacets?;
+    analyticsHandler?: AnalyticsManagerInterface;
+    /** Whether layout size analytics have been sent already. */
+    private layoutSizeAnalyticsSent;
+    /**
+     * When we're animated scrolling to the page, we don't want to fetch
+     * all of the pages as it scrolls so this lets us know if we're scrolling
+     */
+    private isScrollingToCell;
+    /**
+     * When page width resizes from desktop to mobile, set true to
+     * disable expand/collapse transition when loading.
+     */
+    private isResizeToMobile;
+    /**
+     * Flag indicating that a new data source is currently being installed.
+     * During the install, any URL persistence operation should replace the current entry
+     * instead of creating a new one.
+     */
+    private dataSourceInstallInProgress;
+    private leftColIntersectionObserver?;
+    private facetsIntersectionObserver?;
+    private placeholderCellTemplate;
+    constructor();
+    private tileModelAtCellIndex;
+    private get estimatedTileCount();
+    private infiniteScroller?;
+    private sessionIdGenPromise?;
+    /**
+     * Returns a promise resolving to a unique string that persists for the current browser session.
+     * Used in generating unique IDs for search requests, so that multiple requests coming from the
+     * same browser session can be identified.
+     */
+    getSessionId(): Promise<string>;
+    /**
+     * Go to the given page of results
+     *
+     * @param pageNumber
+     */
+    goToPage(pageNumber: number): Promise<void>;
+    /**
+     * Sets the state for whether the initial set of search results is loading in.
+     */
+    setSearchResultsLoading(loading: boolean): void;
+    /**
+     * Sets the state for whether facet data is loading in
+     */
+    setFacetsLoading(loading: boolean): void;
+    /**
+     * Sets the total number of results to be displayed for the current search
+     */
+    setTotalResultCount(totalResults: number): void;
+    /**
+     * Clears all selected/negated facets, date ranges, and letter filters.
+     *
+     * By default, the current sort field/direction are not cleared,
+     * but this can be overridden by setting the `sort` option to `true`.
+     *
+     * Similarly, it is possible to finely control what is cleared by
+     * setting any of the `facets`, `dateRange`, or `letterFilters` flags
+     * in the options object.
+     */
+    clearFilters({ facets, dateRange, letterFilters, sort, }?: {
+        facets?: boolean | undefined;
+        dateRange?: boolean | undefined;
+        letterFilters?: boolean | undefined;
+        sort?: boolean | undefined;
+    }): void;
+    /**
+     * Returns true if the current value of `this.selectedFacets` contains
+     * any facet buckets than have been selected or negated, or false otherwise.
+     */
+    private get hasCheckedFacets();
+    /**
+     * Returns true if there are any currently selected/negated facet buckets,
+     * any selected date range, or any selected letter filters. False otherwise.
+     *
+     * Ignores sorting options.
+     */
+    private get hasActiveFilters();
+    willUpdate(): void;
+    render(): TemplateResult<1>;
+    /**
+     * Determines what type of placeholder content should be shown instead of result tiles, if applicable.
+     * The placeholders indicate states where we have no results to show, which could be the result of:
+     *  - No query is set (on the search page)
+     *  - No results were returned for the most recent search
+     *  - The collection being searched within has no viewable items
+     *  - An error occurred on the most recent search attempt
+     */
+    private setPlaceholderType;
+    /**
+     * Template for the placeholder content to show when no results are available.
+     */
+    private get emptyPlaceholderTemplate();
+    /**
+     * Top-level template for rendering the left (facets) and right (results) columns.
+     */
+    private get collectionBrowserTemplate();
+    /**
+     * Template for either the mobile or desktop version of the left column, depending
+     * on current component state.
+     */
+    private get leftColumnTemplate();
+    /**
+     * Template for the mobile version of the "left column" (which in this case, appears
+     * *above* the search results rather than beside them), for rendering the
+     * accordion-style facets.
+     */
+    private get mobileLeftColumnTemplate();
+    /**
+     * Template for the desktop version of the left column, displaying the facets sidebar.
+     */
+    private get desktopLeftColumnTemplate();
+    /**
+     * Slot which is placed at top of the facets area for user-profile page
+     * - mainly used to render userlists
+     */
+    private get facetTopViewSlot();
+    /**
+     * Template for the "X Results" count at the top of the search results.
+     * Changes to the "Searching..." label if the search results are still loading.
+     */
+    private get resultsCountTemplate();
+    /**
+     * Template for the right column of the collection browser, where the result
+     * tiles and sort/filter bar are shown.
+     */
+    private get rightColumnTemplate();
+    /**
+     * Template for the infinite scroller widget that contains the result tiles.
+     */
+    private get infiniteScrollerTemplate();
+    /**
+     * Produces a `classMap` indicating which classes the infinite scroller should have
+     * given the current display mode & placeholder case.
+     */
+    private get infiniteScrollerClasses();
+    /**
+     * Template for the sort & filtering bar that appears atop the search results.
+     */
+    private get sortFilterBarTemplate();
+    /**
+     * Template for the manage bar UI that appears atop the search results when we are
+     * showing the management view. This generally replaces the sort bar when present.
+     */
+    private get manageBarTemplate();
+    /**
+     * Handler for when the user requests to remove all checked items via the manage bar.
+     * Emits an `itemRemovalRequested` event with all checked tile models.
+     */
+    private handleRemoveItems;
+    /**
+     * Removes all tile models that are currently checked & adjusts the paging
+     * of the data source to account for any new gaps in the data.
+     */
+    removeCheckedTiles(): void;
+    /**
+     * Handler for when the user changes the selected sort option or direction.
+     */
+    private userChangedSort;
+    /**
+     * Fires an analytics event for sorting changes.
+     * @param prevSortDirection Which sort direction was previously set.
+     */
+    private sendSortByAnalytics;
+    /**
+     * Handler for when the selected sort option is updated, whether by the user
+     * themselves or programmatically.
+     */
+    private selectedSortChanged;
+    /**
+     * An object representing the current sort field & direction.
+     */
+    get sortParam(): SortParam | null;
+    /**
+     * Handler for when the display mode option is changed (grid/list/compact-list views).
+     */
+    private displayModeChanged;
+    /**
+     * Returns a query clause identifying the currently selected title filter,
+     * e.g., `firstTitle:X`.
+     */
+    private get titleQuery();
+    /**
+     * Returns a query clause identifying the currently selected creator filter,
+     * e.g., `firstCreator:X`.
+     */
+    private get creatorQuery();
+    /**
+     * Send Analytics when sorting by title's first letter
+     * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
+     */
+    private sendFilterByTitleAnalytics;
+    /**
+     * Send Analytics when filtering by creator's first letter
+     * labels: 'start-<ToLetter>' | 'clear-<FromLetter>' | '<FromLetter>-<ToLetter>'
+     */
+    private sendFilterByCreatorAnalytics;
+    /**
+     * Handler for changes to which letter is selected in the title alphabet bar.
+     */
+    private titleLetterSelected;
+    /**
+     * Handler for changes to which letter is selected in the creator alphabet bar.
+     */
+    private creatorLetterSelected;
+    /**
+     * The full template for how the facets should be structured in mobile view,
+     * including the collapsible container (with header) and the facets themselves.
+     */
+    private get mobileFacetsTemplate();
+    /**
+     * The template for the facets component alone, without any surrounding wrappers.
+     */
+    private get facetsTemplate();
+    /**
+     * The HTML template for the "Clear all filters" button, or `nothing` if no
+     * filters are currently active.
+     *
+     * @param mobile Whether to style/shorten the button for mobile view
+     */
+    private clearFiltersBtnTemplate;
+    /**
+     * Template for the table header content that appears atop the compact list view.
+     */
+    private get listHeaderTemplate();
+    /**
+     * Handler for when the date picker's date range is changed.
+     */
+    private histogramDateRangeUpdated;
+    /**
+     * The Lucene query corresponding to the current date range.
+     */
+    private get dateRangeQueryClause();
+    /**
+     * Emits an event indicating a change in whether the manage mode is shown.
+     */
+    private emitManageModeChangedEvent;
+    /**
+     * Installs a new data source component and associated query state parameters into
+     * this component, causing it to efficiently update its views to represent the
+     * newly-provided data. In this way, one can reuse a single instance of
+     * <collection-browser> to handle multiple different sets of search results on
+     * a single page, each set of results being loaded & updated by its own data
+     * source.
+     *
+     * @param dataSource The data source component containing (or prepared to fetch)
+     * the tile data to be displayed.
+     * @param queryState The new query-related state that this component should
+     * represent, such as the search query, sort option, and any filters applied.
+     */
+    installDataSourceAndQueryState(dataSource: CollectionBrowserDataSourceInterface, queryState: CollectionBrowserQueryState): Promise<void>;
+    firstUpdated(): void;
+    /**
+     * Determines the initial size of the content container and whether or not
+     * the mobile layout should be used.
+     */
+    setInitialSize(): void;
+    /**
+     * Fires an analytics event indicating which type of layout was rendered:
+     * mobile or desktop.
+     */
+    private sendLayoutSizeAnalytics;
+    updated(changed: PropertyValues): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    handleResize(entry: ResizeObserverEntry): void;
+    /**
+     * Updates the data source with the current state of facet readiness for loading,
+     * so that they will begin to load in at the appropriate time according to the
+     * current facet loading strategy.
+     */
+    private updateFacetReadiness;
+    /**
+     * Sets up listeners for events that may require updating the left column height.
+     */
+    private setupLeftColumnScrollListeners;
+    /**
+     * Sets up listeners to control whether the facet sidebar shows its bottom fade-out.
+     * Note this uses a separate IntersectionObserver from the left column, because we
+     * don't need granular intersection thresholds for this.
+     */
+    private setupFacetsScrollListeners;
+    /**
+     * Updates the height of the left column according to its position on the page.
+     * Arrow function ensures proper `this` binding.
+     */
+    private updateLeftColumnHeight;
+    /**
+     * Toggles whether the fade-out is visible at the bottom of the facets.
+     * It should only be visible if the facets are not scrolled to the bottom.
+     * Arrow function ensures proper `this` binding.
+     */
+    private updateFacetFadeOut;
+    /**
+     * Emits a `baseQueryChanged` event indicating an update to the search query.
+     */
+    private emitBaseQueryChanged;
+    /**
+     * Emits a `searchTypeChanged` event indicating an update to the search type
+     * (e.g., metadata vs. full-text).
+     */
+    private emitSearchTypeChanged;
+    /**
+     * Emits a `queryStateChanged` event indicating that one or more of this component's
+     * properties have changed in a way that could affect the set of search results.
+     */
+    emitQueryStateChanged(): void;
+    /**
+     * Emits an `emptyResults` event indicating that we have received an empty result set
+     * for the most recent query.
+     */
+    emitEmptyResults(): void;
+    private disconnectResizeObserver;
+    private setupResizeObserver;
+    /**
+     * When the visible cells change from the infinite scroller, we want to emit
+     * which page is currently visible so the consumer can update its UI or the URL
+     *
+     * @param e
+     * @returns
+     */
+    private visibleCellsChanged;
+    private initialQueryChangeHappened;
+    private historyPopOccurred;
+    private previousQueryKey?;
+    /**
+     * A Promise which, after each query change, resolves once the fetches for the initial
+     * search have completed. Waits for *both* the hits and aggregations fetches to finish.
+     *
+     * Ensure you await this component's `updateComplete` promise before awaiting this
+     * one, to ensure you do not await an obsolete promise from the previous update.
+     */
+    get initialSearchComplete(): Promise<boolean>;
+    /**
+     * Handler for whenever the component's properties change in a way that may require
+     * fetching new results.
+     */
+    private handleQueryChange;
+    private setupStateRestorationObserver;
+    private boundNavigationHandler?;
+    private historyNavigationHandler;
+    private restoreState;
+    private persistState;
+    /**
+     * Emits a `searchResultsLoadingChanged` event indicating that our loading state has
+     * changed (either we have started loading new results, or we have finished loading them).
+     */
+    private emitSearchResultsLoadingChanged;
+    /**
+     * Handler for when the set of selected facets changes.
+     */
+    facetsChanged(e: CustomEvent<SelectedFacets>): void;
+    /**
+     * Handler for when any facet is selected/unselected/hidden/unhidden.
+     * Fires analytics indicating the type of facet event that took place.
+     */
+    facetClickHandler({ detail: { facetType, bucket, negative }, }: CustomEvent<FacetEventDetails>): void;
+    private scrollToPage;
+    /**
+     * Whether sorting by relevance makes sense for the current state.
+     * Currently equivalent to having a non-empty query.
+     */
+    private get isRelevanceSortAvailable();
+    /**
+     * Sets the total number of tiles displayed in the infinite scroller.
+     */
+    setTileCount(count: number): void;
+    /**
+     * Applies any default sort option for the current collection, by checking
+     * for one in the collection's metadata. If none is found, defaults to sorting
+     * descending by:
+     *  - Date Favorited for fav-* collections
+     *  - Weekly views for all other collections
+     */
+    applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
+    /**
+     * Applies the default sort option for the current profile element
+     */
+    applyDefaultProfileSort(): void;
+    /**
+     * This is useful for determining whether we need to reload the scroller.
+     *
+     * When the fetch completes, we need to reload the scroller if the cells for that
+     * page are visible, but if the page is not currenlty visible, we don't need to reload
+     */
+    get currentVisiblePageNumbers(): number[];
+    /**
+     * Refreshes all visible result cells in the infinite scroller.
+     */
+    refreshVisibleResults(): void;
+    /**
+     * Callback when a result is selected
+     */
+    resultSelected(event: CustomEvent<TileModel>): void;
+    cellForIndex(index: number): TemplateResult | undefined;
+    /**
+     * When the user scrolls near to the bottom of the page, fetch the next page
+     * increase the number of pages to render and start fetching data for the new page
+     */
+    private scrollThresholdReached;
+    static get styles(): import("lit").CSSResult[];
+}