clever-tools 4.4.1 → 4.5.0

package/src/commands/emails.js

@@ -1,156 +0,0 @@
-import {
-  todo_addEmailAddress as addEmailAddress,
-  todo_removeEmailAddress as removeEmailAddress,
-} from '@clevercloud/client/esm/api/v2/user.js';
-import { confirm } from '../lib/prompts.js';
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import { getUserEmailAddresses } from '../models/emails.js';
-import { sendToApi } from '../models/send-to-api.js';
-import { openBrowser } from '../models/utils.js';
-
-/**
- * Show primary and secondary email addresses of the current user
- * @param {object} params The command parameters
- * @param {string} params.options.format The output format
- */
-export async function list(params) {
-  const { format } = params.options;
-  const addresses = await getUserEmailAddresses();
-
-  switch (format) {
-    case 'json': {
-      Logger.printJson(addresses);
-      break;
-    }
-    case 'human':
-    default: {
-      Logger.println('✉️  Primary email address:');
-      Logger.println(` • ${styleText('green', addresses.primary)}`);
-      if (addresses.secondary.length > 0) {
-        Logger.println();
-        Logger.println(`✉️  ${addresses.secondary.length} secondary email address(es):`);
-        addresses.secondary.forEach((address) => Logger.println(` • ${styleText('blue', address)}`));
-      }
-    }
-  }
-}
-
-/**
- * Add a secondary email address to the current user
- * @param {object} params The command parameters
- * @param {Array<string>} params.args
- */
-export async function addSecondary(params) {
-  const [secondaryAddress] = params.args;
-
-  const secondaryAddressEncoded = encodeURIComponent(secondaryAddress);
-  try {
-    await addEmailAddress({ email: secondaryAddressEncoded }).then(sendToApi);
-    Logger.printSuccess(
-      `The server sent a confirmation email to ${secondaryAddress} to validate your secondary address`,
-    );
-  } catch (e) {
-    switch (e?.responseBody?.id) {
-      case 101:
-        throw new Error('This address already belongs to your account');
-      case 550:
-        throw new Error('The format of this address is invalid');
-      case 1004:
-        throw new Error('This address belongs to another account');
-      default:
-        throw e;
-    }
-  }
-}
-
-/**
- * Set the primary email address of the current user
- * @param {object} params The command parameters
- * @param {Array<string>} params.args
- */
-export async function setPrimary(params) {
-  const [newPrimaryAddress] = params.args;
-
-  const addresses = await getUserEmailAddresses();
-
-  if (addresses.primary === newPrimaryAddress) {
-    throw new Error('This address is already the primary one');
-  }
-
-  if (!addresses.secondary.includes(newPrimaryAddress)) {
-    throw new Error('This address must be added as a secondary address before marking it as primary');
-  }
-
-  const newPrimaryEmailEncoded = encodeURIComponent(newPrimaryAddress);
-  await addEmailAddress({ email: newPrimaryEmailEncoded }, { make_primary: true }).then(sendToApi);
-
-  Logger.printSuccess(`Primary address updated to ${newPrimaryAddress} successfully`);
-}
-
-/**
- * Remove a secondary email address from the current user
- * @param {object} params The command parameters
- * @param {Array<string>} params.args
- */
-export async function removeSecondary(params) {
-  const [addressToRemove] = params.args;
-
-  const addresses = await getUserEmailAddresses();
-
-  if (!addresses.secondary.includes(addressToRemove)) {
-    throw new Error("This address is not part of the secondary addresses of the current user, it can't be removed");
-  }
-
-  const addressToRemoveEncoded = encodeURIComponent(addressToRemove);
-  await removeEmailAddress({ email: addressToRemoveEncoded }).then(sendToApi);
-
-  Logger.printSuccess(`Secondary address ${addressToRemove} removed successfully`);
-}
-
-/**
- * Remove all secondary email addresses from the current user
- * @param {object} params The command parameters
- * @param {object} params.options The command options
- * @param {boolean} params.options.yes The user confirmation
- */
-export async function removeAllSecondary(params) {
-  if (!params.options.yes) {
-    await confirm('Are you sure you want to remove all your secondary addresses?', 'No secondary addresses removed');
-  }
-
-  const addresses = await getUserEmailAddresses();
-
-  if (addresses.secondary.length === 0) {
-    Logger.println('No secondary address to remove');
-    return;
-  }
-
-  const results = await Promise.all(
-    addresses.secondary.map((addressToRemove) => {
-      const addressToRemoveEncoded = encodeURIComponent(addressToRemove);
-      return removeEmailAddress({ email: addressToRemoveEncoded })
-        .then(sendToApi)
-        .then(() => [true, addressToRemove])
-        .catch(() => [false, addressToRemove]);
-    }),
-  );
-
-  if (results.every(([isRemoved]) => isRemoved)) {
-    Logger.printSuccess('All secondary addresses were removed successfully');
-  } else {
-    const addressesWithErrors = results
-      .filter(([isRemoved]) => !isRemoved)
-      .map(([_, address]) => address)
-      .join(', ');
-    throw new Error(`Some errors occured while removing these addresses: ${addressesWithErrors}`);
-  }
-}
-
-/**
- * Open the email addresses management page of the Console in your browser
- * @returns {Promise<void>} A promise that resolves when the page is opened
- */
-export function openConsole() {
-  return openBrowser('/users/me/emails', 'Opening the email addresses management page of the Console in your browser');
-}

package/src/commands/env.js

@@ -1,124 +0,0 @@
-import {
-  getAllEnvVars,
-  getAllEnvVarsForAddons,
-  getAllEnvVarsForDependencies,
-  removeEnvVar,
-  updateAllEnvVars,
-  updateEnvVar,
-} from '@clevercloud/client/esm/api/v2/application.js';
-import { toNameEqualsValueString, validateName } from '@clevercloud/client/esm/utils/env-vars.js';
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import * as Application from '../models/application.js';
-import { sendToApi } from '../models/send-to-api.js';
-import * as variables from '../models/variables.js';
-
-export async function list(params) {
-  const { alias, app: appIdOrName, 'add-export': addExportsOption, format } = params.options;
-  const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
-
-  const [envFromApp, envFromAddons, envFromDeps] = await Promise.all([
-    getAllEnvVars({ id: ownerId, appId }).then(sendToApi),
-    getAllEnvVarsForAddons({ id: ownerId, appId }).then(sendToApi),
-    getAllEnvVarsForDependencies({ id: ownerId, appId }).then(sendToApi),
-  ]);
-
-  switch (format) {
-    case 'json': {
-      Logger.printJson({
-        env: envFromApp,
-        fromAddons: envFromAddons.map((addon) => ({
-          addonId: addon.addon_id,
-          addonName: addon.addon_name,
-          env: addon.env,
-        })),
-        fromDependencies: envFromDeps.map((dep) => ({
-          addonId: dep.app_id,
-          addonName: dep.app_name,
-          env: dep.env,
-        })),
-      });
-      break;
-    }
-    case 'shell':
-    case 'human':
-    default: {
-      if (addExportsOption) {
-        Logger.println(styleText('yellow', '`--add-export` option is deprecated. Use `--format shell` instead.'));
-      }
-
-      const addExports = addExportsOption || format === 'shell';
-
-      Logger.println('# Manually set env variables');
-      Logger.println(toNameEqualsValueString(envFromApp, { addExports }));
-
-      envFromAddons.forEach((addon) => {
-        Logger.println('# Addon ' + addon.addon_name);
-        Logger.println(toNameEqualsValueString(addon.env, { addExports }));
-      });
-
-      envFromDeps.forEach((dep) => {
-        Logger.println('# Dependency ' + dep.app_name);
-        Logger.println(toNameEqualsValueString(dep.env, { addExports }));
-      });
-    }
-  }
-}
-
-export async function set(params) {
-  const [envName, value] = params.args;
-  const { alias, app: appIdOrName } = params.options;
-
-  const nameIsValid = validateName(envName);
-  if (!nameIsValid) {
-    throw new Error(`Environment variable name ${envName} is invalid`);
-  }
-
-  const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
-
-  await updateEnvVar({ id: ownerId, appId, envName }, { value }).then(sendToApi);
-
-  Logger.println('Your environment variable has been successfully saved');
-}
-
-export async function rm(params) {
-  const [envName] = params.args;
-  const { alias, app: appIdOrName } = params.options;
-  const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
-
-  await removeEnvVar({ id: ownerId, appId, envName }).then(sendToApi);
-
-  Logger.println('Your environment variable has been successfully removed');
-}
-
-export async function importEnv(params) {
-  const { alias, app: appIdOrName, json } = params.options;
-  const format = json ? 'json' : 'name-equals-value';
-  const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
-
-  const envVars = await variables.readVariablesFromStdin(format);
-  await updateAllEnvVars({ id: ownerId, appId }, envVars).then(sendToApi);
-
-  Logger.println('Environment variables have been set');
-}
-
-export async function importVarsFromLocalEnv(params) {
-  const [envNames] = params.args;
-  const { alias, app: appIdOrName } = params.options;
-
-  for (const envName of envNames) {
-    const nameIsValid = validateName(envName);
-    if (!nameIsValid) {
-      throw new Error(`Environment variable name ${envName} is invalid`);
-    }
-  }
-
-  const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
-
-  for (const envName of envNames) {
-    const value = process.env[envName] || '';
-    await updateEnvVar({ id: ownerId, appId, envName }, { value }).then(sendToApi);
-  }
-
-  Logger.println('Your environment variables have been successfully saved');
-}

package/src/commands/features.js

@@ -1,87 +0,0 @@
-import { EXPERIMENTAL_FEATURES } from '../experimental-features.js';
-import { formatTable } from '../format-table.js';
-import { Logger } from '../logger.js';
-import { getFeatures, setFeature } from '../models/configuration.js';
-
-export async function list(params) {
-  const { format } = params.options;
-
-  const featuresConf = await getFeatures();
-  // Add status from configuration file and remove instructions
-  const features = Object.entries(EXPERIMENTAL_FEATURES).map(([id, feature]) => {
-    const enabled = featuresConf[id] === true;
-    return {
-      id,
-      status: feature.status,
-      description: feature.description,
-      enabled,
-    };
-  });
-
-  // For each feature, print the object with the id, status, description and enabled
-  switch (format) {
-    case 'json': {
-      Logger.printJson(features);
-      break;
-    }
-    case 'human':
-    default: {
-      const headers = ['ID', 'STATUS', 'DESCRIPTION', 'ENABLED'];
-
-      Logger.println(
-        formatTable([
-          headers,
-          ...features.map((feature) => [feature.id, feature.status, feature.description, feature.enabled]),
-        ]),
-      );
-    }
-  }
-}
-
-export async function info(params) {
-  const { feature } = params.namedArgs;
-  const availableFeatures = Object.keys(EXPERIMENTAL_FEATURES);
-
-  if (!availableFeatures.includes(feature)) {
-    throw new Error(`Unavailable feature: ${feature}`);
-  }
-
-  Logger.println(EXPERIMENTAL_FEATURES[feature].instructions);
-}
-
-export async function enable(params) {
-  const { features } = params.namedArgs;
-  const availableFeatures = Object.keys(EXPERIMENTAL_FEATURES);
-
-  const unknownFeatures = features.filter((feature) => !availableFeatures.includes(feature));
-  if (unknownFeatures.length > 0) {
-    throw new Error(`Unavailable feature(s): ${unknownFeatures.join(', ')}`);
-  }
-
-  for (const featureName of features) {
-    await setFeature(featureName, true);
-    Logger.println(`Experimental feature '${featureName}' enabled`);
-  }
-
-  if (features.length === 1) {
-    Logger.println(EXPERIMENTAL_FEATURES[features[0]].instructions);
-  } else {
-    Logger.println();
-    Logger.println("To learn more about these experimental features, use 'clever features info FEATURE_NAME'");
-  }
-}
-
-export async function disable(params) {
-  const { features } = params.namedArgs;
-  const availableFeatures = Object.keys(EXPERIMENTAL_FEATURES);
-
-  const unknownFeatures = features.filter((feature) => !availableFeatures.includes(feature));
-  if (unknownFeatures.length > 0) {
-    throw new Error(`Unavailable feature(s): ${unknownFeatures.join(', ')}`);
-  }
-
-  for (const featureName of features) {
-    await setFeature(featureName, false);
-    Logger.println(`Experimental feature '${featureName}' disabled`);
-  }
-}

package/src/commands/k8s.js

@@ -1,193 +0,0 @@
-import { typewriterLogo } from '../lib/ascii.js';
-import {
-  getK8sCluster,
-  isK8sClusterActive,
-  k8sAddPersistentStorage,
-  k8sCreate,
-  k8sDelete,
-  k8sGetConfig,
-  k8sList,
-} from '../lib/k8s.js';
-import { confirm } from '../lib/prompts.js';
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-
-const DEPLOY_POLL_DELAY_MS = 10000;
-
-export async function create(params) {
-  const clusterName = params.args[0];
-  const orgIdOrName = params.options.org;
-
-  try {
-    const cluster = await k8sCreate(clusterName, orgIdOrName);
-
-    if (params.options.watch) {
-      await typewriterLogo();
-
-      let deployedCluster = cluster;
-      while (deployedCluster.status !== 'ACTIVE' && deployedCluster.status !== 'FAILED') {
-        Logger.println(
-          `⏳ Cluster status: ${styleText('yellow', deployedCluster.status)}. Waiting for ${DEPLOY_POLL_DELAY_MS / 1000}s before checking again...`,
-        );
-        await new Promise((resolve) => setTimeout(resolve, DEPLOY_POLL_DELAY_MS));
-
-        deployedCluster = await getK8sCluster(orgIdOrName, cluster.id);
-      }
-
-      Logger.println('');
-      switch (deployedCluster.status) {
-        case 'ACTIVE':
-          Logger.printSuccess(
-            `Cluster ${styleText('green', `${deployedCluster.name} (${deployedCluster.id})`)} deployed successfully`,
-          );
-          break;
-        case 'FAILED':
-          throw new Error(
-            `Cluster ${styleText('red', `${deployedCluster.name} (${deployedCluster.id})`)} deployment failed`,
-          );
-        default:
-          throw new Error(`Unexpected cluster status: ${deployedCluster.status}`);
-      }
-    } else {
-      Logger.println(`🚀 Cluster ${styleText('white', `${cluster.name} (${cluster.id})`)} is being deployed`);
-    }
-
-    const orgMessageComplement = orgIdOrName ? `--org "${orgIdOrName.orga_id || orgIdOrName.orga_name}"` : '';
-
-    Logger.println('');
-    Logger.println(
-      `You can get its information with ${styleText('blue', `clever k8s get ${cluster.id} ${orgMessageComplement}`)}`,
-    );
-  } catch (error) {
-    if (error.responseBody?.code === 'clever.core.quota-exceeded') {
-      throw new Error(
-        'Failed to create Kubernetes cluster: your quota exceeded, contact support to increase your quota',
-      );
-    } else {
-      throw new Error(error.message);
-    }
-  }
-}
-
-export async function del(params) {
-  const [clusterIdOrName] = params.args;
-  const { org: orgIdOrName, yes: confirmDeletion } = params.options;
-
-  let proceedDeletion;
-  if (confirmDeletion) {
-    proceedDeletion = true;
-  } else {
-    proceedDeletion = await confirm(
-      `Are you sure you want to delete the Kubernetes cluster ${styleText(
-        'blue',
-        clusterIdOrName.addon_name || clusterIdOrName.operator_id,
-      )}?`,
-      'Kubernetes cluster deletion cancelled.',
-    );
-  }
-
-  if (proceedDeletion) {
-    await k8sDelete(orgIdOrName, clusterIdOrName);
-    Logger.printSuccess(
-      `Kubernetes cluster ${styleText('green', clusterIdOrName.addon_name || clusterIdOrName.operator_id)} successfully deleted`,
-    );
-  }
-}
-
-export async function list(params) {
-  const { format, org: orgIdOrName } = params.options;
-  const clusters = await k8sList(orgIdOrName, format);
-
-  switch (format) {
-    case 'json':
-      Logger.printJson(clusters);
-      break;
-    case 'human':
-    default:
-      if (clusters.length === 0) {
-        Logger.println(`🔎 No cluster found, create one with ${styleText('blue', `clever k8s create`)} command`);
-        return;
-      }
-
-      Logger.println(`🔎 Found ${clusters.length} cluster${clusters.length > 1 ? 's' : ''}:`);
-
-      Object.values(clusters).forEach((c) => {
-        Logger.println(`  • ${styleText('white', `${c.name} (${c.id})`)} - ${c.status}`);
-      });
-      break;
-  }
-}
-
-export async function get(params) {
-  const [clusterIdOrName] = params.args;
-  const { format, org: orgIdOrName } = params.options;
-
-  const k8sInfo = await getK8sCluster(orgIdOrName, clusterIdOrName);
-
-  switch (format) {
-    case 'json':
-      Logger.printJson(k8sInfo);
-      break;
-    case 'human':
-    default:
-      console.table({
-        Name: k8sInfo.name,
-        ID: k8sInfo.id,
-        Version: k8sInfo.version,
-        Status: k8sInfo.status,
-      });
-
-      Logger.println('');
-      const orgMessageComplement = orgIdOrName ? `--org "${orgIdOrName.orga_id || orgIdOrName.orga_name}"` : '';
-
-      Logger.println(
-        `Once ACTIVE, get the kubeconfig with ${styleText('blue', `clever k8s get-kubeconfig ${k8sInfo.id} ${orgMessageComplement}`)}`,
-      );
-      break;
-  }
-}
-
-export async function addPersistentStorage(params) {
-  const [clusterIdOrName] = params.args;
-  const orgIdOrName = params.options.org;
-
-  if ((await isK8sClusterActive(orgIdOrName, clusterIdOrName)) === false) {
-    Logger.printInfo(
-      'Persistent storage can only be added to deployed clusters, wait for the deployment to finish and try again',
-    );
-
-    const orgMessageComplement = orgIdOrName ? `--org "${orgIdOrName.orga_id || orgIdOrName.orga_name}"` : '';
-    Logger.println(
-      `Check with ${styleText('blue', `clever k8s get ${clusterIdOrName.addon_name || clusterIdOrName.operator_id} ${orgMessageComplement}`)}`,
-    );
-    return;
-  }
-
-  try {
-    await k8sAddPersistentStorage(orgIdOrName, clusterIdOrName);
-    Logger.printSuccess(
-      `Persistent storage successfully activated on cluster ${styleText('green', clusterIdOrName.addon_name || clusterIdOrName.operator_id)}`,
-    );
-  } catch (error) {
-    Logger.error("Failed to add persistent storage, check if it's not already activated");
-  }
-}
-
-export async function getConfig(params) {
-  const [clusterIdOrName] = params.args;
-  const orgIdOrName = params.options.org;
-
-  if ((await isK8sClusterActive(orgIdOrName, clusterIdOrName)) !== true) {
-    Logger.printInfo(
-      'Kubeconfig can only be retrieved from deployed clusters, wait for the deployment to finish and try again',
-    );
-
-    const orgMessageComplement = orgIdOrName ? `--org "${orgIdOrName.orga_id || orgIdOrName.orga_name}"` : '';
-    Logger.println(
-      `Check with ${styleText('blue', `clever k8s get ${clusterIdOrName.addon_name || clusterIdOrName.operator_id} ${orgMessageComplement}`)}`,
-    );
-    return;
-  }
-
-  console.log(await k8sGetConfig(orgIdOrName, clusterIdOrName));
-}

package/src/commands/keycloak.js

@@ -1,138 +0,0 @@
-import {
-  operatorCheckVersion,
-  operatorList,
-  operatorNgDisable,
-  operatorNgEnable,
-  operatorOpen,
-  operatorOpenLogs,
-  operatorOpenWebUi,
-  operatorPrint,
-  operatorReboot,
-  operatorRebuild,
-  operatorUpdateVersion,
-} from '../lib/operator-commands.js';
-
-/**
- * Check the version of a Keycloak operator
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @param {string} params.options.format The output format
- * @returns {Promise<void>}
- */
-export async function checkVersion(params) {
-  const [addonIdOrName] = params.args;
-  const { format } = params.options;
-  await operatorCheckVersion('keycloak', addonIdOrName, format);
-}
-
-/**
- * Update the version of a Keycloak operator
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @returns {Promise<void>}
- */
-export async function updateVersion(params) {
-  const [addonIdOrName] = params.args;
-  const { target } = params.options;
-  await operatorUpdateVersion('keycloak', target, addonIdOrName);
-}
-
-/**
- * Get the details of a Keycloak operator
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @param {string} params.options.format The output format
- * @returns {Promise<void>}
- */
-export async function get(params) {
-  const [addonIdOrName] = params.args;
-  const { format } = params.options;
-  await operatorPrint('keycloak', addonIdOrName, format);
-}
-
-/**
- * List all Keycloak operators
- * @returns {Promise<void>}
- */
-export async function list(params) {
-  await operatorList('keycloak', params.options.format);
-}
-
-/**
- * Unlink a Keycloak operator from a Network Group
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @returns {Promise<void>}
- * @throws {Error} If the Network Group feature is already disabled
- */
-export async function ngDisable(params) {
-  const [addonIdOrName] = params.args;
-  await operatorNgDisable('keycloak', addonIdOrName);
-}
-
-/**
- * Link a Keycloak operator to a Network Group
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @returns {Promise<void>}
- * @throws {Error} If the Network Group feature is already enabled
- */
-export async function ngEnable(params) {
-  const [addonIdOrName] = params.args;
-  await operatorNgEnable('keycloak', addonIdOrName);
-}
-
-/**
- * Open a Keycloak operator dashboard in the Clever Cloud Console
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @returns {Promise<void>}
- */
-export async function open(params) {
-  const [addonIdOrName] = params.args;
-  await operatorOpen('keycloak', addonIdOrName);
-}
-
-/**
- * Open the Logs section of a Keycloak Operator application in the Clever Cloud Console
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @returns {Promise<void>}
- */
-export async function openLogs(params) {
-  const [addonIdOrName] = params.args;
-  await operatorOpenLogs('keycloak', addonIdOrName);
-}
-
-/**
- * Open the Web UI of a Keycloak Operator application in the Clever Cloud Console
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @returns {Promise<void>}
- */
-export async function openWebUi(params) {
-  const [addonIdOrName] = params.args;
-  await operatorOpenWebUi('keycloak', addonIdOrName);
-}
-
-/**
- * Restart a Keycloak operator
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @returns {Promise<void>}
- */
-export async function reboot(params) {
-  const [addonIdOrName] = params.args;
-  await operatorReboot('keycloak', addonIdOrName);
-}
-
-/**
- * Rebuild a Keycloak operator
- * @param {object} params The command's parameters
- * @param {string} params.args[0] The operator's name or ID
- * @returns {Promise<void>}
- */
-export async function rebuild(params) {
-  const [addonIdOrName] = params.args;
-  await operatorRebuild('keycloak', addonIdOrName);
-}