Merge pull request #577 from cloudinary/queryparams-string-value

Queryparams string value

Author: pawelphilipczyk-cloudinary

__TESTS__/unit/url/url.test.ts

@@ -101,6 +101,12 @@ describe('Tests for URL configuration', () => {
     expect(url).toEqual(`https://res.cloudinary.com/demo/image/upload/sample?_i=abcde&_z=1234&_t=false`);
   });
 
+  it('Should include query params when passed as a string', function () {
+    const image = createNewImage('sample', {cloudName: 'demo'}, {queryParams: '_i=abcde&_z=1234&_t=false'});
+    const url = image.toURL();
+    expect(url).toEqual(`https://res.cloudinary.com/demo/image/upload/sample?_i=abcde&_z=1234&_t=false`);
+  });
+
   it('Should include query params with analytics', function () {
     const image = createNewImage('sample', {cloudName: 'demo'}, {analytics: true, queryParams: {"_i": "abcde"}});
     const analyticsOptions = {
@@ -111,4 +117,16 @@ describe('Tests for URL configuration', () => {
     const url = image.toURL({trackedAnalytics: analyticsOptions});
     expect(url).toEqual(`https://res.cloudinary.com/demo/image/upload/sample?_i=abcde&_a=BATAABAQ0`);
   });
+
+  it('Should include query params with analytics when passed as a string', function () {
+    const image = createNewImage('sample', {cloudName: 'demo'}, {analytics: true, queryParams: '_i=abcde&_z=1234&_t=false'});
+    const analyticsOptions = {
+      techVersion: '16.0.0',
+      sdkCode: 'T',
+      sdkSemver: '1.0.0'
+    };
+    const url = image.toURL({trackedAnalytics: analyticsOptions});
+    expect(url).toEqual(`https://res.cloudinary.com/demo/image/upload/sample?_i=abcde&_z=1234&_t=false&_a=BATAABAQ0`);
+  });
+
 });

src/assets/CloudinaryFile.ts

@@ -291,15 +291,33 @@ class CloudinaryFile {
           .replace(/\?/g, '%3F')
           .replace(/=/g, '%3D');
 
-      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('?'));    
+
+      let queryParamsString = '';
+
+      if (typeof(this.urlConfig.queryParams) === 'object') { 
+
+        try { 
+          const queryParams = new URLSearchParams(this.urlConfig.queryParams as Record<string, string>);
+          
+          if (shouldAddAnalytics) {
+            queryParams.set("_a", getSDKAnalyticsSignature(trackedAnalytics));
+          }
+         
+          queryParamsString = queryParams.toString();
+
+        } catch(err) {
+          console.error('Error: URLSearchParams is not available so the queryParams object cannot be parsed, please try passing as an already parsed string');
+        }
+      } else { 
+        queryParamsString = this.urlConfig.queryParams || '';
+        
+        if (shouldAddAnalytics) {
+          queryParamsString += `${(queryParamsString.length > 0 ? '&' : '')}_a=${getSDKAnalyticsSignature(trackedAnalytics)}`;
+        }
       }
 
-      const queryParamsString = queryParams.toString();
       if (queryParamsString) {
         return `${safeURL}?${queryParamsString}`;
       } else {

src/config/URLConfig.ts

@@ -13,7 +13,7 @@ class URLConfig extends Config implements IURLConfig {
   useRootPath?: boolean;
   secure?: boolean;
   forceVersion?: boolean;
-  queryParams?: Record<string, string | number | boolean>;
+  queryParams?: Record<string, string | number | boolean> | string;
 
   /**
    * @param {IURLConfig} userURLConfig
@@ -106,7 +106,7 @@ class URLConfig extends Config implements IURLConfig {
   /**
    * @param params Sets additional params
    */
-  setQueryParams(params: Record<string, string | number | boolean>):this {
+  setQueryParams(params: Record<string, string | number | boolean> | string):this {
     this.queryParams = params;
     return this;
   }

src/config/interfaces/Config/IURLConfig.ts

@@ -13,7 +13,7 @@
  * @prop {boolean} [secure]
  * @prop {boolean} [forceVersion]
  * @prop {boolean} [analytics]
- * @prop {object} [queryParams]
+ * @prop {object|string} [queryParams]  
  * @example
  * import Cloudinary from '@cloudinary/url-gen';
  * // The Cloudinary Instance accepts a URLConfig under the `url` key
@@ -98,7 +98,7 @@ interface IURLConfig {
   /**
    * Additional params to be added to the URL
    */
-  queryParams?: Record<string, string | number | boolean>
+  queryParams?: Record<string, string | number | boolean> | string
 }
 
 export default IURLConfig;