Weave Code
Acme Schemas Laravel Package
gdbots/acme-schemas
gdbots/acme-schemas supplies PHP schema definitions for the Acme domain, giving Laravel applications typed classes for messages and events so data stays consistent across services. Install with Composer to share a common contract for serialization and validation.
Sample schemas for common gdbots services
Frequently asked questions about Acme Schemas
- What is gdbots/acme-schemas used for?
- It provides generated PHP classes and schema definitions for the Acme domain used in the GDBots ecosystem. The classes represent Acme messages and entities so services can share a typed contract for validation and serialization. It is primarily a test or reference schema package rather than a general Laravel library.
- Is gdbots/acme-schemas a Laravel package?
- No, it is framework-agnostic and Composer-installable, so it can be loaded into a Laravel app, but it is not built around Laravel idioms such as Eloquent, form requests, or API resources. It supplies PBJ-style generated message classes, not Eloquent models or Laravel validation rules. Treat it as a data-contract layer, not a Laravel integration.
- How do I install gdbots/acme-schemas with Composer?
- Run composer require gdbots/acme-schemas in your project. Composer will autoload the generated PHP classes if your autoloading is configured normally. Because the package targets the GDBots runtime, verify that gdbots/schemas and the PBJ dependencies match your application's PHP version and constraints.
- Does gdbots/acme-schemas support Laravel 10 and Laravel 11?
- Laravel 10 or 11 on PHP 8.1+ should be technically compatible with the gdbots/schemas v3 line, but this needs verification against the actual composer.json constraints. The package is not Laravel-specific, so Laravel version support depends on PHP and transitive dependency compatibility. Test installation in a scratch branch before committing to it.
- What dependencies does gdbots/acme-schemas require?
- The package sits on top of gdbots/schemas v3.x and is expected to need the PBJ runtime, likely gdbots/pbj and possibly gdbots/pbjx for message bus usage. Its constraints may also pull in transitive packages from the GDBots ecosystem. Check composer.json for exact PHP, gdbots/*, Symfony, or AWS SDK requirements before installing.
- Is gdbots/acme-schemas safe for production use?
- The TPM assessment recommends treating it as a reference implementation rather than a production dependency. It has zero stars, zero dependents, and no external validation, and the Acme entities are placeholders rather than real business models. For production, consider forking and owning an internal package or writing plain DTOs with Laravel validation.
- Is gdbots/acme-schemas maintained?
- Maintenance signals are weak: zero stars, zero dependents, and the last release was June 2023. The sole changelog entry noted is a dependency bump. Check the upstream GDBots packages such as gdbots/schemas and gdbots/pbj for current release cadence before relying on this package.
- How does validation work in gdbots/acme-schemas?
- Validation is part of the generated schema model rather than Laravel form requests or validator rules. The classes are generated from Acme schemas and support structured data validation and serialization through the GDBots/PBJ conventions. You would use the PBJ runtime's field presence and validation semantics, not Laravel's native validation layer.
- Can I customize gdbots/acme-schemas for my own domain?
- Yes, but the practical path is to fork the repository and replace the Acme namespace and domain with your own. Then regenerate the PHP classes using the GDBots schema toolchain against your schema definitions. That is a multi-day to multi-week effort for someone new to PBJ, not a simple config change.
- What are alternatives to gdbots/acme-schemas for Laravel?
- For typical Laravel apps, plain DTOs plus Laravel validation rules, Eloquent models, and API resources are simpler alternatives. If you need schema-first messaging, evaluate the broader GDBots stack or another maintained schema and serialization library. Only adopt acme-schemas if you specifically need the Acme test contract or plan to fork and own it.
Weaver
How can I help you explore Laravel packages today?