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

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

@@ -3,12 +3,35 @@ import { BaseCommand } from '../../modules/ace/main.ts';
 /**
  * The make middleware command to create a new middleware
  * class.
+ *
+ * @example
+ * ```
+ * ace make:middleware Auth
+ * ace make:middleware Auth --stack=server
+ * ace make:middleware Auth --stack=named
+ * ace make:middleware Auth --stack=router
+ * ```
  */
 export default class MakeMiddleware extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration
+     */
     static options: CommandOptions;
+    /**
+     * Name of the middleware
+     */
     name: string;
+    /**
+     * The stack in which to register the middleware
+     */
     stack?: 'server' | 'named' | 'router';
     /**
      * The stub to use for generating the middleware

package/build/commands/make/middleware.js

@@ -20,10 +20,27 @@ import { args, BaseCommand, flags } from "../../modules/ace/main.js";
 /**
  * The make middleware command to create a new middleware
  * class.
+ *
+ * @example
+ * ```
+ * ace make:middleware Auth
+ * ace make:middleware Auth --stack=server
+ * ace make:middleware Auth --stack=named
+ * ace make:middleware Auth --stack=router
+ * ```
  */
 export default class MakeMiddleware extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:middleware';
+    /**
+     * The command description
+     */
     static description = 'Create a new middleware class for HTTP requests';
+    /**
+     * Command options configuration
+     */
     static options = {
         allowUnknownFlags: true,
     };

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

@@ -2,21 +2,48 @@ import { BaseCommand } from '../../modules/ace/main.ts';
 declare const ALLOWED_ENVIRONMENTS: ("web" | "console" | "test" | "repl")[];
 type AllowedAppEnvironments = typeof ALLOWED_ENVIRONMENTS;
 /**
- * Make a new preload file
+ * Command to create a new preload file in the start directory.
+ * Preload files are executed during application startup and can be used
+ * to set up global configurations, register global bindings, or perform
+ * application-wide initialization tasks.
+ *
+ * @example
+ * ```
+ * ace make:preload routes
+ * ace make:preload database --register
+ * ace make:preload events --no-register
+ * ace make:preload kernel --environments=web,console
+ * ```
  */
 export default class MakePreload extends BaseCommand {
     #private;
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Name of the preload file to create
+     */
     name: string;
+    /**
+     * Automatically register the preload file in the .adonisrc.ts file
+     */
     register?: boolean;
+    /**
+     * Application environments where the preload file should be loaded
+     */
     environments?: AllowedAppEnvironments;
     /**
-     * The stub to use for generating the preload file
+     * The stub template file to use for generating the preload file
      */
     protected stubPath: string;
     /**
-     * Run command
+     * Execute the command to create a new preload file.
+     * Validates inputs, generates the preload file, and optionally registers it in .adonisrc.ts.
      */
     run(): Promise<void>;
 }

package/build/commands/make/preload.js

@@ -18,17 +18,36 @@ import stringHelpers from "../../src/helpers/string.js";
 import { args, flags, BaseCommand } from "../../modules/ace/main.js";
 const ALLOWED_ENVIRONMENTS = ['web', 'console', 'test', 'repl'];
 /**
- * Make a new preload file
+ * Command to create a new preload file in the start directory.
+ * Preload files are executed during application startup and can be used
+ * to set up global configurations, register global bindings, or perform
+ * application-wide initialization tasks.
+ *
+ * @example
+ * ```
+ * ace make:preload routes
+ * ace make:preload database --register
+ * ace make:preload events --no-register
+ * ace make:preload kernel --environments=web,console
+ * ```
  */
 export default class MakePreload extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:preload';
+    /**
+     * The command description
+     */
     static description = 'Create a new preload file inside the start directory';
     /**
-     * The stub to use for generating the preload file
+     * The stub template file to use for generating the preload file
      */
     stubPath = 'make/preload/main.stub';
     /**
-     * Validate the environments flag passed by the user
+     * Validate that all specified environments are valid application environments.
+     *
+     * @returns True if all environments are valid or none specified, false otherwise
      */
     #isEnvironmentsFlagValid() {
         if (!this.environments || !this.environments.length) {
@@ -37,7 +56,8 @@ export default class MakePreload extends BaseCommand {
         return this.environments.every((one) => ALLOWED_ENVIRONMENTS.includes(one));
     }
     /**
-     * Run command
+     * Execute the command to create a new preload file.
+     * Validates inputs, generates the preload file, and optionally registers it in .adonisrc.ts.
      */
     async run() {
         /**

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

@@ -2,19 +2,48 @@ import { BaseCommand } from '../../modules/ace/main.ts';
 declare const ALLOWED_ENVIRONMENTS: ("web" | "console" | "test" | "repl")[];
 type AllowedAppEnvironments = typeof ALLOWED_ENVIRONMENTS;
 /**
- * Make a new provider class
+ * Command to create a new service provider class.
+ * Service providers are used to register bindings, configure services,
+ * and bootstrap application components during startup.
+ *
+ * @example
+ * ```
+ * ace make:provider AuthProvider
+ * ace make:provider DatabaseProvider --register
+ * ace make:provider AppProvider --no-register
+ * ace make:provider CacheProvider --environments=web,console
+ * ```
  */
 export default class MakeProvider extends BaseCommand {
     #private;
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Name of the service provider to create
+     */
     name: string;
+    /**
+     * Automatically register the provider in the .adonisrc.ts file
+     */
     register?: boolean;
+    /**
+     * Application environments where the provider should be loaded
+     */
     environments?: AllowedAppEnvironments;
     /**
-     * The stub to use for generating the provider class
+     * The stub template file to use for generating the provider class
      */
     protected stubPath: string;
+    /**
+     * Execute the command to create a new service provider.
+     * Validates inputs, generates the provider file, and optionally registers it in .adonisrc.ts.
+     */
     run(): Promise<void>;
 }
 export {};

package/build/commands/make/provider.js

@@ -18,17 +18,35 @@ import stringHelpers from "../../src/helpers/string.js";
 import { args, BaseCommand, flags } from "../../modules/ace/main.js";
 const ALLOWED_ENVIRONMENTS = ['web', 'console', 'test', 'repl'];
 /**
- * Make a new provider class
+ * Command to create a new service provider class.
+ * Service providers are used to register bindings, configure services,
+ * and bootstrap application components during startup.
+ *
+ * @example
+ * ```
+ * ace make:provider AuthProvider
+ * ace make:provider DatabaseProvider --register
+ * ace make:provider AppProvider --no-register
+ * ace make:provider CacheProvider --environments=web,console
+ * ```
  */
 export default class MakeProvider extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:provider';
+    /**
+     * The command description
+     */
     static description = 'Create a new service provider class';
     /**
-     * The stub to use for generating the provider class
+     * The stub template file to use for generating the provider class
      */
     stubPath = 'make/provider/main.stub';
     /**
-     * Validate the environments flag passed by the user
+     * Validate that all specified environments are valid application environments.
+     *
+     * @returns True if all environments are valid or none specified, false otherwise
      */
     #isEnvironmentsFlagValid() {
         if (!this.environments || !this.environments.length) {
@@ -36,6 +54,10 @@ export default class MakeProvider extends BaseCommand {
         }
         return this.environments.every((one) => ALLOWED_ENVIRONMENTS.includes(one));
     }
+    /**
+     * Execute the command to create a new service provider.
+     * Validates inputs, generates the provider file, and optionally registers it in .adonisrc.ts.
+     */
     async run() {
         /**
          * Ensure the environments are valid when provided via flag

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

@@ -2,11 +2,30 @@ 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

@@ -16,10 +16,26 @@ 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.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

@@ -15,17 +15,36 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 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.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

@@ -15,20 +15,41 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 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, {