@h3ravel/core 1.7.4 → 1.9.0

package/dist/index.d.ts

@@ -1,125 +1,232 @@
-import { IContainer, UseKey, Bindings, IApplication, PathLoader, IServiceProvider, IPathName, IController, HttpContext, IMiddleware } from '@h3ravel/shared';
-import { H3Event } from 'h3';
+import "reflect-metadata";
+import { Bindings, HttpContext, IApplication, IContainer, IController, IMiddleware, IPathName, IServiceProvider, PathLoader, UseKey } from "@h3ravel/shared";
+import { XGeneric } from "@h3ravel/support";
+import { H3, H3Event } from "h3";
+import { Argument, Command } from "commander";
 
+//#region src/Container.d.ts
 declare class Container implements IContainer {
-    private bindings;
-    private singletons;
-    /**
-     * Check if the target has any decorators
-     *
-     * @param target
-     * @returns
-     */
-    static hasAnyDecorator(target: Function): boolean;
-    /**
-     * Bind a transient service to the container
-     */
-    bind<T>(key: new (...args: any[]) => T, factory: () => T): void;
-    bind<T extends UseKey>(key: T, factory: () => Bindings[T]): void;
-    /**
-     * Bind a singleton service to the container
-     */
-    singleton<T extends UseKey>(key: T | (new (..._args: any[]) => Bindings[T]), factory: () => Bindings[T]): void;
-    /**
-     * Resolve a service from the container
-     */
-    make<T extends UseKey, X = undefined>(key: T | (new (..._args: any[]) => Bindings[T])): X extends undefined ? Bindings[T] : X;
-    /**
-     * Automatically build a class with constructor dependency injection
-     */
-    private build;
-    /**
-     * Check if a service is registered
-     */
-    has(key: UseKey): boolean;
+  private bindings;
+  private singletons;
+  /**
+   * Check if the target has any decorators
+   *
+   * @param target
+   * @returns
+   */
+  static hasAnyDecorator(target: Function): boolean;
+  /**
+   * Bind a transient service to the container
+   */
+  bind<T>(key: new (...args: any[]) => T, factory: () => T): void;
+  bind<T extends UseKey>(key: T, factory: () => Bindings[T]): void;
+  /**
+   * Bind a singleton service to the container
+   */
+  singleton<T extends UseKey>(key: T | (new (..._args: any[]) => Bindings[T]), factory: () => Bindings[T]): void;
+  /**
+   * Resolve a service from the container
+   */
+  make<T extends UseKey, X = undefined>(key: T | (new (..._args: any[]) => Bindings[T])): X extends undefined ? Bindings[T] : X;
+  /**
+   * Automatically build a class with constructor dependency injection
+   */
+  private build;
+  /**
+   * Check if a service is registered
+   */
+  has(key: UseKey): boolean;
 }
-
+//#endregion
+//#region src/Application.d.ts
+type AServiceProvider = (new (_app: Application) => IServiceProvider) & IServiceProvider;
 declare class Application extends Container implements IApplication {
-    paths: PathLoader;
-    private booted;
-    private versions;
-    private basePath;
-    private providers;
-    protected externalProviders: Array<new (_app: Application) => IServiceProvider>;
-    constructor(basePath: string);
-    /**
-     * Register core bindings into the container
-     */
-    protected registerBaseBindings(): void;
-    /**
-     * Dynamically register all configured providers
-     */
-    registerConfiguredProviders(): Promise<void>;
-    protected loadOptions(): Promise<void>;
-    /**
-     * Load default and optional providers dynamically
-     *
-     * Auto-Registration Behavior
-     *
-     * Minimal App: Loads only core, config, http, router by default.
-     * Full-Stack App: Installs database, mail, queue, cache → they self-register via their providers.
-     */
-    protected getConfiguredProviders(): Promise<Array<new (_app: Application) => IServiceProvider>>;
-    protected getAllProviders(): Promise<Array<new (_app: Application) => IServiceProvider>>;
-    private sortProviders;
-    registerProviders(providers: Array<new (_app: Application) => IServiceProvider>): void;
-    /**
-     * Register a provider
-     */
-    register(provider: IServiceProvider): Promise<void>;
-    /**
-     * Boot all providers after registration
-     */
-    boot(): Promise<void>;
-    /**
-     * Attempt to dynamically import an optional module
-     */
-    private safeImport;
-    /**
-     * Get the base path of the app
-     *
-     * @returns
-     */
-    getBasePath(): string;
-    /**
-     * Dynamically retrieves a path property from the class.
-     * Any property ending with "Path" is accessible automatically.
-     *
-     * @param name - The base name of the path property
-     * @returns
-     */
-    getPath(name: IPathName, pth?: string): string;
-    /**
-     * Programatically set the paths.
-     *
-     * @param name - The base name of the path property
-     * @param path - The new path
-     * @returns
-     */
-    setPath(name: IPathName, path: string): void;
-    /**
-     * Returns the installed version of the system core and typescript.
-     *
-     * @returns
-     */
-    getVersion(key: 'app' | 'ts'): string;
+  paths: PathLoader;
+  private tries;
+  private booted;
+  private versions;
+  private basePath;
+  private providers;
+  protected externalProviders: Array<new (_app: Application) => IServiceProvider>;
+  /**
+   * List of registered console commands
+   */
+  registeredCommands: (new (app: any, kernel: any) => any)[];
+  constructor(basePath: string);
+  /**
+   * Register core bindings into the container
+   */
+  protected registerBaseBindings(): void;
+  /**
+   * Dynamically register all configured providers
+   */
+  registerConfiguredProviders(): Promise<void>;
+  protected loadOptions(): Promise<void>;
+  /**
+   * Get all registered providers
+   */
+  getRegisteredProviders(): IServiceProvider[];
+  /**
+   * Load default and optional providers dynamically
+   *
+   * Auto-Registration Behavior
+   *
+   * Minimal App: Loads only core, config, http, router by default.
+   * Full-Stack App: Installs database, mail, queue, cache → they self-register via their providers.
+   */
+  protected getConfiguredProviders(): Promise<Array<AServiceProvider>>;
+  protected getAllProviders(): Promise<Array<AServiceProvider>>;
+  private sortProviders;
+  registerProviders(providers: Array<AServiceProvider>): void;
+  /**
+   * Register a provider
+   */
+  register(provider: IServiceProvider): Promise<void>;
+  /**
+   * checks if the application is running in CLI
+   */
+  runningInConsole(): boolean;
+  getRuntimeEnv(): 'browser' | 'node' | 'unknown';
+  /**
+   * Boot all service providers after registration
+   */
+  boot(): Promise<void>;
+  /**
+   * Fire up the developement server using the user provided arguments
+   *
+   * Port will be auto assigned if provided one is not available
+   *
+   * @param h3App The current H3 app instance
+   * @param preferedPort If provided, this will overide the port set in the evironment
+   */
+  fire(h3App: H3, preferedPort?: number): Promise<void>;
+  /**
+   * Attempt to dynamically import an optional module
+   */
+  private safeImport;
+  /**
+   * Get the base path of the app
+   *
+   * @returns
+   */
+  getBasePath(): string;
+  /**
+   * Dynamically retrieves a path property from the class.
+   * Any property ending with "Path" is accessible automatically.
+   *
+   * @param name - The base name of the path property
+   * @returns
+   */
+  getPath(name: IPathName, suffix?: string): string;
+  /**
+   * Programatically set the paths.
+   *
+   * @param name - The base name of the path property
+   * @param path - The new path
+   * @returns
+   */
+  setPath(name: IPathName, path: string): void;
+  /**
+   * Returns the installed version of the system core and typescript.
+   *
+   * @returns
+   */
+  getVersion(key: 'app' | 'ts'): string;
 }
-
+//#endregion
+//#region src/Console/ConsoleKernel.d.ts
+declare class ConsoleKernel {
+  app: Application;
+  cwd: string;
+  output: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+  basePath: string;
+  modulePath: string;
+  consolePath: string;
+  modulePackage: XGeneric<{
+    version: string;
+  }>;
+  consolePackage: XGeneric<{
+    version: string;
+  }>;
+  constructor(app: Application);
+  ensureDirectoryExists(dir: string): Promise<void>;
+}
+//#endregion
+//#region src/Console/ConsoleCommand.d.ts
+declare class ConsoleCommand {
+  protected app: Application;
+  protected kernel: ConsoleKernel;
+  constructor(app: Application, kernel: ConsoleKernel);
+  /**
+   * The underlying commander instance.
+   *
+   * @var Command
+   */
+  program: Command;
+  /**
+   * The name and signature of the console command.
+   *
+   * @var string
+   */
+  protected signature: string;
+  /**
+   * A dictionary of signatures or what not.
+   *
+   * @var object
+   */
+  protected dictionary: Record<string, any>;
+  /**
+   * The console command description.
+   *
+   * @var string
+   */
+  protected description?: string;
+  /**
+   * The console command input.
+   *
+   * @var object
+   */
+  private input;
+  /**
+   * Execute the console command.
+   */
+  handle(..._args: any[]): Promise<void>;
+  setApplication(app: Application): void;
+  setInput(options: XGeneric, args: string[], regArgs: readonly Argument[], dictionary: Record<string, any>, program: Command): void;
+  getSignature(): string;
+  getDescription(): string | undefined;
+  option(key: string, def?: any): any;
+  options(key?: string): any;
+  argument(key: string, def?: any): any;
+  arguments(): Record<string, any>;
+}
+//#endregion
+//#region src/Contracts/ServiceProviderConstructor.d.ts
 type ServiceProviderConstructor = (new (app: Application) => ServiceProvider) & IServiceProvider;
-
+//#endregion
+//#region src/Controller.d.ts
 /**
  * Base controller class
  */
 declare abstract class Controller implements IController {
-    protected app: Application;
-    constructor(app: Application);
-    show(..._ctx: any[]): any;
-    index(..._ctx: any[]): any;
-    store(..._ctx: any[]): any;
-    update(..._ctx: any[]): any;
-    destroy(..._ctx: any[]): any;
+  protected app: Application;
+  constructor(app: Application);
+  show(..._ctx: any[]): any;
+  index(..._ctx: any[]): any;
+  store(..._ctx: any[]): any;
+  update(..._ctx: any[]): any;
+  destroy(..._ctx: any[]): any;
 }
-
+//#endregion
+//#region src/Di/ContainerResolver.d.ts
+declare class ContainerResolver {
+  private app;
+  constructor(app: Application);
+  resolveMethodParams<I extends Record<string, any>>(instance: I, method: keyof I, _default?: any): Promise<I>;
+  static isClass(C: any): boolean;
+}
+//#endregion
+//#region src/Di/Inject.d.ts
 declare function Inject(...dependencies: string[]): (target: any) => void;
 /**
  * Allows binding dependencies to both class and class methods
@@ -127,61 +234,82 @@ declare function Inject(...dependencies: string[]): (target: any) => void;
  * @returns
  */
 declare function Injectable(): ClassDecorator & MethodDecorator;
-
+//#endregion
+//#region src/Http/Kernel.d.ts
 /**
  * Kernel class handles middleware execution and response transformations.
  * It acts as the core middleware pipeline for HTTP requests.
  */
 declare class Kernel {
-    protected context: (event: H3Event) => HttpContext;
-    protected middleware: IMiddleware[];
-    /**
-     * @param context - A factory function that converts an H3Event into an HttpContext.
-     * @param middleware - An array of middleware classes that will be executed in sequence.
-     */
-    constructor(context: (event: H3Event) => HttpContext, middleware?: IMiddleware[]);
-    /**
-     * Handles an incoming request and passes it through middleware before invoking the next handler.
-     *
-     * @param event - The raw H3 event object.
-     * @param next - A callback function that represents the next layer (usually the controller or final handler).
-     * @returns A promise resolving to the result of the request pipeline.
-     */
-    handle(event: H3Event, next: (ctx: HttpContext) => Promise<unknown>): Promise<unknown>;
-    /**
-     * Sequentially runs middleware in the order they were registered.
-     *
-     * @param context - The standardized HttpContext.
-     * @param next - Callback to execute when middleware completes.
-     * @returns A promise resolving to the final handler's result.
-     */
-    private runMiddleware;
-    /**
-     * Utility function to determine if a value is a plain object or array.
-     *
-     * @param value - The value to check.
-     * @returns True if the value is a plain object or array, otherwise false.
-     */
-    private isPlainObject;
+  protected context: (event: H3Event) => HttpContext;
+  protected middleware: IMiddleware[];
+  /**
+   * @param context - A factory function that converts an H3Event into an HttpContext.
+   * @param middleware - An array of middleware classes that will be executed in sequence.
+   */
+  constructor(context: (event: H3Event) => HttpContext, middleware?: IMiddleware[]);
+  /**
+   * Handles an incoming request and passes it through middleware before invoking the next handler.
+   *
+   * @param event - The raw H3 event object.
+   * @param next - A callback function that represents the next layer (usually the controller or final handler).
+   * @returns A promise resolving to the result of the request pipeline.
+   */
+  handle(event: H3Event, next: (ctx: HttpContext) => Promise<unknown>): Promise<unknown>;
+  /**
+   * Sequentially runs middleware in the order they were registered.
+   *
+   * @param context - The standardized HttpContext.
+   * @param next - Callback to execute when middleware completes.
+   * @returns A promise resolving to the final handler's result.
+   */
+  private runMiddleware;
+  /**
+   * Utility function to determine if a value is a plain object or array.
+   *
+   * @param value - The value to check.
+   * @returns True if the value is a plain object or array, otherwise false.
+   */
+  private isPlainObject;
 }
-
+//#endregion
+//#region src/ServiceProvider.d.ts
 declare abstract class ServiceProvider implements IServiceProvider {
-    static order?: `before:${string}` | `after:${string}` | string | undefined;
-    static priority: number;
-    protected app: Application;
-    constructor(app: Application);
-    /**
-     * Register bindings to the container.
-     * Runs before boot().
-     */
-    abstract register(): void | Promise<void>;
-    /**
-     * Perform post-registration booting of services.
-     * Runs after all providers have been registered.
-     */
-    boot?(): void | Promise<void>;
+  /**
+   * Sort order
+   */
+  static order?: `before:${string}` | `after:${string}` | string | undefined;
+  /**
+   * Sort priority
+   */
+  static priority: number;
+  /**
+   * Indicate that this service provider only runs in console
+   */
+  static console: boolean;
+  /**
+   * List of registered console commands
+   */
+  registeredCommands?: (new (app: any, kernel: any) => any)[];
+  protected app: Application;
+  constructor(app: Application);
+  /**
+   * Register bindings to the container.
+   * Runs before boot().
+   */
+  abstract register(...app: unknown[]): void | Promise<void>;
+  /**
+   * Perform post-registration booting of services.
+   * Runs after all providers have been registered.
+   */
+  boot?(...app: unknown[]): void | Promise<void>;
+  /**
+   * An array of console commands to register.
+   */
+  commands(commands: (new (app: any, kernel: any) => any)[]): void;
 }
-
+//#endregion
+//#region src/Providers/CoreServiceProvider.d.ts
 /**
  * Bootstraps core services and bindings.
  *
@@ -192,17 +320,28 @@ declare abstract class ServiceProvider implements IServiceProvider {
  * Auto-Registered
  */
 declare class CoreServiceProvider extends ServiceProvider {
-    static priority: number;
-    register(): void;
+  static priority: number;
+  register(): void;
 }
-
+//#endregion
+//#region src/Providers/ViewServiceProvider.d.ts
 declare class ViewServiceProvider extends ServiceProvider {
-    static priority: number;
-    register(): void;
+  static priority: number;
+  register(): void;
 }
-
+//#endregion
+//#region src/Registerer.d.ts
 declare class Registerer {
-    static register(): void;
+  private app;
+  constructor(app: Application);
+  static register(app: Application): void;
+  bootRegister(): void;
+  private appPath;
+  private basePath;
+  private publicPath;
+  private storagePath;
+  private databasePath;
 }
-
-export { Application, Container, Controller, CoreServiceProvider, Inject, Injectable, Kernel, Registerer, ServiceProvider, type ServiceProviderConstructor, ViewServiceProvider };
+//#endregion
+export { Application, ConsoleCommand, ConsoleKernel, Container, ContainerResolver, Controller, CoreServiceProvider, Inject, Injectable, Kernel, Registerer, ServiceProvider, ServiceProviderConstructor, ViewServiceProvider };
+//# sourceMappingURL=index.d.ts.map