feat(php): differentiate null and omit

Author: stainless-app[bot]

composer.json

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

src/Contracts/CrawlContract.php

@@ -9,6 +9,8 @@
 use Scrapegraphai\Responses\Crawl\CrawlGetResultsResponse;
 use Scrapegraphai\Responses\Crawl\CrawlStartResponse;
 
+use const Scrapegraphai\Core\OMIT as omit;
+
 interface CrawlContract
 {
     public function retrieveResults(
@@ -29,14 +31,14 @@ public function retrieveResults(
      */
     public function start(
         $url,
-        $depth = null,
-        $extractionMode = null,
-        $maxPages = null,
-        $prompt = null,
-        $renderHeavyJs = null,
-        $rules = null,
-        $schema = null,
-        $sitemap = null,
+        $depth = omit,
+        $extractionMode = omit,
+        $maxPages = omit,
+        $prompt = omit,
+        $renderHeavyJs = omit,
+        $rules = omit,
+        $schema = omit,
+        $sitemap = omit,
         ?RequestOptions $requestOptions = null,
     ): CrawlStartResponse;
 }

src/Contracts/FeedbackContract.php

@@ -7,6 +7,8 @@
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Responses\Feedback\FeedbackSubmitResponse;
 
+use const Scrapegraphai\Core\OMIT as omit;
+
 interface FeedbackContract
 {
     /**
@@ -17,7 +19,7 @@ interface FeedbackContract
     public function submit(
         $rating,
         $requestID,
-        $feedbackText = null,
+        $feedbackText = omit,
         ?RequestOptions $requestOptions = null,
     ): FeedbackSubmitResponse;
 }

src/Contracts/GenerateSchemaContract.php

@@ -9,6 +9,8 @@
 use Scrapegraphai\Responses\GenerateSchema\GenerateSchemaGetResponse\FailedSchemaGenerationResponse;
 use Scrapegraphai\Responses\GenerateSchema\GenerateSchemaNewResponse;
 
+use const Scrapegraphai\Core\OMIT as omit;
+
 interface GenerateSchemaContract
 {
     /**
@@ -17,7 +19,7 @@ interface GenerateSchemaContract
      */
     public function create(
         $userPrompt,
-        $existingSchema = null,
+        $existingSchema = omit,
         ?RequestOptions $requestOptions = null,
     ): GenerateSchemaNewResponse;
 

src/Contracts/MarkdownifyContract.php

@@ -8,6 +8,8 @@
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Responses\Markdownify\MarkdownifyGetStatusResponse\FailedMarkdownifyResponse;
 
+use const Scrapegraphai\Core\OMIT as omit;
+
 interface MarkdownifyContract
 {
     /**
@@ -17,8 +19,8 @@ interface MarkdownifyContract
      */
     public function convert(
         $websiteURL,
-        $headers = null,
-        $steps = null,
+        $headers = omit,
+        $steps = omit,
         ?RequestOptions $requestOptions = null,
     ): CompletedMarkdownify;
 

src/Contracts/SearchscraperContract.php

@@ -8,6 +8,8 @@
 use Scrapegraphai\Responses\Searchscraper\SearchscraperGetStatusResponse\FailedSearchScraperResponse;
 use Scrapegraphai\Searchscraper\CompletedSearchScraper;
 
+use const Scrapegraphai\Core\OMIT as omit;
+
 interface SearchscraperContract
 {
     /**
@@ -18,9 +20,9 @@ interface SearchscraperContract
      */
     public function create(
         $userPrompt,
-        $headers = null,
-        $numResults = null,
-        $outputSchema = null,
+        $headers = omit,
+        $numResults = omit,
+        $outputSchema = omit,
         ?RequestOptions $requestOptions = null,
     ): CompletedSearchScraper;
 

src/Contracts/SmartscraperContract.php

@@ -8,6 +8,8 @@
 use Scrapegraphai\Smartscraper\CompletedSmartscraper;
 use Scrapegraphai\Smartscraper\FailedSmartscraper;
 
+use const Scrapegraphai\Core\OMIT as omit;
+
 interface SmartscraperContract
 {
     /**
@@ -24,15 +26,15 @@ interface SmartscraperContract
      */
     public function create(
         $userPrompt,
-        $cookies = null,
-        $headers = null,
-        $numberOfScrolls = null,
-        $outputSchema = null,
-        $renderHeavyJs = null,
-        $steps = null,
-        $totalPages = null,
-        $websiteHTML = null,
-        $websiteURL = null,
+        $cookies = omit,
+        $headers = omit,
+        $numberOfScrolls = omit,
+        $outputSchema = omit,
+        $renderHeavyJs = omit,
+        $steps = omit,
+        $totalPages = omit,
+        $websiteHTML = omit,
+        $websiteURL = omit,
         ?RequestOptions $requestOptions = null,
     ): CompletedSmartscraper;
 

src/Core/Omit.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Scrapegraphai\Core;
+
+const OMIT = Omittable::OMIT;

src/Core/Omittable.php

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

src/Core/Util.php

@@ -349,19 +349,12 @@ public static function decodeContent(MessageInterface $rsp): mixed
 
     /**
      * @param array<string, mixed> $arr
-     * @param list<string> $keys
      *
      * @return array<string, mixed>
      */
-    public static function array_filter_null(array $arr, array $keys): array
+    public static function array_filter_omit(array $arr): array
     {
-        foreach ($keys as $key) {
-            if (array_key_exists($key, $arr) && is_null($arr[$key])) {
-                unset($arr[$key]);
-            }
-        }
-
-        return $arr;
+        return array_filter($arr, fn ($v, $_) => OMIT !== $v, ARRAY_FILTER_USE_BOTH);
     }
 
     /**