@internetarchive/collection-browser 0.3.10-alpha.1 → 0.4.1

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');
+  });
+});

package/test/text-overlay.test.ts

@@ -23,10 +23,13 @@ describe('Text Overlay component', () => {
 
     const overlay = el.shadowRoot?.querySelector('.overlay');
     const noPreview = el.shadowRoot?.querySelector('.no-preview');
+    const iconOverlay = el.shadowRoot?.querySelector('.icon-overlay');
+    const textOverlay = el.shadowRoot?.querySelector('.text-overlay');
 
     expect(overlay).to.exist;
     expect(noPreview).to.exist;
-    expect(noPreview?.textContent).to.equal('Log in\nto view this item');
+    expect(iconOverlay).to.exist;
+    expect(textOverlay?.textContent).to.equal('Log in to view this item');
   });
 
   it('should render component if content warning', async () => {
@@ -36,10 +39,13 @@ describe('Text Overlay component', () => {
 
     const overlay = el.shadowRoot?.querySelector('.overlay');
     const noPreview = el.shadowRoot?.querySelector('.no-preview');
+    const iconOverlay = el.shadowRoot?.querySelector('.icon-overlay');
+    const textOverlay = el.shadowRoot?.querySelector('.text-overlay');
 
     expect(overlay).to.exist;
     expect(noPreview).to.exist;
-    expect(noPreview?.textContent).to.equal('Content may be inappropriate');
+    expect(iconOverlay).to.exist;
+    expect(textOverlay?.textContent).to.equal('Content may be inappropriate');
   });
 
   it('should render component if content warning', async () => {
@@ -49,9 +55,10 @@ describe('Text Overlay component', () => {
 
     const overlay = el.shadowRoot?.querySelector('.overlay');
     const noPreview = el.shadowRoot?.querySelector('.no-preview');
+    const textOverlay = el.shadowRoot?.querySelector('.text-overlay');
 
     expect(overlay).to.exist;
     expect(noPreview).to.exist;
-    expect(noPreview?.textContent).to.equal('Content may be inappropriate');
+    expect(textOverlay?.textContent).to.equal('Content may be inappropriate');
   });
 });

package/tsconfig.json

@@ -1,21 +1,21 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmitOnError": true,
-    "lib": ["es2017", "dom"],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "rootDir": "./",
-    "declaration": true,
-    "importsNotUsedAsValues": "error"
-  },
-  "include": ["src", "test", "index.ts", "types"],
-}
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "lib": ["es2017", "dom"],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "rootDir": "./",
+    "declaration": true,
+    "importsNotUsedAsValues": "error"
+  },
+  "include": ["src", "test", "index.ts", "types"],
+}

package/web-dev-server.config.mjs

@@ -1,30 +1,30 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  nodeResolve: true,
-  open: '/',
-  watch: !hmr,
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  /** Confgure bare import resolve plugin */
-  // nodeResolve: {
-  //   exportConditions: ['browser', 'development']
-  // },
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  http2: true,
-  sslCert: './local.archive.org.cert',
-  sslKey: './local.archive.org.key',
-});
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  nodeResolve: true,
+  open: '/',
+  watch: !hmr,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Confgure bare import resolve plugin */
+  // nodeResolve: {
+  //   exportConditions: ['browser', 'development']
+  // },
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  http2: true,
+  sslCert: './local.archive.org.cert',
+  sslKey: './local.archive.org.key',
+});

package/web-test-runner.config.mjs

@@ -1,41 +1,41 @@
-// import { playwrightLauncher } from '@web/test-runner-playwright';
-
-const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
-
-export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
-  /** Test files to run */
-  files: 'dist/test/**/*.test.js',
-
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Filter out lit dev mode logs */
-  filterBrowserLogs(log) {
-    for (const arg of log.args) {
-      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
-        return false;
-      }
-    }
-    return true;
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto',
-
-  /** Amount of browsers to run concurrently */
-  // concurrentBrowsers: 2,
-
-  /** Amount of test files per browser to test concurrently */
-  // concurrency: 1,
-
-  /** Browsers to run tests on */
-  // browsers: [
-  //   playwrightLauncher({ product: 'chromium' }),
-  //   playwrightLauncher({ product: 'firefox' }),
-  //   playwrightLauncher({ product: 'webkit' }),
-  // ],
-
-  // See documentation for all available options
-});
+// import { playwrightLauncher } from '@web/test-runner-playwright';
+
+const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
+
+export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
+  /** Test files to run */
+  files: 'dist/test/**/*.test.js',
+
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Filter out lit dev mode logs */
+  filterBrowserLogs(log) {
+    for (const arg of log.args) {
+      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto',
+
+  /** Amount of browsers to run concurrently */
+  // concurrentBrowsers: 2,
+
+  /** Amount of test files per browser to test concurrently */
+  // concurrency: 1,
+
+  /** Browsers to run tests on */
+  // browsers: [
+  //   playwrightLauncher({ product: 'chromium' }),
+  //   playwrightLauncher({ product: 'firefox' }),
+  //   playwrightLauncher({ product: 'webkit' }),
+  // ],
+
+  // See documentation for all available options
+});