2.0.0

⚠️ Please make sure to run php artisan vendor:publish --force --provider="OpenSoutheners\LaravelApiable\ServiceProvider" ⚠️

Removed

• JsonApiResponse::list and JsonApiResponse::getOne methods as isn't the responsibility of this package to act as query repository so it makes easier to encapsulate it into repository or whatever design pattern you're using. Use JsonApiResponse::using instead sending the query as its parameter.

Added

• PHP 8 attributes for QueryParams:
  • OpenSoutheners\LaravelApiable\Attributes\FilterQueryParam
  • OpenSoutheners\LaravelApiable\Attributes\IncludeQueryParam
  • OpenSoutheners\LaravelApiable\Attributes\AppendsQueryParam
  • OpenSoutheners\LaravelApiable\Attributes\FieldsQueryParam
  • OpenSoutheners\LaravelApiable\Attributes\SortQueryParam
  • OpenSoutheners\LaravelApiable\Attributes\SearchQueryParam
• Method JsonApiResponse::from can now be non-statically called as JsonApiResponse::using (for dependency injection usage in controllers, etc)

Changed

• Config file changes. Please make sure to run php artisan vendor:publish --force --provider="OpenSoutheners\LaravelApiable\ServiceProvider"
• Constructor from JsonApiResponse now only accepts 1 optional parameter (being the query parameter removed in favor of manually setting this by calling JsonApiResponse::using method)
• Constructor from RequestQueryObject now only accepts 1 optional parameter (being the query parameter removed in favor of manually setting this by calling RequestQueryObject::setQuery method)

1.3.2

Added

• JsonApiResponse:forceAppend method to force appends to the final response

1.3.1

Changed

• JsonApiResponse::getPipelineQuery now accepts an optional callback closure & is exposed as public for repositories usage

1.3.0

Changed

• RequestQueryObject::allowFilter method now accepts 3 arguments (attribute, operator/values, values)

Fixed

• AllowedFilter::scopedValue method was removed and accidentally pushed onto RequestQueryObject::allowScopedFilter

1.2.0

Added

• Method RequestQueryObject::allows to be able to group everything in the same method call without needing to use class methods (AllowedFilters, AllowedFields, etc...)

1.1.0

Added

• AllowedFilter::scoped method for Laravel query scopes filters to specify the filter is not an actual attribute but a query builder scope
• enforce_scoped_names to config/apiable.php to be used so they rename scoped filters in case there are attributes with the same name on the model (remember to use vendor:publish artisan command to update the config file)
• include_allowed to config/apiable.php to be used so any JsonApiResponse will include allowed filters and sorts (like using JsonApiResponse::includeAllowedToResponse but on all requests)
• AssertableJsonApi::hasNotAttribute and AssertableJsonApi::hasNotAttributes methods for negative test assertions (counter part of AssertableJsonApi::hasAttribute and AssertableJsonApi::hasAttributes)

Fixed

• Scoped filters now can be allowed & applied to requested response
• Issue with allowAppends & allowFields sending array of attributes will wrongly parse them

1.0.2

Added

• Allowing fields and appends now accepts model class as for type parameter

1.0.1

Fixed

• Missing publishable config

1.0.0

Removed

• Custom transformers (out of package scope / purpose)

Fixed

• Method allowIncludes adds nested array which leads into issues

Changed

• Model setup not needed (OpenSoutheners\LaravelApiable\JsonApiOptions replaced by OpenSoutheners\LaravelApiable\Facades\Apiable::modelResourceTypeMap facade method)

Added

• Support for laravel/scout
• Support for hammerstone/fast-paginate

0.4.1

Fixed

• Missing autoload-dev, tests were autoloaded with the released version
• Multiple minor fixes around forwarding calls (methods)
• Apiable facade toJsonApi