vitisstudio/restdb-contracts

Contracts, value objects, and capability primitives for the RestDB Eloquent driver

Maintainers

Package info

github.com/VitisStudio/restdb-contracts

Homepage

Issues

pkg:composer/vitisstudio/restdb-contracts

Transparency log

Statistics

Installs: 29

Dependents: 1

Suggesters: 0

Stars: 0

Security

Advisories: 0

Aikido package health analysis

v0.1.2 2026-08-06 17:33 UTC

Requires

MIT 430b8eae5720f3b074de3a37fe7821e51ea4e93f

  • Dan Poblete <dan.woop@vitis.studio>

restapidriverlaraveleloquentcontracts

Published on Packagist.org on 2026-08-07 15:33 UTC

This package is auto-updated.

Last update: 2026-08-07 15:33:57 UTC

README

The SPI for the RestDB Eloquent driver: contracts, immutable value objects, and capability primitives. Depends on nothing from the driver — implement these to build an adapter.

  • Contracts — Adapter, RequestCompiler, ResponseParser, Paginator, Authenticator/RefreshableAuthenticator, ResolvesEndpoints, FilterDialect, SpecParser, and the RestDBException marker.
  • Values — intents (SelectIntent, InsertIntent, UpdateIntent, DeleteIntent), filters (FilterGroup, Condition), paging (PageRequest, PageInfo), wire shapes (CompiledRequest, ApiResponse, ResultPage, WriteResult, ErrorBag, EmptyResult), and ConnectionConfig.
  • Capabilities — the Capability and Operator enums, the immutable CapabilitySet, and the CapabilityGate whose exceptions name the connection, capability, model, method, and fix.

An adapter is a factory of strategies — compiler, parser, paginator, endpoint resolver, capability baseline. Validate yours against Vitis\RestDB\Testing\AdapterConformanceKit (shipped with vitisstudio/restdb).