clever-tools 3.11.0 → 3.12.0

package/src/commands/ng.js

@@ -0,0 +1,202 @@
+import colors from 'colors/safe.js';
+import * as networkGroup from '../models/ng.js';
+import * as networkGroupResources from '../models/ng-resources.js';
+
+import { Logger } from '../logger.js';
+import { printResults } from '../lib/ng-print.js';
+
+/** Create a Network Group
+ * @param {Object} params
+ * @param {Array<Object>} params.args
+ * @param {Object} params.args[0] Network Group label
+ * @param {string} params.options.description Network Group description
+ * @param {Array<string>}  params.options.link Array of member IDs or labels to link to the Network Group
+ * @param {Object} params.options.org Organisation ID or name
+ * @param {string} params.options.tags Comma-separated list of tags
+ */
+export async function createNg (params) {
+  const [ngLabel] = params.args;
+  const label = ngLabel.ngResourceLabel;
+  const { description, link: membersIds, org, tags } = params.options;
+
+  await networkGroup.create(label, description, tags, membersIds, org);
+
+  const successMessage = `Network Group ${colors.green(label)} successfully created`;
+  if (membersIds == null) {
+    Logger.printSuccess(`${successMessage}!`);
+  }
+  else {
+    Logger.printSuccess(`${successMessage} with member(s):`);
+    Logger.println(membersIds.map((id) => colors.grey(`  - ${id}`)).join('\n'));
+  }
+}
+
+/** Delete a Network Group
+ * @param {Object} params
+ * @param {Object} params.args[0] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function deleteNg (params) {
+  const [ngIdOrLabel] = params.args;
+  const { org } = params.options;
+
+  await networkGroup.destroy(ngIdOrLabel, org);
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  Logger.printSuccess(`Network Group ${colors.green(ngText)} successfully deleted!`);
+}
+
+/** Create an external peer in a Network Group
+ * @param {Object} params
+ * @param {Object} params.args[0] External peer ID or label
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {string} params.args[2] Wireguard public key
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function createExternalPeer (params) {
+  const [peerIdOrLabel, ngIdOrLabel, publicKey] = params.args;
+  const { org } = params.options;
+
+  await networkGroupResources.createExternalPeerWithParent(ngIdOrLabel, peerIdOrLabel.ngResourceLabel, publicKey, org);
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  Logger.printSuccess(`External peer ${colors.green(peerIdOrLabel.ngResourceLabel)} successfully created in Network Group ${colors.green(ngText)}`);
+}
+
+/** Delete an external peer from a Network Group
+ * @param {Object} params
+ * @param {Object} params.args[0] External peer ID or label
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function deleteExternalPeer (params) {
+  const [peerIdOrLabel, ngIdOrLabel] = params.args;
+  const { org } = params.options;
+
+  const peerText = peerIdOrLabel.ngResourceLabel ?? peerIdOrLabel.memberId;
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  await networkGroupResources.deleteExternalPeerWithParent(ngIdOrLabel, peerText, org);
+  Logger.printSuccess(`External peer ${colors.green(peerText)} successfully deleted from Network Group ${colors.green(ngText)}`);
+}
+
+/** Link a member to a Network Group
+ * @param {Object} params
+ * @param {string} params.args[0] Member ID
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function linkToNg (params) {
+  const [resourceId, ngIdOrLabel] = params.args;
+  const { org } = params.options;
+
+  await networkGroupResources.linkMember(ngIdOrLabel, resourceId.memberId, org);
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  Logger.printSuccess(`Member ${colors.green(resourceId.memberId)} successfully linked to Network Group ${colors.green(ngText)}`);
+}
+
+/** Unlink a member from a Network Group
+ * @param {Object} params
+ * @param {string} params.args[0] Member ID
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function unlinkFromNg (params) {
+  const [resourceId, ngIdOrLabel] = params.args;
+  const { org } = params.options;
+
+  await networkGroupResources.unlinkMember(ngIdOrLabel, resourceId.memberId, org);
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  Logger.printSuccess(`Member ${colors.green(resourceId.memberId)} successfully unlinked from Network Group ${colors.green(ngText)}`);
+}
+
+/** Print the configuration of a Network Group's peer
+ * @param {Object} params
+ * @param {Object} params.args[0] Peer ID or label
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ * @param {string} params.options.format Output format
+ */
+export async function getPeerConfig (params) {
+  const [peerIdOrLabel, ngIdOrLabel] = params.args;
+  const { org, format } = params.options;
+
+  const config = await networkGroup.getPeerConfig(peerIdOrLabel, ngIdOrLabel, org);
+
+  switch (format) {
+    case 'json': {
+      Logger.printJson(config);
+      break;
+    }
+    case 'human':
+    default: {
+      const decodedConfiguration = Buffer.from(config.configuration, 'base64').toString('utf8');
+      Logger.println(decodedConfiguration);
+    }
+  }
+}
+
+/** List Network Groups, their members and peers
+ * @param {Object} params
+ * @param {Object} params.options.orgaIdOrName Organisation ID or name
+ * @param {string} params.options.format Output format
+ */
+export async function listNg (params) {
+  const { org, format } = params.options;
+
+  const ngs = await networkGroup.getAllNGs(org);
+
+  switch (format) {
+    case 'json': {
+      Logger.printJson(ngs);
+      break;
+    }
+    case 'human':
+    default: {
+      if (!ngs.length) {
+        Logger.println(`ℹ️ No Network Group found, create one with ${colors.blue('clever ng create')} command`);
+        return;
+      }
+      const ngList = ngs.map(({
+        id,
+        label,
+        networkIp,
+        members,
+        peers,
+      }) => ({
+        ID: id,
+        Label: label,
+        'Network CIDR': networkIp,
+        Members: Object.keys(members).length,
+        Peers: Object.keys(peers).length,
+      }));
+
+      console.table(ngList);
+    }
+  }
+}
+
+/** Show information about a Network Group, a member or a peer
+ * @param {Object} params
+ * @param {Object} params.args[0] ID or label of the Network Group, a member or a peer
+ * @param {Object} params.options.org Organisation ID or name
+ * @param {string} params.options.format Output format
+ */
+export async function get (params) {
+  const [idOrLabel] = params.args;
+  const { org, format } = params.options;
+  const type = params.options.type ?? 'single';
+
+  await printResults(idOrLabel, org, format, 'get', type);
+}
+
+/** Show information about a Network Group, a member or a peer
+ * @param {Object} params
+ * @param {Object} params.args[0] ID or label of the Network Group, a member or a peer
+ * @param {Object} params.options.org Organisation ID or name
+ * @param {string} params.options.format Output format
+ */
+export async function search (params) {
+  const [idOrLabel] = params.args;
+  const { org, format } = params.options;
+  const type = params.options.type;
+
+  await printResults(idOrLabel, org, format, 'search', type);
+}

package/src/commands/profile.js

@@ -2,6 +2,7 @@ import colors from 'colors/safe.js';
 import openPage from 'open';
 import { Logger } from '../logger.js';
 import * as User from '../models/user.js';
+import dedent from 'dedent';
 
 export async function profile (params) {
   const { format } = params.options;
@@ -37,12 +38,14 @@ export async function profile (params) {
     }
     case 'human':
     default: {
-      Logger.println('You\'re currently logged in as:');
-      Logger.println(`User id           ${formattedUser.id}`);
-      Logger.println(`Name              ${formattedUser.name ?? colors.red.bold('[not specified]')}`);
-      Logger.println(`Email             ${formattedUser.email}`);
-      Logger.println(`Token expiration  ${tokenExpiration}`);
-      Logger.println(`Two factor auth   ${formattedUser.has2FA ? 'yes' : 'no'}`);
+      Logger.println(dedent`
+        You're currently logged in as:
+        User id           ${formattedUser.id}
+        Name              ${formattedUser.name ?? colors.red.bold('[not specified]')}
+        Email             ${formattedUser.email}
+        Token expiration  ${tokenExpiration}
+        Two factor auth   ${formattedUser.has2FA ? 'yes' : 'no'}
+      `);
     }
   }
 };

package/src/commands/published-config.js

@@ -3,13 +3,13 @@ import { Logger } from '../logger.js';
 import * as variables from '../models/variables.js';
 import { sendToApi } from '../models/send-to-api.js';
 import { toNameEqualsValueString, validateName } from '@clevercloud/client/esm/utils/env-vars.js';
-import * as application from '@clevercloud/client/esm/api/v2/application.js';
+import { getAllExposedEnvVars, updateAllExposedEnvVars } from '@clevercloud/client/esm/api/v2/application.js';
 
 export async function list (params) {
   const { alias, app: appIdOrName, format } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  const publishedConfigs = await application.getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
+  const publishedConfigs = await getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
   const pairs = Object.entries(publishedConfigs).map(([name, value]) => ({ name, value }));
 
   switch (format) {
@@ -39,9 +39,9 @@ export async function set (params) {
 
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  const publishedConfigs = await application.getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
+  const publishedConfigs = await getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
   publishedConfigs[varName] = varValue;
-  await application.updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
+  await updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
 
   Logger.println('Your published config item has been successfully saved');
 };
@@ -51,9 +51,9 @@ export async function rm (params) {
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  const publishedConfigs = await application.getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
+  const publishedConfigs = await getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
   delete publishedConfigs[varName];
-  await application.updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
+  await updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
 
   Logger.println('Your published config item has been successfully removed');
 };
@@ -64,7 +64,7 @@ export async function importEnv (params) {
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
   const publishedConfigs = await variables.readVariablesFromStdin(format);
-  await application.updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
+  await updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
 
   Logger.println('Your published configs have been set');
 };

package/src/commands/stop.js

@@ -1,12 +1,12 @@
 import * as Application from '../models/application.js';
-import * as application from '@clevercloud/client/esm/api/v2/application.js';
 import { Logger } from '../logger.js';
 import { sendToApi } from '../models/send-to-api.js';
+import { undeploy as stopApplication } from '@clevercloud/client/esm/api/v2/application.js';
 
 export async function stop (params) {
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  await application.undeploy({ id: ownerId, appId }).then(sendToApi);
+  await stopApplication({ id: ownerId, appId }).then(sendToApi);
   Logger.println('App successfully stopped!');
 }

package/src/commands/tcp-redirs.js

@@ -4,8 +4,8 @@ import * as Namespaces from '../models/namespaces.js';
 import { sendToApi } from '../models/send-to-api.js';
 import * as Interact from '../models/interact.js';
 import { Logger } from '../logger.js';
-import * as application from '@clevercloud/client/esm/api/v2/application.js';
 import * as Application from '../models/application.js';
+import { addTcpRedir, getTcpRedirs, removeTcpRedir } from '@clevercloud/client/esm/api/v2/application.js';
 
 export async function listNamespaces (params) {
   const { alias, app: appIdOrName, format } = params.options;
@@ -44,7 +44,7 @@ export async function list (params) {
   const { alias, app: appIdOrName, format } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  const redirs = await application.getTcpRedirs({ id: ownerId, appId }).then(sendToApi);
+  const redirs = await getTcpRedirs({ id: ownerId, appId }).then(sendToApi);
 
   switch (format) {
     case 'json': {
@@ -83,10 +83,10 @@ export async function add (params) {
   const { alias, app: appIdOrName, namespace, yes: skipConfirmation } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  const { port } = await application.addTcpRedir({ id: ownerId, appId }, { namespace }).then(sendToApi).catch((error) => {
+  const { port } = await addTcpRedir({ id: ownerId, appId }, { namespace }).then(sendToApi).catch((error) => {
     if (error.status === 402) {
       return acceptPayment(error.response.body, skipConfirmation).then(() => {
-        return application.addTcpRedir({ id: ownerId, appId, payment: 'accepted' }, { namespace }).then(sendToApi);
+        return addTcpRedir({ id: ownerId, appId, payment: 'accepted' }, { namespace }).then(sendToApi);
       });
     }
     else {
@@ -102,7 +102,7 @@ export async function remove (params) {
   const { alias, app: appIdOrName, namespace } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  await application.removeTcpRedir({ id: ownerId, appId, sourcePort: port, namespace }).then(sendToApi);
+  await removeTcpRedir({ id: ownerId, appId, sourcePort: port, namespace }).then(sendToApi);
 
   Logger.println('Successfully removed tcp redirection.');
 };

package/src/commands/tokens.js

@@ -0,0 +1,137 @@
+import colors from 'colors/safe.js';
+import { Logger } from '../logger.js';
+import { createApiToken, deleteApiToken, listApiTokens } from '../clever-client/auth-bridge.js';
+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';
+
+/**
+ * Create a new API token
+ * @param {Object} params - Function parameters
+ * @param {[string]} params.args - Command line args
+ * @param {Object} params.options - Command line options
+ * @param {'json'|'human'} params.options.format - Output format
+ */
+export async function create (params) {
+  const [apiTokenName] = params.args;
+  const { expiration, format } = params.options;
+
+  // Expire in 1 year
+  const dateObject = new Date();
+  dateObject.setFullYear(dateObject.getFullYear() + 1);
+  const maxExpirationDate = dateObject;
+
+  let expirationDate;
+  if (expiration != null) {
+    if (expiration > maxExpirationDate) {
+      throw new Error('You cannot set an expiration date greater than 1 year');
+    }
+    expirationDate = expiration;
+  }
+  else {
+    expirationDate = maxExpirationDate;
+  }
+
+  const user = await getCurrentUser();
+
+  const password = await promptPassword('Enter your password:');
+
+  let mfaCode;
+  if (user.preferredMFA === 'TOTP') {
+    mfaCode = await promptPassword('Enter your 2FA code:');
+  }
+
+  const tokenData = {
+    email: user.email,
+    password,
+    mfaCode,
+    name: apiTokenName,
+    expirationDate: expirationDate.toISOString(),
+  };
+  const createdToken = await createApiToken(tokenData).then(sendToAuthBridge).catch((error) => {
+    const errorCode = error?.cause?.responseBody?.code;
+    if (errorCode === 'invalid-credential') {
+      throw new Error('Invalid credentials, check your password');
+    }
+    if (errorCode === 'invalid-mfa-code') {
+      throw new Error('Invalid credentials, check your 2FA code');
+    }
+    throw error;
+  });
+
+  switch (format) {
+    case 'json':
+      Logger.printJson(createdToken);
+      break;
+    case 'human':
+    default:
+      Logger.println(dedent`
+        ${colors.green('✔')} API token successfully created! Store it securely, you won't able to print it again.
+
+          - API token ID : ${colors.grey(createdToken.apiTokenId)}
+          - API token    : ${colors.grey(createdToken.apiToken)}
+          - Expiration   : ${colors.grey(formatDate(createdToken.expirationDate))}
+
+        Export this token and use it to make authenticated requests to the Clever Cloud API through the Auth Bridge:
+
+        export CC_API_TOKEN=${createdToken.apiToken}
+        curl -H "Authorization: Bearer $CC_API_TOKEN" ${conf.AUTH_BRIDGE_HOST}/v2/self
+
+        Then, to revoke this token, run:
+        clever tokens revoke ${createdToken.apiTokenId}
+      `);
+  }
+}
+
+/**
+ * Get information about an API token
+ * @param {Object} params - Function parameters
+ * @param {Object} params.options - Command line options
+ * @param {Object} params.options.format - Output format
+ * @returns {Promise<void>}
+ */
+export async function list (params) {
+  const { format } = params.options;
+
+  const tokens = await listApiTokens().then(sendToAuthBridge);
+
+  if (format === 'json') {
+    Logger.printJson(tokens);
+  }
+  else {
+    if (tokens.length === 0) {
+      Logger.println(`ℹ️  No API token found, create one with ${colors.blue('clever tokens create')} command`);
+    }
+    else {
+      console.table(tokens.map((token) => {
+        return {
+          'API token ID': token.apiTokenId,
+          Name: token.name,
+          'Creation IP address': token.ip,
+          Creation: formatDate(token.creationDate),
+          Expiration: formatDate(token.expirationDate),
+        };
+      }));
+    }
+  }
+}
+
+/**
+ * Revoke an API token
+ * @param {Object} params - Function parameters
+ * @param {string[]} params.args - Command line arguments, token ID to revoke is expected as first argument
+ * @returns {Promise<void>}
+ */
+export async function revoke (params) {
+  const [apiTokenId] = params.args;
+
+  await deleteApiToken(apiTokenId).then(sendToAuthBridge);
+
+  Logger.println(colors.green('✔'), 'API token successfully revoked!');
+}
+
+function formatDate (dateInput) {
+  return new Date(dateInput).toISOString().substring(0, 16).replace('T', ' ');
+}

package/src/experimental-features.js

@@ -1,8 +1,11 @@
+import dedent from 'dedent';
+import { conf } from './models/configuration.js';
+
 export const EXPERIMENTAL_FEATURES = {
   kv: {
     status: 'alpha',
     description: 'Send commands to databases such as Materia KV or Redis® directly from Clever Tools, without other dependencies',
-    instructions: `
+    instructions: dedent`
       Target any compatible add-on by its name or ID (with an org ID if needed) and send commands to it:
 
           clever kv myMateriaKV SET myKey myValue
@@ -12,6 +15,47 @@ export const EXPERIMENTAL_FEATURES = {
           clever kv redis_xxxxx --org org_xxxxx PING
 
       Learn more about Materia KV: https://www.clever-cloud.com/developers/doc/addons/materia-kv/
-      `,
+    `,
+  },
+  tokens: {
+    status: 'beta',
+    description: `Manage API tokens to query Clever Cloud API from ${conf.AUTH_BRIDGE_HOST}`,
+    instructions: dedent`
+      Create, list or revoke API tokens from a single command:
+
+          clever tokens create myTokenName
+          clever tokens --format json
+          clever tokens revoke myTokenId
+
+      Learn more about Clever Cloud API: https://www.clever-cloud.com/developers/api
+    `,
+  },
+  ng: {
+    status: 'beta',
+    description: 'Manage Network Groups to manage applications, add-ons, external peers through a Wireguard network',
+    instructions: dedent`
+      - Create a Network Group:
+          clever ng create myNG
+      - Create a Network Group with members (application, database add-on):
+          clever ng create myNG --link app_xxx,addon_xxx
+      - List Network Groups:
+          clever ng
+      - Delete a Network Group:
+          clever ng delete myNG
+      - (Un)Link an application or a database add-on to an existing Network Group:
+          clever ng link app_xxx myNG
+          clever ng unlink addon_xxx myNG
+      - Get the Wireguard configuration of a peer:
+          clever ng get-config peerIdOrLabel myNG
+      - Get details about a Network Group, a member or a peer:
+          clever ng get myNg
+          clever ng get app_xxx
+          clever ng get peerId
+          clever ng get memberLabel
+      - Search Network Groups, members or peers:
+          clever ng search myQuery
+
+      Learn more about Network Groups: https://github.com/CleverCloud/clever-tools/blob/master/docs/ng.md
+    `,
   },
 };