admin-bro/src/backend/services/sort-setter/sort-setter.ts

Admin panel for apps written in node.js

import ConfigurationError from '../../utils/errors/configuration-error'
import { ResourceOptions } from '../../decorators/resource/resource-options.interface'

const DEFAULT_DIRECTION = 'asc'

type Sort = {
  direction: 'asc' | 'desc';
  sortBy: string;
}

/**
 * Sets sort parameters for a list.
 *
 * @private
 *
 * @param {object}  query
 * @param {string}  [query.direction]   either `asc` or `desc`
 * @param {string}  [query.sortBy]      sort by field passed in query
 * @param {string}  firstPropertyName   property name which will be taken as a default
 * @param {ResourceOptions} resourceOptions={}  options passed along with given resource
 * @return {Sort}
 */
const sortSetter = (
  { direction, sortBy }: {direction?: 'asc' | 'desc'; sortBy?: string} = {},
  firstPropertyName: string,
  resourceOptions: ResourceOptions = {},
): Sort => {
  const options = resourceOptions.sort || {} as Sort
  if (resourceOptions
      && resourceOptions.sort
      && resourceOptions.sort.direction
      && !['asc', 'desc'].includes(resourceOptions.sort.direction)) {
    throw new ConfigurationError(`
    Sort direction should be either "asc" or "desc",
    "${resourceOptions.sort.direction} was given"`, 'global.html#ResourceOptions')
  }
  const computedDirection = direction || options.direction || DEFAULT_DIRECTION
  const params = {
    direction: computedDirection === 'asc' ? 'asc' : 'desc' as 'asc' | 'desc',
    sortBy: sortBy || options.sortBy || firstPropertyName,
  }

  return params
}

sortSetter.DEFAULT_DIRECTION = DEFAULT_DIRECTION

export { DEFAULT_DIRECTION }

export default sortSetter