@adonisjs/core 6.1.5-3 → 6.1.5-5

package/build/factories/core/ignitor.js

@@ -1,16 +1,36 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Ignitor } from '../../src/ignitor/main.js';
 import { defineConfig as defineHttpConfig } from '../../modules/http.js';
 import { defineConfig as defineLoggerConfig } from '../../modules/logger.js';
 import { defineConfig as defineHashConfig } from '../../modules/hash/main.js';
 import { defineConfig as defineBodyParserConfig } from '../../modules/bodyparser/main.js';
+/**
+ * Ignitor factory creates an instance of the AdonisJS ignitor
+ */
 export class IgnitorFactory {
     #preloadActions = [];
     #parameters = {};
+    /**
+     * A flag to know if we should load the core providers
+     */
     #loadCoreProviders = false;
+    /**
+     * Define preload actions to run.
+     */
     preload(action) {
         this.#preloadActions.push(action);
         return this;
     }
+    /**
+     * Merge core providers with user defined providers
+     */
     #mergeCoreProviders(providers) {
         return [
             '@adonisjs/core/providers/app_provider',
@@ -18,6 +38,9 @@ export class IgnitorFactory {
             '@adonisjs/core/providers/http_provider',
         ].concat(providers || []);
     }
+    /**
+     * Merge custom factory parameters
+     */
     merge(params) {
         if (params.config) {
             this.#parameters.config = Object.assign(this.#parameters.config || {}, params.config);
@@ -27,10 +50,17 @@ export class IgnitorFactory {
         }
         return this;
     }
+    /**
+     * Load core provider when booting the app
+     */
     withCoreProviders() {
         this.#loadCoreProviders = true;
         return this;
     }
+    /**
+     * Merge default config for the core features. A shallow merge
+     * is performed.
+     */
     withCoreConfig() {
         this.merge({
             config: {
@@ -58,6 +88,9 @@ export class IgnitorFactory {
         });
         return this;
     }
+    /**
+     * Create ignitor instance
+     */
     create(appRoot, options) {
         return new Ignitor(appRoot, options).tap((app) => {
             app.booted(async () => {

package/build/factories/core/main.d.ts

@@ -2,4 +2,3 @@ export { AceFactory } from './ace.js';
 export { StubsFactory } from '../stubs.js';
 export { IgnitorFactory } from './ignitor.js';
 export { TestUtilsFactory } from './test_utils.js';
-//# sourceMappingURL=main.d.ts.map

package/build/factories/core/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 { AceFactory } from './ace.js';
 export { StubsFactory } from '../stubs.js';
 export { IgnitorFactory } from './ignitor.js';

package/build/factories/core/test_utils.d.ts

@@ -1,9 +1,11 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
 import { Ignitor } from '../../index.js';
 import type { IgnitorOptions } from '../../src/types.js';
 import { TestUtils } from '../../src/test_utils/main.js';
+/**
+ * Creates an instance of TestUtils class
+ */
 export declare class TestUtilsFactory {
     create(ignitor: Ignitor): TestUtils;
     create(appRoot: URL, options: IgnitorOptions): TestUtils;
 }
-//# sourceMappingURL=test_utils.d.ts.map

package/build/factories/core/test_utils.js

@@ -1,6 +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 { Ignitor } from '../../index.js';
 import { IgnitorFactory } from './ignitor.js';
 import { TestUtils } from '../../src/test_utils/main.js';
+/**
+ * Creates an instance of TestUtils class
+ */
 export class TestUtilsFactory {
     create(ignitorOrAppRoot, options) {
         if (ignitorOrAppRoot instanceof Ignitor) {

package/build/factories/encryption.d.ts

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

package/build/factories/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/factories';

package/build/factories/events.d.ts

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

package/build/factories/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/factories';

package/build/factories/hash.d.ts

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

package/build/factories/hash.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/hash/factories';

package/build/factories/http.d.ts

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

package/build/factories/http.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/http-server/factories';

package/build/factories/logger.d.ts

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

package/build/factories/logger.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/logger/factories';

package/build/factories/stubs.d.ts

@@ -2,9 +2,19 @@ import type { ApplicationService } from '../src/types.js';
 type FactoryParameters = {
     app: ApplicationService;
 };
+/**
+ * Prepares stubs from "@adonisjs/core" package. We do not publish this class as it
+ * is for internal testing only using the "stubsRoot" of the core package
+ */
 export declare class StubsFactory {
     #private;
+    /**
+     * Merge custom factory parameters
+     */
     merge(params: Partial<FactoryParameters>): this;
+    /**
+     * Prepares a stub
+     */
     prepare(stubPath: string, data: Record<string, any>): Promise<{
         contents: any;
         destination: any;
@@ -13,4 +23,3 @@ export declare class StubsFactory {
     }>;
 }
 export {};
-//# sourceMappingURL=stubs.d.ts.map

package/build/factories/stubs.js

@@ -1,14 +1,35 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { AppFactory } from '@adonisjs/application/factories';
 import { stubsRoot } from '../index.js';
+/**
+ * Prepares stubs from "@adonisjs/core" package. We do not publish this class as it
+ * is for internal testing only using the "stubsRoot" of the core package
+ */
 export class StubsFactory {
     #parameters = {};
+    /**
+     * Returns an instance of application
+     */
     #getApp() {
         return this.#parameters.app || new AppFactory().create(new URL('./', import.meta.url), () => { });
     }
+    /**
+     * Merge custom factory parameters
+     */
     merge(params) {
         this.#parameters = Object.assign(this.#parameters, params);
         return this;
     }
+    /**
+     * Prepares a stub
+     */
     async prepare(stubPath, data) {
         const app = this.#getApp();
         await app.init();

package/build/index.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
 export { stubsRoot } from './stubs/index.js';
 export { inject } from './modules/container.js';
 export { Ignitor } from './src/ignitor/main.js';
@@ -140,5 +140,8 @@ export declare const errors: {
     E_INSECURE_APP_KEY: new (args?: any, options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
     E_MISSING_APP_KEY: new (args?: any, options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
 };
+/**
+ * Pretty prints an error with colorful output using
+ * Youch terminal
+ */
 export declare function prettyPrintError(error: any): Promise<void>;
-//# sourceMappingURL=index.d.ts.map

package/build/index.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.
+ */
 import { errors as aceErrors } from '@adonisjs/ace';
 import { errors as envErrors } from '@adonisjs/env';
 import { errors as appErrors } from '@adonisjs/application';
@@ -13,7 +21,12 @@ export const errors = {
     ...aceErrors,
     ...envErrors,
 };
+/**
+ * Pretty prints an error with colorful output using
+ * Youch terminal
+ */
 export async function prettyPrintError(error) {
+    // @ts-expect-error
     const { default: youchTerminal } = await import('youch-terminal');
     const { default: Youch } = await import('youch');
     const youch = new Youch(error, {});

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

@@ -2,26 +2,148 @@ import { BaseCommand as AceBaseCommand, ListCommand as AceListCommand } from '@a
 import { Kernel } from './kernel.js';
 import type { ApplicationService } from '../../src/types.js';
 import type { CommandOptions, ParsedOutput, UIPrimitives } from '../../types/ace.js';
+/**
+ * Wrapper around the stub generation logic.
+ * Allow commands to easily generate files from given stubs
+ */
+declare class StubGenerator {
+    #private;
+    constructor(command: BaseCommand, flags: Record<string, any>);
+    generate(stubsRoot: string, stubPath: string, stubState: Record<string, any>): Promise<{
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "created";
+        skipReason: null;
+    } | {
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "force_created";
+        skipReason: null;
+    } | {
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "skipped";
+        skipReason: string;
+    }>;
+}
+/**
+ * The base command to create custom ace commands. The AdonisJS base commands
+ * receives the application instance
+ */
 export declare class BaseCommand extends AceBaseCommand {
     app: ApplicationService;
     kernel: Kernel;
+    stubGenerator: StubGenerator;
     static options: CommandOptions;
     get staysAlive(): boolean | undefined;
     get startApp(): boolean | undefined;
     constructor(app: ApplicationService, kernel: Kernel, parsed: ParsedOutput, ui: UIPrimitives, prompt: Kernel['prompt']);
+    /**
+     * The prepare template method is used to prepare the
+     * state for the command. This is the first method
+     * executed on a given command instance.
+     */
     prepare?(..._: any[]): any;
+    /**
+     * The interact template method is used to display the prompts
+     * to the user. The method is called after the prepare
+     * method.
+     */
     interact?(..._: any[]): any;
+    /**
+     * The completed method is the method invoked after the command
+     * finishes or results in an error.
+     *
+     * You can access the command error using the `this.error` property.
+     * Returning `true` from completed method supresses the error
+     * reporting to the kernel layer.
+     */
     completed?(..._: any[]): any;
+    /**
+     * Make a new file using the given stub
+     */
+    makeUsingStub(stubPath: string, stubState: Record<string, any>, stubsRoot: string): Promise<{
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "created";
+        skipReason: null;
+    } | {
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "force_created";
+        skipReason: null;
+    } | {
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "skipped";
+        skipReason: string;
+    }>;
+    /**
+     * Executes the command
+     */
     exec(): Promise<any>;
+    /**
+     * 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.
+     */
     terminate(): Promise<void>;
 }
+/**
+ * The List command is used to display a list of commands
+ */
 export declare class ListCommand extends AceListCommand implements BaseCommand {
     app: ApplicationService;
     kernel: Kernel;
+    stubGenerator: StubGenerator;
     static options: CommandOptions;
     get staysAlive(): boolean | undefined;
     get startApp(): boolean | undefined;
     constructor(app: ApplicationService, kernel: Kernel, parsed: ParsedOutput, ui: UIPrimitives, prompt: Kernel['prompt']);
+    /**
+     * Make a new file using the given stub
+     */
+    makeUsingStub(stubPath: string, stubState: Record<string, any>, stubsRoot: string): Promise<{
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "created";
+        skipReason: null;
+    } | {
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "force_created";
+        skipReason: null;
+    } | {
+        relativeFileName: string;
+        contents: any;
+        destination: any;
+        attributes: any;
+        status: "skipped";
+        skipReason: string;
+    }>;
+    /**
+     * 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.
+     */
     terminate(): Promise<void>;
 }
-//# sourceMappingURL=commands.d.ts.map
+export {};

package/build/modules/ace/commands.js

@@ -1,7 +1,45 @@
+/*
+ * @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 {
+import { slash } from '@poppinss/utils';
+/**
+ * Wrapper around the stub generation logic.
+ * Allow commands to easily generate files from given stubs
+ */
+class StubGenerator {
+    #command;
+    #flags;
+    constructor(command, flags) {
+        this.#command = command;
+        this.#flags = flags;
+    }
+    async generate(stubsRoot, stubPath, stubState) {
+        const stub = await this.#command.app.stubs.build(stubPath, { source: stubsRoot });
+        const output = await stub.generate(Object.assign({ flags: this.#flags }, stubState));
+        const entityFileName = slash(this.#command.app.relativePath(output.destination));
+        const result = { ...output, relativeFileName: entityFileName };
+        if (output.status === 'skipped') {
+            this.#command.logger.action(`create ${entityFileName}`).skipped(output.skipReason);
+            return result;
+        }
+        this.#command.logger.action(`create ${entityFileName}`).succeeded();
+        return result;
+    }
+}
+/**
+ * The base command to create custom ace commands. The AdonisJS base commands
+ * receives the application instance
+ */
+export class BaseCommand extends AceBaseCommand {
     app;
     kernel;
+    stubGenerator = new StubGenerator(this, this.parsed?.flags || {});
     static options = {};
     get staysAlive() {
         return this.constructor.options.staysAlive;
@@ -14,12 +52,27 @@ class BaseCommand extends AceBaseCommand {
         this.app = app;
         this.kernel = kernel;
     }
+    /**
+     * Make a new file using the given stub
+     */
+    async makeUsingStub(stubPath, stubState, stubsRoot) {
+        return this.stubGenerator.generate(stubsRoot, stubPath, stubState);
+    }
+    /**
+     * 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 +80,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,16 +92,25 @@ 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;
+    stubGenerator = new StubGenerator(this, this.parsed?.flags || {});
     static options = {};
     get staysAlive() {
         return this.constructor.options.staysAlive;
@@ -57,10 +123,21 @@ class ListCommand extends AceListCommand {
         this.app = app;
         this.kernel = kernel;
     }
+    /**
+     * Make a new file using the given stub
+     */
+    async makeUsingStub(stubPath, stubState, stubsRoot) {
+        return this.stubGenerator.generate(stubsRoot, stubPath, stubState);
+    }
+    /**
+     * 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));
     });
+    /**
+     * 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