feat: add support for non strict query parameters

Author: troch

modules/RouteNode.js

@@ -131,7 +131,8 @@ export default class RouteNode {
         return matched ? segments : null
     }
 
-    getSegmentsMatchingPath(path, trailingSlash = false) {
+    getSegmentsMatchingPath(path, options) {
+        const { trailingSlash, strictQueryParams } = options;
         let matchChildren = (nodes, pathSegment, segments) => {
             // for (child of node.children) {
             for (let i in nodes) {
@@ -159,7 +160,7 @@ export default class RouteNode {
                     Object.keys(match).forEach(param => segments.params[param] = match[param])
 
                     if (!remainingPath.length || // fully matched
-                        remainingPath.indexOf('?') === 0 // we only got unmatched queryParams
+                        !strictQueryParams && remainingPath.indexOf('?') === 0 // unmatched queryParams in non strict mode
                     ) {
                       return segments
                     }
@@ -253,7 +254,9 @@ export default class RouteNode {
         };
     }
 
-    matchPath(path, trailingSlash = false) {
-        return this.buildStateFromSegments(this.getSegmentsMatchingPath(path, trailingSlash))
+    matchPath(path, options) {
+        const defaultOptions = { trailingSlash: false, strictQueryParams: true };
+        options = { ...defaultOptions, ...options };
+        return this.buildStateFromSegments(this.getSegmentsMatchingPath(path, options))
     }
 }

test/main.js

@@ -197,7 +197,7 @@ describe('RouteNode', function () {
         withoutMeta(node.matchPath('/grand-parent/parent/child?nickname=gran&nickname=granny&name=maman&age=3')).should.eql({name: 'grandParent.parent.child', params: {nickname: ['gran', 'granny'], name: 'maman', age: '3'}});
 
         // still matching remainingPath only consist of unknown qsParams
-        node.matchPath('/grand-parent?nickname=gran&name=papa').should.eql({
+        node.matchPath('/grand-parent?nickname=gran&name=papa', { strictQueryParams: false }).should.eql({
           _meta: {
               grandParent: {
                   nickname: 'query'
@@ -206,7 +206,7 @@ describe('RouteNode', function () {
           name: 'grandParent',
           params: {nickname: 'gran'}
         });
-        node.matchPath('/grand-parent/parent/child?nickname=gran&names=papa-maman').should.eql({
+        node.matchPath('/grand-parent/parent/child?nickname=gran&names=papa-maman', { strictQueryParams: false }).should.eql({
           _meta: {
               grandParent: {
                   nickname: 'query'
@@ -269,19 +269,19 @@ describe('RouteNode', function () {
     it('should match paths with optional trailing slashes', function () {
         var rootNode = getRoutes();
         should.not.exists(rootNode.matchPath('/users/list/'));
-        withoutMeta(rootNode.matchPath('/users/list', true)).should.eql({name: 'users.list', params: {}});
+        withoutMeta(rootNode.matchPath('/users/list', { trailingSlash: true })).should.eql({name: 'users.list', params: {}});
         withoutMeta(rootNode.matchPath('/users/list')).should.eql({name: 'users.list', params: {}});
-        withoutMeta(rootNode.matchPath('/users/list/', true)).should.eql({name: 'users.list', params: {}});
-        should.not.exists(rootNode.matchPath('/users/list//', true));
+        withoutMeta(rootNode.matchPath('/users/list/', { trailingSlash: true })).should.eql({name: 'users.list', params: {}});
+        should.not.exists(rootNode.matchPath('/users/list//', { trailingSlash: true }));
 
         var rootNode = getRoutes(true);
         should.not.exists(rootNode.matchPath('/users/list'));
-        withoutMeta(rootNode.matchPath('/users/list', true)).should.eql({name: 'users.list', params: {}});
-        withoutMeta(rootNode.matchPath('/users/list/', true)).should.eql({name: 'users.list', params: {}});
+        withoutMeta(rootNode.matchPath('/users/list', { trailingSlash: true })).should.eql({name: 'users.list', params: {}});
+        withoutMeta(rootNode.matchPath('/users/list/', { trailingSlash: true })).should.eql({name: 'users.list', params: {}});
         withoutMeta(rootNode.matchPath('/users/list/')).should.eql({name: 'users.list', params: {}});
         withoutMeta(rootNode.matchPath('/')).should.eql({name: 'default', params: {}});
-        withoutMeta(rootNode.matchPath('', true)).should.eql({name: 'default', params: {}});
-        should.not.exists(rootNode.matchPath('/users/list//', true));
+        withoutMeta(rootNode.matchPath('', { trailingSlash: true })).should.eql({name: 'default', params: {}});
+        should.not.exists(rootNode.matchPath('/users/list//', { trailingSlash: true }));
     });
 });