api-index-filter.js

import Component from '@glimmer/component';
import sortBy from 'lodash.sortby';

/**
 * @typedef Args
 * @property {object} model
 * @property {object} filterData
 */

/**
 * @typedef Blocks
 * @property {[ApiIndexFilter['filteredData']]} default
 */

/**
 * @extends Component<{ Args: Args, Blocks: Blocks }>
 */
export default class ApiIndexFilter extends Component {
  get filteredMethods() {
    return this.filterItems('methods');
  }

  get filteredEvents() {
    return this.filterItems('events');
  }

  get filteredProperties() {
    return this.filterItems('properties');
  }

  filterItems(itemType) {
    let items =
      this.args.model[itemType] === undefined
        ? []
        : this.args.model[`${itemType}`];
    if (!this.args.filterData.showInherited) {
      items = items.filter((item) => item.inherited !== true);
    }
    if (!this.args.filterData.showProtected) {
      items = items.filter((item) => item.access !== 'protected');
    }
    if (!this.args.filterData.showPrivate) {
      items = items.filter((item) => item.access !== 'private');
    }
    if (!this.args.filterData.showDeprecated) {
      items = items.filter((item) => item.deprecated !== true);
    }

    let sortedItems = sortBy(items, (item) => item.name);
    return this.filterMultipleInheritance(sortedItems);
  }

  get filteredData() {
    return {
      methods: this.filteredMethods,
      properties: this.filteredProperties,
      events: this.filteredEvents,
    };
  }

  /**
   * Returns an array where duplicate methods (by name) are removed.
   * The docs for the nearest inheritance are typically more helpful to users,
   * so in cases of duplicates, "more local" is preferred.
   * Without this, multiple entries for some methods will show up.
   * @method filterMultipleInheritance
   */
  filterMultipleInheritance(items) {
    let dedupedArray = [];
    for (let i = 0; i < items.length; i++) {
      let currentItem = items[i];
      if (i === items.length - 1) {
        // if it's the last item, keep it
        dedupedArray.push(currentItem);
      } else {
        let nextItem = items[i + 1];
        if (currentItem.name === nextItem.name) {
          // if the method would be listed twice, find the more local documentation
          let mostLocal = this.findMostLocal(currentItem, nextItem);
          dedupedArray.push(mostLocal);
          i += 1; // skip the next item with duplicate name
        } else {
          dedupedArray.push(currentItem);
        }
      }
    }
    return dedupedArray;
  }

  /**
   * Returns whichever item is most local.
   * What is "most local" is determined by looking at the file path for the
   * method, the file path for the class being viewed, and the parent if needed.
   * @method findMostLocal
   */
  findMostLocal(currentItem, nextItem) {
    let currentScope = this.args.model.file;
    let parentClassScope = this.args.model.parentClass.get('file');
    if (currentScope === currentItem.file) {
      // if the item belongs to the class, keep it
      return currentItem;
    } else if (parentClassScope === currentItem.file) {
      // or if the item belongs to the parent class, keep it
      return currentItem;
    } else {
      // otherwise, the next item must be "more local"
      return nextItem;
    }
  }
}