adapt-authoring-mongodb 0.0.1

package/.eslintignore

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

package/.eslintrc

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

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,55 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: Please describe the issue
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: Tell us what should have happened
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Steps to reproduce
+      description: Tell us how to reproduce the issue
+    validations:
+      required: true
+  - type: input
+    id: aat-version
+    attributes:
+      label: Authoring tool version
+      description: What version of the Adapt authoring tool are you running?
+    validations:
+      required: true
+  - type: input
+    id: fw-version
+    attributes:
+      label: Framework version
+      description: What version of the Adapt framework are you running?
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: sh

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,22 @@
+name: Feature request
+description: Request a new feature
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to request a new feature in the Adapt authoring tool! The Adapt team will consider all new feature requests, but unfortunately cannot commit to every one.
+  - type: textarea
+    id: description
+    attributes:
+      label: Feature description
+      description: Please describe your feature request
+    validations:
+      required: true
+  - type: checkboxes
+    id: contribute
+    attributes:
+      label: Can you work on this feature?
+      description: If you are able to commit your own time to work on this feature, it will greatly increase the liklihood of it being implemented by the core dev team. Otherwise, it will be triaged and prioritised alongside the core team's current priorities.
+      options:
+        - label: I can contribute

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/pull_request_template.md

@@ -0,0 +1,25 @@
+[//]: # (Please title your PR according to eslint commit conventions)
+[//]: # (See https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint#eslint-convention for details)
+
+[//]: # (Add a link to the original issue)
+
+[//]: # (Delete as appropriate)
+### Fix
+* A sentence describing each fix
+
+### Update
+* A sentence describing each udpate
+
+### New
+* A sentence describing each new feature
+
+### Breaking
+* A sentence describing each breaking change
+
+[//]: # (List appropriate steps for testing if needed)
+### Testing
+1. Steps for testing
+
+[//]: # (Mention any other dependencies)
+
+

package/.github/workflows/labelled_prs.yml

@@ -0,0 +1,16 @@
+name: Add labelled PRs to project
+
+on:
+  pull_request:
+    types: [ labeled ]
+
+jobs:
+  add-to-project:
+    if: ${{ github.event.label.name == 'dependencies' }}
+    name: Add to main project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.1.0
+        with:
+          project-url: https://github.com/orgs/adapt-security/projects/5
+          github-token: ${{ secrets.PROJECTS_SECRET }}

package/.github/workflows/new.yml

@@ -0,0 +1,19 @@
+name: Add to main project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add to main project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.1.0
+        with:
+          project-url: https://github.com/orgs/adapt-security/projects/5
+          github-token: ${{ secrets.PROJECTS_SECRET }}

package/adapt-authoring.json

@@ -0,0 +1,9 @@
+{
+  "essentialType": "db",
+  "documentation": {
+    "enable": true,
+    "manualPages": {
+      "using-mongodb.md": "basics"
+    }
+  }
+}

package/conf/config.schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "connectionUri": {
+      "description": "The MongoDB connection URI used to connect to your MongoDB deployment.",
+      "type": "string",
+      "format": "uri",
+      "examples": [
+        "mongodb://0.0.0.0/adapt-authoring",
+        "mongodb://test1.adaptlearning.org:27018,test2.adaptlearning.org:27019/?replicaSet=test"
+      ]
+    }
+  },
+  "required": ["connectionUri"]
+}

package/docs/using-mongodb.md

@@ -0,0 +1,66 @@
+# Using MongoDB
+The `adapt-authoring-mongodb` module adds the ability to work with MongoDB databases.
+
+## Installing MongoDB
+To save data with the authoring tool, you'll need either a local MongoDB install, or a hosted solution.
+
+If you're new to hosting web applications/MongoDB and are intending to make your install accessible via the internet, we'd suggest going with a hosted solution.
+
+For instructions on installing MongoDB, see the [MongoDB docs](https://docs.mongodb.com/manual/installation/#mongodb-community-edition-installation-tutorials).
+
+## Using the module
+The `adapt-authoring-mongodb` module uses MongoDB's [Node.js driver](https://mongodb.github.io/node-mongodb-native/4.2) behind-the-scenes for communicating with MongoDB.
+
+Where possible, the MongoDBModule API has been designed to mirror the MongoDB Node.js driver API in both naming convensions and parameter naming/order. In some cases this has been changed for ease-of-use (e.g. `insertOne` has been renamed to `insert`). Please see the [Adapt authoring reference for the MongoDBModule](/class/node_modules/adapt-authoring-mongodb/lib/MongoDBModule.js~MongoDBModule.html) for more information (details on which of the MongoDB Node.js driver functions are used is specified there).
+
+> If you're new to working with MongoDB, check out this [Quick Start](https://mongodb.github.io/node-mongodb-native/4.2/#quick-start) guide in the official docs for a good overview.
+
+### Basic use
+The following functions provide the most common functionality, and will likely be the functions you use most often. Please see the [API reference]([/class/node_modules/adapt-authoring-mongodb/lib/MongoDBModule.js~MongoDBModule.html](https://tomtaylor.codes/ls/jsdoc3/MongoDBModule.html)) for full details.
+
+#### `find(collectionName, query, options)`
+Retrieves a document.
+
+#### `insert(collectionName, data, options)`
+Inserts a new document.
+
+#### `replace(collectionName, query, data, options)`
+Completely replaces an existing document.
+
+#### `update(collectionName, query, data, options)`
+Updates only specific fields of an existing document.
+
+#### `delete(collectionName, query, options)`
+Removes an existing document.
+
+### Querying the database
+The `find` function is used to retrieve documents from the database.
+
+
+#### Examples
+Note that the MongoDB module, as with the rest of the application, makes heavy use of promises, and will return a pending Promise for all relevant functions.
+
+Inserting a document into the 'test' collection:
+```
+try {
+  const data = await mongodb.insert('test', { hello: 'world' });
+} catch(e) {
+  // handle error
+}
+```
+
+### Advanced use
+It is possible to access the Node.js driver API directly from the MongoDBModule instance to allow for extra functionality not covered by the MongoDBModule itself. An example of this being creating an aggregation pipeline.
+
+There are two methods of accessing the driver API. Which one you use is entirely up to you, and mostly comes down to code brevity:
+- Using the MongoDB client instance [[Adapt docs](https://tomtaylor.codes/ls/jsdoc3/MongoDBModule.html#client), [MongoDB Node.js driver docs](https://mongodb.github.io/node-mongodb-native/3.6/api/MongoClient.html)]
+- Using the MongoDB collection [[Adapt docs](), [MongoDB Node.js driver docs](https://tomtaylor.codes/ls/jsdoc3/MongoDBModule.html#getCollection)]
+
+```
+// using the client instance
+mongodb.client.db.collection('mycollection').aggregate(/* args */)
+// using MongoDBModule#getCollection
+mongodb.getCollection('mycollection').aggregate(/* args */)
+```
+
+See the [MongoDB Node.js driver docs](https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html) for the full API.

package/errors/errors.json

@@ -0,0 +1,43 @@
+{
+  "INVALID_OBJECTID": {
+    "data": {
+      "value": "The value"
+    },
+    "description": "Not a valid ObjectId",
+    "statusCode": 400
+  },
+  "MONGO_CONN_FAILED": {
+    "data": {
+      "error": "The error message"
+    },
+    "description": "An error occurred connecting to the MongoDB instance",
+    "statusCode": 500
+  },
+  "MONGO_DUPL_INDEX": {
+    "data": {
+      "action": "The action being performed on the database collection",
+      "collectionName": "Name of the collection being processed",
+      "error": "The error message"
+    },
+    "description": "A document already exists with the same indexed value",
+    "statusCode": 400
+  },
+  "MONGO_ERROR": {
+    "data": {
+      "action": "The action being performed on the database collection",
+      "collectionName": "Name of the collection being processed",
+      "error": "The error message"
+    },
+    "description": "An error occurred while performing a MongoDB action",
+    "statusCode": 500
+  },
+  "MONGO_IMMUTABLE_FIELD": {
+    "data": {
+      "action": "The action being performed on the database collection",
+      "collectionName": "Name of the collection being processed",
+      "error": "The error message"
+    },
+    "description": "Attempting to modify an immutable field",
+    "statusCode": 400
+  }
+}

package/index.js

@@ -0,0 +1,7 @@
+/**
+ * MongoDB integration
+ * @namespace mongodb
+ */
+ export { default as ObjectIdUtils } from './lib/ObjectIdUtils.js'
+ export { default } from './lib/MongoDBModule.js'
+ 

package/lib/MongoDBModule.js

@@ -0,0 +1,270 @@
+import { AbstractModule } from 'adapt-authoring-core'
+import { MongoClient } from 'mongodb'
+import ObjectIdUtils from './ObjectIdUtils.js'
+/**
+ * Represents a single MongoDB server instance
+ * @memberof mongodb
+ * @extends {AbstractModule}
+ */
+class MongoDBModule extends AbstractModule {
+  /** @override */
+  async init () {
+    await this.app.waitForModule('config')
+    /**
+     * Reference to the MongDB client
+     * @type {external:MongoDBMongoClient}
+     */
+    this.client = new MongoClient(this.getConfig('connectionUri'), { ignoreUndefined: true })
+    await this.connect()
+    // add custom keywords to JSON Schema validator
+    await ObjectIdUtils.addSchemaKeyword()
+  }
+
+  /**
+   * Connects to the database
+   * @return {Promise}
+   */
+  async connect () {
+    try {
+      await this.client.connect()
+      const { hosts, dbName } = this.client.options
+      this.log('info', `connected to ${dbName} on ${hosts}`)
+    } catch (e) {
+      throw this.app.errors.MONGO_CONN_FAILED
+        .setData({ error: e.message })
+    }
+  }
+
+  /**
+   * Get all the db statistics
+   * @return {Promise}
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Db.html#stats
+   */
+  async getStats () {
+    return this.client.db().stats()
+  }
+
+  /**
+   * Returns the associated MongoDB collection
+   * @param {String} collectionName The name of the MongoDB collection
+   * @return {external:MongoDBCollection}
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html
+   */
+  getCollection (collectionName) {
+    return this.client.db().collection(collectionName)
+  }
+
+  /**
+   * Set an index on a MongoDB collection
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {String|Array|Object} fieldOrSpec Definition of the index
+   * @param {external:MongoDBCreateIndexesOptions} options Options to pass to the MongoDB driver
+   * @return {Promise}
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#createIndex
+   */
+  async setIndex (collectionName, fieldOrSpec, options) {
+    try {
+      await this.getCollection(collectionName).createIndex(fieldOrSpec, options)
+    } catch (e) {
+      this.log('warn', e.toString())
+    }
+  }
+
+  /**
+   * Makes sure options are in the correct format.
+   * @param {Object} options The options to parse
+   */
+  parseOptions (options) {
+    if (!options) {
+      return
+    }
+    ['limit', 'skip'].forEach(o => {
+      if (options[o] === undefined) return
+      try {
+        options[o] = parseInt(options[o])
+      } catch (e) {
+        this.log('warn', `value for option '${o}' is in an unexpected format and will be ignored`)
+        delete options[o]
+      }
+    })
+  }
+
+  /**
+   * Adds a new object to the database
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {Object} data
+   * @param {external:MongoDBInsertOneOptions} options Options to pass to the MongoDB driver
+   * @return {Promise} promise
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#insertOne
+   */
+  async insert (collectionName, data, options) {
+    this.ObjectId.parseIds(data)
+    this.parseOptions(options)
+    // MongoDB doesn't like the explicit setting of _id
+    delete data._id
+    if (data.$set) delete data.$set._id
+    try {
+      const { insertedId } = await this.getCollection(collectionName).insertOne(data, options)
+      const [doc] = await this.find(collectionName, { _id: insertedId })
+      return doc
+    } catch (e) {
+      this.log('error', `failed to insert doc, ${e.message}`)
+      throw this.getError(collectionName, 'insert', e)
+    }
+  }
+
+  /**
+   * Retrieves a new object from the database
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {Object} query
+   * @param {external:MongoDBFindOptions} options Options to pass to the MongoDB driver
+   * @return {Promise} promise
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#find
+   */
+  async find (collectionName, query, options) {
+    this.ObjectId.parseIds(query)
+    this.parseOptions(options)
+    try {
+      return await this.getCollection(collectionName).find(query, options).toArray()
+    } catch (e) {
+      this.log('error', `failed to find docs, ${e.message}`)
+      throw this.getError(collectionName, 'find', e)
+    }
+  }
+
+  /**
+   * Updates an existing object in the database
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {Object} query
+   * @param {Object} data
+   * @param {external:MongoDBFindOneAndUpdateOptions} options Options to pass to the MongoDB driver
+   * @return {Promise} promise
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#findOneAndUpdate
+   */
+  async update (collectionName, query, data, options) {
+    const opts = Object.assign({ includeResultMetadata: false, returnDocument: 'after' }, options)
+    this.parseOptions(opts)
+    this.ObjectId.parseIds(query)
+    this.ObjectId.parseIds(data)
+    // MongoDB doesn't like the explicit setting of _id
+    delete data._id
+    if (data.$set) delete data.$set._id
+    try {
+      return await this.getCollection(collectionName).findOneAndUpdate(query, data, opts)
+    } catch (e) {
+      this.log('error', `failed to update doc, ${e.message}`)
+      throw this.getError(collectionName, 'update', e)
+    }
+  }
+
+  /**
+   * Updates multiple objects in the database
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {Object} query
+   * @param {external:MongoDBUpdateManyOptions} options Options to pass to the MongoDB driver
+   * @return {Promise} promise
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#updateMany
+   */
+  async updateMany (collectionName, query, data, options) {
+    this.parseOptions(options)
+    this.ObjectId.parseIds(query)
+    this.ObjectId.parseIds(data)
+    // MongoDB doesn't like the explicit setting of _id
+    delete data._id
+    if (data.$set) delete data.$set._id
+    try {
+      await this.getCollection(collectionName).updateMany(query, data, options)
+      return this.find(collectionName, query)
+    } catch (e) {
+      this.log('error', `failed to update docs, ${e.message}`)
+      throw this.getError(collectionName, 'update', e)
+    }
+  }
+
+  /**
+   * Replaces an existing object in the database
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {Object} query
+   * @param {Object} data
+   * @param {external:MongoDBFindOneAndReplaceOptions} options Options to pass to the MongoDB driver
+   * @return {Promise} promise
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#findOneAndReplace
+   */
+  async replace (collectionName, query, data, options) {
+    const opts = Object.assign({ includeResultMetadata: false, returnDocument: 'after' }, options)
+    this.ObjectId.parseIds(query)
+    this.ObjectId.parseIds(data)
+    this.parseOptions(options)
+    // MongoDB doesn't like the explicit setting of _id
+    delete data._id
+    if (data.$set) delete data.$set._id
+    try {
+      return await this.getCollection(collectionName).findOneAndReplace(query, data, opts)
+    } catch (e) {
+      this.log('error', `failed to replace doc, ${e.message}`)
+      throw this.getError(collectionName, 'replace', e)
+    }
+  }
+
+  /**
+   * Removes an existing object from the database
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {Object} query
+   * @param {external:MongoDBDeleteOptions} options Options to pass to the MongoDB driver
+   * @return {Promise} promise
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#deleteOne
+   */
+  async delete (collectionName, query, options) {
+    this.ObjectId.parseIds(query)
+    this.parseOptions(options)
+    try {
+      await this.getCollection(collectionName).deleteOne(query, options)
+    } catch (e) {
+      this.log('error', `failed to delete doc, ${e.message}`)
+      throw this.getError(collectionName, 'delete', e)
+    }
+  }
+
+  /**
+   * Removes multiple objects from the database
+   * @param {String} collectionName The name of the MongoDB collection
+   * @param {Object} query
+   * @param {external:MongoDBDeleteOptions} options Options to pass to the MongoDB driver
+   * @return {Promise} promise
+   * @see https://mongodb.github.io/node-mongodb-native/4.2/classes/Collection.html#deleteMany
+   */
+  async deleteMany (collectionName, query, options) {
+    this.ObjectId.parseIds(query)
+    this.parseOptions(options)
+    try {
+      await this.getCollection(collectionName).deleteMany(query, options)
+    } catch (e) {
+      this.log('error', `failed to delete docs, ${e.message}`)
+      throw this.getError(collectionName, 'delete', e)
+    }
+  }
+
+  /**
+   * Returns the relevant AdaptError instance to match the MongoError
+   * @param {String} collectionName DB collection being processed
+   * @param {String} action DB action being performed
+   * @param {String} error The error message
+   * @returns {AdaptError}
+   */
+  getError (collectionName, action, error) {
+    let e = this.app.errors.MONGO_ERROR
+    if (error.code === 66) e = this.app.errors.MONGO_IMMUTABLE_FIELD
+    else if (error.code === 11000) e = this.app.errors.MONGO_DUPL_INDEX
+    return e.setData({ collectionName, action, error: error.message })
+  }
+
+  /**
+   * ObjectId utility functions
+   * @type {ObjectIdUtils}
+   */
+  get ObjectId () {
+    return ObjectIdUtils
+  }
+}
+
+export default MongoDBModule

package/lib/ObjectIdUtils.js

@@ -0,0 +1,102 @@
+import { App, Utils } from 'adapt-authoring-core'
+import { ObjectId } from 'mongodb'
+/**
+ * Utility functions for dealing with MongoDB ObjectIds
+ * @memberof mongodb
+ */
+class ObjectIdUtils {
+  /**
+   * Registers the isObjectId JSON schema keyword
+   */
+  static async addSchemaKeyword () {
+    const jsonschema = await App.instance.waitForModule('jsonschema')
+    jsonschema.addKeyword({
+      keyword: 'isObjectId',
+      type: 'string',
+      modifying: true,
+      schemaType: 'boolean',
+      compile: () => {
+        return (value, { parentData, parentDataProperty }) => {
+          if (!ObjectIdUtils.isValid(value)) {
+            return false
+          }
+          try {
+            parentData[parentDataProperty] = ObjectIdUtils.parse(value)
+          } catch (e) {
+            return false
+          }
+          return true
+        }
+      }
+    })
+  }
+
+  /**
+   * Creates a new ObjectId instance
+   * @return {external:MongoDBObjectId}
+   */
+  static create () {
+    return new ObjectId()
+  }
+
+  /**
+   * Checks a string is a valid ObjectId
+   * @param {String} s String to check
+   * @return {Boolean}
+   */
+  static isValid (s) {
+    try {
+      return ObjectIdUtils.parse(s).equals(s)
+    } catch (e) {
+      return false
+    }
+  }
+
+  /**
+   * Converts a string to an ObjectId
+   * @param {String} s The string to convert
+   * @return {external:MongoDBObjectId} The converted ID
+   * @throws {Error}
+   */
+  static parse (s) {
+    if (ObjectIdUtils.isObjectId(s)) {
+      return s
+    }
+    if (!ObjectId.isValid(s)) {
+      throw App.instance.errors.INVALID_OBJECTID.setData({ value: s })
+    }
+    return new ObjectId(s)
+  }
+
+  /**
+   * Checks an input object for any strings which pass the parse check and convert matches to ObjectId instances
+   * @param {Object} o Object to be checked
+   */
+  static parseIds (o) {
+    if (o === undefined) {
+      return
+    }
+    Object.entries(o).forEach(([k, v]) => {
+      if (Utils.isObject(v)) {
+        this.parseIds(v)
+      } else if (Array.isArray(v)) {
+        v.forEach((v2, i) => {
+          try {
+            if (typeof v2 === 'string') v[i] = this.parse(v2)
+          } catch (e) {} // ignore failures
+          this.parseIds(v2)
+        })
+      } else if (typeof v === 'string' && this.isValid(v)) {
+        try {
+          o[k] = this.parse(v)
+        } catch (e) {} // ignore failures
+      }
+    })
+  }
+
+  static isObjectId (data) {
+    return data instanceof ObjectId
+  }
+}
+
+export default ObjectIdUtils

package/lib/typedefs.js

@@ -0,0 +1,63 @@
+/**
+ * This file exists to define the below types for documentation purposes.
+ */
+/**
+ * MongoDB collection
+ * @memberof mongodb
+ * @external MongoDBCollection
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/api/classes/Collection.html}
+ */
+/**
+ * Options passed to the createIndex function
+ * @memberof mongodb
+ * @external MongoDBCreateIndexesOptions
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/CreateIndexesOptions.html}
+ */
+/**
+ * Options passed to the delete functions
+ * @memberof mongodb
+ * @external MongoDBDeleteOptions
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/DeleteOptions.html}
+ */
+/**
+ * Options passed to the findOneAndReplace function
+ * @memberof mongodb
+ * @external MongoDBFindOneAndReplaceOptions
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/FindOneAndReplaceOptions.html}
+ */
+/**
+ * Options passed to the findOneAndUpdate function
+ * @memberof mongodb
+ * @external MongoDBFindOneAndUpdateOptions
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/FindOneAndUpdateOptions.html}
+ */
+/**
+ * Options passed to the find function
+ * @memberof mongodb
+ * @external MongoDBFindOptions
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/FindOptions.html}
+ */
+/**
+ * Options passed to the insertOne function
+ * @memberof mongodb
+ * @external MongoDBInsertOneOptions
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/InsertOneOptions.html}
+ */
+/**
+ * MongoDB client for DB connections
+ * @memberof mongodb
+ * @external MongoDBMongoClient
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/api/MongoClient.html}
+ */
+/**
+ * MongoDB representation of BSON ObjectId type
+ * @memberof mongodb
+ * @external MongoDBObjectId
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/api/ObjectID.html}
+ */
+/**
+ * Options passed to the update function
+ * @memberof mongodb
+ * @external MongoDBUpdateOptions
+ * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/UpdateOptions.html}
+ */

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "adapt-authoring-mongodb",
+  "version": "0.0.1",
+  "description": "Module for saving to a MongoDB instance",
+  "homepage": "https://github.com/adapt-security/adapt-authoring-mongodb",
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "index.js",
+  "repository": "github:adapt-security/adapt-authoring-mongodb",
+  "dependencies": {
+    "mongodb": "^6.7.0"
+  },
+  "peerDependencies": {
+    "adapt-authoring-core": "github:adapt-security/adapt-authoring-core"
+  },
+  "devDependencies": {
+    "eslint": "^9.12.0",
+    "standard": "^17.1.0"
+  }
+}

package/tests/mongoDBModule.spec.js

@@ -0,0 +1,109 @@
+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

@@ -0,0 +1,37 @@
+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();
+    });
+  });
+});