@caweb/cli 1.2.0 → 1.3.1

package/lib/index.js

@@ -0,0 +1,53 @@
+import {
+    wpPrimary,
+    wpGreen,
+    wpRed,
+    wpYellow,
+    withSpinner,
+} from './spinner.js';
+
+import {
+	runCmd,
+    runCLICmds,
+	currentPath,
+    projectPath,
+    appPath
+} from './helpers.js';
+
+import {
+    activateCAWeb,
+    configureCAWeb,
+    downloadSources,
+	configureDivi,
+	isDiviThemeActive,
+	configureWordPress,
+	isMultisite,
+	convertToMultisite,
+	generateHTAccess,
+	getTaxonomies,
+    createTaxonomies
+} from './wordpress/index.js';
+
+export {
+    currentPath,
+    projectPath,
+    appPath,
+    wpPrimary,
+    wpGreen,
+    wpRed,
+    wpYellow,
+    withSpinner,
+	runCmd,
+    runCLICmds,
+    activateCAWeb,
+    configureCAWeb,
+    downloadSources,
+	configureDivi,
+	isDiviThemeActive,
+	configureWordPress,
+	isMultisite,
+	convertToMultisite,
+	generateHTAccess,
+	getTaxonomies,
+    createTaxonomies
+}

package/lib/spinner.js

@@ -1,5 +1,9 @@
+/**
+ * External dependencies
+ */
 import chalk from 'chalk';
 import ora from 'ora';
+import terminalLink from  'terminal-link';
 
 // Colors.
 const boldWhite = chalk.bold.white;
@@ -18,13 +22,16 @@ const withSpinner =
 		// lets combine arguments with options
 		const cmd = args.pop();
 
-		cmd.registeredArguments.forEach(arg => {
-			// get arg from list.
-			let v = args.shift();
-
-			// add arg to options.
-			args[args.length - 1][arg._name] = v;
-		});
+		if( cmd.registeredArguments ){
+			cmd.registeredArguments.forEach(arg => {
+				// get arg from list.
+				let v = args.shift();
+	
+				// add arg to options.
+				args[args.length - 1][arg._name] = v;
+			});
+		}
+		
 
 		// add any global options.
 		args[0] = {
@@ -45,7 +52,25 @@ const withSpinner =
 				process.exit( 0 );
 			},
 			( error ) => {
-				if( error ){
+
+				// Axios Error
+				if( error &&
+					'object' === typeof error &&
+					'response' in error &&
+					'request' in error 
+				){
+
+					let { data, status } = error.response;
+					
+					if( 401 === status ){
+						data.message +=  `\nPlease check your ${terminalLink('Application Password', 'https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/')}`;
+					}
+
+					spinner.fail( data.message )
+					process.exit( 1 );
+					
+
+				}else if( error ){
 					// Error is an unknown error. That means there was a bug in our code.
 					spinner.fail(
 						typeof error === 'string' ? error : error.message
@@ -53,10 +78,13 @@ const withSpinner =
 					// Disable reason: Using console.error() means we get a stack trace.
 					console.error( error );
 					process.exit( 1 );
+
 				}else{
 					spinner.fail( 'An unknown error occurred.' );
 					process.exit( 1 );
+
 				}
+
 			}
 		);
 	};

package/lib/wordpress/api.js

@@ -0,0 +1,392 @@
+/**
+ * External dependencies
+ */
+import path from 'path';
+import axios from 'axios';
+import terminalLink from  'terminal-link';
+
+
+/**
+ * Internal dependencies
+ */
+import {
+    projectPath,
+    runCmd
+} from '../index.js';
+
+const endpoint = '/wp-json/wp/v2';
+const requestDelay = 1000; // we wait 1 second between requests
+
+
+const sleep = (waitTimeInMs) => new Promise(resolve => setTimeout(resolve, waitTimeInMs));
+
+function processData( data ){
+    /**
+     * If wpautop is enabled and data contains Divi shortcodes, 
+     * WordPress will automatically add an opening/closing p tag that needs to be removed.
+     * @link https://developer.wordpress.org/reference/functions/wpautop/
+    */
+    if( data.includes('et_pb_section') && 
+        data.startsWith('<p>') &&
+        data.endsWith('</p>\n')
+    ){
+        data = data.substring(3, data.length - 5)
+    }
+    return data
+        .replace(/(&#8221;)|(&#8243;)|(&#8220;)/g, '') // replace double encoding
+        .replace(/(\s{2,})/g, ' ') // replace misc spacing // &#8220;
+
+}
+
+function processUrlParam( param ){
+    return ( Array === typeof param ? param.join(',') : param )
+}
+
+/**
+ * Make Requests to WordPress Rest API and return different taxonomy results.
+ * 
+ * 
+ * @async
+ * @param {Object} request Data to pass to Axios request.
+ * @param {string} [tax='pages'] Taxonomy of the request made. Default pages, available choices: pages,posts,menus,menu-items,settings,media
+ * @returns {unknown}
+ */
+async function getTaxonomies( request, tax = 'pages' ){
+    const fields = request.fields ? request.fields : [
+        'id',
+        'type',
+        'alt_text',
+        'caption', 
+        'slug',
+        'title',
+        'source_url',
+        'mime_type',
+        'content',
+        'date',
+        'date_gmt',
+        'status',
+        'featured_media',
+        'comment_status',
+        'ping_status',
+        'template',
+        'format',
+        'categories',
+        'tags',
+        'meta',
+    ];
+
+    let urlParams = [
+        'order=asc'
+    ]
+
+
+    // if fields are passed
+    if( fields.length && 'all' !== fields ){
+        urlParams.push( `_fields=${ fields.join(',')}` );
+    }
+    
+
+    // if no request is added default to GET
+    if( ! request.method ){
+        request.method = 'GET'
+    }
+
+    // if parent argument 
+    if( request.parent ){
+        urlParams.push( `parent=` + processUrlParam( request.parent ))
+    }
+
+    // if include argument 
+    if( request.include ){
+        urlParams.push( `include=` + processUrlParam( request.include ))
+    }
+
+    // if menus argument 
+    if( request.menus ){
+        urlParams.push( 'menus=' + processUrlParam( request.menus ) );
+    }
+
+    // if per page argument.
+    urlParams.push( 'per_page=' + request.per_page ? request.per_page : '100' )
+
+
+    // if posts_per_page argument.
+    urlParams.push( 'posts_per_page=' + request.posts_per_page ? request.posts_per_page : '10' )
+
+
+    let collection = [];
+    let results = false;
+    
+    /**
+     * Results are capped to 100 max per page
+     * in order to return all results, we make the same requests and pass the page parameter.
+     * @see https://developer.wordpress.org/rest-api/using-the-rest-api/pagination/
+     * @type {number}
+    */
+    let page = 1;
+
+    do{
+        
+        results = await axios.request(
+            {
+                ...request,
+                url: `${request.url}${endpoint}/${tax}?` + urlParams.join('&') + `&page=${page}`
+            }
+        ).then(
+            (res) => { 
+                // if no data or empty data return false.
+                if( ! res.data || ( 'object' === typeof res.data && ! Object.entries(res.data).length ) ){
+                    return false;
+                }
+
+                // add results to collection
+                collection = collection.concat( res.data );
+                return true
+        }).catch( 
+            (error) => {
+                return false
+            }
+        );
+
+        // settings taxonomies will always return results regardless of the page parameter.
+        // so we return false after the first request
+        if( 'settings' === tax ){
+            break;
+        }
+
+        page++;
+    }while( results )
+   
+    
+    return collection;
+}
+
+async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
+    // if no request is added default to POST
+    if( ! request.method ){
+        request.method = 'POST'
+    }
+
+    let collection = [];
+
+    for( let obj of taxData ){
+        // endpoint url.
+        let url = `${request.url}${endpoint}/${tax}`;
+        let existingID = false;
+
+        // in order to maintain ID's, we have to use the cli, the REST API doesn't allow passing the id.
+        if( obj.id ){
+            // first we check if the ID exist
+            let idExists = await axios.request(
+                {   
+                    ...request, 
+                    method: 'GET',
+                    url: `${url}/${ obj.id }`
+                } 
+                )
+                .then((res) => { return res.data.id })
+                .catch(error => {return false;})
+
+            // for menus if ID doesn't exist we also check for matching slug
+            // if a menu with a matching slug exists we return that id instead.
+            if( 'menus' === tax && ! idExists ){
+                idExists = await axios.request(
+                    {   
+                        ...request, 
+                        method: 'GET',
+                        url: `${url}/?slug=${ obj.slug }`
+                    } 
+                    )
+                    .then((res) => { return res.data[0].id })
+                    .catch(error => {return false;})
+
+            }
+
+            /**
+             * if the ID doesn't exist we save it so we can update via CLI later on.
+             * if it does exist update endpoint url so we update the existing item.
+             */
+            if( ! idExists ){
+                existingID = obj.id;
+            }else{
+                url = `${url}/${ obj.id }`;
+            }
+
+            // id has to be deleted.        
+            delete obj.id;
+        }
+
+        // process properties
+        if( obj.content && obj.content.rendered ){
+            obj.content = processData(obj.content.rendered);
+        }
+        
+        if( obj.title && obj.title.rendered ){
+            obj.title = processData(obj.title.rendered);
+        }
+
+        if( obj.caption && obj.caption.rendered ){
+            obj.caption = processData(obj.caption.rendered);
+        }
+
+        // make WordPress REST API request.
+        let results = await axios.request({
+                ...request,
+                data: 'media' === tax ? createMediaItem(obj) : obj,
+                url
+            })
+            .then( async (res) => { return res.data; } )
+
+            
+        /**
+         * if the obj had an existing ID that didn't exist
+         */
+        if( existingID ){
+            let post_tbl = 'wp_posts';
+            let post_meta_tbl = 'wp_postmeta';
+            let term_taxonomy_tbl = 'wp_term_taxonomy';
+            let terms_tbl = 'wp_terms';
+            
+            const cmd = [
+                path.join(projectPath, 'bin', 'wp-cli.phar'),
+                `--ssh=${request.ssh}`,
+                '--skip-themes',
+                `--url=${new URL(request.url).origin}`
+            ];
+            
+            // if taxonomy is page/post/media.
+            if( ['pages', 'posts', 'media'].includes(tax) ){
+
+
+                /**
+                 * Since the REST API doesn't detected trashed posts/pages.
+                 * We have to do a drop before we can do an update.
+                 * Since trashed posts/pages stay in the database
+                 */
+                // drop post
+                /*await runCmd(
+                    'php',
+                    [
+                        ...cmd,
+                        '--skip-column-names',
+                        `db query 'DELETE FROM ${post_tbl} WHERE ID=${existingID}'`,
+                    ]
+                )
+
+                // drop post meta.
+                await runCmd(
+                    'php',
+                    [
+                        ...cmd,
+                        '--skip-column-names',
+                        `db query 'DELETE FROM ${post_meta_tbl} WHERE post_id=${existingID}'`,
+                    ]
+                )*/
+
+                // now we can update the new ID with the existing ID.
+                await runCmd(
+                    'php',
+                    [
+                        ...cmd,
+                        '--skip-column-names',
+                        `db query 'UPDATE ${post_tbl} SET ID=${existingID}  WHERE ID=${results.id}'`,
+                    ]
+                )
+                // update post meta.
+                await runCmd(
+                    'php',
+                    [
+                        ...cmd,
+                        '--skip-column-names',
+                        `db query 'UPDATE ${post_meta_tbl} SET post_id=${existingID}  WHERE post_id=${results.id}'`,
+                    ]
+                )
+
+            // if taxonomy is menu.
+            }else if( 'menus' === tax ){
+                 // update the terms table.
+                 await runCmd(
+                    'php',
+                    [
+                        ...cmd,
+                        '--skip-column-names',
+                        `db query 'UPDATE ${terms_tbl} SET term_id=${existingID} WHERE term_id=${results.id}'`,
+                    ]
+                )
+
+                // update the term taxonomy table.
+                await runCmd(
+                    'php',
+                    [
+                        ...cmd,
+                        '--skip-column-names',
+                        `db query 'UPDATE ${term_taxonomy_tbl} SET term_taxonomy_id=${existingID},term_id=${existingID} WHERE term_id=${results.id}'`,
+                    ]
+                )
+
+                /**
+                 * Menus are also stored under nav_menu_locations in the the option theme_mods_<theme_name>
+                 * for each location we patch that nav_menu_locations key with the correct ID
+                 * 
+                 * @todo remove hardcoding of theme name
+                 */
+                results.locations.map( async (location) => {
+                    await runCmd(
+                        'php',
+                        [
+                            ...cmd,
+                            'option patch update',
+                            `theme_mods_CAWeb`,  
+                            'nav_menu_locations',
+                            location,
+                            existingID
+                        ]
+                    )
+                })
+                
+            }
+            
+            // update the API results ID, back to the existing ID from earlier.
+            results.id = existingID;
+        }
+
+        // add results to collection
+        collection = collection.concat( results );
+
+        let p = tax.charAt(0).toUpperCase() + tax.substring(1, tax.length - ( tax.endsWith('s') ? 1 : 0 ) );
+
+        if( undefined !== results && results.id ){
+            spinner.info(`${p}: ${results.id} was created.`);
+        }
+        
+    }
+
+
+}
+
+function createMediaItem( media ){
+    
+    let fd = new FormData();
+    let featureMediaFile = new File(
+        [
+            media.data
+        ], 
+        media.source_url.split('/').pop(), 
+        {
+            type: media.mime_type
+        }
+    );
+    fd.append('file', featureMediaFile );
+    fd.append('title', media.title);
+    fd.append('caption', media.caption);
+    fd.append('alt_text', media.alt_text);
+    fd.append('date', media.date);
+
+    return fd;
+}
+
+
+export {
+    getTaxonomies,
+    createTaxonomies
+}

package/lib/{caweb.js → wordpress/caweb.js}

@@ -7,7 +7,7 @@ import retry from '@wordpress/env/lib/retry.js';
  * Internal dependencies
  */
 import { CAWEB_OPTIONS } from'./options.js';
-import { runCLICmds } from'./utils.js';
+import { runCLICmds } from'../helpers.js';
 import { isMultisite } from'./wordpress.js';
 import { configureDivi } from'./divi.js';
 

package/lib/{divi.js → wordpress/divi.js}

@@ -1,7 +1,7 @@
 /**
  * Internal dependencies
  */
-import { runCLICmds } from './utils.js';
+import { runCLICmds } from '../helpers.js';
 import { DIVI_OPTIONS } from './options.js';
 
 

package/lib/{download-sources.js → wordpress/download-sources.js}

@@ -29,81 +29,6 @@ const pipeline = util.promisify( stream.pipeline );
 const extractZip = util.promisify( zip );
 const rimraf = util.promisify( rim );
 
-/**
- * Download CAWeb Resources.
- * 
- * @param {Object}   spinner The spinner object to show progress.
- * @return {WPConfig} The config object we've loaded.
- */
-async function downloadSources( 
-	{ 
-		spinner,
-		config
-	}  
-	) {
-	const progresses = {};
-	const getProgressSetter = ( id ) => ( progress ) => {
-		progresses[ id ] = progress;
-		spinner.text =
-			`Downloading ${id}.\n` +
-			Object.entries( progresses )
-				.map(
-					( [ key, value ] ) =>
-						`  - ${ key }: ${ ( value * 100 ).toFixed( 0 ) }/100%`
-				)
-				.join( '\n' );
-	};
-
-	const { workDirectoryPath } = config;
-	const { development: dev, tests: test } = config.env;
-
-	let pluginDir = path.resolve(workDirectoryPath, 'plugins');
-	let themeDir = path.resolve(workDirectoryPath, 'themes');
-
-	let sources = dowloadPlugins(pluginDir);
-
-	// Add Divi Theme and plugin to sources.
-	if( (undefined !== dev.config.ET_USERNAME && 
-		undefined !== dev.config.ET_API_KEY) || 
-		(undefined !== test.config.ET_USERNAME && 
-		undefined !== test.config.ET_API_KEY)
-	){
-		let url = 'https://www.elegantthemes.com/api/api_downloads.php';
-		let user = undefined !== dev.config.ET_USERNAME ? dev.config.ET_USERNAME : test.config.ET_USERNAME;
-		let key = undefined !== dev.config.ET_API_KEY ? dev.config.ET_API_KEY : test.config.ET_API_KEY;
-		
-		// Add Divi sources.
-		sources = sources.concat( [
-			{
-				basename: 'Divi',
-				url: `${url}?api_update=1&theme=Divi&api_key=${key}&username=${user}`,
-				path: path.join(themeDir, 'Divi'),
-				type: 'zip'
-			},
-			{
-				basename: 'Divi Plugin',
-				url: `${url}?api_update=1&theme=divi-builder&api_key=${key}&username=${user}`,
-				path: path.join(pluginDir, 'divi-builder'),
-				type: 'zip'
-			}
-		]);
-	}
-
-	// Ensure plugin/theme directory exists for downloading resources.
-	fs.ensureDir(themeDir);
-	fs.ensureDir(pluginDir);
-
-	 await Promise.all(
-		sources.map( ( source ) =>
-			downloadSource( source, {
-				onProgress: getProgressSetter( source.basename ),
-				spinner,
-			} )
-		)
-	);
-	
-};
-
 /**
  * Downloads the given source if necessary. The specific action taken depends
  * on the source type. The source is downloaded to source.path.
@@ -272,6 +197,77 @@ function dowloadPlugins(pluginDir){
 	]
 }
 
-export {
-	downloadSources
-}
+/**
+ * Download CAWeb Resources.
+ * 
+ * @param {Object}   spinner The spinner object to show progress.
+ * @return {WPConfig} The config object we've loaded.
+ */
+export async function downloadSources( 
+	{ 
+		spinner,
+		config
+	}  
+	) {
+	const progresses = {};
+	const getProgressSetter = ( id ) => ( progress ) => {
+		progresses[ id ] = progress;
+		spinner.text =
+			`Downloading ${id}.\n` +
+			Object.entries( progresses )
+				.map(
+					( [ key, value ] ) =>
+						`  - ${ key }: ${ ( value * 100 ).toFixed( 0 ) }/100%`
+				)
+				.join( '\n' );
+	};
+
+	const { workDirectoryPath } = config;
+	const { development: dev, tests: test } = config.env;
+
+	let pluginDir = path.resolve(workDirectoryPath, 'plugins');
+	let themeDir = path.resolve(workDirectoryPath, 'themes');
+
+	let sources = dowloadPlugins(pluginDir);
+
+	// Add Divi Theme and plugin to sources.
+	if( (undefined !== dev.config.ET_USERNAME && 
+		undefined !== dev.config.ET_API_KEY) || 
+		(undefined !== test.config.ET_USERNAME && 
+		undefined !== test.config.ET_API_KEY)
+	){
+		let url = 'https://www.elegantthemes.com/api/api_downloads.php';
+		let user = undefined !== dev.config.ET_USERNAME ? dev.config.ET_USERNAME : test.config.ET_USERNAME;
+		let key = undefined !== dev.config.ET_API_KEY ? dev.config.ET_API_KEY : test.config.ET_API_KEY;
+		
+		// Add Divi sources.
+		sources = sources.concat( [
+			{
+				basename: 'Divi',
+				url: `${url}?api_update=1&theme=Divi&api_key=${key}&username=${user}`,
+				path: path.join(themeDir, 'Divi'),
+				type: 'zip'
+			},
+			{
+				basename: 'Divi Plugin',
+				url: `${url}?api_update=1&theme=divi-builder&api_key=${key}&username=${user}`,
+				path: path.join(pluginDir, 'divi-builder'),
+				type: 'zip'
+			}
+		]);
+	}
+
+	// Ensure plugin/theme directory exists for downloading resources.
+	fs.ensureDir(themeDir);
+	fs.ensureDir(pluginDir);
+
+	 await Promise.all(
+		sources.map( ( source ) =>
+			downloadSource( source, {
+				onProgress: getProgressSetter( source.basename ),
+				spinner,
+			} )
+		)
+	);
+	
+};