Add asset BundleManager & re-organize the asset helper classes

modules/system/ServiceProvider.php

@@ -8,7 +8,7 @@
 use Config;
 use DateInterval;
 use Event;
-use Illuminate\Foundation\Vite;
+use Illuminate\Foundation\Vite as LaravelVite;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Facades\Schema;
 use Markdown;
@@ -145,7 +145,7 @@ protected function registerSingletons()
         });
 
         // Register the Laravel Vite singleton
-        $this->app->singleton(Vite::class, \System\Classes\Vite::class);
+        $this->app->singleton(LaravelVite::class, \System\Classes\Asset\Vite::class);
     }
 
     /**
@@ -321,19 +321,19 @@ protected function registerConsole()
         $this->registerConsoleCommand('plugin.list', \System\Console\PluginList::class);
 
         $this->registerConsoleCommand('mix.compile', Console\Asset\Mix\MixCompile::class);
-        $this->registerConsoleCommand('mix.config', Console\Asset\Mix\MixConfig::class);
+        $this->registerConsoleCommand('mix.config', Console\Asset\Mix\MixCreate::class);
         $this->registerConsoleCommand('mix.install', Console\Asset\Mix\MixInstall::class);
         $this->registerConsoleCommand('mix.list', Console\Asset\Mix\MixList::class);
         $this->registerConsoleCommand('mix.watch', Console\Asset\Mix\MixWatch::class);
 
         $this->registerConsoleCommand('vite.compile', Console\Asset\Vite\ViteCompile::class);
-        $this->registerConsoleCommand('vite.config', Console\Asset\Vite\ViteConfig::class);
+        $this->registerConsoleCommand('vite.config', Console\Asset\Vite\ViteCreate::class);
         $this->registerConsoleCommand('vite.install', Console\Asset\Vite\ViteInstall::class);
         $this->registerConsoleCommand('vite.list', Console\Asset\Vite\ViteList::class);
         $this->registerConsoleCommand('vite.watch', Console\Asset\Vite\ViteWatch::class);
 
-        $this->registerConsoleCommand('npm.run', Console\NpmRun::class);
-        $this->registerConsoleCommand('npm.update', Console\NpmUpdate::class);
+        $this->registerConsoleCommand('npm.run', Console\Asset\NpmRun::class);
+        $this->registerConsoleCommand('npm.update', Console\Asset\NpmUpdate::class);
     }
 
     /*

modules/system/classes/MailManager.php

@@ -344,7 +344,7 @@ public function listRegisteredLayouts()
     /**
      * Registers a callback function that defines mail templates.
      * The callback function should register templates by calling the manager's
-     * registerMailTemplates() function. Thi instance is passed to the
+     * registerMailTemplates() function. This instance is passed to the
      * callback function as an argument. Usage:
      *
      *     MailManager::registerCallback(function ($manager) {

modules/system/classes/asset/BundleManager.php

@@ -0,0 +1,253 @@
+<?php
+
+namespace System\Classes\Asset;
+
+use Closure;
+use Winter\Storm\Support\Traits\Singleton;
+
+/**
+ * Asset Bundle manager.
+ *
+ * This class manages "asset bundles" registered by the core and plugins that are used by the
+ * [mix|vite]:create commands to generate & populate the required files for a given bundle.
+ * Bundles include information on the specific packages & versions required for the bundle
+ * to function in the context of the Winter package (plugin or theme) it is being used in,
+ * as well as dependencies specific to the desired compiler (e.g. mix or vite).
+ *
+ * @package winter\wn-system-module
+ * @author Jack Wilkinson <[email protected]>
+ * @copyright Winter CMS Maintainers
+ */
+class BundleManager
+{
+    use Singleton;
+
+    protected const HANDLER_SETUP = '_setup';
+    protected const HANDLER_SCAFFOLD = '_scaffold';
+
+    /**
+     * List of packages available to install. Allows for `$compilerName` => [`CompilerSpecificPackage`]
+     */
+    protected array $defaultPackages = [
+        'tailwind' => [
+            'tailwindcss' => '^3.4.0',
+            '@tailwindcss/forms' => '^0.5.3',
+            '@tailwindcss/typography' => '^0.5.2',
+        ],
+        'vue' => [
+            'vue' => '^3.4.0',
+            'vite' => [
+                '@vitejs/plugin-vue' => '^5.0.5'
+            ],
+        ],
+    ];
+
+    /**
+     * Cache of registration callbacks.
+     */
+    protected array $callbacks = [];
+
+    /**
+     * List of registered asset bundles in the system
+     */
+    protected array $registeredBundles = [];
+
+    /**
+     * Initialize the singleton
+     */
+    public function init(): void
+    {
+        // Register the default bundles
+        $this->registerCallback(function (self $manager) {
+            $manager->registerBundles($this->defaultPackages);
+
+            $manager->registerSetupHandler('tailwind', function (string $packagePath, string $packageType) {
+                $this->writeFile(
+                    $packagePath . '/tailwind.config.js',
+                    $this->getFixture('tailwind/tailwind.' . $packageType . '.config.js.fixture')
+                );
+
+                $this->writeFile(
+                    $packagePath . '/postcss.config.mjs',
+                    $this->getFixture('tailwind/postcss.config.js.fixture')
+                );
+            });
+
+            $manager->registerScaffoldHandler('tailwind', function (string $contents, string $contentType) {
+                return match ($contentType) {
+                    'mix' => $contents . PHP_EOL . <<<JAVASCRIPT
+                    mix.postCss('assets/src/css/{{packageName}}.css', 'assets/dist/css/{{packageName}}.css', [
+                        require('postcss-import'),
+                        require('tailwindcss'),
+                        require('autoprefixer'),
+                    ]);
+                    JAVASCRIPT,
+                    'css' => $this->getFixture('css/tailwind.css.fixture'),
+                    default => $contents
+                };
+            });
+
+            $manager->registerScaffoldHandler('vue', function (string $contents, string $contentType) {
+                return match ($contentType) {
+                    'vite' => str_replace(
+                        '}),',
+                        <<<JAVASCRIPT
+                        }),
+                                vue({
+                                    template: {
+                                        transformAssetUrls: {
+                                            // The Vue plugin will re-write asset URLs, when referenced
+                                            // in Single File Components, to point to the Laravel web
+                                            // server. Setting this to `null` allows the Laravel plugin
+                                            // to instead re-write asset URLs to point to the Vite
+                                            // server instead.
+                                            base: null,
+
+                                            // The Vue plugin will parse absolute URLs and treat them
+                                            // as absolute paths to files on disk. Setting this to
+                                            // `false` will leave absolute URLs un-touched so they can
+                                            // reference assets in the public directory as expected.
+                                            includeAbsolute: false,
+                                        },
+                                    },
+                                }),
+                        JAVASCRIPT,
+                        str_replace(
+                            'import laravel from \'laravel-vite-plugin\';',
+                            'import laravel from \'laravel-vite-plugin\';' . PHP_EOL . 'import vue from \'@vitejs/plugin-vue\';',
+                            $contents
+                        )
+                    ),
+                    'mix' => str_replace(
+                        'mix.js(\'assets/src/js/{{packageName}}.js\', \'assets/dist/js/{{packageName}}.js\');',
+                        'mix.js(\'assets/src/js/{{packageName}}.js\', \'assets/dist/js/{{packageName}}.js\').vue({ version: 3 });',
+                        $contents
+                    ),
+                    'js' => $this->getFixture('js/vue.js.fixture'),
+                    default => $contents
+                };
+            });
+        });
+    }
+
+    /**
+     * Loads registered asset bundles from modules and plugins
+     */
+    public function loadRegisteredBundles(): void
+    {
+        foreach ($this->callbacks as $callback) {
+            $callback($this);
+        }
+    }
+
+    /**
+     * Returns a list of the registered asset bundles.
+     */
+    public function listRegisteredBundles(): array
+    {
+        if (empty($this->registeredBundles)) {
+            $this->loadRegisteredBundles();
+        }
+
+        return $this->registeredBundles;
+    }
+
+    /**
+     * Get all bundles configured
+     */
+    public function getBundles(): array
+    {
+        return array_keys($this->listRegisteredBundles());
+    }
+
+    /**
+     * Get the packages for a bundle, with compiler specific packages
+     */
+    public function getBundlePackages(string $name, string $assetType): array
+    {
+        $config = $this->listRegisteredBundles()[$name] ?? [];
+
+        $packages = [];
+        foreach ($config as $key => $value) {
+            // Skip handlers
+            if (in_array($key, [static::HANDLER_SETUP, static::HANDLER_SCAFFOLD])) {
+                continue;
+            }
+
+            // Merge in any compiler specific packages for the current compiler
+            if (is_array($value)) {
+                if ($key === $assetType) {
+                    $packages = array_merge($packages, $value);
+                }
+                continue;
+            }
+
+            $packages[$key] = $value;
+        }
+
+        return $packages;
+    }
+
+    /**
+     * Registers a callback function that defines asset bundles. The callback function
+     * should register bundles by calling the manager's registerBundles() function.
+     * This instance is passed to the callback function as an argument. Usage:
+     *
+     *     BundleManager::registerCallback(function ($manager) {
+     *         $manager->registerAssetBundles([...]);
+     *     });
+     *
+     */
+    public function registerCallback(callable $callback): void
+    {
+        $this->callbacks[] = $callback;
+    }
+
+    /**
+     * Registers asset bundles.
+     */
+    public function registerBundles(array $definitions)
+    {
+        $this->registeredBundles = array_replace_recursive($this->registeredBundles, $definitions);
+    }
+
+    /**
+     * Registers a single asset bundle.
+     */
+    public function registerBundle(string $name, array $definition): void
+    {
+        $this->registerBundles([$name => $definition]);
+    }
+
+    /**
+     * Registers a single bundle setup handler.
+     */
+    public function registerSetupHandler(string $name, Closure $closure): void
+    {
+        $this->registeredBundles[$name][static::HANDLER_SETUP] = $closure;
+    }
+
+    /**
+     * Registers a single bundle scaffold handler.
+     */
+    public function registerScaffoldHandler(string $name, Closure $closure): void
+    {
+        $this->registeredBundles[$name][static::HANDLER_SCAFFOLD] = $closure;
+    }
+
+    /**
+     * Gets the setup handler for a bundle.
+     */
+    public function getSetupHandler(string $name): ?Closure
+    {
+        return $this->listRegisteredBundles()[$name][static::HANDLER_SETUP] ?? null;
+    }
+
+    /**
+     * Gets the scaffold handler for a bundle.
+     */
+    public function getScaffoldHandler(string $name): ?Closure
+    {
+        return $this->listRegisteredBundles()[$name][static::HANDLER_SCAFFOLD] ?? null;
+    }
+}

modules/system/classes/PackageJson.php → modules/system/classes/asset/PackageJson.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace System\Classes;
+namespace System\Classes\Asset;
 
 use InvalidArgumentException;
 use RuntimeException;
@@ -249,6 +249,14 @@ public function getContents(): array
         return $this->data;
     }
 
+    /**
+     * Returns the path of the package.json if set
+     */
+    public function getPath(): ?string
+    {
+        return $this->path;
+    }
+
     /**
      * Saves the contents to a file, if the object was init'ed with a path it will save to the path, or can be
      * overwritten with `$path`.

modules/system/classes/CompilableAssets.php → modules/system/classes/asset/PackageManager.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace System\Classes;
+namespace System\Classes\Asset;
 
 use Cms\Classes\Theme;
 use System\Classes\PluginManager;
@@ -11,16 +11,16 @@
 use Winter\Storm\Support\Str;
 
 /**
- * Compilable assets using for Node.js compilation and processing.
+ * Package manager.
  *
- * This works similar to the `System\Classes\CombineAssets` class in that it allows modules, plugins and themes to
- * register configurations that will be passed on to Node.js based compilers for processing.
+ * This class manages compilable asset "packages" registered by modules, plugins, and themes that
+ * provide configurations for Node.js based compilers (e.g. mix or vite) to process.
  *
  * @package winter\wn-system-module
  * @author Jack Wilkinson <[email protected]>
  * @copyright Winter CMS Maintainers
  */
-class CompilableAssets
+class PackageManager
 {
     use \Winter\Storm\Support\Traits\Singleton;
 
@@ -258,7 +258,7 @@ public function getPackage(string $name, bool $includeIgnored = false): array
      * The name of the package is an alias that can be used to reference this package in other methods within this
      * class.
      *
-     * By default, the `CompilableAssets` class will look for a `package.json` file for Node dependencies, and a config
+     * By default, the `PackageManager` class will look for a `package.json` file for Node dependencies, and a config
      * file for the compilable configuration
      *
      * @param string $name The name of the package being registered

modules/system/classes/Vite.php → modules/system/classes/asset/Vite.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace System\Classes;
+namespace System\Classes\Asset;
 
 use Illuminate\Foundation\Vite as LaravelVite;
 use Illuminate\Support\Facades\App;
@@ -27,12 +27,12 @@ public function __invoke($entrypoints, $package = null)
         // Normalise the package name
         $package = strtolower($package);
 
-        if (!($compilableAssetPackage = CompilableAssets::instance()->getPackages('vite')[$package] ?? null)) {
+        if (!($compilableAssetPackage = PackageManager::instance()->getPackages('vite')[$package] ?? null)) {
             throw new SystemException('Unable to resolve package: ' . $package);
         }
 
-        $this->useHotFile(base_path($compilableAssetPackage['path'] . '/public/hot'));
-        return parent::__invoke($entrypoints, $compilableAssetPackage['path'] . '/public/build');
+        $this->useHotFile(base_path($compilableAssetPackage['path'] . '/assets/dist/hot'));
+        return parent::__invoke($entrypoints, $compilableAssetPackage['path'] . '/assets/dist');
     }
 
     /**