Modular Discovery System (MDS) for Laravel

Enterprise-grade framework for automatic component registration and management in Laravel and Livewire 3.

Powered by laravel-package-toolkit - Uses modern package toolkit for streamlined package registration and management.

Installation

Via Composer (as a package)

composer require nyoncode/wire-mds

Publish configuration (optional)

# Use install command (recommended)
php artisan discovery:install

# Or manually
php artisan vendor:publish --tag=discovery::config
php artisan vendor:publish --tag=discovery::views

Basic Usage

Livewire component with MDS

<?php

namespace App\Livewire\Admin;

use NyonCode\WireMds\Attributes\Access;
use NyonCode\WireMds\Attributes\Navigation;
use NyonCode\WireMds\Attributes\Seo;
use NyonCode\WireMds\Attributes\WebRoute;
use NyonCode\WireMds\Traits\WithDiscoveryAccess;
use Livewire\Component;

#[WebRoute(
    uri: '/dashboard',
    name: 'admin.dashboard',
    zone: 'admin'
)]
#[Navigation(
    label: 'Dashboard',
    icon: 'home',
    sort: 10
)]
#[Access(permission: 'admin.dashboard.view')]
#[Seo(
    title: 'Admin Dashboard',
    description: 'Overview of administration'
)]
class Dashboard extends Component
{
    use WithDiscoveryAccess;

    public function render()
    {
        return view('livewire.admin.dashboard');
    }
}

Attributes

#[WebRoute]

Defines component routing.

#[WebRoute(
    uri: '/products/{id}/{slug?}',  // URI with parameters
    name: 'products.show',          // Route name (optional)
    zone: 'frontend',               // Zone (frontend, admin, customer)
    middleware: ['verified'],       // Additional middleware
    where: ['id' => '[0-9]+'],     // Regex constraints
    methods: ['GET'],              // HTTP methods
    domain: null                   // Domain constraint
)]

#[Navigation]

Metadata for UI navigation.

#[Navigation(
    label: 'Users',                    // Display text
    group: 'Settings.Users',           // Hierarchical group (dot-separated)
    icon: 'users',                     // Icon (Heroicons)
    sort: 20,                          // Order (lower = higher)
    hidden: false,                     // Hide from navigation
    badge: 'NEW',                      // Badge text
    badgeColor: 'bg-green-500',        // Badge color
    parent: 'admin.settings.index'     // Parent route for breadcrumbs
)]

#[Access]

Access control (Spatie Permission integration).

#[Access(
    permission: 'users.view',           // Required permission
    // or
    permission: ['users.view', 'admin.*'], // Multiple permissions (supports wildcards)
    roles: ['admin', 'manager'],        // Required roles
    require: 'any',                     // 'any' or 'all'
    guard: 'web',                       // Authentication guard
    authenticated: true,                // Requires authentication
    redirectTo: 'login',               // Redirect on unauthorized access
    httpCode: 403                      // HTTP code on denial
)]

#[Seo]

SEO and sitemap configuration.

#[Seo(
    title: 'Product: {name}',           // Title (supports placeholders)
    description: 'View {name} details', // Description
    noindex: false,                     // Disable indexing
    nofollow: false,                    // Disable link following
    sitemap_priority: 0.8,              // Sitemap priority (0.0-1.0)
    sitemap_frequency: 'weekly',        // Update frequency
    canonical: '/products/{slug}',      // Canonical URL
    og_image: '/images/product.png',    // Open Graph image
    og_type: 'product',                 // Open Graph type
    twitter_card: 'summary_large_image' // Twitter Card type
)]

Zones

Zones define URL prefixes, default middleware, and permissions.

Configuration (`config/discovery.php`)

'zones' => [
    'admin' => [
        'prefix' => '/admin',
        'middleware' => ['web', 'auth', 'verified'],
        'default_permission' => 'admin.*',
        'default_role' => 'admin',
        'layout' => 'layouts.admin',
    ],
    'customer' => [
        'prefix' => '/account',
        'middleware' => ['web', 'auth'],
        'default_permission' => 'customer.*',
        'layout' => 'layouts.customer',
    ],
    'frontend' => [
        'prefix' => '',
        'middleware' => ['web'],
        'default_permission' => null,  // Public
        'layout' => 'layouts.app',
    ],
],

Automatic Normalization

If a component in the admin zone doesn't have #[Access] defined, it automatically gets:

permission: 'admin.*'
authenticated: true

Cache

Generate cache (production)

php artisan discovery:cache

Clear cache

php artisan discovery:clear

Integration with `optimize`

Cache is automatically generated when running:

php artisan optimize

And cleared when running:

php artisan optimize:clear

SEO & Sitemap

Meta tags in Blade

<head>
    <x-discovery::meta-tags />
</head>

Dynamic settings in component

use NyonCode\WireMds\Facades\Seo;

public function mount(Product $product)
{
    Seo::set('title', "Product: {$product->name}");
    Seo::set('description', $product->description);
    Seo::set('og_image', $product->image_url);
}

Generate sitemap

# Generate sitemap.xml
php artisan discovery:sitemap

# Show URLs without generating
php artisan discovery:sitemap --show

Breadcrumbs

Basic usage

<x-discovery::breadcrumbs />

With dynamic parameters

<x-discovery::breadcrumbs :parameters="['name' => $product->name]" />

Register custom resolver

// In AppServiceProvider
use NyonCode\WireMds\Services\BreadcrumbService;

public function boot()
{
    app(BreadcrumbService::class)->registerResolver('products.show', function ($route, $params) {
        return Product::find($params['product'])?->name ?? 'Product';
    });
}

Navigation

In Blade template

<x-discovery::navigation zone="admin" />

With custom classes

<x-discovery::navigation 
    zone="admin"
    class="space-y-2"
    item-class="px-4 py-2"
    active-class="bg-blue-500 text-white"
    :show-icons="true"
    :show-badges="true"
/>

Programmatically

use NyonCode\WireMds\Services\NavigationBuilder;

$navigation = app(NavigationBuilder::class)->forZone('admin');
$flatNav = app(NavigationBuilder::class)->flatForZone('admin');

Blade Components

`<x-discovery::meta-tags />`

Renders all SEO meta tags.

`<x-discovery::breadcrumbs />`

Renders breadcrumb navigation.

Props:

parameters - Array for placeholder replacement
separator - Separator (default: /)
class - CSS classes for container

`<x-discovery::navigation />`

Renders hierarchical navigation.

Props:

zone - Zone (required)
class - CSS classes
show-icons - Show icons (default: true)
show-badges - Show badges (default: true)

Commands

Command	Description
`discovery:cache`	Generates cache manifest
`discovery:clear`	Clears cache
`discovery:list`	Shows all components
`discovery:sitemap`	Generates sitemap.xml

`discovery:list` options

# Filter by zone
php artisan discovery:list --zone=admin

# Public routes only
php artisan discovery:list --public

# Navigation items only
php artisan discovery:list --nav

# JSON output
php artisan discovery:list --json

WithDiscoveryAccess Trait

Trait automatically verifies permissions in mount() method.

use NyonCode\WireMds\Traits\WithDiscoveryAccess;

class MyComponent extends Component
{
    use WithDiscoveryAccess;
    
    // Permissions are checked automatically before mount()
}

Discoverable Interface

For components that need to provide additional metadata:

use NyonCode\WireMds\Contracts\Discoverable;

class MyComponent extends Component implements Discoverable
{
    public static function discoveryMeta(): array
    {
        return [
            'model' => User::class,
            'supports_export' => true,
        ];
    }
}

Facades

Discovery

use NyonCode\WireMds\Facades\Discovery;

$all = Discovery::all();
$component = Discovery::get('admin.dashboard');
$byUri = Discovery::findByUri('/admin/dashboard');
$adminRoutes = Discovery::getByZone('admin');
$publicRoutes = Discovery::getPublicRoutes();

Seo

use NyonCode\WireMds\Facades\Seo;

Seo::set('title', 'Custom Title');
Seo::setMany(['title' => '...', 'description' => '...']);
$data = Seo::getSeoData();
$html = Seo::render();

Best Practices

Always use cache in production - Reflection is slow
Define zones properly - Automatic normalization saves work
Use WithDiscoveryAccess - Consistent permission checking
Use wildcards carefully - admin.* is powerful but dangerous
SEO for public pages - Sitemap contains only public routes

License

MIT

Name		Name	Last commit message	Last commit date
Latest commit History 9 Commits
config		config
database/migrations		database/migrations
examples/Livewire		examples/Livewire
lang		lang
resources		resources
routes		routes
src		src
tests		tests
.gitignore		.gitignore
.prettierrc		.prettierrc
LICENSE		LICENSE
README.md		README.md
composer.json		composer.json
package.json		package.json

Folders and files

Latest commit

History

Repository files navigation

Modular Discovery System (MDS) for Laravel

Table of Contents

Installation

Via Composer (as a package)

Publish configuration (optional)

Basic Usage

Livewire component with MDS

Attributes

#[WebRoute]

#[Navigation]

#[Access]

#[Seo]

Zones

Configuration (config/discovery.php)

Automatic Normalization

Cache

Generate cache (production)

Clear cache

Integration with optimize

SEO & Sitemap

Meta tags in Blade

Dynamic settings in component

Generate sitemap

Breadcrumbs

Basic usage

With dynamic parameters

Register custom resolver

Navigation

In Blade template

With custom classes

Programmatically

Blade Components

<x-discovery::meta-tags />

<x-discovery::breadcrumbs />

<x-discovery::navigation />

Commands

discovery:list options

WithDiscoveryAccess Trait

Discoverable Interface

Facades

Discovery

Seo

Best Practices

License

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Configuration (`config/discovery.php`)

Integration with `optimize`

`<x-discovery::meta-tags />`

`<x-discovery::breadcrumbs />`

`<x-discovery::navigation />`

`discovery:list` options

Packages