clever-tools 4.4.0 → 4.5.0

package/src/commands/emails/emails.command.js

@@ -0,0 +1,35 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import { getUserEmailAddresses } from '../../models/emails.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const emailsCommand = defineCommand({
+  description: 'Manage email addresses of the current user',
+  since: '3.13.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [],
+  async handler(options) {
+    const { format } = options;
+    const addresses = await getUserEmailAddresses();
+
+    switch (format) {
+      case 'json': {
+        Logger.printJson(addresses);
+        break;
+      }
+      case 'human':
+      default: {
+        Logger.println('✉️  Primary email address:');
+        Logger.println(` • ${styleText('green', addresses.primary)}`);
+        if (addresses.secondary.length > 0) {
+          Logger.println();
+          Logger.println(`✉️  ${addresses.secondary.length} secondary email address(es):`);
+          addresses.secondary.forEach((address) => Logger.println(` • ${styleText('blue', address)}`));
+        }
+      }
+    }
+  },
+});

package/src/commands/emails/emails.docs.md

@@ -0,0 +1,79 @@
+# 📖 `clever emails` command reference
+
+## ➡️ `clever emails` <kbd>Since 3.13.0</kbd>
+
+Manage email addresses of the current user
+
+```bash
+clever emails [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever emails add` <kbd>Since 3.13.0</kbd>
+
+Add a new secondary email address to the current user
+
+```bash
+clever emails add <email>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`email`|Email address|
+
+## ➡️ `clever emails open` <kbd>Since 3.13.0</kbd>
+
+Open the email addresses management page in the Console
+
+```bash
+clever emails open
+```
+
+## ➡️ `clever emails primary` <kbd>Since 3.13.0</kbd>
+
+Set the primary email address of the current user
+
+```bash
+clever emails primary <email>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`email`|Email address|
+
+## ➡️ `clever emails remove` <kbd>Since 3.13.0</kbd>
+
+Remove a secondary email address from the current user
+
+```bash
+clever emails remove <email>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`email`|Email address|
+
+## ➡️ `clever emails remove-all` <kbd>Since 3.13.0</kbd>
+
+Remove all secondary email addresses from the current user
+
+```bash
+clever emails remove-all [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-y`, `--yes`|Skip confirmation|

package/src/commands/emails/emails.open.command.js

@@ -0,0 +1,15 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { openBrowser } from '../../models/utils.js';
+
+export const emailsOpenCommand = defineCommand({
+  description: 'Open the email addresses management page in the Console',
+  since: '3.13.0',
+  options: {},
+  args: [],
+  handler() {
+    return openBrowser(
+      '/users/me/emails',
+      'Opening the email addresses management page of the Console in your browser',
+    );
+  },
+});

package/src/commands/emails/emails.primary.command.js

@@ -0,0 +1,29 @@
+import { todo_addEmailAddress as addEmailAddress } from '@clevercloud/client/esm/api/v2/user.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { Logger } from '../../logger.js';
+import { getUserEmailAddresses } from '../../models/emails.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { emailArg } from './emails.args.js';
+
+export const emailsPrimaryCommand = defineCommand({
+  description: 'Set the primary email address of the current user',
+  since: '3.13.0',
+  options: {},
+  args: [emailArg],
+  async handler(_options, newPrimaryAddress) {
+    const addresses = await getUserEmailAddresses();
+
+    if (addresses.primary === newPrimaryAddress) {
+      throw new Error('This address is already the primary one');
+    }
+
+    if (!addresses.secondary.includes(newPrimaryAddress)) {
+      throw new Error('This address must be added as a secondary address before marking it as primary');
+    }
+
+    const newPrimaryEmailEncoded = encodeURIComponent(newPrimaryAddress);
+    await addEmailAddress({ email: newPrimaryEmailEncoded }, { make_primary: true }).then(sendToApi);
+
+    Logger.printSuccess(`Primary address updated to ${newPrimaryAddress} successfully`);
+  },
+});

package/src/commands/emails/emails.remove-all.command.js

@@ -0,0 +1,54 @@
+import { todo_removeEmailAddress as removeEmailAddress } from '@clevercloud/client/esm/api/v2/user.js';
+import { z } from 'zod';
+import { defineCommand } from '../../lib/define-command.js';
+import { defineOption } from '../../lib/define-option.js';
+import { confirm } from '../../lib/prompts.js';
+import { Logger } from '../../logger.js';
+import { getUserEmailAddresses } from '../../models/emails.js';
+import { sendToApi } from '../../models/send-to-api.js';
+
+export const emailsRemoveAllCommand = defineCommand({
+  description: 'Remove all secondary email addresses from the current user',
+  since: '3.13.0',
+  options: {
+    yes: defineOption({
+      name: 'yes',
+      schema: z.boolean().default(false),
+      description: 'Skip confirmation',
+      aliases: ['y'],
+    }),
+  },
+  args: [],
+  async handler(options) {
+    if (!options.yes) {
+      await confirm('Are you sure you want to remove all your secondary addresses?', 'No secondary addresses removed');
+    }
+
+    const addresses = await getUserEmailAddresses();
+
+    if (addresses.secondary.length === 0) {
+      Logger.println('No secondary address to remove');
+      return;
+    }
+
+    const results = await Promise.all(
+      addresses.secondary.map((addressToRemove) => {
+        const addressToRemoveEncoded = encodeURIComponent(addressToRemove);
+        return removeEmailAddress({ email: addressToRemoveEncoded })
+          .then(sendToApi)
+          .then(() => [true, addressToRemove])
+          .catch(() => [false, addressToRemove]);
+      }),
+    );
+
+    if (results.every(([isRemoved]) => isRemoved)) {
+      Logger.printSuccess('All secondary addresses were removed successfully');
+    } else {
+      const addressesWithErrors = results
+        .filter(([isRemoved]) => !isRemoved)
+        .map(([_, address]) => address)
+        .join(', ');
+      throw new Error(`Some errors occured while removing these addresses: ${addressesWithErrors}`);
+    }
+  },
+});

package/src/commands/emails/emails.remove.command.js

@@ -0,0 +1,25 @@
+import { todo_removeEmailAddress as removeEmailAddress } from '@clevercloud/client/esm/api/v2/user.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { Logger } from '../../logger.js';
+import { getUserEmailAddresses } from '../../models/emails.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { emailArg } from './emails.args.js';
+
+export const emailsRemoveCommand = defineCommand({
+  description: 'Remove a secondary email address from the current user',
+  since: '3.13.0',
+  options: {},
+  args: [emailArg],
+  async handler(_options, addressToRemove) {
+    const addresses = await getUserEmailAddresses();
+
+    if (!addresses.secondary.includes(addressToRemove)) {
+      throw new Error("This address is not part of the secondary addresses of the current user, it can't be removed");
+    }
+
+    const addressToRemoveEncoded = encodeURIComponent(addressToRemove);
+    await removeEmailAddress({ email: addressToRemoveEncoded }).then(sendToApi);
+
+    Logger.printSuccess(`Secondary address ${addressToRemove} removed successfully`);
+  },
+});

package/src/commands/env/env.command.js

@@ -0,0 +1,77 @@
+import {
+  getAllEnvVars,
+  getAllEnvVarsForAddons,
+  getAllEnvVarsForDependencies,
+} from '@clevercloud/client/esm/api/v2/application.js';
+import { toNameEqualsValueString } from '@clevercloud/client/esm/utils/env-vars.js';
+import { z } from 'zod';
+import { defineCommand } from '../../lib/define-command.js';
+import { defineOption } from '../../lib/define-option.js';
+import { Logger } from '../../logger.js';
+import * as Application from '../../models/application.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { aliasOption, appIdOrNameOption, envFormatOption } from '../global.options.js';
+
+export const envCommand = defineCommand({
+  description: 'Manage environment variables of an application',
+  since: '0.2.0',
+  options: {
+    addExportsOption: defineOption({
+      name: 'add-export',
+      schema: z.boolean().default(false),
+      description: 'Display sourceable env variables setting',
+      deprecated: 'use `--format shell` instead',
+    }),
+    alias: aliasOption,
+    app: appIdOrNameOption,
+    format: envFormatOption,
+  },
+  args: [],
+  async handler(options) {
+    const { alias, app: appIdOrName, addExportsOption, format } = options;
+    const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
+
+    const [envFromApp, envFromAddons, envFromDeps] = await Promise.all([
+      getAllEnvVars({ id: ownerId, appId }).then(sendToApi),
+      getAllEnvVarsForAddons({ id: ownerId, appId }).then(sendToApi),
+      getAllEnvVarsForDependencies({ id: ownerId, appId }).then(sendToApi),
+    ]);
+
+    switch (format) {
+      case 'json': {
+        Logger.printJson({
+          env: envFromApp,
+          fromAddons: envFromAddons.map((addon) => ({
+            addonId: addon.addon_id,
+            addonName: addon.addon_name,
+            env: addon.env,
+          })),
+          fromDependencies: envFromDeps.map((dep) => ({
+            addonId: dep.app_id,
+            addonName: dep.app_name,
+            env: dep.env,
+          })),
+        });
+        break;
+      }
+      case 'shell':
+      case 'human':
+      default: {
+        const addExports = addExportsOption || format === 'shell';
+
+        Logger.println('# Manually set env variables');
+        Logger.println(toNameEqualsValueString(envFromApp, { addExports }));
+
+        envFromAddons.forEach((addon) => {
+          Logger.println('# Addon ' + addon.addon_name);
+          Logger.println(toNameEqualsValueString(addon.env, { addExports }));
+        });
+
+        envFromDeps.forEach((dep) => {
+          Logger.println('# Dependency ' + dep.app_name);
+          Logger.println(toNameEqualsValueString(dep.env, { addExports }));
+        });
+      }
+    }
+  },
+});

package/src/commands/env/env.docs.md

@@ -0,0 +1,99 @@
+# 📖 `clever env` command reference
+
+## ➡️ `clever env` <kbd>Since 0.2.0</kbd>
+
+Manage environment variables of an application
+
+```bash
+clever env [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--add-export`|Display sourceable env variables setting *(deprecated, use `--format shell` instead)*|
+|`-a`, `--alias` `<alias>`|Short name for the application|
+|`--app` `<app-id\|app-name>`|Application to manage by its ID (or name, if unambiguous)|
+|`-F`, `--format` `<format>`|Output format (human, json, shell) (default: human)|
+
+## ➡️ `clever env import` <kbd>Since 0.3.0</kbd>
+
+Load environment variables from STDIN
+(WARNING: this deletes all current variables and replace them with the new list loaded from STDIN)
+
+```bash
+clever env import [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-a`, `--alias` `<alias>`|Short name for the application|
+|`--app` `<app-id\|app-name>`|Application to manage by its ID (or name, if unambiguous)|
+|`--json`|Import variables as JSON (an array of { "name": "THE_NAME", "value": "THE_VALUE" } objects)|
+
+## ➡️ `clever env import-vars` <kbd>Since 2.0.0</kbd>
+
+Add or update environment variables named <variable-names> (comma-separated), taking their values from the current environment
+
+```bash
+clever env import-vars <variable-names> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`variable-names`|Comma separated list of names of the environment variables|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-a`, `--alias` `<alias>`|Short name for the application|
+|`--app` `<app-id\|app-name>`|Application to manage by its ID (or name, if unambiguous)|
+
+## ➡️ `clever env rm` <kbd>Since 0.3.0</kbd>
+
+Remove an environment variable from an application
+
+```bash
+clever env rm <variable-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`variable-name`|Name of the environment variable|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-a`, `--alias` `<alias>`|Short name for the application|
+|`--app` `<app-id\|app-name>`|Application to manage by its ID (or name, if unambiguous)|
+
+## ➡️ `clever env set` <kbd>Since 0.3.0</kbd>
+
+Add or update an environment variable named <variable-name> with the value <variable-value>
+
+```bash
+clever env set <variable-name> <variable-value> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`variable-name`|Name of the environment variable|
+|`variable-value`|Value of the environment variable|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-a`, `--alias` `<alias>`|Short name for the application|
+|`--app` `<app-id\|app-name>`|Application to manage by its ID (or name, if unambiguous)|

package/src/commands/env/env.import-vars.command.js

@@ -0,0 +1,45 @@
+import { updateEnvVar } from '@clevercloud/client/esm/api/v2/application.js';
+import { validateName } from '@clevercloud/client/esm/utils/env-vars.js';
+import { z } from 'zod';
+import { defineArgument } from '../../lib/define-argument.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { Logger } from '../../logger.js';
+import * as Application from '../../models/application.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { aliasOption, appIdOrNameOption } from '../global.options.js';
+
+export const envImportVarsCommand = defineCommand({
+  description:
+    'Add or update environment variables named <variable-names> (comma-separated), taking their values from the current environment',
+  since: '2.0.0',
+  options: {
+    alias: aliasOption,
+    app: appIdOrNameOption,
+  },
+  args: [
+    defineArgument({
+      schema: z.string(),
+      description: 'Comma separated list of names of the environment variables',
+      placeholder: 'variable-names',
+    }),
+  ],
+  async handler(options, envNames) {
+    const { alias, app: appIdOrName } = options;
+
+    for (const envName of envNames) {
+      const nameIsValid = validateName(envName);
+      if (!nameIsValid) {
+        throw new Error(`Environment variable name ${envName} is invalid`);
+      }
+    }
+
+    const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
+
+    for (const envName of envNames) {
+      const value = process.env[envName] || '';
+      await updateEnvVar({ id: ownerId, appId, envName }, { value }).then(sendToApi);
+    }
+
+    Logger.println('Your environment variables have been successfully saved');
+  },
+});

package/src/commands/env/env.import.command.js

@@ -0,0 +1,29 @@
+import { updateAllEnvVars } from '@clevercloud/client/esm/api/v2/application.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { Logger } from '../../logger.js';
+import * as Application from '../../models/application.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import * as variables from '../../models/variables.js';
+import { aliasOption, appIdOrNameOption, importAsJsonOption } from '../global.options.js';
+
+export const envImportCommand = defineCommand({
+  description:
+    'Load environment variables from STDIN\n(WARNING: this deletes all current variables and replace them with the new list loaded from STDIN)',
+  since: '0.3.0',
+  options: {
+    alias: aliasOption,
+    app: appIdOrNameOption,
+    json: importAsJsonOption,
+  },
+  args: [],
+  async handler(options) {
+    const { alias, app: appIdOrName, json } = options;
+    const format = json ? 'json' : 'name-equals-value';
+    const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
+
+    const envVars = await variables.readVariablesFromStdin(format);
+    await updateAllEnvVars({ id: ownerId, appId }, envVars).then(sendToApi);
+
+    Logger.println('Environment variables have been set');
+  },
+});

package/src/commands/env/env.rm.command.js

@@ -0,0 +1,25 @@
+import { removeEnvVar } from '@clevercloud/client/esm/api/v2/application.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { Logger } from '../../logger.js';
+import * as Application from '../../models/application.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { envVariableNameArg } from '../global.args.js';
+import { aliasOption, appIdOrNameOption } from '../global.options.js';
+
+export const envRmCommand = defineCommand({
+  description: 'Remove an environment variable from an application',
+  since: '0.3.0',
+  options: {
+    alias: aliasOption,
+    app: appIdOrNameOption,
+  },
+  args: [envVariableNameArg],
+  async handler(options, envName) {
+    const { alias, app: appIdOrName } = options;
+    const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
+
+    await removeEnvVar({ id: ownerId, appId, envName }).then(sendToApi);
+
+    Logger.println('Your environment variable has been successfully removed');
+  },
+});

package/src/commands/env/env.set.command.js

@@ -0,0 +1,32 @@
+import { updateEnvVar } from '@clevercloud/client/esm/api/v2/application.js';
+import { validateName } from '@clevercloud/client/esm/utils/env-vars.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { Logger } from '../../logger.js';
+import * as Application from '../../models/application.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { envVariableNameArg, envVariableValueArg } from '../global.args.js';
+import { aliasOption, appIdOrNameOption } from '../global.options.js';
+
+export const envSetCommand = defineCommand({
+  description: 'Add or update an environment variable named <variable-name> with the value <variable-value>',
+  since: '0.3.0',
+  options: {
+    alias: aliasOption,
+    app: appIdOrNameOption,
+  },
+  args: [envVariableNameArg, envVariableValueArg],
+  async handler(options, envName, value) {
+    const { alias, app: appIdOrName } = options;
+
+    const nameIsValid = validateName(envName);
+    if (!nameIsValid) {
+      throw new Error(`Environment variable name ${envName} is invalid`);
+    }
+
+    const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
+
+    await updateEnvVar({ id: ownerId, appId, envName }, { value }).then(sendToApi);
+
+    Logger.println('Your environment variable has been successfully saved');
+  },
+});

package/src/commands/features/features.args.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { defineArgument } from '../../lib/define-argument.js';
+import { commaSeparated } from '../../parsers.js';
+
+export const featuresArg = defineArgument({
+  schema: z.string().transform(commaSeparated),
+  description: 'Comma-separated list of experimental features to manage',
+  placeholder: 'features',
+});

package/src/commands/features/features.command.js

@@ -0,0 +1,7 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { featuresListCommand } from './features.list.command.js';
+
+export const featuresCommand = defineCommand({
+  ...featuresListCommand,
+  description: 'Manage Clever Tools experimental features',
+});

package/src/commands/features/features.disable.command.js

@@ -0,0 +1,25 @@
+import { EXPERIMENTAL_FEATURES } from '../../experimental-features.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { Logger } from '../../logger.js';
+import { setFeature } from '../../models/configuration.js';
+import { featuresArg } from './features.args.js';
+
+export const featuresDisableCommand = defineCommand({
+  description: 'Disable experimental features',
+  since: '3.11.0',
+  options: {},
+  args: [featuresArg],
+  async handler(_options, features) {
+    const availableFeatures = Object.keys(EXPERIMENTAL_FEATURES);
+
+    const unknownFeatures = features.filter((feature) => !availableFeatures.includes(feature));
+    if (unknownFeatures.length > 0) {
+      throw new Error(`Unavailable feature(s): ${unknownFeatures.join(', ')}`);
+    }
+
+    for (const featureName of features) {
+      await setFeature(featureName, false);
+      Logger.println(`Experimental feature '${featureName}' disabled`);
+    }
+  },
+});

package/src/commands/features/features.docs.md

@@ -0,0 +1,71 @@
+# 📖 `clever features` command reference
+
+## ➡️ `clever features` <kbd>Since 3.11.0</kbd>
+
+Manage Clever Tools experimental features
+
+```bash
+clever features [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever features disable` <kbd>Since 3.11.0</kbd>
+
+Disable experimental features
+
+```bash
+clever features disable <features>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`features`|Comma-separated list of experimental features to manage|
+
+## ➡️ `clever features enable` <kbd>Since 3.11.0</kbd>
+
+Enable experimental features
+
+```bash
+clever features enable <features>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`features`|Comma-separated list of experimental features to manage|
+
+## ➡️ `clever features info` <kbd>Since 3.11.0</kbd>
+
+Display info about an experimental feature
+
+```bash
+clever features info <feature>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`feature`|Experimental feature to manage|
+
+## ➡️ `clever features list` <kbd>Since 3.11.0</kbd>
+
+List available experimental features
+
+```bash
+clever features list [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|