@internetarchive/collection-browser 0.3.10-alpha.1 → 0.4.1

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,103 +1,112 @@
-import type { MediaType } from '@internetarchive/field-parsers';
-export interface TileModel {
-    averageRating?: number;
-    collectionIdentifier?: string;
-    collectionName?: string;
-    collections: string[];
-    commentCount: number;
-    creator?: string;
-    creators: string[];
-    dateAdded?: Date;
-    dateArchived?: Date;
-    datePublished?: Date;
-    dateReviewed?: Date;
-    description?: string;
-    favCount: number;
-    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 {
-    'relevance' = "relevance",
-    'alltimeview' = "alltimeview",
-    'weeklyview' = "weeklyview",
-    'title' = "title",
-    'datearchived' = "datearchived",
-    'date' = "date",
-    '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';
-export declare const SortFieldDisplayName: {
-    [key in SortField]: string;
-};
-/**
- * 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;
-};
-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 FacetValue = string;
-export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
-export declare const defaultSelectedFacets: SelectedFacets;
-export declare const facetDisplayOrder: FacetOption[];
-export declare const facetTitles: Record<FacetOption, string>;
-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';
+export interface TileModel {
+    averageRating?: number;
+    collectionIdentifier?: string;
+    collectionName?: string;
+    collections: string[];
+    commentCount: number;
+    creator?: string;
+    creators: string[];
+    dateAdded?: Date;
+    dateArchived?: Date;
+    datePublished?: Date;
+    dateReviewed?: Date;
+    description?: string;
+    favCount: number;
+    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 {
+    'relevance' = "relevance",
+    'alltimeview' = "alltimeview",
+    'weeklyview' = "weeklyview",
+    'title' = "title",
+    'datearchived' = "datearchived",
+    'date' = "date",
+    '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';
+export declare const SortFieldDisplayName: {
+    [key in SortField]: string;
+};
+/**
+ * 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;
+};
+/** 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 FacetValue = string;
+export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
+export declare const defaultSelectedFacets: SelectedFacets;
+export declare const facetDisplayOrder: FacetOption[];
+export declare const facetTitles: Record<FacetOption, string>;
+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>;

package/dist/src/models.js

@@ -1,118 +1,126 @@
-/**
- * The sort fields shown in the sort filter bar
- */
-export var SortField;
-(function (SortField) {
-    SortField["relevance"] = "relevance";
-    SortField["alltimeview"] = "alltimeview";
-    SortField["weeklyview"] = "weeklyview";
-    SortField["title"] = "title";
-    SortField["datearchived"] = "datearchived";
-    SortField["date"] = "date";
-    SortField["datereviewed"] = "datereviewed";
-    SortField["dateadded"] = "dateadded";
-    SortField["creator"] = "creator";
-})(SortField || (SortField = {}));
-export const SortFieldDisplayName = {
-    relevance: 'Relevance',
-    alltimeview: 'All-time Views',
-    weeklyview: 'Weekly Views',
-    title: 'Title',
-    datearchived: 'Date Archived',
-    date: 'Date Published',
-    datereviewed: 'Date Reviewed',
-    dateadded: 'Date Added',
-    creator: 'Creator',
-};
-/**
- * Maps the SortField above to the corresponding Metadata field in the API.
- */
-export const SortFieldToMetadataField = {
-    relevance: null,
-    alltimeview: 'downloads',
-    weeklyview: 'week',
-    title: 'titleSorter',
-    datearchived: 'publicdate',
-    date: 'date',
-    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,
-};
-export const defaultSelectedFacets = {
-    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',
-};
-/**
- * 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,
-};
+/**
+ * The sort fields shown in the sort filter bar
+ */
+export var SortField;
+(function (SortField) {
+    SortField["relevance"] = "relevance";
+    SortField["alltimeview"] = "alltimeview";
+    SortField["weeklyview"] = "weeklyview";
+    SortField["title"] = "title";
+    SortField["datearchived"] = "datearchived";
+    SortField["date"] = "date";
+    SortField["datereviewed"] = "datereviewed";
+    SortField["dateadded"] = "dateadded";
+    SortField["creator"] = "creator";
+})(SortField || (SortField = {}));
+export const SortFieldDisplayName = {
+    relevance: 'Relevance',
+    alltimeview: 'All-time Views',
+    weeklyview: 'Weekly Views',
+    title: 'Title',
+    datearchived: 'Date Archived',
+    date: 'Date Published',
+    datereviewed: 'Date Reviewed',
+    dateadded: 'Date Added',
+    creator: 'Creator',
+};
+/**
+ * Maps the SortField above to the corresponding Metadata field in the API.
+ */
+export const SortFieldToMetadataField = {
+    relevance: null,
+    alltimeview: 'downloads',
+    weeklyview: 'week',
+    title: 'titleSorter',
+    datearchived: 'publicdate',
+    date: 'date',
+    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,
+};
+/**
+ * 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 defaultSelectedFacets = {
+    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',
+};
+/**
+ * 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