@agility/content-sync 1.1.4 → 1.1.6

package/src/store-interface-console.js

@@ -1,73 +1,73 @@
-/**
- * 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;
-}
-
-module.exports = {
-    saveItem,
-    deleteItem,
-    mergeItemToList,
-    getItem,
-    clearItems
+/**
+ * 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;
+}
+
+module.exports = {
+    saveItem,
+    deleteItem,
+    mergeItemToList,
+    getItem,
+    clearItems
 }

package/src/store-interface-filesystem.js

@@ -1,202 +1,202 @@
-const fs = require('fs')
-const os = require('os')
-const path = require('path')
-const {sleep} = require("./util")
-const { lockSync, unlockSync, checkSync, check }  = require("proper-lockfile")
-
-
-require("dotenv").config({
-	path: `.env.${process.env.NODE_ENV}`,
-})
-
-/**
- * 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 });
-
-	let dirPath = path.dirname(filePath);
-
-
-	if (!fs.existsSync(dirPath)) {
-		fs.mkdirSync(dirPath, { recursive: true });
-	}
-
-	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 });
-
-	if (fs.existsSync(filePath)) {
-		fs.unlinkSync(filePath);
-	}
-
-}
-/**
- * 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 });
-
-	if (contentList == null) {
-		//initialize the list
-		contentList = [item];
-	} else {
-		//replace the item...
-		const cIndex = contentList.findIndex((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 {
-			//*** regular item (merge) ***
-			if (cIndex >= 0) {
-				//replace the existing item
-				contentList[cIndex] = item;
-			} else {
-				//and it to the end of the
-				contentList.push(item);
-			}
-		}
-	}
-
-	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 });
-
-	if (!fs.existsSync(filePath)) return null;
-
-	let json = fs.readFileSync(filePath, 'utf8');
-	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 })
-}
-
-
-
-/**
- * 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 () => {
-
-
-	const dir = os.tmpdir();
-	const lockFile = `${dir}/${"agility-sync"}.mutex`
-	if (! fs.existsSync(lockFile)) {
-		fs.writeFileSync(lockFile, "agility-sync");
-	}
-
-	//THE LOCK IS ALREADY HELD - WAIT UP!
-	await waitOnLock(lockFile)
-
-	try {
-		return lockSync(lockFile)
-	} catch (err) {
-		if (`${err}`.indexOf("Lock file is already being held") !== -1) {
-
-			//this error happens when 2 processes try to get a lock at the EXACT same time (very rare)
-			await sleep(100)
-			await waitOnLock(lockFile)
-
-			try {
-				return lockSync(lockFile)
-			} catch (e2) {
-				if (`${err}`.indexOf("Lock file is already being held") !== -1) {
-
-					//this error happens when 2 processes try to get a lock at the EXACT same time (very rare)
-					await sleep(100)
-					await waitOnLock(lockFile)
-					return lockSync(lockFile)
-				}
-			}
-		}
-
-		throw Error("The mutex lock could not be obtained.")
-	}
-
-}
-
-
-//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 }) => {
-		if(typeof itemID === 'string' || itemID instanceof String){
-			itemID = itemID.replace(/[^a-zA-Z ]/g, "");
-		}
-		const fileName = `${itemID}.json`;
-		return path.join(options.rootPath, languageCode, itemType, fileName);
-}
-
-
-module.exports = {
-	saveItem,
-	deleteItem,
-	mergeItemToList,
-	getItem,
-	clearItems,
-	mutexLock
+const fs = require('fs')
+const os = require('os')
+const path = require('path')
+const {sleep} = require("./util")
+const { lockSync, unlockSync, checkSync, check }  = require("proper-lockfile")
+
+
+require("dotenv").config({
+	path: `.env.${process.env.NODE_ENV}`,
+})
+
+/**
+ * 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 });
+
+	let dirPath = path.dirname(filePath);
+
+
+	if (!fs.existsSync(dirPath)) {
+		fs.mkdirSync(dirPath, { recursive: true });
+	}
+
+	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 });
+
+	if (fs.existsSync(filePath)) {
+		fs.unlinkSync(filePath);
+	}
+
+}
+/**
+ * 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 });
+
+	if (contentList == null) {
+		//initialize the list
+		contentList = [item];
+	} else {
+		//replace the item...
+		const cIndex = contentList.findIndex((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 {
+			//*** regular item (merge) ***
+			if (cIndex >= 0) {
+				//replace the existing item
+				contentList[cIndex] = item;
+			} else {
+				//and it to the end of the
+				contentList.push(item);
+			}
+		}
+	}
+
+	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 });
+
+	if (!fs.existsSync(filePath)) return null;
+
+	let json = fs.readFileSync(filePath, 'utf8');
+	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 })
+}
+
+
+
+/**
+ * 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 () => {
+
+
+	const dir = os.tmpdir();
+	const lockFile = `${dir}/${"agility-sync"}.mutex`
+	if (! fs.existsSync(lockFile)) {
+		fs.writeFileSync(lockFile, "agility-sync");
+	}
+
+	//THE LOCK IS ALREADY HELD - WAIT UP!
+	await waitOnLock(lockFile)
+
+	try {
+		return lockSync(lockFile)
+	} catch (err) {
+		if (`${err}`.indexOf("Lock file is already being held") !== -1) {
+
+			//this error happens when 2 processes try to get a lock at the EXACT same time (very rare)
+			await sleep(100)
+			await waitOnLock(lockFile)
+
+			try {
+				return lockSync(lockFile)
+			} catch (e2) {
+				if (`${err}`.indexOf("Lock file is already being held") !== -1) {
+
+					//this error happens when 2 processes try to get a lock at the EXACT same time (very rare)
+					await sleep(100)
+					await waitOnLock(lockFile)
+					return lockSync(lockFile)
+				}
+			}
+		}
+
+		throw Error("The mutex lock could not be obtained.")
+	}
+
+}
+
+
+//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 }) => {
+		if(typeof itemID === 'string' || itemID instanceof String){
+			itemID = itemID.replace(/[`!@#$%^&*()+\=\[\]{};':"\\|,.<>\/?~]/g, "");
+		}
+		const fileName = `${itemID}.json`;
+		return path.join(options.rootPath, languageCode, itemType, fileName);
+}
+
+
+module.exports = {
+	saveItem,
+	deleteItem,
+	mergeItemToList,
+	getItem,
+	clearItems,
+	mutexLock
 }