clever-tools 3.8.3 → 3.9.0

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "clever-tools",
-  "version": "3.8.3",
+  "version": "3.9.0",
   "description": "Command Line Interface for Clever Cloud.",
   "main": "bin/clever.js",
+  "type": "module",
   "keywords": [
     "clever-tools",
     "cli",
@@ -25,8 +26,8 @@
     "scripts/*.sh"
   ],
   "dependencies": {
-    "@clevercloud/client": "8.3.0",
-    "cliparse": "0.4.0",
+    "@clevercloud/client": "9.1.0",
+    "cliparse": "0.5.0",
     "colors": "1.4.0",
     "common-env": "6.4.0",
     "curlconverter": "3.21.0",
@@ -43,6 +44,7 @@
     "string-length": "4.0.2",
     "superagent": "6.1.0",
     "text-table": "0.2.0",
+    "tldts": "6.1.30",
     "update-notifier": "5.1.0",
     "uuid": "8.3.2",
     "ws": "7.4.6",
@@ -51,6 +53,9 @@
   "devDependencies": {
     "@commitlint/cli": "18.4.3",
     "@commitlint/config-conventional": "18.4.3",
+    "@rollup/plugin-commonjs": "26.0.1",
+    "@rollup/plugin-json": "6.1.0",
+    "@rollup/plugin-node-resolve": "15.2.3",
     "aws-sdk": "2.919.0",
     "chai": "4.3.4",
     "del": "6.0.0",
@@ -66,6 +71,7 @@
     "grunt-cli": "1.4.3",
     "grunt-http": "2.3.3",
     "grunt-mocha-test": "0.13.3",
+    "magic-string": "0.30.11",
     "mime-types": "2.1.35",
     "mocha": "8.4.0",
     "pkg": "5.8.1",
@@ -76,6 +82,7 @@
     "pkg-fetch": "3.5.2"
   },
   "scripts": {
+    "build": "rollup -c rollup.config.js",
     "pretest": "npm run lint",
     "test": "grunt test",
     "lint": "eslint bin src scripts",

package/src/command-options.js

@@ -1,6 +1,6 @@
-const cliparse = require('cliparse');
+import cliparse from 'cliparse';
 
-function getOutputFormatOption (formats = []) {
+export function getOutputFormatOption (formats = []) {
   const availableFormats = ['human', 'json', ...formats];
   return cliparse.option('format', {
     aliases: ['F'],
@@ -18,7 +18,7 @@ function getOutputFormatOption (formats = []) {
   });
 }
 
-function getSameCommitPolicyOption () {
+export function getSameCommitPolicyOption () {
   const availablePolicies = ['error', 'ignore', 'restart', 'rebuild'];
   return cliparse.option('same-commit-policy', {
     aliases: ['p'],
@@ -36,7 +36,7 @@ function getSameCommitPolicyOption () {
   });
 }
 
-function getExitOnOption () {
+export function getExitOnOption () {
   const availableExitOn = ['deploy-start', 'deploy-end', 'never'];
   return cliparse.option('exit-on', {
     aliases: ['e'],
@@ -53,9 +53,3 @@ function getExitOnOption () {
     },
   });
 }
-
-module.exports = {
-  getOutputFormatOption,
-  getSameCommitPolicyOption,
-  getExitOnOption,
-};

package/src/command-promise-handler.js

@@ -1,10 +1,10 @@
-'use strict';
+import { Logger } from './logger.js';
+import { getPackageJson } from './load-package-json.cjs';
+import semver from 'semver';
 
-const Logger = require('./logger.js');
-const pkg = require('../package.json');
-const semver = require('semver');
+const pkg = getPackageJson();
 
-function handleCommandPromise (promise) {
+export function handleCommandPromise (promise) {
   promise.catch((error) => {
     Logger.error(error);
     const semverIsOk = semver.satisfies(process.version, pkg.engines.node);
@@ -14,5 +14,3 @@ function handleCommandPromise (promise) {
     process.exit(1);
   });
 }
-
-module.exports = handleCommandPromise;

package/src/commands/accesslogs.js

@@ -1,20 +1,18 @@
-'use strict';
-
-const Application = require('../models/application.js');
-const Logger = require('../logger.js');
-const { getHostAndTokens } = require('../models/send-to-api.js');
-const { ApplicationAccessLogStream } = require('@clevercloud/client/cjs/streams/access-logs.js');
-const { JsonArray } = require('../models/json-array.js');
-const colors = require('colors/safe');
-const formatTable = require('../format-table.js');
-const { truncateWithEllipsis } = require('../models/utils.js');
+import * as Application from '../models/application.js';
+import { Logger } from '../logger.js';
+import { getHostAndTokens } from '../models/send-to-api.js';
+import { ApplicationAccessLogStream } from '@clevercloud/client/esm/streams/access-logs.js';
+import { JsonArray } from '../models/json-array.js';
+import colors from 'colors/safe.js';
+import { formatTable } from '../format-table.js';
+import { truncateWithEllipsis } from '../models/utils.js';
 
 // 2000 logs per 100ms maximum
 const THROTTLE_ELEMENTS = 2000;
 const THROTTLE_PER_IN_MILLISECONDS = 100;
 const CITY_MAX_LENGTH = 20;
 
-async function accessLogs (params) {
+export async function accessLogs (params) {
 
   // TODO: drop when add-ons are supported in API
   if (params.options.addon) {
@@ -129,5 +127,3 @@ function colorStatusCode (code) {
   }
   return code;
 }
-
-module.exports = { accessLogs };

package/src/commands/activity.js

@@ -1,15 +1,13 @@
-'use strict';
+import colors from 'colors/safe.js';
+import moment from 'moment';
 
-const colors = require('colors/safe');
-const moment = require('moment');
-
-const Activity = require('../models/activity.js');
-const formatTable = require('../format-table');
-const Logger = require('../logger.js');
-const { Deferred } = require('../models/utils.js');
-const { EventsStream } = require('@clevercloud/client/cjs/streams/events.node.js');
-const { getHostAndTokens } = require('../models/send-to-api.js');
-const Application = require('../models/application.js');
+import * as Activity from '../models/activity.js';
+import { formatTable } from '../format-table.js';
+import { Logger } from '../logger.js';
+import { Deferred } from '../models/utils.js';
+import { EventsStream } from '@clevercloud/client/esm/streams/events.node.js';
+import { getHostAndTokens } from '../models/send-to-api.js';
+import * as Application from '../models/application.js';
 
 function getColoredState (state, isLast) {
   if (state === 'OK') {
@@ -134,7 +132,7 @@ function getEventHandler (format, follow) {
   }
 }
 
-async function activity (params) {
+export async function activity (params) {
   const { alias, app: appIdOrName, 'show-all': showAll, follow, format } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
   const events = await Activity.list(ownerId, appId, showAll);
@@ -173,5 +171,3 @@ async function activity (params) {
 
   return deferred.promise;
 }
-
-module.exports = { activity };

package/src/commands/addon.js

@@ -1,20 +1,20 @@
-'use strict';
-
-const colors = require('colors/safe');
-
-const Addon = require('../models/addon.js');
-const AppConfig = require('../models/app_configuration.js');
-const formatTable = require('../format-table')();
-const Logger = require('../logger.js');
-const Organisation = require('../models/organisation.js');
-const User = require('../models/user.js');
-const { parseAddonOptions, findOwnerId } = require('../models/addon.js');
-const { getAllEnvVars } = require('@clevercloud/client/cjs/api/v2/addon.js');
-const { sendToApi } = require('../models/send-to-api.js');
-const { toNameEqualsValueString } = require('@clevercloud/client/cjs/utils/env-vars.js');
-const { resolveAddonId } = require('../models/ids-resolver.js');
-
-async function list (params) {
+import colors from 'colors/safe.js';
+
+import * as Addon from '../models/addon.js';
+import * as AppConfig from '../models/app_configuration.js';
+import { formatTable as initFormatTable } from '../format-table.js';
+import { Logger } from '../logger.js';
+import * as Organisation from '../models/organisation.js';
+import * as User from '../models/user.js';
+import { parseAddonOptions, findOwnerId } from '../models/addon.js';
+import { getAllEnvVars } from '@clevercloud/client/esm/api/v2/addon.js';
+import { sendToApi } from '../models/send-to-api.js';
+import { toNameEqualsValueString } from '@clevercloud/client/esm/utils/env-vars.js';
+import { resolveAddonId } from '../models/ids-resolver.js';
+
+const formatTable = initFormatTable();
+
+export async function list (params) {
   const { org: orgaIdOrName, format } = params.options;
 
   const ownerId = await Organisation.getId(orgaIdOrName);
@@ -53,7 +53,7 @@ async function list (params) {
   }
 }
 
-async function create (params) {
+export async function create (params) {
   const [providerName, name] = params.args;
   const {
     link: linkedAppAlias,
@@ -101,9 +101,24 @@ async function create (params) {
 
 function displayAddon (format, addon, providerName, message) {
 
+  const PROVIDERS_WITH_URL = {
+    keycloak: {
+      name: 'Keycloak',
+      urlEnv: 'CC_KEYCLOAK_URL',
+    },
+    'addon-matomo': {
+      name: 'Matomo',
+      urlEnv: 'MATOMO_URL',
+    },
+    metabase: {
+      name: 'Metabase',
+      urlEnv: 'METABASE_URL',
+    },
+  };
+
   const WIP_PROVIDERS = {
     keycloak: {
-      status: 'alpha',
+      status: 'beta',
       postCreateInstructions: [
         'Learn more about Keycloak on Clever Cloud: https://developers.clever-cloud.com/doc/addons/keycloak/',
       ].join('\n'),
@@ -117,8 +132,14 @@ function displayAddon (format, addon, providerName, message) {
         'Learn more about Materia KV on Clever Cloud: https://developers.clever-cloud.com/doc/addons/materia-kv/',
       ].join('\n'),
     },
+    'addon-matomo': {
+      status: 'beta',
+      postCreateInstructions: [
+        'Learn more about Matomo on Clever Cloud: https://developers.clever-cloud.com/doc/addons/matomo/',
+      ].join('\n'),
+    },
     metabase: {
-      status: 'tech preview',
+      status: 'beta',
       postCreateInstructions: [
         'Learn more about Metabase on Clever Cloud: https://developers.clever-cloud.com/doc/addons/metabase/',
       ].join('\n'),
@@ -152,6 +173,7 @@ function displayAddon (format, addon, providerName, message) {
         id: addon.id,
         realId: addon.realId,
         name: addon.name,
+        env: addon.env,
       };
 
       Logger.printJson((WIP_PROVIDERS[providerName] != null)
@@ -169,6 +191,26 @@ function displayAddon (format, addon, providerName, message) {
         `Name: ${addon.name}`,
       ].join('\n'));
 
+      if (providerName in PROVIDERS_WITH_URL) {
+        const provider = PROVIDERS_WITH_URL[providerName];
+        const urlEnv = addon.env.find((entry) => entry.name === provider.urlEnv);
+        const urlToShow = urlEnv.value;
+
+        if (urlEnv) {
+          Logger.println();
+          Logger.println(`Your ${provider.name} is starting:`);
+          Logger.println(` - Access it: ${urlToShow.startsWith('http') ? urlToShow : `https://${urlToShow}`}`);
+          Logger.println(` - Manage it: https://console.clever-cloud.com/goto/${addon.id}`);
+        }
+
+        if (providerName === 'keycloak') {
+          Logger.println();
+          Logger.println("An initial account has been created, you'll be invited to change the password at first login:");
+          Logger.println(` - Admin user name: ${addon.env.find((e) => e.name === 'CC_KEYCLOAK_ADMIN').value}`);
+          Logger.println(` - Temporary password: ${addon.env.find((e) => e.name === 'CC_KEYCLOAK_ADMIN_DEFAULT_PASSWORD').value}`);
+        }
+      }
+
       if (providerName in WIP_PROVIDERS) {
 
         Logger.println();
@@ -178,27 +220,25 @@ function displayAddon (format, addon, providerName, message) {
   }
 }
 
-async function deleteAddon (params) {
+export async function deleteAddon (params) {
   const { yes: skipConfirmation, org: orgaIdOrName } = params.options;
   const [addon] = params.args;
 
   let ownerId = await Organisation.getId(orgaIdOrName);
-
   if (ownerId == null && addon.addon_id != null) {
     ownerId = await Addon.findOwnerId(ownerId, addon.addon_id);
   }
-
   if (ownerId == null && addon.addon_name != null) {
     const foundAddon = await Addon.findByName(addon.addon_name);
     ownerId = foundAddon.orgaId;
   }
 
-  await Addon.delete(ownerId, addon, skipConfirmation);
+  await Addon.deleteAddon(ownerId, addon, skipConfirmation);
 
   Logger.println(`Addon ${addon.addon_id || addon.addon_name} successfully deleted`);
 }
 
-async function rename (params) {
+export async function rename (params) {
   const [addon, newName] = params.args;
   const { org: orgaIdOrName } = params.options;
 
@@ -208,7 +248,7 @@ async function rename (params) {
   Logger.println(`Addon ${addon.addon_id || addon.addon_name} successfully renamed to ${newName}`);
 }
 
-async function listProviders (params) {
+export async function listProviders (params) {
   const { format } = params.options;
 
   const providers = await Addon.listProviders();
@@ -243,7 +283,7 @@ async function listProviders (params) {
   }
 }
 
-async function showProvider (params) {
+export async function showProvider (params) {
   const [providerName] = params.args;
   const { format } = params.options;
 
@@ -327,7 +367,7 @@ async function showProvider (params) {
   }
 }
 
-async function env (params) {
+export async function env (params) {
 
   const { org, format } = params.options;
   const [addonIdOrRealId] = params.args;
@@ -356,13 +396,3 @@ async function env (params) {
       Logger.println(toNameEqualsValueString(envFromAddon, { addExports: false }));
   }
 }
-
-module.exports = {
-  list,
-  create,
-  delete: deleteAddon,
-  rename,
-  listProviders,
-  showProvider,
-  env,
-};

package/src/commands/applications.js

@@ -1,15 +1,13 @@
-'use strict';
+import colors from 'colors/safe.js';
 
-const colors = require('colors/safe');
+import * as AppConfig from '../models/app_configuration.js';
+import * as Application from '../models/application.js';
+import * as Organisation from '../models/organisation.js';
+import { Logger } from '../logger.js';
+import { formatTable } from '../format-table.js';
+import { truncateWithEllipsis } from '../models/utils.js';
 
-const AppConfig = require('../models/app_configuration.js');
-const Application = require('../models/application.js');
-const Organisation = require('../models/organisation.js');
-const Logger = require('../logger.js');
-const formatTable = require('../format-table.js');
-const { truncateWithEllipsis } = require('../models/utils.js');
-
-async function list (params) {
+export async function list (params) {
   const { 'only-aliases': onlyAliases, json } = params.options;
 
   const { apps } = await AppConfig.loadApplicationConf();
@@ -47,7 +45,7 @@ function formatApps (apps, onlyAliases, json) {
   }
 }
 
-async function listAll (params) {
+export async function listAll (params) {
   const { org: orgaIdOrName, format } = params.options;
 
   const linkedApps = await AppConfig.loadApplicationConf().then((conf) => conf.apps);
@@ -121,8 +119,3 @@ async function listAll (params) {
 function getPropertyMaxWidth (array, propertyName) {
   return Math.max(...array.map((o) => o[propertyName].length));
 }
-
-module.exports = {
-  list,
-  listAll,
-};

package/src/commands/cancel-deploy.js

@@ -1,11 +1,9 @@
-'use strict';
+import * as Application from '../models/application.js';
+import { Logger } from '../logger.js';
+import { getAllDeployments, cancelDeployment } from '@clevercloud/client/esm/api/v2/application.js';
+import { sendToApi } from '../models/send-to-api.js';
 
-const Application = require('../models/application.js');
-const Logger = require('../logger.js');
-const { getAllDeployments, cancelDeployment } = require('@clevercloud/client/cjs/api/v2/application.js');
-const { sendToApi } = require('../models/send-to-api.js');
-
-async function cancelDeploy (params) {
+export async function cancelDeploy (params) {
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
@@ -20,5 +18,3 @@ async function cancelDeploy (params) {
 
   Logger.println('Deployment cancelled!');
 };
-
-module.exports = { cancelDeploy };

package/src/commands/config.js

@@ -1,13 +1,11 @@
-'use strict';
+import * as application from '@clevercloud/client/esm/api/v2/application.js';
 
-const application = require('@clevercloud/client/cjs/api/v2/application.js');
+import * as Application from '../models/application.js';
+import * as ApplicationConfiguration from '../models/application_configuration.js';
 
-const Application = require('../models/application.js');
-const ApplicationConfiguration = require('../models/application_configuration.js');
+import { sendToApi } from '../models/send-to-api.js';
 
-const { sendToApi } = require('../models/send-to-api.js');
-
-async function get (params) {
+export async function get (params) {
   const [configurationName] = params.args;
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
@@ -21,7 +19,7 @@ async function get (params) {
   }
 }
 
-async function set (params) {
+export async function set (params) {
   const [configurationName, configurationValue] = params.args;
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
@@ -34,7 +32,7 @@ async function set (params) {
   }
 }
 
-async function update (params) {
+export async function update (params) {
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
   const options = ApplicationConfiguration.parseOptions(params.options);
@@ -49,5 +47,3 @@ async function update (params) {
     ApplicationConfiguration.printByName(app, configName);
   }
 }
-
-module.exports = { get, set, update };

package/src/commands/console.js

@@ -1,11 +1,9 @@
-'use strict';
+import * as Application from '../models/application.js';
+import * as AppConfig from '../models/app_configuration.js';
+import { Logger } from '../logger.js';
+import openPage from 'open';
 
-const Application = require('../models/application.js');
-const AppConfig = require('../models/app_configuration.js');
-const Logger = require('../logger.js');
-const openPage = require('open');
-
-async function openConsole (params) {
+export async function openConsole (params) {
   const { alias, app: appIdOrName } = params.options;
 
   const baseUrl = 'https://console.clever-cloud.com';
@@ -27,5 +25,3 @@ async function openConsole (params) {
 
   await openPage(url, { wait: false });
 }
-
-module.exports = { openConsole };

package/src/commands/create.js

@@ -1,11 +1,9 @@
-'use strict';
+import path from 'node:path';
+import * as Application from '../models/application.js';
+import * as AppConfig from '../models/app_configuration.js';
+import { Logger } from '../logger.js';
 
-const path = require('path');
-const Application = require('../models/application.js');
-const AppConfig = require('../models/app_configuration.js');
-const Logger = require('../logger.js');
-
-async function create (params) {
+export async function create (params) {
   const { type: typeName } = params.options;
   const [rawName] = params.args;
   const { org: orgaIdOrName, alias, region, github: githubOwnerRepo, format, task: taskCommand } = params.options;
@@ -61,5 +59,3 @@ function getGithubDetails (githubOwnerRepo) {
 function getCurrentDirectoryName () {
   return path.basename(process.cwd());
 }
-
-module.exports = { create };

package/src/commands/curl.js

@@ -1,11 +1,9 @@
-'use strict';
-
-const { spawn } = require('child_process');
-const { loadOAuthConf, conf } = require('../models/configuration.js');
-const { addOauthHeader } = require('@clevercloud/client/cjs/oauth.js');
-const Logger = require('../logger.js');
-const colors = require('colors/safe');
-const curlconverter = require('curlconverter');
+import { spawn } from 'node:child_process';
+import { loadOAuthConf, conf } from '../models/configuration.js';
+import { addOauthHeader } from '@clevercloud/client/esm/oauth.js';
+import { Logger } from '../logger.js';
+import colors from 'colors/safe.js';
+import curlconverter from 'curlconverter';
 
 async function loadTokens () {
   const tokens = await loadOAuthConf();
@@ -36,7 +34,7 @@ Our API documentation is available here :
   ${apiDocUrlv4}`);
 }
 
-async function curl () {
+export async function curl () {
 
   // We remove the first three args: "node", "clever" and "curl"
   const curlArgs = process.argv.slice(3);
@@ -93,5 +91,3 @@ async function parseCurlCommand (curlCommand) {
     queryParams: curlRequestParams.queries,
   };
 }
-
-module.exports = { curl };

package/src/commands/database.js

@@ -1,16 +1,15 @@
-'use strict';
+import { sendToApi } from '../models/send-to-api.js';
+import { getBackups } from '@clevercloud/client/esm/api/v2/backups.js';
+import { Logger } from '../logger.js';
+import { formatTable as initFormatTable } from '../format-table.js';
+import superagent from 'superagent';
+import fs from 'node:fs';
+import { findOwnerId } from '../models/addon.js';
+import { resolveRealId, resolveAddonId } from '../models/ids-resolver.js';
 
-const { sendToApi } = require('../models/send-to-api.js');
-const { getBackups } = require('@clevercloud/client/cjs/api/v2/backups.js');
-const { println } = require('../logger.js');
-const formatTable = require('../format-table')();
-const superagent = require('superagent');
-const fs = require('fs');
-const { findOwnerId } = require('../models/addon.js');
-const { resolveRealId, resolveAddonId } = require('../models/ids-resolver.js');
-const Logger = require('../logger.js');
+const formatTable = initFormatTable();
 
-async function listBackups (params) {
+export async function listBackups (params) {
 
   const { org, format } = params.options;
   const [addonIdOrRealId] = params.args;
@@ -22,7 +21,7 @@ async function listBackups (params) {
   const backups = await getBackups({ ownerId, ref: realId }).then(sendToApi);
 
   if (backups.length === 0 && format === 'human') {
-    println('There are no backups yet');
+    Logger.println('There are no backups yet');
     return;
   }
 
@@ -58,7 +57,7 @@ async function listBackups (params) {
         'STATUS',
       ];
 
-      println(formatTable([
+      Logger.println(formatTable([
         head,
         ...formattedLines,
       ]));
@@ -66,7 +65,7 @@ async function listBackups (params) {
   }
 }
 
-async function downloadBackups (params) {
+export async function downloadBackups (params) {
 
   const { org, output } = params.options;
   const [addonIdOrRealId, backupId] = params.args;
@@ -92,5 +91,3 @@ async function downloadBackups (params) {
 
   process.stdout.write(res.body);
 }
-
-module.exports = { listBackups, downloadBackups };

package/src/commands/delete.js

@@ -1,10 +1,8 @@
-'use strict';
+import * as AppConfig from '../models/app_configuration.js';
+import * as Application from '../models/application.js';
+import { Logger } from '../logger.js';
 
-const AppConfig = require('../models/app_configuration.js');
-const Application = require('../models/application.js');
-const Logger = require('../logger.js');
-
-async function deleteApp (params) {
+export async function deleteApp (params) {
   const { alias, app: appIdOrName, yes: skipConfirmation } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
@@ -23,5 +21,3 @@ async function deleteApp (params) {
     }
   }
 };
-
-module.exports = { deleteApp };