@agility/content-sync 1.0.0 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agility/content-sync",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "JavaScript SDK for synchronizing content from Agility CMS",
   "main": "dist/agility-sync-sdk.node.js",
   "scripts": {
@@ -15,9 +15,9 @@
   "author": "Agility CMS",
   "license": "MIT",
   "contributors": [
-	  "Joel Varty",
-	  "James Vidler",
-	  "Joshua Isaac"
+    "Joel Varty",
+    "James Vidler",
+    "Joshua Isaac"
   ],
   "bugs": {
     "url": "https://github.com/agility/agility-sync-sdk/issues"
@@ -26,7 +26,7 @@
   "dependencies": {
     "@agility/content-fetch": "^1.0.0",
     "dotenv": "^8.2.0",
-    "proper-lockfile": "^4.1.1"
+    "proper-lockfile": "^4.1.2"
   },
   "devDependencies": {
     "@babel/cli": "^7.2.3",

package/src/methods/syncContent.js

@@ -53,15 +53,19 @@ export default async function (languageCode, token) {
 		const syncItems = syncRet.items;
 
 		//if we don't get anything back, kick out
-		if (syncItems.length === 0) {
-			break;
+		if (syncItems.length > 0 ) {
+
+			for (let index = 0; index < syncItems.length; index++) {
+				await storeInterface.saveContentItem({ contentItem: syncItems[index], languageCode });
+			}
 		}
 
-		for (let index = 0; index < syncItems.length; index++) {
-			await storeInterface.saveContentItem({ contentItem: syncItems[index], languageCode });
+		if (syncRet.syncToken > token) {
+			token = syncRet.syncToken;
+		} else {
+			break;
 		}
 
-		token = syncRet.syncToken;
 		itemCount += syncItems.length;
 
 	} while (token > 0 || busy === true)

package/src/methods/syncPages.js

@@ -1,7 +1,7 @@
 import { logInfo, logWarning, sleep } from '../util'
 
 export default async function (languageCode, token) {
-    const storeInterface = this.store;
+	const storeInterface = this.store;
 	if (!token) token = 0;
 
 	let itemCount = 0;
@@ -29,7 +29,7 @@ export default async function (languageCode, token) {
 				break
 			}
 
-			if (! busy) {
+			if (!busy) {
 				busy = true
 				logInfo("Sync API is busy.  Waiting...")
 			}
@@ -46,16 +46,21 @@ export default async function (languageCode, token) {
 
 		const syncItems = syncRet.items;
 
-		//if we don't get anything back, kick out
-		if (syncItems.length === 0) {
-			break;
+		//if we have something...
+		if (syncItems.length > 0) {
+
+
+			for (let index = 0; index < syncItems.length; index++) {
+				await storeInterface.savePageItem({ pageItem: syncItems[index], languageCode });
+			}
 		}
 
-		for (let index = 0; index < syncItems.length; index++) {
-			await storeInterface.savePageItem({ pageItem: syncItems[index], languageCode });
+		if (syncRet.syncToken > token) {
+			token = syncRet.syncToken;
+		} else {
+			break;
 		}
 
-		token = syncRet.syncToken;
 		itemCount += syncItems.length;
 
 

package/src/store-interface-console.js

@@ -1,23 +1,64 @@
+/**
+ * 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;
 }
-
+/**
+ * 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;
 }
-
+/**
+ * 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;
 }
-
+/**
+ * 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;
 }
-
+/**
+ * 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;

package/src/store-interface-filesystem.js

@@ -9,13 +9,17 @@ require("dotenv").config({
 	path: `.env.${process.env.NODE_ENV}`,
 })
 
-
-const getFilePath = ({ options, itemType, languageCode, itemID }) => {
-	const fileName = `${itemID}.json`;
-
-	return path.join(options.rootPath, languageCode, itemType, fileName);
-}
-
+/**
+ * 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}
+ */
 const saveItem = async ({ options, item, itemType, languageCode, itemID }) => {
 
 	let filePath = getFilePath({ options, itemType, languageCode, itemID });
@@ -30,7 +34,16 @@ const saveItem = async ({ options, item, itemType, languageCode, itemID }) => {
 	let json = JSON.stringify(item);
 	fs.writeFileSync(filePath, json);
 }
-
+/**
+ * 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}
+ */
 const deleteItem = async ({ options, itemType, languageCode, itemID }) => {
 
 	let filePath = getFilePath({ options, itemType, languageCode, itemID });
@@ -40,7 +53,18 @@ const deleteItem = async ({ options, itemType, languageCode, itemID }) => {
 	}
 
 }
-
+/**
+ * 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}
+ */
 const mergeItemToList = async ({ options, item, languageCode, itemID, referenceName, definitionName }) => {
 
 	let contentList = await getItem({ options, itemType: "list", languageCode, itemID: referenceName });
@@ -75,7 +99,16 @@ const mergeItemToList = async ({ options, item, languageCode, itemID, referenceN
 
 	await saveItem({ options, item: contentList, itemType: "list", languageCode, itemID: referenceName });
 }
-
+/**
+ * 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}
+ */
 const getItem = async ({ options, itemType, languageCode, itemID }) => {
 	let filePath = getFilePath({ options, itemType, languageCode, itemID });
 
@@ -85,18 +118,23 @@ const getItem = async ({ options, itemType, languageCode, itemID }) => {
 	return JSON.parse(json);
 }
 
+/**
+ * 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}
+ */
 const clearItems = async ({ options }) => {
 	fs.rmdirSync(options.rootPath, { recursive: true })
 }
 
-const waitOnLock = async (lockFile) => {
 
-	while (await check(lockFile)) {
-		await sleep(100)
-	}
-
-}
 
+/**
+ * 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}
+ */
 const mutexLock = async () => {
 
 
@@ -137,7 +175,18 @@ const mutexLock = async () => {
 }
 
 
+//private function to get a wait on a lock file
+const waitOnLock = async (lockFile) => {
+	while (await check(lockFile)) {
+		await sleep(100)
+	}
+}
 
+//private function to get path of an item
+const getFilePath = ({ options, itemType, languageCode, itemID }) => {
+	const fileName = `${itemID}.json`;
+	return path.join(options.rootPath, languageCode, itemType, fileName);
+}
 
 
 module.exports = {