Cbox Sync for Laravel

Offline-first sync for Laravel applications: one authoritative server, many replicas, field-level conflicts that are preserved rather than silently overwritten.

This package is the Laravel integration. The engine and its durable storage live in cboxdk/sync, which has no framework dependency; this one wires it into the container, uses one of the application's own database connections, and delegates transaction control to Laravel so it composes with DB::transaction().

composer require cboxdk/laravel-sync
php artisan migrate

use Cbox\Sync\Data\FieldOperation;
use Cbox\Sync\Data\Mutation;
use Cbox\Sync\Engine;
use Cbox\Sync\Enums\MutationKind;
use Cbox\Sync\ValueObjects\EntityKey;
use Cbox\Sync\ValueObjects\MutationSequence;
use Cbox\Sync\ValueObjects\RecordVersion;
use Cbox\Sync\ValueObjects\Replica;

$result = app(Engine::class)->process(new Mutation(
    id: $clientMutationId,
    entity: new EntityKey('tenant-1', 'notes', $noteId),
    replica: new Replica($deviceId),
    sequence: new MutationSequence($clientSequence),
    kind: MutationKind::Update,
    baseVersion: new RecordVersion($knownVersion),
    operations: [FieldOperation::set('title', $title)],
));

Start with the quickstart. See installation, testing and configuration.

Requires PHP ^8.4 and Laravel 12 or 13. Requirements are generated from Composer metadata.

The HTTP endpoints ship with the package but are off by default: your application owns authentication and decides how a space is resolved from a request. It ships no UI. A space accepts one concurrent writer by design — it is the ordering boundary — so pick spaces that match your tenancy.

MIT, copyright Cbox. See LICENSE and BUILD-STATUS.md.