@h3ravel/core 1.14.0 → 1.16.0

package/dist/index.d.cts

@@ -24,7 +24,7 @@ declare class Container implements IContainer {
   /**
    * Bind a singleton service to the container
    */
-  singleton<T extends UseKey>(key: T | (new (..._args: any[]) => Bindings[T]), factory: () => Bindings[T]): void;
+  singleton<T extends UseKey>(key: T | (new (..._args: any[]) => Bindings[T]), factory: (app: this) => Bindings[T]): void;
   /**
    * Resolve a service from the container
    */
@@ -82,9 +82,19 @@ declare abstract class ServiceProvider extends Inference {
    */
   boot?(...app: unknown[]): void | Promise<void>;
   /**
-   * An array of console commands to register.
+   * Register the listed service providers.
+   *
+   * @param commands An array of console commands to register.
+   *
+   * @deprecated since version 1.16.0. Will be removed in future versions, use `registerCommands` instead
    */
   commands(commands: (new (app: any, kernel: any) => any)[]): void;
+  /**
+   * Register the listed service providers.
+   *
+   * @param commands An array of console commands to register.
+   */
+  registerCommands(commands: (new (app: any, kernel: any) => any)[]): void;
 }
 //#endregion
 //#region src/Application.d.ts
@@ -128,13 +138,17 @@ declare class Application extends Container implements IApplication {
    *
    * @param providers All regitererable service providers
    * @param filtered A list of service provider name strings we do not want to register at all cost
+   * @param autoRegisterProviders If set to false, service providers will not be auto discovered and registered.
+   *
    * @returns
    */
-  quickStartup(providers: Array<AServiceProvider>, filtered?: string[]): Promise<void>;
+  quickStartup(providers: Array<AServiceProvider>, filtered?: string[], autoRegisterProviders?: boolean): Promise<this>;
   /**
    * Dynamically register all configured providers
+   *
+   * @param autoRegister If set to false, service providers will not be auto discovered and registered.
    */
-  registerConfiguredProviders(): Promise<void>;
+  registerConfiguredProviders(autoRegister?: boolean): Promise<void>;
   /**
    * Register service providers
    *
@@ -146,6 +160,12 @@ declare class Application extends Container implements IApplication {
    * Register a provider
    */
   register(provider: ServiceProvider): Promise<void>;
+  /**
+   * Register the listed service providers.
+   *
+   * @param commands An array of console commands to register.
+   */
+  withCommands(commands: (new (app: any, kernel: any) => any)[]): this;
   /**
    * checks if the application is running in CLI
    */
@@ -154,7 +174,7 @@ declare class Application extends Container implements IApplication {
   /**
    * Boot all service providers after registration
    */
-  boot(): Promise<void>;
+  boot(): Promise<this>;
   /**
    * Fire up the developement server using the user provided arguments
    *
@@ -258,7 +278,9 @@ declare class ConsoleCommand {
    */
   handle(..._args: any[]): Promise<void>;
   setApplication(app: Application): void;
-  setInput(options: XGeneric, args: string[], regArgs: readonly Argument[], dictionary: Record<string, any>, program: Command): void;
+  setInput(options: XGeneric, args: string[], regArgs: readonly Argument[], dictionary: Record<string, any>, program: Command): this;
+  setOption(key: string, value: unknown): this;
+  setProgram(program: Command): this;
   getSignature(): string;
   getDescription(): string | undefined;
   option(key: string, def?: any): any;
@@ -266,34 +288,65 @@ declare class ConsoleCommand {
   argument(key: string, def?: any): any;
   arguments(): Record<string, any>;
   loadBaseFlags(): void;
+  /**
+   * Check if the command is quiet
+   *
+   * @returns
+   */
+  isQuiet(): any;
+  /**
+   * Check if the command is silent
+   *
+   * @returns
+   */
+  isSilent(): any;
+  /**
+   * Check if the command is non interactive
+   *
+   * @returns
+   */
+  isNonInteractive(): boolean;
+  /**
+   * Get the verbosity of the command
+   *
+   * @returns
+   */
+  getVerbosity(): number;
   /**
    * Log an info message
    */
-  info(message: string): void;
+  info(message: string): this;
   /**
    * Log a warning message
    */
-  warn(message: string): void;
+  warn(message: string): this;
   /**
    * Log a line message
    */
-  line(message: string): void;
+  line(message: string): this;
   /**
    * Log a new line
    */
-  newLine(count?: number): void;
+  newLine(count?: number): this;
   /**
    * Log a success message
    */
-  success(message: string): void;
+  success(message: string): this;
   /**
    * Log an error message
    */
-  error(message: string): void;
+  error(message: string): this;
+  /**
+   * Log an error message and terminate execution of the command
+   * return an exit code of 1
+   *
+   * This method is not chainable
+   */
+  fail(message: string): void;
   /**
    * Log a debug message
    */
-  debug(message: string | string[]): void;
+  debug(message: string | string[]): this;
 }
 //#endregion
 //#region src/Contracts/ServiceProviderConstructor.d.ts
@@ -317,7 +370,7 @@ declare abstract class Controller implements IController {
 declare class ContainerResolver {
   private app;
   constructor(app: Application);
-  resolveMethodParams<I extends Record<string, any>>(instance: I, method: keyof I, _default?: any): Promise<I>;
+  resolveMethodParams<I extends Record<string, any>>(instance: I, method: keyof I, ..._default: any[]): Promise<I>;
   static isClass(C: any): boolean;
 }
 //#endregion
@@ -380,6 +433,13 @@ declare class ProviderRegistry {
   private static providers;
   private static priorityMap;
   private static filteredProviders;
+  private static sortable;
+  /**
+   * Set wether providers should be sorted or not.
+   *
+   * @returns
+   */
+  static setSortable(sort?: boolean): void;
   /**
    * Get a unique identifier for the Provider.
    *
@@ -422,6 +482,10 @@ declare class ProviderRegistry {
    * @returns
    */
   static sort(providers: ProviderCtor[]): ProviderCtor[];
+  /**
+   * Sort service providers
+   */
+  static doSort(): void;
   /**
    * Log the service providers in a table
    *
@@ -441,6 +505,20 @@ declare class ProviderRegistry {
    * @returns
    */
   static has(provider: ProviderCtor): boolean;
+  /**
+   * Automatically search for and discover service providers in packages.
+   *
+   * @param autoRegister
+   * @returns
+   */
+  static discoverProviders(autoRegister?: boolean): Promise<ProviderCtor[]>;
+  /**
+   * Get the content of the package.json file
+   *
+   * @param manifestPath
+   * @returns
+   */
+  private static getManifest;
 }
 //#endregion
 //#region src/Providers/CoreServiceProvider.d.ts

package/dist/index.d.ts

@@ -25,7 +25,7 @@ declare class Container implements IContainer {
   /**
    * Bind a singleton service to the container
    */
-  singleton<T extends UseKey>(key: T | (new (..._args: any[]) => Bindings[T]), factory: () => Bindings[T]): void;
+  singleton<T extends UseKey>(key: T | (new (..._args: any[]) => Bindings[T]), factory: (app: this) => Bindings[T]): void;
   /**
    * Resolve a service from the container
    */
@@ -83,9 +83,19 @@ declare abstract class ServiceProvider extends Inference {
    */
   boot?(...app: unknown[]): void | Promise<void>;
   /**
-   * An array of console commands to register.
+   * Register the listed service providers.
+   *
+   * @param commands An array of console commands to register.
+   *
+   * @deprecated since version 1.16.0. Will be removed in future versions, use `registerCommands` instead
    */
   commands(commands: (new (app: any, kernel: any) => any)[]): void;
+  /**
+   * Register the listed service providers.
+   *
+   * @param commands An array of console commands to register.
+   */
+  registerCommands(commands: (new (app: any, kernel: any) => any)[]): void;
 }
 //#endregion
 //#region src/Application.d.ts
@@ -129,13 +139,17 @@ declare class Application extends Container implements IApplication {
    *
    * @param providers All regitererable service providers
    * @param filtered A list of service provider name strings we do not want to register at all cost
+   * @param autoRegisterProviders If set to false, service providers will not be auto discovered and registered.
+   *
    * @returns
    */
-  quickStartup(providers: Array<AServiceProvider>, filtered?: string[]): Promise<void>;
+  quickStartup(providers: Array<AServiceProvider>, filtered?: string[], autoRegisterProviders?: boolean): Promise<this>;
   /**
    * Dynamically register all configured providers
+   *
+   * @param autoRegister If set to false, service providers will not be auto discovered and registered.
    */
-  registerConfiguredProviders(): Promise<void>;
+  registerConfiguredProviders(autoRegister?: boolean): Promise<void>;
   /**
    * Register service providers
    *
@@ -147,6 +161,12 @@ declare class Application extends Container implements IApplication {
    * Register a provider
    */
   register(provider: ServiceProvider): Promise<void>;
+  /**
+   * Register the listed service providers.
+   *
+   * @param commands An array of console commands to register.
+   */
+  withCommands(commands: (new (app: any, kernel: any) => any)[]): this;
   /**
    * checks if the application is running in CLI
    */
@@ -155,7 +175,7 @@ declare class Application extends Container implements IApplication {
   /**
    * Boot all service providers after registration
    */
-  boot(): Promise<void>;
+  boot(): Promise<this>;
   /**
    * Fire up the developement server using the user provided arguments
    *
@@ -259,7 +279,9 @@ declare class ConsoleCommand {
    */
   handle(..._args: any[]): Promise<void>;
   setApplication(app: Application): void;
-  setInput(options: XGeneric, args: string[], regArgs: readonly Argument[], dictionary: Record<string, any>, program: Command): void;
+  setInput(options: XGeneric, args: string[], regArgs: readonly Argument[], dictionary: Record<string, any>, program: Command): this;
+  setOption(key: string, value: unknown): this;
+  setProgram(program: Command): this;
   getSignature(): string;
   getDescription(): string | undefined;
   option(key: string, def?: any): any;
@@ -267,34 +289,65 @@ declare class ConsoleCommand {
   argument(key: string, def?: any): any;
   arguments(): Record<string, any>;
   loadBaseFlags(): void;
+  /**
+   * Check if the command is quiet
+   *
+   * @returns
+   */
+  isQuiet(): any;
+  /**
+   * Check if the command is silent
+   *
+   * @returns
+   */
+  isSilent(): any;
+  /**
+   * Check if the command is non interactive
+   *
+   * @returns
+   */
+  isNonInteractive(): boolean;
+  /**
+   * Get the verbosity of the command
+   *
+   * @returns
+   */
+  getVerbosity(): number;
   /**
    * Log an info message
    */
-  info(message: string): void;
+  info(message: string): this;
   /**
    * Log a warning message
    */
-  warn(message: string): void;
+  warn(message: string): this;
   /**
    * Log a line message
    */
-  line(message: string): void;
+  line(message: string): this;
   /**
    * Log a new line
    */
-  newLine(count?: number): void;
+  newLine(count?: number): this;
   /**
    * Log a success message
    */
-  success(message: string): void;
+  success(message: string): this;
   /**
    * Log an error message
    */
-  error(message: string): void;
+  error(message: string): this;
+  /**
+   * Log an error message and terminate execution of the command
+   * return an exit code of 1
+   *
+   * This method is not chainable
+   */
+  fail(message: string): void;
   /**
    * Log a debug message
    */
-  debug(message: string | string[]): void;
+  debug(message: string | string[]): this;
 }
 //#endregion
 //#region src/Contracts/ServiceProviderConstructor.d.ts
@@ -318,7 +371,7 @@ declare abstract class Controller implements IController {
 declare class ContainerResolver {
   private app;
   constructor(app: Application);
-  resolveMethodParams<I extends Record<string, any>>(instance: I, method: keyof I, _default?: any): Promise<I>;
+  resolveMethodParams<I extends Record<string, any>>(instance: I, method: keyof I, ..._default: any[]): Promise<I>;
   static isClass(C: any): boolean;
 }
 //#endregion
@@ -381,6 +434,13 @@ declare class ProviderRegistry {
   private static providers;
   private static priorityMap;
   private static filteredProviders;
+  private static sortable;
+  /**
+   * Set wether providers should be sorted or not.
+   *
+   * @returns
+   */
+  static setSortable(sort?: boolean): void;
   /**
    * Get a unique identifier for the Provider.
    *
@@ -423,6 +483,10 @@ declare class ProviderRegistry {
    * @returns
    */
   static sort(providers: ProviderCtor[]): ProviderCtor[];
+  /**
+   * Sort service providers
+   */
+  static doSort(): void;
   /**
    * Log the service providers in a table
    *
@@ -442,6 +506,20 @@ declare class ProviderRegistry {
    * @returns
    */
   static has(provider: ProviderCtor): boolean;
+  /**
+   * Automatically search for and discover service providers in packages.
+   *
+   * @param autoRegister
+   * @returns
+   */
+  static discoverProviders(autoRegister?: boolean): Promise<ProviderCtor[]>;
+  /**
+   * Get the content of the package.json file
+   *
+   * @param manifestPath
+   * @returns
+   */
+  private static getManifest;
 }
 //#endregion
 //#region src/Providers/CoreServiceProvider.d.ts