@adonisjs/core 7.0.0-next.5 → 7.0.0-next.7

package/build/modules/ace/codemods.d.ts

@@ -75,29 +75,101 @@ export declare class Codemods extends EventEmitter {
      */
     getTsMorphProject(): Promise<CodeTransformer['project'] | undefined>;
     /**
-     * Define validations for the environment variables
+     * Define validations for the environment variables in the start/env.ts file.
+     * This method updates the environment validation schema using the assembler.
+     *
+     * @param validations - Validation schema node for environment variables
+     *
+     * @example
+     * ```ts
+     * await codemods.defineEnvValidations({
+     *   NODE_ENV: 'Env.schema.enum(["development", "production", "test"] as const)',
+     *   PORT: 'Env.schema.number()',
+     *   HOST: 'Env.schema.string({ format: "host" })'
+     * })
+     * ```
      */
     defineEnvValidations(validations: EnvValidationNode): Promise<void>;
     /**
-     * Define validations for the environment variables
+     * Register middleware in the start/kernel.ts file.
+     * This method adds middleware to the specified stack (server, router, or named).
+     *
+     * @param stack - The middleware stack to register to ('server' | 'router' | 'named')
+     * @param middleware - Array of middleware nodes to register
+     *
+     * @example
+     * ```ts
+     * await codemods.registerMiddleware('server', [
+     *   {
+     *     name: 'cors',
+     *     path: '@adonisjs/cors/cors_middleware'
+     *   }
+     * ])
+     * ```
      */
     registerMiddleware(stack: 'server' | 'router' | 'named', middleware: MiddlewareNode[]): Promise<void>;
     /**
-     * Register bouncer policies to the list of policies
-     * collection exported from the "app/policies/main.ts"
-     * file.
+     * Register bouncer policies to the list of policies collection exported from
+     * the "app/policies/main.ts" file. This method adds new policy definitions
+     * to the policies export.
+     *
+     * @param policies - Array of policy nodes to register
+     *
+     * @example
+     * ```ts
+     * await codemods.registerPolicies([
+     *   {
+     *     name: 'UserPolicy',
+     *     path: '#policies/user_policy'
+     *   }
+     * ])
+     * ```
      */
     registerPolicies(policies: BouncerPolicyNode[]): Promise<void>;
     /**
-     * Update RCFile
+     * Update the adonisrc.ts file with new configuration settings.
+     * This method allows modification of the AdonisJS runtime configuration.
+     *
+     * @param params - Parameters for updating the RC file (varies based on update type)
+     *
+     * @example
+     * ```ts
+     * await codemods.updateRcFile((rcFile) => {
+     *   rcFile.addCommand('make:custom')
+     *   rcFile.addPreloadFile('#app/events/main')
+     * })
+     * ```
      */
     updateRcFile(...params: Parameters<CodeTransformer['updateRcFile']>): Promise<void>;
     /**
-     * Register a new Vite plugin in the `vite.config.ts` file
+     * Register a new Vite plugin in the vite.config.ts file.
+     * This method adds plugin configuration to the Vite build configuration.
+     *
+     * @param params - Parameters for adding the Vite plugin (varies based on plugin type)
+     *
+     * @example
+     * ```ts
+     * await codemods.registerVitePlugin({
+     *   name: 'vue',
+     *   import: 'import vue from "@vitejs/plugin-vue"',
+     *   options: '()'
+     * })
+     * ```
      */
     registerVitePlugin(...params: Parameters<CodeTransformer['addVitePlugin']>): Promise<void>;
     /**
-     * Register a new Japa plugin in the `tests/bootstrap.ts` file
+     * Register a new Japa plugin in the tests/bootstrap.ts file.
+     * This method adds plugin configuration to the test runner setup.
+     *
+     * @param params - Parameters for adding the Japa plugin (varies based on plugin type)
+     *
+     * @example
+     * ```ts
+     * await codemods.registerJapaPlugin({
+     *   name: 'expect',
+     *   import: 'import { expect } from "@japa/expect"'
+     * })
+     * ```
      */
     registerJapaPlugin(...params: Parameters<CodeTransformer['addJapaPlugin']>): Promise<void>;
     /**
@@ -143,12 +215,19 @@ export declare class Codemods extends EventEmitter {
         skipReason: string;
     }>;
     /**
-     * Install packages using the correct package manager
-     * You can specify version of each package by setting it in the
-     * name like :
+     * Install packages using the detected or specified package manager.
+     * Automatically detects npm, yarn, or pnpm and installs dependencies accordingly.
+     * You can specify version of each package by setting it in the name like '@adonisjs/lucid@next'.
      *
-     * ```
-     * this.installPackages([{ name: '@adonisjs/lucid@next', isDevDependency: false }])
+     * @param packages - Array of packages with their dependency type
+     * @param packageManager - Optional package manager to use (auto-detected if not provided)
+     *
+     * @example
+     * ```ts
+     * const success = await codemods.installPackages([
+     *   { name: '@adonisjs/lucid', isDevDependency: false },
+     *   { name: '@types/node', isDevDependency: true }
+     * ])
      * ```
      */
     installPackages(packages: {
@@ -156,7 +235,23 @@ export declare class Codemods extends EventEmitter {
         isDevDependency: boolean;
     }[], packageManager?: SupportedPackageManager | 'pnpm@6' | 'deno'): Promise<boolean>;
     /**
-     * List the packages one should install before using the packages
+     * List the packages that should be installed manually.
+     * This method displays installation commands for different package managers
+     * when automatic installation is not available or desired.
+     *
+     * @param packages - Array of packages with their dependency type
+     *
+     * @example
+     * ```ts
+     * await codemods.listPackagesToInstall([
+     *   { name: '@adonisjs/lucid', isDevDependency: false },
+     *   { name: '@types/node', isDevDependency: true }
+     * ])
+     * // Output:
+     * // Please install following packages
+     * // npm i -D @types/node
+     * // npm i @adonisjs/lucid
+     * ```
      */
     listPackagesToInstall(packages: {
         name: string;

package/build/modules/ace/codemods.js

@@ -147,7 +147,19 @@ export class Codemods extends EventEmitter {
         return transformer.project;
     }
     /**
-     * Define validations for the environment variables
+     * Define validations for the environment variables in the start/env.ts file.
+     * This method updates the environment validation schema using the assembler.
+     *
+     * @param validations - Validation schema node for environment variables
+     *
+     * @example
+     * ```ts
+     * await codemods.defineEnvValidations({
+     *   NODE_ENV: 'Env.schema.enum(["development", "production", "test"] as const)',
+     *   PORT: 'Env.schema.number()',
+     *   HOST: 'Env.schema.string({ format: "host" })'
+     * })
+     * ```
      */
     async defineEnvValidations(validations) {
         const transformer = await this.#getCodeTransformer();
@@ -166,7 +178,21 @@ export class Codemods extends EventEmitter {
         }
     }
     /**
-     * Define validations for the environment variables
+     * Register middleware in the start/kernel.ts file.
+     * This method adds middleware to the specified stack (server, router, or named).
+     *
+     * @param stack - The middleware stack to register to ('server' | 'router' | 'named')
+     * @param middleware - Array of middleware nodes to register
+     *
+     * @example
+     * ```ts
+     * await codemods.registerMiddleware('server', [
+     *   {
+     *     name: 'cors',
+     *     path: '@adonisjs/cors/cors_middleware'
+     *   }
+     * ])
+     * ```
      */
     async registerMiddleware(stack, middleware) {
         const transformer = await this.#getCodeTransformer();
@@ -185,9 +211,21 @@ export class Codemods extends EventEmitter {
         }
     }
     /**
-     * Register bouncer policies to the list of policies
-     * collection exported from the "app/policies/main.ts"
-     * file.
+     * Register bouncer policies to the list of policies collection exported from
+     * the "app/policies/main.ts" file. This method adds new policy definitions
+     * to the policies export.
+     *
+     * @param policies - Array of policy nodes to register
+     *
+     * @example
+     * ```ts
+     * await codemods.registerPolicies([
+     *   {
+     *     name: 'UserPolicy',
+     *     path: '#policies/user_policy'
+     *   }
+     * ])
+     * ```
      */
     async registerPolicies(policies) {
         const transformer = await this.#getCodeTransformer();
@@ -206,7 +244,18 @@ export class Codemods extends EventEmitter {
         }
     }
     /**
-     * Update RCFile
+     * Update the adonisrc.ts file with new configuration settings.
+     * This method allows modification of the AdonisJS runtime configuration.
+     *
+     * @param params - Parameters for updating the RC file (varies based on update type)
+     *
+     * @example
+     * ```ts
+     * await codemods.updateRcFile((rcFile) => {
+     *   rcFile.addCommand('make:custom')
+     *   rcFile.addPreloadFile('#app/events/main')
+     * })
+     * ```
      */
     async updateRcFile(...params) {
         const transformer = await this.#getCodeTransformer();
@@ -225,7 +274,19 @@ export class Codemods extends EventEmitter {
         }
     }
     /**
-     * Register a new Vite plugin in the `vite.config.ts` file
+     * Register a new Vite plugin in the vite.config.ts file.
+     * This method adds plugin configuration to the Vite build configuration.
+     *
+     * @param params - Parameters for adding the Vite plugin (varies based on plugin type)
+     *
+     * @example
+     * ```ts
+     * await codemods.registerVitePlugin({
+     *   name: 'vue',
+     *   import: 'import vue from "@vitejs/plugin-vue"',
+     *   options: '()'
+     * })
+     * ```
      */
     async registerVitePlugin(...params) {
         const transformer = await this.#getCodeTransformer();
@@ -244,7 +305,18 @@ export class Codemods extends EventEmitter {
         }
     }
     /**
-     * Register a new Japa plugin in the `tests/bootstrap.ts` file
+     * Register a new Japa plugin in the tests/bootstrap.ts file.
+     * This method adds plugin configuration to the test runner setup.
+     *
+     * @param params - Parameters for adding the Japa plugin (varies based on plugin type)
+     *
+     * @example
+     * ```ts
+     * await codemods.registerJapaPlugin({
+     *   name: 'expect',
+     *   import: 'import { expect } from "@japa/expect"'
+     * })
+     * ```
      */
     async registerJapaPlugin(...params) {
         const transformer = await this.#getCodeTransformer();
@@ -296,12 +368,19 @@ export class Codemods extends EventEmitter {
         return result;
     }
     /**
-     * Install packages using the correct package manager
-     * You can specify version of each package by setting it in the
-     * name like :
+     * Install packages using the detected or specified package manager.
+     * Automatically detects npm, yarn, or pnpm and installs dependencies accordingly.
+     * You can specify version of each package by setting it in the name like '@adonisjs/lucid@next'.
      *
-     * ```
-     * this.installPackages([{ name: '@adonisjs/lucid@next', isDevDependency: false }])
+     * @param packages - Array of packages with their dependency type
+     * @param packageManager - Optional package manager to use (auto-detected if not provided)
+     *
+     * @example
+     * ```ts
+     * const success = await codemods.installPackages([
+     *   { name: '@adonisjs/lucid', isDevDependency: false },
+     *   { name: '@types/node', isDevDependency: true }
+     * ])
      * ```
      */
     async installPackages(packages, packageManager) {
@@ -365,7 +444,23 @@ export class Codemods extends EventEmitter {
         }
     }
     /**
-     * List the packages one should install before using the packages
+     * List the packages that should be installed manually.
+     * This method displays installation commands for different package managers
+     * when automatic installation is not available or desired.
+     *
+     * @param packages - Array of packages with their dependency type
+     *
+     * @example
+     * ```ts
+     * await codemods.listPackagesToInstall([
+     *   { name: '@adonisjs/lucid', isDevDependency: false },
+     *   { name: '@types/node', isDevDependency: true }
+     * ])
+     * // Output:
+     * // Please install following packages
+     * // npm i -D @types/node
+     * // npm i @adonisjs/lucid
+     * ```
      */
     async listPackagesToInstall(packages) {
         const appPath = this.#app.makePath();

package/build/modules/ace/main.d.ts

@@ -1,3 +1,33 @@
+/**
+ * Ace command line interface module for AdonisJS applications.
+ * Provides the kernel, base commands, and utilities for building CLI applications.
+ *
+ * @example
+ * // Create and use the Ace kernel
+ * import { Kernel, BaseCommand } from '@adonisjs/core/ace'
+ *
+ * const kernel = new Kernel(app)
+ * await kernel.handle(['make:controller', 'UserController'])
+ *
+ * @example
+ * // Create a custom command
+ * import { BaseCommand, args, flags } from '@adonisjs/core/ace'
+ *
+ * export default class MakeUser extends BaseCommand {
+ *   static commandName = 'make:user'
+ *   static description = 'Create a new user'
+ *
+ *   @args.string({ description: 'Name of the user' })
+ *   declare name: string
+ *
+ *   @flags.boolean({ description: 'Create admin user' })
+ *   declare admin: boolean
+ *
+ *   async run() {
+ *     this.logger.info(`Creating user: ${this.name}`)
+ *   }
+ * }
+ */
 export { Kernel } from './kernel.ts';
 export { BaseCommand, ListCommand } from './commands.ts';
 export { args, flags, errors, Parser, FsLoader, ListLoader, cliHelpers, HelpCommand, IndexGenerator, tracingChannels, } from '@adonisjs/ace';

package/build/modules/ace/main.js

@@ -6,6 +6,36 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * Ace command line interface module for AdonisJS applications.
+ * Provides the kernel, base commands, and utilities for building CLI applications.
+ *
+ * @example
+ * // Create and use the Ace kernel
+ * import { Kernel, BaseCommand } from '@adonisjs/core/ace'
+ *
+ * const kernel = new Kernel(app)
+ * await kernel.handle(['make:controller', 'UserController'])
+ *
+ * @example
+ * // Create a custom command
+ * import { BaseCommand, args, flags } from '@adonisjs/core/ace'
+ *
+ * export default class MakeUser extends BaseCommand {
+ *   static commandName = 'make:user'
+ *   static description = 'Create a new user'
+ *
+ *   @args.string({ description: 'Name of the user' })
+ *   declare name: string
+ *
+ *   @flags.boolean({ description: 'Create admin user' })
+ *   declare admin: boolean
+ *
+ *   async run() {
+ *     this.logger.info(`Creating user: ${this.name}`)
+ *   }
+ * }
+ */
 export { Kernel } from "./kernel.js";
 export { BaseCommand, ListCommand } from "./commands.js";
 export { args, flags, errors, Parser, FsLoader, ListLoader, cliHelpers, HelpCommand, IndexGenerator, tracingChannels, } from '@adonisjs/ace';

package/build/modules/app.d.ts

@@ -1 +1,18 @@
+/**
+ * Application module re-exports all functionality from @adonisjs/application.
+ * This includes the main Application class and related types for managing
+ * the AdonisJS application lifecycle, container bindings, and service providers.
+ *
+ * @example
+ * // Import the Application class
+ * import { Application } from '@adonisjs/core/app'
+ *
+ * const app = new Application(new URL('../', import.meta.url))
+ * await app.init()
+ * await app.boot()
+ *
+ * @example
+ * // Import application types
+ * import type { ApplicationService, ContainerBindings } from '@adonisjs/core/app'
+ */
 export * from '@adonisjs/application';

package/build/modules/app.js

@@ -6,4 +6,21 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * Application module re-exports all functionality from @adonisjs/application.
+ * This includes the main Application class and related types for managing
+ * the AdonisJS application lifecycle, container bindings, and service providers.
+ *
+ * @example
+ * // Import the Application class
+ * import { Application } from '@adonisjs/core/app'
+ *
+ * const app = new Application(new URL('../', import.meta.url))
+ * await app.init()
+ * await app.boot()
+ *
+ * @example
+ * // Import application types
+ * import type { ApplicationService, ContainerBindings } from '@adonisjs/core/app'
+ */
 export * from '@adonisjs/application';

package/build/modules/config.d.ts

@@ -1 +1,18 @@
+/**
+ * Configuration module re-exports all functionality from @adonisjs/config.
+ * This includes the Config class and related types for managing application
+ * configuration files and environment-specific settings.
+ *
+ * @example
+ * // Import the Config class
+ * import { Config } from '@adonisjs/core/config'
+ *
+ * const config = new Config()
+ * config.set('database.connection', 'mysql')
+ * const dbConnection = config.get('database.connection')
+ *
+ * @example
+ * // Import configuration types
+ * import type { ConfigProvider } from '@adonisjs/core/config'
+ */
 export * from '@adonisjs/config';

package/build/modules/config.js

@@ -6,4 +6,21 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * Configuration module re-exports all functionality from @adonisjs/config.
+ * This includes the Config class and related types for managing application
+ * configuration files and environment-specific settings.
+ *
+ * @example
+ * // Import the Config class
+ * import { Config } from '@adonisjs/core/config'
+ *
+ * const config = new Config()
+ * config.set('database.connection', 'mysql')
+ * const dbConnection = config.get('database.connection')
+ *
+ * @example
+ * // Import configuration types
+ * import type { ConfigProvider } from '@adonisjs/core/config'
+ */
 export * from '@adonisjs/config';

package/build/modules/dumper/dumper.d.ts

@@ -28,6 +28,11 @@ import type { Application } from '../app.ts';
  */
 export declare class Dumper {
     #private;
+    /**
+     * Creates a new Dumper instance
+     *
+     * @param app - The AdonisJS application instance
+     */
     constructor(app: Application<any>);
     /**
      * Configure the HTML formatter output options

package/build/modules/dumper/dumper.js

@@ -89,12 +89,22 @@ export class Dumper {
         atom: 'atom://core/open/file?filename=%f&line=%l',
         vscode: 'vscode://file/%f:%l',
     };
+    /**
+     * Creates a new Dumper instance
+     *
+     * @param app - The AdonisJS application instance
+     */
     constructor(app) {
         this.#app = app;
     }
     /**
      * Returns the link to open the file using dd inside one
-     * of the known code editors
+     * of the known code editors. Constructs a URL that can be used
+     * to open the file at a specific line in supported editors.
+     *
+     * @param source - Optional source file information
+     * @param source.location - The file path to open
+     * @param source.line - The line number to jump to
      */
     #getEditorLink(source) {
         const editorURL = this.#editors[IDE] || IDE;

package/build/modules/dumper/main.d.ts

@@ -1,3 +1,24 @@
+/**
+ * Dumper module provides debugging and inspection utilities for AdonisJS applications.
+ * Includes the Dumper class for formatting output, error classes, and configuration helpers.
+ *
+ * @example
+ * // Use the dumper service
+ * import { Dumper } from '@adonisjs/core/dumper'
+ *
+ * const dumper = new Dumper(app)
+ * const htmlOutput = dumper.dumpToHtml(user, { title: 'User Data' })
+ * const ansiOutput = dumper.dumpToAnsi(user, { title: 'Debug User' })
+ *
+ * @example
+ * // Configure dumper output
+ * import { defineConfig } from '@adonisjs/core/dumper'
+ *
+ * export default defineConfig({
+ *   html: { showHidden: true, depth: 5 },
+ *   console: { collapse: ['Date', 'DateTime'] }
+ * })
+ */
 export * as errors from './errors.ts';
 export { Dumper } from './dumper.ts';
 export { defineConfig } from './define_config.ts';

package/build/modules/dumper/main.js

@@ -6,6 +6,27 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * Dumper module provides debugging and inspection utilities for AdonisJS applications.
+ * Includes the Dumper class for formatting output, error classes, and configuration helpers.
+ *
+ * @example
+ * // Use the dumper service
+ * import { Dumper } from '@adonisjs/core/dumper'
+ *
+ * const dumper = new Dumper(app)
+ * const htmlOutput = dumper.dumpToHtml(user, { title: 'User Data' })
+ * const ansiOutput = dumper.dumpToAnsi(user, { title: 'Debug User' })
+ *
+ * @example
+ * // Configure dumper output
+ * import { defineConfig } from '@adonisjs/core/dumper'
+ *
+ * export default defineConfig({
+ *   html: { showHidden: true, depth: 5 },
+ *   console: { collapse: ['Date', 'DateTime'] }
+ * })
+ */
 export * as errors from "./errors.js";
 export { Dumper } from "./dumper.js";
 export { defineConfig } from "./define_config.js";

package/build/modules/encryption.d.ts

@@ -1 +1,18 @@
+/**
+ * Encryption module re-exports all functionality from @adonisjs/encryption.
+ * This includes the Encryption class and related utilities for encrypting and
+ * decrypting data using various algorithms and key management strategies.
+ *
+ * @example
+ * // Import the Encryption class
+ * import { Encryption } from '@adonisjs/core/encryption'
+ *
+ * const encryption = new Encryption({ secret: 'your-secret-key' })
+ * const encrypted = encryption.encrypt('sensitive data')
+ * const decrypted = encryption.decrypt(encrypted)
+ *
+ * @example
+ * // Import encryption types and utilities
+ * import type { EncryptionConfig, DriverContract } from '@adonisjs/core/encryption'
+ */
 export * from '@adonisjs/encryption';

package/build/modules/encryption.js

@@ -6,4 +6,21 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * Encryption module re-exports all functionality from @adonisjs/encryption.
+ * This includes the Encryption class and related utilities for encrypting and
+ * decrypting data using various algorithms and key management strategies.
+ *
+ * @example
+ * // Import the Encryption class
+ * import { Encryption } from '@adonisjs/core/encryption'
+ *
+ * const encryption = new Encryption({ secret: 'your-secret-key' })
+ * const encrypted = encryption.encrypt('sensitive data')
+ * const decrypted = encryption.decrypt(encrypted)
+ *
+ * @example
+ * // Import encryption types and utilities
+ * import type { EncryptionConfig, DriverContract } from '@adonisjs/core/encryption'
+ */
 export * from '@adonisjs/encryption';

package/build/modules/env/main.d.ts

@@ -1 +1,20 @@
+/**
+ * Environment module re-exports all functionality from @adonisjs/env.
+ * This includes the Env class, validation schemas, and utilities for managing
+ * environment variables with type safety and validation.
+ *
+ * @example
+ * // Import the Env class and validation
+ * import { Env } from '@adonisjs/core/env'
+ *
+ * const env = await Env.create(new URL('../', import.meta.url), {
+ *   NODE_ENV: Env.schema.enum(['development', 'production', 'test'] as const),
+ *   PORT: Env.schema.number(),
+ *   HOST: Env.schema.string({ format: 'host' })
+ * })
+ *
+ * @example
+ * // Import environment types and utilities
+ * import type { EnvParser, EnvEditor } from '@adonisjs/core/env'
+ */
 export * from '@adonisjs/env';

package/build/modules/env/main.js

@@ -6,4 +6,23 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * Environment module re-exports all functionality from @adonisjs/env.
+ * This includes the Env class, validation schemas, and utilities for managing
+ * environment variables with type safety and validation.
+ *
+ * @example
+ * // Import the Env class and validation
+ * import { Env } from '@adonisjs/core/env'
+ *
+ * const env = await Env.create(new URL('../', import.meta.url), {
+ *   NODE_ENV: Env.schema.enum(['development', 'production', 'test'] as const),
+ *   PORT: Env.schema.number(),
+ *   HOST: Env.schema.string({ format: 'host' })
+ * })
+ *
+ * @example
+ * // Import environment types and utilities
+ * import type { EnvParser, EnvEditor } from '@adonisjs/core/env'
+ */
 export * from '@adonisjs/env';

package/build/modules/hash/drivers/bcrypt.d.ts

@@ -1 +1,12 @@
+/**
+ * Bcrypt hash driver re-exports from @adonisjs/hash.
+ * Provides bcrypt password hashing functionality with configurable rounds.
+ *
+ * @example
+ * import { Bcrypt } from '@adonisjs/core/hash/drivers/bcrypt'
+ *
+ * const bcrypt = new Bcrypt({ rounds: 12 })
+ * const hashed = await bcrypt.make('password')
+ * const isValid = await bcrypt.verify(hashed, 'password')
+ */
 export * from '@adonisjs/hash/drivers/bcrypt';

package/build/modules/hash/drivers/bcrypt.js

@@ -6,4 +6,15 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * Bcrypt hash driver re-exports from @adonisjs/hash.
+ * Provides bcrypt password hashing functionality with configurable rounds.
+ *
+ * @example
+ * import { Bcrypt } from '@adonisjs/core/hash/drivers/bcrypt'
+ *
+ * const bcrypt = new Bcrypt({ rounds: 12 })
+ * const hashed = await bcrypt.make('password')
+ * const isValid = await bcrypt.verify(hashed, 'password')
+ */
 export * from '@adonisjs/hash/drivers/bcrypt';

package/build/modules/hash/main.d.ts

@@ -1,2 +1,20 @@
+/**
+ * Hash module provides password hashing functionality with multiple driver support.
+ * Re-exports all functionality from @adonisjs/hash along with configuration utilities.
+ *
+ * @example
+ * // Import the Hash manager and drivers
+ * import { HashManager, Hash } from '@adonisjs/core/hash'
+ *
+ * const manager = new HashManager(config)
+ * const hasher = manager.use('scrypt')
+ * const hashed = await hasher.make('password')
+ * const verified = await hasher.verify(hashed, 'password')
+ *
+ * @example
+ * // Import configuration and driver types
+ * import { defineConfig, drivers } from '@adonisjs/core/hash'
+ * import type { HashConfig, ScryptConfig } from '@adonisjs/core/types/hash'
+ */
 export * from '@adonisjs/hash';
 export { defineConfig, drivers } from './define_config.ts';

package/build/modules/hash/main.js

@@ -6,5 +6,23 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * Hash module provides password hashing functionality with multiple driver support.
+ * Re-exports all functionality from @adonisjs/hash along with configuration utilities.
+ *
+ * @example
+ * // Import the Hash manager and drivers
+ * import { HashManager, Hash } from '@adonisjs/core/hash'
+ *
+ * const manager = new HashManager(config)
+ * const hasher = manager.use('scrypt')
+ * const hashed = await hasher.make('password')
+ * const verified = await hasher.verify(hashed, 'password')
+ *
+ * @example
+ * // Import configuration and driver types
+ * import { defineConfig, drivers } from '@adonisjs/core/hash'
+ * import type { HashConfig, ScryptConfig } from '@adonisjs/core/types/hash'
+ */
 export * from '@adonisjs/hash';
 export { defineConfig, drivers } from "./define_config.js";

package/build/providers/app_provider.js

@@ -270,14 +270,17 @@ export default class AppServiceProvider {
      */
     async generateRoutesTypes(router) {
         try {
-            const types = router.generateTypes(2);
+            const { routes, imports, types } = router.generateTypes(2);
             const outputPath = this.app.generatedServerPath('routes.d.ts');
             await mkdir(dirname(outputPath), { recursive: true });
             await writeFile(outputPath, [
                 `import '@adonisjs/core/types/http'`,
+                ...imports,
+                '',
+                ...types,
                 '',
                 'export type ScannedRoutes = {',
-                types,
+                routes,
                 '}',
                 `declare module '@adonisjs/core/types/http' {`,
                 '  export interface RoutesList extends ScannedRoutes {}',
@@ -344,14 +347,7 @@ export default class AppServiceProvider {
             const router = await this.app.container.make('router');
             if (router.commited) {
                 await this.generateRoutesTypes(router);
-                process.once('message', (message) => {
-                    if (message &&
-                        typeof message === 'object' &&
-                        'purpose' in message &&
-                        message.purpose === 'shareRoutes') {
-                        this.app.notify({ isAdonisJS: true, routes: router.toJSON() });
-                    }
-                });
+                this.app.notify({ isAdonisJS: true, routes: JSON.stringify(router.toJSON()) });
             }
         }
     }

package/build/src/cli_formatters/routes_list.js

@@ -64,7 +64,9 @@ export class RoutesListFormatter {
         this.#router.commit();
     }
     /**
-     * Test if a route clears the applied filters
+     * Test if a route clears the applied filters based on middleware, name, pattern, and handler.
+     *
+     * @param route - The serialized route to test against filters
      */
     #isAllowedByFilters(route) {
         let allowRoute = true;
@@ -124,7 +126,10 @@ export class RoutesListFormatter {
         return false;
     }
     /**
-     * Serializes routes JSON to an object that can be used for pretty printing
+     * Serializes routes JSON to an object that can be used for pretty printing.
+     * Converts RouteJSON into a format suitable for display and filtering.
+     *
+     * @param route - The route JSON object to serialize
      */
     async #serializeRoute(route) {
         let methods = route.methods;
@@ -143,13 +148,17 @@ export class RoutesListFormatter {
         };
     }
     /**
-     * Formats the route method for the ansi list and table
+     * Formats the route method for the ansi list and table with dim styling.
+     *
+     * @param method - The HTTP method to format (GET, POST, etc.)
      */
     #formatRouteMethod(method) {
         return this.#colors.dim(method);
     }
     /**
-     * Formats route pattern for the ansi list and table
+     * Formats route pattern for the ansi list and table with colored parameters and route name.
+     *
+     * @param route - The serialized route containing pattern and name information
      */
     #formatRoutePattern(route) {
         const pattern = this.#router
@@ -170,7 +179,9 @@ export class RoutesListFormatter {
         return `${pattern === '/' ? pattern : `/${pattern}`}${route.name ? ` ${this.#colors.dim(`(${route.name})`)}` : ''} `;
     }
     /**
-     * Formats controller name for the ansi list and table
+     * Formats controller name for the ansi list and table with cyan coloring.
+     *
+     * @param route - The serialized route containing handler information
      */
     #formatControllerName(route) {
         return route.handler.type === 'controller'
@@ -178,7 +189,9 @@ export class RoutesListFormatter {
             : '';
     }
     /**
-     * Formats action name for the ansi list and table
+     * Formats action name for the ansi list and table with cyan coloring and arguments.
+     *
+     * @param route - The serialized route containing handler information
      */
     #formatAction(route) {
         if (route.handler.type === 'controller') {
@@ -191,7 +204,10 @@ export class RoutesListFormatter {
         return functionName;
     }
     /**
-     * Formats route middleware for the ansi list and table
+     * Formats route middleware for the ansi list and table with optional compacting.
+     *
+     * @param route - The serialized route containing middleware information
+     * @param mode - Display mode: 'normal' shows all middleware, 'compact' truncates long lists
      */
     #formatMiddleware(route, mode = 'normal') {
         if (mode === 'compact' && route.middleware.length > 3) {

package/build/src/helpers/http.d.ts

@@ -1 +1,20 @@
+/**
+ * HTTP helper utilities re-exported from @adonisjs/http-server. This module
+ * provides a convenient entry point for accessing all HTTP-related utilities
+ * including route helpers, middleware utilities, and request/response helpers.
+ *
+ * @example
+ * // Import specific HTTP helpers
+ * import { middlewareInfo, routeInfo } from '@adonisjs/core/helpers'
+ *
+ * const middleware = middlewareInfo('cors', CorsMiddleware)
+ * const route = routeInfo('users.show', '/users/:id')
+ *
+ * @example
+ * // Access all HTTP helpers
+ * import * as httpHelpers from '@adonisjs/core/helpers/http'
+ *
+ * // Use any helper from the http-server package
+ * const routeData = httpHelpers.routeInfo('api.posts', '/api/posts')
+ */
 export * from '@adonisjs/http-server/helpers';

package/build/src/helpers/http.js

@@ -6,4 +6,23 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+/**
+ * HTTP helper utilities re-exported from @adonisjs/http-server. This module
+ * provides a convenient entry point for accessing all HTTP-related utilities
+ * including route helpers, middleware utilities, and request/response helpers.
+ *
+ * @example
+ * // Import specific HTTP helpers
+ * import { middlewareInfo, routeInfo } from '@adonisjs/core/helpers'
+ *
+ * const middleware = middlewareInfo('cors', CorsMiddleware)
+ * const route = routeInfo('users.show', '/users/:id')
+ *
+ * @example
+ * // Access all HTTP helpers
+ * import * as httpHelpers from '@adonisjs/core/helpers/http'
+ *
+ * // Use any helper from the http-server package
+ * const routeData = httpHelpers.routeInfo('api.posts', '/api/posts')
+ */
 export * from '@adonisjs/http-server/helpers';

package/build/src/helpers/string.js

@@ -43,9 +43,21 @@ const stringHelpers = {
     prettyHrTime(time, options) {
         return prettyHrTime(time, options);
     },
+    /**
+     * Check if a string is empty or contains only whitespace characters.
+     *
+     * @param value - The string to check for emptiness
+     */
     isEmpty(value) {
         return value.trim().length === 0;
     },
+    /**
+     * Escape HTML entities to prevent XSS attacks and display HTML safely.
+     *
+     * @param value - The string containing HTML to escape
+     * @param options - Optional configuration for escaping behavior
+     * @param options.encodeSymbols - Whether to also encode Unicode symbols as HTML entities
+     */
     escapeHTML(value, options) {
         value = he.escape(value);
         if (options && options.encodeSymbols) {
@@ -53,6 +65,12 @@ const stringHelpers = {
         }
         return value;
     },
+    /**
+     * Encode Unicode symbols and special characters as HTML entities.
+     *
+     * @param value - The string containing symbols to encode
+     * @param options - Encoding options from the 'he' library
+     */
     encodeSymbols(value, options) {
         return he.encode(value, options);
     },

package/build/src/ignitor/http.js

@@ -32,7 +32,9 @@ export class HttpServerProcess {
         this.#ignitor = ignitor;
     }
     /**
-     * Calling this method closes the underlying HTTP server
+     * Calling this method closes the underlying HTTP server gracefully.
+     *
+     * @param nodeHttpServer - The Node.js HTTP or HTTPS server instance to close
      */
     #close(nodeHttpServer) {
         return new Promise((resolve) => {
@@ -42,7 +44,11 @@ export class HttpServerProcess {
     }
     /**
      * Monitors the app and the server to close the HTTP server when
-     * either one of them goes down
+     * either one of them goes down. Sets up event listeners for graceful shutdown.
+     *
+     * @param nodeHttpServer - The Node.js HTTP or HTTPS server instance to monitor
+     * @param app - The application service instance
+     * @param logger - The logger service for error reporting
      */
     #monitorAppAndServer(nodeHttpServer, app, logger) {
         /**
@@ -64,7 +70,9 @@ export class HttpServerProcess {
         });
     }
     /**
-     * Starts the http server a given host and port
+     * Starts the HTTP server on a given host and port using environment variables.
+     *
+     * @param nodeHttpServer - The Node.js HTTP or HTTPS server instance to start listening
      */
     #listen(nodeHttpServer) {
         return new Promise((resolve, reject) => {
@@ -81,8 +89,13 @@ export class HttpServerProcess {
         });
     }
     /**
-     * Notifies the app and the parent process that the
-     * HTTP server is ready
+     * Notifies the app and the parent process that the HTTP server is ready.
+     * Sends notifications through multiple channels: parent process, logger, and event emitter.
+     *
+     * @param app - The application service instance for parent process notification
+     * @param logger - The logger service for console output
+     * @param emitter - The event emitter for app-level notifications
+     * @param payload - Server startup information including host, port, and duration
      */
     #notifyServerHasStarted(app, logger, emitter, payload) {
         /**

package/build/src/vine.js

@@ -9,15 +9,21 @@
 import vine, { symbols, BaseLiteralType } from '@vinejs/vine';
 const MULTIPART_FILE = symbols.SUBTYPE ?? Symbol.for('subtype');
 /**
- * Checks if the value is an instance of multipart file
- * from bodyparser.
+ * Checks if the value is an instance of multipart file from bodyparser.
+ * Used internally for type guarding in file validation.
+ *
+ * @param file - The value to check for MultipartFile instance
  */
 function isBodyParserFile(file) {
     return !!(file && typeof file === 'object' && 'isMultipartFile' in file);
 }
 /**
- * VineJS validation rule that validates the file to be an
- * instance of BodyParser MultipartFile class.
+ * VineJS validation rule that validates the file to be an instance of BodyParser
+ * MultipartFile class and applies size/extension validation if configured.
+ *
+ * @param file - The file value to validate
+ * @param options - Validation options for file size and extensions
+ * @param field - The field context from VineJS validation
  */
 const isMultipartFile = vine.createRule((file, options, field) => {
     /**
@@ -26,7 +32,7 @@ const isMultipartFile = vine.createRule((file, options, field) => {
      */
     if (!isBodyParserFile(file)) {
         field.report('The {{ field }} must be a file', 'file', field);
-        return;
+        return false;
     }
     const validationOptions = typeof options === 'function' ? options(field) : options;
     /**
@@ -53,6 +59,7 @@ const isMultipartFile = vine.createRule((file, options, field) => {
     file.errors.forEach((error) => {
         field.report(error.message, `file.${error.type}`, field, validationOptions);
     });
+    return file.isValid;
 });
 /**
  * Represents a multipart file uploaded via multipart/form-data HTTP
@@ -84,8 +91,9 @@ export class VineMultipartFile extends BaseLiteralType {
      * @param validations - Array of validation functions to apply
      */
     constructor(validationOptions, options, validations) {
-        super(options, validations || [isMultipartFile(validationOptions || {})]);
+        super(options, validations || []);
         this.#validationOptions = validationOptions;
+        this.dataTypeValidator = isMultipartFile(validationOptions || {});
     }
     /**
      * Creates a clone of the current VineMultipartFile instance

package/build/types/helpers.d.ts

@@ -1,2 +1,22 @@
+/**
+ * Helper types and utilities for AdonisJS applications.
+ * Re-exports commonly used type utilities and file system operation types.
+ *
+ * @example
+ * // Use Opaque type for branded primitives
+ * import type { Opaque } from '@adonisjs/core/types/helpers'
+ *
+ * type UserId = Opaque<'UserId', number>
+ * const userId: UserId = 123 as UserId
+ *
+ * @example
+ * // Use file system option types
+ * import type { ImportAllFilesOptions } from '@adonisjs/core/types/helpers'
+ *
+ * const options: ImportAllFilesOptions = {
+ *   ignoreMissingExports: true,
+ *   transformKeys: (key) => key.toLowerCase()
+ * }
+ */
 export type { Opaque, NormalizeConstructor } from '@poppinss/utils/types';
 export type { ImportAllFilesOptions, ReadAllFilesOptions } from '@poppinss/utils/fs';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/core",
   "description": "Core of AdonisJS",
-  "version": "7.0.0-next.5",
+  "version": "7.0.0-next.7",
   "engines": {
     "node": ">=24.0.0"
   },
@@ -84,10 +84,10 @@
     "index:commands": "node --import=@poppinss/ts-exec toolkit/main.js index build/commands"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^8.0.0-next.12",
-    "@adonisjs/eslint-config": "^3.0.0-next.1",
+    "@adonisjs/assembler": "^8.0.0-next.14",
+    "@adonisjs/eslint-config": "^3.0.0-next.4",
     "@adonisjs/prettier-config": "^1.4.5",
-    "@adonisjs/tsconfig": "^2.0.0-next.0",
+    "@adonisjs/tsconfig": "^2.0.0-next.2",
     "@japa/assert": "^4.1.1",
     "@japa/expect-type": "^2.0.3",
     "@japa/file-system": "^2.3.2",
@@ -95,12 +95,12 @@
     "@japa/snapshot": "^2.0.9",
     "@poppinss/ts-exec": "^1.4.1",
     "@release-it/conventional-changelog": "^10.0.1",
-    "@types/node": "^24.7.0",
+    "@types/node": "^24.7.2",
     "@types/pretty-hrtime": "^1.0.3",
     "@types/sinon": "^17.0.4",
     "@types/supertest": "^6.0.3",
     "@types/test-console": "^2.0.3",
-    "@vinejs/vine": "^3.0.1",
+    "@vinejs/vine": "^4.0.0-next.1",
     "argon2": "^0.44.0",
     "bcrypt": "^6.0.0",
     "c8": "^10.1.3",
@@ -117,12 +117,12 @@
     "supertest": "^7.1.4",
     "test-console": "^2.0.0",
     "timekeeper": "^2.3.1",
-    "typedoc": "^0.28.13",
+    "typedoc": "^0.28.14",
     "typescript": "^5.9.3",
     "youch": "^4.1.0-beta.11"
   },
   "dependencies": {
-    "@adonisjs/ace": "^14.0.1-next.1",
+    "@adonisjs/ace": "^14.0.1-next.2",
     "@adonisjs/application": "^9.0.0-next.9",
     "@adonisjs/bodyparser": "^11.0.0-next.1",
     "@adonisjs/config": "^6.0.0-next.1",
@@ -132,7 +132,7 @@
     "@adonisjs/fold": "^11.0.0-next.2",
     "@adonisjs/hash": "^10.0.0-next.1",
     "@adonisjs/health": "^3.0.0-next.0",
-    "@adonisjs/http-server": "^8.0.0-next.10",
+    "@adonisjs/http-server": "^8.0.0-next.12",
     "@adonisjs/http-transformers": "^1.5.0",
     "@adonisjs/logger": "^7.1.0-next.0",
     "@adonisjs/repl": "^5.0.0-next.0",
@@ -149,7 +149,7 @@
   },
   "peerDependencies": {
     "@adonisjs/assembler": "^8.0.0-next.10",
-    "@vinejs/vine": "^3.0.0",
+    "@vinejs/vine": "^4.0.0-next.0",
     "argon2": "^0.43.0",
     "bcrypt": "^6.0.0",
     "edge.js": "^6.2.0",