@adonisjs/core 6.0.0-0 → 6.1.0-0

package/build/commands/commands.json

@@ -1 +1 @@
-{"commands":[{"commandName":"eject","description":"Eject scaffolding stubs to your application root","help":"","namespace":null,"aliases":[],"flags":[{"name":"pkg","flagName":"pkg","required":false,"type":"string","description":"Mention package name for searching stubs","default":"@adonisjs/core"}],"args":[{"name":"stubPath","argumentName":"stub-path","required":true,"description":"Path to the stubs directory or a single stub file","type":"string"}],"options":{},"filePath":"eject.js"},{"commandName":"generate:key","description":"Generate a secure random application key","help":"","namespace":"generate","aliases":[],"flags":[{"name":"show","flagName":"show","required":false,"type":"boolean","description":"Display the key on the terminal, instead of writing it to .env file"},{"name":"force","flagName":"force","required":false,"type":"boolean","description":"Force update .env file in production environment"}],"args":[],"options":{},"filePath":"generate_key.js"},{"commandName":"make:command","description":"Create a new ace command class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the command","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/command.js"},{"commandName":"make:controller","description":"Create a new HTTP controller class","help":"","namespace":"make","aliases":[],"flags":[{"name":"singular","flagName":"singular","required":false,"type":"boolean","description":"Convert controller class and file name to its singular form","alias":"r"},{"name":"resource","flagName":"resource","required":false,"type":"boolean","description":"Generate controller with resource actions","alias":"r"},{"name":"api","flagName":"api","required":false,"type":"boolean","description":"Generate controller with api resource actions","alias":"a"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"The name of the controller","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/controller.js"},{"commandName":"make:event","description":"Create a new event class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the event","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/event.js"},{"commandName":"make:listener","description":"Create a new event listener class","help":"","namespace":"make","aliases":[],"flags":[{"name":"event","flagName":"event","required":false,"type":"string","description":"Generate an event class alongside the listener","alias":"e"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the listener","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/listener.js"},{"commandName":"make:middleware","description":"Create a new middleware class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the middleware","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/middleware.js"},{"commandName":"make:provider","description":"Create a new service provider class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the provider","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/provider.js"}],"version":1}
+{"commands":[{"commandName":"configure","description":"Configure a package post installation","help":"","namespace":null,"aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Package name","type":"string"}],"options":{},"filePath":"configure.js"},{"commandName":"eject","description":"Eject scaffolding stubs to your application root","help":"","namespace":null,"aliases":[],"flags":[{"name":"pkg","flagName":"pkg","required":false,"type":"string","description":"Mention package name for searching stubs","default":"@adonisjs/core"}],"args":[{"name":"stubPath","argumentName":"stub-path","required":true,"description":"Path to the stubs directory or a single stub file","type":"string"}],"options":{},"filePath":"eject.js"},{"commandName":"generate:key","description":"Generate a secure random application key","help":"","namespace":"generate","aliases":[],"flags":[{"name":"show","flagName":"show","required":false,"type":"boolean","description":"Display the key on the terminal, instead of writing it to .env file"},{"name":"force","flagName":"force","required":false,"type":"boolean","description":"Force update .env file in production environment"}],"args":[],"options":{},"filePath":"generate_key.js"},{"commandName":"make:command","description":"Create a new ace command class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the command","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/command.js"},{"commandName":"make:controller","description":"Create a new HTTP controller class","help":"","namespace":"make","aliases":[],"flags":[{"name":"singular","flagName":"singular","required":false,"type":"boolean","description":"Convert controller class and file name to its singular form","alias":"r"},{"name":"resource","flagName":"resource","required":false,"type":"boolean","description":"Generate controller with resource actions","alias":"r"},{"name":"api","flagName":"api","required":false,"type":"boolean","description":"Generate controller with api resource actions","alias":"a"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"The name of the controller","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/controller.js"},{"commandName":"make:event","description":"Create a new event class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the event","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/event.js"},{"commandName":"make:listener","description":"Create a new event listener class","help":"","namespace":"make","aliases":[],"flags":[{"name":"event","flagName":"event","required":false,"type":"string","description":"Generate an event class alongside the listener","alias":"e"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the listener","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/listener.js"},{"commandName":"make:middleware","description":"Create a new middleware class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the middleware","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/middleware.js"},{"commandName":"make:provider","description":"Create a new service provider class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the provider","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/provider.js"}],"version":1}

package/build/commands/configure.d.ts

@@ -0,0 +1,17 @@
+import type { ApplicationService } from '../src/types.js';
+import { BaseCommand } from '../modules/ace/main.js';
+export default class Configure extends BaseCommand {
+    #private;
+    static commandName: string;
+    static description: string;
+    name: string;
+    stubsRoot: string;
+    publishStub(stubPath: string, stubData?: Record<string, any>): Promise<void>;
+    defineEnvVariables(environmentVariables: Record<string, number | string | boolean>): Promise<void>;
+    updateRcFile(callback: (rcFileEditor: ApplicationService['rcFileEditor']) => Promise<void> | void): Promise<void>;
+    listPackagesToInstall(packages: {
+        name: string;
+        isDevDependency: boolean;
+    }[]): void;
+    run(): Promise<void>;
+}

package/build/commands/configure.js

@@ -0,0 +1,105 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { slash } from '@poppinss/utils';
+import { EnvEditor } from '../modules/env.js';
+import { args, BaseCommand } from '../modules/ace/main.js';
+export default class Configure extends BaseCommand {
+    static commandName = 'configure';
+    static description = 'Configure a package post installation';
+    #getPackageSource(packageName) {
+        return this.app.import(packageName);
+    }
+    #getInstallationCommands(packages, packageManager, isDev) {
+        if (!packages.length) {
+            return '';
+        }
+        const devFlag = isDev ? ' -D' : '';
+        switch (packageManager) {
+            case 'npm':
+                return `${this.colors.yellow(`npm i${devFlag}`)} ${packages.join(' ')}`;
+            case 'yarn':
+                return `${this.colors.yellow(`yarn add${devFlag}`)} ${packages.join(' ')}`;
+            case 'pnpm':
+                return `${this.colors.yellow(`pnpm add${devFlag}`)} ${packages.join(' ')}`;
+        }
+    }
+    async publishStub(stubPath, stubData) {
+        const stub = await this.app.stubs.build(stubPath, {
+            source: this.stubsRoot,
+        });
+        const output = await stub.generate(stubData || {});
+        const entityFileName = slash(this.app.relativePath(output.destination));
+        if (output.status === 'skipped') {
+            return this.logger.action(`create ${entityFileName}`).skipped(output.skipReason);
+        }
+        this.logger.action(`create ${entityFileName}`).succeeded();
+    }
+    async defineEnvVariables(environmentVariables) {
+        const logs = [];
+        const editor = new EnvEditor(this.app.appRoot);
+        await editor.load();
+        Object.keys(environmentVariables).forEach((key) => {
+            const value = environmentVariables[key];
+            editor.add(key, value);
+            logs.push(`               ${this.colors.dim(`${key}=${value}`)}`);
+        });
+        await editor.save();
+        this.logger.action('update .env file').succeeded();
+        this.logger.log(logs.join('\n'));
+    }
+    async updateRcFile(callback) {
+        await callback(this.app.rcFileEditor);
+        await this.app.rcFileEditor.save();
+        this.logger.action('update .adonisrc.json file').succeeded();
+    }
+    listPackagesToInstall(packages) {
+        const devDependencies = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => name);
+        const prodDependencies = packages.filter((pkg) => !pkg.isDevDependency).map(({ name }) => name);
+        const instructions = this.ui.sticker().heading('Please install following packages');
+        [
+            this.colors.dim('# npm'),
+            this.#getInstallationCommands(devDependencies, 'npm', true),
+            this.#getInstallationCommands(prodDependencies, 'npm', false),
+            ' ',
+        ]
+            .concat([
+            this.colors.dim('# yarn'),
+            this.#getInstallationCommands(devDependencies, 'yarn', true),
+            this.#getInstallationCommands(prodDependencies, 'yarn', false),
+            ' ',
+        ])
+            .concat([
+            this.colors.dim('# pnpm'),
+            this.#getInstallationCommands(devDependencies, 'pnpm', true),
+            this.#getInstallationCommands(prodDependencies, 'pnpm', false),
+        ])
+            .filter((line) => line.length)
+            .forEach((line) => instructions.add(line));
+        instructions.render();
+    }
+    async run() {
+        const packageExports = await this.#getPackageSource(this.name);
+        if (!packageExports.configure) {
+            this.logger.warning(`Cannot configure "${this.name}" package. The package does not export the configure hook`);
+            return;
+        }
+        if (!packageExports.stubsRoot) {
+            this.logger.error(`Missing "stubsRoot" export from "${this.name}" package. The stubsRoot variable is required to lookup package stubs`);
+            this.exitCode = 1;
+            return;
+        }
+        this.stubsRoot = packageExports.stubsRoot;
+        await packageExports.configure(this);
+    }
+}
+__decorate([
+    args.string({ description: 'Package name' }),
+    __metadata("design:type", String)
+], Configure.prototype, "name", void 0);

package/build/factories/app.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/application/factories';

package/build/factories/app.js

@@ -0,0 +1 @@
+export * from '@adonisjs/application/factories';

package/build/factories/bodyparser.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/bodyparser/factories';

package/build/factories/bodyparser.js

@@ -0,0 +1 @@
+export * from '@adonisjs/bodyparser/factories';

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

@@ -0,0 +1,8 @@
+/// <reference types="node" resolution-mode="require"/>
+import { Ignitor } from '../../src/ignitor/main.js';
+import type { IgnitorOptions } from '../../src/types.js';
+import type { Kernel } from '../../modules/ace/kernel.js';
+export declare class AceFactory {
+    make(ignitor: Ignitor): Promise<Kernel>;
+    make(appRoot: URL, options: IgnitorOptions): Promise<Kernel>;
+}

package/build/factories/core/ace.js

@@ -0,0 +1,19 @@
+import { IgnitorFactory } from './ignitor.js';
+import { Ignitor } from '../../src/ignitor/main.js';
+import { createAceKernel } from '../../modules/ace/create_kernel.js';
+export class AceFactory {
+    async make(ignitorOrAppRoot, options) {
+        if (ignitorOrAppRoot instanceof Ignitor) {
+            const app = ignitorOrAppRoot.createApp('console');
+            await app.init();
+            return createAceKernel(app);
+        }
+        const app = new IgnitorFactory()
+            .withCoreConfig()
+            .withCoreProviders()
+            .create(ignitorOrAppRoot, options)
+            .createApp('console');
+        await app.init();
+        return createAceKernel(app);
+    }
+}

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

@@ -0,0 +1,16 @@
+/// <reference types="node" resolution-mode="require"/>
+import { Ignitor } from '../../src/ignitor/main.js';
+import type { ApplicationService, IgnitorOptions } from '../../src/types.js';
+type FactoryParameters = {
+    rcFileContents: Record<string, any>;
+    config: Record<string, any>;
+};
+export declare class IgnitorFactory {
+    #private;
+    preload(action: (app: ApplicationService) => void | Promise<void>): this;
+    merge(params: Partial<FactoryParameters>): this;
+    withCoreProviders(): this;
+    withCoreConfig(): this;
+    create(appRoot: URL, options: IgnitorOptions): Ignitor;
+}
+export {};

package/build/factories/core/ignitor.js

@@ -0,0 +1,76 @@
+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';
+export class IgnitorFactory {
+    #preloadActions = [];
+    #parameters = {};
+    #loadCoreProviders = false;
+    preload(action) {
+        this.#preloadActions.push(action);
+        return this;
+    }
+    #mergeCoreProviders(providers) {
+        return [
+            './providers/app_provider.js',
+            './providers/hash_provider.js',
+            './providers/http_provider.js',
+        ].concat(providers || []);
+    }
+    merge(params) {
+        if (params.config) {
+            this.#parameters.config = Object.assign(this.#parameters.config || {}, params.config);
+        }
+        if (params.rcFileContents) {
+            this.#parameters.rcFileContents = Object.assign(this.#parameters.rcFileContents || {}, params.rcFileContents);
+        }
+        return this;
+    }
+    withCoreProviders() {
+        this.#loadCoreProviders = true;
+        return this;
+    }
+    withCoreConfig() {
+        this.merge({
+            config: {
+                app: {
+                    appKey: 'averylongrandomsecretkey',
+                    http: defineHttpConfig({}),
+                },
+                validator: {},
+                bodyparser: defineBodyParserConfig({}),
+                hash: defineHashConfig({
+                    default: 'scrypt',
+                    list: {
+                        scrypt: {
+                            driver: 'scrypt',
+                        },
+                    },
+                }),
+                logger: defineLoggerConfig({
+                    default: 'app',
+                    loggers: {
+                        app: {},
+                    },
+                }),
+            },
+        });
+        return this;
+    }
+    create(appRoot, options) {
+        return new Ignitor(appRoot, options).tap((app) => {
+            app.booted(async () => {
+                for (let action of this.#preloadActions) {
+                    await action(app);
+                }
+            });
+            if (this.#loadCoreProviders) {
+                this.#parameters.rcFileContents = this.#parameters.rcFileContents || {};
+                this.#parameters.rcFileContents.providers = this.#mergeCoreProviders(this.#parameters.rcFileContents.providers);
+            }
+            this.#parameters.rcFileContents && app.rcContents(this.#parameters.rcFileContents);
+            this.#parameters.config && app.useConfig(this.#parameters.config);
+        });
+    }
+}

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

@@ -0,0 +1,4 @@
+export { AceFactory } from './ace.js';
+export { StubsFactory } from '../stubs.js';
+export { IgnitorFactory } from './ignitor.js';
+export { TestUtilsFactory } from './test_utils.js';

package/build/factories/core/main.js

@@ -0,0 +1,4 @@
+export { AceFactory } from './ace.js';
+export { StubsFactory } from '../stubs.js';
+export { IgnitorFactory } from './ignitor.js';
+export { TestUtilsFactory } from './test_utils.js';

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

@@ -0,0 +1,8 @@
+/// <reference 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';
+export declare class TestUtilsFactory {
+    create(ignitor: Ignitor): TestUtils;
+    create(appRoot: URL, options: IgnitorOptions): TestUtils;
+}

package/build/factories/core/test_utils.js

@@ -0,0 +1,15 @@
+import { Ignitor } from '../../index.js';
+import { IgnitorFactory } from './ignitor.js';
+import { TestUtils } from '../../src/test_utils/main.js';
+export class TestUtilsFactory {
+    create(ignitorOrAppRoot, options) {
+        if (ignitorOrAppRoot instanceof Ignitor) {
+            return new TestUtils(ignitorOrAppRoot.createApp('test'));
+        }
+        return new TestUtils(new IgnitorFactory()
+            .withCoreConfig()
+            .withCoreProviders()
+            .create(ignitorOrAppRoot, options)
+            .createApp('console'));
+    }
+}

package/build/factories/encryption.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/encryption/factories';

package/build/factories/encryption.js

@@ -0,0 +1 @@
+export * from '@adonisjs/encryption/factories';

package/build/factories/events.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/events/factories';

package/build/factories/events.js

@@ -0,0 +1 @@
+export * from '@adonisjs/events/factories';

package/build/factories/hash.d.ts

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

package/build/factories/hash.js

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

package/build/factories/http.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/http-server/factories';

package/build/factories/http.js

@@ -0,0 +1 @@
+export * from '@adonisjs/http-server/factories';

package/build/factories/logger.d.ts

@@ -0,0 +1 @@
+export * from '@adonisjs/logger/factories';

package/build/factories/logger.js

@@ -0,0 +1 @@
+export * from '@adonisjs/logger/factories';

package/build/factories/stubs.d.ts

@@ -0,0 +1,15 @@
+import type { ApplicationService } from '../src/types.js';
+type FactoryParameters = {
+    app: ApplicationService;
+};
+export declare class StubsFactory {
+    #private;
+    merge(params: Partial<FactoryParameters>): this;
+    prepare(stubPath: string, data: Record<string, any>): Promise<{
+        contents: any;
+        destination: any;
+        force: any;
+        attributes: any;
+    }>;
+}
+export {};

package/build/factories/stubs.js

@@ -0,0 +1,20 @@
+import { AppFactory } from '@adonisjs/application/factories';
+import { stubsRoot } from '../index.js';
+export class StubsFactory {
+    #parameters = {};
+    #getApp() {
+        return this.#parameters.app || new AppFactory().create(new URL('./', import.meta.url), () => { });
+    }
+    merge(params) {
+        this.#parameters = Object.assign(this.#parameters, params);
+        return this;
+    }
+    async prepare(stubPath, data) {
+        const app = this.#getApp();
+        await app.init();
+        const stub = await app.stubs.build(stubPath, {
+            source: stubsRoot,
+        });
+        return stub.prepare(data);
+    }
+}

package/build/modules/ace/commands.js

@@ -19,7 +19,8 @@ export class BaseCommand extends AceBaseCommand {
         try {
             this.prepare && (await this.app.container.call(this, 'prepare'));
             this.interact && (await this.app.container.call(this, 'interact'));
-            this.result = await this.app.container.call(this, 'run');
+            const result = await this.app.container.call(this, 'run');
+            this.result = this.result === undefined ? result : this.result;
             this.exitCode = this.exitCode ?? 0;
         }
         catch (error) {

package/build/src/helpers/main.d.ts

@@ -1,2 +1,2 @@
 export { default as cuid } from 'cuid';
-export { safeEqual, compose, base64, fsImportAll, fsReadAll } from '@poppinss/utils';
+export { safeEqual, compose, base64, fsImportAll, fsReadAll, slash } from '@poppinss/utils';

package/build/src/helpers/main.js

@@ -1,2 +1,2 @@
 export { default as cuid } from 'cuid';
-export { safeEqual, compose, base64, fsImportAll, fsReadAll } from '@poppinss/utils';
+export { safeEqual, compose, base64, fsImportAll, fsReadAll, slash } from '@poppinss/utils';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/core",
-  "version": "6.0.0-0",
+  "version": "6.1.0-0",
   "description": "Core of AdonisJS",
   "main": "build/index.js",
   "type": "module",
@@ -10,6 +10,7 @@
     "build/legacy",
     "build/providers",
     "build/services",
+    "build/factories",
     "build/types",
     "build/src",
     "build/stubs",
@@ -19,6 +20,15 @@
   "exports": {
     ".": "./build/index.js",
     "./commands": "./build/commands/main.js",
+    "./commands/*": "./build/commands/*.js",
+    "./factories": "./build/factories/core/main.js",
+    "./factories/app": "./build/factories/app.js",
+    "./factories/bodyparser": "./build/factories/bodyparser.js",
+    "./factories/encryption": "./build/factories/encryption.js",
+    "./factories/events": "./build/factories/events.js",
+    "./factories/hash": "./build/factories/hash.js",
+    "./factories/http": "./build/factories/http.js",
+    "./factories/logger": "./build/factories/logger.js",
     "./types": "./build/src/types.js",
     "./types/ace": "./build/types/ace.js",
     "./types/app": "./build/types/app.js",
@@ -221,7 +231,7 @@
     "exclude": [
       "tests/**",
       "build/**",
-      "test_factories/**",
+      "factories/**",
       ".yalc/**"
     ]
   }