@adonisjs/core 6.1.5-3 → 6.1.5-31

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,15 +2,24 @@ 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;
+        contents: string;
         destination: any;
         force: any;
-        attributes: any;
+        attributes: Record<string, any>;
     }>;
 }
 export {};
-//# sourceMappingURL=stubs.d.ts.map

package/build/factories/stubs.js

@@ -1,18 +1,40 @@
+/*
+ * @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();
-        const stub = await app.stubs.build(stubPath, {
+        const stubs = await app.stubs.create();
+        const stub = await stubs.build(stubPath, {
             source: stubsRoot,
         });
         return stub.prepare(data);

package/build/index.d.ts

@@ -1,144 +1,18 @@
-/// <reference types="node" resolution-mode="require"/>
-export { stubsRoot } from './stubs/index.js';
+import { errors as aceErrors } from '@adonisjs/ace';
+import { errors as envErrors } from '@adonisjs/env';
+import { errors as appErrors } from '@adonisjs/application';
+import { errors as encryptionErrors } from '@adonisjs/encryption';
+import { errors as httpServerErrors } from '@adonisjs/http-server';
+export { stubsRoot } from './stubs/main.js';
 export { inject } from './modules/container.js';
 export { Ignitor } from './src/ignitor/main.js';
-export declare const errors: {
-    E_INVALID_ENV_VARIABLES: {
-        new (message?: string | undefined, options?: (ErrorOptions & {
-            code?: string | undefined;
-            status?: number | undefined;
-        }) | undefined): {
-            help: string;
-            name: string;
-            code?: string | undefined;
-            status: number;
-            toString(): string;
-            message: string;
-            stack?: string | undefined;
-            cause?: unknown;
-            readonly [Symbol.toStringTag]: string;
-        };
-        message: string;
-        code: string;
-        help?: string | undefined;
-        status?: number | undefined;
-        captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
-        prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
-        stackTraceLimit: number;
-    };
-    E_MISSING_COMMAND_NAME: new (args: [command: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_COMMAND_NOT_FOUND: {
-        new (args: [command: string]): {
-            commandName: string;
-            name: string;
-            help?: string | undefined;
-            code?: string | undefined;
-            status: number;
-            toString(): string;
-            message: string;
-            stack?: string | undefined;
-            cause?: unknown;
-            readonly [Symbol.toStringTag]: string;
-        };
-        help?: string | undefined;
-        code?: string | undefined;
-        status?: number | undefined;
-        message?: string | undefined;
-        captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
-        prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
-        stackTraceLimit: number;
-    };
-    E_MISSING_FLAG: new (args: [flag: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_FLAG_VALUE: new (args: [flag: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_ARG: new (args: [arg: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_ARG_VALUE: new (args: [arg: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_UNKNOWN_FLAG: new (args: [flag: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_INVALID_FLAG: new (args: [flag: string, expectedDataType: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_METAFILE_PATTERN: new (args: [fileProperty: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_PRELOAD_FILE: new (args: [preloadProperty: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_PROVIDER_FILE: new (args: [preloadProperty: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_SUITE_NAME: new (args: [suiteProperty: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_SUITE_FILES: new (args: [suiteProperty: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_BUNDLER_DEV_COMMAND: new (args?: any, options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_BUNDLER_BUILD_COMMAND: new (args?: any, options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_MISSING_BUNDLER_NAME: new (args?: any, options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_ROUTE_NOT_FOUND: new (args: [method: string, url: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_CANNOT_LOOKUP_ROUTE: new (args: [routeIdentifier: string], options?: ErrorOptions | undefined) => import("@poppinss/utils").Exception;
-    E_HTTP_EXCEPTION: {
-        new (message?: string | undefined, options?: (ErrorOptions & {
-            code?: string | undefined;
-            status?: number | undefined;
-        }) | undefined): {
-            body: any;
-            name: string;
-            help?: string | undefined;
-            code?: string | undefined;
-            status: number;
-            toString(): string;
-            message: string;
-            stack?: string | undefined;
-            cause?: unknown;
-            readonly [Symbol.toStringTag]: string;
-        };
-        code: string;
-        invoke(body: any, status: number, code?: string | undefined): {
-            body: any;
-            name: string;
-            help?: string | undefined;
-            code?: string | undefined;
-            status: number;
-            toString(): string;
-            message: string;
-            stack?: string | undefined;
-            cause?: unknown;
-            readonly [Symbol.toStringTag]: string;
-        };
-        help?: string | undefined;
-        status?: number | undefined;
-        message?: string | undefined;
-        captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
-        prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
-        stackTraceLimit: number;
-    };
-    E_HTTP_REQUEST_ABORTED: {
-        new (message?: string | undefined, options?: (ErrorOptions & {
-            code?: string | undefined;
-            status?: number | undefined;
-        }) | undefined): {
-            handle(error: any, ctx: import("@adonisjs/http-server").HttpContext): void;
-            body: any;
-            name: string;
-            help?: string | undefined;
-            code?: string | undefined;
-            status: number;
-            toString(): string;
-            message: string;
-            stack?: string | undefined;
-            cause?: unknown;
-            readonly [Symbol.toStringTag]: string;
-        };
-        code: string;
-        invoke(body: any, status: number, code?: string | undefined): {
-            body: any;
-            name: string;
-            help?: string | undefined;
-            code?: string | undefined;
-            status: number;
-            toString(): string;
-            message: string;
-            stack?: string | undefined;
-            cause?: unknown;
-            readonly [Symbol.toStringTag]: string;
-        };
-        help?: string | undefined;
-        status?: number | undefined;
-        message?: string | undefined;
-        captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
-        prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
-        stackTraceLimit: number;
-    };
-    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;
-};
+export { configProvider } from './src/config_provider.js';
+/**
+ * Aggregated errors from all modules.
+ */
+export declare const errors: typeof encryptionErrors & typeof httpServerErrors & typeof appErrors & typeof aceErrors & typeof envErrors;
+/**
+ * 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,11 +1,23 @@
+/*
+ * @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';
 import { errors as encryptionErrors } from '@adonisjs/encryption';
 import { errors as httpServerErrors } from '@adonisjs/http-server';
-export { stubsRoot } from './stubs/index.js';
+export { stubsRoot } from './stubs/main.js';
 export { inject } from './modules/container.js';
 export { Ignitor } from './src/ignitor/main.js';
+export { configProvider } from './src/config_provider.js';
+/**
+ * Aggregated errors from all modules.
+ */
 export const errors = {
     ...encryptionErrors,
     ...httpServerErrors,
@@ -13,7 +25,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/codemods.d.ts

@@ -0,0 +1,59 @@
+import type { Logger } from '@poppinss/cliui';
+import type { CodeTransformer } from '@adonisjs/assembler/code_transformer';
+import type { AddMiddlewareEntry, EnvValidationDefinition } from '@adonisjs/assembler/types';
+import type { Application } from '../app.js';
+/**
+ * Codemods to modify AdonisJS source files. The codemod APIs relies on
+ * "@adonisjs/assembler" package and it must be installed as a dependency
+ * inside user application.
+ */
+export declare class Codemods {
+    #private;
+    constructor(app: Application<any>, cliLogger: Logger);
+    /**
+     * Define one or more environment variables
+     */
+    defineEnvVariables(environmentVariables: Record<string, number | string | boolean>): Promise<void>;
+    /**
+     * Define validations for the environment variables
+     */
+    defineEnvValidations(validations: EnvValidationDefinition): Promise<void>;
+    /**
+     * Define validations for the environment variables
+     */
+    registerMiddleware(stack: 'server' | 'router' | 'named', middleware: AddMiddlewareEntry[]): Promise<void>;
+    /**
+     * Update RCFile
+     */
+    updateRcFile(...params: Parameters<CodeTransformer['updateRcFile']>): Promise<void>;
+    /**
+     * Generats the stub
+     */
+    makeUsingStub(stubsRoot: string, stubPath: string, stubState: Record<string, any>): Promise<{
+        relativeFileName: string;
+        contents: string; /**
+         * Reference to lazily imported assembler code transformer
+         */
+        destination: any;
+        attributes: Record<string, any>;
+        status: "created";
+        skipReason: null;
+    } | {
+        relativeFileName: string;
+        contents: string;
+        destination: any;
+        attributes: Record<string, any>;
+        /**
+         * Reference to CLI logger to write logs
+         */
+        status: "force_created";
+        skipReason: null;
+    } | {
+        relativeFileName: string;
+        contents: string;
+        destination: any;
+        attributes: Record<string, any>;
+        status: "skipped";
+        skipReason: string;
+    }>;
+}

package/build/modules/ace/codemods.js

@@ -0,0 +1,133 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { slash } from '@poppinss/utils';
+import { EnvEditor } from '@adonisjs/env/editor';
+/**
+ * Codemods to modify AdonisJS source files. The codemod APIs relies on
+ * "@adonisjs/assembler" package and it must be installed as a dependency
+ * inside user application.
+ */
+export class Codemods {
+    /**
+     * Flag to know if assembler is installed as a
+     * peer dependency or not.
+     */
+    #isAssemblerInstalled;
+    /**
+     * Reference to lazily imported assembler code transformer
+     */
+    #codeTransformer;
+    /**
+     * Reference to AdonisJS application
+     */
+    #app;
+    /**
+     * Reference to CLI logger to write logs
+     */
+    #cliLogger;
+    constructor(app, cliLogger) {
+        this.#app = app;
+        this.#cliLogger = cliLogger;
+    }
+    /**
+     * Lazily imports assembler
+     */
+    async #importAssembler() {
+        if (this.#isAssemblerInstalled === undefined) {
+            this.#codeTransformer = await import('@adonisjs/assembler/code_transformer');
+            this.#isAssemblerInstalled = !!this.#codeTransformer;
+        }
+    }
+    /**
+     * Define one or more environment variables
+     */
+    async defineEnvVariables(environmentVariables) {
+        const editor = new EnvEditor(this.#app.appRoot);
+        await editor.load();
+        Object.keys(environmentVariables).forEach((key) => {
+            const value = environmentVariables[key];
+            editor.add(key, value);
+        });
+        await editor.save();
+        this.#cliLogger.action('update .env file').succeeded();
+    }
+    /**
+     * Define validations for the environment variables
+     */
+    async defineEnvValidations(validations) {
+        await this.#importAssembler();
+        if (!this.#codeTransformer) {
+            this.#cliLogger.warning('Cannot update "start/env.ts" file. Install "@adonisjs/assembler" to modify source files');
+            return;
+        }
+        const transformer = new this.#codeTransformer.CodeTransformer(this.#app.appRoot);
+        const action = this.#cliLogger.action('update start/env.ts file');
+        try {
+            await transformer.defineEnvValidations(validations);
+            action.succeeded();
+        }
+        catch (error) {
+            action.failed(error.message);
+        }
+    }
+    /**
+     * Define validations for the environment variables
+     */
+    async registerMiddleware(stack, middleware) {
+        await this.#importAssembler();
+        if (!this.#codeTransformer) {
+            this.#cliLogger.warning('Cannot update "start/kernel.ts" file. Install "@adonisjs/assembler" to modify source files');
+            return;
+        }
+        const transformer = new this.#codeTransformer.CodeTransformer(this.#app.appRoot);
+        const action = this.#cliLogger.action('update start/kernel.ts file');
+        try {
+            await transformer.addMiddlewareToStack(stack, middleware);
+            action.succeeded();
+        }
+        catch (error) {
+            action.failed(error.message);
+        }
+    }
+    /**
+     * Update RCFile
+     */
+    async updateRcFile(...params) {
+        await this.#importAssembler();
+        if (!this.#codeTransformer) {
+            this.#cliLogger.warning('Cannot update "adonisrc.ts" file. Install "@adonisjs/assembler" to modify source files');
+            return;
+        }
+        const transformer = new this.#codeTransformer.CodeTransformer(this.#app.appRoot);
+        const action = this.#cliLogger.action('update adonisrc.ts file');
+        try {
+            await transformer.updateRcFile(...params);
+            action.succeeded();
+        }
+        catch (error) {
+            action.failed(error.message);
+        }
+    }
+    /**
+     * Generats the stub
+     */
+    async makeUsingStub(stubsRoot, stubPath, stubState) {
+        const stubs = await this.#app.stubs.create();
+        const stub = await stubs.build(stubPath, { source: stubsRoot });
+        const output = await stub.generate(stubState);
+        const entityFileName = slash(this.#app.relativePath(output.destination));
+        const result = { ...output, relativeFileName: entityFileName };
+        if (output.status === 'skipped') {
+            this.#cliLogger.action(`create ${entityFileName}`).skipped(output.skipReason);
+            return result;
+        }
+        this.#cliLogger.action(`create ${entityFileName}`).succeeded();
+        return result;
+    }
+}

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

@@ -2,6 +2,10 @@ 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';
+/**
+ * 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;
@@ -9,12 +13,46 @@ export declare class BaseCommand extends AceBaseCommand {
     get staysAlive(): boolean | undefined;
     get startApp(): boolean | undefined;
     constructor(app: ApplicationService, kernel: Kernel, parsed: ParsedOutput, ui: UIPrimitives, prompt: Kernel['prompt']);
+    /**
+     * Creates the codemods module to modify source files
+     */
+    createCodemods(): Promise<import("./codemods.js").Codemods>;
+    /**
+     * 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;
+    /**
+     * 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;
@@ -22,6 +60,15 @@ export declare class ListCommand extends AceListCommand implements BaseCommand {
     get staysAlive(): boolean | undefined;
     get startApp(): boolean | undefined;
     constructor(app: ApplicationService, kernel: Kernel, parsed: ParsedOutput, ui: UIPrimitives, prompt: Kernel['prompt']);
+    /**
+     * Creates the codemods module to modify source files
+     */
+    createCodemods(): Promise<import("./codemods.js").Codemods>;
+    /**
+     * 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