@agility/content-sync 1.1.2 → 1.1.4

package/src/sync-client.js

@@ -1,75 +1,75 @@
-import agility from '@agility/content-fetch'
-import syncContent from './methods/syncContent'
-import clearSync from './methods/clearSync'
-import syncPages from './methods/syncPages'
-import runSync from './methods/runSync'
-
-import storeInterface from './store-interface'
-import storeInterfaceFileSystem from './store-interface-filesystem'
-
-function getSyncClient (userConfig) {
-    validateConfigParams(userConfig);
-    return createSyncClient(userConfig);
-}
-
-function validateConfigParams(configParams) {
-
-    if(!configParams.guid || configParams.guid.length == 0) {
-        throw new TypeError('You must provide an guid.');
-    } else if(!configParams.apiKey || configParams.apiKey.length == 0) {
-        throw new TypeError('You must provide an access token.');
-    } else {
-        return;
-    }
-}
-
-const defaultConfig = {
-    baseUrl: null,
-    isPreview: false,
-    guid: null,
-    apiKey: null,
-    languages: [],
-    channels: [],
-    debug: false,
-    store: {
-        interface: storeInterfaceFileSystem,
-        options: {
-            rootPath: '.agility-files'
-        }
-    }
-};
-
-function createSyncClient(userConfig) {
-    let config = {
-        ...defaultConfig,
-        ...userConfig
-
-    }
-
-    const agilityClient = agility.getApi({
-        guid: config.guid,
-        apiKey: config.apiKey,
-        isPreview: config.isPreview,
-        debug: config.debug,
-        baseUrl: config.baseUrl
-    });
-
-
-    //resolve the dependancy for store interface implementation (uses file-system by default)
-    let store = config.store.interface;
-
-    //set the sync storage interface provider, it will also validate it
-    storeInterface.setStore(store, config.store.options);
-
-    return {
-        config,
-        agilityClient,
-        syncContent,
-        syncPages,
-        clearSync,
-        runSync,
-        store: storeInterface
-    }
-}
-
+import agility from '@agility/content-fetch'
+import syncContent from './methods/syncContent'
+import clearSync from './methods/clearSync'
+import syncPages from './methods/syncPages'
+import runSync from './methods/runSync'
+
+import storeInterface from './store-interface'
+import storeInterfaceFileSystem from './store-interface-filesystem'
+
+function getSyncClient (userConfig) {
+    validateConfigParams(userConfig);
+    return createSyncClient(userConfig);
+}
+
+function validateConfigParams(configParams) {
+
+    if(!configParams.guid || configParams.guid.length == 0) {
+        throw new TypeError('You must provide an guid.');
+    } else if(!configParams.apiKey || configParams.apiKey.length == 0) {
+        throw new TypeError('You must provide an access token.');
+    } else {
+        return;
+    }
+}
+
+const defaultConfig = {
+    baseUrl: null,
+    isPreview: false,
+    guid: null,
+    apiKey: null,
+    languages: [],
+    channels: [],
+    debug: false,
+    store: {
+        interface: storeInterfaceFileSystem,
+        options: {
+            rootPath: '.agility-files'
+        }
+    }
+};
+
+function createSyncClient(userConfig) {
+    let config = {
+        ...defaultConfig,
+        ...userConfig
+
+    }
+
+    const agilityClient = agility.getApi({
+        guid: config.guid,
+        apiKey: config.apiKey,
+        isPreview: config.isPreview,
+        debug: config.debug,
+        baseUrl: config.baseUrl
+    });
+
+
+    //resolve the dependancy for store interface implementation (uses file-system by default)
+    let store = config.store.interface;
+
+    //set the sync storage interface provider, it will also validate it
+    storeInterface.setStore(store, config.store.options);
+
+    return {
+        config,
+        agilityClient,
+        syncContent,
+        syncPages,
+        clearSync,
+        runSync,
+        store: storeInterface
+    }
+}
+
 export default { getSyncClient }

package/src/util.js

@@ -1,46 +1,46 @@
-const asyncForEach = async (array, callback) => {
-	for (let index = 0; index < array.length; index++) {
-		await callback(array[index], index, array);
-	}
-}
-
-const logSuccess = (message) => {
-	message = `AgilityCMS => ${message} `;
-	console.log('\x1b[32m%s\x1b[0m', message);
-}
-
-const logWarning = (message) => {
-	message = `AgilityCMS => ${message} `;
-	console.log('\x1b[33m%s\x1b[0m', message);
-}
-
-const logError = (message) => {
-	message = `AgilityCMS => ${message} `;
-	console.log('\x1b[31m%s\x1b[0m', message);
-}
-
-const logInfo = (message) => {
-	message = `AgilityCMS => ${message} `;
-	console.log(message);
-}
-
-const logDebug = (message) => {
-	console.log('#######################################################################');
-	message = `AgilityCMS(debug) => ${message} `;
-	console.log('"\x1b[35m%s\x1b[0m', message);
-};
-
-
-const sleep = (ms) => {
-	return new Promise(resolve => setTimeout(resolve, ms));
-}
-
-module.exports = {
-	logDebug,
-	logInfo,
-	logError,
-	logWarning,
-	logSuccess,
-	asyncForEach,
-	sleep
+const asyncForEach = async (array, callback) => {
+	for (let index = 0; index < array.length; index++) {
+		await callback(array[index], index, array);
+	}
+}
+
+const logSuccess = (message) => {
+	message = `AgilityCMS => ${message} `;
+	console.log('\x1b[32m%s\x1b[0m', message);
+}
+
+const logWarning = (message) => {
+	message = `AgilityCMS => ${message} `;
+	console.log('\x1b[33m%s\x1b[0m', message);
+}
+
+const logError = (message) => {
+	message = `AgilityCMS => ${message} `;
+	console.log('\x1b[31m%s\x1b[0m', message);
+}
+
+const logInfo = (message) => {
+	message = `AgilityCMS => ${message} `;
+	console.log(message);
+}
+
+const logDebug = (message) => {
+	console.log('#######################################################################');
+	message = `AgilityCMS(debug) => ${message} `;
+	console.log('"\x1b[35m%s\x1b[0m', message);
+};
+
+
+const sleep = (ms) => {
+	return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+module.exports = {
+	logDebug,
+	logInfo,
+	logError,
+	logWarning,
+	logSuccess,
+	asyncForEach,
+	sleep
 }

package/test/01-getSyncClient.tests.js

@@ -1,38 +1,38 @@
-import chai from 'chai'
-const assert = chai.assert;
-
-import agilitySync from '../src/sync-client'
-import { createSyncClientUsingConsoleStore } from './_syncClients.config'
-
-
-//This is a synchronous test
-describe('getSyncClient:', function() {
-
-    this.timeout('120s');
-    
-    it('should return a sync worker object with required params', function(done) {
-        const syncClient = agilitySync.getSyncClient({
-            guid: 'some-guid',
-            apiKey: 'some-access-token'
-        });
-        assert.strictEqual(typeof(syncClient), "object");
-        done();
-    })
-
-    it('should return an sync worker object in preview mode', function(done) {
-        const syncClient = agilitySync.getSyncClient({
-            guid: 'some-guid',
-            apiKey: 'some-access-token',
-            isPreview: true
-        });
-
-        assert.strictEqual(syncClient.config.isPreview, true);
-        done();
-    })
-
-    it('should validate a valid external store interface (console)', function(done) {
-        const syncClient = createSyncClientUsingConsoleStore()    
-        done();
-    })
- 
+import chai from 'chai'
+const assert = chai.assert;
+
+import agilitySync from '../src/sync-client'
+import { createSyncClientUsingConsoleStore } from './_syncClients.config'
+
+
+//This is a synchronous test
+describe('getSyncClient:', function() {
+
+    this.timeout('120s');
+    
+    it('should return a sync worker object with required params', function(done) {
+        const syncClient = agilitySync.getSyncClient({
+            guid: 'some-guid',
+            apiKey: 'some-access-token'
+        });
+        assert.strictEqual(typeof(syncClient), "object");
+        done();
+    })
+
+    it('should return an sync worker object in preview mode', function(done) {
+        const syncClient = agilitySync.getSyncClient({
+            guid: 'some-guid',
+            apiKey: 'some-access-token',
+            isPreview: true
+        });
+
+        assert.strictEqual(syncClient.config.isPreview, true);
+        done();
+    })
+
+    it('should validate a valid external store interface (console)', function(done) {
+        const syncClient = createSyncClientUsingConsoleStore()    
+        done();
+    })
+ 
 });

package/test/02-runSync.tests.js

@@ -1,74 +1,74 @@
-import chai from 'chai'
-const assert = chai.assert;
-const expect = chai.expect;
-
-
-import { createSyncClient, createSyncClientUsingConsoleStore, createPreviewSyncClient } from './_syncClients.config'
-
-const sleep = (ms) => {
-	return new Promise(resolve => setTimeout(resolve, ms));
-}
-
-
-/*
-	This file contains static references to content from the instance configured in the apiClient.config file.
-*/
-
-//this file should always run first in the tests...
-
-describe('runSync:', async function () {
-
-	this.timeout('120s');
-
-	it('should run 1 sync method using the filesystem', async function () {
-
-		var sync = createSyncClient();
-		await sync.runSync();
-
-		await sync.clearSync();
-
-	})
-
-
-	it('should run 3 syncs at the same time method using the filesystem', async function () {
-
-		let sync1 = createSyncClient();
-		let sync2 = createSyncClient();
-		let sync3 = createSyncClient();
-
-		let p1 = sync1.runSync();
-		let p2 = sync2.runSync();
-		let p3 = sync3.runSync();
-
-		await Promise.all([p1, p2, p3])
-
-	})
-
-
-	it('should run 3 syncs 1.5 secs apart', async function () {
-
-		let sync1 = createSyncClient();
-		let sync2 = createSyncClient();
-		let sync3 = createSyncClient();
-		await sleep(1500)
-		await sync1.runSync();
-		await sleep(1500)
-		await sync2.runSync();
-		await sleep(1500)
-		await sync3.runSync();
-
-	})
-
-});
-
-describe('runSync:', async function () {
-
-	this.timeout('120s');
-
-	it('should run sync method using the console store', async function () {
-		var sync = createSyncClientUsingConsoleStore();
-		await sync.runSync();
-	})
-
-});
-
+import chai from 'chai'
+const assert = chai.assert;
+const expect = chai.expect;
+
+
+import { createSyncClient, createSyncClientUsingConsoleStore, createPreviewSyncClient } from './_syncClients.config'
+
+const sleep = (ms) => {
+	return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+
+/*
+	This file contains static references to content from the instance configured in the apiClient.config file.
+*/
+
+//this file should always run first in the tests...
+
+describe('runSync:', async function () {
+
+	this.timeout('120s');
+
+	it('should run 1 sync method using the filesystem', async function () {
+
+		var sync = createSyncClient();
+		await sync.runSync();
+
+		await sync.clearSync();
+
+	})
+
+
+	it('should run 3 syncs at the same time method using the filesystem', async function () {
+
+		let sync1 = createSyncClient();
+		let sync2 = createSyncClient();
+		let sync3 = createSyncClient();
+
+		let p1 = sync1.runSync();
+		let p2 = sync2.runSync();
+		let p3 = sync3.runSync();
+
+		await Promise.all([p1, p2, p3])
+
+	})
+
+
+	it('should run 3 syncs 1.5 secs apart', async function () {
+
+		let sync1 = createSyncClient();
+		let sync2 = createSyncClient();
+		let sync3 = createSyncClient();
+		await sleep(1500)
+		await sync1.runSync();
+		await sleep(1500)
+		await sync2.runSync();
+		await sleep(1500)
+		await sync3.runSync();
+
+	})
+
+});
+
+describe('runSync:', async function () {
+
+	this.timeout('120s');
+
+	it('should run sync method using the console store', async function () {
+		var sync = createSyncClientUsingConsoleStore();
+		await sync.runSync();
+	})
+
+});
+

package/test/03-store.getContentItem.tests.js

@@ -1,25 +1,25 @@
-import chai from 'chai'
-const assert = chai.assert;
-const expect = chai.expect;
-
-import { createSyncClient, createPreviewSyncClient } from './_syncClients.config'
-
-/*
-    This file contains static references to content from the instance configured in the apiClient.config file.
-*/
-
-const languageCode = 'en-us'
-
-describe('store.getContentItem:', async function() {
-
-    it('should be able to retrieve an item from the store', async function() {
-        var syncClient = createSyncClient();
-        const contentItem = await syncClient.store.getContentItem({
-            contentID: 21,
-            languageCode: languageCode,
-        })
-        assert.strictEqual(contentItem.contentID, 21, 'retrieved the content item we asked for')
-    })
-
-});
-
+import chai from 'chai'
+const assert = chai.assert;
+const expect = chai.expect;
+
+import { createSyncClient, createPreviewSyncClient } from './_syncClients.config'
+
+/*
+    This file contains static references to content from the instance configured in the apiClient.config file.
+*/
+
+const languageCode = 'en-us'
+
+describe('store.getContentItem:', async function() {
+
+    it('should be able to retrieve an item from the store', async function() {
+        var syncClient = createSyncClient();
+        const contentItem = await syncClient.store.getContentItem({
+            contentID: 21,
+            languageCode: languageCode,
+        })
+        assert.strictEqual(contentItem.contentID, 21, 'retrieved the content item we asked for')
+    })
+
+});
+

package/test/04-store.getContentList.tests.js

@@ -1,67 +1,67 @@
-import chai from 'chai'
-const assert = chai.assert;
-const expect = chai.expect;
-
-import { createSyncClient, createPreviewSyncClient } from './_syncClients.config'
-
-/*
-    This file contains static references to content from the instance configured in the apiClient.config file.
-*/
-
-const languageCode = 'en-us'
-
-describe('store.getContentList:', async function() {
-
-    it('should be able to retrieve a list from the store', async function() {
-        var syncClient = createSyncClient();
-
-        const contentList = await syncClient.store.getContentList({
-            referenceName: 'posts',
-            languageCode: languageCode
-        })
-
-        assert.strictEqual(contentList[0].properties.referenceName, "posts", 'retrieved the content list we asked for')
-    })
-
-
-	it('should be able to expand and page a list from the store', async function() {
-        var syncClient = createSyncClient();
-
-        const contentList = await syncClient.store.getContentList({
-            referenceName: 'posts',
-            languageCode: languageCode,
-			depth: 2,
-			take: 1,
-			skip: 1,
-			expandAllContentLinks: true
-        })
-
-        assert.isAtLeast(contentList.totalCount, 1, 'retrieved the totalCount of the content list we asked for')
-        assert.exists(contentList.items,  'retrieved the items of the content list we asked for')
-        assert.exists(contentList.items[0].fields,  'retrieved the item of the content list we asked for')
-		assert.strictEqual(contentList.items.length, 1,  'retrieved only the item of the content list we asked for')
-
-    })
-
-
-    it('should be able to expand a nested list with expandAllContentLinks', async function () {
-        var syncClient = createSyncClient();
-
-        const contentList = await syncClient.store.getContentList({
-            referenceName: 'listwithnestedcontentlink',
-            languageCode: languageCode,
-            depth: 10,
-            take: 50,
-            skip: 0,
-            expandAllContentLinks: true
-        })
-
-        assert.isAtLeast(contentList.totalCount, 1, 'retrieved the totalCount of the content list we asked for')
-        assert.exists(contentList.items, 'retrieved the items of the content list we asked for')
-        assert.exists(contentList.items[0].fields, 'retrieved the item of the content list we asked for')
-        assert.isAtLeast(contentList.items[0].fields.posts.length, 1, 'expanded the linked cotnent of the posts field')
-
-
-    })
-});
-
+import chai from 'chai'
+const assert = chai.assert;
+const expect = chai.expect;
+
+import { createSyncClient, createPreviewSyncClient } from './_syncClients.config'
+
+/*
+    This file contains static references to content from the instance configured in the apiClient.config file.
+*/
+
+const languageCode = 'en-us'
+
+describe('store.getContentList:', async function() {
+
+    it('should be able to retrieve a list from the store', async function() {
+        var syncClient = createSyncClient();
+
+        const contentList = await syncClient.store.getContentList({
+            referenceName: 'posts',
+            languageCode: languageCode
+        })
+
+        assert.strictEqual(contentList[0].properties.referenceName, "posts", 'retrieved the content list we asked for')
+    })
+
+
+	it('should be able to expand and page a list from the store', async function() {
+        var syncClient = createSyncClient();
+
+        const contentList = await syncClient.store.getContentList({
+            referenceName: 'posts',
+            languageCode: languageCode,
+			depth: 2,
+			take: 1,
+			skip: 1,
+			expandAllContentLinks: true
+        })
+
+        assert.isAtLeast(contentList.totalCount, 1, 'retrieved the totalCount of the content list we asked for')
+        assert.exists(contentList.items,  'retrieved the items of the content list we asked for')
+        assert.exists(contentList.items[0].fields,  'retrieved the item of the content list we asked for')
+		assert.strictEqual(contentList.items.length, 1,  'retrieved only the item of the content list we asked for')
+
+    })
+
+
+    it('should be able to expand a nested list with expandAllContentLinks', async function () {
+        var syncClient = createSyncClient();
+
+        const contentList = await syncClient.store.getContentList({
+            referenceName: 'listwithnestedcontentlink',
+            languageCode: languageCode,
+            depth: 10,
+            take: 50,
+            skip: 0,
+            expandAllContentLinks: true
+        })
+
+        assert.isAtLeast(contentList.totalCount, 1, 'retrieved the totalCount of the content list we asked for')
+        assert.exists(contentList.items, 'retrieved the items of the content list we asked for')
+        assert.exists(contentList.items[0].fields, 'retrieved the item of the content list we asked for')
+        assert.isAtLeast(contentList.items[0].fields.posts.length, 1, 'expanded the linked cotnent of the posts field')
+
+
+    })
+});
+