@internetarchive/collection-browser 0.4.11 → 0.4.13-alpha.1

package/dist/src/models.js

@@ -1,126 +1,137 @@
-/**
- * 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,
-};
+/**
+ * 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["date"] = "date";
+    SortField["datearchived"] = "datearchived";
+    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',
+    date: 'Date published',
+    datearchived: 'Date archived',
+    datereviewed: 'Date reviewed',
+    dateadded: 'Date added',
+    creator: 'Creator',
+};
+export const DefaultSortDirection = {
+    relevance: 'desc',
+    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 = {
+    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,
+};
+/**
+ * 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

package/dist/src/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAiDA;;GAEG;AACH,MAAM,CAAN,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,oCAAyB,CAAA;IACzB,wCAA6B,CAAA;IAC7B,sCAA2B,CAAA;IAC3B,4BAAiB,CAAA;IACjB,0CAA+B,CAAA;IAC/B,0BAAe,CAAA;IACf,0CAA+B,CAAA;IAC/B,oCAAyB,CAAA;IACzB,gCAAqB,CAAA;AACvB,CAAC,EAVW,SAAS,KAAT,SAAS,QAUpB;AAeD,MAAM,CAAC,MAAM,oBAAoB,GAE7B;IACF,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,gBAAgB;IAC7B,UAAU,EAAE,cAAc;IAC1B,KAAK,EAAE,OAAO;IACd,YAAY,EAAE,eAAe;IAC7B,IAAI,EAAE,gBAAgB;IACtB,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,MAAM;IAClB,KAAK,EAAE,aAAa;IACpB,YAAY,EAAE,YAAY;IAC1B,IAAI,EAAE,MAAM;IACZ,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;AAQF;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAqC;IAC3E,KAAK,EAAE,YAAY;IACnB,OAAO,EAAE,cAAc;CACxB,CAAC;AAoCF,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,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;AAEF,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;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';\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  'relevance' = 'relevance',\n  'alltimeview' = 'alltimeview',\n  'weeklyview' = 'weeklyview',\n  'title' = 'title',\n  'datearchived' = 'datearchived',\n  'date' = 'date',\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\nexport const SortFieldDisplayName: {\n  [key in SortField]: string;\n} = {\n  relevance: 'Relevance',\n  alltimeview: 'All-time Views',\n  weeklyview: 'Weekly Views',\n  title: 'Title',\n  datearchived: 'Date Archived',\n  date: 'Date Published',\n  datereviewed: 'Date Reviewed',\n  dateadded: 'Date Added',\n  creator: 'Creator',\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  relevance: null,\n  alltimeview: 'downloads',\n  weeklyview: 'week',\n  title: 'titleSorter',\n  datearchived: 'publicdate',\n  date: 'date',\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/** 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 FacetValue = string;\n\nexport type SelectedFacets = Record<\n  FacetOption,\n  Record<FacetValue, FacetBucket>\n>;\n\nexport const defaultSelectedFacets: 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\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":"AAkDA;;GAEG;AACH,MAAM,CAAN,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,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,EAVW,SAAS,KAAT,SAAS,QAUpB;AAeD,MAAM,CAAC,MAAM,oBAAoB,GAE7B;IACF,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,SAAS,EAAE,MAAM;IACjB,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,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;AAQF;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAqC;IAC3E,KAAK,EAAE,YAAY;IACnB,OAAO,EAAE,cAAc;CACxB,CAAC;AAoCF,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,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;AAEF,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;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 type { SortDirection } 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  '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\nexport const SortFieldDisplayName: {\n  [key in SortField]: string;\n} = {\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;\n} = {\n  relevance: 'desc', // Can't actually change the sort direction for relevance\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  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/** 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 FacetValue = string;\n\nexport type SelectedFacets = Record<\n  FacetOption,\n  Record<FacetValue, FacetBucket>\n>;\n\nexport const defaultSelectedFacets: 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\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"]}

package/dist/src/restoration-state-handler.d.ts

@@ -1,45 +1,45 @@
-import { SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
-import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
-export interface RestorationState {
-    displayMode?: CollectionDisplayMode;
-    searchType?: SearchType;
-    sortParam?: SortParam;
-    selectedSort?: SortField;
-    sortDirection?: SortDirection;
-    selectedFacets: SelectedFacets;
-    baseQuery?: string;
-    currentPage?: number;
-    titleQuery?: string;
-    creatorQuery?: string;
-    minSelectedDate?: string;
-    maxSelectedDate?: string;
-    selectedTitleFilter?: string;
-    selectedCreatorFilter?: string;
-}
-export interface RestorationStateHandlerInterface {
-    persistState(state: RestorationState): void;
-    getRestorationState(): RestorationState;
-}
-export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
-    private context;
-    private cookieDomain;
-    private cookieExpiration;
-    private cookiePath;
-    constructor(options: {
-        context: CollectionBrowserContext;
-    });
-    persistState(state: RestorationState): void;
-    getRestorationState(): RestorationState;
-    private persistViewStateToCookies;
-    private loadTileViewStateFromCookies;
-    private persistQueryStateToUrl;
-    private loadQueryStateFromUrl;
-    private stripQuotes;
-    /**
-     * Sets the facet state for the given field & value to the given state,
-     * creating any previously-undefined buckets as needed.
-     */
-    private setSelectedFacetState;
-    /** Returns a default bucket with the given key, count of 0, and state 'none'. */
-    private getDefaultBucket;
-}
+import { SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
+import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
+export interface RestorationState {
+    displayMode?: CollectionDisplayMode;
+    searchType?: SearchType;
+    sortParam?: SortParam;
+    selectedSort?: SortField;
+    sortDirection?: SortDirection;
+    selectedFacets: SelectedFacets;
+    baseQuery?: string;
+    currentPage?: number;
+    titleQuery?: string;
+    creatorQuery?: string;
+    minSelectedDate?: string;
+    maxSelectedDate?: string;
+    selectedTitleFilter?: string;
+    selectedCreatorFilter?: string;
+}
+export interface RestorationStateHandlerInterface {
+    persistState(state: RestorationState): void;
+    getRestorationState(): RestorationState;
+}
+export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
+    private context;
+    private cookieDomain;
+    private cookieExpiration;
+    private cookiePath;
+    constructor(options: {
+        context: CollectionBrowserContext;
+    });
+    persistState(state: RestorationState): void;
+    getRestorationState(): RestorationState;
+    private persistViewStateToCookies;
+    private loadTileViewStateFromCookies;
+    private persistQueryStateToUrl;
+    private loadQueryStateFromUrl;
+    private stripQuotes;
+    /**
+     * Sets the facet state for the given field & value to the given state,
+     * creating any previously-undefined buckets as needed.
+     */
+    private setSelectedFacetState;
+    /** Returns a default bucket with the given key, count of 0, and state 'none'. */
+    private getDefaultBucket;
+}