@topcli/prompts 1.9.0 → 1.10.1

package/dist/index.js

@@ -7,6 +7,7 @@ import wcwidth from "@topcli/wcwidth";
 import { EOL } from "os";
 import { createInterface } from "readline";
 import { Writable } from "stream";
+import EventEmitter from "events";
 
 // src/utils.ts
 import process2 from "process";
@@ -72,25 +73,49 @@ var PromptAgent = class _PromptAgent {
   }
 };
 
+// src/errors/abort.ts
+var AbortError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "AbortError";
+  }
+};
+
 // src/prompts/abstract.ts
-var AbstractPrompt = class _AbstractPrompt {
+var AbstractPrompt = class _AbstractPrompt extends EventEmitter {
   stdin;
   stdout;
   message;
+  signal;
   history;
   agent;
   mute;
   rl;
-  constructor(message, input = process.stdin, output = process.stdout) {
+  #signalHandler;
+  constructor(options) {
+    super();
     if (this.constructor === _AbstractPrompt) {
       throw new Error("AbstractPrompt can't be instantiated.");
     }
+    const {
+      stdin: input = process.stdin,
+      stdout: output = process.stdout,
+      message,
+      signal
+    } = options;
     if (typeof message !== "string") {
       throw new TypeError(`message must be string, ${typeof message} given.`);
     }
+    if (!output.isTTY) {
+      Object.assign(output, {
+        moveCursor: () => void 0,
+        clearScreenDown: () => void 0
+      });
+    }
     this.stdin = input;
     this.stdout = output;
     this.message = message;
+    this.signal = signal;
     this.history = [];
     this.agent = PromptAgent.agent();
     this.mute = false;
@@ -101,7 +126,7 @@ var AbstractPrompt = class _AbstractPrompt {
       input,
       output: new Writable({
         write: (chunk, encoding, callback) => {
-          if (!this.mute) {
+          if (!this.mute && chunk) {
             this.stdout.write(chunk, encoding);
           }
           callback();
@@ -109,6 +134,16 @@ var AbstractPrompt = class _AbstractPrompt {
       }),
       terminal: true
     });
+    if (this.signal) {
+      this.#signalHandler = () => {
+        this.rl.close();
+        for (let i = 0; i < this.history.length; i++) {
+          this.clearLastLine();
+        }
+        this.emit("error", new AbortError("Prompt aborted"));
+      };
+      this.signal.addEventListener("abort", this.#signalHandler, { once: true });
+    }
   }
   write(data) {
     const formattedData = stripAnsi(data).replace(EOL, "");
@@ -128,6 +163,9 @@ var AbstractPrompt = class _AbstractPrompt {
   }
   destroy() {
     this.rl.close();
+    if (this.signal) {
+      this.signal.removeEventListener("abort", this.#signalHandler);
+    }
   }
 };
 
@@ -175,15 +213,14 @@ var QuestionPrompt = class extends AbstractPrompt {
   answerBuffer;
   #validators;
   #secure;
-  constructor(message, options = {}) {
+  constructor(options) {
     const {
-      stdin = process.stdin,
-      stdout = process.stdout,
       defaultValue,
       validators = [],
-      secure = false
+      secure = false,
+      ...baseOptions
     } = options;
-    super(message, stdin, stdout);
+    super({ ...baseOptions });
     if (defaultValue && typeof defaultValue !== "string") {
       throw new TypeError("defaultValue must be a string");
     }
@@ -196,6 +233,7 @@ var QuestionPrompt = class extends AbstractPrompt {
   #question() {
     return new Promise((resolve) => {
       const questionQuery = this.#getQuestionQuery();
+      this.history.push(questionQuery);
       this.rl.question(questionQuery, (answer) => {
         this.history.push(questionQuery + answer);
         this.mute = false;
@@ -233,24 +271,30 @@ var QuestionPrompt = class extends AbstractPrompt {
     this.answerBuffer = void 0;
     this.#writeAnswer();
   }
-  async question() {
-    this.answer = this.agent.nextAnswers.shift();
-    if (this.answer !== void 0) {
-      this.#writeAnswer();
-      this.destroy();
-      return this.answer;
-    }
-    this.answer = await this.#question();
-    if (this.answer === "" && this.defaultValue) {
-      this.answer = this.defaultValue;
-    }
-    this.#onQuestionAnswer();
-    while (this.answerBuffer !== void 0) {
-      this.answer = await this.answerBuffer;
+  question() {
+    return new Promise(async (resolve, reject) => {
+      this.answer = this.agent.nextAnswers.shift();
+      if (this.answer !== void 0) {
+        this.#writeAnswer();
+        this.destroy();
+        resolve(this.answer);
+        return;
+      }
+      this.once("error", (error) => {
+        reject(error);
+      });
+      this.answer = await this.#question();
+      if (this.answer === "" && this.defaultValue) {
+        this.answer = this.defaultValue;
+      }
       this.#onQuestionAnswer();
-    }
-    this.destroy();
-    return this.answer;
+      while (this.answerBuffer !== void 0) {
+        this.answer = await this.answerBuffer;
+        this.#onQuestionAnswer();
+      }
+      this.destroy();
+      resolve(this.answer);
+    });
   }
 };
 
@@ -277,13 +321,12 @@ var ConfirmPrompt = class extends AbstractPrompt {
   fastAnswer;
   #boundKeyPressEvent;
   #boundExitEvent;
-  constructor(message, options = {}) {
+  constructor(options) {
     const {
-      stdin = process.stdin,
-      stdout = process.stdout,
-      initial = false
+      initial = false,
+      ...baseOptions
     } = options;
-    super(message, stdin, stdout);
+    super({ ...baseOptions });
     this.initial = initial;
     this.selectedValue = initial;
   }
@@ -347,25 +390,31 @@ var ConfirmPrompt = class extends AbstractPrompt {
     this.stdout.clearScreenDown();
     this.write(`${this.selectedValue ? SYMBOLS.Tick : SYMBOLS.Cross} ${kleur3.bold(this.message)}${EOL3}`);
   }
-  async confirm() {
-    const answer = this.agent.nextAnswers.shift();
-    if (answer !== void 0) {
-      this.selectedValue = answer;
-      this.#onQuestionAnswer();
-      this.destroy();
-      return answer;
-    }
-    this.write(SYMBOLS.HideCursor);
-    try {
-      await this.#question();
-      this.#onQuestionAnswer();
-      return this.selectedValue;
-    } finally {
-      this.write(SYMBOLS.ShowCursor);
-      this.#onProcessExit();
-      process.off("exit", this.#boundExitEvent);
-      this.destroy();
-    }
+  confirm() {
+    return new Promise(async (resolve, reject) => {
+      const answer = this.agent.nextAnswers.shift();
+      if (answer !== void 0) {
+        this.selectedValue = answer;
+        this.#onQuestionAnswer();
+        this.destroy();
+        resolve(answer);
+        return;
+      }
+      this.once("error", (error) => {
+        reject(error);
+      });
+      this.write(SYMBOLS.HideCursor);
+      try {
+        await this.#question();
+        this.#onQuestionAnswer();
+        resolve(this.selectedValue);
+      } finally {
+        this.write(SYMBOLS.ShowCursor);
+        this.#onProcessExit();
+        process.off("exit", this.#boundExitEvent);
+        this.destroy();
+      }
+    });
   }
 };
 
@@ -377,6 +426,7 @@ var kRequiredChoiceProperties = ["label", "value"];
 var SelectPrompt = class extends AbstractPrompt {
   #boundExitEvent = () => void 0;
   #boundKeyPressEvent = () => void 0;
+  #validators;
   activeIndex = 0;
   questionMessage;
   autocompleteValue = "";
@@ -414,22 +464,19 @@ var SelectPrompt = class extends AbstractPrompt {
       return choice.label.length;
     }));
   }
-  constructor(message, options) {
+  constructor(options) {
     const {
-      stdin = process.stdin,
-      stdout = process.stdout,
-      choices
-    } = options ?? {};
-    super(message, stdin, stdout);
-    if (!options) {
-      this.destroy();
-      throw new TypeError("Missing required options");
-    }
+      choices,
+      validators = [],
+      ...baseOptions
+    } = options;
+    super({ ...baseOptions });
     this.options = options;
     if (!choices?.length) {
       this.destroy();
       throw new TypeError("Missing required param: choices");
     }
+    this.#validators = validators;
     for (const choice of choices) {
       if (typeof choice === "string") {
         continue;
@@ -509,6 +556,13 @@ var SelectPrompt = class extends AbstractPrompt {
       const choice = this.filteredChoices[this.activeIndex] || "";
       const label = typeof choice === "string" ? choice : choice.label;
       const value = typeof choice === "string" ? choice : choice.value;
+      for (const validator of this.#validators) {
+        if (!validator.validate(value)) {
+          const error = validator.error(value);
+          render({ error });
+          return;
+        }
+      }
       render({ clearRender: true });
       if (!this.options.ignoreValues?.includes(value)) {
         this.#showAnsweredQuestion(label);
@@ -530,56 +584,71 @@ var SelectPrompt = class extends AbstractPrompt {
       render();
     }
   }
-  async select() {
-    const answer = this.agent.nextAnswers.shift();
-    if (answer !== void 0) {
-      this.#showAnsweredQuestion(answer);
-      this.destroy();
-      return answer;
-    }
-    this.write(SYMBOLS.HideCursor);
-    this.#showQuestion();
-    const render = (options = {}) => {
-      const {
-        initialRender = false,
-        clearRender = false
-      } = options;
-      if (!initialRender) {
-        let linesToClear = this.lastRender.endIndex - this.lastRender.startIndex;
-        while (linesToClear > 0) {
-          this.clearLastLine();
-          linesToClear--;
-        }
-        if (this.options.autocomplete) {
-          let linesToClear2 = Math.ceil(
-            wcwidth3(`${SYMBOLS.Pointer} ${this.autocompleteValue}`) / this.stdout.columns
-          );
-          while (linesToClear2 > 0) {
+  select() {
+    return new Promise((resolve, reject) => {
+      const answer = this.agent.nextAnswers.shift();
+      if (answer !== void 0) {
+        this.#showAnsweredQuestion(answer);
+        this.destroy();
+        resolve(answer);
+        return;
+      }
+      this.once("error", (error) => {
+        reject(error);
+      });
+      this.write(SYMBOLS.HideCursor);
+      this.#showQuestion();
+      const render = (options = {}) => {
+        const {
+          initialRender = false,
+          clearRender = false,
+          error = null
+        } = options;
+        if (!initialRender) {
+          let linesToClear = this.lastRender.endIndex - this.lastRender.startIndex;
+          while (linesToClear > 0) {
             this.clearLastLine();
-            linesToClear2--;
+            linesToClear--;
+          }
+          if (this.options.autocomplete) {
+            let linesToClear2 = Math.ceil(
+              wcwidth3(`${SYMBOLS.Pointer} ${this.autocompleteValue}`) / this.stdout.columns
+            );
+            while (linesToClear2 > 0) {
+              this.clearLastLine();
+              linesToClear2--;
+            }
           }
         }
-      }
-      if (clearRender) {
-        const questionLineCount = Math.ceil(
-          wcwidth3(stripAnsi(this.questionMessage)) / this.stdout.columns
-        );
-        this.stdout.moveCursor(-this.stdout.columns, -(1 + questionLineCount));
-        this.stdout.clearScreenDown();
-        return;
-      }
-      this.#showChoices();
-    };
-    render({ initialRender: true });
-    return new Promise((resolve) => {
+        if (clearRender) {
+          const questionLineCount = Math.ceil(
+            wcwidth3(stripAnsi(this.questionMessage)) / this.stdout.columns
+          );
+          this.stdout.moveCursor(-this.stdout.columns, -(1 + questionLineCount));
+          this.stdout.clearScreenDown();
+          return;
+        }
+        if (error) {
+          const linesToClear = Math.ceil(wcwidth3(this.questionMessage) / this.stdout.columns) + 1;
+          this.stdout.moveCursor(0, -linesToClear);
+          this.stdout.clearScreenDown();
+          this.#showQuestion(error);
+        }
+        this.#showChoices();
+      };
+      render({ initialRender: true });
       this.#boundKeyPressEvent = this.#onKeypress.bind(this, resolve, render);
       this.stdin.on("keypress", this.#boundKeyPressEvent);
       this.#boundExitEvent = this.#onProcessExit.bind(this);
       process.once("exit", this.#boundExitEvent);
     });
   }
-  #showQuestion() {
-    this.questionMessage = `${SYMBOLS.QuestionMark} ${kleur4.bold(this.message)}`;
+  #showQuestion(error = null) {
+    let hint = "";
+    if (error) {
+      hint = ` ${hint.length > 0 ? " " : ""}${kleur4.red().bold(`[${error}]`)}`;
+    }
+    this.questionMessage = `${SYMBOLS.QuestionMark} ${kleur4.bold(this.message)}${hint}`;
     this.write(`${this.questionMessage}${EOL4}`);
   }
 };
@@ -595,7 +664,7 @@ var MultiselectPrompt = class extends AbstractPrompt {
   #validators;
   #showHint;
   activeIndex = 0;
-  selectedIndexes = [];
+  selectedIndexes = /* @__PURE__ */ new Set();
   questionMessage;
   autocompleteValue = "";
   options;
@@ -632,20 +701,15 @@ var MultiselectPrompt = class extends AbstractPrompt {
       return choice.label.length;
     }));
   }
-  constructor(message, options) {
+  constructor(options) {
     const {
-      stdin = process.stdin,
-      stdout = process.stdout,
       choices,
       preSelectedChoices,
       validators = [],
-      showHint = true
-    } = options ?? {};
-    super(message, stdin, stdout);
-    if (!options) {
-      this.destroy();
-      throw new TypeError("Missing required options");
-    }
+      showHint = true,
+      ...baseOptions
+    } = options;
+    super({ ...baseOptions });
     this.options = options;
     if (!choices?.length) {
       this.destroy();
@@ -678,7 +742,7 @@ var MultiselectPrompt = class extends AbstractPrompt {
         this.destroy();
         throw new Error(`Invalid pre-selected choice: ${typeof choice === "string" ? choice : choice.value}`);
       }
-      this.selectedIndexes.push(choiceIndex);
+      this.selectedIndexes.add(choiceIndex);
     }
   }
   #getFormattedChoice(choiceIndex) {
@@ -706,7 +770,7 @@ var MultiselectPrompt = class extends AbstractPrompt {
     for (let choiceIndex = startIndex; choiceIndex < endIndex; choiceIndex++) {
       const choice = this.#getFormattedChoice(choiceIndex);
       const isChoiceActive = choiceIndex === this.activeIndex;
-      const isChoiceSelected = this.selectedIndexes.includes(choiceIndex);
+      const isChoiceSelected = this.selectedIndexes.has(choiceIndex);
       const showPreviousChoicesArrow = startIndex > 0 && choiceIndex === startIndex;
       const showNextChoicesArrow = endIndex < this.filteredChoices.length && choiceIndex === endIndex - 1;
       let prefixArrow = "  ";
@@ -726,7 +790,7 @@ var MultiselectPrompt = class extends AbstractPrompt {
     }
   }
   #showAnsweredQuestion(choices, isAgentAnswer = false) {
-    const prefixSymbol = this.selectedIndexes.length === 0 && !isAgentAnswer ? SYMBOLS.Cross : SYMBOLS.Tick;
+    const prefixSymbol = this.selectedIndexes.size === 0 && !isAgentAnswer ? SYMBOLS.Cross : SYMBOLS.Tick;
     const prefix = `${prefixSymbol} ${kleur5.bold(this.message)} ${SYMBOLS.Pointer}`;
     const formattedChoice = kleur5.yellow(choices);
     this.write(`${prefix}${choices ? ` ${formattedChoice}` : ""}${EOL5}`);
@@ -746,20 +810,20 @@ var MultiselectPrompt = class extends AbstractPrompt {
       this.activeIndex = this.activeIndex === this.filteredChoices.length - 1 ? 0 : this.activeIndex + 1;
       render();
     } else if (key.ctrl && key.name === "a") {
-      this.selectedIndexes = this.selectedIndexes.length === this.filteredChoices.length ? [] : this.filteredChoices.map((_, index) => index);
+      this.selectedIndexes = this.selectedIndexes.size === this.filteredChoices.length ? /* @__PURE__ */ new Set() : new Set(this.filteredChoices.map((_, index) => index));
       render();
     } else if (key.name === "right") {
-      this.selectedIndexes.push(this.activeIndex);
+      this.selectedIndexes.add(this.activeIndex);
       render();
     } else if (key.name === "left") {
-      this.selectedIndexes = this.selectedIndexes.filter((index) => index !== this.activeIndex);
+      this.selectedIndexes = new Set([...this.selectedIndexes].filter((index) => index !== this.activeIndex));
       render();
     } else if (key.name === "return") {
-      const labels = this.selectedIndexes.map((index) => {
+      const labels = [...this.selectedIndexes].map((index) => {
         const choice = this.filteredChoices[index];
         return typeof choice === "string" ? choice : choice.label;
       });
-      const values = this.selectedIndexes.map((index) => {
+      const values = [...this.selectedIndexes].map((index) => {
         const choice = this.filteredChoices[index];
         return typeof choice === "string" ? choice : choice.value;
       });
@@ -779,7 +843,7 @@ var MultiselectPrompt = class extends AbstractPrompt {
       resolve(values);
     } else {
       if (!key.ctrl && this.options.autocomplete) {
-        this.selectedIndexes = [];
+        this.selectedIndexes.clear();
         this.activeIndex = 0;
         if (key.name === "backspace" && this.autocompleteValue.length > 0) {
           this.autocompleteValue = this.autocompleteValue.slice(0, -1);
@@ -790,56 +854,60 @@ var MultiselectPrompt = class extends AbstractPrompt {
       render();
     }
   }
-  async multiselect() {
-    const answer = this.agent.nextAnswers.shift();
-    if (answer !== void 0) {
-      const formatedAnser = Array.isArray(answer) ? answer.join(", ") : answer;
-      this.#showAnsweredQuestion(formatedAnser, true);
-      this.destroy();
-      return Array.isArray(answer) ? answer : [answer];
-    }
-    this.write(SYMBOLS.HideCursor);
-    this.#showQuestion();
-    const render = (options = {}) => {
-      const {
-        initialRender = false,
-        clearRender = false,
-        error = null
-      } = options;
-      if (!initialRender) {
-        let linesToClear = this.lastRender.endIndex - this.lastRender.startIndex;
-        while (linesToClear > 0) {
-          this.clearLastLine();
-          linesToClear--;
-        }
-        if (this.options.autocomplete) {
-          let linesToClear2 = Math.ceil(
-            wcwidth4(`${SYMBOLS.Pointer} ${this.autocompleteValue}`) / this.stdout.columns
-          );
-          while (linesToClear2 > 0) {
+  multiselect() {
+    return new Promise((resolve, reject) => {
+      const answer = this.agent.nextAnswers.shift();
+      if (answer !== void 0) {
+        const formatedAnser = Array.isArray(answer) ? answer.join(", ") : answer;
+        this.#showAnsweredQuestion(formatedAnser, true);
+        this.destroy();
+        resolve(Array.isArray(answer) ? answer : [answer]);
+        return;
+      }
+      this.once("error", (error) => {
+        reject(error);
+      });
+      this.write(SYMBOLS.HideCursor);
+      this.#showQuestion();
+      const render = (options = {}) => {
+        const {
+          initialRender = false,
+          clearRender = false,
+          error = null
+        } = options;
+        if (!initialRender) {
+          let linesToClear = this.lastRender.endIndex - this.lastRender.startIndex;
+          while (linesToClear > 0) {
             this.clearLastLine();
-            linesToClear2--;
+            linesToClear--;
+          }
+          if (this.options.autocomplete) {
+            let linesToClear2 = Math.ceil(
+              wcwidth4(`${SYMBOLS.Pointer} ${this.autocompleteValue}`) / this.stdout.columns
+            );
+            while (linesToClear2 > 0) {
+              this.clearLastLine();
+              linesToClear2--;
+            }
           }
         }
-      }
-      if (clearRender) {
-        const questionLineCount = Math.ceil(
-          wcwidth4(stripAnsi(this.questionMessage)) / this.stdout.columns
-        );
-        this.stdout.moveCursor(-this.stdout.columns, -(1 + questionLineCount));
-        this.stdout.clearScreenDown();
-        return;
-      }
-      if (error) {
-        const linesToClear = Math.ceil(wcwidth4(this.questionMessage) / this.stdout.columns) + 1;
-        this.stdout.moveCursor(0, -linesToClear);
-        this.stdout.clearScreenDown();
-        this.#showQuestion(error);
-      }
-      this.#showChoices();
-    };
-    render({ initialRender: true });
-    return new Promise((resolve) => {
+        if (clearRender) {
+          const questionLineCount = Math.ceil(
+            wcwidth4(stripAnsi(this.questionMessage)) / this.stdout.columns
+          );
+          this.stdout.moveCursor(-this.stdout.columns, -(1 + questionLineCount));
+          this.stdout.clearScreenDown();
+          return;
+        }
+        if (error) {
+          const linesToClear = Math.ceil(wcwidth4(this.questionMessage) / this.stdout.columns) + 1;
+          this.stdout.moveCursor(0, -linesToClear);
+          this.stdout.clearScreenDown();
+          this.#showQuestion(error);
+        }
+        this.#showChoices();
+      };
+      render({ initialRender: true });
       this.#boundKeyPressEvent = this.#onKeypress.bind(this, resolve, render);
       this.stdin.on("keypress", this.#boundKeyPressEvent);
       this.#boundExitEvent = this.#onProcessExit.bind(this);
@@ -869,19 +937,18 @@ function required() {
 
 // index.ts
 async function question(message, options = {}) {
-  const questionPrompt = new QuestionPrompt(message, options);
-  return questionPrompt.question();
+  return new QuestionPrompt({ ...options, message }).question();
 }
 async function select(message, options) {
-  const selectPrompt = new SelectPrompt(message, options);
+  const selectPrompt = new SelectPrompt({ ...options, message });
   return selectPrompt.select();
 }
 async function confirm(message, options) {
-  const confirmPrompt = new ConfirmPrompt(message, options);
+  const confirmPrompt = new ConfirmPrompt({ ...options, message });
   return confirmPrompt.confirm();
 }
 async function multiselect(message, options) {
-  const multiselectPrompt = new MultiselectPrompt(message, options);
+  const multiselectPrompt = new MultiselectPrompt({ ...options, message });
   return multiselectPrompt.multiselect();
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@topcli/prompts",
-  "version": "1.9.0",
+  "version": "1.10.1",
   "description": "Node.js user input library for command-line interfaces.",
   "scripts": {
     "build": "tsup index.ts --format cjs,esm --dts --clean",
@@ -34,7 +34,7 @@
     "@nodesecure/eslint-config": "^1.9.0",
     "@types/node": "^20.11.6",
     "c8": "^9.1.0",
-    "eslint": "^8.56.0",
+    "eslint": "^9.2.0",
     "esmock": "^2.6.3",
     "glob": "^10.3.10",
     "tsup": "^8.0.1",