sequelize-querystring-converter/lib/index.js

Enable filter, sort, paginate and search on your dataset by simply adding some query parameters on your API.

const operators = require('./operators');
const { uniqBy, pickBy, pick, parseValue } = require('./helpers');

const extractSort = ({ sort, basedProperties }) => {
  if (sort === '' || sort === undefined) return undefined;

  let sortClause = [];
  let properties = sort.split(',');

  if (basedProperties.length > 0) {
    properties =  properties.filter(property => basedProperties.includes(property.replace(/^-/, '')));
  }

  if (properties.length) {
    properties = properties.length > 1 ? uniqBy(properties, item => item.replace(/^-/, '')) : properties;
    sortClause = properties.map(property => {
      return property.charAt(0) === '-' ? [property.slice(1), 'DESC'] : [property, 'ASC']
    });
  }

  return sortClause;
};

const extractWhere = ({ query, basedProperties, symbolic }) => {
  let properties;
  if (basedProperties.length > 0) {
    properties = pick(query, basedProperties);
  } else {
    const { sort, offset, limit, select, ...others } = query;
    properties = others;
  }

  if (!(Object.keys(properties).length > 0)) return undefined;

  let whereClause = {};
  Object.keys(properties).forEach(property => {
    if (properties[property].includes(':')) {
      let index = properties[property].indexOf(':');
      let [comparisonOp, value] = [properties[property].slice(0, index), properties[property].slice(index + 1)];
      if (comparisonOp in operators) {
        let result = operators[comparisonOp](symbolic, value);
        whereClause[property] = { [result.comparisonOp]: parseValue(result.value) };
      }
    } else {
      whereClause[property] = properties[property];
    }
  });

  return whereClause;
};

const convert = ({ query, basedProperties = [], symbolic = true }) => {
  if (typeof query !== 'object') {
    throw new Error('Query must be object');
  }

  const criteria = {
    where: extractWhere({ query, basedProperties, symbolic }),
    order: extractSort({ sort: query.sort, basedProperties }),
    offset: typeof query.offset === 'string' ? parseInt(query.offset) : query.offset,
    limit:  typeof query.limit === 'string' ? parseInt(query.limit) : query.limit
  };

  return pickBy(criteria);
};

module.exports = { convert };