@internetarchive/collection-browser 1.14.17 → 2.0.0

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

@@ -1,37 +1,38 @@
 import { LitElement, PropertyValues, TemplateResult } from 'lit';
 import type { InfiniteScrollerCellProviderInterface } from '@internetarchive/infinite-scroller';
-import { CollectionExtraInfo, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
+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 { CollectionNameCacheInterface } from '@internetarchive/collection-name-cache';
 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 } 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';
-import { SelectedFacets, SortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails } from './models';
-import { RestorationStateHandlerInterface } from './restoration-state-handler';
-import './empty-placeholder';
-export declare class CollectionBrowser extends LitElement implements InfiniteScrollerCellProviderInterface, SharedResizeObserverResizeHandlerInterface {
+export declare class CollectionBrowser extends LitElement implements InfiniteScrollerCellProviderInterface, SharedResizeObserverResizeHandlerInterface, CollectionBrowserSearchInterface {
     baseNavigationUrl?: string;
     baseImageUrl: string;
     searchService?: SearchServiceInterface;
     searchType: SearchType;
     withinCollection?: string;
+    withinProfile?: string;
+    profileElement?: PageElementName;
     baseQuery?: string;
     displayMode?: CollectionDisplayMode;
-    sortParam: SortParam | null;
     defaultSortParam: SortParam | null;
     selectedSort: SortField;
     selectedTitleFilter: string | null;
     selectedCreatorFilter: string | null;
     sortDirection: SortDirection | null;
     pageSize: number;
-    resizeObserver?: SharedResizeObserverInterface;
     currentPage?: number;
     minSelectedDate?: string;
     maxSelectedDate?: string;
@@ -39,18 +40,18 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     showHistogramDatePicker: boolean;
     suppressPlaceholders: boolean;
     suppressResultCount: boolean;
+    suppressURLQuery: boolean;
     suppressFacets: boolean;
+    suppressSortBar: boolean;
     clearResultsOnEmptyQuery: boolean;
     collectionPagePath: string;
-    collectionInfo?: CollectionExtraInfo;
-    parentCollections: string[];
     /** describes where this component is being used */
     searchContext: string;
-    collectionNameCache?: CollectionNameCacheInterface;
     pageContext: CollectionBrowserContext;
     restorationStateHandler: RestorationStateHandlerInterface;
     mobileBreakpoint: number;
     loggedIn: boolean;
+    resizeObserver?: SharedResizeObserverInterface;
     modalManager?: ModalManagerInterface;
     featureFeedbackService?: FeatureFeedbackServiceInterface;
     recaptchaManager?: RecaptchaManagerInterface;
@@ -59,10 +60,18 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      */
     isManageView: boolean;
     isLoansTab: 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.
      */
-    private initialPageNumber;
+    initialPageNumber: number;
     /**
      * This the the number of pages that we want to show.
      *
@@ -75,18 +84,13 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      */
     private searchResultsLoading;
     private facetsLoading;
-    private fullYearAggregationLoading;
-    private aggregations?;
-    private fullYearsHistogramAggregation;
     private totalResults?;
-    private queryErrorMessage?;
     private mobileView;
     private mobileFacetsVisible;
     private contentWidth?;
     private defaultSortField;
     private defaultSortDirection;
     private placeholderType;
-    private prefixFilterCountMap;
     private contentContainer;
     private leftColumn?;
     private collectionFacets?;
@@ -96,10 +100,6 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      * all of the pages as it scrolls so this lets us know if we're scrolling
      */
     private isScrollingToCell;
-    /**
-     * When we've reached the end of the data, stop trying to fetch more
-     */
-    private endOfDataReached;
     /**
      * When page width resizes from desktop to mobile, set true to
      * disable expand/collapse transition when loading.
@@ -108,17 +108,9 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     private leftColIntersectionObserver?;
     private facetsIntersectionObserver?;
     private placeholderCellTemplate;
+    constructor();
     private tileModelAtCellIndex;
-    private get sortFilterQueries();
     private get estimatedTileCount();
-    /**
-     * 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
-     */
-    private dataSource;
     /**
      * How many tiles to offset the data source by, to account for any removed tiles.
      */
@@ -130,13 +122,25 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      * Used in generating unique IDs for search requests, so that multiple requests coming from the
      * same browser session can be identified.
      */
-    private getSessionId;
+    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.
      *
@@ -216,40 +220,10 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      * of the data source to account for any new gaps in the data.
      */
     removeCheckedTiles(): void;
-    /**
-     * Checks every tile's management checkbox
-     */
-    checkAllTiles(): void;
-    /**
-     * Unchecks every tile's management checkbox
-     */
-    uncheckAllTiles(): void;
-    /**
-     * Applies the given map function to all of the tile models in every page of the data
-     * source. This method updates the data source object in immutable fashion.
-     *
-     * @param mapFn A callback function to apply on each tile model, as with Array.map
-     */
-    private mapDataSource;
-    /**
-     * An array of all the tile models whose management checkboxes are checked
-     */
-    get checkedTileModels(): TileModel[];
-    /**
-     * An array of all the tile models whose management checkboxes are unchecked
-     */
-    get uncheckedTileModels(): TileModel[];
-    /**
-     * Returns a flattened, filtered array of all the tile models in the data source
-     * for which the given predicate returns a truthy value.
-     *
-     * @param predicate A callback function to apply on each tile model, as with Array.filter
-     * @returns A filtered array of tile models satisfying the predicate
-     */
-    private getFilteredTileModels;
     private userChangedSort;
     private sendSortByAnalytics;
     private selectedSortChanged;
+    get sortParam(): SortParam | null;
     private displayModeChanged;
     /**
      * Returns a query clause identifying the currently selected title filter,
@@ -303,6 +277,7 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      * Emits an event indicating a change in whether the manage mode is shown.
      */
     private emitManageModeChangedEvent;
+    installDataSourceAndQueryState(dataSource: CollectionBrowserDataSourceInterface, queryState: CollectionBrowserQueryState): Promise<void>;
     firstUpdated(): void;
     updated(changed: PropertyValues): void;
     disconnectedCallback(): void;
@@ -330,7 +305,8 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     private updateFacetFadeOut;
     private emitBaseQueryChanged;
     private emitSearchTypeChanged;
-    private emitEmptyResults;
+    emitQueryStateChanged(): void;
+    emitEmptyResults(): void;
     private disconnectResizeObserver;
     private setupResizeObserver;
     /**
@@ -344,15 +320,6 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     private initialQueryChangeHappened;
     private historyPopOccurred;
     private previousQueryKey?;
-    /**
-     * Internal property to store the `resolve` function for the most recent
-     * `initialSearchComplete` promise, allowing us to resolve it at the appropriate time.
-     */
-    private _initialSearchCompleteResolver;
-    /**
-     * Internal property to store the private value backing the `initialSearchComplete` getter.
-     */
-    private _initialSearchCompletePromise;
     /**
      * 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.
@@ -367,60 +334,9 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     private historyNavigationHandler;
     private restoreState;
     private persistState;
-    private doInitialPageFetch;
     private emitSearchResultsLoadingChanged;
-    /**
-     * Produces a compact unique ID for a search request that can help with debugging
-     * on the backend by making related requests easier to trace through different services.
-     * (e.g., tying the hits/aggregations requests for the same page back to a single hash).
-     *
-     * @param params The search service parameters for the request
-     * @param kind The kind of request (hits-only, aggregations-only, or both)
-     * @returns A Promise resolving to the uid to apply to the request
-     */
-    private requestUID;
-    /**
-     * Constructs a search service FilterMap object from the combination of
-     * all the currently-applied filters. This includes any facets, letter
-     * filters, and date range.
-     */
-    private get filterMap();
-    /** The full query, including year facets and date range clauses */
-    private get fullQuery();
-    /**
-     * Generates a query string for the given facets
-     *
-     * Example: `mediatype:("collection" OR "audio" OR -"etree") AND year:("2000" OR "2001")`
-     */
-    private get facetQuery();
-    /**
-     * Builds an OR-joined facet clause for the given facet name and values.
-     *
-     * E.g., for name `subject` and values
-     * `{ foo: { state: 'selected' }, bar: { state: 'hidden' } }`
-     * this will produce the clause
-     * `subject:("foo" OR -"bar")`.
-     *
-     * @param facetName The facet type (e.g., 'collection')
-     * @param facetValues The facet buckets, mapped by their keys
-     */
-    private buildFacetClause;
-    /**
-     * Handles some special pre-request normalization steps for certain facet types
-     * that require them.
-     *
-     * @param facetName The name of the facet type (e.g., 'language')
-     * @param facetValues An array of values for that facet type
-     */
-    private prepareFacetForFetch;
-    /**
-     * Takes an array of facet clauses, and combines them into a
-     * full AND-joined facet query string. Empty clauses are ignored.
-     */
-    private joinFacetClauses;
     facetsChanged(e: CustomEvent<SelectedFacets>): void;
     facetClickHandler({ detail: { facetType, bucket, negative }, }: CustomEvent<FacetEventDetails>): void;
-    private fetchFacets;
     private scrollToPage;
     /**
      * Whether sorting by relevance makes sense for the current state.
@@ -428,48 +344,9 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      */
     private get isRelevanceSortAvailable();
     /**
-     * Whether a search may be performed in the current state of the component.
-     * This is only true if the search service is defined, and either
-     *   (a) a non-empty query is set, or
-     *   (b) we are on a collection page in metadata search mode.
+     * Sets the total number of tiles displayed in the infinite scroller.
      */
-    private get canPerformSearch();
-    /**
-     * Additional params to pass to the search service if targeting a collection page,
-     * or null otherwise.
-     */
-    private get collectionParams();
-    /**
-     * The query key is a string that uniquely identifies the current search.
-     * It consists of:
-     *  - The current base query
-     *  - The current collection
-     *  - The current search type
-     *  - Any currently-applied facets
-     *  - Any currently-applied date range
-     *  - Any currently-applied prefix filters
-     *  - The current sort options
-     *
-     * This lets us keep track of queries so we don't persist data that's
-     * no longer relevant.
-     */
-    private get pageFetchQueryKey();
-    /**
-     * Similar to `pageFetchQueryKey` above, but excludes sort fields since they
-     * are not relevant in determining aggregation queries.
-     */
-    private get facetFetchQueryKey();
-    private pageFetchesInProgress;
-    /**
-     * Fetches one or more pages of results and updates the data source.
-     *
-     * @param pageNumber The page number to fetch
-     * @param numInitialPages If this is an initial page fetch (`pageNumber = 1`),
-     *  specifies how many pages to batch together in one request. Ignored
-     *  if `pageNumber != 1`, defaulting to a single page.
-     */
-    fetchPage(pageNumber: number, numInitialPages?: number): Promise<void>;
-    private preloadCollectionNames;
+    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
@@ -477,50 +354,22 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      *  - Date Favorited for fav-* collections
      *  - Weekly views for all other collections
      */
-    private applyDefaultCollectionSort;
+    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
      */
-    private get currentVisiblePageNumbers();
+    get currentVisiblePageNumbers(): number[];
     /**
-     * Update the datasource from the fetch response
-     *
-     * @param pageNumber
-     * @param results
-     */
-    private updateDataSource;
-    private getMediatype;
-    /**
-     * Returns the input string, but removing one set of quotes from all instances of
-     * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
-     * URL-encoded.
-     *
-     * This should be a temporary measure to address the fact that the __href__ field
-     * sometimes acquires extra quotation marks during query rewriting. Once there is a
-     * full Lucene parser in place that handles quoted queries correctly, this can likely
-     * be removed.
-     */
-    private collapseRepeatedQuotes;
-    /** Fetches the aggregation buckets for the given prefix filter type. */
-    private fetchPrefixFilterBuckets;
-    /** Fetches and caches the prefix filter counts for the given filter type. */
-    private updatePrefixFilterCounts;
-    /**
-     * Fetches and caches the prefix filter counts for the current sort type,
-     * provided it is one that permits prefix filtering. (If not, this does nothing).
-     */
-    private updatePrefixFiltersForCurrentSort;
-    /**
-     * Clears the cached letter counts for both title and creator, and
-     * fetches a new set of counts for whichever of them is the currently
-     * selected sort option (which may be neither).
-     *
-     * Call this whenever the counts are invalidated (e.g., by a query change).
+     * Refreshes all visible result cells in the infinite scroller.
      */
-    private refreshLetterCounts;
+    refreshVisibleResults(): void;
     /**
      * Callback when a result is selected
      */