@agility/content-sync 1.1.5 → 1.1.6

package/package.json

@@ -1,46 +1,46 @@
-{
-  "name": "@agility/content-sync",
-  "version": "1.1.5",
-  "description": "JavaScript SDK for synchronizing content from Agility CMS",
-  "main": "dist/agility-sync-sdk.node.js",
-  "scripts": {
-    "test": "nyc --reporter=html --reporter=text mocha --require @babel/register --recursive ./test/",
-    "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose",
-    "build": "webpack --config webpack.config -p"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/agility/agility-sync-sdk.git"
-  },
-  "author": "Agility CMS",
-  "license": "MIT",
-  "contributors": [
-    "Joel Varty",
-    "James Vidler",
-    "Joshua Isaac"
-  ],
-  "bugs": {
-    "url": "https://github.com/agility/agility-sync-sdk/issues"
-  },
-  "homepage": "https://github.com/agility/agility-sync-sdk#readme",
-  "dependencies": {
-    "@agility/content-fetch": "^1.0.0",
-    "dotenv": "^8.2.0",
-    "proper-lockfile": "^4.1.2"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.2.3",
-    "@babel/core": "^7.3.4",
-    "@babel/node": "^7.2.2",
-    "@babel/preset-env": "^7.3.4",
-    "@babel/register": "^7.0.0",
-    "agility-jsdoc-template": "1.0.3",
-    "babel-loader": "^8.0.5",
-    "chai": "^4.2.0",
-    "jsdoc": "^3.5.5",
-    "mocha": "^8.2.1",
-    "nyc": "^15.0.0",
-    "webpack": "^4.29.6",
-    "webpack-cli": "^3.2.3"
-  }
-}
+{
+  "name": "@agility/content-sync",
+  "version": "1.1.6",
+  "description": "JavaScript SDK for synchronizing content from Agility CMS",
+  "main": "dist/agility-sync-sdk.node.js",
+  "scripts": {
+    "test": "nyc --reporter=html --reporter=text mocha --require @babel/register --recursive ./test/",
+    "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose",
+    "build": "webpack --config webpack.config -p"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/agility/agility-sync-sdk.git"
+  },
+  "author": "Agility CMS",
+  "license": "MIT",
+  "contributors": [
+    "Joel Varty",
+    "James Vidler",
+    "Joshua Isaac"
+  ],
+  "bugs": {
+    "url": "https://github.com/agility/agility-sync-sdk/issues"
+  },
+  "homepage": "https://github.com/agility/agility-sync-sdk#readme",
+  "dependencies": {
+    "@agility/content-fetch": "^1.0.0",
+    "dotenv": "^8.2.0",
+    "proper-lockfile": "^4.1.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.2.3",
+    "@babel/core": "^7.3.4",
+    "@babel/node": "^7.2.2",
+    "@babel/preset-env": "^7.3.4",
+    "@babel/register": "^7.0.0",
+    "agility-jsdoc-template": "1.0.3",
+    "babel-loader": "^8.0.5",
+    "chai": "^4.2.0",
+    "jsdoc": "^3.5.5",
+    "mocha": "^8.2.1",
+    "nyc": "^15.0.0",
+    "webpack": "^4.29.6",
+    "webpack-cli": "^3.2.3"
+  }
+}

package/src/methods/clearSync.js

@@ -1,7 +1,7 @@
-import { logSuccess } from '../util'
-
-export default async function () {
-    const storeInterface = this.store;
-	await storeInterface.clear();
-	logSuccess(`Cleared Sync Items`);
-}
+import { logSuccess } from '../util'
+
+export default async function () {
+    const storeInterface = this.store;
+	await storeInterface.clear();
+	logSuccess(`Cleared Sync Items`);
+}

package/src/methods/runSync.js

@@ -1,95 +1,95 @@
-import { logInfo, logSuccess } from '../util'
-
-
-const syncRunner = async function () {
-
-	const storeInterface = this.store.getStore();
-
-	//if a mutex has been defined, call the wait lock
-	let lockRelease = null
-	if (storeInterface.mutexLock !== undefined) {
-		lockRelease = await storeInterface.mutexLock()
-	}
-
-	try {
-
-		//check to see
-
-
-		//actually do the sync
-		await sync(this)
-
-	} finally {
-		if (lockRelease) {
-			lockRelease()
-		}
-	}
-
-}
-
-
-const sync = async (clientObj) => {
-
-	const languageCodes = clientObj.config.languages;
-	const channels = clientObj.config.channels;
-	const storeInterface = clientObj.store;
-
-	const modeStr = clientObj.config.isPreview ? "preview" : "live"
-
-	for (const languageCode of languageCodes) {
-
-
-		let syncState = await storeInterface.getSyncState(languageCode);
-
-		if (!syncState) syncState = { itemToken: 0, pageToken: 0 };
-
-		const lastSyncDate = syncState.lastSyncDate || null
-		//run at MOST once a second
-		if (lastSyncDate && (new Date()) - new Date(lastSyncDate) < 1000) {
-			//skip sync...
-			continue;
-		}
-
-		logSuccess(`Starting Sync for ${languageCode} - ${modeStr} mode.`);
-		const newItemToken = await clientObj.syncContent(languageCode, syncState.itemToken);
-		const newPageToken = await clientObj.syncPages(languageCode, syncState.pageToken);
-
-		if (newItemToken != syncState.itemToken
-			|| newPageToken != syncState.pageToken) {
-			//if we sync ANYTHING - pull the new sitemap down
-
-			for (const channelName of channels) {
-				logInfo(`Updating Sitemap channel ${channelName} in ${languageCode}`);
-
-				const sitemap = await clientObj.agilityClient.getSitemapFlat({ channelName, languageCode });
-				storeInterface.saveSitemap({ sitemap, languageCode, channelName });
-
-				const sitemapNested = await clientObj.agilityClient.getSitemapNested({ channelName, languageCode });
-				storeInterface.saveSitemapNested({ sitemapNested, languageCode, channelName });
-
-			}
-		}
-
-		//save the redirects if they have changed...
-		let urlRedirections = await storeInterface.getUrlRedirections({ languageCode });
-		let lastAccessDate = null;
-		if (urlRedirections) lastAccessDate = urlRedirections.lastAccessDate;
-
-		urlRedirections = await clientObj.agilityClient.getUrlRedirections({ lastAccessDate });
-		if (urlRedirections && urlRedirections.isUpToDate === false) {
-			logInfo(`URL Redirections Updated and Saved`);
-			await storeInterface.saveUrlRedirections({ urlRedirections, languageCode });
-		}
-
-		syncState.itemToken = newItemToken;
-		syncState.pageToken = newPageToken;
-		syncState.lastSyncDate = new Date();
-
-		await storeInterface.saveSyncState({ syncState, languageCode });
-
-		logSuccess(`Completed Sync for ${languageCode} - ${modeStr} mode.`);
-	}
-}
-
-
+import { logInfo, logSuccess } from '../util'
+
+
+const syncRunner = async function () {
+
+	const storeInterface = this.store.getStore();
+
+	//if a mutex has been defined, call the wait lock
+	let lockRelease = null
+	if (storeInterface.mutexLock !== undefined) {
+		lockRelease = await storeInterface.mutexLock()
+	}
+
+	try {
+
+		//check to see
+
+
+		//actually do the sync
+		await sync(this)
+
+	} finally {
+		if (lockRelease) {
+			lockRelease()
+		}
+	}
+
+}
+
+
+const sync = async (clientObj) => {
+
+	const languageCodes = clientObj.config.languages;
+	const channels = clientObj.config.channels;
+	const storeInterface = clientObj.store;
+
+	const modeStr = clientObj.config.isPreview ? "preview" : "live"
+
+	for (const languageCode of languageCodes) {
+
+
+		let syncState = await storeInterface.getSyncState(languageCode);
+
+		if (!syncState) syncState = { itemToken: 0, pageToken: 0 };
+
+		const lastSyncDate = syncState.lastSyncDate || null
+		//run at MOST once a second
+		if (lastSyncDate && (new Date()) - new Date(lastSyncDate) < 1000) {
+			//skip sync...
+			continue;
+		}
+
+		logSuccess(`Starting Sync for ${languageCode} - ${modeStr} mode.`);
+		const newItemToken = await clientObj.syncContent(languageCode, syncState.itemToken);
+		const newPageToken = await clientObj.syncPages(languageCode, syncState.pageToken);
+
+		if (newItemToken != syncState.itemToken
+			|| newPageToken != syncState.pageToken) {
+			//if we sync ANYTHING - pull the new sitemap down
+
+			for (const channelName of channels) {
+				logInfo(`Updating Sitemap channel ${channelName} in ${languageCode}`);
+
+				const sitemap = await clientObj.agilityClient.getSitemapFlat({ channelName, languageCode });
+				storeInterface.saveSitemap({ sitemap, languageCode, channelName });
+
+				const sitemapNested = await clientObj.agilityClient.getSitemapNested({ channelName, languageCode });
+				storeInterface.saveSitemapNested({ sitemapNested, languageCode, channelName });
+
+			}
+		}
+
+		//save the redirects if they have changed...
+		let urlRedirections = await storeInterface.getUrlRedirections({ languageCode });
+		let lastAccessDate = null;
+		if (urlRedirections) lastAccessDate = urlRedirections.lastAccessDate;
+
+		urlRedirections = await clientObj.agilityClient.getUrlRedirections({ lastAccessDate });
+		if (urlRedirections && urlRedirections.isUpToDate === false) {
+			logInfo(`URL Redirections Updated and Saved`);
+			await storeInterface.saveUrlRedirections({ urlRedirections, languageCode });
+		}
+
+		syncState.itemToken = newItemToken;
+		syncState.pageToken = newPageToken;
+		syncState.lastSyncDate = new Date();
+
+		await storeInterface.saveSyncState({ syncState, languageCode });
+
+		logSuccess(`Completed Sync for ${languageCode} - ${modeStr} mode.`);
+	}
+}
+
+
 export default syncRunner

package/src/methods/syncContent.js

@@ -1,81 +1,81 @@
-import { logInfo, logWarning, sleep } from '../util'
-
-
-/**
- * Sync the content items in the specified Agility Instance.
- */
-export default async function (languageCode, token) {
-    const storeInterface = this.store;
-
-	if (!token) token = 0;
-
-	let itemCount = 0
-	let busy = false
-	let waitMS = 0
-	const waitMaxMS = 10 * 60 * 1000
-	const waitIntervalMS = 1000
-
-	do {
-
-
-		//sync content items...
-		const syncRet = await this.agilityClient.getSyncContent({
-			syncToken: token,
-			pageSize: 100,
-			languageCode: languageCode,
-
-		});
-
-
-		if (syncRet === undefined || syncRet === null || (syncRet.busy !== undefined && syncRet.busy === true)) {
-			//if the api is being updated, wait a few ms and try again...
-			waitMS += waitIntervalMS
-			if (waitMS > waitMaxMS) {
-				logWarning("Sync API has been busy for too long, canceling.")
-				break
-			}
-
-			if (! busy) {
-				//first time we're busy...
-				busy = true
-				logInfo("Sync API is busy.  Waiting...")
-			}
-
-			await sleep(waitIntervalMS)
-			continue
-		}
-
-		if (busy === true) {
-			logInfo("Continuing sync...")
-			busy = false
-			waitMS = 0
-		}
-
-		const syncItems = syncRet.items;
-
-		//if we don't get anything back, kick out
-		if (syncItems.length > 0 ) {
-
-			for (let index = 0; index < syncItems.length; index++) {
-				await storeInterface.saveContentItem({ contentItem: syncItems[index], languageCode });
-			}
-		}
-
-		if (syncRet.syncToken > token) {
-			token = syncRet.syncToken;
-		} else {
-			break;
-		}
-
-		itemCount += syncItems.length;
-
-	} while (token > 0 || busy === true)
-
-	if (itemCount > 0) {
-		logInfo(`Content Sync returned ${itemCount} item(s).`);
-	} else {
-		logInfo(`Content Sync returned no item(s).`);
-	}
-
-	return token;
+import { logInfo, logWarning, sleep } from '../util'
+
+
+/**
+ * Sync the content items in the specified Agility Instance.
+ */
+export default async function (languageCode, token) {
+    const storeInterface = this.store;
+
+	if (!token) token = 0;
+
+	let itemCount = 0
+	let busy = false
+	let waitMS = 0
+	const waitMaxMS = 10 * 60 * 1000
+	const waitIntervalMS = 1000
+
+	do {
+
+
+		//sync content items...
+		const syncRet = await this.agilityClient.getSyncContent({
+			syncToken: token,
+			pageSize: 100,
+			languageCode: languageCode,
+
+		});
+
+
+		if (syncRet === undefined || syncRet === null || (syncRet.busy !== undefined && syncRet.busy === true)) {
+			//if the api is being updated, wait a few ms and try again...
+			waitMS += waitIntervalMS
+			if (waitMS > waitMaxMS) {
+				logWarning("Sync API has been busy for too long, canceling.")
+				break
+			}
+
+			if (! busy) {
+				//first time we're busy...
+				busy = true
+				logInfo("Sync API is busy.  Waiting...")
+			}
+
+			await sleep(waitIntervalMS)
+			continue
+		}
+
+		if (busy === true) {
+			logInfo("Continuing sync...")
+			busy = false
+			waitMS = 0
+		}
+
+		const syncItems = syncRet.items;
+
+		//if we don't get anything back, kick out
+		if (syncItems.length > 0 ) {
+
+			for (let index = 0; index < syncItems.length; index++) {
+				await storeInterface.saveContentItem({ contentItem: syncItems[index], languageCode });
+			}
+		}
+
+		if (syncRet.syncToken > token) {
+			token = syncRet.syncToken;
+		} else {
+			break;
+		}
+
+		itemCount += syncItems.length;
+
+	} while (token > 0 || busy === true)
+
+	if (itemCount > 0) {
+		logInfo(`Content Sync returned ${itemCount} item(s).`);
+	} else {
+		logInfo(`Content Sync returned no item(s).`);
+	}
+
+	return token;
 }

package/src/methods/syncPages.js

@@ -1,76 +1,76 @@
-import { logInfo, logWarning, sleep } from '../util'
-
-export default async function (languageCode, token) {
-	const storeInterface = this.store;
-	if (!token) token = 0;
-
-	let itemCount = 0;
-
-	let busy = false
-	let waitMS = 0
-	const waitMaxMS = 10 * 60 * 1000
-	const waitIntervalMS = 1000
-
-
-	do {
-		//sync pages...
-		const syncRet = await this.agilityClient.getSyncPages({
-			syncToken: token,
-			pageSize: 100,
-			languageCode: languageCode
-		});
-
-		if (syncRet === undefined || syncRet === null || (syncRet.busy !== undefined && syncRet.busy === true)) {
-			//if the api is being updated, wait a few ms and try again...
-			waitMS += waitIntervalMS
-			if (waitMS > waitMaxMS) {
-				logWarning("Sync API has been busy for too long, canceling.")
-				break
-			}
-
-			if (!busy) {
-				busy = true
-				logInfo("Sync API is busy.  Waiting...")
-			}
-
-			await sleep(waitIntervalMS)
-			continue
-		}
-
-		if (busy === true) {
-			logInfo("Continuing sync...")
-			waitMS = 0
-			busy = false
-		}
-
-		const syncItems = syncRet.items;
-
-		//if we have something...
-		if (syncItems.length > 0) {
-
-
-			for (let index = 0; index < syncItems.length; index++) {
-				await storeInterface.savePageItem({ pageItem: syncItems[index], languageCode });
-			}
-		}
-
-		if (syncRet.syncToken > token) {
-			token = syncRet.syncToken;
-		} else {
-			break;
-		}
-
-		itemCount += syncItems.length;
-
-
-	} while (token > 0 || busy === true)
-
-	if (itemCount > 0) {
-		logInfo(`Page Sync returned ${itemCount} item(s).`);
-	} else {
-		logInfo(`Page Sync returned no item(s).`);
-	}
-
-
-	return token;
+import { logInfo, logWarning, sleep } from '../util'
+
+export default async function (languageCode, token) {
+	const storeInterface = this.store;
+	if (!token) token = 0;
+
+	let itemCount = 0;
+
+	let busy = false
+	let waitMS = 0
+	const waitMaxMS = 10 * 60 * 1000
+	const waitIntervalMS = 1000
+
+
+	do {
+		//sync pages...
+		const syncRet = await this.agilityClient.getSyncPages({
+			syncToken: token,
+			pageSize: 100,
+			languageCode: languageCode
+		});
+
+		if (syncRet === undefined || syncRet === null || (syncRet.busy !== undefined && syncRet.busy === true)) {
+			//if the api is being updated, wait a few ms and try again...
+			waitMS += waitIntervalMS
+			if (waitMS > waitMaxMS) {
+				logWarning("Sync API has been busy for too long, canceling.")
+				break
+			}
+
+			if (!busy) {
+				busy = true
+				logInfo("Sync API is busy.  Waiting...")
+			}
+
+			await sleep(waitIntervalMS)
+			continue
+		}
+
+		if (busy === true) {
+			logInfo("Continuing sync...")
+			waitMS = 0
+			busy = false
+		}
+
+		const syncItems = syncRet.items;
+
+		//if we have something...
+		if (syncItems.length > 0) {
+
+
+			for (let index = 0; index < syncItems.length; index++) {
+				await storeInterface.savePageItem({ pageItem: syncItems[index], languageCode });
+			}
+		}
+
+		if (syncRet.syncToken > token) {
+			token = syncRet.syncToken;
+		} else {
+			break;
+		}
+
+		itemCount += syncItems.length;
+
+
+	} while (token > 0 || busy === true)
+
+	if (itemCount > 0) {
+		logInfo(`Page Sync returned ${itemCount} item(s).`);
+	} else {
+		logInfo(`Page Sync returned no item(s).`);
+	}
+
+
+	return token;
 }