clever-tools 3.12.0 → 3.13.0

package/src/commands/matomo.js

@@ -0,0 +1,85 @@
+import {
+  operatorList,
+  operatorOpen,
+  operatorOpenLogs,
+  operatorOpenWebUi,
+  operatorPrint,
+  operatorReboot,
+  operatorRebuild,
+} from '../lib/operator-commands.js';
+
+/**
+ * Get the details of a Matomo 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('matomo', addonIdOrName, format);
+}
+
+/**
+ * List all Matomo operators
+ * @returns {Promise<void>}
+ */
+export async function list (params) {
+  await operatorList('addon-matomo', params.options.format);
+}
+
+/**
+ * Open a Matomo 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('matomo', addonIdOrName);
+}
+
+/**
+ * Open the Logs section of a Matomo 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('matomo', addonIdOrName);
+}
+
+/**
+ * Open the Web UI of a Matomo 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('matomo', addonIdOrName);
+}
+
+/**
+ * Reboot a Matomo 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('matomo', addonIdOrName);
+}
+
+/**
+ * Rebuild a Matomo 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('matomo', addonIdOrName);
+}

package/src/commands/metabase.js

@@ -0,0 +1,112 @@
+import {
+  operatorCheckVersion,
+  operatorList,
+  operatorOpen,
+  operatorOpenLogs,
+  operatorOpenWebUi,
+  operatorPrint,
+  operatorReboot,
+  operatorRebuild,
+  operatorUpdateVersion,
+} from '../lib/operator-commands.js';
+
+/**
+ * Check the version of a Metabase 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('metabase', addonIdOrName, format);
+}
+
+/**
+ * Update the version of a Metabase 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('metabase', target, addonIdOrName);
+}
+
+/**
+ * Get the details of a Metabase 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('metabase', addonIdOrName, format);
+}
+
+/**
+ * List all Metabase operators
+ * @returns {Promise<void>}
+ */
+export async function list (params) {
+  await operatorList('metabase', params.options.format);
+}
+
+/**
+ * Open a Metabase 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('metabase', addonIdOrName);
+}
+
+/**
+ * Open the Logs section of a Metabase 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('metabase', addonIdOrName);
+}
+
+/**
+ * Open the Web UI of a Metabase 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('metabase', addonIdOrName);
+}
+
+/**
+ * Reboot a Metabase 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('metabase', addonIdOrName);
+}
+
+/**
+ * Rebuild a Metabase 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('metabase', addonIdOrName);
+}

package/src/commands/open.js

@@ -1,8 +1,6 @@
-import openPage from 'open';
-
 import * as Application from '../models/application.js';
 import * as Domain from '../models/domain.js';
-import { Logger } from '../logger.js';
+import { openBrowser } from '../models/utils.js';
 
 export async function open (params) {
   const { alias, app: appIdOrName } = params.options;
@@ -11,6 +9,5 @@ export async function open (params) {
   const vhost = await Domain.getBest(appId, ownerId);
   const url = 'https://' + vhost.fqdn;
 
-  Logger.println('Opening the application in your browser');
-  await openPage(url, { wait: false });
+  await openBrowser(url, 'Opening the application in your browser');
 }

package/src/commands/otoroshi.js

@@ -0,0 +1,138 @@
+import {
+  operatorCheckVersion,
+  operatorList,
+  operatorNgDisable,
+  operatorNgEnable,
+  operatorOpen,
+  operatorOpenLogs,
+  operatorOpenWebUi,
+  operatorPrint,
+  operatorReboot,
+  operatorRebuild,
+  operatorUpdateVersion,
+} from '../lib/operator-commands.js';
+
+/**
+ * Check the version of an Otoroshi 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('otoroshi', addonIdOrName, format);
+}
+
+/**
+ * Update the version of an Otoroshi 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('otoroshi', target, addonIdOrName);
+}
+
+/**
+ * Get the details of an Otoroshi 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('otoroshi', addonIdOrName, format);
+}
+
+/**
+ * List all Otoroshi operators
+ * @returns {Promise<void>}
+ */
+export async function list (params) {
+  await operatorList('otoroshi', params.options.format);
+}
+
+/**
+ * Unlink a 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('otoroshi', addonIdOrName);
+}
+
+/**
+ * Link a 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('otoroshi', addonIdOrName);
+}
+
+/**
+ * Open an Otoroshi 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('otoroshi', addonIdOrName);
+}
+
+/**
+ * Open the Logs section of an Otoroshi 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('otoroshi', addonIdOrName);
+}
+
+/**
+ * Open the Web UI of an Otoroshi 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('otoroshi', addonIdOrName);
+}
+
+/**
+ * Reboot an Otoroshi 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('otoroshi', addonIdOrName);
+}
+
+/**
+ * Rebuild an Otoroshi 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('otoroshi', addonIdOrName);
+}

package/src/commands/profile.js

@@ -1,5 +1,5 @@
 import colors from 'colors/safe.js';
-import openPage from 'open';
+import { openBrowser } from '../models/utils.js';
 import { Logger } from '../logger.js';
 import * as User from '../models/user.js';
 import dedent from 'dedent';
@@ -51,7 +51,5 @@ export async function profile (params) {
 };
 
 export async function openProfile () {
-  const URL = 'https://console.clever-cloud.com/users/me/information';
-  Logger.debug('Opening the profile page in your browser');
-  await openPage(URL, { wait: false });
+  await openBrowser('/users/me/information', 'Opening the profile page in your browser');
 }

package/src/commands/restart.js

@@ -26,7 +26,7 @@ export async function restart (params) {
   const commitId = fullCommitId || remoteCommitId;
   if (commitId != null) {
     const cacheSuffix = withoutCache ? ' without using cache' : '';
-    Logger.println(`Restarting ${app.name} on commit ${colors.green(commitId)}${cacheSuffix}`);
+    Logger.println(`🔄 Restarting ${colors.bold(app.name)}${cacheSuffix} ${colors.grey(`(${commitId})`)}`);
   }
 
   // This should be handled by the API when a deployment ID is set but we'll do this for now

package/src/commands/ssh-keys.js

@@ -0,0 +1,159 @@
+import { confirm } from '../lib/prompts.js';
+import colors from 'colors/safe.js';
+import { Logger } from '../logger.js';
+import fs from 'node:fs';
+import { sendToApi } from '../models/send-to-api.js';
+import { openBrowser } from '../models/utils.js';
+import dedent from 'dedent';
+import {
+  todo_addSshKey as addSshKey,
+  todo_getSshKeys as getSshKeys,
+  todo_removeSshKey as removeSshKey,
+} from '@clevercloud/client/esm/api/v2/user.js';
+
+/**
+ * List SSH keys 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 keys = await getUserSshKeys();
+
+  switch (format) {
+    case 'json': {
+      Logger.printJson(keys);
+      break;
+    }
+    case 'human':
+    default: {
+      if (keys.length === 0) {
+        Logger.println(dedent`
+          ${colors.blue('🔐 No SSH keys')}
+          
+          To list the SSH keys on your local system, use the following command:
+          ${colors.grey('ssh-add -l -E sha256')}
+          
+          To create a new key pair, use the following command:
+          ${colors.grey('ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_clever -C "An optional comment"')}
+          
+          Then add the public key to your Clever Cloud account:
+          ${colors.grey('clever ssh-keys add myNewKey ~/.ssh/id_ed25519_clever.pub')}
+        `);
+        return;
+      }
+
+      Logger.println(`🔐 ${keys.length} SSH key(s):`);
+      keys.forEach((key) => {
+        Logger.println(` • ${colors.blue(key.name)}`, colors.grey(`(${key.fingerprint})`));
+      });
+    }
+  }
+}
+
+/**
+ * Add a SSH key to the current user
+ * @param {object} params The command parameters
+ * @param {Array<string>} params.args
+ */
+export async function add (params) {
+  const [keyName, filePath] = params.args;
+
+  if (!fs.existsSync(filePath)) {
+    throw new Error(`File ${filePath} does not exist`);
+  }
+
+  const pubKeyContent = fs.readFileSync(filePath, 'utf8').trim();
+  Logger.debug(`SSH key file content: ${pubKeyContent}`);
+
+  try {
+    await addSshKey({ key: encodeURIComponent(keyName) }, JSON.stringify(pubKeyContent)).then(sendToApi);
+  }
+  catch (e) {
+    console.log(e?.responseBody?.id);
+    if (e?.responseBody?.id === 505) {
+      throw new Error('This SSH key is not valid, please make sure you\'re pointing to the public key file');
+    }
+  }
+
+  Logger.printSuccess(`SSH key ${keyName} added successfully`);
+}
+
+/**
+ * Remove a SSH key from the current user
+ * @param {object} params The command parameters
+ * @param {Array<string>} params.args
+ */
+export async function remove (params) {
+  const [keyName] = params.args;
+
+  const keys = await getUserSshKeys();
+
+  if (keys.find((key) => key.name === keyName) == null) {
+    throw new Error(`SSH key ${colors.red(keyName)} not found`);
+  }
+
+  const keyNameEncoded = encodeURIComponent(keyName);
+  await removeSshKey({ key: keyNameEncoded }).then(sendToApi);
+
+  Logger.printSuccess(`SSH key ${keyName} removed successfully`);
+}
+
+/**
+ * Remove all SSH keys 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 removeAll (params) {
+  if (!params.options.yes) {
+    await confirm(
+      'Are you sure you want to remove all your SSH keys?',
+      'No SSH keys removed',
+    );
+  }
+
+  const keys = await getUserSshKeys();
+
+  if (keys.length === 0) {
+    Logger.println('No SSH keys to remove');
+    return;
+  }
+
+  const results = await Promise.all(
+    keys.map((key) => {
+      const keyNameEncoded = encodeURIComponent(key.name);
+      return removeSshKey({ key: keyNameEncoded }).then(sendToApi)
+        .then(() => [true, key.name])
+        .catch(() => [false, key.name]);
+    }),
+  );
+
+  if (results.every(([isRemoved]) => isRemoved)) {
+    Logger.printSuccess('All SSH keys were removed successfully');
+  }
+  else {
+    const keyNamesWithErrors = results
+      .filter(([isRemoved]) => !isRemoved)
+      .map(([_, keyName]) => keyName)
+      .join(', ');
+    throw new Error(`Some errors occured while removing these SSH keys: ${keyNamesWithErrors}`);
+  }
+}
+
+/**
+ * Open the SSH keys 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/ssh-keys', 'Opening the SSH keys management page of the Console in your browser');
+}
+
+/**
+ * @return {Promise<Array<{ name: string, key: string, fingerprint: string }>>}
+ */
+async function getUserSshKeys () {
+  const rawKeys = await getSshKeys().then(sendToApi);
+  return rawKeys.sort((a, b) => a.name.localeCompare(b.name));
+}

package/src/commands/stop.js

@@ -8,5 +8,5 @@ export async function stop (params) {
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
   await stopApplication({ id: ownerId, appId }).then(sendToApi);
-  Logger.println('App successfully stopped!');
+  Logger.printSuccess('Application successfully stopped!');
 }

package/src/commands/tcp-redirs.js

@@ -2,7 +2,7 @@ import colors from 'colors/safe.js';
 
 import * as Namespaces from '../models/namespaces.js';
 import { sendToApi } from '../models/send-to-api.js';
-import * as Interact from '../models/interact.js';
+import { confirm } from '../lib/prompts.js';
 import { Logger } from '../logger.js';
 import * as Application from '../models/application.js';
 import { addTcpRedir, getTcpRedirs, removeTcpRedir } from '@clevercloud/client/esm/api/v2/application.js';
@@ -72,8 +72,8 @@ async function acceptPayment (result, skipConfirmation) {
     Logger.println(`Total (without taxes): ${result.totalHT}€`);
     Logger.println(colors.bold(`Total (with taxes): ${result.totalTTC}€`));
 
-    await Interact.confirm(
-      `You're about to pay ${result.totalTTC}€, confirm? (yes or no) `,
+    await confirm(
+      `You're about to pay ${result.totalTTC}€, confirm?`,
       'No confirmation, aborting TCP redirection creation',
     );
   }

package/src/commands/tokens.js

@@ -5,7 +5,7 @@ import { sendToAuthBridge } from '../models/send-to-api.js';
 import { getCurrent as getCurrentUser } from '../models/user.js';
 import { conf } from '../models/configuration.js';
 import dedent from 'dedent';
-import { promptPassword } from '../prompt-password.js';
+import { promptSecret } from '../lib/prompts.js';
 
 /**
  * Create a new API token
@@ -13,10 +13,20 @@ import { promptPassword } from '../prompt-password.js';
  * @param {[string]} params.args - Command line args
  * @param {Object} params.options - Command line options
  * @param {'json'|'human'} params.options.format - Output format
+ * @param {number} params.options.expiration - Expiration date as timestamp
  */
 export async function create (params) {
   const [apiTokenName] = params.args;
   const { expiration, format } = params.options;
+  const user = await getCurrentUser();
+
+  if (!user.hasPassword) {
+    const apiTokenListHref = new URL('/users/me/api-tokens', conf.CONSOLE_URL).href;
+    throw new Error(dedent`
+      ${colors.yellow('!')} Your Clever Cloud account is linked via GitHub and has no password. Setting one is required to create API tokens.
+      ${colors.blue('→')} To do so, go to the following URL: ${colors.blue(apiTokenListHref)}
+    `);
+  }
 
   // Expire in 1 year
   const dateObject = new Date();
@@ -25,22 +35,20 @@ export async function create (params) {
 
   let expirationDate;
   if (expiration != null) {
-    if (expiration > maxExpirationDate) {
+    if (expiration > maxExpirationDate.getTime()) {
       throw new Error('You cannot set an expiration date greater than 1 year');
     }
-    expirationDate = expiration;
+    expirationDate = new Date(expiration);
   }
   else {
     expirationDate = maxExpirationDate;
   }
 
-  const user = await getCurrentUser();
-
-  const password = await promptPassword('Enter your password:');
+  const password = await promptSecret('Enter your password:');
 
   let mfaCode;
   if (user.preferredMFA === 'TOTP') {
-    mfaCode = await promptPassword('Enter your 2FA code:');
+    mfaCode = await promptSecret('Enter your 2FA code:');
   }
 
   const tokenData = {
@@ -112,6 +120,7 @@ export async function list (params) {
           'Creation IP address': token.ip,
           Creation: formatDate(token.creationDate),
           Expiration: formatDate(token.expirationDate),
+          State: token.state,
         };
       }));
     }

package/src/commands/unlink.js

@@ -1,11 +1,12 @@
 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 unlink (params) {
   const [alias] = params.args;
   const app = await AppConfig.getAppDetails({ alias });
 
   await Application.unlinkRepo(app.alias);
-  Logger.println('Your application has been successfully unlinked!');
+  Logger.printSuccess(`Application ${colors.green(app.appId)} has been successfully unlinked from local alias ${colors.green(app.alias)}!`);
 };