(fix, typescript): serialize optional deep object query params correc…

…tly in the TypeScript SDK (#3071)

* (fix): ts sdk properly serializes optional objects

* add changelog and version bump for ts sdk

* Update CHANGELOG.md

* fix test

generators/typescript/sdk/CHANGELOG.md

@@ -5,6 +5,32 @@ 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.1] - 2024-02-27
+
+- Fix: Optional objects in deep query parameters were previously being incorrectly 
+  serialized. Before this change, optional objects were just being JSON.stringified
+  which would send the incorrect contents over the wire. 
+
+  ```ts
+  // Before
+  if (foo != null) {
+    _queryParams["foo"] = JSON.stringify(foo);
+  }
+
+  // After 
+  if (foo != null) {
+    _queryParams["foo"] = foo;
+  }
+
+  // After (with serde layer)
+  if (foo != null) {
+    _queryParams["foo"] = serializers.Foo.jsonOrThrow(foo, {
+      skipValidation: false,
+      breadcrumbs: ["request", "foo"]
+    })
+  }
+  ```
+
 ## [0.12.0] - 2024-02-26
 
 - Feature: support deep object query parameter serialization. If, query parameters are 

generators/typescript/sdk/VERSION

@@ -1 +1 @@
-0.12.0
+0.12.1

generators/typescript/sdk/client-class-generator/src/endpoints/utils/GeneratedQueryParams.ts

@@ -234,15 +234,23 @@ export class GeneratedQueryParams {
 
     private getObjectType(typeReference: TypeReference, context: SdkContext): DeclaredTypeName | undefined {
         switch (typeReference.type) {
-            case "named": {
-                const typeDeclaration = context.type.getTypeDeclaration(typeReference);
-                switch (typeDeclaration.shape.type) {
-                    case "object":
-                        return typeReference;
-                    case "alias": {
-                        return this.getObjectType(typeDeclaration.shape.aliasOf, context);
+            case "named":
+                {
+                    const typeDeclaration = context.type.getTypeDeclaration(typeReference);
+                    switch (typeDeclaration.shape.type) {
+                        case "object":
+                            return typeReference;
+                        case "alias": {
+                            return this.getObjectType(typeDeclaration.shape.aliasOf, context);
+                        }
                     }
                 }
+                break;
+            case "container": {
+                switch (typeReference.container.type) {
+                    case "optional":
+                        return this.getObjectType(typeReference.container.optional, context);
+                }
             }
         }
         return undefined;

packages/cli/generation/ir-generator/src/__test__/__snapshots__/query-parameters.txt

@@ -569,6 +569,105 @@ exports[`generate IR 1`] = `
                 "typeId": "type_user:NestedUser",
               },
             },
+            {
+              "allowMultiple": false,
+              "availability": null,
+              "docs": null,
+              "name": {
+                "name": {
+                  "camelCase": {
+                    "safeName": "optionalUser",
+                    "unsafeName": "optionalUser",
+                  },
+                  "originalName": "optionalUser",
+                  "pascalCase": {
+                    "safeName": "OptionalUser",
+                    "unsafeName": "OptionalUser",
+                  },
+                  "screamingSnakeCase": {
+                    "safeName": "OPTIONAL_USER",
+                    "unsafeName": "OPTIONAL_USER",
+                  },
+                  "snakeCase": {
+                    "safeName": "optional_user",
+                    "unsafeName": "optional_user",
+                  },
+                },
+                "wireValue": "optionalUser",
+              },
+              "valueType": {
+                "_type": "container",
+                "container": {
+                  "_type": "optional",
+                  "optional": {
+                    "_type": "named",
+                    "fernFilepath": {
+                      "allParts": [
+                        {
+                          "camelCase": {
+                            "safeName": "user",
+                            "unsafeName": "user",
+                          },
+                          "originalName": "user",
+                          "pascalCase": {
+                            "safeName": "User",
+                            "unsafeName": "User",
+                          },
+                          "screamingSnakeCase": {
+                            "safeName": "USER",
+                            "unsafeName": "USER",
+                          },
+                          "snakeCase": {
+                            "safeName": "user",
+                            "unsafeName": "user",
+                          },
+                        },
+                      ],
+                      "file": {
+                        "camelCase": {
+                          "safeName": "user",
+                          "unsafeName": "user",
+                        },
+                        "originalName": "user",
+                        "pascalCase": {
+                          "safeName": "User",
+                          "unsafeName": "User",
+                        },
+                        "screamingSnakeCase": {
+                          "safeName": "USER",
+                          "unsafeName": "USER",
+                        },
+                        "snakeCase": {
+                          "safeName": "user",
+                          "unsafeName": "user",
+                        },
+                      },
+                      "packagePath": [],
+                    },
+                    "name": {
+                      "camelCase": {
+                        "safeName": "user",
+                        "unsafeName": "user",
+                      },
+                      "originalName": "User",
+                      "pascalCase": {
+                        "safeName": "User",
+                        "unsafeName": "User",
+                      },
+                      "screamingSnakeCase": {
+                        "safeName": "USER",
+                        "unsafeName": "USER",
+                      },
+                      "snakeCase": {
+                        "safeName": "user",
+                        "unsafeName": "user",
+                      },
+                    },
+                    "typeId": "type_user:User",
+                  },
+                },
+              },
+            },
             {
               "allowMultiple": true,
               "availability": null,