clever-tools 3.13.1 → 4.0.0

package/src/commands/tokens.js

@@ -1,11 +1,11 @@
-import colors from 'colors/safe.js';
-import { Logger } from '../logger.js';
+import dedent from 'dedent';
+import { styleText } from 'node:util';
 import { createApiToken, deleteApiToken, listApiTokens } from '../clever-client/auth-bridge.js';
+import { promptSecret } from '../lib/prompts.js';
+import { Logger } from '../logger.js';
+import { conf } from '../models/configuration.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 { promptSecret } from '../lib/prompts.js';
 
 /**
  * Create a new API token
@@ -15,7 +15,7 @@ import { promptSecret } from '../lib/prompts.js';
  * @param {'json'|'human'} params.options.format - Output format
  * @param {number} params.options.expiration - Expiration date as timestamp
  */
-export async function create (params) {
+export async function create(params) {
   const [apiTokenName] = params.args;
   const { expiration, format } = params.options;
   const user = await getCurrentUser();
@@ -23,8 +23,8 @@ export async function create (params) {
   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)}
+      ${styleText('yellow', '!')} Your Clever Cloud account is linked via GitHub and has no password. Setting one is required to create API tokens.
+      ${styleText('blue', '→')} To do so, go to the following URL: ${styleText('blue', apiTokenListHref)}
     `);
   }
 
@@ -39,8 +39,7 @@ export async function create (params) {
       throw new Error('You cannot set an expiration date greater than 1 year');
     }
     expirationDate = new Date(expiration);
-  }
-  else {
+  } else {
     expirationDate = maxExpirationDate;
   }
 
@@ -58,16 +57,18 @@ export async function create (params) {
     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;
-  });
+  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':
@@ -76,11 +77,11 @@ export async function create (params) {
     case 'human':
     default:
       Logger.println(dedent`
-        ${colors.green('✔')} API token successfully created! Store it securely, you won't able to print it again.
+        ${styleText('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))}
+          - API token ID : ${styleText('grey', createdToken.apiTokenId)}
+          - API token    : ${styleText('grey', createdToken.apiToken)}
+          - Expiration   : ${styleText('grey', formatDate(createdToken.expirationDate))}
 
         Export this token and use it to make authenticated requests to the Clever Cloud API through the Auth Bridge:
 
@@ -100,29 +101,29 @@ export async function create (params) {
  * @param {Object} params.options.format - Output format
  * @returns {Promise<void>}
  */
-export async function list (params) {
+export async function list(params) {
   const { format } = params.options;
 
   const tokens = await listApiTokens().then(sendToAuthBridge);
 
   if (format === 'json') {
     Logger.printJson(tokens);
-  }
-  else {
+  } 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),
-          State: token.state,
-        };
-      }));
+      Logger.println(`ℹ️  No API token found, create one with ${styleText('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),
+            State: token.state,
+          };
+        }),
+      );
     }
   }
 }
@@ -133,14 +134,14 @@ export async function list (params) {
  * @param {string[]} params.args - Command line arguments, token ID to revoke is expected as first argument
  * @returns {Promise<void>}
  */
-export async function revoke (params) {
+export async function revoke(params) {
   const [apiTokenId] = params.args;
 
   await deleteApiToken(apiTokenId).then(sendToAuthBridge);
 
-  Logger.println(colors.green('✔'), 'API token successfully revoked!');
+  Logger.println(styleText('green', '✔'), 'API token successfully revoked!');
 }
 
-function formatDate (dateInput) {
+function formatDate(dateInput) {
   return new Date(dateInput).toISOString().substring(0, 16).replace('T', ' ');
 }

package/src/commands/unlink.js

@@ -1,12 +1,14 @@
+import { styleText } from 'node:util';
+import { Logger } from '../logger.js';
 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) {
+export async function unlink(params) {
   const [alias] = params.args;
   const app = await AppConfig.getAppDetails({ alias });
 
   await Application.unlinkRepo(app.alias);
-  Logger.printSuccess(`Application ${colors.green(app.appId)} has been successfully unlinked from local alias ${colors.green(app.alias)}!`);
-};
+  Logger.printSuccess(
+    `Application ${styleText('green', app.appId)} has been successfully unlinked from local alias ${styleText('green', app.alias)}!`,
+  );
+}

package/src/commands/version.js

@@ -1,8 +1,6 @@
+import pkg from '../../package.json' with { type: 'json' };
 import { Logger } from '../logger.js';
-import { getPackageJson } from '../load-package-json.cjs';
 
-const pkg = getPackageJson();
-
-export async function version () {
+export async function version() {
   Logger.println(pkg.version);
 }

package/src/commands/webhooks.js

@@ -1,12 +1,10 @@
-import colors from 'colors/safe.js';
-
+import { createWebhook, deleteWebhook, getWebhooks } from '@clevercloud/client/esm/api/v2/notification.js';
+import { styleText } from 'node:util';
 import { Logger } from '../logger.js';
-import { getOwnerAndApp, getOrgaIdOrUserId } from '../models/notification.js';
-
-import { getWebhooks, createWebhook, deleteWebhook } from '@clevercloud/client/esm/api/v2/notification.js';
+import { getOrgaIdOrUserId, getOwnerAndApp } from '../models/notification.js';
 import { sendToApi } from '../models/send-to-api.js';
 
-export async function list (params) {
+export async function list(params) {
   const { org, 'list-all': listAll, format } = params.options;
 
   // TODO: fix alias option
@@ -35,7 +33,7 @@ export async function list (params) {
     case 'human':
     default: {
       formattedHooks.forEach((hook) => {
-        Logger.println(hook.name ? colors.bold(hook.name) : hook.id);
+        Logger.println(hook.name ? styleText('bold', hook.name) : hook.id);
         Logger.println(`  id: ${hook.id}`);
         Logger.println(`  services: ${hook.services.join(', ')}`);
         Logger.println(`  events: ${hook.events.join(', ')}`);
@@ -46,7 +44,7 @@ export async function list (params) {
   }
 }
 
-export async function add (params) {
+export async function add(params) {
   const { org, format, event: events, service } = params.options;
   const [name, hookUrl] = params.args;
 
@@ -56,7 +54,7 @@ export async function add (params) {
   const body = {
     name,
     urls: [{ format, url: hookUrl }],
-    scope: (appId != null && service == null) ? [appId] : service,
+    scope: appId != null && service == null ? [appId] : service,
     events,
   };
 
@@ -65,7 +63,7 @@ export async function add (params) {
   Logger.println('The webhook has been added');
 }
 
-export async function remove (params) {
+export async function remove(params) {
   const { org } = params.options;
   const [notificationId] = params.args;
 

package/src/experimental-features.js

@@ -1,9 +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',
+    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:
 
@@ -13,7 +15,7 @@ export const EXPERIMENTAL_FEATURES = {
           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/
+      Learn more about Materia KV: ${conf.DOC_URL}/addons/materia-kv/
     `,
   },
   ng: {
@@ -41,7 +43,7 @@ export const EXPERIMENTAL_FEATURES = {
       - Search Network Groups, members or peers:
           clever ng search myQuery
 
-      Learn more about Network Groups: https://www.clever-cloud.com/developers/doc/develop/network-groups/
+      Learn more about Network Groups: ${conf.DOC_URL}/develop/network-groups/
     `,
   },
   operators: {
@@ -51,10 +53,10 @@ export const EXPERIMENTAL_FEATURES = {
       clever keycloak
       clever keycloak get keycloak_xxx
       clever keycloak ng enable myKeycloak
-      
+
       clever metabase version check myMetabase
       clever metabase version update myMetabase 0.53
-      
+
       clever matomo open myMatomo
       clever otoroshi open logs myOtoroshi
     `,

package/src/format-table.js

@@ -1,20 +1,51 @@
-import _ from 'lodash';
-import table from 'text-table';
-import stringLength from 'string-length';
+import charRegex from 'char-regex';
+import { stripVTControlCharacters } from 'node:util';
 
-export function formatTable (columnWidth = []) {
+const SEPARATOR = '  ';
 
+function stringLength(string) {
+  if (!string) {
+    return 0;
+  }
+  const stringWithoutAnsi = stripVTControlCharacters(string);
+  if (!stringWithoutAnsi) {
+    return 0;
+  }
+  const stringWithSplitEmojis = stringWithoutAnsi.match(charRegex());
+  if (!stringWithSplitEmojis) {
+    return 0;
+  }
+  return stringWithSplitEmojis.length;
+}
+
+export const formatTable = (data, columnWidth = []) => {
   const fixedWidthPlaceholder = columnWidth.map((item) => {
-    if (typeof item === 'number') {
-      return _.repeat(' ', item);
-    }
-    return item;
+    return typeof item === 'number' ? ' '.repeat(item) : item;
   });
 
-  return function (data) {
-    return table([fixedWidthPlaceholder, ...data], { stringLength })
-      .split('\n')
-      .slice(1)
-      .join('\n');
-  };
-}
+  const columnSizes = [fixedWidthPlaceholder, ...data]
+    .map((row) => row.map((cell) => String(cell)))
+    .reduce((acc, row) => {
+      row.forEach((cell, index) => {
+        const cellLength = stringLength(cell);
+        acc[index] = Math.max(acc[index] ?? 0, cellLength);
+      });
+      return acc;
+    }, []);
+
+  return data
+    .map((row) => row.map((cell) => String(cell)))
+    .map((row) => {
+      return row
+        .map((cell, index) => {
+          const isLastColumn = index === row.length - 1;
+          if (isLastColumn) {
+            return cell;
+          }
+          const rightPaddingLength = columnSizes[index] - stringLength(cell) ?? 0;
+          return cell + ' '.repeat(rightPaddingLength);
+        })
+        .join(SEPARATOR);
+    })
+    .join('\n');
+};

package/src/initial-setup.js

@@ -1,17 +1,4 @@
-import colors from 'colors/safe.js';
-import { getPackageJson } from './load-package-json.cjs';
-import updateNotifierModule from 'update-notifier';
-
-function hasParam (param, paramValue) {
-  const index = process.argv.indexOf(param);
-  if (index === -1) {
-    return false;
-  }
-  if (paramValue != null) {
-    return process.argv[index + 1] === paramValue;
-  }
-  return true;
-}
+import { hasParam } from './lib/has-param.js';
 
 // These need to be set before Logger and other stuffs
 if (hasParam('-v') || hasParam('--verbose')) {
@@ -28,22 +15,5 @@ if (hasParam('--autocomplete-index')) {
 const colorExplicitFalse = hasParam('--no-color') || hasParam('--color', 'false');
 const colorExplicitTrue = hasParam('--color', 'true');
 if (colorExplicitFalse || (!process.stdout.isTTY && !colorExplicitTrue)) {
-  colors.disable();
-}
-
-// These need to be set before Logger and other stuffs
-const pkg = getPackageJson();
-const isRunThroughPackagedBinary = process.pkg != null;
-const updateNotifierExplicitFalse = hasParam('--no-update-notifier') || hasParam('--update-notifier', 'false');
-if (!updateNotifierExplicitFalse && !isRunThroughPackagedBinary) {
-  updateNotifierModule({
-    pkg,
-    tagsUrl: 'https://api.github.com/repos/CleverCloud/clever-tools/tags',
-  }).notify({
-    isGlobal: true,
-    getDetails () {
-      const docsUrl = 'https://github.com/CleverCloud/clever-tools/tree/master/docs#how-to-use-clever-tools';
-      return `\nPlease follow this link to update your clever-tools:\n${docsUrl}`;
-    },
-  });
+  process.env.NO_COLOR = '1';
 }

package/src/initial-update-notifier.js

@@ -0,0 +1,18 @@
+import updateNotifierModule from 'update-notifier';
+import pkg from '../package.json' with { type: 'json' };
+import { hasParam } from './lib/has-param.js';
+
+// These need to be set before Logger and other stuffs
+const updateNotifierExplicitFalse = hasParam('--no-update-notifier') || hasParam('--update-notifier', 'false');
+if (!updateNotifierExplicitFalse) {
+  updateNotifierModule({
+    pkg,
+    tagsUrl: 'https://api.github.com/repos/CleverCloud/clever-tools/tags',
+  }).notify({
+    isGlobal: true,
+    getDetails() {
+      const docsUrl = 'https://github.com/CleverCloud/clever-tools/tree/master/docs#how-to-use-clever-tools';
+      return `\nPlease follow this link to update your clever-tools:\n${docsUrl}`;
+    },
+  });
+}

package/src/lib/has-param.js

@@ -0,0 +1,16 @@
+/**
+ * Check if a specific parameter exists in the command line arguments.
+ * @param {string} param
+ * @param {string} [paramValue]
+ * @return {boolean}
+ */
+export function hasParam(param, paramValue) {
+  const index = process.argv.indexOf(param);
+  if (index === -1) {
+    return false;
+  }
+  if (paramValue != null) {
+    return process.argv[index + 1] === paramValue;
+  }
+  return true;
+}

package/src/lib/ng-print.js

@@ -1,7 +1,6 @@
-import colors from 'colors/safe.js';
-import * as networkGroup from '../models/ng.js';
-
+import { styleText } from 'node:util';
 import { Logger } from '../logger.js';
+import * as networkGroup from '../models/ng.js';
 
 /**
  * Print a Network Group
@@ -9,8 +8,7 @@ import { Logger } from '../logger.js';
  * @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) {
-
+function printNg(ng, format, full = false) {
   switch (format) {
     case 'json': {
       Logger.printJson(ng);
@@ -31,19 +29,19 @@ function printNg (ng, format, full = false) {
       if (full) {
         const members = Object.entries(ng.members)
           .sort((a, b) => a[1].domainName.localeCompare(b[1].domainName))
-          .map(([id, member]) => ({
+          .map(([_id, member]) => ({
             Domain: member.domainName,
           }));
         if (members.length > 0) {
-          Logger.println(colors.bold(' • Members:'));
+          Logger.println(styleText('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));
+          .map(([_id, peer]) => formatPeer(peer));
         if (peers.length > 0) {
-          Logger.println(colors.bold(' • Peers:'));
+          Logger.println(styleText('bold', ' • Peers:'));
           console.table(peers);
         }
       }
@@ -56,8 +54,7 @@ function printNg (ng, format, full = false) {
  * @param {Object} member The Network Group member to print
  * @param {string} format Output format
  */
-function printMember (member, format) {
-
+function printMember(member, format) {
   switch (format) {
     case 'json': {
       Logger.printJson(member);
@@ -79,7 +76,7 @@ function printMember (member, format) {
  * @param {string} format Output format
  * @param {boolean} full If true, get more details about the peer (default: false)
  */
-function printPeer (peer, format, full = false) {
+function printPeer(peer, format, full = false) {
   switch (format) {
     case 'json': {
       Logger.printJson(peer);
@@ -97,7 +94,7 @@ function printPeer (peer, format, full = false) {
  * @param {Object} peer
  * @param {boolean} full If true, get more details about the peer (default: false)
  */
-function formatPeer (peer, full = false) {
+function formatPeer(peer, full = false) {
   const peerToPrint = {
     'Parent Member': peer.parentMember,
     ID: peer.id,
@@ -108,8 +105,7 @@ function formatPeer (peer, full = false) {
   if (full) {
     if (peer.endpoint.ngTerm != null) {
       peerToPrint['Host:IP'] = `${peer.endpoint.ngTerm.host}:${peer.endpoint.ngTerm.port}`;
-    }
-    else {
+    } else {
       peerToPrint.Host = peer.endpoint.ngIp;
     }
     if (peer.endpoint.publicTerm != null) {
@@ -128,18 +124,17 @@ function formatPeer (peer, full = false) {
  * @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) {
-
+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)}`);
+    const searchString = idOrLabel.ngId ?? idOrLabel.memberId ?? idOrLabel.ngResourceLabel;
+    Logger.println(
+      `${styleText('blue', '!')} No Network Group or resource found for ${styleText('blue', searchString)}`,
+    );
     return;
   }
 
@@ -175,17 +170,19 @@ export async function printResults (idOrLabel, org, format, action, type) {
       case 'human':
       default: {
         if (grouped.NetworkGroup) {
-          Logger.println(`${colors.bold(` • Found ${grouped.NetworkGroup.length} Network Group(s):`)}`);
+          Logger.println(`${styleText('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):`)}`);
+          Logger.println(`${styleText('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):`)}`);
+          Logger.println(
+            `${styleText('bold', ` • Found ${grouped.ExternalPeer.length + grouped.CleverPeer.length} Peer(s):`)}`,
+          );
           grouped.CleverPeer?.forEach((item) => printPeer(item, format));
           grouped.ExternalPeer?.forEach((item) => printPeer(item, format));
         }