@adonisjs/core 6.1.5-3 → 6.1.5-31

package/build/providers/vinejs_provider.js

@@ -0,0 +1,84 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import vine, { BaseLiteralType, Vine } from '@vinejs/vine';
+import { Request, RequestValidator } from '../modules/http/main.js';
+/**
+ * Checks if the value is an instance of multipart file
+ * from bodyparser.
+ */
+function isBodyParserFile(file) {
+    return !!(file && typeof file === 'object' && 'isMultipartFile' in file);
+}
+/**
+ * VineJS validation rule that validates the file to be an
+ * instance of BodyParser MultipartFile class.
+ */
+const isMultipartFile = vine.createRule((file, options, field) => {
+    /**
+     * Report error when value is not a field multipart
+     * file object
+     */
+    if (!isBodyParserFile(file)) {
+        field.report('The {{ field }} must be a file', 'file', field);
+        return;
+    }
+    const validationOptions = typeof options === 'function' ? options(field) : options;
+    /**
+     * Set size when it's defined in the options and missing
+     * on the file instance
+     */
+    if (file.sizeLimit === undefined && validationOptions.size) {
+        file.sizeLimit = validationOptions.size;
+    }
+    /**
+     * Set extensions when it's defined in the options and missing
+     * on the file instance
+     */
+    if (file.allowedExtensions === undefined && validationOptions.extnames) {
+        file.allowedExtensions = validationOptions.extnames;
+    }
+    /**
+     * Validate file
+     */
+    file.validate();
+    /**
+     * Report errors
+     */
+    file.errors.forEach((error) => {
+        field.report(error.message, `file.${error.type}`, field, validationOptions);
+    });
+});
+/**
+ * Represents a multipart file uploaded via multipart/form-data HTTP
+ * request.
+ */
+class VineMultipartFile extends BaseLiteralType {
+    #validationOptions;
+    constructor(validationOptions, options, validations) {
+        super(options, validations || [isMultipartFile(validationOptions || {})]);
+        this.#validationOptions = validationOptions;
+    }
+    clone() {
+        return new VineMultipartFile(this.#validationOptions, this.cloneOptions(), this.cloneValidations());
+    }
+}
+/**
+ * The file method is used to validate a field to be a valid
+ * multipart file.
+ */
+Vine.macro('file', function (options) {
+    return new VineMultipartFile(options);
+});
+/**
+ * The validate method can be used to validate the request
+ * data for the current request using VineJS validators
+ */
+Request.macro('validateUsing', function (...args) {
+    return new RequestValidator(this.ctx).validateUsing(...args);
+});

package/build/services/ace.d.ts

@@ -1,4 +1,3 @@
 import type { Kernel } from '../modules/ace/main.js';
 declare let ace: Kernel;
 export { ace as default };
-//# sourceMappingURL=ace.d.ts.map

package/build/services/ace.js

@@ -1,5 +1,20 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import app from './app.js';
 let ace;
+/**
+ * Returns a singleton instance of the ace kernel
+ * from the container.
+ *
+ * ace service is an instance of the "Kernel" class stored inside
+ * the "modules/ace/kernel.ts" file
+ */
 await app.booted(async () => {
     ace = await app.container.make('ace');
 });

package/build/services/app.d.ts

@@ -1,5 +1,12 @@
 import type { ApplicationService } from '../src/types.js';
 declare let app: ApplicationService;
+/**
+ * Set the application instance the app service should
+ * be using. Other services relies on the same app
+ * instance as well.
+ *
+ * app service is an instance of the "Application" exported from
+ * the "modules/app.ts" file.
+ */
 export declare function setApp(appService: ApplicationService): void;
 export { app as default };
-//# sourceMappingURL=app.d.ts.map

package/build/services/app.js

@@ -1,4 +1,20 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 let app;
+/**
+ * Set the application instance the app service should
+ * be using. Other services relies on the same app
+ * instance as well.
+ *
+ * app service is an instance of the "Application" exported from
+ * the "modules/app.ts" file.
+ */
 export function setApp(appService) {
     app = appService;
 }

package/build/services/config.d.ts

@@ -1,4 +1,3 @@
 import type { ApplicationService } from '../src/types.js';
 declare let config: ApplicationService['config'];
 export { config as default };
-//# sourceMappingURL=config.d.ts.map

package/build/services/config.js

@@ -1,5 +1,16 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import app from './app.js';
 let config;
+/**
+ * The config service uses the config instance from the app service
+ */
 await app.booted(() => {
     config = app.config;
 });

package/build/services/emitter.d.ts

@@ -1,4 +1,3 @@
 import type { EmitterService } from '../src/types.js';
 declare let emitter: EmitterService;
 export { emitter as default };
-//# sourceMappingURL=emitter.d.ts.map

package/build/services/emitter.js

@@ -1,5 +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 app from './app.js';
 let emitter;
+/**
+ * Returns a singleton instance of the emitter class
+ * from the container
+ */
 await app.booted(async () => {
     emitter = await app.container.make('emitter');
 });

package/build/services/encryption.d.ts

@@ -1,4 +1,3 @@
 import type { EncryptionService } from '../src/types.js';
 declare let encryption: EncryptionService;
 export { encryption as default };
-//# sourceMappingURL=encryption.d.ts.map

package/build/services/encryption.js

@@ -1,5 +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 app from './app.js';
 let encryption;
+/**
+ * Returns a singleton instance of the encryption class
+ * from the container
+ */
 await app.booted(async () => {
     encryption = await app.container.make('encryption');
 });

package/build/services/hash.d.ts

@@ -1,4 +1,3 @@
 import type { HashService } from '../src/types.js';
 declare let hash: HashService;
 export { hash as default };
-//# sourceMappingURL=hash.d.ts.map

package/build/services/hash.js

@@ -1,5 +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 app from './app.js';
 let hash;
+/**
+ * Returns a singleton instance of the Hash manager from the
+ * container
+ */
 await app.booted(async () => {
     hash = await app.container.make('hash');
 });

package/build/services/logger.d.ts

@@ -1,4 +1,3 @@
 import type { LoggerService } from '../src/types.js';
 declare let logger: LoggerService;
 export { logger as default };
-//# sourceMappingURL=logger.d.ts.map

package/build/services/logger.js

@@ -1,5 +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 app from './app.js';
 let logger;
+/**
+ * Returns a singleton instance of the logger class
+ * from the container
+ */
 await app.booted(async () => {
     logger = await app.container.make('logger');
 });

package/build/services/repl.d.ts

@@ -0,0 +1,3 @@
+import type { Repl } from '../modules/repl.js';
+declare let repl: Repl;
+export { repl as default };

package/build/services/repl.js

@@ -0,0 +1,18 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import app from './app.js';
+let repl;
+/**
+ * Returns a singleton instance of the Repl class from
+ * the container
+ */
+await app.booted(async () => {
+    repl = await app.container.make('repl');
+});
+export { repl as default };

package/build/services/router.d.ts

@@ -1,4 +1,3 @@
 import type { HttpRouterService } from '../src/types.js';
 declare let router: HttpRouterService;
 export { router as default };
-//# sourceMappingURL=router.d.ts.map

package/build/services/router.js

@@ -1,5 +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 app from './app.js';
 let router;
+/**
+ * Returns a singleton instance of the router class from
+ * the container
+ */
 await app.booted(async () => {
     router = await app.container.make('router');
 });

package/build/services/server.d.ts

@@ -1,4 +1,3 @@
 import type { HttpServerService } from '../src/types.js';
 declare let server: HttpServerService;
 export { server as default };
-//# sourceMappingURL=server.d.ts.map

package/build/services/server.js

@@ -1,5 +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 app from './app.js';
 let server;
+/**
+ * Returns a singleton instance of the HTTP server
+ * from the container
+ */
 await app.booted(async () => {
     server = await app.container.make('server');
 });

package/build/services/test_utils.d.ts

@@ -1,4 +1,3 @@
 import type { TestUtils } from '../src/test_utils/main.js';
 declare let testUtils: TestUtils;
 export { testUtils as default };
-//# sourceMappingURL=test_utils.d.ts.map

package/build/services/test_utils.js

@@ -1,5 +1,20 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import app from './app.js';
 let testUtils;
+/**
+ * Returns a singleton instance of the TestUtils class
+ * from the container.
+ *
+ * testUtils service is an instance of the "TestUtils" exported from
+ * the "src/test_utils/main.ts" file.
+ */
 await app.booted(async () => {
     testUtils = await app.container.make('testUtils');
 });

package/build/src/cli_formatters/routes_list.d.ts

@@ -1,5 +1,8 @@
-import { type Router } from '../../modules/http.js';
 import type { UIPrimitives } from '../../types/ace.js';
+import { type Router } from '../../modules/http/main.js';
+/**
+ * Shape of the serialized route specific to the formatter
+ */
 type SerializedRoute = {
     name: string;
     pattern: string;
@@ -14,6 +17,12 @@ type SerializedRoute = {
         method: string;
     };
 };
+/**
+ * Routes list formatter is used to format the routes to JSON or an ANSI string
+ * with pretty output.
+ *
+ * The decisions of colors, padding, alignment are all handled by the lists formatter
+ */
 export declare class RoutesListFormatter {
     #private;
     constructor(router: Router, ui: UIPrimitives, options: {
@@ -24,18 +33,31 @@ export declare class RoutesListFormatter {
         middleware?: string[];
         ignoreMiddleware?: string[];
     });
+    /**
+     * Formats routes as an array of objects. Routes are grouped by
+     * domain.
+     */
     formatAsJSON(): Promise<{
         domain: string;
         routes: SerializedRoute[];
     }[]>;
+    /**
+     * Format routes to ansi list of tables. Each domain has its own table
+     * with heading and rows. Each row has colums with colors and spacing
+     * around them.
+     */
     formatAsAnsiList(): Promise<{
         heading: string;
         rows: string[];
     }[]>;
+    /**
+     * Format routes to ansi tables. Each domain has its own table
+     * with heading and rows. Each row has colums with colors and spacing
+     * around them.
+     */
     formatAsAnsiTable(): Promise<{
         heading: string;
         table: ReturnType<UIPrimitives['table']>;
     }[]>;
 }
 export {};
-//# sourceMappingURL=routes_list.d.ts.map