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

package/README.md

@@ -1,84 +1,84 @@
-![Build Status](https://github.com/internetarchive/iaux-collection-browser/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/internetarchive/iaux-collection-browser/branch/main/graph/badge.svg?token=CLWEGO4RMQ)](https://codecov.io/gh/internetarchive/iaux-collection-browser)
-
-
-# Internet Archive Collection Browser
-
-This is the main collection browser for the Internet Archive website.
-
-[Review app URL](https://internetarchive.github.io/iaux-collection-browser/main) 
-## Usage
-
-```ts
-import '@internetarchive/collection-browser';
-
-<collection-browser>
-</collection-browser>
-```
-
-## Local Demo with `web-dev-server`
-```bash
-yarn install
-yarn start
-```
-To run a local development server that serves the basic demo located in `index.html`
-
-## Testing with Web Test Runner
-To run the suite of Web Test Runner tests, run
-```bash
-yarn run test
-```
-
-To run the tests in watch mode (for &lt;abbr title=&#34;test driven development&#34;&gt;TDD&lt;/abbr&gt;, for example), run
-
-```bash
-yarn run test:watch
-```
-
-## Linting with ESLint, Prettier, and Types
-To scan the project for linting errors, run
-```bash
-yarn run lint
-```
-
-You can lint with ESLint and Prettier individually as well
-```bash
-yarn run lint:eslint
-```
-```bash
-yarn run lint:prettier
-```
-
-To automatically fix many linting errors, run
-```bash
-yarn run format
-```
-
-You can format using ESLint and Prettier individually as well
-```bash
-yarn run format:eslint
-```
-```bash
-yarn run format:prettier
-```
-
-## Tooling configs
-
-For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
-
-If you customize the configuration a lot, you can consider moving them to individual files.
-
-## Manual Deploy using `gh-pages`
-
-Live demo app from current main branch: [https://internetarchive.github.io/iaux-collection-browser](https://internetarchive.github.io/iaux-collection-browser)
-
-```
-yarn run deploy
-```
-
-## Automatic Deploy of Demo App
-
-When you create a Pull Request, if your code passes codecov unit tests, it will be always served live at base url / pull request number. For this demo app, you must create a Pull Request, nothing will be created from a simple branch.
-
-This URL will be removed when the Pull Request is merged/closed.
-
+![Build Status](https://github.com/internetarchive/iaux-collection-browser/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/internetarchive/iaux-collection-browser/branch/main/graph/badge.svg?token=CLWEGO4RMQ)](https://codecov.io/gh/internetarchive/iaux-collection-browser)
+
+
+# Internet Archive Collection Browser
+
+This is the main collection browser for the Internet Archive website.
+
+[Review app URL](https://internetarchive.github.io/iaux-collection-browser/main) 
+## Usage
+
+```ts
+import '@internetarchive/collection-browser';
+
+<collection-browser>
+</collection-browser>
+```
+
+## Local Demo with `web-dev-server`
+```bash
+yarn install
+yarn start
+```
+To run a local development server that serves the basic demo located in `index.html`
+
+## Testing with Web Test Runner
+To run the suite of Web Test Runner tests, run
+```bash
+yarn run test
+```
+
+To run the tests in watch mode (for &lt;abbr title=&#34;test driven development&#34;&gt;TDD&lt;/abbr&gt;, for example), run
+
+```bash
+yarn run test:watch
+```
+
+## Linting with ESLint, Prettier, and Types
+To scan the project for linting errors, run
+```bash
+yarn run lint
+```
+
+You can lint with ESLint and Prettier individually as well
+```bash
+yarn run lint:eslint
+```
+```bash
+yarn run lint:prettier
+```
+
+To automatically fix many linting errors, run
+```bash
+yarn run format
+```
+
+You can format using ESLint and Prettier individually as well
+```bash
+yarn run format:eslint
+```
+```bash
+yarn run format:prettier
+```
+
+## Tooling configs
+
+For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
+
+If you customize the configuration a lot, you can consider moving them to individual files.
+
+## Manual Deploy using `gh-pages`
+
+Live demo app from current main branch: [https://internetarchive.github.io/iaux-collection-browser](https://internetarchive.github.io/iaux-collection-browser)
+
+```
+yarn run deploy
+```
+
+## Automatic Deploy of Demo App
+
+When you create a Pull Request, if your code passes codecov unit tests, it will be always served live at base url / pull request number. For this demo app, you must create a Pull Request, nothing will be created from a simple branch.
+
+This URL will be removed when the Pull Request is merged/closed.
+
 Example: `https://internetarchive.github.io/iaux-collection-browser/pr/<pr-number>`

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { CollectionBrowserDataSource } from './src/data-source/collection-browse
 export { CollectionBrowserDataSourceInterface } from './src/data-source/collection-browser-data-source-interface';
 export { CollectionBrowserQueryState } from './src/data-source/collection-browser-query-state';
 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 { CollectionDisplayMode, SortField, TileModel, FacetOption, SelectedFacets, getDefaultSelectedFacets, } from './src/models';
 export { CollectionBrowserLoadingTile } from './src/tiles/collection-browser-loading-tile';
 export { CollectionTile } from './src/tiles/grid/collection-tile';
 export { AccountTile } from './src/tiles/grid/account-tile';

package/dist/index.js

@@ -1,7 +1,7 @@
 export { CollectionBrowser } from './src/collection-browser';
 export { CollectionBrowserDataSource } from './src/data-source/collection-browser-data-source';
 export { SortFilterBar } from './src/sort-filter-bar/sort-filter-bar';
-export { SortField, TileModel, getDefaultSelectedFacets, sortOptionFromAPIString, resolveCollectionDefaultSort, SORT_OPTIONS, defaultProfileElementSorts, } from './src/models';
+export { SortField, TileModel, getDefaultSelectedFacets, } from './src/models';
 export { CollectionBrowserLoadingTile } from './src/tiles/collection-browser-loading-tile';
 export { CollectionTile } from './src/tiles/grid/collection-tile';
 export { AccountTile } from './src/tiles/grid/account-tile';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kDAAkD,CAAC;AAG/F,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAEL,SAAS,EAET,SAAS,EAGT,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,YAAY,EACZ,0BAA0B,GAC3B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,4BAA4B,EAAE,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAO7D,cAAc,uDAAuD,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6DAA6D,CAAC","sourcesContent":["export { CollectionBrowser } from './src/collection-browser';\nexport { CollectionBrowserDataSource } from './src/data-source/collection-browser-data-source';\nexport { CollectionBrowserDataSourceInterface } from './src/data-source/collection-browser-data-source-interface';\nexport { CollectionBrowserQueryState } from './src/data-source/collection-browser-query-state';\nexport { SortFilterBar } from './src/sort-filter-bar/sort-filter-bar';\nexport {\n  CollectionDisplayMode,\n  SortField,\n  ExplicitSortField,\n  TileModel,\n  FacetOption,\n  SelectedFacets,\n  getDefaultSelectedFacets,\n  sortOptionFromAPIString,\n  resolveCollectionDefaultSort,\n  SORT_OPTIONS,\n  defaultProfileElementSorts,\n} from './src/models';\nexport { CollectionBrowserLoadingTile } from './src/tiles/collection-browser-loading-tile';\nexport { CollectionTile } from './src/tiles/grid/collection-tile';\nexport { AccountTile } from './src/tiles/grid/account-tile';\nexport { ItemTile } from './src/tiles/grid/item-tile';\nexport { TileList } from './src/tiles/list/tile-list';\nexport { TileListCompact } from './src/tiles/list/tile-list-compact';\nexport { TileDispatcher } from './src/tiles/tile-dispatcher';\nexport { LayoutType } from './src/tiles/models';\nexport {\n  SmartQueryHeuristic,\n  KeywordFacetMap,\n  SmartFacet,\n} from './src/collection-facets/smart-facets/models';\nexport * from './src/collection-facets/smart-facets/heuristics/index';\nexport { SmartQueryHeuristicGroup } from './src/collection-facets/smart-facets/smart-facet-heuristics';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kDAAkD,CAAC;AAG/F,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAEL,SAAS,EACT,SAAS,EAGT,wBAAwB,GACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,4BAA4B,EAAE,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAO7D,cAAc,uDAAuD,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6DAA6D,CAAC","sourcesContent":["export { CollectionBrowser } from './src/collection-browser';\nexport { CollectionBrowserDataSource } from './src/data-source/collection-browser-data-source';\nexport { CollectionBrowserDataSourceInterface } from './src/data-source/collection-browser-data-source-interface';\nexport { CollectionBrowserQueryState } from './src/data-source/collection-browser-query-state';\nexport { SortFilterBar } from './src/sort-filter-bar/sort-filter-bar';\nexport {\n  CollectionDisplayMode,\n  SortField,\n  TileModel,\n  FacetOption,\n  SelectedFacets,\n  getDefaultSelectedFacets,\n} from './src/models';\nexport { CollectionBrowserLoadingTile } from './src/tiles/collection-browser-loading-tile';\nexport { CollectionTile } from './src/tiles/grid/collection-tile';\nexport { AccountTile } from './src/tiles/grid/account-tile';\nexport { ItemTile } from './src/tiles/grid/item-tile';\nexport { TileList } from './src/tiles/list/tile-list';\nexport { TileListCompact } from './src/tiles/list/tile-list-compact';\nexport { TileDispatcher } from './src/tiles/tile-dispatcher';\nexport { LayoutType } from './src/tiles/models';\nexport {\n  SmartQueryHeuristic,\n  KeywordFacetMap,\n  SmartFacet,\n} from './src/collection-facets/smart-facets/models';\nexport * from './src/collection-facets/smart-facets/heuristics/index';\nexport { SmartQueryHeuristicGroup } from './src/collection-facets/smart-facets/smart-facet-heuristics';\n"]}

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

@@ -7,7 +7,7 @@ import '@internetarchive/infinite-scroller';
 import type { ModalManagerInterface } from '@internetarchive/modal-manager';
 import type { FeatureFeedbackServiceInterface } from '@internetarchive/feature-feedback';
 import type { RecaptchaManagerInterface } from '@internetarchive/recaptcha-manager';
-import { SelectedFacets, SortField, type ExplicitSortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails, FacetLoadStrategy } from './models';
+import { SelectedFacets, SortField, CollectionBrowserContext, TileModel, CollectionDisplayMode, FacetEventDetails, FacetLoadStrategy } from './models';
 import { RestorationStateHandlerInterface } from './restoration-state-handler';
 import type { CollectionBrowserQueryState, CollectionBrowserSearchInterface } from './data-source/collection-browser-query-state';
 import type { CollectionBrowserDataSourceInterface } from './data-source/collection-browser-data-source-interface';
@@ -61,7 +61,7 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     selectedTitleFilter: string | null;
     selectedCreatorFilter: string | null;
     sortDirection: SortDirection | null;
-    defaultSortField: ExplicitSortField;
+    defaultSortField: Exclude<SortField, SortField.default>;
     defaultSortDirection: SortDirection | null;
     pageSize: number;
     currentPage?: number;
@@ -587,13 +587,6 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      * an error from the backend.
      */
     emitSearchError(): void;
-    /**
-     * 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;
     /**
      * 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.
@@ -659,6 +652,22 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      * Sets the total number of tiles displayed in the infinite scroller.
      */
     setTileCount(count: number): void;
+    /**
+     * Applies the default sort options for the TV search results page
+     */
+    applyDefaultTVSearchSort(): void;
+    /**
+     * 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;
+    /**
+     * Applies the default sort option for the current profile element
+     */
+    applyDefaultProfileSort(): void;
     /**
      * This is useful for determining whether we need to reload the scroller.
      *

package/dist/src/collection-browser.js

@@ -5,7 +5,7 @@ import { classMap } from 'lit/directives/class-map.js';
 import { msg } from '@lit/localize';
 import { SearchType, } from '@internetarchive/search-service';
 import '@internetarchive/infinite-scroller';
-import { SortField, getDefaultSelectedFacets, SORT_OPTIONS, defaultFacetDisplayOrder, tvFacetDisplayOrder, defaultSortAvailability, favoritesSortAvailability, tvSortAvailability, } from './models';
+import { SortField, getDefaultSelectedFacets, sortOptionFromAPIString, SORT_OPTIONS, defaultProfileElementSorts, defaultFacetDisplayOrder, tvFacetDisplayOrder, defaultSortAvailability, favoritesSortAvailability, tvSortAvailability, } from './models';
 import { RestorationStateHandler, } from './restoration-state-handler';
 import { CollectionBrowserDataSource } from './data-source/collection-browser-data-source';
 import { FACETLESS_PAGE_ELEMENTS } from './data-source/models';
@@ -373,6 +373,9 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
     }
     willUpdate(changed) {
         this.setPlaceholderType();
+        if (changed.has('searchType') && this.searchType === SearchType.TV) {
+            this.applyDefaultTVSearchSort();
+        }
     }
     render() {
         return html `
@@ -610,8 +613,10 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         // Determine the set of sortable fields that should be shown in the sort bar
         let sortFieldAvailability = defaultSortAvailability;
         // We adjust the available sort options for a couple of special cases...
-        if (this.withinCollection?.startsWith('fav-')) {
-            // When viewing a fav- collection, we include the Date Favorited option as the default
+        if (this.withinCollection?.startsWith('fav-') ||
+            this.profileElement === 'favorites') {
+            // When viewing a fav- collection or the favorites profile tab,
+            // we include the Date Favorited option as the default
             sortFieldAvailability = favoritesSortAvailability;
         }
         else if (!this.withinCollection && this.searchType === SearchType.TV) {
@@ -1271,12 +1276,6 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         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;
         this.pagesToRender = this.initialPageNumber;
@@ -1365,6 +1364,19 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
                 });
             }
         }
+        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();
         }
@@ -1579,17 +1591,6 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             detail: this.dataSource.queryErrorMessage,
         }));
     }
-    /**
-     * 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) {
-        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.
@@ -1843,6 +1844,66 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             this.infiniteScroller.itemCount = count;
         }
     }
+    /**
+     * Applies the default sort options for the TV search results page
+     */
+    applyDefaultTVSearchSort() {
+        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) {
+        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 = collectionInfo?.public_metadata?.identifier?.startsWith('fav-')
+            ? '-favoritedate'
+            : '-week';
+        // The collection metadata may override the default sorting with something else
+        const metadataSort = 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;
+        }
+    }
+    /**
+     * Applies the default sort option for the current profile element
+     */
+    applyDefaultProfileSort() {
+        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.
      *