@topcli/prompts 1.4.0 → 1.5.0

package/README.md

@@ -51,6 +51,7 @@ question(message: string, options?: PromptOptions): Promise<string>
 ```
 
 Simple prompt, similar to `rl.question()` with an improved UI.
+Use `options.secure` if you need to hide both input and answer.
 Use `options.validators` to handle user input.
 
 **Example**
@@ -156,6 +157,7 @@ export interface Validator {
 export interface QuestionOptions extends SharedOptions {
   defaultValue?: string;
   validators?: Validator[];
+  secure?: boolean;
 }
 
 export interface Choice {

package/index.d.ts

@@ -15,6 +15,7 @@ export interface Validator {
 export interface QuestionOptions extends SharedOptions {
   defaultValue?: string;
   validators?: Validator[];
+  secure?: boolean;
 }
 
 export interface Choice {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@topcli/prompts",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Node.js user input library for command-line interfaces.",
   "scripts": {
     "test": "node --no-warnings=ExperimentalWarning --loader=esmock --test test/",
@@ -24,10 +24,10 @@
   "type": "module",
   "devDependencies": {
     "@nodesecure/eslint-config": "^1.8.0",
-    "@types/node": "^20.8.2",
+    "@types/node": "^20.8.5",
     "c8": "^8.0.1",
-    "eslint": "^8.50.0",
-    "esmock": "^2.5.1"
+    "eslint": "^8.51.0",
+    "esmock": "^2.5.2"
   },
   "dependencies": {
     "is-unicode-supported": "^1.3.0",

package/src/abstract-prompt.js

@@ -1,6 +1,7 @@
 // Import Node.js Dependencies
 import { EOL } from "node:os";
 import { createInterface } from "node:readline";
+import { Writable } from "node:stream";
 
 // Import Third-party Dependencies
 import stripAnsi from "strip-ansi";
@@ -23,11 +24,23 @@ export class AbstractPrompt {
     this.message = message;
     this.history = [];
     this.agent = PromptAgent.agent();
+    this.mute = false;
 
     if (this.stdout.isTTY) {
       this.stdin.setRawMode(true);
     }
-    this.rl = createInterface({ input, output });
+    this.rl = createInterface({
+      input,
+      output: new Writable({
+        write: (chunk, encoding, callback) => {
+          if (!this.mute) {
+            this.stdout.write(chunk, encoding);
+          }
+          callback();
+        }
+      }),
+      terminal: true
+    });
   }
 
   write(data) {

package/src/question-prompt.js

@@ -10,13 +10,15 @@ import { SYMBOLS } from "./constants.js";
 
 export class QuestionPrompt extends AbstractPrompt {
   #validators;
+  #secure;
 
   constructor(message, options = {}) {
     const {
       stdin = process.stdin,
       stdout = process.stdout,
       defaultValue,
-      validators = []
+      validators = [],
+      secure = false
     } = options;
 
     super(message, stdin, stdout);
@@ -28,6 +30,7 @@ export class QuestionPrompt extends AbstractPrompt {
     this.defaultValue = defaultValue;
     this.tip = this.defaultValue ? ` (${this.defaultValue})` : "";
     this.#validators = validators;
+    this.#secure = Boolean(secure);
     this.questionSuffixError = "";
   }
 
@@ -37,9 +40,11 @@ export class QuestionPrompt extends AbstractPrompt {
 
       this.rl.question(questionQuery, (answer) => {
         this.history.push(questionQuery + answer);
+        this.mute = false;
 
         resolve(answer);
       });
+      this.mute = this.#secure;
     });
   }
 
@@ -54,8 +59,7 @@ export class QuestionPrompt extends AbstractPrompt {
 
   #writeAnswer() {
     const prefix = this.answer ? SYMBOLS.Tick : SYMBOLS.Cross;
-    const answer = kleur.yellow(this.answer ?? "");
-
+    const answer = kleur.yellow(this.#secure ? "CONFIDENTIAL" : this.answer ?? "");
     this.write(`${prefix} ${kleur.bold(this.message)} ${SYMBOLS.Pointer} ${answer}${EOL}`);
   }