@adonisjs/core 7.0.0-next.10 → 7.0.0-next.12

package/build/modules/http/request_validator.js

@@ -1,100 +0,0 @@
-/*
- * @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 for validating HTTP request data using VineJS validators.
- * This class provides a convenient way to validate request body, files, cookies,
- * headers, and URL parameters in AdonisJS applications.
- *
- * @example
- * ```ts
- * // Inside a controller method
- * const data = await request.validateUsing(createUserValidator, {
- *   messagesProvider: customMessages
- * })
- * ```
- */
-export class RequestValidator {
-    #ctx;
-    #experimentalFlags;
-    constructor(ctx, experimentalFlags) {
-        this.#ctx = ctx;
-        this.#experimentalFlags = experimentalFlags;
-    }
-    /**
-     * 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;
-    /**
-     * Validate the current HTTP request data using a VineJS validator.
-     * This method automatically includes request body, files, URL parameters,
-     * headers, and cookies in the validation data.
-     *
-     * @param validator - VineJS validator instance
-     * @param options - Optional validation options including custom error reporters and messages
-     *
-     * @example
-     * ```ts
-     * const createUserValidator = vine.compile(
-     *   vine.object({
-     *     email: vine.string().email(),
-     *     name: vine.string().minLength(3)
-     *   })
-     * )
-     *
-     * const data = await request.validateUsing(createUserValidator, {
-     *   errorReporter: () => vine.errors.SimpleErrorReporter,
-     *   messagesProvider: customMessages
-     * })
-     * ```
-     */
-    validateUsing(validator, ...[options]) {
-        const validatorOptions = options || {};
-        /**
-         * Assign request specific error reporter
-         */
-        if (RequestValidator.errorReporter && !validatorOptions.errorReporter) {
-            const errorReporter = RequestValidator.errorReporter(this.#ctx);
-            validatorOptions.errorReporter = () => errorReporter;
-        }
-        /**
-         * Assign request specific messages provider
-         */
-        if (RequestValidator.messagesProvider && !validatorOptions.messagesProvider) {
-            validatorOptions.messagesProvider = RequestValidator.messagesProvider(this.#ctx);
-        }
-        const requestBody = this.#experimentalFlags?.enabled('mergeMultipartFieldsAndFiles')
-            ? this.#ctx.request.all()
-            : {
-                ...this.#ctx.request.all(),
-                ...this.#ctx.request.allFiles(),
-            };
-        /**
-         * Data to validate
-         */
-        const data = validatorOptions.data || {
-            ...requestBody,
-            params: this.#ctx.request.params(),
-            headers: this.#ctx.request.headers(),
-            cookies: this.#ctx.request.cookiesList(),
-        };
-        return validator.validate(data, validatorOptions);
-    }
-}

package/build/src/assembler_hooks/index_entities.js

@@ -1,112 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import stringHelpers from "../helpers/string.js";
-import { outputTransformerDataObjects } from "../utils.js";
-/**
- * Configures the IndexGenerator to create barrel files for "controllers", "events",
- * and "listeners". This function is used as an assembler hook to automatically generate
- * index files that export all modules from specified directories.
- *
- * @param {IndexEntitiesConfig} entities - Configuration object for entities indexing
- *
- * @example
- * // Basic usage with default configuration
- * indexEntities({})
- *
- * @example
- * // Custom configuration for specific entities
- * indexEntities({
- *   events: {
- *     enabled: true,
- *     source: 'app/custom-events',
- *     importAlias: '#custom-events'
- *   },
- *   controllers: {
- *     enabled: false
- *   }
- * })
- *
- * @example
- * // Using custom glob patterns
- * indexEntities({
- *   listeners: {
- *     source: 'app/handlers',
- *     glob: '**\/*_handler.ts'
- *   }
- * })
- */
-export function indexEntities(entities = {}) {
-    const events = Object.assign({ enabled: true, source: 'app/events', importAlias: '#events' }, entities.events);
-    const listeners = Object.assign({ enabled: true, source: 'app/listeners', importAlias: '#listeners' }, entities.listeners);
-    const controllers = Object.assign({ enabled: true, source: 'app/controllers', importAlias: '#controllers' }, entities.controllers);
-    const transformers = Object.assign({
-        enabled: false,
-        source: 'app/transformers',
-        importAlias: '#transformers',
-        withSharedProps: false,
-    }, entities.transformers);
-    return {
-        run(_, indexGenerator) {
-            if (events.enabled) {
-                indexGenerator.add('events', {
-                    source: events.source,
-                    disableLazyImports: true,
-                    glob: events.glob,
-                    as: 'barrelFile',
-                    exportName: 'events',
-                    importAlias: events.importAlias,
-                    output: '.adonisjs/server/events.ts',
-                });
-            }
-            if (listeners.enabled) {
-                indexGenerator.add('listeners', {
-                    source: listeners.source,
-                    glob: listeners.glob,
-                    as: 'barrelFile',
-                    exportName: 'listeners',
-                    importAlias: listeners.importAlias,
-                    output: '.adonisjs/server/listeners.ts',
-                });
-            }
-            if (controllers.enabled) {
-                indexGenerator.add('controllers', {
-                    source: controllers.source,
-                    glob: controllers.glob,
-                    as: 'barrelFile',
-                    exportName: 'controllers',
-                    importAlias: controllers.importAlias,
-                    removeSuffix: 'controller',
-                    output: '.adonisjs/server/controllers.ts',
-                });
-            }
-            if (transformers.enabled) {
-                indexGenerator.add('transformers', {
-                    source: transformers.source,
-                    glob: transformers.glob,
-                    as(vfs, buffer, __, helpers) {
-                        const transformersList = vfs.asTree({
-                            transformKey(key) {
-                                const segments = key.split('/');
-                                const baseName = segments.pop();
-                                return [
-                                    ...segments.map((segment) => stringHelpers.pascalCase(segment)),
-                                    stringHelpers.create(baseName).removeSuffix('transformer').pascalCase(),
-                                ].join('/');
-                            },
-                            transformValue: helpers.toImportPath,
-                        });
-                        outputTransformerDataObjects(transformersList, buffer, transformers.withSharedProps);
-                    },
-                    importAlias: transformers.importAlias,
-                    output: '.adonisjs/client/data.d.ts',
-                });
-            }
-        },
-    };
-}

package/build/src/cli_formatters/routes_list.js

@@ -1,397 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import stringWidth from 'string-width';
-import { cliHelpers } from "../../modules/ace/main.js";
-import { middlewareInfo, routeInfo } from '@adonisjs/http-server/helpers';
-/**
- * Routes list formatter is used to format the routes to JSON or an ANSI string
- * with pretty output.
- *
- * The decisions of colors, padding, alignment are all handled by the lists formatter
- *
- * @example
- * const formatter = new RoutesListFormatter(router, ui, {
- *   displayHeadRoutes: false,
- *   maxPrettyPrintWidth: 120
- * }, {
- *   match: 'api',
- *   middleware: ['auth']
- * })
- *
- * const ansiOutput = await formatter.formatAsAnsiList()
- */
-export class RoutesListFormatter {
-    /**
-     * Router instance containing all registered routes
-     */
-    #router;
-    /**
-     * Colors utility for ANSI formatting
-     */
-    #colors;
-    /**
-     * Table utility for creating formatted tables
-     */
-    #table;
-    /**
-     * Options for printing routes
-     */
-    #options;
-    /**
-     * Filters to apply when finding routes
-     */
-    #filters;
-    /**
-     * Creates a new instance of the routes list formatter
-     *
-     * @param router - Router instance containing routes to format
-     * @param ui - UI primitives for colors and table formatting
-     * @param options - Display options for route formatting
-     * @param filters - Filters to apply when displaying routes
-     */
-    constructor(router, ui, options, filters) {
-        this.#router = router;
-        this.#colors = ui.colors;
-        this.#table = ui.table;
-        this.#filters = filters;
-        this.#options = options;
-        this.#router.commit();
-    }
-    /**
-     * 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;
-        /**
-         * Check if the route is allowed by applying the middleware
-         * filter
-         */
-        if (this.#filters.middleware) {
-            allowRoute = this.#filters.middleware.every((name) => {
-                if (name === '*') {
-                    return route.middleware.length > 0;
-                }
-                return route.middleware.find((middleware) => middleware.name === name);
-            });
-        }
-        /**
-         * Check if the route has any or the ignored middleware. If yes, do not
-         * display the route
-         */
-        if (allowRoute && this.#filters.ignoreMiddleware) {
-            allowRoute = this.#filters.ignoreMiddleware.every((name) => {
-                if (name === '*') {
-                    return route.middleware.length === 0;
-                }
-                return !route.middleware.find((middleware) => middleware.name === name);
-            });
-        }
-        /**
-         * No more filters to be applied
-         */
-        if (!this.#filters.match) {
-            return allowRoute;
-        }
-        /**
-         * Check if the route name has the match keyword
-         */
-        if (route.name.includes(this.#filters.match)) {
-            return true;
-        }
-        /**
-         * Check if the route pattern has the match keyword
-         */
-        if (route.pattern.includes(this.#filters.match)) {
-            return true;
-        }
-        /**
-         * Check if the route handler has the match keyword
-         */
-        if (route.handler.type === 'controller'
-            ? route.handler.moduleNameOrPath.includes(this.#filters.match)
-            : route.handler.name.includes(this.#filters.match)) {
-            return true;
-        }
-        /**
-         * Disallow route
-         */
-        return false;
-    }
-    /**
-     * 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;
-        if (!this.#options.displayHeadRoutes) {
-            methods = methods.filter((method) => method !== 'HEAD');
-        }
-        const middlewareList = await Promise.all([...route.middleware.all()].map((middleware) => {
-            return middlewareInfo(middleware);
-        }));
-        return {
-            name: route.name || '',
-            pattern: route.pattern,
-            methods: methods,
-            handler: await routeInfo(route),
-            middleware: middlewareList.filter((info) => info.type !== 'global'),
-        };
-    }
-    /**
-     * 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 with colored parameters and route name.
-     *
-     * @param route - The serialized route containing pattern and name information
-     */
-    #formatRoutePattern(route) {
-        const pattern = this.#router
-            .parsePattern(route.pattern)
-            .map((token) => {
-            if (token.type === 1) {
-                return this.#colors.yellow(`:${token.val}`);
-            }
-            if (token.type === 3) {
-                return this.#colors.yellow(`:${token.val}?`);
-            }
-            if (token.type === 2) {
-                return this.#colors.red(token.val);
-            }
-            return token.val;
-        })
-            .join('/');
-        return `${pattern === '/' ? pattern : `/${pattern}`}${route.name ? ` ${this.#colors.dim(`(${route.name})`)}` : ''} `;
-    }
-    /**
-     * 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'
-            ? ` ${this.#colors.cyan(route.handler.moduleNameOrPath)}.`
-            : '';
-    }
-    /**
-     * 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') {
-            return `${this.#colors.cyan(route.handler.method)}`;
-        }
-        const functionName = ` ${this.#colors.cyan(route.handler.name)}`;
-        if (route.handler.args) {
-            return ` ${functionName}${this.#colors.dim(`(${route.handler.args})`)}`;
-        }
-        return functionName;
-    }
-    /**
-     * 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) {
-            const firstMiddleware = route.middleware[0].name;
-            const secondMiddleware = route.middleware[1].name;
-            const diff = route.middleware.length - 2;
-            return this.#colors.dim(`${firstMiddleware}, ${secondMiddleware}, and ${diff} more`);
-        }
-        return this.#colors.dim(`${route.middleware
-            .map((one) => one.name)
-            .filter((one) => one)
-            .join(', ')}`);
-    }
-    /**
-     * Formatting the domain headling to be in green color with
-     * dots around it
-     */
-    #formatDomainHeadline(domain) {
-        if (domain !== 'root') {
-            return cliHelpers.justify([`${this.#colors.dim('..')} ${this.#colors.green(domain)} `], {
-                maxWidth: this.#options.maxPrettyPrintWidth || cliHelpers.TERMINAL_SIZE,
-                paddingChar: this.#colors.dim('.'),
-            })[0];
-        }
-        return '';
-    }
-    /**
-     * Justify the ansi list
-     */
-    #justifyListTables(tables) {
-        return tables.map((table) => {
-            /**
-             * Formatting methods
-             */
-            const methods = table.rows.map((columns) => columns[0]);
-            const largestMethodsLength = Math.max(...methods.map((method) => stringWidth(method)));
-            const formattedMethods = cliHelpers.justify(methods, {
-                maxWidth: largestMethodsLength,
-            });
-            /**
-             * Formatting patterns
-             */
-            const patterns = table.rows.map((columns) => columns[1]);
-            const largestPatternLength = Math.max(...patterns.map((pattern) => stringWidth(pattern)));
-            const formattedPatterns = cliHelpers.justify(patterns, {
-                maxWidth: largestPatternLength,
-                paddingChar: this.#colors.dim('.'),
-            });
-            /**
-             * Formatting middleware to be right aligned
-             */
-            const middleware = table.rows.map((columns) => columns[3]);
-            const largestMiddlewareLength = Math.max(...middleware.map((one) => stringWidth(one)));
-            const formattedMiddleware = cliHelpers.justify(middleware, {
-                maxWidth: largestMiddlewareLength,
-                align: 'right',
-                paddingChar: ' ',
-            });
-            /**
-             * Formatting controllers to be right aligned and take all the remaining
-             * space after printing route method, pattern and middleware.
-             */
-            const controllers = table.rows.map((columns) => columns[2]);
-            const largestControllerLength = (this.#options.maxPrettyPrintWidth || cliHelpers.TERMINAL_SIZE) -
-                (largestPatternLength + largestMethodsLength + largestMiddlewareLength);
-            const formattedControllers = cliHelpers.truncate(cliHelpers.justify(controllers, {
-                maxWidth: largestControllerLength,
-                align: 'right',
-                paddingChar: this.#colors.dim('.'),
-            }), {
-                maxWidth: largestControllerLength,
-            });
-            return {
-                heading: table.heading,
-                rows: formattedMethods.reduce((result, method, index) => {
-                    result.push(`${method}${formattedPatterns[index]}${formattedControllers[index]}${formattedMiddleware[index]}`);
-                    return result;
-                }, []),
-            };
-        });
-    }
-    /**
-     * Formats routes as an array of objects. Routes are grouped by
-     * domain.
-     */
-    async formatAsJSON() {
-        const routes = this.#router.toJSON();
-        const domains = Object.keys(routes);
-        let routesJSON = [];
-        for (let domain of domains) {
-            const domainRoutes = await Promise.all(routes[domain].map((route) => this.#serializeRoute(route)));
-            routesJSON.push({
-                domain,
-                routes: domainRoutes.filter((route) => this.#isAllowedByFilters(route)),
-            });
-        }
-        return routesJSON;
-    }
-    /**
-     * Format routes to ansi list of tables. Each domain has its own table
-     * with heading and rows. Each row has colums with colors and spacing
-     * around them.
-     */
-    async formatAsAnsiList() {
-        const routes = this.#router.toJSON();
-        const domains = Object.keys(routes);
-        const tables = [];
-        for (let domain of domains) {
-            const list = {
-                heading: this.#formatDomainHeadline(domain),
-                rows: [
-                    [
-                        this.#colors.dim('METHOD'),
-                        ` ${this.#colors.dim('ROUTE')} `,
-                        ` ${this.#colors.dim('HANDLER')}`,
-                        ` ${this.#colors.dim('MIDDLEWARE')}`,
-                    ],
-                ],
-            };
-            /**
-             * Computing table rows. Each route+method will have its
-             * own row
-             */
-            for (let route of routes[domain]) {
-                const serializedRoute = await this.#serializeRoute(route);
-                if (this.#isAllowedByFilters(serializedRoute)) {
-                    serializedRoute.methods.forEach((method) => {
-                        list.rows.push([
-                            this.#formatRouteMethod(method),
-                            ` ${this.#formatRoutePattern(serializedRoute)}`,
-                            `${this.#formatControllerName(serializedRoute)}${this.#formatAction(serializedRoute)}`,
-                            ` ${this.#formatMiddleware(serializedRoute, 'compact')}`,
-                        ]);
-                    });
-                }
-            }
-            tables.push(list);
-        }
-        return this.#justifyListTables(tables);
-    }
-    /**
-     * Format routes to ansi tables. Each domain has its own table
-     * with heading and rows. Each row has colums with colors and spacing
-     * around them.
-     */
-    async formatAsAnsiTable() {
-        const routes = this.#router.toJSON();
-        const domains = Object.keys(routes);
-        const tables = [];
-        for (let domain of domains) {
-            const list = {
-                heading: this.#formatDomainHeadline(domain),
-                table: this.#table()
-                    .fullWidth()
-                    .fluidColumnIndex(2)
-                    .head([
-                    this.#colors.dim('METHOD'),
-                    this.#colors.dim('ROUTE'),
-                    { hAlign: 'right', content: this.#colors.dim('HANDLER') },
-                    { content: this.#colors.dim('MIDDLEWARE'), hAlign: 'right' },
-                ]),
-            };
-            /**
-             * Computing table rows. Each route+method will have its
-             * own row
-             */
-            for (let route of routes[domain]) {
-                const serializedRoute = await this.#serializeRoute(route);
-                if (this.#isAllowedByFilters(serializedRoute)) {
-                    serializedRoute.methods.forEach((method) => {
-                        list.table.row([
-                            this.#formatRouteMethod(method),
-                            this.#formatRoutePattern(serializedRoute),
-                            {
-                                content: `${this.#formatControllerName(serializedRoute)}${this.#formatAction(serializedRoute)}`,
-                                hAlign: 'right',
-                            },
-                            { content: this.#formatMiddleware(serializedRoute), hAlign: 'right' },
-                        ]);
-                    });
-                }
-            }
-            tables.push(list);
-        }
-        return tables;
-    }
-}

package/build/src/config_provider.js

@@ -1,71 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/**
- * Helper utilities to create and resolve config providers. Config providers
- * are used to defer configuration resolution until the application is booted,
- * allowing access to environment variables and other application services.
- *
- * @example
- * // Creating a database config provider
- * const databaseConfig = configProvider.create(async (app) => ({
- *   connection: app.env.get('DB_CONNECTION', 'sqlite'),
- *   host: app.env.get('DB_HOST', 'localhost'),
- *   port: app.env.get('DB_PORT', 5432)
- * }))
- *
- * @example
- * // Resolving a config provider
- * const config = await configProvider.resolve(app, databaseConfig)
- * if (config) {
- *   console.log(`Database connection: ${config.connection}`)
- * }
- */
-export const configProvider = {
-    /**
-     * Creates a new config provider that will resolve configuration
-     * when the application is booted.
-     *
-     * @param resolver - Function that receives the application service and returns the configuration
-     *
-     * @example
-     * const mailConfig = configProvider.create(async (app) => ({
-     *   driver: app.env.get('MAIL_DRIVER', 'smtp'),
-     *   host: app.env.get('SMTP_HOST'),
-     *   port: app.env.get('SMTP_PORT', 587)
-     * }))
-     */
-    create(resolver) {
-        return {
-            type: 'provider',
-            resolver,
-        };
-    },
-    /**
-     * Resolves a config provider if the provided value is a valid config provider,
-     * otherwise returns null.
-     *
-     * @param app - The application service instance
-     * @param provider - The potential config provider to resolve
-     *
-     * @example
-     * const resolved = await configProvider.resolve(app, someProvider)
-     * if (resolved) {
-     *   // Use the resolved configuration
-     *   console.log('Config resolved:', resolved)
-     * } else {
-     *   console.log('Not a valid config provider')
-     * }
-     */
-    async resolve(app, provider) {
-        if (provider && typeof provider === 'object' && 'type' in provider) {
-            return provider.resolver(app);
-        }
-        return null;
-    },
-};