README

At Opscale, we’re passionate about contributing to the open-source community by providing solutions that help businesses scale efficiently. If you’ve found our tools helpful, here are a few ways you can show your support:

⭐ Star this repository to help others discover our work and be part of our growing community. Every star makes a difference!

💬 Share your experience by leaving a review on Trustpilot or sharing your thoughts on social media. Your feedback helps us improve and grow!

📧 Send us feedback on what we can improve at feedback@opscale.co. We value your input to make our tools even better for everyone.

🙏 Get involved by actively contributing to our open-source repositories. Your participation benefits the entire community and helps push the boundaries of what’s possible.

💼 Hire us if you need custom dashboards, admin panels, internal tools or MVPs tailored to your business. With our expertise, we can help you systematize operations or enhance your existing product. Contact us at hire@opscale.co to discuss your project needs.

Thanks for helping Opscale continue to scale! 🚀

Description

Create Nova resources UI (tables and forms) based on dynamic configuration stored in the database. Perfect for quick prototyping when you need to rapidly create and iterate on data structures without writing code.

Important

This package is experimental and it's not inteded to be used in production (yet)

Installation

You can install the package in to a Laravel app that uses Nova via composer:

composer require opscale-co/nova-dynamic-resources

Next up, you must register the tool with Nova. This is typically done in the tools method of the NovaServiceProvider.

// in app/Providers/NovaServiceProvider.php
// ...
public function tools()
{
    return [
        // ...
        new \Opscale\NovaDynamicResources\Tool(),
    ];
}

Usage

This package provides three different approaches to create dynamic resources, each suited for different use cases:

Type	Use Case	Model	Nova Resource	Fields
Dynamic	Fully dynamic resources	Uses `Record` model	Auto-generated	All from template
Inherited	Own model/table with `template_id`	Custom with `UsesTemplate`	Custom with `UsesTemplate`	Static + template
Composited	Add dynamic fields to existing models	Existing model with `UsesTemplate`	Existing resource with `UsesTemplate`	Static + template

1. Dynamic Type

Best for: Rapid prototyping, admin-configurable resources, or when you don't need custom business logic.

Dynamic templates create fully dynamic resources where both the model and Nova resource are generated automatically. All data is stored in the dynamic_resources_records table.

Setup

Simply create a template in Nova or via seeder:

use Opscale\NovaDynamicResources\Models\Template;
use Opscale\NovaDynamicResources\Models\Enums\TemplateType;

Template::create([
    'label' => 'Events',
    'singular_label' => 'Event',
    'uri_key' => 'events',
    'title' => 'name',
    'type' => TemplateType::Dynamic,
    'related_class' => null,
]);

Then add fields to the template:

$template->fields()->createMany([
    ['type' => 'name', 'label' => 'Name', 'name' => 'name', 'required' => true],
    ['type' => 'description', 'label' => 'Description', 'name' => 'description'],
    ['type' => 'address', 'label' => 'Address', 'name' => 'address'],
    ['type' => 'date', 'label' => 'Date', 'name' => 'date', 'required' => true],
]);

The resource will appear automatically in Nova's sidebar.

2. Inherited Type

Best for: When you have a base model that needs different dynamic fields depending on conditions. Each record can reference a different template, allowing varied field configurations per record.

Inherited templates use your own Eloquent model with a template_id foreign key. This allows you to have a dedicated table for your records while still leveraging dynamic fields from templates.

1. Database Migration

Create a migration for your model's table with a template_id foreign key, your static columns, and a data JSON column for dynamic template fields:

Schema::create('products', function (Blueprint $table) {
    $table->id();
    $table->foreignId('template_id')->constrained('dynamic_resources_templates')->cascadeOnDelete();
    // Static columns
    $table->string('name');
    $table->text('description')->nullable();
    $table->decimal('price', 10, 2);
    $table->unsignedInteger('stock')->default(0);
    // Dynamic template fields stored here
    $table->json('data')->nullable();
    $table->timestamps();
});

2. Model Setup

Create your model with the UsesTemplate trait:

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Opscale\NovaDynamicResources\Models\Concerns\UsesTemplate;

class Product extends Model
{
    use UsesTemplate;

    protected $fillable = [
        'template_id',
        'name',
        'description',
        'price',
        'stock',
        'data',
    ];

    protected $casts = [
        'price' => 'decimal:2',
        'stock' => 'integer',
        'data' => 'array',
    ];
}

The UsesTemplate trait automatically detects the template_id field and uses a belongsTo relationship to the template.

3. Create the Template

use Opscale\NovaDynamicResources\Models\Template;
use Opscale\NovaDynamicResources\Models\Enums\TemplateType;

Template::create([
    'label' => 'Products',
    'singular_label' => 'Product',
    'uri_key' => 'products',
    'title' => 'name',
    'type' => TemplateType::Inherited,
    'related_class' => \App\Nova\Product::class,
]);

4. Add Template Fields

Add dynamic fields that will be stored in the data JSON column:

$template->fields()->createMany([
    ['type' => 'quantity', 'label' => 'Weight', 'name' => 'weight'],
    ['type' => 'quantity', 'label' => 'Height', 'name' => 'height'],
    ['type' => 'quantity', 'label' => 'Width', 'name' => 'width'],
]);

5. Nova Resource Integration

Create a Nova resource with the UsesTemplate trait. You can define static fields before the dynamic template fields:

namespace App\Nova;

use Laravel\Nova\Fields\BelongsTo;
use Laravel\Nova\Fields\Currency;
use Laravel\Nova\Fields\ID;
use Laravel\Nova\Fields\Number;
use Laravel\Nova\Fields\Text;
use Laravel\Nova\Fields\Textarea;
use Laravel\Nova\Http\Requests\NovaRequest;
use Laravel\Nova\Resource;
use Opscale\NovaDynamicResources\Nova\Concerns\UsesTemplate;

class Product extends Resource
{
    use UsesTemplate;

    public static $model = \App\Models\Product::class;

    public static $title = 'name';

    public function fields(NovaRequest $request): array
    {
        return [
            ID::make()->sortable(),

            BelongsTo::make(__('Template'), 'template', \Opscale\NovaDynamicResources\Nova\Template::class)
                ->searchable()
                ->withoutTrashed(),

            // Static fields defined in the Nova resource
            Text::make(__('Name'), 'name')
                ->sortable()
                ->rules('required', 'string', 'max:255'),

            Textarea::make(__('Description'), 'description')
                ->rules('nullable', 'string')
                ->hideFromIndex(),

            Currency::make(__('Price'), 'price')
                ->sortable()
                ->rules('required', 'numeric', 'min:0'),

            Number::make(__('Stock'), 'stock')
                ->sortable()
                ->rules('required', 'integer', 'min:0')
                ->default(0),

            // Dynamic fields from the associated template
            ...$this->renderTemplateFields(),
        ];
    }
}

The Product resource will display the static database fields (name, description, price, stock) followed by any dynamic fields defined in the template (weight, height, width) which are stored in the data JSON column.

3. Composited Type

Best for: When you need the same extra dynamic fields for all records of an existing model. All records share the same template, linked via the Nova resource class.

Composited templates attach dynamic fields to existing models (like User, Order, etc.) and Nova resources. The dynamic field values are stored in a data JSON column on the existing table.

1. Database Migration

Add a data column to your existing table:

Schema::table('users', function (Blueprint $table) {
    $table->json('data')->nullable();
});

2. Model Setup

Add the UsesTemplate trait to your model:

use Opscale\NovaDynamicResources\Models\Concerns\UsesTemplate;

class User extends Authenticatable
{
    use UsesTemplate;

    protected $fillable = [
        'name',
        'email',
        'password',
        'data', // Add this
    ];
}

The UsesTemplate trait provides:

A template() relationship to access the model's template configuration
A fields() relationship to access the template's fields
Dynamic data storage and retrieval via the data JSON column
Automatic eager loading of template and fields

3. Create the Template

use Opscale\NovaDynamicResources\Models\Template;
use Opscale\NovaDynamicResources\Models\Enums\TemplateType;

Template::create([
    'label' => 'Users',
    'singular_label' => 'User',
    'uri_key' => 'users',
    'title' => 'name',
    'type' => TemplateType::Composited,
    'related_class' => \App\Nova\User::class,
]);

4. Add Template Fields

$template->fields()->createMany([
    ['type' => 'phone', 'label' => 'Phone', 'name' => 'phone'],
]);

5. Nova Resource Integration

Add the UsesTemplate trait to your Nova resource and use renderTemplateFields() to render the dynamic fields:

use Opscale\NovaDynamicResources\Nova\Concerns\UsesTemplate;

class User extends Resource
{
    use UsesTemplate;

    public function fields(NovaRequest $request): array
    {
        return [
            // Your existing static fields...
            ID::make()->sortable(),
            Text::make('Name'),
            Text::make('Email'),
            Password::make('Password')->onlyOnForms(),

            // Render dynamic fields from template
            ...$this->renderTemplateFields(),
        ];
    }
}

This approach allows you to extend existing models with configurable fields without modifying the database schema beyond the data column.

Field Configuration

Each field in your dynamic resource consists of:

Label: The display name for the field
Name: The database column name
Type: The business field type (see available types below)
Required: Whether the field is mandatory
Validation Rules: Additional Laravel validation rules
Config: Field-specific configuration options
Hooks: Action classes that process config values before applying them to fields

Available Field Types

Field types are based on business logic and can be found in the config/nova-dynamic-resources.php configuration file. Each type maps to a specific Nova field class with predefined behavior.

You can add more field types by extending the configuration file. The available types include common business field patterns like text, email, phone, address, etc. Business types are used instead of technical field types because they carry implicit validation rules and configuration - for example, an "email" type automatically includes email format validation, while a "phone" type includes phone number pattern validation.

Field Configuration Options

The Config section allows you to call specific methods on the Nova field instance. For example:

required => true is equivalent to calling ->required(true) on the field
placeholder => "Enter your name" calls ->placeholder("Enter your name")
help => "This field is important" calls ->help("This field is important")

This approach provides flexibility to configure Nova fields dynamically while maintaining type safety and IDE support.

Field Hooks Options

The Hooks section allows you to intercept and transform config values before they are applied to the field. Hooks are action classes that extend Opscale\Actions\Action and process the config value dynamically.

For example, when a field type has:

'config' => [
    'options' => 'gender',
],
'hooks' => [
    'options' => \Opscale\NovaDynamicResources\Services\Actions\SelectOptions::class,
]

The SelectOptions hook will be called with the value 'gender' and will fetch the actual options from a catalog, returning them to be passed to the ->options() method on the field.

This is useful for:

Fetching dynamic data from the database (e.g., select options from catalogs)
Transforming values before applying them to fields
Running custom logic based on field configuration

Testing

npm run test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email development@opscale.co instead of using the issue tracker.

Credits

Opscale

License

The MIT License (MIT). Please see License File for more information.

opscale-co / nova-dynamic-resources

Maintainers

Details

README

Description

Installation

Usage

1. Dynamic Type

Setup

2. Inherited Type

1. Database Migration

2. Model Setup

3. Create the Template

4. Add Template Fields

5. Nova Resource Integration

3. Composited Type

1. Database Migration

2. Model Setup

3. Create the Template

4. Add Template Fields

5. Nova Resource Integration

Field Configuration

Available Field Types

Field Configuration Options

Field Hooks Options

Testing

Changelog

Contributing

Security

Credits

License