@internetarchive/collection-browser 2.7.5 → 2.7.6-alpha1

package/src/manage/manage-bar.ts

@@ -1,8 +1,20 @@
 import { msg } from '@lit/localize';
-import { LitElement, html, css, TemplateResult, CSSResultGroup } from 'lit';
+import {
+  LitElement,
+  html,
+  css,
+  TemplateResult,
+  CSSResultGroup,
+  PropertyValues,
+} 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 iaButtonStyle from '../styles/ia-button';
+import './remove-items-modal-content';
 
 export interface ManageableItem {
   identifier: string;
@@ -17,6 +29,26 @@ 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
+   */
+  @property({ type: String }) activeTabId?: string;
+
+  /**
+   * The shared modal manager component for displaying modal dialogs on this page
+   */
+  @property({ type: Object }) modalManager?: ModalManagerInterface;
+
+  /**
+   * Array of items that have been selected for management
+   */
+  @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)
    */
@@ -27,11 +59,22 @@ export class ManageBar extends LitElement {
    */
   @property({ type: Boolean }) showUnselectAll = false;
 
+  /**
+   * Whether to show "Item Manager the items" button (default false)
+   */
+  @property({ type: Boolean }) showManageButton = false;
+
   /**
    * Whether to active delete button for selectable items
    */
   @property({ type: Boolean }) removeAllowed = false;
 
+  updated(changed: PropertyValues): void {
+    if (changed.has('itemRemovalFailed') && this.itemRemovalFailed !== '') {
+      this.showRemoveItemsErrorModal();
+    }
+  }
+
   render(): TemplateResult {
     return html`
       <div class="manage-container">
@@ -43,15 +86,25 @@ export class ManageBar extends LitElement {
           <button
             class="ia-button danger"
             ?disabled=${!this.removeAllowed}
-            @click=${this.removeClicked}
+            @click=${this.showRemoveItemsModal}
           >
             ${msg('Remove selected items')}
           </button>
+          ${when(
+            this.showManageButton,
+            () => 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,
               () => html` <button
-                class="link-styled select-all-btn"
+                class="ia-button link select-all-btn"
                 @click=${this.selectAllClicked}
               >
                 ${msg('Select all')}
@@ -60,7 +113,7 @@ export class ManageBar extends LitElement {
             ${when(
               this.showUnselectAll,
               () => html` <button
-                class="link-styled unselect-all-btn"
+                class="ia-button link unselect-all-btn"
                 @click=${this.unselectAllClicked}
               >
                 ${msg('Unselect all')}
@@ -76,10 +129,19 @@ export class ManageBar extends LitElement {
     this.dispatchEvent(new CustomEvent('cancel'));
   }
 
-  private removeClicked(): void {
+  /**
+   * 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'));
   }
 
+  private manageItemsClicked(): void {
+    this.dispatchEvent(new CustomEvent('manageItems'));
+  }
+
   private selectAllClicked(): void {
     this.dispatchEvent(new CustomEvent('selectAll'));
   }
@@ -88,6 +150,93 @@ 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 delayMessage =
+      this.activeTabId === 'uploads'
+        ? msg(
+            'Note: it may take a few minutes for these items to stop appearing in your uploads list.'
+          )
+        : undefined;
+
+    const customModalContent = html`
+      <remove-items-modal-content
+        .items=${this.selectedItems}
+        .message=${delayMessage}
+        @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
+   */
+  private 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
+   */
+  private 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(this.itemRemovalFailed)}`,
+    });
+
+    this.modalManager?.classList.add('remove-items');
+    this.modalManager?.showModal({
+      config,
+      userClosedModalCallback: () => {
+        this.modalManager?.classList.remove('remove-items');
+      },
+    });
+  }
+
   static get styles(): CSSResultGroup {
     return css`
       ${iaButtonStyle}
@@ -108,33 +257,20 @@ export class ManageBar extends LitElement {
 
       .manage-buttons {
         display: flex;
+        flex-wrap: wrap;
         align-items: center;
         column-gap: 5px;
       }
 
+      .selection-buttons {
+        display: inherit;
+      }
+
       .ia-button,
       button {
         padding: 6px 12px;
         font-size: 1.4rem;
-      }
-
-      .ia-button.danger:disabled {
-        opacity: 0.5;
-      }
-
-      button.link-styled {
-        margin: 0;
-        padding: 6px;
-        border: 0;
-        appearance: none;
-        background: none;
-        color: var(--ia-theme-link-color, #4b64ff);
-        font: inherit;
-        text-decoration: none;
-        cursor: pointer;
-      }
-      button.link-styled:hover {
-        text-decoration: underline;
+        margin: 3px 0;
       }
     `;
   }

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

@@ -0,0 +1,107 @@
+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;
+}
+
+@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

@@ -236,9 +236,9 @@ export type TileDisplayMode =
 /**
  * This is mainly used to set the cookies for the collection display mode.
  *
- * It allows the user to set different modes for different contexts (collection page, search page, etc).
+ * It allows the user to set different modes for different contexts (collection page, search page, profile page etc).
  */
-export type CollectionBrowserContext = 'collection' | 'search';
+export type CollectionBrowserContext = 'collection' | 'search' | 'profile';
 
 /**
  * The sort fields shown in the sort filter bar

package/src/styles/ia-button.ts

@@ -16,8 +16,9 @@ const darkButtonFillColor = css`var(--secondaryCTAFill, #333)`;
 const darkButtonFillColorRGB = css`var(--secondaryCTAFillRGB, 51, 51, 51)`; // RBG format of --secondaryCTAFill
 const darkButtonBorderColor = css`var(--primaryCTABorder, #979797)`;
 
-const warningButtonBGColor = css`#ee8950`;
-const warningButtonBorderColor = css`#ec7939`;
+const warningButtonFillColor = css`var(---primaryWarningFill, #ee8950)`;
+const warningButtonFillColorRGB = css`var(--primaryWarningFillRGB, 238, 137, 80)`; // RBG format of --primaryWarningFill
+const warningButtonBorderColor = css`var(--primaryWarningBorder, #ec7939)`;
 
 export default css`
   .ia-button {
@@ -58,9 +59,12 @@ export default css`
   .ia-button.transparent {
     background-color: transparent;
   }
-  .ia-button.warning {
-    background-color: ${warningButtonBGColor}
-    border-color: ${warningButtonBorderColor};
+
+  .ia-button.primary:disabled,
+  .ia-button.danger:disabled,
+  .ia-button.warning:disabled,
+  .ia-button.dark:disabled {
+    opacity: 0.5;
   }
 
   .ia-button.primary {
@@ -91,6 +95,20 @@ export default css`
     background-color: rgba(${dangerButtonFillColorRGB}, 0.7);
   }
 
+  .ia-button.warning {
+    background-color: ${warningButtonFillColor};
+    border-color: ${warningButtonBorderColor};
+  }
+  .ia-button.warning:hover {
+    background-color: rgba(${warningButtonFillColorRGB}, 0.9);
+  }
+  .ia-button.warning:focus-visible {
+    background-color: rgba(${warningButtonFillColorRGB}, 0.8);
+  }
+  .ia-button.warning:active {
+    background-color: rgba(${warningButtonFillColorRGB}, 0.7);
+  }
+
   .ia-button.dark {
     background-color: ${darkButtonFillColor};
     border-color: ${darkButtonBorderColor};
@@ -104,4 +122,18 @@ export default css`
   .ia-button.dark:active {
     background-color: rgba(${darkButtonFillColorRGB}, 0.7);
   }
+
+  .ia-button.link {
+    margin: 0;
+    padding: 6px;
+    border: 0;
+    appearance: none;
+    background: none;
+    color: var(--ia-theme-link-color, #4b64ff);
+    text-decoration: none;
+    cursor: pointer;
+  }
+  .ia-button.link:hover {
+    text-decoration: underline;
+  }
 `;

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

@@ -31,6 +31,18 @@ describe('Manage bar', () => {
     expect(el.shadowRoot?.querySelector('.unselect-all-btn')).not.to.exist;
   });
 
+  it('does not render item manager button except /search/ page', async () => {
+    const el = await fixture<ManageBar>(html`<manage-bar></manage-bar>`);
+    expect(el.shadowRoot?.querySelector('.ia-button.warning')).not.to.exist;
+  });
+
+  it('render item manager button for /search/ page', async () => {
+    const el = await fixture<ManageBar>(
+      html`<manage-bar .pageContext=${'search'}></manage-bar>`
+    );
+    expect(el.shadowRoot?.querySelector('.ia-button.warning')).to.exist;
+  });
+
   it('includes Select All button when requested', async () => {
     const el = await fixture<ManageBar>(
       html`<manage-bar showSelectAll></manage-bar>`

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