@internetarchive/collection-browser 2.7.6-alpha1 → 2.7.6-alpha3

package/src/app-root.ts

@@ -50,8 +50,6 @@ export class AppRoot extends LitElement {
 
   @state() private searchType: SearchType = SearchType.METADATA;
 
-  @state() private itemRemovalError: String = '';
-
   @property({ type: Object, reflect: false }) latestAction?: AnalyticsEvent;
 
   @query('#base-query-field') private baseQueryField!: HTMLInputElement;
@@ -487,20 +485,13 @@ export class AppRoot extends LitElement {
           .modalManager=${this.modalManager}
           .analyticsHandler=${this.analyticsHandler}
           .pageContext=${'search'}
-          .activeTabId=${'uploads'}
-          .itemRemovalFailed=${''}
+          .activeTabId=${''}
           @visiblePageChanged=${this.visiblePageChanged}
           @baseQueryChanged=${this.baseQueryChanged}
           @searchTypeChanged=${this.searchTypeChanged}
           @manageModeChanged=${this.manageModeChanged}
-          @itemRemovalRequested=${(e: CustomEvent) => {
-            console.log('itemRemovalRequested: ', e.detail.items);
-            setTimeout(() => {
-              this.itemRemovalError = 'something has changed!';
-            }, 1200);
-          }}
-          @itemManagerRequested=${(e: CustomEvent) =>
-            console.log('itemManagerRequested: ', e.detail.items)}
+          @itemRemovalRequested=${this.handleItemRemovalRequest}
+          @itemManagerRequested=${this.handleItemManagerRequest}
         >
           ${this.toggleSlots
             ? html`<div slot="sortbar-left-slot">Sort Slot</div>`
@@ -715,6 +706,35 @@ export class AppRoot extends LitElement {
     if (manageCheckbox) manageCheckbox.checked = e.detail;
   }
 
+  /**
+   * Handler for item removal
+   */
+  private handleItemRemovalRequest(e: CustomEvent) {
+    setTimeout(() => {
+      console.log('itemRemovalRequested: ', e.detail.items);
+
+      // execute item-removal-service, and response is successfully deleted
+      const status = false;
+
+      if (status) {
+        // looking for success?
+        this.collectionBrowser.isManageView = false;
+        this.modalManager?.closeModal();
+        this.modalManager?.classList.remove('remove-items');
+      } else {
+        // looking for failure?
+        this.collectionBrowser.hasItemsDeleted = false;
+      }
+    }, 2000); // let's wait to see processing modal
+  }
+
+  /**
+   * Handler when item manage requested
+   */
+  private handleItemManagerRequest(e: CustomEvent) {
+    console.log('itemManagerRequested: ', e.detail.items);
+  }
+
   /**
    * Handler for when the dev panel's "Enable manage mode" checkbox is changed.
    */
@@ -723,7 +743,7 @@ export class AppRoot extends LitElement {
     this.collectionBrowser.isManageView = target.checked;
     this.collectionBrowser.manageViewLabel =
       'Select items to remove (customizable texts)';
-    this.itemRemovalError = '';
+    this.collectionBrowser.hasItemsDeleted = true;
   }
 
   /**

package/src/collection-browser.ts

@@ -44,6 +44,7 @@ import {
   SORT_OPTIONS,
   defaultProfileElementSorts,
   FacetLoadStrategy,
+  ManageableItem,
 } from './models';
 import {
   RestorationStateHandlerInterface,
@@ -244,7 +245,9 @@ export class CollectionBrowser
   /**
    * If item management UI active
    */
-  @property({ type: Boolean }) isManageView = true;
+  @property({ type: Boolean }) isManageView = false;
+
+  @property({ type: Boolean }) hasItemsDeleted = true;
 
   @property({ type: String }) manageViewLabel = 'Select items to remove';
 
@@ -264,8 +267,6 @@ export class CollectionBrowser
   @property({ type: Object }) dataSource: CollectionBrowserDataSourceInterface =
     new CollectionBrowserDataSource(this, this.pageSize);
 
-  @property({ type: String }) itemRemovalFailed = '';
-
   /**
    * The page that the consumer wants to load.
    */
@@ -782,10 +783,10 @@ export class CollectionBrowser
         .label=${this.manageViewLabel}
         .modalManager=${this.modalManager}
         .selectedItems=${this.dataSource.checkedTileModels}
-        .itemRemovalFailed=${this.itemRemovalFailed}
+        .hasItemsDeleted=${this.hasItemsDeleted}
         showSelectAll
         showUnselectAll
-        ?showManageButton=${this.pageContext === 'search'}
+        ?showItemManageButton=${this.pageContext === 'search'}
         ?removeAllowed=${this.dataSource.checkedTileModels.length !== 0}
         @removeItems=${this.handleRemoveItems}
         @manageItems=${this.handleManageItems}
@@ -804,14 +805,16 @@ export class CollectionBrowser
    * Emits an `itemRemovalRequested` event with all checked tile models.
    */
   private handleRemoveItems(): void {
+    this.hasItemsDeleted = true;
+
     this.dispatchEvent(
-      new CustomEvent<{ items: String }>('itemRemovalRequested', {
+      new CustomEvent<{ items: ManageableItem[] }>('itemRemovalRequested', {
         detail: {
           items: this.dataSource.checkedTileModels.map(model => {
             const cloned = model.clone();
             cloned.dateStr = formatDate(model.datePublished, 'long');
-            return cloned.identifier;
-          }).join(','),
+            return cloned as ManageableItem;
+          }),
         },
       })
     );
@@ -822,12 +825,11 @@ export class CollectionBrowser
    */
   private handleManageItems(): void {
     this.dispatchEvent(
-      new CustomEvent<{ items: String }>('itemManagerRequested', {
+      new CustomEvent<{ items: ManageableItem[] }>('itemManagerRequested', {
         detail: {
-          items: this.dataSource.checkedTileModels
-            .map(item => item.identifier)
-            .filter(Boolean)
-            .join(','),
+          items: this.dataSource.checkedTileModels.map(
+            model => model as ManageableItem
+          ),
         },
       })
     );

package/src/manage/manage-bar.ts

@@ -13,15 +13,10 @@ import {
   ModalConfig,
   type ModalManagerInterface,
 } from '@internetarchive/modal-manager';
+import type { ManageableItem } from '../models';
 import iaButtonStyle from '../styles/ia-button';
 import './remove-items-modal-content';
 
-export interface ManageableItem {
-  identifier: string;
-  title?: string;
-  dateStr?: string;
-}
-
 @customElement('manage-bar')
 export class ManageBar extends LitElement {
   /**
@@ -44,11 +39,6 @@ export class ManageBar extends LitElement {
    */
   @property({ type: Object }) selectedItems: Array<ManageableItem> = [];
 
-  /**
-   * Item removal failure message, if any
-   */
-  @property({ type: String }) itemRemovalFailed = '';
-
   /**
    * Whether to show the "Select All" button (default false)
    */
@@ -59,10 +49,15 @@ export class ManageBar extends LitElement {
    */
   @property({ type: Boolean }) showUnselectAll = false;
 
+  /**
+   * Whether item has deleted or not (default true)
+   */
+  @property({ type: Boolean }) hasItemsDeleted = true;
+
   /**
    * Whether to show "Item Manager the items" button (default false)
    */
-  @property({ type: Boolean }) showManageButton = false;
+  @property({ type: Boolean }) showItemManageButton = false;
 
   /**
    * Whether to active delete button for selectable items
@@ -70,7 +65,7 @@ export class ManageBar extends LitElement {
   @property({ type: Boolean }) removeAllowed = false;
 
   updated(changed: PropertyValues): void {
-    if (changed.has('itemRemovalFailed') && this.itemRemovalFailed !== '') {
+    if (changed.has('hasItemsDeleted') && !this.hasItemsDeleted) {
       this.showRemoveItemsErrorModal();
     }
   }
@@ -91,7 +86,7 @@ export class ManageBar extends LitElement {
             ${msg('Remove selected items')}
           </button>
           ${when(
-            this.showManageButton,
+            this.showItemManageButton,
             () => html` <button
               class="ia-button warning"
               ?disabled=${!this.removeAllowed}
@@ -129,10 +124,6 @@ export class ManageBar extends LitElement {
     this.dispatchEvent(new CustomEvent('cancel'));
   }
 
-  /**
-   * Shows a modal dialog confirming the list of items to be removed
-   * @param items Which items to list in the modal
-   */
   private removeItemsClicked(): void {
     this.showRemoveItemsProcessingModal();
     this.dispatchEvent(new CustomEvent('removeItems'));
@@ -225,7 +216,9 @@ export class ManageBar extends LitElement {
       showHeaderLogo: false,
       closeOnBackdropClick: true,
       title: html`${msg('Error: unable to remove items')}`,
-      message: html`${msg(this.itemRemovalFailed)}`,
+      message: html`${msg(
+        'An error occurred while removing items. Please try again in a few minutes.'
+      )}`,
     });
 
     this.modalManager?.classList.add('remove-items');

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

@@ -2,12 +2,7 @@ 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';
-
-export interface ManageableItem {
-  identifier: string;
-  title?: string;
-  date?: string;
-}
+import type { ManageableItem } from '../models';
 
 @customElement('remove-items-modal-content')
 export class RemoveItemsModalContent extends LitElement {

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