@adonisjs/http-server 5.12.0 → 6.0.0-0

package/build/src/Router/BriskRoute.d.ts

@@ -1,53 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/// <reference path="../../adonis-typings/index.d.ts" />
-import { Macroable } from 'macroable';
-import { Route } from './Route';
-import { BriskRouteContract, RouteMatchersNode, RouteHandler, MakeUrlOptions } from '@ioc:Adonis/Core/Route';
-/**
- * Brisk route enables you to expose expressive API for
- * defining route handler.
- *
- * For example: AdonisJs uses [[BriskRoute]] `Route.on().render()`
- * to render a view without defining a controller method or
- * closure.
- */
-export declare class BriskRoute extends Macroable implements BriskRouteContract {
-    private pattern;
-    private globalMatchers;
-    protected static macros: {};
-    protected static getters: {};
-    /**
-     * Invoked by is reference to the parent method that calls `setHandler` on
-     * this class. We keep a reference to the parent method name for raising
-     * meaningful exception
-     */
-    private invokedBy;
-    /**
-     * Reference to route instance. Set after `setHandler` is called
-     */
-    route: null | Route;
-    constructor(pattern: string, globalMatchers: RouteMatchersNode);
-    /**
-     * Set handler for the brisk route. The `invokedBy` string is the reference
-     * to the method that calls this method. It is required to create human
-     * readable error message when `setHandler` is called for multiple
-     * times.
-     */
-    setHandler(handler: RouteHandler, invokedBy: string, methods?: string[]): Route;
-    /**
-     * Redirect to a given route. Params from the original request will be used when no
-     * custom params are defined
-     */
-    redirect(identifier: string, params?: any[] | Record<string, any>, options?: MakeUrlOptions): Route;
-    /**
-     * Redirect request to a fixed path
-     */
-    redirectToPath(url: string): Route;
-}

package/build/src/Router/BriskRoute.js

@@ -1,74 +0,0 @@
-"use strict";
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BriskRoute = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const macroable_1 = require("macroable");
-const utils_1 = require("@poppinss/utils");
-const Route_1 = require("./Route");
-/**
- * Brisk route enables you to expose expressive API for
- * defining route handler.
- *
- * For example: AdonisJs uses [[BriskRoute]] `Route.on().render()`
- * to render a view without defining a controller method or
- * closure.
- */
-class BriskRoute extends macroable_1.Macroable {
-    constructor(pattern, globalMatchers) {
-        super();
-        this.pattern = pattern;
-        this.globalMatchers = globalMatchers;
-        /**
-         * Invoked by is reference to the parent method that calls `setHandler` on
-         * this class. We keep a reference to the parent method name for raising
-         * meaningful exception
-         */
-        this.invokedBy = '';
-        /**
-         * Reference to route instance. Set after `setHandler` is called
-         */
-        this.route = null;
-    }
-    /**
-     * Set handler for the brisk route. The `invokedBy` string is the reference
-     * to the method that calls this method. It is required to create human
-     * readable error message when `setHandler` is called for multiple
-     * times.
-     */
-    setHandler(handler, invokedBy, methods) {
-        if (this.route) {
-            throw new utils_1.Exception(`\`Route.${invokedBy}\` and \`${this.invokedBy}\` cannot be called together`, 500, 'E_MULTIPLE_BRISK_HANDLERS');
-        }
-        this.route = new Route_1.Route(this.pattern, methods || ['GET', 'HEAD'], handler, this.globalMatchers);
-        this.invokedBy = invokedBy;
-        return this.route;
-    }
-    /**
-     * Redirect to a given route. Params from the original request will be used when no
-     * custom params are defined
-     */
-    redirect(identifier, params, options) {
-        return this.setHandler(async (ctx) => {
-            return ctx.response.redirect().toRoute(identifier, params || ctx.params, options);
-        }, 'redirect');
-    }
-    /**
-     * Redirect request to a fixed path
-     */
-    redirectToPath(url) {
-        return this.setHandler(async (ctx) => {
-            return ctx.response.redirect().toPath(url);
-        }, 'redirect');
-    }
-}
-exports.BriskRoute = BriskRoute;
-BriskRoute.macros = {};
-BriskRoute.getters = {};

package/build/src/Router/Group.d.ts

@@ -1,101 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/// <reference path="../../adonis-typings/index.d.ts" />
-import { Macroable } from 'macroable';
-import { RouteGroupContract, RouteParamMatcher, RouteMiddlewareHandler } from '@ioc:Adonis/Core/Route';
-import { Route } from './Route';
-import { BriskRoute } from './BriskRoute';
-import { RouteResource } from './Resource';
-/**
- * Group class exposes the API to take action on a group of routes.
- * The group routes must be pre-defined using the constructor.
- */
-export declare class RouteGroup extends Macroable implements RouteGroupContract {
-    routes: (Route | RouteResource | BriskRoute | RouteGroup)[];
-    protected static macros: {};
-    protected static getters: {};
-    /**
-     * Array of middleware registered on the group
-     */
-    private groupMiddleware;
-    /**
-     * We register the group middleware only once with the route
-     * and then mutate the internal stack. This ensures that
-     * group own middleware are pushed to the last, but the
-     * entire group of middleware is added to the front
-     * in the routes
-     */
-    private registeredMiddlewareWithRoute;
-    constructor(routes: (Route | RouteResource | BriskRoute | RouteGroup)[]);
-    /**
-     * Invokes a given method with params on the route instance or route
-     * resource instance
-     */
-    private invoke;
-    /**
-     * Define Regex matchers for a given param for all the routes.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).where('id', /^[0-9]+/)
-     * ```
-     */
-    where(param: string, matcher: RouteParamMatcher): this;
-    /**
-     * Define prefix all the routes in the group.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).prefix('v1')
-     * ```
-     */
-    prefix(prefix: string): this;
-    /**
-     * Define domain for all the routes.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).domain(':name.adonisjs.com')
-     * ```
-     */
-    domain(domain: string): this;
-    /**
-     * Prepend name to the routes name.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).as('version1')
-     * ```
-     */
-    as(name: string): this;
-    /**
-     * Prepend an array of middleware to all routes middleware.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).middleware(['auth'])
-     * ```
-     */
-    middleware(middleware: RouteMiddlewareHandler | RouteMiddlewareHandler[], prepend?: boolean): this;
-    /**
-     * Define namespace for all the routes inside the group.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).namespace('App/Admin/Controllers')
-     * ```
-     */
-    namespace(namespace: string): this;
-}

package/build/src/Router/Group.js

@@ -1,165 +0,0 @@
-"use strict";
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouteGroup = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const macroable_1 = require("macroable");
-const BriskRoute_1 = require("./BriskRoute");
-const Resource_1 = require("./Resource");
-const RouterException_1 = require("../Exceptions/RouterException");
-/**
- * Group class exposes the API to take action on a group of routes.
- * The group routes must be pre-defined using the constructor.
- */
-class RouteGroup extends macroable_1.Macroable {
-    constructor(routes) {
-        super();
-        this.routes = routes;
-        /**
-         * Array of middleware registered on the group
-         */
-        this.groupMiddleware = [];
-        /**
-         * We register the group middleware only once with the route
-         * and then mutate the internal stack. This ensures that
-         * group own middleware are pushed to the last, but the
-         * entire group of middleware is added to the front
-         * in the routes
-         */
-        this.registeredMiddlewareWithRoute = false;
-    }
-    /**
-     * Invokes a given method with params on the route instance or route
-     * resource instance
-     */
-    invoke(route, method, params) {
-        if (route instanceof Resource_1.RouteResource) {
-            route.routes.forEach((child) => this.invoke(child, method, params));
-            return;
-        }
-        if (route instanceof RouteGroup) {
-            route.routes.forEach((child) => this.invoke(child, method, params));
-            return;
-        }
-        if (route instanceof BriskRoute_1.BriskRoute) {
-            /* istanbul ignore else */
-            if (route.route) {
-                /*
-                 * Raise error when trying to prefix route name but route doesn't have
-                 * a name
-                 */
-                if (method === 'as' && !route.route.name) {
-                    throw RouterException_1.RouterException.cannotDefineGroupName();
-                }
-                route.route[method](...params);
-            }
-            return;
-        }
-        /*
-         * Raise error when trying to prefix route name but route doesn't have
-         * a name
-         */
-        if (method === 'as' && !route.name) {
-            throw RouterException_1.RouterException.cannotDefineGroupName();
-        }
-        route[method](...params);
-    }
-    /**
-     * Define Regex matchers for a given param for all the routes.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).where('id', /^[0-9]+/)
-     * ```
-     */
-    where(param, matcher) {
-        this.routes.forEach((route) => this.invoke(route, 'where', [param, matcher]));
-        return this;
-    }
-    /**
-     * Define prefix all the routes in the group.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).prefix('v1')
-     * ```
-     */
-    prefix(prefix) {
-        this.routes.forEach((route) => this.invoke(route, 'prefix', [prefix]));
-        return this;
-    }
-    /**
-     * Define domain for all the routes.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).domain(':name.adonisjs.com')
-     * ```
-     */
-    domain(domain) {
-        this.routes.forEach((route) => this.invoke(route, 'domain', [domain]));
-        return this;
-    }
-    /**
-     * Prepend name to the routes name.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).as('version1')
-     * ```
-     */
-    as(name) {
-        this.routes.forEach((route) => this.invoke(route, 'as', [name, true]));
-        return this;
-    }
-    /**
-     * Prepend an array of middleware to all routes middleware.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).middleware(['auth'])
-     * ```
-     */
-    middleware(middleware, prepend = false) {
-        middleware = Array.isArray(middleware) ? middleware : [middleware];
-        if (prepend) {
-            middleware.forEach((one) => this.groupMiddleware.unshift(one));
-        }
-        else {
-            middleware.forEach((one) => this.groupMiddleware.push(one));
-        }
-        if (!this.registeredMiddlewareWithRoute) {
-            this.registeredMiddlewareWithRoute = true;
-            this.routes.forEach((route) => this.invoke(route, 'middleware', [this.groupMiddleware, true]));
-        }
-        return this;
-    }
-    /**
-     * Define namespace for all the routes inside the group.
-     *
-     * @example
-     * ```ts
-     * Route.group(() => {
-     * }).namespace('App/Admin/Controllers')
-     * ```
-     */
-    namespace(namespace) {
-        this.routes.forEach((route) => this.invoke(route, 'namespace', [namespace]));
-        return this;
-    }
-}
-exports.RouteGroup = RouteGroup;
-RouteGroup.macros = {};
-RouteGroup.getters = {};

package/build/src/Router/LookupStore.d.ts

@@ -1,122 +0,0 @@
-import { RouteJSON, LookupStoreTree, UrlBuilderContract, LookupStoreContract } from '@ioc:Adonis/Core/Route';
-import { EncryptionContract } from '@ioc:Adonis/Core/Encryption';
-/**
- * A class to encapsulate finding routes
- */
-declare class Routes {
-    private routes;
-    constructor(routes: RouteJSON[]);
-    /**
-     * Find a route by indentifier
-     */
-    find(routeIdentifier: string): RouteJSON | null;
-    /**
-     * Find a route by indentifier or fail
-     */
-    findOrFail(routeIdentifier: string): RouteJSON;
-    /**
-     * Find if a route exists
-     */
-    has(routeIdentifier: string): boolean;
-}
-/**
- * Url builder is responsible for building the URLs
- */
-export declare class UrlBuilder implements UrlBuilderContract {
-    private encryption;
-    private routes;
-    /**
-     * Params to be used for building the URL
-     */
-    private routeParams;
-    /**
-     * A custom query string to append to the URL
-     */
-    private queryString;
-    /**
-     * A boolean to know if the route should be looked
-     * up inside the route store or not
-     */
-    private lookupRoute;
-    /**
-     * A baseUrl to prefix to the endpoint
-     */
-    private baseUrl;
-    constructor(encryption: EncryptionContract, routes: Routes);
-    /**
-     * Processes the pattern against the params
-     */
-    private processPattern;
-    /**
-     * Suffix the query string to the URL
-     */
-    private suffixQueryString;
-    /**
-     * Prefix a custom url to the final URI
-     */
-    prefixUrl(url: string): this;
-    /**
-     * Disable route lookup. Calling this method considers
-     * the "identifier" as the route pattern
-     */
-    disableRouteLookup(): this;
-    /**
-     * Append query string to the final URI
-     */
-    qs(queryString?: Record<string, any>): this;
-    /**
-     * Define required params to resolve the route
-     */
-    params(params?: any[] | Record<string, any>): this;
-    /**
-     * Generate url for the given route identifier
-     */
-    make(identifier: string): string;
-    /**
-     * Generate url for the given route identifier
-     */
-    makeSigned(identifier: string, options?: {
-        expiresIn?: string | number;
-        purpose?: string;
-    }): string;
-}
-/**
- * The look up store to make URLs for a given route by looking
- * it by its name, route handler or the pattern directly.
- */
-export declare class LookupStore implements LookupStoreContract {
-    private encryption;
-    /**
-     * Shape of the registered routes. Optimized for lookups
-     */
-    tree: LookupStoreTree;
-    constructor(encryption: EncryptionContract);
-    /**
-     * Register a route for lookups
-     */
-    register(route: RouteJSON): void;
-    /**
-     * Returns the route builder for the root domain
-     */
-    builder(): UrlBuilder;
-    /**
-     * Returns the route builder a given domain.
-     */
-    builderForDomain(domainPattern: string): UrlBuilder;
-    /**
-     * Find a route by indentifier. Optionally one can find routes inside
-     * a given domain
-     */
-    find(routeIdentifier: string, domainPattern?: string): RouteJSON | null;
-    /**
-     * Find a route by indentifier or fail. Optionally one can find routes inside
-     * a given domain
-     */
-    findOrFail(routeIdentifier: string, domainPattern?: string): RouteJSON;
-    /**
-     * Find if a route for given identifier exists. Optionally one can find routes inside
-     * a given domain
-     */
-    has(routeIdentifier: string, domainPattern?: string): boolean;
-}
-export {};