clever-tools 4.4.0 → 4.5.0

package/src/commands/notify-email/notify-email.command.js

@@ -0,0 +1,61 @@
+import { getEmailhooks } from '@clevercloud/client/esm/api/v2/notification.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import { getOwnerAndApp } from '../../models/notification.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { humanJsonOutputFormatOption, listAllNotificationsOption, orgaIdOrNameOption } from '../global.options.js';
+
+export const notifyEmailCommand = defineCommand({
+  description: 'Manage email notifications',
+  since: '0.6.1',
+  options: {
+    org: orgaIdOrNameOption,
+    listAll: listAllNotificationsOption,
+    format: humanJsonOutputFormatOption,
+  },
+  args: [],
+  async handler(options) {
+    const { org, listAll, format } = 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]}`);
+          }
+        });
+      }
+    }
+  },
+});

package/src/commands/notify-email/notify-email.docs.md

@@ -0,0 +1,60 @@
+# 📖 `clever notify-email` command reference
+
+## ➡️ `clever notify-email` <kbd>Since 0.6.1</kbd>
+
+Manage email notifications
+
+```bash
+clever notify-email [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`--list-all`|List all notifications for your user or for an organisation with the '--org' option|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+
+## ➡️ `clever notify-email add` <kbd>Since 0.6.1</kbd>
+
+Add a new email notification
+
+```bash
+clever notify-email add --notify <email-address|user-id|organisation> <name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`name`|Notification name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--notify` `<email-address\|user-id\|organisation>`|Notify a user, a specific email address or the whole organisation (multiple values allowed, comma separated) **(required)**|
+|`--event` `<event-type>`|Restrict notifications to specific event types|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+|`--service` `<service-id>`|Restrict notifications to specific applications and add-ons|
+
+## ➡️ `clever notify-email remove` <kbd>Since 0.6.1</kbd>
+
+Remove an existing email notification
+
+```bash
+clever notify-email remove <notification-id> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`notification-id`|Notification ID|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

package/src/commands/notify-email/notify-email.remove.command.js

@@ -0,0 +1,24 @@
+import { deleteEmailhook } from '@clevercloud/client/esm/api/v2/notification.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { Logger } from '../../logger.js';
+import { getOrgaIdOrUserId } from '../../models/notification.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { notificationIdArg } from '../global.args.js';
+import { orgaIdOrNameOption } from '../global.options.js';
+
+export const notifyEmailRemoveCommand = defineCommand({
+  description: 'Remove an existing email notification',
+  since: '0.6.1',
+  options: {
+    org: orgaIdOrNameOption,
+  },
+  args: [notificationIdArg],
+  async handler(options, notificationId) {
+    const { org } = options;
+
+    const ownerId = await getOrgaIdOrUserId(org);
+    await deleteEmailhook({ ownerId, id: notificationId }).then(sendToApi);
+
+    Logger.println('The notification has been successfully removed');
+  },
+});

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

@@ -0,0 +1,24 @@
+import { defineCommand } from '../../lib/define-command.js';
+import * as Application from '../../models/application.js';
+import * as Domain from '../../models/domain.js';
+import { openBrowser } from '../../models/utils.js';
+import { aliasOption, appIdOrNameOption } from '../global.options.js';
+
+export const openCommand = defineCommand({
+  description: 'Open an application in the Console',
+  since: '0.5.0',
+  options: {
+    alias: aliasOption,
+    app: appIdOrNameOption,
+  },
+  args: [],
+  async handler(options) {
+    const { alias, app: appIdOrName } = 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');
+  },
+});

package/src/commands/open/open.docs.md

@@ -0,0 +1,16 @@
+# 📖 `clever open` command reference
+
+## ➡️ `clever open` <kbd>Since 0.5.0</kbd>
+
+Open an application in the Console
+
+```bash
+clever open [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)|

package/src/commands/otoroshi/otoroshi.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorList } from '../../lib/operator-commands.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const otoroshiCommand = defineCommand({
+  description: 'Manage Clever Cloud Otoroshi services',
+  since: '3.13.0',
+  isExperimental: true,
+  featureFlag: 'operators',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [],
+  async handler(options) {
+    await operatorList('otoroshi', options.format);
+  },
+});

package/src/commands/otoroshi/otoroshi.disable-ng.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorNgDisable } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const otoroshiDisableNgCommand = defineCommand({
+  description: 'Unlink Otoroshi from its Network Group',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorNgDisable('otoroshi', addonIdOrName);
+  },
+});

package/src/commands/otoroshi/otoroshi.docs.md

@@ -0,0 +1,211 @@
+# 📖 `clever otoroshi` command reference
+
+> [!NOTE]
+> 🧪 **Experimental**: This command may change or be removed in future versions.
+> Enable with: `clever features enable operators`
+
+## ➡️ `clever otoroshi` <kbd>Since 3.13.0</kbd>
+
+Manage Clever Cloud Otoroshi services
+
+```bash
+clever otoroshi [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever otoroshi disable-ng` <kbd>Since 3.13.0</kbd>
+
+Unlink Otoroshi from its Network Group
+
+```bash
+clever otoroshi disable-ng <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever otoroshi enable-ng` <kbd>Since 3.13.0</kbd>
+
+Link Otoroshi to a Network Group
+
+```bash
+clever otoroshi enable-ng <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever otoroshi get` <kbd>Since 3.13.0</kbd>
+
+Get information about a deployed Otoroshi
+
+```bash
+clever otoroshi get <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever otoroshi get-config` <kbd>Since 4.4.0</kbd>
+
+Get configuration of a deployed Otoroshi in otoroshictl format
+
+```bash
+clever otoroshi get-config <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever otoroshi open` <kbd>Since 3.13.0</kbd>
+
+Open the Otoroshi dashboard in Clever Cloud Console
+
+```bash
+clever otoroshi open <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever otoroshi open logs` <kbd>Since 3.13.0</kbd>
+
+Open the Otoroshi application logs in Clever Cloud Console
+
+```bash
+clever otoroshi open logs <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever otoroshi open webui` <kbd>Since 3.13.0</kbd>
+
+Open the Otoroshi admin console in your browser
+
+```bash
+clever otoroshi open webui <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever otoroshi rebuild` <kbd>Since 3.13.0</kbd>
+
+Rebuild Otoroshi
+
+```bash
+clever otoroshi rebuild <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever otoroshi restart` <kbd>Since 3.13.0</kbd>
+
+Restart Otoroshi
+
+```bash
+clever otoroshi restart <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever otoroshi version` <kbd>Since 3.13.0</kbd>
+
+Manage Otoroshi deployed version
+
+```bash
+clever otoroshi version <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever otoroshi version check` <kbd>Since 3.13.0</kbd>
+
+Check Otoroshi deployed version
+
+```bash
+clever otoroshi version check <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever otoroshi version update` <kbd>Since 3.13.0</kbd>
+
+Update Otoroshi deployed version
+
+```bash
+clever otoroshi version update <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--target` `<version>`|Target version to upgrade to (e.g.: 24, 2.4, 2.4.1)|

package/src/commands/otoroshi/otoroshi.enable-ng.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorNgEnable } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const otoroshiEnableNgCommand = defineCommand({
+  description: 'Link Otoroshi to a Network Group',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorNgEnable('otoroshi', addonIdOrName);
+  },
+});

package/src/commands/otoroshi/otoroshi.get-config.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorPrint } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const otoroshiGetConfigCommand = defineCommand({
+  description: 'Get configuration of a deployed Otoroshi in otoroshictl format',
+  since: '4.4.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorPrint('otoroshi', addonIdOrName, 'otoroshictl');
+  },
+});

package/src/commands/otoroshi/otoroshi.get.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorPrint } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const otoroshiGetCommand = defineCommand({
+  description: 'Get information about a deployed Otoroshi',
+  since: '3.13.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [addonIdOrNameArg],
+  async handler(options, addonIdOrName) {
+    const { format } = options;
+    await operatorPrint('otoroshi', addonIdOrName, format);
+  },
+});

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

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpen } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const otoroshiOpenCommand = defineCommand({
+  description: 'Open the Otoroshi dashboard in Clever Cloud Console',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpen('otoroshi', addonIdOrName);
+  },
+});

package/src/commands/otoroshi/otoroshi.open.logs.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpenLogs } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const otoroshiOpenLogsCommand = defineCommand({
+  description: 'Open the Otoroshi application logs in Clever Cloud Console',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpenLogs('otoroshi', addonIdOrName);
+  },
+});

package/src/commands/otoroshi/otoroshi.open.webui.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpenWebUi } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const otoroshiOpenWebuiCommand = defineCommand({
+  description: 'Open the Otoroshi admin console in your browser',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpenWebUi('otoroshi', addonIdOrName);
+  },
+});

package/src/commands/otoroshi/otoroshi.rebuild.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorRebuild } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const otoroshiRebuildCommand = defineCommand({
+  description: 'Rebuild Otoroshi',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorRebuild('otoroshi', addonIdOrName);
+  },
+});

package/src/commands/otoroshi/otoroshi.restart.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorReboot } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const otoroshiRestartCommand = defineCommand({
+  description: 'Restart Otoroshi',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorReboot('otoroshi', addonIdOrName);
+  },
+});

package/src/commands/otoroshi/otoroshi.version.check.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorCheckVersion } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const otoroshiVersionCheckCommand = defineCommand({
+  description: 'Check Otoroshi deployed version',
+  since: '3.13.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [addonIdOrNameArg],
+  async handler(options, addonIdOrName) {
+    const { format } = options;
+    await operatorCheckVersion('otoroshi', addonIdOrName, format);
+  },
+});

package/src/commands/otoroshi/otoroshi.version.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorCheckVersion } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const otoroshiVersionCommand = defineCommand({
+  description: 'Manage Otoroshi deployed version',
+  since: '3.13.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [addonIdOrNameArg],
+  async handler(options, addonIdOrName) {
+    const { format } = options;
+    await operatorCheckVersion('otoroshi', addonIdOrName, format);
+  },
+});

package/src/commands/otoroshi/otoroshi.version.update.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorUpdateVersion } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+import { targetVersionOption } from '../global.options.js';
+
+export const otoroshiVersionUpdateCommand = defineCommand({
+  description: 'Update Otoroshi deployed version',
+  since: '3.13.0',
+  options: {
+    target: targetVersionOption,
+  },
+  args: [addonIdOrNameArg],
+  async handler(options, addonIdOrName) {
+    const { target } = options;
+    await operatorUpdateVersion('otoroshi', target, addonIdOrName);
+  },
+});

package/src/commands/profile/profile.command.js

@@ -0,0 +1,60 @@
+import dedent from 'dedent';
+import { defineCommand } from '../../lib/define-command.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import * as User from '../../models/user.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const profileCommand = defineCommand({
+  description: 'Display the profile of the current user',
+  since: '0.10.1',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [],
+  async handler(options) {
+    const { format } = options;
+
+    const user = await User.getCurrent();
+    const currentToken = await User.getCurrentToken();
+    const tokenExpiration = new Date(currentToken.expirationDate).toLocaleString('en-US', {
+      year: 'numeric',
+      month: 'short',
+      day: 'numeric',
+      hour: 'numeric',
+      minute: 'numeric',
+      hour12: false,
+      timeZone: 'UTC',
+      timeZoneName: 'short',
+    });
+
+    const formattedUser = {
+      id: user.id,
+      email: user.email,
+      name: user.name,
+      avatar: user.avatar,
+      creationDate: new Date(user.creationDate),
+      tokenExpiration: new Date(currentToken.expirationDate).toISOString(),
+      lang: user.lang,
+      has2FA: user.preferredMFA != null && user.preferredMFA !== 'NONE',
+    };
+
+    switch (format) {
+      case 'json': {
+        Logger.printJson(formattedUser);
+        break;
+      }
+      case 'human':
+      default: {
+        Logger.println(dedent`
+            You're currently logged in as:
+            User id           ${formattedUser.id}
+            Name              ${formattedUser.name ?? styleText(['red', 'bold'], '[not specified]')}
+            Email             ${formattedUser.email}
+            Token expiration  ${tokenExpiration}
+            Two factor auth   ${formattedUser.has2FA ? 'yes' : 'no'}
+          `);
+      }
+    }
+  },
+});