mongodb-ops 0.8.1 → 0.9.0

package/lib/mongodb-ops.js

@@ -114,14 +114,8 @@ class MongoDBOps {
       queryExp = queryExp || {};
       projection = { projection: projection || {} };
 
-      let skip, limit;
-      if (pagination && Number.isInteger(pagination.startIndex) && Number.isInteger(pagination.endIndex)) {
-        if (pagination.endIndex < pagination.startIndex) { return Promise.resolve([]); }
-
-        let startIndex = pagination.startIndex < 1 ? 1 : pagination.startIndex;
-        skip = startIndex - 1;
-        limit = (pagination.endIndex - startIndex + 1) < 0 ? 0 : pagination.endIndex - startIndex + 1;
-      }
+      const { skip, limit } = parsePagination(pagination);
+      if (limit < 1) { return Promise.resolve([]); }
 
       if (isGetCount) { docs = await db.collection(collectionName).countDocuments(queryExp); }
       else if (sort && pagination) { docs = await db.collection(collectionName).find(queryExp, projection).sort(sort).skip(skip).limit(limit).toArray(); }
@@ -151,6 +145,71 @@ class MongoDBOps {
     return Promise.resolve(await MongoDBOps.getData(collectionName, queryExp, isAggregate, projection, sort, pagination, isGetCount, this.connString));
   }
 
+
+  /**
+   * Static method - Use altas search at MongoDB
+   * {@link https://www.mongodb.com/docs/atlas/atlas-search/}
+   * 
+   * @param {string} connString Database connection string
+   * @param {string} collectionName Collection name
+   * @param {object} search $search object - {@link https://www.mongodb.com/docs/atlas/atlas-search/query-syntax/}
+   * @param {object} [obj]
+   * @param {object} [obj.projection] Projection {@link https://docs.mongodb.com/manual/reference/method/db.collection.find/#find-projection}
+   * @param {object} [obj.sort] Sort {@link https://docs.mongodb.com/manual/reference/method/cursor.sort/#cursor.sort}
+   * @param {object} [obj.pagination] Pagination `E.g., { startIndex: 11, endIndex: 20 }`
+   * @param {boolean} [isGetCount=true] Set true to get the number of total matching docs and current page number
+   * @returns {promise} Promise with object or object array
+   */
+  static async search(connString, collectionName, search, { projection, sort, pagination }={}, isGetCount = true) {
+    if ([connString, collectionName, search].includes(undefined)) { return Promise.reject("Connection string, collection name and search cannot be undefined"); }
+
+    const { skip, limit } = parsePagination(pagination);
+    if (limit < 1) { return Promise.resolve([]); }
+
+    const payload = [
+      { $search: search },
+      { $addFields: { score: { $meta: "searchScore" }}},
+    ];
+
+    if (projection) { payload.push({ $project: projection }); }
+    if (sort) { payload.push({ $sort: sort }); }
+
+    const skipLimit = [];
+    if (skip) { skipLimit.push({ $skip: skip }); }
+    if (limit) { skipLimit.push({ $limit: limit }); }
+
+    if (isGetCount) {
+      payload.push({ 
+        $facet: {
+          metadata: [{ $count: "total" }, { $addFields: { page: Math.ceil((skip + 1) / limit) }}],
+          data: skipLimit,
+        }
+      });
+    }
+    else { payload.push(...skipLimit); }
+
+    const result = await MongoDBOps.getData(collectionName, payload, true, undefined, undefined, undefined, undefined, connString);
+
+    return Promise.resolve(isGetCount ? result[0] : result);
+  }
+
+  /**
+   * Instance method - Use altas search at MongoDB
+   * {@link https://www.mongodb.com/docs/atlas/atlas-search/}
+   * 
+   * @param {string} collectionName Collection name
+   * @param {object} search $search object - {@link https://www.mongodb.com/docs/atlas/atlas-search/query-syntax/}
+   * @param {object} [obj]
+   * @param {object} [obj.projection] Projection {@link https://docs.mongodb.com/manual/reference/method/db.collection.find/#find-projection}
+   * @param {object} [obj.sort] Sort {@link https://docs.mongodb.com/manual/reference/method/cursor.sort/#cursor.sort}
+   * @param {object} [obj.pagination] Pagination `E.g., { startIndex: 11, endIndex: 20 }`
+   * @param {boolean} [isGetCount=true] Set true to get the number of total matching docs and current page number
+   * @returns {promise} Promise with object or object array
+   */
+  async search(collectionName, search, { projection, sort, pagination }={}, isGetCount = true) {
+    return Promise.resolve(await MongoDBOps.search(this.connString, collectionName, search, { projection, sort, pagination }, isGetCount));
+  }
+
   /**
    * Static method - Write document to MongoDB
    * 
@@ -289,4 +348,22 @@ class MongoDBOps {
   }
 }
 
-module.exports = MongoDBOps;
+module.exports = MongoDBOps;
+
+/**
+ * Parse the pagaintion and return skip and limit values
+ * 
+ * @param {object} obj
+ * @param {number} [obj.startIndex] Start index
+ * @param {number} [obj.endIndex] Start index
+ * @returns {object} Object with skip and limit values
+ */
+const parsePagination = ({ startIndex, endIndex }={})=> {
+  startIndex = +startIndex; endIndex = +endIndex;
+  startIndex = startIndex < 1 ? 1 : startIndex;
+
+  return {
+    skip: Number.isInteger(startIndex) ? startIndex - 1 : undefined,
+    limit: Number.isInteger(startIndex) && Number.isInteger(endIndex) ? ((endIndex - startIndex + 1) < 0 ? 0 : endIndex - startIndex + 1) : undefined
+  };
+}

package/lib/mongodb-tool-set.js

@@ -86,6 +86,43 @@ class MongoDBToolSet extends MongoDBOps {
     return Promise.resolve(await MongoDBToolSet.getDataCount(this.collectionName, filter, this.connString));
   }
 
+  /**
+   * Static method - List record with optional no. of data counts
+   * 
+   * @param {string} collectionName Collection name
+   * @param {object} [query] Query filter {@link https://docs.mongodb.com/manual/core/document/#document-query-filter}
+   * @param {object} [projection] Projection {@link https://docs.mongodb.com/manual/reference/method/db.collection.find/#find-projection}
+   * @param {object} [sort] Sort filter {@link https://docs.mongodb.com/manual/reference/method/cursor.sort/#cursor.sort} 
+   * @param {object} [pagination] Pagination `E.g., { startIndex: 11, endIndex: 20 }`  
+   * @param {boolean|string} [showCount] Set true to return the data with total_count which is the record count on the data by query
+   * @param {string} connString Database connection string
+   * @returns {promise} Promise with data object or array
+   */
+  static async list(collectionName, query, projection, sort, pagination, showCount, connString) {
+    if (["true", true].includes(showCount)) {
+      const [total_count, data] = await Promise.all([
+        MongoDBToolSet.getDataCount(collectionName, query, connString),
+        MongoDBToolSet.getDataByFilter(collectionName, query, projection, sort, pagination, connString)
+      ]);
+      return Promise.resolve({ total_count, data });
+    }
+    else { return Promise.resolve(await MongoDBToolSet.getDataByFilter(collectionName, query, projection, sort, pagination, connString)); }
+  }
+
+  /**
+   * Instance method - List record with optional no. of data counts
+   * 
+   * @param {object} [query] Query filter {@link https://docs.mongodb.com/manual/core/document/#document-query-filter}
+   * @param {object} [projection] Projection {@link https://docs.mongodb.com/manual/reference/method/db.collection.find/#find-projection}
+   * @param {object} [sort] Sort filter {@link https://docs.mongodb.com/manual/reference/method/cursor.sort/#cursor.sort} 
+   * @param {object} [pagination] Pagination `E.g., { startIndex: 11, endIndex: 20 }`  
+   * @param {boolean|string} [showCount=false] Set true to return the data with total_count which is the record count on the data by query
+   * @returns {promise} Promise with data count
+   */
+  async list(query, projection, sort, pagination, showCount) {
+    return Promise.resolve(await MongoDBToolSet.list(this.collectionName, query, projection, sort, pagination, showCount, this.connString));
+  }
+
   /**
    * Static method - Get all data
    * 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb-ops",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Read and write ops for MongoDB",
   "main": "index.js",
   "scripts": {