clever-tools 3.10.1 → 3.12.0

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

@@ -0,0 +1,61 @@
+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: 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
+          clever kv kv_xxxxxxxx GET myKey -F json
+          clever kv addon_xxxxx SET myTempKey myTempValue EX 120
+          clever kv myMateriaKV -o myOrg TTL myTempKey
+          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
+    `,
+  },
+};

package/src/lib/ng-print.js

@@ -0,0 +1,195 @@
+import colors from 'colors/safe.js';
+import * as networkGroup from '../models/ng.js';
+
+import { Logger } from '../logger.js';
+
+/**
+ * Print a Network Group
+ * @param {Object} ng The Network Group to print
+ * @param {string} format Output format
+ * @param {boolean} full If true, get more details about the Network Group (default: false)
+ */
+function printNg (ng, format, full = false) {
+
+  switch (format) {
+    case 'json': {
+      Logger.printJson(ng);
+      break;
+    }
+    case 'human':
+    default: {
+      const ngData = {
+        ID: ng.id,
+        Label: ng.label,
+        Description: ng.description,
+        Network: `${ng.networkIp}`,
+        'Members/Peers': `${Object.keys(ng.members)?.length}/${Object.keys(ng.peers)?.length}`,
+      };
+
+      console.table(ngData);
+
+      if (full) {
+        const members = Object.entries(ng.members)
+          .sort((a, b) => a[1].domainName.localeCompare(b[1].domainName))
+          .map(([id, member]) => ({
+            Domain: member.domainName,
+          }));
+        if (members.length > 0) {
+          Logger.println(colors.bold(' • Members:'));
+          console.table(members);
+        }
+
+        const peers = Object.entries(ng.peers)
+          .sort((a, b) => a[1].parentMember.localeCompare(b[1].parentMember))
+          .map(([id, peer]) => formatPeer(peer));
+        if (peers.length > 0) {
+          Logger.println(colors.bold(' • Peers:'));
+          console.table(peers);
+        }
+      }
+    }
+  }
+}
+
+/**
+ * Print a Network Group member
+ * @param {Object} member The Network Group member to print
+ * @param {string} format Output format
+ */
+function printMember (member, format) {
+
+  switch (format) {
+    case 'json': {
+      Logger.printJson(member);
+      break;
+    }
+    case 'human':
+    default: {
+      console.table({
+        Label: member.label,
+        Domain: member.domainName,
+      });
+    }
+  }
+}
+
+/**
+ * Print a Network Group peer
+ * @param {Object} peer The Network Group peer to print
+ * @param {string} format Output format
+ * @param {boolean} full If true, get more details about the peer (default: false)
+ */
+function printPeer (peer, format, full = false) {
+  switch (format) {
+    case 'json': {
+      Logger.printJson(peer);
+      break;
+    }
+    case 'human':
+    default: {
+      console.table(formatPeer(peer, full));
+    }
+  }
+}
+
+/**
+ * Format a peer to print
+ * @param {Object} peer
+ * @param {boolean} full If true, get more details about the peer (default: false)
+ */
+function formatPeer (peer, full = false) {
+  const peerToPrint = {
+    'Parent Member': peer.parentMember,
+    ID: peer.id,
+    Label: peer.label,
+    Type: peer.type,
+  };
+
+  if (full) {
+    if (peer.endpoint.ngTerm != null) {
+      peerToPrint['Host:IP'] = `${peer.endpoint.ngTerm.host}:${peer.endpoint.ngTerm.port}`;
+    }
+    else {
+      peerToPrint.Host = peer.endpoint.ngIp;
+    }
+    if (peer.endpoint.publicTerm != null) {
+      peerToPrint['Public Term'] = `${peer.endpoint.publicTerm.host}:${peer.endpoint.publicTerm.port}`;
+    }
+    peerToPrint['Public Key'] = peer.publicKey;
+  }
+
+  return peerToPrint;
+}
+
+/** Print the results of a search or get action
+ * @param {object} idOrLabel ID or label of the Network Group, a member or a peer
+ * @param {object} org Organisation ID or name
+ * @param {string} format Output format
+ * @param {string} action Action to perform (search or get)
+ * @param {string} type Type of item to search (NetworkGroup, Member, Peer)
+ */
+export async function printResults (idOrLabel, org, format, action, type) {
+
+  const exactMatch = action === 'get';
+  const toLookFor = type ?? (action === 'search' ? 'all' : 'single');
+
+  const found = await networkGroup.searchNgOrResource(idOrLabel, org, toLookFor, exactMatch);
+
+  if (!found.length) {
+    const searchString = idOrLabel.ngId
+      ?? idOrLabel.memberId
+      ?? idOrLabel.ngResourceLabel;
+    Logger.println(`${colors.blue('!')} No Network Group or resource found for ${colors.blue(searchString)}`);
+    return;
+  }
+
+  if (found.length === 1) {
+    switch (found[0].type) {
+      case 'NetworkGroup':
+        return printNg(found[0], format, true);
+      case 'Member':
+        return printMember(found[0], format);
+      case 'CleverPeer':
+      case 'ExternalPeer':
+        return printPeer(found[0], format, true);
+      default:
+        throw new Error(`Unknown item type: ${found[0].type}`);
+    }
+  }
+
+  if (action === 'search') {
+    // Group found items by type in a new object
+    const grouped = found.reduce((acc, item) => {
+      if (!acc[item.type]) {
+        acc[item.type] = [];
+      }
+      acc[item.type].push(item);
+      return acc;
+    }, {});
+
+    switch (format) {
+      case 'json': {
+        Logger.printJson(grouped);
+        break;
+      }
+      case 'human':
+      default: {
+        if (grouped.NetworkGroup) {
+          Logger.println(`${colors.bold(` • Found ${grouped.NetworkGroup.length} Network Group(s):`)}`);
+          grouped.NetworkGroup?.forEach((item) => printNg(item, format));
+        }
+
+        if (grouped.Member) {
+          Logger.println(`${colors.bold(` • Found ${grouped.Member.length} Member(s):`)}`);
+          grouped.Member?.forEach((item) => printMember(item, format));
+        }
+
+        if (grouped.ExternalPeer || grouped.CleverPeer) {
+          Logger.println(`${colors.bold(` • Found ${grouped.ExternalPeer.length + grouped.CleverPeer.length} Peer(s):`)}`);
+          grouped.CleverPeer?.forEach((item) => printPeer(item, format));
+          grouped.ExternalPeer?.forEach((item) => printPeer(item, format));
+        }
+      }
+    }
+  }
+}

package/src/logger.js

@@ -55,6 +55,9 @@ export const Logger = _(['debug', 'info', 'warn', 'error'])
 // No decoration for Logger.println
 Logger.println = console.log;
 
+// Logger for success with a green check before the message
+Logger.printSuccess = (message) => console.log(`${colors.bold.green('✓')} ${message}`);
+
 // No decoration for Logger.println
 Logger.printJson = (obj) => {
   console.log(JSON.stringify(obj, null, 2));

package/src/models/activity.js

@@ -1,8 +1,7 @@
-import * as application from '@clevercloud/client/esm/api/v2/application.js';
-
 import { sendToApi } from './send-to-api.js';
+import { getAllDeployments } from '@clevercloud/client/esm/api/v2/application.js';
 
 export function list (ownerId, appId, showAll) {
   const limit = showAll ? null : 10;
-  return application.getAllDeployments({ id: ownerId, appId, limit }).then(sendToApi);
+  return getAllDeployments({ id: ownerId, appId, limit }).then(sendToApi);
 };

package/src/models/addon.js

@@ -1,4 +1,3 @@
-import * as application from '@clevercloud/client/esm/api/v2/application.js';
 import cliparse from 'cliparse';
 
 import { get as getAddon, getAll as getAllAddons, getAllEnvVars, remove as removeAddon, create as createAddon, update as updateAddon } from '@clevercloud/client/esm/api/v2/addon.js';
@@ -10,6 +9,7 @@ import * as Interact from './interact.js';
 import { Logger } from '../logger.js';
 import { sendToApi } from '../models/send-to-api.js';
 import { resolveOwnerId } from './ids-resolver.js';
+import { getAllLinkedAddons, linkAddon, unlinkAddon } from '@clevercloud/client/esm/api/v2/application.js';
 
 export function listProviders () {
   return getAllAddonProviders({}).then(sendToApi);
@@ -42,7 +42,7 @@ export async function list (ownerId, appId, showAll) {
     return allAddons;
   }
 
-  const myAddons = await application.getAllLinkedAddons({ id: ownerId, appId }).then(sendToApi);
+  const myAddons = await getAllLinkedAddons({ id: ownerId, appId }).then(sendToApi);
 
   if (showAll == null) {
     return myAddons;
@@ -191,12 +191,12 @@ async function getId (ownerId, addon) {
 
 export async function link (ownerId, appId, addon) {
   const addonId = await getId(ownerId, addon);
-  return application.linkAddon({ id: ownerId, appId }, JSON.stringify(addonId)).then(sendToApi);
+  return linkAddon({ id: ownerId, appId }, JSON.stringify(addonId)).then(sendToApi);
 }
 
 export async function unlink (ownerId, appId, addon) {
   const addonId = await getId(ownerId, addon);
-  return application.unlinkAddon({ id: ownerId, appId, addonId }).then(sendToApi);
+  return unlinkAddon({ id: ownerId, appId, addonId }).then(sendToApi);
 }
 
 export async function deleteAddon (ownerId, addonIdOrName, skipConfirmation) {

package/src/models/application.js

@@ -1,7 +1,16 @@
 import _ from 'lodash';
-import * as application from '@clevercloud/client/esm/api/v2/application.js';
+import {
+  create as createApplication,
+  remove as removeApplication,
+  getAll as getAllApplications,
+  get as getApplication,
+  redeploy as redeployApplication,
+  update as updateApplication,
+  getAllDependencies,
+  addDependency,
+  removeDependency,
+} from '@clevercloud/client/esm/api/v2/application.js';
 import cliparse from 'cliparse';
-import * as product from '@clevercloud/client/esm/api/v2/product.js';
 import { getSummary } from '@clevercloud/client/esm/api/v2/user.js';
 
 import * as AppConfiguration from './app_configuration.js';
@@ -12,6 +21,7 @@ import * as User from './user.js';
 
 import { sendToApi } from '../models/send-to-api.js';
 import { resolveOwnerId } from './ids-resolver.js';
+import { getAvailableInstances } from '@clevercloud/client/esm/api/v2/product.js';
 
 export function listAvailableTypes () {
   return cliparse.autocomplete.words(['docker', 'elixir', 'go', 'gradle', 'haskell', 'jar', 'maven', 'meteor', 'node', 'php', 'play1', 'play2', 'python', 'ruby', 'rust', 'sbt', 'static-apache', 'war']);
@@ -42,7 +52,7 @@ async function getId (ownerId, dependency) {
 async function getInstanceType (type) {
 
   // TODO: We should be able to use it without {}
-  const types = await product.getAvailableInstances({}).then(sendToApi);
+  const types = await getAvailableInstances({}).then(sendToApi);
 
   const enabledTypes = types.filter((t) => t.enabled);
   const matchingVariants = enabledTypes.filter((t) => t.variant != null && t.variant.slug === type);
@@ -83,7 +93,7 @@ export async function create (name, typeName, region, orgaIdOrName, github, isTa
     newApp.oauthApp = github;
   }
 
-  return application.create({ id: ownerId }, newApp).then(sendToApi);
+  return createApplication({ id: ownerId }, newApp).then(sendToApi);
 };
 
 export async function deleteApp (app, skipConfirmation) {
@@ -97,7 +107,7 @@ export async function deleteApp (app, skipConfirmation) {
     );
   }
 
-  return application.remove({ id: app.ownerId, appId: app.id }).then(sendToApi);
+  return removeApplication({ id: app.ownerId, appId: app.id }).then(sendToApi);
 };
 
 export async function getAllApps (ownerId) {
@@ -123,7 +133,7 @@ export async function getAllApps (ownerId) {
 };
 
 async function getApplicationsForOwner (ownerId) {
-  const rawApplications = await application.getAll({ id: ownerId }).then(sendToApi);
+  const rawApplications = await getAllApplications({ id: ownerId }).then(sendToApi);
   return rawApplications.map((app) => {
     return {
       app_id: app.id,
@@ -150,13 +160,13 @@ function getApplicationByName (apps, name) {
 };
 
 async function getByName (ownerId, name) {
-  const apps = await application.getAll({ id: ownerId }).then(sendToApi);
+  const apps = await getAllApplications({ id: ownerId }).then(sendToApi);
   return getApplicationByName(apps, name);
 };
 
 export function get (ownerId, appId) {
   Logger.debug(`Get information for the app: ${appId}`);
-  return application.get({ id: ownerId, appId }).then(sendToApi);
+  return getApplication({ id: ownerId, appId }).then(sendToApi);
 };
 
 function getFromSelf (appId) {
@@ -164,7 +174,7 @@ function getFromSelf (appId) {
   // /self differs from /organisations only for this one:
   // it fallbacks to the organisations of which the user
   // is a member, if it doesn't belong to Personal Space.
-  return application.get({ appId }).then(sendToApi);
+  return getApplication({ appId }).then(sendToApi);
 };
 
 /**
@@ -245,7 +255,7 @@ export function unlinkRepo (alias) {
 export function redeploy (ownerId, appId, commit, withoutCache) {
   Logger.debug(`Redeploying the app: ${appId}`);
   const useCache = (withoutCache) ? 'no' : null;
-  return application.redeploy({ id: ownerId, appId, commit, useCache }).then(sendToApi);
+  return redeployApplication({ id: ownerId, appId, commit, useCache }).then(sendToApi);
 };
 
 export function mergeScalabilityParameters (scalabilityParameters, instance) {
@@ -283,7 +293,7 @@ export function mergeScalabilityParameters (scalabilityParameters, instance) {
 export async function setScalability (appId, ownerId, scalabilityParameters, buildFlavor) {
   Logger.info('Scaling the app: ' + appId);
 
-  const app = await application.get({ id: ownerId, appId }).then(sendToApi);
+  const app = await getApplication({ id: ownerId, appId }).then(sendToApi);
   const instance = _.cloneDeep(app.instance);
 
   instance.minFlavor = instance.minFlavor.name;
@@ -301,17 +311,17 @@ export async function setScalability (appId, ownerId, scalabilityParameters, bui
     }
   }
 
-  return application.update({ id: ownerId, appId }, newConfig).then(sendToApi);
+  return updateApplication({ id: ownerId, appId }, newConfig).then(sendToApi);
 };
 
 export async function listDependencies (ownerId, appId, showAll) {
-  const applicationDeps = await application.getAllDependencies({ id: ownerId, appId }).then(sendToApi);
+  const applicationDeps = await getAllDependencies({ id: ownerId, appId }).then(sendToApi);
 
   if (!showAll) {
     return applicationDeps.map((app) => ({ ...app, isLinked: true }));
   }
 
-  const allApps = await application.getAll({ id: ownerId }).then(sendToApi);
+  const allApps = await getAllApplications({ id: ownerId }).then(sendToApi);
 
   const applicationDepsIds = applicationDeps.map((app) => app.id);
   return allApps.map((app) => {
@@ -322,10 +332,10 @@ export async function listDependencies (ownerId, appId, showAll) {
 
 export async function link (ownerId, appId, dependency) {
   const dependencyId = await getId(ownerId, dependency);
-  return application.addDependency({ id: ownerId, appId, dependencyId }).then(sendToApi);
+  return addDependency({ id: ownerId, appId, dependencyId }).then(sendToApi);
 };
 
 export async function unlink (ownerId, appId, dependency) {
   const dependencyId = await getId(ownerId, dependency);
-  return application.removeDependency({ id: ownerId, appId, dependencyId }).then(sendToApi);
+  return removeDependency({ id: ownerId, appId, dependencyId }).then(sendToApi);
 };