@adonisjs/core 6.1.5-3 → 6.1.5-5

package/build/commands/list/routes.js

@@ -1,17 +1,29 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 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 { args, BaseCommand, flags } from '../../modules/ace/main.js';
 import { RoutesListFormatter } from '../../src/cli_formatters/routes_list.js';
-class ListRoutes extends BaseCommand {
+/**
+ * The list routes command is used to view the list of registered routes
+ */
+export default class ListRoutes extends BaseCommand {
     static commandName = 'list:routes';
     static description = 'List application routes. This command will boot the application in the console environment';
+    /**
+     * Making sure to start the application so that the routes are
+     * imported
+     */
     static options = {
         startApp: true,
     };
@@ -22,10 +34,16 @@ class ListRoutes extends BaseCommand {
             middleware: this.middleware,
             match: this.match,
         });
+        /**
+         * Display as JSON
+         */
         if (this.json) {
             this.logger.log(JSON.stringify(await formatter.formatAsJSON(), null, 2));
             return;
         }
+        /**
+         * Display as a standard table
+         */
         if (this.table) {
             const tables = await formatter.formatAsAnsiTable();
             tables.forEach((table) => {
@@ -38,6 +56,9 @@ class ListRoutes extends BaseCommand {
             });
             return;
         }
+        /**
+         * Display as a list
+         */
         const list = await formatter.formatAsAnsiList();
         list.forEach((item) => {
             this.logger.log('');
@@ -53,27 +74,21 @@ __decorate([
     args.string({
         description: 'Find routes matching the given keyword. Route name, pattern and controller name will be searched against the keyword',
         required: false,
-    }),
-    __metadata("design:type", String)
+    })
 ], ListRoutes.prototype, "match", void 0);
 __decorate([
     flags.array({
         description: 'View routes that includes all the mentioned middleware names. Use * to see routes that are using one or more middleware',
-    }),
-    __metadata("design:type", Array)
+    })
 ], ListRoutes.prototype, "middleware", void 0);
 __decorate([
     flags.array({
         description: 'View routes that does not include all the mentioned middleware names. Use * to see routes that are using zero middleware',
-    }),
-    __metadata("design:type", Array)
+    })
 ], ListRoutes.prototype, "ignoreMiddleware", void 0);
 __decorate([
-    flags.boolean({ description: 'Get routes list as a JSON string' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Get routes list as a JSON string' })
 ], ListRoutes.prototype, "json", void 0);
 __decorate([
-    flags.boolean({ description: 'View list of routes as a table' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'View list of routes as a table' })
 ], ListRoutes.prototype, "table", void 0);
-export default ListRoutes;

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

@@ -1,28 +1,36 @@
 import { BaseCommand } from '../../modules/ace/main.js';
 import type { CommandOptions } from '../../types/ace.js';
+/**
+ * Base command for make commands
+ */
 export default abstract class extends BaseCommand {
+    /**
+     * Allowing unknown flags to enable custom workflows
+     */
     static options: CommandOptions;
+    /**
+     * Generates the resource from stub
+     */
     protected generate(stubPath: string, stubState: Record<string, any>): Promise<{
         relativeFileName: string;
         contents: any;
         destination: any;
         attributes: any;
-        status: "skipped";
-        skipReason: string;
+        status: "created";
+        skipReason: null;
     } | {
         relativeFileName: string;
         contents: any;
         destination: any;
         attributes: any;
-        status: "created";
+        status: "force_created";
         skipReason: null;
     } | {
         relativeFileName: string;
         contents: any;
         destination: any;
         attributes: any;
-        status: "force_created";
-        skipReason: null;
+        status: "skipped";
+        skipReason: string;
     }>;
 }
-//# sourceMappingURL=_base.d.ts.map

package/build/commands/make/_base.js

@@ -1,28 +1,27 @@
-import { slash } from '@poppinss/utils';
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { stubsRoot } from '../../stubs/index.js';
 import { BaseCommand } from '../../modules/ace/main.js';
-class default_1 extends BaseCommand {
+/**
+ * Base command for make commands
+ */
+export default class default_1 extends BaseCommand {
+    /**
+     * Allowing unknown flags to enable custom workflows
+     */
     static options = {
         allowUnknownFlags: true,
     };
+    /**
+     * Generates the resource from stub
+     */
     async generate(stubPath, stubState) {
-        const stub = await this.app.stubs.build(stubPath, { source: stubsRoot });
-        const output = await stub.generate(Object.assign({
-            flags: this.parsed.flags,
-        }, stubState));
-        const entityFileName = slash(this.app.relativePath(output.destination));
-        if (output.status === 'skipped') {
-            this.logger.action(`create ${entityFileName}`).skipped(output.skipReason);
-            return {
-                ...output,
-                relativeFileName: entityFileName,
-            };
-        }
-        this.logger.action(`create ${entityFileName}`).succeeded();
-        return {
-            ...output,
-            relativeFileName: entityFileName,
-        };
+        return this.makeUsingStub(stubPath, stubState, stubsRoot);
     }
 }
-export default default_1;

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

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

package/build/commands/make/command.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 MakeCommand extends BaseCommand {
+/**
+ * Make a new ace command
+ */
+export default class MakeCommand extends BaseCommand {
     static commandName = 'make:command';
     static description = 'Create a new ace command class';
+    /**
+     * The stub to use for generating the command class
+     */
     stubPath = 'make/command/main.stub';
     async run() {
         await this.generate(this.stubPath, {
@@ -20,7 +31,5 @@ class MakeCommand extends BaseCommand {
     }
 }
 __decorate([
-    args.string({ description: 'Name of the command' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the command' })
 ], MakeCommand.prototype, "name", void 0);
-export default MakeCommand;

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

@@ -1,4 +1,7 @@
 import BaseCommand from './_base.js';
+/**
+ * The make controller command to create an HTTP controller
+ */
 export default class MakeController extends BaseCommand {
     static commandName: string;
     static description: string;
@@ -6,8 +9,13 @@ export default class MakeController extends BaseCommand {
     singular: boolean;
     resource: boolean;
     api: boolean;
+    /**
+     * The stub to use for generating the controller
+     */
     protected stubPath: string;
+    /**
+     * Preparing the command state
+     */
     prepare(): Promise<void>;
     run(): Promise<void>;
 }
-//# sourceMappingURL=controller.d.ts.map

package/build/commands/make/controller.js

@@ -1,25 +1,48 @@
+/*
+ * @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 MakeController extends BaseCommand {
+/**
+ * The make controller command to create an HTTP controller
+ */
+export default class MakeController extends BaseCommand {
     static commandName = 'make:controller';
     static description = 'Create a new HTTP controller class';
+    /**
+     * The stub to use for generating the controller
+     */
     stubPath = 'make/controller/main.stub';
+    /**
+     * Preparing the command state
+     */
     async prepare() {
+        /**
+         * Use resource stub
+         */
         if (this.resource) {
             this.stubPath = 'make/controller/resource.stub';
         }
+        /**
+         * Use api stub
+         */
         if (this.api) {
             this.stubPath = 'make/controller/api.stub';
         }
+        /**
+         * Log warning when both flags are used together
+         */
         if (this.resource && this.api) {
             this.logger.warning('--api and --resource flags cannot be used together. Ignoring --resource');
         }
@@ -31,28 +54,23 @@ class MakeController extends BaseCommand {
     }
 }
 __decorate([
-    args.string({ description: 'The name of the controller' }),
-    __metadata("design:type", String)
+    args.string({ description: 'The name of the controller' })
 ], MakeController.prototype, "name", void 0);
 __decorate([
     flags.boolean({
         description: 'Convert controller class and file name to its singular form',
         alias: 'r',
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], MakeController.prototype, "singular", void 0);
 __decorate([
     flags.boolean({
         description: 'Generate controller with resource actions',
         alias: 'r',
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], MakeController.prototype, "resource", void 0);
 __decorate([
     flags.boolean({
         description: 'Generate controller with api resource actions',
         alias: 'a',
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], MakeController.prototype, "api", void 0);
-export default MakeController;

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

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

package/build/commands/make/event.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 MakeEvent extends BaseCommand {
+/**
+ * The make event command to create a class based event
+ */
+export default class MakeEvent extends BaseCommand {
     static commandName = 'make:event';
     static description = 'Create a new event class';
+    /**
+     * The stub to use for generating the event
+     */
     stubPath = 'make/event/main.stub';
     async run() {
         await this.generate(this.stubPath, {
@@ -20,7 +31,5 @@ class MakeEvent extends BaseCommand {
     }
 }
 __decorate([
-    args.string({ description: 'Name of the event' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the event' })
 ], MakeEvent.prototype, "name", void 0);
-export default MakeEvent;

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

@@ -1,11 +1,17 @@
 import BaseCommand from './_base.js';
+/**
+ * The make listener command to create a class based event
+ * listener
+ */
 export default class MakeListener extends BaseCommand {
     static commandName: string;
     static description: string;
     name: string;
     event: string;
+    /**
+     * The stub to use for generating the event listener
+     */
     protected stubPath: string;
     prepare(): void;
     run(): Promise<void>;
 }
-//# sourceMappingURL=listener.d.ts.map

package/build/commands/make/listener.js

@@ -1,17 +1,29 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 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 MakeListener extends BaseCommand {
+/**
+ * The make listener command to create a class based event
+ * listener
+ */
+export default class MakeListener extends BaseCommand {
     static commandName = 'make:listener';
     static description = 'Create a new event listener class';
+    /**
+     * The stub to use for generating the event listener
+     */
     stubPath = 'make/listener/main.stub';
     prepare() {
         if (this.event) {
@@ -21,6 +33,9 @@ class MakeListener extends BaseCommand {
     async run() {
         if (this.event) {
             const { exitCode } = await this.kernel.exec('make:event', [this.event]);
+            /**
+             * Create listener only when make:event is completed successfully
+             */
             if (exitCode === 0) {
                 const eventEntity = this.app.generators.createEntity(this.event);
                 await this.generate(this.stubPath, {
@@ -36,14 +51,11 @@ class MakeListener extends BaseCommand {
     }
 }
 __decorate([
-    args.string({ description: 'Name of the listener' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the listener' })
 ], MakeListener.prototype, "name", void 0);
 __decorate([
     flags.string({
         description: 'Generate an event class alongside the listener',
         alias: 'e',
-    }),
-    __metadata("design:type", String)
+    })
 ], MakeListener.prototype, "event", void 0);
-export default MakeListener;

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

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

package/build/commands/make/middleware.js

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

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

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

package/build/commands/make/prldfile.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 MakePreloadFile extends BaseCommand {
+/**
+ * Make a new preload file
+ */
+export default class MakePreloadFile extends BaseCommand {
     static commandName = 'make:prldfile';
     static description = 'Create a new preload file inside the start directory';
+    /**
+     * The stub to use for generating the preload file
+     */
     stubPath = 'make/preload_file/main.stub';
     async run() {
         const output = await this.generate(this.stubPath, {
             entity: this.app.generators.createEntity(this.name),
         });
+        /**
+         * Registering the preload file with the `.adonisrc.json` file. We register
+         * the relative path, since we cannot be sure about aliases to exist.
+         */
         const preloadImportPath = `./${output.relativeFileName.replace(/(\.js|\.ts)$/, '')}.js`;
         await this.app.rcFileEditor.addPreloadFile(preloadImportPath).save();
     }
 }
 __decorate([
-    args.string({ description: 'Name of the preload file' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the preload file' })
 ], MakePreloadFile.prototype, "name", void 0);
-export default MakePreloadFile;

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

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