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

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/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-beta.1",
   "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": {