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

package/build/src/exceptions.js

@@ -1,38 +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 { createError, Exception } from '@poppinss/utils';
-export const E_ROUTE_NOT_FOUND = createError('Cannot %s:%s', 'E_ROUTE_NOT_FOUND', 404);
-export const E_CANNOT_LOOKUP_ROUTE = createError('Cannot lookup route "%s"', 'E_CANNOT_LOOKUP_ROUTE', 500);
-export const E_HTTP_EXCEPTION = class HttpException extends Exception {
-    body;
-    static code = 'E_HTTP_EXCEPTION';
-    /**
-     * This method returns an instance of the exception class
-     */
-    static invoke(body, status, code = 'E_HTTP_EXCEPTION') {
-        if (body === null || body === undefined) {
-            const error = new this('HTTP Exception', { status, code });
-            error.body = 'Internal server error';
-            return error;
-        }
-        if (typeof body === 'object') {
-            const error = new this(body.message || 'HTTP Exception', { status, code });
-            error.body = body;
-            return error;
-        }
-        const error = new this(body, { status, code });
-        error.body = body;
-        return error;
-    }
-};
-export const E_HTTP_REQUEST_ABORTED = class AbortException extends E_HTTP_EXCEPTION {
-    handle(error, ctx) {
-        ctx.response.status(error.status).send(error.body);
-    }
-};

package/build/src/helpers.d.ts

@@ -1,23 +0,0 @@
-import { Route } from './router/route.js';
-import { BriskRoute } from './router/brisk.js';
-import { RouteGroup } from './router/group.js';
-import type { RouteJSON } from './types/route.js';
-import { RouteResource } from './router/resource.js';
-/**
- * Makes input string consistent by having only the starting
- * slash
- */
-export declare function dropSlash(input: string): string;
-/**
- * Returns a flat list of routes from the route groups and resources
- */
-export declare function toRoutesJSON(routes: (RouteGroup | Route | RouteResource | BriskRoute)[]): RouteJSON[];
-/**
- * Helper to know if the remote address should
- * be trusted.
- */
-export declare function trustProxy(remoteAddress: string, proxyFn: (addr: string, distance: number) => boolean): boolean;
-/**
- * Parses a range expression to an object filled with the range
- */
-export declare function parseRange<T>(range: string, value: T): Record<number, T>;

package/build/src/helpers.js

@@ -1,84 +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 Cache from 'tmp-cache';
-import { InvalidArgumentsException } from '@poppinss/utils';
-import { BriskRoute } from './router/brisk.js';
-import { RouteGroup } from './router/group.js';
-import { RouteResource } from './router/resource.js';
-const proxyCache = new Cache({ max: 200 });
-/**
- * Makes input string consistent by having only the starting
- * slash
- */
-export function dropSlash(input) {
-    if (input === '/') {
-        return '/';
-    }
-    return `/${input.replace(/^\//, '').replace(/\/$/, '')}`;
-}
-/**
- * Returns a flat list of routes from the route groups and resources
- */
-export function toRoutesJSON(routes) {
-    return routes.reduce((list, route) => {
-        if (route instanceof RouteGroup) {
-            list = list.concat(toRoutesJSON(route.routes));
-            return list;
-        }
-        if (route instanceof RouteResource) {
-            list = list.concat(toRoutesJSON(route.routes));
-            return list;
-        }
-        if (route instanceof BriskRoute) {
-            if (route.route && !route.route.isDeleted()) {
-                list.push(route.route.toJSON());
-            }
-            return list;
-        }
-        if (!route.isDeleted()) {
-            list.push(route.toJSON());
-        }
-        return list;
-    }, []);
-}
-/**
- * Helper to know if the remote address should
- * be trusted.
- */
-export function trustProxy(remoteAddress, proxyFn) {
-    if (proxyCache.has(remoteAddress)) {
-        return proxyCache.get(remoteAddress);
-    }
-    const result = proxyFn(remoteAddress, 0);
-    proxyCache.set(remoteAddress, result);
-    return result;
-}
-/**
- * Parses a range expression to an object filled with the range
- */
-export function parseRange(range, value) {
-    const parts = range.split('..');
-    const min = Number(parts[0]);
-    const max = Number(parts[1]);
-    if (Number.isNaN(min) || Number.isNaN(max)) {
-        return {};
-    }
-    if (min === max) {
-        return {
-            [min]: value,
-        };
-    }
-    if (max < min) {
-        throw new InvalidArgumentsException(`Invalid range "${range}"`);
-    }
-    return [...Array(max - min + 1).keys()].reduce((result, step) => {
-        result[min + step] = value;
-        return result;
-    }, {});
-}

package/build/src/http_context/local_storage.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { AsyncLocalStorage } from 'node:async_hooks';
-import type { HttpContext } from './main.js';
-/**
- * Async local storage for HTTP context
- */
-export declare const asyncLocalStorage: {
-    isEnabled: boolean;
-    storage: null | AsyncLocalStorage<HttpContext>;
-    create(): AsyncLocalStorage<HttpContext>;
-    destroy(): void;
-};

package/build/src/http_context/local_storage.js

@@ -1,39 +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 { AsyncLocalStorage } from 'node:async_hooks';
-/**
- * Async local storage for HTTP context
- */
-export const asyncLocalStorage = {
-    /**
-     * Check if the async local storage for the HTTP
-     * context is enabled or not
-     */
-    isEnabled: false,
-    /**
-     * HTTP context storage instance for the current scope
-     */
-    storage: null,
-    /**
-     * Create the storage instance. This method must be called only
-     * once.
-     */
-    create() {
-        this.isEnabled = true;
-        this.storage = new AsyncLocalStorage();
-        return this.storage;
-    },
-    /**
-     * Destroy the create storage instance
-     */
-    destroy() {
-        this.isEnabled = false;
-        this.storage = null;
-    },
-};

package/build/src/http_context/main.d.ts

@@ -1,58 +0,0 @@
-import Macroable from '@poppinss/macroable';
-import type { Logger } from '@adonisjs/logger';
-import { ContainerResolver } from '@adonisjs/fold';
-import type { Request } from '../request.js';
-import type { Response } from '../response.js';
-import type { StoreRouteNode } from '../types/route.js';
-/**
- * Http context encapsulates properties for a given HTTP request. The
- * context class can be extended using macros and getters.
- */
-export declare class HttpContext extends Macroable {
-    request: Request;
-    response: Response;
-    logger: Logger;
-    containerResolver: ContainerResolver<any>;
-    /**
-     * Find if async localstorage is enabled for HTTP requests
-     * or not
-     */
-    static get usingAsyncLocalStorage(): boolean;
-    /**
-     * Get access to the HTTP context. Available only when
-     * "usingAsyncLocalStorage" is true
-     */
-    static get(): HttpContext | null;
-    /**
-     * Get the HttpContext instance or raise an exception if not
-     * available
-     */
-    static getOrFail(): HttpContext;
-    /**
-     * Run a method that doesn't have access to HTTP context from
-     * the async local storage.
-     */
-    static runOutsideContext<T>(callback: (...args: any[]) => T, ...args: any[]): T;
-    /**
-     * Reference to the current route. Not available inside
-     * server middleware
-     */
-    route?: StoreRouteNode;
-    /**
-     * A unique key for the current route
-     */
-    routeKey?: string;
-    /**
-     * Route params
-     */
-    params: Record<string, any>;
-    /**
-     * Route subdomains
-     */
-    subdomains: Record<string, any>;
-    constructor(request: Request, response: Response, logger: Logger, containerResolver: ContainerResolver<any>);
-    /**
-     * A helper to see top level properties on the context object
-     */
-    inspect(): string;
-}

package/build/src/http_context/main.js

@@ -1,105 +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 { inspect } from 'node:util';
-import Macroable from '@poppinss/macroable';
-import { RuntimeException } from '@poppinss/utils';
-import { asyncLocalStorage } from './local_storage.js';
-/**
- * Http context encapsulates properties for a given HTTP request. The
- * context class can be extended using macros and getters.
- */
-export class HttpContext extends Macroable {
-    request;
-    response;
-    logger;
-    containerResolver;
-    /**
-     * Find if async localstorage is enabled for HTTP requests
-     * or not
-     */
-    static get usingAsyncLocalStorage() {
-        return asyncLocalStorage.isEnabled;
-    }
-    /**
-     * Get access to the HTTP context. Available only when
-     * "usingAsyncLocalStorage" is true
-     */
-    static get() {
-        if (!this.usingAsyncLocalStorage || !asyncLocalStorage.storage) {
-            return null;
-        }
-        return asyncLocalStorage.storage.getStore() || null;
-    }
-    /**
-     * Get the HttpContext instance or raise an exception if not
-     * available
-     */
-    static getOrFail() {
-        /**
-         * Localstorage is not enabled
-         */
-        if (!this.usingAsyncLocalStorage || !asyncLocalStorage.storage) {
-            throw new RuntimeException('HTTP context is not available. Enable "useAsyncLocalStorage" inside "config/app.ts" file');
-        }
-        const store = this.get();
-        if (!store) {
-            throw new RuntimeException('Http context is not available outside of an HTTP request');
-        }
-        return store;
-    }
-    /**
-     * Run a method that doesn't have access to HTTP context from
-     * the async local storage.
-     */
-    static runOutsideContext(callback, ...args) {
-        if (!asyncLocalStorage.storage) {
-            return callback(...args);
-        }
-        return asyncLocalStorage.storage.exit(callback, ...args);
-    }
-    /**
-     * Reference to the current route. Not available inside
-     * server middleware
-     */
-    route;
-    /**
-     * A unique key for the current route
-     */
-    routeKey;
-    /**
-     * Route params
-     */
-    params = {};
-    /**
-     * Route subdomains
-     */
-    subdomains = {};
-    constructor(request, response, logger, containerResolver) {
-        super();
-        this.request = request;
-        this.response = response;
-        this.logger = logger;
-        this.containerResolver = containerResolver;
-        /*
-         * 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;
-    }
-    /**
-     * A helper to see top level properties on the context object
-     */
-    /* c8 ignore next 3 */
-    inspect() {
-        return inspect(this, false, 1, true);
-    }
-}

package/build/src/qs.d.ts

@@ -1,11 +0,0 @@
-import { QSParserConfig } from './types/qs.js';
-/**
- * Query string parser used to parse and stringify query
- * strings.
- */
-export declare class Qs {
-    #private;
-    constructor(config: QSParserConfig);
-    parse(value: string): import("qs").ParsedQs;
-    stringify(value: any): string;
-}

package/build/src/qs.js

@@ -1,25 +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 { parse, stringify } from 'qs';
-/**
- * Query string parser used to parse and stringify query
- * strings.
- */
-export class Qs {
-    #config;
-    constructor(config) {
-        this.#config = config;
-    }
-    parse(value) {
-        return parse(value, this.#config.parse);
-    }
-    stringify(value) {
-        return stringify(value, this.#config.stringify);
-    }
-}

package/build/src/redirect.d.ts

@@ -1,42 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import type { IncomingMessage } from 'node:http';
-import type { Qs } from './qs.js';
-import type { Response } from './response.js';
-import type { Router } from './router/main.js';
-import type { MakeUrlOptions } from './types/route.js';
-/**
- * Exposes the API to construct redirect routes
- */
-export declare class Redirect {
-    #private;
-    constructor(request: IncomingMessage, response: Response, router: Router, qs: Qs);
-    /**
-     * 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[] | Record<string, any>, options?: MakeUrlOptions): void;
-    /**
-     * Redirect the request using a path.
-     */
-    toPath(url: string): void;
-}

package/build/src/redirect.js

@@ -1,140 +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 { parse } from 'node:url';
-import encodeUrl from 'encodeurl';
-import debug from './debug.js';
-/**
- * Exposes the API to construct redirect routes
- */
-export class Redirect {
-    /**
-     * A boolean to forward the existing query string
-     */
-    #forwardQueryString = false;
-    /**
-     * The status code for the redirect
-     */
-    #statusCode = 302;
-    /**
-     * A custom query string to forward
-     */
-    #queryString = {};
-    #request;
-    #response;
-    #router;
-    #qs;
-    constructor(request, response, router, qs) {
-        this.#request = request;
-        this.#response = response;
-        this.#router = router;
-        this.#qs = qs;
-    }
-    /**
-     * Sends response by setting require headers
-     */
-    #sendResponse(url, query) {
-        const stringified = this.#qs.stringify(query);
-        url = stringified ? `${url}?${stringified}` : url;
-        debug('redirecting to url "%s"', url);
-        this.#response.location(encodeUrl(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 referrerUrl = this.#getReferrerUrl();
-        const url = parse(referrerUrl);
-        debug('referrer url "%s"', referrerUrl);
-        debug('referrer base url "%s"', url.pathname);
-        /**
-         * Parse query string from the referrer url
-         */
-        if (this.#forwardQueryString) {
-            query = this.#qs.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 = this.#qs.parse(parse(this.#request.url).query || '');
-        }
-        /**
-         * Assign custom query string
-         */
-        Object.assign(query, this.#queryString);
-        /**
-         * Redirect
-         */
-        this.#sendResponse(url, query);
-    }
-}