Feat: Add support for custom query parameters @W-13974911@

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
   linux-tests:
     strategy:
       matrix:
-        node: [10, 12, 14, 16]
+        node: [10, 12, 14, 16, 18, 20]
       fail-fast: false
     runs-on: ubuntu-latest
     steps:

README.md

@@ -8,7 +8,8 @@ The Salesforce Commerce SDK (Isomorphic) allows easy interaction with the B2C Co
 
 ### Requirements
 
-- Node `^12.x`, `^14.x`, or `^16.x`
+- Node `^12.x`, `^14.x`, `^16.x`, `^18.x` or `^20.x`
+
 
 ### Installation
 

src/test/parameters.test.ts

@@ -140,4 +140,40 @@ describe('Parameters', () => {
       new Error('Missing required path parameter: organizationId')
     );
   });
+
+  it('allow custom query params', async () => {
+    const customersClient = new ShopperCustomers({
+      parameters: {
+        // shortCode is a base URI parameter, not path/query, so it *must* be in the config
+        shortCode: SHORT_CODE,
+      },
+    });
+
+    const options = {
+      parameters: {
+        siteId: SITE_ID,
+        organizationId: ORGANIZATION_ID,
+        clientId: CLIENT_ID,
+        c_validCustomParam: 'custom_param',
+        invalidParam: 'invalid_param',
+      },
+      body: {type: 'guest'},
+    };
+
+    nock(`https://${SHORT_CODE}.api.commercecloud.salesforce.com`)
+      .post(
+        `/customer/shopper-customers/v1/organizations/${ORGANIZATION_ID}/customers/actions/login`
+      )
+      .query({
+        siteId: SITE_ID,
+        clientId: CLIENT_ID,
+        // expect `c_validCustomParam` but not `invalidParam`
+        c_validCustomParam: 'custom_param',
+      })
+      .reply(200, MOCK_RESPONSE);
+
+    const response = await customersClient.authorizeCustomer(options);
+
+    expect(response).toEqual(MOCK_RESPONSE);
+  });
 });

templates/operations.ts.hbs

@@ -33,7 +33,7 @@
           {{#each request.queryParameters}}
           {{{name}}}{{#if (not (is required "true"))}}?{{/if}}: {{{ getTypeFromParameter this}}}
           {{/each}}
-        }, ConfigParameters>,
+        } & { [key in `c_${string}`]: any }, ConfigParameters>,
         headers?: { [key: string]: string },
         {{#if (isRequestWithPayload request)}}
         body: {{{getPayloadTypeFromRequest request}}}
@@ -72,7 +72,7 @@
           {{#each request.queryParameters}}
           {{{name}}}{{#if (not (is required "true"))}}?{{/if}}: {{{ getTypeFromParameter this}}}
           {{/each}}
-        }, ConfigParameters>,
+        } & { [key in `c_${string}`]: any }, ConfigParameters>,
         headers?: { [key: string]: string },
         {{#if (isRequestWithPayload request)}}
         body: {{{getPayloadTypeFromRequest request}}}
@@ -113,7 +113,7 @@
           {{#each request.queryParameters}}
           {{{name}}}{{#if (not (is required "true"))}}?{{/if}}: {{{ getTypeFromParameter this}}}
           {{/each}}
-        }, ConfigParameters>,
+        } & { [key in `c_${string}`]: any }, ConfigParameters>,
         headers?: { [key: string]: string },
         {{#if (isRequestWithPayload request)}}
         body: {{{getPayloadTypeFromRequest request}}}
@@ -142,7 +142,7 @@
       {{/if}}
       {{/each}}
 
-      const queryParams: {{{@root.name.upperCamelCase}}}QueryParameters = {};
+      const queryParams: {{{@root.name.upperCamelCase}}}QueryParameters & { [key in `c_${string}`]: any } = {};
       {{#each request.queryParameters}}
       if (optionParams["{{{name}}}"] !== undefined) {
         queryParams["{{{name}}}"] = optionParams["{{{name}}}"];
@@ -156,6 +156,12 @@
       {{/if}}
       {{/each}}
 
+      Object.keys(optionParams).forEach((key) => {
+        if(key.startsWith('c_') && optionParams[key as keyof typeof optionParams] !== undefined) {
+          queryParams[key as keyof typeof queryParams] = optionParams[key as keyof typeof optionParams]
+        }
+      })
+
       const url = new TemplateURL(
         "{{{../path}}}",
         this.clientConfig.baseUri,