nickwelsh / zero-for-laravel

v0.7.0 2026-11-05 03:53 UTC

Requires

• php: ^8.3
• casbin/casbin: ^4.6
• laravel/framework: ^12.0|^13.0
• laravel/ranger: ^0.5.1
• laravel/surveyor: ^0.3.0
• phpstan/phpdoc-parser: ^2.3

Requires (Dev)

• driftingly/rector-laravel: ^2.3
• formbraid/laravel: ^0.3.0
• inertiajs/inertia-laravel: ^3.0
• larastan/larastan: ^3.9
• laravel/pint: ^1.0
• laravel/scout: ^10.0 || ^11.0
• laravel/wayfinder: dev-next
• orchestra/testbench: ^10.0|^11.0
• peckphp/peck: ^0.3.0
• pestphp/pest: ^4.0
• pestphp/pest-plugin-laravel: ^4.0
• rector/rector: ^2.4
• typesense/typesense-php: ^6.0

Suggests

• formbraid/laravel: Generate Formbraid descriptors and live option sources for Zero controller mutations (^0.3.0).
• laravel/scout: Synchronize optional Typesense search indexes with Eloquent models.
• typesense/typesense-php: Use the optional authenticated InstantSearch transport.

Conflicts

• phpstan/phpstan: 2.3.4

MIT

Published on Packagist.org on 2026-11-05 05:27 UTC

README

Controller-first live queries and mutations for Rocicorp Zero 1.11.3.

Use v0.7.0 with the matching npm package. Generate and deploy PHP registrations and TypeScript contracts together. PHP 8.3+, Laravel 12/13, and PostgreSQL 15+ with logical replication are required targets. Automatic live page props require Inertia Laravel 3 and the optional JavaScript Inertia adapter.

Controllers declare immutable Model::zeroQuery() live props and explicitly opt actions into #[ZeroMutation]. Ranger/Surveyor-backed generation emits coordinated PHP registrations, native ZQL/mutators, validation schemas, result codecs, and named controller modules. Laravel retains real binding, middleware, FormRequests, Gates, and Eloquent. Zero retains replication, optimistic replay, ordering, and durable mutation results.

Zero does not generate global page types. Optionally register ZeroForLaravel\WayfinderServiceProvider with Wayfinder dev-next to specialize its own generated live props; run Zero generation before Wayfinder generation.

php artisan vendor:publish --tag=zero-config
php artisan zero:generate --react
php artisan zero:sync-publication --dry-run

Review and apply publication changes to the application's configured PostgreSQL database. Deploy generated PHP and TypeScript together; use zero:generate --check in CI. Keep the cache API key server-side and independently authenticate end users.

Optional Effect schemas

Zod remains the default generated validator. Applications using Effect 4 can set 'schema_driver' => 'effect' in config/zero.php, install effect in their JavaScript application, and rerun php artisan zero:generate. The Effect driver is tested with Effect 4.0.2; it does not require Formbraid or a Formbraid upgrade.

Generated mutation actions expose native Effect schemas as inputSchema and serverResultSchema. They remain usable with Effect composition and Formbraid's schema option, while retaining the synchronous .parse() API used by Zero:

import { Schema } from 'effect';
import { store } from '@/zero/App/Http/Controllers/TodoController';

const input = store.inputSchema.parse({ title: 'New task' });
const batch = Schema.Array(store.inputSchema);

Generated query validators also implement Standard Schema for native Zero. Both compatibility adapters reject unknown object keys and preserve nested field errors. When decoding a composed schema through Effect directly, pass { onExcessProperty: 'error' } to its decoder to retain that strictness; Effect's default otherwise strips unknown keys. Generated validation is synchronous and requires no Effect services. Add asynchronous or service-dependent form validation outside Zero's optimistic replay.

The driver changes only generated TypeScript validators. PHP registrations, wire encodings, and mutation fingerprints stay unchanged. Effect imports occur only in opted-in generated files, never in the core or table runtime packages.

See the monorepo guide and shared todos example. Development and issues belong in the source monorepo, not the distribution mirror.