@h3ravel/shared 0.22.3 → 0.23.0

package/dist/index.cjs

@@ -29,6 +29,10 @@ let path = require("path");
 path = __toESM(path);
 let chalk = require("chalk");
 chalk = __toESM(chalk);
+let inquirer_autocomplete_standalone = require("inquirer-autocomplete-standalone");
+inquirer_autocomplete_standalone = __toESM(inquirer_autocomplete_standalone);
+let __inquirer_prompts = require("@inquirer/prompts");
+__inquirer_prompts = __toESM(__inquirer_prompts);
 let crypto = require("crypto");
 crypto = __toESM(crypto);
 let preferred_pm = require("preferred-pm");
@@ -290,10 +294,10 @@ var Logger = class Logger {
 		process.exit(0);
 	}
 	static chalker(styles) {
-		return (input) => styles.reduce((acc, style) => {
+		return (input$1) => styles.reduce((acc, style) => {
 			if (style in chalk.default) return (typeof style === "function" ? style : chalk.default[style])(acc);
 			return acc;
-		}, input);
+		}, input$1);
 	}
 	static parse(config, joiner = " ", log = true, sc) {
 		const string = config.map(([str, opt]) => {
@@ -361,6 +365,67 @@ var PathLoader = class {
 	}
 };
 
+//#endregion
+//#region src/Utils/Prompts.ts
+var Prompts = class extends Logger {
+	/**
+	* Allows users to pick from a predefined set of choices when asked a question.
+	*/
+	static async choice(message, choices, defaultIndex) {
+		return (0, __inquirer_prompts.select)({
+			message,
+			choices,
+			default: defaultIndex ? choices.at(defaultIndex) : void 0
+		});
+	}
+	/**
+	* 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`.
+	*/
+	static async confirm(message, def) {
+		return (0, __inquirer_prompts.confirm)({
+			message,
+			default: def
+		});
+	}
+	/**
+	* Prompt the user with the given question, accept their input, 
+	* and then return the user's input back to your command.
+	*/
+	static async ask(message, def) {
+		return (0, __inquirer_prompts.input)({
+			message,
+			default: def
+		});
+	}
+	/**
+	* 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 async secret(message, mask) {
+		return (0, __inquirer_prompts.password)({
+			message,
+			mask
+		});
+	}
+	/**
+	* 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) {
+		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
+		});
+	}
+};
+
 //#endregion
 //#region src/Utils/Resolver.ts
 var Resolver = class {
@@ -482,6 +547,7 @@ exports.FileSystem = FileSystem;
 exports.HttpContext = HttpContext;
 exports.Logger = Logger;
 exports.PathLoader = PathLoader;
+exports.Prompts = Prompts;
 exports.Resolver = Resolver;
 exports.TaskManager = TaskManager;
 exports.baseTsconfig = baseTsconfig;

package/dist/index.d.cts

@@ -3,29 +3,31 @@ import { H3, H3Event, Middleware, MiddlewareOptions, serve } from "h3";
 import { Edge } from "edge.js";
 import { ResponseHeaderMap, TypedHeaders } from "fetchdts";
 import { DotNestedKeys as DotNestedKeys$1, DotNestedValue as DotNestedValue$1 } from "@h3ravel/shared";
+import { Separator } from "@inquirer/prompts";
 import { ChalkInstance } from "chalk";
+import { ChoiceOrSeparatorArray } from "inquirer-autocomplete-standalone";
 
 //#region src/Contracts/ObjContract.d.ts
 /**
  * Adds a dot prefix to nested keys
  */
-type DotPrefix<T extends string, U extends string> = T extends '' ? U : `${T}.${U}`;
+type DotPrefix<T$1 extends string, U extends string> = T$1 extends '' ? U : `${T$1}.${U}`;
 /**
  * Converts a union of objects into a single merged object
  */
-type MergeUnion<T> = (T extends any ? (k: T) => void : never) extends ((k: infer I) => void) ? { [K in keyof I]: I[K] } : never;
+type MergeUnion<T$1> = (T$1 extends any ? (k: T$1) => void : never) extends ((k: infer I) => void) ? { [K in keyof I]: I[K] } : never;
 /**
  * Flattens nested objects into dotted keys
  */
-type DotFlatten<T, Prefix extends string = ''> = MergeUnion<{ [K in keyof T & string]: T[K] extends Record<string, any> ? DotFlatten<T[K], DotPrefix<Prefix, K>> : { [P in DotPrefix<Prefix, K>]: T[K] } }[keyof T & string]>;
+type DotFlatten<T$1, Prefix extends string = ''> = MergeUnion<{ [K in keyof T$1 & string]: T$1[K] extends Record<string, any> ? DotFlatten<T$1[K], DotPrefix<Prefix, K>> : { [P in DotPrefix<Prefix, K>]: T$1[K] } }[keyof T$1 & string]>;
 /**
  * Builds "nested.key" paths for autocompletion
  */
-type DotNestedKeys<T> = { [K in keyof T & string]: T[K] extends object ? `${K}` | `${K}.${DotNestedKeys<T[K]>}` : `${K}` }[keyof T & string];
+type DotNestedKeys<T$1> = { [K in keyof T$1 & string]: T$1[K] extends object ? `${K}` | `${K}.${DotNestedKeys<T$1[K]>}` : `${K}` }[keyof T$1 & string];
 /**
  * Retrieves type at a given dot-path
  */
-type DotNestedValue<T, Path extends string> = Path extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? DotNestedValue<T[Key], Rest> : never : Path extends keyof T ? T[Path] : never;
+type DotNestedValue<T$1, Path extends string> = Path extends `${infer Key}.${infer Rest}` ? Key extends keyof T$1 ? DotNestedValue<T$1[Key], Rest> : never : Path extends keyof T$1 ? T$1[Path] : never;
 /**
  * A generic object type that supports nullable string values
  */
@@ -253,7 +255,7 @@ interface IResponse {
 //#endregion
 //#region src/Contracts/IHttp.d.ts
 type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'patch' | 'apiResource' | 'group' | 'route';
-type ExtractControllerMethods<T> = { [K in keyof T]: T[K] extends ((...args: any[]) => any) ? K : never }[keyof T];
+type ExtractControllerMethods<T$1> = { [K in keyof T$1]: T$1[K] extends ((...args: any[]) => any) ? K : never }[keyof T$1];
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
@@ -406,7 +408,7 @@ declare class PathLoader {
 }
 //#endregion
 //#region src/Contracts/BindingsContract.d.ts
-type RemoveIndexSignature<T> = { [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K] };
+type RemoveIndexSignature<T$1> = { [K in keyof T$1 as string extends K ? never : number extends K ? never : K]: T$1[K] };
 type Bindings = {
   [key: string]: any;
   [key: `app.${string}`]: any;
@@ -431,6 +433,17 @@ type Bindings = {
 };
 type UseKey = keyof RemoveIndexSignature<Bindings>;
 //#endregion
+//#region src/Contracts/PromptsContract.d.ts
+type Choice<Value> = {
+  value: Value;
+  name?: string;
+  description?: string;
+  short?: string;
+  disabled?: boolean | string;
+  type?: never;
+};
+type Choices = readonly (string | Separator)[] | readonly (Separator | Choice<string>)[];
+//#endregion
 //#region src/Contracts/Router.d.ts
 type RouteMethod = 'get' | 'head' | 'put' | 'patch' | 'post' | 'delete';
 interface RouteDefinition {
@@ -616,6 +629,86 @@ declare class FileSystem {
   static resolveFileUp(name: string, extensions: string[] | ((dir: string, filesNames: string[]) => string | false), cwd?: string): string | undefined;
 }
 //#endregion
+//#region src/Utils/Prompts.d.ts
+declare class Prompts extends Logger {
+  /**
+   * Allows users to pick from a predefined set of choices when asked a question.
+   */
+  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>;
+  /**
+   * 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`.
+   */
+  static confirm(
+  /**
+   * Message to dislpay
+   */
+  message: string,
+  /**
+   * The default value
+   */
+  def?: 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.
+   */
+  static ask(
+  /**
+   * Message to dislpay
+   */
+  message: string,
+  /**
+   * The default value
+   */
+  def?: 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
+   */
+  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
+   */
+  message: string,
+  /**
+   * The source of completions
+   */
+  source: string[] | ((input?: string | undefined) => Promise<ChoiceOrSeparatorArray<any>>),
+  /**
+   * Set a default value
+   */
+  def?: string): Promise<any>;
+}
+//#endregion
 //#region src/Utils/Resolver.d.ts
 declare class Resolver {
   static getPakageInstallCommand(pkg?: string): Promise<string>;
@@ -676,4 +769,4 @@ declare class TaskManager {
   static advancedTaskRunner<R = any>(info: [[string, string], [string, string]] | [[string, string]], task: (() => Promise<R>) | (() => R)): Promise<R | undefined>;
 }
 //#endregion
-export { Bindings, DotFlatten, DotNestedKeys, DotNestedValue, EnvParser, EventHandler, ExtractControllerMethods, FileSystem, GenericWithNullableStringValues, HttpContext, IApplication, IContainer, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, PathLoader, Resolver, RouteDefinition, RouteEventHandler, RouteMethod, RouterEnd, TaskManager, UseKey, baseTsconfig, mainTsconfig, packageJsonScript };
+export { Bindings, Choice, Choices, DotFlatten, DotNestedKeys, DotNestedValue, EnvParser, EventHandler, ExtractControllerMethods, FileSystem, GenericWithNullableStringValues, HttpContext, IApplication, IContainer, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, PathLoader, Prompts, Resolver, RouteDefinition, RouteEventHandler, RouteMethod, RouterEnd, TaskManager, UseKey, baseTsconfig, mainTsconfig, packageJsonScript };

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 /// <reference path="./app.globals.d.ts" />
 import { ChalkInstance } from "chalk";
+import { ChoiceOrSeparatorArray } from "inquirer-autocomplete-standalone";
+import { Separator } from "@inquirer/prompts";
 import { H3, H3Event, Middleware, MiddlewareOptions, serve } from "h3";
 import { Edge } from "edge.js";
 import { ResponseHeaderMap, TypedHeaders } from "fetchdts";
@@ -9,23 +11,23 @@ import { DotNestedKeys as DotNestedKeys$1, DotNestedValue as DotNestedValue$1 }
 /**
  * Adds a dot prefix to nested keys
  */
-type DotPrefix<T extends string, U extends string> = T extends '' ? U : `${T}.${U}`;
+type DotPrefix<T$1 extends string, U extends string> = T$1 extends '' ? U : `${T$1}.${U}`;
 /**
  * Converts a union of objects into a single merged object
  */
-type MergeUnion<T> = (T extends any ? (k: T) => void : never) extends ((k: infer I) => void) ? { [K in keyof I]: I[K] } : never;
+type MergeUnion<T$1> = (T$1 extends any ? (k: T$1) => void : never) extends ((k: infer I) => void) ? { [K in keyof I]: I[K] } : never;
 /**
  * Flattens nested objects into dotted keys
  */
-type DotFlatten<T, Prefix extends string = ''> = MergeUnion<{ [K in keyof T & string]: T[K] extends Record<string, any> ? DotFlatten<T[K], DotPrefix<Prefix, K>> : { [P in DotPrefix<Prefix, K>]: T[K] } }[keyof T & string]>;
+type DotFlatten<T$1, Prefix extends string = ''> = MergeUnion<{ [K in keyof T$1 & string]: T$1[K] extends Record<string, any> ? DotFlatten<T$1[K], DotPrefix<Prefix, K>> : { [P in DotPrefix<Prefix, K>]: T$1[K] } }[keyof T$1 & string]>;
 /**
  * Builds "nested.key" paths for autocompletion
  */
-type DotNestedKeys<T> = { [K in keyof T & string]: T[K] extends object ? `${K}` | `${K}.${DotNestedKeys<T[K]>}` : `${K}` }[keyof T & string];
+type DotNestedKeys<T$1> = { [K in keyof T$1 & string]: T$1[K] extends object ? `${K}` | `${K}.${DotNestedKeys<T$1[K]>}` : `${K}` }[keyof T$1 & string];
 /**
  * Retrieves type at a given dot-path
  */
-type DotNestedValue<T, Path extends string> = Path extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? DotNestedValue<T[Key], Rest> : never : Path extends keyof T ? T[Path] : never;
+type DotNestedValue<T$1, Path extends string> = Path extends `${infer Key}.${infer Rest}` ? Key extends keyof T$1 ? DotNestedValue<T$1[Key], Rest> : never : Path extends keyof T$1 ? T$1[Path] : never;
 /**
  * A generic object type that supports nullable string values
  */
@@ -253,7 +255,7 @@ interface IResponse {
 //#endregion
 //#region src/Contracts/IHttp.d.ts
 type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'patch' | 'apiResource' | 'group' | 'route';
-type ExtractControllerMethods<T> = { [K in keyof T]: T[K] extends ((...args: any[]) => any) ? K : never }[keyof T];
+type ExtractControllerMethods<T$1> = { [K in keyof T$1]: T$1[K] extends ((...args: any[]) => any) ? K : never }[keyof T$1];
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
@@ -406,7 +408,7 @@ declare class PathLoader {
 }
 //#endregion
 //#region src/Contracts/BindingsContract.d.ts
-type RemoveIndexSignature<T> = { [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K] };
+type RemoveIndexSignature<T$1> = { [K in keyof T$1 as string extends K ? never : number extends K ? never : K]: T$1[K] };
 type Bindings = {
   [key: string]: any;
   [key: `app.${string}`]: any;
@@ -431,6 +433,17 @@ type Bindings = {
 };
 type UseKey = keyof RemoveIndexSignature<Bindings>;
 //#endregion
+//#region src/Contracts/PromptsContract.d.ts
+type Choice<Value> = {
+  value: Value;
+  name?: string;
+  description?: string;
+  short?: string;
+  disabled?: boolean | string;
+  type?: never;
+};
+type Choices = readonly (string | Separator)[] | readonly (Separator | Choice<string>)[];
+//#endregion
 //#region src/Contracts/Router.d.ts
 type RouteMethod = 'get' | 'head' | 'put' | 'patch' | 'post' | 'delete';
 interface RouteDefinition {
@@ -616,6 +629,86 @@ declare class FileSystem {
   static resolveFileUp(name: string, extensions: string[] | ((dir: string, filesNames: string[]) => string | false), cwd?: string): string | undefined;
 }
 //#endregion
+//#region src/Utils/Prompts.d.ts
+declare class Prompts extends Logger {
+  /**
+   * Allows users to pick from a predefined set of choices when asked a question.
+   */
+  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>;
+  /**
+   * 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`.
+   */
+  static confirm(
+  /**
+   * Message to dislpay
+   */
+  message: string,
+  /**
+   * The default value
+   */
+  def?: 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.
+   */
+  static ask(
+  /**
+   * Message to dislpay
+   */
+  message: string,
+  /**
+   * The default value
+   */
+  def?: 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
+   */
+  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
+   */
+  message: string,
+  /**
+   * The source of completions
+   */
+  source: string[] | ((input?: string | undefined) => Promise<ChoiceOrSeparatorArray<any>>),
+  /**
+   * Set a default value
+   */
+  def?: string): Promise<any>;
+}
+//#endregion
 //#region src/Utils/Resolver.d.ts
 declare class Resolver {
   static getPakageInstallCommand(pkg?: string): Promise<string>;
@@ -676,4 +769,4 @@ declare class TaskManager {
   static advancedTaskRunner<R = any>(info: [[string, string], [string, string]] | [[string, string]], task: (() => Promise<R>) | (() => R)): Promise<R | undefined>;
 }
 //#endregion
-export { Bindings, DotFlatten, DotNestedKeys, DotNestedValue, EnvParser, EventHandler, ExtractControllerMethods, FileSystem, GenericWithNullableStringValues, HttpContext, IApplication, IContainer, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, PathLoader, Resolver, RouteDefinition, RouteEventHandler, RouteMethod, RouterEnd, TaskManager, UseKey, baseTsconfig, mainTsconfig, packageJsonScript };
+export { Bindings, Choice, Choices, DotFlatten, DotNestedKeys, DotNestedValue, EnvParser, EventHandler, ExtractControllerMethods, FileSystem, GenericWithNullableStringValues, HttpContext, IApplication, IContainer, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, PathLoader, Prompts, Resolver, RouteDefinition, RouteEventHandler, RouteMethod, RouterEnd, TaskManager, UseKey, baseTsconfig, mainTsconfig, packageJsonScript };

package/dist/index.js

@@ -2,6 +2,8 @@ import { access } from "fs/promises";
 import escalade from "escalade/sync";
 import path from "path";
 import chalk from "chalk";
+import autocomplete from "inquirer-autocomplete-standalone";
+import { confirm, input, password, select } from "@inquirer/prompts";
 import crypto from "crypto";
 import preferredPM from "preferred-pm";
 
@@ -261,10 +263,10 @@ var Logger = class Logger {
 		process.exit(0);
 	}
 	static chalker(styles) {
-		return (input) => styles.reduce((acc, style) => {
+		return (input$1) => styles.reduce((acc, style) => {
 			if (style in chalk) return (typeof style === "function" ? style : chalk[style])(acc);
 			return acc;
-		}, input);
+		}, input$1);
 	}
 	static parse(config, joiner = " ", log = true, sc) {
 		const string = config.map(([str, opt]) => {
@@ -332,6 +334,67 @@ var PathLoader = class {
 	}
 };
 
+//#endregion
+//#region src/Utils/Prompts.ts
+var Prompts = class extends Logger {
+	/**
+	* Allows users to pick from a predefined set of choices when asked a question.
+	*/
+	static async choice(message, choices, defaultIndex) {
+		return select({
+			message,
+			choices,
+			default: defaultIndex ? choices.at(defaultIndex) : void 0
+		});
+	}
+	/**
+	* 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`.
+	*/
+	static async confirm(message, def) {
+		return confirm({
+			message,
+			default: def
+		});
+	}
+	/**
+	* Prompt the user with the given question, accept their input, 
+	* and then return the user's input back to your command.
+	*/
+	static async ask(message, def) {
+		return input({
+			message,
+			default: def
+		});
+	}
+	/**
+	* 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 async secret(message, mask) {
+		return password({
+			message,
+			mask
+		});
+	}
+	/**
+	* 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) {
+		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
+		});
+	}
+};
+
 //#endregion
 //#region src/Utils/Resolver.ts
 var Resolver = class {
@@ -448,4 +511,4 @@ var TaskManager = class {
 };
 
 //#endregion
-export { EnvParser, FileSystem, HttpContext, Logger, PathLoader, Resolver, TaskManager, baseTsconfig, mainTsconfig, packageJsonScript };
+export { EnvParser, FileSystem, HttpContext, Logger, PathLoader, Prompts, Resolver, TaskManager, baseTsconfig, mainTsconfig, packageJsonScript };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/shared",
-  "version": "0.22.3",
+  "version": "0.23.0",
   "description": "Shared Utilities.",
   "type": "module",
   "main": "./dist/index.js",
@@ -44,15 +44,16 @@
     "laravel"
   ],
   "dependencies": {
-    "h3": "^2.0.0-beta.4",
+    "@inquirer/prompts": "^7.9.0",
     "chalk": "^5.6.0",
     "edge.js": "^6.3.0",
-    "preferred-pm": "^4.1.1",
-    "escalade": "^3.2.0"
+    "escalade": "^3.2.0",
+    "h3": "^2.0.0-beta.4",
+    "inquirer-autocomplete-standalone": "^0.8.1",
+    "preferred-pm": "^4.1.1"
   },
   "devDependencies": {
     "fetchdts": "^0.1.6",
-    "install": "^0.13.0",
     "pnpm": "^10.14.0"
   },
   "scripts": {