@contentstack/cli-cm-bulk-publish 0.1.1-beta.5 → 1.0.1

package/src/commands/cm/bulk-publish/clear.js

@@ -1,65 +0,0 @@
-const fs = require('fs')
-const {cli} = require('cli-ux')
-const {Command, flags} = require('@oclif/command')
-const {getLogsDirPath} = require('../../../util/logger.js')
-
-class ClearCommand extends Command {
-  async run() {
-    const clearFlags = this.parse(ClearCommand).flags
-  	let dirPath = getLogsDirPath()
-    if (clearFlags.list) {
-    	this.listFiles(dirPath)
-    } else if (clearFlags.yes) {
-    	this.rmDir(dirPath, false)
-    } else {
-	    const confirmation = await cli.prompt('Proceed to delete all log files (y/n)?')
-	    if (confirmation) {
-	    	this.rmDir(dirPath, false)
-	    }
-    }
-  }
-
-	rmDir(dirPath, removeSelf) {
-		if (fs.existsSync(dirPath)) {
-			if (removeSelf === undefined) {
-		    removeSelf = true;
-			}
-		  try { var files = fs.readdirSync(dirPath); }
-		  catch(e) { return; }
-		  if (files.length > 0)
-		    for (var i = 0; i < files.length; i++) {
-		      var filePath = dirPath + '/' + files[i];
-		      if (fs.statSync(filePath).isFile())
-		        fs.unlinkSync(filePath);
-		      else
-		        rmDir(filePath);
-		    }
-		  if (removeSelf) {
-		    fs.rmdirSync(dirPath);
-			}
-		  this.log('Log files have been cleared')
-		} else {
-			this.error(`The log directory doesn't exist.`)
-		}
-	}
-
-	listFiles(dirPath) {
-		if (fs.existsSync(dirPath)) {
-			fs.readdir(dirPath, (err, files) => {
-				this.log(files.length)
-			})	
-		} else {
-			this.error(`The log directory doesn't exist.`)
-		}
-	}
-}
-
-ClearCommand.description = `Clear the log folder
-`
-
-ClearCommand.flags = {
-  list: flags.boolean({char: 'l', description: 'List number of log files'}),
-  yes: flags.boolean({char: 'y', description: 'Delete all files without asking for confirmation'})
-}
-
-module.exports = ClearCommand

package/src/commands/cm/bulk-publish/configure.js

@@ -1,44 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const {cli} = require('cli-ux')
-const fs = require('fs')
-const path = require('path')
-let config = require('../../../config/index.js')
-
-class ConfigureCommand extends Command {
-
-  async run() {
-    const configureFlags = this.parse(ConfigureCommand).flags
-
-    if (!configureFlags.alias) {
-      configureFlags.alias = await cli.prompt('Please enter the management token alias to be used')
-    }
-
-    await this.config.runHook('validateManagementTokenAlias', {alias: configureFlags.alias})
-    this.setConfig(configureFlags)
-    this.log('The configuration has been saved successfully.')
-  }
-
-  setConfig({apikey, alias}) {
-    if (alias)
-      config.alias = alias
-    fs.writeFileSync(path.join(process.cwd(), 'config.js'), `module.exports = ${JSON.stringify(config, null, 2)}`)
-  }
-}
-
-ConfigureCommand.description = `Generate configuration template
-The configure command is used for generating a configuration file for bulk-publish script.
-
-Here is a detailed description for all the available flags
-
------------------------------------------------------------------------------------------------------------
---alias or -a : Management token Alias for the stack in use.
-
-EXAMPLE : cm:bulk-publish:configure --alias [MANAGEMENT TOKEN Alias]
-EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
-`
-
-ConfigureCommand.flags = {
-  alias: flags.string({char: 'a', description: 'Management token alias for the stack'}),
-}
-
-module.exports = ConfigureCommand

package/src/commands/cm/bulk-publish/entries.js

@@ -1,131 +0,0 @@
-/* eslint-disable no-console */
-/* eslint-disable node/no-extraneous-require */
-const {Command, flags} = require('@oclif/command')
-const {start} = require('../../../producer/publish-entries')
-const store = require('../../../util/store.js')
-const {cli} = require('cli-ux')
-const configKey = 'publish_entries'
-const {prettyPrint, formatError} = require('../../../util')
-const {getStack} = require('../../../util/client.js')
-let config
-
-class EntriesCommand extends Command {
-  async run() {
-    const entriesFlags = this.parse(EntriesCommand).flags
-    let updatedFlags
-    try {
-      updatedFlags = (entriesFlags.config) ? store.updateMissing(configKey, entriesFlags) : entriesFlags
-    } catch (error) {
-      this.error(error.message, {exit: 2})
-    }
-    if (this.validate(updatedFlags)) {
-      let stack
-      if (!updatedFlags.retryFailed) {
-        if (!updatedFlags.alias) {
-          updatedFlags.alias = await cli.prompt('Provide the alias of the management token to use')
-        }
-        updatedFlags.bulkPublish = updatedFlags.bulkPublish !== 'false'
-        await this.config.runHook('validateManagementTokenAlias', {alias: updatedFlags.alias})
-        config = {
-          alias: updatedFlags.alias,
-          host: this.config.userConfig.getRegion().cma,
-          branch: entriesFlags.branch,
-        }
-        stack = getStack(config)
-      }
-      if (await this.confirmFlags(updatedFlags)) {
-        try {
-          // eslint-disable-next-line no-negated-condition
-          if (!updatedFlags.retryFailed) {
-            await start(updatedFlags, stack, config)
-          } else {
-            await start(updatedFlags)
-          }
-        } catch (error) {
-          let message = formatError(error)
-          this.error(message, {exit: 2})
-        }
-      } else {
-        this.exit(0)
-      }
-    }
-  }
-
-  validate({contentTypes, locales, environments, retryFailed, publishAllContentTypes}) {
-    let missing = []
-    if (retryFailed) {
-      return true
-    }
-
-    if (publishAllContentTypes && contentTypes && contentTypes.length > 0) {
-      this.error('Do not specify contentTypes when publishAllContentTypes flag is set. Please check --help for more details', {exit: 2})
-    }
-
-    if ((!contentTypes || contentTypes.length === 0) && !publishAllContentTypes) {
-      missing.push('Content Types')
-    }
-
-    if (!locales || locales.length === 0) {
-      missing.push('Locales')
-    }
-
-    if (!environments || environments.length === 0) {
-      missing.push('Environments')
-    }
-
-    if (missing.length > 0) {
-      this.error(`${missing.join(', ')} are required for processing this command. Please check --help for more details`, {exit: 2})
-    } else {
-      return true
-    }
-  }
-
-  async confirmFlags(data) {
-    prettyPrint(data)
-    if (data.yes) {
-      return true
-    }
-    const confirmation = await cli.confirm('Do you want to continue with this configuration ? [yes or no]')
-    return confirmation
-  }
-}
-
-EntriesCommand.description = `Publish entries from multiple content-types to multiple environments and locales
-The entries command is used for publishing entries from the specified content types, to the
-specified environments and locales 
-
-Content Types, Environments and Locales are required for executing the command successfully
-But, if retryFailed flag is set, then only a logfile is required
-`
-
-EntriesCommand.flags = {
-  alias: flags.string({char: 'a', description: 'Alias for the management token to be used'}),
-  retryFailed: flags.string({char: 'r', description: 'Retry failed entries from the logfile (optional, overrides all other flags) This flag is used to retry publishing entries that failed to publish in a previous attempt. A log file for the previous session will be required for processing the failed entries'}),
-  bulkPublish: flags.string({char: 'b', description: 'This flag is set to true by default. It indicates that contentstack\'s bulkpublish API will be used for publishing the entries', default: 'true'}),
-  publishAllContentTypes: flags.boolean({char: 'o', description: 'Publish all content-types (optional, cannot be set when contentTypes flag is set)'}),
-  contentTypes: flags.string({char: 't', description: 'The Content-types from which entries need to be published', multiple: true}),
-  locales: flags.string({char: 'l', description: 'Locales to which entries need to be published', multiple: true}),
-  environments: flags.string({char: 'e', description: 'Environments to which entries need to be published', multiple: true}),
-  config: flags.string({char: 'c', description: 'Path for the external config file to be used (A new config file can be generated at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)'}),
-  yes: flags.boolean({char: 'y', description: 'Agree to process the command with the current configuration'}),
-  branch: flags.string({char: 'B', default: 'main', description: 'Specify the branch to fetch the content from (default is main branch)'}),
-}
-
-EntriesCommand.examples = [
-  'General Usage',
-  'csdx cm:bulk-publish:entries -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]',
-  '',
-  'Using --config or -c flag',
-  'Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`',
-  'csdx cm:bulk-publish:entries --config [PATH TO CONFIG FILE]',
-  'csdx cm:bulk-publish:entries -c [PATH TO CONFIG FILE]',
-  '',
-  'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:entries --retryFailed [LOG FILE NAME]',
-  'csdx cm:bulk-publish:entries -r [LOG FILE NAME]',
-  '',
-  'Using --branch or -B flag',
-  'csdx cm:bulk-publish:entries -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -B [BRANCH NAME]',
-]
-
-module.exports = EntriesCommand

package/src/commands/cm/bulk-publish/entry-edits.js

@@ -1,129 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const {start} = require('../../../producer/publish-edits')
-const store = require('../../../util/store.js')
-// eslint-disable-next-line node/no-extraneous-require
-const {cli} = require('cli-ux')
-const configKey = 'publish_edits_on_env'
-const {prettyPrint, formatError} = require('../../../util')
-const {getStack} = require('../../../util/client.js')
-let config
-
-class EntryEditsCommand extends Command {
-  async run() {
-    const entryEditsFlags = this.parse(EntryEditsCommand).flags
-    let updatedFlags
-    try {
-      updatedFlags = (entryEditsFlags.config) ? store.updateMissing(configKey, entryEditsFlags) : entryEditsFlags
-    } catch (error) {
-      this.error(error.message, {exit: 2})
-    }
-    if (this.validate(updatedFlags)) {
-      let stack
-      if (!updatedFlags.retryFailed) {
-        if (!updatedFlags.alias) {
-          updatedFlags.alias = await cli.prompt('Please enter the management token alias to be used')
-        }
-        updatedFlags.bulkPublish = updatedFlags.bulkPublish !== 'false'
-        await this.config.runHook('validateManagementTokenAlias', {alias: updatedFlags.alias})
-        config = {
-          alias: updatedFlags.alias,
-          host: this.config.userConfig.getRegion().cma,
-          branch: entryEditsFlags.branch,
-        }
-        stack = getStack(config)
-      }
-      if (await this.confirmFlags(updatedFlags)) {
-        try {
-          if (!updatedFlags.retryFailed) {
-            await start(updatedFlags, stack, config)
-          } else {
-            await start(updatedFlags)
-          }
-        } catch (error) {
-          let message = formatError(error)
-          this.error(message, {exit: 2})
-        }
-      } else {
-        this.exit(0)
-      }
-    }
-  }
-
-  validate({contentTypes, environments, sourceEnv, locales, retryFailed}) {
-    let missing = []
-    if (retryFailed) {
-      return true
-    }
-
-    if (!contentTypes || contentTypes.length === 0) {
-      missing.push('Content Types')
-    }
-
-    if (!sourceEnv || sourceEnv.length === 0) {
-      missing.push('SourceEnv')
-    }
-
-    if (!environments || environments.length === 0) {
-      missing.push('Environments')
-    }
-
-    if (!locales || locales.length === 0) {
-      missing.push('Locales')
-    }
-
-    if (missing.length > 0) {
-      this.error(`${missing.join(', ')} are required for processing this command. Please check --help for more details`, {exit: 2})
-    } else {
-      return true
-    }
-  }
-
-  async confirmFlags(data) {
-    prettyPrint(data)
-    if (data.yes) {
-      return true
-    }
-    const confirmation = await cli.confirm('Do you want to continue with this configuration ? [yes or no]')
-    return confirmation
-  }
-}
-
-EntryEditsCommand.description = `Publish edited entries from a specified Content Type to given locales and environments
-The entry-edits command is used for publishing entries from the specified content types, to the
-specified environments and locales
-
-Content Type(s), Source Environment, Destination Environment(s) and Locale(s) are required for executing the command successfully
-But, if retryFailed flag is set, then only a logfile is required
-`
-
-EntryEditsCommand.flags = {
-  alias: flags.string({char: 'a', description: 'Alias for the management token to be used'}),
-  retryFailed: flags.string({char: 'r', description: 'Retry publishing failed entries from the logfile (optional, overrides all other flags)'}),
-  bulkPublish: flags.string({char: 'b', description: 'This flag is set to true by default. It indicates that contentstack\'s bulkpublish API will be used for publishing the entries', default: 'true'}),
-  sourceEnv: flags.string({char: 's', description: 'Environment from which edited entries will be published'}),
-  contentTypes: flags.string({char: 't', description: 'The Content-Types which will be checked for edited entries', multiple: true}),
-  locales: flags.string({char: 'l', description: 'Locales to which edited entries need to be published', multiple: true}),
-  environments: flags.string({char: 'e', description: 'Destination environments', multiple: true}),
-  config: flags.string({char: 'c', description: 'Path to config file to be used'}),
-  yes: flags.boolean({char: 'y', description: 'Agree to process the command with the current configuration'}),
-  branch: flags.string({char: 'B', default: 'main', description: 'Specify the branch to fetch the content from (default is main branch)'}),
-}
-
-EntryEditsCommand.examples = [
-  'General Usage',
-  'csdx cm:bulk-publish:entry-edits -t [CONTENT TYPE 1] [CONTENT TYPE 2] -s [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]',
-  '',
-  'Using --config or -c flag',
-  'Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`',
-  'csdx cm:bulk-publish:entry-edits --config [PATH TO CONFIG FILE]',
-  'csdx cm:bulk-publish:entry-edits -c [PATH TO CONFIG FILE]',
-  '',
-  'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:entry-edits --retryFailed [LOG FILE NAME]',
-  'csdx cm:bulk-publish:entry-edits -r [LOG FILE NAME]',
-  '',
-  'Using --branch or -B flag',
-  'csdx cm:bulk-publish:entry-edits -t [CONTENT TYPE 1] [CONTENT TYPE 2] -s [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -B [BRANCH NAME]',
-]
-
-module.exports = EntryEditsCommand

package/src/commands/cm/bulk-publish/nonlocalized-field-changes.js

@@ -1,121 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const {start} = require('../../../producer/nonlocalized-field-changes')
-const store = require('../../../util/store.js')
-const {cli} = require('cli-ux')
-const configKey = 'nonlocalized_field_changes'
-const { prettyPrint, formatError } = require('../../../util')
-const { getStack } = require('../../../util/client.js')
-let config
-
-class NonlocalizedFieldChangesCommand extends Command {
-  async run() {
-    const nonlocalizedFieldChangesFlags = this.parse(NonlocalizedFieldChangesCommand).flags
-    let updatedFlags
-    try {
-      updatedFlags = (nonlocalizedFieldChangesFlags.config) ? store.updateMissing(configKey, nonlocalizedFieldChangesFlags) : nonlocalizedFieldChangesFlags
-    } catch(error) {
-      this.error(error.message, {exit: 2})
-    }
-
-    if (this.validate(updatedFlags)) {
-      let stack
-      if (!updatedFlags.retryFailed) {
-        updatedFlags.bulkPublish = (updatedFlags.bulkPublish === 'false') ? false : true
-        await this.config.runHook('validateManagementTokenAlias', {alias: updatedFlags.alias})
-        config = { 
-          alias: updatedFlags.alias,
-          host: this.config.userConfig.getRegion().cma,
-          branch: nonlocalizedFieldChangesFlags.branch,
-        }
-        stack = getStack(config)
-      }
-      if (await this.confirmFlags(updatedFlags)) {
-        try {
-          if (!updatedFlags.retryFailed) {
-            await start(updatedFlags, stack, config)
-          } else {
-            await start(updatedFlags)
-          }
-        } catch(error) {
-          let message = formatError(error)
-          this.error(message, {exit: 2})
-        }
-      } else {
-        this.exit(0)
-      }
-    }
-  }
-
-  validate({contentTypes, environments, sourceEnv, retryFailed}) {
-    let missing = []
-    if (retryFailed) {
-      return true
-    }
-
-    if (!contentTypes || contentTypes.length === 0) {
-      missing.push('Content Types')
-    }
-
-    if (!sourceEnv) {
-      missing.push('SourceEnv')
-    }
-
-    if (!environments || environments.length === 0) {
-      missing.push('Environments')
-    }
-
-    if (missing.length > 0) {
-      this.error(`${missing.join(', ')} are required for processing this command. Please check --help for more details`, {exit: 2})
-    } else {
-      return true
-    }
-  }
-
-  async confirmFlags(data) {
-    prettyPrint(data)
-    if(data.yes) {
-      return true
-    }
-    const confirmation = await cli.confirm('Do you want to continue with this configuration ? [yes or no]')
-    return confirmation
-  }
-}
-
-NonlocalizedFieldChangesCommand.description = `Publish non-localized-fields for given Content Types, from a particular source environment to specified environments
-The nonlocalized-field-changes command is used for publishing nonlocalized field changes from the given Content Types to
-the specified Environments
-
-Content Types, Environments and Source Environment are required for executing this command successfully.
-But, if retryFailed flag is set, then only a logfile is required
-`
-
-NonlocalizedFieldChangesCommand.flags = {
-  alias: flags.string({char: 'a', description: 'Alias for the management token to be used'}),
-  retryFailed: flags.string({char: 'r', description: 'Retry publishing failed entries from the logfile'}),
-  bulkPublish: flags.string({char: 'b', description: 'This flag is set to true by default. It indicates that contentstack\'s bulkpublish API will be used for publishing the entries', default: 'true'}),
-  sourceEnv: flags.string({char: 's', description: 'Source Environment'}),
-  contentTypes: flags.string({char: 't', description: 'The Content-Types from which entries need to be published', multiple: true}),
-  environments: flags.string({char: 'e', description: 'Destination environments', multiple: true}),
-  config: flags.string({char: 'c', description: 'Path to config file to be used'}),
-  yes: flags.boolean({char: 'y', description: 'Agree to process the command with the current configuration'}),
-  branch: flags.string({char: 'B', default: 'main', description: 'Specify the branch to fetch the content from (default is main branch)'}),
-}
-
-NonlocalizedFieldChangesCommand.examples = [
-  'General Usage',
-  'csdx cm:bulk-publish:nonlocalized-field-changes -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -s [SOURCE ENV]',
-  '',
-  'Using --config or -c flag',
-  'Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`',
-  'csdx cm:bulk-publish:nonlocalized-field-changes --config [PATH TO CONFIG FILE]',
-  'csdx cm:bulk-publish:nonlocalized-field-changes -c [PATH TO CONFIG FILE]',
-  '',
-  'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [LOG FILE NAME]',
-  'csdx cm:bulk-publish:nonlocalized-field-changes -r [LOG FILE NAME]',
-  '',
-  'Using --branch or -B flag',
-  'csdx cm:bulk-publish:nonlocalized-field-changes -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -B [BRANCH NAME] -s [SOURCE ENV]',
-]
-
-module.exports = NonlocalizedFieldChangesCommand

package/src/commands/cm/bulk-publish/revert.js

@@ -1,81 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const {start} = require('../../../producer/revert')
-const store = require('../../../util/store.js')
-const configKey = 'revert'
-const { prettyPrint, formatError } = require('../../../util')
-const { getStack } = require('../../../util/client.js')
-const {cli} = require('cli-ux')
-
-let config
-
-class RevertCommand extends Command {
-  async run() {
-    const revertFlags = this.parse(RevertCommand).flags
-    let updatedFlags
-    try {
-      updatedFlags = (revertFlags.config) ? store.updateMissing(configKey, revertFlags) : revertFlags
-    } catch(error) {
-      this.error(error.message, {exit: 2})
-    }
-    if (this.validate(updatedFlags)) {
-      if(await this.confirmFlags(updatedFlags)) {
-        try {
-          await start(updatedFlags, config)
-        } catch(error) {
-          let message = formatError(error)
-          this.error(message, {exit: 2})
-        }
-      } else {
-        this.exit(0)
-      }
-    }
-  }
-
-  validate({retryFailed, logFile}) {
-    let missing = []
-    if (retryFailed) {
-      return true
-    }
-
-    if (!logFile) {
-      missing.push('Logfile')
-    }
-
-    if (missing.length > 0) {
-      this.error(`${missing.join(', ')} is required for processing this command. Please check --help for more details`, {exit: 2})
-    } else {
-      return true
-    }
-  }
-
-  async confirmFlags(data) {
-    prettyPrint(data)
-    if(data.yes) {
-      return true
-    }
-    const confirmation = await cli.confirm('Do you want to continue with this configuration ? [yes or no]')
-    return confirmation
-  }
-}
-
-RevertCommand.description = `Revert publish operations by using a log file
-The revert command is used for reverting all publish operations performed using bulk-publish script.
-A log file name is required to execute revert command
-`
-
-RevertCommand.flags = {
-  retryFailed: flags.string({char: 'r', description: 'retry publishing failed entries from the logfile'}),
-  logFile: flags.string({char: 'l', description: 'logfile to be used to revert'}),
-}
-
-RevertCommand.examples = [
-  'Using --logFile',
-  'cm:bulk-publish:revert --logFile [LOG FILE NAME]',
-  'cm:bulk-publish:revert -l [LOG FILE NAME]',
-  '',
-  'Using --retryFailed',
-  'cm:bulk-publish:revert --retryFailed [LOG FILE NAME]',
-  'cm:bulk-publish:revert -r [LOG FILE NAME]',
-]
-
-module.exports = RevertCommand