added test cases

Author: iyerrama29

dist/stack.js

@@ -8,13 +8,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const debug_1 = __importDefault(require("debug"));
 const lodash_1 = require("lodash");
 const mongodb_1 = require("mongodb");
 const sift_1 = __importDefault(require("sift"));
 const config_1 = require("./config");
 const util_1 = require("./util");
-const debug = debug_1.default('stack');
 class Stack {
     constructor(stackConfig, existingDB) {
         this.config = lodash_1.merge(config_1.config, stackConfig);
@@ -68,7 +66,6 @@ class Stack {
                 this.client = client;
                 return client.connect().then(() => {
                     this.db = client.db(dbName);
-                    debug('Db connection set successfully!');
                     return resolve(this.db);
                 }).catch(reject);
             }
@@ -78,7 +75,6 @@ class Stack {
         });
     }
     close() {
-        debug('Closing db connection!');
         this.client.close();
     }
     language(code) {
@@ -381,7 +377,7 @@ class Stack {
         });
         return this;
     }
-    regex(field, pattern, options = 'g') {
+    regex(field, pattern, options = 'i') {
         if (!(field) || !(pattern) || typeof field !== 'string' || typeof pattern !== 'string') {
             throw new Error('Kindly provide a valid field and pattern value for \'.regex()\'');
         }
@@ -424,7 +420,7 @@ class Stack {
         }
         return this;
     }
-    where(...expr) {
+    where(expr) {
         if (!(expr)) {
             throw new Error('Kindly provide a valid field and expr/fn value for \'.where()\'');
         }
@@ -438,10 +434,6 @@ class Stack {
         }
         return this;
     }
-    count() {
-        this.collection = this.collection.count();
-        return this;
-    }
     includeCount() {
         this.internal.includeCount = true;
         return this;
@@ -511,6 +503,45 @@ class Stack {
             });
         });
     }
+    count(query) {
+        return new Promise((resolve, reject) => {
+            const queryFilters = this.preProcess(query);
+            if (this.internal.queryReferences) {
+                return this.collection
+                    .find(queryFilters)
+                    .project(this.internal.projections)
+                    .toArray()
+                    .then((result) => {
+                    if (result === null || result.length === 0) {
+                        return resolve({ count: 0 });
+                    }
+                    return this.includeReferencesI(result, this.q.locale, {}, undefined)
+                        .then(() => {
+                        result = sift_1.default(this.internal.queryReferences, result);
+                        result = result.length;
+                        this.cleanup();
+                        return resolve({ count: result });
+                    });
+                })
+                    .catch((error) => {
+                    this.cleanup();
+                    return reject(error);
+                });
+            }
+            return this.collection
+                .find(queryFilters)
+                .project(this.internal.projections)
+                .count()
+                .then((result) => {
+                this.cleanup();
+                return resolve({ count: result });
+            })
+                .catch((error) => {
+                this.cleanup();
+                return reject(error);
+            });
+        });
+    }
     findOne(query = {}) {
         return new Promise((resolve, reject) => {
             this.internal.single = true;
@@ -573,7 +604,6 @@ class Stack {
             this.q.locale = this.config.locales[0].code;
         }
         if (this.q.content_type_uid === 'contentTypes') {
-            debug('Removing \'locale\' filter, since the query is on content types');
             delete this.q.locale;
         }
         const filters = Object.assign({ content_type_uid: this.q.content_type_uid, locale: this.q.locale }, this.q.query);
@@ -598,8 +628,8 @@ class Stack {
     }
     cleanup() {
         this.collection = null;
-        this.internal = {};
-        this.q = {};
+        this.internal = null;
+        this.q = null;
     }
     postProcess(result, contentType) {
         const count = (result === null) ? 0 : result.length;

example/count.js

@@ -0,0 +1,85 @@
+const Contentstack = require('../dist/contentstack').Contentstack
+
+const Stack = Contentstack.Stack({
+  api_key: '',
+  access_token: '',
+  locales: [
+    {
+      code: 'en-us',
+      relative_url_prefix: '/'
+    },
+    {
+      code: 'es-es',
+      relative_url_prefix: '/es/'
+    }
+  ],
+})
+
+function connect () {
+  return new Promise((resolve, reject) => {
+    return Stack.connect()
+      .then(resolve)
+      .catch(reject)
+  })
+}
+
+function close () {
+  return Stack.close()
+}
+
+function count (contentType = 'blog') {
+  return new Promise((resolve, reject) => {
+    Stack.contentType(contentType)
+      .entries()
+      // .includeCount()
+      // .includeReferences()
+      // .queryReferences({'authors.category': {}})
+      // .includeSchema()
+      // .language('es-es')
+      // .notEqualTo('title', 'Blog One')
+      // .query({tags: {$in: ['one', 'two']}})
+      .queryReferences({'authors.category.uid': 'c2'})
+      // .excludeReferences()
+      // .excludeAssets()
+      // .limit(1)
+      // .skip(1)
+      // .query({
+      //   uid: 'blt17559b99fee73d6f'
+      // })
+      .count()
+      .then(resolve)
+      .catch(reject)
+  })
+}
+
+return connect()
+  .then(() => {
+    return count()
+      .then((result) => {
+        const keys = Object.keys(result)
+        // Sample output
+        // {
+        //   entries: [
+        //     {
+        //       title: 'French author',
+        //       gender: null,
+        //       age: null,
+        //       summary: '',
+        //       tags: [
+                
+        //       ],
+        //       locale: 'es-es',
+        //       uid: 'blt17559b99fee73d6f'
+        //     }
+        //   ],
+        //   content_type_uid: 'authors',
+        //   locale: 'es-es'
+        // }
+        console.log(JSON.stringify(result, null, 1))
+      })
+  })
+  .then(close)
+  .then(() => {
+    console.info('Data received successfully!')
+  })
+  .catch(console.error)

example/index.js

@@ -33,7 +33,7 @@ function find (contentType = 'blog') {
       .entries()
       // .includeCount()
       .includeReferences()
-      .queryReferences({'authors.category': {}})
+      // .queryReferences({'authors.category': {}})
       // .includeSchema()
       // .language('es-es')
       // .notEqualTo('title', 'Blog One')

mongodb-fs-sdk.info.md

@@ -0,0 +1,78 @@
+- .connect()
+New method
+Use this method, to connect with the DB
+
+- .close()
+New method
+This method closes the connection with the DB (mongodb-sdk-specific)
+
+- .entry(uid?)
+Method functionality updated
+Pass entry `uid` that you'd want to find. If the uid is not provided, returns the 1st element found in that content type
+Returns `{ entry: { ... } }` OR `{ entry: null }`
+
+- .entries()
+New method
+Used for querying all entries in the `.contentType({{ uid }})` specified
+Note: Call `.contentType({{ uid }})` before calling this method
+
+- .asset(uid?)
+Method functionality updated
+Pass asset `uid` that you'd want to find. If the uid is not provided, returns the 1st element found in assets
+Returns `{ asset: { ... } }` OR `{ asssets: null }`
+Note: No need to call `.contentType({{ uid }})` while calling this
+
+- .assets()
+New method
+Used for querying all assets
+Note: No need to call `.contentType({{ uid }})` while calling this
+
+- .schema(uid?)
+New method
+Method functionality updated
+Pass asset `uid` that you'd want to find. If the uid is not provided, returns the 1st element found in content type schemas
+Returns `{ content_type: { ... } }` OR `{ content_type: null }`
+Note: No need to call `.contentType({{ uid }})` while calling this
+
+- .schemas()
+New method
+Used for querying all the content type schemas
+Note: No need to call `.contentType({{ uid }})` while calling this
+
+- .regex(field, pattern, options?)
+Implementation updated
+Options field is now optional, by default, it will become `i` i.e. case insensitivity match
+Ref. https://docs.mongodb.com/manual/reference/operator/query/regex/
+
+- .where(expr)
+Implementation updated
+Accepts an expression, instead of 'field' and 'value'
+Ref. https://docs.mongodb.com/manual/reference/operator/query/where/index.html
+
+- .count()
+New method
+Returns only the count of the query filters fired
+
+- .includeReferences()
+New method
+Returns all entries and their references
+
+- .excludeReferences()
+New method
+Returns all entries, without any references
+Note: Since assets are considered as references, they'll not be evaluated
+
+- .queryReferences(query)
+New method
+Accepts a query object, which can be used to query on the reference fields
+Note: This is a slow method, since it scans all documents and fires the `reference` query on them. Use `.query()` filters to reduce the total no of documents being scanned
+
+- .find()
+Implementation updated
+Can be used for `.assets()`, `.assets()`, `.entry()`, `.entries()`, `.schema()` and `.schemas()`
+By default, if assets are in 'published' state, their json will be attached in entries. Else, the file fields will be either `null` OR `[]`
+
+- .findOne()
+Implementation updated
+Can be used for `.assets()`, `.assets()`, `.entry()`, `.entries()`, `.schema()` and `.schemas()`
+By default, if assets are in 'published' state, their json will be attached in entries. Else, the file fields will be either `null` OR `{}`