fix: basic pagination should work

Author: stainless-app[bot]

src/Core.php

@@ -4,12 +4,6 @@
 
 namespace CasParser\Core;
 
-/**
- * @internal
- */
-enum Omittable
-{
-    case OMIT;
-}
+use CasParser\Core\Implementation\Omittable;
 
 const OMIT = Omittable::OMIT;

src/Core/BaseClient.php

@@ -79,18 +79,18 @@ public function request(
         [$req, $opts] = $this->buildRequest(method: $method, path: $path, query: $query, headers: $headers, body: $body, opts: $options);
         ['method' => $method, 'path' => $uri, 'headers' => $headers] = $req;
 
-        $req = $this->requestFactory->createRequest($method, uri: $uri);
-        $req = Util::withSetHeaders($req, headers: $headers);
+        $request = $this->requestFactory->createRequest($method, uri: $uri);
+        $request = Util::withSetHeaders($request, headers: $headers);
 
         // @phpstan-ignore-next-line
-        $rsp = $this->sendRequest($req, data: $body, opts: $opts, redirectCount: 0, retryCount: 0);
+        $rsp = $this->sendRequest($request, data: $body, opts: $opts, redirectCount: 0, retryCount: 0);
 
         $decoded = Util::decodeContent($rsp);
 
         if (!is_null($stream)) {
             return new $stream(
                 convert: $convert,
-                request: $req,
+                request: $request,
                 response: $rsp,
                 stream: $decoded
             );

src/Core/Concerns/SdkModel.php

@@ -5,6 +5,7 @@
 namespace CasParser\Core\Concerns;
 
 use CasParser\Core\Contracts\BaseModel;
+use CasParser\Core\Contracts\BasePage;
 use CasParser\Core\Conversion;
 use CasParser\Core\Conversion\CoerceState;
 use CasParser\Core\Conversion\Contracts\Converter;
@@ -244,7 +245,7 @@ private function unsetOptionalProperties(): void
      */
     private static function serialize(mixed $value): mixed
     {
-        if ($value instanceof BaseModel) {
+        if ($value instanceof BaseModel || $value instanceof BasePage) {
             return $value->toArray();
         }
 

src/Core/Pagination/AbstractPage.php renamed to src/Core/Concerns/SdkPage.php

@@ -2,10 +2,9 @@
 
 declare(strict_types=1);
 
-namespace CasParser\Core\Pagination;
+namespace CasParser\Core\Concerns;
 
 use CasParser\Client;
-use CasParser\Core\Contracts\BasePage;
 use CasParser\Core\Conversion\Contracts\Converter;
 use CasParser\Core\Conversion\Contracts\ConverterSource;
 use CasParser\Core\Errors\APIStatusError;
@@ -16,19 +15,20 @@
  *
  * @template Item
  *
- * @implements BasePage<Item>
- *
  * @phpstan-import-type normalized_request from \CasParser\Core\BaseClient
  */
-abstract class AbstractPage implements BasePage
+trait SdkPage
 {
-    public function __construct(
-        protected Converter|ConverterSource|string $convert,
-        protected Client $client,
-        protected array $request,
-        protected RequestOptions $options,
-        protected mixed $data,
-    ) {}
+    private Converter|ConverterSource|string $convert;
+
+    private Client $client;
+
+    /**
+     * normalized_request $request.
+     */
+    private array $request;
+
+    private RequestOptions $options;
 
     /**
      * @return list<Item>

src/Core/Contracts/BasePage.php

@@ -10,11 +10,14 @@
 use CasParser\RequestOptions;
 
 /**
+ * @internal
+ *
  * @template Item
  *
+ * @extends \ArrayAccess<string, mixed>
  * @extends \IteratorAggregate<int, static>
  */
-interface BasePage extends \IteratorAggregate
+interface BasePage extends \ArrayAccess, \JsonSerializable, \Stringable, \IteratorAggregate
 {
     /**
      * @internal
@@ -29,6 +32,14 @@ public function __construct(
         mixed $data,
     );
 
+    /**
+     * @return static<Item>
+     */
+    public static function fromArray(mixed $data): self;
+
+    /** @return array<string, mixed> */
+    public function toArray(): array;
+
     public function hasNextPage(): bool;
 
     /**
@@ -40,4 +51,9 @@ public function getPaginatedItems(): array;
      * @return static<Item>
      */
     public function getNextPage(): static;
+
+    /**
+     * @return \Generator<Item>
+     */
+    public function pagingEachItem(): \Generator;
 }

src/Core/Conversion/ModelOf.php

@@ -6,6 +6,7 @@
 
 use CasParser\Core\Attributes\Api;
 use CasParser\Core\Contracts\BaseModel;
+use CasParser\Core\Contracts\BasePage;
 use CasParser\Core\Conversion;
 use CasParser\Core\Conversion\Contracts\Converter;
 
@@ -20,7 +21,7 @@ final class ModelOf implements Converter
     public readonly array $properties;
 
     /**
-     * @param \ReflectionClass<BaseModel> $class
+     * @param \ReflectionClass<BaseModel|BasePage<mixed>> $class
      */
     public function __construct(public readonly \ReflectionClass $class)
     {
@@ -93,8 +94,10 @@ public function coerce(mixed $value, CoerceState $state): mixed
 
     /**
      * @param array<mixed> $data
+     *
+     * @return BaseModel|BasePage<mixed>
      */
-    public function from(array $data): BaseModel
+    public function from(array $data): BaseModel|BasePage
     {
         $instance = $this->class->newInstanceWithoutConstructor();
         $instance->__unserialize($data); // @phpstan-ignore-line
@@ -104,7 +107,7 @@ public function from(array $data): BaseModel
 
     public function dump(mixed $value, DumpState $state): mixed
     {
-        if ($value instanceof BaseModel) {
+        if ($value instanceof BaseModel || $value instanceof BasePage) {
             $value = $value->toArray();
         }
 

src/Core/Implementation/Omittable.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CasParser\Core\Implementation;
+
+/**
+ * @internal
+ */
+enum Omittable
+{
+    case OMIT;
+}