Merge branch 'release/5.0.0'

Author: lindyhopchris

CHANGELOG.md

@@ -3,7 +3,22 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
-## [4.1.0] - 2023-01-19
+## [5.0.0] - 2023-01-21
+
+### Changed
+
+- Drop support for PHP `7.4` - minimum PHP version is now `8.0`.
+- Drop support for Laravel 8 - package requires Laravel 9.
+
+## [5.0.0-alpha.1] - 2022-06-25
+
+### Changed
+
+- **BREAKING** Upgraded the `neomerx/json-api` dependency from `v1` to `v5` of our fork
+  `laravel-json-api/neomerx-json-api`. Refer to the [Upgrade Guide](./docs/upgrade.md) for details of the required
+  changes.  
+
+## [4.1.0] - 2023-01-21
 
 ### Changed
 

composer.json

@@ -24,10 +24,10 @@
     "require": {
         "php": "^8.0",
         "ext-json": "*",
-        "laravel-json-api/neomerx-json-api": "^1.2",
+        "laravel-json-api/neomerx-json-api": "^5.0.1",
         "laravel/framework": "^9.0",
         "nyholm/psr7": "^1.2",
-        "ramsey/uuid": "^3.0|^4.0",
+        "ramsey/uuid": "^4.0",
         "symfony/psr-http-message-bridge": "^2.0"
     },
     "require-dev": {
@@ -61,7 +61,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-develop": "4.x-dev"
+            "dev-develop": "5.x-dev"
         },
         "laravel": {
             "providers": [

database/migrations/2018_10_23_000001_create_client_jobs_table.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * Copyright 2023 Cloud Creativity Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

docs/basics/adapters.md

@@ -582,9 +582,9 @@ For example, this would create the following for a `posts` resource:
 namespace App\JsonApi\Posts;
 
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractResourceAdapter;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
 use CloudCreativity\LaravelJsonApi\Document\ResourceObject;
 use Illuminate\Support\Collection;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 class DummyClass extends AbstractResourceAdapter
 {
@@ -624,7 +624,7 @@ class DummyClass extends AbstractResourceAdapter
     /**
      * @inheritDoc
      */
-    public function query(EncodingParametersInterface $parameters)
+    public function query(QueryParametersInterface $parameters)
     {
         // TODO: Implement query() method.
     }

docs/basics/schemas.md

@@ -35,7 +35,7 @@ can locate a schema for each PHP class it encounters.
 ## Creating Schemas
 
 To generate a schema that extends, use the following command. The generated schema will extend
-`Neomerx\JsonApi\Schema\SchemaProvider`.
+`CloudCreativity\LaravelJsonApi\Schema\SchemaProvider`.
 
 ```bash
 php artisan make:json-api:schema <resource-type> [<api>]

docs/features/async.md

@@ -71,7 +71,7 @@ In the generated schema, you will need to add the `AsyncSchema` trait, for examp
 
 ```php
 use CloudCreativity\LaravelJsonApi\Queue\AsyncSchema;
-use Neomerx\JsonApi\Schema\SchemaProvider;
+use CloudCreativity\LaravelJsonApi\Schema\SchemaProvider;
 
 class Schema extends SchemaProvider
 {
@@ -171,7 +171,6 @@ namespace App\JsonApi\Podcasts;
 
 use App\Jobs\ProcessPodcast;
 use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 class Adapter extends AbstractAdapter
 {

docs/features/media-types.md

@@ -370,14 +370,14 @@ data. For example:
 ```php
 namespace App\JsonApi\Posts;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
 use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 class Adapter extends AbstractAdapter
 {
     // ...
 
-    public function create(array $document, EncodingParametersInterface $parameters)
+    public function create(array $document, QueryParametersInterface $parameters)
     {
         if ($this->didDecode('application/json')) {
             $document = [

docs/fetching/inclusion.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-This package supports the [inclusion of related resources](http://jsonapi.org/format/1.0/#fetching-includes). 
+This package supports the [inclusion of related resources](http://jsonapi.org/format/1.0/#fetching-includes).
 This allows a client to specify resources related to the primary data that should be included in the response.
 The purpose is to allow the client to reduce the number of HTTP requests it needs to make to obtain all the data
 it requires.
@@ -20,13 +20,13 @@ For this feature to work, you will need to:
 default validators do not allow include paths.
 2. Add relationships to the resource [Schema](../basics/schemas.md) and ensure they return data.
 3. For Eloquent models, define the translation of any JSON API include paths to eager load paths
-on the resource [Adapter](../basics/adapters.md).  
+on the resource [Adapter](../basics/adapters.md).
 
 These are all described in this chapter.
 
 ## The Include Query Parameter
 
-Related resources are specified by the client using the `include` query parameter. This parameter 
+Related resources are specified by the client using the `include` query parameter. This parameter
 contains a comma separated list of relationship paths that should be included. The response will be a
 [compound document](http://jsonapi.org/format/#document-compound-documents) where the primary data of the
 request is in the JSON's `data` member, and the related resources are in the `included` member.
@@ -37,7 +37,7 @@ resources in the same request:
 ```http
 GET /api/posts?include=author,tags HTTP/1.1
 Accept: application/vnd.api+json
-``` 
+```
 
 If these include paths are valid, then the client will receive the following response:
 
@@ -79,7 +79,7 @@ Content-Type: application/vnd.api+json
                     "links": {
                         "self": "/api/posts/123/relationships/tags",
                         "related": "/api/posts/123/tags"
-                    }                
+                    }
                 }
             },
             "links": {
@@ -130,7 +130,7 @@ relationship, the client could request the following:
 ```http
 GET /api/posts?include=author.address,tags HTTP/1.1
 Accept: application/vnd.api+json
-``` 
+```
 
 For this request, both the author `users` resource and the user's `addresses` resource would be present in
 the `included` member of the JSON document.
@@ -201,7 +201,7 @@ class Validators extends AbstractValidators
         'author.address',
         'tags'
     ];
-    
+
     // ...
 }
 ```
@@ -235,7 +235,7 @@ the posts schema would have to return both the related author and the related ta
 ```php
 namespace App\JsonApi\Posts;
 
-use Neomerx\JsonApi\Schema\SchemaProvider;
+use CloudCreativity\LaravelJsonApi\Schema\SchemaProvider;
 
 class Schema extends SchemaProvider
 {
@@ -278,7 +278,7 @@ method on the `users` schema.
 
 ## Eager Loading
 
-The Eloquent adapter automatically converts JSON API include paths to Eloquent model 
+The Eloquent adapter automatically converts JSON API include paths to Eloquent model
 [eager loading](https://laravel.com/docs/eloquent-relationships#eager-loading) paths.
 The JSON API path is converted to a camel-case path. For example, the JSON API path
 `author.current-address` is converted to the `author.currentAddress` Eloquent path.
@@ -299,7 +299,7 @@ class Adapter extends AbstractAdapter
         'author' => 'createdBy',
         'author.current-address' => 'createdBy.currentAddress',
     ];
-    
+
     // ...
 }
 ```
@@ -324,7 +324,7 @@ requested as primary data:
 ```php
 namespace App\JsonApi\Posts;
 
-use Neomerx\JsonApi\Schema\SchemaProvider;
+use CloudCreativity\LaravelJsonApi\Schema\SchemaProvider;
 
 class Schema extends SchemaProvider
 {
@@ -344,7 +344,7 @@ This would mean that the following request receive a response with `users` and `
 ```http
 GET /api/posts HTTP/1.1
 Accept: application/vnd.api+json
-``` 
+```
 
 ### Default Path Eager Loading
 
@@ -359,7 +359,7 @@ use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;
 class Adapter extends AbstractAdapter
 {
     protected $defaultWith = ['author', 'tags'];
-    
+
     // ...
 }
 ```

docs/fetching/pagination.md

@@ -515,10 +515,11 @@ For example:
 
 ```php
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PagingStrategyInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
 
 class DateRangeStrategy implements PagingStrategyInterface
 {
-    public function paginate($query, EncodingParametersInterface $pagingParameters)
+    public function paginate($query, QueryParametersInterface $pagingParameters)
     {
         // ...paging logic here, that returns a JSON API page object.
     }