Allow custom paramsSerializer to be able to implement React Native …

…workaround axios/axios#6102 (comment) #193 (comment)
typesense · May 24, 2024 · 9f976f1 · 9f976f1
1 parent 287b1d0
commit 9f976f1
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 21 deletions.
diff --git a/dist/typesense.js b/dist/typesense.js
diff --git a/dist/typesense.js.map b/dist/typesense.js.map
diff --git a/dist/typesense.min.js b/dist/typesense.min.js
diff --git a/dist/typesense.min.js.map b/dist/typesense.min.js.map
diff --git a/lib/Typesense/ApiCall.js b/lib/Typesense/ApiCall.js
diff --git a/lib/Typesense/ApiCall.js.map b/lib/Typesense/ApiCall.js.map
diff --git a/lib/Typesense/Configuration.d.ts b/lib/Typesense/Configuration.d.ts
@@ -67,6 +67,14 @@ export interface ConfigurationOptions {
      * @type {HTTPSAgent}
      */
     httpsAgent?: HTTPSAgent;
+    /**
+     * Set a custom paramsSerializer
+     *
+     * See axios documentation for more information on how to use this parameter: https://axios-http.com/docs/req_config
+     *  This is helpful for handling React Native issues like this: https://github.com/axios/axios/issues/6102#issuecomment-2085301397
+     * @type {any}
+     */
+    paramsSerializer?: any;
 }
 export default class Configuration {
     readonly nodes: NodeConfiguration[] | NodeConfigurationWithHostname[] | NodeConfigurationWithUrl[];
@@ -84,6 +92,7 @@ export default class Configuration {
     readonly additionalHeaders?: Record<string, string>;
     readonly httpAgent?: HTTPAgent;
     readonly httpsAgent?: HTTPSAgent;
+    readonly paramsSerializer?: any;
     constructor(options: ConfigurationOptions);
     validate(): boolean;
     private validateNodes;

diff --git a/lib/Typesense/Configuration.js b/lib/Typesense/Configuration.js
diff --git a/lib/Typesense/Configuration.js.map b/lib/Typesense/Configuration.js.map
diff --git a/src/Typesense/ApiCall.ts b/src/Typesense/ApiCall.ts
@@ -233,6 +233,13 @@ export default class ApiCall {
           requestOptions.httpsAgent = new HTTPSAgent({ keepAlive: true });
         }
 
+        if (this.configuration.paramsSerializer) {
+          this.logger.debug(
+            `Request #${requestNumber}: Using custom paramsSerializer`,
+          );
+          requestOptions.paramsSerializer = this.configuration.paramsSerializer;
+        }
+
         if (
           bodyParameters &&
           ((typeof bodyParameters === "string" &&

diff --git a/src/Typesense/Configuration.ts b/src/Typesense/Configuration.ts
@@ -86,6 +86,15 @@ export interface ConfigurationOptions {
    * @type {HTTPSAgent}
    */
   httpsAgent?: HTTPSAgent;
+
+  /**
+   * Set a custom paramsSerializer
+   *
+   * See axios documentation for more information on how to use this parameter: https://axios-http.com/docs/req_config
+   *  This is helpful for handling React Native issues like this: https://github.com/axios/axios/issues/6102#issuecomment-2085301397
+   * @type {any}
+   */
+  paramsSerializer?: any;
 }
 
 export default class Configuration {
@@ -110,6 +119,7 @@ export default class Configuration {
   readonly additionalHeaders?: Record<string, string>;
   readonly httpAgent?: HTTPAgent;
   readonly httpsAgent?: HTTPSAgent;
+  readonly paramsSerializer?: any;
 
   constructor(options: ConfigurationOptions) {
     this.nodes = options.nodes || [];
@@ -155,6 +165,8 @@ export default class Configuration {
     this.httpAgent = options.httpAgent;
     this.httpsAgent = options.httpsAgent;
 
+    this.paramsSerializer = options.paramsSerializer;
+
     this.showDeprecationWarnings(options);
     this.validate();
   }