@internetarchive/collection-browser 1.5.2 → 1.5.3-alpha.1

package/dist/src/collection-browser.d.ts

@@ -1,6 +1,6 @@
 import { LitElement, PropertyValues, TemplateResult } from 'lit';
 import type { InfiniteScrollerCellProviderInterface } from '@internetarchive/infinite-scroller';
-import { CollectionExtraInfo, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
+import { SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
 import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
 import '@internetarchive/infinite-scroller';
 import type { CollectionNameCacheInterface } from '@internetarchive/collection-name-cache';
@@ -37,7 +37,6 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     selectedFacets?: SelectedFacets;
     showHistogramDatePicker: boolean;
     collectionPagePath: string;
-    collectionInfo?: CollectionExtraInfo;
     /** describes where this component is being used */
     searchContext: string;
     collectionNameCache?: CollectionNameCacheInterface;
@@ -76,6 +75,8 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     private mobileView;
     private mobileFacetsVisible;
     private contentWidth?;
+    private defaultSortField;
+    private defaultSortDirection;
     private placeholderType;
     private prefixFilterCountMap;
     private contentContainer;
@@ -357,6 +358,11 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     facetClickHandler({ detail: { key, state: facetState, negative }, }: CustomEvent<FacetEventDetails>): void;
     private fetchFacets;
     private scrollToPage;
+    /**
+     * Whether sorting by relevance makes sense for the current state.
+     * Currently equivalent to having a non-empty query.
+     */
+    private get isRelevanceSortAvailable();
     /**
      * Whether a search may be performed in the current state of the component.
      * This is only true if the search service is defined, and either
@@ -400,6 +406,12 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      */
     fetchPage(pageNumber: number, numInitialPages?: number): Promise<void>;
     private preloadCollectionNames;
+    /**
+     * 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 weekly views.
+     */
+    private applyDefaultCollectionSort;
     /**
      * This is useful for determining whether we need to reload the scroller.
      *

package/dist/src/collection-browser.js

@@ -11,7 +11,7 @@ import './sort-filter-bar/sort-filter-bar';
 import './collection-facets';
 import './circular-activity-indicator';
 import './sort-filter-bar/sort-filter-bar';
-import { SortField, SortFieldToMetadataField, getDefaultSelectedFacets, prefixFilterAggregationKeys, } from './models';
+import { SortField, SortFieldToMetadataField, getDefaultSelectedFacets, prefixFilterAggregationKeys, MetadataFieldToSortField, } from './models';
 import { RestorationStateHandler, } from './restoration-state-handler';
 import chevronIcon from './assets/img/icons/chevron';
 import './empty-placeholder';
@@ -24,7 +24,7 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         this.baseImageUrl = 'https://archive.org';
         this.searchType = SearchType.METADATA;
         this.sortParam = null;
-        this.selectedSort = SortField.relevance;
+        this.selectedSort = SortField.default;
         this.selectedTitleFilter = null;
         this.selectedCreatorFilter = null;
         this.sortDirection = null;
@@ -63,6 +63,8 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         this.fullYearAggregationLoading = false;
         this.mobileView = false;
         this.mobileFacetsVisible = false;
+        this.defaultSortField = SortField.relevance;
+        this.defaultSortDirection = null;
         this.placeholderType = null;
         this.prefixFilterCountMap = {};
         /**
@@ -216,7 +218,7 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         if (sort) {
             this.sortParam = null;
             this.sortDirection = null;
-            this.selectedSort = SortField.relevance;
+            this.selectedSort = SortField.default;
         }
     }
     /**
@@ -402,8 +404,11 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
     get sortFilterBarTemplate() {
         return html `
       <sort-filter-bar
+        .defaultSortField=${this.defaultSortField}
+        .defaultSortDirection=${this.defaultSortDirection}
         .selectedSort=${this.selectedSort}
         .sortDirection=${this.sortDirection}
+        .showRelevance=${this.isRelevanceSortAvailable}
         .displayMode=${this.displayMode}
         .selectedTitleFilter=${this.selectedTitleFilter}
         .selectedCreatorFilter=${this.selectedCreatorFilter}
@@ -437,7 +442,7 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         });
     }
     selectedSortChanged() {
-        if (this.selectedSort === 'relevance') {
+        if ([SortField.default, SortField.relevance].includes(this.selectedSort)) {
             this.sortParam = null;
             return;
         }
@@ -868,6 +873,7 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         return this._initialSearchCompletePromise;
     }
     async handleQueryChange() {
+        var _a;
         // only reset if the query has actually changed
         if (!this.searchService || this.pageFetchQueryKey === this.previousQueryKey)
             return;
@@ -892,6 +898,10 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             this.infiniteScroller.itemCount = this.estimatedTileCount;
             this.infiniteScroller.reload();
         }
+        if (this.withinCollection && ((_a = this.baseQuery) === null || _a === void 0 ? void 0 : _a.trim())) {
+            this.defaultSortField = SortField.relevance;
+            this.defaultSortDirection = null;
+        }
         if (!this.initialQueryChangeHappened && this.initialPageNumber > 1) {
             this.scrollToPage(this.initialPageNumber);
         }
@@ -928,7 +938,7 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         this.displayMode = restorationState.displayMode;
         if (restorationState.searchType != null)
             this.searchType = restorationState.searchType;
-        this.selectedSort = (_a = restorationState.selectedSort) !== null && _a !== void 0 ? _a : SortField.relevance;
+        this.selectedSort = (_a = restorationState.selectedSort) !== null && _a !== void 0 ? _a : SortField.default;
         this.sortDirection = (_b = restorationState.sortDirection) !== null && _b !== void 0 ? _b : null;
         this.selectedTitleFilter = (_c = restorationState.selectedTitleFilter) !== null && _c !== void 0 ? _c : null;
         this.selectedCreatorFilter = (_d = restorationState.selectedCreatorFilter) !== null && _d !== void 0 ? _d : null;
@@ -1221,6 +1231,14 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             }, 0);
         });
     }
+    /**
+     * Whether sorting by relevance makes sense for the current state.
+     * Currently equivalent to having a non-empty query.
+     */
+    get isRelevanceSortAvailable() {
+        var _a;
+        return !!((_a = this.baseQuery) === null || _a === void 0 ? void 0 : _a.trim());
+    }
     /**
      * Whether a search may be performed in the current state of the component.
      * This is only true if the search service is defined, and either
@@ -1341,7 +1359,11 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             return;
         }
         this.totalResults = success.response.totalResults;
-        this.collectionInfo = success.response.collectionExtraInfo;
+        if (this.withinCollection) {
+            // 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
+            this.applyDefaultCollectionSort(success.response.collectionExtraInfo);
+        }
         const { results, collectionTitles } = success.response;
         if (results && results.length > 0) {
             // Load any collection titles present on the response into the cache,
@@ -1381,6 +1403,36 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         const collectionIdsArray = Array.from(new Set(collectionIds));
         (_a = this.collectionNameCache) === null || _a === void 0 ? void 0 : _a.preloadIdentifiers(collectionIdsArray);
     }
+    /**
+     * 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 weekly views.
+     */
+    applyDefaultCollectionSort(collectionInfo) {
+        var _a, _b;
+        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;
+        }
+        const defaultSort = (_b = (_a = collectionInfo === null || collectionInfo === void 0 ? void 0 : collectionInfo.public_metadata) === null || _a === void 0 ? void 0 : _a['sort-by']) !== null && _b !== void 0 ? _b : '-week';
+        // Account for both -field and field:dir formats
+        let [field, dir] = defaultSort.split(':');
+        if (field.startsWith('-')) {
+            field = field.slice(1);
+            dir = 'desc';
+        }
+        else if (!['asc', 'desc'].includes(dir)) {
+            dir = 'asc';
+        }
+        const sortField = MetadataFieldToSortField[field];
+        if (sortField && sortField !== SortField.default) {
+            this.defaultSortField = sortField;
+            this.defaultSortDirection = dir;
+        }
+    }
     /**
      * This is useful for determining whether we need to reload the scroller.
      *
@@ -2032,9 +2084,6 @@ __decorate([
 __decorate([
     property({ type: String })
 ], CollectionBrowser.prototype, "collectionPagePath", void 0);
-__decorate([
-    property({ type: Object })
-], CollectionBrowser.prototype, "collectionInfo", void 0);
 __decorate([
     property({ type: String, reflect: true })
 ], CollectionBrowser.prototype, "searchContext", void 0);
@@ -2098,6 +2147,12 @@ __decorate([
 __decorate([
     state()
 ], CollectionBrowser.prototype, "contentWidth", void 0);
+__decorate([
+    state()
+], CollectionBrowser.prototype, "defaultSortField", void 0);
+__decorate([
+    state()
+], CollectionBrowser.prototype, "defaultSortDirection", void 0);
 __decorate([
     state()
 ], CollectionBrowser.prototype, "placeholderType", void 0);