@caweb/cli 1.5.1 → 1.5.3

package/commands/blocks/create-block.js

@@ -3,7 +3,10 @@
  */
 import path from 'path';
 import fs from 'fs';
-import inquirer from 'inquirer';
+// since we are in a spinner,
+// we have to silence all the cancellation errors when using prompts
+// .catch(() => {process.exit(1);})
+import { confirm } from '@inquirer/prompts';
 
 /**
  * Internal dependencies
@@ -49,14 +52,10 @@ export default async function createBlock({
 		if( fs.existsSync(path.resolve(process.cwd(), slug)) ){
 			spinner.info(`${slug} already exists.`)
 
-			const { yesUpdate } = await inquirer.prompt( [
-				{
-					type: 'confirm',
-					name: 'yesUpdate',
-					message: 'Would you like to update it?',
-					default: false,
-				},
-			] );
+			const yesUpdate = await confirm({
+				message: 'Would you like to update it?',
+				default: false,
+			} ).catch(() => {process.exit(1);});
 
 			if( yesUpdate ){
 				spinner.text = `Updating ${slug}...`;

package/commands/index.js

@@ -23,7 +23,7 @@ const a11y = new A11yPlugin().a11yCheck;
 
 import shell from './tasks/shell.js';
 
-import sync from './sync.js';
+import sync from './sync/index.js';
 
 import updatePlugins from './tasks/update-plugins.js'
 import createBlock from './blocks/create-block.js'

package/commands/sync/index.js

@@ -0,0 +1,553 @@
+/**
+ * External dependencies
+ */
+import path from 'path';
+import fs from 'fs';
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
+import axios from 'axios';
+
+// since we are in a spinner,
+// we have to silence all the cancellation errors when using prompts
+// .catch(() => {process.exit(1);})
+import { confirm, input, password } from '@inquirer/prompts';
+
+/**
+ * Internal dependencies
+ */
+import {
+	appPath,
+    getTaxonomies,
+    createTaxonomies
+} from '../../lib/index.js';
+
+import {
+    promptGetInstanceInfo,
+    promptSaveInstanceInfo,
+    promptForSync,
+    promptForId
+} from './prompts.js';
+
+const errors = [];
+const configFile = path.join(appPath, 'caweb.json');
+
+/**
+ * Return all parent items for a given set of ids.
+ *
+ * @async
+ * @param {Array} ids
+ * @param {*} request
+ * @param {string} [tax='pages']
+ * @returns {unknown}
+ */
+async function getParentItems( objects, request, tax = 'pages' ){
+    let parentItemsObjects = [];
+    let objectParentIds = objects.map((obj) => { return obj.parent; }).filter(n => n);
+
+    while( objectParentIds.length > 0 ){
+
+        // if we have parent ids, we have to collect any parent items.
+        let parentItems = await getTaxonomies({
+            ...request, 
+            orderby: 'parent',
+            embed: true,
+            include: objectParentIds
+        }, tax);
+
+        // if we have parent items, we have to add to the items array.
+        if( parentItems ){
+            parentItemsObjects = parentItemsObjects.concat( parentItems );
+        }
+
+        // if the parent items have parent ids, we have to save those for the next run.
+        objectParentIds = parentItems.map((obj) => { return obj.parent; }).filter((id) => { return id !== 0; })   
+    }
+
+    return objects.concat( parentItemsObjects ).sort( (a,b) => a.parent - b.parent );
+}
+
+
+/**
+ * Get information for an instance.
+ *
+ * @async
+ * @param {string} [instance='target']
+ * @returns {Object}
+ */
+async function getInstanceInfo( config, instance = 'target'){
+    // ask for target information to be entered.
+    const inputTarget = await confirm(
+        { 
+            message: `A ${instance} instance was not specified, would you like to enter the information?`,
+            default: true
+        }
+    ).catch(() => {process.exit(1);});
+
+    // if user said yes
+    if( inputTarget ){
+        let target = await promptGetInstanceInfo();
+
+        // ask to save information
+        let nickname = await promptSaveInstanceInfo()
+
+        if( nickname ){
+            config = config ?? {};
+
+            // add the target to sync list
+            config.sync[nickname] = target;
+
+            fs.writeFileSync(
+                configFile,
+                JSON.stringify(config, null, 4)
+            )
+        }
+
+        return target;
+    }
+}
+
+/**
+ * Sync Environments.
+ * 
+ * @see https://developer.wordpress.org/rest-api/reference/
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.target   Remote Site URL with current changes.
+ * @param {boolean} options.dest   Destination Site URL that should be synced.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ * @param {Array} options.tax   Taxonomy that should be synced.
+ * @param {Array} options.include   Include specific IDs only.
+ */
+export default async function sync({
+	spinner,
+	debug,
+	target,
+    dest,
+    interactive,
+    tax,
+    mediaIds,
+    menuIds,
+    pageIds,
+    postIds
+} ) {
+
+    // this gets the working directory path after wp-env validation
+    const {workDirectoryPath} = await loadConfig(path.resolve('.'));
+
+    // read caweb configuration file.    
+    let serviceConfig = fs.existsSync(configFile) ? JSON.parse( fs.readFileSync(configFile) ) : {};
+
+    process.env.WP_CLI_CONFIG_PATH  = path.join(workDirectoryPath, 'config.yml');
+    
+    // get target and dest instance data 
+    target = serviceConfig.sync[target];
+    dest = serviceConfig.sync[dest];
+
+    // if no target was specified or no target saved.
+    if( ! target ){
+        spinner.stop()
+
+       target = await getInstanceInfo(serviceConfig, 'target')
+
+       // if still no target then exit
+       if( ! target ){
+            process.exit(1)
+       }
+    }
+
+
+    // if no dest was specified or no dest saved.
+    if( ! dest ){
+        spinner.stop()
+
+        dest = await getInstanceInfo(serviceConfig, 'destination');
+
+        
+        // if still no target then exit
+        if( ! dest ){
+            process.exit(1)
+        }
+    }
+        
+    /**
+     * each instance has to have a url, user, pwd property
+     */
+    if( 
+        ! target || ! target.url || ! target.user || ! target.pwd ||
+        ! dest || ! dest.url || ! dest.user || ! dest.pwd
+    ){
+        spinner.fail(`caweb.json is not configured properly for ${target} and ${dest}.`);
+        process.exit(1)
+    }
+
+    let targetOptions = {
+        url: target.url,
+        headers: {
+            Authorization: 'Basic ' + Buffer.from(`${target.user}:${target.pwd}`).toString('base64')
+        }
+    }
+    let destOptions = {
+        url: dest.url,
+        headers: {
+            Authorization: 'Basic ' + Buffer.from(`${dest.user}:${dest.pwd}`).toString('base64'),
+            'content-type': 'multipart/form-data',
+            'accept': '*/*'
+        }
+    }
+
+    /**
+     * Sync Process 
+     * If taxonomy is undefined then we don't sync that section.
+     * 
+     * 1) We collect media if the taxonomy is undefined or includes media, pages, posts.
+     * 2) We only collect settings if the taxonomy is undefined or it's set to settings.
+     * 3) We only collect pages if the taxonomy is undefined or it's set to pages.
+     * 4) We only collect posts if the taxonomy is undefined or it's set to posts.
+     * 5) We only collect menus if the taxonomy is undefined or it's set to menus.
+     *    - We also collect menu items if menus are collected.
+     */
+    let settings = [];
+    let mediaLibrary = [];
+    let media = [];
+    let pages = [];
+    let posts = [];
+    let menus = [];
+    let menuNavItems = [];
+
+    // Run prompts if interactive
+    if( interactive ){
+        spinner.stop();
+        tax = await promptForSync(tax);
+
+        let inputtedMediaIds = tax.includes('media') ? await promptForId('Media') : '';
+        let inputtedMenuIds = tax.includes('menus') ? await promptForId('Menus') : '';
+        let inputtedPageIds = tax.includes('pages') ? await promptForId('Pages') : '';
+        let inputtedPostIds = tax.includes('posts') ? await promptForId('Posts') : '';
+
+        // if inputted ids is all then we dont need ids, 
+        inputtedMediaIds = 'all' === inputtedMediaIds ? [] : inputtedMediaIds.split(',');
+        inputtedMenuIds = 'all' === inputtedMenuIds ? [] : inputtedMenuIds.split(',');
+        inputtedPageIds = 'all' === inputtedPageIds ? [] : inputtedPageIds.split(',');
+        inputtedPostIds = 'all' === inputtedPostIds ? [] : inputtedPostIds.split(',');
+
+        mediaIds = mediaIds ? mediaIds.concat(inputtedMediaIds) : inputtedMediaIds;
+        menuIds = menuIds ? menuIds.concat(inputtedMenuIds) : inputtedMenuIds;
+        pageIds = pageIds ? pageIds.concat(inputtedPageIds) : inputtedPageIds;
+        postIds = postIds ? postIds.concat(inputtedPostIds) : inputtedPostIds;
+
+        spinner.start()
+
+    }
+
+    // Media Library.
+    if( tax.includes('media', 'pages', 'posts') ){
+        spinner.text = `Collecting Media Library ${target.url}`;
+        mediaLibrary = await getTaxonomies({ 
+                ...targetOptions, 
+                fields: [
+                    'id', 
+                    'source_url', 
+                    'title', 
+                    'caption', 
+                    'alt_text', 
+                    'date',
+                    'mime_type',
+                    'post',
+                    'media_details'
+                ],
+                include: mediaIds && mediaIds.length ? mediaIds.join(',') : null
+            }, 
+            'media'
+        );
+    }
+
+    // Site Settings.
+    if( tax.includes('settings') ){
+        spinner.text = `Collecting Site Settings from ${target.url}`;
+        settings = await getTaxonomies({
+            ...targetOptions,
+            fields: [
+                'title',
+                'description',
+                'show_on_front',
+                'page_on_front',
+                'posts_per_page'
+            ],
+        }, 'settings')
+        
+    }
+
+    // Pages.
+    if( tax.includes('pages') ){
+        // get all pages/posts
+        spinner.text = `Collecting pages from ${target.url}`;
+        pages = await getTaxonomies({
+                ...targetOptions, 
+                orderby: 'parent',
+                embed: true,
+                include: pageIds && pageIds.length ? pageIds.join(',') : null
+            }, 
+            'pages'
+        );
+
+        // pages can be nested so we have to collect any parent items.
+        pages = await getParentItems( 
+            pages, 
+            targetOptions, 
+            'pages'
+        ) 
+    }
+
+    // Posts.
+    if( tax.includes('posts') ){
+        // get all pages/posts
+        spinner.text = `Collecting all posts from ${target.url}`;
+        posts = await getTaxonomies({
+                ...targetOptions, 
+                orderby: 'parent',
+                include: postIds && postIds.length ? postIds.join(',') : null
+            }, 
+            'posts'
+        );
+
+        // posts can be nested so we have to collect any parent items.
+        posts = await getParentItems( 
+        posts, 
+        targetOptions, 
+        'posts'
+    ) 
+    }
+
+    /**
+     * Media Library Handling
+     * 
+     * We iterate thru the media library to identify which media should be synced.
+     * 1) attached media items by default are only possible on pages.
+     * 2) featured media by default are only possible on posts.
+     * 3) save any linked media in the content of pages and posts.
+     */
+    for( let m of mediaLibrary ){
+        // remove any new line characters.
+        m.source_url = m.source_url.replace('\n','');
+
+        /**
+         * We collect the media if:
+         * - media is attached
+         * - id was explicitly requested
+         * - tax includes media and media ids is blank
+         */
+        if( 
+            m.post || 
+            ( mediaIds && mediaIds.includes( m.id.toString() )  ) || 
+            ( tax.includes('media') && undefined === mediaIds ) 
+        ){
+            media.push( m );
+
+            // we don't have to check any further.
+            continue;
+        }
+
+        for( let p of [].concat( pages, posts ) ){
+            /**
+             * We collect the media if:
+             * - media is featured image 
+             * - media is the src attribute in the content
+             */
+            if( p.featured_media === m.id ||
+                p.content.rendered.match( new RegExp(`src=”(${m.source_url}.*)”`, 'g') )){
+                    media.push( m );
+                }
+        }
+    }
+
+    // filter any duplicate media.
+    media = media.filter((m, index, self) => { return index === self.findIndex((t) => { return t.id === m.id; })} );
+    let i = 0;
+    
+    // before we can upload media files we have to generate the media blob data.
+    for( let m of media ){
+        if( debug ){
+            i++;
+            spinner.info(`Media ID ${m.id} Collected: ${i}/${media.length}`)
+        }
+        
+        const mediaBlob = await axios.request( 
+            {
+                ...targetOptions,
+                url: m.source_url,
+                responseType: 'arraybuffer'
+            } 
+        )
+        .then( (img) => {  return new Blob([img.data]) })
+        .catch( (error) => {
+            errors.push(`${m.source_url} could not be downloaded.`)
+            return false;
+        });
+        
+        if( mediaBlob ){
+            m.data = mediaBlob;
+        }
+    }
+    
+    // this has to be done after we have the media data.
+    // Lets replace the url references in the content of the pages and posts.
+    for( let p of [].concat( pages, posts ) ){
+        p.content.rendered = p.content.rendered.replace( new RegExp(target.url, 'g'), dest.url );
+    }
+
+    
+    // Menu and Nav Items.
+    if( tax.includes('menus')){
+        spinner.text = `Collecting assigned navigation menus from ${target.url}`;
+        // get all menus and navigation links
+        menus = await getTaxonomies({
+            ...targetOptions,
+            fields: [
+                'id',
+                'description',
+                'name',
+                'slug',
+                'meta',
+                'locations'
+            ],
+            include: menuIds && menuIds.length ? menuIds.join(',') : null
+            }, 'menus');
+    
+        menuNavItems = await getTaxonomies( 
+            {
+                ...targetOptions,
+                fields: [
+                    'id',
+                    'title',
+                    'url',
+                    'status',
+                    'attr_title',
+                    'description',
+                    'type',
+                    'type_label',
+                    'object',
+                    'object_id',
+                    'parent',
+                    'menu_order',
+                    'target',
+                    'classes',
+                    'xfn',
+                    'meta',
+                    'menus'
+                ],
+                menus: menus.map((menu) => { return menu.id; })
+            }, 
+            'menu-items'
+        )
+
+        let missingPages = [];
+        let missingPosts = [];
+        // we iterate over menu items
+        menuNavItems.forEach(item => {
+            // if the item is a page and it wasn't previously collected
+            if( 'page' === item.object && ! pages.map(p => p.id ).includes(item.object_id) ){
+                missingPages.push(item.object_id)
+            // if the item is a post and it wasn't previously collected
+            }else if( 'post' === item.object && ! posts.map(p => p.id ).includes(item.object_id) ){
+                missingPosts.push(item.object_id)
+            }
+        })
+
+        // if navigation pages weren't previously collected they must be collected.
+        if( missingPages.length ){
+            missingPages = await getTaxonomies({
+                ...targetOptions, 
+                orderby: 'parent',
+                embed: true,
+                include: missingPages.join(',')
+                }, 
+                'pages'
+            );
+
+            // pages can be nested so we have to collect any parent items.
+            missingPages = await getParentItems( 
+                missingPages, 
+                targetOptions, 
+                'pages'
+            );
+            
+            // add the missing pages to the pages array
+            pages = pages.concat(missingPages)
+        }
+
+        // if navigation posts weren't previously collected they must be collected.
+        if( missingPosts.length ){
+            // get all pages/posts
+            spinner.text = `Collecting all posts from ${target.url}`;
+            missingPosts = await getTaxonomies({
+                    ...targetOptions, 
+                    orderby: 'parent',
+                    include: missingPosts.join(',')
+                }, 
+                'posts'
+            );
+
+            // posts can be nested so we have to collect any parent items.
+            missingPosts = await getParentItems( 
+                missingPosts, 
+                targetOptions, 
+                'posts'
+            )
+            
+            // add the missing posts to the posts array
+            posts = posts.concat(missingPages);
+        }
+    }
+
+    /**
+     * Now we have all the data we can begin to create the taxonomies on the target.
+     * 
+     * Import Order is important otherwise missing dependencies will cause errors to trigger
+     * 1) Media
+     * 2) Pages
+     * 3) Posts
+     * 4) Menus & Navigation Links
+     * 5) Settings
+     */
+
+    // Media.
+    if( media ){
+        spinner.text = `Uploading media files to ${dest.url}`;
+        await createTaxonomies(
+            media.filter((img) => { return img.data }), 
+            destOptions, 
+            'media', 
+            spinner
+            )
+    }
+
+     // Pages.
+    if( pages ){
+        spinner.text = `Creating all pages to ${dest.url}`;
+        await createTaxonomies( pages, destOptions, 'pages', spinner );
+    }
+
+     // Posts.
+    if( posts ){
+        spinner.text = `Creating all posts to ${dest.url}`;
+        await createTaxonomies( posts, destOptions, 'posts', spinner );
+    }
+
+    // Menus and Navigation Links.
+    if( menus ){
+        spinner.text = `Reconstructing navigation menus to ${dest.url}`;
+        await createTaxonomies(menus, destOptions, 'menus', spinner);
+        await createTaxonomies(menuNavItems, destOptions, 'menu-items', spinner);
+    }
+    
+
+    // Settings.
+    if( settings ){
+        spinner.text = `Updating site settings to ${dest.url}`;
+        await createTaxonomies(settings, destOptions, 'settings', spinner);
+    }
+
+    spinner.text = `Sync from ${target.url} to ${dest.url} completed successfully.`
+
+
+};

package/commands/sync/prompts.js

@@ -0,0 +1,107 @@
+/**
+ * External dependencies
+ */
+import { select } from 'inquirer-select-pro';
+import chalk from 'chalk';
+
+// since we are in a spinner,
+// we have to silence all the cancellation errors when using prompts
+// .catch(() => {process.exit(1);})
+import { confirm, input, password } from '@inquirer/prompts';
+
+
+const boldWhite = chalk.bold.white;
+
+/**
+ * Prompt for instance information
+ * { user, pwd, url }
+ * 
+ * @asyncc
+ * @returns {Prompt}
+ */
+async function promptGetInstanceInfo(){
+    return {
+        user: await input({ message: "User Name:" }).catch(() => {process.exit(1);}),
+        pwd: await password({ message: 'Application Password:' }).catch(() => {process.exit(1);}),
+        url: await input({ message: 'URL:' }).catch(() => {process.exit(1);}),
+    };
+}
+
+
+/**
+ * Prompt for saving information
+ * 
+ * @async
+ * @returns {Prompt}
+ */
+async function promptSaveInstanceInfo(){
+    let answer = await confirm(
+        { 
+            message: 'Would you like to save this information?',
+            default: true
+        }
+    ).catch(() => {process.exit(1);});
+
+    if( answer ){
+        // ask instance nickname
+        return await input({ message: "Instance Nickname:" }).catch(() => {process.exit(1);})
+    }
+}
+
+async function promptForSync(tax){
+    let bullet = chalk.yellow('-');
+    let info = chalk.cyan('i');
+    console.log(`Sync WordPress Instances\n${chalk.green('#'.repeat(25))}\n`);
+
+    console.log(chalk.red('Requirements:'));
+    console.log(bullet, 'Both instances must have the CAWebPublishing Development Toolbox WordPless plugin installed and activated');
+    console.log(bullet.repeat(2), 'Plugin can be found https://github.com/CAWebPublishing/caweb-dev/releases');
+    console.log(bullet, 'An application password must be setup for the username');
+    console.log(bullet.repeat(2), 'For more information regarding application password https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/');
+    
+    console.log(chalk.cyan('\nNotes:'));
+    // syncing menus note.
+    console.info(info, 'If Menus is selected, the following will also be synced:');
+    console.info(bullet, 'Any pages/posts (including parents) in the menu items.');
+
+    // syncing pages/posts note.
+    console.info(info, 'If Pages/Posts is selected, the following will also be synced:');
+    console.info(bullet, 'Any media that is attached.');
+    console.info(bullet, 'Any parent pages.');
+
+    console.log('');
+
+    let taxonomies = ['Media', 'Menus', 'Pages', 'Posts', 'Settings'];
+    let options = [];
+
+    taxonomies.forEach(t => {
+        options.push({
+            name: t,
+            value: t.toLowerCase(),
+            checked: tax.includes(t.toLowerCase())
+        })
+    })
+    return await select({
+        message: 'Select from the following taxonomies...',
+        multiple: true,
+        canToggleAll: true,
+        options,
+        defaultValue: options.map(o => o.checked ? o.value : false ).filter( e => e)
+      }).catch(() => {process.exit(1);});
+}
+
+async function promptForId(title){
+    console.log(chalk.cyan('i'), `Enter comma separated list of IDs for ${title}`)
+    return await input({
+        message: 'Which IDs would you like to sync?',
+        default: 'all',
+        value: 'test'
+    }).catch(() => {process.exit(1);});
+}
+
+export {
+    promptGetInstanceInfo,
+    promptSaveInstanceInfo,
+    promptForSync,
+    promptForId
+}

package/lib/cli.js

@@ -306,15 +306,35 @@ export default function cli() {
   // Update a Design System Block Command.
   program.command('sync')
     .description('Sync changes from one WordPress instance to another.')
-    .argument('<from>', 'Target Site URL.')
-    .argument('<to>', 'Destination Site URL.')
+    .argument('[target]', 'Target Site URL.')
+    .argument('[dest]', 'Destination Site URL.')
+	.addOption(new Option(
+		'--interactive',
+		'Runs the sync process with prompts'
+	))
+    .addOption(
+		new Option(
+      		'-t,--tax <tax...>',
+      		'Taxonomy that should be synced. Default is full site sync.'
+    	)
+		.choices(['media', 'menus', 'pages', 'posts', 'settings'])
+		.default(['media', 'menus', 'pages', 'posts', 'settings'])
+	)
     .addOption(new Option(
-      '-t,--tax [tax...]',
-      'Taxonomy that should be synced. Omitting this option will sync the full site.'
-    ).choices(['pages', 'posts', 'media', 'menus', 'settings']))
+      '--media-ids <ids...>',
+      'Sync specific Media IDs.'
+    ))
+    .addOption(new Option(
+      '--menu-ids <ids...>',
+      'Sync specific Menu IDs.'
+    ))
+    .addOption(new Option(
+      '--page-ids <ids...>',
+      'Sync specific Page IDs.'
+    ))
     .addOption(new Option(
-      '-i,--include [include...]',
-      'IDs to of taxonomies to include. Omitting this option will sync all items for given taxonomy.'
+      '--post-ids <ids...>',
+      'Sync specific Post IDs.'
     ))
     .allowUnknownOption(true)
     .action( withSpinner(env.sync) )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -56,7 +56,8 @@
     }
   },
   "dependencies": {
-    "@caweb/webpack": "^1.0.1",
+    "@caweb/webpack": "^1.0.3",
+    "@inquirer/prompts": "^5.2.0",
     "@wordpress/create-block": "^4.46.0",
     "@wordpress/env": "^10.3.0",
     "axios": "^1.7.2",
@@ -65,6 +66,7 @@
     "commander": "^12.1.0",
     "cross-spawn": "^7.0.3",
     "docker-compose": "^0.24.8",
+    "inquirer-select-pro": "^1.0.0-alpha.6",
     "ora": "^8.0.1",
     "resolve-bin": "^1.0.1",
     "terminal-link": "^3.0.0"

package/commands/sync.js

@@ -1,402 +0,0 @@
-/**
- * External dependencies
- */
-import path from 'path';
-import fs from 'fs';
-import loadConfig from '@wordpress/env/lib/config/load-config.js';
-import axios from 'axios';
-
-/**
- * Internal dependencies
- */
-import {
-	appPath,
-    getTaxonomies,
-    createTaxonomies
-} from '../lib/index.js';
-
-const errors = [];
-
-/**
- * Return all parent items for a given set of ids.
- *
- * @async
- * @param {Array} ids
- * @param {*} request
- * @param {string} [tax='pages']
- * @returns {unknown}
- */
-async function getParentItems( objects, request, tax = 'pages' ){
-    let parentItemsObjects = [];
-    let objectParentIds = objects.map((obj) => { return obj.parent; }).filter(n => n);
-
-    while( objectParentIds.length > 0 ){
-
-        // if we have parent ids, we have to collect any parent items.
-        let parentItems = await getTaxonomies({
-            ...request, 
-            orderby: 'parent',
-            embed: true,
-            include: objectParentIds
-        }, tax);
-
-        // if we have parent items, we have to add to the items array.
-        if( parentItems ){
-            parentItemsObjects = parentItemsObjects.concat( parentItems );
-        }
-
-        // if the parent items have parent ids, we have to save those for the next run.
-        objectParentIds = parentItems.map((obj) => { return obj.parent; }).filter((id) => { return id !== 0; })   
-    }
-
-    return objects.concat( parentItemsObjects ).sort( (a,b) => a.parent - b.parent );
-}
-
-/**
- * Sync Environments.
- * 
- * @see https://developer.wordpress.org/rest-api/reference/
- * 
- * @param {Object}  options
- * @param {Object}  options.spinner A CLI spinner which indicates progress.
- * @param {boolean} options.from   Remote Site URL with current changes.
- * @param {boolean} options.to   Destination Site URL that should be synced.
- * @param {boolean} options.debug   True if debug mode is enabled.
- * @param {Array} options.tax   Taxonomy that should be synced.
- * @param {Array} options.include   Include specific IDs only.
- */
-export default async function sync({
-	spinner,
-	debug,
-	from,
-    to,
-    tax,
-    include
-} ) {
-
-    const localFile = path.join(appPath, 'caweb.json');
-    const {workDirectoryPath} = await loadConfig(path.resolve('.'));
-
-    process.env.WP_CLI_CONFIG_PATH  = path.join(workDirectoryPath, 'config.yml');
-    
-    // if caweb.json file doesn't exist we don't do anything
-    if( ! fs.existsSync(localFile) ){
-        spinner.fail('caweb.json file not found.')
-        process.exit(1)
-    }
-
-    // read configuration file
-    const serviceConfig = JSON.parse( fs.readFileSync(localFile) );
-
-    /**
-     * make sure instances are in the file.
-     * must have sync property
-     * each instance has to have a url, user, pwd property
-     */
-    if( 
-        ! serviceConfig.sync || 
-        ! serviceConfig.sync[from] ||
-        ! serviceConfig.sync[from].url ||
-        ! serviceConfig.sync[from].user ||
-        ! serviceConfig.sync[from].pwd ||
-        ! serviceConfig.sync[to] || 
-        ! serviceConfig.sync[to].url ||
-        ! serviceConfig.sync[to].user ||
-        ! serviceConfig.sync[to].pwd
-    ){
-        spinner.fail(`caweb.json is not configured properly for ${from} and ${to}.`);
-        process.exit(1)
-    }
-    
-    // get instance data
-    from = serviceConfig.sync[from];
-    let fromOptions = {
-        url: from.url,
-        headers: {
-            Authorization: 'Basic ' + Buffer.from(`${from.user}:${from.pwd}`).toString('base64')
-        }
-    }
-    
-
-    to = serviceConfig.sync[to];
-
-    let toOptions = {
-        url: to.url,
-        headers: {
-            Authorization: 'Basic ' + Buffer.from(`${to.user}:${to.pwd}`).toString('base64'),
-            'content-type': 'multipart/form-data',
-            'accept': '*/*'
-        }
-    }
-
-    /**
-     * Sync Process 
-     * If taxonomy is undefined then we don't sync that section.
-     * 
-     * 1) We collect media if the taxonomy is undefined or includes media, pages, posts.
-     * 2) We only collect settings if the taxonomy is undefined or it's set to settings.
-     * 3) We only collect pages if the taxonomy is undefined or it's set to pages.
-     * 4) We only collect posts if the taxonomy is undefined or it's set to posts.
-     * 5) We only collect menus if the taxonomy is undefined or it's set to menus.
-     *    - We also collect menu items if menus are collected.
-     */
-    let settings = [];
-    let mediaLibrary = [];
-    let media = [];
-    let pages = [];
-    let posts = [];
-    let menus = [];
-    let menuNavItems = [];
-
-    // Media Library.
-    if( undefined === tax || tax.includes('media', 'pages', 'posts') ){
-        spinner.text = `Collecting Media Library ${from.url}`;
-        mediaLibrary = await getTaxonomies({ 
-                ...fromOptions, 
-                fields: [
-                    'id', 
-                    'source_url', 
-                    'title', 
-                    'caption', 
-                    'alt_text', 
-                    'date',
-                    'mime_type',
-                    'post',
-                    'media_details'
-                ],
-                include: tax && tax.includes('media') && include ? include.join(',') : null
-            }, 
-            'media'
-        );
-    }
-
-    // Site Settings.
-    if( undefined === tax || tax.includes('settings') ){
-        spinner.text = `Collecting Site Settings from ${from.url}`;
-        settings = await getTaxonomies({
-            ...fromOptions,
-            fields: [
-                'title',
-                'description',
-                'show_on_front',
-                'page_on_front',
-                'posts_per_page'
-            ],
-        }, 'settings')
-        
-    }
-
-    // Pages.
-    if( undefined === tax || tax.includes('pages') ){
-        // get all pages/posts
-        spinner.text = `Collecting pages from ${from.url}`;
-        pages = await getTaxonomies({
-                ...fromOptions, 
-                orderby: 'parent',
-                embed: true,
-                include: tax && include ? include.join(',') : null
-            }, 
-            'pages'
-        );
-
-        // we only do this if specific ids were requested.
-        if( include ){
-            // if we have parent ids, we have to collect any parent items.
-            pages = await getParentItems( 
-                pages, 
-                fromOptions, 
-                'pages'
-            ) 
-        }
-    }
-
-    // Posts.
-    if( undefined === tax || tax.includes('posts') ){
-        // get all pages/posts
-        spinner.text = `Collecting all posts from ${from.url}`;
-        posts = await getTaxonomies({
-                ...fromOptions, 
-                orderby: 'parent',
-                include: tax && include ? include.join(',') : null
-            }, 
-            'posts'
-        );
-
-        // we only do this if specific ids were requested.
-        if( include ){
-            // if we have parent ids, we have to collect any parent items.
-            posts = await getParentItems( 
-                posts, 
-                fromOptions, 
-                'posts'
-            ) 
-        }
-    }
-
-    /**
-     * Media Library Handling
-     * 
-     * We iterate thru the media library to identify which media should be synced.
-     * 1) attached media items by default are only possible on pages.
-     * 2) featured media by default are only possible on posts.
-     * 3) save any linked media in the content of pages and posts.
-     */
-    for( let m of mediaLibrary ){
-        // remove any new line characters.
-        m.source_url = m.source_url.replace('\n','');
-
-        // check if the media is attached to a page.
-        // if tax is undefined, we collect all media attached to posts and pages.
-        // if tax is defined, if include is undefined or media is matches post/page, we collect the media.
-        if( ( ! tax && m.post ) ||
-            ( tax && 
-                ( undefined === include || include.includes( m.id.toString() ) )
-            ) ){
-            media.push( m );
-
-            // we don't have to check any further.
-            continue;
-        }
-
-        for( let p of [].concat( pages, posts ) ){
-            // if the media is featured on a post or linked in the content.
-            if( p.featured_media === m.id ||
-                p.content.rendered.match( new RegExp(`src=”(${m.source_url}.*)”`, 'g') )){
-                    media.push( m );
-                }
-        }
-    }
-
-    // filter any duplicate media.
-    media = media.filter((m, index, self) => { return index === self.findIndex((t) => { return t.id === m.id; })} );
-    let i = 0;
-    
-    // before we can upload media files we have to generate the media blob data.
-    for( let m of media ){
-        if( debug ){
-            i++;
-            spinner.info(`Media ID ${m.id} Collected: ${i}/${media.length}`)
-        }
-        
-        const mediaBlob = await axios.request( 
-            {
-                ...fromOptions,
-                url: m.source_url,
-                responseType: 'arraybuffer'
-            } 
-        )
-        .then( (img) => {  return new Blob([img.data]) })
-        .catch( (error) => {
-            errors.push(`${m.source_url} could not be downloaded.`)
-            return false;
-        });
-        
-        if( mediaBlob ){
-            m.data = mediaBlob;
-        }
-    }
-    
-    // this has to be done after we have the media data.
-    // Lets replace the url references in the content of the pages and posts.
-    for( let p of [].concat( pages, posts ) ){
-        p.content.rendered = p.content.rendered.replace( new RegExp(from.url, 'g'), to.url );
-    }
-
-    
-    // Menu and Nav Items.
-    if( undefined === tax || tax.includes('menus')){
-        spinner.text = `Collecting assigned navigation menus from ${from.url}`;
-        // get all menus and navigation links
-        menus = await getTaxonomies({
-            ...fromOptions,
-            fields: [
-                'id',
-                'description',
-                'name',
-                'slug',
-                'meta',
-                'locations'
-            ],
-            include: tax && include ? include.join(',') : null
-            }, 'menus');
-    
-        menuNavItems = await getTaxonomies( 
-            {
-                ...fromOptions,
-                fields: [
-                    'id',
-                    'title',
-                    'url',
-                    'status',
-                    'attr_title',
-                    'description',
-                    'type',
-                    'type_label',
-                    'object',
-                    'object_id',
-                    'parent',
-                    'menu_order',
-                    'target',
-                    'classes',
-                    'xfn',
-                    'meta',
-                    'menus'
-                ],
-                menus: menus.map((menu) => { return menu.id; })
-            }, 
-            'menu-items'
-            )
-
-    }
-
-    /**
-     * Now we have all the data we can begin to create the taxonomies on the target.
-     * 
-     * Import Order is important otherwise missing dependencies will cause errors to trigger
-     * 1) Media
-     * 2) Pages
-     * 3) Posts
-     * 4) Menus & Navigation Links
-     * 5) Settings
-     */
-
-    // Media.
-    if( media ){
-        spinner.text = `Uploading media files to ${to.url}`;
-        await createTaxonomies(
-            media.filter((img) => { return img.data }), 
-            toOptions, 
-            'media', 
-            spinner
-            )
-    }
-
-     // Pages.
-    if( pages ){
-        spinner.text = `Creating all pages to ${to.url}`;
-        await createTaxonomies( pages, toOptions, 'pages', spinner );
-    }
-
-     // Posts.
-    if( posts ){
-        spinner.text = `Creating all posts to ${to.url}`;
-        await createTaxonomies( posts, toOptions, 'posts', spinner );
-    }
-
-    // Menus and Navigation Links.
-    if( menus ){
-        spinner.text = `Reconstructing navigation menus to ${to.url}`;
-        await createTaxonomies(menus, toOptions, 'menus', spinner);
-        await createTaxonomies(menuNavItems, toOptions, 'menu-items', spinner);
-    }
-    
-
-    // Settings.
-    if( settings ){
-        spinner.text = `Updating site settings to ${to.url}`;
-        await createTaxonomies(settings, toOptions, 'settings', spinner);
-    }
-
-    spinner.text = `Sync from ${from.url} to ${to.url} completed successfully.`
-
-};