@internetarchive/collection-browser 1.13.0-alpha2 → 1.14.0

package/test/collection-browser.test.ts

@@ -1211,7 +1211,8 @@ describe('Collection Browser', () => {
     await el.updateComplete;
 
     const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
-    (infiniteScroller as InfiniteScroller).reload = infiniteScrollerRefreshSpy;
+    (infiniteScroller as InfiniteScroller).refreshAllVisibleCells =
+      infiniteScrollerRefreshSpy;
     expect(infiniteScrollerRefreshSpy.called).to.be.false;
     expect(infiniteScrollerRefreshSpy.callCount).to.equal(0);
 
@@ -1462,4 +1463,200 @@ describe('Collection Browser', () => {
     expect(el.minSelectedDate).not.to.exist;
     expect(el.maxSelectedDate).not.to.exist;
   });
+
+  it('shows manage bar interface instead of sort bar when in manage view', async () => {
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'foo';
+    await el.updateComplete;
+    await el.initialSearchComplete;
+
+    el.isManageView = true;
+    await el.updateComplete;
+
+    expect(el.shadowRoot?.querySelector('manage-bar')).to.exist;
+    expect(el.shadowRoot?.querySelector('sort-filter-bar')).not.to.exist;
+
+    el.isManageView = false;
+    await el.updateComplete;
+
+    expect(el.shadowRoot?.querySelector('manage-bar')).not.to.exist;
+    expect(el.shadowRoot?.querySelector('sort-filter-bar')).to.exist;
+  });
+
+  it('switches to grid display mode when manage view activated', async () => {
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser
+        .searchService=${searchService}
+        .baseQuery=${'foo'}
+        .displayMode=${'list-detail'}
+      >
+      </collection-browser>`
+    );
+
+    el.isManageView = true;
+    await el.updateComplete;
+
+    expect(el.displayMode).to.equal('grid');
+  });
+
+  it('can remove all checked tiles', async () => {
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser
+        .searchService=${searchService}
+        .baseNavigationUrl=${''}
+      >
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'foo';
+    el.pageSize = 1; // To hit the edge case of a page break while offsetting tiles
+    await el.updateComplete;
+    await el.initialSearchComplete;
+
+    el.isManageView = true;
+    await el.updateComplete;
+
+    const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
+    expect(infiniteScroller).to.exist;
+
+    let tiles =
+      infiniteScroller!.shadowRoot?.querySelectorAll('tile-dispatcher');
+    expect(tiles).to.exist.and.have.length(2);
+
+    const firstTile = tiles![0] as TileDispatcher;
+    const firstTileLink = firstTile.shadowRoot?.querySelector(
+      'a[href]'
+    ) as HTMLAnchorElement;
+    expect(firstTile.model?.identifier).to.equal('foo');
+    expect(firstTileLink).to.exist;
+
+    // No effect if no tiles checked
+    el.removeCheckedTiles();
+    await el.updateComplete;
+    tiles = infiniteScroller!.shadowRoot?.querySelectorAll('tile-dispatcher');
+    expect(tiles).to.exist.and.have.length(2);
+
+    // Check the first tile
+    firstTileLink!.click();
+    expect(firstTile.model?.checked).to.be.true;
+
+    // Remove checked tiles and verify that we only kept the second tile
+    el.removeCheckedTiles();
+    await el.updateComplete;
+    tiles = infiniteScroller!.shadowRoot?.querySelectorAll('tile-dispatcher');
+    expect(tiles).to.exist.and.have.length(1);
+    expect((tiles![0] as TileDispatcher).model?.identifier).to.equal('bar');
+  });
+
+  it('can check/uncheck all tiles', async () => {
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser
+        .searchService=${searchService}
+        .baseNavigationUrl=${''}
+      >
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'foo';
+    await el.updateComplete;
+    await el.initialSearchComplete;
+
+    el.isManageView = true;
+    await el.updateComplete;
+
+    expect(el.checkedTileModels.length).to.equal(0);
+    expect(el.uncheckedTileModels.length).to.equal(2);
+
+    el.checkAllTiles();
+    expect(el.checkedTileModels.length).to.equal(2);
+    expect(el.uncheckedTileModels.length).to.equal(0);
+
+    el.uncheckAllTiles();
+    expect(el.checkedTileModels.length).to.equal(0);
+    expect(el.uncheckedTileModels.length).to.equal(2);
+  });
+
+  it('emits event when item removal requested', async () => {
+    const spy = sinon.spy();
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser
+        .searchService=${searchService}
+        .baseNavigationUrl=${''}
+        @itemRemovalRequested=${spy}
+      >
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'foo';
+    await el.updateComplete;
+    await el.initialSearchComplete;
+
+    el.isManageView = true;
+    await el.updateComplete;
+
+    const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
+    expect(infiniteScroller).to.exist;
+
+    const tiles =
+      infiniteScroller!.shadowRoot?.querySelectorAll('tile-dispatcher');
+    expect(tiles).to.exist.and.have.length(2);
+
+    const firstTile = tiles![0] as TileDispatcher;
+    const firstTileLink = firstTile.shadowRoot?.querySelector(
+      'a[href]'
+    ) as HTMLAnchorElement;
+    expect(firstTile.model?.identifier).to.equal('foo');
+    expect(firstTileLink).to.exist;
+
+    // Check the first tile
+    firstTileLink!.click();
+    await el.updateComplete;
+
+    const manageBar = el.shadowRoot?.querySelector('manage-bar');
+    expect(manageBar).to.exist;
+
+    // Emit remove event from manage bar
+    manageBar!.dispatchEvent(new CustomEvent('removeItems'));
+
+    await el.updateComplete;
+    expect(spy.callCount).to.equal(1);
+    expect(spy.args[0].length).to.equal(1);
+    expect(spy.args[0][0]?.detail?.items?.[0]?.identifier).to.equal('foo');
+  });
+
+  it('disables manage view when manage bar cancelled', async () => {
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser
+        .searchService=${searchService}
+        .baseNavigationUrl=${''}
+      >
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'foo';
+    await el.updateComplete;
+    await el.initialSearchComplete;
+
+    el.isManageView = true;
+    await el.updateComplete;
+
+    const manageBar = el.shadowRoot?.querySelector('manage-bar');
+    expect(manageBar).to.exist;
+
+    // Emit remove event from manage bar
+    manageBar!.dispatchEvent(new CustomEvent('cancel'));
+
+    await el.updateComplete;
+    expect(el.isManageView).to.be.false;
+  });
 });

package/test/item-image.test.ts

@@ -9,6 +9,7 @@ import '../src/tiles/item-image';
 
 const baseImageUrl = 'https://archive.org';
 const testBookModel: TileModel = {
+  checked: false,
   collections: [],
   commentCount: 0,
   creators: [],
@@ -26,6 +27,7 @@ const testBookModel: TileModel = {
 };
 
 const testAudioModel: TileModel = {
+  checked: false,
   collections: [],
   commentCount: 0,
   creators: [],

package/test/manage/manage-bar.test.ts

@@ -0,0 +1,107 @@
+/* eslint-disable import/no-duplicates */
+import { expect, fixture } from '@open-wc/testing';
+import { html } from 'lit';
+import Sinon from 'sinon';
+import type { ManageBar } from '../../src/manage/manage-bar';
+
+import '../../src/manage/manage-bar';
+
+describe('Manage bar', () => {
+  it('renders basic component', async () => {
+    const el = await fixture<ManageBar>(html`<manage-bar></manage-bar>`);
+
+    expect(el.shadowRoot?.querySelector('.manage-label')).to.exist;
+    expect(el.shadowRoot?.querySelector('.manage-buttons')).to.exist;
+    expect(el.shadowRoot?.querySelector('.cancel-btn')).to.exist;
+    expect(el.shadowRoot?.querySelector('.remove-btn')).to.exist;
+  });
+
+  it('can set the label', async () => {
+    const el = await fixture<ManageBar>(
+      html`<manage-bar label="foo bar"></manage-bar>`
+    );
+    expect(el.shadowRoot?.querySelector('.manage-label')?.textContent).to.equal(
+      'foo bar'
+    );
+  });
+
+  it('does not include Select All/Unselect All buttons by default', async () => {
+    const el = await fixture<ManageBar>(html`<manage-bar></manage-bar>`);
+    expect(el.shadowRoot?.querySelector('.select-all-btn')).not.to.exist;
+    expect(el.shadowRoot?.querySelector('.unselect-all-btn')).not.to.exist;
+  });
+
+  it('includes Select All button when requested', async () => {
+    const el = await fixture<ManageBar>(
+      html`<manage-bar showSelectAll></manage-bar>`
+    );
+    expect(el.shadowRoot?.querySelector('.select-all-btn')).to.exist;
+  });
+
+  it('includes Unselect All button when requested', async () => {
+    const el = await fixture<ManageBar>(
+      html`<manage-bar showUnselectAll></manage-bar>`
+    );
+    expect(el.shadowRoot?.querySelector('.unselect-all-btn')).to.exist;
+  });
+
+  it('emits event when Cancel button clicked', async () => {
+    const spy = Sinon.spy();
+    const el = await fixture<ManageBar>(
+      html`<manage-bar @cancel=${spy}></manage-bar>`
+    );
+
+    const cancelBtn = el.shadowRoot?.querySelector(
+      '.cancel-btn'
+    ) as HTMLButtonElement;
+    expect(cancelBtn).to.exist;
+
+    cancelBtn.click();
+    expect(spy.callCount).to.equal(1);
+  });
+
+  it('emits event when Remove Items button clicked', async () => {
+    const spy = Sinon.spy();
+    const el = await fixture<ManageBar>(
+      html`<manage-bar @removeItems=${spy}></manage-bar>`
+    );
+
+    const removeItemsBtn = el.shadowRoot?.querySelector(
+      '.remove-btn'
+    ) as HTMLButtonElement;
+    expect(removeItemsBtn).to.exist;
+
+    removeItemsBtn.click();
+    expect(spy.callCount).to.equal(1);
+  });
+
+  it('emits event when Select All button clicked', async () => {
+    const spy = Sinon.spy();
+    const el = await fixture<ManageBar>(
+      html`<manage-bar showSelectAll @selectAll=${spy}></manage-bar>`
+    );
+
+    const selectAllBtn = el.shadowRoot?.querySelector(
+      '.select-all-btn'
+    ) as HTMLButtonElement;
+    expect(selectAllBtn).to.exist;
+
+    selectAllBtn.click();
+    expect(spy.callCount).to.equal(1);
+  });
+
+  it('emits event when Unselect All button clicked', async () => {
+    const spy = Sinon.spy();
+    const el = await fixture<ManageBar>(
+      html`<manage-bar showUnselectAll @unselectAll=${spy}></manage-bar>`
+    );
+
+    const unselectAllBtn = el.shadowRoot?.querySelector(
+      '.unselect-all-btn'
+    ) as HTMLButtonElement;
+    expect(unselectAllBtn).to.exist;
+
+    unselectAllBtn.click();
+    expect(spy.callCount).to.equal(1);
+  });
+});

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

@@ -489,12 +489,14 @@ export const getMockSuccessMultipleResults: () => Result<
           fields: {
             identifier: 'foo',
             collection: ['foo', 'bar'],
+            __href__: '/foo',
           },
         }),
         new ItemHit({
           fields: {
             identifier: 'bar',
             collection: ['baz', 'boop'],
+            __href__: '/bar',
           },
         }),
       ],

package/test/tiles/hover/hover-pane-controller.test.ts

@@ -35,6 +35,7 @@ class HostElement extends LitElement implements HoverPaneProviderInterface {
   getHoverPaneProps(): HoverPaneProperties {
     return {
       model: {
+        checked: false,
         collectionFilesCount: 1,
         collections: ['foo', 'bar'],
         collectionSize: 1,

package/test/tiles/tile-dispatcher.test.ts

@@ -1,5 +1,6 @@
 import { aTimeout, expect, fixture } from '@open-wc/testing';
 import { html } from 'lit';
+import sinon from 'sinon';
 import type { TileDispatcher } from '../../src/tiles/tile-dispatcher';
 
 import '../../src/tiles/tile-dispatcher';
@@ -67,6 +68,57 @@ describe('Tile Dispatcher', () => {
     expect(compactListTile).to.exist;
   });
 
+  it('should open item in new tab when right-clicked in manage mode', async () => {
+    const oldWindowOpen = window.open;
+    const spy = sinon.spy();
+    window.open = spy;
+
+    const el = await fixture<TileDispatcher>(html`
+      <tile-dispatcher
+        isManageView
+        .model=${{ identifier: 'foo', href: '/foo' }}
+        .baseNavigationUrl=${''}
+      >
+      </tile-dispatcher>
+    `);
+
+    const tileLink = el.shadowRoot?.querySelector(
+      'a[href]'
+    ) as HTMLAnchorElement;
+    expect(tileLink).to.exist;
+
+    tileLink.dispatchEvent(new Event('contextmenu'));
+    await el.updateComplete;
+
+    expect(spy.callCount).to.equal(1);
+    expect(spy.args[0][0]).to.equal('/foo');
+    expect(spy.args[0][1]).to.equal('_blank');
+
+    window.open = oldWindowOpen;
+  });
+
+  it('should toggle model checked state when manage check clicked', async () => {
+    const el = await fixture<TileDispatcher>(html`
+      <tile-dispatcher
+        isManageView
+        .model=${{ identifier: 'foo', href: '/foo' }}
+        .tileDisplayMode=${'grid'}
+      ></tile-dispatcher>
+    `);
+
+    const manageCheck = el.shadowRoot?.querySelector(
+      '.manage-check > input[type="checkbox"]'
+    ) as HTMLButtonElement;
+
+    manageCheck.click();
+    await el.updateComplete;
+    expect(el.model?.checked).to.be.true;
+
+    manageCheck.click();
+    await el.updateComplete;
+    expect(el.model?.checked).to.be.false;
+  });
+
   it('should return hover pane props', async () => {
     const el = await fixture<TileDispatcher>(html`
       <tile-dispatcher .model=${{ identifier: 'foo' }}> </tile-dispatcher>

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