@internetarchive/collection-browser 4.5.1 → 4.6.0

package/.claude/worktrees/WEBDEV-8677-bump-field-parsers/src/collection-facets/smart-facets/smart-facet-bar.ts

@@ -0,0 +1,437 @@
+import {
+  css,
+  html,
+  LitElement,
+  TemplateResult,
+  CSSResultGroup,
+  nothing,
+  PropertyValues,
+} from 'lit';
+import { repeat } from 'lit/directives/repeat.js';
+import { customElement, property, state } from 'lit/decorators.js';
+import type { Aggregation, Bucket } from '@internetarchive/search-service';
+import type { CollectionTitles } from '../../data-source/models';
+import type {
+  FacetEventDetails,
+  FacetOption,
+  FacetState,
+  SelectedFacets,
+} from '../../models';
+import { updateSelectedFacetBucket } from '../../utils/facet-utils';
+import { SmartQueryHeuristicGroup } from './smart-facet-heuristics';
+import type { SmartFacetDropdown } from './smart-facet-dropdown';
+import type { SmartFacet, SmartFacetEvent } from './models';
+import { smartFacetEquals } from './smart-facet-equals';
+import { dedupe } from './dedupe';
+import { log } from '../../utils/log';
+import filterIcon from '../../assets/img/icons/filter';
+
+import './smart-facet-button';
+import './smart-facet-dropdown';
+
+const fieldPrefixes: Partial<Record<FacetOption, string>> = {
+  collection: 'Collection: ',
+  creator: 'By: ',
+  subject: 'About: ',
+};
+
+function capitalize(str: string) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+
+@customElement('smart-facet-bar')
+export class SmartFacetBar extends LitElement {
+  @property({ type: String }) query?: string;
+
+  @property({ type: Object }) aggregations?: Record<string, Aggregation>;
+
+  @property({ type: Object }) selectedFacets?: SelectedFacets;
+
+  /** The map from collection identifiers to their titles */
+  @property({ type: Object })
+  collectionTitles?: CollectionTitles;
+
+  @property({ type: Boolean }) filterToggleShown = false;
+
+  @property({ type: Boolean }) filterToggleActive = false;
+
+  @property({ type: String }) label?: string;
+
+  @state() private heuristicRecs: SmartFacet[] = [];
+
+  @state() private smartFacets: SmartFacet[][] = [];
+
+  @state() private lastAggregations?: Record<string, Aggregation>;
+
+  //
+  // COMPONENT LIFECYCLE METHODS
+  //
+
+  render() {
+    if (!this.query) return nothing;
+
+    const shouldShowLabel = !!this.label && this.smartFacets.length > 0;
+    return html`
+      <div id="smart-facets-container">
+        ${this.filtersToggleTemplate}
+        ${shouldShowLabel
+          ? html`<p id="filters-label">${this.label}</p>`
+          : nothing}
+        ${repeat(
+          this.smartFacets,
+          f =>
+            `${f[0].label}|${f[0].facets[0].facetType}|${f[0].facets[0].bucketKey}`,
+          facet => this.makeSmartFacet(facet),
+        )}
+      </div>
+    `;
+  }
+
+  protected willUpdate(changed: PropertyValues): void {
+    let shouldUpdateSmartFacets = false;
+
+    if (changed.has('query')) {
+      log('query change', changed.get('query'), this.query);
+      this.lastAggregations = undefined;
+      shouldUpdateSmartFacets = true;
+    }
+
+    if (
+      changed.has('aggregations') &&
+      !this.lastAggregations &&
+      this.aggregations &&
+      Object.keys(this.aggregations).length > 0
+    ) {
+      log('aggs change', changed.get('aggregations'), this.aggregations);
+      this.lastAggregations = this.aggregations;
+      shouldUpdateSmartFacets = true;
+    }
+
+    if (shouldUpdateSmartFacets) {
+      log('should update smart facets, doing so...');
+      this.updateSmartFacets();
+    }
+  }
+
+  refresh(): void {
+    this.lastAggregations = this.aggregations;
+    this.updateSmartFacets();
+  }
+
+  deselectAll(): void {
+    for (const sf of this.smartFacets) {
+      for (const facet of sf) {
+        facet.selected = false;
+      }
+    }
+    this.requestUpdate();
+  }
+
+  private async updateSmartFacets(): Promise<void> {
+    log('updating smart facets');
+    if (this.query) {
+      this.heuristicRecs =
+        await new SmartQueryHeuristicGroup().getRecommendedFacets(this.query);
+      log('heuristic recs are', this.heuristicRecs);
+      this.smartFacets = dedupe(this.facetsToDisplay);
+      log('smart facets are', this.smartFacets);
+    }
+  }
+
+  //
+  // OTHER METHODS
+  //
+
+  private makeSmartFacet(facets: SmartFacet[]) {
+    if (facets.length === 0) {
+      return nothing;
+    }
+    if (facets.length === 1) {
+      return this.smartFacetButton(facets[0]);
+    }
+    return this.smartFacetDropdown(facets);
+  }
+
+  private smartFacetButton(facet: SmartFacet) {
+    return html`
+      <smart-facet-button
+        .facetInfo=${facet}
+        .labelPrefix=${fieldPrefixes[facet.facets[0].facetType]}
+        .selected=${facet.selected ?? false}
+        @facetClick=${this.facetClicked}
+      ></smart-facet-button>
+    `;
+  }
+
+  private smartFacetDropdown(facets: SmartFacet[]) {
+    return html`
+      <smart-facet-dropdown
+        .facetInfo=${facets}
+        .labelPrefix=${fieldPrefixes[facets[0].facets[0].facetType]}
+        .activeFacetRef=${facets[0].facets[0]}
+        @facetClick=${this.dropdownOptionClicked}
+        @dropdownClick=${this.dropdownClicked}
+      ></smart-facet-dropdown>
+    `;
+  }
+
+  private get filtersToggleTemplate(): TemplateResult | typeof nothing {
+    if (!this.filterToggleShown) return nothing;
+
+    return html`
+      <button
+        id="filters-toggle"
+        class=${this.filterToggleActive ? 'active' : ''}
+        title="${this.filterToggleActive ? 'Hide' : 'Show'} filters pane"
+        @click=${this.filterToggleClicked}
+      >
+        ${filterIcon}
+      </button>
+    `;
+  }
+
+  private get facetsToDisplay(): SmartFacet[][] {
+    const facets: SmartFacet[][] = [];
+
+    if (this.heuristicRecs.length > 0) {
+      for (const rec of this.heuristicRecs) {
+        // Suppress mediatype-only facets for now.
+        if (rec.facets.length === 1 && rec.facets[0].facetType === 'mediatype')
+          continue;
+
+        facets.push([rec]);
+      }
+    }
+
+    if (this.lastAggregations) {
+      const keys = [
+        'mediatype',
+        'year',
+        'language',
+        'creator',
+        'subject',
+        'collection',
+      ];
+      for (const key of keys) {
+        const agg = this.lastAggregations[key];
+        if (!agg) continue;
+        if (agg.buckets.length === 0) continue;
+        if (['lending', 'year_histogram', 'date_histogram'].includes(key))
+          continue;
+        if (typeof agg.buckets[0] === 'number') continue;
+
+        if (
+          key === 'mediatype' &&
+          this.selectedFacets &&
+          Object.values(this.selectedFacets.mediatype ?? {}).some(
+            bucket => bucket.state !== 'none',
+          )
+        ) {
+          continue;
+        }
+
+        const facetType = key as FacetOption;
+        const buckets = agg.buckets as Bucket[];
+
+        const unusedBuckets = buckets.filter(b => {
+          const selectedFacetBucket = this.selectedFacets?.[facetType]?.[b.key];
+          if (selectedFacetBucket && selectedFacetBucket.state !== 'none') {
+            return false;
+          }
+          return true;
+        });
+
+        if (facetType === 'mediatype') {
+          continue;
+          // Don't include mediatype bubbles
+        } else if (facetType === 'collection' || facetType === 'subject') {
+          const topBuckets = unusedBuckets.slice(0, 5);
+          facets.push(topBuckets.map(b => this.toSmartFacet(facetType, [b])));
+        } else {
+          facets.push([this.toSmartFacet(facetType, [unusedBuckets[0]])]);
+        }
+      }
+    }
+
+    return facets;
+  }
+
+  private toSmartFacet(
+    facetType: FacetOption,
+    buckets: Bucket[],
+    // prefix = true
+  ): SmartFacet {
+    return {
+      facets: buckets.map(bucket => {
+        let displayText = capitalize(bucket.key.toString());
+        if (facetType === 'collection') {
+          const title = this.collectionTitles?.get(bucket.key.toString());
+          if (title) displayText = title;
+        }
+
+        return {
+          facetType,
+          bucketKey: bucket.key.toString(),
+          displayText,
+        };
+      }),
+    } as SmartFacet;
+  }
+
+  /**
+   * Toggles the state of the given smart facet, and updates the selected facets accordingly.
+   */
+  private toggleSmartFacet(
+    facet: SmartFacet,
+    details: FacetEventDetails[],
+  ): void {
+    let newState: FacetState;
+    if (facet.selected) {
+      // When deselected, leave the smart facet where it is
+      newState = 'none';
+      this.smartFacets = this.smartFacets.map(f => {
+        if (f[0] === facet) return [{ ...facet, selected: false }];
+        return f;
+      });
+    } else {
+      // When selected, move the toggled smart facet to the front of the list
+      newState = 'selected';
+      this.smartFacets = [
+        [{ ...facet, selected: true }],
+        ...this.smartFacets.filter(f => f[0] !== facet),
+      ];
+    }
+
+    this.updateSelectedFacets(
+      details.map(facet => ({
+        ...facet,
+        bucket: {
+          ...facet.bucket,
+          state: newState,
+        },
+      })),
+    );
+  }
+
+  /**
+   * Updates the selected facet buckets for each of the given facets,
+   * and emits a `facetsChanged` event to notify parent components of
+   * the new state.
+   */
+  private updateSelectedFacets(facets: FacetEventDetails[]): void {
+    for (const facet of facets) {
+      this.selectedFacets = updateSelectedFacetBucket(
+        this.selectedFacets,
+        facet.facetType,
+        facet.bucket,
+        true,
+      );
+    }
+
+    const event = new CustomEvent<SelectedFacets>('facetsChanged', {
+      detail: this.selectedFacets,
+    });
+    this.dispatchEvent(event);
+  }
+
+  /**
+   * Handler for when a smart facet button is clicked
+   */
+  private facetClicked(e: CustomEvent<SmartFacetEvent>): void {
+    this.toggleSmartFacet(e.detail.smartFacet, e.detail.details);
+  }
+
+  /**
+   * Handler for when an option in a smart facet dropdown menu is selected
+   */
+  private dropdownOptionClicked(e: CustomEvent<SmartFacetEvent>): void {
+    const existingFacet = this.smartFacets.find(
+      sf => sf.length === 1 && smartFacetEquals(sf[0], e.detail.smartFacet),
+    );
+    if (existingFacet) {
+      // The facet already exists outside the dropdown, so just select it there
+      this.toggleSmartFacet(existingFacet[0], e.detail.details);
+      return;
+    }
+
+    // Otherwise, prepend a new smart facet for the selected option
+    this.smartFacets = [
+      [{ ...e.detail.smartFacet, selected: true }],
+      ...this.smartFacets,
+    ];
+
+    this.updateSelectedFacets(e.detail.details);
+  }
+
+  /**
+   * Handler for when any dropdown is clicked (whether button, caret, or menu item)
+   */
+  private dropdownClicked(e: CustomEvent<SmartFacetDropdown>): void {
+    log('smart bar: onDropdownClick', e.detail);
+    this.shadowRoot
+      ?.querySelectorAll('smart-facet-dropdown')
+      .forEach(dropdown => {
+        if (dropdown !== e.detail) {
+          log('closing', dropdown);
+          (dropdown as SmartFacetDropdown).close();
+        }
+      });
+  }
+
+  private filterToggleClicked(): void {
+    this.dispatchEvent(new CustomEvent('filtersToggled'));
+  }
+
+  //
+  // STYLES
+  //
+
+  static get styles(): CSSResultGroup {
+    return css`
+      #smart-facets-container {
+        display: flex;
+        align-items: center;
+        gap: 5px 10px;
+        padding: 10px 0;
+        white-space: nowrap;
+        overflow: scroll hidden;
+        scrollbar-width: none;
+      }
+
+      #filters-toggle {
+        margin: 0;
+        border: 0;
+        padding: 5px 8px;
+        border-radius: 5px;
+        background: white;
+        color: #2c2c2c;
+        border: 1px solid #194880;
+        font-size: 1.4rem;
+        font-family: inherit;
+        text-decoration: none;
+        cursor: pointer;
+      }
+
+      #filters-toggle.active {
+        background: #194880;
+        color: white;
+      }
+
+      #filters-toggle > svg {
+        width: 12px;
+        filter: invert(0.16667);
+        vertical-align: -1px;
+      }
+
+      #filters-toggle.active > svg {
+        filter: invert(1);
+      }
+
+      #filters-label {
+        font-size: 1.4rem;
+        font-weight: var(--smartFacetLabelFontWeight, normal);
+        margin: 0 -5px 0 0;
+      }
+    `;
+  }
+}

package/.claude/worktrees/WEBDEV-8677-bump-field-parsers/src/collection-facets/smart-facets/smart-facet-button.ts

@@ -0,0 +1,145 @@
+import { css, html, LitElement, CSSResultGroup, nothing } from 'lit';
+import { customElement, property } from 'lit/decorators.js';
+import {
+  mediatypeConfig,
+  MediatypeConfigKey,
+} from '../../mediatype/mediatype-config';
+import type { SmartFacet, SmartFacetEvent } from './models';
+
+import closeCircleDark from '../../assets/img/icons/close-circle-dark';
+
+function capitalize(str?: string): string | undefined {
+  if (!str) return str;
+  return str.charAt(0).toLocaleUpperCase() + str.slice(1);
+}
+
+@customElement('smart-facet-button')
+export class SmartFacetButton extends LitElement {
+  @property({ type: Object }) facetInfo?: SmartFacet;
+
+  @property({ type: String }) labelPrefix?: string;
+
+  @property({ type: Boolean }) selected = false;
+
+  //
+  // COMPONENT LIFECYCLE METHODS
+  //
+
+  render() {
+    if (!this.facetInfo) return nothing;
+
+    const isSingleFacet = this.facetInfo.facets.length === 1;
+    const firstFacet = this.facetInfo.facets[0];
+
+    const displayText = capitalize(
+      (this.labelPrefix ? `${this.labelPrefix} ` : '') +
+        (this.facetInfo.label ??
+          firstFacet.displayText ??
+          firstFacet.bucketKey),
+    );
+    if (!displayText) return nothing;
+
+    const icon =
+      isSingleFacet && firstFacet.facetType === 'mediatype'
+        ? mediatypeConfig[firstFacet.bucketKey as MediatypeConfigKey].icon
+        : nothing;
+
+    return html`
+      <a
+        class="smart-facet-button ${this.selected ? 'selected' : ''}"
+        href=${this.href}
+        @click=${this.facetClicked}
+      >
+        ${icon} ${displayText}
+        ${this.selected
+          ? html`<span class="unselect-button">${closeCircleDark}</span>`
+          : nothing}
+      </a>
+    `;
+  }
+
+  //
+  // OTHER METHODS
+  //
+
+  private get href(): string {
+    const url = new URL(window.location.href);
+    if (this.facetInfo) {
+      for (const facet of this.facetInfo.facets) {
+        url.searchParams.append(
+          'and[]',
+          encodeURIComponent(`${facet.facetType}:"${facet.bucketKey}"`),
+        );
+      }
+    }
+    return url.toString();
+  }
+
+  private facetClicked(e: Event): void {
+    e.preventDefault();
+    if (!this.facetInfo) return;
+
+    this.selected = !this.selected;
+
+    this.dispatchEvent(
+      new CustomEvent<SmartFacetEvent>('facetClick', {
+        detail: {
+          smartFacet: this.facetInfo,
+          details: this.facetInfo.facets.map(f => ({
+            facetType: f.facetType,
+            bucket: {
+              key: f.bucketKey,
+              count: 0,
+              state: this.selected ? 'selected' : 'none',
+            },
+            negative: false,
+          })),
+        },
+      }),
+    );
+  }
+
+  //
+  // STYLES
+  //
+
+  static get styles(): CSSResultGroup {
+    return css`
+      .smart-facet-button {
+        display: inline-flex;
+        align-items: center;
+        column-gap: 5px;
+        padding: 5px 5px;
+        border-radius: 5px;
+        background: white;
+        color: #2c2c2c;
+        border: 1px solid #194880;
+        font-size: 1.4rem;
+        font-family: inherit;
+        line-height: normal;
+        text-decoration: none;
+      }
+
+      .smart-facet-button.selected {
+        background: #194880;
+        color: white;
+      }
+
+      .unselect-button > svg {
+        width: 10px;
+        height: 10px;
+        filter: invert(1);
+      }
+
+      .smart-facet-button > svg {
+        width: 12px;
+        height: 12px;
+        filter: invert(0.16667);
+      }
+
+      .smart-facet-button.selected > svg {
+        filter: invert(1);
+      }
+    `;
+  }
+}