@adonisjs/http-server 6.8.2-8 → 7.0.0-0

package/build/src/router/matchers.d.ts

@@ -1,27 +0,0 @@
-import Macroable from '@poppinss/macroable';
-/**
- * Shortcut methods for commonly used route matchers
- */
-export declare class RouteMatchers extends Macroable {
-    /**
-     * Enforce value to be a number and also casts it to number data
-     * type
-     */
-    number(): {
-        match: RegExp;
-        cast: (value: string) => number;
-    };
-    /**
-     * Enforce value to be formatted as uuid
-     */
-    uuid(): {
-        match: RegExp;
-        cast: (value: string) => string;
-    };
-    /**
-     * Enforce value to be formatted as slug
-     */
-    slug(): {
-        match: RegExp;
-    };
-}

package/build/src/router/matchers.js

@@ -1,36 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import Macroable from '@poppinss/macroable';
-/**
- * Shortcut methods for commonly used route matchers
- */
-export class RouteMatchers extends Macroable {
-    /**
-     * Enforce value to be a number and also casts it to number data
-     * type
-     */
-    number() {
-        return { match: /^[0-9]+$/, cast: (value) => Number(value) };
-    }
-    /**
-     * Enforce value to be formatted as uuid
-     */
-    uuid() {
-        return {
-            match: /^[0-9a-zA-F]{8}-[0-9a-zA-F]{4}-[0-9a-zA-F]{4}-[0-9a-zA-F]{4}-[0-9a-zA-F]{12}$/,
-            cast: (value) => value.toLowerCase(),
-        };
-    }
-    /**
-     * Enforce value to be formatted as slug
-     */
-    slug() {
-        return { match: /^[^\s-_](?!.*?[-_]{2,})([a-z0-9-\\]{1,})[^\s]*[^-_\s]$/ };
-    }
-}

package/build/src/router/parser.d.ts

@@ -1,5 +0,0 @@
-import { MatchItRouteToken, RouteMatchers } from '../types/route.js';
-/**
- * Parses the route pattern
- */
-export declare function parseRoutePattern(pattern: string, matchers?: RouteMatchers): MatchItRouteToken[];

package/build/src/router/parser.js

@@ -1,17 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-// @ts-expect-error
-import matchit from '@poppinss/matchit';
-/**
- * Parses the route pattern
- */
-export function parseRoutePattern(pattern, matchers) {
-    const tokens = matchit.parse(pattern, matchers);
-    return tokens;
-}

package/build/src/router/resource.d.ts

@@ -1,54 +0,0 @@
-import Macroable from '@poppinss/macroable';
-import type { Application } from '@adonisjs/application';
-import { Route } from './route.js';
-import type { Constructor, LazyImport } from '../types/base.js';
-import type { ParsedGlobalMiddleware } from '../types/middleware.js';
-import type { ResourceActionNames, RouteMatcher, RouteMatchers } from '../types/route.js';
-/**
- * Route resource exposes the API to register multiple routes for a resource.
- */
-export declare class RouteResource extends Macroable {
-    #private;
-    /**
-     * A collection of routes instances that belongs to this resource
-     */
-    routes: Route[];
-    constructor(app: Application<any>, routerMiddleware: ParsedGlobalMiddleware[], options: {
-        resource: string;
-        controller: string | LazyImport<Constructor<any>> | Constructor<any>;
-        globalMatchers: RouteMatchers;
-        shallow: boolean;
-    });
-    /**
-     * Register only given routes and remove others
-     */
-    only(names: ResourceActionNames[]): this;
-    /**
-     * Register all routes, except the one's defined
-     */
-    except(names: ResourceActionNames[]): this;
-    /**
-     * Register api only routes. The `create` and `edit` routes, which
-     * are meant to show forms will not be registered
-     */
-    apiOnly(): this;
-    /**
-     * Define matcher for params inside the resource
-     */
-    where(key: string, matcher: RouteMatcher | string | RegExp): this;
-    /**
-     * Tap into multiple routes to configure them by their name
-     */
-    tap(callback: (route: Route) => void): this;
-    tap(actions: ResourceActionNames | ResourceActionNames[], callback: (route: Route) => void): this;
-    /**
-     * Set the param name for a given resource
-     */
-    params(resources: {
-        [resource: string]: string;
-    }): this;
-    /**
-     * Prepend name to all the routes
-     */
-    as(name: string, normalizeName?: boolean): this;
-}

package/build/src/router/resource.js

@@ -1,216 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import string from '@poppinss/utils/string';
-import Macroable from '@poppinss/macroable';
-import { RuntimeException } from '@poppinss/utils';
-import { Route } from './route.js';
-/**
- * Route resource exposes the API to register multiple routes for a resource.
- */
-export class RouteResource extends Macroable {
-    /**
-     * Resource identifier. Nested resources are separated
-     * with a dot notation
-     */
-    #resource;
-    /**
-     * The controller to handle resource routing requests
-     */
-    #controller;
-    /**
-     * Is it a shallow resource? Shallow resources URLs do not have parent
-     * resource name and id once they can be identified with the id.
-     */
-    #shallow = false;
-    /**
-     * Matchers inherited from the router
-     */
-    #globalMatchers;
-    /**
-     * Reference to the AdonisJS application
-     */
-    #app;
-    /**
-     * Middleware registered on the router
-     */
-    #routerMiddleware;
-    /**
-     * Parameter names for the resources. Defaults to `id` for
-     * a singular resource and `resource_id` for nested
-     * resources.
-     */
-    #params = {};
-    /**
-     * Base name for the routes. We suffix action names
-     * on top of the base name
-     */
-    #routesBaseName;
-    /**
-     * A collection of routes instances that belongs to this resource
-     */
-    routes = [];
-    constructor(app, routerMiddleware, options) {
-        super();
-        this.#validateResourceName(options.resource);
-        this.#app = app;
-        this.#shallow = options.shallow;
-        this.#routerMiddleware = routerMiddleware;
-        this.#controller = options.controller;
-        this.#globalMatchers = options.globalMatchers;
-        this.#resource = this.#normalizeResourceName(options.resource);
-        this.#routesBaseName = this.#getRoutesBaseName();
-        this.#buildRoutes();
-    }
-    /**
-     * Normalizes the resource name to dropping leading and trailing
-     * slashes.
-     */
-    #normalizeResourceName(resource) {
-        return resource.replace(/^\//, '').replace(/\/$/, '');
-    }
-    /**
-     * Ensure resource name is not an empty string
-     */
-    #validateResourceName(resource) {
-        if (!resource || resource === '/') {
-            throw new RuntimeException(`Invalid resource name "${resource}"`);
-        }
-    }
-    /**
-     * Converting segments of a resource to snake case to
-     * make the route name.
-     */
-    #getRoutesBaseName() {
-        return this.#resource
-            .split('.')
-            .map((token) => string.snakeCase(token))
-            .join('.');
-    }
-    /**
-     * Create a new route for the given pattern, methods and controller action
-     */
-    #createRoute(pattern, methods, action) {
-        const route = new Route(this.#app, this.#routerMiddleware, {
-            pattern,
-            methods,
-            handler: typeof this.#controller === 'string'
-                ? `${this.#controller}.${action}`
-                : [this.#controller, action],
-            globalMatchers: this.#globalMatchers,
-        });
-        route.as(`${this.#routesBaseName}.${action}`);
-        this.routes.push(route);
-    }
-    /**
-     * Returns the `resource_id` name for a given resource. The
-     * resource name is converted to singular form and
-     * transformed to snake case.
-     *
-     * photos becomes photo_id
-     * users becomes user_id
-     */
-    #getResourceId(resource) {
-        return `${string.snakeCase(string.singular(resource))}_id`;
-    }
-    /**
-     * Build routes for the given resource
-     */
-    #buildRoutes() {
-        const resources = this.#resource.split('.');
-        const mainResource = resources.pop();
-        this.#params[mainResource] = ':id';
-        const baseURI = `${resources
-            .map((resource) => {
-            const paramName = `:${this.#getResourceId(resource)}`;
-            this.#params[resource] = paramName;
-            return `${resource}/${paramName}`;
-        })
-            .join('/')}/${mainResource}`;
-        this.#createRoute(baseURI, ['GET', 'HEAD'], 'index');
-        this.#createRoute(`${baseURI}/create`, ['GET', 'HEAD'], 'create');
-        this.#createRoute(baseURI, ['POST'], 'store');
-        this.#createRoute(`${this.#shallow ? mainResource : baseURI}/:id`, ['GET', 'HEAD'], 'show');
-        this.#createRoute(`${this.#shallow ? mainResource : baseURI}/:id/edit`, ['GET', 'HEAD'], 'edit');
-        this.#createRoute(`${this.#shallow ? mainResource : baseURI}/:id`, ['PUT', 'PATCH'], 'update');
-        this.#createRoute(`${this.#shallow ? mainResource : baseURI}/:id`, ['DELETE'], 'destroy');
-    }
-    /**
-     * Filter the routes based on their partial names
-     */
-    #filter(names, inverse) {
-        const actions = Array.isArray(names) ? names : [names];
-        return this.routes.filter((route) => {
-            const match = actions.find((name) => route.getName().endsWith(name));
-            return inverse ? !match : match;
-        });
-    }
-    /**
-     * Register only given routes and remove others
-     */
-    only(names) {
-        this.#filter(names, true).forEach((route) => route.markAsDeleted());
-        return this;
-    }
-    /**
-     * Register all routes, except the one's defined
-     */
-    except(names) {
-        this.#filter(names, false).forEach((route) => route.markAsDeleted());
-        return this;
-    }
-    /**
-     * Register api only routes. The `create` and `edit` routes, which
-     * are meant to show forms will not be registered
-     */
-    apiOnly() {
-        return this.except(['create', 'edit']);
-    }
-    /**
-     * Define matcher for params inside the resource
-     */
-    where(key, matcher) {
-        this.routes.forEach((route) => {
-            route.where(key, matcher);
-        });
-        return this;
-    }
-    tap(actions, callback) {
-        if (typeof actions === 'function') {
-            this.routes.forEach((route) => actions(route));
-            return this;
-        }
-        this.#filter(actions, false).forEach((route) => callback(route));
-        return this;
-    }
-    /**
-     * Set the param name for a given resource
-     */
-    params(resources) {
-        Object.keys(resources).forEach((resource) => {
-            const param = resources[resource];
-            const existingParam = this.#params[resource];
-            this.#params[resource] = `:${param}`;
-            this.routes.forEach((route) => {
-                route.setPattern(route.getPattern().replace(`${resource}/${existingParam}`, `${resource}/:${param}`));
-            });
-        });
-        return this;
-    }
-    /**
-     * Prepend name to all the routes
-     */
-    as(name, normalizeName = true) {
-        name = normalizeName ? string.snakeCase(name) : name;
-        this.routes.forEach((route) => {
-            route.as(route.getName().replace(this.#routesBaseName, name), false);
-        });
-        this.#routesBaseName = name;
-        return this;
-    }
-}

package/build/src/router/route.d.ts

@@ -1,92 +0,0 @@
-import Macroable from '@poppinss/macroable';
-import type { Application } from '@adonisjs/application';
-import type { Constructor, LazyImport, OneOrMore } from '../types/base.js';
-import type { MiddlewareFn, ParsedNamedMiddleware, ParsedGlobalMiddleware } from '../types/middleware.js';
-import type { GetControllerHandlers, RouteFn, RouteJSON, RouteMatcher, RouteMatchers, StoreRouteMiddleware } from '../types/route.js';
-/**
- * The route class exposes the APIs for constructing a route using the
- * fluent API.
- */
-export declare class Route<Controller extends Constructor<any> = any> extends Macroable {
-    #private;
-    constructor(app: Application<any>, routerMiddleware: ParsedGlobalMiddleware[], options: {
-        pattern: string;
-        methods: string[];
-        handler: RouteFn | string | [LazyImport<Controller> | Controller, GetControllerHandlers<Controller>?];
-        globalMatchers: RouteMatchers;
-    });
-    /**
-     * Define matcher for a given param. If a matcher exists, then we do not
-     * override that, since the routes inside a group will set matchers
-     * before the group, so they should have priority over the group
-     * matchers.
-     *
-     * ```ts
-     * Route.group(() => {
-     *   Route.get('/:id', 'handler').where('id', /^[0-9]$/)
-     * }).where('id', /[^a-z$]/)
-     * ```
-     *
-     * The `/^[0-9]$/` will win over the matcher defined by the group
-     */
-    where(param: string, matcher: RouteMatcher | string | RegExp): this;
-    /**
-     * Define prefix for the route. Calling this method multiple times
-     * applies multiple prefixes in the reverse order.
-     */
-    prefix(prefix: string): this;
-    /**
-     * Define a custom domain for the route. We do not overwrite the domain
-     * unless `overwrite` flag is set to true.
-     */
-    domain(domain: string, overwrite?: boolean): this;
-    /**
-     * Define one or more middleware to be executed before the route
-     * handler.
-     *
-     * Named middleware can be referenced using the name registered with
-     * the router middleware store.
-     */
-    use(middleware: OneOrMore<MiddlewareFn | ParsedNamedMiddleware>): this;
-    /**
-     * @alias use
-     */
-    middleware(middleware: OneOrMore<MiddlewareFn | ParsedNamedMiddleware>): this;
-    /**
-     * Give a unique name to the route. Assinging a new unique removes the
-     * existing name of the route.
-     *
-     * Setting prepends to true prefixes the name to the existing name.
-     */
-    as(name: string, prepend?: boolean): this;
-    /**
-     * Check if the route was marked to be deleted
-     */
-    isDeleted(): boolean;
-    /**
-     * Mark route as deleted. Deleted routes are not registered
-     * with the route store
-     */
-    markAsDeleted(): void;
-    /**
-     * Get the route name
-     */
-    getName(): string | undefined;
-    /**
-     * Get the route pattern
-     */
-    getPattern(): string;
-    /**
-     * Set the route pattern
-     */
-    setPattern(pattern: string): this;
-    /**
-     * Returns the stack of middleware registered on the route.
-     * The value is shared by reference.
-     */
-    getMiddleware(): StoreRouteMiddleware[][];
-    /**
-     * Returns JSON representation of the route
-     */
-    toJSON(): RouteJSON;
-}