@adonisjs/http-server 5.12.0 → 6.0.0-0

package/build/adonis-typings/route.d.ts

@@ -1,559 +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.
- */
-declare module '@ioc:Adonis/Core/Route' {
-    import { MacroableConstructorContract } from 'macroable';
-    import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-    import { ResolvedMiddlewareHandler } from '@ioc:Adonis/Core/Middleware';
-    /**
-     * Route.where param matcher shape
-     */
-    export type RouteParamMatcher = string | RegExp | {
-        match?: RegExp;
-        cast?: (value: string) => any;
-    };
-    /**
-     * The shape of the route handler
-     */
-    export type RouteHandler = ((ctx: HttpContextContract) => any) | string;
-    /**
-     * Middleware handler attached to the route.
-     */
-    export type RouteMiddlewareHandler = string | ((ctx: HttpContextContract, next: () => void, ...options: any[]) => any);
-    /**
-     * Node after resolving controller.method binding from the route
-     */
-    export type ResolvedRouteHandler = {
-        type: 'function';
-        handler: Exclude<RouteHandler, string>;
-    } | {
-        type: 'alias' | 'binding';
-        namespace: string;
-        method: string;
-    };
-    /**
-     * Shape of match from the route store
-     */
-    export type RouteStoreMatch = {
-        old: string;
-        type: number;
-        val: string;
-    };
-    /**
-     * Shape of route param matchers
-     */
-    export type RouteMatchersNode = {
-        [param: string]: {
-            match?: RegExp;
-            cast?: (value: string) => any;
-        };
-    };
-    /**
-     * Route node persisted within the store
-     */
-    export type RouteNode = {
-        pattern: string;
-        /**
-         * The router itself doesn't use the handler for anything, it
-         * leaves the type to `any` for the consumer to decide the
-         * shape of the handler
-         */
-        handler: RouteHandler;
-        /**
-         * The router itself doesn't use the middleware for anything, it
-         * leaves the type to `any` for the consumer to decide the
-         * shape of the middleware
-         */
-        middleware: RouteMiddlewareHandler[];
-        /**
-         * Any custom runtime properties to be added to the route
-         */
-        meta: {
-            resolvedHandler?: ResolvedRouteHandler;
-            resolvedMiddleware?: ResolvedMiddlewareHandler[];
-            namespace?: string;
-        } & Record<string, any>;
-        /**
-         * A unique name to lookup routes by name
-         */
-        name?: string;
-    };
-    /**
-     * An object of routes for a given HTTP method
-     */
-    export type MethodNode = {
-        tokens: any[];
-        routes: {
-            [pattern: string]: RouteNode & {
-                params: string[];
-            };
-        };
-    };
-    /**
-     * Each domain node will have an object of methods and then
-     * a nested object of routes
-     */
-    export type DomainNode = {
-        [method: string]: MethodNode;
-    };
-    /**
-     * Routes tree is a domain of DomainNodes
-     */
-    export type RoutesTree = {
-        tokens: any[];
-        domains: {
-            [domain: string]: DomainNode;
-        };
-    };
-    /**
-     * Route definition returned as a result of `route.toJSON` method
-     */
-    export type RouteJSON = RouteNode & {
-        methods: string[];
-        domain?: string;
-        matchers: RouteMatchersNode;
-    };
-    /**
-     * Shape of the routes tree maintained by the UrlBuilder
-     */
-    export type LookupStoreTree = {
-        [domain: string]: RouteJSON[];
-    };
-    /**
-     * Shape of the matched route for a pattern, method and domain. We set
-     * them as spread options to the context.
-     */
-    export type MatchedRoute = {
-        route: RouteNode & {
-            params: string[];
-        };
-        /**
-         * A unique key for the looked up route
-         */
-        routeKey: string;
-        params: Record<string, any>;
-        subdomains: Record<string, any>;
-    };
-    /**
-     * Shape of route class
-     */
-    export interface RouteContract {
-        /**
-         * A boolean to prevent route from getting registered within
-         * the [[Store]].
-         *
-         * This flag must be set before [[Router.commit]] method
-         */
-        deleted: boolean;
-        /**
-         * A unique name to lookup the route
-         */
-        name: string;
-        /**
-         * Define Regex 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 route matchers.
-         *
-         * ```
-         * Route.group(() => {
-         *   Route.get('/:id', 'handler').where('id', /^[0-9]$/)
-         * }).where('id', /[^a-z$]/)
-         * ```
-         *
-         * The `/^[0-9]$/` should win over the matcher defined by the group
-         */
-        where(param: string, matcher: RouteParamMatcher): this;
-        /**
-         * Define prefix for the route. Prefixes will be concated
-         * This method is mainly exposed for the [[RouteGroup]]
-         */
-        prefix(prefix: string): this;
-        /**
-         * Define a custom domain for the route. Again we do not overwrite the domain
-         * unless `overwrite` flag is set to true.
-         *
-         * This is again done to make route.domain win over route.group.domain
-         */
-        domain(domain: string): this;
-        /**
-         * Define an array of middleware to be executed on the route. If `prepend`
-         * is true, then middleware will be added to start of the existing
-         * middleware. The option is exposed for [[RouteGroup]]
-         */
-        middleware(middleware: RouteMiddlewareHandler | RouteMiddlewareHandler[], prepend?: boolean): this;
-        /**
-         * Give memorizable name to the route. This is helpful, when you
-         * want to lookup route defination by it's name.
-         *
-         * If `prepend` is true, then it will keep on prepending to the existing
-         * name. This option is exposed for [[RouteGroup]]
-         */
-        as(name: string, prepend?: boolean): this;
-        /**
-         * Define controller namespace for a given route
-         */
-        namespace(namespace: string): this;
-        /**
-         * Get the route pattern
-         */
-        getPattern(): string;
-        /**
-         * Update route pattern
-         */
-        setPattern(pattern: string): this;
-        /**
-         * Returns [[RouteDefinition]] that can be passed to the [[Store]] for
-         * registering the route
-         */
-        toJSON(): RouteJSON;
-    }
-    export type ResourceRouteNames = 'create' | 'index' | 'store' | 'show' | 'edit' | 'update' | 'destroy';
-    /**
-     * Shape of route resource class
-     */
-    export interface RouteResourceContract {
-        /**
-         * A copy of routes that belongs to this resource
-         */
-        routes: RouteContract[];
-        /**
-         * Register only given routes and remove others
-         */
-        only(names: ResourceRouteNames[]): this;
-        /**
-         * Register all routes, except the one's defined
-         */
-        except(names: ResourceRouteNames[]): this;
-        /**
-         * Register api only routes. The `create` and `edit` routes, which
-         * are meant to show forms will not be registered
-         */
-        apiOnly(): this;
-        /**
-         * Add middleware to routes inside the resource
-         */
-        middleware(middleware: {
-            [P in ResourceRouteNames]?: RouteMiddlewareHandler | RouteMiddlewareHandler[];
-        } & {
-            '*'?: RouteMiddlewareHandler | RouteMiddlewareHandler[];
-        }): this;
-        /**
-         * Define matcher for params inside the resource
-         */
-        where(key: string, matcher: RouteParamMatcher): this;
-        /**
-         * Define namespace for all the routes inside a given resource
-         */
-        namespace(namespace: string): this;
-        /**
-         * Set the param name for a given resource
-         */
-        paramFor(resource: string, param: string): this;
-        /**
-         * Prepend name to the routes names
-         */
-        as(name: string): this;
-    }
-    /**
-     * Shape of route group class
-     */
-    export interface RouteGroupContract {
-        routes: (RouteContract | RouteResourceContract | BriskRouteContract | RouteGroupContract)[];
-        /**
-         * 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[]): this;
-        /**
-         * Define namespace for all the routes inside the group.
-         *
-         * @example
-         * ```ts
-         * Route.group(() => {
-         * }).namespace('App/Admin/Controllers')
-         * ```
-         */
-        namespace(namespace: string): this;
-    }
-    /**
-     * Shape for brisk/quick routes
-     */
-    export interface BriskRouteContract {
-        /**
-         * Reference to route instance. Set after `setHandler` is called
-         */
-        route: RouteContract | null;
-        /**
-         * 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): RouteContract;
-        /**
-         * Redirect request to a fixed path
-         */
-        redirectToPath(url: string): RouteContract;
-        /**
-         * 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: any, invokedBy: string): RouteContract;
-    }
-    /**
-     * Options accepted by makeUrl methods
-     */
-    export type MakeUrlOptions = {
-        qs?: Record<string, any>;
-        domain?: string;
-        prefixUrl?: string;
-        disableRouteLookup?: boolean;
-    } & Record<string, any>;
-    /**
-     * Options for making a signed url
-     */
-    export type MakeSignedUrlOptions = MakeUrlOptions & {
-        expiresIn?: string | number;
-        purpose?: string;
-    };
-    /**
-     * Shape of router exposed for creating routes
-     */
-    export interface RouterContract extends LookupStoreContract {
-        /**
-         * Exposing BriskRoute, RouteGroup and RouteResource constructors
-         * to be extended from outside
-         */
-        BriskRoute: MacroableConstructorContract<BriskRouteContract>;
-        RouteGroup: MacroableConstructorContract<RouteGroupContract>;
-        RouteResource: MacroableConstructorContract<RouteResourceContract>;
-        Route: MacroableConstructorContract<RouteContract>;
-        RouteMatchers: MacroableConstructorContract<RouteMatchersContract>;
-        /**
-         * Collection of routes, including route resource and route
-         * group. To get a flat list of routes, call `router.toJSON()`
-         */
-        routes: (RouteContract | RouteResourceContract | RouteGroupContract | BriskRouteContract)[];
-        /**
-         * Add route for a given pattern and methods
-         */
-        route(pattern: string, methods: string[], handler: RouteHandler): RouteContract;
-        /**
-         * Define a route that handles all common HTTP methods
-         */
-        any(pattern: string, handler: RouteHandler): RouteContract;
-        /**
-         * Define `GET` route
-         */
-        get(pattern: string, handler: RouteHandler): RouteContract;
-        /**
-         * Define `POST` route
-         */
-        post(pattern: string, handler: RouteHandler): RouteContract;
-        /**
-         * Define `PUT` route
-         */
-        put(pattern: string, handler: RouteHandler): RouteContract;
-        /**
-         * Define `PATCH` route
-         */
-        patch(pattern: string, handler: RouteHandler): RouteContract;
-        /**
-         * Define `DELETE` route
-         */
-        delete(pattern: string, handler: RouteHandler): RouteContract;
-        /**
-         * Creates a group of routes. A route group can apply transforms
-         * to routes in bulk
-         */
-        group(callback: () => void): RouteGroupContract;
-        /**
-         * Registers a route resource with conventional set of routes
-         */
-        resource(resource: string, controller: string): RouteResourceContract;
-        /**
-         * Register a route resource with shallow nested routes.
-         */
-        shallowResource(resource: string, controller: string): RouteResourceContract;
-        /**
-         * Returns a brisk route instance for a given URL pattern
-         */
-        on(pattern: string): BriskRouteContract;
-        /**
-         * Define global route matcher
-         */
-        where(key: string, matcher: RouteParamMatcher): this;
-        /**
-         * Returns a flat list of routes JSON
-         */
-        toJSON(): {
-            [domain: string]: (RouteNode & {
-                methods: string[];
-            })[];
-        };
-        /**
-         * Commit routes to the store. After this, no more
-         * routes can be registered.
-         */
-        commit(): void;
-        /**
-         * Find route for a given URL, method and optionally domain
-         */
-        match(url: string, method: string, domain?: string): null | MatchedRoute;
-        /**
-         * Makes url to a registered route by looking it up with the route pattern,
-         * name or the controller.method
-         */
-        makeUrl(routeIdentifier: string, params?: any[] | MakeUrlOptions, options?: MakeUrlOptions): string;
-        /**
-         * Makes a signed url, which can be confirmed for it's integrity without
-         * relying on any sort of backend storage.
-         */
-        makeSignedUrl(routeIdentifier: string, params?: any[] | MakeSignedUrlOptions, options?: MakeSignedUrlOptions): string;
-        /**
-         * Shortcut methods for defining route param matchers
-         */
-        matchers: RouteMatchersContract;
-    }
-    /**
-     * Shortcut methods for commonly used route matchers
-     */
-    export interface RouteMatchersContract {
-        /**
-         * 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;
-        };
-    }
-    /**
-     * Lookup store allows making urls to a given route by performing
-     * lookup using its name, route handler or the route pattern
-     * directly
-     */
-    export interface LookupStoreContract {
-        /**
-         * 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;
-        /**
-         * Get the builder instance for the main domain
-         */
-        builder(): UrlBuilderContract;
-        /**
-         * Get the builder instance for a specific domain
-         */
-        builderForDomain(domainPattern: string): UrlBuilderContract;
-    }
-    /**
-     * Shape of the Url builder
-     */
-    export interface UrlBuilderContract {
-        /**
-         * Prefix a custom url to the final URI
-         */
-        params(params?: any[] | Record<string, any>): this;
-        /**
-         * Append query string to the final URI
-         */
-        qs(qs?: Record<string, any>): this;
-        /**
-         * Define required params to resolve the route
-         */
-        prefixUrl(url: string): this;
-        /**
-         * Generate url for the given route
-         */
-        make(identifier: string): string;
-        /**
-         * Disable route lookup and consider identifier
-         * as the route pattern
-         */
-        disableRouteLookup(): this;
-        /**
-         * Generate signed url for the given route
-         */
-        makeSigned(identifier: string, options?: {
-            expiresIn?: string | number;
-            purpose?: string;
-        }): string;
-    }
-    const Route: RouterContract;
-    export default Route;
-}

package/build/adonis-typings/route.js

@@ -1,8 +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.
- */

package/build/exceptions.json

@@ -1,110 +0,0 @@
-{
-    "E_CANNOT_LOOKUP_ROUTE": {
-        "message": "Cannot find route for \"{{ identifier }}\" identifier",
-        "code": "E_CANNOT_FIND_ROUTE",
-        "status": 500,
-        "help": [
-            "When making URL for a route. You can use one of the following identifiers",
-            "- The route name. Defined using `Route.as()`",
-            "- The route controller.method name. `PostsController.show`"
-        ]
-    },
-    "E_CANNOT_LOOKUP_DOMAIN": {
-        "message": "Cannot find routes for \"{{ domain }}\" domain",
-        "code": "E_CANNOT_FIND_ROUTE_DOMAIN",
-        "status": 500,
-        "help": [
-            "When making routes for a domain. Make sure",
-            "- You pass in the domain pattern and not the actual URL",
-            "- The domain pattern should be defined inside the routes file"
-        ]
-    },
-    "E_CANNOT_SERIALIZE_RESPONSE_BODY": {
-        "message": "Unable to send HTTP response. Cannot serialize \"{{ dataType }}\" to a string",
-        "code": "E_CANNOT_SERIALIZE_RESPONSE_BODY",
-        "status": 500,
-        "help": [
-            "AdonisJS can only send following data types as a response",
-            "- object, array, number, boolean, date, buffer and string",
-            "- For sending streams, you must use `response.stream` method",
-            "- For downloading files, you must use `response.download` method"
-        ]
-    },
-    "E_HTTP_EXCEPTION": {
-        "message": "Request aborted with status code {{ status }}",
-        "code": "E_HTTP_EXCEPTION",
-        "help": ["A generic exception usually raised using \"response.abort\""]
-    },
-    "E_CANNOT_DEFINE_GROUP_NAME": {
-        "message": "All the routes inside a group must have names before calling \"Route.group.as\"",
-        "code": "E_CANNOT_DEFINE_GROUP_NAME",
-        "status": 500,
-        "help": [
-            "`Route.group.as` adds a prefix to the route names and hence it cannot prefix a route with no initial name",
-            "To fix the issue, you must give name to all the routes inside a group"
-        ]
-    },
-    "E_DUPLICATE_ROUTE_NAME": {
-        "message": "Duplicate route name \"{{ name }}\"",
-        "code": "E_DUPLICATE_ROUTE_NAME",
-        "status": 500,
-        "help": [
-            "Names are assigned to the routes to identify them uniquely and hence a duplicate name is not allowed",
-            "Run `node ace list:routes` to find the route using this name"
-        ]
-    },
-    "E_DUPLICATE_ROUTE": {
-        "message": "Duplicate route \"{{ method }}:{{ pattern }}\"",
-        "code": "E_DUPLICATE_ROUTE",
-        "status": 500,
-        "help": [
-            "The route with the pattern is already registered",
-            "Double check your routes file or run `node ace list:routes`"
-        ]
-    },
-    "E_DUPLICATE_ROUTE_PARAM": {
-        "message": "The \"{{ param }}\" param is mentioned twice in the route pattern \"{{ pattern }}\"",
-        "code": "E_DUPLICATE_ROUTE_PARAM",
-        "status": 500
-    },
-    "E_ROUTE_NOT_FOUND": {
-        "message": "Cannot {{ method }}:{{ url }}",
-        "code": "E_ROUTE_NOT_FOUND",
-        "status": 404
-    },
-    "E_MISSING_NAMED_MIDDLEWARE": {
-        "message": "Cannot find a middleware named \"{{ name }}\"",
-        "code": "E_MISSING_NAMED_MIDDLEWARE",
-        "status": 500,
-        "help": [
-            "The named middleware are supposed to be registered inside `start/kernel` file first",
-            "Open the file and make sure middleware is defined inside `Server.middleware.registerNamed()` call"
-        ]
-    },
-    "E_CANNOT_MAKE_ROUTE_URL": {
-        "message": "\"{{ param }}\" param is required to make URL for \"{{ pattern }}\" route",
-        "code": "E_CANNOT_MAKE_ROUTE_URL",
-        "status": 500,
-        "help": [
-            "Make sure to define params object when using `Route.makeUrl` or the view help `route`."
-        ]
-    },
-    "E_INVALID_ALS_ACCESS": {
-        "message": "HTTP context is not available. Set \"useAsyncLocalStorage\" to true inside \"config/app.ts\" file",
-        "code": "E_INVALID_ALS_ACCESS",
-        "status": 500,
-        "help": [
-            "HttpContext.getOrFail method returns the HTTP context only when Async local storage is enabled",
-            "- Either, you must enable it insie the config/app.ts file",
-            "- Or remove the usage of HttpContext.getOrFail method"
-        ]
-    },
-    "E_INVALID_ALS_SCOPE": {
-        "message": "Http context is not available outside of an HTTP request",
-        "code": "E_INVALID_ALS_SCOPE",
-        "status": 500,
-        "help": [
-            "Make sure the code that attempts to access the HttpContext is running within the scope of an HTTP request"
-        ]
-    }
-}