fix: support false value in query parameters. (#999)

.changeset/old-spoons-buy.md

@@ -0,0 +1,5 @@
+---
+'@moralisweb3/api-utils': patch
+---
+
+The `OperationRequestBuilder` does not skip the `false` value anymore for URL parameters.

packages/apiUtils/src/resolvers2/OperationRequestBuilder.test.ts

@@ -6,6 +6,7 @@ export interface TestRequest {
   userId: number;
   traceId: number;
   password: string;
+  flag: boolean;
 }
 
 const operation: Operation<TestRequest, unknown, unknown, unknown> = {
@@ -14,7 +15,7 @@ const operation: Operation<TestRequest, unknown, unknown, unknown> = {
   groupName: 'test',
   method: 'POST',
   urlPathParamNames: ['userId'],
-  urlSearchParamNames: ['traceId'],
+  urlSearchParamNames: ['traceId', 'flag'],
   urlPathPattern: '/api/{userId}',
   bodyParamNames: ['password'],
   bodyType: 'properties',
@@ -23,6 +24,7 @@ const operation: Operation<TestRequest, unknown, unknown, unknown> = {
       userId: String(request.userId),
       trace_id: String(request.traceId),
       extraSearchParam: '100',
+      flag: request.flag,
     };
   },
   getRequestBody: (request) => {
@@ -61,12 +63,25 @@ describe('OperationRequestBuilder', () => {
         userId: 100,
         traceId: 200,
         password: 'foo',
+        flag: true,
       });
 
       expect(url).toBe('https://localhost/api/100');
-      expect(Object.keys(urlSearchParams).length).toBe(2);
+      expect(Object.keys(urlSearchParams).length).toBe(3);
       expect(urlSearchParams['trace_id']).toBe('200');
       expect(urlSearchParams['extraSearchParam']).toBe('100');
+      expect(urlSearchParams['flag']).toBe(true);
+    });
+
+    it('keeps false value', () => {
+      const { urlSearchParams } = builder.prepareUrl('https://localhost', {
+        userId: 1,
+        traceId: 1,
+        password: '1',
+        flag: false,
+      });
+
+      expect(urlSearchParams['flag']).toBe(false);
     });
   });
 
@@ -76,6 +91,7 @@ describe('OperationRequestBuilder', () => {
         userId: 100,
         traceId: 200,
         password: 'foo',
+        flag: true,
       }) as OperationRequestPropertiesBody;
 
       expect(Object.keys(body).length).toBe(2);

packages/apiUtils/src/resolvers2/OperationRequestBuilder.ts

@@ -23,7 +23,7 @@ export class OperationRequestBuilder<Request> {
 
     for (const paramName of this.operation.urlPathParamNames ?? []) {
       const paramValue = urlParams[paramName as string];
-      if (!paramValue) {
+      if (paramValue === undefined || paramValue === null) {
         throw new Error(`Param ${paramName as string} is required`);
       }
       urlPath = urlPath.replace(`{${paramName as string}}`, paramValue as string);
@@ -35,7 +35,7 @@ export class OperationRequestBuilder<Request> {
       .filter((paramName) => !this.operation.urlPathParamNames?.includes(paramName as keyof Request))
       .forEach((paramName) => {
         const paramValue = urlParams[paramName];
-        if (paramValue) {
+        if (paramValue !== undefined && paramValue !== null) {
           urlSearchParams[paramName] = paramValue;
         }
       });

packages/evmApi/integration/mocks/endpoints/getContractNFTs.ts

@@ -8,12 +8,14 @@ export const mockGetContractNFTs = MockScenarios.create(
     url: `/nft/:address`,
     getParams: ({ req }) => ({
       address: req.params.address,
+      disable_total: req.url.searchParams.get('disable_total'),
     }),
   },
   [
     {
       condition: {
         address: '0x75e3e9c92162e62000425c98769965a76c2e387a',
+        disable_total: 'false',
       },
       response: {
         status: 'SYNCING',
@@ -63,6 +65,7 @@ export const mockGetContractNFTs = MockScenarios.create(
     {
       condition: {
         address: '0x75e3e9c92162e62000425c98769965a76c2e387',
+        disable_total: 'true',
       },
       responseStatus: 400,
       response: createErrorResponse('[C0005] Invalid address provided'),

packages/evmApi/integration/test/getContractNFTs.test.ts

@@ -16,6 +16,7 @@ describe('getContractNFTs', () => {
     it('should get NFTs for a given contract address', async () => {
       const result = await EvmApi.nft.getContractNFTs({
         address: '0x75e3e9c92162e62000425c98769965a76c2e387a',
+        disableTotal: false,
       });
 
       const response = result.raw.result?.at(0);
@@ -33,6 +34,7 @@ describe('getContractNFTs', () => {
       const failedResult = await EvmApi.nft
         .getContractNFTs({
           address: '0x75e3e9c92162e62000425c98769965a76c2e387a',
+          disableTotal: true,
         })
         .then()
         .catch((err) => {