@internetarchive/collection-browser 3.1.0 → 3.1.1-alpha-webdev6778.2

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

@@ -599,6 +599,7 @@ export class CollectionBrowserDataSource
 
     const trimmedQuery = this.host.baseQuery?.trim();
     const hasNonEmptyQuery = !!trimmedQuery;
+    const hasIdentifiers = !!this.host.identifiers?.length;
     const isCollectionSearch = !!this.host.withinCollection;
     const isProfileSearch = !!this.host.withinProfile;
     const hasProfileElement = !!this.host.profileElement;
@@ -617,6 +618,7 @@ export class CollectionBrowserDataSource
     // Otherwise, a non-empty query must be set.
     return (
       hasNonEmptyQuery ||
+      hasIdentifiers ||
       (isCollectionSearch && isValidForCollectionSearch) ||
       (isProfileSearch && isValidForProfileSearch)
     );
@@ -826,6 +828,11 @@ export class CollectionBrowserDataSource
    * @inheritdoc
    */
   get pageSpecifierParams(): PageSpecifierParams | null {
+    if (this.host.identifiers?.length) {
+      return {
+        pageType: 'client_document_fetch',
+      };
+    }
     if (this.host.withinCollection) {
       return {
         pageType: 'collection_details',
@@ -848,20 +855,20 @@ export class CollectionBrowserDataSource
    * The full query, including year facets and date range clauses
    */
   private get fullQuery(): string | undefined {
-    let fullQuery = this.host.baseQuery?.trim() ?? '';
+    const parts = [];
+    const trimmedQuery = this.host.baseQuery?.trim();
+    if (trimmedQuery) parts.push(trimmedQuery);
+    
+    if (this.host.identifiers) {
+      parts.push(`identifier:(${this.host.identifiers.join(' OR ')})`);
+    }
 
     const { facetQuery, dateRangeQueryClause, sortFilterQueries } = this;
+    if (facetQuery) parts.push(facetQuery);
+    if (dateRangeQueryClause) parts.push(dateRangeQueryClause);
+    if (sortFilterQueries) parts.push(sortFilterQueries);
 
-    if (facetQuery) {
-      fullQuery += ` AND ${facetQuery}`;
-    }
-    if (dateRangeQueryClause) {
-      fullQuery += ` AND ${dateRangeQueryClause}`;
-    }
-    if (sortFilterQueries) {
-      fullQuery += ` AND ${sortFilterQueries}`;
-    }
-    return fullQuery.trim();
+    return parts.join(' AND ').trim();
   }
 
   /**
@@ -1001,6 +1008,7 @@ export class CollectionBrowserDataSource
     const params: SearchParams = {
       ...this.pageSpecifierParams,
       query: trimmedQuery || '',
+      identifiers: this.host.identifiers,
       rows: 0,
       filters: this.filterMap,
       // Fetch a few extra buckets beyond the 6 we show, in case some get suppressed
@@ -1133,6 +1141,7 @@ export class CollectionBrowserDataSource
     const params: SearchParams = {
       ...this.pageSpecifierParams,
       query: trimmedQuery || '',
+      identifiers: this.host.identifiers,
       page: pageNumber,
       rows: numRows,
       sort: sortParams,
@@ -1318,6 +1327,7 @@ export class CollectionBrowserDataSource
     const params: SearchParams = {
       ...this.pageSpecifierParams,
       query: trimmedQuery || '',
+      identifiers: this.host.identifiers,
       rows: 0,
       filters: this.filterMap,
       // Only fetch the firstTitle or firstCreator aggregation

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

@@ -19,6 +19,7 @@ import type { CollectionBrowserDataSourceInterface } from './collection-browser-
  */
 export interface CollectionBrowserQueryState {
   baseQuery?: string;
+  identifiers?: string[];
   withinCollection?: string;
   withinProfile?: string;
   profileElement?: PageElementName;

package/src/data-source/models.ts

@@ -25,7 +25,7 @@ export type PageSpecifierParams = {
   /**
    * The target identifier for collection or profile pages (e.g., "prelinger", "@brewster", ...)
    */
-  pageTarget: string;
+  pageTarget?: string;
   /**
    * Which specific elements of a profile page to fetch. Corresponds to individual tab data
    * (e.g., "uploads", "reviews", ...)

package/src/expanded-date-picker.ts

@@ -1,191 +1,191 @@
-import {
-  css,
-  html,
-  LitElement,
-  CSSResultGroup,
-  TemplateResult,
-  nothing,
-} from 'lit';
-import { customElement, property } from 'lit/decorators.js';
-import { ifDefined } from 'lit/directives/if-defined.js';
-import { msg } from '@lit/localize';
-import type { ModalManagerInterface } from '@internetarchive/modal-manager';
-import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
-import {
-  BarScalingOption,
-  BinSnappingInterval,
-} from '@internetarchive/histogram-date-range';
-import {
-  analyticsActions,
-  analyticsCategories,
-} from './utils/analytics-events';
-
-import '@internetarchive/histogram-date-range';
-
-@customElement('expanded-date-picker')
-export class ExpandedDatePicker extends LitElement {
-  @property({ type: String }) minDate?: string;
-
-  @property({ type: String }) maxDate?: string;
-
-  @property({ type: String }) minSelectedDate?: string;
-
-  @property({ type: String }) maxSelectedDate?: string;
-
-  @property({ type: Array }) buckets?: number[];
-
-  @property({ type: String }) customDateFormat?: string;
-
-  @property({ type: String }) customTooltipDateFormat?: string;
-
-  @property({ type: String }) customTooltipLabel?: string;
-
-  @property({ type: String }) binSnapping: BinSnappingInterval = 'none';
-
-  @property({ type: String }) barScaling: BarScalingOption = 'logarithmic';
-
-  @property({ type: Object, attribute: false })
-  modalManager?: ModalManagerInterface;
-
-  @property({ type: Object, attribute: false })
-  analyticsHandler?: AnalyticsManagerInterface;
-
-  render(): TemplateResult {
-    return html`
-      <div id="container">
-        <histogram-date-range
-          id="date-picker"
-          .minDate=${this.minDate}
-          .maxDate=${this.maxDate}
-          .minSelectedDate=${this.minSelectedDate ?? this.minDate}
-          .maxSelectedDate=${this.maxSelectedDate ?? this.maxDate}
-          dateFormat=${ifDefined(this.customDateFormat)}
-          tooltipDateFormat=${ifDefined(this.customTooltipDateFormat)}
-          tooltipLabel=${ifDefined(this.customTooltipLabel)}
-          .binSnapping=${this.binSnapping}
-          .barScaling=${this.barScaling ?? nothing}
-          .updateDelay=${0}
-          updateWhileFocused
-          missingDataMessage="..."
-          .width=${560}
-          .height=${120}
-          .bins=${this.buckets}
-          @histogramDateRangeUpdated=${this.histogramDateRangeUpdated}
-        >
-          <button
-            id="apply-btn"
-            slot="inputs-right-side"
-            @click=${this.applyBtnClicked}
-          >
-            ${msg('Apply date range')}
-          </button>
-        </histogram-date-range>
-      </div>
-    `;
-  }
-
-  connectedCallback(): void {
-    super.connectedCallback?.();
-    this.setupEscapeListener();
-  }
-
-  disconnectedCallback(): void {
-    super.disconnectedCallback?.();
-    this.removeEscapeListener();
-  }
-
-  /**
-   * Add an event listener to close the date picker modal when the Esc key is pressed
-   */
-  private setupEscapeListener() {
-    document.addEventListener('keydown', this.boundEscapeListener);
-  }
-
-  /**
-   * Remove the Esc key listener that was previously added
-   */
-  private removeEscapeListener() {
-    document.removeEventListener('keydown', this.boundEscapeListener);
-  }
-
-  /**
-   * Closes the modal dialog if the given event is pressing the Esc key.
-   * Arrow function to ensure `this` remains bound to the current component.
-   */
-  private boundEscapeListener = (e: KeyboardEvent) => {
-    if (e.key === 'Escape') {
-      this.closeModal();
-    }
-  };
-
-  /**
-   * When the histogram is updated, keep track of the newly selected date range.
-   * We don't commit to the new range until the apply button is clicked.
-   */
-  private histogramDateRangeUpdated(
-    e: CustomEvent<{
-      minDate: string;
-      maxDate: string;
-    }>,
-  ): void {
-    this.minSelectedDate = e.detail.minDate;
-    this.maxSelectedDate = e.detail.maxDate;
-  }
-
-  /**
-   * When the Apply button is clicked, emit the current date range and close the modal.
-   */
-  private applyBtnClicked(): void {
-    const event = new CustomEvent('histogramDateRangeApplied', {
-      detail: {
-        minDate: this.minSelectedDate,
-        maxDate: this.maxSelectedDate,
-      },
-    });
-    this.dispatchEvent(event);
-    this.closeModal();
-
-    this.analyticsHandler?.sendEvent({
-      category: analyticsCategories.default,
-      action: analyticsActions.histogramChangedFromModal,
-      label: window.location.href,
-    });
-  }
-
-  /**
-   * Closes the modal associated with this component (if it exists) and dispatches a
-   * modalClosed event.
-   */
-  private closeModal(): void {
-    if (this.modalManager) {
-      this.modalManager.closeModal();
-      this.dispatchEvent(new CustomEvent('modalClosed'));
-    }
-  }
-
-  static get styles(): CSSResultGroup {
-    return css`
-      #container {
-        display: flex;
-        justify-content: center;
-        padding: 40px 10px 10px;
-        overflow: hidden;
-      }
-
-      #date-picker {
-        --histogramDateRangeInputWidth: 50px;
-        --histogramDateRangeInputRowMargin: 5px 0 0 0;
-      }
-
-      #apply-btn {
-        margin: 0 0 0 5px;
-        padding: 8px 10px;
-        border: 0;
-        border-radius: 4px;
-        background: var(--primaryButtonBGColor, #194880);
-        color: white;
-        cursor: pointer;
-      }
-    `;
-  }
-}
+import {
+  css,
+  html,
+  LitElement,
+  CSSResultGroup,
+  TemplateResult,
+  nothing,
+} from 'lit';
+import { customElement, property } from 'lit/decorators.js';
+import { ifDefined } from 'lit/directives/if-defined.js';
+import { msg } from '@lit/localize';
+import type { ModalManagerInterface } from '@internetarchive/modal-manager';
+import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
+import {
+  BarScalingOption,
+  BinSnappingInterval,
+} from '@internetarchive/histogram-date-range';
+import {
+  analyticsActions,
+  analyticsCategories,
+} from './utils/analytics-events';
+
+import '@internetarchive/histogram-date-range';
+
+@customElement('expanded-date-picker')
+export class ExpandedDatePicker extends LitElement {
+  @property({ type: String }) minDate?: string;
+
+  @property({ type: String }) maxDate?: string;
+
+  @property({ type: String }) minSelectedDate?: string;
+
+  @property({ type: String }) maxSelectedDate?: string;
+
+  @property({ type: Array }) buckets?: number[];
+
+  @property({ type: String }) customDateFormat?: string;
+
+  @property({ type: String }) customTooltipDateFormat?: string;
+
+  @property({ type: String }) customTooltipLabel?: string;
+
+  @property({ type: String }) binSnapping: BinSnappingInterval = 'none';
+
+  @property({ type: String }) barScaling: BarScalingOption = 'logarithmic';
+
+  @property({ type: Object, attribute: false })
+  modalManager?: ModalManagerInterface;
+
+  @property({ type: Object, attribute: false })
+  analyticsHandler?: AnalyticsManagerInterface;
+
+  render(): TemplateResult {
+    return html`
+      <div id="container">
+        <histogram-date-range
+          id="date-picker"
+          .minDate=${this.minDate}
+          .maxDate=${this.maxDate}
+          .minSelectedDate=${this.minSelectedDate ?? this.minDate}
+          .maxSelectedDate=${this.maxSelectedDate ?? this.maxDate}
+          dateFormat=${ifDefined(this.customDateFormat)}
+          tooltipDateFormat=${ifDefined(this.customTooltipDateFormat)}
+          tooltipLabel=${ifDefined(this.customTooltipLabel)}
+          .binSnapping=${this.binSnapping}
+          .barScaling=${this.barScaling ?? nothing}
+          .updateDelay=${0}
+          updateWhileFocused
+          missingDataMessage="..."
+          .width=${560}
+          .height=${120}
+          .bins=${this.buckets}
+          @histogramDateRangeUpdated=${this.histogramDateRangeUpdated}
+        >
+          <button
+            id="apply-btn"
+            slot="inputs-right-side"
+            @click=${this.applyBtnClicked}
+          >
+            ${msg('Apply date range')}
+          </button>
+        </histogram-date-range>
+      </div>
+    `;
+  }
+
+  connectedCallback(): void {
+    super.connectedCallback?.();
+    this.setupEscapeListener();
+  }
+
+  disconnectedCallback(): void {
+    super.disconnectedCallback?.();
+    this.removeEscapeListener();
+  }
+
+  /**
+   * Add an event listener to close the date picker modal when the Esc key is pressed
+   */
+  private setupEscapeListener() {
+    document.addEventListener('keydown', this.boundEscapeListener);
+  }
+
+  /**
+   * Remove the Esc key listener that was previously added
+   */
+  private removeEscapeListener() {
+    document.removeEventListener('keydown', this.boundEscapeListener);
+  }
+
+  /**
+   * Closes the modal dialog if the given event is pressing the Esc key.
+   * Arrow function to ensure `this` remains bound to the current component.
+   */
+  private boundEscapeListener = (e: KeyboardEvent) => {
+    if (e.key === 'Escape') {
+      this.closeModal();
+    }
+  };
+
+  /**
+   * When the histogram is updated, keep track of the newly selected date range.
+   * We don't commit to the new range until the apply button is clicked.
+   */
+  private histogramDateRangeUpdated(
+    e: CustomEvent<{
+      minDate: string;
+      maxDate: string;
+    }>,
+  ): void {
+    this.minSelectedDate = e.detail.minDate;
+    this.maxSelectedDate = e.detail.maxDate;
+  }
+
+  /**
+   * When the Apply button is clicked, emit the current date range and close the modal.
+   */
+  private applyBtnClicked(): void {
+    const event = new CustomEvent('histogramDateRangeApplied', {
+      detail: {
+        minDate: this.minSelectedDate,
+        maxDate: this.maxSelectedDate,
+      },
+    });
+    this.dispatchEvent(event);
+    this.closeModal();
+
+    this.analyticsHandler?.sendEvent({
+      category: analyticsCategories.default,
+      action: analyticsActions.histogramChangedFromModal,
+      label: window.location.href,
+    });
+  }
+
+  /**
+   * Closes the modal associated with this component (if it exists) and dispatches a
+   * modalClosed event.
+   */
+  private closeModal(): void {
+    if (this.modalManager) {
+      this.modalManager.closeModal();
+      this.dispatchEvent(new CustomEvent('modalClosed'));
+    }
+  }
+
+  static get styles(): CSSResultGroup {
+    return css`
+      #container {
+        display: flex;
+        justify-content: center;
+        padding: 40px 10px 10px;
+        overflow: hidden;
+      }
+
+      #date-picker {
+        --histogramDateRangeInputWidth: 50px;
+        --histogramDateRangeInputRowMargin: 5px 0 0 0;
+      }
+
+      #apply-btn {
+        margin: 0 0 0 5px;
+        padding: 8px 10px;
+        border: 0;
+        border-radius: 4px;
+        background: var(--primaryButtonBGColor, #194880);
+        color: white;
+        cursor: pointer;
+      }
+    `;
+  }
+}