@shell-shock/plugin-prompts 0.2.3 → 0.3.1

package/dist/components/prompts-builtin.mjs

@@ -181,7 +181,7 @@ function BasePromptDeclarations() {
 					createComponent(InterfaceMember, {
 						name: "validate",
 						optional: true,
-						type: "(value: TValue) => boolean | string | { type: 'error' | 'warning'; message: string } | null | undefined | Promise<boolean | string | { type: 'error' | 'warning'; message: string } | null | undefined>",
+						type: "(value: TValue) => boolean | string | null | undefined | Promise<boolean | 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, {}),
@@ -367,21 +367,21 @@ function BasePromptDeclarations() {
 					}),
 					createIntrinsic("hbr", {}),
 					createComponent(ClassField, {
-						name: "validator",
+						name: "validate",
 						"protected": true,
 						type: "(value: TValue) => boolean | string | null | undefined | Promise<boolean | string | null | undefined>",
 						children: code`() => true; `
 					}),
 					createIntrinsic("hbr", {}),
 					createComponent(ClassField, {
-						name: "parser",
+						name: "parse",
 						"protected": true,
 						type: "PromptParser<TValue>",
 						children: code`(value: string) => value as TValue; `
 					}),
 					createIntrinsic("hbr", {}),
 					createComponent(ClassField, {
-						name: "formatter",
+						name: "format",
 						"protected": true,
 						type: "PromptFormatter<TValue>",
 						children: code`(value: TValue) => String(value); `
@@ -397,7 +397,8 @@ function BasePromptDeclarations() {
 					createComponent(ClassField, {
 						name: "maskCompleted",
 						"protected": true,
-						type: "(input: string) => string"
+						type: "(input: string) => string",
+						children: code`this.mask; `
 					}),
 					createIntrinsic("hbr", {}),
 					createComponent(ClassField, {
@@ -437,13 +438,13 @@ function BasePromptDeclarations() {
             this.description = config.description;
           }
           if (config.validate) {
-            this.validator = config.validate;
+            this.validate = config.validate;
           }
           if (config.parse) {
-            this.parser = config.parse.bind(this);
+            this.parse = config.parse.bind(this);
           }
           if (config.format) {
-            this.formatter = config.format.bind(this);
+            this.format = config.format.bind(this);
           }
 
           if (config.maskCompleted) {
@@ -452,9 +453,6 @@ function BasePromptDeclarations() {
           if (config.mask) {
             this.mask = config.mask;
           }
-          if (!this.maskCompleted) {
-            this.maskCompleted = this.mask;
-          }
 
           if (config.timeout !== undefined && !Number.isNaN(config.timeout)) {
             setTimeout(() => {
@@ -516,7 +514,7 @@ function BasePromptDeclarations() {
 						"protected": true,
 						name: "isPlaceholder",
 						type: "boolean",
-						children: code`return (this.displayValue === this.formatter(this.parser(this.initialValue)) && !this.#isDirty) || !this.#isKeyPressed; `
+						children: code`return (this.displayValue === this.format(this.initialValue) && !this.#isDirty) || !this.#isKeyPressed; `
 					}),
 					createComponent(Spacing, {}),
 					createComponent(ClassPropertyGet, {
@@ -569,7 +567,7 @@ function BasePromptDeclarations() {
             updatedValue = value;
           }
 
-          this.displayValue = this.mask(this.formatter(updatedValue));
+          this.displayValue = this.mask(this.format(updatedValue));
           this.#value = updatedValue;
 
           if (!this.#isDirty && this.#value !== this.initialValue) {
@@ -578,7 +576,7 @@ function BasePromptDeclarations() {
 
           this.onChange(previousValue);
           setTimeout(() => {
-            Promise.resolve(this.validate(updatedValue)).then(() => this.sync());
+            Promise.resolve(this.checkValidations(updatedValue)).then(() => this.sync());
           }, 0);
 
           this.sync(); `
@@ -675,14 +673,14 @@ function BasePromptDeclarations() {
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
 						doc: "A method to validate the prompt input using the provided validator function, which updates the error message and error state based on the validation result. This method is called whenever the prompt value changes and needs to be validated.",
-						name: "validate",
+						name: "checkValidations",
 						async: true,
 						"protected": true,
 						parameters: [{
 							name: "value",
 							type: "TValue"
 						}],
-						children: code`let result = await this.validator(value);
+						children: code`let result = await this.validate(value);
           if (typeof result === "string") {
             this.errorMessage = result;
           } else if (typeof result === "boolean") {
@@ -759,11 +757,11 @@ function BasePromptDeclarations() {
             return this.bell();
           }
 
-          this.changeValue(\`\${
+          this.changeValue(this.parse(\`\${
             this.displayValue.slice(0, this.cursor - 1)
           }\${
             this.displayValue.slice(this.cursor)
-          }\`);
+          }\`));
 
           if (this.isCursorAtStart) {
             this.cursorOffset = 0;
@@ -783,11 +781,11 @@ function BasePromptDeclarations() {
             return this.bell();
           }
 
-          this.changeValue(\`\${
+          this.changeValue(this.parse(\`\${
             this.displayValue.slice(0, this.cursor)
           }\${
             this.displayValue.slice(this.cursor + 1)
-          }\`);
+          }\`));
 
           if (this.isCursorAtEnd) {
             this.cursorOffset = 0;
@@ -833,7 +831,7 @@ function BasePromptDeclarations() {
 						children: code`this.cursorOffset = 0;
           this.cursor = this.displayValue.length;
 
-          await this.validate(this.value);
+          await this.checkValidations(this.value);
           if (this.isError) {
             this.sync();
             this.bell();
@@ -1084,7 +1082,7 @@ function TextPromptDeclarations() {
 						"protected": true,
 						parameters: [{
 							name: "previousValue",
-							type: "TValue"
+							type: "string"
 						}],
 						children: code`this.#isInvalid = false;
           this.cursor = this.displayValue.slice(0, this.cursor).length + 1; `
@@ -1101,11 +1099,11 @@ function TextPromptDeclarations() {
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
 						doc: "A method to validate the prompt input",
-						name: "validate",
+						name: "checkValidations",
 						override: true,
 						async: true,
 						"protected": true,
-						children: code`await super.validate(this.value);
+						children: code`await super.checkValidations(this.value);
           this.#isInvalid = this.isError; `
 					}),
 					createComponent(Spacing, {}),
@@ -1834,17 +1832,17 @@ function NumericPromptDeclarations() {
           }
 
           if (config.parse) {
-            this.parser = config.parse.bind(this);
+            this.parse = config.parse.bind(this);
           } else {
-            const parser = (value: string) => this.isFloat ? Math.round(Math.pow(10, this.precision) * Number.parseFloat(value)) / Math.pow(10, this.precision) : Number.parseInt(value);
-            this.parser = parser.bind(this);
+            const parse = (value: string) => this.isFloat ? Math.round(Math.pow(10, this.precision) * Number.parseFloat(value)) / Math.pow(10, this.precision) : Number.parseInt(value);
+            this.parse = parse.bind(this);
           }
 
           if (config.validate) {
-            this.validator = config.validate.bind(this);
+            this.validate = config.validate.bind(this);
           } else {
-            const validator = (value: number) => !Number.isNaN(value) && value >= this.min && value <= this.max;
-            this.validator = validator.bind(this);
+            const validate = (value: number) => !Number.isNaN(value) && value >= this.min && value <= this.max;
+            this.validate = validate.bind(this);
           }
 
           this.changeValue(this.initialValue);
@@ -1880,7 +1878,7 @@ function NumericPromptDeclarations() {
             this.displayValue.slice(this.cursor)
           }\`;
 
-          let value = this.parser(displayValue);
+          let value = this.parse(displayValue);
           if (!Number.isNaN(value)) {
 
             value = Math.min(value, this.max);
@@ -1903,7 +1901,7 @@ function NumericPromptDeclarations() {
 						"protected": true,
 						parameters: [{
 							name: "previousValue",
-							type: "TValue"
+							type: "number"
 						}],
 						children: code`this.#isInvalid = false;
           this.cursor = this.displayValue.slice(0, this.cursor).length + 1; `
@@ -1911,11 +1909,11 @@ function NumericPromptDeclarations() {
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
 						doc: "A method to validate the prompt input",
-						name: "validate",
+						name: "checkValidations",
 						override: true,
 						async: true,
 						"protected": true,
-						children: code`await super.validate(this.value);
+						children: code`await super.checkValidations(this.value);
           this.#isInvalid = this.isError; `
 					}),
 					createComponent(Spacing, {}),
@@ -2501,16 +2499,14 @@ function ConfirmPromptDeclarations() {
           }
 
           if (char.toLowerCase() === "y" || char.toLowerCase() === "t" || char.toLowerCase() === "0") {
-            this.value = true;
+            this.changeValue(true);
             return this.submit();
           } else if (char.toLowerCase() === "n" || char.toLowerCase() === "f" || char.toLowerCase() === "1") {
-            this.value = false;
+            this.changeValue(false);
             return this.submit();
           } else {
             return this.bell();
-          }
-
-          this.sync(); `
+          } `
 					}),
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
@@ -2652,6 +2648,50 @@ run(); ` }),
 		})
 	];
 }
+function WaitForKeyPressDeclaration() {
+	return [createComponent(TSDoc, {
+		heading: "A function to create and run a wait-for-key-press prompt, which returns a promise that resolves when any key is pressed or rejects with a {@link CANCEL_SYMBOL | cancel symbol} if the prompt is cancelled.",
+		get children() {
+			return [
+				createComponent(TSDocRemarks, { children: code`This function creates an instance of the Prompt class with a custom onKeyPress handler that resolves the promise when any key is pressed. It sets up event listeners for state updates and cancellation to handle the prompt interactions and return the appropriate results. The wait-for-key-press prompt is useful for scenarios where you want to pause execution until the user presses any key, such as waiting for user input before proceeding with a task.` }),
+				createComponent(Spacing, {}),
+				createComponent(TSDocExample, { children: `import { waitForKeyPress } from "shell-shock:prompts";
+
+async function run() {
+  const result = await waitForKeyPress();
+  console.log("A key was pressed!");
+}
+
+run(); ` }),
+				createComponent(Spacing, {}),
+				createComponent(TSDocParam, {
+					name: "timeout",
+					children: `The amount of time in milliseconds to wait before automatically resolving the prompt, defaults to 2 hours (7200000 ms)`
+				}),
+				createComponent(TSDocReturns, { children: `A promise that resolves when any key is pressed` })
+			];
+		}
+	}), createComponent(FunctionDeclaration, {
+		name: "waitForKeyPress",
+		"export": true,
+		parameters: [{
+			name: "timeout",
+			default: "7200000"
+		}],
+		children: code`process.stdin.setRawMode(true);
+        return new Promise(resolve => process.stdin.once("data", () => {
+          if (timeout >= 0) {
+            setTimeout(() => {
+              process.stdin.setRawMode(false);
+              resolve(void 0);
+            }, timeout);
+          }
+
+          process.stdin.setRawMode(false);
+          resolve(void 0);
+        })); `
+	})];
+}
 /**
 * A built-in prompts module for Shell Shock.
 */
@@ -2705,6 +2745,8 @@ function PromptsBuiltin(props) {
 				createComponent(Spacing, {}),
 				createComponent(ConfirmPromptDeclarations, {}),
 				createComponent(Spacing, {}),
+				createComponent(WaitForKeyPressDeclaration, {}),
+				createComponent(Spacing, {}),
 				createComponent(Show, {
 					get when() {
 						return Boolean(children);
@@ -2717,5 +2759,5 @@ function PromptsBuiltin(props) {
 }
 
 //#endregion
-export { BasePromptDeclarations, ConfirmPromptDeclarations, NumericPromptDeclarations, PasswordPromptDeclaration, PromptsBuiltin, SelectPromptDeclarations, TextPromptDeclarations, TogglePromptDeclarations };
+export { BasePromptDeclarations, ConfirmPromptDeclarations, NumericPromptDeclarations, PasswordPromptDeclaration, PromptsBuiltin, SelectPromptDeclarations, TextPromptDeclarations, TogglePromptDeclarations, WaitForKeyPressDeclaration };
 //# sourceMappingURL=prompts-builtin.mjs.map