@adonisjs/core 5.9.0 → 6.0.0-0

package/build/src/Bindings/Tests.js

@@ -1,66 +0,0 @@
-"use strict";
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * 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.defineTestsBindings = void 0;
-/**
- * Define test bindings
- */
-function defineTestsBindings(ApiRequest, ApiClient, CookieClient) {
-    /**
-     * Serializing for parsing response cookies
-     */
-    ApiClient.cookiesSerializer({
-        /**
-         * The methods on the Request class encrypts and signs cookies.
-         * Therefore, the prepare method returns the value as it is
-         */
-        prepare(_, value) {
-            return value;
-        },
-        /**
-         * Process the server response and convert cookie value to a
-         * plain string
-         */
-        process(key, value) {
-            return CookieClient.parse(key, value);
-        },
-    });
-    /**
-     * Define cookie
-     */
-    ApiRequest.macro('cookie', function (key, value) {
-        const signedValue = CookieClient.sign(key, value);
-        if (signedValue) {
-            this.cookiesJar[key] = { name: key, value: signedValue };
-        }
-        return this;
-    });
-    /**
-     * Define encrypted cookie
-     */
-    ApiRequest.macro('encryptedCookie', function (key, value) {
-        const encryptedValue = CookieClient.encrypt(key, value);
-        if (encryptedValue) {
-            this.cookiesJar[key] = { name: key, value: encryptedValue };
-        }
-        return this;
-    });
-    /**
-     * Define plain cookie
-     */
-    ApiRequest.macro('plainCookie', function (key, value) {
-        const encodedValue = CookieClient.encode(key, value);
-        if (encodedValue) {
-            this.cookiesJar[key] = { name: key, value: encodedValue };
-        }
-        return this;
-    });
-}
-exports.defineTestsBindings = defineTestsBindings;

package/build/src/HealthCheck/Checkers/AppKey.d.ts

@@ -1,6 +0,0 @@
-import { HealthCheckContract } from '@ioc:Adonis/Core/HealthCheck';
-/**
- * Check for the APP_KEY to ensure it is present and has
- * desired length.
- */
-export default function addAppKeyChecker(healthCheck: HealthCheckContract): void;

package/build/src/HealthCheck/Checkers/AppKey.js

@@ -1,60 +0,0 @@
-"use strict";
-/*
- * @adonisjs/core
- *
- * (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 });
-/**
- * Message for missing Api Key
- */
-const MISSING_APP_KEY_MESSAGE = [
-    'Missing APP_KEY environment variable.',
-    'It is required to keep your application secure',
-].join(' ');
-/**
- * Message for insecure Api Key
- */
-const INSECURE_APP_KEY_MESSAGE = [
-    'Insecure APP_KEY.',
-    'It must be 32 characters long.',
-    'Run "node ace generate:key" to generate a secure key',
-].join(' ');
-const DISPLAY_NAME = 'App Key Check';
-/**
- * Check for the APP_KEY to ensure it is present and has
- * desired length.
- */
-function addAppKeyChecker(healthCheck) {
-    healthCheck.addChecker('appKey', async () => {
-        const appKey = process.env.APP_KEY;
-        if (!appKey) {
-            return {
-                displayName: DISPLAY_NAME,
-                health: {
-                    healthy: false,
-                    message: MISSING_APP_KEY_MESSAGE,
-                },
-            };
-        }
-        if (appKey && appKey.length < 32) {
-            return {
-                displayName: DISPLAY_NAME,
-                health: {
-                    healthy: false,
-                    message: INSECURE_APP_KEY_MESSAGE,
-                },
-            };
-        }
-        return {
-            displayName: DISPLAY_NAME,
-            health: {
-                healthy: true,
-            },
-        };
-    });
-}
-exports.default = addAppKeyChecker;

package/build/src/HealthCheck/Checkers/Env.d.ts

@@ -1,6 +0,0 @@
-import { HealthCheckContract } from '@ioc:Adonis/Core/HealthCheck';
-/**
- * Register the `env` checker to ensure that `NODE_ENV` environment
- * variable is defined.
- */
-export default function addEnvChecker(healthCheck: HealthCheckContract): void;

package/build/src/HealthCheck/Checkers/Env.js

@@ -1,42 +0,0 @@
-"use strict";
-/*
- * @adonisjs/core
- *
- * (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 });
-/**
- * Message for missing app key
- */
-const MISSING_NODE_ENV_MESSAGE = [
-    'Missing NODE_ENV environment variable.',
-    'It can make some parts of the application misbehave',
-].join(' ');
-const DISPLAY_NAME = 'Node Env Check';
-/**
- * Register the `env` checker to ensure that `NODE_ENV` environment
- * variable is defined.
- */
-function addEnvChecker(healthCheck) {
-    healthCheck.addChecker('env', async () => {
-        const env = process.env.NODE_ENV;
-        return env
-            ? {
-                displayName: DISPLAY_NAME,
-                health: {
-                    healthy: true,
-                },
-            }
-            : {
-                displayName: DISPLAY_NAME,
-                health: {
-                    healthy: false,
-                    message: MISSING_NODE_ENV_MESSAGE,
-                },
-            };
-    });
-}
-exports.default = addEnvChecker;

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

@@ -1,48 +0,0 @@
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { Checker, HealthReport, HealthCheckContract } from '@ioc:Adonis/Core/HealthCheck';
-/**
- * The module exposes the API to find the health, liveliness and readiness of
- * the system. You can also add your own checkers.
- */
-export declare class HealthCheck implements HealthCheckContract {
-    private application;
-    /**
-     * A copy of registered checkers
-     */
-    private healthCheckers;
-    /**
-     * Reference to the IoC container to resolve health checkers
-     */
-    private resolver;
-    /**
-     * Returns an array of registered services names
-     */
-    get servicesList(): string[];
-    constructor(application: ApplicationContract);
-    /**
-     * Invokes a given checker to collect the report metrics.
-     */
-    private invokeChecker;
-    /**
-     * A boolean to know, if all health checks have passed
-     * or not.
-     */
-    isLive(): Promise<boolean>;
-    /**
-     * Add a custom checker to check a given service connectivity
-     * with the server
-     */
-    addChecker(service: string, checker: Checker): void;
-    /**
-     * Ensure that application is ready. This relies on the application module.
-     */
-    isReady(): boolean;
-    /**
-     * Returns the health check reports. The health checks are performed when
-     * this method is invoked.
-     */
-    getReport(): Promise<{
-        healthy: boolean;
-        report: HealthReport;
-    }>;
-}

package/build/src/HealthCheck/index.js

@@ -1,99 +0,0 @@
-"use strict";
-/*
- * @adonisjs/core
- *
- * (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.HealthCheck = void 0;
-/**
- * The module exposes the API to find the health, liveliness and readiness of
- * the system. You can also add your own checkers.
- */
-class HealthCheck {
-    /**
-     * Returns an array of registered services names
-     */
-    get servicesList() {
-        return Object.keys(this.healthCheckers);
-    }
-    constructor(application) {
-        this.application = application;
-        /**
-         * A copy of registered checkers
-         */
-        this.healthCheckers = {};
-        /**
-         * Reference to the IoC container to resolve health checkers
-         */
-        this.resolver = this.application.container.getResolver('report');
-    }
-    /**
-     * Invokes a given checker to collect the report metrics.
-     */
-    async invokeChecker(service, reportSheet) {
-        const checker = this.healthCheckers[service];
-        let report;
-        try {
-            if (typeof checker === 'function') {
-                report = await checker();
-            }
-            else {
-                report = await this.resolver.call(checker);
-            }
-            report.displayName = report.displayName || service;
-        }
-        catch (error) {
-            report = {
-                displayName: service,
-                health: { healthy: false, message: error.message },
-                meta: { fatal: true },
-            };
-        }
-        reportSheet[service] = report;
-        return report.health.healthy;
-    }
-    /**
-     * A boolean to know, if all health checks have passed
-     * or not.
-     */
-    async isLive() {
-        if (!this.isReady()) {
-            return false;
-        }
-        const { healthy } = await this.getReport();
-        return healthy;
-    }
-    /**
-     * Add a custom checker to check a given service connectivity
-     * with the server
-     */
-    addChecker(service, checker) {
-        this.healthCheckers[service] = checker;
-    }
-    /**
-     * Ensure that application is ready. This relies on the application module.
-     */
-    isReady() {
-        return this.application.isReady;
-    }
-    /**
-     * Returns the health check reports. The health checks are performed when
-     * this method is invoked.
-     */
-    async getReport() {
-        const report = {};
-        await Promise.all(Object.keys(this.healthCheckers).map((service) => {
-            return this.invokeChecker(service, report);
-        }));
-        /**
-         * Finding unhealthy service to know if system is healthy or not
-         */
-        const unhealthyService = Object.keys(report).find((service) => !report[service].health.healthy);
-        return { healthy: !unhealthyService, report };
-    }
-}
-exports.HealthCheck = HealthCheck;

package/build/src/Hooks/Cors/index.d.ts

@@ -1,70 +0,0 @@
-/// <reference types="@adonisjs/http-server/build/adonis-typings" />
-import { CorsConfig } from '@ioc:Adonis/Core/Cors';
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-/**
- * The Cors middleware class to handle preflight request as per the CORS
- * RFC https://www.w3.org/TR/cors/.
- *
- * This is a functional middleware and shared among all requests. So make
- * sure not to set request specific instance properties.
- */
-export declare class Cors {
-    private options;
-    private isEnabled;
-    constructor(options: CorsConfig);
-    /**
-     * Normalize config options
-     */
-    private normalizeOptions;
-    /**
-     * Computes the origin for the current request based upon the
-     * user config.
-     *
-     * Origin match is always case sensitive
-     */
-    private computeResponseOrigin;
-    /**
-     * Returns an array of headers allowed based upon user config
-     * and request headers.
-     *
-     * The array items are casted to lowercase for case insensitive
-     * match.
-     */
-    private computedAllowedHeaders;
-    /**
-     * Sets the `Access-Control-Allow-Origin` header
-     */
-    private setOrigin;
-    /**
-     * Setting `Access-Control-Expose-Headers` headers, when custom headers
-     * are defined. If no custom headers are defined, then simple response
-     * headers are used instead.
-     */
-    private setExposedHeaders;
-    /**
-     * Allows `Access-Control-Allow-Credentials` when enabled inside the user
-     * config.
-     */
-    private setCredentials;
-    /**
-     * Set `Access-Control-Allow-Methods` header.
-     */
-    private setAllowMethods;
-    /**
-     * Set `Access-Control-Allow-Headers` header.
-     */
-    private setAllowHeaders;
-    /**
-     * Set `Access-Control-Max-Age` header.
-     */
-    private setMaxAge;
-    /**
-     * Ends the preflight request with 204 status code
-     */
-    private endPreFlight;
-    /**
-     * Handle HTTP request for CORS. This method is binded as a before hook
-     * to the HTTP server.
-     */
-    handle(ctx: HttpContextContract): Promise<void>;
-}