adapt-authoring-api 1.1.0 → 1.2.0

package/errors/errors.json

@@ -28,5 +28,14 @@
   "NO_SCHEMA_DEF": {
     "description": "No json schema has been defined",
     "statusCode": 404
+  },
+  "TOO_MANY_RESULTS": {
+    "data": {
+      "actual": "Number of actual results",
+      "expected": "Number of expected results",
+      "query": "The query"
+    },
+    "description": "Too many results were returned",
+    "statusCode": 500
   }
 }

package/lib/AbstractApiModule.js

@@ -566,6 +566,21 @@ class AbstractApiModule extends AbstractModule {
     return this.cache.get(q, options, mongoOptions)
   }
 
+  /**
+   * Retrieves a single document from the DB. If multiple results are returned from the query, an error is thrown.
+   * @param {Object} query Attributes to use to filter DB documents
+   * @param {FindOptions} options Function options
+   * @param {external:MongoDBFindOptions} mongoOptions Options to be passed to the MongoDB function
+   * @return {Promise} Resolves with the single DB document
+   */
+  async findOne (query, options, mongoOptions) {
+    const results = await this.find(query, options, mongoOptions)
+    if (results.length > 1) {
+      throw this.app.errors.TOO_MANY_RESULTS.setData({ actual: results.length, expected: 1, query })
+    }
+    return results[0]
+  }
+
   /**
    * Updates an existing document in the DB
    * @param {Object} query Attributes to use to filter DB documents

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-api",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Abstract module for creating APIs",
   "homepage": "https://github.com/adapt-security/adapt-authoring-api",
   "license": "GPL-3.0",