Merge pull request #7 from contentstack/sync_api

Merged Sync_api branch with master

Author: rohitmishra209

.gitignore

@@ -5,4 +5,5 @@ node_modules/*
 reports/*
 apidocs-templates/*
 test/smtpconfig.js
-test/config.js
+test/config.js
+test/sync_config.js

README.md

@@ -168,6 +168,66 @@ Following are Image Delivery API examples.
         'height': 100
     }) 
 
+### Using the Sync API with JavaScript SDK
+
+The Sync API takes care of syncing your Contentstack data with your app and ensures that the data is always up-to-date by providing delta updates. Contentstack’s JavaScript SDK supports Sync API, which you can use to build powerful apps. Read through to understand how to use the Sync API with Contentstack JavaScript SDK.
+[Read Sync API documentation](https://docs.google.com/document/d/14IFRlmtOja5OPzlK1Q6DxW3auISEQNhX6opMYJcHVsI/). 
+
+##### Initial sync
+
+The Initial Sync process performs a complete sync of your app data. It returns all the published entries and assets of the specified stack in response.
+
+To start the Initial Sync process, use the syncStack method.
+        
+        let data = Stack.sync({"init": true})
+        data.then(function(sync_data, err) {
+            //error for any error description
+            //sync_data.items: contains sync data
+            //sync_data.paginationToken: for fetching the next batch of entries using pagination token
+            //sync_token.syncToken: for performing subsequent sync after initial sync
+            if (err) throw err
+        })
+
+The response also contains a sync token, which you need to store, since this token is used to get subsequent delta updates later, as shown in the Subsequent Sync section below. 
+
+You can also fetch custom results in initial sync by using advanced sync queries. 
+
+
+##### Sync pagination
+
+If the result of the initial sync (or subsequent sync) contains more than 100 records, the response would be paginated. It provides pagination token in the response. You will need to use this token to get the next batch of data. 
+
+        
+        let data = Stack.sync({"pagination_token" : "<pagination_token>"})
+        data.then(function(result,  err) {
+            //error for any error description
+            //result.items: contains sync data
+            //result.paginationToken: For fetching the next batch of entries using pagination token
+            //result.syncToken: For performing subsequent sync after initial sync
+            if(err) throw err    
+        })
+
+##### Subsequent sync
+
+You can use the sync token (that you receive after initial sync) to get the updated content next time. The sync token fetches only the content that was added after your last sync, and the details of the content that was deleted or updated.
+
+    
+        let data = Stack.sync({"sync_token" :  “<sync_token>”})
+        data.then(function(sync_data,  err) {
+            //error for any error description
+            //sync_data.items: contains sync data
+            //sync_data.paginationToken: for fetching the next batch of entries using pagination token
+            //sync_token.syncToken: for performing subsequent sync after initial sync
+            if(err) throw err
+        })
+
+##### Advanced sync queries
+
+You can use advanced sync queries to fetch custom results while performing initial sync. 
+[Read advanced sync queries documentation](https://www.contentstack.com/docs/guide/synchronization/using-the-sync-api-with-javascript-sdk#advanced-sync-queries)
+
+
+
 ### Helpful Links
 
 - [Contentstack Website](https://www.contentstack.com) 

config.js

@@ -4,6 +4,7 @@ const config = {
     port: 443,
     version: "v3",
     urls: {
+        sync: "/stacks/sync",
         content_types: "/content_types/",
         entries: "/entries/",
         assets: "/assets/",

dist/nativescript/contentstack.js

@@ -270,6 +270,8 @@ function resultWrapper(result) {
         result.entry = (0, _result2.default)(result.entry);
     } else if (result && typeof result.asset !== 'undefined') {
         result.asset = (0, _result2.default)(result.asset);
+    } else if (result && typeof result.items !== 'undefined') {
+        result.items = (0, _result2.default)(result.items).toJSON();
     }
 
     return result;
@@ -285,11 +287,13 @@ function spreadResult(result) {
         if (typeof result.count !== 'undefined') _results.push(result.count);
         if (typeof result.entry !== 'undefined') _results = result.entry;
         if (typeof result.asset !== 'undefined') _results = result.asset;
+        if (typeof result.items !== 'undefined') _results.push(result);
     }
     return _results;
 };
 
 function sendRequest(queryObject) {
+
     var env_uid = queryObject.environment_uid;
     if (env_uid) {
         queryObject._query.environment_uid = env_uid;
@@ -341,6 +345,7 @@ function sendRequest(queryObject) {
                 try {
                     self.entry_uid = self.asset_uid = self.tojson = self.queryCachePolicy = undefined;
                     var entries = {};
+                    var syncstack = {};
                     if (queryObject.singleEntry) {
                         queryObject.singleEntry = false;
                         if (data.schema) entries.schema = data.schema;
@@ -360,9 +365,17 @@ function sendRequest(queryObject) {
                             }
                             return;
                         }
+                    } else if (data.items) {
+                        syncstack = {
+                            items: data.items,
+                            pagination_token: data.pagination_token,
+                            sync_token: data.sync_token,
+                            total_count: data.total_count
+                        };
                     } else {
                         entries = data;
                     }
+
                     if (cachePolicy !== -1) {
                         self.provider.set(hashQuery, entries, function (err) {
                             try {
@@ -374,10 +387,14 @@ function sendRequest(queryObject) {
                             }
                         });
                         return resolve(spreadResult(entries));
-                    } else {
-                        if (!tojson) entries = resultWrapper(entries);
-                        return resolve(spreadResult(entries));
                     }
+
+                    if (Object.keys(syncstack).length) {
+                        return resolve(syncstack);
+                    }
+
+                    if (!tojson) entries = resultWrapper(entries);
+                    return resolve(spreadResult(entries));
                 } catch (e) {
                     return reject({
                         message: e.message
@@ -498,6 +515,8 @@ Object.defineProperty(exports, "__esModule", {
 var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+/*import Sync from './modules/sync';*/
+
 
 var _config = __webpack_require__(7);
 
@@ -548,6 +567,7 @@ var Stack = function () {
         this.config = _config2.default;
         this.cachePolicy = _index2.default.policies.IGNORE_CACHE;
         this.provider = _index2.default.providers('localstorage');
+        //this.sync_cdn_api_key = stack_arguments[0].sync_cdn_api_key;
 
         for (var _len = arguments.length, stack_arguments = Array(_len), _key = 0; _key < _len; _key++) {
             stack_arguments[_key] = arguments[_key];
@@ -832,6 +852,44 @@ var Stack = function () {
             return (0, _request2.default)(query);
         }
 
+        /**
+         * @method sync
+         * @description The Sync API takes care of syncing your Contentstack data with your app and ensures that the data is always up-to-date by providing delta updates. Contentstack’s iOS SDK supports Sync API, which you can use to build powerful apps. Read through to understand how to use the Sync API with Contentstack JavaScript SDK.
+         * @param {object} params - params is an object which Supports locale, start_date, content_type_id queries.
+         * @example 
+         * Stack.sync({'init': true})        // For initializing sync
+         * @example 
+         * Stack.sync({'init': true, 'locale': 'en-us'})     //For initializing sync with entries of a specific locale
+         * @example 
+         * Stack.sync({'init': true, 'start_date': '2018-10-22'})    //For initializing sync with entries published after a specific date
+         * @example 
+         * Stack.sync({'init': true, 'content_type_id': 'session'})   //For initializing sync with entries of a specific content type
+         * @example 
+         * Stack.sync({'init': true, 'type': 'entry_published'})   //Use the type parameter to get a specific type of content.Supports 'asset_published', 'entry_published', 'asset_unpublished', 'entry_unpublished', 'asset_deleted', 'entry_deleted', 'content_type_deleted'.
+         * @example 
+         * Stack.sync({'pagination_token': '<btlsomething>'})    // For fetching the next batch of entries using pagination token
+         * @example 
+         * Stack.sync({'sync_token': '<btlsomething>'})    // For performing subsequent sync after initial sync
+         * @returns {object}
+         */
+
+    }, {
+        key: 'sync',
+        value: function sync(params) {
+            this._query = {};
+            this._query = Object.assign(this._query, params);
+            this.requestParams = {
+                method: 'POST',
+                headers: this.headers,
+                url: this.config.protocol + "://" + this.config.host + ':' + this.config.port + '/' + this.config.version + this.config.urls.sync,
+                body: {
+                    _method: 'GET',
+                    query: this._query
+                }
+            };
+            return Utils.sendRequest(this);
+        }
+
         /**
          * @method imageTransform
          * @description Transforms provided image url based on transformation parameters.  
@@ -894,7 +952,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }
 
 //JS SDK version
-var version = '3.4.0';
+var version = '3.4.1';
+var environment = void 0,
+    api_key = void 0;
 
 function Request(options) {
     return new Promise(function (resolve, reject) {
@@ -1326,6 +1386,7 @@ var Entry = function () {
                         query: this._query
                     }
                 };
+
                 return Utils.sendRequest(this);
             } else {
                 console.error("Kindly provide an entry uid. e.g. .Entry('bltsomething123')");
@@ -1915,6 +1976,7 @@ var config = {
     port: 443,
     version: "v3",
     urls: {
+        sync: "/stacks/sync",
         content_types: "/content_types/",
         entries: "/entries/",
         assets: "/assets/",