Strip empty properties

.php-cs-fixer.dist.php

@@ -10,16 +10,17 @@
     ->setRules([
         '@PSR12' => true,
         '@PSR12:risky' => true,
-        'no_unused_imports' => true,
+        'array_indentation' => true,
+        'declare_strict_types' => true,
+        'explicit_string_variable' => true,
         'global_namespace_import' => ['import_classes' => true, 'import_constants' => true, 'import_functions' => true],
         'native_function_invocation' => true,
-        'declare_strict_types' => true,
+        'no_unused_imports' => true,
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
+        'single_quote' => true,
         'strict_comparison' => true,
         'strict_param' => true,
-        'explicit_string_variable' => true,
         'trailing_comma_in_multiline' => true,
-        'array_indentation' => true,
-        'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
     ])
     ->setRiskyAllowed(true)
     ->setFinder($finder);

README.md

@@ -101,9 +101,6 @@ use TiMacDonald\JsonApi\JsonApiResource;
 
 class UserResource extends JsonApiResource
 {
-    /**
-     * @var string[]
-     */
     public $attributes = [
         'name',
         'website',
@@ -163,18 +160,12 @@ use TiMacDonald\JsonApi\JsonApiResource;
 
 class UserResource extends JsonApiResource
 {
-    /**
-     * @var string[]
-     */
     public $attributes = [
         'name',
         'website',
         'twitter_handle',
     ];
 
-    /**
-     * @var array<string, class-string<JsonApiResource>>
-     */
     public $relationships = [
         'team' => TeamResource::class,
         'posts' => PostResource::class,
@@ -193,18 +184,12 @@ use TiMacDonald\JsonApi\JsonApiResource;
 
 class UserResource extends JsonApiResource
 {
-    /**
-     * @var string[]
-     */
     public $attributes = [
         'name',
         'website',
         'twitter_handle',
     ];
 
-    /**
-     * @var string[]
-     */
     public $relationships = [
         'team',
         'posts',
@@ -415,15 +400,10 @@ GET /posts?include=author&fields[posts]=title,excerpt&fields[users]=name
         "author": {
           "data": {
             "type": "users",
-            "id": "74812",
-            "meta": {}
-          },
-          "meta": {},
-          "links": {}
+            "id": "74812"
+          }
         }
-      },
-      "meta": {},
-      "links": {}
+      }
     },
     {
       "id": "39974",
@@ -436,15 +416,10 @@ GET /posts?include=author&fields[posts]=title,excerpt&fields[users]=name
         "author": {
           "data": {
             "type": "users",
-            "id": "74812",
-            "meta": {}
-          },
-          "meta": {},
-          "links": {}
+            "id": "74812"
+          }
         }
-      },
-      "meta": {},
-      "links": {}
+      }
     }
   ],
   "included": [
@@ -453,10 +428,7 @@ GET /posts?include=author&fields[posts]=title,excerpt&fields[users]=name
       "id": "74812",
       "attributes": {
         "name": "Tim"
-      },
-      "relationships": {},
-      "meta": {},
-      "links": {}
+      }
     }
   ]
 }

src/JsonApiResource.php

@@ -118,17 +118,19 @@ public function toResourceIdentifier(Request $request)
      * @api
      *
      * @param Request $request
-     * @return array{id: string, type: string, attributes: stdClass, relationships: stdClass, meta: stdClass, links: stdClass}
+     * @return array{id: string, type: string, attributes?: stdClass, relationships?: stdClass, meta?: stdClass, links?: stdClass}
      */
     public function toArray($request)
     {
         return [
             'id' => $this->resolveId($request),
             'type' => $this->resolveType($request),
-            'attributes' => (object) $this->requestedAttributes($request)->all(),
-            'relationships' => (object) $this->requestedRelationshipsAsIdentifiers($request)->all(),
-            'meta' => (object) array_merge($this->toMeta($request), $this->meta),
-            'links' => (object) self::parseLinks(array_merge($this->toLinks($request), $this->links)),
+            ...Collection::make([
+                'attributes' => $this->requestedAttributes($request)->all(),
+                'relationships' => $this->requestedRelationshipsAsIdentifiers($request)->all(),
+                'links' => self::parseLinks(array_merge($this->toLinks($request), $this->links)),
+                'meta' => array_merge($this->toMeta($request), $this->meta),
+            ])->filter()->map(fn ($value) => (object) $value),
         ];
     }
 
@@ -141,9 +143,10 @@ public function toArray($request)
     public function with($request)
     {
         return [
-            'included' => $this->included($request)
+            ...($included = $this->included($request)
                 ->uniqueStrict(fn (JsonApiResource $resource): string => $resource->toUniqueResourceIdentifier($request))
-                ->values(),
+                ->values()
+                ->all()) ? ['included' => $included] : [],
             'jsonapi' => self::serverImplementationResolver()($request),
         ];
     }

src/JsonApiResourceCollection.php

@@ -56,11 +56,12 @@ private function resolveResourceIdentifiers(Request $request)
     public function with($request)
     {
         return [
-            'included' => $this->collection
+            ...($included = $this->collection
                 ->map(fn (JsonApiResource $resource): Collection => $resource->included($request))
                 ->flatten()
                 ->uniqueStrict(fn (JsonApiResource $resource): string => $resource->toUniqueResourceIdentifier($request))
-                ->values(),
+                ->values()
+                ->all()) ? ['included' => $included] : [],
             'jsonapi' => JsonApiResource::serverImplementationResolver()($request),
         ];
     }

src/JsonApiServerImplementation.php

@@ -26,13 +26,13 @@ public function __construct(string $version, array $meta = [])
     /**
      * @internal
      *
-     * @return array{version: string, meta: stdClass}
+     * @return array{version: string, meta?: stdClass}
      */
     public function jsonSerialize(): array
     {
         return [
             'version' => $this->version,
-            'meta' => (object) $this->meta,
+            ...$this->meta ? ['meta' => (object) $this->meta] : [],
         ];
     }
 }

src/Link.php

@@ -60,13 +60,13 @@ public function __construct(string $key, string $href, array $meta = [])
     /**
      * @internal
      *
-     * @return array{href: string, meta: stdClass}
+     * @return array{href: string, meta?: stdClass}
      */
     public function jsonSerialize(): array
     {
         return [
             'href' => $this->href,
-            'meta' => (object) $this->meta,
+            ...$this->meta ? ['meta' => (object) $this->meta] : [],
         ];
     }
 }

src/RelationshipObject.php

@@ -64,14 +64,14 @@ private function __construct(ResourceIdentifier|array|null $data, array $links =
     /**
      * @internal
      *
-     * @return array{data: ResourceIdentifier|null|array<int, ResourceIdentifier>, meta: stdClass, links: stdClass}
+     * @return array{data: ResourceIdentifier|null|array<int, ResourceIdentifier>, meta?: stdClass, links?: stdClass}
      */
     public function jsonSerialize(): array
     {
         return [
             'data' => $this->data,
-            'meta' => (object) $this->meta,
-            'links' => (object) self::parseLinks($this->links),
+            ...$this->meta ? ['meta' => (object) $this->meta] : [],
+            ...$this->links ? ['links' => (object) self::parseLinks($this->links)] : [],
         ];
     }
 }

src/ResourceIdentifier.php

@@ -38,14 +38,14 @@ public function __construct(string $type, string $id, array $meta = [])
     /**
      * @internal
      *
-     * @return array{type: string, id: string, meta: stdClass}
+     * @return array{type: string, id: string, meta?: stdClass}
      */
     public function jsonSerialize(): array
     {
         return [
             'type' => $this->type,
             'id' => $this->id,
-            'meta' => (object) $this->meta,
+            ...$this->meta ? ['meta' => (object) $this->meta] : [],
         ];
     }
 }