@internetarchive/collection-browser 3.3.2 → 3.3.3

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

@@ -0,0 +1,113 @@
+import { LitElement, PropertyValues, TemplateResult } from 'lit';
+import { Aggregation, AggregationSortType, FilterMap, SearchServiceInterface, SearchType } from '@internetarchive/search-service';
+import '@internetarchive/histogram-date-range';
+import '@internetarchive/feature-feedback';
+import { ModalManagerInterface } from '@internetarchive/modal-manager';
+import type { FeatureFeedbackServiceInterface } from '@internetarchive/feature-feedback';
+import type { RecaptchaManagerInterface } from '@internetarchive/recaptcha-manager';
+import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
+import type { SharedResizeObserverInterface } from '@internetarchive/shared-resize-observer';
+import { FacetOption, SelectedFacets, FacetGroup } from './models';
+import type { CollectionTitles, PageSpecifierParams, TVChannelAliases } from './data-source/models';
+import '@internetarchive/histogram-date-range';
+import './collection-facets/more-facets-content';
+import './collection-facets/facets-template';
+import './collection-facets/facet-tombstone-row';
+import './expanded-date-picker';
+export declare class CollectionFacets extends LitElement {
+    searchService?: SearchServiceInterface;
+    searchType?: SearchType;
+    aggregations?: Record<string, Aggregation>;
+    histogramAggregation?: Aggregation;
+    minSelectedDate?: string;
+    maxSelectedDate?: string;
+    moreLinksVisible: boolean;
+    facetsLoading: boolean;
+    histogramAggregationLoading: boolean;
+    selectedFacets?: SelectedFacets;
+    collapsableFacets: boolean;
+    contentWidth?: number;
+    showHistogramDatePicker: boolean;
+    allowExpandingDatePicker: boolean;
+    suppressMediatypeFacets: boolean;
+    query?: string;
+    identifiers?: string[];
+    pageSpecifierParams?: PageSpecifierParams;
+    parentCollections: string[];
+    filterMap?: FilterMap;
+    baseNavigationUrl?: string;
+    collectionPagePath: string;
+    isManageView: boolean;
+    isTvSearch: boolean;
+    facetDisplayOrder: FacetOption[];
+    modalManager?: ModalManagerInterface;
+    resizeObserver?: SharedResizeObserverInterface;
+    featureFeedbackService?: FeatureFeedbackServiceInterface;
+    recaptchaManager?: RecaptchaManagerInterface;
+    analyticsHandler?: AnalyticsManagerInterface;
+    collectionTitles?: CollectionTitles;
+    tvChannelAliases?: TVChannelAliases;
+    openFacets: Record<FacetOption, boolean>;
+    /**
+     * Maximum # of facet buckets to render per facet group
+     */
+    private allowedFacetCount;
+    render(): TemplateResult<1>;
+    private get collectionPartOfTemplate();
+    private partOfCollectionClicked;
+    /**
+     * Properties to pass into the date-picker histogram component
+     */
+    private get histogramProps();
+    /**
+     * Opens a modal dialog containing an enlarged version of the date picker.
+     */
+    private showDatePickerModal;
+    private handleExpandedDatePickerClosed;
+    updated(changed: PropertyValues): void;
+    private dispatchFacetsChangedEvent;
+    /**
+     * Template for the "Expand" button to show the date picker modal, or
+     * `nothing` if that button should currently not be shown.
+     */
+    private get expandDatePickerBtnTemplate();
+    private get histogramTemplate();
+    /**
+     * Dispatches a `histogramDateRangeUpdated` event with the date range copied from the
+     * input event.
+     *
+     * Arrow function to ensure `this` is always bound to the current component.
+     */
+    private histogramDateRangeUpdated;
+    /**
+     * Combines the selected facets with the aggregations to create a single list of facets
+     */
+    private get mergedFacets();
+    /**
+     * Converts the selected facets to a `FacetGroup` array,
+     * which is easier to work with
+     */
+    private get selectedFacetGroups();
+    /**
+     * Converts the raw `aggregations` to `FacetGroups`, which are easier to use
+     */
+    private get aggregationFacetGroups();
+    /**
+     * Generate the template for a facet group with a header and the collapsible
+     * chevron for the mobile view
+     */
+    private getFacetGroupTemplate;
+    private getTombstoneFacetGroupTemplate;
+    /**
+     * Generate the More... link button just below the facets group
+     *
+     * TODO: want to fire analytics?
+     */
+    private searchMoreFacetsLink;
+    showMoreFacetsModal(facetGroup: FacetGroup, sortedBy: AggregationSortType): Promise<void>;
+    /**
+     * Generate the list template for each bucket in a facet group
+     */
+    private getFacetTemplate;
+    static get styles(): import("lit").CSSResult[];
+}