@shell-shock/preset-cli 0.4.1 → 0.5.0

package/dist/components/prompts-builtin.mjs

@@ -82,35 +82,6 @@ function BasePromptDeclarations() {
 			returnType: "string",
 			children: code`return " ".repeat(input.length); `
 		}),
-		createComponent(Spacing, {}),
-		code`
-        const DEFAULT_ICONS = process.platform === "win32" ? {
-          arrowUp: "↑",
-          arrowDown: "↓",
-          arrowLeft: "←",
-          arrowRight: "→",
-          radioOn: "(*)",
-          radioOff: "( )",
-          tick: "√",
-          cross: "×",
-          ellipsis: "...",
-          pointerSmall: "»",
-          line: "─",
-          pointer: ">"
-        } : {
-          arrowUp: "↑",
-          arrowDown: "↓",
-          arrowLeft: "←",
-          arrowRight: "→",
-          radioOn: "◉",
-          radioOff: "◯",
-          tick: "✔",
-          cross: "✖",
-          ellipsis: "…",
-          pointerSmall: "›",
-          line: "─",
-          pointer: "❯"
-        }; `,
 		createComponent(Spacing, {}),
 		createComponent(InterfaceDeclaration, {
 			"export": true,
@@ -240,7 +211,13 @@ function BasePromptDeclarations() {
 						type: "string",
 						doc: "The default error message to display when validation fails"
 					}),
-					createComponent(Spacing, {})
+					createComponent(Spacing, {}),
+					createComponent(InterfaceMember, {
+						name: "timeout",
+						optional: true,
+						type: "number",
+						doc: "The timeout duration in milliseconds for the prompt. If none is provided, the prompt will not time out."
+					})
 				];
 			}
 		}),
@@ -275,7 +252,7 @@ function BasePromptDeclarations() {
 						type: "boolean",
 						children: code`false; `
 					}),
-					createIntrinsic("hbr", {}),
+					createComponent(Spacing, {}),
 					createComponent(ClassField, {
 						name: "initialValue",
 						abstract: true,
@@ -433,6 +410,14 @@ function BasePromptDeclarations() {
             this.formatter = config.format.bind(this);
           }
 
+          if (config.timeout !== undefined && !Number.isNaN(config.timeout)) {
+            setTimeout(() => {
+              if (!this.isCompleted) {
+                this.cancel();
+              }
+            }, config.timeout);
+          }
+
           this.message = config.message;
 
           this.#readline = readline.createInterface({
@@ -488,12 +473,12 @@ function BasePromptDeclarations() {
 						"protected": true,
 						name: "status",
 						type: "string",
-						children: code`return this.completed ? "" : \` \\n    \${
+						children: code`return this.isCompleted ? "" : \` \\n    \${
               colors.italic(
                 this.isError
-                  ? colors.text.prompt.description.error(splitText(this.errorMessage, "1/3").join("\\n"))
-                  : this.isCompleted
-                    ? colors.text.prompt.description.active(this.description)
+                  ? colors.text.prompt.description.error(splitText(this.errorMessage, "3/4").join("\\n"))
+                  : this.description
+                    ? colors.text.prompt.description.active(splitText(this.description, "3/4").join("\\n"))
                     : ""
               )
             }\`; `
@@ -812,20 +797,27 @@ function BasePromptDeclarations() {
 		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 factory 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.",
+			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, {}),
+		createComponent(TSDoc, {
+			heading: "A utility function to check if a given value is the {@link CANCEL_SYMBOL | cancel symbol}, which can be used to determine if a prompt interaction was cancelled based on the value returned from a prompt factory function. This function checks if the provided value is strictly equal to the {@link CANCEL_SYMBOL | CANCEL_SYMBOL}, allowing for a consistent way to handle prompt cancellations across different prompt types and interactions.",
+			get children() {
+				return [createComponent(TSDocParam, {
+					name: "value",
+					children: `The value to check.`
+				}), createComponent(TSDocReturns, { children: `A boolean indicating whether the provided value is the {@link CANCEL_SYMBOL | cancel symbol}, which can be used to determine if a prompt interaction was cancelled.` })];
+			}
+		}),
 		createComponent(FunctionDeclaration, {
 			name: "isCancel",
 			"export": true,
-			doc: "Checks if a given value is a {@link CANCEL_SYMBOL | cancel symbol}.",
 			parameters: [{
 				name: "value",
-				type: "any",
-				doc: "The value to check"
+				type: "any"
 			}],
-			returnType: "boolean",
+			returnType: "value is typeof CANCEL_SYMBOL",
 			children: code`return value === CANCEL_SYMBOL; `
 		})
 	];
@@ -874,6 +866,7 @@ function TextPromptDeclarations() {
 					createComponent(ClassField, {
 						name: "initialValue",
 						"protected": true,
+						override: true,
 						type: "string",
 						children: code`""; `
 					}),
@@ -1107,7 +1100,7 @@ function TextPromptDeclarations() {
 			get children() {
 				return [
 					createComponent(TSDocRemarks, { children: code`This function can be used to easily create and run a text prompt without needing to manually create an instance of the TextPrompt class and handle its events. The function accepts a configuration object that extends the base PromptFactoryConfig with additional options specific to text prompts, such as the initial value and mask function. The returned promise allows for easy handling of the prompt result using async/await syntax or traditional promise chaining.` }),
-					createComponent(TSDocExample, { children: `import { text, isCancel } from "shell-shock/prompts";
+					createComponent(TSDocExample, { children: `import { text, isCancel } from "shell-shock:prompts";
 
 async function run() {
   const name = await text({
@@ -1159,6 +1152,10 @@ function SelectPromptDeclarations() {
 		createComponent(InterfaceDeclaration, {
 			name: "PromptOptionConfig",
 			doc: "Configuration for an option the user can select from the select prompt",
+			typeParameters: [{
+				name: "TValue",
+				default: "string"
+			}],
 			get children() {
 				return [
 					createComponent(InterfaceMember, {
@@ -1177,7 +1174,7 @@ function SelectPromptDeclarations() {
 					createComponent(Spacing, {}),
 					createComponent(InterfaceMember, {
 						name: "value",
-						type: "any",
+						type: "TValue",
 						doc: "The value of the option"
 					}),
 					createComponent(Spacing, {}),
@@ -1208,10 +1205,19 @@ function SelectPromptDeclarations() {
 		createComponent(InterfaceDeclaration, {
 			"export": true,
 			name: "PromptOption",
-			"extends": "PromptOptionConfig",
+			"extends": "PromptOptionConfig<TValue>",
 			doc: "An option the user can select from the select prompt",
+			typeParameters: [{
+				name: "TValue",
+				default: "string"
+			}],
 			get children() {
 				return [
+					createComponent(InterfaceMember, {
+						name: "label",
+						type: "string",
+						doc: "The message label for the option"
+					}),
 					createComponent(InterfaceMember, {
 						name: "index",
 						type: "number",
@@ -1235,8 +1241,12 @@ function SelectPromptDeclarations() {
 		createComponent(Spacing, {}),
 		createComponent(InterfaceDeclaration, {
 			name: "SelectPromptConfig",
-			"extends": "PromptConfig<string>",
+			"extends": "PromptConfig<TValue>",
 			doc: "An options object for configuring a select prompt",
+			typeParameters: [{
+				name: "TValue",
+				default: "string"
+			}],
 			get children() {
 				return [
 					createComponent(InterfaceMember, {
@@ -1248,7 +1258,7 @@ function SelectPromptDeclarations() {
 					createComponent(Spacing, {}),
 					createComponent(InterfaceMember, {
 						name: "options",
-						type: "Array<string | PromptOptionConfig>",
+						type: "Array<string | PromptOptionConfig<TValue>>",
 						doc: "The options available for the select prompt"
 					}),
 					createComponent(Spacing, {}),
@@ -1268,13 +1278,14 @@ function SelectPromptDeclarations() {
 			"extends": "Prompt<TValue>",
 			typeParameters: [{
 				name: "TValue",
-				default: "any"
+				default: "string"
 			}],
 			get children() {
 				return [
 					createComponent(ClassField, {
 						name: "initialValue",
 						"protected": true,
+						override: true,
 						type: "TValue"
 					}),
 					createIntrinsic("hbr", {}),
@@ -1288,47 +1299,48 @@ function SelectPromptDeclarations() {
 					createComponent(ClassField, {
 						name: "options",
 						"protected": true,
-						type: "PromptOption[]",
+						type: "PromptOption<TValue>[]",
 						children: code`[]; `
 					}),
 					createComponent(Spacing, {}),
-					code`constructor(config: SelectPromptConfig) {
+					code`constructor(config: SelectPromptConfig<TValue>) {
           super(config);
 
           if (config.initialValue) {
-            this.initialValue = config.initialValue;
+            this.initialValue = config.initialValue as TValue;
+          } else {
+            this.initialValue = undefined as unknown as TValue;
           }
 
-          this.options = config.options.map(opt => {
-            let option!: PromptOption;
+          this.options = config.options.map((opt, index) => {
+            let option = {} as Partial<PromptOption<TValue>>;
             if (typeof opt === "string") {
-              option = { index: -1, label: opt, value: opt, selected: false, disabled: false } as PromptOption;
+              option = { label: opt, value: opt as TValue, selected: false, disabled: false };
             } else if (typeof opt === "object") {
-              option = opt as PromptOption;
+              option = opt;
             } else {
               throw new Error(\`Invalid option provided to SelectPrompt at index #\${index}\`);
             }
 
             return {
-              label: String(option.value),
+              label: String(option.value) || "",
               ...option,
-              index: -1,
               description: option.description,
               selected: !!option.selected || (this.initialValue !== undefined && option.value === this.initialValue),
               disabled: !!option.disabled
-            };
+            } as PromptOption<TValue>;
           }).sort((a, b) => a.label.localeCompare(b.label)).map((option, index) => ({ ...option, index }));
 
           const selected = this.options.findIndex(option => option.selected);
           if (selected > -1) {
             this.cursor = selected;
             if (this.options[this.cursor]) {
-              this.initialValue = this.options[this.cursor].value;
+              this.initialValue = this.options[this.cursor].value as TValue;
             }
           }
 
           if (this.initialValue === undefined && this.options.length > 0 && this.options[0]) {
-            this.initialValue = this.options[0].value;
+            this.initialValue = this.options[0].value as TValue;
           }
 
           if (config.optionsPerPage) {
@@ -1341,9 +1353,9 @@ function SelectPromptDeclarations() {
 					createComponent(ClassPropertyGet, {
 						doc: "Returns the currently selected option",
 						name: "selectedOption",
-						type: "PromptOption | null",
+						type: "PromptOption<TValue> | null",
 						"protected": true,
-						children: code`return this.options[this.cursor] ?? null; `
+						children: code`return this.options.find(option => option.value === this.value) ?? null; `
 					}),
 					createComponent(Spacing, {}),
 					createComponent(ClassMethod, {
@@ -1462,6 +1474,7 @@ function SelectPromptDeclarations() {
 					createComponent(ClassMethod, {
 						doc: "A method to render the prompt",
 						name: "render",
+						override: true,
 						"protected": true,
 						children: code`if (this.isInitial) {
             this.output.write(cursor.hide);
@@ -1508,7 +1521,7 @@ function SelectPromptDeclarations() {
                   : this.cursor === index
                     ? colors.bold(colors.underline(colors.text.prompt.input.active(this.options[index]!.label)))
                     : colors.text.prompt.input.inactive(this.options[index]!.label)
-              } \${" ".repeat(spacing - this.options[index]!.label.length - (this.options[index]!.icon ? this.options[index]!.icon.length + 1 : 0))}\${
+              } \${" ".repeat(spacing - this.options[index]!.label.length - (this.options[index]!.icon ? this.options[index]!.icon!.length + 1 : 0))}\${
                 this.options[index]!.description && this.cursor === index
                     ? colors.italic(colors.text.prompt.description.active(this.options[index]!.description))
                     : ""
@@ -1541,7 +1554,7 @@ function SelectPromptDeclarations() {
 			heading: "A function to create and run a select 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 { select, isCancel } from "shell-shock/prompts";
+					createComponent(TSDocExample, { children: `import { select, isCancel } from "shell-shock:prompts";
 
 async function run() {
   const color = await select({
@@ -1649,6 +1662,7 @@ function NumericPromptDeclarations() {
 					createComponent(ClassField, {
 						name: "initialValue",
 						"protected": true,
+						override: true,
 						type: "number",
 						children: code`0; `
 					}),
@@ -1743,6 +1757,7 @@ function NumericPromptDeclarations() {
 					createComponent(ClassMethod, {
 						doc: "A method to reset the prompt input",
 						name: "reset",
+						override: true,
 						"protected": true,
 						children: code`super.reset();
           this.currentInput = "";
@@ -1760,6 +1775,7 @@ function NumericPromptDeclarations() {
 					createComponent(ClassMethod, {
 						doc: "A method to handle keypress events and determine the corresponding action",
 						name: "keypress",
+						override: true,
 						"protected": true,
 						parameters: [{
 							name: "char",
@@ -1869,7 +1885,7 @@ function NumericPromptDeclarations() {
 			heading: "A function to create and run a numeric 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 { numeric, isCancel } from "shell-shock/prompts";
+					createComponent(TSDocExample, { children: `import { numeric, isCancel } from "shell-shock:prompts";
 
 async function run() {
   const age = await numeric({
@@ -1953,6 +1969,7 @@ function TogglePromptDeclarations() {
 					createComponent(ClassField, {
 						name: "initialValue",
 						"protected": true,
+						override: true,
 						type: "boolean",
 						children: code`false; `
 					}),
@@ -2015,6 +2032,7 @@ function TogglePromptDeclarations() {
 					createComponent(ClassMethod, {
 						doc: "A method to handle keypress events and determine the corresponding action",
 						name: "keypress",
+						override: true,
 						"protected": true,
 						parameters: [{
 							name: "char",
@@ -2098,7 +2116,7 @@ function TogglePromptDeclarations() {
 			heading: "A function to create and run a toggle 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 { toggle, isCancel } from "shell-shock/prompts";
+					createComponent(TSDocExample, { children: `import { toggle, isCancel } from "shell-shock:prompts";
 
 async function run() {
   const likesIceCream = await toggle({
@@ -2170,7 +2188,7 @@ function PasswordPromptDeclaration() {
 				return [
 					createComponent(TSDocRemarks, { children: code`This function creates an instance of the TextPrompt class with the provided configuration options and a custom mask function to handle password input. It sets up event listeners for state updates, submission, and cancellation to handle the prompt interactions and return the appropriate results. The password prompt allows users to input text that is masked for privacy, making it suitable for scenarios like entering passwords or sensitive information.` }),
 					createComponent(Spacing, {}),
-					createComponent(TSDocExample, { children: `import { password, isCancel } from "shell-shock/prompts";
+					createComponent(TSDocExample, { children: `import { password, isCancel } from "shell-shock:prompts";
 
 async function run() {
   const userPassword = await password({