@adonisjs/core 6.19.0 → 7.0.0-next.1

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

@@ -1,16 +1,42 @@
-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 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

@@ -12,21 +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, BaseCommand } from '../../modules/ace/main.js';
+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.js';
-import { CommandOptions } from '../../types/ace.js';
+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

@@ -12,21 +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, BaseCommand } from '../../modules/ace/main.js';
+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.js';
-import { CommandOptions } from '../../types/ace.js';
+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

@@ -12,27 +12,54 @@ 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";
 /**
- * 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) {

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

@@ -1,14 +1,37 @@
-import { BaseCommand } from '../../modules/ace/main.js';
-import { CommandOptions } from '../../types/ace.js';
+import { type CommandOptions } from '../../types/ace.ts';
+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

@@ -12,18 +12,35 @@ 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 { slash } from '@poppinss/utils';
 import string from '@poppinss/utils/string';
 import { basename, extname, relative } from 'node:path';
-import { stubsRoot } from '../../stubs/main.js';
-import { args, BaseCommand, flags } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+import stringHelpers from "../../src/helpers/string.js";
+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,
     };
@@ -60,7 +77,7 @@ export default class MakeMiddleware extends BaseCommand {
          * Creative relative path for the middleware file from
          * the "./app/middleware" directory
          */
-        const middlewareRelativePath = slash(relative(this.app.middlewarePath(), destination).replace(extname(destination), ''));
+        const middlewareRelativePath = stringHelpers.toUnixSlash(relative(this.app.middlewarePath(), destination).replace(extname(destination), ''));
         /**
          * Take the middleware relative path, remove `_middleware` prefix from it
          * and convert everything to camelcase

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

@@ -1,22 +1,49 @@
-import { BaseCommand } from '../../modules/ace/main.js';
+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

@@ -12,23 +12,42 @@ 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 { slash } from '@poppinss/utils';
 import { extname, relative } from 'node:path';
-import { stubsRoot } from '../../stubs/main.js';
-import { args, flags, BaseCommand } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+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() {
         /**
@@ -70,7 +90,7 @@ export default class MakePreload extends BaseCommand {
          * Creative relative path for the preload file from
          * the "./start" directory
          */
-        const preloadFileRelativePath = slash(relative(this.app.startPath(), destination).replace(extname(destination), ''));
+        const preloadFileRelativePath = stringHelpers.toUnixSlash(relative(this.app.startPath(), destination).replace(extname(destination), ''));
         await codemods.updateRcFile((rcFile) => {
             rcFile.addPreloadFile(`#start/${preloadFileRelativePath}`, this.environments);
         });

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

@@ -1,20 +1,49 @@
-import { BaseCommand } from '../../modules/ace/main.js';
+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

@@ -12,23 +12,41 @@ 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 { slash } from '@poppinss/utils';
 import { extname, relative } from 'node:path';
-import { stubsRoot } from '../../stubs/main.js';
-import { args, BaseCommand, flags } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+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
@@ -67,7 +89,7 @@ export default class MakeProvider extends BaseCommand {
          * Creative relative path for the provider file from
          * the "./start" directory
          */
-        const providerRelativePath = slash(relative(this.app.providersPath(), destination).replace(extname(destination), ''));
+        const providerRelativePath = stringHelpers.toUnixSlash(relative(this.app.providersPath(), destination).replace(extname(destination), ''));
         await codemods.updateRcFile((rcFile) => {
             rcFile.addProvider(`#providers/${providerRelativePath}`, this.environments);
         });