fix: URI encode user-inputted string

src/Alias.php

@@ -41,7 +41,7 @@ public function __construct(string $name, ApiCall $apiCall)
      */
     public function endPointPath(): string
     {
-        return sprintf('%s/%s', Aliases::RESOURCE_PATH, $this->name);
+        return sprintf('%s/%s', Aliases::RESOURCE_PATH, encodeURIComponent($this->name));
     }
 
     /**

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

@@ -25,6 +25,6 @@ public function delete()
 
     private function endpointPath()
     {
-        return AnalyticsRules::RESOURCE_PATH . '/' . $this->ruleName;
+        return AnalyticsRules::RESOURCE_PATH . '/' . encodeURIComponent($this->ruleName);
     }
 }

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

@@ -64,7 +64,7 @@ public function __construct(string $name, ApiCall $apiCall)
      */
     public function endPointPath(): string
     {
-        return sprintf('%s/%s', Collections::RESOURCE_PATH, $this->name);
+        return sprintf('%s/%s', Collections::RESOURCE_PATH, encodeURIComponent($this->name));
     }
 
     /**

src/Conversation.php

@@ -68,6 +68,6 @@ public function delete(): array
      */
     public function endPointPath(): string
     {
-        return sprintf('%s/%s', Conversations::RESOURCE_PATH, $this->id);
+        return sprintf('%s/%s', Conversations::RESOURCE_PATH, encodeURIComponent($this->id));
     }
 }

src/ConversationModel.php

@@ -68,6 +68,6 @@ public function delete(): array
      */
     public function endPointPath(): string
     {
-        return sprintf('%s/%s', ConversationModels::RESOURCE_PATH, $this->id);
+        return sprintf('%s/%s', ConversationModels::RESOURCE_PATH, encodeURIComponent($this->id));
     }
 }

src/Document.php

@@ -51,9 +51,9 @@ private function endpointPath(): string
         return sprintf(
             '%s/%s/%s/%s',
             Collections::RESOURCE_PATH,
-            $this->collectionName,
+            encodeURIComponent($this->collectionName),
             Documents::RESOURCE_PATH,
-            $this->documentId
+            encodeURIComponent($this->documentId)
         );
     }
 

src/Documents.php

@@ -53,7 +53,7 @@ private function endPointPath(string $action = ''): string
         return sprintf(
             '%s/%s/%s/%s',
             Collections::RESOURCE_PATH,
-            $this->collectionName,
+            encodeURIComponent($this->collectionName),
             static::RESOURCE_PATH,
             $action
         );
@@ -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

@@ -41,7 +41,7 @@ public function __construct(string $keyId, ApiCall $apiCall)
      */
     private function endpointPath(): string
     {
-        return sprintf('%s/%s', Keys::RESOURCE_PATH, $this->keyId);
+        return sprintf('%s/%s', Keys::RESOURCE_PATH, encodeURIComponent($this->keyId));
     }
 
     /**

src/Override.php

@@ -51,9 +51,9 @@ private function endPointPath(): string
         return sprintf(
             '%s/%s/%s/%s',
             Collections::RESOURCE_PATH,
-            $this->collectionName,
+            encodeURIComponent($this->collectionName),
             Overrides::RESOURCE_PATH,
-            $this->overrideId
+            encodeURIComponent($this->overrideId)
         );
     }
 

src/Overrides.php

@@ -53,9 +53,9 @@ public function endPointPath(string $overrideId = ''): string
         return sprintf(
             '%s/%s/%s/%s',
             Collections::RESOURCE_PATH,
-            $this->collectionName,
+            encodeURIComponent($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

@@ -49,9 +49,9 @@ private function endPointPath(): string
         return sprintf(
             '%s/%s/%s/%s',
             Collections::RESOURCE_PATH,
-            $this->collectionName,
+            encodeURIComponent($this->collectionName),
             synonyms::RESOURCE_PATH,
-            $this->synonymId
+            encodeURIComponent($this->synonymId)
         );
     }
 

src/Synonyms.php

@@ -51,9 +51,9 @@ public function endPointPath(string $synonymId = ''): string
         return sprintf(
             '%s/%s/%s/%s',
             Collections::RESOURCE_PATH,
-            $this->collectionName,
+            encodeURIComponent($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);
+}

tests/Feature/AliasesTest.php

@@ -36,6 +36,15 @@ public function testCanUpsertAnAlias(): void
         $this->assertEquals($this->sampleAliasResponse, $this->upsertResponse);
     }
 
+    public function testCanUpsertAnAliasUrlEncodedName(): void
+    {
+        $aliasedCollection = [
+            'collection_name' => 'companies_june11'
+        ];
+        $res = $this->client()->aliases->upsert("abc123?=+/~-_- &| test'", $aliasedCollection);
+        $this->assertEquals(["name"=>"abc123?=+/~-_- &| test'", ...$aliasedCollection], $res);
+    }
+
     public function testCanRetrieveAlias(): void
     {
         $response = $this->client()->aliases['companies']->retrieve();