@internetarchive/collection-browser 4.2.1-alpha-webdev8165.0 → 4.3.0

package/src/models.ts

@@ -364,6 +364,13 @@ export interface SortOption {
    */
   shownInSortBar: boolean;
 
+  /**
+   * Whether this sort option should be saved to the URL.
+   * If false, then no `sort` param will be added to the URL when this sort option
+   * is selected.
+   */
+  shownInURL: boolean;
+
   /**
    * Whether this sort option is passed to the search service.
    * If false, then no sort param will be passed to the search service at all when
@@ -401,6 +408,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: null,
     canSetDirection: false,
     shownInSortBar: false,
+    shownInURL: false,
     handledBySearchService: false, // We rely on the PPS default sort handling in these cases
     displayName: '',
     urlNames: ['', null, undefined], // Empty or nullish sort params result in default sorting
@@ -414,30 +422,30 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: null,
     canSetDirection: true,
     shownInSortBar: false,
+    shownInURL: false,
     handledBySearchService: true, // The unrecognized sort param is passed along as-is
     displayName: '',
     urlNames: [],
   },
-  // Relevance sort is only available when there is a user-specified query that relevancy can be
-  // scored against. Therefore, it does not appear as a sort bar option when browsing a collection
-  // with no query set. When relevance is the page default (e.g., for regular searches), it is
-  // remapped to SortField.default and does not produce a URL param. When it is NOT the default
-  // (e.g., TV searches), it writes `sort=relevance` to the URL. The `_score` alias is retained
-  // for backwards compatibility (it's what the PPS uses under the hood).
+  // Relevance sort is unique in that it does not produce a URL param when it is set.
+  // It is only available when there is a user-specified query that relevancy can be scored against.
+  // Therefore, it does not appear as a sort bar option when browsing a collection with no query set.
   [SortField.relevance]: {
     field: SortField.relevance,
     defaultSortDirection: null,
     canSetDirection: false,
     shownInSortBar: true,
+    shownInURL: false,
     handledBySearchService: false,
     displayName: 'Relevance',
-    urlNames: ['relevance', '_score'],
+    urlNames: ['_score'],
   },
   [SortField.alltimeview]: {
     field: SortField.alltimeview,
     defaultSortDirection: 'desc',
     canSetDirection: true,
     shownInSortBar: true,
+    shownInURL: true,
     handledBySearchService: true,
     searchServiceKey: 'downloads',
     displayName: 'All-time views',
@@ -448,6 +456,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: 'desc',
     canSetDirection: true,
     shownInSortBar: true,
+    shownInURL: true,
     handledBySearchService: true,
     searchServiceKey: 'week',
     displayName: 'Weekly views',
@@ -458,6 +467,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: 'asc',
     canSetDirection: true,
     shownInSortBar: true,
+    shownInURL: true,
     handledBySearchService: true,
     searchServiceKey: 'titleSorter',
     displayName: 'Title',
@@ -468,6 +478,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: 'desc',
     canSetDirection: true,
     shownInSortBar: true,
+    shownInURL: true,
     handledBySearchService: true,
     searchServiceKey: 'date',
     displayName: 'Date published',
@@ -478,6 +489,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: 'desc',
     canSetDirection: true,
     shownInSortBar: true,
+    shownInURL: true,
     handledBySearchService: true,
     searchServiceKey: 'publicdate',
     displayName: 'Date archived',
@@ -488,6 +500,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: 'desc',
     canSetDirection: true,
     shownInSortBar: true,
+    shownInURL: true,
     handledBySearchService: true,
     searchServiceKey: 'reviewdate',
     displayName: 'Date reviewed',
@@ -498,6 +511,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: 'desc',
     canSetDirection: true,
     shownInSortBar: true,
+    shownInURL: true,
     handledBySearchService: true,
     searchServiceKey: 'addeddate',
     displayName: 'Date added',
@@ -508,6 +522,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: 'desc',
     canSetDirection: false,
     shownInSortBar: true, // But only when viewing fav-* collections
+    shownInURL: false,
     handledBySearchService: false,
     searchServiceKey: 'favoritedate',
     displayName: 'Date favorited',
@@ -518,6 +533,7 @@ export const SORT_OPTIONS: Record<SortField, SortOption> = {
     defaultSortDirection: 'asc',
     canSetDirection: true,
     shownInSortBar: true,
+    shownInURL: true,
     handledBySearchService: true,
     searchServiceKey: 'creatorSorter',
     displayName: 'Creator',

package/src/restoration-state-handler.ts

@@ -147,6 +147,10 @@ export class RestorationStateHandler
       const sortOption = SORT_OPTIONS[state.selectedSort];
       let prefix = this.sortDirectionPrefix(state.sortDirection);
 
+      const isTVRelevanceSort =
+        state.searchType === SearchType.TV &&
+        state.selectedSort === SortField.relevance;
+
       if (sortOption.field === SortField.unrecognized) {
         // For unrecognized sorts, use the existing param, possibly updating its direction
         const oldSortParam = oldParams.get('sort') ?? '';
@@ -161,7 +165,7 @@ export class RestorationStateHandler
         } else {
           newParams.set('sort', oldSortParam);
         }
-      } else if (sortOption.field !== SortField.default) {
+      } else if (sortOption.shownInURL || isTVRelevanceSort) {
         // Otherwise, use the canonical API form of the sort option
         const canonicalApiSort = sortOption.urlNames[0];
         newParams.set('sort', `${prefix}${canonicalApiSort}`);

package/src/tiles/list/tile-list-compact-header.ts

@@ -1,86 +1,86 @@
-import { css, html } from 'lit';
-import { customElement } from 'lit/decorators.js';
-import { msg } from '@lit/localize';
-import { BaseTileComponent } from '../base-tile-component';
-
-@customElement('tile-list-compact-header')
-export class TileListCompactHeader extends BaseTileComponent {
-  /*
-   * Reactive properties inherited from BaseTileComponent:
-   *  - model?: TileModel;
-   *  - currentWidth?: number;
-   *  - currentHeight?: number;
-   *  - baseNavigationUrl?: string;
-   *  - baseImageUrl?: string;
-   *  - collectionPagePath?: string;
-   *  - sortParam: SortParam | null = null;
-   *  - creatorFilter?: string;
-   *  - mobileBreakpoint?: number;
-   *  - loggedIn = false;
-   *  - suppressBlurring = false;
-   */
-
-  render() {
-    return html`
-      <div id="list-line-header" class="${this.classSize}">
-        <div id="thumb"></div>
-        <div id="title">${msg('Title')}</div>
-        <div id="creator">${msg('Creator')}</div>
-        <div id="date">
-          ${this.displayValueProvider.dateLabel || msg('Published')}
-        </div>
-        <div id="icon">${msg('Type')}</div>
-        <div id="views">${msg('Views')}</div>
-      </div>
-    `;
-  }
-
-  private get classSize(): string {
-    if (
-      this.mobileBreakpoint &&
-      this.currentWidth &&
-      this.currentWidth < this.mobileBreakpoint
-    ) {
-      return 'mobile';
-    }
-    return 'desktop';
-  }
-
-  static get styles() {
-    return css`
-      html {
-        font-size: unset;
-      }
-
-      div {
-        font-size: 14px;
-        font-weight: bold;
-        line-height: 20px;
-      }
-
-      .mobile #views {
-        display: none;
-      }
-
-      #views {
-        text-align: right;
-        padding-right: 8px;
-      }
-
-      #list-line-header {
-        display: grid;
-        column-gap: 10px;
-        align-items: flex-end;
-        padding-bottom: 2px;
-      }
-
-      #list-line-header.mobile {
-        grid-template-columns: 36px 3fr 2fr 68px 35px;
-      }
-
-      #list-line-header.desktop {
-        grid-template-columns: 51px 3fr 2fr 95px 30px 60px;
-      }
-    `;
-  }
-}
+import { css, html } from 'lit';
+import { customElement } from 'lit/decorators.js';
+import { msg } from '@lit/localize';
+import { BaseTileComponent } from '../base-tile-component';
+
+@customElement('tile-list-compact-header')
+export class TileListCompactHeader extends BaseTileComponent {
+  /*
+   * Reactive properties inherited from BaseTileComponent:
+   *  - model?: TileModel;
+   *  - currentWidth?: number;
+   *  - currentHeight?: number;
+   *  - baseNavigationUrl?: string;
+   *  - baseImageUrl?: string;
+   *  - collectionPagePath?: string;
+   *  - sortParam: SortParam | null = null;
+   *  - creatorFilter?: string;
+   *  - mobileBreakpoint?: number;
+   *  - loggedIn = false;
+   *  - suppressBlurring = false;
+   */
+
+  render() {
+    return html`
+      <div id="list-line-header" class="${this.classSize}">
+        <div id="thumb"></div>
+        <div id="title">${msg('Title')}</div>
+        <div id="creator">${msg('Creator')}</div>
+        <div id="date">
+          ${this.displayValueProvider.dateLabel || msg('Published')}
+        </div>
+        <div id="icon">${msg('Type')}</div>
+        <div id="views">${this.displayValueProvider.viewsLabel}</div>
+      </div>
+    `;
+  }
+
+  private get classSize(): string {
+    if (
+      this.mobileBreakpoint &&
+      this.currentWidth &&
+      this.currentWidth < this.mobileBreakpoint
+    ) {
+      return 'mobile';
+    }
+    return 'desktop';
+  }
+
+  static get styles() {
+    return css`
+      html {
+        font-size: unset;
+      }
+
+      div {
+        font-size: 14px;
+        font-weight: bold;
+        line-height: 20px;
+      }
+
+      .mobile #views {
+        display: none;
+      }
+
+      #views {
+        text-align: right;
+        padding-right: 8px;
+      }
+
+      #list-line-header {
+        display: grid;
+        column-gap: 10px;
+        align-items: flex-end;
+        padding-bottom: 2px;
+      }
+
+      #list-line-header.mobile {
+        grid-template-columns: 36px 3fr 2fr 68px 35px;
+      }
+
+      #list-line-header.desktop {
+        grid-template-columns: 51px 3fr 2fr 95px 30px 115px;
+      }
+    `;
+  }
+}