new CSS and JS build system

Modules/Helpdesk/Config/config.php

@@ -0,0 +1,8 @@
+<?php
+
+return [
+    'name' => 'Helpdesk',
+    'features' =>
+     [
+     ],
+];

Modules/Helpdesk/Database/Seeders/HelpdeskDatabaseSeeder.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Modules\Helpdesk\Database\Seeders;
+
+use Illuminate\Database\Seeder;
+use Illuminate\Database\Eloquent\Model;
+
+class HelpdeskDatabaseSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        Model::unguard();
+
+        // $this->call("OthersTableSeeder");
+    }
+}

Modules/Helpdesk/Helpers/Helper.php

@@ -0,0 +1,12 @@
+<?php
+use Modules\Helpdesk\Support\ModuleInfo;
+
+if (! function_exists('helpdesk_feature_enabled')) {
+    /**
+     * Check if a feature is enabled in the config.
+     */
+    function helpdesk_feature_enabled(string $key): bool
+    {
+        return (bool) config(ModuleInfo::nameLower().".features.{$key}", false);
+    }
+}

Modules/Helpdesk/Http/Controllers/HelpdeskController.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Modules\Helpdesk\Http\Controllers;
+
+use Illuminate\Contracts\Support\Renderable;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
+
+class HelpdeskController extends Controller
+{
+    /**
+     * Display a listing of the resource.
+     * @return Renderable
+     */
+    public function index()
+    {
+        return view('helpdesk::index');
+    }
+
+    /**
+     * Show the form for creating a new resource.
+     * @return Renderable
+     */
+    public function create()
+    {
+        return view('helpdesk::create');
+    }
+
+    /**
+     * Store a newly created resource in storage.
+     * @param Request $request
+     * @return Renderable
+     */
+    public function store(Request $request)
+    {
+        //
+    }
+
+    /**
+     * Show the specified resource.
+     * @param int $id
+     * @return Renderable
+     */
+    public function show($id)
+    {
+        return view('helpdesk::show');
+    }
+
+    /**
+     * Show the form for editing the specified resource.
+     * @param int $id
+     * @return Renderable
+     */
+    public function edit($id)
+    {
+        return view('helpdesk::edit');
+    }
+
+    /**
+     * Update the specified resource in storage.
+     * @param Request $request
+     * @param int $id
+     * @return Renderable
+     */
+    public function update(Request $request, $id)
+    {
+        //
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     * @param int $id
+     * @return Renderable
+     */
+    public function destroy($id)
+    {
+        //
+    }
+}

Modules/Helpdesk/Providers/HelpdeskServiceProvider.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace Modules\Helpdesk\Providers;
+
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Database\Eloquent\Factory;
+use Illuminate\Support\Facades\File;
+use Modules\Helpdesk\Support\ModuleInfo;
+use Config;
+
+class HelpdeskServiceProvider extends ServiceProvider
+{
+    /**
+     * @var string $moduleName
+     */
+    protected string $moduleName = 'Helpdesk';
+
+    /**
+     * @var string $moduleNameLower
+     */
+    protected string $moduleNameLower = 'helpdesk';
+
+
+     /**
+      * Get the services provided by the provider.
+      *
+      * @return array
+      */
+    public function provides():array
+    {
+        return [];
+    }
+
+    /**
+     * Boot the application events.
+     *
+     * @return void
+     */
+    public function boot() : void
+    {
+        $this->registerTranslations();
+        $this->registerConfig();
+        $this->registerViews();
+        $this->registerHelpers();
+        $this->registerCommands();
+        $this->loadMigrationsFrom(module_path(ModuleInfo::name(), 'Database/Migrations'));
+    }
+
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register(): void
+    {
+        $this->app->register(RouteServiceProvider::class);
+    }
+
+    /**
+     * Register the helpers.
+     *
+     * @return void
+     */
+    protected function registerHelpers(): void
+    {
+        foreach (glob(__DIR__.'/../Helpers/*.php') as $filename) {
+            require_once $filename;
+        }
+    }
+
+     /**
+     * Dynamically Register Commands.
+     *
+     * @return void
+     */
+    public function registerCommands(): void
+       {
+           if (!$this->app->runningInConsole()) {
+               return;
+           }
+           $commandPath = __DIR__ . '/../Console';
+            $commands = collect(File::allFiles($commandPath))
+                 ->map(function ($file) {
+                     $class = 'Modules\\' . $this->moduleName . '\\Console\\' . $file->getFilenameWithoutExtension();
+                     return $class;
+                })
+                ->filter(function ($class) {
+                    return class_exists($class);
+                })
+                ->values()
+                ->all();
+            $this->commands($commands);
+        }
+
+    /**
+     * Register config.
+     *
+     * @return void
+     */
+    protected function registerConfig(): void
+    {
+        $this->publishes([
+            module_path(ModuleInfo::name(), 'Config/config.php') => config_path( ModuleInfo::nameLower(). '.php'),
+        ], 'config');
+        $this->mergeConfigFrom(
+            module_path(ModuleInfo::name(), 'Config/config.php'),  ModuleInfo::nameLower()
+        );
+    }
+
+    /**
+     * Register views.
+     *
+     * @return void
+     */
+    public function registerViews(): void
+    {
+        $viewPath = resource_path('views/modules/' . ModuleInfo::nameLower());
+        $sourcePath = module_path(ModuleInfo::name(), 'Resources/views');
+        $this->publishes([
+            $sourcePath => $viewPath
+        ], ['views',  ModuleInfo::nameLower() . '-module-views']);
+        $this->loadViewsFrom(array_merge($this->getPublishableViewPaths(), [$sourcePath]),  ModuleInfo::nameLower());
+    }
+
+    /**
+     * Register translations.
+     *
+     * @return void
+     */
+    public function registerTranslations(): void
+    {
+        $langPath = resource_path('lang/modules/' .  ModuleInfo::nameLower());
+
+        if (is_dir($langPath)) {
+            $this->loadTranslationsFrom($langPath,  ModuleInfo::nameLower());
+        } else {
+            $this->loadTranslationsFrom(module_path(ModuleInfo::name(), 'Resources/lang'), ModuleInfo::nameLower());
+        }
+    }
+
+    /**
+     * Regsiter View Paths
+     * @return array
+     */
+    private function getPublishableViewPaths(): array
+    {
+        $paths = [];
+        foreach (Config::get('view.paths') as $path) {
+            if (is_dir($path . '/modules/' . ModuleInfo::nameLower())) {
+                $paths[] = $path . '/modules/' . ModuleInfo::nameLower();
+            }
+        }
+        return $paths;
+    }
+}

Modules/Helpdesk/Providers/RouteServiceProvider.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Modules\Helpdesk\Providers;
+
+use Illuminate\Support\Facades\Route;
+use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
+
+class RouteServiceProvider extends ServiceProvider
+{
+    /**
+     * The module namespace to assume when generating URLs to actions.
+     *
+     * @var string
+     */
+    protected $moduleNamespace = 'Modules\Helpdesk\Http\Controllers';
+
+    /**
+     * Called before routes are registered.
+     *
+     * Register any model bindings or pattern based filters.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        parent::boot();
+    }
+
+    /**
+     * Define the routes for the application.
+     *
+     * @return void
+     */
+    public function map()
+    {
+        $this->mapApiRoutes();
+
+        $this->mapWebRoutes();
+    }
+
+    /**
+     * Define the "web" routes for the application.
+     *
+     * These routes all receive session state, CSRF protection, etc.
+     *
+     * @return void
+     */
+    protected function mapWebRoutes()
+    {
+        Route::middleware('web')
+            ->namespace($this->moduleNamespace)
+            ->group(module_path('Helpdesk', '/Routes/web.php'));
+    }
+
+    /**
+     * Define the "api" routes for the application.
+     *
+     * These routes are typically stateless.
+     *
+     * @return void
+     */
+    protected function mapApiRoutes()
+    {
+        Route::prefix('api')
+            ->middleware('api')
+            ->namespace($this->moduleNamespace)
+            ->group(module_path('Helpdesk', '/Routes/api.php'));
+    }
+}

Modules/Helpdesk/Resources/assets/js/app.js

@@ -0,0 +1 @@
+window.Helpdesk = window.Helpdesk || {};

Modules/Helpdesk/Resources/assets/sass/app.scss

@@ -0,0 +1,3 @@
+.helpdesk-module {
+    min-height: 100vh;
+}

Modules/Helpdesk/Resources/views/index.blade.php

@@ -0,0 +1,9 @@
+@extends('helpdesk::layouts.master')
+
+@section('content')
+    <h1>Hello World</h1>
+
+    <p>
+        This view is loaded from module: {!! config('helpdesk.name') !!}
+    </p>
+@endsection

Modules/Helpdesk/Resources/views/layouts/master.blade.php

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <title>Module Helpdesk</title>
+
+        @vite([
+            'Resources/assets/sass/app.scss',
+            'Resources/assets/js/app.js',
+        ], 'build/helpdesk')
+    </head>
+    <body>
+        @yield('content')
+    </body>
+</html>

Modules/Helpdesk/Routes/api.php

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Http\Request;
+
+/*
+|--------------------------------------------------------------------------
+| API Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register API routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| is assigned the "api" middleware group. Enjoy building your API!
+|
+*/
+
+Route::middleware('auth:api')->get('/helpdesk', function (Request $request) {
+    return $request->user();
+});

Modules/Helpdesk/Routes/web.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Web Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register web routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| contains the "web" middleware group. Now create something great!
+|
+*/
+
+Route::prefix('helpdesk')->group(function() {
+    Route::get('/', 'HelpdeskController@index');
+});

Modules/Helpdesk/Support/ModuleInfo.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Modules\Helpdesk\Support;
+
+class ModuleInfo
+{
+    protected static string $moduleName =  'Helpdesk';
+
+    /**
+     * defines the Module Name
+     * @return string
+     */
+    public static function name(): string
+    {
+        return static::$moduleName;
+    }
+
+    /**
+     * define the lowercase version
+     * @return string
+     */
+    public static function nameLower(): string
+    {
+        return strtolower(static::$moduleName);
+    }
+}

Modules/Helpdesk/changelog.yaml

@@ -0,0 +1,9 @@
+url: https://wms.vm
+versions:
+  "1.0.0":
+    changed:
+      - Initial Module Definition
+  "1.0.1":
+    changed:
+      - Added Vite Support and removed webpack
+

Modules/Helpdesk/composer.json

@@ -0,0 +1,27 @@
+{
+    "name": "mpba/helpdesk",
+    "description": "Helpdesk module",
+    "authors": [
+        {
+            "name": "Mark Gregory",
+            "email": "mark.gregory@mpba.co.uk"
+        }
+    ],
+    "extra": {
+        "laravel": {
+            "providers": [],
+            "aliases": {}
+        }
+    },
+    "autoload": {
+        "psr-4": {
+            "Modules\\Helpdesk\\": ""
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/",
+            "Modules\\Helpdesk\\Tests\\": "Tests/"
+        }
+    }
+}

Modules/Helpdesk/module.json

@@ -0,0 +1,14 @@
+{
+    "name": "Helpdesk",
+    "alias": "helpdesk",
+    "version": "1.0.0",
+    "description": "",
+    "keywords": [],
+    "priority": 0,
+    "providers": [
+        "Modules\\Helpdesk\\Providers\\HelpdeskServiceProvider"
+    ],
+    "aliases": {},
+    "files": [],
+    "requires": []
+}

Modules/Helpdesk/package.json

@@ -0,0 +1,15 @@
+{
+    "private": true,
+    "type": "module",
+    "scripts": {
+        "dev": "vite",
+        "build": "vite build"
+    },
+    "devDependencies": {
+        "@vitejs/plugin-vue": "latest",
+        "axios": "latest",
+        "laravel-vite-plugin": "latest",
+        "sass-embedded": "^1.100.0",
+        "vite": "latest"
+    }
+}

Modules/Helpdesk/vite.config.js

@@ -0,0 +1,26 @@
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+    build: {
+        emptyOutDir: true,
+        manifest: true,
+        outDir: '../../public/build/helpdesk',
+    },
+    plugins: [
+        laravel({
+            publicDirectory: '../../public',
+            buildDirectory: 'build/helpdesk',
+            input: [
+                'Resources/assets/sass/app.scss',
+                'Resources/assets/js/app.js',
+            ],
+            refresh: [
+                'Resources/views/**/*.blade.php',
+                'Routes/**/*.php',
+                'Http/**/*.php',
+                'Providers/**/*.php',
+            ],
+        }),
+    ],
+});

composer.json

@@ -101,7 +101,7 @@
             "npm run build"
         ],
         "reload": [
-            "npm run build",
+            "npm run build:all",
             "@php artisan optimize:clear",
             "@php artisan octane:reload"
         ],

modules_statuses.json

@@ -15,5 +15,6 @@
     "Shipping": true,
     "Transportation": true,
     "Warehouse": true,
-    "Pricing": true
+    "Pricing": true,
+    "Helpdesk": true
 }

package.json

@@ -3,8 +3,19 @@
     "private": true,
     "type": "module",
     "scripts": {
+
+        "dev": "vite --host 0.0.0.0",
+
         "build": "vite build",
-        "dev": "vite"
+
+        "modules:install": "find Modules -maxdepth 2 -name package.json -not -path '*/node_modules/*' -execdir npm install \\;",
+
+        "modules:build": "find Modules -maxdepth 2 -name package.json -not -path '*/node_modules/*' -exec sh -c 'cd \"$(dirname \"$1\")\" && node -e \"const p=require(\\\"./package.json\\\"); process.exit(p.scripts && p.scripts.build ? 0 : 1)\" && npm run build || true' sh {} \\;",
+
+        "build:all": "npm run build && npm run modules:build",
+
+        "install:all": "npm install && npm run modules:install"
+
     },
     "dependencies": {
         "@fortawesome/fontawesome-free": "^7.1.0",
@@ -14,6 +25,7 @@
         "concurrently": "^9.0.1",
         "flatpickr": "^4.6.13",
         "laravel-vite-plugin": "^3.1",
+        "sass-embedded": "^1.100.0",
         "tailwindcss": "^4.0.7",
         "vite": "^8.0.0"
     },