@adonisjs/core 6.1.5-1 → 6.1.5-10

package/build/modules/hash/main.js

@@ -1,2 +1,11 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/hash';
 export { defineConfig } from './define_config.js';
+export { default as driversList } from './drivers_collection.js';

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

@@ -0,0 +1,2 @@
+export * from '@adonisjs/http-server';
+export { RequestValidator } from './request_validator.js';

package/build/modules/http/main.js

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export * from '@adonisjs/http-server';
+export { RequestValidator } from './request_validator.js';

package/build/modules/http/request_validator.d.ts

@@ -0,0 +1,44 @@
+import { type VineValidator } from '@vinejs/vine';
+import type { Infer, SchemaTypes, ValidationOptions, ErrorReporterContract, MessagesProviderContact } from '@vinejs/vine/types';
+import { type HttpContext } from '@adonisjs/http-server';
+/**
+ * Request validation options with custom data as well
+ */
+type RequestValidationOptions<MetaData extends undefined | Record<string, any>> = ValidationOptions<MetaData> & {
+    data?: any;
+};
+/**
+ * Request validator is used validate HTTP request data using
+ * VineJS validators. You may validate the request body,
+ * files, cookies, and headers.
+ */
+export declare class RequestValidator {
+    #private;
+    constructor(ctx: HttpContext);
+    /**
+     * The error reporter method returns the error reporter
+     * to use for reporting errors.
+     *
+     * You can use this function to pick a different error reporter
+     * for each HTTP request
+     */
+    static errorReporter?: (_: HttpContext) => ErrorReporterContract;
+    /**
+     * The messages provider method returns the messages provider to use
+     * finding custom error messages
+     *
+     * You can use this function to pick a different messages provider for
+     * each HTTP request
+     */
+    static messagesProvider?: (_: HttpContext) => MessagesProviderContact;
+    /**
+     * The validate method can be used to validate the request
+     * data for the current request using VineJS validators
+     */
+    validateUsing<Schema extends SchemaTypes, MetaData extends undefined | Record<string, any>>(validator: VineValidator<Schema, MetaData>, ...[options]: [undefined] extends MetaData ? [options?: RequestValidationOptions<MetaData> | undefined] : [options: RequestValidationOptions<MetaData>]): Promise<Infer<Schema>>;
+}
+declare module '@adonisjs/http-server' {
+    interface Request extends RequestValidator {
+    }
+}
+export {};

package/build/modules/http/request_validator.js

@@ -0,0 +1,74 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Request } from '@adonisjs/http-server';
+/**
+ * Request validator is used validate HTTP request data using
+ * VineJS validators. You may validate the request body,
+ * files, cookies, and headers.
+ */
+export class RequestValidator {
+    #ctx;
+    constructor(ctx) {
+        this.#ctx = ctx;
+    }
+    /**
+     * The error reporter method returns the error reporter
+     * to use for reporting errors.
+     *
+     * You can use this function to pick a different error reporter
+     * for each HTTP request
+     */
+    static errorReporter;
+    /**
+     * The messages provider method returns the messages provider to use
+     * finding custom error messages
+     *
+     * You can use this function to pick a different messages provider for
+     * each HTTP request
+     */
+    static messagesProvider;
+    /**
+     * The validate method can be used to validate the request
+     * data for the current request using VineJS validators
+     */
+    validateUsing(validator, ...[options]) {
+        const validatorOptions = options || {};
+        /**
+         * Assign request specific error reporter
+         */
+        if (RequestValidator.errorReporter) {
+            const errorReporter = RequestValidator.errorReporter(this.#ctx);
+            validatorOptions.errorReporter = () => errorReporter;
+        }
+        /**
+         * Assign request specific messages provider
+         */
+        if (RequestValidator.messagesProvider) {
+            validatorOptions.messagesProvider = RequestValidator.messagesProvider(this.#ctx);
+        }
+        /**
+         * Data to validate
+         */
+        const data = validatorOptions.data || {
+            ...this.#ctx.request.all(),
+            ...this.#ctx.request.allFiles(),
+            params: this.#ctx.request.params(),
+            headers: this.#ctx.request.headers(),
+            cookies: this.#ctx.request.cookiesList(),
+        };
+        return validator.validate(data, validatorOptions);
+    }
+}
+/**
+ * The validate method can be used to validate the request
+ * data for the current request using VineJS validators
+ */
+Request.macro('validateUsing', function (...args) {
+    return new RequestValidator(this.ctx).validateUsing(...args);
+});

package/build/modules/logger.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/logger';

package/build/modules/repl.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/repl';

package/build/modules/repl.js

@@ -0,0 +1,9 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export * from '@adonisjs/repl';

package/build/providers/app_provider.d.ts

@@ -1,16 +1,45 @@
 import type { ApplicationService } from '../src/types.js';
+/**
+ * The Application Service provider registers all the baseline
+ * features required to run the framework.
+ */
 export default class AppServiceProvider {
     protected app: ApplicationService;
     constructor(app: ApplicationService);
+    /**
+     * Registers test utils with the container
+     */
     protected registerTestUtils(): void;
+    /**
+     * Registers ace with the container
+     */
     protected registerAce(): void;
+    /**
+     * Registers the application to the container
+     */
     protected registerApp(): void;
+    /**
+     * Registers the logger class to resolve the default logger
+     */
     protected registerLogger(): void;
+    /**
+     * Registers the logger manager to the container
+     */
     protected registerLoggerManager(): void;
+    /**
+     * Registers the config to the container
+     */
     protected registerConfig(): void;
+    /**
+     * Registers emitter service to the container
+     */
     protected registerEmitter(): void;
+    /**
+     * Register the encryption service to the container
+     */
     protected registerEncryption(): void;
-    protected configureValidator(): Promise<void>;
+    /**
+     * Registers bindings
+     */
     register(): void;
-    boot(): Promise<void>;
 }

package/build/providers/app_provider.js

@@ -1,52 +1,85 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Config } from '../modules/config.js';
-import { Emitter } from '../modules/events.js';
-import { validator } from '../legacy/validator.js';
+import { Logger } from '../modules/logger.js';
 import { Encryption } from '../modules/encryption.js';
-import { Logger, LoggerManager } from '../modules/logger.js';
+/**
+ * The Application Service provider registers all the baseline
+ * features required to run the framework.
+ */
 export default class AppServiceProvider {
     app;
     constructor(app) {
         this.app = app;
     }
+    /**
+     * Registers test utils with the container
+     */
     registerTestUtils() {
         this.app.container.singleton('testUtils', async () => {
             const { TestUtils } = await import('../src/test_utils/main.js');
             return new TestUtils(this.app);
         });
     }
+    /**
+     * Registers ace with the container
+     */
     registerAce() {
         this.app.container.singleton('ace', async () => {
             const { createAceKernel } = await import('../modules/ace/create_kernel.js');
             return createAceKernel(this.app);
         });
     }
+    /**
+     * Registers the application to the container
+     */
     registerApp() {
         this.app.container.singleton('app', () => this.app);
     }
+    /**
+     * Registers the logger class to resolve the default logger
+     */
     registerLogger() {
         this.app.container.singleton(Logger, async (resolver) => {
             const loggerManager = await resolver.make('logger');
             return loggerManager.use();
         });
     }
+    /**
+     * Registers the logger manager to the container
+     */
     registerLoggerManager() {
-        const LoggerServiceManager = LoggerManager;
-        this.app.container.singleton(LoggerServiceManager, () => {
+        this.app.container.singleton('logger', async () => {
+            const { LoggerManager } = await import('../modules/logger.js');
             const config = this.app.config.get('logger');
             return new LoggerManager(config);
         });
-        this.app.container.alias('logger', LoggerServiceManager);
     }
+    /**
+     * Registers the config to the container
+     */
     registerConfig() {
         this.app.container.singleton(Config, () => this.app.config);
         this.app.container.alias('config', Config);
     }
+    /**
+     * Registers emitter service to the container
+     */
     registerEmitter() {
-        this.app.container.singleton(Emitter, () => {
+        this.app.container.singleton('emitter', async () => {
+            const { Emitter } = await import('../modules/events.js');
             return new Emitter(this.app);
         });
-        this.app.container.alias('emitter', Emitter);
     }
+    /**
+     * Register the encryption service to the container
+     */
     registerEncryption() {
         this.app.container.singleton(Encryption, () => {
             const appKey = this.app.config.get('app.appKey');
@@ -54,10 +87,9 @@ export default class AppServiceProvider {
         });
         this.app.container.alias('encryption', Encryption);
     }
-    async configureValidator() {
-        const config = await this.app.container.make('config');
-        validator.configure(config.get('validator', {}));
-    }
+    /**
+     * Registers bindings
+     */
     register() {
         this.registerApp();
         this.registerAce();
@@ -68,7 +100,4 @@ export default class AppServiceProvider {
         this.registerEncryption();
         this.registerTestUtils();
     }
-    async boot() {
-        await this.configureValidator();
-    }
 }

package/build/providers/hash_provider.d.ts

@@ -1,9 +1,25 @@
 import type { ApplicationService } from '../src/types.js';
+/**
+ * Registers the passwords hasher with the container
+ */
 export default class HashServiceProvider {
     protected app: ApplicationService;
     constructor(app: ApplicationService);
+    /**
+     * Registering bundled drivers with the driversList collection
+     */
     protected registerHashDrivers(): void;
+    /**
+     * Registering the hash class to resolve an instance with the
+     * default hasher.
+     */
     protected registerHash(): void;
+    /**
+     * Registers the hash manager with the container
+     */
     protected registerHashManager(): void;
+    /**
+     * Registers bindings
+     */
     register(): void;
 }

package/build/providers/hash_provider.js

@@ -1,29 +1,54 @@
-import { Hash, HashManager } from '../modules/hash/main.js';
-import hashDriversCollection from '../modules/hash/drivers_collection.js';
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Argon, Bcrypt, Hash, Scrypt, driversList } from '../modules/hash/main.js';
+/**
+ * Registers the passwords hasher with the container
+ */
 export default class HashServiceProvider {
     app;
     constructor(app) {
         this.app = app;
     }
+    /**
+     * Registering bundled drivers with the driversList collection
+     */
     registerHashDrivers() {
-        this.app.container.singleton('hashDrivers', () => hashDriversCollection);
+        driversList.extend('bcrypt', (config) => new Bcrypt(config));
+        driversList.extend('scrypt', (config) => new Scrypt(config));
+        driversList.extend('argon2', (config) => new Argon(config));
     }
+    /**
+     * Registering the hash class to resolve an instance with the
+     * default hasher.
+     */
     registerHash() {
         this.app.container.singleton(Hash, async (resolver) => {
             const hashManager = await resolver.make('hash');
             return hashManager.use();
         });
     }
+    /**
+     * Registers the hash manager with the container
+     */
     registerHashManager() {
-        this.app.container.singleton(HashManager, async () => {
+        this.app.container.singleton('hash', async () => {
+            const { HashManager } = await import('../modules/hash/main.js');
             const config = this.app.config.get('hash');
             return new HashManager(config);
         });
-        this.app.container.alias('hash', HashManager);
     }
+    /**
+     * Registers bindings
+     */
     register() {
-        this.registerHashManager();
         this.registerHashDrivers();
+        this.registerHashManager();
         this.registerHash();
     }
 }

package/build/providers/http_provider.d.ts

@@ -1,9 +1,26 @@
 import type { ApplicationService } from '../src/types.js';
+/**
+ * Http Service provider binds the router and the HTTP server to
+ * the container.
+ */
 export default class HttpServiceProvider {
     protected app: ApplicationService;
     constructor(app: ApplicationService);
+    /**
+     * Registers the HTTP server with the container as a singleton
+     */
     protected registerServer(): void;
+    /**
+     * Registers router with the container as a singleton
+     */
     protected registerRouter(): void;
+    /**
+     * Self construct bodyparser middleware class, since it needs
+     * config that cannot be resolved by the container
+     */
     protected registerBodyParserMiddleware(): void;
+    /**
+     * Registers bindings
+     */
     register(): void;
 }

package/build/providers/http_provider.js

@@ -1,10 +1,25 @@
-import { Router, Server } from '../modules/http.js';
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Router, Server } from '../modules/http/main.js';
 import BodyParserMiddleware from '../modules/bodyparser/bodyparser_middleware.js';
+/**
+ * Http Service provider binds the router and the HTTP server to
+ * the container.
+ */
 export default class HttpServiceProvider {
     app;
     constructor(app) {
         this.app = app;
     }
+    /**
+     * Registers the HTTP server with the container as a singleton
+     */
     registerServer() {
         this.app.container.singleton(Server, async (resolver) => {
             const encryption = await resolver.make('encryption');
@@ -15,6 +30,9 @@ export default class HttpServiceProvider {
         });
         this.app.container.alias('server', Server);
     }
+    /**
+     * Registers router with the container as a singleton
+     */
     registerRouter() {
         this.app.container.singleton(Router, async (resolver) => {
             const server = await resolver.make('server');
@@ -22,12 +40,19 @@ export default class HttpServiceProvider {
         });
         this.app.container.alias('router', Router);
     }
+    /**
+     * Self construct bodyparser middleware class, since it needs
+     * config that cannot be resolved by the container
+     */
     registerBodyParserMiddleware() {
         this.app.container.bind(BodyParserMiddleware, () => {
             const config = this.app.config.get('bodyparser');
             return new BodyParserMiddleware(config);
         });
     }
+    /**
+     * Registers bindings
+     */
     register() {
         this.registerServer();
         this.registerRouter();

package/build/providers/repl_provider.d.ts

@@ -0,0 +1,13 @@
+import type { ApplicationService } from '../src/types.js';
+export default class ReplServiceProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    /**
+     * Registers the REPL binding
+     */
+    register(): void;
+    /**
+     * Registering REPL bindings during provider boot
+     */
+    boot(): Promise<void>;
+}

package/build/providers/repl_provider.js

@@ -0,0 +1,37 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { join } from 'node:path';
+import { homedir } from 'node:os';
+export default class ReplServiceProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    /**
+     * Registers the REPL binding
+     */
+    register() {
+        this.app.container.singleton('repl', async () => {
+            const { Repl } = await import('../modules/repl.js');
+            return new Repl({
+                historyFilePath: join(homedir(), '.adonisjs_v6_repl_history'),
+            });
+        });
+    }
+    /**
+     * Registering REPL bindings during provider boot
+     */
+    async boot() {
+        if (this.app.getEnvironment() === 'repl') {
+            const repl = await this.app.container.make('repl');
+            const { defineReplBindings } = await import('../src/bindings/repl.js');
+            defineReplBindings(this.app, repl);
+        }
+    }
+}

package/build/services/ace.js

@@ -1,5 +1,20 @@
+/*
+ * @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 ace;
+/**
+ * Returns a singleton instance of the ace kernel
+ * from the container.
+ *
+ * ace service is an instance of the "Kernel" class stored inside
+ * the "modules/ace/kernel.ts" file
+ */
 await app.booted(async () => {
     ace = await app.container.make('ace');
 });

package/build/services/app.d.ts

@@ -1,4 +1,12 @@
 import type { ApplicationService } from '../src/types.js';
 declare let app: ApplicationService;
+/**
+ * Set the application instance the app service should
+ * be using. Other services relies on the same app
+ * instance as well.
+ *
+ * app service is an instance of the "Application" exported from
+ * the "modules/app.ts" file.
+ */
 export declare function setApp(appService: ApplicationService): void;
 export { app as default };

package/build/services/app.js

@@ -1,4 +1,20 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 let app;
+/**
+ * Set the application instance the app service should
+ * be using. Other services relies on the same app
+ * instance as well.
+ *
+ * app service is an instance of the "Application" exported from
+ * the "modules/app.ts" file.
+ */
 export function setApp(appService) {
     app = appService;
 }

package/build/services/config.js

@@ -1,5 +1,16 @@
+/*
+ * @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 config;
+/**
+ * The config service uses the config instance from the app service
+ */
 await app.booted(() => {
     config = app.config;
 });

package/build/services/emitter.js

@@ -1,7 +1,18 @@
+/*
+ * @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';
-import { Emitter } from '../modules/events.js';
 let emitter;
+/**
+ * Returns a singleton instance of the emitter class
+ * from the container
+ */
 await app.booted(async () => {
-    emitter = await app.container.make(Emitter);
+    emitter = await app.container.make('emitter');
 });
 export { emitter as default };

package/build/services/encryption.js

@@ -1,7 +1,18 @@
+/*
+ * @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';
-import { Encryption } from '../modules/encryption.js';
 let encryption;
+/**
+ * Returns a singleton instance of the encryption class
+ * from the container
+ */
 await app.booted(async () => {
-    encryption = await app.container.make(Encryption);
+    encryption = await app.container.make('encryption');
 });
 export { encryption as default };