@adonisjs/core 5.8.9 → 5.9.0

package/build/adonis-typings/assets-manager.d.ts

@@ -27,6 +27,10 @@ declare module '@ioc:Adonis/Core/AssetsManager' {
          * A boolean to know if entry points are supported or not
          */
         hasEntrypoints: boolean;
+        /**
+         * Attributes to apply to the script tag
+         */
+        scriptAttributes: Record<string, any>;
         /**
          * The current version of assets.
          */

package/build/commands/ListRoutes/index.d.ts

@@ -4,7 +4,7 @@ import type { RouteNode } from '@ioc:Adonis/Core/Route';
 /**
  * Shape of a route serialized by the ListRoute JSON serializer
  */
-export declare type SerializedRoute = {
+export type SerializedRoute = {
     domain: string;
     name: string;
     pattern: string;

package/build/src/AssetsManager/Drivers/Base.d.ts

@@ -0,0 +1,27 @@
+import { ApplicationContract } from '@ioc:Adonis/Core/Application';
+export declare abstract class BaseDriver {
+    protected application: ApplicationContract;
+    /**
+     * We cache the manifest contents and the entrypoints contents
+     * in production
+     */
+    private manifestCache?;
+    private entrypointsCache?;
+    /**
+     * Path to the output public dir. Defaults to `/public/assets`
+     */
+    publicPath: string;
+    constructor(application: ApplicationContract);
+    /**
+     * Reads the file contents as JSON
+     */
+    protected readFileAsJSON(filePath: string): any;
+    /**
+     * Returns the manifest contents as object
+     */
+    manifest(): any;
+    /**
+     * Returns the entrypoints contents as object
+     */
+    entryPoints(): any;
+}

package/build/src/AssetsManager/Drivers/Base.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseDriver = void 0;
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+class BaseDriver {
+    constructor(application) {
+        this.application = application;
+        /**
+         * Path to the output public dir. Defaults to `/public/assets`
+         */
+        this.publicPath = this.application.publicPath('assets');
+    }
+    /**
+     * Reads the file contents as JSON
+     */
+    readFileAsJSON(filePath) {
+        if (!(0, fs_extra_1.pathExistsSync)(filePath)) {
+            throw new Error(`Cannot find "${filePath}" file. Make sure you are compiling assets`);
+        }
+        return JSON.parse((0, fs_extra_1.readFileSync)(filePath, 'utf-8'));
+    }
+    /**
+     * Returns the manifest contents as object
+     */
+    manifest() {
+        /**
+         * Use in-memory cache when exists
+         */
+        if (this.manifestCache) {
+            this.application.logger.trace('reading manifest from cache');
+            return this.manifestCache;
+        }
+        const manifest = this.readFileAsJSON((0, path_1.join)(this.publicPath, 'manifest.json'));
+        this.application.logger.trace('reading manifest from %s', this.publicPath);
+        /**
+         * Cache manifest in production to avoid re-reading the file from disk
+         */
+        if (this.application.inProduction) {
+            this.manifestCache = manifest;
+        }
+        return manifest;
+    }
+    /**
+     * Returns the entrypoints contents as object
+     */
+    entryPoints() {
+        /**
+         * Use in-memory cache when exists
+         */
+        if (this.entrypointsCache) {
+            this.application.logger.trace('reading entrypoints from cache');
+            return this.entrypointsCache;
+        }
+        const entryPoints = this.readFileAsJSON((0, path_1.join)(this.publicPath, 'entrypoints.json'));
+        this.application.logger.trace('reading entrypoints from %s', this.publicPath);
+        /**
+         * Cache entrypoints file in production to avoid re-reading the file from disk
+         */
+        if (this.application.inProduction) {
+            this.entrypointsCache = entryPoints.entrypoints || {};
+        }
+        return entryPoints.entrypoints || {};
+    }
+}
+exports.BaseDriver = BaseDriver;

package/build/src/AssetsManager/Drivers/Encore.d.ts

@@ -1,5 +1,5 @@
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
 import { AssetsDriverContract } from '@ioc:Adonis/Core/AssetsManager';
+import { BaseDriver } from './Base';
 /**
  * Resolves entry points and assets path for webpack encore. Relies
  * on the "manifest.json" and "entrypoints.json" files.
@@ -28,45 +28,25 @@ import { AssetsDriverContract } from '@ioc:Adonis/Core/AssetsManager';
  *  }
  * ```
  */
-export declare class EncoreDriver implements AssetsDriverContract {
-    private application;
-    /**
-     * We cache the manifest contents and the entrypoints contents
-     * in production
-     */
-    private manifestCache?;
-    private entrypointsCache?;
+export declare class EncoreDriver extends BaseDriver implements AssetsDriverContract {
     name: string;
     /**
      * Encore driver has support for entrypoints
      */
     hasEntrypoints: boolean;
     /**
-     * Path to the output public dir. Defaults to `/public/assets`
+     * Attributes to apply to the script tag
      */
-    publicPath: string;
+    scriptAttributes: Record<string, any>;
     /**
      * Returns the version of the assets by hashing the manifest file
      * contents
      */
     get version(): string;
-    constructor(application: ApplicationContract);
-    /**
-     * Reads the file contents as JSON
-     */
-    private readFileAsJSON;
-    /**
-     * Returns the manifest contents as object
-     */
-    manifest(): any;
     /**
      * Returns path to a given asset file
      */
     assetPath(name: string): string;
-    /**
-     * Returns the entrypoints contents as object
-     */
-    entryPoints(): any;
     /**
      * Returns list for all the javascript files for a given entry point
      */

package/build/src/AssetsManager/Drivers/Encore.js

@@ -9,9 +9,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EncoreDriver = void 0;
-const path_1 = require("path");
 const crypto_1 = require("crypto");
-const fs_extra_1 = require("fs-extra");
+const Base_1 = require("./Base");
 /**
  * Resolves entry points and assets path for webpack encore. Relies
  * on the "manifest.json" and "entrypoints.json" files.
@@ -40,18 +39,18 @@ const fs_extra_1 = require("fs-extra");
  *  }
  * ```
  */
-class EncoreDriver {
-    constructor(application) {
-        this.application = application;
+class EncoreDriver extends Base_1.BaseDriver {
+    constructor() {
+        super(...arguments);
         this.name = 'encore';
         /**
          * Encore driver has support for entrypoints
          */
         this.hasEntrypoints = true;
         /**
-         * Path to the output public dir. Defaults to `/public/assets`
+         * Attributes to apply to the script tag
          */
-        this.publicPath = this.application.publicPath('assets');
+        this.scriptAttributes = {};
     }
     /**
      * Returns the version of the assets by hashing the manifest file
@@ -60,39 +59,6 @@ class EncoreDriver {
     get version() {
         return (0, crypto_1.createHash)('md5').update(JSON.stringify(this.manifest())).digest('hex').slice(0, 10);
     }
-    /**
-     * Reads the file contents as JSON
-     */
-    readFileAsJSON(filePath) {
-        /**
-         * Ensure the file exists, otherwise raise a meaningful exception
-         */
-        if (!(0, fs_extra_1.pathExistsSync)(filePath)) {
-            throw new Error(`Cannot find "${filePath}" file. Make sure you are compiling assets`);
-        }
-        return JSON.parse((0, fs_extra_1.readFileSync)(filePath, 'utf-8'));
-    }
-    /**
-     * Returns the manifest contents as object
-     */
-    manifest() {
-        /**
-         * Use in-memory cache when exists
-         */
-        if (this.manifestCache) {
-            this.application.logger.trace('reading encore manifest from cache');
-            return this.manifestCache;
-        }
-        const manifest = this.readFileAsJSON((0, path_1.join)(this.publicPath, 'manifest.json'));
-        this.application.logger.trace('reading encore manifest from %s', this.publicPath);
-        /**
-         * Cache manifest in production to avoid re-reading the file from disk
-         */
-        if (this.application.inProduction) {
-            this.manifestCache = manifest;
-        }
-        return manifest;
-    }
     /**
      * Returns path to a given asset file
      */
@@ -103,27 +69,6 @@ class EncoreDriver {
         }
         return manifest[name];
     }
-    /**
-     * Returns the entrypoints contents as object
-     */
-    entryPoints() {
-        /**
-         * Use in-memory cache when exists
-         */
-        if (this.entrypointsCache) {
-            this.application.logger.trace('reading encore entrypoints from cache');
-            return this.entrypointsCache;
-        }
-        const entryPoints = this.readFileAsJSON((0, path_1.join)(this.publicPath, 'entrypoints.json'));
-        this.application.logger.trace('reading encore entrypoints from %s', this.publicPath);
-        /**
-         * Cache entrypoints file in production to avoid re-reading the file from disk
-         */
-        if (this.application.inProduction) {
-            this.entrypointsCache = entryPoints.entrypoints || {};
-        }
-        return entryPoints.entrypoints || {};
-    }
     /**
      * Returns list for all the javascript files for a given entry point
      */

package/build/src/AssetsManager/Drivers/Fake.d.ts

@@ -12,6 +12,7 @@ export declare class FakeDriver implements AssetsDriverContract {
     name: string;
     hasEntrypoints: boolean;
     publicPath: string;
+    scriptAttributes: Record<string, any>;
     get version(): string;
     constructor(application: ApplicationContract);
     /**

package/build/src/AssetsManager/Drivers/Fake.js

@@ -17,14 +17,15 @@ exports.FakeDriver = void 0;
  * testing without compiling the real assets
  */
 class FakeDriver {
+    get version() {
+        return '';
+    }
     constructor(application) {
         this.application = application;
         this.name = 'fake';
         this.hasEntrypoints = true;
         this.publicPath = this.application.publicPath('assets');
-    }
-    get version() {
-        return '';
+        this.scriptAttributes = {};
     }
     /**
      * Returns the manifest contents as object

package/build/src/AssetsManager/Drivers/Vite.d.ts

@@ -0,0 +1,84 @@
+import { AssetsDriverContract } from '@ioc:Adonis/Core/AssetsManager';
+import { BaseDriver } from './Base';
+/**
+ * Resolves entry points and assets path for Vite. Relies
+ * on the "manifest.json" and "entrypoints.json" files.
+ *
+ **********************************************************************
+ * The driver assumes following format for the manifest.json file
+ **********************************************************************
+ *
+ * ```json
+ *  {
+ *    "assetName": {
+ *      "file": "path",
+ *      "src": "path"
+ *    },
+ *    ...
+ *  }
+ * ```
+ **********************************************************************
+ * The driver assumes following format for the entrypoints.json file
+ ***********************************************************************
+ *
+ * ```json
+ *  {
+ *    "url": "url"
+ *    "entrypoints": {
+ *      "entryPointName": {
+ *         "js": ["url", "url"],
+ *         "css": ["url", "url"],
+ *      }
+ *    }
+ *  }
+ * ```
+ *
+ * Please read the documentation for understanding the format of the files.
+ */
+export declare class ViteDriver extends BaseDriver implements AssetsDriverContract {
+    name: string;
+    /**
+     * Vite driver has support for entrypoints
+     */
+    hasEntrypoints: boolean;
+    /**
+     * Attributes to apply to the script tag. Vite needs to serve
+     * source over native ESM
+     */
+    scriptAttributes: Record<string, any>;
+    /**
+     * If we should use the manifest. We only use the manifest in production.
+     */
+    private shouldUseManifest;
+    /**
+     * Get the assets url from the entrypoints.json file
+     */
+    private getAssetUrl;
+    /**
+     * Returns path to a given asset file
+     */
+    assetPath(filename: string): string;
+    /**
+     * Returns the manifest contents as object
+     *
+     * Note that the manifest file is only available in production.
+     * Vite doesn't generate any manifest file in development.
+     */
+    manifest(): any;
+    /**
+     * Returns list for all the javascript files for a given entry point
+     */
+    entryPointJsFiles(name: string): string[];
+    /**
+     * Returns list for all the css files for a given entry point
+     */
+    entryPointCssFiles(name: string): string[];
+    /**
+     * Returns the script needed for the HMR working with React
+     */
+    getReactHmrScript(): string;
+    /**
+     * Returns the script needed for the HMR working with Vite
+     */
+    getViteHmrScript(): string;
+}

package/build/src/AssetsManager/Drivers/Vite.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViteDriver = void 0;
+const path_1 = require("path");
+const Base_1 = require("./Base");
+/**
+ * Resolves entry points and assets path for Vite. Relies
+ * on the "manifest.json" and "entrypoints.json" files.
+ *
+ **********************************************************************
+ * The driver assumes following format for the manifest.json file
+ **********************************************************************
+ *
+ * ```json
+ *  {
+ *    "assetName": {
+ *      "file": "path",
+ *      "src": "path"
+ *    },
+ *    ...
+ *  }
+ * ```
+ **********************************************************************
+ * The driver assumes following format for the entrypoints.json file
+ ***********************************************************************
+ *
+ * ```json
+ *  {
+ *    "url": "url"
+ *    "entrypoints": {
+ *      "entryPointName": {
+ *         "js": ["url", "url"],
+ *         "css": ["url", "url"],
+ *      }
+ *    }
+ *  }
+ * ```
+ *
+ * Please read the documentation for understanding the format of the files.
+ */
+class ViteDriver extends Base_1.BaseDriver {
+    constructor() {
+        super(...arguments);
+        this.name = 'vite';
+        /**
+         * Vite driver has support for entrypoints
+         */
+        this.hasEntrypoints = true;
+        /**
+         * Attributes to apply to the script tag. Vite needs to serve
+         * source over native ESM
+         */
+        this.scriptAttributes = { type: 'module' };
+    }
+    /**
+     * If we should use the manifest. We only use the manifest in production.
+     */
+    shouldUseManifest() {
+        return this.application.inProduction;
+    }
+    /**
+     * Get the assets url from the entrypoints.json file
+     */
+    getAssetUrl() {
+        return this.readFileAsJSON((0, path_1.join)(this.publicPath, 'entrypoints.json')).url;
+    }
+    /**
+     * Returns path to a given asset file
+     */
+    assetPath(filename) {
+        if (!this.shouldUseManifest()) {
+            return `${this.getAssetUrl()}/${filename}`;
+        }
+        const manifest = this.manifest();
+        if (!manifest[filename]) {
+            throw new Error(`Cannot find "${filename}" asset in the manifest file`);
+        }
+        return `${this.getAssetUrl()}/${manifest[filename].file}`;
+    }
+    /**
+     * Returns the manifest contents as object
+     *
+     * Note that the manifest file is only available in production.
+     * Vite doesn't generate any manifest file in development.
+     */
+    manifest() {
+        if (!this.shouldUseManifest()) {
+            throw new Error('Cannot use manifest when not in production');
+        }
+        return super.manifest();
+    }
+    /**
+     * Returns list for all the javascript files for a given entry point
+     */
+    entryPointJsFiles(name) {
+        const entrypoints = this.entryPoints();
+        if (!entrypoints[name]) {
+            throw new Error(`Cannot find assets for "${name}" entrypoint. Make sure to define it inside the "entryPoints" vite config`);
+        }
+        return entrypoints[name].js;
+    }
+    /**
+     * Returns list for all the css files for a given entry point
+     */
+    entryPointCssFiles(name) {
+        const entrypoints = this.entryPoints();
+        if (!entrypoints[name]) {
+            throw new Error(`Cannot find assets for "${name}" entrypoint. Make sure to define it inside the "entryPoints" vite config`);
+        }
+        return entrypoints[name].css;
+    }
+    /**
+     * Returns the script needed for the HMR working with React
+     */
+    getReactHmrScript() {
+        if (!this.application.inDev) {
+            return '';
+        }
+        return `
+    <script type="module">
+      import RefreshRuntime from '${this.getAssetUrl()}/@react-refresh'
+      RefreshRuntime.injectIntoGlobalHook(window)
+      window.$RefreshReg$ = () => {}
+      window.$RefreshSig$ = () => (type) => type
+      window.__vite_plugin_react_preamble_installed__ = true
+    </script>
+    `;
+    }
+    /**
+     * Returns the script needed for the HMR working with Vite
+     */
+    getViteHmrScript() {
+        if (!this.application.inDev) {
+            return '';
+        }
+        return `<script type="module" src="${this.getAssetUrl()}/@vite/client"></script>`;
+    }
+}
+exports.ViteDriver = ViteDriver;

package/build/src/AssetsManager/index.d.ts

@@ -11,6 +11,10 @@ export declare class AssetsManager implements AssetsManagerContract {
     private config;
     application: ApplicationContract;
     private drivers;
+    /**
+     * Attributes to apply to the script tag
+     */
+    get scriptAttributes(): Record<string, any>;
     /**
      * Configured driver
      */

package/build/src/AssetsManager/index.js

@@ -16,6 +16,7 @@ const utils_1 = require("@poppinss/utils");
 const stringify_attributes_1 = __importDefault(require("stringify-attributes"));
 const Fake_1 = require("./Drivers/Fake");
 const Encore_1 = require("./Drivers/Encore");
+const Vite_1 = require("./Drivers/Vite");
 /**
  * Assets manager exposes the API to make link and HTML fragments
  * for static assets.
@@ -24,14 +25,11 @@ const Encore_1 = require("./Drivers/Encore");
  * separately
  */
 class AssetsManager {
-    constructor(config, application) {
-        this.config = config;
-        this.application = application;
-        this.drivers = {
-            encore: () => new Encore_1.EncoreDriver(this.application),
-            fake: () => new Fake_1.FakeDriver(this.application),
-        };
-        this.booted = false;
+    /**
+     * Attributes to apply to the script tag
+     */
+    get scriptAttributes() {
+        return this.driver.scriptAttributes;
     }
     /**
      * Find if the configured driver supports entrypoints or not
@@ -62,6 +60,16 @@ class AssetsManager {
         this.boot();
         return this.driver.name;
     }
+    constructor(config, application) {
+        this.config = config;
+        this.application = application;
+        this.drivers = {
+            vite: () => new Vite_1.ViteDriver(this.application),
+            encore: () => new Encore_1.EncoreDriver(this.application),
+            fake: () => new Fake_1.FakeDriver(this.application),
+        };
+        this.booted = false;
+    }
     /**
      * Boot the manager. Must be done lazily to allow `extend` method to takes
      * in effect.
@@ -144,9 +152,14 @@ class AssetsManager {
      */
     entryPointScriptTags(name) {
         const scripts = this.entryPointJsFiles(name);
-        const scriptAttributes = this.config.script ? this.config.script.attributes || {} : {};
+        const configDefinedAttributes = this.config.script?.attributes || {};
+        const driverDefinedAttributes = this.driver.scriptAttributes || {};
+        const mergedAttributes = {
+            ...configDefinedAttributes,
+            ...driverDefinedAttributes,
+        };
         return scripts
-            .map((url) => `<script src="${url}"${(0, stringify_attributes_1.default)(scriptAttributes)}></script>`)
+            .map((url) => `<script src="${url}"${(0, stringify_attributes_1.default)(mergedAttributes)}></script>`)
             .join('\n');
     }
     /**
@@ -155,7 +168,7 @@ class AssetsManager {
      */
     entryPointStyleTags(name) {
         const links = this.entryPointCssFiles(name);
-        const styleAttributes = this.config.style ? this.config.style.attributes || {} : {};
+        const styleAttributes = this.config.style?.attributes || {};
         return links
             .map((url) => `<link rel="stylesheet" href="${url}"${(0, stringify_attributes_1.default)(styleAttributes)} />`)
             .join('\n');

package/build/src/HealthCheck/index.js

@@ -14,6 +14,12 @@ exports.HealthCheck = void 0;
  * the system. You can also add your own checkers.
  */
 class HealthCheck {
+    /**
+     * Returns an array of registered services names
+     */
+    get servicesList() {
+        return Object.keys(this.healthCheckers);
+    }
     constructor(application) {
         this.application = application;
         /**
@@ -25,12 +31,6 @@ class HealthCheck {
          */
         this.resolver = this.application.container.getResolver('report');
     }
-    /**
-     * Returns an array of registered services names
-     */
-    get servicesList() {
-        return Object.keys(this.healthCheckers);
-    }
     /**
      * Invokes a given checker to collect the report metrics.
      */

package/build/src/Ignitor/Ace/App/index.js

@@ -43,6 +43,13 @@ const ASSEMBLER_COMMANDS = [
  * the manifest file.
  */
 class App {
+    /**
+     * Returns a boolean if mentioned command is an assembler
+     * command
+     */
+    get isAssemblerCommand() {
+        return ASSEMBLER_COMMANDS.includes(this.commandName);
+    }
     /**
      * Source root always points to the compiled source
      * code.
@@ -58,13 +65,6 @@ class App {
          */
         this.ace = new ace_1.Kernel(this.kernel.application);
     }
-    /**
-     * Returns a boolean if mentioned command is an assembler
-     * command
-     */
-    get isAssemblerCommand() {
-        return ASSEMBLER_COMMANDS.includes(this.commandName);
-    }
     /**
      * Print commands help
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@adonisjs/core",
-	"version": "5.8.9",
+	"version": "5.9.0",
 	"description": "Core of AdonisJS",
 	"exports": {
 		".": {
@@ -68,16 +68,16 @@
 	},
 	"homepage": "https://github.com/adonisjs/core#readme",
 	"devDependencies": {
-		"@adonisjs/assembler": "^5.9.3",
+		"@adonisjs/assembler": "^5.9.5",
 		"@adonisjs/fold": "^8.2.0",
 		"@adonisjs/logger": "^4.1.5",
 		"@adonisjs/mrm-preset": "^5.0.3",
 		"@adonisjs/repl": "^3.1.11",
 		"@adonisjs/require-ts": "^2.0.13",
-		"@adonisjs/sink": "^5.4.1",
-		"@japa/assert": "^1.3.5",
-		"@japa/preset-adonis": "^1.1.1",
-		"@japa/run-failed-tests": "^1.0.8",
+		"@adonisjs/sink": "^5.4.2",
+		"@japa/assert": "^1.3.6",
+		"@japa/preset-adonis": "^1.2.0",
+		"@japa/run-failed-tests": "^1.1.0",
 		"@japa/runner": "^2.2.2",
 		"@japa/spec-reporter": "^1.3.2",
 		"@poppinss/dev-utils": "^2.0.3",
@@ -88,7 +88,7 @@
 		"copyfiles": "^2.4.1",
 		"cz-conventional-changelog": "^3.3.0",
 		"del-cli": "^5.0.0",
-		"eslint": "^8.27.0",
+		"eslint": "^8.28.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-adonis": "^2.1.1",
 		"eslint-plugin-prettier": "^4.2.1",
@@ -102,8 +102,8 @@
 		"strip-ansi": "^6.0.1",
 		"supertest": "^6.3.1",
 		"test-console": "^2.0.0",
-		"typescript": "^4.8.4",
-		"youch": "^3.2.1",
+		"typescript": "^4.9.3",
+		"youch": "^3.2.2",
 		"youch-terminal": "^2.1.5"
 	},
 	"nyc": {
@@ -126,12 +126,12 @@
 	},
 	"dependencies": {
 		"@adonisjs/ace": "^11.3.1",
-		"@adonisjs/application": "^5.2.5",
+		"@adonisjs/application": "^5.3.0",
 		"@adonisjs/bodyparser": "^8.1.7",
 		"@adonisjs/drive": "^2.3.0",
 		"@adonisjs/encryption": "^4.0.8",
 		"@adonisjs/events": "^7.2.1",
-		"@adonisjs/hash": "^7.2.0",
+		"@adonisjs/hash": "^7.2.2",
 		"@adonisjs/http-server": "^5.12.0",
 		"@adonisjs/validator": "^12.4.1",
 		"@poppinss/cliui": "^3.0.5",
@@ -139,7 +139,7 @@
 		"@poppinss/utils": "^5.0.0",
 		"fs-extra": "^10.1.0",
 		"macroable": "^7.0.2",
-		"memfs": "^3.4.10",
+		"memfs": "^3.4.12",
 		"serve-static": "^1.15.0",
 		"stringify-attributes": "^2.0.0"
 	},