@topcli/prompts 1.6.0 → 1.8.0

package/src/prompts/multiselect.js

@@ -1,333 +0,0 @@
-// Import Node.js Dependencies
-import { EOL } from "node:os";
-
-// Import Third-party Dependencies
-import kleur from "kleur";
-import wcwidth from "@topcli/wcwidth";
-
-// Import Internal Dependencies
-import { AbstractPrompt } from "./abstract.js";
-import { stripAnsi } from "../utils.js";
-import { SYMBOLS } from "../constants.js";
-
-// CONSTANTS
-const kRequiredChoiceProperties = ["label", "value"];
-
-export class MultiselectPrompt extends AbstractPrompt {
-  #boundExitEvent = () => void 0;
-  #boundKeyPressEvent = () => void 0;
-  #validators;
-
-  activeIndex = 0;
-  selectedIndexes = [];
-  questionMessage;
-  autocompleteValue = "";
-
-  get choices() {
-    return this.options.choices;
-  }
-
-  get filteredChoices() {
-    return this.options.autocomplete && this.autocompleteValue.length > 0 ? this.choices.filter((choice) => {
-      if (typeof choice === "string") {
-        if (this.autocompleteValue.includes(" ")) {
-          return this.autocompleteValue.split(" ").every((word) => choice.includes(word)) ||
-          choice.includes(this.autocompleteValue);
-        }
-
-        return choice.includes(this.autocompleteValue);
-      }
-
-      if (this.autocompleteValue.includes(" ")) {
-        return this.autocompleteValue.split(" ").every((word) => choice.label.includes(word)) ||
-        choice.label.includes(this.autocompleteValue);
-      }
-
-      return choice.label.includes(this.autocompleteValue);
-    }) : this.choices;
-  }
-
-  get longestChoice() {
-    return Math.max(...this.filteredChoices.map((choice) => {
-      if (typeof choice === "string") {
-        return choice.length;
-      }
-
-      return choice.label.length;
-    }));
-  }
-
-  constructor(message, options) {
-    const {
-      stdin = process.stdin,
-      stdout = process.stdout,
-      choices,
-      preSelectedChoices,
-      validators = []
-    } = options ?? {};
-
-    super(message, stdin, stdout);
-
-    if (!options) {
-      this.destroy();
-      throw new TypeError("Missing required options");
-    }
-
-    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;
-      }
-
-      for (const prop of kRequiredChoiceProperties) {
-        if (!choice[prop]) {
-          this.destroy();
-          throw new TypeError(`Missing ${prop} for choice ${JSON.stringify(choice)}`);
-        }
-      }
-    }
-
-    if (!preSelectedChoices) {
-      return;
-    }
-
-    for (const choice of preSelectedChoices) {
-      const choiceIndex = this.filteredChoices.findIndex((item) => {
-        if (typeof item === "string") {
-          return item === choice;
-        }
-
-        return item.value === choice;
-      });
-
-      if (choiceIndex === -1) {
-        throw new Error(`Invalid pre-selected choice: ${choice.value ?? choice}`);
-      }
-
-      this.selectedIndexes.push(choiceIndex);
-    }
-  }
-
-  #getFormattedChoice(choiceIndex) {
-    const choice = this.filteredChoices[choiceIndex];
-
-    if (typeof choice === "string") {
-      return { value: choice, label: choice };
-    }
-
-    return choice;
-  }
-
-  #getVisibleChoices() {
-    const maxVisible = this.options.maxVisible || 8;
-    let startIndex = Math.min(this.filteredChoices.length - maxVisible, this.activeIndex - Math.floor(maxVisible / 2));
-    if (startIndex < 0) {
-      startIndex = 0;
-    }
-
-    const endIndex = Math.min(startIndex + maxVisible, this.filteredChoices.length);
-
-    return { startIndex, endIndex };
-  }
-
-  #showChoices() {
-    const { startIndex, endIndex } = this.#getVisibleChoices();
-    this.lastRender = { startIndex, endIndex };
-
-    if (this.options.autocomplete) {
-      this.write(`${SYMBOLS.Pointer} ${this.autocompleteValue}${EOL}`);
-    }
-    for (let choiceIndex = startIndex; choiceIndex < endIndex; choiceIndex++) {
-      const choice = this.#getFormattedChoice(choiceIndex);
-      const isChoiceActive = choiceIndex === this.activeIndex;
-      const isChoiceSelected = this.selectedIndexes.includes(choiceIndex);
-      const showPreviousChoicesArrow = startIndex > 0 && choiceIndex === startIndex;
-      const showNextChoicesArrow = endIndex < this.filteredChoices.length && choiceIndex === endIndex - 1;
-
-      let prefixArrow = "  ";
-      if (showPreviousChoicesArrow) {
-        prefixArrow = SYMBOLS.Previous + " ";
-      }
-      else if (showNextChoicesArrow) {
-        prefixArrow = SYMBOLS.Next + " ";
-      }
-
-      const prefix = `${prefixArrow}${isChoiceSelected ? SYMBOLS.Active : SYMBOLS.Inactive}`;
-      const formattedLabel = choice.label.padEnd(
-        this.longestChoice < 10 ? this.longestChoice : 0
-      );
-      const formattedDescription = choice.description ? ` - ${choice.description}` : "";
-      const color = isChoiceActive ? kleur.white().bold : kleur.gray;
-      const str = `${prefix} ${color(`${formattedLabel}${formattedDescription}`)}${EOL}`;
-
-      this.write(str);
-    }
-  }
-
-  #showAnsweredQuestion(choices, isAgentAnswer = false) {
-    const prefixSymbol = this.selectedIndexes.length === 0 && !isAgentAnswer ? SYMBOLS.Cross : SYMBOLS.Tick;
-    const prefix = `${prefixSymbol} ${kleur.bold(this.message)} ${SYMBOLS.Pointer}`;
-    const formattedChoice = kleur.yellow(choices);
-
-    this.write(`${prefix}${choices ? ` ${formattedChoice}` : ""}${EOL}`);
-  }
-
-  #onProcessExit() {
-    this.stdin.off("keypress", this.#boundKeyPressEvent);
-    this.stdout.moveCursor(-this.stdout.columns, 0);
-    this.stdout.clearScreenDown();
-    this.write(SYMBOLS.ShowCursor);
-  }
-
-  #onKeypress(...args) {
-    const [resolve, render, _, key] = args;
-    if (key.name === "up") {
-      this.activeIndex = this.activeIndex === 0 ? this.filteredChoices.length - 1 : this.activeIndex - 1;
-      render();
-    }
-    else if (key.name === "down") {
-      this.activeIndex = this.activeIndex === this.filteredChoices.length - 1 ? 0 : this.activeIndex + 1;
-      render();
-    }
-    else if (key.ctrl && key.name === "a") {
-      // eslint-disable-next-line max-len
-      this.selectedIndexes = this.selectedIndexes.length === this.filteredChoices.length ? [] : this.filteredChoices.map((_, index) => index);
-      render();
-    }
-    else if (key.name === "right") {
-      this.selectedIndexes.push(this.activeIndex);
-      render();
-    }
-    else if (key.name === "left") {
-      this.selectedIndexes = this.selectedIndexes.filter((index) => index !== this.activeIndex);
-      render();
-    }
-    else if (key.name === "return") {
-      const labels = this.selectedIndexes.map((index) => this.filteredChoices[index].label ?? this.filteredChoices[index]);
-      const values = this.selectedIndexes.map((index) => this.filteredChoices[index].value ?? this.filteredChoices[index]);
-
-      for (const validator of this.#validators) {
-        if (!validator.validate(values)) {
-          const error = validator.error(values);
-          render({ error });
-
-          return;
-        }
-      }
-
-      render({ clearRender: true });
-
-      this.#showAnsweredQuestion(labels.join(", "));
-
-      this.write(SYMBOLS.ShowCursor);
-      this.destroy();
-
-      this.#onProcessExit();
-      process.off("exit", this.#boundExitEvent);
-
-      resolve(values);
-    }
-    else {
-      if (!key.ctrl && this.options.autocomplete) {
-        // reset selected choices when user type
-        this.selectedIndexes = [];
-        this.activeIndex = 0;
-        if (key.name === "backspace" && this.autocompleteValue.length > 0) {
-          this.autocompleteValue = this.autocompleteValue.slice(0, -1);
-        }
-        else if (key.name !== "backspace") {
-          this.autocompleteValue += key.sequence;
-        }
-      }
-      render();
-    }
-  }
-
-  async multiselect() {
-    if (this.agent.nextAnswers.length > 0) {
-      const answer = this.agent.nextAnswers.shift();
-      this.#showAnsweredQuestion(answer, true);
-      this.destroy();
-
-      return 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 linesToClear = Math.ceil(
-            wcwidth(`${SYMBOLS.Pointer} ${this.autocompleteValue}`) / this.stdout.columns
-          );
-          while (linesToClear > 0) {
-            this.clearLastLine();
-            linesToClear--;
-          }
-        }
-      }
-
-      if (clearRender) {
-        const questionLineCount = Math.ceil(
-          wcwidth(stripAnsi(this.questionMessage)) / this.stdout.columns
-        );
-        this.stdout.moveCursor(-this.stdout.columns, -(1 + questionLineCount));
-        this.stdout.clearScreenDown();
-
-        return;
-      }
-
-      if (error) {
-        const linesToClear = Math.ceil(wcwidth(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) => {
-      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(error = null) {
-    let hint = kleur.gray(
-      // eslint-disable-next-line max-len
-      `(Press ${kleur.bold("<Ctrl+A>")} to toggle all, ${kleur.bold("<Ctrl+Space>")} to select, ${kleur.bold("<Left/Right>")} to toggle, ${kleur.bold("<Return>")} to submit)`
-    );
-    if (error) {
-      hint += ` ${kleur.red().bold(`[${error}]`)}`;
-    }
-    this.questionMessage = `${SYMBOLS.QuestionMark} ${kleur.bold(this.message)} ${hint}`;
-
-    this.write(`${this.questionMessage}${EOL}`);
-  }
-}

package/src/prompts/question.js

@@ -1,115 +0,0 @@
-// Import Node.js Dependencies
-import { EOL } from "node:os";
-
-// Import Third-party Dependencies
-import kleur from "kleur";
-import wcwidth from "@topcli/wcwidth";
-
-// Import Internal Dependencies
-import { AbstractPrompt } from "./abstract.js";
-import { stripAnsi } from "../utils.js";
-import { SYMBOLS } from "../constants.js";
-
-export class QuestionPrompt extends AbstractPrompt {
-  #validators;
-  #secure;
-
-  constructor(message, options = {}) {
-    const {
-      stdin = process.stdin,
-      stdout = process.stdout,
-      defaultValue,
-      validators = [],
-      secure = false
-    } = options;
-
-    super(message, stdin, stdout);
-
-    if (defaultValue && typeof defaultValue !== "string") {
-      throw new TypeError("defaultValue must be a string");
-    }
-
-    this.defaultValue = defaultValue;
-    this.tip = this.defaultValue ? ` (${this.defaultValue})` : "";
-    this.#validators = validators;
-    this.#secure = Boolean(secure);
-    this.questionSuffixError = "";
-  }
-
-  #question() {
-    return new Promise((resolve) => {
-      const questionQuery = this.#getQuestionQuery();
-
-      this.rl.question(questionQuery, (answer) => {
-        this.history.push(questionQuery + answer);
-        this.mute = false;
-
-        resolve(answer);
-      });
-      this.mute = this.#secure;
-    });
-  }
-
-  #getQuestionQuery() {
-    return `${kleur.bold(`${SYMBOLS.QuestionMark} ${this.message}${this.tip}`)} ${this.questionSuffixError}`;
-  }
-
-  #setQuestionSuffixError(error) {
-    const suffix = kleur.red(`[${error}] `);
-    this.questionSuffixError = suffix;
-  }
-
-  #writeAnswer() {
-    const prefix = this.answer ? SYMBOLS.Tick : SYMBOLS.Cross;
-    const answer = kleur.yellow(this.#secure ? "CONFIDENTIAL" : this.answer ?? "");
-    this.write(`${prefix} ${kleur.bold(this.message)} ${SYMBOLS.Pointer} ${answer}${EOL}`);
-  }
-
-  #onQuestionAnswer() {
-    const questionLineCount = Math.ceil(
-      wcwidth(stripAnsi(this.#getQuestionQuery() + this.answer)) / this.stdout.columns
-    );
-
-    this.stdout.moveCursor(-this.stdout.columns, -questionLineCount);
-    this.stdout.clearScreenDown();
-
-    for (const validator of this.#validators) {
-      if (!validator.validate(this.answer)) {
-        const error = validator.error(this.answer);
-        this.#setQuestionSuffixError(error);
-        this.answer = this.#question();
-
-        return;
-      }
-    }
-
-    this.#writeAnswer();
-  }
-
-  async question() {
-    if (this.agent.nextAnswers.length > 0) {
-      this.answer = this.agent.nextAnswers.shift();
-      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.answer?.constructor.name === "Promise") {
-      this.answer = await this.answer;
-      this.#onQuestionAnswer();
-    }
-
-    this.destroy();
-
-    return this.answer;
-  }
-}

package/src/prompts/select.js

@@ -1,215 +0,0 @@
-// Import Node.js Dependencies
-import { EOL } from "node:os";
-
-// Import Third-party Dependencies
-import kleur from "kleur";
-import wcwidth from "@topcli/wcwidth";
-
-// Import Internal Dependencies
-import { AbstractPrompt } from "./abstract.js";
-import { stripAnsi } from "../utils.js";
-import { SYMBOLS } from "../constants.js";
-
-export class SelectPrompt extends AbstractPrompt {
-  #boundExitEvent = () => void 0;
-  #boundKeyPressEvent = () => void 0;
-  activeIndex = 0;
-
-  get choices() {
-    return this.options.choices;
-  }
-
-  constructor(message, options) {
-    const {
-      stdin = process.stdin,
-      stdout = process.stdout,
-      choices
-    } = options ?? {};
-
-    super(message, stdin, stdout);
-
-    if (!options) {
-      this.destroy();
-      throw new TypeError("Missing required options");
-    }
-
-    this.options = options;
-
-    if (!choices?.length) {
-      this.destroy();
-      throw new TypeError("Missing required param: choices");
-    }
-
-    this.longestChoice = Math.max(...choices.map((choice) => {
-      if (typeof choice === "string") {
-        return choice.length;
-      }
-
-      const kRequiredChoiceProperties = ["label", "value"];
-
-      for (const prop of kRequiredChoiceProperties) {
-        if (!choice[prop]) {
-          this.destroy();
-          throw new TypeError(`Missing ${prop} for choice ${JSON.stringify(choice)}`);
-        }
-      }
-
-      return choice.label.length;
-    }));
-  }
-
-  #getFormattedChoice(choiceIndex) {
-    const choice = this.choices[choiceIndex];
-
-    if (typeof choice === "string") {
-      return { value: choice, label: choice };
-    }
-
-    return choice;
-  }
-
-  #getVisibleChoices() {
-    const maxVisible = this.options.maxVisible || 8;
-    let startIndex = Math.min(this.choices.length - maxVisible, this.activeIndex - Math.floor(maxVisible / 2));
-    if (startIndex < 0) {
-      startIndex = 0;
-    }
-
-    const endIndex = Math.min(startIndex + maxVisible, this.choices.length);
-
-    return { startIndex, endIndex };
-  }
-
-  #showChoices() {
-    const { startIndex, endIndex } = this.#getVisibleChoices();
-    this.lastRender = { startIndex, endIndex };
-
-    for (let choiceIndex = startIndex; choiceIndex < endIndex; choiceIndex++) {
-      const choice = this.#getFormattedChoice(choiceIndex);
-      const isChoiceSelected = choiceIndex === this.activeIndex;
-      const showPreviousChoicesArrow = startIndex > 0 && choiceIndex === startIndex;
-      const showNextChoicesArrow = endIndex < this.choices.length && choiceIndex === endIndex - 1;
-
-      let prefixArrow = " ";
-      if (showPreviousChoicesArrow) {
-        prefixArrow = SYMBOLS.Previous;
-      }
-      else if (showNextChoicesArrow) {
-        prefixArrow = SYMBOLS.Next;
-      }
-
-      const prefix = `${prefixArrow}${isChoiceSelected ? `${SYMBOLS.Pointer} ` : "  "}`;
-      const formattedLabel = choice.label.padEnd(
-        this.longestChoice < 10 ? this.longestChoice : 0
-      );
-      const formattedDescription = choice.description ? ` - ${choice.description}` : "";
-      const color = isChoiceSelected ? kleur.white().bold : kleur.gray;
-      const str = color(`${prefix}${formattedLabel}${formattedDescription}${EOL}`);
-
-      this.write(str);
-    }
-  }
-
-  #showAnsweredQuestion(choice) {
-    const prefix = `${SYMBOLS.Tick} ${kleur.bold(this.message)} ${SYMBOLS.Pointer}`;
-    const formattedChoice = kleur.yellow(choice.label ?? choice);
-
-    this.write(`${prefix} ${formattedChoice}${EOL}`);
-  }
-
-  #onProcessExit() {
-    this.stdin.off("keypress", this.#boundKeyPressEvent);
-    this.stdout.moveCursor(-this.stdout.columns, 0);
-    this.stdout.clearScreenDown();
-    this.write(SYMBOLS.ShowCursor);
-  }
-
-  #onKeypress(...args) {
-    const [resolve, render, _, key] = args;
-
-    if (key.name === "up") {
-      this.activeIndex = this.activeIndex === 0 ? this.choices.length - 1 : this.activeIndex - 1;
-      render();
-    }
-    else if (key.name === "down") {
-      this.activeIndex = this.activeIndex === this.choices.length - 1 ? 0 : this.activeIndex + 1;
-      render();
-    }
-    else if (key.name === "return") {
-      render({ clearRender: true });
-
-      const currentChoice = this.choices[this.activeIndex];
-      const value = currentChoice.value ?? currentChoice;
-
-      if (!this.options.ignoreValues?.includes(value)) {
-        this.#showAnsweredQuestion(currentChoice);
-      }
-
-      this.write(SYMBOLS.ShowCursor);
-      this.destroy();
-
-      this.#onProcessExit();
-      process.off("exit", this.#boundExitEvent);
-      resolve(value);
-    }
-    else {
-      render();
-    }
-  }
-
-  async select() {
-    if (this.agent.nextAnswers.length > 0) {
-      const answer = this.agent.nextAnswers.shift();
-      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 (clearRender) {
-        const questionLineCount = Math.ceil(
-          wcwidth(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) => {
-      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} ${kleur.bold(this.message)}`;
-    this.write(`${this.questionMessage}${EOL}`);
-  }
-}

package/src/utils.js

@@ -1,43 +0,0 @@
-import process from "node:process";
-
-// CONSTANTS
-const kAnsiRegex = ansiRegex();
-
-/**
- * @see https://github.com/chalk/ansi-regex
- */
-export function ansiRegex({onlyFirst = false} = {}) {
-	const pattern = [
-		'[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
-		'(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))'
-	].join('|');
-
-	return new RegExp(pattern, onlyFirst ? undefined : 'g');
-}
-
-/**
- * @param {!string} string
- * @returns {string}
- */
-export function stripAnsi(string) {
-  return string.replace(kAnsiRegex, "");
-}
-
-/**
- * @see https://github.com/sindresorhus/is-unicode-supported
- * @returns {boolean}
- */
-export function isUnicodeSupported() {
-	if (process.platform !== 'win32') {
-		return process.env.TERM !== 'linux'; // Linux console (kernel)
-	}
-
-	return Boolean(process.env.WT_SESSION) // Windows Terminal
-		|| Boolean(process.env.TERMINUS_SUBLIME) // Terminus (<0.2.27)
-		|| process.env.ConEmuTask === '{cmd::Cmder}' // ConEmu and cmder
-		|| process.env.TERM_PROGRAM === 'Terminus-Sublime'
-		|| process.env.TERM_PROGRAM === 'vscode'
-		|| process.env.TERM === 'xterm-256color'
-		|| process.env.TERM === 'alacritty'
-		|| process.env.TERMINAL_EMULATOR === 'JetBrains-JediTerm';
-}

package/src/validators.js

@@ -1,6 +0,0 @@
-export function required() {
-  return {
-    validate: (input) => (Array.isArray(input) ? input.length > 0 : Boolean(input)),
-    error: () => "required"
-  };
-}