@adonisjs/core 5.8.9 → 6.0.0-0

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

@@ -1,83 +0,0 @@
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { ExtendCallback, AssetsManagerConfig, AssetsManagerContract } from '@ioc:Adonis/Core/AssetsManager';
-/**
- * Assets manager exposes the API to make link and HTML fragments
- * for static assets.
- *
- * The compilation is not done by the assets manager. It must be done
- * separately
- */
-export declare class AssetsManager implements AssetsManagerContract {
-    private config;
-    application: ApplicationContract;
-    private drivers;
-    /**
-     * Configured driver
-     */
-    private driver;
-    private booted;
-    /**
-     * Find if the configured driver supports entrypoints or not
-     */
-    get hasEntrypoints(): boolean;
-    /**
-     * Path to the public output directory. The property must be
-     * mutable
-     */
-    get publicPath(): string;
-    /**
-     * Returns the current version of assets
-     */
-    get version(): string | undefined;
-    /**
-     * Returns the name of the driver currently in use
-     */
-    get name(): string;
-    constructor(config: AssetsManagerConfig, application: ApplicationContract);
-    /**
-     * Boot the manager. Must be done lazily to allow `extend` method to takes
-     * in effect.
-     */
-    private boot;
-    /**
-     * Ensure entrypoints are enabled, otherwise raise an exception. The
-     * methods relying on the entrypoints file uses this method
-     */
-    private ensureHasEntryPoints;
-    /**
-     * Returns the manifest contents as an object
-     */
-    manifest(): any;
-    /**
-     * Returns path to a given asset entry
-     */
-    assetPath(filename: string): string;
-    /**
-     * Returns the entrypoints contents as an object
-     */
-    entryPoints(): any;
-    /**
-     * Returns list for all the javascript files for a given entry point.
-     * Raises exceptions when [[hasEntrypoints]] is false
-     */
-    entryPointJsFiles(name: string): string[];
-    /**
-     * Returns list for all the css files for a given entry point.
-     * Raises exceptions when [[hasEntrypoints]] is false
-     */
-    entryPointCssFiles(name: string): string[];
-    /**
-     * Returns an HTML fragment for script tags. Raises exceptions
-     * when [[hasEntrypoints]] is false
-     */
-    entryPointScriptTags(name: string): string;
-    /**
-     * Returns an HTML fragment for stylesheet link tags. Raises exceptions
-     * when [[hasEntrypoints]] is false
-     */
-    entryPointStyleTags(name: string): string;
-    /**
-     * Register a custom asset manager driver
-     */
-    extend(name: string, callback: ExtendCallback): this;
-}

package/build/src/AssetsManager/index.js

@@ -1,171 +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.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssetsManager = void 0;
-const utils_1 = require("@poppinss/utils");
-const stringify_attributes_1 = __importDefault(require("stringify-attributes"));
-const Fake_1 = require("./Drivers/Fake");
-const Encore_1 = require("./Drivers/Encore");
-/**
- * Assets manager exposes the API to make link and HTML fragments
- * for static assets.
- *
- * The compilation is not done by the assets manager. It must be done
- * separately
- */
-class AssetsManager {
-    constructor(config, application) {
-        this.config = config;
-        this.application = application;
-        this.drivers = {
-            encore: () => new Encore_1.EncoreDriver(this.application),
-            fake: () => new Fake_1.FakeDriver(this.application),
-        };
-        this.booted = false;
-    }
-    /**
-     * Find if the configured driver supports entrypoints or not
-     */
-    get hasEntrypoints() {
-        this.boot();
-        return this.driver.hasEntrypoints;
-    }
-    /**
-     * Path to the public output directory. The property must be
-     * mutable
-     */
-    get publicPath() {
-        this.boot();
-        return this.driver.publicPath;
-    }
-    /**
-     * Returns the current version of assets
-     */
-    get version() {
-        this.boot();
-        return this.driver.version;
-    }
-    /**
-     * Returns the name of the driver currently in use
-     */
-    get name() {
-        this.boot();
-        return this.driver.name;
-    }
-    /**
-     * Boot the manager. Must be done lazily to allow `extend` method to takes
-     * in effect.
-     */
-    boot() {
-        if (this.booted) {
-            return false;
-        }
-        this.booted = true;
-        const driver = this.config.driver || 'encore';
-        /**
-         * Ensure driver name is recognized
-         */
-        if (!this.drivers[driver]) {
-            throw new utils_1.Exception(`Invalid asset driver "${driver}". Make sure to register the driver using the "AssetsManager.extend" method`);
-        }
-        /**
-         * Configure the driver
-         */
-        this.driver = this.drivers[driver](this, this.config);
-        /**
-         * Configure the public path
-         */
-        if (this.config.publicPath) {
-            this.driver.publicPath = this.config.publicPath;
-        }
-    }
-    /**
-     * Ensure entrypoints are enabled, otherwise raise an exception. The
-     * methods relying on the entrypoints file uses this method
-     */
-    ensureHasEntryPoints() {
-        if (!this.hasEntrypoints) {
-            throw new Error(`Cannot reference entrypoints. The "${this.driver.name}" driver does not support entrypoints`);
-        }
-    }
-    /**
-     * Returns the manifest contents as an object
-     */
-    manifest() {
-        this.boot();
-        return this.driver.manifest();
-    }
-    /**
-     * Returns path to a given asset entry
-     */
-    assetPath(filename) {
-        this.boot();
-        return this.driver.assetPath(filename);
-    }
-    /**
-     * Returns the entrypoints contents as an object
-     */
-    entryPoints() {
-        this.boot();
-        this.ensureHasEntryPoints();
-        return this.driver.entryPoints();
-    }
-    /**
-     * Returns list for all the javascript files for a given entry point.
-     * Raises exceptions when [[hasEntrypoints]] is false
-     */
-    entryPointJsFiles(name) {
-        this.boot();
-        this.ensureHasEntryPoints();
-        return this.driver.entryPointJsFiles(name);
-    }
-    /**
-     * Returns list for all the css files for a given entry point.
-     * Raises exceptions when [[hasEntrypoints]] is false
-     */
-    entryPointCssFiles(name) {
-        this.boot();
-        this.ensureHasEntryPoints();
-        return this.driver.entryPointCssFiles(name);
-    }
-    /**
-     * Returns an HTML fragment for script tags. Raises exceptions
-     * when [[hasEntrypoints]] is false
-     */
-    entryPointScriptTags(name) {
-        const scripts = this.entryPointJsFiles(name);
-        const scriptAttributes = this.config.script ? this.config.script.attributes || {} : {};
-        return scripts
-            .map((url) => `<script src="${url}"${(0, stringify_attributes_1.default)(scriptAttributes)}></script>`)
-            .join('\n');
-    }
-    /**
-     * Returns an HTML fragment for stylesheet link tags. Raises exceptions
-     * when [[hasEntrypoints]] is false
-     */
-    entryPointStyleTags(name) {
-        const links = this.entryPointCssFiles(name);
-        const styleAttributes = this.config.style ? this.config.style.attributes || {} : {};
-        return links
-            .map((url) => `<link rel="stylesheet" href="${url}"${(0, stringify_attributes_1.default)(styleAttributes)} />`)
-            .join('\n');
-    }
-    /**
-     * Register a custom asset manager driver
-     */
-    extend(name, callback) {
-        this.drivers[name] = callback;
-        return this;
-    }
-}
-exports.AssetsManager = AssetsManager;

package/build/src/Bindings/Repl.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="@adonisjs/repl" />
-import { ReplContract } from '@ioc:Adonis/Addons/Repl';
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-/**
- * Define repl bindings. The method must be invoked when application environment
- * is set to repl.
- */
-export declare function defineReplBindings(application: ApplicationContract, Repl: ReplContract): void;

package/build/src/Bindings/Repl.js

@@ -1,90 +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.defineReplBindings = void 0;
-/**
- * Shortcuts to load containers bindings
- */
-function setupReplState(repl, key, value) {
-    repl.server.context[key] = value;
-    repl.notify(`Loaded ${key} module. You can access it using the "${repl.colors.underline(key)}" variable`);
-}
-/**
- * Define repl bindings. The method must be invoked when application environment
- * is set to repl.
- */
-function defineReplBindings(application, Repl) {
-    /**
-     * Load the encryption module
-     */
-    Repl.addMethod('loadEncryption', (repl) => {
-        setupReplState(repl, 'Encryption', application.container.resolveBinding('Adonis/Core/Encryption'));
-    }, {
-        description: 'Load encryption provider and save reference to the "Encryption" variable',
-    });
-    /**
-     * Load the hash module
-     */
-    Repl.addMethod('loadHash', (repl) => {
-        setupReplState(repl, 'Hash', application.container.resolveBinding('Adonis/Core/Hash'));
-    }, {
-        description: 'Load hash provider and save reference to the "Hash" variable',
-    });
-    /**
-     * Load the Env module
-     */
-    Repl.addMethod('loadEnv', (repl) => {
-        setupReplState(repl, 'Env', application.container.resolveBinding('Adonis/Core/Env'));
-    }, {
-        description: 'Load env provider and save reference to the "Env" variable',
-    });
-    /**
-     * Load the HTTP router
-     */
-    Repl.addMethod('loadRouter', (repl) => {
-        setupReplState(repl, 'Route', application.container.resolveBinding('Adonis/Core/Route'));
-    }, {
-        description: 'Load router and save reference to the "Route" variable',
-    });
-    /**
-     * Load config
-     */
-    Repl.addMethod('loadConfig', (repl) => {
-        setupReplState(repl, 'Config', application.container.resolveBinding('Adonis/Core/Config'));
-    }, {
-        description: 'Load config and save reference to the "Config" variable',
-    });
-    /**
-     * Load validator
-     */
-    Repl.addMethod('loadValidator', (repl) => {
-        setupReplState(repl, 'Validator', application.container.resolveBinding('Adonis/Core/Validator'));
-    }, {
-        description: 'Load validator and save reference to the "Validator" variable',
-    });
-    /**
-     * Create context for a dummy route
-     */
-    Repl.addMethod('getContext', (_, route, params) => {
-        return application.container.use('Adonis/Core/HttpContext').create(route, params || {});
-    }, {
-        description: 'Get HTTP context for a given route',
-        usage: `${Repl.colors.yellow('getContext')}${Repl.colors.gray('(route, params?)')}`,
-    });
-    /**
-     * Load the Helpers module
-     */
-    Repl.addMethod('loadHelpers', (repl) => {
-        setupReplState(repl, 'Helpers', application.container.resolveBinding('Adonis/Core/Helpers'));
-    }, {
-        description: 'Load helpers provider and save reference to the "Helpers" variable',
-    });
-}
-exports.defineReplBindings = defineReplBindings;

package/build/src/Bindings/Tests.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="@adonisjs/http-server/build/adonis-typings" />
-import { ContainerBindings } from '@ioc:Adonis/Core/Application';
-import { CookieClientContract } from '@ioc:Adonis/Core/CookieClient';
-/**
- * Define test bindings
- */
-export declare function defineTestsBindings(ApiRequest: ContainerBindings['Japa/Preset/ApiRequest'], ApiClient: ContainerBindings['Japa/Preset/ApiClient'], CookieClient: CookieClientContract): void;

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 {
-    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');
-    }
-    /**
-     * Returns an array of registered services names
-     */
-    get servicesList() {
-        return Object.keys(this.healthCheckers);
-    }
-    /**
-     * 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;