add support for extra populate options on relationships

Author: danivek

README.md

@@ -36,8 +36,13 @@ var JSONAPIMongoParser = require(json-api-mongo-parser);
 var jsonApiMongoParser = new JSONAPIMongoParser({
   article: {
     relationships: { // Declaring relationships with its type
-      author: 'people',
-      comments: 'comment',
+      author: 'people', // can be a string
+      comments: { // Or an object with extra options for population query
+        type : 'comment',
+        options: {
+          lean: true
+        }
+      },
     }
   },
   comment: {

lib/JSONAPIMongoParser.js

@@ -116,15 +116,25 @@ module.exports = class JSONAPIMongoParser {
             if (lastNode === currentNode) {
               // Parse select for include type
               const select = this.parseFields(_.get(flatOptions[type], chain.slice(0, j + 1).concat(['type'])), fieldsQuery);
+              // Get populate options defined on this relationships
+              const options = _.get(flatOptions[type], chain.slice(0, j + 1).concat(['options']));
+
+              // Populate query
               const populate = {
                 path: wantedNode,
                 populate: [],
               };
 
+              // Select
               if (select) {
                 populate.select = select;
               }
 
+              // Extra options
+              if (options) {
+                populate.options = options;
+              }
+
               const newNode = currentNode[k] = populate;
               currentNode = newNode.populate;
             }
@@ -138,6 +148,15 @@ module.exports = class JSONAPIMongoParser {
     return !_.isEmpty(output) ? output : undefined;
   }
 
+  parse(type, query) {
+    return {
+      select: this.parseFields(type, query.fields),
+      sort: this.parseSort(query.sort),
+      page: this.parsePage(query.page),
+      populate: this.parseInclude(type, query.include, query.fields),
+    };
+  }
+
   _removeDeepEmptyArray(item) {
     const that = this;
     _.forOwn(item, (value, key) => {
@@ -151,26 +170,24 @@ module.exports = class JSONAPIMongoParser {
     });
   }
 
-  parse(type, query) {
-    return {
-      select: this.parseFields(type, query.fields),
-      sort: this.parseSort(query.sort),
-      page: this.parsePage(query.page),
-      populate: this.parseInclude(type, query.include, query.fields),
-    };
-  }
-
   _flattenOptions() {
     const flatOptions = {};
     const that = this;
 
     const flattenRelationships = function(type) {
-      const flatRelationships = {
-        type: type,
-      };
+      let flatRelationships;
+
+      // Type definition can be a string or an object with extra options for population query
+      if (_.isString(type)) {
+        flatRelationships = {
+          type: type,
+        };
+      } else {
+        flatRelationships = type;
+      }
 
-      if (that.options[type] && that.options[type].relationships) {
-        _.forOwn(that.options[type].relationships, (value, key) => {
+      if (that.options[flatRelationships.type] && that.options[flatRelationships.type].relationships) {
+        _.forOwn(that.options[flatRelationships.type].relationships, (value, key) => {
           flatRelationships[key] = flattenRelationships(value);
         });
       }

test/unit/JSONAPIMongoParser.test.js

@@ -325,7 +325,12 @@ describe('JSONAPIMongoParser', function() {
         article: {
           relationships: {
             author: 'people',
-            comments: 'comment',
+            comments: {
+              type: 'comment',
+              options: {
+                lean: true
+              }
+            },
           }
         },
         comment: {
@@ -398,6 +403,9 @@ describe('JSONAPIMongoParser', function() {
             body: 1,
             author: 1,
             tag: 1
+          },
+          options: {
+            lean: true
           }
         }]
       });