clever-tools 4.4.1 → 4.5.0

package/src/commands/kv.js

@@ -1,93 +0,0 @@
-import { getAllEnvVars } from '@clevercloud/client/esm/api/v2/addon.js';
-import Redis from 'ioredis';
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import { findAddonsByNameOrId } from '../models/ids-resolver.js';
-import { sendToApi } from '../models/send-to-api.js';
-
-const URL_ENV_KEY = 'REDIS_URL';
-const MAX_RETRIES_PER_REQUEST = 1;
-
-/**
- * Send a raw command to a compatible KV database
- * @param {Object} params
- * @param {Array<string>} params.args
- * @param {Object} params.options
- * @param {string} params.options.format
- * @returns {Promise<void>}
- */
-export async function sendRawCommand(params) {
-  const [addonIdOrRealIdOrName] = params.args;
-  const { org, format } = params.options;
-
-  const addons = await findAddonsByNameOrId(addonIdOrRealIdOrName, org);
-
-  if (addons.length === 0) {
-    throw new Error(`Add-on ${addonIdOrRealIdOrName} not found`);
-  }
-
-  if (addons.length > 1) {
-    const formattedAddons = addons
-      .map(({ addonId, ownerId }) => `\n${styleText('grey', `- ${addonId} (${ownerId})`)}`)
-      .join('');
-    throw new Error(`Several add-ons found for '${addonIdOrRealIdOrName}', use ID instead:${formattedAddons}`);
-  }
-
-  const { addonId, ownerId } = addons[0];
-
-  const url = await getAddonUrl(ownerId, addonId);
-
-  Logger.debug(`Extracted command: ${params.args.join(' ')}`);
-  const command = params.args.slice(1);
-
-  const result = await sendCommand(url, command);
-
-  switch (format) {
-    case 'json': {
-      Logger.printJson(result);
-      break;
-    }
-    case 'human':
-    default: {
-      Logger.println(result);
-    }
-  }
-}
-
-/**
- * Get the URL of the compatible KV database
- * @param {string} ownerId
- * @param {string} addonId
- * @returns {Promise<string>} the URL of the compatible KV database
- */
-async function getAddonUrl(ownerId, addonId) {
-  const envVars = await getAllEnvVars({ id: ownerId, addonId }).then(sendToApi);
-  const redisUrl = envVars.find((env) => env.name === URL_ENV_KEY)?.value;
-
-  if (!redisUrl) {
-    throw new Error(
-      `Environment variable ${styleText('red', URL_ENV_KEY)} not found, is it a Materia KV or Redis® add-on?`,
-    );
-  }
-
-  return redisUrl;
-}
-
-/**
- * Send a command to a compatible KV database
- * @param {string} url
- * @param {Array<string>} command
- * @returns {Promise<string>} the command result
- */
-async function sendCommand(url, command) {
-  Logger.debug(`Sending command '${command.join(' ')}' to ${url}`);
-  const client = new Redis(url, { maxRetriesPerRequest: MAX_RETRIES_PER_REQUEST });
-  try {
-    const result = await client.call(...command);
-    Logger.debug(`Command result: ${result}`);
-    return result;
-  } finally {
-    await client.disconnect();
-    Logger.debug('Disconnected from server');
-  }
-}

package/src/commands/link.js

@@ -1,20 +0,0 @@
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import * as Application from '../models/application.js';
-
-export async function link(params) {
-  const [app] = params.args;
-  const { org: orgaIdOrName, alias } = params.options;
-
-  let appConfigEntry;
-  if (app.app_id != null && orgaIdOrName != null) {
-    Logger.warn("You've specified a unique application ID, organisation option will be ignored");
-    appConfigEntry = await Application.linkRepo(app, null, alias);
-  } else {
-    appConfigEntry = await Application.linkRepo(app, orgaIdOrName, alias);
-  }
-
-  Logger.printSuccess(
-    `Application ${styleText('green', appConfigEntry.app_id)} has been successfully linked to local alias ${styleText('green', appConfigEntry.alias)}!`,
-  );
-}

package/src/commands/logout.js

@@ -1,8 +0,0 @@
-import { Logger } from '../logger.js';
-import { conf, writeOAuthConf } from '../models/configuration.js';
-
-export async function logout() {
-  // write empty object
-  await writeOAuthConf({});
-  Logger.println(`${conf.CONFIGURATION_FILE} has been updated.`);
-}

package/src/commands/logs.js

@@ -1,45 +0,0 @@
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import * as Application from '../models/application.js';
-import { resolveAddonId } from '../models/ids-resolver.js';
-import * as Log from '../models/log-v4.js';
-import * as LogV2 from '../models/log.js';
-import { Deferred } from '../models/utils.js';
-
-export async function appLogs(params) {
-  const {
-    alias,
-    app: appIdOrName,
-    addon: addonIdOrRealId,
-    after: since,
-    before: until,
-    search,
-    'deployment-id': deploymentId,
-    format,
-  } = params.options;
-
-  // ignore --search ""
-  const filter = search !== '' ? search : null;
-  const isForHuman = format === 'human';
-
-  // TODO: drop when addons are migrated to the v4 API
-  if (addonIdOrRealId != null) {
-    const addonId = await resolveAddonId(addonIdOrRealId);
-    if (isForHuman) {
-      Logger.println(styleText('blue', 'Waiting for addon logs…'));
-    } else {
-      throw new Error(`"${format}" format is not yet available for add-on logs`);
-    }
-    return LogV2.displayLogs({ appAddonId: addonId, since, until, filter, deploymentId });
-  }
-
-  const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
-
-  if (isForHuman) {
-    Logger.println(styleText('blue', 'Waiting for application logs…'));
-  }
-
-  const deferred = new Deferred();
-  await Log.displayLogs({ ownerId, appId, since, until, filter, deploymentId, format, deferred });
-  return deferred.promise;
-}

package/src/commands/makeDefault.js

@@ -1,11 +0,0 @@
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import * as AppConfig from '../models/app_configuration.js';
-
-export async function makeDefault(params) {
-  const [alias] = params.args;
-
-  await AppConfig.setDefault(alias);
-
-  Logger.printSuccess(`The application ${styleText('green', alias)} has been set as default`);
-}

package/src/commands/matomo.js

@@ -1,85 +0,0 @@
-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

@@ -1,112 +0,0 @@
-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/ng.js

@@ -1,202 +0,0 @@
-import { printResults } from '../lib/ng-print.js';
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import * as networkGroupResources from '../models/ng-resources.js';
-import * as networkGroup from '../models/ng.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 ${styleText('green', label)} successfully created`;
-  if (membersIds == null) {
-    Logger.printSuccess(`${successMessage}!`);
-  } else {
-    Logger.printSuccess(`${successMessage} with member(s):`);
-    Logger.println(membersIds.map((id) => styleText('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 ${styleText('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 ${styleText('green', peerIdOrLabel.ngResourceLabel)} successfully created in Network Group ${styleText('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 ${styleText('green', peerText)} successfully deleted from Network Group ${styleText('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 ${styleText('green', resourceId.memberId)} successfully linked to Network Group ${styleText('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 ${styleText('green', resourceId.memberId)} successfully unlinked from Network Group ${styleText('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 ${styleText('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/notify-email.js

@@ -1,99 +0,0 @@
-import { createEmailhook, deleteEmailhook, getEmailhooks } from '@clevercloud/client/esm/api/v2/notification.js';
-import { styleText } from '../lib/style-text.js';
-import { Logger } from '../logger.js';
-import { getOrgaIdOrUserId, getOwnerAndApp } from '../models/notification.js';
-import { sendToApi } from '../models/send-to-api.js';
-
-export async function list(params) {
-  const { org, 'list-all': listAll, format } = params.options;
-
-  // TODO: fix alias option
-  const { ownerId, appId } = await getOwnerAndApp(null, org, !listAll);
-  const hooks = await getEmailhooks({ ownerId }).then(sendToApi);
-
-  const formattedHooks = hooks
-    .filter((hook) => {
-      const emptyScope = !hook.scope || hook.scope.length === 0;
-      return !appId || emptyScope || hook.scope.includes(appId);
-    })
-    .map((hook) => ({
-      id: hook.id,
-      name: hook.name,
-      ownerId: hook.ownerId,
-      services: hook.scope ?? [hook.ownerId],
-      events: hook.events ?? ['ALL'],
-      notified: hook.notified ? hook.notified.map(({ target }) => target ?? 'whole team') : ['whole team'],
-    }));
-
-  switch (format) {
-    case 'json': {
-      Logger.printJson(formattedHooks);
-      break;
-    }
-    case 'human':
-    default: {
-      formattedHooks.forEach((hook) => {
-        Logger.println(styleText('bold', hook.name ?? hook.id));
-        Logger.println(`  id: ${hook.id}`);
-        Logger.println(`  services: ${hook.services.join(', ')}`);
-        Logger.println(`  events: ${hook.events.join(', ')}`);
-        if (hook.notified.length > 1) {
-          Logger.println('  to:');
-          hook.notified.forEach((target) => Logger.println(`    ${target}`));
-        } else {
-          Logger.println(`  to: ${hook.notified[0]}`);
-        }
-      });
-    }
-  }
-}
-
-export function getEmailNotificationTargets(notifTargets) {
-  if (notifTargets == null) {
-    return [];
-  }
-
-  return notifTargets
-    .map((el) => {
-      if (el.includes('@')) {
-        return { type: 'email', target: el };
-      }
-      if (el.startsWith('user_')) {
-        return { type: 'userid', target: el };
-      }
-      if (el.toLowerCase() === 'organisation') {
-        return { type: 'organisation' };
-      }
-      return null;
-    })
-    .filter((e) => e != null);
-}
-
-export async function add(params) {
-  const { org, event: events, service, notify: notifTargets } = params.options;
-  const [name] = params.args;
-
-  // TODO: fix alias option
-  const { ownerId, appId } = await getOwnerAndApp(null, org, !org && !service);
-
-  const body = {
-    name,
-    notified: getEmailNotificationTargets(notifTargets),
-    scope: appId != null && service == null ? [appId] : service,
-    events,
-  };
-
-  await createEmailhook({ ownerId }, body).then(sendToApi);
-
-  Logger.println('The webhook has been added');
-}
-
-export async function remove(params) {
-  const { org } = params.options;
-  const [notificationId] = params.args;
-
-  const ownerId = await getOrgaIdOrUserId(org);
-  await deleteEmailhook({ ownerId, id: notificationId }).then(sendToApi);
-
-  Logger.println('The notification has been successfully removed');
-}

package/src/commands/open.js

@@ -1,13 +0,0 @@
-import * as Application from '../models/application.js';
-import * as Domain from '../models/domain.js';
-import { openBrowser } from '../models/utils.js';
-
-export async function open(params) {
-  const { alias, app: appIdOrName } = params.options;
-  const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
-
-  const vhost = await Domain.getBest(appId, ownerId);
-  const url = 'https://' + vhost.fqdn;
-
-  await openBrowser(url, 'Opening the application in your browser');
-}