picker-db 3.5.0 → 3.6.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## v3.6.0
+### Added
+* Mongo Atlas Connection: Added configuration for connection with MongoAtlas database

package/lib/Mongo/index.js

@@ -1,3 +1,5 @@
+require("./typedef");
+
 const mongoose = require("mongoose");
 const _ = require("lodash");
 
@@ -9,18 +11,7 @@ const logger = require("../Logger");
 class MongoDB {
   /**
    * Sets up the configuration for the mongo connection
-   * @param {object} config
-   * @param {string} config.dbName
-   * @param {boolean} [config.isLoggingEnabled]
-   * @param {boolean} [config.isDebugEnabled]
-   * @param {object} config.auth
-   * @param {string} config.auth.username
-   * @param {string} config.auth.password
-   * @param {string} [config.auth.host]
-   * @param {string} [config.auth.port]
-   * @param {string} [config.auth.environment]
-   * @param {boolean} [config.useMongoClient]
-   * @param {boolean} [config.useUnifiedTopology]
+   * @param {MongoConfig} config
    */
   constructor (config = {}) {
     this.config = _.defaults(
@@ -45,15 +36,15 @@ class MongoDB {
 
   /**
    * Returns connection uri based on environment
-   * @param {object} auth
-   * @param {string} auth.username
-   * @param {string} auth.password
-   * @param {string} [auth.host]
-   * @param {string} [auth.port]
+   * @param {MongoAuth} auth
+   * @returns {string}
    */
   getUri (auth) {
     let uri = "";
     switch (auth.environment) {
+      case "atlas":
+        uri = auth.dbUri;
+        break;
       case "local":
         uri = `mongodb://${auth.host}:${auth.port}/${this.config.dbName}`;
         break;

package/lib/Mongo/typedef.js

@@ -0,0 +1,19 @@
+/**
+ * @typedef MongoConfig
+ * @property {string} dbName
+ * @property {boolean} [isLoggingEnabled]
+ * @property {boolean} [isDebugEnabled]
+ * @property {boolean} [useMongoClient]
+ * @property {boolean} [useUnifiedTopology]
+ * @property {MongoAuth} auth
+ */
+
+/**
+ * @typedef MongoAuth
+ * @property {string} [environment]
+ * @property {string} [username]
+ * @property {string} [password]
+ * @property {string} [host]
+ * @property {string} [port]
+ * @property {string} [dbUri]
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "picker-db",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "Picker DB services",
   "main": "index.js",
   "scripts": {