@agility/content-sync 1.1.9 → 1.2.0-beta.2

package/dist/types/Gallery.d.ts

@@ -0,0 +1,15 @@
+export interface Gallery {
+    id: number;
+    name: string;
+    description?: string;
+    items: GalleryItem[];
+    languageCode: string;
+}
+export interface GalleryItem {
+    id: number;
+    title: string;
+    description?: string;
+    url: string;
+    thumbnailUrl?: string;
+    order: number;
+}

package/dist/types/Gallery.js

@@ -0,0 +1 @@
+export {};

package/dist/types/Page.d.ts

@@ -0,0 +1,14 @@
+export interface Page {
+    pageID: number;
+    properties: {
+        state: number;
+    };
+    zones: {
+        [zoneName: string]: PageModule[];
+    };
+}
+export interface PageModule {
+    item: {
+        contentid: number;
+    };
+}

package/dist/types/Page.js

@@ -0,0 +1 @@
+export {};

package/dist/types/PageModel.d.ts

@@ -0,0 +1,36 @@
+export interface PageModel {
+    id: number;
+    name: string;
+    definitionName: string;
+    description?: string;
+    zones: PageModelZone[];
+    languageCode: string;
+}
+export interface PageModelZone {
+    name: string;
+    label: string;
+    type: string;
+    required: boolean;
+    modules: PageModelModule[];
+}
+export interface PageModelModule {
+    name: string;
+    label: string;
+    type: string;
+    fields: PageModelField[];
+}
+export interface PageModelField {
+    name: string;
+    label: string;
+    type: string;
+    required: boolean;
+    defaultValue?: any;
+    validation?: PageModelFieldValidation;
+}
+export interface PageModelFieldValidation {
+    type: string;
+    message?: string;
+    pattern?: string;
+    min?: number;
+    max?: number;
+}

package/dist/types/PageModel.js

@@ -0,0 +1 @@
+export {};

package/dist/types/StoreInterface.d.ts

@@ -0,0 +1,165 @@
+import type { ContentItem } from './ContentItem';
+import type { Page } from './Page';
+import type { Asset } from './Asset';
+import type { Gallery } from './Gallery';
+import type { Container } from './Container';
+import type { ContentModel } from './ContentModel';
+import type { PageModel } from './PageModel';
+export interface StoreOptions {
+    rootPath: string;
+    languageCode: string;
+    clearData?: boolean;
+}
+export interface StoreInterface {
+    clearItems(options: StoreOptions): Promise<void>;
+    deleteItem(params: {
+        options: StoreOptions;
+        itemType: string;
+        languageCode: string;
+        itemID: string | number;
+    }): Promise<void>;
+    getItem(params: {
+        options: StoreOptions;
+        itemType: string;
+        languageCode: string;
+        itemID: string | number;
+    }): Promise<any>;
+    saveItem(params: {
+        options: StoreOptions;
+        item: any;
+        itemType: string;
+        languageCode: string;
+        itemID: string | number;
+    }): Promise<void>;
+    getContentItem(options: {
+        contentID: number;
+        languageCode: string;
+    }): Promise<ContentItem | null>;
+    saveContentItem(options: {
+        contentItem: ContentItem;
+        languageCode: string;
+    }): Promise<void>;
+    getContentItems(options: {
+        languageCode: string;
+    }): Promise<ContentItem[]>;
+    saveContentItems(options: {
+        contentItems: ContentItem[];
+        languageCode: string;
+    }): Promise<void>;
+    getPage(options: {
+        pageID: number;
+        languageCode: string;
+    }): Promise<Page | null>;
+    savePageItem(options: {
+        page: Page;
+        languageCode: string;
+    }): Promise<void>;
+    getPages(options: {
+        languageCode: string;
+    }): Promise<Page[]>;
+    savePageItems(options: {
+        pages: Page[];
+        languageCode: string;
+    }): Promise<void>;
+    getAsset(options: {
+        assetID: number;
+        languageCode: string;
+    }): Promise<Asset | null>;
+    saveAsset(options: {
+        asset: Asset;
+        languageCode: string;
+    }): Promise<void>;
+    getAssets(options: {
+        languageCode: string;
+    }): Promise<Asset[]>;
+    saveAssets(options: {
+        assets: Asset[];
+        languageCode: string;
+    }): Promise<void>;
+    getGallery(options: {
+        galleryID: number;
+        languageCode: string;
+    }): Promise<Gallery | null>;
+    saveGallery(options: {
+        gallery: Gallery;
+        languageCode: string;
+    }): Promise<void>;
+    getGalleries(options: {
+        languageCode: string;
+    }): Promise<Gallery[]>;
+    saveGalleries(options: {
+        galleries: Gallery[];
+        languageCode: string;
+    }): Promise<void>;
+    getContainer(options: {
+        containerID: number;
+        languageCode: string;
+    }): Promise<Container | null>;
+    saveContainer(options: {
+        container: Container;
+        languageCode: string;
+    }): Promise<void>;
+    getContainers(options: {
+        languageCode: string;
+    }): Promise<Container[]>;
+    saveContainers(options: {
+        containers: Container[];
+        languageCode: string;
+    }): Promise<void>;
+    getContentModel(options: {
+        contentModelID: number;
+        languageCode: string;
+    }): Promise<ContentModel | null>;
+    saveContentModel(options: {
+        contentModel: ContentModel;
+        languageCode: string;
+    }): Promise<void>;
+    getContentModels(options: {
+        languageCode: string;
+    }): Promise<ContentModel[]>;
+    saveContentModels(options: {
+        contentModels: ContentModel[];
+        languageCode: string;
+    }): Promise<void>;
+    getPageModel(options: {
+        pageModelID: number;
+        languageCode: string;
+    }): Promise<PageModel | null>;
+    savePageModel(options: {
+        pageModel: PageModel;
+        languageCode: string;
+    }): Promise<void>;
+    getPageModels(options: {
+        languageCode: string;
+    }): Promise<PageModel[]>;
+    savePageModels(options: {
+        pageModels: PageModel[];
+        languageCode: string;
+    }): Promise<void>;
+    getList(options: {
+        listName: string;
+        languageCode: string;
+    }): Promise<any[]>;
+    saveList(options: {
+        listName: string;
+        items: any[];
+        languageCode: string;
+    }): Promise<void>;
+    mergeItemToList(params: {
+        options: StoreOptions;
+        item: any;
+        languageCode: string;
+        itemID: string | number;
+        referenceName: string;
+        definitionName: string;
+    }): Promise<void>;
+    removeItemFromList(options: {
+        listName: string;
+        itemID: number;
+        languageCode: string;
+    }): Promise<void>;
+    initialize(options: StoreOptions): Promise<void>;
+    clearData(options: {
+        languageCode: string;
+    }): Promise<void>;
+}

package/dist/types/StoreInterface.js

@@ -0,0 +1 @@
+export {};

package/dist/types/SyncProgress.d.ts

@@ -0,0 +1,11 @@
+export interface SyncProgress {
+    status: 'init' | 'progress' | 'done';
+    current?: number;
+    total?: number;
+    item?: any;
+    languageCode?: string;
+}
+export interface SyncOptions {
+    languageCode: string;
+    clearData?: boolean;
+}

package/dist/types/SyncProgress.js

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -0,0 +1,11 @@
+export interface SyncProgress {
+    status: 'init' | 'progress' | 'done';
+    current?: number;
+    total?: number;
+    item?: any;
+    languageCode?: string;
+}
+export interface SyncOptions {
+    languageCode: string;
+    clearData?: boolean;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/util.d.ts

@@ -0,0 +1,7 @@
+export declare const logDebug: (message: string) => void;
+export declare const logInfo: (message: string) => void;
+export declare const logError: (message: string) => void;
+export declare const logWarning: (message: string) => void;
+export declare const logSuccess: (message: string) => void;
+export declare const asyncForEach: <T>(array: T[], callback: (item: T, index: number, array: T[]) => Promise<void>) => Promise<void>;
+export declare const sleep: (ms: number) => Promise<void>;

package/dist/util.js

@@ -0,0 +1,23 @@
+export const logDebug = (message) => {
+    console.debug(message);
+};
+export const logInfo = (message) => {
+    console.info(message);
+};
+export const logError = (message) => {
+    console.error(message);
+};
+export const logWarning = (message) => {
+    console.warn(message);
+};
+export const logSuccess = (message) => {
+    console.log(message);
+};
+export const asyncForEach = async (array, callback) => {
+    for (let index = 0; index < array.length; index++) {
+        await callback(array[index], index, array);
+    }
+};
+export const sleep = (ms) => {
+    return new Promise(resolve => setTimeout(resolve, ms));
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agility/content-sync",
-  "version": "1.1.9",
+  "version": "1.2.0-beta.2",
   "description": "JavaScript SDK for synchronizing content from Agility CMS",
   "main": "dist/agility-sync-sdk.node.js",
   "scripts": {
@@ -17,7 +17,9 @@
   "contributors": [
     "Joel Varty",
     "James Vidler",
-    "Joshua Isaac"
+    "Joshua Isaac",
+    "Kevin Tran",
+    "Aaron Taylor"
   ],
   "bugs": {
     "url": "https://github.com/agility/agility-sync-sdk/issues"
@@ -32,6 +34,7 @@
     "@babel/cli": "^7.2.3",
     "@babel/core": "^7.3.4",
     "@babel/node": "^7.2.2",
+    "@babel/plugin-transform-runtime": "^7.28.0",
     "@babel/preset-env": "^7.3.4",
     "@babel/register": "^7.0.0",
     "agility-jsdoc-template": "1.0.3",
@@ -40,7 +43,8 @@
     "jsdoc": "^3.5.5",
     "mocha": "^8.2.1",
     "nyc": "^15.0.0",
+    "regenerator-runtime": "^0.14.1",
     "webpack": "^4.29.6",
     "webpack-cli": "^3.2.3"
   }
-}
+}

package/src/methods/clearSync.js

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

package/src/methods/runSync.js

@@ -1,9 +1,8 @@
 import { logInfo, logSuccess } from '../util'
 
 
-const syncRunner = async function () {
+const syncRunner = async function (config, agilityClient, storeInterface, syncContent, syncPages) {
 
-	const storeInterface = this.store.getStore();
 
 	//if a mutex has been defined, call the wait lock
 	let lockRelease = null
@@ -17,7 +16,7 @@ const syncRunner = async function () {
 
 
 		//actually do the sync
-		await sync(this)
+		await sync(config, agilityClient, storeInterface, syncContent, syncPages)
 
 	} finally {
 		if (lockRelease) {
@@ -28,13 +27,12 @@ const syncRunner = async function () {
 }
 
 
-const sync = async (clientObj) => {
+const sync = async (config, agilityClient, storeInterface, syncContent, syncPages) => {
 
-	const languageCodes = clientObj.config.languages;
-	const channels = clientObj.config.channels;
-	const storeInterface = clientObj.store;
+	const languageCodes = config.languages;
+	const channels = config.channels;
 
-	const modeStr = clientObj.config.isPreview ? "preview" : "live"
+	const modeStr = config.isPreview ? "preview" : "live"
 
 	for (const languageCode of languageCodes) {
 
@@ -51,8 +49,8 @@ const sync = async (clientObj) => {
 		}
 
 		logSuccess(`Starting Sync for ${languageCode} - ${modeStr} mode.`);
-		const newItemToken = await clientObj.syncContent(languageCode, syncState.itemToken);
-		const newPageToken = await clientObj.syncPages(languageCode, syncState.pageToken);
+		const newItemToken = await syncContent(languageCode, syncState.itemToken);
+		const newPageToken = await syncPages(languageCode, syncState.pageToken);
 
 		if (newItemToken != syncState.itemToken
 			|| newPageToken != syncState.pageToken) {
@@ -61,10 +59,10 @@ const sync = async (clientObj) => {
 			for (const channelName of channels) {
 				logInfo(`Updating Sitemap channel ${channelName} in ${languageCode}`);
 
-				const sitemap = await clientObj.agilityClient.getSitemapFlat({ channelName, languageCode });
+				const sitemap = await agilityClient.getSitemapFlat({ channelName, languageCode });
 				storeInterface.saveSitemap({ sitemap, languageCode, channelName });
 
-				const sitemapNested = await clientObj.agilityClient.getSitemapNested({ channelName, languageCode });
+				const sitemapNested = await agilityClient.getSitemapNested({ channelName, languageCode });
 				storeInterface.saveSitemapNested({ sitemapNested, languageCode, channelName });
 
 			}
@@ -75,7 +73,7 @@ const sync = async (clientObj) => {
 		let lastAccessDate = null;
 		if (urlRedirections) lastAccessDate = urlRedirections.lastAccessDate;
 
-		urlRedirections = await clientObj.agilityClient.getUrlRedirections({ lastAccessDate });
+		urlRedirections = await agilityClient.getUrlRedirections({ lastAccessDate });
 		if (urlRedirections && urlRedirections.isUpToDate === false) {
 			logInfo(`URL Redirections Updated and Saved`);
 			await storeInterface.saveUrlRedirections({ urlRedirections, languageCode });

package/src/methods/syncContent.js

@@ -4,8 +4,8 @@ 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;
+export default async function (languageCode, token, storeInterface, agilityClient) {
+
 
 	if (!token) token = 0;
 
@@ -19,7 +19,7 @@ export default async function (languageCode, token) {
 
 
 		//sync content items...
-		const syncRet = await this.agilityClient.getSyncContent({
+		const syncRet = await agilityClient.getSyncContent({
 			syncToken: token,
 			pageSize: 100,
 			languageCode: languageCode,
@@ -35,7 +35,7 @@ export default async function (languageCode, token) {
 				break
 			}
 
-			if (! busy) {
+			if (!busy) {
 				//first time we're busy...
 				busy = true
 				logInfo("Sync API is busy.  Waiting...")
@@ -54,7 +54,7 @@ export default async function (languageCode, token) {
 		const syncItems = syncRet.items;
 
 		//if we don't get anything back, kick out
-		if (syncItems.length > 0 ) {
+		if (syncItems.length > 0) {
 
 			for (let index = 0; index < syncItems.length; index++) {
 				await storeInterface.saveContentItem({ contentItem: syncItems[index], languageCode });

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;
+export default async function (languageCode, token, storeInterface, agilityClient) {
+
 	if (!token) token = 0;
 
 	let itemCount = 0;
@@ -14,7 +14,7 @@ export default async function (languageCode, token) {
 
 	do {
 		//sync pages...
-		const syncRet = await this.agilityClient.getSyncPages({
+		const syncRet = await agilityClient.getSyncPages({
 			syncToken: token,
 			pageSize: 100,
 			languageCode: languageCode