@adonisjs/http-server 5.12.0 → 6.0.0-0

package/build/src/Router/LookupStore.js

@@ -1,264 +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.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LookupStore = exports.UrlBuilder = void 0;
-const qs_1 = __importDefault(require("qs"));
-const encodeurl_1 = __importDefault(require("encodeurl"));
-const RouterException_1 = require("../Exceptions/RouterException");
-/**
- * A class to encapsulate finding routes
- */
-class Routes {
-    constructor(routes) {
-        this.routes = routes;
-    }
-    /**
-     * Find a route by indentifier
-     */
-    find(routeIdentifier) {
-        return (this.routes.find(({ name, pattern, handler }) => {
-            return (name === routeIdentifier || pattern === routeIdentifier || handler === routeIdentifier);
-        }) || null);
-    }
-    /**
-     * Find a route by indentifier or fail
-     */
-    findOrFail(routeIdentifier) {
-        const route = this.find(routeIdentifier);
-        if (!route) {
-            throw RouterException_1.RouterException.cannotLookupRoute(routeIdentifier);
-        }
-        return route;
-    }
-    /**
-     * Find if a route exists
-     */
-    has(routeIdentifier) {
-        return !!this.find(routeIdentifier);
-    }
-}
-/**
- * Url builder is responsible for building the URLs
- */
-class UrlBuilder {
-    constructor(encryption, routes) {
-        this.encryption = encryption;
-        this.routes = routes;
-        /**
-         * A custom query string to append to the URL
-         */
-        this.queryString = {};
-        /**
-         * A boolean to know if the route should be looked
-         * up inside the route store or not
-         */
-        this.lookupRoute = true;
-    }
-    /**
-     * Processes the pattern against the params
-     */
-    processPattern(pattern) {
-        let url = [];
-        const isParamsAnArray = Array.isArray(this.routeParams);
-        /*
-         * Split pattern when route has dynamic segments
-         */
-        const tokens = pattern.split('/');
-        let paramsIndex = 0;
-        for (const token of tokens) {
-            /**
-             * Expected wildcard param to be at the end always and hence
-             * we must break out from the loop
-             */
-            if (token === '*') {
-                const wildcardParams = isParamsAnArray
-                    ? this.routeParams.slice(paramsIndex)
-                    : this.routeParams['*'];
-                if (!wildcardParams || !Array.isArray(wildcardParams) || !wildcardParams.length) {
-                    throw RouterException_1.RouterException.cannotMakeRoute('*', pattern);
-                }
-                url = url.concat(wildcardParams);
-                break;
-            }
-            /**
-             * Token is a static value
-             */
-            if (!token.startsWith(':')) {
-                url.push(token);
-            }
-            else {
-                const isOptional = token.endsWith('?');
-                const paramName = token.replace(/^:/, '').replace(/\?$/, '');
-                const param = isParamsAnArray ? this.routeParams[paramsIndex] : this.routeParams[paramName];
-                paramsIndex++;
-                /*
-                 * A required param is always required to make the complete URL
-                 */
-                if (!param && !isOptional) {
-                    throw RouterException_1.RouterException.cannotMakeRoute(paramName, pattern);
-                }
-                url.push(param);
-            }
-        }
-        return url.join('/');
-    }
-    /**
-     * Suffix the query string to the URL
-     */
-    suffixQueryString(url) {
-        if (this.queryString) {
-            const encoded = qs_1.default.stringify(this.queryString);
-            url = encoded ? `${url}?${(0, encodeurl_1.default)(encoded)}` : url;
-        }
-        return url;
-    }
-    /**
-     * Prefix a custom url to the final URI
-     */
-    prefixUrl(url) {
-        this.baseUrl = url;
-        return this;
-    }
-    /**
-     * Disable route lookup. Calling this method considers
-     * the "identifier" as the route pattern
-     */
-    disableRouteLookup() {
-        this.lookupRoute = false;
-        return this;
-    }
-    /**
-     * Append query string to the final URI
-     */
-    qs(queryString) {
-        if (!queryString) {
-            return this;
-        }
-        this.queryString = queryString;
-        return this;
-    }
-    /**
-     * Define required params to resolve the route
-     */
-    params(params) {
-        if (!params) {
-            return this;
-        }
-        this.routeParams = params;
-        return this;
-    }
-    /**
-     * Generate url for the given route identifier
-     */
-    make(identifier) {
-        let url;
-        if (this.lookupRoute) {
-            const route = this.routes.findOrFail(identifier);
-            url = this.processPattern(route.pattern);
-        }
-        else {
-            url = this.processPattern(identifier);
-        }
-        return this.suffixQueryString(this.baseUrl ? `${this.baseUrl}${url}` : url);
-    }
-    /**
-     * Generate url for the given route identifier
-     */
-    makeSigned(identifier, options) {
-        let url;
-        if (this.lookupRoute) {
-            const route = this.routes.findOrFail(identifier);
-            url = this.processPattern(route.pattern);
-        }
-        else {
-            url = this.processPattern(identifier);
-        }
-        /*
-         * Making the signature from the qualified url. We do not prefix the domain when
-         * making signature, since it just makes the signature big.
-         *
-         * There might be a case, when someone wants to generate signature for the same route
-         * on their 2 different domains, but we ignore that case for now and can consider
-         * it later (when someone asks for it)
-         */
-        const signature = this.encryption.verifier.sign(this.suffixQueryString(url), options?.expiresIn, options?.purpose);
-        /*
-         * Adding signature to the query string and re-making the url again
-         */
-        Object.assign(this.queryString, { signature });
-        return this.suffixQueryString(this.baseUrl ? `${this.baseUrl}${url}` : url);
-    }
-}
-exports.UrlBuilder = UrlBuilder;
-/**
- * The look up store to make URLs for a given route by looking
- * it by its name, route handler or the pattern directly.
- */
-class LookupStore {
-    constructor(encryption) {
-        this.encryption = encryption;
-        /**
-         * Shape of the registered routes. Optimized for lookups
-         */
-        this.tree = {};
-    }
-    /**
-     * Register a route for lookups
-     */
-    register(route) {
-        const domain = route.domain || 'root';
-        this.tree[domain] = this.tree[domain] || [];
-        this.tree[domain].push(route);
-    }
-    /**
-     * Returns the route builder for the root domain
-     */
-    builder() {
-        return this.builderForDomain('root');
-    }
-    /**
-     * Returns the route builder a given domain.
-     */
-    builderForDomain(domainPattern) {
-        const domainRoutes = this.tree[domainPattern];
-        if (!domainRoutes && domainPattern !== 'root') {
-            throw RouterException_1.RouterException.cannotLookupDomain(domainPattern);
-        }
-        return new UrlBuilder(this.encryption, new Routes(domainRoutes || []));
-    }
-    /**
-     * Find a route by indentifier. Optionally one can find routes inside
-     * a given domain
-     */
-    find(routeIdentifier, domainPattern) {
-        const routes = this.tree[domainPattern || 'root'] || [];
-        return new Routes(routes || []).find(routeIdentifier);
-    }
-    /**
-     * Find a route by indentifier or fail. Optionally one can find routes inside
-     * a given domain
-     */
-    findOrFail(routeIdentifier, domainPattern) {
-        const routes = this.tree[domainPattern || 'root'] || [];
-        return new Routes(routes || []).findOrFail(routeIdentifier);
-    }
-    /**
-     * Find if a route for given identifier exists. Optionally one can find routes inside
-     * a given domain
-     */
-    has(routeIdentifier, domainPattern) {
-        const routes = this.tree[domainPattern || 'root'] || [];
-        return new Routes(routes || []).has(routeIdentifier);
-    }
-}
-exports.LookupStore = LookupStore;

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

@@ -1,31 +0,0 @@
-/// <reference path="../../adonis-typings/index.d.ts" />
-import { Macroable } from 'macroable';
-import { RouteMatchersContract } from '@ioc:Adonis/Core/Route';
-/**
- * Shortcut methods for commonly used route matchers
- */
-export declare class RouteMatchers extends Macroable implements RouteMatchersContract {
-    protected static macros: {};
-    protected static getters: {};
-    /**
-     * 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,43 +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.RouteMatchers = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const macroable_1 = require("macroable");
-/**
- * Shortcut methods for commonly used route matchers
- */
-class RouteMatchers extends macroable_1.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]$/ };
-    }
-}
-exports.RouteMatchers = RouteMatchers;
-RouteMatchers.macros = {};
-RouteMatchers.getters = {};

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

@@ -1,95 +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 { RouteParamMatcher, ResourceRouteNames, RouteMatchersNode, RouteResourceContract, RouteMiddlewareHandler } from '@ioc:Adonis/Core/Route';
-import { Route } from './Route';
-/**
- * Resource route helps in defining multiple conventional routes. The support
- * for shallow routes makes it super easy to avoid deeply nested routes.
- * Learn more http://weblog.jamisbuck.org/2007/2/5/nesting-resources.
- *
- * @example
- * ```ts
- * const resource = new RouteResource('articles', 'ArticlesController')
- * ```
- */
-export declare class RouteResource extends Macroable implements RouteResourceContract {
-    private resource;
-    private controller;
-    private globalMatchers;
-    private shallow;
-    protected static macros: {};
-    protected static getters: {};
-    /**
-     * The param names used to create the resource URLs.
-     *
-     * We need these later when someone explicitly wants to remap
-     * param name for a given resource using the "paramFor" method.
-     */
-    private resourceParamNames;
-    /**
-     * A copy of routes that belongs to this resource
-     */
-    routes: Route[];
-    /**
-     * Resource name
-     */
-    private resourceName;
-    constructor(resource: string, controller: string, globalMatchers: RouteMatchersNode, shallow?: boolean);
-    /**
-     * Add a new route for the given pattern, methods and controller action
-     */
-    private makeRoute;
-    /**
-     * Build routes for the given resource
-     */
-    private buildRoutes;
-    /**
-     * Filter the routes based on their partial names
-     */
-    private filter;
-    /**
-     * 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;
-}

package/build/src/Router/Resource.js

@@ -1,182 +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.RouteResource = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const pluralize_1 = require("pluralize");
-const macroable_1 = require("macroable");
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const Route_1 = require("./Route");
-/**
- * Resource route helps in defining multiple conventional routes. The support
- * for shallow routes makes it super easy to avoid deeply nested routes.
- * Learn more http://weblog.jamisbuck.org/2007/2/5/nesting-resources.
- *
- * @example
- * ```ts
- * const resource = new RouteResource('articles', 'ArticlesController')
- * ```
- */
-class RouteResource extends macroable_1.Macroable {
-    constructor(resource, controller, globalMatchers, shallow = false) {
-        super();
-        this.resource = resource;
-        this.controller = controller;
-        this.globalMatchers = globalMatchers;
-        this.shallow = shallow;
-        /**
-         * The param names used to create the resource URLs.
-         *
-         * We need these later when someone explicitly wants to remap
-         * param name for a given resource using the "paramFor" method.
-         */
-        this.resourceParamNames = {};
-        /**
-         * A copy of routes that belongs to this resource
-         */
-        this.routes = [];
-        /**
-         * Resource name
-         */
-        this.resourceName = this.resource
-            .split('.')
-            .map((token) => helpers_1.string.snakeCase(token))
-            .join('.');
-        this.buildRoutes();
-    }
-    /**
-     * Add a new route for the given pattern, methods and controller action
-     */
-    makeRoute(pattern, methods, action) {
-        const route = new Route_1.Route(pattern, methods, `${this.controller}.${action}`, this.globalMatchers);
-        route.as(`${this.resourceName}.${action}`);
-        this.routes.push(route);
-    }
-    /**
-     * Build routes for the given resource
-     */
-    buildRoutes() {
-        this.resource = this.resource.replace(/^\//, '').replace(/\/$/, '');
-        const resourceTokens = this.resource.split('.');
-        const mainResource = resourceTokens.pop();
-        /**
-         * The main resource always uses ids
-         */
-        this.resourceParamNames[mainResource] = ':id';
-        const fullUrl = `${resourceTokens
-            .map((token) => {
-            const paramName = `:${helpers_1.string.snakeCase((0, pluralize_1.singular)(token))}_id`;
-            this.resourceParamNames[token] = paramName;
-            return `${token}/${paramName}`;
-        })
-            .join('/')}/${mainResource}`;
-        this.makeRoute(fullUrl, ['GET', 'HEAD'], 'index');
-        this.makeRoute(`${fullUrl}/create`, ['GET', 'HEAD'], 'create');
-        this.makeRoute(fullUrl, ['POST'], 'store');
-        this.makeRoute(`${this.shallow ? mainResource : fullUrl}/:id`, ['GET', 'HEAD'], 'show');
-        this.makeRoute(`${this.shallow ? mainResource : fullUrl}/:id/edit`, ['GET', 'HEAD'], 'edit');
-        this.makeRoute(`${this.shallow ? mainResource : fullUrl}/:id`, ['PUT', 'PATCH'], 'update');
-        this.makeRoute(`${this.shallow ? mainResource : fullUrl}/:id`, ['DELETE'], 'destroy');
-    }
-    /**
-     * Filter the routes based on their partial names
-     */
-    filter(names, inverse) {
-        return this.routes.filter((route) => {
-            const match = names.find((name) => route.name.endsWith(name));
-            return inverse ? !match : match;
-        });
-    }
-    /**
-     * Register only given routes and remove others
-     */
-    only(names) {
-        this.filter(names, true).forEach((route) => (route.deleted = true));
-        return this;
-    }
-    /**
-     * Register all routes, except the one's defined
-     */
-    except(names) {
-        this.filter(names, false).forEach((route) => (route.deleted = true));
-        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']);
-    }
-    /**
-     * Add middleware to routes inside the resource
-     */
-    middleware(middleware) {
-        for (let name in middleware) {
-            if (name === '*') {
-                this.routes.forEach((one) => one.middleware(middleware[name]));
-            }
-            else {
-                const route = this.routes.find((one) => one.name.endsWith(name));
-                /* istanbul ignore else */
-                if (route) {
-                    route.middleware(middleware[name]);
-                }
-            }
-        }
-        return this;
-    }
-    /**
-     * Define matcher for params inside the resource
-     */
-    where(key, matcher) {
-        this.routes.forEach((route) => {
-            route.where(key, matcher);
-        });
-        return this;
-    }
-    /**
-     * Define namespace for all the routes inside a given resource
-     */
-    namespace(namespace) {
-        this.routes.forEach((route) => {
-            route.namespace(namespace);
-        });
-        return this;
-    }
-    /**
-     * Set the param name for a given resource
-     */
-    paramFor(resource, param) {
-        const existingParam = this.resourceParamNames[resource];
-        this.resourceParamNames[resource] = `:${param}`;
-        this.routes.forEach((route) => {
-            /**
-             * Update the pattern for the route with the new param name
-             */
-            route.setPattern(route.getPattern().replace(`${resource}/${existingParam}`, `${resource}/:${param}`));
-        });
-        return this;
-    }
-    /**
-     * Prepend name to the routes names
-     */
-    as(name) {
-        name = helpers_1.string.snakeCase(name);
-        this.routes.forEach((route) => {
-            route.as(route.name.replace(this.resourceName, name), false);
-        });
-        this.resourceName = name;
-        return this;
-    }
-}
-exports.RouteResource = RouteResource;
-RouteResource.macros = {};
-RouteResource.getters = {};