@topcli/prompts 2.4.1 → 3.1.0

package/dist/index.d.cts

@@ -1,99 +1,136 @@
+//#region src/validators.d.ts
 type ValidResponseObject = {
-    isValid?: true;
+  isValid?: true;
 };
 type InvalidResponseObject = {
-    isValid: false;
-    error: string;
+  isValid: false;
+  error: string;
 };
 type ValidationResponseObject = ValidResponseObject | InvalidResponseObject;
 type ValidationResponse = InvalidResponse | ValidResponse;
 type InvalidResponse = string | InvalidResponseObject;
 type ValidResponse = null | undefined | true | ValidResponseObject;
+type ValidTransformationResponse<T> = {
+  isValid: true;
+  transformed: T;
+};
+type TransformationResponse<T> = InvalidResponse | ValidTransformationResponse<T>;
 interface PromptValidator<T extends string | string[]> {
-    validate: (input: T) => ValidationResponse;
+  validate: (input: T) => ValidationResponse | Promise<ValidationResponse>;
+}
+interface PromptTransformer<T> {
+  transform: (input: string) => TransformationResponse<T> | Promise<TransformationResponse<T>>;
 }
 declare function required(): PromptValidator<any>;
-
+//#endregion
+//#region src/prompt-agent.d.ts
 declare class PromptAgent<T = string> {
-    #private;
-    /**
-     * The prompts answers queue.
-     * When not empty, any prompt will be answered by the first answer in this list.
-     */
-    nextAnswers: T[];
-    static agent<T>(): PromptAgent<T>;
-    constructor(instancier: symbol);
-    /**
-     * Programmatically set the next answer for any prompt (`question()`, `confirm()`, `select()`)
-     *
-     * This is useful for testing.
-     *
-     * @example
-     * ```js
-     * const promptAgent = PromptAgent.agent();
-     * promptAgent.nextAnswer("toto");
-     *
-     * const input = await question("what is your name?");
-     * assert.equal(input, "toto");
-     * ```
-     */
-    nextAnswer(value: T): void;
+  #private;
+  /**
+   * The prompts answers queue.
+   * When not empty, any prompt will be answered by the first answer in this list.
+   */
+  nextAnswers: T[];
+  static agent<T>(): PromptAgent<T>;
+  constructor(instancier: symbol);
+  /**
+   * Programmatically set the next answer for any prompt (`question()`, `confirm()`, `select()`)
+   *
+   * This is useful for testing.
+   *
+   * @example
+   * ```js
+   * const promptAgent = PromptAgent.agent();
+   * promptAgent.nextAnswer("toto");
+   *
+   * const input = await question("what is your name?");
+   * assert.equal(input, "toto");
+   * ```
+   */
+  nextAnswer(value: T): void;
 }
-
+//#endregion
+//#region src/transformers.d.ts
+declare function number(): PromptTransformer<number>;
+declare function integer(): PromptTransformer<number>;
+declare function url(): PromptTransformer<URL>;
+//#endregion
+//#region src/types.d.ts
 interface Choice<T extends string> {
-    value: T;
-    label: string;
-    description?: string;
+  value: T;
+  label: string;
+  description?: string;
+  disabled?: boolean | string;
+}
+interface Separator {
+  type: "separator";
+  label?: string;
 }
-
+//#endregion
+//#region src/prompts/abstract.d.ts
 type Stdin = NodeJS.ReadStream & {
-    fd: 0;
+  fd: 0;
 };
 type Stdout = NodeJS.WriteStream & {
-    fd: 1;
+  fd: 1;
 };
 interface AbstractPromptOptions {
-    stdin?: Stdin;
-    stdout?: Stdout;
-    message: string;
-    skip?: boolean;
-    signal?: AbortSignal;
+  stdin?: Stdin;
+  stdout?: Stdout;
+  message: string;
+  skip?: boolean;
+  signal?: AbortSignal;
 }
-
-interface QuestionOptions extends AbstractPromptOptions {
-    defaultValue?: string;
-    validators?: PromptValidator<string>[];
-    secure?: boolean | {
-        placeholder: string;
-    };
+//#endregion
+//#region src/prompts/question.d.ts
+interface QuestionOptions<T = string> extends AbstractPromptOptions {
+  defaultValue?: string;
+  validators?: PromptValidator<string>[];
+  transformer?: PromptTransformer<T>;
+  secure?: boolean | {
+    placeholder: string;
+  };
 }
-
+//#endregion
+//#region src/prompts/confirm.d.ts
 interface ConfirmOptions extends AbstractPromptOptions {
-    initial?: boolean;
+  initial?: boolean;
 }
-
+//#endregion
+//#region src/prompts/select.d.ts
 interface SelectOptions<T extends string> extends AbstractPromptOptions {
-    choices: (Choice<T> | T)[];
-    maxVisible?: number;
-    ignoreValues?: (T | number | boolean)[];
-    validators?: PromptValidator<string>[];
-    autocomplete?: boolean;
-    caseSensitive?: boolean;
+  choices: (Choice<T> | T | Separator)[];
+  maxVisible?: number;
+  ignoreValues?: (T | number | boolean)[];
+  validators?: PromptValidator<string>[];
+  autocomplete?: boolean;
+  caseSensitive?: boolean;
 }
-
+//#endregion
+//#region src/prompts/multiselect.d.ts
 interface MultiselectOptions<T extends string> extends AbstractPromptOptions {
-    choices: (Choice<T> | T)[];
-    maxVisible?: number;
-    preSelectedChoices?: (Choice<T> | T)[];
-    validators?: PromptValidator<string[]>[];
-    autocomplete?: boolean;
-    caseSensitive?: boolean;
-    showHint?: boolean;
+  choices: (Choice<T> | T | Separator)[];
+  maxVisible?: number;
+  preSelectedChoices?: (Choice<T> | T)[];
+  validators?: PromptValidator<string[]>[];
+  autocomplete?: boolean;
+  caseSensitive?: boolean;
+  showHint?: boolean;
 }
-
-declare function question(message: string, options?: Omit<QuestionOptions, "message">): Promise<string>;
+//#endregion
+//#region src/index.d.ts
+declare function question<T = string>(message: string, options?: Omit<QuestionOptions<T>, "message">): Promise<T>;
 declare function select<T extends string>(message: string, options: Omit<SelectOptions<T>, "message">): Promise<T>;
 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 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 };
+declare const validators: {
+  required: typeof required;
+};
+declare const transformers: {
+  number: typeof number;
+  integer: typeof integer;
+  url: typeof url;
+};
+//#endregion
+export { type AbstractPromptOptions, type Choice, type ConfirmOptions, type InvalidResponse, type InvalidResponseObject, type MultiselectOptions, PromptAgent, type PromptTransformer, type PromptValidator, type QuestionOptions, type SelectOptions, type Separator, type TransformationResponse, type ValidResponse, type ValidResponseObject, type ValidTransformationResponse, type ValidationResponse, type ValidationResponseObject, confirm, multiselect, question, select, transformers, validators };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/validators.ts","../src/prompt-agent.ts","../src/transformers.ts","../src/types.ts","../src/prompts/abstract.ts","../src/prompts/question.ts","../src/prompts/confirm.ts","../src/prompts/select.ts","../src/prompts/multiselect.ts","../src/index.ts"],"mappings":";KAAY,mBAAA;EACV,OAAA;AAAA;AAAA,KAEU,qBAAA;EACV,OAAA;EACA,KAAA;AAAA;AAAA,KAEU,wBAAA,GAA2B,mBAAA,GAAsB,qBAAA;AAAA,KACjD,kBAAA,GAAqB,eAAA,GAAkB,aAAA;AAAA,KACvC,eAAA,YAA2B,qBAAA;AAAA,KAC3B,aAAA,6BAA0C,mBAAA;AAAA,KAE1C,2BAAA;EACV,OAAA;EACA,WAAA,EAAa,CAAA;AAAA;AAAA,KAEH,sBAAA,MAA4B,eAAA,GAAkB,2BAAA,CAA4B,CAAA;AAAA,UAErE,eAAA;EACf,QAAA,GAAW,KAAA,EAAO,CAAA,KAAM,kBAAA,GAAqB,OAAA,CAAQ,kBAAA;AAAA;AAAA,UAGtC,iBAAA;EACf,SAAA,GAAY,KAAA,aAAkB,sBAAA,CAAuB,CAAA,IAAK,OAAA,CAAQ,sBAAA,CAAuB,CAAA;AAAA;AAAA,iBAG3E,QAAA,CAAA,GAAY,eAAA;;;cCvBf,WAAA;EAAA;EDHkB;;;;ECQ7B,WAAA,EAAa,CAAA;EAAA,OAON,KAAA,GAAA,CAAA,GAAO,WAAA,CAAA,CAAA;cAKF,UAAA;EDhBZ;;AAGF;;;;;AACA;;;;;AACA;;EC+BE,UAAA,CAAW,KAAA,EAAO,CAAA;AAAA;;;iBCrCJ,MAAA,CAAA,GAAU,iBAAA;AAAA,iBAiBV,OAAA,CAAA,GAAW,iBAAA;AAAA,iBAiBX,GAAA,CAAA,GAAO,iBAAA,CAAkB,GAAA;;;UCrCxB,MAAA;EACf,KAAA,EAAO,CAAA;EACP,KAAA;EACA,WAAA;EACA,QAAA;AAAA;AAAA,UAGe,SAAA;EACf,IAAA;EACA,KAAA;AAAA;;;KCOG,KAAA,GAAQ,MAAA,CAAO,UAAA;EAClB,EAAA;AAAA;AAAA,KAGG,MAAA,GAAS,MAAA,CAAO,WAAA;EACnB,EAAA;AAAA;AAAA,UAGe,qBAAA;EACf,KAAA,GAAQ,KAAA;EACR,MAAA,GAAS,MAAA;EACT,OAAA;EACA,IAAA;EACA,MAAA,GAAS,WAAA;AAAA;;;UCXM,eAAA,qBAAoC,qBAAA;EACnD,YAAA;EACA,UAAA,GAAa,eAAA;EACb,WAAA,GAAc,iBAAA,CAAkB,CAAA;EAChC,MAAA;IACE,WAAA;EAAA;AAAA;;;UCba,cAAA,SAAuB,qBAAA;EACtC,OAAA;AAAA;;;UCIe,aAAA,2BAAwC,qBAAA;EACvD,OAAA,GAAU,MAAA,CAAO,CAAA,IAAK,CAAA,GAAI,SAAA;EAC1B,UAAA;EACA,YAAA,IAAgB,CAAA;EAChB,UAAA,GAAa,eAAA;EACb,YAAA;EACA,aAAA;AAAA;;;UCPe,kBAAA,2BAA6C,qBAAA;EAC5D,OAAA,GAAU,MAAA,CAAO,CAAA,IAAK,CAAA,GAAI,SAAA;EAC1B,UAAA;EACA,kBAAA,IAAsB,MAAA,CAAO,CAAA,IAAK,CAAA;EAClC,UAAA,GAAa,eAAA;EACb,YAAA;EACA,aAAA;EACA,QAAA;AAAA;;;iBCcoB,QAAA,YAAA,CACpB,OAAA,UACA,OAAA,GAAS,IAAA,CAAK,eAAA,CAAgB,CAAA,gBAC7B,OAAA,CAAQ,CAAA;AAAA,iBAuBW,MAAA,kBAAA,CACpB,OAAA,UACA,OAAA,EAAS,IAAA,CAAK,aAAA,CAAc,CAAA,gBAC3B,OAAA,CAAQ,CAAA;AAAA,iBAuBW,OAAA,CACpB,OAAA,UACA,OAAA,GAAS,IAAA,CAAK,cAAA,eACb,OAAA;AAAA,iBAuBmB,WAAA,kBAAA,CACpB,OAAA,UACA,OAAA,EAAS,IAAA,CAAK,kBAAA,CAAmB,CAAA,gBAChC,OAAA,CAAQ,CAAA;AAAA,cAiDE,UAAA;mBAAyB,QAAA;AAAA;AAAA,cACzB,YAAA"}

package/dist/index.d.mts

@@ -0,0 +1,139 @@
+import EventEmitter from "node:events";
+import readline from "node:readline";
+
+//#region src/validators.d.ts
+type ValidResponseObject = {
+  isValid?: true;
+};
+type InvalidResponseObject = {
+  isValid: false;
+  error: string;
+};
+type ValidationResponseObject = ValidResponseObject | InvalidResponseObject;
+type ValidationResponse = InvalidResponse | ValidResponse;
+type InvalidResponse = string | InvalidResponseObject;
+type ValidResponse = null | undefined | true | ValidResponseObject;
+type ValidTransformationResponse<T> = {
+  isValid: true;
+  transformed: T;
+};
+type TransformationResponse<T> = InvalidResponse | ValidTransformationResponse<T>;
+interface PromptValidator<T extends string | string[]> {
+  validate: (input: T) => ValidationResponse | Promise<ValidationResponse>;
+}
+interface PromptTransformer<T> {
+  transform: (input: string) => TransformationResponse<T> | Promise<TransformationResponse<T>>;
+}
+declare function required(): PromptValidator<any>;
+//#endregion
+//#region src/prompt-agent.d.ts
+declare class PromptAgent<T = string> {
+  #private;
+  /**
+   * The prompts answers queue.
+   * When not empty, any prompt will be answered by the first answer in this list.
+   */
+  nextAnswers: T[];
+  static agent<T>(): PromptAgent<T>;
+  constructor(instancier: symbol);
+  /**
+   * Programmatically set the next answer for any prompt (`question()`, `confirm()`, `select()`)
+   *
+   * This is useful for testing.
+   *
+   * @example
+   * ```js
+   * const promptAgent = PromptAgent.agent();
+   * promptAgent.nextAnswer("toto");
+   *
+   * const input = await question("what is your name?");
+   * assert.equal(input, "toto");
+   * ```
+   */
+  nextAnswer(value: T): void;
+}
+//#endregion
+//#region src/transformers.d.ts
+declare function number(): PromptTransformer<number>;
+declare function integer(): PromptTransformer<number>;
+declare function url(): PromptTransformer<URL>;
+//#endregion
+//#region src/types.d.ts
+interface Choice<T extends string> {
+  value: T;
+  label: string;
+  description?: string;
+  disabled?: boolean | string;
+}
+interface Separator {
+  type: "separator";
+  label?: string;
+}
+//#endregion
+//#region src/prompts/abstract.d.ts
+type Stdin = NodeJS.ReadStream & {
+  fd: 0;
+};
+type Stdout = NodeJS.WriteStream & {
+  fd: 1;
+};
+interface AbstractPromptOptions {
+  stdin?: Stdin;
+  stdout?: Stdout;
+  message: string;
+  skip?: boolean;
+  signal?: AbortSignal;
+}
+//#endregion
+//#region src/prompts/question.d.ts
+interface QuestionOptions<T = string> extends AbstractPromptOptions {
+  defaultValue?: string;
+  validators?: PromptValidator<string>[];
+  transformer?: PromptTransformer<T>;
+  secure?: boolean | {
+    placeholder: string;
+  };
+}
+//#endregion
+//#region src/prompts/confirm.d.ts
+interface ConfirmOptions extends AbstractPromptOptions {
+  initial?: boolean;
+}
+//#endregion
+//#region src/prompts/select.d.ts
+interface SelectOptions<T extends string> extends AbstractPromptOptions {
+  choices: (Choice<T> | T | Separator)[];
+  maxVisible?: number;
+  ignoreValues?: (T | number | boolean)[];
+  validators?: PromptValidator<string>[];
+  autocomplete?: boolean;
+  caseSensitive?: boolean;
+}
+//#endregion
+//#region src/prompts/multiselect.d.ts
+interface MultiselectOptions<T extends string> extends AbstractPromptOptions {
+  choices: (Choice<T> | T | Separator)[];
+  maxVisible?: number;
+  preSelectedChoices?: (Choice<T> | T)[];
+  validators?: PromptValidator<string[]>[];
+  autocomplete?: boolean;
+  caseSensitive?: boolean;
+  showHint?: boolean;
+}
+//#endregion
+//#region src/index.d.ts
+declare function question<T = string>(message: string, options?: Omit<QuestionOptions<T>, "message">): Promise<T>;
+declare function select<T extends string>(message: string, options: Omit<SelectOptions<T>, "message">): Promise<T>;
+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[]>;
+declare const validators: {
+  required: typeof required;
+};
+declare const transformers: {
+  number: typeof number;
+  integer: typeof integer;
+  url: typeof url;
+};
+//#endregion
+export { type AbstractPromptOptions, type Choice, type ConfirmOptions, type InvalidResponse, type InvalidResponseObject, type MultiselectOptions, PromptAgent, type PromptTransformer, type PromptValidator, type QuestionOptions, type SelectOptions, type Separator, type TransformationResponse, type ValidResponse, type ValidResponseObject, type ValidTransformationResponse, type ValidationResponse, type ValidationResponseObject, confirm, multiselect, question, select, transformers, validators };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/validators.ts","../src/prompt-agent.ts","../src/transformers.ts","../src/types.ts","../src/prompts/abstract.ts","../src/prompts/question.ts","../src/prompts/confirm.ts","../src/prompts/select.ts","../src/prompts/multiselect.ts","../src/index.ts"],"mappings":";;;;KAAY,mBAAA;EACV,OAAA;AAAA;AAAA,KAEU,qBAAA;EACV,OAAA;EACA,KAAA;AAAA;AAAA,KAEU,wBAAA,GAA2B,mBAAA,GAAsB,qBAAA;AAAA,KACjD,kBAAA,GAAqB,eAAA,GAAkB,aAAA;AAAA,KACvC,eAAA,YAA2B,qBAAA;AAAA,KAC3B,aAAA,6BAA0C,mBAAA;AAAA,KAE1C,2BAAA;EACV,OAAA;EACA,WAAA,EAAa,CAAA;AAAA;AAAA,KAEH,sBAAA,MAA4B,eAAA,GAAkB,2BAAA,CAA4B,CAAA;AAAA,UAErE,eAAA;EACf,QAAA,GAAW,KAAA,EAAO,CAAA,KAAM,kBAAA,GAAqB,OAAA,CAAQ,kBAAA;AAAA;AAAA,UAGtC,iBAAA;EACf,SAAA,GAAY,KAAA,aAAkB,sBAAA,CAAuB,CAAA,IAAK,OAAA,CAAQ,sBAAA,CAAuB,CAAA;AAAA;AAAA,iBAG3E,QAAA,CAAA,GAAY,eAAA;;;cCvBf,WAAA;EAAA;;;ADHb;;ECQE,WAAA,EAAa,CAAA;EAAA,OAON,KAAA,GAAA,CAAA,GAAO,WAAA,CAAA,CAAA;cAKF,UAAA;EDjBF;;;;;AAIZ;;;;;AACA;;;;ECgCE,UAAA,CAAW,KAAA,EAAO,CAAA;AAAA;;;iBCrCJ,MAAA,CAAA,GAAU,iBAAA;AAAA,iBAiBV,OAAA,CAAA,GAAW,iBAAA;AAAA,iBAiBX,GAAA,CAAA,GAAO,iBAAA,CAAkB,GAAA;;;UCrCxB,MAAA;EACf,KAAA,EAAO,CAAA;EACP,KAAA;EACA,WAAA;EACA,QAAA;AAAA;AAAA,UAGe,SAAA;EACf,IAAA;EACA,KAAA;AAAA;;;KCOG,KAAA,GAAQ,MAAA,CAAO,UAAA;EAClB,EAAA;AAAA;AAAA,KAGG,MAAA,GAAS,MAAA,CAAO,WAAA;EACnB,EAAA;AAAA;AAAA,UAGe,qBAAA;EACf,KAAA,GAAQ,KAAA;EACR,MAAA,GAAS,MAAA;EACT,OAAA;EACA,IAAA;EACA,MAAA,GAAS,WAAA;AAAA;;;UCXM,eAAA,qBAAoC,qBAAA;EACnD,YAAA;EACA,UAAA,GAAa,eAAA;EACb,WAAA,GAAc,iBAAA,CAAkB,CAAA;EAChC,MAAA;IACE,WAAA;EAAA;AAAA;;;UCba,cAAA,SAAuB,qBAAA;EACtC,OAAA;AAAA;;;UCIe,aAAA,2BAAwC,qBAAA;EACvD,OAAA,GAAU,MAAA,CAAO,CAAA,IAAK,CAAA,GAAI,SAAA;EAC1B,UAAA;EACA,YAAA,IAAgB,CAAA;EAChB,UAAA,GAAa,eAAA;EACb,YAAA;EACA,aAAA;AAAA;;;UCPe,kBAAA,2BAA6C,qBAAA;EAC5D,OAAA,GAAU,MAAA,CAAO,CAAA,IAAK,CAAA,GAAI,SAAA;EAC1B,UAAA;EACA,kBAAA,IAAsB,MAAA,CAAO,CAAA,IAAK,CAAA;EAClC,UAAA,GAAa,eAAA;EACb,YAAA;EACA,aAAA;EACA,QAAA;AAAA;;;iBCcoB,QAAA,YAAA,CACpB,OAAA,UACA,OAAA,GAAS,IAAA,CAAK,eAAA,CAAgB,CAAA,gBAC7B,OAAA,CAAQ,CAAA;AAAA,iBAuBW,MAAA,kBAAA,CACpB,OAAA,UACA,OAAA,EAAS,IAAA,CAAK,aAAA,CAAc,CAAA,gBAC3B,OAAA,CAAQ,CAAA;AAAA,iBAuBW,OAAA,CACpB,OAAA,UACA,OAAA,GAAS,IAAA,CAAK,cAAA,eACb,OAAA;AAAA,iBAuBmB,WAAA,kBAAA,CACpB,OAAA,UACA,OAAA,EAAS,IAAA,CAAK,kBAAA,CAAmB,CAAA,gBAChC,OAAA,CAAQ,CAAA;AAAA,cAiDE,UAAA;mBAAyB,QAAA;AAAA;AAAA,cACzB,YAAA"}