Add missing types

Author: norkunas

src/Contracts/Data.php

@@ -6,7 +6,7 @@
 
 class Data implements \ArrayAccess, \Countable, \IteratorAggregate
 {
-    protected $data = [];
+    protected array $data = [];
 
     public function __construct(array $data = [])
     {
@@ -28,14 +28,9 @@ public function offsetUnset($offset): void
         unset($this->data[$offset]);
     }
 
-    #[\ReturnTypeWillChange]
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
-        if (isset($this->data[$offset])) {
-            return $this->data[$offset];
-        }
-
-        return null;
+        return $this->data[$offset] ?? null;
     }
 
     public function count(): int

src/Contracts/Http.php

@@ -8,11 +8,11 @@ interface Http
 {
     public function get(string $path, array $query = []);
 
-    public function post(string $path, $body = null, array $query = [], ?string $contentType = null);
+    public function post(string $path, mixed $body = null, array $query = [], ?string $contentType = null);
 
-    public function put(string $path, $body = null, array $query = [], ?string $contentType = null);
+    public function put(string $path, mixed $body = null, array $query = [], ?string $contentType = null);
 
-    public function patch(string $path, $body = null, array $query = []);
+    public function patch(string $path, mixed $body = null, array $query = []);
 
     public function delete(string $path, array $query = []);
 }

src/Contracts/SimilarDocumentsQuery.php

@@ -7,9 +7,9 @@
 class SimilarDocumentsQuery
 {
     /**
-     * @var int|string
+     * @var int|non-empty-string
      */
-    private $id;
+    private int|string $id;
 
     /**
      * @var non-empty-string
@@ -42,16 +42,13 @@ class SimilarDocumentsQuery
      */
     private ?array $filter = null;
 
-    /**
-     * @var int|float|null
-     */
-    private $rankingScoreThreshold;
+    private int|float|null $rankingScoreThreshold = null;
 
     /**
-     * @param int|string       $id
-     * @param non-empty-string $embedder
+     * @param int|non-empty-string $id
+     * @param non-empty-string     $embedder
      */
-    public function __construct($id, string $embedder)
+    public function __construct(int|string $id, string $embedder)
     {
         $this->id = $id;
         $this->embedder = $embedder;
@@ -142,11 +139,9 @@ public function setRetrieveVectors(?bool $retrieveVectors): self
     }
 
     /**
-     * @param int|float|null $rankingScoreThreshold
-     *
      * @return $this
      */
-    public function setRankingScoreThreshold($rankingScoreThreshold): self
+    public function setRankingScoreThreshold(int|float|null $rankingScoreThreshold): self
     {
         $this->rankingScoreThreshold = $rankingScoreThreshold;
 
@@ -155,7 +150,7 @@ public function setRankingScoreThreshold($rankingScoreThreshold): self
 
     /**
      * @return array{
-     *     id: int|string,
+     *     id: int|non-empty-string,
      *     embedder: non-empty-string,
      *     offset?: non-negative-int,
      *     limit?: positive-int,

src/Endpoints/Batches.php

@@ -10,7 +10,7 @@ class Batches extends Endpoint
 {
     protected const PATH = '/batches';
 
-    public function get($batchUid): array
+    public function get(int $batchUid): array
     {
         return $this->http->get(self::PATH.'/'.$batchUid);
     }

src/Endpoints/Delegates/HandlesBatches.php

@@ -12,7 +12,7 @@ trait HandlesBatches
 {
     protected Batches $batches;
 
-    public function getBatch($uid): array
+    public function getBatch(int $uid): array
     {
         return $this->batches->get($uid);
     }

src/Endpoints/Delegates/HandlesDocuments.php

@@ -7,14 +7,12 @@
 use Meilisearch\Contracts\DocumentsQuery;
 use Meilisearch\Contracts\DocumentsResults;
 use Meilisearch\Exceptions\ApiException;
-use Meilisearch\Exceptions\InvalidArgumentException;
 use Meilisearch\Exceptions\InvalidResponseBodyException;
 
 trait HandlesDocuments
 {
-    public function getDocument($documentId, ?array $fields = null)
+    public function getDocument(string|int $documentId, ?array $fields = null): array
     {
-        $this->assertValidDocumentId($documentId);
         $query = isset($fields) ? ['fields' => implode(',', $fields)] : [];
 
         return $this->http->get(self::PATH.'/'.$this->uid.'/documents/'.$documentId, $query);
@@ -38,27 +36,27 @@ public function getDocuments(?DocumentsQuery $options = null): DocumentsResults
         }
     }
 
-    public function addDocuments(array $documents, ?string $primaryKey = null)
+    public function addDocuments(array $documents, ?string $primaryKey = null): array
     {
         return $this->http->post(self::PATH.'/'.$this->uid.'/documents', $documents, ['primaryKey' => $primaryKey]);
     }
 
-    public function addDocumentsJson(string $documents, ?string $primaryKey = null)
+    public function addDocumentsJson(string $documents, ?string $primaryKey = null): array
     {
         return $this->http->post(self::PATH.'/'.$this->uid.'/documents', $documents, ['primaryKey' => $primaryKey], 'application/json');
     }
 
-    public function addDocumentsCsv(string $documents, ?string $primaryKey = null, ?string $delimiter = null)
+    public function addDocumentsCsv(string $documents, ?string $primaryKey = null, ?string $delimiter = null): array
     {
         return $this->http->post(self::PATH.'/'.$this->uid.'/documents', $documents, ['primaryKey' => $primaryKey, 'csvDelimiter' => $delimiter], 'text/csv');
     }
 
-    public function addDocumentsNdjson(string $documents, ?string $primaryKey = null)
+    public function addDocumentsNdjson(string $documents, ?string $primaryKey = null): array
     {
         return $this->http->post(self::PATH.'/'.$this->uid.'/documents', $documents, ['primaryKey' => $primaryKey], 'application/x-ndjson');
     }
 
-    public function addDocumentsInBatches(array $documents, ?int $batchSize = 1000, ?string $primaryKey = null)
+    public function addDocumentsInBatches(array $documents, ?int $batchSize = 1000, ?string $primaryKey = null): array
     {
         $promises = [];
 
@@ -69,7 +67,7 @@ public function addDocumentsInBatches(array $documents, ?int $batchSize = 1000,
         return $promises;
     }
 
-    public function addDocumentsCsvInBatches(string $documents, ?int $batchSize = 1000, ?string $primaryKey = null, ?string $delimiter = null)
+    public function addDocumentsCsvInBatches(string $documents, ?int $batchSize = 1000, ?string $primaryKey = null, ?string $delimiter = null): array
     {
         $promises = [];
 
@@ -80,7 +78,7 @@ public function addDocumentsCsvInBatches(string $documents, ?int $batchSize = 10
         return $promises;
     }
 
-    public function addDocumentsNdjsonInBatches(string $documents, ?int $batchSize = 1000, ?string $primaryKey = null)
+    public function addDocumentsNdjsonInBatches(string $documents, ?int $batchSize = 1000, ?string $primaryKey = null): array
     {
         $promises = [];
 
@@ -91,27 +89,27 @@ public function addDocumentsNdjsonInBatches(string $documents, ?int $batchSize =
         return $promises;
     }
 
-    public function updateDocuments(array $documents, ?string $primaryKey = null)
+    public function updateDocuments(array $documents, ?string $primaryKey = null): array
     {
         return $this->http->put(self::PATH.'/'.$this->uid.'/documents', $documents, ['primaryKey' => $primaryKey]);
     }
 
-    public function updateDocumentsJson(string $documents, ?string $primaryKey = null)
+    public function updateDocumentsJson(string $documents, ?string $primaryKey = null): array
     {
         return $this->http->put(self::PATH.'/'.$this->uid.'/documents', $documents, ['primaryKey' => $primaryKey], 'application/json');
     }
 
-    public function updateDocumentsCsv(string $documents, ?string $primaryKey = null, ?string $delimiter = null)
+    public function updateDocumentsCsv(string $documents, ?string $primaryKey = null, ?string $delimiter = null): array
     {
         return $this->http->put(self::PATH.'/'.$this->uid.'/documents', $documents, ['primaryKey' => $primaryKey, 'csvDelimiter' => $delimiter], 'text/csv');
     }
 
-    public function updateDocumentsNdjson(string $documents, ?string $primaryKey = null)
+    public function updateDocumentsNdjson(string $documents, ?string $primaryKey = null): array
     {
         return $this->http->put(self::PATH.'/'.$this->uid.'/documents', $documents, ['primaryKey' => $primaryKey], 'application/x-ndjson');
     }
 
-    public function updateDocumentsInBatches(array $documents, ?int $batchSize = 1000, ?string $primaryKey = null)
+    public function updateDocumentsInBatches(array $documents, ?int $batchSize = 1000, ?string $primaryKey = null): array
     {
         $promises = [];
 
@@ -122,7 +120,7 @@ public function updateDocumentsInBatches(array $documents, ?int $batchSize = 100
         return $promises;
     }
 
-    public function updateDocumentsCsvInBatches(string $documents, ?int $batchSize = 1000, ?string $primaryKey = null, ?string $delimiter = null)
+    public function updateDocumentsCsvInBatches(string $documents, ?int $batchSize = 1000, ?string $primaryKey = null, ?string $delimiter = null): array
     {
         $promises = [];
 
@@ -133,7 +131,7 @@ public function updateDocumentsCsvInBatches(string $documents, ?int $batchSize =
         return $promises;
     }
 
-    public function updateDocumentsNdjsonInBatches(string $documents, ?int $batchSize = 1000, ?string $primaryKey = null)
+    public function updateDocumentsNdjsonInBatches(string $documents, ?int $batchSize = 1000, ?string $primaryKey = null): array
     {
         $promises = [];
 
@@ -154,7 +152,7 @@ public function updateDocumentsNdjsonInBatches(string $documents, ?int $batchSiz
      * @param non-empty-string                                                                                       $function
      * @param array{filter?: non-empty-string|list<non-empty-string>|null, context?: array<non-empty-string, mixed>} $options
      */
-    public function updateDocumentsByFunction(string $function, array $options = [])
+    public function updateDocumentsByFunction(string $function, array $options = []): array
     {
         return $this->http->post(self::PATH.'/'.$this->uid.'/documents/edit', array_merge(['function' => $function], $options));
     }
@@ -164,10 +162,8 @@ public function deleteAllDocuments(): array
         return $this->http->delete(self::PATH.'/'.$this->uid.'/documents');
     }
 
-    public function deleteDocument($documentId): array
+    public function deleteDocument(string|int $documentId): array
     {
-        $this->assertValidDocumentId($documentId);
-
         return $this->http->delete(self::PATH.'/'.$this->uid.'/documents/'.$documentId);
     }
 
@@ -186,17 +182,6 @@ public function deleteDocuments(array $options): array
         }
     }
 
-    private function assertValidDocumentId($documentId): void
-    {
-        if (!\is_string($documentId) && !\is_int($documentId)) {
-            throw InvalidArgumentException::invalidType('documentId', ['string', 'int']);
-        }
-
-        if (\is_string($documentId) && '' === trim($documentId)) {
-            throw InvalidArgumentException::emptyArgument('documentId');
-        }
-    }
-
     private static function batchCsvString(string $documents, int $batchSize): \Generator
     {
         $parsedDocuments = preg_split("/\r\n|\n|\r/", trim($documents));

src/Endpoints/Delegates/HandlesIndex.php

@@ -17,31 +17,49 @@ public function getIndexes(?IndexesQuery $options = null): IndexesResults
         return $this->index->all($options ?? null);
     }
 
+    /**
+     * @param non-empty-string $uid
+     */
     public function getRawIndex(string $uid): array
     {
         return $this->index($uid)->fetchRawInfo();
     }
 
+    /**
+     * @param non-empty-string $uid
+     */
     public function index(string $uid): Indexes
     {
         return new Indexes($this->http, $uid);
     }
 
+    /**
+     * @param non-empty-string $uid
+     */
     public function getIndex(string $uid): Indexes
     {
         return $this->index($uid)->fetchInfo();
     }
 
+    /**
+     * @param non-empty-string $uid
+     */
     public function deleteIndex(string $uid): array
     {
         return $this->index($uid)->delete();
     }
 
+    /**
+     * @param non-empty-string $uid
+     */
     public function createIndex(string $uid, array $options = []): array
     {
         return $this->index->create($uid, $options);
     }
 
+    /**
+     * @param non-empty-string $uid
+     */
     public function updateIndex(string $uid, array $options = []): array
     {
         return $this->index($uid)->update($options);

src/Endpoints/Delegates/HandlesTasks.php

@@ -15,7 +15,7 @@ trait HandlesTasks
 {
     protected Tasks $tasks;
 
-    public function getTask($uid): array
+    public function getTask(int $uid): array
     {
         return $this->tasks->get($uid);
     }
@@ -42,15 +42,17 @@ public function cancelTasks(?CancelTasksQuery $options = null): array
     /**
      * @throws TimeOutException
      */
-    public function waitForTask($uid, int $timeoutInMs = 5000, int $intervalInMs = 50): array
+    public function waitForTask(int $uid, int $timeoutInMs = 5000, int $intervalInMs = 50): array
     {
         return $this->tasks->waitTask($uid, $timeoutInMs, $intervalInMs);
     }
 
     /**
+     * @param array<int> $uids
+     *
      * @throws TimeOutException
      */
-    public function waitForTasks($uids, int $timeoutInMs = 5000, int $intervalInMs = 50): array
+    public function waitForTasks(array $uids, int $timeoutInMs = 5000, int $intervalInMs = 50): array
     {
         return $this->tasks->waitTasks($uids, $timeoutInMs, $intervalInMs);
     }

src/Endpoints/Delegates/TasksQueryTrait.php

@@ -148,7 +148,7 @@ protected function baseArray(): array
 
     private function formatDate(?\DateTimeInterface $date): ?string
     {
-        return null !== $date ? $date->format(\DateTimeInterface::RFC3339) : null;
+        return $date?->format(\DateTimeInterface::RFC3339);
     }
 
     private function formatArray(?array $array): ?string

src/Endpoints/Indexes.php

@@ -136,7 +136,7 @@ public function fetchInfo(): self
         return $this->fill($response);
     }
 
-    public function update($body): array
+    public function update(array $body): array
     {
         return $this->http->patch(self::PATH.'/'.$this->uid, $body);
     }
@@ -156,7 +156,7 @@ public function swapIndexes(array $indexes): array
 
     // Tasks
 
-    public function getTask($uid): array
+    public function getTask(int $uid): array
     {
         return $this->http->get('/tasks/'.$uid);
     }
@@ -179,11 +179,9 @@ public function getTasks(?TasksQuery $options = null): TasksResults
     // Search
 
     /**
-     * @return SearchResult|array
-     *
      * @phpstan-return ($options is array{raw: true|non-falsy-string|positive-int} ? array : SearchResult)
      */
-    public function search(?string $query, array $searchParams = [], array $options = [])
+    public function search(?string $query, array $searchParams = [], array $options = []): SearchResult|array
     {
         $result = $this->rawSearch($query, $searchParams);