@agility/content-sync 1.2.0-beta.4 → 1.2.0-beta.6

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "@agility/content-sync",
-  "version": "1.2.0-beta.4",
+  "version": "1.2.0-beta.6",
   "description": "JavaScript SDK for synchronizing content from Agility CMS",
   "main": "dist/agility-sync-sdk.node.js",
-
   "scripts": {
-    "preinstall": "node -e \"const major = process.version.match(/^v(\\d+)/)[1]; if (major != 16) { console.error('Node 16 required, found Node ' + major); process.exit(1); }\"",
     "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"
@@ -39,6 +37,7 @@
     "@babel/plugin-transform-runtime": "^7.28.0",
     "@babel/preset-env": "^7.3.4",
     "@babel/register": "^7.0.0",
+    "@babel/runtime": "^7.27.6",
     "agility-jsdoc-template": "1.0.3",
     "babel-loader": "^8.0.5",
     "chai": "^4.2.0",

package/src/sync-client.js

@@ -82,4 +82,4 @@ function createSyncClient(userConfig) {
     }
 }
 
-export { getSyncClient }
+export default { getSyncClient }

package/dist/index.d.ts

@@ -1,20 +0,0 @@
-export * from './types/StoreInterface';
-export * from './types/ContentItem';
-export * from './types/Page';
-export * from './types/Asset';
-export * from './types/Container';
-export { ConsoleStore } from './store-interface-console';
-export { FileSystemStore } from './store-interface-filesystem';
-export { SyncClient } from './sync-client';
-export { logDebug, logInfo, logError, logWarning, logSuccess, asyncForEach } from './util';
-export { syncContentModels } from './methods/syncContentModels';
-export { syncPageModels } from './methods/syncPageModels';
-import syncContent from './methods/syncContent';
-import syncPages from './methods/syncPages';
-export { syncContent, syncPages };
-export { syncAssets } from './methods/syncAssets';
-export { syncGalleries } from './methods/syncGalleries';
-export { syncContainers } from './methods/syncContainers';
-export { clearSync } from './methods/clearSync';
-import runSync from './methods/runSync';
-export { runSync };

package/dist/index.js

@@ -1,25 +0,0 @@
-// Export types
-export * from './types/StoreInterface';
-export * from './types/ContentItem';
-export * from './types/Page';
-export * from './types/Asset';
-export * from './types/Container';
-// Export store interface implementations
-export { ConsoleStore } from './store-interface-console';
-export { FileSystemStore } from './store-interface-filesystem';
-// Export sync client
-export { SyncClient } from './sync-client';
-// Export utility functions
-export { logDebug, logInfo, logError, logWarning, logSuccess, asyncForEach } from './util';
-// Export sync methods
-export { syncContentModels } from './methods/syncContentModels';
-export { syncPageModels } from './methods/syncPageModels';
-import syncContent from './methods/syncContent';
-import syncPages from './methods/syncPages';
-export { syncContent, syncPages };
-export { syncAssets } from './methods/syncAssets';
-export { syncGalleries } from './methods/syncGalleries';
-export { syncContainers } from './methods/syncContainers';
-export { clearSync } from './methods/clearSync';
-import runSync from './methods/runSync';
-export { runSync };

package/dist/methods/clearSync.d.ts

@@ -1,3 +0,0 @@
-import { StoreInterface, StoreOptions } from '../types/StoreInterface';
-export declare const setStore: (storeToUse: StoreInterface, storeOptions: StoreOptions) => void;
-export declare const clearSync: () => Promise<void>;

package/dist/methods/clearSync.js

@@ -1,21 +0,0 @@
-import { logDebug, logError } from '../util';
-import { clear } from '../store-interface';
-let store = null;
-let options = null;
-export const setStore = (storeToUse, storeOptions) => {
-    store = storeToUse;
-    options = storeOptions;
-};
-export const clearSync = async () => {
-    if (!store || !options) {
-        throw new Error('Store not initialized. Call setStore first.');
-    }
-    try {
-        await clear();
-        logDebug('Cleared all sync data');
-    }
-    catch (error) {
-        logError('Error clearing sync data');
-        throw error;
-    }
-};

package/dist/methods/runSync.d.ts

@@ -1,39 +0,0 @@
-import type { StoreInterface, StoreOptions } from '../types/StoreInterface';
-import type { AgilityClient } from '../types/AgilityClient';
-export declare const setStore: (storeToUse: StoreInterface, storeOptions: StoreOptions) => void;
-export interface SyncData {
-    contentModels?: any[];
-    pageModels?: any[];
-    assets?: any[];
-    galleries?: any[];
-    containers?: any[];
-}
-interface SyncProgress {
-    status: 'init' | 'progress' | 'done';
-    current?: number;
-    total?: number;
-    item?: any;
-    languageCode?: string;
-    model?: string;
-}
-interface SyncOptions {
-    clearData?: boolean;
-    contentModels?: boolean;
-    pageModels?: boolean;
-    content?: boolean;
-    pages?: boolean;
-    assets?: boolean;
-    galleries?: boolean;
-    containers?: boolean;
-    languageCode?: string;
-}
-/**
- * Run a complete sync operation for the specified data models
- * @param options - Sync options including which models to sync and whether to clear data first
- * @returns AsyncGenerator that yields progress information
- */
-export default function runSync(this: {
-    store: StoreInterface;
-    agilityClient: AgilityClient;
-}, options?: SyncOptions): AsyncGenerator<SyncProgress, void>;
-export {};

package/dist/methods/runSync.js

@@ -1,94 +0,0 @@
-import { logError, logSuccess } from '../util';
-import { syncContentModels } from './syncContentModels';
-import { syncPageModels } from './syncPageModels';
-import syncContent from './syncContent';
-import syncPages from './syncPages';
-import { syncAssets } from './syncAssets';
-import { syncGalleries } from './syncGalleries';
-import { syncContainers } from './syncContainers';
-import { clearSync } from './clearSync';
-let store = null;
-let options = null;
-export const setStore = (storeToUse, storeOptions) => {
-    store = storeToUse;
-    options = storeOptions;
-};
-/**
- * Run a complete sync operation for the specified data models
- * @param options - Sync options including which models to sync and whether to clear data first
- * @returns AsyncGenerator that yields progress information
- */
-export default async function* runSync(options = {}) {
-    const { clearData = false, contentModels = false, pageModels = false, content = false, pages = false, assets = false, galleries = false, containers = false, languageCode = 'en-us' } = options;
-    // Check if store is initialized
-    if (!this.store) {
-        logError('Store not initialized. Please call setStore first.');
-        return;
-    }
-    try {
-        // Clear data if requested
-        if (clearData) {
-            yield { status: 'init', model: 'clear' };
-            await clearSync.call(this);
-            yield { status: 'done', model: 'clear' };
-        }
-        // Sync content models if requested
-        if (contentModels) {
-            yield { status: 'init', model: 'contentModels' };
-            await syncContentModels.call(this, languageCode);
-            yield { status: 'done', model: 'contentModels' };
-        }
-        // Sync page models if requested
-        if (pageModels) {
-            yield { status: 'init', model: 'pageModels' };
-            await syncPageModels.call(this, languageCode);
-            yield { status: 'done', model: 'pageModels' };
-        }
-        // Sync content if requested
-        if (content) {
-            yield { status: 'init', model: 'content' };
-            const contentGenerator = syncContent.call(this, languageCode);
-            for await (const progress of contentGenerator) {
-                yield { ...progress, model: 'content' };
-            }
-        }
-        // Sync pages if requested
-        if (pages) {
-            yield { status: 'init', model: 'pages' };
-            const pagesGenerator = syncPages.call(this, languageCode);
-            for await (const progress of pagesGenerator) {
-                yield { ...progress, model: 'pages' };
-            }
-        }
-        // Sync assets if requested
-        if (assets) {
-            yield { status: 'init', model: 'assets' };
-            const assetsGenerator = syncAssets.call(this, languageCode);
-            for await (const progress of assetsGenerator) {
-                yield { ...progress, model: 'assets' };
-            }
-        }
-        // Sync galleries if requested
-        if (galleries) {
-            yield { status: 'init', model: 'galleries' };
-            const galleriesGenerator = syncGalleries.call(this, languageCode);
-            for await (const progress of galleriesGenerator) {
-                yield { ...progress, model: 'galleries' };
-            }
-        }
-        // Sync containers if requested
-        if (containers) {
-            yield { status: 'init', model: 'containers' };
-            const containersGenerator = syncContainers.call(this, languageCode);
-            for await (const progress of containersGenerator) {
-                yield { ...progress, model: 'containers' };
-            }
-        }
-        logSuccess('Sync completed successfully');
-    }
-    catch (error) {
-        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-        logError(`Error during sync: ${errorMessage}`);
-        throw error;
-    }
-}

package/dist/methods/syncAssets.d.ts

@@ -1,18 +0,0 @@
-import { StoreInterface, StoreOptions } from '../types/StoreInterface';
-export declare const setStore: (storeToUse: StoreInterface, storeOptions: StoreOptions) => void;
-interface SyncProgress {
-    status: 'init' | 'progress' | 'done';
-    current?: number;
-    total?: number;
-    item?: any;
-    languageCode?: string;
-}
-/**
- * Sync assets from Agility CMS
- * @param languageCode - The language code to sync assets for
- * @returns AsyncGenerator that yields progress information
- */
-export declare function syncAssets(this: {
-    store: StoreInterface;
-}, languageCode: string): AsyncGenerator<SyncProgress, void>;
-export {};

package/dist/methods/syncAssets.js

@@ -1,34 +0,0 @@
-import { logError, logInfo } from '../util';
-let store = null;
-let options = null;
-export const setStore = (storeToUse, storeOptions) => {
-    store = storeToUse;
-    options = storeOptions;
-};
-/**
- * Sync assets from Agility CMS
- * @param languageCode - The language code to sync assets for
- * @returns AsyncGenerator that yields progress information
- */
-export async function* syncAssets(languageCode) {
-    const storeInterface = this.store;
-    try {
-        yield { status: 'init' };
-        // Get all assets
-        const assets = await storeInterface.getAssets({ languageCode });
-        const total = assets.length;
-        yield { status: 'progress', total };
-        // Process each asset
-        for (let i = 0; i < assets.length; i++) {
-            const asset = assets[i];
-            await storeInterface.saveAsset({ asset, languageCode });
-            yield { status: 'progress', current: i + 1, total, item: asset, languageCode };
-        }
-        yield { status: 'done' };
-        logInfo(`Synced ${total} assets`);
-    }
-    catch (error) {
-        logError('Error syncing assets');
-        throw error;
-    }
-}

package/dist/methods/syncContainers.d.ts

@@ -1,18 +0,0 @@
-import { StoreInterface, StoreOptions } from '../types/StoreInterface';
-export declare const setStore: (storeToUse: StoreInterface, storeOptions: StoreOptions) => void;
-interface SyncProgress {
-    status: 'init' | 'progress' | 'done';
-    current?: number;
-    total?: number;
-    item?: any;
-    languageCode?: string;
-}
-/**
- * Sync containers from Agility CMS
- * @param languageCode - The language code to sync containers for
- * @returns AsyncGenerator that yields progress information
- */
-export declare function syncContainers(this: {
-    store: StoreInterface;
-}, languageCode: string): AsyncGenerator<SyncProgress, void>;
-export {};

package/dist/methods/syncContainers.js

@@ -1,34 +0,0 @@
-import { logError, logInfo } from '../util';
-let store = null;
-let options = null;
-export const setStore = (storeToUse, storeOptions) => {
-    store = storeToUse;
-    options = storeOptions;
-};
-/**
- * Sync containers from Agility CMS
- * @param languageCode - The language code to sync containers for
- * @returns AsyncGenerator that yields progress information
- */
-export async function* syncContainers(languageCode) {
-    const storeInterface = this.store;
-    try {
-        yield { status: 'init' };
-        // Get all containers
-        const containers = await storeInterface.getContainers({ languageCode });
-        const total = containers.length;
-        yield { status: 'progress', total };
-        // Process each container
-        for (let i = 0; i < containers.length; i++) {
-            const container = containers[i];
-            await storeInterface.saveContainer({ container, languageCode });
-            yield { status: 'progress', current: i + 1, total, item: container, languageCode };
-        }
-        yield { status: 'done' };
-        logInfo(`Synced ${total} containers`);
-    }
-    catch (error) {
-        logError('Error syncing containers');
-        throw error;
-    }
-}

package/dist/methods/syncContent.d.ts

@@ -1,20 +0,0 @@
-import { StoreInterface } from '../types/StoreInterface';
-import { AgilityClient } from '../types/AgilityClient';
-interface SyncProgress {
-    status: 'init' | 'progress' | 'done';
-    current?: number;
-    total?: number;
-    item?: any;
-    languageCode?: string;
-}
-/**
- * Sync the content items in the specified Agility Instance.
- * @param languageCode - The language code to sync content for
- * @param token - The sync token to start from
- * @returns The last sync token used
- */
-export default function syncContent(this: {
-    store: StoreInterface;
-    agilityClient: AgilityClient;
-}, languageCode: string, token?: number): AsyncGenerator<SyncProgress, number>;
-export {};

package/dist/methods/syncContent.js

@@ -1,83 +0,0 @@
-import { logInfo, logWarning, sleep } from '../util';
-/**
- * Sync the content items in the specified Agility Instance.
- * @param languageCode - The language code to sync content for
- * @param token - The sync token to start from
- * @returns The last sync token used
- */
-export default async function* syncContent(languageCode, token = 0) {
-    const storeInterface = this.store;
-    let itemCount = 0;
-    let busy = false;
-    let waitMS = 0;
-    const waitMaxMS = 10 * 60 * 1000;
-    const waitIntervalMS = 1000;
-    // Initialize progress
-    yield { status: 'init' };
-    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++) {
-                const item = syncItems[index];
-                await storeInterface.saveItem({
-                    options: {
-                        rootPath: './data',
-                        languageCode: languageCode
-                    },
-                    item,
-                    itemType: 'content',
-                    languageCode,
-                    itemID: item.contentID
-                });
-                itemCount++;
-                yield {
-                    status: 'progress',
-                    current: itemCount,
-                    item,
-                    languageCode
-                };
-            }
-        }
-        if (syncRet.syncToken > token) {
-            token = syncRet.syncToken;
-        }
-        else {
-            break;
-        }
-    } while (token > 0 || busy === true);
-    if (itemCount > 0) {
-        logInfo(`Content Sync returned ${itemCount} item(s).`);
-    }
-    else {
-        logInfo(`Content Sync returned no item(s).`);
-    }
-    yield { status: 'done' };
-    return token;
-}

package/dist/methods/syncContentModels.d.ts

@@ -1,10 +0,0 @@
-import { StoreInterface, StoreOptions } from '../types/StoreInterface';
-import { SyncProgress } from '../types';
-export declare const setStore: (storeToUse: StoreInterface, storeOptions: StoreOptions) => void;
-/**
- * Sync content models from Agility CMS
- * @param store - The store interface to use
- * @param languageCode - The language code to sync content models for
- * @returns AsyncGenerator that yields progress information
- */
-export declare function syncContentModels(store: StoreInterface, languageCode: string): AsyncGenerator<SyncProgress, void>;

package/dist/methods/syncContentModels.js

@@ -1,34 +0,0 @@
-import { logError, logInfo } from '../util';
-let store = null;
-let options = null;
-export const setStore = (storeToUse, storeOptions) => {
-    store = storeToUse;
-    options = storeOptions;
-};
-/**
- * Sync content models from Agility CMS
- * @param store - The store interface to use
- * @param languageCode - The language code to sync content models for
- * @returns AsyncGenerator that yields progress information
- */
-export async function* syncContentModels(store, languageCode) {
-    try {
-        yield { status: 'init' };
-        // Get all content models
-        const contentModels = await store.getContentModels({ languageCode });
-        const total = contentModels.length;
-        yield { status: 'progress', total };
-        // Process each content model
-        for (let i = 0; i < contentModels.length; i++) {
-            const contentModel = contentModels[i];
-            await store.saveContentModel({ contentModel, languageCode });
-            yield { status: 'progress', current: i + 1, total, item: contentModel, languageCode };
-        }
-        yield { status: 'done' };
-        logInfo(`Synced ${total} content models`);
-    }
-    catch (error) {
-        logError('Error syncing content models');
-        throw error;
-    }
-}

package/dist/methods/syncGalleries.d.ts

@@ -1,18 +0,0 @@
-import { StoreInterface, StoreOptions } from '../types/StoreInterface';
-export declare const setStore: (storeToUse: StoreInterface, storeOptions: StoreOptions) => void;
-interface SyncProgress {
-    status: 'init' | 'progress' | 'done';
-    current?: number;
-    total?: number;
-    item?: any;
-    languageCode?: string;
-}
-/**
- * Sync galleries from Agility CMS
- * @param languageCode - The language code to sync galleries for
- * @returns AsyncGenerator that yields progress information
- */
-export declare function syncGalleries(this: {
-    store: StoreInterface;
-}, languageCode: string): AsyncGenerator<SyncProgress, void>;
-export {};

package/dist/methods/syncGalleries.js

@@ -1,34 +0,0 @@
-import { logError, logInfo } from '../util';
-let store = null;
-let options = null;
-export const setStore = (storeToUse, storeOptions) => {
-    store = storeToUse;
-    options = storeOptions;
-};
-/**
- * Sync galleries from Agility CMS
- * @param languageCode - The language code to sync galleries for
- * @returns AsyncGenerator that yields progress information
- */
-export async function* syncGalleries(languageCode) {
-    const storeInterface = this.store;
-    try {
-        yield { status: 'init' };
-        // Get all galleries
-        const galleries = await storeInterface.getGalleries({ languageCode });
-        const total = galleries.length;
-        yield { status: 'progress', total };
-        // Process each gallery
-        for (let i = 0; i < galleries.length; i++) {
-            const gallery = galleries[i];
-            await storeInterface.saveGallery({ gallery, languageCode });
-            yield { status: 'progress', current: i + 1, total, item: gallery, languageCode };
-        }
-        yield { status: 'done' };
-        logInfo(`Synced ${total} galleries`);
-    }
-    catch (error) {
-        logError('Error syncing galleries');
-        throw error;
-    }
-}

package/dist/methods/syncPageModels.d.ts

@@ -1,18 +0,0 @@
-import { StoreInterface, StoreOptions } from '../types/StoreInterface';
-export declare const setStore: (storeToUse: StoreInterface, storeOptions: StoreOptions) => void;
-interface SyncProgress {
-    status: 'init' | 'progress' | 'done';
-    current?: number;
-    total?: number;
-    item?: any;
-    languageCode?: string;
-}
-/**
- * Sync page models from Agility CMS
- * @param languageCode - The language code to sync page models for
- * @returns AsyncGenerator that yields progress information
- */
-export declare function syncPageModels(this: {
-    store: StoreInterface;
-}, languageCode: string): AsyncGenerator<SyncProgress, void>;
-export {};

package/dist/methods/syncPageModels.js

@@ -1,34 +0,0 @@
-import { logError, logInfo } from '../util';
-let store = null;
-let options = null;
-export const setStore = (storeToUse, storeOptions) => {
-    store = storeToUse;
-    options = storeOptions;
-};
-/**
- * Sync page models from Agility CMS
- * @param languageCode - The language code to sync page models for
- * @returns AsyncGenerator that yields progress information
- */
-export async function* syncPageModels(languageCode) {
-    const storeInterface = this.store;
-    try {
-        yield { status: 'init' };
-        // Get all page models
-        const pageModels = await storeInterface.getPageModels({ languageCode });
-        const total = pageModels.length;
-        yield { status: 'progress', total };
-        // Process each page model
-        for (let i = 0; i < pageModels.length; i++) {
-            const pageModel = pageModels[i];
-            await storeInterface.savePageModel({ pageModel, languageCode });
-            yield { status: 'progress', current: i + 1, total, item: pageModel, languageCode };
-        }
-        yield { status: 'done' };
-        logInfo(`Synced ${total} page models`);
-    }
-    catch (error) {
-        logError('Error syncing page models');
-        throw error;
-    }
-}

package/dist/methods/syncPages.d.ts

@@ -1,20 +0,0 @@
-import { StoreInterface } from '../types/StoreInterface';
-import { AgilityClient } from '../types/AgilityClient';
-interface SyncProgress {
-    status: 'init' | 'progress' | 'done';
-    current?: number;
-    total?: number;
-    item?: any;
-    languageCode?: string;
-}
-/**
- * Sync the pages in the specified Agility Instance.
- * @param languageCode - The language code to sync pages for
- * @param token - The sync token to start from
- * @returns The last sync token used
- */
-export default function syncPages(this: {
-    store: StoreInterface;
-    agilityClient: AgilityClient;
-}, languageCode: string, token?: number): AsyncGenerator<SyncProgress, number>;
-export {};