backup

Author: iyerrama29

README.md

@@ -1,22 +1,69 @@
 [![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
-## Contentstack Sync Mongodb SDK
 
-The Contentstack sync utility lets you sync your Contentstack data on your server, enabling you to save data locally and serve content directly from your server.
+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/).
 
-The Cotentstack mongodb content store library is part of Contentstack sync utility's content storage drivers and is used to store data in the MongoDB database and [contentstack-sync-mongodb-sdk]() library is used to query data stored there.
+## Contentstack DataSync MongoDB SDK
 
-Learn how Contentstack helps you store your data locally with the help of the Contentstack sync utility [here]().
-
-Currently, Contentstack offers the following databases for storing the synced data:
-- Filesystem data store: [contentstack-content-store-filesystem](https://github.com/contentstack/contentstack-content-store-filesystem) used to store data in your system's filesystem. You can use filesystem SDK [contentstack-sync-filesystem-sdk]((https://github.com/contentstack/contentstack-sync-filesystem-sdk) to query data from filesystem.
-- Filesystem asset store: [contentstack-asset-store-filesystem](https://github.com/contentstack/contentstack-asset-store-filesystem)
-- Mongodb data store: [contentstack-content-store-mongodb](https://github.com/contentstack/contentstack-content-store-mongodb) used to store data in your MongoDB. You can use MongoDB SDK [contentstack-sync-mongodb-sdk]((https://github.com/contentstack/contentstack-sync-mongodb-sdk) to query data from mongodb.
+[Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync) provides MongoDB SDK to query applications that have locally stored contents in mongodb. Given below is the detailed guide and helpful resources to get started.
 
 ### Prerequisite
 
 - nodejs, v8+
-- Data synced via mongodb content store
 - MongoDB, v3.6 or higher
+- You should have the data synced through [Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync) 
+
+### Configuration
+
+|Property|Data Type|Default value|Description|
+|--|--|--|--|
+|dbName|string|contentstack-persistent-db|**Optional** The MongoDB database name|
+|collectionName|string|contents|**Optional** MongoDB database's collection name|
+|uri|string|mongodb://localhost:27017 |**Optional.** The MongoDB connection URI|
+| indexes | object |**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** Option to create db indexes via configuration|
+|projections|object|**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** Mongodb projections. Keys provided here would be displayed/filtered out when fetching the result|
+|options|object|**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** MongoDB connection options [Ref.](http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html) for more info|
+|limit|number|**Optional.** Caps the total no of objects returned in a single call|
+|skip|number|**Optional.** Number of objects skipped before the result is returned|
+
+### Detailed configs
+
+By default, this module uses the following internal configuration.
+
+```js
+{
+  dbName: 'contentstack-persistent-db',
+  collectionName: 'contents',
+  uri: 'mongodb://localhost:27017',
+  indexes: {
+    published_at: -1,
+    content_type_uid: 1,
+    locale: 1,
+    uid: 1
+  },
+  limit: 100,
+  locales: [
+  ],
+  options: {
+    autoReconnect: true,
+    connectTimeoutMS: 15000,
+    keepAlive: true,
+    noDelay: true,
+    reconnectInterval: 1000,
+    reconnectTries: 20,
+    useNewUrlParser: true,
+  },
+  projections: {
+    _id: 0,
+    _version: 0,
+    content_type_uid: 0,
+    created_at: 0,
+    sys_keys: 0,
+    updated_at: 0,
+    updated_by: 0,
+  },
+  skip: 0,
+}
+```
 
 ### Setup and Installation
 
@@ -110,4 +157,22 @@ Once you have initialized the SDK, you can start querying on the sync-utility's
     })
     .catch(reject)
 ```
-For more details on queries supported/querying, [refer this](./mongodb-sdk-querying.md)!
+
+## Advanced Queries
+
+In order to learn more about advance queries please refer the API documentation, [here](https://contentstack.github.io/datasync-mongodb-sdk/).
+
+### Further Reading
+
+- [Getting started with Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync)    
+- [Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync/configuration-files-for-contentstack-datasync) doc lists the configuration for different modules
+
+### Support and Feature requests
+
+If you have any issues working with the library, please file an issue [here](https://github.com/contentstack/datasync-content-store-mongodb/issues) at Github.
+
+You can send us an e-mail at [[email protected]](mailto:[email protected]) if you have any support or feature requests. Our support team is available 24/7 on the intercom. You can always get in touch and give us an opportunity to serve you better!
+
+### License
+
+This repository is published under the [MIT license](LICENSE).

dist/config.js

@@ -10,12 +10,14 @@ exports.config = {
         collectionName: 'contents',
         dbName: 'contentstack-persistent-db',
         indexes: {
+            published_at: -1,
             content_type_uid: 1,
             locale: 1,
             uid: 1
         },
         limit: 100,
         locales: [],
+        // http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html
         options: {
             autoReconnect: true,
             connectTimeoutMS: 15000,

dist/index.js

@@ -6,7 +6,31 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const stack_1 = require("./stack");
+/**
+ * @class Stack
+ * @description Initialize an instance of `Stack`
+ * @api public
+ * @example
+ * const Stack = Contentstack.Stack({
+ *  contentStore: {
+ *    baseDir: '../../dev-contents'
+ *  },
+ *  locales: [
+ *    {
+ *      code: 'en-us',
+ *      relative_url_prefix: '/'
+ *    }
+ *  ]
+ * })
+ *
+ * @returns {Stack}
+ */
 class Contentstack {
+    /**
+     * @summary
+     * 	Initialize Stack instance
+     * @param {Object} stack_arguments - Stack config
+     */
     static Stack(config, db) {
         return new stack_1.Stack(config, db);
     }