@athenna/http 5.10.0 → 5.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "5.10.0",
+  "version": "5.11.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -51,7 +51,7 @@
     "./types": "./src/types/index.js",
     "./package": "./package.json",
     "./package.json": "./package.json",
-    "./vite": "./src/vite/index.js",
+    "./vite/plugin": "./src/vite/plugin.js",
     "./testing/plugins": "./src/testing/plugins/index.js",
     "./kernels/HttpKernel": "./src/kernels/HttpKernel.js",
     "./handlers/HttpExceptionHandler": "./src/handlers/HttpExceptionHandler.js",

package/src/types/vite/PluginOptions.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export interface PluginOptions {
+    /**
+     * The URL where the assets will be served. This is particularly
+     * useful if you are using a CDN to deploy your assets.
+     *
+     * @default ''
+     */
+    assetsUrl?: string;
+    /**
+     * Files that should trigger a page reload when changed.
+     *
+     * @default ['./src/resources/views/** /*.edge']
+     */
+    reload?: string[];
+    /**
+     * Paths to the entrypoints files
+     */
+    entrypoints: string[];
+    /**
+     * Public directory where the assets will be compiled.
+     *
+     * @default 'public/assets'
+     */
+    buildDirectory?: string;
+}

package/src/types/vite/PluginOptions.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/src/vite/config.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import type { ConfigEnv, Plugin, UserConfig } from 'vite';
+import type { PluginOptions } from '#src/types/vite/PluginOptions';
+/**
+ * Resolve the `config.base` value
+ */
+export declare function resolveBase(config: UserConfig, options: Required<PluginOptions>, command: 'build' | 'serve'): string;
+/**
+ * Vite config hook
+ */
+export declare function configHook(options: Required<PluginOptions>, userConfig: UserConfig, { command }: ConfigEnv): UserConfig;
+/**
+ * Update the user vite config to match Athenna requirements.
+ */
+export declare const config: (options: Required<PluginOptions>) => Plugin;

package/src/vite/config.js

@@ -0,0 +1,57 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { join } from 'node:path';
+/**
+ * Resolve the `config.base` value
+ */
+export function resolveBase(config, options, command) {
+    if (config.base)
+        return config.base;
+    if (command === 'build') {
+        return options.assetsUrl.endsWith('/')
+            ? options.assetsUrl
+            : options.assetsUrl + '/';
+    }
+    return '/';
+}
+/**
+ * Vite config hook
+ */
+export function configHook(options, userConfig, { command }) {
+    const config = {
+        publicDir: userConfig.publicDir ?? false,
+        base: resolveBase(userConfig, options, command),
+        /**
+         * Disable the vite dev server cors handling. Otherwise, it will
+         * override the cors settings defined by @fastify/cors.
+         */
+        server: { cors: userConfig.server?.cors ?? false },
+        build: {
+            assetsDir: '',
+            emptyOutDir: true,
+            manifest: userConfig.build?.manifest ?? true,
+            outDir: userConfig.build?.outDir ?? options.buildDirectory,
+            assetsInlineLimit: userConfig.build?.assetsInlineLimit ?? 0,
+            rollupOptions: {
+                input: options.entrypoints.map(entrypoint => join(userConfig.root || '', entrypoint))
+            }
+        }
+    };
+    return config;
+}
+/**
+ * Update the user vite config to match Athenna requirements.
+ */
+export const config = (options) => {
+    return {
+        name: 'vite-plugin-athenna:config',
+        enforce: 'post',
+        config: configHook.bind(null, options)
+    };
+};

package/src/vite/plugin.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import type { PluginOption } from 'vite';
+import type { PluginOptions } from '#src/types/vite/PluginOptions';
+export default function athenna(options: PluginOptions): PluginOption[];

package/src/vite/plugin.js

@@ -0,0 +1,25 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import PluginRestart from 'vite-plugin-restart';
+import { config } from '#src/vite/config';
+export default function athenna(options) {
+    const fullOptions = Object.assign({
+        assetsUrl: '/assets',
+        buildDirectory: 'public/assets',
+        reload: ['./src/resources/views/**/*.edge'],
+        css: {
+            preprocessorOptions: {
+                scss: {
+                    api: 'modern'
+                }
+            }
+        }
+    }, options);
+    return [PluginRestart({ reload: fullOptions.reload }), config(fullOptions)];
+}

package/src/vite/index.d.ts

@@ -1,2 +0,0 @@
-import { type UserConfig } from 'vite';
-export declare function defineAthennaConfig(config: UserConfig): UserConfig;

package/src/vite/index.js

@@ -1,34 +0,0 @@
-import PluginRestart from 'vite-plugin-restart';
-import { Path } from '@athenna/common';
-import { mergeConfig, defineConfig } from 'vite';
-export function defineAthennaConfig(config) {
-    const defaultConfig = {
-        root: Path.pwd(),
-        assetsUrl: '/assets',
-        buildDirectory: 'public/assets',
-        css: {
-            preprocessorOptions: {
-                scss: {
-                    api: 'modern'
-                }
-            }
-        },
-        build: {
-            assetsDir: '',
-            manifest: true,
-            emptyOutDir: true,
-            outDir: 'public/assets',
-            assetsInlineLimit: 0,
-            rollupOptions: {
-                output: {
-                    entryFileNames: '[name].js',
-                    chunkFileNames: '[name].js',
-                    assetFileNames: '[name].[ext]'
-                },
-                input: [Path.resources('css/app.scss'), Path.resources('js/app.js')]
-            }
-        },
-        plugins: [PluginRestart({ reload: [Path.views('**/*.edge')] })]
-    };
-    return defineConfig(mergeConfig(defaultConfig, config));
-}