@internetarchive/collection-browser 2.5.2 → 2.6.1

package/dist/src/models.d.ts

@@ -1,209 +1,211 @@
-import type { MediaType } from '@internetarchive/field-parsers';
-import { AggregationSortType, Review, SearchResult, SortDirection } from '@internetarchive/search-service';
-/**
- * Class for converting & storing raw search results in the correct format for UI tiles.
- */
-export declare class TileModel {
-    averageRating?: number;
-    captureDates?: Date[];
-    checked: boolean;
-    collectionIdentifier?: string;
-    collectionName?: string;
-    collectionFilesCount: number;
-    collections: string[];
-    collectionSize: number;
-    commentCount: number;
-    creator?: string;
-    creators: string[];
-    dateStr?: string;
-    dateAdded?: Date;
-    dateArchived?: Date;
-    datePublished?: Date;
-    dateReviewed?: Date;
-    description?: string;
-    favCount: number;
-    href?: string;
-    identifier?: string;
-    issue?: string;
-    itemCount: number;
-    mediatype: MediaType;
-    review?: Review;
-    source?: string;
-    snippets?: string[];
-    subjects: string[];
-    title: string;
-    viewCount?: number;
-    volume?: string;
-    weeklyViewCount?: number;
-    loginRequired: boolean;
-    contentWarning: boolean;
-    constructor(result: SearchResult);
-    /**
-     * Copies the contents of this TileModel onto a new instance
-     */
-    clone(): TileModel;
-    /**
-     * Determines the appropriate tile flags for the given search result
-     * (login required and/or content warning)
-     */
-    private getFlags;
-}
-export declare type RequestKind = 'full' | 'hits' | 'aggregations';
-export declare type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';
-export declare type TileDisplayMode = 'grid' | 'list-compact' | 'list-detail' | 'list-header';
-/**
- * This is mainly used to set the cookies for the collection display mode.
- *
- * It allows the user to set different modes for different contexts (collection page, search page, etc).
- */
-export declare type CollectionBrowserContext = 'collection' | 'search';
-/**
- * The sort fields shown in the sort filter bar
- */
-export declare enum SortField {
-    'default' = "default",
-    'unrecognized' = "unrecognized",
-    'relevance' = "relevance",
-    'alltimeview' = "alltimeview",
-    'weeklyview' = "weeklyview",
-    'title' = "title",
-    'date' = "date",
-    'datearchived' = "datearchived",
-    'datereviewed' = "datereviewed",
-    'dateadded' = "dateadded",
-    'datefavorited' = "datefavorited",
-    'creator' = "creator"
-}
-export interface SortOption {
-    /**
-     * The SortField enum member corresponding to this option.
-     */
-    field: SortField;
-    /**
-     * The default sort direction to apply when this sort option is first selected.
-     */
-    defaultSortDirection: SortDirection | null;
-    /**
-     * Whether this sort option allows its sort direction to be changed from the default.
-     */
-    canSetDirection: boolean;
-    /**
-     * Whether this sort option may appear in the sort bar.
-     */
-    shownInSortBar: boolean;
-    /**
-     * Whether this sort option should be saved to the URL.
-     * If false, then no `sort` param will be added to the URL when this sort option
-     * is selected.
-     */
-    shownInURL: boolean;
-    /**
-     * Whether this sort option is passed to the search service.
-     * If false, then no sort param will be passed to the search service at all when
-     * this sort option is selected.
-     */
-    handledBySearchService: boolean;
-    /**
-     * The string identifying this sort field to the search service & backend API.
-     */
-    searchServiceKey?: string;
-    /**
-     * The human-readable name to use for this option in the sort bar (if applicable).
-     */
-    displayName: string;
-    /**
-     * A list of URL param keys that should be mapped to this sort option.
-     * E.g., both `title` and `titleSorter` in the URL map to the `SortField.title` option.
-     */
-    urlNames: (string | null | undefined)[];
-}
-export declare const SORT_OPTIONS: Record<SortField, SortOption>;
-/**
- * Returns the SortOption corresponding to the given API sort name, or
- * the "unrecognized" SortOption if none matches.
- */
-export declare function sortOptionFromAPIString(sortName?: string | null): SortOption;
-export declare const defaultProfileElementSorts: Record<string, Exclude<SortField, SortField.default>>;
-/** A union of the fields that permit prefix filtering (e.g., alphabetical filtering) */
-export declare type PrefixFilterType = 'title' | 'creator';
-/** A map from prefixes (e.g., initial letters) to the number of items matching that prefix */
-export declare type PrefixFilterCounts = Record<string, number>;
-/**
- * A map from prefix filter types to the corresponding aggregation keys
- * that are needed to fetch the filter counts from the backend.
- */
-export declare const prefixFilterAggregationKeys: Record<PrefixFilterType, string>;
-/**
- * Different facet loading strategies that can be used with collection browser.
- *  - `eager`: Facet data is always loaded as soon as a search is performed
- *  - `lazy-mobile`: In the desktop layout, functions exactly as `eager`.
- *     In the mobile layout, facet data will only be loaded once the "Filters" accordion is opened.
- *  - `opt-in`: In the desktop layout, facet data will only be loaded after the user presses a "Load Facets" button.
- *     In the mobile layout, functions exactly as `lazy-mobile`.
- *  - `off`: Facet data will never be loaded, and a message will be displayed in place of facets
- *     indicating that they are unavailable.
- */
-export declare type FacetLoadStrategy = 'eager' | 'lazy-mobile' | 'opt-in' | 'off';
-/**
- * Union of the facet types that are available in the sidebar.
- */
-export declare type FacetOption = 'subject' | 'lending' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
-export declare type SelectedFacetState = 'selected' | 'hidden';
-export declare type FacetState = SelectedFacetState | 'none';
-export interface FacetBucket {
-    displayText?: string;
-    key: string;
-    count: number;
-    state: FacetState;
-}
-export interface FacetGroup {
-    title: string;
-    key: FacetOption;
-    buckets: FacetBucket[];
-}
-/**
- * Information about a user interaction event on a facet.
- */
-export declare type FacetEventDetails = {
-    /**
-     * The type of facet that was interacted with (e.g., 'mediatype', 'language', ...).
-     */
-    facetType: FacetOption;
-    /**
-     * The bucket corresponding to the facet that was interacted with, including the
-     * updated state of the facet after the interaction.
-     */
-    bucket: FacetBucket;
-    /**
-     * Whether the interaction occurred on a negative facet.
-     */
-    negative: boolean;
-};
-export declare type FacetValue = string;
-export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
-export declare const getDefaultSelectedFacets: () => SelectedFacets;
-export declare const facetDisplayOrder: FacetOption[];
-export declare const facetTitles: Record<FacetOption, string>;
-/**
- * The default sort type to use for each facet type
- */
-export declare const defaultFacetSort: Record<FacetOption, AggregationSortType>;
-/**
- * The sort type corresponding to facet bucket values, for each facet type
- * (i.e., the opposite of "sort by count" for that type).
- */
-export declare const valueFacetSort: Record<FacetOption, AggregationSortType>;
-export declare type LendingFacetKey = 'is_lendable' | 'is_borrowable' | 'available_to_borrow' | 'is_browsable' | 'available_to_browse' | 'is_readable' | 'available_to_waitlist';
-/**
- * Maps valid lending keys to whether they should be visible in the facet sidebar
- */
-export declare const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean>;
-/**
- * Maps valid, visible lending keys to their facet sidebar display text
- */
-export declare const lendingFacetDisplayNames: Partial<Record<LendingFacetKey, string>>;
-/**
- * A record of which admin-only collections should be suppressed from being displayed
- * as facets or in an item's list of collections.
- */
-export declare const suppressedCollections: Record<string, boolean>;
+import type { MediaType } from '@internetarchive/field-parsers';
+import { AggregationSortType, Review, SearchResult, SortDirection } from '@internetarchive/search-service';
+/**
+ * Class for converting & storing raw search results in the correct format for UI tiles.
+ */
+export declare class TileModel {
+    averageRating?: number;
+    captureDates?: Date[];
+    checked: boolean;
+    collectionIdentifier?: string;
+    collectionName?: string;
+    collectionFilesCount: number;
+    collections: string[];
+    collectionSize: number;
+    commentCount: number;
+    creator?: string;
+    creators: string[];
+    dateStr?: string;
+    dateAdded?: Date;
+    dateArchived?: Date;
+    datePublished?: Date;
+    dateReviewed?: Date;
+    description?: string;
+    favCount: number;
+    href?: string;
+    identifier?: string;
+    issue?: string;
+    itemCount: number;
+    mediatype: MediaType;
+    review?: Review;
+    source?: string;
+    snippets?: string[];
+    subjects: string[];
+    title: string;
+    viewCount?: number;
+    volume?: string;
+    weeklyViewCount?: number;
+    loginRequired: boolean;
+    contentWarning: boolean;
+    constructor(result: SearchResult);
+    /**
+     * Copies the contents of this TileModel onto a new instance
+     */
+    clone(): TileModel;
+    /**
+     * Determines the appropriate tile flags for the given search result
+     * (login required and/or content warning)
+     */
+    private getFlags;
+}
+export declare type RequestKind = 'full' | 'hits' | 'aggregations';
+export declare type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';
+export declare type TileDisplayMode = 'grid' | 'list-compact' | 'list-detail' | 'list-header';
+/**
+ * This is mainly used to set the cookies for the collection display mode.
+ *
+ * It allows the user to set different modes for different contexts (collection page, search page, etc).
+ */
+export declare type CollectionBrowserContext = 'collection' | 'search';
+/**
+ * The sort fields shown in the sort filter bar
+ */
+export declare enum SortField {
+    'default' = "default",
+    'unrecognized' = "unrecognized",
+    'relevance' = "relevance",
+    'alltimeview' = "alltimeview",
+    'weeklyview' = "weeklyview",
+    'title' = "title",
+    'date' = "date",
+    'datearchived' = "datearchived",
+    'datereviewed' = "datereviewed",
+    'dateadded' = "dateadded",
+    'datefavorited' = "datefavorited",
+    'creator' = "creator"
+}
+export interface SortOption {
+    /**
+     * The SortField enum member corresponding to this option.
+     */
+    field: SortField;
+    /**
+     * The default sort direction to apply when this sort option is first selected.
+     */
+    defaultSortDirection: SortDirection | null;
+    /**
+     * Whether this sort option allows its sort direction to be changed from the default.
+     */
+    canSetDirection: boolean;
+    /**
+     * Whether this sort option may appear in the sort bar.
+     */
+    shownInSortBar: boolean;
+    /**
+     * Whether this sort option should be saved to the URL.
+     * If false, then no `sort` param will be added to the URL when this sort option
+     * is selected.
+     */
+    shownInURL: boolean;
+    /**
+     * Whether this sort option is passed to the search service.
+     * If false, then no sort param will be passed to the search service at all when
+     * this sort option is selected.
+     */
+    handledBySearchService: boolean;
+    /**
+     * The string identifying this sort field to the search service & backend API.
+     */
+    searchServiceKey?: string;
+    /**
+     * The human-readable name to use for this option in the sort bar (if applicable).
+     */
+    displayName: string;
+    /**
+     * A list of URL param keys that should be mapped to this sort option.
+     * E.g., both `title` and `titleSorter` in the URL map to the `SortField.title` option.
+     */
+    urlNames: (string | null | undefined)[];
+}
+export declare const SORT_OPTIONS: Record<SortField, SortOption>;
+/**
+ * Returns the SortOption corresponding to the given API sort name, or
+ * the "unrecognized" SortOption if none matches.
+ */
+export declare function sortOptionFromAPIString(sortName?: string | null): SortOption;
+export declare const defaultProfileElementSorts: Record<string, Exclude<SortField, SortField.default>>;
+/** A union of the fields that permit prefix filtering (e.g., alphabetical filtering) */
+export declare type PrefixFilterType = 'title' | 'creator';
+/** A map from prefixes (e.g., initial letters) to the number of items matching that prefix */
+export declare type PrefixFilterCounts = Record<string, number>;
+/**
+ * A map from prefix filter types to the corresponding aggregation keys
+ * that are needed to fetch the filter counts from the backend.
+ */
+export declare const prefixFilterAggregationKeys: Record<PrefixFilterType, string>;
+/**
+ * Different facet loading strategies that can be used with collection browser.
+ *  - `eager`: Facet data is always loaded as soon as a search is performed
+ *  - `lazy-mobile`: In the desktop layout, functions exactly as `eager`.
+ *     In the mobile layout, facet data will only be loaded once the "Filters" accordion is opened.
+ *  - `opt-in-or-login`: Same as `opt-in` for guest users not logged into an account, but same as `eager` for
+ *     any logged in user.
+ *  - `opt-in`: In the desktop layout, facet data will only be loaded after the user presses a "Load Facets" button.
+ *     In the mobile layout, functions exactly as `lazy-mobile`.
+ *  - `off`: Facet data will never be loaded, and a message will be displayed in place of facets
+ *     indicating that they are unavailable.
+ */
+export declare type FacetLoadStrategy = 'eager' | 'lazy-mobile' | 'opt-in-or-login' | 'opt-in' | 'off';
+/**
+ * Union of the facet types that are available in the sidebar.
+ */
+export declare type FacetOption = 'subject' | 'lending' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
+export declare type SelectedFacetState = 'selected' | 'hidden';
+export declare type FacetState = SelectedFacetState | 'none';
+export interface FacetBucket {
+    displayText?: string;
+    key: string;
+    count: number;
+    state: FacetState;
+}
+export interface FacetGroup {
+    title: string;
+    key: FacetOption;
+    buckets: FacetBucket[];
+}
+/**
+ * Information about a user interaction event on a facet.
+ */
+export declare type FacetEventDetails = {
+    /**
+     * The type of facet that was interacted with (e.g., 'mediatype', 'language', ...).
+     */
+    facetType: FacetOption;
+    /**
+     * The bucket corresponding to the facet that was interacted with, including the
+     * updated state of the facet after the interaction.
+     */
+    bucket: FacetBucket;
+    /**
+     * Whether the interaction occurred on a negative facet.
+     */
+    negative: boolean;
+};
+export declare type FacetValue = string;
+export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
+export declare const getDefaultSelectedFacets: () => SelectedFacets;
+export declare const facetDisplayOrder: FacetOption[];
+export declare const facetTitles: Record<FacetOption, string>;
+/**
+ * The default sort type to use for each facet type
+ */
+export declare const defaultFacetSort: Record<FacetOption, AggregationSortType>;
+/**
+ * The sort type corresponding to facet bucket values, for each facet type
+ * (i.e., the opposite of "sort by count" for that type).
+ */
+export declare const valueFacetSort: Record<FacetOption, AggregationSortType>;
+export declare type LendingFacetKey = 'is_lendable' | 'is_borrowable' | 'available_to_borrow' | 'is_browsable' | 'available_to_browse' | 'is_readable' | 'available_to_waitlist';
+/**
+ * Maps valid lending keys to whether they should be visible in the facet sidebar
+ */
+export declare const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean>;
+/**
+ * Maps valid, visible lending keys to their facet sidebar display text
+ */
+export declare const lendingFacetDisplayNames: Partial<Record<LendingFacetKey, string>>;
+/**
+ * A record of which admin-only collections should be suppressed from being displayed
+ * as facets or in an item's list of collections.
+ */
+export declare const suppressedCollections: Record<string, boolean>;