adapt-authoring-mongodb 0.0.1 → 1.0.0

package/.eslintignore

@@ -1 +1 @@
-node_modules
+node_modules

package/.eslintrc

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

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,55 +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
+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/feature_request.yml

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

@@ -1,11 +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"
+# 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

@@ -1,25 +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)
-
-
+[//]: # (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

@@ -1,16 +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 }}
+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

@@ -1,19 +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 }}
+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/.github/workflows/releases.yml

@@ -0,0 +1,25 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 'lts/*'
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.AAT_NPM_TOKEN }}
+        run: npx semantic-release

package/adapt-authoring.json

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

package/conf/config.schema.json

@@ -1,16 +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"]
-}
+{
+  "$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

@@ -1,66 +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 */)
-```
-
+# 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

@@ -1,43 +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
-  }
+{
+  "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

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