fix(Transaction): Fixed an issue related to query params with special characters (#42)

Author: vijayasingam-paddle

CHANGELOG.md

@@ -12,6 +12,15 @@ When we make [non-breaking changes](https://developer.paddle.com/api-reference/a
 
 This means when upgrading minor versions of the SDK, you may notice type errors. You can safely ignore these or fix by adding additional type guards.
 
+## 1.5.1 - 2024-09-10
+
+### Fixed
+
+- Fixed a bug where query parameters with special characters were not passed correctly to the API.
+- Dependabot security updates.
+
+---
+
 ## 1.5.0 - 2024-08-16
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "A Node.js SDK that you can use to integrate Paddle Billing with applications written in server-side JavaScript.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",

src/__tests__/resources/transactions.test.ts

@@ -50,12 +50,15 @@ describe('TransactionsResource', () => {
     const queryParams: ListTransactionQueryParameters = {
       after: '2',
       id: ['1234'],
+      'createdAt[GTE]': '2024-09-10T15:38:35.675098Z',
     };
 
     const transactionCollection = transactionsResource.list(queryParams);
     let transactions = await transactionCollection.next();
 
-    expect(paddleInstance.get).toBeCalledWith('/transactions?after=2&id=1234');
+    expect(paddleInstance.get).toBeCalledWith(
+      '/transactions?after=2&id=1234&created_at%5BGTE%5D=2024-09-10T15%3A38%3A35.675098Z',
+    );
     expect(transactions.length).toBe(1);
   });
 

src/internal/base/query-parameters.ts

@@ -1,4 +1,11 @@
-import snakeCase from 'lodash/snakeCase';
+/** We cannot use lodash to convert camelCase to snake_case because it will remove special characters and convert all text to lowercase.
+ * We have date fields in the format `updatedAt[GTE]` and we need to convert them to `updated_at[GTE]`.
+ */
+function convertCamelCaseToSnakeCase(input: string) {
+  return input.replace(/\b(\w+)([A-Z][a-z])/g, (_match: string, p1, p2) => {
+    return p1.replace(/([a-z])([A-Z])/g, '$1_$2').toLowerCase() + '_' + p2.toLowerCase();
+  });
+}
 
 export class QueryParameters<T> {
   constructor(private readonly queryParameters: T) {}
@@ -7,7 +14,7 @@ export class QueryParameters<T> {
     for (const key in this.queryParameters) {
       const value = this.queryParameters[key];
       if (key && value) {
-        urlSearchParam.append(snakeCase(key), `${value}`);
+        urlSearchParam.append(convertCamelCaseToSnakeCase(key), `${value}`);
       }
     }
     return '?' + urlSearchParam.toString();