feat: schema return skeleton insteadof object (stdClass)

Author: Ark4ne

CHANGELOG-1.1.md

@@ -2,8 +2,13 @@ Release note
 ============
 
 # v1.1.8
+### Add
+- `Skeleton::class` present skeleton of a `JsonApiResource::class`
+
 ### Changes
 - **@deprecated** `Support\With` is replaced by `Support\Arr`
+- `Resources\Schema::schema` return `Skeleton`
+- `Resources\SchemaCollection::schema` return `Skeleton`
 
 ### Fixes
 - `JsonApiResource::toArray` return true deep array

src/Requests/Rules/Fields.php

@@ -3,6 +3,7 @@
 namespace Ark4ne\JsonApi\Requests\Rules;
 
 use Ark4ne\JsonApi\Requests\Rules\Traits\UseTrans;
+use Ark4ne\JsonApi\Resources\Skeleton;
 use Ark4ne\JsonApi\Support\Fields as SupportFields;
 use Illuminate\Contracts\Validation\Rule;
 
@@ -66,12 +67,12 @@ public function message(): array
     }
 
     /**
-     * @param object                  $schema
+     * @param Skeleton                $schema
      * @param array<string, string[]> $desired
      *
      * @return bool
      */
-    private function assert(object $schema, array $desired): bool
+    private function assert(Skeleton $schema, array $desired): bool
     {
         $resources = $this->extractSchemaFields($schema);
 
@@ -92,12 +93,12 @@ private function assert(object $schema, array $desired): bool
     }
 
     /**
-     * @param object                  $schema
+     * @param Skeleton                $schema
      * @param array<string, string[]> $resources
      *
      * @return array<string, string[]>
      */
-    private function extractSchemaFields(object $schema, array $resources = []): array
+    private function extractSchemaFields(Skeleton $schema, array $resources = []): array
     {
         if (isset($resources[$schema->type])) {
             return $resources;

src/Requests/Rules/Includes.php

@@ -3,6 +3,7 @@
 namespace Ark4ne\JsonApi\Requests\Rules;
 
 use Ark4ne\JsonApi\Requests\Rules\Traits\UseTrans;
+use Ark4ne\JsonApi\Resources\Skeleton;
 use Ark4ne\JsonApi\Support\Includes as SupportIncludes;
 use Illuminate\Contracts\Validation\Rule;
 
@@ -60,13 +61,13 @@ public function message(): array
     }
 
     /**
-     * @param object               $schema
+     * @param Skeleton             $schema
      * @param array<string, mixed> $desired
      * @param string               $pretend
      *
      * @return bool
      */
-    private function assert(object $schema, array $desired, string $pretend = ''): bool
+    private function assert(Skeleton $schema, array $desired, string $pretend = ''): bool
     {
         foreach ($desired as $relation => $sub) {
             if (!isset($schema->relationships[$relation])) {

src/Resources/Concerns/Schema.php

@@ -2,6 +2,7 @@
 
 namespace Ark4ne\JsonApi\Resources\Concerns;
 
+use Ark4ne\JsonApi\Resources\Skeleton;
 use Ark4ne\JsonApi\Support\FakeModel;
 use Illuminate\Http\Request;
 use Illuminate\Support\Collection;
@@ -10,11 +11,11 @@
 trait Schema
 {
     /**
-     * @var array<class-string, object>
+     * @var array<class-string, Skeleton>
      */
     private static array $schemas = [];
 
-    public static function schema(Request $request = null): object
+    public static function schema(Request $request = null): Skeleton
     {
         if (isset(self::$schemas[static::class])) {
             return self::$schemas[static::class];
@@ -24,15 +25,11 @@ public static function schema(Request $request = null): object
 
         $request ??= new Request;
 
-        $schema = (object)[
-            'type' => null,
-            'fields' => [],
-            'relationships' => [],
-        ];
+        self::$schemas[static::class] = $schema = new Skeleton(
+            static::class,
+            $resource->toType($request)
+        );
 
-        self::$schemas[static::class] = $schema;
-
-        $schema->type = $resource->toType($request);
         $schema->fields = (new Collection($resource->toAttributes($request)))->keys()->all();
 
         foreach ($resource->toRelationships($request) as $name => $relation) {

src/Resources/Concerns/SchemaCollection.php

@@ -2,12 +2,13 @@
 
 namespace Ark4ne\JsonApi\Resources\Concerns;
 
+use Ark4ne\JsonApi\Resources\Skeleton;
 use Illuminate\Http\Request;
 use ReflectionClass;
 
 trait SchemaCollection
 {
-    public static function schema(Request $request = null): object
+    public static function schema(Request $request = null): Skeleton
     {
         return self::new()->collects::schema($request);
     }

src/Resources/Skeleton.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Ark4ne\JsonApi\Resources;
+
+/**
+ * @template T
+ */
+class Skeleton
+{
+    /**
+     * @param class-string<T>     $for
+     * @param string              $type
+     * @param string[]            $fields
+     * @param array<string, self> $relationships
+     */
+    public function __construct(
+        public string $for,
+        public string $type,
+        public array $fields = [],
+        public array $relationships = [],
+    ) {
+    }
+}