(fix, typescript): sdk code snippets dont render empty dicts for para…

…meters with default values (#3074)

* (fix, typescript): sdk code snippets dont render empty dicts for parameters with default values

* update changelog

generators/typescript/sdk/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.12.2] - 2024-02-27
+
+- Fix: Previously SDK code snippets would not take into account default parameter values
+  and would always include a `{}`. This was odd and didn't represent how a developer 
+  would use the SDK. Now, the snippets check for default parameter values and omit 
+  if there are no fields specified. 
+
+  ```ts
+  // Before
+  client.users.list({})
+
+  // After
+  client.users.list()
+  ```
+
 ## [0.12.1] - 2024-02-27
 
 - Fix: Optional objects in deep query parameters were previously being incorrectly 

generators/typescript/sdk/VERSION

@@ -1 +1 @@
-0.12.1
+0.12.2

generators/typescript/sdk/client-class-generator/src/endpoint-request/GeneratedDefaultEndpointRequest.ts

@@ -132,10 +132,17 @@ export class GeneratedDefaultEndpointRequest implements GeneratedEndpointRequest
         }
         if (this.requestParameter != null) {
             const requestParameterExample = this.requestParameter.generateExample({ context, example, opts });
-            if (requestParameterExample == null) {
+            if (
+                requestParameterExample != null &&
+                getTextOfTsNode(requestParameterExample) === "{}" &&
+                this.requestParameter.isOptional({ context })
+            ) {
+                // pass
+            } else if (requestParameterExample != null) {
+                result.push(requestParameterExample);
+            } else if (!this.requestParameter.isOptional({ context })) {
                 return undefined;
             }
-            result.push(requestParameterExample);
         }
         return result;
     }

generators/typescript/sdk/client-class-generator/src/request-parameter/AbstractRequestParameter.ts

@@ -73,4 +73,5 @@ export abstract class AbstractRequestParameter implements RequestParameter {
         hasQuestionToken: boolean;
         initializer?: ts.Expression;
     };
+    public abstract isOptional({ context }: { context: SdkContext }): boolean;
 }

generators/typescript/sdk/client-class-generator/src/request-parameter/FileUploadRequestParameter.ts

@@ -31,6 +31,10 @@ export class FileUploadRequestParameter extends AbstractRequestParameter {
         return this.getGeneratedRequestWrapper(context).getAllQueryParameters();
     }
 
+    public isOptional({ context }: { context: SdkContext }): boolean {
+        return false;
+    }
+
     public withQueryParameter(
         queryParameter: QueryParameter,
         context: SdkContext,

generators/typescript/sdk/client-class-generator/src/request-parameter/RequestBodyParameter.ts

@@ -42,6 +42,11 @@ export class RequestBodyParameter extends AbstractRequestParameter {
         throw new Error("Cannot reference query parameter because request is not wrapped");
     }
 
+    public isOptional({ context }: { context: SdkContext }): boolean {
+        const type = context.type.getReferenceToType(this.requestBodyReference.requestBodyType);
+        return type.isOptional;
+    }
+
     public generateExample({
         context,
         example,

generators/typescript/sdk/client-class-generator/src/request-parameter/RequestParameter.ts

@@ -25,4 +25,5 @@ export interface RequestParameter {
         example: ExampleEndpointCall;
         opts: GetReferenceOpts;
     }): ts.Expression | undefined;
+    isOptional({ context }: { context: SdkContext }): boolean;
 }

generators/typescript/sdk/client-class-generator/src/request-parameter/RequestWrapperParameter.ts

@@ -143,6 +143,10 @@ export class RequestWrapperParameter extends AbstractRequestParameter {
         });
     }
 
+    public isOptional({ context }: { context: SdkContext }): boolean {
+        return this.getGeneratedRequestWrapper(context).areAllPropertiesOptional(context);
+    }
+
     public getReferenceToQueryParameter(queryParameterKey: string, context: SdkContext): ts.Expression {
         const queryParameter = this.endpoint.queryParameters.find(
             (queryParam) => queryParam.name.wireValue === queryParameterKey