rename to queryParams

Author: lbendavid-cloudinary

__TESTS__/unit/url/url.test.ts

@@ -96,13 +96,13 @@ describe('Tests for URL configuration', () => {
   });
 
   it('Should include query params', function () {
-    const image = createNewImage('sample', {cloudName: 'demo'}, {urlSearchParams: {"_i": "abcde", "_z": 1234, "_t": false}});
+    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, urlSearchParams: {"_i": "abcde"}});
+    const image = createNewImage('sample', {cloudName: 'demo'}, {analytics: true, queryParams: {"_i": "abcde"}});
     const url = image.toURL();
     expect(url).toEqual(`https://res.cloudinary.com/demo/image/upload/sample?_i=abcde&_a=E`);
   });

__TESTS__/unit/urlConfig.test.ts

@@ -158,7 +158,7 @@ describe('It tests a combination of Cloudinary URL and Configuration', () => {
       .setShorten(true)
       .setSignUrl(true)
       .setUseRootPath(true)
-      .setUrlSearchParams({foo: 'bar', baz: 111, dummy: true});
+      .setQueryParams({foo: 'bar', baz: 111, dummy: true});
 
     expect(conf.cname).toBe('foo');
     expect(conf.forceVersion).toBe(true);
@@ -168,6 +168,6 @@ describe('It tests a combination of Cloudinary URL and Configuration', () => {
     expect(conf.shorten).toBe(true);
     expect(conf.signUrl).toBe(true);
     expect(conf.useRootPath).toBe(true);
-    expect(conf.urlSearchParams).toEqual({foo: 'bar', baz: 111, dummy: true});
+    expect(conf.queryParams).toEqual({foo: 'bar', baz: 111, dummy: true});
   });
 });

src/assets/CloudinaryFile.ts

@@ -283,17 +283,17 @@ class CloudinaryFile {
         .replace(/\?/g, '%3F')
         .replace(/=/g, '%3D');
 
-      const urlSearchParams = new URLSearchParams(this.urlConfig.urlSearchParams as Record<string, string>);
+      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('?'))) {
-        urlSearchParams.set("_a", getSDKAnalyticsSignature(trackedAnalytics));
+        queryParams.set("_a", getSDKAnalyticsSignature(trackedAnalytics));
       }
 
-      const searchParams = urlSearchParams.toString();
-      if (searchParams) {
-        return `${safeURL}?${searchParams}`;
+      const queryParamsString = queryParams.toString();
+      if (queryParamsString) {
+        return `${safeURL}?${queryParamsString}`;
       } else {
         return safeURL;
       }

src/config/URLConfig.ts

@@ -13,7 +13,7 @@ class URLConfig extends Config implements IURLConfig {
   useRootPath?: boolean;
   secure?: boolean;
   forceVersion?: boolean;
-  urlSearchParams?: Record<string, string | number | boolean>;
+  queryParams?: Record<string, string | number | boolean>;
 
   /**
    * @param {IURLConfig} userURLConfig
@@ -106,8 +106,8 @@ class URLConfig extends Config implements IURLConfig {
   /**
    * @param params Sets additional params
    */
-  setUrlSearchParams(params: Record<string, string | number | boolean>):this {
-    this.urlSearchParams = params;
+  setQueryParams(params: Record<string, string | number | boolean>):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} [urlSearchParams]
+ * @prop {object} [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
    */
-  urlSearchParams?: Record<string, string | number | boolean>
+  queryParams?: Record<string, string | number | boolean>
 }
 
 export default IURLConfig;

src/internal/internalConstants.ts

@@ -17,7 +17,7 @@ export const ALLOWED_URL_CONFIG = [
   'secure',
   'forceVersion',
   'analytics',
-  'urlSearchParams'
+  'queryParams'
 ];
 
 /**