contentful-lib-helpers/lib/deleteEnvironment.js

Helpers for Contentful's Content Management API

/**
 * Deletes the given Contentful environment, unless it is protected.
 *
 * @param {import("contentful-management/dist/typings/entities/environment").Environment} environment - The environment to delete.
 * @param {number} [verbosityLevel=1] - 0 = NONE, 1 = ERROR, 2 = DEBUG, 3 = INFO
 * @param {string[]} forbiddenEnvironments - An array of environment IDs that are protected and cannot be deleted.
 * @returns {Promise<boolean>} - True if the environment was successfully deleted, false otherwise.
 *
 * @example
 *
 * Usage:
 * import contentfulManagement from 'contentful-management'
 * const environment = await getEnvironment(contentfulManagement, 'access-token', 'space-id', 'environment-id')
 *
 * // Deleting an environment with the default configuration
 * const result = await deleteEnvironment(environment)
 * // Deleting an environment with custom configuration
 * const result = await deleteEnvironment(environment, 2, ['test', 'prod'])
 */
export async function deleteEnvironment(
  environment,
  verbosityLevel = 1,
  forbiddenEnvironments = ['dev', 'uat', 'staging', 'master']
) {
  const environmentId = environment?.sys?.id ?? null

  if (forbiddenEnvironments.includes(environmentId)) {
    verbosityLevel > 0 &&
      console.error(
        `@@/ERROR: Environment '${environmentId}' is protected and cannot be deleted.`
      )
    return false
  }

  try {
    if (environment === null) {
      verbosityLevel > 0 &&
        console.error(
          `@@/ERROR: Cannot perform 'delete' on an invalid Environment '${environmentId}'.`
        )
      return false
    }

    verbosityLevel > 2 &&
      console.log(`##/INFO: Deleting environment '${environmentId}'.`)

    await environment?.delete()

    verbosityLevel > 1 &&
      console.log(`%%/DEBUG: Environment '${environmentId}' was deleted.`)

    return true
  } catch (error) {
    verbosityLevel > 0 &&
      console.error(
        `@@/ERROR: Error deleting environment '${environmentId}': ${error}`
      )
  }

  return false
}