@topcli/prompts 2.4.0 → 2.4.1

package/README.md

@@ -84,9 +84,9 @@ const packageName = await question('Package name', {
 - required
 
 ```js
-import { prompt, required } from "@topcli/prompts";
+import { question, required } from "@topcli/prompts";
 
-const name = await prompt("What's your name ?", {
+const name = await question("What's your name ?", {
   validators: [required()]
 });
 ```
@@ -94,7 +94,7 @@ const name = await prompt("What's your name ?", {
 ### `select()`
 
 ```ts
-select(message: string, options: SelectOptions): Promise<string>
+select<T extends string>(message: string, options: SelectOptions<T>): Promise<T>
 ```
 
 Scrollable select depending `maxVisible` (default `8`).
@@ -114,7 +114,7 @@ Use `options.skip` to skip prompt. It will return the first choice.
 ### `multiselect()`
 
 ```ts
-multiselect(message: string, options: MultiselectOptions): Promise<[string]>
+multiselect<T extends string>(message: string, options: MultiselectOptions<T>): Promise<T[]>
 ```
 
 Scrollable multiselect depending `options.maxVisible` (default `8`).<br>
@@ -196,46 +196,46 @@ export interface AbstractPromptOptions {
   stdin?: Stdin;
   stdout?: Stdout;
   message: string;
-  sginal?: AbortSignal;
+  skip?: boolean;
+  signal?: AbortSignal;
 }
 
-export interface PromptValidator<T = string | string[] | boolean> {
-    validate: (input: T) => boolean;
-    error: (input: T) => string;
+export interface PromptValidator<T extends string | string[]> {
+  validate: (input: T) => boolean;
 }
 
 export interface QuestionOptions extends SharedOptions {
   defaultValue?: string;
-  validators?: Validator[];
+  validators?: PromptValidator<string>[];
   secure?: boolean;
 }
 
-export interface Choice {
-  value: any;
+export interface Choice<T = any> {
+  value: T;
   label: string;
   description?: string;
 }
 
-export interface SelectOptions extends SharedOptions  {
-  choices: (Choice | string)[];
+export interface SelectOptions<T extends string> extends AbstractPromptOptions {
+  choices: (Choice<T> | T)[];
   maxVisible?: number;
-  ignoreValues?: (string | number | boolean)[];
-  validators?: Validator[];
+  ignoreValues?: (T | number | boolean)[];
+  validators?: PromptValidator<string>[];
   autocomplete?: boolean;
   caseSensitive?: boolean;
 }
 
-export interface MultiselectOptions extends SharedOptions  {
-  choices: (Choice | string)[];
+export interface MultiselectOptions<T extends string> extends AbstractPromptOptions {
+  choices: (Choice<T> | T)[];
   maxVisible?: number;
-  preSelectedChoices?: (Choice | string)[];
-  validators?: Validator[];
+  preSelectedChoices?: (Choice<T> | T)[];
+  validators?: PromptValidator<string[]>[];
   autocomplete?: boolean;
   caseSensitive?: boolean;
   showHint?: boolean;
 }
 
-export interface ConfirmOptions extends SharedOptions  {
+export interface ConfirmOptions extends AbstractPromptOptions {
   initial?: boolean;
 }
 ```
@@ -264,6 +264,7 @@ Open an issue if you want to provide feedback such as bug reports or enchancemen
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/noxify"><img src="https://avatars.githubusercontent.com/u/521777?v=4?s=100" width="100px;" alt="Marcus Reinhardt"/><br /><sub><b>Marcus Reinhardt</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=noxify" title="Code">💻</a> <a href="https://github.com/TopCli/prompts/commits?author=noxify" title="Tests">⚠️</a> <a href="https://github.com/TopCli/prompts/commits?author=noxify" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ItsHarper"><img src="https://avatars.githubusercontent.com/u/10224994?v=4?s=100" width="100px;" alt="Harper Andrews"/><br /><sub><b>Harper Andrews</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=ItsHarper" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

package/dist/index.cjs

@@ -27,7 +27,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// index.ts
+// src/index.ts
 var index_exports = {};
 __export(index_exports, {
   PromptAgent: () => PromptAgent,
@@ -39,16 +39,30 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/prompts/question.ts
-var import_node_os2 = require("os");
-var import_node_util4 = require("util");
-
-// src/prompts/abstract.ts
-var import_node_os = require("os");
-var import_node_readline = __toESM(require("readline"), 1);
-var import_node_stream = require("stream");
-var import_node_events = __toESM(require("events"), 1);
-var import_node_util = require("util");
+// src/validators.ts
+function required() {
+  return {
+    validate: (input) => {
+      const isValid2 = Array.isArray(input) ? input.length > 0 : Boolean(input);
+      return isValid2 ? null : { isValid: isValid2, error: "required" };
+    }
+  };
+}
+function isValid(result) {
+  if (typeof result === "object") {
+    return result?.isValid !== false;
+  }
+  if (typeof result === "string") {
+    return result.length > 0;
+  }
+  return true;
+}
+function resultError(result) {
+  if (typeof result === "object") {
+    return result.error;
+  }
+  return result;
+}
 
 // src/prompt-agent.ts
 var kPrivateInstancier = Symbol("instancier");
@@ -93,6 +107,13 @@ var PromptAgent = class _PromptAgent {
   }
 };
 
+// src/prompts/abstract.ts
+var import_node_os = require("os");
+var import_node_readline = __toESM(require("readline"), 1);
+var import_node_stream = require("stream");
+var import_node_events = __toESM(require("events"), 1);
+var import_node_util = require("util");
+
 // src/errors/abort.ts
 var AbortError = class extends Error {
   constructor(message) {
@@ -205,6 +226,10 @@ var AbstractPrompt = class _AbstractPrompt extends import_node_events.default {
   }
 };
 
+// src/prompts/question.ts
+var import_node_os2 = require("os");
+var import_node_util4 = require("util");
+
 // src/utils.ts
 var import_node_process = __toESM(require("process"), 1);
 var import_node_util2 = require("util");
@@ -263,31 +288,6 @@ var SYMBOLS = {
   Inactive: (0, import_node_util3.styleText)("gray", kSymbols.inactive)
 };
 
-// src/validators.ts
-function required() {
-  return {
-    validate: (input) => {
-      const isValid2 = Array.isArray(input) ? input.length > 0 : Boolean(input);
-      return isValid2 ? null : { isValid: isValid2, error: "required" };
-    }
-  };
-}
-function isValid(result) {
-  if (typeof result === "object") {
-    return result?.isValid !== false;
-  }
-  if (typeof result === "string") {
-    return result.length > 0;
-  }
-  return true;
-}
-function resultError(result) {
-  if (typeof result === "object") {
-    return result.error;
-  }
-  return result;
-}
-
 // src/prompts/question.ts
 var QuestionPrompt = class extends AbstractPrompt {
   defaultValue;
@@ -1049,21 +1049,26 @@ var MultiselectPrompt = class extends AbstractPrompt {
   }
 };
 
-// index.ts
+// src/index.ts
 function question(message, options = {}) {
-  return new QuestionPrompt({ ...options, message }).question();
+  return new QuestionPrompt(
+    { ...options, message }
+  ).question();
 }
 function select(message, options) {
-  const selectPrompt = new SelectPrompt({ ...options, message });
-  return selectPrompt.select();
+  return new SelectPrompt(
+    { ...options, message }
+  ).select();
 }
 function confirm(message, options = {}) {
-  const confirmPrompt = new ConfirmPrompt({ ...options, message });
-  return confirmPrompt.confirm();
+  return new ConfirmPrompt(
+    { ...options, message }
+  ).confirm();
 }
 function multiselect(message, options) {
-  const multiselectPrompt = new MultiselectPrompt({ ...options, message });
-  return multiselectPrompt.multiselect();
+  return new MultiselectPrompt(
+    { ...options, message }
+  ).multiselect();
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.d.cts

@@ -5,13 +5,14 @@ type InvalidResponseObject = {
     isValid: false;
     error: string;
 };
+type ValidationResponseObject = ValidResponseObject | InvalidResponseObject;
 type ValidationResponse = InvalidResponse | ValidResponse;
 type InvalidResponse = string | InvalidResponseObject;
 type ValidResponse = null | undefined | true | ValidResponseObject;
-interface PromptValidator<T = string | string[] | boolean> {
+interface PromptValidator<T extends string | string[]> {
     validate: (input: T) => ValidationResponse;
 }
-declare function required<T = string | string[] | boolean>(): PromptValidator<T>;
+declare function required(): PromptValidator<any>;
 
 declare class PromptAgent<T = string> {
     #private;
@@ -39,6 +40,12 @@ declare class PromptAgent<T = string> {
     nextAnswer(value: T): void;
 }
 
+interface Choice<T extends string> {
+    value: T;
+    label: string;
+    description?: string;
+}
+
 type Stdin = NodeJS.ReadStream & {
     fd: 0;
 };
@@ -53,15 +60,9 @@ interface AbstractPromptOptions {
     signal?: AbortSignal;
 }
 
-interface Choice<T = any> {
-    value: T;
-    label: string;
-    description?: string;
-}
-
 interface QuestionOptions extends AbstractPromptOptions {
     defaultValue?: string;
-    validators?: PromptValidator[];
+    validators?: PromptValidator<string>[];
     secure?: boolean | {
         placeholder: string;
     };
@@ -71,23 +72,23 @@ interface ConfirmOptions extends AbstractPromptOptions {
     initial?: boolean;
 }
 
-interface MultiselectOptions<T extends string> extends AbstractPromptOptions {
+interface SelectOptions<T extends string> extends AbstractPromptOptions {
     choices: (Choice<T> | T)[];
     maxVisible?: number;
-    preSelectedChoices?: (Choice | T)[];
-    validators?: PromptValidator<T[]>[];
+    ignoreValues?: (T | number | boolean)[];
+    validators?: PromptValidator<string>[];
     autocomplete?: boolean;
     caseSensitive?: boolean;
-    showHint?: boolean;
 }
 
-interface SelectOptions<T extends string> extends AbstractPromptOptions {
+interface MultiselectOptions<T extends string> extends AbstractPromptOptions {
     choices: (Choice<T> | T)[];
     maxVisible?: number;
-    ignoreValues?: (T | number | boolean)[];
-    validators?: PromptValidator<T>[];
+    preSelectedChoices?: (Choice<T> | T)[];
+    validators?: PromptValidator<string[]>[];
     autocomplete?: boolean;
     caseSensitive?: boolean;
+    showHint?: boolean;
 }
 
 declare function question(message: string, options?: Omit<QuestionOptions, "message">): Promise<string>;
@@ -95,4 +96,4 @@ declare function select<T extends string>(message: string, options: Omit<SelectO
 declare function confirm(message: string, options?: Omit<ConfirmOptions, "message">): Promise<boolean>;
 declare function multiselect<T extends string>(message: string, options: Omit<MultiselectOptions<T>, "message">): Promise<T[]>;
 
-export { type AbstractPromptOptions, type Choice, type ConfirmOptions, type MultiselectOptions, PromptAgent, type PromptValidator, type QuestionOptions, type SelectOptions, confirm, multiselect, question, required, select };
+export { type AbstractPromptOptions, type Choice, type ConfirmOptions, type InvalidResponse, type InvalidResponseObject, type MultiselectOptions, PromptAgent, type PromptValidator, type QuestionOptions, type SelectOptions, type ValidResponse, type ValidResponseObject, type ValidationResponse, type ValidationResponseObject, confirm, multiselect, question, required, select };

package/dist/index.d.ts

@@ -5,13 +5,14 @@ type InvalidResponseObject = {
     isValid: false;
     error: string;
 };
+type ValidationResponseObject = ValidResponseObject | InvalidResponseObject;
 type ValidationResponse = InvalidResponse | ValidResponse;
 type InvalidResponse = string | InvalidResponseObject;
 type ValidResponse = null | undefined | true | ValidResponseObject;
-interface PromptValidator<T = string | string[] | boolean> {
+interface PromptValidator<T extends string | string[]> {
     validate: (input: T) => ValidationResponse;
 }
-declare function required<T = string | string[] | boolean>(): PromptValidator<T>;
+declare function required(): PromptValidator<any>;
 
 declare class PromptAgent<T = string> {
     #private;
@@ -39,6 +40,12 @@ declare class PromptAgent<T = string> {
     nextAnswer(value: T): void;
 }
 
+interface Choice<T extends string> {
+    value: T;
+    label: string;
+    description?: string;
+}
+
 type Stdin = NodeJS.ReadStream & {
     fd: 0;
 };
@@ -53,15 +60,9 @@ interface AbstractPromptOptions {
     signal?: AbortSignal;
 }
 
-interface Choice<T = any> {
-    value: T;
-    label: string;
-    description?: string;
-}
-
 interface QuestionOptions extends AbstractPromptOptions {
     defaultValue?: string;
-    validators?: PromptValidator[];
+    validators?: PromptValidator<string>[];
     secure?: boolean | {
         placeholder: string;
     };
@@ -71,23 +72,23 @@ interface ConfirmOptions extends AbstractPromptOptions {
     initial?: boolean;
 }
 
-interface MultiselectOptions<T extends string> extends AbstractPromptOptions {
+interface SelectOptions<T extends string> extends AbstractPromptOptions {
     choices: (Choice<T> | T)[];
     maxVisible?: number;
-    preSelectedChoices?: (Choice | T)[];
-    validators?: PromptValidator<T[]>[];
+    ignoreValues?: (T | number | boolean)[];
+    validators?: PromptValidator<string>[];
     autocomplete?: boolean;
     caseSensitive?: boolean;
-    showHint?: boolean;
 }
 
-interface SelectOptions<T extends string> extends AbstractPromptOptions {
+interface MultiselectOptions<T extends string> extends AbstractPromptOptions {
     choices: (Choice<T> | T)[];
     maxVisible?: number;
-    ignoreValues?: (T | number | boolean)[];
-    validators?: PromptValidator<T>[];
+    preSelectedChoices?: (Choice<T> | T)[];
+    validators?: PromptValidator<string[]>[];
     autocomplete?: boolean;
     caseSensitive?: boolean;
+    showHint?: boolean;
 }
 
 declare function question(message: string, options?: Omit<QuestionOptions, "message">): Promise<string>;
@@ -95,4 +96,4 @@ declare function select<T extends string>(message: string, options: Omit<SelectO
 declare function confirm(message: string, options?: Omit<ConfirmOptions, "message">): Promise<boolean>;
 declare function multiselect<T extends string>(message: string, options: Omit<MultiselectOptions<T>, "message">): Promise<T[]>;
 
-export { type AbstractPromptOptions, type Choice, type ConfirmOptions, type MultiselectOptions, PromptAgent, type PromptValidator, type QuestionOptions, type SelectOptions, confirm, multiselect, question, required, select };
+export { type AbstractPromptOptions, type Choice, type ConfirmOptions, type InvalidResponse, type InvalidResponseObject, type MultiselectOptions, PromptAgent, type PromptValidator, type QuestionOptions, type SelectOptions, type ValidResponse, type ValidResponseObject, type ValidationResponse, type ValidationResponseObject, confirm, multiselect, question, required, select };

package/dist/index.js

@@ -1,13 +1,27 @@
-// src/prompts/question.ts
-import { EOL as EOL2 } from "node:os";
-import { styleText as styleText2 } from "node:util";
-
-// src/prompts/abstract.ts
-import { EOL } from "node:os";
-import readline from "node:readline";
-import { Writable } from "node:stream";
-import EventEmitter from "node:events";
-import { stripVTControlCharacters } from "node:util";
+// src/validators.ts
+function required() {
+  return {
+    validate: (input) => {
+      const isValid2 = Array.isArray(input) ? input.length > 0 : Boolean(input);
+      return isValid2 ? null : { isValid: isValid2, error: "required" };
+    }
+  };
+}
+function isValid(result) {
+  if (typeof result === "object") {
+    return result?.isValid !== false;
+  }
+  if (typeof result === "string") {
+    return result.length > 0;
+  }
+  return true;
+}
+function resultError(result) {
+  if (typeof result === "object") {
+    return result.error;
+  }
+  return result;
+}
 
 // src/prompt-agent.ts
 var kPrivateInstancier = Symbol("instancier");
@@ -52,6 +66,13 @@ var PromptAgent = class _PromptAgent {
   }
 };
 
+// src/prompts/abstract.ts
+import { EOL } from "node:os";
+import readline from "node:readline";
+import { Writable } from "node:stream";
+import EventEmitter from "node:events";
+import { stripVTControlCharacters } from "node:util";
+
 // src/errors/abort.ts
 var AbortError = class extends Error {
   constructor(message) {
@@ -164,6 +185,10 @@ var AbstractPrompt = class _AbstractPrompt extends EventEmitter {
   }
 };
 
+// src/prompts/question.ts
+import { EOL as EOL2 } from "node:os";
+import { styleText as styleText2 } from "node:util";
+
 // src/utils.ts
 import process2 from "node:process";
 import { stripVTControlCharacters as stripVTControlCharacters2 } from "node:util";
@@ -222,31 +247,6 @@ var SYMBOLS = {
   Inactive: styleText("gray", kSymbols.inactive)
 };
 
-// src/validators.ts
-function required() {
-  return {
-    validate: (input) => {
-      const isValid2 = Array.isArray(input) ? input.length > 0 : Boolean(input);
-      return isValid2 ? null : { isValid: isValid2, error: "required" };
-    }
-  };
-}
-function isValid(result) {
-  if (typeof result === "object") {
-    return result?.isValid !== false;
-  }
-  if (typeof result === "string") {
-    return result.length > 0;
-  }
-  return true;
-}
-function resultError(result) {
-  if (typeof result === "object") {
-    return result.error;
-  }
-  return result;
-}
-
 // src/prompts/question.ts
 var QuestionPrompt = class extends AbstractPrompt {
   defaultValue;
@@ -1008,21 +1008,26 @@ var MultiselectPrompt = class extends AbstractPrompt {
   }
 };
 
-// index.ts
+// src/index.ts
 function question(message, options = {}) {
-  return new QuestionPrompt({ ...options, message }).question();
+  return new QuestionPrompt(
+    { ...options, message }
+  ).question();
 }
 function select(message, options) {
-  const selectPrompt = new SelectPrompt({ ...options, message });
-  return selectPrompt.select();
+  return new SelectPrompt(
+    { ...options, message }
+  ).select();
 }
 function confirm(message, options = {}) {
-  const confirmPrompt = new ConfirmPrompt({ ...options, message });
-  return confirmPrompt.confirm();
+  return new ConfirmPrompt(
+    { ...options, message }
+  ).confirm();
 }
 function multiselect(message, options) {
-  const multiselectPrompt = new MultiselectPrompt({ ...options, message });
-  return multiselectPrompt.multiselect();
+  return new MultiselectPrompt(
+    { ...options, message }
+  ).multiselect();
 }
 export {
   PromptAgent,

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@topcli/prompts",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "description": "Node.js user input library for command-line interfaces.",
+  "type": "module",
   "scripts": {
-    "build": "tsup index.ts --format cjs,esm --dts --clean",
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
     "prepublishOnly": "npm run build",
-    "test": "glob -c \"tsx --test\" \"./test/**/*.test.ts\"",
-    "coverage": "c8 -r html npm run test",
+    "test-only": "glob -c \"tsx --test\" \"./test/**/*.test.ts\"",
+    "test-types": "npm run build && tsd && attw --pack .",
+    "test": "c8 -r html npm run test-only && npm run test-types",
     "lint": "eslint src test",
     "lint:fix": "eslint . --fix"
   },
@@ -14,9 +16,8 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
   "keywords": [
@@ -29,13 +30,14 @@
   ],
   "author": "PierreDemailly <pierredemailly.pro@gmail.com>",
   "license": "ISC",
-  "type": "module",
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
     "@openally/config.eslint": "^2.0.0",
     "@openally/config.typescript": "^1.0.3",
     "@types/node": "^24.0.3",
     "c8": "^10.1.3",
     "glob": "^11.0.0",
+    "tsd": "^0.33.0",
     "tsup": "^8.3.5",
     "tsx": "^4.19.2",
     "typescript": "^5.7.2"
@@ -46,5 +48,8 @@
   "bugs": {
     "url": "https://github.com/TopCli/prompts/issues"
   },
-  "homepage": "https://github.com/TopCli/prompts#readme"
+  "homepage": "https://github.com/TopCli/prompts#readme",
+  "tsd": {
+    "directory": "test/types"
+  }
 }