test cases updated, 80% coverage achieved

Author: iyerrama29

README.md

@@ -1,9 +1,9 @@
 [![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
-## Contentstack sync Mongodb SDK
+## Contentstack Sync Mongodb SDK
 
 Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/). 
 
-(Contentstack sync utility)[] provides Mongodb SDK to query applications that have locally strored contents in mongodb. Given below is the detailed guide and helpful resources to get started with Mongodb SDK.
+[Contentstack sync utility](https://www.contentstack.com/docs/tools-and-frameworks) provides Mongodb SDK to query applications that have locally strored contents in mongodb. Given below is the detailed guide and helpful resources to get started with Mongodb SDK.
 
 ### Prerequisite
 
@@ -14,30 +14,33 @@ Contentstack is a headless CMS with an API-first approach. It is a CMS that deve
 
 To import the SDK in your project, use the following command:
 ```js
-  const Contentstack = require ('contentstack-sync-mongodb-sdk)
+  import { Contentstack } from 'contentstack-sync-mongodb-sdk'
 ```
 
 To initialize the SDK, you'd need to perform the following steps
 
 1. Initialize stack instance.
 ```js
-  const Stack = contentstack.Stack(config)
+  const Stack = Contentstack.Stack(config)
 ```
-2. Call the connect method. The connect method connects the SDK to the database. Call this, before running SDK queries
+
+2. Call the connect method. This method establishes a connection between the SDK and mongodb database.
 ```js
   Stack.connect(dbConfig)
-    .then()
-    .catch()
+    .then(fnResolve)
+    .catch(fnReject)
 ```
+> Important: You need to call this, before running SDK queries!
+
 Once you have initialized the SDK, you can start querying on the sync-utility's DB's
 
 ### Querying
 
-Notes
-- By default, 'content_type_uid' and 'locale' keys as part of the response.
-- If `.language()` is not provided, then the 1st language, provided in config would be considered.
-- If querying for a single entry/asset (using `.entry()` OR `.findOne()`), the result will be an object i.e. `{ entry: {} }`, if the entry or asset is not found, `{ entry: null }` will be returned.
-- Querying multiple entries, would return `{ entries: [ {...} ] }`.
+- Notes
+  - By default, 'content_type_uid' and 'locale' keys as part of the response.
+  - If `.language()` is not provided, then the 1st language, provided in `config.locales` would be considered.
+  - If querying for a single entry/asset (using `.entry()` OR `.findOne()`), the result will be an object i.e. `{ entry: {} }`, if the entry or asset is not found, `{ entry: null }` will be returned.
+  - Querying multiple entries, would return `{ entries: [ {...} ] }`.
 
 
 1. Query a single entry
@@ -58,9 +61,11 @@ Notes
       //   locale: ''
       // }
     })
+    .catch(reject)
+
   // Sample 2. Returns the 1st entry that matches query filters
   Stack.contentType('blogs')
-    .entries() // OR .assets()
+    .entries() // for .assets() OR .schemas() - ignore calling .contentType()
     .language('en-us')
     .findOne()
     .then((result) => {
@@ -73,15 +78,13 @@ Notes
       //   locale: ''
       // }
     })
-    .catch()
+    .catch(reject)
 ```
 
-2. Querying a set of entries or assets
-
+2. Querying a set of entries, assets or content types
 ```js
   Stack.contentType('blogs')
-    .entries()
-    .includeContentType()
+    .entries() // for .assets() OR .schemas() - ignore calling .contentType()
     .includeCount()
     .find()
     .then((result) => {
@@ -92,14 +95,11 @@ Notes
       //       title: ''
       //     }
       //   ],
-      //   content_type: {
-      //     title: 'Blogs',
-      //     ...
-      //   },
       //   content_type_uid: 'blogs',
       //   locale: '',
       //   count: 1
       // }
     })
-    .catch()
-```
+    .catch(reject)
+```
+For more details on queries supported/querying, [refer this](./mongodb-sdk-querying.md)!

dist/stack.js

@@ -446,12 +446,20 @@ class Stack {
             throw new Error('Kindly provide a valid field and expr/fn value for \'.where()\'');
         }
         else if (this.q.query && typeof this.q.query === 'object') {
+            if (typeof expr === 'function') {
+                expr = expr.toString();
+            }
             this.q.query = lodash_1.merge(this.q.query, {
                 $where: expr,
             });
         }
         else {
-            this.q.query.$where = expr;
+            if (typeof expr === 'function') {
+                expr = expr.toString();
+            }
+            this.q.query = {
+                $where: expr,
+            };
         }
         return this;
     }
@@ -535,9 +543,6 @@ class Stack {
         return new Promise((resolve, reject) => {
             const queryFilters = this.preProcess(query);
             this.collection = this.collection.find(queryFilters);
-            if (this.internal.sort) {
-                this.collection = this.collection.sort(this.internal.sort);
-            }
             if (this.internal.queryReferences) {
                 return this.collection
                     .project(this.internal.projections)
@@ -546,6 +551,7 @@ class Stack {
                     if (result === null || result.length === 0) {
                         return resolve({ count: 0 });
                     }
+                    this.internal.includeReferences = true;
                     return this.includeReferencesI(result, this.q.locale, {}, undefined)
                         .then(() => {
                         result = sift_1.default(this.internal.queryReferences, result);

dist/util.js

@@ -6,9 +6,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const lodash_1 = require("lodash");
-exports.append = (field) => {
-    return `data.${field}`;
-};
 exports.validateURI = (uri) => {
     if (typeof uri !== 'string' || uri.length === 0) {
         throw new Error(`Mongodb connection url: ${uri} must be of type string`);
@@ -37,25 +34,3 @@ const getParents = (child, mapping) => {
     }
     return parents;
 };
-exports.mask = (json, filter) => {
-    filter.forEach((field) => {
-        maskKeys(json, field.split('.'), 0);
-    });
-};
-const maskKeys = (json, arr, pos) => {
-    const key = arr[pos];
-    if (json.hasOwnProperty(key)) {
-        if (pos === arr.length - 1) {
-            delete json[key];
-        }
-        else {
-            pos++;
-            maskKeys(json[key], arr, pos);
-        }
-    }
-    else if (typeof json === 'object' && json instanceof Array && json.length) {
-        json.forEach((sub) => {
-            maskKeys(sub, arr, pos);
-        });
-    }
-};

example/random.js

@@ -14,7 +14,7 @@ const Stack = Contentstack.Stack({
     }
   ],
   dbName: 'sync-test',
-  collectionName: 'references'
+  collectionName: 'count'
 })
 
 Stack.connect({collectionName: 'logical'}).then(() => {
@@ -26,13 +26,18 @@ Stack.connect({collectionName: 'logical'}).then(() => {
   //   .catch(console.error)
   Stack.contentType('blog')
     .entries()
-    .includeReferences()
+    // .includeReferences()
+    // .where(function () {
+    //   return (this.no === 1)
+    // })
+    .queryReferences({'authors.uid': 'a10'})
     // .only(['published_at'])
     // .except(['published_at'])
     // .ascending()
     // .descending()
     // .and([{uid: 'b1'}, {no: 1}])
-    .find()
+    // .find()
+    .count()
     .then(console.log)
     .catch(console.error)
 })