Typing responses for stricter typing

roberto-butti · roberto-butti · commit 9d6de866f92b · 2025-02-08T15:56:51.000+01:00
diff --git a/src/Data/SpaceData.php b/src/Data/SpaceData.php
@@ -48,12 +48,6 @@ public function createdAt(): null|string
         return $this->getFormattedDateTime('created_at', "", format: "Y-m-d");
     }
 
-    public function updatedAt(): null|string
-    {
-        return $this->getFormattedDateTime('updated_at', "", format: "Y-m-d");
-    }
-
-
 
     public function planDescription(): null|string
     {
diff --git a/src/Data/SpacesData.php b/src/Data/SpacesData.php
@@ -18,13 +18,7 @@ public static function make(array $data = []): self
         return new self($data);
     }
 
-    /**
-     * @param array<string, array<mixed>> $data
-     */
-    public static function makeFromResponse(array $data = []): self
-    {
-        return new self($data["spaces"] ?? []);
-    }
+
 
 
     public function howManySpaces(): int
diff --git a/src/Endpoints/AssetApi.php b/src/Endpoints/AssetApi.php
@@ -9,7 +9,7 @@
 use Storyblok\ManagementApi\Data\StoryblokData;
 use Storyblok\ManagementApi\QueryParameters\AssetsParams;
 use Storyblok\ManagementApi\QueryParameters\PaginationParams;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 use Symfony\Component\HttpClient\HttpClient;
 
 /**
diff --git a/src/Endpoints/EndpointBase.php b/src/Endpoints/EndpointBase.php
@@ -8,9 +8,10 @@
 use Psr\Log\NullLogger;
 use Storyblok\ManagementApi\Data\StoryblokData;
 use Storyblok\ManagementApi\ManagementApiClient;
-use Storyblok\ManagementApi\StoryblokResponse;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
+use Storyblok\ManagementApi\Response\StoryblokResponse;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
+use Symfony\Contracts\HttpClient\ResponseInterface;
 
 /**
  * Class EndpointBase
@@ -38,12 +39,27 @@ public function makeRequest(
         array $options = [],
         string $dataClass = StoryblokData::class,
     ): StoryblokResponseInterface {
-        $response = $this->httpClient->request(
+        $response = $this->makeHttpRequest(
             $method,
             $path,
             $options,
         );
-
         return StoryblokResponse::make($response, $dataClass);
     }
+
+    /**
+     * @param array<mixed> $options
+     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
+     */
+    public function makeHttpRequest(
+        string $method,
+        string $path,
+        array $options = [],
+    ): ResponseInterface {
+        return $this->httpClient->request(
+            $method,
+            $path,
+            $options,
+        );
+    }
 }
diff --git a/src/Endpoints/ManagementApi.php b/src/Endpoints/ManagementApi.php
@@ -4,7 +4,7 @@
 
 namespace Storyblok\ManagementApi\Endpoints;
 
-use Storyblok\ManagementApi\StoryblokResponseInterface;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 
 /**
  *
diff --git a/src/Endpoints/SpaceApi.php b/src/Endpoints/SpaceApi.php
@@ -7,36 +7,42 @@
 use Storyblok\ManagementApi\Data\SpaceData;
 use Storyblok\ManagementApi\Data\SpacesData;
 use Storyblok\ManagementApi\Data\StoryblokData;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
+use Storyblok\ManagementApi\Response\SpaceResponse;
+use Storyblok\ManagementApi\Response\SpacesResponse;
+use Storyblok\ManagementApi\Response\StoryblokResponse;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 
 /**
  *
  */
 class SpaceApi extends EndpointBase
 {
-    public function all(): StoryblokResponseInterface
+    public function all(): SpacesResponse
     {
-        return $this->makeRequest(
+        $httpResponse = $this->makeHttpRequest(
             "GET",
             '/v1/spaces',
-            dataClass: SpacesData::class,
         );
+        return new SpacesResponse($httpResponse, SpacesData::class);
     }
 
 
-    public function get(string $spaceId): StoryblokResponseInterface
+
+
+    public function get(string $spaceId): SpaceResponse
     {
-        return $this->makeRequest(
+        $httpResponse = $this->makeHttpRequest(
             "GET",
             '/v1/spaces/' . $spaceId,
-            dataClass: SpaceData::class,
         );
+        return new SpaceResponse($httpResponse);
     }
 
 
-    public function create(StoryblokData $storyblokData): StoryblokResponseInterface
+    public function create(StoryblokData $storyblokData): SpaceResponse
     {
-        return $this->makeRequest(
+
+        $httpResponse =  $this->makeHttpRequest(
             "POST",
             "/v1/spaces",
             [
@@ -45,11 +51,12 @@ public function create(StoryblokData $storyblokData): StoryblokResponseInterface
                 ],
             ],
         );
+        return new SpaceResponse($httpResponse);
     }
 
-    public function duplicate(string|int $duplicateId, string $name): StoryblokResponseInterface
+    public function duplicate(string|int $duplicateId, string $name): SpaceResponse
     {
-        return $this->makeRequest(
+        $httpResponse = $this->makeHttpRequest(
             "POST",
             "/v1/spaces",
             [
@@ -61,31 +68,34 @@ public function duplicate(string|int $duplicateId, string $name): StoryblokRespo
                 ],
             ],
         );
+        return new SpaceResponse($httpResponse);
     }
 
     /**
      * @param $spaceId
      */
-    public function delete(string $spaceId): StoryblokResponseInterface
+    public function delete(string $spaceId): SpaceResponse
     {
-        return $this->makeRequest(
+        $httpResponse = $this->makeHttpRequest(
             "DELETE",
             '/v1/spaces/' . $spaceId,
         );
+        return new SpaceResponse($httpResponse);
     }
 
     /**
      * @param $spaceId
      */
-    public function backup(string $spaceId): StoryblokResponseInterface
+    public function backup(string $spaceId): SpaceResponse
     {
-        return $this->makeRequest(
+        $httpResponse = $this->makeHttpRequest(
             "POST",
             sprintf('/v1/spaces/%s/backups', $spaceId),
             [
                 "body" => [
                 ],
             ],
         );
+        return new SpaceResponse($httpResponse);
     }
 }
diff --git a/src/Endpoints/StoryApi.php b/src/Endpoints/StoryApi.php
@@ -4,19 +4,17 @@
 
 namespace Storyblok\ManagementApi\Endpoints;
 
+use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
-use Storyblok\ManagementApi\ManagementApiClient;
-use Storyblok\ManagementApi\QueryParameters\Filters\QueryFilters;
-use Storyblok\ManagementApi\QueryParameters\PaginationParams;
-use Storyblok\ManagementApi\QueryParameters\StoriesParams;
-use Storyblok\ManagementApi\Data\StoryblokDataInterface;
-use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Storyblok\ManagementApi\Data\StoriesData;
 use Storyblok\ManagementApi\Data\StoryData;
 use Storyblok\ManagementApi\Exceptions\InvalidStoryDataException;
 use Storyblok\ManagementApi\Exceptions\StoryblokApiException;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
-use Psr\Log\LoggerInterface;
+use Storyblok\ManagementApi\ManagementApiClient;
+use Storyblok\ManagementApi\QueryParameters\Filters\QueryFilters;
+use Storyblok\ManagementApi\QueryParameters\PaginationParams;
+use Storyblok\ManagementApi\QueryParameters\StoriesParams;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 
 /**
  * StoryApi handles all story-related operations in the Storyblok Management API
diff --git a/src/Endpoints/StoryBulkApi.php b/src/Endpoints/StoryBulkApi.php
@@ -4,19 +4,17 @@
 
 namespace Storyblok\ManagementApi\Endpoints;
 
+use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+use Storyblok\ManagementApi\Data\StoriesData;
+use Storyblok\ManagementApi\Data\StoryblokDataInterface;
+use Storyblok\ManagementApi\Data\StoryData;
+use Storyblok\ManagementApi\Exceptions\StoryblokApiException;
 use Storyblok\ManagementApi\ManagementApiClient;
 use Storyblok\ManagementApi\QueryParameters\Filters\QueryFilters;
 use Storyblok\ManagementApi\QueryParameters\PaginationParams;
 use Storyblok\ManagementApi\QueryParameters\StoriesParams;
-use Storyblok\ManagementApi\Data\StoryblokDataInterface;
-use Symfony\Contracts\HttpClient\HttpClientInterface;
-use Storyblok\ManagementApi\Data\StoriesData;
-use Storyblok\ManagementApi\Data\StoryData;
-use Storyblok\ManagementApi\Exceptions\InvalidStoryDataException;
-use Storyblok\ManagementApi\Exceptions\StoryblokApiException;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
-use Psr\Log\LoggerInterface;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 
 /**
  * StoryApi handles all story-related operations in the Storyblok Management API
diff --git a/src/Endpoints/TagApi.php b/src/Endpoints/TagApi.php
@@ -6,7 +6,7 @@
 
 use Storyblok\ManagementApi\Data\TagData;
 use Storyblok\ManagementApi\Data\TagsData;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 
 /**
  *
diff --git a/src/Endpoints/UserApi.php b/src/Endpoints/UserApi.php
@@ -5,7 +5,7 @@
 namespace Storyblok\ManagementApi\Endpoints;
 
 use Storyblok\ManagementApi\Data\UserData;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 
 /**
  *
diff --git a/src/Endpoints/WorkflowApi.php b/src/Endpoints/WorkflowApi.php
@@ -7,7 +7,7 @@
 use Storyblok\ManagementApi\Data\StoryblokData;
 use Storyblok\ManagementApi\Data\WorkflowData;
 use Storyblok\ManagementApi\Data\WorkflowsData;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 
 /**
  *
diff --git a/src/Endpoints/WorkflowStageApi.php b/src/Endpoints/WorkflowStageApi.php
@@ -8,7 +8,7 @@
 use Storyblok\ManagementApi\Data\WorkflowStageData;
 use Storyblok\ManagementApi\Data\WorkflowStagesData;
 use Storyblok\ManagementApi\QueryParameters\WorkflowStagesParams;
-use Storyblok\ManagementApi\StoryblokResponseInterface;
+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;
 
 /**
  *
diff --git a/src/Exceptions/StoryblokFormatException.php b/src/Exceptions/StoryblokFormatException.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storyblok\ManagementApi\Exceptions;
+
+/**
+ * Exception thrown when there is an expected format from the Response
+ */
+class StoryblokFormatException extends \Exception {}
diff --git a/src/Response/SpaceResponse.php b/src/Response/SpaceResponse.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storyblok\ManagementApi\Response;
+
+use Storyblok\ManagementApi\Data\SpaceData;
+use Storyblok\ManagementApi\Exceptions\StoryblokFormatException;
+use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+
+class SpaceResponse extends StoryblokResponse implements StoryblokResponseInterface
+{
+    /**
+     * @throws TransportExceptionInterface
+     * @throws ServerExceptionInterface
+     * @throws RedirectionExceptionInterface
+     * @throws DecodingExceptionInterface
+     * @throws StoryblokFormatException
+     * @throws ClientExceptionInterface
+     */
+    #[\Override]
+    public function data(): SpaceData
+    {
+        $key = "space";
+        $array = $this->toArray();
+        if (array_key_exists($key, $array)) {
+            return new SpaceData($array[$key]);
+        }
+
+        //var_dump($array);
+
+        throw new StoryblokFormatException(sprintf("Expected '%s' in the response.", $key));
+
+    }
+
+}
diff --git a/src/Response/SpacesResponse.php b/src/Response/SpacesResponse.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storyblok\ManagementApi\Response;
+
+use Storyblok\ManagementApi\Data\SpaceData;
+use Storyblok\ManagementApi\Data\SpacesData;
+use Storyblok\ManagementApi\Data\StoryblokData;
+use Storyblok\ManagementApi\Exceptions\StoryblokFormatException;
+use Storyblok\ManagementApi\Response\StoryblokResponse;
+
+class SpacesResponse extends StoryblokResponse implements StoryblokResponseInterface
+{
+    #[\Override]
+    public function data(): SpacesData
+    {
+        $key = "spaces";
+        $array = $this->toArray();
+        if (array_key_exists($key, $array)) {
+            return new SpacesData($array[$key]);
+        }
+
+        throw new StoryblokFormatException(sprintf("Expected '%s' in the response.", $key));
+
+    }
+
+}
diff --git a/src/Response/StoryblokResponse.php b/src/Response/StoryblokResponse.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Storyblok\ManagementApi;
+namespace Storyblok\ManagementApi\Response;
 
 use Storyblok\ManagementApi\Data\StoryblokData;
 use Storyblok\ManagementApi\Data\StoryblokDataInterface;
diff --git a/src/Response/StoryblokResponseInterface.php b/src/Response/StoryblokResponseInterface.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Storyblok\ManagementApi;
+namespace Storyblok\ManagementApi\Response;
 
 use Storyblok\ManagementApi\Data\StoryblokDataInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
diff --git a/tests/Feature/Data/empty-space.json b/tests/Feature/Data/empty-space.json
@@ -0,0 +1 @@
+["This record could not be found"]
diff --git a/tests/Feature/Data/list-spaces.json b/tests/Feature/Data/list-spaces.json
diff --git a/tests/Feature/Data/one-space.json b/tests/Feature/Data/one-space.json
diff --git a/tests/Feature/SpaceTest.php b/tests/Feature/SpaceTest.php

Original file line number	Diff line number	Diff line change
`@@ -48,12 +48,6 @@ public function createdAt(): null\|string`
`48`	`48`	`return $this->getFormattedDateTime('created_at', "", format: "Y-m-d");`
`49`	`49`	`}`
`50`	`50`
`51`		`- public function updatedAt(): null\|string`
`52`		`- {`
`53`		`- return $this->getFormattedDateTime('updated_at', "", format: "Y-m-d");`
`54`		`- }`
`55`		`-`
`56`		`-`
`57`	`51`
`58`	`52`	`public function planDescription(): null\|string`
`59`	`53`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Storyblok\ManagementApi\Endpoints;`
`6`	`6`
`7`		`-use Storyblok\ManagementApi\StoryblokResponseInterface;`
	`7`	`+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`*`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`use Storyblok\ManagementApi\Data\TagData;`
`8`	`8`	`use Storyblok\ManagementApi\Data\TagsData;`
`9`		`-use Storyblok\ManagementApi\StoryblokResponseInterface;`
	`9`	`+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`*`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace Storyblok\ManagementApi\Endpoints;`
`6`	`6`
`7`	`7`	`use Storyblok\ManagementApi\Data\UserData;`
`8`		`-use Storyblok\ManagementApi\StoryblokResponseInterface;`
	`8`	`+use Storyblok\ManagementApi\Response\StoryblokResponseInterface;`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`*`