feat: allow passing string to query params.

Author: atdcloud

src/assets/CloudinaryFile.ts

@@ -288,15 +288,41 @@ class CloudinaryFile {
       // 2. If we got an object we have to check if URLSearchParams is available, and only then use it
       //    Beause we want to throw a meaningful Error in case it's not - we can wrap the below code in a try catch clause 
       // 3. If it already was a string then we can skip the parsing but still we need to assign it to `queryParamsString`
-      const queryParams = new URLSearchParams(this.urlConfig.queryParams as Record<string, string>);
-
-      // urlConfig.analytics is true by default, has to be explicitly set to false to overwrite
-      // Don't add analytics when publicId includes a '?' to not risk changing existing query params
-      if (this.urlConfig.analytics !== false && !(publicID.includes('?'))) {
-        queryParams.set("_a", getSDKAnalyticsSignature(trackedAnalytics));
-      }
+        //
+
+    const shouldAddAnalytics = this.urlConfig.analytics !== false && !(publicID.includes('?'));    
+
+    if (typeof(this.urlConfig.queryParams) === 'object'){ //#1
+
+        try { //#2
+          const queryParams = new URLSearchParams(this.urlConfig.queryParams as Record<string, string>);
+          // urlConfig.analytics is true by default, has to be explicitly set to false to overwrite
+          // Don't add analytics when publicId includes a '?' to not risk changing existing query params
+          
+          if (shouldAddAnalytics) {
+            queryParams.set("_a", getSDKAnalyticsSignature(trackedAnalytics));
+          }
+         
+          const queryParamsString = queryParams.toString();
+
+        } catch(){
+            //TODO: improve error message, consult with docs team.
+            throw "Error: URLSearchParams is not available."; //#2
+        }
+    } 
+    
+    //if (typeof(this.urlConfig.queryParams)  === 'string'){ //#3
+    else{ //#3
+       //assign to queryParamsString  
+        let queryParamsString = this.urlConfig.queryParams || '';
+        
+        if (shouldAddAnalytics) {
+            queryParams.set("_a", getSDKAnalyticsSignature(trackedAnalytics));
+            queryParamsString += (queryParamsString.length > 0 ? "&" :"") + "_a=" + getSDKAnalyticsSignature(trackedAnalytics);
+        }
+        
+    }
 
-      const queryParamsString = queryParams.toString();
       if (queryParamsString) {
         return `${safeURL}?${queryParamsString}`;
       } else {

src/config/.URLConfig.ts.swp

@@ -14,7 +14,7 @@ class URLConfig extends Config implements IURLConfig {
   secure?: boolean;
   forceVersion?: boolean;
   // TODO: We need to change the type here to accept string
-  queryParams?: Record<string, string | number | boolean>;
+  queryParams?: Record<string, string | number | boolean> | string;
 
   /**
    * @param {IURLConfig} userURLConfig
@@ -108,7 +108,7 @@ class URLConfig extends Config implements IURLConfig {
    * @param params Sets additional params
    */
   // TODO: We need to change the type here to accept string
-  setQueryParams(params: Record<string, string | number | boolean>):this {
+  setQueryParams(params: Record<string, string | number | boolean> | string):this {
     this.queryParams = params;
     return this;
   }

src/config/URLConfig.ts

@@ -14,7 +14,7 @@
  * @prop {boolean} [forceVersion]
  * @prop {boolean} [analytics]
  *   // TODO: This is just for generating docs - we need to change the type here to accept string
- * @prop {object} [queryParams]
+ * @prop {object|string} [queryParams]  
  * @example
  * import Cloudinary from '@cloudinary/url-gen';
  * // The Cloudinary Instance accepts a URLConfig under the `url` key
@@ -100,7 +100,7 @@ interface IURLConfig {
    * Additional params to be added to the URL
    */
   // TODO: We need to change the type here to accept string
-  queryParams?: Record<string, string | number | boolean>
+  queryParams?: Record<string, string | number | boolean> | string
 }
 
 export default IURLConfig;