mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-04-18 18:54:07 +00:00
feat(menu): priority-sorted menu groups, user-menu items, sidebar appearance toggle
Every main_menu entry moves from numeric group (1/2/3) to string-based group + group_label + priority. Groups now carry their own i18n label and child entries are sorted by an explicit priority field instead of config-array order, so module-contributed menu items can slot into any existing group at any position.
BootstrapController merges module-registered menu items into main_menu (previously they lived in a separate module_menu response key) and introduces a user_menu response key for items modules want to place in the avatar dropdown. The global store follows suit: moduleMenu becomes userMenu, menuGroups is a computed that sorts by priority, and hasActiveModules drops out.
New admin Appearance setting page with a single toggle for whether sidebar group labels render — so instances that prefer a compact sidebar can hide the Documents/Administration/Modules headings without losing the grouping itself. CompanyLayout watches route meta and re-bootstraps when the admin-mode flag flips so the sidebar repaints with the right menu on navigation across the admin boundary.
Test suites updated: module menu merging is asserted against main_menu (name: 'module-{slug}') rather than the old module_menu response; HelloWorldIntegrationTest verifies the schema translation path; CompanyModulesIndexTest covers the display_name attachment.
This commit is contained in:
@@ -24,7 +24,7 @@ afterEach(function () {
|
||||
Registry::flush();
|
||||
});
|
||||
|
||||
test('bootstrap returns module_menu populated from Registry', function () {
|
||||
test('bootstrap merges module menu items into main_menu', function () {
|
||||
Registry::registerMenu('sales-tax-us', [
|
||||
'title' => 'sales_tax_us::menu.title',
|
||||
'link' => '/admin/modules/sales-tax-us/settings',
|
||||
@@ -33,18 +33,43 @@ test('bootstrap returns module_menu populated from Registry', function () {
|
||||
|
||||
$response = getJson('api/v1/bootstrap')->assertOk();
|
||||
|
||||
$response->assertJsonPath('module_menu.0.title', 'sales_tax_us::menu.title');
|
||||
$response->assertJsonPath('module_menu.0.link', '/admin/modules/sales-tax-us/settings');
|
||||
$response->assertJsonPath('module_menu.0.icon', 'CalculatorIcon');
|
||||
$mainMenu = collect($response->json('main_menu'));
|
||||
$moduleItem = $mainMenu->firstWhere('name', 'module-sales-tax-us');
|
||||
|
||||
expect($moduleItem)->not->toBeNull();
|
||||
expect($moduleItem['link'])->toBe('/admin/modules/sales-tax-us/settings');
|
||||
expect($moduleItem['icon'])->toBe('CalculatorIcon');
|
||||
expect($moduleItem['group'])->toBe('modules');
|
||||
});
|
||||
|
||||
test('bootstrap returns empty module_menu when nothing is registered', function () {
|
||||
getJson('api/v1/bootstrap')
|
||||
->assertOk()
|
||||
->assertJsonPath('module_menu', []);
|
||||
test('module items support custom group and priority', function () {
|
||||
Registry::registerMenu('sales-tax-us', [
|
||||
'title' => 'sales_tax_us::menu.title',
|
||||
'link' => '/admin/modules/sales-tax-us/settings',
|
||||
'icon' => 'CalculatorIcon',
|
||||
'group' => 'documents',
|
||||
'priority' => 25,
|
||||
]);
|
||||
|
||||
$response = getJson('api/v1/bootstrap')->assertOk();
|
||||
|
||||
$mainMenu = collect($response->json('main_menu'));
|
||||
$moduleItem = $mainMenu->firstWhere('name', 'module-sales-tax-us');
|
||||
|
||||
expect($moduleItem['group'])->toBe('documents');
|
||||
expect($moduleItem['priority'])->toBe(25);
|
||||
});
|
||||
|
||||
test('admin-mode bootstrap does not include module_menu', function () {
|
||||
test('bootstrap has no module items when nothing is registered', function () {
|
||||
$response = getJson('api/v1/bootstrap')->assertOk();
|
||||
|
||||
$mainMenu = collect($response->json('main_menu'));
|
||||
$moduleItems = $mainMenu->filter(fn ($item) => str_starts_with($item['name'], 'module-'));
|
||||
|
||||
expect($moduleItems)->toBeEmpty();
|
||||
});
|
||||
|
||||
test('admin-mode bootstrap does not include module items', function () {
|
||||
Registry::registerMenu('sales-tax-us', [
|
||||
'title' => 'sales_tax_us::menu.title',
|
||||
'link' => '/admin/modules/sales-tax-us/settings',
|
||||
@@ -53,7 +78,8 @@ test('admin-mode bootstrap does not include module_menu', function () {
|
||||
|
||||
$response = getJson('api/v1/bootstrap?admin_mode=1');
|
||||
|
||||
// Super-admin branch should not include the dynamic Modules sidebar group —
|
||||
// that surface only exists in the company context.
|
||||
$response->assertJsonMissingPath('module_menu');
|
||||
$mainMenu = collect($response->json('main_menu'));
|
||||
$moduleItems = $mainMenu->filter(fn ($item) => str_starts_with($item['name'] ?? '', 'module-'));
|
||||
|
||||
expect($moduleItems)->toBeEmpty();
|
||||
});
|
||||
|
||||
@@ -93,6 +93,7 @@ test('includes registered menu entry for active modules', function () {
|
||||
|
||||
$response = getJson('api/v1/company-modules')->assertOk();
|
||||
|
||||
$response->assertJsonPath('data.0.display_name', 'Menu Module');
|
||||
$response->assertJsonPath('data.0.menu.title', 'menu_module::menu.title');
|
||||
$response->assertJsonPath('data.0.menu.icon', 'CalculatorIcon');
|
||||
});
|
||||
|
||||
@@ -4,7 +4,6 @@ use App\Models\CompanySetting;
|
||||
use App\Models\Module;
|
||||
use App\Models\User;
|
||||
use Illuminate\Support\Facades\Artisan;
|
||||
use InvoiceShelf\Modules\Registry;
|
||||
use Laravel\Sanctum\Sanctum;
|
||||
|
||||
use function Pest\Laravel\getJson;
|
||||
@@ -14,7 +13,7 @@ use function Pest\Laravel\putJson;
|
||||
* Integration test that exercises the real Modules/HelloWorld module end-to-end
|
||||
* — no Registry mocking. Proves that when an active module's ServiceProvider
|
||||
* registers menu + settings via InvoiceShelf\Modules\Registry, the host app's
|
||||
* bootstrap, company-modules index, and settings controllers all surface it.
|
||||
* company-modules index and settings controllers surface it consistently.
|
||||
*
|
||||
* The HelloWorld module's provider boots automatically because nwidart sees
|
||||
* it in `storage/app/modules_statuses.json` (set to enabled when the module
|
||||
@@ -39,18 +38,19 @@ beforeEach(function () {
|
||||
);
|
||||
});
|
||||
|
||||
test('HelloWorld registers a menu entry visible in bootstrap', function () {
|
||||
test('bootstrap merges HelloWorld into main_menu under modules group', function () {
|
||||
$response = getJson('api/v1/bootstrap')->assertOk();
|
||||
|
||||
$menu = collect($response->json('module_menu'));
|
||||
$entry = $menu->firstWhere('link', '/admin/modules/hello-world/settings');
|
||||
$mainMenu = collect($response->json('main_menu'));
|
||||
$helloWorld = $mainMenu->firstWhere('name', 'module-hello-world');
|
||||
|
||||
expect($entry)->not->toBeNull();
|
||||
expect($entry['title'])->toBe('helloworld::menu.title');
|
||||
expect($entry['icon'])->toBe('HandRaisedIcon');
|
||||
expect($helloWorld)->not->toBeNull();
|
||||
expect($helloWorld['link'])->toBe('/admin/modules/hello-world/dashboard');
|
||||
expect($helloWorld['icon'])->toBe('HandRaisedIcon');
|
||||
expect($helloWorld['group'])->toBe('modules');
|
||||
});
|
||||
|
||||
test('HelloWorld appears in the company Active Modules index with has_settings flag', function () {
|
||||
test('HelloWorld appears in the company Active Modules index with translated display name', function () {
|
||||
$response = getJson('api/v1/company-modules')->assertOk();
|
||||
|
||||
// The DB row stores PascalCase but the controller normalizes to kebab-case
|
||||
@@ -58,20 +58,23 @@ test('HelloWorld appears in the company Active Modules index with has_settings f
|
||||
$row = collect($response->json('data'))->firstWhere('slug', 'hello-world');
|
||||
expect($row)->not->toBeNull();
|
||||
expect($row['name'])->toBe('HelloWorld');
|
||||
expect($row['display_name'])->toBe('Hello World');
|
||||
expect($row['has_settings'])->toBeTrue();
|
||||
expect($row['menu']['title'])->toBe('Hello World');
|
||||
expect($row['menu']['icon'])->toBe('HandRaisedIcon');
|
||||
});
|
||||
|
||||
test('GET module settings returns the HelloWorld schema with defaults', function () {
|
||||
test('GET module settings returns the translated HelloWorld schema with defaults', function () {
|
||||
$response = getJson('api/v1/modules/hello-world/settings')->assertOk();
|
||||
|
||||
$sections = $response->json('schema.sections');
|
||||
expect($sections)->toHaveCount(2);
|
||||
expect($sections[0]['title'])->toBe('helloworld::settings.greeting_section');
|
||||
expect($sections[0]['title'])->toBe('Greeting');
|
||||
|
||||
$fields = collect($sections[0]['fields'])->keyBy('key');
|
||||
expect($fields)->toHaveKeys(['greeting', 'recipient', 'show_emoji']);
|
||||
expect($fields['greeting']['type'])->toBe('text');
|
||||
expect($fields['greeting']['label'])->toBe('Greeting message');
|
||||
expect($fields['greeting']['rules'])->toContain('required');
|
||||
|
||||
// Defaults flow through when nothing has been saved yet
|
||||
|
||||
@@ -48,6 +48,7 @@ test('module:make generates a ServiceProvider that uses InvoiceShelf\\Modules\\R
|
||||
$contents = File::get($providerPath);
|
||||
|
||||
expect($contents)->toContain('use InvoiceShelf\\Modules\\Registry as ModuleRegistry;');
|
||||
expect($contents)->toContain('use InvoiceShelf\\Modules\\Support\\ModuleServiceProvider;');
|
||||
expect($contents)->toContain('ModuleRegistry::registerMenu(');
|
||||
expect($contents)->toContain('ModuleRegistry::registerSettings(');
|
||||
expect($contents)->toContain("protected string \$name = '{$this->scaffoldModule}';");
|
||||
|
||||
Reference in New Issue
Block a user