clever-tools 4.7.1 → 4.9.0

package/src/commands/oauth-consumers/oauth-consumers.docs.md

@@ -0,0 +1,130 @@
+# 📖 `clever oauth-consumers` command reference
+
+## ➡️ `clever oauth-consumers` <kbd>Since 4.8.0</kbd>
+
+Manage OAuth consumers used with a Clever Cloud login
+
+```bash
+clever oauth-consumers
+```
+
+## ➡️ `clever oauth-consumers create` <kbd>Since 4.8.0</kbd>
+
+Create an OAuth consumer
+
+```bash
+clever oauth-consumers create <name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`name`|Consumer name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--base-url` `<url>`|OAuth callback base URL|
+|`-d`, `--description` `<description>`|Consumer description|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+|`--picture` `<url>`|Application logo URL|
+|`--rights` `<rights>`|Comma-separated list of rights (access-organisations, access-organisations-bills, access-organisations-consumption-statistics, access-organisations-credit-count, access-personal-information, manage-organisations, manage-organisations-applications, manage-organisations-members, manage-organisations-services, manage-personal-information, manage-ssh-keys, all)|
+|`--url` `<url>`|Application home URL|
+
+## ➡️ `clever oauth-consumers delete` <kbd>Since 4.8.0</kbd>
+
+Delete an OAuth consumer
+
+```bash
+clever oauth-consumers delete <consumer-key|consumer-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`consumer-key|consumer-name`|OAuth consumer key (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-y`, `--yes`|Skip confirmation prompts|
+
+## ➡️ `clever oauth-consumers get` <kbd>Since 4.8.0</kbd>
+
+Get details of an OAuth consumer
+
+```bash
+clever oauth-consumers get <consumer-key|consumer-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`consumer-key|consumer-name`|OAuth consumer key (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`--with-secret`|Include the consumer secret in the output|
+
+## ➡️ `clever oauth-consumers list` <kbd>Since 4.8.0</kbd>
+
+List OAuth consumers
+
+```bash
+clever oauth-consumers list [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever oauth-consumers open` <kbd>Since 4.8.0</kbd>
+
+Open an OAuth consumer in the Clever Cloud Console
+
+```bash
+clever oauth-consumers open <consumer-key|consumer-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`consumer-key|consumer-name`|OAuth consumer key (or name, if unambiguous)|
+
+## ➡️ `clever oauth-consumers update` <kbd>Since 4.8.0</kbd>
+
+Update an OAuth consumer
+
+```bash
+clever oauth-consumers update <consumer-key|consumer-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`consumer-key|consumer-name`|OAuth consumer key (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--base-url` `<url>`|OAuth callback base URL|
+|`-d`, `--description` `<description>`|Consumer description|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`-n`, `--name` `<name>`|Consumer name|
+|`--picture` `<url>`|Application logo URL|
+|`--rights` `<rights>`|Comma-separated list of rights (access-organisations, access-organisations-bills, access-organisations-consumption-statistics, access-organisations-credit-count, access-personal-information, manage-organisations, manage-organisations-applications, manage-organisations-members, manage-organisations-services, manage-personal-information, manage-ssh-keys, all)|
+|`--url` `<url>`|Application home URL|

package/src/commands/oauth-consumers/oauth-consumers.get.command.js

@@ -0,0 +1,67 @@
+import { getSecret as getOauthConsumerSecret } from '@clevercloud/client/esm/api/v2/oauth-consumer.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 { OAUTH_RIGHTS, resolveOauthConsumer } from '../../models/oauth-consumer.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+import { consumerKeyOrNameArg } from './oauth-consumers.args.js';
+
+export const oauthConsumersGetCommand = defineCommand({
+  description: 'Get details of an OAuth consumer',
+  since: '4.8.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+    withSecret: defineOption({
+      name: 'with-secret',
+      schema: z.boolean().default(false),
+      description: 'Include the consumer secret in the output',
+    }),
+  },
+  args: [consumerKeyOrNameArg],
+  async handler(options, keyOrName) {
+    const { format, withSecret } = options;
+
+    const oauthConsumer = await resolveOauthConsumer(keyOrName);
+
+    const secret = withSecret
+      ? await getOauthConsumerSecret({ id: oauthConsumer.ownerId, key: oauthConsumer.key })
+          .then(sendToApi)
+          .then((c) => c.secret)
+      : null;
+
+    switch (format) {
+      case 'json': {
+        Logger.printJson({ ...oauthConsumer, ...(secret != null && { secret }) });
+        break;
+      }
+      case 'human':
+      default: {
+        const dataToPrint = {
+          Key: oauthConsumer.key,
+          Name: oauthConsumer.name || '(unnamed)',
+          Description: oauthConsumer.description || '',
+          URL: oauthConsumer.url || '',
+          Picture: oauthConsumer.picture || '',
+          'Base URL': oauthConsumer.baseUrl || '',
+        };
+
+        if (secret != null) {
+          dataToPrint.Secret = secret;
+        }
+
+        console.table(dataToPrint);
+
+        if (oauthConsumer.rights) {
+          Logger.println('');
+          const rightsData = {};
+          for (const [apiName, cliName] of Object.entries(OAUTH_RIGHTS)) {
+            rightsData[cliName] = oauthConsumer.rights[apiName] ?? false;
+          }
+          console.table(rightsData);
+        }
+      }
+    }
+  },
+});

package/src/commands/oauth-consumers/oauth-consumers.list.command.js

@@ -0,0 +1,34 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { printItemsByOwner } from '../../lib/print-items-by-owner.js';
+import { Logger } from '../../logger.js';
+import { getAllConsumers } from '../../models/oauth-consumer.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const oauthConsumersListCommand = defineCommand({
+  description: 'List OAuth consumers',
+  since: '4.8.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  async handler(options) {
+    const { format } = options;
+    const oauthConsumers = await getAllConsumers();
+
+    switch (format) {
+      case 'json': {
+        const consumersPerOwner = Object.groupBy(oauthConsumers, (c) => c.ownerId);
+        Logger.printJson(consumersPerOwner);
+        break;
+      }
+      case 'human':
+      default: {
+        printItemsByOwner(oauthConsumers, {
+          itemName: 'OAuth consumer',
+          emptyCommand: 'clever oauth-consumers create',
+          getItemId: (c) => c.key,
+          getExtraLines: (c) => (c.url ? `URL: ${c.url}` : null),
+        });
+      }
+    }
+  },
+});

package/src/commands/oauth-consumers/oauth-consumers.open.command.js

@@ -0,0 +1,18 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { styleText } from '../../lib/style-text.js';
+import { resolveOauthConsumer } from '../../models/oauth-consumer.js';
+import { openBrowser } from '../../models/utils.js';
+import { consumerKeyOrNameArg } from './oauth-consumers.args.js';
+
+export const oauthConsumersOpenCommand = defineCommand({
+  description: 'Open an OAuth consumer in the Clever Cloud Console',
+  since: '4.8.0',
+  args: [consumerKeyOrNameArg],
+  async handler(options, keyOrName) {
+    const oauthConsumer = await resolveOauthConsumer(keyOrName);
+    await openBrowser(
+      `/organisations/${oauthConsumer.ownerId}/oauth-consumers/${oauthConsumer.key}`,
+      `Opening OAuth consumer ${styleText('blue', oauthConsumer.key)} in the browser…`,
+    );
+  },
+});

package/src/commands/oauth-consumers/oauth-consumers.options.js

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+import { defineOption } from '../../lib/define-option.js';
+import { OAUTH_RIGHTS } from '../../models/oauth-consumer.js';
+
+export const descriptionOption = defineOption({
+  name: 'description',
+  schema: z.string().trim().min(1).optional(),
+  description: 'Consumer description',
+  aliases: ['d'],
+  placeholder: 'description',
+});
+
+export const urlOption = defineOption({
+  name: 'url',
+  schema: z.string().url().optional(),
+  description: 'Application home URL',
+  placeholder: 'url',
+});
+
+export const pictureOption = defineOption({
+  name: 'picture',
+  schema: z.string().url().optional(),
+  description: 'Application logo URL',
+  placeholder: 'url',
+});
+
+export const baseUrlOption = defineOption({
+  name: 'base-url',
+  schema: z.string().url().optional(),
+  description: 'OAuth callback base URL',
+  placeholder: 'url',
+});
+
+/** @type {[string, ...string[]]} */
+const OAUTH_RIGHTS_WITH_ALL = [...Object.values(OAUTH_RIGHTS), 'all'];
+
+const rightsSchema = z
+  .string()
+  .transform((s) => s.split(',').map((r) => r.trim()))
+  .pipe(z.array(z.enum(OAUTH_RIGHTS_WITH_ALL)))
+  .optional();
+
+export const rightsOption = defineOption({
+  name: 'rights',
+  schema: rightsSchema,
+  description: `Comma-separated list of rights (${OAUTH_RIGHTS_WITH_ALL.join(', ')})`,
+  placeholder: 'rights',
+});

package/src/commands/oauth-consumers/oauth-consumers.update.command.js

@@ -0,0 +1,83 @@
+import { update as updateOauthConsumer } from '@clevercloud/client/esm/api/v2/oauth-consumer.js';
+import { z } from 'zod';
+import { defineCommand } from '../../lib/define-command.js';
+import { defineOption } from '../../lib/define-option.js';
+import { promptTextOption } from '../../lib/prompts.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import {
+  promptRights,
+  removeReadonlyRights,
+  resolveOauthConsumer,
+  rightsFromList,
+} from '../../models/oauth-consumer.js';
+import { sendToApi } from '../../models/send-to-api.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+import { consumerKeyOrNameArg } from './oauth-consumers.args.js';
+import { baseUrlOption, descriptionOption, pictureOption, rightsOption, urlOption } from './oauth-consumers.options.js';
+
+const nameOption = defineOption({
+  name: 'name',
+  schema: z.string().trim().min(1).optional(),
+  description: 'Consumer name',
+  aliases: ['n'],
+  placeholder: 'name',
+});
+
+export const oauthConsumersUpdateCommand = defineCommand({
+  description: 'Update an OAuth consumer',
+  since: '4.8.0',
+  options: {
+    name: nameOption,
+    description: descriptionOption,
+    url: urlOption,
+    picture: pictureOption,
+    baseUrl: baseUrlOption,
+    rights: rightsOption,
+    format: humanJsonOutputFormatOption,
+  },
+  args: [consumerKeyOrNameArg],
+  async handler(options, keyOrName) {
+    const { name, description, url, picture, baseUrl, rights, format } = options;
+
+    const oauthConsumer = await resolveOauthConsumer(keyOrName);
+
+    const hasAnyOption = [name, description, url, picture, baseUrl, rights].some((v) => v != null);
+
+    const body = hasAnyOption
+      ? {
+          name: name ?? oauthConsumer.name,
+          description: description ?? oauthConsumer.description,
+          url: url ?? oauthConsumer.url,
+          picture: picture ?? oauthConsumer.picture,
+          baseUrl: baseUrl ?? oauthConsumer.baseUrl,
+          rights: rights != null ? rightsFromList(rights) : removeReadonlyRights(oauthConsumer.rights),
+        }
+      : {
+          name: await promptTextOption(nameOption, oauthConsumer.name),
+          description: await promptTextOption(descriptionOption, oauthConsumer.description),
+          url: await promptTextOption(urlOption, oauthConsumer.url),
+          picture: await promptTextOption(pictureOption, oauthConsumer.picture),
+          baseUrl: await promptTextOption(baseUrlOption, oauthConsumer.baseUrl),
+          rights: await promptRights(oauthConsumer.rights),
+        };
+
+    const updatedOauthConsumer = await updateOauthConsumer(
+      { id: oauthConsumer.ownerId, key: oauthConsumer.key },
+      body,
+    ).then(sendToApi);
+
+    switch (format) {
+      case 'json': {
+        Logger.printJson(updatedOauthConsumer);
+        break;
+      }
+      case 'human':
+      default: {
+        Logger.printSuccess(
+          `OAuth consumer ${styleText(['bold', 'green'], updatedOauthConsumer.key)} has been updated!`,
+        );
+      }
+    }
+  },
+});

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

@@ -19,6 +19,6 @@ export const openCommand = defineCommand({
     const vhost = await Domain.getBest(appId, ownerId);
     const url = 'https://' + vhost.fqdn;
 
-    await openBrowser(url, 'Opening the application in your browser');
+    await openBrowser(url, 'Opening the application in the browser…');
   },
 });

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

@@ -108,6 +108,20 @@ clever otoroshi open logs <addon-id|addon-name>
 |---|---|
 |`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
 
+## ➡️ `clever otoroshi open swaggerui` <kbd>Since 4.9.0</kbd>
+
+Open the Otoroshi Swagger UI in your browser
+
+```bash
+clever otoroshi open swaggerui <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

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

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

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

@@ -7,6 +7,6 @@ export const profileOpenCommand = defineCommand({
   options: {},
   args: [],
   async handler() {
-    await openBrowser('/users/me/information', 'Opening the profile page in your browser');
+    await openBrowser('/users/me/information', 'Opening the profile page in the browser…');
   },
 });

package/src/commands/restart/restart.docs.md

@@ -15,7 +15,7 @@ clever restart [options]
 |`-a`, `--alias` `<alias>`|Short name for the application|
 |`--app` `<app-id\|app-name>`|Application to manage by its ID (or name, if unambiguous)|
 |`--commit` `<commit-id>`|Restart the application with a specific commit ID|
-|`-e`, `--exit-on` `<step>`|Step at which the logs streaming is ended, steps are: deploy-start, deploy-end, never (default: deploy-end)|
+|`-e`, `--exit-on` `<step>`|Step at which the logs streaming is ended (deploy-start, deploy-end, never) (default: deploy-end)|
 |`--follow`|Continue to follow logs after deployment has ended *(deprecated, use `--exit-on never` instead)*|
 |`-q`, `--quiet`|Don't show logs during deployment|
 |`--without-cache`|Restart the application without using cache|

package/src/commands/ssh-keys/ssh-keys.open.command.js

@@ -7,6 +7,6 @@ export const sshKeysOpenCommand = defineCommand({
   options: {},
   args: [],
   handler() {
-    return openBrowser('/users/me/ssh-keys', 'Opening the SSH keys management page of the Console in your browser');
+    return openBrowser('/users/me/ssh-keys', 'Opening the SSH keys page in the browser…');
   },
 });

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

@@ -1,7 +1,7 @@
 import { deleteWebhook } 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 { getOwnerIdFromOrgIdOrName } from '../../models/ids-resolver.js';
 import { sendToApi } from '../../models/send-to-api.js';
 import { notificationIdArg } from '../global.args.js';
 import { orgaIdOrNameOption } from '../global.options.js';
@@ -16,7 +16,7 @@ export const webhooksRemoveCommand = defineCommand({
   async handler(options, notificationId) {
     const { org } = options;
 
-    const ownerId = await getOrgaIdOrUserId(org);
+    const ownerId = await getOwnerIdFromOrgIdOrName(org);
     await deleteWebhook({ ownerId, id: notificationId }).then(sendToApi);
 
     Logger.println('The notification has been successfully removed');

package/src/lib/cliparse-patched.js

@@ -80,6 +80,7 @@ cliparseCommandModule.help = function (context) {
   if (commandInfo.args) {
     argumentsRows = commandInfo.args.map((arg) => {
       let description = arg.description;
+      if (arg.enumValues) description += ` (${arg.enumValues.join(', ')})`;
       if (arg.optional) description += ` ${styleText('dim', arg.optional)}`;
       return [arg.name, description];
     });
@@ -93,6 +94,7 @@ cliparseCommandModule.help = function (context) {
       const aliasesPadding = opt.aliases[0].length === 2 ? '' : '    ';
       const aliases = aliasesPadding + opt.aliases.join(', ') + placeholder;
       let description = opt.description;
+      if (opt.enumValues) description += ` (${opt.enumValues.join(', ')})`;
       if (opt.deprecated) description += ` ${styleText('dim', opt.deprecated)}`;
       if (opt.required) description += ` ${styleText('dim', opt.required)}`;
       if (opt.default) description += ` ${styleText('dim', opt.default)}`;

package/src/lib/get-command-info.js

@@ -1,4 +1,4 @@
-import { getDefault, isBoolean, isRequired } from './zod-utils.js';
+import { getDefault, getEnumValues, isBoolean, isRequired } from './zod-utils.js';
 
 /**
  * @typedef {import('./get-command-info.types.d.ts').ArgumentInfo} ArgumentInfo
@@ -45,6 +45,7 @@ export function getCommandInfo(path, definition) {
           name: arg.placeholder,
           description: arg.description,
           optional: isRequired(arg.schema) ? null : '(optional)',
+          enumValues: getEnumValues(arg.schema) ?? null,
         };
       })
     : null;
@@ -78,6 +79,7 @@ export function getCommandInfo(path, definition) {
                   : null,
             required: isRequired(option.schema) ? '(required)' : null,
             default: defaultValue ? `(default: ${defaultValue})` : null,
+            enumValues: getEnumValues(option.schema) ?? null,
           };
         })
     : null;

package/src/lib/get-command-info.types.d.ts

@@ -13,6 +13,8 @@ export interface ArgumentInfo {
   description: string;
   /** '(optional)' or null */
   optional: string | null;
+  /** Enum values if the schema is a z.enum(), or null */
+  enumValues: string[] | null;
 }
 
 export interface OptionInfo {
@@ -30,6 +32,8 @@ export interface OptionInfo {
   required: string | null;
   /** '(default: value)' or null */
   default: string | null;
+  /** Enum values if the schema is a z.enum(), or null */
+  enumValues: string[] | null;
 }
 
 export interface CommandInfo {