clever-tools 3.8.3 → 3.10.0

package/src/models/node-dns-resolver.js

@@ -0,0 +1,43 @@
+import { Resolver } from 'node:dns/promises';
+
+export class DnsResolver {
+  constructor () {
+    this._resolver = new Resolver();
+  }
+
+  /**
+   * Resolves A records for the given hostname.
+   *
+   * @async
+   * @param {string} hostname - The hostname to resolve A records for.
+   * @returns {Promise<string[]>} A promise that resolves to an array of IP addresses, or an empty array if not found or an error occurs.
+   */
+  resolveA (hostname) {
+    return this._resolver.resolve4(hostname).catch((error) => {
+      switch (error.code) {
+        case 'ENOTFOUND':
+        case 'ENODATA':
+          return [];
+      }
+      throw new Error(`Could not resolve DNS for ${hostname}. Caused by: ${error.message}`);
+    });
+  }
+
+  /**
+   * Resolves CNAME records for the given hostname.
+   *
+   * @async
+   * @param {string} hostname - The hostname to resolve CNAME records for.
+   * @returns {Promise<string|null>} A promise that resolves to the CNAME record if found, or null if not found or an error occurs.
+   */
+  resolveCname (hostname) {
+    return this._resolver.resolveCname(hostname).catch((error) => {
+      switch (error.code) {
+        case 'ENOTFOUND':
+        case 'ENODATA':
+          return null;
+      }
+      throw new Error(`Could not resolve DNS for ${hostname}. Caused by: ${error.message}`);
+    });
+  }
+}

package/src/models/notification.js

@@ -1,13 +1,10 @@
-'use strict';
+import cliparse from 'cliparse';
+import * as AppConfig from '../models/app_configuration.js';
+import * as Organisation from '../models/organisation.js';
+import * as User from '../models/user.js';
 
-const autocomplete = require('cliparse').autocomplete;
-
-const AppConfig = require('../models/app_configuration.js');
-const Organisation = require('../models/organisation.js');
-const User = require('../models/user.js');
-
-function listMetaEvents () {
-  return autocomplete.words([
+export function listMetaEvents () {
+  return cliparse.autocomplete.words([
     'META_SERVICE_LIFECYCLE',
     'META_DEPLOYMENT_RESULT',
     'META_SERVICE_MANAGEMENT',
@@ -15,13 +12,13 @@ function listMetaEvents () {
   ]);
 }
 
-function getOrgaIdOrUserId (orgIdOrName) {
+export function getOrgaIdOrUserId (orgIdOrName) {
   return (orgIdOrName == null)
     ? User.getCurrentId()
     : Organisation.getId(orgIdOrName);
 }
 
-async function getOwnerAndApp (alias, org, useLinkedApp) {
+export async function getOwnerAndApp (alias, org, useLinkedApp) {
 
   if (!useLinkedApp) {
     const ownerId = await getOrgaIdOrUserId(org);
@@ -30,9 +27,3 @@ async function getOwnerAndApp (alias, org, useLinkedApp) {
 
   return AppConfig.getAppDetails({ alias });
 }
-
-module.exports = {
-  listMetaEvents,
-  getOrgaIdOrUserId,
-  getOwnerAndApp,
-};

package/src/models/organisation.js

@@ -1,11 +1,9 @@
-'use strict';
+import _ from 'lodash';
 
-const _ = require('lodash');
+import { getSummary } from '@clevercloud/client/esm/api/v2/user.js';
+import { sendToApi } from '../models/send-to-api.js';
 
-const { getSummary } = require('@clevercloud/client/cjs/api/v2/user.js');
-const { sendToApi } = require('../models/send-to-api.js');
-
-async function getId (orgaIdOrName) {
+export async function getId (orgaIdOrName) {
   if (orgaIdOrName == null) {
     return null;
   }
@@ -32,7 +30,3 @@ async function getByName (name) {
 
   return filteredOrgs[0];
 }
-
-module.exports = {
-  getId,
-};

package/src/models/send-to-api.js

@@ -1,11 +1,17 @@
-'use strict';
+import { Logger } from '../logger.js';
+import { addOauthHeader } from '@clevercloud/client/esm/oauth.js';
+import { conf, loadOAuthConf } from '../models/configuration.js';
+import { execWarpscript } from '@clevercloud/client/esm/request-warp10.superagent.js';
+import { prefixUrl } from '@clevercloud/client/esm/prefix-url.js';
+import { request } from '@clevercloud/client/esm/request.fetch.js';
+import { subtle as cryptoSuble } from 'node:crypto';
 
-const Logger = require('../logger.js');
-const { addOauthHeader } = require('@clevercloud/client/cjs/oauth.js');
-const { conf, loadOAuthConf } = require('../models/configuration.js');
-const { execWarpscript } = require('@clevercloud/client/cjs/request-warp10.superagent.js');
-const { prefixUrl } = require('@clevercloud/client/cjs/prefix-url.js');
-const { request } = require('@clevercloud/client/cjs/request.fetch.js');
+// Required for @clevercloud/client with "old" Node.js
+if (globalThis.crypto == null) {
+  globalThis.crypto = {
+    subtle: cryptoSuble,
+  };
+}
 
 async function loadTokens () {
   const tokens = await loadOAuthConf();
@@ -17,7 +23,7 @@ async function loadTokens () {
   };
 }
 
-async function sendToApi (requestParams) {
+export async function sendToApi (requestParams) {
   const tokens = await loadTokens();
   return Promise.resolve(requestParams)
     .then(prefixUrl(conf.API_HOST))
@@ -30,7 +36,7 @@ async function sendToApi (requestParams) {
     .catch(processError);
 }
 
-function processError (error) {
+export function processError (error) {
   const code = error.code ?? error?.cause?.code;
   if (code === 'EAI_AGAIN') {
     throw new Error('Cannot reach the Clever Cloud API, please check your internet connection.', { cause: error });
@@ -41,18 +47,16 @@ function processError (error) {
   throw error;
 }
 
-function sendToWarp10 (requestParams) {
+export function sendToWarp10 (requestParams) {
   return Promise.resolve(requestParams)
     .then(prefixUrl(conf.WARP_10_EXEC_URL))
     .then((requestParams) => execWarpscript(requestParams, { retry: 1 }));
 }
 
-async function getHostAndTokens () {
+export async function getHostAndTokens () {
   const tokens = await loadTokens();
   return {
     apiHost: conf.API_HOST,
     tokens,
   };
 }
-
-module.exports = { sendToApi, sendToWarp10, getHostAndTokens, processError };

package/src/models/user.js

@@ -1,15 +1,22 @@
-'use strict';
+import { get } from '@clevercloud/client/esm/api/v2/organisation.js';
+import { sendToApi } from '../models/send-to-api.js';
 
-const { get } = require('@clevercloud/client/cjs/api/v2/organisation.js');
-const { sendToApi } = require('../models/send-to-api.js');
-
-function getCurrent () {
+export function getCurrent () {
   return get({}).then(sendToApi);
-};
+}
 
-function getCurrentId () {
+export function getCurrentId () {
   return get({}).then(sendToApi)
     .then(({ id }) => id);
-};
+}
 
-module.exports = { getCurrent, getCurrentId };
+// TODO move to clever client
+export function getCurrentToken () {
+  return Promise.resolve({
+    method: 'get',
+    url: '/v2/self/tokens/current',
+    headers: { Accept: 'application/json' },
+    // no query params
+    // no body
+  }).then(sendToApi);
+}

package/src/models/utils.js

@@ -1,11 +1,9 @@
-'use strict';
-
 // Inspirations:
 // https://github.com/sindresorhus/p-defer/blob/master/index.js
 // https://github.com/ljharb/promise-deferred/blob/master/index.js
 
 // When you mix async/await APIs with event emitters callbacks, it's hard to keep a proper error flow without a good old deferred.
-class Deferred {
+export class Deferred {
 
   constructor () {
     this.promise = new Promise((resolve, reject) => {
@@ -15,11 +13,9 @@ class Deferred {
   }
 }
 
-function truncateWithEllipsis (length, string) {
+export function truncateWithEllipsis (length, string) {
   if (string.length > length - 1) {
     return string.substring(0, length - 1) + '…';
   }
   return string;
 }
-
-module.exports = { Deferred, truncateWithEllipsis };

package/src/models/variables.js

@@ -1,8 +1,6 @@
-'use strict';
-
-const _countBy = require('lodash/countBy.js');
-const readline = require('readline');
-const { ERROR_TYPES, parseRaw, toNameValueObject, validateName } = require('@clevercloud/client/cjs/utils/env-vars.js');
+import _countBy from 'lodash/countBy.js';
+import readline from 'node:readline';
+import { ERROR_TYPES, parseRaw, toNameValueObject, validateName } from '@clevercloud/client/esm/utils/env-vars.js';
 
 function readStdin () {
 
@@ -105,7 +103,7 @@ function parseFromNameEqualsValue (rawStdin) {
   return toNameValueObject(variables);
 }
 
-async function readVariablesFromStdin (format) {
+export async function readVariablesFromStdin (format) {
 
   const rawStdin = await readStdin();
 
@@ -118,7 +116,3 @@ async function readVariablesFromStdin (format) {
       throw new Error('Unrecognized environment input format. Available formats are \'name-equals-value\' and \'json\'');
   }
 }
-
-module.exports = {
-  readVariablesFromStdin,
-};

package/src/parsers.js

@@ -1,12 +1,21 @@
-'use strict';
+import cliparse from 'cliparse';
 
-const cliparse = require('cliparse');
+import * as Application from './models/application.js';
+import ISO8601 from 'iso8601-duration';
+import Duration from 'duration-js';
 
-const Application = require('./models/application.js');
-const ISO8601 = require('iso8601-duration');
-const Duration = require('duration-js');
+const addonOptionsRegex = /^\w+=.+$/;
 
-function flavor (flavor) {
+export function addonOptions (options) {
+  for (const option of options) {
+    if (!option.match(addonOptionsRegex)) {
+      return cliparse.parsers.error('Invalid option: ' + option);
+    }
+  }
+  return cliparse.parsers.success(options.join(','));
+}
+
+export function flavor (flavor) {
   const flavors = Application.listAvailableFlavors();
   if (flavors.includes(flavor)) {
     return cliparse.parsers.success(flavor);
@@ -14,14 +23,14 @@ function flavor (flavor) {
   return cliparse.parsers.error('Invalid value: ' + flavor);
 }
 
-function buildFlavor (flavorOrDisabled) {
+export function buildFlavor (flavorOrDisabled) {
   if (flavorOrDisabled === 'disabled') {
     return cliparse.parsers.success(flavorOrDisabled);
   }
   return flavor(flavorOrDisabled);
 }
 
-function instances (instances) {
+export function instances (instances) {
   const parsedInstances = parseInt(instances, 10);
   if (isNaN(parsedInstances)) {
     return cliparse.parsers.error('Invalid number: ' + instances);
@@ -32,7 +41,7 @@ function instances (instances) {
   return cliparse.parsers.success(parsedInstances);
 }
 
-function date (dateString) {
+export function date (dateString) {
   const date = new Date(dateString);
   if (isNaN(dateString) && !isNaN(date.getTime())) {
     return cliparse.parsers.success(date);
@@ -48,7 +57,7 @@ function date (dateString) {
 
 const appIdRegex = /^app_[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
 
-function appIdOrName (string) {
+export function appIdOrName (string) {
   if (string.match(appIdRegex)) {
     return cliparse.parsers.success({ app_id: string });
   }
@@ -57,7 +66,7 @@ function appIdOrName (string) {
 
 const orgaIdRegex = /^(user_|orga_)[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
 
-function orgaIdOrName (string) {
+export function orgaIdOrName (string) {
   if (string.match(orgaIdRegex)) {
     return cliparse.parsers.success({ orga_id: string });
   }
@@ -66,27 +75,18 @@ function orgaIdOrName (string) {
 
 const addonIdRegex = /^addon_[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
 
-function addonIdOrName (string) {
+export function addonIdOrName (string) {
   if (string.match(addonIdRegex)) {
     return cliparse.parsers.success({ addon_id: string });
   }
   return cliparse.parsers.success({ addon_name: string });
 }
 
-const ngIdRegex = /^ng_[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
-
-function ngIdOrLabel (string) {
-  if (string.match(ngIdRegex)) {
-    return cliparse.parsers.success({ ng_id: string });
-  }
-  return cliparse.parsers.success({ ng_label: string });
-}
-
-function commaSeparated (string) {
+export function commaSeparated (string) {
   return cliparse.parsers.success(string.split(','));
 }
 
-function integer (string) {
+export function integer (string) {
   const integer = parseInt(string);
   if (isNaN(integer)) {
     return cliparse.parsers.error('Invalid number: ' + string);
@@ -94,7 +94,7 @@ function integer (string) {
   return cliparse.parsers.success(integer);
 }
 
-function nonEmptyString (string) {
+export function nonEmptyString (string) {
   if (typeof string !== 'string' || string === '') {
     return cliparse.parsers.error('Invalid string, it should not be empty');
   }
@@ -104,14 +104,14 @@ function nonEmptyString (string) {
 // /^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?$/i;
 const tagRegex = /^[^,\s]+$/;
 
-function tag (string) {
+export function tag (string) {
   if (string.match(tagRegex)) {
     return cliparse.parsers.success(string);
   }
   return cliparse.parsers.error(`Invalid tag '${string}'. Should match ${tagRegex}`);
 }
 
-function tags (string) {
+export function tags (string) {
   if (String(string).length === 0) {
     return cliparse.parsers.success([]);
   }
@@ -124,34 +124,18 @@ function tags (string) {
   return cliparse.parsers.success(tags);
 }
 
-function ngMemberType (string) {
-  const possible = ['application', 'addon', 'external'];
-  if (possible.includes(string)) {
-    return cliparse.parsers.success(string);
-  }
-  return cliparse.parsers.error(`Invalid member type '${string}'. Should be in ${JSON.stringify(possible)}`);
-}
-
-function ngPeerRole (string) {
-  const possible = ['client', 'server'];
-  if (possible.includes(string)) {
-    return cliparse.parsers.success(string);
-  }
-  return cliparse.parsers.error(`Invalid peer role '${string}'. Should be in ${JSON.stringify(possible)}`);
-}
+export const ipAddressRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])$/;
 
-const ipAddressRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])$/;
-
-function ipAddress (string) {
+export function ipAddress (string) {
   if (string.match(ipAddressRegex)) {
     return cliparse.parsers.success(string);
   }
   return cliparse.parsers.error(`Invalid IP address '${string}'. Should match ${ipAddressRegex}`);
 }
 
-const portNumberRegex = /^\d{1,5}$/;
+export const portNumberRegex = /^\d{1,5}$/;
 
-function portNumber (number) {
+export function portNumber (number) {
   if (String(number).match(portNumberRegex)) {
     return cliparse.parsers.success(number);
   }
@@ -164,7 +148,7 @@ function portNumber (number) {
  * @param {string} durationStr an ISO8601, 1h or a positive number
  * @returns {number} number of seconds
  */
-function durationInSeconds (durationStr = '') {
+export function durationInSeconds (durationStr = '') {
   const failed = cliparse.parsers.error(`Invalid duration: "${durationStr}", expect (IS0 8601 duration / a "1h, 1m, 30s" like duration / a positive number in seconds)`);
 
   if (durationStr.startsWith('P')) {
@@ -190,26 +174,3 @@ function durationInSeconds (durationStr = '') {
     return cliparse.parsers.success(n);
   }
 }
-
-module.exports = {
-  buildFlavor,
-  flavor,
-  instances,
-  date,
-  appIdOrName,
-  orgaIdOrName,
-  addonIdOrName,
-  ngIdOrLabel,
-  commaSeparated,
-  integer,
-  tag,
-  tags,
-  ngMemberType,
-  ngPeerRole,
-  ipAddressRegex,
-  ipAddress,
-  portNumberRegex,
-  portNumber,
-  durationInSeconds,
-  nonEmptyString,
-};

package/src/commands/networkgroups/commands.js

@@ -1,7 +0,0 @@
-'use strict';
-
-module.exports = {
-  ...require('./index.js'),
-  ...require('./members.js'),
-  ...require('./peers.js'),
-};

package/src/commands/networkgroups/index.js

@@ -1,67 +0,0 @@
-'use strict';
-
-const ngApi = require('@clevercloud/client/cjs/api/v4/network-group.js');
-
-const { sendToApi } = require('../../models/send-to-api.js');
-
-const Logger = require('../../logger.js');
-const NetworkGroup = require('../../models/networkgroup.js');
-const Formatter = require('../../models/format-string.js');
-const TableFormatter = require('../../models/format-ng-table.js');
-
-async function listNetworkGroups (params) {
-  const { org: orgaIdOrName, alias, json } = params.options;
-  const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
-
-  Logger.info(`Listing Network Groups from owner ${Formatter.formatString(ownerId)}`);
-  const result = await ngApi.listNetworkGroups({ ownerId }).then(sendToApi);
-
-  if (json) {
-    Logger.println(JSON.stringify(result, null, 2));
-  }
-  else {
-    if (result.length === 0) {
-      Logger.println(`No Network Group found for ${ownerId}. You can create one with ${Formatter.formatCommand('clever networkgroups create')}.`);
-    }
-    else {
-      TableFormatter.printNetworkGroupsTableHeader();
-      result
-        .map((ng) => TableFormatter.formatNetworkGroupsLine(ng))
-        .forEach((ng) => Logger.println(ng));
-    }
-  }
-}
-
-async function createNg (params) {
-  const { org: orgaIdOrName, alias, label, description, tags, json } = params.options;
-  const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
-
-  Logger.info(`Creating Network Group from owner ${Formatter.formatString(ownerId)}`);
-  const body = { ownerId: ownerId, label, description, tags };
-  Logger.debug('Sending body: ' + JSON.stringify(body, null, 2));
-  const result = await ngApi.createNetworkGroup({ ownerId }, body).then(sendToApi);
-
-  if (json) {
-    Logger.println(JSON.stringify(result, null, 2));
-  }
-  else {
-    Logger.println(`Network Group ${Formatter.formatString(label)} creation will be performed asynchronously.`);
-  }
-}
-
-async function deleteNg (params) {
-  const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel } = params.options;
-  const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
-  const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
-
-  Logger.info(`Deleting Network Group ${Formatter.formatString(networkGroupId)} from owner ${Formatter.formatString(ownerId)}`);
-  await ngApi.deleteNetworkGroup({ ownerId, networkGroupId }).then(sendToApi);
-
-  Logger.println(`Network Group ${Formatter.formatString(networkGroupId)} deletion will be performed asynchronously.`);
-}
-
-module.exports = {
-  listNetworkGroups,
-  createNg,
-  deleteNg,
-};

package/src/commands/networkgroups/members.js

@@ -1,80 +0,0 @@
-'use strict';
-
-const ngApi = require('@clevercloud/client/cjs/api/v4/network-group.js');
-
-const { sendToApi } = require('../../models/send-to-api.js');
-
-const Logger = require('../../logger.js');
-const NetworkGroup = require('../../models/networkgroup.js');
-const Formatter = require('../../models/format-string.js');
-const TableFormatter = require('../../models/format-ng-table.js');
-
-async function listMembers (params) {
-  const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'natural-name': naturalName, json } = params.options;
-  const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
-  const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
-
-  Logger.info(`Listing members from Network Group '${networkGroupId}'`);
-  const result = await ngApi.listNetworkGroupMembers({ ownerId, networkGroupId }).then(sendToApi);
-
-  if (json) {
-    Logger.println(JSON.stringify(result, null, 2));
-  }
-  else {
-    if (result.length === 0) {
-      Logger.println(`No member found. You can add one with ${Formatter.formatCommand('clever networkgroups members add')}.`);
-    }
-    else {
-      await TableFormatter.printMembersTableHeader(naturalName);
-      for (const ng of result) {
-        Logger.println(await TableFormatter.formatMembersLine(ng, naturalName));
-      }
-    }
-  }
-}
-
-async function getMember (params) {
-  const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'member-id': memberId, 'natural-name': naturalName, json } = params.options;
-  const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
-  const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel); ;
-
-  Logger.info(`Getting details for member ${Formatter.formatString(memberId)} in Network Group ${Formatter.formatString(networkGroupId)}`);
-  const result = await ngApi.getNetworkGroupMember({ ownerId, networkGroupId, memberId: memberId }).then(sendToApi);
-
-  if (json) {
-    Logger.println(JSON.stringify(result, null, 2));
-  }
-  else {
-    await TableFormatter.printMembersTableHeader(naturalName);
-    Logger.println(await TableFormatter.formatMembersLine(result, naturalName));
-  }
-}
-
-async function addMember (params) {
-  const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'member-id': memberId, type, 'domain-name': domainName, label } = params.options;
-  const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
-  const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
-
-  const body = { id: memberId, label, domain_name: domainName, type };
-  Logger.debug('Sending body: ' + JSON.stringify(body, null, 2));
-  await ngApi.createNetworkGroupMember({ ownerId, networkGroupId }, body).then(sendToApi);
-
-  Logger.println(`Successfully added member ${Formatter.formatString(memberId)} to Network Group ${Formatter.formatString(networkGroupId)}.`);
-}
-
-async function removeMember (params) {
-  const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'member-id': memberId } = params.options;
-  const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
-  const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
-
-  await ngApi.deleteNetworkGroupMember({ ownerId, networkGroupId, memberId }).then(sendToApi);
-
-  Logger.println(`Successfully removed member ${Formatter.formatString(memberId)} from Network Group ${Formatter.formatString(networkGroupId)}.`);
-}
-
-module.exports = {
-  listMembers,
-  getMember,
-  addMember,
-  removeMember,
-};