Merge branch 'release/1.1.0' into main

Author: lindyhopchris

CHANGELOG.md

@@ -3,6 +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/).
 
+## [1.1.0] - 2022-01-03
+
+### Fixed
+
+- Fixed setting the top-level `jsonapi` value on the `Document` class, which was not setting the cast value.
+
+### Removed
+
+- The `RelationshipDocument` no longer merges relationship links with the top-level document links. This is because we
+  now expect the top-level links provided to the encoder to already have the relationship links merged. The `core`
+  package takes care of this in the relationship response classes, while also providing the capability for the developer
+  to turn off link merging if desired (which is a better implementation). This change is considered non-breaking because
+  the core package dependency has been upgraded and there were existing bugs in the links merging implementation within
+  the `RelationshipDocument` class. I.e. it would fail if either of the self or related links were missing, or if the
+  relationship was hidden - so removing this merging fixes bugs in the implementation.
+
 ## [1.0.0] - 2021-07-31
 
 Initial stable release, with no changes since `1.0.0-beta.1`.

composer.json

@@ -26,7 +26,7 @@
         "php": "^7.4|^8.0",
         "ext-json": "*",
         "illuminate/support": "^8.0",
-        "laravel-json-api/core": "^1.0.0",
+        "laravel-json-api/core": "^1.1",
         "laravel-json-api/neomerx-json-api": "^4.0.2"
     },
     "require-dev": {

src/Document.php

@@ -27,7 +27,6 @@
 
 abstract class Document implements JsonApiDocument
 {
-
     /**
      * @var ExtendedEncoder
      */
@@ -81,7 +80,7 @@ abstract protected function encode(): string;
     public function withJsonApi($jsonApi): self
     {
         if ($value = JsonApi::nullable($jsonApi)) {
-            $this->jsonApi = $jsonApi;
+            $this->jsonApi = $value;
         }
 
         return $this;
@@ -226,4 +225,12 @@ protected function encoder(): ExtendedEncoder
     {
         return $this->encoder;
     }
+
+    /**
+     * @return Mapper
+     */
+    protected function mapper(): Mapper
+    {
+        return $this->mapper;
+    }
 }

src/RelationshipDocument.php

@@ -24,21 +24,20 @@
 
 class RelationshipDocument extends Document
 {
-
     /**
      * @var JsonApiResource
      */
-    private JsonApiResource $resource;
+    protected JsonApiResource $resource;
 
     /**
      * @var string
      */
-    private string $fieldName;
+    protected string $fieldName;
 
     /**
      * @var mixed
      */
-    private $data;
+    protected $data;
 
     /**
      * RelationshipDocument constructor.
@@ -69,8 +68,6 @@ protected function serialize(): array
     {
         return $this
             ->encoder()
-            ->withRelationshipSelfLink($this->resource, $this->fieldName)
-            ->withRelationshipRelatedLink($this->resource, $this->fieldName)
             ->serializeIdentifiers($this->data);
     }
 
@@ -81,9 +78,6 @@ protected function encode(): string
     {
         return $this
             ->encoder()
-            ->withRelationshipSelfLink($this->resource, $this->fieldName)
-            ->withRelationshipRelatedLink($this->resource, $this->fieldName)
             ->encodeIdentifiers($this->data);
     }
-
 }