Export parameter keys (@W-15676813@)

package.json

@@ -177,11 +177,11 @@
   "bundlesize": [
     {
       "path": "lib/**/*.js",
-      "maxSize": "46 kB"
+      "maxSize": "48 kB"
     },
     {
       "path": "commerce-sdk-isomorphic-with-deps.tgz",
-      "maxSize": "400 kB"
+      "maxSize": "410 kB"
     }
   ],
   "proxy": "https://SHORTCODE.api.commercecloud.salesforce.com"

scripts/utils.ts

@@ -46,6 +46,10 @@
     'operationsPartial',
     path.join(TEMPLATE_DIRECTORY, 'operations.ts.hbs')
   );
+  registerPartial(
+    'paramKeysPartial',
+    path.join(TEMPLATE_DIRECTORY, 'paramKeys.ts.hbs')
+  );
 }
 
 function addTemplates(apis: ApiMetadata, outputBasePath: string): ApiMetadata {
@@ -136,7 +140,7 @@
   deployment: RegExp,
   rootPath: string
 ): Promise<void> {
   console.warn('updateApis is deprecated. Use downloadLatestApis instead.');
 
   const matchedApis = await download.search(`"${name}"`, deployment);
   if (!(matchedApis?.length > 0)) {

src/test/parameters.test.ts

@@ -25,6 +25,13 @@ describe('Parameters', () => {
       .reply(200, MOCK_RESPONSE)
   );
 
+  it('has a list of parameter keys (and the required ones)', () => {
+    // eslint-disable-next-line
+    expect(ShopperSearch.paramKeys?.productSearch).toBeDefined();
+    // eslint-disable-next-line
+    expect(ShopperSearch.paramKeys?.productSearchRequired).toBeDefined();
+  });
+
   it('can all be specified in config (no method parameters object)', async () => {
     const searchClient = new ShopperSearch({
       parameters: {

templates/client.ts.hbs

@@ -80,13 +80,12 @@ export type {{name.upperCamelCase}}Parameters = {{name.upperCamelCase}}PathParam
 *
 * <span style="font-size:.7em; display:block; text-align: right">
 * API Version: {{metadata.version}}<br />
-* Last Updated: {{metadata.updatedDate}}<br />  
+* Last Updated: {{metadata.updatedDate}}<br />
 * </span>
-{{#if (eq (lowercase metadata.categories.[CC Version Status].[0]) "beta")}}
-* @beta 
+* {{#if (eq (lowercase metadata.categories.[CC Version Status].[0]) "beta")}}
+* @beta
 * {{/if}}
-* 
-
+*
 */
 export class {{name.upperCamelCase}}<ConfigParameters extends {{{name.upperCamelCase}}}Parameters & Record<string, unknown>> {
   // baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
@@ -101,6 +100,6 @@ export class {{name.upperCamelCase}}<ConfigParameters extends {{{name.upperCamel
     this.clientConfig = new ClientConfig(cfg) as ClientConfig<ConfigParameters> & { baseUri: string };
   }
 
+  {{> paramKeysPartial model}}
   {{> operationsPartial model}}
-
 }

templates/operations.ts.hbs

@@ -1,5 +1,6 @@
 {{#each encodes.endPoints}}
   {{#each operations}}
+
     /**
     * {{{formatForTsDoc description}}}
     *
@@ -193,7 +194,7 @@
           method: "{{loud method}}",
           headers,
           {{#if (isRequestWithPayload request)}}body: this.clientConfig.transformRequest(options.body, headers){{/if}}
-        }, 
+        },
         this.clientConfig,
         rawResponse
       )

templates/paramKeys.ts.hbs

@@ -0,0 +1,24 @@
+static readonly paramKeys = {
+  {{#each encodes.endPoints}}
+  {{#each operations}}
+  {{{name}}}: [
+    {{#each ../parameters}}
+    '{{{name}}}',
+    {{/each}}
+    {{#each request.queryParameters}}
+    '{{{name}}}',
+    {{/each}}
+  ],
+  {{{name}}}Required: [
+    {{#each ../parameters}}
+    '{{{name}}}',
+    {{/each}}
+    {{#each request.queryParameters}}
+    {{#if (is required "true")}}
+    '{{{name}}}',
+    {{/if}}
+    {{/each}}
+  ],
+  {{/each}}
+  {{/each}}
+} as const;