@adonisjs/core 6.1.5-4 → 6.1.5-5

package/build/commands/make/provider.js

@@ -1,28 +1,41 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 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 BaseCommand from './_base.js';
 import { args } from '../../modules/ace/main.js';
-class MakeProvider extends BaseCommand {
+/**
+ * Make a new provider class
+ */
+export default class MakeProvider extends BaseCommand {
     static commandName = 'make:provider';
     static description = 'Create a new service provider class';
+    /**
+     * The stub to use for generating the provider class
+     */
     stubPath = 'make/provider/main.stub';
     async run() {
         const output = await this.generate(this.stubPath, {
             entity: this.app.generators.createEntity(this.name),
         });
+        /**
+         * Registering the provider with the `.adonisrc.json` file. We register
+         * the relative path, since we cannot be sure about aliases to exist.
+         */
         const providerImportPath = `./${output.relativeFileName.replace(/(\.js|\.ts)$/, '')}.js`;
         await this.app.rcFileEditor.addProvider(providerImportPath).save();
     }
 }
 __decorate([
-    args.string({ description: 'Name of the provider' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the provider' })
 ], MakeProvider.prototype, "name", void 0);
-export default MakeProvider;

package/build/commands/make/service.d.ts

@@ -1,9 +1,14 @@
 import BaseCommand from './_base.js';
+/**
+ * Make a new service class
+ */
 export default class MakeService extends BaseCommand {
     static commandName: string;
     static description: string;
     name: string;
+    /**
+     * The stub to use for generating the service class
+     */
     protected stubPath: string;
     run(): Promise<void>;
 }
-//# sourceMappingURL=service.d.ts.map

package/build/commands/make/service.js

@@ -1,17 +1,28 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 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 BaseCommand from './_base.js';
 import { args } from '../../modules/ace/main.js';
-class MakeService extends BaseCommand {
+/**
+ * Make a new service class
+ */
+export default class MakeService extends BaseCommand {
     static commandName = 'make:service';
     static description = 'Create a new service class';
+    /**
+     * The stub to use for generating the service class
+     */
     stubPath = 'make/service/main.stub';
     async run() {
         await this.generate(this.stubPath, {
@@ -20,7 +31,5 @@ class MakeService extends BaseCommand {
     }
 }
 __decorate([
-    args.string({ description: 'Name of the service' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the service' })
 ], MakeService.prototype, "name", void 0);
-export default MakeService;

package/build/commands/make/test.d.ts

@@ -1,11 +1,19 @@
 import BaseCommand from './_base.js';
+/**
+ * Make a new test file
+ */
 export default class MakeTest extends BaseCommand {
     #private;
     static commandName: string;
     static description: string;
     name: string;
     suite?: string;
+    /**
+     * The stub to use for generating the test file
+     */
     protected stubPath: string;
+    /**
+     * Executed by ace
+     */
     run(): Promise<void>;
 }
-//# sourceMappingURL=test.d.ts.map

package/build/commands/make/test.js

@@ -1,26 +1,47 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 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 BaseCommand from './_base.js';
 import { args, flags } from '../../modules/ace/main.js';
-class MakeTest extends BaseCommand {
+/**
+ * Make a new test file
+ */
+export default class MakeTest extends BaseCommand {
     static commandName = 'make:test';
     static description = 'Create a new Japa test file';
+    /**
+     * The stub to use for generating the test file
+     */
     stubPath = 'make/test/main.stub';
+    /**
+     * Returns the suite name for creating the test file
+     */
     async #getSuite() {
         if (this.suite) {
             return this.suite;
         }
+        /**
+         * Use the first suite from the rcFile when there is only
+         * one suite
+         */
         const rcFileSuites = this.app.rcFile.tests.suites;
         if (rcFileSuites.length === 1) {
             return rcFileSuites[0].name;
         }
+        /**
+         * Prompt the user to select a suite manually
+         */
         return this.prompt.choice('Select the suite for the test file', this.app.rcFile.tests.suites.map((suite) => {
             return suite.name;
         }), {
@@ -29,6 +50,9 @@ class MakeTest extends BaseCommand {
             },
         });
     }
+    /**
+     * Returns the directory path for the selected suite.
+     */
     async #getSuiteDirectory(directories) {
         if (directories.length === 1) {
             return directories[0];
@@ -39,18 +63,30 @@ class MakeTest extends BaseCommand {
             },
         });
     }
+    /**
+     * Find suite info from the rcFile file
+     */
     #findSuite(suiteName) {
         return this.app.rcFile.tests.suites.find((suite) => {
             return suite.name === suiteName;
         });
     }
+    /**
+     * Executed by ace
+     */
     async run() {
         const suite = this.#findSuite(await this.#getSuite());
+        /**
+         * Show error when mentioned/selected suite does not exist
+         */
         if (!suite) {
             this.logger.error(`The "${this.suite}" suite is not configured inside the .adonisrc.json file`);
             this.exitCode = 1;
             return;
         }
+        /**
+         * Generate entity
+         */
         await this.generate(this.stubPath, {
             entity: this.app.generators.createEntity(this.name),
             suite: {
@@ -60,11 +96,8 @@ class MakeTest extends BaseCommand {
     }
 }
 __decorate([
-    args.string({ description: 'Name of the test file' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the test file' })
 ], MakeTest.prototype, "name", void 0);
 __decorate([
-    flags.string({ description: 'The suite for which to create the test file' }),
-    __metadata("design:type", String)
+    flags.string({ description: 'The suite for which to create the test file' })
 ], MakeTest.prototype, "suite", void 0);
-export default MakeTest;

package/build/commands/serve.d.ts

@@ -1,5 +1,10 @@
 import type { CommandOptions } from '../types/ace.js';
 import { BaseCommand } from '../modules/ace/main.js';
+/**
+ * Serve command is used to run the AdonisJS HTTP server during development. The
+ * command under the hood runs the "bin/server.ts" file and watches for file
+ * system changes
+ */
 export default class Serve extends BaseCommand {
     #private;
     static commandName: string;
@@ -11,6 +16,8 @@ export default class Serve extends BaseCommand {
     clear?: boolean;
     assets?: boolean;
     assetsArgs?: string[];
+    /**
+     * Runs the HTTP server
+     */
     run(): Promise<void>;
 }
-//# sourceMappingURL=serve.d.ts.map

package/build/commands/serve.js

@@ -1,15 +1,25 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 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 { BaseCommand, flags } from '../modules/ace/main.js';
 import { detectAssetsBundler, importAssembler, importTypeScript } from '../src/internal_helpers.js';
-class Serve extends BaseCommand {
+/**
+ * Serve command is used to run the AdonisJS HTTP server during development. The
+ * command under the hood runs the "bin/server.ts" file and watches for file
+ * system changes
+ */
+export default class Serve extends BaseCommand {
     static commandName = 'serve';
     static description = 'Start the development HTTP server along with the file watcher to perform restarts on file change';
     static help = [
@@ -27,6 +37,9 @@ class Serve extends BaseCommand {
     static options = {
         staysAlive: true,
     };
+    /**
+     * Log a development dependency is missing
+     */
     #logMissingDevelopmentDependency(dependency) {
         this.logger.error([
             `Cannot find package "${dependency}"`,
@@ -36,6 +49,9 @@ class Serve extends BaseCommand {
             'If you are running your application in production, then use "node bin/server.js" command to start the HTTP server',
         ].join('\n'));
     }
+    /**
+     * Runs the HTTP server
+     */
     async run() {
         const assembler = await importAssembler(this.app);
         if (!assembler) {
@@ -52,7 +68,7 @@ class Serve extends BaseCommand {
                 ? {
                     serve: this.assets === false ? false : true,
                     driver: assetsBundler.name,
-                    cmd: assetsBundler.devServerCommand,
+                    cmd: assetsBundler.devServer.command,
                     args: this.assetsArgs || [],
                 }
                 : {
@@ -60,13 +76,26 @@ class Serve extends BaseCommand {
                 },
             metaFiles: this.app.rcFile.metaFiles,
         });
+        /**
+         * Share command logger with assembler, so that CLI flags like --no-ansi has
+         * similar impact for assembler logs as well.
+         */
         devServer.setLogger(this.logger);
+        /**
+         * Exit command when the dev server is closed
+         */
         devServer.onClose((exitCode) => {
             this.exitCode = exitCode;
         });
+        /**
+         * Exit command when the dev server crashes
+         */
         devServer.onError(() => {
             this.exitCode = 1;
         });
+        /**
+         * Start the development server
+         */
         if (this.watch) {
             const ts = await importTypeScript(this.app);
             if (!ts) {
@@ -82,33 +111,27 @@ class Serve extends BaseCommand {
     }
 }
 __decorate([
-    flags.boolean({ description: 'Watch filesystem and restart the HTTP server on file change' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Watch filesystem and restart the HTTP server on file change' })
 ], Serve.prototype, "watch", void 0);
 __decorate([
-    flags.boolean({ description: 'Use polling to detect filesystem changes' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Use polling to detect filesystem changes' })
 ], Serve.prototype, "poll", void 0);
 __decorate([
     flags.boolean({
         description: 'Clear the terminal for new logs after file change',
         showNegatedVariantInHelp: true,
         default: true,
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], Serve.prototype, "clear", void 0);
 __decorate([
     flags.boolean({
         description: 'Start assets bundler dev server',
         showNegatedVariantInHelp: true,
         default: true,
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], Serve.prototype, "assets", void 0);
 __decorate([
     flags.array({
         description: 'Define CLI arguments to pass to the assets bundler',
-    }),
-    __metadata("design:type", Array)
+    })
 ], Serve.prototype, "assetsArgs", void 0);
-export default Serve;

package/build/commands/test.d.ts

@@ -1,5 +1,9 @@
 import type { CommandOptions } from '../types/ace.js';
 import { BaseCommand } from '../modules/ace/main.js';
+/**
+ * Test command is used to run tests with optional file watcher. Under the
+ * hood, we run "bin/test.js" file.
+ */
 export default class Test extends BaseCommand {
     #private;
     static commandName: string;
@@ -16,6 +20,8 @@ export default class Test extends BaseCommand {
     clear?: boolean;
     assets?: boolean;
     assetsArgs?: string[];
+    /**
+     * Runs tests
+     */
     run(): Promise<void>;
 }
-//# sourceMappingURL=test.d.ts.map

package/build/commands/test.js

@@ -1,21 +1,33 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 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 { BaseCommand, flags, args } from '../modules/ace/main.js';
 import { detectAssetsBundler, importAssembler, importTypeScript } from '../src/internal_helpers.js';
-class Test extends BaseCommand {
+/**
+ * Test command is used to run tests with optional file watcher. Under the
+ * hood, we run "bin/test.js" file.
+ */
+export default class Test extends BaseCommand {
     static commandName = 'test';
     static description = 'Run tests along with the file watcher to re-run tests on file change';
     static options = {
         allowUnknownFlags: true,
         staysAlive: true,
     };
+    /**
+     * Log a development dependency is missing
+     */
     #logMissingDevelopmentDependency(dependency) {
         this.logger.error([
             `Cannot find package "${dependency}"`,
@@ -25,6 +37,9 @@ class Test extends BaseCommand {
             'If you are run tests inside a CI, make sure the NODE_ENV is set to "development"',
         ].join('\n'));
     }
+    /**
+     * Runs tests
+     */
     async run() {
         const assembler = await importAssembler(this.app);
         if (!assembler) {
@@ -39,9 +54,15 @@ class Test extends BaseCommand {
             scriptArgs: this.parsed.unknownFlags
                 .map((flag) => {
                 const value = this.parsed.flags[flag];
+                /**
+                 * Not mentioning value when value is "true"
+                 */
                 if (value === true) {
                     return [`--${flag}`];
                 }
+                /**
+                 * Repeating flag multiple times when value is an array
+                 */
                 if (Array.isArray(value)) {
                     return value.map((v) => [`--${flag}`, v]);
                 }
@@ -52,7 +73,7 @@ class Test extends BaseCommand {
                 ? {
                     serve: this.assets === false ? false : true,
                     driver: assetsBundler.name,
-                    cmd: assetsBundler.devServerCommand,
+                    cmd: assetsBundler.devServer.command,
                     args: this.assetsArgs || [],
                 }
                 : {
@@ -74,13 +95,26 @@ class Test extends BaseCommand {
             }),
             metaFiles: this.app.rcFile.metaFiles,
         });
+        /**
+         * Share command logger with assembler, so that CLI flags like --no-ansi has
+         * similar impact for assembler logs as well.
+         */
         testRunner.setLogger(this.logger);
+        /**
+         * Exit command when the test runner is closed
+         */
         testRunner.onClose((exitCode) => {
             this.exitCode = exitCode;
         });
+        /**
+         * Exit command when the dev server crashes
+         */
         testRunner.onError(() => {
             this.exitCode = 1;
         });
+        /**
+         * Start the test runner in watch mode
+         */
         if (this.watch) {
             const ts = await importTypeScript(this.app);
             if (!ts) {
@@ -99,57 +133,45 @@ __decorate([
     args.spread({
         description: 'Mention suite names to run tests for selected suites',
         required: false,
-    }),
-    __metadata("design:type", Array)
+    })
 ], Test.prototype, "suites", void 0);
 __decorate([
-    flags.array({ description: 'Filter tests by the filename' }),
-    __metadata("design:type", Array)
+    flags.array({ description: 'Filter tests by the filename' })
 ], Test.prototype, "files", void 0);
 __decorate([
-    flags.array({ description: 'Filter tests by tags' }),
-    __metadata("design:type", Array)
+    flags.array({ description: 'Filter tests by tags' })
 ], Test.prototype, "tags", void 0);
 __decorate([
-    flags.array({ description: 'Run tests that does not have mentioned tags' }),
-    __metadata("design:type", Array)
+    flags.array({ description: 'Run tests that does not have mentioned tags' })
 ], Test.prototype, "ignoreTags", void 0);
 __decorate([
-    flags.array({ description: 'Filter tests by parent group title' }),
-    __metadata("design:type", Array)
+    flags.array({ description: 'Filter tests by parent group title' })
 ], Test.prototype, "groups", void 0);
 __decorate([
-    flags.array({ description: 'Filter tests by test title' }),
-    __metadata("design:type", Array)
+    flags.array({ description: 'Filter tests by test title' })
 ], Test.prototype, "tests", void 0);
 __decorate([
-    flags.boolean({ description: 'Watch filesystem and re-run tests on file change' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Watch filesystem and re-run tests on file change' })
 ], Test.prototype, "watch", void 0);
 __decorate([
-    flags.boolean({ description: 'Use polling to detect filesystem changes' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Use polling to detect filesystem changes' })
 ], Test.prototype, "poll", void 0);
 __decorate([
     flags.boolean({
         description: 'Clear the terminal for new logs after file change',
         showNegatedVariantInHelp: true,
         default: true,
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], Test.prototype, "clear", void 0);
 __decorate([
     flags.boolean({
         description: 'Start assets bundler dev server.',
         showNegatedVariantInHelp: true,
         default: true,
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], Test.prototype, "assets", void 0);
 __decorate([
     flags.array({
         description: 'Define CLI arguments to pass to the assets bundler',
-    }),
-    __metadata("design:type", Array)
+    })
 ], Test.prototype, "assetsArgs", void 0);
-export default Test;

package/build/factories/app.d.ts

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

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

package/build/factories/bodyparser.d.ts

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

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

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

@@ -1,9 +1,11 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@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';
+/**
+ * Creates an instance of Ace kernel
+ */
 export declare class AceFactory {
     make(ignitor: Ignitor): Promise<Kernel>;
     make(appRoot: URL, options: IgnitorOptions): Promise<Kernel>;
 }
-//# sourceMappingURL=ace.d.ts.map

package/build/factories/core/ace.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 { IgnitorFactory } from './ignitor.js';
 import { Ignitor } from '../../src/ignitor/main.js';
 import { createAceKernel } from '../../modules/ace/create_kernel.js';
+/**
+ * Creates an instance of Ace kernel
+ */
 export class AceFactory {
     async make(ignitorOrAppRoot, options) {
         if (ignitorOrAppRoot instanceof Ignitor) {

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

@@ -1,17 +1,35 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@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>;
 };
+/**
+ * Ignitor factory creates an instance of the AdonisJS ignitor
+ */
 export declare class IgnitorFactory {
     #private;
+    /**
+     * Define preload actions to run.
+     */
     preload(action: (app: ApplicationService) => void | Promise<void>): this;
+    /**
+     * Merge custom factory parameters
+     */
     merge(params: Partial<FactoryParameters>): this;
+    /**
+     * Load core provider when booting the app
+     */
     withCoreProviders(): this;
+    /**
+     * Merge default config for the core features. A shallow merge
+     * is performed.
+     */
     withCoreConfig(): this;
+    /**
+     * Create ignitor instance
+     */
     create(appRoot: URL, options: IgnitorOptions): Ignitor;
 }
 export {};
-//# sourceMappingURL=ignitor.d.ts.map