Support specifying ids in Service.enrichment call

CHANGES

@@ -67,4 +67,5 @@
 3.12.0 Query#orderBy and Query#select accept an options object to silence events.
 3.13.0 findById now accepts a list of fields to find.
 3.16.0 update params for paginating query and setting number of results returned. Thanks Aman!
+3.17.0 support specifying ids instead of list in service.enrichment options
 **/

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "imjs",
-  "version": "3.15.1",
+  "version": "3.17.0",
   "description": "Client library for communication with InterMine web-services",
   "main": "js/im.js",
   "dependencies": {},

js/im.js

@@ -1,4 +1,4 @@
-/*! imjs - v3.16.0 - 2019-08-22 */
+/*! imjs - v3.17.0 - 2019-12-09 */
 
 // This library is open source software according to the definition of the
 // GNU Lesser General Public Licence, Version 3, (LGPLv3) a copy of which is
@@ -3541,11 +3541,18 @@
     Service.prototype.enrichment = function(opts, cb) {
       return REQUIRES_VERSION(this, 8, (function(_this) {
         return function() {
-          var req;
-          req = merge({
+          var defaults, req;
+          defaults = {
             maxp: 0.05,
             correction: 'Holm-Bonferroni'
-          }, opts);
+          };
+          if (utils.isArray(opts.ids)) {
+            req = merge(defaults, opts, {
+              ids: opts.ids.join(",")
+            });
+          } else {
+            req = merge(defaults, opts);
+          }
           return withCB(cb, _this.get(ENRICHMENT_PATH, req).then(get('results')));
         };
       })(this));
@@ -5071,7 +5078,7 @@
 
 },{"./promise":8}],17:[function(_dereq_,module,exports){
 (function() {
-  exports.VERSION = '3.16.0';
+  exports.VERSION = '3.17.0';
 
 }).call(this);
 

package.json

@@ -1,11 +1,11 @@
 {
   "name": "imjs",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Client library for communication with InterMine web-services",
   "main": "build/service",
   "browser": {
     "xmldom": "./build/shims/xmldom.js",
-		"build/service": "./dist/im.js"
+    "build/service": "./dist/im.js"
   },
   "keywords": [
     "javascript",

src/service.coffee

@@ -297,6 +297,7 @@ class Service
   # of the items in this list.
   # @param [Object<String, String>] opts The parameters to pass to the calculation.
   # @option opts [String] list The name of the list to analyse.
+  # @option opts [Array<Number>] ids Array of InterMine object ID numbers to analyse.
   # @option opts [String] widget The name of the enrichment calculation to use.
   # @option opts [Number] maxp The maximum permissible p-value (optional, default = 0.05).
   # @option opts [String] correction The correction algorithm to use (default = Holm-Bonferroni).
@@ -306,7 +307,13 @@ class Service
   # @param [->] cb A function to call with the results when they have been received (optional).
   # @return [Promise<Array<Object>>] A promise to get results.
   enrichment: (opts, cb) => REQUIRES_VERSION @, 8, =>
-    req = merge {maxp: 0.05, correction: 'Holm-Bonferroni'}, opts
+    defaults = {maxp: 0.05, correction: 'Holm-Bonferroni'}
+
+    if utils.isArray opts.ids
+      req = merge defaults, opts, {ids: opts.ids.join(",")}
+    else
+      req = merge defaults, opts
+
     withCB cb, @get(ENRICHMENT_PATH, req).then(get 'results')
 
   # Search for items in the database by any term or facet.

test/mocha/enrichment.coffee

@@ -55,6 +55,18 @@ integrationTests() && describe 'Service', ->
 
     it 'performs an enrichment calculation', eventually there_are_seven
 
+
+  integrationTests() && describe '#enrichment, using ids', ->
+
+    @beforeAll prepare -> service.enrichment
+      # ID contents of 'My-Favourite-Employees' list.
+      ids: [2000010, 2000019, 2000064, 2000067]
+      widget: 'contractor_enrichment'
+      maxp: 1
+      correction: 'Bonferroni'
+
+    it 'performs an enrichment calculation using ids', eventually there_are_seven
+
   integrationTests() && describe '#enrichment with callback', ->
 
     it 'performs an enrichment calculation with a callback', (done) ->