v1.5

CHANGELOG-1.5.md

@@ -0,0 +1,5 @@
+Release note
+============
+# v1.5.0
+### Added
+- Struct value type

readme.md

@@ -399,7 +399,8 @@ UserResource::collection(User::all()); // => JsonApiCollection
 | `date`    | Cast to date, allow to use custom format |
 | `array`   | Cast to array                            |
 | `mixed`   | Don't cast, return as is                 |
-| `enum`    | Get enum value.                          |
+| `enum`    | Get enum value                           |
+| `struct`  | Custom struct. Accept an array of values |
 
 ### Relation methods
 | Method  | Description                                                       |

src/Descriptors/Describer.php

@@ -151,12 +151,12 @@ abstract public function retriever(): null|string|Closure;
      *
      * @return int|string
      */
-    public static function retrieveName(mixed $value, int|string $key): int|string
+    public static function retrieveName(mixed $value, int|string $key, null|string $prefix = null): int|string
     {
         if (is_int($key) && $value instanceof self && is_string($retriever = $value->retriever())) {
-            return $retriever;
+            return $prefix ? $prefix . '.' . $retriever : $retriever;
         }
 
-        return $key;
+        return $prefix ? $prefix . '.' . $key : $key;
     }
 }

src/Descriptors/Resolver.php

@@ -11,7 +11,7 @@ trait Resolver
      * @param \Illuminate\Http\Request $request
      * @param iterable<mixed>|null $values
      *
-     * @return array<mixed>|null
+     * @return array<array-key, mixed>|null
      */
     protected function resolveValues(Request $request, ?iterable $values): ?array
     {

src/Descriptors/Values.php

@@ -2,16 +2,17 @@
 
 namespace Ark4ne\JsonApi\Descriptors;
 
-use Ark4ne\JsonApi\Descriptors\Relations\RelationMany;
-use Ark4ne\JsonApi\Descriptors\Relations\RelationOne;
-use Ark4ne\JsonApi\Descriptors\Values\{ValueArray,
+use Ark4ne\JsonApi\Descriptors\Values\{
+    ValueArray,
     ValueBool,
     ValueDate,
     ValueEnum,
     ValueFloat,
     ValueInteger,
     ValueMixed,
-    ValueString};
+    ValueString,
+    ValueStruct
+};
 use Closure;
 
 /**
@@ -98,4 +99,14 @@ protected function enum(null|string|Closure $attribute = null): ValueEnum
     {
         return new ValueEnum($attribute);
     }
+
+    /**
+     * @param Closure(T):iterable<string, mixed|\Closure|\Ark4ne\JsonApi\Descriptors\Values\Value> $attribute
+     *
+     * @return \Ark4ne\JsonApi\Descriptors\Values\ValueStruct<T>
+     */
+    protected function struct(Closure $attribute): ValueStruct
+    {
+        return new ValueStruct($attribute);
+    }
 }

src/Descriptors/Values/Value.php

@@ -108,7 +108,7 @@ public function resolveFor(Request $request, mixed $model, string $field): mixed
 
         return $value === null && $this->nullable
             ? null
-            : $this->value($value);
+            : $this->value($value, $request);
     }
 
     protected function check(Request $request, mixed $model, string $attribute): bool
@@ -120,5 +120,5 @@ protected function check(Request $request, mixed $model, string $attribute): boo
         return parent::check($request, $model, $attribute);
     }
 
-    abstract protected function value(mixed $of): mixed;
+    abstract protected function value(mixed $of, Request $request): mixed;
 }

src/Descriptors/Values/ValueArray.php

@@ -2,6 +2,7 @@
 
 namespace Ark4ne\JsonApi\Descriptors\Values;
 
+use Illuminate\Http\Request;
 use Illuminate\Support\Collection;
 
 /**
@@ -12,10 +13,10 @@ class ValueArray extends Value
 {
     /**
      * @param mixed $of
-     *
+     * @param Request $request
      * @return array<array-key, mixed>
      */
-    public function value(mixed $of): array
+    public function value(mixed $of, Request $request): array
     {
         return (new Collection($of))->toArray();
     }

src/Descriptors/Values/ValueBool.php

@@ -2,13 +2,15 @@
 
 namespace Ark4ne\JsonApi\Descriptors\Values;
 
+use Illuminate\Http\Request;
+
 /**
  * @template T
  * @extends Value<T>
  */
 class ValueBool extends Value
 {
-    public function value(mixed $of): bool
+    public function value(mixed $of, Request $request): bool
     {
         return (bool)$of;
     }

src/Descriptors/Values/ValueDate.php

@@ -6,6 +6,7 @@
 use Closure;
 use DateTime;
 use DateTimeInterface;
+use Illuminate\Http\Request;
 
 /**
  * @template T
@@ -31,7 +32,7 @@ public function format(string $format): static
     /**
      * @throws \Exception
      */
-    public function value(mixed $of): string
+    public function value(mixed $of, Request $request): string
     {
         if ($of === null) {
             return (new DateTime("@0"))->format($this->format);

src/Descriptors/Values/ValueEnum.php

@@ -3,6 +3,7 @@
 namespace Ark4ne\JsonApi\Descriptors\Values;
 
 use BackedEnum;
+use Illuminate\Http\Request;
 use UnitEnum;
 
 /**
@@ -11,7 +12,7 @@
  */
 class ValueEnum extends Value
 {
-    protected function value(mixed $of): mixed
+    protected function value(mixed $of, Request $request): mixed
     {
         if ($of instanceof BackedEnum) return $of->value;
         if ($of instanceof UnitEnum) return $of->name;

src/Descriptors/Values/ValueFloat.php

@@ -4,6 +4,7 @@
 
 use Ark4ne\JsonApi\Support\Config;
 use Closure;
+use Illuminate\Http\Request;
 
 /**
  * @template T
@@ -26,7 +27,7 @@ public function precision(int $precision): static
         return $this;
     }
 
-    public function value(mixed $of): float
+    public function value(mixed $of, Request $request): float
     {
         if (isset($this->precision)) {
             $precision = 10 ** $this->precision;

src/Descriptors/Values/ValueInteger.php

@@ -2,13 +2,15 @@
 
 namespace Ark4ne\JsonApi\Descriptors\Values;
 
+use Illuminate\Http\Request;
+
 /**
  * @template T
  * @extends Value<T>
  */
 class ValueInteger extends Value
 {
-    public function value(mixed $of): int
+    public function value(mixed $of, Request $request): int
     {
         return (int)$of;
     }

src/Descriptors/Values/ValueMixed.php

@@ -2,13 +2,15 @@
 
 namespace Ark4ne\JsonApi\Descriptors\Values;
 
+use Illuminate\Http\Request;
+
 /**
  * @template T
  * @extends Value<T>
  */
 class ValueMixed extends Value
 {
-    public function value(mixed $of): mixed
+    public function value(mixed $of, Request $request): mixed
     {
         return $of;
     }

src/Descriptors/Values/ValueString.php

@@ -2,13 +2,15 @@
 
 namespace Ark4ne\JsonApi\Descriptors\Values;
 
+use Illuminate\Http\Request;
+
 /**
  * @template T
  * @extends Value<T>
  */
 class ValueString extends Value
 {
-    public function value(mixed $of): string
+    public function value(mixed $of, Request $request): string
     {
         return (string)$of;
     }

src/Descriptors/Values/ValueStruct.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Ark4ne\JsonApi\Descriptors\Values;
+
+use Ark4ne\JsonApi\Descriptors\Resolver;
+use Ark4ne\JsonApi\Support\Values;
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Support\Collection;
+
+/**
+ * @template T
+ * @extends Value<T>
+ */
+class ValueStruct extends Value
+{
+    use Resolver;
+
+    protected mixed $resource;
+
+    public function __construct(Closure $values)
+    {
+        parent::__construct($values);
+    }
+
+    public function resolveFor(Request $request, mixed $model, string $field): mixed
+    {
+        $this->resource = $model;
+
+        return parent::resolveFor($request, $model, $field);
+    }
+
+    /**
+     * @param iterable<array-key, mixed> $of
+     * @param Request $request
+     *
+     * @return array<array-key, mixed>
+     */
+    public function value(mixed $of, Request $request): array
+    {
+        $attributes = Values::mergeValues($this->resolveValues($request, Values::mergeValues($of)));
+
+        return (new Collection($attributes))->toArray();
+    }
+}

src/Resources/Concerns/Attributes.php

@@ -2,6 +2,7 @@
 
 namespace Ark4ne\JsonApi\Resources\Concerns;
 
+use Ark4ne\JsonApi\Support\Arr;
 use Ark4ne\JsonApi\Support\Fields;
 use Illuminate\Http\Request;
 
@@ -14,7 +15,7 @@ trait Attributes
      *
      * @param \Illuminate\Http\Request $request
      *
-     * @return iterable<string, \Closure|mixed>|iterable<array-key, \Ark4ne\JsonApi\Descriptors\Values\Value>
+     * @return iterable<array-key, mixed|\Closure|\Ark4ne\JsonApi\Descriptors\Values\Value>
      *
      * ```
      * return [
@@ -58,7 +59,7 @@ private function requestedAttributes(Request $request): array
 
             $attributes = null === $fields
                 ? $attributes
-                : array_intersect_key($attributes, array_fill_keys($fields, true));
+                : Arr::intersectKeyStruct($attributes, Arr::undot(array_fill_keys($fields, true)));
 
             return array_map('\value', $attributes);
         });

src/Resources/Concerns/PrepareData.php

@@ -28,7 +28,6 @@ trait PrepareData
      */
     protected function mergeValues(iterable $data): iterable
     {
-
         return Values::mergeValues($data);
     }
 

src/Resources/Concerns/Schema.php

@@ -5,6 +5,7 @@
 use Ark4ne\JsonApi\Descriptors\Describer;
 use Ark4ne\JsonApi\Descriptors\Relations\Relation;
 use Ark4ne\JsonApi\Descriptors\Resolver;
+use Ark4ne\JsonApi\Descriptors\Values\ValueStruct;
 use Ark4ne\JsonApi\Resources\Skeleton;
 use Ark4ne\JsonApi\Support\FakeModel;
 use Ark4ne\JsonApi\Support\Values;
@@ -37,9 +38,16 @@ public static function schema(null|Request $request = null): Skeleton
         );
 
         $schema->fields = (new Collection(Values::mergeValues($resource->toAttributes($request))))
-            ->map(fn($value, $key) => Describer::retrieveName($value, $key))
-            ->values()
-            ->all();
+            ->flatMap(function ($value, $key) use ($resource) {
+                $collection = (new Collection([Describer::retrieveName($value, $key) => true]));
+
+                if ($value instanceof ValueStruct) {
+                    return $collection->merge(self::structFields($resource, $key, $value, $key));
+                }
+
+                return $collection;
+            })
+            ->keys()->all();
 
         foreach (Values::mergeValues($resource->toRelationships($request)) as $name => $relation) {
             if ($relation instanceof Relation) {
@@ -83,4 +91,21 @@ private static function new(): static
 
         return $instance;
     }
+
+    private static function structFields(mixed $resource, string $key, ValueStruct $struct, null|string $prefix = null): Collection
+    {
+        /** @var array<array-key, mixed> $attributes */
+        $attributes = ($struct->retriever())($resource, $key);
+
+        return (new Collection(Values::mergeValues($attributes)))
+            ->flatMap(function($value, $key) use ($resource, $prefix) {
+                $prefixed = Describer::retrieveName($value, $key, $prefix);
+
+                if ($value instanceof ValueStruct) {
+                    return self::structFields($resource, $key, $value, $prefixed);
+                }
+
+                return [$prefixed => $value];
+            });
+    }
 }

src/Support/Arr.php

@@ -163,6 +163,28 @@ public static function apply(array &$array, string $path, mixed $value, null|str
         return $array;
     }
 
+    /**
+     * @template TKey as array-key
+     * @template TValue
+     *
+     * @param array<TKey, TValue> $array
+     * @param array<array-key, mixed> $struct
+     *
+     * @return array<TKey, TValue>
+     */
+    public static function intersectKeyStruct(array $array, array $struct): array
+    {
+        $res = array_intersect_key($array, $struct);
+
+        foreach ($res as $key => $value) {
+            if (is_array($value) && is_array($struct[$key])) {
+                $res[$key] = self::intersectKeyStruct($value, $struct[$key]);
+            }
+        }
+
+        return $res;
+    }
+
     /**
      * @template TKey as array-key
      * @template TValue