@internetarchive/collection-browser 4.1.0 → 4.1.1-alpha-webdev8185.1

package/src/data-source/collection-browser-query-state.ts

@@ -1,60 +1,69 @@
-import type {
-  CollectionExtraInfo,
-  PageElementName,
-  SearchServiceInterface,
-  SearchType,
-  SortDirection,
-  SortParam,
-} from '@internetarchive/search-service';
-import type { FacetLoadStrategy, SelectedFacets, SortField } from '../models';
-import type { CollectionBrowserDataSourceInterface } from './collection-browser-data-source-interface';
-
-/**
- * Properties of collection browser that affect the overall search query
- */
-export interface CollectionBrowserQueryState {
-  baseQuery?: string;
-  identifiers?: string[];
-  withinCollection?: string;
-  withinProfile?: string;
-  profileElement?: PageElementName;
-  searchType: SearchType;
-  selectedFacets?: SelectedFacets;
-  internalFilters?: SelectedFacets;
-  minSelectedDate?: string;
-  maxSelectedDate?: string;
-  selectedTitleFilter: string | null;
-  selectedCreatorFilter: string | null;
-  selectedSort?: SortField;
-  sortDirection: SortDirection | null;
-}
-
-/**
- * Interface representing search-related state and operations required by the
- * data source on its host component.
- */
-export interface CollectionBrowserSearchInterface
-  extends CollectionBrowserQueryState {
-  searchService?: SearchServiceInterface;
-  isTVCollection: boolean;
-  readonly sortParam: SortParam | null;
-  readonly defaultSortField: SortField | null;
-  readonly defaultSortDirection: SortDirection | null;
-  readonly facetLoadStrategy: FacetLoadStrategy;
-  readonly initialPageNumber: number;
-  readonly maxPagesToManage: number;
-  readonly currentVisiblePageNumbers: number[];
-  readonly clearResultsOnEmptyQuery?: boolean;
-  readonly dataSource?: CollectionBrowserDataSourceInterface;
-
-  getSessionId(): Promise<string>;
-  setSearchResultsLoading(loading: boolean): void;
-  setFacetsLoading(loading: boolean): void;
-  setTotalResultCount(count: number): void;
-  setTileCount(count: number): void;
-  applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
-  emitEmptyResults(): void;
-  emitSearchError(): void;
-  emitQueryStateChanged(): void;
-  refreshVisibleResults(): void;
-}
+import type {
+  CollectionExtraInfo,
+  PageElementName,
+  SearchServiceInterface,
+  SearchType,
+  SortDirection,
+  SortParam,
+} from '@internetarchive/search-service';
+import type {
+  ExplicitSortField,
+  FacetLoadStrategy,
+  SelectedFacets,
+  SortField,
+} from '../models';
+import type { CollectionBrowserDataSourceInterface } from './collection-browser-data-source-interface';
+
+/**
+ * Properties of collection browser that affect the overall search query
+ */
+export interface CollectionBrowserQueryState {
+  baseQuery?: string;
+  identifiers?: string[];
+  withinCollection?: string;
+  withinProfile?: string;
+  profileElement?: PageElementName;
+  searchType: SearchType;
+  selectedFacets?: SelectedFacets;
+  internalFilters?: SelectedFacets;
+  minSelectedDate?: string;
+  maxSelectedDate?: string;
+  selectedTitleFilter: string | null;
+  selectedCreatorFilter: string | null;
+  selectedSort?: SortField;
+  sortDirection: SortDirection | null;
+  defaultSortField?: ExplicitSortField;
+  defaultSortDirection?: SortDirection | null;
+}
+
+/**
+ * Interface representing search-related state and operations required by the
+ * data source on its host component.
+ */
+export interface CollectionBrowserSearchInterface
+  extends CollectionBrowserQueryState {
+  searchService?: SearchServiceInterface;
+  isTVCollection: boolean;
+  readonly sortParam: SortParam | null;
+  readonly defaultSortField: ExplicitSortField;
+  readonly defaultSortDirection: SortDirection | null;
+  readonly facetLoadStrategy: FacetLoadStrategy;
+  readonly initialPageNumber: number;
+  readonly maxPagesToManage: number;
+  readonly currentVisiblePageNumbers: number[];
+  readonly clearResultsOnEmptyQuery?: boolean;
+  readonly dataSource?: CollectionBrowserDataSourceInterface;
+
+  getSessionId(): Promise<string>;
+  setSearchResultsLoading(loading: boolean): void;
+  setFacetsLoading(loading: boolean): void;
+  setTotalResultCount(count: number): void;
+  setTileCount(count: number): void;
+  emitCollectionExtraInfoLoaded(
+    collectionExtraInfo?: CollectionExtraInfo,
+  ): void;
+  emitEmptyResults(): void;
+  emitSearchError(): void;
+  emitQueryStateChanged(): void;
+  refreshVisibleResults(): void;
+}

package/src/models.ts

@@ -3,6 +3,7 @@ import { msg } from '@lit/localize';
 import type { MediaType } from '@internetarchive/field-parsers';
 import {
   AggregationSortType,
+  CollectionExtraInfo,
   HitType,
   SearchReview,
   SearchResult,
@@ -322,6 +323,16 @@ export enum SortField {
   'creator' = 'creator',
 }
 
+/**
+ * A sort field other than the abstract "default" placeholder.
+ * This is useful because the "default" sort field is just an indicator to
+ * revert to an explicitly defined fallback value. So when defining default
+ * sort logic, this type should be preferred to avoid accidentally permitting
+ * that fallback to itself equal the "default" placeholder (which would be
+ * rather circular/ill-defined).
+ */
+export type ExplicitSortField = Exclude<SortField, SortField.default>;
+
 /**
  * Views-related sort fields
  */
@@ -553,6 +564,47 @@ export function sortOptionFromAPIString(sortName?: string | null): SortOption {
   );
 }
 
+/**
+ * Resolves the default sort option for a collection based on its metadata.
+ *
+ * - Favorite collections (`fav-*`) default to Date Favorited descending.
+ * - Other collections default to Weekly Views descending.
+ * - If the collection metadata specifies a `sort-by` field, that overrides the above.
+ *
+ * Supports both `-field` (dash prefix = desc) and `field:dir` metadata formats.
+ *
+ * Note: This does NOT handle the "relevance when a query is present" rule,
+ * which is managed separately by collection-browser itself.
+ */
+export function resolveCollectionDefaultSort(
+  collectionInfo?: CollectionExtraInfo,
+): { field: ExplicitSortField; direction: SortDirection } {
+  const isFav = collectionInfo?.public_metadata?.identifier?.startsWith('fav-');
+  const baseDefaultSort: string = isFav ? '-favoritedate' : '-week';
+  const metadataSort: string | undefined =
+    collectionInfo?.public_metadata?.['sort-by'];
+  const defaultSortToApply = metadataSort ?? baseDefaultSort;
+
+  // Account for both -field and field:dir formats
+  let [field, dir] = defaultSortToApply.split(':');
+  if (field.startsWith('-')) {
+    field = field.slice(1);
+    dir = 'desc';
+  } else if (!['asc', 'desc'].includes(dir)) {
+    dir = 'asc';
+  }
+
+  const sortOption = sortOptionFromAPIString(field);
+  const sortField = sortOption.field;
+  if (sortField && sortField !== SortField.default) {
+    return {
+      field: sortField as ExplicitSortField,
+      direction: dir as SortDirection,
+    };
+  }
+  return { field: SortField.weeklyview, direction: 'desc' };
+}
+
 export const defaultSortAvailability: Record<SortField, boolean> = {
   [SortField.relevance]: true,
   [SortField.weeklyview]: true,
@@ -580,10 +632,7 @@ export const tvSortAvailability: Record<SortField, boolean> = {
   [SortField.dateadded]: false,
 };
 
-export const defaultProfileElementSorts: Record<
-  string,
-  Exclude<SortField, SortField.default>
-> = {
+export const defaultProfileElementSorts: Record<string, ExplicitSortField> = {
   uploads: SortField.datearchived,
   reviews: SortField.datereviewed,
   collections: SortField.datearchived,