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

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

@@ -0,0 +1,197 @@
+const { Command, flags } = require('@contentstack/cli-command');
+const { start } = require('../../../producer/publish-edits');
+const store = require('../../../util/store.js');
+// eslint-disable-next-line node/no-extraneous-require
+const { cliux } = require('@contentstack/cli-utilities');
+const configKey = 'publish_edits_on_env';
+const { prettyPrint, formatError } = require('../../../util');
+const { getStack } = require('../../../util/client.js');
+const { printFlagDeprecation } = require('@contentstack/cli-utilities');
+let config;
+
+class PublishModifiedCommand extends Command {
+  async run() {
+    const entryEditsFlags = this.parse(PublishModifiedCommand).flags;
+    entryEditsFlags.retryFailed = entryEditsFlags['retry-failed'] || entryEditsFlags.retryFailed || false;
+    entryEditsFlags.contentTypes = entryEditsFlags['content-types'] || entryEditsFlags.contentTypes;
+    entryEditsFlags.bulkPublish = entryEditsFlags['bulk-publish'] || entryEditsFlags.bulkPublish;
+    entryEditsFlags.sourceEnv = entryEditsFlags['source-env'] || entryEditsFlags.sourceEnv;
+    delete entryEditsFlags['retry-failed'];
+    delete entryEditsFlags['content-types'];
+    delete entryEditsFlags['bulk-publish'];
+    delete entryEditsFlags['source-env'];
+
+    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 cliux.prompt('Please enter the management token alias to be used');
+        }
+        updatedFlags.bulkPublish = updatedFlags.bulkPublish !== 'false';
+        // Validate management token alias.
+        try {
+          this.getToken(updatedFlags.alias);
+        } catch (error) {
+          this.error(`The configured management token alias ${updatedFlags.alias} has not been added yet. Add it using 'csdx auth:tokens:add -a ${updatedFlags.alias}'`, { exit: 2 })
+        }
+        config = {
+          alias: updatedFlags.alias,
+          host: this.region.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;
+    }
+    return cliux.confirm('Do you want to continue with this configuration ? [yes or no]');
+  }
+}
+
+PublishModifiedCommand.description = `Publish edited entries from a specified content type to the given locales and environments
+The publish-modified command is used to publish entries from the specified content types, to the
+specified environments and locales
+
+Note: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the command successfully
+But, if retry-failed flag is set, then only a logfile is required
+`;
+
+PublishModifiedCommand.flags = {
+  alias: flags.string({ char: 'a', description: 'Alias(name) for the management token' }),
+  retryFailed: flags.string({
+    char: 'r',
+    description: 'Retry publishing failed entries from the logfile (optional, overrides all other flags)',
+    hidden: true,
+    parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']),
+  }),
+  'retry-failed': flags.string({
+    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 to publish the entries",
+    hidden: true,
+    parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']),
+  }),
+  'bulk-publish': flags.string({
+    description:
+      "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
+    default: 'true',
+  }),
+  sourceEnv: flags.string({
+    char: 's',
+    description: 'Environment from which edited entries will be published',
+    hidden: true,
+    parse: printFlagDeprecation(['-s', '--sourceEnv'], ['--source-env']),
+  }),
+  'source-env': flags.string({
+    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,
+    parse: printFlagDeprecation(['-t', '--contentTypes'], ['--content-types']),
+    hidden: true,
+  }),
+  'content-types': flags.string({
+    description: 'The Contenttypes which will be checked for edited entries',
+    multiple: true,
+  }),
+  locales: flags.string({
+    char: 'l',
+    description: 'Locales where edited entries will be published',
+    multiple: true,
+    parse: printFlagDeprecation(['-l'], ['--locales']),
+  }),
+  environments: flags.string({ char: 'e', description: 'Destination environments', multiple: true }),
+  config: flags.string({ char: 'c', description: 'Path to the config file' }),
+  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 (by default the main branch is selected)',
+    parse: printFlagDeprecation(['-B'], ['--branch']),
+  }),
+};
+
+PublishModifiedCommand.examples = [
+  'General Usage',
+  'csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [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:stacks:publish-configure -a [ALIAS]`',
+  'csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]',
+  'csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]',
+  '',
+  'Using --retry-failed',
+  'csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]',
+  'csdx cm:entries:publish-modified -r [LOG FILE NAME]',
+  '',
+  'Using --branch',
+  'csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]',
+];
+
+PublishModifiedCommand.aliases = ['cm:bulk-publish:entry-edits']
+
+PublishModifiedCommand.usage = 'cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]'
+
+module.exports = PublishModifiedCommand;

package/src/commands/cm/entries/publish-non-localized-fields.js

@@ -0,0 +1,208 @@
+const { Command, flags } = require('@contentstack/cli-command');
+const { start } = require('../../../producer/nonlocalized-field-changes');
+const store = require('../../../util/store.js');
+const { cliux } = require('@contentstack/cli-utilities');
+const configKey = 'nonlocalized_field_changes';
+const { prettyPrint, formatError } = require('../../../util');
+const { getStack } = require('../../../util/client.js');
+const { printFlagDeprecation } = require('@contentstack/cli-utilities');
+let config;
+
+class NonlocalizedFieldChangesCommand extends Command {
+  async run() {
+    const nonlocalizedFieldChangesFlags = this.parse(NonlocalizedFieldChangesCommand).flags;
+    nonlocalizedFieldChangesFlags.retryFailed =
+      nonlocalizedFieldChangesFlags['retry-failed'] || nonlocalizedFieldChangesFlags.retryFailed || false;
+    nonlocalizedFieldChangesFlags.bulkPublish =
+      nonlocalizedFieldChangesFlags['bulk-publish'] || nonlocalizedFieldChangesFlags.bulkPublish;
+    nonlocalizedFieldChangesFlags.sourceEnv =
+      nonlocalizedFieldChangesFlags['source-env'] || nonlocalizedFieldChangesFlags.sourceEnv;
+    nonlocalizedFieldChangesFlags.contentTypes =
+      nonlocalizedFieldChangesFlags['content-types'] || nonlocalizedFieldChangesFlags.contentTypes;
+
+    delete nonlocalizedFieldChangesFlags['retry-failed'];
+    delete nonlocalizedFieldChangesFlags['bulk-publish'];
+    delete nonlocalizedFieldChangesFlags['source-env'];
+    delete nonlocalizedFieldChangesFlags['content-types'];
+
+    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;
+        // Validate management token alias.
+        try {
+          this.getToken(updatedFlags.alias);
+        } catch (error) {
+          this.error(
+            `The configured management token alias ${updatedFlags.alias} has not been added yet. Add it using 'csdx auth:tokens:add -a ${updatedFlags.alias}'`,
+            { exit: 2 },
+          );
+        }
+        config = {
+          alias: updatedFlags.alias,
+          host: this.region.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;
+    }
+    return cliux.confirm('Do you want to continue with this configuration ? [yes or no]');
+
+  }
+}
+
+NonlocalizedFieldChangesCommand.description = `Publish non-localized fields for the given content types, from a particular source environment to the specified environments
+The non-localized field changes command is used to publish non-localized field changes from the given content types to the specified environments
+
+Note: Content types, Environments and Source Environment are required to execute this command successfully.
+But, if retryFailed flag is set, then only a logfile is required`;
+
+NonlocalizedFieldChangesCommand.flags = {
+  alias: flags.string({
+    char: 'a',
+    description: 'Alias(name) for the management token',
+  }),
+  'retry-failed': flags.string({
+    description: 'Retry publishing failed entries from the logfile',
+  }),
+  'bulk-publish': flags.string({
+    description:
+      "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
+    default: 'true',
+  }),
+  'source-env': flags.string({
+    description: 'Source Environment',
+  }),
+  'content-types': flags.string({
+    description: 'The Contenttypes from which entries will be published',
+    multiple: true,
+  }),
+  environments: flags.string({
+    char: 'e',
+    description: 'Destination environments',
+    multiple: true,
+  }),
+  config: flags.string({
+    char: 'c',
+    description: 'Path to the config file',
+  }),
+  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 (by default the main branch is selected)',
+    parse: printFlagDeprecation(['-B'], ['--branch']),
+  }),
+
+  // To be deprecated
+  retryFailed: flags.string({
+    char: 'r',
+    description: 'Retry publishing failed entries from the logfile',
+    hidden: true,
+    parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']),
+  }),
+  bulkPublish: flags.string({
+    char: 'b',
+    description:
+      "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
+    default: 'true',
+    hidden: true,
+    parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']),
+  }),
+  sourceEnv: flags.string({
+    char: 's',
+    description: 'Source Environment',
+    hidden: true,
+    parse: printFlagDeprecation(['-s', '--sourceEnv'], ['--source-env']),
+  }),
+  contentTypes: flags.string({
+    char: 't',
+    description: 'The contenttypes from which entries will be published',
+    multiple: true,
+    hidden: true,
+    parse: printFlagDeprecation(['-t', '--contentTypes'], ['--content-types']),
+  }),
+};
+
+NonlocalizedFieldChangesCommand.examples = [
+  'General Usage',
+  'csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [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:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]',
+  'csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]',
+  '',
+  'Using --retry-failed flag',
+  'csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]',
+  '',
+  'Using --branch flag',
+  'csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]',
+];
+
+NonlocalizedFieldChangesCommand.aliases = ['cm:bulk-publish:nonlocalized-field-changes'];
+
+NonlocalizedFieldChangesCommand.usage = 'cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]'
+
+module.exports = NonlocalizedFieldChangesCommand;

package/src/commands/cm/entries/publish-only-unpublished.js

@@ -0,0 +1,109 @@
+'use strict';
+
+const { Command, flags } = require('@contentstack/cli-command');
+const { printFlagDeprecation } = require('@contentstack/cli-utilities');
+const { publishOnlyUnpublishedService } = require('../../../services/publish-only-unpublished');
+
+class PublishOnlyUnpublished extends Command {
+  async run() {
+    try {
+      await publishOnlyUnpublishedService.apply(this, [PublishOnlyUnpublished]);
+    } catch (error) {
+      this.error(error, { exit: 2 });
+    }
+  }
+}
+
+PublishOnlyUnpublished.description = `Publish unpublished entries from the source environment, to other environments and locales
+The publish-only-unpublished command is used to publish unpublished entries from the source environment, to other environments and locales
+
+Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the command successfully
+But, if retry-failed flag is set, then only a logfile is required
+`;
+
+PublishOnlyUnpublished.flags = {
+  alias: flags.string({ char: 'a', description: 'Alias(name) for the management token' }),
+  retryFailed: flags.string({
+    char: 'r',
+    hidden: true,
+    description: 'Retry publishing failed entries from the logfile',
+    parse: printFlagDeprecation(['--retryFailed', '-r'], ['--retry-failed']),
+  }),
+  'retry-failed': flags.string({
+    description: 'Retry publishing failed entries from the logfile',
+  }),
+  bulkPublish: flags.string({
+    char: 'b',
+    hidden: true,
+    description:
+      "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
+    default: 'true',
+    parse: printFlagDeprecation(['--bulkPublish', '-b'], ['--bulk-publish']),
+  }),
+  'bulk-publish': flags.string({
+    char: 'b',
+    description:
+      "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
+    default: 'true',
+  }),
+  sourceEnv: flags.string({
+    char: 's',
+    hidden: true,
+    description: 'Source Env',
+    parse: printFlagDeprecation(['--sourceEnv', '-s'], ['--source-env']),
+  }),
+  'source-env': flags.string({
+    description: 'Source Env',
+  }),
+  contentTypes: flags.string({
+    char: 't',
+    description: 'The Content-Types from which entries need to be published',
+    multiple: true,
+    hidden: true,
+    parse: printFlagDeprecation(['--contentTypes', '-t'], ['--content-types']),
+  }),
+  'content-types': flags.string({
+    description: 'The Contenttypes from which entries will be published',
+    multiple: true,
+  }),
+  locale: flags.string({
+    hidden: true,
+    char: 'l',
+    description: 'Source locale',
+    parse: printFlagDeprecation(['-l'], ['--locales']),
+  }),
+  locales: flags.string({
+    description: 'Source locale',
+  }),
+  environments: flags.string({ char: 'e', description: 'Destination environments', multiple: true }),
+  config: flags.string({ char: 'c', description: 'Path to the config file' }),
+  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 (by default the main branch is selected)',
+    parse: printFlagDeprecation(['-B'], ['--branch']),
+  }),
+};
+
+PublishOnlyUnpublished.examples = [
+  'General Usage',
+  'csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [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:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]',
+  'csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]',
+  '',
+  'Using --retry-failed',
+  'csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]',
+  '',
+  'Using --branch',
+  'csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]',
+];
+
+PublishOnlyUnpublished.aliases = ['cm:bulk-publish:unpublished-entries'];
+
+PublishOnlyUnpublished.usage = 'cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]';
+
+module.exports = PublishOnlyUnpublished;