fix: URI encode user-inputted string

src/Alias.php

@@ -32,7 +32,7 @@ class Alias
      */
     public function __construct(string $name, ApiCall $apiCall)
     {
-        $this->name    = $name;
+        $this->name    = encodeURIComponent($name);
         $this->apiCall = $apiCall;
     }
 

src/Aliases.php

@@ -43,7 +43,7 @@ public function __construct(ApiCall $apiCall)
      */
     public function endPointPath(string $aliasName): string
     {
-        return sprintf('%s/%s', static::RESOURCE_PATH, $aliasName);
+        return sprintf('%s/%s', static::RESOURCE_PATH, encodeURIComponent($aliasName));
     }
 
     /**

src/AnalyticsRule.php

@@ -9,7 +9,7 @@ class AnalyticsRule
 
     public function __construct(string $ruleName, ApiCall $apiCall)
     {
-        $this->ruleName = $ruleName;
+        $this->ruleName = encodeURIComponent($ruleName);
         $this->apiCall  = $apiCall;
     }
 

src/AnalyticsRules.php

@@ -34,6 +34,6 @@ public function retrieve()
 
     private function endpoint_path($operation = null)
     {
-        return self::RESOURCE_PATH . ($operation === null ? '' : "/$operation");
+        return self::RESOURCE_PATH . ($operation === null ? '' : "/" . encodeURIComponent($operation));
     }
 }

src/Client.php

@@ -5,6 +5,7 @@
 use Typesense\Exceptions\ConfigError;
 use Typesense\Lib\Configuration;
 
+include('utils/utils.php');
 /**
  * Class Client
  *

src/Collection.php

@@ -52,11 +52,12 @@ class Collection
      */
     public function __construct(string $name, ApiCall $apiCall)
     {
-        $this->name      = $name;
+        $encodedName     = encodeURIComponent($name);
+        $this->name      = $encodedName;
         $this->apiCall   = $apiCall;
-        $this->documents = new Documents($name, $this->apiCall);
-        $this->overrides = new Overrides($name, $this->apiCall);
-        $this->synonyms  = new Synonyms($name, $this->apiCall);
+        $this->documents = new Documents($encodedName, $this->apiCall);
+        $this->overrides = new Overrides($encodedName, $this->apiCall);
+        $this->synonyms  = new Synonyms($encodedName, $this->apiCall);
     }
 
     /**

src/Conversation.php

@@ -30,7 +30,7 @@ class Conversation
      */
     public function __construct(string $id, ApiCall $apiCall)
     {
-        $this->id = $id;
+        $this->id = encodeURIComponent($id);
         $this->apiCall = $apiCall;
     }
 

src/ConversationModel.php

@@ -30,7 +30,7 @@ class ConversationModel
      */
     public function __construct(string $id, ApiCall $apiCall)
     {
-        $this->id = $id;
+        $this->id = encodeURIComponent($id);
         $this->apiCall = $apiCall;
     }
 

src/Document.php

@@ -38,8 +38,8 @@ class Document
      */
     public function __construct(string $collectionName, string $documentId, ApiCall $apiCall)
     {
-        $this->collectionName = $collectionName;
-        $this->documentId     = $documentId;
+        $this->collectionName = $collectionName; // already URI encoded in Collection construct
+        $this->documentId     = encodeURIComponent($documentId);
         $this->apiCall        = $apiCall;
     }
 

src/Documents.php

@@ -39,7 +39,7 @@ class Documents implements \ArrayAccess
      */
     public function __construct(string $collectionName, ApiCall $apiCall)
     {
-        $this->collectionName = $collectionName;
+        $this->collectionName = $collectionName; // already URI encoded in Collection construct
         $this->apiCall        = $apiCall;
     }
 
@@ -125,7 +125,7 @@ public function createMany(array $documents, array $options = []): array
     {
         $this->apiCall->getLogger()->warning(
             "createMany is deprecated and will be removed in a future version. " .
-            "Use import instead, which now takes both an array of documents or a JSONL string of documents"
+                "Use import instead, which now takes both an array of documents or a JSONL string of documents"
         );
         return $this->import($documents, $options);
     }

src/Key.php

@@ -32,7 +32,7 @@ class Key
      */
     public function __construct(string $keyId, ApiCall $apiCall)
     {
-        $this->keyId   = $keyId;
+        $this->keyId   = encodeURIComponent($keyId);
         $this->apiCall = $apiCall;
     }
 

src/Override.php

@@ -38,8 +38,8 @@ class Override
      */
     public function __construct(string $collectionName, string $overrideId, ApiCall $apiCall)
     {
-        $this->collectionName = $collectionName;
-        $this->overrideId     = $overrideId;
+        $this->collectionName = $collectionName; // already URI encoded in Collection construct
+        $this->overrideId     = encodeURIComponent($overrideId);
         $this->apiCall        = $apiCall;
     }
 

src/Overrides.php

@@ -5,6 +5,8 @@
 use Http\Client\Exception as HttpClientException;
 use Typesense\Exceptions\TypesenseClientError;
 
+
+
 /**
  * Class Overrides
  *
@@ -39,7 +41,7 @@ class Overrides implements \ArrayAccess
      */
     public function __construct(string $collectionName, ApiCall $apiCall)
     {
-        $this->collectionName = $collectionName;
+        $this->collectionName = $collectionName; // already URI encoded in Collection construct
         $this->apiCall        = $apiCall;
     }
 
@@ -55,7 +57,7 @@ public function endPointPath(string $overrideId = ''): string
             Collections::RESOURCE_PATH,
             $this->collectionName,
             static::RESOURCE_PATH,
-            $overrideId
+            encodeURIComponent($overrideId)
         );
     }
 

src/Presets.php

@@ -89,7 +89,7 @@ private function endpointPath($presetsName)
         return sprintf(
             '%s/%s',
             static::PRESETS_PATH,
-            $presetsName
+            encodeURIComponent($presetsName)
         );
     }
 

src/Stopwords.php

@@ -88,7 +88,7 @@ private function endpointPath($stopwordsName)
         return sprintf(
             '%s/%s',
             static::STOPWORDS_PATH,
-            $stopwordsName
+            encodeURIComponent($stopwordsName)
         );
     }
 }

src/Synonym.php

@@ -36,8 +36,8 @@ class Synonym
      */
     public function __construct(string $collectionName, string $synonymId, ApiCall $apiCall)
     {
-        $this->collectionName = $collectionName;
-        $this->synonymId      = $synonymId;
+        $this->collectionName = $collectionName; // already URI encoded in Collection construct
+        $this->synonymId      = encodeURIComponent($synonymId);
         $this->apiCall        = $apiCall;
     }
 

src/Synonyms.php

@@ -37,7 +37,7 @@ class Synonyms implements \ArrayAccess
      */
     public function __construct(string $collectionName, ApiCall $apiCall)
     {
-        $this->collectionName = $collectionName;
+        $this->collectionName = $collectionName; // already URI encoded in Collection construct
         $this->apiCall        = $apiCall;
     }
 
@@ -53,7 +53,7 @@ public function endPointPath(string $synonymId = ''): string
             Collections::RESOURCE_PATH,
             $this->collectionName,
             static::RESOURCE_PATH,
-            $synonymId
+            encodeURIComponent($synonymId)
         );
     }
 

src/utils/utils.php

@@ -0,0 +1,8 @@
+<?php
+
+// https://stackoverflow.com/a/1734255
+function encodeURIComponent($str)
+{
+    $revert = array('%21' => '!', '%2A' => '*', '%27' => "'", '%28' => '(', '%29' => ')');
+    return strtr(rawurlencode($str), $revert);
+}