@internetarchive/collection-browser 1.8.0 → 1.9.0-alpha1

package/dist/src/mediatype/mediatype-config.d.ts

@@ -1,3 +1,3 @@
-export declare const mediatypeConfig: {
-    [key: string]: any;
-};
+export declare const mediatypeConfig: {
+    [key: string]: any;
+};

package/dist/src/mediatype/mediatype-config.js

@@ -1,86 +1,86 @@
-import { accountIcon } from '../assets/img/icons/mediatype/account';
-import { audioIcon } from '../assets/img/icons/mediatype/audio';
-import { collectionIcon } from '../assets/img/icons/mediatype/collection';
-import { dataIcon } from '../assets/img/icons/mediatype/data';
-import { etreeIcon } from '../assets/img/icons/mediatype/etree';
-import { imagesIcon } from '../assets/img/icons/mediatype/images';
-import { filmIcon } from '../assets/img/icons/mediatype/film';
-import { radioIcon } from '../assets/img/icons/mediatype/radio';
-import { softwareIcon } from '../assets/img/icons/mediatype/software';
-import { textsIcon } from '../assets/img/icons/mediatype/texts';
-import { tvIcon } from '../assets/img/icons/mediatype/tv';
-import { videoIcon } from '../assets/img/icons/mediatype/video';
-import { webIcon } from '../assets/img/icons/mediatype/web';
-export const mediatypeConfig = {
-    account: {
-        color: '#000000',
-        icon: accountIcon,
-        text: 'Account',
-    },
-    audio: {
-        color: '#00adef',
-        icon: audioIcon,
-        text: 'Audio',
-    },
-    collection: {
-        color: '#4666ff',
-        icon: collectionIcon,
-        text: 'Collection',
-    },
-    data: {
-        color: '#333333',
-        icon: dataIcon,
-        text: 'Data',
-    },
-    etree: {
-        color: '#00adef',
-        icon: etreeIcon,
-        text: 'E-tree',
-    },
-    film: {
-        color: '#bf1b2c',
-        icon: filmIcon,
-        text: 'Film',
-    },
-    image: {
-        color: '#aa99c9',
-        icon: imagesIcon,
-        text: 'Image',
-    },
-    movies: {
-        color: '#f1644b',
-        icon: filmIcon,
-        text: 'Movie',
-    },
-    radio: {
-        color: '#8fdaef',
-        icon: radioIcon,
-        text: 'Radio',
-    },
-    software: {
-        color: '#9ecc4f',
-        icon: softwareIcon,
-        text: 'Software',
-    },
-    texts: {
-        color: '#faab3c',
-        icon: textsIcon,
-        text: 'Text',
-    },
-    tv: {
-        color: '#f1644b',
-        icon: tvIcon,
-        text: 'TV',
-    },
-    video: {
-        color: '#f1644b',
-        icon: videoIcon,
-        text: 'Video',
-    },
-    web: {
-        color: '#ffcd27',
-        icon: webIcon,
-        text: 'Web',
-    },
-};
+import { accountIcon } from '../assets/img/icons/mediatype/account';
+import { audioIcon } from '../assets/img/icons/mediatype/audio';
+import { collectionIcon } from '../assets/img/icons/mediatype/collection';
+import { dataIcon } from '../assets/img/icons/mediatype/data';
+import { etreeIcon } from '../assets/img/icons/mediatype/etree';
+import { imagesIcon } from '../assets/img/icons/mediatype/images';
+import { filmIcon } from '../assets/img/icons/mediatype/film';
+import { radioIcon } from '../assets/img/icons/mediatype/radio';
+import { softwareIcon } from '../assets/img/icons/mediatype/software';
+import { textsIcon } from '../assets/img/icons/mediatype/texts';
+import { tvIcon } from '../assets/img/icons/mediatype/tv';
+import { videoIcon } from '../assets/img/icons/mediatype/video';
+import { webIcon } from '../assets/img/icons/mediatype/web';
+export const mediatypeConfig = {
+    account: {
+        color: '#000000',
+        icon: accountIcon,
+        text: 'Account',
+    },
+    audio: {
+        color: '#00adef',
+        icon: audioIcon,
+        text: 'Audio',
+    },
+    collection: {
+        color: '#4666ff',
+        icon: collectionIcon,
+        text: 'Collection',
+    },
+    data: {
+        color: '#333333',
+        icon: dataIcon,
+        text: 'Data',
+    },
+    etree: {
+        color: '#00adef',
+        icon: etreeIcon,
+        text: 'E-tree',
+    },
+    film: {
+        color: '#bf1b2c',
+        icon: filmIcon,
+        text: 'Film',
+    },
+    image: {
+        color: '#aa99c9',
+        icon: imagesIcon,
+        text: 'Image',
+    },
+    movies: {
+        color: '#f1644b',
+        icon: filmIcon,
+        text: 'Movie',
+    },
+    radio: {
+        color: '#8fdaef',
+        icon: radioIcon,
+        text: 'Radio',
+    },
+    software: {
+        color: '#9ecc4f',
+        icon: softwareIcon,
+        text: 'Software',
+    },
+    texts: {
+        color: '#faab3c',
+        icon: textsIcon,
+        text: 'Text',
+    },
+    tv: {
+        color: '#f1644b',
+        icon: tvIcon,
+        text: 'TV',
+    },
+    video: {
+        color: '#f1644b',
+        icon: videoIcon,
+        text: 'Video',
+    },
+    web: {
+        color: '#ffcd27',
+        icon: webIcon,
+        text: 'Web',
+    },
+};
 //# sourceMappingURL=mediatype-config.js.map

package/dist/src/models.d.ts

@@ -1,149 +1,162 @@
-import type { MediaType } from '@internetarchive/field-parsers';
-import { AggregationSortType, SortDirection } from '@internetarchive/search-service';
-export interface TileModel {
-    averageRating?: number;
-    collectionIdentifier?: string;
-    collectionName?: string;
-    collectionFilesCount: number;
-    collections: string[];
-    collectionSize: number;
-    commentCount: number;
-    creator?: string;
-    creators: string[];
-    dateAdded?: Date;
-    dateArchived?: Date;
-    datePublished?: Date;
-    dateReviewed?: Date;
-    description?: string;
-    favCount: number;
-    href?: string;
-    identifier: string;
-    issue?: string;
-    itemCount: number;
-    mediatype: MediaType;
-    source?: string;
-    snippets?: string[];
-    subjects: string[];
-    title: string;
-    viewCount: number;
-    volume?: string;
-    weeklyViewCount?: number;
-    loginRequired: boolean;
-    contentWarning: boolean;
-}
-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",
-    'relevance' = "relevance",
-    'alltimeview' = "alltimeview",
-    'weeklyview' = "weeklyview",
-    'title' = "title",
-    'date' = "date",
-    'datearchived' = "datearchived",
-    'datereviewed' = "datereviewed",
-    'dateadded' = "dateadded",
-    'creator' = "creator"
-}
-/**
- * The metadata fields we sort by that map to the SortFields above
- */
-export declare type MetadataSortField = 'downloads' | 'week' | 'titleSorter' | 'date' | 'creatorSorter' | 'publicdate' | 'reviewdate' | 'addeddate';
-/**
- * All sort strings recognized in search URLs
- */
-export declare type URLSortField = MetadataSortField | 'title' | 'creator';
-export declare const SortFieldDisplayName: {
-    [key in SortField]: string;
-};
-export declare const DefaultSortDirection: {
-    [key in SortField]: SortDirection | null;
-};
-/**
- * Maps the SortField above to the corresponding Metadata field in the API.
- */
-export declare const SortFieldToMetadataField: {
-    [key in SortField]: MetadataSortField | null;
-};
-/**
- * Maps the Metadata field to the corresponding SortField field in the API.
- */
-export declare const MetadataFieldToSortField: {
-    [key in MetadataSortField]: SortField;
-};
-/**
- * Maps the Metadata fields to how they should be presented in URLs.
- */
-export declare const MetadataFieldToURLField: {
-    [key in MetadataSortField]: URLSortField;
-};
-/**
- * Maps all allowable sort strings from the URL to their respective
- * sort fields.
- */
-export declare const URLFieldToSortField: Record<URLSortField, SortField>;
-/** 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>;
-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[];
-}
-export declare type FacetEventDetails = {
-    key: FacetOption;
-    state: FacetState;
-    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, SortDirection } from '@internetarchive/search-service';
+export interface TileModel {
+    averageRating?: number;
+    collectionIdentifier?: string;
+    collectionName?: string;
+    collectionFilesCount: number;
+    collections: string[];
+    collectionSize: number;
+    commentCount: number;
+    creator?: string;
+    creators: string[];
+    dateAdded?: Date;
+    dateArchived?: Date;
+    datePublished?: Date;
+    dateReviewed?: Date;
+    description?: string;
+    favCount: number;
+    href?: string;
+    identifier: string;
+    issue?: string;
+    itemCount: number;
+    mediatype: MediaType;
+    source?: string;
+    snippets?: string[];
+    subjects: string[];
+    title: string;
+    viewCount: number;
+    volume?: string;
+    weeklyViewCount?: number;
+    loginRequired: boolean;
+    contentWarning: boolean;
+}
+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",
+    '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;
+/** 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>;
+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[];
+}
+export declare type FacetEventDetails = {
+    key: FacetOption;
+    state: FacetState;
+    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>;