Merge branch 'main' into bump-meilisearch-v1.7.0

meilisearch · Feb 16, 2024 · 8fea95e · 8fea95e
2 parents 79e18c9 + a0bcb5a
commit 8fea95e
Show file tree

Hide file tree

Showing 14 changed files with 41 additions and 41 deletions.
diff --git a/src/Client.php b/src/Client.php
@@ -40,11 +40,11 @@ class Client
      */
     public function __construct(
         string $url,
-        string $apiKey = null,
-        ClientInterface $httpClient = null,
-        RequestFactoryInterface $requestFactory = null,
+        ?string $apiKey = null,
+        ?ClientInterface $httpClient = null,
+        ?RequestFactoryInterface $requestFactory = null,
         array $clientAgents = [],
-        StreamFactoryInterface $streamFactory = null
+        ?StreamFactoryInterface $streamFactory = null
     ) {
         $this->http = new MeilisearchClientAdapter($url, $apiKey, $httpClient, $requestFactory, $clientAgents, $streamFactory);
         $this->index = new Indexes($this->http);

diff --git a/src/Contracts/Endpoint.php b/src/Contracts/Endpoint.php
@@ -10,7 +10,7 @@ abstract class Endpoint
     protected Http $http;
     protected ?string $apiKey;
 
-    public function __construct(Http $http, string $apiKey = null)
+    public function __construct(Http $http, ?string $apiKey = null)
     {
         $this->http = $http;
         $this->apiKey = $apiKey;

diff --git a/src/Contracts/Http.php b/src/Contracts/Http.php
@@ -8,9 +8,9 @@ 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, $body = null, array $query = [], ?string $contentType = null);
 
-    public function put(string $path, $body = null, array $query = [], string $contentType = null);
+    public function put(string $path, $body = null, array $query = [], ?string $contentType = null);
 
     public function patch(string $path, $body = null, array $query = []);
 

diff --git a/src/Endpoints/Delegates/HandlesDocuments.php b/src/Endpoints/Delegates/HandlesDocuments.php
@@ -12,15 +12,15 @@
 
 trait HandlesDocuments
 {
-    public function getDocument($documentId, array $fields = null)
+    public function getDocument($documentId, ?array $fields = null)
     {
         $this->assertValidDocumentId($documentId);
         $query = isset($fields) ? ['fields' => implode(',', $fields)] : [];
 
         return $this->http->get(self::PATH.'/'.$this->uid.'/documents/'.$documentId, $query);
     }
 
-    public function getDocuments(DocumentsQuery $options = null): DocumentsResults
+    public function getDocuments(?DocumentsQuery $options = null): DocumentsResults
     {
         try {
             $options = $options ?? new DocumentsQuery();
@@ -38,27 +38,27 @@ public function getDocuments(DocumentsQuery $options = null): DocumentsResults
         }
     }
 
-    public function addDocuments(array $documents, string $primaryKey = null)
+    public function addDocuments(array $documents, ?string $primaryKey = null)
     {
         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)
     {
         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)
     {
         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)
     {
         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)
     {
         $promises = [];
         foreach (self::batch($documents, $batchSize) as $batch) {
@@ -68,7 +68,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)
     {
         $promises = [];
 
@@ -79,7 +79,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)
     {
         $promises = [];
         foreach (self::batchNdjsonString($documents, $batchSize) as $batch) {
@@ -89,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)
     {
         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)
     {
         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)
     {
         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)
     {
         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)
     {
         $promises = [];
         foreach (self::batch($documents, $batchSize) as $batch) {
@@ -119,7 +119,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)
     {
         $promises = [];
         foreach (self::batchCsvString($documents, $batchSize) as $batch) {
@@ -129,7 +129,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)
     {
         $promises = [];
         foreach (self::batchNdjsonString($documents, $batchSize) as $batch) {

diff --git a/src/Endpoints/Delegates/HandlesIndex.php b/src/Endpoints/Delegates/HandlesIndex.php
@@ -12,7 +12,7 @@ trait HandlesIndex
 {
     protected Indexes $index;
 
-    public function getIndexes(IndexesQuery $options = null): IndexesResults
+    public function getIndexes(?IndexesQuery $options = null): IndexesResults
     {
         return $this->index->all($options ?? null);
     }

diff --git a/src/Endpoints/Delegates/HandlesKeys.php b/src/Endpoints/Delegates/HandlesKeys.php
@@ -12,7 +12,7 @@ trait HandlesKeys
 {
     protected Keys $keys;
 
-    public function getKeys(KeysQuery $options = null): KeysResults
+    public function getKeys(?KeysQuery $options = null): KeysResults
     {
         return $this->keys->all($options);
     }

diff --git a/src/Endpoints/Delegates/HandlesTasks.php b/src/Endpoints/Delegates/HandlesTasks.php
@@ -20,7 +20,7 @@ public function getTask($uid): array
         return $this->tasks->get($uid);
     }
 
-    public function getTasks(TasksQuery $options = null): TasksResults
+    public function getTasks(?TasksQuery $options = null): TasksResults
     {
         $query = isset($options) ? $options->toArray() : [];
 
@@ -29,12 +29,12 @@ public function getTasks(TasksQuery $options = null): TasksResults
         return new TasksResults($response);
     }
 
-    public function deleteTasks(DeleteTasksQuery $options = null): array
+    public function deleteTasks(?DeleteTasksQuery $options = null): array
     {
         return $this->tasks->deleteTasks($options);
     }
 
-    public function cancelTasks(CancelTasksQuery $options = null): array
+    public function cancelTasks(?CancelTasksQuery $options = null): array
     {
         return $this->tasks->cancelTasks($options);
     }

diff --git a/src/Endpoints/Indexes.php b/src/Endpoints/Indexes.php
@@ -77,7 +77,7 @@ public function create(string $uid, array $options = []): array
         return $this->http->post(self::PATH, $options);
     }
 
-    public function all(IndexesQuery $options = null): IndexesResults
+    public function all(?IndexesQuery $options = null): IndexesResults
     {
         $indexes = [];
         $query = isset($options) ? $options->toArray() : [];
@@ -159,7 +159,7 @@ public function getTask($uid): array
         return $this->http->get('/tasks/'.$uid);
     }
 
-    public function getTasks(TasksQuery $options = null): TasksResults
+    public function getTasks(?TasksQuery $options = null): TasksResults
     {
         $options = $options ?? new TasksQuery();
 

diff --git a/src/Endpoints/Keys.php b/src/Endpoints/Keys.php
@@ -157,7 +157,7 @@ public function get($keyOrUid): self
         return $this->fill($response);
     }
 
-    public function all(KeysQuery $options = null): KeysResults
+    public function all(?KeysQuery $options = null): KeysResults
     {
         $query = isset($options) ? $options->toArray() : [];
 

diff --git a/src/Exceptions/JsonDecodingException.php b/src/Exceptions/JsonDecodingException.php
@@ -6,7 +6,7 @@
 
 final class JsonDecodingException extends \Exception implements ExceptionInterface
 {
-    public function __construct(string $message, int $code = 0, \Throwable $previous = null)
+    public function __construct(string $message, int $code = 0, ?\Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }

diff --git a/src/Exceptions/JsonEncodingException.php b/src/Exceptions/JsonEncodingException.php
@@ -6,7 +6,7 @@
 
 final class JsonEncodingException extends \Exception implements ExceptionInterface
 {
-    public function __construct(string $message, int $code = 0, \Throwable $previous = null)
+    public function __construct(string $message, int $code = 0, ?\Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }

diff --git a/src/Exceptions/TimeOutException.php b/src/Exceptions/TimeOutException.php
@@ -9,7 +9,7 @@ class TimeOutException extends \Exception implements ExceptionInterface
     public $code;
     public $message;
 
-    public function __construct(string $message = null, int $code = null, \Throwable $previous = null)
+    public function __construct(?string $message = null, ?int $code = null, ?\Throwable $previous = null)
     {
         $this->message = $message ?? 'Request timed out';
         $this->code = $code ?? 408;

diff --git a/src/Http/Client.php b/src/Http/Client.php
@@ -37,11 +37,11 @@ class Client implements Http
      */
     public function __construct(
         string $url,
-        string $apiKey = null,
-        ClientInterface $httpClient = null,
-        RequestFactoryInterface $reqFactory = null,
+        ?string $apiKey = null,
+        ?ClientInterface $httpClient = null,
+        ?RequestFactoryInterface $reqFactory = null,
         array $clientAgents = [],
-        StreamFactoryInterface $streamFactory = null
+        ?StreamFactoryInterface $streamFactory = null
     ) {
         $this->baseUrl = $url;
         $this->http = $httpClient ?? Psr18ClientDiscovery::find();
@@ -79,7 +79,7 @@ public function get(string $path, array $query = [])
      * @throws CommunicationException
      * @throws JsonEncodingException
      */
-    public function post(string $path, $body = null, array $query = [], string $contentType = null)
+    public function post(string $path, $body = null, array $query = [], ?string $contentType = null)
     {
         if (!\is_null($contentType)) {
             $this->headers['Content-type'] = $contentType;
@@ -95,7 +95,7 @@ public function post(string $path, $body = null, array $query = [], string $cont
         return $this->execute($request);
     }
 
-    public function put(string $path, $body = null, array $query = [], string $contentType = null)
+    public function put(string $path, $body = null, array $query = [], ?string $contentType = null)
     {
         if (!\is_null($contentType)) {
             $this->headers['Content-type'] = $contentType;

diff --git a/src/Meilisearch.php b/src/Meilisearch.php
@@ -6,7 +6,7 @@
 
 class Meilisearch
 {
-    public const VERSION = '1.6.0';
+    public const VERSION = '1.6.1';
 
     public static function qualifiedVersion()
     {