Laravel Apiable Laravel Package

Added

• AssertableJsonApi::data(Closure) — scope into the data member using the full AssertableJson fluent API (where, has, missing, count, etc, dd, dump, when, tap, …)
• AssertableJsonApi::meta(Closure) — scope into meta
• AssertableJsonApi::links(Closure) — scope into links
• AssertableJsonApi::errors(Closure) — scope into errors
• AssertableJsonApi::included(Closure) — scope into included
• AssertableJsonApi::relationship(string $name, Closure) — scope into relationships.{name}.data of the current resource
• AssertableJsonApi::at(int $position, Closure $callback) — optional closure variant; when a callback is supplied the method runs assertions inside that scope and returns $this (the collection) for further chaining
• AssertableJsonApi::atRelation(Model $model, Closure $callback) — optional closure variant on atRelation
• AssertableJsonApi::assertIsJsonApiDocument() — validates the top-level JSON:API document structure (requires at least one of data/errors/meta; data and errors must not coexist; included requires data)
• Error documents (errors, no data) are now accepted by fromTestResponse and can be asserted via errors()

Changed

• AssertableJsonApi constructor is now aligned with the parent AssertableJson(array $props, ?string $path = null). All JSON:API state (id, type, attributes, relationships, included) is now derived from props via accessors instead of stored as separate fields. As a result, parent methods scope(), first(), each(), where(), has(), missing(), count(), etc(), dd(), dump(), when(), tap() are now fully functional on AssertableJsonApi instances.
• fromTestResponse no longer silently collapses a collection response to the first item. Calling hasAttribute(), hasId(), hasType(), or relationship methods directly on a collection root now operates on the root document, not the first item. Use ->at(0) to scope into a specific collection item before running those assertions.
• hasAttribute($name, $value) value comparison tightened. The old implementation used assertContains($value, $attributes) which matched the value against any attribute — regardless of key. The new implementation uses assertSame($value, $attributes[$name]) which correctly checks the exact key/value pair. Action required: any test that relied on the old loose matching (e.g. hasAttribute('subtitle', 'Hello') passing because a different key happened to hold 'Hello') needs to be corrected.
• hasAttribute($name, $value) skipping falsy values fixed. The old guard was if ($value), which skipped the value check when $value was 0, false, or ''. The guard is now if ($value !== null), so values of 0 and false are correctly asserted.
• toArray() now returns the full document props (delegating to AssertableJson::toArray()) instead of only the attributes of the current resource. Code that called ->toArray() to obtain attributes should use ->toArray()['data']['attributes'] or ->prop('data.attributes').
• hasNotAttribute($name, $value) semantics clarified. Without $value, asserts the attribute key is absent. With $value, asserts that either the key is absent or the key's value differs from $value. Previously the method always failed if the key existed, even when only checking that a specific value was not present.
• hasAttributes() now accepts both list form (['title', 'abstract'] — key existence only) and map form (['title' => 'Hello'] — key + exact value).

Fixed

• scope(), first(), each() from the parent now work correctly because the constructor matches the parent signature
• AssertableJsonApi::rootProps is threaded into child scopes so included, meta, and links are reachable from any scope depth

Added

• Apiable::modelResourceMap() to register custom JsonApiResource classes per model globally
• Apiable::jsonApiResourceFor() to resolve the registered resource class for a given model instance
• JsonApiResponse::usingResource() to override the resource class used for serialization per-response
• JsonApiResource::toApplicationJsonArray() for plain JSON serialization merging model attributes with computed ones

Fixed

• Related models in included relationships now resolve through the resource registry instead of always using the base JsonApiResource class
• Pivot relationship meta keys were not being prefixed correctly (array_walk callback was not returning the modified array); replaced with an explicit loop

Added

• Multiple scoped filters parameters values (e.g. /?filter[withStatuses]=Active&filter[withStatuses]=Archived) (#15)

Fixed

• Issue when included repeated relationships replaced others (#11)

Added

• apiable:docs command to generate API documentation from PHP attributes in Postman v2.1, Markdown/MDX, and OpenAPI 3.1 formats
• $description property to all *QueryParam attributes for documentation generation
• #[DocumentedResource], #[DocumentedEndpointSection], and #[EndpointResource] PHP attributes for annotating controllers
• OpenSoutheners\LaravelApiable\Documentation\Generator class for building resource documentation trees from registered routes
• OpenSoutheners\LaravelApiable\Http\JsonApiPaginator class exposing pagination logic as a typed static method
• Laravel 13 support

Fixed

• Handler::includesTrace() was calling env('APP_DEBUG') outside of the config directory, which returns null in production; now uses config('app.debug')
• IteratesResultsAfterQuery had leaked application-specific imports (App\Domain\Process\Models\Box\Box, App\Models\ModelForm) left over from a real project
• addAppendsToResult() instanceof JsonApiCollection check was unreachable because it was nested inside an instanceof JsonApiResource branch (since JsonApiCollection extends JsonApiResource); logic restructured to check the most-specific subtype first
• addAppendsToResult() instanceof Paginator branch was using the Paginator contract which does not declare through(); changed to AbstractPaginator
• CollectsResources::collects() was missing a return null fallback, causing PHPStan to report a missing return statement
• isScope() in ApplyFiltersToQuery was using get_parent_class() to exclude base builder methods, which could return false for unknown types; now diffs against Illuminate\Database\Eloquent\Builder::class directly, which is also more accurate
• Various PHPDoc type corrections in documentation exporters and Generator (malformed class name OpenSouthenersLaravelApiableDocumentationResource → \OpenSoutheners\LaravelApiable\Documentation\Resource)

Removed

• Laravel 11 support

Fixed

• Exceptions handler at issue #20

Added

• Appends to raw JSON responses

Fixed

• URL params getting double encoded

Fixed

• Laravel param inconsistency with paginator page number also applies to FastPaginate

Fixed

• Pagination returns wrong page name query parameter (Laravel framework is inconsistent around this)

Fixed

• Apiable::toJsonApi() given collection as input returns empty response

Fixed

• jsonApiPaginate() method typos

Fixed

• Page number resolver not properly retrieved for jsonApiPaginate() method
• Fast paginate package with new name and namespace check

Added

• Laravel 12 support

Removed

• Laravel 9 and 10 support
• PHP 8.0 and 8.1 support

Changed

• Replaced package open-southeners/laravel-helpers with open-southeners/extended-php

Fixed

• Performance degradation issue on serialisation (infinite loop on nested includeds)

Added

• Laravel 11 support

Fixed

• Raw response without pagination returning query builder

Added

• Raw response formatting to JsonApiResponse

Added

• Type generics into:
  • OpenSoutheners\LaravelApiable\Http\JsonApiResponse
  • OpenSoutheners\LaravelApiable\Http\RequestQueryObject
  • OpenSoutheners\LaravelApiable\Http\Resources\JsonApiResource
  • OpenSoutheners\LaravelApiable\Http\Resources\JsonApiCollection
  • OpenSoutheners\LaravelApiable\Contracts\ViewQueryable
  • OpenSoutheners\LaravelApiable\Contracts\ViewableBuilder

Added

• Handler::withHeader (used as apiable()->jsonApiRenderable()->withHeader) to add headers to JSON errors

Added

• Includes relationships counts with tags_count (needs to end with _count). E.g:

JsonApiResponse::using(Post::class)->allowInclude(['tags_count']);

// Then request this with ?include=tags_count

Fixed

• Some IDEs getting confused with returning self types in traits (replaced to static)

Changed

• Fix open-southeners/laravel-helpers utilities package version constrain so other packages can use similar versions under the same major release

Fixed

• Query withCount method usage with apiable is replacing the underlying added selects for these counts

Fixed

• Force formatting always coming through even thought is not forced by config

Changed

• Config file now with response.formatting with type and force sub-items as options

Fixed

• Force formatting for Inertia based apps (now can use Apiable::forceResponseFormatting())

Fixed

• Non existing class ForceAppendAttribute when reading controller attributes

Added

• Default sorts using JsonApiResponse::applyDefaultSort method or OpenSoutheners\LaravelApiable\Attributes\ApplyDefaultSort attribute
• Default filters using JsonApiResponse::applyDefaultFilter method or OpenSoutheners\LaravelApiable\Attributes\ApplyDefaultFilter attribute
• Default formatting bypass using JsonApiResponse::forceFormatting method

Changed

• Request::wantsJsonApi() only looks at Accept header, not looking for Content-Type one anymore
• Now all requests can send a different Accept header if they want a diffent response formatting. For e.g. sending Accept: application/json will get raw JSON response. Default being configured in the config/apiable.php make sure to publish or update it

Added

• Sorts now accepts relationships (for e.g. /posts?sort=tags.created_at)

Fixed

• PHP deprecation warning on string vars interpolation

Fixed

• JsonApiResponse using viewable builder (query scopes to filter by view permission) didn't send any user as first parameter