@heroku/heroku-cli-util 10.4.0-beta.0 → 10.4.0

package/README.md

@@ -77,7 +77,7 @@ console.log(color.failure('Build failed'));      // Red
 console.log(color.warning('Deprecated feature')); // Orange
 
 // User/Team colors
-console.log(color.team('my-team'));              // Cyan, bold
+console.log(color.team('my-team'));              // Light cyan
 console.log(color.user('user@example.com'));     // Cyan
 
 // General purpose

package/dist/index.d.ts

@@ -11,6 +11,7 @@ import PsqlService from './utils/pg/psql.js';
 import { ago } from './ux/ago.js';
 import { alignColumns } from './ux/align-columns.js';
 import { anykey } from './ux/any-key.js';
+import { confirmCommand } from './ux/confirm-command.js';
 import { toHumanReadableDataSize } from './ux/data-size.js';
 import { formatPrice } from './ux/format-price.js';
 import { openUrl } from './ux/open-url.js';
@@ -58,6 +59,7 @@ export declare const hux: {
     alignColumns: typeof alignColumns;
     anykey: typeof anykey;
     confirm: (message: string, { defaultAnswer, ms, }?: import("./ux/confirm.js").PromptInputs<boolean>) => Promise<boolean>;
+    confirmCommand: typeof confirmCommand;
     formatPrice: typeof formatPrice;
     openUrl: typeof openUrl;
     prompt: typeof prompt;

package/dist/index.js

@@ -11,6 +11,7 @@ import { ago } from './ux/ago.js';
 import { alignColumns } from './ux/align-columns.js';
 import { anykey } from './ux/any-key.js';
 import { confirm } from './ux/confirm.js';
+import { confirmCommand } from './ux/confirm-command.js';
 import { toHumanReadableDataSize } from './ux/data-size.js';
 import { formatPrice } from './ux/format-price.js';
 import { openUrl } from './ux/open-url.js';
@@ -50,6 +51,7 @@ export const hux = {
     alignColumns,
     anykey,
     confirm,
+    confirmCommand,
     formatPrice,
     openUrl,
     prompt,

package/dist/ux/colors.d.ts

@@ -8,10 +8,13 @@ declare const COLORS: {
     readonly CODE_BG: 237;
     readonly CODE_FG: 255;
     readonly CYAN: "#50D3D5";
+    readonly CYAN_LIGHT: "#8FF5F7";
+    readonly GOLD: 220;
     readonly GRAY: 248;
     readonly GREEN: 40;
-    readonly MAGENTA: "#FF8DD3";
+    readonly MAGENTA: "#FF22DD";
     readonly ORANGE: 214;
+    readonly PINK: 212;
     readonly PURPLE: 147;
     readonly RED: "#FF8787";
     readonly TEAL: 43;
@@ -25,15 +28,19 @@ export declare const addon: (text: string) => string;
 export declare const attachment: (text: string) => string;
 export declare const name: (text: string) => string;
 export declare const success: (text: string) => string;
+export declare const enabled: (text: string) => string;
 export declare const failure: (text: string) => string;
+export declare const error: (text: string) => string;
 export declare const warning: (text: string) => string;
 export declare const team: (text: string) => string;
 export declare const user: (text: string) => string;
 export declare const label: (text: string) => string;
 export declare const info: (text: string) => string;
 export declare const inactive: (text: string) => string;
+export declare const disabled: (text: string) => string;
 export declare const command: (text: string) => string;
 export declare const code: (text: string) => string;
+export declare const snippet: (text: string) => string;
 /**
  * Color palette for reference
  * Shows ANSI256 codes for most colors, hex values for magenta, red, and cyan
@@ -41,12 +48,12 @@ export declare const code: (text: string) => string;
 export declare const colorPalette: {
     readonly addon: {
         readonly name: "yellow";
-        readonly style: "bold";
+        readonly style: "normal";
         readonly value: 185;
     };
     readonly app: {
         readonly name: "purple";
-        readonly style: "bold";
+        readonly style: "normal";
         readonly value: 147;
     };
     readonly attachment: {
@@ -54,6 +61,11 @@ export declare const colorPalette: {
         readonly style: "normal";
         readonly value: 185;
     };
+    readonly code: {
+        readonly name: "white on dark gray";
+        readonly style: "bold";
+        readonly value: 255;
+    };
     readonly command: {
         readonly name: "white on dark gray";
         readonly style: "bold";
@@ -61,7 +73,7 @@ export declare const colorPalette: {
     };
     readonly datastore: {
         readonly name: "yellow";
-        readonly style: "bold";
+        readonly style: "normal";
         readonly value: 185;
     };
     readonly failure: {
@@ -69,6 +81,11 @@ export declare const colorPalette: {
         readonly style: "normal";
         readonly value: "#FF8787";
     };
+    readonly gold: {
+        readonly name: "gold";
+        readonly style: "normal";
+        readonly value: 220;
+    };
     readonly inactive: {
         readonly name: "gray";
         readonly style: "normal";
@@ -87,16 +104,21 @@ export declare const colorPalette: {
     readonly name: {
         readonly name: "magenta";
         readonly style: "normal";
-        readonly value: "#FF8DD3";
+        readonly value: "#FF22DD";
     };
     readonly pipeline: {
         readonly name: "purple";
         readonly style: "normal";
         readonly value: 147;
     };
+    readonly snippet: {
+        readonly name: "white on dark gray";
+        readonly style: "normal";
+        readonly value: 255;
+    };
     readonly space: {
         readonly name: "blue";
-        readonly style: "bold";
+        readonly style: "normal";
         readonly value: 117;
     };
     readonly success: {
@@ -105,9 +127,9 @@ export declare const colorPalette: {
         readonly value: 40;
     };
     readonly team: {
-        readonly name: "cyan";
-        readonly style: "bold";
-        readonly value: "#50D3D5";
+        readonly name: "light cyan";
+        readonly style: "normal";
+        readonly value: "#8FF5F7";
     };
     readonly user: {
         readonly name: "cyan";

package/dist/ux/colors.js

@@ -14,14 +14,19 @@ const COLORS = {
     CODE_FG: 255,
     // Cyan tones (kept as hex for precise color matching)
     CYAN: '#50D3D5',
+    CYAN_LIGHT: '#8FF5F7',
+    // Gold tones (ANSI256: 220, approx. #FFD700)
+    GOLD: 220,
     // Gray tones (ANSI256: 248)
     GRAY: 248,
     // Green tones (ANSI256: 40)
     GREEN: 40,
     // Magenta tones (kept as hex for precise color matching)
-    MAGENTA: '#FF8DD3',
+    MAGENTA: '#FF22DD',
     // Orange tones (ANSI256: 214)
     ORANGE: 214,
+    // Pink tones (ANSI256: 212, approx. #FF87D7 - closest match to original #FF8DD3)
+    PINK: 212,
     // Purple tones (ANSI256: 147 - closest match to original #ACADFF)
     PURPLE: 147,
     // Red tones (kept as hex for precise color matching)
@@ -45,45 +50,52 @@ const supportsAnsi256 = ansi.level >= 2;
 // Helper function for purple color that falls back to ANSI16 magenta when only ANSI16 is supported
 const purpleColorize = () => supportsAnsi256 ? ansi.fg(COLORS.PURPLE) : ansi.magenta;
 // Colors for entities on the Heroku platform
-export const app = (text) => purpleColorize().bold(`${supportsAnsi256 ? '⬢ ' : ''}${text}`);
-export const pipeline = (text) => purpleColorize()(text);
-export const space = (text) => colorize(COLORS.BLUE).bold(`${supportsAnsi256 ? '⬡ ' : ''}${text}`);
-export const datastore = (text) => colorize(COLORS.YELLOW).bold(`${supportsAnsi256 ? '⛁ ' : ''}${text}`);
-export const addon = (text) => colorize(COLORS.YELLOW).bold(text);
-export const attachment = (text) => colorize(COLORS.YELLOW)(text);
-export const name = (text) => colorize(COLORS.MAGENTA)(text);
+export const app = (text) => purpleColorize()(`${supportsAnsi256 ? '⬢ ' : ''}${text}`);
+export const pipeline = (text) => colorize(COLORS.MAGENTA)(text);
+export const space = (text) => colorize(COLORS.BLUE)(`${supportsAnsi256 ? '⬡ ' : ''}${text}`);
+export const datastore = (text) => colorize(COLORS.YELLOW)(`${supportsAnsi256 ? '⛁ ' : ''}${text}`);
+export const addon = (text) => colorize(COLORS.YELLOW)(text);
+export const attachment = (text) => colorize(COLORS.GOLD)(text);
+export const name = (text) => colorize(COLORS.PINK)(text);
 // Status colors
 export const success = (text) => colorize(COLORS.GREEN)(text);
+export const enabled = success;
 export const failure = (text) => colorize(COLORS.RED)(text);
+export const error = failure;
 export const warning = (text) => colorize(COLORS.ORANGE)(text);
 // User/Team colors
-export const team = (text) => colorize(COLORS.CYAN).bold(text);
+export const team = (text) => colorize(COLORS.CYAN_LIGHT)(text);
 export const user = (text) => colorize(COLORS.CYAN)(text);
 // General purpose colors
 export const label = (text) => ansi.bold(text);
 export const info = (text) => colorize(COLORS.TEAL)(text);
 export const inactive = (text) => colorize(COLORS.GRAY)(text);
+export const disabled = inactive;
 export const command = (text) => bgColorize(COLORS.CODE_BG).fg(COLORS.CODE_FG).bold(` $ ${text} `);
 export const code = (text) => bgColorize(COLORS.CODE_BG).fg(COLORS.CODE_FG).bold(`${text}`);
+export const snippet = code;
 /**
  * Color palette for reference
  * Shows ANSI256 codes for most colors, hex values for magenta, red, and cyan
  */
 export const colorPalette = {
-    addon: { name: 'yellow', style: 'bold', value: COLORS.YELLOW },
-    app: { name: 'purple', style: 'bold', value: COLORS.PURPLE },
+    addon: { name: 'yellow', style: 'normal', value: COLORS.YELLOW },
+    app: { name: 'purple', style: 'normal', value: COLORS.PURPLE },
     attachment: { name: 'yellow', style: 'normal', value: COLORS.YELLOW },
+    code: { name: 'white on dark gray', style: 'bold', value: COLORS.CODE_FG },
     command: { name: 'white on dark gray', style: 'bold', value: COLORS.CODE_FG },
-    datastore: { name: 'yellow', style: 'bold', value: COLORS.YELLOW },
+    datastore: { name: 'yellow', style: 'normal', value: COLORS.YELLOW },
     failure: { name: 'red', style: 'normal', value: COLORS.RED },
+    gold: { name: 'gold', style: 'normal', value: COLORS.GOLD },
     inactive: { name: 'gray', style: 'normal', value: COLORS.GRAY },
     info: { name: 'teal', style: 'normal', value: COLORS.TEAL },
     label: { name: 'bright white/black', style: 'bold', value: 'default' },
     name: { name: 'magenta', style: 'normal', value: COLORS.MAGENTA },
     pipeline: { name: 'purple', style: 'normal', value: COLORS.PURPLE },
-    space: { name: 'blue', style: 'bold', value: COLORS.BLUE },
+    snippet: { name: 'white on dark gray', style: 'normal', value: COLORS.CODE_FG },
+    space: { name: 'blue', style: 'normal', value: COLORS.BLUE },
     success: { name: 'green', style: 'normal', value: COLORS.GREEN },
-    team: { name: 'cyan', style: 'bold', value: COLORS.CYAN },
+    team: { name: 'light cyan', style: 'normal', value: COLORS.CYAN_LIGHT },
     user: { name: 'cyan', style: 'normal', value: COLORS.CYAN },
     warning: { name: 'orange', style: 'normal', value: COLORS.ORANGE },
 };

package/dist/ux/confirm-command.d.ts

@@ -0,0 +1,38 @@
+import { prompt } from './prompt.js';
+type ConfirmCommandOptions = {
+    abortedMessage?: string;
+    comparison: string;
+    confirmation?: string;
+    promptFunction?: typeof prompt;
+    warningMessage?: string;
+};
+/**
+ * @description Prompts the user to confirm a destructive action by typing a comparison string, or validates a
+ * pre-provided confirmation.
+ * @param options - Configuration options for the confirmation command.
+ * @param options.abortedMessage - Custom message to display when the action is aborted (default: 'Aborted.').
+ * @param options.comparison - The string that must be entered to confirm the action (required). Typically the app name,
+ * but can be other identifiers like a Private Space name.
+ * @param options.confirmation - Pre-provided confirmation string to validate without prompting (optional). If provided
+ * and matches comparison, returns immediately without prompting.
+ * @param options.promptFunction - Function to use for prompting (default: prompt, used for dependency injection in tests).
+ * @param options.warningMessage - Custom warning message to display before prompting (optional). Default message assumes
+ * comparison is an app name. Provide a custom message if using a different identifier.
+ * @returns Promise that resolves if confirmation matches, or throws an error if it doesn't.
+ * @throws {Error} When confirmation doesn't match the comparison string.
+ * @example
+ *   // Interactive prompt
+ *   await confirmCommand({comparison: 'my-app'})
+ *
+ *   // Pre-provided confirmation (no prompt)
+ *   await confirmCommand({comparison: 'my-app', confirmation: 'my-app'})
+ *
+ *   // Custom messages
+ *   await confirmCommand({
+ *     comparison: 'my-app',
+ *     warningMessage: 'This will delete your database',
+ *     abortedMessage: 'Database deletion cancelled.'
+ *   })
+ */
+export declare function confirmCommand({ abortedMessage, comparison, confirmation, promptFunction, warningMessage, }: ConfirmCommandOptions): Promise<void>;
+export {};

package/dist/ux/confirm-command.js

@@ -0,0 +1,56 @@
+import { ux } from '@oclif/core';
+import tsheredoc from 'tsheredoc';
+import * as color from './colors.js';
+import { prompt } from './prompt.js';
+/**
+ * @description Prompts the user to confirm a destructive action by typing a comparison string, or validates a
+ * pre-provided confirmation.
+ * @param options - Configuration options for the confirmation command.
+ * @param options.abortedMessage - Custom message to display when the action is aborted (default: 'Aborted.').
+ * @param options.comparison - The string that must be entered to confirm the action (required). Typically the app name,
+ * but can be other identifiers like a Private Space name.
+ * @param options.confirmation - Pre-provided confirmation string to validate without prompting (optional). If provided
+ * and matches comparison, returns immediately without prompting.
+ * @param options.promptFunction - Function to use for prompting (default: prompt, used for dependency injection in tests).
+ * @param options.warningMessage - Custom warning message to display before prompting (optional). Default message assumes
+ * comparison is an app name. Provide a custom message if using a different identifier.
+ * @returns Promise that resolves if confirmation matches, or throws an error if it doesn't.
+ * @throws {Error} When confirmation doesn't match the comparison string.
+ * @example
+ *   // Interactive prompt
+ *   await confirmCommand({comparison: 'my-app'})
+ *
+ *   // Pre-provided confirmation (no prompt)
+ *   await confirmCommand({comparison: 'my-app', confirmation: 'my-app'})
+ *
+ *   // Custom messages
+ *   await confirmCommand({
+ *     comparison: 'my-app',
+ *     warningMessage: 'This will delete your database',
+ *     abortedMessage: 'Database deletion cancelled.'
+ *   })
+ */
+export async function confirmCommand({ abortedMessage, comparison, confirmation, promptFunction = prompt, warningMessage, }) {
+    const heredoc = tsheredoc.default;
+    if (!abortedMessage) {
+        abortedMessage = 'Aborted.';
+    }
+    if (confirmation) {
+        if (confirmation === comparison)
+            return;
+        throw new Error(`Confirmation ${color.bold.red(confirmation)} did not match ${color.bold.red(comparison)}. ${abortedMessage}`);
+    }
+    if (!warningMessage) {
+        warningMessage = heredoc `
+      Destructive Action
+      This command will affect the app ${color.bold.red(comparison)}
+    `;
+    }
+    ux.warn(warningMessage);
+    process.stderr.write('\n');
+    const entered = await promptFunction(`To proceed, type ${color.bold.red(comparison)} or re-run this command with ${color.bold.red(`--confirm ${comparison}`)}`, { required: true });
+    if (entered === comparison) {
+        return;
+    }
+    throw new Error(`Confirmation did not match ${color.bold.red(comparison)}. ${abortedMessage}`);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@heroku/heroku-cli-util",
-  "version": "10.4.0-beta.0",
+  "version": "10.4.0",
   "description": "Set of helpful CLI utilities",
   "author": "Heroku",
   "license": "ISC",
@@ -38,13 +38,11 @@
     "mock-stdin": "^1.0.0",
     "nock": "^13.2.9",
     "open": "^11",
-    "printf": "^0.6.1",
     "sinon": "^18.0.1",
     "sinon-chai": "^3.7.0",
     "tmp": "^0.2.5",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
-    "tsheredoc": "^1.0.1",
     "typescript": "^5.4.0"
   },
   "dependencies": {
@@ -55,6 +53,8 @@
     "ansis": "^4.1.0",
     "debug": "^4.4.0",
     "inquirer": "^12.6.1",
+    "printf": "^0.6.1",
+    "tsheredoc": "^1.0.1",
     "tunnel-ssh": "5.2.0"
   },
   "engines": {