Added tests for parser() function and adjustments in index.d.ts

Author: douglasrafael

index.d.ts

@@ -5,7 +5,7 @@ declare namespace queryStringsParser {
     export interface QueryStringsParser {
         (options?: IOptions): any
 
-        parser(query?: string | object, options?: IOptions): any
+        parser(query?: string | object, defaults?: IDefault, options?: IOptions): any
 
         parseFields(query?: string | object, options?: IOptions): any
 

index.js

@@ -1,8 +1,6 @@
 'use strict'
-
 const read = require('./lib/read')
 
-
 exports = module.exports = function (params) {
     return read.parser(params)
 }

lib/read.js

@@ -66,7 +66,7 @@ function validate_options(params) {
 }
 
 exports = module.exports.parseAll = function (_query, _default, _options) {
-    const params = validate_options(Object.assign({'default': _default} || {}, _options || {}))
+    const params = validate_options(Object.assign({'default': _default}, _options || {}))
     return {
         fields: fields.fields(stringToJson(_query), params),
         sort: ordination.sort(stringToJson(_query), params),

package.json

@@ -1,6 +1,6 @@
 {
   "name": "query-strings-parser",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "Middleware to transform query strings in a format that is recognized by the MongoDB, MySQL and other databases...",
   "license": "MIT",
   "main": "index.js",
@@ -48,4 +48,4 @@
     "nyc": "^14.1.1",
     "supertest": "^4.0.2"
   }
-}
+}

test/integration/index.custom.config.spec.js

@@ -108,11 +108,10 @@ describe('queryFilter()', function () {
 })
 
 function validate(query, options) {
-    expect(query).is.not.null
     expect(query).is.not.eql({})
     expect(query.pagination.limit).to.eql(options.default.pagination.limit)
     expect(query.pagination.page).to.eql(options.default.pagination.page)
     expect(query.sort).to.eql(options.default.sort)
     expect(query.fields).to.eql(options.default.fields)
     expect(query.filters).to.eql(options.default.filters)
-}
+}

test/integration/index.default.config.spec.js

@@ -511,7 +511,6 @@ describe('queryFilter()', function () {
 
 
 function validate(query, options) {
-    expect(query).is.not.null
     expect(query).is.not.eql({})
     expect(query.pagination.limit).to.eql(options.default.pagination.limit)
     expect(query.pagination.skip).to.eql(options.default.pagination.skip)
@@ -521,7 +520,6 @@ function validate(query, options) {
 }
 
 function validateWithPeriod(query, options) {
-    expect(query).is.not.null
     expect(query).is.not.eql({})
     expect(query.pagination.limit).to.eql(options.default.pagination.limit)
     expect(query.pagination.skip).to.eql(options.default.pagination.skip)
@@ -541,4 +539,4 @@ function dateToString(date) {
     return `${date.getFullYear()}-`
         .concat(`${(date.getMonth() + 1) > 9 ? (date.getMonth() + 1) : '0'.concat((date.getMonth() + 1))}-`)
         .concat(`${date.getDate() > 9 ? date.getDate() : '0'.concat(date.getDate())}`)
-}
+}

test/unit/index.spec.js

@@ -119,14 +119,90 @@ describe('QueryString: Parsers', function () {
             })
         })
 
-        context('when use parse with defualt date fields', function () {
+        context('when use parse with default date fields', function () {
             it('should return parse query date merge with default date', function () {
                 const query = '?start_at=2019-02-05T00:00:00&end_at=2019-02-05T23:59:59'
                 const result = index.parseDate(query, {start_at: 'created_at', end_at: 'created_at'})
                 verifyDate(result)
             })
         })
     })
+
+    describe('parser()', function () {
+        context('when parser is used with defaults options', function () {
+            it('should return object with fields, sort, filters, pagination and original query', function () {
+                verifyParser(index.parser(''))
+            })
+
+            it('should return parse query fields', function () {
+                const query = '?fields=name,age,created_at'
+                verifyFields(index.parser(query).fields)
+            })
+
+            it('should return parse query sort', function () {
+                const query = '?sort=name,-age,created_at'
+                verifySort(index.parser(query).sort)
+            })
+
+            it('should return parse query pagination', function () {
+                const query = '?limit=20&skip=3'
+                const result = index.parser(query)
+                expect(result.pagination).to.have.property('limit', 20)
+                expect(result.pagination).to.have.property('skip', 3)
+            })
+
+            it('should return parse query filter', function () {
+                const query = '?name=lucas&age=30'
+                verifyFilter(index.parser(query).filters)
+            })
+
+            it('should return parse query date', function () {
+                const query = '?start_at=2019-02-05T00:00:00&end_at=2019-02-05T23:59:59'
+                verifyDate(index.parser(query).filters)
+            })
+        })
+
+        context('when parser is used with custom options', function () {
+            it('should return parse query fields merged with default fields', function () {
+                const query = '?fields=name,age,created_at'
+                const result = index.parser(query, {fields: {_id: 0}})
+                verifyFields(result.fields)
+                expect(result.fields).to.have.property('_id', 0)
+            })
+
+            it('should return parsing query classification merged with custom classification', function () {
+                const query = '?sort=name,-age,created_at'
+                const result = index.parser(query, {sort: {_id: 'desc'}})
+                verifySort(result.sort)
+                expect(result.sort).to.have.property('_id', 'desc')
+            })
+
+            it('should return parse query pagination', function () {
+                const query = '?page=3'
+                verifyPage(index.parser(query,
+                    {pagination: {limit: 20}},
+                    {use_page: true}
+                ).pagination)
+            })
+
+            it('should return parse query filters merge with custom filters', function () {
+                const query = '?name=lucas&age=30'
+                const result = index.parser(query, {filters: {'job': 'Engineer'}})
+                verifyFilter(result.filters)
+                expect(result.filters).to.have.property('job', 'Engineer')
+            })
+
+            it('should return parse query date merge with default date', function () {
+                const query = '?start_at=2019-02-05T00:00:00&end_at=2019-02-05T23:59:59'
+                const result = index.parser(
+                    query,
+                    {},
+                    {date_fields: {start_at: 'timestamp', end_at: 'timestamp'}})
+                expect(result.filters.$and[0]).to.have.all.keys('timestamp')
+                expect(result.filters.$and[1]).to.have.all.keys('timestamp')
+            })
+        })
+    })
 })
 
 function verifyFields(result) {
@@ -166,4 +242,12 @@ function verifyDate(result) {
     expect(result.$and).to.have.lengthOf(2)
     expect(result.$and[0]).to.have.all.keys('created_at')
     expect(result.$and[1]).to.have.all.keys('created_at')
-}
+}
+
+function verifyParser(result) {
+    expect(result).to.have.property('fields')
+    expect(result).to.have.property('sort')
+    expect(result).to.have.property('filters')
+    expect(result).to.have.property('pagination')
+    expect(result).to.have.property('original')
+}