@topcli/prompts 2.3.0 → 2.4.0

package/README.md

@@ -55,7 +55,7 @@ Simple prompt, similar to `rl.question()` with an improved UI.
 
 Use `options.defaultValue` to set a default value.
 
-Use `options.secure` if you need to hide both input and answer.
+Use `options.secure` if you need to hide both input and answer. You can provide either a **boolean** or an **object** which allows to configure a `placeholder` such as `*`.
 
 Use `options.signal` to set an `AbortSignal` (throws a [AbortError](#aborterror)).
 

package/dist/index.cjs

@@ -102,6 +102,9 @@ var AbortError = class extends Error {
 };
 
 // src/prompts/abstract.ts
+function kNoopTransformer(input) {
+  return input;
+}
 var AbstractPrompt = class _AbstractPrompt extends import_node_events.default {
   stdin;
   stdout;
@@ -110,7 +113,7 @@ var AbstractPrompt = class _AbstractPrompt extends import_node_events.default {
   skip;
   history;
   agent;
-  mute;
+  transformer = kNoopTransformer;
   rl;
   #signalHandler;
   constructor(options) {
@@ -141,7 +144,6 @@ var AbstractPrompt = class _AbstractPrompt extends import_node_events.default {
     this.skip = skip;
     this.history = [];
     this.agent = PromptAgent.agent();
-    this.mute = false;
     if (this.stdout.isTTY) {
       this.stdin.setRawMode(true);
     }
@@ -149,8 +151,13 @@ var AbstractPrompt = class _AbstractPrompt extends import_node_events.default {
       input,
       output: new import_node_stream.Writable({
         write: (chunk, encoding, callback) => {
-          if (!this.mute && chunk) {
-            this.stdout.write(chunk, encoding);
+          if (chunk) {
+            const transformed = this.transformer(
+              Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk)
+            );
+            if (transformed !== null) {
+              this.stdout.write(transformed, encoding);
+            }
           }
           callback();
         }
@@ -171,6 +178,9 @@ var AbstractPrompt = class _AbstractPrompt extends import_node_events.default {
       this.signal.addEventListener("abort", this.#signalHandler, { once: true });
     }
   }
+  reset() {
+    this.transformer = kNoopTransformer;
+  }
   write(data) {
     const formattedData = (0, import_node_util.stripVTControlCharacters)(data).replace(import_node_os.EOL, "");
     if (formattedData) {
@@ -287,6 +297,7 @@ var QuestionPrompt = class extends AbstractPrompt {
   answerBuffer;
   #validators;
   #secure;
+  #securePlaceholder = null;
   constructor(options) {
     const {
       defaultValue,
@@ -301,7 +312,12 @@ var QuestionPrompt = class extends AbstractPrompt {
     this.defaultValue = defaultValue;
     this.tip = this.defaultValue ? ` (${this.defaultValue})` : "";
     this.#validators = validators;
-    this.#secure = Boolean(secure);
+    if (typeof secure === "object") {
+      this.#secure = true;
+      this.#securePlaceholder = secure.placeholder;
+    } else {
+      this.#secure = Boolean(secure);
+    }
     this.questionSuffixError = "";
   }
   #question() {
@@ -310,10 +326,12 @@ var QuestionPrompt = class extends AbstractPrompt {
       this.history.push(questionQuery);
       this.rl.question(questionQuery, (answer) => {
         this.history.push(questionQuery + answer);
-        this.mute = false;
+        this.reset();
         resolve(answer);
       });
-      this.mute = this.#secure;
+      if (this.#securePlaceholder !== null) {
+        this.transformer = (input) => Buffer.from(this.#securePlaceholder.repeat(input.length), "utf-8");
+      }
     });
   }
   #getQuestionQuery() {
@@ -325,8 +343,13 @@ var QuestionPrompt = class extends AbstractPrompt {
   }
   #writeAnswer() {
     const prefix = this.answer ? SYMBOLS.Tick : SYMBOLS.Cross;
-    const answer = (0, import_node_util4.styleText)("yellow", this.#secure ? "CONFIDENTIAL" : this.answer ?? "");
-    this.write(`${prefix} ${(0, import_node_util4.styleText)("bold", this.message)} ${SYMBOLS.Pointer} ${answer}${import_node_os2.EOL}`);
+    const answer = this.answer ?? "";
+    const maskedAnswer = this.#securePlaceholder ? this.#securePlaceholder.repeat(answer.length) : answer;
+    const stylizedAnswer = (0, import_node_util4.styleText)(
+      "yellow",
+      this.#secure && this.#securePlaceholder === null ? "CONFIDENTIAL" : maskedAnswer
+    );
+    this.write(`${prefix} ${(0, import_node_util4.styleText)("bold", this.message)} ${SYMBOLS.Pointer} ${stylizedAnswer}${import_node_os2.EOL}`);
   }
   #onQuestionAnswer() {
     const questionLineCount = Math.ceil(

package/dist/index.d.cts

@@ -62,7 +62,9 @@ interface Choice<T = any> {
 interface QuestionOptions extends AbstractPromptOptions {
     defaultValue?: string;
     validators?: PromptValidator[];
-    secure?: boolean;
+    secure?: boolean | {
+        placeholder: string;
+    };
 }
 
 interface ConfirmOptions extends AbstractPromptOptions {

package/dist/index.d.ts

@@ -62,7 +62,9 @@ interface Choice<T = any> {
 interface QuestionOptions extends AbstractPromptOptions {
     defaultValue?: string;
     validators?: PromptValidator[];
-    secure?: boolean;
+    secure?: boolean | {
+        placeholder: string;
+    };
 }
 
 interface ConfirmOptions extends AbstractPromptOptions {

package/dist/index.js

@@ -61,6 +61,9 @@ var AbortError = class extends Error {
 };
 
 // src/prompts/abstract.ts
+function kNoopTransformer(input) {
+  return input;
+}
 var AbstractPrompt = class _AbstractPrompt extends EventEmitter {
   stdin;
   stdout;
@@ -69,7 +72,7 @@ var AbstractPrompt = class _AbstractPrompt extends EventEmitter {
   skip;
   history;
   agent;
-  mute;
+  transformer = kNoopTransformer;
   rl;
   #signalHandler;
   constructor(options) {
@@ -100,7 +103,6 @@ var AbstractPrompt = class _AbstractPrompt extends EventEmitter {
     this.skip = skip;
     this.history = [];
     this.agent = PromptAgent.agent();
-    this.mute = false;
     if (this.stdout.isTTY) {
       this.stdin.setRawMode(true);
     }
@@ -108,8 +110,13 @@ var AbstractPrompt = class _AbstractPrompt extends EventEmitter {
       input,
       output: new Writable({
         write: (chunk, encoding, callback) => {
-          if (!this.mute && chunk) {
-            this.stdout.write(chunk, encoding);
+          if (chunk) {
+            const transformed = this.transformer(
+              Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk)
+            );
+            if (transformed !== null) {
+              this.stdout.write(transformed, encoding);
+            }
           }
           callback();
         }
@@ -130,6 +137,9 @@ var AbstractPrompt = class _AbstractPrompt extends EventEmitter {
       this.signal.addEventListener("abort", this.#signalHandler, { once: true });
     }
   }
+  reset() {
+    this.transformer = kNoopTransformer;
+  }
   write(data) {
     const formattedData = stripVTControlCharacters(data).replace(EOL, "");
     if (formattedData) {
@@ -246,6 +256,7 @@ var QuestionPrompt = class extends AbstractPrompt {
   answerBuffer;
   #validators;
   #secure;
+  #securePlaceholder = null;
   constructor(options) {
     const {
       defaultValue,
@@ -260,7 +271,12 @@ var QuestionPrompt = class extends AbstractPrompt {
     this.defaultValue = defaultValue;
     this.tip = this.defaultValue ? ` (${this.defaultValue})` : "";
     this.#validators = validators;
-    this.#secure = Boolean(secure);
+    if (typeof secure === "object") {
+      this.#secure = true;
+      this.#securePlaceholder = secure.placeholder;
+    } else {
+      this.#secure = Boolean(secure);
+    }
     this.questionSuffixError = "";
   }
   #question() {
@@ -269,10 +285,12 @@ var QuestionPrompt = class extends AbstractPrompt {
       this.history.push(questionQuery);
       this.rl.question(questionQuery, (answer) => {
         this.history.push(questionQuery + answer);
-        this.mute = false;
+        this.reset();
         resolve(answer);
       });
-      this.mute = this.#secure;
+      if (this.#securePlaceholder !== null) {
+        this.transformer = (input) => Buffer.from(this.#securePlaceholder.repeat(input.length), "utf-8");
+      }
     });
   }
   #getQuestionQuery() {
@@ -284,8 +302,13 @@ var QuestionPrompt = class extends AbstractPrompt {
   }
   #writeAnswer() {
     const prefix = this.answer ? SYMBOLS.Tick : SYMBOLS.Cross;
-    const answer = styleText2("yellow", this.#secure ? "CONFIDENTIAL" : this.answer ?? "");
-    this.write(`${prefix} ${styleText2("bold", this.message)} ${SYMBOLS.Pointer} ${answer}${EOL2}`);
+    const answer = this.answer ?? "";
+    const maskedAnswer = this.#securePlaceholder ? this.#securePlaceholder.repeat(answer.length) : answer;
+    const stylizedAnswer = styleText2(
+      "yellow",
+      this.#secure && this.#securePlaceholder === null ? "CONFIDENTIAL" : maskedAnswer
+    );
+    this.write(`${prefix} ${styleText2("bold", this.message)} ${SYMBOLS.Pointer} ${stylizedAnswer}${EOL2}`);
   }
   #onQuestionAnswer() {
     const questionLineCount = Math.ceil(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@topcli/prompts",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Node.js user input library for command-line interfaces.",
   "scripts": {
     "build": "tsup index.ts --format cjs,esm --dts --clean",