@internetarchive/collection-browser 1.7.1-alpha.0 → 1.9.0-alpha1

package/dist/src/models.js

@@ -1,196 +1,257 @@
-import { AggregationSortType, } from '@internetarchive/search-service';
-/**
- * The sort fields shown in the sort filter bar
- */
-export var SortField;
-(function (SortField) {
-    SortField["default"] = "default";
-    SortField["relevance"] = "relevance";
-    SortField["alltimeview"] = "alltimeview";
-    SortField["weeklyview"] = "weeklyview";
-    SortField["title"] = "title";
-    SortField["date"] = "date";
-    SortField["datearchived"] = "datearchived";
-    SortField["datereviewed"] = "datereviewed";
-    SortField["dateadded"] = "dateadded";
-    SortField["creator"] = "creator";
-})(SortField || (SortField = {}));
-export const SortFieldDisplayName = {
-    default: '',
-    relevance: 'Relevance',
-    alltimeview: 'All-time views',
-    weeklyview: 'Weekly views',
-    title: 'Title',
-    date: 'Date published',
-    datearchived: 'Date archived',
-    datereviewed: 'Date reviewed',
-    dateadded: 'Date added',
-    creator: 'Creator',
-};
-export const DefaultSortDirection = {
-    default: null,
-    relevance: null,
-    alltimeview: 'desc',
-    weeklyview: 'desc',
-    title: 'asc',
-    date: 'desc',
-    datearchived: 'desc',
-    datereviewed: 'desc',
-    dateadded: 'desc',
-    creator: 'asc',
-};
-/**
- * Maps the SortField above to the corresponding Metadata field in the API.
- */
-export const SortFieldToMetadataField = {
-    default: null,
-    relevance: null,
-    alltimeview: 'downloads',
-    weeklyview: 'week',
-    title: 'titleSorter',
-    date: 'date',
-    datearchived: 'publicdate',
-    datereviewed: 'reviewdate',
-    dateadded: 'addeddate',
-    creator: 'creatorSorter',
-};
-/**
- * Maps the Metadata field to the corresponding SortField field in the API.
- */
-export const MetadataFieldToSortField = {
-    week: SortField.weeklyview,
-    downloads: SortField.alltimeview,
-    titleSorter: SortField.title,
-    date: SortField.date,
-    publicdate: SortField.datearchived,
-    reviewdate: SortField.datereviewed,
-    addeddate: SortField.dateadded,
-    creatorSorter: SortField.creator,
-};
-/**
- * Maps the Metadata fields to how they should be presented in URLs.
- */
-export const MetadataFieldToURLField = {
-    week: 'week',
-    downloads: 'downloads',
-    titleSorter: 'title',
-    date: 'date',
-    publicdate: 'publicdate',
-    reviewdate: 'reviewdate',
-    addeddate: 'addeddate',
-    creatorSorter: 'creator',
-};
-/**
- * Maps all allowable sort strings from the URL to their respective
- * sort fields.
- */
-export const URLFieldToSortField = {
-    week: SortField.weeklyview,
-    downloads: SortField.alltimeview,
-    title: SortField.title,
-    titleSorter: SortField.title,
-    date: SortField.date,
-    publicdate: SortField.datearchived,
-    reviewdate: SortField.datereviewed,
-    addeddate: SortField.dateadded,
-    creator: SortField.creator,
-    creatorSorter: SortField.creator,
-};
-/**
- * A map from prefix filter types to the corresponding aggregation keys
- * that are needed to fetch the filter counts from the backend.
- */
-export const prefixFilterAggregationKeys = {
-    title: 'firstTitle',
-    creator: 'firstCreator',
-};
-export const getDefaultSelectedFacets = () => ({
-    subject: {},
-    lending: {},
-    mediatype: {},
-    language: {},
-    creator: {},
-    collection: {},
-    year: {},
-});
-export const facetDisplayOrder = [
-    'mediatype',
-    'lending',
-    'year',
-    'subject',
-    'collection',
-    'creator',
-    'language',
-];
-export const facetTitles = {
-    subject: 'Subject',
-    lending: 'Availability',
-    mediatype: 'Media Type',
-    language: 'Language',
-    creator: 'Creator',
-    collection: 'Collection',
-    year: 'Year',
-};
-/**
- * The default sort type to use for each facet type
- */
-export const defaultFacetSort = {
-    subject: AggregationSortType.COUNT,
-    lending: AggregationSortType.COUNT,
-    mediatype: AggregationSortType.COUNT,
-    language: AggregationSortType.COUNT,
-    creator: AggregationSortType.COUNT,
-    collection: AggregationSortType.COUNT,
-    year: AggregationSortType.NUMERIC,
-};
-/**
- * The sort type corresponding to facet bucket values, for each facet type
- * (i.e., the opposite of "sort by count" for that type).
- */
-export const valueFacetSort = {
-    subject: AggregationSortType.ALPHABETICAL,
-    lending: AggregationSortType.ALPHABETICAL,
-    mediatype: AggregationSortType.ALPHABETICAL,
-    language: AggregationSortType.ALPHABETICAL,
-    creator: AggregationSortType.ALPHABETICAL,
-    collection: AggregationSortType.ALPHABETICAL,
-    year: AggregationSortType.NUMERIC,
-};
-/**
- * Maps valid lending keys to whether they should be visible in the facet sidebar
- */
-export const lendingFacetKeysVisibility = {
-    is_lendable: true,
-    is_borrowable: false,
-    available_to_borrow: true,
-    is_browsable: false,
-    available_to_browse: false,
-    is_readable: true,
-    available_to_waitlist: false,
-};
-/**
- * Maps valid, visible lending keys to their facet sidebar display text
- */
-export const lendingFacetDisplayNames = {
-    is_lendable: 'Lending Library',
-    available_to_borrow: 'Borrow 14 Days',
-    is_readable: 'Always Available',
-};
-/**
- * A record of which admin-only collections should be suppressed from being displayed
- * as facets or in an item's list of collections.
- */
-export const suppressedCollections = {
-    deemphasize: true,
-    community: true,
-    stream_only: true,
-    samples_only: true,
-    test_collection: true,
-    printdisabled: true,
-    'openlibrary-ol': true,
-    nationalemergencylibrary: true,
-    china: true,
-    americana: true,
-    toronto: true,
-};
+import { AggregationSortType, } from '@internetarchive/search-service';
+/**
+ * The sort fields shown in the sort filter bar
+ */
+export var SortField;
+(function (SortField) {
+    SortField["default"] = "default";
+    SortField["unrecognized"] = "unrecognized";
+    SortField["relevance"] = "relevance";
+    SortField["alltimeview"] = "alltimeview";
+    SortField["weeklyview"] = "weeklyview";
+    SortField["title"] = "title";
+    SortField["date"] = "date";
+    SortField["datearchived"] = "datearchived";
+    SortField["datereviewed"] = "datereviewed";
+    SortField["dateadded"] = "dateadded";
+    SortField["creator"] = "creator";
+})(SortField || (SortField = {}));
+export const SORT_OPTIONS = {
+    // Default sort is the case where the user has not specified a sort option via the sort bar or URL.
+    // In these cases, we defer to whatever sort the backend chooses.
+    // For the search page, the default is always relevance sort.
+    // For collection pages _without a query_, the default is usually weekly views, but this can be
+    // overridden by the collection's `sort-by` metadata entry. If a query _is_ specified, then the
+    // default is again relevance sort.
+    [SortField.default]: {
+        field: SortField.default,
+        defaultSortDirection: null,
+        canSetDirection: false,
+        shownInSortBar: false,
+        shownInURL: false,
+        handledBySearchService: false,
+        displayName: '',
+        urlNames: ['', null, undefined], // Empty or nullish sort params result in default sorting
+    },
+    // Unrecognized sort is the case where the user has specified a sort in the URL, but it is not
+    // one of the options listed in this map. We still want these unrecognized sorts to be applied
+    // when searching, but they are not displayed in the sort bar and we do not actively manage
+    // their URL param beyond flipping the direction as needed.
+    [SortField.unrecognized]: {
+        field: SortField.unrecognized,
+        defaultSortDirection: null,
+        canSetDirection: true,
+        shownInSortBar: false,
+        shownInURL: false,
+        handledBySearchService: true,
+        displayName: '',
+        urlNames: [],
+    },
+    // Relevance sort is unique in that it does not produce a URL param when it is set.
+    // It is only available when there is a user-specified query that relevancy can be scored against.
+    // Therefore, it does not appear as a sort bar option when browsing a collection with no query set.
+    [SortField.relevance]: {
+        field: SortField.relevance,
+        defaultSortDirection: null,
+        canSetDirection: false,
+        shownInSortBar: true,
+        shownInURL: false,
+        handledBySearchService: false,
+        displayName: 'Relevance',
+        urlNames: ['_score'],
+    },
+    [SortField.alltimeview]: {
+        field: SortField.alltimeview,
+        defaultSortDirection: 'desc',
+        canSetDirection: true,
+        shownInSortBar: true,
+        shownInURL: true,
+        handledBySearchService: true,
+        searchServiceKey: 'downloads',
+        displayName: 'All-time views',
+        urlNames: ['downloads'],
+    },
+    [SortField.weeklyview]: {
+        field: SortField.weeklyview,
+        defaultSortDirection: 'desc',
+        canSetDirection: true,
+        shownInSortBar: true,
+        shownInURL: true,
+        handledBySearchService: true,
+        searchServiceKey: 'week',
+        displayName: 'Weekly views',
+        urlNames: ['week'],
+    },
+    [SortField.title]: {
+        field: SortField.title,
+        defaultSortDirection: 'asc',
+        canSetDirection: true,
+        shownInSortBar: true,
+        shownInURL: true,
+        handledBySearchService: true,
+        searchServiceKey: 'titleSorter',
+        displayName: 'Title',
+        urlNames: ['title', 'titleSorter'],
+    },
+    [SortField.date]: {
+        field: SortField.date,
+        defaultSortDirection: 'desc',
+        canSetDirection: true,
+        shownInSortBar: true,
+        shownInURL: true,
+        handledBySearchService: true,
+        searchServiceKey: 'date',
+        displayName: 'Date published',
+        urlNames: ['date'],
+    },
+    [SortField.datearchived]: {
+        field: SortField.datearchived,
+        defaultSortDirection: 'desc',
+        canSetDirection: true,
+        shownInSortBar: true,
+        shownInURL: true,
+        handledBySearchService: true,
+        searchServiceKey: 'publicdate',
+        displayName: 'Date archived',
+        urlNames: ['publicdate'],
+    },
+    [SortField.datereviewed]: {
+        field: SortField.datereviewed,
+        defaultSortDirection: 'desc',
+        canSetDirection: true,
+        shownInSortBar: true,
+        shownInURL: true,
+        handledBySearchService: true,
+        searchServiceKey: 'reviewdate',
+        displayName: 'Date reviewed',
+        urlNames: ['reviewdate'],
+    },
+    [SortField.dateadded]: {
+        field: SortField.dateadded,
+        defaultSortDirection: 'desc',
+        canSetDirection: true,
+        shownInSortBar: true,
+        shownInURL: true,
+        handledBySearchService: true,
+        searchServiceKey: 'addeddate',
+        displayName: 'Date added',
+        urlNames: ['addeddate'],
+    },
+    [SortField.creator]: {
+        field: SortField.creator,
+        defaultSortDirection: 'asc',
+        canSetDirection: true,
+        shownInSortBar: true,
+        shownInURL: true,
+        handledBySearchService: true,
+        searchServiceKey: 'creatorSorter',
+        displayName: 'Creator',
+        urlNames: ['creator', 'creatorSorter'],
+    },
+};
+/**
+ * Returns the SortOption corresponding to the given API sort name, or
+ * the "unrecognized" SortOption if none matches.
+ */
+export function sortOptionFromAPIString(sortName) {
+    var _a;
+    return ((_a = Object.values(SORT_OPTIONS).find(opt => opt.urlNames.some(name => sortName === name))) !== null && _a !== void 0 ? _a : SORT_OPTIONS[SortField.unrecognized]);
+}
+/**
+ * A map from prefix filter types to the corresponding aggregation keys
+ * that are needed to fetch the filter counts from the backend.
+ */
+export const prefixFilterAggregationKeys = {
+    title: 'firstTitle',
+    creator: 'firstCreator',
+};
+export const getDefaultSelectedFacets = () => ({
+    subject: {},
+    lending: {},
+    mediatype: {},
+    language: {},
+    creator: {},
+    collection: {},
+    year: {},
+});
+export const facetDisplayOrder = [
+    'mediatype',
+    'lending',
+    'year',
+    'subject',
+    'collection',
+    'creator',
+    'language',
+];
+export const facetTitles = {
+    subject: 'Subject',
+    lending: 'Availability',
+    mediatype: 'Media Type',
+    language: 'Language',
+    creator: 'Creator',
+    collection: 'Collection',
+    year: 'Year',
+};
+/**
+ * The default sort type to use for each facet type
+ */
+export const defaultFacetSort = {
+    subject: AggregationSortType.COUNT,
+    lending: AggregationSortType.COUNT,
+    mediatype: AggregationSortType.COUNT,
+    language: AggregationSortType.COUNT,
+    creator: AggregationSortType.COUNT,
+    collection: AggregationSortType.COUNT,
+    year: AggregationSortType.NUMERIC,
+};
+/**
+ * The sort type corresponding to facet bucket values, for each facet type
+ * (i.e., the opposite of "sort by count" for that type).
+ */
+export const valueFacetSort = {
+    subject: AggregationSortType.ALPHABETICAL,
+    lending: AggregationSortType.ALPHABETICAL,
+    mediatype: AggregationSortType.ALPHABETICAL,
+    language: AggregationSortType.ALPHABETICAL,
+    creator: AggregationSortType.ALPHABETICAL,
+    collection: AggregationSortType.ALPHABETICAL,
+    year: AggregationSortType.NUMERIC,
+};
+/**
+ * Maps valid lending keys to whether they should be visible in the facet sidebar
+ */
+export const lendingFacetKeysVisibility = {
+    is_lendable: true,
+    is_borrowable: false,
+    available_to_borrow: true,
+    is_browsable: false,
+    available_to_browse: false,
+    is_readable: true,
+    available_to_waitlist: false,
+};
+/**
+ * Maps valid, visible lending keys to their facet sidebar display text
+ */
+export const lendingFacetDisplayNames = {
+    is_lendable: 'Lending Library',
+    available_to_borrow: 'Borrow 14 Days',
+    is_readable: 'Always Available',
+};
+/**
+ * A record of which admin-only collections should be suppressed from being displayed
+ * as facets or in an item's list of collections.
+ */
+export const suppressedCollections = {
+    deemphasize: true,
+    community: true,
+    stream_only: true,
+    samples_only: true,
+    test_collection: true,
+    printdisabled: true,
+    'openlibrary-ol': true,
+    nationalemergencylibrary: true,
+    china: true,
+    americana: true,
+    toronto: true,
+};
 //# sourceMappingURL=models.js.map

package/dist/src/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,GAEpB,MAAM,iCAAiC,CAAC;AAiDzC;;GAEG;AACH,MAAM,CAAN,IAAY,SAWX;AAXD,WAAY,SAAS;IACnB,gCAAqB,CAAA;IACrB,oCAAyB,CAAA;IACzB,wCAA6B,CAAA;IAC7B,sCAA2B,CAAA;IAC3B,4BAAiB,CAAA;IACjB,0BAAe,CAAA;IACf,0CAA+B,CAAA;IAC/B,0CAA+B,CAAA;IAC/B,oCAAyB,CAAA;IACzB,gCAAqB,CAAA;AACvB,CAAC,EAXW,SAAS,KAAT,SAAS,QAWpB;AAoBD,MAAM,CAAC,MAAM,oBAAoB,GAE7B;IACF,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,gBAAgB;IAC7B,UAAU,EAAE,cAAc;IAC1B,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,gBAAgB;IACtB,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAE7B;IACF,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,MAAM;IACnB,UAAU,EAAE,MAAM;IAClB,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,MAAM;IACpB,YAAY,EAAE,MAAM;IACpB,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE,KAAK;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,MAAM;IAClB,KAAK,EAAE,aAAa;IACpB,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,YAAY;IAC1B,YAAY,EAAE,YAAY;IAC1B,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,eAAe;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,IAAI,EAAE,SAAS,CAAC,UAAU;IAC1B,SAAS,EAAE,SAAS,CAAC,WAAW;IAChC,WAAW,EAAE,SAAS,CAAC,KAAK;IAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,aAAa,EAAE,SAAS,CAAC,OAAO;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAEhC;IACF,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,OAAO;IACpB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,YAAY;IACxB,SAAS,EAAE,WAAW;IACtB,aAAa,EAAE,SAAS;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAoC;IAClE,IAAI,EAAE,SAAS,CAAC,UAAU;IAC1B,SAAS,EAAE,SAAS,CAAC,WAAW;IAChC,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,WAAW,EAAE,SAAS,CAAC,KAAK;IAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,OAAO,EAAE,SAAS,CAAC,OAAO;IAC1B,aAAa,EAAE,SAAS,CAAC,OAAO;CACjC,CAAC;AAQF;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAqC;IAC3E,KAAK,EAAE,YAAY;IACnB,OAAO,EAAE,cAAc;CACxB,CAAC;AA0CF,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAmB,EAAE,CAAC,CAAC;IAC7D,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;IACd,IAAI,EAAE,EAAE;CACT,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAkB;IAC9C,WAAW;IACX,SAAS;IACT,MAAM;IACN,SAAS;IACT,YAAY;IACZ,SAAS;IACT,UAAU;CACX,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAgC;IACtD,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA6C;IACxE,OAAO,EAAE,mBAAmB,CAAC,KAAK;IAClC,OAAO,EAAE,mBAAmB,CAAC,KAAK;IAClC,SAAS,EAAE,mBAAmB,CAAC,KAAK;IACpC,QAAQ,EAAE,mBAAmB,CAAC,KAAK;IACnC,OAAO,EAAE,mBAAmB,CAAC,KAAK;IAClC,UAAU,EAAE,mBAAmB,CAAC,KAAK;IACrC,IAAI,EAAE,mBAAmB,CAAC,OAAO;CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAA6C;IACtE,OAAO,EAAE,mBAAmB,CAAC,YAAY;IACzC,OAAO,EAAE,mBAAmB,CAAC,YAAY;IACzC,SAAS,EAAE,mBAAmB,CAAC,YAAY;IAC3C,QAAQ,EAAE,mBAAmB,CAAC,YAAY;IAC1C,OAAO,EAAE,mBAAmB,CAAC,YAAY;IACzC,UAAU,EAAE,mBAAmB,CAAC,YAAY;IAC5C,IAAI,EAAE,mBAAmB,CAAC,OAAO;CAClC,CAAC;AAWF;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAqC;IAC1E,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,KAAK;IACpB,mBAAmB,EAAE,IAAI;IACzB,YAAY,EAAE,KAAK;IACnB,mBAAmB,EAAE,KAAK;IAC1B,WAAW,EAAE,IAAI;IACjB,qBAAqB,EAAE,KAAK;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,WAAW,EAAE,iBAAiB;IAC9B,mBAAmB,EAAE,gBAAgB;IACrC,WAAW,EAAE,kBAAkB;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA4B;IAC5D,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,eAAe,EAAE,IAAI;IACrB,aAAa,EAAE,IAAI;IACnB,gBAAgB,EAAE,IAAI;IACtB,wBAAwB,EAAE,IAAI;IAC9B,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;CACd,CAAC","sourcesContent":["import type { MediaType } from '@internetarchive/field-parsers';\nimport {\n  AggregationSortType,\n  SortDirection,\n} from '@internetarchive/search-service';\n\nexport interface TileModel {\n  averageRating?: number;\n  collectionIdentifier?: string;\n  collectionName?: string;\n  collectionFilesCount: number;\n  collections: string[];\n  collectionSize: number;\n  commentCount: number;\n  creator?: string;\n  creators: string[];\n  dateAdded?: Date; // Date added to public search (software-defined) [from: addeddate]\n  dateArchived?: Date; // Date archived (software-defined) item created on archive.org [from: publicdate]\n  datePublished?: Date; // Date work published in the world (user-defined) [from: date]\n  dateReviewed?: Date; // Date reviewed (user-created) most recent review [from: reviewdate]\n  description?: string;\n  favCount: number;\n  href?: string;\n  identifier: string;\n  issue?: string;\n  itemCount: number;\n  mediatype: MediaType;\n  source?: string;\n  snippets?: string[];\n  subjects: string[];\n  title: string;\n  viewCount: number;\n  volume?: string;\n  weeklyViewCount?: number;\n  loginRequired: boolean;\n  contentWarning: boolean;\n}\n\nexport type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';\n\nexport type TileDisplayMode =\n  | 'grid'\n  | 'list-compact'\n  | 'list-detail'\n  | 'list-header';\n\n/**\n * This is mainly used to set the cookies for the collection display mode.\n *\n * It allows the user to set different modes for different contexts (collection page, search page, etc).\n */\nexport type CollectionBrowserContext = 'collection' | 'search';\n\n/**\n * The sort fields shown in the sort filter bar\n */\nexport enum SortField {\n  'default' = 'default',\n  'relevance' = 'relevance',\n  'alltimeview' = 'alltimeview',\n  'weeklyview' = 'weeklyview',\n  'title' = 'title',\n  'date' = 'date',\n  'datearchived' = 'datearchived',\n  'datereviewed' = 'datereviewed',\n  'dateadded' = 'dateadded',\n  'creator' = 'creator',\n}\n\n/**\n * The metadata fields we sort by that map to the SortFields above\n */\nexport type MetadataSortField =\n  | 'downloads'\n  | 'week'\n  | 'titleSorter'\n  | 'date'\n  | 'creatorSorter'\n  | 'publicdate'\n  | 'reviewdate'\n  | 'addeddate';\n\n/**\n * All sort strings recognized in search URLs\n */\nexport type URLSortField = MetadataSortField | 'title' | 'creator';\n\nexport const SortFieldDisplayName: {\n  [key in SortField]: string;\n} = {\n  default: '', // Use the default sorting option for the current page context, if none has been selected\n  relevance: 'Relevance',\n  alltimeview: 'All-time views',\n  weeklyview: 'Weekly views',\n  title: 'Title',\n  date: 'Date published',\n  datearchived: 'Date archived',\n  datereviewed: 'Date reviewed',\n  dateadded: 'Date added',\n  creator: 'Creator',\n};\n\nexport const DefaultSortDirection: {\n  [key in SortField]: SortDirection | null;\n} = {\n  default: null,\n  relevance: null, // Sort direction is disabled entirely for relevance sort (user can't click the button)\n  alltimeview: 'desc',\n  weeklyview: 'desc',\n  title: 'asc',\n  date: 'desc',\n  datearchived: 'desc',\n  datereviewed: 'desc',\n  dateadded: 'desc',\n  creator: 'asc',\n};\n\n/**\n * Maps the SortField above to the corresponding Metadata field in the API.\n */\nexport const SortFieldToMetadataField: {\n  [key in SortField]: MetadataSortField | null;\n} = {\n  default: null,\n  relevance: null,\n  alltimeview: 'downloads',\n  weeklyview: 'week',\n  title: 'titleSorter',\n  date: 'date',\n  datearchived: 'publicdate',\n  datereviewed: 'reviewdate',\n  dateadded: 'addeddate',\n  creator: 'creatorSorter',\n};\n\n/**\n * Maps the Metadata field to the corresponding SortField field in the API.\n */\nexport const MetadataFieldToSortField: {\n  [key in MetadataSortField]: SortField;\n} = {\n  week: SortField.weeklyview,\n  downloads: SortField.alltimeview,\n  titleSorter: SortField.title,\n  date: SortField.date,\n  publicdate: SortField.datearchived,\n  reviewdate: SortField.datereviewed,\n  addeddate: SortField.dateadded,\n  creatorSorter: SortField.creator,\n};\n\n/**\n * Maps the Metadata fields to how they should be presented in URLs.\n */\nexport const MetadataFieldToURLField: {\n  [key in MetadataSortField]: URLSortField;\n} = {\n  week: 'week',\n  downloads: 'downloads',\n  titleSorter: 'title',\n  date: 'date',\n  publicdate: 'publicdate',\n  reviewdate: 'reviewdate',\n  addeddate: 'addeddate',\n  creatorSorter: 'creator',\n};\n\n/**\n * Maps all allowable sort strings from the URL to their respective\n * sort fields.\n */\nexport const URLFieldToSortField: Record<URLSortField, SortField> = {\n  week: SortField.weeklyview,\n  downloads: SortField.alltimeview,\n  title: SortField.title,\n  titleSorter: SortField.title,\n  date: SortField.date,\n  publicdate: SortField.datearchived,\n  reviewdate: SortField.datereviewed,\n  addeddate: SortField.dateadded,\n  creator: SortField.creator,\n  creatorSorter: SortField.creator,\n};\n\n/** A union of the fields that permit prefix filtering (e.g., alphabetical filtering) */\nexport type PrefixFilterType = 'title' | 'creator';\n\n/** A map from prefixes (e.g., initial letters) to the number of items matching that prefix */\nexport type PrefixFilterCounts = Record<string, number>;\n\n/**\n * A map from prefix filter types to the corresponding aggregation keys\n * that are needed to fetch the filter counts from the backend.\n */\nexport const prefixFilterAggregationKeys: Record<PrefixFilterType, string> = {\n  title: 'firstTitle',\n  creator: 'firstCreator',\n};\n\nexport type FacetOption =\n  | 'subject'\n  | 'lending'\n  | 'mediatype'\n  | 'language'\n  | 'creator'\n  | 'collection'\n  | 'year';\n\nexport type SelectedFacetState = 'selected' | 'hidden';\n\nexport type FacetState = SelectedFacetState | 'none';\n\nexport interface FacetBucket {\n  // for some facets, we augment the key with a display value\n  displayText?: string;\n  key: string;\n  count: number;\n  state: FacetState;\n}\n\nexport interface FacetGroup {\n  title: string;\n  key: FacetOption;\n  buckets: FacetBucket[];\n}\n\nexport type FacetEventDetails = {\n  key: FacetOption;\n  state: FacetState;\n  negative: boolean;\n};\n\nexport type FacetValue = string;\n\nexport type SelectedFacets = Record<\n  FacetOption,\n  Record<FacetValue, FacetBucket>\n>;\n\nexport const getDefaultSelectedFacets = (): SelectedFacets => ({\n  subject: {},\n  lending: {},\n  mediatype: {},\n  language: {},\n  creator: {},\n  collection: {},\n  year: {},\n});\n\nexport const facetDisplayOrder: FacetOption[] = [\n  'mediatype',\n  'lending',\n  'year',\n  'subject',\n  'collection',\n  'creator',\n  'language',\n];\n\nexport const facetTitles: Record<FacetOption, string> = {\n  subject: 'Subject',\n  lending: 'Availability',\n  mediatype: 'Media Type',\n  language: 'Language',\n  creator: 'Creator',\n  collection: 'Collection',\n  year: 'Year',\n};\n\n/**\n * The default sort type to use for each facet type\n */\nexport const defaultFacetSort: Record<FacetOption, AggregationSortType> = {\n  subject: AggregationSortType.COUNT,\n  lending: AggregationSortType.COUNT,\n  mediatype: AggregationSortType.COUNT,\n  language: AggregationSortType.COUNT,\n  creator: AggregationSortType.COUNT,\n  collection: AggregationSortType.COUNT,\n  year: AggregationSortType.NUMERIC,\n};\n\n/**\n * The sort type corresponding to facet bucket values, for each facet type\n * (i.e., the opposite of \"sort by count\" for that type).\n */\nexport const valueFacetSort: Record<FacetOption, AggregationSortType> = {\n  subject: AggregationSortType.ALPHABETICAL,\n  lending: AggregationSortType.ALPHABETICAL,\n  mediatype: AggregationSortType.ALPHABETICAL,\n  language: AggregationSortType.ALPHABETICAL,\n  creator: AggregationSortType.ALPHABETICAL,\n  collection: AggregationSortType.ALPHABETICAL,\n  year: AggregationSortType.NUMERIC,\n};\n\nexport type LendingFacetKey =\n  | 'is_lendable'\n  | 'is_borrowable'\n  | 'available_to_borrow'\n  | 'is_browsable'\n  | 'available_to_browse'\n  | 'is_readable'\n  | 'available_to_waitlist';\n\n/**\n * Maps valid lending keys to whether they should be visible in the facet sidebar\n */\nexport const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean> = {\n  is_lendable: true,\n  is_borrowable: false,\n  available_to_borrow: true,\n  is_browsable: false,\n  available_to_browse: false,\n  is_readable: true,\n  available_to_waitlist: false,\n};\n\n/**\n * Maps valid, visible lending keys to their facet sidebar display text\n */\nexport const lendingFacetDisplayNames: Partial<\n  Record<LendingFacetKey, string>\n> = {\n  is_lendable: 'Lending Library',\n  available_to_borrow: 'Borrow 14 Days',\n  is_readable: 'Always Available',\n};\n\n/**\n * A record of which admin-only collections should be suppressed from being displayed\n * as facets or in an item's list of collections.\n */\nexport const suppressedCollections: Record<string, boolean> = {\n  deemphasize: true,\n  community: true,\n  stream_only: true,\n  samples_only: true,\n  test_collection: true,\n  printdisabled: true,\n  'openlibrary-ol': true,\n  nationalemergencylibrary: true,\n  china: true,\n  americana: true,\n  toronto: true,\n};\n"]}
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,GAEpB,MAAM,iCAAiC,CAAC;AAiDzC;;GAEG;AACH,MAAM,CAAN,IAAY,SAYX;AAZD,WAAY,SAAS;IACnB,gCAAqB,CAAA;IACrB,0CAA+B,CAAA;IAC/B,oCAAyB,CAAA;IACzB,wCAA6B,CAAA;IAC7B,sCAA2B,CAAA;IAC3B,4BAAiB,CAAA;IACjB,0BAAe,CAAA;IACf,0CAA+B,CAAA;IAC/B,0CAA+B,CAAA;IAC/B,oCAAyB,CAAA;IACzB,gCAAqB,CAAA;AACvB,CAAC,EAZW,SAAS,KAAT,SAAS,QAYpB;AAsDD,MAAM,CAAC,MAAM,YAAY,GAAkC;IACzD,mGAAmG;IACnG,iEAAiE;IACjE,6DAA6D;IAC7D,+FAA+F;IAC/F,+FAA+F;IAC/F,mCAAmC;IACnC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;QACnB,KAAK,EAAE,SAAS,CAAC,OAAO;QACxB,oBAAoB,EAAE,IAAI;QAC1B,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,KAAK;QACrB,UAAU,EAAE,KAAK;QACjB,sBAAsB,EAAE,KAAK;QAC7B,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,yDAAyD;KAC3F;IACD,8FAA8F;IAC9F,8FAA8F;IAC9F,2FAA2F;IAC3F,2DAA2D;IAC3D,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE;QACxB,KAAK,EAAE,SAAS,CAAC,YAAY;QAC7B,oBAAoB,EAAE,IAAI;QAC1B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,KAAK;QACrB,UAAU,EAAE,KAAK;QACjB,sBAAsB,EAAE,IAAI;QAC5B,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,EAAE;KACb;IACD,mFAAmF;IACnF,kGAAkG;IAClG,mGAAmG;IACnG,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;QACrB,KAAK,EAAE,SAAS,CAAC,SAAS;QAC1B,oBAAoB,EAAE,IAAI;QAC1B,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,KAAK;QACjB,sBAAsB,EAAE,KAAK;QAC7B,WAAW,EAAE,WAAW;QACxB,QAAQ,EAAE,CAAC,QAAQ,CAAC;KACrB;IACD,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;QACvB,KAAK,EAAE,SAAS,CAAC,WAAW;QAC5B,oBAAoB,EAAE,MAAM;QAC5B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,IAAI;QAChB,sBAAsB,EAAE,IAAI;QAC5B,gBAAgB,EAAE,WAAW;QAC7B,WAAW,EAAE,gBAAgB;QAC7B,QAAQ,EAAE,CAAC,WAAW,CAAC;KACxB;IACD,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;QACtB,KAAK,EAAE,SAAS,CAAC,UAAU;QAC3B,oBAAoB,EAAE,MAAM;QAC5B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,IAAI;QAChB,sBAAsB,EAAE,IAAI;QAC5B,gBAAgB,EAAE,MAAM;QACxB,WAAW,EAAE,cAAc;QAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;KACnB;IACD,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;QACjB,KAAK,EAAE,SAAS,CAAC,KAAK;QACtB,oBAAoB,EAAE,KAAK;QAC3B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,IAAI;QAChB,sBAAsB,EAAE,IAAI;QAC5B,gBAAgB,EAAE,aAAa;QAC/B,WAAW,EAAE,OAAO;QACpB,QAAQ,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC;KACnC;IACD,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;QAChB,KAAK,EAAE,SAAS,CAAC,IAAI;QACrB,oBAAoB,EAAE,MAAM;QAC5B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,IAAI;QAChB,sBAAsB,EAAE,IAAI;QAC5B,gBAAgB,EAAE,MAAM;QACxB,WAAW,EAAE,gBAAgB;QAC7B,QAAQ,EAAE,CAAC,MAAM,CAAC;KACnB;IACD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE;QACxB,KAAK,EAAE,SAAS,CAAC,YAAY;QAC7B,oBAAoB,EAAE,MAAM;QAC5B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,IAAI;QAChB,sBAAsB,EAAE,IAAI;QAC5B,gBAAgB,EAAE,YAAY;QAC9B,WAAW,EAAE,eAAe;QAC5B,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE;QACxB,KAAK,EAAE,SAAS,CAAC,YAAY;QAC7B,oBAAoB,EAAE,MAAM;QAC5B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,IAAI;QAChB,sBAAsB,EAAE,IAAI;QAC5B,gBAAgB,EAAE,YAAY;QAC9B,WAAW,EAAE,eAAe;QAC5B,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;QACrB,KAAK,EAAE,SAAS,CAAC,SAAS;QAC1B,oBAAoB,EAAE,MAAM;QAC5B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,IAAI;QAChB,sBAAsB,EAAE,IAAI;QAC5B,gBAAgB,EAAE,WAAW;QAC7B,WAAW,EAAE,YAAY;QACzB,QAAQ,EAAE,CAAC,WAAW,CAAC;KACxB;IACD,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;QACnB,KAAK,EAAE,SAAS,CAAC,OAAO;QACxB,oBAAoB,EAAE,KAAK;QAC3B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,IAAI;QAChB,sBAAsB,EAAE,IAAI;QAC5B,gBAAgB,EAAE,eAAe;QACjC,WAAW,EAAE,SAAS;QACtB,QAAQ,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;KACvC;CACF,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,QAAwB;;IAC9D,OAAO,CACL,MAAA,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACrC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,KAAK,IAAI,CAAC,CAC7C,mCAAI,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,CAC1C,CAAC;AACJ,CAAC;AAQD;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAqC;IAC3E,KAAK,EAAE,YAAY;IACnB,OAAO,EAAE,cAAc;CACxB,CAAC;AA0CF,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAmB,EAAE,CAAC,CAAC;IAC7D,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;IACd,IAAI,EAAE,EAAE;CACT,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAkB;IAC9C,WAAW;IACX,SAAS;IACT,MAAM;IACN,SAAS;IACT,YAAY;IACZ,SAAS;IACT,UAAU;CACX,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAgC;IACtD,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA6C;IACxE,OAAO,EAAE,mBAAmB,CAAC,KAAK;IAClC,OAAO,EAAE,mBAAmB,CAAC,KAAK;IAClC,SAAS,EAAE,mBAAmB,CAAC,KAAK;IACpC,QAAQ,EAAE,mBAAmB,CAAC,KAAK;IACnC,OAAO,EAAE,mBAAmB,CAAC,KAAK;IAClC,UAAU,EAAE,mBAAmB,CAAC,KAAK;IACrC,IAAI,EAAE,mBAAmB,CAAC,OAAO;CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAA6C;IACtE,OAAO,EAAE,mBAAmB,CAAC,YAAY;IACzC,OAAO,EAAE,mBAAmB,CAAC,YAAY;IACzC,SAAS,EAAE,mBAAmB,CAAC,YAAY;IAC3C,QAAQ,EAAE,mBAAmB,CAAC,YAAY;IAC1C,OAAO,EAAE,mBAAmB,CAAC,YAAY;IACzC,UAAU,EAAE,mBAAmB,CAAC,YAAY;IAC5C,IAAI,EAAE,mBAAmB,CAAC,OAAO;CAClC,CAAC;AAWF;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAqC;IAC1E,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,KAAK;IACpB,mBAAmB,EAAE,IAAI;IACzB,YAAY,EAAE,KAAK;IACnB,mBAAmB,EAAE,KAAK;IAC1B,WAAW,EAAE,IAAI;IACjB,qBAAqB,EAAE,KAAK;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,WAAW,EAAE,iBAAiB;IAC9B,mBAAmB,EAAE,gBAAgB;IACrC,WAAW,EAAE,kBAAkB;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA4B;IAC5D,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,eAAe,EAAE,IAAI;IACrB,aAAa,EAAE,IAAI;IACnB,gBAAgB,EAAE,IAAI;IACtB,wBAAwB,EAAE,IAAI;IAC9B,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;CACd,CAAC","sourcesContent":["import type { MediaType } from '@internetarchive/field-parsers';\nimport {\n  AggregationSortType,\n  SortDirection,\n} from '@internetarchive/search-service';\n\nexport interface TileModel {\n  averageRating?: number;\n  collectionIdentifier?: string;\n  collectionName?: string;\n  collectionFilesCount: number;\n  collections: string[];\n  collectionSize: number;\n  commentCount: number;\n  creator?: string;\n  creators: string[];\n  dateAdded?: Date; // Date added to public search (software-defined) [from: addeddate]\n  dateArchived?: Date; // Date archived (software-defined) item created on archive.org [from: publicdate]\n  datePublished?: Date; // Date work published in the world (user-defined) [from: date]\n  dateReviewed?: Date; // Date reviewed (user-created) most recent review [from: reviewdate]\n  description?: string;\n  favCount: number;\n  href?: string;\n  identifier: string;\n  issue?: string;\n  itemCount: number;\n  mediatype: MediaType;\n  source?: string;\n  snippets?: string[];\n  subjects: string[];\n  title: string;\n  viewCount: number;\n  volume?: string;\n  weeklyViewCount?: number;\n  loginRequired: boolean;\n  contentWarning: boolean;\n}\n\nexport type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';\n\nexport type TileDisplayMode =\n  | 'grid'\n  | 'list-compact'\n  | 'list-detail'\n  | 'list-header';\n\n/**\n * This is mainly used to set the cookies for the collection display mode.\n *\n * It allows the user to set different modes for different contexts (collection page, search page, etc).\n */\nexport type CollectionBrowserContext = 'collection' | 'search';\n\n/**\n * The sort fields shown in the sort filter bar\n */\nexport enum SortField {\n  'default' = 'default',\n  'unrecognized' = 'unrecognized',\n  'relevance' = 'relevance',\n  'alltimeview' = 'alltimeview',\n  'weeklyview' = 'weeklyview',\n  'title' = 'title',\n  'date' = 'date',\n  'datearchived' = 'datearchived',\n  'datereviewed' = 'datereviewed',\n  'dateadded' = 'dateadded',\n  'creator' = 'creator',\n}\n\nexport interface SortOption {\n  /**\n   * The SortField enum member corresponding to this option.\n   */\n  field: SortField;\n\n  /**\n   * The default sort direction to apply when this sort option is first selected.\n   */\n  defaultSortDirection: SortDirection | null;\n\n  /**\n   * Whether this sort option allows its sort direction to be changed from the default.\n   */\n  canSetDirection: boolean;\n\n  /**\n   * Whether this sort option may appear in the sort bar.\n   */\n  shownInSortBar: boolean;\n\n  /**\n   * Whether this sort option should be saved to the URL.\n   * If false, then no `sort` param will be added to the URL when this sort option\n   * is selected.\n   */\n  shownInURL: boolean;\n\n  /**\n   * Whether this sort option is passed to the search service.\n   * If false, then no sort param will be passed to the search service at all when\n   * this sort option is selected.\n   */\n  handledBySearchService: boolean;\n\n  /**\n   * The string identifying this sort field to the search service & backend API.\n   */\n  searchServiceKey?: string;\n\n  /**\n   * The human-readable name to use for this option in the sort bar (if applicable).\n   */\n  displayName: string;\n\n  /**\n   * A list of URL param keys that should be mapped to this sort option.\n   * E.g., both `title` and `titleSorter` in the URL map to the `SortField.title` option.\n   */\n  urlNames: (string | null | undefined)[];\n}\n\nexport const SORT_OPTIONS: Record<SortField, SortOption> = {\n  // Default sort is the case where the user has not specified a sort option via the sort bar or URL.\n  // In these cases, we defer to whatever sort the backend chooses.\n  // For the search page, the default is always relevance sort.\n  // For collection pages _without a query_, the default is usually weekly views, but this can be\n  // overridden by the collection's `sort-by` metadata entry. If a query _is_ specified, then the\n  // default is again relevance sort.\n  [SortField.default]: {\n    field: SortField.default,\n    defaultSortDirection: null,\n    canSetDirection: false,\n    shownInSortBar: false,\n    shownInURL: false,\n    handledBySearchService: false, // We rely on the PPS default sort handling in these cases\n    displayName: '',\n    urlNames: ['', null, undefined], // Empty or nullish sort params result in default sorting\n  },\n  // Unrecognized sort is the case where the user has specified a sort in the URL, but it is not\n  // one of the options listed in this map. We still want these unrecognized sorts to be applied\n  // when searching, but they are not displayed in the sort bar and we do not actively manage\n  // their URL param beyond flipping the direction as needed.\n  [SortField.unrecognized]: {\n    field: SortField.unrecognized,\n    defaultSortDirection: null,\n    canSetDirection: true,\n    shownInSortBar: false,\n    shownInURL: false,\n    handledBySearchService: true, // The unrecognized sort param is passed along as-is\n    displayName: '',\n    urlNames: [],\n  },\n  // Relevance sort is unique in that it does not produce a URL param when it is set.\n  // It is only available when there is a user-specified query that relevancy can be scored against.\n  // Therefore, it does not appear as a sort bar option when browsing a collection with no query set.\n  [SortField.relevance]: {\n    field: SortField.relevance,\n    defaultSortDirection: null,\n    canSetDirection: false,\n    shownInSortBar: true,\n    shownInURL: false,\n    handledBySearchService: false,\n    displayName: 'Relevance',\n    urlNames: ['_score'],\n  },\n  [SortField.alltimeview]: {\n    field: SortField.alltimeview,\n    defaultSortDirection: 'desc',\n    canSetDirection: true,\n    shownInSortBar: true,\n    shownInURL: true,\n    handledBySearchService: true,\n    searchServiceKey: 'downloads',\n    displayName: 'All-time views',\n    urlNames: ['downloads'],\n  },\n  [SortField.weeklyview]: {\n    field: SortField.weeklyview,\n    defaultSortDirection: 'desc',\n    canSetDirection: true,\n    shownInSortBar: true,\n    shownInURL: true,\n    handledBySearchService: true,\n    searchServiceKey: 'week',\n    displayName: 'Weekly views',\n    urlNames: ['week'],\n  },\n  [SortField.title]: {\n    field: SortField.title,\n    defaultSortDirection: 'asc',\n    canSetDirection: true,\n    shownInSortBar: true,\n    shownInURL: true,\n    handledBySearchService: true,\n    searchServiceKey: 'titleSorter',\n    displayName: 'Title',\n    urlNames: ['title', 'titleSorter'],\n  },\n  [SortField.date]: {\n    field: SortField.date,\n    defaultSortDirection: 'desc',\n    canSetDirection: true,\n    shownInSortBar: true,\n    shownInURL: true,\n    handledBySearchService: true,\n    searchServiceKey: 'date',\n    displayName: 'Date published',\n    urlNames: ['date'],\n  },\n  [SortField.datearchived]: {\n    field: SortField.datearchived,\n    defaultSortDirection: 'desc',\n    canSetDirection: true,\n    shownInSortBar: true,\n    shownInURL: true,\n    handledBySearchService: true,\n    searchServiceKey: 'publicdate',\n    displayName: 'Date archived',\n    urlNames: ['publicdate'],\n  },\n  [SortField.datereviewed]: {\n    field: SortField.datereviewed,\n    defaultSortDirection: 'desc',\n    canSetDirection: true,\n    shownInSortBar: true,\n    shownInURL: true,\n    handledBySearchService: true,\n    searchServiceKey: 'reviewdate',\n    displayName: 'Date reviewed',\n    urlNames: ['reviewdate'],\n  },\n  [SortField.dateadded]: {\n    field: SortField.dateadded,\n    defaultSortDirection: 'desc',\n    canSetDirection: true,\n    shownInSortBar: true,\n    shownInURL: true,\n    handledBySearchService: true,\n    searchServiceKey: 'addeddate',\n    displayName: 'Date added',\n    urlNames: ['addeddate'],\n  },\n  [SortField.creator]: {\n    field: SortField.creator,\n    defaultSortDirection: 'asc',\n    canSetDirection: true,\n    shownInSortBar: true,\n    shownInURL: true,\n    handledBySearchService: true,\n    searchServiceKey: 'creatorSorter',\n    displayName: 'Creator',\n    urlNames: ['creator', 'creatorSorter'],\n  },\n};\n\n/**\n * Returns the SortOption corresponding to the given API sort name, or\n * the \"unrecognized\" SortOption if none matches.\n */\nexport function sortOptionFromAPIString(sortName?: string | null): SortOption {\n  return (\n    Object.values(SORT_OPTIONS).find(opt =>\n      opt.urlNames.some(name => sortName === name)\n    ) ?? SORT_OPTIONS[SortField.unrecognized]\n  );\n}\n\n/** A union of the fields that permit prefix filtering (e.g., alphabetical filtering) */\nexport type PrefixFilterType = 'title' | 'creator';\n\n/** A map from prefixes (e.g., initial letters) to the number of items matching that prefix */\nexport type PrefixFilterCounts = Record<string, number>;\n\n/**\n * A map from prefix filter types to the corresponding aggregation keys\n * that are needed to fetch the filter counts from the backend.\n */\nexport const prefixFilterAggregationKeys: Record<PrefixFilterType, string> = {\n  title: 'firstTitle',\n  creator: 'firstCreator',\n};\n\nexport type FacetOption =\n  | 'subject'\n  | 'lending'\n  | 'mediatype'\n  | 'language'\n  | 'creator'\n  | 'collection'\n  | 'year';\n\nexport type SelectedFacetState = 'selected' | 'hidden';\n\nexport type FacetState = SelectedFacetState | 'none';\n\nexport interface FacetBucket {\n  // for some facets, we augment the key with a display value\n  displayText?: string;\n  key: string;\n  count: number;\n  state: FacetState;\n}\n\nexport interface FacetGroup {\n  title: string;\n  key: FacetOption;\n  buckets: FacetBucket[];\n}\n\nexport type FacetEventDetails = {\n  key: FacetOption;\n  state: FacetState;\n  negative: boolean;\n};\n\nexport type FacetValue = string;\n\nexport type SelectedFacets = Record<\n  FacetOption,\n  Record<FacetValue, FacetBucket>\n>;\n\nexport const getDefaultSelectedFacets = (): SelectedFacets => ({\n  subject: {},\n  lending: {},\n  mediatype: {},\n  language: {},\n  creator: {},\n  collection: {},\n  year: {},\n});\n\nexport const facetDisplayOrder: FacetOption[] = [\n  'mediatype',\n  'lending',\n  'year',\n  'subject',\n  'collection',\n  'creator',\n  'language',\n];\n\nexport const facetTitles: Record<FacetOption, string> = {\n  subject: 'Subject',\n  lending: 'Availability',\n  mediatype: 'Media Type',\n  language: 'Language',\n  creator: 'Creator',\n  collection: 'Collection',\n  year: 'Year',\n};\n\n/**\n * The default sort type to use for each facet type\n */\nexport const defaultFacetSort: Record<FacetOption, AggregationSortType> = {\n  subject: AggregationSortType.COUNT,\n  lending: AggregationSortType.COUNT,\n  mediatype: AggregationSortType.COUNT,\n  language: AggregationSortType.COUNT,\n  creator: AggregationSortType.COUNT,\n  collection: AggregationSortType.COUNT,\n  year: AggregationSortType.NUMERIC,\n};\n\n/**\n * The sort type corresponding to facet bucket values, for each facet type\n * (i.e., the opposite of \"sort by count\" for that type).\n */\nexport const valueFacetSort: Record<FacetOption, AggregationSortType> = {\n  subject: AggregationSortType.ALPHABETICAL,\n  lending: AggregationSortType.ALPHABETICAL,\n  mediatype: AggregationSortType.ALPHABETICAL,\n  language: AggregationSortType.ALPHABETICAL,\n  creator: AggregationSortType.ALPHABETICAL,\n  collection: AggregationSortType.ALPHABETICAL,\n  year: AggregationSortType.NUMERIC,\n};\n\nexport type LendingFacetKey =\n  | 'is_lendable'\n  | 'is_borrowable'\n  | 'available_to_borrow'\n  | 'is_browsable'\n  | 'available_to_browse'\n  | 'is_readable'\n  | 'available_to_waitlist';\n\n/**\n * Maps valid lending keys to whether they should be visible in the facet sidebar\n */\nexport const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean> = {\n  is_lendable: true,\n  is_borrowable: false,\n  available_to_borrow: true,\n  is_browsable: false,\n  available_to_browse: false,\n  is_readable: true,\n  available_to_waitlist: false,\n};\n\n/**\n * Maps valid, visible lending keys to their facet sidebar display text\n */\nexport const lendingFacetDisplayNames: Partial<\n  Record<LendingFacetKey, string>\n> = {\n  is_lendable: 'Lending Library',\n  available_to_borrow: 'Borrow 14 Days',\n  is_readable: 'Always Available',\n};\n\n/**\n * A record of which admin-only collections should be suppressed from being displayed\n * as facets or in an item's list of collections.\n */\nexport const suppressedCollections: Record<string, boolean> = {\n  deemphasize: true,\n  community: true,\n  stream_only: true,\n  samples_only: true,\n  test_collection: true,\n  printdisabled: true,\n  'openlibrary-ol': true,\n  nationalemergencylibrary: true,\n  china: true,\n  americana: true,\n  toronto: true,\n};\n"]}