@adonisjs/http-server 5.12.0 → 6.0.1-0

package/build/src/Cookie/Parser/index.js

@@ -1,174 +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.CookieParser = void 0;
-const cookie_1 = __importDefault(require("cookie"));
-const Client_1 = require("../Client");
-/**
- * Cookie parser parses the HTTP `cookie` header and collects all cookies
- * inside an object of `key-value` pair, but doesn't attempt to decrypt
- * or unsign or decode the individual values.
- *
- * The cookie values are lazily decrypted, or unsigned to avoid unncessary
- * processing, which infact can be used as a means to burden the server
- * by sending too many cookies which even doesn't belongs to the
- * server.
- */
-class CookieParser {
-    constructor(cookieHeader, encryption) {
-        this.cookieHeader = cookieHeader;
-        this.encryption = encryption;
-        this.client = new Client_1.CookieClient(this.encryption);
-        /**
-         * A copy of cached cookies, they are cached during a request after
-         * initial decoding, unsigning or decrypting.
-         */
-        this.cachedCookies = {
-            signedCookies: {},
-            plainCookies: {},
-            encryptedCookies: {},
-        };
-        /**
-         * An object of key-value pair collected by parsing
-         * the request cookie header.
-         */
-        this.cookies = this.parse();
-    }
-    /**
-     * Parses the request `cookie` header
-     */
-    parse() {
-        /*
-         * Set to empty object when cookie header is empty string
-         */
-        if (!this.cookieHeader) {
-            return {};
-        }
-        /*
-         * Parse and store reference
-         */
-        return cookie_1.default.parse(this.cookieHeader);
-    }
-    /**
-     * Attempts to decode a cookie by the name. When calling this method,
-     * you are assuming that the cookie was just encoded at the first
-     * place and not signed or encrypted.
-     */
-    decode(key, encoded = true) {
-        /*
-         * Ignore when initial value is not defined or null
-         */
-        const value = this.cookies[key];
-        if (value === null || value === undefined) {
-            return null;
-        }
-        /*
-         * Reference to the cache object. Mainly done to avoid typos,
-         * since this object is referenced a handful of times inside
-         * this method.
-         */
-        const cacheObject = this.cachedCookies.plainCookies;
-        /*
-         * Return from cache, when already parsed
-         */
-        if (cacheObject[key] !== undefined) {
-            return cacheObject[key];
-        }
-        /*
-         * Attempt to unpack and cache it for future. The value is only
-         * when value it is not null.
-         */
-        const parsed = encoded ? this.client.decode(key, value) : value;
-        if (parsed !== null) {
-            cacheObject[key] = parsed;
-        }
-        return parsed;
-    }
-    /**
-     * Attempts to unsign a cookie by the name. When calling this method,
-     * you are assuming that the cookie was signed at the first place.
-     */
-    unsign(key) {
-        /*
-         * Ignore when initial value is not defined or null
-         */
-        const value = this.cookies[key];
-        if (value === null || value === undefined) {
-            return null;
-        }
-        /*
-         * Reference to the cache object. Mainly done to avoid typos,
-         * since this object is referenced a handful of times inside
-         * this method.
-         */
-        const cacheObject = this.cachedCookies.signedCookies;
-        /*
-         * Return from cache, when already parsed
-         */
-        if (cacheObject[key] !== undefined) {
-            return cacheObject[key];
-        }
-        /*
-         * Attempt to unpack and cache it for future. The value is only
-         * when value it is not null.
-         */
-        const parsed = this.client.unsign(key, value);
-        if (parsed !== null) {
-            cacheObject[key] = parsed;
-        }
-        return parsed;
-    }
-    /**
-     * Attempts to decrypt a cookie by the name. When calling this method,
-     * you are assuming that the cookie was encrypted at the first place.
-     */
-    decrypt(key) {
-        /*
-         * Ignore when initial value is not defined or null
-         */
-        const value = this.cookies[key];
-        if (value === null || value === undefined) {
-            return null;
-        }
-        /*
-         * Reference to the cache object. Mainly done to avoid typos,
-         * since this object is referenced a handful of times inside
-         * this method.
-         */
-        const cacheObject = this.cachedCookies.encryptedCookies;
-        /*
-         * Return from cache, when already parsed
-         */
-        if (cacheObject[key] !== undefined) {
-            return cacheObject[key];
-        }
-        /*
-         * Attempt to unpack and cache it for future. The value is only
-         * when value it is not null.
-         */
-        const parsed = this.client.decrypt(key, value);
-        if (parsed !== null) {
-            cacheObject[key] = parsed;
-        }
-        return parsed;
-    }
-    /**
-     * Returns an object of cookies key-value pair. Do note, the
-     * cookies are not decoded, unsigned or decrypted inside this
-     * list.
-     */
-    list() {
-        return this.cookies;
-    }
-}
-exports.CookieParser = CookieParser;

package/build/src/Cookie/Serializer/index.d.ts

@@ -1,46 +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.
- */
-import { CookieOptions } from '@ioc:Adonis/Core/Response';
-import { EncryptionContract } from '@ioc:Adonis/Core/Encryption';
-/**
- * Cookies serializer is used to serialize a value to be set on the `Set-Cookie`
- * header. You can `encode`, `sign` on `encrypt` cookies using the serializer
- * and then set them individually using the `set-cookie` header.
- */
-export declare class CookieSerializer {
-    private encryption;
-    private client;
-    constructor(encryption: EncryptionContract);
-    /**
-     * Serializes the key-value pair to a string, that can be set on the
-     * `Set-Cookie` header.
-     */
-    private serializeAsCookie;
-    /**
-     * Encodes value as a plain cookie. Do note, the value is still JSON.stringified
-     * and converted to base64 encoded string to avoid encoding issues.
-     *
-     * @example
-     * ```ts
-     *  serializer.encode('name', 'virk')
-     * ```
-     */
-    encode(key: string, value: any, options?: Partial<CookieOptions & {
-        encode: boolean;
-    }>): string | null;
-    /**
-     * Signs the value and returns it back as a url safe string. The signed value
-     * has a verification hash attached to it to detect data tampering.
-     */
-    sign(key: string, value: any, options?: Partial<CookieOptions>): string | null;
-    /**
-     * Encrypts the value and returns it back as a url safe string.
-     */
-    encrypt(key: string, value: any, options?: Partial<CookieOptions>): string | null;
-}

package/build/src/Cookie/Serializer/index.js

@@ -1,88 +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.CookieSerializer = void 0;
-const ms_1 = __importDefault(require("ms"));
-const cookie_1 = __importDefault(require("cookie"));
-const Client_1 = require("../Client");
-/**
- * Cookies serializer is used to serialize a value to be set on the `Set-Cookie`
- * header. You can `encode`, `sign` on `encrypt` cookies using the serializer
- * and then set them individually using the `set-cookie` header.
- */
-class CookieSerializer {
-    constructor(encryption) {
-        this.encryption = encryption;
-        this.client = new Client_1.CookieClient(this.encryption);
-    }
-    /**
-     * Serializes the key-value pair to a string, that can be set on the
-     * `Set-Cookie` header.
-     */
-    serializeAsCookie(key, value, options) {
-        /**
-         * Invoked expires method to get the date
-         */
-        let expires = options?.expires;
-        if (typeof expires === 'function') {
-            expires = expires();
-        }
-        /**
-         * Parse string based max age to number
-         */
-        let maxAge = options?.maxAge;
-        if (typeof maxAge === 'string') {
-            maxAge = (0, ms_1.default)(maxAge) / 1000;
-        }
-        const parsedOptions = Object.assign({}, options, { maxAge, expires });
-        return cookie_1.default.serialize(key, value, parsedOptions);
-    }
-    /**
-     * Encodes value as a plain cookie. Do note, the value is still JSON.stringified
-     * and converted to base64 encoded string to avoid encoding issues.
-     *
-     * @example
-     * ```ts
-     *  serializer.encode('name', 'virk')
-     * ```
-     */
-    encode(key, value, options) {
-        const packedValue = !(options?.encode ?? true) ? value : this.client.encode(key, value);
-        if (packedValue === null) {
-            return null;
-        }
-        return this.serializeAsCookie(key, packedValue, options);
-    }
-    /**
-     * Signs the value and returns it back as a url safe string. The signed value
-     * has a verification hash attached to it to detect data tampering.
-     */
-    sign(key, value, options) {
-        const packedValue = this.client.sign(key, value);
-        if (packedValue === null) {
-            return null;
-        }
-        return this.serializeAsCookie(key, packedValue, options);
-    }
-    /**
-     * Encrypts the value and returns it back as a url safe string.
-     */
-    encrypt(key, value, options) {
-        const packedValue = this.client.encrypt(key, value);
-        if (packedValue === null) {
-            return null;
-        }
-        return this.serializeAsCookie(key, packedValue, options);
-    }
-}
-exports.CookieSerializer = CookieSerializer;

package/build/src/Exceptions/HttpException.d.ts

@@ -1,20 +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 { Exception } from '@poppinss/utils';
-/**
- * Custom exception to abort requests as one liners
- */
-export declare class HttpException extends Exception {
-    body: any;
-    /**
-     * This method returns an instance of the exception class
-     */
-    static invoke(body: any, status: number, code?: string): HttpException;
-}

package/build/src/Exceptions/HttpException.js

@@ -1,36 +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.HttpException = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const utils_1 = require("@poppinss/utils");
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const exceptions_json_1 = require("../../exceptions.json");
-/**
- * Custom exception to abort requests as one liners
- */
-class HttpException extends utils_1.Exception {
-    /**
-     * This method returns an instance of the exception class
-     */
-    static invoke(body, status, code) {
-        const message = exceptions_json_1.E_HTTP_EXCEPTION.message;
-        code = code || exceptions_json_1.E_HTTP_EXCEPTION.code;
-        if (body !== null && typeof body === 'object') {
-            const error = new this(body.message || (0, helpers_1.interpolate)(message, { status }), status, code);
-            error.body = body;
-            return error;
-        }
-        const error = new this(body || (0, helpers_1.interpolate)(message, { status }), status, code);
-        error.body = error.message;
-        return error;
-    }
-}
-exports.HttpException = HttpException;

package/build/src/Exceptions/RouterException.d.ts

@@ -1,36 +0,0 @@
-import { Exception } from '@poppinss/utils';
-/**
- * Exceptions related to the HTTP router
- */
-export declare class RouterException extends Exception {
-    /**
-     * Raised when one of the routes inside the group doesn't have a name
-     * but an attempt is made to name the group
-     */
-    static cannotDefineGroupName(): void;
-    /**
-     * Raised when a duplicate route pattern is find for the same HTTP method
-     */
-    static duplicateRoute(method: string, pattern: string): void;
-    /**
-     * Raised when a route has duplicate params
-     */
-    static duplicateRouteParam(param: string, pattern: string): RouterException;
-    /**
-     * Raised when route name is not unique
-     */
-    static duplicateRouteName(name: string): void;
-    /**
-     * Raised when unable to make url for a given route, because one of the
-     * params value is not defined
-     */
-    static cannotMakeRoute(param: string, pattern: string): void;
-    /**
-     * Raised when unable to lookup a route using its identifier
-     */
-    static cannotLookupRoute(identifier: string): void;
-    /**
-     * Raised when unable to lookup domain
-     */
-    static cannotLookupDomain(domain: string): void;
-}

package/build/src/Exceptions/RouterException.js

@@ -1,76 +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.RouterException = void 0;
-const utils_1 = require("@poppinss/utils");
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const exceptions_json_1 = require("../../exceptions.json");
-/**
- * Exceptions related to the HTTP router
- */
-class RouterException extends utils_1.Exception {
-    /**
-     * Raised when one of the routes inside the group doesn't have a name
-     * but an attempt is made to name the group
-     */
-    static cannotDefineGroupName() {
-        const error = new this(exceptions_json_1.E_CANNOT_DEFINE_GROUP_NAME.message, exceptions_json_1.E_CANNOT_DEFINE_GROUP_NAME.status, exceptions_json_1.E_CANNOT_DEFINE_GROUP_NAME.code);
-        error.help = exceptions_json_1.E_CANNOT_DEFINE_GROUP_NAME.help.join('\n');
-        throw error;
-    }
-    /**
-     * Raised when a duplicate route pattern is find for the same HTTP method
-     */
-    static duplicateRoute(method, pattern) {
-        const error = new this((0, helpers_1.interpolate)(exceptions_json_1.E_DUPLICATE_ROUTE.message, { method, pattern }), exceptions_json_1.E_DUPLICATE_ROUTE.status, exceptions_json_1.E_DUPLICATE_ROUTE.code);
-        error.help = exceptions_json_1.E_DUPLICATE_ROUTE.help.join('\n');
-        throw error;
-    }
-    /**
-     * Raised when a route has duplicate params
-     */
-    static duplicateRouteParam(param, pattern) {
-        return new this((0, helpers_1.interpolate)(exceptions_json_1.E_DUPLICATE_ROUTE_PARAM.message, { param, pattern }), exceptions_json_1.E_DUPLICATE_ROUTE_PARAM.status, exceptions_json_1.E_DUPLICATE_ROUTE_PARAM.code);
-    }
-    /**
-     * Raised when route name is not unique
-     */
-    static duplicateRouteName(name) {
-        const error = new this((0, helpers_1.interpolate)(exceptions_json_1.E_DUPLICATE_ROUTE_NAME.message, { name }), exceptions_json_1.E_DUPLICATE_ROUTE_NAME.status, exceptions_json_1.E_DUPLICATE_ROUTE_NAME.code);
-        error.help = exceptions_json_1.E_DUPLICATE_ROUTE_NAME.help.join('\n');
-        throw error;
-    }
-    /**
-     * Raised when unable to make url for a given route, because one of the
-     * params value is not defined
-     */
-    static cannotMakeRoute(param, pattern) {
-        const error = new this((0, helpers_1.interpolate)(exceptions_json_1.E_CANNOT_MAKE_ROUTE_URL.message, { pattern, param }), exceptions_json_1.E_CANNOT_MAKE_ROUTE_URL.status, exceptions_json_1.E_CANNOT_MAKE_ROUTE_URL.code);
-        error.help = exceptions_json_1.E_CANNOT_MAKE_ROUTE_URL.help.join('\n');
-        throw error;
-    }
-    /**
-     * Raised when unable to lookup a route using its identifier
-     */
-    static cannotLookupRoute(identifier) {
-        const error = new this((0, helpers_1.interpolate)(exceptions_json_1.E_CANNOT_LOOKUP_ROUTE.message, { identifier }), exceptions_json_1.E_CANNOT_LOOKUP_ROUTE.status, exceptions_json_1.E_CANNOT_LOOKUP_ROUTE.code);
-        error.help = exceptions_json_1.E_CANNOT_LOOKUP_ROUTE.help.join('\n');
-        throw error;
-    }
-    /**
-     * Raised when unable to lookup domain
-     */
-    static cannotLookupDomain(domain) {
-        const error = new this((0, helpers_1.interpolate)(exceptions_json_1.E_CANNOT_LOOKUP_DOMAIN.message, { domain }), exceptions_json_1.E_CANNOT_LOOKUP_DOMAIN.status, exceptions_json_1.E_CANNOT_LOOKUP_DOMAIN.code);
-        error.help = exceptions_json_1.E_CANNOT_LOOKUP_DOMAIN.help.join('\n');
-        throw error;
-    }
-}
-exports.RouterException = RouterException;

package/build/src/HttpContext/LocalStorage/index.d.ts

@@ -1,24 +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 { AsyncLocalStorage } from 'async_hooks';
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-/**
- * Find if the async localstorage is enabled or not
- */
-export declare let usingAsyncLocalStorage: boolean;
-/**
- * Toggle the async local storage
- */
-export declare function useAsyncLocalStorage(enabled: boolean): void;
-/**
- * Async local storage for the HTTP context
- */
-export declare const httpContextLocalStorage: AsyncLocalStorage<HttpContextContract>;

package/build/src/HttpContext/LocalStorage/index.js

@@ -1,28 +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.httpContextLocalStorage = exports.useAsyncLocalStorage = exports.usingAsyncLocalStorage = void 0;
-/// <reference path="../../../adonis-typings/index.ts" />
-const async_hooks_1 = require("async_hooks");
-/**
- * Find if the async localstorage is enabled or not
- */
-exports.usingAsyncLocalStorage = false;
-/**
- * Toggle the async local storage
- */
-function useAsyncLocalStorage(enabled) {
-    exports.usingAsyncLocalStorage = enabled;
-}
-exports.useAsyncLocalStorage = useAsyncLocalStorage;
-/**
- * Async local storage for the HTTP context
- */
-exports.httpContextLocalStorage = new async_hooks_1.AsyncLocalStorage();

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

@@ -1,90 +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="@adonisjs/logger/build/adonis-typings/logger" />
-/// <reference types="@adonisjs/profiler/build/adonis-typings/profiler" />
-/// <reference types="node" />
-import { Macroable } from 'macroable';
-import { RouteNode } from '@ioc:Adonis/Core/Route';
-import { IncomingMessage, ServerResponse } from 'http';
-import { LoggerContract } from '@ioc:Adonis/Core/Logger';
-import { RequestContract } from '@ioc:Adonis/Core/Request';
-import { ResponseContract } from '@ioc:Adonis/Core/Response';
-import { ProfilerRowContract } from '@ioc:Adonis/Core/Profiler';
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-/**
- * Http context is passed to all route handlers, middleware,
- * error handler and server hooks.
- */
-export declare class HttpContext extends Macroable implements HttpContextContract {
-    request: RequestContract;
-    response: ResponseContract;
-    logger: LoggerContract;
-    profiler: ProfilerRowContract;
-    /**
-     * Set inside the provider
-     */
-    static app: ApplicationContract;
-    /**
-     * 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(): HttpContextContract | null;
-    /**
-     * Get the HttpContext instance or raise an exception if not
-     * available
-     */
-    static getOrFail(): HttpContextContract;
-    /**
-     * 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;
-    /**
-     * A unique key for the current route
-     */
-    routeKey: string;
-    /**
-     * Route params
-     */
-    params: Record<string, any>;
-    /**
-     * Route subdomains
-     */
-    subdomains: Record<string, any>;
-    /**
-     * Reference to the current route. Not available inside
-     * server hooks
-     */
-    route?: RouteNode & {
-        params: string[];
-    };
-    /**
-     * Required by macroable
-     */
-    protected static macros: {};
-    protected static getters: {};
-    constructor(request: RequestContract, response: ResponseContract, logger: LoggerContract, profiler: ProfilerRowContract);
-    /**
-     * A helper to see top level properties on the context object
-     */
-    inspect(): string;
-    /**
-     * 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: string, routeParams: Record<string, any>, req?: IncomingMessage, res?: ServerResponse): HttpContext;
-}