@internetarchive/collection-browser 0.4.0 → 0.4.2

package/src/sort-filter-bar/alpha-bar.ts

@@ -1,10 +1,13 @@
 import { LitElement, html, css } from 'lit';
 import { customElement, property } from 'lit/decorators.js';
+import type { PrefixFilterCounts } from '../models';
 
 @customElement('alpha-bar')
 export class AlphaBar extends LitElement {
   @property({ type: String }) selectedLetter: string | null = null;
 
+  @property({ type: Object }) letterCounts?: PrefixFilterCounts;
+
   private get selectedUppercaseLetter(): string | undefined {
     return this.selectedLetter?.toUpperCase();
   }
@@ -21,15 +24,9 @@ export class AlphaBar extends LitElement {
                     ? 'selected'
                     : ''}
                 >
-                  <a
-                    href="#"
-                    @click=${(e: Event) => {
-                      e.preventDefault();
-                      this.letterClicked(letter);
-                    }}
-                  >
-                    ${letter}
-                  </a>
+                  ${this.letterCounts?.[letter]
+                    ? this.letterLinkTemplate(letter)
+                    : html`<span>${letter}</span>`}
                 </li>
               `
           )}
@@ -38,6 +35,20 @@ export class AlphaBar extends LitElement {
     `;
   }
 
+  private letterLinkTemplate(letter: string) {
+    return html`
+      <a
+        href="#"
+        @click=${(e: Event) => {
+          e.preventDefault();
+          this.letterClicked(letter);
+        }}
+      >
+        ${letter}
+      </a>
+    `;
+  }
+
   private letterClicked(letter: string) {
     if (letter === this.selectedUppercaseLetter) {
       this.selectedLetter = null;
@@ -85,6 +96,12 @@ export class AlphaBar extends LitElement {
       display: block;
     }
 
+    span {
+      color: #aaa;
+      padding: 0.5rem 0;
+      display: block;
+    }
+
     .selected {
       background-color: darkgray;
     }

package/src/sort-filter-bar/sort-filter-bar.ts

@@ -13,6 +13,8 @@ import type {
 } from '@internetarchive/shared-resize-observer';
 import {
   CollectionDisplayMode,
+  PrefixFilterCounts,
+  PrefixFilterType,
   SortField,
   SortFieldDisplayName,
 } from '../models';
@@ -42,6 +44,11 @@ export class SortFilterBar
 
   @property({ type: Boolean }) showRelevance: boolean = true;
 
+  @property({ type: Object }) prefixFilterCountMap?: Record<
+    PrefixFilterType,
+    PrefixFilterCounts
+  >;
+
   @property({ type: Object }) resizeObserver?: SharedResizeObserverInterface;
 
   @state() alphaSelectorVisible: AlphaSelector | null = null;
@@ -563,6 +570,7 @@ export class SortFilterBar
   private get titleSelectorBar() {
     return html` <alpha-bar
       .selectedLetter=${this.selectedTitleFilter}
+      .letterCounts=${this.prefixFilterCountMap?.title}
       @letterChanged=${this.titleLetterChanged}
     ></alpha-bar>`;
   }
@@ -570,6 +578,7 @@ export class SortFilterBar
   private get creatorSelectorBar() {
     return html` <alpha-bar
       .selectedLetter=${this.selectedCreatorFilter}
+      .letterCounts=${this.prefixFilterCountMap?.creator}
       @letterChanged=${this.creatorLetterChanged}
     ></alpha-bar>`;
   }

package/src/tiles/image-block.ts

@@ -91,7 +91,6 @@ export class ImageBlock extends LitElement {
       .grid {
         height: var(--imgBlockHeight, 16rem);
         flex: 1;
-        display: inline-block;
         position: initial;
       }
 

package/test/collection-browser.test.ts

@@ -20,6 +20,20 @@ import { analyticsCategories } from '../src/utils/analytics-events';
 import type { TileDispatcher } from '../src/tiles/tile-dispatcher';
 import type { CollectionFacets } from '../src/collection-facets';
 
+/**
+ * Wait for the next tick of the event loop.
+ *
+ * This is necessary in some of the tests because certain collection browser
+ * updates take more than one tick to render (e.g., date picker & query changes).
+ * These delays are non-ideal and should eventually be investigated and fixed,
+ * but they are minor enough that waiting for the next tick is a reasonable
+ * testing solution for now.
+ */
+const nextTick = () =>
+  new Promise(resolve => {
+    setTimeout(resolve, 0);
+  });
+
 describe('Collection Browser', () => {
   beforeEach(async () => {
     // Apparently query params set by one test can bleed into other tests.
@@ -61,6 +75,8 @@ describe('Collection Browser', () => {
     );
 
     el.searchContext = 'betaSearchService';
+    el.selectedSort = 'creator' as SortField;
+    el.sortDirection = 'asc';
     el.selectedCreatorFilter = 'A';
     await el.updateComplete;
 
@@ -86,6 +102,7 @@ describe('Collection Browser', () => {
 
     el.searchContext = 'beta-search-service';
     el.selectedSort = 'title' as SortField;
+    el.sortDirection = 'asc';
     el.selectedTitleFilter = 'A';
     await el.updateComplete;
 
@@ -199,6 +216,7 @@ describe('Collection Browser', () => {
 
     el.baseQuery = 'collection:foo';
     await el.updateComplete;
+    await nextTick();
 
     expect(searchService.searchParams?.query).to.equal('collection:foo');
     expect(
@@ -219,6 +237,7 @@ describe('Collection Browser', () => {
 
     el.baseQuery = 'collection:foo';
     await el.updateComplete;
+    await nextTick();
 
     expect(searchService.searchParams?.query).to.equal('collection:foo');
     expect(searchService.searchType).to.equal(SearchType.METADATA);
@@ -240,6 +259,7 @@ describe('Collection Browser', () => {
 
     el.baseQuery = 'collection:foo';
     await el.updateComplete;
+    await nextTick();
 
     expect(searchService.searchParams?.query).to.equal('collection:foo');
     expect(searchService.searchType).to.equal(SearchType.FULLTEXT);
@@ -286,9 +306,16 @@ describe('Collection Browser', () => {
     el.selectedFacets = selectedFacets;
     await el.updateComplete;
 
-    expect(searchService.searchParams?.query).to.equal(
-      'collection:foo AND (subject:("foo" OR -"bar") AND language:("en"))'
-    );
+    expect(searchService.searchParams?.query).to.equal('collection:foo');
+    expect(searchService.searchParams?.filters).to.deep.equal({
+      subject: {
+        foo: 'inc',
+        bar: 'exc',
+      },
+      language: {
+        en: 'inc',
+      },
+    });
   });
 
   it('fires a separate date histogram query when year facets are applied', async () => {
@@ -337,7 +364,8 @@ describe('Collection Browser', () => {
 
     el.baseQuery = 'collection:foo';
     el.showHistogramDatePicker = true;
-    el.dateRangeQueryClause = 'year:[1995 TO 2005]';
+    el.minSelectedDate = '1995';
+    el.maxSelectedDate = '2005';
     await el.updateComplete;
 
     expect(
@@ -375,7 +403,8 @@ describe('Collection Browser', () => {
 
     el.baseQuery = 'collection:foo';
     el.showHistogramDatePicker = false;
-    el.dateRangeQueryClause = 'year:[1995 TO 2005]';
+    el.minSelectedDate = '1995';
+    el.maxSelectedDate = '2005';
     await el.updateComplete;
 
     expect(searchService.searchParams?.aggregations?.simpleParams).to.satisfy(
@@ -675,7 +704,9 @@ describe('Collection Browser', () => {
       </collection-browser>`
     );
 
-    el.baseQuery = 'collection:foo';
+    el.baseQuery = 'first-title';
+    el.selectedSort = 'title' as SortField;
+    el.sortDirection = 'asc';
     el.selectedTitleFilter = 'X';
     await el.updateComplete;
 
@@ -685,7 +716,7 @@ describe('Collection Browser', () => {
     });
 
     expect(searchService.searchParams?.query).to.equal(
-      'collection:foo AND firstTitle:X'
+      'first-title AND firstTitle:X'
     );
   });
 
@@ -696,7 +727,9 @@ describe('Collection Browser', () => {
       </collection-browser>`
     );
 
-    el.baseQuery = 'collection:foo';
+    el.baseQuery = 'first-creator';
+    el.selectedSort = 'creator' as SortField;
+    el.sortDirection = 'asc';
     el.selectedCreatorFilter = 'X';
     await el.updateComplete;
 
@@ -706,10 +739,55 @@ describe('Collection Browser', () => {
     });
 
     expect(searchService.searchParams?.query).to.equal(
-      'collection:foo AND firstCreator:X'
+      'first-creator AND firstCreator:X'
     );
   });
 
+  it('sets sort filter properties simultaneous with facets and date range', async () => {
+    const searchService = new MockSearchService();
+    const selectedFacets: SelectedFacets = {
+      collection: { foo: { key: 'foo', state: 'selected', count: 1 } },
+      creator: {},
+      language: {},
+      lending: {},
+      mediatype: {},
+      subject: {},
+      year: {},
+    };
+
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'first-creator';
+    el.selectedSort = 'creator' as SortField;
+    el.selectedFacets = selectedFacets;
+    el.minSelectedDate = '1950';
+    el.maxSelectedDate = '1970';
+    el.sortDirection = 'asc';
+    el.selectedCreatorFilter = 'X';
+    await el.updateComplete;
+
+    // Wait an extra tick
+    await new Promise(res => {
+      setTimeout(res, 0);
+    });
+
+    expect(searchService.searchParams?.query).to.equal(
+      'first-creator AND firstCreator:X'
+    );
+    expect(searchService.searchParams?.filters).to.deep.equal({
+      collection: {
+        foo: 'inc',
+      },
+      year: {
+        '1950': 'gte',
+        '1970': 'lte',
+      },
+    });
+  });
+
   it('sets date range query when date picker selection changed', async () => {
     const searchService = new MockSearchService();
     const el = await fixture<CollectionBrowser>(
@@ -756,7 +834,8 @@ describe('Collection Browser', () => {
     // Ensure that the histogram change propagated to the collection browser's
     // date query correctly.
     await el.updateComplete;
-    expect(el.dateRangeQueryClause).to.equal('year:[1960 TO 2000]');
+    expect(el.minSelectedDate).to.equal('1960');
+    expect(el.maxSelectedDate).to.equal('2000');
   });
 
   it('scrolls to page', async () => {
@@ -862,6 +941,7 @@ describe('Collection Browser', () => {
 
     el.baseQuery = 'single-result';
     await el.updateComplete;
+    await nextTick();
 
     expect(
       el.shadowRoot?.querySelector('#big-results-label')?.textContent

package/test/collection-facets/more-facets-content.test.ts

@@ -80,7 +80,7 @@ describe('More facets content', () => {
     );
 
     el.facetKey = 'collection';
-    el.fullQuery = 'title:hello';
+    el.query = 'title:hello';
     await el.updateComplete;
 
     expect(searchService.searchParams?.query).to.equal('title:hello');
@@ -97,7 +97,7 @@ describe('More facets content', () => {
     );
 
     el.facetKey = 'collection';
-    el.fullQuery = 'title:hello';
+    el.query = 'title:hello';
     await el.updateComplete;
 
     expect(searchService.searchParams?.query).to.equal('title:hello');

package/test/mocks/mock-search-responses.ts

@@ -193,6 +193,84 @@ export const mockSuccessLoggedInAndNoPreviewResult: Result<
   },
 };
 
+export const mockSuccessFirstTitleResult: Result<
+  SearchResponse,
+  SearchServiceError
+> = {
+  success: {
+    request: {
+      clientParameters: {
+        user_query: 'first-title',
+        sort: ['title', 'asc'],
+      },
+      finalizedParameters: {
+        user_query: 'first-title',
+        sort: ['title', 'asc'],
+      },
+    },
+    rawResponse: {},
+    response: {
+      totalResults: 1,
+      returnedCount: 1,
+      aggregations: {
+        firstTitle: new Aggregation({
+          buckets: [{ key: 'X', doc_count: 1 }],
+        }),
+      },
+      results: [
+        new ItemHit({
+          fields: {
+            identifier: 'foo',
+          },
+        }),
+      ],
+    },
+    responseHeader: {
+      succeeded: true,
+      query_time: 0,
+    },
+  },
+};
+
+export const mockSuccessFirstCreatorResult: Result<
+  SearchResponse,
+  SearchServiceError
+> = {
+  success: {
+    request: {
+      clientParameters: {
+        user_query: 'first-creator',
+        sort: ['creator', 'asc'],
+      },
+      finalizedParameters: {
+        user_query: 'first-creator',
+        sort: ['creator', 'asc'],
+      },
+    },
+    rawResponse: {},
+    response: {
+      totalResults: 1,
+      returnedCount: 1,
+      aggregations: {
+        firstCreator: new Aggregation({
+          buckets: [{ key: 'X', doc_count: 1 }],
+        }),
+      },
+      results: [
+        new ItemHit({
+          fields: {
+            identifier: 'foo',
+          },
+        }),
+      ],
+    },
+    responseHeader: {
+      succeeded: true,
+      query_time: 0,
+    },
+  },
+};
+
 export const getMockSuccessSingleResultWithSort: (
   resultsSpy: Function
 ) => Result<SearchResponse, SearchServiceError> = (resultsSpy: Function) => ({

package/test/mocks/mock-search-service.ts

@@ -15,6 +15,8 @@ import {
   mockSuccessLoggedInAndNoPreviewResult,
   mockSuccessWithYearHistogramAggs,
   mockSuccessMultiLineDescription,
+  mockSuccessFirstTitleResult,
+  mockSuccessFirstCreatorResult,
 } from './mock-search-responses';
 
 export class MockSearchService implements SearchServiceInterface {
@@ -58,6 +60,10 @@ export class MockSearchService implements SearchServiceInterface {
         return mockSuccessNoPreviewResult;
       case 'loggedin-no-preview':
         return mockSuccessLoggedInAndNoPreviewResult;
+      case 'first-title':
+        return mockSuccessFirstTitleResult;
+      case 'first-creator':
+        return mockSuccessFirstCreatorResult;
       case 'with-sort':
         return getMockSuccessSingleResultWithSort(this.resultsSpy);
       default:

package/test/restoration-state-handler.test.ts

@@ -59,9 +59,6 @@ describe('Restoration state handler', () => {
     const restorationState = handler.getRestorationState();
     expect(restorationState.minSelectedDate).to.equal('2018');
     expect(restorationState.maxSelectedDate).to.equal('2021');
-    expect(restorationState.dateRangeQueryClause).to.equal(
-      'year:"2018 TO 2021"'
-    );
   });
 
   it('should restore creator filter from URL', async () => {

package/test/sort-filter-bar/alpha-bar.test.ts

@@ -0,0 +1,52 @@
+import { expect, fixture } from '@open-wc/testing';
+import { html } from 'lit';
+import type { AlphaBar } from '../../src/sort-filter-bar/alpha-bar';
+
+import '../../src/sort-filter-bar/alpha-bar';
+
+describe('Alphabetical Filter Bar', () => {
+  it('renders component', async () => {
+    const el = await fixture<AlphaBar>(html`<alpha-bar></alpha-bar>`);
+
+    // Should have all the letters
+    const letters = el.shadowRoot?.querySelectorAll('li');
+    expect(letters?.length).to.equal(26);
+  });
+
+  it('renders letters with items as links', async () => {
+    const el = await fixture<AlphaBar>(html`<alpha-bar></alpha-bar>`);
+
+    el.letterCounts = { U: 10, X: 10 };
+    await el.updateComplete;
+
+    // Should have exactly two letter links
+    const letterLinks = el.shadowRoot?.querySelectorAll('li > a[href]');
+    expect(letterLinks?.length).to.equal(2);
+    expect(letterLinks?.item(0).textContent?.trim()).to.equal('U');
+    expect(letterLinks?.item(1).textContent?.trim()).to.equal('X');
+  });
+
+  it('renders letters without items as uninteractive text', async () => {
+    const el = await fixture<AlphaBar>(html`<alpha-bar></alpha-bar>`);
+
+    el.letterCounts = { U: 10, X: 10 };
+    await el.updateComplete;
+
+    // All but the two letters above should just be inert spans, not links
+    const letterNonLinks = el.shadowRoot?.querySelectorAll('li > span');
+    expect(letterNonLinks?.length).to.equal(24);
+    expect(letterNonLinks?.item(0).textContent?.trim()).to.equal('A');
+    expect(letterNonLinks?.item(23).textContent?.trim()).to.equal('Z');
+  });
+
+  it('renders the selected letter with the "selected" class', async () => {
+    const el = await fixture<AlphaBar>(html`<alpha-bar></alpha-bar>`);
+
+    el.selectedLetter = 'B';
+    await el.updateComplete;
+
+    const selectedLetter = el.shadowRoot?.querySelector('li.selected');
+    expect(selectedLetter).to.exist;
+    expect(selectedLetter?.textContent?.trim()).to.equal('B');
+  });
+});

package/test/sort-filter-bar/sort-filter-bar.test.ts

@@ -185,3 +185,47 @@ describe('Display mode/style buttons', () => {
     expect(displayModeTitle).to.equal('Tile view');
   });
 });
+
+describe('Sort/filter bar letter behavior', () => {
+  it('sets the selected title letter when clicked', async () => {
+    const el = await fixture<SortFilterBar>(html`
+      <sort-filter-bar></sort-filter-bar>
+    `);
+
+    el.selectedSort = 'title' as SortField;
+    el.prefixFilterCountMap = { title: { T: 1 }, creator: {} };
+    await el.updateComplete;
+
+    const alphaBar = el.shadowRoot?.querySelector('alpha-bar');
+    const letterLink = alphaBar?.shadowRoot?.querySelector(
+      'li > a[href]'
+    ) as HTMLAnchorElement;
+    expect(letterLink?.textContent?.trim()).to.equal('T');
+
+    letterLink?.click();
+    await el.updateComplete;
+
+    expect(el.selectedTitleFilter).to.equal('T');
+  });
+
+  it('sets the selected creator letter when clicked', async () => {
+    const el = await fixture<SortFilterBar>(html`
+      <sort-filter-bar></sort-filter-bar>
+    `);
+
+    el.selectedSort = 'creator' as SortField;
+    el.prefixFilterCountMap = { title: {}, creator: { C: 1 } };
+    await el.updateComplete;
+
+    const alphaBar = el.shadowRoot?.querySelector('alpha-bar');
+    const letterLink = alphaBar?.shadowRoot?.querySelector(
+      'li > a[href]'
+    ) as HTMLAnchorElement;
+    expect(letterLink?.textContent?.trim()).to.equal('C');
+
+    letterLink?.click();
+    await el.updateComplete;
+
+    expect(el.selectedCreatorFilter).to.equal('C');
+  });
+});