@adonisjs/core 6.1.5-3 → 6.1.5-30

package/build/modules/ace/commands.js

@@ -1,5 +1,17 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { BaseCommand as AceBaseCommand, ListCommand as AceListCommand } from '@adonisjs/ace';
-class BaseCommand extends AceBaseCommand {
+/**
+ * The base command to create custom ace commands. The AdonisJS base commands
+ * receives the application instance
+ */
+export class BaseCommand extends AceBaseCommand {
     app;
     kernel;
     static options = {};
@@ -14,12 +26,28 @@ class BaseCommand extends AceBaseCommand {
         this.app = app;
         this.kernel = kernel;
     }
+    /**
+     * Creates the codemods module to modify source files
+     */
+    async createCodemods() {
+        const { Codemods } = await import('./codemods.js');
+        return new Codemods(this.app, this.logger);
+    }
+    /**
+     * Executes the command
+     */
     async exec() {
         this.hydrate();
         try {
+            /**
+             * Executing the template methods
+             */
             this.prepare && (await this.app.container.call(this, 'prepare'));
             this.interact && (await this.app.container.call(this, 'interact'));
             const result = await this.app.container.call(this, 'run');
+            /**
+             * Set exit code
+             */
             this.result = this.result === undefined ? result : this.result;
             this.exitCode = this.exitCode ?? 0;
         }
@@ -27,6 +55,10 @@ class BaseCommand extends AceBaseCommand {
             this.error = error;
             this.exitCode = this.exitCode ?? 1;
         }
+        /**
+         * Run the completed method (if exists) and check if has handled
+         * the error
+         */
         let errorHandled = this.completed
             ? await this.app.container.call(this, 'completed')
             : false;
@@ -35,14 +67,22 @@ class BaseCommand extends AceBaseCommand {
         }
         return this.result;
     }
+    /**
+     * Terminate the app. A command should prefer calling this method
+     * over the "app.terminate", because this method only triggers
+     * app termination when the current command is in the charge
+     * of the process.
+     */
     async terminate() {
         if (this.kernel.getMainCommand() === this) {
             await this.app.terminate();
         }
     }
 }
-export { BaseCommand };
-class ListCommand extends AceListCommand {
+/**
+ * The List command is used to display a list of commands
+ */
+export class ListCommand extends AceListCommand {
     app;
     kernel;
     static options = {};
@@ -57,10 +97,22 @@ class ListCommand extends AceListCommand {
         this.app = app;
         this.kernel = kernel;
     }
+    /**
+     * Creates the codemods module to modify source files
+     */
+    async createCodemods() {
+        const { Codemods } = await import('./codemods.js');
+        return new Codemods(this.app, this.logger);
+    }
+    /**
+     * Terminate the app. A command should prefer calling this method
+     * over the "app.terminate", because this method only triggers
+     * app termination when the current command is in the charge
+     * of the process.
+     */
     async terminate() {
         if (this.kernel.getMainCommand() === this) {
             await this.app.terminate();
         }
     }
 }
-export { ListCommand };

package/build/modules/ace/create_kernel.d.ts

@@ -1,4 +1,12 @@
 import { Kernel } from './main.js';
 import type { ApplicationService } from '../../src/types.js';
+/**
+ * We abstract the logic for creating the ace kernel in this
+ * file. So that both the "console" environment and rest
+ * of the environments can configure and use ace.
+ *
+ * - In console environment, ace manages the lifecycle of the process
+ * - In other environments, ace can be pulled from the container to
+ * run commands
+ */
 export declare function createAceKernel(app: ApplicationService): Kernel;
-//# sourceMappingURL=create_kernel.d.ts.map

package/build/modules/ace/create_kernel.js

@@ -1,11 +1,36 @@
+/*
+ * @adonisjs/ace
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Kernel } from './main.js';
 import { FsLoader, HelpCommand } from '../../modules/ace/main.js';
+/**
+ * We abstract the logic for creating the ace kernel in this
+ * file. So that both the "console" environment and rest
+ * of the environments can configure and use ace.
+ *
+ * - In console environment, ace manages the lifecycle of the process
+ * - In other environments, ace can be pulled from the container to
+ * run commands
+ */
 export function createAceKernel(app) {
     const kernel = new Kernel(app);
     kernel.addLoader(new FsLoader(app.commandsPath()));
+    kernel.info.set('binary', 'node ace');
+    /**
+     * Lazy import commands mentioned in the "commands" array
+     * of rcFile
+     */
     app.rcFile.commands.forEach((commandModule) => {
-        kernel.addLoader(() => app.import(commandModule));
+        kernel.addLoader(() => typeof commandModule === 'function' ? commandModule() : app.import(commandModule));
     });
+    /**
+     * Custom global flags
+     */
     kernel.defineFlag('ansi', {
         type: 'boolean',
         showNegatedVariantInHelp: true,
@@ -15,6 +40,9 @@ export function createAceKernel(app) {
         type: 'boolean',
         description: HelpCommand.description,
     });
+    /**
+     * Flag listener to turn colors on/off
+     */
     kernel.on('ansi', (_, $kernel, parsed) => {
         if (parsed.flags.ansi === false) {
             $kernel.ui.switchMode('silent');
@@ -23,6 +51,9 @@ export function createAceKernel(app) {
             $kernel.ui.switchMode('normal');
         }
     });
+    /**
+     * Flag listener to display the help
+     */
     kernel.on('help', async (command, $kernel, parsed) => {
         parsed.args.unshift(command.commandName);
         const help = new HelpCommand($kernel, parsed, kernel.ui, kernel.prompt);

package/build/modules/ace/kernel.d.ts

@@ -1,8 +1,11 @@
 import { Kernel as AceKernel } from '@adonisjs/ace';
 import { BaseCommand } from './commands.js';
 import type { ApplicationService } from '../../src/types.js';
+/**
+ * The base command to create custom ace commands. The AdonisJS base commands
+ * receives the application instance
+ */
 export declare class Kernel extends AceKernel<typeof BaseCommand> {
     app: ApplicationService;
     constructor(app: ApplicationService);
 }
-//# sourceMappingURL=kernel.d.ts.map

package/build/modules/ace/kernel.js

@@ -1,5 +1,17 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Kernel as AceKernel } from '@adonisjs/ace';
 import { ListCommand } from './commands.js';
+/**
+ * The base command to create custom ace commands. The AdonisJS base commands
+ * receives the application instance
+ */
 export class Kernel extends AceKernel {
     app;
     constructor(app) {

package/build/modules/ace/main.d.ts

@@ -1,4 +1,3 @@
 export { Kernel } from './kernel.js';
 export { BaseCommand, ListCommand } from './commands.js';
 export { args, flags, errors, Parser, FsLoader, ListLoader, cliHelpers, HelpCommand, IndexGenerator, } from '@adonisjs/ace';
-//# sourceMappingURL=main.d.ts.map

package/build/modules/ace/main.js

@@ -1,3 +1,11 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export { Kernel } from './kernel.js';
 export { BaseCommand, ListCommand } from './commands.js';
 export { args, flags, errors, Parser, FsLoader, ListLoader, cliHelpers, HelpCommand, IndexGenerator, } from '@adonisjs/ace';

package/build/modules/ace/shell.d.ts

@@ -1,5 +1,12 @@
 /// <reference types="node" resolution-mode="require"/>
+/**
+ * Ace shell is used to run the ace commands inside a TypeScript project
+ * without pre-compiling TypeScript source files.
+ *
+ * Under the hood a child process is used to execute the "bin/console.ts" file. This
+ * is required because we have to use "ts-node/esm" loader in order to run TypeScript
+ * files.
+ */
 export declare function aceShell(cwd: URL): {
     handle(argv: string[]): Promise<void>;
 };
-//# sourceMappingURL=shell.d.ts.map

package/build/modules/ace/shell.js

@@ -1,8 +1,29 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 const DEFAULT_NODE_ARGS = [
+    // Use ts-node/esm loader. The project must install it
     '--loader=ts-node/esm',
+    // Disable annonying warnings
     '--no-warnings',
+    // Enable expiremental meta resolve for cases where someone uses magic import string
     '--experimental-import-meta-resolve',
+    // Enable source maps, since TSNode source maps are broken
+    '--enable-source-maps',
 ];
+/**
+ * Ace shell is used to run the ace commands inside a TypeScript project
+ * without pre-compiling TypeScript source files.
+ *
+ * Under the hood a child process is used to execute the "bin/console.ts" file. This
+ * is required because we have to use "ts-node/esm" loader in order to run TypeScript
+ * files.
+ */
 export function aceShell(cwd) {
     return {
         async handle(argv) {

package/build/modules/app.d.ts

@@ -1,2 +1 @@
 export * from '@adonisjs/application';
-//# sourceMappingURL=app.d.ts.map

package/build/modules/app.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/application';

package/build/modules/bodyparser/bodyparser_middleware.d.ts

@@ -1,3 +1,6 @@
 import { BodyParserMiddleware } from '@adonisjs/bodyparser/bodyparser_middleware';
+/**
+ * Default export allows lazy importing middleware with
+ * destructuring the named exports
+ */
 export default BodyParserMiddleware;
-//# sourceMappingURL=bodyparser_middleware.d.ts.map

package/build/modules/bodyparser/bodyparser_middleware.js

@@ -1,2 +1,14 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { BodyParserMiddleware } from '@adonisjs/bodyparser/bodyparser_middleware';
+/**
+ * Default export allows lazy importing middleware with
+ * destructuring the named exports
+ */
 export default BodyParserMiddleware;

package/build/modules/bodyparser/main.d.ts

@@ -1,2 +1 @@
 export * from '@adonisjs/bodyparser';
-//# sourceMappingURL=main.d.ts.map

package/build/modules/bodyparser/main.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/bodyparser';

package/build/modules/config.d.ts

@@ -1,2 +1 @@
 export * from '@adonisjs/config';
-//# sourceMappingURL=config.d.ts.map

package/build/modules/config.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/config';

package/build/modules/container.d.ts

@@ -1,2 +1 @@
 export * from '@adonisjs/fold';
-//# sourceMappingURL=container.d.ts.map

package/build/modules/container.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/fold';

package/build/modules/encryption.d.ts

@@ -1,2 +1 @@
 export * from '@adonisjs/encryption';
-//# sourceMappingURL=encryption.d.ts.map

package/build/modules/encryption.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/encryption';

package/build/modules/env/editor.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/env/editor';

package/{modules/config.ts → build/modules/env/editor.js}

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-export * from '@adonisjs/config'
+export * from '@adonisjs/env/editor';

package/{modules/env.ts → build/modules/env/main.js}

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-export * from '@adonisjs/env'
+export * from '@adonisjs/env';

package/build/modules/events.d.ts

@@ -1,2 +1 @@
 export * from '@adonisjs/events';
-//# sourceMappingURL=events.d.ts.map

package/build/modules/events.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/events';

package/build/modules/hash/define_config.d.ts

@@ -1,16 +1,35 @@
-import type { HashDriversList } from '../../src/types.js';
-import type { ManagerDriverFactory } from '../../types/hash.js';
-export declare function defineConfig<KnownHashers extends Record<string, {
-    [K in keyof HashDriversList]: {
-        driver: K;
-    } & Parameters<HashDriversList[K]>[0];
-}[keyof HashDriversList]>>(config: {
-    default?: keyof KnownHashers;
-    list: KnownHashers;
-}): {
+import type { Argon } from './drivers/argon.js';
+import type { Scrypt } from './drivers/scrypt.js';
+import type { Bcrypt } from './drivers/bcrypt.js';
+import type { ConfigProvider } from '../../src/types.js';
+import type { ArgonConfig, BcryptConfig, ScryptConfig, ManagerDriverFactory } from '../../types/hash.js';
+/**
+ * Resolved config from the config provider will be
+ * the config accepted by the hash manager
+ */
+type ResolvedConfig<KnownHashers extends Record<string, ManagerDriverFactory | ConfigProvider<ManagerDriverFactory>>> = {
     default?: keyof KnownHashers;
     list: {
-        [K in keyof KnownHashers]: ManagerDriverFactory;
+        [K in keyof KnownHashers]: KnownHashers[K] extends ConfigProvider<infer A> ? A : KnownHashers[K];
     };
 };
-//# sourceMappingURL=define_config.d.ts.map
+/**
+ * Define config for the hash service.
+ */
+export declare function defineConfig<KnownHashers extends Record<string, ManagerDriverFactory | ConfigProvider<ManagerDriverFactory>>>(config: {
+    default?: keyof KnownHashers;
+    list: KnownHashers;
+}): ConfigProvider<ResolvedConfig<KnownHashers>>;
+/**
+ * Helpers to configure drivers inside the config file. The
+ * drivers will be imported and constructed lazily.
+ *
+ * - Import happens when you first use the hash module
+ * - Construction of drivers happens when you first use a driver
+ */
+export declare const drivers: {
+    argon2: (config: ArgonConfig) => ConfigProvider<() => Argon>;
+    bcrypt: (config: BcryptConfig) => ConfigProvider<() => Bcrypt>;
+    scrypt: (config: ScryptConfig) => ConfigProvider<() => Scrypt>;
+};
+export {};

package/build/modules/hash/define_config.js

@@ -1,19 +1,77 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { InvalidArgumentsException } from '@poppinss/utils';
-import driversCollection from './drivers_collection.js';
+import debug from '../../src/debug.js';
+import { configProvider } from '../../src/config_provider.js';
+/**
+ * Define config for the hash service.
+ */
 export function defineConfig(config) {
+    /**
+     * Hashers list should always be provided
+     */
     if (!config.list) {
         throw new InvalidArgumentsException('Missing "list" property in hash config');
     }
+    /**
+     * The default hasher should be mentioned in the list
+     */
     if (config.default && !config.list[config.default]) {
         throw new InvalidArgumentsException(`Missing "list.${String(config.default)}" in hash config. It is referenced by the "default" property`);
     }
-    const managerHashers = Object.keys(config.list).reduce((result, disk) => {
-        const hasherConfig = config.list[disk];
-        result[disk] = () => driversCollection.create(hasherConfig.driver, hasherConfig);
-        return result;
-    }, {});
-    return {
-        default: config.default,
-        list: managerHashers,
-    };
+    /**
+     * Config provider to lazily import drivers as they are used inside
+     * the user application
+     */
+    return configProvider.create(async (app) => {
+        debug('resolving hash config');
+        const hashersList = Object.keys(config.list);
+        const hashers = {};
+        for (let hasherName of hashersList) {
+            const hasher = config.list[hasherName];
+            if (typeof hasher === 'function') {
+                hashers[hasherName] = hasher;
+            }
+            else {
+                hashers[hasherName] = await hasher.resolver(app);
+            }
+        }
+        return {
+            default: config.default,
+            list: hashers,
+        };
+    });
 }
+/**
+ * Helpers to configure drivers inside the config file. The
+ * drivers will be imported and constructed lazily.
+ *
+ * - Import happens when you first use the hash module
+ * - Construction of drivers happens when you first use a driver
+ */
+export const drivers = {
+    argon2: (config) => {
+        return configProvider.create(async () => {
+            const { Argon } = await import('./drivers/argon.js');
+            return () => new Argon(config);
+        });
+    },
+    bcrypt: (config) => {
+        return configProvider.create(async () => {
+            const { Bcrypt } = await import('./drivers/bcrypt.js');
+            return () => new Bcrypt(config);
+        });
+    },
+    scrypt: (config) => {
+        return configProvider.create(async () => {
+            const { Scrypt } = await import('./drivers/scrypt.js');
+            return () => new Scrypt(config);
+        });
+    },
+};

package/build/modules/hash/drivers/argon.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/hash/drivers/argon';

package/{factories/hash.ts → build/modules/hash/drivers/argon.js}

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-export * from '@adonisjs/hash/factories'
+export * from '@adonisjs/hash/drivers/argon';

package/build/modules/hash/drivers/bcrypt.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/hash/drivers/bcrypt';

package/{factories/events.ts → build/modules/hash/drivers/bcrypt.js}

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-export * from '@adonisjs/events/factories'
+export * from '@adonisjs/hash/drivers/bcrypt';

package/build/modules/hash/drivers/scrypt.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/hash/drivers/scrypt';

package/{legacy/validator.ts → build/modules/hash/drivers/scrypt.js}

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-export * from '@adonisjs/validator'
+export * from '@adonisjs/hash/drivers/scrypt';

package/build/modules/hash/main.d.ts

@@ -1,4 +1,2 @@
 export * from '@adonisjs/hash';
-export { defineConfig } from './define_config.js';
-export { default as driversList } from './drivers_collection.js';
-//# sourceMappingURL=main.d.ts.map
+export { defineConfig, drivers } from './define_config.js';

package/build/modules/hash/main.js

@@ -1,3 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export * from '@adonisjs/hash';
-export { defineConfig } from './define_config.js';
-export { default as driversList } from './drivers_collection.js';
+export { defineConfig, drivers } from './define_config.js';

package/build/modules/hash/phc_formatter.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/hash/phc_formatter';

package/{factories/logger.ts → build/modules/hash/phc_formatter.js}

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-export * from '@adonisjs/logger/factories'
+export * from '@adonisjs/hash/phc_formatter';

package/build/modules/http/main.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Bodyparser import is needed to merge types of Request
+ * class augmented by the bodyparser package
+ */
+import '@adonisjs/bodyparser';
+export * from '@adonisjs/http-server';
+export { RequestValidator } from './request_validator.js';

package/build/modules/http/main.js

@@ -0,0 +1,15 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * Bodyparser import is needed to merge types of Request
+ * class augmented by the bodyparser package
+ */
+import '@adonisjs/bodyparser';
+export * from '@adonisjs/http-server';
+export { RequestValidator } from './request_validator.js';