feat(refactor)!: clean up pagination, errors, as well as request methods

Author: stainless-app[bot]

README.md

@@ -72,7 +72,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 ```php
 <?php
 
-use Scrapegraphai\Errors\APIConnectionError;
+use Scrapegraphai\Core\Errors\APIConnectionError;
 
 try {
   $completedSmartscraper = $client->smartscraper->create(

composer.json

@@ -2,7 +2,7 @@
   "$schema": "https://getcomposer.org/schema.json",
   "autoload": {
     "files": [
-      "src/Core/Omit.php",
+      "src/Core.php",
       "src/Client.php"
     ],
     "psr-4": {

src/Core/Omittable.php renamed to src/Core.php

@@ -11,3 +11,5 @@ enum Omittable
 {
     case OMIT;
 }
+
+const OMIT = Omittable::OMIT;

src/Core/BaseClient.php

@@ -13,7 +13,7 @@
 use Psr\Http\Message\StreamFactoryInterface;
 use Psr\Http\Message\UriFactoryInterface;
 use Psr\Http\Message\UriInterface;
-use Scrapegraphai\Errors\APIStatusError;
+use Scrapegraphai\Core\Errors\APIStatusError;
 use Scrapegraphai\RequestOptions;
 
 class BaseClient

src/Core/Concerns/SdkParams.php

@@ -6,6 +6,7 @@
 
 use Scrapegraphai\Core\Conversion;
 use Scrapegraphai\Core\Conversion\DumpState;
+use Scrapegraphai\Core\Util;
 use Scrapegraphai\RequestOptions;
 
 /**
@@ -29,9 +30,10 @@ trait SdkParams
      */
     public static function parseRequest(array|self|null $params, array|RequestOptions|null $options): array
     {
+        $value = is_array($params) ? Util::array_filter_omit($params) : $params;
         $converter = self::converter();
         $state = new DumpState;
-        $dumped = (array) Conversion::dump($converter, value: $params, state: $state);
+        $dumped = (array) Conversion::dump($converter, value: $value, state: $state);
         $opts = RequestOptions::parse($options); // @phpstan-ignore-line
 
         if (!$state->canRetry) {

src/Core/Contracts/BasePage.php

@@ -9,14 +9,31 @@
 use Scrapegraphai\Core\Pagination\PageRequestOptions;
 
 /**
- * @internal
+ * @template Item
+ *
+ * @extends \IteratorAggregate<int, static>
  */
-interface BasePage
+interface BasePage extends \IteratorAggregate
 {
+    /**
+     * @internal
+     */
     public function __construct(
         BaseClient $client,
         PageRequestOptions $options,
         ResponseInterface $response,
         mixed $body,
     );
+
+    public function hasNextPage(): bool;
+
+    /**
+     * @return list<Item>
+     */
+    public function getPaginatedItems(): array;
+
+    /**
+     * @return static<Item>
+     */
+    public function getNextPage(): static;
 }

src/Errors/APIConnectionError.php renamed to src/Core/Errors/APIConnectionError.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Scrapegraphai\Errors;
+namespace Scrapegraphai\Core\Errors;
 
 class APIConnectionError extends APIError
 {

src/Errors/APIError.php renamed to src/Core/Errors/APIError.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace Scrapegraphai\Errors;
+namespace Scrapegraphai\Core\Errors;
 
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
-class APIError extends Error
+class APIError extends ScrapegraphaiError
 {
     public ?int $status = null;
 

src/Errors/APIStatusError.php renamed to src/Core/Errors/APIStatusError.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Scrapegraphai\Errors;
+namespace Scrapegraphai\Core\Errors;
 
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;

src/Errors/APITimeoutError.php renamed to src/Core/Errors/APITimeoutError.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Scrapegraphai\Errors;
+namespace Scrapegraphai\Core\Errors;
 
 use Psr\Http\Message\RequestInterface;