Merge branch 'develop' into next

Author: lindyhopchris

.github/workflows/tests.yml

@@ -14,8 +14,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [8.2, 8.3]
-        laravel: [11]
+        php: [8.2, 8.3, 8.4]
 
     steps:
     - name: Checkout Code
@@ -30,9 +29,6 @@ jobs:
         coverage: none
         ini-values: error_reporting=E_ALL
 
-    - name: Set Laravel Version
-      run: composer require "illuminate/contracts:^${{ matrix.laravel }}" --no-update
-
     - name: Install dependencies
       uses: nick-fields/retry@v3
       with:

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+## [3.1.0] - 2024-11-30
+
+### Added
+
+- Package now requires `laravel-json-api/core` v4 or v5.
+
+### Fixed
+
+- Removed deprecation notices in PHP 8.4.
+
 ## [3.0.0] - 2024-03-14
 
 ### Changed

composer.json

@@ -28,7 +28,7 @@
         "illuminate/contracts": "^11.0",
         "illuminate/pipeline": "^11.0",
         "illuminate/support": "^11.0",
-        "laravel-json-api/core": "^5.0"
+        "laravel-json-api/core": "^6.0"
     },
     "require-dev": {
         "orchestra/testbench": "^9.0",

phpunit.xml

@@ -13,6 +13,7 @@
          failOnWarning="true"
          failOnDeprecation="true"
          failOnNotice="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
 >
   <coverage/>
   <testsuites>

src/Factory.php

@@ -51,7 +51,7 @@ public function __construct(Specification $spec, Translator $translator)
      *      the relation the identifier exists in.
      * @return Identifier
      */
-    public function createIdentifierValue(string $path, $value, Relation $relation = null): Identifier
+    public function createIdentifierValue(string $path, $value, ?Relation $relation = null): Identifier
     {
         return new Identifier($this->spec, $this->translator, $path, $value, $relation);
     }

src/ResourceDocumentComplianceChecker.php

@@ -13,26 +13,26 @@
 
 use LaravelJsonApi\Contracts\Spec\ResourceDocumentComplianceChecker as ResourceDocumentComplianceCheckerContract;
 use LaravelJsonApi\Contracts\Support\Result as ResultContract;
+use LaravelJsonApi\Core\Bus\Commands\Result;
 use LaravelJsonApi\Core\Exceptions\JsonApiException;
-use LaravelJsonApi\Core\Support\Result;
 use LaravelJsonApi\Core\Values\ResourceId;
 use LaravelJsonApi\Core\Values\ResourceType;
 
-class ResourceDocumentComplianceChecker implements ResourceDocumentComplianceCheckerContract
+final readonly class ResourceDocumentComplianceChecker implements ResourceDocumentComplianceCheckerContract
 {
     /**
      * ResourceDocumentComplianceChecker constructor
      *
      * @param ResourceBuilder $builder
      */
-    public function __construct(private readonly ResourceBuilder $builder)
+    public function __construct(private ResourceBuilder $builder)
     {
     }
 
     /**
      * @inheritDoc
      */
-    public function mustSee(ResourceType|string $type, ResourceId|string $id = null): static
+    public function mustSee(ResourceType|string $type, ResourceId|string|null $id = null): static
     {
         $id = ($id === null) ? null : (string) $id;
 

src/Values/Identifier.php

@@ -73,7 +73,7 @@ public function __construct(
         Translator $translator,
         string $path,
         $value,
-        Relation $relation = null
+        ?Relation $relation = null
     ) {
         $this->spec = $spec;
         $this->translator = $translator;