@adonisjs/http-server 5.12.0 → 6.0.1-0

package/build/src/HttpContext/index.js

@@ -1,181 +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.HttpContext = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const net_1 = require("net");
-const util_1 = require("util");
-const macroable_1 = require("macroable");
-const matchit_1 = __importDefault(require("@poppinss/matchit"));
-const utils_1 = require("@poppinss/utils");
-const http_1 = require("http");
-const Request_1 = require("../Request");
-const Response_1 = require("../Response");
-const helpers_1 = require("../helpers");
-const LocalStorage_1 = require("./LocalStorage");
-const exceptions_json_1 = require("../../exceptions.json");
-/**
- * Http context is passed to all route handlers, middleware,
- * error handler and server hooks.
- */
-class HttpContext extends macroable_1.Macroable {
-    constructor(request, response, logger, profiler) {
-        super();
-        this.request = request;
-        this.response = response;
-        this.logger = logger;
-        this.profiler = profiler;
-        /**
-         * Route params
-         */
-        this.params = {};
-        /**
-         * Route subdomains
-         */
-        this.subdomains = {};
-        /*
-         * Creating the circular reference. We do this, since request and response
-         * are meant to be extended and at times people would want to access
-         * other ctx properties like `logger`, `profiler` inside those
-         * extended methods.
-         */
-        this.request.ctx = this;
-        this.response.ctx = this;
-    }
-    /**
-     * Find if async localstorage is enabled for HTTP requests
-     * or not
-     */
-    static get usingAsyncLocalStorage() {
-        return LocalStorage_1.usingAsyncLocalStorage;
-    }
-    /**
-     * Get access to the HTTP context. Available only when
-     * "usingAsyncLocalStorage" is true
-     */
-    static get() {
-        if (!LocalStorage_1.usingAsyncLocalStorage) {
-            return null;
-        }
-        return LocalStorage_1.httpContextLocalStorage.getStore() || null;
-    }
-    /**
-     * Get the HttpContext instance or raise an exception if not
-     * available
-     */
-    static getOrFail() {
-        /**
-         * Localstorage is not enabled
-         */
-        if (!LocalStorage_1.usingAsyncLocalStorage) {
-            const error = new utils_1.Exception(exceptions_json_1.E_INVALID_ALS_ACCESS.message, exceptions_json_1.E_INVALID_ALS_ACCESS.status, exceptions_json_1.E_INVALID_ALS_ACCESS.code);
-            error.help = exceptions_json_1.E_INVALID_ALS_ACCESS.help.join('\n');
-            throw error;
-        }
-        const store = this.get();
-        /**
-         * Store is not accessible
-         */
-        if (!store) {
-            const error = new utils_1.Exception(exceptions_json_1.E_INVALID_ALS_SCOPE.message, exceptions_json_1.E_INVALID_ALS_SCOPE.status, exceptions_json_1.E_INVALID_ALS_SCOPE.code);
-            error.help = exceptions_json_1.E_INVALID_ALS_SCOPE.help.join('\n');
-            throw error;
-        }
-        return store;
-    }
-    /**
-     * Run a method that doesn't have access to HTTP context from
-     * the async local storage.
-     */
-    static runOutsideContext(callback, ...args) {
-        return LocalStorage_1.httpContextLocalStorage.exit(callback, ...args);
-    }
-    /**
-     * A helper to see top level properties on the context object
-     */
-    inspect() {
-        return (0, util_1.inspect)(this, false, 1, true);
-    }
-    /**
-     * Creates a new fake context instance for a given route. The method is
-     * meant to be used inside an AdonisJS application since it relies
-     * directly on the IoC container.
-     */
-    static create(routePattern, routeParams, req, res) {
-        const Router = HttpContext.app.container.resolveBinding('Adonis/Core/Route');
-        const Encryption = HttpContext.app.container.resolveBinding('Adonis/Core/Encryption');
-        const serverConfig = HttpContext.app.container
-            .resolveBinding('Adonis/Core/Config')
-            .get('app.http', {});
-        req = req || new http_1.IncomingMessage(new net_1.Socket());
-        res = res || new http_1.ServerResponse(req);
-        /*
-         * Creating the url from the router pattern and params. Only
-         * when actual URL isn't defined.
-         */
-        req.url = req.url || (0, helpers_1.processPattern)(routePattern, routeParams);
-        /*
-         * Creating new request instance
-         */
-        const request = new Request_1.Request(req, res, Encryption, {
-            allowMethodSpoofing: serverConfig.allowMethodSpoofing,
-            subdomainOffset: serverConfig.subdomainOffset,
-            trustProxy: serverConfig.trustProxy,
-            generateRequestId: serverConfig.generateRequestId,
-        });
-        /*
-         * Creating new response instance
-         */
-        const response = new Response_1.Response(req, res, Encryption, {
-            etag: serverConfig.etag,
-            cookie: serverConfig.cookie,
-            jsonpCallbackName: serverConfig.jsonpCallbackName,
-        }, Router);
-        /*
-         * Creating new ctx instance
-         */
-        const ctx = new HttpContext(request, response, this.app.logger.child({}), this.app.profiler.create('http:context'));
-        /*
-         * Attaching route to the ctx
-         */
-        ctx.route = {
-            pattern: routePattern,
-            middleware: [],
-            handler: async () => 'handled',
-            meta: {},
-            params: matchit_1.default
-                .parse(routePattern, {})
-                .filter((token) => [1, 3].includes(token.type))
-                .map((token) => token.val),
-        };
-        /*
-         * Defining route key
-         */
-        ctx.routeKey = `${request.method() || 'GET'}-${ctx.route.pattern}`;
-        /*
-         * Attaching params to the ctx
-         */
-        ctx.params = routeParams;
-        /**
-         * Set params on the request
-         */
-        ctx.request.updateParams(routeParams);
-        return ctx;
-    }
-}
-exports.HttpContext = HttpContext;
-/**
- * Required by macroable
- */
-HttpContext.macros = {};
-HttpContext.getters = {};

package/build/src/MiddlewareStore/index.d.ts

@@ -1,92 +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 { IocContract } from '@adonisjs/fold';
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { MiddlewareHandler, MiddlewareStoreContract, ResolvedMiddlewareHandler } from '@ioc:Adonis/Core/Middleware';
-/**
- * Middleware store register and keep all the application middleware at one
- * place. Also middleware are resolved during the registration and any
- * part of the application can read them without extra overhead.
- *
- * @example
- * ```ts
- * const store = new MiddlewareStore()
- *
- * store.register([
- *   'App/Middleware/Auth'
- * ])
- *
- * store.registerNamed({
- *   auth: 'App/Middleware/Auth'
- * })
- *
- * store.get()
- * ```
- */
-export declare class MiddlewareStore implements MiddlewareStoreContract {
-    private container;
-    /**
-     * A list of global middleware
-     */
-    private list;
-    /**
-     * A map of named middleware. Named middleware are used as reference
-     * on the routes
-     */
-    private named;
-    /**
-     * The resolver to resolve middleware from the IoC container
-     */
-    private resolver;
-    constructor(container: IocContract);
-    /**
-     * Resolves the middleware node based upon it's type. If value is a string, then
-     * we pre-fetch it from the IoC container upfront. On every request, we just
-     * create a new instance of the class and avoid re-fetching it from the IoC
-     * container for performance reasons.
-     *
-     * The annoying part is that one has to create the middleware before registering
-     * it, otherwise an exception will be raised.
-     */
-    private resolveMiddleware;
-    /**
-     * Register an array of global middleware. These middleware are read
-     * by HTTP server and executed on every request
-     */
-    register(middleware: MiddlewareHandler[]): this;
-    /**
-     * Register named middleware that can be referenced later on routes
-     */
-    registerNamed(middleware: {
-        [alias: string]: MiddlewareHandler;
-    }): this;
-    /**
-     * Return all middleware registered using [[MiddlewareStore.register]]
-     * method
-     */
-    get(): ResolvedMiddlewareHandler[];
-    /**
-     * Returns a single middleware by it's name registered
-     * using [[MiddlewareStore.registerNamed]] method.
-     */
-    getNamed(name: string): null | ResolvedMiddlewareHandler;
-    /**
-     * Clears all the global middleware
-     */
-    clear(): void;
-    /**
-     * Clears all/selected named middleware
-     */
-    clearNamed(names?: string[]): void;
-    /**
-     * Invokes a resolved middleware.
-     */
-    invokeMiddleware(middleware: ResolvedMiddlewareHandler, params: [HttpContextContract, () => Promise<void>]): Promise<void>;
-}

package/build/src/MiddlewareStore/index.js

@@ -1,133 +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.MiddlewareStore = void 0;
-/**
- * Middleware store register and keep all the application middleware at one
- * place. Also middleware are resolved during the registration and any
- * part of the application can read them without extra overhead.
- *
- * @example
- * ```ts
- * const store = new MiddlewareStore()
- *
- * store.register([
- *   'App/Middleware/Auth'
- * ])
- *
- * store.registerNamed({
- *   auth: 'App/Middleware/Auth'
- * })
- *
- * store.get()
- * ```
- */
-class MiddlewareStore {
-    constructor(container) {
-        this.container = container;
-        /**
-         * A list of global middleware
-         */
-        this.list = [];
-        /**
-         * A map of named middleware. Named middleware are used as reference
-         * on the routes
-         */
-        this.named = {};
-        this.resolver = container.getResolver();
-    }
-    /**
-     * Resolves the middleware node based upon it's type. If value is a string, then
-     * we pre-fetch it from the IoC container upfront. On every request, we just
-     * create a new instance of the class and avoid re-fetching it from the IoC
-     * container for performance reasons.
-     *
-     * The annoying part is that one has to create the middleware before registering
-     * it, otherwise an exception will be raised.
-     */
-    resolveMiddleware(middleware) {
-        return typeof middleware === 'function'
-            ? {
-                type: 'lazy-import',
-                value: middleware,
-                args: [],
-            }
-            : Object.assign(this.resolver.resolve(`${middleware}.handle`), { args: [] });
-    }
-    /**
-     * Register an array of global middleware. These middleware are read
-     * by HTTP server and executed on every request
-     */
-    register(middleware) {
-        this.list = middleware.map(this.resolveMiddleware.bind(this));
-        return this;
-    }
-    /**
-     * Register named middleware that can be referenced later on routes
-     */
-    registerNamed(middleware) {
-        this.named = Object.keys(middleware).reduce((result, alias) => {
-            result[alias] = this.resolveMiddleware(middleware[alias]);
-            return result;
-        }, {});
-        return this;
-    }
-    /**
-     * Return all middleware registered using [[MiddlewareStore.register]]
-     * method
-     */
-    get() {
-        return this.list;
-    }
-    /**
-     * Returns a single middleware by it's name registered
-     * using [[MiddlewareStore.registerNamed]] method.
-     */
-    getNamed(name) {
-        return this.named[name] || null;
-    }
-    /**
-     * Clears all the global middleware
-     */
-    clear() {
-        this.list = [];
-    }
-    /**
-     * Clears all/selected named middleware
-     */
-    clearNamed(names) {
-        if (names) {
-            names.forEach((name) => delete this.named[name]);
-        }
-        else {
-            this.named = {};
-        }
-    }
-    /**
-     * Invokes a resolved middleware.
-     */
-    async invokeMiddleware(middleware, params) {
-        if (middleware.type === 'function') {
-            return middleware.value(params[0], params[1], middleware.args);
-        }
-        const args = [params[0], params[1]];
-        args.push(middleware.args);
-        /**
-         * Handling the lazily imported middleware
-         */
-        if (middleware.type === 'lazy-import') {
-            const middlewareClass = await middleware.value();
-            const middlewareInstance = await this.container.makeAsync(middlewareClass.default);
-            return this.container.callAsync(middlewareInstance, 'handle', args);
-        }
-        return this.resolver.call(middleware, undefined, args);
-    }
-}
-exports.MiddlewareStore = MiddlewareStore;

package/build/src/Redirect/index.d.ts

@@ -1,71 +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" />
-/// <reference types="node" />
-import { IncomingMessage } from 'http';
-import { RouterContract, MakeUrlOptions } from '@ioc:Adonis/Core/Route';
-import { RedirectContract, ResponseContract } from '@ioc:Adonis/Core/Response';
-/**
- * Exposes the API to construct redirect routes
- */
-export declare class Redirect implements RedirectContract {
-    private request;
-    private response;
-    private router;
-    /**
-     * A boolean to forward the existing query string
-     */
-    private forwardQueryString;
-    /**
-     * The status code for the redirect
-     */
-    private statusCode;
-    /**
-     * A custom query string to forward
-     */
-    private queryString;
-    constructor(request: IncomingMessage, response: ResponseContract, router: RouterContract);
-    /**
-     * Sends response by setting require headers
-     */
-    private sendResponse;
-    /**
-     * Returns the referrer url
-     */
-    private getReferrerUrl;
-    /**
-     * Set a custom status code.
-     */
-    status(statusCode: number): this;
-    /**
-     * Clearing query string values added using the
-     * "withQs" method
-     */
-    clearQs(): this;
-    /**
-     * Define query string for the redirect. Not passing
-     * any value will forward the current request query
-     * string.
-     */
-    withQs(): this;
-    withQs(values: Record<string, any>): this;
-    withQs(name: string, value: any): this;
-    /**
-     * Redirect to the previous path.
-     */
-    back(): void;
-    /**
-     * Redirect the request using a route identifier.
-     */
-    toRoute(routeIdentifier: string, params?: any[] | MakeUrlOptions, options?: MakeUrlOptions): void;
-    /**
-     * Redirect the request using a path.
-     */
-    toPath(url: string): void;
-}

package/build/src/Redirect/index.js

@@ -1,139 +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.Redirect = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const qs_1 = __importDefault(require("qs"));
-const url_1 = require("url");
-const encodeurl_1 = __importDefault(require("encodeurl"));
-/**
- * Exposes the API to construct redirect routes
- */
-class Redirect {
-    constructor(request, response, router) {
-        this.request = request;
-        this.response = response;
-        this.router = router;
-        /**
-         * A boolean to forward the existing query string
-         */
-        this.forwardQueryString = false;
-        /**
-         * The status code for the redirect
-         */
-        this.statusCode = 302;
-        /**
-         * A custom query string to forward
-         */
-        this.queryString = {};
-    }
-    /**
-     * Sends response by setting require headers
-     */
-    sendResponse(url, query) {
-        const stringified = qs_1.default.stringify(query);
-        url = stringified ? `${url}?${stringified}` : url;
-        this.response.location((0, encodeurl_1.default)(url));
-        this.response.safeStatus(this.statusCode);
-        this.response.type('text/plain; charset=utf-8');
-        this.response.send(`Redirecting to ${url}`);
-    }
-    /**
-     * Returns the referrer url
-     */
-    getReferrerUrl() {
-        let url = this.request.headers['referer'] || this.request.headers['referrer'] || '/';
-        return Array.isArray(url) ? url[0] : url;
-    }
-    /**
-     * Set a custom status code.
-     */
-    status(statusCode) {
-        this.statusCode = statusCode;
-        return this;
-    }
-    /**
-     * Clearing query string values added using the
-     * "withQs" method
-     */
-    clearQs() {
-        this.forwardQueryString = false;
-        this.queryString = {};
-        return this;
-    }
-    withQs(name, value) {
-        if (typeof name === 'undefined') {
-            this.forwardQueryString = true;
-            return this;
-        }
-        if (typeof name === 'string') {
-            this.queryString[name] = value;
-            return this;
-        }
-        Object.assign(this.queryString, name);
-        return this;
-    }
-    /**
-     * Redirect to the previous path.
-     */
-    back() {
-        let query = {};
-        const url = (0, url_1.parse)(this.getReferrerUrl());
-        /**
-         * Parse query string from the referrer url
-         */
-        if (this.forwardQueryString) {
-            query = qs_1.default.parse(url.query || '');
-        }
-        /**
-         * Append custom query string
-         */
-        Object.assign(query, this.queryString);
-        /**
-         * Redirect
-         */
-        this.sendResponse(url.pathname || '', query);
-    }
-    /**
-     * Redirect the request using a route identifier.
-     */
-    toRoute(routeIdentifier, params, options) {
-        if (options && options.qs) {
-            this.withQs(options.qs);
-            options.qs = undefined;
-        }
-        const url = this.router.makeUrl(routeIdentifier, params, options);
-        return this.toPath(url);
-    }
-    /**
-     * Redirect the request using a path.
-     */
-    toPath(url) {
-        let query = {};
-        /**
-         * Extract query string from the current URL
-         */
-        if (this.forwardQueryString) {
-            query = qs_1.default.parse((0, url_1.parse)(this.request.url).query || '');
-        }
-        /**
-         * Assign custom query string
-         */
-        Object.assign(query, this.queryString);
-        /**
-         * Redirect
-         */
-        this.sendResponse(url, query);
-    }
-}
-exports.Redirect = Redirect;