@orfeas126/box-ui-elements/es/utils/sorter.js

Box UI Elements

/**
 * 
 * @file Function to sort the item list
 * @author Box
 */

import comparator from './comparator';
import { getBadItemError } from './error';
function isSortingNeeded(order, sortBy, sortDirection) {
  return !Array.isArray(order) || !order.some(entry => entry.by === sortBy && entry.direction === sortDirection);
}

/**
 * Sorts items in place
 *
 * @param {Object} item box item object
 * @param {string} sortBy sort by field
 * @param {string} sortDirection the sort direction
 * @param {Cache} cache item cache
 * @return {void}
 */
export default function sorter(item, sortBy, sortDirection, cache) {
  const {
    item_collection
  } = item;
  if (!item_collection) {
    throw getBadItemError();
  }
  const {
    entries,
    order
  } = item_collection;
  if (!Array.isArray(entries)) {
    throw getBadItemError();
  }
  if (isSortingNeeded(order, sortBy, sortDirection)) {
    entries.sort(comparator(sortBy, sortDirection, cache));
    item_collection.order = [{
      by: sortBy,
      direction: sortDirection
    }];
  }
  return item;
}

/**
 * Sort valid feed items, descending by created_at time.
 *
 * @param {Array<?Comments | ?Tasks | ?FileVersions>} args - Arguments list of each item container
 * type that is allowed in the feed.
 * @return {Array<?Comments | ?Tasks | ?FileVersions>} the sorted feed items
 */
export function sortFeedItems(...args) {
  const feedItems = args.reduce((items, itemContainer) => {
    if (itemContainer) {
      return items.concat(itemContainer.entries);
    }
    return items;
  }, []).sort((a, b) => Date.parse(a.created_at) - Date.parse(b.created_at));
  return feedItems;
}
//# sourceMappingURL=sorter.js.map