@adonisjs/http-server 5.11.0 → 6.0.0-0

package/build/providers/HttpServerProvider.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 { ApplicationContract } from '@ioc:Adonis/Core/Application';
-export default class HttpServerProvider {
-    protected application: ApplicationContract;
-    constructor(application: ApplicationContract);
-    /**
-     * Validate server config to ensure we start with sane defaults
-     */
-    private validateServerConfig;
-    /**
-     * Register request and response bindings to the container
-     */
-    protected registerRequestResponse(): void;
-    /**
-     * Registering middleware store to the container
-     */
-    protected registerMiddlewareStore(): void;
-    /**
-     * Registering the HTTP context
-     */
-    protected registerHTTPContext(): void;
-    /**
-     * Register the HTTP server
-     */
-    protected registerHttpServer(): void;
-    /**
-     * Register the router. The router points to the instance of router used
-     * by the middleware
-     */
-    protected registerRouter(): void;
-    /**
-     * Registers the cookie client with the container
-     */
-    protected registerCookieClient(): void;
-    /**
-     * Registering all bindings
-     */
-    register(): void;
-}

package/build/providers/HttpServerProvider.js

@@ -1,100 +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 });
-const utils_1 = require("@poppinss/utils");
-class HttpServerProvider {
-    constructor(application) {
-        this.application = application;
-    }
-    /**
-     * Validate server config to ensure we start with sane defaults
-     */
-    validateServerConfig(config) {
-        if (!config.cookie || typeof config.cookie !== 'object') {
-            throw new utils_1.Exception('Missing "cookie" config inside the "http" block in "config/app" file.');
-        }
-        if (typeof config.trustProxy !== 'function') {
-            throw new utils_1.Exception('Invalid "trustProxy" value inside the "http" block in "config/app" file.');
-        }
-    }
-    /**
-     * Register request and response bindings to the container
-     */
-    registerRequestResponse() {
-        this.application.container.singleton('Adonis/Core/Request', () => {
-            return require('../src/Request').Request;
-        });
-        this.application.container.singleton('Adonis/Core/Response', () => {
-            return require('../src/Response').Response;
-        });
-    }
-    /**
-     * Registering middleware store to the container
-     */
-    registerMiddlewareStore() {
-        this.application.container.bind('Adonis/Core/MiddlewareStore', () => {
-            return require('../src/MiddlewareStore').MiddlewareStore;
-        });
-    }
-    /**
-     * Registering the HTTP context
-     */
-    registerHTTPContext() {
-        this.application.container.bind('Adonis/Core/HttpContext', () => {
-            const { HttpContext } = require('../src/HttpContext');
-            HttpContext.app = this.application.container.resolveBinding('Adonis/Core/Application');
-            return HttpContext;
-        });
-    }
-    /**
-     * Register the HTTP server
-     */
-    registerHttpServer() {
-        this.application.container.singleton('Adonis/Core/Server', () => {
-            const { Server } = require('../src/Server');
-            const Config = this.application.container.resolveBinding('Adonis/Core/Config');
-            const Encryption = this.application.container.resolveBinding('Adonis/Core/Encryption');
-            const serverConfig = Config.get('app.http', {});
-            this.validateServerConfig(serverConfig);
-            return new Server(this.application, Encryption, serverConfig);
-        });
-    }
-    /**
-     * Register the router. The router points to the instance of router used
-     * by the middleware
-     */
-    registerRouter() {
-        this.application.container.singleton('Adonis/Core/Route', () => {
-            return this.application.container.resolveBinding('Adonis/Core/Server').router;
-        });
-    }
-    /**
-     * Registers the cookie client with the container
-     */
-    registerCookieClient() {
-        this.application.container.singleton('Adonis/Core/CookieClient', () => {
-            const { CookieClient } = require('../src/Cookie/Client');
-            const Encryption = this.application.container.resolveBinding('Adonis/Core/Encryption');
-            return new CookieClient(Encryption);
-        });
-    }
-    /**
-     * Registering all bindings
-     */
-    register() {
-        this.registerRequestResponse();
-        this.registerMiddlewareStore();
-        this.registerHttpServer();
-        this.registerHTTPContext();
-        this.registerRouter();
-        this.registerCookieClient();
-    }
-}
-exports.default = HttpServerProvider;

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

@@ -1,39 +0,0 @@
-/// <reference path="../../../adonis-typings/index.d.ts" />
-import { EncryptionContract } from '@ioc:Adonis/Core/Encryption';
-import { CookieClientContract } from '@ioc:Adonis/Core/CookieClient';
-/**
- * Cookie client exposes the API to parse/set AdonisJS
- * cookies as a client.
- */
-export declare class CookieClient implements CookieClientContract {
-    private encryption;
-    constructor(encryption: EncryptionContract);
-    /**
-     * Encrypt a key value pair to be sent in the cookie header
-     */
-    encrypt(key: string, value: any): string | null;
-    /**
-     * Sign a key value pair to be sent in the cookie header
-     */
-    sign(key: string, value: any): string | null;
-    /**
-     * Encode a key value pair to be sent in the cookie header
-     */
-    encode(_: string, value: any): string | null;
-    /**
-     * Unsign a signed cookie value
-     */
-    unsign(key: string, value: string): any;
-    /**
-     * Decrypt an encrypted cookie value
-     */
-    decrypt(key: string, value: string): any;
-    /**
-     * Decode an encoded cookie value
-     */
-    decode(_: string, value: string): any;
-    /**
-     * Parse response cookie
-     */
-    parse(key: string, value: any): any;
-}

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

@@ -1,108 +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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CookieClient = void 0;
-const PlainCookie = __importStar(require("../Drivers/Plain"));
-const SignedCookie = __importStar(require("../Drivers/Signed"));
-const EncryptedCookie = __importStar(require("../Drivers/Encrypted"));
-/**
- * Cookie client exposes the API to parse/set AdonisJS
- * cookies as a client.
- */
-class CookieClient {
-    constructor(encryption) {
-        this.encryption = encryption;
-    }
-    /**
-     * Encrypt a key value pair to be sent in the cookie header
-     */
-    encrypt(key, value) {
-        return EncryptedCookie.pack(key, value, this.encryption);
-    }
-    /**
-     * Sign a key value pair to be sent in the cookie header
-     */
-    sign(key, value) {
-        return SignedCookie.pack(key, value, this.encryption);
-    }
-    /**
-     * Encode a key value pair to be sent in the cookie header
-     */
-    encode(_, value) {
-        return PlainCookie.pack(value);
-    }
-    /**
-     * Unsign a signed cookie value
-     */
-    unsign(key, value) {
-        return SignedCookie.canUnpack(value) ? SignedCookie.unpack(key, value, this.encryption) : null;
-    }
-    /**
-     * Decrypt an encrypted cookie value
-     */
-    decrypt(key, value) {
-        return EncryptedCookie.canUnpack(value)
-            ? EncryptedCookie.unpack(key, value, this.encryption)
-            : null;
-    }
-    /**
-     * Decode an encoded cookie value
-     */
-    decode(_, value) {
-        return PlainCookie.canUnpack(value) ? PlainCookie.unpack(value) : null;
-    }
-    /**
-     * Parse response cookie
-     */
-    parse(key, value) {
-        /**
-         * Unsign signed cookie
-         */
-        if (SignedCookie.canUnpack(value)) {
-            return SignedCookie.unpack(key, value, this.encryption);
-        }
-        /**
-         * Decrypted encrypted cookie
-         */
-        if (EncryptedCookie.canUnpack(value)) {
-            return EncryptedCookie.unpack(key, value, this.encryption);
-        }
-        /**
-         * Decode encoded cookie
-         */
-        if (PlainCookie.canUnpack(value)) {
-            return PlainCookie.unpack(value);
-        }
-    }
-}
-exports.CookieClient = CookieClient;

package/build/src/Cookie/Drivers/Encrypted.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.
- */
-import { EncryptionContract } from '@ioc:Adonis/Core/Encryption';
-/**
- * Encrypt a value to be set as cookie
- */
-export declare function pack(key: string, value: any, encryption: EncryptionContract): null | string;
-/**
- * Returns a boolean, if the unpack method from this module can attempt
- * to unpack encrypted value.
- */
-export declare function canUnpack(encryptedValue: string): boolean;
-/**
- * Attempts to unpack the encrypted cookie value. Returns null, when fails to do so.
- * Only call this method, when `canUnpack` returns true, otherwise runtime
- * exceptions can be raised.
- */
-export declare function unpack(key: string, encryptedValue: string, encryption: EncryptionContract): null | any;

package/build/src/Cookie/Drivers/Encrypted.js

@@ -1,42 +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.unpack = exports.canUnpack = exports.pack = void 0;
-/**
- * Encrypt a value to be set as cookie
- */
-function pack(key, value, encryption) {
-    if (value === undefined || value === null) {
-        return null;
-    }
-    return `e:${encryption.encrypt(value, undefined, key)}`;
-}
-exports.pack = pack;
-/**
- * Returns a boolean, if the unpack method from this module can attempt
- * to unpack encrypted value.
- */
-function canUnpack(encryptedValue) {
-    return typeof encryptedValue === 'string' && encryptedValue.substr(0, 2) === 'e:';
-}
-exports.canUnpack = canUnpack;
-/**
- * Attempts to unpack the encrypted cookie value. Returns null, when fails to do so.
- * Only call this method, when `canUnpack` returns true, otherwise runtime
- * exceptions can be raised.
- */
-function unpack(key, encryptedValue, encryption) {
-    const value = encryptedValue.slice(2);
-    if (!value) {
-        return null;
-    }
-    return encryption.decrypt(value, key);
-}
-exports.unpack = unpack;

package/build/src/Cookie/Drivers/Plain.d.ts

@@ -1,23 +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.
- */
-/**
- * Encodes a value into a base64 url encoded string to
- * be set as cookie
- */
-export declare function pack(value: any): null | string;
-/**
- * Returns true when this `unpack` method of this module can attempt
- * to unpack the encode value.
- */
-export declare function canUnpack(encodedValue: string): boolean;
-/**
- * Attempts to unpack the value by decoding it. Make sure to call, `canUnpack`
- * before calling this method
- */
-export declare function unpack(encodedValue: string): null | any;

package/build/src/Cookie/Drivers/Plain.js

@@ -1,40 +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.unpack = exports.canUnpack = exports.pack = void 0;
-const helpers_1 = require("@poppinss/utils/build/helpers");
-/**
- * Encodes a value into a base64 url encoded string to
- * be set as cookie
- */
-function pack(value) {
-    if (value === undefined || value === null) {
-        return null;
-    }
-    return helpers_1.base64.urlEncode(new helpers_1.MessageBuilder().build(value));
-}
-exports.pack = pack;
-/**
- * Returns true when this `unpack` method of this module can attempt
- * to unpack the encode value.
- */
-function canUnpack(encodedValue) {
-    return typeof encodedValue === 'string';
-}
-exports.canUnpack = canUnpack;
-/**
- * Attempts to unpack the value by decoding it. Make sure to call, `canUnpack`
- * before calling this method
- */
-function unpack(encodedValue) {
-    const verified = new helpers_1.MessageBuilder().verify(helpers_1.base64.urlDecode(encodedValue, 'utf-8', true));
-    return verified === undefined ? null : verified;
-}
-exports.unpack = unpack;

package/build/src/Cookie/Drivers/Signed.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.
- */
-import { EncryptionContract } from '@ioc:Adonis/Core/Encryption';
-/**
- * Signs a value to be shared as a cookie. The signed output has a
- * hash to verify tampering with the original value
- */
-export declare function pack(key: string, value: any, encryption: EncryptionContract): null | string;
-/**
- * Returns a boolean, if the unpack method from this module can attempt
- * to unpack the signed value.
- */
-export declare function canUnpack(signedValue: string): boolean;
-/**
- * Attempts to unpack the signed value. Make sure to call `canUnpack` before
- * calling this method.
- */
-export declare function unpack(key: string, signedValue: string, encryption: EncryptionContract): null | any;

package/build/src/Cookie/Drivers/Signed.js

@@ -1,42 +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.unpack = exports.canUnpack = exports.pack = void 0;
-/**
- * Signs a value to be shared as a cookie. The signed output has a
- * hash to verify tampering with the original value
- */
-function pack(key, value, encryption) {
-    if (value === undefined || value === null) {
-        return null;
-    }
-    return `s:${encryption.verifier.sign(value, undefined, key)}`;
-}
-exports.pack = pack;
-/**
- * Returns a boolean, if the unpack method from this module can attempt
- * to unpack the signed value.
- */
-function canUnpack(signedValue) {
-    return typeof signedValue === 'string' && signedValue.substr(0, 2) === 's:';
-}
-exports.canUnpack = canUnpack;
-/**
- * Attempts to unpack the signed value. Make sure to call `canUnpack` before
- * calling this method.
- */
-function unpack(key, signedValue, encryption) {
-    const value = signedValue.slice(2);
-    if (!value) {
-        return null;
-    }
-    return encryption.verifier.unsign(value, key);
-}
-exports.unpack = unpack;

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

@@ -1,61 +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 { EncryptionContract } from '@ioc:Adonis/Core/Encryption';
-/**
- * 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.
- */
-export declare class CookieParser {
-    private cookieHeader;
-    private encryption;
-    private client;
-    /**
-     * A copy of cached cookies, they are cached during a request after
-     * initial decoding, unsigning or decrypting.
-     */
-    private cachedCookies;
-    /**
-     * An object of key-value pair collected by parsing
-     * the request cookie header.
-     */
-    private cookies;
-    constructor(cookieHeader: string, encryption: EncryptionContract);
-    /**
-     * Parses the request `cookie` header
-     */
-    private parse;
-    /**
-     * 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: string): any | null;
-    /**
-     * 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: string): null | any;
-    /**
-     * 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: string): null | any;
-    /**
-     * Returns an object of cookies key-value pair. Do note, the
-     * cookies are not decoded, unsigned or decrypted inside this
-     * list.
-     */
-    list(): Record<string, any>;
-}