@internetarchive/collection-browser 2.7.7 → 2.7.8-alpha1

package/src/collection-browser.ts

@@ -57,7 +57,6 @@ import type {
 } from './data-source/collection-browser-query-state';
 import { FACETLESS_PAGE_ELEMENTS } from './data-source/models';
 import type { CollectionFacets } from './collection-facets';
-import type { ManageableItem } from './manage/manage-bar';
 import type { CollectionBrowserDataSourceInterface } from './data-source/collection-browser-data-source-interface';
 import {
   analyticsActions,
@@ -66,9 +65,9 @@ import {
 import chevronIcon from './assets/img/icons/chevron';
 import { srOnlyStyle } from './styles/sr-only';
 import { sha1 } from './utils/sha1';
-import { formatDate } from './utils/format-date';
 import { log } from './utils/log';
 import type { PlaceholderType } from './empty-placeholder';
+import type { ManageBar } from './manage/manage-bar';
 
 import './empty-placeholder';
 import './tiles/tile-dispatcher';
@@ -263,6 +262,12 @@ export class CollectionBrowser
   @property({ type: Object }) dataSource: CollectionBrowserDataSourceInterface =
     new CollectionBrowserDataSource(this, this.pageSize);
 
+  /**
+   * The maximum number of pages we will load when a privileged user clicks
+   * the "Manage" button on the search page. Limited to 15 pages.
+   */
+  maxPagesToManage = 15;
+
   /**
    * The page that the consumer wants to load.
    */
@@ -299,6 +304,8 @@ export class CollectionBrowser
 
   @query('collection-facets') private collectionFacets?: CollectionFacets;
 
+  @query('manage-bar') private manageBar?: ManageBar;
+
   @property({ type: Object, attribute: false })
   analyticsHandler?: AnalyticsManagerInterface;
 
@@ -774,20 +781,29 @@ export class CollectionBrowser
    * showing the management view. This generally replaces the sort bar when present.
    */
   private get manageBarTemplate(): TemplateResult {
+    const manageViewModalMsg =
+      this.profileElement === 'uploads'
+        ? 'Note: it may take a few minutes for these items to stop appearing in your uploads list.'
+        : nothing;
+
     return html`
       <manage-bar
         .label=${this.manageViewLabel}
-        .pageContext=${this.pageContext}
+        .modalManager=${this.modalManager}
+        .selectedItems=${this.dataSource.checkedTileModels}
+        .manageViewModalMsg=${manageViewModalMsg}
         showSelectAll
         showUnselectAll
+        ?showItemManageButton=${this.pageContext === 'search'}
         ?removeAllowed=${this.dataSource.checkedTileModels.length !== 0}
         @removeItems=${this.handleRemoveItems}
-        @itemsManager=${this.handleItemsManager}
+        @manageItems=${this.handleManageItems}
         @selectAll=${() => this.dataSource.checkAllTiles()}
         @unselectAll=${() => this.dataSource.uncheckAllTiles()}
         @cancel=${() => {
           this.isManageView = false;
           this.dataSource.uncheckAllTiles();
+          if (this.searchResultsLoading) this.dataSource.resetPages();
         }}
       ></manage-bar>
     `;
@@ -799,13 +815,11 @@ export class CollectionBrowser
    */
   private handleRemoveItems(): void {
     this.dispatchEvent(
-      new CustomEvent<{ items: ManageableItem[] }>('itemRemovalRequested', {
+      new CustomEvent<{ items: String[] }>('itemRemovalRequested', {
         detail: {
-          items: this.dataSource.checkedTileModels.map(model => {
-            const cloned = model.clone();
-            cloned.dateStr = formatDate(model.datePublished, 'long');
-            return cloned as ManageableItem;
-          }),
+          items: this.dataSource.checkedTileModels.map(model =>
+            model?.identifier ? model.identifier : ''
+          ),
         },
       })
     );
@@ -814,19 +828,32 @@ export class CollectionBrowser
   /**
    * Handler when user request to bulk edit from /search/ page
    */
-  private handleItemsManager(): void {
+  private handleManageItems(): void {
     this.dispatchEvent(
-      new CustomEvent('itemManagerRequested', {
+      new CustomEvent<{ items: String[] }>('itemManagerRequested', {
         detail: {
-          items: this.dataSource.checkedTileModels
-            .map(item => item.identifier)
-            .filter(Boolean)
-            .join(','),
+          items: this.dataSource.checkedTileModels.map(model =>
+            model?.identifier ? model.identifier : ''
+          ),
         },
       })
     );
   }
 
+  /**
+   * Handler to show processing modal while removing item
+   */
+  showRemoveItemsProcessingModal(): void {
+    this.manageBar?.showRemoveItemsProcessingModal();
+  }
+
+  /**
+   * Handler to show error modal when item removal failed
+   */
+  showRemoveItemsErrorModal(): void {
+    this.manageBar?.showRemoveItemsErrorModal();
+  }
+
   /**
    * Removes all tile models that are currently checked & adjusts the paging
    * of the data source to account for any new gaps in the data.
@@ -1430,7 +1457,11 @@ export class CollectionBrowser
     }
 
     if (changed.has('isManageView')) {
-      if (this.isManageView) this.displayMode = 'grid';
+      if (this.isManageView) {
+        this.displayMode = 'grid';
+        this.fetchManagableSearchResults();
+      } else if (this.pageContext === 'search') this.infiniteScroller?.reload();
+
       this.infiniteScroller?.refreshAllVisibleCells();
       this.emitManageModeChangedEvent();
     }
@@ -2066,6 +2097,24 @@ export class CollectionBrowser
     }
   }
 
+  /**
+   * Fetches search results for privileged users when in manage view
+   * If total results exceed the threshold, partially resets the datasource pages
+   * and fetches the first page with a limit based on the threshold
+   */
+  private fetchManagableSearchResults(): void {
+    const maxAllowedResults = this.maxPagesToManage * this.pageSize;
+    if (
+      this.pageContext === 'search' &&
+      this.dataSource.totalResults > maxAllowedResults &&
+      !this.searchResultsLoading
+    ) {
+      this.dataSource.resetPages();
+      this.dataSource.fetchPage(1, this.maxPagesToManage); // will fetch 750 results
+      this.infiniteScroller?.reload();
+    }
+  }
+
   static get styles() {
     return [
       srOnlyStyle,

package/src/data-source/collection-browser-data-source-interface.ts

@@ -155,6 +155,11 @@ export interface CollectionBrowserDataSourceInterface
    */
   reset(): void;
 
+  /**
+   * Resets the data source to its pages.
+   */
+  resetPages(): void;
+
   /**
    * Adds the given page of tile models to the data source.
    * If the given page number already exists, that page will be overwritten.

package/src/data-source/collection-browser-data-source.ts

@@ -246,6 +246,19 @@ export class CollectionBrowserDataSource
     this.requestHostUpdate();
   }
 
+  /**
+   * @inheritdoc
+   */
+  resetPages(): void {
+    if (Object.keys(this.pages).length !== this.host.maxPagesToManage) {
+      this.pages = {};
+    }
+
+    // Invalidate any fetches in progress
+    this.fetchesInProgress.clear();
+    this.requestHostUpdate();
+  }
+
   /**
    * @inheritdoc
    */
@@ -433,6 +446,7 @@ export class CollectionBrowserDataSource
   map(
     callback: (model: TileModel, index: number, array: TileModel[]) => TileModel
   ): void {
+    if (!Object.keys(this.pages).length) return;
     this.pages = Object.fromEntries(
       Object.entries(this.pages).map(([page, tileModels]) => [
         page,

package/src/data-source/collection-browser-query-state.ts

@@ -38,6 +38,7 @@ export interface CollectionBrowserSearchInterface
   readonly defaultSortField: SortField | null;
   readonly facetLoadStrategy: FacetLoadStrategy;
   readonly initialPageNumber: number;
+  readonly maxPagesToManage: number;
   readonly currentVisiblePageNumbers: number[];
   readonly clearResultsOnEmptyQuery?: boolean;
   readonly dataSource?: CollectionBrowserDataSourceInterface;

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')}
+            ${msg('Remove selected items')} (${this.selectedItems.length})
           </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')} (${this.selectedItems.length})
+            </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/collection-browser.test.ts

@@ -2001,4 +2001,27 @@ describe('Collection Browser', () => {
     const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
     expect(infiniteScroller).not.to.exist;
   });
+
+  it('fetch larger result on search page for admin user to manage items', async () => {
+    const resultsSpy = sinon.spy();
+    const searchService = new MockSearchService({
+      asyncResponse: true,
+      resultsSpy,
+    });
+
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    const numberOfPages = 15;
+
+    el.baseQuery = 'jack';
+    el.isManageView = true;
+    await el.dataSource.fetchPage(1, numberOfPages);
+    await el.updateComplete;
+
+    const initialResults = el.dataSource.getAllPages();
+    expect(Object.keys(initialResults).length).to.deep.equal(numberOfPages);
+  });
 });

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