@adonisjs/core 6.1.5-2 → 6.1.5-21

package/build/modules/config.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/config';

package/build/modules/container.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/fold';

package/build/modules/encryption.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/encryption';

package/build/modules/env.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/env';

package/build/modules/events.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/events';

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

@@ -1,5 +1,8 @@
 import type { HashDriversList } from '../../src/types.js';
 import type { ManagerDriverFactory } from '../../types/hash.js';
+/**
+ * Define config for the hash service.
+ */
 export declare function defineConfig<KnownHashers extends Record<string, {
     [K in keyof HashDriversList]: {
         driver: K;
@@ -9,6 +12,7 @@ export declare function defineConfig<KnownHashers extends Record<string, {
     list: KnownHashers;
 }): {
     default?: keyof KnownHashers;
+    driversInUse: Set<keyof HashDriversList>;
     list: {
         [K in keyof KnownHashers]: ManagerDriverFactory;
     };

package/build/modules/hash/define_config.js

@@ -1,18 +1,41 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { InvalidArgumentsException } from '@poppinss/utils';
 import driversCollection from './drivers_collection.js';
+/**
+ * Define config for the hash service.
+ */
 export function defineConfig(config) {
+    /**
+     * Hashers list should always be provided
+     */
     if (!config.list) {
         throw new InvalidArgumentsException('Missing "list" property in hash config');
     }
+    /**
+     * The default hasher should be mentioned in the list
+     */
     if (config.default && !config.list[config.default]) {
         throw new InvalidArgumentsException(`Missing "list.${String(config.default)}" in hash config. It is referenced by the "default" property`);
     }
+    /**
+     * Converting list config to a collection that hash manager can use
+     */
+    const driversInUse = new Set();
     const managerHashers = Object.keys(config.list).reduce((result, disk) => {
         const hasherConfig = config.list[disk];
+        driversInUse.add(hasherConfig.driver);
         result[disk] = () => driversCollection.create(hasherConfig.driver, hasherConfig);
         return result;
     }, {});
     return {
+        driversInUse,
         default: config.default,
         list: managerHashers,
     };

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

@@ -0,0 +1 @@
+export * from '@adonisjs/hash/drivers/argon';

package/build/modules/hash/drivers/argon.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/hash/drivers/argon';

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

@@ -0,0 +1 @@
+export * from '@adonisjs/hash/drivers/bcrypt';

package/build/modules/hash/drivers/bcrypt.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/hash/drivers/bcrypt';

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

@@ -0,0 +1 @@
+export * from '@adonisjs/hash/drivers/scrypt';

package/build/modules/hash/drivers/scrypt.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/hash/drivers/scrypt';

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

@@ -1,9 +1,21 @@
-import { Argon, Bcrypt, Scrypt } from './main.js';
 import type { HashDriversList } from '../../src/types.js';
+/**
+ * A global collection of Hash drivers
+ */
 declare class HashDriversCollection {
+    /**
+     * List of registered drivers
+     */
     list: Partial<HashDriversList>;
+    /**
+     * Extend drivers collection and add a custom
+     * driver to it.
+     */
     extend<Name extends keyof HashDriversList>(driverName: Name, factoryCallback: HashDriversList[Name]): this;
-    create<Name extends keyof HashDriversList>(name: Name, config: Parameters<HashDriversList[Name]>[0]): Bcrypt | Argon | Scrypt;
+    /**
+     * Creates the driver instance with config
+     */
+    create<Name extends keyof HashDriversList>(name: Name, config: Parameters<HashDriversList[Name]>[0]): import("@adonisjs/hash/drivers/bcrypt").Bcrypt | import("@adonisjs/hash/drivers/argon").Argon | import("@adonisjs/hash/drivers/scrypt").Scrypt;
 }
-declare const hashDriversCollection: HashDriversCollection;
-export default hashDriversCollection;
+declare const _default: HashDriversCollection;
+export default _default;

package/build/modules/hash/drivers_collection.js

@@ -1,15 +1,39 @@
-import { Argon, Bcrypt, Scrypt } from './main.js';
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * This class exists in the core, because it maintains a list of
+ * globally available drivers applicable to the hash manager
+ * instance registered with the container.
+ *
+ * In other words, these drivers are not needed by the hash module
+ * regular usage and specific to AdonisJS container flow.
+ */
 import { RuntimeException } from '@poppinss/utils';
+/**
+ * A global collection of Hash drivers
+ */
 class HashDriversCollection {
-    list = {
-        bcrypt: (config) => new Bcrypt(config),
-        argon2: (config) => new Argon(config),
-        scrypt: (config) => new Scrypt(config),
-    };
+    /**
+     * List of registered drivers
+     */
+    list = {};
+    /**
+     * Extend drivers collection and add a custom
+     * driver to it.
+     */
     extend(driverName, factoryCallback) {
         this.list[driverName] = factoryCallback;
         return this;
     }
+    /**
+     * Creates the driver instance with config
+     */
     create(name, config) {
         const driverFactory = this.list[name];
         if (!driverFactory) {
@@ -18,5 +42,4 @@ class HashDriversCollection {
         return driverFactory(config);
     }
 }
-const hashDriversCollection = new HashDriversCollection();
-export default hashDriversCollection;
+export default new HashDriversCollection();

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

@@ -1,2 +1,3 @@
 export * from '@adonisjs/hash';
 export { defineConfig } from './define_config.js';
+export { default as driversList } from './drivers_collection.js';

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,34 @@
+import type { VineValidator } from '@vinejs/vine';
+import type { Infer, SchemaTypes, ErrorReporterContract, MessagesProviderContact } from '@vinejs/vine/types';
+import type { HttpContext } from './main.js';
+import type { RequestValidationOptions } from '../../types/http.js';
+/**
+ * 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>>;
+}

package/build/modules/http/request_validator.js

@@ -0,0 +1,66 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * 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);
+    }
+}

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/edge_provider.d.ts

@@ -0,0 +1,31 @@
+import { type Edge } from 'edge.js';
+import type { ApplicationService } from '../src/types.js';
+import { type Route } from '../modules/http/main.js';
+declare module '@adonisjs/core/http' {
+    interface HttpContext {
+        /**
+         * Reference to the edge renderer to render templates
+         * during an HTTP request
+         */
+        view: ReturnType<Edge['createRenderer']>;
+    }
+    interface BriskRoute {
+        /**
+         * Render an edge template without defining an
+         * explicit route handler
+         */
+        render(template: string, data?: Record<string, any>): Route;
+    }
+}
+/**
+ * The Edge service provider configures Edge to work within
+ * an AdonisJS application environment
+ */
+export default class EdgeServiceProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    /**
+     * Bridge AdonisJS and Edge
+     */
+    boot(): Promise<void>;
+}

package/build/providers/edge_provider.js

@@ -0,0 +1,69 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import edge from 'edge.js';
+import { BriskRoute, HttpContext } from '../modules/http/main.js';
+/**
+ * The Edge service provider configures Edge to work within
+ * an AdonisJS application environment
+ */
+export default class EdgeServiceProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    /**
+     * Bridge AdonisJS and Edge
+     */
+    async boot() {
+        const app = this.app;
+        const router = await this.app.container.make('router');
+        function edgeConfigResolver(key, defaultValue) {
+            return app.config.get(key, defaultValue);
+        }
+        edgeConfigResolver.has = function (key) {
+            return app.config.has(key);
+        };
+        /**
+         * Mount the default disk
+         */
+        edge.mount(app.viewsPath());
+        /**
+         * Cache templates in production
+         */
+        edge.configure({ cache: app.inProduction });
+        /**
+         * Define Edge global helpers
+         */
+        edge.global('route', function (...args) {
+            return router.makeUrl(...args);
+        });
+        edge.global('signedRoute', function (...args) {
+            return router.makeSignedUrl(...args);
+        });
+        edge.global('app', app);
+        edge.global('config', edgeConfigResolver);
+        /**
+         * Creating a isolated instance of edge renderer
+         */
+        HttpContext.getter('view', function () {
+            return edge.createRenderer().share({
+                request: this.request,
+            });
+        });
+        /**
+         * Adding brisk route to render templates without an
+         * explicit handler
+         */
+        BriskRoute.macro('render', function (template, data) {
+            return this.setHandler(({ view }) => {
+                return view.render(template, data);
+            });
+        });
+    }
+}