@adonisjs/core 6.19.0 → 7.0.0-next.1

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

@@ -1,12 +1,31 @@
-import { BaseCommand } from '../../modules/ace/main.js';
-import { CommandOptions } from '../../types/ace.js';
+import { BaseCommand } from '../../modules/ace/main.ts';
+import { type CommandOptions } from '../../types/ace.ts';
 /**
  * Make a new service class
+ *
+ * @example
+ * ```
+ * ace make:service UserService
+ * ace make:service AuthService
+ * ace make:service User/ProfileService
+ * ```
  */
 export default class MakeService extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration
+     */
     static options: CommandOptions;
+    /**
+     * Name of the service
+     */
     name: string;
     /**
      * The stub to use for generating the service class

package/build/commands/make/service.js

@@ -12,14 +12,30 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { stubsRoot } from '../../stubs/main.js';
-import { args, BaseCommand } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+import { args, BaseCommand } from "../../modules/ace/main.js";
 /**
  * Make a new service class
+ *
+ * @example
+ * ```
+ * ace make:service UserService
+ * ace make:service AuthService
+ * ace make:service User/ProfileService
+ * ```
  */
 export default class MakeService extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:service';
+    /**
+     * The command description
+     */
     static description = 'Create a new service class';
+    /**
+     * Command options configuration
+     */
     static options = {
         allowUnknownFlags: true,
     };

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

@@ -1,19 +1,42 @@
-import { BaseCommand } from '../../modules/ace/main.js';
+import { BaseCommand } from '../../modules/ace/main.ts';
 /**
- * Make a new test file
+ * Command to create a new Japa test file.
+ * Supports multiple test suites and automatically detects or prompts for
+ * the appropriate suite and directory based on application configuration.
+ *
+ * @example
+ * ```
+ * ace make:test UserController
+ * ace make:test UserModel --suite=unit
+ * ace make:test AuthService --suite=integration
+ * ```
  */
 export default class MakeTest extends BaseCommand {
     #private;
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Name of the test file to create
+     */
     name: string;
+    /**
+     * Test suite name where the test file should be created
+     */
     suite?: string;
     /**
-     * The stub to use for generating the test file
+     * The stub template file to use for generating the test file
      */
     protected stubPath: string;
     /**
-     * Executed by ace
+     * Execute the command to create a new test file.
+     * Validates the suite exists, prompts for missing information,
+     * and generates the test file in the appropriate location.
      */
     run(): Promise<void>;
 }

package/build/commands/make/test.js

@@ -12,20 +12,39 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { stubsRoot } from '../../stubs/main.js';
-import { args, flags, BaseCommand } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+import { args, flags, BaseCommand } from "../../modules/ace/main.js";
 /**
- * Make a new test file
+ * Command to create a new Japa test file.
+ * Supports multiple test suites and automatically detects or prompts for
+ * the appropriate suite and directory based on application configuration.
+ *
+ * @example
+ * ```
+ * ace make:test UserController
+ * ace make:test UserModel --suite=unit
+ * ace make:test AuthService --suite=integration
+ * ```
  */
 export default class MakeTest extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:test';
+    /**
+     * The command description
+     */
     static description = 'Create a new Japa test file';
     /**
-     * The stub to use for generating the test file
+     * The stub template file to use for generating the test file
      */
     stubPath = 'make/test/main.stub';
     /**
-     * Returns the suite name for creating the test file
+     * Determine the test suite name for creating the test file.
+     * Uses the provided suite flag, or automatically selects if only one suite exists,
+     * or prompts the user to choose from available suites.
+     *
+     * @returns The name of the selected test suite
      */
     async #getSuite() {
         if (this.suite) {
@@ -51,7 +70,11 @@ export default class MakeTest extends BaseCommand {
         });
     }
     /**
-     * Returns the directory path for the selected suite.
+     * Determine the directory path for the test file within the selected suite.
+     * Automatically selects if only one directory exists, otherwise prompts the user.
+     *
+     * @param directories - Array of available directories for the suite
+     * @returns The selected directory path
      */
     async #getSuiteDirectory(directories) {
         if (directories.length === 1) {
@@ -64,7 +87,10 @@ export default class MakeTest extends BaseCommand {
         });
     }
     /**
-     * Find suite info from the rcFile file
+     * Find suite configuration from the RC file by name.
+     *
+     * @param suiteName - The name of the suite to find
+     * @returns The suite configuration or undefined if not found
      */
     #findSuite(suiteName) {
         return this.app.rcFile.tests.suites.find((suite) => {
@@ -72,7 +98,9 @@ export default class MakeTest extends BaseCommand {
         });
     }
     /**
-     * Executed by ace
+     * Execute the command to create a new test file.
+     * Validates the suite exists, prompts for missing information,
+     * and generates the test file in the appropriate location.
      */
     async run() {
         const suite = this.#findSuite(await this.#getSuite());

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

@@ -0,0 +1,43 @@
+import { BaseCommand } from '../../modules/ace/main.ts';
+import { type CommandOptions } from '../../types/ace.ts';
+/**
+ * Command to create a new transformer class.
+ * Transformers are used to serialize data objects (like models) into specific
+ * formats for API responses, allowing you to control which fields are exposed
+ * and how data is structured for clients.
+ *
+ * @example
+ * ```
+ * ace make:transformer User
+ * ace make:transformer Post
+ * ace make:transformer ProductTransformer
+ * ```
+ */
+export default class MakeTransformer 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 entity for which to generate the transformer
+     */
+    name: string;
+    /**
+     * The stub template file to use for generating the transformer class
+     */
+    protected stubPath: string;
+    /**
+     * Execute the command to create a new transformer class.
+     * Generates the transformer file with proper data serialization structure.
+     */
+    run(): Promise<void>;
+}

package/build/commands/make/transformer.js

@@ -0,0 +1,65 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { stubsRoot } from "../../stubs/main.js";
+import { args, BaseCommand } from "../../modules/ace/main.js";
+/**
+ * Command to create a new transformer class.
+ * Transformers are used to serialize data objects (like models) into specific
+ * formats for API responses, allowing you to control which fields are exposed
+ * and how data is structured for clients.
+ *
+ * @example
+ * ```
+ * ace make:transformer User
+ * ace make:transformer Post
+ * ace make:transformer ProductTransformer
+ * ```
+ */
+export default class MakeTransformer extends BaseCommand {
+    /**
+     * The command name
+     */
+    static commandName = 'make:transformer';
+    /**
+     * The command description
+     */
+    static description = 'Create a new transformer class';
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
+    static options = {
+        allowUnknownFlags: true,
+    };
+    /**
+     * The stub template file to use for generating the transformer class
+     */
+    stubPath = 'make/transformer/main.stub';
+    /**
+     * Execute the command to create a new transformer class.
+     * Generates the transformer file with proper data serialization structure.
+     */
+    async run() {
+        const codemods = await this.createCodemods();
+        await codemods.makeUsingStub(stubsRoot, this.stubPath, {
+            flags: this.parsed.flags,
+            entity: this.app.generators.createEntity(this.name),
+            model: this.app.generators.createEntity(this.name),
+        });
+    }
+}
+__decorate([
+    args.string({ description: 'Entity name for which to generate the transformer' })
+], MakeTransformer.prototype, "name", void 0);

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

@@ -1,21 +1,52 @@
-import { BaseCommand } from '../../modules/ace/main.js';
-import { CommandOptions } from '../../types/ace.js';
+import { BaseCommand } from '../../modules/ace/main.ts';
+import { type CommandOptions } from '../../types/ace.ts';
 /**
- * Make a new VineJS validator
+ * Command to create a new VineJS validator file.
+ * Validators define reusable validation schemas for request validation,
+ * and can be generated as simple validators or resource-based validators
+ * with create and update schemas.
+ *
+ * @example
+ * ```
+ * ace make:validator UserValidator
+ * ace make:validator PostValidator --resource
+ * ace make:validator ContactValidator
+ * ```
  */
 export default class MakeValidator 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 validator file to create
+     */
     name: string;
+    /**
+     * Generate a resource validator with create and update schemas
+     */
     resource: boolean;
     /**
-     * The stub to use for generating the validator
+     * The stub template file to use for generating the validator
      */
     protected stubPath: string;
     /**
-     * Preparing the command state
+     * Prepare the command by selecting the appropriate stub based on options.
+     * Uses a resource stub when generating validators for CRUD operations.
      */
     prepare(): Promise<void>;
+    /**
+     * Execute the command to create a new VineJS validator file.
+     * Generates the validator with the appropriate stub template.
+     */
     run(): Promise<void>;
 }

package/build/commands/make/validator.js

@@ -12,23 +12,44 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { stubsRoot } from '../../stubs/main.js';
-import { args, flags, BaseCommand } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+import { args, flags, BaseCommand } from "../../modules/ace/main.js";
 /**
- * Make a new VineJS validator
+ * Command to create a new VineJS validator file.
+ * Validators define reusable validation schemas for request validation,
+ * and can be generated as simple validators or resource-based validators
+ * with create and update schemas.
+ *
+ * @example
+ * ```
+ * ace make:validator UserValidator
+ * ace make:validator PostValidator --resource
+ * ace make:validator ContactValidator
+ * ```
  */
 export default class MakeValidator extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:validator';
+    /**
+     * The command description
+     */
     static description = 'Create a new file to define VineJS validators';
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options = {
         allowUnknownFlags: true,
     };
     /**
-     * The stub to use for generating the validator
+     * The stub template file to use for generating the validator
      */
     stubPath = 'make/validator/main.stub';
     /**
-     * Preparing the command state
+     * Prepare the command by selecting the appropriate stub based on options.
+     * Uses a resource stub when generating validators for CRUD operations.
      */
     async prepare() {
         /**
@@ -38,6 +59,10 @@ export default class MakeValidator extends BaseCommand {
             this.stubPath = 'make/validator/resource.stub';
         }
     }
+    /**
+     * Execute the command to create a new VineJS validator file.
+     * Generates the validator with the appropriate stub template.
+     */
     async run() {
         const codemods = await this.createCodemods();
         await codemods.makeUsingStub(stubsRoot, this.stubPath, {

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

@@ -1,14 +1,37 @@
-import { BaseCommand } from '../../modules/ace/main.js';
+import { BaseCommand } from '../../modules/ace/main.ts';
 /**
- * Make a new EdgeJS template file
+ * Command to create a new Edge.js template file.
+ * Edge templates are used for rendering HTML views in your web application,
+ * supporting layouts, partials, components, and template inheritance.
+ *
+ * @example
+ * ```
+ * ace make:view home
+ * ace make:view users/profile
+ * ace make:view components/navbar
+ * ace make:view layouts/app
+ * ```
  */
 export default class MakeView extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Name of the template file to create
+     */
     name: string;
     /**
-     * The stub to use for generating the template
+     * The stub template file to use for generating the Edge template
      */
     protected stubPath: string;
+    /**
+     * Execute the command to create a new Edge.js template file.
+     * Generates the template file in the views directory.
+     */
     run(): Promise<void>;
 }

package/build/commands/make/view.js

@@ -12,18 +12,38 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { stubsRoot } from '../../stubs/main.js';
-import { args, BaseCommand } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+import { args, BaseCommand } from "../../modules/ace/main.js";
 /**
- * Make a new EdgeJS template file
+ * Command to create a new Edge.js template file.
+ * Edge templates are used for rendering HTML views in your web application,
+ * supporting layouts, partials, components, and template inheritance.
+ *
+ * @example
+ * ```
+ * ace make:view home
+ * ace make:view users/profile
+ * ace make:view components/navbar
+ * ace make:view layouts/app
+ * ```
  */
 export default class MakeView extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:view';
+    /**
+     * The command description
+     */
     static description = 'Create a new Edge.js template file';
     /**
-     * The stub to use for generating the template
+     * The stub template file to use for generating the Edge template
      */
     stubPath = 'make/view/main.stub';
+    /**
+     * Execute the command to create a new Edge.js template file.
+     * Generates the template file in the views directory.
+     */
     async run() {
         const codemods = await this.createCodemods();
         await codemods.makeUsingStub(stubsRoot, this.stubPath, {

package/build/commands/repl.d.ts

@@ -1,14 +1,34 @@
-import { BaseCommand } from '../modules/ace/main.js';
-import { CommandOptions } from '../types/ace.js';
+import { BaseCommand } from '../modules/ace/main.ts';
+import { type CommandOptions } from '../types/ace.ts';
 /**
- * The ReplCommand class is used to start the Repl server
+ * Command to start an interactive REPL (Read-Eval-Print Loop) session for AdonisJS.
+ * The REPL provides a command-line interface where you can execute JavaScript code
+ * in the context of your AdonisJS application, allowing you to interact with models,
+ * services, and other application components in real-time.
+ *
+ * @example
+ * ```
+ * ace repl
+ * ```
  */
 export default class ReplCommand extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration.
+     * Requires the application to be started and keeps the process alive.
+     */
     static options: CommandOptions;
     /**
-     * Starts the REPL server process
+     * Execute the command to start the REPL server.
+     * Creates a REPL instance from the container and sets up an exit handler
+     * that properly terminates the application when the REPL session ends.
      */
     run(): Promise<void>;
 }

package/build/commands/repl.js

@@ -6,19 +6,39 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { BaseCommand } from '../modules/ace/main.js';
+import { BaseCommand } from "../modules/ace/main.js";
 /**
- * The ReplCommand class is used to start the Repl server
+ * Command to start an interactive REPL (Read-Eval-Print Loop) session for AdonisJS.
+ * The REPL provides a command-line interface where you can execute JavaScript code
+ * in the context of your AdonisJS application, allowing you to interact with models,
+ * services, and other application components in real-time.
+ *
+ * @example
+ * ```
+ * ace repl
+ * ```
  */
 export default class ReplCommand extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'repl';
+    /**
+     * The command description
+     */
     static description = 'Start a new REPL session';
+    /**
+     * Command options configuration.
+     * Requires the application to be started and keeps the process alive.
+     */
     static options = {
         startApp: true,
         staysAlive: true,
     };
     /**
-     * Starts the REPL server process
+     * Execute the command to start the REPL server.
+     * Creates a REPL instance from the container and sets up an exit handler
+     * that properly terminates the application when the REPL session ends.
      */
     async run() {
         const repl = await this.app.container.make('repl');

package/build/commands/serve.d.ts

@@ -1,24 +1,58 @@
 import type { DevServer } from '@adonisjs/assembler';
-import type { CommandOptions } from '../types/ace.js';
-import { BaseCommand } from '../modules/ace/main.js';
+import type { CommandOptions } from '../types/ace.ts';
+import { BaseCommand } from '../modules/ace/main.ts';
 /**
  * Serve command is used to run the AdonisJS HTTP server during development. The
  * command under the hood runs the "bin/server.ts" file and watches for file
  * system changes
+ *
+ * @example
+ * ```
+ * ace serve
+ * ace serve --watch
+ * ace serve --hmr
+ * ace serve --poll
+ * ace serve --no-clear
+ * ```
  */
 export default class Serve extends BaseCommand {
     #private;
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Help text for the command
+     */
     static help: string[];
+    /**
+     * Command options configuration
+     */
     static options: CommandOptions;
+    /**
+     * The development server instance
+     */
     devServer: DevServer;
+    /**
+     * Start the server with HMR support
+     */
     hmr?: boolean;
+    /**
+     * Watch filesystem and restart the HTTP server on file change
+     */
     watch?: boolean;
+    /**
+     * Use polling to detect filesystem changes
+     */
     poll?: boolean;
+    /**
+     * Clear the terminal for new logs after file change
+     */
     clear?: boolean;
-    assets?: boolean;
-    assetsArgs?: string[];
     /**
      * Runs the HTTP server
      */