@adonisjs/core 7.0.0-next.4 → 7.0.0-next.6

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';