coveo-search-ui/src/ui/Sort/SortCriteria.ts

Coveo JavaScript Search Framework

import { chain, contains, first, values } from 'underscore';
import { Assert } from '../../misc/Assert';
import { QueryBuilder } from '../../ui/Base/QueryBuilder';

export enum VALID_SORT {
  RELEVANCY = 'relevancy',
  DATE = 'date',
  QRE = 'qre'
}

export enum VALID_DIRECTION {
  ASCENDING = 'ascending',
  DESCENDING = 'descending'
}

export class SortCriterion {
  private static sortsNeedingDirection = [VALID_SORT.DATE];

  /**
   * Create a new SortCriteria
   * @param sort The sort criteria (e.g.: relevancy, date)
   * @param direction The direction by which to sort (e.g.: ascending, descending)
   */
  constructor(public sort: VALID_SORT, public direction: VALID_DIRECTION | '' = '') {
    if (!SortCriterion.sortIsField(sort)) {
      Assert.check(
        this.isValidSort(sort),
        `${sort} is not a valid sort criteria. Valid values are ${values(VALID_SORT)} or a valid index sortable index field.`
      );
    }
    if (SortCriterion.sortNeedsDirection(sort)) {
      Assert.check(
        this.isValidDirection(direction),
        `${direction} is not a valid sort criteria direction. Valid values are ${values(VALID_DIRECTION)}`
      );
    } else {
      Assert.check(direction == '');
    }
  }

  private isValidDirection(direction: string): direction is VALID_DIRECTION {
    return chain(VALID_DIRECTION)
      .values()
      .contains(direction as any)
      .value();
  }

  private isValidSort(sort: string): sort is VALID_SORT {
    return chain(VALID_SORT)
      .values()
      .contains(sort as any)
      .value();
  }

  private static sortIsField(criteria: string) {
    return criteria.charAt(0) == '@';
  }

  private static sortNeedsDirection(sort: string) {
    return contains(SortCriterion.sortsNeedingDirection, sort) || SortCriterion.sortIsField(sort);
  }
}

export class SortCriteria {
  private criteria: SortCriterion[] = [];

  constructor(rawCriteriaString: string) {
    const criteria = rawCriteriaString.split(';');
    criteria.forEach(criterion => {
      const split = criterion.match(/\S+/g);
      this.criteria.push(new SortCriterion(split[0] as VALID_SORT, split[1] as VALID_DIRECTION));
    });
  }

  public get direction() {
    return first(this.criteria).direction;
  }

  public get sort() {
    return first(this.criteria).sort;
  }

  /**
   * Return a new SortCriteria from a string
   * @param criteria The string from which to create the SortCriteria
   */
  static parse(criteria: string): SortCriteria {
    return new SortCriteria(criteria);
  }

  /**
   * Put the sort criteria in the passed queryBuilder
   * @param queryBuilder The queryBuilder in which to put the sort criteria.
   */
  public putInQueryBuilder(queryBuilder: QueryBuilder) {
    Assert.exists(queryBuilder);
    queryBuilder.sortCriteria = this.toString()
      .split(';')
      .join(',');
  }

  /**
   * Returns a string representation of the sort criteria (e.g.: 'date ascending').
   */
  public toString(): string {
    return this.criteria
      .map(criterion => {
        return criterion.direction ? `${criterion.sort} ${criterion.direction}` : `${criterion.sort}`;
      })
      .join(';');
  }

  /**
   * Checks if the SortCriteria is equal to another.
   * @param criteria The SortCriteria to compare with
   */
  public equals(criteria: SortCriteria): boolean {
    return criteria.toString() == this.toString();
  }
}