Weave Code
Custom Fields Laravel Package
aureuserp/custom-fields
A Laravel package for Aureus ERP that lets you attach dynamic custom fields to modules without schema changes. Define fields, store values, and render them in forms and views to extend core entities with flexible, configurable data.
At a glance
Frequently asked questions about Custom Fields
- What is the aureuserp/custom-fields package used for?
- It is a Laravel package for Aureus ERP that lets you attach dynamic custom fields to modules without altering core database schemas. You define field metadata, store values, and render the fields in forms and views to extend entities with configurable data. It fits best as an extension layer for low-to-medium criticality domain objects such as accounts, contacts, orders, projects, or configuration records. Avoid making it the primary storage model for high-volume financial ledger tables or strictly regulated entities until storage and indexing behavior are proven.
- How do I install aureuserp/custom-fields in a Laravel application?
- The expected path is a Composer require, service-provider registration, publishing config and migrations, running migrations, and applying a trait or contract to target Eloquent models. You then define field metadata through the package APIs or an admin surface and verify CRUD, querying, validation, permissions, and tenant isolation. Because adoption is low and the public API surface is not fully documented in the overview, confirm the exact install steps against the repository README and composer.json before integrating. Start with a time-boxed proof of concept on one non-critical module.
- Which Laravel and PHP versions does this package support?
- The provided material does not confirm the supported Laravel and PHP version matrix, so you should check composer.json, the CI configuration, and recent release notes. Validate it against the exact Laravel, PHP, and database versions your product uses, including MySQL or PostgreSQL behavior. If your application uses Filament, Livewire, or a separate API layer, treat frontend and API compatibility as a separate validation track. Pin the package version once a compatible combination is confirmed.
- How does aureuserp/custom-fields store custom field values?
- The overview does not state whether values are stored as JSON, EAV rows, or physical columns, and that choice materially affects query performance, indexing, and reporting. Inspect the published migrations and model code before committing to the package. Test list queries, report queries, exports, and search with realistic tenant data volumes. If the storage strategy creates weak indexing or complex joins, limit use to lower-volume entities or add application-level indexing and caching.
- Can I use aureuserp/custom-fields outside Aureus ERP?
- The package is described as Laravel-native but built for Aureus ERP, so it may rely on Aureus conventions, service providers, or UI assumptions. It is reasonable to evaluate it for another Laravel business application, but only after a technical spike confirms dependencies and integration points. Check whether it requires specific tenancy, authorization, audit, or admin-panel layers. If those dependencies are tightly coupled to Aureus ERP, adapting it may cost more than building a small internal custom-field layer.
- How do I attach custom fields to an Eloquent model?
- The usual pattern is to apply a package trait or implement a contract on the target model, then register field definitions for that entity. You should verify the exact trait name, field-definition API, casting behavior, and query scopes in the repository code. After wiring one model, test create, read, update, delete, validation, and filtered queries before extending to additional modules. Do not migrate existing core columns into dynamic fields without a separate data-model review.
- Does the package handle validation, permissions, and multi-tenancy?
- The overview does not guarantee built-in validation hooks, authorization rules, audit trails, or tenant isolation, so treat these as verification items. Even if the package offers hooks, your application should enforce validation and authorization at its own boundaries. Multi-tenant isolation is especially important because field definitions and values can leak across tenants if scopes are missed. Add automated tests for permissions, tenant isolation, and schema changes before enabling customer-facing customization.
- What are the performance concerns with dynamic custom fields?
- Dynamic-field models often introduce query complexity, weak indexing, and slower list, report, export, and search operations. Validate performance with realistic tenant volumes rather than small development datasets. Pay attention to how values are joined or filtered and whether common fields can be indexed. Avoid using the package initially for high-volume financial ledger tables or entities with strict regulatory reporting requirements until storage and indexing behavior are proven.
- Does aureuserp/custom-fields provide UI components or a REST API?
- The package overview mentions rendering fields in forms and views, but it does not clearly confirm whether it ships Filament components, Blade helpers, or a REST API. Treat UI and API integration as separate compatibility tracks and inspect the repository for frontend dependencies. If no admin UI is included, plan to build your own field-management screens and API endpoints around the package APIs. Confirm how field definitions are created, edited, validated, and versioned before exposing them to end users.
- Is aureuserp/custom-fields production-ready and well maintained?
- Adoption signals are weak, with roughly 10 stars, so it should be treated as a due-diligence candidate rather than a strategic dependency. The MIT license lowers legal friction but does not reduce operational ownership, and community support is unlikely to offset maintenance if upstream activity stalls. Pin versions, review upgrades deliberately, and establish an internal owner plus a runbook for field-definition errors, migrations, permissions, and data-quality issues. Have a documented fork or exit plan before production rollout.
Weaver
How can I help you explore Laravel packages today?