@internetarchive/collection-browser 1.12.0 → 1.13.0-alpha2

package/dist/src/models.js

@@ -1,270 +1,270 @@
-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["datefavorited"] = "datefavorited";
-    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.
-    // For fav-* collections only, the default is instead sorting by date favorited.
-    [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.datefavorited]: {
-        field: SortField.datefavorited,
-        defaultSortDirection: 'desc',
-        canSetDirection: false,
-        shownInSortBar: true,
-        shownInURL: false,
-        handledBySearchService: false,
-        searchServiceKey: 'favoritedate',
-        displayName: 'Date favorited',
-        urlNames: ['favoritedate'],
-    },
-    [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,
-};
+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["datefavorited"] = "datefavorited";
+    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.
+    // For fav-* collections only, the default is instead sorting by date favorited.
+    [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.datefavorited]: {
+        field: SortField.datefavorited,
+        defaultSortDirection: 'desc',
+        canSetDirection: false,
+        shownInSortBar: true,
+        shownInURL: false,
+        handledBySearchService: false,
+        searchServiceKey: 'favoritedate',
+        displayName: 'Date favorited',
+        urlNames: ['favoritedate'],
+    },
+    [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