@shell-shock/preset-cli 0.5.1 → 0.7.0

package/dist/components/prompts-builtin.mjs

@@ -1,13 +1,14 @@
 import { createComponent, createIntrinsic, memo, mergeProps } from "@alloy-js/core/jsx-runtime";
 import { Show, code, splitProps } from "@alloy-js/core";
 import { FunctionDeclaration, VarDeclaration } from "@alloy-js/typescript";
-import { useTheme } from "@shell-shock/preset-script/contexts/theme";
 import { Spacing } from "@powerlines/plugin-alloy/core/components/spacing";
-import defu from "defu";
 import { BuiltinFile } from "@powerlines/plugin-alloy/typescript/components/builtin-file";
+import defu from "defu";
+import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import { TSDoc, TSDocDefaultValue, TSDocExample, TSDocParam, TSDocRemarks, TSDocReturns } from "@powerlines/plugin-alloy/typescript/components/tsdoc";
+import { useTheme } from "@shell-shock/preset-script/contexts/theme";
 import { ClassDeclaration, ClassField, ClassMethod, ClassPropertyGet } from "@powerlines/plugin-alloy/typescript/components/class-declaration";
-import { InterfaceDeclaration, InterfaceMember } from "@powerlines/plugin-alloy/typescript/components/interface-declaration";
-import { TSDoc, TSDocExample, TSDocParam, TSDocRemarks, TSDocReturns } from "@powerlines/plugin-alloy/typescript/components/tsdoc";
+import { InterfaceDeclaration as InterfaceDeclaration$1, InterfaceMember } from "@powerlines/plugin-alloy/typescript/components/interface-declaration";
 import { TypeDeclaration } from "@powerlines/plugin-alloy/typescript/components/type-declaration";
 
 //#region src/components/prompts-builtin.tsx
@@ -83,7 +84,7 @@ function BasePromptDeclarations() {
 			children: code`return " ".repeat(input.length); `
 		}),
 		createComponent(Spacing, {}),
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			"export": true,
 			name: "PromptState",
 			doc: "The current state of a prompt",
@@ -134,9 +135,9 @@ function BasePromptDeclarations() {
 			}
 		}),
 		createComponent(Spacing, {}),
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			name: "PromptConfig",
-			doc: "Configuration options for configuring a prompt",
+			doc: "Configuration options for creating a prompt",
 			typeParameters: [{
 				name: "TValue",
 				default: "string"
@@ -180,7 +181,7 @@ function BasePromptDeclarations() {
 					createComponent(InterfaceMember, {
 						name: "validate",
 						optional: true,
-						type: "(value: TValue) => boolean | string | null | undefined | Promise<boolean | string | null | undefined>",
+						type: "(value: TValue) => boolean | string | { type: 'error' | 'warning'; message: string } | null | undefined | Promise<boolean | string | { type: 'error' | 'warning'; message: string } | null | undefined>",
 						doc: "A validation function that returns true if the input is valid, false or a string error message if the input is invalid"
 					}),
 					createComponent(Spacing, {}),
@@ -202,7 +203,14 @@ function BasePromptDeclarations() {
 						name: "mask",
 						optional: true,
 						type: "(input: string) => string",
-						doc: "A function that masks the input value and returns the masked result or throws an error if the input is invalid"
+						doc: "A function that masks the input value and returns the masked result. This can be used to create password inputs or other sensitive input types where the actual input value should not be displayed. If not provided, the prompt will display the input as is without masking."
+					}),
+					createComponent(Spacing, {}),
+					createComponent(InterfaceMember, {
+						name: "maskSubmitted",
+						optional: true,
+						type: "(input: string) => string",
+						doc: "A function that masks the value submitted by the user so that it can then be used in the console output or elsewhere without exposing sensitive information. If not provided, the prompt will use the same mask function for both input and submitted value masking."
 					}),
 					createComponent(Spacing, {}),
 					createComponent(InterfaceMember, {
@@ -299,7 +307,7 @@ function BasePromptDeclarations() {
 						name: "defaultErrorMessage",
 						"protected": true,
 						type: "string",
-						children: code`"Invalid value provided"; `
+						children: code`"An invalid value was provided"; `
 					}),
 					createIntrinsic("hbr", {}),
 					createComponent(ClassField, {
@@ -318,6 +326,7 @@ function BasePromptDeclarations() {
 					createIntrinsic("hbr", {}),
 					createComponent(ClassField, {
 						name: "isInitial",
+						"protected": true,
 						type: "boolean",
 						children: code`true; `
 					}),
@@ -371,6 +380,12 @@ function BasePromptDeclarations() {
 						children: code`noMask; `
 					}),
 					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "maskSubmitted",
+						"protected": true,
+						type: "(input: string) => string"
+					}),
+					createIntrinsic("hbr", {}),
 					createComponent(ClassField, {
 						name: "cursor",
 						"protected": true,
@@ -384,6 +399,13 @@ function BasePromptDeclarations() {
 						type: "number",
 						children: code`0; `
 					}),
+					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "cursorHidden",
+						"protected": true,
+						type: "boolean",
+						children: code`false; `
+					}),
 					createComponent(Spacing, {}),
 					code`constructor(protected config: PromptConfig<TValue>) {
           super();
@@ -410,6 +432,16 @@ function BasePromptDeclarations() {
             this.formatter = config.format.bind(this);
           }
 
+          if (config.maskSubmitted) {
+            this.maskSubmitted = config.maskSubmitted;
+          }
+          if (config.mask) {
+            this.mask = config.mask;
+          }
+          if (!this.maskSubmitted) {
+            this.maskSubmitted = this.mask;
+          }
+
           if (config.timeout !== undefined && !Number.isNaN(config.timeout)) {
             setTimeout(() => {
               if (!this.isCompleted) {
@@ -499,7 +531,7 @@ function BasePromptDeclarations() {
             updatedValue = value;
           }
 
-          this.displayValue = this.formatter(updatedValue);
+          this.displayValue = this.mask(this.formatter(updatedValue));
           this.#value = updatedValue;
           setTimeout(() => {
             Promise.resolve(this.validate(updatedValue)).then(() => this.sync());
@@ -709,6 +741,8 @@ function BasePromptDeclarations() {
             }
 
             this.output.write(clear(this.consoleOutput, this.output.columns));
+          } else if (this.cursorHidden) {
+            this.output.write(cursor.hide);
           }
 
           this.consoleOutput = \` \${
@@ -751,7 +785,7 @@ function BasePromptDeclarations() {
             : this.isError
               ? colors.text.prompt.input.error(this.displayValue)
               : this.isSubmitted
-                ? colors.text.prompt.input.submitted(this.displayValue)
+                ? colors.text.prompt.input.submitted(this.maskSubmitted(this.displayValue))
                 : this.isCancelled
                   ? colors.text.prompt.input.cancelled(this.displayValue)
               : colors.bold(colors.text.prompt.input.active(this.displayValue)); `
@@ -760,7 +794,7 @@ function BasePromptDeclarations() {
 			}
 		}),
 		createComponent(Spacing, {}),
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			name: "PromptFactoryConfig",
 			"extends": "PromptConfig<TValue>",
 			doc: "Configuration options for creating a prompt with a prompt factory function",
@@ -794,10 +828,10 @@ function BasePromptDeclarations() {
 			}
 		}),
 		createComponent(Spacing, {}),
+		createComponent(TSDoc, { heading: "A unique symbol used to indicate that a prompt was cancelled, which can be returned from a prompt function to signal that the prompt interaction should be cancelled and any pending promises should be rejected with this symbol. This allows for a consistent way to handle prompt cancellations across different prompt types and interactions." }),
 		createComponent(VarDeclaration, {
 			"export": true,
 			name: "CANCEL_SYMBOL",
-			doc: "A unique symbol used to indicate that a prompt was cancelled, which can be returned from a prompt function to signal that the prompt interaction should be cancelled and any pending promises should be rejected with this symbol. This allows for a consistent way to handle prompt cancellations across different prompt types and interactions.",
 			children: code`Symbol("shell-shock:prompts:cancel"); `
 		}),
 		createComponent(Spacing, {}),
@@ -827,10 +861,10 @@ function BasePromptDeclarations() {
 */
 function TextPromptDeclarations() {
 	return [
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			name: "StringPromptConfig",
 			"extends": "PromptConfig<string>",
-			doc: "Configuration options for configuring a text-based prompt",
+			doc: "Configuration options for creating a text-based prompt",
 			get children() {
 				return [
 					createComponent(InterfaceMember, {
@@ -880,6 +914,7 @@ function TextPromptDeclarations() {
 
           this.cursor = 0;
           this.sync();
+          this.first();
         } `,
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
@@ -1149,7 +1184,7 @@ run(); ` }),
 */
 function SelectPromptDeclarations() {
 	return [
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			name: "PromptOptionConfig",
 			doc: "Configuration for an option the user can select from the select prompt",
 			typeParameters: [{
@@ -1202,7 +1237,7 @@ function SelectPromptDeclarations() {
 			}
 		}),
 		createComponent(Spacing, {}),
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			"export": true,
 			name: "PromptOption",
 			"extends": "PromptOptionConfig<TValue>",
@@ -1239,7 +1274,7 @@ function SelectPromptDeclarations() {
 			}
 		}),
 		createComponent(Spacing, {}),
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			name: "SelectPromptConfig",
 			"extends": "PromptConfig<TValue>",
 			doc: "An options object for configuring a select prompt",
@@ -1302,6 +1337,14 @@ function SelectPromptDeclarations() {
 						type: "PromptOption<TValue>[]",
 						children: code`[]; `
 					}),
+					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "cursorHidden",
+						"protected": true,
+						override: true,
+						type: "boolean",
+						children: code`true; `
+					}),
 					createComponent(Spacing, {}),
 					code`constructor(config: SelectPromptConfig<TValue>) {
           super(config);
@@ -1476,11 +1519,7 @@ function SelectPromptDeclarations() {
 						name: "render",
 						override: true,
 						"protected": true,
-						children: code`if (this.isInitial) {
-            this.output.write(cursor.hide);
-          }
-
-          const spacing = Math.max(...this.options.map(option => option.label?.length || 0)) + 2;
+						children: code`const spacing = Math.max(...this.options.map(option => option.label?.length || 0)) + 2;
 
           const startIndex = Math.max(Math.min(this.options.length - this.optionsPerPage, this.cursor - Math.floor(this.optionsPerPage / 2)), 0);
           const endIndex = Math.min(startIndex + this.optionsPerPage, this.options.length);
@@ -1609,10 +1648,10 @@ run(); ` }),
 */
 function NumericPromptDeclarations() {
 	return [
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			name: "NumberPromptConfig",
 			"extends": "PromptConfig<number>",
-			doc: "Configuration options for configuring a numeric prompt",
+			doc: "Configuration options for creating a numeric prompt",
 			get children() {
 				return [
 					createComponent(InterfaceMember, {
@@ -1659,6 +1698,13 @@ function NumericPromptDeclarations() {
 			"extends": "Prompt<number>",
 			get children() {
 				return [
+					createComponent(ClassField, {
+						name: "isInvalid",
+						isPrivateMember: true,
+						type: "boolean",
+						children: code`false; `
+					}),
+					createComponent(Spacing, {}),
 					createComponent(ClassField, {
 						name: "initialValue",
 						"protected": true,
@@ -1667,6 +1713,14 @@ function NumericPromptDeclarations() {
 						children: code`0; `
 					}),
 					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "defaultErrorMessage",
+						"protected": true,
+						override: true,
+						type: "string",
+						children: code`"A valid numeric value must be provided"; `
+					}),
+					createIntrinsic("hbr", {}),
 					createComponent(ClassField, {
 						name: "isFloat",
 						"protected": true,
@@ -1752,6 +1806,7 @@ function NumericPromptDeclarations() {
           }
 
           this.sync();
+          this.last();
         } `,
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
@@ -1762,14 +1817,6 @@ function NumericPromptDeclarations() {
 						children: code`super.reset();
           this.currentInput = "";
           `
-					}),
-					createComponent(Spacing, {}),
-					createComponent(ClassMethod, {
-						doc: "A method to move the cursor to the end of the input",
-						name: "next",
-						"protected": true,
-						children: code`this.changeValue(this.initialValue);
-          this.sync(); `
 					}),
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
@@ -1793,18 +1840,12 @@ function NumericPromptDeclarations() {
             return this.bell();
           }
 
-          if (Date.now() - this.inputTimestamp > 1000) {
-            this.currentInput = "";
-          }
-
-          this.currentInput += char;
-          this.inputTimestamp = Date.now();
-
-          if (char === ".") {
+          this.displayValue += char;
+          if ((char === "-" || char === ".") && this.displayValue.length === 1) {
             return this.sync();
           }
 
-          let value = Math.min(this.parser(this.currentInput), this.max);
+          let value = Math.min(this.parser(this.displayValue), this.max);
           if (value > this.max) {
             value = this.max;
           }
@@ -1813,6 +1854,14 @@ function NumericPromptDeclarations() {
           }
 
           this.changeValue(value);
+          this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to move the cursor to the end of the input",
+						name: "next",
+						"protected": true,
+						children: code`this.changeValue(this.initialValue);
           this.sync(); `
 					}),
 					createComponent(Spacing, {}),
@@ -1820,14 +1869,10 @@ function NumericPromptDeclarations() {
 						doc: "A method to move the cursor to the up",
 						name: "up",
 						"protected": true,
-						children: code`this.currentInput = "";
-
-          let value = this.value;
+						children: code`let value = this.value;
           if (this.displayValue === "") {
-            value = this.min === Number.NEGATIVE_INFINITY ? 0 - this.increment : this.min - this.increment;
-          }
-
-          if (value >= this.max) {
+            value = this.min < 0 ? 0 : this.min;
+          } else if (value >= this.max) {
             return this.bell();
           }
 
@@ -1839,36 +1884,134 @@ function NumericPromptDeclarations() {
 						doc: "A method to move the cursor to the down",
 						name: "down",
 						"protected": true,
-						children: code`this.currentInput = "";
+						children: code`let value = this.value;
+          if (this.displayValue === "") {
+            value = this.min < 0 ? 0 : this.min;
+          } else if (value <= this.min) {
+            return this.bell();
+          }
 
-          let value = this.value;
-          if(this.displayValue === "") {
-            value = this.min === Number.NEGATIVE_INFINITY ? 0 + this.increment : this.min + this.increment;
+          this.changeValue(value === this.min ? this.min : value - this.increment);
+          this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to move the cursor to the left",
+						name: "left",
+						"protected": true,
+						children: code`if (this.cursor <= 0 || this.isPlaceholder) {
+            return this.bell();
           }
 
-          if (value <= this.min) {
+          this.moveCursor(-1);
+          this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to move the cursor to the right",
+						name: "right",
+						"protected": true,
+						children: code`if (this.cursor >= this.displayValue.length || this.isPlaceholder) {
             return this.bell();
           }
 
-          this.changeValue(value - this.increment);
+          this.moveCursor(1);
           this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to move the cursor to the left or right by a \\`count\\` of positions",
+						name: "moveCursor",
+						parameters: [{
+							name: "count",
+							type: "number"
+						}],
+						"protected": true,
+						children: code`if (this.isPlaceholder) {
+            return;
+          }
+
+          this.cursor = this.cursor + count;
+          this.cursorOffset += count; `
 					}),
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
 						doc: "A method to delete the character backward of the cursor",
 						name: "delete",
 						"protected": true,
-						children: code`if (this.displayValue === "") {
+						children: code`if (this.isCursorAtStart()) {
             return this.bell();
           }
 
-          let value = this.parser(this.displayValue.slice(0, -1));
-          if (value < this.min) {
-            value = this.min === Number.NEGATIVE_INFINITY ? 0 : this.min;
+          if (this.displayValue === "") {
+            return this.bell();
+          }
+
+          this.changeValue(\`\${this.displayValue.slice(0, this.cursor - 1)}\${this.displayValue.slice(this.cursor)}\`);
+          this.#isInvalid = false;
+
+          if (this.isCursorAtStart()) {
+            this.cursorOffset = 0
+          } else {
+            this.cursorOffset++;
+            this.moveCursor(-1);
           }
 
-          this.changeValue(value);
           this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to delete the character forward of the cursor",
+						name: "deleteForward",
+						"protected": true,
+						children: code`if (this.cursor >= this.displayValue.length || this.isPlaceholder) {
+            return this.bell();
+          }
+
+          this.changeValue(\`\${
+            this.displayValue.slice(0, this.cursor)
+          }\${
+            this.displayValue.slice(this.cursor + 1)
+          }\`);
+          this.#isInvalid = false;
+
+          if (this.isCursorAtEnd()) {
+            this.cursorOffset = 0;
+          } else {
+            this.cursorOffset++;
+          }
+
+          this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to move the cursor to the start",
+						name: "first",
+						"protected": true,
+						children: code`this.cursor = 0;
+          this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to move the cursor to the end",
+						name: "last",
+						"protected": true,
+						children: code`this.cursor = this.displayValue.length;
+          this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to check if the cursor is at the start",
+						name: "isCursorAtStart",
+						"protected": true,
+						children: code`return this.cursor === 0 || (this.isPlaceholder && this.cursor === 1); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to check if the cursor is at the end",
+						name: "isCursorAtEnd",
+						"protected": true,
+						children: code`return this.cursor === this.displayValue.length || (this.isPlaceholder && this.cursor === this.displayValue.length + 1); `
 					})
 				];
 			}
@@ -1934,11 +2077,11 @@ run(); ` }),
 */
 function TogglePromptDeclarations() {
 	return [
-		createComponent(InterfaceDeclaration, {
+		createComponent(InterfaceDeclaration$1, {
 			"export": true,
 			name: "TogglePromptConfig",
 			"extends": "PromptConfig<boolean>",
-			doc: "Configuration options for configuring a boolean toggle prompt",
+			doc: "Configuration options for creating a boolean toggle prompt",
 			get children() {
 				return [
 					createComponent(InterfaceMember, {
@@ -1962,7 +2105,7 @@ function TogglePromptDeclarations() {
 		createComponent(ClassDeclaration, {
 			"export": true,
 			name: "TogglePrompt",
-			doc: "A prompt for selecting a boolean input",
+			doc: "A prompt for toggling a boolean input",
 			"extends": "Prompt<boolean>",
 			get children() {
 				return [
@@ -1987,6 +2130,14 @@ function TogglePromptDeclarations() {
 						type: "string",
 						children: code`"No"; `
 					}),
+					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "cursorHidden",
+						"protected": true,
+						override: true,
+						type: "boolean",
+						children: code`true; `
+					}),
 					createComponent(Spacing, {}),
 					code`constructor(config: TogglePromptConfig) {
           super(config);
@@ -2100,6 +2251,23 @@ function TogglePromptDeclarations() {
 						"protected": true,
 						children: code`this.changeValue(!this.value);
           this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to render the prompt",
+						name: "render",
+						override: true,
+						"protected": true,
+						returnType: "string",
+						children: code`return this.isSubmitted
+              ? colors.text.prompt.input.submitted(this.value ? this.trueMessage : this.falseMessage)
+              : this.isCancelled
+                ? colors.text.prompt.input.cancelled(this.value ? this.trueMessage : this.falseMessage)
+            : \`\${
+                this.value ? colors.text.prompt.input.inactive(this.falseMessage) : colors.underline(colors.bold(colors.text.prompt.input.active(this.falseMessage)))
+            } \${colors.border.app.divider.tertiary("/")} \${
+                this.value ? colors.underline(colors.bold(colors.text.prompt.input.active(this.trueMessage))) : colors.text.prompt.input.inactive(this.trueMessage)
+            }\`; `
 					})
 				];
 			}
@@ -2159,6 +2327,262 @@ run(); ` }),
 	];
 }
 /**
+* A component that renders the declarations for the built-in confirm prompt, which allows users to select a boolean value (true/false) with support for custom messages for the true and false states. This prompt type can be used for scenarios where the user needs to toggle a setting on or off, such as enabling or disabling a feature. The ConfirmPrompt class extends the base Prompt class and implements specific logic for handling boolean input and rendering interactions.
+*/
+function ConfirmPromptDeclarations() {
+	return [
+		createComponent(InterfaceDeclaration$1, {
+			"export": true,
+			name: "ConfirmPromptConfig",
+			"extends": "PromptConfig<boolean>",
+			doc: "Configuration options for creating a boolean confirm prompt",
+			get children() {
+				return [
+					createComponent(TSDoc, {
+						heading: "The message for the \\`Yes\\` state of the prompt",
+						get children() {
+							return createComponent(TSDocDefaultValue, {
+								get type() {
+									return ReflectionKind.string;
+								},
+								defaultValue: "Yes"
+							});
+						}
+					}),
+					createComponent(InterfaceMember, {
+						name: "yesMessage",
+						optional: true,
+						type: "string"
+					}),
+					createComponent(Spacing, {}),
+					createComponent(TSDoc, {
+						heading: "The \\`Yes\\` option when choosing between yes/no",
+						get children() {
+							return createComponent(TSDocDefaultValue, {
+								get type() {
+									return ReflectionKind.string;
+								},
+								defaultValue: "1"
+							});
+						}
+					}),
+					createComponent(InterfaceMember, {
+						name: "yesOption",
+						optional: true,
+						type: "string"
+					}),
+					createComponent(Spacing, {}),
+					createComponent(TSDoc, {
+						heading: "The message for the \\`No\\` state of the prompt",
+						get children() {
+							return createComponent(TSDocDefaultValue, {
+								get type() {
+									return ReflectionKind.string;
+								},
+								defaultValue: "(Y/n)"
+							});
+						}
+					}),
+					createComponent(InterfaceMember, {
+						name: "noMessage",
+						optional: true,
+						type: "string"
+					}),
+					createComponent(Spacing, {}),
+					createComponent(TSDoc, {
+						heading: "The \\`No\\` option when choosing between yes/no",
+						get children() {
+							return createComponent(TSDocDefaultValue, {
+								get type() {
+									return ReflectionKind.string;
+								},
+								defaultValue: "(y/N)"
+							});
+						}
+					}),
+					createComponent(InterfaceMember, {
+						name: "noOption",
+						optional: true,
+						type: "string"
+					})
+				];
+			}
+		}),
+		createComponent(Spacing, {}),
+		createComponent(ClassDeclaration, {
+			"export": true,
+			name: "ConfirmPrompt",
+			doc: "A prompt for confirming a boolean input",
+			"extends": "Prompt<boolean>",
+			get children() {
+				return [
+					createComponent(ClassField, {
+						name: "initialValue",
+						"protected": true,
+						override: true,
+						type: "boolean",
+						children: code`false; `
+					}),
+					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "yesMessage",
+						"protected": true,
+						type: "string",
+						children: code`"Yes"; `
+					}),
+					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "yesOption",
+						"protected": true,
+						type: "string",
+						children: code`"(Y/n)"; `
+					}),
+					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "noMessage",
+						"protected": true,
+						type: "string",
+						children: code`"No"; `
+					}),
+					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "noOption",
+						"protected": true,
+						type: "string",
+						children: code`"(y/N)"; `
+					}),
+					createIntrinsic("hbr", {}),
+					createComponent(ClassField, {
+						name: "cursorHidden",
+						"protected": true,
+						override: true,
+						type: "boolean",
+						children: code`true; `
+					}),
+					createComponent(Spacing, {}),
+					code`constructor(config: ConfirmPromptConfig) {
+          super(config);
+
+          if (config.initialValue) {
+            this.initialValue = config.initialValue;
+          }
+
+          if (config.yesMessage) {
+            this.yesMessage = config.yesMessage;
+          }
+          if (config.yesOption) {
+            this.yesOption = config.yesOption;
+          }
+          if (config.noMessage) {
+            this.noMessage = config.noMessage;
+          }
+          if (config.noOption) {
+            this.noOption = config.noOption;
+          }
+
+          this.sync();
+        } `,
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to handle keypress events and determine the corresponding action",
+						name: "keypress",
+						override: true,
+						"protected": true,
+						parameters: [{
+							name: "char",
+							type: "string"
+						}, {
+							name: "key",
+							type: "readline.Key"
+						}],
+						children: code`const action = this.getAction(key);
+          if (action && typeof (this as any)[action] === "function") {
+            return (this as any)[action]();
+          }
+
+          if (char.toLowerCase() === "y" || char.toLowerCase() === "t" || char.toLowerCase() === "0") {
+            this.value = true;
+            return this.submit();
+          } else if (char.toLowerCase() === "n" || char.toLowerCase() === "f" || char.toLowerCase() === "1") {
+            this.value = false;
+            return this.submit();
+          } else {
+            return this.bell();
+          }
+
+          this.sync(); `
+					}),
+					createComponent(Spacing, {}),
+					createComponent(ClassMethod, {
+						doc: "A method to render the prompt",
+						name: "render",
+						override: true,
+						"protected": true,
+						returnType: "string",
+						children: code`return this.isSubmitted
+              ? colors.text.prompt.input.submitted(this.value ? this.yesMessage : this.noMessage)
+              : this.isCancelled
+                ? colors.text.prompt.input.cancelled(this.value ? this.yesMessage : this.noMessage)
+            : colors.text.prompt.input.inactive(this.initialValue ? this.yesOption : this.noOption); `
+					})
+				];
+			}
+		}),
+		createComponent(Spacing, {}),
+		createComponent(TSDoc, { heading: "An object representing the configuration options for a confirm prompt, which extends the base PromptFactoryConfig with additional options specific to the confirm prompt." }),
+		createComponent(TypeDeclaration, {
+			name: "ConfirmConfig",
+			"export": true,
+			children: code`PromptFactoryConfig<boolean> & ConfirmPromptConfig; `
+		}),
+		createComponent(Spacing, {}),
+		createComponent(TSDoc, {
+			heading: "A function to create and run a confirm prompt, which returns a promise that resolves with the submitted value or rejects with a {@link CANCEL_SYMBOL | cancel symbol} if the prompt is cancelled.",
+			get children() {
+				return [
+					createComponent(TSDocExample, { children: `import { confirm, isCancel } from "shell-shock:prompts";
+
+async function run() {
+  const likesIceCream = await confirm({
+    message: "Do you like ice cream?"
+  });
+  if (isCancel(likesIceCream)) {
+    console.log("Prompt was cancelled");
+    return;
+  }
+
+  console.log("You" + (likesIceCream ? " like ice cream" : " don't like ice cream") + "!");
+}
+
+run(); ` }),
+					createComponent(Spacing, {}),
+					createComponent(TSDocParam, {
+						name: "config",
+						children: `The configuration options to pass to the confirm prompt, which extends the base PromptFactoryConfig with additional options specific to the confirm prompt`
+					}),
+					createComponent(TSDocReturns, { children: `A promise that resolves with the submitted value or rejects with a {@link CANCEL_SYMBOL | cancel symbol} if the prompt is cancelled` })
+				];
+			}
+		}),
+		createComponent(FunctionDeclaration, {
+			name: "confirm",
+			"export": true,
+			parameters: [{
+				name: "config",
+				type: "ConfirmConfig"
+			}],
+			returnType: "Promise<boolean | symbol>",
+			children: code`return new Promise<boolean | symbol>((response, reject) => {
+            const prompt = new ConfirmPrompt(config);
+
+            prompt.on("state", state => config.onState?.(state));
+            prompt.on("submit", value => response(value));
+            prompt.on("cancel", event => reject(CANCEL_SYMBOL));
+          }); `
+		})
+	];
+}
+/**
 * Declarations for a password prompt that allows users to input and edit text, with support for cursor movement, deletion, and custom masking. This prompt type can be used for various text input scenarios, such as entering a password or any other string input. The PasswordPrompt class extends the base Prompt class and implements specific logic for handling password input and editing interactions.
 */
 function PasswordPromptDeclaration() {
@@ -2179,7 +2603,7 @@ function PasswordPromptDeclaration() {
 		createComponent(TypeDeclaration, {
 			name: "PasswordConfig",
 			"export": true,
-			children: code`Omit<TextConfig, "mask">; `
+			children: code`Omit<TextConfig, "mask" | "maskSubmitted">; `
 		}),
 		createComponent(Spacing, {}),
 		createComponent(TSDoc, {
@@ -2222,7 +2646,8 @@ run(); ` }),
 			returnType: "Promise<string | symbol>",
 			children: code`return text({
             ...config,
-            mask: passwordMask
+            mask: passwordMask,
+            maskSubmitted: () => "*******"
           });`
 		})
 	];
@@ -2234,7 +2659,7 @@ function PromptsBuiltin(props) {
 	const [{ children }, rest] = splitProps(props, ["children"]);
 	return createComponent(BuiltinFile, mergeProps({
 		id: "prompts",
-		description: "A collection of prompts that allow for interactive input in command line applications."
+		description: "A collection of prompts that allow for interactive input in command-line applications."
 	}, rest, {
 		get imports() {
 			return defu(rest.imports ?? {}, {
@@ -2278,6 +2703,8 @@ function PromptsBuiltin(props) {
 				createComponent(Spacing, {}),
 				createComponent(PasswordPromptDeclaration, {}),
 				createComponent(Spacing, {}),
+				createComponent(ConfirmPromptDeclarations, {}),
+				createComponent(Spacing, {}),
 				createComponent(Show, {
 					get when() {
 						return Boolean(children);
@@ -2290,5 +2717,5 @@ function PromptsBuiltin(props) {
 }
 
 //#endregion
-export { BasePromptDeclarations, NumericPromptDeclarations, PasswordPromptDeclaration, PromptsBuiltin, SelectPromptDeclarations, TextPromptDeclarations, TogglePromptDeclarations };
+export { BasePromptDeclarations, ConfirmPromptDeclarations, NumericPromptDeclarations, PasswordPromptDeclaration, PromptsBuiltin, SelectPromptDeclarations, TextPromptDeclarations, TogglePromptDeclarations };
 //# sourceMappingURL=prompts-builtin.mjs.map