heroku 11.0.0-alpha.11 → 11.0.0-alpha.12

package/lib/commands/addons/destroy.d.ts

@@ -1,20 +1,20 @@
 import { Command } from '@heroku-cli/command';
 export default class Destroy extends Command {
-    static topic: string;
+    static args: {
+        addonName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
-    static strict: boolean;
     static examples: string[];
-    static hiddenAliases: string[];
     static flags: {
-        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        confirm: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        wait: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        confirm: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        wait: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    static args: {
-        addonName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
+    static hiddenAliases: string[];
     static notifier: (subtitle: string, message: string, success?: boolean) => void;
+    static strict: boolean;
+    static topic: string;
     run(): Promise<void>;
 }

package/lib/commands/addons/destroy.js

@@ -1,38 +1,38 @@
-import { color } from '@heroku-cli/color';
+import { color, utils } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { Args } from '@oclif/core';
-import notify from '../../lib/notify.js';
-import ConfirmCommand from '../../lib/confirmCommand.js';
-import destroyAddon from '../../lib/addons/destroy_addon.js';
-import { resolveAddon } from '../../lib/addons/resolve.js';
 import _ from 'lodash';
+import destroyAddon from '../../lib/addons/destroy_addon.js';
+import ConfirmCommand from '../../lib/confirmCommand.js';
+import notify from '../../lib/notify.js';
 export default class Destroy extends Command {
-    static topic = 'addons';
+    static args = {
+        addonName: Args.string({ description: 'unique identifier or globally unique name of the add-on', required: true }),
+    };
     static description = 'permanently destroy an add-on resource';
-    static strict = false;
-    static examples = ['addons:destroy [ADDON]... [flags]'];
-    static hiddenAliases = ['addons:remove'];
+    static examples = [`${color.command('addons:destroy [ADDON]... [flags]')}`];
     static flags = {
-        force: flags.boolean({ char: 'f', description: 'allow destruction even if connected to other apps' }),
-        confirm: flags.string({ char: 'c' }),
-        wait: flags.boolean({ description: 'watch add-on destruction status and exit when complete' }),
         app: flags.app(),
+        confirm: flags.string({ char: 'c' }),
+        force: flags.boolean({ char: 'f', description: 'allow destruction even if connected to other apps' }),
         remote: flags.remote(),
+        wait: flags.boolean({ description: 'watch add-on destruction status and exit when complete' }),
     };
-    static args = {
-        addonName: Args.string({ required: true, description: 'unique identifier or globally unique name of the add-on' }),
-    };
+    static hiddenAliases = ['addons:remove'];
     static notifier = notify;
+    static strict = false;
+    static topic = 'addons';
     async run() {
-        const { flags, argv } = await this.parse(Destroy);
-        const { app, wait, confirm } = flags;
+        const { argv, flags } = await this.parse(Destroy);
+        const { app, confirm, wait } = flags;
         const force = flags.force || process.env.HEROKU_FORCE === '1';
-        const addons = await Promise.all(argv.map((name) => resolveAddon(this.heroku, app, name)));
+        const addonResolver = new utils.AddonResolver(this.heroku);
+        const addons = await Promise.all(argv.map((name) => addonResolver.resolve(name, app)));
         for (const addon of addons) {
             // prevent deletion of add-on when context.app is set but the addon is attached to a different app
             const addonApp = addon.app?.name;
             if (app && addonApp !== app) {
-                throw new Error(`${color.yellow(addon.name ?? '')} is on ${color.magenta(addonApp ?? '')} not ${color.magenta(app)}`);
+                throw new Error(`${color.addon(addon.name ?? '')} is on ${color.app(addonApp ?? '')} not ${color.app(app)}`);
             }
         }
         for (const addonApps of Object.entries(_.groupBy(addons, 'app.name'))) {

package/lib/commands/addons/detach.d.ts

@@ -1,13 +1,13 @@
 import { Command } from '@heroku-cli/command';
 export default class Detach extends Command {
-    static topic: string;
+    static args: {
+        attachment_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
     static flags: {
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    static args: {
-        attachment_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
+    static topic: string;
     run(): Promise<void>;
 }

package/lib/commands/addons/detach.js

@@ -1,26 +1,26 @@
-import { color } from '@heroku-cli/color';
+import { color } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
 export default class Detach extends Command {
-    static topic = 'addons';
+    static args = {
+        attachment_name: Args.string({ description: 'unique identifier of the add-on attachment', required: true }),
+    };
     static description = 'detach an existing add-on resource from an app';
     static flags = {
         app: flags.app({ required: true }),
         remote: flags.remote(),
     };
-    static args = {
-        attachment_name: Args.string({ required: true, description: 'unique identifier of the add-on attachment' }),
-    };
+    static topic = 'addons';
     async run() {
-        const { flags, args } = await this.parse(Detach);
+        const { args, flags } = await this.parse(Detach);
         const { app } = flags;
         const { body: attachment } = await this.heroku.get(`/apps/${app}/addon-attachments/${args.attachment_name}`);
-        ux.action.start(`Detaching ${color.cyan(attachment.name || '')} to ${color.yellow(attachment.addon?.name || '')} from ${color.magenta(app)}`);
+        ux.action.start(`Detaching ${color.attachment(attachment.name || '')} to ${color.addon(attachment.addon?.name || '')} from ${color.app(app)}`);
         await this.heroku.delete(`/addon-attachments/${attachment.id}`);
         ux.action.stop();
-        ux.action.start(`Unsetting ${color.cyan(attachment.name || '')} config vars and restarting ${color.magenta(app)}`);
+        ux.action.start(`Unsetting ${color.attachment(attachment.name || '')} config vars and restarting ${color.app(app)}`);
         const { body: releases } = await this.heroku.get(`/apps/${app}/releases`, {
-            partial: true, headers: { Range: 'version ..; max=1, order=desc' },
+            headers: { Range: 'version ..; max=1, order=desc' }, partial: true,
         });
         ux.action.stop(`done, v${releases[0]?.version || ''}`);
     }

package/lib/commands/addons/docs.d.ts

@@ -1,15 +1,15 @@
 import { Command } from '@heroku-cli/command';
 export default class Docs extends Command {
-    static topic: string;
+    static args: {
+        addon: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
     static flags: {
-        'show-url': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'show-url': import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    static args: {
-        addon: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
+    static topic: string;
     static urlOpener: (url: string) => Promise<unknown>;
     run(): Promise<void>;
 }

package/lib/commands/addons/docs.js

@@ -1,22 +1,22 @@
-import { color } from '@heroku-cli/color';
+import { color } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { Args, ux } from '@oclif/core';
-import { resolveAddon } from '../../lib/addons/resolve.js';
 import open from 'open';
+import { resolveAddon } from '../../lib/addons/resolve.js';
 export default class Docs extends Command {
-    static topic = 'addons';
+    static args = {
+        addon: Args.string({ description: 'unique identifier or globally unique name of the add-on', required: true }),
+    };
     static description = "open an add-on's Dev Center documentation in your browser";
     static flags = {
-        'show-url': flags.boolean({ description: 'show URL, do not open browser' }),
         app: flags.app(),
         remote: flags.remote(),
+        'show-url': flags.boolean({ description: 'show URL, do not open browser' }),
     };
-    static args = {
-        addon: Args.string({ required: true, description: 'unique identifier or globally unique name of the add-on' }),
-    };
+    static topic = 'addons';
     static urlOpener = open;
     async run() {
-        const { flags, args } = await this.parse(Docs);
+        const { args, flags } = await this.parse(Docs);
         const { app } = flags;
         const id = args.addon.split(':')[0];
         const addonResponse = await this.heroku.get(`/addon-services/${encodeURIComponent(id)}`)
@@ -27,7 +27,7 @@ export default class Docs extends Command {
             ux.stdout(url);
         }
         else {
-            ux.stdout(`Opening ${color.cyan(url)}...`);
+            ux.stdout(`Opening ${color.info(url)}...`);
             await Docs.urlOpener(url);
         }
     }

package/lib/commands/addons/index.d.ts

@@ -2,15 +2,15 @@ import { Command } from '@heroku-cli/command';
 import * as Heroku from '@heroku-cli/schema';
 export declare function renderAttachment(attachment: Heroku.AddOnAttachment, app: string, isFirst?: boolean): string;
 export default class Addons extends Command {
-    static topic: string;
-    static usage: string;
     static description: string;
+    static examples: string[];
     static flags: {
         all: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    static examples: string[];
+    static topic: string;
+    static usage: string;
     run(): Promise<void>;
 }

package/lib/commands/addons/index.js

@@ -1,10 +1,9 @@
-import { color } from '@heroku-cli/color';
+import { color, hux } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { ux } from '@oclif/core';
-import { hux } from '@heroku/heroku-cli-util';
-import { formatPrice, grandfatheredPrice, formatState } from '../../lib/addons/util.js';
 import _ from 'lodash';
 import printf from 'printf';
+import { formatPrice, formatState, grandfatheredPrice } from '../../lib/addons/util.js';
 const topic = 'addons';
 async function addonGetter(api, app) {
     let attachmentsResponse = null;
@@ -12,8 +11,8 @@ async function addonGetter(api, app) {
     if (app) { // don't display attachments globally
         addonsResponse = api.get(`/apps/${app}/addons`, {
             headers: {
-                'Accept-Expansion': 'addon_service,plan',
                 Accept: 'application/vnd.heroku+json; version=3.sdk',
+                'Accept-Expansion': 'addon_service,plan',
             },
         });
         const sudoHeaders = JSON.parse(process.env.HEROKU_HEADERS || '{}');
@@ -32,8 +31,8 @@ async function addonGetter(api, app) {
     else {
         addonsResponse = api.get('/addons', {
             headers: {
-                'Accept-Expansion': 'addon_service,plan',
                 Accept: 'application/vnd.heroku+json; version=3.sdk',
+                'Accept-Expansion': 'addon_service,plan',
             },
         });
     }
@@ -61,7 +60,7 @@ async function addonGetter(api, app) {
     _.values(groupedAttachments)
         .forEach(atts => {
         const inaccessibleAddon = {
-            app: atts[0].addon.app, name: atts[0].addon.name, addon_service: {}, plan: {}, attachments: atts,
+            addon_service: {}, app: atts[0].addon.app, attachments: atts, name: atts[0].addon.name, plan: {},
         };
         if (isRelevantToApp(inaccessibleAddon)) {
             addons.push(inaccessibleAddon);
@@ -75,12 +74,13 @@ function displayAll(addons) {
         ux.stdout('No add-ons.');
         return;
     }
+    /* eslint-disable perfectionist/sort-objects */
     hux.table(addons, {
         'Owning App': {
-            get: ({ app }) => color.cyan(app?.name || ''),
+            get: ({ app }) => color.app(app?.name || ''),
         },
         'Add-on': {
-            get: ({ name }) => color.magenta(name || ''),
+            get: ({ name }) => color.addon(name || ''),
         },
         Plan: {
             get({ plan }) {
@@ -93,14 +93,14 @@ function displayAll(addons) {
             get({ plan }) {
                 if (plan?.price === undefined)
                     return color.dim('?');
-                return formatPrice({ price: plan?.price, hourly: true });
+                return formatPrice({ hourly: true, price: plan?.price });
             },
         },
         'Max Price': {
             get({ plan }) {
                 if (plan?.price === undefined)
                     return color.dim('?');
-                return formatPrice({ price: plan?.price, hourly: false });
+                return formatPrice({ hourly: false, price: plan?.price });
             },
         },
         State: {
@@ -125,12 +125,13 @@ function displayAll(addons) {
     }, {
         overflow: 'wrap',
     });
+    /* eslint-enable perfectionist/sort-objects */
 }
 function formatAttachment(attachment, showApp = true) {
-    const attName = color.green(attachment.name || '');
+    const attName = color.attachment(attachment.name || '');
     const output = [color.dim('as'), attName];
     if (showApp) {
-        const appInfo = `on ${color.cyan(attachment.app?.name || '')} app`;
+        const appInfo = `on ${color.app(attachment.app?.name || '')} app`;
         output.push(color.dim(appInfo));
     }
     return output.join(' ');
@@ -147,7 +148,7 @@ function displayForApp(app, addons) {
     }
     const isForeignApp = (attOrAddon) => attOrAddon.app?.name !== app;
     function presentAddon(addon) {
-        const name = color.magenta(addon.name || '');
+        const name = color.addon(addon.name || '');
         let service = addon.addon_service?.name;
         if (service === undefined) {
             service = color.dim('?');
@@ -174,17 +175,18 @@ function displayForApp(app, addons) {
         Price: {
             get(addon) {
                 if (addon.app?.name === app) {
-                    return formatPrice({ price: addon.plan?.price, hourly: true });
+                    return formatPrice({ hourly: true, price: addon.plan?.price });
                 }
-                return color.dim(printf('(billed to %s app)', color.cyan(addon.app?.name || '')));
+                return color.dim(printf('(billed to %s app)', color.app(addon.app?.name || '')));
             },
         },
+        // eslint-disable-next-line perfectionist/sort-objects
         'Max Price': {
             get(addon) {
                 if (addon.app?.name === app) {
-                    return formatPrice({ price: addon.plan?.price, hourly: false });
+                    return formatPrice({ hourly: false, price: addon.plan?.price });
                 }
-                return color.dim(printf('(billed to %s app)', color.cyan(addon.app?.name || '')));
+                return color.dim(printf('(billed to %s app)', color.app(addon.app?.name || '')));
             },
         },
         State: {
@@ -193,14 +195,12 @@ function displayForApp(app, addons) {
     }, {
         overflow: 'wrap',
     });
-    ux.stdout(`The table above shows ${color.magenta('add-ons')} and the ${color.green('attachments')} to the current app (${app}) or other ${color.cyan('apps')}.\n  `);
+    ux.stdout(`The table above shows add-ons and the attachments to the current app (${color.app(app)}) or other apps.\n  `);
 }
 function displayJSON(addons) {
     ux.stdout(JSON.stringify(addons, null, 2));
 }
 export default class Addons extends Command {
-    static topic = topic;
-    static usage = 'addons [--all|--app APP]';
     static description = `Lists your add-ons and attachments.
 
   The default filter applied depends on whether you are in a Heroku app
@@ -208,19 +208,21 @@ export default class Addons extends Command {
   is implied. Explicitly providing either flag overrides the default
   behavior.
   `;
+    static examples = [
+        `${color.command(`heroku ${topic} --all`)}`,
+        `${color.command(`heroku ${topic} --app acme-inc-www`)}`,
+    ];
     static flags = {
         all: flags.boolean({ char: 'A', description: 'show add-ons and attachments for all accessible apps' }),
-        json: flags.boolean({ description: 'return add-ons in json format' }),
         app: flags.app(),
+        json: flags.boolean({ description: 'return add-ons in json format' }),
         remote: flags.remote(),
     };
-    static examples = [
-        `$ heroku ${topic} --all`,
-        `$ heroku ${topic} --app acme-inc-www`,
-    ];
+    static topic = topic;
+    static usage = 'addons [--all|--app APP]';
     async run() {
         const { flags } = await this.parse(Addons);
-        const { app, all, json } = flags;
+        const { all, app, json } = flags;
         if (!all && app) {
             const addons = await addonGetter(this.heroku, app);
             if (json)

package/lib/commands/addons/info.d.ts

@@ -1,14 +1,14 @@
 import { Command } from '@heroku-cli/command';
 export default class Info extends Command {
-    static topic: string;
+    static args: {
+        addon: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
     static flags: {
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
+    static topic: string;
     static usage: string;
-    static args: {
-        addon: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
     run(): Promise<void>;
 }

package/lib/commands/addons/info.js

@@ -1,38 +1,42 @@
-import { color } from '@heroku-cli/color';
+import { color, hux } from '@heroku/heroku-cli-util';
 import { Command, flags } from '@heroku-cli/command';
 import { Args } from '@oclif/core';
-import { hux } from '@heroku/heroku-cli-util';
-import { grandfatheredPrice, formatPrice, formatState } from '../../lib/addons/util.js';
 import { resolveAddon } from '../../lib/addons/resolve.js';
+import { formatPrice, formatState, grandfatheredPrice } from '../../lib/addons/util.js';
 const topic = 'addons';
 export default class Info extends Command {
-    static topic = topic;
+    static args = {
+        addon: Args.string({ description: 'unique identifier or globally unique name of the add-on', required: true }),
+    };
     static description = 'show detailed add-on resource and attachment information';
     static flags = {
         app: flags.app(),
         remote: flags.remote(),
     };
+    static topic = topic;
     static usage = `${topic}:info ADDON`;
-    static args = {
-        addon: Args.string({ required: true, description: 'unique identifier or globally unique name of the add-on' }),
-    };
     async run() {
-        const { flags, args } = await this.parse(Info);
+        const { args, flags } = await this.parse(Info);
         const { app } = flags;
         const addon = await resolveAddon(this.heroku, app, args.addon);
         const { body: attachments } = await this.heroku.get(`/addons/${addon.id}/addon-attachments`);
         addon.plan.price = grandfatheredPrice(addon);
         addon.attachments = attachments;
-        hux.styledHeader(color.magenta(addon.name ?? ''));
+        hux.styledHeader(color.addon(addon.name ?? ''));
+        /* eslint-disable perfectionist/sort-objects */
         hux.styledObject({
             Plan: addon.plan.name,
-            Price: formatPrice({ price: addon.plan.price, hourly: true }),
-            'Max Price': formatPrice({ price: addon.plan.price, hourly: false }),
+            Price: formatPrice({ hourly: true, price: addon.plan.price }),
+            'Max Price': formatPrice({ hourly: false, price: addon.plan.price }),
             Attachments: addon.attachments.map((att) => [
-                color.cyan(att.app?.name || ''), color.green(att.name || ''),
+                color.app(att.app?.name || ''), color.attachment(att.name || ''),
             ].join('::'))
-                .sort(), 'Owning app': color.cyan(addon.app?.name ?? ''), 'Installed at': (new Date(addon.created_at ?? ''))
-                .toString(), State: formatState(addon.state),
+                .sort(),
+            'Owning app': color.app(addon.app?.name ?? ''),
+            'Installed at': (new Date(addon.created_at ?? ''))
+                .toString(),
+            State: formatState(addon.state),
         });
+        /* eslint-enable perfectionist/sort-objects */
     }
 }

package/lib/commands/addons/open.d.ts

@@ -1,13 +1,5 @@
 import { Command } from '@heroku-cli/command';
 export interface SsoParams {
-    /**
-     * user email address
-     */
-    email: string;
-    /**
-     * user ID
-     */
-    user_id: string;
     /**
      * billing app name
      */
@@ -17,21 +9,17 @@ export interface SsoParams {
      */
     context_app: string;
     /**
-     * SSO request timestamp
-     */
-    timestamp: string;
-    /**
-     * Navigation metadata (deprecated)
+     * user email address
      */
-    'nav-data': string;
+    email: string;
     /**
      * Provider ID (deprecated)
      */
     id: string;
     /**
-     * SSO v1 token (deprecated)
+     * Navigation metadata (deprecated)
      */
-    token: string;
+    'nav-data': string;
     /**
      * Add-on resource ID
      */
@@ -40,35 +28,46 @@ export interface SsoParams {
      * SSO v3 token
      */
     resource_token: string;
-}
-export interface AddonSso {
     /**
-     * SSO request method
+     * SSO request timestamp
      */
-    method: 'get' | 'post';
+    timestamp: string;
+    /**
+     * SSO v1 token (deprecated)
+     */
+    token: string;
+    /**
+     * user ID
+     */
+    user_id: string;
+}
+export interface AddonSso {
     /**
      * URL of the SSO request
      */
     action: string;
+    /**
+     * SSO request method
+     */
+    method: 'get' | 'post';
     /**
      * SSO params for POST request
      */
     params?: SsoParams;
 }
 export default class Open extends Command {
-    static urlOpener: (url: string) => Promise<unknown>;
-    static topic: string;
+    static args: {
+        addon: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
     static description: string;
     static flags: {
-        'show-url': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'show-url': import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    static args: {
-        addon: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
+    static topic: string;
+    static urlOpener: (url: string) => Promise<unknown>;
     static openUrl(url: string): Promise<void>;
-    private parsed;
     run(): Promise<void>;
     private sudo;
     private writeSudoTemplate;