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

package/index.ts

@@ -6,15 +6,10 @@ export { SortFilterBar } from './src/sort-filter-bar/sort-filter-bar';
 export {
   CollectionDisplayMode,
   SortField,
-  ExplicitSortField,
   TileModel,
   FacetOption,
   SelectedFacets,
   getDefaultSelectedFacets,
-  sortOptionFromAPIString,
-  resolveCollectionDefaultSort,
-  SORT_OPTIONS,
-  defaultProfileElementSorts,
 } from './src/models';
 export { CollectionBrowserLoadingTile } from './src/tiles/collection-browser-loading-tile';
 export { CollectionTile } from './src/tiles/grid/collection-tile';

package/package.json

@@ -3,7 +3,7 @@
   "description": "The Internet Archive Collection Browser.",
   "license": "AGPL-3.0-only",
   "author": "Internet Archive",
-  "version": "4.1.1-alpha-webdev8185.1",
+  "version": "4.1.1",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "scripts": {

package/src/collection-browser.ts

@@ -36,13 +36,14 @@ import type { IAComboBox } from '@internetarchive/elements/ia-combo-box/ia-combo
 import {
   SelectedFacets,
   SortField,
-  type ExplicitSortField,
   CollectionBrowserContext,
   getDefaultSelectedFacets,
   TileModel,
   CollectionDisplayMode,
   FacetEventDetails,
+  sortOptionFromAPIString,
   SORT_OPTIONS,
+  defaultProfileElementSorts,
   FacetLoadStrategy,
   defaultFacetDisplayOrder,
   tvFacetDisplayOrder,
@@ -150,8 +151,10 @@ export class CollectionBrowser
 
   @property({ type: String }) sortDirection: SortDirection | null = null;
 
-  @property({ type: String }) defaultSortField: ExplicitSortField =
-    SortField.relevance;
+  @property({ type: String }) defaultSortField: Exclude<
+    SortField,
+    SortField.default
+  > = SortField.relevance;
 
   @property({ type: String }) defaultSortDirection: SortDirection | null = null;
 
@@ -598,6 +601,10 @@ export class CollectionBrowser
 
   willUpdate(changed: PropertyValues): void {
     this.setPlaceholderType();
+
+    if (changed.has('searchType') && this.searchType === SearchType.TV) {
+      this.applyDefaultTVSearchSort();
+    }
   }
 
   render() {
@@ -1639,12 +1646,6 @@ export class CollectionBrowser
     this.maxSelectedDate = queryState.maxSelectedDate;
     this.selectedSort = queryState.selectedSort ?? SortField.default;
     this.sortDirection = queryState.sortDirection;
-    if (queryState.defaultSortField) {
-      this.defaultSortField = queryState.defaultSortField;
-    }
-    if (queryState.defaultSortDirection !== undefined) {
-      this.defaultSortDirection = queryState.defaultSortDirection;
-    }
     this.selectedTitleFilter = queryState.selectedTitleFilter;
     this.selectedCreatorFilter = queryState.selectedCreatorFilter;
 
@@ -1755,6 +1756,21 @@ export class CollectionBrowser
       }
     }
 
+    if (changed.has('profileElement')) {
+      this.applyDefaultProfileSort();
+    }
+
+    if (changed.has('withinCollection') && this.withinCollection) {
+      // Set a sensible default collection sort while we load results, which we will later
+      // adjust based on any sort-by metadata once the response arrives.
+      if (!this.baseQuery) {
+        this.defaultSortField = this.withinCollection.startsWith('fav-')
+          ? SortField.datefavorited
+          : SortField.weeklyview;
+        this.defaultSortDirection = 'desc';
+      }
+    }
+
     if (changed.has('baseQuery')) {
       this.emitBaseQueryChanged();
     }
@@ -2067,22 +2083,6 @@ export class CollectionBrowser
     );
   }
 
-  /**
-   * Emits a `collectionExtraInfoLoaded` event when the data source has received
-   * collection metadata from the backend. This allows parent components to react
-   * to the metadata (e.g., to update their default sort based on the collection's
-   * `sort-by` metadata field).
-   */
-  emitCollectionExtraInfoLoaded(
-    collectionExtraInfo?: CollectionExtraInfo,
-  ): void {
-    this.dispatchEvent(
-      new CustomEvent('collectionExtraInfoLoaded', {
-        detail: collectionExtraInfo,
-      }),
-    );
-  }
-
   /**
    * Emits a `queryStateChanged` event indicating that one or more of this component's
    * properties have changed in a way that could affect the set of search results.
@@ -2382,6 +2382,75 @@ export class CollectionBrowser
     }
   }
 
+  /**
+   * Applies the default sort options for the TV search results page
+   */
+  applyDefaultTVSearchSort(): void {
+    this.defaultSortField = SortField.datearchived;
+    this.defaultSortDirection = 'desc';
+  }
+
+  /**
+   * Applies any default sort option for the current collection, by checking
+   * for one in the collection's metadata. If none is found, defaults to sorting
+   * descending by:
+   *  - Date Favorited for fav-* collections
+   *  - Weekly views for all other collections
+   */
+  applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void {
+    if (this.baseQuery) {
+      // If there's a query set, then we default to relevance sorting regardless of
+      // the collection metadata-specified sort.
+      this.defaultSortField = SortField.relevance;
+      this.defaultSortDirection = null;
+      return;
+    }
+
+    // Favorite collections sort on Date Favorited by default.
+    // Other collections fall back to sorting on weekly views.
+    const baseDefaultSort: string =
+      collectionInfo?.public_metadata?.identifier?.startsWith('fav-')
+        ? '-favoritedate'
+        : '-week';
+
+    // The collection metadata may override the default sorting with something else
+    const metadataSort: string | undefined =
+      collectionInfo?.public_metadata?.['sort-by'];
+
+    // Prefer the metadata-specified sort if one exists
+    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) {
+      this.defaultSortField = sortField;
+      this.defaultSortDirection = dir as SortDirection;
+    }
+  }
+
+  /**
+   * Applies the default sort option for the current profile element
+   */
+  applyDefaultProfileSort(): void {
+    if (this.profileElement) {
+      const defaultSortField = defaultProfileElementSorts[this.profileElement];
+      this.defaultSortField = defaultSortField ?? SortField.weeklyview;
+    } else {
+      this.defaultSortField = SortField.weeklyview;
+    }
+
+    this.defaultSortDirection = 'desc';
+  }
+
   /**
    * This is useful for determining whether we need to reload the scroller.
    *

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

@@ -1194,9 +1194,10 @@ export class CollectionBrowserDataSource
     if (withinCollection) {
       this.collectionExtraInfo = success.response.collectionExtraInfo;
 
-      // Emit the collection metadata so the parent page can set default sort
+      // For collections, we want the UI to respect the default sort option
+      // which can be specified in metadata, or otherwise assumed to be week:desc
       if (this.activeOnHost) {
-        this.host.emitCollectionExtraInfoLoaded(this.collectionExtraInfo);
+        this.host.applyDefaultCollectionSort(this.collectionExtraInfo);
       }
 
       if (this.collectionExtraInfo) {

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

@@ -6,12 +6,7 @@ import type {
   SortDirection,
   SortParam,
 } from '@internetarchive/search-service';
-import type {
-  ExplicitSortField,
-  FacetLoadStrategy,
-  SelectedFacets,
-  SortField,
-} from '../models';
+import type { FacetLoadStrategy, SelectedFacets, SortField } from '../models';
 import type { CollectionBrowserDataSourceInterface } from './collection-browser-data-source-interface';
 
 /**
@@ -32,8 +27,6 @@ export interface CollectionBrowserQueryState {
   selectedCreatorFilter: string | null;
   selectedSort?: SortField;
   sortDirection: SortDirection | null;
-  defaultSortField?: ExplicitSortField;
-  defaultSortDirection?: SortDirection | null;
 }
 
 /**
@@ -45,7 +38,7 @@ export interface CollectionBrowserSearchInterface
   searchService?: SearchServiceInterface;
   isTVCollection: boolean;
   readonly sortParam: SortParam | null;
-  readonly defaultSortField: ExplicitSortField;
+  readonly defaultSortField: SortField | null;
   readonly defaultSortDirection: SortDirection | null;
   readonly facetLoadStrategy: FacetLoadStrategy;
   readonly initialPageNumber: number;
@@ -59,9 +52,7 @@ export interface CollectionBrowserSearchInterface
   setFacetsLoading(loading: boolean): void;
   setTotalResultCount(count: number): void;
   setTileCount(count: number): void;
-  emitCollectionExtraInfoLoaded(
-    collectionExtraInfo?: CollectionExtraInfo,
-  ): void;
+  applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
   emitEmptyResults(): void;
   emitSearchError(): void;
   emitQueryStateChanged(): void;

package/src/models.ts

@@ -3,7 +3,6 @@ import { msg } from '@lit/localize';
 import type { MediaType } from '@internetarchive/field-parsers';
 import {
   AggregationSortType,
-  CollectionExtraInfo,
   HitType,
   SearchReview,
   SearchResult,
@@ -323,16 +322,6 @@ 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
  */
@@ -564,47 +553,6 @@ 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,
@@ -632,7 +580,10 @@ export const tvSortAvailability: Record<SortField, boolean> = {
   [SortField.dateadded]: false,
 };
 
-export const defaultProfileElementSorts: Record<string, ExplicitSortField> = {
+export const defaultProfileElementSorts: Record<
+  string,
+  Exclude<SortField, SortField.default>
+> = {
   uploads: SortField.datearchived,
   reviews: SortField.datereviewed,
   collections: SortField.datearchived,