[tcgc] remove deprecated nameInClient property from `SdkModelProper…

…tyType`s (Azure#1064) fixes Azure#446 --------- Co-authored-by: iscai-msft <isabellavcai@gmail.com>
markcowl · Jun 26, 2024 · c4a4d08 · c4a4d08
1 parent 2271561
commit c4a4d08
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 96 deletions.
diff --git a/.chronus/changes/remove_name_in_client-2024-5-24-13-45-6.md b/.chronus/changes/remove_name_in_client-2024-5-24-13-45-6.md
@@ -0,0 +1,7 @@
+---
+changeKind: breaking
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+remove deprecated `.nameInClient` property from `SdkModelPropertyType`s
diff --git a/packages/typespec-client-generator-core/src/http.ts b/packages/typespec-client-generator-core/src/http.ts
@@ -153,7 +153,6 @@ function getSdkHttpParameters(
       retval.bodyParam = {
         kind: "body",
         name,
-        nameInClient: name,
         isGeneratedName: true,
         description: getDocHelper(context, tspBody.type).description,
         details: getDocHelper(context, tspBody.type).details,
@@ -259,7 +258,6 @@ function createContentTypeOrAcceptHeader(
   // No need for clientDefaultValue because it's a constant, it only has one value
   return {
     type,
-    nameInClient: name,
     name,
     isGeneratedName: true,
     apiVersions: bodyObject.apiVersions,
@@ -473,7 +471,6 @@ export function getCorrespondingMethodParams(
       const apiVersionParamUpdated: SdkParameter = {
         ...apiVersionParam,
         name: "apiVersion",
-        nameInClient: "apiVersion",
         isGeneratedName: apiVersionParam.name !== "apiVersion",
         optional: false,
         clientDefaultValue:

diff --git a/packages/typespec-client-generator-core/src/interfaces.ts b/packages/typespec-client-generator-core/src/interfaces.ts
@@ -328,10 +328,6 @@ export interface SdkEndpointType extends SdkTypeBase {
 export interface SdkModelPropertyTypeBase {
   __raw?: ModelProperty;
   type: SdkType;
-  /**
-   * @deprecated This property is deprecated. Use `.name` instead.
-   */
-  nameInClient: string;
   name: string;
   isGeneratedName: boolean;
   description?: string;

diff --git a/packages/typespec-client-generator-core/src/package.ts b/packages/typespec-client-generator-core/src/package.ts
@@ -413,7 +413,6 @@ function getSdkMethodParameter(
       details: getDocHelper(context, type).details,
       apiVersions,
       type: propertyType,
-      nameInClient: name,
       name,
       isGeneratedName: Boolean(libraryName),
       optional: false,
@@ -478,7 +477,6 @@ function getSdkEndpointParameter(
       templateArguments: [
         {
           name,
-          nameInClient: name,
           isGeneratedName: true,
           description: "Service host",
           kind: "path",
@@ -533,7 +531,6 @@ function getSdkEndpointParameter(
   return diagnostics.wrap({
     kind: "endpoint",
     type,
-    nameInClient: "endpoint",
     name: "endpoint",
     isGeneratedName: true,
     description: "Service host",

diff --git a/packages/typespec-client-generator-core/src/types.ts b/packages/typespec-client-generator-core/src/types.ts
@@ -511,7 +511,6 @@ function addDiscriminatorToModelType(
         ? discriminatorProperty.serializedName
         : discriminator.propertyName,
       type: discriminatorType!,
-      nameInClient: name,
       name,
       isGeneratedName: false,
       onClient: false,
@@ -966,7 +965,6 @@ export function getSdkCredentialParameter(
   return {
     type: getSdkCredentialType(context, client, auth),
     kind: "credential",
-    nameInClient: name,
     name,
     isGeneratedName: true,
     description: "Credential used to authenticate requests to the service.",
@@ -1001,7 +999,6 @@ export function getSdkModelPropertyTypeBase(
     details: docWrapper.details,
     apiVersions,
     type: propertyType,
-    nameInClient: name,
     name,
     isGeneratedName: false,
     optional: type.optional,

diff --git a/packages/typespec-client-generator-core/test/package.test.ts b/packages/typespec-client-generator-core/test/package.test.ts
diff --git a/packages/typespec-client-generator-core/test/types/body-model-property-types.test.ts b/packages/typespec-client-generator-core/test/types/body-model-property-types.test.ts
@@ -106,23 +106,20 @@ describe("typespec-client-generator-core: body model property types", () => {
       (x) => x.kind === "property" && x.serializedName === "encodedWireName"
     );
     ok(jsonEncodedProp);
-    strictEqual(jsonEncodedProp.nameInClient, "jsonEncodedAndProjectedName");
     strictEqual(jsonEncodedProp.name, "jsonEncodedAndProjectedName");
 
     // wire name test with deprecated projected
     const jsonProjectedProp = sdkModel.properties.find(
       (x) => x.kind === "property" && x.serializedName === "realWireName"
     );
     ok(jsonProjectedProp);
-    strictEqual(jsonProjectedProp.nameInClient, "jsonProjectedName");
     strictEqual(jsonProjectedProp.name, "jsonProjectedName");
 
     // regular
     const regularProp = sdkModel.properties.find(
       (x) => x.kind === "property" && x.serializedName === "regular"
     );
     ok(regularProp);
-    strictEqual(regularProp.nameInClient, "regular");
     strictEqual(regularProp.name, "regular");
   });
   it("union type", async function () {

diff --git a/packages/typespec-client-generator-core/test/types/model-types.test.ts b/packages/typespec-client-generator-core/test/types/model-types.test.ts
@@ -146,7 +146,6 @@ describe("typespec-client-generator-core: model types", () => {
     strictEqual(recursiveModel.properties.length, 1);
     const prop = recursiveModel.properties[0];
     strictEqual(prop.kind, "property");
-    strictEqual(prop.nameInClient, "prop");
     strictEqual(prop.name, "prop");
     strictEqual(prop.type.kind, "model");
     strictEqual(prop.type.name, "RecursiveModel");