adapt-authoring-mongodb 1.0.0 → 1.1.0

package/.github/workflows/standardjs.yml

@@ -0,0 +1,13 @@
+name: Standard.js formatting check
+on: push
+jobs:
+  default:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@master
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+      - run: npm ci
+      - run: npx standard

package/index.js

@@ -2,6 +2,5 @@
  * MongoDB integration
  * @namespace mongodb
  */
- export { default as ObjectIdUtils } from './lib/ObjectIdUtils.js'
- export { default } from './lib/MongoDBModule.js'
- 
+export { default as ObjectIdUtils } from './lib/ObjectIdUtils.js'
+export { default } from './lib/MongoDBModule.js'

package/lib/MongoDBModule.js

@@ -125,7 +125,8 @@ class MongoDBModule extends AbstractModule {
     this.ObjectId.parseIds(query)
     this.parseOptions(options)
     try {
-      return await this.getCollection(collectionName).find(query, options).toArray()
+      const cursor = this.getCollection(collectionName).find(query, options)
+      return options?.returnCursor === true ? cursor : await cursor.toArray()
     } catch (e) {
       this.log('error', `failed to find docs, ${e.message}`)
       throw this.getError(collectionName, 'find', e)

package/lib/typedefs.js

@@ -60,4 +60,4 @@
  * @memberof mongodb
  * @external MongoDBUpdateOptions
  * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/UpdateOptions.html}
- */
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-mongodb",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Module for saving to a MongoDB instance",
   "homepage": "https://github.com/adapt-security/adapt-authoring-mongodb",
   "license": "GPL-3.0",
@@ -14,7 +14,6 @@
     "adapt-authoring-core": "github:adapt-security/adapt-authoring-core"
   },
   "devDependencies": {
-    "eslint": "^9.12.0",
     "standard": "^17.1.0",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/git": "^10.0.1",

package/.eslintignore

@@ -1 +0,0 @@
-node_modules

package/.eslintrc

@@ -1,14 +0,0 @@
-{
-  "env": {
-      "browser": false,
-      "node": true,
-      "commonjs": false,
-      "es2020": true
-  },
-  "extends": [
-      "standard"
-  ],
-  "parserOptions": {
-      "ecmaVersion": 2020
-  }
-}

package/tests/mongoDBModule.spec.js

@@ -1,109 +0,0 @@
-const MongoDBModule = require('../lib/MongoDBModule');
-const should = require('should');
-
-describe('MongoDB module', function() {
-  describe('#readyState()', function() {
-    it('should return a number', function() {
-      false.should.be.true();
-    });
-    it('should return a value even if no connection', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#isConnected()', function() {
-    it('should return true if connected', function() {
-      false.should.be.true();
-    });
-    it('should return false if not connected', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#connectionURI()', function() {
-    it('should return a valid connection string', function() {
-      false.should.be.true();
-    });
-    it('should not include undefined values', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#getCollection()', function() {
-    it('should return a MongoDB collection', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#connect()', function() {
-    it('should establish a connection to specified MongoDB instance', function() {
-      false.should.be.true();
-    });
-    it('should fail gracefully on error', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#insert()', function() {
-    it('should return a promise', function() {
-      false.should.be.true();
-    });
-    it('should return an error if no data is passed', function() {
-      false.should.be.true();
-    });
-    it('should return the inserted document', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#find()', function() {
-    it('should return a promise', function() {
-      false.should.be.true();
-    });
-    it('should return an error if invalid query data is passed', function() {
-      false.should.be.true();
-    });
-    it('should return an error if invalid model type is specified', function() {
-      false.should.be.true();
-    });
-    it('should populate specified attributes', function() {
-      false.should.be.true();
-    });
-    it('should return matching documents', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#replace()', function() {
-    it('should return a promise', function() {
-      false.should.be.true();
-    });
-    it('should return an error if invalid query data is passed', function() {
-      false.should.be.true();
-    });
-    it('should return an error if invalid model type is specified', function() {
-      false.should.be.true();
-    });
-    it('should replace matching document(s)', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#delete()', function() {
-    it('should return a promise', function() {
-      false.should.be.true();
-    });
-    it('should return an error if invalid query data is passed', function() {
-      false.should.be.true();
-    });
-    it('should return an error if invalid model type is specified', function() {
-      false.should.be.true();
-    });
-    it('should delete matching document(s)', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#formatError()', function() {
-    it('should return an Error', function() {
-      false.should.be.true();
-    });
-    it('should set custom statusCode', function() {
-      false.should.be.true();
-    });
-    it('should set default statusCode', function() {
-      false.should.be.true();
-    });
-  });
-});

package/tests/objectIdUtils.spec.js

@@ -1,37 +0,0 @@
-const should = require('should');
-
-describe('ObjectId Utils', function() {
-  describe('#isValid', function() {
-    it('should return false for empty/undefined param', function() {
-      false.should.be.true();
-    });
-    it('should return true for valid string', function() {
-      false.should.be.true();
-    });
-    it('should return true for invalid type', function() {
-      false.should.be.true();
-    });
-    it('should return true for invalid string', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#parse', function() {
-    it('should return an ObjectId instance', function() {
-      false.should.be.true();
-    });
-    it('should throw an error on invalid input', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#parseParamIds', function() {
-    it('parse a valid _id to an ObjectId', function() {
-      false.should.be.true();
-    });
-    it('throw an error on invalid _id', function() {
-      false.should.be.true();
-    });
-    it('ignore non _id fields', function() {
-      false.should.be.true();
-    });
-  });
-});