Merge pull request #16 from fratzinger/master

merge params deeply & ability to pass a function

.gitignore

@@ -13,6 +13,7 @@ pids
 lib-cov
 
 # Coverage directory used by tools like istanbul
+.nyc_output
 coverage
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)

README.md

@@ -26,7 +26,9 @@ const options = {
     service: 'tags',
     nameAs: 'tags',
     keyHere: 'tagIds',
-    keyThere: '_id'
+    keyThere: '_id',
+    asArray: true, // by default
+    params: {} // by default
   }
 }
 
@@ -37,6 +39,17 @@ app.service('posts').hooks({
 });
 ```
 
+## Options for include
+
+| **Option** | **Description** |
+|------------|-----------------|
+| `service`  | The service to reference<br><br>**required**<br>**Type:** `{String}` |
+| `nameAs`   | The property to be assigned to on this entry<br><br>**required**<br>**Type:** `{String}` |
+| `keyHere`  | The primary or secondary key for this entry<br><br>**required**<br>**Type:** `{String}` |
+| `keyThere` | The primary or secondary key for the referenced entry/entries<br><br>**required**<br>**Type:** `{String}` |
+| `asArray`  | Is the referenced item a single entry or an array of entries?<br><br>**optional - default:** `true`<br>**Type:** `{Boolean}`
+| `params`   | Additional params to be passed to the underlying service.<br>You can mutate the passed `params` object or return a newly created `params` object which gets merged deeply <br>Merged deeply after the params are generated internally.<br><quote>**ProTip:** You can use this for adding a '$select' property or passing authentication and user data from 'context' to 'params' to restrict accesss</quote><br><br>**optional - default:** `{}`<br>**Type:** `{Object | Function(params, context): undefined|params}` |
+
 ## Multiple Populates
 ```js
 const { shallowPopulate } = require('feathers-shallow-populate')
@@ -47,13 +60,17 @@ const options = {
       service: 'tags',
       nameAs: 'tags',
       keyHere: 'tagIds',
-      keyThere: '_id'
+      keyThere: '_id',
+      asArray: true,
+      params: {}
     },
     {
       service: 'comments',
       nameAs: 'comments',
       keyHere: 'commentIds',
-      keyThere: '_id'
+      keyThere: '_id',
+      asArray: true,
+      params: {}
     }
   ]
 }
@@ -105,7 +122,8 @@ const options = {
     nameAs: 'publisher',
     keyHere: 'publisherId',
     keyThere: 'id',
-    asArray: false
+    asArray: false,
+    params: {}
   }
 }
 

lib/shallow-populate.js

@@ -2,6 +2,8 @@ const assert = require('assert')
 const getByDot = require('lodash/get')
 const setByDot = require('lodash/set')
 const isEqual = require('lodash/isEqual')
+const isFunction = require('lodash/isFunction')
+const merge = require('lodash/merge')
 const defaults = {
   include: undefined
 }
@@ -104,15 +106,20 @@ module.exports = function (options) {
     //   }
     // }
 
-    const paramSets = includes.map(i => {
+    const params = includes.map(i => {
       const keyVals = dataMap[i.keyHere]
       let keysHere = Object.keys(keyVals) || []
       keysHere = keysHere.map(k => keyVals[k].key)
+      let params = { query: { [i.keyThere]: { $in: keysHere } }, paginate: false }
 
-      return { query: { [i.keyThere]: { $in: keysHere } } }
+      const providedParams = (isFunction(i.params)) ? i.params(params, context) : i.params
+
+      if (providedParams && params != providedParams) params = merge(params, providedParams)
+
+      return params
     })
 
-    const requests = includes.map((i, index) => app.service(i.service).find(Object.assign({}, paramSets[index], { paginate: false }, i.params)))
+    const requests = includes.map((include, index) => app.service(include.service).find(params[index]))
 
     return Promise.all(requests)
       .then(responses => {