feat: add todos for queryparams as a string

Author: pawelphilipczyk-cloudinary

__TESTS__/unit/url/url.test.ts

@@ -111,4 +111,6 @@ 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`);
   });
+
+  // TODO: Write test(s): Should include query params as a string
 });

src/assets/CloudinaryFile.ts

@@ -283,6 +283,11 @@ class CloudinaryFile {
         .replace(/\?/g, '%3F')
         .replace(/=/g, '%3D');
 
+      // TODO
+      // 1. First we have to check if `this.urlConfig.queryParams` is an object and therefore needs parsing
+      // 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

src/config/URLConfig.ts

@@ -13,6 +13,7 @@ class URLConfig extends Config implements IURLConfig {
   useRootPath?: boolean;
   secure?: boolean;
   forceVersion?: boolean;
+  // TODO: We need to change the type here to accept string
   queryParams?: Record<string, string | number | boolean>;
 
   /**
@@ -106,6 +107,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 {
     this.queryParams = params;
     return this;

src/config/interfaces/Config/IURLConfig.ts

@@ -13,6 +13,7 @@
  * @prop {boolean} [secure]
  * @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]
  * @example
  * import Cloudinary from '@cloudinary/url-gen';
@@ -98,6 +99,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>
 }