@adonisjs/core 6.19.0 → 7.0.0-next.0

package/build/providers/edge_provider.js

@@ -7,20 +7,49 @@
  * file that was distributed with this source code.
  */
 import edge from 'edge.js';
-import { pluginEdgeDumper } from '../modules/dumper/plugins/edge.js';
-import { BriskRoute, HttpContext } from '../modules/http/main.js';
+import { pluginEdgeDumper } from "../modules/dumper/plugins/edge.js";
+import { BriskRoute, HttpContext } from "../modules/http/main.js";
 /**
  * The Edge service provider configures Edge to work within
  * an AdonisJS application environment
+ *
+ * This provider integrates EdgeJS template engine with AdonisJS by:
+ * - Mounting the views directory
+ * - Configuring template caching for production
+ * - Adding global helpers for route generation
+ * - Creating isolated renderer instances for HTTP contexts
+ * - Adding render macro to BriskRoute for template rendering
+ *
+ * @example
+ * const provider = new EdgeServiceProvider(app)
+ * await provider.boot()
  */
 export default class EdgeServiceProvider {
     app;
+    /**
+     * Edge service provider constructor
+     *
+     * Sets the usingEdgeJS flag to true to indicate EdgeJS is being used.
+     *
+     * @param app - The application service instance
+     */
     constructor(app) {
         this.app = app;
         this.app.usingEdgeJS = true;
     }
     /**
      * Bridge AdonisJS and Edge
+     *
+     * Configures EdgeJS integration by:
+     * - Setting up template mounting and caching
+     * - Defining global helpers (route, signedRoute, app, config)
+     * - Adding view getter to HttpContext for isolated rendering
+     * - Adding render macro to BriskRoute
+     * - Registering dumper plugin
+     *
+     * @example
+     * await provider.boot()
+     * // Now edge templates can use {{ route('home') }} helper
      */
     async boot() {
         const app = this.app;

package/build/providers/hash_provider.d.ts

@@ -1,21 +1,58 @@
-import type { ApplicationService } from '../src/types.js';
+import type { ApplicationService } from '../src/types.ts';
 /**
  * Registers the passwords hasher with the container
+ *
+ * This provider sets up password hashing functionality by:
+ * - Registering the HashManager with configuration from config/hash.ts
+ * - Providing a Hash class that uses the default hasher
+ * - Supporting multiple hashing drivers (bcrypt, argon2, etc.)
+ *
+ * @example
+ * const provider = new HashServiceProvider(app)
+ * provider.register()
+ * const hash = await app.container.make('hash')
  */
 export default class HashServiceProvider {
     protected app: ApplicationService;
+    /**
+     * Hash service provider constructor
+     *
+     * @param app - The application service instance
+     */
     constructor(app: ApplicationService);
     /**
      * Registering the hash class to resolve an instance with the
      * default hasher.
+     *
+     * Creates a singleton binding for the Hash class that resolves
+     * the default hasher from the hash manager.
+     *
+     * @example
+     * const hash = await container.make(Hash)
+     * const hashed = await hash.make('password')
      */
     protected registerHash(): void;
     /**
      * Registers the hash manager with the container
+     *
+     * Creates a singleton binding for 'hash' that instantiates
+     * the HashManager with configuration from config/hash.ts file.
+     * Throws an error if the configuration is invalid.
+     *
+     * @example
+     * const hashManager = await container.make('hash')
+     * const bcryptHasher = hashManager.use('bcrypt')
      */
     protected registerHashManager(): void;
     /**
      * Registers bindings
+     *
+     * Called during the application bootstrap phase to register
+     * the hash manager and hash class with the IoC container.
+     *
+     * @example
+     * const provider = new HashServiceProvider(app)
+     * provider.register() // Registers hash services
      */
     register(): void;
 }

package/build/providers/hash_provider.js

@@ -6,20 +6,42 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { RuntimeException } from '@poppinss/utils';
-import { Hash } from '../modules/hash/main.js';
-import { configProvider } from '../src/config_provider.js';
+import { RuntimeException } from '@poppinss/utils/exception';
+import { Hash } from "../modules/hash/main.js";
+import { configProvider } from "../src/config_provider.js";
 /**
  * Registers the passwords hasher with the container
+ *
+ * This provider sets up password hashing functionality by:
+ * - Registering the HashManager with configuration from config/hash.ts
+ * - Providing a Hash class that uses the default hasher
+ * - Supporting multiple hashing drivers (bcrypt, argon2, etc.)
+ *
+ * @example
+ * const provider = new HashServiceProvider(app)
+ * provider.register()
+ * const hash = await app.container.make('hash')
  */
 export default class HashServiceProvider {
     app;
+    /**
+     * Hash service provider constructor
+     *
+     * @param app - The application service instance
+     */
     constructor(app) {
         this.app = app;
     }
     /**
      * Registering the hash class to resolve an instance with the
      * default hasher.
+     *
+     * Creates a singleton binding for the Hash class that resolves
+     * the default hasher from the hash manager.
+     *
+     * @example
+     * const hash = await container.make(Hash)
+     * const hashed = await hash.make('password')
      */
     registerHash() {
         this.app.container.singleton(Hash, async (resolver) => {
@@ -29,6 +51,14 @@ export default class HashServiceProvider {
     }
     /**
      * Registers the hash manager with the container
+     *
+     * Creates a singleton binding for 'hash' that instantiates
+     * the HashManager with configuration from config/hash.ts file.
+     * Throws an error if the configuration is invalid.
+     *
+     * @example
+     * const hashManager = await container.make('hash')
+     * const bcryptHasher = hashManager.use('bcrypt')
      */
     registerHashManager() {
         this.app.container.singleton('hash', async () => {
@@ -46,6 +76,13 @@ export default class HashServiceProvider {
     }
     /**
      * Registers bindings
+     *
+     * Called during the application bootstrap phase to register
+     * the hash manager and hash class with the IoC container.
+     *
+     * @example
+     * const provider = new HashServiceProvider(app)
+     * provider.register() // Registers hash services
      */
     register() {
         this.registerHashManager();

package/build/providers/repl_provider.d.ts

@@ -1,13 +1,52 @@
-import type { ApplicationService } from '../src/types.js';
+import type { ApplicationService } from '../src/types.ts';
+/**
+ * REPL Service Provider configures the interactive Node.js REPL
+ * for AdonisJS applications
+ *
+ * This provider sets up:
+ * - REPL instance with history file support
+ * - Helper methods for importing modules and making container bindings
+ * - Quick access methods for loading common services (app, router, etc.)
+ * - Utility methods for development and debugging
+ *
+ * @example
+ * const provider = new ReplServiceProvider(app)
+ * provider.register()
+ * await provider.boot()
+ */
 export default class ReplServiceProvider {
     protected app: ApplicationService;
+    /**
+     * REPL service provider constructor
+     *
+     * @param app - The application service instance
+     */
     constructor(app: ApplicationService);
     /**
      * Registers the REPL binding
+     *
+     * Creates a singleton binding for the REPL with history file
+     * support in the user's home directory.
+     *
+     * @example
+     * const provider = new ReplServiceProvider(app)
+     * provider.register()
+     * const repl = await app.container.make('repl')
      */
     register(): void;
     /**
      * Registering REPL bindings during provider boot
+     *
+     * Adds helper methods to the REPL instance including:
+     * - importDefault: Import default export from modules
+     * - importAll: Import all files from a directory
+     * - make: Create instances using container.make
+     * - load* methods: Quick access to common services
+     * - loadHelpers: Load utility helper functions
+     *
+     * @example
+     * await provider.boot()
+     * // REPL now has helper methods available
      */
     boot(): Promise<void>;
 }

package/build/providers/repl_provider.js

@@ -8,23 +8,62 @@
  */
 import { join } from 'node:path';
 import { homedir } from 'node:os';
-import { fsImportAll } from '@poppinss/utils';
-import { Repl } from '../modules/repl.js';
+import { fsImportAll } from '@poppinss/utils/fs';
+import { Repl } from "../modules/repl.js";
 /**
  * Resolves a container binding and sets it on the REPL
  * context
+ *
+ * This helper function makes a service from the container and
+ * adds it to the REPL context with a notification message.
+ *
+ * @param app - The application service instance
+ * @param repl - The REPL instance to add the binding to
+ * @param binding - The container binding key to resolve
+ *
+ * @example
+ * await resolveBindingForRepl(app, repl, 'router')
+ * // Now 'router' variable is available in REPL
  */
 async function resolveBindingForRepl(app, repl, binding) {
     repl.server.context[binding] = await app.container.make(binding);
     repl.notify(`Loaded "${binding}" service. You can access it using the "${repl.colors.underline(binding)}" variable`);
 }
+/**
+ * REPL Service Provider configures the interactive Node.js REPL
+ * for AdonisJS applications
+ *
+ * This provider sets up:
+ * - REPL instance with history file support
+ * - Helper methods for importing modules and making container bindings
+ * - Quick access methods for loading common services (app, router, etc.)
+ * - Utility methods for development and debugging
+ *
+ * @example
+ * const provider = new ReplServiceProvider(app)
+ * provider.register()
+ * await provider.boot()
+ */
 export default class ReplServiceProvider {
     app;
+    /**
+     * REPL service provider constructor
+     *
+     * @param app - The application service instance
+     */
     constructor(app) {
         this.app = app;
     }
     /**
      * Registers the REPL binding
+     *
+     * Creates a singleton binding for the REPL with history file
+     * support in the user's home directory.
+     *
+     * @example
+     * const provider = new ReplServiceProvider(app)
+     * provider.register()
+     * const repl = await app.container.make('repl')
      */
     register() {
         this.app.container.singleton(Repl, async () => {
@@ -36,6 +75,17 @@ export default class ReplServiceProvider {
     }
     /**
      * Registering REPL bindings during provider boot
+     *
+     * Adds helper methods to the REPL instance including:
+     * - importDefault: Import default export from modules
+     * - importAll: Import all files from a directory
+     * - make: Create instances using container.make
+     * - load* methods: Quick access to common services
+     * - loadHelpers: Load utility helper functions
+     *
+     * @example
+     * await provider.boot()
+     * // REPL now has helper methods available
      */
     async boot() {
         this.app.container.resolving('repl', (repl) => {

package/build/providers/vinejs_provider.d.ts

@@ -1,6 +1,6 @@
-import type { ApplicationService } from '../src/types.js';
-import { RequestValidator } from '../modules/http/main.js';
-import { FileRuleValidationOptions, VineMultipartFile } from '../src/vine.js';
+import type { ApplicationService } from '../src/types.ts';
+import { RequestValidator } from '../modules/http/main.ts';
+import { type FileRuleValidationOptions, VineMultipartFile } from '../src/vine.ts';
 /**
  * Extend VineJS
  */
@@ -17,11 +17,38 @@ declare module '@adonisjs/core/http' {
     }
 }
 /**
- * The Edge service provider configures Edge to work within
- * an AdonisJS application environment
+ * The VineJS service provider integrates VineJS validation
+ * library with AdonisJS application environment
+ *
+ * This provider sets up:
+ * - File validation rule for multipart file uploads
+ * - Request validation macro for easy validation in HTTP contexts
+ * - Extension of VineJS with AdonisJS-specific validation features
+ *
+ * @example
+ * const provider = new VineJSServiceProvider(app)
+ * provider.boot()
+ * // Now Request has validateUsing method
  */
 export default class VineJSServiceProvider {
     protected app: ApplicationService;
+    /**
+     * VineJS service provider constructor
+     *
+     * Sets the usingVineJS flag to true to indicate VineJS is being used.
+     *
+     * @param app - The application service instance
+     */
     constructor(app: ApplicationService);
+    /**
+     * Boot the VineJS service provider
+     *
+     * Extends VineJS with file validation macro and adds validateUsing
+     * method to the Request class for easy validation in HTTP contexts.
+     *
+     * @example
+     * provider.boot()
+     * // Now vine.file() and request.validateUsing() are available
+     */
     boot(): void;
 }

package/build/providers/vinejs_provider.js

@@ -7,18 +7,45 @@
  * file that was distributed with this source code.
  */
 import { Vine } from '@vinejs/vine';
-import { Request, RequestValidator } from '../modules/http/main.js';
-import { VineMultipartFile } from '../src/vine.js';
+import { Request, RequestValidator } from "../modules/http/main.js";
+import { VineMultipartFile } from "../src/vine.js";
 /**
- * The Edge service provider configures Edge to work within
- * an AdonisJS application environment
+ * The VineJS service provider integrates VineJS validation
+ * library with AdonisJS application environment
+ *
+ * This provider sets up:
+ * - File validation rule for multipart file uploads
+ * - Request validation macro for easy validation in HTTP contexts
+ * - Extension of VineJS with AdonisJS-specific validation features
+ *
+ * @example
+ * const provider = new VineJSServiceProvider(app)
+ * provider.boot()
+ * // Now Request has validateUsing method
  */
 export default class VineJSServiceProvider {
     app;
+    /**
+     * VineJS service provider constructor
+     *
+     * Sets the usingVineJS flag to true to indicate VineJS is being used.
+     *
+     * @param app - The application service instance
+     */
     constructor(app) {
         this.app = app;
         this.app.usingVineJS = true;
     }
+    /**
+     * Boot the VineJS service provider
+     *
+     * Extends VineJS with file validation macro and adds validateUsing
+     * method to the Request class for easy validation in HTTP contexts.
+     *
+     * @example
+     * provider.boot()
+     * // Now vine.file() and request.validateUsing() are available
+     */
     boot() {
         const experimentalFlags = this.app.experimentalFlags;
         /**

package/build/services/ace.d.ts

@@ -1,3 +1,3 @@
-import type { Kernel } from '../modules/ace/main.js';
+import type { Kernel } from '../modules/ace/main.ts';
 declare let ace: Kernel;
 export { ace as default };

package/build/services/ace.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let ace;
 /**
  * Returns a singleton instance of the ace kernel

package/build/services/app.d.ts

@@ -1,4 +1,4 @@
-import type { ApplicationService } from '../src/types.js';
+import type { ApplicationService } from '../src/types.ts';
 declare let app: ApplicationService;
 /**
  * Set the application instance the app service should

package/build/services/config.d.ts

@@ -1,3 +1,3 @@
-import type { ApplicationService } from '../src/types.js';
+import type { ApplicationService } from '../src/types.ts';
 declare let config: ApplicationService['config'];
 export { config as default };

package/build/services/config.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let config;
 /**
  * The config service uses the config instance from the app service

package/build/services/dumper.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let dumper;
 /**
  * dumper service is an instance of the "Dumper" class stored inside

package/build/services/emitter.d.ts

@@ -1,3 +1,3 @@
-import type { EmitterService } from '../src/types.js';
+import type { EmitterService } from '../src/types.ts';
 declare let emitter: EmitterService;
 export { emitter as default };

package/build/services/emitter.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let emitter;
 /**
  * Returns a singleton instance of the emitter class

package/build/services/encryption.d.ts

@@ -1,3 +1,3 @@
-import type { EncryptionService } from '../src/types.js';
+import type { EncryptionService } from '../src/types.ts';
 declare let encryption: EncryptionService;
 export { encryption as default };

package/build/services/encryption.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let encryption;
 /**
  * Returns a singleton instance of the encryption class

package/build/services/hash.d.ts

@@ -1,3 +1,3 @@
-import type { HashService } from '../src/types.js';
+import type { HashService } from '../src/types.ts';
 declare let hash: HashService;
 export { hash as default };

package/build/services/hash.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let hash;
 /**
  * Returns a singleton instance of the Hash manager from the

package/build/services/logger.d.ts

@@ -1,3 +1,3 @@
-import type { LoggerService } from '../src/types.js';
+import type { LoggerService } from '../src/types.ts';
 declare let logger: LoggerService;
 export { logger as default };

package/build/services/logger.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let logger;
 /**
  * Returns a singleton instance of the logger class

package/build/services/repl.d.ts

@@ -1,3 +1,3 @@
-import type { Repl } from '../modules/repl.js';
+import type { Repl } from '../modules/repl.ts';
 declare let repl: Repl;
 export { repl as default };

package/build/services/repl.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let repl;
 /**
  * Returns a singleton instance of the Repl class from

package/build/services/router.d.ts

@@ -1,3 +1,3 @@
-import type { HttpRouterService } from '../src/types.js';
+import type { HttpRouterService } from '../src/types.ts';
 declare let router: HttpRouterService;
 export { router as default };

package/build/services/router.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let router;
 /**
  * Returns a singleton instance of the router class from

package/build/services/server.d.ts

@@ -1,3 +1,3 @@
-import type { HttpServerService } from '../src/types.js';
+import type { HttpServerService } from '../src/types.ts';
 declare let server: HttpServerService;
 export { server as default };

package/build/services/server.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let server;
 /**
  * Returns a singleton instance of the HTTP server

package/build/services/test_utils.d.ts

@@ -1,3 +1,3 @@
-import type { TestUtils } from '../src/test_utils/main.js';
+import type { TestUtils } from '../src/test_utils/main.ts';
 declare let testUtils: TestUtils;
 export { testUtils as default };

package/build/services/test_utils.js

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import app from './app.js';
+import app from "./app.js";
 let testUtils;
 /**
  * Returns a singleton instance of the TestUtils class

package/build/services/url_builder.d.ts

@@ -0,0 +1,4 @@
+import type { SignedUrlBuilderService, UrlBuilderService } from '../src/types.ts';
+declare let urlFor: UrlBuilderService;
+declare let signedUrlFor: SignedUrlBuilderService;
+export { urlFor, signedUrlFor };

package/build/services/url_builder.js

@@ -0,0 +1,21 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import app from "./app.js";
+let urlFor;
+let signedUrlFor;
+/**
+ * Returns a singleton instance of the router class from
+ * the container
+ */
+await app.booted(async () => {
+    const router = await app.container.make('router');
+    urlFor = router.urlBuilder.urlFor;
+    signedUrlFor = router.urlBuilder.signedUrlFor;
+});
+export { urlFor, signedUrlFor };