SeQuelizeQueryParser (sqqp)

A small helper library to parse query strings into corresponding query parameters as needed in Sequelize.js.

Currently supported are where, order/sort and limit parameters.

Motivation

I was looking for a flexible query parser which would allow me to design and customize API queries to my needs and would provide a parsed result which can be processed directly into Sequelize.js querying arguments.

Installation

npm -S sqqp

Usage

Sqqb allows for a flexible provision of query parameters. By default, the query parameters are expected to be provided as key-value pairs (e.g. express.js req.query).

    const sqqp = require('sqqp');

    sqqp.parse({ 'id:eq': '1' });
    // { id: { eq: '1' } }

    sqqp.parse({ 'id:or': '[1,2]' });
    // { id: { or: ['1', '2'] } }

    sqqp.parse({ 'id:or': '[1,2]', 'name:eq': 'foo' });
    // { id: { or: ['1', '2'] }, name: { eq: 'foo' } }

    sqqp.parse({ 'id:or': '[1,2]', 'name:eq': 'foo', 'date:order': 'asc', 'place:order': 'desc', limit: 10 })
    /* 
    {
      where: { 
        id: { or: ['1', '2'] },
        name: { eq: 'foo' } 
      }, 
      order: [['date', 'asc'], ['place', 'desc']], 
      limit: 10 
    } 
    */

Sqqp supports customized queries. For more details see the options parameter.

    const sqqp = require('sqqp');

    const options = {
      delimiters: {
        operator: ';',
        value: '+',
        queryParams: {
          delimiter: '.',
          boundaries: ['(', ')']
        }
      },
      express: false,
      orderId: 'order',
      limitId: 'limit'
    };

    sqqp.parse('id;eq+1', options);
    // { where: { id: { eq: '1' } } }

    sqqp.parse('id;or+(1.2)&name;eq+foo&date;order+asc&place;order+desc&limit+10', options);
    // { where: { id: { or: ['1', '2'] } } }

    sqqp.parse('id;or+(1.2)&name;eq+foo&date;order+asc&place;order+desc&limit+10', options);
    /* 
    {
      where: { 
        id: { or: ['1', '2'] },
        name: { eq: 'foo' } 
      }, 
      order: [['date', 'asc'], ['place', 'desc']], 
      limit: 10 
    } 
    */

Options

The options parameter holds information about the customisation of the query. A provision of the entire object is required. If no options argument is provided to the .parse method, the default options object will be used:

    options = {
      delimiters: {
        operator: ':',
        value: '=',
        queryParams: {
          delimiter: ',',
          boundaries: ['[', ']']
        }
      },
      express: true,
      orderId: 'order',
      limitId: 'limit'
    };

Tests

npm test

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. The master branch is protected. Feel free to provide your code into the development branch.