@agility/content-sync 1.0.3 → 1.0.4

package/README.md

@@ -12,10 +12,11 @@ By keeping a local cache of your content, your web app can access content faster
 
 ## Use Cases
 1. You want to reduce the amount of REST API calls made to your Agility CMS instance.
-2. You want so synchronize content from the CMS to another system such Redis Cache
-3. You are running a **Server-Side Rendered (SSR)** web app and you want to cache your content locally, reducing latency for retrieving content.
-4. You are using a **Static Site Generator (SSG)** and you don't want to have to re-source all of your content on each build.
-5. You have a client-side **Single Page Application**, and want to cache content in local storage in the browser.
+2. You have a client-side Single Page Application, and want to cache content in local storage in the browser.
+3. You want so synchronize content from the CMS to another system such Redis Cache
+4. You are running a **Server-Side Rendered (SSR)** web app and you want to cache your content locally, reducing latency for retrieving content.
+5. You are using a **Static Site Generator (SSG)** and you don't want to have to re-source all of your content on each build.
+6. You have a client-side **Single Page Application**, and want to cache content in local storage in the browser.
 
 ## How it Works
 This Sync SDK uses the Sync API `getSyncPages` and `getSyncContent` found in our [Agility CMS Content Fetch JS SDK](https://agilitydocs.netlify.com/agility-content-fetch-js-sdk/) and aims to abstract some of the complexities involved in managing synced content.
@@ -58,32 +59,6 @@ npm install @agility/content-sync
     ```
     `runSync()` will pull down all your *Sitemap*, *Pages*, and *Content* and store them in your local filesystem under the default path `.agility-files`.
 
-## Sync using a Custom Store
-While this SDK provides a filesystem sync interface by default, you can change this and use another one or create your own.
-```javascript
-import agilitySync from '@agility/constent-sync'
-import aSampleSyncConsoleInterface from './store-interface-console'
-const syncClient = agilitySync.getSyncClient({
-    //your 'guid' from Agility CMS
-    guid: 'some-guid',
-    //your 'apiKey' from Agility CMS
-    apiKey: 'some-api-key',
-    //the language(s) of content you want to source
-    languages: ['en-us'],
-    //your channel(s) for the pages you want to source
-    channels: ['website'],
-    //your custom storage/access interface
-    store: {
-        //must be the interface used to store and access content
-        interface: aSampleSyncConsoleInterface,
-        //any options/config that you want to pass along to your interface as an argument 'options'
-        options: {}
-    }
-});
-//start the sync process
-syncClient.runSync();
-```
-
 ## Accessing Content
 Once content is in your sync store, you can easily access it as you need it:
 ```javascript
@@ -121,32 +96,106 @@ await syncClient.clearSync();
 ```
 
 ## How to Create your Own Sync Store
-Create a new `.js` file which exports the following methods:
+While this SDK provides a filesystem sync interface by default, you can change this and use another one or create your own.
+1. Create a new `.js` file which exports the following methods:
 ```javascript
-exports.saveItem = async ({ options, item, itemType, languageCode, itemID }) => {
+/**
+ * The function to handle saving/updating an item to your storage. This could be a Content Item, Page, Url Redirections, Sync State (state), or Sitemap.
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {Object} params.item - The object representing the Content Item, Page, Url Redirections, Sync State (state), or Sitemap that needs to be saved/updated
+ * @param {String} params.itemType - The type of item being saved/updated, expected values are `item`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
+ * @param {String} params.languageCode - The locale code associated to the item being saved/updated
+ * @param {(String|Number)} params.itemID - The ID of the item being saved/updated - this could be a string or number depending on the itemType
+ * @returns {Void}
+ */
+const saveItem = async ({ options, item, itemType, languageCode, itemID }) => {
     console.log(`Console Interface: saveItem has been called`);
     return null;
 }
-
-exports.deleteItem = async ({ options, itemType, languageCode, itemID }) => {
+/**
+ * The function to handle deleting an item to your storage. This could be a Content Item, Page, Url Redirections, Sync State (state), or Sitemap.
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {String} params.itemType - The type of item being deleted, expected values are `item`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
+ * @param {String} params.languageCode - The locale code associated to the item being saved/updated
+ * @param {(String|Number)} params.itemID - The ID of the item being deleted - this could be a string or number depending on the itemType
+ * @returns {Void}
+ */
+const deleteItem = async ({ options, itemType, languageCode, itemID }) => {
     console.log(`Console Interface: deleteItem has been called`);
     return null;
 }
-
-exports.mergeItemToList = async ({ options, item, languageCode, itemID, referenceName, definitionName }) => {
+/**
+ * The function to handle updating and placing a Content Item into a "list" so that you can handle querying a collection of items.
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {Object} params.item - The object representing the Content Item
+ * @param {String} params.languageCode - The locale code associated to the item being saved/updated 
+ * @param {(String|Number)} params.itemID - The ID of the item being updated - this could be a string or number depending on the itemType
+ * @param {String} params.referenceName - The reference name of the Content List that this Content Item should be added to
+ * @param {String} params.definitionName - The Model name that the Content Item is based on
+ * @returns {Void}
+ */
+const mergeItemToList = async ({ options, item, languageCode, itemID, referenceName, definitionName }) => {
 	console.log(`Console Interface: mergeItemToList has been called`);
     return null;
 }
-
-exports.getItem = async ({ options, itemType, languageCode, itemID }) => {
+/**
+ * The function to handle retrieving a Content Item, Page, Url Redirections, Sync State (state), or Sitemap
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {String} params.itemType - The type of item being accessed, expected values are `item`, `list`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
+ * @param {String} params.languageCode - The locale code associated to the item being accessed
+ * @param {(String|Number)} params.itemID - The ID of the item being accessed - this could be a string or number depending on the itemType
+ * @returns {Object}
+ */
+const getItem = async ({ options, itemType, languageCode, itemID }) => {
     console.log(`Console Interface: getItem has been called`)
     return null;
 }
-
-exports.clearItems = async ({ options }) => {
+/**
+ * The function to handle clearing the cache of synchronized data from the CMS
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @returns {Void}
+ */
+const clearItems = async ({ options }) => {
     console.log(`Console Interface: clearItem has been called`)
     return null;
 }
+
+module.exports = {
+    saveItem,
+    deleteItem,
+    mergeItemToList,
+    getItem,
+    clearItems
+}
+```
+2. Register the `syncClient` to use your **Sync Store**
+```javascript
+import agilitySync from '@agility/constent-sync'
+import sampleSyncConsoleInterface from './store-interface-console'
+const syncClient = agilitySync.getSyncClient({
+    //your 'guid' from Agility CMS
+    guid: 'some-guid',
+    //your 'apiKey' from Agility CMS
+    apiKey: 'some-api-key',
+    //the language(s) of content you want to source
+    languages: ['en-us'],
+    //your channel(s) for the pages you want to source
+    channels: ['website'],
+    //your custom storage/access interface
+    store: {
+        //must be the interface used to store and access content
+        interface: sampleSyncConsoleInterface,
+        //any options/config that you want to pass along to your interface as an argument 'options'
+        options: {}
+    }
+});
+//start the sync process
+syncClient.runSync();
 ```
 
 

package/dist/agility-sync-sdk.node.js

@@ -9277,14 +9277,18 @@ __webpack_require__(29).config({
   path: ".env.".concat("production") });
 
 
-
-var getFilePath = function getFilePath(_ref) {var options = _ref.options,itemType = _ref.itemType,languageCode = _ref.languageCode,itemID = _ref.itemID;
-  var fileName = "".concat(itemID, ".json");
-
-  return path.join(options.rootPath, languageCode, itemType, fileName);
-};
-
-var saveItem = /*#__PURE__*/function () {var _ref3 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(_ref2) {var options, item, itemType, languageCode, itemID, filePath, dirPath, json;return regeneratorRuntime.wrap(function _callee$(_context) {while (1) {switch (_context.prev = _context.next) {case 0:options = _ref2.options, item = _ref2.item, itemType = _ref2.itemType, languageCode = _ref2.languageCode, itemID = _ref2.itemID;
+/**
+ * The function to handle saving/updating an item to your storage. This could be a Content Item, Page, Url Redirections, Sync State (state), or Sitemap.
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {String} params.options.rootPath - The path to store/access the content as JSON 
+ * @param {Object} params.item - The object representing the Content Item, Page, Url Redirections, Sync State (state), or Sitemap that needs to be saved/updated
+ * @param {String} params.itemType - The type of item being saved/updated, expected values are `item`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
+ * @param {String} params.languageCode - The locale code associated to the item being saved/updated
+ * @param {(String|Number)} params.itemID - The ID of the item being saved/updated - this could be a string or number depending on the itemType
+ * @returns {Void}
+ */
+var saveItem = /*#__PURE__*/function () {var _ref2 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(_ref) {var options, item, itemType, languageCode, itemID, filePath, dirPath, json;return regeneratorRuntime.wrap(function _callee$(_context) {while (1) {switch (_context.prev = _context.next) {case 0:options = _ref.options, item = _ref.item, itemType = _ref.itemType, languageCode = _ref.languageCode, itemID = _ref.itemID;
 
             filePath = getFilePath({ options: options, itemType: itemType, languageCode: languageCode, itemID: itemID });
 
@@ -9296,78 +9300,110 @@ var saveItem = /*#__PURE__*/function () {var _ref3 = _asyncToGenerator( /*#__PUR
             }
 
             json = JSON.stringify(item);
-            fs.writeFileSync(filePath, json);case 6:case "end":return _context.stop();}}}, _callee);}));return function saveItem(_x) {return _ref3.apply(this, arguments);};}();
-
+            fs.writeFileSync(filePath, json);case 6:case "end":return _context.stop();}}}, _callee);}));return function saveItem(_x) {return _ref2.apply(this, arguments);};}();
 
-var deleteItem = /*#__PURE__*/function () {var _ref5 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2(_ref4) {var options, itemType, languageCode, itemID, filePath;return regeneratorRuntime.wrap(function _callee2$(_context2) {while (1) {switch (_context2.prev = _context2.next) {case 0:options = _ref4.options, itemType = _ref4.itemType, languageCode = _ref4.languageCode, itemID = _ref4.itemID;
+/**
+ * The function to handle deleting an item to your storage. This could be a Content Item, Page, Url Redirections, Sync State (state), or Sitemap.
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {String} params.options.rootPath - The path to store/access the content as JSON 
+ * @param {String} params.itemType - The type of item being deleted, expected values are `item`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
+ * @param {String} params.languageCode - The locale code associated to the item being saved/updated
+ * @param {(String|Number)} params.itemID - The ID of the item being deleted - this could be a string or number depending on the itemType
+ * @returns {Void}
+ */
+var deleteItem = /*#__PURE__*/function () {var _ref4 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2(_ref3) {var options, itemType, languageCode, itemID, filePath;return regeneratorRuntime.wrap(function _callee2$(_context2) {while (1) {switch (_context2.prev = _context2.next) {case 0:options = _ref3.options, itemType = _ref3.itemType, languageCode = _ref3.languageCode, itemID = _ref3.itemID;
 
             filePath = getFilePath({ options: options, itemType: itemType, languageCode: languageCode, itemID: itemID });
 
             if (fs.existsSync(filePath)) {
               fs.unlinkSync(filePath);
-            }case 3:case "end":return _context2.stop();}}}, _callee2);}));return function deleteItem(_x2) {return _ref5.apply(this, arguments);};}();
-
+            }case 3:case "end":return _context2.stop();}}}, _callee2);}));return function deleteItem(_x2) {return _ref4.apply(this, arguments);};}();
 
 
-var mergeItemToList = /*#__PURE__*/function () {var _ref7 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3(_ref6) {var options, item, languageCode, itemID, referenceName, definitionName, contentList, cIndex;return regeneratorRuntime.wrap(function _callee3$(_context3) {while (1) {switch (_context3.prev = _context3.next) {case 0:options = _ref6.options, item = _ref6.item, languageCode = _ref6.languageCode, itemID = _ref6.itemID, referenceName = _ref6.referenceName, definitionName = _ref6.definitionName;_context3.next = 3;return (
+/**
+ * The function to handle updating and placing a Content Item into a "list" so that you can handle querying a collection of items.
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {String} params.options.rootPath - The path to store/access the content as JSON 
+ * @param {Object} params.item - The object representing the Content Item
+ * @param {String} params.languageCode - The locale code associated to the item being saved/updated 
+ * @param {(String|Number)} params.itemID - The ID of the item being updated - this could be a string or number depending on the itemType
+ * @param {String} params.referenceName - The reference name of the Content List that this Content Item should be added to
+ * @param {String} params.definitionName - The Model name that the Content Item is based on
+ * @returns {Void}
+ */
+var mergeItemToList = /*#__PURE__*/function () {var _ref6 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3(_ref5) {var options, item, languageCode, itemID, referenceName, definitionName, contentList, cIndex;return regeneratorRuntime.wrap(function _callee3$(_context3) {while (1) {switch (_context3.prev = _context3.next) {case 0:options = _ref5.options, item = _ref5.item, languageCode = _ref5.languageCode, itemID = _ref5.itemID, referenceName = _ref5.referenceName, definitionName = _ref5.definitionName;_context3.next = 3;return (
 
               getItem({ options: options, itemType: "list", languageCode: languageCode, itemID: referenceName }));case 3:contentList = _context3.sent;
 
             if (contentList == null) {
               //initialize the list
-              contentList = [];
-            }
-
-
-            //replace the item...
-            cIndex = contentList.findIndex(function (ci) {
-              return ci.contentID === itemID;
-            });
-
-            if (item.properties.state === 3) {
-              //*** deleted item (remove from the list) ***
-              if (cIndex >= 0) {
-                //remove the item
-                contentList.splice(cIndex, 1);
-              }
-
+              contentList = [item];
             } else {
-              //*** regular item (merge) ***
-              if (cIndex >= 0) {
-                //replace the existing item
-                contentList[cIndex] = item;
+              //replace the item...
+              cIndex = contentList.findIndex(function (ci) {
+                return ci.contentID === itemID;
+              });
+
+              if (item.properties.state === 3) {
+                //*** deleted item (remove from the list) ***
+                if (cIndex >= 0) {
+                  //remove the item
+                  contentList.splice(cIndex, 1);
+                }
+
               } else {
-                //and it to the end of the
-                contentList.push(item);
+                //*** regular item (merge) ***
+                if (cIndex >= 0) {
+                  //replace the existing item
+                  contentList[cIndex] = item;
+                } else {
+                  //and it to the end of the
+                  contentList.push(item);
+                }
               }
+            }_context3.next = 7;return (
 
-            }_context3.next = 9;return (
+              saveItem({ options: options, item: contentList, itemType: "list", languageCode: languageCode, itemID: referenceName }));case 7:case "end":return _context3.stop();}}}, _callee3);}));return function mergeItemToList(_x3) {return _ref6.apply(this, arguments);};}();
 
-              saveItem({ options: options, item: contentList, itemType: "list", languageCode: languageCode, itemID: referenceName }));case 9:case "end":return _context3.stop();}}}, _callee3);}));return function mergeItemToList(_x3) {return _ref7.apply(this, arguments);};}();
-
-
-var getItem = /*#__PURE__*/function () {var _ref9 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4(_ref8) {var options, itemType, languageCode, itemID, filePath, json;return regeneratorRuntime.wrap(function _callee4$(_context4) {while (1) {switch (_context4.prev = _context4.next) {case 0:options = _ref8.options, itemType = _ref8.itemType, languageCode = _ref8.languageCode, itemID = _ref8.itemID;
+/**
+ * The function to handle retrieving a Content Item, Page, Url Redirections, Sync State (state), or Sitemap
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {String} params.options.rootPath - The path to store/access the content as JSON 
+ * @param {String} params.itemType - The type of item being accessed, expected values are `item`, `list`, `page`, `sitemap`, `nestedsitemap`, `state`, `urlredirections`
+ * @param {String} params.languageCode - The locale code associated to the item being accessed
+ * @param {(String|Number)} params.itemID - The ID of the item being accessed - this could be a string or number depending on the itemType
+ * @returns {Object}
+ */
+var getItem = /*#__PURE__*/function () {var _ref8 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4(_ref7) {var options, itemType, languageCode, itemID, filePath, json;return regeneratorRuntime.wrap(function _callee4$(_context4) {while (1) {switch (_context4.prev = _context4.next) {case 0:options = _ref7.options, itemType = _ref7.itemType, languageCode = _ref7.languageCode, itemID = _ref7.itemID;
             filePath = getFilePath({ options: options, itemType: itemType, languageCode: languageCode, itemID: itemID });if (
 
             fs.existsSync(filePath)) {_context4.next = 4;break;}return _context4.abrupt("return", null);case 4:
 
             json = fs.readFileSync(filePath, 'utf8');return _context4.abrupt("return",
-            JSON.parse(json));case 6:case "end":return _context4.stop();}}}, _callee4);}));return function getItem(_x4) {return _ref9.apply(this, arguments);};}();
-
-
-var clearItems = /*#__PURE__*/function () {var _ref11 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5(_ref10) {var options;return regeneratorRuntime.wrap(function _callee5$(_context5) {while (1) {switch (_context5.prev = _context5.next) {case 0:options = _ref10.options;
-            fs.rmdirSync(options.rootPath, { recursive: true });case 2:case "end":return _context5.stop();}}}, _callee5);}));return function clearItems(_x5) {return _ref11.apply(this, arguments);};}();
+            JSON.parse(json));case 6:case "end":return _context4.stop();}}}, _callee4);}));return function getItem(_x4) {return _ref8.apply(this, arguments);};}();
 
 
-var waitOnLock = /*#__PURE__*/function () {var _ref12 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee6(lockFile) {return regeneratorRuntime.wrap(function _callee6$(_context6) {while (1) {switch (_context6.prev = _context6.next) {case 0:_context6.next = 2;return (
-
-              check(lockFile));case 2:if (!_context6.sent) {_context6.next = 7;break;}_context6.next = 5;return (
-              sleep(100));case 5:_context6.next = 0;break;case 7:case "end":return _context6.stop();}}}, _callee6);}));return function waitOnLock(_x6) {return _ref12.apply(this, arguments);};}();
+/**
+ * The function to handle clearing the cache of synchronized data from the CMS
+ * @param {Object} params - The parameters object
+ * @param {Object} params.options - A flexible object that can contain any properties specifically related to this interface
+ * @param {String} params.options.rootPath - The path to store/access the content as JSON 
+ * @returns {Void}
+ */
+var clearItems = /*#__PURE__*/function () {var _ref10 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5(_ref9) {var options;return regeneratorRuntime.wrap(function _callee5$(_context5) {while (1) {switch (_context5.prev = _context5.next) {case 0:options = _ref9.options;
+            fs.rmdirSync(options.rootPath, { recursive: true });case 2:case "end":return _context5.stop();}}}, _callee5);}));return function clearItems(_x5) {return _ref10.apply(this, arguments);};}();
 
 
 
 
-var mutexLock = /*#__PURE__*/function () {var _ref13 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee7() {var dir, lockFile;return regeneratorRuntime.wrap(function _callee7$(_context7) {while (1) {switch (_context7.prev = _context7.next) {case 0:
+/**
+ * The function to handle multi-threaded Syncs that may be happening at the same time. If you need to prevent a sync from happening and let it wait until another sync has finished use this.
+ * @returns {Promise}
+ */
+var mutexLock = /*#__PURE__*/function () {var _ref11 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee6() {var dir, lockFile;return regeneratorRuntime.wrap(function _callee6$(_context6) {while (1) {switch (_context6.prev = _context6.next) {case 0:
 
 
             dir = os.tmpdir();
@@ -9377,38 +9413,49 @@ var mutexLock = /*#__PURE__*/function () {var _ref13 = _asyncToGenerator( /*#__P
             }
 
             //THE LOCK IS ALREADY HELD - WAIT UP!
-            _context7.next = 5;return waitOnLock(lockFile);case 5:_context7.prev = 5;return _context7.abrupt("return",
+            _context6.next = 5;return waitOnLock(lockFile);case 5:_context6.prev = 5;return _context6.abrupt("return",
 
 
-            lockSync(lockFile));case 9:_context7.prev = 9;_context7.t0 = _context7["catch"](5);if (!(
+            lockSync(lockFile));case 9:_context6.prev = 9;_context6.t0 = _context6["catch"](5);if (!(
 
-            "".concat(_context7.t0).indexOf("Lock file is already being held") !== -1)) {_context7.next = 28;break;}_context7.next = 14;return (
+            "".concat(_context6.t0).indexOf("Lock file is already being held") !== -1)) {_context6.next = 28;break;}_context6.next = 14;return (
 
 
-              sleep(100));case 14:_context7.next = 16;return (
-              waitOnLock(lockFile));case 16:_context7.prev = 16;return _context7.abrupt("return",
+              sleep(100));case 14:_context6.next = 16;return (
+              waitOnLock(lockFile));case 16:_context6.prev = 16;return _context6.abrupt("return",
 
 
-            lockSync(lockFile));case 20:_context7.prev = 20;_context7.t1 = _context7["catch"](16);if (!(
+            lockSync(lockFile));case 20:_context6.prev = 20;_context6.t1 = _context6["catch"](16);if (!(
 
-            "".concat(_context7.t0).indexOf("Lock file is already being held") !== -1)) {_context7.next = 28;break;}_context7.next = 25;return (
+            "".concat(_context6.t0).indexOf("Lock file is already being held") !== -1)) {_context6.next = 28;break;}_context6.next = 25;return (
 
 
-              sleep(100));case 25:_context7.next = 27;return (
-              waitOnLock(lockFile));case 27:return _context7.abrupt("return",
+              sleep(100));case 25:_context6.next = 27;return (
+              waitOnLock(lockFile));case 27:return _context6.abrupt("return",
             lockSync(lockFile));case 28:throw (
 
 
 
 
-              Error("The mutex lock could not be obtained."));case 29:case "end":return _context7.stop();}}}, _callee7, null, [[5, 9], [16, 20]]);}));return function mutexLock() {return _ref13.apply(this, arguments);};}();
+              Error("The mutex lock could not be obtained."));case 29:case "end":return _context6.stop();}}}, _callee6, null, [[5, 9], [16, 20]]);}));return function mutexLock() {return _ref11.apply(this, arguments);};}();
+
 
 
 
 
+//private function to get a wait on a lock file
+var waitOnLock = /*#__PURE__*/function () {var _ref12 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee7(lockFile) {return regeneratorRuntime.wrap(function _callee7$(_context7) {while (1) {switch (_context7.prev = _context7.next) {case 0:_context7.next = 2;return (
+              check(lockFile));case 2:if (!_context7.sent) {_context7.next = 7;break;}_context7.next = 5;return (
+              sleep(100));case 5:_context7.next = 0;break;case 7:case "end":return _context7.stop();}}}, _callee7);}));return function waitOnLock(_x6) {return _ref12.apply(this, arguments);};}();
 
 
 
+//private function to get path of an item
+var getFilePath = function getFilePath(_ref13) {var options = _ref13.options,itemType = _ref13.itemType,languageCode = _ref13.languageCode,itemID = _ref13.itemID;
+  var fileName = "".concat(itemID, ".json");
+  return path.join(options.rootPath, languageCode, itemType, fileName);
+};
+
 
 module.exports = {
   saveItem: saveItem,
@@ -11179,7 +11226,7 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {try
             //if the api is being updated, wait a few ms and try again...
             waitMS += waitIntervalMS;if (!(
             waitMS > waitMaxMS)) {_context.next = 15;break;}
-            Object(util["logWarning"])("Sync API has been busy for too long, canceling.");return _context.abrupt("break", 33);case 15:
+            Object(util["logWarning"])("Sync API has been busy for too long, canceling.");return _context.abrupt("break", 36);case 15:
 
 
 
@@ -11189,7 +11236,7 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {try
               Object(util["logInfo"])("Sync API is busy.  Waiting...");
             }_context.next = 18;return (
 
-              Object(util["sleep"])(waitIntervalMS));case 18:return _context.abrupt("continue", 32);case 19:
+              Object(util["sleep"])(waitIntervalMS));case 18:return _context.abrupt("continue", 35);case 19:
 
 
 
@@ -11202,18 +11249,22 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {try
             syncItems = syncRet.items;
 
             //if we don't get anything back, kick out
-            if (!(syncItems.length === 0)) {_context.next = 23;break;}return _context.abrupt("break", 33);case 23:
+            if (!(syncItems.length > 0)) {_context.next = 29;break;}
+
+            index = 0;case 23:if (!(index < syncItems.length)) {_context.next = 29;break;}_context.next = 26;return (
+              storeInterface.saveContentItem({ contentItem: syncItems[index], languageCode: languageCode }));case 26:index++;_context.next = 23;break;case 29:if (!(
+
 
 
+            syncRet.syncToken > token)) {_context.next = 33;break;}
+            token = syncRet.syncToken;_context.next = 34;break;case 33:return _context.abrupt("break", 36);case 34:
 
-            index = 0;case 24:if (!(index < syncItems.length)) {_context.next = 30;break;}_context.next = 27;return (
-              storeInterface.saveContentItem({ contentItem: syncItems[index], languageCode: languageCode }));case 27:index++;_context.next = 24;break;case 30:
 
 
-            token = syncRet.syncToken;
-            itemCount += syncItems.length;case 32:if (
 
-            token > 0 || busy === true) {_context.next = 7;break;}case 33:
+            itemCount += syncItems.length;case 35:if (
+
+            token > 0 || busy === true) {_context.next = 7;break;}case 36:
 
             if (itemCount > 0) {
               Object(util["logInfo"])("Content Sync returned ".concat(itemCount, " item(s)."));
@@ -11221,7 +11272,7 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {try
               Object(util["logInfo"])("Content Sync returned no item(s).");
             }return _context.abrupt("return",
 
-            token);case 35:case "end":return _context.stop();}}}, _callee, this);}));return syncContent_ref.apply(this, arguments);}
+            token);case 38:case "end":return _context.stop();}}}, _callee, this);}));return syncContent_ref.apply(this, arguments);}
 // CONCATENATED MODULE: ./src/methods/clearSync.js
 function clearSync_asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {try {var info = gen[key](arg);var value = info.value;} catch (error) {reject(error);return;}if (info.done) {resolve(value);} else {Promise.resolve(value).then(_next, _throw);}}function clearSync_asyncToGenerator(fn) {return function () {var self = this,args = arguments;return new Promise(function (resolve, reject) {var gen = fn.apply(self, args);function _next(value) {clearSync_asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);}function _throw(err) {clearSync_asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);}_next(undefined);});};}
 
@@ -11257,7 +11308,7 @@ function syncPages_asyncGeneratorStep(gen, resolve, reject, _next, _throw, key,
             //if the api is being updated, wait a few ms and try again...
             waitMS += waitIntervalMS;if (!(
             waitMS > waitMaxMS)) {_context.next = 15;break;}
-            Object(util["logWarning"])("Sync API has been busy for too long, canceling.");return _context.abrupt("break", 33);case 15:
+            Object(util["logWarning"])("Sync API has been busy for too long, canceling.");return _context.abrupt("break", 36);case 15:
 
 
 
@@ -11266,7 +11317,7 @@ function syncPages_asyncGeneratorStep(gen, resolve, reject, _next, _throw, key,
               Object(util["logInfo"])("Sync API is busy.  Waiting...");
             }_context.next = 18;return (
 
-              Object(util["sleep"])(waitIntervalMS));case 18:return _context.abrupt("continue", 32);case 19:
+              Object(util["sleep"])(waitIntervalMS));case 18:return _context.abrupt("continue", 35);case 19:
 
 
 
@@ -11278,20 +11329,25 @@ function syncPages_asyncGeneratorStep(gen, resolve, reject, _next, _throw, key,
 
             syncItems = syncRet.items;
 
-            //if we don't get anything back, kick out
-            if (!(syncItems.length === 0)) {_context.next = 23;break;}return _context.abrupt("break", 33);case 23:
+            //if we have something...
+            if (!(syncItems.length > 0)) {_context.next = 29;break;}
+
+
+            index = 0;case 23:if (!(index < syncItems.length)) {_context.next = 29;break;}_context.next = 26;return (
+              storeInterface.savePageItem({ pageItem: syncItems[index], languageCode: languageCode }));case 26:index++;_context.next = 23;break;case 29:if (!(
+
+
 
+            syncRet.syncToken > token)) {_context.next = 33;break;}
+            token = syncRet.syncToken;_context.next = 34;break;case 33:return _context.abrupt("break", 36);case 34:
 
 
-            index = 0;case 24:if (!(index < syncItems.length)) {_context.next = 30;break;}_context.next = 27;return (
-              storeInterface.savePageItem({ pageItem: syncItems[index], languageCode: languageCode }));case 27:index++;_context.next = 24;break;case 30:
 
 
-            token = syncRet.syncToken;
-            itemCount += syncItems.length;case 32:if (
+            itemCount += syncItems.length;case 35:if (
 
 
-            token > 0 || busy === true) {_context.next = 7;break;}case 33:
+            token > 0 || busy === true) {_context.next = 7;break;}case 36:
 
             if (itemCount > 0) {
               Object(util["logInfo"])("Page Sync returned ".concat(itemCount, " item(s)."));
@@ -11300,7 +11356,7 @@ function syncPages_asyncGeneratorStep(gen, resolve, reject, _next, _throw, key,
             }return _context.abrupt("return",
 
 
-            token);case 35:case "end":return _context.stop();}}}, _callee, this);}));return syncPages_ref.apply(this, arguments);}
+            token);case 38:case "end":return _context.stop();}}}, _callee, this);}));return syncPages_ref.apply(this, arguments);}
 // CONCATENATED MODULE: ./src/methods/runSync.js
 function _createForOfIteratorHelper(o, allowArrayLike) {var it;if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) {if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") {if (it) o = it;var i = 0;var F = function F() {};return { s: F, n: function n() {if (i >= o.length) return { done: true };return { done: false, value: o[i++] };}, e: function e(_e) {throw _e;}, f: F };}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}var normalCompletion = true,didErr = false,err;return { s: function s() {it = o[Symbol.iterator]();}, n: function n() {var step = it.next();normalCompletion = step.done;return step;}, e: function e(_e2) {didErr = true;err = _e2;}, f: function f() {try {if (!normalCompletion && it["return"] != null) it["return"]();} finally {if (didErr) throw err;}} };}function _unsupportedIterableToArray(o, minLen) {if (!o) return;if (typeof o === "string") return _arrayLikeToArray(o, minLen);var n = Object.prototype.toString.call(o).slice(8, -1);if (n === "Object" && o.constructor) n = o.constructor.name;if (n === "Map" || n === "Set") return Array.from(o);if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);}function _arrayLikeToArray(arr, len) {if (len == null || len > arr.length) len = arr.length;for (var i = 0, arr2 = new Array(len); i < len; i++) {arr2[i] = arr[i];}return arr2;}function runSync_asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {try {var info = gen[key](arg);var value = info.value;} catch (error) {reject(error);return;}if (info.done) {resolve(value);} else {Promise.resolve(value).then(_next, _throw);}}function runSync_asyncToGenerator(fn) {return function () {var self = this,args = arguments;return new Promise(function (resolve, reject) {var gen = fn.apply(self, args);function _next(value) {runSync_asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);}function _throw(err) {runSync_asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);}_next(undefined);});};}
 
@@ -11465,7 +11521,7 @@ var saveContentItem = /*#__PURE__*/function () {var _ref2 = store_interface_asyn
             definitionName = sanitizeName(contentItem.properties.definitionName);
             referenceName = contentItem.properties.referenceName;if (!(
 
-            contentItem.properties.state === 3)) {_context.next = 15;break;}_context.next = 9;return (
+            contentItem.properties.state === 3)) {_context.next = 17;break;}_context.next = 9;return (
 
 
 
@@ -11473,27 +11529,26 @@ var saveContentItem = /*#__PURE__*/function () {var _ref2 = store_interface_asyn
                 options: options,
                 itemType: "item",
                 languageCode: languageCode,
-                itemID: contentItem.contentID }));case 9:currentItem = _context.sent;
+                itemID: contentItem.contentID }));case 9:currentItem = _context.sent;if (!
 
+            currentItem) {_context.next = 15;break;}
 
-            if (currentItem) {
-              //if the item is deleted, we need to grab the def and ref name from the current
-              definitionName = sanitizeName(currentItem.properties.definitionName);
-              referenceName = currentItem.properties.referenceName;
-            }_context.next = 13;return (
+            //if the item is deleted, we need to grab the def and ref name from the current
+            definitionName = sanitizeName(currentItem.properties.definitionName);
+            referenceName = currentItem.properties.referenceName;_context.next = 15;return (
 
               store_interface_store.deleteItem({
                 options: options,
                 itemType: "item",
                 languageCode: languageCode,
-                itemID: contentItem.contentID }));case 13:_context.next = 20;break;case 15:if (!(
+                itemID: contentItem.contentID }));case 15:_context.next = 22;break;case 17:if (!(
 
 
 
 
             !contentItem.properties.definitionName ||
-            !contentItem.properties.referenceName)) {_context.next = 18;break;}
-            Object(util["logWarning"])("Content with id ".concat(contentItem.contentID, " does not have the neccessary properties to be saved."));return _context.abrupt("return");case 18:_context.next = 20;return (
+            !contentItem.properties.referenceName)) {_context.next = 20;break;}
+            Object(util["logWarning"])("Content with id ".concat(contentItem.contentID, " does not have the neccessary properties to be saved."));return _context.abrupt("return");case 20:_context.next = 22;return (
 
 
 
@@ -11504,11 +11559,11 @@ var saveContentItem = /*#__PURE__*/function () {var _ref2 = store_interface_asyn
                 item: contentItem,
                 itemType: "item",
                 languageCode: languageCode,
-                itemID: contentItem.contentID }));case 20:if (!
+                itemID: contentItem.contentID }));case 22:if (!
 
 
 
-            referenceName) {_context.next = 23;break;}_context.next = 23;return (
+            referenceName) {_context.next = 25;break;}_context.next = 25;return (
 
               store_interface_store.mergeItemToList({
                 options: options,
@@ -11516,7 +11571,7 @@ var saveContentItem = /*#__PURE__*/function () {var _ref2 = store_interface_asyn
                 languageCode: languageCode,
                 itemID: contentItem.contentID,
                 referenceName: referenceName,
-                definitionName: definitionName }));case 23:case "end":return _context.stop();}}}, _callee);}));return function saveContentItem(_x) {return _ref2.apply(this, arguments);};}();
+                definitionName: definitionName }));case 25:case "end":return _context.stop();}}}, _callee);}));return function saveContentItem(_x) {return _ref2.apply(this, arguments);};}();