fix: fixed url encode issue for special symbols

Author: sunil-lakshman

.talismanrc

@@ -3,7 +3,7 @@ fileignoreconfig:
   ignore_detectors:
     - filecontent
 - filename: package-lock.json
-  checksum: 3f095735d07bd662952f037664e7ac61ce7841b5940ab16af4a3ef4ad9076d13
+  checksum: 4a47373a7a9548e1feb6cd50157f7dae495066fc959908d79b961be7da32cf42
 - filename: .husky/pre-commit
   checksum: 5baabd7d2c391648163f9371f0e5e9484f8fb90fa2284cfc378732ec3192c193
 - filename: test/request.spec.ts

CHANGELOG.md

@@ -1,14 +1,12 @@
 ## Change log
 
-### Version: 1.3.8
-#### Date: Jan-12-2026
- - Fix: Add .js extensions to relative imports in ESM build for proper module resolution
- - Fix: Change lodash import from named import to default import for ESM compatibility with CommonJS modules
-
-### Version: 1.3.7
-#### Date: Jan-12-2026
- - Fix: Improve error messages
+### Version: 1.3.10
+#### Date: Feb-13-2026
+ - Fix: fix url encode for special symbols.
 
+### Version: 1.3.9
+#### Date: Jan-28-2026
+ - Fix: Resolve lodash dependency snyk issue
 
 ### Version: 1.3.8
 #### Date: Jan-15-2026

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/core",
-  "version": "1.3.9",
+  "version": "1.3.10",
   "type": "commonjs",
   "main": "./dist/cjs/src/index.js",
   "types": "./dist/cjs/src/index.d.ts",
@@ -33,7 +33,7 @@
     "husky-check": "npx husky install && chmod +x .husky/pre-commit"
   },
   "dependencies": {
-    "axios": "^1.13.4",
+    "axios": "^1.13.5",
     "axios-mock-adapter": "^2.1.0",
     "lodash": "^4.17.23",
     "qs": "6.14.1",

package.json

@@ -5,7 +5,7 @@ export function serialize(params: Record<string, any>) {
   delete params.query;
   let qs = Qs.stringify(params, { arrayFormat: 'brackets' });
   if (query) {
-    qs = qs + `&query=${encodeURI(JSON.stringify(query))}`;
+    qs = qs + `&query=${encodeURIComponent(JSON.stringify(query))}`;
   }
   params.query = query;
 

src/lib/param-serializer.ts

@@ -3,26 +3,19 @@ import { serialize } from './param-serializer';
 import { APIError } from './api-error';
 import { ERROR_MESSAGES } from './error-messages';
 
-/**
- * Handles array parameters properly with & separators
- * React Native compatible implementation without URLSearchParams.set()
- */
-function serializeParams(params: any): string {
-  if (!params) return '';
-
-  return serialize(params);
-}
-
 /**
  * Builds the full URL with query parameters
+ * Used only for long URLs that need to be passed directly to axios
  */
-function buildFullUrl(baseURL: string | undefined, url: string, queryString: string): string {
+function buildFullUrl(baseURL: string | undefined, url: string, params: any): string {
+  const queryString = params ? serialize(params) : '';
+  
   if (url.startsWith('http://') || url.startsWith('https://')) {
-    return `${url}?${queryString}`;
+    return queryString ? `${url}?${queryString}` : url;
   }
   const base = baseURL || '';
 
-  return `${base}${url}?${queryString}`;
+  return queryString ? `${base}${url}?${queryString}` : `${base}${url}`;
 }
 
 /**
@@ -58,7 +51,7 @@ async function makeRequest(
   // Determine URL length threshold based on whether it's a preview endpoint
   // rest-preview.contentstack.com has stricter limits, so use lower threshold
   const isPreview = isPreviewEndpoint(actualFullUrl);
-  const urlLengthThreshold = isPreview ? 1500 : 2000;
+  const urlLengthThreshold = isPreview ? 1500 : 8000; // Increased from 2000 to 8000
 
   // If URL is too long, use direct axios request with full URL
   if (actualFullUrl.length > urlLengthThreshold) {
@@ -117,8 +110,9 @@ export async function getData(instance: AxiosInstance, url: string, data?: any)
       maxContentLength: Infinity,
       maxBodyLength: Infinity,
     };
-    const queryString = serializeParams(requestConfig.params);
-    const actualFullUrl = buildFullUrl(instance.defaults.baseURL, url, queryString);
+    
+    // Build full URL with serialized params (only used for long URLs)
+    const actualFullUrl = buildFullUrl(instance.defaults.baseURL, url, requestConfig.params);
     const response = await makeRequest(instance, url, requestConfig, actualFullUrl);
 
     if (response?.data) {

src/lib/request.ts

@@ -21,15 +21,29 @@ describe('serialize', () => {
 
   it('should return query with encode string when passed query param', (done) => {
     const param = serialize({ query: { title: { $in: ['welcome', 'hello'] } } });
-    expect(param).toEqual('&query=%7B%22title%22:%7B%22$in%22:%5B%22welcome%22,%22hello%22%5D%7D%7D');
+    expect(param).toEqual('&query=%7B%22title%22%3A%7B%22%24in%22%3A%5B%22welcome%22%2C%22hello%22%5D%7D%7D');
     done();
   });
 
   it('should return brackets and query with encoded string when passed query param and array value', (done) => {
     const param = serialize({ include: ['reference'], query: { title: { $in: ['welcome', 'hello'] } } });
     expect(param).toEqual(
-      'include%5B%5D=reference&query=%7B%22title%22:%7B%22$in%22:%5B%22welcome%22,%22hello%22%5D%7D%7D'
+      'include%5B%5D=reference&query=%7B%22title%22%3A%7B%22%24in%22%3A%5B%22welcome%22%2C%22hello%22%5D%7D%7D'
     );
     done();
   });
+
+  it('should properly encode special characters like ampersand in query values', (done) => {
+    const param = serialize({ query: { url: '/imaging-&-automation' } });
+    // The & should be encoded as %26
+    expect(param).toEqual('&query=%7B%22url%22%3A%22%2Fimaging-%26-automation%22%7D');
+    done();
+  });
+
+  it('should properly encode other URL-special characters in query values', (done) => {
+    const param = serialize({ query: { title: 'test=value&foo=bar?baz' } });
+    // =, &, and ? should all be encoded
+    expect(param).toEqual('&query=%7B%22title%22%3A%22test%3Dvalue%26foo%3Dbar%3Fbaz%22%7D');
+    done();
+  });
 });

test/param-serializer.spec.ts

@@ -346,15 +346,15 @@ describe('Request tests', () => {
     expect(result).toEqual(mockResponse);
   });
 
-  it('should use instance.request when URL length exceeds 2000 characters', async () => {
+  it('should use instance.request when URL length exceeds 8000 characters', async () => {
     const client = httpClient({ defaultHostname: 'example.com' });
     const url = '/your-api-endpoint';
     const mockResponse = { data: 'mocked' };
 
-    // Create a very long query parameter that will exceed 2000 characters when combined with baseURL
+    // Create a very long query parameter that will exceed 8000 characters when combined with baseURL
     // baseURL is typically like 'https://example.com:443/v3' (~30 chars), url is '/your-api-endpoint' (~20 chars)
-    // So we need params that serialize to >1950 chars to exceed 2000 total
-    const longParam = 'x'.repeat(2000);
+    // So we need params that serialize to >7950 chars to exceed 8000 total
+    const longParam = 'x'.repeat(8000);
     const requestData = { params: { longParam, param2: 'y'.repeat(500) } };
 
     // Mock instance.request since that's what gets called for long URLs
@@ -498,15 +498,15 @@ describe('Request tests', () => {
       expect(mock.history.get[0].url).toBe(absoluteUrl);
     });
 
-    it('should handle absolute URL when actualFullUrl exceeds 2000 characters', async () => {
+    it('should handle absolute URL when actualFullUrl exceeds 8000 characters', async () => {
       const client = httpClient({
         defaultHostname: 'example.com',
       });
       const absoluteUrl = 'https://external-api.com/api/endpoint';
       const mockResponse = { data: 'mocked' };
 
-      // Create a very long query parameter that will exceed 2000 characters
-      const longParam = 'x'.repeat(2000);
+      // Create a very long query parameter that will exceed 8000 characters
+      const longParam = 'x'.repeat(8000);
       const requestData = { params: { longParam, param2: 'y'.repeat(500) } };
 
       // Mock instance.request since that's what gets called for long URLs
@@ -542,8 +542,8 @@ describe('Request tests', () => {
       const absoluteUrl = 'https://external-api.com/api/endpoint';
       const mockResponse = { data: 'mocked' };
 
-      // Create params that will make URL exceed 2000 characters
-      const longParam = 'x'.repeat(2000);
+      // Create params that will make URL exceed 8000 characters
+      const longParam = 'x'.repeat(8000);
       const requestData = { params: { longParam, param2: 'y'.repeat(500) } };
 
       // Mock instance.request since URL will exceed threshold
@@ -576,7 +576,7 @@ describe('Request tests', () => {
       };
 
       // Create include[] parameters that would exceed 1500 chars for Live Preview
-      // but would be under 2000 chars for regular requests
+      // but would be under 8000 chars for regular requests
       const manyIncludes = Array.from({ length: 100 }, (_, i) => `ref_field_${i}_with_long_name`);
       const requestData = { params: { 'include[]': manyIncludes } };
 
@@ -622,16 +622,16 @@ describe('Request tests', () => {
       expect(mock.history.get.length).toBe(1);
     });
 
-    it('should use instance.request for regular URLs exceeding 2000 characters', async () => {
+    it('should use instance.request for regular URLs exceeding 8000 characters', async () => {
       const client = httpClient({ defaultHostname: 'example.com' });
       const url = '/content_types/blog/entries/entry123';
       const mockResponse = { entry: { uid: 'entry123', title: 'Test' } };
 
-      // Create many include[] parameters that will exceed 2000 characters
-      const manyIncludes = Array.from({ length: 200 }, (_, i) => `ref_field_${i}_with_very_long_name_to_make_url_long`);
+      // Create many include[] parameters that will exceed 8000 characters
+      const manyIncludes = Array.from({ length: 500 }, (_, i) => `ref_field_${i}_with_very_long_name_to_make_url_long`);
       const requestData = { params: { 'include[]': manyIncludes } };
 
-      // Mock instance.request since URL will exceed 2000 chars
+      // Mock instance.request since URL will exceed 8000 chars
       const requestSpy = jest.spyOn(client, 'request').mockResolvedValue({ data: mockResponse } as any);
 
       const result = await getData(client, url, requestData);