@h3ravel/shared 0.29.0-alpha.8 → 0.30.0

package/dist/index.cjs

@@ -36,6 +36,8 @@ path = __toESM(path);
 let inquirer_autocomplete_standalone = require("inquirer-autocomplete-standalone");
 inquirer_autocomplete_standalone = __toESM(inquirer_autocomplete_standalone);
 let __inquirer_prompts = require("@inquirer/prompts");
+let ora = require("ora");
+ora = __toESM(ora);
 let crypto = require("crypto");
 crypto = __toESM(crypto);
 let preferred_pm = require("preferred-pm");
@@ -691,39 +693,57 @@ var PathLoader = class {
 var Prompts = class extends Logger {
 	/**
 	* Allows users to pick from a predefined set of choices when asked a question.
+	* 
+	* @param message      Message to display
+	* @param choices      The choices available to the user
+	* @param defaultIndex Item index front of which the cursor will initially appear
+	* @param pageSize     The number of items to show per page
+	* @returns
 	*/
-	static async choice(message, choices, defaultIndex) {
+	static async choice(message, choices, defaultIndex, pageSize) {
 		return (0, __inquirer_prompts.select)({
 			message,
 			choices,
-			default: defaultIndex ? choices.at(defaultIndex) : void 0
+			default: defaultIndex ? choices.at(defaultIndex) : void 0,
+			pageSize
 		});
 	}
 	/**
 	* Ask the user for a simple "yes or no" confirmation. 
 	* By default, this method returns `false`. However, if the user enters y or yes 
 	* in response to the prompt, the method would return `true`.
+	* 
+	* @param message      Message to display
+	* @param defaultValue The default value
 	*/
-	static async confirm(message, def) {
+	static async confirm(message, defaultValue) {
 		return (0, __inquirer_prompts.confirm)({
 			message,
-			default: def
+			default: defaultValue
 		});
 	}
 	/**
 	* Prompt the user with the given question, accept their input, 
 	* and then return the user's input back to your command.
+	* 
+	* @param message      Message to display
+	* @param defaultValue The default value
+	* @returns 
 	*/
-	static async ask(message, def) {
+	static async ask(message, defaultValue) {
 		return (0, __inquirer_prompts.input)({
 			message,
-			default: def
+			default: defaultValue
 		});
 	}
 	/**
 	* Prompt the user with the given question, accept their input which 
 	* will not be visible to them as they type in the console, 
 	* and then return the user's input back to your command.
+	* 
+	* @param message Message to display
+	* @param mask    Mask the user input
+	* @returns 
 	*/
 	static async secret(message, mask) {
 		return (0, __inquirer_prompts.password)({
@@ -735,14 +755,68 @@ var Prompts = class extends Logger {
 	* Provide auto-completion for possible choices. 
 	* The user can still provide any answer, regardless of the auto-completion hints.
 	*/
-	static async anticipate(message, source, def) {
+	/**
+	* 
+	* @param message      Message to dislpay
+	* @param source       The source of completions
+	* @param defaultValue Set a default value
+	* @param pageSize     The number of items to show per page
+	* @returns 
+	*/
+	static async anticipate(message, source, defaultValue, pageSize) {
 		return (0, inquirer_autocomplete_standalone.default)({
 			message,
 			source: Array.isArray(source) ? async (term) => {
 				return (term ? source.filter((e) => e.includes(term)) : source).map((e) => ({ value: e }));
 			} : source,
 			suggestOnly: true,
-			default: def
+			default: defaultValue,
+			pageSize
+		});
+	}
+	/**
+	* Display a spinner while performing a long task
+	* 
+	* @param options The spinner options
+	* @returns 
+	*/
+	static spinner(options) {
+		return (0, ora.default)(options);
+	}
+	/**
+	* Allows users to select multiple options from a predefined list of choices.
+	* 
+	* @param message  Message to display
+	* @param choices  The choices available to the user
+	* @param required Whether at least one choice is required
+	* @param prefix   Prefix to display before the message
+	* @param pageSize The number of items to show per page
+	* @returns
+	*/
+	static async checkbox(message, choices, required, prefix, pageSize) {
+		return await (0, __inquirer_prompts.checkbox)({
+			message,
+			choices,
+			required,
+			prefix,
+			pageSize
+		});
+	}
+	/**
+	* Open the user's default text editor to accept multi-line input.
+	* 
+	* @param message  Message to display
+	* @param postfix  The postfix of the file being edited [e.g., '.txt', '.md']
+	* @param defaultValue The default value to pre-fill in the editor
+	* @param validate A function to validate the input text
+	* @returns
+	*/
+	static async editor(message, postfix, defaultValue, validate) {
+		return await (0, __inquirer_prompts.editor)({
+			message: message ?? "Please provide your input in the editor below:",
+			postfix,
+			default: defaultValue,
+			validate
 		});
 	}
 };

package/dist/index.d.ts

@@ -3,6 +3,8 @@ import { Separator } from "@inquirer/prompts";
 import { ChoiceOrSeparatorArray, ChoiceOrSeparatorArray as ChoiceOrSeparatorArray$1 } from "inquirer-autocomplete-standalone";
 import { ChalkInstance } from "chalk";
 import { ClassConstructor, IPathName } from "@h3ravel/contracts";
+import * as ora0 from "ora";
+import { Options } from "ora";
 
 //#region src/Container.d.ts
 declare const INTERNAL_METHODS: unique symbol;
@@ -423,80 +425,83 @@ declare class PathLoader {
 declare class Prompts extends Logger {
   /**
    * Allows users to pick from a predefined set of choices when asked a question.
+   *
+   * @param message      Message to display
+   * @param choices      The choices available to the user
+   * @param defaultIndex Item index front of which the cursor will initially appear
+   * @param pageSize     The number of items to show per page
+   * @returns
    */
-  static choice(
-  /**
-   * Message to dislpay
-   */
-  message: string,
-  /**
-   * The choices available to the user
-   */
-  choices: Choices,
-  /**
-   * Item index front of which the cursor will initially appear
-   */
-  defaultIndex?: number): Promise<string>;
+  static choice(message: string, choices: Choices, defaultIndex?: number, pageSize?: number): Promise<string>;
   /**
    * Ask the user for a simple "yes or no" confirmation.
    * By default, this method returns `false`. However, if the user enters y or yes
    * in response to the prompt, the method would return `true`.
+   *
+   * @param message      Message to display
+   * @param defaultValue The default value
    */
-  static confirm(
-  /**
-   * Message to dislpay
-   */
-  message: string,
-  /**
-   * The default value
-   */
-  def?: boolean | undefined): Promise<boolean>;
+  static confirm(message: string, defaultValue?: boolean | undefined): Promise<boolean>;
   /**
    * Prompt the user with the given question, accept their input,
    * and then return the user's input back to your command.
+   *
+   * @param message      Message to display
+   * @param defaultValue The default value
+   * @returns
    */
-  static ask(
-  /**
-   * Message to dislpay
-   */
-  message: string,
-  /**
-   * The default value
-   */
-  def?: string | undefined): Promise<string>;
+  static ask(message: string, defaultValue?: string | undefined): Promise<string>;
   /**
    * Prompt the user with the given question, accept their input which
    * will not be visible to them as they type in the console,
    * and then return the user's input back to your command.
-   */
-  static secret(
-  /**
-   * Message to dislpay
-   */
-  message: string,
-  /**
-   * Mask the user input
    *
-   * @default true
+   * @param message Message to display
+   * @param mask    Mask the user input
+   * @returns
    */
-  mask?: string | boolean): Promise<string>;
+  static secret(message: string, mask?: string | boolean): Promise<string>;
   /**
    * Provide auto-completion for possible choices.
    * The user can still provide any answer, regardless of the auto-completion hints.
    */
-  static anticipate(
   /**
-   * Message to dislpay
+   *
+   * @param message      Message to dislpay
+   * @param source       The source of completions
+   * @param defaultValue Set a default value
+   * @param pageSize     The number of items to show per page
+   * @returns
    */
-  message: string,
+  static anticipate(message: string, source: string[] | ((input?: string | undefined) => Promise<ChoiceOrSeparatorArray$1<any>>), defaultValue?: string, pageSize?: number): Promise<any>;
   /**
-   * The source of completions
+   * Display a spinner while performing a long task
+   *
+   * @param options The spinner options
+   * @returns
+   */
+  static spinner(options?: string | Options | undefined): ora0.Ora;
+  /**
+   * Allows users to select multiple options from a predefined list of choices.
+   *
+   * @param message  Message to display
+   * @param choices  The choices available to the user
+   * @param required Whether at least one choice is required
+   * @param prefix   Prefix to display before the message
+   * @param pageSize The number of items to show per page
+   * @returns
    */
-  source: string[] | ((input?: string | undefined) => Promise<ChoiceOrSeparatorArray$1<any>>),
+  static checkbox(message: string, choices: Choices, required?: boolean, prefix?: string, pageSize?: number): Promise<string[]>;
   /**
-   * Set a default value
+   * Open the user's default text editor to accept multi-line input.
+   *
+   * @param message  Message to display
+   * @param postfix  The postfix of the file being edited [e.g., '.txt', '.md']
+   * @param defaultValue The default value to pre-fill in the editor
+   * @param validate A function to validate the input text
+   * @returns
    */
-  def?: string): Promise<any>;
+  static editor(message?: string, postfix?: string, defaultValue?: string, validate?: (text: string) => boolean | string): Promise<string>;
 }
 //#endregion
 //#region src/Utils/Resolver.d.ts

package/dist/index.js

@@ -4,7 +4,8 @@ import escalade from "escalade/sync";
 import { existsSync } from "fs";
 import path from "path";
 import autocomplete from "inquirer-autocomplete-standalone";
-import { confirm, input, password, select } from "@inquirer/prompts";
+import { checkbox, confirm, editor, input, password, select } from "@inquirer/prompts";
+import ora from "ora";
 import crypto from "crypto";
 import preferredPM from "preferred-pm";
 
@@ -658,39 +659,57 @@ var PathLoader = class {
 var Prompts = class extends Logger {
 	/**
 	* Allows users to pick from a predefined set of choices when asked a question.
+	* 
+	* @param message      Message to display
+	* @param choices      The choices available to the user
+	* @param defaultIndex Item index front of which the cursor will initially appear
+	* @param pageSize     The number of items to show per page
+	* @returns
 	*/
-	static async choice(message, choices, defaultIndex) {
+	static async choice(message, choices, defaultIndex, pageSize) {
 		return select({
 			message,
 			choices,
-			default: defaultIndex ? choices.at(defaultIndex) : void 0
+			default: defaultIndex ? choices.at(defaultIndex) : void 0,
+			pageSize
 		});
 	}
 	/**
 	* Ask the user for a simple "yes or no" confirmation. 
 	* By default, this method returns `false`. However, if the user enters y or yes 
 	* in response to the prompt, the method would return `true`.
+	* 
+	* @param message      Message to display
+	* @param defaultValue The default value
 	*/
-	static async confirm(message, def) {
+	static async confirm(message, defaultValue) {
 		return confirm({
 			message,
-			default: def
+			default: defaultValue
 		});
 	}
 	/**
 	* Prompt the user with the given question, accept their input, 
 	* and then return the user's input back to your command.
+	* 
+	* @param message      Message to display
+	* @param defaultValue The default value
+	* @returns 
 	*/
-	static async ask(message, def) {
+	static async ask(message, defaultValue) {
 		return input({
 			message,
-			default: def
+			default: defaultValue
 		});
 	}
 	/**
 	* Prompt the user with the given question, accept their input which 
 	* will not be visible to them as they type in the console, 
 	* and then return the user's input back to your command.
+	* 
+	* @param message Message to display
+	* @param mask    Mask the user input
+	* @returns 
 	*/
 	static async secret(message, mask) {
 		return password({
@@ -702,14 +721,68 @@ var Prompts = class extends Logger {
 	* Provide auto-completion for possible choices. 
 	* The user can still provide any answer, regardless of the auto-completion hints.
 	*/
-	static async anticipate(message, source, def) {
+	/**
+	* 
+	* @param message      Message to dislpay
+	* @param source       The source of completions
+	* @param defaultValue Set a default value
+	* @param pageSize     The number of items to show per page
+	* @returns 
+	*/
+	static async anticipate(message, source, defaultValue, pageSize) {
 		return autocomplete({
 			message,
 			source: Array.isArray(source) ? async (term) => {
 				return (term ? source.filter((e) => e.includes(term)) : source).map((e) => ({ value: e }));
 			} : source,
 			suggestOnly: true,
-			default: def
+			default: defaultValue,
+			pageSize
+		});
+	}
+	/**
+	* Display a spinner while performing a long task
+	* 
+	* @param options The spinner options
+	* @returns 
+	*/
+	static spinner(options) {
+		return ora(options);
+	}
+	/**
+	* Allows users to select multiple options from a predefined list of choices.
+	* 
+	* @param message  Message to display
+	* @param choices  The choices available to the user
+	* @param required Whether at least one choice is required
+	* @param prefix   Prefix to display before the message
+	* @param pageSize The number of items to show per page
+	* @returns
+	*/
+	static async checkbox(message, choices, required, prefix, pageSize) {
+		return await checkbox({
+			message,
+			choices,
+			required,
+			prefix,
+			pageSize
+		});
+	}
+	/**
+	* Open the user's default text editor to accept multi-line input.
+	* 
+	* @param message  Message to display
+	* @param postfix  The postfix of the file being edited [e.g., '.txt', '.md']
+	* @param defaultValue The default value to pre-fill in the editor
+	* @param validate A function to validate the input text
+	* @returns
+	*/
+	static async editor(message, postfix, defaultValue, validate) {
+		return await editor({
+			message: message ?? "Please provide your input in the editor below:",
+			postfix,
+			default: defaultValue,
+			validate
 		});
 	}
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/shared",
-  "version": "0.29.0-alpha.8",
+  "version": "0.30.0",
   "description": "Shared Utilities.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -50,6 +50,7 @@
     "escalade": "^3.2.0",
     "h3": "2.0.1-rc.5",
     "inquirer-autocomplete-standalone": "^0.8.1",
+    "ora": "^9.1.0",
     "preferred-pm": "^4.1.1"
   },
   "devDependencies": {