@internetarchive/collection-browser 2.7.7 → 2.7.8

package/src/manage/manage-bar.ts

@@ -2,13 +2,13 @@ import { msg } from '@lit/localize';
 import { LitElement, html, css, TemplateResult, CSSResultGroup } from 'lit';
 import { customElement, property } from 'lit/decorators.js';
 import { when } from 'lit/directives/when.js';
+import {
+  ModalConfig,
+  type ModalManagerInterface,
+} from '@internetarchive/modal-manager';
+import type { ManageableItem } from '../models';
 import iaButtonStyle from '../styles/ia-button';
-
-export interface ManageableItem {
-  identifier: string;
-  title?: string;
-  dateStr?: string;
-}
+import './remove-items-modal-content';
 
 @customElement('manage-bar')
 export class ManageBar extends LitElement {
@@ -18,9 +18,19 @@ export class ManageBar extends LitElement {
   @property({ type: String }) label = msg('Select items to remove');
 
   /**
-   * Specifies the context in which the collection browser is being used
+   * The shared modal manager component for displaying modal dialogs on this page
    */
-  @property({ type: String }) pageContext?: string;
+  @property({ type: Object }) modalManager?: ModalManagerInterface;
+
+  /**
+   * Array of items that have been selected for management
+   */
+  @property({ type: Object }) selectedItems: Array<ManageableItem> = [];
+
+  /**
+   * Message shows as note in the modal when removing items
+   */
+  @property({ type: String }) manageViewModalMsg?: string;
 
   /**
    * Whether to show the "Select All" button (default false)
@@ -32,6 +42,11 @@ export class ManageBar extends LitElement {
    */
   @property({ type: Boolean }) showUnselectAll = false;
 
+  /**
+   * Whether to show "Item Manager the items" button (default false)
+   */
+  @property({ type: Boolean }) showItemManageButton = false;
+
   /**
    * Whether to active delete button for selectable items
    */
@@ -48,21 +63,20 @@ export class ManageBar extends LitElement {
           <button
             class="ia-button danger"
             ?disabled=${!this.removeAllowed}
-            @click=${this.removeClicked}
+            @click=${this.showRemoveItemsModal}
           >
             ${msg('Remove selected items')}
           </button>
-          ${this.pageContext === 'search'
-            ? html`
-                <button
-                  class="ia-button warning"
-                  ?disabled=${!this.removeAllowed}
-                  @click=${this.itemsManagerClicked}
-                >
-                  ${msg('Item Manager the items')}
-                </button>
-              `
-            : ''}
+          ${when(
+            this.showItemManageButton,
+            () => html` <button
+              class="ia-button warning"
+              ?disabled=${!this.removeAllowed}
+              @click=${this.manageItemsClicked}
+            >
+              ${msg('Item Manager the items')}
+            </button>`
+          )}
           <div class="selection-buttons">
             ${when(
               this.showSelectAll,
@@ -92,12 +106,12 @@ export class ManageBar extends LitElement {
     this.dispatchEvent(new CustomEvent('cancel'));
   }
 
-  private removeClicked(): void {
+  private removeItemsClicked(): void {
     this.dispatchEvent(new CustomEvent('removeItems'));
   }
 
-  private itemsManagerClicked(): void {
-    this.dispatchEvent(new CustomEvent('itemsManager'));
+  private manageItemsClicked(): void {
+    this.dispatchEvent(new CustomEvent('manageItems'));
   }
 
   private selectAllClicked(): void {
@@ -108,6 +122,88 @@ export class ManageBar extends LitElement {
     this.dispatchEvent(new CustomEvent('unselectAll'));
   }
 
+  /**
+   * Shows a modal dialog confirming the list of items to be removed
+   * @param items Which items to list in the modal
+   */
+  private showRemoveItemsModal(): void {
+    const customModalContent = html`
+      <remove-items-modal-content
+        .items=${this.selectedItems}
+        .message=${this.manageViewModalMsg}
+        @confirm=${() => this.removeItemsClicked()}
+      ></remove-items-modal-content>
+    `;
+
+    const config = new ModalConfig({
+      showProcessingIndicator: false,
+      processingImageMode: 'processing',
+      bodyColor: '#fff',
+      headerColor: '#194880',
+      showHeaderLogo: false,
+      closeOnBackdropClick: true,
+      title: html`${msg('Are you sure you want to remove these items?')}`,
+    });
+
+    this.modalManager?.classList.add('remove-items');
+    this.modalManager?.showModal({
+      config,
+      customModalContent,
+      userClosedModalCallback: () => {
+        this.modalManager?.classList.remove('remove-items');
+      },
+    });
+  }
+
+  /**
+   * Shows a modal dialog indicating that item removal is being processed
+   */
+  showRemoveItemsProcessingModal(): void {
+    const config = new ModalConfig({
+      showProcessingIndicator: true,
+      processingImageMode: 'processing',
+      bodyColor: '#fff',
+      headerColor: '#194880',
+      showHeaderLogo: false,
+      closeOnBackdropClick: true,
+      title: html`${msg('Removing selected items...')}`,
+    });
+
+    this.modalManager?.classList.add('remove-items');
+    this.modalManager?.showModal({
+      config,
+      userClosedModalCallback: () => {
+        this.modalManager?.classList.remove('remove-items');
+      },
+    });
+  }
+
+  /**
+   * Shows a modal dialog indicating that an error occurred while removing items
+   */
+  showRemoveItemsErrorModal(): void {
+    const config = new ModalConfig({
+      showProcessingIndicator: false,
+      processingImageMode: 'processing',
+      bodyColor: '#fff',
+      headerColor: '#691916',
+      showHeaderLogo: false,
+      closeOnBackdropClick: true,
+      title: html`${msg('Error: unable to remove items')}`,
+      message: html`${msg(
+        'An error occurred while removing items. Please try again in a few minutes.'
+      )}`,
+    });
+
+    this.modalManager?.classList.add('remove-items');
+    this.modalManager?.showModal({
+      config,
+      userClosedModalCallback: () => {
+        this.modalManager?.classList.remove('remove-items');
+      },
+    });
+  }
+
   static get styles(): CSSResultGroup {
     return css`
       ${iaButtonStyle}

package/src/manage/remove-items-modal-content.ts

@@ -0,0 +1,102 @@
+import { LitElement, html, css, nothing, TemplateResult, CSSResult } from 'lit';
+import { customElement, property } from 'lit/decorators.js';
+import { msg } from '@lit/localize';
+import { map } from 'lit/directives/map.js';
+import type { ManageableItem } from '../models';
+
+@customElement('remove-items-modal-content')
+export class RemoveItemsModalContent extends LitElement {
+  @property({ type: Object }) items: ManageableItem[] = [];
+
+  @property({ type: String }) message?: string;
+
+  render(): TemplateResult {
+    return html`
+      <ul>
+        ${map(
+          this.items,
+          ({ title, date }) => html`
+            <li>
+              <span class="item-title">${title ?? '[untitled]'}</span>
+              <span class="item-date">${date ?? ''}</span>
+            </li>
+          `
+        )}
+      </ul>
+      ${this.message ? html`<p class="message">${this.message}</p>` : nothing}
+      <div class="button-bar">
+        <button class="remove-items-btn" @click=${this.removeItemsBtnClicked}>
+          ${msg('Remove items')}
+        </button>
+      </div>
+    `;
+  }
+
+  private removeItemsBtnClicked(): void {
+    this.dispatchEvent(
+      new CustomEvent<{ items: ManageableItem[] }>('confirm', {
+        detail: {
+          items: this.items,
+        },
+      })
+    );
+  }
+
+  static get styles(): CSSResult {
+    return css`
+      ul {
+        margin: 0;
+        padding: 0 10px;
+        font-size: 1.4rem;
+        list-style-type: none;
+        max-height: min(400px, 40vh);
+        overflow-y: auto;
+      }
+
+      li {
+        display: flex;
+        justify-content: space-between;
+        padding: 2px 0;
+      }
+      li:not(:last-of-type) {
+        border-bottom: 1px solid rgb(232, 232, 232);
+      }
+
+      .item-title {
+        word-break: break-word;
+      }
+
+      .item-date {
+        white-space: nowrap;
+      }
+
+      .message {
+        font-size: 1.4rem;
+        padding: 5px 10px;
+      }
+
+      .button-bar {
+        display: flex;
+        justify-content: center;
+        margin: 10px 5px;
+      }
+
+      .remove-items-btn {
+        margin-bottom: 10px;
+        padding: 10px;
+        border: 1px solid var(--primaryErrorCTABorder, #d43f3a);
+        border-radius: 4px;
+        color: white;
+        background: var(--primaryErrorCTAFill, #d9534f);
+        appearance: none;
+        cursor: pointer;
+      }
+      .remove-items-btn:hover {
+        background: rgba(var(--primaryErrorCTAFillRGB, 229, 28, 38), 0.9);
+      }
+      .remove-items-btn:active {
+        background: rgba(var(--primaryErrorCTAFillRGB, 229, 28, 38), 0.7);
+      }
+    `;
+  }
+}

package/src/models.ts

@@ -675,3 +675,13 @@ export const suppressedCollections: Record<string, boolean> = {
   americana: true,
   toronto: true,
 };
+
+/**
+ * A record of manageable item
+ */
+export interface ManageableItem {
+  identifier: string;
+  title?: string;
+  dateStr?: string;
+  date?: string;
+}

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

@@ -2,9 +2,14 @@
 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';
+import {
+  ModalManager,
+  ModalManagerInterface,
+} from '@internetarchive/modal-manager';
+import '@internetarchive/modal-manager';
+import { msg } from '@lit/localize';
+import type { ManageBar } from '../../src/manage/manage-bar';
 
 describe('Manage bar', () => {
   it('renders basic component', async () => {
@@ -38,7 +43,7 @@ describe('Manage bar', () => {
 
   it('render item manager button for /search/ page', async () => {
     const el = await fixture<ManageBar>(
-      html`<manage-bar .pageContext=${'search'}></manage-bar>`
+      html`<manage-bar showItemManageButton></manage-bar>`
     );
     expect(el.shadowRoot?.querySelector('.ia-button.warning')).to.exist;
   });
@@ -84,21 +89,6 @@ describe('Manage bar', () => {
     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} removeAllowed></manage-bar>`
-    );
-
-    const removeItemsBtn = el.shadowRoot?.querySelector(
-      '.ia-button.danger'
-    ) 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>(
@@ -128,4 +118,37 @@ describe('Manage bar', () => {
     unselectAllBtn.click();
     expect(spy.callCount).to.equal(1);
   });
+
+  it('opens the remove items modal when showRemoveItemsModal is clicked', async () => {
+    const el = await fixture<ManageBar>(html`
+      <manage-bar
+        .modalManager=${new ModalManager()}
+        .selectedItems=${[{ identifier: '1', title: 'Item 1' }]}
+        removeAllowed
+      ></manage-bar>
+    `);
+    await el.updateComplete;
+
+    const removeButton = el.shadowRoot?.querySelector(
+      '.ia-button.danger'
+    ) as HTMLButtonElement;
+    expect(removeButton).to.exist;
+
+    const showModalSpy = Sinon.spy(
+      el.modalManager as ModalManagerInterface,
+      'showModal'
+    );
+
+    await el.updateComplete;
+    removeButton?.click();
+
+    console.log(showModalSpy.args[0][0].config.title?.values[0]);
+
+    expect(showModalSpy.callCount).to.equal(1);
+    expect(el.modalManager?.classList.contains('remove-items')).to.be;
+    expect(showModalSpy.args[0][0].config.title?.values[0]).to.equal(
+      msg('Are you sure you want to remove these items?')
+    );
+    expect(showModalSpy.args[0][0].customModalContent).to.exist;
+  });
 });

package/test/manage/remove-items-modal-content.test.ts

@@ -0,0 +1,82 @@
+/* eslint-disable import/no-duplicates */
+import { expect, fixture } from '@open-wc/testing';
+import { html } from 'lit';
+import Sinon from 'sinon';
+import type { ManageableItem } from '../../src/models';
+import type { RemoveItemsModalContent } from '../../src/manage/remove-items-modal-content';
+import '../../src/manage/remove-items-modal-content';
+
+describe('RemoveItemsModalContent', () => {
+  const items: ManageableItem[] = [
+    { identifier: '1', title: 'Item 1', date: '2022-01-01' },
+    { identifier: '2', title: 'Item 2', date: '2022-01-02' },
+  ];
+
+  it('renders basic component', async () => {
+    const el = await fixture<RemoveItemsModalContent>(html`
+      <remove-items-modal-content
+        .items=${items}
+        .message=${''}
+      ></remove-items-modal-content>
+    `);
+
+    expect(el.shadowRoot?.querySelector('ul')).to.exist;
+    expect(el.shadowRoot?.querySelector('.button-bar')).to.exist;
+    expect(el.shadowRoot?.querySelector('.remove-items-btn')).to.exist;
+  });
+
+  it('renders list of items', async () => {
+    const el = await fixture<RemoveItemsModalContent>(html`
+      <remove-items-modal-content
+        .items=${items}
+        .message=${''}
+      ></remove-items-modal-content>
+    `);
+
+    const listItems = el.shadowRoot?.querySelectorAll('li');
+    expect(listItems).to.have.lengthOf(2);
+
+    listItems?.forEach((item, index) => {
+      expect(item.querySelector('.item-title')?.textContent).to.equal(
+        items[index].title
+      );
+      expect(item.querySelector('.item-date')?.textContent).to.equal(
+        items[index].date
+      );
+    });
+  });
+
+  it('renders message', async () => {
+    const message = 'This is a test message';
+    const el = await fixture<RemoveItemsModalContent>(html`
+      <remove-items-modal-content
+        .items=${[]}
+        .message=${message}
+      ></remove-items-modal-content>
+    `);
+
+    expect(el.shadowRoot?.querySelector('.message')?.textContent).to.equal(
+      message
+    );
+  });
+
+  it('dispatches confirm event when remove items button is clicked', async () => {
+    const el = await fixture<RemoveItemsModalContent>(html`
+      <remove-items-modal-content
+        .items=${items}
+        .message=${''}
+      ></remove-items-modal-content>
+    `);
+
+    const spy = Sinon.spy();
+    el.addEventListener('confirm', spy);
+
+    const button = el.shadowRoot?.querySelector(
+      '.remove-items-btn'
+    ) as HTMLInputElement;
+    button?.click();
+
+    expect(spy.calledOnce).to.be.true;
+    expect(spy.args[0][0].detail.items).to.deep.equal(items);
+  });
+});

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