@adonisjs/core 7.0.0-next.0 → 7.0.0-next.10

package/build/commands/generate_key.js

@@ -18,9 +18,22 @@ import { BaseCommand, flags } from "../modules/ace/main.js";
 /**
  * The generate key command is used to generate the app key
  * and write it inside the .env file.
+ *
+ * @example
+ * ```
+ * ace generate:key
+ * ace generate:key --show
+ * ace generate:key --force
+ * ```
  */
 export default class GenerateKey extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'generate:key';
+    /**
+     * The command description
+     */
     static description = 'Generate a cryptographically secure random application key';
     async run() {
         let writeToFile = process.env.NODE_ENV !== 'production';

package/build/commands/inspect_rcfile.d.ts

@@ -1,9 +1,27 @@
 import { BaseCommand } from '../modules/ace/main.ts';
 /**
- * Prints the RcFile file contents to the terminal
+ * Command to inspect and display the AdonisJS RC file contents with default values.
+ * The RC file contains configuration for providers, preloads, commands, and other
+ * application settings. This command formats and displays the contents in a readable JSON format.
+ *
+ * @example
+ * ```
+ * ace inspect:rcfile
+ * ```
  */
 export default class InspectRCFile extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Execute the command to display RC file contents.
+     * Transforms provider, preload, and command entries to display their file paths
+     * as strings and formats the output as readable JSON.
+     */
     run(): Promise<void>;
 }

package/build/commands/inspect_rcfile.js

@@ -8,11 +8,29 @@
  */
 import { BaseCommand } from "../modules/ace/main.js";
 /**
- * Prints the RcFile file contents to the terminal
+ * Command to inspect and display the AdonisJS RC file contents with default values.
+ * The RC file contains configuration for providers, preloads, commands, and other
+ * application settings. This command formats and displays the contents in a readable JSON format.
+ *
+ * @example
+ * ```
+ * ace inspect:rcfile
+ * ```
  */
 export default class InspectRCFile extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'inspect:rcfile';
+    /**
+     * The command description
+     */
     static description = 'Inspect the RC file with its default values';
+    /**
+     * Execute the command to display RC file contents.
+     * Transforms provider, preload, and command entries to display their file paths
+     * as strings and formats the output as readable JSON.
+     */
     async run() {
         const { raw, providers, preloads, commands, ...rest } = this.app.rcFile;
         this.logger.log(JSON.stringify({

package/build/commands/list/routes.d.ts

@@ -1,36 +1,58 @@
 import type { CommandOptions } from '../../types/ace.ts';
 import { BaseCommand } from '../../modules/ace/main.ts';
 /**
- * The list routes command is used to view the list of registered routes
+ * Command to display a list of all registered routes in the application.
+ * Supports filtering by keywords, middleware, and output formatting options.
+ * Routes can be displayed as a formatted list, table, or JSON.
+ *
+ * @example
+ * ```
+ * ace list:routes
+ * ace list:routes user
+ * ace list:routes --middleware=auth
+ * ace list:routes --ignore-middleware=guest
+ * ace list:routes --json
+ * ace list:routes --table
+ * ```
  */
 export default class ListRoutes extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
     /**
-     * Making sure to start the application so that the routes are
-     * imported
+     * Command options configuration.
+     * Requires the application to be started so routes are loaded.
      */
     static options: CommandOptions;
     /**
-     * The match filter is used to find route by name, pattern and controller name that
-     * includes the match keyword
+     * Keyword to match against route names, patterns, and controller names
      */
     match: string;
     /**
-     * The middleware flag searches for the routes using all the mentioned middleware
+     * Filter routes that include all specified middleware names
      */
     middleware: string[];
     /**
-     * The ignoreMiddleware flag searches for the routes not using all the mentioned middleware
+     * Filter routes that do not include all specified middleware names
      */
     ignoreMiddleware: string[];
     /**
-     * The json flag is used to view list of routes as a JSON string.
+     * Output routes as JSON format
      */
     json: boolean;
     /**
-     * The table flag is used to view list of routes as a classic CLI table
+     * Output routes as a CLI table format
      */
     table: boolean;
+    /**
+     * Execute the command to list application routes.
+     * Creates a formatter with the specified filters and outputs routes
+     * in the requested format (JSON, table, or formatted list).
+     */
     run(): Promise<void>;
 }

package/build/commands/list/routes.js

@@ -15,18 +15,41 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { args, BaseCommand, flags } from "../../modules/ace/main.js";
 import { RoutesListFormatter } from "../../src/cli_formatters/routes_list.js";
 /**
- * The list routes command is used to view the list of registered routes
+ * Command to display a list of all registered routes in the application.
+ * Supports filtering by keywords, middleware, and output formatting options.
+ * Routes can be displayed as a formatted list, table, or JSON.
+ *
+ * @example
+ * ```
+ * ace list:routes
+ * ace list:routes user
+ * ace list:routes --middleware=auth
+ * ace list:routes --ignore-middleware=guest
+ * ace list:routes --json
+ * ace list:routes --table
+ * ```
  */
 export default class ListRoutes extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'list:routes';
+    /**
+     * The command description
+     */
     static description = 'List application routes. This command will boot the application in the console environment';
     /**
-     * Making sure to start the application so that the routes are
-     * imported
+     * Command options configuration.
+     * Requires the application to be started so routes are loaded.
      */
     static options = {
         startApp: true,
     };
+    /**
+     * Execute the command to list application routes.
+     * Creates a formatter with the specified filters and outputs routes
+     * in the requested format (JSON, table, or formatted list).
+     */
     async run() {
         const router = await this.app.container.make('router');
         const formatter = new RoutesListFormatter(router, this.ui, {}, {

package/build/commands/make/command.d.ts

@@ -1,14 +1,37 @@
 import { BaseCommand } from '../../modules/ace/main.ts';
 /**
- * Make a new ace command
+ * Command to create a new Ace command class.
+ * Ace commands are CLI commands that can be executed via the `ace` binary,
+ * allowing you to create custom functionality for your application's command line interface.
+ *
+ * @example
+ * ```
+ * ace make:command SendEmails
+ * ace make:command ProcessPayments
+ * ace make:command GenerateReports
+ * ace make:command CleanupFiles
+ * ```
  */
 export default class MakeCommand extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Name of the command class to create
+     */
     name: string;
     /**
-     * The stub to use for generating the command class
+     * The stub template file to use for generating the command class
      */
     protected stubPath: string;
+    /**
+     * Execute the command to create a new Ace command class.
+     * Generates the command file with proper CLI command structure.
+     */
     run(): Promise<void>;
 }

package/build/commands/make/command.js

@@ -16,15 +16,35 @@ import { stubsRoot } from "../../stubs/main.js";
 import { args } from "../../modules/ace/main.js";
 import { BaseCommand } from "../../modules/ace/main.js";
 /**
- * Make a new ace command
+ * Command to create a new Ace command class.
+ * Ace commands are CLI commands that can be executed via the `ace` binary,
+ * allowing you to create custom functionality for your application's command line interface.
+ *
+ * @example
+ * ```
+ * ace make:command SendEmails
+ * ace make:command ProcessPayments
+ * ace make:command GenerateReports
+ * ace make:command CleanupFiles
+ * ```
  */
 export default class MakeCommand extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:command';
+    /**
+     * The command description
+     */
     static description = 'Create a new ace command class';
     /**
-     * The stub to use for generating the command class
+     * The stub template file to use for generating the command class
      */
     stubPath = 'make/command/main.stub';
+    /**
+     * Execute the command to create a new Ace command class.
+     * Generates the command file with proper CLI command structure.
+     */
     async run() {
         const codemods = await this.createCodemods();
         await codemods.makeUsingStub(stubsRoot, this.stubPath, {

package/build/commands/make/controller.d.ts

@@ -2,15 +2,48 @@ import { BaseCommand } from '../../modules/ace/main.ts';
 import { type CommandOptions } from '../../types/ace.ts';
 /**
  * The make controller command to create an HTTP controller
+ *
+ * @example
+ * ```
+ * ace make:controller User
+ * ace make:controller User store update
+ * ace make:controller User --resource
+ * ace make:controller User --api
+ * ace make:controller User --singular
+ * ```
  */
 export default class MakeController extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration
+     */
     static options: CommandOptions;
+    /**
+     * The name of the controller
+     */
     name: string;
+    /**
+     * Create controller with custom method names
+     */
     actions?: string[];
+    /**
+     * Generate controller in singular form
+     */
     singular: boolean;
+    /**
+     * Generate resourceful controller with methods to perform CRUD actions on a resource
+     */
     resource: boolean;
+    /**
+     * Generate resourceful controller without the "edit" and the "create" methods
+     */
     api: boolean;
     /**
      * The stub to use for generating the controller

package/build/commands/make/controller.js

@@ -17,10 +17,28 @@ import { stubsRoot } from "../../stubs/main.js";
 import { args, flags, BaseCommand } from "../../modules/ace/main.js";
 /**
  * The make controller command to create an HTTP controller
+ *
+ * @example
+ * ```
+ * ace make:controller User
+ * ace make:controller User store update
+ * ace make:controller User --resource
+ * ace make:controller User --api
+ * ace make:controller User --singular
+ * ```
  */
 export default class MakeController extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:controller';
+    /**
+     * The command description
+     */
     static description = 'Create a new HTTP controller class';
+    /**
+     * Command options configuration
+     */
     static options = {
         allowUnknownFlags: true,
     };

package/build/commands/make/event.d.ts

@@ -1,16 +1,42 @@
 import { BaseCommand } from '../../modules/ace/main.ts';
 import { type CommandOptions } from '../../types/ace.ts';
 /**
- * The make event command to create a class based event
+ * Command to create a new event class.
+ * Events are data objects that encapsulate information about something
+ * that happened in your application and can be dispatched to listeners.
+ *
+ * @example
+ * ```
+ * ace make:event UserRegistered
+ * ace make:event OrderCompleted
+ * ace make:event EmailSent
+ * ```
  */
 export default class MakeEvent extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options: CommandOptions;
+    /**
+     * Name of the event class to create
+     */
     name: string;
     /**
-     * The stub to use for generating the event
+     * The stub template file to use for generating the event class
      */
     protected stubPath: string;
+    /**
+     * Execute the command to create a new event class.
+     * Generates the event file with proper event structure.
+     */
     run(): Promise<void>;
 }

package/build/commands/make/event.js

@@ -15,18 +15,41 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { stubsRoot } from "../../stubs/main.js";
 import { args, BaseCommand } from "../../modules/ace/main.js";
 /**
- * The make event command to create a class based event
+ * Command to create a new event class.
+ * Events are data objects that encapsulate information about something
+ * that happened in your application and can be dispatched to listeners.
+ *
+ * @example
+ * ```
+ * ace make:event UserRegistered
+ * ace make:event OrderCompleted
+ * ace make:event EmailSent
+ * ```
  */
 export default class MakeEvent extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:event';
+    /**
+     * The command description
+     */
     static description = 'Create a new event class';
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options = {
         allowUnknownFlags: true,
     };
     /**
-     * The stub to use for generating the event
+     * The stub template file to use for generating the event class
      */
     stubPath = 'make/event/main.stub';
+    /**
+     * Execute the command to create a new event class.
+     * Generates the event file with proper event structure.
+     */
     async run() {
         const codemods = await this.createCodemods();
         await codemods.makeUsingStub(stubsRoot, this.stubPath, {

package/build/commands/make/exception.d.ts

@@ -1,16 +1,42 @@
 import { BaseCommand } from '../../modules/ace/main.ts';
 import { type CommandOptions } from '../../types/ace.ts';
 /**
- * Make a new exception class
+ * Command to create a new custom exception class.
+ * Custom exceptions allow you to define specific error types for your application
+ * with custom error messages, status codes, and error handling logic.
+ *
+ * @example
+ * ```
+ * ace make:exception ValidationException
+ * ace make:exception UnauthorizedException
+ * ace make:exception ResourceNotFoundException
+ * ```
  */
 export default class MakeException extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options: CommandOptions;
+    /**
+     * Name of the exception class to create
+     */
     name: string;
     /**
-     * The stub to use for generating the command class
+     * The stub template file to use for generating the exception class
      */
     protected stubPath: string;
+    /**
+     * Execute the command to create a new custom exception class.
+     * Generates the exception file with proper error handling structure.
+     */
     run(): Promise<void>;
 }

package/build/commands/make/exception.js

@@ -15,18 +15,41 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { stubsRoot } from "../../stubs/main.js";
 import { args, BaseCommand } from "../../modules/ace/main.js";
 /**
- * Make a new exception class
+ * Command to create a new custom exception class.
+ * Custom exceptions allow you to define specific error types for your application
+ * with custom error messages, status codes, and error handling logic.
+ *
+ * @example
+ * ```
+ * ace make:exception ValidationException
+ * ace make:exception UnauthorizedException
+ * ace make:exception ResourceNotFoundException
+ * ```
  */
 export default class MakeException extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:exception';
+    /**
+     * The command description
+     */
     static description = 'Create a new custom exception class';
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options = {
         allowUnknownFlags: true,
     };
     /**
-     * The stub to use for generating the command class
+     * The stub template file to use for generating the exception class
      */
     stubPath = 'make/exception/main.stub';
+    /**
+     * Execute the command to create a new custom exception class.
+     * Generates the exception file with proper error handling structure.
+     */
     async run() {
         const codemods = await this.createCodemods();
         await codemods.makeUsingStub(stubsRoot, this.stubPath, {

package/build/commands/make/listener.d.ts

@@ -1,19 +1,52 @@
 import { BaseCommand } from '../../modules/ace/main.ts';
 import { type CommandOptions } from '../../types/ace.ts';
 /**
- * The make listener command to create a class based event
- * listener
+ * Command to create a new event listener class.
+ * Event listeners handle events dispatched by the application and can optionally
+ * generate the corresponding event class automatically.
+ *
+ * @example
+ * ```
+ * ace make:listener UserRegistered
+ * ace make:listener EmailSent --event=EmailSent
+ * ace make:listener OrderCompleted --event=OrderEvent
+ * ```
  */
 export default class MakeListener extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options: CommandOptions;
+    /**
+     * Name of the event listener class to create
+     */
     name: string;
+    /**
+     * Generate an event class alongside the listener and bind them together
+     */
     event: string;
     /**
-     * The stub to use for generating the event listener
+     * The stub template file to use for generating the event listener
      */
     protected stubPath: string;
+    /**
+     * Prepare the command by selecting the appropriate stub based on options.
+     * Uses a different stub when generating a listener for a specific event.
+     */
     prepare(): void;
+    /**
+     * Execute the command to create a new event listener.
+     * If an event is specified, creates the event class first,
+     * then generates the listener with proper event binding.
+     */
     run(): Promise<void>;
 }

package/build/commands/make/listener.js

@@ -15,24 +15,51 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { stubsRoot } from "../../stubs/main.js";
 import { args, flags, BaseCommand } from "../../modules/ace/main.js";
 /**
- * The make listener command to create a class based event
- * listener
+ * Command to create a new event listener class.
+ * Event listeners handle events dispatched by the application and can optionally
+ * generate the corresponding event class automatically.
+ *
+ * @example
+ * ```
+ * ace make:listener UserRegistered
+ * ace make:listener EmailSent --event=EmailSent
+ * ace make:listener OrderCompleted --event=OrderEvent
+ * ```
  */
 export default class MakeListener extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:listener';
+    /**
+     * The command description
+     */
     static description = 'Create a new event listener class';
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options = {
         allowUnknownFlags: true,
     };
     /**
-     * The stub to use for generating the event listener
+     * The stub template file to use for generating the event listener
      */
     stubPath = 'make/listener/main.stub';
+    /**
+     * Prepare the command by selecting the appropriate stub based on options.
+     * Uses a different stub when generating a listener for a specific event.
+     */
     prepare() {
         if (this.event) {
             this.stubPath = 'make/listener/for_event.stub';
         }
     }
+    /**
+     * Execute the command to create a new event listener.
+     * If an event is specified, creates the event class first,
+     * then generates the listener with proper event binding.
+     */
     async run() {
         const codemods = await this.createCodemods();
         if (this.event) {