clever-tools 3.11.0 → 3.13.0

package/src/clever-client/operators.js

@@ -0,0 +1,121 @@
+// TODO: Move this to the Clever Cloud JS Client
+
+/**
+ * GET /v4/addon-providers/addon-{provider}/addons/{realId}
+ * @param {Object} params
+ * @param {String} params.provider
+ * @param {String} params.realId
+ */
+export function getOperator (params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'get',
+    url: `/v4/addon-providers/addon-${params.provider}/addons/${params.realId}`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * POST /v4/addon-providers/addon-{provider}/addons/{realId}/reboot
+ * @param {Object} params
+ * @param {String} params.provider
+ * @param {String} params.realId
+ */
+export function rebootOperator (params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'post',
+    url: `/v4/addon-providers/addon-${params.provider}/addons/${params.realId}/reboot`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * POST /v4/addon-providers/addon-{provider}/addons/{realId}/rebuild
+ * @param {Object} params
+ * @param {String} params.provider
+ * @param {String} params.realId
+ */
+export function rebuildOperator (params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'post',
+    url: `/v4/addon-providers/addon-${params.provider}/addons/${params.realId}/rebuild`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * POST /v4/addon-providers/addon-{provider}/addons/{realId}/networkgroup
+ * @param {Object} params
+ * @param {String} params.provider
+ * @param {String} params.realId
+ */
+export function ngEnableOperator (params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'post',
+    url: `/v4/addon-providers/addon-${params.provider}/addons/${params.realId}/networkgroup`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * POST /v4/addon-providers/addon-{provider}/addons/{realId}/networkgroup
+ * @param {Object} params
+ * @param {String} params.provider
+ * @param {String} params.realId
+ */
+export function ngDisableOperator (params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'delete',
+    url: `/v4/addon-providers/addon-${params.provider}/addons/${params.realId}/networkgroup`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * GET /v4/addon-providers/addon-{provider}/addons/{realId}/version/check
+ * @param {Object} params
+ * @param {String} params.provider
+ * @param {String} params.realId
+ */
+export function versionCheck (params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'get',
+    url: `/v4/addon-providers/addon-${params.provider}/addons/${params.realId}/version/check`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * POST /v4/addon-providers/addon-{provider}/addons/{realId}/version/update
+ * @param {Object} params
+ * @param {String} params.provider
+ * @param {String} params.realId
+ * @param {Object} body
+ */
+export function versionUpdate (params, body) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'post',
+    url: `/v4/addon-providers/addon-${params.provider}/addons/${params.realId}/version/update`,
+    headers: { Accept: 'application/json', 'Content-Type': 'application/json' },
+    // no queryParams
+    body,
+  });
+}

package/src/commands/addon.js

@@ -12,6 +12,7 @@ import { sendToApi } from '../models/send-to-api.js';
 import { toNameEqualsValueString } from '@clevercloud/client/esm/utils/env-vars.js';
 import { resolveAddonId } from '../models/ids-resolver.js';
 import { conf } from '../models/configuration.js';
+import dedent from 'dedent';
 
 const formatTable = initFormatTable();
 
@@ -123,49 +124,49 @@ function displayAddon (format, addon, providerName, message) {
 
   const WIP_PROVIDERS = {
     keycloak: {
-      status: 'beta',
-      postCreateInstructions: [
-        `Learn more about Keycloak on Clever Cloud: ${conf.DOC_URL}/addons/keycloak/`,
-      ].join('\n'),
+      status: '',
+      postCreateInstructions: dedent`
+        Learn more about Keycloak on Clever Cloud: ${conf.DOC_URL}/addons/keycloak/,
+      `,
     },
     kv: {
       status: 'alpha',
-      postCreateInstructions: [
-        colors.yellow('You can easily use Materia KV with \'redis-cli\', with such commands:'),
-        colors.blue(`source <(clever addon env ${addon.id} -F shell)`),
-        colors.blue('redis-cli -h $KV_HOST -p $KV_PORT --tls'),
-        `Learn more about Materia KV on Clever Cloud: ${conf.DOC_URL}/addons/materia-kv/`,
-      ].join('\n'),
+      postCreateInstructions: dedent`
+        ${colors.yellow('You can easily use Materia KV with \'redis-cli\', with such commands:')}
+        ${colors.blue(`source <(clever addon env ${addon.id} -F shell)`)}
+        ${colors.blue('redis-cli -h $KV_HOST -p $KV_PORT --tls')}
+        Learn more about Materia KV on Clever Cloud: ${conf.DOC_URL}/addons/materia-kv/
+      `,
     },
     'addon-matomo': {
-      status: 'beta',
-      postCreateInstructions: [
-        `Learn more about Matomo on Clever Cloud: ${conf.DOC_URL}/addons/matomo/`,
-      ].join('\n'),
+      status: '',
+      postCreateInstructions: dedent`
+        Learn more about Matomo on Clever Cloud: ${conf.DOC_URL}/addons/matomo/
+      `,
     },
     metabase: {
-      status: 'beta',
-      postCreateInstructions: [
-        `Learn more about Metabase on Clever Cloud: ${conf.DOC_URL}/addons/metabase/`,
-      ].join('\n'),
+      status: '',
+      postCreateInstructions: dedent`
+        Learn more about Metabase on Clever Cloud: ${conf.DOC_URL}/addons/metabase/
+      `,
     },
     otoroshi: {
-      status: 'beta',
-      postCreateInstructions: [
-        `Learn more about Otoroshi with LLM on Clever Cloud: ${conf.DOC_URL}/addons/otoroshi/`,
-      ].join('\n'),
+      status: '',
+      postCreateInstructions: dedent`
+        Learn more about Otoroshi with LLM on Clever Cloud: ${conf.DOC_URL}/addons/otoroshi/
+      `,
     },
     'addon-pulsar': {
       status: 'beta',
-      postCreateInstructions: [
-        `Learn more about Pulsar on Clever Cloud: ${conf.DOC_URL}/addons/pulsar/`,
-      ].join('\n'),
+      postCreateInstructions: dedent`
+        Learn more about Pulsar on Clever Cloud: ${conf.DOC_URL}/addons/pulsar/
+      `,
     },
   };
 
   let providerNameToShow = '';
   let statusMessage = '';
-  if (providerName in WIP_PROVIDERS) {
+  if (providerName in WIP_PROVIDERS && WIP_PROVIDERS[providerName].status !== '') {
 
     providerNameToShow = providerName === 'kv'
       ? 'Materia KV'
@@ -206,11 +207,12 @@ function displayAddon (format, addon, providerName, message) {
         const provider = PROVIDERS_WITH_URL[providerName];
         const urlEnv = addon.env.find((entry) => entry.name === provider.urlEnv);
         const urlToShow = urlEnv.value;
+        const urlToShowWithHttps = urlToShow.startsWith('http') ? urlToShow : `https://${urlToShow}`;
 
         if (urlEnv) {
           Logger.println();
           Logger.println(`Your ${provider.name} is starting:`);
-          Logger.println(` - Access it: ${urlToShow.startsWith('http') ? urlToShow : `https://${urlToShow}`}`);
+          Logger.println(` - Access it: ${urlToShowWithHttps}`);
           Logger.println(` - Manage it: ${conf.GOTO_URL}/${addon.id}`);
         }
 
@@ -232,7 +234,11 @@ function displayAddon (format, addon, providerName, message) {
       if (providerName in WIP_PROVIDERS) {
 
         Logger.println();
-        Logger.println(colors.yellow(`/!\\ ${statusMessage}`));
+
+        if (statusMessage !== '') {
+          Logger.println(colors.yellow(`/!\\ ${statusMessage}`));
+        }
+
         Logger.println(WIP_PROVIDERS[providerName].postCreateInstructions);
       }
   }

package/src/commands/cancel-deploy.js

@@ -2,6 +2,7 @@ import * as Application from '../models/application.js';
 import { Logger } from '../logger.js';
 import { getAllDeployments, cancelDeployment } from '@clevercloud/client/esm/api/v2/application.js';
 import { sendToApi } from '../models/send-to-api.js';
+import colors from 'colors/safe.js';
 
 export async function cancelDeploy (params) {
   const { alias, app: appIdOrName } = params.options;
@@ -13,8 +14,6 @@ export async function cancelDeploy (params) {
     throw new Error('There is no ongoing deployment for this application');
   }
 
-  const deploymentId = deployments[0].id;
-  await cancelDeployment({ id: ownerId, appId, deploymentId }).then(sendToApi);
-
-  Logger.println('Deployment cancelled!');
+  await cancelDeployment({ id: ownerId, appId, deploymentId: deployments[0].id }).then(sendToApi);
+  Logger.printSuccess(`Deployment ${colors.bold.green(deployments[0].uuid)} successfully cancelled!`);
 };

package/src/commands/config.js

@@ -1,22 +1,21 @@
-import * as application from '@clevercloud/client/esm/api/v2/application.js';
-
 import * as Application from '../models/application.js';
 import * as ApplicationConfiguration from '../models/application_configuration.js';
+import { Logger } from '../logger.js';
+import colors from 'colors/safe.js';
 
-import { sendToApi } from '../models/send-to-api.js';
+export async function list (params) {
+  const { alias, app: appIdOrName } = params.options;
+  const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
+  const app = await Application.get(ownerId, appId);
+  ApplicationConfiguration.printAllValues(app);
+}
 
 export async function get (params) {
   const [configurationName] = params.args;
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
   const app = await Application.get(ownerId, appId);
-
-  if (configurationName == null) {
-    ApplicationConfiguration.print(app);
-  }
-  else {
-    ApplicationConfiguration.printById(app, configurationName);
-  }
+  ApplicationConfiguration.printValue(app, configurationName);
 }
 
 export async function set (params) {
@@ -24,12 +23,11 @@ export async function set (params) {
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
   const config = ApplicationConfiguration.getById(configurationName);
-
-  if (config != null) {
-    const app = await application.update({ id: ownerId, appId }, { [config.name]: ApplicationConfiguration.parse(config, configurationValue) }).then(sendToApi);
-
-    ApplicationConfiguration.printById(app, configurationName);
-  }
+  const options = {
+    [config.name]: ApplicationConfiguration.parse(config, configurationValue),
+  };
+  const app = await Application.updateOptions(ownerId, appId, options);
+  Logger.printSuccess(`Config ${colors.green(config.id)} successfully updated to ${colors.green(ApplicationConfiguration.formatValue(config, app[config.name]))}!`);
 }
 
 export async function update (params) {
@@ -41,9 +39,7 @@ export async function update (params) {
     throw new Error('No configuration to update');
   }
 
-  const app = await application.update({ id: ownerId, appId }, options).then(sendToApi);
+  const app = await Application.updateOptions(ownerId, appId, options);
 
-  for (const configName of Object.keys(options)) {
-    ApplicationConfiguration.printByName(app, configName);
-  }
+  ApplicationConfiguration.printAllValues(app);
 }

package/src/commands/console.js

@@ -1,8 +1,6 @@
 import * as Application from '../models/application.js';
 import * as AppConfig from '../models/app_configuration.js';
-import { Logger } from '../logger.js';
-import openPage from 'open';
-import { conf } from '../models/configuration.js';
+import { openBrowser } from '../models/utils.js';
 
 export async function openConsole (params) {
   const { alias, app: appIdOrName } = params.options;
@@ -10,17 +8,13 @@ export async function openConsole (params) {
   const { apps } = await AppConfig.loadApplicationConf();
   // If no app is linked or asked, open the Console without any context
   if (apps.length === 0 && !appIdOrName) {
-    Logger.println('Opening the Console in your browser');
-    await openPage(conf.CONSOLE_URL, { wait: false });
+    await openBrowser('/', 'Opening the Console in your browser');
     return;
   }
 
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
   const prefixPath = (ownerId.startsWith('user_')) ? 'users/me' : `organisations/${ownerId}`;
-  const url = `${conf.CONSOLE_URL}/${prefixPath}/applications/${appId}`;
+  const consolePath = `/${prefixPath}/applications/${appId}`;
 
-  Logger.debug(`URL: ${url}`);
-  Logger.println(`Opening the Console in your browser for application ${appId}`);
-
-  await openPage(url, { wait: false });
+  await openBrowser(consolePath, `Opening the Console in your browser for application ${appId}`);
 }

package/src/commands/create.js

@@ -1,7 +1,10 @@
 import path from 'node:path';
+import colors from 'colors/safe.js';
 import * as Application from '../models/application.js';
 import * as AppConfig from '../models/app_configuration.js';
 import { Logger } from '../logger.js';
+import { isGitWorkingDirectoryClean, isInsideGitRepo } from '../models/git.js';
+import { conf } from '../models/configuration.js';
 
 export async function create (params) {
   const { type: typeName } = params.options;
@@ -37,15 +40,7 @@ export async function create (params) {
 
     case 'human':
     default:
-      if (isTask) {
-        Logger.println('Your application has been successfully created as a task!');
-        Logger.println(`The "CC_RUN_COMMAND" environment variable has been set to "${taskCommand}"`);
-      }
-      else {
-        Logger.println('Your application has been successfully created!');
-      }
-      Logger.println(`ID: ${app.id}`);
-      Logger.println(`Name: ${name}`);
+      await displayAppCreation(app, alias, github, taskCommand);
   }
 };
 
@@ -59,3 +54,75 @@ function getGithubDetails (githubOwnerRepo) {
 function getCurrentDirectoryName () {
   return path.basename(process.cwd());
 }
+
+/**
+ * Display the application creation message in a human-readable format
+ * @param {Object} app - The application object
+ * @param {string} alias - The alias of the application
+ * @param {Object} github - The GitHub details
+ * @param {string} taskCommand - The task command
+ */
+async function displayAppCreation (app, alias, github, taskCommand) {
+
+  Logger.printSuccess(`Application ${colors.green(app.name)} successfully created!`);
+
+  const hasDistinctAlias = alias != null && alias !== app.name;
+  const isTask = app.instance.lifetime === 'TASK';
+
+  Logger.println();
+  printFieldsAsTable(2, {
+    Type: colors.blue(`⬢ ${app.instance.variant.name}`),
+    ID: app.id,
+    'Org ID': app.ownerId,
+    Name: app.name,
+    GitHub: github != null && `${github.owner}/${github.name}`,
+    Alias: hasDistinctAlias && alias,
+    Zone: app.zone,
+    Task: isTask && `"${taskCommand}"`,
+  });
+
+  Logger.println();
+  Logger.println('  ' + colors.bold('Next steps:'));
+
+  if (!github) {
+    const isInsideGit = await isInsideGitRepo();
+    if (!isInsideGit) {
+      Logger.println(`  ${colors.yellow('!')} Initialize a git repository first, for example:`);
+      Logger.println(`    ${shellCommand('git init')}`);
+      Logger.println(`    ${shellCommand('git add .')}`);
+      Logger.println(`    ${shellCommand('git commit -m "Initial commit"')}`);
+      Logger.println();
+    }
+    else {
+      const isClean = await isGitWorkingDirectoryClean();
+      if (!isClean) {
+        Logger.println(`  ${colors.yellow('!')} Commit your changes first:`);
+        Logger.println(`    ${shellCommand('git add .')}`);
+        Logger.println(`    ${shellCommand('git commit -m "My changes"')}`);
+        Logger.println();
+      }
+    }
+  }
+
+  if (github) {
+    Logger.println(`  ${colors.blue('→')} Push changes to ${colors.blue(`${github.owner}/${github.name}`)} GitHub repository to trigger a deployment, or ${colors.blue('clever restart')} the latest pushed commit`);
+  }
+  else {
+    Logger.println(`  ${colors.blue('→')} Run ${colors.blue('clever deploy')} ${isTask ? 'to execute your task' : 'to deploy your application'}`);
+  }
+
+  Logger.println(`  ${colors.blue('→')} Manage your application at: ${colors.underline(`${conf.GOTO_URL}/${app.id}`)}`);
+  Logger.println('');
+}
+
+function shellCommand (command) {
+  return `${colors.grey('$')} ${colors.yellow(command)}`;
+}
+
+function printFieldsAsTable (indent, fields) {
+  const fieldsWithValues = Object.fromEntries(Object.entries(fields).filter(([_, value]) => typeof value === 'string'));
+  const labelMaxWidth = Math.max(...Object.keys(fieldsWithValues).map((label) => label.length));
+  return Object.entries(fieldsWithValues).forEach(([label, value]) => {
+    Logger.println(`${' '.repeat(indent)}${label.padEnd(labelMaxWidth, ' ')}  ${colors.grey(value)}`);
+  });
+}

package/src/commands/curl.js

@@ -1,9 +1,10 @@
 import { spawn } from 'node:child_process';
-import { loadOAuthConf, conf } from '../models/configuration.js';
+import { conf, loadOAuthConf } from '../models/configuration.js';
 import { addOauthHeader } from '@clevercloud/client/esm/oauth.js';
 import { Logger } from '../logger.js';
 import colors from 'colors/safe.js';
 import curlconverter from 'curlconverter';
+import dedent from 'dedent';
 
 async function loadTokens () {
   const tokens = await loadOAuthConf();
@@ -16,22 +17,21 @@ async function loadTokens () {
 }
 
 function printCleverCurlHelp () {
-  const apiDocUrlv2 = `${conf.API_DOC_URL}/v2/`;
-  const apiDocUrlv4 = `${conf.API_DOC_URL}/v4/`;
-
-  Logger.println(`Usage: clever curl
-Query Clever Cloud's API using Clever Tools credentials. For example:
-
-  clever curl ${conf.API_HOST}/v2/self
-  clever curl ${conf.API_HOST}/v2/summary
-  clever curl ${conf.API_HOST}/v4/products/zones
-  clever curl ${conf.API_HOST}/v2/organisations/<ORGANISATION_ID>/applications | jq '.[].id'
-  clever curl ${conf.API_HOST}/v4/billing/organisations/<ORGANISATION_ID>/<INVOICE_NUMBER>.pdf > invoice.pdf
-
-Our API documentation is available here :
-
-  ${apiDocUrlv2}
-  ${apiDocUrlv4}`);
+  Logger.println(dedent`
+    Usage: clever curl
+    Query Clever Cloud's API using Clever Tools credentials. For example:
+    
+      clever curl ${conf.API_HOST}/v2/self
+      clever curl ${conf.API_HOST}/v2/summary
+      clever curl ${conf.API_HOST}/v4/products/zones
+      clever curl ${conf.API_HOST}/v2/organisations/<ORGANISATION_ID>/applications | jq '.[].id'
+      clever curl ${conf.API_HOST}/v4/billing/organisations/<ORGANISATION_ID>/<INVOICE_NUMBER>.pdf > invoice.pdf
+    
+    Our API documentation is available here :
+    
+      ${conf.API_DOC_URL}/v2/
+      ${conf.API_DOC_URL}/v4/
+  `);
 }
 
 export async function curl () {

package/src/commands/database.js

@@ -2,8 +2,8 @@ import { sendToApi } from '../models/send-to-api.js';
 import { getBackups } from '@clevercloud/client/esm/api/v2/backups.js';
 import { Logger } from '../logger.js';
 import { formatTable as initFormatTable } from '../format-table.js';
-import superagent from 'superagent';
 import fs from 'node:fs';
+import { Writable } from 'node:stream';
 import { findOwnerId } from '../models/addon.js';
 import { resolveRealId, resolveAddonId } from '../models/ids-resolver.js';
 
@@ -80,14 +80,14 @@ export async function downloadBackups (params) {
     throw new Error('no backup with this ID');
   }
 
-  const res = await superagent
-    .get(backup.download_url)
-    .responseType('blob');
-
-  if (output) {
-    fs.writeFileSync(output, res.body);
-    return;
+  const response = await globalThis.fetch(backup.download_url);
+  if (!response.ok) {
+    throw new Error('Failed to download backup');
   }
 
-  process.stdout.write(res.body);
+  await response
+    .body
+    .pipeTo(
+      Writable.toWeb(output ? fs.createWriteStream(output) : process.stdout),
+    );
 }

package/src/commands/delete.js

@@ -1,6 +1,7 @@
 import * as AppConfig from '../models/app_configuration.js';
 import * as Application from '../models/application.js';
 import { Logger } from '../logger.js';
+import colors from 'colors/safe.js';
 
 export async function deleteApp (params) {
   const { alias, app: appIdOrName, yes: skipConfirmation } = params.options;
@@ -8,16 +9,16 @@ export async function deleteApp (params) {
 
   const app = await Application.get(ownerId, appId);
   if (app == null) {
-    Logger.println('The application doesn\'t exist');
+    throw new Error('The application doesn\'t exist');
   }
-  else {
-    // delete app
-    await Application.deleteApp(app, skipConfirmation);
-    Logger.println('The application has been deleted');
-    // unlink app
-    const wasUnlinked = await AppConfig.removeLinkedApplication({ appId, alias });
-    if (wasUnlinked) {
-      Logger.println('The application has been unlinked');
-    }
+
+  // delete app
+  await Application.deleteApp(app, skipConfirmation);
+  Logger.printSuccess(`Application ${colors.green(colors.bold(`${app.name}`))} successfully deleted!`);
+  Logger.println(`  ${colors.grey('•')} Application ID: ${colors.grey(app.id)}`);
+
+  const wasUnlinked = await AppConfig.removeLinkedApplication({ appId, alias });
+  if (wasUnlinked) {
+    Logger.println(`  ${colors.blue('→')} Local alias ${colors.blue(alias || app.name)} unlinked`);
   }
 };